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;
71 gboolean desktop_last;
73 guint screendesktop_number;
88 static gpointer setup_func(xmlNodePtr node);
89 static void free_func(gpointer options);
90 static gboolean run_func_if(ObActionsData *data, gpointer options);
91 static gboolean run_func_stop(ObActionsData *data, gpointer options);
92 static gboolean run_func_foreach(ObActionsData *data, gpointer options);
94 static gboolean foreach_stop;
96 void action_if_startup(void)
98 actions_register("If", setup_func, free_func, run_func_if);
99 actions_register("Stop", NULL, NULL, run_func_stop);
100 actions_register("ForEach", setup_func, free_func, run_func_foreach);
102 actions_set_can_stop("Stop", TRUE);
105 static inline void set_bool(xmlNodePtr node,
112 if ((n = obt_xml_find_node(node, name))) {
113 if (obt_xml_node_bool(n))
120 static void setup_typed_match(TypedMatch *tm, xmlNodePtr n)
123 if ((s = obt_xml_node_string(n))) {
125 if (!obt_xml_attr_string(n, "type", &type) ||
126 !g_ascii_strcasecmp(type, "pattern"))
128 tm->type = MATCH_TYPE_PATTERN;
129 tm->m.pattern = g_pattern_spec_new(s);
130 } else if (type && !g_ascii_strcasecmp(type, "regex")) {
131 tm->type = MATCH_TYPE_REGEX;
132 tm->m.regex = g_regex_new(s, 0, 0, NULL);
133 } else if (type && !g_ascii_strcasecmp(type, "exact")) {
134 tm->type = MATCH_TYPE_EXACT;
135 tm->m.exact = g_strdup(s);
142 static void free_typed_match(TypedMatch *tm)
145 case MATCH_TYPE_PATTERN:
146 g_pattern_spec_free(tm->m.pattern);
148 case MATCH_TYPE_REGEX:
149 g_regex_unref(tm->m.regex);
151 case MATCH_TYPE_EXACT:
154 case MATCH_TYPE_NONE:
159 static gboolean check_typed_match(TypedMatch *tm, const gchar *s)
162 case MATCH_TYPE_PATTERN:
163 return g_pattern_match_string(tm->m.pattern, s);
164 case MATCH_TYPE_REGEX:
165 return g_regex_match(tm->m.regex, s, 0, NULL);
166 case MATCH_TYPE_EXACT:
167 return !strcmp(tm->m.exact, s);
168 case MATCH_TYPE_NONE:
171 g_assert_not_reached();
174 static void setup_query(Options* o, xmlNodePtr node, QueryTarget target) {
175 Query *q = g_slice_new0(Query);
176 g_array_append_val(o->queries, q);
180 set_bool(node, "shaded", &q->shaded_on, &q->shaded_off);
181 set_bool(node, "maximized", &q->maxfull_on, &q->maxfull_off);
182 set_bool(node, "maximizedhorizontal", &q->maxhorz_on, &q->maxhorz_off);
183 set_bool(node, "maximizedvertical", &q->maxvert_on, &q->maxvert_off);
184 set_bool(node, "iconified", &q->iconic_on, &q->iconic_off);
185 set_bool(node, "focused", &q->focused, &q->unfocused);
186 set_bool(node, "urgent", &q->urgent_on, &q->urgent_off);
187 set_bool(node, "undecorated", &q->decor_off, &q->decor_on);
188 set_bool(node, "omnipresent", &q->omnipresent_on, &q->omnipresent_off);
191 if ((n = obt_xml_find_node(node, "desktop"))) {
193 if ((s = obt_xml_node_string(n))) {
194 if (!g_ascii_strcasecmp(s, "current"))
195 q->desktop_current = TRUE;
196 else if (!g_ascii_strcasecmp(s, "other"))
197 q->desktop_other = TRUE;
198 else if (!g_ascii_strcasecmp(s, "last"))
199 q->desktop_last = TRUE;
201 q->desktop_number = atoi(s);
205 if ((n = obt_xml_find_node(node, "activedesktop"))) {
206 q->screendesktop_number = obt_xml_node_int(n);
208 if ((n = obt_xml_find_node(node, "title"))) {
209 setup_typed_match(&q->title, n);
211 if ((n = obt_xml_find_node(node, "class"))) {
212 setup_typed_match(&q->class, n);
214 if ((n = obt_xml_find_node(node, "name"))) {
215 setup_typed_match(&q->name, n);
217 if ((n = obt_xml_find_node(node, "role"))) {
218 setup_typed_match(&q->role, n);
220 if ((n = obt_xml_find_node(node, "type"))) {
221 setup_typed_match(&q->type, n);
223 if ((n = obt_xml_find_node(node, "monitor"))) {
224 q->client_monitor = obt_xml_node_int(n);
228 static gpointer setup_func(xmlNodePtr node)
230 Options *o = g_slice_new0(Options);
232 gboolean zero_terminated = FALSE;
233 gboolean clear_to_zero_on_alloc = FALSE;
234 o->queries = g_array_new(zero_terminated,
235 clear_to_zero_on_alloc,
239 if ((n = obt_xml_find_node(node, "then"))) {
242 m = obt_xml_find_node(n->children, "action");
244 ObActionsAct *action = actions_parse(m);
245 if (action) o->thenacts = g_slist_append(o->thenacts, action);
246 m = obt_xml_find_node(m->next, "action");
249 if ((n = obt_xml_find_node(node, "else"))) {
252 m = obt_xml_find_node(n->children, "action");
254 ObActionsAct *action = actions_parse(m);
255 if (action) o->elseacts = g_slist_append(o->elseacts, action);
256 m = obt_xml_find_node(m->next, "action");
260 xmlNodePtr query_node = obt_xml_find_node(node, "query");
262 /* The default query if none is specified. It uses the conditions
263 found in the action's node. */
266 QUERY_TARGET_IS_ACTION_TARGET);
269 QueryTarget query_target = QUERY_TARGET_IS_ACTION_TARGET;
270 if (obt_xml_attr_contains(query_node, "target", "focus"))
271 query_target = QUERY_TARGET_IS_FOCUS_TARGET;
273 setup_query(o, query_node->children, query_target);
275 query_node = obt_xml_find_node(query_node->next, "query");
282 static void free_func(gpointer options)
284 Options *o = options;
287 for (i = 0; i < o->queries->len; ++i) {
288 Query *q = g_array_index(o->queries, Query*, i);
290 free_typed_match(&q->title);
291 free_typed_match(&q->class);
292 free_typed_match(&q->name);
293 free_typed_match(&q->role);
294 free_typed_match(&q->type);
296 g_slice_free(Query, q);
299 while (o->thenacts) {
300 actions_act_unref(o->thenacts->data);
301 o->thenacts = g_slist_delete_link(o->thenacts, o->thenacts);
303 while (o->elseacts) {
304 actions_act_unref(o->elseacts->data);
305 o->elseacts = g_slist_delete_link(o->elseacts, o->elseacts);
308 g_array_unref(o->queries);
309 g_slice_free(Options, o);
312 /* Always return FALSE because its not interactive */
313 static gboolean run_func_if(ObActionsData *data, gpointer options)
315 Options *o = options;
316 ObClient *action_target = data->client;
317 gboolean is_true = TRUE;
320 for (i = 0; is_true && i < o->queries->len; ++i) {
321 Query *q = g_array_index(o->queries, Query*, i);
322 ObClient *query_target = NULL;
325 case QUERY_TARGET_IS_ACTION_TARGET:
326 query_target = data->client;
328 case QUERY_TARGET_IS_FOCUS_TARGET:
329 query_target = focus_client;
333 /* If there's no client to query, then false. */
340 is_true &= query_target->shaded;
342 is_true &= !query_target->shaded;
345 is_true &= query_target->iconic;
347 is_true &= !query_target->iconic;
350 is_true &= query_target->max_horz;
352 is_true &= !query_target->max_horz;
355 is_true &= query_target->max_vert;
357 is_true &= !query_target->max_vert;
359 gboolean is_max_full =
360 query_target->max_vert && query_target->max_horz;
362 is_true &= is_max_full;
364 is_true &= !is_max_full;
367 is_true &= query_target == focus_client;
369 is_true &= query_target != focus_client;
372 query_target->urgent || query_target->demands_attention;
374 is_true &= is_urgent;
376 is_true &= !is_urgent;
378 gboolean has_visible_title_bar =
379 !query_target->undecorated &&
380 (query_target->decorations & OB_FRAME_DECOR_TITLEBAR);
382 is_true &= has_visible_title_bar;
384 is_true &= !has_visible_title_bar;
386 if (q->omnipresent_on)
387 is_true &= query_target->desktop == DESKTOP_ALL;
388 if (q->omnipresent_off)
389 is_true &= query_target->desktop != DESKTOP_ALL;
391 gboolean is_on_current_desktop =
392 query_target->desktop == screen_desktop ||
393 query_target->desktop == DESKTOP_ALL;
394 if (q->desktop_current)
395 is_true &= is_on_current_desktop;
396 if (q->desktop_other)
397 is_true &= !is_on_current_desktop;
399 is_true &= query_target->desktop == screen_last_desktop;
401 if (q->desktop_number) {
402 gboolean is_on_desktop =
403 query_target->desktop == q->desktop_number - 1 ||
404 query_target->desktop == DESKTOP_ALL;
405 is_true &= is_on_desktop;
408 if (q->screendesktop_number)
409 is_true &= screen_desktop == q->screendesktop_number - 1;
411 is_true &= check_typed_match(&q->title, query_target->original_title);
412 is_true &= check_typed_match(&q->class, query_target->class);
413 is_true &= check_typed_match(&q->name, query_target->name);
414 is_true &= check_typed_match(&q->role, query_target->role);
415 is_true &= check_typed_match(&q->type,
416 client_type_to_string(query_target));
418 if (q->client_monitor)
419 is_true &= client_monitor(query_target) == q->client_monitor - 1;
429 actions_run_acts(acts, data->uact, data->state,
430 data->x, data->y, data->button,
431 data->context, action_target);
436 static gboolean run_func_foreach(ObActionsData *data, gpointer options)
440 foreach_stop = FALSE;
442 for (it = client_list; it; it = g_list_next(it)) {
443 data->client = it->data;
444 run_func_if(data, options);
446 foreach_stop = FALSE;
454 static gboolean run_func_stop(ObActionsData *data, gpointer options)
456 /* This stops the loop above so we don't invoke actions on any more
460 /* TRUE causes actions_run_acts to not run further actions on the current