added GetHimagelist()

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

diff --git a/include/wx/db.h b/include/wx/db.h
index 60a301d782ed93c5e30321c0bb1362d788d4491e..63ab1a66c71e62905b5e735c13f383ff52f32ba6 100644 (file)
--- a/include/wx/db.h
+++ b/include/wx/db.h
@@ -19,40 +19,26 @@
 // Created:     9.96
 // RCS-ID:      $Id$
 // Copyright:   (c) 1996 Remstar International, Inc.
 // Created:     9.96
 // RCS-ID:      $Id$
 // Copyright:   (c) 1996 Remstar International, Inc.

-// Licence:     wxWidgets licence, plus:
-// 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
-//                 wxWidgets-based application
-//              2) All enhancements and bug fixes are to be submitted back to the wxWidgets
-//                 user groups free of all charges for use with the wxWidgets library.
-//              3) These classes may not be distributed as part of any other class library,
-//                 DLL, text (written or electronic), other than a complete distribution of
-//                 the wxWidgets GUI development toolkit.
-//
+// Licence:     wxWindows licence

 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_DB_H_
 #define _WX_DB_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

 //               return columns in the order they were created
 #define OLD_GETCOLUMNS 1
 #define EXPERIMENTAL_WXDB_FUNCTIONS 1
 
 //               return columns in the order they were created
 #define OLD_GETCOLUMNS 1
 #define EXPERIMENTAL_WXDB_FUNCTIONS 1
 

-#include "wx/version.h"
-

 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
     #pragma interface "db.h"
 #endif
 
 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
     #pragma interface "db.h"
 #endif
 

-#include "wx/setup.h"
-

 #include "wx/defs.h"
 #include "wx/string.h"
 
 #include "wx/defs.h"
 #include "wx/string.h"
 

-#if defined(__VISUALC__) 
+#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
     // 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


@@ -75,6 +61,9 @@
     //
     #include "sql.h"
     #include "sqlext.h"
     //
     #include "sql.h"
     #include "sqlext.h"

+    //#if wxUSE_UNICODE
+    //    #include <sqlucode.h>
+    //#endif

     #include "odbcinst.h"
 #else
     #if defined(__WINDOWS__) && ( defined(HAVE_W32API_H) || defined(__BORLANDC__) )
     #include "odbcinst.h"
 #else
     #if defined(__WINDOWS__) && ( defined(HAVE_W32API_H) || defined(__BORLANDC__) )


@@ -86,24 +75,31 @@
         // Use the ones from the library
         #include "wx/isql.h"
         #include "wx/isqlext.h"
         // Use the ones from the library
         #include "wx/isql.h"
         #include "wx/isqlext.h"

+        // Not available in v2.x of iODBC
+        #ifndef __WXMSW__
+            typedef wxChar SQLTCHAR;
+        #endif

     #else
         #include <sql.h>
         #include <sqlext.h>
     #else
         #include <sql.h>
         #include <sqlext.h>

+        //#if wxUSE_UNICODE
+        //    #include <sqlucode.h>
+        //#endif

     #endif
     }
 #endif
 
     #endif
     }
 #endif
 

+#if wxUSE_UNICODE
+#define SQL_C_WXCHAR SQL_C_WCHAR
+#else
+#define SQL_C_WXCHAR SQL_C_CHAR
+#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


@@ -128,8 +124,8 @@ enum enumDummy {enumDum1};
 
 const int wxDB_PATH_MAX                 = 254;
 
 
 const int wxDB_PATH_MAX                 = 254;
 

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

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


@@ -303,8 +299,8 @@ class WXDLLIMPEXP_ODBC wxDbConnectInf
     public:
 
         wxDbConnectInf();
     public:
 
         wxDbConnectInf();

-        wxDbConnectInf(HENV henv, const wxString &dsn, const wxString &userID=wxEmptyString, 
-                       const wxString &password=wxEmptyString, const wxString &defaultDir=wxEmptyString, 
+        wxDbConnectInf(HENV henv, const wxString &dsn, const wxString &userID=wxEmptyString,
+                       const wxString &password=wxEmptyString, const wxString &defaultDir=wxEmptyString,

                        const wxString &description=wxEmptyString, const wxString &fileType=wxEmptyString);
 
         ~wxDbConnectInf();
                        const wxString &description=wxEmptyString, const wxString &fileType=wxEmptyString);
 
         ~wxDbConnectInf();


@@ -372,10 +368,10 @@ public:
     SWORD          i_sqlDataType;
 
     wxDbColFor();
     SWORD          i_sqlDataType;
 
     wxDbColFor();

-    ~wxDbColFor();
+    ~wxDbColFor(){}

 
     void           Initialize();
 
     void           Initialize();

-    int            Format(int Nation, int dbDataType, SWORD sqlDataType, short columnSize, short decimalDigits);
+    int            Format(int Nation, int dbDataType, SWORD sqlDataType, short columnLength, short decimalDigits);

 };
 
 
 };
 
 


@@ -388,8 +384,8 @@ public:
     wxChar       colName[DB_MAX_COLUMN_NAME_LEN+1];
     SWORD        sqlDataType;
     wxChar       typeName[128+1];
     wxChar       colName[DB_MAX_COLUMN_NAME_LEN+1];
     SWORD        sqlDataType;
     wxChar       typeName[128+1];

-    SWORD        columnSize;
-    SWORD        bufferLength;
+    SWORD        columnLength;
+    SWORD        bufferSize;

     short        decimalDigits;
     short        numPrecRadix;
     short        nullable;
     short        decimalDigits;
     short        numPrecRadix;
     short        nullable;


@@ -465,7 +461,19 @@ enum wxDBMS
     dbmsDB2,
     dbmsINTERBASE,
     dbmsPERVASIVE_SQL,
     dbmsDB2,
     dbmsINTERBASE,
     dbmsPERVASIVE_SQL,

-    dbmsXBASE_SEQUITER
+    dbmsXBASE_SEQUITER,
+    dbmsFIREBIRD,
+    dbmsMAXDB,
+    dbmsFuture1,
+    dbmsFuture2,
+    dbmsFuture3,
+    dbmsFuture4,
+    dbmsFuture5,
+    dbmsFuture6,
+    dbmsFuture7,
+    dbmsFuture8,
+    dbmsFuture9,
+    dbmsFuture10

 };
 
 
 };
 
 


@@ -477,8 +485,8 @@ enum wxDBMS
 // will overwrite the errors of the previously destroyed wxDb object in
 // this variable.
 
 // will overwrite the errors of the previously destroyed wxDb object in
 // this variable.
 

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

 
 
 class WXDLLIMPEXP_ODBC wxDb
 
 
 class WXDLLIMPEXP_ODBC wxDb


@@ -498,13 +506,14 @@ 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(bool failOnDataTypeUnsupported=TRUE);
+    bool             getDbInfo(bool failOnDataTypeUnsupported=true);

     bool             getDataTypeInfo(SWORD fSqlType, wxDbSqlTypeInfo &structSQLTypeInfo);
     bool             setConnectionOptions(void);
     void             logError(const wxString &errMsg, const wxString &SQLState);
     const wxChar    *convertUserID(const wxChar *userID, wxString &UserID);
     bool             getDataTypeInfo(SWORD fSqlType, wxDbSqlTypeInfo &structSQLTypeInfo);
     bool             setConnectionOptions(void);
     void             logError(const wxString &errMsg, const wxString &SQLState);
     const wxChar    *convertUserID(const wxChar *userID, wxString &UserID);

+    bool             determineDataTypes(bool failOnDataTypeUnsupported);

     void             initialize();
     void             initialize();

-    bool             open(bool failOnDataTypeUnsupported=TRUE);
+    bool             open(bool failOnDataTypeUnsupported=true);

 
 #if !wxODBC_BACKWARD_COMPATABILITY
     // ODBC handles
 
 #if !wxODBC_BACKWARD_COMPATABILITY
     // ODBC handles


@@ -592,7 +601,13 @@ public:
     // ODBC Error Inf.
     SWORD  cbErrorMsg;
     int    DB_STATUS;
     // ODBC Error Inf.
     SWORD  cbErrorMsg;
     int    DB_STATUS;

+#ifdef __VMS
+   // The DECC compiler chokes when in db.cpp the array is accessed outside
+   // its bounds. Maybe this change should also applied for other platforms.
+    wxChar errorList[DB_MAX_ERROR_HISTORY][DB_MAX_ERROR_MSG_LEN+1];
+#else

     wxChar errorList[DB_MAX_ERROR_HISTORY][DB_MAX_ERROR_MSG_LEN];
     wxChar errorList[DB_MAX_ERROR_HISTORY][DB_MAX_ERROR_MSG_LEN];

+#endif

     wxChar errorMsg[SQL_MAX_MESSAGE_LENGTH];
     SDWORD nativeError;
     wxChar sqlState[20];
     wxChar errorMsg[SQL_MAX_MESSAGE_LENGTH];
     SDWORD nativeError;
     wxChar sqlState[20];


@@ -616,9 +631,9 @@ public:
     ~wxDb();
 
     // Data Source Name, User ID, Password and whether open should fail on data type not supported
     ~wxDb();
 
     // Data Source Name, User ID, Password and whether open should fail on data type not supported

-    bool         Open(const wxString& inConnectStr, bool failOnDataTypeUnsupported=TRUE);
-    bool         Open(const wxString &Dsn, const wxString &Uid, const wxString &AuthStr, bool failOnDataTypeUnsupported=TRUE);
-    bool         Open(wxDbConnectInf *dbConnectInf, bool failOnDataTypeUnsupported=TRUE);
+    bool         Open(const wxString& inConnectStr, bool failOnDataTypeUnsupported=true);
+    bool         Open(const wxString &Dsn, const wxString &Uid, const wxString &AuthStr, bool failOnDataTypeUnsupported=true);
+    bool         Open(wxDbConnectInf *dbConnectInf, bool failOnDataTypeUnsupported=true);

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


@@ -626,9 +641,10 @@ public:
     bool         DispAllErrors(HENV aHenv, HDBC aHdbc = SQL_NULL_HDBC, HSTMT aHstmt = SQL_NULL_HSTMT);
     bool         GetNextError(HENV aHenv, HDBC aHdbc = SQL_NULL_HDBC, HSTMT aHstmt = SQL_NULL_HSTMT);
     void         DispNextError(void);
     bool         DispAllErrors(HENV aHenv, HDBC aHdbc = SQL_NULL_HDBC, HSTMT aHstmt = SQL_NULL_HSTMT);
     bool         GetNextError(HENV aHenv, HDBC aHdbc = SQL_NULL_HDBC, HSTMT aHstmt = SQL_NULL_HSTMT);
     void         DispNextError(void);

-    bool         CreateView(const wxString &viewName, const wxString &colList, const wxString &pSqlStmt, bool attemptDrop=TRUE);
+    bool         CreateView(const wxString &viewName, const wxString &colList, const wxString &pSqlStmt, bool attemptDrop=true);

     bool         DropView(const wxString &viewName);
     bool         ExecSql(const wxString &pSqlStmt);
     bool         DropView(const wxString &viewName);
     bool         ExecSql(const wxString &pSqlStmt);

+    bool         ExecSql(const wxString &pSqlStmt, wxDbColInf** columns, short& numcols);

     bool         GetNext(void);
     bool         GetData(UWORD colNo, SWORD cType, PTR pData, SDWORD maxLen, SDWORD FAR *cbReturned);
     bool         Grant(int privileges, const wxString &tableName, const wxString &userList = wxT("PUBLIC"));
     bool         GetNext(void);
     bool         GetData(UWORD colNo, SWORD cType, PTR pData, SDWORD maxLen, SDWORD FAR *cbReturned);
     bool         Grant(int privileges, const wxString &tableName, const wxString &userList = wxT("PUBLIC"));


@@ -638,7 +654,7 @@ public:
     int          GetKeyFields(const wxString &tableName, wxDbColInf* colInf, UWORD noCols);
 
     wxDbColInf  *GetColumns(wxChar *tableName[], const wxChar *userID=NULL);
     int          GetKeyFields(const wxString &tableName, wxDbColInf* colInf, UWORD noCols);
 
     wxDbColInf  *GetColumns(wxChar *tableName[], const wxChar *userID=NULL);

-    wxDbColInf  *GetColumns(const wxString &tableName, UWORD *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;}


@@ -661,25 +677,25 @@ public:
     wxDbSqlTypeInfo GetTypeInfBlob()       {return typeInfBlob;}
 
     // tableName can refer to a table, view, alias or synonym
     wxDbSqlTypeInfo GetTypeInfBlob()       {return typeInfBlob;}
 
     // tableName can refer to a table, view, alias or synonym

-    bool         TableExists(const wxString &tableName, const wxChar *userID=NULL, 
+    bool         TableExists(const wxString &tableName, const wxChar *userID=NULL,

                              const wxString &tablePath=wxEmptyString);
                              const wxString &tablePath=wxEmptyString);

-    bool         TablePrivileges(const wxString &tableName, const wxString &priv, 
-                                 const wxChar *userID=NULL, const wxChar *schema=NULL, 
+    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
                                  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 
+    // 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);
 
     // 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) 
+    void         LogError(const wxString &errMsg, const wxString &SQLState = wxEmptyString)

                         { logError(errMsg, SQLState); }
     void         SetDebugErrorMessages(bool state) { silent = !state; }
                         { logError(errMsg, SQLState); }
     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);
 
     wxDBMS       Dbms(void);
     bool         WriteSqlLog(const wxString &logMsg);
 
     wxDBMS       Dbms(void);


@@ -752,7 +768,7 @@ wxDbSqlLog(wxDbSqlLogState state, const wxString &filename = SQL_LOG_FILENAME);
 #if 0
 // MSW/VC6 ONLY!!!  Experimental
 int WXDLLEXPORT wxDbCreateDataSource(const wxString &driverName, const wxString &dsn, const wxString &description=wxEmptyString,
 #if 0
 // MSW/VC6 ONLY!!!  Experimental
 int WXDLLEXPORT wxDbCreateDataSource(const wxString &driverName, const wxString &dsn, const wxString &description=wxEmptyString,

-                                     bool sysDSN=FALSE, const wxString &defDir=wxEmptyString, wxWindow *parent=NULL);
+                                     bool sysDSN=false, const wxString &defDir=wxEmptyString, wxWindow *parent=NULL);

 #endif
 
 // This routine allows you to query a driver manager
 #endif
 
 // This routine allows you to query a driver manager


@@ -760,8 +776,8 @@ int WXDLLEXPORT wxDbCreateDataSource(const wxString &driverName, const wxString
 // the first time using SQL_FETCH_FIRST.  Continue to call it
 // using SQL_FETCH_NEXT until you've exhausted the list.
 bool WXDLLIMPEXP_ODBC
 // the first time using SQL_FETCH_FIRST.  Continue to call it
 // using SQL_FETCH_NEXT until you've exhausted the list.
 bool WXDLLIMPEXP_ODBC

-wxDbGetDataSource(HENV henv, wxChar *Dsn, SWORD DsnMax, wxChar *DsDesc,
-                  SWORD DsDescMax, UWORD direction = SQL_FETCH_NEXT);
+wxDbGetDataSource(HENV henv, wxChar *Dsn, SWORD DsnMaxLength, wxChar *DsDesc,
+                  SWORD DsDescMaxLength, 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


@@ -801,7 +817,7 @@ int   WXDLLIMPEXP_ODBC  NumberDbConnectionsInUse(void);
 bool SqlLog(sqlLog state, const wxChar *filename = SQL_LOG_FILENAME);
 
 bool WXDLLIMPEXP_ODBC
 bool SqlLog(sqlLog state, const wxChar *filename = SQL_LOG_FILENAME);
 
 bool WXDLLIMPEXP_ODBC

-GetDataSource(HENV henv, char *Dsn, SWORD DsnMax, char *DsDesc, SWORD DsDescMax,
+GetDataSource(HENV henv, char *Dsn, SWORD DsnMaxLength, char *DsDesc, SWORD DsDescMaxLength,

               UWORD direction = SQL_FETCH_NEXT);
 
 #endif  // Deprecated structures/classes/functions
               UWORD direction = SQL_FETCH_NEXT);
 
 #endif  // Deprecated structures/classes/functions