X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4fdae9972d39fbe62adaa1c1d721ba1762cd8950..bf7d7ee7062f7f6028df40e43745235658e38b4d:/include/wx/db.h diff --git a/include/wx/db.h b/include/wx/db.h index 6df0e249f4..31bc02b3b0 100644 --- a/include/wx/db.h +++ b/include/wx/db.h @@ -46,21 +46,18 @@ #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 +#ifdef __GNUG__ + #pragma interface "db.h" #endif #include "wx/setup.h" -#if wxMAJOR_VERSION == 2 - extern "C" { +#include "wx/defs.h" +#include "wx/string.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, @@ -75,22 +72,7 @@ #include "wx/isql.h" #include "wx/isqlext.h" #endif - } -#else // version == 1 - 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 - } -#endif +} typedef float SFLOAT; typedef double SDOUBLE; @@ -103,19 +85,31 @@ typedef unsigned int UINT; 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; @@ -135,6 +129,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; @@ -254,25 +249,82 @@ enum wxODBC_ERRORS DB_ERR_TIMEOUT_EXPIRED // SqlState = 'S1T00' }; +#ifndef MAXNAME +#define MAXNAME 31 +#endif + +#ifndef SQL_MAX_AUTHSTR_LEN +// There does not seem to be a standard for this, so I am +// defaulting to the value that MS uses +#define SQL_MAX_AUTHSTR_LEN MAXNAME +#endif -struct wxDbConnectInf +class WXDLLEXPORT wxDbConnectInf { - HENV Henv; - wxString Dsn; // Data Source Name - wxString Uid; // User ID - wxString AuthStr; // Authorization string (password) + private: + bool freeHenvOnDestroy; - wxString description; // Not sure what the max length is - wxString fileType; // Not sure what the max length is + 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) - // Optionals needed for some databases like dBase - wxString defaultDir; // Directory that db file resides in -}; + wxString Description; // Not sure what the max length is + wxString FileType; // Not sure what the max length is + + // Optionals needed for some databases like dBase + wxString DefaultDir; // Directory that db file resides in + + public: + + wxDbConnectInf(); + 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(); -struct wxDbSqlTypeInfo + bool Initialize(); + + bool AllocHenv(); + void FreeHenv(); + + // Accessors + const HENV &GetHenv() { return Henv; }; + + const wxChar *GetDsn() { return Dsn; }; + + const wxChar *GetUid() { return Uid; }; + const wxChar *GetUserID() { return Uid; }; + + const wxChar *GetAuthStr() { return AuthStr; }; + const wxChar *GetPassword() { return AuthStr; }; + + const wxChar *GetDescription() { return Description; }; + const wxChar *GetFileType() { return FileType; }; + const wxChar *GetDefaultDir() { return DefaultDir; }; + + void SetHenv(const HENV henv) { Henv = henv; }; + + void SetDsn(const wxString &dsn); + + void SetUserID(const wxString &userID); + void SetUid(const wxString &uid) { SetUserID(uid); }; + + void SetPassword(const wxString &password); + void SetAuthStr(const wxString &authstr) { SetPassword(authstr); }; + + void SetDescription(const wxString &desc) { Description = desc; }; + void SetFileType(const wxString &fileType) { FileType = fileType; }; + void SetDefaultDir(const wxString &defDir) { DefaultDir = defDir; }; +}; // class wxDbConnectInf + + +struct WXDLLEXPORT wxDbSqlTypeInfo { wxString TypeName; - int FsqlType; + SWORD FsqlType; long Precision; short CaseSensitive; // short MinimumScale; @@ -283,17 +335,18 @@ struct wxDbSqlTypeInfo class WXDLLEXPORT wxDbColFor { public: - wxString s_Field; // Formated String for Output - wxString s_Format[7]; // Formated Objects - TIMESTAMP has the biggest (7) + wxString s_Field; // Formated String for Output + wxString s_Format[7]; // Formated Objects - TIMESTAMP has the biggest (7) wxString s_Amount[7]; // Formated Objects - amount of things that can be formatted int i_Amount[7]; // Formated Objects - TT MM YYYY HH MM SS m - int i_Nation; // 0 = timestamp , 1=EU, 2=UK, 3=International, 4=US - int i_dbDataType; // conversion of the 'sqlDataType' to the generic data type used by these classes + int i_Nation; // 0 = timestamp , 1=EU, 2=UK, 3=International, 4=US + int i_dbDataType; // conversion of the 'sqlDataType' to the generic data type used by these classes SWORD i_sqlDataType; wxDbColFor(); ~wxDbColFor(); + void Initialize(); int Format(int Nation, int dbDataType, SWORD sqlDataType, short columnSize, short decimalDigits); }; @@ -323,9 +376,9 @@ public: wxDbColInf(); ~wxDbColInf(); -}; - + bool Initialize(); +}; class WXDLLEXPORT wxDbTableInf // Description of a Table @@ -334,10 +387,13 @@ 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(); }; @@ -351,6 +407,8 @@ public: wxDbInf(); ~wxDbInf(); + + bool Initialize(); }; @@ -377,7 +435,8 @@ enum wxDBMS dbmsINFORMIX, dbmsVIRTUOSO, dbmsDB2, - dbmsINTERBASE + dbmsINTERBASE, + dbmsPERVASIVE_SQL }; @@ -395,6 +454,7 @@ class WXDLLEXPORT 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) @@ -408,8 +468,8 @@ private: bool getDataTypeInfo(SWORD fSqlType, wxDbSqlTypeInfo &structSQLTypeInfo); bool setConnectionOptions(void); void logError(const wxString &errMsg, const wxString &SQLState); - void initialize(); const wxChar *convertUserID(const wxChar *userID, wxString &UserID); + void initialize(); #if !wxODBC_BACKWARD_COMPATABILITY // ODBC handles @@ -433,9 +493,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 @@ -505,11 +573,15 @@ public: wxDbSqlTypeInfo typeInfInteger; wxDbSqlTypeInfo typeInfFloat; wxDbSqlTypeInfo typeInfDate; + wxDbSqlTypeInfo typeInfBlob; #endif // Public member functions - wxDb(HENV &aHenv, bool FwdOnlyCursors=(bool)wxODBC_FWD_ONLY_CURSORS); + 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 + 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); @@ -526,37 +598,46 @@ 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); + + 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;} @@ -583,6 +664,7 @@ struct wxDbList wxDbList *PtrNext; // Pointer to next item in the list }; + #ifdef __WXDEBUG__ #include "wx/object.h" class wxTablesInUse : public wxObject @@ -604,14 +686,21 @@ 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 + // This function sets the sql log state for all open wxDb objects -bool wxDbSqlLog(wxDbSqlLogState state, const wxChar *filename = SQL_LOG_FILENAME); +bool WXDLLEXPORT 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