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 QHELPSEARCHINDEXREADERDEFAULT_H

    43 #define QHELPSEARCHINDEXREADERDEFAULT_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 #include "qhelpsearchindexreader_p.h"

    58 

    59 #include <QtCore/QHash>

    60 #include <QtCore/QPair>

    61 

    62 QT_BEGIN_NAMESPACE

    63 

    64 struct Entry;

    65 struct PosEntry;

    66 

    67 namespace qt {

    68     namespace fulltextsearch {

    69         namespace std {

    70 

    71 class Reader

    72 {

    73     typedef QList<QStringList> DocumentList;

    74     typedef QHash<QString, Entry*> EntryTable;

    75     typedef QPair<EntryTable, DocumentList> Index;

    76     typedef QHash<QString, Index> IndexTable;

    77 

    78 public:

    79     Reader();

    80     ~Reader();

    81 

    82     bool readIndex();

    83     bool initCheck() const;

    84     void setIndexPath(const QString &path);

    85     void filterFilesForAttributes(const QStringList &attributes);

    86     void setIndexFile(const QString &namespaceName, const QString &attributes);

    87     bool splitSearchTerm(const QString &searchTerm, QStringList *terms,

    88         QStringList *termSeq, QStringList *seqWords);

    89 

    90     void searchInIndex(const QStringList &terms);

    91     QVector<DocumentInfo> hits();

    92     bool searchForPattern(const QStringList &patterns,

    93         const QStringList &words, const QByteArray &data);

    94 

    95 private:

    96     QVector<Document> setupDummyTerm(const QStringList &terms, const EntryTable &entryTable);

    97     QStringList getWildcardTerms(const QString &term, const EntryTable &entryTable);

    98     void buildMiniIndex(const QString &string);

    99     void reset();

   100     void cleanupIndex(EntryTable &entryTable);

   101 

   102 private:

   103     uint wordNum;

   104     QString indexPath;

   105     QString indexFile;

   106     QString documentFile;

   107 

   108     IndexTable indexTable;

   109     QList<TermInfo> termList;

   110     IndexTable searchIndexTable;

   111     QHash<QString, PosEntry*> miniIndex;

   112 };

   113 

   114 

   115 class QHelpSearchIndexReaderDefault : public QHelpSearchIndexReader

   116 {

   117     Q_OBJECT

   118 

   119 public:

   120     QHelpSearchIndexReaderDefault();

   121     ~QHelpSearchIndexReaderDefault();

   122 

   123 private:

   124     void run();

   125 

   126 private:

   127     Reader m_reader;

   128 };

   129 

   130         }   // namespace std

   131     }   // namespace fulltextsearch

   132 }   // namespace qt

   133 

   134 QT_END_NAMESPACE

   135 

   136 #endif  // QHELPSEARCHINDEXREADERDEFAULT_H