1 /****************************************************************************
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/
6 ** This file is part of the QtDeclarative module of the Qt Toolkit.
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** GNU Lesser General Public License Usage
10 ** This file may be used under the terms of the GNU Lesser General Public
11 ** License version 2.1 as published by the Free Software Foundation and
12 ** appearing in the file LICENSE.LGPL included in the packaging of this
13 ** file. Please review the following information to ensure the GNU Lesser
14 ** General Public License version 2.1 requirements will be met:
15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
17 ** In addition, as a special exception, Nokia gives you certain additional
18 ** rights. These rights are described in the Nokia Qt LGPL Exception
19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
21 ** GNU General Public License Usage
22 ** Alternatively, this file may be used under the terms of the GNU General
23 ** Public License version 3.0 as published by the Free Software Foundation
24 ** and appearing in the file LICENSE.GPL included in the packaging of this
25 ** file. Please review the following information to ensure the GNU General
26 ** Public License version 3.0 requirements will be met:
27 ** http://www.gnu.org/copyleft/gpl.html.
30 ** Alternatively, this file may be used in accordance with the terms and
31 ** conditions contained in a signed written agreement between you and Nokia.
40 ****************************************************************************/
42 #ifndef QDECLARATIVECUSTOMPARSER_H
43 #define QDECLARATIVECUSTOMPARSER_H
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.
56 #include "qdeclarativemetatype_p.h"
57 #include "qdeclarativeerror.h"
58 #include "qdeclarativescript_p.h"
59 #include "qdeclarativebinding_p.h"
61 #include <QtCore/qbytearray.h>
62 #include <QtCore/qxmlstream.h>
69 class QDeclarativeCompiler;
71 class QDeclarativeCustomParserPropertyPrivate;
72 class Q_DECLARATIVE_EXPORT QDeclarativeCustomParserProperty
75 QDeclarativeCustomParserProperty();
76 QDeclarativeCustomParserProperty(const QDeclarativeCustomParserProperty &);
77 QDeclarativeCustomParserProperty &operator=(const QDeclarativeCustomParserProperty &);
78 ~QDeclarativeCustomParserProperty();
81 QDeclarativeScript::Location location() const;
84 // Will be one of QDeclarativeScript::Variant, QDeclarativeCustomParserProperty or
85 // QDeclarativeCustomParserNode
86 QList<QVariant> assignedValues() const;
89 friend class QDeclarativeCustomParserNodePrivate;
90 friend class QDeclarativeCustomParserPropertyPrivate;
91 QDeclarativeCustomParserPropertyPrivate *d;
94 class QDeclarativeCustomParserNodePrivate;
95 class Q_DECLARATIVE_EXPORT QDeclarativeCustomParserNode
98 QDeclarativeCustomParserNode();
99 QDeclarativeCustomParserNode(const QDeclarativeCustomParserNode &);
100 QDeclarativeCustomParserNode &operator=(const QDeclarativeCustomParserNode &);
101 ~QDeclarativeCustomParserNode();
103 QString name() const;
104 QDeclarativeScript::Location location() const;
106 QList<QDeclarativeCustomParserProperty> properties() const;
109 friend class QDeclarativeCustomParserNodePrivate;
110 QDeclarativeCustomParserNodePrivate *d;
113 class Q_DECLARATIVE_EXPORT QDeclarativeCustomParser
118 AcceptsAttachedProperties = 0x00000001,
119 AcceptsSignalHandlers = 0x00000002
121 Q_DECLARE_FLAGS(Flags, Flag)
123 QDeclarativeCustomParser() : compiler(0), object(0), m_flags(NoFlag) {}
124 QDeclarativeCustomParser(Flags f) : compiler(0), object(0), m_flags(f) {}
125 virtual ~QDeclarativeCustomParser() {}
128 Flags flags() const { return m_flags; }
130 virtual QByteArray compile(const QList<QDeclarativeCustomParserProperty> &)=0;
131 virtual void setCustomData(QObject *, const QByteArray &)=0;
133 QList<QDeclarativeError> errors() const { return exceptions; }
136 void error(const QString& description);
137 void error(const QDeclarativeCustomParserProperty&, const QString& description);
138 void error(const QDeclarativeCustomParserNode&, const QString& description);
140 int evaluateEnum(const QByteArray&) const;
142 const QMetaObject *resolveType(const QString&) const;
144 QDeclarativeBinding::Identifier rewriteBinding(const QDeclarativeScript::Variant&, const QString&);
145 QString rewriteSignalHandler(const QDeclarativeScript::Variant&, const QString&);
148 QList<QDeclarativeError> exceptions;
149 QDeclarativeCompiler *compiler;
150 QDeclarativeScript::Object *object;
152 friend class QDeclarativeCompiler;
154 Q_DECLARE_OPERATORS_FOR_FLAGS(QDeclarativeCustomParser::Flags);
157 #define QML_REGISTER_CUSTOM_TYPE(URI, VERSION_MAJ, VERSION_MIN, NAME, TYPE, CUSTOMTYPE) \
158 qmlRegisterCustomType<TYPE>(#URI, VERSION_MAJ, VERSION_MIN, #NAME, #TYPE, new CUSTOMTYPE)
163 Q_DECLARE_METATYPE(QDeclarativeCustomParserProperty)
164 Q_DECLARE_METATYPE(QDeclarativeCustomParserNode)