/****************************************************************************

**

** All rights reserved.

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

**

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

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

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

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

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

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

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

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

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

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

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

**

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

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

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

**

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

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

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

#ifndef QHELPSEARCHINDEXREADER_H

#define QHELPSEARCHINDEXREADER_H

//

//  W A R N I N G

//  -------------

//

// This file is not part of the Qt API. It exists for the convenience

// of the help generator tools. This header file may change from version

// to version without notice, or even be removed.

//

// We mean it.

//

#include "qhelpsearchengine.h"

#include <QtCore/QList>

#include <QtCore/QMutex>

#include <QtCore/QObject>

#include <QtCore/QString>

#include <QtCore/QThread>

#include <QtCore/QWaitCondition>

QT_BEGIN_NAMESPACE

class QHelpEngineCore;

class QHelpSearchIndexReader : public QThread

{

    Q_OBJECT

public:

    QHelpSearchIndexReader();

    ~QHelpSearchIndexReader();

    void cancelSearching();

    void search(const QString &collectionFile,

        const QString &indexFilesFolder,

        const QList<QHelpSearchQuery> &queryList);

    int hitCount() const;

    QList<QHelpSearchEngine::SearchHit> hits(int start, int end) const;

signals:

    void searchingStarted();

    void searchingFinished(int hits);

protected:

    mutable QMutex mutex;

    QList<QHelpSearchEngine::SearchHit> hitList;

    bool m_cancel;

    QString m_collectionFile;

    QList<QHelpSearchQuery> m_query;

    QString m_indexFilesFolder;

private:

    virtual void run()=0;

};

QT_END_NAMESPACE

#endif  // QHELPSEARCHINDEXREADER_H