blob: d75e65a3e7e9cd8f16a01c997c60842d911489f1 [file] [log] [blame]
/****************************************************************************
**
** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
** 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$
** GNU Lesser General Public License Usage
** 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.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU General
** Public License version 3.0 as published by the Free Software Foundation
** and appearing in the file LICENSE.GPL included in the packaging of this
** file. Please review the following information to ensure the GNU General
** Public License version 3.0 requirements will be met:
** http://www.gnu.org/copyleft/gpl.html.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef QHELPSEARCHINDEXWRITERDEFAULT_H
#define QHELPSEARCHINDEXWRITERDEFAULT_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 "qhelpsearchindex_default_p.h"
#include <QtCore/QHash>
#include <QtCore/QMutex>
#include <QtCore/QObject>
#include <QtCore/QString>
#include <QtCore/QThread>
#include <QtCore/QStringList>
#include <QtCore/QWaitCondition>
QT_BEGIN_NAMESPACE
namespace fulltextsearch {
namespace std {
class Writer
{
public:
Writer(const QString &path);
~Writer();
void reset();
bool writeIndex() const;
void removeIndex() const;
void setIndexFile(const QString &namespaceName, const QString &attributes);
void insertInIndex(const QString &string, int docNum);
void insertInDocumentList(const QString &title, const QString &url);
private:
QString indexPath;
QString indexFile;
QString documentFile;
QHash<QString, Entry*> index;
QList<QStringList> documentList;
};
class QHelpSearchIndexWriter : public QThread
{
Q_OBJECT
public:
QHelpSearchIndexWriter();
~QHelpSearchIndexWriter();
void cancelIndexing();
void updateIndex(const QString &collectionFile,
const QString &indexFilesFolder, bool reindex);
signals:
void indexingStarted();
void indexingFinished();
private:
void run();
QString addNamespace(const QString namespaces, const QString &namespaceName);
QString removeNamespace(const QString namespaces, const QString &namespaceName);
private:
QMutex mutex;
QWaitCondition waitCondition;
bool m_cancel;
bool m_reindex;
QString m_collectionFile;
QString m_indexFilesFolder;
};
} // namespace std
} // namespace fulltextsearch
QT_END_NAMESPACE
#endif // QHELPSEARCHINDEXWRITERDEFAULT_H