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;
67 gboolean omnipresent_on;
68 gboolean omnipresent_off;
69 gboolean desktop_current;
70 gboolean desktop_other;
72 guint screendesktop_number;
87 static gpointer setup_func(xmlNodePtr node);
88 static void free_func(gpointer options);
89 static gboolean run_func_if(ObActionsData *data, gpointer options);
90 static gboolean run_func_stop(ObActionsData *data, gpointer options);
91 static gboolean run_func_foreach(ObActionsData *data, gpointer options);
93 static gboolean foreach_stop;
95 void action_if_startup(void)
97 actions_register("If", setup_func, free_func, run_func_if);
98 actions_register("Stop", NULL, NULL, run_func_stop);
99 actions_register("ForEach", setup_func, free_func, run_func_foreach);
101 actions_set_can_stop("Stop", TRUE);
104 static inline void set_bool(xmlNodePtr node,
111 if ((n = obt_xml_find_node(node, name))) {
112 if (obt_xml_node_bool(n))
119 static void setup_typed_match(TypedMatch *tm, xmlNodePtr n)
122 if ((s = obt_xml_node_string(n))) {
124 if (!obt_xml_attr_string(n, "type", &type) ||
125 !g_ascii_strcasecmp(type, "pattern"))
127 tm->type = MATCH_TYPE_PATTERN;
128 tm->m.pattern = g_pattern_spec_new(s);
129 } else if (type && !g_ascii_strcasecmp(type, "regex")) {
130 tm->type = MATCH_TYPE_REGEX;
131 tm->m.regex = g_regex_new(s, 0, 0, NULL);
132 } else if (type && !g_ascii_strcasecmp(type, "exact")) {
133 tm->type = MATCH_TYPE_EXACT;
134 tm->m.exact = g_strdup(s);
141 static void free_typed_match(TypedMatch *tm)
144 case MATCH_TYPE_PATTERN:
145 g_pattern_spec_free(tm->m.pattern);
147 case MATCH_TYPE_REGEX:
148 g_regex_unref(tm->m.regex);
150 case MATCH_TYPE_EXACT:
153 case MATCH_TYPE_NONE:
158 static gboolean check_typed_match(TypedMatch *tm, const gchar *s)
161 case MATCH_TYPE_PATTERN:
162 return g_pattern_match_string(tm->m.pattern, s);
163 case MATCH_TYPE_REGEX:
164 return g_regex_match(tm->m.regex, s, 0, NULL);
165 case MATCH_TYPE_EXACT:
166 return !strcmp(tm->m.exact, s);
167 case MATCH_TYPE_NONE:
170 g_assert_not_reached();
173 static void setup_query(Options* o, xmlNodePtr node, QueryTarget target) {
174 Query *q = g_slice_new0(Query);
175 g_array_append_val(o->queries, q);
179 set_bool(node, "shaded", &q->shaded_on, &q->shaded_off);
180 set_bool(node, "maximized", &q->maxfull_on, &q->maxfull_off);
181 set_bool(node, "maximizedhorizontal", &q->maxhorz_on, &q->maxhorz_off);
182 set_bool(node, "maximizedvertical", &q->maxvert_on, &q->maxvert_off);
183 set_bool(node, "iconified", &q->iconic_on, &q->iconic_off);
184 set_bool(node, "focused", &q->focused, &q->unfocused);
185 set_bool(node, "urgent", &q->urgent_on, &q->urgent_off);
186 set_bool(node, "undecorated", &q->decor_off, &q->decor_on);
187 set_bool(node, "omnipresent", &q->omnipresent_on, &q->omnipresent_off);
190 if ((n = obt_xml_find_node(node, "desktop"))) {
192 if ((s = obt_xml_node_string(n))) {
193 if (!g_ascii_strcasecmp(s, "current"))
194 q->desktop_current = TRUE;
195 if (!g_ascii_strcasecmp(s, "other"))
196 q->desktop_other = TRUE;
198 q->desktop_number = atoi(s);
202 if ((n = obt_xml_find_node(node, "activedesktop"))) {
203 q->screendesktop_number = obt_xml_node_int(n);
205 if ((n = obt_xml_find_node(node, "title"))) {
206 setup_typed_match(&q->title, n);
208 if ((n = obt_xml_find_node(node, "class"))) {
209 setup_typed_match(&q->class, n);
211 if ((n = obt_xml_find_node(node, "name"))) {
212 setup_typed_match(&q->name, n);
214 if ((n = obt_xml_find_node(node, "role"))) {
215 setup_typed_match(&q->role, n);
217 if ((n = obt_xml_find_node(node, "type"))) {
218 setup_typed_match(&q->type, n);
220 if ((n = obt_xml_find_node(node, "monitor"))) {
221 q->client_monitor = obt_xml_node_int(n);
225 static gpointer setup_func(xmlNodePtr node)
227 Options *o = g_slice_new0(Options);
229 gboolean zero_terminated = FALSE;
230 gboolean clear_to_zero_on_alloc = FALSE;
231 o->queries = g_array_new(zero_terminated,
232 clear_to_zero_on_alloc,
236 if ((n = obt_xml_find_node(node, "then"))) {
239 m = obt_xml_find_node(n->children, "action");
241 ObActionsAct *action = actions_parse(m);
242 if (action) o->thenacts = g_slist_append(o->thenacts, action);
243 m = obt_xml_find_node(m->next, "action");
246 if ((n = obt_xml_find_node(node, "else"))) {
249 m = obt_xml_find_node(n->children, "action");
251 ObActionsAct *action = actions_parse(m);
252 if (action) o->elseacts = g_slist_append(o->elseacts, action);
253 m = obt_xml_find_node(m->next, "action");
257 xmlNodePtr query_node = obt_xml_find_node(node, "query");
259 /* The default query if none is specified. It uses the conditions
260 found in the action's node. */
263 QUERY_TARGET_IS_ACTION_TARGET);
266 QueryTarget query_target = QUERY_TARGET_IS_ACTION_TARGET;
267 if (obt_xml_attr_contains(query_node, "target", "focus"))
268 query_target = QUERY_TARGET_IS_FOCUS_TARGET;
270 setup_query(o, query_node->children, query_target);
272 query_node = obt_xml_find_node(query_node->next, "query");
279 static void free_func(gpointer options)
281 Options *o = options;
284 for (i = 0; i < o->queries->len; ++i) {
285 Query *q = g_array_index(o->queries, Query*, i);
287 free_typed_match(&q->title);
288 free_typed_match(&q->class);
289 free_typed_match(&q->name);
290 free_typed_match(&q->role);
291 free_typed_match(&q->type);
293 g_slice_free(Query, q);
296 while (o->thenacts) {
297 actions_act_unref(o->thenacts->data);
298 o->thenacts = g_slist_delete_link(o->thenacts, o->thenacts);
300 while (o->elseacts) {
301 actions_act_unref(o->elseacts->data);
302 o->elseacts = g_slist_delete_link(o->elseacts, o->elseacts);
305 g_array_unref(o->queries);
306 g_slice_free(Options, o);
309 /* Always return FALSE because its not interactive */
310 static gboolean run_func_if(ObActionsData *data, gpointer options)
312 Options *o = options;
313 ObClient *action_target = data->client;
314 gboolean is_true = TRUE;
317 for (i = 0; is_true && i < o->queries->len; ++i) {
318 Query *q = g_array_index(o->queries, Query*, i);
319 ObClient *query_target = NULL;
322 case QUERY_TARGET_IS_ACTION_TARGET:
323 query_target = data->client;
325 case QUERY_TARGET_IS_FOCUS_TARGET:
326 query_target = focus_client;
330 /* If there's no client to query, then false. */
337 is_true &= query_target->shaded;
339 is_true &= !query_target->shaded;
342 is_true &= query_target->iconic;
344 is_true &= !query_target->iconic;
347 is_true &= query_target->max_horz;
349 is_true &= !query_target->max_horz;
352 is_true &= query_target->max_vert;
354 is_true &= !query_target->max_vert;
356 gboolean is_max_full =
357 query_target->max_vert && query_target->max_horz;
359 is_true &= is_max_full;
361 is_true &= !is_max_full;
364 is_true &= query_target == focus_client;
366 is_true &= query_target != focus_client;
369 query_target->urgent || query_target->demands_attention;
371 is_true &= is_urgent;
373 is_true &= !is_urgent;
375 gboolean has_visible_title_bar =
376 !query_target->undecorated &&
377 (query_target->decorations & OB_FRAME_DECOR_TITLEBAR);
379 is_true &= has_visible_title_bar;
381 is_true &= !has_visible_title_bar;
383 if (q->omnipresent_on)
384 is_true &= query_target->desktop == DESKTOP_ALL;
385 if (q->omnipresent_off)
386 is_true &= query_target->desktop != DESKTOP_ALL;
388 gboolean is_on_current_desktop =
389 query_target->desktop == screen_desktop ||
390 query_target->desktop == DESKTOP_ALL;
391 if (q->desktop_current)
392 is_true &= is_on_current_desktop;
393 if (q->desktop_other)
394 is_true &= !is_on_current_desktop;
396 if (q->desktop_number) {
397 gboolean is_on_desktop =
398 query_target->desktop == q->desktop_number - 1 ||
399 query_target->desktop == DESKTOP_ALL;
400 is_true &= is_on_desktop;
403 if (q->screendesktop_number)
404 is_true &= screen_desktop == q->screendesktop_number - 1;
406 is_true &= check_typed_match(&q->title, query_target->original_title);
407 is_true &= check_typed_match(&q->class, query_target->class);
408 is_true &= check_typed_match(&q->name, query_target->name);
409 is_true &= check_typed_match(&q->role, query_target->role);
410 is_true &= check_typed_match(&q->type,
411 client_type_to_string(query_target));
413 if (q->client_monitor)
414 is_true &= client_monitor(query_target) == q->client_monitor - 1;
424 actions_run_acts(acts, data->uact, data->state,
425 data->x, data->y, data->button,
426 data->context, action_target);
431 static gboolean run_func_foreach(ObActionsData *data, gpointer options)
435 foreach_stop = FALSE;
437 for (it = client_list; it; it = g_list_next(it)) {
438 data->client = it->data;
439 run_func_if(data, options);
441 foreach_stop = FALSE;
449 static gboolean run_func_stop(ObActionsData *data, gpointer options)
451 /* This stops the loop above so we don't invoke actions on any more
455 /* TRUE causes actions_run_acts to not run further actions on the current