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