1 /* licensing and copyright information here */
11 #include <glib/gi18n-lib.h>
13 #include <pango/pango.h>
15 #include "chimara-glk.h"
16 #include "chimara-glk-private.h"
17 #include "chimara-marshallers.h"
28 #define CHIMARA_GLK_MIN_WIDTH 0
29 #define CHIMARA_GLK_MIN_HEIGHT 0
33 * @short_description: Widget which executes a Glk program
34 * @stability: Unstable
36 * The #ChimaraGlk widget opens and runs a Glk program. The program must be
37 * compiled as a plugin module, with a function <function>glk_main()</function>
38 * that the Glk library can hook into.
40 * On Linux systems, this is a file with a name like
41 * <filename>plugin.so</filename>. For portability, you can use libtool and
44 * pkglib_LTLIBRARIES = plugin.la
45 * plugin_la_SOURCES = plugin.c foo.c bar.c
46 * plugin_la_LDFLAGS = -module -shared -avoid-version -export-symbols-regex "^glk_main$$"
48 * This will produce <filename>plugin.la</filename> which is a text file
49 * containing the correct plugin file to open (see the relevant section of the
51 * url="http://www.gnu.org/software/libtool/manual/html_node/Finding-the-dlname.html">
52 * Libtool manual</ulink>).
54 * You need to initialize multithreading in any program you use a #ChimaraGlk
55 * widget in. This means including the following incantation at the beginning
58 * if(!g_thread_supported())
59 * g_thread_init(NULL);
62 * This initialization must take place <emphasis>before</emphasis> the call to
63 * gtk_init(). In addition to this, you must also protect your call to
64 * gtk_main() by calling gdk_threads_enter() right before it, and
65 * gdk_threads_leave() right after it.
67 * The following sample program shows how to initialize and construct a simple
68 * GTK window that runs a Glk program:
71 * #include <gtk/gtk.h>
72 * #include <libchimara/chimara-glk.h>
75 * main(int argc, char *argv[])
77 * GtkWidget *window, *glk;
78 * GError *error = NULL;
79 * gchar *plugin_argv[] = { "plugin.so", "-option" };
81 * /<!---->* Initialize threads and GTK *<!---->/
82 * if(!g_thread_supported())
83 * g_thread_init(NULL);
85 * gtk_init(&argc, &argv);
87 * /<!---->* Construct the window and its contents. We quit the GTK main loop
88 * * when the window's close button is clicked. *<!---->/
89 * window = gtk_window_new(GTK_WINDOW_TOPLEVEL);
90 * g_signal_connect(window, "delete-event", G_CALLBACK(gtk_main_quit), NULL);
91 * glk = chimara_glk_new();
92 * gtk_container_add(GTK_CONTAINER(window), glk);
93 * gtk_widget_show_all(window);
95 * /<!---->* Add a reference to the ChimaraGlk widget, since we want it to
96 * * persist after the window's delete-event -- otherwise it will be destroyed
97 * * with the window. *<!---->/
100 * /<!---->* Start the Glk program in a separate thread *<!---->/
101 * if(!chimara_glk_run(CHIMARA_GLK(glk), "./plugin.so", 2, plugin_argv, &error))
102 * g_error("Error starting Glk library: %s\n", error->message);
104 * /<!---->* Start the GTK main loop *<!---->/
105 * gdk_threads_enter();
107 * gdk_threads_leave();
109 * /<!---->* After the GTK main loop exits, signal the Glk program to shut down if
110 * * it is still running, and wait for it to exit. *<!---->/
111 * chimara_glk_stop(CHIMARA_GLK(glk));
112 * chimara_glk_wait(CHIMARA_GLK(glk));
113 * g_object_unref(glk);
120 typedef void (* glk_main_t) (void);
121 typedef int (* glkunix_startup_code_t) (glkunix_startup_t*);
146 static guint chimara_glk_signals[LAST_SIGNAL] = { 0 };
148 G_DEFINE_TYPE(ChimaraGlk, chimara_glk, GTK_TYPE_CONTAINER);
151 chimara_glk_init(ChimaraGlk *self)
153 chimara_init(); /* This is a library entry point */
155 gtk_widget_set_has_window(GTK_WIDGET(self), FALSE);
157 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(self);
160 priv->interactive = TRUE;
161 priv->styles = g_new0(StyleSet,1);
162 priv->glk_styles = g_new0(StyleSet,1);
163 priv->pager_attr_list = pango_attr_list_new();
164 priv->final_message = g_strdup("[ The game has finished ]");
165 priv->event_queue = g_queue_new();
166 priv->char_input_queue = g_async_queue_new();
167 priv->line_input_queue = g_async_queue_new();
168 /* FIXME Should be g_async_queue_new_full(g_free); but only in GTK >= 2.16 */
170 g_mutex_init(&priv->event_lock);
171 g_mutex_init(&priv->abort_lock);
172 g_mutex_init(&priv->shutdown_lock);
173 g_mutex_init(&priv->arrange_lock);
174 g_mutex_init(&priv->resource_lock);
176 g_cond_init(&priv->event_queue_not_empty);
177 g_cond_init(&priv->event_queue_not_full);
178 g_cond_init(&priv->shutdown_key_pressed);
179 g_cond_init(&priv->rearranged);
180 g_cond_init(&priv->resource_loaded);
181 g_cond_init(&priv->resource_info_available);
187 chimara_glk_set_property(GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
189 ChimaraGlk *glk = CHIMARA_GLK(object);
193 case PROP_INTERACTIVE:
194 chimara_glk_set_interactive( glk, g_value_get_boolean(value) );
197 chimara_glk_set_protect( glk, g_value_get_boolean(value) );
200 chimara_glk_set_spacing( glk, g_value_get_uint(value) );
203 G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
208 chimara_glk_get_property(GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
210 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(object);
214 case PROP_INTERACTIVE:
215 g_value_set_boolean(value, priv->interactive);
218 g_value_set_boolean(value, priv->protect);
221 g_value_set_uint(value, priv->spacing);
223 case PROP_PROGRAM_NAME:
224 g_value_set_string(value, priv->program_name);
226 case PROP_PROGRAM_INFO:
227 g_value_set_string(value, priv->program_info);
229 case PROP_STORY_NAME:
230 g_value_set_string(value, priv->story_name);
233 g_value_set_boolean(value, priv->running);
236 G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
241 chimara_glk_finalize(GObject *object)
243 ChimaraGlk *self = CHIMARA_GLK(object);
244 CHIMARA_GLK_USE_PRIVATE(self, priv);
245 priv->after_finalize = TRUE;
247 /* Free widget properties */
248 g_free(priv->final_message);
250 g_hash_table_destroy(priv->styles->text_buffer);
251 g_hash_table_destroy(priv->styles->text_grid);
252 g_hash_table_destroy(priv->glk_styles->text_buffer);
253 g_hash_table_destroy(priv->glk_styles->text_grid);
254 pango_attr_list_unref(priv->pager_attr_list);
256 /* Free the event queue */
257 g_mutex_lock(&priv->event_lock);
258 g_queue_foreach(priv->event_queue, (GFunc)g_free, NULL);
259 g_queue_free(priv->event_queue);
260 g_cond_clear(&priv->event_queue_not_empty);
261 g_cond_clear(&priv->event_queue_not_full);
262 priv->event_queue = NULL;
263 g_mutex_unlock(&priv->event_lock);
264 g_mutex_clear(&priv->event_lock);
266 /* Free the abort signaling mechanism */
267 g_mutex_lock(&priv->abort_lock);
268 /* Make sure no other thread is busy with this */
269 g_mutex_unlock(&priv->abort_lock);
270 g_mutex_clear(&priv->abort_lock);
272 /* Free the shutdown keypress signaling mechanism */
273 g_mutex_lock(&priv->shutdown_lock);
274 g_cond_clear(&priv->shutdown_key_pressed);
275 g_mutex_unlock(&priv->shutdown_lock);
276 g_mutex_clear(&priv->shutdown_lock);
278 /* Free the window arrangement signaling */
279 g_mutex_lock(&priv->arrange_lock);
280 g_cond_clear(&priv->rearranged);
281 g_mutex_unlock(&priv->arrange_lock);
282 g_mutex_clear(&priv->arrange_lock);
284 g_mutex_lock(&priv->resource_lock);
285 g_cond_clear(&priv->resource_loaded);
286 g_cond_clear(&priv->resource_info_available);
287 g_mutex_unlock(&priv->resource_lock);
288 g_mutex_clear(&priv->resource_lock);
289 g_slist_foreach(priv->image_cache, (GFunc)clear_image_cache, NULL);
290 g_slist_free(priv->image_cache);
291 /* Unref input queues (this should destroy them since any Glk thread has stopped by now */
292 g_async_queue_unref(priv->char_input_queue);
293 g_async_queue_unref(priv->line_input_queue);
294 /* Destroy callback data if ownership retained */
295 if(priv->resource_load_callback_destroy_data)
296 priv->resource_load_callback_destroy_data(priv->resource_load_callback_data);
298 /* Free other stuff */
299 g_free(priv->current_dir);
300 g_free(priv->program_name);
301 g_free(priv->program_info);
302 g_free(priv->story_name);
303 g_free(priv->styles);
304 g_free(priv->glk_styles);
306 /* Chain up to parent */
307 G_OBJECT_CLASS(chimara_glk_parent_class)->finalize(object);
310 /* Internal function: Recursively get the Glk window tree's size request */
312 request_recurse(winid_t win, GtkRequisition *requisition, guint spacing)
314 if(win->type == wintype_Pair)
316 /* Get children's size requests */
317 GtkRequisition child1, child2;
318 request_recurse(win->window_node->children->data, &child1, spacing);
319 request_recurse(win->window_node->children->next->data, &child2, spacing);
321 glui32 division = win->split_method & winmethod_DivisionMask;
322 glui32 direction = win->split_method & winmethod_DirMask;
323 unsigned border = ((win->split_method & winmethod_BorderMask) == winmethod_NoBorder)? 0 : spacing;
325 /* If the split is fixed, get the size of the fixed child */
326 if(division == winmethod_Fixed)
331 child1.width = win->key_window?
332 win->constraint_size * win->key_window->unit_width
335 case winmethod_Right:
336 child2.width = win->key_window?
337 win->constraint_size * win->key_window->unit_width
340 case winmethod_Above:
341 child1.height = win->key_window?
342 win->constraint_size * win->key_window->unit_height
345 case winmethod_Below:
346 child2.height = win->key_window?
347 win->constraint_size * win->key_window->unit_height
353 /* Add the children's requests */
357 case winmethod_Right:
358 requisition->width = child1.width + child2.width + border;
359 requisition->height = MAX(child1.height, child2.height);
361 case winmethod_Above:
362 case winmethod_Below:
363 requisition->width = MAX(child1.width, child2.width);
364 requisition->height = child1.height + child2.height + border;
369 /* For non-pair windows, just use the size that GTK requests */
371 gtk_widget_size_request(win->frame, requisition);
374 /* Overrides gtk_widget_size_request */
376 chimara_glk_size_request(GtkWidget *widget, GtkRequisition *requisition)
378 g_return_if_fail(widget);
379 g_return_if_fail(requisition);
380 g_return_if_fail(CHIMARA_IS_GLK(widget));
382 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(widget);
384 guint border_width = gtk_container_get_border_width(GTK_CONTAINER(widget));
385 /* For now, just pass the size request on to the root Glk window */
386 if(priv->root_window)
388 request_recurse(priv->root_window->data, requisition, priv->spacing);
389 requisition->width += 2 * border_width;
390 requisition->height += 2 * border_width;
394 requisition->width = CHIMARA_GLK_MIN_WIDTH + 2 * border_width;
395 requisition->height = CHIMARA_GLK_MIN_HEIGHT + 2 * border_width;
399 /* Recursively give the Glk windows their allocated space. Returns a window
400 containing all children of this window that must be redrawn, or NULL if there
401 are no children that require redrawing. */
403 allocate_recurse(winid_t win, GtkAllocation *allocation, guint spacing)
405 if(win->type == wintype_Pair)
407 glui32 division = win->split_method & winmethod_DivisionMask;
408 glui32 direction = win->split_method & winmethod_DirMask;
409 unsigned border = ((win->split_method & winmethod_BorderMask) == winmethod_NoBorder)? 0 : spacing;
411 /* If the space gets too small to honor the spacing property, then just
412 ignore spacing in this window and below. */
413 if( (border > allocation->width && (direction == winmethod_Left || direction == winmethod_Right))
414 || (border > allocation->height && (direction == winmethod_Above || direction == winmethod_Below)) )
417 GtkAllocation child1, child2;
418 child1.x = allocation->x;
419 child1.y = allocation->y;
421 if(division == winmethod_Fixed)
423 /* If the key window has been closed, then default to 0; otherwise
424 use the key window to determine the size */
428 child1.width = win->key_window?
429 CLAMP(win->constraint_size * win->key_window->unit_width, 0, allocation->width - border)
432 case winmethod_Right:
433 child2.width = win->key_window?
434 CLAMP(win->constraint_size * win->key_window->unit_width, 0, allocation->width - border)
437 case winmethod_Above:
438 child1.height = win->key_window?
439 CLAMP(win->constraint_size * win->key_window->unit_height, 0, allocation->height - border)
442 case winmethod_Below:
443 child2.height = win->key_window?
444 CLAMP(win->constraint_size * win->key_window->unit_height, 0, allocation->height - border)
449 else /* proportional */
451 gdouble fraction = win->constraint_size / 100.0;
455 child1.width = MAX(0, (gint)ceil(fraction * (allocation->width - border)) );
457 case winmethod_Right:
458 child2.width = MAX(0, (gint)ceil(fraction * (allocation->width - border)) );
460 case winmethod_Above:
461 child1.height = MAX(0, (gint)ceil(fraction * (allocation->height - border)) );
463 case winmethod_Below:
464 child2.height = MAX(0, (gint)ceil(fraction * (allocation->height - border)) );
469 /* Fill in the rest of the size requisitions according to the child specified above */
473 child2.width = MAX(0, allocation->width - border - child1.width);
474 child2.x = child1.x + child1.width + border;
476 child1.height = child2.height = allocation->height;
478 case winmethod_Right:
479 child1.width = MAX(0, allocation->width - border - child2.width);
480 child2.x = child1.x + child1.width + border;
482 child1.height = child2.height = allocation->height;
484 case winmethod_Above:
485 child2.height = MAX(0, allocation->height - border - child1.height);
487 child2.y = child1.y + child1.height + border;
488 child1.width = child2.width = allocation->width;
490 case winmethod_Below:
491 child1.height = MAX(0, allocation->height - border - child2.height);
493 child2.y = child1.y + child1.height + border;
494 child1.width = child2.width = allocation->width;
499 winid_t arrange1 = allocate_recurse(win->window_node->children->data, &child1, spacing);
500 winid_t arrange2 = allocate_recurse(win->window_node->children->next->data, &child2, spacing);
508 else if(win->type == wintype_TextGrid)
510 /* Pass the size allocation on to the framing widget */
511 gtk_widget_size_allocate(win->frame, allocation);
512 /* It says in the spec that when a text grid window is resized smaller,
513 the bottom or right area is thrown away; when it is resized larger, the
514 bottom or right area is filled with blanks. */
515 GtkAllocation widget_allocation;
516 gtk_widget_get_allocation(win->widget, &widget_allocation);
517 glui32 new_width = (glui32)(widget_allocation.width / win->unit_width);
518 glui32 new_height = (glui32)(widget_allocation.height / win->unit_height);
520 if(new_width != win->width || new_height != win->height)
522 // Window has changed size, trim or expand the textbuffer if necessary.
523 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
524 GtkTextIter start, end;
526 // Add or remove lines
527 if(new_height == 0) {
528 gtk_text_buffer_get_start_iter(buffer, &start);
529 gtk_text_buffer_get_end_iter(buffer, &end);
530 gtk_text_buffer_delete(buffer, &start, &end);
532 else if(new_height < win->height)
534 // Remove surplus lines
535 gtk_text_buffer_get_end_iter(buffer, &end);
536 gtk_text_buffer_get_iter_at_line(buffer, &start, new_height-1);
537 gtk_text_iter_forward_to_line_end(&start);
538 gtk_text_buffer_delete(buffer, &start, &end);
541 else if(new_height > win->height)
544 gint lines_to_add = new_height - win->height;
545 gtk_text_buffer_get_end_iter(buffer, &end);
548 gchar *blanks = g_strnfill(win->width, ' ');
549 gchar **blanklines = g_new0(gchar *, lines_to_add + 1);
551 for(count = 0; count < lines_to_add; count++)
552 blanklines[count] = blanks;
553 blanklines[lines_to_add] = NULL;
554 gchar *vertical_blanks = g_strjoinv("\n", blanklines);
559 gtk_text_buffer_insert(buffer, &end, "\n", 1);
561 gtk_text_buffer_insert(buffer, &end, vertical_blanks, -1);
564 // Trim or expand lines
565 if(new_width < win->width) {
566 gtk_text_buffer_get_start_iter(buffer, &start);
570 for(line = 0; line <= new_height; line++) {
572 gtk_text_iter_forward_cursor_positions(&start, new_width);
573 gtk_text_iter_forward_to_line_end(&end);
574 gtk_text_buffer_delete(buffer, &start, &end);
575 gtk_text_iter_forward_line(&start);
578 } else if(new_width > win->width) {
579 gint chars_to_add = new_width - win->width;
580 gchar *horizontal_blanks = g_strnfill(chars_to_add, ' ');
582 gtk_text_buffer_get_start_iter(buffer, &start);
586 for(line = 0; line <= new_height; line++) {
587 gtk_text_iter_forward_to_line_end(&start);
589 gint start_offset = gtk_text_iter_get_offset(&start);
590 gtk_text_buffer_insert(buffer, &end, horizontal_blanks, -1);
591 gtk_text_buffer_get_iter_at_offset(buffer, &start, start_offset);
592 gtk_text_iter_forward_line(&start);
596 g_free(horizontal_blanks);
600 gboolean arrange = !(win->width == new_width && win->height == new_height);
601 win->width = new_width;
602 win->height = new_height;
603 return arrange? win : NULL;
606 /* For non-pair, non-text-grid windows, just give them the size */
607 gtk_widget_size_allocate(win->frame, allocation);
611 /* Overrides gtk_widget_size_allocate */
613 chimara_glk_size_allocate(GtkWidget *widget, GtkAllocation *allocation)
615 g_return_if_fail(widget);
616 g_return_if_fail(allocation);
617 g_return_if_fail(CHIMARA_IS_GLK(widget));
619 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(widget);
621 gtk_widget_set_allocation(widget, allocation);
623 if(priv->root_window) {
625 guint border_width = gtk_container_get_border_width(GTK_CONTAINER(widget));
626 child.x = allocation->x + border_width;
627 child.y = allocation->y + border_width;
628 child.width = CLAMP(allocation->width - 2 * border_width, 0, allocation->width);
629 child.height = CLAMP(allocation->height - 2 * border_width, 0, allocation->height);
630 winid_t arrange = allocate_recurse(priv->root_window->data, &child, priv->spacing);
632 /* arrange points to a window that contains all text grid and graphics
633 windows which have been resized */
634 g_mutex_lock(&priv->arrange_lock);
635 if(!priv->ignore_next_arrange_event)
638 event_throw(CHIMARA_GLK(widget), evtype_Arrange, arrange == priv->root_window->data? NULL : arrange, 0, 0);
641 priv->ignore_next_arrange_event = FALSE;
642 priv->needs_rearrange = FALSE;
643 g_cond_signal(&priv->rearranged);
644 g_mutex_unlock(&priv->arrange_lock);
648 /* Recursively invoke callback() on the GtkWidget of each non-pair window in the tree */
650 forall_recurse(winid_t win, GtkCallback callback, gpointer callback_data)
652 if(win->type == wintype_Pair)
654 forall_recurse(win->window_node->children->data, callback, callback_data);
655 forall_recurse(win->window_node->children->next->data, callback, callback_data);
658 (*callback)(win->frame, callback_data);
661 /* Overrides gtk_container_forall */
663 chimara_glk_forall(GtkContainer *container, gboolean include_internals, GtkCallback callback, gpointer callback_data)
665 g_return_if_fail(container);
666 g_return_if_fail(CHIMARA_IS_GLK(container));
668 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(container);
670 /* All the children are "internal" */
671 if(!include_internals)
674 if(priv->root_window)
675 forall_recurse(priv->root_window->data, callback, callback_data);
679 chimara_glk_stopped(ChimaraGlk *self)
681 CHIMARA_GLK_USE_PRIVATE(self, priv);
682 priv->running = FALSE;
683 priv->program_name = NULL;
684 g_object_notify(G_OBJECT(self), "program-name");
685 priv->program_info = NULL;
686 g_object_notify(G_OBJECT(self), "program-info");
687 priv->story_name = NULL;
688 g_object_notify(G_OBJECT(self), "story-name");
692 chimara_glk_started(ChimaraGlk *self)
694 CHIMARA_GLK_USE_PRIVATE(self, priv);
695 priv->running = TRUE;
699 chimara_glk_waiting(ChimaraGlk *self)
701 /* Default signal handler */
705 chimara_glk_char_input(ChimaraGlk *self, guint window_rock, guint keysym)
707 /* Default signal handler */
711 chimara_glk_line_input(ChimaraGlk *self, guint window_rock, gchar *text)
713 /* Default signal handler */
717 chimara_glk_text_buffer_output(ChimaraGlk *self, guint window_rock, gchar *text)
719 /* Default signal handler */
723 chimara_glk_iliad_screen_update(ChimaraGlk *self, gboolean typing)
725 /* Default signal handler */
729 chimara_glk_class_init(ChimaraGlkClass *klass)
731 /* Override methods of parent classes */
732 GObjectClass *object_class = G_OBJECT_CLASS(klass);
733 object_class->set_property = chimara_glk_set_property;
734 object_class->get_property = chimara_glk_get_property;
735 object_class->finalize = chimara_glk_finalize;
737 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS(klass);
738 widget_class->size_request = chimara_glk_size_request;
739 widget_class->size_allocate = chimara_glk_size_allocate;
741 GtkContainerClass *container_class = GTK_CONTAINER_CLASS(klass);
742 container_class->forall = chimara_glk_forall;
745 klass->stopped = chimara_glk_stopped;
746 klass->started = chimara_glk_started;
747 klass->waiting = chimara_glk_waiting;
748 klass->char_input = chimara_glk_char_input;
749 klass->line_input = chimara_glk_line_input;
750 klass->text_buffer_output = chimara_glk_text_buffer_output;
751 klass->iliad_screen_update = chimara_glk_iliad_screen_update;
754 * ChimaraGlk::stopped:
755 * @glk: The widget that received the signal
757 * Emitted when the a Glk program finishes executing in the widget, whether
758 * it ended normally, or was interrupted.
760 chimara_glk_signals[STOPPED] = g_signal_new("stopped",
761 G_OBJECT_CLASS_TYPE(klass), G_SIGNAL_RUN_FIRST,
762 /* FIXME: Should be G_SIGNAL_RUN_CLEANUP but that segfaults??! */
763 G_STRUCT_OFFSET(ChimaraGlkClass, stopped), NULL, NULL,
764 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
766 * ChimaraGlk::started:
767 * @glk: The widget that received the signal
769 * Emitted when a Glk program starts executing in the widget.
771 chimara_glk_signals[STARTED] = g_signal_new ("started",
772 G_OBJECT_CLASS_TYPE(klass), G_SIGNAL_RUN_FIRST,
773 G_STRUCT_OFFSET(ChimaraGlkClass, started), NULL, NULL,
774 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
776 * ChimaraGlk::waiting:
777 * @glk: The widget that received the signal
779 * Emitted when glk_select() is called by the Glk program and the event
780 * queue is empty, which means that the widget is waiting for input.
782 chimara_glk_signals[WAITING] = g_signal_new("waiting",
783 G_OBJECT_CLASS_TYPE(klass), 0,
784 G_STRUCT_OFFSET(ChimaraGlkClass, waiting), NULL, NULL,
785 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
787 * ChimaraGlk::char-input:
788 * @glk: The widget that received the signal
789 * @window_rock: The rock value of the window that received character input
790 * (see <link linkend="chimara-Rocks">Rocks</link>)
791 * @keysym: The key that was typed, in the form of a key symbol from
792 * <filename class="headerfile">gdk/gdkkeysyms.h</filename>
794 * Emitted when a Glk window receives character input.
796 chimara_glk_signals[CHAR_INPUT] = g_signal_new("char-input",
797 G_OBJECT_CLASS_TYPE(klass), 0,
798 G_STRUCT_OFFSET(ChimaraGlkClass, char_input), NULL, NULL,
799 _chimara_marshal_VOID__UINT_UINT,
800 G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_UINT);
802 * ChimaraGlk::line-input:
803 * @glk: The widget that received the signal
804 * @window_rock: The rock value of the window that received line input (see
805 * <link linkend="chimara-Rocks">Rocks</link>)
806 * @text: The text that was typed
808 * Emitted when a Glk window receives line input.
810 chimara_glk_signals[LINE_INPUT] = g_signal_new("line-input",
811 G_OBJECT_CLASS_TYPE(klass), 0,
812 G_STRUCT_OFFSET(ChimaraGlkClass, line_input), NULL, NULL,
813 _chimara_marshal_VOID__UINT_STRING,
814 G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_STRING);
816 * ChimaraGlk::text-buffer-output:
817 * @glk: The widget that received the signal
818 * @window_rock: The rock value of the window that was printed to (see <link
819 * linkend="chimara-Rocks">Rocks</link>)
821 * Emitted when text is printed to a text buffer window.
823 chimara_glk_signals[TEXT_BUFFER_OUTPUT] = g_signal_new("text-buffer-output",
824 G_OBJECT_CLASS_TYPE(klass), 0,
825 G_STRUCT_OFFSET(ChimaraGlkClass, text_buffer_output), NULL, NULL,
826 _chimara_marshal_VOID__UINT_STRING,
827 G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_STRING);
829 * ChimaraGlk::iliad-screen-update:
830 * @self: The widget that received the signal
831 * @typing: Whether to perform a typing or full screen update
833 * Iliad specific signal which is emitted whenever the screen needs to be updated.
834 * Since iliad screen updates are very slow, updating should only be done when
837 chimara_glk_signals[ILIAD_SCREEN_UPDATE] = g_signal_new("iliad-screen-update",
838 G_OBJECT_CLASS_TYPE(klass), 0,
839 G_STRUCT_OFFSET(ChimaraGlkClass, iliad_screen_update), NULL, NULL,
840 _chimara_marshal_VOID__BOOLEAN,
841 G_TYPE_NONE, 1, G_TYPE_BOOLEAN);
845 * ChimaraGlk:interactive:
847 * Sets whether the widget is interactive. A Glk widget is normally
848 * interactive, but in non-interactive mode, keyboard and mouse input are
849 * ignored and the Glk program is controlled by
850 * chimara_glk_feed_char_input() and chimara_glk_feed_line_input().
851 * <quote>More</quote> prompts when a lot of text is printed to a text
852 * buffer are also disabled. This is typically used when you wish to control
853 * an interpreter program by feeding it a predefined list of commands.
855 g_object_class_install_property( object_class, PROP_INTERACTIVE,
856 g_param_spec_boolean("interactive", _("Interactive"),
857 _("Whether user input is expected in the Glk program"),
859 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
862 * ChimaraGlk:protect:
864 * Sets whether the Glk program is allowed to do file operations. In protect
865 * mode, all file operations will fail.
867 g_object_class_install_property(object_class, PROP_PROTECT,
868 g_param_spec_boolean("protect", _("Protected"),
869 _("Whether the Glk program is barred from doing file operations"),
871 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
874 * ChimaraGlk:spacing:
876 * The amount of space between the Glk windows. This space forms a visible
877 * border between windows; however, if you open a window using the
878 * %winmethod_NoBorder flag, there will be no spacing between it and its
879 * sibling window, no matter what the value of this property is.
881 g_object_class_install_property(object_class, PROP_SPACING,
882 g_param_spec_uint("spacing", _("Spacing"),
883 _("The amount of space between Glk windows"),
885 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
888 * ChimaraGlk:program-name:
890 * The name of the currently running Glk program. You cannot set this
891 * property yourself. It is set to the filename of the plugin when you call
892 * chimara_glk_run(), but the plugin can change it by calling
893 * garglk_set_program_name(). To find out when this information changes,
894 * for example to put the program name in the title bar of a window, connect
895 * to the <code>::notify::program-name</code> signal.
897 g_object_class_install_property(object_class, PROP_PROGRAM_NAME,
898 g_param_spec_string("program-name", _("Program name"),
899 _("Name of the currently running program"),
901 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
904 * ChimaraGlk:program-info:
906 * Information about the currently running Glk program. You cannot set this
907 * property yourself. The plugin can change it by calling
908 * garglk_set_program_info(). See also #ChimaraGlk:program-name.
910 g_object_class_install_property(object_class, PROP_PROGRAM_INFO,
911 g_param_spec_string("program-info", _("Program info"),
912 _("Information about the currently running program"),
914 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
917 * ChimaraGlk:story-name:
919 * The name of the story currently running in the Glk interpreter. You
920 * cannot set this property yourself. It is set to the story filename when
921 * you call chimara_if_run_game(), but the plugin can change it by calling
922 * garglk_set_story_name().
924 * Strictly speaking, this should be a property of #ChimaraIF, but it is
925 * legal for any Glk program to call garglk_set_story_name(), even if it is
926 * not an interpreter and does not load story files.
928 g_object_class_install_property(object_class, PROP_STORY_NAME,
929 g_param_spec_string("story-name", _("Story name"),
930 _("Name of the story currently loaded in the interpreter"),
932 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
935 * ChimaraGlk:running:
937 * Whether this Glk widget is currently running a game or not.
939 g_object_class_install_property(object_class, PROP_RUNNING,
940 g_param_spec_boolean("running", _("Running"),
941 _("Whether there is a program currently running"),
943 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
946 g_type_class_add_private(klass, sizeof(ChimaraGlkPrivate));
949 /* PUBLIC FUNCTIONS */
952 * chimara_error_quark:
954 * The error domain for errors from Chimara widgets.
956 * Returns: The string <quote>chimara-error-quark</quote> as a <link
957 * linkend="GQuark">GQuark</link>.
960 chimara_error_quark(void)
962 chimara_init(); /* This is a library entry point */
963 return g_quark_from_static_string("chimara-error-quark");
969 * Creates and initializes a new #ChimaraGlk widget.
971 * Return value: a #ChimaraGlk widget, with a floating reference.
974 chimara_glk_new(void)
976 /* This is a library entry point; initialize the library */
979 return GTK_WIDGET(g_object_new(CHIMARA_TYPE_GLK, NULL));
983 * chimara_glk_set_interactive:
984 * @glk: a #ChimaraGlk widget
985 * @interactive: whether the widget should expect user input
987 * Sets the #ChimaraGlk:interactive property of @glk.
990 chimara_glk_set_interactive(ChimaraGlk *glk, gboolean interactive)
992 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
994 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
995 priv->interactive = interactive;
996 g_object_notify(G_OBJECT(glk), "interactive");
1000 * chimara_glk_get_interactive:
1001 * @glk: a #ChimaraGlk widget
1003 * Returns whether @glk is interactive (expecting user input). See
1004 * #ChimaraGlk:interactive.
1006 * Return value: %TRUE if @glk is interactive.
1009 chimara_glk_get_interactive(ChimaraGlk *glk)
1011 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1013 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1014 return priv->interactive;
1018 * chimara_glk_set_protect:
1019 * @glk: a #ChimaraGlk widget
1020 * @protect: whether the widget should allow the Glk program to do file
1023 * Sets the #ChimaraGlk:protect property of @glk. In protect mode, the Glk
1024 * program is not allowed to do file operations.
1027 chimara_glk_set_protect(ChimaraGlk *glk, gboolean protect)
1029 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1031 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1032 priv->protect = protect;
1033 g_object_notify(G_OBJECT(glk), "protect");
1037 * chimara_glk_get_protect:
1038 * @glk: a #ChimaraGlk widget
1040 * Returns whether @glk is in protect mode (banned from doing file operations).
1041 * See #ChimaraGlk:protect.
1043 * Return value: %TRUE if @glk is in protect mode.
1046 chimara_glk_get_protect(ChimaraGlk *glk)
1048 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1050 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1051 return priv->protect;
1055 * chimara_glk_set_css_to_default:
1056 * @glk: a #ChimaraGlk widget
1058 * Resets the styles for text buffer and text grid windows to their defaults.
1060 * This function is not implemented yet.
1064 chimara_glk_set_css_to_default(ChimaraGlk *glk)
1066 reset_default_styles(glk);
1070 * chimara_glk_set_css_from_file:
1071 * @glk: a #ChimaraGlk widget
1072 * @filename: path to a CSS file, or %NULL
1073 * @error: location to store a <link
1074 * linkend="glib-Error-Reporting">GError</link>, or %NULL
1076 * Sets the styles for text buffer and text grid windows according to the CSS
1077 * file @filename. Note that the styles are set cumulatively on top of whatever
1078 * the styles are at the time this function is called; to reset the styles to
1079 * their defaults, use chimara_glk_set_css_to_default().
1081 * Returns: %TRUE on success, %FALSE if an error occurred, in which case @error
1085 chimara_glk_set_css_from_file(ChimaraGlk *glk, const gchar *filename, GError **error)
1087 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1088 g_return_val_if_fail(filename, FALSE);
1089 g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
1091 int fd = open(filename, O_RDONLY);
1094 *error = g_error_new(G_IO_ERROR, g_io_error_from_errno(errno),
1095 _("Error opening file \"%s\": %s"), filename, g_strerror(errno));
1099 GScanner *scanner = create_css_file_scanner();
1100 g_scanner_input_file(scanner, fd);
1101 scanner->input_name = filename;
1102 scan_css_file(scanner, glk);
1104 if(close(fd) == -1) {
1106 *error = g_error_new(G_IO_ERROR, g_io_error_from_errno(errno),
1107 _("Error closing file \"%s\": %s"), filename, g_strerror(errno));
1114 * chimara_glk_set_css_from_string:
1115 * @glk: a #ChimaraGlk widget
1116 * @css: a string containing CSS code
1118 * Sets the styles for text buffer and text grid windows according to the CSS
1119 * code @css. Note that the styles are set cumulatively on top of whatever the
1120 * styles are at the time this function is called; to reset the styles to their
1121 * defaults, use chimara_glk_set_css_to_default().
1124 chimara_glk_set_css_from_string(ChimaraGlk *glk, const gchar *css)
1126 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1127 g_return_if_fail(css || *css);
1129 GScanner *scanner = create_css_file_scanner();
1130 g_scanner_input_text(scanner, css, strlen(css));
1131 scanner->input_name = "<string>";
1132 scan_css_file(scanner, glk);
1136 * chimara_glk_set_spacing:
1137 * @glk: a #ChimaraGlk widget
1138 * @spacing: the number of pixels to put between Glk windows
1140 * Sets the #ChimaraGlk:spacing property of @glk, which is the border width in
1141 * pixels between Glk windows.
1144 chimara_glk_set_spacing(ChimaraGlk *glk, guint spacing)
1146 g_return_if_fail( glk || CHIMARA_IS_GLK(glk) );
1148 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1149 priv->spacing = spacing;
1150 g_object_notify(G_OBJECT(glk), "spacing");
1154 * chimara_glk_get_spacing:
1155 * @glk: a #ChimaraGlk widget
1157 * Gets the value set by chimara_glk_set_spacing().
1159 * Return value: pixels of spacing between Glk windows
1162 chimara_glk_get_spacing(ChimaraGlk *glk)
1164 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), 0);
1166 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1167 return priv->spacing;
1170 struct StartupData {
1171 glk_main_t glk_main;
1172 glkunix_startup_code_t glkunix_startup_code;
1173 glkunix_startup_t args;
1174 ChimaraGlkPrivate *glk_data;
1178 free_startup_data(struct StartupData *startup)
1181 while(i < startup->args.argc)
1182 g_free(startup->args.argv[i++]);
1183 g_free(startup->args.argv);
1187 /* glk_enter() is the actual function called in the new thread in which
1188 glk_main() runs. Takes ownership of @startup and will free it. */
1190 glk_enter(struct StartupData *startup)
1192 extern GPrivate *glk_data_key;
1193 g_private_set(glk_data_key, startup->glk_data);
1195 /* Acquire the Glk thread's references to the input queues */
1196 g_async_queue_ref(startup->glk_data->char_input_queue);
1197 g_async_queue_ref(startup->glk_data->line_input_queue);
1199 /* Run startup function */
1200 if(startup->glkunix_startup_code) {
1201 startup->glk_data->in_startup = TRUE;
1202 int result = startup->glkunix_startup_code(&startup->args);
1203 startup->glk_data->in_startup = FALSE;
1206 free_startup_data(startup);
1211 /* Run main function */
1212 glk_main_t glk_main = startup->glk_main;
1214 /* COMPAT: avoid usage of slices */
1215 g_signal_emit_by_name(startup->glk_data->self, "started");
1217 free_startup_data(startup);
1218 glk_exit(); /* Run shutdown code in glk_exit() even if glk_main() returns normally */
1219 g_assert_not_reached(); /* because glk_exit() calls g_thread_exit() */
1225 * @glk: a #ChimaraGlk widget
1226 * @plugin: path to a plugin module compiled with <filename
1227 * class="header">glk.h</filename>
1228 * @argc: Number of command line arguments in @argv
1229 * @argv: Array of command line arguments to pass to the plugin
1230 * @error: location to store a <link
1231 * linkend="glib-Error-Reporting">GError</link>, or %NULL
1233 * Opens a Glk program compiled as a plugin. Sorts out its command line
1234 * arguments from #glkunix_arguments, calls its startup function
1235 * glkunix_startup_code(), and then calls its main function glk_main() in
1236 * a separate thread. On failure, returns %FALSE and sets @error.
1238 * The plugin must at least export a glk_main() function; #glkunix_arguments and
1239 * glkunix_startup_code() are optional.
1241 * Return value: %TRUE if the Glk program was started successfully.
1244 chimara_glk_run(ChimaraGlk *glk, const gchar *plugin, int argc, char *argv[], GError **error)
1246 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1247 g_return_val_if_fail(plugin, FALSE);
1248 g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
1250 if(chimara_glk_get_running(glk)) {
1251 g_set_error(error, CHIMARA_ERROR, CHIMARA_PLUGIN_ALREADY_RUNNING, _("There was already a plugin running."));
1255 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1257 /* COMPAT: avoid usage of slices */
1258 struct StartupData *startup = g_new0(struct StartupData,1);
1260 g_assert( g_module_supported() );
1261 /* If there is already a module loaded, free it first -- you see, we want to
1262 * keep modules loaded as long as possible to avoid crashes in stack unwinding */
1263 chimara_glk_unload_plugin(glk);
1264 /* Open the module to run */
1265 priv->program = g_module_open(plugin, G_MODULE_BIND_LAZY);
1269 g_set_error(error, CHIMARA_ERROR, CHIMARA_LOAD_MODULE_ERROR, _("Error opening module: %s"), g_module_error());
1272 if( !g_module_symbol(priv->program, "glk_main", (gpointer *) &startup->glk_main) )
1274 g_set_error(error, CHIMARA_ERROR, CHIMARA_NO_GLK_MAIN, _("Error finding glk_main(): %s"), g_module_error());
1278 if( g_module_symbol(priv->program, "glkunix_startup_code", (gpointer *) &startup->glkunix_startup_code) )
1280 glkunix_argumentlist_t *glkunix_arguments;
1282 if( !(g_module_symbol(priv->program, "glkunix_arguments", (gpointer *) &glkunix_arguments)
1283 && parse_command_line(glkunix_arguments, argc, argv, &startup->args)) )
1285 /* arguments could not be parsed, so create data ourselves */
1286 startup->args.argc = 1;
1287 startup->args.argv = g_new0(gchar *, 1);
1290 /* Set the program invocation name */
1291 startup->args.argv[0] = g_strdup(plugin);
1293 startup->glk_data = priv;
1295 /* Set the program name */
1296 priv->program_name = g_path_get_basename(plugin);
1297 g_object_notify(G_OBJECT(glk), "program-name");
1299 /* Run in a separate thread */
1300 priv->thread = g_thread_try_new("glk", (GThreadFunc)glk_enter, startup, error);
1302 return !(priv->thread == NULL);
1306 * chimara_glk_run_file:
1307 * @self: a #ChimaraGlk widget
1308 * @plugin_file: a #GFile pointing to a plugin module compiled with <filename
1309 * class="header">glk.h</filename>
1310 * @argc: Number of command line arguments in @argv
1311 * @argv: Array of command line arguments to pass to the plugin
1312 * @error: location to store a <link
1313 * linkend="glib-Error-Reporting">GError</link>, or %NULL
1315 * Opens a Glk program compiled as a plugin, from a #GFile. See
1316 * chimara_glk_run() for details.
1318 * Return value: %TRUE if the Glk program was started successfully.
1321 chimara_glk_run_file(ChimaraGlk *self, GFile *plugin_file, int argc, char *argv[], GError **error)
1323 g_return_val_if_fail(self || CHIMARA_IS_GLK(self), FALSE);
1324 g_return_val_if_fail(plugin_file || G_IS_FILE(plugin_file), FALSE);
1325 g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
1327 char *path = g_file_get_path(plugin_file);
1328 gboolean retval = chimara_glk_run(self, path, argc, argv, error);
1336 * @glk: a #ChimaraGlk widget
1338 * Signals the Glk program running in @glk to abort. Note that if the program is
1339 * caught in an infinite loop in which glk_tick() is not called, this may not
1342 * This function does nothing if no Glk program is running.
1345 chimara_glk_stop(ChimaraGlk *glk)
1347 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1348 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1350 /* Don't do anything if not running a program */
1354 if(!priv->after_finalize) {
1355 g_mutex_lock(&priv->abort_lock);
1356 priv->abort_signalled = TRUE;
1357 g_mutex_unlock(&priv->abort_lock);
1358 /* Stop blocking on the event queue condition */
1359 event_throw(glk, evtype_Abort, NULL, 0, 0);
1360 /* Stop blocking on the shutdown key press condition */
1361 g_mutex_lock(&priv->shutdown_lock);
1362 g_cond_signal(&priv->shutdown_key_pressed);
1363 g_mutex_unlock(&priv->shutdown_lock);
1369 * @glk: a #ChimaraGlk widget
1371 * Holds up the main thread and waits for the Glk program running in @glk to
1374 * This function does nothing if no Glk program is running.
1377 chimara_glk_wait(ChimaraGlk *glk)
1379 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1380 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1381 /* Don't do anything if not running a program */
1384 /* Unlock GDK mutex, because the Glk program might need to use it for shutdown */
1385 gdk_threads_leave();
1386 g_thread_join(priv->thread);
1387 gdk_threads_enter();
1391 * chimara_glk_unload_plugin:
1392 * @glk: a #ChimaraGlk widget
1394 * The plugin containing the Glk program is unloaded as late as possible before
1395 * loading a new plugin, in order to prevent crashes while printing stack
1396 * backtraces during debugging. Sometimes this behavior is not desirable. This
1397 * function forces @glk to unload the plugin running in it.
1399 * This function does nothing if there is no plugin loaded.
1402 chimara_glk_unload_plugin(ChimaraGlk *glk)
1404 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1405 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1406 if( priv->program && !g_module_close(priv->program) )
1407 g_warning( "Error closing module :%s", g_module_error() );
1411 * chimara_glk_get_running:
1412 * @glk: a #ChimaraGlk widget
1414 * Use this function to tell whether a program is currently running in the
1417 * Returns: %TRUE if @glk is executing a Glk program, %FALSE otherwise.
1420 chimara_glk_get_running(ChimaraGlk *glk)
1422 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1423 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1424 return priv->running;
1428 * chimara_glk_feed_char_input:
1429 * @glk: a #ChimaraGlk widget
1430 * @keyval: a key symbol as defined in <filename
1431 * class="headerfile">gdk/gdkkeysyms.h</filename>
1433 * Pretend that a key was pressed in the Glk program as a response to a
1434 * character input request. You can call this function even when no window has
1435 * requested character input, in which case the key will be saved for the
1436 * following window that requests character input. This has the disadvantage
1437 * that if more than one window has requested character input, it is arbitrary
1438 * which one gets the key press.
1441 chimara_glk_feed_char_input(ChimaraGlk *glk, guint keyval)
1443 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1444 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1445 g_async_queue_push(priv->char_input_queue, GUINT_TO_POINTER(keyval));
1446 event_throw(glk, evtype_ForcedCharInput, NULL, 0, 0);
1450 * chimara_glk_feed_line_input:
1451 * @glk: a #ChimaraGlk widget
1452 * @text: text to pass to the next line input request
1454 * Pretend that @text was typed in the Glk program as a response to a line input
1455 * request. @text does not need to end with a newline. You can call this
1456 * function even when no window has requested line input, in which case the text
1457 * will be saved for the following window that requests line input. This has the
1458 * disadvantage that if more than one window has requested line input, it is
1459 * arbitrary which one gets the text.
1462 chimara_glk_feed_line_input(ChimaraGlk *glk, const gchar *text)
1464 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1465 g_return_if_fail(text);
1466 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1467 g_async_queue_push(priv->line_input_queue, g_strdup(text));
1468 event_throw(glk, evtype_ForcedLineInput, NULL, 0, 0);
1472 * chimara_glk_is_char_input_pending:
1473 * @glk: a #ChimaraGlk widget
1475 * Use this function to tell if character input forced by
1476 * chimara_glk_feed_char_input() has been passed to an input request or not.
1478 * Returns: %TRUE if forced character input is pending, %FALSE otherwise.
1481 chimara_glk_is_char_input_pending(ChimaraGlk *glk)
1483 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1484 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1485 return g_async_queue_length(priv->char_input_queue) > 0;
1489 * chimara_glk_is_line_input_pending:
1490 * @glk: a #ChimaraGlk widget
1492 * Use this function to tell if line input forced by
1493 * chimara_glk_feed_line_input() has been passed to an input request or not.
1495 * Returns: %TRUE if forced line input is pending, %FALSE otherwise.
1498 chimara_glk_is_line_input_pending(ChimaraGlk *glk)
1500 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1501 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1502 return g_async_queue_length(priv->line_input_queue) > 0;
1506 * chimara_glk_get_tag:
1507 * @glk: a #ChimaraGlk widget
1508 * @window: The type of window to retrieve the tag for
1509 * @name: The name of the tag to retrieve
1511 * Use this function to get a #GtkTextTag so style properties can be changed.
1512 * See also chimara_glk_set_css_from_string().
1514 * The layout of the text in Chimara is controlled by two sets of tags: one set
1515 * describing the style in text buffers and one for text grids. See also the
1516 * Glk specification for the difference between the two. The main narrative of
1517 * a game is usually rendered in text buffers, whereas text grids are mostly
1518 * used for status bars and in game menus.
1520 * The following tag names are supported:
1522 * <listitem><para>normal</para></listitem>
1523 * <listitem><para>emphasized</para></listitem>
1524 * <listitem><para>preformatted</para></listitem>
1525 * <listitem><para>header</para></listitem>
1526 * <listitem><para>subheader</para></listitem>
1527 * <listitem><para>alert</para></listitem>
1528 * <listitem><para>note</para></listitem>
1529 * <listitem><para>block-quote</para></listitem>
1530 * <listitem><para>input</para></listitem>
1531 * <listitem><para>user1</para></listitem>
1532 * <listitem><para>user2</para></listitem>
1533 * <listitem><para>hyperlink</para></listitem>
1534 * <listitem><para>pager</para></listitem>
1537 * Returns: (transfer none): The #GtkTextTag corresponding to @name in the
1538 * styles of @window.
1541 chimara_glk_get_tag(ChimaraGlk *glk, ChimaraGlkWindowType window, const gchar *name)
1543 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1546 case CHIMARA_GLK_TEXT_BUFFER:
1547 return GTK_TEXT_TAG( g_hash_table_lookup(priv->styles->text_buffer, name) );
1549 case CHIMARA_GLK_TEXT_GRID:
1550 return GTK_TEXT_TAG( g_hash_table_lookup(priv->styles->text_grid, name) );
1553 ILLEGAL_PARAM("Unknown window type: %u", window);
1559 * chimara_glk_get_tag_names:
1560 * @glk: a #ChimaraGlk widget
1561 * @num_tags: Return location for the number of tag names retrieved.
1563 * Retrieves the possible tag names to use in chimara_glk_get_tag().
1565 * Returns: (transfer none) (array length=num_tags) (element-type utf8):
1566 * Array of strings containing the tag names. This array is owned by Chimara,
1570 chimara_glk_get_tag_names(ChimaraGlk *glk, unsigned int *num_tags)
1572 g_return_val_if_fail(num_tags != NULL, NULL);
1574 *num_tags = CHIMARA_NUM_STYLES;
1575 return style_get_tag_names();
1579 * chimara_glk_update_style:
1580 * @glk: a #ChimaraGlk widget
1582 * Processes style updates and updates the widget to reflect the new style.
1583 * Call this every time you change a property of a #GtkTextTag retrieved by
1584 * chimara_glk_get_tag().
1587 chimara_glk_update_style(ChimaraGlk *glk)
1589 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1592 /* Schedule a redraw */
1593 g_mutex_lock(&priv->arrange_lock);
1594 priv->needs_rearrange = TRUE;
1595 priv->ignore_next_arrange_event = TRUE;
1596 g_mutex_unlock(&priv->arrange_lock);
1597 gtk_widget_queue_resize( GTK_WIDGET(priv->self) );
1601 * chimara_glk_set_resource_load_callback:
1602 * @glk: a #ChimaraGlk widget
1603 * @func: a function to call for loading resources, or %NULL
1604 * @user_data: user data to pass to @func, or %NULL
1605 * @destroy_user_data: a function to call for freeing @user_data, or %NULL
1607 * Sometimes it is preferable to load image and sound resources from somewhere
1608 * else than a Blorb file, for example while developing a game. Section 14 of
1609 * the <ulink url="http://eblong.com/zarf/blorb/blorb.html#s14">Blorb
1610 * specification</ulink> allows for this possibility. This function sets @func
1611 * to be called when the Glk program requests loading an image or sound without
1612 * a Blorb resource map having been loaded, optionally passing @user_data as an
1615 * Note that @func is only called if no Blorb resource map has been set; having
1616 * a resource map in place overrides this function.
1618 * If you pass non-%NULL for @destroy_user_data, then @glk takes ownership of
1619 * @user_data. When it is not needed anymore, it will be freed by calling
1620 * @destroy_user_data on it. If you wish to retain ownership of @user_data, pass
1621 * %NULL for @destroy_user_data.
1623 * To deactivate the callback, call this function with @func set to %NULL.
1626 chimara_glk_set_resource_load_callback(ChimaraGlk *glk, ChimaraResourceLoadFunc func, gpointer user_data, GDestroyNotify destroy_user_data)
1628 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1630 if(priv->resource_load_callback == func
1631 && priv->resource_load_callback_data == user_data
1632 && priv->resource_load_callback_destroy_data == destroy_user_data)
1635 if(priv->resource_load_callback_destroy_data)
1636 priv->resource_load_callback_destroy_data(priv->resource_load_callback_data);
1638 priv->resource_load_callback = func;
1639 priv->resource_load_callback_data = user_data;
1640 priv->resource_load_callback_destroy_data = destroy_user_data;