Revision control
Copy as Markdown
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
// Qt-Security score:significant reason:header-decls-only
#ifndef QHELPDBREADER_H
#define QHELPDBREADER_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 <QtCore/qbytearray.h>
#include <QtCore/qobject.h>
#include <QtCore/qstringlist.h>
#include <functional>
QT_BEGIN_NAMESPACE
class QSqlQuery;
class QVersionNumber;
class QHelpDBReader : public QObject
{
Q_OBJECT
public:
class IndexItem
{
public:
QString name;
QString identifier;
int fileId = 0;
QString anchor;
QStringList filterAttributes;
};
class FileItem
{
public:
QString name;
QString title;
QStringList filterAttributes;
};
class ContentsItem
{
public:
QByteArray data;
QStringList filterAttributes;
};
class IndexTable
{
public:
QList<IndexItem> indexItems;
QList<FileItem> fileItems;
QList<ContentsItem> contentsItems;
QStringList usedFilterAttributes;
};
QHelpDBReader(const QString &dbName);
QHelpDBReader(const QString &dbName, const QString &uniqueId, QObject *parent);
~QHelpDBReader();
bool init();
QString namespaceName() const;
QString virtualFolder() const;
QString version() const;
IndexTable indexTable() const;
QList<QStringList> filterAttributeSets() const;
// Calls the handler for each matching file, decompressing one file at a time.
// Stops when the handler returns false. The handler must not use this reader.
void filesData(const QStringList &filterAttributes, const QStringList &extensionFilters,
const std::function<bool(const QString &fileName,
const QByteArray &data)> &handler) const;
QByteArray fileData(const QString &virtualFolder, const QString &filePath) const;
QStringList customFilters() const;
QStringList filterAttributes(const QString &filterName = {}) const;
QVariant metaData(const QString &name) const;
static QVersionNumber versionHeuristic(const QString &namespaceName);
private:
QString quote(const QString &string) const;
bool initDB();
QString qtVersionHeuristic() const;
bool m_initDone = false;
QString m_dbName;
QString m_uniqueId;
QString m_error;
std::unique_ptr<QSqlQuery> m_query;
mutable QString m_namespace;
};
QT_END_NAMESPACE
#endif // QHELPDBREADER_H