plasma-workspace/libtaskmanager/taskgroup.cpp

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

Copyright 2008 Christian Mollekopf <chrigi_1@hotmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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

// Own
#include "taskgroup.h"
#include "taskmanager.h"
#include "taskitem.h"
#include "groupmanager.h"

// Qt
#include <QtCore/QMimeData>
#include <QtCore/QTimer>

// KDE

namespace TaskManager
{


class TaskGroup::Private
{
public:
    Private(TaskGroup *group, GroupManager *manager)
        : q(group),
          groupIcon(QIcon::fromTheme("xorg")),
          groupManager(manager)
    {
    }

    void itemDestroyed(AbstractGroupableItem *item);
    void itemChanged(::TaskManager::TaskChanges changes);
    void signalRemovals();

    TaskGroup *q;
    QList<AbstractGroupableItem *> signalRemovalsFor;
    ItemList members;
    QString groupName;
    QIcon groupIcon;
    GroupManager *groupManager;
};

TaskGroup::TaskGroup(GroupManager *parent, const QString &name)
    :   AbstractGroupableItem(parent),
        d(new Private(this, parent))
{
    d->groupName = name;
    //qDebug() << "Group Created: Name: " << d->groupName;
}

TaskGroup::TaskGroup(GroupManager *parent)
    :   AbstractGroupableItem(parent),
        d(new Private(this, parent))
{
    //qDebug() << "Group Created: Name: " << d->groupName;
}


TaskGroup::~TaskGroup()
{
    emit destroyed(this);
    delete d;
}

WindowList TaskGroup::winIds() const
{
//     qDebug() << name() << d->members.size();
    if (d->members.isEmpty()) {
//         qDebug() << "empty group: " << name();
    }
    WindowList ids;
    foreach (AbstractGroupableItem * groupable, d->members) {
        ids += groupable->winIds();
    }
//     qDebug() << ids.size();
    return ids;
}

//TODO unused
WindowList TaskGroup::directMemberwinIds() const
{
    WindowList ids;
    foreach (AbstractGroupableItem * groupable, d->members) {
        if (groupable->itemType() != GroupItemType) {
            ids += groupable->winIds();
        }
    }
    return ids;
}

AbstractGroupableItem *TaskGroup::getMemberByWId(WId id)
{
    foreach (AbstractGroupableItem * groupable, d->members) {
        if (groupable->itemType() == GroupItemType) {
            AbstractGroupableItem *item = static_cast<TaskGroup*>(groupable)->getMemberByWId(id);
            if (item) {
                return item;
            }
        } else {
            if (groupable->winIds().isEmpty()) {
                continue;
            }
            if (groupable->winIds().values().first() == id) {
                return groupable;
            }
        }
    }
    //qDebug() << "item not found";
    return 0;
}

AbstractGroupableItem *TaskGroup::getMemberById(int id)
{
    foreach (AbstractGroupableItem * groupable, d->members) {
        if (groupable->id() == id) {
            return groupable;
        } else {
            if (groupable->itemType() == GroupItemType) {
                AbstractGroupableItem *item = static_cast<TaskGroup*>(groupable)->getMemberById(id);
                if (item) {
                    return item;
                }
            }
        }
    }
    //qDebug() << "item not found";
    return 0;
}

//including subgroups
int TaskGroup::totalSize()
{
    int size = 0;
    foreach (AbstractGroupableItem * groupable, d->members) {
        if (groupable->itemType() == GroupItemType) {
            size += static_cast<TaskGroup*>(groupable)->totalSize();
        } else {
            size++;
        }
    }
    return size;
}

void TaskGroup::add(AbstractGroupableItem *item, int insertIndex)
{
    /*    if (!item->itemType() == GroupItemType) {
            if ((dynamic_cast<TaskItem*>(item))->task()) {
                qDebug() << "Add item" << (dynamic_cast<TaskItem*>(item))->task()->visibleName();
            }
            qDebug() << " to Group " << name();
        }
    */
    if (!item) {
//         qDebug() << "invalid item";
        return;
    }

    if (d->members.contains(item)) {
        //qDebug() << "already in this group";
        return;
    }

    if (d->groupName.isEmpty()) {
        TaskItem *taskItem = qobject_cast<TaskItem*>(item);
        if (taskItem) {
            d->groupName = taskItem->taskName();
        }
    }

    if (item->parentGroup()) {
        item->parentGroup()->remove(item);
    } else if (item->itemType() == GroupItemType) {
        TaskGroup *group = static_cast<TaskGroup*>(item);
        if (group) {
            foreach (AbstractGroupableItem * subItem, group->members()) {
                connect(subItem, SIGNAL(changed(::TaskManager::TaskChanges)),
                        item, SLOT(itemChanged(::TaskManager::TaskChanges)), Qt::UniqueConnection);
            }
        }
    }

    int index = insertIndex;

    if (index < 0) {
        index = d->members.count();
        if (d->groupManager->separateLaunchers()) {
            if (item->itemType() == LauncherItemType) {
                QUrl lUrl = item->launcherUrl();

                int maxIndex = d->groupManager->launcherIndex(lUrl);

                if (maxIndex < 0 || maxIndex >= d->members.count()) {
                    maxIndex = d->members.count() - 1;
                }

                for (index = 0; index < maxIndex; ++index) {
                    if (d->members.at(index)->itemType() != LauncherItemType) {
                        break;
                    }
                }
            }
        } else {
            QUrl lUrl = item->launcherUrl();
            int urlIdx = d->groupManager->launcherIndex(lUrl);
            if (urlIdx >= 0) {
                for (index = 0; index < d->members.count(); ++index) {
                    int idx = d->groupManager->launcherIndex(d->members.at(index)->launcherUrl());
                    if (urlIdx < idx || idx < 0) {
                        break;
                    }
                }
            }
        }
    }

    item->setParentGroup(this);
    emit itemAboutToBeAdded(item, index);
    d->members.insert(index, item);


    connect(item, SIGNAL(destroyed(AbstractGroupableItem*)),
            this, SLOT(itemDestroyed(AbstractGroupableItem*)));
    //if the item will gain a parent those connections will be added by the if up there
    if (!isRootGroup()) {
        connect(item, SIGNAL(changed(::TaskManager::TaskChanges)),
                this, SLOT(itemChanged(::TaskManager::TaskChanges)));
    }

    //For debug
    /* foreach (AbstractGroupableItem *item, d->members) {
         if (item->itemType() == GroupItemType) {
             qDebug() << (dynamic_cast<TaskGroup*>(item))->name();
         } else {
             qDebug() << (dynamic_cast<TaskItem*>(item))->task()->visibleName();
         }
     }*/
    emit itemAdded(item);
}

void TaskGroup::Private::itemDestroyed(AbstractGroupableItem *item)
{
    emit q->itemAboutToBeRemoved(item);
    members.removeAll(item);
    signalRemovalsFor << item;
    QTimer::singleShot(0, q, SLOT(signalRemovals()));
}

void TaskGroup::Private::signalRemovals()
{
    // signal removals for is full of dangling pointers. do not use them!
    foreach (AbstractGroupableItem * item, signalRemovalsFor) {
        emit q->itemRemoved(item);
    }

    signalRemovalsFor.clear();
}

void TaskGroup::Private::itemChanged(::TaskManager::TaskChanges changes)
{
    if (q->manager()->forceGrouping()) {
        emit q->changed(changes);
        return;
    }

    if (changes & ::TaskManager::IconChanged) {
        emit q->checkIcon(q);
    }

    if (changes & StateChanged) {
        emit q->changed(StateChanged);
    }
}

void TaskGroup::remove(AbstractGroupableItem *item)
{
    Q_ASSERT(item);

    /*
    if (item->itemType() == GroupItemType) {
        qDebug() << "Remove group" << (dynamic_cast<TaskGroup*>(item))->name();
    } else if ((dynamic_cast<TaskItem*>(item))->task()) {
        qDebug() << "Remove item" << (dynamic_cast<TaskItem*>(item))->task()->visibleName();
    }
    qDebug() << "from Group: " << name();
    */

    /* qDebug() << "GroupMembers: ";
     foreach (AbstractGroupableItem *item, d->members) {
         if (item->itemType() == GroupItemType) {
             qDebug() << (dynamic_cast<TaskGroup*>(item))->name();
         } else {
             qDebug() << (dynamic_cast<TaskItem*>(item))->task()->visibleName();
         }
     }*/

    if (!d->members.contains(item)) {
//         qDebug() << "couldn't find item";
        return;
    }

    emit itemAboutToBeRemoved(item);
    disconnect(item, 0, this, 0);

    d->members.removeAll(item);
    item->setParentGroup(0);
    /*if (d->members.isEmpty()) {
        qDebug() << "empty";
        emit empty(this);
    }*/

    emit itemRemoved(item);
}

void TaskGroup::clear()
{
    ItemList copy = d->members;

    foreach (AbstractGroupableItem * ai, copy) {
        if (qobject_cast<TaskGroup *>(ai)) {
            static_cast<TaskGroup *>(ai)->clear();
        }
        remove(ai);
    }
}

GroupManager *TaskGroup::manager() const
{
    return d->groupManager;
}

ItemList TaskGroup::members() const
{
    return d->members;
}

QString TaskGroup::name() const
{
    return d->groupName;
}

void TaskGroup::setName(const QString &newName)
{
    d->groupName = newName;
    emit changed(NameChanged);
}

QIcon TaskGroup::icon() const
{
    return d->groupIcon;
}

void TaskGroup::setIcon(const QIcon &newIcon)
{
    d->groupIcon = newIcon;
    emit changed(IconChanged);
}

ItemType TaskGroup::itemType() const
{
    return GroupItemType;
}

bool TaskGroup::isGroupItem() const
{
    return true;
}

bool TaskGroup::isRootGroup() const
{
    return !parentGroup();
}

/** only true if item is in this group */
bool TaskGroup::hasDirectMember(AbstractGroupableItem *item) const
{
    return d->members.contains(item);
}

/** true if item is in this or any sub group */
bool TaskGroup::hasMember(AbstractGroupableItem *item) const
{
    //qDebug();
    TaskGroup *group = item->parentGroup();
    while (group) {
        if (group == this) {
            return true;
        }
        group = group->parentGroup();
    }
    return false;
}

/** Returns Direct Member group if the passed item is in a subgroup */
AbstractGroupableItem *TaskGroup::directMember(AbstractGroupableItem *item) const
{
    AbstractGroupableItem *tempItem = item;
    while (tempItem) {
        if (d->members.contains(item)) {
            return item;
        }
        tempItem = tempItem->parentGroup();
    }

//     qDebug() << "item not found";
    return 0;
}

void TaskGroup::setShaded(bool state)
{
    foreach (AbstractGroupableItem * item, d->members) {
        item->setShaded(state);
    }
}

void TaskGroup::toggleShaded()
{
    setShaded(!isShaded());
}

bool TaskGroup::isShaded() const
{
    foreach (AbstractGroupableItem * item, d->members) {
        if (!item->isShaded()) {
            return false;
        }
    }
    return true;
}

void TaskGroup::toDesktop(int desk)
{
    foreach (AbstractGroupableItem * item, d->members) {
        item->toDesktop(desk);
    }
    emit movedToDesktop(desk);
}

bool TaskGroup::isOnCurrentDesktop() const
{
    foreach (AbstractGroupableItem * item, d->members) {
        if (!item->isOnCurrentDesktop()) {
            return false;
        }
    }
    return true;
}

void TaskGroup::addMimeData(QMimeData *mimeData) const
{
    //qDebug() << d->members.count();
    if (d->members.isEmpty()) {
        return;
    }

    QByteArray data;
    WindowList ids = winIds();
    int count = ids.count();
    data.resize(sizeof(int) + sizeof(WId) * count);
    memcpy(data.data(), &count, sizeof(int));
    int i = 0;
    foreach (WId id, ids) {
        //qDebug() << "adding" << id;
        memcpy(data.data() + sizeof(int) + sizeof(WId) * i, &id, sizeof(WId));
        ++i;
    }

    //qDebug() << "done:" << data.size() << count;
    mimeData->setData(Task::groupMimetype(), data);
}

QUrl TaskGroup::launcherUrl() const
{
    // Strategy: try to return the first non-group item's launcherUrl,
    // failing that, try to return the  launcherUrl of the first group
    // if any
    foreach (AbstractGroupableItem * item, d->members) {
        if (item->itemType() != GroupItemType) {
            return item->launcherUrl();
        }
    }

    if (d->members.isEmpty()) {
        return QUrl();
    }

    return d->members.first()->launcherUrl();
}

bool TaskGroup::isOnAllDesktops() const
{
    foreach (AbstractGroupableItem * item, d->members) {
        if (!item->isOnAllDesktops()) {
            return false;
        }
    }
    return true;
}

//return 0 if tasks are on different desktops or on all dektops
int TaskGroup::desktop() const
{
    if (d->members.isEmpty()) {
        return 0;
    }

    if (KWindowSystem::numberOfDesktops() < 2) {
        return 0;
    }

    int desk = d->members.first()->desktop();
    foreach (AbstractGroupableItem * item, d->members) {
        if (item->desktop() != desk) {
            return 0;
        }
    }
    return desk;
}

void TaskGroup::setMaximized(bool state)
{
    foreach (AbstractGroupableItem * item, d->members) {
        item->setMaximized(state);
    }
}

void TaskGroup::toggleMaximized()
{
    setMaximized(!isMaximized());
}

bool TaskGroup::isMaximized() const
{
    foreach (AbstractGroupableItem * item, d->members) {
        if (!item->isMaximized()) {
            return false;
        }
    }
    return true;
}

void TaskGroup::setMinimized(bool state)
{
    foreach (AbstractGroupableItem * item, d->members) {
        item->setMinimized(state);
    }
}

void TaskGroup::toggleMinimized()
{
    setMinimized(!isMinimized());
}

bool TaskGroup::isMinimized() const
{
    foreach (AbstractGroupableItem * item, d->members) {
        if (!item->isMinimized()) {
            return false;
        }
    }
    return true;
}

void TaskGroup::setFullScreen(bool state)
{
    foreach (AbstractGroupableItem * item, d->members) {
        item->setFullScreen(state);
    }
}

void TaskGroup::toggleFullScreen()
{
    setFullScreen(!isFullScreen());
}

bool TaskGroup::isFullScreen() const
{
    foreach (AbstractGroupableItem * item, d->members) {
        if (!item->isFullScreen()) {
            return false;
        }
    }
    return true;
}

void TaskGroup::setKeptBelowOthers(bool state)
{
    foreach (AbstractGroupableItem * item, d->members) {
        item->setKeptBelowOthers(state);
    }
}

void TaskGroup::toggleKeptBelowOthers()
{
    setKeptBelowOthers(!isKeptBelowOthers());
}

bool TaskGroup::isKeptBelowOthers() const
{
    foreach (AbstractGroupableItem * item, d->members) {
        if (!item->isKeptBelowOthers()) {
            return false;
        }
    }
    return true;
}

void TaskGroup::setAlwaysOnTop(bool state)
{
    foreach (AbstractGroupableItem * item, d->members) {
        item->setAlwaysOnTop(state);
    }
}

void TaskGroup::toggleAlwaysOnTop()
{
    setAlwaysOnTop(!isAlwaysOnTop());
}

bool TaskGroup::isAlwaysOnTop() const
{
    foreach (AbstractGroupableItem * item, d->members) {
        if (!item->isAlwaysOnTop()) {
            return false;
        }
    }
    return true;
}

bool TaskGroup::isActionSupported(NET::Action action) const
{
    if (KWindowSystem::allowedActionsSupported()) {
        foreach (AbstractGroupableItem * item, d->members) {
            if (!item->isActionSupported(action)) {
                return false;
            }
        }
        return true;
    }
    return false;
}

void TaskGroup::close()
{
    foreach (AbstractGroupableItem * item, d->members) {
        item->close();
    }
}

bool TaskGroup::isActive() const
{
    foreach (AbstractGroupableItem * item, d->members) {
        if (item->isActive()) {
            return true;
        }
    }

    return false;
}

bool TaskGroup::demandsAttention() const
{
    foreach (AbstractGroupableItem * item, d->members) {
        if (item->demandsAttention()) {
            return true;
        }
    }

    return false;
}

bool TaskGroup::moveItem(int oldIndex, int newIndex)
{
    //qDebug() << oldIndex << newIndex;
    if ((d->members.count() <= newIndex) || (newIndex < 0) ||
            (d->members.count() <= oldIndex || oldIndex < 0)) {
//         qDebug() << "index out of bounds";
        return false;
    }

    AbstractGroupableItem *item = d->members.at(oldIndex);
    emit itemAboutToMove(item, oldIndex, newIndex);
    d->members.move(oldIndex, newIndex);
    emit itemPositionChanged(item);
    return true;
}

} // TaskManager namespace

#include "moc_taskgroup.cpp"