driver.h

/* This file is part of the KDE project
   Copyright (C) 2003-2006 Jaroslaw Staniek <js@iidea.pl>
 
   This program is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.
 
   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.
 
   You should have received a copy of the GNU Library General Public License
   along with this program; see the file COPYING.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
*/
 
#ifndef KEXIDB_DRIVER_H
#define KEXIDB_DRIVER_H
 
#include <tqobject.h>
#include <tqdatetime.h>
#include <tqdict.h>
 
#include <kexidb/global.h>
#include <kexidb/object.h>
#include <kexidb/field.h>
 
class KService;
 
namespace KexiDB {
 
class AdminTools;
class Connection;
class ConnectionData;
class ConnectionInternal;
class DriverManager;
class DriverBehaviour;
class DriverPrivate;


class KEXI_DB_EXPORT Driver : public TQObject, public KexiDB::Object
{
    TQ_OBJECT
  
    public:
        class Info {
            public:
            Info();
            TQString name, caption, comment, fileDBMimeType;
            bool fileBased : 1;
            bool allowImportingTo : 1;
        };
        typedef TQMap<TQString,Info> InfoMap;
        
        enum Features {
            NoFeatures = 0,
            SingleTransactions = 1,   
            MultipleTransactions = 2, 
//(js) NOT YET IN USE:
            NestedTransactions = 4,
            CursorForward = 8, 
            CursorBackward = (CursorForward+16),
            CompactingDatabaseSupported = 32,
            //-- temporary options: can be removed later, use at your own risk --
            IgnoreTransactions = 1024
        };

        enum CreateConnectionOptions {
            ReadOnlyConnection = 1 
        };
        
        virtual ~Driver();

        Connection *createConnection( ConnectionData &conn_data, int options = 0 );

        const TQPtrList<Connection> connectionsList() const;
 
//      /*! \return a name equal to the service name (X-Kexi-DriverName) 
//       stored in given service .desktop file. */
//      TQString driverName() { return m_driverName; }

        TQString fileDBDriverMimeType() const;

        static TQString defaultFileBasedDriverMimeType();

        static TQString defaultFileBasedDriverName();

        const KService* service() const;

        bool isFileDriver() const;

        virtual bool isSystemObjectName( const TQString& n ) const;

        static bool isKexiDBSystemObjectName( const TQString& n );

        virtual bool isSystemDatabaseName( const TQString& n ) const = 0;

        bool isSystemFieldName( const TQString& n ) const;

        int features() const;

        bool transactionsSupported() const;

        AdminTools& adminTools() const;

        virtual TQString sqlTypeName(int id_t, int p=0) const;

        static TQString defaultSQLTypeName(int id_t);

        virtual bool isValid();
    
        virtual DatabaseVersionInfo version() const = 0;

        virtual TQString valueToSQL( uint ftype, const TQVariant& v ) const;
        
        inline TQString valueToSQL( const TQString& ftype, const TQVariant& v ) const {
            return valueToSQL(Field::typeForString(ftype), v);
        }

        inline TQString valueToSQL( const Field *field, const TQVariant& v ) const {
            return valueToSQL( (field ? field->type() : Field::InvalidType), v );
        }

        inline virtual TQString dateTimeToSQL(const TQDateTime& v) const {

//old           const TQDateTime dt( v.toDateTime() );
//old           return TQString("\'")+dt.date().toString(TQt::ISODate)+" "+dt.time().toString(TQt::ISODate)+"\'";
            return TQString("\'")+v.toString(TQt::ISODate)+"\'";
        }

        virtual TQString escapeString( const TQString& str ) const = 0;
        
        virtual TQCString escapeString( const TQCString& str ) const = 0;
        
        virtual TQString escapeBLOB(const TQByteArray& array) const = 0;
 
//todo enum EscapeType { EscapeDriver = 0x00, EscapeKexi = 0x01};
//todo enum EscapePolicy { EscapeAsNecessary = 0x00, EscapeAlways = 0x02 };
 
        enum EscapeType { EscapeDriver = 0x01, EscapeKexi = 0x02};
        
        enum EscapePolicy { EscapeAsNecessary = 0x04, EscapeAlways = 0x08 };


        TQString escapeIdentifier( const TQString& str, 
            int options = EscapeDriver|EscapeAsNecessary) const;
 
        TQCString escapeIdentifier( const TQCString& str, 
            int options = EscapeDriver|EscapeAsNecessary) const;

        TQVariant propertyValue( const TQCString& propName ) const;

        TQString propertyCaption( const TQCString& propName ) const;

        TQValueList<TQCString> propertyNames() const;
 
    protected:
        Driver( TQObject *parent, const char *name, const TQStringList &args = TQStringList() );

        virtual Connection *drv_createConnection( ConnectionData &conn_data ) = 0;
//virtual ConnectionInternal* createConnectionInternalObject( Connection& conn ) = 0;

        virtual TQString drv_escapeIdentifier( const TQString& str ) const = 0;
        
        virtual TQCString drv_escapeIdentifier( const TQCString& str ) const = 0;
        
        virtual bool drv_isSystemFieldName( const TQString& n ) const = 0;
        
        /* Creates admin tools object providing a number of database administration 
         tools for the driver. This is called once per driver.
 
         Note for driver developers: Reimplement this method by returning 
         KexiDB::AdminTools-derived object. Default implementation creates 
         empty admin tools. 
         @see adminTools() */
        virtual AdminTools* drv_createAdminTools() const;

        Connection* removeConnection( Connection *conn );
 
    friend class Connection;
    friend class Cursor;
    friend class DriverManagerInternal;
 

    void initSQLKeywords(int hashSize = 17);
 
    DriverBehaviour *beh;
    DriverPrivate *d;
};
 
} //namespace KexiDB

#define KEXIDB_DRIVER \
    public: \
    virtual DatabaseVersionInfo version() const;
 
#endif