Merge lp:~mhr3/libunity/api-tweaks into lp:libunity

[Michal Hruby]

Add unity_object_unref wrapper, deprecate the DBusName and DBusPath keys in .scope files, use UniqueName & GroupName instead (same as what the API uses).

Add unity_object_unref wrapper, deprecate the DBusName and DBusPath keys in .scope files, use UniqueName & GroupName instead (same as what the API uses).

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:241
http://jenkins.qa.ubuntu.com/job/libunity-ci/38/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/libunity-saucy-amd64-ci/23
    SUCCESS: http://jenkins.qa.ubuntu.com/job/libunity-saucy-armhf-ci/23
    SUCCESS: http://jenkins.qa.ubuntu.com/job/libunity-saucy-i386-ci/23

Click here to trigger a rebuild:
http://s-jenkins:8080/job/libunity-ci/38/rebuild

review: Approve (continuous-integration)

[Paweł Stołowski (stolowski)]

Looks good overall, just two comments:

86 + if (o.get_type ().name ().has_prefix ("Unity"))

This check looks a bit shaky, but I recon we can't do much more... So, how about renaming object_unref to unity_object_unref to emphasize this requirement?

82 + public static void object_unref (void* object)
What's the use case / who is going to use it? Can you add a docstring?

review: Needs Fixing

[lp:~mhr3/libunity/api-tweaks]

242. By Michal Hruby on 2013-06-24

Add proper doc string

[Michal Hruby (mhr3)]

> Looks good overall, just two comments:
>
> 86 + if (o.get_type ().name ().has_prefix ("Unity"))
>
> This check looks a bit shaky, but I recon we can't do much more... So, how
> about renaming object_unref to unity_object_unref to emphasize this
> requirement?

That's already the name, note the Unity namespace.

>
> 82 + public static void object_unref (void* object)
> What's the use case / who is going to use it? Can you add a docstring?

It's *the* destructor for everything.

[Paweł Stołowski (stolowski)]

Ok, thanks for clarification, let's get it it.

review: Approve

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:242
http://jenkins.qa.ubuntu.com/job/libunity-ci/39/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/libunity-saucy-amd64-ci/24
    SUCCESS: http://jenkins.qa.ubuntu.com/job/libunity-saucy-armhf-ci/24
    SUCCESS: http://jenkins.qa.ubuntu.com/job/libunity-saucy-i386-ci/24

Click here to trigger a rebuild:
http://s-jenkins:8080/job/libunity-ci/39/rebuild

review: Approve (continuous-integration)

=== modified file 'configure.ac'
--- configure.ac	2013-06-18 17:29:18 +0000
+++ configure.ac	2013-06-24 16:07:47 +0000
@@ -1,5 +1,5 @@
 # When releasing also remember to update the soname as instructed below
-AC_INIT(libunity, 7.0.4)
+AC_INIT(libunity, 7.0.5)
 
 AM_INIT_AUTOMAKE(AC_PACKAGE_NAME, AC_PACKAGE_VERSION)
 AM_CONFIG_HEADER(config.h)

=== modified file 'debian/changelog'
--- debian/changelog	2013-06-21 04:02:47 +0000
+++ debian/changelog	2013-06-24 16:07:47 +0000
@@ -1,3 +1,10 @@
+libunity (7.0.5-0ubuntu1) UNRELEASED; urgency=low
+
+  * Add unity_object_unref wrapper.
+  * Use GroupName and UniqueName in the .scope files.
+
+ -- Michal Hruby <[e-mail]>  Mon, 24 Jun 2013 11:28:15 +0100
+
 libunity (7.0.4daily13.06.21-0ubuntu1) saucy; urgency=low
 
   [ Michal Hruby ]

=== modified file 'debian/libunity9.symbols'
--- debian/libunity9.symbols	2013-06-21 15:35:04 +0000
+++ debian/libunity9.symbols	2013-06-24 16:07:47 +0000
@@ -572,6 +572,7 @@
  unity_music_preview_get_type@Base 5.90.0
  unity_music_preview_new@Base 5.90.0
  unity_music_preview_track_state_get_type@Base 5.92.0
+ unity_object_unref@Base 0replaceme
  unity_options_filter_add_option@Base 4.0.0
  unity_options_filter_construct@Base 4.0.0
  unity_options_filter_find_and_update_option@Base 4.0.0

=== modified file 'protocol/protocol-scope-discovery.vala'
--- protocol/protocol-scope-discovery.vala	2013-06-11 10:24:17 +0000
+++ protocol/protocol-scope-discovery.vala	2013-06-24 16:07:47 +0000
@@ -234,8 +234,24 @@
 
         // required fields
         this.name = dgettext(this.domain, file.get_string (SCOPE_GROUP, "Name"));
-        this.dbus_name = file.get_string (SCOPE_GROUP, "DBusName");
-        this.dbus_path = file.get_string (SCOPE_GROUP, "DBusPath");
+        // support deprecated DBusName / DBusPath, but require the new
+        // GroupName & UniqueName
+        if (file.has_key (SCOPE_GROUP, "DBusName"))
+        {
+          this.dbus_name = file.get_string (SCOPE_GROUP, "DBusName");
+        }
+        else
+        {
+          this.dbus_name = file.get_string (SCOPE_GROUP, "GroupName");
+        }
+        if (file.has_key (SCOPE_GROUP, "DBusPath"))
+        {
+          this.dbus_path = file.get_string (SCOPE_GROUP, "DBusPath");
+        }
+        else
+        {
+          this.dbus_path = file.get_string (SCOPE_GROUP, "UniqueName");
+        }
         this.icon = file.get_string (SCOPE_GROUP, "Icon");
         this.type = file.get_string (SCOPE_GROUP, "Type");
 

=== modified file 'src/unity-utils.vala'
--- src/unity-utils.vala	2013-06-21 15:27:07 +0000
+++ src/unity-utils.vala	2013-06-24 16:07:47 +0000
@@ -21,7 +21,28 @@
 using GLib;
 using Gee;
 
-namespace Unity.Internal {
+namespace Unity {
+
+  /**
+   * Destroy an object.
+   *
+   * Unreferences object returned by one of unity_*_new constructors.
+   */
+  public static void object_unref (void* object)
+  {
+    Object* o_ptr = (Object*) object;
+    // we don't want people using unity_object_unref for non Unity classes
+    if (o_ptr is Object && o_ptr->get_type ().name ().has_prefix ("Unity"))
+    {
+      delete o_ptr;
+    }
+    else
+    {
+      critical ("Unable to unref object, invalid object type");
+    }
+  }
+
+namespace Internal {
 
 /* Cateories: [id, display_name, icon, renderer_name, hints] */
 internal const string[] CATEGORIES_SCHEMA = {"s", "s", "s", "s", "a{sv}"};
@@ -287,3 +308,4 @@
 }
 
 } /* namespace Unity.Internal */
+} /* namespace Unity */

=== modified file 'test/data/unity/scopes/masterscope_b.scope'
--- test/data/unity/scopes/masterscope_b.scope	2013-06-10 12:02:11 +0000
+++ test/data/unity/scopes/masterscope_b.scope	2013-06-24 16:07:47 +0000
@@ -1,6 +1,6 @@
 [Scope]
-DBusName=com.canonical.Unity.Scope.MasterB
-DBusPath=/com/canonical/unity/scope/masterb
+GroupName=com.canonical.Unity.Scope.MasterB
+UniqueName=/com/canonical/unity/scope/masterb
 Icon=/usr/share/unity/6/icon2.svg
 IsMaster=true
 RequiredMetadata=bid[s];a[s];b[y];

=== modified file 'test/data/unity/scopes/masterscope_b/brokenscope.scope'
--- test/data/unity/scopes/masterscope_b/brokenscope.scope	2012-12-04 17:19:39 +0000
+++ test/data/unity/scopes/masterscope_b/brokenscope.scope	2013-06-24 16:07:47 +0000
@@ -1,3 +1,3 @@
 [Scope]
-DBusName=com.canonical.Unity.Scope.Subscope1
-DBusPath=/com/canonical/unity/scope/subscope1
+GroupName=com.canonical.Unity.Scope.Subscope1
+UniqueName=/com/canonical/unity/scope/subscope1

=== modified file 'test/data/unity/scopes/masterscope_b/subscope1.scope'
--- test/data/unity/scopes/masterscope_b/subscope1.scope	2013-04-23 18:21:33 +0000
+++ test/data/unity/scopes/masterscope_b/subscope1.scope	2013-06-24 16:07:47 +0000
@@ -1,6 +1,6 @@
 [Scope]
-DBusName=com.canonical.Unity.Scope.Subscope1
-DBusPath=/com/canonical/unity/scope/subscope1
+GroupName=com.canonical.Unity.Scope.Subscope1
+UniqueName=/com/canonical/unity/scope/subscope1
 Icon=/usr/share/unity/6/icon-sub1.svg
 RequiredMetadata=bid[s];
 OptionalMetadata=

=== modified file 'test/data/unity/scopes/masterscope_b/subscope2.scope'
--- test/data/unity/scopes/masterscope_b/subscope2.scope	2013-04-03 15:22:36 +0000
+++ test/data/unity/scopes/masterscope_b/subscope2.scope	2013-06-24 16:07:47 +0000
@@ -1,6 +1,6 @@
 [Scope]
-DBusName=com.canonical.Unity.Scope.Subscope2
-DBusPath=/com/canonical/unity/scope/subscope2
+GroupName=com.canonical.Unity.Scope.Subscope2
+UniqueName=/com/canonical/unity/scope/subscope2
 Icon=/usr/share/unity/6/icon-sub2.svg
 Keywords=pooh;
 Type=various

=== modified file 'test/data/unity/scopes/test_masterscope.scope'
--- test/data/unity/scopes/test_masterscope.scope	2013-04-03 15:22:36 +0000
+++ test/data/unity/scopes/test_masterscope.scope	2013-06-24 16:07:47 +0000
@@ -1,6 +1,6 @@
 [Scope]
-DBusName=com.canonical.Unity.Scope.Test
-DBusPath=/com/canonical/Unity/MasterScope/Test
+GroupName=com.canonical.Unity.Scope.Test
+UniqueName=/com/canonical/Unity/MasterScope/Test
 Icon=/usr/share/unity/6/icon1.svg
 IsMaster=true
 RequiredMetadata=required_string[s];required_int[i];