1 /****************************************************************************

     2 **

     3 ** Copyright (C) 2010 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 

    60 #include <QtCore/qbytearray.h>

    61 #include <QtCore/qxmlstream.h>

    62 

    63 QT_BEGIN_HEADER

    64 

    65 QT_BEGIN_NAMESPACE

    66 

    67 QT_MODULE(Declarative)

    68 

    69 class QDeclarativeCompiler;

    70 

    71 class QDeclarativeCustomParserPropertyPrivate;

    72 class Q_DECLARATIVE_EXPORT QDeclarativeCustomParserProperty

    73 {

    74 public:

    75     QDeclarativeCustomParserProperty();

    76     QDeclarativeCustomParserProperty(const QDeclarativeCustomParserProperty &);

    77     QDeclarativeCustomParserProperty &operator=(const QDeclarativeCustomParserProperty &);

    78     ~QDeclarativeCustomParserProperty();

    79 

    80     QByteArray name() const;

    81     QDeclarativeParser::Location location() const;

    82 

    83     bool isList() const;

    84     // Will be one of QDeclarativeParser::Variant, QDeclarativeCustomParserProperty or 

    85     // QDeclarativeCustomParserNode

    86     QList<QVariant> assignedValues() const;

    87 

    88 private:

    89     friend class QDeclarativeCustomParserNodePrivate;

    90     friend class QDeclarativeCustomParserPropertyPrivate;

    91     QDeclarativeCustomParserPropertyPrivate *d;

    92 };

    93 

    94 class QDeclarativeCustomParserNodePrivate;

    95 class Q_DECLARATIVE_EXPORT QDeclarativeCustomParserNode

    96 {

    97 public:

    98     QDeclarativeCustomParserNode();

    99     QDeclarativeCustomParserNode(const QDeclarativeCustomParserNode &);

   100     QDeclarativeCustomParserNode &operator=(const QDeclarativeCustomParserNode &);

   101     ~QDeclarativeCustomParserNode();

   102 

   103     QByteArray name() const;

   104     QDeclarativeParser::Location location() const;

   105 

   106     QList<QDeclarativeCustomParserProperty> properties() const;

   107 

   108 private:

   109     friend class QDeclarativeCustomParserNodePrivate;

   110     QDeclarativeCustomParserNodePrivate *d;

   111 };

   112 

   113 class Q_DECLARATIVE_EXPORT QDeclarativeCustomParser

   114 {

   115 public:

   116     QDeclarativeCustomParser() : compiler(0), object(0) {}

   117     virtual ~QDeclarativeCustomParser() {}

   118 

   119     void clearErrors();

   120 

   121     virtual QByteArray compile(const QList<QDeclarativeCustomParserProperty> &)=0;

   122     virtual void setCustomData(QObject *, const QByteArray &)=0;

   123 

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

   125 

   126 protected:

   127     void error(const QString& description);

   128     void error(const QDeclarativeCustomParserProperty&, const QString& description);

   129     void error(const QDeclarativeCustomParserNode&, const QString& description);

   130 

   131     int evaluateEnum(const QByteArray&) const;

   132 

   133 private:

   134     QList<QDeclarativeError> exceptions;

   135     QDeclarativeCompiler *compiler;

   136     QDeclarativeParser::Object *object;

   137     friend class QDeclarativeCompiler;

   138 };

   139 

   140 #if 0

   141 #define QML_REGISTER_CUSTOM_TYPE(URI, VERSION_MAJ, VERSION_MIN, NAME, TYPE, CUSTOMTYPE) \

   142             qmlRegisterCustomType<TYPE>(#URI, VERSION_MAJ, VERSION_MIN, #NAME, #TYPE, new CUSTOMTYPE)

   143 #endif

   144 

   145 QT_END_NAMESPACE

   146 

   147 Q_DECLARE_METATYPE(QDeclarativeCustomParserProperty)

   148 Q_DECLARE_METATYPE(QDeclarativeCustomParserNode)

   149 

   150 QT_END_HEADER

   151 

   152 #endif