Fix a typo in debug message
[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_INTERNAL;
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(INTERNAL_AS_WINDOW(self));
60     window_add(&self->bg, INTERNAL_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(INTERNAL_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     g_free(area);
260
261     if (m == screen_num_monitors) {
262         RECT_SET(mon, x, y, w, h);
263         m = screen_find_monitor(&mon);
264         if (m == screen_num_monitors)
265             m = 0;
266         area = screen_physical_area_monitor(m);
267
268         x=MAX(MIN(x, area->x+area->width-w),area->x);
269         y=MAX(MIN(y, area->y+area->height-h),area->y);
270
271         g_free(area);
272     }
273
274     /* set the windows/appearances up */
275     XMoveResizeWindow(obt_display, self->bg, x, y, w, h);
276     /* when there is no icon and the text is not parent relative, then
277        fill the whole dialog with the text appearance, don't use the bg at all
278     */
279     if (self->hasicon || self->a_text->surface.grad == RR_SURFACE_PARENTREL)
280         RrPaint(self->a_bg, self->bg, w, h);
281
282     if (textw) {
283         self->a_text->surface.parent = self->a_bg;
284         self->a_text->surface.parentx = textx;
285         self->a_text->surface.parenty = texty;
286         XMoveResizeWindow(obt_display, self->text, textx, texty, textw, texth);
287         RrPaint(self->a_text, self->text, textw, texth);
288     }
289
290     if (self->hasicon)
291         self->draw_icon(iconx, icony, iconw, iconh, self->draw_icon_data);
292
293     /* do the actual showing */
294     if (!self->mapped) {
295         if (usec) {
296             /* don't kill previous show timers */
297             if (!self->delay_mapped) {
298                 obt_main_loop_timeout_add(ob_main_loop, usec,
299                                           popup_show_timeout, self,
300                                           g_direct_equal, NULL);
301                 self->delay_mapped = TRUE;
302             }
303         } else {
304             popup_show_timeout(self);
305         }
306     }
307 }
308
309 void popup_hide(ObPopup *self)
310 {
311     if (self->mapped) {
312         gulong ignore_start;
313
314         /* kill enter events cause by this unmapping */
315         ignore_start = event_start_ignore_all_enters();
316
317         XUnmapWindow(obt_display, self->bg);
318         self->mapped = FALSE;
319
320         event_end_ignore_all_enters(ignore_start);
321     } else if (self->delay_mapped) {
322         obt_main_loop_timeout_remove(ob_main_loop, popup_show_timeout);
323         self->delay_mapped = FALSE;
324     }
325 }
326
327 static void icon_popup_draw_icon(gint x, gint y, gint w, gint h, gpointer data)
328 {
329     ObIconPopup *self = data;
330
331     self->a_icon->surface.parent = self->popup->a_bg;
332     self->a_icon->surface.parentx = x;
333     self->a_icon->surface.parenty = y;
334     XMoveResizeWindow(obt_display, self->icon, x, y, w, h);
335     RrPaint(self->a_icon, self->icon, w, h);
336 }
337
338 ObIconPopup *icon_popup_new(void)
339 {
340     ObIconPopup *self;
341
342     self = g_new0(ObIconPopup, 1);
343     self->popup = popup_new();
344     self->a_icon = RrAppearanceCopy(ob_rr_theme->a_clear_tex);
345     self->icon = XCreateWindow(obt_display, self->popup->bg,
346                                0, 0, 1, 1, 0,
347                                RrDepth(ob_rr_inst), InputOutput,
348                                RrVisual(ob_rr_inst), 0, NULL);
349     XMapWindow(obt_display, self->icon);
350
351     self->popup->hasicon = TRUE;
352     self->popup->draw_icon = icon_popup_draw_icon;
353     self->popup->draw_icon_data = self;
354
355     return self;
356 }
357
358 void icon_popup_free(ObIconPopup *self)
359 {
360     if (self) {
361         XDestroyWindow(obt_display, self->icon);
362         RrAppearanceFree(self->a_icon);
363         popup_free(self->popup);
364         g_free(self);
365     }
366 }
367
368 void icon_popup_delay_show(ObIconPopup *self, gulong usec,
369                            gchar *text, RrImage *icon)
370 {
371     if (icon) {
372         RrAppearanceClearTextures(self->a_icon);
373         self->a_icon->texture[0].type = RR_TEXTURE_IMAGE;
374         self->a_icon->texture[0].data.image.alpha = 0xff;
375         self->a_icon->texture[0].data.image.image = icon;
376     } else {
377         RrAppearanceClearTextures(self->a_icon);
378         self->a_icon->texture[0].type = RR_TEXTURE_NONE;
379     }
380
381     popup_delay_show(self->popup, usec, text);
382 }
383
384 void icon_popup_icon_size_multiplier(ObIconPopup *self, guint wm, guint hm)
385 {
386     /* cap them at 1 */
387     self->popup->iconwm = MAX(1, wm);
388     self->popup->iconhm = MAX(1, hm);
389 }
390
391 static void pager_popup_draw_icon(gint px, gint py, gint w, gint h,
392                                   gpointer data)
393 {
394     ObPagerPopup *self = data;
395     gint x, y;
396     guint rown, n;
397     guint horz_inc;
398     guint vert_inc;
399     guint r, c;
400     gint eachw, eachh;
401     const guint cols = screen_desktop_layout.columns;
402     const guint rows = screen_desktop_layout.rows;
403     const gint linewidth = ob_rr_theme->obwidth;
404
405     eachw = (w - ((cols + 1) * linewidth)) / cols;
406     eachh = (h - ((rows + 1) * linewidth)) / rows;
407     /* make them squares */
408     eachw = eachh = MIN(eachw, eachh);
409
410     /* center */
411     px += (w - (cols * (eachw + linewidth) + linewidth)) / 2;
412     py += (h - (rows * (eachh + linewidth) + linewidth)) / 2;
413
414     if (eachw <= 0 || eachh <= 0)
415         return;
416
417     switch (screen_desktop_layout.orientation) {
418     case OB_ORIENTATION_HORZ:
419         switch (screen_desktop_layout.start_corner) {
420         case OB_CORNER_TOPLEFT:
421             n = 0;
422             horz_inc = 1;
423             vert_inc = cols;
424             break;
425         case OB_CORNER_TOPRIGHT:
426             n = cols - 1;
427             horz_inc = -1;
428             vert_inc = cols;
429             break;
430         case OB_CORNER_BOTTOMRIGHT:
431             n = rows * cols - 1;
432             horz_inc = -1;
433             vert_inc = -screen_desktop_layout.columns;
434             break;
435         case OB_CORNER_BOTTOMLEFT:
436             n = (rows - 1) * cols;
437             horz_inc = 1;
438             vert_inc = -cols;
439             break;
440         default:
441             g_assert_not_reached();
442         }
443         break;
444     case OB_ORIENTATION_VERT:
445         switch (screen_desktop_layout.start_corner) {
446         case OB_CORNER_TOPLEFT:
447             n = 0;
448             horz_inc = rows;
449             vert_inc = 1;
450             break;
451         case OB_CORNER_TOPRIGHT:
452             n = rows * (cols - 1);
453             horz_inc = -rows;
454             vert_inc = 1;
455             break;
456         case OB_CORNER_BOTTOMRIGHT:
457             n = rows * cols - 1;
458             horz_inc = -rows;
459             vert_inc = -1;
460             break;
461         case OB_CORNER_BOTTOMLEFT:
462             n = rows - 1;
463             horz_inc = rows;
464             vert_inc = -1;
465             break;
466         default:
467             g_assert_not_reached();
468         }
469         break;
470     default:
471         g_assert_not_reached();
472     }
473
474     rown = n;
475     for (r = 0, y = 0; r < rows; ++r, y += eachh + linewidth)
476     {
477         for (c = 0, x = 0; c < cols; ++c, x += eachw + linewidth)
478         {
479             RrAppearance *a;
480
481             if (n < self->desks) {
482                 a = (n == self->curdesk ? self->hilight : self->unhilight);
483
484                 a->surface.parent = self->popup->a_bg;
485                 a->surface.parentx = x + px;
486                 a->surface.parenty = y + py;
487                 XMoveResizeWindow(obt_display, self->wins[n],
488                                   x + px, y + py, eachw, eachh);
489                 RrPaint(a, self->wins[n], eachw, eachh);
490             }
491             n += horz_inc;
492         }
493         n = rown += vert_inc;
494     }
495 }
496
497 ObPagerPopup *pager_popup_new(void)
498 {
499     ObPagerPopup *self;
500
501     self = g_new(ObPagerPopup, 1);
502     self->popup = popup_new();
503
504     self->desks = 0;
505     self->wins = g_new(Window, self->desks);
506     self->hilight = RrAppearanceCopy(ob_rr_theme->osd_hilite_fg);
507     self->unhilight = RrAppearanceCopy(ob_rr_theme->osd_unhilite_fg);
508
509     self->popup->hasicon = TRUE;
510     self->popup->draw_icon = pager_popup_draw_icon;
511     self->popup->draw_icon_data = self;
512
513     return self;
514 }
515
516 void pager_popup_free(ObPagerPopup *self)
517 {
518     if (self) {
519         guint i;
520
521         for (i = 0; i < self->desks; ++i)
522             XDestroyWindow(obt_display, self->wins[i]);
523         g_free(self->wins);
524         RrAppearanceFree(self->hilight);
525         RrAppearanceFree(self->unhilight);
526         popup_free(self->popup);
527         g_free(self);
528     }
529 }
530
531 void pager_popup_delay_show(ObPagerPopup *self, gulong usec,
532                             gchar *text, guint desk)
533 {
534     guint i;
535
536     if (screen_num_desktops < self->desks)
537         for (i = screen_num_desktops; i < self->desks; ++i)
538             XDestroyWindow(obt_display, self->wins[i]);
539
540     if (screen_num_desktops != self->desks)
541         self->wins = g_renew(Window, self->wins, screen_num_desktops);
542
543     if (screen_num_desktops > self->desks)
544         for (i = self->desks; i < screen_num_desktops; ++i) {
545             XSetWindowAttributes attr;
546
547             attr.border_pixel =
548                 RrColorPixel(ob_rr_theme->osd_border_color);
549             self->wins[i] = XCreateWindow(obt_display, self->popup->bg,
550                                           0, 0, 1, 1, ob_rr_theme->obwidth,
551                                           RrDepth(ob_rr_inst), InputOutput,
552                                           RrVisual(ob_rr_inst), CWBorderPixel,
553                                           &attr);
554             XMapWindow(obt_display, self->wins[i]);
555         }
556
557     self->desks = screen_num_desktops;
558     self->curdesk = desk;
559
560     popup_delay_show(self->popup, usec, text);
561 }
562
563 void pager_popup_icon_size_multiplier(ObPagerPopup *self, guint wm, guint hm)
564 {
565     /* cap them at 1 */
566     self->popup->iconwm = MAX(1, wm);
567     self->popup->iconhm = MAX(1, hm);
568 }