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

**

** 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 "hbstyleoptionslider.h"

#include "hbstyleoptionsliderelement_p.h"

#include "hbstyleoptionpushbutton.h"

#include "hbstyleoptiontoolbutton.h"

#include "hbstyleoptiontooltip.h"

#include "hbstyleoptionprogressbar.h"

#include "hbstyleoptionabstractviewitem.h"

#include "hbstyleoptionlistviewitem.h"

#include "hbstyleoptionmenuitem.h"

#include "hbstyleoptionlabel.h"

#include "hbstyleoptionscrollbar.h"

#include "hbstyleoptiontoolbarextension.h"

#include "hbstyleoptiongridviewitem.h"

#include "hbstyleoptioncheckbox.h"

#include "hbiconloader_p.h"

#include "hbstyleoptiontitlepane.h"

#include "hbstyleoptionstatusbar_p.h"

#include "hbstyleoptionindicatorgroup.h"

#include "hbstyleoptionprogressdialog.h"

#include "hbstyleoptionnotificationdialog.h"

#include "hbstyleoptiontreeviewitem.h"

#include "hbstyleoptioncolorgridviewitem.h"

#include "hbstyleoptionmessagebox.h"

#include "hbstyleoptionsoftkey.h"   // deprecated

#include "hbstyleoptionnavigationbutton.h"

#include "hbstyleoptionindicatorbutton.h"

#include "hbstyleoptionsignalindicator_p.h"

#include "hbstyleoptionbatteryindicator_p.h"

#include "hbstyle_p.h"

#include "hbstyleloader.h"

#include "hbwidgetloader_p.h"

#include "hbstyleoptionratingslider.h"

#include "hbstyleoptiondataformviewitem.h"

#include "hbstyleoptiondatagroup_p.h"

#include "hbstyleoptiondatagroupheadingwidget_p.h"

#include "hbstyleoptiondataform.h"

#include "hbstyleoptiongroupbox.h"

#include "hbstyleoptionindexfeedback.h"

#include "hbstyleoptioncombobox.h"

#include "hbstyleoptioninputdialog.h"

#include <hbicon.h>

#include <hbstyle.h>

#include <hbframedrawer.h>

#include <hbiconitem.h>

#include <hbiconitem_p.h>

#include <hbframeitem.h>

#include <hbframedrawer.h>

#include <hbframedrawer_p.h>

#include <hbframebackground.h>

#include <hbprogresstrackitem_p.h>

#include <hbslidertrackitem_p.h>

#include <hbinstance.h>

#include <hbtextitem.h>

#include <hbtextitem_p.h>

#include <hbmarqueeitem.h>

#include <hbmarqueeitem_p.h>

#include <hbrichtextitem.h>

#include <hbrichtextitem_p.h>

#include <hbtoucharea.h>

#include <hbindicatorleveliconitem_p.h>

#include <hbglobal.h>

#include <QPluginLoader>

#include <hbstyleinterface.h>

#include <hbstyleparameters.h>

#include "hbstyleselector_p.h"

#include "hblayeredstyleloader_p.h"

#include "hbwidgetstyleloader_p.h"

#include "hbcssparser_p.h"

#include "hbrepeaticonitem_p.h"

#include "hbcolortheme_p.h"

#include "hbnamespace_p.h"

#include "hbmeshlayout_p.h"

#include <QGraphicsWidget>

#include <hbwidget.h>

#include <hbwidgetbase.h>

#include "hbdeviceprofile.h"

#include "hbrepeatitem_p.h"

#include <QDebug>

//Uncomment next define in order to get more debug prints.

//Similar define exists also in the engine side.

//#define HBSTYLE_DEBUG

#ifdef HBSTYLE_DEBUG

#include <QDebug>

#endif

/*!

    @beta

    @hbcore

    \class HbStyle

    \brief HbStyle is the style management class for widgets

    HbStyle is used for the style management of widgets.

    It offers methods to create and update styled primitives. Briefly, styled primitives

    are HbWidgetBase-derived (which is a QGraphicsWidget) classes which draw a certain part of the user interface (for example

    the button background, or the slider thumb).

    A widget that chooses to be styled needs to create its primitives

    by using the createPrimitive method.

    Whenever the widget's state changes in a way that needs changes in drawing the primitive

    (such as button pressed down -> change the button background image) then the widget needs to

    call the updatePrimitive method.

    Generally primitives should be updated only when a state change occurs. When a widget uses primitives to construct

    itself it does not need a paint() method at all since primitives (widget's childs) are doing the drawing. 

    Painting for the primitives occurs from the graphics scene.

*/

// TODO: margins should be defined in layout data once layout specification exists.

static const int ItemName = 0xfffe;

static const QString STYLE_LOCATION = QLatin1String(":/themes/style/hbdefault/rules/widgets/%w/%w");

static const QString COLOR_STYLE_LOCATION = QLatin1String(":/themes/style/hbdefault/rules/widgets/%w/%w_color");

static const int TOUCHAREA_ZVALUE = 1000;

static const QString GLOBAL_PARAMETERS_LOCATION = QLatin1String(":/themes/style/hbdefault/variables/layout/zoom/0/hbglobalparameters.css");

/*!

Constructor

*/

HbStyle::HbStyle() :

    d_ptr(new HbStylePrivate)

{

    Q_D( HbStyle );

    d->q_ptr = this;

    QObject::connect(hbInstance->theme(), SIGNAL(changed()), this, SLOT(_q_onThemeChanged()));

}

/*!

Destructor

*/

HbStyle::~HbStyle()

{

    delete d_ptr;

}

/*!

    Registers the style plugin with the Style system. This method can be called by a custom widget

    or application in order to register the style plugin that implements the custom graphics primitives.

    This method results in loading of the plugin, if the plugin is registered for the first time.

    It returns the base ID for the primitives implemented by the style plugin. The custom widget

    can use the range of integers from (BaseID) to (BaseID+count-1) to refer to the custom

    primitives, where count is the number of primitives supported by the plugin. The style

    plugin must return the correct number of primitives when the primitiveCount() method is called.

    In case of errors the method returns < 0. Note also that for each registerPlugin there must be

    a unregisterPlugin call, the last unregisterPlugin call for a plugin causes the plugin to be unloaded.

    If the style plugin implementation returns valid path with layout defition files (CSS+WidgetML)

    from layoutPath() method the layout definitions CSSs gets read when calling registerPlugin().

    \param pluginName, name of the Plugin library to be dynamically loaded

    \return int the base ID to be used for the primitives implemented by the style plugin

    \sa unregisterPlugin()

 */

int HbStyle::registerPlugin(const QString &pluginName)

{

    Q_D( const HbStyle );

    // check if the plugin is already registered

    if (d->registeredPlugins.contains(pluginName)) {

        // increase the reference count

        d->registeredPlugins.value(pluginName)->refCount++;

        // return the base ID of the primitives enumeration

        return d->registeredPlugins.value(pluginName)->primitiveBaseId;

    }

    // load the plugin

    QPluginLoader* loader = new QPluginLoader(pluginName);

    if (loader == 0)

        return -1;

    // get the instance pointer

    QObject* pluginInstance = loader->instance();

    if (pluginInstance == 0) {

        delete loader;

        // try the additional paths

        QFileInfo fileInfo( pluginName );

        foreach( QString additionalPath, hbInstance->libraryPaths() ) {

            const QDir pluginDir(additionalPath);

            loader = new QPluginLoader(pluginDir.absoluteFilePath(fileInfo.fileName()));

            if ( loader ) {

                pluginInstance = loader->instance();

                if ( !pluginInstance ) {

                    delete loader;

                } else {

                    break;

                }

            }

        }

        if ( !pluginInstance ) {

            return -1;

        }

    }

    HbStyleInterface *stylePlugin = qobject_cast<HbStyleInterface *>(pluginInstance);

    int primitiveCount = stylePlugin->primitiveCount();

    if (primitiveCount <= 0) {

        delete pluginInstance;

        delete loader;

        return -1;

    }

    HbStyleInterfaceInfo* info = new HbStyleInterfaceInfo();

    info->loader = loader;

    info->primitiveBaseId = d->nextAvailableId;

    // make entries for the primitives in the hash table

    for (int i=d->nextAvailableId; i<(d->nextAvailableId+primitiveCount); i++)

    {

        d->customPrimitives.insert(i, info);

    }

    // make entry for the plugin in the registered plugins hash table

    HbStylePluginInfo* pluginInfo = new HbStylePluginInfo();

    pluginInfo->primitiveBaseId = d->nextAvailableId;

    pluginInfo->primitiveCount = primitiveCount;

    pluginInfo->refCount = 1;

    d->registeredPlugins.insert(pluginName, pluginInfo);

    d->nextAvailableId += primitiveCount;

    // register associated style files

    HbWidgetStyleLoader::instance()->addFilePath(

        stylePlugin->layoutPath(),

        HbLayeredStyleLoader::Concern_Layouts, 

        HbLayeredStyleLoader::Priority_Core);

    d->pluginStylePaths.insert(pluginName, stylePlugin->layoutPath());

    return pluginInfo->primitiveBaseId;

}

/*!

    Un-registers the style plugin.

    If the reference count becomes zero, the plugin is unloaded and the primitive IDs are de-registered

    If a client has called registerPlugin() it must unregister the style plugin with this method.

    \param pluginName, name of the Plugin library

 */

void HbStyle::unregisterPlugin(const QString &pluginName)

{

    Q_D( const HbStyle );

    if (d->registeredPlugins.contains(pluginName)) {

        HbStylePluginInfo *info = d->registeredPlugins.value(pluginName);

        info->refCount--;

        // unload plugin and remove from list

        if (info->refCount == 0) {

            HbStyleInterfaceInfo* styleInfo = d->customPrimitives.value(info->primitiveBaseId);

            delete styleInfo->loader->instance();

            delete styleInfo->loader;

            delete styleInfo;

            for (int i=info->primitiveBaseId; i< (info->primitiveBaseId+info->primitiveCount); i++) {

                  d->customPrimitives.remove(i);

            }

            d->registeredPlugins.remove(pluginName);

	        // unregister associated style files

            HbWidgetStyleLoader::instance()->removeFilePath(

                d->pluginStylePaths.value(pluginName),

                HbLayeredStyleLoader::Concern_Layouts, 

                HbLayeredStyleLoader::Priority_Core);

            d->pluginStylePaths.remove(pluginName);

            if( d->registeredPlugins.count() == 0 ){

                // no plugins loaded, can reset the id counter

                d->nextAvailableId = HbStyle::P_CustomBase;

            }

        }

    }

}

/*!

  Creates instances of primitive graphics items. This method should be used by all widgets that support styling.

  When changing the style the returned primitives can be replaced with an altered version of the primitives, or with a completely

  different primitive, to create a custom appearance. This shouldn't cause changes to the widget if the functional design

  remains the same.

  This method returns HbWidgetBase objects. A widget can store the returned items as HbWidgetBase. If a widget

  does not require any functionality from HbWidgetBase then it should store the primitives as QGraphicsItems.

  \note This method is used to replace the conventional Qt-style paint indirection via drawPrimitive.

  \sa HbStyle::updatePrimitive method which is to be used in conjunction with this method

  \sa HbWidgetBase

  \param primitive, to identify the primitive to create

  \param parent of the item

  \return HbWidgetBase is returned.

 */

QGraphicsItem *HbStyle::createPrimitive( HbStyle::Primitive primitive, QGraphicsItem *parent ) const

{

    Q_D( const HbStyle );

    if (d->customPrimitives.contains(primitive)) {

        HbStyleInterfaceInfo* info = d->customPrimitives.value(primitive);

        QObject* pluginInstance = info->loader->instance();

        HbStyleInterface *stylePlugin = qobject_cast<HbStyleInterface *>(pluginInstance);

        return stylePlugin->createPrimitive((HbStyle::Primitive)(primitive-info->primitiveBaseId), parent);

    }

        switch (primitive){

            case P_MenuItem_submenuindicator:

                {

                HbIconItem *item = new HbIconItem(parent);

                setItemName(item, QLatin1String("submenu-indicator"));

                return item;

                }

            case P_MenuItem_checkindicator:

                {

                HbIconItem *item = new HbIconItem(parent);

                setItemName(item, QLatin1String("check-indicator"));

                return item;

                }

            case P_MenuItem_separator:

                {

                HbIconItem *item = new HbIconItem(parent);

                setItemName(item, QLatin1String("separator"));

                return item;

                }

            case P_ToolButton_icon:

            case P_PushButton_icon:

			case P_ProgressDialog_icon:

            case P_CheckBox_icon:

            case P_GroupBoxHeading_icon:

            case P_Label_icon:

            case P_GridViewItem_icon: {

                HbIconItem *item = new HbIconItem(HbIcon(),parent);

                setItemName(item, QLatin1String("icon"));

                return item; 

                }

            case P_DataGroup_icon:

                {

                HbIconItem *item = new HbIconItem(HbIcon(), parent);

                setItemName(item, QLatin1String("dataGroup_Icon"));

                return item; 

                }

            case P_DataItem_icon:

                {

                HbIconItem *item = new HbIconItem(HbIcon(), parent);

                setItemName(item, QLatin1String("dataItem_Icon"));

                return item; 

                }

            case P_ComboBox_text:

                {

                    HbTextItem *textItem = new HbTextItem(parent);

                    setItemName(textItem, QLatin1String("combobox_labelfield"));

                    return  textItem;

                }

            case P_ToolButton_text:

            case P_CheckBox_text:

            case P_ProgressDialog_text:

            case P_PushButton_text:

                {

                HbTextItem *ti = new HbTextItem(parent);

                setItemName(ti, QLatin1String("text"));

                return  ti;

                }

            case P_DataGroup_heading:

                {

                HbTextItem *ti = new HbTextItem(parent);

                setItemName(ti, QLatin1String("dataGroup_HeadingLabel"));

                return  ti;

                }

            case P_DataGroup_description:

                {

                HbTextItem *ti = new HbTextItem(parent);

                setItemName(ti, QLatin1String("dataGroup_Description"));

                return  ti;

                }

            case P_DataForm_heading:

                {

                HbTextItem *ti = new HbTextItem(parent);

                setItemName(ti, QLatin1String("dataForm_Heading"));

                //ti->setZValue(2);

                return  ti;

                }

            case P_DataForm_description:

                {

                HbTextItem *ti = new HbTextItem(parent);

                setItemName(ti, QLatin1String("dataForm_Desc"));

                return  ti;

                }

            case P_PushButton_additionaltext:

                {

                HbTextItem *ti = new HbTextItem(parent);

                setItemName(ti, QLatin1String("additional-text"));

                return  ti;

                }

             case P_ProgressBar_toucharea:

                {

                HbTouchArea *ta = new HbTouchArea(parent);

                ta->setFlag(QGraphicsItem::ItemIsFocusable);

                setItemName(ta, QLatin1String("toucharea1"));

				ta->setZValue(TOUCHAREA_ZVALUE);

                return ta;

                }

			case P_ProgressSliderHandle_toucharea: 

                {

                HbTouchArea *ta = new HbTouchArea(parent);

                ta->setFlag(QGraphicsItem::ItemIsFocusable);

                setItemName(ta, QLatin1String("toucharea"));

				ta->setZValue(TOUCHAREA_ZVALUE);

                if(parent){

                    parent->setHandlesChildEvents(true); 

                }

                return ta;

                }

			case P_ProgressSlider_handle:

			    {

                HbIconItem *item = new HbIconItem(QLatin1String("qtg_graf_progslider_handle_normal"), parent);

				item->setAspectRatioMode(Qt::IgnoreAspectRatio);

                return item;									 

				}

            case P_ProgressSlider_handleicon:{

                HbIconItem *item = new HbIconItem(QLatin1String("qtg_mono_play"), parent);

                return item;

                }

            case P_PushButton_toucharea: // Generic implementation, can add other cases here

            case P_CheckBox_toucharea:

            case P_RatingSlider_toucharea:

	        case P_SliderElement_touchhandle: 

                {

                HbTouchArea *ta = new HbTouchArea(parent);

                ta->setFlag(QGraphicsItem::ItemIsFocusable);

                setItemName(ta, QLatin1String("toucharea"));

                if(parent){

                    parent->setHandlesChildEvents(true); 

                }

                return ta;

                }

            case P_ScrollBar_toucharea:

                {

                HbTouchArea *ta = new HbTouchArea(parent);

                ta->setFlags(QGraphicsItem::ItemIsFocusable);

                setItemName(ta, QLatin1String("toucharea"));

                // NOTE:: This is a temporary fix

                //if(parent){

                //    parent->setHandlesChildEvents(true); 

                //}

                return ta;

                }

            case P_ComboBoxButton_toucharea:

                {

                HbTouchArea *ta = new HbTouchArea(parent);

                ta->setFlag(QGraphicsItem::ItemIsFocusable);

                setItemName(ta, QLatin1String("combobox_button_toucharea"));

                /*if(parent){

                    parent->setHandlesChildEvents(true); 

                }*/

                return ta;

                }

             case P_TitleBar_toucharea: {

                HbTouchArea *ta = new HbTouchArea(parent);

                ta->setFlag(QGraphicsItem::ItemIsFocusable);

                setItemName(ta, QLatin1String("toucharea"));

                return ta;

                }

             case P_SliderElement_touchdecrease:

             case P_SliderElement_touchincrease:

             case P_SliderElement_touchgroove:

                {

                HbTouchArea *ta = new HbTouchArea(parent);

                ta->setFlag(QGraphicsItem::ItemIsFocusable);

                if(parent){

                    //parent->setHandlesChildEvents(true); 

                }

                return ta;

                }

            case P_SliderElement_text:

            case P_ProgressBar_text:

            {

                HbTextItem *ti = new HbTextItem(parent);

                return  ti;

            }

            case P_DataItem_label:

            {

                HbTextItem *ti = new HbTextItem(parent);

                setItemName(ti, QLatin1String("dataItem_Label"));

                return  ti;

            }

            case P_DataItem_description:

            {

                HbTextItem *ti = new HbTextItem(parent);

                setItemName(ti, QLatin1String("dataItem_Description"));