/****************************************************************************
**
** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
** Contact: Qt Software Information (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 either Technology Preview License Agreement or the
** Beta Release License Agreement.
**
** 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.0, included in the file LGPL_EXCEPTION.txt in this
** package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at qt-sales@nokia.com.
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QMLCUSTOMPARSER_H
#define QMLCUSTOMPARSER_H

#include <QtCore/qbytearray.h>
#include <QtCore/qxmlstream.h>
#include <QtDeclarative/qfxglobal.h>
#include <QtDeclarative/qmlmetatype.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;

    bool isList() const;
    QList<QVariant> assignedValues() const;

private:
    friend class QmlCustomParserNodePrivate;
    friend class QmlCustomParserPropertyPrivate;
    QmlCustomParserPropertyPrivate *d;
};
Q_DECLARE_METATYPE(QmlCustomParserProperty);

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

    QByteArray name() const;

    QList<QmlCustomParserProperty> properties() const;

private:
    friend class QmlCustomParserNodePrivate;
    QmlCustomParserNodePrivate *d;
};
Q_DECLARE_METATYPE(QmlCustomParserNode);

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

    virtual QByteArray compile(QXmlStreamReader&, bool *ok)=0;
    virtual QByteArray compile(const QList<QmlCustomParserProperty> &, bool *ok);
    virtual QVariant create(const QByteArray &)=0;
    virtual void setCustomData(QObject *, const QByteArray &);

    struct Register {
        Register(const char *name, QmlCustomParser *parser) {
            qmlRegisterCustomParser(name, parser);
        }
    };
    template<typename T>
    struct Define {
        static Register instance;
    };
};
#define QML_DEFINE_CUSTOM_PARSER(name, parserClass) \
    template<> QmlCustomParser::Register QmlCustomParser::Define<parserClass>::instance(# name, new parserClass);
#define QML_DEFINE_CUSTOM_PARSER_NS(namespacestring, name, parserClass) \
    template<> QmlCustomParser::Register QmlCustomParser::Define<parserClass>::instance(namespacestring "/" # name, new parserClass);

#define QML_DEFINE_CUSTOM_TYPE(TYPE, NAME, CUSTOMTYPE) \
    template<> QmlPrivate::InstanceType QmlPrivate::Define<TYPE *>::instance(qmlRegisterCustomType<TYPE>(#NAME, #TYPE, new CUSTOMTYPE));

QT_END_NAMESPACE

QT_END_HEADER

#endif