X-Git-Url: https://git.stderr.nl/gitweb?a=blobdiff_plain;f=src%2Fchimara-glk.c;h=4bc1c156bc83f6e75148faa3876460f5b8934416;hb=3c678195610789166e1133575789f25da8f1a291;hp=4484e81f87092b915f0e68cd1db4c402b70210e6;hpb=2f48cae403429be0396f2b7bef0ba6d5d2bdc02f;p=rodin%2Fchimara.git

diff --git a/src/chimara-glk.c b/src/chimara-glk.c
index 4484e81..4bc1c15 100644
--- a/src/chimara-glk.c
+++ b/src/chimara-glk.c
@@ -12,6 +12,31 @@
 #define CHIMARA_GLK_MIN_WIDTH 0
 #define CHIMARA_GLK_MIN_HEIGHT 0
 
+/**
+ * SECTION:chimara-glk
+ * @short_description: Widget which executes a Glk program
+ * @stability: Unstable
+ * @include: chimara/chimara-glk.h
+ * 
+ * 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.
+ *
+ * On Linux systems, this is a file with a name like 
+ * <filename>plugin.so</filename>. For portability, you can use libtool and 
+ * automake:
+ * <informalexample><programlisting>
+ * pkglib_LTLIBRARIES = plugin.la
+ * plugin_la_SOURCES = plugin.c foo.c bar.c
+ * plugin_la_LDFLAGS = -module -shared -avoid-version -export-symbols-regex "^glk_main$$"
+ * </programlisting></informalexample>
+ * This will produce <filename>plugin.la</filename> which is a text file 
+ * containing the correct plugin file to open (see the relevant section of the
+ * <ulink 
+ * url="http://www.gnu.org/software/libtool/manual/html_node/Finding-the-dlname.html">
+ * Libtool manual</ulink>).
+ */
+
 typedef void (* glk_main_t) (void);
 
 enum {
@@ -130,7 +155,7 @@ chimara_glk_size_request(GtkWidget *widget, GtkRequisition *requisition)
     /* 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;
@@ -206,10 +231,24 @@ chimara_glk_class_init(ChimaraGlkClass *klass)
     /* Signals */
     klass->stopped = chimara_glk_stopped;
     klass->started = chimara_glk_started;
+    /**
+     * 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.
+     */ 
     chimara_glk_signals[STOPPED] = g_signal_new("stopped", 
         G_OBJECT_CLASS_TYPE(klass), 0, 
         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.
+	 */
 	chimara_glk_signals[STARTED] = g_signal_new ("started",
 		G_OBJECT_CLASS_TYPE (klass), 0,
 		G_STRUCT_OFFSET(ChimaraGlkClass, started), NULL, NULL,
@@ -222,12 +261,28 @@ chimara_glk_class_init(ChimaraGlkClass *klass)
         TRUE,
         G_PARAM_READABLE | G_PARAM_WRITABLE | G_PARAM_LAX_VALIDATION |
         G_PARAM_STATIC_NAME | G_PARAM_STATIC_NICK | G_PARAM_STATIC_BLURB);
+    /**
+     * ChimaraGlk:interactive:
+     *
+     * Sets whether the widget is interactive. A Glk widget is normally 
+     * interactive, but in non-interactive mode, keyboard and mouse input are 
+     * 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.
+     */
     g_object_class_install_property(object_class, PROP_INTERACTIVE, pspec);
     pspec = g_param_spec_boolean("protect", _("Protected"),
         _("Whether the Glk program is barred from doing file operations"),
         FALSE,
         G_PARAM_READABLE | G_PARAM_WRITABLE | G_PARAM_LAX_VALIDATION |
         G_PARAM_STATIC_NAME | G_PARAM_STATIC_NICK | G_PARAM_STATIC_BLURB);
+    /**
+     * ChimaraGlk:protect:
+     *
+     * Sets whether the Glk program is allowed to do file operations. In protect
+     * mode, all file operations will fail.
+     */
     g_object_class_install_property(object_class, PROP_PROTECT, pspec);
     
     /* Private data */
@@ -236,6 +291,13 @@ chimara_glk_class_init(ChimaraGlkClass *klass)
 
 /* 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)
 {
@@ -251,6 +313,13 @@ 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. 
+ */
 void 
 chimara_glk_set_interactive(ChimaraGlk *glk, gboolean interactive)
 {
@@ -260,6 +329,15 @@ 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 
+ * #ChimaraGlk:interactive.
+ *
+ * Return value: %TRUE if @glk is interactive.
+ */
 gboolean 
 chimara_glk_get_interactive(ChimaraGlk *glk)
 {
@@ -269,6 +347,15 @@ 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)
 {
@@ -278,6 +365,15 @@ 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 #ChimaraGlk:protect.
+ *
+ * Return value: %TRUE if @glk is in protect mode.
+ */
 gboolean 
 chimara_glk_get_protect(ChimaraGlk *glk)
 {
@@ -298,6 +394,19 @@ glk_enter(gpointer glk_main)
 	return NULL;
 }
 
+/**
+ * chimara_glk_run:
+ * @glk: a #ChimaraGlk widget
+ * @plugin: path to a plugin module compiled with <filename 
+ * class="header">glk.h</filename>
+ * @error: location to store a <link linkend="glib-GError">GError</link>, 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, gchar *plugin, GError **error)
 {
@@ -333,17 +442,34 @@ chimara_glk_run(ChimaraGlk *glk, gchar *plugin, GError **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: 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
+}