Files
qt4-x11/tools/assistant/lib/qhelpsearchindexwriter_default_p.h
2025-08-24 20:55:26 +08:00

131 lines
3.9 KiB
C++

/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the Qt Assistant of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see http://www.qt.io/terms-conditions. For further
** information use the contact form at http://www.qt.io/contact-us.
**
** 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 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file. Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** As a special exception, The Qt Company gives you certain additional
** rights. These rights are described in The Qt Company 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.
**
** $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