Merge lp:~mhr3/dee/introspectable-sort-methods into lp:dee

[Michal Hruby]

Make the *sorted methods usable with introspection

Dee's find_sorted and insert_sorted were not usable from introspectable languages.

Added a delegate that's introspection friendly and tests that make sure it's working.

[Paweł Stołowski (stolowski)]

Looks, good. Just one question:
30 + # FIXME: perhaps override __eq__ on ModelIter?
is this still applicable?

review: Needs Information

[lp:~mhr3/dee/introspectable-sort-methods]

376. By Michal Hruby on 2012-08-15

Remove fixed FIXME

[Michal Hruby (mhr3)]

> Looks, good. Just one question:
> 30 + # FIXME: perhaps override __eq__ on ModelIter?
> is this still applicable?

Right, already fixed.

[Paweł Stołowski (stolowski)]

Looks good, tests pass.

review: Approve

=== modified file 'bindings/python/Dee.py'
--- bindings/python/Dee.py	2012-06-27 15:36:53 +0000
+++ bindings/python/Dee.py	2012-08-15 13:38:19 +0000
@@ -63,14 +63,20 @@
     def insert_before (self, iter, *args):
         return self.insert_row_before (iter, self._build_row(args))
     
+    def insert_row_sorted (self, row_spec, sort_func, data):
+    	return self.insert_row_sorted_with_sizes (row_spec, sort_func, data)
+
     def insert_sorted (self, sort_func, *args):
     	return self.insert_row_sorted (self._build_row(args), sort_func, None)
    
+    def find_row_sorted (self, row_spec, sort_func, data):
+    	return self.find_row_sorted_with_sizes (row_spec, sort_func, data)
+    
     def find_sorted (self, sort_func, *args):
     	return self.find_row_sorted (self._build_row(args), sort_func, None)
     
     def get_schema (self):
-        return Dee.Model.get_schema(self)[0]
+        return Dee.Model.get_schema(self)
     
     def get_value (self, itr, column):
         return Dee.Model.get_value (self, itr, column).unpack()
@@ -108,8 +114,21 @@
         return self.get_n_rows()
         
         
+class ModelIter(Dee.ModelIter):
+
+    def __init__(self):
+        Dee.ModelIter.__init__(self)
+
+    def __eq__ (self, other):
+        if not isinstance (other, ModelIter):
+            return False
+        return repr(self) == repr(other)
+
+
 
 Model = override(Model)
 __all__.append('Model')
+ModelIter = override(ModelIter)
+__all__.append('ModelIter')
 
 
 
=== modified file 'src/dee-model.c'
--- src/dee-model.c	2012-02-28 00:36:16 +0000
+++ src/dee-model.c	2012-08-15 13:38:19 +0000
@@ -975,6 +975,20 @@
   return (* iface->insert_row_before) (self, iter, row_members);
 }
 
+/* Translates DeeCompareRowFunc callback into DeeCompareRowSizedFunc */
+static gint
+dee_model_cmp_func_translate_func (GVariant **row1,
+                                   GVariant **row2,
+                                   gpointer data)
+{
+  gpointer *all_data = (gpointer*) data;
+  DeeCompareRowSizedFunc cmp_func = (DeeCompareRowSizedFunc) all_data[0];
+  gpointer user_data = all_data[1];
+  guint array_length = GPOINTER_TO_UINT (all_data[2]);
+
+  return cmp_func (row1, array_length, row2, array_length, user_data);
+}
+
 /**
  * dee_model_insert_row_sorted:
  * @self: The model to do a sorted insert on
@@ -1009,6 +1023,41 @@
 }
 
 /**
+ * dee_model_insert_row_sorted_with_sizes:
+ * @self: The model to do a sorted insert on
+ * @row_members: (array zero-terminated=1): An array of
+ *       #GVariants with type signature matching those of the
+ *       column schemas of @self. If any of the variants have floating
+ *       references they will be consumed.
+ * @cmp_func: (scope call): Callback used for comparison or rows
+ * @user_data: (closure): Arbitrary pointer passed to @cmp_func during search
+ *
+ * Inserts a row in @self according to the sorting specified by @cmp_func.
+ * If you use this method for insertion you should not use other methods as this
+ * method assumes the model to be already sorted by @cmp_func.
+ *
+ * Returns: (transfer none) (type Dee.ModelIter): A #DeeModelIter pointing to the new row
+ */
+DeeModelIter*
+dee_model_insert_row_sorted_with_sizes (DeeModel               *self,
+                                        GVariant              **row_members,
+                                        DeeCompareRowSizedFunc  cmp_func,
+                                        gpointer                user_data)
+{
+  gpointer all_data[3];
+
+  g_return_val_if_fail (DEE_IS_MODEL (self), NULL);
+
+  all_data[0] = cmp_func;
+  all_data[1] = user_data;
+  all_data[2] = GUINT_TO_POINTER (dee_model_get_n_columns (self));
+
+  return dee_model_insert_row_sorted (self, row_members,
+                                      dee_model_cmp_func_translate_func,
+                                      all_data);
+}
+
+/**
  * dee_model_insert_sorted:
  * @self: The model to do a sorted insert on
  * @cmp_func: (scope call): Callback used for comparison or rows
@@ -1103,6 +1152,55 @@
 }
 
 /**
+ * dee_model_find_row_sorted_with_sizes:
+ * @self: The model to search
+ * @row_spec: (array zero-terminated=1): An array of
+ *       #GVariants with type signature matching those of the
+ *       column schemas of @self. No references will be taken on the variants.
+ * @cmp_func: (scope call): Callback used for comparison or rows
+ * @user_data: (closure): Arbitrary pointer passed to @cmp_func during search
+ * @out_was_found: (out): A place to store a boolean value that will be set when
+ *                 this method returns. If %TRUE then an exact match was found.
+ *                 If %FALSE then the returned iter points to a row just after
+ *                 where @row_spec would have been inserted.
+ *                 Pass %NULL to ignore.
+ *
+ * Like dee_model_find_row_sorted(), but uses DeeCompareRowSizedFunc and
+ * therefore doesn't cause trouble when used from introspected languages.
+ *
+ * Finds a row in @self according to the sorting specified by @cmp_func.
+ * This method will assume that @self is already sorted by @cmp_func.
+ *
+ * If you use this method for searching you should only use
+ * dee_model_insert_row_sorted() (or dee_model_insert_row_sorted_with_sizes())
+ * to insert rows in the model.
+ *
+ * Returns: (transfer none) (type Dee.ModelIter): If @out_was_found is set to
+ *           %TRUE then a #DeeModelIter pointing to the first matching row.
+ *           If it is %FALSE then the iter pointing to the row just after where
+ *           @row_spec_would have been inserted.
+ */
+DeeModelIter*
+dee_model_find_row_sorted_with_sizes (DeeModel                *self,
+                                      GVariant               **row_spec,
+                                      DeeCompareRowSizedFunc   cmp_func,
+                                      gpointer                 user_data,
+                                      gboolean                *out_was_found)
+{
+  gpointer all_data[3];
+
+  g_return_val_if_fail (DEE_IS_MODEL (self), NULL);
+
+  all_data[0] = cmp_func;
+  all_data[1] = user_data;
+  all_data[2] = GUINT_TO_POINTER (dee_model_get_n_columns (self));
+
+  return dee_model_find_row_sorted (self, row_spec,
+                                    dee_model_cmp_func_translate_func,
+                                    all_data, out_was_found);
+}
+
+/**
  * dee_model_find_sorted:
  * @self: The model to search
  * @cmp_func: (scope call): Callback used for comparison or rows
 
=== modified file 'src/dee-model.h'
--- src/dee-model.h	2012-03-19 11:18:50 +0000
+++ src/dee-model.h	2012-08-15 13:38:19 +0000
@@ -78,6 +78,27 @@
                                             GVariant** row2,
                                             gpointer user_data);
 
+/**
+ * DeeCompareRowSizedFunc:
+ * @row1: (array length=row1_length): Row data
+ * @row1_length: The number of elements in row1 array
+ * @row2: (array length=row2_length): Row data to compare with
+ * @row2_length: The number of elements in row2 array
+ * @user_data: (closure): User data passed to comparison function
+ *
+ * Compares @row1 and @row2. Mainly used with 
+ * dee_model_insert_row_sorted_with_sizes() and
+ * dee_model_find_row_sorted_with_sizes().
+ *
+ * Returns: -1, 0, or 1 if @row1 is respectively less than, equal, or greater
+ * than @row2.
+ */
+typedef gint          (*DeeCompareRowSizedFunc) (GVariant** row1,
+                                                 guint row1_length,
+                                                 GVariant** row2,
+                                                 guint row2_length,
+                                                 gpointer user_data);
+
 struct _DeeModelIface
 {
   GTypeInterface g_iface;
@@ -291,6 +312,11 @@
                                              DeeCompareRowFunc   cmp_func,
                                              gpointer            user_data);
 
+DeeModelIter*   dee_model_insert_row_sorted_with_sizes (DeeModel              *self,
+                                                        GVariant             **row_members,
+                                                        DeeCompareRowSizedFunc cmp_func,
+                                                        gpointer               user_data);
+
 DeeModelIter*   dee_model_insert_sorted (DeeModel           *self,
                                          DeeCompareRowFunc   cmp_func,
                                          gpointer            user_data,
@@ -302,11 +328,17 @@
                                              gpointer            user_data,
                                              gboolean           *out_was_found);
 
-DeeModelIter*  dee_model_find_sorted    (DeeModel           *self,
-                                         DeeCompareRowFunc   cmp_func,
-                                         gpointer            user_data,
-                                         gboolean           *out_was_found,
-                                         ...);
+DeeModelIter*  dee_model_find_row_sorted_with_sizes (DeeModel               *self,
+                                                     GVariant             **row_spec,
+                                                     DeeCompareRowSizedFunc cmp_func,
+                                                     gpointer               user_data,
+                                                     gboolean               *out_was_found);
+
+DeeModelIter*   dee_model_find_sorted    (DeeModel           *self,
+                                          DeeCompareRowFunc   cmp_func,
+                                          gpointer            user_data,
+                                          gboolean           *out_was_found,
+                                          ...);
 
 void            dee_model_remove          (DeeModel     *self,
                                            DeeModelIter *iter);
 
=== modified file 'tests/test-model-rows.c'
--- tests/test-model-rows.c	2012-01-26 19:08:42 +0000
+++ tests/test-model-rows.c	2012-08-15 13:38:19 +0000
@@ -47,6 +47,7 @@
 static void test_iter_backwards  (RowsFixture *fix, gconstpointer data);
 static void test_illegal_access  (RowsFixture *fix, gconstpointer data);
 static void test_sorted          (RowsFixture *fix, gconstpointer data);
+static void test_sorted_with_sizes (RowsFixture *fix, gconstpointer data);
 
 static void test_model_iter_copy (RowsFixture *fix, gconstpointer data);
 static void test_model_iter_free (RowsFixture *fix, gconstpointer data);
@@ -133,6 +134,13 @@
               proxy_rows_setup, test_sorted, proxy_rows_teardown);
   g_test_add (TXN_DOMAIN"/Sorted", RowsFixture, 0,
               txn_rows_setup, test_sorted, txn_rows_teardown);
+
+  g_test_add (SEQ_DOMAIN"/Sorted/WithSizes", RowsFixture, 0,
+              seq_rows_setup, test_sorted_with_sizes, seq_rows_teardown);
+  g_test_add (PROXY_DOMAIN"/Sorted/WithSizes", RowsFixture, 0,
+              proxy_rows_setup, test_sorted_with_sizes, proxy_rows_teardown);
+  g_test_add (TXN_DOMAIN"/Sorted/WithSizes", RowsFixture, 0,
+              txn_rows_setup, test_sorted_with_sizes, txn_rows_teardown);
 }
 
 static void
@@ -560,3 +568,125 @@
   g_assert (was_found);
   g_assert (result == hter);
 }
+
+static gint
+sized_cmp_col_0 (GVariant **row1, guint row1_length,
+                 GVariant **row2, guint row2_length, gpointer user_data)
+{
+  g_assert_cmpstr (user_data, ==, "test-user-data");
+  g_assert_cmpuint (row1_length, ==, 2);
+  g_assert_cmpuint (row2_length, ==, 2);
+  g_assert_cmpuint (row1_length, ==, row2_length);
+  return g_variant_get_int32 (row2[0]) - g_variant_get_int32 (row1[0]);
+}
+
+static void
+test_sorted_with_sizes (RowsFixture *fix, gconstpointer data)
+{
+  DeeModelIter *hter, *iter, *jter, *kter;
+  gboolean      was_found;
+  GVariant     *row_spec[2];
+
+  /* FINAL MODEL: [(28,s), (27,s), (26,s), (25,s)]
+   *           ~= [hter, iter, jter, kter] */
+
+  row_spec[0] = g_variant_new_int32 (0);
+  row_spec[1] = g_variant_new_string ("");
+  /* Test find() with an empty model. With NULL was_found arg */
+  iter = dee_model_find_row_sorted_with_sizes (fix->model, row_spec,
+                                               sized_cmp_col_0,
+                                               "test-user-data",
+                                               NULL);
+  g_assert (iter == dee_model_get_last_iter (fix->model));
+
+  /* Test find() with an empty model. With non-NULL was_found arg */
+  was_found = TRUE;
+  iter = dee_model_find_row_sorted_with_sizes (fix->model, row_spec,
+                                               sized_cmp_col_0,
+                                               "test-user-data",
+                                               &was_found);
+  g_assert (!was_found);
+  g_assert (iter == dee_model_get_last_iter (fix->model));
+
+  /* Insert the first row */
+  row_spec[0] = g_variant_new_int32 (27);
+  row_spec[1] = g_variant_new_string ("Sorta sorted");
+  iter = dee_model_insert_row_sorted_with_sizes (fix->model, row_spec,
+                                                 sized_cmp_col_0,
+                                                 "test-user-data");
+  g_assert (iter != dee_model_get_last_iter (fix->model));
+  g_assert (iter == dee_model_get_first_iter (fix->model));
+
+  /* Test append */
+  row_spec[0] = g_variant_new_int32 (25);
+  row_spec[1] = g_variant_new_string ("Sorta sorted");
+  kter = dee_model_insert_row_sorted_with_sizes (fix->model, row_spec,
+                                                 sized_cmp_col_0,
+                                                 "test-user-data");
+  g_assert (kter != dee_model_get_last_iter (fix->model));
+  g_assert (kter != dee_model_get_first_iter (fix->model));
+  g_assert (iter == dee_model_get_first_iter (fix->model));
+  g_assert (kter != iter);
+
+  g_assert_cmpint (2, ==, dee_model_get_n_rows (fix->model));
+  g_assert (kter == dee_model_next (fix->model, iter));
+
+  /* Test insert in between rows */
+  row_spec[0] = g_variant_new_int32 (26);
+  row_spec[1] = g_variant_new_string ("Sorta sorted");
+  jter = dee_model_insert_row_sorted_with_sizes (fix->model, row_spec,
+                                                 sized_cmp_col_0,
+                                                 "test-user-data");
+  g_assert (jter != dee_model_get_last_iter (fix->model));
+  g_assert (jter != dee_model_get_first_iter (fix->model));
+  g_assert (iter == dee_model_get_first_iter (fix->model));
+  g_assert (jter != iter);
+  g_assert (jter != kter);
+
+  g_assert (jter == dee_model_next (fix->model, iter));
+  g_assert (kter == dee_model_next (fix->model, jter));
+  g_assert (dee_model_get_last_iter (fix->model) == dee_model_next (fix->model, kter));
+
+  /* Test prepend */
+  row_spec[0] = g_variant_new_int32 (28);
+  row_spec[1] = g_variant_new_string ("Sorta sorted");
+  hter = dee_model_insert_row_sorted_with_sizes (fix->model, row_spec,
+                                                 sized_cmp_col_0,
+                                                 "test-user-data");
+  g_assert (hter == dee_model_get_first_iter (fix->model));
+  g_assert (iter == dee_model_next (fix->model, hter));
+
+  g_assert_cmpint (4, ==, dee_model_get_n_rows (fix->model));
+
+  /* Test find() again now that we have data in the model */
+  DeeModelIter *result;
+  row_spec[0] = g_variant_new_int32 (24);
+  row_spec[1] = g_variant_new_string ("");
+  result = dee_model_find_row_sorted_with_sizes (fix->model, row_spec,
+                                                 sized_cmp_col_0,
+                                                 "test-user-data", NULL);
+  g_assert (result == dee_model_get_last_iter (fix->model));
+  row_spec[0] = g_variant_new_int32 (28);
+  row_spec[1] = g_variant_new_string ("");
+  result = dee_model_find_row_sorted_with_sizes (fix->model, row_spec,
+                                                 sized_cmp_col_0,
+                                                 "test-user-data", NULL);
+  g_assert (result == hter);
+
+  /* Test find(). With non-NULL was_found arg */
+  was_found = FALSE;
+  row_spec[0] = g_variant_new_int32 (24);
+  row_spec[1] = g_variant_new_string ("");
+  result = dee_model_find_row_sorted_with_sizes (fix->model, row_spec,
+                                                 sized_cmp_col_0,
+                                                 "test-user-data", &was_found);
+  g_assert (result == dee_model_get_last_iter (fix->model));
+  row_spec[0] = g_variant_new_int32 (28);
+  row_spec[1] = g_variant_new_string ("");
+  result = dee_model_find_row_sorted_with_sizes (fix->model, row_spec,
+                                                 sized_cmp_col_0,
+                                                 "test-user-data", &was_found);
+  g_assert (was_found);
+  g_assert (result == hter);
+}
+
 
=== modified file 'vapi/dee-1.0.vapi'
--- vapi/dee-1.0.vapi	2012-03-19 11:18:50 +0000
+++ vapi/dee-1.0.vapi	2012-08-15 13:38:19 +0000
@@ -208,6 +208,7 @@
 		public abstract unowned Dee.ModelIter append_row ([CCode (array_length = false, array_null_terminated = true)] GLib.Variant[] row_members);
 		public abstract void clear ();
 		public abstract unowned Dee.ModelIter find_row_sorted ([CCode (array_length = false, array_null_terminated = true)] GLib.Variant[] row_spec, [CCode (delegate_target_pos = 2.5)] Dee.CompareRowFunc cmp_func, out bool out_was_found);
+		public unowned Dee.ModelIter find_row_sorted_with_sizes ([CCode (array_length = false, array_null_terminated = true)] GLib.Variant[] row_spec, [CCode (delegate_target_pos = 2.5)] Dee.CompareRowSizedFunc cmp_func, out bool out_was_found);
 		public unowned Dee.ModelIter find_sorted ([CCode (delegate_target_pos = 1.5)] Dee.CompareRowFunc cmp_func, out bool out_was_found, ...);
 		public void @get (Dee.ModelIter iter, ...);
 		public abstract bool get_bool (Dee.ModelIter iter, uint column);
@@ -235,6 +236,7 @@
 		public abstract unowned Dee.ModelIter insert_row (uint pos, [CCode (array_length = false, array_null_terminated = true)] GLib.Variant[] row_members);
 		public abstract unowned Dee.ModelIter insert_row_before (Dee.ModelIter iter, [CCode (array_length = false, array_null_terminated = true)] GLib.Variant[] row_members);
 		public abstract unowned Dee.ModelIter insert_row_sorted ([CCode (array_length = false, array_null_terminated = true)] GLib.Variant[] row_members, Dee.CompareRowFunc cmp_func);
+		public unowned Dee.ModelIter insert_row_sorted_with_sizes ([CCode (array_length = false, array_null_terminated = true)] GLib.Variant[] row_members, Dee.CompareRowSizedFunc cmp_func);
 		public unowned Dee.ModelIter insert_sorted ([CCode (delegate_target_pos = 1.5)] Dee.CompareRowFunc cmp_func, ...);
 		public abstract bool is_first (Dee.ModelIter iter);
 		public abstract bool is_last (Dee.ModelIter iter);
@@ -343,6 +345,8 @@
 	[CCode (cheader_filename = "dee.h", instance_pos = 2.9)]
 	public delegate int CompareRowFunc ([CCode (array_length = false)] GLib.Variant[] row1, [CCode (array_length = false)] GLib.Variant[] row2);
 	[CCode (cheader_filename = "dee.h", instance_pos = 2.9)]
+	public delegate int CompareRowSizedFunc ([CCode (array_length_cname = "row1_length", array_length_pos = 1.5, array_length_type = "guint")] GLib.Variant[] row1, [CCode (array_length_cname = "row2_length", array_length_pos = 2.1, array_length_type = "guint")] GLib.Variant[] row2);
+	[CCode (cheader_filename = "dee.h", instance_pos = 2.9)]
 	public delegate void FilterMapFunc (Dee.Model orig_model, Dee.FilterModel filter_model);
 	[CCode (cheader_filename = "dee.h", instance_pos = 3.9)]
 	public delegate bool FilterMapNotify (Dee.Model orig_model, Dee.ModelIter orig_iter, Dee.FilterModel filter_model);