1 /****************************************************************************
2 **
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://www.qt.io/licensing/
5 **
6 ** This file is part of the QtDeclarative module of the Qt Toolkit.
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 http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://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 2.1 or version 3 as published by the Free
20 ** Software Foundation and appearing in the file LICENSE.LGPLv21 and
21 ** LICENSE.LGPLv3 included in the packaging of this file. Please review the
22 ** following information to ensure the GNU Lesser General Public License
23 ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
24 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25 **
26 ** As a special exception, The Qt Company gives you certain additional
27 ** rights. These rights are described in The Qt Company LGPL Exception
28 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29 **
30 ** GNU General Public License Usage
31 ** Alternatively, this file may be used under the terms of the GNU
32 ** General Public License version 3.0 as published by the Free Software
33 ** Foundation and appearing in the file LICENSE.GPL included in the
34 ** packaging of this file.  Please review the following information to
35 ** ensure the GNU General Public License version 3.0 requirements will be
36 ** met: http://www.gnu.org/copyleft/gpl.html.
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41 
42 #ifndef QDECLARATIVEDIRPARSER_P_H
43 #define QDECLARATIVEDIRPARSER_P_H
44 
45 //
46 //  W A R N I N G
47 //  -------------
48 //
49 // This file is not part of the Qt API.  It exists purely as an
50 // implementation detail.  This header file may change from version to
51 // version without notice, or even be removed.
52 //
53 // We mean it.
54 //
55 
56 #include <QtCore/QUrl>
57 #include <QtCore/QHash>
58 
59 QT_BEGIN_NAMESPACE
60 
61 class QDeclarativeError;
62 class QDeclarativeDirParser
63 {
64     Q_DISABLE_COPY(QDeclarativeDirParser)
65 
66 public:
67     QDeclarativeDirParser();
68     ~QDeclarativeDirParser();
69 
70     QUrl url() const;
71     void setUrl(const QUrl &url);
72 
73     QString source() const;
74     void setSource(const QString &source);
75 
76     QString fileSource() const;
77     void setFileSource(const QString &filePath);
78 
79     bool isParsed() const;
80     bool parse();
81 
82     bool hasError() const;
83     QList<QDeclarativeError> errors(const QString &uri) const;
84 
85     struct Plugin
86     {
PluginPlugin87         Plugin() {}
88 
PluginPlugin89         Plugin(const QString &name, const QString &path)
90             : name(name), path(path) {}
91 
92         QString name;
93         QString path;
94     };
95 
96     struct Component
97     {
ComponentComponent98         Component()
99             : majorVersion(0), minorVersion(0), internal(false) {}
100 
ComponentComponent101         Component(const QString &typeName, const QString &fileName, int majorVersion, int minorVersion)
102             : typeName(typeName), fileName(fileName), majorVersion(majorVersion), minorVersion(minorVersion),
103             internal(false) {}
104 
105         QString typeName;
106         QString fileName;
107         int majorVersion;
108         int minorVersion;
109         bool internal;
110     };
111 
112     QList<Component> components() const;
113     QList<Plugin> plugins() const;
114 
115 #ifdef QT_CREATOR
116     struct TypeInfo
117     {
TypeInfoTypeInfo118         TypeInfo() {}
TypeInfoTypeInfo119         TypeInfo(const QString &fileName)
120             : fileName(fileName) {}
121 
122         QString fileName;
123     };
124 
125     QList<TypeInfo> typeInfos() const;
126 #endif
127 
128 private:
129     void reportError(int line, int column, const QString &message);
130 
131 private:
132     QList<QDeclarativeError> _errors;
133     QUrl _url;
134     QString _source;
135     QString _filePathSouce;
136     QList<Component> _components;
137     QList<Plugin> _plugins;
138 #ifdef QT_CREATOR
139     QList<TypeInfo> _typeInfos;
140 #endif
141     unsigned _isParsed: 1;
142 };
143 
144 typedef QList<QDeclarativeDirParser::Component> QDeclarativeDirComponents;
145 
146 
147 QT_END_NAMESPACE
148 
149 #endif // QDECLARATIVEDIRPARSER_P_H
150