make an obt_root() macro
[dana/openbox.git] / openbox / popup.c
1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
2
3    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 "popup.h"
21
22 #include "openbox.h"
23 #include "frame.h"
24 #include "client.h"
25 #include "stacking.h"
26 #include "event.h"
27 #include "screen.h"
28 #include "render/render.h"
29 #include "render/theme.h"
30
31 ObPopup *popup_new(void)
32 {
33     XSetWindowAttributes attrib;
34     ObPopup *self = g_new0(ObPopup, 1);
35
36     self->obwin.type = OB_WINDOW_CLASS_INTERNALWINDOW;
37     self->gravity = NorthWestGravity;
38     self->x = self->y = self->textw = self->h = 0;
39     self->a_bg = RrAppearanceCopy(ob_rr_theme->osd_hilite_bg);
40     self->a_text = RrAppearanceCopy(ob_rr_theme->osd_hilite_label);
41     self->iconwm = self->iconhm = 1;
42
43     attrib.override_redirect = True;
44     self->bg = XCreateWindow(obt_display, obt_root(ob_screen),
45                              0, 0, 1, 1, 0, RrDepth(ob_rr_inst),
46                              InputOutput, RrVisual(ob_rr_inst),
47                              CWOverrideRedirect, &attrib);
48
49     self->text = XCreateWindow(obt_display, self->bg,
50                                0, 0, 1, 1, 0, RrDepth(ob_rr_inst),
51                                InputOutput, RrVisual(ob_rr_inst), 0, NULL);
52
53     XSetWindowBorderWidth(obt_display, self->bg, ob_rr_theme->obwidth);
54     XSetWindowBorder(obt_display, self->bg,
55                      RrColorPixel(ob_rr_theme->osd_border_color));
56
57     XMapWindow(obt_display, self->text);
58
59     stacking_add(INTERNALWINDOW_AS_WINDOW(self));
60     window_add(&self->bg, INTERNALWINDOW_AS_WINDOW(self));
61     return self;
62 }
63
64 void popup_free(ObPopup *self)
65 {
66     if (self) {
67         XDestroyWindow(obt_display, self->bg);
68         XDestroyWindow(obt_display, self->text);
69         RrAppearanceFree(self->a_bg);
70         RrAppearanceFree(self->a_text);
71         window_remove(self->bg);
72         stacking_remove(self);
73         g_free(self);
74     }
75 }
76
77 void popup_position(ObPopup *self, gint gravity, gint x, gint y)
78 {
79     self->gravity = gravity;
80     self->x = x;
81     self->y = y;
82 }
83
84 void popup_text_width(ObPopup *self, gint w)
85 {
86     self->textw = w;
87 }
88
89 void popup_min_width(ObPopup *self, gint minw)
90 {
91     self->minw = minw;
92 }
93
94 void popup_max_width(ObPopup *self, gint maxw)
95 {
96     self->maxw = maxw;
97 }
98
99 void popup_height(ObPopup *self, gint h)
100 {
101     gint texth;
102
103     /* don't let the height be smaller than the text */
104     texth = RrMinHeight(self->a_text) + ob_rr_theme->paddingy * 2;
105     self->h = MAX(h, texth);
106 }
107
108 void popup_text_width_to_string(ObPopup *self, gchar *text)
109 {
110     if (text[0] != '\0') {
111         self->a_text->texture[0].data.text.string = text;
112         self->textw = RrMinWidth(self->a_text);
113     } else
114         self->textw = 0;
115 }
116
117 void popup_height_to_string(ObPopup *self, gchar *text)
118 {
119     self->h = RrMinHeight(self->a_text) + ob_rr_theme->paddingy * 2;
120 }
121
122 void popup_text_width_to_strings(ObPopup *self, gchar **strings, gint num)
123 {
124     gint i, maxw;
125
126     maxw = 0;
127     for (i = 0; i < num; ++i) {
128         popup_text_width_to_string(self, strings[i]);
129         maxw = MAX(maxw, self->textw);
130     }
131     self->textw = maxw;
132 }
133
134 void popup_set_text_align(ObPopup *self, RrJustify align)
135 {
136     self->a_text->texture[0].data.text.justify = align;
137 }
138
139 static gboolean popup_show_timeout(gpointer data)
140 {
141     ObPopup *self = data;
142
143     XMapWindow(obt_display, self->bg);
144     stacking_raise(INTERNALWINDOW_AS_WINDOW(self));
145     self->mapped = TRUE;
146     self->delay_mapped = FALSE;
147
148     return FALSE; /* don't repeat */
149 }
150
151 void popup_delay_show(ObPopup *self, gulong usec, gchar *text)
152 {
153     gint l, t, r, b;
154     gint x, y, w, h;
155     guint m;
156     gint emptyx, emptyy; /* empty space between elements */
157     gint textx, texty, textw, texth;
158     gint iconx, icony, iconw, iconh;
159     Rect *area, mon;
160
161     /* when there is no icon and the text is not parent relative, then
162        fill the whole dialog with the text appearance, don't use the bg at all
163     */
164     if (self->hasicon || self->a_text->surface.grad == RR_SURFACE_PARENTREL)
165         RrMargins(self->a_bg, &l, &t, &r, &b);
166     else
167         l = t = r = b = 0;
168
169     /* set up the textures */
170     self->a_text->texture[0].data.text.string = text;
171
172     /* measure the text out */
173     if (text[0] != '\0') {
174         RrMinSize(self->a_text, &textw, &texth);
175     } else {
176         textw = 0;
177         texth = RrMinHeight(self->a_text);
178     }
179
180     /* get the height, which is also used for the icon width */
181     emptyy = t + b + ob_rr_theme->paddingy * 2;
182     if (self->h)
183         texth = self->h - emptyy;
184     h = texth * self->iconhm + emptyy;
185
186     if (self->textw)
187         textw = self->textw;
188
189     iconx = textx = l + ob_rr_theme->paddingx;
190
191     emptyx = l + r + ob_rr_theme->paddingx * 2;
192     if (self->hasicon) {
193         iconw = texth * self->iconwm;
194         iconh = texth * self->iconhm;
195         textx += iconw + ob_rr_theme->paddingx;
196         if (textw)
197             emptyx += ob_rr_theme->paddingx; /* between the icon and text */
198     } else
199         iconw = 0;
200
201     texty = (h - texth - emptyy) / 2 + t + ob_rr_theme->paddingy;
202     icony = (h - iconh - emptyy) / 2 + t + ob_rr_theme->paddingy;
203
204     /* when there is no icon, then fill the whole dialog with the text
205        appearance
206     */
207     if (!self->hasicon)
208     {
209         textx = texty = 0;
210         texth += emptyy;
211         textw += emptyx;
212         emptyx = emptyy = 0;
213     }
214
215     w = textw + emptyx + iconw;
216     /* cap it at maxw/minw */
217     if (self->maxw) w = MIN(w, self->maxw);
218     if (self->minw) w = MAX(w, self->minw);
219     textw = w - emptyx - iconw;
220
221     /* sanity checks to avoid crashes! */
222     if (w < 1) w = 1;
223     if (h < 1) h = 1;
224     if (texth < 1) texth = 1;
225
226     /* set up the x coord */
227     x = self->x;
228     switch (self->gravity) {
229     case NorthGravity: case CenterGravity: case SouthGravity:
230         x -= w / 2;
231         break;
232     case NorthEastGravity: case EastGravity: case SouthEastGravity:
233         x -= w;
234         break;
235     }
236
237     /* set up the y coord */
238     y = self->y;
239     switch (self->gravity) {
240     case WestGravity: case CenterGravity: case EastGravity:
241         y -= h / 2;
242         break;
243     case SouthWestGravity: case SouthGravity: case SouthEastGravity:
244         y -= h;
245         break;
246     }
247
248     /* Find the monitor which contains the biggest part of the popup.
249      * If the popup is completely off screen, limit it to the intersection
250      * of all monitors and then try again. If it's still off screen, put it
251      * on monitor 0. */
252     RECT_SET(mon, x, y, w, h);
253     m = screen_find_monitor(&mon);
254     area = screen_physical_area_monitor(m);
255
256     x=MAX(MIN(x, area->x+area->width-w),area->x);
257     y=MAX(MIN(y, area->y+area->height-h),area->y);
258
259     if (m == screen_num_monitors) {
260         RECT_SET(mon, x, y, w, h);
261         m = screen_find_monitor(&mon);
262         if (m == screen_num_monitors)
263             m = 0;
264         area = screen_physical_area_monitor(m);
265
266         x=MAX(MIN(x, area->x+area->width-w),area->x);
267         y=MAX(MIN(y, area->y+area->height-h),area->y);
268     }
269
270     /* set the windows/appearances up */
271     XMoveResizeWindow(obt_display, self->bg, x, y, w, h);
272     /* when there is no icon and the text is not parent relative, then
273        fill the whole dialog with the text appearance, don't use the bg at all
274     */
275     if (self->hasicon || self->a_text->surface.grad == RR_SURFACE_PARENTREL)
276         RrPaint(self->a_bg, self->bg, w, h);
277
278     if (textw) {
279         self->a_text->surface.parent = self->a_bg;
280         self->a_text->surface.parentx = textx;
281         self->a_text->surface.parenty = texty;
282         XMoveResizeWindow(obt_display, self->text, textx, texty, textw, texth);
283         RrPaint(self->a_text, self->text, textw, texth);
284     }
285
286     if (self->hasicon)
287         self->draw_icon(iconx, icony, iconw, iconh, self->draw_icon_data);
288
289     /* do the actual showing */
290     if (!self->mapped) {
291         if (usec) {
292             /* don't kill previous show timers */
293             if (!self->delay_mapped) {
294                 obt_main_loop_timeout_add(ob_main_loop, usec,
295                                           popup_show_timeout, self,
296                                           g_direct_equal, NULL);
297                 self->delay_mapped = TRUE;
298             }
299         } else {
300             popup_show_timeout(self);
301         }
302     }
303
304     g_free(area);
305 }
306
307 void popup_hide(ObPopup *self)
308 {
309     if (self->mapped) {
310         gulong ignore_start;
311
312         /* kill enter events cause by this unmapping */
313         ignore_start = event_start_ignore_all_enters();
314
315         XUnmapWindow(obt_display, self->bg);
316         self->mapped = FALSE;
317
318         event_end_ignore_all_enters(ignore_start);
319     } else if (self->delay_mapped) {
320         obt_main_loop_timeout_remove(ob_main_loop, popup_show_timeout);
321         self->delay_mapped = FALSE;
322     }
323 }
324
325 static void icon_popup_draw_icon(gint x, gint y, gint w, gint h, gpointer data)
326 {
327     ObIconPopup *self = data;
328
329     self->a_icon->surface.parent = self->popup->a_bg;
330     self->a_icon->surface.parentx = x;
331     self->a_icon->surface.parenty = y;
332     XMoveResizeWindow(obt_display, self->icon, x, y, w, h);
333     RrPaint(self->a_icon, self->icon, w, h);
334 }
335
336 ObIconPopup *icon_popup_new(void)
337 {
338     ObIconPopup *self;
339
340     self = g_new0(ObIconPopup, 1);
341     self->popup = popup_new();
342     self->a_icon = RrAppearanceCopy(ob_rr_theme->a_clear_tex);
343     self->icon = XCreateWindow(obt_display, self->popup->bg,
344                                0, 0, 1, 1, 0,
345                                RrDepth(ob_rr_inst), InputOutput,
346                                RrVisual(ob_rr_inst), 0, NULL);
347     XMapWindow(obt_display, self->icon);
348
349     self->popup->hasicon = TRUE;
350     self->popup->draw_icon = icon_popup_draw_icon;
351     self->popup->draw_icon_data = self;
352
353     return self;
354 }
355
356 void icon_popup_free(ObIconPopup *self)
357 {
358     if (self) {
359         XDestroyWindow(obt_display, self->icon);
360         RrAppearanceFree(self->a_icon);
361         popup_free(self->popup);
362         g_free(self);
363     }
364 }
365
366 void icon_popup_delay_show(ObIconPopup *self, gulong usec,
367                            gchar *text, const ObClientIcon *icon)
368 {
369     if (icon) {
370         self->a_icon->texture[0].type = RR_TEXTURE_RGBA;
371         self->a_icon->texture[0].data.rgba.width = icon->width;
372         self->a_icon->texture[0].data.rgba.height = icon->height;
373         self->a_icon->texture[0].data.rgba.alpha = 0xff;
374         self->a_icon->texture[0].data.rgba.data = icon->data;
375     } else
376         self->a_icon->texture[0].type = RR_TEXTURE_NONE;
377
378     popup_delay_show(self->popup, usec, text);
379 }
380
381 void icon_popup_icon_size_multiplier(ObIconPopup *self, guint wm, guint hm)
382 {
383     /* cap them at 1 */
384     self->popup->iconwm = MAX(1, wm);
385     self->popup->iconhm = MAX(1, hm);
386 }
387
388 static void pager_popup_draw_icon(gint px, gint py, gint w, gint h,
389                                   gpointer data)
390 {
391     ObPagerPopup *self = data;
392     gint x, y;
393     guint rown, n;
394     guint horz_inc;
395     guint vert_inc;
396     guint r, c;
397     gint eachw, eachh;
398     const guint cols = screen_desktop_layout.columns;
399     const guint rows = screen_desktop_layout.rows;
400     const gint linewidth = ob_rr_theme->obwidth;
401
402     eachw = (w - ((cols + 1) * linewidth)) / cols;
403     eachh = (h - ((rows + 1) * linewidth)) / rows;
404     /* make them squares */
405     eachw = eachh = MIN(eachw, eachh);
406
407     /* center */
408     px += (w - (cols * (eachw + linewidth) + linewidth)) / 2;
409     py += (h - (rows * (eachh + linewidth) + linewidth)) / 2;
410
411     if (eachw <= 0 || eachh <= 0)
412         return;
413
414     switch (screen_desktop_layout.orientation) {
415     case OB_ORIENTATION_HORZ:
416         switch (screen_desktop_layout.start_corner) {
417         case OB_CORNER_TOPLEFT:
418             n = 0;
419             horz_inc = 1;
420             vert_inc = cols;
421             break;
422         case OB_CORNER_TOPRIGHT:
423             n = cols - 1;
424             horz_inc = -1;
425             vert_inc = cols;
426             break;
427         case OB_CORNER_BOTTOMRIGHT:
428             n = rows * cols - 1;
429             horz_inc = -1;
430             vert_inc = -screen_desktop_layout.columns;
431             break;
432         case OB_CORNER_BOTTOMLEFT:
433             n = (rows - 1) * cols;
434             horz_inc = 1;
435             vert_inc = -cols;
436             break;
437         default:
438             g_assert_not_reached();
439         }
440         break;
441     case OB_ORIENTATION_VERT:
442         switch (screen_desktop_layout.start_corner) {
443         case OB_CORNER_TOPLEFT:
444             n = 0;
445             horz_inc = rows;
446             vert_inc = 1;
447             break;
448         case OB_CORNER_TOPRIGHT:
449             n = rows * (cols - 1);
450             horz_inc = -rows;
451             vert_inc = 1;
452             break;
453         case OB_CORNER_BOTTOMRIGHT:
454             n = rows * cols - 1;
455             horz_inc = -rows;
456             vert_inc = -1;
457             break;
458         case OB_CORNER_BOTTOMLEFT:
459             n = rows - 1;
460             horz_inc = rows;
461             vert_inc = -1;
462             break;
463         default:
464             g_assert_not_reached();
465         }
466         break;
467     default:
468         g_assert_not_reached();
469     }
470
471     rown = n;
472     for (r = 0, y = 0; r < rows; ++r, y += eachh + linewidth)
473     {
474         for (c = 0, x = 0; c < cols; ++c, x += eachw + linewidth)
475         {
476             RrAppearance *a;
477
478             if (n < self->desks) {
479                 a = (n == self->curdesk ? self->hilight : self->unhilight);
480
481                 a->surface.parent = self->popup->a_bg;
482                 a->surface.parentx = x + px;
483                 a->surface.parenty = y + py;
484                 XMoveResizeWindow(obt_display, self->wins[n],
485                                   x + px, y + py, eachw, eachh);
486                 RrPaint(a, self->wins[n], eachw, eachh);
487             }
488             n += horz_inc;
489         }
490         n = rown += vert_inc;
491     }
492 }
493
494 ObPagerPopup *pager_popup_new(void)
495 {
496     ObPagerPopup *self;
497
498     self = g_new(ObPagerPopup, 1);
499     self->popup = popup_new();
500
501     self->desks = 0;
502     self->wins = g_new(Window, self->desks);
503     self->hilight = RrAppearanceCopy(ob_rr_theme->osd_hilite_fg);
504     self->unhilight = RrAppearanceCopy(ob_rr_theme->osd_unhilite_fg);
505
506     self->popup->hasicon = TRUE;
507     self->popup->draw_icon = pager_popup_draw_icon;
508     self->popup->draw_icon_data = self;
509
510     return self;
511 }
512
513 void pager_popup_free(ObPagerPopup *self)
514 {
515     if (self) {
516         guint i;
517
518         for (i = 0; i < self->desks; ++i)
519             XDestroyWindow(obt_display, self->wins[i]);
520         g_free(self->wins);
521         RrAppearanceFree(self->hilight);
522         RrAppearanceFree(self->unhilight);
523         popup_free(self->popup);
524         g_free(self);
525     }
526 }
527
528 void pager_popup_delay_show(ObPagerPopup *self, gulong usec,
529                             gchar *text, guint desk)
530 {
531     guint i;
532
533     if (screen_num_desktops < self->desks)
534         for (i = screen_num_desktops; i < self->desks; ++i)
535             XDestroyWindow(obt_display, self->wins[i]);
536
537     if (screen_num_desktops != self->desks)
538         self->wins = g_renew(Window, self->wins, screen_num_desktops);
539
540     if (screen_num_desktops > self->desks)
541         for (i = self->desks; i < screen_num_desktops; ++i) {
542             XSetWindowAttributes attr;
543
544             attr.border_pixel =
545                 RrColorPixel(ob_rr_theme->osd_border_color);
546             self->wins[i] = XCreateWindow(obt_display, self->popup->bg,
547                                           0, 0, 1, 1, ob_rr_theme->obwidth,
548                                           RrDepth(ob_rr_inst), InputOutput,
549                                           RrVisual(ob_rr_inst), CWBorderPixel,
550                                           &attr);
551             XMapWindow(obt_display, self->wins[i]);
552         }
553
554     self->desks = screen_num_desktops;
555     self->curdesk = desk;
556
557     popup_delay_show(self->popup, usec, text);
558 }
559
560 void pager_popup_icon_size_multiplier(ObPagerPopup *self, guint wm, guint hm)
561 {
562     /* cap them at 1 */
563     self->popup->iconwm = MAX(1, wm);
564     self->popup->iconhm = MAX(1, hm);
565 }