Merge lp:~mhr3/libzeitgeist/various-fixes into lp:libzeitgeist

[Michal Hruby]

More binding related fixes.

[Mikkel Kamstrup Erlandsen (kamstrup)]

Looks good I think. Could you elaborate a bit on what the intention of these fixes are?

Also; the primary goal seems to be adding the ZeitgeistMonitor API, but why do you need the EggZeitgeistMonitor? It's not an exported symbol of the lib (just an impl detail)...

review: Needs Information

[Michal Hruby (mhr3)]

Yes, primary goal is addition of ZeitgeistMonitor, other than that there are fixes so now all ZeitgeistLog methods should be usable (and leak-free) in Vala.

As for EggZeitgeistMonitor, I had to define it, cause the introspection finds that ZeitgeistMonitor implements it and without the dummy definition it's not possible to generate the vapi, still it's defined as empty interface - so also just an impl detail.

The only issue is that the vapi was generated using git vapigen and the insert_events_from_ptrarray method will only work with git Vala, but once 0.8.2 is released, it will be fine.

[Mikkel Kamstrup Erlandsen (kamstrup)]

One more thing before I merge. How about changing the signature of Log.insert_events_from_ptrarray() from your new:

 zeitgeist_log_insert_events_from_ptrarray (ZeitgeistLog *self,
                                            GCancellable *cancellable,
                                            GPtrArray *events,
                                            GAsyncReadyCallback callback,
                                            gpointer user_data);

to:

 zeitgeist_log_insert_events_from_ptrarray (ZeitgeistLog *self,
                                            GPtrArray *events,
                                            GCancellable *cancellable,
                                            GAsyncReadyCallback callback,
                                            gpointer user_data);

Ie. making 'events' the second arg. That way the signature is consistent with how GIO does it. See fx. g_output_stream_write_async().

Sorry for the fuzz! :-)

review: Needs Fixing

[lp:~mhr3/libzeitgeist/various-fixes]

107. By Mikkel Kamstrup Erlandsen <kamstrup@hardback> on 2010-04-29

Add zeitgeist-1.0.types to doc generation. This makes gtk-doc include properties and signals for the classes

108. By Mikkel Kamstrup Erlandsen <kamstrup@hardback> on 2010-04-29

Fix ref to egg_zeitgeist_storage_state_get_type in docs. Should be zeitgeist_storage_state_get_type

[Michal Hruby (mhr3)]

Yep, I missed that, fixed and pushed.

[Mikkel Kamstrup Erlandsen (kamstrup)]

Merged. Thanks a bunch for your hard work!

review: Approve (review and distcheck)

[lp:~mhr3/libzeitgeist/various-fixes]

109. By Mikkel Kamstrup Erlandsen <kamstrup@hardback> on 2010-04-29

Merge Michal Hruby's branch lp:~mhr3/libzeitgeist/various-fixes into trunk. This fixes ZeitgeistMonitor's Vala API and makes the method signature of zeitgeist_log_insert_events_from_ptrarray() be in line with those of GIO async methods.

Also lower EggDBus requirements to 0.5 (from 0.6)

110. By Mikkel Kamstrup Erlandsen <kamstrup@hardback> on 2010-04-29

Improve docs for ZeitgeistMonitor and make the event-templates and time-range properties read-only.

=== modified file 'bindings/zeitgeist-1.0-custom.vala'
--- bindings/zeitgeist-1.0-custom.vala	2010-04-23 06:18:45 +0000
+++ bindings/zeitgeist-1.0-custom.vala	2010-04-29 09:28:31 +0000
@@ -19,6 +19,9 @@
 
 namespace Zeitgeist
 {
+  public interface EggZeitgeistMonitor: GLib.Object
+  {
+  }
   [CCode (cname = "ZEITGEIST_GTIMEVAL_TO_TIMESTAMP")]
   public static int64 timeval_to_timestamp (GLib.TimeVal time_val);
   [CCode (cname = "ZEITGEIST_TIMESTAMP_TO_GTIMEVAL")]

=== modified file 'bindings/zeitgeist-1.0.gi'
--- bindings/zeitgeist-1.0.gi	2010-04-23 09:59:59 +0000
+++ bindings/zeitgeist-1.0.gi	2010-04-29 09:28:31 +0000
@@ -1,39 +1,39 @@
 <?xml version="1.0"?>
 <api version="1.0">
 	<namespace name="Zeitgeist">
-		<struct name="ZeitgeistMonitor">
-			<method name="get_path" symbol="zeitgeist_monitor_get_path">
-				<return-type type="gchar*"/>
-				<parameters>
-					<parameter name="self" type="ZeitgeistMonitor*"/>
-				</parameters>
-			</method>
-			<method name="get_templates" symbol="zeitgeist_monitor_get_templates">
-				<return-type type="GPtrArray*"/>
-				<parameters>
-					<parameter name="self" type="ZeitgeistMonitor*"/>
-				</parameters>
-			</method>
-			<method name="get_time_range" symbol="zeitgeist_monitor_get_time_range">
-				<return-type type="ZeitgeistTimeRange*"/>
-				<parameters>
-					<parameter name="self" type="ZeitgeistMonitor*"/>
-				</parameters>
-			</method>
-			<method name="new" symbol="zeitgeist_monitor_new">
-				<return-type type="ZeitgeistMonitor*"/>
-				<parameters>
-					<parameter name="time_range" type="ZeitgeistTimeRange*"/>
-					<parameter name="event_templates" type="GPtrArray*"/>
-				</parameters>
-			</method>
-			<field name="parent_instance" type="GObject"/>
-		</struct>
-		<struct name="ZeitgeistMonitorClass">
-			<field name="parent_class" type="GObjectClass"/>
-			<field name="events_inserted" type="GCallback"/>
-			<field name="events_deleted" type="GCallback"/>
-		</struct>
+		<function name="interpretation_for_mimetype" symbol="zeitgeist_interpretation_for_mimetype">
+			<return-type type="gchar*"/>
+			<parameters>
+				<parameter name="mimetype" type="gchar*"/>
+			</parameters>
+		</function>
+		<function name="manifestation_for_uri" symbol="zeitgeist_manifestation_for_uri">
+			<return-type type="gchar*"/>
+			<parameters>
+				<parameter name="uri" type="gchar*"/>
+			</parameters>
+		</function>
+		<function name="register_mimetype" symbol="zeitgeist_register_mimetype">
+			<return-type type="void"/>
+			<parameters>
+				<parameter name="mimetype" type="gchar*"/>
+				<parameter name="interpretation_uri" type="gchar*"/>
+			</parameters>
+		</function>
+		<function name="register_mimetype_regex" symbol="zeitgeist_register_mimetype_regex">
+			<return-type type="void"/>
+			<parameters>
+				<parameter name="mimetype_regex" type="gchar*"/>
+				<parameter name="interpretation_uri" type="gchar*"/>
+			</parameters>
+		</function>
+		<function name="register_uri_scheme" symbol="zeitgeist_register_uri_scheme">
+			<return-type type="void"/>
+			<parameters>
+				<parameter name="uri_scheme" type="gchar*"/>
+				<parameter name="manifestation_type" type="gchar*"/>
+			</parameters>
+		</function>
 		<enum name="ZeitgeistResultType" type-name="ZeitgeistResultType" get-type="zeitgeist_result_type_get_type">
 			<member name="ZEITGEIST_RESULT_TYPE_MOST_RECENT_EVENTS" value="0"/>
 			<member name="ZEITGEIST_RESULT_TYPE_LEAST_RECENT_EVENTS" value="1"/>
@@ -320,10 +320,10 @@
 				<return-type type="void"/>
 				<parameters>
 					<parameter name="self" type="ZeitgeistLog*"/>
+					<parameter name="events" type="GPtrArray*"/>
 					<parameter name="cancellable" type="GCancellable*"/>
 					<parameter name="callback" type="GAsyncReadyCallback"/>
 					<parameter name="user_data" type="gpointer"/>
-					<parameter name="events" type="GPtrArray*"/>
 				</parameters>
 			</method>
 			<method name="insert_events_no_reply" symbol="zeitgeist_log_insert_events_no_reply">
@@ -399,6 +399,54 @@
 				</parameters>
 			</method>
 		</object>
+		<object name="ZeitgeistMonitor" parent="GObject" type-name="ZeitgeistMonitor" get-type="zeitgeist_monitor_get_type">
+			<implements>
+				<interface name="EggZeitgeistMonitor"/>
+			</implements>
+			<method name="get_path" symbol="zeitgeist_monitor_get_path">
+				<return-type type="gchar*"/>
+				<parameters>
+					<parameter name="self" type="ZeitgeistMonitor*"/>
+				</parameters>
+			</method>
+			<method name="get_templates" symbol="zeitgeist_monitor_get_templates">
+				<return-type type="GPtrArray*"/>
+				<parameters>
+					<parameter name="self" type="ZeitgeistMonitor*"/>
+				</parameters>
+			</method>
+			<method name="get_time_range" symbol="zeitgeist_monitor_get_time_range">
+				<return-type type="ZeitgeistTimeRange*"/>
+				<parameters>
+					<parameter name="self" type="ZeitgeistMonitor*"/>
+				</parameters>
+			</method>
+			<constructor name="new" symbol="zeitgeist_monitor_new">
+				<return-type type="ZeitgeistMonitor*"/>
+				<parameters>
+					<parameter name="time_range" type="ZeitgeistTimeRange*"/>
+					<parameter name="event_templates" type="GPtrArray*"/>
+				</parameters>
+			</constructor>
+			<property name="event-templates" type="GPtrArray*" readable="1" writable="1" construct="0" construct-only="1"/>
+			<property name="time-range" type="ZeitgeistTimeRange*" readable="1" writable="1" construct="0" construct-only="1"/>
+			<signal name="events-deleted" when="LAST">
+				<return-type type="void"/>
+				<parameters>
+					<parameter name="self" type="ZeitgeistMonitor*"/>
+					<parameter name="time_range" type="ZeitgeistTimeRange*"/>
+					<parameter name="event_ids" type="GArray*"/>
+				</parameters>
+			</signal>
+			<signal name="events-inserted" when="LAST">
+				<return-type type="void"/>
+				<parameters>
+					<parameter name="self" type="ZeitgeistMonitor*"/>
+					<parameter name="time_range" type="ZeitgeistTimeRange*"/>
+					<parameter name="events" type="GPtrArray*"/>
+				</parameters>
+			</signal>
+		</object>
 		<object name="ZeitgeistSubject" parent="GInitiallyUnowned" type-name="ZeitgeistSubject" get-type="zeitgeist_subject_get_type">
 			<method name="get_interpretation" symbol="zeitgeist_subject_get_interpretation">
 				<return-type type="gchar*"/>

=== modified file 'bindings/zeitgeist-1.0.metadata'
--- bindings/zeitgeist-1.0.metadata	2010-04-23 06:40:26 +0000
+++ bindings/zeitgeist-1.0.metadata	2010-04-29 09:28:31 +0000
@@ -1,8 +1,9 @@
 Zeitgeist cheader_filename="zeitgeist.h"
 zeitgeist_log_new transfer_ownership="1"
 zeitgeist_log_insert_events ellipsis="1" async="1"
-zeitgeist_log_insert_events_from_ptrarray async="1"
+zeitgeist_log_insert_events_from_ptrarray async="1" finish_name="zeitgeist_log_insert_events_finish"
 zeitgeist_log_insert_events_from_ptrarray.events transfer_ownership="1"
+zeitgeist_log_insert_events_valist hidden="1"
 zeitgeist_log_insert_events_no_reply ellipsis="1"
 zeitgeist_log_insert_events_finish transfer_ownership="1"
 zeitgeist_log_find_events async="1"
@@ -17,7 +18,7 @@
 zeitgeist_log_find_related_uris async="1"
 zeitgeist_log_find_related_uris.event_templates transfer_ownership="1"
 zeitgeist_log_find_related_uris.result_event_templates transfer_ownership="1"
-zeitgeist_log_find_related_uris_finish is_array="1" no_array_lengh="1" array_null_terminated="1" transfer_ownership="1"
+zeitgeist_log_find_related_uris_finish is_array="1" no_array_length="1" array_null_terminated="1" transfer_ownership="1"
 zeitgeist_log_delete_events async="1"
 zeitgeist_log_delete_events.event_ids transfer_ownership="1"
 zeitgeist_log_delete_log async="1"
@@ -25,5 +26,6 @@
 zeitgeist_log_install_monitor async="1"
 zeitgeist_log_remove_monitor async="1"
 zeitgeist_event_new_full ellipsis="1"
+zeitgeist_monitor_new.event_templates transfer_ownership="1"
 
 zeitgeist_log_*.cancellable nullable="1"

=== modified file 'bindings/zeitgeist-1.0.vapi'
--- bindings/zeitgeist-1.0.vapi	2010-04-23 09:59:59 +0000
+++ bindings/zeitgeist-1.0.vapi	2010-04-29 09:28:31 +0000
@@ -39,6 +39,7 @@
 		public GLib.Array find_event_ids_finish (GLib.AsyncResult res) throws GLib.Error;
 		public async GLib.PtrArray find_events (Zeitgeist.TimeRange time_range, owned GLib.PtrArray event_templates, Zeitgeist.StorageState storage_state, uint32 num_events, Zeitgeist.ResultType result_type, GLib.Cancellable? cancellable) throws GLib.Error;
 		public GLib.PtrArray find_events_finish (GLib.AsyncResult res) throws GLib.Error;
+		[CCode (array_length = false, array_null_terminated = true)]
 		public async string[] find_related_uris (Zeitgeist.TimeRange time_range, owned GLib.PtrArray event_templates, owned GLib.PtrArray result_event_templates, Zeitgeist.StorageState storage_state, uint32 num_events, Zeitgeist.ResultType result_type, GLib.Cancellable? cancellable) throws GLib.Error;
 		[CCode (array_length = false, array_null_terminated = true)]
 		public string[] find_related_uris_finish (GLib.AsyncResult res) throws GLib.Error;
@@ -46,9 +47,9 @@
 		public GLib.PtrArray get_events_finish (GLib.AsyncResult res) throws GLib.Error;
 		public async GLib.Array insert_events (GLib.Cancellable? cancellable, ...) throws GLib.Error;
 		public GLib.Array insert_events_finish (GLib.AsyncResult res) throws GLib.Error;
-		public async void insert_events_from_ptrarray (GLib.Cancellable? cancellable, owned GLib.PtrArray events);
+		[CCode (finish_name = "zeitgeist_log_insert_events_finish")]
+		public async GLib.Array insert_events_from_ptrarray (owned GLib.PtrArray events, GLib.Cancellable? cancellable) throws GLib.Error;
 		public void insert_events_no_reply (...);
-		public void insert_events_valist (GLib.Cancellable? cancellable, GLib.AsyncReadyCallback callback, void* events);
 		public async bool install_monitor (Zeitgeist.Monitor monitor, GLib.Cancellable? cancellable) throws GLib.Error;
 		public bool install_monitor_finish (GLib.AsyncResult res) throws GLib.Error;
 		public async bool quit (GLib.Cancellable? cancellable) throws GLib.Error;
@@ -56,22 +57,18 @@
 		public async bool remove_monitor (Zeitgeist.Monitor monitor, GLib.Cancellable? cancellable) throws GLib.Error;
 		public bool remove_monitor_finish (GLib.AsyncResult res) throws GLib.Error;
 	}
-	[Compact]
 	[CCode (cheader_filename = "zeitgeist.h")]
-	public class Monitor {
-		public weak GLib.Object parent_instance;
+	public class Monitor : GLib.Object, Zeitgeist.EggZeitgeistMonitor {
 		[CCode (has_construct_function = false)]
-		public Monitor (Zeitgeist.TimeRange time_range, GLib.PtrArray event_templates);
+		public Monitor (Zeitgeist.TimeRange time_range, owned GLib.PtrArray event_templates);
 		public unowned string get_path ();
 		public unowned GLib.PtrArray get_templates ();
 		public unowned Zeitgeist.TimeRange get_time_range ();
-	}
-	[Compact]
-	[CCode (cheader_filename = "zeitgeist.h")]
-	public class MonitorClass {
-		public weak GLib.Callback events_deleted;
-		public weak GLib.Callback events_inserted;
-		public weak GLib.ObjectClass parent_class;
+		[NoAccessorMethod]
+		public GLib.PtrArray event_templates { owned get; construct; }
+		public Zeitgeist.TimeRange time_range { get; construct; }
+		public virtual signal void events_deleted (Zeitgeist.TimeRange time_range, GLib.Array event_ids);
+		public virtual signal void events_inserted (Zeitgeist.TimeRange time_range, GLib.PtrArray events);
 	}
 	[CCode (cheader_filename = "zeitgeist.h")]
 	public class Subject : GLib.InitiallyUnowned {
@@ -109,6 +106,9 @@
 		[CCode (has_construct_function = false)]
 		public TimeRange.to_now ();
 	}
+	[CCode (cheader_filename = "zeitgeist.h")]
+	public interface EggZeitgeistMonitor : GLib.Object {
+	}
 	[CCode (cprefix = "ZEITGEIST_RESULT_TYPE_", cheader_filename = "zeitgeist.h")]
 	public enum ResultType {
 		MOST_RECENT_EVENTS,
@@ -284,6 +284,16 @@
 	public const string ZG_USER_ACTIVITY;
 	[CCode (cheader_filename = "zeitgeist.h")]
 	public const string ZG_WORLD_ACTIVITY;
+	[CCode (cheader_filename = "zeitgeist.h")]
+	public static unowned string interpretation_for_mimetype (string mimetype);
+	[CCode (cheader_filename = "zeitgeist.h")]
+	public static unowned string manifestation_for_uri (string uri);
+	[CCode (cheader_filename = "zeitgeist.h")]
+	public static void register_mimetype (string mimetype, string interpretation_uri);
+	[CCode (cheader_filename = "zeitgeist.h")]
+	public static void register_mimetype_regex (string mimetype_regex, string interpretation_uri);
+	[CCode (cheader_filename = "zeitgeist.h")]
+	public static void register_uri_scheme (string uri_scheme, string manifestation_type);
 	[CCode (cname = "ZEITGEIST_TIMESTAMP_TO_GTIMEVAL", cheader_filename = "zeitgeist.h")]
 	public static GLib.TimeVal timestamp_to_timeval (int64 timestamp);
 	[CCode (cname = "ZEITGEIST_GTIMEVAL_TO_TIMESTAMP", cheader_filename = "zeitgeist.h")]

=== modified file 'configure.ac'
--- configure.ac	2010-04-20 07:09:49 +0000
+++ configure.ac	2010-04-29 09:28:31 +0000
@@ -36,7 +36,7 @@
 # Check library deps
 ####################################################################
 GLIB_REQUIRED=2.20
-EGGDBUS_REQUIRED=0.6
+EGGDBUS_REQUIRED=0.5
 
 PKG_CHECK_MODULES(GLIB2, [glib-2.0 >= $GLIB_REQUIRED ])
 PKG_CHECK_MODULES(GOBJECT2, [gobject-2.0 >= $GLIB_REQUIRED ])

=== modified file 'src/zeitgeist-log.c'
--- src/zeitgeist-log.c	2010-04-23 06:35:17 +0000
+++ src/zeitgeist-log.c	2010-04-29 09:28:31 +0000
@@ -428,33 +428,33 @@
   GPtrArray *_events;
 
   _events = _zeitgeist_events_from_valist (events);
-  zeitgeist_log_insert_events_from_ptrarray (self, cancellable,
-                                             callback, user_data, _events);
+  zeitgeist_log_insert_events_from_ptrarray (self, _events, cancellable,
+                                             callback, user_data);
 }
 
 /**
  * zeitgeist_log_insert_events_from_ptrarray:
  * @self: The log logging the events
+ * @events: A #GPtrArray of #ZeitgeistEvent<!-- -->s to insert. This method
+ *          steals the reference to @events and consumes all floating refs
+ *          on the event members. It is assumed that the free_func on @events
+ *          is set to g_object_unref().
  * @cancellable: To cancel the operation or %NULL
  * @callback: #GAsyncReadyCallback to invoke once the logging operation has
  *            completed. Set to %NULL to ignore the result. In this callback
  *            you can invoke zeitgeist_log_insert_events_finish() to collect
  *            the event ids of the inserted events
  * @user_data: Any user data to pass back to @callback
- * @events: A #GPtrArray of #ZeitgeistEvent<!-- -->s to insert. This method
- *          steals the reference to @events and consumes all floating refs
- *          on the event members. It is assumed that the free_func on @events
- *          is set to g_object_unref().
  *
  * Asynchrnously send a set of events to the Zeitgeist daemon, requesting they
  * be inserted into the log.
  */
 void
 zeitgeist_log_insert_events_from_ptrarray (ZeitgeistLog        *self,
+                                           GPtrArray           *events,
                                            GCancellable        *cancellable,
                                            GAsyncReadyCallback  callback,
-                                           gpointer             user_data,
-                                           GPtrArray           *events)
+                                           gpointer             user_data)
 {
   ZeitgeistLogPrivate   *priv;
   EggDBusArraySeq       *_events;

=== modified file 'src/zeitgeist-log.h'
--- src/zeitgeist-log.h	2010-04-23 06:35:17 +0000
+++ src/zeitgeist-log.h	2010-04-29 09:28:31 +0000
@@ -76,10 +76,10 @@
 
 void         zeitgeist_log_insert_events_from_ptrarray
                                                 (ZeitgeistLog        *self,
+                                                 GPtrArray           *events,
                                                  GCancellable        *cancellable,
                                                  GAsyncReadyCallback  callback,
-                                                 gpointer             user_data,
-                                                 GPtrArray           *events);
+                                                 gpointer             user_data);
 
 GArray*      zeitgeist_log_insert_events_finish (ZeitgeistLog        *self,
                                                  GAsyncResult        *res,

=== modified file 'src/zeitgeist-monitor.c'
--- src/zeitgeist-monitor.c	2010-04-20 07:42:33 +0000
+++ src/zeitgeist-monitor.c	2010-04-29 09:28:31 +0000
@@ -39,10 +39,6 @@
  * A monitor must be installed into the running Zeitgeist daemon by calling
  * zeitgeist_log_install_monitor(). The monitor will not emit any of the
  * ::events-added or ::events-deleted signals before this.
- *
- * Monitors are sub classes of #GInitiallyUnowned which means that
- * you may pass them directly to methods provided by the Zeitgeist library
- * and forget about them. The callee will own the floating reference.
  */
 
 static void   egg_zeitgeist_monitor_iface_init (EggZeitgeistMonitorIface *iface);
@@ -226,7 +222,7 @@
 	              NULL, NULL,
 	              _zeitgeist_cclosure_marshal_VOID__OBJECT_BOXED,
 	              G_TYPE_NONE,
-	              2, G_TYPE_OBJECT, G_TYPE_PTR_ARRAY);
+	              2, ZEITGEIST_TYPE_TIME_RANGE, G_TYPE_PTR_ARRAY);
 
   /**
    * ZeitgeistMonitor::events-deleted:
@@ -242,7 +238,7 @@
 	              NULL, NULL,
 	              _zeitgeist_cclosure_marshal_VOID__OBJECT_BOXED,
 	              G_TYPE_NONE,
-	              2, G_TYPE_OBJECT, G_TYPE_ARRAY);
+	              2, ZEITGEIST_TYPE_TIME_RANGE, G_TYPE_ARRAY);
   
   g_type_class_add_private (object_class, sizeof (ZeitgeistMonitorPrivate));
 }

=== modified file 'src/zeitgeist-monitor.h'
--- src/zeitgeist-monitor.h	2010-04-20 07:26:51 +0000
+++ src/zeitgeist-monitor.h	2010-04-29 09:28:31 +0000
@@ -60,6 +60,8 @@
   GObject parent_instance;
 };
 
+GType               zeitgeist_monitor_get_type       ();
+
 ZeitgeistMonitor*   zeitgeist_monitor_new            (ZeitgeistTimeRange *time_range,
                                                       GPtrArray          *event_templates);
 
@@ -71,4 +73,4 @@
 
 G_END_DECLS
 
-#endif /* _ZEITGEIST_MONITOR_H_ */
\ No newline at end of file
+#endif /* _ZEITGEIST_MONITOR_H_ */