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