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

**

** 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 HBCSSPARSER_P_H

#define HBCSSPARSER_P_H

#include <QStringList>

#include <QVector>

#include <QVariant>

#include <QPair>

#include <QSize>

#include <QFont>

#include <QIcon>

#include <QSizePolicy>

#include <QHash>

#include <hbglobal.h>

#include <hbnamespace.h>

#include <hbdeviceprofile.h>

#include <hbfontspec.h>

#include <hbanchor.h>

// containers and memory manager inclusion

#include "hbmemorymanager_p.h"

#include "hbvector_p.h"

#include "hbstring_p.h"

#include "hbvariant_p.h"

#include "hbstringvector_p.h"

class HbLayoutParameters;

namespace HbCss

{

enum Property {

    Property_Unknown,

    Property_Alignment,

    Property_AnchorDirection,

    Property_AspectRatio,

    Property_BorderWidth,

    Property_BorderWidthBottom,

    Property_BorderWidthLeft,

    Property_BorderWidthRight,

    Property_BorderWidthTop,

    Property_Bottom,

    Property_CenterHorizontal,

    Property_CenterVertical,

    Property_Color,

    Property_FixedHeight,

    Property_FixedLength,

    Property_FixedSize,

    Property_FixedWidth,

    Property_Font,

    Property_FontFamily,

    Property_FontSize,

    Property_FontStyle,

    Property_FontVariant,

    Property_FontWeight,

    Property_Layout,

    Property_LayoutDirection,

    Property_Left,

    Property_MaximumHeight,

    Property_MaximumLength,

    Property_MaximumSize,

    Property_MaximumWidth,

    Property_MinimumHeight,

    Property_MinimumLength,

    Property_MinimumSize,

    Property_MinimumWidth,

    Property_PreferredHeight,

    Property_PreferredLength,

    Property_PreferredSize,

    Property_PreferredWidth,

    Property_Right,

    Property_Section,

    Property_SizePolicy,

    Property_SizePolicyHorizontal,

    Property_SizePolicyVertical,

    Property_TextAlignment,

    Property_TextDecoration,

    Property_TextHeight,

    Property_TextLineCountMax,

    Property_TextLineCountMin,

    Property_TextTransform,

    Property_TextWrapMode,

    Property_Top,

    Property_ZValue,

    NumProperties

};

enum KnownValue {

    UnknownValue,

    Value_Normal,

    Value_Italic,

    Value_Oblique,

    Value_Bold,

    Value_Underline,

    Value_Overline,

    Value_LineThrough,

    Value_Left,

    Value_Right,

    Value_Top,

    Value_Bottom,

    Value_Center,

    Value_None,

    Value_Transparent,

    Value_SmallCaps,

    Value_Uppercase,

    Value_Lowercase,

    Value_Ignore,

    Value_Keep,

    Value_KeepExpand,

    Value_Primary,

    Value_Secondary,

    Value_Title,

    Value_PrimarySmall,

    Value_Digital,

    Value_Fixed,

    Value_Minimum,

    Value_Maximum,

    Value_Preferred,

    Value_Expanding,

    Value_MinimumExpanding,

    Value_Ignored,

    Value_LeftToRight,

    Value_RightToLeft,

    Value_Parent,

    Value_NoWrap,

    Value_WordWrap,

    Value_WrapAnywhere,

    Value_Positive,

    Value_Negative,

    NumKnownValues

};

enum Edge {

    TopEdge,

    RightEdge,

    BottomEdge,

    LeftEdge,

    NumEdges

};

enum LayoutDirection {

    LayoutDirection_LeftToRight,

    LayoutDirection_RightToLeft,

    LayoutDirection_Parent,

    NumKnownLayoutDirections

};

struct HB_CORE_PRIVATE_EXPORT Value //krazy:exclude=multiclasses

{

    enum Type {

        Unknown,

        Number,

        Percentage,

        Length,

        String,

        Identifier,

        KnownIdentifier,

        Uri,

        Color,

        Function,

        TermOperatorSlash,

        TermOperatorComma,

        Variable,  //added for variable support

        VariableNegative,  //added for variable support

        Expression, //added for expression support

        ExpressionNegative, //added for expression support

        LengthInUnits,

        LengthInPixels,

        LengthInMillimeters

    };

    inline Value(HbMemoryManager::MemoryType memType = HbMemoryManager::HeapMemory) 

        : memoryType(memType),

          type(Unknown),

          original(memType),

          variant(memType)

    { }

    inline Value(const Value &other)

        : memoryType(other.memoryType),

          type(other.type),

          original(other.original),

          variant(other.variant)

    { }

#ifdef CSS_PARSER_TRACES

    void print() const;

#endif

    // Data

    HbMemoryManager::MemoryType memoryType;

    Type type;

    HbString original;

    HbVariant variant;

};

// 1. StyleRule - x:hover, y:clicked > z:checked { prop1: value1; prop2: value2; }

// 2. QVector<Selector> - x:hover, y:clicked z:checked

// 3. QVector<BasicSelector> - y:clicked z:checked

// 4. QVector<Declaration> - { prop1: value1; prop2: value2; }

// 5. Declaration - prop1: value1;

struct HB_CORE_PRIVATE_EXPORT Declaration //krazy:exclude=multiclasses

{

    inline Declaration(HbMemoryManager::MemoryType type = HbMemoryManager::HeapMemory)

        :memoryType(type),

        property(type),

        propertyId(Property_Unknown),

        values(type),

        important(false)

    {}

    inline bool isEmpty() const { return property.isEmpty() && propertyId == Property_Unknown; }

#ifdef CSS_PARSER_TRACES

    void print() const;

#endif

    // Data

    HbMemoryManager::MemoryType memoryType;

    HbString property;

    Property propertyId;

    HbVector<Value> values;

    bool important;

};

typedef QPair<int, Declaration> WeightedDeclaration;

const quint32 PseudoClass_Unknown          = 0x00000000;

const quint32 PseudoClass_Unspecified      = 0x00000001;

const quint32 PseudoClass_Landscape        = 0x00000002;

const quint32 PseudoClass_Portrait         = 0x00000004;

const quint32 PseudoClass_LeftToRight      = 0x00000008;

const quint32 PseudoClass_RightToLeft      = 0x00000010;

// The Any specifier is never generated, but can be used as a wildcard in searches.

const quint32 PseudoClass_Any              = 0x00000020;

const int NumPseudos = 7;

struct HB_CORE_PRIVATE_EXPORT Pseudo //krazy:exclude=multiclasses

{

    Pseudo(HbMemoryManager::MemoryType memType = HbMemoryManager::HeapMemory) 

        : memoryType(memType),

          negated(false),

          name(memType),

          function(memType)

    { }

#ifdef CSS_PARSER_TRACES

    void print() const;

#endif

    //Data

    HbMemoryManager::MemoryType memoryType;

    bool negated;

    quint64 type;

    HbString name;

    HbString function;

};

struct HB_CORE_PRIVATE_EXPORT AttributeSelector //krazy:exclude=multiclasses

{

    enum ValueMatchType {

        NoMatch,

        MatchEqual,

        MatchContains,

        MatchBeginsWith

    };

    inline AttributeSelector(HbMemoryManager::MemoryType type = HbMemoryManager::HeapMemory)

        : memoryType(type),

          name(type),

          nameHash(0),

          value(type),

          valueMatchCriterium(NoMatch),

          negated(false)         

    {}

#ifdef CSS_PARSER_TRACES

    void print() const;

#endif

    HbMemoryManager::MemoryType memoryType;

    HbString name;

    uint nameHash;

    HbString value;

    ValueMatchType valueMatchCriterium;

    bool negated;

};

struct HB_CORE_PRIVATE_EXPORT BasicSelector //krazy:exclude=multiclasses

{

    inline BasicSelector(HbMemoryManager::MemoryType type = HbMemoryManager::HeapMemory) 

        : memoryType(type),

          elementName(type),

          ids(type),

          pseudos(type),

          attributeSelectors(type),

          relationToNext(NoRelation)

    {}

    inline BasicSelector(const BasicSelector &other) 

        : memoryType(other.memoryType),

          elementName(other.elementName),

          ids(other.ids),

          pseudos(other.pseudos),

          attributeSelectors(other.attributeSelectors),

          relationToNext(other.relationToNext)

    {

        GET_MEMORY_MANAGER(other.memoryType)

        if (!manager->isWritable()) {

            memoryType = HbMemoryManager::HeapMemory;

        }

    }

    enum Relation {

        NoRelation,

        MatchNextSelectorIfAncestor,

        MatchNextSelectorIfParent,

        MatchNextSelectorIfPreceeds

    };

#ifdef CSS_PARSER_TRACES

    void print() const;

#endif

    // Data

    HbMemoryManager::MemoryType memoryType;

    HbString elementName;

    HbStringVector ids;

    HbVector<Pseudo> pseudos;

    HbVector<AttributeSelector> attributeSelectors;

    Relation relationToNext;

};

struct HB_CORE_PRIVATE_EXPORT Selector //krazy:exclude=multiclasses

{

    Selector() 

        : memoryType(HbMemoryManager::HeapMemory),

          basicSelectors(HbMemoryManager::HeapMemory)

    {}

    Selector(HbMemoryManager::MemoryType type) 

        : memoryType(type),

          basicSelectors(type)

    {}

    int specificity() const;

    quint64 pseudoClass(quint64 *negated = 0) const;

    QString pseudoElement() const;

#ifdef CSS_PARSER_TRACES

    void print() const;

#endif

    // Data

    HbMemoryManager::MemoryType memoryType;

    HbVector<BasicSelector> basicSelectors;

};

enum KnownPropertyFlag {

    // Generic

    ExtractedLeft       = 0x00000001,

    ExtractedRight      = 0x00000002,

    ExtractedTop        = 0x00000004,

    ExtractedBottom     = 0x00000008,

    ExtractedCenterH    = 0x00000010,

    ExtractedCenterV    = 0x00000020,

    ExtractedPrefW      = 0x00000100,

    ExtractedPrefH      = 0x00000200,

    ExtractedMinW       = 0x00000400,

    ExtractedMinH       = 0x00000800,

    ExtractedMaxW       = 0x00001000,

    ExtractedMaxH       = 0x00002000,

    ExtractedPolHor     = 0x00004000,

    ExtractedPolVer     = 0x00008000,

    ExtractedLayoutDir  = 0x00010000,

    ExtractedZValue     = 0x00020000,

    ExtractedAlignment  = 0x00040000,

    // Text specific

    ExtractedWrapMode   = 0x00200000,

    ExtractedMinLines   = 0x00400000,

    ExtractedMaxLines   = 0x00800000,

    ExtractedFont       = 0x01000000,

    ExtractedFontSpec   = 0x02000000,

    // Icon specific

    ExtractedAspectRatioMode    = 0x10000000,

    // Frame specific

    ExtractedBorderWidths       = 0x20000000,

    // Anchor specific

    ExtractedAnchorDir          = 0x80000000

};

Q_DECLARE_FLAGS(KnownPropertyFlags, KnownPropertyFlag)

struct KnownProperties

{

    qreal mLeft, mTop, mRight, mBottom, mCenterH, mCenterV, mZ;

    qreal mPrefW, mPrefH, mMinW, mMinH, mMaxW, mMaxH;

    QSizePolicy mSizePolicy;

    HbCss::LayoutDirection mLayoutDir;    

    Qt::Alignment mAlignment;

    Hb::TextWrapping mTextWrapMode;

    int mMinLines, mMaxLines;

    QFont mFont;

    HbFontSpec mFontSpec;

    Qt::AspectRatioMode mAspectRatioMode;

    qreal mBorderWidths[HbCss::NumEdges];

    HbAnchor::Direction mAnchorDir;

    KnownPropertyFlags mFlags;

};

struct HB_CORE_PRIVATE_EXPORT ValueExtractor //krazy:exclude=multiclasses

{

    ValueExtractor(const HbVector<Declaration> &declarations, const HbDeviceProfile &profile);

    ValueExtractor(const HbDeviceProfile &profile = HbDeviceProfile());

    void setLayoutParameters(const HbLayoutParameters &layoutParams) { layoutParameters = &layoutParams; }

    void setVariables(const QHash<quint32, HbCss::Declaration> &vars) { variables = &vars; }

    bool extractVariableValue(quint32 hashValue, HbCss::Value &value) const;

    bool extractVariableValue(const QString &variableName, HbCss::Value &value) const;

    bool extractColor(QColor &color) const;

private:

    HbVector<Declaration> declarations;

    const HbLayoutParameters *layoutParameters;

    const QHash<quint32, HbCss::Declaration> *variables;

    HbDeviceProfile currentProfile;

};

struct StyleSheet;

struct HB_CORE_PRIVATE_EXPORT StyleRule //krazy:exclude=multiclasses

{

    StyleRule(HbMemoryManager::MemoryType type = HbMemoryManager::HeapMemory)

        : memoryType(type),

          selectors(type),

          declarations(type)

#ifdef HB_CSS_INSPECTOR

          , owningStyleSheet(0, type)

#endif

    {}