Merge branch 'backport' into work
[mikachu/openbox.git] / openbox / prompt.c
1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
2
3    prompt.c for the Openbox window manager
4    Copyright (c) 2008        Dana Jansens
5
6    This program is free software; you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 2 of the License, or
9    (at your option) any later version.
10
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15
16    See the COPYING file for a copy of the GNU General Public License.
17 */
18
19 #include "prompt.h"
20 #include "openbox.h"
21 #include "screen.h"
22 #include "client.h"
23 #include "group.h"
24 #include "event.h"
25 #include "obt/display.h"
26 #include "obt/keyboard.h"
27 #include "obt/prop.h"
28 #include "gettext.h"
29
30 static GList *prompt_list = NULL;
31
32 /* we construct these */
33 static RrAppearance *prompt_a_bg;
34 static RrAppearance *prompt_a_button;
35 static RrAppearance *prompt_a_focus;
36 static RrAppearance *prompt_a_press;
37 static RrAppearance *prompt_a_pfocus;
38 /* we change the max width which would screw with others */
39 static RrAppearance *prompt_a_msg;
40
41 /* sizing stuff */
42 #define OUTSIDE_MARGIN 4
43 #define MSG_BUTTON_SEPARATION 4
44 #define BUTTON_SEPARATION 4
45 #define BUTTON_VMARGIN 4
46 #define BUTTON_HMARGIN 12
47 #define MAX_WIDTH 400
48
49 static void prompt_layout(ObPrompt *self);
50 static void render_all(ObPrompt *self);
51 static void render_button(ObPrompt *self, ObPromptElement *e);
52 static void prompt_resize(ObPrompt *self, gint w, gint h);
53
54 void prompt_startup(gboolean reconfig)
55 {
56     RrColor *c_button, *c_focus, *c_press, *c_pfocus;
57
58     /* note: this is not a copy, don't free it */
59     prompt_a_bg = ob_rr_theme->osd_hilite_bg;
60
61     prompt_a_button = RrAppearanceCopy(ob_rr_theme->a_focused_unpressed_close);
62     prompt_a_focus = RrAppearanceCopy(ob_rr_theme->a_hover_focused_close);
63     prompt_a_press = RrAppearanceCopy(ob_rr_theme->a_focused_pressed_close);
64     prompt_a_pfocus = RrAppearanceCopy(ob_rr_theme->a_focused_pressed_close);
65
66     c_button = prompt_a_button->texture[0].data.mask.color;
67     c_focus = prompt_a_focus->texture[0].data.mask.color;
68     c_press = prompt_a_press->texture[0].data.mask.color;
69     c_pfocus = prompt_a_press->texture[0].data.mask.color;
70
71     RrAppearanceRemoveTextures(prompt_a_button);
72     RrAppearanceRemoveTextures(prompt_a_focus);
73     RrAppearanceRemoveTextures(prompt_a_press);
74     RrAppearanceRemoveTextures(prompt_a_pfocus);
75
76     /* texture[0] is the text and texture[1-4] (for prompt_a_focus and
77        prompt_a_pfocus) is lineart to show where keyboard focus is */
78     RrAppearanceAddTextures(prompt_a_button, 1);
79     RrAppearanceAddTextures(prompt_a_focus, 5);
80     RrAppearanceAddTextures(prompt_a_press, 1);
81     RrAppearanceAddTextures(prompt_a_pfocus, 5);
82
83     /* totally cheating here.. */
84     prompt_a_button->texture[0] = ob_rr_theme->osd_hilite_label->texture[0];
85     prompt_a_focus->texture[0] = ob_rr_theme->osd_hilite_label->texture[0];
86     prompt_a_press->texture[0] = ob_rr_theme->osd_hilite_label->texture[0];
87     prompt_a_pfocus->texture[0] = ob_rr_theme->osd_hilite_label->texture[0];
88
89     prompt_a_button->texture[0].data.text.justify = RR_JUSTIFY_CENTER;
90     prompt_a_focus->texture[0].data.text.justify = RR_JUSTIFY_CENTER;
91     prompt_a_press->texture[0].data.text.justify = RR_JUSTIFY_CENTER;
92     prompt_a_pfocus->texture[0].data.text.justify = RR_JUSTIFY_CENTER;
93
94     prompt_a_button->texture[0].data.text.color = c_button;
95     prompt_a_focus->texture[0].data.text.color = c_focus;
96     prompt_a_press->texture[0].data.text.color = c_press;
97     prompt_a_pfocus->texture[0].data.text.color = c_press;
98
99     prompt_a_focus->texture[1].data.lineart.color = c_focus;
100     prompt_a_focus->texture[2].data.lineart.color = c_focus;
101     prompt_a_focus->texture[3].data.lineart.color = c_focus;
102     prompt_a_focus->texture[4].data.lineart.color = c_focus;
103
104     prompt_a_pfocus->texture[1].data.lineart.color = c_press;
105     prompt_a_pfocus->texture[2].data.lineart.color = c_press;
106     prompt_a_pfocus->texture[3].data.lineart.color = c_press;
107     prompt_a_pfocus->texture[4].data.lineart.color = c_press;
108
109     prompt_a_msg = RrAppearanceCopy(ob_rr_theme->osd_hilite_label);
110     prompt_a_msg->texture[0].data.text.flow = TRUE;
111
112     if (reconfig) {
113         GList *it;
114         for (it = prompt_list; it; it = g_list_next(it)) {
115             ObPrompt *p = it->data;
116             prompt_layout(p);
117             render_all(p);
118         }
119     }
120 }
121
122 void prompt_shutdown(gboolean reconfig)
123 {
124     RrAppearanceFree(prompt_a_button);
125     RrAppearanceFree(prompt_a_focus);
126     RrAppearanceFree(prompt_a_press);
127     RrAppearanceFree(prompt_a_pfocus);
128     RrAppearanceFree(prompt_a_msg);
129 }
130
131 ObPrompt* prompt_new(const gchar *msg,
132                      const ObPromptAnswer *answers, gint n_answers,
133                      gint default_result, gint cancel_result,
134                      ObPromptCallback func, gpointer data)
135 {
136     ObPrompt *self;
137     XSetWindowAttributes attrib;
138     gint i;
139
140     attrib.override_redirect = FALSE;
141
142     self = g_new0(ObPrompt, 1);
143     self->ref = 1;
144     self->func = func;
145     self->data = data;
146     self->default_result = default_result;
147     self->cancel_result = cancel_result;
148     self->super.type = OB_WINDOW_CLASS_PROMPT;
149     self->super.window = XCreateWindow(obt_display, obt_root(ob_screen),
150                                        0, 0, 1, 1, 0,
151                                        CopyFromParent, InputOutput,
152                                        CopyFromParent,
153                                        CWOverrideRedirect,
154                                        &attrib);
155
156     /* make it a dialog type window */
157     OBT_PROP_SET32(self->super.window, NET_WM_WINDOW_TYPE, ATOM,
158                    OBT_PROP_ATOM(NET_WM_WINDOW_TYPE_DIALOG));
159
160     /* listen for key presses on the window */
161     self->event_mask = KeyPressMask;
162
163     /* set up the text message widow */
164     self->msg.text = g_strdup(msg);
165     self->msg.window = XCreateWindow(obt_display, self->super.window,
166                                      0, 0, 1, 1, 0,
167                                      CopyFromParent, InputOutput,
168                                      CopyFromParent, 0, NULL);
169     XMapWindow(obt_display, self->msg.window);
170
171     /* set up the buttons from the answers */
172
173     self->n_buttons = n_answers;
174     if (!self->n_buttons)
175         self->n_buttons = 1;
176
177     self->button = g_new0(ObPromptElement, self->n_buttons);
178
179     if (n_answers == 0) {
180         g_assert(self->n_buttons == 1); /* should be set to this above.. */
181         self->button[0].text = g_strdup(_("OK"));
182     }
183     else {
184         g_assert(self->n_buttons > 0);
185         for (i = 0; i < self->n_buttons; ++i) {
186             self->button[i].text = g_strdup(answers[i].text);
187             self->button[i].result = answers[i].result;
188         }
189     }
190
191     for (i = 0; i < self->n_buttons; ++i) {
192         self->button[i].window = XCreateWindow(obt_display, self->super.window,
193                                                0, 0, 1, 1, 0,
194                                                CopyFromParent, InputOutput,
195                                                CopyFromParent, 0, NULL);
196         XMapWindow(obt_display, self->button[i].window);
197         window_add(&self->button[i].window, PROMPT_AS_WINDOW(self));
198
199         /* listen for button presses on the buttons */
200         XSelectInput(obt_display, self->button[i].window,
201                      ButtonPressMask | ButtonReleaseMask | ButtonMotionMask);
202     }
203
204     prompt_list = g_list_prepend(prompt_list, self);
205
206     return self;
207 }
208
209 void prompt_ref(ObPrompt *self)
210 {
211     ++self->ref;
212 }
213
214 void prompt_unref(ObPrompt *self)
215 {
216     if (self && --self->ref == 0) {
217         gint i;
218
219         prompt_list = g_list_remove(prompt_list, self);
220
221         for (i = 0; i < self->n_buttons; ++i) {
222             window_remove(self->button[i].window);
223             XDestroyWindow(obt_display, self->button[i].window);
224         }
225
226         XDestroyWindow(obt_display, self->msg.window);
227         XDestroyWindow(obt_display, self->super.window);
228         g_free(self);
229     }
230 }
231
232 static void prompt_layout(ObPrompt *self)
233 {
234     gint l, r, t, b;
235     gint i;
236     gint allbuttonsw, allbuttonsh, buttonx;
237     gint w, h;
238     gint maxw;
239
240     RrMargins(prompt_a_bg, &l, &t, &r, &b);
241     l += OUTSIDE_MARGIN;
242     t += OUTSIDE_MARGIN;
243     r += OUTSIDE_MARGIN;
244     b += OUTSIDE_MARGIN;
245
246     {
247         Rect *area = screen_physical_area_all_monitors();
248         maxw = MIN(MAX_WIDTH, area->width*4/5);
249         g_free(area);
250     }
251
252     /* find the button sizes and how much space we need for them */
253     allbuttonsw = allbuttonsh = 0;
254     for (i = 0; i < self->n_buttons; ++i) {
255         gint bw, bh;
256
257         prompt_a_button->texture[0].data.text.string = self->button[i].text;
258         prompt_a_focus->texture[0].data.text.string = self->button[i].text;
259         prompt_a_press->texture[0].data.text.string = self->button[i].text;
260         prompt_a_pfocus->texture[0].data.text.string = self->button[i].text;
261         RrMinSize(prompt_a_button, &bw, &bh);
262         self->button[i].width = bw;
263         self->button[i].height = bh;
264         RrMinSize(prompt_a_focus, &bw, &bh);
265         self->button[i].width = MAX(self->button[i].width, bw);
266         self->button[i].height = MAX(self->button[i].height, bh);
267         RrMinSize(prompt_a_press, &bw, &bh);
268         self->button[i].width = MAX(self->button[i].width, bw);
269         self->button[i].height = MAX(self->button[i].height, bh);
270         RrMinSize(prompt_a_pfocus, &bw, &bh);
271         self->button[i].width = MAX(self->button[i].width, bw);
272         self->button[i].height = MAX(self->button[i].height, bh);
273
274
275         self->button[i].width += BUTTON_HMARGIN * 2;
276         self->button[i].height += BUTTON_VMARGIN * 2;
277
278         allbuttonsw += self->button[i].width + (i > 0 ? BUTTON_SEPARATION : 0);
279         allbuttonsh = MAX(allbuttonsh, self->button[i].height);
280     }
281
282     self->msg_wbound = MAX(allbuttonsw, maxw);
283
284     /* measure the text message area */
285     prompt_a_msg->texture[0].data.text.string = self->msg.text;
286     prompt_a_msg->texture[0].data.text.maxwidth = self->msg_wbound;
287     RrMinSize(prompt_a_msg, &self->msg.width, &self->msg.height);
288
289     /* width and height inside the outer margins */
290     w = MAX(self->msg.width, allbuttonsw);
291     h = self->msg.height + MSG_BUTTON_SEPARATION + allbuttonsh;
292
293     /* position the text message */
294     self->msg.x = l + (w - self->msg.width) / 2;
295     self->msg.y = t;
296
297     /* position the button buttons on the right of the dialog */
298     buttonx = l + w;
299     for (i = self->n_buttons - 1; i >= 0; --i) {
300         self->button[i].x = buttonx - self->button[i].width;
301         buttonx -= self->button[i].width + BUTTON_SEPARATION;
302         self->button[i].y = t + h - allbuttonsh;
303         self->button[i].y += (allbuttonsh - self->button[i].height) / 2;
304     }
305
306     /* size and position the toplevel window */
307     prompt_resize(self, w + l + r, h + t + b);
308
309     /* move and resize the internal windows */
310     XMoveResizeWindow(obt_display, self->msg.window,
311                       self->msg.x, self->msg.y,
312                       self->msg.width, self->msg.height);
313     for (i = 0; i < self->n_buttons; ++i)
314         XMoveResizeWindow(obt_display, self->button[i].window,
315                           self->button[i].x, self->button[i].y,
316                           self->button[i].width, self->button[i].height);
317 }
318
319 static void prompt_resize(ObPrompt *self, gint w, gint h)
320 {
321     XConfigureRequestEvent req;
322     XSizeHints hints;
323
324     self->width = w;
325     self->height = h;
326
327     /* the user can't resize the prompt */
328     hints.flags = PMinSize | PMaxSize;
329     hints.min_width = hints.max_width = w;
330     hints.min_height = hints.max_height = h;
331     XSetWMNormalHints(obt_display, self->super.window, &hints);
332
333     if (self->mapped) {
334         /* send a configure request like a normal client would */
335         req.type = ConfigureRequest;
336         req.display = obt_display;
337         req.parent = obt_root(ob_screen);
338         req.window = self->super.window;
339         req.width = w;
340         req.height = h;
341         req.value_mask = CWWidth | CWHeight;
342         XSendEvent(req.display, req.window, FALSE, StructureNotifyMask,
343                    (XEvent*)&req);
344     }
345     else
346         XResizeWindow(obt_display, self->super.window, w, h);
347 }
348
349 static void setup_button_focus_tex(ObPromptElement *e, RrAppearance *a,
350                                    gboolean on)
351 {
352     gint i, l, r, t, b;
353
354     for (i = 1; i < 5; ++i)
355         a->texture[i].type = on ? RR_TEXTURE_LINE_ART : RR_TEXTURE_NONE;
356
357     if (!on) return;
358
359     RrMargins(a, &l, &t, &r, &b);
360     l += MIN(BUTTON_HMARGIN, BUTTON_VMARGIN) / 2;
361     r += MIN(BUTTON_HMARGIN, BUTTON_VMARGIN) / 2;
362     t += MIN(BUTTON_HMARGIN, BUTTON_VMARGIN) / 2;
363     b += MIN(BUTTON_HMARGIN, BUTTON_VMARGIN) / 2;
364
365     /* top line */
366     a->texture[1].data.lineart.x1 = l;
367     a->texture[1].data.lineart.x2 = e->width - r - 1;
368     a->texture[1].data.lineart.y1 = t;
369     a->texture[1].data.lineart.y2 = t;
370
371     /* bottom line */
372     a->texture[2].data.lineart.x1 = l;
373     a->texture[2].data.lineart.x2 = e->width - r - 1;
374     a->texture[2].data.lineart.y1 = e->height - b - 1;
375     a->texture[2].data.lineart.y2 = e->height - b - 1;
376
377     /* left line */
378     a->texture[3].data.lineart.x1 = l;
379     a->texture[3].data.lineart.x2 = l;
380     a->texture[3].data.lineart.y1 = t;
381     a->texture[3].data.lineart.y2 = e->height - b - 1;
382
383     /* right line */
384     a->texture[4].data.lineart.x1 = e->width - r - 1;
385     a->texture[4].data.lineart.x2 = e->width - r - 1;
386     a->texture[4].data.lineart.y1 = t;
387     a->texture[4].data.lineart.y2 = e->height - b - 1;
388 }
389
390 static void render_button(ObPrompt *self, ObPromptElement *e)
391 {
392     RrAppearance *a;
393
394     if (e->pressed && self->focus == e) a = prompt_a_pfocus;
395     else if (self->focus == e)          a = prompt_a_focus;
396     else if (e->pressed)                a = prompt_a_press;
397     else                                a = prompt_a_button;
398
399     a->surface.parent = prompt_a_bg;
400     a->surface.parentx = e->x;
401     a->surface.parenty = e->y;
402
403     /* draw the keyfocus line */
404     if (a == prompt_a_pfocus || a == prompt_a_focus)
405         setup_button_focus_tex(e, a, TRUE);
406
407     a->texture[0].data.text.string = e->text;
408     RrPaint(a, e->window, e->width, e->height);
409
410     /* turn off the keyfocus line so that it doesn't affect size calculations
411      */
412     if (a == prompt_a_pfocus || a == prompt_a_focus)
413         setup_button_focus_tex(e, a, FALSE);
414 }
415
416 static void render_all(ObPrompt *self)
417 {
418     gint i;
419
420     RrPaint(prompt_a_bg, self->super.window, self->width, self->height);
421
422     prompt_a_msg->surface.parent = prompt_a_bg;
423     prompt_a_msg->surface.parentx = self->msg.x;
424     prompt_a_msg->surface.parenty = self->msg.y;
425
426     prompt_a_msg->texture[0].data.text.string = self->msg.text;
427     prompt_a_msg->texture[0].data.text.maxwidth = self->msg_wbound;
428     RrPaint(prompt_a_msg, self->msg.window, self->msg.width, self->msg.height);
429
430     for (i = 0; i < self->n_buttons; ++i)
431         render_button(self, &self->button[i]);
432 }
433
434 void prompt_show(ObPrompt *self, ObClient *parent, gboolean modal)
435 {
436     gint i;
437
438     if (self->mapped) {
439         /* activate the prompt */
440         OBT_PROP_MSG(ob_screen, self->super.window, NET_ACTIVE_WINDOW,
441                      1, /* from an application.. */
442                      event_curtime,
443                      0,
444                      0, 0);
445         return;
446     }
447
448     /* set the focused button (if not found then the first button is used) */
449     self->focus = &self->button[0];
450     for (i = 0; i < self->n_buttons; ++i)
451         if (self->button[i].result == self->default_result) {
452             self->focus = &self->button[i];
453             break;
454         }
455
456     if (parent) {
457         Atom states[1];
458         gint nstates;
459         Window p;
460         XWMHints h;
461
462         if (parent->group) {
463             /* make it transient for the window's group */
464             h.flags = WindowGroupHint;
465             h.window_group = parent->group->leader;
466             p = obt_root(ob_screen);
467         }
468         else {
469             /* make it transient for the window directly */
470             h.flags = 0;
471             p = parent->window;
472         }
473
474         XSetWMHints(obt_display, self->super.window, &h);
475         OBT_PROP_SET32(self->super.window, WM_TRANSIENT_FOR, WINDOW, p);
476
477         states[0] = OBT_PROP_ATOM(NET_WM_STATE_MODAL);
478         nstates = (modal ? 1 : 0);
479         OBT_PROP_SETA32(self->super.window, NET_WM_STATE, ATOM,
480                         states, nstates);
481     }
482     else
483         OBT_PROP_ERASE(self->super.window, WM_TRANSIENT_FOR);
484
485     /* set up the dialog and render it */
486     prompt_layout(self);
487     render_all(self);
488
489     client_manage(self->super.window, self);
490
491     self->mapped = TRUE;
492 }
493
494 void prompt_hide(ObPrompt *self)
495 {
496     XUnmapWindow(obt_display, self->super.window);
497     self->mapped = FALSE;
498 }
499
500 gboolean prompt_key_event(ObPrompt *self, XEvent *e)
501 {
502     gboolean shift;
503     guint shift_mask;
504
505     if (e->type != KeyPress) return FALSE;
506
507     shift_mask = obt_keyboard_modkey_to_modmask(OBT_KEYBOARD_MODKEY_SHIFT);
508     shift = !!(e->xkey.state & shift_mask);
509
510     /* only accept shift */
511     if (e->xkey.state != 0 && e->xkey.state != shift_mask)
512         return FALSE;
513
514     if (e->xkey.keycode == ob_keycode(OB_KEY_ESCAPE))
515         prompt_cancel(self);
516     else if (e->xkey.keycode == ob_keycode(OB_KEY_RETURN) ||
517              e->xkey.keycode == ob_keycode(OB_KEY_SPACE))
518     {
519         if (self->func) self->func(self, self->focus->result, self->data);
520         prompt_hide(self);
521     }
522     else if (e->xkey.keycode == ob_keycode(OB_KEY_TAB) ||
523              e->xkey.keycode == ob_keycode(OB_KEY_LEFT) ||
524              e->xkey.keycode == ob_keycode(OB_KEY_RIGHT))
525     {
526         gint i;
527         gboolean left;
528         ObPromptElement *oldfocus;
529
530         left = e->xkey.keycode == ob_keycode(OB_KEY_LEFT) ||
531             (e->xkey.keycode == ob_keycode(OB_KEY_TAB) && shift);
532         oldfocus = self->focus;
533
534         for (i = 0; i < self->n_buttons; ++i)
535             if (self->focus == &self->button[i]) break;
536         i += (left ? -1 : 1);
537         if (i < 0) i = self->n_buttons - 1;
538         else if (i >= self->n_buttons) i = 0;
539         self->focus = &self->button[i];
540
541         if (oldfocus != self->focus) render_button(self, oldfocus);
542         render_button(self, self->focus);
543     }
544     return TRUE;
545 }
546
547 gboolean prompt_mouse_event(ObPrompt *self, XEvent *e)
548 {
549     gint i;
550     ObPromptElement *but;
551
552     if (e->type != ButtonPress && e->type != ButtonRelease &&
553         e->type != MotionNotify) return FALSE;
554
555     /* find the button */
556     but = NULL;
557     for (i = 0; i < self->n_buttons; ++i)
558         if (self->button[i].window ==
559             (e->type == MotionNotify ? e->xmotion.window : e->xbutton.window))
560         {
561             but = &self->button[i];
562             break;
563         }
564     if (!but) return FALSE;
565
566     if (e->type == ButtonPress) {
567         ObPromptElement *oldfocus;
568
569         oldfocus = self->focus;
570
571         but->pressed = TRUE;
572         self->focus = but;
573
574         if (oldfocus != but) render_button(self, oldfocus);
575         render_button(self, but);
576     }
577     else if (e->type == ButtonRelease) {
578         if (but->pressed) {
579             if (self->func) self->func(self, but->result, self->data);
580             prompt_hide(self);
581         }
582     }
583     else if (e->type == MotionNotify) {
584         gboolean press;
585
586         press = (e->xmotion.x >= 0 && e->xmotion.y >= 0 &&
587                  e->xmotion.x < but->width && e->xmotion.y < but->height);
588
589         if (press != but->pressed) {
590             but->pressed = press;
591             render_button(self, but);
592         }
593     }
594     return TRUE;
595 }
596
597 void prompt_cancel(ObPrompt *self)
598 {
599     if (self->func) self->func(self, self->cancel_result, self->data);
600     prompt_hide(self);
601 }