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

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

diff --git a/include/wx/db.h b/include/wx/db.h
index 0248829126e724cedb1da86075ec58021f894ae4..31bc02b3b05fb89bf8ebefcd252457fbf028534c 100644 (file)
--- a/include/wx/db.h
+++ b/include/wx/db.h
@@ -46,21 +46,18 @@
 #define OLD_GETCOLUMNS 1
 #define EXPERIMENTAL_WXDB_FUNCTIONS 1
 
-// 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 "db.h"
-    #endif
+#ifdef __GNUG__
+    #pragma interface "db.h"
 #endif
 
 #include "wx/setup.h"
 
-#if wxMAJOR_VERSION == 2
-    extern "C" {
+#include "wx/defs.h"
+#include "wx/string.h"
+
+extern "C" {
 #ifdef __VISUALC__
 // If you use the wxDbCreateDataSource() function with MSW/VC6,
 // you cannot use the iODBC headers, you must use the VC headers,
@@ -75,22 +72,7 @@
     #include "wx/isql.h"
     #include "wx/isqlext.h"
 #endif
-    }
-#else  // version == 1
-    extern "C" {
-#ifdef __VISUALC__
-// If you use the wxDbCreateDataSource() function with MSW/VC6,
-// you cannot use the iODBC headers, you must use the VC headers,
-// plus the odbcinst.h header - gt Nov 2 2000
-    #include "sql.h"
-    #include "sqlext.h"
-    #include "odbcinst.h"
-#else
-    #include "iodbc.h"
-    #include "isqlext.h"
-#endif
-    }
-#endif
+}
 
 typedef float SFLOAT;
 typedef double SDOUBLE;
@@ -105,10 +87,13 @@ enum enumDummy {enumDum1};
 
 #ifndef SQL_C_BOOLEAN
 #define SQL_C_BOOLEAN(datatype) (sizeof(datatype) == 1 ? SQL_C_UTINYINT : (sizeof(datatype) == 2 ? SQL_C_USHORT : SQL_C_ULONG))
+//#  define SQL_C_BOOLEAN (sizeof(int) == 2 ? SQL_C_USHORT : SQL_C_ULONG)
 #endif
+
 #ifndef SQL_C_ENUM
 #define SQL_C_ENUM (sizeof(enumDummy) == 2 ? SQL_C_USHORT : SQL_C_ULONG)
 #endif
+
 #ifndef SQL_C_BLOB
     #ifdef SQL_LONGVARBINARY
         #define SQL_C_BLOB SQL_LONGVARBINARY
@@ -116,15 +101,15 @@ enum enumDummy {enumDum1};
         #define SQL_C_BLOB SQL_VARBINARY
     #endif
 #endif
-
+/*
 #ifndef TRUE
-#define TRUE 1
+#define TRUE true
 #endif
 
 #ifndef FALSE
-#define FALSE 0
+#define FALSE false
 #endif
-
+*/
 const int wxDB_PATH_MAX                 = 254;
 
 extern wxChar const *SQL_LOG_FILENAME;
@@ -280,10 +265,10 @@ class WXDLLEXPORT wxDbConnectInf
         bool freeHenvOnDestroy;
 
     public:
-           HENV Henv;
-           wxChar Dsn[SQL_MAX_DSN_LENGTH+1];                  // Data Source Name
-           wxChar Uid[SQL_MAX_USER_NAME_LEN+1];               // User ID
-           wxChar AuthStr[SQL_MAX_AUTHSTR_LEN+1];             // Authorization string (password)
+        HENV Henv;
+        wxChar Dsn[SQL_MAX_DSN_LENGTH+1];                  // Data Source Name
+        wxChar Uid[SQL_MAX_USER_NAME_LEN+1];               // User ID
+        wxChar AuthStr[SQL_MAX_AUTHSTR_LEN+1];             // Authorization string (password)
 
         wxString Description;                              // Not sure what the max length is
         wxString FileType;                                 // Not sure what the max length is
@@ -339,7 +324,7 @@ class WXDLLEXPORT wxDbConnectInf
 struct WXDLLEXPORT wxDbSqlTypeInfo
 {
     wxString    TypeName;
-    int         FsqlType;
+    SWORD       FsqlType;
     long        Precision;
     short       CaseSensitive;
 //    short     MinimumScale;
@@ -396,15 +381,13 @@ public:
 };
 
 
-
-
 class WXDLLEXPORT wxDbTableInf        // Description of a Table
 {
 public:
     wxChar      tableName[DB_MAX_TABLE_NAME_LEN+1];
     wxChar      tableType[254+1];           // "TABLE" or "SYSTEM TABLE" etc.
     wxChar      tableRemarks[254+1];
-    int         numCols;                    // How many Columns does this Table have: GetColumnCount(..);
+    UWORD       numCols;                    // How many Columns does this Table have: GetColumnCount(..);
     wxDbColInf *pColInf;                    // pColInf = NULL ; User can later call GetColumns(..);
 
     wxDbTableInf();
@@ -452,7 +435,8 @@ enum wxDBMS
     dbmsINFORMIX,
     dbmsVIRTUOSO,
     dbmsDB2,
-    dbmsINTERBASE
+    dbmsINTERBASE,
+    dbmsPERVASIVE_SQL
 };
 
 
@@ -470,6 +454,7 @@ class WXDLLEXPORT wxDb
 {
 private:
     bool             dbIsOpen;
+    bool             dbIsCached;      // Was connection created by caching functions
     wxString         dsn;             // Data source name
     wxString         uid;             // User ID
     wxString         authStr;         // Authorization string (password)
@@ -513,6 +498,9 @@ private:
 
 public:
 
+    void             setCached(bool cached)  { dbIsCached = cached; };  // This function must only be called by wxDbGetConnection() and wxDbCloseConnections!!!
+    bool             IsCached() { return dbIsCached; };
+
     bool             GetDataTypeInfo(SWORD fSqlType, wxDbSqlTypeInfo &structSQLTypeInfo)
                             { return getDataTypeInfo(fSqlType, structSQLTypeInfo); }
 
@@ -590,6 +578,7 @@ public:
 
     // Public member functions
     wxDb(const HENV &aHenv, bool FwdOnlyCursors=(bool)wxODBC_FWD_ONLY_CURSORS);
+    ~wxDb();
 
     bool         Open(const wxString &Dsn, const wxString &Uid, const wxString &AuthStr);  // Data Source Name, User ID, Password
     bool         Open(wxDbConnectInf *dbConnectInf);
@@ -609,10 +598,10 @@ public:
     int          TranslateSqlState(const wxString &SQLState);
     wxDbInf     *GetCatalog(const wxChar *userID=NULL);
     bool         Catalog(const wxChar *userID=NULL, const wxString &fileName=SQL_CATALOG_FILENAME);
-    int          GetKeyFields(const wxString &tableName, wxDbColInf* colInf, int nocols);
+    int          GetKeyFields(const wxString &tableName, wxDbColInf* colInf, UWORD noCols);
 
     wxDbColInf  *GetColumns(wxChar *tableName[], const wxChar *userID=NULL);
-    wxDbColInf  *GetColumns(const wxString &tableName, int *numCols, const wxChar *userID=NULL); 
+    wxDbColInf  *GetColumns(const wxString &tableName, UWORD *numCols, const wxChar *userID=NULL); 
 
     int             GetColumnCount(const wxString &tableName, const wxChar *userID=NULL);
     const wxChar   *GetDatabaseName(void)  {return dbInf.dbmsName;}
@@ -697,8 +686,15 @@ void  WXDLLEXPORT  wxDbCloseConnections(void);
 int   WXDLLEXPORT  wxDbConnectionsInUse(void);
 
 
+//TODO: document
+// Writes a message to the wxLog window (stdout usually) when an internal error
+// situation occurs.  This function only works in DEBUG builds
+const wxChar WXDLLEXPORT *wxDbLogExtendedErrorMsg(const wxChar *userText, wxDb *pDb,
+                                                  char *ErrFile, int ErrLine);
+//TODO: end document
+
 // This function sets the sql log state for all open wxDb objects
-bool wxDbSqlLog(wxDbSqlLogState state, const wxString &filename = SQL_LOG_FILENAME);
+bool  WXDLLEXPORT  wxDbSqlLog(wxDbSqlLogState state, const wxString &filename = SQL_LOG_FILENAME);
 
 
 #if 0