added MSLU reference to wxUSE_UNICODE

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

diff --git a/include/wx/db.h b/include/wx/db.h
index 708d6d74b21760b6716371b5762453db2a9c24f8..ecb4f3ab6af410c37f29fd411c7b1dd0db2ad430 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 


@@ -48,28 +43,52 @@
 
 #include "wx/version.h"
 
 
 #include "wx/version.h"
 

-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(__APPLE__)

     #pragma interface "db.h"
 #endif
 
 #include "wx/setup.h"
 
     #pragma interface "db.h"
 #endif
 
 #include "wx/setup.h"
 

-extern "C" {
+#include "wx/defs.h"
+#include "wx/string.h"
+

 #ifdef __VISUALC__
 #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
-//
+    // 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"
     #include "sql.h"
     #include "sqlext.h"
     #include "odbcinst.h"

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

 #endif
 #endif

-}
+

 
 typedef float SFLOAT;
 typedef double SDOUBLE;
 
 typedef float SFLOAT;
 typedef double SDOUBLE;


@@ -98,7 +117,7 @@ enum enumDummy {enumDum1};
         #define SQL_C_BLOB SQL_VARBINARY
     #endif
 #endif
         #define SQL_C_BLOB SQL_VARBINARY
     #endif
 #endif

-
+/*

 #ifndef TRUE
 #define TRUE true
 #endif
 #ifndef TRUE
 #define TRUE true
 #endif


@@ -106,12 +125,11 @@ enum enumDummy {enumDum1};
 #ifndef FALSE
 #define FALSE false
 #endif
 #ifndef FALSE
 #define FALSE false
 #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;


@@ -433,7 +451,8 @@ enum wxDBMS
     dbmsVIRTUOSO,
     dbmsDB2,
     dbmsINTERBASE,
     dbmsVIRTUOSO,
     dbmsDB2,
     dbmsINTERBASE,

-    dbmsPERVASIVE_SQL
+    dbmsPERVASIVE_SQL,
+    dbmsXBASE_SEQUITER

 };
 
 
 };
 
 


@@ -444,7 +463,8 @@ 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
 
 
 class WXDLLEXPORT wxDb


@@ -577,7 +597,8 @@ public:
     wxDb(const HENV &aHenv, bool FwdOnlyCursors=(bool)wxODBC_FWD_ONLY_CURSORS);
     ~wxDb();
 
     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);


@@ -586,7 +607,7 @@ 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         GetNext(void);
     bool         DropView(const wxString &viewName);
     bool         ExecSql(const wxString &pSqlStmt);
     bool         GetNext(void);


@@ -600,7 +621,7 @@ public:
     wxDbColInf  *GetColumns(wxChar *tableName[], const wxChar *userID=NULL);
     wxDbColInf  *GetColumns(const wxString &tableName, UWORD *numCols, const wxChar *userID=NULL); 
 
     wxDbColInf  *GetColumns(wxChar *tableName[], const wxChar *userID=NULL);
     wxDbColInf  *GetColumns(const wxString &tableName, UWORD *numCols, const wxChar *userID=NULL); 
 

-    UWORD           GetColumnCount(const wxString &tableName, const wxChar *userID=NULL);
+    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 wxChar   *GetDatabaseName(void)  {return dbInf.dbmsName;}
     const wxString &GetDataSource(void)    {return dsn;}
     const wxString &GetDatasourceName(void){return dsn;}


@@ -624,11 +645,19 @@ 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; }
     bool         SetSqlLogging(wxDbSqlLogState state, const wxString &filename = SQL_LOG_FILENAME, 
     void         LogError(const wxString &errMsg, const wxString &SQLState = wxEmptyString) 
                         { logError(errMsg, SQLState); }
     void         SetDebugErrorMessages(bool state) { silent = !state; }
     bool         SetSqlLogging(wxDbSqlLogState state, const wxString &filename = SQL_LOG_FILENAME, 

-                               bool append = false);
+                               bool append = FALSE);

     bool         WriteSqlLog(const wxString &logMsg);
 
     wxDBMS       Dbms(void);
     bool         WriteSqlLog(const wxString &logMsg);
 
     wxDBMS       Dbms(void);


@@ -683,12 +712,13 @@ void  WXDLLEXPORT  wxDbCloseConnections(void);
 int   WXDLLEXPORT  wxDbConnectionsInUse(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
 // 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
+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
 bool  WXDLLEXPORT  wxDbSqlLog(wxDbSqlLogState state, const wxString &filename = SQL_LOG_FILENAME);
 
 // This function sets the sql log state for all open wxDb objects
 bool  WXDLLEXPORT  wxDbSqlLog(wxDbSqlLogState state, const wxString &filename = SQL_LOG_FILENAME);


@@ -697,7 +727,7 @@ bool  WXDLLEXPORT  wxDbSqlLog(wxDbSqlLogState state, const wxString &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


@@ -705,7 +735,7 @@ 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 WXDLLEXPORT wxDbGetDataSource(HENV henv, wxChar *Dsn, SWORD DsnMax, wxChar *DsDesc,
 // 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, DWORD direction = SQL_FETCH_NEXT);
+                                   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


@@ -741,10 +771,11 @@ bool  WXDLLEXPORT  FreeDbConnection(wxDB *pDb);
 void  WXDLLEXPORT  CloseDbConnections(void);
 int   WXDLLEXPORT  NumberDbConnectionsInUse(void);
 
 void  WXDLLEXPORT  CloseDbConnections(void);
 int   WXDLLEXPORT  NumberDbConnectionsInUse(void);
 

-bool SqlLog(sqlLog state, const char *filename = SQL_LOG_FILENAME);
+bool SqlLog(sqlLog state, const wxChar *filename = SQL_LOG_FILENAME);

 
 bool WXDLLEXPORT GetDataSource(HENV henv, char *Dsn, SWORD DsnMax, char *DsDesc, SWORD DsDescMax,
                                UWORD direction = SQL_FETCH_NEXT);
 #endif  // Deprecated structures/classes/functions
 
 
 bool WXDLLEXPORT GetDataSource(HENV henv, char *Dsn, SWORD DsnMax, char *DsDesc, SWORD DsDescMax,
                                UWORD direction = SQL_FETCH_NEXT);
 #endif  // Deprecated structures/classes/functions
 

-#endif
+#endif // _WX_DB_H_
+