src/qml/qml/qqmlcustomparser_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   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 Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/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 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QQMLCUSTOMPARSER_H
  43 #define QQMLCUSTOMPARSER_H
  44
  45 //
  46 //  W A R N I N G
  47 //  -------------
  48 //
  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.
  52 //
  53 // We mean it.
  54 //
  55
  56 #include "qqmlmetatype_p.h"
  57 #include "qqmlerror.h"
  58 #include "qqmlscript_p.h"
  59 #include "qqmlbinding_p.h"
  60
  61 #include <QtCore/qbytearray.h>
  62 #include <QtCore/qxmlstream.h>
  63
  64 QT_BEGIN_HEADER
  65
  66 QT_BEGIN_NAMESPACE
  67
  68
  69 class QQmlCompiler;
  70
  71 class QQmlCustomParserPropertyPrivate;
  72 class Q_QML_PRIVATE_EXPORT QQmlCustomParserProperty
  73 {
  74 public:
  75     QQmlCustomParserProperty();
  76     QQmlCustomParserProperty(const QQmlCustomParserProperty &);
  77     QQmlCustomParserProperty &operator=(const QQmlCustomParserProperty &);
  78     ~QQmlCustomParserProperty();
  79
  80     QString name() const;
  81     QQmlScript::Location location() const;
  82
  83     bool isList() const;
  84     // Will be one of QQmlScript::Variant, QQmlCustomParserProperty or
  85     // QQmlCustomParserNode
  86     QList<QVariant> assignedValues() const;
  87
  88 private:
  89     friend class QQmlCustomParserNodePrivate;
  90     friend class QQmlCustomParserPropertyPrivate;
  91     QQmlCustomParserPropertyPrivate *d;
  92 };
  93
  94 class QQmlCustomParserNodePrivate;
  95 class Q_QML_PRIVATE_EXPORT QQmlCustomParserNode
  96 {
  97 public:
  98     QQmlCustomParserNode();
  99     QQmlCustomParserNode(const QQmlCustomParserNode &);
 100     QQmlCustomParserNode &operator=(const QQmlCustomParserNode &);
 101     ~QQmlCustomParserNode();
 102
 103     QString name() const;
 104     QQmlScript::Location location() const;
 105
 106     QList<QQmlCustomParserProperty> properties() const;
 107
 108 private:
 109     friend class QQmlCustomParserNodePrivate;
 110     QQmlCustomParserNodePrivate *d;
 111 };
 112
 113 class Q_QML_PRIVATE_EXPORT QQmlCustomParser
 114 {
 115 public:
 116     enum Flag {
 117         NoFlag                    = 0x00000000,
 118         AcceptsAttachedProperties = 0x00000001,
 119         AcceptsSignalHandlers     = 0x00000002
 120     };
 121     Q_DECLARE_FLAGS(Flags, Flag)
 122
 123     QQmlCustomParser() : compiler(0), object(0), m_flags(NoFlag) {}
 124     QQmlCustomParser(Flags f) : compiler(0), object(0), m_flags(f) {}
 125     virtual ~QQmlCustomParser() {}
 126
 127     void clearErrors();
 128     Flags flags() const { return m_flags; }
 129
 130     virtual QByteArray compile(const QList<QQmlCustomParserProperty> &)=0;
 131     virtual void setCustomData(QObject *, const QByteArray &)=0;
 132
 133     QList<QQmlError> errors() const { return exceptions; }
 134
 135 protected:
 136     void error(const QString& description);
 137     void error(const QQmlCustomParserProperty&, const QString& description);
 138     void error(const QQmlCustomParserNode&, const QString& description);
 139
 140     int evaluateEnum(const QByteArray&, bool *ok) const;
 141
 142     const QMetaObject *resolveType(const QString&) const;
 143
 144     QQmlBinding::Identifier rewriteBinding(const QQmlScript::Variant&, const QString&);
 145     QString rewriteSignalHandler(const QQmlScript::Variant&, const QString&);
 146
 147 private:
 148     QList<QQmlError> exceptions;
 149     QQmlCompiler *compiler;
 150     QQmlScript::Object *object;
 151     Flags m_flags;
 152     friend class QQmlCompiler;
 153 };
 154 Q_DECLARE_OPERATORS_FOR_FLAGS(QQmlCustomParser::Flags);
 155
 156 #if 0
 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)
 159 #endif
 160
 161 QT_END_NAMESPACE
 162
 163 Q_DECLARE_METATYPE(QQmlCustomParserProperty)
 164 Q_DECLARE_METATYPE(QQmlCustomParserNode)
 165
 166 QT_END_HEADER
 167
 168 #endif