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 static gboolean      replay_pointer = FALSE;
  40
  41 struct _ObActionsDefinition {
  42     guint ref;
  43
  44     gchar *name;
  45
  46     ObActionsDataSetupFunc setup;
  47     ObActionsDataFreeFunc free;
  48     ObActionsRunFunc run;
  49     ObActionsInteractiveInputFunc i_input;
  50     ObActionsInteractiveCancelFunc i_cancel;
  51 };
  52
  53 struct _ObActionsAct {
  54     guint ref;
  55
  56     ObActionsDefinition *def;
  57     gpointer options;
  58 };
  59
  60 static GSList *registered = NULL;
  61
  62
  63 void actions_startup(gboolean reconfig)
  64 {
  65     if (reconfig) return;
  66
  67     action_all_startup();
  68 }
  69
  70 void actions_shutdown(gboolean reconfig)
  71 {
  72     actions_interactive_cancel_act();
  73
  74     if (reconfig) return;
  75
  76     /* free all the registered actions */
  77     while (registered) {
  78         actions_definition_unref(registered->data);
  79         registered = g_slist_delete_link(registered, registered);
  80     }
  81 }
  82
  83 gboolean actions_register(const gchar *name,
  84                           ObActionsDataSetupFunc setup,
  85                           ObActionsDataFreeFunc free,
  86                           ObActionsRunFunc run,
  87                           ObActionsInteractiveInputFunc i_input,
  88                           ObActionsInteractiveCancelFunc i_cancel)
  89 {
  90     GSList *it;
  91     ObActionsDefinition *def;
  92
  93     g_assert(run != NULL);
  94     g_assert((i_input == NULL) == (i_cancel == NULL));
  95
  96     for (it = registered; it; it = g_slist_next(it)) {
  97         def = it->data;
  98         if (!g_ascii_strcasecmp(name, def->name)) /* already registered */
  99             return FALSE;
 100     }
 101
 102     def = g_new(ObActionsDefinition, 1);
 103     def->ref = 1;
 104     def->name = g_strdup(name);
 105     def->setup = setup;
 106     def->free = free;
 107     def->run = run;
 108     def->i_input = i_input;
 109     def->i_cancel = i_cancel;
 110
 111     registered = g_slist_prepend(registered, def);
 112
 113     return TRUE;
 114 }
 115
 116 static void actions_definition_ref(ObActionsDefinition *def)
 117 {
 118     ++def->ref;
 119 }
 120
 121 static void actions_definition_unref(ObActionsDefinition *def)
 122 {
 123     if (def && --def->ref == 0) {
 124         g_free(def->name);
 125         g_free(def);
 126     }
 127 }
 128
 129 static ObActionsAct* actions_build_act_from_string(const gchar *name)
 130 {
 131     GSList *it;
 132     ObActionsDefinition *def = NULL;
 133     ObActionsAct *act = NULL;
 134
 135     /* find the requested action */
 136     for (it = registered; it; it = g_slist_next(it)) {
 137         def = it->data;
 138         if (!g_ascii_strcasecmp(name, def->name))
 139             break;
 140         def = NULL;
 141     }
 142
 143     /* if we found the action */
 144     if (def) {
 145         act = g_new(ObActionsAct, 1);
 146         act->ref = 1;
 147         act->def = def;
 148         actions_definition_ref(act->def);
 149         act->options = NULL;
 150     } else
 151         g_message(_("Invalid action '%s' requested. No such action exists."),
 152                   name);
 153
 154     return act;
 155 }
 156
 157 ObActionsAct* actions_parse_string(const gchar *name)
 158 {
 159     ObActionsAct *act = NULL;
 160
 161     if ((act = actions_build_act_from_string(name)))
 162         if (act->def->setup)
 163             act->options = act->def->setup(NULL);
 164
 165     return act;
 166 }
 167
 168 ObActionsAct* actions_parse(xmlNodePtr node)
 169 {
 170     gchar *name;
 171     ObActionsAct *act = NULL;
 172
 173     if (obt_parse_attr_string(node, "name", &name)) {
 174         if ((act = actions_build_act_from_string(name)))
 175             /* there is more stuff to parse here */
 176             if (act->def->setup)
 177                 act->options = act->def->setup(node->children);
 178
 179         g_free(name);
 180     }
 181
 182     return act;
 183 }
 184
 185 gboolean actions_act_is_interactive(ObActionsAct *act)
 186 {
 187     return act->def->i_cancel != NULL;
 188 }
 189
 190 void actions_act_ref(ObActionsAct *act)
 191 {
 192     ++act->ref;
 193 }
 194
 195 void actions_act_unref(ObActionsAct *act)
 196 {
 197     if (act && --act->ref == 0) {
 198         /* free the action specific options */
 199         if (act->def->free)
 200             act->def->free(act->options);
 201         /* unref the definition */
 202         actions_definition_unref(act->def);
 203         g_free(act);
 204     }
 205 }
 206
 207 static void actions_setup_data(ObActionsData *data,
 208                                ObUserAction uact,
 209                                guint state,
 210                                gint x,
 211                                gint y,
 212                                gint button,
 213                                ObFrameContext con,
 214                                struct _ObClient *client)
 215 {
 216     data->uact = uact;
 217     data->state = state;
 218     data->x = x;
 219     data->y = y;
 220     data->button = button;
 221     data->context = con;
 222     data->client = client;
 223 }
 224
 225 void actions_set_need_pointer_replay_before_move(gboolean replay)
 226 {
 227     replay_pointer = replay;
 228 }
 229
 230 gboolean actions_get_need_pointer_replay_before_move()
 231 {
 232     return replay_pointer;
 233 }
 234
 235 void actions_run_acts(GSList *acts,
 236                       ObUserAction uact,
 237                       guint state,
 238                       gint x,
 239                       gint y,
 240                       gint button,
 241                       ObFrameContext con,
 242                       struct _ObClient *client)
 243 {
 244     GSList *it;
 245
 246     /* Don't allow saving the initial state when running things from the
 247        menu */
 248     if (uact == OB_USER_ACTION_MENU_SELECTION)
 249         state = 0;
 250     /* If x and y are < 0 then use the current pointer position */
 251     if (x < 0 && y < 0)
 252         screen_pointer_pos(&x, &y);
 253
 254     for (it = acts; it; it = g_slist_next(it)) {
 255         ObActionsData data;
 256         ObActionsAct *act = it->data;
 257         gboolean ok = TRUE;
 258
 259         actions_setup_data(&data, uact, state, x, y, button, con, client);
 260
 261         /* if they have the same run function, then we'll assume they are
 262            cooperating and not cancel eachother out */
 263         if (!interactive_act || interactive_act->def->run != act->def->run) {
 264             if (actions_act_is_interactive(act)) {
 265                 /* cancel the old one */
 266                 if (interactive_act)
 267                     actions_interactive_cancel_act();
 268                 ok = actions_interactive_begin_act(act, state);
 269             }
 270         }
 271
 272         /* fire the action's run function with this data */
 273         if (ok) {
 274             if (!act->def->run(&data, act->options)) {
 275                 if (actions_act_is_interactive(act))
 276                     actions_interactive_end_act();
 277             } else {
 278                 /* make sure its interactive if it returned TRUE */
 279                 g_assert(act->def->i_cancel && act->def->i_input);
 280
 281                 /* no actions are run after the interactive one */
 282                 break;
 283             }
 284         }
 285     }
 286 }
 287
 288 gboolean actions_interactive_act_running(void)
 289 {
 290     return interactive_act != NULL;
 291 }
 292
 293 void actions_interactive_cancel_act(void)
 294 {
 295     if (interactive_act) {
 296         interactive_act->def->i_cancel(interactive_act->options);
 297         actions_interactive_end_act();
 298     }
 299 }
 300
 301 static gboolean actions_interactive_begin_act(ObActionsAct *act, guint state)
 302 {
 303     if (grab_keyboard()) {
 304         interactive_act = act;
 305         actions_act_ref(interactive_act);
 306
 307         interactive_initial_state = state;
 308
 309         /* if using focus_delay, stop the timer now so that focus doesn't go
 310            moving on us, which would kill the action */
 311         event_halt_focus_delay();
 312
 313         return TRUE;
 314     }
 315     else
 316         return FALSE;
 317 }
 318
 319 static void actions_interactive_end_act(void)
 320 {
 321     if (interactive_act) {
 322         ungrab_keyboard();
 323
 324         actions_act_unref(interactive_act);
 325         interactive_act = NULL;
 326     }
 327 }
 328
 329 gboolean actions_interactive_input_event(XEvent *e)
 330 {
 331     gboolean used = FALSE;
 332     if (interactive_act) {
 333         if (!interactive_act->def->i_input(interactive_initial_state, e,
 334                                            interactive_act->options, &used))
 335         {
 336             used = TRUE; /* if it cancelled the action then it has to of
 337                             been used */
 338             actions_interactive_end_act();
 339         }
 340     }
 341     return used;
 342 }
 343
 344 void actions_client_move(ObActionsData *data, gboolean start)
 345 {
 346     static gulong ignore_start = 0;
 347     if (start) {
 348         ignore_start = event_start_ignore_all_enters();
 349         if (replay_pointer) {
 350             /* replay the pointer event before any windows move */
 351             XAllowEvents(obt_display, ReplayPointer, event_curtime);
 352             replay_pointer = FALSE;
 353         }
 354     }
 355     else if (config_focus_follow &&
 356              data->context != OB_FRAME_CONTEXT_CLIENT)
 357     {
 358         if (data->uact == OB_USER_ACTION_MOUSE_PRESS) {
 359             struct _ObClient *c;
 360
 361             /* usually this is sorta redundant, but with a press action
 362                that moves windows our from under the cursor, the enter
 363                event will come as a GrabNotify which is ignored, so this
 364                makes a fake enter event
 365             */
 366             if ((c = client_under_pointer()) && c != data->client) {
 367                 ob_debug_type(OB_DEBUG_FOCUS,
 368                               "Generating fake enter because we did a "
 369                               "mouse-event action");
 370                 event_enter_client(c);
 371             }
 372         }
 373         else if (!data->button && !config_focus_under_mouse)
 374             event_end_ignore_all_enters(ignore_start);
 375     }
 376 }