add AppSystem.get_top_directories() and CinnamonApp.get_categories()

itzexor · itzexor · commit 1cf2ae30b4ee · 2019-08-27T20:51:14.000-07:00
rev3
diff --git a/src/cinnamon-app-private.h b/src/cinnamon-app-private.h
@@ -12,10 +12,12 @@ G_BEGIN_DECLS
 
 CinnamonApp* _cinnamon_app_new_for_window (MetaWindow *window);
 
-CinnamonApp* _cinnamon_app_new (GMenuTreeEntry *entry);
+CinnamonApp* _cinnamon_app_new (GMenuTreeEntry *entry, GPtrArray *categories);
 
 void _cinnamon_app_set_entry (CinnamonApp *app, GMenuTreeEntry *entry);
 
+void _cinnamon_app_set_categories (CinnamonApp *app, GPtrArray *categories);
+
 void _cinnamon_app_handle_startup_sequence (CinnamonApp *app, SnStartupSequence *sequence);
 
 void _cinnamon_app_add_window (CinnamonApp *app, MetaWindow *window);
diff --git a/src/cinnamon-app-system.c b/src/cinnamon-app-system.c
@@ -52,10 +52,36 @@ struct _CinnamonAppSystemPrivate {
   GHashTable *running_apps;
   GHashTable *id_to_app;
   GHashTable *startup_wm_class_to_app;
+  GPtrArray *top_level_directories;
 
   GSList *known_vendor_prefixes;
 };
 
+typedef struct {
+  GMenuTreeEntry *entry;
+  GPtrArray *categories;
+} FlattenedEntry;
+
+static FlattenedEntry *
+flattened_entry_new (GMenuTreeEntry *entry)
+{
+  g_return_val_if_fail (entry != NULL, NULL);
+  FlattenedEntry *out = g_slice_new (FlattenedEntry);
+  out->entry = gmenu_tree_item_ref (entry);
+  out->categories = g_ptr_array_new_with_free_func ((GDestroyNotify) gmenu_tree_item_unref);
+  return out;
+}
+
+static void
+flattened_entry_free (FlattenedEntry *entry)
+{
+  g_return_if_fail (entry != NULL);
+  g_clear_pointer (&entry->entry, gmenu_tree_item_unref);
+  g_clear_pointer (&entry->categories, g_ptr_array_unref);
+  g_slice_free (FlattenedEntry, entry);
+}
+
+
 static void cinnamon_app_system_finalize (GObject *object);
 static void on_apps_tree_changed_cb (GMenuTree *tree, gpointer user_data);
 CinnamonApp * lookup_heuristic_basename (CinnamonAppSystem *system, const char *name);
@@ -127,6 +153,8 @@ cinnamon_app_system_init (CinnamonAppSystem *self)
                                            NULL,
                                            (GDestroyNotify)g_object_unref);
 
+  priv->top_level_directories = NULL;
+
   priv->startup_wm_class_to_app = g_hash_table_new_full (g_str_hash, g_str_equal,
                                                          NULL,
                                                          (GDestroyNotify)g_object_unref);
@@ -476,12 +504,16 @@ deduplicate_apps (GPtrArray   *app_array,
   DEBUG_RENAMING ("Done renaming for '%s'\n\n", (gchar *) key);
 }
 
-static void
+static gboolean
 get_flattened_entries_recurse (GMenuTreeDirectory *dir,
-                               GHashTable         *entry_set)
+                               GMenuTreeDirectory *top_dir,
+                               GHashTable         *flattened_entry_set,
+                               GPtrArray          *top_level_dirs)
 {
   GMenuTreeIter *iter = gmenu_tree_directory_iter (dir);
   GMenuTreeItemType next_type;
+  gboolean has_entries = FALSE;
+  gboolean is_root = top_dir == NULL;
 
   while ((next_type = gmenu_tree_iter_next (iter)) != GMENU_TREE_ITEM_INVALID)
     {
@@ -492,17 +524,36 @@ get_flattened_entries_recurse (GMenuTreeDirectory *dir,
         case GMENU_TREE_ITEM_ENTRY:
           {
             GMenuTreeEntry *entry;
+            FlattenedEntry *f_entry;
             item = entry = gmenu_tree_iter_get_entry (iter);
-            /* Key is owned by entry */
-            g_hash_table_replace (entry_set,
-                                  (char*)gmenu_tree_entry_get_desktop_file_id (entry),
-                                  gmenu_tree_item_ref (entry));
+            char *desktop_id = (char*)gmenu_tree_entry_get_desktop_file_id (entry);
+
+            f_entry = g_hash_table_lookup (flattened_entry_set, desktop_id);
+            if (!f_entry)
+              {
+                f_entry = flattened_entry_new (entry);
+
+                if (!is_root)
+                  g_ptr_array_add (f_entry->categories, g_strdup(gmenu_tree_directory_get_menu_id (top_dir)));
+
+                /* Key is owned by entry */
+                g_hash_table_insert (flattened_entry_set, desktop_id, f_entry);
+              }
+            g_ptr_array_add (f_entry->categories, g_strdup(gmenu_tree_directory_get_menu_id (dir)));
+            has_entries = TRUE;
           }
           break;
         case GMENU_TREE_ITEM_DIRECTORY:
           {
-            item = gmenu_tree_iter_get_directory (iter);
-            get_flattened_entries_recurse ((GMenuTreeDirectory*)item, entry_set);
+            GMenuTreeDirectory *next_dir;
+            item = next_dir = gmenu_tree_iter_get_directory (iter);
+            gboolean res = get_flattened_entries_recurse (next_dir,
+                                                          is_root ? dir : top_dir,
+                                                          flattened_entry_set,
+                                                          top_level_dirs);
+            has_entries |= res;
+            if (is_root && res && !g_ptr_array_find (top_level_dirs, item, NULL))
+                g_ptr_array_add (top_level_dirs, gmenu_tree_item_ref (item));
           }
           break;
         case GMENU_TREE_ITEM_INVALID:
@@ -518,26 +569,7 @@ get_flattened_entries_recurse (GMenuTreeDirectory *dir,
     }
 
   gmenu_tree_iter_unref (iter);
-}
-
-static GHashTable *
-get_flattened_entries_from_tree (GMenuTree *tree)
-{
-  GHashTable *table;
-  GMenuTreeDirectory *root;
-
-  table = g_hash_table_new_full (g_str_hash, g_str_equal,
-                                 (GDestroyNotify) NULL,
-                                 (GDestroyNotify) gmenu_tree_item_unref);
-
-  root = gmenu_tree_get_root_directory (tree);
-
-  if (root != NULL)
-    get_flattened_entries_recurse (root, table);
-
-  gmenu_tree_item_unref (root);
-
-  return table;
+  return has_entries;
 }
 
 static void
@@ -547,11 +579,20 @@ on_apps_tree_changed_cb (GMenuTree *tree,
   CinnamonAppSystem *self = CINNAMON_APP_SYSTEM (user_data);
   GError *error = NULL;
   GHashTable *new_apps, *display_names;
+  GPtrArray *dirs;
+  GMenuTreeDirectory *root;
   GHashTableIter iter;
   gpointer key, value;
 
   g_assert (tree == self->priv->apps_tree);
 
+  new_apps = g_hash_table_new_full (g_str_hash, g_str_equal,
+                                    (GDestroyNotify) NULL,
+                                    (GDestroyNotify) flattened_entry_free);
+
+  dirs = g_ptr_array_new_with_free_func ((GDestroyNotify) gmenu_tree_item_unref);
+  g_clear_pointer (&self->priv->top_level_directories, g_ptr_array_unref);
+
   g_slist_free_full (self->priv->known_vendor_prefixes, g_free);
   self->priv->known_vendor_prefixes = NULL;
 
@@ -569,7 +610,14 @@ on_apps_tree_changed_cb (GMenuTree *tree,
       return;
     }
 
-  new_apps = get_flattened_entries_from_tree (self->priv->apps_tree);
+  root = gmenu_tree_get_root_directory (self->priv->apps_tree);
+
+  if (root != NULL)
+    get_flattened_entries_recurse (root, NULL, new_apps, dirs);
+
+  gmenu_tree_item_unref (root);
+
+  self->priv->top_level_directories = dirs;
 
   display_names = g_hash_table_new_full (g_str_hash, g_str_equal,
                                          (GDestroyNotify) g_free,
@@ -579,7 +627,8 @@ on_apps_tree_changed_cb (GMenuTree *tree,
   while (g_hash_table_iter_next (&iter, &key, &value))
     {
       const char *id = key;
-      GMenuTreeEntry *entry = value;
+      FlattenedEntry *f_entry = value;
+      GMenuTreeEntry *entry = f_entry->entry;
       GMenuTreeEntry *old_entry;
       char *prefix;
       CinnamonApp *app;
@@ -627,13 +676,14 @@ on_apps_tree_changed_cb (GMenuTree *tree,
 #endif
 
           _cinnamon_app_set_entry (app, entry);
+          _cinnamon_app_set_categories (app, f_entry->categories);
 
           g_object_ref (app);  /* Extra ref, removed in _replace below */
         }
       else
         {
           old_entry = NULL;
-          app = _cinnamon_app_new (entry);
+          app = _cinnamon_app_new (entry, f_entry->categories);
 
           DEBUG_RENAMING ("New app entry: '%s' with source '%s'\n",
                           _cinnamon_app_get_common_name (app),
@@ -748,7 +798,7 @@ cinnamon_app_system_get_tree (CinnamonAppSystem *self)
 /**
  * cinnamon_app_system_get_default:
  *
- * Return Value: (transfer none): The global #CinnamonAppSystem singleton
+ * Returns: (transfer none): The global #CinnamonAppSystem singleton
  */
 CinnamonAppSystem *
 cinnamon_app_system_get_default (void)
@@ -761,6 +811,19 @@ cinnamon_app_system_get_default (void)
   return instance;
 }
 
+/**
+ * cinnamon_app_system_get_top_directories:
+ *
+ * Returns: (nullable) (transfer none) (element-type GMenuTreeDirectory): A list of top level menu directories.
+ */
+GPtrArray *
+cinnamon_app_system_get_top_directories (CinnamonAppSystem *self)
+{
+  return self->priv->top_level_directories;
+}
+
+
+
 gboolean
 case_insensitive_search (const char *key,
                          const char *value,
@@ -780,7 +843,7 @@ case_insensitive_search (const char *key,
  *
  * Find a #CinnamonApp corresponding to an id.
  *
- * Return value: (transfer none): The #CinnamonApp for id, or %NULL if none
+ * Returns: (transfer none): The #CinnamonApp for id, or %NULL if none
  */
 CinnamonApp *
 cinnamon_app_system_lookup_app (CinnamonAppSystem   *self,
diff --git a/src/cinnamon-app-system.h b/src/cinnamon-app-system.h
@@ -53,4 +53,6 @@ GSList         *cinnamon_app_system_get_all                   (CinnamonAppSystem
 
 GSList         *cinnamon_app_system_get_running               (CinnamonAppSystem  *self);
 
+GPtrArray      *cinnamon_app_system_get_top_directories       (CinnamonAppSystem  *self);
+
 #endif /* __CINNAMON_APP_SYSTEM_H__ */
diff --git a/src/cinnamon-app.c b/src/cinnamon-app.c
@@ -57,6 +57,9 @@ struct _CinnamonApp
                           * want (e.g. it will be of TYPE_NORMAL from
                           * the way cinnamon-window-tracker.c works).
                           */
+
+  GPtrArray *categories;
+
   GDesktopAppInfo *info;
 
   CinnamonAppRunningState *running_state;
@@ -739,6 +742,16 @@ cinnamon_app_get_windows (CinnamonApp *app)
   return app->running_state->windows;
 }
 
+/**
+ * cinnamon_app_get_categories:
+ *
+ * Returns: (nullable) (transfer none) (element-type utf8): List of categories or NULL if app is window-backed
+ */
+GPtrArray *
+cinnamon_app_get_categories (CinnamonApp *app) {
+  return app->categories;
+}
+
 guint
 cinnamon_app_get_n_windows (CinnamonApp *app)
 {
@@ -789,20 +802,20 @@ _cinnamon_app_new_for_window (MetaWindow      *window)
 }
 
 CinnamonApp *
-_cinnamon_app_new (GMenuTreeEntry *info)
+_cinnamon_app_new (GMenuTreeEntry *info, GPtrArray *categories)
 {
   CinnamonApp *app;
 
   app = g_object_new (CINNAMON_TYPE_APP, NULL);
 
   _cinnamon_app_set_entry (app, info);
-
+  _cinnamon_app_set_categories (app, categories);
   return app;
 }
 
 void
 _cinnamon_app_set_entry (CinnamonApp       *app,
-                      GMenuTreeEntry *entry)
+                         GMenuTreeEntry *entry)
 {
   g_clear_pointer (&app->entry, gmenu_tree_item_unref);
   g_clear_object (&app->info);
@@ -820,6 +833,14 @@ _cinnamon_app_set_entry (CinnamonApp       *app,
     }
 }
 
+void
+_cinnamon_app_set_categories (CinnamonApp *app,
+                              GPtrArray   *categories)
+  {
+    g_clear_pointer (&app->categories, g_ptr_array_unref);
+    app->categories = g_ptr_array_ref (categories);
+  }
+
 static void
 cinnamon_app_state_transition (CinnamonApp      *app,
                             CinnamonAppState  state)
@@ -1193,27 +1214,23 @@ unref_running_state (CinnamonAppRunningState *state)
 static void
 cinnamon_app_init (CinnamonApp *self)
 {
-  self->state = CINNAMON_APP_STATE_STOPPED;
-  self->keywords = NULL;
+  self->categories = NULL;
+  self->entry = NULL;
   self->global = cinnamon_global_get ();
+  self->keywords = NULL;
+  self->state = CINNAMON_APP_STATE_STOPPED;
+  self->unique_name = NULL;
+  self->window_id_string = NULL;
 }
 
 static void
 cinnamon_app_dispose (GObject *object)
 {
   CinnamonApp *app = CINNAMON_APP (object);
 
-  if (app->entry)
-    {
-      gmenu_tree_item_unref (app->entry);
-      app->entry = NULL;
-    }
-
-  if (app->info)
-    {
-      g_object_unref (app->info);
-      app->info = NULL;
-    }
+  g_clear_pointer(&app->entry, gmenu_tree_item_unref);
+  g_clear_pointer(&app->info, g_object_unref);
+  g_clear_pointer(&app->categories, g_ptr_array_unref);
 
   while (app->running_state)
     _cinnamon_app_remove_window (app, app->running_state->windows->data);
diff --git a/src/cinnamon-app.h b/src/cinnamon-app.h
@@ -73,6 +73,8 @@ GSList *cinnamon_app_get_windows (CinnamonApp *app);
 
 GSList *cinnamon_app_get_pids (CinnamonApp *app);
 
+GPtrArray *cinnamon_app_get_categories (CinnamonApp *app);
+
 gboolean cinnamon_app_is_on_workspace (CinnamonApp *app, MetaWorkspace *workspace);
 
 gboolean cinnamon_app_launch (CinnamonApp     *app,
