openbox/actions.c

   1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
   2
   3    actions.h for the Openbox window manager
   4    Copyright (c) 2007        Dana Jansens
   5
   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.
  10
  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.
  15
  16    See the COPYING file for a copy of the GNU General Public License.
  17 */
  18
  19 #include "actions.h"
  20 #include "gettext.h"
  21 #include "grab.h"
  22 #include "screen.h"
  23 #include "event.h"
  24 #include "config.h"
  25 #include "client.h"
  26 #include "openbox.h"
  27 #include "debug.h"
  28
  29 #include "actions/all.h"
  30
  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);
  36
  37 static ObActionsAct *interactive_act = NULL;
  38 static guint         interactive_initial_state = 0;
  39
  40 struct _ObActionsDefinition {
  41     guint ref;
  42
  43     gchar *name;
  44
  45     ObActionsDataSetupFunc setup;
  46     ObActionsDataFreeFunc free;
  47     ObActionsRunFunc run;
  48     ObActionsInteractiveInputFunc i_input;
  49     ObActionsInteractiveCancelFunc i_cancel;
  50 };
  51
  52 struct _ObActionsAct {
  53     guint ref;
  54
  55     ObActionsDefinition *def;
  56     gpointer options;
  57 };
  58
  59 static GSList *registered = NULL;
  60
  61
  62 void actions_startup(gboolean reconfig)
  63 {
  64     if (reconfig) return;
  65
  66     action_all_startup();
  67 }
  68
  69 void actions_shutdown(gboolean reconfig)
  70 {
  71     actions_interactive_cancel_act();
  72
  73     if (reconfig) return;
  74
  75     /* free all the registered actions */
  76     while (registered) {
  77         actions_definition_unref(registered->data);
  78         registered = g_slist_delete_link(registered, registered);
  79     }
  80 }
  81
  82 gboolean actions_register(const gchar *name,
  83                           ObActionsDataSetupFunc setup,
  84                           ObActionsDataFreeFunc free,
  85                           ObActionsRunFunc run,
  86                           ObActionsInteractiveInputFunc i_input,
  87                           ObActionsInteractiveCancelFunc i_cancel)
  88 {
  89     GSList *it;
  90     ObActionsDefinition *def;
  91
  92     g_assert(run != NULL);
  93     g_assert((i_input == NULL) == (i_cancel == NULL));
  94
  95     for (it = registered; it; it = g_slist_next(it)) {
  96         def = it->data;
  97         if (!g_ascii_strcasecmp(name, def->name)) /* already registered */
  98             return FALSE;
  99     }
 100
 101     def = g_new(ObActionsDefinition, 1);
 102     def->ref = 1;
 103     def->name = g_strdup(name);
 104     def->setup = setup;
 105     def->free = free;
 106     def->run = run;
 107     def->i_input = i_input;
 108     def->i_cancel = i_cancel;
 109
 110     registered = g_slist_prepend(registered, def);
 111
 112     return TRUE;
 113 }
 114
 115 static void actions_definition_ref(ObActionsDefinition *def)
 116 {
 117     ++def->ref;
 118 }
 119
 120 static void actions_definition_unref(ObActionsDefinition *def)
 121 {
 122     if (def && --def->ref == 0) {
 123         g_free(def->name);
 124         g_free(def);
 125     }
 126 }
 127
 128 static ObActionsAct* actions_build_act_from_string(const gchar *name)
 129 {
 130     GSList *it;
 131     ObActionsDefinition *def = NULL;
 132     ObActionsAct *act = NULL;
 133
 134     /* find the requested action */
 135     for (it = registered; it; it = g_slist_next(it)) {
 136         def = it->data;
 137         if (!g_ascii_strcasecmp(name, def->name))
 138             break;
 139         def = NULL;
 140     }
 141
 142     /* if we found the action */
 143     if (def) {
 144         act = g_new(ObActionsAct, 1);
 145         act->ref = 1;
 146         act->def = def;
 147         actions_definition_ref(act->def);
 148         act->options = NULL;
 149     } else
 150         g_message(_("Invalid action \"%s\" requested. No such action exists."),
 151                   name);
 152
 153     return act;
 154 }
 155
 156 ObActionsAct* actions_parse_string(const gchar *name)
 157 {
 158     ObActionsAct *act = NULL;
 159
 160     if ((act = actions_build_act_from_string(name)))
 161         if (act->def->setup)
 162             act->options = act->def->setup(NULL);
 163
 164     return act;
 165 }
 166
 167 ObActionsAct* actions_parse(xmlNodePtr node)
 168 {
 169     gchar *name;
 170     ObActionsAct *act = NULL;
 171
 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 */
 175             if (act->def->setup)
 176                 act->options = act->def->setup(node->children);
 177
 178         g_free(name);
 179     }
 180
 181     return act;
 182 }
 183
 184 gboolean actions_act_is_interactive(ObActionsAct *act)
 185 {
 186     return act->def->i_cancel != NULL;
 187 }
 188
 189 void actions_act_ref(ObActionsAct *act)
 190 {
 191     ++act->ref;
 192 }
 193
 194 void actions_act_unref(ObActionsAct *act)
 195 {
 196     if (act && --act->ref == 0) {
 197         /* free the action specific options */
 198         if (act->def->free)
 199             act->def->free(act->options);
 200         /* unref the definition */
 201         actions_definition_unref(act->def);
 202         g_free(act);
 203     }
 204 }
 205
 206 static void actions_setup_data(ObActionsData *data,
 207                                ObUserAction uact,
 208                                guint state,
 209                                gint x,
 210                                gint y,
 211                                gint button,
 212                                ObFrameContext con,
 213                                struct _ObClient *client)
 214 {
 215     data->uact = uact;
 216     data->state = state;
 217     data->x = x;
 218     data->y = y;
 219     data->button = button;
 220     data->context = con;
 221     data->client = client;
 222 }
 223
 224 void actions_run_acts(GSList *acts,
 225                       ObUserAction uact,
 226                       guint state,
 227                       gint x,
 228                       gint y,
 229                       gint button,
 230                       ObFrameContext con,
 231                       struct _ObClient *client)
 232 {
 233     GSList *it;
 234
 235     /* Don't allow saving the initial state when running things from the
 236        menu */
 237     if (uact == OB_USER_ACTION_MENU_SELECTION)
 238         state = 0;
 239     /* If x and y are < 0 then use the current pointer position */
 240     if (x < 0 && y < 0)
 241         screen_pointer_pos(&x, &y);
 242
 243     for (it = acts; it; it = g_slist_next(it)) {
 244         ObActionsData data;
 245         ObActionsAct *act = it->data;
 246         gboolean ok = TRUE;
 247
 248         actions_setup_data(&data, uact, state, x, y, button, con, client);
 249
 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 */
 255                 if (interactive_act)
 256                     actions_interactive_cancel_act();
 257                 ok = actions_interactive_begin_act(act, state);
 258             }
 259         }
 260
 261         /* fire the action's run function with this data */
 262         if (ok) {
 263             if (!act->def->run(&data, act->options)) {
 264                 if (actions_act_is_interactive(act))
 265                     actions_interactive_end_act();
 266             } else {
 267                 /* make sure its interactive if it returned TRUE */
 268                 g_assert(act->def->i_cancel && act->def->i_input);
 269
 270                 /* no actions are run after the interactive one */
 271                 break;
 272             }
 273         }
 274     }
 275 }
 276
 277 gboolean actions_interactive_act_running(void)
 278 {
 279     return interactive_act != NULL;
 280 }
 281
 282 void actions_interactive_cancel_act(void)
 283 {
 284     if (interactive_act) {
 285         interactive_act->def->i_cancel(interactive_act->options);
 286         actions_interactive_end_act();
 287     }
 288 }
 289
 290 static gboolean actions_interactive_begin_act(ObActionsAct *act, guint state)
 291 {
 292     if (grab_keyboard()) {
 293         interactive_act = act;
 294         actions_act_ref(interactive_act);
 295
 296         interactive_initial_state = state;
 297
 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();
 301
 302         return TRUE;
 303     }
 304     else
 305         return FALSE;
 306 }
 307
 308 static void actions_interactive_end_act(void)
 309 {
 310     if (interactive_act) {
 311         ungrab_keyboard();
 312
 313         actions_act_unref(interactive_act);
 314         interactive_act = NULL;
 315     }
 316 }
 317
 318 gboolean actions_interactive_input_event(XEvent *e)
 319 {
 320     gboolean used = FALSE;
 321     if (interactive_act) {
 322         if (!interactive_act->def->i_input(interactive_initial_state, e,
 323                                            interactive_act->options, &used))
 324         {
 325             used = TRUE; /* if it cancelled the action then it has to of
 326                             been used */
 327             actions_interactive_end_act();
 328         }
 329     }
 330     return used;
 331 }
 332
 333 void actions_client_move(ObActionsData *data, gboolean start)
 334 {
 335     static gulong ignore_start = 0;
 336     if (start)
 337         ignore_start = event_start_ignore_all_enters();
 338     else if (config_focus_follow &&
 339              data->context != OB_FRAME_CONTEXT_CLIENT)
 340     {
 341         if (data->uact == OB_USER_ACTION_MOUSE_PRESS) {
 342             struct _ObClient *c;
 343
 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
 348
 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
 351                should be ignored
 352             */
 353             if ((c = client_under_pointer()) && c != data->client &&
 354                 !grab_on_pointer())
 355             {
 356                 ob_debug_type(OB_DEBUG_FOCUS,
 357                               "Generating fake enter because we did a "
 358                               "mouse-event action");
 359                 event_enter_client(c);
 360             }
 361         }
 362         else if (!data->button && !config_focus_under_mouse)
 363             event_end_ignore_all_enters(ignore_start);
 364     }
 365 }