#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"
* SECTION:chimara-glk
* @short_description: Widget which executes a Glk program
* @stability: Unstable
- * @include: libchimara/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>
priv->ignore_next_arrange_event = FALSE;
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 */
+ /* FIXME 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;
g_free(priv->program_name);
g_free(priv->program_info);
g_free(priv->story_name);
+ g_free(priv->styles);
+ g_free(priv->glk_styles);
/* Chain up to parent */
G_OBJECT_CLASS(chimara_glk_parent_class)->finalize(object);
glui32 division = win->split_method & winmethod_DivisionMask;
glui32 direction = win->split_method & winmethod_DirMask;
-
+ unsigned border = ((win->split_method & winmethod_BorderMask) == winmethod_NoBorder)? 0 : spacing;
+
/* If the split is fixed, get the size of the fixed child */
if(division == winmethod_Fixed)
{
{
case winmethod_Left:
case winmethod_Right:
- requisition->width = child1.width + child2.width + spacing;
+ requisition->width = child1.width + child2.width + border;
requisition->height = MAX(child1.height, child2.height);
break;
case winmethod_Above:
case winmethod_Below:
requisition->width = MAX(child1.width, child2.width);
- requisition->height = child1.height + child2.height + spacing;
+ requisition->height = child1.height + child2.height + border;
break;
}
}
{
glui32 division = win->split_method & winmethod_DivisionMask;
glui32 direction = win->split_method & winmethod_DirMask;
+ unsigned border = ((win->split_method & winmethod_BorderMask) == winmethod_NoBorder)? 0 : spacing;
/* If the space gets too small to honor the spacing property, then just
ignore spacing in this window and below. */
- if( (spacing > allocation->width && (direction == winmethod_Left || direction == winmethod_Right))
- || (spacing > allocation->height && (direction == winmethod_Above || direction == winmethod_Below)) )
- spacing = 0;
+ if( (border > allocation->width && (direction == winmethod_Left || direction == winmethod_Right))
+ || (border > allocation->height && (direction == winmethod_Above || direction == winmethod_Below)) )
+ border = 0;
GtkAllocation child1, child2;
child1.x = allocation->x;
{
case winmethod_Left:
child1.width = win->key_window?
- CLAMP(win->constraint_size * win->key_window->unit_width, 0, allocation->width - spacing)
+ CLAMP(win->constraint_size * win->key_window->unit_width, 0, allocation->width - border)
: 0;
break;
case winmethod_Right:
child2.width = win->key_window?
- CLAMP(win->constraint_size * win->key_window->unit_width, 0, allocation->width - spacing)
+ CLAMP(win->constraint_size * win->key_window->unit_width, 0, allocation->width - border)
: 0;
break;
case winmethod_Above:
child1.height = win->key_window?
- CLAMP(win->constraint_size * win->key_window->unit_height, 0, allocation->height - spacing)
+ CLAMP(win->constraint_size * win->key_window->unit_height, 0, allocation->height - border)
: 0;
break;
case winmethod_Below:
child2.height = win->key_window?
- CLAMP(win->constraint_size * win->key_window->unit_height, 0, allocation->height - spacing)
+ CLAMP(win->constraint_size * win->key_window->unit_height, 0, allocation->height - border)
: 0;
break;
}
switch(direction)
{
case winmethod_Left:
- child1.width = MAX(0, (gint)ceil(fraction * (allocation->width - spacing)) );
+ child1.width = MAX(0, (gint)ceil(fraction * (allocation->width - border)) );
break;
case winmethod_Right:
- child2.width = MAX(0, (gint)ceil(fraction * (allocation->width - spacing)) );
+ child2.width = MAX(0, (gint)ceil(fraction * (allocation->width - border)) );
break;
case winmethod_Above:
- child1.height = MAX(0, (gint)ceil(fraction * (allocation->height - spacing)) );
+ child1.height = MAX(0, (gint)ceil(fraction * (allocation->height - border)) );
break;
case winmethod_Below:
- child2.height = MAX(0, (gint)ceil(fraction * (allocation->height - spacing)) );
+ child2.height = MAX(0, (gint)ceil(fraction * (allocation->height - border)) );
break;
}
}
switch(direction)
{
case winmethod_Left:
- child2.width = MAX(0, allocation->width - spacing - child1.width);
- child2.x = child1.x + child1.width + spacing;
+ child2.width = MAX(0, allocation->width - border - child1.width);
+ child2.x = child1.x + child1.width + border;
child2.y = child1.y;
child1.height = child2.height = allocation->height;
break;
case winmethod_Right:
- child1.width = MAX(0, allocation->width - spacing - child2.width);
- child2.x = child1.x + child1.width + spacing;
+ child1.width = MAX(0, allocation->width - border - child2.width);
+ child2.x = child1.x + child1.width + border;
child2.y = child1.y;
child1.height = child2.height = allocation->height;
break;
case winmethod_Above:
- child2.height = MAX(0, allocation->height - spacing - child1.height);
+ child2.height = MAX(0, allocation->height - border - child1.height);
child2.x = child1.x;
- child2.y = child1.y + child1.height + spacing;
+ child2.y = child1.y + child1.height + border;
child1.width = child2.width = allocation->width;
break;
case winmethod_Below:
- child1.height = MAX(0, allocation->height - spacing - child2.height);
+ child1.height = MAX(0, allocation->height - border - child2.height);
child2.x = child1.x;
- child2.y = child1.y + child1.height + spacing;
+ child2.y = child1.y + child1.height + border;
child1.width = child2.width = allocation->width;
break;
}
_chimara_marshal_VOID__UINT_STRING,
G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_STRING);
/**
- * ChimaraGlk::iliad-update-screen:
+ * ChimaraGlk::iliad-screen-update:
* @self: The widget that received the signal
* @typing: Whether to perform a typing or full screen update
*
/**
* ChimaraGlk:spacing:
*
- * The amount of space between the Glk windows.
+ * The amount of space between the Glk windows. This space forms a visible
+ * border between windows; however, if you open a window using the
+ * %winmethod_NoBorder flag, there will be no spacing between it and its
+ * sibling window, no matter what the value of this property is.
*/
g_object_class_install_property(object_class, PROP_SPACING,
g_param_spec_uint("spacing", _("Spacing"),
int fd = open(filename, O_RDONLY);
if(fd == -1) {
- *error = g_error_new(G_IO_ERROR, g_io_error_from_errno(errno),
- _("Error opening file \"%s\": %s"), filename, g_strerror(errno));
+ if(error)
+ *error = g_error_new(G_IO_ERROR, g_io_error_from_errno(errno),
+ _("Error opening file \"%s\": %s"), filename, g_strerror(errno));
return FALSE;
}
scan_css_file(scanner, glk);
if(close(fd) == -1) {
- *error = g_error_new(G_IO_ERROR, g_io_error_from_errno(errno),
- _("Error closing file \"%s\": %s"), filename, g_strerror(errno));
+ if(error)
+ *error = g_error_new(G_IO_ERROR, g_io_error_from_errno(errno),
+ _("Error closing file \"%s\": %s"), filename, g_strerror(errno));
return FALSE;
}
return TRUE;
* 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)
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
+ * @glk: a #ChimaraGlk widget
* @window: The type of window to retrieve the tag for
* @name: The name of the tag to retrieve
*
* Use this function to get a #GtkTextTag so style properties can be changed.
- * See also #chimara_glk_set_css_from_string.
+ * See also chimara_glk_set_css_from_string().
*
* The layout of the text in Chimara is controlled by two sets of tags: one set
* describing the style in text buffers and one for text grids. See also the
- * GLK specification for the difference between the two. The main narrative of
+ * Glk specification for the difference between the two. The main narrative of
* a game is usually rendered in text buffers, whereas text grids are mostly
* used for status bars and in game menus.
*
* <listitem><para>user2</para></listitem>
* <listitem><para>hyperlink</para></listitem>
* <listitem><para>pager</para></listitem>
- * </itenizedlist>
+ * </itemizedlist>
*/
-GtkTextTag*
+GtkTextTag *
chimara_glk_get_tag(ChimaraGlk *glk, ChimaraGlkWindowType window, const gchar *name)
{
CHIMARA_GLK_USE_PRIVATE(glk, priv);
}
/**
- * chimara_glk_get_tag:
- * @glk: a #ChimarGlk widget
+ * chimara_glk_get_tag_names:
+ * @glk: a #ChimaraGlk widget
*
- * Retrieves the possible tag names to use in #chimara_glk_get_tag.
+ * Retrieves the possible tag names to use in chimara_glk_get_tag().
*/
-const gchar**
+const gchar **
chimara_glk_get_tag_names(ChimaraGlk *glk)
{
return style_get_tag_names();
* chimara_glk_get_num_tag_names:
* @glk: a #ChimaraGlk widget
*
- * Retrieves the number of style tags returned by #chimara_glk_get_tag_names.
+ * Retrieves the number of style tags returned by chimara_glk_get_tag_names().
*/
gint
chimara_glk_get_num_tag_names(ChimaraGlk *glk)
*
* Processes style updates and updates the widget to reflect the new style.
* Call this every time you change a property of a #GtkTextTag retrieved by
- * #chimara_glk_get_tag.
+ * chimara_glk_get_tag().
*/
void
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;
+}