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

**

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

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the Qt Designer 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 Technology Preview License Agreement accompanying

** this package.

**

** 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.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 qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

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

#include "qdesigner_propertysheet_p.h"

#include "qdesigner_utils_p.h"

#include "formwindowbase_p.h"

#include "layoutinfo_p.h"

#include "qlayout_widget_p.h"

#include "qdesigner_introspection_p.h"

#include <formbuilderextra_p.h>

#include <QtDesigner/QDesignerFormWindowInterface>

#include <QtDesigner/QDesignerFormEditorInterface>

#include <QtDesigner/QDesignerWidgetDataBaseInterface>

#include <QtCore/QDebug>

#include <QtGui/QLayout>

#include <QtGui/QDockWidget>

#include <QtGui/QDialog>

#include <QtGui/QLabel>

#include <QtGui/QGroupBox>

#include <QtGui/QStyle>

#include <QtGui/QApplication>

#include <QtGui/QToolBar>

#include <QtGui/QMainWindow>

#include <QtGui/QMenuBar>

QT_BEGIN_NAMESPACE

#define USE_LAYOUT_SIZE_CONSTRAINT

static const QDesignerMetaObjectInterface *propertyIntroducedBy(const QDesignerMetaObjectInterface *meta, int index)

{

    if (index >= meta->propertyOffset())

        return meta;

    if (meta->superClass())

        return propertyIntroducedBy(meta->superClass(), index);

    return 0;

}

// Layout fake properties (prefixed by 'layout' to distinguish them from other 'margins'

// that might be around. These are forwarded to the layout sheet (after name transformation).

//

// 'layoutObjectName' is new for 4.4. It is the name of the actual layout.

// Up to 4.3, QLayoutWidget's name was displayed in the objectinspector.

// This changes with 4.4; the layout name is displayed. This means that for

// old forms, QLayoutWidget will show up as ''; however, the uic code will

// still use 'verticalLayout' (in case someone accesses it). New Layouts get autogenerated names,

// legacy forms will keep their empty names (unless someone types in a new name).

static const char *layoutObjectNameC = "layoutName";

static const char *layoutLeftMarginC = "layoutLeftMargin";

static const char *layoutTopMarginC = "layoutTopMargin";

static const char *layoutRightMarginC = "layoutRightMargin";

static const char *layoutBottomMarginC = "layoutBottomMargin";

static const char *layoutSpacingC = "layoutSpacing";

static const char *layoutHorizontalSpacingC = "layoutHorizontalSpacing";

static const char *layoutVerticalSpacingC = "layoutVerticalSpacing";

static const char *layoutSizeConstraintC = "layoutSizeConstraint";

// form layout

static const char *layoutFieldGrowthPolicyC = "layoutFieldGrowthPolicy";

static const char *layoutRowWrapPolicyC = "layoutRowWrapPolicy";

static const char *layoutLabelAlignmentC = "layoutLabelAlignment";

static const char *layoutFormAlignmentC = "layoutFormAlignment";

// stretches

static const char *layoutboxStretchPropertyC = "layoutStretch";

static const char *layoutGridRowStretchPropertyC = "layoutRowStretch";

static const char *layoutGridColumnStretchPropertyC = "layoutColumnStretch";

static const char *layoutGridRowMinimumHeightC = "layoutRowMinimumHeight";

static const char *layoutGridColumnMinimumWidthC = "layoutColumnMinimumWidth";

// Find the form editor in the hierarchy.

// We know that the parent of the sheet is the extension manager

// whose parent is the core.

static QDesignerFormEditorInterface *formEditorForObject(QObject *o) {

    do {

        if (QDesignerFormEditorInterface* core = qobject_cast<QDesignerFormEditorInterface*>(o))

            return core;

        o = o->parent();

    } while(o);

    Q_ASSERT(o);

    return 0;

}

static bool hasLayoutAttributes(QDesignerFormEditorInterface *core, QObject *object)

{

    if (!object->isWidgetType())

        return false;

    QWidget *w =  qobject_cast<QWidget *>(object);

    if (const QDesignerWidgetDataBaseInterface *db = core->widgetDataBase()) {

        if (db->isContainer(w))

            return true;

    }

    return false;

}

// Cache DesignerMetaEnum by scope/name of a  QMetaEnum

static const qdesigner_internal::DesignerMetaEnum &designerMetaEnumFor(const QDesignerMetaEnumInterface *me)

{

    typedef QPair<QString, QString> ScopeNameKey;

    typedef QMap<ScopeNameKey, qdesigner_internal::DesignerMetaEnum> DesignerMetaEnumCache;

    static DesignerMetaEnumCache cache;

    const QString name = me->name();

    const QString scope = me->scope();

    const ScopeNameKey key = ScopeNameKey(scope, name);

    DesignerMetaEnumCache::iterator it = cache.find(key);

    if (it == cache.end()) {

        qdesigner_internal::DesignerMetaEnum dme = qdesigner_internal::DesignerMetaEnum(name, scope, me->separator());

        const int keyCount = me->keyCount();

        for (int i=0; i < keyCount; ++i)

            dme.addKey(me->value(i), me->key(i));

        it = cache.insert(key, dme);

    }

    return it.value();

}

// Cache DesignerMetaFlags by scope/name of a  QMetaEnum

static const qdesigner_internal::DesignerMetaFlags &designerMetaFlagsFor(const QDesignerMetaEnumInterface *me)

{

    typedef QPair<QString, QString> ScopeNameKey;

    typedef QMap<ScopeNameKey, qdesigner_internal::DesignerMetaFlags> DesignerMetaFlagsCache;

    static DesignerMetaFlagsCache cache;

    const QString name = me->name();

    const QString scope = me->scope();

    const ScopeNameKey key = ScopeNameKey(scope, name);

    DesignerMetaFlagsCache::iterator it = cache.find(key);

    if (it == cache.end()) {

        qdesigner_internal::DesignerMetaFlags dme = qdesigner_internal::DesignerMetaFlags(name, scope, me->separator());

        const int keyCount = me->keyCount();

        for (int i=0; i < keyCount; ++i)

            dme.addKey(me->value(i), me->key(i));

        it = cache.insert(key, dme);

    }

    return it.value();

}

// ------------ QDesignerMemberSheetPrivate

class QDesignerPropertySheetPrivate {

public:

    typedef QDesignerPropertySheet::PropertyType PropertyType;

    typedef QDesignerPropertySheet::ObjectType ObjectType;

    explicit QDesignerPropertySheetPrivate(QDesignerPropertySheet *sheetPublic, QObject *object, QObject *sheetParent);

    bool invalidIndex(const char *functionName, int index) const;

    inline int count() const { return m_meta->propertyCount() + m_addProperties.count(); }

    PropertyType propertyType(int index) const;

    QString transformLayoutPropertyName(int index) const;

    QLayout* layout(QDesignerPropertySheetExtension **layoutPropertySheet = 0) const;

    static ObjectType objectType(const QObject *o);

    bool isReloadableProperty(int index) const;

    bool isResourceProperty(int index) const;

    void addResourceProperty(int index, QVariant::Type type);

    QVariant resourceProperty(int index) const;

    void setResourceProperty(int index, const QVariant &value);

    QVariant emptyResourceProperty(int index) const; // of type PropertySheetPixmapValue / PropertySheetIconValue

    QVariant defaultResourceProperty(int index) const; // of type QPixmap / QIcon (maybe it can be generalized for all types, not resource only)

    bool isStringProperty(int index) const;

    void addStringProperty(int index);

    qdesigner_internal::PropertySheetStringValue stringProperty(int index) const;

    void setStringProperty(int index, const qdesigner_internal::PropertySheetStringValue &value);

    bool isKeySequenceProperty(int index) const;

    void addKeySequenceProperty(int index);

    qdesigner_internal::PropertySheetKeySequenceValue keySequenceProperty(int index) const;

    void setKeySequenceProperty(int index, const qdesigner_internal::PropertySheetKeySequenceValue &value);

    enum PropertyKind { NormalProperty, FakeProperty, DynamicProperty, DefaultDynamicProperty };

    class Info {

    public:

        Info();

        QString group;

        QVariant defaultValue;

        bool changed;

        bool visible;

        bool attribute;

        bool reset;

        PropertyType propertyType;

        PropertyKind kind;

    };

    Info &ensureInfo(int index);

    QDesignerPropertySheet *q;

    QDesignerFormEditorInterface *m_core;

    const QDesignerMetaObjectInterface *m_meta;

    const ObjectType m_objectType;

    typedef QHash<int, Info> InfoHash;

    InfoHash m_info;

    QHash<int, QVariant> m_fakeProperties;

    QHash<int, QVariant> m_addProperties;

    QHash<QString, int> m_addIndex;

    QHash<int, QVariant> m_resourceProperties; // only PropertySheetPixmapValue snd PropertySheetIconValue here

    QHash<int, qdesigner_internal::PropertySheetStringValue> m_stringProperties; // only PropertySheetStringValue

    QHash<int, qdesigner_internal::PropertySheetKeySequenceValue> m_keySequenceProperties; // only PropertySheetKeySequenceValue

    const bool m_canHaveLayoutAttributes;

    // Variables used for caching the layout, access via layout().

    QPointer<QObject> m_object;

    mutable QPointer<QLayout> m_lastLayout;

    mutable QDesignerPropertySheetExtension *m_lastLayoutPropertySheet;

    mutable bool m_LastLayoutByDesigner;

    qdesigner_internal::DesignerPixmapCache *m_pixmapCache;

    qdesigner_internal::DesignerIconCache *m_iconCache;

    QPointer<qdesigner_internal::FormWindowBase> m_fwb;

    // Enable Qt's internal properties starting with prefix "_q_"

    static bool m_internalDynamicPropertiesEnabled;

};

bool QDesignerPropertySheetPrivate::m_internalDynamicPropertiesEnabled = false;

/*

    The property is reloadable if its contents depends on resource.

*/

bool QDesignerPropertySheetPrivate::isReloadableProperty(int index) const

{

    return isResourceProperty(index)

           || propertyType(index) == QDesignerPropertySheet::PropertyStyleSheet

           || q->property(index).type() == QVariant::Url;

}

/*

    Resource properties are those which:

        1) are reloadable

        2) their state is associated with a file which can be taken from resources

        3) we don't store them in Qt meta object system (because designer keeps different data structure for them)

*/

bool QDesignerPropertySheetPrivate::isResourceProperty(int index) const

{

    return m_resourceProperties.contains(index);

}

void QDesignerPropertySheetPrivate::addResourceProperty(int index, QVariant::Type type)

{

    if (type == QVariant::Pixmap)

        m_resourceProperties.insert(index, qVariantFromValue(qdesigner_internal::PropertySheetPixmapValue()));

    else if (type == QVariant::Icon)

        m_resourceProperties.insert(index, qVariantFromValue(qdesigner_internal::PropertySheetIconValue()));

}

QVariant QDesignerPropertySheetPrivate::emptyResourceProperty(int index) const

{

    QVariant v = m_resourceProperties.value(index);

    if (qVariantCanConvert<qdesigner_internal::PropertySheetPixmapValue>(v))

        return qVariantFromValue(qdesigner_internal::PropertySheetPixmapValue());

    if (qVariantCanConvert<qdesigner_internal::PropertySheetIconValue>(v))

        return qVariantFromValue(qdesigner_internal::PropertySheetIconValue());

    return v;

}

QVariant QDesignerPropertySheetPrivate::defaultResourceProperty(int index) const

{

    return m_info.value(index).defaultValue;

}

QVariant QDesignerPropertySheetPrivate::resourceProperty(int index) const

{

    return m_resourceProperties.value(index);

}

void QDesignerPropertySheetPrivate::setResourceProperty(int index, const QVariant &value)

{

    Q_ASSERT(isResourceProperty(index));

    QVariant &v = m_resourceProperties[index];

    if ((qVariantCanConvert<qdesigner_internal::PropertySheetPixmapValue>(value) && qVariantCanConvert<qdesigner_internal::PropertySheetPixmapValue>(v))

        || (qVariantCanConvert<qdesigner_internal::PropertySheetIconValue>(value) && qVariantCanConvert<qdesigner_internal::PropertySheetIconValue>(v)))

        v = value;

}

bool QDesignerPropertySheetPrivate::isStringProperty(int index) const

{

    return m_stringProperties.contains(index);

}

void QDesignerPropertySheetPrivate::addStringProperty(int index)

{

    m_stringProperties.insert(index, qdesigner_internal::PropertySheetStringValue());

}

qdesigner_internal::PropertySheetStringValue QDesignerPropertySheetPrivate::stringProperty(int index) const

{

    return m_stringProperties.value(index);

}

void QDesignerPropertySheetPrivate::setStringProperty(int index, const qdesigner_internal::PropertySheetStringValue &value)

{

    Q_ASSERT(isStringProperty(index));

    m_stringProperties[index] = value;

}

bool QDesignerPropertySheetPrivate::isKeySequenceProperty(int index) const

{

    return m_keySequenceProperties.contains(index);

}

void QDesignerPropertySheetPrivate::addKeySequenceProperty(int index)

{

    m_keySequenceProperties.insert(index, qdesigner_internal::PropertySheetKeySequenceValue());

}

qdesigner_internal::PropertySheetKeySequenceValue QDesignerPropertySheetPrivate::keySequenceProperty(int index) const

{

    return m_keySequenceProperties.value(index);

}

void QDesignerPropertySheetPrivate::setKeySequenceProperty(int index, const qdesigner_internal::PropertySheetKeySequenceValue &value)

{

    Q_ASSERT(isKeySequenceProperty(index));

    m_keySequenceProperties[index] = value;

}

QDesignerPropertySheetPrivate::Info::Info() :

    changed(false),

    visible(true),

    attribute(false),

    reset(true),

    propertyType(QDesignerPropertySheet::PropertyNone),

    kind(NormalProperty)

{

}

QDesignerPropertySheetPrivate::QDesignerPropertySheetPrivate(QDesignerPropertySheet *sheetPublic, QObject *object, QObject *sheetParent) :

    q(sheetPublic),

    m_core(formEditorForObject(sheetParent)),

    m_meta(m_core->introspection()->metaObject(object)),

    m_objectType(QDesignerPropertySheet::objectTypeFromObject(object)),

    m_canHaveLayoutAttributes(hasLayoutAttributes(m_core, object)),

    m_object(object),

    m_lastLayout(0),

    m_lastLayoutPropertySheet(0),

    m_LastLayoutByDesigner(false),

    m_pixmapCache(0),

    m_iconCache(0)

{

}

qdesigner_internal::FormWindowBase *QDesignerPropertySheet::formWindowBase() const

{

    return d->m_fwb;

}

bool QDesignerPropertySheetPrivate::invalidIndex(const char *functionName, int index) const

{

    if (index < 0 || index >= count()) {

        qWarning() <<  "** WARNING " << functionName << " invoked for " << m_object->objectName() << " was  passed an invalid index " << index << '.';

        return true;

    }

    return false;

}

QLayout* QDesignerPropertySheetPrivate::layout(QDesignerPropertySheetExtension **layoutPropertySheet) const

{

    // Return the layout and its property sheet

    // only if it is managed by designer and not one created on a custom widget.

    // (attempt to cache the value as this requires some hoops).

    if (layoutPropertySheet)

        *layoutPropertySheet = 0;

    if (!m_object->isWidgetType() || !m_canHaveLayoutAttributes)

        return 0;

    QWidget *widget = qobject_cast<QWidget*>(m_object);

    QLayout *widgetLayout = qdesigner_internal::LayoutInfo::internalLayout(widget);

    if (!widgetLayout) {

        m_lastLayout = 0;

        m_lastLayoutPropertySheet = 0;

        return 0;

    }

    // Smart logic to avoid retrieving the meta DB from the widget every time.

    if (widgetLayout != m_lastLayout) {

        m_lastLayout = widgetLayout;

        m_LastLayoutByDesigner = false;

        m_lastLayoutPropertySheet = 0;

        // Is this a layout managed by designer or some layout on a custom widget?

        if (qdesigner_internal::LayoutInfo::managedLayout(m_core ,widgetLayout)) {

            m_LastLayoutByDesigner = true;

            m_lastLayoutPropertySheet = qt_extension<QDesignerPropertySheetExtension*>(m_core->extensionManager(), m_lastLayout);

        }

    }

    if (!m_LastLayoutByDesigner)

        return 0;

    if (layoutPropertySheet)

        *layoutPropertySheet = m_lastLayoutPropertySheet;

    return  m_lastLayout;

}

QDesignerPropertySheetPrivate::Info &QDesignerPropertySheetPrivate::ensureInfo(int index)

{

    InfoHash::iterator it = m_info.find(index);

    if (it == m_info.end())

        it = m_info.insert(index, Info());

    return it.value();

}

QDesignerPropertySheet::PropertyType QDesignerPropertySheetPrivate::propertyType(int index) const

{

    const InfoHash::const_iterator it = m_info.constFind(index);

    if (it == m_info.constEnd())

        return QDesignerPropertySheet::PropertyNone;

    return it.value().propertyType;

}

QString QDesignerPropertySheetPrivate::transformLayoutPropertyName(int index) const

{

    typedef QMap<QDesignerPropertySheet::PropertyType, QString> TypeNameMap;

    static TypeNameMap typeNameMap;

    if (typeNameMap.empty()) {

        typeNameMap.insert(QDesignerPropertySheet::PropertyLayoutObjectName, QLatin1String("objectName"));

        typeNameMap.insert(QDesignerPropertySheet::PropertyLayoutLeftMargin, QLatin1String("leftMargin"));

        typeNameMap.insert(QDesignerPropertySheet::PropertyLayoutTopMargin, QLatin1String("topMargin"));

        typeNameMap.insert(QDesignerPropertySheet::PropertyLayoutRightMargin, QLatin1String("rightMargin"));

        typeNameMap.insert(QDesignerPropertySheet::PropertyLayoutBottomMargin, QLatin1String("bottomMargin"));

        typeNameMap.insert(QDesignerPropertySheet::PropertyLayoutSpacing, QLatin1String("spacing"));

        typeNameMap.insert(QDesignerPropertySheet::PropertyLayoutHorizontalSpacing, QLatin1String("horizontalSpacing"));

        typeNameMap.insert(QDesignerPropertySheet::PropertyLayoutVerticalSpacing, QLatin1String("verticalSpacing"));

        typeNameMap.insert(QDesignerPropertySheet::PropertyLayoutSizeConstraint, QLatin1String("sizeConstraint"));

        typeNameMap.insert(QDesignerPropertySheet::PropertyLayoutFieldGrowthPolicy, QLatin1String("fieldGrowthPolicy"));

        typeNameMap.insert(QDesignerPropertySheet::PropertyLayoutRowWrapPolicy, QLatin1String("rowWrapPolicy"));

        typeNameMap.insert(QDesignerPropertySheet::PropertyLayoutLabelAlignment, QLatin1String("labelAlignment"));

        typeNameMap.insert(QDesignerPropertySheet::PropertyLayoutFormAlignment, QLatin1String("formAlignment"));

        typeNameMap.insert(QDesignerPropertySheet::PropertyLayoutBoxStretch, QLatin1String("stretch"));

        typeNameMap.insert(QDesignerPropertySheet::PropertyLayoutGridRowStretch, QLatin1String("rowStretch"));

        typeNameMap.insert(QDesignerPropertySheet::PropertyLayoutGridColumnStretch, QLatin1String("columnStretch"));

        typeNameMap.insert(QDesignerPropertySheet::PropertyLayoutGridRowMinimumHeight, QLatin1String("rowMinimumHeight"));

        typeNameMap.insert(QDesignerPropertySheet::PropertyLayoutGridColumnMinimumWidth, QLatin1String("columnMinimumWidth"));

    }

    const TypeNameMap::const_iterator it = typeNameMap.constFind(propertyType(index));

    if (it != typeNameMap.constEnd())

        return it.value();

    return QString();

}

// ----------- QDesignerPropertySheet

QDesignerPropertySheet::ObjectType QDesignerPropertySheet::objectTypeFromObject(const QObject *o)

{

    if (qobject_cast<const QLayout *>(o))

        return ObjectLayout;

    if (!o->isWidgetType())

        return ObjectNone;

    if (qobject_cast<const QLayoutWidget *>(o))

        return ObjectLayoutWidget;

    if (qobject_cast<const QLabel*>(o))

        return ObjectLabel;

    if (o->inherits("Q3GroupBox"))

        return ObjectQ3GroupBox;

    return ObjectNone;

}

QDesignerPropertySheet::PropertyType QDesignerPropertySheet::propertyTypeFromName(const QString &name)

{

    typedef QHash<QString, PropertyType> PropertyTypeHash;

    static PropertyTypeHash propertyTypeHash;

    if (propertyTypeHash.empty()) {

        propertyTypeHash.insert(QLatin1String(layoutObjectNameC),         PropertyLayoutObjectName);

        propertyTypeHash.insert(QLatin1String(layoutLeftMarginC),         PropertyLayoutLeftMargin);

        propertyTypeHash.insert(QLatin1String(layoutTopMarginC),          PropertyLayoutTopMargin);

        propertyTypeHash.insert(QLatin1String(layoutRightMarginC),        PropertyLayoutRightMargin);

        propertyTypeHash.insert(QLatin1String(layoutBottomMarginC),       PropertyLayoutBottomMargin);

        propertyTypeHash.insert(QLatin1String(layoutSpacingC),            PropertyLayoutSpacing);

        propertyTypeHash.insert(QLatin1String(layoutHorizontalSpacingC),  PropertyLayoutHorizontalSpacing);