Add API to start plugins using GFile
[projects/chimara/chimara.git] / libchimara / chimara-glk.c
index 47c2b51b014b320d625bfabc3cf1147d004902af..b7c0a7d6f3df2f9290ed5e459ea02d9c481b9e26 100644 (file)
@@ -1257,8 +1257,7 @@ chimara_glk_run(ChimaraGlk *glk, const gchar *plugin, int argc, char *argv[], GE
     g_assert( g_module_supported() );
        /* If there is already a module loaded, free it first -- you see, we want to
         * keep modules loaded as long as possible to avoid crashes in stack unwinding */
-       if( priv->program && !g_module_close(priv->program) )
-               g_warning( "Error closing module :%s", g_module_error() );
+       chimara_glk_unload_plugin(glk);
        /* Open the module to run */
     priv->program = g_module_open(plugin, G_MODULE_BIND_LAZY);
     
@@ -1300,6 +1299,35 @@ chimara_glk_run(ChimaraGlk *glk, const gchar *plugin, int argc, char *argv[], GE
        return !(priv->thread == NULL);
 }
 
+/**
+ * chimara_glk_run_file:
+ * @self: a #ChimaraGlk widget
+ * @plugin_file: a #GFile pointing to a plugin module compiled with <filename
+ * class="header">glk.h</filename>
+ * @argc: Number of command line arguments in @argv
+ * @argv: Array of command line arguments to pass to the plugin
+ * @error: location to store a <link
+ * linkend="glib-Error-Reporting">GError</link>, or %NULL
+ *
+ * Opens a Glk program compiled as a plugin, from a #GFile. See
+ * chimara_glk_run() for details.
+ *
+ * Return value: %TRUE if the Glk program was started successfully.
+ */
+gboolean
+chimara_glk_run_file(ChimaraGlk *self, GFile *plugin_file, int argc, char *argv[], GError **error)
+{
+       g_return_val_if_fail(self || CHIMARA_IS_GLK(self), FALSE);
+       g_return_val_if_fail(plugin_file || G_IS_FILE(plugin_file), FALSE);
+       g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
+
+       char *path = g_file_get_path(plugin_file);
+       gboolean retval = chimara_glk_run(self, path, argc, argv, error);
+       g_free(path);
+
+       return retval;
+}
+
 /**
  * chimara_glk_stop:
  * @glk: a #ChimaraGlk widget
@@ -1356,6 +1384,26 @@ chimara_glk_wait(ChimaraGlk *glk)
        gdk_threads_enter();
 }
 
+/**
+ * chimara_glk_unload_plugin:
+ * @glk: a #ChimaraGlk widget
+ *
+ * The plugin containing the Glk program is unloaded as late as possible before
+ * loading a new plugin, in order to prevent crashes while printing stack
+ * backtraces during debugging. Sometimes this behavior is not desirable. This
+ * function forces @glk to unload the plugin running in it.
+ *
+ * This function does nothing if there is no plugin loaded.
+ */
+void
+chimara_glk_unload_plugin(ChimaraGlk *glk)
+{
+       g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
+    CHIMARA_GLK_USE_PRIVATE(glk, priv);
+       if( priv->program && !g_module_close(priv->program) )
+               g_warning( "Error closing module :%s", g_module_error() );
+}
+
 /**
  * chimara_glk_get_running:
  * @glk: a #ChimaraGlk widget