qqmlpreviewfileloader.h

Go to the documentation of this file.

// Copyright (C) 2018 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
 
#ifndef QQMLPREVIEWFILELOADER_H
#define QQMLPREVIEWFILELOADER_H
 
//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt API.  It exists purely as an
// implementation detail.  This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//
 
#include "qqmlpreviewblacklist.h"
 
#include <QtCore/qobject.h>
#include <QtCore/qthread.h>
#include <QtCore/qmutex.h>
#include <QtCore/qwaitcondition.h>
#include <QtCore/qvector.h>
#include <QtCore/qurl.h>
#include <QtCore/qpointer.h>
#include <QtCore/qset.h>
 
QT_BEGIN_NAMESPACE
 
class QQmlPreviewServiceImpl;
class QQmlPreviewFileLoader : public QObject
{
    Q_OBJECT
public:
    enum Result {
        File,
        Directory,
        Fallback,
        Unknown
    };
 
    QQmlPreviewFileLoader(QQmlPreviewServiceImpl *service);
 
    QMutex *loadMutex() { return &m_loadMutex; }
    Result load(const QString &file);
 
    QByteArray contents();
    QStringList entries();
 
    void whitelist(const QUrl &url);
    bool isBlacklisted(const QString &file);
 
Q_SIGNALS:
    void request(const QString &file);
 
private:
    QMutex m_loadMutex;
    QMutex m_contentMutex;
    QWaitCondition m_waitCondition;
 
    QString m_path;
    QByteArray m_contents;
    QStringList m_entries;
    Result m_result;
 
    QQmlPreviewBlacklist m_blacklist;
    QHash<QString, QByteArray> m_fileCache;
    QHash<QString, QStringList> m_directoryCache;
 
    void file(const QString &file, const QByteArray &contents);
    void directory(const QString &file, const QStringList &entries);
    void error(const QString &file);
    void clearCache();
};
 
QT_END_NAMESPACE
 
#endif // QQMLPREVIEWFILELOADER_H