]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/dbtable.h
doc view code inteprets wxSTREAM_EOF as correct,
[wxWidgets.git] / include / wx / dbtable.h
index fe52615bce1448dccd8842cb5c55d08c79fb0404..79cb77f90cce64e87a36d945c924c3feeb2c55e4 100644 (file)
@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
-// Name:        table.h
+// Name:        dbtable.h
 // Purpose:     Declaration of the wxTable class.
 // Author:      Doug Card
 // Modified by:
 // SYNOPSIS STOP
 */
 
-#ifndef TABLE_DOT_H
-#define TABLE_DOT_H
+#ifndef DBTABLE_DOT_H
+#define DBTABLE_DOT_H
 
-#ifdef __GNUG__
-#pragma interface "dbtable.h"
+// Use this line for wxWindows v1.x
+//#include "wx_ver.h"
+// Use this line for wxWindows v2.x
+#include "wx/version.h"
+
+#if wxMAJOR_VERSION == 2
+       #ifdef __GNUG__
+       #pragma interface "dbtable.h"
+       #endif
 #endif
 
-#include "wx/db.h"
+#if wxMAJOR_VERSION == 2
+       #include "wx/db.h"
+#else
+       #include "db.h"
+#endif
 
-const int ROWID_LEN = 24;  // 18 is the max, 24 is in case it gets larger
+const int      ROWID_LEN                       = 24;  // 18 is the max, 24 is in case it gets larger
+const int      DEFAULT_CURSOR          = 0;
+const bool     QUERY_ONLY                      = TRUE;
+const bool  DISABLE_VIEW               = TRUE;
 
 // The following class is used to define a column of a table.
 // The wxTable constructor will dynamically allocate as many of
@@ -43,10 +57,10 @@ const int ROWID_LEN = 24;  // 18 is the max, 24 is in case it gets larger
 // source, exchange data between the data source and the C++
 // object, and so on.
 
-class CcolDef
+class WXDLLEXPORT CcolDef
 {
 public:
-       char    ColName[DB_MAX_COLUMN_NAME_LEN+1];      // Column Name  glt 4/19/97 added one for the null terminator
+       char    ColName[DB_MAX_COLUMN_NAME_LEN+1];      // Column Name
        int     DbDataType;                                                                     // Logical Data Type; e.g. DB_DATA_TYPE_INTEGER
        int     SqlCtype;                                                                               // C data type; e.g. SQL_C_LONG
        void   *PtrDataObj;                                                                     // Address of the data object
@@ -56,30 +70,33 @@ public:
        bool    InsertAllowed;                                                          // Specifies whether this column should be included in an INSERT statement
        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
 };  // CcolDef
 
 // This structure is used when creating secondary indexes.
-class CidxDef
+class WXDLLEXPORT CidxDef
 {
 public:
-       char ColName[DB_MAX_COLUMN_NAME_LEN+1]; // Column Name  glt 4/19/97 added one for the null terminator
+       char ColName[DB_MAX_COLUMN_NAME_LEN+1];
        bool Ascending;
 };  // CidxDef
 
-class wxTable
+class WXDLLEXPORT wxTable
 {
 private:
 
+       ULONG   tableID;  // Used for debugging.  This can help to match up mismatched constructors/destructors
+
        // Private member variables
-       int currCursorNo;
+       UDWORD cursorType;
 
        // Private member functions
        bool bindInsertParams(void);
        bool bindUpdateParams(void);
        bool bindCols(HSTMT cursor);
        bool getRec(UWORD fetchType);
-       bool execDelete(char *pSqlStmt);
-       bool execUpdate(char *pSqlStmt);
+       bool execDelete(const char *pSqlStmt);
+       bool execUpdate(const char *pSqlStmt);
        bool query(int queryType, bool forUpdate, bool distinct, char *pSqlStmt = 0);
 
 public:
@@ -91,17 +108,20 @@ public:
        HENV  henv;                                                     // ODBC Environment handle
        HDBC  hdbc;                                                     // ODBC DB Connection handle
        HSTMT hstmt;                                            // ODBC Statement handle
-//     HSTMT c0, c1, c2, c3, c4, c5;   // Cursors 0 through 5
-       HSTMT c0, c1, c2;                                       // Limited to Cursors 0 through 2 for now
+       HSTMT *hstmtDefault;                            // Default cursor
        HSTMT hstmtInsert;                              // ODBC Statement handle used specifically for inserts
        HSTMT hstmtDelete;                              // ODBC Statement handle used specifically for deletes
        HSTMT hstmtUpdate;                              // ODBC Statement handle used specifically for updates
-       HSTMT hstmtCount;                                       // ODBC Statement handle used specifically for COUNT(*)
+       HSTMT hstmtInternal;                            // ODBC Statement handle used internally only
+       HSTMT *hstmtCount;                              // ODBC Statement handle used by Count() function (No binding of columns)
 
        // Table Inf.
        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
+       bool queryOnly;                                                                                 // Query Only, no inserts, updates or deletes
+
+       char tablePath[DB_PATH_MAX];  // needed for dBase tables
 
        // Column Definitions
        CcolDef *colDefs;       // Array of CcolDef structures
@@ -109,24 +129,27 @@ public:
        // Where, Order By and From clauses
        char *where;                    // Standard SQL where clause, minus the word WHERE
        char *orderBy;                  // Standard SQL order by clause, minus the ORDER BY
-       char *from;                             // Allows for joins in a Ctable::Query().  Format: ",tbl,tbl..."
+       char *from;                             // Allows for joins in a wxTable::Query().  Format: ",tbl,tbl..."
 
        // Flags
        bool selectForUpdate;
 
        // Public member functions
-       wxTable(wxDB *pwxDB, const char *tblName, const int nCols, const char *qryTblName = 0);
+       wxTable(wxDB *pwxDB, const char *tblName, const int nCols,
+               const char *qryTblName = 0, bool qryOnly = !QUERY_ONLY, const char *tblPath=NULL);
        virtual ~wxTable();
        bool    Open(void);
-       bool    CreateTable(void);
-       bool    CreateIndex(char * idxName, bool unique, int noIdxCols, CidxDef *pIdxDefs);
+       bool    CreateTable(bool attemptDrop=TRUE);
+       bool    DropTable(void);
+       bool    CreateIndex(const char * idxName, bool unique, int noIdxCols, CidxDef *pIdxDefs, bool attemptDrop=TRUE);
+       bool    DropIndex(const char * idxName);
        bool    CloseCursor(HSTMT cursor);
        int   Insert(void);
        bool    Update(void);
-       bool    Update(char *pSqlStmt);
-       bool    UpdateWhere(char *pWhereClause);
+       bool    Update(const char *pSqlStmt);
+       bool    UpdateWhere(const char *pWhereClause);
        bool    Delete(void);
-       bool    DeleteWhere(char *pWhereClause);
+       bool    DeleteWhere(const char *pWhereClause);
        bool    DeleteMatching(void);
        virtual bool Query(bool forUpdate = FALSE, bool distinct = FALSE);
        bool    QueryBySqlStmt(char *pSqlStmt);
@@ -134,31 +157,41 @@ public:
        bool    QueryOnKeyFields(bool forUpdate = FALSE, bool distinct = FALSE);
        bool    GetNext(void)   { return(getRec(SQL_FETCH_NEXT));  }
        bool    operator++(int) { return(getRec(SQL_FETCH_NEXT));  }
-#ifndef FWD_ONLY_CURSORS
-       bool    GetPrev(void)   { return(getRec(SQL_FETCH_PRIOR)); }
-       bool    operator--(int) { return(getRec(SQL_FETCH_PRIOR)); }
-       bool    GetFirst(void)  { return(getRec(SQL_FETCH_FIRST)); }
-       bool    GetLast(void)   { return(getRec(SQL_FETCH_LAST));  }
-#endif
+
+       /***** These four functions only work with wxDB instances that are defined  *****
+        ***** as not being FwdOnlyCursors                                          *****/
+       bool    GetPrev(void);
+       bool    operator--(int);
+       bool    GetFirst(void);
+       bool    GetLast(void);
+
        bool    IsCursorClosedOnCommit(void);
        bool    IsColNull(int colNo);
        UWORD GetRowNum(void);
        void  GetSelectStmt(char *pSqlStmt, int typeOfSelect, bool distinct);
-       void  GetDeleteStmt(char *pSqlStmt, int typeOfDel, char *pWhereClause = 0);
-       void  GetUpdateStmt(char *pSqlStmt, int typeOfUpd, char *pWhereClause = 0);
-       void  GetWhereClause(char *pWhereClause, int typeOfWhere, char *qualTableName = 0);
+       void  GetDeleteStmt(char *pSqlStmt, int typeOfDel, const char *pWhereClause = 0);
+       void  GetUpdateStmt(char *pSqlStmt, int typeOfUpd, const char *pWhereClause = 0);
+       void  GetWhereClause(char *pWhereClause, int typeOfWhere, const char *qualTableName = 0);
        bool    CanSelectForUpdate(void);
        bool    CanUpdByROWID(void);
        void  ClearMemberVars(void);
        bool    SetQueryTimeout(UDWORD nSeconds);
-       void  SetColDefs (int index, char *fieldName, int dataType, void *pData, int cType,
+       void  SetColDefs (int index, const char *fieldName, int dataType, void *pData, int cType,
                                                        int size, bool keyField = FALSE, bool upd = TRUE,
                                                        bool insAllow = TRUE, bool derivedCol = FALSE);
-       bool    SetCursor(int cursorNo = DB_CURSOR0);
-       int     GetCursor(void) { return(currCursorNo); }
-       ULONG Count(void);
+       HSTMT *NewCursor(bool setCursor = FALSE, bool bindColumns = TRUE);
+       bool    DeleteCursor(HSTMT *hstmtDel);
+       void    SetCursor(HSTMT *hstmtActivate = (void **) DEFAULT_CURSOR);
+       HSTMT GetCursor(void) { return(hstmt); }
+       ULONG Count(const char *args="*");
        int   DB_STATUS(void) { return(pDb->DB_STATUS); }
        bool    Refresh(void);
+       bool    SetNull(int colNo);
+       bool    SetNull(const char *colName);
+
+#ifdef __WXDEBUG__
+       ULONG   GetTableID() { return tableID; };
+#endif
 
 };  // wxTable