X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a144affed28cbd6828dfbe8c17b4cac989e7a6b3..b3fcfa4d89d44425ed28050462c6064100fe7b05:/include/wx/db.h diff --git a/include/wx/db.h b/include/wx/db.h index 29efb2b3a6..58843cf23e 100644 --- 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,34 +43,67 @@ #include "wx/version.h" -#ifdef __GNUG__ +#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) #pragma interface "db.h" #endif #include "wx/setup.h" -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 + // directly when using MFC because it includes it itself in a + // different manner + #if wxUSE_MFC + #include + #else // !wxUSE_MFC + #ifndef STRICT + #define STRICT 1 + #endif + + #include + #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" + #if defined(__WINDOWS__) && ( defined(HAVE_W32API_H) || defined(__BORLANDC__) ) + #include + #include "wx/msw/winundef.h" + #endif + extern "C" { + #if defined(wxUSE_BUILTIN_IODBC) && wxUSE_BUILTIN_IODBC + // Use the ones from the library + #include "wx/isql.h" + #include "wx/isqlext.h" + #else + #include + #include + #endif + } #endif -} + 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 @@ -109,9 +137,8 @@ enum enumDummy {enumDum1}; */ 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; @@ -256,7 +283,7 @@ enum wxODBC_ERRORS #define SQL_MAX_AUTHSTR_LEN MAXNAME #endif -class WXDLLEXPORT wxDbConnectInf +class WXDLLIMPEXP_ODBC wxDbConnectInf { private: bool freeHenvOnDestroy; @@ -318,7 +345,7 @@ class WXDLLEXPORT wxDbConnectInf }; // class wxDbConnectInf -struct WXDLLEXPORT wxDbSqlTypeInfo +struct WXDLLIMPEXP_ODBC wxDbSqlTypeInfo { wxString TypeName; SWORD FsqlType; @@ -329,7 +356,7 @@ struct WXDLLEXPORT wxDbSqlTypeInfo }; -class WXDLLEXPORT wxDbColFor +class WXDLLIMPEXP_ODBC wxDbColFor { public: wxString s_Field; // Formated String for Output @@ -348,7 +375,7 @@ public: }; -class WXDLLEXPORT wxDbColInf +class WXDLLIMPEXP_ODBC wxDbColInf { public: wxChar catalog[128+1]; @@ -378,7 +405,7 @@ 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]; @@ -394,7 +421,7 @@ public: }; -class WXDLLEXPORT wxDbInf // Description of a Database +class WXDLLIMPEXP_ODBC wxDbInf // Description of a Database { public: wxChar catalog[128+1]; @@ -433,7 +460,8 @@ enum wxDBMS dbmsVIRTUOSO, dbmsDB2, dbmsINTERBASE, - dbmsPERVASIVE_SQL + dbmsPERVASIVE_SQL, + dbmsXBASE_SEQUITER }; @@ -444,10 +472,12 @@ 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]; +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; @@ -461,7 +491,7 @@ private: 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); @@ -577,7 +607,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); @@ -600,7 +631,7 @@ public: 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;} @@ -624,6 +655,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; } @@ -677,21 +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. -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); -//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 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 -bool WXDLLEXPORT wxDbSqlLog(wxDbSqlLogState state, const wxString &filename = SQL_LOG_FILENAME); +bool WXDLLIMPEXP_ODBC +wxDbSqlLog(wxDbSqlLogState state, const wxString &filename = SQL_LOG_FILENAME); #if 0 @@ -704,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. -bool WXDLLEXPORT wxDbGetDataSource(HENV henv, wxChar *Dsn, SWORD DsnMax, wxChar *DsDesc, - SWORD DsDescMax, DWORD 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 @@ -736,15 +779,19 @@ typedef wxTablesInUse CstructTablesInUse; #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 +#endif // _WX_DB_H_ +