Implemented garglk_set_program_name(), garglk_set_program_info(), garglk_set_story_name()

git-svn-id: http://lassie.dyndns-server.com/svn/gargoyle-gtk@257 ddfedd41-794f-dd11-ae45-00112f111e67

diff --git a/libchimara/chimara-glk-private.h b/libchimara/chimara-glk-private.h
index 7b00d0a5b76ace09316839b06d7e2477ac64edd5..6743ecd3aa41d7862a4da5af42beb6da780eeb25 100644 (file)
--- a/libchimara/chimara-glk-private.h
+++ b/libchimara/chimara-glk-private.h
@@ -69,6 +69,10 @@ struct _ChimaraGlkPrivate {
        guint32 resource_available;
 
        /* *** Glk library data *** */
+       /* Info about current plugin */
+       gchar *program_name;
+       gchar *program_info;
+       gchar *story_name;
     /* User-defined interrupt handler */
     void (*interrupt_handler)(void);
     /* Global tree of all windows */

diff --git a/libchimara/chimara-glk.c b/libchimara/chimara-glk.c
index f0d946d87a9f7be77df5c74cdb51d08dd1e0d84d..59f99ac8f4c9069b450d3f42c193667cdeb93f9d 100644 (file)
--- a/libchimara/chimara-glk.c
+++ b/libchimara/chimara-glk.c
@@ -125,6 +125,9 @@ enum {
     PROP_INTERACTIVE,
     PROP_PROTECT,
        PROP_SPACING,
+       PROP_PROGRAM_NAME,
+       PROP_PROGRAM_INFO,
+       PROP_STORY_NAME
 };
 
 enum {
@@ -178,6 +181,9 @@ chimara_glk_init(ChimaraGlk *self)
        priv->resource_loaded = g_cond_new();
        priv->resource_info_available = g_cond_new();
        priv->image_cache = NULL;
+       priv->program_name = NULL;
+       priv->program_info = NULL;
+       priv->story_name = NULL;
        priv->interrupt_handler = NULL;
     priv->root_window = NULL;
     priv->fileref_list = NULL;
@@ -227,7 +233,16 @@ chimara_glk_get_property(GObject *object, guint prop_id, GValue *value, GParamSp
                case PROP_SPACING:
                        g_value_set_uint(value, priv->spacing);
                        break;
-        default:
+               case PROP_PROGRAM_NAME:
+                       g_value_set_string(value, priv->program_name);
+                       break;
+               case PROP_PROGRAM_INFO:
+                       g_value_set_string(value, priv->program_info);
+                       break;
+               case PROP_STORY_NAME:
+                       g_value_set_string(value, priv->story_name);
+                       break;
+               default:
             G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
     }
 }
@@ -286,6 +301,9 @@ chimara_glk_finalize(GObject *object)
        
        /* Free other stuff */
        g_free(priv->current_dir);
+       g_free(priv->program_name);
+       g_free(priv->program_info);
+       g_free(priv->story_name);
 
        /* Chain up to parent */
     G_OBJECT_CLASS(chimara_glk_parent_class)->finalize(object);
@@ -630,6 +648,12 @@ chimara_glk_stopped(ChimaraGlk *self)
 {
     CHIMARA_GLK_USE_PRIVATE(self, priv);
     priv->running = FALSE;
+    priv->program_name = NULL;
+    g_object_notify(G_OBJECT(self), "program-name");
+    priv->program_info = NULL;
+    g_object_notify(G_OBJECT(self), "program-info");
+    priv->story_name = NULL;
+    g_object_notify(G_OBJECT(self), "story-name");
 }
 
 static void
@@ -815,7 +839,54 @@ chimara_glk_class_init(ChimaraGlkClass *klass)
                0, G_MAXUINT, 0,
                G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
        
-    /* Private data */
+       /**
+        * ChimaraGlk:program-name:
+        *
+        * The name of the currently running Glk program. You cannot set this 
+        * property yourself. It is set to the filename of the plugin when you call
+        * chimara_glk_run(), but the plugin can change it by calling 
+        * garglk_set_program_name(). To find out when this information changes,
+        * for example to put the program name in the title bar of a window, connect
+        * to the <code>::notify::program-name</code> signal.
+        */
+       g_object_class_install_property(object_class, PROP_PROGRAM_NAME,
+               g_param_spec_string("program-name", _("Program name"),
+               _("Name of the currently running program"),
+               NULL,
+               G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
+               
+       /**
+        * ChimaraGlk:program-info:
+        *
+        * Information about the currently running Glk program. You cannot set this
+        * property yourself. The plugin can change it by calling
+        * garglk_set_program_info(). See also #ChimaraGlk:program-name.
+        */
+       g_object_class_install_property(object_class, PROP_PROGRAM_INFO,
+               g_param_spec_string("program-info", _("Program info"),
+               _("Information about the currently running program"),
+               NULL,
+               G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
+       
+       /**
+        * ChimaraGlk:story-name:
+        *
+        * The name of the story currently running in the Glk interpreter. You
+        * cannot set this property yourself. It is set to the story filename when
+        * you call chimara_if_run_game(), but the plugin can change it by calling
+        * garglk_set_story_name().
+        *
+        * Strictly speaking, this should be a property of #ChimaraIF, but it is
+        * legal for any Glk program to call garglk_set_story_name(), even if it is
+        * not an interpreter and does not load story files.
+        */
+       g_object_class_install_property(object_class, PROP_STORY_NAME,
+               g_param_spec_string("story-name", _("Story name"),
+               _("Name of the story currently loaded in the interpreter"),
+               NULL,
+               G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
+       
+       /* Private data */
     g_type_class_add_private(klass, sizeof(ChimaraGlkPrivate));
 }
 
@@ -1159,11 +1230,15 @@ chimara_glk_run(ChimaraGlk *glk, const gchar *plugin, int argc, char *argv[], GE
                        startup->args.argv = g_new0(gchar *, 1);
                }
 
-               /* Set the program name */
+               /* Set the program invocation name */
                startup->args.argv[0] = g_strdup(plugin);
     }
        startup->glk_data = priv;
        
+       /* Set the program name */
+       priv->program_name = g_path_get_basename(plugin);
+       g_object_notify(G_OBJECT(glk), "program-name");
+       
     /* Run in a separate thread */
        priv->thread = g_thread_create((GThreadFunc)glk_enter, startup, TRUE, error);
        

diff --git a/libchimara/chimara-if.c b/libchimara/chimara-if.c
index cb0f425f012afd47c5382012ef765b560c901781..2c26fbf7290c748ad25be18edb5a077b2f05065b 100644 (file)
--- a/libchimara/chimara-if.c
+++ b/libchimara/chimara-if.c
@@ -6,6 +6,7 @@
 #include <glib/gi18n-lib.h>
 #include "chimara-if.h"
 #include "chimara-glk.h"
+#include "chimara-glk-private.h"
 #include "chimara-marshallers.h"
 #include "init.h"
 
@@ -642,7 +643,14 @@ chimara_if_run_game(ChimaraIF *self, gchar *gamefile, GError **error)
        GSList *ptr;
        for(count = 0, ptr = args; ptr; count++, ptr = g_slist_next(ptr))
                argv[count] = ptr->data;
-
+               
+       /* Set the story name */
+       /* We peek into ChimaraGlk's private data here, because GObject has no
+       equivalent to "protected" */
+       CHIMARA_GLK_USE_PRIVATE(self, glk_priv);
+       glk_priv->story_name = g_path_get_basename(gamefile);
+       g_object_notify(G_OBJECT(self), "story-name");
+       
        gboolean retval = chimara_glk_run(CHIMARA_GLK(self), pluginpath, argc, argv, error);
        g_free(argv);
        if(terpnumstr)

diff --git a/libchimara/garglk.c b/libchimara/garglk.c
index b72fc5979e8d1c1929d442e9fffa28a45e5e81f8..1a657ec81a9b4e3d642c6a63dae8f53d24208d7e 100644 (file)
--- a/libchimara/garglk.c
+++ b/libchimara/garglk.c
@@ -32,13 +32,13 @@ garglk_fileref_get_name(frefid_t fref)
  * — for example, in the title bar of a window. A typical use of this
  * function would be:
  * |[ garglk_set_program_name("SuperGlkFrotz 0.1"); ]|
- *
- * <warning><para>This function is not currently implemented.</para></warning>
  */
 void 
 garglk_set_program_name(const char *name)
 {
-       WARNING(_("Not implemented"));
+       ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
+       glk_data->program_name = g_strdup(name);
+       g_object_notify(G_OBJECT(glk_data->self), "program-name");
 }
 
 /**
@@ -56,13 +56,13 @@ garglk_set_program_name(const char *name)
  *     "Glk port by Tor Andersson\n"
  *     "Animation, networking, and evil AI by Sven Metcalfe");
  * ]|
- *
- * <warning><para>This function is not currently implemented.</para></warning>
  */
 void 
 garglk_set_program_info(const char *info)
 {
-       WARNING(_("Not implemented"));
+       ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
+       glk_data->program_info = g_strdup(info);
+       g_object_notify(G_OBJECT(glk_data->self), "program-info");
 }
 
 /**
@@ -75,13 +75,14 @@ garglk_set_program_info(const char *info)
  * anywhere &mdash; for example, in the title bar of a window. A typical use of
  * this function would be:
  * |[ garglk_set_story_name("Lighan Ses Lion, el Zarf"); ]|
- *
- * <warning><para>This function is not currently implemented.</para></warning>
  */
 void 
 garglk_set_story_name(const char *name)
 {
-       WARNING(_("Not implemented"));
+       g_printerr("garglk_set_story_name(\"%s\");\n", name);
+       ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
+       glk_data->story_name = g_strdup(name);
+       g_object_notify(G_OBJECT(glk_data->self), "story-name");
 }
 
 /**