X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/5bdad317aa06da5590f585581677f18765985391..31ad423e4fb556ec225a63b161154d3bf3445c1b:/include/wx/db.h diff --git a/include/wx/db.h b/include/wx/db.h index 57ec4345f7..8ca2c10966 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. @@ -23,22 +23,17 @@ // 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 -// wxWindows-based application -// 2) All enhancements and bug fixes are to be submitted back to the wxWindows -// user groups free of all charges for use with the wxWindows library. +// 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 wxWindows GUI development toolkit. +// the wxWidgets GUI development toolkit. // /////////////////////////////////////////////////////////////////////////////// -/* -// 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,7 +43,7 @@ #include "wx/version.h" -#ifdef __GNUG__ +#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) #pragma interface "db.h" #endif @@ -57,28 +52,58 @@ #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, -// plus the odbcinst.h header - gt Nov 2 2000 -// -// Must add "odbccp32.lib" in \wx2\wxWindows\src\makevc.env to the WINLIBS= line -// +#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\wxWidgets\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 @@ -86,35 +111,25 @@ 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(int) == 2 ? SQL_C_USHORT : SQL_C_ULONG) + #define SQL_C_BOOLEAN(datatype) (sizeof(datatype) == 1 ? SQL_C_UTINYINT : (sizeof(datatype) == 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) + #define SQL_C_ENUM (sizeof(enumDummy) == 2 ? SQL_C_USHORT : SQL_C_ULONG) #endif +// NOTE: If SQL_C_BLOB is defined, and it is not SQL_C_BINARY, iODBC 2.x +// may not function correctly. Likely best to use SQL_C_BINARY direct #ifndef SQL_C_BLOB - #ifdef SQL_LONGVARBINARY - #define SQL_C_BLOB SQL_LONGVARBINARY - #elif SQL_VARBINARY - #define SQL_C_BLOB SQL_VARBINARY + #ifdef SQL_C_BINARY + #define SQL_C_BLOB SQL_C_BINARY #endif #endif -/* -#ifndef TRUE -#define TRUE true -#endif -#ifndef FALSE -#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; @@ -250,25 +265,34 @@ enum wxODBC_ERRORS }; #ifndef MAXNAME -#define MAXNAME 31 + #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 + // 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 + +#ifndef SQL_MAX_CONNECTSTR_LEN + // There does not seem to be a standard for this, so I am + // defaulting to the value that MS recommends + #define SQL_MAX_CONNECTSTR_LEN 1024 #endif -class WXDLLEXPORT wxDbConnectInf + +class WXDLLIMPEXP_ODBC wxDbConnectInf { private: bool freeHenvOnDestroy; + bool useConnectionStr; 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) + wxChar ConnectionStr[SQL_MAX_CONNECTSTR_LEN+1]; // Connection string (password) wxString Description; // Not sure what the max length is wxString FileType; // Not sure what the max length is @@ -301,6 +325,9 @@ class WXDLLEXPORT wxDbConnectInf const wxChar *GetAuthStr() { return AuthStr; }; const wxChar *GetPassword() { return AuthStr; }; + const wxChar *GetConnectionStr() { return ConnectionStr; }; + bool UseConnectionStr() { return useConnectionStr; }; + const wxChar *GetDescription() { return Description; }; const wxChar *GetFileType() { return FileType; }; const wxChar *GetDefaultDir() { return DefaultDir; }; @@ -315,24 +342,25 @@ class WXDLLEXPORT wxDbConnectInf void SetPassword(const wxString &password); 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; }; }; // class wxDbConnectInf -struct WXDLLEXPORT wxDbSqlTypeInfo +struct WXDLLIMPEXP_ODBC wxDbSqlTypeInfo { wxString TypeName; SWORD FsqlType; long Precision; short CaseSensitive; -// short MinimumScale; short MaximumScale; }; -class WXDLLEXPORT wxDbColFor +class WXDLLIMPEXP_ODBC wxDbColFor { public: wxString s_Field; // Formated String for Output @@ -351,7 +379,7 @@ public: }; -class WXDLLEXPORT wxDbColInf +class WXDLLIMPEXP_ODBC wxDbColInf { public: wxChar catalog[128+1]; @@ -381,7 +409,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]; @@ -397,7 +425,7 @@ public: }; -class WXDLLEXPORT wxDbInf // Description of a Database +class WXDLLIMPEXP_ODBC wxDbInf // Description of a Database { public: wxChar catalog[128+1]; @@ -436,7 +464,8 @@ enum wxDBMS dbmsVIRTUOSO, dbmsDB2, dbmsINTERBASE, - dbmsPERVASIVE_SQL + dbmsPERVASIVE_SQL, + dbmsXBASE_SEQUITER }; @@ -447,29 +476,35 @@ 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_ODBC(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 + bool dbOpenedWithConnectionString; // Was the database connection opened with a connection string wxString dsn; // Data source name wxString uid; // User ID wxString authStr; // Authorization string (password) + wxString inConnectionStr; // Connection string used to connect to the database + wxString outConnectionStr;// Connection string returned by the database when a connection is successfully opened FILE *fpSqlLog; // Sql Log file pointer wxDbSqlLogState sqlLogState; // On or Off bool fwdOnlyCursors; 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(); + bool open(bool failOnDataTypeUnsupported=TRUE); #if !wxODBC_BACKWARD_COMPATABILITY // ODBC handles @@ -580,8 +615,10 @@ 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 - bool Open(wxDbConnectInf *dbConnectInf); + // 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(wxDb *copyDb); // pointer to a wxDb whose connection info should be copied rather than re-queried void Close(void); bool CommitTrans(void); @@ -609,7 +646,10 @@ public: const wxString &GetDatasourceName(void){return dsn;} const wxString &GetUsername(void) {return uid;} const wxString &GetPassword(void) {return authStr;} + const wxString &GetConnectionInStr(void) {return inConnectionStr;} + const wxString &GetConnectionOutStr(void) {return outConnectionStr;} bool IsOpen(void) {return dbIsOpen;} + bool OpenedWithConnectionString(void) {return dbOpenedWithConnectionString;} HENV GetHENV(void) {return henv;} HDBC GetHDBC(void) {return hdbc;} HSTMT GetHSTMT(void) {return hstmt;} @@ -667,6 +707,7 @@ struct wxDbList wxString Dsn; // Data Source Name wxString Uid; // User ID wxString AuthStr; // Authorization string (password) + wxString ConnectionStr; // Connection string used instead of DSN wxDb *PtrDb; // Pointer to the wxDb object bool Free; // Is item free or in use? wxDbList *PtrNext; // Pointer to next item in the list @@ -688,20 +729,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); // 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, - wxChar *ErrFile, int ErrLine); +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 @@ -714,8 +759,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, 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 @@ -746,15 +792,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_ +