From 8761b279a715167fc87194c14efe00f10bba2bf9 Mon Sep 17 00:00:00 2001
From: =?utf8?q?=C3=98yvind=20Kol=C3=A5s?= <pippin@linux.intel.com>
Date: Wed, 12 May 2010 17:03:25 +0100
Subject: [PATCH] state-machine: add completed signal

Added a completed signal to the animator
---
 clutter/clutter-state.c        | 54 ++++++++++++++++++++++++++++++++++++++----
 clutter/clutter-state.h        |  6 ++++-
 tests/interactive/test-state.c |  7 ++++++
 3 files changed, 61 insertions(+), 6 deletions(-)

diff --git a/clutter/clutter-state.c b/clutter/clutter-state.c
index 77da22f..520c0b5 100644
--- a/clutter/clutter-state.c
+++ b/clutter/clutter-state.c
@@ -35,6 +35,7 @@
 
 #include "clutter-private.h"
 #include "clutter-state.h"
+#include "clutter-marshal.h"
 #include <gobject/gvaluecollector.h>
 #include <string.h>
 
@@ -98,6 +99,13 @@ typedef struct _ClutterStateKey
   gint             ref_count;
 } _ClutterStateKey;
 
+enum
+{
+  COMPLETED,
+  LAST_SIGNAL
+};
+
+static guint state_signals[LAST_SIGNAL] = {0, };
 
 #define CLUTTER_STATE_GET_PRIVATE(obj)            \
               (G_TYPE_INSTANCE_GET_PRIVATE ((obj), \
@@ -309,7 +317,7 @@ clutter_state_finalize (GObject *object)
 }
 
 static void clutter_state_completed (ClutterTimeline *timeline,
-                                     ClutterState   *state)
+                                     ClutterState    *state)
 {
   if (state->priv->current_animator)
     {
@@ -317,6 +325,7 @@ static void clutter_state_completed (ClutterTimeline *timeline,
                                      NULL);
       state->priv->current_animator = NULL;
     }
+  g_signal_emit (state, state_signals[COMPLETED], 0);
 }
 
 static void clutter_state_new_frame (ClutterTimeline *timeline,
@@ -925,6 +934,15 @@ clutter_state_class_init (ClutterStateClass *klass)
   gobject_class->finalize = clutter_state_finalize;
 
   g_type_class_add_private (klass, sizeof (ClutterStatePrivate));
+
+  state_signals[COMPLETED] =
+  g_signal_new (I_("completed"),
+                G_TYPE_FROM_CLASS (gobject_class),
+                G_SIGNAL_RUN_LAST,
+                G_STRUCT_OFFSET (ClutterStateClass, completed),
+                NULL, NULL,
+                clutter_marshal_VOID__VOID,
+                G_TYPE_NONE, 0);
 }
 
 static void
@@ -1264,11 +1282,19 @@ clutter_state_set_duration (ClutterState *state,
     }
 }
 
-/* should have durations for:
+/**
+ * clutter_state_get_duration:
+ * @state: a #ClutterState
+ * @source_state_name: the name of the source state to set duration for or NULL
+ * @target_state_name: the name of the source state to set duration for or NULL
  *
- * global:            NULL, NULL
- * per-state-default: NULL, state
- * directly encoded:  state, state
+ * Query the duration used for transitions between source/target state pair,
+ * the semantics for the query are the same as the semantics used for setting
+ * in #clutter_state_set_duration.
+ *
+ * Since: 1.4
+ * 
+ * Returns: the duration in ms.
  */
 guint
 clutter_state_get_duration (ClutterState *state,
@@ -1308,3 +1334,21 @@ clutter_state_get_duration (ClutterState *state,
     ret = state->priv->duration;
   return ret;
 }
+
+/**
+ * clutter_state_get_target_state:
+ * @state: a #ClutterState
+ *
+ * Query the currently set target-state, during a transition it will also
+ * return the current target. Can be useful in the completed callback.
+ *
+ * Since: 1.4
+ * 
+ * Returns: the duration in ms.
+ */
+const gchar *
+clutter_state_get_target_state (ClutterState *state)
+{
+  g_return_val_if_fail (CLUTTER_IS_STATE (state), NULL);
+  return state->priv->target_state_name;
+}
diff --git a/clutter/clutter-state.h b/clutter/clutter-state.h
index 845918e..a6b1ced 100644
--- a/clutter/clutter-state.h
+++ b/clutter/clutter-state.h
@@ -82,6 +82,9 @@ struct _ClutterStateClass
   /*< private >*/
   GObjectClass parent_class;
 
+  /*< public >*/
+  void (*completed) (ClutterState *state);
+
   /* padding for future expansion */
   gpointer _padding_dummy[16];
 };
@@ -97,7 +100,8 @@ ClutterTimeline * clutter_state_change               (ClutterState    *state,
                                                       const gchar     *target_transition_name);
 ClutterTimeline * clutter_state_change_noanim        (ClutterState    *state,
                                                       const gchar     *target_transition_name);
-ClutterState *    clutter_state_set_key               (ClutterState   *state,
+const gchar     * clutter_state_get_target_state     (ClutterState    *state);
+ClutterState *    clutter_state_set_key              (ClutterState    *state,
                                                       const gchar     *source_transition_name,
                                                       const gchar     *target_transition_name,
                                                       GObject         *object,
diff --git a/tests/interactive/test-state.c b/tests/interactive/test-state.c
index 7a7b86e..fd43190 100644
--- a/tests/interactive/test-state.c
+++ b/tests/interactive/test-state.c
@@ -23,6 +23,12 @@ static gboolean release_event (ClutterActor *actor,
   return TRUE;
 }
 
+static void completed (ClutterState *state,
+                       gpointer      data)
+{
+  g_print ("Completed transitioning to state: %s\n",
+           clutter_state_get_target_state (state), data);
+}
 
 static ClutterActor *new_rect (gint r,
                                gint g,
@@ -86,6 +92,7 @@ test_state_main (gint    argc,
           rects[1], "scale-y", CLUTTER_LINEAR, 2.0,
           NULL);
   clutter_state_set_duration (state, "start", "end", 5000);
+  g_signal_connect (state, "completed", G_CALLBACK (completed), NULL);
 
   clutter_actor_show (stage);
   clutter_state_change (state, "start");
-- 
2.7.4