1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
3 actions.h for the Openbox window manager
4 Copyright (c) 2007 Dana Jansens
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 See the COPYING file for a copy of the GNU General Public License.
29 #include "actions/all.h"
31 static void actions_definition_ref(ObActionsDefinition *def);
32 static void actions_definition_unref(ObActionsDefinition *def);
33 static gboolean actions_interactive_begin_act(ObActionsAct *act, guint state);
34 static void actions_interactive_end_act();
35 static ObActionsAct* actions_build_act_from_string(const gchar *name);
37 static ObActionsAct *interactive_act = NULL;
38 static guint interactive_initial_state = 0;
40 struct _ObActionsDefinition {
45 ObActionsDataSetupFunc setup;
46 ObActionsDataFreeFunc free;
48 ObActionsInteractiveInputFunc i_input;
49 ObActionsInteractiveCancelFunc i_cancel;
50 ObActionsShutdownFunc shutdown;
53 struct _ObActionsAct {
56 ObActionsDefinition *def;
60 static GSList *registered = NULL;
62 void actions_startup(gboolean reconfig)
69 void actions_shutdown(gboolean reconfig)
71 actions_interactive_cancel_act();
75 /* free all the registered actions */
77 ObActionsDefinition *d = registered->data;
78 if (d->shutdown) d->shutdown();
79 actions_definition_unref(d);
80 registered = g_slist_delete_link(registered, registered);
84 gboolean actions_register(const gchar *name,
85 ObActionsDataSetupFunc setup,
86 ObActionsDataFreeFunc free,
88 ObActionsInteractiveInputFunc i_input,
89 ObActionsInteractiveCancelFunc i_cancel)
92 ObActionsDefinition *def;
94 g_assert(run != NULL);
95 g_assert((i_input == NULL) == (i_cancel == NULL));
97 for (it = registered; it; it = g_slist_next(it)) {
99 if (!g_ascii_strcasecmp(name, def->name)) /* already registered */
103 def = g_new(ObActionsDefinition, 1);
105 def->name = g_strdup(name);
109 def->i_input = i_input;
110 def->i_cancel = i_cancel;
111 def->shutdown = NULL;
113 registered = g_slist_prepend(registered, def);
118 gboolean actions_set_shutdown(const gchar *name,
119 ObActionsShutdownFunc shutdown)
122 ObActionsDefinition *def;
124 for (it = registered; it; it = g_slist_next(it)) {
126 if (!g_ascii_strcasecmp(name, def->name)) {
127 def->shutdown = shutdown;
134 static void actions_definition_ref(ObActionsDefinition *def)
139 static void actions_definition_unref(ObActionsDefinition *def)
141 if (def && --def->ref == 0) {
147 static ObActionsAct* actions_build_act_from_string(const gchar *name)
150 ObActionsDefinition *def = NULL;
151 ObActionsAct *act = NULL;
153 /* find the requested action */
154 for (it = registered; it; it = g_slist_next(it)) {
156 if (!g_ascii_strcasecmp(name, def->name))
161 /* if we found the action */
163 act = g_new(ObActionsAct, 1);
166 actions_definition_ref(act->def);
169 g_message(_("Invalid action \"%s\" requested. No such action exists."),
175 ObActionsAct* actions_parse_string(const gchar *name)
177 ObActionsAct *act = NULL;
179 if ((act = actions_build_act_from_string(name)))
181 act->options = act->def->setup(NULL, NULL, NULL);
186 ObActionsAct* actions_parse(ObParseInst *i,
191 ObActionsAct *act = NULL;
193 if (parse_attr_string("name", node, &name)) {
194 if ((act = actions_build_act_from_string(name)))
195 /* there is more stuff to parse here */
197 act->options = act->def->setup(i, doc, node->xmlChildrenNode);
205 gboolean actions_act_is_interactive(ObActionsAct *act)
207 return act->def->i_cancel != NULL;
210 void actions_act_ref(ObActionsAct *act)
215 void actions_act_unref(ObActionsAct *act)
217 if (act && --act->ref == 0) {
218 /* free the action specific options */
220 act->def->free(act->options);
221 /* unref the definition */
222 actions_definition_unref(act->def);
227 static void actions_setup_data(ObActionsData *data,
234 struct _ObClient *client)
240 data->button = button;
242 data->client = client;
245 void actions_run_acts(GSList *acts,
252 struct _ObClient *client)
256 /* Don't allow saving the initial state when running things from the
258 if (uact == OB_USER_ACTION_MENU_SELECTION)
260 /* If x and y are < 0 then use the current pointer position */
262 screen_pointer_pos(&x, &y);
264 for (it = acts; it; it = g_slist_next(it)) {
266 ObActionsAct *act = it->data;
269 actions_setup_data(&data, uact, state, x, y, button, con, client);
271 /* if they have the same run function, then we'll assume they are
272 cooperating and not cancel eachother out */
273 if (!interactive_act || interactive_act->def->run != act->def->run) {
274 if (actions_act_is_interactive(act)) {
275 /* cancel the old one */
277 actions_interactive_cancel_act();
278 ok = actions_interactive_begin_act(act, state);
282 /* fire the action's run function with this data */
284 if (!act->def->run(&data, act->options)) {
285 if (actions_act_is_interactive(act))
286 actions_interactive_end_act();
288 /* make sure its interactive if it returned TRUE */
289 g_assert(act->def->i_cancel && act->def->i_input);
291 /* no actions are run after the interactive one */
298 gboolean actions_interactive_act_running(void)
300 return interactive_act != NULL;
303 void actions_interactive_cancel_act(void)
305 if (interactive_act) {
306 interactive_act->def->i_cancel(interactive_act->options);
307 actions_interactive_end_act();
311 static gboolean actions_interactive_begin_act(ObActionsAct *act, guint state)
313 if (grab_keyboard()) {
314 interactive_act = act;
315 actions_act_ref(interactive_act);
317 interactive_initial_state = state;
319 /* if using focus_delay, stop the timer now so that focus doesn't go
320 moving on us, which would kill the action */
321 event_halt_focus_delay();
329 static void actions_interactive_end_act(void)
331 if (interactive_act) {
334 actions_act_unref(interactive_act);
335 interactive_act = NULL;
339 gboolean actions_interactive_input_event(XEvent *e)
341 gboolean used = FALSE;
342 if (interactive_act) {
343 if (!interactive_act->def->i_input(interactive_initial_state, e,
344 interactive_act->options, &used))
346 used = TRUE; /* if it cancelled the action then it has to of
348 actions_interactive_end_act();
354 void actions_client_move(ObActionsData *data, gboolean start)
356 static gulong ignore_start = 0;
358 ignore_start = event_start_ignore_all_enters();
359 else if (config_focus_follow &&
360 data->context != OB_FRAME_CONTEXT_CLIENT)
362 if (data->uact == OB_USER_ACTION_MOUSE_PRESS) {
365 /* usually this is sorta redundant, but with a press action
366 that moves windows our from under the cursor, the enter
367 event will come as a GrabNotify which is ignored, so this
368 makes a fake enter event
370 don't do this if there is a grab on the pointer. enter events
371 are ignored during a grab, so don't force fake ones when they
374 if ((c = client_under_pointer()) && c != data->client &&
377 ob_debug_type(OB_DEBUG_FOCUS,
378 "Generating fake enter because we did a "
379 "mouse-event action");
380 event_enter_client(c);
383 else if (!data->button && !config_focus_under_mouse)
384 event_end_ignore_all_enters(ignore_start);