Header Cosmetics

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

diff --git a/include/wx/db.h b/include/wx/db.h
index 0248829126e724cedb1da86075ec58021f894ae4..1c007c953c4a8bba80fea02f505f047758edbd7d 100644 (file)
--- a/include/wx/db.h
+++ b/include/wx/db.h
@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

-// Name:        db.h
+// Name:        wx/db.h

 // Purpose:     Header file wxDb class.  The wxDb class represents a connection
 //              to an ODBC data source.  The wxDb class allows operations on the data
 //              source such as opening and closing the data source.
 // Purpose:     Header file wxDb class.  The wxDb class represents a connection
 //              to an ODBC data source.  The wxDb class allows operations on the data
 //              source such as opening and closing the data source.


@@ -32,13 +32,8 @@
 //
 ///////////////////////////////////////////////////////////////////////////////
 
 //
 ///////////////////////////////////////////////////////////////////////////////
 

-/*
-// SYNOPSIS START
-// SYNOPSIS STOP
-*/
-
-#ifndef DB_DOT_H
-#define DB_DOT_H
+#ifndef _WX_DB_H_
+#define _WX_DB_H_

 
 
 // BJO 20000503: introduce new GetColumns members which are more database independant and 
 
 
 // BJO 20000503: introduce new GetColumns members which are more database independant and 


@@ -46,57 +41,69 @@
 #define OLD_GETCOLUMNS 1
 #define EXPERIMENTAL_WXDB_FUNCTIONS 1
 
 #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"
 
 #include "wx/version.h"
 

-#if wxMAJOR_VERSION == 2
-    #ifdef __GNUG__
-        #pragma interface "db.h"
-    #endif
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
+    #pragma interface "db.h"

 #endif
 
 #include "wx/setup.h"
 
 #endif
 
 #include "wx/setup.h"
 

-#if wxMAJOR_VERSION == 2
-    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
-//
-//  Must add "odbccp32.lib" in \wx2\wxWindows\src\makevc.env to the WINLIBS= line
-//
+#include "wx/defs.h"
+#include "wx/string.h"
+
+#if defined(__VISUALC__) 
+    // we need to include standard Windows headers but we can't include
+    // <windows.h> directly when using MFC because it includes it itself in a
+    // different manner
+    #if wxUSE_MFC
+        #include <afxwin.h>
+    #else // !wxUSE_MFC
+        #ifndef STRICT
+            #define STRICT 1
+        #endif
+
+        #include <windows.h>
+        #include "wx/msw/winundef.h"
+    #endif // wxUSE_MFC/!wxUSE_MFC
+
+    // 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
+    //
+    // Must add "odbccp32.lib" in \wx2\wxWindows\src\makevc.env to the WINLIBS= line
+    //

     #include "sql.h"
     #include "sqlext.h"
     #include "odbcinst.h"
 #else
     #include "sql.h"
     #include "sqlext.h"
     #include "odbcinst.h"
 #else

-    #include "wx/isql.h"
-    #include "wx/isqlext.h"
-#endif
-    }
-#else  // version == 1
+    #if defined(__WINDOWS__) && defined(HAVE_W32API_H)
+        #include <windows.h>
+        #include "wx/msw/winundef.h"
+    #endif

     extern "C" {
     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
+    #if defined(wxUSE_BUILTIN_IODBC) && wxUSE_BUILTIN_IODBC
+        // Use the ones from the library
+        #include "wx/isql.h"
+        #include "wx/isqlext.h"
+    #else
+        #include <sql.h>
+        #include <sqlext.h>
+    #endif

     }
 #endif
 
     }
 #endif
 

+

 typedef float SFLOAT;
 typedef double SDOUBLE;
 typedef unsigned int UINT;
 #define ULONG UDWORD
 
 typedef float SFLOAT;
 typedef double SDOUBLE;
 typedef unsigned int UINT;
 #define ULONG UDWORD
 

+// Not available in iODBC
+#ifndef __WXMSW__
+typedef UCHAR SQLTCHAR;
+#endif
+

 #ifndef wxODBC_FWD_ONLY_CURSORS
 #define wxODBC_FWD_ONLY_CURSORS 1
 #endif
 #ifndef wxODBC_FWD_ONLY_CURSORS
 #define wxODBC_FWD_ONLY_CURSORS 1
 #endif


@@ -105,10 +112,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))
 
 #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
 #endif

+

 #ifndef SQL_C_ENUM
 #define SQL_C_ENUM (sizeof(enumDummy) == 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
 #ifndef SQL_C_BLOB
     #ifdef SQL_LONGVARBINARY
         #define SQL_C_BLOB SQL_LONGVARBINARY


@@ -116,20 +126,19 @@ enum enumDummy {enumDum1};
         #define SQL_C_BLOB SQL_VARBINARY
     #endif
 #endif
         #define SQL_C_BLOB SQL_VARBINARY
     #endif
 #endif

-
+/*

 #ifndef TRUE
 #ifndef TRUE

-#define TRUE 1
+#define TRUE true

 #endif
 
 #ifndef FALSE
 #endif
 
 #ifndef FALSE

-#define FALSE 0
+#define FALSE false

 #endif
 #endif

-
+*/

 const int wxDB_PATH_MAX                 = 254;
 
 const int wxDB_PATH_MAX                 = 254;
 

-extern wxChar const *SQL_LOG_FILENAME;
-extern wxChar const *SQL_CATALOG_FILENAME;
-
+WXDLLIMPEXP_DATA_ODBC(extern wxChar const *) SQL_LOG_FILENAME;
+WXDLLIMPEXP_DATA_ODBC(extern wxChar const *) SQL_CATALOG_FILENAME;

 
 // Database Globals
 const int DB_TYPE_NAME_LEN            = 40;
 
 // Database Globals
 const int DB_TYPE_NAME_LEN            = 40;


@@ -274,16 +283,16 @@ enum wxODBC_ERRORS
 #define SQL_MAX_AUTHSTR_LEN MAXNAME
 #endif
 
 #define SQL_MAX_AUTHSTR_LEN MAXNAME
 #endif
 

-class WXDLLEXPORT wxDbConnectInf
+class WXDLLIMPEXP_ODBC wxDbConnectInf

 {
     private:
         bool freeHenvOnDestroy;
 
     public:
 {
     private:
         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
 
         wxString Description;                              // Not sure what the max length is
         wxString FileType;                                 // Not sure what the max length is


@@ -336,10 +345,10 @@ class WXDLLEXPORT wxDbConnectInf
 };  // class wxDbConnectInf
 
 
 };  // class wxDbConnectInf
 
 

-struct WXDLLEXPORT wxDbSqlTypeInfo
+struct WXDLLIMPEXP_ODBC wxDbSqlTypeInfo

 {
     wxString    TypeName;
 {
     wxString    TypeName;

-    int         FsqlType;
+    SWORD       FsqlType;

     long        Precision;
     short       CaseSensitive;
 //    short     MinimumScale;
     long        Precision;
     short       CaseSensitive;
 //    short     MinimumScale;


@@ -347,7 +356,7 @@ struct WXDLLEXPORT wxDbSqlTypeInfo
 };
 
 
 };
 
 

-class WXDLLEXPORT wxDbColFor
+class WXDLLIMPEXP_ODBC wxDbColFor

 {
 public:
     wxString       s_Field;              // Formated String for Output
 {
 public:
     wxString       s_Field;              // Formated String for Output


@@ -366,7 +375,7 @@ public:
 };
 
 
 };
 
 

-class WXDLLEXPORT wxDbColInf
+class WXDLLIMPEXP_ODBC wxDbColInf

 {
 public:
     wxChar       catalog[128+1];
 {
 public:
     wxChar       catalog[128+1];


@@ -396,15 +405,13 @@ public:
 };
 
 
 };
 
 

-
-
-class WXDLLEXPORT wxDbTableInf        // Description of a Table
+class WXDLLIMPEXP_ODBC 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];
 {
 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();
     wxDbColInf *pColInf;                    // pColInf = NULL ; User can later call GetColumns(..);
 
     wxDbTableInf();


@@ -414,7 +421,7 @@ public:
 };
 
 
 };
 
 

-class WXDLLEXPORT wxDbInf     // Description of a Database
+class WXDLLIMPEXP_ODBC wxDbInf     // Description of a Database

 {
 public:
     wxChar        catalog[128+1];
 {
 public:
     wxChar        catalog[128+1];


@@ -452,7 +459,9 @@ enum wxDBMS
     dbmsINFORMIX,
     dbmsVIRTUOSO,
     dbmsDB2,
     dbmsINFORMIX,
     dbmsVIRTUOSO,
     dbmsDB2,

-    dbmsINTERBASE
+    dbmsINTERBASE,
+    dbmsPERVASIVE_SQL,
+    dbmsXBASE_SEQUITER

 };
 
 
 };
 
 


@@ -463,13 +472,16 @@ enum wxDBMS
 // why the connection failed.  Note: as each wxDb object is closed, it
 // will overwrite the errors of the previously destroyed wxDb object in
 // this variable.
 // why the connection failed.  Note: as each wxDb object is closed, it
 // will overwrite the errors of the previously destroyed wxDb object in
 // this variable.

-extern wxChar DBerrorList[DB_MAX_ERROR_HISTORY][DB_MAX_ERROR_MSG_LEN];
+
+WXDLLIMPEXP_DATA_BASE(extern wxChar)
+    DBerrorList[DB_MAX_ERROR_HISTORY][DB_MAX_ERROR_MSG_LEN];

 
 
 
 

-class WXDLLEXPORT wxDb
+class WXDLLIMPEXP_ODBC wxDb

 {
 private:
     bool             dbIsOpen;
 {
 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)
     wxString         dsn;             // Data source name
     wxString         uid;             // User ID
     wxString         authStr;         // Authorization string (password)


@@ -479,7 +491,7 @@ private:
     wxDBMS           dbmsType;        // Type of datasource - i.e. Oracle, dBase, SQLServer, etc
 
     // Private member functions
     wxDBMS           dbmsType;        // Type of datasource - i.e. Oracle, dBase, SQLServer, etc
 
     // Private member functions

-    bool             getDbInfo(void);
+    bool             getDbInfo(bool failOnDataTypeUnsupported = TRUE);

     bool             getDataTypeInfo(SWORD fSqlType, wxDbSqlTypeInfo &structSQLTypeInfo);
     bool             setConnectionOptions(void);
     void             logError(const wxString &errMsg, const wxString &SQLState);
     bool             getDataTypeInfo(SWORD fSqlType, wxDbSqlTypeInfo &structSQLTypeInfo);
     bool             setConnectionOptions(void);
     void             logError(const wxString &errMsg, const wxString &SQLState);


@@ -513,6 +525,9 @@ private:
 
 public:
 
 
 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); }
 
     bool             GetDataTypeInfo(SWORD fSqlType, wxDbSqlTypeInfo &structSQLTypeInfo)
                             { return getDataTypeInfo(fSqlType, structSQLTypeInfo); }
 


@@ -590,8 +605,10 @@ public:
 
     // Public member functions
     wxDb(const HENV &aHenv, bool FwdOnlyCursors=(bool)wxODBC_FWD_ONLY_CURSORS);
 
     // 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
+    // Data Source Name, User ID, Password and whether open should fail on data type not supported
+    bool         Open(const wxString &Dsn, const wxString &Uid, const wxString &AuthStr, bool failOnDataTypeUnsupported=TRUE);

     bool         Open(wxDbConnectInf *dbConnectInf);
     bool         Open(wxDb *copyDb);  // pointer to a wxDb whose connection info should be copied rather than re-queried
     void         Close(void);
     bool         Open(wxDbConnectInf *dbConnectInf);
     bool         Open(wxDb *copyDb);  // pointer to a wxDb whose connection info should be copied rather than re-queried
     void         Close(void);


@@ -609,10 +626,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          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(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;}
 
     int             GetColumnCount(const wxString &tableName, const wxChar *userID=NULL);
     const wxChar   *GetDatabaseName(void)  {return dbInf.dbmsName;}


@@ -638,6 +655,14 @@ public:
                                  const wxChar *userID=NULL, const wxChar *schema=NULL, 
                                  const wxString &path=wxEmptyString);
 
                                  const wxChar *userID=NULL, const wxChar *schema=NULL, 
                                  const wxString &path=wxEmptyString);
 

+    // These two functions return the table name or column name in a form ready
+    // for use in SQL statements.  For example, if the datasource allows spaces
+    // in the table name or column name, the returned string will have the
+    // correct enclosing marks around the name to allow it to be properly 
+    // included in a SQL statement
+    const wxString  SQLTableName(const wxChar *tableName);
+    const wxString  SQLColumnName(const wxChar *colName);
+

     void         LogError(const wxString &errMsg, const wxString &SQLState = wxEmptyString) 
                         { logError(errMsg, SQLState); }
     void         SetDebugErrorMessages(bool state) { silent = !state; }
     void         LogError(const wxString &errMsg, const wxString &SQLState = wxEmptyString) 
                         { logError(errMsg, SQLState); }
     void         SetDebugErrorMessages(bool state) { silent = !state; }


@@ -691,14 +716,24 @@ class wxTablesInUse : public wxObject
 // The following routines allow a user to get new database connections, free them
 // for other code segments to use, or close all of them when the application has
 // completed.
 // The following routines allow a user to get new database connections, free them
 // for other code segments to use, or close all of them when the application has
 // completed.

-wxDb  WXDLLEXPORT *wxDbGetConnection(wxDbConnectInf *pDbConfig, bool FwdOnlyCursors=(bool)wxODBC_FWD_ONLY_CURSORS);
-bool  WXDLLEXPORT  wxDbFreeConnection(wxDb *pDb);
-void  WXDLLEXPORT  wxDbCloseConnections(void);
-int   WXDLLEXPORT  wxDbConnectionsInUse(void);
+wxDb  WXDLLIMPEXP_ODBC *wxDbGetConnection(wxDbConnectInf *pDbConfig, bool FwdOnlyCursors=(bool)wxODBC_FWD_ONLY_CURSORS);
+bool  WXDLLIMPEXP_ODBC  wxDbFreeConnection(wxDb *pDb);
+void  WXDLLIMPEXP_ODBC  wxDbCloseConnections(void);
+int   WXDLLIMPEXP_ODBC  wxDbConnectionsInUse(void);
+
+
+// Writes a message to the wxLog window (stdout usually) when an internal error
+// situation occurs.  This function only works in DEBUG builds
+const wxChar WXDLLIMPEXP_ODBC *
+wxDbLogExtendedErrorMsg(const wxChar *userText,
+                        wxDb *pDb,
+                        const wxChar *ErrFile,
+                        int ErrLine);

 
 
 // This function sets the sql log state for all open wxDb objects
 
 
 // This function sets the sql log state for all open wxDb objects

-bool wxDbSqlLog(wxDbSqlLogState state, const wxString &filename = SQL_LOG_FILENAME);
+bool WXDLLIMPEXP_ODBC
+wxDbSqlLog(wxDbSqlLogState state, const wxString &filename = SQL_LOG_FILENAME);

 
 
 #if 0
 
 
 #if 0


@@ -711,8 +746,9 @@ int WXDLLEXPORT wxDbCreateDataSource(const wxString &driverName, const wxString
 // for a list of available datasources.  Call this routine
 // the first time using SQL_FETCH_FIRST.  Continue to call it
 // using SQL_FETCH_NEXT until you've exhausted the list.
 // for a list of available datasources.  Call this routine
 // the first time using SQL_FETCH_FIRST.  Continue to call it
 // using SQL_FETCH_NEXT until you've exhausted the list.

-bool WXDLLEXPORT wxDbGetDataSource(HENV henv, wxChar *Dsn, SWORD DsnMax, wxChar *DsDesc,
-                                   SWORD DsDescMax, UWORD direction = SQL_FETCH_NEXT);
+bool WXDLLIMPEXP_ODBC
+wxDbGetDataSource(HENV henv, wxChar *Dsn, SWORD DsnMax, wxChar *DsDesc,
+                  SWORD DsDescMax, UWORD direction = SQL_FETCH_NEXT);

 
 
 // Change this to 0 to remove use of all deprecated functions
 
 
 // Change this to 0 to remove use of all deprecated functions


@@ -743,15 +779,19 @@ typedef wxTablesInUse        CstructTablesInUse;
 #endif
 
 // Deprecated function names that are replaced by the function names listed above
 #endif
 
 // Deprecated function names that are replaced by the function names listed above

-wxDB  WXDLLEXPORT *GetDbConnection(DbStuff *pDbStuff, bool FwdOnlyCursors=(bool)wxODBC_FWD_ONLY_CURSORS);
-bool  WXDLLEXPORT  FreeDbConnection(wxDB *pDb);
-void  WXDLLEXPORT  CloseDbConnections(void);
-int   WXDLLEXPORT  NumberDbConnectionsInUse(void);
+wxDB  WXDLLIMPEXP_ODBC
+*GetDbConnection(DbStuff *pDbStuff, bool FwdOnlyCursors=(bool)wxODBC_FWD_ONLY_CURSORS);
+bool  WXDLLIMPEXP_ODBC  FreeDbConnection(wxDB *pDb);
+void  WXDLLIMPEXP_ODBC  CloseDbConnections(void);
+int   WXDLLIMPEXP_ODBC  NumberDbConnectionsInUse(void);
+
+bool SqlLog(sqlLog state, const wxChar *filename = SQL_LOG_FILENAME);

 
 

-bool SqlLog(sqlLog state, const char *filename = SQL_LOG_FILENAME);
+bool WXDLLIMPEXP_ODBC
+GetDataSource(HENV henv, char *Dsn, SWORD DsnMax, char *DsDesc, SWORD DsDescMax,
+              UWORD direction = SQL_FETCH_NEXT);

 
 

-bool WXDLLEXPORT GetDataSource(HENV henv, char *Dsn, SWORD DsnMax, char *DsDesc, SWORD DsDescMax,
-                               UWORD direction = SQL_FETCH_NEXT);

 #endif  // Deprecated structures/classes/functions
 
 #endif  // Deprecated structures/classes/functions
 

-#endif
+#endif // _WX_DB_H_
+