fluxbox/src/FbTk/FbWindow.cc
Mathias Gumz c0e5d1c7a3 Fix broken _NET_REQUEST_FRAME_EXTENTS support
There was a subtle flaw in the way fluxbox detects to which BScreen a
given Window belongs: We have to compare the RootWindow of the given
Window against the RootWindow of each BScreen.

That underlying flaw made _NET_REQUEST_FRAME_EXTENTS fail: the code path
needs a valid BScreen for the given window, otherwise we return early.

Closes #1121.
2015-01-22 10:14:12 +01:00

732 lines
22 KiB
C++

// FbWindow.cc for FbTk - fluxbox toolkit
// Copyright (c) 2002 - 2006 Henrik Kinnunen (fluxgen at fluxbox dot 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 "FbWindow.hh"
#include "FbPixmap.hh"
#include "FbString.hh"
#include "EventManager.hh"
#include "Color.hh"
#include "App.hh"
#include "Transparent.hh"
#include <X11/Xutil.h>
#include <X11/Xatom.h>
#include <cassert>
#include <limits>
namespace FbTk {
Window FbWindow::rootWindow(Display* dpy, Drawable win) {
union { int i; unsigned int ui; } ignore;
Window root = None;
XGetGeometry(dpy, win, &root, &ignore.i, &ignore.i, &ignore.ui, &ignore.ui, &ignore.ui, &ignore.ui);
return root;
}
FbWindow::FbWindow():
FbDrawable(),
m_parent(0), m_screen_num(0), m_window(0),
m_x(0), m_y(0), m_width(0), m_height(0),
m_border_width(0), m_border_color(0),
m_depth(0), m_destroy(true),
m_lastbg_color_set(false), m_lastbg_color(0), m_lastbg_pm(0),
m_renderer(0) {
}
FbWindow::FbWindow(const FbWindow& the_copy):
FbDrawable(),
m_parent(the_copy.parent()),
m_screen_num(the_copy.screenNumber()), m_window(the_copy.window()),
m_x(the_copy.x()), m_y(the_copy.y()),
m_width(the_copy.width()), m_height(the_copy.height()),
m_border_width(the_copy.borderWidth()),
m_border_color(the_copy.borderColor()),
m_depth(the_copy.depth()), m_destroy(true),
m_lastbg_color_set(false), m_lastbg_color(0), m_lastbg_pm(0),
m_renderer(the_copy.m_renderer) {
the_copy.m_window = 0;
}
FbWindow::FbWindow(int screen_num,
int x, int y,
unsigned int width, unsigned int height,
long eventmask,
bool override_redirect,
bool save_unders,
unsigned int depth,
int class_type,
Visual *visual,
Colormap cmap):
FbDrawable(),
m_parent(0),
m_screen_num(screen_num),
m_window(0),
m_x(0), m_y(0), m_width(1), m_height(1),
m_border_width(0),
m_border_color(0),
m_depth(0),
m_destroy(true),
m_lastbg_color_set(false),
m_lastbg_color(0),
m_lastbg_pm(0), m_renderer(0) {
create(RootWindow(display(), screen_num),
x, y, width, height, eventmask,
override_redirect, save_unders, depth, class_type, visual, cmap);
}
FbWindow::FbWindow(const FbWindow &parent,
int x, int y, unsigned int width, unsigned int height,
long eventmask,
bool override_redirect,
bool save_unders,
unsigned int depth,
int class_type,
Visual *visual,
Colormap cmap):
FbDrawable(),
m_parent(&parent),
m_screen_num(parent.screenNumber()),
m_window(0),
m_x(0), m_y(0),
m_width(1), m_height(1),
m_destroy(true),
m_lastbg_color_set(false), m_lastbg_color(0),
m_lastbg_pm(0), m_renderer(0) {
create(parent.window(), x, y, width, height, eventmask,
override_redirect, save_unders, depth, class_type, visual, cmap);
}
FbWindow::FbWindow(Window client):
FbDrawable(),
m_parent(0), m_screen_num(0), m_window(0),
m_x(0), m_y(0), m_width(1), m_height(1),
m_border_width(0), m_border_color(0),
m_depth(0), m_destroy(false), // don't destroy this window
m_lastbg_color_set(false), m_lastbg_color(0), m_lastbg_pm(0),
m_renderer(0) {
setNew(client);
}
FbWindow::~FbWindow() {
// Need to free xrender pics before destroying window
if (m_transparent.get() != 0) {
removeAlphaWin(*this);
m_transparent.reset(0);
}
if (m_window != 0) {
// so we don't get any dangling eventhandler for this window
FbTk::EventManager::instance()->remove(m_window);
if (m_destroy)
XDestroyWindow(display(), m_window);
}
}
void FbWindow::setBackgroundColor(const FbTk::Color &bg_color) {
if (bg_color.isAllocated()) {
m_lastbg_color = bg_color.pixel();
m_lastbg_color_set = true;
m_lastbg_pm = None;
} else {
m_lastbg_color_set = false;
}
updateBackground(false);
}
void FbWindow::setBackgroundPixmap(Pixmap bg_pixmap) {
m_lastbg_pm = bg_pixmap;
if (bg_pixmap != None)
m_lastbg_color_set = false;
updateBackground(false);
}
void FbWindow::invalidateBackground() {
m_lastbg_pm = None;
m_lastbg_color_set = false;
}
void FbWindow::updateBackground(bool only_if_alpha) {
Pixmap newbg = m_lastbg_pm;
int alpha = 255;
bool free_newbg = false;
if (m_lastbg_pm == None && !m_lastbg_color_set)
return;
if (m_transparent.get() != 0)
alpha = m_transparent->alpha();
if (only_if_alpha && alpha == 255)
return;
// still use bg buffer pixmap if not transparent
// cause it does nice caching things, assuming we have a renderer
if (m_lastbg_pm != ParentRelative && (m_renderer || alpha != 255)) {
// update source and destination if needed
Pixmap root = FbPixmap::getRootPixmap(screenNumber());
if (alpha != 255 && m_transparent->source() != root)
m_transparent->setSource(root, screenNumber());
FbPixmap newpm = FbPixmap(*this, width(), height(), depth());
free_newbg = true; // newpm gets released to newbg at end of block
GC gc = XCreateGC(display(), window(), 0, 0);
if (m_lastbg_pm == None && m_lastbg_color_set) {
XSetForeground(display(), gc, m_lastbg_color);
newpm.fillRectangle(gc, 0, 0, width(), height());
} else {
// copy from window if no color and no bg...
newpm.copyArea((m_lastbg_pm == None)?drawable():m_lastbg_pm, gc, 0, 0, 0, 0, width(), height());
}
XFreeGC(display(), gc);
if (alpha != 255)
m_transparent->setDest(newpm.drawable(), screenNumber());
// get root position
const FbWindow *root_parent = parent();
// our position in parent ("root")
int root_x = x() + borderWidth(), root_y = y() + borderWidth();
if (root_parent != 0) {
root_x += root_parent->x() + root_parent->borderWidth();
root_y += root_parent->y() + root_parent->borderWidth();
while (root_parent->parent() != 0) {
root_parent = root_parent->parent();
root_x += root_parent->x() + root_parent->borderWidth();
root_y += root_parent->y() + root_parent->borderWidth();
}
}
// render background image from root pos to our window
if (alpha != 255)
m_transparent->render(root_x, root_y,
0, 0,
width(), height());
// render any foreground items
if (m_renderer)
m_renderer->renderForeground(*this, newpm);
if (alpha != 255)
m_transparent->freeDest(); // it's only temporary, don't leave it hanging around
newbg = newpm.release();
}
if (newbg != None)
XSetWindowBackgroundPixmap(display(), m_window, newbg);
else if (m_lastbg_color_set)
XSetWindowBackground(display(), m_window, m_lastbg_color);
if (free_newbg)
XFreePixmap(display(), newbg);
}
void FbWindow::setBorderColor(const FbTk::Color &border_color) {
XSetWindowBorder(display(), m_window, border_color.pixel());
m_border_color = border_color.pixel();
}
void FbWindow::setBorderWidth(unsigned int size) {
XSetWindowBorderWidth(display(), m_window, size);
m_border_width = size;
}
void FbWindow::setName(const char *name) {
XStoreName(display(), m_window, name);
}
void FbWindow::setWindowRole(const char *windowRole) {
XTextProperty tp;
XStringListToTextProperty(const_cast<char **>(&windowRole), 1, &tp);
XSetTextProperty(display(), m_window, &tp, XInternAtom(display(), "WM_WINDOW_ROLE", False));
XFree(tp.value);
}
void FbWindow::setEventMask(long mask) {
XSelectInput(display(), m_window, mask);
}
void FbWindow::clear() {
XClearWindow(display(), m_window);
if (m_lastbg_pm == ParentRelative && m_renderer)
m_renderer->renderForeground(*this, *this);
}
void FbWindow::clearArea(int x, int y,
unsigned int width, unsigned int height,
bool exposures) {
// TODO: probably could call renderForeground here (with x,y,w,h)
if (m_lastbg_pm == ParentRelative && m_renderer)
FbWindow::clear();
else
XClearArea(display(), window(), x, y, width, height, exposures);
}
// If override_is_offset, then dest_override is a pixmap located at the_x, the_y
// with size the_width x the_height in the target window.
void FbWindow::updateTransparent(int the_x, int the_y, unsigned int the_width, unsigned int the_height, Pixmap dest_override, bool override_is_offset) {
#ifdef HAVE_XRENDER
if (!m_transparent.get())
return;
if (width() == 0 || height() == 0)
return;
if (!dest_override && ((the_width == 0 && the_height == 0) ||
(the_width == width() && the_height == height())) &&
the_x <= 0 && the_y <= 0) {
// do the whole thing
updateBackground(true);
return;
}
if (!dest_override)
dest_override = window();
if (the_width == 0 || the_height == 0) {
the_width = width();
the_height = height();
}
if (the_x < 0 || the_y < 0) {
the_x = 0;
the_y = 0;
}
// update source and destination if needed
Pixmap root = FbPixmap::getRootPixmap(screenNumber());
if (m_transparent->source() != root)
m_transparent->setSource(root, screenNumber());
if (m_transparent->dest() != dest_override)
m_transparent->setDest(dest_override, screenNumber());
// get root position
const FbWindow *root_parent = parent();
// our position in parent ("root")
int root_x = x() + borderWidth(), root_y = y() + borderWidth();
if (root_parent != 0) {
root_x += root_parent->x() + root_parent->borderWidth();
root_y += root_parent->y() + root_parent->borderWidth();
while (root_parent->parent() != 0) {
root_parent = root_parent->parent();
root_x += root_parent->x() + root_parent->borderWidth();
root_y += root_parent->y() + root_parent->borderWidth();
}
} // else toplevel window so we already have x, y set
// render background image from root pos to our window
m_transparent->render(root_x + the_x, root_y + the_y,
override_is_offset?0:the_x, override_is_offset?0:the_y,
the_width, the_height);
#endif // HAVE_XRENDER
}
void FbWindow::setAlpha(int alpha) {
#ifdef HAVE_XRENDER
if (FbTk::Transparent::haveComposite()) {
if (m_transparent.get() != 0) {
removeAlphaWin(*this);
m_transparent.reset(0);
}
// don't setOpaque, let controlling objects do that
// since it's only needed on toplevel windows
} else {
if (!FbTk::Transparent::haveRender())
alpha = 255;
if (m_transparent.get() == 0 && alpha < 255) {
m_transparent.reset(new Transparent(FbPixmap::getRootPixmap(screenNumber()), window(), alpha, screenNumber()));
addAlphaWin(*this);
} else if (alpha < 255 && alpha != m_transparent->alpha())
m_transparent->setAlpha(alpha);
else if (alpha == 255) {
removeAlphaWin(*this);
m_transparent.reset(0); // destroy transparent object
}
}
#endif // HAVE_XRENDER
}
int FbWindow::alpha() const {
#ifdef HAVE_XRENDER
if (m_transparent.get())
return m_transparent->alpha();
#endif // HAVE_XRENDER
return 255;
}
FbWindow &FbWindow::operator = (const FbWindow &win) {
m_parent = win.parent();
m_screen_num = win.screenNumber();
m_window = win.window();
m_x = win.x();
m_y = win.y();
m_width = win.width();
m_height = win.height();
m_border_width = win.borderWidth();
m_border_color = win.borderColor();
m_depth = win.depth();
// take over this window
win.m_window = 0;
return *this;
}
FbWindow &FbWindow::operator = (Window win) {
setNew(win);
return *this;
}
void FbWindow::setNew(Window win) {
if (m_window != 0 && m_destroy)
XDestroyWindow(display(), m_window);
m_window = win;
if (m_window != 0) {
updateGeometry();
XWindowAttributes attr;
attr.screen = 0;
//get screen number
if (XGetWindowAttributes(display(),
m_window,
&attr) != 0 && attr.screen != 0) {
m_screen_num = XScreenNumberOfScreen(attr.screen);
if (attr.width <= 0)
m_width = 1;
else
m_width = attr.width;
if (attr.height <= 0)
m_height = 1;
else
m_height = attr.height;
m_x = attr.x;
m_y = attr.y;
m_depth = attr.depth;
m_border_width = attr.border_width;
}
}
}
void FbWindow::show() {
XMapWindow(display(), m_window);
}
void FbWindow::showSubwindows() {
XMapSubwindows(display(), m_window);
}
void FbWindow::hide() {
XUnmapWindow(display(), m_window);
}
void FbWindow::lower() {
XLowerWindow(display(), window());
}
void FbWindow::raise() {
XRaiseWindow(display(), window());
}
void FbWindow::setInputFocus(int revert_to, int time) {
XSetInputFocus(display(), window(), revert_to, time);
}
void FbWindow::setCursor(Cursor cur) {
XDefineCursor(display(), window(), cur);
}
void FbWindow::reparent(const FbWindow &parent, int x, int y, bool continuing) {
XReparentWindow(display(), window(), parent.window(), x, y);
m_parent = &parent;
if (continuing) // we will continue managing this window after reparent
updateGeometry();
}
namespace {
struct TextPropPtr {
TextPropPtr(XTextProperty& prop):m_prop(prop) {}
~TextPropPtr() {
if (m_prop.value != 0) {
XFree(m_prop.value);
m_prop.value = 0;
}
}
XTextProperty& m_prop;
};
}
long FbWindow::cardinalProperty(Atom prop, bool* exists) const {
Atom type;
int format;
unsigned long nitems, bytes_after;
long* num;
long ret=0;
if (exists) *exists=false;
if (property(prop, 0, 1, False, XA_CARDINAL, &type, &format, &nitems, &bytes_after, reinterpret_cast<unsigned char**>(&num))) {
if (type == XA_CARDINAL && nitems) {
ret = *num;
if (exists) *exists=true;
}
XFree(num);
}
return ret;
}
FbTk::FbString FbWindow::textProperty(Atom prop,bool*exists) const {
XTextProperty text_prop;
TextPropPtr helper(text_prop);
char ** stringlist = 0;
int count = 0;
FbTk::FbString ret;
static const Atom utf8string = XInternAtom(display(), "UTF8_STRING", False);
if (exists) *exists=false;
if (XGetTextProperty(display(), window(), &text_prop, prop) == 0 || text_prop.value == 0 || text_prop.nitems == 0) {
return "";
}
if (text_prop.encoding == XA_STRING) {
if (XTextPropertyToStringList(&text_prop, &stringlist, &count) == 0 || count == 0) {
return "";
}
ret = FbStringUtil::XStrToFb(stringlist[0]);
} else if (text_prop.encoding == utf8string && text_prop.format == 8) {
#ifdef X_HAVE_UTF8_STRING
Xutf8TextPropertyToTextList(display(), &text_prop, &stringlist, &count);
if (count == 0 || stringlist == 0) {
return "";
}
#else
if (XTextPropertyToStringList(&text_prop, &stringlist, &count) == 0 || count == 0 || stringlist == 0) {
return "";
}
#endif
ret = stringlist[0];
} else {
// still returns a "StringList" despite the different name
XmbTextPropertyToTextList(display(), &text_prop, &stringlist, &count);
if (count == 0 || stringlist == 0) {
return "";
}
ret = FbStringUtil::LocaleStrToFb(stringlist[0]);
}
XFreeStringList(stringlist);
if (exists) *exists=true;
return ret;
}
bool FbWindow::property(Atom prop,
long long_offset, long long_length,
bool do_delete,
Atom req_type,
Atom *actual_type_return,
int *actual_format_return,
unsigned long *nitems_return,
unsigned long *bytes_after_return,
unsigned char **prop_return) const {
if (XGetWindowProperty(display(), window(),
prop, long_offset, long_length, do_delete,
req_type, actual_type_return,
actual_format_return, nitems_return,
bytes_after_return, prop_return) == Success)
return true;
return false;
}
void FbWindow::changeProperty(Atom prop, Atom type,
int format,
int mode,
unsigned char *data,
int nelements) {
XChangeProperty(display(), m_window, prop, type,
format, mode,
data, nelements);
}
void FbWindow::deleteProperty(Atom prop) {
XDeleteProperty(display(), m_window, prop);
}
void FbWindow::addToSaveSet() {
XAddToSaveSet(display(), m_window);
}
void FbWindow::removeFromSaveSet() {
XRemoveFromSaveSet(display(), m_window);
}
int FbWindow::screenNumber() const {
return m_screen_num;
}
long FbWindow::eventMask() const {
XWindowAttributes attrib;
XGetWindowAttributes(display(), window(),
&attrib);
return attrib.your_event_mask;
}
void FbWindow::setOpaque(int alpha) {
#ifdef HAVE_XRENDER
static const Atom alphaatom = XInternAtom(display(), "_NET_WM_WINDOW_OPACITY", False);
unsigned long opacity = alpha * 0x1010101;
changeProperty(alphaatom, XA_CARDINAL, 32, PropModeReplace, (unsigned char *) &opacity, 1l);
#endif // HAVE_XRENDER
}
bool FbWindow::updateGeometry() {
if (m_window == 0)
return false;
int old_x = m_x, old_y = m_y;
unsigned int old_width = m_width, old_height = m_height;
Window root;
unsigned int border_width, depth;
if (XGetGeometry(display(), m_window, &root, &m_x, &m_y,
&m_width, &m_height, &border_width, &depth))
m_depth = depth;
return (old_x != m_x || old_y != m_y || old_width != m_width ||
old_height != m_height);
}
void FbWindow::create(Window parent, int x, int y,
unsigned int width, unsigned int height,
long eventmask, bool override_redirect,
bool save_unders, unsigned int depth, int class_type,
Visual *visual, Colormap cmap) {
m_border_width = 0;
m_border_color = 0;
long valmask = CWEventMask;
XSetWindowAttributes values;
values.event_mask = eventmask;
if (override_redirect) {
valmask |= CWOverrideRedirect;
values.override_redirect = True;
}
if (save_unders) {
valmask |= CWSaveUnder;
values.save_under = True;
}
if (cmap != CopyFromParent) {
valmask |= CWColormap | CWBackPixel | CWBorderPixel;
values.colormap = cmap;
values.background_pixel = XWhitePixel(display(), 0);
values.border_pixel = XBlackPixel(display(), 0);
}
m_window = XCreateWindow(display(), parent, x, y, width, height,
0, // border width
depth, // depth
class_type, // class
visual, // visual
valmask, // create mask
&values); // create atrribs
assert(m_window);
updateGeometry();
}
void FbWindow::sendConfigureNotify(int x, int y,
unsigned int width, unsigned int height,
unsigned int bw) {
Display *disp = FbTk::App::instance()->display();
XEvent event;
event.type = ConfigureNotify;
event.xconfigure.display = disp;
event.xconfigure.event = window();
event.xconfigure.window = window();
event.xconfigure.x = x;
event.xconfigure.y = y;
event.xconfigure.width = width;
event.xconfigure.height = height;
event.xconfigure.border_width = bw;
event.xconfigure.above = None;
event.xconfigure.override_redirect = false;
XSendEvent(disp, window(), False, StructureNotifyMask, &event);
}
FbWindow::FbWinList FbWindow::m_alpha_wins;
void FbWindow::addAlphaWin(FbWindow &win) {
m_alpha_wins.insert(&win);
}
void FbWindow::removeAlphaWin(FbWindow &win) {
FbWinList::iterator it = m_alpha_wins.find(&win);
if (it != m_alpha_wins.end())
m_alpha_wins.erase(it);
}
void FbWindow::updatedAlphaBackground(int screen) {
FbWinList::iterator it = m_alpha_wins.begin();
FbWinList::iterator it_end = m_alpha_wins.end();
for (; it != it_end; ++it) {
if ((*it)->screenNumber() == screen) {
(*it)->updateBackground(false);
(*it)->clear();
}
}
}
bool operator == (Window win, const FbWindow &fbwin) {
return win == fbwin.window();
}
}