openbox/focus_cycle_popup.c

   1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
   2
   3    focus_cycle_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 "focus_cycle_popup.h"
  21 #include "popup.h"
  22 #include "client.h"
  23 #include "screen.h"
  24 #include "focus.h"
  25 #include "openbox.h"
  26 #include "window.h"
  27 #include "event.h"
  28 #include "render/render.h"
  29
  30 #include <X11/Xlib.h>
  31 #include <glib.h>
  32
  33 /* Size of the hilite box around a window's icon */
  34 #define HILITE_SIZE 40
  35 /* Width of the outer ring around the hilite box */
  36 #define HILITE_WIDTH 2
  37 /* Space between the outer ring around the hilite box and the icon inside it */
  38 #define HILITE_MARGIN 1
  39 /* Total distance from the edge of the hilite box to the icon inside it */
  40 #define HILITE_OFFSET (HILITE_WIDTH + HILITE_MARGIN)
  41 /* Size of the icons, which can appear inside or outside of a hilite box */
  42 #define ICON_SIZE (HILITE_SIZE - 2*HILITE_OFFSET)
  43 /* Margin area around the outside of the dialog */
  44 #define OUTSIDE_BORDER 3
  45 /* Margin area around the text */
  46 #define TEXT_BORDER 2
  47
  48 typedef struct _ObFocusCyclePopup       ObFocusCyclePopup;
  49 typedef struct _ObFocusCyclePopupTarget ObFocusCyclePopupTarget;
  50
  51 struct _ObFocusCyclePopupTarget
  52 {
  53     ObClient *client;
  54     gchar *text;
  55     Window iconwin;
  56     /* This is used when the popup is in list mode */
  57     Window textwin;
  58 };
  59
  60 struct _ObFocusCyclePopup
  61 {
  62     ObWindow obwin;
  63     Window bg;
  64
  65     /* This is used when the popup is in icon mode */
  66     Window icon_mode_text;
  67
  68     GList *targets;
  69     gint n_targets;
  70
  71     const ObFocusCyclePopupTarget *last_target;
  72
  73     gint maxtextw;
  74
  75     RrAppearance *a_bg;
  76     RrAppearance *a_text;
  77     RrAppearance *a_hilite_text;
  78     RrAppearance *a_icon;
  79
  80     gboolean mapped;
  81 };
  82
  83 /*! This popup shows all possible windows */
  84 static ObFocusCyclePopup popup;
  85 /*! This popup shows a single window */
  86 static ObIconPopup *single_popup;
  87
  88 static gchar *popup_get_name (ObClient *c);
  89 static void   popup_setup    (ObFocusCyclePopup *p,
  90                               gboolean create_targets,
  91                               gboolean iconic_windows,
  92                               gboolean all_desktops,
  93                               gboolean dock_windows,
  94                               gboolean desktop_windows);
  95 static void   popup_render   (ObFocusCyclePopup *p,
  96                               const ObClient *c,
  97                               ObFocusCyclePopupMode mode);
  98
  99 static Window create_window(Window parent, guint bwidth, gulong mask,
 100                             XSetWindowAttributes *attr)
 101 {
 102     return XCreateWindow(obt_display, parent, 0, 0, 1, 1, bwidth,
 103                          RrDepth(ob_rr_inst), InputOutput,
 104                          RrVisual(ob_rr_inst), mask, attr);
 105 }
 106
 107 void focus_cycle_popup_startup(gboolean reconfig)
 108 {
 109     XSetWindowAttributes attrib;
 110     RrPixel32 *p;
 111
 112     single_popup = icon_popup_new();
 113
 114     popup.obwin.type = OB_WINDOW_CLASS_INTERNAL;
 115     popup.a_bg = RrAppearanceCopy(ob_rr_theme->osd_hilite_bg);
 116     popup.a_hilite_text = RrAppearanceCopy(ob_rr_theme->osd_hilite_label);
 117     popup.a_text = RrAppearanceCopy(ob_rr_theme->a_unfocused_label);
 118     popup.a_icon = RrAppearanceCopy(ob_rr_theme->a_clear);
 119
 120     popup.a_hilite_text->surface.parent = popup.a_bg;
 121     popup.a_text->surface.parent = popup.a_bg;
 122     popup.a_icon->surface.parent = popup.a_bg;
 123
 124     popup.a_text->texture[0].data.text.justify = RR_JUSTIFY_LEFT;
 125     popup.a_hilite_text->texture[0].data.text.justify = RR_JUSTIFY_LEFT;
 126
 127     /* 2 textures. texture[0] is the icon.  texture[1] is the hilight, and
 128        may or may not be used */
 129     RrAppearanceAddTextures(popup.a_icon, 2);
 130
 131     popup.a_icon->texture[0].type = RR_TEXTURE_RGBA;
 132
 133     attrib.override_redirect = True;
 134     attrib.border_pixel=RrColorPixel(ob_rr_theme->osd_border_color);
 135     popup.bg = create_window(obt_root(ob_screen), ob_rr_theme->obwidth,
 136                              CWOverrideRedirect | CWBorderPixel, &attrib);
 137
 138     /* create the text window used for the icon-mode popup */
 139     popup.icon_mode_text = create_window(popup.bg, 0, 0, NULL);
 140
 141     popup.targets = NULL;
 142     popup.n_targets = 0;
 143     popup.last_target = NULL;
 144
 145     /* set up the hilite texture for the icon */
 146     popup.a_icon->texture[1].data.rgba.width = HILITE_SIZE;
 147     popup.a_icon->texture[1].data.rgba.height = HILITE_SIZE;
 148     popup.a_icon->texture[1].data.rgba.alpha = 0xff;
 149     p = g_new(RrPixel32, HILITE_SIZE * HILITE_SIZE);
 150     popup.a_icon->texture[1].data.rgba.data = p;
 151
 152     /* create the hilite under the target icon */
 153     {
 154         RrPixel32 color;
 155         gint x, y, o;
 156
 157         color = ((ob_rr_theme->osd_color->r & 0xff) << RrDefaultRedOffset) +
 158             ((ob_rr_theme->osd_color->g & 0xff) << RrDefaultGreenOffset) +
 159             ((ob_rr_theme->osd_color->b & 0xff) << RrDefaultBlueOffset);
 160
 161         o = 0;
 162         for (x = 0; x < HILITE_SIZE; x++)
 163             for (y = 0; y < HILITE_SIZE; y++) {
 164                 guchar a;
 165
 166                 if (x < HILITE_WIDTH ||
 167                     x >= HILITE_SIZE - HILITE_WIDTH ||
 168                     y < HILITE_WIDTH ||
 169                     y >= HILITE_SIZE - HILITE_WIDTH)
 170                 {
 171                     /* the border of the target */
 172                     a = 0x88;
 173                 }
 174                 else {
 175                     /* the background of the target */
 176                     a = 0x22;
 177                 }
 178
 179                 p[o++] = color + (a << RrDefaultAlphaOffset);
 180             }
 181     }
 182
 183     stacking_add(INTERNAL_AS_WINDOW(&popup));
 184     window_add(&popup.bg, INTERNAL_AS_WINDOW(&popup));
 185 }
 186
 187 void focus_cycle_popup_shutdown(gboolean reconfig)
 188 {
 189     icon_popup_free(single_popup);
 190
 191     window_remove(popup.bg);
 192     stacking_remove(INTERNAL_AS_WINDOW(&popup));
 193
 194     while(popup.targets) {
 195         ObFocusCyclePopupTarget *t = popup.targets->data;
 196
 197         g_free(t->text);
 198         XDestroyWindow(obt_display, t->iconwin);
 199         XDestroyWindow(obt_display, t->textwin);
 200
 201         popup.targets = g_list_delete_link(popup.targets, popup.targets);
 202     }
 203
 204     g_free(popup.a_icon->texture[1].data.rgba.data);
 205     popup.a_icon->texture[1].data.rgba.data = NULL;
 206
 207     XDestroyWindow(obt_display, popup.icon_mode_text);
 208     XDestroyWindow(obt_display, popup.bg);
 209
 210     RrAppearanceFree(popup.a_icon);
 211     RrAppearanceFree(popup.a_hilite_text);
 212     RrAppearanceFree(popup.a_text);
 213     RrAppearanceFree(popup.a_bg);
 214 }
 215
 216 static void popup_setup(ObFocusCyclePopup *p, gboolean create_targets,
 217                         gboolean iconic_windows, gboolean all_desktops,
 218                         gboolean dock_windows, gboolean desktop_windows)
 219 {
 220     gint maxwidth, n;
 221     GList *it;
 222
 223     g_assert(p->targets == NULL);
 224     g_assert(p->n_targets == 0);
 225
 226     /* make its width to be the width of all the possible titles */
 227
 228     /* build a list of all the valid focus targets and measure their strings,
 229        and count them */
 230     maxwidth = 0;
 231     n = 0;
 232     for (it = g_list_last(focus_order); it; it = g_list_previous(it)) {
 233         ObClient *ft = it->data;
 234
 235         if (focus_valid_target(ft, TRUE,
 236                                iconic_windows,
 237                                all_desktops,
 238                                dock_windows,
 239                                desktop_windows))
 240         {
 241             gchar *text = popup_get_name(ft);
 242
 243             /* measure */
 244             p->a_text->texture[0].data.text.string = text;
 245             maxwidth = MAX(maxwidth, RrMinWidth(p->a_text));
 246
 247             if (!create_targets)
 248                 g_free(text);
 249             else {
 250                 ObFocusCyclePopupTarget *t = g_new(ObFocusCyclePopupTarget, 1);
 251
 252                 t->client = ft;
 253                 t->text = text;
 254                 t->iconwin = create_window(p->bg, 0, 0, NULL);
 255                 t->textwin = create_window(p->bg, 0, 0, NULL);
 256
 257                 XMapWindow(obt_display, t->iconwin);
 258
 259                 p->targets = g_list_prepend(p->targets, t);
 260                 ++n;
 261             }
 262         }
 263     }
 264
 265     p->n_targets = n;
 266     p->maxtextw = maxwidth;
 267 }
 268
 269 static gchar *popup_get_name(ObClient *c)
 270 {
 271     ObClient *p;
 272     gchar *title;
 273     const gchar *desk = NULL;
 274     gchar *ret;
 275
 276     /* find our highest direct parent */
 277     p = client_search_top_direct_parent(c);
 278
 279     if (c->desktop != DESKTOP_ALL && c->desktop != screen_desktop)
 280         desk = screen_desktop_names[c->desktop];
 281
 282     title = c->iconic ? c->icon_title : c->title;
 283
 284     /* use the transient's parent's title/icon if we don't have one */
 285     if (p != c && title[0] == '\0')
 286         title = p->iconic ? p->icon_title : p->title;
 287
 288     if (desk)
 289         ret = g_strdup_printf("%s [%s]", title, desk);
 290     else
 291         ret = g_strdup(title);
 292
 293     return ret;
 294 }
 295
 296 static void popup_render(ObFocusCyclePopup *p, const ObClient *c,
 297                          ObFocusCyclePopupMode mode)
 298 {
 299     gint ml, mt, mr, mb;
 300     gint l, t, r, b;
 301     gint x, y, w, h;
 302     Rect *screen_area = NULL;
 303     gint rgbax, rgbay, rgbaw, rgbah;
 304     gint i;
 305     GList *it;
 306     const ObFocusCyclePopupTarget *newtarget;
 307     gint icons_per_row;
 308     gint icon_rows;
 309     gint textw, texth;
 310
 311     /* vars for icon mode */
 312     gint icon_mode_textx;
 313     gint icon_mode_texty;
 314     gint icons_center_x;
 315
 316     /* vars for list mode */
 317     gint list_mode_icon_column_w = HILITE_SIZE + OUTSIDE_BORDER;
 318
 319     g_assert(mode == OB_FOCUS_CYCLE_POPUP_MODE_ICONS ||
 320              mode == OB_FOCUS_CYCLE_POPUP_MODE_LIST);
 321
 322     screen_area = screen_physical_area_active();
 323
 324     /* get the outside margins */
 325     RrMargins(p->a_bg, &ml, &mt, &mr, &mb);
 326
 327     /* get our outside borders */
 328     l = ml + OUTSIDE_BORDER;
 329     r = mr + OUTSIDE_BORDER;
 330     t = mt + OUTSIDE_BORDER;
 331     b = mb + OUTSIDE_BORDER;
 332
 333     /* get the width from the text and keep it within limits */
 334     w = l + r + p->maxtextw;
 335     if (mode == OB_FOCUS_CYCLE_POPUP_MODE_LIST)
 336         /* when in list mode, there are icons down the side */
 337         w += list_mode_icon_column_w;
 338     w = MIN(w, MAX(screen_area->width/3, POPUP_WIDTH)); /* max width */
 339     w = MAX(w, POPUP_WIDTH); /* min width */
 340
 341     if (mode == OB_FOCUS_CYCLE_POPUP_MODE_ICONS) {
 342         /* how many icons will fit in that row? make the width fit that */
 343         w -= l + r;
 344         icons_per_row = (w + HILITE_SIZE - 1) / HILITE_SIZE;
 345         w = icons_per_row * HILITE_SIZE + l + r;
 346
 347         /* how many rows do we need? */
 348         icon_rows = (p->n_targets-1) / icons_per_row + 1;
 349
 350     }
 351     else {
 352         /* in list mode, there is one column of icons.. */
 353         icons_per_row = 1;
 354         icon_rows = p->n_targets;
 355     }
 356
 357     /* get the text dimensions */
 358     textw = w - l - r;
 359     if (mode == OB_FOCUS_CYCLE_POPUP_MODE_LIST)
 360         /* leave space on the side for the icons */
 361         textw -= list_mode_icon_column_w;
 362     texth = RrMinHeight(p->a_text) + TEXT_BORDER * 2;
 363
 364     /* find the height of the dialog */
 365 #warning limit the height and scroll entries somehow
 366     h = t + b + (icon_rows * MAX(HILITE_SIZE, texth));
 367     if (mode == OB_FOCUS_CYCLE_POPUP_MODE_ICONS)
 368         /* in icon mode the text sits below the icons, so make some space */
 369         h += OUTSIDE_BORDER + texth;
 370
 371     /* center the icons if there is less than one row */
 372     if (icon_rows == 1)
 373         icons_center_x = (w - p->n_targets * HILITE_SIZE) / 2;
 374     else
 375         icons_center_x = 0;
 376
 377     if (mode == OB_FOCUS_CYCLE_POPUP_MODE_ICONS) {
 378         /* get the position of the text */
 379         icon_mode_textx = l;
 380         icon_mode_texty = h - texth - b;
 381     }
 382
 383     /* find the position for the popup (include the outer borders) */
 384     x = screen_area->x + (screen_area->width -
 385                           (w + ob_rr_theme->obwidth * 2)) / 2;
 386     y = screen_area->y + (screen_area->height -
 387                           (h + ob_rr_theme->obwidth * 2)) / 2;
 388
 389     /* get the dimensions of the target hilite texture */
 390     rgbax = ml;
 391     rgbay = mt;
 392     rgbaw = w - ml - mr;
 393     rgbah = h - mt - mb;
 394
 395     if (!p->mapped) {
 396         /* position the background but don't draw it */
 397         XMoveResizeWindow(obt_display, p->bg, x, y, w, h);
 398
 399         if (mode == OB_FOCUS_CYCLE_POPUP_MODE_ICONS) {
 400             /* position the text */
 401             XMoveResizeWindow(obt_display, p->icon_mode_text,
 402                               icon_mode_textx, icon_mode_texty, textw, texth);
 403             XMapWindow(obt_display, popup.icon_mode_text);
 404         }
 405         else
 406             XUnmapWindow(obt_display, popup.icon_mode_text);
 407     }
 408
 409     /* find the focused target */
 410     newtarget = NULL;
 411     for (i = 0, it = p->targets; it; ++i, it = g_list_next(it)) {
 412         const ObFocusCyclePopupTarget *target = it->data;
 413         if (target->client == c) {
 414             /* save the target */
 415             newtarget = target;
 416             break;
 417         }
 418     }
 419
 420     g_assert(newtarget != NULL);
 421
 422     /* * * draw everything * * */
 423
 424     /* draw the background */
 425     if (!p->mapped)
 426         RrPaint(p->a_bg, p->bg, w, h);
 427
 428     /* draw the icons and text */
 429     for (i = 0, it = p->targets; it; ++i, it = g_list_next(it)) {
 430         const ObFocusCyclePopupTarget *target = it->data;
 431
 432         /* have to redraw the targetted icon and last targetted icon
 433          * to update the hilite */
 434         if (!p->mapped || newtarget == target || p->last_target == target) {
 435             const gint row = i / icons_per_row; /* starting from 0 */
 436             const gint col = i % icons_per_row; /* starting from 0 */
 437             const ObClientIcon *icon;
 438             gint iconx, icony;
 439             gint list_mode_textx, list_mode_texty;
 440             RrAppearance *text;
 441
 442             /* find the coordinates for the icon */
 443             iconx = icons_center_x + l + (col * HILITE_SIZE);
 444             icony = t + (row * MAX(texth, HILITE_SIZE))
 445                 + MAX(texth - HILITE_SIZE, 0) / 2;
 446
 447             /* find the dimensions of the text box */
 448             list_mode_textx = iconx + HILITE_SIZE + TEXT_BORDER;
 449             list_mode_texty = icony + HILITE_OFFSET;
 450
 451             /* position the icon */
 452             XMoveResizeWindow(obt_display, target->iconwin,
 453                               iconx, icony, HILITE_SIZE, HILITE_SIZE);
 454
 455             /* position the text */
 456             if (mode == OB_FOCUS_CYCLE_POPUP_MODE_LIST) {
 457                 XMoveResizeWindow(obt_display, target->textwin,
 458                                   list_mode_textx, list_mode_texty,
 459                                   textw, texth);
 460                 XMapWindow(obt_display, target->textwin);
 461             }
 462             else
 463                 XUnmapWindow(obt_display, target->textwin);
 464
 465             /* get the icon from the client */
 466             icon = client_icon(target->client, ICON_SIZE, ICON_SIZE);
 467             p->a_icon->texture[0].data.rgba.width = icon->width;
 468             p->a_icon->texture[0].data.rgba.height = icon->height;
 469             p->a_icon->texture[0].data.rgba.twidth = ICON_SIZE;
 470             p->a_icon->texture[0].data.rgba.theight = ICON_SIZE;
 471             p->a_icon->texture[0].data.rgba.tx = HILITE_OFFSET;
 472             p->a_icon->texture[0].data.rgba.ty = HILITE_OFFSET;
 473             p->a_icon->texture[0].data.rgba.alpha =
 474                 target->client->iconic ? OB_ICONIC_ALPHA : 0xff;
 475             p->a_icon->texture[0].data.rgba.data = icon->data;
 476
 477             /* Draw the hilite? */
 478             p->a_icon->texture[1].type = (target == newtarget) ?
 479                                          RR_TEXTURE_RGBA : RR_TEXTURE_NONE;
 480
 481             /* draw the icon */
 482             p->a_icon->surface.parentx = iconx;
 483             p->a_icon->surface.parenty = icony;
 484             RrPaint(p->a_icon, target->iconwin, HILITE_SIZE, HILITE_SIZE);
 485
 486             /* draw the text */
 487             if (mode == OB_FOCUS_CYCLE_POPUP_MODE_LIST || target == newtarget)
 488             {
 489                 text = (target == newtarget) ? p->a_hilite_text : p->a_text;
 490                 text->texture[0].data.text.string = target->text;
 491                 text->surface.parentx =
 492                     mode == OB_FOCUS_CYCLE_POPUP_MODE_ICONS ?
 493                     icon_mode_textx : list_mode_textx;
 494                 text->surface.parenty =
 495                     mode == OB_FOCUS_CYCLE_POPUP_MODE_ICONS ?
 496                     icon_mode_texty : list_mode_texty;
 497                 RrPaint(text,
 498                         (mode == OB_FOCUS_CYCLE_POPUP_MODE_ICONS ?
 499                          p->icon_mode_text : target->textwin),
 500                         textw, texth);
 501             }
 502         }
 503     }
 504
 505     p->last_target = newtarget;
 506
 507     g_free(screen_area);
 508 }
 509
 510 void focus_cycle_popup_show(ObClient *c, gboolean iconic_windows,
 511                             gboolean all_desktops, gboolean dock_windows,
 512                             gboolean desktop_windows,
 513                             ObFocusCyclePopupMode mode)
 514 {
 515     g_assert(c != NULL);
 516
 517     if (mode == OB_FOCUS_CYCLE_POPUP_MODE_NONE) {
 518         focus_cycle_popup_hide();
 519         return;
 520     }
 521
 522     /* do this stuff only when the dialog is first showing */
 523     if (!popup.mapped)
 524         popup_setup(&popup, TRUE, iconic_windows, all_desktops,
 525                     dock_windows, desktop_windows);
 526     g_assert(popup.targets != NULL);
 527
 528     popup_render(&popup, c, mode);
 529
 530     if (!popup.mapped) {
 531         /* show the dialog */
 532         XMapWindow(obt_display, popup.bg);
 533         XFlush(obt_display);
 534         popup.mapped = TRUE;
 535         screen_hide_desktop_popup();
 536     }
 537 }
 538
 539 void focus_cycle_popup_hide(void)
 540 {
 541     gulong ignore_start;
 542
 543     ignore_start = event_start_ignore_all_enters();
 544
 545     XUnmapWindow(obt_display, popup.bg);
 546     XFlush(obt_display);
 547
 548     event_end_ignore_all_enters(ignore_start);
 549
 550     popup.mapped = FALSE;
 551
 552     while(popup.targets) {
 553         ObFocusCyclePopupTarget *t = popup.targets->data;
 554
 555         g_free(t->text);
 556         XDestroyWindow(obt_display, t->iconwin);
 557         XDestroyWindow(obt_display, t->textwin);
 558         g_free(t);
 559
 560         popup.targets = g_list_delete_link(popup.targets, popup.targets);
 561     }
 562     popup.n_targets = 0;
 563     popup.last_target = NULL;
 564 }
 565
 566 void focus_cycle_popup_single_show(struct _ObClient *c,
 567                                    gboolean iconic_windows,
 568                                    gboolean all_desktops,
 569                                    gboolean dock_windows,
 570                                    gboolean desktop_windows)
 571 {
 572     gchar *text;
 573
 574     g_assert(c != NULL);
 575
 576     /* do this stuff only when the dialog is first showing */
 577     if (!popup.mapped) {
 578         Rect *a;
 579
 580         popup_setup(&popup, FALSE, iconic_windows, all_desktops,
 581                     dock_windows, desktop_windows);
 582         g_assert(popup.targets == NULL);
 583
 584         /* position the popup */
 585         a = screen_physical_area_active();
 586         icon_popup_position(single_popup, CenterGravity,
 587                             a->x + a->width / 2, a->y + a->height / 2);
 588         icon_popup_height(single_popup, POPUP_HEIGHT);
 589         icon_popup_min_width(single_popup, POPUP_WIDTH);
 590         icon_popup_max_width(single_popup, MAX(a->width/3, POPUP_WIDTH));
 591         icon_popup_text_width(single_popup, popup.maxtextw);
 592         g_free(a);
 593     }
 594
 595     text = popup_get_name(c);
 596     icon_popup_show(single_popup, text, client_icon(c, HILITE_SIZE,
 597                                                     HILITE_SIZE));
 598     g_free(text);
 599     screen_hide_desktop_popup();
 600 }
 601
 602 void focus_cycle_popup_single_hide(void)
 603 {
 604     icon_popup_hide(single_popup);
 605 }