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

**

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

**

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

#include "hbxmlloaderbasesyntax_p.h"

#include <QMetaEnum>

#include <QDebug>

/*

    \class HbXmlLoaderBaseSyntax

    \internal

    \proto

*/

HbXmlLoaderBaseSyntax::HbXmlLoaderBaseSyntax( HbXmlLoaderAbstractActions *actions )

: HbXmlLoaderAbstractSyntax(actions)

{

}

HbXmlLoaderBaseSyntax::~HbXmlLoaderBaseSyntax()

{

    qDeleteAll(mCurrentContainer);

}

bool HbXmlLoaderBaseSyntax::load( QIODevice *device, const QString &section )

{

    return loadDevice(device, section);

}

bool HbXmlLoaderBaseSyntax::scanForSections( QIODevice *device, QList<QString> &sectionsList ) {

    const QChar separator(' ');

    bool exit = false;

    bool result = true;

    mReader.setDevice( device );

    mCurrentSection.clear();

    mTopState = TS_READ_DOCUMENT;

    while( !exit ) {

        switch( mTopState ) {

            case TS_READ_DOCUMENT:

            {

                mCurrentTokenType = mReader.readNext();

                HB_DOCUMENTLOADER_PRINT( "TOP_STATE READ_ELEMENT " + mReader.name().toString() );

                switch( mCurrentTokenType ) {

                    case QXmlStreamReader::EndElement:

                    case QXmlStreamReader::StartElement:

                    {

                        mCurrentElementType = elementType( mReader.name() );

                        if( ( mCurrentElementType == HbXml::METADATA ) && ( mCurrentTokenType == QXmlStreamReader::StartElement ) ) {

                            mTopState = TS_READ_METADATA;

                            break;

                        }

                        if( mCurrentElementType == HbXml::SECTION ) {

                            if( mCurrentTokenType == QXmlStreamReader::StartElement ) {

                                QString name = attribute( ATTR_NAME );

                                if( name.isEmpty() ) {

                                    qWarning() << "Section without a name, line " << mReader.lineNumber();

                                    mTopState = TS_ERROR;

                                    break;

                                }

                                mCurrentSection << name;

                                sectionsList.append( mCurrentSection.join( separator ) );

                            } else if( mCurrentTokenType == QXmlStreamReader::EndElement ) {

                                mCurrentSection.removeLast();

                            }

                        }

                        break;

                    }

                    case QXmlStreamReader::EndDocument:

                    {

                        mTopState = TS_EXIT;

                        break;

                    }

                    case QXmlStreamReader::Characters:

                    {

                        if( mReader.isWhitespace() ) {

                            break;

                        }

                        HB_DOCUMENTLOADER_PRINT( "Characters" );

                    }

                    case QXmlStreamReader::NoToken:

                    HB_DOCUMENTLOADER_PRINT( "NoToken" );

                    case QXmlStreamReader::Invalid:

                    HB_DOCUMENTLOADER_PRINT( "Invalid" );

                    case QXmlStreamReader::EntityReference:

                    {

                        qWarning() << "Parse error, line " << mReader.lineNumber();

                        mTopState = TS_ERROR;

                        break;

                    }

                    case QXmlStreamReader::StartDocument:

                    case QXmlStreamReader::Comment:

                    case QXmlStreamReader::DTD:

                    case QXmlStreamReader::ProcessingInstruction:

                    default:

                    {

                        break;

                    }

                }

                break;

            }

            case TS_READ_METADATA:

            {

                HB_DOCUMENTLOADER_PRINT( "TOP_STATE READ_METADATA" );

                mCurrentTokenType = mReader.readNext();

                switch( mCurrentTokenType ) {

                    case QXmlStreamReader::EndElement:

                    {

                        mCurrentElementType = elementType( mReader.name() );

                        if( mCurrentElementType == HbXml::METADATA ) {

                            mTopState = TS_READ_DOCUMENT;

                        }

                        break;

                    }

                    case QXmlStreamReader::NoToken:

                    case QXmlStreamReader::Invalid:

                    {

                        qWarning() << "Parse error, line " << mReader.lineNumber();

                        mTopState = TS_ERROR;

                        break;

                    }

                    case QXmlStreamReader::EndDocument:

                    {

                        qWarning() << "Unexpected end of document, line " << mReader.lineNumber();

                        mTopState = TS_ERROR;

                        break;

                    }

                    default:

                    {

                        break;

                    }

                }

                break;

            }

            case TS_ERROR:

            {

                HB_DOCUMENTLOADER_PRINT( "TOP_STATE ERROR" );

                result = false;

                mTopState = TS_EXIT;

                break;

            }

            case TS_EXIT:

            {

                HB_DOCUMENTLOADER_PRINT( "TOP_STATE EXIT" );

                exit = true;

                break;

            }

            default:

            {

                HB_DOCUMENTLOADER_PRINT( "INTERNAL ERROR" );

                mTopState = TS_ERROR;

                break;

            }

        }

    }

    mReader.clear();

    return result;

}

bool HbXmlLoaderBaseSyntax::loadDevice(QIODevice *device, const QString &section)

{

    const QChar separator(' ');

    mReader.setDevice( device );

    bool exit = false;

    bool result = true;

    mCurrentSection.clear();

    mRequiredSection.clear();

    mTopState = TS_READ_DOCUMENT;

    mDocumentState = DS_START_DOCUMENT;

    mElementState = ES_GENERAL_ITEM;

    mCurrentLayoutType = LAYOUT_NULL;

    mCurrentContainerType = CONTAINER_NULL;

    if( section != 0 ) {

        mRequiredSection = section.split( separator, QString::SkipEmptyParts );

    }

    while( !exit ) {

        switch( mTopState ) {

            case TS_READ_DOCUMENT:

            {

                mCurrentTokenType = mReader.readNext();

                HB_DOCUMENTLOADER_PRINT( "TOP_STATE READ_ELEMENT " + mReader.name().toString() );

                switch( mCurrentTokenType ) {

                    case QXmlStreamReader::EndElement:

                    case QXmlStreamReader::StartElement:

                    {

                        mCurrentElementType = elementType( mReader.name() );

                        if( ( mCurrentElementType == HbXml::METADATA ) && ( mCurrentTokenType == QXmlStreamReader::StartElement ) ) {

                            mTopState = TS_READ_METADATA;

                            break;

                        }

                        if( ! readDocument() ) {

                            qWarning() << "Error in document, line " << mReader.lineNumber();

                            mTopState = TS_ERROR;

                        }

                        break;

                    }

                    case QXmlStreamReader::EndDocument:

                    {

                        if( mDocumentState == DS_END_DOCUMENT ) {

                            mTopState = TS_EXIT;

                        } else {

                            qWarning() << "Unexpected end of document, line " << mReader.lineNumber();

                            mTopState = TS_ERROR;

                        }

                        break;

                    }

                    case QXmlStreamReader::Characters:

                    {

                        if( mReader.isWhitespace() ) {

                            break;

                        }

                        HB_DOCUMENTLOADER_PRINT( "Characters" );

                    }

                    case QXmlStreamReader::NoToken:

                    HB_DOCUMENTLOADER_PRINT( "NoToken" );

                    case QXmlStreamReader::Invalid:

                    HB_DOCUMENTLOADER_PRINT( "Invalid" );

                    case QXmlStreamReader::EntityReference:

                    {

                        qWarning() << "Parse error, line " << mReader.lineNumber();

                        mTopState = TS_ERROR;

                        break;

                    }

                    case QXmlStreamReader::StartDocument:

                    case QXmlStreamReader::Comment:

                    case QXmlStreamReader::DTD:

                    case QXmlStreamReader::ProcessingInstruction:

                    default:

                    {

                        break;

                    }

                }

                break;

            }

            case TS_READ_METADATA:

            {

                HB_DOCUMENTLOADER_PRINT( "TOP_STATE READ_METADATA" );

                mCurrentTokenType = mReader.readNext();

                switch( mCurrentTokenType ) {

                    case QXmlStreamReader::EndElement:

                    {

                        mCurrentElementType = elementType( mReader.name() );

                        if( mCurrentElementType == HbXml::METADATA ) {

                            mTopState = TS_READ_DOCUMENT;

                        }

                        break;

                    }

                    case QXmlStreamReader::NoToken:

                    case QXmlStreamReader::Invalid:

                    {

                        qWarning() << "Parse error, line " << mReader.lineNumber();

                        mTopState = TS_ERROR;

                        break;

                    }

                    case QXmlStreamReader::EndDocument:

                    {

                        qWarning() << "Unexpected end of document, line " << mReader.lineNumber();

                        mTopState = TS_ERROR;

                        break;

                    }

                    default:

                    {

                        break;

                    }

                }

                break;

            }

            case TS_ERROR:

            {

                HB_DOCUMENTLOADER_PRINT( "TOP_STATE ERROR" );

                result = false;

                mActions->cleanUp();

                mActions->deleteAll();

                exit = true;

                break;

            }

            case TS_EXIT:

            {

                mActions->cleanUp();

                HB_DOCUMENTLOADER_PRINT( "TOP_STATE EXIT" );

                exit = true;

                break;

            }

            default:

            {

                HB_DOCUMENTLOADER_PRINT( "INTERNAL ERROR" );

                mTopState = TS_ERROR;

                break;

            }

        }

    }

    mReader.clear();

    return result;

}

bool HbXmlLoaderBaseSyntax::readDocument()

{

    bool result = false;

    switch( mDocumentState ) {

        case DS_START_DOCUMENT:

        {

            HB_DOCUMENTLOADER_PRINT( "DOCUMENT_STATE START DOCUMENT" );

            if( mCurrentElementType == HbXml::DOCUMENT ) {

                result = processDocument();

                HB_DOCUMENTLOADER_PRINT( "SWITCHING TO READ SECTIONS STATE" );

                mDocumentState = DS_READ_SECTIONS;

            }

            break;

        }

        case DS_READ_SECTIONS:

        {

            if( ( mCurrentElementType == HbXml::DOCUMENT ) && ( mCurrentTokenType == QXmlStreamReader::EndElement ) ) {

                HB_DOCUMENTLOADER_PRINT( "SWITCHING TO END DOCUMENT STATE" );

                mDocumentState = DS_END_DOCUMENT;

                result = checkEndElementCorrectness();

                break;

            }

            if( ( mCurrentSection != mRequiredSection ) ) {

                HB_DOCUMENTLOADER_PRINT( "DOCUMENT_STATE READ ALIEN SECTIONS" );

                result = readAlienSection();

            } else {

                HB_DOCUMENTLOADER_PRINT( "DOCUMENT_STATE READ TARGET SECTIONS" );

                result = readTargetSection();

            }

            break;

        }

        case DS_END_DOCUMENT:

        {

            HB_DOCUMENTLOADER_PRINT( "DOCUMENT_STATE END DOCUMENT - ERROR" );

            break;

        }

    }

    return result;

}

bool HbXmlLoaderBaseSyntax::readAlienSection()

{

    if( mCurrentElementType == HbXml::SECTION ) {

        if( mCurrentTokenType == QXmlStreamReader::StartElement ) {

            QString name = attribute( ATTR_NAME );

            if( name.isEmpty() ) {

                qWarning() << "Section without a name, line " << mReader.lineNumber();

                return false;

            }

            HB_DOCUMENTLOADER_PRINT( QString( "READ ALIEN SECTION: LEAVING SECTION " ) + "'" + mCurrentSection.join(" ") + "'" );

            mCurrentSection << name;

            HB_DOCUMENTLOADER_PRINT( QString("READ ALIEN SECTION: ENTERING SECTION " ) + "'" + mCurrentSection.join(" ") + "'" );

        } else if( mCurrentTokenType == QXmlStreamReader::EndElement ) {

            HB_DOCUMENTLOADER_PRINT( QString( "READ ALIEN SECTION: LEAVING SECTION " ) + "'" + mCurrentSection.join(" ") + "'" );

            mCurrentSection.removeLast();

            HB_DOCUMENTLOADER_PRINT( QString( "READ ALIEN SECTION: ENTERING SECTION " ) + "'" + mCurrentSection.join(" ") + "'" );

        } else {

            HB_DOCUMENTLOADER_PRINT( "READ ALIEN SECTION: UNEXPECTED TOKEN TYPE" );

        }

    }

    return true;

}

bool HbXmlLoaderBaseSyntax::readTargetSection()

{

    bool result = false;

    if( mCurrentTokenType == QXmlStreamReader::StartElement ) {

        HB_DOCUMENTLOADER_PRINT( QString( "READ TARGET SECTION: START ELEMENT " ) + mReader.name().toString() );

        switch( mElementState ) {

            case ES_GENERAL_ITEM:

            {

                result = readGeneralStartItem();

                break;

            }

            case ES_LAYOUT_ITEM:

            {

                result = readLayoutStartItem();

                break;

            }

            case ES_CONTAINER_ITEM:

            {

                result = readContainerStartItem();

                break;

            }

        }

    } else if( mCurrentTokenType == QXmlStreamReader::EndElement ) {

        HB_DOCUMENTLOADER_PRINT( QString( "READ TARGET SECTION: END ELEMENT " ) + mReader.name().toString() );

        switch( mElementState ) {

            case ES_GENERAL_ITEM:

            {

                result = readGeneralEndItem();

                break;

            }

            case ES_LAYOUT_ITEM:

            {

                result = readLayoutEndItem();

                break;

            }

            case ES_CONTAINER_ITEM:

            {

                result = readContainerEndItem();

                break;

            }

        }

    } else {

        HB_DOCUMENTLOADER_PRINT( "READ TARGET SECTION: UNEXPECTED TOKEN TYPE" );

    }

    return result;

}

bool HbXmlLoaderBaseSyntax::readContainerStartItem()

{

    qWarning() << "Internal error, wrong container type, line " << mReader.lineNumber();

    return false;

}

bool HbXmlLoaderBaseSyntax::readContainerEndItem()

{

    HB_DOCUMENTLOADER_PRINT( "GENERAL CONTAINER END ITEM" );

    if( mCurrentElementType == HbXml::CONTAINER ) {

        HB_DOCUMENTLOADER_PRINT( "GENERAL CONTAINER END ITEM : SWITCHING TO GENERAL ITEM PROCESSING MODE" );

        mElementState = ES_GENERAL_ITEM;

    }

    return true;

}

bool HbXmlLoaderBaseSyntax::readLayoutStartItem()

{

    qWarning() << "Internal error, wrong layout type, line " << mReader.lineNumber();

    return false;

}

bool HbXmlLoaderBaseSyntax::readAnchorLayoutStartItem(bool idBased)

{

    bool result = true;

    HbXmlLengthValue minVal, prefVal, maxVal;

    QSizePolicy::Policy sizepolicyVal;

    QSizePolicy::Policy *sizepolicyValP = 0;

    HbAnchor::Direction directionVal;

    HbAnchor::Direction *directionValP = 0;

    QString anchorId;

    const QString src = attribute( AL_SRC_NAME );

    QString srcId = attribute( AL_SRC_ID );

    if ( src.isNull() && srcId.isNull() ) {

        HB_DOCUMENTLOADER_PRINT( QString( "ANCHORLAYOUT: NO SRC NOR SRCID SPECIFIED" ) );

        result = false;

    } else if ( !src.isNull() && !srcId.isNull() ) {

        HB_DOCUMENTLOADER_PRINT( QString( "ANCHORLAYOUT: BOTH SRC AND SRCID SPECIFIED" ) );

        result = false;

    } else if ( idBased && srcId.isNull() ) {

        srcId = src;

    }

    const QString dst = attribute( AL_DST_NAME );

    QString dstId = attribute( AL_DST_ID );

    if ( dst.isNull() && dstId.isNull() ) {

        HB_DOCUMENTLOADER_PRINT( QString( "ANCHORLAYOUT: NO DST NOR DSTID SPECIFIED" ) );

        result = false;

    } else if ( !dst.isNull() && !dstId.isNull() ) {

        HB_DOCUMENTLOADER_PRINT( QString( "ANCHORLAYOUT: BOTH DST AND DSTID SPECIFIED" ) );

        result = false;

    } else if ( idBased && dstId.isNull() ) {

        dstId = dst;

    }

    const QString srcEdgeStr = attribute( AL_SRC_EDGE );

    const QString dstEdgeStr = attribute( AL_DST_EDGE );