1 /****************************************************************************
3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
4 ** All rights reserved.
5 ** Contact: Nokia Corporation (qt-info@nokia.com)
7 ** This file is part of the QtDeclarative module of the Qt Toolkit.
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.
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.
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.
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.
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 "private/qdeclarativemetatype_p.h"
57 #include "qdeclarativeerror.h"
58 #include "private/qdeclarativeparser_p.h"
59 #include "private/qdeclarativebinding_p.h"
61 #include <QtCore/qbytearray.h>
62 #include <QtCore/qxmlstream.h>
68 QT_MODULE(Declarative)
70 class QDeclarativeCompiler;
72 class QDeclarativeCustomParserPropertyPrivate;
73 class Q_DECLARATIVE_EXPORT QDeclarativeCustomParserProperty
76 QDeclarativeCustomParserProperty();
77 QDeclarativeCustomParserProperty(const QDeclarativeCustomParserProperty &);
78 QDeclarativeCustomParserProperty &operator=(const QDeclarativeCustomParserProperty &);
79 ~QDeclarativeCustomParserProperty();
81 QByteArray name() const;
82 QDeclarativeParser::Location location() const;
85 // Will be one of QDeclarativeParser::Variant, QDeclarativeCustomParserProperty or
86 // QDeclarativeCustomParserNode
87 QList<QVariant> assignedValues() const;
90 friend class QDeclarativeCustomParserNodePrivate;
91 friend class QDeclarativeCustomParserPropertyPrivate;
92 QDeclarativeCustomParserPropertyPrivate *d;
95 class QDeclarativeCustomParserNodePrivate;
96 class Q_DECLARATIVE_EXPORT QDeclarativeCustomParserNode
99 QDeclarativeCustomParserNode();
100 QDeclarativeCustomParserNode(const QDeclarativeCustomParserNode &);
101 QDeclarativeCustomParserNode &operator=(const QDeclarativeCustomParserNode &);
102 ~QDeclarativeCustomParserNode();
104 QByteArray name() const;
105 QDeclarativeParser::Location location() const;
107 QList<QDeclarativeCustomParserProperty> properties() const;
110 friend class QDeclarativeCustomParserNodePrivate;
111 QDeclarativeCustomParserNodePrivate *d;
114 class Q_DECLARATIVE_EXPORT QDeclarativeCustomParser
119 AcceptsAttachedProperties = 0x00000001,
120 AcceptsSignalHandlers = 0x00000002
122 Q_DECLARE_FLAGS(Flags, Flag)
124 QDeclarativeCustomParser() : compiler(0), object(0), m_flags(NoFlag) {}
125 QDeclarativeCustomParser(Flags f) : compiler(0), object(0), m_flags(f) {}
126 virtual ~QDeclarativeCustomParser() {}
129 Flags flags() const { return m_flags; }
131 virtual QByteArray compile(const QList<QDeclarativeCustomParserProperty> &)=0;
132 virtual void setCustomData(QObject *, const QByteArray &)=0;
134 QList<QDeclarativeError> errors() const { return exceptions; }
137 void error(const QString& description);
138 void error(const QDeclarativeCustomParserProperty&, const QString& description);
139 void error(const QDeclarativeCustomParserNode&, const QString& description);
141 int evaluateEnum(const QByteArray&) const;
143 const QMetaObject *resolveType(const QByteArray&) const;
145 QDeclarativeBinding::Identifier rewriteBinding(const QString&, const QByteArray&);
148 QList<QDeclarativeError> exceptions;
149 QDeclarativeCompiler *compiler;
150 QDeclarativeParser::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)