Wrappers for *ToText

[wxWidgets.git] / include / wx / db.h

diff --git a/include/wx/db.h b/include/wx/db.h
index 8bff95b46e676aeb55a9d9733e8a0699fcd577e9..8ca2c10966b074f048a4eb7efad751d4fb6c0997 100644 (file)
--- a/include/wx/db.h
+++ b/include/wx/db.h
@@ -23,12 +23,12 @@
 // 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
 // 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
 //              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.

 //
 ///////////////////////////////////////////////////////////////////////////////
 
 //
 ///////////////////////////////////////////////////////////////////////////////
 


@@ -71,13 +71,13 @@
     // you cannot use the iODBC headers, you must use the VC headers,
     // plus the odbcinst.h header - gt Nov 2 2000
     //
     // 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
+    // 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 "sql.h"
     #include "sqlext.h"
     #include "odbcinst.h"
 #else

-    #if defined(__WINDOWS__) && defined(HAVE_W32API_H)
+    #if defined(__WINDOWS__) && ( defined(HAVE_W32API_H) || defined(__BORLANDC__) )

         #include <windows.h>
         #include "wx/msw/winundef.h"
     #endif
         #include <windows.h>
         #include "wx/msw/winundef.h"
     #endif


@@ -111,30 +111,21 @@ typedef UCHAR SQLTCHAR;
 enum enumDummy {enumDum1};
 
 #ifndef SQL_C_BOOLEAN
 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
 #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
 
 #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
 #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
     #endif
 #endif

-/*
-#ifndef TRUE
-#define TRUE true
-#endif

 
 

-#ifndef FALSE
-#define FALSE false
-#endif
-*/

 const int wxDB_PATH_MAX                 = 254;
 
 WXDLLIMPEXP_DATA_ODBC(extern wxChar const *) SQL_LOG_FILENAME;
 const int wxDB_PATH_MAX                 = 254;
 
 WXDLLIMPEXP_DATA_ODBC(extern wxChar const *) SQL_LOG_FILENAME;


@@ -274,25 +265,34 @@ enum wxODBC_ERRORS
 };
 
 #ifndef MAXNAME
 };
 
 #ifndef MAXNAME

-#define MAXNAME         31
+    #define MAXNAME         31

 #endif
 
 #ifndef SQL_MAX_AUTHSTR_LEN
 #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
 
 #endif
 

+

 class WXDLLIMPEXP_ODBC wxDbConnectInf
 {
     private:
         bool freeHenvOnDestroy;
 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)
 
     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
 
         wxString Description;                              // Not sure what the max length is
         wxString FileType;                                 // Not sure what the max length is


@@ -325,6 +325,9 @@ class WXDLLIMPEXP_ODBC wxDbConnectInf
         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    *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; };


@@ -339,6 +342,8 @@ class WXDLLIMPEXP_ODBC wxDbConnectInf
         void             SetPassword(const wxString &password);
         void             SetAuthStr(const wxString &authstr)    { SetPassword(authstr); };
 
         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;   };
         void             SetDescription(const wxString &desc)   { Description   = desc;     };
         void             SetFileType(const wxString &fileType)  { FileType      = fileType; };
         void             SetDefaultDir(const wxString &defDir)  { DefaultDir    = defDir;   };


@@ -351,7 +356,6 @@ struct WXDLLIMPEXP_ODBC wxDbSqlTypeInfo
     SWORD       FsqlType;
     long        Precision;
     short       CaseSensitive;
     SWORD       FsqlType;
     long        Precision;
     short       CaseSensitive;

-//    short     MinimumScale;

     short       MaximumScale;
 };
 
     short       MaximumScale;
 };
 


@@ -473,7 +477,7 @@ enum wxDBMS
 // will overwrite the errors of the previously destroyed wxDb object in
 // this variable.
 
 // will overwrite the errors of the previously destroyed wxDb object in
 // this variable.
 

-WXDLLIMPEXP_DATA_BASE(extern wxChar)
+WXDLLIMPEXP_DATA_ODBC(extern wxChar)

     DBerrorList[DB_MAX_ERROR_HISTORY][DB_MAX_ERROR_MSG_LEN];
 
 
     DBerrorList[DB_MAX_ERROR_HISTORY][DB_MAX_ERROR_MSG_LEN];
 
 


@@ -482,21 +486,25 @@ class WXDLLIMPEXP_ODBC wxDb
 private:
     bool             dbIsOpen;
     bool             dbIsCached;      // Was connection created by caching functions
 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         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
     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             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
 
 #if !wxODBC_BACKWARD_COMPATABILITY
     // ODBC handles


@@ -608,8 +616,9 @@ public:
     ~wxDb();
 
     // Data Source Name, User ID, Password and whether open should fail on data type not supported
     ~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(const wxString &Dsn, const wxString &Uid, const wxString &AuthStr, bool failOnDataTypeUnsupported=TRUE);

-    bool         Open(wxDbConnectInf *dbConnectInf);
+    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);
     bool         Open(wxDb *copyDb);  // pointer to a wxDb whose connection info should be copied rather than re-queried
     void         Close(void);
     bool         CommitTrans(void);


@@ -637,7 +646,10 @@ public:
     const wxString &GetDatasourceName(void){return dsn;}
     const wxString &GetUsername(void)      {return uid;}
     const wxString &GetPassword(void)      {return authStr;}
     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            IsOpen(void)           {return dbIsOpen;}

+    bool            OpenedWithConnectionString(void) {return dbOpenedWithConnectionString;}

     HENV            GetHENV(void)          {return henv;}
     HDBC            GetHDBC(void)          {return hdbc;}
     HSTMT           GetHSTMT(void)         {return hstmt;}
     HENV            GetHENV(void)          {return henv;}
     HDBC            GetHDBC(void)          {return hdbc;}
     HSTMT           GetHSTMT(void)         {return hstmt;}


@@ -695,6 +707,7 @@ struct wxDbList
     wxString  Dsn;           // Data Source Name
     wxString  Uid;           // User ID
     wxString  AuthStr;       // Authorization string (password)
     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
     wxDb     *PtrDb;         // Pointer to the wxDb object
     bool      Free;          // Is item free or in use?
     wxDbList *PtrNext;       // Pointer to next item in the list