Set hints that remember the WM_WINDOW_ROLE and WM_CLASS properties for our users.
[dana/openbox.git] / openbox / focus_cycle_popup.c
1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
2
3    focus_cycle_popup.c for the Openbox window manager
4    Copyright (c) 2006        Mikael Magnusson
5    Copyright (c) 2003-2007   Dana Jansens
6
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 2 of the License, or
10    (at your option) any later version.
11
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16
17    See the COPYING file for a copy of the GNU General Public License.
18 */
19
20 #include "focus_cycle_popup.h"
21 #include "popup.h"
22 #include "client.h"
23 #include "screen.h"
24 #include "focus.h"
25 #include "openbox.h"
26 #include "window.h"
27 #include "event.h"
28 #include "render/render.h"
29
30 #include <X11/Xlib.h>
31 #include <glib.h>
32
33 #define ICON_SIZE 40
34 #define ICON_HILITE_WIDTH 2
35 #define ICON_HILITE_MARGIN 1
36 #define OUTSIDE_BORDER 3
37 #define TEXT_BORDER 2
38
39 typedef struct _ObFocusCyclePopup       ObFocusCyclePopup;
40 typedef struct _ObFocusCyclePopupTarget ObFocusCyclePopupTarget;
41
42 struct _ObFocusCyclePopupTarget
43 {
44     ObClient *client;
45     RrImage *icon;
46     gchar *text;
47     Window win;
48 };
49
50 struct _ObFocusCyclePopup
51 {
52     ObWindow obwin;
53     Window bg;
54
55     Window text;
56
57     GList *targets;
58     gint n_targets;
59
60     const ObFocusCyclePopupTarget *last_target;
61
62     gint maxtextw;
63
64     RrAppearance *a_bg;
65     RrAppearance *a_text;
66     RrAppearance *a_icon;
67
68     RrPixel32 *hilite_rgba;
69
70     gboolean mapped;
71 };
72
73 /*! This popup shows all possible windows */
74 static ObFocusCyclePopup popup;
75 /*! This popup shows a single window */
76 static ObIconPopup *single_popup;
77
78 static gchar *popup_get_name (ObClient *c);
79 static void   popup_setup    (ObFocusCyclePopup *p,
80                               gboolean create_targets,
81                               gboolean iconic_windows,
82                               gboolean all_desktops,
83                               gboolean dock_windows,
84                               gboolean desktop_windows);
85 static void   popup_render   (ObFocusCyclePopup *p,
86                               const ObClient *c);
87
88 static Window create_window(Window parent, guint bwidth, gulong mask,
89                             XSetWindowAttributes *attr)
90 {
91     return XCreateWindow(ob_display, parent, 0, 0, 1, 1, bwidth,
92                          RrDepth(ob_rr_inst), InputOutput,
93                          RrVisual(ob_rr_inst), mask, attr);
94 }
95
96 void focus_cycle_popup_startup(gboolean reconfig)
97 {
98     XSetWindowAttributes attrib;
99
100     single_popup = icon_popup_new();
101
102     popup.obwin.type = Window_Internal;
103     popup.a_bg = RrAppearanceCopy(ob_rr_theme->osd_hilite_bg);
104     popup.a_text = RrAppearanceCopy(ob_rr_theme->osd_hilite_label);
105     popup.a_icon = RrAppearanceCopy(ob_rr_theme->a_clear_tex);
106
107     popup.a_text->surface.parent = popup.a_bg;
108     popup.a_icon->surface.parent = popup.a_bg;
109
110     RrAppearanceClearTextures(popup.a_icon);
111     popup.a_icon->texture[0].type = RR_TEXTURE_IMAGE;
112
113     RrAppearanceAddTextures(popup.a_bg, 1);
114     popup.a_bg->texture[0].type = RR_TEXTURE_RGBA;
115
116     attrib.override_redirect = True;
117     attrib.border_pixel=RrColorPixel(ob_rr_theme->osd_border_color);
118     popup.bg = create_window(RootWindow(ob_display, ob_screen),
119                              ob_rr_theme->obwidth,
120                              CWOverrideRedirect | CWBorderPixel, &attrib);
121
122     popup.text = create_window(popup.bg, 0, 0, NULL);
123
124     popup.targets = NULL;
125     popup.n_targets = 0;
126     popup.last_target = NULL;
127
128     popup.hilite_rgba = NULL;
129
130     XMapWindow(ob_display, popup.text);
131
132     stacking_add(INTERNAL_AS_WINDOW(&popup));
133     g_hash_table_insert(window_map, &popup.bg, &popup);
134 }
135
136 void focus_cycle_popup_shutdown(gboolean reconfig)
137 {
138     icon_popup_free(single_popup);
139
140     g_hash_table_remove(window_map, &popup.bg);
141     stacking_remove(INTERNAL_AS_WINDOW(&popup));
142
143     while(popup.targets) {
144         ObFocusCyclePopupTarget *t = popup.targets->data;
145
146         RrImageUnref(t->icon);
147         g_free(t->text);
148         XDestroyWindow(ob_display, t->win);
149         g_free(t);
150
151         popup.targets = g_list_delete_link(popup.targets, popup.targets);
152     }
153
154     g_free(popup.hilite_rgba);
155     popup.hilite_rgba = NULL;
156
157     XDestroyWindow(ob_display, popup.text);
158     XDestroyWindow(ob_display, popup.bg);
159
160     RrAppearanceFree(popup.a_icon);
161     RrAppearanceFree(popup.a_text);
162     RrAppearanceFree(popup.a_bg);
163 }
164
165 static void popup_setup(ObFocusCyclePopup *p, gboolean create_targets,
166                         gboolean iconic_windows, gboolean all_desktops,
167                         gboolean dock_windows, gboolean desktop_windows)
168 {
169     gint maxwidth, n;
170     GList *it;
171
172     g_assert(p->targets == NULL);
173     g_assert(p->n_targets == 0);
174
175     /* make its width to be the width of all the possible titles */
176
177     /* build a list of all the valid focus targets and measure their strings,
178        and count them */
179     maxwidth = 0;
180     n = 0;
181     for (it = g_list_last(focus_order); it; it = g_list_previous(it)) {
182         ObClient *ft = it->data;
183
184         if (focus_valid_target(ft, TRUE,
185                                iconic_windows,
186                                all_desktops,
187                                dock_windows,
188                                desktop_windows,
189                                FALSE))
190         {
191             gchar *text = popup_get_name(ft);
192
193             /* measure */
194             p->a_text->texture[0].data.text.string = text;
195             maxwidth = MAX(maxwidth, RrMinWidth(p->a_text));
196
197             if (!create_targets)
198                 g_free(text);
199             else {
200                 ObFocusCyclePopupTarget *t = g_new(ObFocusCyclePopupTarget, 1);
201
202                 t->client = ft;
203                 t->text = text;
204                 t->icon = client_icon(t->client);
205                 RrImageRef(t->icon); /* own the icon so it won't go away */
206                 t->win = create_window(p->bg, 0, 0, NULL);
207
208                 XMapWindow(ob_display, t->win);
209
210                 p->targets = g_list_prepend(p->targets, t);
211                 ++n;
212             }
213         }
214     }
215
216     p->n_targets = n;
217     p->maxtextw = maxwidth;
218 }
219
220 static gchar *popup_get_name(ObClient *c)
221 {
222     ObClient *p;
223     gchar *title;
224     const gchar *desk = NULL;
225     gchar *ret;
226
227     /* find our highest direct parent */
228     p = client_search_top_direct_parent(c);
229
230     if (c->desktop != DESKTOP_ALL && c->desktop != screen_desktop)
231         desk = screen_desktop_names[c->desktop];
232
233     title = c->iconic ? c->icon_title : c->title;
234
235     /* use the transient's parent's title/icon if we don't have one */
236     if (p != c && title[0] == '\0')
237         title = p->iconic ? p->icon_title : p->title;
238
239     if (desk)
240         ret = g_strdup_printf("%s [%s]", title, desk);
241     else
242         ret = g_strdup(title);
243
244     return ret;
245 }
246
247 static void popup_render(ObFocusCyclePopup *p, const ObClient *c)
248 {
249     gint ml, mt, mr, mb;
250     gint l, t, r, b;
251     gint x, y, w, h;
252     Rect *screen_area = NULL;
253     gint icons_per_row;
254     gint icon_rows;
255     gint textx, texty, textw, texth;
256     gint rgbax, rgbay, rgbaw, rgbah;
257     gint icons_center_x;
258     gint innerw, innerh;
259     gint i;
260     GList *it;
261     const ObFocusCyclePopupTarget *newtarget;
262     gint newtargetx, newtargety;
263
264     screen_area = screen_physical_area_primary();
265
266     /* get the outside margins */
267     RrMargins(p->a_bg, &ml, &mt, &mr, &mb);
268
269     /* get our outside borders */
270     l = ml + OUTSIDE_BORDER;
271     r = mr + OUTSIDE_BORDER;
272     t = mt + OUTSIDE_BORDER;
273     b = mb + OUTSIDE_BORDER;
274
275     /* get the icon pictures' sizes */
276     innerw = ICON_SIZE - (ICON_HILITE_WIDTH + ICON_HILITE_MARGIN) * 2;
277     innerh = ICON_SIZE - (ICON_HILITE_WIDTH + ICON_HILITE_MARGIN) * 2;
278
279     /* get the width from the text and keep it within limits */
280     w = l + r + p->maxtextw;
281     w = MIN(w, MAX(screen_area->width/3, POPUP_WIDTH)); /* max width */
282     w = MAX(w, POPUP_WIDTH); /* min width */
283
284     /* how many icons will fit in that row? make the width fit that */
285     w -= l + r;
286     icons_per_row = (w + ICON_SIZE - 1) / ICON_SIZE;
287     w = icons_per_row * ICON_SIZE + l + r;
288
289     /* how many rows do we need? */
290     icon_rows = (p->n_targets-1) / icons_per_row + 1;
291
292     /* get the text dimensions */
293     textw = w - l - r;
294     texth = RrMinHeight(p->a_text) + TEXT_BORDER * 2;
295
296     /* find the height of the dialog */
297     h = t + b + (icon_rows * ICON_SIZE) + (OUTSIDE_BORDER + texth);
298
299     /* get the position of the text */
300     textx = l;
301     texty = h - texth - b;
302
303     /* find the position for the popup (include the outer borders) */
304     x = screen_area->x + (screen_area->width -
305                           (w + ob_rr_theme->obwidth * 2)) / 2;
306     y = screen_area->y + (screen_area->height -
307                           (h + ob_rr_theme->obwidth * 2)) / 2;
308
309     /* get the dimensions of the target hilite texture */
310     rgbax = ml;
311     rgbay = mt;
312     rgbaw = w - ml - mr;
313     rgbah = h - mt - mb;
314
315     /* center the icons if there is less than one row */
316     if (icon_rows == 1)
317         icons_center_x = (w - p->n_targets * ICON_SIZE) / 2;
318     else
319         icons_center_x = 0;
320
321     if (!p->mapped) {
322         /* position the background but don't draw it*/
323         XMoveResizeWindow(ob_display, p->bg, x, y, w, h);
324
325         /* set up the hilite texture for the background */
326         p->a_bg->texture[0].data.rgba.width = rgbaw;
327         p->a_bg->texture[0].data.rgba.height = rgbah;
328         p->a_bg->texture[0].data.rgba.alpha = 0xff;
329         p->hilite_rgba = g_new(RrPixel32, rgbaw * rgbah);
330         p->a_bg->texture[0].data.rgba.data = p->hilite_rgba;
331
332         /* position the text, but don't draw it */
333         XMoveResizeWindow(ob_display, p->text, textx, texty, textw, texth);
334         p->a_text->surface.parentx = textx;
335         p->a_text->surface.parenty = texty;
336     }
337
338     /* find the focused target */
339     for (i = 0, it = p->targets; it; ++i, it = g_list_next(it)) {
340         const ObFocusCyclePopupTarget *target = it->data;
341         const gint row = i / icons_per_row; /* starting from 0 */
342         const gint col = i % icons_per_row; /* starting from 0 */
343
344         if (target->client == c) {
345             /* save the target */
346             newtarget = target;
347             newtargetx = icons_center_x + l + (col * ICON_SIZE);
348             newtargety = t + (row * ICON_SIZE);
349
350             if (!p->mapped)
351                 break; /* if we're not dimensioning, then we're done */
352         }
353     }
354
355     g_assert(newtarget != NULL);
356
357     /* create the hilite under the target icon */
358     {
359         RrPixel32 color;
360         gint i, j, o;
361
362         color = ((ob_rr_theme->osd_color->r & 0xff) << RrDefaultRedOffset) +
363             ((ob_rr_theme->osd_color->g & 0xff) << RrDefaultGreenOffset) +
364             ((ob_rr_theme->osd_color->b & 0xff) << RrDefaultBlueOffset);
365
366         o = 0;
367         for (i = 0; i < rgbah; ++i)
368             for (j = 0; j < rgbaw; ++j) {
369                 guchar a;
370                 const gint x = j + rgbax - newtargetx;
371                 const gint y = i + rgbay - newtargety;
372
373                 if (x < 0 || x >= ICON_SIZE ||
374                     y < 0 || y >= ICON_SIZE)
375                 {
376                     /* outside the target */
377                     a = 0x00;
378                 }
379                 else if (x < ICON_HILITE_WIDTH ||
380                          x >= ICON_SIZE - ICON_HILITE_WIDTH ||
381                          y < ICON_HILITE_WIDTH ||
382                          y >= ICON_SIZE - ICON_HILITE_WIDTH)
383                 {
384                     /* the border of the target */
385                     a = 0x88;
386                 }
387                 else {
388                     /* the background of the target */
389                     a = 0x22;
390                 }
391
392                 p->hilite_rgba[o++] =
393                     color + (a << RrDefaultAlphaOffset);
394             }
395     }
396
397     /* * * draw everything * * */
398
399     /* draw the background */
400     RrPaint(p->a_bg, p->bg, w, h);
401
402     /* draw the icons */
403     for (i = 0, it = p->targets; it; ++i, it = g_list_next(it)) {
404         const ObFocusCyclePopupTarget *target = it->data;
405
406         /* have to redraw the targetted icon and last targetted icon,
407            they can pick up the hilite changes in the backgroud */
408         if (!p->mapped || newtarget == target || p->last_target == target) {
409             const gint row = i / icons_per_row; /* starting from 0 */
410             const gint col = i % icons_per_row; /* starting from 0 */
411             gint innerx, innery;
412
413             /* find the dimensions of the icon inside it */
414             innerx = icons_center_x + l + (col * ICON_SIZE);
415             innerx += ICON_HILITE_WIDTH + ICON_HILITE_MARGIN;
416             innery = t + (row * ICON_SIZE);
417             innery += ICON_HILITE_WIDTH + ICON_HILITE_MARGIN;
418
419             /* move the icon */
420             XMoveResizeWindow(ob_display, target->win,
421                               innerx, innery, innerw, innerh);
422
423             /* get the icon from the client */
424             p->a_icon->texture[0].data.image.alpha =
425                 target->client->iconic ? OB_ICONIC_ALPHA : 0xff;
426             p->a_icon->texture[0].data.image.image = target->icon;
427
428             /* draw the icon */
429             p->a_icon->surface.parentx = innerx;
430             p->a_icon->surface.parenty = innery;
431             RrPaint(p->a_icon, target->win, innerw, innerh);
432         }
433     }
434
435     /* draw the text */
436     p->a_text->texture[0].data.text.string = newtarget->text;
437     p->a_text->surface.parentx = textx;
438     p->a_text->surface.parenty = texty;
439     RrPaint(p->a_text, p->text, textw, texth);
440
441     p->last_target = newtarget;
442
443     g_free(screen_area);
444 }
445
446 void focus_cycle_popup_show(ObClient *c, gboolean iconic_windows,
447                             gboolean all_desktops, gboolean dock_windows,
448                             gboolean desktop_windows)
449 {
450     g_assert(c != NULL);
451
452     /* do this stuff only when the dialog is first showing */
453     if (!popup.mapped)
454         popup_setup(&popup, TRUE, iconic_windows, all_desktops,
455                     dock_windows, desktop_windows);
456     g_assert(popup.targets != NULL);
457
458     popup_render(&popup, c);
459
460     if (!popup.mapped) {
461         /* show the dialog */
462         XMapWindow(ob_display, popup.bg);
463         XFlush(ob_display);
464         popup.mapped = TRUE;
465         screen_hide_desktop_popup();
466     }
467 }
468
469 void focus_cycle_popup_hide(void)
470 {
471     gulong ignore_start;
472
473     ignore_start = event_start_ignore_all_enters();
474
475     XUnmapWindow(ob_display, popup.bg);
476     XFlush(ob_display);
477
478     event_end_ignore_all_enters(ignore_start);
479
480     popup.mapped = FALSE;
481
482     while(popup.targets) {
483         ObFocusCyclePopupTarget *t = popup.targets->data;
484
485         RrImageUnref(t->icon);
486         g_free(t->text);
487         XDestroyWindow(ob_display, t->win);
488         g_free(t);
489
490         popup.targets = g_list_delete_link(popup.targets, popup.targets);
491     }
492     popup.n_targets = 0;
493     popup.last_target = NULL;
494
495     g_free(popup.hilite_rgba);
496     popup.hilite_rgba = NULL;
497 }
498
499 void focus_cycle_popup_single_show(struct _ObClient *c,
500                                    gboolean iconic_windows,
501                                    gboolean all_desktops,
502                                    gboolean dock_windows,
503                                    gboolean desktop_windows)
504 {
505     gchar *text;
506
507     g_assert(c != NULL);
508
509     /* do this stuff only when the dialog is first showing */
510     if (!popup.mapped) {
511         Rect *a;
512
513         popup_setup(&popup, FALSE, iconic_windows, all_desktops,
514                     dock_windows, desktop_windows);
515         g_assert(popup.targets == NULL);
516
517         /* position the popup */
518         a = screen_physical_area_primary();
519         icon_popup_position(single_popup, CenterGravity,
520                             a->x + a->width / 2, a->y + a->height / 2);
521         icon_popup_height(single_popup, POPUP_HEIGHT);
522         icon_popup_min_width(single_popup, POPUP_WIDTH);
523         icon_popup_max_width(single_popup, MAX(a->width/3, POPUP_WIDTH));
524         icon_popup_text_width(single_popup, popup.maxtextw);
525         g_free(a);
526     }
527
528     text = popup_get_name(c);
529     icon_popup_show(single_popup, text, client_icon(c));
530     g_free(text);
531     screen_hide_desktop_popup();
532 }
533
534 void focus_cycle_popup_single_hide(void)
535 {
536     icon_popup_hide(single_popup);
537 }