Merge remote-tracking branch 'qt/4.8'
[qt:qt.git] / src / declarative / qml / qdeclarativedirparser_p.h
1 /****************************************************************************
2 **
3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
4 ** All rights reserved.
5 ** Contact: Nokia Corporation (qt-info@nokia.com)
6 **
7 ** This file is part of the QtDeclarative module of the Qt Toolkit.
8 **
9 ** $QT_BEGIN_LICENSE:LGPL$
10 ** GNU Lesser General Public License Usage
11 ** This file may be used under the terms of the GNU Lesser General Public
12 ** License version 2.1 as published by the Free Software Foundation and
13 ** appearing in the file LICENSE.LGPL included in the packaging of this
14 ** file. Please review the following information to ensure the GNU Lesser
15 ** General Public License version 2.1 requirements will be met:
16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
17 **
18 ** In addition, as a special exception, Nokia gives you certain additional
19 ** rights. These rights are described in the Nokia Qt LGPL Exception
20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
21 **
22 ** GNU General Public License Usage
23 ** Alternatively, this file may be used under the terms of the GNU General
24 ** Public License version 3.0 as published by the Free Software Foundation
25 ** and appearing in the file LICENSE.GPL included in the packaging of this
26 ** file. Please review the following information to ensure the GNU General
27 ** Public License version 3.0 requirements will be met:
28 ** http://www.gnu.org/copyleft/gpl.html.
29 **
30 ** Other Usage
31 ** Alternatively, this file may be used in accordance with the terms and
32 ** conditions contained in a signed written agreement between you and Nokia.
33 **
34 **
35 **
36 **
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     bool isParsed() const;
77     bool parse();
78
79     bool hasError() const;
80     QList<QDeclarativeError> errors() const;
81
82     struct Plugin
83     {
84         Plugin() {}
85
86         Plugin(const QString &name, const QString &path)
87             : name(name), path(path) {}
88
89         QString name;
90         QString path;
91     };
92
93     struct Component
94     {
95         Component()
96             : majorVersion(0), minorVersion(0), internal(false) {}
97
98         Component(const QString &typeName, const QString &fileName, int majorVersion, int minorVersion)
99             : typeName(typeName), fileName(fileName), majorVersion(majorVersion), minorVersion(minorVersion),
100             internal(false) {}
101
102         QString typeName;
103         QString fileName;
104         int majorVersion;
105         int minorVersion;
106         bool internal;
107     };
108
109     QList<Component> components() const;
110     QList<Plugin> plugins() const;
111
112 #ifdef QT_CREATOR
113     struct TypeInfo
114     {
115         TypeInfo() {}
116         TypeInfo(const QString &fileName)
117             : fileName(fileName) {}
118
119         QString fileName;
120     };
121
122     QList<TypeInfo> typeInfos() const;
123 #endif
124
125 private:
126     void reportError(int line, int column, const QString &message);
127
128 private:
129     QList<QDeclarativeError> _errors;
130     QUrl _url;
131     QString _source;
132     QList<Component> _components;
133     QList<Plugin> _plugins;
134 #ifdef QT_CREATOR
135     QList<TypeInfo> _typeInfos;
136 #endif
137     unsigned _isParsed: 1;
138 };
139
140 typedef QList<QDeclarativeDirParser::Component> QDeclarativeDirComponents;
141
142
143 QT_END_NAMESPACE
144
145 #endif // QDECLARATIVEDIRPARSER_P_H