Merge lp:~kamstrup/libunity/keywords-index into lp:libunity

[Mikkel Kamstrup Erlandsen]

See commit msg and attached bug

[Neil J. Patel (njpatel)]

Looks good, approved.

review: Approve

[Michal Hruby (mhr3)]

And one more from me.

review: Approve

[lp:~kamstrup/libunity/keywords-index]

83. By Mikkel Kamstrup Erlandsen on 2011-09-27

Merge lp:~mhr3/libunity/no-string-array-copies: Don't copy string arrays all over the place when registering keywords

=== modified file 'configure.ac'
--- configure.ac	2011-09-15 11:14:02 +0000
+++ configure.ac	2011-09-27 10:55:34 +0000
@@ -1,5 +1,5 @@
 # When releasing also remember to update the soname as instructed below
-AC_INIT(libunity, 4.0.4)
+AC_INIT(libunity, 4.0.5)
 
 AM_INIT_AUTOMAKE(AC_PACKAGE_NAME, AC_PACKAGE_VERSION)
 AM_CONFIG_HEADER(config.h)
@@ -16,9 +16,9 @@
 # - If binary compatibility has been broken (eg removed or changed interfaces)
 #   change to C+1:0:0
 # - If the interface is the same as the previous version, change to C:R+1:A
-LIBUNITY_LT_CURRENT=7
+LIBUNITY_LT_CURRENT=8
 LIBUNITY_LT_REV=0
-LIBUNITY_LT_AGE=1
+LIBUNITY_LT_AGE=2
 LIBUNITY_LT_VERSION="$LIBUNITY_LT_CURRENT:$LIBUNITY_LT_REV:$LIBUNITY_LT_AGE"
 LIBUNITY_LT_LDFLAGS="-version-info $LIBUNITY_LT_VERSION -export-symbols-regex '^unity_.*'"
 

=== modified file 'src/unity-appinfo-manager.vala'
--- src/unity-appinfo-manager.vala	2011-09-15 09:09:46 +0000
+++ src/unity-appinfo-manager.vala	2011-09-27 10:55:34 +0000
@@ -37,6 +37,11 @@
   private class StringArrayWrapper
   {
     public string[] strings;
+
+    public void take_strings (owned string[] str_arr)
+    {
+      strings = (owned) str_arr;
+    }
   }
 
   /**
@@ -54,12 +59,14 @@
     private HashTable<string,AppInfo?> appinfo_by_id; /* id or path -> AppInfo */
     private HashTable<string,FileMonitor> monitors; /* parent uri -> monitor */
     private HashTable<string, StringArrayWrapper> categories_by_id; /* desktop id or path -> xdg cats */
+    private HashTable<string, StringArrayWrapper> keywords_by_id; /* desktop id or path -> X-GNOME-Keywords and X-AppInstall-Keywords */
     private HashTable<string,string?> paths_by_id; /* desktop id -> full path to desktop file */
     
     private AppInfoManager ()
     {
       appinfo_by_id = new HashTable<string,AppInfo?> (str_hash, str_equal);
       categories_by_id = new HashTable<string,StringArrayWrapper> (str_hash, str_equal);
+      keywords_by_id = new HashTable<string,StringArrayWrapper> (str_hash, str_equal);
       paths_by_id = new HashTable<string,string?> (str_hash, str_equal);
 
       monitors = new HashTable<string,FileMonitor> (str_hash, str_equal);
@@ -187,16 +194,9 @@
       if (keyfile != null)
         {
           appinfo = new DesktopAppInfo.from_keyfile (keyfile);
-          try {
-            string[] categories = keyfile.get_string_list ("Desktop Entry",
-                                                           "Categories");
-            
-            var wrapper = new StringArrayWrapper();
-            wrapper.strings = categories;
-            categories_by_id.insert (id, wrapper);
-          } catch (KeyFileError e) {
-            /* Unknown key or group. This app has no XDG Catories */
-          }          
+          
+          register_categories (id, keyfile);
+          register_keywords (id, keyfile);
         }
       else
         appinfo = null;      
@@ -227,6 +227,28 @@
       var result = categories_by_id.lookup (id);
       return result != null ? result.strings : null;
     }
+    
+    /**
+     * Look up keywords for for desktop id or file path @id. The keywords will
+     * be an amalgamation of the X-GNOME-Keywords and X-AppInstall-Keywords
+     * fields from the .desktopfile.
+     * Returns null if id is not found.
+     * This method will do sync IO if the desktop file for @id is not
+     * already cached. So if you are living in an async world you must first
+     * do an async call to lookup_async(id) before calling this method, in which
+     * case no sync io will be done.
+     */
+    public unowned string[]? get_keywords (string id)
+    {
+      /* Make sure we have loaded the relevant .desktop file: */
+      AppInfo? appinfo = lookup (id);
+      
+      if (appinfo == null)
+        return null;
+
+      var result = keywords_by_id.lookup (id);
+      return result != null ? result.strings : null;
+    }
 	
     /**
      * Look up the full path to the desktop file for desktop id @id.
@@ -327,27 +349,69 @@
       /* Create the appinfo and cache it */
       var appinfo = new DesktopAppInfo.from_keyfile (keyfile);
       appinfo_by_id.insert (id, appinfo);
+      register_categories (id, keyfile);
+      register_keywords (id, keyfile);
+      
+      return appinfo;
+    }
+    
+    /* Clear all cached AppInfos */
+    public void clear ()
+    {
+      appinfo_by_id.remove_all ();
+      categories_by_id.remove_all ();
+      keywords_by_id.remove_all ();
+	    paths_by_id.remove_all ();
+      // We don't tear down fs monitors... Dunno if we should...
+    }
+    
+    private void register_categories (string id, KeyFile keyfile)
+    {
       try {
         string[] categories = keyfile.get_string_list ("Desktop Entry",
                                                        "Categories");
 
         var wrapper = new StringArrayWrapper();
-        wrapper.strings = categories;
+        wrapper.take_strings ((owned) categories);
         categories_by_id.insert (id, wrapper);
       } catch (KeyFileError eee) {
         /* Unknown key or group. This app has no XDG Catories */
       }
-      
-      return appinfo;
     }
     
-    /* Clear all cached AppInfos */
-    public void clear ()
+    private void register_keywords (string id, KeyFile keyfile)
     {
-      appinfo_by_id.remove_all ();
-      categories_by_id.remove_all ();
-	  paths_by_id.remove_all ();
-      // We don't tear down fs monitors... Dunno if we should...
+      string[] gkeywords;
+      string[] akeywords;
+      try {
+        gkeywords = keyfile.get_locale_string_list ("Desktop Entry",
+                                                    "X-GNOME-Keywords");
+      } catch (KeyFileError e) {
+        /* Unknown key or group. This app has no X-GNOME-Keywords */
+        gkeywords = new string[0];
+      }
+      try {
+        akeywords = keyfile.get_locale_string_list ("Desktop Entry",
+                                                    "X-AppInstall-Keywords");
+      } catch (KeyFileError e) {
+        /* Unknown key or group. This app has no X-GNOME-Keywords */
+        akeywords = new string[0];
+      }
+          
+      /* Copy the two keyword types into one 'keyword' array */
+      string[] keywords = new string[gkeywords.length + akeywords.length];
+      for (int i = 0; i < gkeywords.length; i++)
+      {
+        keywords[i] = gkeywords[i];
+      }
+      for (int i = 0; i < akeywords.length; i++)
+      {
+        keywords[gkeywords.length + i] = akeywords[i];
+      }
+          
+      var wrapper = new StringArrayWrapper();
+      wrapper.take_strings ((owned) keywords);
+      keywords_by_id.insert (id, wrapper);
     }
   
   } /* class AppInfoManager */

=== modified file 'test/data/applications/ubuntu-about.desktop'
--- test/data/applications/ubuntu-about.desktop	2011-01-11 21:37:07 +0000
+++ test/data/applications/ubuntu-about.desktop	2011-09-27 10:55:34 +0000
@@ -9,3 +9,5 @@
 Categories=GNOME;Application;Core;
 StartupNotify=true
 X-Ubuntu-Gettext-Domain=gnome-panel-2.0
+X-GNOME-Keywords=about;ubuntu;help
+X-AppInstall-Keywords=testkeyword

=== modified file 'test/data/test_desktop_file.desktop'
--- test/data/test_desktop_file.desktop	2011-01-11 21:37:07 +0000
+++ test/data/test_desktop_file.desktop	2011-09-27 10:55:34 +0000
@@ -6,3 +6,4 @@
 Type=Application
 StartupNotify=false
 Icon=test_desktop_icon.png
+

=== modified file 'test/vala/test-appinfo-manager.vala'
--- test/vala/test-appinfo-manager.vala	2011-09-09 16:00:28 +0000
+++ test/vala/test-appinfo-manager.vala	2011-09-27 10:55:34 +0000
@@ -61,6 +61,7 @@
       var manager = AppInfoManager.get_instance();
       assert (manager.lookup ("_foobar.desktop") == null);
       assert (manager.get_categories ("_foobar.desktop") == null);
+      assert (manager.get_keywords ("_foobar.desktop") == null);
       assert (manager.get_path ("_foobar.desktop") == null);
     }
 
@@ -79,6 +80,7 @@
         AppInfo? appinfo = yield manager.lookup_async ("_foobar.desktop");
         assert (appinfo == null);
         assert (manager.get_categories ("_foobar.desktop") == null);
+        assert (manager.get_keywords ("_foobar.desktop") == null);
         assert (manager.get_path ("_foobar.desktop") == null);
       } catch (Error e) {
         error ("Error reading desktop file: %s", e.message);
@@ -99,10 +101,19 @@
       
       string[]? categories = manager.get_categories ("ubuntu-about.desktop");
       assert (categories != null);
+      assert (categories.length == 3);
       assert (categories[0] == "GNOME");
       assert (categories[1] == "Application");
       assert (categories[2] == "Core");
       
+      string[]? keywords = manager.get_keywords ("ubuntu-about.desktop");
+      assert (keywords != null);
+      assert (keywords.length == 4);
+      assert (keywords[0] == "about");
+      assert (keywords[1] == "ubuntu");
+      assert (keywords[2] == "help");
+      assert (keywords[3] == "testkeyword");
+      
       string path = manager.get_path ("ubuntu-about.desktop");
       string abs_path = File.new_for_path(Config.TESTDIR).resolve_relative_path("data/applications/ubuntu-about.desktop").get_path();
       assert (path == abs_path);
@@ -129,9 +140,18 @@
       
       string[]? categories = manager.get_categories ("ubuntu-about.desktop");
       assert (categories != null);
+      assert (categories.length == 3);
       assert (categories[0] == "GNOME");
       assert (categories[1] == "Application");
       assert (categories[2] == "Core");
+      
+      string[]? keywords = manager.get_keywords ("ubuntu-about.desktop");
+      assert (keywords != null);
+      assert (keywords[0] == "about");
+      assert (keywords[1] == "ubuntu");
+      assert (keywords[2] == "help");
+      assert (keywords[3] == "testkeyword");
+      assert (keywords.length == 4);
 
       string path = manager.get_path ("ubuntu-about.desktop");
       string abs_path = File.new_for_path(Config.TESTDIR).resolve_relative_path("data/applications/ubuntu-about.desktop").get_path();