* 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>
PROP_SPACING,
PROP_PROGRAM_NAME,
PROP_PROGRAM_INFO,
- PROP_STORY_NAME
+ PROP_STORY_NAME,
+ PROP_RUNNING
};
enum {
static void
chimara_glk_init(ChimaraGlk *self)
{
- GTK_WIDGET_SET_FLAGS(GTK_WIDGET(self), GTK_NO_WINDOW);
+ chimara_init(); /* This is a library entry point */
+
+ gtk_widget_set_has_window(GTK_WIDGET(self), FALSE);
ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(self);
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();
case PROP_STORY_NAME:
g_value_set_string(value, priv->story_name);
break;
+ case PROP_RUNNING:
+ g_value_set_boolean(value, priv->running);
+ break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
}
/* Unref input queues (this should destroy them since any Glk thread has stopped by now */
g_async_queue_unref(priv->char_input_queue);
g_async_queue_unref(priv->line_input_queue);
+ /* Destroy callback data if ownership retained */
+ if(priv->resource_load_callback_destroy_data)
+ priv->resource_load_callback_destroy_data(priv->resource_load_callback_data);
/* Free other stuff */
g_free(priv->current_dir);
G_OBJECT_CLASS(chimara_glk_parent_class)->finalize(object);
}
-/* Internal function: Recursively get the Glk window tree's size request */
+/* Implementation of get_request_mode(): Always request constant size */
+static GtkSizeRequestMode
+chimara_glk_get_request_mode(GtkWidget *widget)
+{
+ return GTK_SIZE_REQUEST_CONSTANT_SIZE;
+}
+
+/* Minimal implementation of width request. Allocation in Glk is
+strictly top-down, so we just request our current size by returning 1. */
static void
-request_recurse(winid_t win, GtkRequisition *requisition, guint spacing)
+chimara_glk_get_preferred_width(GtkWidget *widget, int *minimal, int *natural)
{
- if(win->type == wintype_Pair)
- {
- /* Get children's size requests */
- GtkRequisition child1, child2;
- request_recurse(win->window_node->children->data, &child1, spacing);
- request_recurse(win->window_node->children->next->data, &child2, spacing);
+ g_return_if_fail(widget || CHIMARA_IS_GLK(widget));
+ g_return_if_fail(minimal);
+ g_return_if_fail(natural);
- glui32 division = win->split_method & winmethod_DivisionMask;
- glui32 direction = win->split_method & winmethod_DirMask;
-
- /* If the split is fixed, get the size of the fixed child */
- if(division == winmethod_Fixed)
- {
- switch(direction)
- {
- case winmethod_Left:
- child1.width = win->key_window?
- win->constraint_size * win->key_window->unit_width
- : 0;
- break;
- case winmethod_Right:
- child2.width = win->key_window?
- win->constraint_size * win->key_window->unit_width
- : 0;
- break;
- case winmethod_Above:
- child1.height = win->key_window?
- win->constraint_size * win->key_window->unit_height
- : 0;
- break;
- case winmethod_Below:
- child2.height = win->key_window?
- win->constraint_size * win->key_window->unit_height
- : 0;
- break;
- }
- }
-
- /* Add the children's requests */
- switch(direction)
- {
- case winmethod_Left:
- case winmethod_Right:
- requisition->width = child1.width + child2.width + spacing;
- 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;
- break;
- }
- }
-
- /* For non-pair windows, just use the size that GTK requests */
- else
- gtk_widget_size_request(win->frame, requisition);
+ *minimal = *natural = 1;
}
-/* Overrides gtk_widget_size_request */
+/* Minimal implementation of height request. Allocation in Glk is
+strictly top-down, so we just request our current size by returning 1. */
static void
-chimara_glk_size_request(GtkWidget *widget, GtkRequisition *requisition)
+chimara_glk_get_preferred_height(GtkWidget *widget, int *minimal, int *natural)
{
- g_return_if_fail(widget);
- g_return_if_fail(requisition);
- g_return_if_fail(CHIMARA_IS_GLK(widget));
-
- ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(widget);
-
- /* For now, just pass the size request on to the root Glk window */
- if(priv->root_window)
- {
- request_recurse(priv->root_window->data, requisition, priv->spacing);
- requisition->width += 2 * GTK_CONTAINER(widget)->border_width;
- requisition->height += 2 * GTK_CONTAINER(widget)->border_width;
- }
- else
- {
- requisition->width = CHIMARA_GLK_MIN_WIDTH + 2 * GTK_CONTAINER(widget)->border_width;
- requisition->height = CHIMARA_GLK_MIN_HEIGHT + 2 * GTK_CONTAINER(widget)->border_width;
- }
+ g_return_if_fail(widget || CHIMARA_IS_GLK(widget));
+ g_return_if_fail(minimal);
+ g_return_if_fail(natural);
+
+ *minimal = *natural = 1;
}
/* Recursively give the Glk windows their allocated space. Returns a window
{
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;
}
/* It says in the spec that when a text grid window is resized smaller,
the bottom or right area is thrown away; when it is resized larger, the
bottom or right area is filled with blanks. */
- glui32 newwidth = (glui32)(win->widget->allocation.width / win->unit_width);
- glui32 newheight = (glui32)(win->widget->allocation.height / win->unit_height);
- gint line;
- GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
- GtkTextIter start, end;
-
- for(line = 0; line < win->height; line++)
+ GtkAllocation widget_allocation;
+ gtk_widget_get_allocation(win->widget, &widget_allocation);
+ glui32 new_width = (glui32)(widget_allocation.width / win->unit_width);
+ glui32 new_height = (glui32)(widget_allocation.height / win->unit_height);
+
+ if(new_width != win->width || new_height != win->height)
{
- gtk_text_buffer_get_iter_at_line(textbuffer, &start, line);
- /* If this line is going to fall off the bottom, delete it */
- if(line >= newheight)
- {
- end = start;
- gtk_text_iter_forward_to_line_end(&end);
- gtk_text_iter_forward_char(&end);
- gtk_text_buffer_delete(textbuffer, &start, &end);
- break;
+ // Window has changed size, trim or expand the textbuffer if necessary.
+ GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
+ GtkTextIter start, end;
+
+ // Add or remove lines
+ if(new_height == 0) {
+ gtk_text_buffer_get_start_iter(buffer, &start);
+ gtk_text_buffer_get_end_iter(buffer, &end);
+ gtk_text_buffer_delete(buffer, &start, &end);
}
- /* If this line is not long enough, add spaces on the end */
- if(newwidth > win->width)
+ else if(new_height < win->height)
{
- gchar *spaces = g_strnfill(newwidth - win->width, ' ');
+ // Remove surplus lines
+ gtk_text_buffer_get_end_iter(buffer, &end);
+ gtk_text_buffer_get_iter_at_line(buffer, &start, new_height-1);
gtk_text_iter_forward_to_line_end(&start);
- gtk_text_buffer_insert(textbuffer, &start, spaces, -1);
- g_free(spaces);
+ gtk_text_buffer_delete(buffer, &start, &end);
+
}
- /* But if it's too long, delete characters from the end */
- else if(newwidth < win->width)
+ else if(new_height > win->height)
{
+ // Add extra lines
+ gint lines_to_add = new_height - win->height;
+ gtk_text_buffer_get_end_iter(buffer, &end);
+ start = end;
+
+ gchar *blanks = g_strnfill(win->width, ' ');
+ gchar **blanklines = g_new0(gchar *, lines_to_add + 1);
+ int count;
+ for(count = 0; count < lines_to_add; count++)
+ blanklines[count] = blanks;
+ blanklines[lines_to_add] = NULL;
+ gchar *vertical_blanks = g_strjoinv("\n", blanklines);
+ g_free(blanklines);
+ g_free(blanks);
+
+ if(win->height > 0)
+ gtk_text_buffer_insert(buffer, &end, "\n", 1);
+
+ gtk_text_buffer_insert(buffer, &end, vertical_blanks, -1);
+ }
+
+ // Trim or expand lines
+ if(new_width < win->width) {
+ gtk_text_buffer_get_start_iter(buffer, &start);
end = start;
- gtk_text_iter_forward_chars(&start, newwidth);
- gtk_text_iter_forward_to_line_end(&end);
- gtk_text_buffer_delete(textbuffer, &start, &end);
+
+ gint line;
+ for(line = 0; line <= new_height; line++) {
+ // Trim the line
+ gtk_text_iter_forward_cursor_positions(&start, new_width);
+ gtk_text_iter_forward_to_line_end(&end);
+ gtk_text_buffer_delete(buffer, &start, &end);
+ gtk_text_iter_forward_line(&start);
+ end = start;
+ }
+ } else if(new_width > win->width) {
+ gint chars_to_add = new_width - win->width;
+ gchar *horizontal_blanks = g_strnfill(chars_to_add, ' ');
+
+ gtk_text_buffer_get_start_iter(buffer, &start);
+ end = start;
+
+ gint line;
+ for(line = 0; line <= new_height; line++) {
+ gtk_text_iter_forward_to_line_end(&start);
+ end = start;
+ gint start_offset = gtk_text_iter_get_offset(&start);
+ gtk_text_buffer_insert(buffer, &end, horizontal_blanks, -1);
+ gtk_text_buffer_get_iter_at_offset(buffer, &start, start_offset);
+ gtk_text_iter_forward_line(&start);
+ end = start;
+ }
+
+ g_free(horizontal_blanks);
}
- /* Note: if the widths are equal, do nothing */
- }
- /* Add blank lines if there aren't enough lines to fit the new size */
- if(newheight > win->height)
- {
- gchar *blanks = g_strnfill(win->width, ' ');
- gchar **blanklines = g_new0(gchar *, (newheight - win->height) + 1);
- int count;
- for(count = 0; count < newheight - win->height; count++)
- blanklines[count] = blanks;
- blanklines[newheight - win->height] = NULL;
- gchar *text = g_strjoinv("\n", blanklines);
- g_free(blanklines); /* not g_strfreev() */
- g_free(blanks);
-
- gtk_text_buffer_get_end_iter(textbuffer, &start);
- gtk_text_buffer_insert(textbuffer, &start, "\n", -1);
- gtk_text_buffer_insert(textbuffer, &start, text, -1);
- g_free(text);
}
- gboolean arrange = !(win->width == newwidth && win->height == newheight);
- win->width = newwidth;
- win->height = newheight;
+ gboolean arrange = !(win->width == new_width && win->height == new_height);
+ win->width = new_width;
+ win->height = new_height;
return arrange? win : NULL;
}
ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(widget);
- widget->allocation = *allocation;
-
+ gtk_widget_set_allocation(widget, allocation);
+
if(priv->root_window) {
- GtkAllocation child;
- child.x = allocation->x + GTK_CONTAINER(widget)->border_width;
- child.y = allocation->y + GTK_CONTAINER(widget)->border_width;
- child.width = CLAMP(allocation->width - 2 * GTK_CONTAINER(widget)->border_width, 0, allocation->width);
- child.height = CLAMP(allocation->height - 2 * GTK_CONTAINER(widget)->border_width, 0, allocation->height);
+ GtkAllocation child = *allocation;
winid_t arrange = allocate_recurse(priv->root_window->data, &child, priv->spacing);
-
+
/* arrange points to a window that contains all text grid and graphics
windows which have been resized */
g_mutex_lock(priv->arrange_lock);
/* Default signal handler */
}
-/* COMPAT: G_PARAM_STATIC_STRINGS only appeared in GTK 2.13.0 */
-#ifndef G_PARAM_STATIC_STRINGS
-
-/* COMPAT: G_PARAM_STATIC_NAME and friends only appeared in GTK 2.8 */
-#if GTK_CHECK_VERSION(2,8,0)
-#define G_PARAM_STATIC_STRINGS (G_PARAM_STATIC_NAME | G_PARAM_STATIC_NICK | G_PARAM_STATIC_BLURB)
-#else
-#define G_PARAM_STATIC_STRINGS (0)
-#endif
-
-#endif
-
static void
chimara_glk_class_init(ChimaraGlkClass *klass)
{
object_class->finalize = chimara_glk_finalize;
GtkWidgetClass *widget_class = GTK_WIDGET_CLASS(klass);
- widget_class->size_request = chimara_glk_size_request;
+ widget_class->get_request_mode = chimara_glk_get_request_mode;
+ widget_class->get_preferred_width = chimara_glk_get_preferred_width;
+ widget_class->get_preferred_height = chimara_glk_get_preferred_height;
widget_class->size_allocate = chimara_glk_size_allocate;
GtkContainerClass *container_class = GTK_CONTAINER_CLASS(klass);
container_class->forall = chimara_glk_forall;
+ /* Automatically handle the GtkContainer:border-width property */
+ gtk_container_class_handle_border_width(container_class);
/* Signals */
klass->stopped = chimara_glk_stopped;
_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"),
NULL,
G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
+ /**
+ * ChimaraGlk:running:
+ *
+ * Whether this Glk widget is currently running a game or not.
+ */
+ g_object_class_install_property(object_class, PROP_RUNNING,
+ g_param_spec_boolean("running", _("Running"),
+ _("Whether there is a program currently running"),
+ FALSE,
+ G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
+
/* Private data */
g_type_class_add_private(klass, sizeof(ChimaraGlkPrivate));
}
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;
g_assert( g_module_supported() );
/* If there is already a module loaded, free it first -- you see, we want to
* keep modules loaded as long as possible to avoid crashes in stack unwinding */
- if( priv->program && !g_module_close(priv->program) )
- g_warning( "Error closing module :%s", g_module_error() );
+ chimara_glk_unload_plugin(glk);
/* Open the module to run */
priv->program = g_module_open(plugin, G_MODULE_BIND_LAZY);
return !(priv->thread == NULL);
}
+/**
+ * chimara_glk_run_file:
+ * @self: a #ChimaraGlk widget
+ * @plugin_file: a #GFile pointing to a plugin module compiled with <filename
+ * class="header">glk.h</filename>
+ * @argc: Number of command line arguments in @argv
+ * @argv: Array of command line arguments to pass to the plugin
+ * @error: location to store a <link
+ * linkend="glib-Error-Reporting">GError</link>, or %NULL
+ *
+ * Opens a Glk program compiled as a plugin, from a #GFile. See
+ * chimara_glk_run() for details.
+ *
+ * Return value: %TRUE if the Glk program was started successfully.
+ */
+gboolean
+chimara_glk_run_file(ChimaraGlk *self, GFile *plugin_file, int argc, char *argv[], GError **error)
+{
+ g_return_val_if_fail(self || CHIMARA_IS_GLK(self), FALSE);
+ g_return_val_if_fail(plugin_file || G_IS_FILE(plugin_file), FALSE);
+ g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
+
+ char *path = g_file_get_path(plugin_file);
+ gboolean retval = chimara_glk_run(self, path, argc, argv, error);
+ g_free(path);
+
+ return retval;
+}
+
/**
* 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.
+ *
+ * This function does nothing if no Glk program is running.
*/
void
chimara_glk_stop(ChimaraGlk *glk)
*
* Holds up the main thread and waits for the Glk program running in @glk to
* finish.
+ *
+ * This function does nothing if no Glk program is running.
*/
void
chimara_glk_wait(ChimaraGlk *glk)
gdk_threads_enter();
}
+/**
+ * chimara_glk_unload_plugin:
+ * @glk: a #ChimaraGlk widget
+ *
+ * The plugin containing the Glk program is unloaded as late as possible before
+ * loading a new plugin, in order to prevent crashes while printing stack
+ * backtraces during debugging. Sometimes this behavior is not desirable. This
+ * function forces @glk to unload the plugin running in it.
+ *
+ * This function does nothing if there is no plugin loaded.
+ */
+void
+chimara_glk_unload_plugin(ChimaraGlk *glk)
+{
+ g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
+ CHIMARA_GLK_USE_PRIVATE(glk, priv);
+ if( priv->program && !g_module_close(priv->program) )
+ g_warning( "Error closing module :%s", g_module_error() );
+}
+
/**
* chimara_glk_get_running:
* @glk: a #ChimaraGlk widget
/**
* 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>
+ *
+ * Returns: (transfer none): The #GtkTextTag corresponding to @name in the
+ * styles of @window.
*/
-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
- *
- * Retrieves the possible tag names to use in #chimara_glk_get_tag.
- */
-const gchar**
-chimara_glk_get_tag_names(ChimaraGlk *glk)
-{
- return style_get_tag_names();
-}
-
-/**
- * chimara_glk_get_num_tag_names:
+ * chimara_glk_get_tag_names:
* @glk: a #ChimaraGlk widget
+ * @num_tags: Return location for the number of tag names retrieved.
+ *
+ * Retrieves the possible tag names to use in chimara_glk_get_tag().
*
- * Retrieves the number of style tags returned by #chimara_glk_get_tag_names.
+ * Returns: (transfer none) (array length=num_tags) (element-type utf8):
+ * Array of strings containing the tag names. This array is owned by Chimara,
+ * do not free it.
*/
-gint
-chimara_glk_get_num_tag_names(ChimaraGlk *glk)
+const gchar **
+chimara_glk_get_tag_names(ChimaraGlk *glk, unsigned int *num_tags)
{
- return CHIMARA_NUM_STYLES;
+ g_return_val_if_fail(num_tags != NULL, NULL);
+
+ *num_tags = CHIMARA_NUM_STYLES;
+ return style_get_tag_names();
}
/**
*
* 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)
* @glk: a #ChimaraGlk widget
* @func: a function to call for loading resources, or %NULL
* @user_data: user data to pass to @func, or %NULL
+ * @destroy_user_data: a function to call for freeing @user_data, 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
* Note that @func is only called if no Blorb resource map has been set; having
* a resource map in place overrides this function.
*
+ * If you pass non-%NULL for @destroy_user_data, then @glk takes ownership of
+ * @user_data. When it is not needed anymore, it will be freed by calling
+ * @destroy_user_data on it. If you wish to retain ownership of @user_data, pass
+ * %NULL for @destroy_user_data.
+ *
* 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_set_resource_load_callback(ChimaraGlk *glk, ChimaraResourceLoadFunc func, gpointer user_data, GDestroyNotify destroy_user_data)
{
CHIMARA_GLK_USE_PRIVATE(glk, priv);
+
+ if(priv->resource_load_callback == func
+ && priv->resource_load_callback_data == user_data
+ && priv->resource_load_callback_destroy_data == destroy_user_data)
+ return;
+
+ if(priv->resource_load_callback_destroy_data)
+ priv->resource_load_callback_destroy_data(priv->resource_load_callback_data);
+
priv->resource_load_callback = func;
priv->resource_load_callback_data = user_data;
+ priv->resource_load_callback_destroy_data = destroy_user_data;
}
projects / projects / chimara / chimara.git / blobdiff