[glib-controller] Add a model example

[Emmanuele Bassi <ebassi src gnome org>]

commit b29ee39d517ee32cfa564bf73d4e5553ed69601b
Author: Emmanuele Bassi <ebassi linux intel com>
Date:   Fri Apr 30 15:27:02 2010 +0100

    Add a model example
    
    MySimpleModel is a simple example of a "model" object using a GPtrArray
    as storage and a GPtrArrayController internally.
    
    As the model operates on the storage, it also notifies the controller of
    the changes; user code (in this case, a simple display function) will
    monitor the GController::changed signal on the GController provided by
    the model class.

 .gitignore              |    1 +
 Makefile.am             |    9 ++
 examples/simple-model.c |  289 +++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 299 insertions(+), 0 deletions(-)
---
diff --git a/.gitignore b/.gitignore
index e720d4a..7d44c6d 100644
--- a/.gitignore
+++ b/.gitignore
@@ -54,6 +54,7 @@ libtool
 ltmain.sh
 missing
 omf.make
+simple-model
 stamp-h1
 stamp-enum-types
 stamp-marshal
diff --git a/Makefile.am b/Makefile.am
index 525e828..65a4dd2 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -16,6 +16,8 @@ EXTRA_DIST =
 TEST_PROGS =
 check_PROGRAMS = $(TEST_PROGS)
 
+noinst_PROGRAMS =
+
 # unfortunately, gtk-doc has issues with non-recursive autotools
 SUBDIRS = . doc
 
@@ -135,5 +137,12 @@ hash_controller_CPPFLAGS = $(AM_CPPFLAGS) $(GCONTROLLER_DEBUG_CFLAGS) -I$(top_sr
 hash_controller_CFLAGS = $(GCONTROLLER_CFLAGS) $(MAINTAINER_CFLAGS)
 hash_controller_LDADD = $(GCONTROLLER_LIBS) $(top_builddir)/libglib-controller-1.0.la
 
+# Examples
+noinst_PROGRAMS += simple-model
+simple_model_SOURCES = examples/simple-model.c
+simple_model_CPPFLAGS = $(AM_CPPFLAGS) $(GCONTROLLER_DEBUG_CFLAGS) -I$(top_srcdir) -I$(top_srcdir)/glib-controller -I$(top_builddir)
+simple_model_CFLAGS = $(GCONTROLLER_CFLAGS) $(MAINTAINER_CFLAGS)
+simple_model_LDADD = $(GCONTROLLER_LIBS) $(top_builddir)/libglib-controller-1.0.la
+
 # GCov rules
 #include $(top_srcdir)/build/Makefile.am.gcov
diff --git a/examples/simple-model.c b/examples/simple-model.c
new file mode 100644
index 0000000..311e082
--- /dev/null
+++ b/examples/simple-model.c
@@ -0,0 +1,289 @@
+#include <stdlib.h>
+#include <string.h>
+#include <stdio.h>
+
+#include <glib-object.h>
+#include <glib-controller/glib-controller.h>
+
+G_BEGIN_DECLS
+
+#define MY_TYPE_SIMPLE_MODEL            (my_simple_model_get_type ())
+#define MY_SIMPLE_MODEL(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), MY_TYPE_SIMPLE_MODEL, MySimpleModel))
+#define MY_IS_SIMPLE_MODEL(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), MY_TYPE_SIMPLE_MODEL))
+
+typedef struct _MySimpleModel           MySimpleModel;
+typedef struct _MySimpleModelClass      MySimpleModelClass;
+
+struct _MySimpleModel
+{
+  GObject parent_instance;
+
+  GController *controller;
+  GPtrArray *array;
+};
+
+struct _MySimpleModelClass
+{
+  GObjectClass parent_class;
+};
+
+GType my_simple_model_get_type (void) G_GNUC_CONST;
+
+G_END_DECLS
+
+/* implementation */
+
+G_DEFINE_TYPE (MySimpleModel, my_simple_model, G_TYPE_OBJECT);
+
+static void
+my_simple_model_dispose (GObject *gobject)
+{
+  MySimpleModel *model = MY_SIMPLE_MODEL (gobject);
+
+  if (model->controller != NULL)
+    {
+      g_object_unref (model->controller);
+      model->controller = NULL;
+    }
+
+  G_OBJECT_CLASS (my_simple_model_parent_class)->dispose (gobject);
+}
+
+static void
+my_simple_model_class_init (MySimpleModelClass *klass)
+{
+  GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
+
+  gobject_class->dispose = my_simple_model_dispose;
+}
+
+static void
+my_simple_model_init (MySimpleModel *model)
+{
+  GPtrArray *array = g_ptr_array_new_with_free_func (g_free);
+
+  model->controller = g_ptr_array_controller_new (array);
+  g_ptr_array_unref (array);
+
+  model->array = array;
+}
+
+MySimpleModel *
+my_simple_model_new (void)
+{
+  return g_object_new (MY_TYPE_SIMPLE_MODEL, NULL);
+}
+
+void
+my_simple_model_add_text (MySimpleModel *model,
+                          const gchar   *text)
+{
+  GControllerReference *ref;
+
+  g_return_if_fail (MY_IS_SIMPLE_MODEL (model));
+  g_return_if_fail (text != NULL && text[0] != '\0');
+
+  g_ptr_array_add (model->array, g_strdup (text));
+
+  ref = g_controller_create_reference (model->controller, G_CONTROLLER_ADD,
+                                       G_TYPE_UINT, 1,
+                                       model->array->len - 1);
+  g_controller_emit_changed (model->controller, ref);
+  g_object_unref (ref);
+}
+
+void
+my_simple_model_remove_text (MySimpleModel *model,
+                             const gchar   *text)
+{
+  GControllerReference *ref;
+  gint i, pos;
+
+  g_return_if_fail (MY_IS_SIMPLE_MODEL (model));
+  g_return_if_fail (text != NULL && text[0] != '\0');
+
+  pos = -1;
+  for (i = 0; i < model->array->len; i++)
+    {
+      if (strcmp (g_ptr_array_index (model->array, i), text) == 0)
+        {
+          pos = i;
+          break;
+        }
+    }
+
+  if (pos == -1)
+    return;
+
+  ref = g_controller_create_reference (model->controller, G_CONTROLLER_REMOVE,
+                                       G_TYPE_UINT, 1,
+                                       pos);
+  g_controller_emit_changed (model->controller, ref);
+  g_object_unref (model->controller);
+
+  g_ptr_array_remove_index (model->array, pos);
+}
+
+G_CONST_RETURN gchar *
+my_simple_model_get_text (MySimpleModel *model,
+                          gint           pos)
+{
+  g_return_val_if_fail (MY_IS_SIMPLE_MODEL (model), NULL);
+
+  return g_ptr_array_index (model->array, pos);
+}
+
+G_CONST_RETURN gchar **
+my_simple_model_get_items (MySimpleModel *model)
+{
+  g_return_val_if_fail (MY_IS_SIMPLE_MODEL (model), NULL);
+
+  return (const gchar **) model->array->pdata;
+}
+
+void
+my_simple_model_set_items (MySimpleModel       *model,
+                           gint                 n_strings,
+                           const gchar * const  text[])
+{
+  GControllerReference *ref;
+  GPtrArray *array;
+  gint i;
+
+  g_return_if_fail (MY_IS_SIMPLE_MODEL (model));
+
+  array = g_ptr_array_sized_new (n_strings);
+  for (i = 0; n_strings; i++)
+    g_ptr_array_add (array, g_strdup (text[i]));
+
+  g_ptr_array_controller_set_array (G_PTR_ARRAY_CONTROLLER (model->controller), array);
+
+  ref = g_controller_create_reference (model->controller, G_CONTROLLER_REPLACE,
+                                       G_TYPE_UINT, 0);
+  g_controller_emit_changed (model->controller, ref);
+  g_object_unref (ref);
+}
+
+void
+my_simple_model_clear (MySimpleModel *model)
+{
+  GControllerReference *ref;
+  GPtrArray *array;
+
+  g_return_if_fail (MY_IS_SIMPLE_MODEL (model));
+
+  array = g_ptr_array_new ();
+  g_ptr_array_controller_set_array (G_PTR_ARRAY_CONTROLLER (model->controller), array);
+
+  ref = g_controller_create_reference (model->controller, G_CONTROLLER_CLEAR,
+                                       G_TYPE_UINT, 0);
+  g_controller_emit_changed (model->controller, ref);
+  g_object_unref (ref);
+}
+
+gint
+my_simple_model_get_size (MySimpleModel *model)
+{
+  g_return_val_if_fail (MY_IS_SIMPLE_MODEL (model), 0);
+
+  return model->array->len;
+}
+
+GController *
+my_simple_model_get_controller (MySimpleModel *model)
+{
+  g_return_val_if_fail (MY_IS_SIMPLE_MODEL (model), NULL);
+
+  return model->controller;
+}
+
+/* user */
+
+static void
+on_model_changed (GController *controller,
+                  GControllerAction action,
+                  GControllerReference *ref,
+                  MySimpleModel *model)
+{
+  gint i, n_indices;
+
+  n_indices = g_controller_reference_get_n_indices (ref);
+
+  switch (action)
+    {
+    case G_CONTROLLER_ADD:
+      for (i = 0; i < n_indices; i++)
+        {
+          gint idx = g_controller_reference_get_index_uint (ref, i);
+          const gchar *text;
+
+          text = my_simple_model_get_text (model, idx);
+          g_assert (text != NULL);
+
+          g_print ("*** Added '%s' (at index '%d') ***\n", text, idx);
+        }
+      break;
+
+    case G_CONTROLLER_REMOVE:
+      for (i = 0; i < n_indices; i++)
+        {
+          gint idx = g_controller_reference_get_index_uint (ref, i);
+          const gchar *text;
+
+          text = my_simple_model_get_text (model, idx);
+          g_assert (text != NULL);
+
+          g_print ("*** Removed '%s' (at index '%d') ***\n", text, idx);
+        }
+      break;
+
+    case G_CONTROLLER_CLEAR:
+      g_print ("*** Model cleared ***\n");
+      break;
+
+    default:
+      break;
+    }
+}
+
+int
+main (int argc, char *argv[])
+{
+  MySimpleModel *model;
+  const gchar **items;
+  gint n_items, i;
+
+  g_type_init ();
+
+  model = my_simple_model_new ();
+  g_signal_connect (my_simple_model_get_controller (model),
+                    "changed",
+                    G_CALLBACK (on_model_changed),
+                    model);
+
+  my_simple_model_add_text (model, "foo");
+  my_simple_model_add_text (model, "bar");
+  my_simple_model_add_text (model, "baz");
+
+  items = my_simple_model_get_items (model);
+  n_items = my_simple_model_get_size (model);
+
+  g_print ("Model contents:\n");
+  for (i = 0; i < n_items; i++)
+    g_print ("\trow[%d] = '%s'\n", i, items[i]);
+
+  my_simple_model_remove_text (model, "baz");
+
+  items = my_simple_model_get_items (model);
+  n_items = my_simple_model_get_size (model);
+
+  g_print ("Model contents:\n");
+  for (i = 0; i < n_items; i++)
+    g_print ("\trow[%d] = '%s'\n", i, items[i]);
+
+  my_simple_model_clear (model);
+
+  g_object_unref (model);
+
+  return EXIT_SUCCESS;
+}