X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/5cf34cf07e86972e05b9add28ffa81e6dd04696b..b8e7b6738fe00529fdeae26e6cfea1ccc2a00a76:/include/wx/db.h diff --git a/include/wx/db.h b/include/wx/db.h index d5bfa18e56..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 @@ -46,81 +41,104 @@ #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" -#if wxMAJOR_VERSION == 2 - #ifdef __GNUG__ - #pragma interface "db.h" - #endif +#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) + #pragma interface "db.h" #endif #include "wx/setup.h" -#if wxMAJOR_VERSION == 2 - 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" -#endif - } -#else // version == 1 + #if defined(__WINDOWS__) && ( defined(HAVE_W32API_H) || defined(__BORLANDC__) ) + #include + #include "wx/msw/winundef.h" + #endif 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 + #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 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 (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) +#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 -#define TRUE 1 +#define TRUE true #endif #ifndef FALSE -#define FALSE 0 +#define FALSE false #endif - +*/ 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; @@ -135,6 +153,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_BLOB = 5; const int DB_SELECT_KEYFIELDS = 1; const int DB_SELECT_WHERE = 2; @@ -264,16 +283,16 @@ enum wxODBC_ERRORS #define SQL_MAX_AUTHSTR_LEN MAXNAME #endif -class wxDbConnectInf +class WXDLLIMPEXP_ODBC wxDbConnectInf { 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 @@ -284,9 +303,9 @@ class wxDbConnectInf public: wxDbConnectInf(); - wxDbConnectInf(HENV henv, const wxString &dsn, const wxString &userID="", - const wxString &password="", const wxString &defaultDir="", - const wxString &description="", const wxString &fileType=""); + 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(); @@ -296,8 +315,7 @@ class wxDbConnectInf void FreeHenv(); // Accessors - const HENV GetHenv() { return Henv; }; - const HENV &GetHenvAddress() { return Henv; }; + const HENV &GetHenv() { return Henv; }; const wxChar *GetDsn() { return Dsn; }; @@ -327,10 +345,10 @@ class wxDbConnectInf }; // class wxDbConnectInf -struct wxDbSqlTypeInfo +struct WXDLLIMPEXP_ODBC wxDbSqlTypeInfo { wxString TypeName; - int FsqlType; + SWORD FsqlType; long Precision; short CaseSensitive; // short MinimumScale; @@ -338,7 +356,7 @@ struct wxDbSqlTypeInfo }; -class WXDLLEXPORT wxDbColFor +class WXDLLIMPEXP_ODBC wxDbColFor { public: wxString s_Field; // Formated String for Output @@ -352,11 +370,12 @@ public: wxDbColFor(); ~wxDbColFor(); + void Initialize(); int Format(int Nation, int dbDataType, SWORD sqlDataType, short columnSize, short decimalDigits); }; -class WXDLLEXPORT wxDbColInf +class WXDLLIMPEXP_ODBC wxDbColInf { public: wxChar catalog[128+1]; @@ -381,25 +400,28 @@ public: wxDbColInf(); ~wxDbColInf(); -}; - + bool Initialize(); +}; -class WXDLLEXPORT wxDbTableInf // Description of a Table +class WXDLLIMPEXP_ODBC 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(); ~wxDbTableInf(); + + bool Initialize(); }; -class WXDLLEXPORT wxDbInf // Description of a Database +class WXDLLIMPEXP_ODBC wxDbInf // Description of a Database { public: wxChar catalog[128+1]; @@ -409,6 +431,8 @@ public: wxDbInf(); ~wxDbInf(); + + bool Initialize(); }; @@ -435,7 +459,9 @@ enum wxDBMS dbmsINFORMIX, dbmsVIRTUOSO, dbmsDB2, - dbmsINTERBASE + dbmsINTERBASE, + dbmsPERVASIVE_SQL, + dbmsXBASE_SEQUITER }; @@ -446,13 +472,16 @@ 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; + bool dbIsCached; // Was connection created by caching functions wxString dsn; // Data source name wxString uid; // User ID wxString authStr; // Authorization string (password) @@ -462,11 +491,12 @@ 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); const wxChar *convertUserID(const wxChar *userID, wxString &UserID); + void initialize(); #if !wxODBC_BACKWARD_COMPATABILITY // ODBC handles @@ -490,9 +520,17 @@ private: wxDbSqlTypeInfo typeInfInteger; wxDbSqlTypeInfo typeInfFloat; wxDbSqlTypeInfo typeInfDate; + wxDbSqlTypeInfo typeInfBlob; #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 @@ -562,13 +600,16 @@ public: wxDbSqlTypeInfo typeInfInteger; wxDbSqlTypeInfo typeInfFloat; wxDbSqlTypeInfo typeInfDate; + wxDbSqlTypeInfo typeInfBlob; #endif // Public member functions - wxDb(HENV &aHenv, bool FwdOnlyCursors=(bool)wxODBC_FWD_ONLY_CURSORS); - void Initialize(); + 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 CommitTrans(void); @@ -585,37 +626,54 @@ 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 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(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;} - 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=wxT("")); // 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=wxT("")); // tableName can refer to a table, view, alias or synonym - void LogError(const wxString &errMsg, const wxString &SQLState = wxT("")) { 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; } - 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 ModifyColumn(const wxString &tableName, const wxString &columnName, int dataType, ULONG columnLength=0, - const wxString &optionalParam=""); + const wxString &optionalParam=wxEmptyString); bool FwdOnlyCursors(void) {return fwdOnlyCursors;} @@ -658,28 +716,39 @@ 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); + + +// Writes a message to the wxLog window (stdout usually) when an internal error +// situation occurs. This function only works in DEBUG builds +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 wxDbSqlLog(wxDbSqlLogState state, const wxChar *filename = SQL_LOG_FILENAME); +bool WXDLLIMPEXP_ODBC +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=wxT(""), - bool sysDSN=FALSE, const wxString &defDir=wxT(""), wxWindow *parent=NULL); +int WXDLLEXPORT wxDbCreateDataSource(const wxString &driverName, const wxString &dsn, const wxString &description=wxEmptyString, + bool sysDSN=FALSE, const wxString &defDir=wxEmptyString, wxWindow *parent=NULL); #endif // This routine allows you to query a driver manager // 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, UWORD 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 @@ -710,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_ +