no changes (0 -> NULL)

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

diff --git a/include/wx/db.h b/include/wx/db.h
index 8f8606137484ded8f2b68d9716f7507cee7d5303..16d239a63b75f52a8192178a6083cc2a6232b3ae 100644 (file)
--- a/include/wx/db.h
+++ b/include/wx/db.h
@@ -46,22 +46,28 @@
 #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
+#ifdef __GNUG__
+    #pragma interface "db.h"

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

-#if wxMAJOR_VERSION == 2
-    extern "C" {
+#include "wx/defs.h"
+#include "wx/string.h"
+

 #ifdef __VISUALC__
 #ifdef __VISUALC__

+// include standard Windows headers
+#if defined(__WXMSW__) && !wxUSE_MFC
+    #ifndef STRICT
+        #define STRICT 1
+    #endif
+
+    #include <windows.h>
+    #include "wx/msw/winundef.h"
+#endif
+

 // 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
 // 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


@@ -71,26 +77,19 @@
     #include "sql.h"
     #include "sqlext.h"
     #include "odbcinst.h"
     #include "sql.h"
     #include "sqlext.h"
     #include "odbcinst.h"

+#elif defined( __VMS )
+// For OpenVMS use the ones from the library
+extern "C" {
+    #include <isql.h>
+    #include <isqlext.h>
+}

 #else
 #else

+extern "C" {

     #include "wx/isql.h"
     #include "wx/isqlext.h"
     #include "wx/isql.h"
     #include "wx/isqlext.h"

+}

 #endif
 #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;
 
 typedef float SFLOAT;
 typedef double SDOUBLE;


@@ -103,24 +102,35 @@ typedef unsigned int UINT;
 
 enum enumDummy {enumDum1};
 
 
 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(datatype) (sizeof(datatype) == 1 ? SQL_C_UTINYINT : (sizeof(datatype) == 2 ? SQL_C_USHORT : SQL_C_ULONG))

-//    #define SQL_C_BOOLEAN (sizeof(Bool) == 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)
 #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
+    #elif SQL_VARBINARY
+        #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;
-
+WXDLLEXPORT_DATA(extern wxChar const *) SQL_LOG_FILENAME;
+WXDLLEXPORT_DATA(extern wxChar const *) SQL_CATALOG_FILENAME;

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


@@ -135,6 +145,7 @@ const int DB_DATA_TYPE_VARCHAR        = 1;
 const int DB_DATA_TYPE_INTEGER        = 2;
 const int DB_DATA_TYPE_FLOAT          = 3;
 const int DB_DATA_TYPE_DATE           = 4;
 const int DB_DATA_TYPE_INTEGER        = 2;
 const int DB_DATA_TYPE_FLOAT          = 3;
 const int DB_DATA_TYPE_DATE           = 4;

+const int DB_DATA_TYPE_BLOB           = 5;

 
 const int DB_SELECT_KEYFIELDS         = 1;
 const int DB_SELECT_WHERE             = 2;
 
 const int DB_SELECT_KEYFIELDS         = 1;
 const int DB_SELECT_WHERE             = 2;


@@ -264,16 +275,16 @@ enum wxODBC_ERRORS
 #define SQL_MAX_AUTHSTR_LEN MAXNAME
 #endif
 
 #define SQL_MAX_AUTHSTR_LEN MAXNAME
 #endif
 

-class wxDbConnectInf
+class WXDLLEXPORT 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


@@ -326,10 +337,10 @@ class wxDbConnectInf
 };  // class wxDbConnectInf
 
 
 };  // class wxDbConnectInf
 
 

-struct wxDbSqlTypeInfo
+struct WXDLLEXPORT wxDbSqlTypeInfo

 {
     wxString    TypeName;
 {
     wxString    TypeName;

-    int         FsqlType;
+    SWORD       FsqlType;

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


@@ -386,15 +397,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];
 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();
     wxDbColInf *pColInf;                    // pColInf = NULL ; User can later call GetColumns(..);
 
     wxDbTableInf();


@@ -442,7 +451,8 @@ enum wxDBMS
     dbmsINFORMIX,
     dbmsVIRTUOSO,
     dbmsDB2,
     dbmsINFORMIX,
     dbmsVIRTUOSO,
     dbmsDB2,

-    dbmsINTERBASE
+    dbmsINTERBASE,
+    dbmsPERVASIVE_SQL

 };
 
 
 };
 
 


@@ -453,13 +463,15 @@ 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];
+
+WXDLLEXPORT_DATA(extern wxChar) DBerrorList[DB_MAX_ERROR_HISTORY][DB_MAX_ERROR_MSG_LEN];

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


@@ -498,9 +510,17 @@ private:
     wxDbSqlTypeInfo typeInfInteger;
     wxDbSqlTypeInfo typeInfFloat;
     wxDbSqlTypeInfo typeInfDate;
     wxDbSqlTypeInfo typeInfInteger;
     wxDbSqlTypeInfo typeInfFloat;
     wxDbSqlTypeInfo typeInfDate;

+    wxDbSqlTypeInfo typeInfBlob;

 #endif
 
 public:
 #endif
 
 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); }
+

 #if wxODBC_BACKWARD_COMPATABILITY
     // ODBC handles
     HENV  henv;        // ODBC Environment handle
 #if wxODBC_BACKWARD_COMPATABILITY
     // ODBC handles
     HENV  henv;        // ODBC Environment handle


@@ -570,12 +590,15 @@ public:
     wxDbSqlTypeInfo typeInfInteger;
     wxDbSqlTypeInfo typeInfFloat;
     wxDbSqlTypeInfo typeInfDate;
     wxDbSqlTypeInfo typeInfInteger;
     wxDbSqlTypeInfo typeInfFloat;
     wxDbSqlTypeInfo typeInfDate;

+    wxDbSqlTypeInfo typeInfBlob;

 #endif
 
     // Public member functions
     wxDb(const HENV &aHenv, bool FwdOnlyCursors=(bool)wxODBC_FWD_ONLY_CURSORS);
 #endif
 
     // 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);


@@ -593,33 +616,50 @@ 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;}

     const wxString &GetDataSource(void)    {return dsn;}
     const wxString &GetDatasourceName(void){return dsn;}
     const wxString &GetUsername(void)      {return uid;}
     const wxString &GetPassword(void)      {return authStr;}
     const wxString &GetDataSource(void)    {return dsn;}
     const wxString &GetDatasourceName(void){return dsn;}
     const wxString &GetUsername(void)      {return uid;}
     const wxString &GetPassword(void)      {return authStr;}

-    bool         IsOpen(void)           {return dbIsOpen;}
-    HENV         GetHENV(void)          {return henv;}
-    HDBC         GetHDBC(void)          {return hdbc;}
-    HSTMT        GetHSTMT(void)         {return hstmt;}
-    int          GetTableCount()        {return nTables;};  // number of tables using this connection
-    wxDbSqlTypeInfo GetTypeInfVarchar() {return typeInfVarchar;}
-    wxDbSqlTypeInfo GetTypeInfInteger() {return typeInfInteger;}
-    wxDbSqlTypeInfo GetTypeInfFloat()   {return typeInfFloat;}
-    wxDbSqlTypeInfo GetTypeInfDate()    {return typeInfDate;}
-
-    bool         TableExists(const wxString &tableName, const wxChar *userID=NULL, const wxString &tablePath=wxEmptyString);  // tableName can refer to a table, view, alias or synonym
-    bool         TablePrivileges(const wxString &tableName, const wxString &priv, const wxChar *userID=NULL, const wxChar *schema=NULL, const wxString &path=wxEmptyString);  // tableName can refer to a table, view, alias or synonym
-    void         LogError(const wxString &errMsg, const wxString &SQLState = wxEmptyString) { logError(errMsg, SQLState); }
+    bool            IsOpen(void)           {return dbIsOpen;}
+    HENV            GetHENV(void)          {return henv;}
+    HDBC            GetHDBC(void)          {return hdbc;}
+    HSTMT           GetHSTMT(void)         {return hstmt;}
+    int             GetTableCount()        {return nTables;}  // number of tables using this connection
+    wxDbSqlTypeInfo GetTypeInfVarchar()    {return typeInfVarchar;}
+    wxDbSqlTypeInfo GetTypeInfInteger()    {return typeInfInteger;}
+    wxDbSqlTypeInfo GetTypeInfFloat()      {return typeInfFloat;}
+    wxDbSqlTypeInfo GetTypeInfDate()       {return typeInfDate;}
+    wxDbSqlTypeInfo GetTypeInfBlob()       {return typeInfBlob;}
+
+    // tableName can refer to a table, view, alias or synonym
+    bool         TableExists(const wxString &tableName, const wxChar *userID=NULL, 
+                             const wxString &tablePath=wxEmptyString);
+    bool         TablePrivileges(const wxString &tableName, const wxString &priv, 
+                                 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         SetDebugErrorMessages(bool state) { silent = !state; }

-    bool         SetSqlLogging(wxDbSqlLogState state, const wxString &filename = SQL_LOG_FILENAME, bool append = FALSE);
+    bool         SetSqlLogging(wxDbSqlLogState state, const wxString &filename = SQL_LOG_FILENAME, 
+                               bool append = FALSE);

     bool         WriteSqlLog(const wxString &logMsg);
     bool         WriteSqlLog(const wxString &logMsg);

+

     wxDBMS       Dbms(void);
     bool         ModifyColumn(const wxString &tableName, const wxString &columnName,
                               int dataType, ULONG columnLength=0,
     wxDBMS       Dbms(void);
     bool         ModifyColumn(const wxString &tableName, const wxString &columnName,
                               int dataType, ULONG columnLength=0,


@@ -672,8 +712,16 @@ void  WXDLLEXPORT  wxDbCloseConnections(void);
 int   WXDLLEXPORT  wxDbConnectionsInUse(void);
 
 
 int   WXDLLEXPORT  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 WXDLLEXPORT *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  WXDLLEXPORT  wxDbSqlLog(wxDbSqlLogState state, const wxString &filename = SQL_LOG_FILENAME);

 
 
 #if 0
 
 
 #if 0