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.
28 #include "actions/all.h"
30 static void actions_definition_ref(ObActionsDefinition *def);
31 static void actions_definition_unref(ObActionsDefinition *def);
32 static gboolean actions_interactive_begin_act(ObActionsAct *act, guint state);
33 static void actions_interactive_end_act();
34 static ObActionsAct* actions_build_act_from_string(const gchar *name);
36 static ObActionsAct *interactive_act = NULL;
37 static guint interactive_initial_state = 0;
39 struct _ObActionsDefinition {
44 ObActionsDataSetupFunc setup;
45 ObActionsDataFreeFunc free;
47 ObActionsInteractiveInputFunc i_input;
48 ObActionsInteractiveCancelFunc i_cancel;
51 struct _ObActionsAct {
54 ObActionsDefinition *def;
58 static GSList *registered = NULL;
61 void actions_startup(gboolean reconfig)
68 void actions_shutdown(gboolean reconfig)
70 actions_interactive_cancel_act();
74 /* free all the registered actions */
76 actions_definition_unref(registered->data);
77 registered = g_slist_delete_link(registered, registered);
81 gboolean actions_register(const gchar *name,
82 ObActionsDataSetupFunc setup,
83 ObActionsDataFreeFunc free,
85 ObActionsInteractiveInputFunc i_input,
86 ObActionsInteractiveCancelFunc i_cancel)
89 ObActionsDefinition *def;
91 g_assert(run != NULL);
92 g_assert((i_input == NULL) == (i_cancel == NULL));
94 for (it = registered; it; it = g_slist_next(it)) {
96 if (!g_ascii_strcasecmp(name, def->name)) /* already registered */
100 def = g_new(ObActionsDefinition, 1);
102 def->name = g_strdup(name);
106 def->i_input = i_input;
107 def->i_cancel = i_cancel;
109 registered = g_slist_prepend(registered, def);
114 static void actions_definition_ref(ObActionsDefinition *def)
119 static void actions_definition_unref(ObActionsDefinition *def)
121 if (def && --def->ref == 0) {
127 static ObActionsAct* actions_build_act_from_string(const gchar *name)
130 ObActionsDefinition *def = NULL;
131 ObActionsAct *act = NULL;
133 /* find the requested action */
134 for (it = registered; it; it = g_slist_next(it)) {
136 if (!g_ascii_strcasecmp(name, def->name))
141 /* if we found the action */
143 act = g_new(ObActionsAct, 1);
146 actions_definition_ref(act->def);
149 g_message(_("Invalid action '%s' requested. No such action exists."),
155 ObActionsAct* actions_parse_string(const gchar *name)
157 ObActionsAct *act = NULL;
159 if ((act = actions_build_act_from_string(name)))
161 act->options = act->def->setup(NULL);
166 ObActionsAct* actions_parse(xmlNodePtr node)
169 ObActionsAct *act = NULL;
171 if (obt_parse_attr_string(node, "name", &name)) {
172 if ((act = actions_build_act_from_string(name)))
173 /* there is more stuff to parse here */
175 act->options = act->def->setup(node->children);
183 gboolean actions_act_is_interactive(ObActionsAct *act)
185 return act->def->i_cancel != NULL;
188 void actions_act_ref(ObActionsAct *act)
193 void actions_act_unref(ObActionsAct *act)
195 if (act && --act->ref == 0) {
196 /* free the action specific options */
198 act->def->free(act->options);
199 /* unref the definition */
200 actions_definition_unref(act->def);
205 static void actions_setup_data(ObActionsData *data,
212 struct _ObClient *client)
218 data->button = button;
220 data->client = client;
223 void actions_run_acts(GSList *acts,
230 struct _ObClient *client)
234 /* Don't allow saving the initial state when running things from the
236 if (uact == OB_USER_ACTION_MENU_SELECTION)
238 /* If x and y are < 0 then use the current pointer position */
240 screen_pointer_pos(&x, &y);
242 for (it = acts; it; it = g_slist_next(it)) {
244 ObActionsAct *act = it->data;
247 actions_setup_data(&data, uact, state, x, y, button, con, client);
249 /* if they have the same run function, then we'll assume they are
250 cooperating and not cancel eachother out */
251 if (!interactive_act || interactive_act->def->run != act->def->run) {
252 if (actions_act_is_interactive(act)) {
253 /* cancel the old one */
255 actions_interactive_cancel_act();
256 ok = actions_interactive_begin_act(act, state);
260 /* fire the action's run function with this data */
262 if (!act->def->run(&data, act->options)) {
263 if (actions_act_is_interactive(act))
264 actions_interactive_end_act();
266 /* make sure its interactive if it returned TRUE */
267 g_assert(act->def->i_cancel && act->def->i_input);
269 /* no actions are run after the interactive one */
276 gboolean actions_interactive_act_running(void)
278 return interactive_act != NULL;
281 void actions_interactive_cancel_act(void)
283 if (interactive_act) {
284 interactive_act->def->i_cancel(interactive_act->options);
285 actions_interactive_end_act();
289 static gboolean actions_interactive_begin_act(ObActionsAct *act, guint state)
291 if (grab_keyboard()) {
292 interactive_act = act;
293 actions_act_ref(interactive_act);
295 interactive_initial_state = state;
297 /* if using focus_delay, stop the timer now so that focus doesn't go
298 moving on us, which would kill the action */
299 event_halt_focus_delay();
307 static void actions_interactive_end_act(void)
309 if (interactive_act) {
312 actions_act_unref(interactive_act);
313 interactive_act = NULL;
317 gboolean actions_interactive_input_event(XEvent *e)
319 gboolean used = FALSE;
320 if (interactive_act) {
321 if (!interactive_act->def->i_input(interactive_initial_state, e,
322 interactive_act->options, &used))
324 used = TRUE; /* if it cancelled the action then it has to of
326 actions_interactive_end_act();
332 void actions_client_move(ObActionsData *data, gboolean start)
334 static gulong ignore_start = 0;
336 ignore_start = event_start_ignore_all_enters();
337 else if (config_focus_follow &&
338 data->context != OB_FRAME_CONTEXT_CLIENT)
340 if (!data->button && data->client && !config_focus_under_mouse)
341 event_end_ignore_all_enters(ignore_start);
345 /* usually this is sorta redundant, but with a press action
346 that moves windows our from under the cursor, the enter
347 event will come as a GrabNotify which is ignored, so this
348 makes a fake enter event
350 if ((c = client_under_pointer()) && c != data->client) {
351 ob_debug_type(OB_DEBUG_FOCUS,
352 "Generating fake enter because we did a "
353 "mouse-event action");
354 event_enter_client(c);