wx/wxPostgreSQL.h

/* Name:        wx/wxPostgreSQL.h
 * Purpose:     connect to PostgreSQL database.
 * Sever version: 8.3
 * Author:      Trần Ngọc Quân
 * Modified by:
 * Created:     20/10/2010
 * RCS-ID:
 * Copyright:   (c) 2010 wxPostgreSQL team
 * Licence: GPL
 */
#ifndef WX_POSTGRESQL_H
#define WX_POSTGRESQL_H
#if !WX_PRECOMP
#include <wx/wx.h>
#else
// basic wxWidgets headers
#include <wx/wxprec.h>
#endif
#include <libpq-fe.h>

typedef ConnStatusType wxConnStatusType;
typedef PostgresPollingStatusType wxPostgresPollingStatusType;
typedef ExecStatusType  wxExecStatusType;
typedef PGTransactionStatusType wxPGTransactionStatusType;
typedef PGVerbosity     wxVerbosity;
typedef PGconn  wxPGconn;
typedef PGresult        wxResult;
typedef PGcancel        wxPGcancel;
typedef PGnotify        wxPGnotify;
typedef PQprintOpt      wxPrintOpt;
typedef PQconninfoOption wxConninfoOption;
typedef PQArgBlock wxArgBlock;
typedef PQnoticeReceiver wxNoticeReceiver;
typedef PQnoticeProcessor wxNoticeProcessor;
typedef pgthreadlock_t wxpgthreadlock_t;
typedef Oid wxOid;

class wxPostgreSQLresult;

class wxPostgreSQL
{
public:
    wxPostgreSQL();
    wxPostgreSQL(const wxPostgreSQL& pq);
    wxPostgreSQL(char* const constr);
    wxPostgreSQL(const wxString& constr);
    wxPostgreSQL(const char *pghost,
                 const char *pgport,
                 const char *pgoptions,
                 const char *pgtty,
                 const char *dbName,
                 const char *login,
                 const char *pwd);
    wxPostgresPollingStatusType ConnectPoll();
    void Finish();
    static wxConninfoOption* ConnDefaults();
    void ConninfoFree();
    int ResetStart();
    wxPostgresPollingStatusType ResetPoll();
    void Reset();
    wxPGcancel* GetCancel();
    static void FreeCancel(wxPGcancel *cancel);
    static int  Cancel(wxPGcancel *cancel, char *errbuf, int errbufsize);
    int RequestCancel();

    /* Accessor functions for PGconn objects */
    char* GetDatabaseName();
    char* GetUserName();
    char* GetPassword();
    char* GetHost();
    char* GetPort();
    char* GetTTY();
    char* Options();
    wxConnStatusType Status();
    wxPGTransactionStatusType TransactionStatus();
    const char* ParameterStatus(const char* paramName);
    int ProtocolVersion()const;
    int ServerVersion()const;
    char* ErrorMessage() const;
    int Socket();
    int BackendPID();
    int IsNeedsPassword();
    int IsUsedPassword();
    int GetClientEncoding();
    int SetClientEncoding(const char *encoding);

    void* GetSSL();

    static void InitSSL(int do_init);

    wxVerbosity SetErrorVerbosity(wxVerbosity verbosity);

    void Trace(FILE *debug_port);
    void UnTrace();

    /* Override default notice handling routines */
    wxNoticeReceiver SetNoticeReceiver(wxNoticeReceiver proc, void *arg);
    wxNoticeProcessor SetNoticeProcessor(wxNoticeProcessor proc, void *arg);
    static pgthreadlock_t RegisterThreadLock(pgthreadlock_t newhandler);
    wxPostgreSQLresult* Execute(const char *query);
    wxPostgreSQLresult* Execute(const wxString& query);
    wxPostgreSQLresult* ExecuteParams(const char *command,
                                      int nParams,
                                      const wxOid *paramTypes,
                                      const char *const * paramValues,
                                      const int *paramLengths,
                                      const int *paramFormats,
                                      int resultFormat);
    wxPostgreSQLresult* Prepare(const char *stmtName,
                                const char *query,
                                int nParams,
                                const wxOid *paramTypes);
    wxPostgreSQLresult* ExecutePrepared(const char *stmtName,
                                        int nParams,
                                        const char *const * paramValues,
                                        const int *paramLengths,
                                        const int *paramFormats,
                                        int resultFormat);

    int SendQuery(const char *query);
    int SendQueryParams(const char *command,
                        int nParams,
                        const wxOid *paramTypes,
                        const char *const * paramValues,
                        const int *paramLengths,
                        const int *paramFormats,
                        int resultFormat);
    int SendPrepare(const char *stmtName,
                    const char *query,
                    int nParams,
                    const Oid *paramTypes);
    int SendQueryPrepared(const char *stmtName,
                          int nParams,
                          const char *const * paramValues,
                          const int *paramLengths,
                          const int *paramFormats,
                          int resultFormat);
    wxPostgreSQLresult* GetResult();

    int IsBusy();
    int ConsumeInput();

    wxPGnotify* Notifies();

    int PutCopyData(const char *buffer, int nbytes);
    int PutCopyEnd(const char *errormsg);

    int GetCopyData(char **buffer, int async);
    int Getline(char *string, int length);
    int Putline(const char *string);
    int GetlineAsync(char *buffer, int bufsize);
    int PutnBytes(const char *buffer, int nbytes);
    int EndCopy();

    int SetNonBlocking(int arg);
    int IsNonBlocking();
    static int  IsThreadSafe();

    int Flush();

    wxPostgreSQLresult* fn(int fnid,
                           int *result_buf,
                           int *result_len,
                           int result_is_int,
                           const wxArgBlock *args,
                           int nargs);
    wxPostgreSQLresult* DescribePrepared(const char *stmt);
    wxPostgreSQLresult* DescribePortal(const char *portal);
    int SendDescribePrepared(const char *stmt);
    int SendDescribePortal(const char *portal);

    static void FreeMemory(void *ptr);

    wxPostgreSQLresult* MakeEmptyResult(ExecStatusType status);

    size_t EscapeStringConn(char *to, const char *from, size_t length, int *error);
    unsigned char* EscapeByteaConn(const unsigned char *from, size_t from_length, size_t *to_length);
    static unsigned char* EscapeBytea(const unsigned char *from, size_t from_length, size_t *to_length);
    unsigned char* UnescapeBytea(const unsigned char *strtext, size_t *retbuflen);

    static size_t EscapeString(char *to, const char *from, size_t length);

    /* === in fe-lobj.c === */
    /* Large-object access routines */
    int lo_open(wxOid lobjId, int mode);
    int lo_close(int fd);
    int lo_read(int fd, char *buf, size_t len);
    int lo_write(int fd, const char *buf, size_t len);
    int lo_lseek(int fd, int offset, int whence);
    wxOid lo_creat(int mode);
    wxOid lo_create(wxOid lobjId);
    int lo_tell(int fd);
    int lo_truncate(int fd, size_t len);
    int lo_unlink(wxOid lobjId);
    wxOid lo_import(const char *filename);
    int lo_export(wxOid lobjId, const char *filename);

    /* === in fe-misc.c === */
    static int  mblen(const char *s, int encoding);

    static int  dsplen(const char *s, int encoding);

    static int  env2encoding();

    /* === in fe-auth.c === */
    static char* EncryptPassword(const char *passwd, const char *user);

    /* === in encnames.c === */

    static int  char2encoding(const char *name);
    static const char* encoding2char(int encoding);
    static int  valid_server_encoding_id(int encoding);
    ~wxPostgreSQL();

private:

    char* conninfo;
    wxPGconn* conn;
    wxConninfoOption* connOptions;
};
//End of declaration wxPostgreSQL class

class wxPostgreSQLresult
{
public:
    wxPostgreSQLresult();
    wxPostgreSQLresult(wxResult* res);
    ~wxPostgreSQLresult();
    wxExecStatusType Status();
    void Clear();
    char* StatusMessage(wxExecStatusType status);
    char* ErrorMessage();
    char* ErrorFieldMessage(int fieldcode);
    int GetNumberRows();
    int GetNumberFields();
    int IsBinary();
    char* FieldName(int field_num);
    int FieldNumber(const char *field_name);
    wxOid FieldTable(int field_num);
    int FieldTableColumn(int field_num);
    int FieldFormat(int field_num);
    wxOid FieldType(int field_num);
    int FieldSize(int field_num);
    int FieldModifier(int field_num);
    char* CommandStatus();
    char* OIDStatus();  /* old and ugly */
    wxOid OIDValue();   /* new and improved */
    char* CommandNumberRows();
    char* GetValue(int tup_num, int field_num);
    int GetLength(int tup_num, int field_num);
    int IsNull(int tup_num, int field_num);
    int NumberParams();
    wxOid ParamType(int param_num);
    void Print(FILE *fout, /* output stream */
               const wxPrintOpt *ps);   /* option structure */
    void DisplayRows(FILE *fp,          /* where to send the output */
                     int fillAlign,     /* pad the fields with spaces */
                     const char *fieldSep,      /* field separator */
                     int printHeader,   /* display headers? */
                     int quiet);

    void PrintRows(FILE *fout,          /* output stream */
                   int printAttName, /* print attribute names */
                   int terseOutput,     /* delimiter bars */
                   int width);          /* width of column, if 0, use variable width */

protected:

private:
    wxResult* res;

};

#endif // End wxPostgreSQL.h