Removed some commented-out code

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

diff --git a/include/wx/db.h b/include/wx/db.h
index 86fa70404ca19c141535ee5956d0cbba474484c3..8cd409a0ce972ac09cac71f97f123935d165ba20 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.
@@ -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 
@@ -48,28 +43,47 @@
 
 #include "wx/version.h"
 
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(__APPLE__)
     #pragma interface "db.h"
 #endif
 
 #include "wx/setup.h"
 
-extern "C" {
+#include "wx/defs.h"
+#include "wx/string.h"
+
 #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"
 #else
-    #include "wx/isql.h"
-    #include "wx/isqlext.h"
+    // Use the ones from the library
+    extern "C" {
+        #include <sql.h>
+        #include <sqlext.h>
+    }
 #endif
-}
+
 
 typedef float SFLOAT;
 typedef double SDOUBLE;
@@ -109,9 +123,8 @@ enum enumDummy {enumDum1};
 */
 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;
@@ -433,7 +446,8 @@ enum wxDBMS
     dbmsVIRTUOSO,
     dbmsDB2,
     dbmsINTERBASE,
-    dbmsPERVASIVE_SQL
+    dbmsPERVASIVE_SQL,
+    dbmsXBASE_SEQUITER
 };
 
 
@@ -444,7 +458,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.
-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
@@ -577,7 +592,8 @@ public:
     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);
@@ -624,6 +640,14 @@ public:
                                  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; }
@@ -683,12 +707,13 @@ 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
+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);
@@ -741,10 +766,11 @@ bool  WXDLLEXPORT  FreeDbConnection(wxDB *pDb);
 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
 
-#endif
+#endif // _WX_DB_H_
+