summaryrefslogtreecommitdiffstats
path: root/src/declarative/qml/qmlcustomparser.cpp
blob: dbcbeb15392fce49d38bedbceff3c3264677fd69 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
/****************************************************************************
**
** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
** Contact: Qt Software Information (qt-info@nokia.com)
**
** This file is part of the QtDeclarative module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the either Technology Preview License Agreement or the
** Beta Release License Agreement.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain
** additional rights. These rights are described in the Nokia Qt LGPL
** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
** package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at qt-sales@nokia.com.
** $QT_END_LICENSE$
**
****************************************************************************/

#include "qmlcustomparser_p.h"
#include "qmlcustomparser_p_p.h"
#include "qmlparser_p.h"

#include <QtCore/qdebug.h>

QT_BEGIN_NAMESPACE

using namespace QmlParser;

/*!
    \class QmlCustomParser
    \brief The QmlCustomParser class allows you to add new arbitrary types to QML.
    \internal

    By subclassing QmlCustomParser, you can add an XML parser for
    building a particular type.

    The subclass must implement compile() and create(), and define
    itself in the meta type system with one of the macros:

    \code
    QML_DEFINE_CUSTOM_PARSER(Name, parserClass)
    \endcode

    \code
    QML_DEFINE_CUSTOM_PARSER_NS("XmlNamespaceUri", Name, parserClass)
    \endcode
*/

/*
    \fn QByteArray QmlCustomParser::compile(QXmlStreamReader& reader)

    Upon entry to this function, \a reader is positioned on a
    QXmlStreamReader::StartElement with the name specified when the
    class was defined with the QML_DEFINE_CUSTOM_PARSER macro.

    The custom parser must consume tokens from \a reader until the
    EndElement matching the initial start element is reached, or until
    error.

    Errors must be reported via the error() functions.

    The returned QByteArray contains data meaningful only to the
    custom parser; the type engine will pass this same data to
    create() when making an instance of the data.

    The QByteArray may be cached between executions of the system, so
    it must contain correctly-serialized data (not, for example,
    pointers to stack objects).
*/

/*
    \fn QVariant QmlCustomParser::create(const QByteArray &data)

    This function returns a QVariant containing the value represented
    by \a data, which is a block of data previously returned by a call
    to compile().

    If the compile is for a type, the variant should be a pointer to
    the correctly-named QObject subclass (i.e. the one defined by
    QML_DEFINE_TYPE for the same-named type as this custom parser is
    defined for).
*/

QmlCustomParserNode 
QmlCustomParserNodePrivate::fromObject(QmlParser::Object *root)
{
    QmlCustomParserNode rootNode;
    rootNode.d->name = root->typeName;
    rootNode.d->location = root->location.start;

    for(QHash<QByteArray, Property *>::Iterator iter = root->properties.begin();
        iter != root->properties.end();
        ++iter) {

        Property *p = *iter;

        rootNode.d->properties << fromProperty(p);
    }

    return rootNode;
}

QmlCustomParserProperty 
QmlCustomParserNodePrivate::fromProperty(QmlParser::Property *p)
{
    QmlCustomParserProperty prop;
    prop.d->name = p->name;
    prop.d->isList = (p->values.count() > 1);
    prop.d->location = p->location.start;

    if (p->value) {
        QmlCustomParserNode node = fromObject(p->value);
        QList<QmlCustomParserProperty> props = node.properties();
        for (int ii = 0; ii < props.count(); ++ii)
            prop.d->values << QVariant::fromValue(props.at(ii));
    } else {
        for(int ii = 0; ii < p->values.count(); ++ii) {
            Value *v = p->values.at(ii);
            v->type = QmlParser::Value::Literal;

            if(v->object) {
                QmlCustomParserNode node = fromObject(v->object);
                prop.d->values << QVariant::fromValue(node);
            } else {
                prop.d->values << QVariant::fromValue(v->value);
            }

        }
    }

    return prop;
}

QmlCustomParserNode::QmlCustomParserNode()
: d(new QmlCustomParserNodePrivate)
{
}

QmlCustomParserNode::QmlCustomParserNode(const QmlCustomParserNode &other)
: d(new QmlCustomParserNodePrivate)
{
    *this = other;
}

QmlCustomParserNode &QmlCustomParserNode::operator=(const QmlCustomParserNode &other)
{
    d->name = other.d->name;
    d->properties = other.d->properties;
    d->location = other.d->location;
    return *this;
}

QmlCustomParserNode::~QmlCustomParserNode()
{
    delete d; d = 0;
}

QByteArray QmlCustomParserNode::name() const
{
    return d->name;
}

QList<QmlCustomParserProperty> QmlCustomParserNode::properties() const
{
    return d->properties;
}

QmlParser::Location QmlCustomParserNode::location() const
{
    return d->location;
}

QmlCustomParserProperty::QmlCustomParserProperty()
: d(new QmlCustomParserPropertyPrivate)
{
}

QmlCustomParserProperty::QmlCustomParserProperty(const QmlCustomParserProperty &other)
: d(new QmlCustomParserPropertyPrivate)
{
    *this = other;
}

QmlCustomParserProperty &QmlCustomParserProperty::operator=(const QmlCustomParserProperty &other)
{
    d->name = other.d->name;
    d->isList = other.d->isList;
    d->values = other.d->values;
    d->location = other.d->location;
    return *this;
}

QmlCustomParserProperty::~QmlCustomParserProperty()
{
    delete d; d = 0;
}

QByteArray QmlCustomParserProperty::name() const
{
    return d->name;
}

bool QmlCustomParserProperty::isList() const
{
    return d->isList;
}

QmlParser::Location QmlCustomParserProperty::location() const
{
    return d->location;
}

QList<QVariant> QmlCustomParserProperty::assignedValues() const
{
    return d->values;
}

void QmlCustomParser::clearErrors()
{
    exceptions.clear();
}

/*!
    Reports an error in parsing \a prop, with the given \a description.

    An error is generated referring to the position of \a node in the source file.
*/
void QmlCustomParser::error(const QmlCustomParserProperty& prop, const QString& description)
{
    QmlError error;
    QString exceptionDescription;
    error.setLine(prop.location().line);
    error.setColumn(prop.location().column);
    error.setDescription(description);
    exceptions << error;
}

/*!
    Reports an error in parsing \a node, with the given \a description.

    An error is generated referring to the position of \a node in the source file.
*/
void QmlCustomParser::error(const QmlCustomParserNode& node, const QString& description)
{
    QmlError error;
    QString exceptionDescription;
    error.setLine(node.location().line);
    error.setColumn(node.location().column);
    error.setDescription(description);
    exceptions << error;
}

QT_END_NAMESPACE