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