1 /* licensing and copyright information here */
11 #include <glib/gi18n-lib.h>
13 #include <pango/pango.h>
15 #include "chimara-glk.h"
16 #include "chimara-glk-private.h"
17 #include "chimara-marshallers.h"
28 #define CHIMARA_GLK_MIN_WIDTH 0
29 #define CHIMARA_GLK_MIN_HEIGHT 0
33 * @short_description: Widget which executes a Glk program
34 * @stability: Unstable
36 * The #ChimaraGlk widget opens and runs a Glk program. The program must be
37 * compiled as a plugin module, with a function <function>glk_main()</function>
38 * that the Glk library can hook into.
40 * On Linux systems, this is a file with a name like
41 * <filename>plugin.so</filename>. For portability, you can use libtool and
44 * pkglib_LTLIBRARIES = plugin.la
45 * plugin_la_SOURCES = plugin.c foo.c bar.c
46 * plugin_la_LDFLAGS = -module -shared -avoid-version -export-symbols-regex "^glk_main$$"
48 * This will produce <filename>plugin.la</filename> which is a text file
49 * containing the correct plugin file to open (see the relevant section of the
51 * url="http://www.gnu.org/software/libtool/manual/html_node/Finding-the-dlname.html">
52 * Libtool manual</ulink>).
54 * You need to initialize GDK threading in any program you use a #ChimaraGlk
56 * This means calling gdk_threads_init() at the beginning of your program,
57 * <emphasis>before</emphasis> the call to gtk_init().
58 * In addition to this, you must also protect your call to gtk_main() by calling
59 * gdk_threads_enter() right before it, and gdk_threads_leave() right after it.
61 * The following sample program shows how to initialize and construct a simple
62 * GTK window that runs a Glk program:
65 * #include <gtk/gtk.h>
66 * #include <libchimara/chimara-glk.h>
69 * main(int argc, char *argv[])
71 * GtkWidget *window, *glk;
72 * GError *error = NULL;
73 * gchar *plugin_argv[] = { "plugin.so", "-option" };
75 * /<!---->* Initialize threads and GTK *<!---->/
77 * gtk_init(&argc, &argv);
79 * /<!---->* Construct the window and its contents. We quit the GTK main loop
80 * * when the window's close button is clicked. *<!---->/
81 * window = gtk_window_new(GTK_WINDOW_TOPLEVEL);
82 * g_signal_connect(window, "delete-event", G_CALLBACK(gtk_main_quit), NULL);
83 * glk = chimara_glk_new();
84 * gtk_container_add(GTK_CONTAINER(window), glk);
85 * gtk_widget_show_all(window);
87 * /<!---->* Add a reference to the ChimaraGlk widget, since we want it to
88 * * persist after the window's delete-event -- otherwise it will be destroyed
89 * * with the window. *<!---->/
92 * /<!---->* Start the Glk program in a separate thread *<!---->/
93 * if(!chimara_glk_run(CHIMARA_GLK(glk), "./plugin.so", 2, plugin_argv, &error))
94 * g_error("Error starting Glk library: %s\n", error->message);
96 * /<!---->* Start the GTK main loop *<!---->/
97 * gdk_threads_enter();
99 * gdk_threads_leave();
101 * /<!---->* After the GTK main loop exits, signal the Glk program to shut down if
102 * * it is still running, and wait for it to exit. *<!---->/
103 * chimara_glk_stop(CHIMARA_GLK(glk));
104 * chimara_glk_wait(CHIMARA_GLK(glk));
105 * g_object_unref(glk);
112 typedef void (* glk_main_t) (void);
113 typedef int (* glkunix_startup_code_t) (glkunix_startup_t*);
138 static guint chimara_glk_signals[LAST_SIGNAL] = { 0 };
140 G_DEFINE_TYPE(ChimaraGlk, chimara_glk, GTK_TYPE_CONTAINER);
143 chimara_glk_init(ChimaraGlk *self)
145 chimara_init(); /* This is a library entry point */
147 gtk_widget_set_has_window(GTK_WIDGET(self), FALSE);
149 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(self);
152 priv->interactive = TRUE;
153 priv->styles = g_new0(StyleSet,1);
154 priv->glk_styles = g_new0(StyleSet,1);
155 priv->pager_attr_list = pango_attr_list_new();
156 priv->final_message = g_strdup("[ The game has finished ]");
157 priv->event_queue = g_queue_new();
158 priv->char_input_queue = g_async_queue_new_full(g_free);
159 priv->line_input_queue = g_async_queue_new_full(g_free);
161 g_mutex_init(&priv->event_lock);
162 g_mutex_init(&priv->abort_lock);
163 g_mutex_init(&priv->shutdown_lock);
164 g_mutex_init(&priv->arrange_lock);
165 g_mutex_init(&priv->resource_lock);
167 g_cond_init(&priv->event_queue_not_empty);
168 g_cond_init(&priv->event_queue_not_full);
169 g_cond_init(&priv->shutdown_key_pressed);
170 g_cond_init(&priv->rearranged);
171 g_cond_init(&priv->resource_loaded);
172 g_cond_init(&priv->resource_info_available);
178 chimara_glk_set_property(GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
180 ChimaraGlk *glk = CHIMARA_GLK(object);
184 case PROP_INTERACTIVE:
185 chimara_glk_set_interactive( glk, g_value_get_boolean(value) );
188 chimara_glk_set_protect( glk, g_value_get_boolean(value) );
191 chimara_glk_set_spacing( glk, g_value_get_uint(value) );
194 G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
199 chimara_glk_get_property(GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
201 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(object);
205 case PROP_INTERACTIVE:
206 g_value_set_boolean(value, priv->interactive);
209 g_value_set_boolean(value, priv->protect);
212 g_value_set_uint(value, priv->spacing);
214 case PROP_PROGRAM_NAME:
215 g_value_set_string(value, priv->program_name);
217 case PROP_PROGRAM_INFO:
218 g_value_set_string(value, priv->program_info);
220 case PROP_STORY_NAME:
221 g_value_set_string(value, priv->story_name);
224 g_value_set_boolean(value, priv->running);
227 G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
232 chimara_glk_finalize(GObject *object)
234 ChimaraGlk *self = CHIMARA_GLK(object);
235 CHIMARA_GLK_USE_PRIVATE(self, priv);
236 priv->after_finalize = TRUE;
238 /* Free widget properties */
239 g_free(priv->final_message);
241 g_hash_table_destroy(priv->styles->text_buffer);
242 g_hash_table_destroy(priv->styles->text_grid);
243 g_hash_table_destroy(priv->glk_styles->text_buffer);
244 g_hash_table_destroy(priv->glk_styles->text_grid);
245 pango_attr_list_unref(priv->pager_attr_list);
247 /* Free the event queue */
248 g_mutex_lock(&priv->event_lock);
249 g_queue_foreach(priv->event_queue, (GFunc)g_free, NULL);
250 g_queue_free(priv->event_queue);
251 g_cond_clear(&priv->event_queue_not_empty);
252 g_cond_clear(&priv->event_queue_not_full);
253 priv->event_queue = NULL;
254 g_mutex_unlock(&priv->event_lock);
255 g_mutex_clear(&priv->event_lock);
257 /* Free the abort signaling mechanism */
258 g_mutex_lock(&priv->abort_lock);
259 /* Make sure no other thread is busy with this */
260 g_mutex_unlock(&priv->abort_lock);
261 g_mutex_clear(&priv->abort_lock);
263 /* Free the shutdown keypress signaling mechanism */
264 g_mutex_lock(&priv->shutdown_lock);
265 g_cond_clear(&priv->shutdown_key_pressed);
266 g_mutex_unlock(&priv->shutdown_lock);
267 g_mutex_clear(&priv->shutdown_lock);
269 /* Free the window arrangement signaling */
270 g_mutex_lock(&priv->arrange_lock);
271 g_cond_clear(&priv->rearranged);
272 g_mutex_unlock(&priv->arrange_lock);
273 g_mutex_clear(&priv->arrange_lock);
275 g_mutex_lock(&priv->resource_lock);
276 g_cond_clear(&priv->resource_loaded);
277 g_cond_clear(&priv->resource_info_available);
278 g_mutex_unlock(&priv->resource_lock);
279 g_mutex_clear(&priv->resource_lock);
280 g_slist_foreach(priv->image_cache, (GFunc)clear_image_cache, NULL);
281 g_slist_free(priv->image_cache);
282 /* Unref input queues (this should destroy them since any Glk thread has stopped by now */
283 g_async_queue_unref(priv->char_input_queue);
284 g_async_queue_unref(priv->line_input_queue);
285 /* Destroy callback data if ownership retained */
286 if(priv->resource_load_callback_destroy_data)
287 priv->resource_load_callback_destroy_data(priv->resource_load_callback_data);
289 /* Free other stuff */
290 g_free(priv->current_dir);
291 g_free(priv->program_name);
292 g_free(priv->program_info);
293 g_free(priv->story_name);
294 g_free(priv->styles);
295 g_free(priv->glk_styles);
297 /* Chain up to parent */
298 G_OBJECT_CLASS(chimara_glk_parent_class)->finalize(object);
301 /* Internal function: Recursively get the Glk window tree's size request */
303 request_recurse(winid_t win, GtkRequisition *requisition, guint spacing)
305 if(win->type == wintype_Pair)
307 /* Get children's size requests */
308 GtkRequisition child1, child2;
309 request_recurse(win->window_node->children->data, &child1, spacing);
310 request_recurse(win->window_node->children->next->data, &child2, spacing);
312 glui32 division = win->split_method & winmethod_DivisionMask;
313 glui32 direction = win->split_method & winmethod_DirMask;
314 unsigned border = ((win->split_method & winmethod_BorderMask) == winmethod_NoBorder)? 0 : spacing;
316 /* If the split is fixed, get the size of the fixed child */
317 if(division == winmethod_Fixed)
322 child1.width = win->key_window?
323 win->constraint_size * win->key_window->unit_width
326 case winmethod_Right:
327 child2.width = win->key_window?
328 win->constraint_size * win->key_window->unit_width
331 case winmethod_Above:
332 child1.height = win->key_window?
333 win->constraint_size * win->key_window->unit_height
336 case winmethod_Below:
337 child2.height = win->key_window?
338 win->constraint_size * win->key_window->unit_height
344 /* Add the children's requests */
348 case winmethod_Right:
349 requisition->width = child1.width + child2.width + border;
350 requisition->height = MAX(child1.height, child2.height);
352 case winmethod_Above:
353 case winmethod_Below:
354 requisition->width = MAX(child1.width, child2.width);
355 requisition->height = child1.height + child2.height + border;
360 /* For non-pair windows, just use the size that GTK requests */
362 gtk_widget_size_request(win->frame, requisition);
365 /* Overrides gtk_widget_size_request */
367 chimara_glk_size_request(GtkWidget *widget, GtkRequisition *requisition)
369 g_return_if_fail(widget);
370 g_return_if_fail(requisition);
371 g_return_if_fail(CHIMARA_IS_GLK(widget));
373 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(widget);
375 guint border_width = gtk_container_get_border_width(GTK_CONTAINER(widget));
376 /* For now, just pass the size request on to the root Glk window */
377 if(priv->root_window)
379 request_recurse(priv->root_window->data, requisition, priv->spacing);
380 requisition->width += 2 * border_width;
381 requisition->height += 2 * border_width;
385 requisition->width = CHIMARA_GLK_MIN_WIDTH + 2 * border_width;
386 requisition->height = CHIMARA_GLK_MIN_HEIGHT + 2 * border_width;
390 /* Recursively give the Glk windows their allocated space. Returns a window
391 containing all children of this window that must be redrawn, or NULL if there
392 are no children that require redrawing. */
394 allocate_recurse(winid_t win, GtkAllocation *allocation, guint spacing)
396 if(win->type == wintype_Pair)
398 glui32 division = win->split_method & winmethod_DivisionMask;
399 glui32 direction = win->split_method & winmethod_DirMask;
400 unsigned border = ((win->split_method & winmethod_BorderMask) == winmethod_NoBorder)? 0 : spacing;
402 /* If the space gets too small to honor the spacing property, then just
403 ignore spacing in this window and below. */
404 if( (border > allocation->width && (direction == winmethod_Left || direction == winmethod_Right))
405 || (border > allocation->height && (direction == winmethod_Above || direction == winmethod_Below)) )
408 GtkAllocation child1, child2;
409 child1.x = allocation->x;
410 child1.y = allocation->y;
412 if(division == winmethod_Fixed)
414 /* If the key window has been closed, then default to 0; otherwise
415 use the key window to determine the size */
419 child1.width = win->key_window?
420 CLAMP(win->constraint_size * win->key_window->unit_width, 0, allocation->width - border)
423 case winmethod_Right:
424 child2.width = win->key_window?
425 CLAMP(win->constraint_size * win->key_window->unit_width, 0, allocation->width - border)
428 case winmethod_Above:
429 child1.height = win->key_window?
430 CLAMP(win->constraint_size * win->key_window->unit_height, 0, allocation->height - border)
433 case winmethod_Below:
434 child2.height = win->key_window?
435 CLAMP(win->constraint_size * win->key_window->unit_height, 0, allocation->height - border)
440 else /* proportional */
442 gdouble fraction = win->constraint_size / 100.0;
446 child1.width = MAX(0, (gint)ceil(fraction * (allocation->width - border)) );
448 case winmethod_Right:
449 child2.width = MAX(0, (gint)ceil(fraction * (allocation->width - border)) );
451 case winmethod_Above:
452 child1.height = MAX(0, (gint)ceil(fraction * (allocation->height - border)) );
454 case winmethod_Below:
455 child2.height = MAX(0, (gint)ceil(fraction * (allocation->height - border)) );
460 /* Fill in the rest of the size requisitions according to the child specified above */
464 child2.width = MAX(0, allocation->width - border - child1.width);
465 child2.x = child1.x + child1.width + border;
467 child1.height = child2.height = allocation->height;
469 case winmethod_Right:
470 child1.width = MAX(0, allocation->width - border - child2.width);
471 child2.x = child1.x + child1.width + border;
473 child1.height = child2.height = allocation->height;
475 case winmethod_Above:
476 child2.height = MAX(0, allocation->height - border - child1.height);
478 child2.y = child1.y + child1.height + border;
479 child1.width = child2.width = allocation->width;
481 case winmethod_Below:
482 child1.height = MAX(0, allocation->height - border - child2.height);
484 child2.y = child1.y + child1.height + border;
485 child1.width = child2.width = allocation->width;
490 winid_t arrange1 = allocate_recurse(win->window_node->children->data, &child1, spacing);
491 winid_t arrange2 = allocate_recurse(win->window_node->children->next->data, &child2, spacing);
499 else if(win->type == wintype_TextGrid)
501 /* Pass the size allocation on to the framing widget */
502 gtk_widget_size_allocate(win->frame, allocation);
503 /* It says in the spec that when a text grid window is resized smaller,
504 the bottom or right area is thrown away; when it is resized larger, the
505 bottom or right area is filled with blanks. */
506 GtkAllocation widget_allocation;
507 gtk_widget_get_allocation(win->widget, &widget_allocation);
508 glui32 new_width = (glui32)(widget_allocation.width / win->unit_width);
509 glui32 new_height = (glui32)(widget_allocation.height / win->unit_height);
511 if(new_width != win->width || new_height != win->height)
513 // Window has changed size, trim or expand the textbuffer if necessary.
514 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
515 GtkTextIter start, end;
517 // Add or remove lines
518 if(new_height == 0) {
519 gtk_text_buffer_get_start_iter(buffer, &start);
520 gtk_text_buffer_get_end_iter(buffer, &end);
521 gtk_text_buffer_delete(buffer, &start, &end);
523 else if(new_height < win->height)
525 // Remove surplus lines
526 gtk_text_buffer_get_end_iter(buffer, &end);
527 gtk_text_buffer_get_iter_at_line(buffer, &start, new_height-1);
528 gtk_text_iter_forward_to_line_end(&start);
529 gtk_text_buffer_delete(buffer, &start, &end);
532 else if(new_height > win->height)
535 gint lines_to_add = new_height - win->height;
536 gtk_text_buffer_get_end_iter(buffer, &end);
539 gchar *blanks = g_strnfill(win->width, ' ');
540 gchar **blanklines = g_new0(gchar *, lines_to_add + 1);
542 for(count = 0; count < lines_to_add; count++)
543 blanklines[count] = blanks;
544 blanklines[lines_to_add] = NULL;
545 gchar *vertical_blanks = g_strjoinv("\n", blanklines);
550 gtk_text_buffer_insert(buffer, &end, "\n", 1);
552 gtk_text_buffer_insert(buffer, &end, vertical_blanks, -1);
555 // Trim or expand lines
556 if(new_width < win->width) {
557 gtk_text_buffer_get_start_iter(buffer, &start);
561 for(line = 0; line <= new_height; line++) {
563 gtk_text_iter_forward_cursor_positions(&start, new_width);
564 gtk_text_iter_forward_to_line_end(&end);
565 gtk_text_buffer_delete(buffer, &start, &end);
566 gtk_text_iter_forward_line(&start);
569 } else if(new_width > win->width) {
570 gint chars_to_add = new_width - win->width;
571 gchar *horizontal_blanks = g_strnfill(chars_to_add, ' ');
573 gtk_text_buffer_get_start_iter(buffer, &start);
577 for(line = 0; line <= new_height; line++) {
578 gtk_text_iter_forward_to_line_end(&start);
580 gint start_offset = gtk_text_iter_get_offset(&start);
581 gtk_text_buffer_insert(buffer, &end, horizontal_blanks, -1);
582 gtk_text_buffer_get_iter_at_offset(buffer, &start, start_offset);
583 gtk_text_iter_forward_line(&start);
587 g_free(horizontal_blanks);
591 gboolean arrange = !(win->width == new_width && win->height == new_height);
592 win->width = new_width;
593 win->height = new_height;
594 return arrange? win : NULL;
597 /* For non-pair, non-text-grid windows, just give them the size */
598 gtk_widget_size_allocate(win->frame, allocation);
602 /* Overrides gtk_widget_size_allocate */
604 chimara_glk_size_allocate(GtkWidget *widget, GtkAllocation *allocation)
606 g_return_if_fail(widget);
607 g_return_if_fail(allocation);
608 g_return_if_fail(CHIMARA_IS_GLK(widget));
610 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(widget);
612 gtk_widget_set_allocation(widget, allocation);
614 if(priv->root_window) {
616 guint border_width = gtk_container_get_border_width(GTK_CONTAINER(widget));
617 child.x = allocation->x + border_width;
618 child.y = allocation->y + border_width;
619 child.width = CLAMP(allocation->width - 2 * border_width, 0, allocation->width);
620 child.height = CLAMP(allocation->height - 2 * border_width, 0, allocation->height);
621 winid_t arrange = allocate_recurse(priv->root_window->data, &child, priv->spacing);
623 /* arrange points to a window that contains all text grid and graphics
624 windows which have been resized */
625 g_mutex_lock(&priv->arrange_lock);
626 if(!priv->ignore_next_arrange_event)
629 event_throw(CHIMARA_GLK(widget), evtype_Arrange, arrange == priv->root_window->data? NULL : arrange, 0, 0);
632 priv->ignore_next_arrange_event = FALSE;
633 priv->needs_rearrange = FALSE;
634 g_cond_signal(&priv->rearranged);
635 g_mutex_unlock(&priv->arrange_lock);
639 /* Recursively invoke callback() on the GtkWidget of each non-pair window in the tree */
641 forall_recurse(winid_t win, GtkCallback callback, gpointer callback_data)
643 if(win->type == wintype_Pair)
645 forall_recurse(win->window_node->children->data, callback, callback_data);
646 forall_recurse(win->window_node->children->next->data, callback, callback_data);
649 (*callback)(win->frame, callback_data);
652 /* Overrides gtk_container_forall */
654 chimara_glk_forall(GtkContainer *container, gboolean include_internals, GtkCallback callback, gpointer callback_data)
656 g_return_if_fail(container);
657 g_return_if_fail(CHIMARA_IS_GLK(container));
659 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(container);
661 /* All the children are "internal" */
662 if(!include_internals)
665 if(priv->root_window)
666 forall_recurse(priv->root_window->data, callback, callback_data);
670 chimara_glk_stopped(ChimaraGlk *self)
672 CHIMARA_GLK_USE_PRIVATE(self, priv);
673 priv->running = FALSE;
674 priv->program_name = NULL;
675 g_object_notify(G_OBJECT(self), "program-name");
676 priv->program_info = NULL;
677 g_object_notify(G_OBJECT(self), "program-info");
678 priv->story_name = NULL;
679 g_object_notify(G_OBJECT(self), "story-name");
683 chimara_glk_started(ChimaraGlk *self)
685 CHIMARA_GLK_USE_PRIVATE(self, priv);
686 priv->running = TRUE;
690 chimara_glk_waiting(ChimaraGlk *self)
692 /* Default signal handler */
696 chimara_glk_char_input(ChimaraGlk *self, guint window_rock, guint keysym)
698 /* Default signal handler */
702 chimara_glk_line_input(ChimaraGlk *self, guint window_rock, gchar *text)
704 /* Default signal handler */
708 chimara_glk_text_buffer_output(ChimaraGlk *self, guint window_rock, gchar *text)
710 /* Default signal handler */
714 chimara_glk_iliad_screen_update(ChimaraGlk *self, gboolean typing)
716 /* Default signal handler */
720 chimara_glk_class_init(ChimaraGlkClass *klass)
722 /* Override methods of parent classes */
723 GObjectClass *object_class = G_OBJECT_CLASS(klass);
724 object_class->set_property = chimara_glk_set_property;
725 object_class->get_property = chimara_glk_get_property;
726 object_class->finalize = chimara_glk_finalize;
728 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS(klass);
729 widget_class->size_request = chimara_glk_size_request;
730 widget_class->size_allocate = chimara_glk_size_allocate;
732 GtkContainerClass *container_class = GTK_CONTAINER_CLASS(klass);
733 container_class->forall = chimara_glk_forall;
736 klass->stopped = chimara_glk_stopped;
737 klass->started = chimara_glk_started;
738 klass->waiting = chimara_glk_waiting;
739 klass->char_input = chimara_glk_char_input;
740 klass->line_input = chimara_glk_line_input;
741 klass->text_buffer_output = chimara_glk_text_buffer_output;
742 klass->iliad_screen_update = chimara_glk_iliad_screen_update;
745 * ChimaraGlk::stopped:
746 * @glk: The widget that received the signal
748 * Emitted when the a Glk program finishes executing in the widget, whether
749 * it ended normally, or was interrupted.
751 chimara_glk_signals[STOPPED] = g_signal_new("stopped",
752 G_OBJECT_CLASS_TYPE(klass), G_SIGNAL_RUN_FIRST,
753 /* FIXME: Should be G_SIGNAL_RUN_CLEANUP but that segfaults??! */
754 G_STRUCT_OFFSET(ChimaraGlkClass, stopped), NULL, NULL,
755 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
757 * ChimaraGlk::started:
758 * @glk: The widget that received the signal
760 * Emitted when a Glk program starts executing in the widget.
762 chimara_glk_signals[STARTED] = g_signal_new ("started",
763 G_OBJECT_CLASS_TYPE(klass), G_SIGNAL_RUN_FIRST,
764 G_STRUCT_OFFSET(ChimaraGlkClass, started), NULL, NULL,
765 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
767 * ChimaraGlk::waiting:
768 * @glk: The widget that received the signal
770 * Emitted when glk_select() is called by the Glk program and the event
771 * queue is empty, which means that the widget is waiting for input.
773 chimara_glk_signals[WAITING] = g_signal_new("waiting",
774 G_OBJECT_CLASS_TYPE(klass), 0,
775 G_STRUCT_OFFSET(ChimaraGlkClass, waiting), NULL, NULL,
776 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
778 * ChimaraGlk::char-input:
779 * @glk: The widget that received the signal
780 * @window_rock: The rock value of the window that received character input
781 * (see <link linkend="chimara-Rocks">Rocks</link>)
782 * @keysym: The key that was typed, in the form of a key symbol from
783 * <filename class="headerfile">gdk/gdkkeysyms.h</filename>
785 * Emitted when a Glk window receives character input.
787 chimara_glk_signals[CHAR_INPUT] = g_signal_new("char-input",
788 G_OBJECT_CLASS_TYPE(klass), 0,
789 G_STRUCT_OFFSET(ChimaraGlkClass, char_input), NULL, NULL,
790 _chimara_marshal_VOID__UINT_UINT,
791 G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_UINT);
793 * ChimaraGlk::line-input:
794 * @glk: The widget that received the signal
795 * @window_rock: The rock value of the window that received line input (see
796 * <link linkend="chimara-Rocks">Rocks</link>)
797 * @text: The text that was typed
799 * Emitted when a Glk window receives line input.
801 chimara_glk_signals[LINE_INPUT] = g_signal_new("line-input",
802 G_OBJECT_CLASS_TYPE(klass), 0,
803 G_STRUCT_OFFSET(ChimaraGlkClass, line_input), NULL, NULL,
804 _chimara_marshal_VOID__UINT_STRING,
805 G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_STRING);
807 * ChimaraGlk::text-buffer-output:
808 * @glk: The widget that received the signal
809 * @window_rock: The rock value of the window that was printed to (see <link
810 * linkend="chimara-Rocks">Rocks</link>)
812 * Emitted when text is printed to a text buffer window.
814 chimara_glk_signals[TEXT_BUFFER_OUTPUT] = g_signal_new("text-buffer-output",
815 G_OBJECT_CLASS_TYPE(klass), 0,
816 G_STRUCT_OFFSET(ChimaraGlkClass, text_buffer_output), NULL, NULL,
817 _chimara_marshal_VOID__UINT_STRING,
818 G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_STRING);
820 * ChimaraGlk::iliad-screen-update:
821 * @self: The widget that received the signal
822 * @typing: Whether to perform a typing or full screen update
824 * Iliad specific signal which is emitted whenever the screen needs to be updated.
825 * Since iliad screen updates are very slow, updating should only be done when
828 chimara_glk_signals[ILIAD_SCREEN_UPDATE] = g_signal_new("iliad-screen-update",
829 G_OBJECT_CLASS_TYPE(klass), 0,
830 G_STRUCT_OFFSET(ChimaraGlkClass, iliad_screen_update), NULL, NULL,
831 _chimara_marshal_VOID__BOOLEAN,
832 G_TYPE_NONE, 1, G_TYPE_BOOLEAN);
836 * ChimaraGlk:interactive:
838 * Sets whether the widget is interactive. A Glk widget is normally
839 * interactive, but in non-interactive mode, keyboard and mouse input are
840 * ignored and the Glk program is controlled by
841 * chimara_glk_feed_char_input() and chimara_glk_feed_line_input().
842 * <quote>More</quote> prompts when a lot of text is printed to a text
843 * buffer are also disabled. This is typically used when you wish to control
844 * an interpreter program by feeding it a predefined list of commands.
846 g_object_class_install_property( object_class, PROP_INTERACTIVE,
847 g_param_spec_boolean("interactive", _("Interactive"),
848 _("Whether user input is expected in the Glk program"),
850 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
853 * ChimaraGlk:protect:
855 * Sets whether the Glk program is allowed to do file operations. In protect
856 * mode, all file operations will fail.
858 g_object_class_install_property(object_class, PROP_PROTECT,
859 g_param_spec_boolean("protect", _("Protected"),
860 _("Whether the Glk program is barred from doing file operations"),
862 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
865 * ChimaraGlk:spacing:
867 * The amount of space between the Glk windows. This space forms a visible
868 * border between windows; however, if you open a window using the
869 * %winmethod_NoBorder flag, there will be no spacing between it and its
870 * sibling window, no matter what the value of this property is.
872 g_object_class_install_property(object_class, PROP_SPACING,
873 g_param_spec_uint("spacing", _("Spacing"),
874 _("The amount of space between Glk windows"),
876 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
879 * ChimaraGlk:program-name:
881 * The name of the currently running Glk program. You cannot set this
882 * property yourself. It is set to the filename of the plugin when you call
883 * chimara_glk_run(), but the plugin can change it by calling
884 * garglk_set_program_name(). To find out when this information changes,
885 * for example to put the program name in the title bar of a window, connect
886 * to the <code>::notify::program-name</code> signal.
888 g_object_class_install_property(object_class, PROP_PROGRAM_NAME,
889 g_param_spec_string("program-name", _("Program name"),
890 _("Name of the currently running program"),
892 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
895 * ChimaraGlk:program-info:
897 * Information about the currently running Glk program. You cannot set this
898 * property yourself. The plugin can change it by calling
899 * garglk_set_program_info(). See also #ChimaraGlk:program-name.
901 g_object_class_install_property(object_class, PROP_PROGRAM_INFO,
902 g_param_spec_string("program-info", _("Program info"),
903 _("Information about the currently running program"),
905 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
908 * ChimaraGlk:story-name:
910 * The name of the story currently running in the Glk interpreter. You
911 * cannot set this property yourself. It is set to the story filename when
912 * you call chimara_if_run_game(), but the plugin can change it by calling
913 * garglk_set_story_name().
915 * Strictly speaking, this should be a property of #ChimaraIF, but it is
916 * legal for any Glk program to call garglk_set_story_name(), even if it is
917 * not an interpreter and does not load story files.
919 g_object_class_install_property(object_class, PROP_STORY_NAME,
920 g_param_spec_string("story-name", _("Story name"),
921 _("Name of the story currently loaded in the interpreter"),
923 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
926 * ChimaraGlk:running:
928 * Whether this Glk widget is currently running a game or not.
930 g_object_class_install_property(object_class, PROP_RUNNING,
931 g_param_spec_boolean("running", _("Running"),
932 _("Whether there is a program currently running"),
934 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
937 g_type_class_add_private(klass, sizeof(ChimaraGlkPrivate));
940 /* PUBLIC FUNCTIONS */
943 * chimara_error_quark:
945 * The error domain for errors from Chimara widgets.
947 * Returns: The string <quote>chimara-error-quark</quote> as a <link
948 * linkend="GQuark">GQuark</link>.
951 chimara_error_quark(void)
953 chimara_init(); /* This is a library entry point */
954 return g_quark_from_static_string("chimara-error-quark");
960 * Creates and initializes a new #ChimaraGlk widget.
962 * Return value: a #ChimaraGlk widget, with a floating reference.
965 chimara_glk_new(void)
967 /* This is a library entry point; initialize the library */
970 return GTK_WIDGET(g_object_new(CHIMARA_TYPE_GLK, NULL));
974 * chimara_glk_set_interactive:
975 * @glk: a #ChimaraGlk widget
976 * @interactive: whether the widget should expect user input
978 * Sets the #ChimaraGlk:interactive property of @glk.
981 chimara_glk_set_interactive(ChimaraGlk *glk, gboolean interactive)
983 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
985 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
986 priv->interactive = interactive;
987 g_object_notify(G_OBJECT(glk), "interactive");
991 * chimara_glk_get_interactive:
992 * @glk: a #ChimaraGlk widget
994 * Returns whether @glk is interactive (expecting user input). See
995 * #ChimaraGlk:interactive.
997 * Return value: %TRUE if @glk is interactive.
1000 chimara_glk_get_interactive(ChimaraGlk *glk)
1002 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1004 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1005 return priv->interactive;
1009 * chimara_glk_set_protect:
1010 * @glk: a #ChimaraGlk widget
1011 * @protect: whether the widget should allow the Glk program to do file
1014 * Sets the #ChimaraGlk:protect property of @glk. In protect mode, the Glk
1015 * program is not allowed to do file operations.
1018 chimara_glk_set_protect(ChimaraGlk *glk, gboolean protect)
1020 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1022 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1023 priv->protect = protect;
1024 g_object_notify(G_OBJECT(glk), "protect");
1028 * chimara_glk_get_protect:
1029 * @glk: a #ChimaraGlk widget
1031 * Returns whether @glk is in protect mode (banned from doing file operations).
1032 * See #ChimaraGlk:protect.
1034 * Return value: %TRUE if @glk is in protect mode.
1037 chimara_glk_get_protect(ChimaraGlk *glk)
1039 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1041 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1042 return priv->protect;
1046 * chimara_glk_set_css_to_default:
1047 * @glk: a #ChimaraGlk widget
1049 * Resets the styles for text buffer and text grid windows to their defaults.
1051 * This function is not implemented yet.
1055 chimara_glk_set_css_to_default(ChimaraGlk *glk)
1057 reset_default_styles(glk);
1061 * chimara_glk_set_css_from_file:
1062 * @glk: a #ChimaraGlk widget
1063 * @filename: path to a CSS file, or %NULL
1064 * @error: location to store a <link
1065 * linkend="glib-Error-Reporting">GError</link>, or %NULL
1067 * Sets the styles for text buffer and text grid windows according to the CSS
1068 * file @filename. Note that the styles are set cumulatively on top of whatever
1069 * the styles are at the time this function is called; to reset the styles to
1070 * their defaults, use chimara_glk_set_css_to_default().
1072 * Returns: %TRUE on success, %FALSE if an error occurred, in which case @error
1076 chimara_glk_set_css_from_file(ChimaraGlk *glk, const gchar *filename, GError **error)
1078 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1079 g_return_val_if_fail(filename, FALSE);
1080 g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
1082 int fd = open(filename, O_RDONLY);
1085 *error = g_error_new(G_IO_ERROR, g_io_error_from_errno(errno),
1086 _("Error opening file \"%s\": %s"), filename, g_strerror(errno));
1090 GScanner *scanner = create_css_file_scanner();
1091 g_scanner_input_file(scanner, fd);
1092 scanner->input_name = filename;
1093 scan_css_file(scanner, glk);
1095 if(close(fd) == -1) {
1097 *error = g_error_new(G_IO_ERROR, g_io_error_from_errno(errno),
1098 _("Error closing file \"%s\": %s"), filename, g_strerror(errno));
1105 * chimara_glk_set_css_from_string:
1106 * @glk: a #ChimaraGlk widget
1107 * @css: a string containing CSS code
1109 * Sets the styles for text buffer and text grid windows according to the CSS
1110 * code @css. Note that the styles are set cumulatively on top of whatever the
1111 * styles are at the time this function is called; to reset the styles to their
1112 * defaults, use chimara_glk_set_css_to_default().
1115 chimara_glk_set_css_from_string(ChimaraGlk *glk, const gchar *css)
1117 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1118 g_return_if_fail(css || *css);
1120 GScanner *scanner = create_css_file_scanner();
1121 g_scanner_input_text(scanner, css, strlen(css));
1122 scanner->input_name = "<string>";
1123 scan_css_file(scanner, glk);
1127 * chimara_glk_set_spacing:
1128 * @glk: a #ChimaraGlk widget
1129 * @spacing: the number of pixels to put between Glk windows
1131 * Sets the #ChimaraGlk:spacing property of @glk, which is the border width in
1132 * pixels between Glk windows.
1135 chimara_glk_set_spacing(ChimaraGlk *glk, guint spacing)
1137 g_return_if_fail( glk || CHIMARA_IS_GLK(glk) );
1139 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1140 priv->spacing = spacing;
1141 g_object_notify(G_OBJECT(glk), "spacing");
1145 * chimara_glk_get_spacing:
1146 * @glk: a #ChimaraGlk widget
1148 * Gets the value set by chimara_glk_set_spacing().
1150 * Return value: pixels of spacing between Glk windows
1153 chimara_glk_get_spacing(ChimaraGlk *glk)
1155 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), 0);
1157 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1158 return priv->spacing;
1161 struct StartupData {
1162 glk_main_t glk_main;
1163 glkunix_startup_code_t glkunix_startup_code;
1164 glkunix_startup_t args;
1165 ChimaraGlkPrivate *glk_data;
1169 free_startup_data(struct StartupData *startup)
1172 while(i < startup->args.argc)
1173 g_free(startup->args.argv[i++]);
1174 g_free(startup->args.argv);
1175 g_slice_free(struct StartupData, startup);
1178 /* glk_enter() is the actual function called in the new thread in which
1179 glk_main() runs. Takes ownership of @startup and will free it. */
1181 glk_enter(struct StartupData *startup)
1183 extern GPrivate glk_data_key;
1184 g_private_set(&glk_data_key, startup->glk_data);
1186 /* Acquire the Glk thread's references to the input queues */
1187 g_async_queue_ref(startup->glk_data->char_input_queue);
1188 g_async_queue_ref(startup->glk_data->line_input_queue);
1190 /* Run startup function */
1191 if(startup->glkunix_startup_code) {
1192 startup->glk_data->in_startup = TRUE;
1193 int result = startup->glkunix_startup_code(&startup->args);
1194 startup->glk_data->in_startup = FALSE;
1197 free_startup_data(startup);
1202 /* Run main function */
1203 glk_main_t glk_main = startup->glk_main;
1205 g_signal_emit_by_name(startup->glk_data->self, "started");
1208 free_startup_data(startup);
1209 glk_exit(); /* Run shutdown code in glk_exit() even if glk_main() returns normally */
1210 g_assert_not_reached(); /* because glk_exit() calls g_thread_exit() */
1216 * @glk: a #ChimaraGlk widget
1217 * @plugin: path to a plugin module compiled with <filename
1218 * class="header">glk.h</filename>
1219 * @argc: Number of command line arguments in @argv
1220 * @argv: Array of command line arguments to pass to the plugin
1221 * @error: location to store a <link
1222 * linkend="glib-Error-Reporting">GError</link>, or %NULL
1224 * Opens a Glk program compiled as a plugin. Sorts out its command line
1225 * arguments from #glkunix_arguments, calls its startup function
1226 * glkunix_startup_code(), and then calls its main function glk_main() in
1227 * a separate thread. On failure, returns %FALSE and sets @error.
1229 * The plugin must at least export a glk_main() function; #glkunix_arguments and
1230 * glkunix_startup_code() are optional.
1232 * Return value: %TRUE if the Glk program was started successfully.
1235 chimara_glk_run(ChimaraGlk *glk, const gchar *plugin, int argc, char *argv[], GError **error)
1237 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1238 g_return_val_if_fail(plugin, FALSE);
1239 g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
1241 if(chimara_glk_get_running(glk)) {
1242 g_set_error(error, CHIMARA_ERROR, CHIMARA_PLUGIN_ALREADY_RUNNING, _("There was already a plugin running."));
1246 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1248 struct StartupData *startup = g_slice_new0(struct StartupData);
1250 g_assert( g_module_supported() );
1251 /* If there is already a module loaded, free it first -- you see, we want to
1252 * keep modules loaded as long as possible to avoid crashes in stack unwinding */
1253 chimara_glk_unload_plugin(glk);
1254 /* Open the module to run */
1255 priv->program = g_module_open(plugin, G_MODULE_BIND_LAZY);
1259 g_set_error(error, CHIMARA_ERROR, CHIMARA_LOAD_MODULE_ERROR, _("Error opening module: %s"), g_module_error());
1262 if( !g_module_symbol(priv->program, "glk_main", (gpointer *) &startup->glk_main) )
1264 g_set_error(error, CHIMARA_ERROR, CHIMARA_NO_GLK_MAIN, _("Error finding glk_main(): %s"), g_module_error());
1268 if( g_module_symbol(priv->program, "glkunix_startup_code", (gpointer *) &startup->glkunix_startup_code) )
1270 glkunix_argumentlist_t *glkunix_arguments;
1272 if( !(g_module_symbol(priv->program, "glkunix_arguments", (gpointer *) &glkunix_arguments)
1273 && parse_command_line(glkunix_arguments, argc, argv, &startup->args)) )
1275 /* arguments could not be parsed, so create data ourselves */
1276 startup->args.argc = 1;
1277 startup->args.argv = g_new0(gchar *, 1);
1280 /* Set the program invocation name */
1281 startup->args.argv[0] = g_strdup(plugin);
1283 startup->glk_data = priv;
1285 /* Set the program name */
1286 priv->program_name = g_path_get_basename(plugin);
1287 g_object_notify(G_OBJECT(glk), "program-name");
1289 /* Run in a separate thread */
1290 priv->thread = g_thread_try_new("glk", (GThreadFunc)glk_enter, startup, error);
1292 return !(priv->thread == NULL);
1296 * chimara_glk_run_file:
1297 * @self: a #ChimaraGlk widget
1298 * @plugin_file: a #GFile pointing to a plugin module compiled with <filename
1299 * class="header">glk.h</filename>
1300 * @argc: Number of command line arguments in @argv
1301 * @argv: Array of command line arguments to pass to the plugin
1302 * @error: location to store a <link
1303 * linkend="glib-Error-Reporting">GError</link>, or %NULL
1305 * Opens a Glk program compiled as a plugin, from a #GFile. See
1306 * chimara_glk_run() for details.
1308 * Return value: %TRUE if the Glk program was started successfully.
1311 chimara_glk_run_file(ChimaraGlk *self, GFile *plugin_file, int argc, char *argv[], GError **error)
1313 g_return_val_if_fail(self || CHIMARA_IS_GLK(self), FALSE);
1314 g_return_val_if_fail(plugin_file || G_IS_FILE(plugin_file), FALSE);
1315 g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
1317 char *path = g_file_get_path(plugin_file);
1318 gboolean retval = chimara_glk_run(self, path, argc, argv, error);
1326 * @glk: a #ChimaraGlk widget
1328 * Signals the Glk program running in @glk to abort. Note that if the program is
1329 * caught in an infinite loop in which glk_tick() is not called, this may not
1332 * This function does nothing if no Glk program is running.
1335 chimara_glk_stop(ChimaraGlk *glk)
1337 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1338 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1340 /* Don't do anything if not running a program */
1344 if(!priv->after_finalize) {
1345 g_mutex_lock(&priv->abort_lock);
1346 priv->abort_signalled = TRUE;
1347 g_mutex_unlock(&priv->abort_lock);
1348 /* Stop blocking on the event queue condition */
1349 event_throw(glk, evtype_Abort, NULL, 0, 0);
1350 /* Stop blocking on the shutdown key press condition */
1351 g_mutex_lock(&priv->shutdown_lock);
1352 g_cond_signal(&priv->shutdown_key_pressed);
1353 g_mutex_unlock(&priv->shutdown_lock);
1359 * @glk: a #ChimaraGlk widget
1361 * Holds up the main thread and waits for the Glk program running in @glk to
1364 * This function does nothing if no Glk program is running.
1367 chimara_glk_wait(ChimaraGlk *glk)
1369 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1370 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1371 /* Don't do anything if not running a program */
1374 /* Unlock GDK mutex, because the Glk program might need to use it for shutdown */
1375 gdk_threads_leave();
1376 g_thread_join(priv->thread);
1377 gdk_threads_enter();
1381 * chimara_glk_unload_plugin:
1382 * @glk: a #ChimaraGlk widget
1384 * The plugin containing the Glk program is unloaded as late as possible before
1385 * loading a new plugin, in order to prevent crashes while printing stack
1386 * backtraces during debugging. Sometimes this behavior is not desirable. This
1387 * function forces @glk to unload the plugin running in it.
1389 * This function does nothing if there is no plugin loaded.
1392 chimara_glk_unload_plugin(ChimaraGlk *glk)
1394 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1395 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1396 if( priv->program && !g_module_close(priv->program) )
1397 g_warning( "Error closing module :%s", g_module_error() );
1401 * chimara_glk_get_running:
1402 * @glk: a #ChimaraGlk widget
1404 * Use this function to tell whether a program is currently running in the
1407 * Returns: %TRUE if @glk is executing a Glk program, %FALSE otherwise.
1410 chimara_glk_get_running(ChimaraGlk *glk)
1412 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1413 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1414 return priv->running;
1418 * chimara_glk_feed_char_input:
1419 * @glk: a #ChimaraGlk widget
1420 * @keyval: a key symbol as defined in <filename
1421 * class="headerfile">gdk/gdkkeysyms.h</filename>
1423 * Pretend that a key was pressed in the Glk program as a response to a
1424 * character input request. You can call this function even when no window has
1425 * requested character input, in which case the key will be saved for the
1426 * following window that requests character input. This has the disadvantage
1427 * that if more than one window has requested character input, it is arbitrary
1428 * which one gets the key press.
1431 chimara_glk_feed_char_input(ChimaraGlk *glk, guint keyval)
1433 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1434 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1435 g_async_queue_push(priv->char_input_queue, GUINT_TO_POINTER(keyval));
1436 event_throw(glk, evtype_ForcedCharInput, NULL, 0, 0);
1440 * chimara_glk_feed_line_input:
1441 * @glk: a #ChimaraGlk widget
1442 * @text: text to pass to the next line input request
1444 * Pretend that @text was typed in the Glk program as a response to a line input
1445 * request. @text does not need to end with a newline. You can call this
1446 * function even when no window has requested line input, in which case the text
1447 * will be saved for the following window that requests line input. This has the
1448 * disadvantage that if more than one window has requested line input, it is
1449 * arbitrary which one gets the text.
1452 chimara_glk_feed_line_input(ChimaraGlk *glk, const gchar *text)
1454 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1455 g_return_if_fail(text);
1456 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1457 g_async_queue_push(priv->line_input_queue, g_strdup(text));
1458 event_throw(glk, evtype_ForcedLineInput, NULL, 0, 0);
1462 * chimara_glk_is_char_input_pending:
1463 * @glk: a #ChimaraGlk widget
1465 * Use this function to tell if character input forced by
1466 * chimara_glk_feed_char_input() has been passed to an input request or not.
1468 * Returns: %TRUE if forced character input is pending, %FALSE otherwise.
1471 chimara_glk_is_char_input_pending(ChimaraGlk *glk)
1473 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1474 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1475 return g_async_queue_length(priv->char_input_queue) > 0;
1479 * chimara_glk_is_line_input_pending:
1480 * @glk: a #ChimaraGlk widget
1482 * Use this function to tell if line input forced by
1483 * chimara_glk_feed_line_input() has been passed to an input request or not.
1485 * Returns: %TRUE if forced line input is pending, %FALSE otherwise.
1488 chimara_glk_is_line_input_pending(ChimaraGlk *glk)
1490 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1491 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1492 return g_async_queue_length(priv->line_input_queue) > 0;
1496 * chimara_glk_get_tag:
1497 * @glk: a #ChimaraGlk widget
1498 * @window: The type of window to retrieve the tag for
1499 * @name: The name of the tag to retrieve
1501 * Use this function to get a #GtkTextTag so style properties can be changed.
1502 * See also chimara_glk_set_css_from_string().
1504 * The layout of the text in Chimara is controlled by two sets of tags: one set
1505 * describing the style in text buffers and one for text grids. See also the
1506 * Glk specification for the difference between the two. The main narrative of
1507 * a game is usually rendered in text buffers, whereas text grids are mostly
1508 * used for status bars and in game menus.
1510 * The following tag names are supported:
1512 * <listitem><para>normal</para></listitem>
1513 * <listitem><para>emphasized</para></listitem>
1514 * <listitem><para>preformatted</para></listitem>
1515 * <listitem><para>header</para></listitem>
1516 * <listitem><para>subheader</para></listitem>
1517 * <listitem><para>alert</para></listitem>
1518 * <listitem><para>note</para></listitem>
1519 * <listitem><para>block-quote</para></listitem>
1520 * <listitem><para>input</para></listitem>
1521 * <listitem><para>user1</para></listitem>
1522 * <listitem><para>user2</para></listitem>
1523 * <listitem><para>hyperlink</para></listitem>
1524 * <listitem><para>pager</para></listitem>
1527 * Returns: (transfer none): The #GtkTextTag corresponding to @name in the
1528 * styles of @window.
1531 chimara_glk_get_tag(ChimaraGlk *glk, ChimaraGlkWindowType window, const gchar *name)
1533 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1536 case CHIMARA_GLK_TEXT_BUFFER:
1537 return GTK_TEXT_TAG( g_hash_table_lookup(priv->styles->text_buffer, name) );
1539 case CHIMARA_GLK_TEXT_GRID:
1540 return GTK_TEXT_TAG( g_hash_table_lookup(priv->styles->text_grid, name) );
1543 ILLEGAL_PARAM("Unknown window type: %u", window);
1549 * chimara_glk_get_tag_names:
1550 * @glk: a #ChimaraGlk widget
1551 * @num_tags: Return location for the number of tag names retrieved.
1553 * Retrieves the possible tag names to use in chimara_glk_get_tag().
1555 * Returns: (transfer none) (array length=num_tags) (element-type utf8):
1556 * Array of strings containing the tag names. This array is owned by Chimara,
1560 chimara_glk_get_tag_names(ChimaraGlk *glk, unsigned int *num_tags)
1562 g_return_val_if_fail(num_tags != NULL, NULL);
1564 *num_tags = CHIMARA_NUM_STYLES;
1565 return style_get_tag_names();
1569 * chimara_glk_update_style:
1570 * @glk: a #ChimaraGlk widget
1572 * Processes style updates and updates the widget to reflect the new style.
1573 * Call this every time you change a property of a #GtkTextTag retrieved by
1574 * chimara_glk_get_tag().
1577 chimara_glk_update_style(ChimaraGlk *glk)
1579 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1582 /* Schedule a redraw */
1583 g_mutex_lock(&priv->arrange_lock);
1584 priv->needs_rearrange = TRUE;
1585 priv->ignore_next_arrange_event = TRUE;
1586 g_mutex_unlock(&priv->arrange_lock);
1587 gtk_widget_queue_resize( GTK_WIDGET(priv->self) );
1591 * chimara_glk_set_resource_load_callback:
1592 * @glk: a #ChimaraGlk widget
1593 * @func: a function to call for loading resources, or %NULL
1594 * @user_data: user data to pass to @func, or %NULL
1595 * @destroy_user_data: a function to call for freeing @user_data, or %NULL
1597 * Sometimes it is preferable to load image and sound resources from somewhere
1598 * else than a Blorb file, for example while developing a game. Section 14 of
1599 * the <ulink url="http://eblong.com/zarf/blorb/blorb.html#s14">Blorb
1600 * specification</ulink> allows for this possibility. This function sets @func
1601 * to be called when the Glk program requests loading an image or sound without
1602 * a Blorb resource map having been loaded, optionally passing @user_data as an
1605 * Note that @func is only called if no Blorb resource map has been set; having
1606 * a resource map in place overrides this function.
1608 * If you pass non-%NULL for @destroy_user_data, then @glk takes ownership of
1609 * @user_data. When it is not needed anymore, it will be freed by calling
1610 * @destroy_user_data on it. If you wish to retain ownership of @user_data, pass
1611 * %NULL for @destroy_user_data.
1613 * To deactivate the callback, call this function with @func set to %NULL.
1616 chimara_glk_set_resource_load_callback(ChimaraGlk *glk, ChimaraResourceLoadFunc func, gpointer user_data, GDestroyNotify destroy_user_data)
1618 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1620 if(priv->resource_load_callback == func
1621 && priv->resource_load_callback_data == user_data
1622 && priv->resource_load_callback_destroy_data == destroy_user_data)
1625 if(priv->resource_load_callback_destroy_data)
1626 priv->resource_load_callback_destroy_data(priv->resource_load_callback_data);
1628 priv->resource_load_callback = func;
1629 priv->resource_load_callback_data = user_data;
1630 priv->resource_load_callback_destroy_data = destroy_user_data;