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;
52 struct _ObActionsAct {
55 ObActionsDefinition *def;
59 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 actions_definition_unref(registered->data);
78 registered = g_slist_delete_link(registered, registered);
82 gboolean actions_register(const gchar *name,
83 ObActionsDataSetupFunc setup,
84 ObActionsDataFreeFunc free,
86 ObActionsInteractiveInputFunc i_input,
87 ObActionsInteractiveCancelFunc i_cancel)
90 ObActionsDefinition *def;
92 g_assert(run != NULL);
93 g_assert((i_input == NULL) == (i_cancel == NULL));
95 for (it = registered; it; it = g_slist_next(it)) {
97 if (!g_ascii_strcasecmp(name, def->name)) /* already registered */
101 def = g_new(ObActionsDefinition, 1);
103 def->name = g_strdup(name);
107 def->i_input = i_input;
108 def->i_cancel = i_cancel;
110 registered = g_slist_prepend(registered, def);
115 static void actions_definition_ref(ObActionsDefinition *def)
120 static void actions_definition_unref(ObActionsDefinition *def)
122 if (def && --def->ref == 0) {
128 static ObActionsAct* actions_build_act_from_string(const gchar *name)
131 ObActionsDefinition *def = NULL;
132 ObActionsAct *act = NULL;
134 /* find the requested action */
135 for (it = registered; it; it = g_slist_next(it)) {
137 if (!g_ascii_strcasecmp(name, def->name))
142 /* if we found the action */
144 act = g_new(ObActionsAct, 1);
147 actions_definition_ref(act->def);
150 g_message(_("Invalid action \"%s\" requested. No such action exists."),
156 ObActionsAct* actions_parse_string(const gchar *name)
158 ObActionsAct *act = NULL;
160 if ((act = actions_build_act_from_string(name)))
162 act->options = act->def->setup(NULL);
167 ObActionsAct* actions_parse(xmlNodePtr node)
170 ObActionsAct *act = NULL;
172 if (obt_parse_attr_string(node, "name", &name)) {
173 if ((act = actions_build_act_from_string(name)))
174 /* there is more stuff to parse here */
176 act->options = act->def->setup(node->children);
184 gboolean actions_act_is_interactive(ObActionsAct *act)
186 return act->def->i_cancel != NULL;
189 void actions_act_ref(ObActionsAct *act)
194 void actions_act_unref(ObActionsAct *act)
196 if (act && --act->ref == 0) {
197 /* free the action specific options */
199 act->def->free(act->options);
200 /* unref the definition */
201 actions_definition_unref(act->def);
206 static void actions_setup_data(ObActionsData *data,
213 struct _ObClient *client)
219 data->button = button;
221 data->client = client;
224 void actions_run_acts(GSList *acts,
231 struct _ObClient *client)
235 /* Don't allow saving the initial state when running things from the
237 if (uact == OB_USER_ACTION_MENU_SELECTION)
239 /* If x and y are < 0 then use the current pointer position */
241 screen_pointer_pos(&x, &y);
243 for (it = acts; it; it = g_slist_next(it)) {
245 ObActionsAct *act = it->data;
248 actions_setup_data(&data, uact, state, x, y, button, con, client);
250 /* if they have the same run function, then we'll assume they are
251 cooperating and not cancel eachother out */
252 if (!interactive_act || interactive_act->def->run != act->def->run) {
253 if (actions_act_is_interactive(act)) {
254 /* cancel the old one */
256 actions_interactive_cancel_act();
257 ok = actions_interactive_begin_act(act, state);
261 /* fire the action's run function with this data */
263 if (!act->def->run(&data, act->options)) {
264 if (actions_act_is_interactive(act))
265 actions_interactive_end_act();
267 /* make sure its interactive if it returned TRUE */
268 g_assert(act->def->i_cancel && act->def->i_input);
270 /* no actions are run after the interactive one */
277 gboolean actions_interactive_act_running(void)
279 return interactive_act != NULL;
282 void actions_interactive_cancel_act(void)
284 if (interactive_act) {
285 interactive_act->def->i_cancel(interactive_act->options);
286 actions_interactive_end_act();
290 static gboolean actions_interactive_begin_act(ObActionsAct *act, guint state)
292 if (grab_keyboard()) {
293 interactive_act = act;
294 actions_act_ref(interactive_act);
296 interactive_initial_state = state;
298 /* if using focus_delay, stop the timer now so that focus doesn't go
299 moving on us, which would kill the action */
300 event_halt_focus_delay();
308 static void actions_interactive_end_act(void)
310 if (interactive_act) {
313 actions_act_unref(interactive_act);
314 interactive_act = NULL;
318 gboolean actions_interactive_input_event(XEvent *e)
320 gboolean used = FALSE;
321 if (interactive_act) {
322 if (!interactive_act->def->i_input(interactive_initial_state, e,
323 interactive_act->options, &used))
325 used = TRUE; /* if it cancelled the action then it has to of
327 actions_interactive_end_act();
333 void actions_client_move(ObActionsData *data, gboolean start)
335 static gulong ignore_start = 0;
337 ignore_start = event_start_ignore_all_enters();
338 else if (config_focus_follow &&
339 data->context != OB_FRAME_CONTEXT_CLIENT)
341 if (data->uact == OB_USER_ACTION_MOUSE_PRESS) {
344 /* usually this is sorta redundant, but with a press action
345 that moves windows our from under the cursor, the enter
346 event will come as a GrabNotify which is ignored, so this
347 makes a fake enter event
349 don't do this if there is a grab on the pointer. enter events
350 are ignored during a grab, so don't force fake ones when they
353 if ((c = client_under_pointer()) && c != data->client &&
356 ob_debug_type(OB_DEBUG_FOCUS,
357 "Generating fake enter because we did a "
358 "mouse-event action");
359 event_enter_client(c);
362 else if (!data->button && !config_focus_under_mouse)
363 event_end_ignore_all_enters(ignore_start);