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();
35 static ObActionsAct *interactive_act = NULL;
36 static guint interactive_initial_state = 0;
38 struct _ObActionsDefinition {
43 ObActionsDataSetupFunc setup;
44 ObActionsDataFreeFunc free;
46 ObActionsInteractiveInputFunc i_input;
47 ObActionsInteractiveCancelFunc i_cancel;
50 struct _ObActionsAct {
53 ObActionsDefinition *def;
57 static GSList *registered = NULL;
60 void actions_startup(gboolean reconfig)
67 void actions_shutdown(gboolean reconfig)
69 actions_interactive_cancel_act();
73 /* free all the registered actions */
75 actions_definition_unref(registered->data);
76 registered = g_slist_delete_link(registered, registered);
80 gboolean actions_register(const gchar *name,
81 ObActionsDataSetupFunc setup,
82 ObActionsDataFreeFunc free,
84 ObActionsInteractiveInputFunc i_input,
85 ObActionsInteractiveCancelFunc i_cancel)
88 ObActionsDefinition *def;
90 g_assert(run != NULL);
91 g_assert((i_input == NULL) == (i_cancel == NULL));
93 for (it = registered; it; it = g_slist_next(it)) {
95 if (!g_ascii_strcasecmp(name, def->name)) /* already registered */
99 def = g_new(ObActionsDefinition, 1);
101 def->name = g_strdup(name);
105 def->i_input = i_input;
106 def->i_cancel = i_cancel;
108 registered = g_slist_prepend(registered, def);
113 static void actions_definition_ref(ObActionsDefinition *def)
118 static void actions_definition_unref(ObActionsDefinition *def)
120 if (def && --def->ref == 0) {
126 ObActionsAct* actions_parse_string(const gchar *name)
129 ObActionsDefinition *def = NULL;
130 ObActionsAct *act = NULL;
132 /* find the requested action */
133 for (it = registered; it; it = g_slist_next(it)) {
135 if (!g_ascii_strcasecmp(name, def->name))
140 /* if we found the action */
142 act = g_new(ObActionsAct, 1);
145 actions_definition_ref(act->def);
148 g_message(_("Invalid action '%s' requested. No such action exists."),
154 ObActionsAct* actions_parse(ObParseInst *i,
159 ObActionsAct *act = NULL;
161 if (parse_attr_string("name", node, &name)) {
162 if ((act = actions_parse_string(name)))
163 /* there is more stuff to parse here */
165 act->options = act->def->setup(i, doc, node->xmlChildrenNode);
173 gboolean actions_act_is_interactive(ObActionsAct *act)
175 return act->def->i_cancel != NULL;
178 void actions_act_ref(ObActionsAct *act)
183 void actions_act_unref(ObActionsAct *act)
185 if (act && --act->ref == 0) {
186 /* free the action specific options */
188 act->def->free(act->options);
189 /* unref the definition */
190 actions_definition_unref(act->def);
195 static void actions_setup_data(ObActionsData *data,
202 struct _ObClient *client)
208 data->button = button;
210 data->client = client;
213 void actions_run_acts(GSList *acts,
220 struct _ObClient *client)
224 /* Don't allow saving the initial state when running things from the
226 if (uact == OB_USER_ACTION_MENU_SELECTION)
228 /* If x and y are < 0 then use the current pointer position */
230 screen_pointer_pos(&x, &y);
232 for (it = acts; it; it = g_slist_next(it)) {
234 ObActionsAct *act = it->data;
237 actions_setup_data(&data, uact, state, x, y, button, con, client);
239 if (actions_act_is_interactive(act) &&
240 (!interactive_act || interactive_act->def != act->def))
242 ok = actions_interactive_begin_act(act, state);
245 /* fire the action's run function with this data */
247 if (!act->def->run(&data, act->options))
248 actions_interactive_end_act();
250 /* make sure its interactive if it returned TRUE */
251 g_assert(act->def->i_cancel && act->def->i_input);
253 /* no actions are run after the interactive one */
260 gboolean actions_interactive_act_running()
262 return interactive_act != NULL;
265 void actions_interactive_cancel_act()
267 if (interactive_act) {
268 interactive_act->def->i_cancel(interactive_act->options);
269 actions_interactive_end_act();
273 static gboolean actions_interactive_begin_act(ObActionsAct *act, guint state)
275 /* cancel the old one */
277 actions_interactive_cancel_act();
279 if (grab_keyboard()) {
280 interactive_act = act;
281 actions_act_ref(interactive_act);
283 interactive_initial_state = state;
290 static void actions_interactive_end_act()
292 if (interactive_act) {
295 actions_act_unref(interactive_act);
296 interactive_act = NULL;
300 gboolean actions_interactive_input_event(XEvent *e)
302 gboolean used = FALSE;
303 if (interactive_act) {
304 if (!interactive_act->def->i_input(interactive_initial_state, e,
305 interactive_act->options, &used))
307 used = TRUE; /* if it cancelled the action then it has to of
309 actions_interactive_end_act();
315 void actions_client_move(ObActionsData *data, gboolean start)
317 static gulong ignore_start = 0;
319 ignore_start = event_start_ignore_all_enters();
320 else if (config_focus_follow &&
321 data->context != OB_FRAME_CONTEXT_CLIENT)
323 if (!data->button && data->client && !config_focus_under_mouse)
324 event_end_ignore_all_enters(ignore_start);
328 /* usually this is sorta redundant, but with a press action
329 that moves windows our from under the cursor, the enter
330 event will come as a GrabNotify which is ignored, so this
331 makes a fake enter event
333 if ((c = client_under_pointer()) && c != data->client) {
334 ob_debug_type(OB_DEBUG_FOCUS,
335 "Generating fake enter because we did a "
336 "mouse-event action");
337 event_enter_client(c);