source: branches/vendor/trolltech/qt/current/tools/assistant/lib/qhelpsearchindex_default_p.h @ 2

Last change on this file since 2 was 2, checked in by Dmitry A. Kuminov, 13 years ago

Initially imported qt-all-opensource-src-4.5.1 from Trolltech.

File size: 4.7 KB
Line 
1/****************************************************************************
2**
3** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
4** Contact: Qt Software Information (qt-info@nokia.com)
5**
6** This file is part of the Qt Assistant of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial Usage
10** Licensees holding valid Qt Commercial licenses may use this file in
11** accordance with the Qt Commercial License Agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and Nokia.
14**
15** GNU Lesser General Public License Usage
16** Alternatively, this file may be used under the terms of the GNU Lesser
17** General Public License version 2.1 as published by the Free Software
18** Foundation and appearing in the file LICENSE.LGPL included in the
19** packaging of this file.  Please review the following information to
20** ensure the GNU Lesser General Public License version 2.1 requirements
21** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
22**
23** In addition, as a special exception, Nokia gives you certain
24** additional rights. These rights are described in the Nokia Qt LGPL
25** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
26** package.
27**
28** GNU General Public License Usage
29** Alternatively, this file may be used under the terms of the GNU
30** General Public License version 3.0 as published by the Free Software
31** Foundation and appearing in the file LICENSE.GPL included in the
32** packaging of this file.  Please review the following information to
33** ensure the GNU General Public License version 3.0 requirements will be
34** met: http://www.gnu.org/copyleft/gpl.html.
35**
36** If you are unsure which license is appropriate for your use, please
37** contact the sales department at qt-sales@nokia.com.
38** $QT_END_LICENSE$
39**
40****************************************************************************/
41
42#ifndef QHELPSEARCHINDEXDEFAULT_H
43#define QHELPSEARCHINDEXDEFAULT_H
44
45//
46//  W A R N I N G
47//  -------------
48//
49// This file is not part of the Qt API. It exists for the convenience
50// of the help generator tools. This header file may change from version
51// to version without notice, or even be removed.
52//
53// We mean it.
54//
55
56#include <QtCore/QString>
57#include <QtCore/QVector>
58#include <QtCore/QDataStream>
59
60QT_BEGIN_NAMESPACE
61
62namespace QtHelpInternal {
63
64struct Document {
65    Document(qint16 d, qint16 f)
66        : docNumber(d), frequency(f) {}
67
68    Document()
69        : docNumber(-1), frequency(0) {}
70
71    bool operator==(const Document &doc) const {
72        return docNumber == doc.docNumber;
73    }
74    bool operator<(const Document &doc) const {
75        return frequency > doc.frequency;
76    }
77    bool operator<=(const Document &doc) const {
78        return frequency >= doc.frequency;
79    }
80    bool operator>(const Document &doc) const {
81        return frequency < doc.frequency;
82    }
83
84    qint16 docNumber;
85    qint16 frequency;
86};
87
88struct DocumentInfo : public Document {
89    DocumentInfo()
90        : Document(-1, 0), documentTitle(QString()), documentUrl(QString()) {}
91
92    DocumentInfo(qint16 d, qint16 f, const QString &title, const QString &url)
93        : Document(d, f), documentTitle(title), documentUrl(url) {}
94
95    DocumentInfo(const Document &document, const QString &title, const QString &url)
96        : Document(document.docNumber, document.frequency), documentTitle(title), documentUrl(url) {}
97
98    QString documentTitle;
99    QString documentUrl;
100};
101
102struct Entry {
103    Entry(qint16 d) { documents.append(Document(d, 1)); }
104    Entry(QVector<Document> l) : documents(l) {}
105
106    QVector<Document> documents;
107};
108
109struct PosEntry {
110    PosEntry(int p) { positions.append(p); }
111    QList<uint> positions;
112};
113
114struct Term {
115    Term() : frequency(-1) {}
116    Term(const QString &t, int f, QVector<Document> l) : term(t), frequency(f), documents(l) {}
117    QString term;
118    int frequency;
119    QVector<Document>documents;
120    bool operator<(const Term &i2) const { return frequency < i2.frequency; }
121};
122
123struct TermInfo {
124    TermInfo() : frequency(-1) {}
125    TermInfo(const QString &t, int f, QVector<DocumentInfo> l)
126        : term(t), frequency(f), documents(l) {}
127
128    bool operator<(const TermInfo &i2) const { return frequency < i2.frequency; }
129
130    QString term;
131    int frequency;
132    QVector<DocumentInfo>documents;
133};
134
135} // namespace QtHelpInternal
136
137using QtHelpInternal::Document;
138using QtHelpInternal::DocumentInfo;
139using QtHelpInternal::Entry;
140using QtHelpInternal::PosEntry;
141using QtHelpInternal::Term;
142using QtHelpInternal::TermInfo;
143
144QDataStream &operator>>(QDataStream &s, Document &l);
145QDataStream &operator<<(QDataStream &s, const Document &l);
146
147QT_END_NAMESPACE
148
149#endif  // QHELPSEARCHINDEXDEFAULT_H
Note: See TracBrowser for help on using the repository browser.