1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtQml module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QQMLCUSTOMPARSER_H
41#define QQMLCUSTOMPARSER_H
42
43//
44// W A R N I N G
45// -------------
46//
47// This file is not part of the Qt API. It exists purely as an
48// implementation detail. This header file may change from version to
49// version without notice, or even be removed.
50//
51// We mean it.
52//
53
54#include "qqmlerror.h"
55#include "qqmlbinding_p.h"
56#include <private/qv4compileddata_p.h>
57
58#include <QtCore/qbytearray.h>
59#include <QtCore/qxmlstream.h>
60
61QT_BEGIN_NAMESPACE
62
63class QQmlPropertyValidator;
64class QQmlEnginePrivate;
65
66class Q_QML_PRIVATE_EXPORT QQmlCustomParser
67{
68public:
69 enum Flag {
70 NoFlag = 0x00000000,
71 AcceptsAttachedProperties = 0x00000001,
72 AcceptsSignalHandlers = 0x00000002
73 };
74 Q_DECLARE_FLAGS(Flags, Flag)
75
76 QQmlCustomParser() : engine(nullptr), validator(nullptr), m_flags(NoFlag) {}
77 QQmlCustomParser(Flags f) : engine(nullptr), validator(nullptr), m_flags(f) {}
78 virtual ~QQmlCustomParser() {}
79
80 void clearErrors();
81 Flags flags() const { return m_flags; }
82
83 virtual void verifyBindings(const QQmlRefPointer<QV4::ExecutableCompilationUnit> &, const QList<const QV4::CompiledData::Binding *> &) = 0;
84 virtual void applyBindings(QObject *, const QQmlRefPointer<QV4::ExecutableCompilationUnit> &, const QList<const QV4::CompiledData::Binding *> &) = 0;
85
86 QVector<QQmlJS::DiagnosticMessage> errors() const { return exceptions; }
87
88protected:
89 void error(const QV4::CompiledData::Binding *binding, const QString& description)
90 { error(binding->location, description); }
91 void error(const QV4::CompiledData::Object *object, const QString& description)
92 { error(object->location, description); }
93 void error(const QV4::CompiledData::Location &location, const QString& description);
94
95 int evaluateEnum(const QByteArray&, bool *ok) const;
96
97 const QMetaObject *resolveType(const QString&) const;
98
99private:
100 QVector<QQmlJS::DiagnosticMessage> exceptions;
101 QQmlEnginePrivate *engine;
102 const QQmlPropertyValidator *validator;
103 Flags m_flags;
104 QBiPointer<const QQmlImports, QQmlTypeNameCache> imports;
105 friend class QQmlPropertyValidator;
106 friend class QQmlObjectCreator;
107};
108Q_DECLARE_OPERATORS_FOR_FLAGS(QQmlCustomParser::Flags)
109
110#if 0
111#define QML_REGISTER_CUSTOM_TYPE(URI, VERSION_MAJ, VERSION_MIN, NAME, TYPE, CUSTOMTYPE) \
112 qmlRegisterCustomType<TYPE>(#URI, VERSION_MAJ, VERSION_MIN, #NAME, #TYPE, new CUSTOMTYPE)
113#endif
114
115QT_END_NAMESPACE
116
117#endif
118