[libpeas] [PeasEngine] Add peas_engine_append_search_path()

[Steve Frécinaux <sfre src gnome org>]

commit d4cacb912cc2d7b786150934198b5661c52b560d
Author: Steve Frécinaux <code istique net>
Date:   Fri Aug 27 15:55:18 2010 +0200

    [PeasEngine] Add peas_engine_append_search_path()
    
    This new API replaces the old "search-path" construct property. It
    is more understandable and can be used after object construction.
    
    https://bugzilla.gnome.org/show_bug.cgi?id=628183

 docs/reference/libpeas-sections.txt |    1 +
 libpeas/peas-engine.c               |  133 ++++++++++++++++++----------------
 libpeas/peas-engine.h               |    7 ++-
 peas-demo/peas-demo.c               |   34 ++++-----
 4 files changed, 90 insertions(+), 85 deletions(-)
---
diff --git a/docs/reference/libpeas-sections.txt b/docs/reference/libpeas-sections.txt
index ab88799..1b954e4 100644
--- a/docs/reference/libpeas-sections.txt
+++ b/docs/reference/libpeas-sections.txt
@@ -62,6 +62,7 @@ PeasGtkPluginManagerViewPrivate
 PeasEngine
 PeasEngineClass
 peas_engine_new
+peas_engine_add_search_path
 peas_engine_rescan_plugins
 peas_engine_get_plugin_list
 peas_engine_get_loaded_plugins
diff --git a/libpeas/peas-engine.c b/libpeas/peas-engine.c
index f29c1a8..fa92e32 100644
--- a/libpeas/peas-engine.c
+++ b/libpeas/peas-engine.c
@@ -70,7 +70,6 @@ static guint signals[LAST_SIGNAL];
 enum {
   PROP_0,
   PROP_APP_NAME,
-  PROP_SEARCH_PATHS,
   PROP_PLUGIN_LIST,
   PROP_LOADED_PLUGINS
 };
@@ -82,10 +81,15 @@ struct _LoaderInfo {
   PeasObjectModule *module;
 };
 
+typedef struct _SearchPath {
+  gchar *module_dir;
+  gchar *data_dir;
+} SearchPath;
+
 struct _PeasEnginePrivate {
   gchar *app_name;
   gchar *file_ext;
-  gchar **search_paths;
+  GList *search_paths;
 
   GList *plugin_list;
   GHashTable *loaders;
@@ -172,22 +176,68 @@ load_dir_real (PeasEngine  *engine,
 void
 peas_engine_rescan_plugins (PeasEngine *engine)
 {
-  gchar **sp;
-  guint i;
+  GList *item;
 
   g_return_if_fail (PEAS_IS_ENGINE (engine));
 
-  sp = engine->priv->search_paths;
-  if (sp == NULL)
+  if (engine->priv->search_paths == NULL)
     {
       g_debug ("No search paths where provided");
       return;
     }
 
   /* Go and read everything from the provided search paths */
-  for (i = 0; sp[i] != NULL; i += 2)
-    load_dir_real (engine, sp[i], sp[i + 1], 1);
+  for (item = engine->priv->search_paths; item != NULL; item = item->next)
+    {
+      SearchPath *sp = (SearchPath *) item->data;
+      load_dir_real (engine, sp->module_dir, sp->data_dir, 1);
+    }
+
+  g_object_notify (G_OBJECT (engine), "plugin-list");
+}
+
+/**
+ * peas_engine_add_search_path:
+ * @engine: A #PeasEngine.
+ * @module_dir: the plugin module directory.
+ * @data_dir: (allow-none): the plugin data directory.
+ *
+ * This function appends a search path to the list of paths where to
+ * look for plugins.
+ *
+ * A so-called "search path" actually consists of a couple of both a
+ * module directory (where the shared libraries or language modules
+ * lie) and a data directory (where the plugin data is).
+ *
+ * The #PeasPlugin will be able to use a correct data dir depending on
+ * where it is installed, hence allowing to keep the plugin agnostic
+ * when it comes to installation location: the same plugin can be
+ * installed either in the system path or in the user's home directory,
+ * without taking other special care than using
+ * peas_plugin_info_get_data_dir() when looking for its data files.
+ *
+ * If @data_dir is %NULL, then it is set to the same value as
+ * @module_dir.
+ */
+void
+peas_engine_add_search_path (PeasEngine *engine,
+                             const gchar *module_dir,
+                             const gchar *data_dir)
+{
+  SearchPath *sp;
+
+  g_return_if_fail (PEAS_IS_ENGINE (engine));
+  g_return_if_fail (module_dir != NULL);
+
+  sp = g_slice_new (SearchPath);
+  sp->module_dir = g_strdup (module_dir);
+  sp->data_dir = g_strdup (data_dir ? data_dir : module_dir);
 
+  /* Appending to a list is bad, but is easier to handle wrt refreshing
+   * the plugin list. */
+  engine->priv->search_paths = g_list_append (engine->priv->search_paths, sp);
+
+  load_dir_real (engine, sp->module_dir, sp->data_dir, 1);
   g_object_notify (G_OBJECT (engine), "plugin-list");
 }
 
@@ -318,9 +368,6 @@ peas_engine_set_property (GObject      *object,
       engine->priv->app_name = g_value_dup_string (value);
       engine->priv->file_ext = compute_file_extension (engine->priv->app_name);
       break;
-    case PROP_SEARCH_PATHS:
-      engine->priv->search_paths = g_value_dup_boxed (value);
-      break;
     case PROP_LOADED_PLUGINS:
       peas_engine_set_loaded_plugins (engine,
                                       (const gchar **) g_value_get_boxed (value));
@@ -344,9 +391,6 @@ peas_engine_get_property (GObject    *object,
     case PROP_APP_NAME:
       g_value_set_string (value, engine->priv->app_name);
       break;
-    case PROP_SEARCH_PATHS:
-      g_value_set_boxed (value, engine->priv->search_paths);
-      break;
     case PROP_PLUGIN_LIST:
       g_value_set_pointer (value,
                            (gpointer) peas_engine_get_plugin_list (engine));
@@ -383,8 +427,18 @@ peas_engine_finalize (GObject *object)
   for (item = engine->priv->plugin_list; item; item = item->next)
     _peas_plugin_info_unref (PEAS_PLUGIN_INFO (item->data));
 
+  /* free the search path list */
+  for (item = engine->priv->search_paths; item; item = item->next)
+    {
+      SearchPath *sp = (SearchPath *) item->data;
+
+      g_free (sp->module_dir);
+      g_free (sp->data_dir);
+      g_slice_free (SearchPath, sp);
+    }
+
   g_list_free (engine->priv->plugin_list);
-  g_strfreev (engine->priv->search_paths);
+  g_list_free (engine->priv->search_paths);
   g_free (engine->priv->file_ext);
   g_free (engine->priv->app_name);
 
@@ -426,48 +480,6 @@ peas_engine_class_init (PeasEngineClass *klass)
                                                         G_PARAM_STATIC_STRINGS));
 
   /**
-   * PeasEngine:search-paths:
-   *
-   * The list of path where to look for plugins.
-   *
-   * A so-called "search path" actually consists on a couple of both a
-   * module directory (where the shared libraries or language modules
-   * lie) and a data directory (where the plugin data is).
-   *
-   * The #PeasPlugin will be able to use a correct data dir depending on
-   * where it is installed, hence allowing to keep the plugin agnostic
-   * when it comes to installation location: the same plugin can be
-   * installed both in the system path or in the user's home directory,
-   * without taking other special care than using
-   * peas_plugin_info_get_data_dir() when looking for its data files.
-   *
-   * Concretely, this property contains a %NULL-terminated array of
-   * strings, whose even-indexed strings are module directories, and
-   * odd-indexed ones are the associated data directories.  Here is an
-   * example of such an array:
-   * |[
-   * gchar const * const search_paths[] = {
-   *         // Plugins in ~/.config
-   *         g_build_filename (g_get_user_config_dir (), "example/plugins", NULL),
-   *         g_build_filename (g_get_user_config_dir (), "example/plugins", NULL),
-   *         // System plugins
-   *         EXAMPLE_PREFIX "/lib/example/plugins/",
-   *         EXAMPLE_PREFIX "/share/example/plugins/",
-   *         NULL
-   * };
-   * ]|
-   */
-  g_object_class_install_property (object_class,
-                                   PROP_SEARCH_PATHS,
-                                   g_param_spec_boxed ("search-paths",
-                                                       "Search paths",
-                                                       "The list of paths where to look for plugins",
-                                                       G_TYPE_STRV,
-                                                       G_PARAM_READWRITE |
-                                                       G_PARAM_CONSTRUCT_ONLY |
-                                                       G_PARAM_STATIC_STRINGS));
-
-  /**
    * PeasEngine:plugin-list:
    *
    * The list of found plugins.
@@ -1127,7 +1139,6 @@ peas_engine_set_loaded_plugins (PeasEngine   *engine,
 /**
  * peas_engine_new:
  * @app_name: (allow-none): The name of the application
- * @search_paths: The paths where to look for plugins
  *
  * Returns a new #PeasEngine object.
  * See the properties description for more information about the parameters.
@@ -1135,13 +1146,9 @@ peas_engine_set_loaded_plugins (PeasEngine   *engine,
  * Returns: a newly created #PeasEngine object.
  */
 PeasEngine *
-peas_engine_new (const gchar  *app_name,
-                 const gchar **search_paths)
+peas_engine_new (const gchar  *app_name)
 {
-  g_return_val_if_fail (search_paths != NULL, NULL);
-
   return PEAS_ENGINE (g_object_new (PEAS_TYPE_ENGINE,
                                     "app-name", app_name,
-                                    "search-paths", search_paths,
                                     NULL));
 }
diff --git a/libpeas/peas-engine.h b/libpeas/peas-engine.h
index 2288ba7..4a47405 100644
--- a/libpeas/peas-engine.h
+++ b/libpeas/peas-engine.h
@@ -68,8 +68,11 @@ struct _PeasEngineClass {
 };
 
 GType             peas_engine_get_type            (void) G_GNUC_CONST;
-PeasEngine       *peas_engine_new                 (const gchar     *app_name,
-                                                   const gchar    **search_paths);
+PeasEngine       *peas_engine_new                 (const gchar     *app_name);
+
+void              peas_engine_add_search_path     (PeasEngine      *engine,
+                                                   const gchar     *plugin_dir,
+                                                   const gchar     *data_dir);
 
 /* plugin management */
 void              peas_engine_disable_loader      (PeasEngine      *engine,
diff --git a/peas-demo/peas-demo.c b/peas-demo/peas-demo.c
index d8fa48c..264b468 100644
--- a/peas-demo/peas-demo.c
+++ b/peas-demo/peas-demo.c
@@ -125,7 +125,7 @@ main (int    argc,
 {
   GOptionContext *option_context;
   GError *error = NULL;
-  gchar **search_paths;
+  gchar *plugin_dir;
 
   option_context = g_option_context_new (_("- libpeas demo application"));
   g_option_context_add_main_entries (option_context, demo_args, GETTEXT_PACKAGE);
@@ -140,34 +140,29 @@ main (int    argc,
 
   g_option_context_free (option_context);
 
-  search_paths = g_new0 (gchar *, 5);
-
-  /* User-installed plugins */
-  search_paths[0] = g_build_filename (g_get_user_config_dir (), "peas-demo/plugins", NULL);
-  search_paths[1] = g_build_filename (g_get_user_config_dir (), "peas-demo/plugins", NULL);
-
+  /* Ensure we pick the uninstalled plugin loaders if we're running from build dir */
   if (run_from_build_dir)
     {
       g_debug ("Running from build dir.");
       g_irepository_prepend_search_path ("../libpeas");
       g_irepository_prepend_search_path ("../libpeasui");
       g_setenv ("PEAS_PLUGIN_LOADERS_DIR", "../loaders", TRUE);
-
-      /* Uninstalled plugins */
-      search_paths[2] = g_strdup ("./plugins");
-      search_paths[3] = g_strdup ("./plugins");
-    }
-  else
-    {
-      /* System-wide plugins */
-      search_paths[2] = g_strdup (PEAS_LIBDIR "/peas-demo/plugins/");
-      search_paths[3] = g_strdup (PEAS_PREFIX "/share/peas-demo/plugins/");
     }
 
   g_irepository_require (g_irepository_get_default (), "PeasGtk", "1.0", 0, NULL);
 
-  engine = peas_engine_new ("PeasDemo",
-                            (const gchar **) search_paths);
+  engine = peas_engine_new ("PeasDemo");
+
+  plugin_dir = g_build_filename (g_get_user_config_dir (), "peas-demo/plugins", NULL);
+  peas_engine_add_search_path (engine, plugin_dir, plugin_dir);
+  g_free (plugin_dir);
+
+  if (run_from_build_dir)
+    peas_engine_add_search_path (engine, "./plugins", NULL);
+  else
+    peas_engine_add_search_path (engine,
+                                 PEAS_LIBDIR "/peas-demo/plugins/",
+                                 PEAS_PREFIX "/share/peas-demo/plugins");
 
   n_windows = 0;
   main_window = create_main_window ();
@@ -176,7 +171,6 @@ main (int    argc,
   gtk_main ();
 
   g_object_unref (engine);
-  g_strfreev (search_paths);
 
   return 0;
 }