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->protect = FALSE;
162 priv->styles = g_new0(StyleSet,1);
163 priv->glk_styles = g_new0(StyleSet,1);
164 priv->final_message = g_strdup("[ The game has finished ]");
165 priv->running = FALSE;
166 priv->program = NULL;
168 priv->event_queue = g_queue_new();
169 priv->event_lock = g_mutex_new();
170 priv->event_queue_not_empty = g_cond_new();
171 priv->event_queue_not_full = g_cond_new();
172 priv->abort_lock = g_mutex_new();
173 priv->abort_signalled = FALSE;
174 priv->shutdown_lock = g_mutex_new();
175 priv->shutdown_key_pressed = g_cond_new();
176 priv->arrange_lock = g_mutex_new();
177 priv->rearranged = g_cond_new();
178 priv->needs_rearrange = FALSE;
179 priv->ignore_next_arrange_event = FALSE;
180 priv->char_input_queue = g_async_queue_new();
181 priv->line_input_queue = g_async_queue_new();
182 /* FIXME Should be g_async_queue_new_full(g_free); but only in GTK >= 2.16 */
183 priv->resource_map = NULL;
184 priv->resource_lock = g_mutex_new();
185 priv->resource_loaded = g_cond_new();
186 priv->resource_info_available = g_cond_new();
187 priv->resource_load_callback = NULL;
188 priv->resource_load_callback_data = NULL;
189 priv->image_cache = NULL;
190 priv->program_name = NULL;
191 priv->program_info = NULL;
192 priv->story_name = NULL;
193 priv->interrupt_handler = NULL;
194 priv->root_window = NULL;
195 priv->fileref_list = NULL;
196 priv->current_stream = NULL;
197 priv->stream_list = NULL;
199 priv->in_startup = FALSE;
200 priv->current_dir = NULL;
206 chimara_glk_set_property(GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
208 ChimaraGlk *glk = CHIMARA_GLK(object);
212 case PROP_INTERACTIVE:
213 chimara_glk_set_interactive( glk, g_value_get_boolean(value) );
216 chimara_glk_set_protect( glk, g_value_get_boolean(value) );
219 chimara_glk_set_spacing( glk, g_value_get_uint(value) );
222 G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
227 chimara_glk_get_property(GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
229 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(object);
233 case PROP_INTERACTIVE:
234 g_value_set_boolean(value, priv->interactive);
237 g_value_set_boolean(value, priv->protect);
240 g_value_set_uint(value, priv->spacing);
242 case PROP_PROGRAM_NAME:
243 g_value_set_string(value, priv->program_name);
245 case PROP_PROGRAM_INFO:
246 g_value_set_string(value, priv->program_info);
248 case PROP_STORY_NAME:
249 g_value_set_string(value, priv->story_name);
252 g_value_set_boolean(value, priv->running);
255 G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
260 chimara_glk_finalize(GObject *object)
262 ChimaraGlk *self = CHIMARA_GLK(object);
263 CHIMARA_GLK_USE_PRIVATE(self, priv);
265 /* Free widget properties */
266 g_free(priv->final_message);
268 g_hash_table_destroy(priv->styles->text_buffer);
269 g_hash_table_destroy(priv->styles->text_grid);
270 g_hash_table_destroy(priv->glk_styles->text_buffer);
271 g_hash_table_destroy(priv->glk_styles->text_grid);
273 /* Free the event queue */
274 g_mutex_lock(priv->event_lock);
275 g_queue_foreach(priv->event_queue, (GFunc)g_free, NULL);
276 g_queue_free(priv->event_queue);
277 g_cond_free(priv->event_queue_not_empty);
278 g_cond_free(priv->event_queue_not_full);
279 priv->event_queue = NULL;
280 g_mutex_unlock(priv->event_lock);
281 g_mutex_free(priv->event_lock);
282 /* Free the abort signaling mechanism */
283 g_mutex_lock(priv->abort_lock);
284 /* Make sure no other thread is busy with this */
285 g_mutex_unlock(priv->abort_lock);
286 g_mutex_free(priv->abort_lock);
287 priv->abort_lock = NULL;
288 /* Free the shutdown keypress signaling mechanism */
289 g_mutex_lock(priv->shutdown_lock);
290 g_cond_free(priv->shutdown_key_pressed);
291 g_mutex_unlock(priv->shutdown_lock);
292 priv->shutdown_lock = NULL;
293 /* Free the window arrangement signaling */
294 g_mutex_lock(priv->arrange_lock);
295 g_cond_free(priv->rearranged);
296 g_mutex_unlock(priv->arrange_lock);
297 g_mutex_free(priv->arrange_lock);
298 priv->arrange_lock = NULL;
299 g_mutex_lock(priv->resource_lock);
300 g_cond_free(priv->resource_loaded);
301 g_cond_free(priv->resource_info_available);
302 g_mutex_unlock(priv->resource_lock);
303 g_mutex_free(priv->resource_lock);
304 g_slist_foreach(priv->image_cache, (GFunc)clear_image_cache, NULL);
305 g_slist_free(priv->image_cache);
306 /* Unref input queues (this should destroy them since any Glk thread has stopped by now */
307 g_async_queue_unref(priv->char_input_queue);
308 g_async_queue_unref(priv->line_input_queue);
309 /* Destroy callback data if ownership retained */
310 if(priv->resource_load_callback_destroy_data)
311 priv->resource_load_callback_destroy_data(priv->resource_load_callback_data);
313 /* Free other stuff */
314 g_free(priv->current_dir);
315 g_free(priv->program_name);
316 g_free(priv->program_info);
317 g_free(priv->story_name);
318 g_free(priv->styles);
319 g_free(priv->glk_styles);
321 /* Chain up to parent */
322 G_OBJECT_CLASS(chimara_glk_parent_class)->finalize(object);
325 /* Implementation of get_request_mode(): Always request constant size */
326 static GtkSizeRequestMode
327 chimara_glk_get_request_mode(GtkWidget *widget)
329 return GTK_SIZE_REQUEST_CONSTANT_SIZE;
332 /* Minimal implementation of width request. Allocation in Glk is
333 strictly top-down, so we just request our current size by returning 1. */
335 chimara_glk_get_preferred_width(GtkWidget *widget, int *minimal, int *natural)
337 g_return_if_fail(widget || CHIMARA_IS_GLK(widget));
338 g_return_if_fail(minimal);
339 g_return_if_fail(natural);
341 *minimal = *natural = 1;
344 /* Minimal implementation of height request. Allocation in Glk is
345 strictly top-down, so we just request our current size by returning 1. */
347 chimara_glk_get_preferred_height(GtkWidget *widget, int *minimal, int *natural)
349 g_return_if_fail(widget || CHIMARA_IS_GLK(widget));
350 g_return_if_fail(minimal);
351 g_return_if_fail(natural);
353 *minimal = *natural = 1;
356 /* Recursively give the Glk windows their allocated space. Returns a window
357 containing all children of this window that must be redrawn, or NULL if there
358 are no children that require redrawing. */
360 allocate_recurse(winid_t win, GtkAllocation *allocation, guint spacing)
362 if(win->type == wintype_Pair)
364 glui32 division = win->split_method & winmethod_DivisionMask;
365 glui32 direction = win->split_method & winmethod_DirMask;
366 unsigned border = ((win->split_method & winmethod_BorderMask) == winmethod_NoBorder)? 0 : spacing;
368 /* If the space gets too small to honor the spacing property, then just
369 ignore spacing in this window and below. */
370 if( (border > allocation->width && (direction == winmethod_Left || direction == winmethod_Right))
371 || (border > allocation->height && (direction == winmethod_Above || direction == winmethod_Below)) )
374 GtkAllocation child1, child2;
375 child1.x = allocation->x;
376 child1.y = allocation->y;
378 if(division == winmethod_Fixed)
380 /* If the key window has been closed, then default to 0; otherwise
381 use the key window to determine the size */
385 child1.width = win->key_window?
386 CLAMP(win->constraint_size * win->key_window->unit_width, 0, allocation->width - border)
389 case winmethod_Right:
390 child2.width = win->key_window?
391 CLAMP(win->constraint_size * win->key_window->unit_width, 0, allocation->width - border)
394 case winmethod_Above:
395 child1.height = win->key_window?
396 CLAMP(win->constraint_size * win->key_window->unit_height, 0, allocation->height - border)
399 case winmethod_Below:
400 child2.height = win->key_window?
401 CLAMP(win->constraint_size * win->key_window->unit_height, 0, allocation->height - border)
406 else /* proportional */
408 gdouble fraction = win->constraint_size / 100.0;
412 child1.width = MAX(0, (gint)ceil(fraction * (allocation->width - border)) );
414 case winmethod_Right:
415 child2.width = MAX(0, (gint)ceil(fraction * (allocation->width - border)) );
417 case winmethod_Above:
418 child1.height = MAX(0, (gint)ceil(fraction * (allocation->height - border)) );
420 case winmethod_Below:
421 child2.height = MAX(0, (gint)ceil(fraction * (allocation->height - border)) );
426 /* Fill in the rest of the size requisitions according to the child specified above */
430 child2.width = MAX(0, allocation->width - border - child1.width);
431 child2.x = child1.x + child1.width + border;
433 child1.height = child2.height = allocation->height;
435 case winmethod_Right:
436 child1.width = MAX(0, allocation->width - border - child2.width);
437 child2.x = child1.x + child1.width + border;
439 child1.height = child2.height = allocation->height;
441 case winmethod_Above:
442 child2.height = MAX(0, allocation->height - border - child1.height);
444 child2.y = child1.y + child1.height + border;
445 child1.width = child2.width = allocation->width;
447 case winmethod_Below:
448 child1.height = MAX(0, allocation->height - border - child2.height);
450 child2.y = child1.y + child1.height + border;
451 child1.width = child2.width = allocation->width;
456 winid_t arrange1 = allocate_recurse(win->window_node->children->data, &child1, spacing);
457 winid_t arrange2 = allocate_recurse(win->window_node->children->next->data, &child2, spacing);
465 else if(win->type == wintype_TextGrid)
467 /* Pass the size allocation on to the framing widget */
468 gtk_widget_size_allocate(win->frame, allocation);
469 /* It says in the spec that when a text grid window is resized smaller,
470 the bottom or right area is thrown away; when it is resized larger, the
471 bottom or right area is filled with blanks. */
472 GtkAllocation widget_allocation;
473 gtk_widget_get_allocation(win->widget, &widget_allocation);
474 glui32 new_width = (glui32)(widget_allocation.width / win->unit_width);
475 glui32 new_height = (glui32)(widget_allocation.height / win->unit_height);
477 if(new_width != win->width || new_height != win->height)
479 // Window has changed size, trim or expand the textbuffer if necessary.
480 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
481 GtkTextIter start, end;
483 // Add or remove lines
484 if(new_height == 0) {
485 gtk_text_buffer_get_start_iter(buffer, &start);
486 gtk_text_buffer_get_end_iter(buffer, &end);
487 gtk_text_buffer_delete(buffer, &start, &end);
489 else if(new_height < win->height)
491 // Remove surplus lines
492 gtk_text_buffer_get_end_iter(buffer, &end);
493 gtk_text_buffer_get_iter_at_line(buffer, &start, new_height-1);
494 gtk_text_iter_forward_to_line_end(&start);
495 gtk_text_buffer_delete(buffer, &start, &end);
498 else if(new_height > win->height)
501 gint lines_to_add = new_height - win->height;
502 gtk_text_buffer_get_end_iter(buffer, &end);
505 gchar *blanks = g_strnfill(win->width, ' ');
506 gchar **blanklines = g_new0(gchar *, lines_to_add + 1);
508 for(count = 0; count < lines_to_add; count++)
509 blanklines[count] = blanks;
510 blanklines[lines_to_add] = NULL;
511 gchar *vertical_blanks = g_strjoinv("\n", blanklines);
516 gtk_text_buffer_insert(buffer, &end, "\n", 1);
518 gtk_text_buffer_insert(buffer, &end, vertical_blanks, -1);
521 // Trim or expand lines
522 if(new_width < win->width) {
523 gtk_text_buffer_get_start_iter(buffer, &start);
527 for(line = 0; line <= new_height; line++) {
529 gtk_text_iter_forward_cursor_positions(&start, new_width);
530 gtk_text_iter_forward_to_line_end(&end);
531 gtk_text_buffer_delete(buffer, &start, &end);
532 gtk_text_iter_forward_line(&start);
535 } else if(new_width > win->width) {
536 gint chars_to_add = new_width - win->width;
537 gchar *horizontal_blanks = g_strnfill(chars_to_add, ' ');
539 gtk_text_buffer_get_start_iter(buffer, &start);
543 for(line = 0; line <= new_height; line++) {
544 gtk_text_iter_forward_to_line_end(&start);
546 gint start_offset = gtk_text_iter_get_offset(&start);
547 gtk_text_buffer_insert(buffer, &end, horizontal_blanks, -1);
548 gtk_text_buffer_get_iter_at_offset(buffer, &start, start_offset);
549 gtk_text_iter_forward_line(&start);
553 g_free(horizontal_blanks);
557 gboolean arrange = !(win->width == new_width && win->height == new_height);
558 win->width = new_width;
559 win->height = new_height;
560 return arrange? win : NULL;
563 /* For non-pair, non-text-grid windows, just give them the size */
564 gtk_widget_size_allocate(win->frame, allocation);
568 /* Overrides gtk_widget_size_allocate */
570 chimara_glk_size_allocate(GtkWidget *widget, GtkAllocation *allocation)
572 g_return_if_fail(widget);
573 g_return_if_fail(allocation);
574 g_return_if_fail(CHIMARA_IS_GLK(widget));
576 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(widget);
578 gtk_widget_set_allocation(widget, allocation);
580 if(priv->root_window) {
581 GtkAllocation child = *allocation;
582 winid_t arrange = allocate_recurse(priv->root_window->data, &child, priv->spacing);
584 /* arrange points to a window that contains all text grid and graphics
585 windows which have been resized */
586 g_mutex_lock(priv->arrange_lock);
587 if(!priv->ignore_next_arrange_event)
590 event_throw(CHIMARA_GLK(widget), evtype_Arrange, arrange == priv->root_window->data? NULL : arrange, 0, 0);
593 priv->ignore_next_arrange_event = FALSE;
594 priv->needs_rearrange = FALSE;
595 g_cond_signal(priv->rearranged);
596 g_mutex_unlock(priv->arrange_lock);
600 /* Recursively invoke callback() on the GtkWidget of each non-pair window in the tree */
602 forall_recurse(winid_t win, GtkCallback callback, gpointer callback_data)
604 if(win->type == wintype_Pair)
606 forall_recurse(win->window_node->children->data, callback, callback_data);
607 forall_recurse(win->window_node->children->next->data, callback, callback_data);
610 (*callback)(win->frame, callback_data);
613 /* Overrides gtk_container_forall */
615 chimara_glk_forall(GtkContainer *container, gboolean include_internals, GtkCallback callback, gpointer callback_data)
617 g_return_if_fail(container);
618 g_return_if_fail(CHIMARA_IS_GLK(container));
620 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(container);
622 /* All the children are "internal" */
623 if(!include_internals)
626 if(priv->root_window)
627 forall_recurse(priv->root_window->data, callback, callback_data);
631 chimara_glk_stopped(ChimaraGlk *self)
633 CHIMARA_GLK_USE_PRIVATE(self, priv);
634 priv->running = FALSE;
635 priv->program_name = NULL;
636 g_object_notify(G_OBJECT(self), "program-name");
637 priv->program_info = NULL;
638 g_object_notify(G_OBJECT(self), "program-info");
639 priv->story_name = NULL;
640 g_object_notify(G_OBJECT(self), "story-name");
644 chimara_glk_started(ChimaraGlk *self)
646 CHIMARA_GLK_USE_PRIVATE(self, priv);
647 priv->running = TRUE;
651 chimara_glk_waiting(ChimaraGlk *self)
653 /* Default signal handler */
657 chimara_glk_char_input(ChimaraGlk *self, guint window_rock, guint keysym)
659 /* Default signal handler */
663 chimara_glk_line_input(ChimaraGlk *self, guint window_rock, gchar *text)
665 /* Default signal handler */
669 chimara_glk_text_buffer_output(ChimaraGlk *self, guint window_rock, gchar *text)
671 /* Default signal handler */
675 chimara_glk_iliad_screen_update(ChimaraGlk *self, gboolean typing)
677 /* Default signal handler */
681 chimara_glk_class_init(ChimaraGlkClass *klass)
683 /* Override methods of parent classes */
684 GObjectClass *object_class = G_OBJECT_CLASS(klass);
685 object_class->set_property = chimara_glk_set_property;
686 object_class->get_property = chimara_glk_get_property;
687 object_class->finalize = chimara_glk_finalize;
689 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS(klass);
690 widget_class->get_request_mode = chimara_glk_get_request_mode;
691 widget_class->get_preferred_width = chimara_glk_get_preferred_width;
692 widget_class->get_preferred_height = chimara_glk_get_preferred_height;
693 widget_class->size_allocate = chimara_glk_size_allocate;
695 GtkContainerClass *container_class = GTK_CONTAINER_CLASS(klass);
696 container_class->forall = chimara_glk_forall;
697 /* Automatically handle the GtkContainer:border-width property */
698 gtk_container_class_handle_border_width(container_class);
701 klass->stopped = chimara_glk_stopped;
702 klass->started = chimara_glk_started;
703 klass->waiting = chimara_glk_waiting;
704 klass->char_input = chimara_glk_char_input;
705 klass->line_input = chimara_glk_line_input;
706 klass->text_buffer_output = chimara_glk_text_buffer_output;
707 klass->iliad_screen_update = chimara_glk_iliad_screen_update;
710 * ChimaraGlk::stopped:
711 * @glk: The widget that received the signal
713 * Emitted when the a Glk program finishes executing in the widget, whether
714 * it ended normally, or was interrupted.
716 chimara_glk_signals[STOPPED] = g_signal_new("stopped",
717 G_OBJECT_CLASS_TYPE(klass), G_SIGNAL_RUN_FIRST,
718 /* FIXME: Should be G_SIGNAL_RUN_CLEANUP but that segfaults??! */
719 G_STRUCT_OFFSET(ChimaraGlkClass, stopped), NULL, NULL,
720 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
722 * ChimaraGlk::started:
723 * @glk: The widget that received the signal
725 * Emitted when a Glk program starts executing in the widget.
727 chimara_glk_signals[STARTED] = g_signal_new ("started",
728 G_OBJECT_CLASS_TYPE(klass), G_SIGNAL_RUN_FIRST,
729 G_STRUCT_OFFSET(ChimaraGlkClass, started), NULL, NULL,
730 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
732 * ChimaraGlk::waiting:
733 * @glk: The widget that received the signal
735 * Emitted when glk_select() is called by the Glk program and the event
736 * queue is empty, which means that the widget is waiting for input.
738 chimara_glk_signals[WAITING] = g_signal_new("waiting",
739 G_OBJECT_CLASS_TYPE(klass), 0,
740 G_STRUCT_OFFSET(ChimaraGlkClass, waiting), NULL, NULL,
741 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
743 * ChimaraGlk::char-input:
744 * @glk: The widget that received the signal
745 * @window_rock: The rock value of the window that received character input
746 * (see <link linkend="chimara-Rocks">Rocks</link>)
747 * @keysym: The key that was typed, in the form of a key symbol from
748 * <filename class="headerfile">gdk/gdkkeysyms.h</filename>
750 * Emitted when a Glk window receives character input.
752 chimara_glk_signals[CHAR_INPUT] = g_signal_new("char-input",
753 G_OBJECT_CLASS_TYPE(klass), 0,
754 G_STRUCT_OFFSET(ChimaraGlkClass, char_input), NULL, NULL,
755 _chimara_marshal_VOID__UINT_UINT,
756 G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_UINT);
758 * ChimaraGlk::line-input:
759 * @glk: The widget that received the signal
760 * @window_rock: The rock value of the window that received line input (see
761 * <link linkend="chimara-Rocks">Rocks</link>)
762 * @text: The text that was typed
764 * Emitted when a Glk window receives line input.
766 chimara_glk_signals[LINE_INPUT] = g_signal_new("line-input",
767 G_OBJECT_CLASS_TYPE(klass), 0,
768 G_STRUCT_OFFSET(ChimaraGlkClass, line_input), NULL, NULL,
769 _chimara_marshal_VOID__UINT_STRING,
770 G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_STRING);
772 * ChimaraGlk::text-buffer-output:
773 * @glk: The widget that received the signal
774 * @window_rock: The rock value of the window that was printed to (see <link
775 * linkend="chimara-Rocks">Rocks</link>)
777 * Emitted when text is printed to a text buffer window.
779 chimara_glk_signals[TEXT_BUFFER_OUTPUT] = g_signal_new("text-buffer-output",
780 G_OBJECT_CLASS_TYPE(klass), 0,
781 G_STRUCT_OFFSET(ChimaraGlkClass, text_buffer_output), NULL, NULL,
782 _chimara_marshal_VOID__UINT_STRING,
783 G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_STRING);
785 * ChimaraGlk::iliad-screen-update:
786 * @self: The widget that received the signal
787 * @typing: Whether to perform a typing or full screen update
789 * Iliad specific signal which is emitted whenever the screen needs to be updated.
790 * Since iliad screen updates are very slow, updating should only be done when
793 chimara_glk_signals[ILIAD_SCREEN_UPDATE] = g_signal_new("iliad-screen-update",
794 G_OBJECT_CLASS_TYPE(klass), 0,
795 G_STRUCT_OFFSET(ChimaraGlkClass, iliad_screen_update), NULL, NULL,
796 _chimara_marshal_VOID__BOOLEAN,
797 G_TYPE_NONE, 1, G_TYPE_BOOLEAN);
801 * ChimaraGlk:interactive:
803 * Sets whether the widget is interactive. A Glk widget is normally
804 * interactive, but in non-interactive mode, keyboard and mouse input are
805 * ignored and the Glk program is controlled by
806 * chimara_glk_feed_char_input() and chimara_glk_feed_line_input().
807 * <quote>More</quote> prompts when a lot of text is printed to a text
808 * buffer are also disabled. This is typically used when you wish to control
809 * an interpreter program by feeding it a predefined list of commands.
811 g_object_class_install_property( object_class, PROP_INTERACTIVE,
812 g_param_spec_boolean("interactive", _("Interactive"),
813 _("Whether user input is expected in the Glk program"),
815 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
818 * ChimaraGlk:protect:
820 * Sets whether the Glk program is allowed to do file operations. In protect
821 * mode, all file operations will fail.
823 g_object_class_install_property(object_class, PROP_PROTECT,
824 g_param_spec_boolean("protect", _("Protected"),
825 _("Whether the Glk program is barred from doing file operations"),
827 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
830 * ChimaraGlk:spacing:
832 * The amount of space between the Glk windows. This space forms a visible
833 * border between windows; however, if you open a window using the
834 * %winmethod_NoBorder flag, there will be no spacing between it and its
835 * sibling window, no matter what the value of this property is.
837 g_object_class_install_property(object_class, PROP_SPACING,
838 g_param_spec_uint("spacing", _("Spacing"),
839 _("The amount of space between Glk windows"),
841 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
844 * ChimaraGlk:program-name:
846 * The name of the currently running Glk program. You cannot set this
847 * property yourself. It is set to the filename of the plugin when you call
848 * chimara_glk_run(), but the plugin can change it by calling
849 * garglk_set_program_name(). To find out when this information changes,
850 * for example to put the program name in the title bar of a window, connect
851 * to the <code>::notify::program-name</code> signal.
853 g_object_class_install_property(object_class, PROP_PROGRAM_NAME,
854 g_param_spec_string("program-name", _("Program name"),
855 _("Name of the currently running program"),
857 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
860 * ChimaraGlk:program-info:
862 * Information about the currently running Glk program. You cannot set this
863 * property yourself. The plugin can change it by calling
864 * garglk_set_program_info(). See also #ChimaraGlk:program-name.
866 g_object_class_install_property(object_class, PROP_PROGRAM_INFO,
867 g_param_spec_string("program-info", _("Program info"),
868 _("Information about the currently running program"),
870 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
873 * ChimaraGlk:story-name:
875 * The name of the story currently running in the Glk interpreter. You
876 * cannot set this property yourself. It is set to the story filename when
877 * you call chimara_if_run_game(), but the plugin can change it by calling
878 * garglk_set_story_name().
880 * Strictly speaking, this should be a property of #ChimaraIF, but it is
881 * legal for any Glk program to call garglk_set_story_name(), even if it is
882 * not an interpreter and does not load story files.
884 g_object_class_install_property(object_class, PROP_STORY_NAME,
885 g_param_spec_string("story-name", _("Story name"),
886 _("Name of the story currently loaded in the interpreter"),
888 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
891 * ChimaraGlk:running:
893 * Whether this Glk widget is currently running a game or not.
895 g_object_class_install_property(object_class, PROP_RUNNING,
896 g_param_spec_boolean("running", _("Running"),
897 _("Whether there is a program currently running"),
899 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
902 g_type_class_add_private(klass, sizeof(ChimaraGlkPrivate));
905 /* PUBLIC FUNCTIONS */
908 * chimara_error_quark:
910 * The error domain for errors from Chimara widgets.
912 * Returns: The string <quote>chimara-error-quark</quote> as a <link
913 * linkend="GQuark">GQuark</link>.
916 chimara_error_quark(void)
918 chimara_init(); /* This is a library entry point */
919 return g_quark_from_static_string("chimara-error-quark");
925 * Creates and initializes a new #ChimaraGlk widget.
927 * Return value: a #ChimaraGlk widget, with a floating reference.
930 chimara_glk_new(void)
932 /* This is a library entry point; initialize the library */
935 return GTK_WIDGET(g_object_new(CHIMARA_TYPE_GLK, NULL));
939 * chimara_glk_set_interactive:
940 * @glk: a #ChimaraGlk widget
941 * @interactive: whether the widget should expect user input
943 * Sets the #ChimaraGlk:interactive property of @glk.
946 chimara_glk_set_interactive(ChimaraGlk *glk, gboolean interactive)
948 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
950 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
951 priv->interactive = interactive;
952 g_object_notify(G_OBJECT(glk), "interactive");
956 * chimara_glk_get_interactive:
957 * @glk: a #ChimaraGlk widget
959 * Returns whether @glk is interactive (expecting user input). See
960 * #ChimaraGlk:interactive.
962 * Return value: %TRUE if @glk is interactive.
965 chimara_glk_get_interactive(ChimaraGlk *glk)
967 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
969 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
970 return priv->interactive;
974 * chimara_glk_set_protect:
975 * @glk: a #ChimaraGlk widget
976 * @protect: whether the widget should allow the Glk program to do file
979 * Sets the #ChimaraGlk:protect property of @glk. In protect mode, the Glk
980 * program is not allowed to do file operations.
983 chimara_glk_set_protect(ChimaraGlk *glk, gboolean protect)
985 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
987 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
988 priv->protect = protect;
989 g_object_notify(G_OBJECT(glk), "protect");
993 * chimara_glk_get_protect:
994 * @glk: a #ChimaraGlk widget
996 * Returns whether @glk is in protect mode (banned from doing file operations).
997 * See #ChimaraGlk:protect.
999 * Return value: %TRUE if @glk is in protect mode.
1002 chimara_glk_get_protect(ChimaraGlk *glk)
1004 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1006 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1007 return priv->protect;
1011 * chimara_glk_set_css_to_default:
1012 * @glk: a #ChimaraGlk widget
1014 * Resets the styles for text buffer and text grid windows to their defaults.
1016 * This function is not implemented yet.
1020 chimara_glk_set_css_to_default(ChimaraGlk *glk)
1022 reset_default_styles(glk);
1026 * chimara_glk_set_css_from_file:
1027 * @glk: a #ChimaraGlk widget
1028 * @filename: path to a CSS file, or %NULL
1029 * @error: location to store a <link
1030 * linkend="glib-Error-Reporting">GError</link>, or %NULL
1032 * Sets the styles for text buffer and text grid windows according to the CSS
1033 * file @filename. Note that the styles are set cumulatively on top of whatever
1034 * the styles are at the time this function is called; to reset the styles to
1035 * their defaults, use chimara_glk_set_css_to_default().
1037 * Returns: %TRUE on success, %FALSE if an error occurred, in which case @error
1041 chimara_glk_set_css_from_file(ChimaraGlk *glk, const gchar *filename, GError **error)
1043 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1044 g_return_val_if_fail(filename, FALSE);
1045 g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
1047 int fd = open(filename, O_RDONLY);
1050 *error = g_error_new(G_IO_ERROR, g_io_error_from_errno(errno),
1051 _("Error opening file \"%s\": %s"), filename, g_strerror(errno));
1055 GScanner *scanner = create_css_file_scanner();
1056 g_scanner_input_file(scanner, fd);
1057 scanner->input_name = filename;
1058 scan_css_file(scanner, glk);
1060 if(close(fd) == -1) {
1062 *error = g_error_new(G_IO_ERROR, g_io_error_from_errno(errno),
1063 _("Error closing file \"%s\": %s"), filename, g_strerror(errno));
1070 * chimara_glk_set_css_from_string:
1071 * @glk: a #ChimaraGlk widget
1072 * @css: a string containing CSS code
1074 * Sets the styles for text buffer and text grid windows according to the CSS
1075 * code @css. Note that the styles are set cumulatively on top of whatever the
1076 * styles are at the time this function is called; to reset the styles to their
1077 * defaults, use chimara_glk_set_css_to_default().
1080 chimara_glk_set_css_from_string(ChimaraGlk *glk, const gchar *css)
1082 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1083 g_return_if_fail(css || *css);
1085 GScanner *scanner = create_css_file_scanner();
1086 g_scanner_input_text(scanner, css, strlen(css));
1087 scanner->input_name = "<string>";
1088 scan_css_file(scanner, glk);
1092 * chimara_glk_set_spacing:
1093 * @glk: a #ChimaraGlk widget
1094 * @spacing: the number of pixels to put between Glk windows
1096 * Sets the #ChimaraGlk:spacing property of @glk, which is the border width in
1097 * pixels between Glk windows.
1100 chimara_glk_set_spacing(ChimaraGlk *glk, guint spacing)
1102 g_return_if_fail( glk || CHIMARA_IS_GLK(glk) );
1104 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1105 priv->spacing = spacing;
1106 g_object_notify(G_OBJECT(glk), "spacing");
1110 * chimara_glk_get_spacing:
1111 * @glk: a #ChimaraGlk widget
1113 * Gets the value set by chimara_glk_set_spacing().
1115 * Return value: pixels of spacing between Glk windows
1118 chimara_glk_get_spacing(ChimaraGlk *glk)
1120 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), 0);
1122 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1123 return priv->spacing;
1126 struct StartupData {
1127 glk_main_t glk_main;
1128 glkunix_startup_code_t glkunix_startup_code;
1129 glkunix_startup_t args;
1130 ChimaraGlkPrivate *glk_data;
1133 /* glk_enter() is the actual function called in the new thread in which glk_main() runs. */
1135 glk_enter(struct StartupData *startup)
1137 extern GPrivate *glk_data_key;
1138 g_private_set(glk_data_key, startup->glk_data);
1140 /* Acquire the Glk thread's references to the input queues */
1141 g_async_queue_ref(startup->glk_data->char_input_queue);
1142 g_async_queue_ref(startup->glk_data->line_input_queue);
1144 /* Run startup function */
1145 if(startup->glkunix_startup_code) {
1146 startup->glk_data->in_startup = TRUE;
1147 int result = startup->glkunix_startup_code(&startup->args);
1148 startup->glk_data->in_startup = FALSE;
1151 while(i < startup->args.argc)
1152 g_free(startup->args.argv[i++]);
1153 g_free(startup->args.argv);
1159 /* Run main function */
1160 glk_main_t glk_main = startup->glk_main;
1162 /* COMPAT: avoid usage of slices */
1164 g_signal_emit_by_name(startup->glk_data->self, "started");
1166 glk_exit(); /* Run shutdown code in glk_exit() even if glk_main() returns normally */
1167 g_assert_not_reached(); /* because glk_exit() calls g_thread_exit() */
1173 * @glk: a #ChimaraGlk widget
1174 * @plugin: path to a plugin module compiled with <filename
1175 * class="header">glk.h</filename>
1176 * @argc: Number of command line arguments in @argv
1177 * @argv: Array of command line arguments to pass to the plugin
1178 * @error: location to store a <link
1179 * linkend="glib-Error-Reporting">GError</link>, or %NULL
1181 * Opens a Glk program compiled as a plugin. Sorts out its command line
1182 * arguments from #glkunix_arguments, calls its startup function
1183 * glkunix_startup_code(), and then calls its main function glk_main() in
1184 * a separate thread. On failure, returns %FALSE and sets @error.
1186 * The plugin must at least export a glk_main() function; #glkunix_arguments and
1187 * glkunix_startup_code() are optional.
1189 * Return value: %TRUE if the Glk program was started successfully.
1192 chimara_glk_run(ChimaraGlk *glk, const gchar *plugin, int argc, char *argv[], GError **error)
1194 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1195 g_return_val_if_fail(plugin, FALSE);
1196 g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
1198 if(chimara_glk_get_running(glk)) {
1199 g_set_error(error, CHIMARA_ERROR, CHIMARA_PLUGIN_ALREADY_RUNNING, _("There was already a plugin running."));
1203 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1205 /* COMPAT: avoid usage of slices */
1206 struct StartupData *startup = g_new0(struct StartupData,1);
1208 g_assert( g_module_supported() );
1209 /* If there is already a module loaded, free it first -- you see, we want to
1210 * keep modules loaded as long as possible to avoid crashes in stack unwinding */
1211 chimara_glk_unload_plugin(glk);
1212 /* Open the module to run */
1213 priv->program = g_module_open(plugin, G_MODULE_BIND_LAZY);
1217 g_set_error(error, CHIMARA_ERROR, CHIMARA_LOAD_MODULE_ERROR, _("Error opening module: %s"), g_module_error());
1220 if( !g_module_symbol(priv->program, "glk_main", (gpointer *) &startup->glk_main) )
1222 g_set_error(error, CHIMARA_ERROR, CHIMARA_NO_GLK_MAIN, _("Error finding glk_main(): %s"), g_module_error());
1226 if( g_module_symbol(priv->program, "glkunix_startup_code", (gpointer *) &startup->glkunix_startup_code) )
1228 glkunix_argumentlist_t *glkunix_arguments;
1230 if( !(g_module_symbol(priv->program, "glkunix_arguments", (gpointer *) &glkunix_arguments)
1231 && parse_command_line(glkunix_arguments, argc, argv, &startup->args)) )
1233 /* arguments could not be parsed, so create data ourselves */
1234 startup->args.argc = 1;
1235 startup->args.argv = g_new0(gchar *, 1);
1238 /* Set the program invocation name */
1239 startup->args.argv[0] = g_strdup(plugin);
1241 startup->glk_data = priv;
1243 /* Set the program name */
1244 priv->program_name = g_path_get_basename(plugin);
1245 g_object_notify(G_OBJECT(glk), "program-name");
1247 /* Run in a separate thread */
1248 priv->thread = g_thread_create((GThreadFunc)glk_enter, startup, TRUE, error);
1250 return !(priv->thread == NULL);
1254 * chimara_glk_run_file:
1255 * @self: a #ChimaraGlk widget
1256 * @plugin_file: a #GFile pointing to a plugin module compiled with <filename
1257 * class="header">glk.h</filename>
1258 * @argc: Number of command line arguments in @argv
1259 * @argv: Array of command line arguments to pass to the plugin
1260 * @error: location to store a <link
1261 * linkend="glib-Error-Reporting">GError</link>, or %NULL
1263 * Opens a Glk program compiled as a plugin, from a #GFile. See
1264 * chimara_glk_run() for details.
1266 * Return value: %TRUE if the Glk program was started successfully.
1269 chimara_glk_run_file(ChimaraGlk *self, GFile *plugin_file, int argc, char *argv[], GError **error)
1271 g_return_val_if_fail(self || CHIMARA_IS_GLK(self), FALSE);
1272 g_return_val_if_fail(plugin_file || G_IS_FILE(plugin_file), FALSE);
1273 g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
1275 char *path = g_file_get_path(plugin_file);
1276 gboolean retval = chimara_glk_run(self, path, argc, argv, error);
1284 * @glk: a #ChimaraGlk widget
1286 * Signals the Glk program running in @glk to abort. Note that if the program is
1287 * caught in an infinite loop in which glk_tick() is not called, this may not
1290 * This function does nothing if no Glk program is running.
1293 chimara_glk_stop(ChimaraGlk *glk)
1295 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1296 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1298 /* Don't do anything if not running a program */
1302 if(priv->abort_lock) {
1303 g_mutex_lock(priv->abort_lock);
1304 priv->abort_signalled = TRUE;
1305 g_mutex_unlock(priv->abort_lock);
1306 /* Stop blocking on the event queue condition */
1307 event_throw(glk, evtype_Abort, NULL, 0, 0);
1308 /* Stop blocking on the shutdown key press condition */
1309 g_mutex_lock(priv->shutdown_lock);
1310 g_cond_signal(priv->shutdown_key_pressed);
1311 g_mutex_unlock(priv->shutdown_lock);
1317 * @glk: a #ChimaraGlk widget
1319 * Holds up the main thread and waits for the Glk program running in @glk to
1322 * This function does nothing if no Glk program is running.
1325 chimara_glk_wait(ChimaraGlk *glk)
1327 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1328 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1329 /* Don't do anything if not running a program */
1332 /* Unlock GDK mutex, because the Glk program might need to use it for shutdown */
1333 gdk_threads_leave();
1334 g_thread_join(priv->thread);
1335 gdk_threads_enter();
1339 * chimara_glk_unload_plugin:
1340 * @glk: a #ChimaraGlk widget
1342 * The plugin containing the Glk program is unloaded as late as possible before
1343 * loading a new plugin, in order to prevent crashes while printing stack
1344 * backtraces during debugging. Sometimes this behavior is not desirable. This
1345 * function forces @glk to unload the plugin running in it.
1347 * This function does nothing if there is no plugin loaded.
1350 chimara_glk_unload_plugin(ChimaraGlk *glk)
1352 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1353 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1354 if( priv->program && !g_module_close(priv->program) )
1355 g_warning( "Error closing module :%s", g_module_error() );
1359 * chimara_glk_get_running:
1360 * @glk: a #ChimaraGlk widget
1362 * Use this function to tell whether a program is currently running in the
1365 * Returns: %TRUE if @glk is executing a Glk program, %FALSE otherwise.
1368 chimara_glk_get_running(ChimaraGlk *glk)
1370 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1371 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1372 return priv->running;
1376 * chimara_glk_feed_char_input:
1377 * @glk: a #ChimaraGlk widget
1378 * @keyval: a key symbol as defined in <filename
1379 * class="headerfile">gdk/gdkkeysyms.h</filename>
1381 * Pretend that a key was pressed in the Glk program as a response to a
1382 * character input request. You can call this function even when no window has
1383 * requested character input, in which case the key will be saved for the
1384 * following window that requests character input. This has the disadvantage
1385 * that if more than one window has requested character input, it is arbitrary
1386 * which one gets the key press.
1389 chimara_glk_feed_char_input(ChimaraGlk *glk, guint keyval)
1391 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1392 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1393 g_async_queue_push(priv->char_input_queue, GUINT_TO_POINTER(keyval));
1394 event_throw(glk, evtype_ForcedCharInput, NULL, 0, 0);
1398 * chimara_glk_feed_line_input:
1399 * @glk: a #ChimaraGlk widget
1400 * @text: text to pass to the next line input request
1402 * Pretend that @text was typed in the Glk program as a response to a line input
1403 * request. @text does not need to end with a newline. You can call this
1404 * function even when no window has requested line input, in which case the text
1405 * will be saved for the following window that requests line input. This has the
1406 * disadvantage that if more than one window has requested line input, it is
1407 * arbitrary which one gets the text.
1410 chimara_glk_feed_line_input(ChimaraGlk *glk, const gchar *text)
1412 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1413 g_return_if_fail(text);
1414 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1415 g_async_queue_push(priv->line_input_queue, g_strdup(text));
1416 event_throw(glk, evtype_ForcedLineInput, NULL, 0, 0);
1420 * chimara_glk_is_char_input_pending:
1421 * @glk: a #ChimaraGlk widget
1423 * Use this function to tell if character input forced by
1424 * chimara_glk_feed_char_input() has been passed to an input request or not.
1426 * Returns: %TRUE if forced character input is pending, %FALSE otherwise.
1429 chimara_glk_is_char_input_pending(ChimaraGlk *glk)
1431 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1432 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1433 return g_async_queue_length(priv->char_input_queue) > 0;
1437 * chimara_glk_is_line_input_pending:
1438 * @glk: a #ChimaraGlk widget
1440 * Use this function to tell if line input forced by
1441 * chimara_glk_feed_line_input() has been passed to an input request or not.
1443 * Returns: %TRUE if forced line input is pending, %FALSE otherwise.
1446 chimara_glk_is_line_input_pending(ChimaraGlk *glk)
1448 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1449 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1450 return g_async_queue_length(priv->line_input_queue) > 0;
1454 * chimara_glk_get_tag:
1455 * @glk: a #ChimaraGlk widget
1456 * @window: The type of window to retrieve the tag for
1457 * @name: The name of the tag to retrieve
1459 * Use this function to get a #GtkTextTag so style properties can be changed.
1460 * See also chimara_glk_set_css_from_string().
1462 * The layout of the text in Chimara is controlled by two sets of tags: one set
1463 * describing the style in text buffers and one for text grids. See also the
1464 * Glk specification for the difference between the two. The main narrative of
1465 * a game is usually rendered in text buffers, whereas text grids are mostly
1466 * used for status bars and in game menus.
1468 * The following tag names are supported:
1470 * <listitem><para>normal</para></listitem>
1471 * <listitem><para>emphasized</para></listitem>
1472 * <listitem><para>preformatted</para></listitem>
1473 * <listitem><para>header</para></listitem>
1474 * <listitem><para>subheader</para></listitem>
1475 * <listitem><para>alert</para></listitem>
1476 * <listitem><para>note</para></listitem>
1477 * <listitem><para>block-quote</para></listitem>
1478 * <listitem><para>input</para></listitem>
1479 * <listitem><para>user1</para></listitem>
1480 * <listitem><para>user2</para></listitem>
1481 * <listitem><para>hyperlink</para></listitem>
1482 * <listitem><para>pager</para></listitem>
1485 * Returns: (transfer none): The #GtkTextTag corresponding to @name in the
1486 * styles of @window.
1489 chimara_glk_get_tag(ChimaraGlk *glk, ChimaraGlkWindowType window, const gchar *name)
1491 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1494 case CHIMARA_GLK_TEXT_BUFFER:
1495 return GTK_TEXT_TAG( g_hash_table_lookup(priv->styles->text_buffer, name) );
1497 case CHIMARA_GLK_TEXT_GRID:
1498 return GTK_TEXT_TAG( g_hash_table_lookup(priv->styles->text_grid, name) );
1501 ILLEGAL_PARAM("Unknown window type: %u", window);
1507 * chimara_glk_get_tag_names:
1508 * @glk: a #ChimaraGlk widget
1509 * @num_tags: Return location for the number of tag names retrieved.
1511 * Retrieves the possible tag names to use in chimara_glk_get_tag().
1513 * Returns: (transfer none) (array length=num_tags) (element-type utf8):
1514 * Array of strings containing the tag names. This array is owned by Chimara,
1518 chimara_glk_get_tag_names(ChimaraGlk *glk, unsigned int *num_tags)
1520 g_return_val_if_fail(num_tags != NULL, NULL);
1522 *num_tags = CHIMARA_NUM_STYLES;
1523 return style_get_tag_names();
1527 * chimara_glk_set_resource_load_callback:
1528 * @glk: a #ChimaraGlk widget
1529 * @func: a function to call for loading resources, or %NULL
1530 * @user_data: user data to pass to @func, or %NULL
1531 * @destroy_user_data: a function to call for freeing @user_data, or %NULL
1533 * Sometimes it is preferable to load image and sound resources from somewhere
1534 * else than a Blorb file, for example while developing a game. Section 14 of
1535 * the <ulink url="http://eblong.com/zarf/blorb/blorb.html#s14">Blorb
1536 * specification</ulink> allows for this possibility. This function sets @func
1537 * to be called when the Glk program requests loading an image or sound without
1538 * a Blorb resource map having been loaded, optionally passing @user_data as an
1541 * Note that @func is only called if no Blorb resource map has been set; having
1542 * a resource map in place overrides this function.
1544 * If you pass non-%NULL for @destroy_user_data, then @glk takes ownership of
1545 * @user_data. When it is not needed anymore, it will be freed by calling
1546 * @destroy_user_data on it. If you wish to retain ownership of @user_data, pass
1547 * %NULL for @destroy_user_data.
1549 * To deactivate the callback, call this function with @func set to %NULL.
1552 chimara_glk_set_resource_load_callback(ChimaraGlk *glk, ChimaraResourceLoadFunc func, gpointer user_data, GDestroyNotify destroy_user_data)
1554 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1556 if(priv->resource_load_callback == func
1557 && priv->resource_load_callback_data == user_data
1558 && priv->resource_load_callback_destroy_data == destroy_user_data)
1561 if(priv->resource_load_callback_destroy_data)
1562 priv->resource_load_callback_destroy_data(priv->resource_load_callback_data);
1564 priv->resource_load_callback = func;
1565 priv->resource_load_callback_data = user_data;
1566 priv->resource_load_callback_destroy_data = destroy_user_data;