1/****************************************************************************
2**
3** Copyright (C) 2018 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QML preview debug service.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QQMLPREVIEWFILELOADER_H
41#define QQMLPREVIEWFILELOADER_H
42
43//
44// W A R N I N G
45// -------------
46//
47// This file is not part of the Qt API. It exists purely as an
48// implementation detail. This header file may change from version to
49// version without notice, or even be removed.
50//
51// We mean it.
52//
53
54#include "qqmlpreviewblacklist.h"
55
56#include <QtCore/qobject.h>
57#include <QtCore/qthread.h>
58#include <QtCore/qmutex.h>
59#include <QtCore/qwaitcondition.h>
60#include <QtCore/qvector.h>
61#include <QtCore/qurl.h>
62#include <QtCore/qpointer.h>
63#include <QtCore/qset.h>
64
65QT_BEGIN_NAMESPACE
66
67class QQmlPreviewServiceImpl;
68class QQmlPreviewFileLoader : public QObject
69{
70 Q_OBJECT
71public:
72 enum Result {
73 File,
74 Directory,
75 Fallback,
76 Unknown
77 };
78
79 QQmlPreviewFileLoader(QQmlPreviewServiceImpl *service);
80 ~QQmlPreviewFileLoader();
81
82 QMutex *loadMutex() { return &m_loadMutex; }
83 Result load(const QString &file);
84
85 QByteArray contents();
86 QStringList entries();
87
88 void whitelist(const QUrl &url);
89 bool isBlacklisted(const QString &file);
90
91signals:
92 void request(const QString &file);
93
94private:
95 QMutex m_loadMutex;
96 QMutex m_contentMutex;
97 QWaitCondition m_waitCondition;
98
99 QThread m_thread;
100 QPointer<QQmlPreviewServiceImpl> m_service;
101
102 QString m_path;
103 QByteArray m_contents;
104 QStringList m_entries;
105 Result m_result;
106
107 QQmlPreviewBlacklist m_blacklist;
108 QHash<QString, QByteArray> m_fileCache;
109 QHash<QString, QStringList> m_directoryCache;
110
111 void file(const QString &file, const QByteArray &contents);
112 void directory(const QString &file, const QStringList &entries);
113 void error(const QString &file);
114 void clearCache();
115};
116
117QT_END_NAMESPACE
118
119#endif // QQMLPREVIEWFILELOADER_H
120

source code of qtdeclarative/src/plugins/qmltooling/qmldbg_preview/qqmlpreviewfileloader.h