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

**

** 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 QHELPSEARCHINDEXDEFAULT_H

#define QHELPSEARCHINDEXDEFAULT_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/QString>

#include <QtCore/QVector>

#include <QtCore/QDataStream>

QT_BEGIN_NAMESPACE

namespace QtHelpInternal {

struct Document {

    Document(qint16 d, qint16 f)

        : docNumber(d), frequency(f) {}

    Document()

        : docNumber(-1), frequency(0) {}

    bool operator==(const Document &doc) const {

        return docNumber == doc.docNumber;

    }

    bool operator<(const Document &doc) const {

        return frequency > doc.frequency;

    }

    bool operator<=(const Document &doc) const {

        return frequency >= doc.frequency;

    }

    bool operator>(const Document &doc) const {

        return frequency < doc.frequency;

    }

    qint16 docNumber;

    qint16 frequency;

};

struct DocumentInfo : public Document {

    DocumentInfo()

        : Document(-1, 0), documentTitle(QString()), documentUrl(QString()) {}

    DocumentInfo(qint16 d, qint16 f, const QString &title, const QString &url)

        : Document(d, f), documentTitle(title), documentUrl(url) {}

    DocumentInfo(const Document &document, const QString &title, const QString &url)

        : Document(document.docNumber, document.frequency), documentTitle(title), documentUrl(url) {}

    QString documentTitle;

    QString documentUrl;

};

struct Entry {

    Entry(qint16 d) { documents.append(Document(d, 1)); }

    Entry(QVector<Document> l) : documents(l) {}

    QVector<Document> documents;

};

struct PosEntry {

    PosEntry(int p) { positions.append(p); }

    QList<uint> positions;

};

struct Term {

    Term() : frequency(-1) {}

    Term(const QString &t, int f, QVector<Document> l) : term(t), frequency(f), documents(l) {}

    QString term;

    int frequency;

    QVector<Document>documents;

    bool operator<(const Term &i2) const { return frequency < i2.frequency; }

};

struct TermInfo {

    TermInfo() : frequency(-1) {}

    TermInfo(const QString &t, int f, QVector<DocumentInfo> l)

        : term(t), frequency(f), documents(l) {}

    bool operator<(const TermInfo &i2) const { return frequency < i2.frequency; }

    QString term;

    int frequency;

    QVector<DocumentInfo>documents;

};

} // namespace QtHelpInternal

using QtHelpInternal::Document;

using QtHelpInternal::DocumentInfo;

using QtHelpInternal::Entry;

using QtHelpInternal::PosEntry;

using QtHelpInternal::Term;

using QtHelpInternal::TermInfo;

QDataStream &operator>>(QDataStream &s, Document &l);

QDataStream &operator<<(QDataStream &s, const Document &l);

QT_END_NAMESPACE

#endif  // QHELPSEARCHINDEXDEFAULT_H