X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/77ffb5937e89927b621128789401db8921fe580f..c534e69669840e016d9e109356d8839302bb95db:/include/wx/db.h diff --git a/include/wx/db.h b/include/wx/db.h index 60a301d782..0c9b196a2b 100644 --- a/include/wx/db.h +++ b/include/wx/db.h @@ -19,52 +19,29 @@ // Created: 9.96 // RCS-ID: $Id$ // Copyright: (c) 1996 Remstar International, Inc. -// Licence: wxWidgets licence, plus: -// Notice: This class library and its intellectual design are free of charge for use, -// modification, enhancement, debugging under the following conditions: -// 1) These classes may only be used as part of the implementation of a -// wxWidgets-based application -// 2) All enhancements and bug fixes are to be submitted back to the wxWidgets -// user groups free of all charges for use with the wxWidgets library. -// 3) These classes may not be distributed as part of any other class library, -// DLL, text (written or electronic), other than a complete distribution of -// the wxWidgets GUI development toolkit. -// +// Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////////// #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 independent and // return columns in the order they were created #define OLD_GETCOLUMNS 1 #define EXPERIMENTAL_WXDB_FUNCTIONS 1 -#include "wx/version.h" - -#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) - #pragma interface "db.h" -#endif - -#include "wx/setup.h" - #include "wx/defs.h" #include "wx/string.h" -#if defined(__VISUALC__) +#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" + #include "wx/msw/wrapwin.h" #endif // wxUSE_MFC/!wxUSE_MFC // If you use the wxDbCreateDataSource() function with MSW/VC6, @@ -75,35 +52,59 @@ // #include "sql.h" #include "sqlext.h" + //#if wxUSE_UNICODE + // #include + //#endif #include "odbcinst.h" #else - #if defined(__WINDOWS__) && ( defined(HAVE_W32API_H) || defined(__BORLANDC__) ) - #include - #include "wx/msw/winundef.h" + #if defined(__WINDOWS__) && ( defined(HAVE_W32API_H) || defined(__BORLANDC__) || defined (__DMC__)) + #include "wx/msw/wrapwin.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 + // Not available in v2.x of iODBC + #ifndef __WXMSW__ + #if wxUSE_UNICODE + typedef wxChar SQLTCHAR; + #else + typedef UCHAR SQLTCHAR; + #endif + #endif + #else // !wxUSE_BUILTIN_IODBC + // SQL headers define BOOL if it's not defined yet but BOOL is also + // defined in many other places on other systems (Motif, at least on + // OpenVMS; Cocoa and X11) so prevent the problem by defining it before + // including these headers + #define BOOL int #include #include - #endif + #undef BOOL + #endif // wxUSE_BUILTIN_IODBC/!wxUSE_BUILTIN_IODBC } #endif +#if wxUSE_UNICODE +#define SQL_C_WXCHAR SQL_C_WCHAR +#else +#define SQL_C_WXCHAR SQL_C_CHAR +#endif + +#ifdef __DIGITALMARS__ +#if wxUSE_UNICODE +typedef wxChar SQLTCHAR; +#else +typedef UCHAR SQLTCHAR; +#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 @@ -126,10 +127,19 @@ enum enumDummy {enumDum1}; #endif #endif +#ifndef _WIN64 +#ifndef SQLLEN +#define SQLLEN SQLINTEGER +#endif +#ifndef SQLULEN +#define SQLULEN SQLUINTEGER +#endif +#endif + const int wxDB_PATH_MAX = 254; -WXDLLIMPEXP_DATA_ODBC(extern wxChar const *) SQL_LOG_FILENAME; -WXDLLIMPEXP_DATA_ODBC(extern wxChar const *) SQL_CATALOG_FILENAME; +extern WXDLLIMPEXP_DATA_ODBC(wxChar const *) SQL_LOG_FILENAME; +extern WXDLLIMPEXP_DATA_ODBC(wxChar const *) SQL_CATALOG_FILENAME; // Database Globals const int DB_TYPE_NAME_LEN = 40; @@ -145,6 +155,7 @@ 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_DATA_TYPE_MEMO = 6; const int DB_SELECT_KEYFIELDS = 1; const int DB_SELECT_WHERE = 2; @@ -303,8 +314,8 @@ class WXDLLIMPEXP_ODBC wxDbConnectInf public: wxDbConnectInf(); - wxDbConnectInf(HENV henv, const wxString &dsn, const wxString &userID=wxEmptyString, - const wxString &password=wxEmptyString, const wxString &defaultDir=wxEmptyString, + 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(); @@ -315,38 +326,38 @@ class WXDLLIMPEXP_ODBC wxDbConnectInf void FreeHenv(); // Accessors - const HENV &GetHenv() { return Henv; }; + const HENV &GetHenv() { return Henv; } - const wxChar *GetDsn() { return Dsn; }; + const wxChar *GetDsn() { return Dsn; } - const wxChar *GetUid() { return Uid; }; - const wxChar *GetUserID() { return Uid; }; + const wxChar *GetUid() { return Uid; } + const wxChar *GetUserID() { return Uid; } - const wxChar *GetAuthStr() { return AuthStr; }; - const wxChar *GetPassword() { return AuthStr; }; + const wxChar *GetAuthStr() { return AuthStr; } + const wxChar *GetPassword() { return AuthStr; } - const wxChar *GetConnectionStr() { return ConnectionStr; }; - bool UseConnectionStr() { return useConnectionStr; }; + const wxChar *GetConnectionStr() { return ConnectionStr; } + bool UseConnectionStr() { return useConnectionStr; } - const wxChar *GetDescription() { return Description; }; - const wxChar *GetFileType() { return FileType; }; - const wxChar *GetDefaultDir() { return DefaultDir; }; + const wxChar *GetDescription() { return Description; } + const wxChar *GetFileType() { return FileType; } + const wxChar *GetDefaultDir() { return DefaultDir; } - void SetHenv(const HENV henv) { Henv = henv; }; + 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 SetUid(const wxString &uid) { SetUserID(uid); } void SetPassword(const wxString &password); - void SetAuthStr(const wxString &authstr) { SetPassword(authstr); }; + void SetAuthStr(const wxString &authstr) { SetPassword(authstr); } void SetConnectionStr(const wxString &connectStr); - void SetDescription(const wxString &desc) { Description = desc; }; - void SetFileType(const wxString &fileType) { FileType = fileType; }; - void SetDefaultDir(const wxString &defDir) { DefaultDir = defDir; }; + void SetDescription(const wxString &desc) { Description = desc; } + void SetFileType(const wxString &fileType) { FileType = fileType; } + void SetDefaultDir(const wxString &defDir) { DefaultDir = defDir; } }; // class wxDbConnectInf @@ -363,19 +374,19 @@ struct WXDLLIMPEXP_ODBC wxDbSqlTypeInfo class WXDLLIMPEXP_ODBC wxDbColFor { public: - 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 + wxString s_Field; // Formatted String for Output + wxString s_Format[7]; // Formatted Objects - TIMESTAMP has the biggest (7) + wxString s_Amount[7]; // Formatted Objects - amount of things that can be formatted + int i_Amount[7]; // Formatted 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 SWORD i_sqlDataType; wxDbColFor(); - ~wxDbColFor(); + ~wxDbColFor(){} void Initialize(); - int Format(int Nation, int dbDataType, SWORD sqlDataType, short columnSize, short decimalDigits); + int Format(int Nation, int dbDataType, SWORD sqlDataType, short columnLength, short decimalDigits); }; @@ -388,8 +399,8 @@ public: wxChar colName[DB_MAX_COLUMN_NAME_LEN+1]; SWORD sqlDataType; wxChar typeName[128+1]; - SWORD columnSize; - SWORD bufferLength; + SWORD columnLength; + SWORD bufferSize; short decimalDigits; short numPrecRadix; short nullable; @@ -465,7 +476,19 @@ enum wxDBMS dbmsDB2, dbmsINTERBASE, dbmsPERVASIVE_SQL, - dbmsXBASE_SEQUITER + dbmsXBASE_SEQUITER, + dbmsFIREBIRD, + dbmsMAXDB, + dbmsFuture1, + dbmsFuture2, + dbmsFuture3, + dbmsFuture4, + dbmsFuture5, + dbmsFuture6, + dbmsFuture7, + dbmsFuture8, + dbmsFuture9, + dbmsFuture10 }; @@ -477,8 +500,8 @@ enum wxDBMS // will overwrite the errors of the previously destroyed wxDb object in // this variable. -WXDLLIMPEXP_DATA_BASE(extern wxChar) - DBerrorList[DB_MAX_ERROR_HISTORY][DB_MAX_ERROR_MSG_LEN]; +extern WXDLLIMPEXP_DATA_ODBC(wxChar) + DBerrorList[DB_MAX_ERROR_HISTORY][DB_MAX_ERROR_MSG_LEN+1]; class WXDLLIMPEXP_ODBC wxDb @@ -498,13 +521,14 @@ private: wxDBMS dbmsType; // Type of datasource - i.e. Oracle, dBase, SQLServer, etc // Private member functions - bool getDbInfo(bool failOnDataTypeUnsupported=TRUE); + 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 convertUserID(const wxChar *userID, wxString &UserID); + bool determineDataTypes(bool failOnDataTypeUnsupported); void initialize(); - bool open(bool failOnDataTypeUnsupported=TRUE); + bool open(bool failOnDataTypeUnsupported=true); #if !wxODBC_BACKWARD_COMPATABILITY // ODBC handles @@ -529,12 +553,13 @@ private: wxDbSqlTypeInfo typeInfFloat; wxDbSqlTypeInfo typeInfDate; wxDbSqlTypeInfo typeInfBlob; + wxDbSqlTypeInfo typeInfMemo; #endif public: - void setCached(bool cached) { dbIsCached = cached; }; // This function must only be called by wxDbGetConnection() and wxDbCloseConnections!!! - bool IsCached() { return dbIsCached; }; + 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); } @@ -592,9 +617,15 @@ public: // ODBC Error Inf. SWORD cbErrorMsg; int DB_STATUS; +#ifdef __VMS + // The DECC compiler chokes when in db.cpp the array is accessed outside + // its bounds. Maybe this change should also applied for other platforms. + wxChar errorList[DB_MAX_ERROR_HISTORY][DB_MAX_ERROR_MSG_LEN+1]; +#else wxChar errorList[DB_MAX_ERROR_HISTORY][DB_MAX_ERROR_MSG_LEN]; +#endif wxChar errorMsg[SQL_MAX_MESSAGE_LENGTH]; - SDWORD nativeError; + SQLINTEGER nativeError; wxChar sqlState[20]; #if wxODBC_BACKWARD_COMPATABILITY @@ -616,9 +647,11 @@ public: ~wxDb(); // Data Source Name, User ID, Password and whether open should fail on data type not supported - bool Open(const wxString& inConnectStr, bool failOnDataTypeUnsupported=TRUE); - bool Open(const wxString &Dsn, const wxString &Uid, const wxString &AuthStr, bool failOnDataTypeUnsupported=TRUE); - bool Open(wxDbConnectInf *dbConnectInf, bool failOnDataTypeUnsupported=TRUE); + bool Open(const wxString& inConnectStr, bool failOnDataTypeUnsupported=true); + ///This version of Open will open the odbc source selection dialog. Cast a wxWindow::GetHandle() to SQLHWND to use. + bool Open(const wxString& inConnectStr, SQLHWND parentWnd, bool failOnDataTypeUnsupported=true); + bool Open(const wxString &Dsn, const wxString &Uid, const wxString &AuthStr, bool failOnDataTypeUnsupported=true); + bool Open(wxDbConnectInf *dbConnectInf, bool failOnDataTypeUnsupported=true); bool Open(wxDb *copyDb); // pointer to a wxDb whose connection info should be copied rather than re-queried void Close(void); bool CommitTrans(void); @@ -626,11 +659,12 @@ 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 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 ExecSql(const wxString &pSqlStmt, wxDbColInf** columns, short& numcols); bool GetNext(void); - bool GetData(UWORD colNo, SWORD cType, PTR pData, SDWORD maxLen, SDWORD FAR *cbReturned); + bool GetData(UWORD colNo, SWORD cType, PTR pData, SDWORD maxLen, SQLLEN FAR *cbReturned); bool Grant(int privileges, const wxString &tableName, const wxString &userList = wxT("PUBLIC")); int TranslateSqlState(const wxString &SQLState); wxDbInf *GetCatalog(const wxChar *userID=NULL); @@ -638,7 +672,7 @@ public: int GetKeyFields(const wxString &tableName, wxDbColInf* colInf, UWORD noCols); wxDbColInf *GetColumns(wxChar *tableName[], const wxChar *userID=NULL); - wxDbColInf *GetColumns(const wxString &tableName, UWORD *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;} @@ -659,27 +693,28 @@ public: wxDbSqlTypeInfo GetTypeInfFloat() {return typeInfFloat;} wxDbSqlTypeInfo GetTypeInfDate() {return typeInfDate;} wxDbSqlTypeInfo GetTypeInfBlob() {return typeInfBlob;} + wxDbSqlTypeInfo GetTypeInfMemo() {return typeInfMemo;} // tableName can refer to a table, view, alias or synonym - bool TableExists(const wxString &tableName, const wxChar *userID=NULL, + 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, + 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 + // 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) + 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); @@ -689,6 +724,9 @@ public: bool FwdOnlyCursors(void) {return fwdOnlyCursors;} + // return the string with all special SQL characters escaped + wxString EscapeSqlChars(const wxString& value); + // These two functions are provided strictly for use by wxDbTable. // DO NOT USE THESE FUNCTIONS, OR MEMORY LEAKS MAY OCCUR void incrementTableCount() { nTables++; return; } @@ -752,7 +790,7 @@ 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=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 @@ -760,14 +798,14 @@ 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 WXDLLIMPEXP_ODBC -wxDbGetDataSource(HENV henv, wxChar *Dsn, SWORD DsnMax, wxChar *DsDesc, - SWORD DsDescMax, UWORD direction = SQL_FETCH_NEXT); +wxDbGetDataSource(HENV henv, wxChar *Dsn, SWORD DsnMaxLength, wxChar *DsDesc, + SWORD DsDescMaxLength, UWORD direction = SQL_FETCH_NEXT); // Change this to 0 to remove use of all deprecated functions #if wxODBC_BACKWARD_COMPATABILITY //################################################################################# -//############### DEPRECATED functions for backward compatability ################# +//############### DEPRECATED functions for backward compatibility ################# //################################################################################# // Backward compability structures/classes. This will eventually go away @@ -801,7 +839,7 @@ int WXDLLIMPEXP_ODBC NumberDbConnectionsInUse(void); bool SqlLog(sqlLog state, const wxChar *filename = SQL_LOG_FILENAME); bool WXDLLIMPEXP_ODBC -GetDataSource(HENV henv, char *Dsn, SWORD DsnMax, char *DsDesc, SWORD DsDescMax, +GetDataSource(HENV henv, char *Dsn, SWORD DsnMaxLength, char *DsDesc, SWORD DsDescMaxLength, UWORD direction = SQL_FETCH_NEXT); #endif // Deprecated structures/classes/functions