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