1 /****************************************************************************

     2 **

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

     4 ** All rights reserved.

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

     6 **

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

     8 **

     9 ** $QT_BEGIN_LICENSE:LGPL$

    10 ** No Commercial Usage

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

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

    13 ** contained in the Technology Preview License Agreement accompanying

    14 ** this package.

    15 **

    16 ** GNU Lesser General Public License Usage

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

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

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

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

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

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

    23 **

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

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

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

    27 **

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

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

    30 **

    31 **

    32 **

    33 **

    34 **

    35 **

    36 **

    37 **

    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 

    66 QT_BEGIN_NAMESPACE

    67 

    68 namespace qt {

    69     namespace fulltextsearch {

    70         namespace std {

    71 

    72 class Writer

    73 {

    74 public:

    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 

    85 private:

    86     QString indexPath;

    87     QString indexFile;

    88     QString documentFile;

    89 

    90     QHash<QString, Entry*> index;

    91     QList<QStringList> documentList;

    92 };

    93 

    94 

    95 class QHelpSearchIndexWriter : public QThread

    96 {

    97     Q_OBJECT

    98 

    99 public:

   100     QHelpSearchIndexWriter();

   101     ~QHelpSearchIndexWriter();

   102 

   103     void cancelIndexing();

   104     void updateIndex(const QString &collectionFile,

   105         const QString &indexFilesFolder, bool reindex);

   106 

   107 signals:

   108     void indexingStarted();

   109     void indexingFinished();

   110 

   111 private:

   112     void run();

   113     QString addNamespace(const QString namespaces, const QString &namespaceName);

   114     QString removeNamespace(const QString namespaces, const QString &namespaceName);

   115 

   116 private:

   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 

   130 QT_END_NAMESPACE

   131 

   132 #endif  // QHELPSEARCHINDEXWRITERDEFAULT_H