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()
  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     return self;
  62 }
  63
  64 void popup_free(ObPopup *self)
  65 {
  66     if (self) {
  67         XDestroyWindow(ob_display, self->bg);
  68         XDestroyWindow(ob_display, self->text);
  69         RrAppearanceFree(self->a_bg);
  70         RrAppearanceFree(self->a_text);
  71         stacking_remove(self);
  72         g_free(self);
  73     }
  74 }
  75
  76 void popup_position(ObPopup *self, gint gravity, gint x, gint y)
  77 {
  78     self->gravity = gravity;
  79     self->x = x;
  80     self->y = y;
  81 }
  82
  83 void popup_text_width(ObPopup *self, gint w)
  84 {
  85     self->textw = w;
  86 }
  87
  88 void popup_min_width(ObPopup *self, gint minw)
  89 {
  90     self->minw = minw;
  91 }
  92
  93 void popup_max_width(ObPopup *self, gint maxw)
  94 {
  95     self->maxw = maxw;
  96 }
  97
  98 void popup_height(ObPopup *self, gint h)
  99 {
 100     gint texth;
 101
 102     /* don't let the height be smaller than the text */
 103     texth = RrMinHeight(self->a_text) + ob_rr_theme->paddingy * 2;
 104     self->h = MAX(h, texth);
 105 }
 106
 107 void popup_text_width_to_string(ObPopup *self, gchar *text)
 108 {
 109     if (text[0] != '\0') {
 110         self->a_text->texture[0].data.text.string = text;
 111         self->textw = RrMinWidth(self->a_text);
 112     } else
 113         self->textw = 0;
 114 }
 115
 116 void popup_height_to_string(ObPopup *self, gchar *text)
 117 {
 118     self->h = RrMinHeight(self->a_text) + ob_rr_theme->paddingy * 2;
 119 }
 120
 121 void popup_text_width_to_strings(ObPopup *self, gchar **strings, gint num)
 122 {
 123     gint i, maxw;
 124
 125     maxw = 0;
 126     for (i = 0; i < num; ++i) {
 127         popup_text_width_to_string(self, strings[i]);
 128         maxw = MAX(maxw, self->textw);
 129     }
 130     self->textw = maxw;
 131 }
 132
 133 void popup_set_text_align(ObPopup *self, RrJustify align)
 134 {
 135     self->a_text->texture[0].data.text.justify = align;
 136 }
 137
 138 static gboolean popup_show_timeout(gpointer data)
 139 {
 140     ObPopup *self = data;
 141
 142     XMapWindow(ob_display, self->bg);
 143     stacking_raise(INTERNAL_AS_WINDOW(self));
 144     self->mapped = TRUE;
 145     self->delay_mapped = FALSE;
 146
 147     return FALSE; /* don't repeat */
 148 }
 149
 150 void popup_delay_show(ObPopup *self, gulong usec, gchar *text)
 151 {
 152     gint l, t, r, b;
 153     gint x, y, w, h;
 154     gint emptyx, emptyy; /* empty space between elements */
 155     gint textx, texty, textw, texth;
 156     gint iconx, icony, iconw, iconh;
 157     Rect *area;
 158
 159     area = screen_physical_area();
 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     else
 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 and the text is not parent relative, then
 206        fill the whole dialog with the text appearance, don't use the bg at all
 207     */
 208     if (!(self->hasicon || self->a_text->surface.grad == RR_SURFACE_PARENTREL))
 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     x=MAX(MIN(x, area->width-w),0);
 250     y=MAX(MIN(y, area->height-h),0);
 251
 252     /* set the windows/appearances up */
 253     XMoveResizeWindow(ob_display, self->bg, x, y, w, h);
 254     /* when there is no icon and the text is not parent relative, then
 255        fill the whole dialog with the text appearance, don't use the bg at all
 256     */
 257     if (self->hasicon || self->a_text->surface.grad == RR_SURFACE_PARENTREL)
 258         RrPaint(self->a_bg, self->bg, w, h);
 259
 260     if (textw) {
 261         self->a_text->surface.parent = self->a_bg;
 262         self->a_text->surface.parentx = textx;
 263         self->a_text->surface.parenty = texty;
 264         XMoveResizeWindow(ob_display, self->text, textx, texty, textw, texth);
 265         RrPaint(self->a_text, self->text, textw, texth);
 266     }
 267
 268     if (self->hasicon)
 269         self->draw_icon(iconx, icony, iconw, iconh, self->draw_icon_data);
 270
 271     /* do the actual showing */
 272     if (!self->mapped) {
 273         if (usec) {
 274             /* don't kill previous show timers */
 275             if (!self->delay_mapped) {
 276                 ob_main_loop_timeout_add(ob_main_loop, usec,
 277                                          popup_show_timeout, self,
 278                                          g_direct_equal, NULL);
 279                 self->delay_mapped = TRUE;
 280             }
 281         } else {
 282             popup_show_timeout(self);
 283         }
 284     }
 285 }
 286
 287 void popup_hide(ObPopup *self)
 288 {
 289     if (self->mapped) {
 290         gulong ignore_start;
 291
 292         /* kill enter events cause by this unmapping */
 293         ignore_start = event_start_ignore_all_enters();
 294
 295         XUnmapWindow(ob_display, self->bg);
 296         self->mapped = FALSE;
 297
 298         event_end_ignore_all_enters(ignore_start);
 299     } else if (self->delay_mapped) {
 300         ob_main_loop_timeout_remove(ob_main_loop, popup_show_timeout);
 301         self->delay_mapped = FALSE;
 302     }
 303 }
 304
 305 static void icon_popup_draw_icon(gint x, gint y, gint w, gint h, gpointer data)
 306 {
 307     ObIconPopup *self = data;
 308
 309     self->a_icon->surface.parent = self->popup->a_bg;
 310     self->a_icon->surface.parentx = x;
 311     self->a_icon->surface.parenty = y;
 312     XMoveResizeWindow(ob_display, self->icon, x, y, w, h);
 313     RrPaint(self->a_icon, self->icon, w, h);
 314 }
 315
 316 ObIconPopup *icon_popup_new()
 317 {
 318     ObIconPopup *self;
 319
 320     self = g_new0(ObIconPopup, 1);
 321     self->popup = popup_new(TRUE);
 322     self->a_icon = RrAppearanceCopy(ob_rr_theme->a_clear_tex);
 323     self->icon = XCreateWindow(ob_display, self->popup->bg,
 324                                0, 0, 1, 1, 0,
 325                                RrDepth(ob_rr_inst), InputOutput,
 326                                RrVisual(ob_rr_inst), 0, NULL);
 327     XMapWindow(ob_display, self->icon);
 328
 329     self->popup->hasicon = TRUE;
 330     self->popup->draw_icon = icon_popup_draw_icon;
 331     self->popup->draw_icon_data = self;
 332
 333     return self;
 334 }
 335
 336 void icon_popup_free(ObIconPopup *self)
 337 {
 338     if (self) {
 339         XDestroyWindow(ob_display, self->icon);
 340         RrAppearanceFree(self->a_icon);
 341         popup_free(self->popup);
 342         g_free(self);
 343     }
 344 }
 345
 346 void icon_popup_delay_show(ObIconPopup *self, gulong usec,
 347                            gchar *text, const ObClientIcon *icon)
 348 {
 349     if (icon) {
 350         self->a_icon->texture[0].type = RR_TEXTURE_RGBA;
 351         self->a_icon->texture[0].data.rgba.width = icon->width;
 352         self->a_icon->texture[0].data.rgba.height = icon->height;
 353         self->a_icon->texture[0].data.rgba.alpha = 0xff;
 354         self->a_icon->texture[0].data.rgba.data = icon->data;
 355     } else
 356         self->a_icon->texture[0].type = RR_TEXTURE_NONE;
 357
 358     popup_delay_show(self->popup, usec, text);
 359 }
 360
 361 void icon_popup_icon_size_multiplier(ObIconPopup *self, guint wm, guint hm)
 362 {
 363     /* cap them at 1 */
 364     self->popup->iconwm = MAX(1, wm);
 365     self->popup->iconhm = MAX(1, hm);
 366 }
 367
 368 static void pager_popup_draw_icon(gint px, gint py, gint w, gint h,
 369                                   gpointer data)
 370 {
 371     ObPagerPopup *self = data;
 372     gint x, y;
 373     guint rown, n;
 374     guint horz_inc;
 375     guint vert_inc;
 376     guint r, c;
 377     gint eachw, eachh;
 378     const guint cols = screen_desktop_layout.columns;
 379     const guint rows = screen_desktop_layout.rows;
 380     const gint linewidth = ob_rr_theme->obwidth;
 381
 382     eachw = (w - ((cols + 1) * linewidth)) / cols;
 383     eachh = (h - ((rows + 1) * linewidth)) / rows;
 384     /* make them squares */
 385     eachw = eachh = MIN(eachw, eachh);
 386
 387     /* center */
 388     px += (w - (cols * (eachw + linewidth) + linewidth)) / 2;
 389     py += (h - (rows * (eachh + linewidth) + linewidth)) / 2;
 390
 391     if (eachw <= 0 || eachh <= 0)
 392         return;
 393
 394     switch (screen_desktop_layout.orientation) {
 395     case OB_ORIENTATION_HORZ:
 396         switch (screen_desktop_layout.start_corner) {
 397         case OB_CORNER_TOPLEFT:
 398             n = 0;
 399             horz_inc = 1;
 400             vert_inc = cols;
 401             break;
 402         case OB_CORNER_TOPRIGHT:
 403             n = cols - 1;
 404             horz_inc = -1;
 405             vert_inc = cols;
 406             break;
 407         case OB_CORNER_BOTTOMRIGHT:
 408             n = rows * cols - 1;
 409             horz_inc = -1;
 410             vert_inc = -screen_desktop_layout.columns;
 411             break;
 412         case OB_CORNER_BOTTOMLEFT:
 413             n = (rows - 1) * cols;
 414             horz_inc = 1;
 415             vert_inc = -cols;
 416             break;
 417         default:
 418             g_assert_not_reached();
 419         }
 420         break;
 421     case OB_ORIENTATION_VERT:
 422         switch (screen_desktop_layout.start_corner) {
 423         case OB_CORNER_TOPLEFT:
 424             n = 0;
 425             horz_inc = rows;
 426             vert_inc = 1;
 427             break;
 428         case OB_CORNER_TOPRIGHT:
 429             n = rows * (cols - 1);
 430             horz_inc = -rows;
 431             vert_inc = 1;
 432             break;
 433         case OB_CORNER_BOTTOMRIGHT:
 434             n = rows * cols - 1;
 435             horz_inc = -rows;
 436             vert_inc = -1;
 437             break;
 438         case OB_CORNER_BOTTOMLEFT:
 439             n = rows - 1;
 440             horz_inc = rows;
 441             vert_inc = -1;
 442             break;
 443         default:
 444             g_assert_not_reached();
 445         }
 446         break;
 447     default:
 448         g_assert_not_reached();
 449     }
 450
 451     rown = n;
 452     for (r = 0, y = 0; r < rows; ++r, y += eachh + linewidth)
 453     {
 454         for (c = 0, x = 0; c < cols; ++c, x += eachw + linewidth)
 455         {
 456             RrAppearance *a;
 457
 458             if (n < self->desks) {
 459                 a = (n == self->curdesk ? self->hilight : self->unhilight);
 460
 461                 a->surface.parent = self->popup->a_bg;
 462                 a->surface.parentx = x + px;
 463                 a->surface.parenty = y + py;
 464                 XMoveResizeWindow(ob_display, self->wins[n],
 465                                   x + px, y + py, eachw, eachh);
 466                 RrPaint(a, self->wins[n], eachw, eachh);
 467             }
 468             n += horz_inc;
 469         }
 470         n = rown += vert_inc;
 471     }
 472 }
 473
 474 ObPagerPopup *pager_popup_new()
 475 {
 476     ObPagerPopup *self;
 477
 478     self = g_new(ObPagerPopup, 1);
 479     self->popup = popup_new(TRUE);
 480
 481     self->desks = 0;
 482     self->wins = g_new(Window, self->desks);
 483     self->hilight = RrAppearanceCopy(ob_rr_theme->osd_hilite_fg);
 484     self->unhilight = RrAppearanceCopy(ob_rr_theme->osd_unhilite_fg);
 485
 486     self->popup->hasicon = TRUE;
 487     self->popup->draw_icon = pager_popup_draw_icon;
 488     self->popup->draw_icon_data = self;
 489
 490     return self;
 491 }
 492
 493 void pager_popup_free(ObPagerPopup *self)
 494 {
 495     if (self) {
 496         guint i;
 497
 498         for (i = 0; i < self->desks; ++i)
 499             XDestroyWindow(ob_display, self->wins[i]);
 500         g_free(self->wins);
 501         RrAppearanceFree(self->hilight);
 502         RrAppearanceFree(self->unhilight);
 503         popup_free(self->popup);
 504         g_free(self);
 505     }
 506 }
 507
 508 void pager_popup_delay_show(ObPagerPopup *self, gulong usec,
 509                             gchar *text, guint desk)
 510 {
 511     guint i;
 512
 513     if (screen_num_desktops < self->desks)
 514         for (i = screen_num_desktops; i < self->desks; ++i)
 515             XDestroyWindow(ob_display, self->wins[i]);
 516
 517     if (screen_num_desktops != self->desks)
 518         self->wins = g_renew(Window, self->wins, screen_num_desktops);
 519
 520     if (screen_num_desktops > self->desks)
 521         for (i = self->desks; i < screen_num_desktops; ++i) {
 522             XSetWindowAttributes attr;
 523
 524             attr.border_pixel =
 525                 RrColorPixel(ob_rr_theme->osd_border_color);
 526             self->wins[i] = XCreateWindow(ob_display, self->popup->bg,
 527                                           0, 0, 1, 1, ob_rr_theme->obwidth,
 528                                           RrDepth(ob_rr_inst), InputOutput,
 529                                           RrVisual(ob_rr_inst), CWBorderPixel,
 530                                           &attr);
 531             XMapWindow(ob_display, self->wins[i]);
 532         }
 533
 534     self->desks = screen_num_desktops;
 535     self->curdesk = desk;
 536
 537     popup_delay_show(self->popup, usec, text);
 538 }
 539
 540 void pager_popup_icon_size_multiplier(ObPagerPopup *self, guint wm, guint hm)
 541 {
 542     /* cap them at 1 */
 543     self->popup->iconwm = MAX(1, wm);
 544     self->popup->iconhm = MAX(1, hm);
 545 }