Wrote documentation for new functions
[projects/chimara/chimara.git] / libchimara / chimara-glk.c
index b9e0437e3249a48eda74b6016eb2ace27a020e71..45031d9178767b51c63bbf535d67c1a2c9552be3 100644 (file)
@@ -2,16 +2,19 @@
 
 #include <math.h>
 #include <gtk/gtk.h>
-#include <glib/gi18n.h>
+#include <config.h>
+#include <glib/gi18n-lib.h>
 #include <gmodule.h>
 #include <pango/pango.h>
 #include "chimara-glk.h"
 #include "chimara-glk-private.h"
+#include "chimara-marshallers.h"
 #include "glk.h"
 #include "abort.h"
 #include "window.h"
 #include "glkstart.h"
 #include "glkunix.h"
+#include "init.h"
 
 #define CHIMARA_GLK_MIN_WIDTH 0
 #define CHIMARA_GLK_MIN_HEIGHT 0
@@ -22,7 +25,7 @@
  * @stability: Unstable
  * @include: chimara/chimara-glk.h
  * 
- * The ChimaraGlk widget opens and runs a Glk program. The program must be
+ * The #ChimaraGlk widget opens and runs a Glk program. The program must be
  * compiled as a plugin module, with a function <function>glk_main()</function>
  * that the Glk library can hook into.
  *
@@ -56,6 +59,10 @@ enum {
 enum {
        STOPPED,
        STARTED,
+       WAITING,
+       CHAR_INPUT,
+       LINE_INPUT,
+       TEXT_BUFFER_OUTPUT,
 
        LAST_SIGNAL
 };
@@ -76,16 +83,20 @@ chimara_glk_init(ChimaraGlk *self)
     priv->protect = FALSE;
        priv->default_font_desc = pango_font_description_from_string("Sans");
        priv->monospace_font_desc = pango_font_description_from_string("Monospace");
+       priv->css_file = "style.css";
+       priv->default_styles = g_new0(StyleSet,1);
+       priv->current_styles = g_new0(StyleSet,1);
+       priv->running = FALSE;
     priv->program = NULL;
     priv->thread = NULL;
-    priv->event_queue = NULL;
-    priv->event_lock = NULL;
-    priv->event_queue_not_empty = NULL;
-    priv->event_queue_not_full = NULL;
-    priv->abort_lock = NULL;
+    priv->event_queue = g_queue_new();
+    priv->event_lock = g_mutex_new();
+    priv->event_queue_not_empty = g_cond_new();
+    priv->event_queue_not_full = g_cond_new();
+    priv->abort_lock = g_mutex_new();
     priv->abort_signalled = FALSE;
-       priv->arrange_lock = NULL;
-       priv->rearranged = NULL;
+       priv->arrange_lock = g_mutex_new();
+       priv->rearranged = g_cond_new();
        priv->needs_rearrange = FALSE;
        priv->ignore_next_arrange_event = FALSE;
     priv->interrupt_handler = NULL;
@@ -168,14 +179,14 @@ chimara_glk_finalize(GObject *object)
        g_mutex_unlock(priv->event_lock);
        g_mutex_free(priv->event_lock);
        
-       /* Free the abort signalling mechanism */
+       /* Free the abort signaling mechanism */
        g_mutex_lock(priv->abort_lock);
        /* Make sure no other thread is busy with this */
        g_mutex_unlock(priv->abort_lock);
        g_mutex_free(priv->abort_lock);
        priv->abort_lock = NULL;
 
-       /* Free the window arrangement signalling */
+       /* Free the window arrangement signaling */
        g_mutex_lock(priv->arrange_lock);
        g_cond_free(priv->rearranged);
        g_mutex_unlock(priv->arrange_lock);
@@ -186,6 +197,7 @@ chimara_glk_finalize(GObject *object)
        pango_font_description_free(priv->default_font_desc);
        pango_font_description_free(priv->monospace_font_desc);
        g_free(priv->current_dir);
+       g_hash_table_destroy(priv->default_styles);
        
     G_OBJECT_CLASS(chimara_glk_parent_class)->finalize(object);
 }
@@ -484,7 +496,7 @@ chimara_glk_size_allocate(GtkWidget *widget, GtkAllocation *allocation)
                if(!priv->ignore_next_arrange_event)
                {
                        if(arrange)
-                               event_throw(evtype_Arrange, arrange == priv->root_window->data? NULL : arrange, 0, 0);
+                               event_throw(CHIMARA_GLK(widget), evtype_Arrange, arrange == priv->root_window->data? NULL : arrange, 0, 0);
                }
                else
                        priv->ignore_next_arrange_event = FALSE;
@@ -527,7 +539,8 @@ chimara_glk_forall(GtkContainer *container, gboolean include_internals, GtkCallb
 static void
 chimara_glk_stopped(ChimaraGlk *self)
 {
-    ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(self);
+    CHIMARA_GLK_USE_PRIVATE(self, priv);
+    priv->running = FALSE;
 
     /* Free the plugin */
        if( priv->program && !g_module_close(priv->program) )
@@ -537,7 +550,32 @@ chimara_glk_stopped(ChimaraGlk *self)
 static void
 chimara_glk_started(ChimaraGlk *self)
 {
-       /* TODO: Add default signal handler implementation here */
+       CHIMARA_GLK_USE_PRIVATE(self, priv);
+       priv->running = TRUE;
+}
+
+static void
+chimara_glk_waiting(ChimaraGlk *self)
+{
+       /* Default signal handler */
+}
+
+static void
+chimara_glk_char_input(ChimaraGlk *self, guint window_rock, guint keysym)
+{
+       /* Default signal handler */
+}
+
+static void
+chimara_glk_line_input(ChimaraGlk *self, guint window_rock, gchar *text)
+{
+       /* Default signal handler */
+}
+
+static void
+chimara_glk_text_buffer_output(ChimaraGlk *self, guint window_rock, gchar *text)
+{
+       /* Default signal handler */
 }
 
 /* G_PARAM_STATIC_STRINGS only appeared in GTK 2.13.0 */
@@ -564,28 +602,85 @@ chimara_glk_class_init(ChimaraGlkClass *klass)
     /* Signals */
     klass->stopped = chimara_glk_stopped;
     klass->started = chimara_glk_started;
+    klass->waiting = chimara_glk_waiting;
+    klass->char_input = chimara_glk_char_input;
+    klass->line_input = chimara_glk_line_input;
+    klass->text_buffer_output = chimara_glk_text_buffer_output;
     /**
      * ChimaraGlk::stopped:
      * @glk: The widget that received the signal
      *
-     * The ::stopped signal is emitted when the a Glk program finishes
-     * executing in the widget, whether it ended normally, or was interrupted.
+     * Emitted when the a Glk program finishes executing in the widget, whether
+     * it ended normally, or was interrupted.
      */ 
     chimara_glk_signals[STOPPED] = g_signal_new("stopped", 
         G_OBJECT_CLASS_TYPE(klass), 0, 
+        /* FIXME: Should be G_SIGNAL_RUN_CLEANUP but that segfaults??! */
         G_STRUCT_OFFSET(ChimaraGlkClass, stopped), NULL, NULL,
                g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
        /**
         * ChimaraGlk::started:
         * @glk: The widget that received the signal
         *
-        * The ::started signal is emitted when a Glk program starts executing in
-        * the widget.
+        * Emitted when a Glk program starts executing in the widget.
         */
        chimara_glk_signals[STARTED] = g_signal_new ("started",
-               G_OBJECT_CLASS_TYPE (klass), 0,
+               G_OBJECT_CLASS_TYPE(klass), 0,
                G_STRUCT_OFFSET(ChimaraGlkClass, started), NULL, NULL,
                g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
+       /**
+        * ChimaraGlk::waiting:
+        * @glk: The widget that received the signal
+        * 
+        * Emitted when glk_select() is called by the Glk program and the event
+        * queue is empty, which means that the widget is waiting for input.
+        */
+       chimara_glk_signals[WAITING] = g_signal_new("waiting",
+               G_OBJECT_CLASS_TYPE(klass), 0,
+               G_STRUCT_OFFSET(ChimaraGlkClass, waiting), NULL, NULL,
+               g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
+       /**
+        * ChimaraGlk::char-input:
+        * @glk: The widget that received the signal
+        * @window_rock: The rock value of the window that received character input
+        * (see <link linkend="chimara-Rocks">Rocks</link>)
+        * @keysym: The key that was typed, in the form of a key symbol from 
+        * <filename class="headerfile">gdk/gdkkeysyms.h</filename>
+        * 
+        * Emitted when a Glk window receives character input.
+        */
+       chimara_glk_signals[CHAR_INPUT] = g_signal_new("char-input",
+               G_OBJECT_CLASS_TYPE(klass), 0,
+               G_STRUCT_OFFSET(ChimaraGlkClass, char_input), NULL, NULL,
+               chimara_marshal_VOID__UINT_UINT,
+               G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_UINT);
+       /**
+        * ChimaraGlk::line-input:
+        * @glk: The widget that received the signal
+        * @window_rock: The rock value of the window that received line input (see
+        * <link linkend="chimara-Rocks">Rocks</link>)
+        * @text: The text that was typed
+        * 
+        * Emitted when a Glk window receives line input.
+        */
+       chimara_glk_signals[LINE_INPUT] = g_signal_new("line-input",
+               G_OBJECT_CLASS_TYPE(klass), 0,
+               G_STRUCT_OFFSET(ChimaraGlkClass, line_input), NULL, NULL,
+               chimara_marshal_VOID__UINT_STRING,
+               G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_STRING);
+       /**
+        * ChimaraGlk::text-buffer-output:
+        * @glk: The widget that received the signal
+        * @window_rock: The rock value of the window that was printed to (see <link
+        * linkend="chimara-Rocks">Rocks</link>)
+        * 
+        * Emitted when text is printed to a text buffer window.
+        */
+       chimara_glk_signals[TEXT_BUFFER_OUTPUT] = g_signal_new("text-buffer-output",
+               G_OBJECT_CLASS_TYPE(klass), 0,
+               G_STRUCT_OFFSET(ChimaraGlkClass, text_buffer_output), NULL, NULL,
+               chimara_marshal_VOID__UINT_STRING,
+               G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_STRING);
 
     /* Properties */
     /**
@@ -663,6 +758,21 @@ chimara_glk_class_init(ChimaraGlkClass *klass)
 
 /* PUBLIC FUNCTIONS */
 
+/**
+ * chimara_error_quark:
+ *
+ * The error domain for errors from Chimara widgets.
+ *
+ * Returns: The string <quote>chimara-error-quark</quote> as a <link 
+ * linkend="GQuark">GQuark</link>.
+ */
+GQuark
+chimara_error_quark(void)
+{
+       chimara_init(); /* This is a library entry point */
+       return g_quark_from_static_string("chimara-error-quark");
+}
+
 /**
  * chimara_glk_new:
  *
@@ -673,18 +783,10 @@ chimara_glk_class_init(ChimaraGlkClass *klass)
 GtkWidget *
 chimara_glk_new(void)
 {
-    ChimaraGlk *self = CHIMARA_GLK(g_object_new(CHIMARA_TYPE_GLK, NULL));
-    ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(self);
-    
-    priv->event_queue = g_queue_new();
-    priv->event_lock = g_mutex_new();
-    priv->event_queue_not_empty = g_cond_new();
-    priv->event_queue_not_full = g_cond_new();
-    priv->abort_lock = g_mutex_new();
-       priv->arrange_lock = g_mutex_new();
-       priv->rearranged = g_cond_new();
-    
-    return GTK_WIDGET(self);
+       /* This is a library entry point; initialize the library */
+       chimara_init();
+
+    return GTK_WIDGET(g_object_new(CHIMARA_TYPE_GLK, NULL));
 }
 
 /**
@@ -929,19 +1031,21 @@ struct StartupData {
        glk_main_t glk_main;
        glkunix_startup_code_t glkunix_startup_code;
        glkunix_startup_t args;
+       ChimaraGlkPrivate *glk_data;
 };
 
 /* glk_enter() is the actual function called in the new thread in which glk_main() runs.  */
 static gpointer
 glk_enter(struct StartupData *startup)
 {
-    extern ChimaraGlkPrivate *glk_data;
+       extern GPrivate *glk_data_key;
+       g_private_set(glk_data_key, startup->glk_data);
        
        /* Run startup function */
        if(startup->glkunix_startup_code) {
-               glk_data->in_startup = TRUE;
+               startup->glk_data->in_startup = TRUE;
                int result = startup->glkunix_startup_code(&startup->args);
-               glk_data->in_startup = FALSE;
+               startup->glk_data->in_startup = FALSE;
                
                int i = 0;
                while(i < startup->args.argc)
@@ -953,10 +1057,10 @@ glk_enter(struct StartupData *startup)
        }
        
        /* Run main function */
-    g_signal_emit_by_name(glk_data->self, "started");
+    g_signal_emit_by_name(startup->glk_data->self, "started");
        (startup->glk_main)();
-       g_slice_free(struct StartupData, startup);      
-       g_signal_emit_by_name(glk_data->self, "stopped");
+       g_signal_emit_by_name(startup->glk_data->self, "stopped");
+       g_slice_free(struct StartupData, startup);
        return NULL;
 }
 
@@ -981,7 +1085,7 @@ glk_enter(struct StartupData *startup)
  * Return value: %TRUE if the Glk program was started successfully.
  */
 gboolean
-chimara_glk_run(ChimaraGlk *glk, gchar *plugin, int argc, char *argv[], GError **error)
+chimara_glk_run(ChimaraGlk *glk, const gchar *plugin, int argc, char *argv[], GError **error)
 {
     g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
     g_return_val_if_fail(plugin, FALSE);
@@ -995,12 +1099,12 @@ chimara_glk_run(ChimaraGlk *glk, gchar *plugin, int argc, char *argv[], GError *
     
     if(!priv->program)
     {
-        g_warning( "Error opening module: %s", g_module_error() );
+       g_set_error(error, CHIMARA_ERROR, CHIMARA_LOAD_MODULE_ERROR, _("Error opening module: %s"), g_module_error());
         return FALSE;
     }
     if( !g_module_symbol(priv->program, "glk_main", (gpointer *) &startup->glk_main) )
     {
-        g_warning( "Error finding glk_main(): %s", g_module_error() );
+       g_set_error(error, CHIMARA_ERROR, CHIMARA_NO_GLK_MAIN, _("Error finding glk_main(): %s"), g_module_error());
         return FALSE;
     }
 
@@ -1019,11 +1123,7 @@ chimara_glk_run(ChimaraGlk *glk, gchar *plugin, int argc, char *argv[], GError *
                /* Set the program name */
                startup->args.argv[0] = g_strdup(plugin);
     }
-
-       extern ChimaraGlkPrivate *glk_data;
-    /* Set the thread's private data */
-    /* TODO: Do this with a GPrivate */
-    glk_data = priv;
+       startup->glk_data = priv;
        
     /* Run in a separate thread */
        priv->thread = g_thread_create((GThreadFunc)glk_enter, startup, TRUE, error);
@@ -1043,8 +1143,18 @@ void
 chimara_glk_stop(ChimaraGlk *glk)
 {
     g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
-    /* TODO: check if glk is actually running a program */
-       signal_abort();
+    CHIMARA_GLK_USE_PRIVATE(glk, priv);
+    /* Don't do anything if not running a program */
+    if(!priv->running)
+       return;
+    
+       if(priv->abort_lock) {
+               g_mutex_lock(priv->abort_lock);
+               priv->abort_signalled = TRUE;
+               g_mutex_unlock(priv->abort_lock);
+               /* Stop blocking on the event queue condition */
+               event_throw(glk, evtype_Abort, NULL, 0, 0);
+       }
 }
 
 /**
@@ -1058,7 +1168,26 @@ void
 chimara_glk_wait(ChimaraGlk *glk)
 {
     g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
-    
-    ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
+    CHIMARA_GLK_USE_PRIVATE(glk, priv);
+    /* Don't do anything if not running a program */
+    if(!priv->running)
+       return;
     g_thread_join(priv->thread);
 }
+
+/**
+ * chimara_glk_get_running:
+ * @glk: a #ChimaraGlk widget
+ * 
+ * Use this function to tell whether a program is currently running in the
+ * widget.
+ * 
+ * Returns: %TRUE if @glk is executing a Glk program, %FALSE otherwise.
+ */
+gboolean
+chimara_glk_get_running(ChimaraGlk *glk)
+{
+       g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
+       CHIMARA_GLK_USE_PRIVATE(glk, priv);
+       return priv->running;
+}