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*);
145 static guint chimara_glk_signals[LAST_SIGNAL] = { 0 };
147 G_DEFINE_TYPE(ChimaraGlk, chimara_glk, GTK_TYPE_CONTAINER);
150 chimara_glk_init(ChimaraGlk *self)
152 GTK_WIDGET_SET_FLAGS(GTK_WIDGET(self), GTK_NO_WINDOW);
154 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(self);
157 priv->interactive = TRUE;
158 priv->protect = FALSE;
159 priv->styles = g_new0(StyleSet,1);
160 priv->glk_styles = g_new0(StyleSet,1);
161 priv->pager_attr_list = pango_attr_list_new();
162 priv->final_message = g_strdup("[ The game has finished ]");
163 priv->running = FALSE;
164 priv->program = NULL;
166 priv->event_queue = g_queue_new();
167 priv->event_lock = g_mutex_new();
168 priv->event_queue_not_empty = g_cond_new();
169 priv->event_queue_not_full = g_cond_new();
170 priv->abort_lock = g_mutex_new();
171 priv->abort_signalled = FALSE;
172 priv->shutdown_lock = g_mutex_new();
173 priv->shutdown_key_pressed = g_cond_new();
174 priv->arrange_lock = g_mutex_new();
175 priv->rearranged = g_cond_new();
176 priv->needs_rearrange = FALSE;
177 priv->ignore_next_arrange_event = FALSE;
178 priv->char_input_queue = g_async_queue_new();
179 priv->line_input_queue = g_async_queue_new();
180 /* FIXME Should be g_async_queue_new_full(g_free); but only in GTK >= 2.16 */
181 priv->resource_map = NULL;
182 priv->resource_lock = g_mutex_new();
183 priv->resource_loaded = g_cond_new();
184 priv->resource_info_available = g_cond_new();
185 priv->resource_load_callback = NULL;
186 priv->resource_load_callback_data = NULL;
187 priv->image_cache = NULL;
188 priv->program_name = NULL;
189 priv->program_info = NULL;
190 priv->story_name = NULL;
191 priv->interrupt_handler = NULL;
192 priv->root_window = NULL;
193 priv->fileref_list = NULL;
194 priv->current_stream = NULL;
195 priv->stream_list = NULL;
197 priv->in_startup = FALSE;
198 priv->current_dir = NULL;
204 chimara_glk_set_property(GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
206 ChimaraGlk *glk = CHIMARA_GLK(object);
210 case PROP_INTERACTIVE:
211 chimara_glk_set_interactive( glk, g_value_get_boolean(value) );
214 chimara_glk_set_protect( glk, g_value_get_boolean(value) );
217 chimara_glk_set_spacing( glk, g_value_get_uint(value) );
220 G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
225 chimara_glk_get_property(GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
227 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(object);
231 case PROP_INTERACTIVE:
232 g_value_set_boolean(value, priv->interactive);
235 g_value_set_boolean(value, priv->protect);
238 g_value_set_uint(value, priv->spacing);
240 case PROP_PROGRAM_NAME:
241 g_value_set_string(value, priv->program_name);
243 case PROP_PROGRAM_INFO:
244 g_value_set_string(value, priv->program_info);
246 case PROP_STORY_NAME:
247 g_value_set_string(value, priv->story_name);
250 G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
255 chimara_glk_finalize(GObject *object)
257 ChimaraGlk *self = CHIMARA_GLK(object);
258 CHIMARA_GLK_USE_PRIVATE(self, priv);
260 /* Free widget properties */
261 g_free(priv->final_message);
263 g_hash_table_destroy(priv->styles->text_buffer);
264 g_hash_table_destroy(priv->styles->text_grid);
265 g_hash_table_destroy(priv->glk_styles->text_buffer);
266 g_hash_table_destroy(priv->glk_styles->text_grid);
267 pango_attr_list_unref(priv->pager_attr_list);
269 /* Free the event queue */
270 g_mutex_lock(priv->event_lock);
271 g_queue_foreach(priv->event_queue, (GFunc)g_free, NULL);
272 g_queue_free(priv->event_queue);
273 g_cond_free(priv->event_queue_not_empty);
274 g_cond_free(priv->event_queue_not_full);
275 priv->event_queue = NULL;
276 g_mutex_unlock(priv->event_lock);
277 g_mutex_free(priv->event_lock);
278 /* Free the abort signaling mechanism */
279 g_mutex_lock(priv->abort_lock);
280 /* Make sure no other thread is busy with this */
281 g_mutex_unlock(priv->abort_lock);
282 g_mutex_free(priv->abort_lock);
283 priv->abort_lock = NULL;
284 /* Free the shutdown keypress signaling mechanism */
285 g_mutex_lock(priv->shutdown_lock);
286 g_cond_free(priv->shutdown_key_pressed);
287 g_mutex_unlock(priv->shutdown_lock);
288 priv->shutdown_lock = NULL;
289 /* Free the window arrangement signaling */
290 g_mutex_lock(priv->arrange_lock);
291 g_cond_free(priv->rearranged);
292 g_mutex_unlock(priv->arrange_lock);
293 g_mutex_free(priv->arrange_lock);
294 priv->arrange_lock = NULL;
295 g_mutex_lock(priv->resource_lock);
296 g_cond_free(priv->resource_loaded);
297 g_cond_free(priv->resource_info_available);
298 g_mutex_unlock(priv->resource_lock);
299 g_mutex_free(priv->resource_lock);
300 g_slist_foreach(priv->image_cache, (GFunc)clear_image_cache, NULL);
301 g_slist_free(priv->image_cache);
302 /* Unref input queues (this should destroy them since any Glk thread has stopped by now */
303 g_async_queue_unref(priv->char_input_queue);
304 g_async_queue_unref(priv->line_input_queue);
306 /* Free other stuff */
307 g_free(priv->current_dir);
308 g_free(priv->program_name);
309 g_free(priv->program_info);
310 g_free(priv->story_name);
311 g_free(priv->styles);
312 g_free(priv->glk_styles);
314 /* Chain up to parent */
315 G_OBJECT_CLASS(chimara_glk_parent_class)->finalize(object);
318 /* Internal function: Recursively get the Glk window tree's size request */
320 request_recurse(winid_t win, GtkRequisition *requisition, guint spacing)
322 if(win->type == wintype_Pair)
324 /* Get children's size requests */
325 GtkRequisition child1, child2;
326 request_recurse(win->window_node->children->data, &child1, spacing);
327 request_recurse(win->window_node->children->next->data, &child2, spacing);
329 glui32 division = win->split_method & winmethod_DivisionMask;
330 glui32 direction = win->split_method & winmethod_DirMask;
331 unsigned border = ((win->split_method & winmethod_BorderMask) == winmethod_NoBorder)? 0 : spacing;
333 /* If the split is fixed, get the size of the fixed child */
334 if(division == winmethod_Fixed)
339 child1.width = win->key_window?
340 win->constraint_size * win->key_window->unit_width
343 case winmethod_Right:
344 child2.width = win->key_window?
345 win->constraint_size * win->key_window->unit_width
348 case winmethod_Above:
349 child1.height = win->key_window?
350 win->constraint_size * win->key_window->unit_height
353 case winmethod_Below:
354 child2.height = win->key_window?
355 win->constraint_size * win->key_window->unit_height
361 /* Add the children's requests */
365 case winmethod_Right:
366 requisition->width = child1.width + child2.width + border;
367 requisition->height = MAX(child1.height, child2.height);
369 case winmethod_Above:
370 case winmethod_Below:
371 requisition->width = MAX(child1.width, child2.width);
372 requisition->height = child1.height + child2.height + border;
377 /* For non-pair windows, just use the size that GTK requests */
379 gtk_widget_size_request(win->frame, requisition);
382 /* Overrides gtk_widget_size_request */
384 chimara_glk_size_request(GtkWidget *widget, GtkRequisition *requisition)
386 g_return_if_fail(widget);
387 g_return_if_fail(requisition);
388 g_return_if_fail(CHIMARA_IS_GLK(widget));
390 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(widget);
392 /* For now, just pass the size request on to the root Glk window */
393 if(priv->root_window)
395 request_recurse(priv->root_window->data, requisition, priv->spacing);
396 requisition->width += 2 * GTK_CONTAINER(widget)->border_width;
397 requisition->height += 2 * GTK_CONTAINER(widget)->border_width;
401 requisition->width = CHIMARA_GLK_MIN_WIDTH + 2 * GTK_CONTAINER(widget)->border_width;
402 requisition->height = CHIMARA_GLK_MIN_HEIGHT + 2 * GTK_CONTAINER(widget)->border_width;
406 /* Recursively give the Glk windows their allocated space. Returns a window
407 containing all children of this window that must be redrawn, or NULL if there
408 are no children that require redrawing. */
410 allocate_recurse(winid_t win, GtkAllocation *allocation, guint spacing)
412 if(win->type == wintype_Pair)
414 glui32 division = win->split_method & winmethod_DivisionMask;
415 glui32 direction = win->split_method & winmethod_DirMask;
416 unsigned border = ((win->split_method & winmethod_BorderMask) == winmethod_NoBorder)? 0 : spacing;
418 /* If the space gets too small to honor the spacing property, then just
419 ignore spacing in this window and below. */
420 if( (border > allocation->width && (direction == winmethod_Left || direction == winmethod_Right))
421 || (border > allocation->height && (direction == winmethod_Above || direction == winmethod_Below)) )
424 GtkAllocation child1, child2;
425 child1.x = allocation->x;
426 child1.y = allocation->y;
428 if(division == winmethod_Fixed)
430 /* If the key window has been closed, then default to 0; otherwise
431 use the key window to determine the size */
435 child1.width = win->key_window?
436 CLAMP(win->constraint_size * win->key_window->unit_width, 0, allocation->width - border)
439 case winmethod_Right:
440 child2.width = win->key_window?
441 CLAMP(win->constraint_size * win->key_window->unit_width, 0, allocation->width - border)
444 case winmethod_Above:
445 child1.height = win->key_window?
446 CLAMP(win->constraint_size * win->key_window->unit_height, 0, allocation->height - border)
449 case winmethod_Below:
450 child2.height = win->key_window?
451 CLAMP(win->constraint_size * win->key_window->unit_height, 0, allocation->height - border)
456 else /* proportional */
458 gdouble fraction = win->constraint_size / 100.0;
462 child1.width = MAX(0, (gint)ceil(fraction * (allocation->width - border)) );
464 case winmethod_Right:
465 child2.width = MAX(0, (gint)ceil(fraction * (allocation->width - border)) );
467 case winmethod_Above:
468 child1.height = MAX(0, (gint)ceil(fraction * (allocation->height - border)) );
470 case winmethod_Below:
471 child2.height = MAX(0, (gint)ceil(fraction * (allocation->height - border)) );
476 /* Fill in the rest of the size requisitions according to the child specified above */
480 child2.width = MAX(0, allocation->width - border - child1.width);
481 child2.x = child1.x + child1.width + border;
483 child1.height = child2.height = allocation->height;
485 case winmethod_Right:
486 child1.width = MAX(0, allocation->width - border - child2.width);
487 child2.x = child1.x + child1.width + border;
489 child1.height = child2.height = allocation->height;
491 case winmethod_Above:
492 child2.height = MAX(0, allocation->height - border - child1.height);
494 child2.y = child1.y + child1.height + border;
495 child1.width = child2.width = allocation->width;
497 case winmethod_Below:
498 child1.height = MAX(0, allocation->height - border - child2.height);
500 child2.y = child1.y + child1.height + border;
501 child1.width = child2.width = allocation->width;
506 winid_t arrange1 = allocate_recurse(win->window_node->children->data, &child1, spacing);
507 winid_t arrange2 = allocate_recurse(win->window_node->children->next->data, &child2, spacing);
515 else if(win->type == wintype_TextGrid)
517 /* Pass the size allocation on to the framing widget */
518 gtk_widget_size_allocate(win->frame, allocation);
519 /* It says in the spec that when a text grid window is resized smaller,
520 the bottom or right area is thrown away; when it is resized larger, the
521 bottom or right area is filled with blanks. */
522 glui32 newwidth = (glui32)(win->widget->allocation.width / win->unit_width);
523 glui32 newheight = (glui32)(win->widget->allocation.height / win->unit_height);
525 GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
526 GtkTextIter start, end;
528 for(line = 0; line < win->height; line++)
530 gtk_text_buffer_get_iter_at_line(textbuffer, &start, line);
531 /* If this line is going to fall off the bottom, delete it */
532 if(line >= newheight)
535 gtk_text_iter_forward_to_line_end(&end);
536 gtk_text_iter_forward_char(&end);
537 gtk_text_buffer_delete(textbuffer, &start, &end);
540 /* If this line is not long enough, add spaces on the end */
541 if(newwidth > win->width)
543 gchar *spaces = g_strnfill(newwidth - win->width, ' ');
544 gtk_text_iter_forward_to_line_end(&start);
545 gtk_text_buffer_insert(textbuffer, &start, spaces, -1);
548 /* But if it's too long, delete characters from the end */
549 else if(newwidth < win->width)
552 gtk_text_iter_forward_chars(&start, newwidth);
553 gtk_text_iter_forward_to_line_end(&end);
554 gtk_text_buffer_delete(textbuffer, &start, &end);
556 /* Note: if the widths are equal, do nothing */
558 /* Add blank lines if there aren't enough lines to fit the new size */
559 if(newheight > win->height)
561 gchar *blanks = g_strnfill(win->width, ' ');
562 gchar **blanklines = g_new0(gchar *, (newheight - win->height) + 1);
564 for(count = 0; count < newheight - win->height; count++)
565 blanklines[count] = blanks;
566 blanklines[newheight - win->height] = NULL;
567 gchar *text = g_strjoinv("\n", blanklines);
568 g_free(blanklines); /* not g_strfreev() */
571 gtk_text_buffer_get_end_iter(textbuffer, &start);
572 gtk_text_buffer_insert(textbuffer, &start, "\n", -1);
573 gtk_text_buffer_insert(textbuffer, &start, text, -1);
577 gboolean arrange = !(win->width == newwidth && win->height == newheight);
578 win->width = newwidth;
579 win->height = newheight;
580 return arrange? win : NULL;
583 /* For non-pair, non-text-grid windows, just give them the size */
584 gtk_widget_size_allocate(win->frame, allocation);
588 /* Overrides gtk_widget_size_allocate */
590 chimara_glk_size_allocate(GtkWidget *widget, GtkAllocation *allocation)
592 g_return_if_fail(widget);
593 g_return_if_fail(allocation);
594 g_return_if_fail(CHIMARA_IS_GLK(widget));
596 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(widget);
598 widget->allocation = *allocation;
600 if(priv->root_window) {
602 child.x = allocation->x + GTK_CONTAINER(widget)->border_width;
603 child.y = allocation->y + GTK_CONTAINER(widget)->border_width;
604 child.width = CLAMP(allocation->width - 2 * GTK_CONTAINER(widget)->border_width, 0, allocation->width);
605 child.height = CLAMP(allocation->height - 2 * GTK_CONTAINER(widget)->border_width, 0, allocation->height);
606 winid_t arrange = allocate_recurse(priv->root_window->data, &child, priv->spacing);
608 /* arrange points to a window that contains all text grid and graphics
609 windows which have been resized */
610 g_mutex_lock(priv->arrange_lock);
611 if(!priv->ignore_next_arrange_event)
614 event_throw(CHIMARA_GLK(widget), evtype_Arrange, arrange == priv->root_window->data? NULL : arrange, 0, 0);
617 priv->ignore_next_arrange_event = FALSE;
618 priv->needs_rearrange = FALSE;
619 g_cond_signal(priv->rearranged);
620 g_mutex_unlock(priv->arrange_lock);
624 /* Recursively invoke callback() on the GtkWidget of each non-pair window in the tree */
626 forall_recurse(winid_t win, GtkCallback callback, gpointer callback_data)
628 if(win->type == wintype_Pair)
630 forall_recurse(win->window_node->children->data, callback, callback_data);
631 forall_recurse(win->window_node->children->next->data, callback, callback_data);
634 (*callback)(win->frame, callback_data);
637 /* Overrides gtk_container_forall */
639 chimara_glk_forall(GtkContainer *container, gboolean include_internals, GtkCallback callback, gpointer callback_data)
641 g_return_if_fail(container);
642 g_return_if_fail(CHIMARA_IS_GLK(container));
644 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(container);
646 /* All the children are "internal" */
647 if(!include_internals)
650 if(priv->root_window)
651 forall_recurse(priv->root_window->data, callback, callback_data);
655 chimara_glk_stopped(ChimaraGlk *self)
657 CHIMARA_GLK_USE_PRIVATE(self, priv);
658 priv->running = FALSE;
659 priv->program_name = NULL;
660 g_object_notify(G_OBJECT(self), "program-name");
661 priv->program_info = NULL;
662 g_object_notify(G_OBJECT(self), "program-info");
663 priv->story_name = NULL;
664 g_object_notify(G_OBJECT(self), "story-name");
668 chimara_glk_started(ChimaraGlk *self)
670 CHIMARA_GLK_USE_PRIVATE(self, priv);
671 priv->running = TRUE;
675 chimara_glk_waiting(ChimaraGlk *self)
677 /* Default signal handler */
681 chimara_glk_char_input(ChimaraGlk *self, guint window_rock, guint keysym)
683 /* Default signal handler */
687 chimara_glk_line_input(ChimaraGlk *self, guint window_rock, gchar *text)
689 /* Default signal handler */
693 chimara_glk_text_buffer_output(ChimaraGlk *self, guint window_rock, gchar *text)
695 /* Default signal handler */
699 chimara_glk_iliad_screen_update(ChimaraGlk *self, gboolean typing)
701 /* Default signal handler */
704 /* COMPAT: G_PARAM_STATIC_STRINGS only appeared in GTK 2.13.0 */
705 #ifndef G_PARAM_STATIC_STRINGS
707 /* COMPAT: G_PARAM_STATIC_NAME and friends only appeared in GTK 2.8 */
708 #if GTK_CHECK_VERSION(2,8,0)
709 #define G_PARAM_STATIC_STRINGS (G_PARAM_STATIC_NAME | G_PARAM_STATIC_NICK | G_PARAM_STATIC_BLURB)
711 #define G_PARAM_STATIC_STRINGS (0)
717 chimara_glk_class_init(ChimaraGlkClass *klass)
719 /* Override methods of parent classes */
720 GObjectClass *object_class = G_OBJECT_CLASS(klass);
721 object_class->set_property = chimara_glk_set_property;
722 object_class->get_property = chimara_glk_get_property;
723 object_class->finalize = chimara_glk_finalize;
725 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS(klass);
726 widget_class->size_request = chimara_glk_size_request;
727 widget_class->size_allocate = chimara_glk_size_allocate;
729 GtkContainerClass *container_class = GTK_CONTAINER_CLASS(klass);
730 container_class->forall = chimara_glk_forall;
733 klass->stopped = chimara_glk_stopped;
734 klass->started = chimara_glk_started;
735 klass->waiting = chimara_glk_waiting;
736 klass->char_input = chimara_glk_char_input;
737 klass->line_input = chimara_glk_line_input;
738 klass->text_buffer_output = chimara_glk_text_buffer_output;
739 klass->iliad_screen_update = chimara_glk_iliad_screen_update;
742 * ChimaraGlk::stopped:
743 * @glk: The widget that received the signal
745 * Emitted when the a Glk program finishes executing in the widget, whether
746 * it ended normally, or was interrupted.
748 chimara_glk_signals[STOPPED] = g_signal_new("stopped",
749 G_OBJECT_CLASS_TYPE(klass), G_SIGNAL_RUN_FIRST,
750 /* FIXME: Should be G_SIGNAL_RUN_CLEANUP but that segfaults??! */
751 G_STRUCT_OFFSET(ChimaraGlkClass, stopped), NULL, NULL,
752 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
754 * ChimaraGlk::started:
755 * @glk: The widget that received the signal
757 * Emitted when a Glk program starts executing in the widget.
759 chimara_glk_signals[STARTED] = g_signal_new ("started",
760 G_OBJECT_CLASS_TYPE(klass), G_SIGNAL_RUN_FIRST,
761 G_STRUCT_OFFSET(ChimaraGlkClass, started), NULL, NULL,
762 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
764 * ChimaraGlk::waiting:
765 * @glk: The widget that received the signal
767 * Emitted when glk_select() is called by the Glk program and the event
768 * queue is empty, which means that the widget is waiting for input.
770 chimara_glk_signals[WAITING] = g_signal_new("waiting",
771 G_OBJECT_CLASS_TYPE(klass), 0,
772 G_STRUCT_OFFSET(ChimaraGlkClass, waiting), NULL, NULL,
773 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
775 * ChimaraGlk::char-input:
776 * @glk: The widget that received the signal
777 * @window_rock: The rock value of the window that received character input
778 * (see <link linkend="chimara-Rocks">Rocks</link>)
779 * @keysym: The key that was typed, in the form of a key symbol from
780 * <filename class="headerfile">gdk/gdkkeysyms.h</filename>
782 * Emitted when a Glk window receives character input.
784 chimara_glk_signals[CHAR_INPUT] = g_signal_new("char-input",
785 G_OBJECT_CLASS_TYPE(klass), 0,
786 G_STRUCT_OFFSET(ChimaraGlkClass, char_input), NULL, NULL,
787 _chimara_marshal_VOID__UINT_UINT,
788 G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_UINT);
790 * ChimaraGlk::line-input:
791 * @glk: The widget that received the signal
792 * @window_rock: The rock value of the window that received line input (see
793 * <link linkend="chimara-Rocks">Rocks</link>)
794 * @text: The text that was typed
796 * Emitted when a Glk window receives line input.
798 chimara_glk_signals[LINE_INPUT] = g_signal_new("line-input",
799 G_OBJECT_CLASS_TYPE(klass), 0,
800 G_STRUCT_OFFSET(ChimaraGlkClass, line_input), NULL, NULL,
801 _chimara_marshal_VOID__UINT_STRING,
802 G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_STRING);
804 * ChimaraGlk::text-buffer-output:
805 * @glk: The widget that received the signal
806 * @window_rock: The rock value of the window that was printed to (see <link
807 * linkend="chimara-Rocks">Rocks</link>)
809 * Emitted when text is printed to a text buffer window.
811 chimara_glk_signals[TEXT_BUFFER_OUTPUT] = g_signal_new("text-buffer-output",
812 G_OBJECT_CLASS_TYPE(klass), 0,
813 G_STRUCT_OFFSET(ChimaraGlkClass, text_buffer_output), NULL, NULL,
814 _chimara_marshal_VOID__UINT_STRING,
815 G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_STRING);
817 * ChimaraGlk::iliad-screen-update:
818 * @self: The widget that received the signal
819 * @typing: Whether to perform a typing or full screen update
821 * Iliad specific signal which is emitted whenever the screen needs to be updated.
822 * Since iliad screen updates are very slow, updating should only be done when
825 chimara_glk_signals[ILIAD_SCREEN_UPDATE] = g_signal_new("iliad-screen-update",
826 G_OBJECT_CLASS_TYPE(klass), 0,
827 G_STRUCT_OFFSET(ChimaraGlkClass, iliad_screen_update), NULL, NULL,
828 _chimara_marshal_VOID__BOOLEAN,
829 G_TYPE_NONE, 1, G_TYPE_BOOLEAN);
833 * ChimaraGlk:interactive:
835 * Sets whether the widget is interactive. A Glk widget is normally
836 * interactive, but in non-interactive mode, keyboard and mouse input are
837 * ignored and the Glk program is controlled by
838 * chimara_glk_feed_char_input() and chimara_glk_feed_line_input().
839 * <quote>More</quote> prompts when a lot of text is printed to a text
840 * buffer are also disabled. This is typically used when you wish to control
841 * an interpreter program by feeding it a predefined list of commands.
843 g_object_class_install_property( object_class, PROP_INTERACTIVE,
844 g_param_spec_boolean("interactive", _("Interactive"),
845 _("Whether user input is expected in the Glk program"),
847 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
850 * ChimaraGlk:protect:
852 * Sets whether the Glk program is allowed to do file operations. In protect
853 * mode, all file operations will fail.
855 g_object_class_install_property(object_class, PROP_PROTECT,
856 g_param_spec_boolean("protect", _("Protected"),
857 _("Whether the Glk program is barred from doing file operations"),
859 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
862 * ChimaraGlk:spacing:
864 * The amount of space between the Glk windows. This space forms a visible
865 * border between windows; however, if you open a window using the
866 * %winmethod_NoBorder flag, there will be no spacing between it and its
867 * sibling window, no matter what the value of this property is.
869 g_object_class_install_property(object_class, PROP_SPACING,
870 g_param_spec_uint("spacing", _("Spacing"),
871 _("The amount of space between Glk windows"),
873 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
876 * ChimaraGlk:program-name:
878 * The name of the currently running Glk program. You cannot set this
879 * property yourself. It is set to the filename of the plugin when you call
880 * chimara_glk_run(), but the plugin can change it by calling
881 * garglk_set_program_name(). To find out when this information changes,
882 * for example to put the program name in the title bar of a window, connect
883 * to the <code>::notify::program-name</code> signal.
885 g_object_class_install_property(object_class, PROP_PROGRAM_NAME,
886 g_param_spec_string("program-name", _("Program name"),
887 _("Name of the currently running program"),
889 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
892 * ChimaraGlk:program-info:
894 * Information about the currently running Glk program. You cannot set this
895 * property yourself. The plugin can change it by calling
896 * garglk_set_program_info(). See also #ChimaraGlk:program-name.
898 g_object_class_install_property(object_class, PROP_PROGRAM_INFO,
899 g_param_spec_string("program-info", _("Program info"),
900 _("Information about the currently running program"),
902 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
905 * ChimaraGlk:story-name:
907 * The name of the story currently running in the Glk interpreter. You
908 * cannot set this property yourself. It is set to the story filename when
909 * you call chimara_if_run_game(), but the plugin can change it by calling
910 * garglk_set_story_name().
912 * Strictly speaking, this should be a property of #ChimaraIF, but it is
913 * legal for any Glk program to call garglk_set_story_name(), even if it is
914 * not an interpreter and does not load story files.
916 g_object_class_install_property(object_class, PROP_STORY_NAME,
917 g_param_spec_string("story-name", _("Story name"),
918 _("Name of the story currently loaded in the interpreter"),
920 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
923 g_type_class_add_private(klass, sizeof(ChimaraGlkPrivate));
926 /* PUBLIC FUNCTIONS */
929 * chimara_error_quark:
931 * The error domain for errors from Chimara widgets.
933 * Returns: The string <quote>chimara-error-quark</quote> as a <link
934 * linkend="GQuark">GQuark</link>.
937 chimara_error_quark(void)
939 chimara_init(); /* This is a library entry point */
940 return g_quark_from_static_string("chimara-error-quark");
946 * Creates and initializes a new #ChimaraGlk widget.
948 * Return value: a #ChimaraGlk widget, with a floating reference.
951 chimara_glk_new(void)
953 /* This is a library entry point; initialize the library */
956 return GTK_WIDGET(g_object_new(CHIMARA_TYPE_GLK, NULL));
960 * chimara_glk_set_interactive:
961 * @glk: a #ChimaraGlk widget
962 * @interactive: whether the widget should expect user input
964 * Sets the #ChimaraGlk:interactive property of @glk.
967 chimara_glk_set_interactive(ChimaraGlk *glk, gboolean interactive)
969 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
971 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
972 priv->interactive = interactive;
973 g_object_notify(G_OBJECT(glk), "interactive");
977 * chimara_glk_get_interactive:
978 * @glk: a #ChimaraGlk widget
980 * Returns whether @glk is interactive (expecting user input). See
981 * #ChimaraGlk:interactive.
983 * Return value: %TRUE if @glk is interactive.
986 chimara_glk_get_interactive(ChimaraGlk *glk)
988 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
990 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
991 return priv->interactive;
995 * chimara_glk_set_protect:
996 * @glk: a #ChimaraGlk widget
997 * @protect: whether the widget should allow the Glk program to do file
1000 * Sets the #ChimaraGlk:protect property of @glk. In protect mode, the Glk
1001 * program is not allowed to do file operations.
1004 chimara_glk_set_protect(ChimaraGlk *glk, gboolean protect)
1006 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1008 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1009 priv->protect = protect;
1010 g_object_notify(G_OBJECT(glk), "protect");
1014 * chimara_glk_get_protect:
1015 * @glk: a #ChimaraGlk widget
1017 * Returns whether @glk is in protect mode (banned from doing file operations).
1018 * See #ChimaraGlk:protect.
1020 * Return value: %TRUE if @glk is in protect mode.
1023 chimara_glk_get_protect(ChimaraGlk *glk)
1025 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1027 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1028 return priv->protect;
1032 * chimara_glk_set_css_to_default:
1033 * @glk: a #ChimaraGlk widget
1035 * Resets the styles for text buffer and text grid windows to their defaults.
1037 * This function is not implemented yet.
1041 chimara_glk_set_css_to_default(ChimaraGlk *glk)
1043 reset_default_styles(glk);
1047 * chimara_glk_set_css_from_file:
1048 * @glk: a #ChimaraGlk widget
1049 * @filename: path to a CSS file, or %NULL
1050 * @error: location to store a <link
1051 * linkend="glib-Error-Reporting">GError</link>, or %NULL
1053 * Sets the styles for text buffer and text grid windows according to the CSS
1054 * file @filename. Note that the styles are set cumulatively on top of whatever
1055 * the styles are at the time this function is called; to reset the styles to
1056 * their defaults, use chimara_glk_set_css_to_default().
1058 * Returns: %TRUE on success, %FALSE if an error occurred, in which case @error
1062 chimara_glk_set_css_from_file(ChimaraGlk *glk, const gchar *filename, GError **error)
1064 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1065 g_return_val_if_fail(filename, FALSE);
1066 g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
1068 int fd = open(filename, O_RDONLY);
1071 *error = g_error_new(G_IO_ERROR, g_io_error_from_errno(errno),
1072 _("Error opening file \"%s\": %s"), filename, g_strerror(errno));
1076 GScanner *scanner = create_css_file_scanner();
1077 g_scanner_input_file(scanner, fd);
1078 scanner->input_name = filename;
1079 scan_css_file(scanner, glk);
1081 if(close(fd) == -1) {
1083 *error = g_error_new(G_IO_ERROR, g_io_error_from_errno(errno),
1084 _("Error closing file \"%s\": %s"), filename, g_strerror(errno));
1091 * chimara_glk_set_css_from_string:
1092 * @glk: a #ChimaraGlk widget
1093 * @css: a string containing CSS code
1095 * Sets the styles for text buffer and text grid windows according to the CSS
1096 * code @css. Note that the styles are set cumulatively on top of whatever the
1097 * styles are at the time this function is called; to reset the styles to their
1098 * defaults, use chimara_glk_set_css_to_default().
1101 chimara_glk_set_css_from_string(ChimaraGlk *glk, const gchar *css)
1103 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1104 g_return_if_fail(css || *css);
1106 GScanner *scanner = create_css_file_scanner();
1107 g_scanner_input_text(scanner, css, strlen(css));
1108 scanner->input_name = "<string>";
1109 scan_css_file(scanner, glk);
1113 * chimara_glk_set_spacing:
1114 * @glk: a #ChimaraGlk widget
1115 * @spacing: the number of pixels to put between Glk windows
1117 * Sets the #ChimaraGlk:spacing property of @glk, which is the border width in
1118 * pixels between Glk windows.
1121 chimara_glk_set_spacing(ChimaraGlk *glk, guint spacing)
1123 g_return_if_fail( glk || CHIMARA_IS_GLK(glk) );
1125 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1126 priv->spacing = spacing;
1127 g_object_notify(G_OBJECT(glk), "spacing");
1131 * chimara_glk_get_spacing:
1132 * @glk: a #ChimaraGlk widget
1134 * Gets the value set by chimara_glk_set_spacing().
1136 * Return value: pixels of spacing between Glk windows
1139 chimara_glk_get_spacing(ChimaraGlk *glk)
1141 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), 0);
1143 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1144 return priv->spacing;
1147 struct StartupData {
1148 glk_main_t glk_main;
1149 glkunix_startup_code_t glkunix_startup_code;
1150 glkunix_startup_t args;
1151 ChimaraGlkPrivate *glk_data;
1154 /* glk_enter() is the actual function called in the new thread in which glk_main() runs. */
1156 glk_enter(struct StartupData *startup)
1158 extern GPrivate *glk_data_key;
1159 g_private_set(glk_data_key, startup->glk_data);
1161 /* Acquire the Glk thread's references to the input queues */
1162 g_async_queue_ref(startup->glk_data->char_input_queue);
1163 g_async_queue_ref(startup->glk_data->line_input_queue);
1165 /* Run startup function */
1166 if(startup->glkunix_startup_code) {
1167 startup->glk_data->in_startup = TRUE;
1168 int result = startup->glkunix_startup_code(&startup->args);
1169 startup->glk_data->in_startup = FALSE;
1172 while(i < startup->args.argc)
1173 g_free(startup->args.argv[i++]);
1174 g_free(startup->args.argv);
1180 /* Run main function */
1181 glk_main_t glk_main = startup->glk_main;
1183 /* COMPAT: avoid usage of slices */
1185 g_signal_emit_by_name(startup->glk_data->self, "started");
1187 glk_exit(); /* Run shutdown code in glk_exit() even if glk_main() returns normally */
1188 g_assert_not_reached(); /* because glk_exit() calls g_thread_exit() */
1194 * @glk: a #ChimaraGlk widget
1195 * @plugin: path to a plugin module compiled with <filename
1196 * class="header">glk.h</filename>
1197 * @argc: Number of command line arguments in @argv
1198 * @argv: Array of command line arguments to pass to the plugin
1199 * @error: location to store a <link
1200 * linkend="glib-Error-Reporting">GError</link>, or %NULL
1202 * Opens a Glk program compiled as a plugin. Sorts out its command line
1203 * arguments from #glkunix_arguments, calls its startup function
1204 * glkunix_startup_code(), and then calls its main function glk_main() in
1205 * a separate thread. On failure, returns %FALSE and sets @error.
1207 * The plugin must at least export a glk_main() function; #glkunix_arguments and
1208 * glkunix_startup_code() are optional.
1210 * Return value: %TRUE if the Glk program was started successfully.
1213 chimara_glk_run(ChimaraGlk *glk, const gchar *plugin, int argc, char *argv[], GError **error)
1215 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1216 g_return_val_if_fail(plugin, FALSE);
1217 g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
1219 if(chimara_glk_get_running(glk)) {
1220 g_set_error(error, CHIMARA_ERROR, CHIMARA_PLUGIN_ALREADY_RUNNING, _("There was already a plugin running."));
1224 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1226 /* COMPAT: avoid usage of slices */
1227 struct StartupData *startup = g_new0(struct StartupData,1);
1229 g_assert( g_module_supported() );
1230 /* If there is already a module loaded, free it first -- you see, we want to
1231 * keep modules loaded as long as possible to avoid crashes in stack unwinding */
1232 if( priv->program && !g_module_close(priv->program) )
1233 g_warning( "Error closing module :%s", g_module_error() );
1234 /* Open the module to run */
1235 priv->program = g_module_open(plugin, G_MODULE_BIND_LAZY);
1239 g_set_error(error, CHIMARA_ERROR, CHIMARA_LOAD_MODULE_ERROR, _("Error opening module: %s"), g_module_error());
1242 if( !g_module_symbol(priv->program, "glk_main", (gpointer *) &startup->glk_main) )
1244 g_set_error(error, CHIMARA_ERROR, CHIMARA_NO_GLK_MAIN, _("Error finding glk_main(): %s"), g_module_error());
1248 if( g_module_symbol(priv->program, "glkunix_startup_code", (gpointer *) &startup->glkunix_startup_code) )
1250 glkunix_argumentlist_t *glkunix_arguments;
1252 if( !(g_module_symbol(priv->program, "glkunix_arguments", (gpointer *) &glkunix_arguments)
1253 && parse_command_line(glkunix_arguments, argc, argv, &startup->args)) )
1255 /* arguments could not be parsed, so create data ourselves */
1256 startup->args.argc = 1;
1257 startup->args.argv = g_new0(gchar *, 1);
1260 /* Set the program invocation name */
1261 startup->args.argv[0] = g_strdup(plugin);
1263 startup->glk_data = priv;
1265 /* Set the program name */
1266 priv->program_name = g_path_get_basename(plugin);
1267 g_object_notify(G_OBJECT(glk), "program-name");
1269 /* Run in a separate thread */
1270 priv->thread = g_thread_create((GThreadFunc)glk_enter, startup, TRUE, error);
1272 return !(priv->thread == NULL);
1277 * @glk: a #ChimaraGlk widget
1279 * Signals the Glk program running in @glk to abort. Note that if the program is
1280 * caught in an infinite loop in which glk_tick() is not called, this may not
1284 chimara_glk_stop(ChimaraGlk *glk)
1286 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1287 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1289 /* Don't do anything if not running a program */
1293 if(priv->abort_lock) {
1294 g_mutex_lock(priv->abort_lock);
1295 priv->abort_signalled = TRUE;
1296 g_mutex_unlock(priv->abort_lock);
1297 /* Stop blocking on the event queue condition */
1298 event_throw(glk, evtype_Abort, NULL, 0, 0);
1299 /* Stop blocking on the shutdown key press condition */
1300 g_mutex_lock(priv->shutdown_lock);
1301 g_cond_signal(priv->shutdown_key_pressed);
1302 g_mutex_unlock(priv->shutdown_lock);
1308 * @glk: a #ChimaraGlk widget
1310 * Holds up the main thread and waits for the Glk program running in @glk to
1314 chimara_glk_wait(ChimaraGlk *glk)
1316 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1317 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1318 /* Don't do anything if not running a program */
1321 /* Unlock GDK mutex, because the Glk program might need to use it for shutdown */
1322 gdk_threads_leave();
1323 g_thread_join(priv->thread);
1324 gdk_threads_enter();
1328 * chimara_glk_get_running:
1329 * @glk: a #ChimaraGlk widget
1331 * Use this function to tell whether a program is currently running in the
1334 * Returns: %TRUE if @glk is executing a Glk program, %FALSE otherwise.
1337 chimara_glk_get_running(ChimaraGlk *glk)
1339 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1340 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1341 return priv->running;
1345 * chimara_glk_feed_char_input:
1346 * @glk: a #ChimaraGlk widget
1347 * @keyval: a key symbol as defined in <filename
1348 * class="headerfile">gdk/gdkkeysyms.h</filename>
1350 * Pretend that a key was pressed in the Glk program as a response to a
1351 * character input request. You can call this function even when no window has
1352 * requested character input, in which case the key will be saved for the
1353 * following window that requests character input. This has the disadvantage
1354 * that if more than one window has requested character input, it is arbitrary
1355 * which one gets the key press.
1358 chimara_glk_feed_char_input(ChimaraGlk *glk, guint keyval)
1360 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1361 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1362 g_async_queue_push(priv->char_input_queue, GUINT_TO_POINTER(keyval));
1363 event_throw(glk, evtype_ForcedCharInput, NULL, 0, 0);
1367 * chimara_glk_feed_line_input:
1368 * @glk: a #ChimaraGlk widget
1369 * @text: text to pass to the next line input request
1371 * Pretend that @text was typed in the Glk program as a response to a line input
1372 * request. @text does not need to end with a newline. You can call this
1373 * function even when no window has requested line input, in which case the text
1374 * will be saved for the following window that requests line input. This has the
1375 * disadvantage that if more than one window has requested line input, it is
1376 * arbitrary which one gets the text.
1379 chimara_glk_feed_line_input(ChimaraGlk *glk, const gchar *text)
1381 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1382 g_return_if_fail(text);
1383 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1384 g_async_queue_push(priv->line_input_queue, g_strdup(text));
1385 event_throw(glk, evtype_ForcedLineInput, NULL, 0, 0);
1389 * chimara_glk_is_char_input_pending:
1390 * @glk: a #ChimaraGlk widget
1392 * Use this function to tell if character input forced by
1393 * chimara_glk_feed_char_input() has been passed to an input request or not.
1395 * Returns: %TRUE if forced character input is pending, %FALSE otherwise.
1398 chimara_glk_is_char_input_pending(ChimaraGlk *glk)
1400 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1401 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1402 return g_async_queue_length(priv->char_input_queue) > 0;
1406 * chimara_glk_is_line_input_pending:
1407 * @glk: a #ChimaraGlk widget
1409 * Use this function to tell if line input forced by
1410 * chimara_glk_feed_line_input() has been passed to an input request or not.
1412 * Returns: %TRUE if forced line input is pending, %FALSE otherwise.
1415 chimara_glk_is_line_input_pending(ChimaraGlk *glk)
1417 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1418 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1419 return g_async_queue_length(priv->line_input_queue) > 0;
1423 * chimara_glk_get_tag:
1424 * @glk: a #ChimaraGlk widget
1425 * @window: The type of window to retrieve the tag for
1426 * @name: The name of the tag to retrieve
1428 * Use this function to get a #GtkTextTag so style properties can be changed.
1429 * See also chimara_glk_set_css_from_string().
1431 * The layout of the text in Chimara is controlled by two sets of tags: one set
1432 * describing the style in text buffers and one for text grids. See also the
1433 * Glk specification for the difference between the two. The main narrative of
1434 * a game is usually rendered in text buffers, whereas text grids are mostly
1435 * used for status bars and in game menus.
1437 * The following tag names are supported:
1439 * <listitem><para>normal</para></listitem>
1440 * <listitem><para>emphasized</para></listitem>
1441 * <listitem><para>preformatted</para></listitem>
1442 * <listitem><para>header</para></listitem>
1443 * <listitem><para>subheader</para></listitem>
1444 * <listitem><para>alert</para></listitem>
1445 * <listitem><para>note</para></listitem>
1446 * <listitem><para>block-quote</para></listitem>
1447 * <listitem><para>input</para></listitem>
1448 * <listitem><para>user1</para></listitem>
1449 * <listitem><para>user2</para></listitem>
1450 * <listitem><para>hyperlink</para></listitem>
1451 * <listitem><para>pager</para></listitem>
1455 chimara_glk_get_tag(ChimaraGlk *glk, ChimaraGlkWindowType window, const gchar *name)
1457 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1460 case CHIMARA_GLK_TEXT_BUFFER:
1461 return GTK_TEXT_TAG( g_hash_table_lookup(priv->styles->text_buffer, name) );
1463 case CHIMARA_GLK_TEXT_GRID:
1464 return GTK_TEXT_TAG( g_hash_table_lookup(priv->styles->text_grid, name) );
1467 ILLEGAL_PARAM("Unknown window type: %u", window);
1473 * chimara_glk_get_tag_names:
1474 * @glk: a #ChimaraGlk widget
1476 * Retrieves the possible tag names to use in chimara_glk_get_tag().
1479 chimara_glk_get_tag_names(ChimaraGlk *glk)
1481 return style_get_tag_names();
1485 * chimara_glk_get_num_tag_names:
1486 * @glk: a #ChimaraGlk widget
1488 * Retrieves the number of style tags returned by chimara_glk_get_tag_names().
1491 chimara_glk_get_num_tag_names(ChimaraGlk *glk)
1493 return CHIMARA_NUM_STYLES;
1497 * chimara_glk_update_style:
1498 * @glk: a #ChimaraGlk widget
1500 * Processes style updates and updates the widget to reflect the new style.
1501 * Call this every time you change a property of a #GtkTextTag retrieved by
1502 * chimara_glk_get_tag().
1505 chimara_glk_update_style(ChimaraGlk *glk)
1507 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1510 /* Schedule a redraw */
1511 g_mutex_lock(priv->arrange_lock);
1512 priv->needs_rearrange = TRUE;
1513 priv->ignore_next_arrange_event = TRUE;
1514 g_mutex_unlock(priv->arrange_lock);
1515 gtk_widget_queue_resize( GTK_WIDGET(priv->self) );
1519 * chimara_glk_set_resource_load_callback:
1520 * @glk: a #ChimaraGlk widget
1521 * @func: a function to call for loading resources, or %NULL
1522 * @user_data: user data to pass to @func, or %NULL
1524 * Sometimes it is preferable to load image and sound resources from somewhere
1525 * else than a Blorb file, for example while developing a game. Section 14 of
1526 * the <ulink url="http://eblong.com/zarf/blorb/blorb.html#s14">Blorb
1527 * specification</ulink> allows for this possibility. This function sets @func
1528 * to be called when the Glk program requests loading an image or sound without
1529 * a Blorb resource map having been loaded, optionally passing @user_data as an
1532 * Note that @func is only called if no Blorb resource map has been set; having
1533 * a resource map in place overrides this function.
1535 * To deactivate the callback, call this function with @func set to %NULL.
1538 chimara_glk_set_resource_load_callback(ChimaraGlk *glk, ChimaraResourceLoadFunc func, gpointer user_data)
1540 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1541 priv->resource_load_callback = func;
1542 priv->resource_load_callback_data = user_data;