tools/assistant/lib/qhelpsearchindexreader_p.h
changeset 0 1918ee327afb
child 3 41300fa6a67c
equal deleted inserted replaced
-1:000000000000 0:1918ee327afb
       
     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 QHELPSEARCHINDEXREADER_H
       
    43 #define QHELPSEARCHINDEXREADER_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 "qhelpsearchengine.h"
       
    57 
       
    58 #include <QtCore/QList>
       
    59 #include <QtCore/QMutex>
       
    60 #include <QtCore/QObject>
       
    61 #include <QtCore/QString>
       
    62 #include <QtCore/QThread>
       
    63 #include <QtCore/QWaitCondition>
       
    64 
       
    65 QT_BEGIN_NAMESPACE
       
    66 
       
    67 class QHelpEngineCore;
       
    68 
       
    69 namespace qt {
       
    70     namespace fulltextsearch {
       
    71 
       
    72 class QHelpSearchIndexReader : public QThread
       
    73 {
       
    74     Q_OBJECT
       
    75 
       
    76 public:
       
    77     QHelpSearchIndexReader();
       
    78     ~QHelpSearchIndexReader();
       
    79 
       
    80     void cancelSearching();
       
    81     void search(const QString &collectionFile,
       
    82         const QString &indexFilesFolder,
       
    83         const QList<QHelpSearchQuery> &queryList);
       
    84     int hitsCount() const;
       
    85     QList<QHelpSearchEngine::SearchHit> hits(int start, int end) const;
       
    86 
       
    87 signals:
       
    88     void searchingStarted();
       
    89     void searchingFinished(int hits);
       
    90 
       
    91 protected:
       
    92     mutable QMutex mutex;
       
    93     QList<QHelpSearchEngine::SearchHit> hitList;
       
    94     bool m_cancel;
       
    95     QString m_collectionFile;
       
    96     QList<QHelpSearchQuery> m_query;
       
    97     QString m_indexFilesFolder;
       
    98 
       
    99 private:
       
   100     virtual void run()=0;
       
   101 };
       
   102 
       
   103     }   // namespace fulltextsearch
       
   104 }  // namespace qt
       
   105 
       
   106 QT_END_NAMESPACE
       
   107 
       
   108 #endif  // QHELPSEARCHINDEXREADER_H