source: branches/vendor/trolltech/qt/current/tools/assistant/lib/qhelpsearchindexwriter_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: 3.9 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 QHELPSEARCHINDEXWRITERDEFAULT_H
43#define QHELPSEARCHINDEXWRITERDEFAULT_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 "qhelpsearchindex_default_p.h"
57
58#include <QtCore/QHash>
59#include <QtCore/QMutex>
60#include <QtCore/QObject>
61#include <QtCore/QString>
62#include <QtCore/QThread>
63#include <QtCore/QStringList>
64#include <QtCore/QWaitCondition>
65
66QT_BEGIN_NAMESPACE
67
68namespace qt {
69    namespace fulltextsearch {
70        namespace std {
71
72class Writer
73{
74public:
75    Writer(const QString &path);
76    ~Writer();
77
78    void reset();
79    bool writeIndex() const;
80    void removeIndex() const;
81    void setIndexFile(const QString &namespaceName, const QString &attributes);
82    void insertInIndex(const QString &string, int docNum);
83    void insertInDocumentList(const QString &title, const QString &url);
84
85private:
86    QString indexPath;
87    QString indexFile;
88    QString documentFile;
89
90    QHash<QString, Entry*> index;
91    QList<QStringList> documentList;
92};
93
94
95class QHelpSearchIndexWriter : public QThread
96{
97    Q_OBJECT
98
99public:
100    QHelpSearchIndexWriter();
101    ~QHelpSearchIndexWriter();
102
103    void cancelIndexing();
104    void updateIndex(const QString &collectionFile,
105        const QString &indexFilesFolder, bool reindex);
106
107signals:
108    void indexingStarted();
109    void indexingFinished();
110
111private:
112    void run();
113    QString addNamespace(const QString namespaces, const QString &namespaceName);
114    QString removeNamespace(const QString namespaces, const QString &namespaceName);
115
116private:
117    QMutex mutex;
118    QWaitCondition waitCondition;
119
120    bool m_cancel;
121    bool m_reindex;
122    QString m_collectionFile;
123    QString m_indexFilesFolder;
124};
125
126        }   // namespace std
127    }   // namespace fulltextsearch
128}   // namespace qt
129
130QT_END_NAMESPACE
131
132#endif  // QHELPSEARCHINDEXWRITERDEFAULT_H
Note: See TracBrowser for help on using the repository browser.