Merge branch 'master' of github.com:wmvanvliet/Chimara

[projects/chimara/chimara.git] / libchimara / chimara-glk.c

diff --git a/libchimara/chimara-glk.c b/libchimara/chimara-glk.c
index 5cdf63eba1ab7d64a241380d76d86f73cd7cb5dc..ca01f44510d7c7dd86a0db2fa9698385cea1197b 100644 (file)
--- a/libchimara/chimara-glk.c
+++ b/libchimara/chimara-glk.c
@@ -11,6 +11,7 @@
 #include <glib/gi18n-lib.h>
 #include <gmodule.h>
 #include <pango/pango.h>
+#include <gio/gio.h>
 #include "chimara-glk.h"
 #include "chimara-glk-private.h"
 #include "chimara-marshallers.h"
@@ -178,9 +179,12 @@ chimara_glk_init(ChimaraGlk *self)
        priv->char_input_queue = g_async_queue_new();
        priv->line_input_queue = g_async_queue_new();
        /* Should be g_async_queue_new_full(g_free); but only in GTK >= 2.16 */
+       priv->resource_map = NULL;
        priv->resource_lock = g_mutex_new();
        priv->resource_loaded = g_cond_new();
        priv->resource_info_available = g_cond_new();
+       priv->resource_load_callback = NULL;
+       priv->resource_load_callback_data = NULL;
        priv->image_cache = NULL;
        priv->program_name = NULL;
        priv->program_info = NULL;
@@ -1362,8 +1366,8 @@ chimara_glk_feed_char_input(ChimaraGlk *glk, guint keyval)
  * request. @text does not need to end with a newline. You can call this 
  * function even when no window has requested line input, in which case the text
  * will be saved for the following window that requests line input. This has the 
- * disadvantage that if more than one window has requested character input, it 
- * is arbitrary which one gets the text.
+ * disadvantage that if more than one window has requested line input, it is
+ * arbitrary which one gets the text.
  */
 void 
 chimara_glk_feed_line_input(ChimaraGlk *glk, const gchar *text)
@@ -1375,6 +1379,40 @@ chimara_glk_feed_line_input(ChimaraGlk *glk, const gchar *text)
        event_throw(glk, evtype_ForcedLineInput, NULL, 0, 0);
 }
 
+/**
+ * chimara_glk_is_char_input_pending:
+ * @glk: a #ChimaraGlk widget
+ *
+ * Use this function to tell if character input forced by 
+ * chimara_glk_feed_char_input() has been passed to an input request or not.
+ *
+ * Returns: %TRUE if forced character input is pending, %FALSE otherwise.
+ */
+gboolean
+chimara_glk_is_char_input_pending(ChimaraGlk *glk)
+{
+       g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
+       CHIMARA_GLK_USE_PRIVATE(glk, priv);
+       return g_async_queue_length(priv->char_input_queue) > 0;
+}
+
+/**
+ * chimara_glk_is_line_input_pending:
+ * @glk: a #ChimaraGlk widget
+ *
+ * Use this function to tell if line input forced by 
+ * chimara_glk_feed_line_input() has been passed to an input request or not.
+ *
+ * Returns: %TRUE if forced line input is pending, %FALSE otherwise.
+ */
+gboolean
+chimara_glk_is_line_input_pending(ChimaraGlk *glk)
+{
+       g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
+       CHIMARA_GLK_USE_PRIVATE(glk, priv);
+       return g_async_queue_length(priv->line_input_queue) > 0;
+}
+
 /**
  * chimara_glk_get_tag:
  * @glk: a #ChimarGlk widget
@@ -1470,3 +1508,30 @@ chimara_glk_update_style(ChimaraGlk *glk)
        g_mutex_unlock(priv->arrange_lock);
        gtk_widget_queue_resize( GTK_WIDGET(priv->self) );
 }
+
+/**
+ * chimara_glk_set_resource_load_callback:
+ * @glk: a #ChimaraGlk widget
+ * @func: a function to call for loading resources, or %NULL
+ * @user_data: user data to pass to @func, or %NULL
+ *
+ * Sometimes it is preferable to load image and sound resources from somewhere
+ * else than a Blorb file, for example while developing a game. Section 14 of
+ * the <ulink url="http://eblong.com/zarf/blorb/blorb.html#s14">Blorb
+ * specification</ulink> allows for this possibility. This function sets @func
+ * to be called when the Glk program requests loading an image or sound without
+ * a Blorb resource map having been loaded, optionally passing @user_data as an 
+ * extra parameter.
+ *
+ * Note that @func is only called if no Blorb resource map has been set; having
+ * a resource map in place overrides this function.
+ *
+ * To deactivate the callback, call this function with @func set to %NULL.
+ */
+void
+chimara_glk_set_resource_load_callback(ChimaraGlk *glk, ChimaraResourceLoadFunc func, gpointer user_data)
+{
+       CHIMARA_GLK_USE_PRIVATE(glk, priv);
+       priv->resource_load_callback = func;
+       priv->resource_load_callback_data = user_data;
+}