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
31 /* Substitute functions for compiling on iLiad */
33 #if !GTK_CHECK_VERSION(2, 18, 0)
34 #define gtk_widget_get_allocation(w, a) \
36 (a)->x = (w)->allocation.x; \
37 (a)->y = (w)->allocation.y; \
38 (a)->width = (w)->allocation.width; \
39 (a)->height = (w)->allocation.height; \
41 #define gtk_widget_set_allocation(w, a) \
42 G_STMT_START { (w)->allocation = *(a); } G_STMT_END
43 #define gtk_widget_set_has_window(w, f) \
46 GTK_WIDGET_UNSET_FLAGS((w), GTK_NO_WINDOW); \
48 GTK_WIDGET_SET_FLAGS((w), GTK_NO_WINDOW); \
54 * @short_description: Widget which executes a Glk program
55 * @stability: Unstable
57 * The #ChimaraGlk widget opens and runs a Glk program. The program must be
58 * compiled as a plugin module, with a function <function>glk_main()</function>
59 * that the Glk library can hook into.
61 * On Linux systems, this is a file with a name like
62 * <filename>plugin.so</filename>. For portability, you can use libtool and
65 * pkglib_LTLIBRARIES = plugin.la
66 * plugin_la_SOURCES = plugin.c foo.c bar.c
67 * plugin_la_LDFLAGS = -module -shared -avoid-version -export-symbols-regex "^glk_main$$"
69 * This will produce <filename>plugin.la</filename> which is a text file
70 * containing the correct plugin file to open (see the relevant section of the
72 * url="http://www.gnu.org/software/libtool/manual/html_node/Finding-the-dlname.html">
73 * Libtool manual</ulink>).
75 * You need to initialize multithreading in any program you use a #ChimaraGlk
76 * widget in. This means including the following incantation at the beginning
79 * if(!g_thread_supported())
80 * g_thread_init(NULL);
83 * This initialization must take place <emphasis>before</emphasis> the call to
84 * gtk_init(). In addition to this, you must also protect your call to
85 * gtk_main() by calling gdk_threads_enter() right before it, and
86 * gdk_threads_leave() right after it.
88 * The following sample program shows how to initialize and construct a simple
89 * GTK window that runs a Glk program:
92 * #include <gtk/gtk.h>
93 * #include <libchimara/chimara-glk.h>
96 * main(int argc, char *argv[])
98 * GtkWidget *window, *glk;
99 * GError *error = NULL;
100 * gchar *plugin_argv[] = { "plugin.so", "-option" };
102 * /<!---->* Initialize threads and GTK *<!---->/
103 * if(!g_thread_supported())
104 * g_thread_init(NULL);
105 * gdk_threads_init();
106 * gtk_init(&argc, &argv);
108 * /<!---->* Construct the window and its contents. We quit the GTK main loop
109 * * when the window's close button is clicked. *<!---->/
110 * window = gtk_window_new(GTK_WINDOW_TOPLEVEL);
111 * g_signal_connect(window, "delete-event", G_CALLBACK(gtk_main_quit), NULL);
112 * glk = chimara_glk_new();
113 * gtk_container_add(GTK_CONTAINER(window), glk);
114 * gtk_widget_show_all(window);
116 * /<!---->* Add a reference to the ChimaraGlk widget, since we want it to
117 * * persist after the window's delete-event -- otherwise it will be destroyed
118 * * with the window. *<!---->/
121 * /<!---->* Start the Glk program in a separate thread *<!---->/
122 * if(!chimara_glk_run(CHIMARA_GLK(glk), "./plugin.so", 2, plugin_argv, &error))
123 * g_error("Error starting Glk library: %s\n", error->message);
125 * /<!---->* Start the GTK main loop *<!---->/
126 * gdk_threads_enter();
128 * gdk_threads_leave();
130 * /<!---->* After the GTK main loop exits, signal the Glk program to shut down if
131 * * it is still running, and wait for it to exit. *<!---->/
132 * chimara_glk_stop(CHIMARA_GLK(glk));
133 * chimara_glk_wait(CHIMARA_GLK(glk));
134 * g_object_unref(glk);
141 typedef void (* glk_main_t) (void);
142 typedef int (* glkunix_startup_code_t) (glkunix_startup_t*);
167 static guint chimara_glk_signals[LAST_SIGNAL] = { 0 };
169 G_DEFINE_TYPE(ChimaraGlk, chimara_glk, GTK_TYPE_CONTAINER);
172 chimara_glk_init(ChimaraGlk *self)
174 chimara_init(); /* This is a library entry point */
176 gtk_widget_set_has_window(GTK_WIDGET(self), FALSE);
178 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(self);
181 priv->interactive = TRUE;
182 priv->protect = FALSE;
183 priv->styles = g_new0(StyleSet,1);
184 priv->glk_styles = g_new0(StyleSet,1);
185 priv->pager_attr_list = pango_attr_list_new();
186 priv->final_message = g_strdup("[ The game has finished ]");
187 priv->running = FALSE;
188 priv->program = NULL;
190 priv->event_queue = g_queue_new();
191 priv->event_lock = g_mutex_new();
192 priv->event_queue_not_empty = g_cond_new();
193 priv->event_queue_not_full = g_cond_new();
194 priv->abort_lock = g_mutex_new();
195 priv->abort_signalled = FALSE;
196 priv->shutdown_lock = g_mutex_new();
197 priv->shutdown_key_pressed = g_cond_new();
198 priv->arrange_lock = g_mutex_new();
199 priv->rearranged = g_cond_new();
200 priv->needs_rearrange = FALSE;
201 priv->ignore_next_arrange_event = FALSE;
202 priv->char_input_queue = g_async_queue_new();
203 priv->line_input_queue = g_async_queue_new();
204 /* FIXME Should be g_async_queue_new_full(g_free); but only in GTK >= 2.16 */
205 priv->resource_map = NULL;
206 priv->resource_lock = g_mutex_new();
207 priv->resource_loaded = g_cond_new();
208 priv->resource_info_available = g_cond_new();
209 priv->resource_load_callback = NULL;
210 priv->resource_load_callback_data = NULL;
211 priv->image_cache = NULL;
212 priv->program_name = NULL;
213 priv->program_info = NULL;
214 priv->story_name = NULL;
215 priv->interrupt_handler = NULL;
216 priv->root_window = NULL;
217 priv->fileref_list = NULL;
218 priv->current_stream = NULL;
219 priv->stream_list = NULL;
221 priv->in_startup = FALSE;
222 priv->current_dir = NULL;
228 chimara_glk_set_property(GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
230 ChimaraGlk *glk = CHIMARA_GLK(object);
234 case PROP_INTERACTIVE:
235 chimara_glk_set_interactive( glk, g_value_get_boolean(value) );
238 chimara_glk_set_protect( glk, g_value_get_boolean(value) );
241 chimara_glk_set_spacing( glk, g_value_get_uint(value) );
244 G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
249 chimara_glk_get_property(GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
251 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(object);
255 case PROP_INTERACTIVE:
256 g_value_set_boolean(value, priv->interactive);
259 g_value_set_boolean(value, priv->protect);
262 g_value_set_uint(value, priv->spacing);
264 case PROP_PROGRAM_NAME:
265 g_value_set_string(value, priv->program_name);
267 case PROP_PROGRAM_INFO:
268 g_value_set_string(value, priv->program_info);
270 case PROP_STORY_NAME:
271 g_value_set_string(value, priv->story_name);
274 g_value_set_boolean(value, priv->running);
277 G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
282 chimara_glk_finalize(GObject *object)
284 ChimaraGlk *self = CHIMARA_GLK(object);
285 CHIMARA_GLK_USE_PRIVATE(self, priv);
287 /* Free widget properties */
288 g_free(priv->final_message);
290 g_hash_table_destroy(priv->styles->text_buffer);
291 g_hash_table_destroy(priv->styles->text_grid);
292 g_hash_table_destroy(priv->glk_styles->text_buffer);
293 g_hash_table_destroy(priv->glk_styles->text_grid);
294 pango_attr_list_unref(priv->pager_attr_list);
296 /* Free the event queue */
297 g_mutex_lock(priv->event_lock);
298 g_queue_foreach(priv->event_queue, (GFunc)g_free, NULL);
299 g_queue_free(priv->event_queue);
300 g_cond_free(priv->event_queue_not_empty);
301 g_cond_free(priv->event_queue_not_full);
302 priv->event_queue = NULL;
303 g_mutex_unlock(priv->event_lock);
304 g_mutex_free(priv->event_lock);
305 /* Free the abort signaling mechanism */
306 g_mutex_lock(priv->abort_lock);
307 /* Make sure no other thread is busy with this */
308 g_mutex_unlock(priv->abort_lock);
309 g_mutex_free(priv->abort_lock);
310 priv->abort_lock = NULL;
311 /* Free the shutdown keypress signaling mechanism */
312 g_mutex_lock(priv->shutdown_lock);
313 g_cond_free(priv->shutdown_key_pressed);
314 g_mutex_unlock(priv->shutdown_lock);
315 priv->shutdown_lock = NULL;
316 /* Free the window arrangement signaling */
317 g_mutex_lock(priv->arrange_lock);
318 g_cond_free(priv->rearranged);
319 g_mutex_unlock(priv->arrange_lock);
320 g_mutex_free(priv->arrange_lock);
321 priv->arrange_lock = NULL;
322 g_mutex_lock(priv->resource_lock);
323 g_cond_free(priv->resource_loaded);
324 g_cond_free(priv->resource_info_available);
325 g_mutex_unlock(priv->resource_lock);
326 g_mutex_free(priv->resource_lock);
327 g_slist_foreach(priv->image_cache, (GFunc)clear_image_cache, NULL);
328 g_slist_free(priv->image_cache);
329 /* Unref input queues (this should destroy them since any Glk thread has stopped by now */
330 g_async_queue_unref(priv->char_input_queue);
331 g_async_queue_unref(priv->line_input_queue);
332 /* Destroy callback data if ownership retained */
333 if(priv->resource_load_callback_destroy_data)
334 priv->resource_load_callback_destroy_data(priv->resource_load_callback_data);
336 /* Free other stuff */
337 g_free(priv->current_dir);
338 g_free(priv->program_name);
339 g_free(priv->program_info);
340 g_free(priv->story_name);
341 g_free(priv->styles);
342 g_free(priv->glk_styles);
344 /* Chain up to parent */
345 G_OBJECT_CLASS(chimara_glk_parent_class)->finalize(object);
348 /* Internal function: Recursively get the Glk window tree's size request */
350 request_recurse(winid_t win, GtkRequisition *requisition, guint spacing)
352 if(win->type == wintype_Pair)
354 /* Get children's size requests */
355 GtkRequisition child1, child2;
356 request_recurse(win->window_node->children->data, &child1, spacing);
357 request_recurse(win->window_node->children->next->data, &child2, spacing);
359 glui32 division = win->split_method & winmethod_DivisionMask;
360 glui32 direction = win->split_method & winmethod_DirMask;
361 unsigned border = ((win->split_method & winmethod_BorderMask) == winmethod_NoBorder)? 0 : spacing;
363 /* If the split is fixed, get the size of the fixed child */
364 if(division == winmethod_Fixed)
369 child1.width = win->key_window?
370 win->constraint_size * win->key_window->unit_width
373 case winmethod_Right:
374 child2.width = win->key_window?
375 win->constraint_size * win->key_window->unit_width
378 case winmethod_Above:
379 child1.height = win->key_window?
380 win->constraint_size * win->key_window->unit_height
383 case winmethod_Below:
384 child2.height = win->key_window?
385 win->constraint_size * win->key_window->unit_height
391 /* Add the children's requests */
395 case winmethod_Right:
396 requisition->width = child1.width + child2.width + border;
397 requisition->height = MAX(child1.height, child2.height);
399 case winmethod_Above:
400 case winmethod_Below:
401 requisition->width = MAX(child1.width, child2.width);
402 requisition->height = child1.height + child2.height + border;
407 /* For non-pair windows, just use the size that GTK requests */
409 gtk_widget_size_request(win->frame, requisition);
412 /* Overrides gtk_widget_size_request */
414 chimara_glk_size_request(GtkWidget *widget, GtkRequisition *requisition)
416 g_return_if_fail(widget);
417 g_return_if_fail(requisition);
418 g_return_if_fail(CHIMARA_IS_GLK(widget));
420 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(widget);
422 guint border_width = gtk_container_get_border_width(GTK_CONTAINER(widget));
423 /* For now, just pass the size request on to the root Glk window */
424 if(priv->root_window)
426 request_recurse(priv->root_window->data, requisition, priv->spacing);
427 requisition->width += 2 * border_width;
428 requisition->height += 2 * border_width;
432 requisition->width = CHIMARA_GLK_MIN_WIDTH + 2 * border_width;
433 requisition->height = CHIMARA_GLK_MIN_HEIGHT + 2 * border_width;
437 /* Recursively give the Glk windows their allocated space. Returns a window
438 containing all children of this window that must be redrawn, or NULL if there
439 are no children that require redrawing. */
441 allocate_recurse(winid_t win, GtkAllocation *allocation, guint spacing)
443 if(win->type == wintype_Pair)
445 glui32 division = win->split_method & winmethod_DivisionMask;
446 glui32 direction = win->split_method & winmethod_DirMask;
447 unsigned border = ((win->split_method & winmethod_BorderMask) == winmethod_NoBorder)? 0 : spacing;
449 /* If the space gets too small to honor the spacing property, then just
450 ignore spacing in this window and below. */
451 if( (border > allocation->width && (direction == winmethod_Left || direction == winmethod_Right))
452 || (border > allocation->height && (direction == winmethod_Above || direction == winmethod_Below)) )
455 GtkAllocation child1, child2;
456 child1.x = allocation->x;
457 child1.y = allocation->y;
459 if(division == winmethod_Fixed)
461 /* If the key window has been closed, then default to 0; otherwise
462 use the key window to determine the size */
466 child1.width = win->key_window?
467 CLAMP(win->constraint_size * win->key_window->unit_width, 0, allocation->width - border)
470 case winmethod_Right:
471 child2.width = win->key_window?
472 CLAMP(win->constraint_size * win->key_window->unit_width, 0, allocation->width - border)
475 case winmethod_Above:
476 child1.height = win->key_window?
477 CLAMP(win->constraint_size * win->key_window->unit_height, 0, allocation->height - border)
480 case winmethod_Below:
481 child2.height = win->key_window?
482 CLAMP(win->constraint_size * win->key_window->unit_height, 0, allocation->height - border)
487 else /* proportional */
489 gdouble fraction = win->constraint_size / 100.0;
493 child1.width = MAX(0, (gint)ceil(fraction * (allocation->width - border)) );
495 case winmethod_Right:
496 child2.width = MAX(0, (gint)ceil(fraction * (allocation->width - border)) );
498 case winmethod_Above:
499 child1.height = MAX(0, (gint)ceil(fraction * (allocation->height - border)) );
501 case winmethod_Below:
502 child2.height = MAX(0, (gint)ceil(fraction * (allocation->height - border)) );
507 /* Fill in the rest of the size requisitions according to the child specified above */
511 child2.width = MAX(0, allocation->width - border - child1.width);
512 child2.x = child1.x + child1.width + border;
514 child1.height = child2.height = allocation->height;
516 case winmethod_Right:
517 child1.width = MAX(0, allocation->width - border - child2.width);
518 child2.x = child1.x + child1.width + border;
520 child1.height = child2.height = allocation->height;
522 case winmethod_Above:
523 child2.height = MAX(0, allocation->height - border - child1.height);
525 child2.y = child1.y + child1.height + border;
526 child1.width = child2.width = allocation->width;
528 case winmethod_Below:
529 child1.height = MAX(0, allocation->height - border - child2.height);
531 child2.y = child1.y + child1.height + border;
532 child1.width = child2.width = allocation->width;
537 winid_t arrange1 = allocate_recurse(win->window_node->children->data, &child1, spacing);
538 winid_t arrange2 = allocate_recurse(win->window_node->children->next->data, &child2, spacing);
546 else if(win->type == wintype_TextGrid)
548 /* Pass the size allocation on to the framing widget */
549 gtk_widget_size_allocate(win->frame, allocation);
550 /* It says in the spec that when a text grid window is resized smaller,
551 the bottom or right area is thrown away; when it is resized larger, the
552 bottom or right area is filled with blanks. */
553 GtkAllocation widget_allocation;
554 gtk_widget_get_allocation(win->widget, &widget_allocation);
555 glui32 newwidth = (glui32)(widget_allocation.width / win->unit_width);
556 glui32 newheight = (glui32)(widget_allocation.height / win->unit_height);
558 GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
559 GtkTextIter start, end;
561 for(line = 0; line < win->height; line++)
563 gtk_text_buffer_get_iter_at_line(textbuffer, &start, line);
564 /* If this line is going to fall off the bottom, delete it */
565 if(line >= newheight)
568 gtk_text_iter_forward_to_line_end(&end);
569 gtk_text_iter_forward_char(&end);
570 gtk_text_buffer_delete(textbuffer, &start, &end);
573 /* If this line is not long enough, add spaces on the end */
574 if(newwidth > win->width)
576 gchar *spaces = g_strnfill(newwidth - win->width, ' ');
577 gtk_text_iter_forward_to_line_end(&start);
578 gtk_text_buffer_insert(textbuffer, &start, spaces, -1);
581 /* But if it's too long, delete characters from the end */
582 else if(newwidth < win->width)
585 gtk_text_iter_forward_chars(&start, newwidth);
586 gtk_text_iter_forward_to_line_end(&end);
587 gtk_text_buffer_delete(textbuffer, &start, &end);
589 /* Note: if the widths are equal, do nothing */
591 /* Add blank lines if there aren't enough lines to fit the new size */
592 if(newheight > win->height)
594 gchar *blanks = g_strnfill(win->width, ' ');
595 gchar **blanklines = g_new0(gchar *, (newheight - win->height) + 1);
597 for(count = 0; count < newheight - win->height; count++)
598 blanklines[count] = blanks;
599 blanklines[newheight - win->height] = NULL;
600 gchar *text = g_strjoinv("\n", blanklines);
601 g_free(blanklines); /* not g_strfreev() */
604 gtk_text_buffer_get_end_iter(textbuffer, &start);
605 gtk_text_buffer_insert(textbuffer, &start, "\n", -1);
606 gtk_text_buffer_insert(textbuffer, &start, text, -1);
610 gboolean arrange = !(win->width == newwidth && win->height == newheight);
611 win->width = newwidth;
612 win->height = newheight;
613 return arrange? win : NULL;
616 /* For non-pair, non-text-grid windows, just give them the size */
617 gtk_widget_size_allocate(win->frame, allocation);
621 /* Overrides gtk_widget_size_allocate */
623 chimara_glk_size_allocate(GtkWidget *widget, GtkAllocation *allocation)
625 g_return_if_fail(widget);
626 g_return_if_fail(allocation);
627 g_return_if_fail(CHIMARA_IS_GLK(widget));
629 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(widget);
631 gtk_widget_set_allocation(widget, allocation);
633 if(priv->root_window) {
635 guint border_width = gtk_container_get_border_width(GTK_CONTAINER(widget));
636 child.x = allocation->x + border_width;
637 child.y = allocation->y + border_width;
638 child.width = CLAMP(allocation->width - 2 * border_width, 0, allocation->width);
639 child.height = CLAMP(allocation->height - 2 * border_width, 0, allocation->height);
640 winid_t arrange = allocate_recurse(priv->root_window->data, &child, priv->spacing);
642 /* arrange points to a window that contains all text grid and graphics
643 windows which have been resized */
644 g_mutex_lock(priv->arrange_lock);
645 if(!priv->ignore_next_arrange_event)
648 event_throw(CHIMARA_GLK(widget), evtype_Arrange, arrange == priv->root_window->data? NULL : arrange, 0, 0);
651 priv->ignore_next_arrange_event = FALSE;
652 priv->needs_rearrange = FALSE;
653 g_cond_signal(priv->rearranged);
654 g_mutex_unlock(priv->arrange_lock);
658 /* Recursively invoke callback() on the GtkWidget of each non-pair window in the tree */
660 forall_recurse(winid_t win, GtkCallback callback, gpointer callback_data)
662 if(win->type == wintype_Pair)
664 forall_recurse(win->window_node->children->data, callback, callback_data);
665 forall_recurse(win->window_node->children->next->data, callback, callback_data);
668 (*callback)(win->frame, callback_data);
671 /* Overrides gtk_container_forall */
673 chimara_glk_forall(GtkContainer *container, gboolean include_internals, GtkCallback callback, gpointer callback_data)
675 g_return_if_fail(container);
676 g_return_if_fail(CHIMARA_IS_GLK(container));
678 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(container);
680 /* All the children are "internal" */
681 if(!include_internals)
684 if(priv->root_window)
685 forall_recurse(priv->root_window->data, callback, callback_data);
689 chimara_glk_stopped(ChimaraGlk *self)
691 CHIMARA_GLK_USE_PRIVATE(self, priv);
692 priv->running = FALSE;
693 priv->program_name = NULL;
694 g_object_notify(G_OBJECT(self), "program-name");
695 priv->program_info = NULL;
696 g_object_notify(G_OBJECT(self), "program-info");
697 priv->story_name = NULL;
698 g_object_notify(G_OBJECT(self), "story-name");
702 chimara_glk_started(ChimaraGlk *self)
704 CHIMARA_GLK_USE_PRIVATE(self, priv);
705 priv->running = TRUE;
709 chimara_glk_waiting(ChimaraGlk *self)
711 /* Default signal handler */
715 chimara_glk_char_input(ChimaraGlk *self, guint window_rock, guint keysym)
717 /* Default signal handler */
721 chimara_glk_line_input(ChimaraGlk *self, guint window_rock, gchar *text)
723 /* Default signal handler */
727 chimara_glk_text_buffer_output(ChimaraGlk *self, guint window_rock, gchar *text)
729 /* Default signal handler */
733 chimara_glk_iliad_screen_update(ChimaraGlk *self, gboolean typing)
735 /* Default signal handler */
738 /* COMPAT: G_PARAM_STATIC_STRINGS only appeared in GTK 2.13.0 */
739 #ifndef G_PARAM_STATIC_STRINGS
741 /* COMPAT: G_PARAM_STATIC_NAME and friends only appeared in GTK 2.8 */
742 #if GTK_CHECK_VERSION(2,8,0)
743 #define G_PARAM_STATIC_STRINGS (G_PARAM_STATIC_NAME | G_PARAM_STATIC_NICK | G_PARAM_STATIC_BLURB)
745 #define G_PARAM_STATIC_STRINGS (0)
751 chimara_glk_class_init(ChimaraGlkClass *klass)
753 /* Override methods of parent classes */
754 GObjectClass *object_class = G_OBJECT_CLASS(klass);
755 object_class->set_property = chimara_glk_set_property;
756 object_class->get_property = chimara_glk_get_property;
757 object_class->finalize = chimara_glk_finalize;
759 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS(klass);
760 widget_class->size_request = chimara_glk_size_request;
761 widget_class->size_allocate = chimara_glk_size_allocate;
763 GtkContainerClass *container_class = GTK_CONTAINER_CLASS(klass);
764 container_class->forall = chimara_glk_forall;
767 klass->stopped = chimara_glk_stopped;
768 klass->started = chimara_glk_started;
769 klass->waiting = chimara_glk_waiting;
770 klass->char_input = chimara_glk_char_input;
771 klass->line_input = chimara_glk_line_input;
772 klass->text_buffer_output = chimara_glk_text_buffer_output;
773 klass->iliad_screen_update = chimara_glk_iliad_screen_update;
776 * ChimaraGlk::stopped:
777 * @glk: The widget that received the signal
779 * Emitted when the a Glk program finishes executing in the widget, whether
780 * it ended normally, or was interrupted.
782 chimara_glk_signals[STOPPED] = g_signal_new("stopped",
783 G_OBJECT_CLASS_TYPE(klass), G_SIGNAL_RUN_FIRST,
784 /* FIXME: Should be G_SIGNAL_RUN_CLEANUP but that segfaults??! */
785 G_STRUCT_OFFSET(ChimaraGlkClass, stopped), NULL, NULL,
786 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
788 * ChimaraGlk::started:
789 * @glk: The widget that received the signal
791 * Emitted when a Glk program starts executing in the widget.
793 chimara_glk_signals[STARTED] = g_signal_new ("started",
794 G_OBJECT_CLASS_TYPE(klass), G_SIGNAL_RUN_FIRST,
795 G_STRUCT_OFFSET(ChimaraGlkClass, started), NULL, NULL,
796 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
798 * ChimaraGlk::waiting:
799 * @glk: The widget that received the signal
801 * Emitted when glk_select() is called by the Glk program and the event
802 * queue is empty, which means that the widget is waiting for input.
804 chimara_glk_signals[WAITING] = g_signal_new("waiting",
805 G_OBJECT_CLASS_TYPE(klass), 0,
806 G_STRUCT_OFFSET(ChimaraGlkClass, waiting), NULL, NULL,
807 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
809 * ChimaraGlk::char-input:
810 * @glk: The widget that received the signal
811 * @window_rock: The rock value of the window that received character input
812 * (see <link linkend="chimara-Rocks">Rocks</link>)
813 * @keysym: The key that was typed, in the form of a key symbol from
814 * <filename class="headerfile">gdk/gdkkeysyms.h</filename>
816 * Emitted when a Glk window receives character input.
818 chimara_glk_signals[CHAR_INPUT] = g_signal_new("char-input",
819 G_OBJECT_CLASS_TYPE(klass), 0,
820 G_STRUCT_OFFSET(ChimaraGlkClass, char_input), NULL, NULL,
821 _chimara_marshal_VOID__UINT_UINT,
822 G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_UINT);
824 * ChimaraGlk::line-input:
825 * @glk: The widget that received the signal
826 * @window_rock: The rock value of the window that received line input (see
827 * <link linkend="chimara-Rocks">Rocks</link>)
828 * @text: The text that was typed
830 * Emitted when a Glk window receives line input.
832 chimara_glk_signals[LINE_INPUT] = g_signal_new("line-input",
833 G_OBJECT_CLASS_TYPE(klass), 0,
834 G_STRUCT_OFFSET(ChimaraGlkClass, line_input), NULL, NULL,
835 _chimara_marshal_VOID__UINT_STRING,
836 G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_STRING);
838 * ChimaraGlk::text-buffer-output:
839 * @glk: The widget that received the signal
840 * @window_rock: The rock value of the window that was printed to (see <link
841 * linkend="chimara-Rocks">Rocks</link>)
843 * Emitted when text is printed to a text buffer window.
845 chimara_glk_signals[TEXT_BUFFER_OUTPUT] = g_signal_new("text-buffer-output",
846 G_OBJECT_CLASS_TYPE(klass), 0,
847 G_STRUCT_OFFSET(ChimaraGlkClass, text_buffer_output), NULL, NULL,
848 _chimara_marshal_VOID__UINT_STRING,
849 G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_STRING);
851 * ChimaraGlk::iliad-screen-update:
852 * @self: The widget that received the signal
853 * @typing: Whether to perform a typing or full screen update
855 * Iliad specific signal which is emitted whenever the screen needs to be updated.
856 * Since iliad screen updates are very slow, updating should only be done when
859 chimara_glk_signals[ILIAD_SCREEN_UPDATE] = g_signal_new("iliad-screen-update",
860 G_OBJECT_CLASS_TYPE(klass), 0,
861 G_STRUCT_OFFSET(ChimaraGlkClass, iliad_screen_update), NULL, NULL,
862 _chimara_marshal_VOID__BOOLEAN,
863 G_TYPE_NONE, 1, G_TYPE_BOOLEAN);
867 * ChimaraGlk:interactive:
869 * Sets whether the widget is interactive. A Glk widget is normally
870 * interactive, but in non-interactive mode, keyboard and mouse input are
871 * ignored and the Glk program is controlled by
872 * chimara_glk_feed_char_input() and chimara_glk_feed_line_input().
873 * <quote>More</quote> prompts when a lot of text is printed to a text
874 * buffer are also disabled. This is typically used when you wish to control
875 * an interpreter program by feeding it a predefined list of commands.
877 g_object_class_install_property( object_class, PROP_INTERACTIVE,
878 g_param_spec_boolean("interactive", _("Interactive"),
879 _("Whether user input is expected in the Glk program"),
881 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
884 * ChimaraGlk:protect:
886 * Sets whether the Glk program is allowed to do file operations. In protect
887 * mode, all file operations will fail.
889 g_object_class_install_property(object_class, PROP_PROTECT,
890 g_param_spec_boolean("protect", _("Protected"),
891 _("Whether the Glk program is barred from doing file operations"),
893 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
896 * ChimaraGlk:spacing:
898 * The amount of space between the Glk windows. This space forms a visible
899 * border between windows; however, if you open a window using the
900 * %winmethod_NoBorder flag, there will be no spacing between it and its
901 * sibling window, no matter what the value of this property is.
903 g_object_class_install_property(object_class, PROP_SPACING,
904 g_param_spec_uint("spacing", _("Spacing"),
905 _("The amount of space between Glk windows"),
907 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
910 * ChimaraGlk:program-name:
912 * The name of the currently running Glk program. You cannot set this
913 * property yourself. It is set to the filename of the plugin when you call
914 * chimara_glk_run(), but the plugin can change it by calling
915 * garglk_set_program_name(). To find out when this information changes,
916 * for example to put the program name in the title bar of a window, connect
917 * to the <code>::notify::program-name</code> signal.
919 g_object_class_install_property(object_class, PROP_PROGRAM_NAME,
920 g_param_spec_string("program-name", _("Program name"),
921 _("Name of the currently running program"),
923 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
926 * ChimaraGlk:program-info:
928 * Information about the currently running Glk program. You cannot set this
929 * property yourself. The plugin can change it by calling
930 * garglk_set_program_info(). See also #ChimaraGlk:program-name.
932 g_object_class_install_property(object_class, PROP_PROGRAM_INFO,
933 g_param_spec_string("program-info", _("Program info"),
934 _("Information about the currently running program"),
936 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
939 * ChimaraGlk:story-name:
941 * The name of the story currently running in the Glk interpreter. You
942 * cannot set this property yourself. It is set to the story filename when
943 * you call chimara_if_run_game(), but the plugin can change it by calling
944 * garglk_set_story_name().
946 * Strictly speaking, this should be a property of #ChimaraIF, but it is
947 * legal for any Glk program to call garglk_set_story_name(), even if it is
948 * not an interpreter and does not load story files.
950 g_object_class_install_property(object_class, PROP_STORY_NAME,
951 g_param_spec_string("story-name", _("Story name"),
952 _("Name of the story currently loaded in the interpreter"),
954 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
957 * ChimaraGlk:running:
959 * Whether this Glk widget is currently running a game or not.
961 g_object_class_install_property(object_class, PROP_RUNNING,
962 g_param_spec_boolean("running", _("Running"),
963 _("Whether there is a program currently running"),
965 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
968 g_type_class_add_private(klass, sizeof(ChimaraGlkPrivate));
971 /* PUBLIC FUNCTIONS */
974 * chimara_error_quark:
976 * The error domain for errors from Chimara widgets.
978 * Returns: The string <quote>chimara-error-quark</quote> as a <link
979 * linkend="GQuark">GQuark</link>.
982 chimara_error_quark(void)
984 chimara_init(); /* This is a library entry point */
985 return g_quark_from_static_string("chimara-error-quark");
991 * Creates and initializes a new #ChimaraGlk widget.
993 * Return value: a #ChimaraGlk widget, with a floating reference.
996 chimara_glk_new(void)
998 /* This is a library entry point; initialize the library */
1001 return GTK_WIDGET(g_object_new(CHIMARA_TYPE_GLK, NULL));
1005 * chimara_glk_set_interactive:
1006 * @glk: a #ChimaraGlk widget
1007 * @interactive: whether the widget should expect user input
1009 * Sets the #ChimaraGlk:interactive property of @glk.
1012 chimara_glk_set_interactive(ChimaraGlk *glk, gboolean interactive)
1014 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1016 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1017 priv->interactive = interactive;
1018 g_object_notify(G_OBJECT(glk), "interactive");
1022 * chimara_glk_get_interactive:
1023 * @glk: a #ChimaraGlk widget
1025 * Returns whether @glk is interactive (expecting user input). See
1026 * #ChimaraGlk:interactive.
1028 * Return value: %TRUE if @glk is interactive.
1031 chimara_glk_get_interactive(ChimaraGlk *glk)
1033 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1035 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1036 return priv->interactive;
1040 * chimara_glk_set_protect:
1041 * @glk: a #ChimaraGlk widget
1042 * @protect: whether the widget should allow the Glk program to do file
1045 * Sets the #ChimaraGlk:protect property of @glk. In protect mode, the Glk
1046 * program is not allowed to do file operations.
1049 chimara_glk_set_protect(ChimaraGlk *glk, gboolean protect)
1051 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1053 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1054 priv->protect = protect;
1055 g_object_notify(G_OBJECT(glk), "protect");
1059 * chimara_glk_get_protect:
1060 * @glk: a #ChimaraGlk widget
1062 * Returns whether @glk is in protect mode (banned from doing file operations).
1063 * See #ChimaraGlk:protect.
1065 * Return value: %TRUE if @glk is in protect mode.
1068 chimara_glk_get_protect(ChimaraGlk *glk)
1070 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1072 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1073 return priv->protect;
1077 * chimara_glk_set_css_to_default:
1078 * @glk: a #ChimaraGlk widget
1080 * Resets the styles for text buffer and text grid windows to their defaults.
1082 * This function is not implemented yet.
1086 chimara_glk_set_css_to_default(ChimaraGlk *glk)
1088 reset_default_styles(glk);
1092 * chimara_glk_set_css_from_file:
1093 * @glk: a #ChimaraGlk widget
1094 * @filename: path to a CSS file, or %NULL
1095 * @error: location to store a <link
1096 * linkend="glib-Error-Reporting">GError</link>, or %NULL
1098 * Sets the styles for text buffer and text grid windows according to the CSS
1099 * file @filename. Note that the styles are set cumulatively on top of whatever
1100 * the styles are at the time this function is called; to reset the styles to
1101 * their defaults, use chimara_glk_set_css_to_default().
1103 * Returns: %TRUE on success, %FALSE if an error occurred, in which case @error
1107 chimara_glk_set_css_from_file(ChimaraGlk *glk, const gchar *filename, GError **error)
1109 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1110 g_return_val_if_fail(filename, FALSE);
1111 g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
1113 int fd = open(filename, O_RDONLY);
1116 *error = g_error_new(G_IO_ERROR, g_io_error_from_errno(errno),
1117 _("Error opening file \"%s\": %s"), filename, g_strerror(errno));
1121 GScanner *scanner = create_css_file_scanner();
1122 g_scanner_input_file(scanner, fd);
1123 scanner->input_name = filename;
1124 scan_css_file(scanner, glk);
1126 if(close(fd) == -1) {
1128 *error = g_error_new(G_IO_ERROR, g_io_error_from_errno(errno),
1129 _("Error closing file \"%s\": %s"), filename, g_strerror(errno));
1136 * chimara_glk_set_css_from_string:
1137 * @glk: a #ChimaraGlk widget
1138 * @css: a string containing CSS code
1140 * Sets the styles for text buffer and text grid windows according to the CSS
1141 * code @css. Note that the styles are set cumulatively on top of whatever the
1142 * styles are at the time this function is called; to reset the styles to their
1143 * defaults, use chimara_glk_set_css_to_default().
1146 chimara_glk_set_css_from_string(ChimaraGlk *glk, const gchar *css)
1148 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1149 g_return_if_fail(css || *css);
1151 GScanner *scanner = create_css_file_scanner();
1152 g_scanner_input_text(scanner, css, strlen(css));
1153 scanner->input_name = "<string>";
1154 scan_css_file(scanner, glk);
1158 * chimara_glk_set_spacing:
1159 * @glk: a #ChimaraGlk widget
1160 * @spacing: the number of pixels to put between Glk windows
1162 * Sets the #ChimaraGlk:spacing property of @glk, which is the border width in
1163 * pixels between Glk windows.
1166 chimara_glk_set_spacing(ChimaraGlk *glk, guint spacing)
1168 g_return_if_fail( glk || CHIMARA_IS_GLK(glk) );
1170 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1171 priv->spacing = spacing;
1172 g_object_notify(G_OBJECT(glk), "spacing");
1176 * chimara_glk_get_spacing:
1177 * @glk: a #ChimaraGlk widget
1179 * Gets the value set by chimara_glk_set_spacing().
1181 * Return value: pixels of spacing between Glk windows
1184 chimara_glk_get_spacing(ChimaraGlk *glk)
1186 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), 0);
1188 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1189 return priv->spacing;
1192 struct StartupData {
1193 glk_main_t glk_main;
1194 glkunix_startup_code_t glkunix_startup_code;
1195 glkunix_startup_t args;
1196 ChimaraGlkPrivate *glk_data;
1199 /* glk_enter() is the actual function called in the new thread in which glk_main() runs. */
1201 glk_enter(struct StartupData *startup)
1203 extern GPrivate *glk_data_key;
1204 g_private_set(glk_data_key, startup->glk_data);
1206 /* Acquire the Glk thread's references to the input queues */
1207 g_async_queue_ref(startup->glk_data->char_input_queue);
1208 g_async_queue_ref(startup->glk_data->line_input_queue);
1210 /* Run startup function */
1211 if(startup->glkunix_startup_code) {
1212 startup->glk_data->in_startup = TRUE;
1213 int result = startup->glkunix_startup_code(&startup->args);
1214 startup->glk_data->in_startup = FALSE;
1217 while(i < startup->args.argc)
1218 g_free(startup->args.argv[i++]);
1219 g_free(startup->args.argv);
1225 /* Run main function */
1226 glk_main_t glk_main = startup->glk_main;
1228 /* COMPAT: avoid usage of slices */
1230 g_signal_emit_by_name(startup->glk_data->self, "started");
1232 glk_exit(); /* Run shutdown code in glk_exit() even if glk_main() returns normally */
1233 g_assert_not_reached(); /* because glk_exit() calls g_thread_exit() */
1239 * @glk: a #ChimaraGlk widget
1240 * @plugin: path to a plugin module compiled with <filename
1241 * class="header">glk.h</filename>
1242 * @argc: Number of command line arguments in @argv
1243 * @argv: Array of command line arguments to pass to the plugin
1244 * @error: location to store a <link
1245 * linkend="glib-Error-Reporting">GError</link>, or %NULL
1247 * Opens a Glk program compiled as a plugin. Sorts out its command line
1248 * arguments from #glkunix_arguments, calls its startup function
1249 * glkunix_startup_code(), and then calls its main function glk_main() in
1250 * a separate thread. On failure, returns %FALSE and sets @error.
1252 * The plugin must at least export a glk_main() function; #glkunix_arguments and
1253 * glkunix_startup_code() are optional.
1255 * Return value: %TRUE if the Glk program was started successfully.
1258 chimara_glk_run(ChimaraGlk *glk, const gchar *plugin, int argc, char *argv[], GError **error)
1260 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1261 g_return_val_if_fail(plugin, FALSE);
1262 g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
1264 if(chimara_glk_get_running(glk)) {
1265 g_set_error(error, CHIMARA_ERROR, CHIMARA_PLUGIN_ALREADY_RUNNING, _("There was already a plugin running."));
1269 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1271 /* COMPAT: avoid usage of slices */
1272 struct StartupData *startup = g_new0(struct StartupData,1);
1274 g_assert( g_module_supported() );
1275 /* If there is already a module loaded, free it first -- you see, we want to
1276 * keep modules loaded as long as possible to avoid crashes in stack unwinding */
1277 chimara_glk_unload_plugin(glk);
1278 /* Open the module to run */
1279 priv->program = g_module_open(plugin, G_MODULE_BIND_LAZY);
1283 g_set_error(error, CHIMARA_ERROR, CHIMARA_LOAD_MODULE_ERROR, _("Error opening module: %s"), g_module_error());
1286 if( !g_module_symbol(priv->program, "glk_main", (gpointer *) &startup->glk_main) )
1288 g_set_error(error, CHIMARA_ERROR, CHIMARA_NO_GLK_MAIN, _("Error finding glk_main(): %s"), g_module_error());
1292 if( g_module_symbol(priv->program, "glkunix_startup_code", (gpointer *) &startup->glkunix_startup_code) )
1294 glkunix_argumentlist_t *glkunix_arguments;
1296 if( !(g_module_symbol(priv->program, "glkunix_arguments", (gpointer *) &glkunix_arguments)
1297 && parse_command_line(glkunix_arguments, argc, argv, &startup->args)) )
1299 /* arguments could not be parsed, so create data ourselves */
1300 startup->args.argc = 1;
1301 startup->args.argv = g_new0(gchar *, 1);
1304 /* Set the program invocation name */
1305 startup->args.argv[0] = g_strdup(plugin);
1307 startup->glk_data = priv;
1309 /* Set the program name */
1310 priv->program_name = g_path_get_basename(plugin);
1311 g_object_notify(G_OBJECT(glk), "program-name");
1313 /* Run in a separate thread */
1314 priv->thread = g_thread_create((GThreadFunc)glk_enter, startup, TRUE, error);
1316 return !(priv->thread == NULL);
1320 * chimara_glk_run_file:
1321 * @self: a #ChimaraGlk widget
1322 * @plugin_file: a #GFile pointing to a plugin module compiled with <filename
1323 * class="header">glk.h</filename>
1324 * @argc: Number of command line arguments in @argv
1325 * @argv: Array of command line arguments to pass to the plugin
1326 * @error: location to store a <link
1327 * linkend="glib-Error-Reporting">GError</link>, or %NULL
1329 * Opens a Glk program compiled as a plugin, from a #GFile. See
1330 * chimara_glk_run() for details.
1332 * Return value: %TRUE if the Glk program was started successfully.
1335 chimara_glk_run_file(ChimaraGlk *self, GFile *plugin_file, int argc, char *argv[], GError **error)
1337 g_return_val_if_fail(self || CHIMARA_IS_GLK(self), FALSE);
1338 g_return_val_if_fail(plugin_file || G_IS_FILE(plugin_file), FALSE);
1339 g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
1341 char *path = g_file_get_path(plugin_file);
1342 gboolean retval = chimara_glk_run(self, path, argc, argv, error);
1350 * @glk: a #ChimaraGlk widget
1352 * Signals the Glk program running in @glk to abort. Note that if the program is
1353 * caught in an infinite loop in which glk_tick() is not called, this may not
1356 * This function does nothing if no Glk program is running.
1359 chimara_glk_stop(ChimaraGlk *glk)
1361 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1362 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1364 /* Don't do anything if not running a program */
1368 if(priv->abort_lock) {
1369 g_mutex_lock(priv->abort_lock);
1370 priv->abort_signalled = TRUE;
1371 g_mutex_unlock(priv->abort_lock);
1372 /* Stop blocking on the event queue condition */
1373 event_throw(glk, evtype_Abort, NULL, 0, 0);
1374 /* Stop blocking on the shutdown key press condition */
1375 g_mutex_lock(priv->shutdown_lock);
1376 g_cond_signal(priv->shutdown_key_pressed);
1377 g_mutex_unlock(priv->shutdown_lock);
1383 * @glk: a #ChimaraGlk widget
1385 * Holds up the main thread and waits for the Glk program running in @glk to
1388 * This function does nothing if no Glk program is running.
1391 chimara_glk_wait(ChimaraGlk *glk)
1393 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1394 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1395 /* Don't do anything if not running a program */
1398 /* Unlock GDK mutex, because the Glk program might need to use it for shutdown */
1399 gdk_threads_leave();
1400 g_thread_join(priv->thread);
1401 gdk_threads_enter();
1405 * chimara_glk_unload_plugin:
1406 * @glk: a #ChimaraGlk widget
1408 * The plugin containing the Glk program is unloaded as late as possible before
1409 * loading a new plugin, in order to prevent crashes while printing stack
1410 * backtraces during debugging. Sometimes this behavior is not desirable. This
1411 * function forces @glk to unload the plugin running in it.
1413 * This function does nothing if there is no plugin loaded.
1416 chimara_glk_unload_plugin(ChimaraGlk *glk)
1418 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1419 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1420 if( priv->program && !g_module_close(priv->program) )
1421 g_warning( "Error closing module :%s", g_module_error() );
1425 * chimara_glk_get_running:
1426 * @glk: a #ChimaraGlk widget
1428 * Use this function to tell whether a program is currently running in the
1431 * Returns: %TRUE if @glk is executing a Glk program, %FALSE otherwise.
1434 chimara_glk_get_running(ChimaraGlk *glk)
1436 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1437 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1438 return priv->running;
1442 * chimara_glk_feed_char_input:
1443 * @glk: a #ChimaraGlk widget
1444 * @keyval: a key symbol as defined in <filename
1445 * class="headerfile">gdk/gdkkeysyms.h</filename>
1447 * Pretend that a key was pressed in the Glk program as a response to a
1448 * character input request. You can call this function even when no window has
1449 * requested character input, in which case the key will be saved for the
1450 * following window that requests character input. This has the disadvantage
1451 * that if more than one window has requested character input, it is arbitrary
1452 * which one gets the key press.
1455 chimara_glk_feed_char_input(ChimaraGlk *glk, guint keyval)
1457 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1458 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1459 g_async_queue_push(priv->char_input_queue, GUINT_TO_POINTER(keyval));
1460 event_throw(glk, evtype_ForcedCharInput, NULL, 0, 0);
1464 * chimara_glk_feed_line_input:
1465 * @glk: a #ChimaraGlk widget
1466 * @text: text to pass to the next line input request
1468 * Pretend that @text was typed in the Glk program as a response to a line input
1469 * request. @text does not need to end with a newline. You can call this
1470 * function even when no window has requested line input, in which case the text
1471 * will be saved for the following window that requests line input. This has the
1472 * disadvantage that if more than one window has requested line input, it is
1473 * arbitrary which one gets the text.
1476 chimara_glk_feed_line_input(ChimaraGlk *glk, const gchar *text)
1478 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1479 g_return_if_fail(text);
1480 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1481 g_async_queue_push(priv->line_input_queue, g_strdup(text));
1482 event_throw(glk, evtype_ForcedLineInput, NULL, 0, 0);
1486 * chimara_glk_is_char_input_pending:
1487 * @glk: a #ChimaraGlk widget
1489 * Use this function to tell if character input forced by
1490 * chimara_glk_feed_char_input() has been passed to an input request or not.
1492 * Returns: %TRUE if forced character input is pending, %FALSE otherwise.
1495 chimara_glk_is_char_input_pending(ChimaraGlk *glk)
1497 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1498 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1499 return g_async_queue_length(priv->char_input_queue) > 0;
1503 * chimara_glk_is_line_input_pending:
1504 * @glk: a #ChimaraGlk widget
1506 * Use this function to tell if line input forced by
1507 * chimara_glk_feed_line_input() has been passed to an input request or not.
1509 * Returns: %TRUE if forced line input is pending, %FALSE otherwise.
1512 chimara_glk_is_line_input_pending(ChimaraGlk *glk)
1514 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1515 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1516 return g_async_queue_length(priv->line_input_queue) > 0;
1520 * chimara_glk_get_tag:
1521 * @glk: a #ChimaraGlk widget
1522 * @window: The type of window to retrieve the tag for
1523 * @name: The name of the tag to retrieve
1525 * Use this function to get a #GtkTextTag so style properties can be changed.
1526 * See also chimara_glk_set_css_from_string().
1528 * The layout of the text in Chimara is controlled by two sets of tags: one set
1529 * describing the style in text buffers and one for text grids. See also the
1530 * Glk specification for the difference between the two. The main narrative of
1531 * a game is usually rendered in text buffers, whereas text grids are mostly
1532 * used for status bars and in game menus.
1534 * The following tag names are supported:
1536 * <listitem><para>normal</para></listitem>
1537 * <listitem><para>emphasized</para></listitem>
1538 * <listitem><para>preformatted</para></listitem>
1539 * <listitem><para>header</para></listitem>
1540 * <listitem><para>subheader</para></listitem>
1541 * <listitem><para>alert</para></listitem>
1542 * <listitem><para>note</para></listitem>
1543 * <listitem><para>block-quote</para></listitem>
1544 * <listitem><para>input</para></listitem>
1545 * <listitem><para>user1</para></listitem>
1546 * <listitem><para>user2</para></listitem>
1547 * <listitem><para>hyperlink</para></listitem>
1548 * <listitem><para>pager</para></listitem>
1551 * Returns: (transfer none): The #GtkTextTag corresponding to @name in the
1552 * styles of @window.
1555 chimara_glk_get_tag(ChimaraGlk *glk, ChimaraGlkWindowType window, const gchar *name)
1557 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1560 case CHIMARA_GLK_TEXT_BUFFER:
1561 return GTK_TEXT_TAG( g_hash_table_lookup(priv->styles->text_buffer, name) );
1563 case CHIMARA_GLK_TEXT_GRID:
1564 return GTK_TEXT_TAG( g_hash_table_lookup(priv->styles->text_grid, name) );
1567 ILLEGAL_PARAM("Unknown window type: %u", window);
1573 * chimara_glk_get_tag_names:
1574 * @glk: a #ChimaraGlk widget
1575 * @num_tags: Return location for the number of tag names retrieved.
1577 * Retrieves the possible tag names to use in chimara_glk_get_tag().
1579 * Returns: (transfer none) (array length=num_tags) (element-type utf8):
1580 * Array of strings containing the tag names. This array is owned by Chimara,
1584 chimara_glk_get_tag_names(ChimaraGlk *glk, unsigned int *num_tags)
1586 g_return_val_if_fail(num_tags != NULL, NULL);
1588 *num_tags = CHIMARA_NUM_STYLES;
1589 return style_get_tag_names();
1593 * chimara_glk_update_style:
1594 * @glk: a #ChimaraGlk widget
1596 * Processes style updates and updates the widget to reflect the new style.
1597 * Call this every time you change a property of a #GtkTextTag retrieved by
1598 * chimara_glk_get_tag().
1601 chimara_glk_update_style(ChimaraGlk *glk)
1603 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1606 /* Schedule a redraw */
1607 g_mutex_lock(priv->arrange_lock);
1608 priv->needs_rearrange = TRUE;
1609 priv->ignore_next_arrange_event = TRUE;
1610 g_mutex_unlock(priv->arrange_lock);
1611 gtk_widget_queue_resize( GTK_WIDGET(priv->self) );
1615 * chimara_glk_set_resource_load_callback:
1616 * @glk: a #ChimaraGlk widget
1617 * @func: a function to call for loading resources, or %NULL
1618 * @user_data: user data to pass to @func, or %NULL
1619 * @destroy_user_data: a function to call for freeing @user_data, or %NULL
1621 * Sometimes it is preferable to load image and sound resources from somewhere
1622 * else than a Blorb file, for example while developing a game. Section 14 of
1623 * the <ulink url="http://eblong.com/zarf/blorb/blorb.html#s14">Blorb
1624 * specification</ulink> allows for this possibility. This function sets @func
1625 * to be called when the Glk program requests loading an image or sound without
1626 * a Blorb resource map having been loaded, optionally passing @user_data as an
1629 * Note that @func is only called if no Blorb resource map has been set; having
1630 * a resource map in place overrides this function.
1632 * If you pass non-%NULL for @destroy_user_data, then @glk takes ownership of
1633 * @user_data. When it is not needed anymore, it will be freed by calling
1634 * @destroy_user_data on it. If you wish to retain ownership of @user_data, pass
1635 * %NULL for @destroy_user_data.
1637 * To deactivate the callback, call this function with @func set to %NULL.
1640 chimara_glk_set_resource_load_callback(ChimaraGlk *glk, ChimaraResourceLoadFunc func, gpointer user_data, GDestroyNotify destroy_user_data)
1642 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1644 if(priv->resource_load_callback == func
1645 && priv->resource_load_callback_data == user_data
1646 && priv->resource_load_callback_destroy_data == destroy_user_data)
1649 if(priv->resource_load_callback_destroy_data)
1650 priv->resource_load_callback_destroy_data(priv->resource_load_callback_data);
1652 priv->resource_load_callback = func;
1653 priv->resource_load_callback_data = user_data;
1654 priv->resource_load_callback_destroy_data = destroy_user_data;