summaryrefslogtreecommitdiffstats
path: root/src/declarative/qml/qmlcustomparser_p.h
blob: 9502b080a990b790d1309565ee9c9f6f39a90242 (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
/****************************************************************************
**
** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (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 Technology Preview License Agreement accompanying
** this package.
**
** 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.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
**
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QMLCUSTOMPARSER_H
#define QMLCUSTOMPARSER_H

//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt API.  It exists purely as an
// implementation detail.  This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//

#include "qmlmetatype.h"
#include "qmlerror.h"
#include "qmlparser_p.h"

#include <QtCore/qbytearray.h>
#include <QtCore/qxmlstream.h>

QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE

QT_MODULE(Declarative)

class QmlCustomParserPropertyPrivate;
class Q_DECLARATIVE_EXPORT QmlCustomParserProperty
{
public:
    QmlCustomParserProperty();
    QmlCustomParserProperty(const QmlCustomParserProperty &);
    QmlCustomParserProperty &operator=(const QmlCustomParserProperty &);
    ~QmlCustomParserProperty();

    QByteArray name() const;
    QmlParser::Location location() const;

    bool isList() const;
    // Will be one of QmlParser::Variant, QmlCustomParserProperty or 
    // QmlCustomParserNode
    QList<QVariant> assignedValues() const;

private:
    friend class QmlCustomParserNodePrivate;
    friend class QmlCustomParserPropertyPrivate;
    QmlCustomParserPropertyPrivate *d;
};

class QmlCustomParserNodePrivate;
class Q_DECLARATIVE_EXPORT QmlCustomParserNode
{
public:
    QmlCustomParserNode();
    QmlCustomParserNode(const QmlCustomParserNode &);
    QmlCustomParserNode &operator=(const QmlCustomParserNode &);
    ~QmlCustomParserNode();

    QByteArray name() const;
    QmlParser::Location location() const;

    QList<QmlCustomParserProperty> properties() const;

private:
    friend class QmlCustomParserNodePrivate;
    QmlCustomParserNodePrivate *d;
};

class Q_DECLARATIVE_EXPORT QmlCustomParser
{
public:
    virtual ~QmlCustomParser() {}

    void clearErrors();

    virtual QByteArray compile(const QList<QmlCustomParserProperty> &)=0;
    virtual void setCustomData(QObject *, const QByteArray &)=0;

    QList<QmlError> errors() const { return exceptions; }

protected:
    void error(const QmlCustomParserProperty&, const QString& description);
    void error(const QmlCustomParserNode&, const QString& description);

private:
    QList<QmlError> exceptions;
};

#if defined(Q_OS_SYMBIAN)
# define QML_DEFINE_CUSTOM_TYPE(URI, VERSION_MAJ, VERSION_MIN, NAME, TYPE, CUSTOMTYPE) \
    static int defineCustomType##NAME = qmlRegisterCustomType<TYPE>(#URI, VERSION_MAJ, VERSION_MIN, #NAME, #TYPE, new CUSTOMTYPE);
#else
# define QML_DEFINE_CUSTOM_TYPE(URI, VERSION_MAJ, VERSION_MIN, NAME, TYPE, CUSTOMTYPE) \
    template<> QmlPrivate::InstanceType QmlPrivate::Define<TYPE *,(VERSION_MAJ), (VERSION_MIN)>::instance(qmlRegisterCustomType<TYPE>(#URI, VERSION_MAJ, VERSION_MIN, #NAME, #TYPE, new CUSTOMTYPE));
#endif

QT_END_NAMESPACE

Q_DECLARE_METATYPE(QmlCustomParserProperty)
Q_DECLARE_METATYPE(QmlCustomParserNode)

QT_END_HEADER

#endif