openbox/actions/if.c

   1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
   2
   3    if.c for the Openbox window manager
   4    Copyright (c) 2007        Mikael Magnusson
   5    Copyright (c) 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 "openbox/actions.h"
  21 #include "openbox/misc.h"
  22 #include "openbox/client.h"
  23 #include "openbox/frame.h"
  24 #include "openbox/screen.h"
  25 #include "openbox/focus.h"
  26 #include <glib.h>
  27
  28 typedef enum {
  29     QUERY_TARGET_IS_ACTION_TARGET,
  30     QUERY_TARGET_IS_FOCUS_TARGET,
  31 } QueryTarget;
  32
  33 typedef enum {
  34     MATCH_TYPE_NONE = 0,
  35     MATCH_TYPE_PATTERN,
  36     MATCH_TYPE_REGEX,
  37     MATCH_TYPE_EXACT,
  38 } MatchType;
  39
  40 typedef struct {
  41     MatchType type;
  42     union m {
  43         GPatternSpec *pattern;
  44         GRegex *regex;
  45         gchar *exact;
  46     } m;
  47 } TypedMatch;
  48
  49 typedef struct {
  50     QueryTarget target;
  51     gboolean shaded_on;
  52     gboolean shaded_off;
  53     gboolean maxvert_on;
  54     gboolean maxvert_off;
  55     gboolean maxhorz_on;
  56     gboolean maxhorz_off;
  57     gboolean maxfull_on;
  58     gboolean maxfull_off;
  59     gboolean iconic_on;
  60     gboolean iconic_off;
  61     gboolean fullscreen_on;
  62     gboolean fullscreen_off;
  63     gboolean locked_on;
  64     gboolean locked_off;
  65     gboolean focused;
  66     gboolean unfocused;
  67     gboolean urgent_on;
  68     gboolean urgent_off;
  69     gboolean decor_off;
  70     gboolean decor_on;
  71     gboolean omnipresent_on;
  72     gboolean omnipresent_off;
  73     gboolean desktop_current;
  74     gboolean desktop_other;
  75     gboolean desktop_last;
  76     guint    desktop_number;
  77     guint    screendesktop_number;
  78     guint    client_monitor;
  79     TypedMatch title;
  80     TypedMatch class;
  81     TypedMatch name;
  82     TypedMatch role;
  83     TypedMatch type;
  84 } Query;
  85
  86 typedef struct {
  87     GArray *queries;
  88     GSList *thenacts;
  89     GSList *elseacts;
  90 } Options;
  91
  92 static gpointer setup_func(xmlNodePtr node);
  93 static void     free_func(gpointer options);
  94 static gboolean run_func_if(ObActionsData *data, gpointer options);
  95 static gboolean run_func_stop(ObActionsData *data, gpointer options);
  96 static gboolean run_func_foreach(ObActionsData *data, gpointer options);
  97
  98 static gboolean foreach_stop;
  99
 100 void action_if_startup(void)
 101 {
 102     actions_register("If", setup_func, free_func, run_func_if);
 103     actions_register("Stop", NULL, NULL, run_func_stop);
 104     actions_register("ForEach", setup_func, free_func, run_func_foreach);
 105
 106     actions_set_can_stop("Stop", TRUE);
 107 }
 108
 109 static inline void set_bool(xmlNodePtr node,
 110                             const char *name,
 111                             gboolean *on,
 112                             gboolean *off)
 113 {
 114     xmlNodePtr n;
 115
 116     if ((n = obt_xml_find_node(node, name))) {
 117         if (obt_xml_node_bool(n))
 118             *on = TRUE;
 119         else
 120             *off = TRUE;
 121     }
 122 }
 123
 124 static void setup_typed_match(TypedMatch *tm, xmlNodePtr n)
 125 {
 126     gchar *s;
 127     if ((s = obt_xml_node_string(n))) {
 128         gchar *type = NULL;
 129         if (!obt_xml_attr_string(n, "type", &type) ||
 130             !g_ascii_strcasecmp(type, "pattern"))
 131         {
 132             tm->type = MATCH_TYPE_PATTERN;
 133             tm->m.pattern = g_pattern_spec_new(s);
 134         } else if (type && !g_ascii_strcasecmp(type, "regex")) {
 135             tm->type = MATCH_TYPE_REGEX;
 136             tm->m.regex = g_regex_new(s, 0, 0, NULL);
 137         } else if (type && !g_ascii_strcasecmp(type, "exact")) {
 138             tm->type = MATCH_TYPE_EXACT;
 139             tm->m.exact = g_strdup(s);
 140         }
 141         g_free(s);
 142         g_free(type);
 143     }
 144 }
 145
 146 static void free_typed_match(TypedMatch *tm)
 147 {
 148     switch (tm->type) {
 149     case MATCH_TYPE_PATTERN:
 150         g_pattern_spec_free(tm->m.pattern);
 151         break;
 152     case MATCH_TYPE_REGEX:
 153         g_regex_unref(tm->m.regex);
 154         break;
 155     case MATCH_TYPE_EXACT:
 156         g_free(tm->m.exact);
 157         break;
 158     case MATCH_TYPE_NONE:
 159         break;
 160     }
 161 }
 162
 163 static gboolean check_typed_match(TypedMatch *tm, const gchar *s)
 164 {
 165     switch (tm->type) {
 166     case MATCH_TYPE_PATTERN:
 167         return g_pattern_match_string(tm->m.pattern, s);
 168     case MATCH_TYPE_REGEX:
 169         return g_regex_match(tm->m.regex, s, 0, NULL);
 170     case MATCH_TYPE_EXACT:
 171         return !strcmp(tm->m.exact, s);
 172     case MATCH_TYPE_NONE:
 173         return TRUE;
 174     }
 175     g_assert_not_reached();
 176 }
 177
 178 static void setup_query(Options* o, xmlNodePtr node, QueryTarget target) {
 179     Query *q = g_slice_new0(Query);
 180     g_array_append_val(o->queries, q);
 181
 182     q->target = target;
 183
 184     set_bool(node, "shaded", &q->shaded_on, &q->shaded_off);
 185     set_bool(node, "maximized", &q->maxfull_on, &q->maxfull_off);
 186     set_bool(node, "maximizedhorizontal", &q->maxhorz_on, &q->maxhorz_off);
 187     set_bool(node, "maximizedvertical", &q->maxvert_on, &q->maxvert_off);
 188     set_bool(node, "iconified", &q->iconic_on, &q->iconic_off);
 189     set_bool(node, "fullscreen", &q->fullscreen_on, &q->fullscreen_off);
 190     set_bool(node, "locked", &q->locked_on, &q->locked_off);
 191     set_bool(node, "focused", &q->focused, &q->unfocused);
 192     set_bool(node, "urgent", &q->urgent_on, &q->urgent_off);
 193     set_bool(node, "undecorated", &q->decor_off, &q->decor_on);
 194     set_bool(node, "omnipresent", &q->omnipresent_on, &q->omnipresent_off);
 195
 196     xmlNodePtr n;
 197     if ((n = obt_xml_find_node(node, "desktop"))) {
 198         gchar *s;
 199         if ((s = obt_xml_node_string(n))) {
 200             if (!g_ascii_strcasecmp(s, "current"))
 201                 q->desktop_current = TRUE;
 202             else if (!g_ascii_strcasecmp(s, "other"))
 203                 q->desktop_other = TRUE;
 204             else if (!g_ascii_strcasecmp(s, "last"))
 205                 q->desktop_last = TRUE;
 206             else
 207                 q->desktop_number = atoi(s);
 208             g_free(s);
 209         }
 210     }
 211     if ((n = obt_xml_find_node(node, "activedesktop"))) {
 212         q->screendesktop_number = obt_xml_node_int(n);
 213     }
 214     if ((n = obt_xml_find_node(node, "title"))) {
 215         setup_typed_match(&q->title, n);
 216     }
 217     if ((n = obt_xml_find_node(node, "class"))) {
 218         setup_typed_match(&q->class, n);
 219     }
 220     if ((n = obt_xml_find_node(node, "name"))) {
 221         setup_typed_match(&q->name, n);
 222     }
 223     if ((n = obt_xml_find_node(node, "role"))) {
 224         setup_typed_match(&q->role, n);
 225     }
 226     if ((n = obt_xml_find_node(node, "type"))) {
 227         setup_typed_match(&q->type, n);
 228     }
 229     if ((n = obt_xml_find_node(node, "monitor"))) {
 230         q->client_monitor = obt_xml_node_int(n);
 231     }
 232 }
 233
 234 static gpointer setup_func(xmlNodePtr node)
 235 {
 236     Options *o = g_slice_new0(Options);
 237
 238     gboolean zero_terminated = FALSE;
 239     gboolean clear_to_zero_on_alloc = FALSE;
 240     o->queries = g_array_new(zero_terminated,
 241                              clear_to_zero_on_alloc,
 242                              sizeof(Query*));
 243
 244     xmlNodePtr n;
 245     if ((n = obt_xml_find_node(node, "then"))) {
 246         xmlNodePtr m;
 247
 248         m = obt_xml_find_node(n->children, "action");
 249         while (m) {
 250             ObActionsAct *action = actions_parse(m);
 251             if (action) o->thenacts = g_slist_append(o->thenacts, action);
 252             m = obt_xml_find_node(m->next, "action");
 253         }
 254     }
 255     if ((n = obt_xml_find_node(node, "else"))) {
 256         xmlNodePtr m;
 257
 258         m = obt_xml_find_node(n->children, "action");
 259         while (m) {
 260             ObActionsAct *action = actions_parse(m);
 261             if (action) o->elseacts = g_slist_append(o->elseacts, action);
 262             m = obt_xml_find_node(m->next, "action");
 263         }
 264     }
 265
 266     xmlNodePtr query_node = obt_xml_find_node(node, "query");
 267     if (!query_node) {
 268         /* The default query if none is specified. It uses the conditions
 269            found in the action's node. */
 270         setup_query(o,
 271                     node,
 272                     QUERY_TARGET_IS_ACTION_TARGET);
 273     } else {
 274         while (query_node) {
 275             QueryTarget query_target = QUERY_TARGET_IS_ACTION_TARGET;
 276             if (obt_xml_attr_contains(query_node, "target", "focus"))
 277                 query_target = QUERY_TARGET_IS_FOCUS_TARGET;
 278
 279             setup_query(o, query_node->children, query_target);
 280
 281             query_node = obt_xml_find_node(query_node->next, "query");
 282         }
 283     }
 284
 285     return o;
 286 }
 287
 288 static void free_func(gpointer options)
 289 {
 290     Options *o = options;
 291
 292     guint i;
 293     for (i = 0; i < o->queries->len; ++i) {
 294         Query *q = g_array_index(o->queries, Query*, i);
 295
 296         free_typed_match(&q->title);
 297         free_typed_match(&q->class);
 298         free_typed_match(&q->name);
 299         free_typed_match(&q->role);
 300         free_typed_match(&q->type);
 301
 302         g_slice_free(Query, q);
 303     }
 304
 305     while (o->thenacts) {
 306         actions_act_unref(o->thenacts->data);
 307         o->thenacts = g_slist_delete_link(o->thenacts, o->thenacts);
 308     }
 309     while (o->elseacts) {
 310         actions_act_unref(o->elseacts->data);
 311         o->elseacts = g_slist_delete_link(o->elseacts, o->elseacts);
 312     }
 313
 314     g_array_unref(o->queries);
 315     g_slice_free(Options, o);
 316 }
 317
 318 /* Always return FALSE because its not interactive */
 319 static gboolean run_func_if(ObActionsData *data, gpointer options)
 320 {
 321     Options *o = options;
 322     ObClient *action_target = data->client;
 323     gboolean is_true = TRUE;
 324
 325     guint i;
 326     for (i = 0; is_true && i < o->queries->len; ++i) {
 327         Query *q = g_array_index(o->queries, Query*, i);
 328         ObClient *query_target = NULL;
 329
 330         switch (q->target) {
 331         case QUERY_TARGET_IS_ACTION_TARGET:
 332             query_target = data->client;
 333             break;
 334         case QUERY_TARGET_IS_FOCUS_TARGET:
 335             query_target = focus_client;
 336             break;
 337         }
 338
 339         /* If there's no client to query, then false. */
 340         if (!query_target) {
 341             is_true = FALSE;
 342             break;
 343         }
 344
 345         if (q->shaded_on)
 346             is_true &= query_target->shaded;
 347         if (q->shaded_off)
 348             is_true &= !query_target->shaded;
 349
 350         if (q->iconic_on)
 351             is_true &= query_target->iconic;
 352         if (q->iconic_off)
 353             is_true &= !query_target->iconic;
 354
 355         if (q->fullscreen_on)
 356             is_true &= query_target->fullscreen;
 357         if (q->fullscreen_off)
 358             is_true &= !query_target->fullscreen;
 359
 360         if (q->locked_on)
 361             is_true &= query_target->locked;
 362         if (q->locked_off)
 363             is_true &= !query_target->locked;
 364
 365         if (q->maxhorz_on)
 366             is_true &= query_target->max_horz;
 367         if (q->maxhorz_off)
 368             is_true &= !query_target->max_horz;
 369
 370         if (q->maxvert_on)
 371             is_true &= query_target->max_vert;
 372         if (q->maxvert_off)
 373             is_true &= !query_target->max_vert;
 374
 375         gboolean is_max_full =
 376             query_target->max_vert && query_target->max_horz;
 377         if (q->maxfull_on)
 378             is_true &= is_max_full;
 379         if (q->maxfull_off)
 380             is_true &= !is_max_full;
 381
 382         if (q->focused)
 383             is_true &= query_target == focus_client;
 384         if (q->unfocused)
 385             is_true &= query_target != focus_client;
 386
 387         gboolean is_urgent =
 388             query_target->urgent || query_target->demands_attention;
 389         if (q->urgent_on)
 390             is_true &= is_urgent;
 391         if (q->urgent_off)
 392             is_true &= !is_urgent;
 393
 394         gboolean has_visible_title_bar =
 395             !query_target->undecorated &&
 396             (query_target->decorations & OB_FRAME_DECOR_TITLEBAR);
 397         if (q->decor_on)
 398             is_true &= has_visible_title_bar;
 399         if (q->decor_off)
 400             is_true &= !has_visible_title_bar;
 401
 402         if (q->omnipresent_on)
 403             is_true &= query_target->desktop == DESKTOP_ALL;
 404         if (q->omnipresent_off)
 405             is_true &= query_target->desktop != DESKTOP_ALL;
 406
 407         gboolean is_on_current_desktop =
 408             query_target->desktop == screen_desktop ||
 409             query_target->desktop == DESKTOP_ALL;
 410         if (q->desktop_current)
 411             is_true &= is_on_current_desktop;
 412         if (q->desktop_other)
 413             is_true &= !is_on_current_desktop;
 414         if (q->desktop_last)
 415             is_true &= query_target->desktop == screen_last_desktop;
 416
 417         if (q->desktop_number) {
 418             gboolean is_on_desktop =
 419                 query_target->desktop == q->desktop_number - 1 ||
 420                 query_target->desktop == DESKTOP_ALL;
 421             is_true &= is_on_desktop;
 422         }
 423
 424         if (q->screendesktop_number)
 425             is_true &= screen_desktop == q->screendesktop_number - 1;
 426
 427         is_true &= check_typed_match(&q->title, query_target->original_title);
 428         is_true &= check_typed_match(&q->class, query_target->class);
 429         is_true &= check_typed_match(&q->name, query_target->name);
 430         is_true &= check_typed_match(&q->role, query_target->role);
 431         is_true &= check_typed_match(&q->type,
 432                                      client_type_to_string(query_target));
 433
 434         if (q->client_monitor)
 435             is_true &= client_monitor(query_target) == q->client_monitor - 1;
 436
 437     }
 438
 439     GSList *acts;
 440     if (is_true)
 441         acts = o->thenacts;
 442     else
 443         acts = o->elseacts;
 444
 445     actions_run_acts(acts, data->uact, data->state,
 446                      data->x, data->y, data->button,
 447                      data->context, action_target);
 448
 449     return FALSE;
 450 }
 451
 452 static gboolean run_func_foreach(ObActionsData *data, gpointer options)
 453 {
 454     GList *it;
 455
 456     foreach_stop = FALSE;
 457
 458     for (it = client_list; it; it = g_list_next(it)) {
 459         data->client = it->data;
 460         run_func_if(data, options);
 461         if (foreach_stop) {
 462             foreach_stop = FALSE;
 463             break;
 464         }
 465     }
 466
 467     return FALSE;
 468 }
 469
 470 static gboolean run_func_stop(ObActionsData *data, gpointer options)
 471 {
 472     /* This stops the loop above so we don't invoke actions on any more
 473        clients */
 474     foreach_stop = TRUE;
 475
 476     /* TRUE causes actions_run_acts to not run further actions on the current
 477        client */
 478     return TRUE;
 479 }