/****************************************************************************

**

** Copyright (C) 2008-2010 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (developer.feedback@nokia.com)

**

** This file is part of the HbCore module of the UI Extensions for Mobile.

**

** GNU Lesser General Public License Usage

** 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.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at developer.feedback@nokia.com.

**

****************************************************************************/

#ifndef HBXMLLOADERABSTRACTSYNTAX_P_H

#define HBXMLLOADERABSTRACTSYNTAX_P_H

#include <hbglobal.h>

#include <QHash>

#include <QList>

#include <QXmlStreamReader>

#include <QPointer>

#include <QByteArray>

#include <QVariant>

namespace HbXml {

    enum ElementType {

        DOCUMENT,

        OBJECT,

        WIDGET,

        LAYOUT,

        SPACERITEM,

        CONNECT,

        CONTAINER,

        PROPERTY,

        SECTION,

        REF,

        VARIABLE,

        METADATA,

        UNKNOWN,

        DEPRECATED

    };

    enum ActionType {

        ActionReset,

        ActionCleanUp,

        ActionDeleteAll,

        ActionPushDocument,

        ActionPushObject,

        ActionPushWidget,

        ActionPushConnect,

        ActionPushProperty,

        ActionPushRef,

        ActionPushContainer,

        ActionPop,

        ActionSetContentsMargins,

        ActionSetSizePolicy,

        ActionSetSizeHint,

        ActionSetToolTip,

        ActionCreateAnchorLayout,

        ActionAddAnchorLayoutItem,

        ActionSetAnchorLayoutMapping,

        ActionCreateGridLayout,

        ActionAddGridLayoutCell,

        ActionSetGridLayoutRowProperties,

        ActionSetGridLayoutColumnProperties,

        ActionSetGridLayoutRowHeights,

        ActionSetGridLayoutColumnWidths,

        ActionCreateLinearLayout,

        ActionAddLinearLayoutItem,

        ActionAddLinearLayoutStretch,

        ActionSetLayoutContentsMargins,

        ActionCreateStackedLayout,

        ActionAddStackedLayoutItem,

        ActionCreateNullLayout,

        ActionEnd

    };

    struct Element {

        ElementType type;

        void *data;

    };

}

class HbXmlLoaderAbstractActions;

class HbWidget;

struct HB_CORE_PRIVATE_EXPORT HbXmlLengthValue

{

    enum Type {

        None = 0,

        PlainNumber,

        Pixel,

        Unit,

        Millimeter,

        Variable,

    };

    qreal mValue;

    QString mString;

    Type mType;

};

HB_CORE_PRIVATE_EXPORT QDataStream &operator<<(QDataStream &, const HbXmlLengthValue &);

HB_CORE_PRIVATE_EXPORT QDataStream &operator>>(QDataStream &, HbXmlLengthValue &);

class HB_CORE_PRIVATE_EXPORT HbXmlVariable

{

public:

    enum Type {

        UNKNOWN,

        INT,

        REAL,

        STRING,

        LOCALIZED_STRING,

        BOOL,

        ICON,

        SIZE,

        RECT,

        POINT,

        ENUMS,

        COLOR,

        FONTSPEC

    };

public:

    HbXmlVariable();

    ~HbXmlVariable();

private:

    Q_DISABLE_COPY(HbXmlVariable)

public:

    Type mType;

    QList<void*> mParameters;

};

HB_CORE_PRIVATE_EXPORT QDataStream &operator<<(QDataStream &, const HbXmlVariable &);

HB_CORE_PRIVATE_EXPORT QDataStream &operator>>(QDataStream &, HbXmlVariable &);

class HB_CORE_PRIVATE_EXPORT HbXmlLoaderAbstractSyntax

{

public:

    enum DocumentLexems {

        ATTR_NAME,

        ATTR_TYPE,

        ATTR_VALUE,

        ATTR_ICONNAME,

        ATTR_WIDTH,

        ATTR_HEIGHT,

        ATTR_SRC,

        ATTR_SIGNAL,

        ATTR_DST,

        ATTR_SLOT,

        ATTR_X,

        ATTR_Y,

        ATTR_PLUGIN,

        ATTR_ROLE,

        ATTR_OBJECT,

        ATTR_CONTEXT,

        ATTR_LEFT,

        ATTR_RIGHT,

        ATTR_TOP,

        ATTR_BOTTOM,

        ATTR_HORIZONTALPOLICY,

        ATTR_VERTICALPOLICY,

        ATTR_HORIZONTALSTRETCH,

        ATTR_VERTICALSTRETCH,

        ATTR_COMMENT,

        ATTR_WIDGET,

        ATTR_VERSION,

        ATTR_FONTSPECROLE,

        ATTR_TEXTHEIGHT,

        ATTR_STRETCHFACTOR,

        // Deprecated.

        ATTR_TEXTPANEHEIGHT,

        ATTR_LOCID,

        ATTR_ACTION,

        TYPE_DOCUMENT,

        TYPE_HBWIDGET,

        TYPE_OBJECT,

        TYPE_WIDGET,

        // Deprecated.

        TYPE_SPACERITEM,

        TYPE_CONNECT,

        TYPE_LAYOUT,

        TYPE_SECTION,

        TYPE_REF,

        TYPE_CONTENTSMARGINS,

        TYPE_SIZEPOLICY,

        TYPE_SIZEHINT,

        TYPE_ZVALUE,

        TYPE_TOOLTIP,

        TYPE_METADATA,

        TYPE_CONTAINER,

        TYPE_INT,

        TYPE_REAL,

        TYPE_LOCALIZED_STRING,

        TYPE_STRING,

        TYPE_ENUMS,

        TYPE_BOOL,

        TYPE_ICON,

        TYPE_SIZE,

        TYPE_RECT,

        TYPE_POINT,

        TYPE_COLOR,

        TYPE_ALIGNMENT,

        TYPE_FONTSPEC,

        LAYOUT_ANCHOR,

        LAYOUT_MESH,

        LAYOUT_GRID,

        LAYOUT_LINEAR,

        LAYOUT_STACK,

        LAYOUT_NULL,

        LAYOUT_ALIEN,

        CONTAINER_STRINGLIST,

        CONTAINER_NULL,

        UNIT_UNIT,

        UNIT_PIXEL,

        UNIT_MILLIMETER,

        UNIT_VAR_START,

        UNIT_VAR_NEG_START,

        UNIT_VAR_END,

        UNIT_EXPR_START,

        UNIT_EXPR_NEG_START,

        UNIT_EXPR_END,

        AL_ANCHOR,

        AL_SRC_NAME,

        AL_SRC_ID,

        AL_SRC_EDGE,

        AL_DST_NAME,

        AL_DST_ID,

        AL_DST_EDGE,

        AL_MIN_LENGTH,

        AL_PREF_LENGTH,

        AL_MAX_LENGTH,

        AL_SIZEPOLICY,

        AL_DIRECTION,

        AL_ANCHOR_ID,

        AL_SPACING,

        AL_SPACER,

        AL_MAPPING,

        AL_MAPPING_ITEM,

        AL_MAPPING_ID,

        ML_MESHITEM, 

        GL_GRIDCELL, 

        GL_ITEMNAME, 

        GL_ROW,

        GL_COLUMN,

        GL_ROWSPAN,

        GL_COLUMNSPAN,

        GL_SPACING,

        GL_GRIDROW,

        GL_GRIDCOLUMN,

        GL_MINWIDTH,

        GL_MAXWIDTH,

        GL_PREFWIDTH,

        GL_FIXEDWIDTH,

        GL_MINHEIGHT,

        GL_MAXHEIGHT,

        GL_PREFHEIGHT,

        GL_FIXEDHEIGHT,

        LL_ORIENTATION,

        LL_LINEARITEM, 

        LL_STRETCH, 

        LL_ITEMNAME, 

        LL_INDEX,

        LL_SPACING,

        SL_STACKITEM, 

        SL_ITEMNAME, 

        SL_INDEX,

        NUMBER_OF_LEXEMS // Keep this last!

    };

public:

    HbXmlLoaderAbstractSyntax( HbXmlLoaderAbstractActions *actions );

    virtual ~HbXmlLoaderAbstractSyntax();

    virtual bool load( QIODevice *device, const QString &section );

public:

    void setActions( HbXmlLoaderAbstractActions *actions );

    bool toReal(const QString &value, qreal& result) const;

    bool toLengthValue(const QString &value, HbXmlLengthValue& lengthVal) const;

    const char *lexemValue(DocumentLexems lex) const;

protected:

    HbXmlLoaderAbstractActions *mActions;

private:

    Q_DISABLE_COPY(HbXmlLoaderAbstractSyntax)

};

#endif // HBXMLLOADERABSTRACTSYNTAX_P_H