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