src/declarative/qml/qdeclarativecustomparser_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the QtDeclarative module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** No Commercial Usage
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 ** Alternatively, this file may be used under the terms of the GNU Lesser
  18 ** General Public License version 2.1 as published by the Free Software
  19 ** Foundation and appearing in the file LICENSE.LGPL included in the
  20 ** packaging of this file.  Please review the following information to
  21 ** ensure the GNU Lesser General Public License version 2.1 requirements
  22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  23 **
  24 ** In addition, as a special exception, Nokia gives you certain additional
  25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QDECLARATIVECUSTOMPARSER_H
  43 #define QDECLARATIVECUSTOMPARSER_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 "private/qdeclarativemetatype_p.h"
  57 #include "qdeclarativeerror.h"
  58 #include "private/qdeclarativeparser_p.h"
  59 #include "private/qdeclarativebinding_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 QT_MODULE(Declarative)
  69
  70 class QDeclarativeCompiler;
  71
  72 class QDeclarativeCustomParserPropertyPrivate;
  73 class Q_DECLARATIVE_EXPORT QDeclarativeCustomParserProperty
  74 {
  75 public:
  76     QDeclarativeCustomParserProperty();
  77     QDeclarativeCustomParserProperty(const QDeclarativeCustomParserProperty &);
  78     QDeclarativeCustomParserProperty &operator=(const QDeclarativeCustomParserProperty &);
  79     ~QDeclarativeCustomParserProperty();
  80
  81     QByteArray name() const;
  82     QDeclarativeParser::Location location() const;
  83
  84     bool isList() const;
  85     // Will be one of QDeclarativeParser::Variant, QDeclarativeCustomParserProperty or
  86     // QDeclarativeCustomParserNode
  87     QList<QVariant> assignedValues() const;
  88
  89 private:
  90     friend class QDeclarativeCustomParserNodePrivate;
  91     friend class QDeclarativeCustomParserPropertyPrivate;
  92     QDeclarativeCustomParserPropertyPrivate *d;
  93 };
  94
  95 class QDeclarativeCustomParserNodePrivate;
  96 class Q_DECLARATIVE_EXPORT QDeclarativeCustomParserNode
  97 {
  98 public:
  99     QDeclarativeCustomParserNode();
 100     QDeclarativeCustomParserNode(const QDeclarativeCustomParserNode &);
 101     QDeclarativeCustomParserNode &operator=(const QDeclarativeCustomParserNode &);
 102     ~QDeclarativeCustomParserNode();
 103
 104     QByteArray name() const;
 105     QDeclarativeParser::Location location() const;
 106
 107     QList<QDeclarativeCustomParserProperty> properties() const;
 108
 109 private:
 110     friend class QDeclarativeCustomParserNodePrivate;
 111     QDeclarativeCustomParserNodePrivate *d;
 112 };
 113
 114 class Q_DECLARATIVE_EXPORT QDeclarativeCustomParser
 115 {
 116 public:
 117     enum Flag {
 118         NoFlag                    = 0x00000000,
 119         AcceptsAttachedProperties = 0x00000001
 120     };
 121     Q_DECLARE_FLAGS(Flags, Flag)
 122
 123     QDeclarativeCustomParser() : compiler(0), object(0), m_flags(NoFlag) {}
 124     QDeclarativeCustomParser(Flags f) : compiler(0), object(0), m_flags(f) {}
 125     virtual ~QDeclarativeCustomParser() {}
 126
 127     void clearErrors();
 128     Flags flags() const { return m_flags; }
 129
 130     virtual QByteArray compile(const QList<QDeclarativeCustomParserProperty> &)=0;
 131     virtual void setCustomData(QObject *, const QByteArray &)=0;
 132
 133     QList<QDeclarativeError> errors() const { return exceptions; }
 134
 135 protected:
 136     void error(const QString& description);
 137     void error(const QDeclarativeCustomParserProperty&, const QString& description);
 138     void error(const QDeclarativeCustomParserNode&, const QString& description);
 139
 140     int evaluateEnum(const QByteArray&) const;
 141
 142     const QMetaObject *resolveType(const QByteArray&) const;
 143
 144     QDeclarativeBinding::Identifier rewriteBinding(const QString&, const QByteArray&);
 145
 146 private:
 147     QList<QDeclarativeError> exceptions;
 148     QDeclarativeCompiler *compiler;
 149     QDeclarativeParser::Object *object;
 150     Flags m_flags;
 151     friend class QDeclarativeCompiler;
 152 };
 153 Q_DECLARE_OPERATORS_FOR_FLAGS(QDeclarativeCustomParser::Flags);
 154
 155 #if 0
 156 #define QML_REGISTER_CUSTOM_TYPE(URI, VERSION_MAJ, VERSION_MIN, NAME, TYPE, CUSTOMTYPE) \
 157             qmlRegisterCustomType<TYPE>(#URI, VERSION_MAJ, VERSION_MIN, #NAME, #TYPE, new CUSTOMTYPE)
 158 #endif
 159
 160 QT_END_NAMESPACE
 161
 162 Q_DECLARE_METATYPE(QDeclarativeCustomParserProperty)
 163 Q_DECLARE_METATYPE(QDeclarativeCustomParserNode)
 164
 165 QT_END_HEADER
 166
 167 #endif