0278757eadbf29fd9e9f0768abc45c207dd63af2
[dana/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 "openbox.h"
23 #include "client.h"
24 #include "group.h"
25 #include "prop.h"
26 #include "modkeys.h"
27 #include "event.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 = Window_Prompt;
149     self->super.window = XCreateWindow(ob_display,
150                                        RootWindow(ob_display, ob_screen),
151                                        0, 0, 1, 1, 0,
152                                        CopyFromParent, InputOutput,
153                                        CopyFromParent,
154                                        CWOverrideRedirect,
155                                        &attrib);
156
157     /* make it a dialog type window */
158     PROP_SET32(self->super.window, net_wm_window_type, atom,
159                prop_atoms.net_wm_window_type_dialog);
160
161     /* listen for key presses on the window */
162     self->event_mask = KeyPressMask;
163
164     /* set up the text message widow */
165     self->msg.text = g_strdup(msg);
166     self->msg.window = XCreateWindow(ob_display, self->super.window,
167                                      0, 0, 1, 1, 0,
168                                      CopyFromParent, InputOutput,
169                                      CopyFromParent, 0, NULL);
170     XMapWindow(ob_display, self->msg.window);
171
172     /* set up the buttons from the answers */
173
174     self->n_buttons = n_answers;
175     if (!self->n_buttons)
176         self->n_buttons = 1;
177
178     self->button = g_new0(ObPromptElement, self->n_buttons);
179
180     if (n_answers == 0) {
181         g_assert(self->n_buttons == 1); /* should be set to this above.. */
182         self->button[0].text = g_strdup(_("OK"));
183     }
184     else {
185         g_assert(self->n_buttons > 0);
186         for (i = 0; i < self->n_buttons; ++i) {
187             self->button[i].text = g_strdup(answers[i].text);
188             self->button[i].result = answers[i].result;
189         }
190     }
191
192     for (i = 0; i < self->n_buttons; ++i) {
193         self->button[i].window = XCreateWindow(ob_display, self->super.window,
194                                                0, 0, 1, 1, 0,
195                                                CopyFromParent, InputOutput,
196                                                CopyFromParent, 0, NULL);
197         XMapWindow(ob_display, self->button[i].window);
198         g_hash_table_insert(window_map, &self->button[i].window,
199                             PROMPT_AS_WINDOW(self));
200
201         /* listen for button presses on the buttons */
202         XSelectInput(ob_display, self->button[i].window,
203                      ButtonPressMask | ButtonReleaseMask | ButtonMotionMask);
204     }
205
206     prompt_list = g_list_prepend(prompt_list, self);
207
208     return self;
209 }
210
211 void prompt_ref(ObPrompt *self)
212 {
213     ++self->ref;
214 }
215
216 void prompt_unref(ObPrompt *self)
217 {
218     if (self && --self->ref == 0) {
219         gint i;
220
221         prompt_list = g_list_remove(prompt_list, self);
222
223         for (i = 0; i < self->n_buttons; ++i) {
224             g_hash_table_remove(window_map, &self->button[i].window);
225             XDestroyWindow(ob_display, self->button[i].window);
226         }
227
228         XDestroyWindow(ob_display, self->msg.window);
229         XDestroyWindow(ob_display, self->super.window);
230         g_free(self);
231     }
232 }
233
234 static void prompt_layout(ObPrompt *self)
235 {
236     gint l, r, t, b;
237     gint i;
238     gint allbuttonsw, allbuttonsh, buttonx;
239     gint w, h;
240     gint maxw;
241
242     RrMargins(prompt_a_bg, &l, &t, &r, &b);
243     l += OUTSIDE_MARGIN;
244     t += OUTSIDE_MARGIN;
245     r += OUTSIDE_MARGIN;
246     b += OUTSIDE_MARGIN;
247
248     {
249         Rect *area = screen_physical_area_all_monitors();
250         maxw = MIN(MAX_WIDTH, area->width*4/5);
251         g_free(area);
252     }
253
254     /* find the button sizes and how much space we need for them */
255     allbuttonsw = allbuttonsh = 0;
256     for (i = 0; i < self->n_buttons; ++i) {
257         gint bw, bh;
258
259         prompt_a_button->texture[0].data.text.string = self->button[i].text;
260         prompt_a_focus->texture[0].data.text.string = self->button[i].text;
261         prompt_a_press->texture[0].data.text.string = self->button[i].text;
262         prompt_a_pfocus->texture[0].data.text.string = self->button[i].text;
263         RrMinSize(prompt_a_button, &bw, &bh);
264         self->button[i].width = bw;
265         self->button[i].height = bh;
266         RrMinSize(prompt_a_focus, &bw, &bh);
267         self->button[i].width = MAX(self->button[i].width, bw);
268         self->button[i].height = MAX(self->button[i].height, bh);
269         RrMinSize(prompt_a_press, &bw, &bh);
270         self->button[i].width = MAX(self->button[i].width, bw);
271         self->button[i].height = MAX(self->button[i].height, bh);
272         RrMinSize(prompt_a_pfocus, &bw, &bh);
273         self->button[i].width = MAX(self->button[i].width, bw);
274         self->button[i].height = MAX(self->button[i].height, bh);
275
276
277         self->button[i].width += BUTTON_HMARGIN * 2;
278         self->button[i].height += BUTTON_VMARGIN * 2;
279
280         allbuttonsw += self->button[i].width + (i > 0 ? BUTTON_SEPARATION : 0);
281         allbuttonsh = MAX(allbuttonsh, self->button[i].height);
282     }
283
284     self->msg_wbound = MAX(allbuttonsw, maxw);
285
286     /* measure the text message area */
287     prompt_a_msg->texture[0].data.text.string = self->msg.text;
288     prompt_a_msg->texture[0].data.text.maxwidth = self->msg_wbound;
289     RrMinSize(prompt_a_msg, &self->msg.width, &self->msg.height);
290
291     /* width and height inside the outer margins */
292     w = MAX(self->msg.width, allbuttonsw);
293     h = self->msg.height + MSG_BUTTON_SEPARATION + allbuttonsh;
294
295     /* position the text message */
296     self->msg.x = l + (w - self->msg.width) / 2;
297     self->msg.y = t;
298
299     /* position the button buttons on the right of the dialog */
300     buttonx = l + w;
301     for (i = self->n_buttons - 1; i >= 0; --i) {
302         self->button[i].x = buttonx - self->button[i].width;
303         buttonx -= self->button[i].width + BUTTON_SEPARATION;
304         self->button[i].y = t + h - allbuttonsh;
305         self->button[i].y += (allbuttonsh - self->button[i].height) / 2;
306     }
307
308     /* size and position the toplevel window */
309     prompt_resize(self, w + l + r, h + t + b);
310
311     /* move and resize the internal windows */
312     XMoveResizeWindow(ob_display, self->msg.window,
313                       self->msg.x, self->msg.y,
314                       self->msg.width, self->msg.height);
315     for (i = 0; i < self->n_buttons; ++i)
316         XMoveResizeWindow(ob_display, self->button[i].window,
317                           self->button[i].x, self->button[i].y,
318                           self->button[i].width, self->button[i].height);
319 }
320
321 static void prompt_resize(ObPrompt *self, gint w, gint h)
322 {
323     XConfigureRequestEvent req;
324     XSizeHints hints;
325
326     self->width = w;
327     self->height = h;
328
329     /* the user can't resize the prompt */
330     hints.flags = PMinSize | PMaxSize;
331     hints.min_width = hints.max_width = w;
332     hints.min_height = hints.max_height = h;
333     XSetWMNormalHints(ob_display, self->super.window, &hints);
334
335     if (self->mapped) {
336         /* send a configure request like a normal client would */
337         req.type = ConfigureRequest;
338         req.display = ob_display;
339         req.parent = RootWindow(ob_display, ob_screen);
340         req.window = self->super.window;
341         req.width = w;
342         req.height = h;
343         req.value_mask = CWWidth | CWHeight;
344         XSendEvent(req.display, req.window, FALSE, StructureNotifyMask,
345                    (XEvent*)&req);
346     }
347     else
348         XResizeWindow(ob_display, self->super.window, w, h);
349 }
350
351 static void setup_button_focus_tex(ObPromptElement *e, RrAppearance *a,
352                                    gboolean on)
353 {
354     gint i, l, r, t, b;
355
356     for (i = 1; i < 5; ++i)
357         a->texture[i].type = on ? RR_TEXTURE_LINE_ART : RR_TEXTURE_NONE;
358
359     if (!on) return;
360
361     RrMargins(a, &l, &t, &r, &b);
362     l += MIN(BUTTON_HMARGIN, BUTTON_VMARGIN) / 2;
363     r += MIN(BUTTON_HMARGIN, BUTTON_VMARGIN) / 2;
364     t += MIN(BUTTON_HMARGIN, BUTTON_VMARGIN) / 2;
365     b += MIN(BUTTON_HMARGIN, BUTTON_VMARGIN) / 2;
366
367     /* top line */
368     a->texture[1].data.lineart.x1 = l;
369     a->texture[1].data.lineart.x2 = e->width - r - 1;
370     a->texture[1].data.lineart.y1 = t;
371     a->texture[1].data.lineart.y2 = t;
372
373     /* bottom line */
374     a->texture[2].data.lineart.x1 = l;
375     a->texture[2].data.lineart.x2 = e->width - r - 1;
376     a->texture[2].data.lineart.y1 = e->height - b - 1;
377     a->texture[2].data.lineart.y2 = e->height - b - 1;
378
379     /* left line */
380     a->texture[3].data.lineart.x1 = l;
381     a->texture[3].data.lineart.x2 = l;
382     a->texture[3].data.lineart.y1 = t;
383     a->texture[3].data.lineart.y2 = e->height - b - 1;
384
385     /* right line */
386     a->texture[4].data.lineart.x1 = e->width - r - 1;
387     a->texture[4].data.lineart.x2 = e->width - r - 1;
388     a->texture[4].data.lineart.y1 = t;
389     a->texture[4].data.lineart.y2 = e->height - b - 1;
390 }
391
392 static void render_button(ObPrompt *self, ObPromptElement *e)
393 {
394     RrAppearance *a;
395
396     if (e->pressed && self->focus == e) a = prompt_a_pfocus;
397     else if (self->focus == e)          a = prompt_a_focus;
398     else if (e->pressed)                a = prompt_a_press;
399     else                                a = prompt_a_button;
400
401     a->surface.parent = prompt_a_bg;
402     a->surface.parentx = e->x;
403     a->surface.parenty = e->y;
404
405     /* draw the keyfocus line */
406     if (a == prompt_a_pfocus || a == prompt_a_focus)
407         setup_button_focus_tex(e, a, TRUE);
408
409     a->texture[0].data.text.string = e->text;
410     RrPaint(a, e->window, e->width, e->height);
411
412     /* turn off the keyfocus line so that it doesn't affect size calculations
413      */
414     if (a == prompt_a_pfocus || a == prompt_a_focus)
415         setup_button_focus_tex(e, a, FALSE);
416 }
417
418 static void render_all(ObPrompt *self)
419 {
420     gint i;
421
422     RrPaint(prompt_a_bg, self->super.window, self->width, self->height);
423
424     prompt_a_msg->surface.parent = prompt_a_bg;
425     prompt_a_msg->surface.parentx = self->msg.x;
426     prompt_a_msg->surface.parenty = self->msg.y;
427
428     prompt_a_msg->texture[0].data.text.string = self->msg.text;
429     prompt_a_msg->texture[0].data.text.maxwidth = self->msg_wbound;
430     RrPaint(prompt_a_msg, self->msg.window, self->msg.width, self->msg.height);
431
432     for (i = 0; i < self->n_buttons; ++i)
433         render_button(self, &self->button[i]);
434 }
435
436 void prompt_show(ObPrompt *self, ObClient *parent, gboolean modal)
437 {
438     gint i;
439
440     if (self->mapped) {
441         /* activate the prompt */
442         PROP_MSG(self->super.window, net_active_window,
443                  1, /* from an application.. */
444                  event_curtime,
445                  0,
446                  0);
447         return;
448     }
449
450     /* set the focused button (if not found then the first button is used) */
451     self->focus = &self->button[0];
452     for (i = 0; i < self->n_buttons; ++i)
453         if (self->button[i].result == self->default_result) {
454             self->focus = &self->button[i];
455             break;
456         }
457
458     if (parent) {
459         Atom states[1];
460         gint nstates;
461         Window p;
462         XWMHints h;
463
464         if (parent->group) {
465             /* make it transient for the window's group */
466             h.flags = WindowGroupHint;
467             h.window_group = parent->group->leader;
468             p = RootWindow(ob_display, ob_screen);
469         }
470         else {
471             /* make it transient for the window directly */
472             h.flags = 0;
473             p = parent->window;
474         }
475
476         XSetWMHints(ob_display, self->super.window, &h);
477         PROP_SET32(self->super.window, wm_transient_for, window, p);
478
479         states[0] = prop_atoms.net_wm_state_modal;
480         nstates = (modal ? 1 : 0);
481         PROP_SETA32(self->super.window, net_wm_state, atom, states, nstates);
482     }
483     else
484         PROP_ERASE(self->super.window, wm_transient_for);
485
486     /* set up the dialog and render it */
487     prompt_layout(self);
488     render_all(self);
489
490     client_manage(self->super.window, self);
491
492     self->mapped = TRUE;
493 }
494
495 void prompt_hide(ObPrompt *self)
496 {
497     XUnmapWindow(ob_display, self->super.window);
498     self->mapped = FALSE;
499 }
500
501 gboolean prompt_key_event(ObPrompt *self, XEvent *e)
502 {
503     gboolean shift;
504     guint shift_mask;
505
506     if (e->type != KeyPress) return FALSE;
507
508     shift_mask = modkeys_key_to_mask(OB_MODKEY_KEY_SHIFT);
509     shift = !!(e->xkey.state & shift_mask);
510
511     /* only accept shift */
512     if (e->xkey.state != 0 && e->xkey.state != shift_mask)
513         return FALSE;
514
515     if (e->xkey.keycode == ob_keycode(OB_KEY_ESCAPE))
516         prompt_cancel(self);
517     else if (e->xkey.keycode == ob_keycode(OB_KEY_RETURN) ||
518              e->xkey.keycode == ob_keycode(OB_KEY_SPACE))
519     {
520         if (self->func) self->func(self, self->focus->result, self->data);
521         prompt_hide(self);
522     }
523     else if (e->xkey.keycode == ob_keycode(OB_KEY_TAB) ||
524              e->xkey.keycode == ob_keycode(OB_KEY_LEFT) ||
525              e->xkey.keycode == ob_keycode(OB_KEY_RIGHT))
526     {
527         gint i;
528         gboolean left;
529         ObPromptElement *oldfocus;
530
531         left = e->xkey.keycode == ob_keycode(OB_KEY_LEFT) ||
532             (e->xkey.keycode == ob_keycode(OB_KEY_TAB) && shift);
533         oldfocus = self->focus;
534
535         for (i = 0; i < self->n_buttons; ++i)
536             if (self->focus == &self->button[i]) break;
537         i += (left ? -1 : 1);
538         if (i < 0) i = self->n_buttons - 1;
539         else if (i >= self->n_buttons) i = 0;
540         self->focus = &self->button[i];
541
542         if (oldfocus != self->focus) render_button(self, oldfocus);
543         render_button(self, self->focus);
544     }
545     return TRUE;
546 }
547
548 gboolean prompt_mouse_event(ObPrompt *self, XEvent *e)
549 {
550     gint i;
551     ObPromptElement *but;
552
553     if (e->type != ButtonPress && e->type != ButtonRelease &&
554         e->type != MotionNotify) return FALSE;
555
556     /* find the button */
557     but = NULL;
558     for (i = 0; i < self->n_buttons; ++i)
559         if (self->button[i].window ==
560             (e->type == MotionNotify ? e->xmotion.window : e->xbutton.window))
561         {
562             but = &self->button[i];
563             break;
564         }
565     if (!but) return FALSE;
566
567     if (e->type == ButtonPress) {
568         ObPromptElement *oldfocus;
569
570         oldfocus = self->focus;
571
572         but->pressed = TRUE;
573         self->focus = but;
574
575         if (oldfocus != but) render_button(self, oldfocus);
576         render_button(self, but);
577     }
578     else if (e->type == ButtonRelease) {
579         if (but->pressed) {
580             if (self->func) self->func(self, but->result, self->data);
581             prompt_hide(self);
582         }
583     }
584     else if (e->type == MotionNotify) {
585         gboolean press;
586
587         press = (e->xmotion.x >= 0 && e->xmotion.y >= 0 &&
588                  e->xmotion.x < but->width && e->xmotion.y < but->height);
589
590         if (press != but->pressed) {
591             but->pressed = press;
592             render_button(self, but);
593         }
594     }
595     return TRUE;
596 }
597
598 void prompt_cancel(ObPrompt *self)
599 {
600     if (self->func) self->func(self, self->cancel_result, self->data);
601     prompt_hide(self);
602 }