#include <gtk/gtk.h>
#include <glib/gi18n.h>
+#include <gmodule.h>
#include "chimara-glk.h"
#include "chimara-glk-private.h"
#include "glk.h"
+#include "abort.h"
#include "window.h"
#define CHIMARA_GLK_MIN_WIDTH 0
#define CHIMARA_GLK_MIN_HEIGHT 0
+typedef void (* glk_main_t) (void);
+
enum {
PROP_0,
PROP_INTERACTIVE,
priv->self = self;
priv->interactive = TRUE;
priv->protect = FALSE;
+ priv->program = NULL;
priv->thread = NULL;
priv->event_queue = NULL;
priv->event_lock = NULL;
g_mutex_unlock(priv->abort_lock);
g_mutex_free(priv->abort_lock);
priv->abort_lock = NULL;
-
+
G_OBJECT_CLASS(chimara_glk_parent_class)->finalize(object);
}
/* For now, just pass the size request on to the root Glk window */
if(priv->root_window) {
GtkWidget *child = ((winid_t)(priv->root_window->data))->frame;
- if(GTK_WIDGET_VISIBLE(child))
+ if(GTK_WIDGET_VISIBLE(child))
gtk_widget_size_request(child, requisition);
} else {
requisition->width = CHIMARA_GLK_MIN_WIDTH;
static void
chimara_glk_stopped(ChimaraGlk *self)
{
- /* TODO: Add default signal handler implementation here */
+ ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(self);
+
+ /* Free the plugin */
+ if( priv->program && !g_module_close(priv->program) )
+ g_warning( "Error closing module: %s", g_module_error() );
}
static void
/* PUBLIC FUNCTIONS */
+/**
+ * chimara_glk_new:
+ *
+ * Creates and initializes a new #ChimaraGlk widget.
+ *
+ * Return value: a #ChimaraGlk widget, with a floating reference.
+ */
GtkWidget *
chimara_glk_new(void)
{
return GTK_WIDGET(self);
}
+/**
+ * chimara_glk_set_interactive:
+ * @glk: a #ChimaraGlk widget
+ * @interactive: whether the widget should expect user input
+ *
+ * Sets the #ChimaraGlk:interactive property of @glk. A Glk widget is normally
+ * interactive, but in non-interactive mode, keyboard and mouse input is ignored
+ * and the Glk program is controlled by chimara_glk_feed_text(). "More" prompts
+ * when a lot of text is printed to a text buffer are also disabled. This is
+ * typically used when you wish to control an interpreter program by feeding it
+ * a predefined list of commands.
+ */
void
chimara_glk_set_interactive(ChimaraGlk *glk, gboolean interactive)
{
priv->interactive = interactive;
}
+/**
+ * chimara_glk_get_interactive:
+ * @glk: a #ChimaraGlk widget
+ *
+ * Returns whether @glk is interactive (expecting user input). See
+ * chimara_glk_set_interactive().
+ *
+ * Return value: %TRUE if @glk is interactive.
+ */
gboolean
chimara_glk_get_interactive(ChimaraGlk *glk)
{
return priv->interactive;
}
+/**
+ * chimara_glk_set_protect:
+ * @glk: a #ChimaraGlk widget
+ * @protect: whether the widget should allow the Glk program to do file
+ * operations
+ *
+ * Sets the #ChimaraGlk:protect property of @glk. In protect mode, the Glk
+ * program is not allowed to do file operations.
+ */
void
chimara_glk_set_protect(ChimaraGlk *glk, gboolean protect)
{
priv->protect = protect;
}
+/**
+ * chimara_glk_get_protect:
+ * @glk: a #ChimaraGlk widget
+ *
+ * Returns whether @glk is in protect mode (banned from doing file operations).
+ * See chimara_glk_set_protect().
+ *
+ * Return value: %TRUE if @glk is in protect mode.
+ */
gboolean
chimara_glk_get_protect(ChimaraGlk *glk)
{
return priv->protect;
}
-/* glk_enter() is called to create a new thread in which glk_main() runs. */
+/* glk_enter() is the actual function called in the new thread in which glk_main() runs. */
static gpointer
-glk_enter(gpointer glk)
+glk_enter(gpointer glk_main)
{
extern ChimaraGlkPrivate *glk_data;
-
- glk_data = CHIMARA_GLK_PRIVATE((ChimaraGlk *)glk);
- glk_main();
+ g_signal_emit_by_name(glk_data->self, "started");
+ ((glk_main_t)glk_main)();
+ g_signal_emit_by_name(glk_data->self, "stopped");
return NULL;
}
+/**
+ * chimara_glk_run:
+ * @glk: a #ChimaraGlk widget
+ * @plugin: path to a plugin module compiled with glk.h
+ * @error: location to store a #GError, or %NULL
+ *
+ * Opens a Glk program compiled as a plugin and runs its glk_main() function in
+ * a separate thread. On failure, returns %FALSE and sets @error.
+ *
+ * Return value: %TRUE if the Glk program was started successfully.
+ */
gboolean
-chimara_glk_run(ChimaraGlk *glk, GError **error)
+chimara_glk_run(ChimaraGlk *glk, gchar *plugin, GError **error)
{
g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
-
+ g_return_val_if_fail(plugin, FALSE);
+
ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
+
+ /* Open the module to run */
+ glk_main_t glk_main;
+ g_assert( g_module_supported() );
+ priv->program = g_module_open(plugin, G_MODULE_BIND_LAZY);
+
+ if(!priv->program)
+ {
+ g_warning( "Error opening module: %s", g_module_error() );
+ return FALSE;
+ }
+ if( !g_module_symbol(priv->program, "glk_main", (gpointer *) &glk_main) )
+ {
+ g_warning( "Error finding glk_main(): %s", g_module_error() );
+ return FALSE;
+ }
+
+ extern ChimaraGlkPrivate *glk_data;
+ /* Set the thread's private data */
+ /* TODO: Do this with a GPrivate */
+ glk_data = priv;
+
/* Run in a separate thread */
- priv->thread = g_thread_create(glk_enter, glk, TRUE, error);
+ priv->thread = g_thread_create(glk_enter, glk_main, TRUE, error);
+
return !(priv->thread == NULL);
}
+/**
+ * chimara_glk_stop:
+ * @glk: a #ChimaraGlk widget
+ *
+ * Signals the Glk program running in @glk to abort. Note that if the program is
+ * caught in an infinite loop in which glk_tick() is not called, this may not
+ * work.
+ */
void
chimara_glk_stop(ChimaraGlk *glk)
{
g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
-
- /* TODO */
+ /* TODO: check if glk is actually running a program */
+ signal_abort();
}
+/**
+ * chimara_glk_wait:
+ * @glk: a #ChimaraGlk widget
+ *
+ * Holds up the main thread and waits for the Glk program running in @glk to
+ * finish.
+ */
void
chimara_glk_wait(ChimaraGlk *glk)
{
+ g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
+
ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
g_thread_join(priv->thread);
}
\ No newline at end of file
projects / rodin / chimara.git / blobdiff