Merge branch 'backport' into work
[dana/openbox.git] / openbox / actions.c
index 8d523dc..8f72714 100644 (file)
 
 #include "actions.h"
 #include "gettext.h"
+#include "grab.h"
+#include "screen.h"
+#include "event.h"
+#include "config.h"
+#include "client.h"
+#include "openbox.h"
+#include "debug.h"
 
-static void actions_definition_ref(ObActionsDefinition *def);
-static void actions_definition_unref(ObActionsDefinition *def);
+#include "actions/all.h"
+
+static void     actions_definition_ref(ObActionsDefinition *def);
+static void     actions_definition_unref(ObActionsDefinition *def);
+static gboolean actions_interactive_begin_act(ObActionsAct *act, guint state);
+static void     actions_interactive_end_act();
+static ObActionsAct* actions_build_act_from_string(const gchar *name);
+
+static ObActionsAct *interactive_act = NULL;
+static guint         interactive_initial_state = 0;
 
 struct _ObActionsDefinition {
     guint ref;
 
     gchar *name;
-    gboolean allow_interactive;
 
     ObActionsDataSetupFunc setup;
     ObActionsDataFreeFunc free;
     ObActionsRunFunc run;
+    ObActionsInteractiveInputFunc i_input;
+    ObActionsInteractiveCancelFunc i_cancel;
 };
 
 struct _ObActionsAct {
     guint ref;
 
     ObActionsDefinition *def;
-
     gpointer options;
 };
 
@@ -48,11 +63,13 @@ void actions_startup(gboolean reconfig)
 {
     if (reconfig) return;
 
-    
+    action_all_startup();
 }
 
 void actions_shutdown(gboolean reconfig)
 {
+    actions_interactive_cancel_act();
+
     if (reconfig) return;
 
     /* free all the registered actions */
@@ -63,14 +80,18 @@ void actions_shutdown(gboolean reconfig)
 }
 
 gboolean actions_register(const gchar *name,
-                          gboolean allow_interactive,
                           ObActionsDataSetupFunc setup,
                           ObActionsDataFreeFunc free,
-                          ObActionsRunFunc run)
+                          ObActionsRunFunc run,
+                          ObActionsInteractiveInputFunc i_input,
+                          ObActionsInteractiveCancelFunc i_cancel)
 {
     GSList *it;
     ObActionsDefinition *def;
 
+    g_assert(run != NULL);
+    g_assert((i_input == NULL) == (i_cancel == NULL));
+
     for (it = registered; it; it = g_slist_next(it)) {
         def = it->data;
         if (!g_ascii_strcasecmp(name, def->name)) /* already registered */
@@ -80,10 +101,14 @@ gboolean actions_register(const gchar *name,
     def = g_new(ObActionsDefinition, 1);
     def->ref = 1;
     def->name = g_strdup(name);
-    def->allow_interactive = allow_interactive;
     def->setup = setup;
     def->free = free;
     def->run = run;
+    def->i_input = i_input;
+    def->i_cancel = i_cancel;
+
+    registered = g_slist_prepend(registered, def);
+
     return TRUE;
 }
 
@@ -100,10 +125,10 @@ static void actions_definition_unref(ObActionsDefinition *def)
     }
 }
 
-ObActionsAct* actions_parse_string(const gchar *name)
+static ObActionsAct* actions_build_act_from_string(const gchar *name)
 {
     GSList *it;
-    ObActionsDefinition *def;
+    ObActionsDefinition *def = NULL;
     ObActionsAct *act = NULL;
 
     /* find the requested action */
@@ -122,23 +147,33 @@ ObActionsAct* actions_parse_string(const gchar *name)
         actions_definition_ref(act->def);
         act->options = NULL;
     } else
-        g_message(_("Invalid action '%s' requested. No such action exists."),
+        g_message(_("Invalid action \"%s\" requested. No such action exists."),
                   name);
 
     return act;
 }
 
-ObActionsAct* actions_parse(ObParseInst *i,
-                            xmlDocPtr doc,
-                            xmlNodePtr node)
+ObActionsAct* actions_parse_string(const gchar *name)
+{
+    ObActionsAct *act = NULL;
+
+    if ((act = actions_build_act_from_string(name)))
+        if (act->def->setup)
+            act->options = act->def->setup(NULL);
+
+    return act;
+}
+
+ObActionsAct* actions_parse(xmlNodePtr node)
 {
     gchar *name;
     ObActionsAct *act = NULL;
 
-    if (parse_attr_string("name", node, &name)) {
-        if ((act = actions_parse_string(name)))
+    if (obt_parse_attr_string(node, "name", &name)) {
+        if ((act = actions_build_act_from_string(name)))
             /* there is more stuff to parse here */
-            act->options = act->def->setup(i, doc, node->children);
+            if (act->def->setup)
+                act->options = act->def->setup(node->children);
 
         g_free(name);
     }
@@ -146,6 +181,11 @@ ObActionsAct* actions_parse(ObParseInst *i,
     return act;
 }
 
+gboolean actions_act_is_interactive(ObActionsAct *act)
+{
+    return act->def->i_cancel != NULL;
+}
+
 void actions_act_ref(ObActionsAct *act)
 {
     ++act->ref;
@@ -155,9 +195,171 @@ void actions_act_unref(ObActionsAct *act)
 {
     if (act && --act->ref == 0) {
         /* free the action specific options */
-        act->def->free(act->options);
+        if (act->def->free)
+            act->def->free(act->options);
         /* unref the definition */
         actions_definition_unref(act->def);
         g_free(act);
     }
 }
+
+static void actions_setup_data(ObActionsData *data,
+                               ObUserAction uact,
+                               guint state,
+                               gint x,
+                               gint y,
+                               gint button,
+                               ObFrameContext con,
+                               struct _ObClient *client)
+{
+    data->uact = uact;
+    data->state = state;
+    data->x = x;
+    data->y = y;
+    data->button = button;
+    data->context = con;
+    data->client = client;
+}
+
+void actions_run_acts(GSList *acts,
+                      ObUserAction uact,
+                      guint state,
+                      gint x,
+                      gint y,
+                      gint button,
+                      ObFrameContext con,
+                      struct _ObClient *client)
+{
+    GSList *it;
+
+    /* Don't allow saving the initial state when running things from the
+       menu */
+    if (uact == OB_USER_ACTION_MENU_SELECTION)
+        state = 0;
+    /* If x and y are < 0 then use the current pointer position */
+    if (x < 0 && y < 0)
+        screen_pointer_pos(&x, &y);
+
+    for (it = acts; it; it = g_slist_next(it)) {
+        ObActionsData data;
+        ObActionsAct *act = it->data;
+        gboolean ok = TRUE;
+
+        actions_setup_data(&data, uact, state, x, y, button, con, client);
+
+        /* if they have the same run function, then we'll assume they are
+           cooperating and not cancel eachother out */
+        if (!interactive_act || interactive_act->def->run != act->def->run) {
+            if (actions_act_is_interactive(act)) {
+                /* cancel the old one */
+                if (interactive_act)
+                    actions_interactive_cancel_act();
+                ok = actions_interactive_begin_act(act, state);
+            }
+        }
+
+        /* fire the action's run function with this data */
+        if (ok) {
+            if (!act->def->run(&data, act->options)) {
+                if (actions_act_is_interactive(act))
+                    actions_interactive_end_act();
+            } else {
+                /* make sure its interactive if it returned TRUE */
+                g_assert(act->def->i_cancel && act->def->i_input);
+
+                /* no actions are run after the interactive one */
+                break;
+            }
+        }
+    }
+}
+
+gboolean actions_interactive_act_running(void)
+{
+    return interactive_act != NULL;
+}
+
+void actions_interactive_cancel_act(void)
+{
+    if (interactive_act) {
+        interactive_act->def->i_cancel(interactive_act->options);
+        actions_interactive_end_act();
+    }
+}
+
+static gboolean actions_interactive_begin_act(ObActionsAct *act, guint state)
+{
+    if (grab_keyboard()) {
+        interactive_act = act;
+        actions_act_ref(interactive_act);
+
+        interactive_initial_state = state;
+
+        /* if using focus_delay, stop the timer now so that focus doesn't go
+           moving on us, which would kill the action */
+        event_halt_focus_delay();
+
+        return TRUE;
+    }
+    else
+        return FALSE;
+}
+
+static void actions_interactive_end_act(void)
+{
+    if (interactive_act) {
+        ungrab_keyboard();
+
+        actions_act_unref(interactive_act);
+        interactive_act = NULL;
+    }
+}
+
+gboolean actions_interactive_input_event(XEvent *e)
+{
+    gboolean used = FALSE;
+    if (interactive_act) {
+        if (!interactive_act->def->i_input(interactive_initial_state, e,
+                                           interactive_act->options, &used))
+        {
+            used = TRUE; /* if it cancelled the action then it has to of
+                            been used */
+            actions_interactive_end_act();
+        }
+    }
+    return used;
+}
+
+void actions_client_move(ObActionsData *data, gboolean start)
+{
+    static gulong ignore_start = 0;
+    if (start)
+        ignore_start = event_start_ignore_all_enters();
+    else if (config_focus_follow &&
+             data->context != OB_FRAME_CONTEXT_CLIENT)
+    {
+        if (data->uact == OB_USER_ACTION_MOUSE_PRESS) {
+            struct _ObClient *c;
+
+            /* usually this is sorta redundant, but with a press action
+               that moves windows our from under the cursor, the enter
+               event will come as a GrabNotify which is ignored, so this
+               makes a fake enter event
+
+               don't do this if there is a grab on the pointer.  enter events
+               are ignored during a grab, so don't force fake ones when they
+               should be ignored
+            */
+            if ((c = client_under_pointer()) && c != data->client &&
+                !grab_on_pointer())
+            {
+                ob_debug_type(OB_DEBUG_FOCUS,
+                              "Generating fake enter because we did a "
+                              "mouse-event action");
+                event_enter_client(c);
+            }
+        }
+        else if (!data->button && !config_focus_under_mouse)
+            event_end_ignore_all_enters(ignore_start);
+    }
+}