Trying to hide evidence of my negative programming skills...

[wxWidgets.git] / include / wx / dbtable.h

diff --git a/include/wx/dbtable.h b/include/wx/dbtable.h
index 6f7e6866d516a9c87f0b99a67091ef393d643279..c23c72370d2c6f7bf756778c1aad8e46ea05dad9 100644 (file)
--- a/include/wx/dbtable.h
+++ b/include/wx/dbtable.h
@@ -3,11 +3,13 @@
 // Purpose:     Declaration of the wxDbTable class.
 // Author:      Doug Card
 // Modified by: George Tasker
 // Purpose:     Declaration of the wxDbTable class.
 // Author:      Doug Card
 // Modified by: George Tasker

+//              Bart Jourquin
+//              Mark Johnson

 // Created:     9.96
 // RCS-ID:      $Id$
 // Copyright:   (c) 1996 Remstar International, Inc.
 // Licence:     wxWindows licence, plus:
 // Created:     9.96
 // RCS-ID:      $Id$
 // Copyright:   (c) 1996 Remstar International, Inc.
 // Licence:     wxWindows licence, plus:

-// Notice:        This class library and its intellectual design are free of charge for use,
+// Notice:      This class library and its intellectual design are free of charge for use,

 //              modification, enhancement, debugging under the following conditions:
 //              1) These classes may only be used as part of the implementation of a
 //                 wxWindows-based application
 //              modification, enhancement, debugging under the following conditions:
 //              1) These classes may only be used as part of the implementation of a
 //                 wxWindows-based application


@@ -26,28 +28,26 @@
 #ifndef DBTABLE_DOT_H
 #define DBTABLE_DOT_H
 
 #ifndef DBTABLE_DOT_H
 #define DBTABLE_DOT_H
 

-// Use this line for wxWindows v1.x
-//#include "wx_ver.h"
-// Use this line for wxWindows v2.x

 #include "wx/version.h"
 
 #include "wx/version.h"
 

-#if wxMAJOR_VERSION == 2
-    #ifdef __GNUG__
-    #pragma interface "dbtable.h"
-    #endif
+#ifdef __GNUG__
+  #pragma interface "dbtable.h"

 #endif
 
 #endif
 

-#if wxMAJOR_VERSION == 2
-    #include "wx/db.h"
-#else
-    #include "db.h"
-#endif
+#include "wx/db.h"
+
+#include "wx/variant.h"
+#include "wx/dbkeyg.h"

 
 const int   wxDB_ROWID_LEN       = 24;  // 18 is the max, 24 is in case it gets larger
 const int   wxDB_DEFAULT_CURSOR  = 0;
 const bool  wxDB_QUERY_ONLY      = TRUE;
 const bool  wxDB_DISABLE_VIEW    = TRUE;
 
 
 const int   wxDB_ROWID_LEN       = 24;  // 18 is the max, 24 is in case it gets larger
 const int   wxDB_DEFAULT_CURSOR  = 0;
 const bool  wxDB_QUERY_ONLY      = TRUE;
 const bool  wxDB_DISABLE_VIEW    = TRUE;
 

+// Used to indicate end of a variable length list of
+// column numbers passed to member functions
+const int   wxDB_NO_MORE_COLUMN_NUMBERS = -1;
+

 // The following class is used to define a column of a table.
 // The wxDbTable constructor will dynamically allocate as many of
 // these as there are columns in the table.  The class derived
 // The following class is used to define a column of a table.
 // The wxDbTable constructor will dynamically allocate as many of
 // these as there are columns in the table.  The class derived


@@ -59,9 +59,9 @@ const bool  wxDB_DISABLE_VIEW    = TRUE;
 class WXDLLEXPORT wxDbColDef
 {
 public:
 class WXDLLEXPORT wxDbColDef
 {
 public:

-    char    ColName[DB_MAX_COLUMN_NAME_LEN+1];  // Column Name
+    wxChar  ColName[DB_MAX_COLUMN_NAME_LEN+1];  // Column Name

     int     DbDataType;                         // Logical Data Type; e.g. DB_DATA_TYPE_INTEGER
     int     DbDataType;                         // Logical Data Type; e.g. DB_DATA_TYPE_INTEGER

-    int     SqlCtype;                           // C data type; e.g. SQL_C_LONG
+    SWORD   SqlCtype;                           // C data type; e.g. SQL_C_LONG

     void   *PtrDataObj;                         // Address of the data object
     int     SzDataObj;                          // Size, in bytes, of the data object
     bool    KeyField;                           // TRUE if this column is part of the PRIMARY KEY to the table; Date fields should NOT be KeyFields.
     void   *PtrDataObj;                         // Address of the data object
     int     SzDataObj;                          // Size, in bytes, of the data object
     bool    KeyField;                           // TRUE if this column is part of the PRIMARY KEY to the table; Date fields should NOT be KeyFields.


@@ -70,6 +70,10 @@ public:
     bool    DerivedCol;                         // Specifies whether this column is a derived value
     SDWORD  CbValue;                            // Internal use only!!!
     bool    Null;                               // NOT FULLY IMPLEMENTED - Allows NULL values in Inserts and Updates
     bool    DerivedCol;                         // Specifies whether this column is a derived value
     SDWORD  CbValue;                            // Internal use only!!!
     bool    Null;                               // NOT FULLY IMPLEMENTED - Allows NULL values in Inserts and Updates

+
+    wxDbColDef();
+
+    bool    Initialize();

 };  // wxDbColDef
 
 
 };  // wxDbColDef
 
 


@@ -78,7 +82,7 @@ class WXDLLEXPORT wxDbColDataPtr
 public:
     void    *PtrDataObj;
     int      SzDataObj;
 public:
     void    *PtrDataObj;
     int      SzDataObj;

-    int      SqlCtype;
+    SWORD    SqlCtype;

 };  // wxDbColDataPtr
 
 
 };  // wxDbColDataPtr
 
 


@@ -86,28 +90,34 @@ public:
 class WXDLLEXPORT wxDbIdxDef
 {
 public:
 class WXDLLEXPORT wxDbIdxDef
 {
 public:

-    char ColName[DB_MAX_COLUMN_NAME_LEN+1];
-    bool Ascending;
+    wxChar  ColName[DB_MAX_COLUMN_NAME_LEN+1];
+    bool    Ascending;

 };  // wxDbIdxDef
 
 
 class WXDLLEXPORT wxDbTable
 {
 private:
 };  // wxDbIdxDef
 
 
 class WXDLLEXPORT wxDbTable
 {
 private:

-    ULONG    tableID;  // Used for debugging.  This can help to match up mismatched constructors/destructors
+    ULONG       tableID;  // Used for debugging.  This can help to match up mismatched constructors/destructors

 
     // Private member variables
 
     // Private member variables

-    UDWORD cursorType;
-    bool   insertable;
+    UDWORD      cursorType;
+    bool        insertable;

 
     // Private member functions
 
     // Private member functions

-    bool bindInsertParams(void);
-    bool bindUpdateParams(void);
-    bool bindCols(HSTMT cursor);
-    bool getRec(UWORD fetchType);
-    bool execDelete(const char *pSqlStmt);
-    bool execUpdate(const char *pSqlStmt);
-    bool query(int queryType, bool forUpdate, bool distinct, const char *pSqlStmt = 0);
+    bool        initialize(wxDb *pwxDb, const wxString &tblName, const UWORD numColumns,
+                       const wxString &qryTblName, bool qryOnly, const wxString &tblPath);
+    void        cleanup();
+
+    bool        bindParams(bool forUpdate);  // called by the other 'bind' functions
+    bool        bindInsertParams(void);
+    bool        bindUpdateParams(void);
+
+    bool        bindCols(HSTMT cursor);
+    bool        getRec(UWORD fetchType);
+    bool        execDelete(const wxString &pSqlStmt);
+    bool        execUpdate(const wxString &pSqlStmt);
+    bool        query(int queryType, bool forUpdate, bool distinct, const wxString &pSqlStmt=wxEmptyString);

 
 #if !wxODBC_BACKWARD_COMPATABILITY
 // these were public
 
 #if !wxODBC_BACKWARD_COMPATABILITY
 // these were public


@@ -134,10 +144,10 @@ private:
     wxDb       *pDb;
 
     // Table Inf.
     wxDb       *pDb;
 
     // Table Inf.

-    char        tablePath[wxDB_PATH_MAX];                  // needed for dBase tables
-    char        tableName[DB_MAX_TABLE_NAME_LEN+1];        // Table name
-    char        queryTableName[DB_MAX_TABLE_NAME_LEN+1];   // Query Table Name
-    int         noCols;                                    // # of columns in the table
+    wxString    tablePath;                                 // needed for dBase tables
+    wxString    tableName;                                 // Table name
+    wxString    queryTableName;                            // Query Table Name
+    UWORD       noCols;                                    // # of columns in the table

     bool        queryOnly;                                 // Query Only, no inserts, updates or deletes
 
     // Column Definitions
     bool        queryOnly;                                 // Query Only, no inserts, updates or deletes
 
     // Column Definitions


@@ -171,59 +181,73 @@ public:
     char        tablePath[wxDB_PATH_MAX];                  // needed for dBase tables
     char        tableName[DB_MAX_TABLE_NAME_LEN+1];        // Table name
     char        queryTableName[DB_MAX_TABLE_NAME_LEN+1];   // Query Table Name
     char        tablePath[wxDB_PATH_MAX];                  // needed for dBase tables
     char        tableName[DB_MAX_TABLE_NAME_LEN+1];        // Table name
     char        queryTableName[DB_MAX_TABLE_NAME_LEN+1];   // Query Table Name

-    int         noCols;                                    // # of columns in the table
+    UWORD       noCols;                                    // # of columns in the table

     bool        queryOnly;                                 // Query Only, no inserts, updates or deletes
 
     // Column Definitions
     wxDbColDef *colDefs;         // Array of wxDbColDef structures
 #endif
     // Public member functions
     bool        queryOnly;                                 // Query Only, no inserts, updates or deletes
 
     // Column Definitions
     wxDbColDef *colDefs;         // Array of wxDbColDef structures
 #endif
     // Public member functions

-    wxDbTable(wxDb *pwxDb, const char *tblName, const int nCols,
-              const char *qryTblName = 0, bool qryOnly = !wxDB_QUERY_ONLY, const char *tblPath=NULL);
+    wxDbTable(wxDb *pwxDb, const wxString &tblName, const UWORD numColumns,
+              const wxString &qryTblName="", bool qryOnly = !wxDB_QUERY_ONLY, 
+              const wxString &tblPath="");
+
+    // DEPRECATED
+    wxDbTable(wxDb *pwxDb, const wxString &tblName, const UWORD numColumns,
+              const wxChar *qryTblName="", bool qryOnly = !wxDB_QUERY_ONLY, 
+              const wxString &tblPath="");
+

     virtual ~wxDbTable();
 
     virtual ~wxDbTable();
 

-    bool            Open(void);
+    bool            Open(bool checkPrivileges=FALSE, bool checkTableExists=TRUE);

     bool            CreateTable(bool attemptDrop=TRUE);
     bool            DropTable(void);
     bool            CreateTable(bool attemptDrop=TRUE);
     bool            DropTable(void);

-    bool            CreateIndex(const char * idxName, bool unique, int noIdxCols, wxDbIdxDef *pIdxDefs, bool attemptDrop=TRUE);
-    bool            DropIndex(const char * idxName);
+    bool            CreateIndex(const wxString &idxName, bool unique, UWORD noIdxCols, 
+                                wxDbIdxDef *pIdxDefs, bool attemptDrop=TRUE);
+    bool            DropIndex(const wxString &idxName);

 
 

-// Accessors
+    // Accessors

 
     // The member variables returned by these accessors are all
 
     // The member variables returned by these accessors are all

-    // set when the wxDbTable instance is createand cannot be 
+    // set when the wxDbTable instance is created and cannot be 

     // changed, hence there is no corresponding SetXxxx function
     // changed, hence there is no corresponding SetXxxx function

-        wxDb           *GetDb()              { return pDb; }
-        const char     *GetTableName()       { return tableName; }
-        const char     *GetQueryTableName()  { return queryTableName; }
-        const char     *GetTablePath()       { return tablePath; }
+    wxDb           *GetDb()              { return pDb; }
+    const wxString &GetTableName()       { return tableName; }
+    const wxString &GetQueryTableName()  { return queryTableName; }
+    const wxString &GetTablePath()       { return tablePath; }

 
 

-         int GetNumberOfColumns() { return noCols; }  // number of "defined" columns for this wxDbTable instance
-       
+    UWORD           GetNumberOfColumns() { return noCols; }  // number of "defined" columns for this wxDbTable instance

 
 

-        const char     *GetFromClause()      { return from; }
-        const char     *GetOrderByClause()   { return orderBy; }
-        const char     *GetWhereClause()     { return where; }
+    const wxString &GetFromClause()      { return from; }
+    const wxString &GetOrderByClause()   { return orderBy; }
+    const wxString &GetWhereClause()     { return where; }

 
 

-        bool            IsQueryOnly()        { return queryOnly; }
+    bool            IsQueryOnly()        { return queryOnly; }

 #if wxODBC_BACKWARD_COMPATABILITY
     void            SetFromClause(const char *From) { from = (char *)From; }
 #if wxODBC_BACKWARD_COMPATABILITY
     void            SetFromClause(const char *From) { from = (char *)From; }

-        void            SetOrderByClause(const char *OrderBy) { orderBy = (char *)OrderBy; }
-        void            SetWhereClause(const char *Where) { where = (char *)Where; }
+    void            SetOrderByClause(const char *OrderBy) { orderBy = (char *)OrderBy; }
+    void            SetWhereClause(const char *Where) { where = (char *)Where; }

 #else
 #else

-        void            SetFromClause(const wxString& From) { from = From; }
-        void            SetOrderByClause(const wxString& OrderBy) { orderBy = OrderBy; }
-        void            SetWhereClause(const wxString& Where) { where = Where; }
+    void            SetFromClause(const wxString &From) { from = From; }
+    void            SetOrderByClause(const wxString &OrderBy) { orderBy = OrderBy; }
+    bool            SetOrderByColNums(UWORD first, ...);
+    void            SetWhereClause(const wxString &Where) { where = Where; }
+    void            From(const wxString &From) { from = From; }
+    void            OrderBy(const wxString &OrderBy) { orderBy = OrderBy; }
+    void            Where(const wxString &Where) { where = Where; }
+    const wxString &Where()   { return where; }
+    const wxString &OrderBy() { return orderBy; }
+    const wxString &From()    { return from; }

 #endif
     int             Insert(void);
     bool            Update(void);
 #endif
     int             Insert(void);
     bool            Update(void);

-    bool            Update(const char *pSqlStmt);
-    bool            UpdateWhere(const char *pWhereClause);
+    bool            Update(const wxString &pSqlStmt);
+    bool            UpdateWhere(const wxString &pWhereClause);

     bool            Delete(void);
     bool            Delete(void);

-    bool            DeleteWhere(const char *pWhereClause);
+    bool            DeleteWhere(const wxString &pWhereClause);

     bool            DeleteMatching(void);
     virtual bool    Query(bool forUpdate = FALSE, bool distinct = FALSE);
     bool            DeleteMatching(void);
     virtual bool    Query(bool forUpdate = FALSE, bool distinct = FALSE);

-    bool            QueryBySqlStmt(const char *pSqlStmt);
+    bool            QueryBySqlStmt(const wxString &pSqlStmt);

     bool            QueryMatching(bool forUpdate = FALSE, bool distinct = FALSE);
     bool            QueryOnKeyFields(bool forUpdate = FALSE, bool distinct = FALSE);
     bool            Refresh(void);
     bool            QueryMatching(bool forUpdate = FALSE, bool distinct = FALSE);
     bool            QueryOnKeyFields(bool forUpdate = FALSE, bool distinct = FALSE);
     bool            Refresh(void);


@@ -240,32 +264,42 @@ public:
     bool            IsCursorClosedOnCommit(void);
     UWORD           GetRowNum(void);
 
     bool            IsCursorClosedOnCommit(void);
     UWORD           GetRowNum(void);
 

-    void            BuildSelectStmt(char *pSqlStmt, int typeOfSelect, bool distinct);
-    void            BuildDeleteStmt(char *pSqlStmt, int typeOfDel, const char *pWhereClause = 0);
-    void            BuildUpdateStmt(char *pSqlStmt, int typeOfUpd, const char *pWhereClause = 0);
-    void            BuildWhereClause(char *pWhereClause, int typeOfWhere, const char *qualTableName = 0, bool useLikeComparison=FALSE);
+    void            BuildSelectStmt(wxString &pSqlStmt, int typeOfSelect, bool distinct);
+    void            BuildSelectStmt(wxChar *pSqlStmt, int typeOfSelect, bool distinct);
+
+    void            BuildDeleteStmt(wxString &pSqlStmt, int typeOfDel, const wxString &pWhereClause="");
+    void            BuildDeleteStmt(wxChar *pSqlStmt, int typeOfDel, const wxString &pWhereClause="");
+
+    void            BuildUpdateStmt(wxString &pSqlStmt, int typeOfUpd, const wxString &pWhereClause="");
+    void            BuildUpdateStmt(wxChar *pSqlStmt, int typeOfUpd, const wxString &pWhereClause="");
+
+    void            BuildWhereClause(wxString &pWhereClause, int typeOfWhere, const wxString &qualTableName="", bool useLikeComparison=FALSE);
+    void            BuildWhereClause(wxChar *pWhereClause, int typeOfWhere, const wxString &qualTableName="", bool useLikeComparison=FALSE);
+

 #if wxODBC_BACKWARD_COMPATABILITY
 // The following member functions are deprecated.  You should use the BuildXxxxxStmt functions (above)
     void            GetSelectStmt(char *pSqlStmt, int typeOfSelect, bool distinct)
                            { BuildSelectStmt(pSqlStmt,typeOfSelect,distinct); }
 #if wxODBC_BACKWARD_COMPATABILITY
 // The following member functions are deprecated.  You should use the BuildXxxxxStmt functions (above)
     void            GetSelectStmt(char *pSqlStmt, int typeOfSelect, bool distinct)
                            { BuildSelectStmt(pSqlStmt,typeOfSelect,distinct); }

-    void            GetDeleteStmt(char *pSqlStmt, int typeOfDel, const char *pWhereClause = 0)
+    void            GetDeleteStmt(char *pSqlStmt, int typeOfDel, const char *pWhereClause = NULL)

                            { BuildDeleteStmt(pSqlStmt,typeOfDel,pWhereClause); }
                            { BuildDeleteStmt(pSqlStmt,typeOfDel,pWhereClause); }

-    void            GetUpdateStmt(char *pSqlStmt, int typeOfUpd, const char *pWhereClause = 0)
+    void            GetUpdateStmt(char *pSqlStmt, int typeOfUpd, const char *pWhereClause = NULL)

                            { BuildUpdateStmt(pSqlStmt,typeOfUpd,pWhereClause); }
     void            GetWhereClause(char *pWhereClause, int typeOfWhere, 
                            { BuildUpdateStmt(pSqlStmt,typeOfUpd,pWhereClause); }
     void            GetWhereClause(char *pWhereClause, int typeOfWhere, 

-                                   const char *qualTableName = 0, bool useLikeComparison=FALSE)
+                                   const char *qualTableName = NULL, bool useLikeComparison=FALSE)

                            { BuildWhereClause(pWhereClause,typeOfWhere,qualTableName,useLikeComparison); }
 #endif
     bool            CanSelectForUpdate(void);
     bool            CanUpdByROWID(void);
                            { BuildWhereClause(pWhereClause,typeOfWhere,qualTableName,useLikeComparison); }
 #endif
     bool            CanSelectForUpdate(void);
     bool            CanUpdByROWID(void);

-    void            ClearMemberVars(void);
+    void            ClearMemberVar(UWORD colNo, bool setToNull=FALSE);
+    void            ClearMemberVars(bool setToNull=FALSE);

     bool            SetQueryTimeout(UDWORD nSeconds);
 
     wxDbColDef     *GetColDefs() { return colDefs; }
     bool            SetQueryTimeout(UDWORD nSeconds);
 
     wxDbColDef     *GetColDefs() { return colDefs; }

-    void            SetColDefs(int index, const char *fieldName, int dataType, void *pData, int cType,
+    void            SetColDefs(UWORD index, const wxString &fieldName, int dataType, 
+                               void *pData, SWORD cType,

                                int size, bool keyField = FALSE, bool upd = TRUE,
                                bool insAllow = TRUE, bool derivedCol = FALSE);
                                int size, bool keyField = FALSE, bool upd = TRUE,
                                bool insAllow = TRUE, bool derivedCol = FALSE);

-    wxDbColDataPtr *SetColDefs(wxDbColInf *colInfs, ULONG numCols);
+    wxDbColDataPtr *SetColDefs(wxDbColInf *colInfs, UWORD numCols);

 
     bool            CloseCursor(HSTMT cursor);
     bool            DeleteCursor(HSTMT *hstmtDel);
 
     bool            CloseCursor(HSTMT cursor);
     bool            DeleteCursor(HSTMT *hstmtDel);


@@ -277,17 +311,47 @@ public:
     HSTMT          *NewCursor(bool setCursor = FALSE, bool bindColumns = TRUE) {  return GetNewCursor(setCursor,bindColumns); }
 #endif
 
     HSTMT          *NewCursor(bool setCursor = FALSE, bool bindColumns = TRUE) {  return GetNewCursor(setCursor,bindColumns); }
 #endif
 

-    ULONG           Count(const char *args="*");
+    ULONG           Count(const wxString &args="*");

     int             DB_STATUS(void) { return(pDb->DB_STATUS); }
 
     int             DB_STATUS(void) { return(pDb->DB_STATUS); }
 

-    bool            IsColNull(int colNo);
-    bool            SetNull(int colNo);
-    bool            SetNull(const char *colName);
-
+    bool            IsColNull(UWORD colNo) const;
+    bool            SetColNull(UWORD colNo, bool set=TRUE);
+    bool            SetColNull(const wxString &colName, bool set=TRUE);
+#if wxODBC_BACKWARD_COMPATABILITY
+// The following member functions are deprecated.  You should use the SetColNull()
+    bool            SetNull(int colNo, bool set=TRUE) { return (SetNull(colNo,set)); }
+    bool            SetNull(const char *colName, bool set=TRUE) { return (SetNull(colName,set)); }
+#endif

 #ifdef __WXDEBUG__
     ULONG           GetTableID() { return tableID; }
 #endif
 
 #ifdef __WXDEBUG__
     ULONG           GetTableID() { return tableID; }
 #endif
 

+//TODO: Need to Document
+    typedef     enum  { WX_ROW_MODE_QUERY , WX_ROW_MODE_INDIVIDUAL } rowmode_t;
+    virtual     void         SetRowMode(const rowmode_t rowmode);
+    virtual     wxVariant    GetCol(const int Colno) const ;
+    virtual     void         SetCol(const int ColNo, const wxVariant value);
+    virtual     GenericKey   GetKey(void);
+    virtual     void         SetKey(const GenericKey &key);
+
+    private:
+        HSTMT      *m_hstmtGridQuery;
+        rowmode_t   m_rowmode;
+        size_t      m_keysize;
+
+//      typedef enum {unmodified=0, UpdatePending, InsertPending } recStatus;
+
+//      recStatus  get_ModifiedStatus() { return m_recstatus; }
+        
+//      void modify() {
+//          if (m_recstatus==unmodified)
+//              m_recstatus=UpdatePending;
+//      }
+//  protected:
+//      void insertify() {m_recstatus=InsertPending; }
+//      void unmodify() {m_recstatus=unmodified; }
+//      recStatus m_recstatus;
+//TODO: Need to Document

 };  // wxDbTable
 
 
 };  // wxDbTable