1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
3 if.c for the Openbox window manager
4 Copyright (c) 2007 Mikael Magnusson
5 Copyright (c) 2007 Dana Jansens
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.
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.
17 See the COPYING file for a copy of the GNU General Public License.
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"
29 QUERY_TARGET_IS_ACTION_TARGET,
30 QUERY_TARGET_IS_FOCUS_TARGET,
43 GPatternSpec *pattern;
69 gboolean omnipresent_on;
70 gboolean omnipresent_off;
71 gboolean desktop_current;
72 gboolean desktop_other;
74 guint screendesktop_number;
89 static gpointer setup_func(xmlNodePtr node);
90 static void free_func(gpointer options);
91 static gboolean run_func_if(ObActionsData *data, gpointer options);
92 static gboolean run_func_continue(ObActionsData *data, gpointer options);
93 static gboolean run_func_stop(ObActionsData *data, gpointer options);
94 static gboolean run_func_foreach(ObActionsData *data, gpointer options);
95 static gboolean run_func_group(ObActionsData *data, gpointer options);
97 static gboolean foreach_stop;
99 void action_if_startup(void)
101 actions_register("If", setup_func, free_func, run_func_if);
102 actions_register("Stop", NULL, NULL, run_func_stop);
103 actions_register("Continue", NULL, NULL, run_func_continue);
104 actions_register("ForEach", setup_func, free_func, run_func_foreach);
106 actions_set_can_stop("Stop", TRUE);
107 //actions_register("GroupMembers", setup_func, free_func, run_func_group);
110 static inline void set_bool(xmlNodePtr node,
117 if ((n = obt_xml_find_node(node, name))) {
118 if (obt_xml_node_bool(n))
125 static void setup_typed_match(TypedMatch *tm, xmlNodePtr n)
128 if ((s = obt_xml_node_string(n))) {
130 if (!obt_xml_attr_string(n, "type", &type) ||
131 !g_ascii_strcasecmp(type, "pattern"))
133 tm->type = MATCH_TYPE_PATTERN;
134 tm->m.pattern = g_pattern_spec_new(s);
135 } else if (type && !g_ascii_strcasecmp(type, "regex")) {
136 tm->type = MATCH_TYPE_REGEX;
137 tm->m.regex = g_regex_new(s, 0, 0, NULL);
138 } else if (type && !g_ascii_strcasecmp(type, "exact")) {
139 tm->type = MATCH_TYPE_EXACT;
140 tm->m.exact = g_strdup(s);
147 static void free_typed_match(TypedMatch *tm)
150 case MATCH_TYPE_PATTERN:
151 g_pattern_spec_free(tm->m.pattern);
153 case MATCH_TYPE_REGEX:
154 g_regex_unref(tm->m.regex);
156 case MATCH_TYPE_EXACT:
159 case MATCH_TYPE_NONE:
164 static gboolean check_typed_match(TypedMatch *tm, const gchar *s)
167 case MATCH_TYPE_PATTERN:
168 return g_pattern_match_string(tm->m.pattern, s);
169 case MATCH_TYPE_REGEX:
170 return g_regex_match(tm->m.regex, s, 0, NULL);
171 case MATCH_TYPE_EXACT:
172 return !strcmp(tm->m.exact, s);
173 case MATCH_TYPE_NONE:
176 g_assert_not_reached();
179 static void setup_query(Options* o, xmlNodePtr node, QueryTarget target) {
180 Query *q = g_slice_new0(Query);
181 g_array_append_val(o->queries, q);
185 set_bool(node, "shaded", &q->shaded_on, &q->shaded_off);
186 set_bool(node, "maximized", &q->maxfull_on, &q->maxfull_off);
187 set_bool(node, "maximizedhorizontal", &q->maxhorz_on, &q->maxhorz_off);
188 set_bool(node, "maximizedvertical", &q->maxvert_on, &q->maxvert_off);
189 set_bool(node, "iconified", &q->iconic_on, &q->iconic_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);
197 if ((n = obt_xml_find_node(node, "desktop"))) {
199 if ((s = obt_xml_node_string(n))) {
200 if (!g_ascii_strcasecmp(s, "current"))
201 q->desktop_current = TRUE;
202 if (!g_ascii_strcasecmp(s, "other"))
203 q->desktop_other = TRUE;
205 q->desktop_number = atoi(s);
209 if ((n = obt_xml_find_node(node, "activedesktop"))) {
210 q->screendesktop_number = obt_xml_node_int(n);
212 if ((n = obt_xml_find_node(node, "title"))) {
213 setup_typed_match(&q->title, n);
215 if ((n = obt_xml_find_node(node, "class"))) {
216 setup_typed_match(&q->class, n);
218 if ((n = obt_xml_find_node(node, "name"))) {
219 setup_typed_match(&q->name, n);
221 if ((n = obt_xml_find_node(node, "role"))) {
222 setup_typed_match(&q->role, n);
224 if ((n = obt_xml_find_node(node, "type"))) {
225 setup_typed_match(&q->type, n);
227 if ((n = obt_xml_find_node(node, "monitor"))) {
228 q->client_monitor = obt_xml_node_int(n);
232 static gpointer setup_func(xmlNodePtr node)
234 Options *o = g_slice_new0(Options);
236 gboolean zero_terminated = FALSE;
237 gboolean clear_to_zero_on_alloc = FALSE;
238 o->queries = g_array_new(zero_terminated,
239 clear_to_zero_on_alloc,
243 if ((n = obt_xml_find_node(node, "then"))) {
246 m = obt_xml_find_node(n->children, "action");
248 ObActionsAct *action = actions_parse(m);
249 if (action) o->thenacts = g_slist_append(o->thenacts, action);
250 m = obt_xml_find_node(m->next, "action");
253 if ((n = obt_xml_find_node(node, "else"))) {
256 m = obt_xml_find_node(n->children, "action");
258 ObActionsAct *action = actions_parse(m);
259 if (action) o->elseacts = g_slist_append(o->elseacts, action);
260 m = obt_xml_find_node(m->next, "action");
264 xmlNodePtr query_node = obt_xml_find_node(node, "query");
266 /* The default query if none is specified. It uses the conditions
267 found in the action's node. */
270 QUERY_TARGET_IS_ACTION_TARGET);
273 QueryTarget query_target = QUERY_TARGET_IS_ACTION_TARGET;
274 if (obt_xml_attr_contains(query_node, "target", "focus"))
275 query_target = QUERY_TARGET_IS_FOCUS_TARGET;
277 setup_query(o, query_node->children, query_target);
279 query_node = obt_xml_find_node(query_node->next, "query");
286 static void free_func(gpointer options)
288 Options *o = options;
291 for (i = 0; i < o->queries->len; ++i) {
292 Query *q = g_array_index(o->queries, Query*, i);
294 free_typed_match(&q->title);
295 free_typed_match(&q->class);
296 free_typed_match(&q->name);
297 free_typed_match(&q->role);
298 free_typed_match(&q->type);
300 g_slice_free(Query, q);
303 while (o->thenacts) {
304 actions_act_unref(o->thenacts->data);
305 o->thenacts = g_slist_delete_link(o->thenacts, o->thenacts);
307 while (o->elseacts) {
308 actions_act_unref(o->elseacts->data);
309 o->elseacts = g_slist_delete_link(o->elseacts, o->elseacts);
312 g_array_unref(o->queries);
313 g_slice_free(Options, o);
316 /* Always return FALSE because its not interactive */
317 static gboolean run_func_if(ObActionsData *data, gpointer options)
319 Options *o = options;
320 ObClient *action_target = data->client;
321 gboolean is_true = TRUE;
324 for (i = 0; is_true && i < o->queries->len; ++i) {
325 Query *q = g_array_index(o->queries, Query*, i);
326 ObClient *query_target = NULL;
329 case QUERY_TARGET_IS_ACTION_TARGET:
330 query_target = data->client;
332 case QUERY_TARGET_IS_FOCUS_TARGET:
333 query_target = focus_client;
337 /* If there's no client to query, then false. */
344 is_true &= query_target->shaded;
346 is_true &= !query_target->shaded;
349 is_true &= query_target->iconic;
351 is_true &= !query_target->iconic;
354 is_true &= query_target->locked;
356 is_true &= !query_target->locked;
359 is_true &= query_target->max_horz;
361 is_true &= !query_target->max_horz;
364 is_true &= query_target->max_vert;
366 is_true &= !query_target->max_vert;
368 gboolean is_max_full =
369 query_target->max_vert && query_target->max_horz;
371 is_true &= is_max_full;
373 is_true &= !is_max_full;
376 is_true &= query_target == focus_client;
378 is_true &= query_target != focus_client;
381 query_target->urgent || query_target->demands_attention;
383 is_true &= is_urgent;
385 is_true &= !is_urgent;
387 gboolean has_visible_title_bar =
388 !query_target->undecorated &&
389 (query_target->decorations & OB_FRAME_DECOR_TITLEBAR);
391 is_true &= has_visible_title_bar;
393 is_true &= !has_visible_title_bar;
395 if (q->omnipresent_on)
396 is_true &= query_target->desktop == DESKTOP_ALL;
397 if (q->omnipresent_off)
398 is_true &= query_target->desktop != DESKTOP_ALL;
400 gboolean is_on_current_desktop =
401 query_target->desktop == screen_desktop ||
402 query_target->desktop == DESKTOP_ALL;
403 if (q->desktop_current)
404 is_true &= is_on_current_desktop;
405 if (q->desktop_other)
406 is_true &= !is_on_current_desktop;
408 if (q->desktop_number) {
409 gboolean is_on_desktop =
410 query_target->desktop == q->desktop_number - 1 ||
411 query_target->desktop == DESKTOP_ALL;
412 is_true &= is_on_desktop;
415 if (q->screendesktop_number)
416 is_true &= screen_desktop == q->screendesktop_number - 1;
418 is_true &= check_typed_match(&q->title, query_target->original_title);
419 is_true &= check_typed_match(&q->class, query_target->class);
420 is_true &= check_typed_match(&q->name, query_target->name);
421 is_true &= check_typed_match(&q->role, query_target->role);
422 is_true &= check_typed_match(&q->type,
423 client_type_to_string(query_target));
425 if (q->client_monitor)
426 is_true &= client_monitor(query_target) == q->client_monitor - 1;
436 actions_run_acts(acts, data->uact, data->state,
437 data->x, data->y, data->button,
438 data->context, action_target);
443 static gboolean run_func_foreach(ObActionsData *data, gpointer options)
447 foreach_stop = FALSE;
449 for (it = client_list; it; it = g_list_next(it)) {
450 data->client = it->data;
451 run_func_if(data, options);
453 foreach_stop = FALSE;
461 static gboolean run_func_continue(ObActionsData *data, gpointer options)
467 static gboolean run_func_group(ObActionsData *data, gpointer acts)
469 GSList *it, *a = acts;
470 ObClient *c = data->client;
473 for (it = c->group->members; it; it = g_slist_next(it)) {
474 ObClient *member = it->data;
475 if (actions_run_acts(a, data->uact, data->state,
476 data->x, data->y, data->button,
477 data->context, member))
485 static gboolean run_func_stop(ObActionsData *data, gpointer options)
487 /* This stops the loop above so we don't invoke actions on any more
491 /* TRUE causes actions_run_acts to not run further actions on the current