/* This file is part of the KDE project
   Copyright (C) 2005,2006 Martin Ellis <martin.ellis@kdemail.net>
   Copyright (C) 2005-2016 Jarosław Staniek <staniek@kde.org>

   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 MDBMIGRATE_H
#define MDBMIGRATE_H

#include <mdbtools.h>

#include <migration/keximigrate.h>

#include <KDbConnection>

#include <QByteArray>

namespace KexiMigration
{

class MDBMigrate : public KexiMigrate
{
    Q_OBJECT

public:
    explicit MDBMigrate(QObject *parent, const QVariantList& args = QVariantList());
    virtual ~MDBMigrate();

    //! Convert an MDB type to a KDb type, prompting user if necessary.
    KDbField::Type type(int type);

    //! Get the table definition for a given table name
    /*! Look up the table definition for the given table.  This only returns a ptr
        to the MdbTableDef - it doesn't load e.g. the column data.
        Remember to mdb_free_tabledef the table definition when it's finished
        with.
        \return the table definition, or null if no matching table was found
    */
    MdbTableDef* getTableDef(const QString& tableName);

    QVariant toQVariant(const char* data, unsigned int len, int type);

    bool getPrimaryKey(KDbTableSchema* table, MdbTableDef* tableDef);

    //! Reimplemented to add support for "sourceDatabaseHasNonUnicodeEncoding" property
    //! @todo this should be in KDbConnection class but Migration framework has no such yet!
    virtual QVariant propertyValue(const QByteArray& propName);

protected:
    //! Driver specific function to return table names
    virtual bool drv_tableNames(QStringList *tablenames);

    //! Driver specific implementation to read a table schema
    virtual bool drv_readTableSchema(
        const QString& originalName, KDbTableSchema *tableSchema);

    //! Creates connection object to the source database (driver-specific).
    KDbConnection* drv_createConnection() Q_DECL_OVERRIDE;

    //! Driver specific connection implementation
    virtual bool drv_connect();

    //! Disconnect from the db backend
    virtual bool drv_disconnect();

    //! Copy MDB table to a KDb table
    bool drv_copyTable(const QString& srcTable,
                       KDbConnection *destConn, KDbTableSchema* dstTable,
                       const RecordFilter *recordFilter = nullptr) Q_DECL_OVERRIDE;

    virtual bool drv_progressSupported() {
        return true;
    }
    virtual bool drv_getTableSize(const QString& table, quint64 *size);

private:
    MdbHandle *m_mdb = nullptr;
};
}

#endif
