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 GDK threading in any program you use a #ChimaraGlk
56 * This means calling gdk_threads_init() at the beginning of your program,
57 * <emphasis>before</emphasis> the call to gtk_init().
58 * In addition to this, you must also protect your call to gtk_main() by calling
59 * gdk_threads_enter() right before it, and gdk_threads_leave() right after it.
61 * The following sample program shows how to initialize and construct a simple
62 * GTK window that runs a Glk program:
65 * #include <gtk/gtk.h>
66 * #include <libchimara/chimara-glk.h>
69 * main(int argc, char *argv[])
71 * GtkWidget *window, *glk;
72 * GError *error = NULL;
73 * gchar *plugin_argv[] = { "plugin.so", "-option" };
75 * /<!---->* Initialize threads and GTK *<!---->/
77 * gtk_init(&argc, &argv);
79 * /<!---->* Construct the window and its contents. We quit the GTK main loop
80 * * when the window's close button is clicked. *<!---->/
81 * window = gtk_window_new(GTK_WINDOW_TOPLEVEL);
82 * g_signal_connect(window, "delete-event", G_CALLBACK(gtk_main_quit), NULL);
83 * glk = chimara_glk_new();
84 * gtk_container_add(GTK_CONTAINER(window), glk);
85 * gtk_widget_show_all(window);
87 * /<!---->* Add a reference to the ChimaraGlk widget, since we want it to
88 * * persist after the window's delete-event -- otherwise it will be destroyed
89 * * with the window. *<!---->/
92 * /<!---->* Start the Glk program in a separate thread *<!---->/
93 * if(!chimara_glk_run(CHIMARA_GLK(glk), "./plugin.so", 2, plugin_argv, &error))
94 * g_error("Error starting Glk library: %s\n", error->message);
96 * /<!---->* Start the GTK main loop *<!---->/
97 * gdk_threads_enter();
99 * gdk_threads_leave();
101 * /<!---->* After the GTK main loop exits, signal the Glk program to shut down if
102 * * it is still running, and wait for it to exit. *<!---->/
103 * chimara_glk_stop(CHIMARA_GLK(glk));
104 * chimara_glk_wait(CHIMARA_GLK(glk));
105 * g_object_unref(glk);
112 typedef void (* glk_main_t) (void);
113 typedef int (* glkunix_startup_code_t) (glkunix_startup_t*);
138 static guint chimara_glk_signals[LAST_SIGNAL] = { 0 };
140 G_DEFINE_TYPE(ChimaraGlk, chimara_glk, GTK_TYPE_CONTAINER);
143 chimara_glk_init(ChimaraGlk *self)
145 chimara_init(); /* This is a library entry point */
147 gtk_widget_set_has_window(GTK_WIDGET(self), FALSE);
149 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(self);
152 priv->interactive = TRUE;
153 priv->styles = g_new0(StyleSet,1);
154 priv->glk_styles = g_new0(StyleSet,1);
155 priv->final_message = g_strdup("[ The game has finished ]");
156 priv->event_queue = g_queue_new();
157 priv->char_input_queue = g_async_queue_new_full(g_free);
158 priv->line_input_queue = g_async_queue_new_full(g_free);
160 g_mutex_init(&priv->event_lock);
161 g_mutex_init(&priv->abort_lock);
162 g_mutex_init(&priv->shutdown_lock);
163 g_mutex_init(&priv->arrange_lock);
164 g_mutex_init(&priv->resource_lock);
166 g_cond_init(&priv->event_queue_not_empty);
167 g_cond_init(&priv->event_queue_not_full);
168 g_cond_init(&priv->shutdown_key_pressed);
169 g_cond_init(&priv->rearranged);
170 g_cond_init(&priv->resource_loaded);
171 g_cond_init(&priv->resource_info_available);
177 chimara_glk_set_property(GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
179 ChimaraGlk *glk = CHIMARA_GLK(object);
183 case PROP_INTERACTIVE:
184 chimara_glk_set_interactive( glk, g_value_get_boolean(value) );
187 chimara_glk_set_protect( glk, g_value_get_boolean(value) );
190 chimara_glk_set_spacing( glk, g_value_get_uint(value) );
193 G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
198 chimara_glk_get_property(GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
200 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(object);
204 case PROP_INTERACTIVE:
205 g_value_set_boolean(value, priv->interactive);
208 g_value_set_boolean(value, priv->protect);
211 g_value_set_uint(value, priv->spacing);
213 case PROP_PROGRAM_NAME:
214 g_value_set_string(value, priv->program_name);
216 case PROP_PROGRAM_INFO:
217 g_value_set_string(value, priv->program_info);
219 case PROP_STORY_NAME:
220 g_value_set_string(value, priv->story_name);
223 g_value_set_boolean(value, priv->running);
226 G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
231 chimara_glk_finalize(GObject *object)
233 ChimaraGlk *self = CHIMARA_GLK(object);
234 CHIMARA_GLK_USE_PRIVATE(self, priv);
235 priv->after_finalize = TRUE;
237 /* Free widget properties */
238 g_free(priv->final_message);
240 g_hash_table_destroy(priv->styles->text_buffer);
241 g_hash_table_destroy(priv->styles->text_grid);
242 g_hash_table_destroy(priv->glk_styles->text_buffer);
243 g_hash_table_destroy(priv->glk_styles->text_grid);
245 /* Free the event queue */
246 g_mutex_lock(&priv->event_lock);
247 g_queue_foreach(priv->event_queue, (GFunc)g_free, NULL);
248 g_queue_free(priv->event_queue);
249 g_cond_clear(&priv->event_queue_not_empty);
250 g_cond_clear(&priv->event_queue_not_full);
251 priv->event_queue = NULL;
252 g_mutex_unlock(&priv->event_lock);
253 g_mutex_clear(&priv->event_lock);
255 /* Free the abort signaling mechanism */
256 g_mutex_lock(&priv->abort_lock);
257 /* Make sure no other thread is busy with this */
258 g_mutex_unlock(&priv->abort_lock);
259 g_mutex_clear(&priv->abort_lock);
261 /* Free the shutdown keypress signaling mechanism */
262 g_mutex_lock(&priv->shutdown_lock);
263 g_cond_clear(&priv->shutdown_key_pressed);
264 g_mutex_unlock(&priv->shutdown_lock);
265 g_mutex_clear(&priv->shutdown_lock);
267 /* Free the window arrangement signaling */
268 g_mutex_lock(&priv->arrange_lock);
269 g_cond_clear(&priv->rearranged);
270 g_mutex_unlock(&priv->arrange_lock);
271 g_mutex_clear(&priv->arrange_lock);
273 g_mutex_lock(&priv->resource_lock);
274 g_cond_clear(&priv->resource_loaded);
275 g_cond_clear(&priv->resource_info_available);
276 g_mutex_unlock(&priv->resource_lock);
277 g_mutex_clear(&priv->resource_lock);
278 g_slist_foreach(priv->image_cache, (GFunc)clear_image_cache, NULL);
279 g_slist_free(priv->image_cache);
280 /* Unref input queues (this should destroy them since any Glk thread has stopped by now */
281 g_async_queue_unref(priv->char_input_queue);
282 g_async_queue_unref(priv->line_input_queue);
283 /* Destroy callback data if ownership retained */
284 if(priv->resource_load_callback_destroy_data)
285 priv->resource_load_callback_destroy_data(priv->resource_load_callback_data);
287 /* Free other stuff */
288 g_free(priv->current_dir);
289 g_free(priv->program_name);
290 g_free(priv->program_info);
291 g_free(priv->story_name);
292 g_free(priv->styles);
293 g_free(priv->glk_styles);
295 /* Chain up to parent */
296 G_OBJECT_CLASS(chimara_glk_parent_class)->finalize(object);
299 /* Implementation of get_request_mode(): Always request constant size */
300 static GtkSizeRequestMode
301 chimara_glk_get_request_mode(GtkWidget *widget)
303 return GTK_SIZE_REQUEST_CONSTANT_SIZE;
306 /* Minimal implementation of width request. Allocation in Glk is
307 strictly top-down, so we just request our current size by returning 1. */
309 chimara_glk_get_preferred_width(GtkWidget *widget, int *minimal, int *natural)
311 g_return_if_fail(widget || CHIMARA_IS_GLK(widget));
312 g_return_if_fail(minimal);
313 g_return_if_fail(natural);
315 *minimal = *natural = 1;
318 /* Minimal implementation of height request. Allocation in Glk is
319 strictly top-down, so we just request our current size by returning 1. */
321 chimara_glk_get_preferred_height(GtkWidget *widget, int *minimal, int *natural)
323 g_return_if_fail(widget || CHIMARA_IS_GLK(widget));
324 g_return_if_fail(minimal);
325 g_return_if_fail(natural);
327 *minimal = *natural = 1;
330 /* Recursively give the Glk windows their allocated space. Returns a window
331 containing all children of this window that must be redrawn, or NULL if there
332 are no children that require redrawing. */
334 allocate_recurse(winid_t win, GtkAllocation *allocation, guint spacing)
336 if(win->type == wintype_Pair)
338 glui32 division = win->split_method & winmethod_DivisionMask;
339 glui32 direction = win->split_method & winmethod_DirMask;
340 unsigned border = ((win->split_method & winmethod_BorderMask) == winmethod_NoBorder)? 0 : spacing;
342 /* If the space gets too small to honor the spacing property, then just
343 ignore spacing in this window and below. */
344 if( (border > allocation->width && (direction == winmethod_Left || direction == winmethod_Right))
345 || (border > allocation->height && (direction == winmethod_Above || direction == winmethod_Below)) )
348 GtkAllocation child1, child2;
349 child1.x = allocation->x;
350 child1.y = allocation->y;
352 if(division == winmethod_Fixed)
354 /* If the key window has been closed, then default to 0; otherwise
355 use the key window to determine the size */
359 child1.width = win->key_window?
360 CLAMP(win->constraint_size * win->key_window->unit_width, 0, allocation->width - border)
363 case winmethod_Right:
364 child2.width = win->key_window?
365 CLAMP(win->constraint_size * win->key_window->unit_width, 0, allocation->width - border)
368 case winmethod_Above:
369 child1.height = win->key_window?
370 CLAMP(win->constraint_size * win->key_window->unit_height, 0, allocation->height - border)
373 case winmethod_Below:
374 child2.height = win->key_window?
375 CLAMP(win->constraint_size * win->key_window->unit_height, 0, allocation->height - border)
380 else /* proportional */
382 gdouble fraction = win->constraint_size / 100.0;
386 child1.width = MAX(0, (gint)ceil(fraction * (allocation->width - border)) );
388 case winmethod_Right:
389 child2.width = MAX(0, (gint)ceil(fraction * (allocation->width - border)) );
391 case winmethod_Above:
392 child1.height = MAX(0, (gint)ceil(fraction * (allocation->height - border)) );
394 case winmethod_Below:
395 child2.height = MAX(0, (gint)ceil(fraction * (allocation->height - border)) );
400 /* Fill in the rest of the size requisitions according to the child specified above */
404 child2.width = MAX(0, allocation->width - border - child1.width);
405 child2.x = child1.x + child1.width + border;
407 child1.height = child2.height = allocation->height;
409 case winmethod_Right:
410 child1.width = MAX(0, allocation->width - border - child2.width);
411 child2.x = child1.x + child1.width + border;
413 child1.height = child2.height = allocation->height;
415 case winmethod_Above:
416 child2.height = MAX(0, allocation->height - border - child1.height);
418 child2.y = child1.y + child1.height + border;
419 child1.width = child2.width = allocation->width;
421 case winmethod_Below:
422 child1.height = MAX(0, allocation->height - border - child2.height);
424 child2.y = child1.y + child1.height + border;
425 child1.width = child2.width = allocation->width;
430 winid_t arrange1 = allocate_recurse(win->window_node->children->data, &child1, spacing);
431 winid_t arrange2 = allocate_recurse(win->window_node->children->next->data, &child2, spacing);
439 else if(win->type == wintype_TextGrid)
441 /* Pass the size allocation on to the framing widget */
442 gtk_widget_size_allocate(win->frame, allocation);
443 /* It says in the spec that when a text grid window is resized smaller,
444 the bottom or right area is thrown away; when it is resized larger, the
445 bottom or right area is filled with blanks. */
446 GtkAllocation widget_allocation;
447 gtk_widget_get_allocation(win->widget, &widget_allocation);
448 glui32 new_width = (glui32)(widget_allocation.width / win->unit_width);
449 glui32 new_height = (glui32)(widget_allocation.height / win->unit_height);
451 if(new_width != win->width || new_height != win->height)
453 // Window has changed size, trim or expand the textbuffer if necessary.
454 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
455 GtkTextIter start, end;
457 // Add or remove lines
458 if(new_height == 0) {
459 gtk_text_buffer_get_start_iter(buffer, &start);
460 gtk_text_buffer_get_end_iter(buffer, &end);
461 gtk_text_buffer_delete(buffer, &start, &end);
463 else if(new_height < win->height)
465 // Remove surplus lines
466 gtk_text_buffer_get_end_iter(buffer, &end);
467 gtk_text_buffer_get_iter_at_line(buffer, &start, new_height-1);
468 gtk_text_iter_forward_to_line_end(&start);
469 gtk_text_buffer_delete(buffer, &start, &end);
472 else if(new_height > win->height)
475 gint lines_to_add = new_height - win->height;
476 gtk_text_buffer_get_end_iter(buffer, &end);
479 gchar *blanks = g_strnfill(win->width, ' ');
480 gchar **blanklines = g_new0(gchar *, lines_to_add + 1);
482 for(count = 0; count < lines_to_add; count++)
483 blanklines[count] = blanks;
484 blanklines[lines_to_add] = NULL;
485 gchar *vertical_blanks = g_strjoinv("\n", blanklines);
490 gtk_text_buffer_insert(buffer, &end, "\n", 1);
492 gtk_text_buffer_insert(buffer, &end, vertical_blanks, -1);
495 // Trim or expand lines
496 if(new_width < win->width) {
497 gtk_text_buffer_get_start_iter(buffer, &start);
501 for(line = 0; line <= new_height; line++) {
503 gtk_text_iter_forward_cursor_positions(&start, new_width);
504 gtk_text_iter_forward_to_line_end(&end);
505 gtk_text_buffer_delete(buffer, &start, &end);
506 gtk_text_iter_forward_line(&start);
509 } else if(new_width > win->width) {
510 gint chars_to_add = new_width - win->width;
511 gchar *horizontal_blanks = g_strnfill(chars_to_add, ' ');
513 gtk_text_buffer_get_start_iter(buffer, &start);
517 for(line = 0; line <= new_height; line++) {
518 gtk_text_iter_forward_to_line_end(&start);
520 gint start_offset = gtk_text_iter_get_offset(&start);
521 gtk_text_buffer_insert(buffer, &end, horizontal_blanks, -1);
522 gtk_text_buffer_get_iter_at_offset(buffer, &start, start_offset);
523 gtk_text_iter_forward_line(&start);
527 g_free(horizontal_blanks);
531 gboolean arrange = !(win->width == new_width && win->height == new_height);
532 win->width = new_width;
533 win->height = new_height;
534 return arrange? win : NULL;
537 /* For non-pair, non-text-grid windows, just give them the size */
538 gtk_widget_size_allocate(win->frame, allocation);
542 /* Overrides gtk_widget_size_allocate */
544 chimara_glk_size_allocate(GtkWidget *widget, GtkAllocation *allocation)
546 g_return_if_fail(widget);
547 g_return_if_fail(allocation);
548 g_return_if_fail(CHIMARA_IS_GLK(widget));
550 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(widget);
552 gtk_widget_set_allocation(widget, allocation);
554 if(priv->root_window) {
555 GtkAllocation child = *allocation;
556 winid_t arrange = allocate_recurse(priv->root_window->data, &child, priv->spacing);
558 /* arrange points to a window that contains all text grid and graphics
559 windows which have been resized */
560 g_mutex_lock(&priv->arrange_lock);
561 if(!priv->ignore_next_arrange_event)
564 event_throw(CHIMARA_GLK(widget), evtype_Arrange, arrange == priv->root_window->data? NULL : arrange, 0, 0);
567 priv->ignore_next_arrange_event = FALSE;
568 priv->needs_rearrange = FALSE;
569 g_cond_signal(&priv->rearranged);
570 g_mutex_unlock(&priv->arrange_lock);
574 /* Recursively invoke callback() on the GtkWidget of each non-pair window in the tree */
576 forall_recurse(winid_t win, GtkCallback callback, gpointer callback_data)
578 if(win->type == wintype_Pair)
580 forall_recurse(win->window_node->children->data, callback, callback_data);
581 forall_recurse(win->window_node->children->next->data, callback, callback_data);
584 (*callback)(win->frame, callback_data);
587 /* Overrides gtk_container_forall */
589 chimara_glk_forall(GtkContainer *container, gboolean include_internals, GtkCallback callback, gpointer callback_data)
591 g_return_if_fail(container);
592 g_return_if_fail(CHIMARA_IS_GLK(container));
594 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(container);
596 /* All the children are "internal" */
597 if(!include_internals)
600 if(priv->root_window)
601 forall_recurse(priv->root_window->data, callback, callback_data);
605 chimara_glk_stopped(ChimaraGlk *self)
607 CHIMARA_GLK_USE_PRIVATE(self, priv);
608 priv->running = FALSE;
609 priv->program_name = NULL;
610 g_object_notify(G_OBJECT(self), "program-name");
611 priv->program_info = NULL;
612 g_object_notify(G_OBJECT(self), "program-info");
613 priv->story_name = NULL;
614 g_object_notify(G_OBJECT(self), "story-name");
618 chimara_glk_started(ChimaraGlk *self)
620 CHIMARA_GLK_USE_PRIVATE(self, priv);
621 priv->running = TRUE;
625 chimara_glk_class_init(ChimaraGlkClass *klass)
627 /* Override methods of parent classes */
628 GObjectClass *object_class = G_OBJECT_CLASS(klass);
629 object_class->set_property = chimara_glk_set_property;
630 object_class->get_property = chimara_glk_get_property;
631 object_class->finalize = chimara_glk_finalize;
633 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS(klass);
634 widget_class->get_request_mode = chimara_glk_get_request_mode;
635 widget_class->get_preferred_width = chimara_glk_get_preferred_width;
636 widget_class->get_preferred_height = chimara_glk_get_preferred_height;
637 widget_class->size_allocate = chimara_glk_size_allocate;
639 GtkContainerClass *container_class = GTK_CONTAINER_CLASS(klass);
640 container_class->forall = chimara_glk_forall;
641 /* Automatically handle the GtkContainer:border-width property */
642 gtk_container_class_handle_border_width(container_class);
645 klass->stopped = chimara_glk_stopped;
646 klass->started = chimara_glk_started;
649 * ChimaraGlk::stopped:
650 * @glk: The widget that received the signal
652 * Emitted when the a Glk program finishes executing in the widget, whether
653 * it ended normally, or was interrupted.
655 chimara_glk_signals[STOPPED] = g_signal_new("stopped",
656 G_OBJECT_CLASS_TYPE(klass), G_SIGNAL_RUN_FIRST,
657 /* FIXME: Should be G_SIGNAL_RUN_CLEANUP but that segfaults??! */
658 G_STRUCT_OFFSET(ChimaraGlkClass, stopped), NULL, NULL,
659 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
661 * ChimaraGlk::started:
662 * @glk: The widget that received the signal
664 * Emitted when a Glk program starts executing in the widget.
666 chimara_glk_signals[STARTED] = g_signal_new ("started",
667 G_OBJECT_CLASS_TYPE(klass), G_SIGNAL_RUN_FIRST,
668 G_STRUCT_OFFSET(ChimaraGlkClass, started), NULL, NULL,
669 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
671 * ChimaraGlk::waiting:
672 * @glk: The widget that received the signal
674 * Emitted when glk_select() is called by the Glk program and the event
675 * queue is empty, which means that the widget is waiting for input.
677 chimara_glk_signals[WAITING] = g_signal_new("waiting",
678 G_OBJECT_CLASS_TYPE(klass), 0,
679 G_STRUCT_OFFSET(ChimaraGlkClass, waiting), NULL, NULL,
680 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
682 * ChimaraGlk::char-input:
683 * @self: The widget that received the signal
684 * @window_rock: The rock value of the window that received character input
685 * (see <link linkend="chimara-Rocks">Rocks</link>)
686 * @window_id_string: A string value uniquely identifying the window that
687 * received character input
688 * @keysym: The key that was typed, in the form of a key symbol from
689 * <filename class="headerfile">gdk/gdkkeysyms.h</filename>
691 * Emitted when a Glk window receives character input.
692 * The @window_rock can be used to identify the window.
693 * However, rock values in Glk are allowed to be identical for different
694 * windows, so Chimara also provides a string value with which the window
695 * can be uniquely identified.
697 chimara_glk_signals[CHAR_INPUT] = g_signal_new("char-input",
698 G_OBJECT_CLASS_TYPE(klass), 0,
699 G_STRUCT_OFFSET(ChimaraGlkClass, char_input), NULL, NULL,
700 _chimara_marshal_VOID__UINT_STRING_UINT,
701 G_TYPE_NONE, 3, G_TYPE_UINT, G_TYPE_STRING, G_TYPE_UINT);
703 * ChimaraGlk::line-input:
704 * @self: The widget that received the signal
705 * @window_rock: The rock value of the window that received line input (see
706 * <link linkend="chimara-Rocks">Rocks</link>)
707 * @window_id_string: A string value uniquely identifying the window that
709 * @text: The text that was typed
711 * Emitted when a Glk window receives line input.
712 * The @window_rock can be used to identify the window.
713 * However, rock values in Glk are allowed to be identical for different
714 * windows, so Chimara also provides a string value with which the window
715 * can be uniquely identified.
717 chimara_glk_signals[LINE_INPUT] = g_signal_new("line-input",
718 G_OBJECT_CLASS_TYPE(klass), 0,
719 G_STRUCT_OFFSET(ChimaraGlkClass, line_input), NULL, NULL,
720 _chimara_marshal_VOID__UINT_STRING_STRING,
721 G_TYPE_NONE, 3, G_TYPE_UINT, G_TYPE_STRING, G_TYPE_STRING);
723 * ChimaraGlk::text-buffer-output:
724 * @self: The widget that received the signal
725 * @window_rock: The rock value of the window that was printed to (see <link
726 * linkend="chimara-Rocks">Rocks</link>)
727 * @window_id_string: A string value uniquely identifying the window that
730 * Emitted when text is printed to a text buffer window.
731 * The @window_rock can be used to identify the window.
732 * However, rock values in Glk are allowed to be identical for different
733 * windows, so Chimara also provides a string value with which the window
734 * can be uniquely identified.
736 chimara_glk_signals[TEXT_BUFFER_OUTPUT] = g_signal_new("text-buffer-output",
737 G_OBJECT_CLASS_TYPE(klass), 0,
738 G_STRUCT_OFFSET(ChimaraGlkClass, text_buffer_output), NULL, NULL,
739 _chimara_marshal_VOID__UINT_STRING_STRING,
740 G_TYPE_NONE, 3, G_TYPE_UINT, G_TYPE_STRING, G_TYPE_STRING);
742 * ChimaraGlk::iliad-screen-update:
743 * @self: The widget that received the signal
744 * @typing: Whether to perform a typing or full screen update
746 * Iliad specific signal which is emitted whenever the screen needs to be updated.
747 * Since iliad screen updates are very slow, updating should only be done when
750 chimara_glk_signals[ILIAD_SCREEN_UPDATE] = g_signal_new("iliad-screen-update",
751 G_OBJECT_CLASS_TYPE(klass), 0,
752 G_STRUCT_OFFSET(ChimaraGlkClass, iliad_screen_update), NULL, NULL,
753 _chimara_marshal_VOID__BOOLEAN,
754 G_TYPE_NONE, 1, G_TYPE_BOOLEAN);
758 * ChimaraGlk:interactive:
760 * Sets whether the widget is interactive. A Glk widget is normally
761 * interactive, but in non-interactive mode, keyboard and mouse input are
762 * ignored and the Glk program is controlled by
763 * chimara_glk_feed_char_input() and chimara_glk_feed_line_input().
764 * <quote>More</quote> prompts when a lot of text is printed to a text
765 * buffer are also disabled. This is typically used when you wish to control
766 * an interpreter program by feeding it a predefined list of commands.
768 g_object_class_install_property( object_class, PROP_INTERACTIVE,
769 g_param_spec_boolean("interactive", _("Interactive"),
770 _("Whether user input is expected in the Glk program"),
772 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
775 * ChimaraGlk:protect:
777 * Sets whether the Glk program is allowed to do file operations. In protect
778 * mode, all file operations will fail.
780 g_object_class_install_property(object_class, PROP_PROTECT,
781 g_param_spec_boolean("protect", _("Protected"),
782 _("Whether the Glk program is barred from doing file operations"),
784 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
787 * ChimaraGlk:spacing:
789 * The amount of space between the Glk windows. This space forms a visible
790 * border between windows; however, if you open a window using the
791 * %winmethod_NoBorder flag, there will be no spacing between it and its
792 * sibling window, no matter what the value of this property is.
794 g_object_class_install_property(object_class, PROP_SPACING,
795 g_param_spec_uint("spacing", _("Spacing"),
796 _("The amount of space between Glk windows"),
798 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
801 * ChimaraGlk:program-name:
803 * The name of the currently running Glk program. You cannot set this
804 * property yourself. It is set to the filename of the plugin when you call
805 * chimara_glk_run(), but the plugin can change it by calling
806 * garglk_set_program_name(). To find out when this information changes,
807 * for example to put the program name in the title bar of a window, connect
808 * to the <code>::notify::program-name</code> signal.
810 g_object_class_install_property(object_class, PROP_PROGRAM_NAME,
811 g_param_spec_string("program-name", _("Program name"),
812 _("Name of the currently running program"),
814 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
817 * ChimaraGlk:program-info:
819 * Information about the currently running Glk program. You cannot set this
820 * property yourself. The plugin can change it by calling
821 * garglk_set_program_info(). See also #ChimaraGlk:program-name.
823 g_object_class_install_property(object_class, PROP_PROGRAM_INFO,
824 g_param_spec_string("program-info", _("Program info"),
825 _("Information about the currently running program"),
827 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
830 * ChimaraGlk:story-name:
832 * The name of the story currently running in the Glk interpreter. You
833 * cannot set this property yourself. It is set to the story filename when
834 * you call chimara_if_run_game(), but the plugin can change it by calling
835 * garglk_set_story_name().
837 * Strictly speaking, this should be a property of #ChimaraIF, but it is
838 * legal for any Glk program to call garglk_set_story_name(), even if it is
839 * not an interpreter and does not load story files.
841 g_object_class_install_property(object_class, PROP_STORY_NAME,
842 g_param_spec_string("story-name", _("Story name"),
843 _("Name of the story currently loaded in the interpreter"),
845 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
848 * ChimaraGlk:running:
850 * Whether this Glk widget is currently running a game or not.
852 g_object_class_install_property(object_class, PROP_RUNNING,
853 g_param_spec_boolean("running", _("Running"),
854 _("Whether there is a program currently running"),
856 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
859 g_type_class_add_private(klass, sizeof(ChimaraGlkPrivate));
862 /* PUBLIC FUNCTIONS */
865 * chimara_error_quark:
867 * The error domain for errors from Chimara widgets.
869 * Returns: The string <quote>chimara-error-quark</quote> as a <link
870 * linkend="GQuark">GQuark</link>.
873 chimara_error_quark(void)
875 chimara_init(); /* This is a library entry point */
876 return g_quark_from_static_string("chimara-error-quark");
882 * Creates and initializes a new #ChimaraGlk widget.
884 * Return value: a #ChimaraGlk widget, with a floating reference.
887 chimara_glk_new(void)
889 /* This is a library entry point; initialize the library */
892 return GTK_WIDGET(g_object_new(CHIMARA_TYPE_GLK, NULL));
896 * chimara_glk_set_interactive:
897 * @glk: a #ChimaraGlk widget
898 * @interactive: whether the widget should expect user input
900 * Sets the #ChimaraGlk:interactive property of @glk.
903 chimara_glk_set_interactive(ChimaraGlk *glk, gboolean interactive)
905 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
907 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
908 priv->interactive = interactive;
909 g_object_notify(G_OBJECT(glk), "interactive");
913 * chimara_glk_get_interactive:
914 * @glk: a #ChimaraGlk widget
916 * Returns whether @glk is interactive (expecting user input). See
917 * #ChimaraGlk:interactive.
919 * Return value: %TRUE if @glk is interactive.
922 chimara_glk_get_interactive(ChimaraGlk *glk)
924 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
926 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
927 return priv->interactive;
931 * chimara_glk_set_protect:
932 * @glk: a #ChimaraGlk widget
933 * @protect: whether the widget should allow the Glk program to do file
936 * Sets the #ChimaraGlk:protect property of @glk. In protect mode, the Glk
937 * program is not allowed to do file operations.
940 chimara_glk_set_protect(ChimaraGlk *glk, gboolean protect)
942 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
944 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
945 priv->protect = protect;
946 g_object_notify(G_OBJECT(glk), "protect");
950 * chimara_glk_get_protect:
951 * @glk: a #ChimaraGlk widget
953 * Returns whether @glk is in protect mode (banned from doing file operations).
954 * See #ChimaraGlk:protect.
956 * Return value: %TRUE if @glk is in protect mode.
959 chimara_glk_get_protect(ChimaraGlk *glk)
961 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
963 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
964 return priv->protect;
968 * chimara_glk_set_css_to_default:
969 * @glk: a #ChimaraGlk widget
971 * Resets the styles for text buffer and text grid windows to their defaults.
973 * This function is not implemented yet.
977 chimara_glk_set_css_to_default(ChimaraGlk *glk)
979 reset_default_styles(glk);
983 * chimara_glk_set_css_from_file:
984 * @glk: a #ChimaraGlk widget
985 * @filename: path to a CSS file, or %NULL
986 * @error: location to store a <link
987 * linkend="glib-Error-Reporting">GError</link>, or %NULL
989 * Sets the styles for text buffer and text grid windows according to the CSS
990 * file @filename. Note that the styles are set cumulatively on top of whatever
991 * the styles are at the time this function is called; to reset the styles to
992 * their defaults, use chimara_glk_set_css_to_default().
994 * Returns: %TRUE on success, %FALSE if an error occurred, in which case @error
998 chimara_glk_set_css_from_file(ChimaraGlk *glk, const gchar *filename, GError **error)
1000 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1001 g_return_val_if_fail(filename, FALSE);
1002 g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
1004 int fd = open(filename, O_RDONLY);
1007 *error = g_error_new(G_IO_ERROR, g_io_error_from_errno(errno),
1008 _("Error opening file \"%s\": %s"), filename, g_strerror(errno));
1012 GScanner *scanner = create_css_file_scanner();
1013 g_scanner_input_file(scanner, fd);
1014 scanner->input_name = filename;
1015 scan_css_file(scanner, glk);
1017 if(close(fd) == -1) {
1019 *error = g_error_new(G_IO_ERROR, g_io_error_from_errno(errno),
1020 _("Error closing file \"%s\": %s"), filename, g_strerror(errno));
1027 * chimara_glk_set_css_from_string:
1028 * @glk: a #ChimaraGlk widget
1029 * @css: a string containing CSS code
1031 * Sets the styles for text buffer and text grid windows according to the CSS
1032 * code @css. Note that the styles are set cumulatively on top of whatever the
1033 * styles are at the time this function is called; to reset the styles to their
1034 * defaults, use chimara_glk_set_css_to_default().
1037 chimara_glk_set_css_from_string(ChimaraGlk *glk, const gchar *css)
1039 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1040 g_return_if_fail(css || *css);
1042 GScanner *scanner = create_css_file_scanner();
1043 g_scanner_input_text(scanner, css, strlen(css));
1044 scanner->input_name = "<string>";
1045 scan_css_file(scanner, glk);
1049 * chimara_glk_set_spacing:
1050 * @glk: a #ChimaraGlk widget
1051 * @spacing: the number of pixels to put between Glk windows
1053 * Sets the #ChimaraGlk:spacing property of @glk, which is the border width in
1054 * pixels between Glk windows.
1057 chimara_glk_set_spacing(ChimaraGlk *glk, guint spacing)
1059 g_return_if_fail( glk || CHIMARA_IS_GLK(glk) );
1061 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1062 priv->spacing = spacing;
1063 g_object_notify(G_OBJECT(glk), "spacing");
1067 * chimara_glk_get_spacing:
1068 * @glk: a #ChimaraGlk widget
1070 * Gets the value set by chimara_glk_set_spacing().
1072 * Return value: pixels of spacing between Glk windows
1075 chimara_glk_get_spacing(ChimaraGlk *glk)
1077 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), 0);
1079 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1080 return priv->spacing;
1083 struct StartupData {
1084 glk_main_t glk_main;
1085 glkunix_startup_code_t glkunix_startup_code;
1086 glkunix_startup_t args;
1087 ChimaraGlkPrivate *glk_data;
1091 free_startup_data(struct StartupData *startup)
1094 while(i < startup->args.argc)
1095 g_free(startup->args.argv[i++]);
1096 g_free(startup->args.argv);
1097 g_slice_free(struct StartupData, startup);
1100 /* glk_enter() is the actual function called in the new thread in which
1101 glk_main() runs. Takes ownership of @startup and will free it. */
1103 glk_enter(struct StartupData *startup)
1105 extern GPrivate glk_data_key;
1106 g_private_set(&glk_data_key, startup->glk_data);
1108 /* Acquire the Glk thread's references to the input queues */
1109 g_async_queue_ref(startup->glk_data->char_input_queue);
1110 g_async_queue_ref(startup->glk_data->line_input_queue);
1112 /* Run startup function */
1113 if(startup->glkunix_startup_code) {
1114 startup->glk_data->in_startup = TRUE;
1115 int result = startup->glkunix_startup_code(&startup->args);
1116 startup->glk_data->in_startup = FALSE;
1119 free_startup_data(startup);
1124 /* Run main function */
1125 glk_main_t glk_main = startup->glk_main;
1127 g_signal_emit_by_name(startup->glk_data->self, "started");
1129 free_startup_data(startup);
1130 glk_exit(); /* Run shutdown code in glk_exit() even if glk_main() returns normally */
1131 g_assert_not_reached(); /* because glk_exit() calls g_thread_exit() */
1137 * @glk: a #ChimaraGlk widget
1138 * @plugin: path to a plugin module compiled with <filename
1139 * class="header">glk.h</filename>
1140 * @argc: Number of command line arguments in @argv
1141 * @argv: Array of command line arguments to pass to the plugin
1142 * @error: location to store a <link
1143 * linkend="glib-Error-Reporting">GError</link>, or %NULL
1145 * Opens a Glk program compiled as a plugin. Sorts out its command line
1146 * arguments from #glkunix_arguments, calls its startup function
1147 * glkunix_startup_code(), and then calls its main function glk_main() in
1148 * a separate thread. On failure, returns %FALSE and sets @error.
1150 * The plugin must at least export a glk_main() function; #glkunix_arguments and
1151 * glkunix_startup_code() are optional.
1153 * Return value: %TRUE if the Glk program was started successfully.
1156 chimara_glk_run(ChimaraGlk *glk, const gchar *plugin, int argc, char *argv[], GError **error)
1158 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1159 g_return_val_if_fail(plugin, FALSE);
1160 g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
1162 if(chimara_glk_get_running(glk)) {
1163 g_set_error(error, CHIMARA_ERROR, CHIMARA_PLUGIN_ALREADY_RUNNING, _("There was already a plugin running."));
1167 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1169 struct StartupData *startup = g_slice_new0(struct StartupData);
1171 g_assert( g_module_supported() );
1172 /* If there is already a module loaded, free it first -- you see, we want to
1173 * keep modules loaded as long as possible to avoid crashes in stack unwinding */
1174 chimara_glk_unload_plugin(glk);
1175 /* Open the module to run */
1176 priv->program = g_module_open(plugin, G_MODULE_BIND_LAZY);
1180 g_set_error(error, CHIMARA_ERROR, CHIMARA_LOAD_MODULE_ERROR, _("Error opening module: %s"), g_module_error());
1183 if( !g_module_symbol(priv->program, "glk_main", (gpointer *) &startup->glk_main) )
1185 g_set_error(error, CHIMARA_ERROR, CHIMARA_NO_GLK_MAIN, _("Error finding glk_main(): %s"), g_module_error());
1189 if( g_module_symbol(priv->program, "glkunix_startup_code", (gpointer *) &startup->glkunix_startup_code) )
1191 glkunix_argumentlist_t *glkunix_arguments;
1193 if( !(g_module_symbol(priv->program, "glkunix_arguments", (gpointer *) &glkunix_arguments)
1194 && parse_command_line(glkunix_arguments, argc, argv, &startup->args)) )
1196 /* arguments could not be parsed, so create data ourselves */
1197 startup->args.argc = 1;
1198 startup->args.argv = g_new0(gchar *, 1);
1201 /* Set the program invocation name */
1202 startup->args.argv[0] = g_strdup(plugin);
1204 startup->glk_data = priv;
1206 /* Set the program name */
1207 priv->program_name = g_path_get_basename(plugin);
1208 g_object_notify(G_OBJECT(glk), "program-name");
1210 /* Run in a separate thread */
1211 priv->thread = g_thread_try_new("glk", (GThreadFunc)glk_enter, startup, error);
1213 return !(priv->thread == NULL);
1217 * chimara_glk_run_file:
1218 * @self: a #ChimaraGlk widget
1219 * @plugin_file: a #GFile pointing to a plugin module compiled with <filename
1220 * class="header">glk.h</filename>
1221 * @argc: Number of command line arguments in @argv
1222 * @argv: Array of command line arguments to pass to the plugin
1223 * @error: location to store a <link
1224 * linkend="glib-Error-Reporting">GError</link>, or %NULL
1226 * Opens a Glk program compiled as a plugin, from a #GFile. See
1227 * chimara_glk_run() for details.
1229 * Return value: %TRUE if the Glk program was started successfully.
1232 chimara_glk_run_file(ChimaraGlk *self, GFile *plugin_file, int argc, char *argv[], GError **error)
1234 g_return_val_if_fail(self || CHIMARA_IS_GLK(self), FALSE);
1235 g_return_val_if_fail(plugin_file || G_IS_FILE(plugin_file), FALSE);
1236 g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
1238 char *path = g_file_get_path(plugin_file);
1239 gboolean retval = chimara_glk_run(self, path, argc, argv, error);
1247 * @glk: a #ChimaraGlk widget
1249 * Signals the Glk program running in @glk to abort. Note that if the program is
1250 * caught in an infinite loop in which glk_tick() is not called, this may not
1253 * This function does nothing if no Glk program is running.
1256 chimara_glk_stop(ChimaraGlk *glk)
1258 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1259 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1261 /* Don't do anything if not running a program */
1265 if(!priv->after_finalize) {
1266 g_mutex_lock(&priv->abort_lock);
1267 priv->abort_signalled = TRUE;
1268 g_mutex_unlock(&priv->abort_lock);
1269 /* Stop blocking on the event queue condition */
1270 event_throw(glk, evtype_Abort, NULL, 0, 0);
1271 /* Stop blocking on the shutdown key press condition */
1272 g_mutex_lock(&priv->shutdown_lock);
1273 g_cond_signal(&priv->shutdown_key_pressed);
1274 g_mutex_unlock(&priv->shutdown_lock);
1280 * @glk: a #ChimaraGlk widget
1282 * Holds up the main thread and waits for the Glk program running in @glk to
1285 * This function does nothing if no Glk program is running.
1288 chimara_glk_wait(ChimaraGlk *glk)
1290 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1291 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1292 /* Don't do anything if not running a program */
1295 /* Unlock GDK mutex, because the Glk program might need to use it for shutdown */
1296 gdk_threads_leave();
1297 g_thread_join(priv->thread);
1298 gdk_threads_enter();
1302 * chimara_glk_unload_plugin:
1303 * @glk: a #ChimaraGlk widget
1305 * The plugin containing the Glk program is unloaded as late as possible before
1306 * loading a new plugin, in order to prevent crashes while printing stack
1307 * backtraces during debugging. Sometimes this behavior is not desirable. This
1308 * function forces @glk to unload the plugin running in it.
1310 * This function does nothing if there is no plugin loaded.
1313 chimara_glk_unload_plugin(ChimaraGlk *glk)
1315 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1316 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1317 if( priv->program && !g_module_close(priv->program) )
1318 g_warning( "Error closing module :%s", g_module_error() );
1322 * chimara_glk_get_running:
1323 * @glk: a #ChimaraGlk widget
1325 * Use this function to tell whether a program is currently running in the
1328 * Returns: %TRUE if @glk is executing a Glk program, %FALSE otherwise.
1331 chimara_glk_get_running(ChimaraGlk *glk)
1333 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1334 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1335 return priv->running;
1339 * chimara_glk_feed_char_input:
1340 * @glk: a #ChimaraGlk widget
1341 * @keyval: a key symbol as defined in <filename
1342 * class="headerfile">gdk/gdkkeysyms.h</filename>
1344 * Pretend that a key was pressed in the Glk program as a response to a
1345 * character input request. You can call this function even when no window has
1346 * requested character input, in which case the key will be saved for the
1347 * following window that requests character input. This has the disadvantage
1348 * that if more than one window has requested character input, it is arbitrary
1349 * which one gets the key press.
1352 chimara_glk_feed_char_input(ChimaraGlk *glk, guint keyval)
1354 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1355 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1356 g_async_queue_push(priv->char_input_queue, GUINT_TO_POINTER(keyval));
1357 event_throw(glk, evtype_ForcedCharInput, NULL, 0, 0);
1361 * chimara_glk_feed_line_input:
1362 * @glk: a #ChimaraGlk widget
1363 * @text: text to pass to the next line input request
1365 * Pretend that @text was typed in the Glk program as a response to a line input
1366 * request. @text does not need to end with a newline. You can call this
1367 * function even when no window has requested line input, in which case the text
1368 * will be saved for the following window that requests line input. This has the
1369 * disadvantage that if more than one window has requested line input, it is
1370 * arbitrary which one gets the text.
1373 chimara_glk_feed_line_input(ChimaraGlk *glk, const gchar *text)
1375 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1376 g_return_if_fail(text);
1377 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1378 g_async_queue_push(priv->line_input_queue, g_strdup(text));
1379 event_throw(glk, evtype_ForcedLineInput, NULL, 0, 0);
1383 * chimara_glk_is_char_input_pending:
1384 * @glk: a #ChimaraGlk widget
1386 * Use this function to tell if character input forced by
1387 * chimara_glk_feed_char_input() has been passed to an input request or not.
1389 * Returns: %TRUE if forced character input is pending, %FALSE otherwise.
1392 chimara_glk_is_char_input_pending(ChimaraGlk *glk)
1394 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1395 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1396 return g_async_queue_length(priv->char_input_queue) > 0;
1400 * chimara_glk_is_line_input_pending:
1401 * @glk: a #ChimaraGlk widget
1403 * Use this function to tell if line input forced by
1404 * chimara_glk_feed_line_input() has been passed to an input request or not.
1406 * Returns: %TRUE if forced line input is pending, %FALSE otherwise.
1409 chimara_glk_is_line_input_pending(ChimaraGlk *glk)
1411 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1412 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1413 return g_async_queue_length(priv->line_input_queue) > 0;
1417 * chimara_glk_get_tag:
1418 * @glk: a #ChimaraGlk widget
1419 * @window: The type of window to retrieve the tag for
1420 * @name: The name of the tag to retrieve
1422 * Use this function to get a #GtkTextTag so style properties can be changed.
1423 * See also chimara_glk_set_css_from_string().
1425 * The layout of the text in Chimara is controlled by two sets of tags: one set
1426 * describing the style in text buffers and one for text grids. See also the
1427 * Glk specification for the difference between the two. The main narrative of
1428 * a game is usually rendered in text buffers, whereas text grids are mostly
1429 * used for status bars and in game menus.
1431 * The following tag names are supported:
1433 * <listitem><para>normal</para></listitem>
1434 * <listitem><para>emphasized</para></listitem>
1435 * <listitem><para>preformatted</para></listitem>
1436 * <listitem><para>header</para></listitem>
1437 * <listitem><para>subheader</para></listitem>
1438 * <listitem><para>alert</para></listitem>
1439 * <listitem><para>note</para></listitem>
1440 * <listitem><para>block-quote</para></listitem>
1441 * <listitem><para>input</para></listitem>
1442 * <listitem><para>user1</para></listitem>
1443 * <listitem><para>user2</para></listitem>
1444 * <listitem><para>hyperlink</para></listitem>
1445 * <listitem><para>pager</para></listitem>
1448 * Returns: (transfer none): The #GtkTextTag corresponding to @name in the
1449 * styles of @window.
1452 chimara_glk_get_tag(ChimaraGlk *glk, ChimaraGlkWindowType window, const gchar *name)
1454 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1457 case CHIMARA_GLK_TEXT_BUFFER:
1458 return GTK_TEXT_TAG( g_hash_table_lookup(priv->styles->text_buffer, name) );
1460 case CHIMARA_GLK_TEXT_GRID:
1461 return GTK_TEXT_TAG( g_hash_table_lookup(priv->styles->text_grid, name) );
1464 ILLEGAL_PARAM("Unknown window type: %u", window);
1470 * chimara_glk_get_tag_names:
1471 * @glk: a #ChimaraGlk widget
1472 * @num_tags: Return location for the number of tag names retrieved.
1474 * Retrieves the possible tag names to use in chimara_glk_get_tag().
1476 * Returns: (transfer none) (array length=num_tags) (element-type utf8):
1477 * Array of strings containing the tag names. This array is owned by Chimara,
1481 chimara_glk_get_tag_names(ChimaraGlk *glk, unsigned int *num_tags)
1483 g_return_val_if_fail(num_tags != NULL, NULL);
1485 *num_tags = CHIMARA_NUM_STYLES;
1486 return style_get_tag_names();
1490 * chimara_glk_set_resource_load_callback:
1491 * @glk: a #ChimaraGlk widget
1492 * @func: a function to call for loading resources, or %NULL
1493 * @user_data: user data to pass to @func, or %NULL
1494 * @destroy_user_data: a function to call for freeing @user_data, or %NULL
1496 * Sometimes it is preferable to load image and sound resources from somewhere
1497 * else than a Blorb file, for example while developing a game. Section 14 of
1498 * the <ulink url="http://eblong.com/zarf/blorb/blorb.html#s14">Blorb
1499 * specification</ulink> allows for this possibility. This function sets @func
1500 * to be called when the Glk program requests loading an image or sound without
1501 * a Blorb resource map having been loaded, optionally passing @user_data as an
1504 * Note that @func is only called if no Blorb resource map has been set; having
1505 * a resource map in place overrides this function.
1507 * If you pass non-%NULL for @destroy_user_data, then @glk takes ownership of
1508 * @user_data. When it is not needed anymore, it will be freed by calling
1509 * @destroy_user_data on it. If you wish to retain ownership of @user_data, pass
1510 * %NULL for @destroy_user_data.
1512 * To deactivate the callback, call this function with @func set to %NULL.
1515 chimara_glk_set_resource_load_callback(ChimaraGlk *glk, ChimaraResourceLoadFunc func, gpointer user_data, GDestroyNotify destroy_user_data)
1517 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1519 if(priv->resource_load_callback == func
1520 && priv->resource_load_callback_data == user_data
1521 && priv->resource_load_callback_destroy_data == destroy_user_data)
1524 if(priv->resource_load_callback_destroy_data)
1525 priv->resource_load_callback_destroy_data(priv->resource_load_callback_data);
1527 priv->resource_load_callback = func;
1528 priv->resource_load_callback_data = user_data;
1529 priv->resource_load_callback_destroy_data = destroy_user_data;