openbox/focus.c

   1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
   2
   3    focus.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 "debug.h"
  21 #include "event.h"
  22 #include "openbox.h"
  23 #include "grab.h"
  24 #include "framerender.h"
  25 #include "client.h"
  26 #include "config.h"
  27 #include "frame.h"
  28 #include "screen.h"
  29 #include "group.h"
  30 #include "prop.h"
  31 #include "focus.h"
  32 #include "stacking.h"
  33 #include "popup.h"
  34 #include "render/render.h"
  35
  36 #include <X11/Xlib.h>
  37 #include <glib.h>
  38 #include <assert.h>
  39
  40 ObClient *focus_client = NULL;
  41 GList *focus_order = NULL;
  42 ObClient *focus_cycle_target = NULL;
  43
  44 struct {
  45     InternalWindow top;
  46     InternalWindow left;
  47     InternalWindow right;
  48     InternalWindow bottom;
  49 } focus_indicator;
  50
  51 RrAppearance *a_focus_indicator;
  52 RrColor *color_white;
  53
  54 static ObIconPopup *focus_cycle_popup;
  55
  56 static void focus_cycle_destructor(ObClient *client, gpointer data)
  57 {
  58     /* end cycling if the target disappears. CurrentTime is fine, time won't
  59        be used
  60     */
  61     if (focus_cycle_target == client)
  62         focus_cycle(TRUE, TRUE, TRUE, TRUE, TRUE, TRUE);
  63 }
  64
  65 static Window createWindow(Window parent, gulong mask,
  66                            XSetWindowAttributes *attrib)
  67 {
  68     return XCreateWindow(ob_display, parent, 0, 0, 1, 1, 0,
  69                          RrDepth(ob_rr_inst), InputOutput,
  70                          RrVisual(ob_rr_inst), mask, attrib);
  71
  72 }
  73
  74 void focus_startup(gboolean reconfig)
  75 {
  76     focus_cycle_popup = icon_popup_new(TRUE);
  77
  78     if (!reconfig) {
  79         XSetWindowAttributes attr;
  80
  81         client_add_destructor(focus_cycle_destructor, NULL);
  82
  83         /* start with nothing focused */
  84         focus_nothing();
  85
  86         focus_indicator.top.obwin.type = Window_Internal;
  87         focus_indicator.left.obwin.type = Window_Internal;
  88         focus_indicator.right.obwin.type = Window_Internal;
  89         focus_indicator.bottom.obwin.type = Window_Internal;
  90
  91         attr.override_redirect = True;
  92         attr.background_pixel = BlackPixel(ob_display, ob_screen);
  93         focus_indicator.top.win =
  94             createWindow(RootWindow(ob_display, ob_screen),
  95                          CWOverrideRedirect | CWBackPixel, &attr);
  96         focus_indicator.left.win =
  97             createWindow(RootWindow(ob_display, ob_screen),
  98                          CWOverrideRedirect | CWBackPixel, &attr);
  99         focus_indicator.right.win =
 100             createWindow(RootWindow(ob_display, ob_screen),
 101                          CWOverrideRedirect | CWBackPixel, &attr);
 102         focus_indicator.bottom.win =
 103             createWindow(RootWindow(ob_display, ob_screen),
 104                          CWOverrideRedirect | CWBackPixel, &attr);
 105
 106         stacking_add(INTERNAL_AS_WINDOW(&focus_indicator.top));
 107         stacking_add(INTERNAL_AS_WINDOW(&focus_indicator.left));
 108         stacking_add(INTERNAL_AS_WINDOW(&focus_indicator.right));
 109         stacking_add(INTERNAL_AS_WINDOW(&focus_indicator.bottom));
 110
 111         color_white = RrColorNew(ob_rr_inst, 0xff, 0xff, 0xff);
 112
 113         a_focus_indicator = RrAppearanceNew(ob_rr_inst, 4);
 114         a_focus_indicator->surface.grad = RR_SURFACE_SOLID;
 115         a_focus_indicator->surface.relief = RR_RELIEF_FLAT;
 116         a_focus_indicator->surface.primary = RrColorNew(ob_rr_inst,
 117                                                         0, 0, 0);
 118         a_focus_indicator->texture[0].type = RR_TEXTURE_LINE_ART;
 119         a_focus_indicator->texture[0].data.lineart.color = color_white;
 120         a_focus_indicator->texture[1].type = RR_TEXTURE_LINE_ART;
 121         a_focus_indicator->texture[1].data.lineart.color = color_white;
 122         a_focus_indicator->texture[2].type = RR_TEXTURE_LINE_ART;
 123         a_focus_indicator->texture[2].data.lineart.color = color_white;
 124         a_focus_indicator->texture[3].type = RR_TEXTURE_LINE_ART;
 125         a_focus_indicator->texture[3].data.lineart.color = color_white;
 126     }
 127 }
 128
 129 void focus_shutdown(gboolean reconfig)
 130 {
 131     icon_popup_free(focus_cycle_popup);
 132
 133     if (!reconfig) {
 134         client_remove_destructor(focus_cycle_destructor);
 135
 136         /* reset focus to root */
 137         XSetInputFocus(ob_display, PointerRoot, RevertToNone, CurrentTime);
 138
 139         RrColorFree(color_white);
 140
 141         RrAppearanceFree(a_focus_indicator);
 142
 143         XDestroyWindow(ob_display, focus_indicator.top.win);
 144         XDestroyWindow(ob_display, focus_indicator.left.win);
 145         XDestroyWindow(ob_display, focus_indicator.right.win);
 146         XDestroyWindow(ob_display, focus_indicator.bottom.win);
 147     }
 148 }
 149
 150 static void push_to_top(ObClient *client)
 151 {
 152     focus_order = g_list_remove(focus_order, client);
 153     focus_order = g_list_prepend(focus_order, client);
 154 }
 155
 156 void focus_set_client(ObClient *client)
 157 {
 158     Window active;
 159
 160     ob_debug_type(OB_DEBUG_FOCUS,
 161                   "focus_set_client 0x%lx\n", client ? client->window : 0);
 162
 163     /* uninstall the old colormap, and install the new one */
 164     screen_install_colormap(focus_client, FALSE);
 165     screen_install_colormap(client, TRUE);
 166
 167     /* in the middle of cycling..? kill it. CurrentTime is fine, time won't
 168        be used.
 169     */
 170     if (focus_cycle_target)
 171         focus_cycle(TRUE, TRUE, TRUE, TRUE, TRUE, TRUE);
 172
 173     focus_client = client;
 174
 175     if (client != NULL) {
 176         /* move to the top of the list */
 177         push_to_top(client);
 178         /* remove hiliting from the window when it gets focused */
 179         client_hilite(client, FALSE);
 180     }
 181
 182     /* set the NET_ACTIVE_WINDOW hint, but preserve it on shutdown */
 183     if (ob_state() != OB_STATE_EXITING) {
 184         active = client ? client->window : None;
 185         PROP_SET32(RootWindow(ob_display, ob_screen),
 186                    net_active_window, window, active);
 187     }
 188 }
 189
 190 ObClient* focus_fallback_target(gboolean allow_refocus, ObClient *old)
 191 {
 192     GList *it;
 193     ObClient *target = NULL;
 194     ObClient *desktop = NULL;
 195
 196     ob_debug_type(OB_DEBUG_FOCUS, "trying pointer stuff\n");
 197     if (config_focus_follow && !config_focus_last)
 198     {
 199         if ((target = client_under_pointer()))
 200             if (allow_refocus || target != old)
 201                 if (client_normal(target) && client_can_focus(target)) {
 202                     ob_debug_type(OB_DEBUG_FOCUS, "found in pointer stuff\n");
 203                     return target;
 204                 }
 205     }
 206
 207 #if 0
 208         /* try for group relations */
 209         if (old->group) {
 210             GSList *sit;
 211
 212             for (it = focus_order[screen_desktop]; it; it = g_list_next(it))
 213                 for (sit = old->group->members; sit; sit = g_slist_next(sit))
 214                     if (sit->data == it->data)
 215                         if (sit->data != old && client_normal(sit->data))
 216                             if (client_can_focus(sit->data))
 217                                 return sit->data;
 218         }
 219 #endif
 220
 221     ob_debug_type(OB_DEBUG_FOCUS, "trying omnipresentness\n");
 222     if (allow_refocus && old && old->desktop == DESKTOP_ALL &&
 223         client_normal(old))
 224     {
 225         return old;
 226     }
 227
 228
 229     ob_debug_type(OB_DEBUG_FOCUS, "trying  the focus order\n");
 230     for (it = focus_order; it; it = g_list_next(it))
 231         if (allow_refocus || it->data != old) {
 232             ObClient *c = it->data;
 233             /* fallback focus to a window if:
 234                1. it is actually focusable, cuz if it's not then we're sending
 235                focus off to nothing
 236                2. it is validated. if the window is about to disappear, then
 237                don't try focus it.
 238                3. it is visible on the current desktop. this ignores
 239                omnipresent windows, which are problematic in their own rite.
 240                4. it's not iconic
 241                5. it is a normal type window, don't fall back onto a dock or
 242                a splashscreen or a desktop window (save the desktop as a
 243                backup fallback though)
 244             */
 245             if (client_can_focus(c) && !c->iconic)
 246             {
 247                 if (c->desktop == screen_desktop && client_normal(c)) {
 248                     ob_debug_type(OB_DEBUG_FOCUS, "found in focus order\n");
 249                     return it->data;
 250                 } else if ((c->desktop == screen_desktop ||
 251                             c->desktop == DESKTOP_ALL) &&
 252                            c->type == OB_CLIENT_TYPE_DESKTOP &&
 253                            desktop == NULL)
 254                     desktop = c;
 255             }
 256         }
 257
 258     /* as a last resort fallback to the desktop window if there is one.
 259        (if there's more than one, then the one most recently focused.)
 260     */
 261     ob_debug_type(OB_DEBUG_FOCUS, "found desktop: \n", !!desktop);
 262     return desktop;
 263 }
 264
 265 void focus_fallback(gboolean allow_refocus)
 266 {
 267     ObClient *new;
 268     ObClient *old = focus_client;
 269
 270     /* unfocus any focused clients.. they can be focused by Pointer events
 271        and such, and then when I try focus them, I won't get a FocusIn event
 272        at all for them.
 273     */
 274     focus_nothing();
 275
 276     if ((new = focus_fallback_target(allow_refocus, old)))
 277         client_focus(new);
 278 }
 279
 280 void focus_nothing()
 281 {
 282     /* Install our own colormap */
 283     if (focus_client != NULL) {
 284         screen_install_colormap(focus_client, FALSE);
 285         screen_install_colormap(NULL, TRUE);
 286     }
 287
 288     focus_client = NULL;
 289
 290     /* when nothing will be focused, send focus to the backup target */
 291     XSetInputFocus(ob_display, screen_support_win, RevertToPointerRoot,
 292                    event_curtime);
 293 }
 294
 295 static void popup_cycle(ObClient *c, gboolean show)
 296 {
 297     if (!show) {
 298         icon_popup_hide(focus_cycle_popup);
 299     } else {
 300         Rect *a;
 301         ObClient *p = c;
 302         gchar *title = NULL;
 303
 304         a = screen_physical_area_monitor(0);
 305         icon_popup_position(focus_cycle_popup, CenterGravity,
 306                             a->x + a->width / 2, a->y + a->height / 2);
 307 /*        icon_popup_size(focus_cycle_popup, a->height/2, a->height/16);
 308         icon_popup_show(focus_cycle_popup, c->title,
 309                         client_icon(c, a->height/16, a->height/16));
 310 */
 311         /* XXX the size and the font extents need to be related on some level
 312          */
 313         icon_popup_size(focus_cycle_popup, POPUP_WIDTH, POPUP_HEIGHT);
 314
 315         /* use the transient's parent's title/icon */
 316         while (p->transient_for && p->transient_for != OB_TRAN_GROUP)
 317             p = p->transient_for;
 318
 319         if (p != c && !strcmp("", (c->iconic ? c->icon_title : c->title)))
 320             title = g_strdup(p->iconic ? p->icon_title : p->title);
 321             /*title = g_strconcat((c->iconic ? c->icon_title : c->title),
 322                                 " - ",
 323                                 (p->iconic ? p->icon_title : p->title),
 324                                 NULL);
 325             */
 326         icon_popup_show(focus_cycle_popup,
 327                         (title ? title :
 328                          (c->iconic ? c->icon_title : c->title)),
 329                         client_icon(p, 48, 48));
 330         g_free(title);
 331     }
 332 }
 333
 334 void focus_cycle_draw_indicator()
 335 {
 336     if (!focus_cycle_target) {
 337         XUnmapWindow(ob_display, focus_indicator.top.win);
 338         XUnmapWindow(ob_display, focus_indicator.left.win);
 339         XUnmapWindow(ob_display, focus_indicator.right.win);
 340         XUnmapWindow(ob_display, focus_indicator.bottom.win);
 341
 342         /* kill enter events cause by this unmapping */
 343         event_ignore_queued_enters();
 344     } else {
 345         /*
 346           if (focus_cycle_target)
 347               frame_adjust_focus(focus_cycle_target->frame, FALSE);
 348           frame_adjust_focus(focus_cycle_target->frame, TRUE);
 349         */
 350         gint x, y, w, h;
 351         gint wt, wl, wr, wb;
 352
 353         wt = wl = wr = wb = MAX(3,
 354                                 MAX(1, MAX(ob_rr_theme->paddingx,
 355                                            ob_rr_theme->paddingy)) * 2 +
 356                                 ob_rr_theme->fbwidth * 2);
 357
 358         x = focus_cycle_target->frame->area.x;
 359         y = focus_cycle_target->frame->area.y;
 360         w = focus_cycle_target->frame->area.width;
 361         h = wt;
 362
 363         XMoveResizeWindow(ob_display, focus_indicator.top.win,
 364                           x, y, w, h);
 365         a_focus_indicator->texture[0].data.lineart.x1 = 0;
 366         a_focus_indicator->texture[0].data.lineart.y1 = h-1;
 367         a_focus_indicator->texture[0].data.lineart.x2 = 0;
 368         a_focus_indicator->texture[0].data.lineart.y2 = 0;
 369         a_focus_indicator->texture[1].data.lineart.x1 = 0;
 370         a_focus_indicator->texture[1].data.lineart.y1 = 0;
 371         a_focus_indicator->texture[1].data.lineart.x2 = w-1;
 372         a_focus_indicator->texture[1].data.lineart.y2 = 0;
 373         a_focus_indicator->texture[2].data.lineart.x1 = w-1;
 374         a_focus_indicator->texture[2].data.lineart.y1 = 0;
 375         a_focus_indicator->texture[2].data.lineart.x2 = w-1;
 376         a_focus_indicator->texture[2].data.lineart.y2 = h-1;
 377         a_focus_indicator->texture[3].data.lineart.x1 = (wl-1);
 378         a_focus_indicator->texture[3].data.lineart.y1 = h-1;
 379         a_focus_indicator->texture[3].data.lineart.x2 = w - wr;
 380         a_focus_indicator->texture[3].data.lineart.y2 = h-1;
 381         RrPaint(a_focus_indicator, focus_indicator.top.win,
 382                 w, h);
 383
 384         x = focus_cycle_target->frame->area.x;
 385         y = focus_cycle_target->frame->area.y;
 386         w = wl;
 387         h = focus_cycle_target->frame->area.height;
 388
 389         XMoveResizeWindow(ob_display, focus_indicator.left.win,
 390                           x, y, w, h);
 391         a_focus_indicator->texture[0].data.lineart.x1 = w-1;
 392         a_focus_indicator->texture[0].data.lineart.y1 = 0;
 393         a_focus_indicator->texture[0].data.lineart.x2 = 0;
 394         a_focus_indicator->texture[0].data.lineart.y2 = 0;
 395         a_focus_indicator->texture[1].data.lineart.x1 = 0;
 396         a_focus_indicator->texture[1].data.lineart.y1 = 0;
 397         a_focus_indicator->texture[1].data.lineart.x2 = 0;
 398         a_focus_indicator->texture[1].data.lineart.y2 = h-1;
 399         a_focus_indicator->texture[2].data.lineart.x1 = 0;
 400         a_focus_indicator->texture[2].data.lineart.y1 = h-1;
 401         a_focus_indicator->texture[2].data.lineart.x2 = w-1;
 402         a_focus_indicator->texture[2].data.lineart.y2 = h-1;
 403         a_focus_indicator->texture[3].data.lineart.x1 = w-1;
 404         a_focus_indicator->texture[3].data.lineart.y1 = wt-1;
 405         a_focus_indicator->texture[3].data.lineart.x2 = w-1;
 406         a_focus_indicator->texture[3].data.lineart.y2 = h - wb;
 407         RrPaint(a_focus_indicator, focus_indicator.left.win,
 408                 w, h);
 409
 410         x = focus_cycle_target->frame->area.x +
 411             focus_cycle_target->frame->area.width - wr;
 412         y = focus_cycle_target->frame->area.y;
 413         w = wr;
 414         h = focus_cycle_target->frame->area.height ;
 415
 416         XMoveResizeWindow(ob_display, focus_indicator.right.win,
 417                           x, y, w, h);
 418         a_focus_indicator->texture[0].data.lineart.x1 = 0;
 419         a_focus_indicator->texture[0].data.lineart.y1 = 0;
 420         a_focus_indicator->texture[0].data.lineart.x2 = w-1;
 421         a_focus_indicator->texture[0].data.lineart.y2 = 0;
 422         a_focus_indicator->texture[1].data.lineart.x1 = w-1;
 423         a_focus_indicator->texture[1].data.lineart.y1 = 0;
 424         a_focus_indicator->texture[1].data.lineart.x2 = w-1;
 425         a_focus_indicator->texture[1].data.lineart.y2 = h-1;
 426         a_focus_indicator->texture[2].data.lineart.x1 = w-1;
 427         a_focus_indicator->texture[2].data.lineart.y1 = h-1;
 428         a_focus_indicator->texture[2].data.lineart.x2 = 0;
 429         a_focus_indicator->texture[2].data.lineart.y2 = h-1;
 430         a_focus_indicator->texture[3].data.lineart.x1 = 0;
 431         a_focus_indicator->texture[3].data.lineart.y1 = wt-1;
 432         a_focus_indicator->texture[3].data.lineart.x2 = 0;
 433         a_focus_indicator->texture[3].data.lineart.y2 = h - wb;
 434         RrPaint(a_focus_indicator, focus_indicator.right.win,
 435                 w, h);
 436
 437         x = focus_cycle_target->frame->area.x;
 438         y = focus_cycle_target->frame->area.y +
 439             focus_cycle_target->frame->area.height - wb;
 440         w = focus_cycle_target->frame->area.width;
 441         h = wb;
 442
 443         XMoveResizeWindow(ob_display, focus_indicator.bottom.win,
 444                           x, y, w, h);
 445         a_focus_indicator->texture[0].data.lineart.x1 = 0;
 446         a_focus_indicator->texture[0].data.lineart.y1 = 0;
 447         a_focus_indicator->texture[0].data.lineart.x2 = 0;
 448         a_focus_indicator->texture[0].data.lineart.y2 = h-1;
 449         a_focus_indicator->texture[1].data.lineart.x1 = 0;
 450         a_focus_indicator->texture[1].data.lineart.y1 = h-1;
 451         a_focus_indicator->texture[1].data.lineart.x2 = w-1;
 452         a_focus_indicator->texture[1].data.lineart.y2 = h-1;
 453         a_focus_indicator->texture[2].data.lineart.x1 = w-1;
 454         a_focus_indicator->texture[2].data.lineart.y1 = h-1;
 455         a_focus_indicator->texture[2].data.lineart.x2 = w-1;
 456         a_focus_indicator->texture[2].data.lineart.y2 = 0;
 457         a_focus_indicator->texture[3].data.lineart.x1 = wl-1;
 458         a_focus_indicator->texture[3].data.lineart.y1 = 0;
 459         a_focus_indicator->texture[3].data.lineart.x2 = w - wr;
 460         a_focus_indicator->texture[3].data.lineart.y2 = 0;
 461         RrPaint(a_focus_indicator, focus_indicator.bottom.win,
 462                 w, h);
 463
 464         XMapWindow(ob_display, focus_indicator.top.win);
 465         XMapWindow(ob_display, focus_indicator.left.win);
 466         XMapWindow(ob_display, focus_indicator.right.win);
 467         XMapWindow(ob_display, focus_indicator.bottom.win);
 468     }
 469 }
 470
 471 static gboolean valid_focus_target(ObClient *ft)
 472 {
 473     /* we don't use client_can_focus here, because that doesn't let you
 474        focus an iconic window, but we want to be able to, so we just check
 475        if the focus flags on the window allow it, and its on the current
 476        desktop */
 477     if ((ft->type == OB_CLIENT_TYPE_NORMAL ||
 478          ft->type == OB_CLIENT_TYPE_DIALOG ||
 479          (!client_has_group_siblings(ft) &&
 480           (ft->type == OB_CLIENT_TYPE_TOOLBAR ||
 481            ft->type == OB_CLIENT_TYPE_MENU ||
 482            ft->type == OB_CLIENT_TYPE_UTILITY))) &&
 483         ((ft->can_focus || ft->focus_notify) &&
 484          !ft->skip_pager &&
 485          (ft->desktop == screen_desktop || ft->desktop == DESKTOP_ALL)) &&
 486         ft == client_focus_target(ft))
 487         return TRUE;
 488 /*
 489     {
 490         GSList *it;
 491
 492         for (it = ft->transients; it; it = g_slist_next(it)) {
 493             ObClient *c = it->data;
 494
 495             if (c->frame->visible)
 496                 return FALSE;
 497         }
 498         return TRUE;
 499     }
 500 */
 501
 502     return FALSE;
 503 }
 504
 505 void focus_cycle(gboolean forward, gboolean linear, gboolean interactive,
 506                  gboolean dialog, gboolean done, gboolean cancel)
 507 {
 508     static ObClient *first = NULL;
 509     static ObClient *t = NULL;
 510     static GList *order = NULL;
 511     GList *it, *start, *list;
 512     ObClient *ft = NULL;
 513
 514     if (interactive) {
 515         if (cancel) {
 516             focus_cycle_target = NULL;
 517             goto done_cycle;
 518         } else if (done)
 519             goto done_cycle;
 520
 521         if (!focus_order)
 522             goto done_cycle;
 523
 524         if (!first) first = focus_client;
 525
 526         if (linear) list = client_list;
 527         else        list = focus_order;
 528     } else {
 529         if (!focus_order)
 530             goto done_cycle;
 531         list = client_list;
 532     }
 533     if (!focus_cycle_target) focus_cycle_target = focus_client;
 534
 535     start = it = g_list_find(list, focus_cycle_target);
 536     if (!start) /* switched desktops or something? */
 537         start = it = forward ? g_list_last(list) : g_list_first(list);
 538     if (!start) goto done_cycle;
 539
 540     do {
 541         if (forward) {
 542             it = it->next;
 543             if (it == NULL) it = g_list_first(list);
 544         } else {
 545             it = it->prev;
 546             if (it == NULL) it = g_list_last(list);
 547         }
 548         ft = it->data;
 549         if (valid_focus_target(ft)) {
 550             if (interactive) {
 551                 if (ft != focus_cycle_target) { /* prevents flicker */
 552                     focus_cycle_target = ft;
 553                     focus_cycle_draw_indicator();
 554                 }
 555                 popup_cycle(ft, dialog);
 556                 return;
 557             } else if (ft != focus_cycle_target) {
 558                 focus_cycle_target = ft;
 559                 done = TRUE;
 560                 break;
 561             }
 562         }
 563     } while (it != start);
 564
 565 done_cycle:
 566     if (done && focus_cycle_target)
 567         client_activate(focus_cycle_target, FALSE, TRUE);
 568
 569     t = NULL;
 570     first = NULL;
 571     focus_cycle_target = NULL;
 572     g_list_free(order);
 573     order = NULL;
 574
 575     if (interactive) {
 576         focus_cycle_draw_indicator();
 577         popup_cycle(ft, FALSE);
 578     }
 579
 580     return;
 581 }
 582
 583 void focus_directional_cycle(ObDirection dir, gboolean interactive,
 584                              gboolean dialog, gboolean done, gboolean cancel)
 585 {
 586     static ObClient *first = NULL;
 587     ObClient *ft = NULL;
 588
 589     if (!interactive)
 590         return;
 591
 592     if (cancel) {
 593         focus_cycle_target = NULL;
 594         goto done_cycle;
 595     } else if (done)
 596         goto done_cycle;
 597
 598     if (!focus_order)
 599         goto done_cycle;
 600
 601     if (!first) first = focus_client;
 602     if (!focus_cycle_target) focus_cycle_target = focus_client;
 603
 604     if (focus_cycle_target)
 605         ft = client_find_directional(focus_cycle_target, dir);
 606     else {
 607         GList *it;
 608
 609         for (it = focus_order; it; it = g_list_next(it))
 610             if (valid_focus_target(it->data))
 611                 ft = it->data;
 612     }
 613
 614     if (ft) {
 615         if (ft != focus_cycle_target) {/* prevents flicker */
 616             focus_cycle_target = ft;
 617             focus_cycle_draw_indicator();
 618         }
 619     }
 620     if (focus_cycle_target) {
 621         popup_cycle(focus_cycle_target, dialog);
 622         if (dialog)
 623             return;
 624     }
 625
 626
 627 done_cycle:
 628     if (done && focus_cycle_target)
 629         client_activate(focus_cycle_target, FALSE, TRUE);
 630
 631     first = NULL;
 632     focus_cycle_target = NULL;
 633
 634     focus_cycle_draw_indicator();
 635     popup_cycle(ft, FALSE);
 636
 637     return;
 638 }
 639
 640 void focus_order_add_new(ObClient *c)
 641 {
 642     if (c->iconic)
 643         focus_order_to_top(c);
 644     else {
 645         g_assert(!g_list_find(focus_order, c));
 646         /* if there are any iconic windows, put this above them in the order,
 647            but if there are not, then put it under the currently focused one */
 648         if (focus_order && ((ObClient*)focus_order->data)->iconic)
 649             focus_order = g_list_insert(focus_order, c, 0);
 650         else
 651             focus_order = g_list_insert(focus_order, c, 1);
 652     }
 653 }
 654
 655 void focus_order_remove(ObClient *c)
 656 {
 657     focus_order = g_list_remove(focus_order, c);
 658 }
 659
 660 void focus_order_to_top(ObClient *c)
 661 {
 662     focus_order = g_list_remove(focus_order, c);
 663     if (!c->iconic) {
 664         focus_order = g_list_prepend(focus_order, c);
 665     } else {
 666         GList *it;
 667
 668         /* insert before first iconic window */
 669         for (it = focus_order;
 670              it && !((ObClient*)it->data)->iconic; it = g_list_next(it));
 671         focus_order = g_list_insert_before(focus_order, it, c);
 672     }
 673 }
 674
 675 void focus_order_to_bottom(ObClient *c)
 676 {
 677     focus_order = g_list_remove(focus_order, c);
 678     if (c->iconic) {
 679         focus_order = g_list_append(focus_order, c);
 680     } else {
 681         GList *it;
 682
 683         /* insert before first iconic window */
 684         for (it = focus_order;
 685              it && !((ObClient*)it->data)->iconic; it = g_list_next(it));
 686         focus_order = g_list_insert_before(focus_order, it, c);
 687     }
 688 }
 689
 690 ObClient *focus_order_find_first(guint desktop)
 691 {
 692     GList *it;
 693     for (it = focus_order; it; it = g_list_next(it)) {
 694         ObClient *c = it->data;
 695         if (c->desktop == desktop || c->desktop == DESKTOP_ALL)
 696             return c;
 697     }
 698     return NULL;
 699 }