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 QQMLPREVIEWFILEENGINE_H |
41 | #define QQMLPREVIEWFILEENGINE_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 "qqmlpreviewfileloader.h" |
55 | |
56 | #include <private/qabstractfileengine_p.h> |
57 | #include <private/qfsfileengine_p.h> |
58 | #include <QtCore/qbuffer.h> |
59 | |
60 | QT_BEGIN_NAMESPACE |
61 | |
62 | class QQmlPreviewFileEngine : public QAbstractFileEngine |
63 | { |
64 | public: |
65 | QQmlPreviewFileEngine(const QString &file, const QString &absolute, |
66 | QQmlPreviewFileLoader *loader); |
67 | |
68 | void setFileName(const QString &file) override; |
69 | |
70 | bool open(QIODevice::OpenMode flags) override ; |
71 | bool close() override; |
72 | qint64 size() const override; |
73 | qint64 pos() const override; |
74 | bool seek(qint64) override; |
75 | qint64 read(char *data, qint64 maxlen) override; |
76 | |
77 | FileFlags fileFlags(FileFlags type) const override; |
78 | QString fileName(QAbstractFileEngine::FileName file) const override; |
79 | uint ownerId(FileOwner) const override; |
80 | |
81 | Iterator *beginEntryList(QDir::Filters filters, const QStringList &filterNames) override; |
82 | Iterator *endEntryList() override; |
83 | |
84 | // Forwarding to fallback if exists |
85 | bool flush() override; |
86 | bool syncToDisk() override; |
87 | bool isSequential() const override; |
88 | bool remove() override; |
89 | bool copy(const QString &newName) override; |
90 | bool rename(const QString &newName) override; |
91 | bool renameOverwrite(const QString &newName) override; |
92 | bool link(const QString &newName) override; |
93 | bool mkdir(const QString &dirName, bool createParentDirectories) const override; |
94 | bool rmdir(const QString &dirName, bool recurseParentDirectories) const override; |
95 | bool setSize(qint64 size) override; |
96 | bool caseSensitive() const override; |
97 | bool isRelativePath() const override; |
98 | QStringList entryList(QDir::Filters filters, const QStringList &filterNames) const override; |
99 | bool setPermissions(uint perms) override; |
100 | QByteArray id() const override; |
101 | QString owner(FileOwner) const override; |
102 | QDateTime fileTime(FileTime time) const override; |
103 | int handle() const override; |
104 | qint64 readLine(char *data, qint64 maxlen) override; |
105 | qint64 write(const char *data, qint64 len) override; |
106 | bool extension(Extension extension, const ExtensionOption *option, ExtensionReturn *output) override; |
107 | bool supportsExtension(Extension extension) const override; |
108 | |
109 | private: |
110 | void load() const; |
111 | |
112 | QString m_name; |
113 | QString m_absolute; |
114 | QPointer<QQmlPreviewFileLoader> m_loader; |
115 | |
116 | mutable QBuffer m_contents; |
117 | mutable QStringList m_entries; |
118 | mutable QScopedPointer<QAbstractFileEngine> m_fallback; |
119 | mutable QQmlPreviewFileLoader::Result m_result = QQmlPreviewFileLoader::Unknown; |
120 | }; |
121 | |
122 | class QQmlPreviewFileEngineHandler : public QAbstractFileEngineHandler |
123 | { |
124 | public: |
125 | QQmlPreviewFileEngineHandler(QQmlPreviewFileLoader *loader); |
126 | QAbstractFileEngine *create(const QString &fileName) const override; |
127 | |
128 | private: |
129 | QPointer<QQmlPreviewFileLoader> m_loader; |
130 | }; |
131 | |
132 | |
133 | |
134 | QT_END_NAMESPACE |
135 | |
136 | #endif // QQMLPREVIEWFILEENGINE_H |
137 | |