/****************************************************************************

**

** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the Qt Assistant of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

** Alternatively, this file may be used under the terms of the GNU Lesser

** General Public License version 2.1 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL included in the

** packaging of this file.  Please review the following information to

** ensure the GNU Lesser General Public License version 2.1 requirements

** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

#ifndef QHELPDBREADER_H

#define QHELPDBREADER_H

//

//  W A R N I N G

//  -------------

//

// This file is not part of the Qt API. It exists for the convenience

// of the help generator tools. This header file may change from version

// to version without notice, or even be removed.

//

// We mean it.

//

#include <QtCore/QObject>

#include <QtCore/QStringList>

#include <QtCore/QUrl>

#include <QtCore/QByteArray>

#include <QtCore/QSet>

QT_BEGIN_NAMESPACE

class QSqlQuery;

class QHelpDBReader : public QObject

{

    Q_OBJECT

public:

    QHelpDBReader(const QString &dbName); 

    QHelpDBReader(const QString &dbName, const QString &uniqueId,

        QObject *parent);

    ~QHelpDBReader();

    bool init();

    QString errorMessage() const;

    QString databaseName() const;

    QString namespaceName() const;

    QString virtualFolder() const;

    QList<QStringList> filterAttributeSets() const;

    QStringList files(const QStringList &filterAttributes,

        const QString &extensionFilter = QString()) const;

    bool fileExists(const QString &virtualFolder, const QString &filePath,

        const QStringList &filterAttributes = QStringList()) const;

    QByteArray fileData(const QString &virtualFolder,

        const QString &filePath) const;

    QStringList customFilters() const;

    QStringList filterAttributes(const QString &filterName = QString()) const;

    QStringList indicesForFilter(const QStringList &filterAttributes) const;

    void linksForKeyword(const QString &keyword, const QStringList &filterAttributes,

        QMap<QString, QUrl> &linkMap) const;

    void linksForIdentifier(const QString &id, const QStringList &filterAttributes,

        QMap<QString, QUrl> &linkMap) const;

    QList<QByteArray> contentsForFilter(const QStringList &filterAttributes) const;

    QUrl urlOfPath(const QString &relativePath) const;

    QSet<int> indexIds(const QStringList &attributes) const;

    bool createAttributesCache(const QStringList &attributes,

        const QSet<int> &indexIds);

    QVariant metaData(const QString &name) const;

private:

    void initObject(const QString &dbName, const QString &uniqueId);

    QUrl buildQUrl(const QString &ns, const QString &folder,

        const QString &relFileName, const QString &anchor) const;

    QString mergeList(const QStringList &list) const;

    QString quote(const QString &string) const;

    bool m_initDone;

    QString m_dbName;

    QString m_uniqueId;

    QString m_error;

    QSqlQuery *m_query;

    mutable QString m_namespace;

    QSet<QString> m_viewAttributes;

    bool m_useAttributesCache;

    QSet<int> m_indicesCache;

};

QT_END_NAMESPACE

#endif