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
35 * @include: libchimara/chimara-glk.h
37 * The #ChimaraGlk widget opens and runs a Glk program. The program must be
38 * compiled as a plugin module, with a function <function>glk_main()</function>
39 * that the Glk library can hook into.
41 * On Linux systems, this is a file with a name like
42 * <filename>plugin.so</filename>. For portability, you can use libtool and
45 * pkglib_LTLIBRARIES = plugin.la
46 * plugin_la_SOURCES = plugin.c foo.c bar.c
47 * plugin_la_LDFLAGS = -module -shared -avoid-version -export-symbols-regex "^glk_main$$"
49 * This will produce <filename>plugin.la</filename> which is a text file
50 * containing the correct plugin file to open (see the relevant section of the
52 * url="http://www.gnu.org/software/libtool/manual/html_node/Finding-the-dlname.html">
53 * Libtool manual</ulink>).
55 * You need to initialize multithreading in any program you use a #ChimaraGlk
56 * widget in. This means including the following incantation at the beginning
59 * if(!g_thread_supported())
60 * g_thread_init(NULL);
63 * This initialization must take place <emphasis>before</emphasis> the call to
64 * gtk_init(). In addition to this, you must also protect your call to
65 * gtk_main() by calling gdk_threads_enter() right before it, and
66 * gdk_threads_leave() right after it.
68 * The following sample program shows how to initialize and construct a simple
69 * GTK window that runs a Glk program:
72 * #include <gtk/gtk.h>
73 * #include <libchimara/chimara-glk.h>
76 * main(int argc, char *argv[])
78 * GtkWidget *window, *glk;
79 * GError *error = NULL;
80 * gchar *plugin_argv[] = { "plugin.so", "-option" };
82 * /<!---->* Initialize threads and GTK *<!---->/
83 * if(!g_thread_supported())
84 * g_thread_init(NULL);
86 * gtk_init(&argc, &argv);
88 * /<!---->* Construct the window and its contents. We quit the GTK main loop
89 * * when the window's close button is clicked. *<!---->/
90 * window = gtk_window_new(GTK_WINDOW_TOPLEVEL);
91 * g_signal_connect(window, "delete-event", G_CALLBACK(gtk_main_quit), NULL);
92 * glk = chimara_glk_new();
93 * gtk_container_add(GTK_CONTAINER(window), glk);
94 * gtk_widget_show_all(window);
96 * /<!---->* Add a reference to the ChimaraGlk widget, since we want it to
97 * * persist after the window's delete-event -- otherwise it will be destroyed
98 * * with the window. *<!---->/
101 * /<!---->* Start the Glk program in a separate thread *<!---->/
102 * if(!chimara_glk_run(CHIMARA_GLK(glk), "./plugin.so", 2, plugin_argv, &error))
103 * g_error("Error starting Glk library: %s\n", error->message);
105 * /<!---->* Start the GTK main loop *<!---->/
106 * gdk_threads_enter();
108 * gdk_threads_leave();
110 * /<!---->* After the GTK main loop exits, signal the Glk program to shut down if
111 * * it is still running, and wait for it to exit. *<!---->/
112 * chimara_glk_stop(CHIMARA_GLK(glk));
113 * chimara_glk_wait(CHIMARA_GLK(glk));
114 * g_object_unref(glk);
121 typedef void (* glk_main_t) (void);
122 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 GTK_WIDGET_SET_FLAGS(GTK_WIDGET(self), GTK_NO_WINDOW);
155 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(self);
158 priv->interactive = TRUE;
159 priv->protect = FALSE;
160 priv->styles = g_new0(StyleSet,1);
161 priv->glk_styles = g_new0(StyleSet,1);
162 priv->pager_attr_list = pango_attr_list_new();
163 priv->final_message = g_strdup("[ The game has finished ]");
164 priv->running = FALSE;
165 priv->program = NULL;
167 priv->event_queue = g_queue_new();
168 priv->event_lock = g_mutex_new();
169 priv->event_queue_not_empty = g_cond_new();
170 priv->event_queue_not_full = g_cond_new();
171 priv->abort_lock = g_mutex_new();
172 priv->abort_signalled = FALSE;
173 priv->shutdown_lock = g_mutex_new();
174 priv->shutdown_key_pressed = g_cond_new();
175 priv->arrange_lock = g_mutex_new();
176 priv->rearranged = g_cond_new();
177 priv->needs_rearrange = FALSE;
178 priv->ignore_next_arrange_event = FALSE;
179 priv->char_input_queue = g_async_queue_new();
180 priv->line_input_queue = g_async_queue_new();
181 /* Should be g_async_queue_new_full(g_free); but only in GTK >= 2.16 */
182 priv->resource_map = NULL;
183 priv->open_external_blorb = FALSE;
184 priv->external_blorb_pathname = NULL;
185 priv->resource_lock = g_mutex_new();
186 priv->resource_loaded = g_cond_new();
187 priv->resource_info_available = g_cond_new();
188 priv->resource_load_callback = NULL;
189 priv->resource_load_callback_data = NULL;
190 priv->image_cache = NULL;
191 priv->program_name = NULL;
192 priv->program_info = NULL;
193 priv->story_name = NULL;
194 priv->interrupt_handler = NULL;
195 priv->root_window = NULL;
196 priv->fileref_list = NULL;
197 priv->current_stream = NULL;
198 priv->stream_list = NULL;
200 priv->in_startup = FALSE;
201 priv->current_dir = NULL;
207 chimara_glk_set_property(GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
209 ChimaraGlk *glk = CHIMARA_GLK(object);
213 case PROP_INTERACTIVE:
214 chimara_glk_set_interactive( glk, g_value_get_boolean(value) );
217 chimara_glk_set_protect( glk, g_value_get_boolean(value) );
220 chimara_glk_set_spacing( glk, g_value_get_uint(value) );
223 G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
228 chimara_glk_get_property(GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
230 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(object);
234 case PROP_INTERACTIVE:
235 g_value_set_boolean(value, priv->interactive);
238 g_value_set_boolean(value, priv->protect);
241 g_value_set_uint(value, priv->spacing);
243 case PROP_PROGRAM_NAME:
244 g_value_set_string(value, priv->program_name);
246 case PROP_PROGRAM_INFO:
247 g_value_set_string(value, priv->program_info);
249 case PROP_STORY_NAME:
250 g_value_set_string(value, priv->story_name);
253 G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
258 chimara_glk_finalize(GObject *object)
260 ChimaraGlk *self = CHIMARA_GLK(object);
261 CHIMARA_GLK_USE_PRIVATE(self, priv);
263 /* Free widget properties */
264 g_free(priv->final_message);
266 g_hash_table_destroy(priv->styles->text_buffer);
267 g_hash_table_destroy(priv->styles->text_grid);
268 g_hash_table_destroy(priv->glk_styles->text_buffer);
269 g_hash_table_destroy(priv->glk_styles->text_grid);
270 pango_attr_list_unref(priv->pager_attr_list);
272 /* Free the event queue */
273 g_mutex_lock(priv->event_lock);
274 g_queue_foreach(priv->event_queue, (GFunc)g_free, NULL);
275 g_queue_free(priv->event_queue);
276 g_cond_free(priv->event_queue_not_empty);
277 g_cond_free(priv->event_queue_not_full);
278 priv->event_queue = NULL;
279 g_mutex_unlock(priv->event_lock);
280 g_mutex_free(priv->event_lock);
281 /* Free the abort signaling mechanism */
282 g_mutex_lock(priv->abort_lock);
283 /* Make sure no other thread is busy with this */
284 g_mutex_unlock(priv->abort_lock);
285 g_mutex_free(priv->abort_lock);
286 priv->abort_lock = NULL;
287 /* Free the shutdown keypress signaling mechanism */
288 g_mutex_lock(priv->shutdown_lock);
289 g_cond_free(priv->shutdown_key_pressed);
290 g_mutex_unlock(priv->shutdown_lock);
291 priv->shutdown_lock = NULL;
292 /* Free the window arrangement signaling */
293 g_mutex_lock(priv->arrange_lock);
294 g_cond_free(priv->rearranged);
295 g_mutex_unlock(priv->arrange_lock);
296 g_mutex_free(priv->arrange_lock);
297 priv->arrange_lock = NULL;
298 g_mutex_lock(priv->resource_lock);
299 g_cond_free(priv->resource_loaded);
300 g_cond_free(priv->resource_info_available);
301 g_mutex_unlock(priv->resource_lock);
302 g_mutex_free(priv->resource_lock);
303 g_slist_foreach(priv->image_cache, (GFunc)clear_image_cache, NULL);
304 g_slist_free(priv->image_cache);
305 /* Unref input queues (this should destroy them since any Glk thread has stopped by now */
306 g_async_queue_unref(priv->char_input_queue);
307 g_async_queue_unref(priv->line_input_queue);
309 /* Free other stuff */
310 g_free(priv->current_dir);
311 g_free(priv->program_name);
312 g_free(priv->program_info);
313 g_free(priv->story_name);
314 g_free(priv->styles);
315 g_free(priv->glk_styles);
317 /* Chain up to parent */
318 G_OBJECT_CLASS(chimara_glk_parent_class)->finalize(object);
321 /* Internal function: Recursively get the Glk window tree's size request */
323 request_recurse(winid_t win, GtkRequisition *requisition, guint spacing)
325 if(win->type == wintype_Pair)
327 /* Get children's size requests */
328 GtkRequisition child1, child2;
329 request_recurse(win->window_node->children->data, &child1, spacing);
330 request_recurse(win->window_node->children->next->data, &child2, spacing);
332 glui32 division = win->split_method & winmethod_DivisionMask;
333 glui32 direction = win->split_method & winmethod_DirMask;
335 /* If the split is fixed, get the size of the fixed child */
336 if(division == winmethod_Fixed)
341 child1.width = win->key_window?
342 win->constraint_size * win->key_window->unit_width
345 case winmethod_Right:
346 child2.width = win->key_window?
347 win->constraint_size * win->key_window->unit_width
350 case winmethod_Above:
351 child1.height = win->key_window?
352 win->constraint_size * win->key_window->unit_height
355 case winmethod_Below:
356 child2.height = win->key_window?
357 win->constraint_size * win->key_window->unit_height
363 /* Add the children's requests */
367 case winmethod_Right:
368 requisition->width = child1.width + child2.width + spacing;
369 requisition->height = MAX(child1.height, child2.height);
371 case winmethod_Above:
372 case winmethod_Below:
373 requisition->width = MAX(child1.width, child2.width);
374 requisition->height = child1.height + child2.height + spacing;
379 /* For non-pair windows, just use the size that GTK requests */
381 gtk_widget_size_request(win->frame, requisition);
384 /* Overrides gtk_widget_size_request */
386 chimara_glk_size_request(GtkWidget *widget, GtkRequisition *requisition)
388 g_return_if_fail(widget);
389 g_return_if_fail(requisition);
390 g_return_if_fail(CHIMARA_IS_GLK(widget));
392 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(widget);
394 /* For now, just pass the size request on to the root Glk window */
395 if(priv->root_window)
397 request_recurse(priv->root_window->data, requisition, priv->spacing);
398 requisition->width += 2 * GTK_CONTAINER(widget)->border_width;
399 requisition->height += 2 * GTK_CONTAINER(widget)->border_width;
403 requisition->width = CHIMARA_GLK_MIN_WIDTH + 2 * GTK_CONTAINER(widget)->border_width;
404 requisition->height = CHIMARA_GLK_MIN_HEIGHT + 2 * GTK_CONTAINER(widget)->border_width;
408 /* Recursively give the Glk windows their allocated space. Returns a window
409 containing all children of this window that must be redrawn, or NULL if there
410 are no children that require redrawing. */
412 allocate_recurse(winid_t win, GtkAllocation *allocation, guint spacing)
414 if(win->type == wintype_Pair)
416 glui32 division = win->split_method & winmethod_DivisionMask;
417 glui32 direction = win->split_method & winmethod_DirMask;
419 /* If the space gets too small to honor the spacing property, then just
420 ignore spacing in this window and below. */
421 if( (spacing > allocation->width && (direction == winmethod_Left || direction == winmethod_Right))
422 || (spacing > allocation->height && (direction == winmethod_Above || direction == winmethod_Below)) )
425 GtkAllocation child1, child2;
426 child1.x = allocation->x;
427 child1.y = allocation->y;
429 if(division == winmethod_Fixed)
431 /* If the key window has been closed, then default to 0; otherwise
432 use the key window to determine the size */
436 child1.width = win->key_window?
437 CLAMP(win->constraint_size * win->key_window->unit_width, 0, allocation->width - spacing)
440 case winmethod_Right:
441 child2.width = win->key_window?
442 CLAMP(win->constraint_size * win->key_window->unit_width, 0, allocation->width - spacing)
445 case winmethod_Above:
446 child1.height = win->key_window?
447 CLAMP(win->constraint_size * win->key_window->unit_height, 0, allocation->height - spacing)
450 case winmethod_Below:
451 child2.height = win->key_window?
452 CLAMP(win->constraint_size * win->key_window->unit_height, 0, allocation->height - spacing)
457 else /* proportional */
459 gdouble fraction = win->constraint_size / 100.0;
463 child1.width = MAX(0, (gint)ceil(fraction * (allocation->width - spacing)) );
465 case winmethod_Right:
466 child2.width = MAX(0, (gint)ceil(fraction * (allocation->width - spacing)) );
468 case winmethod_Above:
469 child1.height = MAX(0, (gint)ceil(fraction * (allocation->height - spacing)) );
471 case winmethod_Below:
472 child2.height = MAX(0, (gint)ceil(fraction * (allocation->height - spacing)) );
477 /* Fill in the rest of the size requisitions according to the child specified above */
481 child2.width = MAX(0, allocation->width - spacing - child1.width);
482 child2.x = child1.x + child1.width + spacing;
484 child1.height = child2.height = allocation->height;
486 case winmethod_Right:
487 child1.width = MAX(0, allocation->width - spacing - child2.width);
488 child2.x = child1.x + child1.width + spacing;
490 child1.height = child2.height = allocation->height;
492 case winmethod_Above:
493 child2.height = MAX(0, allocation->height - spacing - child1.height);
495 child2.y = child1.y + child1.height + spacing;
496 child1.width = child2.width = allocation->width;
498 case winmethod_Below:
499 child1.height = MAX(0, allocation->height - spacing - child2.height);
501 child2.y = child1.y + child1.height + spacing;
502 child1.width = child2.width = allocation->width;
507 winid_t arrange1 = allocate_recurse(win->window_node->children->data, &child1, spacing);
508 winid_t arrange2 = allocate_recurse(win->window_node->children->next->data, &child2, spacing);
516 else if(win->type == wintype_TextGrid)
518 /* Pass the size allocation on to the framing widget */
519 gtk_widget_size_allocate(win->frame, allocation);
520 /* It says in the spec that when a text grid window is resized smaller,
521 the bottom or right area is thrown away; when it is resized larger, the
522 bottom or right area is filled with blanks. */
523 glui32 newwidth = (glui32)(win->widget->allocation.width / win->unit_width);
524 glui32 newheight = (glui32)(win->widget->allocation.height / win->unit_height);
526 GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
527 GtkTextIter start, end;
529 for(line = 0; line < win->height; line++)
531 gtk_text_buffer_get_iter_at_line(textbuffer, &start, line);
532 /* If this line is going to fall off the bottom, delete it */
533 if(line >= newheight)
536 gtk_text_iter_forward_to_line_end(&end);
537 gtk_text_iter_forward_char(&end);
538 gtk_text_buffer_delete(textbuffer, &start, &end);
541 /* If this line is not long enough, add spaces on the end */
542 if(newwidth > win->width)
544 gchar *spaces = g_strnfill(newwidth - win->width, ' ');
545 gtk_text_iter_forward_to_line_end(&start);
546 gtk_text_buffer_insert(textbuffer, &start, spaces, -1);
549 /* But if it's too long, delete characters from the end */
550 else if(newwidth < win->width)
553 gtk_text_iter_forward_chars(&start, newwidth);
554 gtk_text_iter_forward_to_line_end(&end);
555 gtk_text_buffer_delete(textbuffer, &start, &end);
557 /* Note: if the widths are equal, do nothing */
559 /* Add blank lines if there aren't enough lines to fit the new size */
560 if(newheight > win->height)
562 gchar *blanks = g_strnfill(win->width, ' ');
563 gchar **blanklines = g_new0(gchar *, (newheight - win->height) + 1);
565 for(count = 0; count < newheight - win->height; count++)
566 blanklines[count] = blanks;
567 blanklines[newheight - win->height] = NULL;
568 gchar *text = g_strjoinv("\n", blanklines);
569 g_free(blanklines); /* not g_strfreev() */
572 gtk_text_buffer_get_end_iter(textbuffer, &start);
573 gtk_text_buffer_insert(textbuffer, &start, "\n", -1);
574 gtk_text_buffer_insert(textbuffer, &start, text, -1);
578 gboolean arrange = !(win->width == newwidth && win->height == newheight);
579 win->width = newwidth;
580 win->height = newheight;
581 return arrange? win : NULL;
584 /* For non-pair, non-text-grid windows, just give them the size */
585 gtk_widget_size_allocate(win->frame, allocation);
589 /* Overrides gtk_widget_size_allocate */
591 chimara_glk_size_allocate(GtkWidget *widget, GtkAllocation *allocation)
593 g_return_if_fail(widget);
594 g_return_if_fail(allocation);
595 g_return_if_fail(CHIMARA_IS_GLK(widget));
597 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(widget);
599 widget->allocation = *allocation;
601 if(priv->root_window) {
603 child.x = allocation->x + GTK_CONTAINER(widget)->border_width;
604 child.y = allocation->y + GTK_CONTAINER(widget)->border_width;
605 child.width = CLAMP(allocation->width - 2 * GTK_CONTAINER(widget)->border_width, 0, allocation->width);
606 child.height = CLAMP(allocation->height - 2 * GTK_CONTAINER(widget)->border_width, 0, allocation->height);
607 winid_t arrange = allocate_recurse(priv->root_window->data, &child, priv->spacing);
609 /* arrange points to a window that contains all text grid and graphics
610 windows which have been resized */
611 g_mutex_lock(priv->arrange_lock);
612 if(!priv->ignore_next_arrange_event)
615 event_throw(CHIMARA_GLK(widget), evtype_Arrange, arrange == priv->root_window->data? NULL : arrange, 0, 0);
618 priv->ignore_next_arrange_event = FALSE;
619 priv->needs_rearrange = FALSE;
620 g_cond_signal(priv->rearranged);
621 g_mutex_unlock(priv->arrange_lock);
625 /* Recursively invoke callback() on the GtkWidget of each non-pair window in the tree */
627 forall_recurse(winid_t win, GtkCallback callback, gpointer callback_data)
629 if(win->type == wintype_Pair)
631 forall_recurse(win->window_node->children->data, callback, callback_data);
632 forall_recurse(win->window_node->children->next->data, callback, callback_data);
635 (*callback)(win->frame, callback_data);
638 /* Overrides gtk_container_forall */
640 chimara_glk_forall(GtkContainer *container, gboolean include_internals, GtkCallback callback, gpointer callback_data)
642 g_return_if_fail(container);
643 g_return_if_fail(CHIMARA_IS_GLK(container));
645 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(container);
647 /* All the children are "internal" */
648 if(!include_internals)
651 if(priv->root_window)
652 forall_recurse(priv->root_window->data, callback, callback_data);
656 chimara_glk_stopped(ChimaraGlk *self)
658 CHIMARA_GLK_USE_PRIVATE(self, priv);
659 priv->running = FALSE;
660 priv->program_name = NULL;
661 g_object_notify(G_OBJECT(self), "program-name");
662 priv->program_info = NULL;
663 g_object_notify(G_OBJECT(self), "program-info");
664 priv->story_name = NULL;
665 g_object_notify(G_OBJECT(self), "story-name");
669 chimara_glk_started(ChimaraGlk *self)
671 CHIMARA_GLK_USE_PRIVATE(self, priv);
672 priv->running = TRUE;
676 chimara_glk_waiting(ChimaraGlk *self)
678 /* Default signal handler */
682 chimara_glk_char_input(ChimaraGlk *self, guint window_rock, guint keysym)
684 /* Default signal handler */
688 chimara_glk_line_input(ChimaraGlk *self, guint window_rock, gchar *text)
690 /* Default signal handler */
694 chimara_glk_text_buffer_output(ChimaraGlk *self, guint window_rock, gchar *text)
696 /* Default signal handler */
700 chimara_glk_iliad_screen_update(ChimaraGlk *self, gboolean typing)
702 /* Default signal handler */
705 /* COMPAT: G_PARAM_STATIC_STRINGS only appeared in GTK 2.13.0 */
706 #ifndef G_PARAM_STATIC_STRINGS
708 /* COMPAT: G_PARAM_STATIC_NAME and friends only appeared in GTK 2.8 */
709 #if GTK_CHECK_VERSION(2,8,0)
710 #define G_PARAM_STATIC_STRINGS (G_PARAM_STATIC_NAME | G_PARAM_STATIC_NICK | G_PARAM_STATIC_BLURB)
712 #define G_PARAM_STATIC_STRINGS (0)
718 chimara_glk_class_init(ChimaraGlkClass *klass)
720 /* Override methods of parent classes */
721 GObjectClass *object_class = G_OBJECT_CLASS(klass);
722 object_class->set_property = chimara_glk_set_property;
723 object_class->get_property = chimara_glk_get_property;
724 object_class->finalize = chimara_glk_finalize;
726 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS(klass);
727 widget_class->size_request = chimara_glk_size_request;
728 widget_class->size_allocate = chimara_glk_size_allocate;
730 GtkContainerClass *container_class = GTK_CONTAINER_CLASS(klass);
731 container_class->forall = chimara_glk_forall;
734 klass->stopped = chimara_glk_stopped;
735 klass->started = chimara_glk_started;
736 klass->waiting = chimara_glk_waiting;
737 klass->char_input = chimara_glk_char_input;
738 klass->line_input = chimara_glk_line_input;
739 klass->text_buffer_output = chimara_glk_text_buffer_output;
740 klass->iliad_screen_update = chimara_glk_iliad_screen_update;
743 * ChimaraGlk::stopped:
744 * @glk: The widget that received the signal
746 * Emitted when the a Glk program finishes executing in the widget, whether
747 * it ended normally, or was interrupted.
749 chimara_glk_signals[STOPPED] = g_signal_new("stopped",
750 G_OBJECT_CLASS_TYPE(klass), G_SIGNAL_RUN_FIRST,
751 /* FIXME: Should be G_SIGNAL_RUN_CLEANUP but that segfaults??! */
752 G_STRUCT_OFFSET(ChimaraGlkClass, stopped), NULL, NULL,
753 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
755 * ChimaraGlk::started:
756 * @glk: The widget that received the signal
758 * Emitted when a Glk program starts executing in the widget.
760 chimara_glk_signals[STARTED] = g_signal_new ("started",
761 G_OBJECT_CLASS_TYPE(klass), G_SIGNAL_RUN_FIRST,
762 G_STRUCT_OFFSET(ChimaraGlkClass, started), NULL, NULL,
763 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
765 * ChimaraGlk::waiting:
766 * @glk: The widget that received the signal
768 * Emitted when glk_select() is called by the Glk program and the event
769 * queue is empty, which means that the widget is waiting for input.
771 chimara_glk_signals[WAITING] = g_signal_new("waiting",
772 G_OBJECT_CLASS_TYPE(klass), 0,
773 G_STRUCT_OFFSET(ChimaraGlkClass, waiting), NULL, NULL,
774 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
776 * ChimaraGlk::char-input:
777 * @glk: The widget that received the signal
778 * @window_rock: The rock value of the window that received character input
779 * (see <link linkend="chimara-Rocks">Rocks</link>)
780 * @keysym: The key that was typed, in the form of a key symbol from
781 * <filename class="headerfile">gdk/gdkkeysyms.h</filename>
783 * Emitted when a Glk window receives character input.
785 chimara_glk_signals[CHAR_INPUT] = g_signal_new("char-input",
786 G_OBJECT_CLASS_TYPE(klass), 0,
787 G_STRUCT_OFFSET(ChimaraGlkClass, char_input), NULL, NULL,
788 _chimara_marshal_VOID__UINT_UINT,
789 G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_UINT);
791 * ChimaraGlk::line-input:
792 * @glk: The widget that received the signal
793 * @window_rock: The rock value of the window that received line input (see
794 * <link linkend="chimara-Rocks">Rocks</link>)
795 * @text: The text that was typed
797 * Emitted when a Glk window receives line input.
799 chimara_glk_signals[LINE_INPUT] = g_signal_new("line-input",
800 G_OBJECT_CLASS_TYPE(klass), 0,
801 G_STRUCT_OFFSET(ChimaraGlkClass, line_input), NULL, NULL,
802 _chimara_marshal_VOID__UINT_STRING,
803 G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_STRING);
805 * ChimaraGlk::text-buffer-output:
806 * @glk: The widget that received the signal
807 * @window_rock: The rock value of the window that was printed to (see <link
808 * linkend="chimara-Rocks">Rocks</link>)
810 * Emitted when text is printed to a text buffer window.
812 chimara_glk_signals[TEXT_BUFFER_OUTPUT] = g_signal_new("text-buffer-output",
813 G_OBJECT_CLASS_TYPE(klass), 0,
814 G_STRUCT_OFFSET(ChimaraGlkClass, text_buffer_output), NULL, NULL,
815 _chimara_marshal_VOID__UINT_STRING,
816 G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_STRING);
818 * ChimaraGlk::iliad-update-screen:
819 * @self: The widget that received the signal
820 * @typing: Whether to perform a typing or full screen update
822 * Iliad specific signal which is emitted whenever the screen needs to be updated.
823 * Since iliad screen updates are very slow, updating should only be done when
826 chimara_glk_signals[ILIAD_SCREEN_UPDATE] = g_signal_new("iliad-screen-update",
827 G_OBJECT_CLASS_TYPE(klass), 0,
828 G_STRUCT_OFFSET(ChimaraGlkClass, iliad_screen_update), NULL, NULL,
829 _chimara_marshal_VOID__BOOLEAN,
830 G_TYPE_NONE, 1, G_TYPE_BOOLEAN);
834 * ChimaraGlk:interactive:
836 * Sets whether the widget is interactive. A Glk widget is normally
837 * interactive, but in non-interactive mode, keyboard and mouse input are
838 * ignored and the Glk program is controlled by
839 * chimara_glk_feed_char_input() and chimara_glk_feed_line_input().
840 * <quote>More</quote> prompts when a lot of text is printed to a text
841 * buffer are also disabled. This is typically used when you wish to control
842 * an interpreter program by feeding it a predefined list of commands.
844 g_object_class_install_property( object_class, PROP_INTERACTIVE,
845 g_param_spec_boolean("interactive", _("Interactive"),
846 _("Whether user input is expected in the Glk program"),
848 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
851 * ChimaraGlk:protect:
853 * Sets whether the Glk program is allowed to do file operations. In protect
854 * mode, all file operations will fail.
856 g_object_class_install_property(object_class, PROP_PROTECT,
857 g_param_spec_boolean("protect", _("Protected"),
858 _("Whether the Glk program is barred from doing file operations"),
860 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
863 * ChimaraGlk:spacing:
865 * The amount of space between the Glk windows.
867 g_object_class_install_property(object_class, PROP_SPACING,
868 g_param_spec_uint("spacing", _("Spacing"),
869 _("The amount of space between Glk windows"),
871 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
874 * ChimaraGlk:program-name:
876 * The name of the currently running Glk program. You cannot set this
877 * property yourself. It is set to the filename of the plugin when you call
878 * chimara_glk_run(), but the plugin can change it by calling
879 * garglk_set_program_name(). To find out when this information changes,
880 * for example to put the program name in the title bar of a window, connect
881 * to the <code>::notify::program-name</code> signal.
883 g_object_class_install_property(object_class, PROP_PROGRAM_NAME,
884 g_param_spec_string("program-name", _("Program name"),
885 _("Name of the currently running program"),
887 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
890 * ChimaraGlk:program-info:
892 * Information about the currently running Glk program. You cannot set this
893 * property yourself. The plugin can change it by calling
894 * garglk_set_program_info(). See also #ChimaraGlk:program-name.
896 g_object_class_install_property(object_class, PROP_PROGRAM_INFO,
897 g_param_spec_string("program-info", _("Program info"),
898 _("Information about the currently running program"),
900 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
903 * ChimaraGlk:story-name:
905 * The name of the story currently running in the Glk interpreter. You
906 * cannot set this property yourself. It is set to the story filename when
907 * you call chimara_if_run_game(), but the plugin can change it by calling
908 * garglk_set_story_name().
910 * Strictly speaking, this should be a property of #ChimaraIF, but it is
911 * legal for any Glk program to call garglk_set_story_name(), even if it is
912 * not an interpreter and does not load story files.
914 g_object_class_install_property(object_class, PROP_STORY_NAME,
915 g_param_spec_string("story-name", _("Story name"),
916 _("Name of the story currently loaded in the interpreter"),
918 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
921 g_type_class_add_private(klass, sizeof(ChimaraGlkPrivate));
924 /* PUBLIC FUNCTIONS */
927 * chimara_error_quark:
929 * The error domain for errors from Chimara widgets.
931 * Returns: The string <quote>chimara-error-quark</quote> as a <link
932 * linkend="GQuark">GQuark</link>.
935 chimara_error_quark(void)
937 chimara_init(); /* This is a library entry point */
938 return g_quark_from_static_string("chimara-error-quark");
944 * Creates and initializes a new #ChimaraGlk widget.
946 * Return value: a #ChimaraGlk widget, with a floating reference.
949 chimara_glk_new(void)
951 /* This is a library entry point; initialize the library */
954 return GTK_WIDGET(g_object_new(CHIMARA_TYPE_GLK, NULL));
958 * chimara_glk_set_interactive:
959 * @glk: a #ChimaraGlk widget
960 * @interactive: whether the widget should expect user input
962 * Sets the #ChimaraGlk:interactive property of @glk.
965 chimara_glk_set_interactive(ChimaraGlk *glk, gboolean interactive)
967 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
969 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
970 priv->interactive = interactive;
971 g_object_notify(G_OBJECT(glk), "interactive");
975 * chimara_glk_get_interactive:
976 * @glk: a #ChimaraGlk widget
978 * Returns whether @glk is interactive (expecting user input). See
979 * #ChimaraGlk:interactive.
981 * Return value: %TRUE if @glk is interactive.
984 chimara_glk_get_interactive(ChimaraGlk *glk)
986 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
988 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
989 return priv->interactive;
993 * chimara_glk_set_protect:
994 * @glk: a #ChimaraGlk widget
995 * @protect: whether the widget should allow the Glk program to do file
998 * Sets the #ChimaraGlk:protect property of @glk. In protect mode, the Glk
999 * program is not allowed to do file operations.
1002 chimara_glk_set_protect(ChimaraGlk *glk, gboolean protect)
1004 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1006 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1007 priv->protect = protect;
1008 g_object_notify(G_OBJECT(glk), "protect");
1012 * chimara_glk_get_protect:
1013 * @glk: a #ChimaraGlk widget
1015 * Returns whether @glk is in protect mode (banned from doing file operations).
1016 * See #ChimaraGlk:protect.
1018 * Return value: %TRUE if @glk is in protect mode.
1021 chimara_glk_get_protect(ChimaraGlk *glk)
1023 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1025 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1026 return priv->protect;
1030 * chimara_glk_set_css_to_default:
1031 * @glk: a #ChimaraGlk widget
1033 * Resets the styles for text buffer and text grid windows to their defaults.
1035 * This function is not implemented yet.
1039 chimara_glk_set_css_to_default(ChimaraGlk *glk)
1041 reset_default_styles(glk);
1045 * chimara_glk_set_css_from_file:
1046 * @glk: a #ChimaraGlk widget
1047 * @filename: path to a CSS file, or %NULL
1048 * @error: location to store a <link
1049 * linkend="glib-Error-Reporting">GError</link>, or %NULL
1051 * Sets the styles for text buffer and text grid windows according to the CSS
1052 * file @filename. Note that the styles are set cumulatively on top of whatever
1053 * the styles are at the time this function is called; to reset the styles to
1054 * their defaults, use chimara_glk_set_css_to_default().
1056 * Returns: %TRUE on success, %FALSE if an error occurred, in which case @error
1060 chimara_glk_set_css_from_file(ChimaraGlk *glk, const gchar *filename, GError **error)
1062 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1063 g_return_val_if_fail(filename, FALSE);
1064 g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
1066 int fd = open(filename, O_RDONLY);
1068 *error = g_error_new(G_IO_ERROR, g_io_error_from_errno(errno),
1069 _("Error opening file \"%s\": %s"), filename, g_strerror(errno));
1073 GScanner *scanner = create_css_file_scanner();
1074 g_scanner_input_file(scanner, fd);
1075 scanner->input_name = filename;
1076 scan_css_file(scanner, glk);
1078 if(close(fd) == -1) {
1079 *error = g_error_new(G_IO_ERROR, g_io_error_from_errno(errno),
1080 _("Error closing file \"%s\": %s"), filename, g_strerror(errno));
1087 * chimara_glk_set_css_from_string:
1088 * @glk: a #ChimaraGlk widget
1089 * @css: a string containing CSS code
1091 * Sets the styles for text buffer and text grid windows according to the CSS
1092 * code @css. Note that the styles are set cumulatively on top of whatever the
1093 * styles are at the time this function is called; to reset the styles to their
1094 * defaults, use chimara_glk_set_css_to_default().
1097 chimara_glk_set_css_from_string(ChimaraGlk *glk, const gchar *css)
1099 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1100 g_return_if_fail(css || *css);
1102 GScanner *scanner = create_css_file_scanner();
1103 g_scanner_input_text(scanner, css, strlen(css));
1104 scanner->input_name = "<string>";
1105 scan_css_file(scanner, glk);
1109 * chimara_glk_set_spacing:
1110 * @glk: a #ChimaraGlk widget
1111 * @spacing: the number of pixels to put between Glk windows
1113 * Sets the #ChimaraGlk:spacing property of @glk, which is the border width in
1114 * pixels between Glk windows.
1117 chimara_glk_set_spacing(ChimaraGlk *glk, guint spacing)
1119 g_return_if_fail( glk || CHIMARA_IS_GLK(glk) );
1121 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1122 priv->spacing = spacing;
1123 g_object_notify(G_OBJECT(glk), "spacing");
1127 * chimara_glk_get_spacing:
1128 * @glk: a #ChimaraGlk widget
1130 * Gets the value set by chimara_glk_set_spacing().
1132 * Return value: pixels of spacing between Glk windows
1135 chimara_glk_get_spacing(ChimaraGlk *glk)
1137 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), 0);
1139 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1140 return priv->spacing;
1143 struct StartupData {
1144 glk_main_t glk_main;
1145 glkunix_startup_code_t glkunix_startup_code;
1146 glkunix_startup_t args;
1147 ChimaraGlkPrivate *glk_data;
1150 /* glk_enter() is the actual function called in the new thread in which glk_main() runs. */
1152 glk_enter(struct StartupData *startup)
1154 extern GPrivate *glk_data_key;
1155 g_private_set(glk_data_key, startup->glk_data);
1157 /* Acquire the Glk thread's references to the input queues */
1158 g_async_queue_ref(startup->glk_data->char_input_queue);
1159 g_async_queue_ref(startup->glk_data->line_input_queue);
1161 /* Run startup function */
1162 if(startup->glkunix_startup_code) {
1163 startup->glk_data->in_startup = TRUE;
1164 int result = startup->glkunix_startup_code(&startup->args);
1165 startup->glk_data->in_startup = FALSE;
1168 while(i < startup->args.argc)
1169 g_free(startup->args.argv[i++]);
1170 g_free(startup->args.argv);
1176 /* Open external Blorb file if specified */
1177 if(startup->glk_data->open_external_blorb) {
1178 glkunix_set_base_file(startup->glk_data->external_blorb_pathname);
1179 gchar *basename = g_path_get_basename(startup->glk_data->external_blorb_pathname);
1180 frefid_t blorbref = glk_fileref_create_by_name(fileusage_BinaryMode | fileusage_Data, basename, 0);
1182 strid_t blorbfile = glk_stream_open_file(blorbref, filemode_Read, 0);
1183 giblorb_set_resource_map(blorbfile);
1184 glk_fileref_destroy(blorbref);
1185 g_printerr("Opening external blorb file\n");
1188 /* Run main function */
1189 glk_main_t glk_main = startup->glk_main;
1191 /* COMPAT: avoid usage of slices */
1193 g_signal_emit_by_name(startup->glk_data->self, "started");
1195 glk_exit(); /* Run shutdown code in glk_exit() even if glk_main() returns normally */
1196 g_assert_not_reached(); /* because glk_exit() calls g_thread_exit() */
1202 * @glk: a #ChimaraGlk widget
1203 * @plugin: path to a plugin module compiled with <filename
1204 * class="header">glk.h</filename>
1205 * @argc: Number of command line arguments in @argv
1206 * @argv: Array of command line arguments to pass to the plugin
1207 * @error: location to store a <link
1208 * linkend="glib-Error-Reporting">GError</link>, or %NULL
1210 * Opens a Glk program compiled as a plugin. Sorts out its command line
1211 * arguments from #glkunix_arguments, calls its startup function
1212 * glkunix_startup_code(), and then calls its main function glk_main() in
1213 * a separate thread. On failure, returns %FALSE and sets @error.
1215 * The plugin must at least export a glk_main() function; #glkunix_arguments and
1216 * glkunix_startup_code() are optional.
1218 * Return value: %TRUE if the Glk program was started successfully.
1221 chimara_glk_run(ChimaraGlk *glk, const gchar *plugin, int argc, char *argv[], GError **error)
1223 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1224 g_return_val_if_fail(plugin, FALSE);
1225 g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
1227 if(chimara_glk_get_running(glk)) {
1228 g_set_error(error, CHIMARA_ERROR, CHIMARA_PLUGIN_ALREADY_RUNNING, _("There was already a plugin running."));
1232 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1234 /* COMPAT: avoid usage of slices */
1235 struct StartupData *startup = g_new0(struct StartupData,1);
1237 g_assert( g_module_supported() );
1238 /* If there is already a module loaded, free it first -- you see, we want to
1239 * keep modules loaded as long as possible to avoid crashes in stack unwinding */
1240 if( priv->program && !g_module_close(priv->program) )
1241 g_warning( "Error closing module :%s", g_module_error() );
1242 /* Open the module to run */
1243 priv->program = g_module_open(plugin, G_MODULE_BIND_LAZY);
1247 g_set_error(error, CHIMARA_ERROR, CHIMARA_LOAD_MODULE_ERROR, _("Error opening module: %s"), g_module_error());
1250 if( !g_module_symbol(priv->program, "glk_main", (gpointer *) &startup->glk_main) )
1252 g_set_error(error, CHIMARA_ERROR, CHIMARA_NO_GLK_MAIN, _("Error finding glk_main(): %s"), g_module_error());
1256 if( g_module_symbol(priv->program, "glkunix_startup_code", (gpointer *) &startup->glkunix_startup_code) )
1258 glkunix_argumentlist_t *glkunix_arguments;
1260 if( !(g_module_symbol(priv->program, "glkunix_arguments", (gpointer *) &glkunix_arguments)
1261 && parse_command_line(glkunix_arguments, argc, argv, &startup->args)) )
1263 /* arguments could not be parsed, so create data ourselves */
1264 startup->args.argc = 1;
1265 startup->args.argv = g_new0(gchar *, 1);
1268 /* Set the program invocation name */
1269 startup->args.argv[0] = g_strdup(plugin);
1271 startup->glk_data = priv;
1273 /* Set the program name */
1274 priv->program_name = g_path_get_basename(plugin);
1275 g_object_notify(G_OBJECT(glk), "program-name");
1277 /* Run in a separate thread */
1278 priv->thread = g_thread_create((GThreadFunc)glk_enter, startup, TRUE, error);
1280 return !(priv->thread == NULL);
1285 * @glk: a #ChimaraGlk widget
1287 * Signals the Glk program running in @glk to abort. Note that if the program is
1288 * caught in an infinite loop in which glk_tick() is not called, this may not
1292 chimara_glk_stop(ChimaraGlk *glk)
1294 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1295 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1297 /* Don't do anything if not running a program */
1301 if(priv->abort_lock) {
1302 g_mutex_lock(priv->abort_lock);
1303 priv->abort_signalled = TRUE;
1304 g_mutex_unlock(priv->abort_lock);
1305 /* Stop blocking on the event queue condition */
1306 event_throw(glk, evtype_Abort, NULL, 0, 0);
1307 /* Stop blocking on the shutdown key press condition */
1308 g_mutex_lock(priv->shutdown_lock);
1309 g_cond_signal(priv->shutdown_key_pressed);
1310 g_mutex_unlock(priv->shutdown_lock);
1316 * @glk: a #ChimaraGlk widget
1318 * Holds up the main thread and waits for the Glk program running in @glk to
1322 chimara_glk_wait(ChimaraGlk *glk)
1324 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1325 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1326 /* Don't do anything if not running a program */
1329 /* Unlock GDK mutex, because the Glk program might need to use it for shutdown */
1330 gdk_threads_leave();
1331 g_thread_join(priv->thread);
1332 gdk_threads_enter();
1336 * chimara_glk_get_running:
1337 * @glk: a #ChimaraGlk widget
1339 * Use this function to tell whether a program is currently running in the
1342 * Returns: %TRUE if @glk is executing a Glk program, %FALSE otherwise.
1345 chimara_glk_get_running(ChimaraGlk *glk)
1347 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1348 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1349 return priv->running;
1353 * chimara_glk_feed_char_input:
1354 * @glk: a #ChimaraGlk widget
1355 * @keyval: a key symbol as defined in <filename
1356 * class="headerfile">gdk/gdkkeysyms.h</filename>
1358 * Pretend that a key was pressed in the Glk program as a response to a
1359 * character input request. You can call this function even when no window has
1360 * requested character input, in which case the key will be saved for the
1361 * following window that requests character input. This has the disadvantage
1362 * that if more than one window has requested character input, it is arbitrary
1363 * which one gets the key press.
1366 chimara_glk_feed_char_input(ChimaraGlk *glk, guint keyval)
1368 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1369 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1370 g_async_queue_push(priv->char_input_queue, GUINT_TO_POINTER(keyval));
1371 event_throw(glk, evtype_ForcedCharInput, NULL, 0, 0);
1375 * chimara_glk_feed_line_input:
1376 * @glk: a #ChimaraGlk widget
1377 * @text: text to pass to the next line input request
1379 * Pretend that @text was typed in the Glk program as a response to a line input
1380 * request. @text does not need to end with a newline. You can call this
1381 * function even when no window has requested line input, in which case the text
1382 * will be saved for the following window that requests line input. This has the
1383 * disadvantage that if more than one window has requested line input, it is
1384 * arbitrary which one gets the text.
1387 chimara_glk_feed_line_input(ChimaraGlk *glk, const gchar *text)
1389 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1390 g_return_if_fail(text);
1391 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1392 g_async_queue_push(priv->line_input_queue, g_strdup(text));
1393 event_throw(glk, evtype_ForcedLineInput, NULL, 0, 0);
1397 * chimara_glk_is_char_input_pending:
1398 * @glk: a #ChimaraGlk widget
1400 * Use this function to tell if character input forced by
1401 * chimara_glk_feed_char_input() has been passed to an input request or not.
1403 * Returns: %TRUE if forced character input is pending, %FALSE otherwise.
1406 chimara_glk_is_char_input_pending(ChimaraGlk *glk)
1408 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1409 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1410 return g_async_queue_length(priv->char_input_queue) > 0;
1414 * chimara_glk_is_line_input_pending:
1415 * @glk: a #ChimaraGlk widget
1417 * Use this function to tell if line input forced by
1418 * chimara_glk_feed_line_input() has been passed to an input request or not.
1420 * Returns: %TRUE if forced line input is pending, %FALSE otherwise.
1423 chimara_glk_is_line_input_pending(ChimaraGlk *glk)
1425 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1426 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1427 return g_async_queue_length(priv->line_input_queue) > 0;
1431 * chimara_glk_get_tag:
1432 * @glk: a #ChimarGlk widget
1433 * @window: The type of window to retrieve the tag for
1434 * @name: The name of the tag to retrieve
1436 * Use this function to get a #GtkTextTag so style properties can be changed.
1437 * See also #chimara_glk_set_css_from_string.
1439 * The layout of the text in Chimara is controlled by two sets of tags: one set
1440 * describing the style in text buffers and one for text grids. See also the
1441 * GLK specification for the difference between the two. The main narrative of
1442 * a game is usually rendered in text buffers, whereas text grids are mostly
1443 * used for status bars and in game menus.
1445 * The following tag names are supported:
1447 * <listitem><para>normal</para></listitem>
1448 * <listitem><para>emphasized</para></listitem>
1449 * <listitem><para>preformatted</para></listitem>
1450 * <listitem><para>header</para></listitem>
1451 * <listitem><para>subheader</para></listitem>
1452 * <listitem><para>alert</para></listitem>
1453 * <listitem><para>note</para></listitem>
1454 * <listitem><para>block-quote</para></listitem>
1455 * <listitem><para>input</para></listitem>
1456 * <listitem><para>user1</para></listitem>
1457 * <listitem><para>user2</para></listitem>
1458 * <listitem><para>hyperlink</para></listitem>
1459 * <listitem><para>pager</para></listitem>
1463 chimara_glk_get_tag(ChimaraGlk *glk, ChimaraGlkWindowType window, const gchar *name)
1465 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1468 case CHIMARA_GLK_TEXT_BUFFER:
1469 return GTK_TEXT_TAG( g_hash_table_lookup(priv->styles->text_buffer, name) );
1471 case CHIMARA_GLK_TEXT_GRID:
1472 return GTK_TEXT_TAG( g_hash_table_lookup(priv->styles->text_grid, name) );
1475 ILLEGAL_PARAM("Unknown window type: %u", window);
1481 * chimara_glk_get_tag:
1482 * @glk: a #ChimarGlk widget
1484 * Retrieves the possible tag names to use in #chimara_glk_get_tag.
1487 chimara_glk_get_tag_names(ChimaraGlk *glk)
1489 return style_get_tag_names();
1493 * chimara_glk_get_num_tag_names:
1494 * @glk: a #ChimaraGlk widget
1496 * Retrieves the number of style tags returned by #chimara_glk_get_tag_names.
1499 chimara_glk_get_num_tag_names(ChimaraGlk *glk)
1501 return CHIMARA_NUM_STYLES;
1505 * chimara_glk_update_style:
1506 * @glk: a #ChimaraGlk widget
1508 * Processes style updates and updates the widget to reflect the new style.
1509 * Call this every time you change a property of a #GtkTextTag retrieved by
1510 * #chimara_glk_get_tag.
1513 chimara_glk_update_style(ChimaraGlk *glk)
1515 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1518 /* Schedule a redraw */
1519 g_mutex_lock(priv->arrange_lock);
1520 priv->needs_rearrange = TRUE;
1521 priv->ignore_next_arrange_event = TRUE;
1522 g_mutex_unlock(priv->arrange_lock);
1523 gtk_widget_queue_resize( GTK_WIDGET(priv->self) );
1527 * chimara_glk_set_resource_load_callback:
1528 * @glk: a #ChimaraGlk widget
1529 * @func: a function to call for loading resources, or %NULL
1530 * @user_data: user data to pass to @func, or %NULL
1532 * Sometimes it is preferable to load image and sound resources from somewhere
1533 * else than a Blorb file, for example while developing a game. Section 14 of
1534 * the <ulink url="http://eblong.com/zarf/blorb/blorb.html#s14">Blorb
1535 * specification</ulink> allows for this possibility. This function sets @func
1536 * to be called when the Glk program requests loading an image or sound without
1537 * a Blorb resource map having been loaded, optionally passing @user_data as an
1540 * Note that @func is only called if no Blorb resource map has been set; having
1541 * a resource map in place overrides this function.
1543 * To deactivate the callback, call this function with @func set to %NULL.
1546 chimara_glk_set_resource_load_callback(ChimaraGlk *glk, ChimaraResourceLoadFunc func, gpointer user_data)
1548 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1549 priv->resource_load_callback = func;
1550 priv->resource_load_callback_data = user_data;