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

**

** Copyright (C) 2009 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 "button_taskmenu.h"

#include "inplace_editor.h"

#include <qdesigner_formwindowcommand_p.h>

#include <formwindowbase_p.h>

#include <QtDesigner/QDesignerFormWindowInterface>

#include <QtDesigner/QDesignerFormWindowCursorInterface>

#include <QtDesigner/QDesignerFormEditorInterface>

#include <QtDesigner/QDesignerMetaDataBaseInterface>

#include <QtDesigner/QDesignerObjectInspectorInterface>

#include <QtDesigner/QDesignerPropertyEditorInterface>

#include <QtGui/QAction>

#include <QtGui/QActionGroup>

#include <QtGui/QMenu>

#include <QtGui/QStyle>

#include <QtGui/QStyleOption>

#include <QtGui/QAbstractButton>

#include <QtGui/QButtonGroup>

#include <QtGui/QApplication>

#include <QtCore/QDebug>

Q_DECLARE_METATYPE(QButtonGroup*)

QT_BEGIN_NAMESPACE

namespace qdesigner_internal {

enum { debugButtonMenu = 0 };

typedef QList<QAbstractButton *> ButtonList;

typedef QList<QButtonGroup *> ButtonGroupList;

// ButtonGroupCommand: Base for commands handling button groups and button lists

// addButtonsToGroup() and removeButtonsFromGroup() are low-level helpers for

// adding/removing members to/from existing groups.

//

// createButtonGroup()/breakButtonGroup() create and remove the groups from scratch.

// When using them in a command, the command must be executed within

// a macro since it makes the form emit objectRemoved() which might cause other components

// to add commands (for example, removal of signals and slots)

class ButtonGroupCommand : public QDesignerFormWindowCommand {

protected:

    ButtonGroupCommand(const QString &description, QDesignerFormWindowInterface *formWindow);

    void initialize(const ButtonList &bl, QButtonGroup *buttonGroup);

    // Helper: Add the buttons to the group

    void addButtonsToGroup();

    // Helper; Remove the buttons

    void removeButtonsFromGroup();

    // Create the button group in Designer

    void createButtonGroup();

    // Remove the button group from Designer

    void breakButtonGroup();

public:

    static QString nameList(const ButtonList& bl);

    static ButtonGroupList managedButtonGroups(const QDesignerFormWindowInterface *formWindow);

private:

    ButtonList m_buttonList;

    QButtonGroup *m_buttonGroup;

};

ButtonGroupCommand::ButtonGroupCommand(const QString &description, QDesignerFormWindowInterface *formWindow) :

    QDesignerFormWindowCommand(description, formWindow),

    m_buttonGroup(0)

{

}

void ButtonGroupCommand::initialize(const ButtonList &bl, QButtonGroup *buttonGroup)

{

    m_buttonList = bl;

    m_buttonGroup = buttonGroup;

}

void ButtonGroupCommand::addButtonsToGroup()

{

    if (debugButtonMenu)

        qDebug() << "Adding " << m_buttonList << " to " << m_buttonGroup;

    const ButtonList::const_iterator cend = m_buttonList.constEnd();

    for (ButtonList::const_iterator it = m_buttonList.constBegin(); it != cend; ++it)

        m_buttonGroup->addButton(*it);

}

void ButtonGroupCommand::removeButtonsFromGroup()

{

    if (debugButtonMenu)

        qDebug() << "Removing " << m_buttonList << " from " << m_buttonGroup;

    const ButtonList::const_iterator cend = m_buttonList.constEnd();

    for (ButtonList::const_iterator it = m_buttonList.constBegin(); it != cend; ++it)

        m_buttonGroup->removeButton(*it);

}

void ButtonGroupCommand::createButtonGroup()

{

    if (debugButtonMenu)

        qDebug() << "Creating " <<  m_buttonGroup << " from " <<  m_buttonList;

    QDesignerFormWindowInterface *fw = formWindow();

    QDesignerFormEditorInterface *core = fw->core();

    core->metaDataBase()->add(m_buttonGroup);

    addButtonsToGroup();

    // Make button group visible

    core->objectInspector()->setFormWindow(fw);

}

void ButtonGroupCommand::breakButtonGroup()

{

    if (debugButtonMenu)

        qDebug() << "Removing " <<  m_buttonGroup << " consisting of " <<  m_buttonList;

    QDesignerFormWindowInterface *fw = formWindow();

    QDesignerFormEditorInterface *core = fw->core();

    // Button group was selected, that is, break was invoked via its context menu. Remove it from property editor, select the buttons

    if (core->propertyEditor()->object() == m_buttonGroup) {

        fw->clearSelection(false);

        const ButtonList::const_iterator cend = m_buttonList.constEnd();

        for (ButtonList::const_iterator it = m_buttonList.constBegin(); it != cend; ++it)

            fw->selectWidget(*it, true);

    }

    // Now remove and refresh object inspector

    removeButtonsFromGroup();

    // Notify components (for example, signal slot editor)

    if (qdesigner_internal::FormWindowBase *fwb = qobject_cast<qdesigner_internal::FormWindowBase *>(fw))

        fwb->emitObjectRemoved(m_buttonGroup);

    core->metaDataBase()->remove(m_buttonGroup);

    core->objectInspector()->setFormWindow(fw);

}

QString ButtonGroupCommand::nameList(const ButtonList& bl)

{

    QString rc;

    const QChar quote = QLatin1Char('\'');

    const QString separator =  QLatin1String(", ");

    const int size = bl.size();

    for (int i = 0; i < size; i++) {

        if (i)

            rc += separator;

        rc += quote;

        rc += bl[i]->objectName();

        rc += quote;

    }

    return rc;

}

ButtonGroupList ButtonGroupCommand::managedButtonGroups(const QDesignerFormWindowInterface *formWindow)

{

    const QDesignerMetaDataBaseInterface *mdb = formWindow->core()->metaDataBase();

    ButtonGroupList bl;

    // Check 1st order children for managed button groups

    const QObjectList children = formWindow->mainContainer()->children();

    const QObjectList::const_iterator cend =  children.constEnd();

    for (QObjectList::const_iterator it =  children.constBegin(); it != cend; ++it) {

        if (!(*it)->isWidgetType())

            if (QButtonGroup *bg = qobject_cast<QButtonGroup *>(*it))

                if (mdb->item(bg))

                    bl.push_back(bg);

    }

    return bl;

}

// --------------- CreateButtonGroupCommand

// This command might be executed in a macro with a remove

// command to move buttons from one group to a new one.

class CreateButtonGroupCommand : public ButtonGroupCommand {

public:

    CreateButtonGroupCommand(QDesignerFormWindowInterface *formWindow);

    bool init(const ButtonList &bl);

    virtual void undo() { breakButtonGroup(); }

    virtual void redo() { createButtonGroup(); }

};

CreateButtonGroupCommand::CreateButtonGroupCommand(QDesignerFormWindowInterface *formWindow) :

    ButtonGroupCommand(QApplication::translate("Command", "Create button group"), formWindow)

{

}

bool CreateButtonGroupCommand::init(const ButtonList &bl)

{

    if (bl.empty())

        return false;

    QDesignerFormWindowInterface *fw = formWindow();

    QButtonGroup *buttonGroup = new QButtonGroup(fw->mainContainer());

    buttonGroup->setObjectName(QLatin1String("buttonGroup"));

    fw->ensureUniqueObjectName(buttonGroup);

    initialize(bl, buttonGroup);

    return true;

}

// --------------- BreakButtonGroupCommand

class BreakButtonGroupCommand : public ButtonGroupCommand {

public:

    BreakButtonGroupCommand(QDesignerFormWindowInterface *formWindow);

    bool init(QButtonGroup *group);

    virtual void undo() { createButtonGroup(); }

    virtual void redo() { breakButtonGroup(); }

};

BreakButtonGroupCommand::BreakButtonGroupCommand(QDesignerFormWindowInterface *formWindow) :

    ButtonGroupCommand(QApplication::translate("Command", "Break button group"), formWindow)

{

}

bool BreakButtonGroupCommand::init(QButtonGroup *group)

{

    if (!group)

        return false;

    initialize(group->buttons(), group);

    setText(QApplication::translate("Command", "Break button group '%1'").arg(group->objectName()));

    return true;

}

// --------------- AddButtonsToGroupCommand

// This command might be executed in a macro with a remove

// command to move buttons from one group to a new one.

class AddButtonsToGroupCommand : public ButtonGroupCommand {

public:

    AddButtonsToGroupCommand(QDesignerFormWindowInterface *formWindow);

    void init(const ButtonList &bl, QButtonGroup *group);

    virtual void undo() { removeButtonsFromGroup(); }

    virtual void redo() { addButtonsToGroup(); }

};

AddButtonsToGroupCommand::AddButtonsToGroupCommand(QDesignerFormWindowInterface *formWindow) :

    ButtonGroupCommand(QApplication::translate("Command", "Add buttons to group"), formWindow)

{

}

void AddButtonsToGroupCommand::init(const ButtonList &bl, QButtonGroup *group)

{

    initialize(bl, group);

    //: Command description for adding buttons to a QButtonGroup

    setText(QApplication::translate("Command", "Add '%1' to '%2'").arg(nameList(bl), group->objectName()));

}

//--------------------  RemoveButtonsFromGroupCommand

class RemoveButtonsFromGroupCommand : public ButtonGroupCommand {

public:

    RemoveButtonsFromGroupCommand(QDesignerFormWindowInterface *formWindow);

    bool init(const ButtonList &bl);

    virtual void undo() {  addButtonsToGroup(); }

    virtual void redo() {  removeButtonsFromGroup(); }

};

RemoveButtonsFromGroupCommand::RemoveButtonsFromGroupCommand(QDesignerFormWindowInterface *formWindow) :

    ButtonGroupCommand(QApplication::translate("Command", "Remove buttons from group"), formWindow)

{

}

bool RemoveButtonsFromGroupCommand::init(const ButtonList &bl)

{

    if (bl.empty())

        return false;

    QButtonGroup *group = bl.front()->group();

    if (!group)

        return false;

    if (bl.size() >= group->buttons().size())

        return false;

    initialize(bl, group);

    //: Command description for removing buttons from a QButtonGroup

    setText(QApplication::translate("Command", "Remove '%1' from '%2'").arg(nameList(bl), group->objectName()));

    return true;

}

// --------  ButtonGroupMenu

ButtonGroupMenu::ButtonGroupMenu(QObject *parent) :

    QObject(parent),

    m_selectGroupAction(new QAction(tr("Select members"), this)),

    m_breakGroupAction(new QAction(tr("Break"), this)),

    m_formWindow(0),

    m_buttonGroup(0),

    m_currentButton(0)

{

    connect(m_breakGroupAction, SIGNAL(triggered()), this, SLOT(breakGroup()));

    connect(m_selectGroupAction, SIGNAL(triggered()), this, SLOT(selectGroup()));

}

void ButtonGroupMenu::initialize(QDesignerFormWindowInterface *formWindow, QButtonGroup *buttonGroup, QAbstractButton *currentButton)

{

    m_buttonGroup = buttonGroup;

    m_currentButton = currentButton;

    m_formWindow = formWindow;

    Q_ASSERT(m_formWindow);

    const bool canBreak = buttonGroup != 0;

    m_breakGroupAction->setEnabled(canBreak);

    m_selectGroupAction->setEnabled(canBreak);

}

void ButtonGroupMenu::selectGroup()

{

    // Select and make current button "current" again by selecting it last (if there is any)

    const ButtonList buttons = m_buttonGroup->buttons();

    m_formWindow->clearSelection(false);

    const ButtonList::const_iterator cend = buttons.constEnd();

    for (ButtonList::const_iterator it = buttons.constBegin(); it != cend; ++it)

        if (*it != m_currentButton)

            m_formWindow->selectWidget(*it, true);

    if (m_currentButton)

        m_formWindow->selectWidget(m_currentButton, true);

}

void ButtonGroupMenu::breakGroup()

{

    BreakButtonGroupCommand *cmd = new BreakButtonGroupCommand(m_formWindow);

    if (cmd->init(m_buttonGroup)) {

        // Need a macro since the command might trigger additional commands

        QUndoStack *history = m_formWindow->commandHistory();

        history->beginMacro(cmd->text());

        history->push(cmd);

        history->endMacro();

    } else {

        qWarning("** WARNING Failed to initialize BreakButtonGroupCommand!");

        delete cmd;

    }

}

// ButtonGroupTaskMenu

ButtonGroupTaskMenu::ButtonGroupTaskMenu(QButtonGroup *buttonGroup, QObject *parent) :

    QObject(parent),

    m_buttonGroup(buttonGroup)

{

    m_taskActions.push_back(m_menu.breakGroupAction());

    m_taskActions.push_back(m_menu.selectGroupAction());

}

QAction *ButtonGroupTaskMenu::preferredEditAction() const

{

    return m_menu.selectGroupAction();

}

QList<QAction*> ButtonGroupTaskMenu::taskActions() const

{

    m_menu.initialize(QDesignerFormWindowInterface::findFormWindow(m_buttonGroup), m_buttonGroup);

    return m_taskActions;

}

// -------- Text area editor

class ButtonTextTaskMenuInlineEditor : public  TaskMenuInlineEditor

{

public:

    ButtonTextTaskMenuInlineEditor(QAbstractButton *button, QObject *parent);

protected:

    virtual QRect editRectangle() const;

};

ButtonTextTaskMenuInlineEditor::ButtonTextTaskMenuInlineEditor(QAbstractButton *button, QObject *parent) :

      TaskMenuInlineEditor(button, ValidationMultiLine, QLatin1String("text"), parent)

{

}

QRect ButtonTextTaskMenuInlineEditor::editRectangle() const

{

    QWidget *w = widget();

    QStyleOptionButton opt;

    opt.init(w);

    return w->style()->subElementRect(QStyle::SE_PushButtonContents, &opt, w);

}

// -------- Command link button description editor

class LinkDescriptionTaskMenuInlineEditor : public  TaskMenuInlineEditor

{

public:

    LinkDescriptionTaskMenuInlineEditor(QAbstractButton *button, QObject *parent);

protected:

    virtual QRect editRectangle() const;

};

LinkDescriptionTaskMenuInlineEditor::LinkDescriptionTaskMenuInlineEditor(QAbstractButton *button, QObject *parent) :

      TaskMenuInlineEditor(button, ValidationMultiLine, QLatin1String("description"), parent)

{

}

QRect LinkDescriptionTaskMenuInlineEditor::editRectangle() const

{

    QWidget *w = widget(); // TODO: What is the exact description area?

    QStyleOptionButton opt;

    opt.init(w);

    return w->style()->subElementRect(QStyle::SE_PushButtonContents, &opt, w);

}

// ----------- ButtonTaskMenu:

ButtonTaskMenu::ButtonTaskMenu(QAbstractButton *button, QObject *parent)  :

    QDesignerTaskMenu(button, parent),

    m_assignGroupSubMenu(new QMenu),

    m_assignActionGroup(0),

    m_assignToGroupSubMenuAction(new QAction(tr("Assign to button group"), this)),

    m_currentGroupSubMenu(new QMenu),

    m_currentGroupSubMenuAction(new QAction(tr("Button group"), this)),

    m_createGroupAction(new QAction(tr("New button group"), this)),

    m_preferredEditAction(new QAction(tr("Change text..."), this)),

    m_removeFromGroupAction(new QAction(tr("None"), this))

{

    connect(m_createGroupAction, SIGNAL(triggered()), this, SLOT(createGroup()));

    TaskMenuInlineEditor *textEditor = new ButtonTextTaskMenuInlineEditor(button, this);

    connect(m_preferredEditAction, SIGNAL(triggered()), textEditor, SLOT(editText()));

    connect(m_removeFromGroupAction, SIGNAL(triggered()), this, SLOT(removeFromGroup()));

    m_assignToGroupSubMenuAction->setMenu(m_assignGroupSubMenu);

    m_currentGroupSubMenu->addAction(m_groupMenu.breakGroupAction());

    m_currentGroupSubMenu->addAction(m_groupMenu.selectGroupAction());

    m_currentGroupSubMenuAction->setMenu(m_currentGroupSubMenu);

    m_taskActions.append(m_preferredEditAction);

    m_taskActions.append(m_assignToGroupSubMenuAction);

    m_taskActions.append(m_currentGroupSubMenuAction);

    m_taskActions.append(createSeparator());

}

ButtonTaskMenu::~ButtonTaskMenu()

{

    delete m_assignGroupSubMenu;

    delete m_currentGroupSubMenu;

}

QAction *ButtonTaskMenu::preferredEditAction() const

{

    return m_preferredEditAction;

}

bool ButtonTaskMenu::refreshAssignMenu(const QDesignerFormWindowInterface *fw, int buttonCount, SelectionType st, QButtonGroup *currentGroup)

{

    // clear

    if (m_assignActionGroup) {

        delete m_assignActionGroup;

        m_assignActionGroup = 0;

    }

    m_assignGroupSubMenu->clear();

    if (st == OtherSelection)

        return false;

    // Assign to new: Need several

    const bool canAssignToNewGroup = buttonCount > 1;

    m_createGroupAction->setEnabled(canAssignToNewGroup);

    if (canAssignToNewGroup)

        m_assignGroupSubMenu->addAction(m_createGroupAction);

    // Assign to other

    const ButtonGroupList bl = ButtonGroupCommand::managedButtonGroups(fw);

    // Groups: Any groups to add to except the current?

    const int groupCount = bl.size();

    const bool hasAddGroups = groupCount > 1 || (groupCount == 1 && !bl.contains(currentGroup));

    if (hasAddGroups) {

        if (!m_assignGroupSubMenu->isEmpty())

            m_assignGroupSubMenu->addSeparator();

        // Create a new action group

        m_assignActionGroup = new QActionGroup(this);

        connect(m_assignActionGroup, SIGNAL(triggered(QAction*)), this, SLOT(addToGroup(QAction*)));

        const ButtonGroupList::const_iterator cend = bl.constEnd();

        for (ButtonGroupList::const_iterator it = bl.constBegin(); it != cend; ++it) {

            QButtonGroup *bg = *it;

            if (*it != currentGroup) {

                QAction *a = new QAction(bg->objectName(), m_assignGroupSubMenu);

                a->setData(qVariantFromValue(bg));

                m_assignActionGroup->addAction(a);

                m_assignGroupSubMenu->addAction(a);

            }

        }

    }

    // Can remove: A homogenous selection of another group that does not completely break it.

    const bool canRemoveFromGroup = st == GroupedButtonSelection;

    m_removeFromGroupAction->setEnabled(canRemoveFromGroup);

    if (canRemoveFromGroup) {

        if (!m_assignGroupSubMenu->isEmpty())

            m_assignGroupSubMenu->addSeparator();

        m_assignGroupSubMenu->addAction(m_removeFromGroupAction);

    }

    return !m_assignGroupSubMenu->isEmpty();

}

QList<QAction*> ButtonTaskMenu::taskActions() const