kwin/libkdecorations/kdecoration.cpp

/*****************************************************************
This file is part of the KDE project.

Copyright (C) 2003 Lubos Lunak <l.lunak@kde.org>

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 OR COPYRIGHT HOLDERS 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.
******************************************************************/

#include "kdecoration.h"
#include "kdecoration_p.h"

#include <QApplication>
#include <QMenu>
#include <QWindow>
#include <KConfigGroup>
#include <assert.h>
#include <X11/Xlib.h>
#include <fixx11h.h>

#include "kdecorationfactory.h"
#include "kdecorationbridge.h"


/*

Extending KDecoration:
======================

If KDecoration will ever need to be extended in a way that'd break binary compatibility
(i.e. adding new virtual methods most probably), new class KDecoration2 should be
inherited from KDecoration and those methods added there. Code that would depend
on the new functionality could then dynamic_cast<> to KDecoration2 to check whether
it is available and use it.

KCommonDecoration would have to be extended the same way, adding KCommonDecoration2
inheriting KCommonDecoration and adding the new API matching KDecoration2.

*/

class KDecorationPrivate
{
public:
    KDecorationPrivate(KDecorationBridge *b, KDecorationFactory *f)
        : bridge(b)
        , factory(f)
        , alphaEnabled(false)
        , w()
        , window()
    {
    }
    KDecorationBridge *bridge;
    KDecorationFactory *factory;
    bool alphaEnabled;
    QScopedPointer<QWidget> w;
    QScopedPointer<QWindow> window;
};

KDecoration::KDecoration(KDecorationBridge* bridge, KDecorationFactory* factory)
    :   d(new KDecorationPrivate(bridge, factory))
{
    factory->addDecoration(this);
    connect(this, static_cast<void (KDecoration::*)(bool)>(&KDecoration::keepAboveChanged),
            this, static_cast<void (KDecoration::*)()>(&KDecoration::keepAboveChanged));
    connect(this, static_cast<void (KDecoration::*)(bool)>(&KDecoration::keepBelowChanged),
            this, static_cast<void (KDecoration::*)()>(&KDecoration::keepBelowChanged));
}

KDecoration::~KDecoration()
{
    factory()->removeDecoration(this);
    delete d;
}

const KDecorationOptions* KDecoration::options()
{
    return KDecorationOptions::self();
}

void KDecoration::createMainWidget(Qt::WindowFlags flags)
{
    // FRAME check flags?
    QWidget *w = new QWidget(nullptr, initialWFlags() | flags);
    w->setObjectName(QLatin1String("decoration widget"));
    if (options()->showTooltips())
        w->setAttribute(Qt::WA_AlwaysShowToolTips);
    setMainWidget(w);
}

void KDecoration::setMainWidget(QWidget* w)
{
    assert(d->w.isNull());
    d->w.reset(w);
    w->setMouseTracking(true);
    widget()->resize(geometry().size());
}

void KDecoration::setMainWindow(QWindow *window)
{
    assert(d->window.isNull());
    d->window.reset(window);
    d->window->resize(geometry().size());
}

Qt::WindowFlags KDecoration::initialWFlags() const
{
    return d->bridge->initialWFlags();
}

void KDecoration::show()
{
    if (!d->w.isNull()) {
        d->w->show();
    } else if (!d->window.isNull()) {
        d->window->show();
    }
}

void KDecoration::hide()
{
    if (!d->w.isNull()) {
        d->w->hide();
    } else if (!d->window.isNull()) {
        d->window->hide();
    }
}

QRect KDecoration::rect() const
{
    if (!d->w.isNull()) {
        return d->w->rect();
    } else if (!d->window.isNull()) {
        return QRect(QPoint(0, 0), d->window->size());
    }
    return QRect();
}

bool KDecoration::isActive() const
{
    return d->bridge->isActive();
}

bool KDecoration::isCloseable() const
{
    return d->bridge->isCloseable();
}

bool KDecoration::isMaximizable() const
{
    return d->bridge->isMaximizable();
}

KDecoration::MaximizeMode KDecoration::maximizeMode() const
{
    return d->bridge->maximizeMode();
}

bool KDecoration::isMaximized() const
{
    return maximizeMode() == MaximizeFull;
}

KDecoration::QuickTileMode KDecoration::quickTileMode() const
{
    return d->bridge->quickTileMode();
}

bool KDecoration::isMinimizable() const
{
    return d->bridge->isMinimizable();
}

bool KDecoration::providesContextHelp() const
{
    return d->bridge->providesContextHelp();
}

int KDecoration::desktop() const
{
    return d->bridge->desktop();
}

bool KDecoration::isModal() const
{
    return d->bridge->isModal();
}

bool KDecoration::isShadeable() const
{
    return d->bridge->isShadeable();
}

bool KDecoration::isShade() const
{
    return d->bridge->isShade();
}

bool KDecoration::isSetShade() const
{
    return d->bridge->isSetShade();
}

bool KDecoration::keepAbove() const
{
    return d->bridge->keepAbove();
}

bool KDecoration::keepBelow() const
{
    return d->bridge->keepBelow();
}

bool KDecoration::isMovable() const
{
    return d->bridge->isMovable();
}

bool KDecoration::isResizable() const
{
    return d->bridge->isResizable();
}

NET::WindowType KDecoration::windowType(unsigned long supported_types) const
{
    // this one is also duplicated in KDecorationFactory
    return d->bridge->windowType(supported_types);
}

QIcon KDecoration::icon() const
{
    return d->bridge->icon();
}

QString KDecoration::caption() const
{
    return d->bridge->caption();
}

void KDecoration::processMousePressEvent(QMouseEvent* e)
{
    return d->bridge->processMousePressEvent(e);
}

void KDecoration::showWindowMenu(const QRect &pos)
{
    d->bridge->showWindowMenu(pos);
}

void KDecoration::showWindowMenu(QPoint pos)
{
    d->bridge->showWindowMenu(pos);
}

void KDecoration::showApplicationMenu(const QPoint &p)
{
    d->bridge->showApplicationMenu(p);
}

bool KDecoration::menuAvailable() const
{
    return d->bridge->menuAvailable();
}

void KDecoration::performWindowOperation(WindowOperation op)
{
    d->bridge->performWindowOperation(op);
}

void KDecoration::setMask(const QRegion& reg, int mode)
{
    d->bridge->setMask(reg, mode);
}

void KDecoration::clearMask()
{
    d->bridge->setMask(QRegion(), 0);
}

bool KDecoration::isPreview() const
{
    return d->bridge->isPreview();
}

QRect KDecoration::geometry() const
{
    return d->bridge->geometry();
}

QRect KDecoration::iconGeometry() const
{
    return d->bridge->iconGeometry();
}

QRegion KDecoration::unobscuredRegion(const QRegion& r) const
{
    return d->bridge->unobscuredRegion(r);
}

WId KDecoration::windowId() const
{
    return d->bridge->windowId();
}

void KDecoration::closeWindow()
{
    d->bridge->closeWindow();
}

void KDecoration::maximize(Qt::MouseButtons button)
{
    performWindowOperation(options()->operationMaxButtonClick(button));
}

void KDecoration::maximize(MaximizeMode mode)
{
    d->bridge->maximize(mode);
}

void KDecoration::minimize()
{
    d->bridge->minimize();
}

void KDecoration::showContextHelp()
{
    d->bridge->showContextHelp();
}

void KDecoration::setDesktop(int desktop)
{
    d->bridge->setDesktop(desktop);
}

void KDecoration::toggleOnAllDesktops()
{
    if (isOnAllDesktops())
        setDesktop(d->bridge->currentDesktop());
    else
        setDesktop(NET::OnAllDesktops);
}

void KDecoration::titlebarDblClickOperation()
{
    d->bridge->titlebarDblClickOperation();
}

void KDecoration::titlebarMouseWheelOperation(int delta)
{
    d->bridge->titlebarMouseWheelOperation(delta);
}

void KDecoration::setShade(bool set)
{
    d->bridge->setShade(set);
}

void KDecoration::setKeepAbove(bool set)
{
    d->bridge->setKeepAbove(set);
}

void KDecoration::setKeepBelow(bool set)
{
    d->bridge->setKeepBelow(set);
}

bool KDecoration::windowDocked(Position)
{
    return false;
}

void KDecoration::grabXServer()
{
    d->bridge->grabXServer(true);
}

void KDecoration::ungrabXServer()
{
    d->bridge->grabXServer(false);
}

KDecoration::Position KDecoration::mousePosition(const QPoint& p) const
{
    const int range = 16;
    int bleft, bright, btop, bbottom;
    borders(bleft, bright, btop, bbottom);
    btop = qMin(btop, 4);   // otherwise whole titlebar would have resize cursor

    Position m = PositionCenter;

    if ((p.x() > bleft && p.x() < widget()->width() - bright)
            && (p.y() > btop && p.y() < widget()->height() - bbottom))
        return PositionCenter;

    if (p.y() <= qMax(range, btop) && p.x() <= qMax(range, bleft))
        m = PositionTopLeft;
    else if (p.y() >= widget()->height() - qMax(range, bbottom)
            && p.x() >= widget()->width() - qMax(range, bright))
        m = PositionBottomRight;
    else if (p.y() >= widget()->height() - qMax(range, bbottom) && p.x() <= qMax(range, bleft))
        m = PositionBottomLeft;
    else if (p.y() <= qMax(range, btop) && p.x() >= widget()->width() - qMax(range, bright))
        m = PositionTopRight;
    else if (p.y() <= btop)
        m = PositionTop;
    else if (p.y() >= widget()->height() - bbottom)
        m = PositionBottom;
    else if (p.x() <= bleft)
        m = PositionLeft;
    else if (p.x() >= widget()->width() - bright)
        m = PositionRight;
    else
        m = PositionCenter;
    return m;
}

QRect KDecoration::transparentRect() const
{
    return d->bridge->transparentRect();
}

void KDecoration::setAlphaEnabled(bool enabled)
{
    if (d->alphaEnabled == enabled) {
        return;
    }
    d->alphaEnabled = enabled;
    emit alphaEnabledChanged(enabled);
}

bool KDecoration::isAlphaEnabled() const
{
    return d->alphaEnabled;
}

bool KDecoration::compositingActive() const
{
    return d->bridge->compositingActive();
}

QPalette KDecoration::palette() const
{
    return d->bridge->palette();
}

void KDecoration::padding(int &left, int &right, int &top, int &bottom) const
{
    left = right = top = bottom = 0;
}

//BEGIN Window tabbing

int KDecoration::tabCount() const
{
    return d->bridge->tabCount();
}

long KDecoration::tabId(int idx) const
{
    return d->bridge->tabId(idx);
}

QString KDecoration::caption(int idx) const
{
    return d->bridge->caption(idx);
}

QIcon KDecoration::icon(int idx) const
{
    return d->bridge->icon(idx);
}

long KDecoration::currentTabId() const
{
    return d->bridge->currentTabId();
}

void KDecoration::setCurrentTab(long id)
{
    d->bridge->setCurrentTab(id);
}

void KDecoration::tab_A_before_B(long A, long B)
{
    d->bridge->tab_A_before_B(A, B);
}

void KDecoration::tab_A_behind_B(long A, long B)
{
    d->bridge->tab_A_behind_B(A, B);
}

void KDecoration::untab(long id, const QRect& newGeom)
{
    d->bridge->untab(id, newGeom);
}

void KDecoration::closeTab(long id)
{
    d->bridge->closeTab(id);
}

void KDecoration::closeTabGroup()
{
    d->bridge->closeTabGroup();
}

void KDecoration::showWindowMenu(const QPoint &pos, long id)
{
    d->bridge->showWindowMenu(pos, id);
}

//END tabbing

KDecoration::WindowOperation KDecoration::buttonToWindowOperation(Qt::MouseButtons button)
{
    return d->bridge->buttonToWindowOperation(button);
}

QRegion KDecoration::region(KDecorationDefines::Region)
{
    return QRegion();
}

KDecorationDefines::Position KDecoration::titlebarPosition()
{
    return PositionTop;
}

QWidget* KDecoration::widget()
{
    return d->w.data();
}

const QWidget* KDecoration::widget() const
{
    return d->w.data();
}

QWindow *KDecoration::window()
{
    if (!d->window.isNull()) {
        return d->window.data();
    }
    if (!d->w.isNull()) {
        // we have a widget
        if (d->w->windowHandle()) {
            // the window exists, so return it
            return d->w->windowHandle();
        } else {
            // access window Id to generate the handle
            WId tempId = d->w->winId();
            Q_UNUSED(tempId)
            return d->w->windowHandle();
        }
    }
    // neither window, nor widget are set
    return nullptr;
}

KDecorationFactory* KDecoration::factory() const
{
    return d->factory;
}

bool KDecoration::isOnAllDesktops() const
{
    return desktop() == NET::OnAllDesktops;
}

bool KDecoration::isOnAllDesktopsAvailable() const
{
    return d->bridge->isOnAllDesktopsAvailable();
}

int KDecoration::width() const
{
    return geometry().width();
}

int KDecoration::height() const
{
    return geometry().height();
}

void KDecoration::render(QPaintDevice* device, const QRegion& sourceRegion)
{
    if (!widget()) {
        return;
    }
    // do not use DrawWindowBackground, it's ok to be transparent
    widget()->render(device, QPoint(), sourceRegion, QWidget::DrawChildren);
}

void KDecoration::update()
{
    int left, right, top, bottom;
    left = right = top = bottom = 0;
    padding(left, right, top, bottom);
    update(QRegion(0, 0, width() + left + right, height() + top + bottom));
}

void KDecoration::update(const QRect &rect)
{
    update(QRegion(rect));
}

void KDecoration::update(const QRegion &region)
{
    d->bridge->update(region);
}

QString KDecorationDefines::tabDragMimeType()
{
    return QStringLiteral("text/ClientGroupItem");
}

KDecorationOptions* KDecorationOptions::s_self = nullptr;

KDecorationOptions::KDecorationOptions(QObject *parent)
    : QObject(parent)
    , d(new KDecorationOptionsPrivate(this))
{
    assert(s_self == nullptr);
    s_self = this;
    connect(this, &KDecorationOptions::activeFontChanged, this, &KDecorationOptions::fontsChanged);
    connect(this, &KDecorationOptions::inactiveFontChanged, this, &KDecorationOptions::fontsChanged);
    connect(this, &KDecorationOptions::smallActiveFontChanged, this, &KDecorationOptions::fontsChanged);
    connect(this, &KDecorationOptions::smallInactiveFontChanged, this, &KDecorationOptions::fontsChanged);
    connect(this, &KDecorationOptions::leftButtonsChanged, this, &KDecorationOptions::buttonsChanged);
    connect(this, &KDecorationOptions::rightButtonsChanged, this, &KDecorationOptions::buttonsChanged);
    connect(this, &KDecorationOptions::customButtonPositionsChanged, this, &KDecorationOptions::buttonsChanged);
}

KDecorationOptions::~KDecorationOptions()
{
    assert(s_self == this);
    s_self = nullptr;
    delete d;
}

KDecorationOptions* KDecorationOptions::self()
{
    return s_self;
}

QColor KDecorationOptions::color(ColorType type, bool active) const
{
    return(d->colors[type + (active ? 0 : NUM_COLORS)]);
}

QFont KDecorationOptions::font(bool active, bool small) const
{
    if (small)
        return(active ? d->activeFontSmall : d->inactiveFontSmall);
    else
        return(active ? d->activeFont : d->inactiveFont);
}

QPalette KDecorationOptions::palette(ColorType type, bool active) const
{
    int idx = type + (active ? 0 : NUM_COLORS);
    if (d->pal[idx])
        return(*d->pal[idx]);
    // TODO: Why construct the palette this way? Is it worth porting to Qt4?
    //d->pal[idx] = new QPalette(Qt::black, d->colors[idx], d->colors[idx].light(150),
    //                           d->colors[idx].dark(), d->colors[idx].dark(120),
    //                           Qt::black, QApplication::palette().active().
    //                           base());
    d->pal[idx] = new QPalette(d->colors[idx]);
    return(*d->pal[idx]);
}

void KDecorationOptions::updateSettings(KConfig* config)
{
    d->updateSettings(config);
}

bool KDecorationOptions::customButtonPositions() const
{
    return d->custom_button_positions;
}

QList<KDecorationDefines::DecorationButton> KDecorationOptions::titleButtonsLeft() const
{
    return d->title_buttons_left;
}

QList<KDecorationDefines::DecorationButton> KDecorationOptions::defaultTitleButtonsLeft()
{
    return QList<DecorationButton>() << DecorationButtonMenu
                                     << DecorationButtonOnAllDesktops;
}

QList<KDecorationDefines::DecorationButton> KDecorationOptions::titleButtonsRight() const
{
    return d->title_buttons_right;
}

QList<KDecorationDefines::DecorationButton> KDecorationOptions::defaultTitleButtonsRight()
{
    return QList<DecorationButton>() << DecorationButtonQuickHelp
                                     << DecorationButtonMinimize
                                     << DecorationButtonMaximizeRestore
                                     << DecorationButtonClose;
}

bool KDecorationOptions::showTooltips() const
{
    return d->show_tooltips;
}

KDecorationOptions::BorderSize KDecorationOptions::preferredBorderSize(KDecorationFactory* factory) const
{
    assert(factory != nullptr);
    if (d->cached_border_size == BordersCount)   // invalid
        d->cached_border_size = d->findPreferredBorderSize(d->border_size,
                                factory->borderSizes());
    return d->cached_border_size;
}

KDecorationDefines::WindowOperation KDecorationOptions::operationMaxButtonClick(Qt::MouseButtons button) const
{
    return button == Qt::RightButton ? d->opMaxButtonRightClick :
           button == Qt::MidButton ?   d->opMaxButtonMiddleClick :
           d->opMaxButtonLeftClick;
}

void KDecorationOptions::setOpMaxButtonLeftClick(WindowOperation op)
{
    d->opMaxButtonLeftClick = op;
}

void KDecorationOptions::setOpMaxButtonRightClick(WindowOperation op)
{
    d->opMaxButtonRightClick = op;
}

void KDecorationOptions::setOpMaxButtonMiddleClick(WindowOperation op)
{
    d->opMaxButtonMiddleClick = op;
}

void KDecorationOptions::setBorderSize(BorderSize bs)
{
    d->border_size = bs;
    d->cached_border_size = BordersCount; // invalid
}

void KDecorationOptions::setCustomButtonPositions(bool b)
{
    d->custom_button_positions = b;
}

void KDecorationOptions::setTitleButtonsLeft(const QList<DecorationButton>& b)
{
    d->title_buttons_left = b;
}

void KDecorationOptions::setTitleButtonsRight(const QList<DecorationButton>& b)
{
    d->title_buttons_right = b;
}


static QHash<KDecorationDefines::DecorationButton, QByteArray> s_buttonNames;
static void initButtons()
{
    if (!s_buttonNames.isEmpty()) {
        return;
    }
    s_buttonNames[KDecorationDefines::DecorationButtonMenu]            = QByteArrayLiteral("M");
    s_buttonNames[KDecorationDefines::DecorationButtonApplicationMenu] = QByteArrayLiteral("N");
    s_buttonNames[KDecorationDefines::DecorationButtonOnAllDesktops]   = QByteArrayLiteral("S");
    s_buttonNames[KDecorationDefines::DecorationButtonQuickHelp]       = QByteArrayLiteral("H");
    s_buttonNames[KDecorationDefines::DecorationButtonMinimize]        = QByteArrayLiteral("I");
    s_buttonNames[KDecorationDefines::DecorationButtonMaximizeRestore] = QByteArrayLiteral("A");
    s_buttonNames[KDecorationDefines::DecorationButtonClose]           = QByteArrayLiteral("X");
    s_buttonNames[KDecorationDefines::DecorationButtonKeepAbove]       = QByteArrayLiteral("F");
    s_buttonNames[KDecorationDefines::DecorationButtonKeepBelow]       = QByteArrayLiteral("B");
    s_buttonNames[KDecorationDefines::DecorationButtonShade]           = QByteArrayLiteral("L");
    s_buttonNames[KDecorationDefines::DecorationButtonResize]          = QByteArrayLiteral("R");
    s_buttonNames[KDecorationDefines::DecorationButtonExplicitSpacer]  = QByteArrayLiteral("_");
}

static QString buttonsToString(const QList<KDecorationDefines::DecorationButton> &buttons)
{
    auto buttonToString = [](KDecorationDefines::DecorationButton button) -> QByteArray {
        const auto it = s_buttonNames.constFind(button);
        if (it != s_buttonNames.constEnd()) {
            return it.value();
        }
        return QByteArray();
    };
    QByteArray ret;
    for (auto button : buttons) {
        ret.append(buttonToString(button));
    }
    return QString::fromUtf8(ret);
}

QList< KDecorationDefines::DecorationButton > KDecorationOptions::readDecorationButtons(const KConfigGroup &config,
                                                                                        const char *key,
                                                                                        const QList< DecorationButton > &defaultValue)
{
    initButtons();
    auto buttonFromString = [](const QByteArray &button) -> DecorationButton {
        return s_buttonNames.key(button, DecorationButtonNone);
    };
    auto buttonsFromString = [buttonFromString](const QString &buttons) -> QList<DecorationButton> {
        QList<DecorationButton> ret;
        for (auto it = buttons.constBegin(); it != buttons.constEnd(); ++it) {
            char character = (*it).toLatin1();
            const DecorationButton button = buttonFromString(QByteArray::fromRawData(&character, 1));
            if (button != DecorationButtonNone) {
                ret << button;
            }
        }
        return ret;
    };
    return buttonsFromString(config.readEntry(key, buttonsToString(defaultValue)));
}

void KDecorationOptions::writeDecorationButtons(KConfigGroup &config, const char *key,
                                                const QList< DecorationButton > &value)
{
    initButtons();
    config.writeEntry(key, buttonsToString(value));
}

extern "C" {

int decoration_bridge_version()
{
    return KWIN_DECORATION_BRIDGE_API_VERSION;
}

}

#include "kdecoration.moc"