1 /* licensing and copyright information here */
11 #include <glib/gi18n-lib.h>
13 #include <pango/pango.h>
15 #include "chimara-glk.h"
16 #include "chimara-glk-private.h"
17 #include "chimara-marshallers.h"
28 #define CHIMARA_GLK_MIN_WIDTH 0
29 #define CHIMARA_GLK_MIN_HEIGHT 0
33 * @short_description: Widget which executes a Glk program
34 * @stability: Unstable
36 * The #ChimaraGlk widget opens and runs a Glk program. The program must be
37 * compiled as a plugin module, with a function <function>glk_main()</function>
38 * that the Glk library can hook into.
40 * On Linux systems, this is a file with a name like
41 * <filename>plugin.so</filename>. For portability, you can use libtool and
44 * pkglib_LTLIBRARIES = plugin.la
45 * plugin_la_SOURCES = plugin.c foo.c bar.c
46 * plugin_la_LDFLAGS = -module -shared -avoid-version -export-symbols-regex "^glk_main$$"
48 * This will produce <filename>plugin.la</filename> which is a text file
49 * containing the correct plugin file to open (see the relevant section of the
51 * url="http://www.gnu.org/software/libtool/manual/html_node/Finding-the-dlname.html">
52 * Libtool manual</ulink>).
54 * You need to initialize multithreading in any program you use a #ChimaraGlk
55 * widget in. This means including the following incantation at the beginning
58 * if(!g_thread_supported())
59 * g_thread_init(NULL);
62 * This initialization must take place <emphasis>before</emphasis> the call to
63 * gtk_init(). In addition to this, you must also protect your call to
64 * gtk_main() by calling gdk_threads_enter() right before it, and
65 * gdk_threads_leave() right after it.
67 * The following sample program shows how to initialize and construct a simple
68 * GTK window that runs a Glk program:
71 * #include <gtk/gtk.h>
72 * #include <libchimara/chimara-glk.h>
75 * main(int argc, char *argv[])
77 * GtkWidget *window, *glk;
78 * GError *error = NULL;
79 * gchar *plugin_argv[] = { "plugin.so", "-option" };
81 * /<!---->* Initialize threads and GTK *<!---->/
82 * if(!g_thread_supported())
83 * g_thread_init(NULL);
85 * gtk_init(&argc, &argv);
87 * /<!---->* Construct the window and its contents. We quit the GTK main loop
88 * * when the window's close button is clicked. *<!---->/
89 * window = gtk_window_new(GTK_WINDOW_TOPLEVEL);
90 * g_signal_connect(window, "delete-event", G_CALLBACK(gtk_main_quit), NULL);
91 * glk = chimara_glk_new();
92 * gtk_container_add(GTK_CONTAINER(window), glk);
93 * gtk_widget_show_all(window);
95 * /<!---->* Add a reference to the ChimaraGlk widget, since we want it to
96 * * persist after the window's delete-event -- otherwise it will be destroyed
97 * * with the window. *<!---->/
100 * /<!---->* Start the Glk program in a separate thread *<!---->/
101 * if(!chimara_glk_run(CHIMARA_GLK(glk), "./plugin.so", 2, plugin_argv, &error))
102 * g_error("Error starting Glk library: %s\n", error->message);
104 * /<!---->* Start the GTK main loop *<!---->/
105 * gdk_threads_enter();
107 * gdk_threads_leave();
109 * /<!---->* After the GTK main loop exits, signal the Glk program to shut down if
110 * * it is still running, and wait for it to exit. *<!---->/
111 * chimara_glk_stop(CHIMARA_GLK(glk));
112 * chimara_glk_wait(CHIMARA_GLK(glk));
113 * g_object_unref(glk);
120 typedef void (* glk_main_t) (void);
121 typedef int (* glkunix_startup_code_t) (glkunix_startup_t*);
146 static guint chimara_glk_signals[LAST_SIGNAL] = { 0 };
148 G_DEFINE_TYPE(ChimaraGlk, chimara_glk, GTK_TYPE_CONTAINER);
151 chimara_glk_init(ChimaraGlk *self)
153 chimara_init(); /* This is a library entry point */
155 gtk_widget_set_has_window(GTK_WIDGET(self), FALSE);
157 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(self);
160 priv->interactive = TRUE;
161 priv->styles = g_new0(StyleSet,1);
162 priv->glk_styles = g_new0(StyleSet,1);
163 priv->final_message = g_strdup("[ The game has finished ]");
164 priv->event_queue = g_queue_new();
165 priv->char_input_queue = g_async_queue_new();
166 priv->line_input_queue = g_async_queue_new();
167 /* FIXME Should be g_async_queue_new_full(g_free); but only in GTK >= 2.16 */
169 g_mutex_init(&priv->event_lock);
170 g_mutex_init(&priv->abort_lock);
171 g_mutex_init(&priv->shutdown_lock);
172 g_mutex_init(&priv->arrange_lock);
173 g_mutex_init(&priv->resource_lock);
175 g_cond_init(&priv->event_queue_not_empty);
176 g_cond_init(&priv->event_queue_not_full);
177 g_cond_init(&priv->shutdown_key_pressed);
178 g_cond_init(&priv->rearranged);
179 g_cond_init(&priv->resource_loaded);
180 g_cond_init(&priv->resource_info_available);
186 chimara_glk_set_property(GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
188 ChimaraGlk *glk = CHIMARA_GLK(object);
192 case PROP_INTERACTIVE:
193 chimara_glk_set_interactive( glk, g_value_get_boolean(value) );
196 chimara_glk_set_protect( glk, g_value_get_boolean(value) );
199 chimara_glk_set_spacing( glk, g_value_get_uint(value) );
202 G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
207 chimara_glk_get_property(GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
209 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(object);
213 case PROP_INTERACTIVE:
214 g_value_set_boolean(value, priv->interactive);
217 g_value_set_boolean(value, priv->protect);
220 g_value_set_uint(value, priv->spacing);
222 case PROP_PROGRAM_NAME:
223 g_value_set_string(value, priv->program_name);
225 case PROP_PROGRAM_INFO:
226 g_value_set_string(value, priv->program_info);
228 case PROP_STORY_NAME:
229 g_value_set_string(value, priv->story_name);
232 g_value_set_boolean(value, priv->running);
235 G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
240 chimara_glk_finalize(GObject *object)
242 ChimaraGlk *self = CHIMARA_GLK(object);
243 CHIMARA_GLK_USE_PRIVATE(self, priv);
244 priv->after_finalize = TRUE;
246 /* Free widget properties */
247 g_free(priv->final_message);
249 g_hash_table_destroy(priv->styles->text_buffer);
250 g_hash_table_destroy(priv->styles->text_grid);
251 g_hash_table_destroy(priv->glk_styles->text_buffer);
252 g_hash_table_destroy(priv->glk_styles->text_grid);
254 /* Free the event queue */
255 g_mutex_lock(&priv->event_lock);
256 g_queue_foreach(priv->event_queue, (GFunc)g_free, NULL);
257 g_queue_free(priv->event_queue);
258 g_cond_clear(&priv->event_queue_not_empty);
259 g_cond_clear(&priv->event_queue_not_full);
260 priv->event_queue = NULL;
261 g_mutex_unlock(&priv->event_lock);
262 g_mutex_clear(&priv->event_lock);
264 /* Free the abort signaling mechanism */
265 g_mutex_lock(&priv->abort_lock);
266 /* Make sure no other thread is busy with this */
267 g_mutex_unlock(&priv->abort_lock);
268 g_mutex_clear(&priv->abort_lock);
270 /* Free the shutdown keypress signaling mechanism */
271 g_mutex_lock(&priv->shutdown_lock);
272 g_cond_clear(&priv->shutdown_key_pressed);
273 g_mutex_unlock(&priv->shutdown_lock);
274 g_mutex_clear(&priv->shutdown_lock);
276 /* Free the window arrangement signaling */
277 g_mutex_lock(&priv->arrange_lock);
278 g_cond_clear(&priv->rearranged);
279 g_mutex_unlock(&priv->arrange_lock);
280 g_mutex_clear(&priv->arrange_lock);
282 g_mutex_lock(&priv->resource_lock);
283 g_cond_clear(&priv->resource_loaded);
284 g_cond_clear(&priv->resource_info_available);
285 g_mutex_unlock(&priv->resource_lock);
286 g_mutex_clear(&priv->resource_lock);
287 g_slist_foreach(priv->image_cache, (GFunc)clear_image_cache, NULL);
288 g_slist_free(priv->image_cache);
289 /* Unref input queues (this should destroy them since any Glk thread has stopped by now */
290 g_async_queue_unref(priv->char_input_queue);
291 g_async_queue_unref(priv->line_input_queue);
292 /* Destroy callback data if ownership retained */
293 if(priv->resource_load_callback_destroy_data)
294 priv->resource_load_callback_destroy_data(priv->resource_load_callback_data);
296 /* Free other stuff */
297 g_free(priv->current_dir);
298 g_free(priv->program_name);
299 g_free(priv->program_info);
300 g_free(priv->story_name);
301 g_free(priv->styles);
302 g_free(priv->glk_styles);
304 /* Chain up to parent */
305 G_OBJECT_CLASS(chimara_glk_parent_class)->finalize(object);
308 /* Implementation of get_request_mode(): Always request constant size */
309 static GtkSizeRequestMode
310 chimara_glk_get_request_mode(GtkWidget *widget)
312 return GTK_SIZE_REQUEST_CONSTANT_SIZE;
315 /* Minimal implementation of width request. Allocation in Glk is
316 strictly top-down, so we just request our current size by returning 1. */
318 chimara_glk_get_preferred_width(GtkWidget *widget, int *minimal, int *natural)
320 g_return_if_fail(widget || CHIMARA_IS_GLK(widget));
321 g_return_if_fail(minimal);
322 g_return_if_fail(natural);
324 *minimal = *natural = 1;
327 /* Minimal implementation of height request. Allocation in Glk is
328 strictly top-down, so we just request our current size by returning 1. */
330 chimara_glk_get_preferred_height(GtkWidget *widget, int *minimal, int *natural)
332 g_return_if_fail(widget || CHIMARA_IS_GLK(widget));
333 g_return_if_fail(minimal);
334 g_return_if_fail(natural);
336 *minimal = *natural = 1;
339 /* Recursively give the Glk windows their allocated space. Returns a window
340 containing all children of this window that must be redrawn, or NULL if there
341 are no children that require redrawing. */
343 allocate_recurse(winid_t win, GtkAllocation *allocation, guint spacing)
345 if(win->type == wintype_Pair)
347 glui32 division = win->split_method & winmethod_DivisionMask;
348 glui32 direction = win->split_method & winmethod_DirMask;
349 unsigned border = ((win->split_method & winmethod_BorderMask) == winmethod_NoBorder)? 0 : spacing;
351 /* If the space gets too small to honor the spacing property, then just
352 ignore spacing in this window and below. */
353 if( (border > allocation->width && (direction == winmethod_Left || direction == winmethod_Right))
354 || (border > allocation->height && (direction == winmethod_Above || direction == winmethod_Below)) )
357 GtkAllocation child1, child2;
358 child1.x = allocation->x;
359 child1.y = allocation->y;
361 if(division == winmethod_Fixed)
363 /* If the key window has been closed, then default to 0; otherwise
364 use the key window to determine the size */
368 child1.width = win->key_window?
369 CLAMP(win->constraint_size * win->key_window->unit_width, 0, allocation->width - border)
372 case winmethod_Right:
373 child2.width = win->key_window?
374 CLAMP(win->constraint_size * win->key_window->unit_width, 0, allocation->width - border)
377 case winmethod_Above:
378 child1.height = win->key_window?
379 CLAMP(win->constraint_size * win->key_window->unit_height, 0, allocation->height - border)
382 case winmethod_Below:
383 child2.height = win->key_window?
384 CLAMP(win->constraint_size * win->key_window->unit_height, 0, allocation->height - border)
389 else /* proportional */
391 gdouble fraction = win->constraint_size / 100.0;
395 child1.width = MAX(0, (gint)ceil(fraction * (allocation->width - border)) );
397 case winmethod_Right:
398 child2.width = MAX(0, (gint)ceil(fraction * (allocation->width - border)) );
400 case winmethod_Above:
401 child1.height = MAX(0, (gint)ceil(fraction * (allocation->height - border)) );
403 case winmethod_Below:
404 child2.height = MAX(0, (gint)ceil(fraction * (allocation->height - border)) );
409 /* Fill in the rest of the size requisitions according to the child specified above */
413 child2.width = MAX(0, allocation->width - border - child1.width);
414 child2.x = child1.x + child1.width + border;
416 child1.height = child2.height = allocation->height;
418 case winmethod_Right:
419 child1.width = MAX(0, allocation->width - border - child2.width);
420 child2.x = child1.x + child1.width + border;
422 child1.height = child2.height = allocation->height;
424 case winmethod_Above:
425 child2.height = MAX(0, allocation->height - border - child1.height);
427 child2.y = child1.y + child1.height + border;
428 child1.width = child2.width = allocation->width;
430 case winmethod_Below:
431 child1.height = MAX(0, allocation->height - border - child2.height);
433 child2.y = child1.y + child1.height + border;
434 child1.width = child2.width = allocation->width;
439 winid_t arrange1 = allocate_recurse(win->window_node->children->data, &child1, spacing);
440 winid_t arrange2 = allocate_recurse(win->window_node->children->next->data, &child2, spacing);
448 else if(win->type == wintype_TextGrid)
450 /* Pass the size allocation on to the framing widget */
451 gtk_widget_size_allocate(win->frame, allocation);
452 /* It says in the spec that when a text grid window is resized smaller,
453 the bottom or right area is thrown away; when it is resized larger, the
454 bottom or right area is filled with blanks. */
455 GtkAllocation widget_allocation;
456 gtk_widget_get_allocation(win->widget, &widget_allocation);
457 glui32 new_width = (glui32)(widget_allocation.width / win->unit_width);
458 glui32 new_height = (glui32)(widget_allocation.height / win->unit_height);
460 if(new_width != win->width || new_height != win->height)
462 // Window has changed size, trim or expand the textbuffer if necessary.
463 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
464 GtkTextIter start, end;
466 // Add or remove lines
467 if(new_height == 0) {
468 gtk_text_buffer_get_start_iter(buffer, &start);
469 gtk_text_buffer_get_end_iter(buffer, &end);
470 gtk_text_buffer_delete(buffer, &start, &end);
472 else if(new_height < win->height)
474 // Remove surplus lines
475 gtk_text_buffer_get_end_iter(buffer, &end);
476 gtk_text_buffer_get_iter_at_line(buffer, &start, new_height-1);
477 gtk_text_iter_forward_to_line_end(&start);
478 gtk_text_buffer_delete(buffer, &start, &end);
481 else if(new_height > win->height)
484 gint lines_to_add = new_height - win->height;
485 gtk_text_buffer_get_end_iter(buffer, &end);
488 gchar *blanks = g_strnfill(win->width, ' ');
489 gchar **blanklines = g_new0(gchar *, lines_to_add + 1);
491 for(count = 0; count < lines_to_add; count++)
492 blanklines[count] = blanks;
493 blanklines[lines_to_add] = NULL;
494 gchar *vertical_blanks = g_strjoinv("\n", blanklines);
499 gtk_text_buffer_insert(buffer, &end, "\n", 1);
501 gtk_text_buffer_insert(buffer, &end, vertical_blanks, -1);
504 // Trim or expand lines
505 if(new_width < win->width) {
506 gtk_text_buffer_get_start_iter(buffer, &start);
510 for(line = 0; line <= new_height; line++) {
512 gtk_text_iter_forward_cursor_positions(&start, new_width);
513 gtk_text_iter_forward_to_line_end(&end);
514 gtk_text_buffer_delete(buffer, &start, &end);
515 gtk_text_iter_forward_line(&start);
518 } else if(new_width > win->width) {
519 gint chars_to_add = new_width - win->width;
520 gchar *horizontal_blanks = g_strnfill(chars_to_add, ' ');
522 gtk_text_buffer_get_start_iter(buffer, &start);
526 for(line = 0; line <= new_height; line++) {
527 gtk_text_iter_forward_to_line_end(&start);
529 gint start_offset = gtk_text_iter_get_offset(&start);
530 gtk_text_buffer_insert(buffer, &end, horizontal_blanks, -1);
531 gtk_text_buffer_get_iter_at_offset(buffer, &start, start_offset);
532 gtk_text_iter_forward_line(&start);
536 g_free(horizontal_blanks);
540 gboolean arrange = !(win->width == new_width && win->height == new_height);
541 win->width = new_width;
542 win->height = new_height;
543 return arrange? win : NULL;
546 /* For non-pair, non-text-grid windows, just give them the size */
547 gtk_widget_size_allocate(win->frame, allocation);
551 /* Overrides gtk_widget_size_allocate */
553 chimara_glk_size_allocate(GtkWidget *widget, GtkAllocation *allocation)
555 g_return_if_fail(widget);
556 g_return_if_fail(allocation);
557 g_return_if_fail(CHIMARA_IS_GLK(widget));
559 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(widget);
561 gtk_widget_set_allocation(widget, allocation);
563 if(priv->root_window) {
564 GtkAllocation child = *allocation;
565 winid_t arrange = allocate_recurse(priv->root_window->data, &child, priv->spacing);
567 /* arrange points to a window that contains all text grid and graphics
568 windows which have been resized */
569 g_mutex_lock(&priv->arrange_lock);
570 if(!priv->ignore_next_arrange_event)
573 event_throw(CHIMARA_GLK(widget), evtype_Arrange, arrange == priv->root_window->data? NULL : arrange, 0, 0);
576 priv->ignore_next_arrange_event = FALSE;
577 priv->needs_rearrange = FALSE;
578 g_cond_signal(&priv->rearranged);
579 g_mutex_unlock(&priv->arrange_lock);
583 /* Recursively invoke callback() on the GtkWidget of each non-pair window in the tree */
585 forall_recurse(winid_t win, GtkCallback callback, gpointer callback_data)
587 if(win->type == wintype_Pair)
589 forall_recurse(win->window_node->children->data, callback, callback_data);
590 forall_recurse(win->window_node->children->next->data, callback, callback_data);
593 (*callback)(win->frame, callback_data);
596 /* Overrides gtk_container_forall */
598 chimara_glk_forall(GtkContainer *container, gboolean include_internals, GtkCallback callback, gpointer callback_data)
600 g_return_if_fail(container);
601 g_return_if_fail(CHIMARA_IS_GLK(container));
603 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(container);
605 /* All the children are "internal" */
606 if(!include_internals)
609 if(priv->root_window)
610 forall_recurse(priv->root_window->data, callback, callback_data);
614 chimara_glk_stopped(ChimaraGlk *self)
616 CHIMARA_GLK_USE_PRIVATE(self, priv);
617 priv->running = FALSE;
618 priv->program_name = NULL;
619 g_object_notify(G_OBJECT(self), "program-name");
620 priv->program_info = NULL;
621 g_object_notify(G_OBJECT(self), "program-info");
622 priv->story_name = NULL;
623 g_object_notify(G_OBJECT(self), "story-name");
627 chimara_glk_started(ChimaraGlk *self)
629 CHIMARA_GLK_USE_PRIVATE(self, priv);
630 priv->running = TRUE;
634 chimara_glk_waiting(ChimaraGlk *self)
636 /* Default signal handler */
640 chimara_glk_char_input(ChimaraGlk *self, guint window_rock, guint keysym)
642 /* Default signal handler */
646 chimara_glk_line_input(ChimaraGlk *self, guint window_rock, gchar *text)
648 /* Default signal handler */
652 chimara_glk_text_buffer_output(ChimaraGlk *self, guint window_rock, gchar *text)
654 /* Default signal handler */
658 chimara_glk_iliad_screen_update(ChimaraGlk *self, gboolean typing)
660 /* Default signal handler */
664 chimara_glk_class_init(ChimaraGlkClass *klass)
666 /* Override methods of parent classes */
667 GObjectClass *object_class = G_OBJECT_CLASS(klass);
668 object_class->set_property = chimara_glk_set_property;
669 object_class->get_property = chimara_glk_get_property;
670 object_class->finalize = chimara_glk_finalize;
672 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS(klass);
673 widget_class->get_request_mode = chimara_glk_get_request_mode;
674 widget_class->get_preferred_width = chimara_glk_get_preferred_width;
675 widget_class->get_preferred_height = chimara_glk_get_preferred_height;
676 widget_class->size_allocate = chimara_glk_size_allocate;
678 GtkContainerClass *container_class = GTK_CONTAINER_CLASS(klass);
679 container_class->forall = chimara_glk_forall;
680 /* Automatically handle the GtkContainer:border-width property */
681 gtk_container_class_handle_border_width(container_class);
684 klass->stopped = chimara_glk_stopped;
685 klass->started = chimara_glk_started;
686 klass->waiting = chimara_glk_waiting;
687 klass->char_input = chimara_glk_char_input;
688 klass->line_input = chimara_glk_line_input;
689 klass->text_buffer_output = chimara_glk_text_buffer_output;
690 klass->iliad_screen_update = chimara_glk_iliad_screen_update;
693 * ChimaraGlk::stopped:
694 * @glk: The widget that received the signal
696 * Emitted when the a Glk program finishes executing in the widget, whether
697 * it ended normally, or was interrupted.
699 chimara_glk_signals[STOPPED] = g_signal_new("stopped",
700 G_OBJECT_CLASS_TYPE(klass), G_SIGNAL_RUN_FIRST,
701 /* FIXME: Should be G_SIGNAL_RUN_CLEANUP but that segfaults??! */
702 G_STRUCT_OFFSET(ChimaraGlkClass, stopped), NULL, NULL,
703 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
705 * ChimaraGlk::started:
706 * @glk: The widget that received the signal
708 * Emitted when a Glk program starts executing in the widget.
710 chimara_glk_signals[STARTED] = g_signal_new ("started",
711 G_OBJECT_CLASS_TYPE(klass), G_SIGNAL_RUN_FIRST,
712 G_STRUCT_OFFSET(ChimaraGlkClass, started), NULL, NULL,
713 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
715 * ChimaraGlk::waiting:
716 * @glk: The widget that received the signal
718 * Emitted when glk_select() is called by the Glk program and the event
719 * queue is empty, which means that the widget is waiting for input.
721 chimara_glk_signals[WAITING] = g_signal_new("waiting",
722 G_OBJECT_CLASS_TYPE(klass), 0,
723 G_STRUCT_OFFSET(ChimaraGlkClass, waiting), NULL, NULL,
724 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
726 * ChimaraGlk::char-input:
727 * @glk: The widget that received the signal
728 * @window_rock: The rock value of the window that received character input
729 * (see <link linkend="chimara-Rocks">Rocks</link>)
730 * @keysym: The key that was typed, in the form of a key symbol from
731 * <filename class="headerfile">gdk/gdkkeysyms.h</filename>
733 * Emitted when a Glk window receives character input.
735 chimara_glk_signals[CHAR_INPUT] = g_signal_new("char-input",
736 G_OBJECT_CLASS_TYPE(klass), 0,
737 G_STRUCT_OFFSET(ChimaraGlkClass, char_input), NULL, NULL,
738 _chimara_marshal_VOID__UINT_UINT,
739 G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_UINT);
741 * ChimaraGlk::line-input:
742 * @glk: The widget that received the signal
743 * @window_rock: The rock value of the window that received line input (see
744 * <link linkend="chimara-Rocks">Rocks</link>)
745 * @text: The text that was typed
747 * Emitted when a Glk window receives line input.
749 chimara_glk_signals[LINE_INPUT] = g_signal_new("line-input",
750 G_OBJECT_CLASS_TYPE(klass), 0,
751 G_STRUCT_OFFSET(ChimaraGlkClass, line_input), NULL, NULL,
752 _chimara_marshal_VOID__UINT_STRING,
753 G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_STRING);
755 * ChimaraGlk::text-buffer-output:
756 * @glk: The widget that received the signal
757 * @window_rock: The rock value of the window that was printed to (see <link
758 * linkend="chimara-Rocks">Rocks</link>)
760 * Emitted when text is printed to a text buffer window.
762 chimara_glk_signals[TEXT_BUFFER_OUTPUT] = g_signal_new("text-buffer-output",
763 G_OBJECT_CLASS_TYPE(klass), 0,
764 G_STRUCT_OFFSET(ChimaraGlkClass, text_buffer_output), NULL, NULL,
765 _chimara_marshal_VOID__UINT_STRING,
766 G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_STRING);
768 * ChimaraGlk::iliad-screen-update:
769 * @self: The widget that received the signal
770 * @typing: Whether to perform a typing or full screen update
772 * Iliad specific signal which is emitted whenever the screen needs to be updated.
773 * Since iliad screen updates are very slow, updating should only be done when
776 chimara_glk_signals[ILIAD_SCREEN_UPDATE] = g_signal_new("iliad-screen-update",
777 G_OBJECT_CLASS_TYPE(klass), 0,
778 G_STRUCT_OFFSET(ChimaraGlkClass, iliad_screen_update), NULL, NULL,
779 _chimara_marshal_VOID__BOOLEAN,
780 G_TYPE_NONE, 1, G_TYPE_BOOLEAN);
784 * ChimaraGlk:interactive:
786 * Sets whether the widget is interactive. A Glk widget is normally
787 * interactive, but in non-interactive mode, keyboard and mouse input are
788 * ignored and the Glk program is controlled by
789 * chimara_glk_feed_char_input() and chimara_glk_feed_line_input().
790 * <quote>More</quote> prompts when a lot of text is printed to a text
791 * buffer are also disabled. This is typically used when you wish to control
792 * an interpreter program by feeding it a predefined list of commands.
794 g_object_class_install_property( object_class, PROP_INTERACTIVE,
795 g_param_spec_boolean("interactive", _("Interactive"),
796 _("Whether user input is expected in the Glk program"),
798 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
801 * ChimaraGlk:protect:
803 * Sets whether the Glk program is allowed to do file operations. In protect
804 * mode, all file operations will fail.
806 g_object_class_install_property(object_class, PROP_PROTECT,
807 g_param_spec_boolean("protect", _("Protected"),
808 _("Whether the Glk program is barred from doing file operations"),
810 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
813 * ChimaraGlk:spacing:
815 * The amount of space between the Glk windows. This space forms a visible
816 * border between windows; however, if you open a window using the
817 * %winmethod_NoBorder flag, there will be no spacing between it and its
818 * sibling window, no matter what the value of this property is.
820 g_object_class_install_property(object_class, PROP_SPACING,
821 g_param_spec_uint("spacing", _("Spacing"),
822 _("The amount of space between Glk windows"),
824 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
827 * ChimaraGlk:program-name:
829 * The name of the currently running Glk program. You cannot set this
830 * property yourself. It is set to the filename of the plugin when you call
831 * chimara_glk_run(), but the plugin can change it by calling
832 * garglk_set_program_name(). To find out when this information changes,
833 * for example to put the program name in the title bar of a window, connect
834 * to the <code>::notify::program-name</code> signal.
836 g_object_class_install_property(object_class, PROP_PROGRAM_NAME,
837 g_param_spec_string("program-name", _("Program name"),
838 _("Name of the currently running program"),
840 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
843 * ChimaraGlk:program-info:
845 * Information about the currently running Glk program. You cannot set this
846 * property yourself. The plugin can change it by calling
847 * garglk_set_program_info(). See also #ChimaraGlk:program-name.
849 g_object_class_install_property(object_class, PROP_PROGRAM_INFO,
850 g_param_spec_string("program-info", _("Program info"),
851 _("Information about the currently running program"),
853 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
856 * ChimaraGlk:story-name:
858 * The name of the story currently running in the Glk interpreter. You
859 * cannot set this property yourself. It is set to the story filename when
860 * you call chimara_if_run_game(), but the plugin can change it by calling
861 * garglk_set_story_name().
863 * Strictly speaking, this should be a property of #ChimaraIF, but it is
864 * legal for any Glk program to call garglk_set_story_name(), even if it is
865 * not an interpreter and does not load story files.
867 g_object_class_install_property(object_class, PROP_STORY_NAME,
868 g_param_spec_string("story-name", _("Story name"),
869 _("Name of the story currently loaded in the interpreter"),
871 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
874 * ChimaraGlk:running:
876 * Whether this Glk widget is currently running a game or not.
878 g_object_class_install_property(object_class, PROP_RUNNING,
879 g_param_spec_boolean("running", _("Running"),
880 _("Whether there is a program currently running"),
882 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
885 g_type_class_add_private(klass, sizeof(ChimaraGlkPrivate));
888 /* PUBLIC FUNCTIONS */
891 * chimara_error_quark:
893 * The error domain for errors from Chimara widgets.
895 * Returns: The string <quote>chimara-error-quark</quote> as a <link
896 * linkend="GQuark">GQuark</link>.
899 chimara_error_quark(void)
901 chimara_init(); /* This is a library entry point */
902 return g_quark_from_static_string("chimara-error-quark");
908 * Creates and initializes a new #ChimaraGlk widget.
910 * Return value: a #ChimaraGlk widget, with a floating reference.
913 chimara_glk_new(void)
915 /* This is a library entry point; initialize the library */
918 return GTK_WIDGET(g_object_new(CHIMARA_TYPE_GLK, NULL));
922 * chimara_glk_set_interactive:
923 * @glk: a #ChimaraGlk widget
924 * @interactive: whether the widget should expect user input
926 * Sets the #ChimaraGlk:interactive property of @glk.
929 chimara_glk_set_interactive(ChimaraGlk *glk, gboolean interactive)
931 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
933 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
934 priv->interactive = interactive;
935 g_object_notify(G_OBJECT(glk), "interactive");
939 * chimara_glk_get_interactive:
940 * @glk: a #ChimaraGlk widget
942 * Returns whether @glk is interactive (expecting user input). See
943 * #ChimaraGlk:interactive.
945 * Return value: %TRUE if @glk is interactive.
948 chimara_glk_get_interactive(ChimaraGlk *glk)
950 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
952 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
953 return priv->interactive;
957 * chimara_glk_set_protect:
958 * @glk: a #ChimaraGlk widget
959 * @protect: whether the widget should allow the Glk program to do file
962 * Sets the #ChimaraGlk:protect property of @glk. In protect mode, the Glk
963 * program is not allowed to do file operations.
966 chimara_glk_set_protect(ChimaraGlk *glk, gboolean protect)
968 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
970 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
971 priv->protect = protect;
972 g_object_notify(G_OBJECT(glk), "protect");
976 * chimara_glk_get_protect:
977 * @glk: a #ChimaraGlk widget
979 * Returns whether @glk is in protect mode (banned from doing file operations).
980 * See #ChimaraGlk:protect.
982 * Return value: %TRUE if @glk is in protect mode.
985 chimara_glk_get_protect(ChimaraGlk *glk)
987 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
989 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
990 return priv->protect;
994 * chimara_glk_set_css_to_default:
995 * @glk: a #ChimaraGlk widget
997 * Resets the styles for text buffer and text grid windows to their defaults.
999 * This function is not implemented yet.
1003 chimara_glk_set_css_to_default(ChimaraGlk *glk)
1005 reset_default_styles(glk);
1009 * chimara_glk_set_css_from_file:
1010 * @glk: a #ChimaraGlk widget
1011 * @filename: path to a CSS file, or %NULL
1012 * @error: location to store a <link
1013 * linkend="glib-Error-Reporting">GError</link>, or %NULL
1015 * Sets the styles for text buffer and text grid windows according to the CSS
1016 * file @filename. Note that the styles are set cumulatively on top of whatever
1017 * the styles are at the time this function is called; to reset the styles to
1018 * their defaults, use chimara_glk_set_css_to_default().
1020 * Returns: %TRUE on success, %FALSE if an error occurred, in which case @error
1024 chimara_glk_set_css_from_file(ChimaraGlk *glk, const gchar *filename, GError **error)
1026 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1027 g_return_val_if_fail(filename, FALSE);
1028 g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
1030 int fd = open(filename, O_RDONLY);
1033 *error = g_error_new(G_IO_ERROR, g_io_error_from_errno(errno),
1034 _("Error opening file \"%s\": %s"), filename, g_strerror(errno));
1038 GScanner *scanner = create_css_file_scanner();
1039 g_scanner_input_file(scanner, fd);
1040 scanner->input_name = filename;
1041 scan_css_file(scanner, glk);
1043 if(close(fd) == -1) {
1045 *error = g_error_new(G_IO_ERROR, g_io_error_from_errno(errno),
1046 _("Error closing file \"%s\": %s"), filename, g_strerror(errno));
1053 * chimara_glk_set_css_from_string:
1054 * @glk: a #ChimaraGlk widget
1055 * @css: a string containing CSS code
1057 * Sets the styles for text buffer and text grid windows according to the CSS
1058 * code @css. Note that the styles are set cumulatively on top of whatever the
1059 * styles are at the time this function is called; to reset the styles to their
1060 * defaults, use chimara_glk_set_css_to_default().
1063 chimara_glk_set_css_from_string(ChimaraGlk *glk, const gchar *css)
1065 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1066 g_return_if_fail(css || *css);
1068 GScanner *scanner = create_css_file_scanner();
1069 g_scanner_input_text(scanner, css, strlen(css));
1070 scanner->input_name = "<string>";
1071 scan_css_file(scanner, glk);
1075 * chimara_glk_set_spacing:
1076 * @glk: a #ChimaraGlk widget
1077 * @spacing: the number of pixels to put between Glk windows
1079 * Sets the #ChimaraGlk:spacing property of @glk, which is the border width in
1080 * pixels between Glk windows.
1083 chimara_glk_set_spacing(ChimaraGlk *glk, guint spacing)
1085 g_return_if_fail( glk || CHIMARA_IS_GLK(glk) );
1087 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1088 priv->spacing = spacing;
1089 g_object_notify(G_OBJECT(glk), "spacing");
1093 * chimara_glk_get_spacing:
1094 * @glk: a #ChimaraGlk widget
1096 * Gets the value set by chimara_glk_set_spacing().
1098 * Return value: pixels of spacing between Glk windows
1101 chimara_glk_get_spacing(ChimaraGlk *glk)
1103 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), 0);
1105 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1106 return priv->spacing;
1109 struct StartupData {
1110 glk_main_t glk_main;
1111 glkunix_startup_code_t glkunix_startup_code;
1112 glkunix_startup_t args;
1113 ChimaraGlkPrivate *glk_data;
1117 free_startup_data(struct StartupData *startup)
1120 while(i < startup->args.argc)
1121 g_free(startup->args.argv[i++]);
1122 g_free(startup->args.argv);
1126 /* glk_enter() is the actual function called in the new thread in which
1127 glk_main() runs. Takes ownership of @startup and will free it. */
1129 glk_enter(struct StartupData *startup)
1131 extern GPrivate glk_data_key;
1132 g_private_set(&glk_data_key, startup->glk_data);
1134 /* Acquire the Glk thread's references to the input queues */
1135 g_async_queue_ref(startup->glk_data->char_input_queue);
1136 g_async_queue_ref(startup->glk_data->line_input_queue);
1138 /* Run startup function */
1139 if(startup->glkunix_startup_code) {
1140 startup->glk_data->in_startup = TRUE;
1141 int result = startup->glkunix_startup_code(&startup->args);
1142 startup->glk_data->in_startup = FALSE;
1145 free_startup_data(startup);
1150 /* Run main function */
1151 glk_main_t glk_main = startup->glk_main;
1153 /* COMPAT: avoid usage of slices */
1154 g_signal_emit_by_name(startup->glk_data->self, "started");
1156 free_startup_data(startup);
1157 glk_exit(); /* Run shutdown code in glk_exit() even if glk_main() returns normally */
1158 g_assert_not_reached(); /* because glk_exit() calls g_thread_exit() */
1164 * @glk: a #ChimaraGlk widget
1165 * @plugin: path to a plugin module compiled with <filename
1166 * class="header">glk.h</filename>
1167 * @argc: Number of command line arguments in @argv
1168 * @argv: Array of command line arguments to pass to the plugin
1169 * @error: location to store a <link
1170 * linkend="glib-Error-Reporting">GError</link>, or %NULL
1172 * Opens a Glk program compiled as a plugin. Sorts out its command line
1173 * arguments from #glkunix_arguments, calls its startup function
1174 * glkunix_startup_code(), and then calls its main function glk_main() in
1175 * a separate thread. On failure, returns %FALSE and sets @error.
1177 * The plugin must at least export a glk_main() function; #glkunix_arguments and
1178 * glkunix_startup_code() are optional.
1180 * Return value: %TRUE if the Glk program was started successfully.
1183 chimara_glk_run(ChimaraGlk *glk, const gchar *plugin, int argc, char *argv[], GError **error)
1185 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1186 g_return_val_if_fail(plugin, FALSE);
1187 g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
1189 if(chimara_glk_get_running(glk)) {
1190 g_set_error(error, CHIMARA_ERROR, CHIMARA_PLUGIN_ALREADY_RUNNING, _("There was already a plugin running."));
1194 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1196 /* COMPAT: avoid usage of slices */
1197 struct StartupData *startup = g_new0(struct StartupData,1);
1199 g_assert( g_module_supported() );
1200 /* If there is already a module loaded, free it first -- you see, we want to
1201 * keep modules loaded as long as possible to avoid crashes in stack unwinding */
1202 chimara_glk_unload_plugin(glk);
1203 /* Open the module to run */
1204 priv->program = g_module_open(plugin, G_MODULE_BIND_LAZY);
1208 g_set_error(error, CHIMARA_ERROR, CHIMARA_LOAD_MODULE_ERROR, _("Error opening module: %s"), g_module_error());
1211 if( !g_module_symbol(priv->program, "glk_main", (gpointer *) &startup->glk_main) )
1213 g_set_error(error, CHIMARA_ERROR, CHIMARA_NO_GLK_MAIN, _("Error finding glk_main(): %s"), g_module_error());
1217 if( g_module_symbol(priv->program, "glkunix_startup_code", (gpointer *) &startup->glkunix_startup_code) )
1219 glkunix_argumentlist_t *glkunix_arguments;
1221 if( !(g_module_symbol(priv->program, "glkunix_arguments", (gpointer *) &glkunix_arguments)
1222 && parse_command_line(glkunix_arguments, argc, argv, &startup->args)) )
1224 /* arguments could not be parsed, so create data ourselves */
1225 startup->args.argc = 1;
1226 startup->args.argv = g_new0(gchar *, 1);
1229 /* Set the program invocation name */
1230 startup->args.argv[0] = g_strdup(plugin);
1232 startup->glk_data = priv;
1234 /* Set the program name */
1235 priv->program_name = g_path_get_basename(plugin);
1236 g_object_notify(G_OBJECT(glk), "program-name");
1238 /* Run in a separate thread */
1239 priv->thread = g_thread_try_new("glk", (GThreadFunc)glk_enter, startup, error);
1241 return !(priv->thread == NULL);
1245 * chimara_glk_run_file:
1246 * @self: a #ChimaraGlk widget
1247 * @plugin_file: a #GFile pointing to a plugin module compiled with <filename
1248 * class="header">glk.h</filename>
1249 * @argc: Number of command line arguments in @argv
1250 * @argv: Array of command line arguments to pass to the plugin
1251 * @error: location to store a <link
1252 * linkend="glib-Error-Reporting">GError</link>, or %NULL
1254 * Opens a Glk program compiled as a plugin, from a #GFile. See
1255 * chimara_glk_run() for details.
1257 * Return value: %TRUE if the Glk program was started successfully.
1260 chimara_glk_run_file(ChimaraGlk *self, GFile *plugin_file, int argc, char *argv[], GError **error)
1262 g_return_val_if_fail(self || CHIMARA_IS_GLK(self), FALSE);
1263 g_return_val_if_fail(plugin_file || G_IS_FILE(plugin_file), FALSE);
1264 g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
1266 char *path = g_file_get_path(plugin_file);
1267 gboolean retval = chimara_glk_run(self, path, argc, argv, error);
1275 * @glk: a #ChimaraGlk widget
1277 * Signals the Glk program running in @glk to abort. Note that if the program is
1278 * caught in an infinite loop in which glk_tick() is not called, this may not
1281 * This function does nothing if no Glk program is running.
1284 chimara_glk_stop(ChimaraGlk *glk)
1286 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1287 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1289 /* Don't do anything if not running a program */
1293 if(!priv->after_finalize) {
1294 g_mutex_lock(&priv->abort_lock);
1295 priv->abort_signalled = TRUE;
1296 g_mutex_unlock(&priv->abort_lock);
1297 /* Stop blocking on the event queue condition */
1298 event_throw(glk, evtype_Abort, NULL, 0, 0);
1299 /* Stop blocking on the shutdown key press condition */
1300 g_mutex_lock(&priv->shutdown_lock);
1301 g_cond_signal(&priv->shutdown_key_pressed);
1302 g_mutex_unlock(&priv->shutdown_lock);
1308 * @glk: a #ChimaraGlk widget
1310 * Holds up the main thread and waits for the Glk program running in @glk to
1313 * This function does nothing if no Glk program is running.
1316 chimara_glk_wait(ChimaraGlk *glk)
1318 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1319 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1320 /* Don't do anything if not running a program */
1323 /* Unlock GDK mutex, because the Glk program might need to use it for shutdown */
1324 gdk_threads_leave();
1325 g_thread_join(priv->thread);
1326 gdk_threads_enter();
1330 * chimara_glk_unload_plugin:
1331 * @glk: a #ChimaraGlk widget
1333 * The plugin containing the Glk program is unloaded as late as possible before
1334 * loading a new plugin, in order to prevent crashes while printing stack
1335 * backtraces during debugging. Sometimes this behavior is not desirable. This
1336 * function forces @glk to unload the plugin running in it.
1338 * This function does nothing if there is no plugin loaded.
1341 chimara_glk_unload_plugin(ChimaraGlk *glk)
1343 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1344 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1345 if( priv->program && !g_module_close(priv->program) )
1346 g_warning( "Error closing module :%s", g_module_error() );
1350 * chimara_glk_get_running:
1351 * @glk: a #ChimaraGlk widget
1353 * Use this function to tell whether a program is currently running in the
1356 * Returns: %TRUE if @glk is executing a Glk program, %FALSE otherwise.
1359 chimara_glk_get_running(ChimaraGlk *glk)
1361 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1362 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1363 return priv->running;
1367 * chimara_glk_feed_char_input:
1368 * @glk: a #ChimaraGlk widget
1369 * @keyval: a key symbol as defined in <filename
1370 * class="headerfile">gdk/gdkkeysyms.h</filename>
1372 * Pretend that a key was pressed in the Glk program as a response to a
1373 * character input request. You can call this function even when no window has
1374 * requested character input, in which case the key will be saved for the
1375 * following window that requests character input. This has the disadvantage
1376 * that if more than one window has requested character input, it is arbitrary
1377 * which one gets the key press.
1380 chimara_glk_feed_char_input(ChimaraGlk *glk, guint keyval)
1382 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1383 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1384 g_async_queue_push(priv->char_input_queue, GUINT_TO_POINTER(keyval));
1385 event_throw(glk, evtype_ForcedCharInput, NULL, 0, 0);
1389 * chimara_glk_feed_line_input:
1390 * @glk: a #ChimaraGlk widget
1391 * @text: text to pass to the next line input request
1393 * Pretend that @text was typed in the Glk program as a response to a line input
1394 * request. @text does not need to end with a newline. You can call this
1395 * function even when no window has requested line input, in which case the text
1396 * will be saved for the following window that requests line input. This has the
1397 * disadvantage that if more than one window has requested line input, it is
1398 * arbitrary which one gets the text.
1401 chimara_glk_feed_line_input(ChimaraGlk *glk, const gchar *text)
1403 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1404 g_return_if_fail(text);
1405 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1406 g_async_queue_push(priv->line_input_queue, g_strdup(text));
1407 event_throw(glk, evtype_ForcedLineInput, NULL, 0, 0);
1411 * chimara_glk_is_char_input_pending:
1412 * @glk: a #ChimaraGlk widget
1414 * Use this function to tell if character input forced by
1415 * chimara_glk_feed_char_input() has been passed to an input request or not.
1417 * Returns: %TRUE if forced character input is pending, %FALSE otherwise.
1420 chimara_glk_is_char_input_pending(ChimaraGlk *glk)
1422 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1423 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1424 return g_async_queue_length(priv->char_input_queue) > 0;
1428 * chimara_glk_is_line_input_pending:
1429 * @glk: a #ChimaraGlk widget
1431 * Use this function to tell if line input forced by
1432 * chimara_glk_feed_line_input() has been passed to an input request or not.
1434 * Returns: %TRUE if forced line input is pending, %FALSE otherwise.
1437 chimara_glk_is_line_input_pending(ChimaraGlk *glk)
1439 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1440 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1441 return g_async_queue_length(priv->line_input_queue) > 0;
1445 * chimara_glk_get_tag:
1446 * @glk: a #ChimaraGlk widget
1447 * @window: The type of window to retrieve the tag for
1448 * @name: The name of the tag to retrieve
1450 * Use this function to get a #GtkTextTag so style properties can be changed.
1451 * See also chimara_glk_set_css_from_string().
1453 * The layout of the text in Chimara is controlled by two sets of tags: one set
1454 * describing the style in text buffers and one for text grids. See also the
1455 * Glk specification for the difference between the two. The main narrative of
1456 * a game is usually rendered in text buffers, whereas text grids are mostly
1457 * used for status bars and in game menus.
1459 * The following tag names are supported:
1461 * <listitem><para>normal</para></listitem>
1462 * <listitem><para>emphasized</para></listitem>
1463 * <listitem><para>preformatted</para></listitem>
1464 * <listitem><para>header</para></listitem>
1465 * <listitem><para>subheader</para></listitem>
1466 * <listitem><para>alert</para></listitem>
1467 * <listitem><para>note</para></listitem>
1468 * <listitem><para>block-quote</para></listitem>
1469 * <listitem><para>input</para></listitem>
1470 * <listitem><para>user1</para></listitem>
1471 * <listitem><para>user2</para></listitem>
1472 * <listitem><para>hyperlink</para></listitem>
1473 * <listitem><para>pager</para></listitem>
1476 * Returns: (transfer none): The #GtkTextTag corresponding to @name in the
1477 * styles of @window.
1480 chimara_glk_get_tag(ChimaraGlk *glk, ChimaraGlkWindowType window, const gchar *name)
1482 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1485 case CHIMARA_GLK_TEXT_BUFFER:
1486 return GTK_TEXT_TAG( g_hash_table_lookup(priv->styles->text_buffer, name) );
1488 case CHIMARA_GLK_TEXT_GRID:
1489 return GTK_TEXT_TAG( g_hash_table_lookup(priv->styles->text_grid, name) );
1492 ILLEGAL_PARAM("Unknown window type: %u", window);
1498 * chimara_glk_get_tag_names:
1499 * @glk: a #ChimaraGlk widget
1500 * @num_tags: Return location for the number of tag names retrieved.
1502 * Retrieves the possible tag names to use in chimara_glk_get_tag().
1504 * Returns: (transfer none) (array length=num_tags) (element-type utf8):
1505 * Array of strings containing the tag names. This array is owned by Chimara,
1509 chimara_glk_get_tag_names(ChimaraGlk *glk, unsigned int *num_tags)
1511 g_return_val_if_fail(num_tags != NULL, NULL);
1513 *num_tags = CHIMARA_NUM_STYLES;
1514 return style_get_tag_names();
1518 * chimara_glk_set_resource_load_callback:
1519 * @glk: a #ChimaraGlk widget
1520 * @func: a function to call for loading resources, or %NULL
1521 * @user_data: user data to pass to @func, or %NULL
1522 * @destroy_user_data: a function to call for freeing @user_data, or %NULL
1524 * Sometimes it is preferable to load image and sound resources from somewhere
1525 * else than a Blorb file, for example while developing a game. Section 14 of
1526 * the <ulink url="http://eblong.com/zarf/blorb/blorb.html#s14">Blorb
1527 * specification</ulink> allows for this possibility. This function sets @func
1528 * to be called when the Glk program requests loading an image or sound without
1529 * a Blorb resource map having been loaded, optionally passing @user_data as an
1532 * Note that @func is only called if no Blorb resource map has been set; having
1533 * a resource map in place overrides this function.
1535 * If you pass non-%NULL for @destroy_user_data, then @glk takes ownership of
1536 * @user_data. When it is not needed anymore, it will be freed by calling
1537 * @destroy_user_data on it. If you wish to retain ownership of @user_data, pass
1538 * %NULL for @destroy_user_data.
1540 * To deactivate the callback, call this function with @func set to %NULL.
1543 chimara_glk_set_resource_load_callback(ChimaraGlk *glk, ChimaraResourceLoadFunc func, gpointer user_data, GDestroyNotify destroy_user_data)
1545 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1547 if(priv->resource_load_callback == func
1548 && priv->resource_load_callback_data == user_data
1549 && priv->resource_load_callback_destroy_data == destroy_user_data)
1552 if(priv->resource_load_callback_destroy_data)
1553 priv->resource_load_callback_destroy_data(priv->resource_load_callback_data);
1555 priv->resource_load_callback = func;
1556 priv->resource_load_callback_data = user_data;
1557 priv->resource_load_callback_destroy_data = destroy_user_data;