Merge lp:~mhr3/dee/floating-and-sinking into lp:dee

[Michal Hruby]

Since dee_serializable_serialize is a virtual method, it has to return a non-floating reference to make sure it works in all cases without memory leaks.

[Mikkel Kamstrup Erlandsen (kamstrup)]

Agreed with the analysis in bug #916783. Let's get this in.

review: Approve

=== modified file 'src/dee-serializable.c'
--- src/dee-serializable.c	2011-11-30 10:24:47 +0000
+++ src/dee-serializable.c	2012-01-16 08:22:24 +0000
@@ -379,6 +379,8 @@
 
   g_variant_builder_add_value (&b, g_variant_new_variant (payload));
 
+  g_variant_unref (payload);
+
   return g_variant_builder_end (&b);
 }
 
@@ -391,18 +393,25 @@
  * You can recreate a serialized instance by calling dee_serializable_parse()
  * provided that you know the correct #GType for the serialized instance.
  *
- * Return value: A floating reference to a #GVariant with the serialized data.
- *               The variants type signature is entirely dependent of the
- *               underlying implementation.
+ * Return value: (transfer full): A reference to a #GVariant with
+ *               the serialized data. The variants type signature is entirely
+ *               dependent of the underlying implementation. Free using
+ *               g_variant_unref().
  */
 GVariant*
 dee_serializable_serialize (DeeSerializable *self)
 {
   DeeSerializableIface *iface;
+  GVariant *result;
 
   g_return_val_if_fail (DEE_IS_SERIALIZABLE (self), NULL);
 
   iface = DEE_SERIALIZABLE_GET_IFACE (self);
 
-  return (* iface->serialize) (self);
+  result = iface->serialize (self);
+  /* Make sure we return a real reference
+   * FIXME: just use g_variant_take_ref once we depend on glib 2.30 */
+  if (g_variant_is_floating (result)) return g_variant_ref_sink (result);
+
+  return result;
 }

=== modified file 'vapi/Dee-1.0-custom.vala'
--- vapi/Dee-1.0-custom.vala	2012-01-04 08:32:53 +0000
+++ vapi/Dee-1.0-custom.vala	2012-01-16 08:22:24 +0000
@@ -23,10 +23,17 @@
 		public void clear (Dee.Model model, Dee.ModelIter iter);
 	}
 
+	[CCode (type_id = "dee_result_set_get_type ()")]
 	public interface ResultSet {
 		[CCode (cname = "_vala_dee_result_set_iterator")]
 		public Dee.ResultSet iterator ();
 		[CCode (cname = "_vala_dee_result_set_next_value")]
 		public unowned Dee.ModelIter? next_value ();
 	}
+
+	[CCode (type_id = "dee_serializable_get_type ()")]
+	public interface Serializable : GLib.Object {
+		[CCode (returns_floating_reference = true)]
+		public GLib.Variant externalize ();
+	}
 }

=== modified file 'vapi/Dee-1.0.metadata'
--- vapi/Dee-1.0.metadata	2012-01-09 17:07:37 +0000
+++ vapi/Dee-1.0.metadata	2012-01-16 08:22:24 +0000
@@ -22,6 +22,7 @@
 SerializableParseFunc skip=false
 Serializable
 	.register_parser skip=false
+	.externalize skip // we need floating annotation here, see -custom
 
 SerializableModel
 	.get_seqnum virtual

=== modified file 'vapi/dee-1.0.vapi'
--- vapi/dee-1.0.vapi	2012-01-09 17:07:37 +0000
+++ vapi/dee-1.0.vapi	2012-01-16 08:22:24 +0000
@@ -239,7 +239,7 @@
 		public abstract GLib.Object load (string resource_name) throws GLib.Error;
 		public abstract bool store (Dee.Serializable resource, string resource_name) throws GLib.Error;
 	}
-	[CCode (cheader_filename = "dee.h")]
+	[CCode (cheader_filename = "dee.h", type_id = "dee_result_set_get_type ()")]
 	public interface ResultSet : GLib.Object {
 		public abstract unowned Dee.Model get_model ();
 		public abstract uint get_n_rows ();
@@ -255,6 +255,7 @@
 	}
 	[CCode (cheader_filename = "dee.h", type_id = "dee_serializable_get_type ()")]
 	public interface Serializable : GLib.Object {
+		[CCode (returns_floating_reference = true)]
 		public GLib.Variant externalize ();
 		public static GLib.Object parse (GLib.Variant data, GLib.Type type);
 		public static GLib.Object parse_external (GLib.Variant data);
@@ -279,7 +280,7 @@
 		public static Dee.Filter new_sort (owned Dee.CompareRowFunc cmp_row);
 		public bool notify (Dee.ModelIter orig_iter, Dee.Model orig_model, Dee.FilterModel filter_model);
 	}
-	[CCode (cheader_filename = "dee.h")]
+	[CCode (cheader_filename = "dee.h", has_type_id = false)]
 	public struct ModelReader {
 		public weak Dee.ModelReaderFunc reader_func;
 		public void* userdata;