[clutter/wip/apocalypses/apocalypse-1: 83/92] actor: Use flags to control add/remove child

[Emmanuele Bassi <ebassi src gnome org>]

commit ca50fb8592956a2f9e20d1102f9e63546d2da20f
Author: Emmanuele Bassi <ebassi gnome org>
Date:   Tue Dec 27 11:28:36 2011 +0000

    actor: Use flags to control add/remove child
    
    The internal versions of add_child() and remove_child() currently use
    boolean arguments to control things like the ChildMeta instances and
    the emissions of signals; using more than one boolean argument is an
    indication that you need flags to avoid readability issues, as well as
    providing a way to add new behaviours without a combinatorial explosion
    of arguments, later on.

 clutter/clutter-actor.c |  124 ++++++++++++++++++++++++++++++-----------------
 1 files changed, 80 insertions(+), 44 deletions(-)
---
diff --git a/clutter/clutter-actor.c b/clutter/clutter-actor.c
index 9be5a55..2a938e9 100644
--- a/clutter/clutter-actor.c
+++ b/clutter/clutter-actor.c
@@ -9494,16 +9494,19 @@ typedef void (* ClutterActorAddChildFunc) (ClutterActor *parent,
                                            ClutterActor *child,
                                            gpointer      data);
 
+typedef enum {
+  ADD_CHILD_CREATE_META      = 1 << 0,
+  ADD_CHILD_EMIT_PARENT_SET  = 1 << 1,
+  ADD_CHILD_EMIT_ACTOR_ADDED = 1 << 2
+} ClutterActorAddChildFlags;
+
 /*< private >
  * clutter_actor_add_child_internal:
  * @self: a #ClutterActor
  * @child: a #ClutterActor
+ * @flags: control flags for actions
  * @add_func: delegate function
  * @data: (closure): data to pass to @add_func
- * @create_meta: whether this function should create a #ClutterChildMeta
- *   instance through the #ClutterContainer interface
- * @emit_signal: whether this function should emit the
- *   #ClutterContainer::actor-added signal
  *
  * Adds @child to the list of children of @self.
  *
@@ -9511,19 +9514,17 @@ typedef void (* ClutterActorAddChildFunc) (ClutterActor *parent,
  * function will just set up the state, perform basic checks, and emit
  * signals.
  *
- * For backward compatibility with #ClutterContainer and the old
- * #ClutterActor API, this function can optionally emit the Container
- * signals and create #ClutterChildMeta instances.
+ * The @flags argument is used to perform additional operations.
  */
-static void
-clutter_actor_add_child_internal (ClutterActor             *self,
-                                  ClutterActor             *child,
-                                  ClutterActorAddChildFunc  add_func,
-                                  gpointer                  data,
-                                  gboolean                  create_meta,
-                                  gboolean                  emit_signal)
+static inline void
+clutter_actor_add_child_internal (ClutterActor              *self,
+                                  ClutterActor              *child,
+                                  ClutterActorAddChildFlags  flags,
+                                  ClutterActorAddChildFunc   add_func,
+                                  gpointer                   data)
 {
   ClutterTextDirection text_dir;
+  gboolean create_meta, emit_parent_set, emit_actor_added;
 
   if (child->priv->parent != NULL)
     {
@@ -9544,6 +9545,10 @@ clutter_actor_add_child_internal (ClutterActor             *self,
       return;
     }
 
+  create_meta = (flags & ADD_CHILD_CREATE_META) != 0;
+  emit_parent_set = (flags & ADD_CHILD_EMIT_PARENT_SET) != 0;
+  emit_actor_added = (flags & ADD_CHILD_EMIT_ACTOR_ADDED) != 0;
+
   if (create_meta)
     clutter_container_create_child_meta (CLUTTER_CONTAINER (self), child);
 
@@ -9562,7 +9567,7 @@ clutter_actor_add_child_internal (ClutterActor             *self,
     CLUTTER_SET_PRIVATE_FLAGS (child, CLUTTER_INTERNAL_CHILD);
 
   /* clutter_actor_reparent() will emit ::parent-set for us */
-  if (!CLUTTER_ACTOR_IN_REPARENT (child))
+  if (emit_parent_set && !CLUTTER_ACTOR_IN_REPARENT (child))
     g_signal_emit (child, actor_signals[PARENT_SET], 0, NULL);
 
   /* If parent is mapped or realized, we need to also be mapped or
@@ -9598,7 +9603,7 @@ clutter_actor_add_child_internal (ClutterActor             *self,
       clutter_actor_queue_relayout (child->priv->parent);
     }
 
-  if (emit_signal)
+  if (emit_actor_added)
     g_signal_emit_by_name (self, "actor-added", child);
 }
 
@@ -9630,10 +9635,11 @@ clutter_actor_add_child (ClutterActor *self,
   g_return_if_fail (child->priv->parent == NULL);
 
   clutter_actor_add_child_internal (self, child,
+                                    ADD_CHILD_CREATE_META |
+                                    ADD_CHILD_EMIT_PARENT_SET |
+                                    ADD_CHILD_EMIT_ACTOR_ADDED,
                                     insert_child_at_depth,
-                                    NULL,
-                                    TRUE, /* create_meta */
-                                    TRUE  /* emit_signals */);
+                                    NULL);
 }
 
 /**
@@ -9667,10 +9673,11 @@ clutter_actor_insert_child_at_index (ClutterActor *self,
   g_return_if_fail (child->priv->parent == NULL);
 
   clutter_actor_add_child_internal (self, child,
+                                    ADD_CHILD_CREATE_META |
+                                    ADD_CHILD_EMIT_PARENT_SET |
+                                    ADD_CHILD_EMIT_ACTOR_ADDED,
                                     insert_child_at_index,
-                                    GINT_TO_POINTER (index_),
-                                    TRUE,
-                                    TRUE);
+                                    GINT_TO_POINTER (index_));
 }
 
 /**
@@ -9709,10 +9716,11 @@ clutter_actor_insert_child_above (ClutterActor *self,
                      sibling->priv->parent == self));
 
   clutter_actor_add_child_internal (self, child,
+                                    ADD_CHILD_CREATE_META |
+                                    ADD_CHILD_EMIT_PARENT_SET |
+                                    ADD_CHILD_EMIT_ACTOR_ADDED,
                                     insert_child_above,
-                                    sibling,
-                                    TRUE,
-                                    TRUE);
+                                    sibling);
 }
 
 /**
@@ -9751,10 +9759,11 @@ clutter_actor_insert_child_below (ClutterActor *self,
                      sibling->priv->parent == self));
 
   clutter_actor_add_child_internal (self, child,
+                                    ADD_CHILD_CREATE_META |
+                                    ADD_CHILD_EMIT_PARENT_SET |
+                                    ADD_CHILD_EMIT_ACTOR_ADDED,
                                     insert_child_below,
-                                    sibling,
-                                    TRUE,
-                                    TRUE);
+                                    sibling);
 }
 
 /**
@@ -9789,10 +9798,9 @@ clutter_actor_set_parent (ClutterActor *self,
    * emissions
    */
   clutter_actor_add_child_internal (parent, self,
+                                    ADD_CHILD_EMIT_PARENT_SET,
                                     insert_child_at_depth,
-                                    NULL,
-                                    FALSE,
-                                    FALSE);
+                                    NULL);
 }
 
 /**
@@ -9871,14 +9879,32 @@ remove_child (ClutterActor *self,
     self->priv->last_child = prev_sibling;
 }
 
+typedef enum {
+  REMOVE_CHILD_DESTROY_META = 1 << 0,
+  REMOVE_CHILD_EMIT_PARENT_SET = 1 << 1,
+  REMOVE_CHILD_EMIT_ACTOR_REMOVED = 1 << 2
+} ClutterActorRemoveChildFlags;
+
+/*< private >
+ * clutter_actor_remove_child_internal:
+ * @self: a #ClutterActor
+ * @child: the child of @self that has to be removed
+ * @flags: control the removal operations
+ *
+ * Removes @child from the list of children of @self.
+ */
 static void
-clutter_actor_remove_child_internal (ClutterActor *self,
-                                     ClutterActor *child,
-                                     gboolean      destroy_meta,
-                                     gboolean      emit_signal)
+clutter_actor_remove_child_internal (ClutterActor                 *self,
+                                     ClutterActor                 *child,
+                                     ClutterActorRemoveChildFlags  flags)
 {
+  gboolean destroy_meta, emit_parent_set, emit_actor_removed;
   gboolean was_mapped;
 
+  destroy_meta = (flags & REMOVE_CHILD_DESTROY_META) != 0;
+  emit_parent_set = (flags & REMOVE_CHILD_EMIT_PARENT_SET) != 0;
+  emit_actor_removed = (flags & REMOVE_CHILD_EMIT_ACTOR_REMOVED) != 0;
+
   if (destroy_meta)
     clutter_container_destroy_child_meta (CLUTTER_CONTAINER (self), child);
 
@@ -9914,7 +9940,7 @@ clutter_actor_remove_child_internal (ClutterActor *self,
   child->priv->parent = NULL;
 
   /* clutter_actor_reparent() will emit ::parent-set for us */
-  if (!CLUTTER_ACTOR_IN_REPARENT (child))
+  if (emit_parent_set && !CLUTTER_ACTOR_IN_REPARENT (child))
     g_signal_emit (child, actor_signals[PARENT_SET], 0, self);
 
   remove_child (self, child);
@@ -9928,7 +9954,7 @@ clutter_actor_remove_child_internal (ClutterActor *self,
     clutter_actor_queue_relayout (self);
 
   /* we need to emit the signal before dropping the reference */
-  if (emit_signal)
+  if (emit_actor_removed)
     g_signal_emit_by_name (self, "actor-removed", child);
 
   /* remove the reference we acquired in clutter_actor_add_child() */
@@ -9962,7 +9988,10 @@ clutter_actor_remove_child (ClutterActor *self,
   g_return_if_fail (child->priv->parent != NULL);
   g_return_if_fail (child->priv->parent == self);
 
-  clutter_actor_remove_child_internal (self, child, TRUE, TRUE);
+  clutter_actor_remove_child_internal (self, child,
+                                       REMOVE_CHILD_DESTROY_META |
+                                       REMOVE_CHILD_EMIT_PARENT_SET |
+                                       REMOVE_CHILD_EMIT_ACTOR_REMOVED);
 }
 
 /**
@@ -9991,7 +10020,10 @@ clutter_actor_remove_all_children (ClutterActor *self)
     {
       ClutterActor *next = iter->priv->next_sibling;
 
-      clutter_actor_remove_child_internal (self, iter, TRUE, TRUE);
+      clutter_actor_remove_child_internal (self, iter,
+                                           REMOVE_CHILD_DESTROY_META |
+                                           REMOVE_CHILD_EMIT_PARENT_SET |
+                                           REMOVE_CHILD_EMIT_ACTOR_REMOVED);
 
       iter = next;
     }
@@ -10060,14 +10092,19 @@ clutter_actor_replace_child (ClutterActor *self,
   prev_sibling = old_child->priv->prev_sibling;
   next_sibling = old_child->priv->next_sibling;
 
-  clutter_actor_remove_child_internal (self, old_child, TRUE, TRUE);
+  clutter_actor_remove_child_internal (self, old_child,
+                                       REMOVE_CHILD_DESTROY_META |
+                                       REMOVE_CHILD_EMIT_PARENT_SET |
+                                       REMOVE_CHILD_EMIT_ACTOR_REMOVED);
 
   clos.prev_sibling = prev_sibling;
   clos.next_sibling = next_sibling;
   clutter_actor_add_child_internal (self, new_child,
+                                    ADD_CHILD_CREATE_META |
+                                    ADD_CHILD_EMIT_PARENT_SET |
+                                    ADD_CHILD_EMIT_ACTOR_ADDED,
                                     insert_child_between,
-                                    &clos,
-                                    TRUE, TRUE);
+                                    &clos);
 }
 
 /**
@@ -10097,8 +10134,7 @@ clutter_actor_unparent (ClutterActor *self)
     return;
 
   clutter_actor_remove_child_internal (self->priv->parent, self,
-                                       FALSE,
-                                       FALSE);
+                                       REMOVE_CHILD_EMIT_PARENT_SET);
 }
 
 /**