1 /* licensing and copyright information here */
11 #include <glib/gi18n-lib.h>
13 #include <pango/pango.h>
14 #include "chimara-glk.h"
15 #include "chimara-glk-private.h"
16 #include "chimara-marshallers.h"
27 #define CHIMARA_GLK_MIN_WIDTH 0
28 #define CHIMARA_GLK_MIN_HEIGHT 0
32 * @short_description: Widget which executes a Glk program
33 * @stability: Unstable
34 * @include: libchimara/chimara-glk.h
36 * The #ChimaraGlk widget opens and runs a Glk program. The program must be
37 * compiled as a plugin module, with a function <function>glk_main()</function>
38 * that the Glk library can hook into.
40 * On Linux systems, this is a file with a name like
41 * <filename>plugin.so</filename>. For portability, you can use libtool and
44 * pkglib_LTLIBRARIES = plugin.la
45 * plugin_la_SOURCES = plugin.c foo.c bar.c
46 * plugin_la_LDFLAGS = -module -shared -avoid-version -export-symbols-regex "^glk_main$$"
48 * This will produce <filename>plugin.la</filename> which is a text file
49 * containing the correct plugin file to open (see the relevant section of the
51 * url="http://www.gnu.org/software/libtool/manual/html_node/Finding-the-dlname.html">
52 * Libtool manual</ulink>).
54 * You need to initialize multithreading in any program you use a #ChimaraGlk
55 * widget in. This means including the following incantation at the beginning
58 * if(!g_thread_supported())
59 * g_thread_init(NULL);
62 * This initialization must take place <emphasis>before</emphasis> the call to
63 * gtk_init(). In addition to this, you must also protect your call to
64 * gtk_main() by calling gdk_threads_enter() right before it, and
65 * gdk_threads_leave() right after it.
67 * The following sample program shows how to initialize and construct a simple
68 * GTK window that runs a Glk program:
71 * #include <gtk/gtk.h>
72 * #include <libchimara/chimara-glk.h>
75 * main(int argc, char *argv[])
77 * GtkWidget *window, *glk;
78 * GError *error = NULL;
79 * gchar *plugin_argv[] = { "plugin.so", "-option" };
81 * /<!---->* Initialize threads and GTK *<!---->/
82 * if(!g_thread_supported())
83 * g_thread_init(NULL);
85 * gtk_init(&argc, &argv);
87 * /<!---->* Construct the window and its contents. We quit the GTK main loop
88 * * when the window's close button is clicked. *<!---->/
89 * window = gtk_window_new(GTK_WINDOW_TOPLEVEL);
90 * g_signal_connect(window, "delete-event", G_CALLBACK(gtk_main_quit), NULL);
91 * glk = chimara_glk_new();
92 * gtk_container_add(GTK_CONTAINER(window), glk);
93 * gtk_widget_show_all(window);
95 * /<!---->* Add a reference to the ChimaraGlk widget, since we want it to
96 * * persist after the window's delete-event -- otherwise it will be destroyed
97 * * with the window. *<!---->/
100 * /<!---->* Start the Glk program in a separate thread *<!---->/
101 * if(!chimara_glk_run(CHIMARA_GLK(glk), "./plugin.so", 2, plugin_argv, &error))
102 * g_error("Error starting Glk library: %s\n", error->message);
104 * /<!---->* Start the GTK main loop *<!---->/
105 * gdk_threads_enter();
107 * gdk_threads_leave();
109 * /<!---->* After the GTK main loop exits, signal the Glk program to shut down if
110 * * it is still running, and wait for it to exit. *<!---->/
111 * chimara_glk_stop(CHIMARA_GLK(glk));
112 * chimara_glk_wait(CHIMARA_GLK(glk));
113 * g_object_unref(glk);
120 typedef void (* glk_main_t) (void);
121 typedef int (* glkunix_startup_code_t) (glkunix_startup_t*);
145 static guint chimara_glk_signals[LAST_SIGNAL] = { 0 };
147 G_DEFINE_TYPE(ChimaraGlk, chimara_glk, GTK_TYPE_CONTAINER);
150 chimara_glk_init(ChimaraGlk *self)
152 GTK_WIDGET_SET_FLAGS(GTK_WIDGET(self), GTK_NO_WINDOW);
154 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(self);
157 priv->interactive = TRUE;
158 priv->protect = FALSE;
159 priv->styles = g_new0(StyleSet,1);
160 priv->glk_styles = g_new0(StyleSet,1);
161 priv->pager_attr_list = pango_attr_list_new();
162 priv->final_message = g_strdup("[ The game has finished ]");
163 priv->running = FALSE;
164 priv->program = NULL;
166 priv->event_queue = g_queue_new();
167 priv->event_lock = g_mutex_new();
168 priv->event_queue_not_empty = g_cond_new();
169 priv->event_queue_not_full = g_cond_new();
170 priv->abort_lock = g_mutex_new();
171 priv->abort_signalled = FALSE;
172 priv->shutdown_lock = g_mutex_new();
173 priv->shutdown_key_pressed = g_cond_new();
174 priv->arrange_lock = g_mutex_new();
175 priv->rearranged = g_cond_new();
176 priv->needs_rearrange = FALSE;
177 priv->ignore_next_arrange_event = FALSE;
178 priv->char_input_queue = g_async_queue_new();
179 priv->line_input_queue = g_async_queue_new();
180 /* Should be g_async_queue_new_full(g_free); but only in GTK >= 2.16 */
181 priv->resource_map = NULL;
182 priv->resource_lock = g_mutex_new();
183 priv->resource_loaded = g_cond_new();
184 priv->resource_info_available = g_cond_new();
185 priv->image_cache = NULL;
186 priv->program_name = NULL;
187 priv->program_info = NULL;
188 priv->story_name = NULL;
189 priv->interrupt_handler = NULL;
190 priv->root_window = NULL;
191 priv->fileref_list = NULL;
192 priv->current_stream = NULL;
193 priv->stream_list = NULL;
195 priv->in_startup = FALSE;
196 priv->current_dir = NULL;
202 chimara_glk_set_property(GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
204 ChimaraGlk *glk = CHIMARA_GLK(object);
208 case PROP_INTERACTIVE:
209 chimara_glk_set_interactive( glk, g_value_get_boolean(value) );
212 chimara_glk_set_protect( glk, g_value_get_boolean(value) );
215 chimara_glk_set_spacing( glk, g_value_get_uint(value) );
218 G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
223 chimara_glk_get_property(GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
225 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(object);
229 case PROP_INTERACTIVE:
230 g_value_set_boolean(value, priv->interactive);
233 g_value_set_boolean(value, priv->protect);
236 g_value_set_uint(value, priv->spacing);
238 case PROP_PROGRAM_NAME:
239 g_value_set_string(value, priv->program_name);
241 case PROP_PROGRAM_INFO:
242 g_value_set_string(value, priv->program_info);
244 case PROP_STORY_NAME:
245 g_value_set_string(value, priv->story_name);
248 G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
253 chimara_glk_finalize(GObject *object)
255 ChimaraGlk *self = CHIMARA_GLK(object);
256 CHIMARA_GLK_USE_PRIVATE(self, priv);
258 /* Free widget properties */
259 g_free(priv->final_message);
261 g_hash_table_destroy(priv->styles->text_buffer);
262 g_hash_table_destroy(priv->styles->text_grid);
263 g_hash_table_destroy(priv->glk_styles->text_buffer);
264 g_hash_table_destroy(priv->glk_styles->text_grid);
265 pango_attr_list_unref(priv->pager_attr_list);
267 /* Free the event queue */
268 g_mutex_lock(priv->event_lock);
269 g_queue_foreach(priv->event_queue, (GFunc)g_free, NULL);
270 g_queue_free(priv->event_queue);
271 g_cond_free(priv->event_queue_not_empty);
272 g_cond_free(priv->event_queue_not_full);
273 priv->event_queue = NULL;
274 g_mutex_unlock(priv->event_lock);
275 g_mutex_free(priv->event_lock);
276 /* Free the abort signaling mechanism */
277 g_mutex_lock(priv->abort_lock);
278 /* Make sure no other thread is busy with this */
279 g_mutex_unlock(priv->abort_lock);
280 g_mutex_free(priv->abort_lock);
281 priv->abort_lock = NULL;
282 /* Free the shutdown keypress signaling mechanism */
283 g_mutex_lock(priv->shutdown_lock);
284 g_cond_free(priv->shutdown_key_pressed);
285 g_mutex_unlock(priv->shutdown_lock);
286 priv->shutdown_lock = NULL;
287 /* Free the window arrangement signaling */
288 g_mutex_lock(priv->arrange_lock);
289 g_cond_free(priv->rearranged);
290 g_mutex_unlock(priv->arrange_lock);
291 g_mutex_free(priv->arrange_lock);
292 priv->arrange_lock = NULL;
293 g_mutex_lock(priv->resource_lock);
294 g_cond_free(priv->resource_loaded);
295 g_cond_free(priv->resource_info_available);
296 g_mutex_unlock(priv->resource_lock);
297 g_mutex_free(priv->resource_lock);
298 g_slist_foreach(priv->image_cache, (GFunc)clear_image_cache, NULL);
299 g_slist_free(priv->image_cache);
300 /* Unref input queues (this should destroy them since any Glk thread has stopped by now */
301 g_async_queue_unref(priv->char_input_queue);
302 g_async_queue_unref(priv->line_input_queue);
304 /* Free other stuff */
305 g_free(priv->current_dir);
306 g_free(priv->program_name);
307 g_free(priv->program_info);
308 g_free(priv->story_name);
309 g_free(priv->styles);
310 g_free(priv->glk_styles);
312 /* Chain up to parent */
313 G_OBJECT_CLASS(chimara_glk_parent_class)->finalize(object);
316 /* Internal function: Recursively get the Glk window tree's size request */
318 request_recurse(winid_t win, GtkRequisition *requisition, guint spacing)
320 if(win->type == wintype_Pair)
322 /* Get children's size requests */
323 GtkRequisition child1, child2;
324 request_recurse(win->window_node->children->data, &child1, spacing);
325 request_recurse(win->window_node->children->next->data, &child2, spacing);
327 glui32 division = win->split_method & winmethod_DivisionMask;
328 glui32 direction = win->split_method & winmethod_DirMask;
330 /* If the split is fixed, get the size of the fixed child */
331 if(division == winmethod_Fixed)
336 child1.width = win->key_window?
337 win->constraint_size * win->key_window->unit_width
340 case winmethod_Right:
341 child2.width = win->key_window?
342 win->constraint_size * win->key_window->unit_width
345 case winmethod_Above:
346 child1.height = win->key_window?
347 win->constraint_size * win->key_window->unit_height
350 case winmethod_Below:
351 child2.height = win->key_window?
352 win->constraint_size * win->key_window->unit_height
358 /* Add the children's requests */
362 case winmethod_Right:
363 requisition->width = child1.width + child2.width + spacing;
364 requisition->height = MAX(child1.height, child2.height);
366 case winmethod_Above:
367 case winmethod_Below:
368 requisition->width = MAX(child1.width, child2.width);
369 requisition->height = child1.height + child2.height + spacing;
374 /* For non-pair windows, just use the size that GTK requests */
376 gtk_widget_size_request(win->frame, requisition);
379 /* Overrides gtk_widget_size_request */
381 chimara_glk_size_request(GtkWidget *widget, GtkRequisition *requisition)
383 g_return_if_fail(widget);
384 g_return_if_fail(requisition);
385 g_return_if_fail(CHIMARA_IS_GLK(widget));
387 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(widget);
389 /* For now, just pass the size request on to the root Glk window */
390 if(priv->root_window)
392 request_recurse(priv->root_window->data, requisition, priv->spacing);
393 requisition->width += 2 * GTK_CONTAINER(widget)->border_width;
394 requisition->height += 2 * GTK_CONTAINER(widget)->border_width;
398 requisition->width = CHIMARA_GLK_MIN_WIDTH + 2 * GTK_CONTAINER(widget)->border_width;
399 requisition->height = CHIMARA_GLK_MIN_HEIGHT + 2 * GTK_CONTAINER(widget)->border_width;
403 /* Recursively give the Glk windows their allocated space. Returns a window
404 containing all children of this window that must be redrawn, or NULL if there
405 are no children that require redrawing. */
407 allocate_recurse(winid_t win, GtkAllocation *allocation, guint spacing)
409 if(win->type == wintype_Pair)
411 glui32 division = win->split_method & winmethod_DivisionMask;
412 glui32 direction = win->split_method & winmethod_DirMask;
414 /* If the space gets too small to honor the spacing property, then just
415 ignore spacing in this window and below. */
416 if( (spacing > allocation->width && (direction == winmethod_Left || direction == winmethod_Right))
417 || (spacing > allocation->height && (direction == winmethod_Above || direction == winmethod_Below)) )
420 GtkAllocation child1, child2;
421 child1.x = allocation->x;
422 child1.y = allocation->y;
424 if(division == winmethod_Fixed)
426 /* If the key window has been closed, then default to 0; otherwise
427 use the key window to determine the size */
431 child1.width = win->key_window?
432 CLAMP(win->constraint_size * win->key_window->unit_width, 0, allocation->width - spacing)
435 case winmethod_Right:
436 child2.width = win->key_window?
437 CLAMP(win->constraint_size * win->key_window->unit_width, 0, allocation->width - spacing)
440 case winmethod_Above:
441 child1.height = win->key_window?
442 CLAMP(win->constraint_size * win->key_window->unit_height, 0, allocation->height - spacing)
445 case winmethod_Below:
446 child2.height = win->key_window?
447 CLAMP(win->constraint_size * win->key_window->unit_height, 0, allocation->height - spacing)
452 else /* proportional */
454 gdouble fraction = win->constraint_size / 100.0;
458 child1.width = MAX(0, (gint)ceil(fraction * (allocation->width - spacing)) );
460 case winmethod_Right:
461 child2.width = MAX(0, (gint)ceil(fraction * (allocation->width - spacing)) );
463 case winmethod_Above:
464 child1.height = MAX(0, (gint)ceil(fraction * (allocation->height - spacing)) );
466 case winmethod_Below:
467 child2.height = MAX(0, (gint)ceil(fraction * (allocation->height - spacing)) );
472 /* Fill in the rest of the size requisitions according to the child specified above */
476 child2.width = MAX(0, allocation->width - spacing - child1.width);
477 child2.x = child1.x + child1.width + spacing;
479 child1.height = child2.height = allocation->height;
481 case winmethod_Right:
482 child1.width = MAX(0, allocation->width - spacing - child2.width);
483 child2.x = child1.x + child1.width + spacing;
485 child1.height = child2.height = allocation->height;
487 case winmethod_Above:
488 child2.height = MAX(0, allocation->height - spacing - child1.height);
490 child2.y = child1.y + child1.height + spacing;
491 child1.width = child2.width = allocation->width;
493 case winmethod_Below:
494 child1.height = MAX(0, allocation->height - spacing - child2.height);
496 child2.y = child1.y + child1.height + spacing;
497 child1.width = child2.width = allocation->width;
502 winid_t arrange1 = allocate_recurse(win->window_node->children->data, &child1, spacing);
503 winid_t arrange2 = allocate_recurse(win->window_node->children->next->data, &child2, spacing);
511 else if(win->type == wintype_TextGrid)
513 /* Pass the size allocation on to the framing widget */
514 gtk_widget_size_allocate(win->frame, allocation);
515 /* It says in the spec that when a text grid window is resized smaller,
516 the bottom or right area is thrown away; when it is resized larger, the
517 bottom or right area is filled with blanks. */
518 glui32 newwidth = (glui32)(win->widget->allocation.width / win->unit_width);
519 glui32 newheight = (glui32)(win->widget->allocation.height / win->unit_height);
521 GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
522 GtkTextIter start, end;
524 for(line = 0; line < win->height; line++)
526 gtk_text_buffer_get_iter_at_line(textbuffer, &start, line);
527 /* If this line is going to fall off the bottom, delete it */
528 if(line >= newheight)
531 gtk_text_iter_forward_to_line_end(&end);
532 gtk_text_iter_forward_char(&end);
533 gtk_text_buffer_delete(textbuffer, &start, &end);
536 /* If this line is not long enough, add spaces on the end */
537 if(newwidth > win->width)
539 gchar *spaces = g_strnfill(newwidth - win->width, ' ');
540 gtk_text_iter_forward_to_line_end(&start);
541 gtk_text_buffer_insert(textbuffer, &start, spaces, -1);
544 /* But if it's too long, delete characters from the end */
545 else if(newwidth < win->width)
548 gtk_text_iter_forward_chars(&start, newwidth);
549 gtk_text_iter_forward_to_line_end(&end);
550 gtk_text_buffer_delete(textbuffer, &start, &end);
552 /* Note: if the widths are equal, do nothing */
554 /* Add blank lines if there aren't enough lines to fit the new size */
555 if(newheight > win->height)
557 gchar *blanks = g_strnfill(win->width, ' ');
558 gchar **blanklines = g_new0(gchar *, (newheight - win->height) + 1);
560 for(count = 0; count < newheight - win->height; count++)
561 blanklines[count] = blanks;
562 blanklines[newheight - win->height] = NULL;
563 gchar *text = g_strjoinv("\n", blanklines);
564 g_free(blanklines); /* not g_strfreev() */
567 gtk_text_buffer_get_end_iter(textbuffer, &start);
568 gtk_text_buffer_insert(textbuffer, &start, "\n", -1);
569 gtk_text_buffer_insert(textbuffer, &start, text, -1);
573 gboolean arrange = !(win->width == newwidth && win->height == newheight);
574 win->width = newwidth;
575 win->height = newheight;
576 return arrange? win : NULL;
579 /* For non-pair, non-text-grid windows, just give them the size */
580 gtk_widget_size_allocate(win->frame, allocation);
584 /* Overrides gtk_widget_size_allocate */
586 chimara_glk_size_allocate(GtkWidget *widget, GtkAllocation *allocation)
588 g_return_if_fail(widget);
589 g_return_if_fail(allocation);
590 g_return_if_fail(CHIMARA_IS_GLK(widget));
592 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(widget);
594 widget->allocation = *allocation;
596 if(priv->root_window) {
598 child.x = allocation->x + GTK_CONTAINER(widget)->border_width;
599 child.y = allocation->y + GTK_CONTAINER(widget)->border_width;
600 child.width = CLAMP(allocation->width - 2 * GTK_CONTAINER(widget)->border_width, 0, allocation->width);
601 child.height = CLAMP(allocation->height - 2 * GTK_CONTAINER(widget)->border_width, 0, allocation->height);
602 winid_t arrange = allocate_recurse(priv->root_window->data, &child, priv->spacing);
604 /* arrange points to a window that contains all text grid and graphics
605 windows which have been resized */
606 g_mutex_lock(priv->arrange_lock);
607 if(!priv->ignore_next_arrange_event)
610 event_throw(CHIMARA_GLK(widget), evtype_Arrange, arrange == priv->root_window->data? NULL : arrange, 0, 0);
613 priv->ignore_next_arrange_event = FALSE;
614 priv->needs_rearrange = FALSE;
615 g_cond_signal(priv->rearranged);
616 g_mutex_unlock(priv->arrange_lock);
620 /* Recursively invoke callback() on the GtkWidget of each non-pair window in the tree */
622 forall_recurse(winid_t win, GtkCallback callback, gpointer callback_data)
624 if(win->type == wintype_Pair)
626 forall_recurse(win->window_node->children->data, callback, callback_data);
627 forall_recurse(win->window_node->children->next->data, callback, callback_data);
630 (*callback)(win->frame, callback_data);
633 /* Overrides gtk_container_forall */
635 chimara_glk_forall(GtkContainer *container, gboolean include_internals, GtkCallback callback, gpointer callback_data)
637 g_return_if_fail(container);
638 g_return_if_fail(CHIMARA_IS_GLK(container));
640 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(container);
642 /* All the children are "internal" */
643 if(!include_internals)
646 if(priv->root_window)
647 forall_recurse(priv->root_window->data, callback, callback_data);
651 chimara_glk_stopped(ChimaraGlk *self)
653 CHIMARA_GLK_USE_PRIVATE(self, priv);
654 priv->running = FALSE;
655 priv->program_name = NULL;
656 g_object_notify(G_OBJECT(self), "program-name");
657 priv->program_info = NULL;
658 g_object_notify(G_OBJECT(self), "program-info");
659 priv->story_name = NULL;
660 g_object_notify(G_OBJECT(self), "story-name");
664 chimara_glk_started(ChimaraGlk *self)
666 CHIMARA_GLK_USE_PRIVATE(self, priv);
667 priv->running = TRUE;
671 chimara_glk_waiting(ChimaraGlk *self)
673 /* Default signal handler */
677 chimara_glk_char_input(ChimaraGlk *self, guint window_rock, guint keysym)
679 /* Default signal handler */
683 chimara_glk_line_input(ChimaraGlk *self, guint window_rock, gchar *text)
685 /* Default signal handler */
689 chimara_glk_text_buffer_output(ChimaraGlk *self, guint window_rock, gchar *text)
691 /* Default signal handler */
695 chimara_glk_iliad_screen_update(ChimaraGlk *self, gboolean typing)
697 /* Default signal handler */
700 /* COMPAT: G_PARAM_STATIC_STRINGS only appeared in GTK 2.13.0 */
701 #ifndef G_PARAM_STATIC_STRINGS
703 /* COMPAT: G_PARAM_STATIC_NAME and friends only appeared in GTK 2.8 */
704 #if GTK_CHECK_VERSION(2,8,0)
705 #define G_PARAM_STATIC_STRINGS (G_PARAM_STATIC_NAME | G_PARAM_STATIC_NICK | G_PARAM_STATIC_BLURB)
707 #define G_PARAM_STATIC_STRINGS (0)
713 chimara_glk_class_init(ChimaraGlkClass *klass)
715 /* Override methods of parent classes */
716 GObjectClass *object_class = G_OBJECT_CLASS(klass);
717 object_class->set_property = chimara_glk_set_property;
718 object_class->get_property = chimara_glk_get_property;
719 object_class->finalize = chimara_glk_finalize;
721 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS(klass);
722 widget_class->size_request = chimara_glk_size_request;
723 widget_class->size_allocate = chimara_glk_size_allocate;
725 GtkContainerClass *container_class = GTK_CONTAINER_CLASS(klass);
726 container_class->forall = chimara_glk_forall;
729 klass->stopped = chimara_glk_stopped;
730 klass->started = chimara_glk_started;
731 klass->waiting = chimara_glk_waiting;
732 klass->char_input = chimara_glk_char_input;
733 klass->line_input = chimara_glk_line_input;
734 klass->text_buffer_output = chimara_glk_text_buffer_output;
735 klass->iliad_screen_update = chimara_glk_iliad_screen_update;
738 * ChimaraGlk::stopped:
739 * @glk: The widget that received the signal
741 * Emitted when the a Glk program finishes executing in the widget, whether
742 * it ended normally, or was interrupted.
744 chimara_glk_signals[STOPPED] = g_signal_new("stopped",
745 G_OBJECT_CLASS_TYPE(klass), G_SIGNAL_RUN_FIRST,
746 /* FIXME: Should be G_SIGNAL_RUN_CLEANUP but that segfaults??! */
747 G_STRUCT_OFFSET(ChimaraGlkClass, stopped), NULL, NULL,
748 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
750 * ChimaraGlk::started:
751 * @glk: The widget that received the signal
753 * Emitted when a Glk program starts executing in the widget.
755 chimara_glk_signals[STARTED] = g_signal_new ("started",
756 G_OBJECT_CLASS_TYPE(klass), G_SIGNAL_RUN_FIRST,
757 G_STRUCT_OFFSET(ChimaraGlkClass, started), NULL, NULL,
758 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
760 * ChimaraGlk::waiting:
761 * @glk: The widget that received the signal
763 * Emitted when glk_select() is called by the Glk program and the event
764 * queue is empty, which means that the widget is waiting for input.
766 chimara_glk_signals[WAITING] = g_signal_new("waiting",
767 G_OBJECT_CLASS_TYPE(klass), 0,
768 G_STRUCT_OFFSET(ChimaraGlkClass, waiting), NULL, NULL,
769 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
771 * ChimaraGlk::char-input:
772 * @glk: The widget that received the signal
773 * @window_rock: The rock value of the window that received character input
774 * (see <link linkend="chimara-Rocks">Rocks</link>)
775 * @keysym: The key that was typed, in the form of a key symbol from
776 * <filename class="headerfile">gdk/gdkkeysyms.h</filename>
778 * Emitted when a Glk window receives character input.
780 chimara_glk_signals[CHAR_INPUT] = g_signal_new("char-input",
781 G_OBJECT_CLASS_TYPE(klass), 0,
782 G_STRUCT_OFFSET(ChimaraGlkClass, char_input), NULL, NULL,
783 _chimara_marshal_VOID__UINT_UINT,
784 G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_UINT);
786 * ChimaraGlk::line-input:
787 * @glk: The widget that received the signal
788 * @window_rock: The rock value of the window that received line input (see
789 * <link linkend="chimara-Rocks">Rocks</link>)
790 * @text: The text that was typed
792 * Emitted when a Glk window receives line input.
794 chimara_glk_signals[LINE_INPUT] = g_signal_new("line-input",
795 G_OBJECT_CLASS_TYPE(klass), 0,
796 G_STRUCT_OFFSET(ChimaraGlkClass, line_input), NULL, NULL,
797 _chimara_marshal_VOID__UINT_STRING,
798 G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_STRING);
800 * ChimaraGlk::text-buffer-output:
801 * @glk: The widget that received the signal
802 * @window_rock: The rock value of the window that was printed to (see <link
803 * linkend="chimara-Rocks">Rocks</link>)
805 * Emitted when text is printed to a text buffer window.
807 chimara_glk_signals[TEXT_BUFFER_OUTPUT] = g_signal_new("text-buffer-output",
808 G_OBJECT_CLASS_TYPE(klass), 0,
809 G_STRUCT_OFFSET(ChimaraGlkClass, text_buffer_output), NULL, NULL,
810 _chimara_marshal_VOID__UINT_STRING,
811 G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_STRING);
813 * ChimaraGlk::iliad-update-screen:
814 * @self: The widget that received the signal
815 * @typing: Whether to perform a typing or full screen update
817 * Iliad specific signal which is emitted whenever the screen needs to be updated.
818 * Since iliad screen updates are very slow, updating should only be done when
821 chimara_glk_signals[ILIAD_SCREEN_UPDATE] = g_signal_new("iliad-screen-update",
822 G_OBJECT_CLASS_TYPE(klass), 0,
823 G_STRUCT_OFFSET(ChimaraGlkClass, iliad_screen_update), NULL, NULL,
824 _chimara_marshal_VOID__BOOLEAN,
825 G_TYPE_NONE, 1, G_TYPE_BOOLEAN);
829 * ChimaraGlk:interactive:
831 * Sets whether the widget is interactive. A Glk widget is normally
832 * interactive, but in non-interactive mode, keyboard and mouse input are
833 * ignored and the Glk program is controlled by
834 * chimara_glk_feed_char_input() and chimara_glk_feed_line_input().
835 * <quote>More</quote> prompts when a lot of text is printed to a text
836 * buffer are also disabled. This is typically used when you wish to control
837 * an interpreter program by feeding it a predefined list of commands.
839 g_object_class_install_property( object_class, PROP_INTERACTIVE,
840 g_param_spec_boolean("interactive", _("Interactive"),
841 _("Whether user input is expected in the Glk program"),
843 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
846 * ChimaraGlk:protect:
848 * Sets whether the Glk program is allowed to do file operations. In protect
849 * mode, all file operations will fail.
851 g_object_class_install_property(object_class, PROP_PROTECT,
852 g_param_spec_boolean("protect", _("Protected"),
853 _("Whether the Glk program is barred from doing file operations"),
855 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
858 * ChimaraGlk:spacing:
860 * The amount of space between the Glk windows.
862 g_object_class_install_property(object_class, PROP_SPACING,
863 g_param_spec_uint("spacing", _("Spacing"),
864 _("The amount of space between Glk windows"),
866 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
869 * ChimaraGlk:program-name:
871 * The name of the currently running Glk program. You cannot set this
872 * property yourself. It is set to the filename of the plugin when you call
873 * chimara_glk_run(), but the plugin can change it by calling
874 * garglk_set_program_name(). To find out when this information changes,
875 * for example to put the program name in the title bar of a window, connect
876 * to the <code>::notify::program-name</code> signal.
878 g_object_class_install_property(object_class, PROP_PROGRAM_NAME,
879 g_param_spec_string("program-name", _("Program name"),
880 _("Name of the currently running program"),
882 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
885 * ChimaraGlk:program-info:
887 * Information about the currently running Glk program. You cannot set this
888 * property yourself. The plugin can change it by calling
889 * garglk_set_program_info(). See also #ChimaraGlk:program-name.
891 g_object_class_install_property(object_class, PROP_PROGRAM_INFO,
892 g_param_spec_string("program-info", _("Program info"),
893 _("Information about the currently running program"),
895 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
898 * ChimaraGlk:story-name:
900 * The name of the story currently running in the Glk interpreter. You
901 * cannot set this property yourself. It is set to the story filename when
902 * you call chimara_if_run_game(), but the plugin can change it by calling
903 * garglk_set_story_name().
905 * Strictly speaking, this should be a property of #ChimaraIF, but it is
906 * legal for any Glk program to call garglk_set_story_name(), even if it is
907 * not an interpreter and does not load story files.
909 g_object_class_install_property(object_class, PROP_STORY_NAME,
910 g_param_spec_string("story-name", _("Story name"),
911 _("Name of the story currently loaded in the interpreter"),
913 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
916 g_type_class_add_private(klass, sizeof(ChimaraGlkPrivate));
919 /* PUBLIC FUNCTIONS */
922 * chimara_error_quark:
924 * The error domain for errors from Chimara widgets.
926 * Returns: The string <quote>chimara-error-quark</quote> as a <link
927 * linkend="GQuark">GQuark</link>.
930 chimara_error_quark(void)
932 chimara_init(); /* This is a library entry point */
933 return g_quark_from_static_string("chimara-error-quark");
939 * Creates and initializes a new #ChimaraGlk widget.
941 * Return value: a #ChimaraGlk widget, with a floating reference.
944 chimara_glk_new(void)
946 /* This is a library entry point; initialize the library */
949 return GTK_WIDGET(g_object_new(CHIMARA_TYPE_GLK, NULL));
953 * chimara_glk_set_interactive:
954 * @glk: a #ChimaraGlk widget
955 * @interactive: whether the widget should expect user input
957 * Sets the #ChimaraGlk:interactive property of @glk.
960 chimara_glk_set_interactive(ChimaraGlk *glk, gboolean interactive)
962 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
964 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
965 priv->interactive = interactive;
966 g_object_notify(G_OBJECT(glk), "interactive");
970 * chimara_glk_get_interactive:
971 * @glk: a #ChimaraGlk widget
973 * Returns whether @glk is interactive (expecting user input). See
974 * #ChimaraGlk:interactive.
976 * Return value: %TRUE if @glk is interactive.
979 chimara_glk_get_interactive(ChimaraGlk *glk)
981 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
983 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
984 return priv->interactive;
988 * chimara_glk_set_protect:
989 * @glk: a #ChimaraGlk widget
990 * @protect: whether the widget should allow the Glk program to do file
993 * Sets the #ChimaraGlk:protect property of @glk. In protect mode, the Glk
994 * program is not allowed to do file operations.
997 chimara_glk_set_protect(ChimaraGlk *glk, gboolean protect)
999 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1001 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1002 priv->protect = protect;
1003 g_object_notify(G_OBJECT(glk), "protect");
1007 * chimara_glk_get_protect:
1008 * @glk: a #ChimaraGlk widget
1010 * Returns whether @glk is in protect mode (banned from doing file operations).
1011 * See #ChimaraGlk:protect.
1013 * Return value: %TRUE if @glk is in protect mode.
1016 chimara_glk_get_protect(ChimaraGlk *glk)
1018 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1020 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1021 return priv->protect;
1025 * chimara_glk_set_css_to_default:
1026 * @glk: a #ChimaraGlk widget
1028 * Resets the styles for text buffer and text grid windows to their defaults.
1030 * This function is not implemented yet.
1034 chimara_glk_set_css_to_default(ChimaraGlk *glk)
1036 reset_default_styles(glk);
1040 * chimara_glk_set_css_from_file:
1041 * @glk: a #ChimaraGlk widget
1042 * @filename: path to a CSS file, or %NULL
1043 * @error: location to store a <link
1044 * linkend="glib-Error-Reporting">GError</link>, or %NULL
1046 * Sets the styles for text buffer and text grid windows according to the CSS
1047 * file @filename. Note that the styles are set cumulatively on top of whatever
1048 * the styles are at the time this function is called; to reset the styles to
1049 * their defaults, use chimara_glk_set_css_to_default().
1051 * Returns: %TRUE on success, %FALSE if an error occurred, in which case @error
1055 chimara_glk_set_css_from_file(ChimaraGlk *glk, const gchar *filename, GError **error)
1057 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1058 g_return_val_if_fail(filename, FALSE);
1059 g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
1061 int fd = open(filename, O_RDONLY);
1063 *error = g_error_new(G_IO_ERROR, g_io_error_from_errno(errno),
1064 _("Error opening file \"%s\": %s"), filename, g_strerror(errno));
1068 GScanner *scanner = create_css_file_scanner();
1069 g_scanner_input_file(scanner, fd);
1070 scanner->input_name = filename;
1071 scan_css_file(scanner, glk);
1073 if(close(fd) == -1) {
1074 *error = g_error_new(G_IO_ERROR, g_io_error_from_errno(errno),
1075 _("Error closing file \"%s\": %s"), filename, g_strerror(errno));
1082 * chimara_glk_set_css_from_string:
1083 * @glk: a #ChimaraGlk widget
1084 * @css: a string containing CSS code
1086 * Sets the styles for text buffer and text grid windows according to the CSS
1087 * code @css. Note that the styles are set cumulatively on top of whatever the
1088 * styles are at the time this function is called; to reset the styles to their
1089 * defaults, use chimara_glk_set_css_to_default().
1092 chimara_glk_set_css_from_string(ChimaraGlk *glk, const gchar *css)
1094 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1095 g_return_if_fail(css || *css);
1097 GScanner *scanner = create_css_file_scanner();
1098 g_scanner_input_text(scanner, css, strlen(css));
1099 scanner->input_name = "<string>";
1100 scan_css_file(scanner, glk);
1104 * chimara_glk_set_spacing:
1105 * @glk: a #ChimaraGlk widget
1106 * @spacing: the number of pixels to put between Glk windows
1108 * Sets the #ChimaraGlk:spacing property of @glk, which is the border width in
1109 * pixels between Glk windows.
1112 chimara_glk_set_spacing(ChimaraGlk *glk, guint spacing)
1114 g_return_if_fail( glk || CHIMARA_IS_GLK(glk) );
1116 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1117 priv->spacing = spacing;
1118 g_object_notify(G_OBJECT(glk), "spacing");
1122 * chimara_glk_get_spacing:
1123 * @glk: a #ChimaraGlk widget
1125 * Gets the value set by chimara_glk_set_spacing().
1127 * Return value: pixels of spacing between Glk windows
1130 chimara_glk_get_spacing(ChimaraGlk *glk)
1132 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), 0);
1134 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1135 return priv->spacing;
1138 struct StartupData {
1139 glk_main_t glk_main;
1140 glkunix_startup_code_t glkunix_startup_code;
1141 glkunix_startup_t args;
1142 ChimaraGlkPrivate *glk_data;
1145 /* glk_enter() is the actual function called in the new thread in which glk_main() runs. */
1147 glk_enter(struct StartupData *startup)
1149 extern GPrivate *glk_data_key;
1150 g_private_set(glk_data_key, startup->glk_data);
1152 /* Acquire the Glk thread's references to the input queues */
1153 g_async_queue_ref(startup->glk_data->char_input_queue);
1154 g_async_queue_ref(startup->glk_data->line_input_queue);
1156 /* Run startup function */
1157 if(startup->glkunix_startup_code) {
1158 startup->glk_data->in_startup = TRUE;
1159 int result = startup->glkunix_startup_code(&startup->args);
1160 startup->glk_data->in_startup = FALSE;
1163 while(i < startup->args.argc)
1164 g_free(startup->args.argv[i++]);
1165 g_free(startup->args.argv);
1171 /* Run main function */
1172 glk_main_t glk_main = startup->glk_main;
1174 /* COMPAT: avoid usage of slices */
1176 g_signal_emit_by_name(startup->glk_data->self, "started");
1178 glk_exit(); /* Run shutdown code in glk_exit() even if glk_main() returns normally */
1179 g_assert_not_reached(); /* because glk_exit() calls g_thread_exit() */
1185 * @glk: a #ChimaraGlk widget
1186 * @plugin: path to a plugin module compiled with <filename
1187 * class="header">glk.h</filename>
1188 * @argc: Number of command line arguments in @argv
1189 * @argv: Array of command line arguments to pass to the plugin
1190 * @error: location to store a <link
1191 * linkend="glib-Error-Reporting">GError</link>, or %NULL
1193 * Opens a Glk program compiled as a plugin. Sorts out its command line
1194 * arguments from #glkunix_arguments, calls its startup function
1195 * glkunix_startup_code(), and then calls its main function glk_main() in
1196 * a separate thread. On failure, returns %FALSE and sets @error.
1198 * The plugin must at least export a glk_main() function; #glkunix_arguments and
1199 * glkunix_startup_code() are optional.
1201 * Return value: %TRUE if the Glk program was started successfully.
1204 chimara_glk_run(ChimaraGlk *glk, const gchar *plugin, int argc, char *argv[], GError **error)
1206 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1207 g_return_val_if_fail(plugin, FALSE);
1208 g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
1210 if(chimara_glk_get_running(glk)) {
1211 g_set_error(error, CHIMARA_ERROR, CHIMARA_PLUGIN_ALREADY_RUNNING, _("There was already a plugin running."));
1215 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1217 /* COMPAT: avoid usage of slices */
1218 struct StartupData *startup = g_new0(struct StartupData,1);
1220 g_assert( g_module_supported() );
1221 /* If there is already a module loaded, free it first -- you see, we want to
1222 * keep modules loaded as long as possible to avoid crashes in stack unwinding */
1223 if( priv->program && !g_module_close(priv->program) )
1224 g_warning( "Error closing module :%s", g_module_error() );
1225 /* Open the module to run */
1226 priv->program = g_module_open(plugin, G_MODULE_BIND_LAZY);
1230 g_set_error(error, CHIMARA_ERROR, CHIMARA_LOAD_MODULE_ERROR, _("Error opening module: %s"), g_module_error());
1233 if( !g_module_symbol(priv->program, "glk_main", (gpointer *) &startup->glk_main) )
1235 g_set_error(error, CHIMARA_ERROR, CHIMARA_NO_GLK_MAIN, _("Error finding glk_main(): %s"), g_module_error());
1239 if( g_module_symbol(priv->program, "glkunix_startup_code", (gpointer *) &startup->glkunix_startup_code) )
1241 glkunix_argumentlist_t *glkunix_arguments;
1243 if( !(g_module_symbol(priv->program, "glkunix_arguments", (gpointer *) &glkunix_arguments)
1244 && parse_command_line(glkunix_arguments, argc, argv, &startup->args)) )
1246 /* arguments could not be parsed, so create data ourselves */
1247 startup->args.argc = 1;
1248 startup->args.argv = g_new0(gchar *, 1);
1251 /* Set the program invocation name */
1252 startup->args.argv[0] = g_strdup(plugin);
1254 startup->glk_data = priv;
1256 /* Set the program name */
1257 priv->program_name = g_path_get_basename(plugin);
1258 g_object_notify(G_OBJECT(glk), "program-name");
1260 /* Run in a separate thread */
1261 priv->thread = g_thread_create((GThreadFunc)glk_enter, startup, TRUE, error);
1263 return !(priv->thread == NULL);
1268 * @glk: a #ChimaraGlk widget
1270 * Signals the Glk program running in @glk to abort. Note that if the program is
1271 * caught in an infinite loop in which glk_tick() is not called, this may not
1275 chimara_glk_stop(ChimaraGlk *glk)
1277 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1278 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1280 /* Don't do anything if not running a program */
1284 if(priv->abort_lock) {
1285 g_mutex_lock(priv->abort_lock);
1286 priv->abort_signalled = TRUE;
1287 g_mutex_unlock(priv->abort_lock);
1288 /* Stop blocking on the event queue condition */
1289 event_throw(glk, evtype_Abort, NULL, 0, 0);
1290 /* Stop blocking on the shutdown key press condition */
1291 g_mutex_lock(priv->shutdown_lock);
1292 g_cond_signal(priv->shutdown_key_pressed);
1293 g_mutex_unlock(priv->shutdown_lock);
1299 * @glk: a #ChimaraGlk widget
1301 * Holds up the main thread and waits for the Glk program running in @glk to
1305 chimara_glk_wait(ChimaraGlk *glk)
1307 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1308 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1309 /* Don't do anything if not running a program */
1312 /* Unlock GDK mutex, because the Glk program might need to use it for shutdown */
1313 gdk_threads_leave();
1314 g_thread_join(priv->thread);
1315 gdk_threads_enter();
1319 * chimara_glk_get_running:
1320 * @glk: a #ChimaraGlk widget
1322 * Use this function to tell whether a program is currently running in the
1325 * Returns: %TRUE if @glk is executing a Glk program, %FALSE otherwise.
1328 chimara_glk_get_running(ChimaraGlk *glk)
1330 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1331 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1332 return priv->running;
1336 * chimara_glk_feed_char_input:
1337 * @glk: a #ChimaraGlk widget
1338 * @keyval: a key symbol as defined in <filename
1339 * class="headerfile">gdk/gdkkeysyms.h</filename>
1341 * Pretend that a key was pressed in the Glk program as a response to a
1342 * character input request. You can call this function even when no window has
1343 * requested character input, in which case the key will be saved for the
1344 * following window that requests character input. This has the disadvantage
1345 * that if more than one window has requested character input, it is arbitrary
1346 * which one gets the key press.
1349 chimara_glk_feed_char_input(ChimaraGlk *glk, guint keyval)
1351 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1352 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1353 g_async_queue_push(priv->char_input_queue, GUINT_TO_POINTER(keyval));
1354 event_throw(glk, evtype_ForcedCharInput, NULL, 0, 0);
1358 * chimara_glk_feed_line_input:
1359 * @glk: a #ChimaraGlk widget
1360 * @text: text to pass to the next line input request
1362 * Pretend that @text was typed in the Glk program as a response to a line input
1363 * request. @text does not need to end with a newline. You can call this
1364 * function even when no window has requested line input, in which case the text
1365 * will be saved for the following window that requests line input. This has the
1366 * disadvantage that if more than one window has requested line input, it is
1367 * arbitrary which one gets the text.
1370 chimara_glk_feed_line_input(ChimaraGlk *glk, const gchar *text)
1372 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1373 g_return_if_fail(text);
1374 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1375 g_async_queue_push(priv->line_input_queue, g_strdup(text));
1376 event_throw(glk, evtype_ForcedLineInput, NULL, 0, 0);
1380 * chimara_glk_is_char_input_pending:
1381 * @glk: a #ChimaraGlk widget
1383 * Use this function to tell if character input forced by
1384 * chimara_glk_feed_char_input() has been passed to an input request or not.
1386 * Returns: %TRUE if forced character input is pending, %FALSE otherwise.
1389 chimara_glk_is_char_input_pending(ChimaraGlk *glk)
1391 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1392 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1393 return g_async_queue_length(priv->char_input_queue) > 0;
1397 * chimara_glk_is_line_input_pending:
1398 * @glk: a #ChimaraGlk widget
1400 * Use this function to tell if line input forced by
1401 * chimara_glk_feed_line_input() has been passed to an input request or not.
1403 * Returns: %TRUE if forced line input is pending, %FALSE otherwise.
1406 chimara_glk_is_line_input_pending(ChimaraGlk *glk)
1408 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1409 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1410 return g_async_queue_length(priv->line_input_queue) > 0;
1414 * chimara_glk_get_tag:
1415 * @glk: a #ChimarGlk widget
1416 * @window: The type of window to retrieve the tag for
1417 * @name: The name of the tag to retrieve
1419 * Use this function to get a #GtkTextTag so style properties can be changed.
1420 * See also #chimara_glk_set_css_from_string.
1422 * The layout of the text in Chimara is controlled by two sets of tags: one set
1423 * describing the style in text buffers and one for text grids. See also the
1424 * GLK specification for the difference between the two. The main narrative of
1425 * a game is usually rendered in text buffers, whereas text grids are mostly
1426 * used for status bars and in game menus.
1428 * The following tag names are supported:
1430 * <listitem><para>normal</para></listitem>
1431 * <listitem><para>emphasized</para></listitem>
1432 * <listitem><para>preformatted</para></listitem>
1433 * <listitem><para>header</para></listitem>
1434 * <listitem><para>subheader</para></listitem>
1435 * <listitem><para>alert</para></listitem>
1436 * <listitem><para>note</para></listitem>
1437 * <listitem><para>block-quote</para></listitem>
1438 * <listitem><para>input</para></listitem>
1439 * <listitem><para>user1</para></listitem>
1440 * <listitem><para>user2</para></listitem>
1441 * <listitem><para>hyperlink</para></listitem>
1442 * <listitem><para>pager</para></listitem>
1446 chimara_glk_get_tag(ChimaraGlk *glk, ChimaraGlkWindowType window, const gchar *name)
1448 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1451 case CHIMARA_GLK_TEXT_BUFFER:
1452 return GTK_TEXT_TAG( g_hash_table_lookup(priv->styles->text_buffer, name) );
1454 case CHIMARA_GLK_TEXT_GRID:
1455 return GTK_TEXT_TAG( g_hash_table_lookup(priv->styles->text_grid, name) );
1458 ILLEGAL_PARAM("Unknown window type: %u", window);
1464 * chimara_glk_get_tag:
1465 * @glk: a #ChimarGlk widget
1467 * Retrieves the possible tag names to use in #chimara_glk_get_tag.
1470 chimara_glk_get_tag_names(ChimaraGlk *glk)
1472 return style_get_tag_names();
1476 * chimara_glk_get_num_tag_names:
1477 * @glk: a #ChimaraGlk widget
1479 * Retrieves the number of style tags returned by #chimara_glk_get_tag_names.
1482 chimara_glk_get_num_tag_names(ChimaraGlk *glk)
1484 return CHIMARA_NUM_STYLES;
1488 * chimara_glk_update_style:
1489 * @glk: a #ChimaraGlk widget
1491 * Processes style updates and updates the widget to reflect the new style.
1492 * Call this every time you change a property of a #GtkTextTag retrieved by
1493 * #chimara_glk_get_tag.
1496 chimara_glk_update_style(ChimaraGlk *glk)
1498 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1501 /* Schedule a redraw */
1502 g_mutex_lock(priv->arrange_lock);
1503 priv->needs_rearrange = TRUE;
1504 priv->ignore_next_arrange_event = TRUE;
1505 g_mutex_unlock(priv->arrange_lock);
1506 gtk_widget_queue_resize( GTK_WIDGET(priv->self) );