kwin/tabbox/clientmodel.cpp
Martin Gräßlin bd7958392d Verify pointer is valid when calculating the longest caption
The method was missing a check whether the weak pointers in the
internal list got deleted. This could in very unlikely cases
lead to a crash.

In order to verify that adding the null pointer check fixes the
crash a unit test is added to simulate the situation of a
pointer being deleted. This required to add a mock a few
classes of TabBox. A MockTabBoxHandler and MockTabBoxClient are
added implementing the specific interfaces. The DeclarativeView
is completely mocked to make the linker happy. Including the
actual implementation is not possible as it pulls in half of
KWin core.

BUG: 303840
FIXED-IN: 4.9.0
REVIEW: 105645
2012-07-22 19:23:36 +02:00

276 lines
7.8 KiB
C++

/********************************************************************
KWin - the KDE window manager
This file is part of the KDE project.
Copyright (C) 2009 Martin Gräßlin <kde@martin-graesslin.com>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*********************************************************************/
// own
#include "clientmodel.h"
// tabbox
#include "tabboxconfig.h"
#include "tabboxhandler.h"
// Qt
#include <QTextStream>
// KDE
#include <KLocale>
// other
#include <math.h>
namespace KWin
{
namespace TabBox
{
ClientModel::ClientModel(QObject* parent)
: QAbstractItemModel(parent)
{
QHash<int, QByteArray> roles;
roles[CaptionRole] = "caption";
roles[DesktopNameRole] = "desktopName";
roles[MinimizedRole] = "minimized";
roles[WIdRole] = "windowId";
roles[CloseableRole] = "closeable";
setRoleNames(roles);
}
ClientModel::~ClientModel()
{
}
QVariant ClientModel::data(const QModelIndex& index, int role) const
{
if (!index.isValid())
return QVariant();
if (m_clientList.isEmpty()) {
return QVariant();
}
int clientIndex = index.row() * columnCount() + index.column();
if (clientIndex >= m_clientList.count())
return QVariant();
QSharedPointer<TabBoxClient> client = m_clientList[ clientIndex ].toStrongRef();
if (!client) {
return QVariant();
}
switch(role) {
case Qt::DisplayRole:
case CaptionRole:
return client->caption();
case ClientRole:
return qVariantFromValue((void*)client.data());
case DesktopNameRole: {
return tabBox->desktopName(client.data());
}
case WIdRole:
return qulonglong(client->window());
case MinimizedRole:
return client->isMinimized();
case CloseableRole:
//clients that claim to be first are not closeable
return client->isCloseable() && !client->isFirstInTabBox();
default:
return QVariant();
}
}
QString ClientModel::longestCaption() const
{
QString caption;
foreach (QWeakPointer<TabBoxClient> clientPointer, m_clientList) {
QSharedPointer<TabBoxClient> client = clientPointer.toStrongRef();
if (!client) {
continue;
}
if (client->caption().size() > caption.size()) {
caption = client->caption();
}
}
return caption;
}
int ClientModel::columnCount(const QModelIndex& parent) const
{
Q_UNUSED(parent)
int count = 1;
switch(tabBox->config().layout()) {
case TabBoxConfig::HorizontalLayout:
count = m_clientList.count();
break;
case TabBoxConfig::VerticalLayout:
count = 1;
break;
case TabBoxConfig::HorizontalVerticalLayout:
count = qRound(sqrt(float(m_clientList.count())));
if (count * count < m_clientList.count())
count++;
break;
}
return qMax(count, 1);
}
int ClientModel::rowCount(const QModelIndex& parent) const
{
Q_UNUSED(parent)
int count = 1;
switch(tabBox->config().layout()) {
case TabBoxConfig::HorizontalLayout:
count = 1;
break;
case TabBoxConfig::VerticalLayout:
count = m_clientList.count();
break;
case TabBoxConfig::HorizontalVerticalLayout:
count = qRound(sqrt(float(m_clientList.count())));
break;
}
return qMax(count, 1);
}
QModelIndex ClientModel::parent(const QModelIndex& child) const
{
Q_UNUSED(child)
return QModelIndex();
}
QModelIndex ClientModel::index(int row, int column, const QModelIndex& parent) const
{
Q_UNUSED(parent)
int index = row * columnCount() + column;
if (index >= m_clientList.count() && !m_clientList.isEmpty())
return QModelIndex();
return createIndex(row, column);
}
QModelIndex ClientModel::index(QWeakPointer<TabBoxClient> client) const
{
if (!m_clientList.contains(client))
return QModelIndex();
int index = m_clientList.indexOf(client);
int row = index / columnCount();
int column = index % columnCount();
return createIndex(row, column);
}
void ClientModel::createClientList(bool partialReset)
{
createClientList(tabBox->currentDesktop(), partialReset);
}
void ClientModel::createClientList(int desktop, bool partialReset)
{
TabBoxClient* start = tabBox->activeClient().toStrongRef().data();
// TODO: new clients are not added at correct position
if (partialReset && !m_clientList.isEmpty()) {
QSharedPointer<TabBoxClient> firstClient = m_clientList.first().toStrongRef();
if (firstClient) {
start = firstClient.data();
}
}
m_clientList.clear();
QList< QWeakPointer< TabBoxClient > > stickyClients;
switch(tabBox->config().clientSwitchingMode()) {
case TabBoxConfig::FocusChainSwitching: {
TabBoxClient* c = tabBox->nextClientFocusChain(start).data();
TabBoxClient* stop = c;
while (c) {
QWeakPointer<TabBoxClient> add = tabBox->clientToAddToList(c, desktop);
if (!add.isNull()) {
if (start == add.data()) {
m_clientList.removeAll(add);
m_clientList.prepend(add);
} else
m_clientList += add;
if (add.data()->isFirstInTabBox()) {
stickyClients << add;
}
}
c = tabBox->nextClientFocusChain(c).data();
if (c == stop)
break;
}
break;
}
case TabBoxConfig::StackingOrderSwitching: {
// TODO: needs improvement
TabBoxClientList stacking = tabBox->stackingOrder();
TabBoxClient* c = stacking.first().data();
TabBoxClient* stop = c;
int index = 0;
while (c) {
QWeakPointer<TabBoxClient> add = tabBox->clientToAddToList(c, desktop);
if (!add.isNull()) {
if (start == add.data()) {
m_clientList.removeAll(add);
m_clientList.prepend(add);
} else
m_clientList += add;
if (add.data()->isFirstInTabBox()) {
stickyClients << add;
}
}
if (index >= stacking.size() - 1) {
c = NULL;
} else {
c = stacking[++index].data();
}
if (c == stop)
break;
}
break;
}
}
foreach (QWeakPointer< TabBoxClient > c, stickyClients) {
m_clientList.removeAll(c);
m_clientList.prepend(c);
}
if (tabBox->config().showDesktopMode() == TabBoxConfig::ShowDesktopClient || m_clientList.isEmpty()) {
QWeakPointer<TabBoxClient> desktopClient = tabBox->desktopClient();
if (!desktopClient.isNull())
m_clientList.append(desktopClient);
}
reset();
}
void ClientModel::close(int i)
{
QModelIndex ind = index(i, 0);
if (!ind.isValid()) {
return;
}
QSharedPointer<TabBoxClient> client = m_clientList.at(i).toStrongRef();
if (client) {
client->close();
}
}
void ClientModel::activate(int i)
{
QModelIndex ind = index(i, 0);
if (!ind.isValid()) {
return;
}
tabBox->setCurrentIndex(ind);
tabBox->activateAndClose();
}
} // namespace Tabbox
} // namespace KWin