1 /****************************************************************************
2 **
3 ** Copyright (C) 2020 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of Qt Creator.
7 **
8 ** Commercial License Usage
9 ** Licensees holding valid commercial Qt licenses may use this file in
10 ** accordance with the commercial license agreement provided with the
11 ** Software or, alternatively, in accordance with the terms contained in
12 ** a written agreement between you and The Qt Company. For licensing terms
13 ** and conditions see https://www.qt.io/terms-conditions. For further
14 ** information use the contact form at https://www.qt.io/contact-us.
15 **
16 ** GNU General Public License Usage
17 ** Alternatively, this file may be used under the terms of the GNU
18 ** General Public License version 3 as published by the Free Software
19 ** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
20 ** included in the packaging of this file. Please review the following
21 ** information to ensure the GNU General Public License requirements will
22 ** be met: https://www.gnu.org/licenses/gpl-3.0.html.
23 **
24 ****************************************************************************/
25 
26 #pragma once
27 
28 #include <coreplugin/icore.h>
29 
30 #include <QString>
31 #include <QStringList>
32 #include <QSet>
33 #include <QHash>
34 
35 namespace QmlDesigner {
36 
37 class DesignerMcuManager
38 {
39 public:
40     struct Version {
41         QString name;
42         QString fileName;
43     };
44     using VersionsList = QList<Version>;
45 
46     struct ItemProperties {
47         QStringList properties;
48         bool allowChildren = true;
49     };
50 
51     static DesignerMcuManager& instance();
52 
53     static QString mcuResourcesPath();
54 
55     bool isMCUProject() const;
56 
57     void readMetadata();
58     void readVersionData(const DesignerMcuManager::Version &version);
59 
60     DesignerMcuManager::Version currentVersion() const;
61     DesignerMcuManager::Version defaultVersion() const;
62     DesignerMcuManager::VersionsList versions() const;
63 
64     QSet<QString> bannedItems() const;
65     QSet<QString> bannedProperties() const;
66 
67     QStringList allowedImports() const;
68     QStringList bannedImports() const;
69 
70     QHash<QString, ItemProperties> allowedItemProperties() const;
71     QHash<QString, QStringList> bannedComplexProperties() const;
72 
73     DesignerMcuManager(DesignerMcuManager const&) = delete;
74     void operator=(DesignerMcuManager const&) = delete;
75 
76 private:
77     DesignerMcuManager();
78     ~DesignerMcuManager();
79 
80 private:
81     DesignerMcuManager::Version m_currentVersion;
82     DesignerMcuManager::Version m_defaultVersion;
83 
84     QSet<QString> m_bannedItems;
85     QSet<QString> m_bannedProperties;
86     QStringList m_allowedImports;
87     QStringList m_bannedImports;
88     QHash<QString, ItemProperties> m_allowedItemProperties;
89     QHash<QString, QStringList> m_bannedComplexProperties;
90 
91     DesignerMcuManager::VersionsList m_versionsList;
92 
93 };
94 
95 } // namespace QmlDesigner
96