openbox/focus_cycle.c

   1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
   2
   3    focus_cycle.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.h"
  21 #include "focus_cycle_indicator.h"
  22 #include "client.h"
  23 #include "frame.h"
  24 #include "focus.h"
  25 #include "screen.h"
  26 #include "openbox.h"
  27 #include "debug.h"
  28
  29 #include <X11/Xlib.h>
  30 #include <glib.h>
  31
  32 ObClient       *focus_cycle_target = NULL;
  33 static gboolean focus_cycle_iconic_windows;
  34 static gboolean focus_cycle_all_desktops;
  35 static gboolean focus_cycle_dock_windows;
  36 static gboolean focus_cycle_desktop_windows;
  37
  38 static ObClient *focus_find_directional(ObClient *c,
  39                                         ObDirection dir,
  40                                         gboolean dock_windows,
  41                                         gboolean desktop_windows);
  42
  43 void focus_cycle_startup(gboolean reconfig)
  44 {
  45     if (reconfig) return;
  46 }
  47
  48 void focus_cycle_shutdown(gboolean reconfig)
  49 {
  50     if (reconfig) return;
  51 }
  52
  53 gboolean focus_interruptable(ObClient *ifclient)
  54 {
  55     /* stop focus cycling if the given client is a valid focus target,
  56        and so the cycling is being disrupted */
  57     return focus_cycle_target && ifclient &&
  58            focus_valid_target(ifclient, TRUE,
  59                               focus_cycle_iconic_windows,
  60                               focus_cycle_all_desktops,
  61                               focus_cycle_dock_windows,
  62                               focus_cycle_desktop_windows);
  63 }
  64
  65 void focus_cycle_stop(ObClient *ifclient)
  66 {
  67     if (focus_interruptable(ifclient)) {
  68         focus_cycle(TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE,TRUE);
  69         focus_directional_cycle(0, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE);
  70     }
  71 }
  72
  73 ObClient* focus_cycle(gboolean forward, gboolean all_desktops,
  74                       gboolean dock_windows, gboolean desktop_windows,
  75                       gboolean linear, gboolean interactive,
  76                       gboolean showbar, ObFocusCyclePopupMode mode,
  77                       gboolean done, gboolean cancel)
  78 {
  79     static GList *order = NULL;
  80     GList *it, *start, *list;
  81     ObClient *ft = NULL;
  82     ObClient *ret = NULL;
  83
  84     if (interactive) {
  85         if (cancel) {
  86             focus_cycle_target = NULL;
  87             goto done_cycle;
  88         } else if (done)
  89             goto done_cycle;
  90
  91         if (!focus_order)
  92             goto done_cycle;
  93
  94         if (linear) list = client_list;
  95         else        list = focus_order;
  96     } else {
  97         if (!focus_order)
  98             goto done_cycle;
  99         list = client_list;
 100     }
 101
 102     if (focus_cycle_target == NULL) {
 103         focus_cycle_iconic_windows = TRUE;
 104         focus_cycle_all_desktops = all_desktops;
 105         focus_cycle_dock_windows = dock_windows;
 106         focus_cycle_desktop_windows = desktop_windows;
 107         start = it = g_list_find(list, focus_client);
 108     } else
 109         start = it = g_list_find(list, focus_cycle_target);
 110
 111     if (!start) /* switched desktops or something? */
 112         start = it = forward ? g_list_last(list) : g_list_first(list);
 113     if (!start) goto done_cycle;
 114
 115     do {
 116         if (forward) {
 117             it = it->next;
 118             if (it == NULL) it = g_list_first(list);
 119         } else {
 120             it = it->prev;
 121             if (it == NULL) it = g_list_last(list);
 122         }
 123         ft = it->data;
 124         if (focus_valid_target(ft, TRUE,
 125                                focus_cycle_iconic_windows,
 126                                focus_cycle_all_desktops,
 127                                focus_cycle_dock_windows,
 128                                focus_cycle_desktop_windows))
 129         {
 130             if (interactive) {
 131                 if (ft != focus_cycle_target) { /* prevents flicker */
 132                     focus_cycle_target = ft;
 133                     focus_cycle_draw_indicator(showbar ? ft : NULL);
 134                 }
 135                 /* same arguments as focus_target_valid */
 136                 focus_cycle_popup_show(ft,
 137                                        focus_cycle_iconic_windows,
 138                                        focus_cycle_all_desktops,
 139                                        focus_cycle_dock_windows,
 140                                        focus_cycle_desktop_windows,
 141                                        mode);
 142                 return focus_cycle_target;
 143             } else if (ft != focus_cycle_target) {
 144                 focus_cycle_target = ft;
 145                 done = TRUE;
 146                 break;
 147             }
 148         }
 149     } while (it != start);
 150
 151 done_cycle:
 152     if (done && !cancel) ret = focus_cycle_target;
 153
 154     focus_cycle_target = NULL;
 155     g_list_free(order);
 156     order = NULL;
 157
 158     if (interactive) {
 159         focus_cycle_draw_indicator(NULL);
 160         focus_cycle_popup_hide();
 161     }
 162
 163     return ret;
 164 }
 165
 166 /* this be mostly ripped from fvwm */
 167 static ObClient *focus_find_directional(ObClient *c, ObDirection dir,
 168                                         gboolean dock_windows,
 169                                         gboolean desktop_windows)
 170 {
 171     gint my_cx, my_cy, his_cx, his_cy;
 172     gint offset = 0;
 173     gint distance = 0;
 174     gint score, best_score;
 175     ObClient *best_client, *cur;
 176     GList *it;
 177
 178     if (!client_list)
 179         return NULL;
 180
 181     /* first, find the centre coords of the currently focused window */
 182     my_cx = c->frame->area.x + c->frame->area.width / 2;
 183     my_cy = c->frame->area.y + c->frame->area.height / 2;
 184
 185     best_score = -1;
 186     best_client = c;
 187
 188     for (it = g_list_first(client_list); it; it = g_list_next(it)) {
 189         cur = it->data;
 190
 191         /* the currently selected window isn't interesting */
 192         if (cur == c)
 193             continue;
 194         if (!focus_valid_target(it->data, TRUE, FALSE, FALSE, dock_windows,
 195                                 desktop_windows))
 196             continue;
 197
 198         /* find the centre coords of this window, from the
 199          * currently focused window's point of view */
 200         his_cx = (cur->frame->area.x - my_cx)
 201             + cur->frame->area.width / 2;
 202         his_cy = (cur->frame->area.y - my_cy)
 203             + cur->frame->area.height / 2;
 204
 205         if (dir == OB_DIRECTION_NORTHEAST || dir == OB_DIRECTION_SOUTHEAST ||
 206             dir == OB_DIRECTION_SOUTHWEST || dir == OB_DIRECTION_NORTHWEST)
 207         {
 208             gint tx;
 209             /* Rotate the diagonals 45 degrees counterclockwise.
 210              * To do this, multiply the matrix /+h +h\ with the
 211              * vector (x y).                   \-h +h/
 212              * h = sqrt(0.5). We can set h := 1 since absolute
 213              * distance doesn't matter here. */
 214             tx = his_cx + his_cy;
 215             his_cy = -his_cx + his_cy;
 216             his_cx = tx;
 217         }
 218
 219         switch (dir) {
 220         case OB_DIRECTION_NORTH:
 221         case OB_DIRECTION_SOUTH:
 222         case OB_DIRECTION_NORTHEAST:
 223         case OB_DIRECTION_SOUTHWEST:
 224             offset = (his_cx < 0) ? -his_cx : his_cx;
 225             distance = ((dir == OB_DIRECTION_NORTH ||
 226                          dir == OB_DIRECTION_NORTHEAST) ?
 227                         -his_cy : his_cy);
 228             break;
 229         case OB_DIRECTION_EAST:
 230         case OB_DIRECTION_WEST:
 231         case OB_DIRECTION_SOUTHEAST:
 232         case OB_DIRECTION_NORTHWEST:
 233             offset = (his_cy < 0) ? -his_cy : his_cy;
 234             distance = ((dir == OB_DIRECTION_WEST ||
 235                          dir == OB_DIRECTION_NORTHWEST) ?
 236                         -his_cx : his_cx);
 237             break;
 238         }
 239
 240         /* the target must be in the requested direction */
 241         if (distance <= 0)
 242             continue;
 243
 244         /* Calculate score for this window.  The smaller the better. */
 245         score = distance + offset;
 246
 247         /* windows more than 45 degrees off the direction are
 248          * heavily penalized and will only be chosen if nothing
 249          * else within a million pixels */
 250         if (offset > distance)
 251             score += 1000000;
 252
 253         if (best_score == -1 || score < best_score) {
 254             best_client = cur;
 255             best_score = score;
 256         }
 257     }
 258
 259     return best_client;
 260 }
 261
 262 ObClient* focus_directional_cycle(ObDirection dir, gboolean dock_windows,
 263                                   gboolean desktop_windows,
 264                                   gboolean interactive,
 265                                   gboolean showbar, gboolean dialog,
 266                                   gboolean done, gboolean cancel)
 267 {
 268     static ObClient *first = NULL;
 269     ObClient *ft = NULL;
 270     ObClient *ret = NULL;
 271
 272     if (cancel) {
 273         focus_cycle_target = NULL;
 274         goto done_cycle;
 275     } else if (done && interactive)
 276         goto done_cycle;
 277
 278     if (!focus_order)
 279         goto done_cycle;
 280
 281     if (focus_cycle_target == NULL) {
 282         focus_cycle_iconic_windows = FALSE;
 283         focus_cycle_all_desktops = FALSE;
 284         focus_cycle_dock_windows = dock_windows;
 285         focus_cycle_desktop_windows = desktop_windows;
 286     }
 287
 288     if (!g_list_find(client_list, first))
 289         first = focus_client;
 290
 291     if (g_list_find(client_list, focus_cycle_target))
 292         ft = focus_find_directional(focus_cycle_target, dir, dock_windows,
 293                                     desktop_windows);
 294     else if (first)
 295         ft = focus_find_directional(first, dir, dock_windows, desktop_windows);
 296     else {
 297         GList *it;
 298
 299         for (it = focus_order; it; it = g_list_next(it))
 300             if (focus_valid_target(it->data, TRUE,
 301                                    focus_cycle_iconic_windows,
 302                                    focus_cycle_all_desktops,
 303                                    focus_cycle_dock_windows,
 304                                    focus_cycle_desktop_windows))
 305                 ft = it->data;
 306     }
 307
 308     if (ft && ft != focus_cycle_target) {/* prevents flicker */
 309         focus_cycle_target = ft;
 310         if (!interactive)
 311             goto done_cycle;
 312         focus_cycle_draw_indicator(showbar ? ft : NULL);
 313     }
 314     if (focus_cycle_target && dialog)
 315         /* same arguments as focus_target_valid */
 316         focus_cycle_popup_single_show(focus_cycle_target,
 317                                       focus_cycle_iconic_windows,
 318                                       focus_cycle_all_desktops,
 319                                       focus_cycle_dock_windows,
 320                                       focus_cycle_desktop_windows);
 321     return focus_cycle_target;
 322
 323 done_cycle:
 324     if (done && !cancel) ret = focus_cycle_target;
 325
 326     first = NULL;
 327     focus_cycle_target = NULL;
 328
 329     focus_cycle_draw_indicator(NULL);
 330     focus_cycle_popup_single_hide();
 331
 332     return ret;
 333 }