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"
26 #define CHIMARA_GLK_MIN_WIDTH 0
27 #define CHIMARA_GLK_MIN_HEIGHT 0
31 * @short_description: Widget which executes a Glk program
32 * @stability: Unstable
33 * @include: libchimara/chimara-glk.h
35 * The #ChimaraGlk widget opens and runs a Glk program. The program must be
36 * compiled as a plugin module, with a function <function>glk_main()</function>
37 * that the Glk library can hook into.
39 * On Linux systems, this is a file with a name like
40 * <filename>plugin.so</filename>. For portability, you can use libtool and
43 * pkglib_LTLIBRARIES = plugin.la
44 * plugin_la_SOURCES = plugin.c foo.c bar.c
45 * plugin_la_LDFLAGS = -module -shared -avoid-version -export-symbols-regex "^glk_main$$"
47 * This will produce <filename>plugin.la</filename> which is a text file
48 * containing the correct plugin file to open (see the relevant section of the
50 * url="http://www.gnu.org/software/libtool/manual/html_node/Finding-the-dlname.html">
51 * Libtool manual</ulink>).
53 * You need to initialize multithreading in any program you use a #ChimaraGlk
54 * widget in. This means including the following incantation at the beginning
57 * if(!g_thread_supported())
58 * g_thread_init(NULL);
61 * This initialization must take place <emphasis>before</emphasis> the call to
62 * gtk_init(). In addition to this, you must also protect your call to
63 * gtk_main() by calling gdk_threads_enter() right before it, and
64 * gdk_threads_leave() right after it.
66 * The following sample program shows how to initialize and construct a simple
67 * GTK window that runs a Glk program:
70 * #include <gtk/gtk.h>
71 * #include <libchimara/chimara-glk.h>
81 * main(int argc, char *argv[])
83 * GtkWidget *window, *glk;
84 * GError *error = NULL;
85 * gchar *plugin_argv[] = { "plugin.so", "-option" };
87 * /<!---->* Initialize threads and GTK *<!---->/
88 * if(!g_thread_supported())
89 * g_thread_init(NULL);
91 * gtk_init(&argc, &argv);
93 * /<!---->* Construct the window and its contents. We quit the GTK main loop
94 * * when the window's close button is clicked. *<!---->/
95 * window = gtk_window_new(GTK_WINDOW_TOPLEVEL);
96 * g_signal_connect(window, "delete-event", G_CALLBACK(quit), NULL);
97 * glk = chimara_glk_new();
98 * gtk_container_add(GTK_CONTAINER(window), glk);
99 * gtk_widget_show_all(window);
101 * /<!---->* Start the Glk program in a separate thread *<!---->/
102 * if(!chimara_glk_run(CHIMARA_GLK(glk), "./plugin.so", 2, plugin_argv, &error))
103 * g_error("Error starting Glk library: %s\n", error->message);
105 * /<!---->* Start the GTK main loop *<!---->/
106 * gdk_threads_enter();
108 * gdk_threads_leave();
110 * /<!---->* After the GTK main loop exits, signal the Glk program to shut down if
111 * * it is still running, and wait for it to exit. *<!---->/
112 * chimara_glk_stop(CHIMARA_GLK(glk));
113 * chimara_glk_wait(CHIMARA_GLK(glk));
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->default_styles = g_new0(StyleSet,1);
160 priv->current_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_lock = g_mutex_new();
182 priv->resource_loaded = g_cond_new();
183 priv->resource_info_available = g_cond_new();
184 priv->image_cache = NULL;
185 priv->program_name = NULL;
186 priv->program_info = NULL;
187 priv->story_name = NULL;
188 priv->interrupt_handler = NULL;
189 priv->root_window = NULL;
190 priv->fileref_list = NULL;
191 priv->current_stream = NULL;
192 priv->stream_list = NULL;
194 priv->in_startup = FALSE;
195 priv->current_dir = NULL;
201 chimara_glk_set_property(GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
203 ChimaraGlk *glk = CHIMARA_GLK(object);
207 case PROP_INTERACTIVE:
208 chimara_glk_set_interactive( glk, g_value_get_boolean(value) );
211 chimara_glk_set_protect( glk, g_value_get_boolean(value) );
214 chimara_glk_set_spacing( glk, g_value_get_uint(value) );
217 G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
222 chimara_glk_get_property(GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
224 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(object);
228 case PROP_INTERACTIVE:
229 g_value_set_boolean(value, priv->interactive);
232 g_value_set_boolean(value, priv->protect);
235 g_value_set_uint(value, priv->spacing);
237 case PROP_PROGRAM_NAME:
238 g_value_set_string(value, priv->program_name);
240 case PROP_PROGRAM_INFO:
241 g_value_set_string(value, priv->program_info);
243 case PROP_STORY_NAME:
244 g_value_set_string(value, priv->story_name);
247 G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
252 chimara_glk_finalize(GObject *object)
254 ChimaraGlk *self = CHIMARA_GLK(object);
255 CHIMARA_GLK_USE_PRIVATE(self, priv);
257 /* Free widget properties */
258 g_free(priv->final_message);
260 g_hash_table_destroy(priv->default_styles->text_buffer);
261 g_hash_table_destroy(priv->default_styles->text_grid);
262 g_hash_table_destroy(priv->current_styles->text_buffer);
263 g_hash_table_destroy(priv->current_styles->text_grid);
264 pango_attr_list_unref(priv->pager_attr_list);
266 /* Free the event queue */
267 g_mutex_lock(priv->event_lock);
268 g_queue_foreach(priv->event_queue, (GFunc)g_free, NULL);
269 g_queue_free(priv->event_queue);
270 g_cond_free(priv->event_queue_not_empty);
271 g_cond_free(priv->event_queue_not_full);
272 priv->event_queue = NULL;
273 g_mutex_unlock(priv->event_lock);
274 g_mutex_free(priv->event_lock);
275 /* Free the abort signaling mechanism */
276 g_mutex_lock(priv->abort_lock);
277 /* Make sure no other thread is busy with this */
278 g_mutex_unlock(priv->abort_lock);
279 g_mutex_free(priv->abort_lock);
280 priv->abort_lock = NULL;
281 /* Free the shutdown keypress signaling mechanism */
282 g_mutex_lock(priv->shutdown_lock);
283 g_cond_free(priv->shutdown_key_pressed);
284 g_mutex_unlock(priv->shutdown_lock);
285 priv->shutdown_lock = NULL;
286 /* Free the window arrangement signaling */
287 g_mutex_lock(priv->arrange_lock);
288 g_cond_free(priv->rearranged);
289 g_mutex_unlock(priv->arrange_lock);
290 g_mutex_free(priv->arrange_lock);
291 priv->arrange_lock = NULL;
292 g_mutex_lock(priv->resource_lock);
293 g_cond_free(priv->resource_loaded);
294 g_cond_free(priv->resource_info_available);
295 g_mutex_unlock(priv->resource_lock);
296 g_mutex_free(priv->resource_lock);
297 g_slist_foreach(priv->image_cache, (GFunc)clear_image_cache, NULL);
298 g_slist_free(priv->image_cache);
299 /* Unref input queues (this should destroy them since any Glk thread has stopped by now */
300 g_async_queue_unref(priv->char_input_queue);
301 g_async_queue_unref(priv->line_input_queue);
303 /* Free other stuff */
304 g_free(priv->current_dir);
305 g_free(priv->program_name);
306 g_free(priv->program_info);
307 g_free(priv->story_name);
309 /* Chain up to parent */
310 G_OBJECT_CLASS(chimara_glk_parent_class)->finalize(object);
313 /* Internal function: Recursively get the Glk window tree's size request */
315 request_recurse(winid_t win, GtkRequisition *requisition, guint spacing)
317 if(win->type == wintype_Pair)
319 /* Get children's size requests */
320 GtkRequisition child1, child2;
321 request_recurse(win->window_node->children->data, &child1, spacing);
322 request_recurse(win->window_node->children->next->data, &child2, spacing);
324 glui32 division = win->split_method & winmethod_DivisionMask;
325 glui32 direction = win->split_method & winmethod_DirMask;
327 /* If the split is fixed, get the size of the fixed child */
328 if(division == winmethod_Fixed)
333 child1.width = win->key_window?
334 win->constraint_size * win->key_window->unit_width
337 case winmethod_Right:
338 child2.width = win->key_window?
339 win->constraint_size * win->key_window->unit_width
342 case winmethod_Above:
343 child1.height = win->key_window?
344 win->constraint_size * win->key_window->unit_height
347 case winmethod_Below:
348 child2.height = win->key_window?
349 win->constraint_size * win->key_window->unit_height
355 /* Add the children's requests */
359 case winmethod_Right:
360 requisition->width = child1.width + child2.width + spacing;
361 requisition->height = MAX(child1.height, child2.height);
363 case winmethod_Above:
364 case winmethod_Below:
365 requisition->width = MAX(child1.width, child2.width);
366 requisition->height = child1.height + child2.height + spacing;
371 /* For non-pair windows, just use the size that GTK requests */
373 gtk_widget_size_request(win->frame, requisition);
376 /* Overrides gtk_widget_size_request */
378 chimara_glk_size_request(GtkWidget *widget, GtkRequisition *requisition)
380 g_return_if_fail(widget);
381 g_return_if_fail(requisition);
382 g_return_if_fail(CHIMARA_IS_GLK(widget));
384 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(widget);
386 /* For now, just pass the size request on to the root Glk window */
387 if(priv->root_window)
389 request_recurse(priv->root_window->data, requisition, priv->spacing);
390 requisition->width += 2 * GTK_CONTAINER(widget)->border_width;
391 requisition->height += 2 * GTK_CONTAINER(widget)->border_width;
395 requisition->width = CHIMARA_GLK_MIN_WIDTH + 2 * GTK_CONTAINER(widget)->border_width;
396 requisition->height = CHIMARA_GLK_MIN_HEIGHT + 2 * GTK_CONTAINER(widget)->border_width;
400 /* Recursively give the Glk windows their allocated space. Returns a window
401 containing all children of this window that must be redrawn, or NULL if there
402 are no children that require redrawing. */
404 allocate_recurse(winid_t win, GtkAllocation *allocation, guint spacing)
406 if(win->type == wintype_Pair)
408 glui32 division = win->split_method & winmethod_DivisionMask;
409 glui32 direction = win->split_method & winmethod_DirMask;
411 /* If the space gets too small to honor the spacing property, then just
412 ignore spacing in this window and below. */
413 if( (spacing > allocation->width && (direction == winmethod_Left || direction == winmethod_Right))
414 || (spacing > allocation->height && (direction == winmethod_Above || direction == winmethod_Below)) )
417 GtkAllocation child1, child2;
418 child1.x = allocation->x;
419 child1.y = allocation->y;
421 if(division == winmethod_Fixed)
423 /* If the key window has been closed, then default to 0; otherwise
424 use the key window to determine the size */
428 child1.width = win->key_window?
429 CLAMP(win->constraint_size * win->key_window->unit_width, 0, allocation->width - spacing)
432 case winmethod_Right:
433 child2.width = win->key_window?
434 CLAMP(win->constraint_size * win->key_window->unit_width, 0, allocation->width - spacing)
437 case winmethod_Above:
438 child1.height = win->key_window?
439 CLAMP(win->constraint_size * win->key_window->unit_height, 0, allocation->height - spacing)
442 case winmethod_Below:
443 child2.height = win->key_window?
444 CLAMP(win->constraint_size * win->key_window->unit_height, 0, allocation->height - spacing)
449 else /* proportional */
451 gdouble fraction = win->constraint_size / 100.0;
455 child1.width = MAX(0, (gint)ceil(fraction * (allocation->width - spacing)) );
457 case winmethod_Right:
458 child2.width = MAX(0, (gint)ceil(fraction * (allocation->width - spacing)) );
460 case winmethod_Above:
461 child1.height = MAX(0, (gint)ceil(fraction * (allocation->height - spacing)) );
463 case winmethod_Below:
464 child2.height = MAX(0, (gint)ceil(fraction * (allocation->height - spacing)) );
469 /* Fill in the rest of the size requisitions according to the child specified above */
473 child2.width = MAX(0, allocation->width - spacing - child1.width);
474 child2.x = child1.x + child1.width + spacing;
476 child1.height = child2.height = allocation->height;
478 case winmethod_Right:
479 child1.width = MAX(0, allocation->width - spacing - child2.width);
480 child2.x = child1.x + child1.width + spacing;
482 child1.height = child2.height = allocation->height;
484 case winmethod_Above:
485 child2.height = MAX(0, allocation->height - spacing - child1.height);
487 child2.y = child1.y + child1.height + spacing;
488 child1.width = child2.width = allocation->width;
490 case winmethod_Below:
491 child1.height = MAX(0, allocation->height - spacing - child2.height);
493 child2.y = child1.y + child1.height + spacing;
494 child1.width = child2.width = allocation->width;
499 winid_t arrange1 = allocate_recurse(win->window_node->children->data, &child1, spacing);
500 winid_t arrange2 = allocate_recurse(win->window_node->children->next->data, &child2, spacing);
508 else if(win->type == wintype_TextGrid)
510 /* Pass the size allocation on to the framing widget */
511 gtk_widget_size_allocate(win->frame, allocation);
512 /* It says in the spec that when a text grid window is resized smaller,
513 the bottom or right area is thrown away; when it is resized larger, the
514 bottom or right area is filled with blanks. */
515 glui32 newwidth = (glui32)(win->widget->allocation.width / win->unit_width);
516 glui32 newheight = (glui32)(win->widget->allocation.height / win->unit_height);
518 GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
519 GtkTextIter start, end;
521 for(line = 0; line < win->height; line++)
523 gtk_text_buffer_get_iter_at_line(textbuffer, &start, line);
524 /* If this line is going to fall off the bottom, delete it */
525 if(line >= newheight)
528 gtk_text_iter_forward_to_line_end(&end);
529 gtk_text_iter_forward_char(&end);
530 gtk_text_buffer_delete(textbuffer, &start, &end);
533 /* If this line is not long enough, add spaces on the end */
534 if(newwidth > win->width)
536 gchar *spaces = g_strnfill(newwidth - win->width, ' ');
537 gtk_text_iter_forward_to_line_end(&start);
538 gtk_text_buffer_insert(textbuffer, &start, spaces, -1);
541 /* But if it's too long, delete characters from the end */
542 else if(newwidth < win->width)
545 gtk_text_iter_forward_chars(&start, newwidth);
546 gtk_text_iter_forward_to_line_end(&end);
547 gtk_text_buffer_delete(textbuffer, &start, &end);
549 /* Note: if the widths are equal, do nothing */
551 /* Add blank lines if there aren't enough lines to fit the new size */
552 if(newheight > win->height)
554 gchar *blanks = g_strnfill(win->width, ' ');
555 gchar **blanklines = g_new0(gchar *, (newheight - win->height) + 1);
557 for(count = 0; count < newheight - win->height; count++)
558 blanklines[count] = blanks;
559 blanklines[newheight - win->height] = NULL;
560 gchar *text = g_strjoinv("\n", blanklines);
561 g_free(blanklines); /* not g_strfreev() */
564 gtk_text_buffer_get_end_iter(textbuffer, &start);
565 gtk_text_buffer_insert(textbuffer, &start, "\n", -1);
566 gtk_text_buffer_insert(textbuffer, &start, text, -1);
570 gboolean arrange = !(win->width == newwidth && win->height == newheight);
571 win->width = newwidth;
572 win->height = newheight;
573 return arrange? win : NULL;
576 /* For non-pair, non-text-grid windows, just give them the size */
577 gtk_widget_size_allocate(win->frame, allocation);
581 /* Overrides gtk_widget_size_allocate */
583 chimara_glk_size_allocate(GtkWidget *widget, GtkAllocation *allocation)
585 g_return_if_fail(widget);
586 g_return_if_fail(allocation);
587 g_return_if_fail(CHIMARA_IS_GLK(widget));
589 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(widget);
591 widget->allocation = *allocation;
593 if(priv->root_window) {
595 child.x = allocation->x + GTK_CONTAINER(widget)->border_width;
596 child.y = allocation->y + GTK_CONTAINER(widget)->border_width;
597 child.width = CLAMP(allocation->width - 2 * GTK_CONTAINER(widget)->border_width, 0, allocation->width);
598 child.height = CLAMP(allocation->height - 2 * GTK_CONTAINER(widget)->border_width, 0, allocation->height);
599 winid_t arrange = allocate_recurse(priv->root_window->data, &child, priv->spacing);
601 /* arrange points to a window that contains all text grid and graphics
602 windows which have been resized */
603 g_mutex_lock(priv->arrange_lock);
604 if(!priv->ignore_next_arrange_event)
607 event_throw(CHIMARA_GLK(widget), evtype_Arrange, arrange == priv->root_window->data? NULL : arrange, 0, 0);
610 priv->ignore_next_arrange_event = FALSE;
611 priv->needs_rearrange = FALSE;
612 g_cond_signal(priv->rearranged);
613 g_mutex_unlock(priv->arrange_lock);
617 /* Recursively invoke callback() on the GtkWidget of each non-pair window in the tree */
619 forall_recurse(winid_t win, GtkCallback callback, gpointer callback_data)
621 if(win->type == wintype_Pair)
623 forall_recurse(win->window_node->children->data, callback, callback_data);
624 forall_recurse(win->window_node->children->next->data, callback, callback_data);
627 (*callback)(win->frame, callback_data);
630 /* Overrides gtk_container_forall */
632 chimara_glk_forall(GtkContainer *container, gboolean include_internals, GtkCallback callback, gpointer callback_data)
634 g_return_if_fail(container);
635 g_return_if_fail(CHIMARA_IS_GLK(container));
637 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(container);
639 /* All the children are "internal" */
640 if(!include_internals)
643 if(priv->root_window)
644 forall_recurse(priv->root_window->data, callback, callback_data);
648 chimara_glk_stopped(ChimaraGlk *self)
650 CHIMARA_GLK_USE_PRIVATE(self, priv);
651 priv->running = FALSE;
652 priv->program_name = NULL;
653 g_object_notify(G_OBJECT(self), "program-name");
654 priv->program_info = NULL;
655 g_object_notify(G_OBJECT(self), "program-info");
656 priv->story_name = NULL;
657 g_object_notify(G_OBJECT(self), "story-name");
661 chimara_glk_started(ChimaraGlk *self)
663 CHIMARA_GLK_USE_PRIVATE(self, priv);
664 priv->running = TRUE;
668 chimara_glk_waiting(ChimaraGlk *self)
670 /* Default signal handler */
674 chimara_glk_char_input(ChimaraGlk *self, guint window_rock, guint keysym)
676 /* Default signal handler */
680 chimara_glk_line_input(ChimaraGlk *self, guint window_rock, gchar *text)
682 /* Default signal handler */
686 chimara_glk_text_buffer_output(ChimaraGlk *self, guint window_rock, gchar *text)
688 /* Default signal handler */
692 chimara_glk_iliad_screen_update(ChimaraGlk *self, gboolean typing)
694 /* Default signal handler */
697 /* COMPAT: G_PARAM_STATIC_STRINGS only appeared in GTK 2.13.0 */
698 #ifndef G_PARAM_STATIC_STRINGS
700 /* COMPAT: G_PARAM_STATIC_NAME and friends only appeared in GTK 2.8 */
701 #if GTK_CHECK_VERSION(2,8,0)
702 #define G_PARAM_STATIC_STRINGS (G_PARAM_STATIC_NAME | G_PARAM_STATIC_NICK | G_PARAM_STATIC_BLURB)
704 #define G_PARAM_STATIC_STRINGS (0)
710 chimara_glk_class_init(ChimaraGlkClass *klass)
712 /* Override methods of parent classes */
713 GObjectClass *object_class = G_OBJECT_CLASS(klass);
714 object_class->set_property = chimara_glk_set_property;
715 object_class->get_property = chimara_glk_get_property;
716 object_class->finalize = chimara_glk_finalize;
718 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS(klass);
719 widget_class->size_request = chimara_glk_size_request;
720 widget_class->size_allocate = chimara_glk_size_allocate;
722 GtkContainerClass *container_class = GTK_CONTAINER_CLASS(klass);
723 container_class->forall = chimara_glk_forall;
726 klass->stopped = chimara_glk_stopped;
727 klass->started = chimara_glk_started;
728 klass->waiting = chimara_glk_waiting;
729 klass->char_input = chimara_glk_char_input;
730 klass->line_input = chimara_glk_line_input;
731 klass->text_buffer_output = chimara_glk_text_buffer_output;
732 klass->iliad_screen_update = chimara_glk_iliad_screen_update;
735 * ChimaraGlk::stopped:
736 * @glk: The widget that received the signal
738 * Emitted when the a Glk program finishes executing in the widget, whether
739 * it ended normally, or was interrupted.
741 chimara_glk_signals[STOPPED] = g_signal_new("stopped",
742 G_OBJECT_CLASS_TYPE(klass), G_SIGNAL_RUN_FIRST,
743 /* FIXME: Should be G_SIGNAL_RUN_CLEANUP but that segfaults??! */
744 G_STRUCT_OFFSET(ChimaraGlkClass, stopped), NULL, NULL,
745 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
747 * ChimaraGlk::started:
748 * @glk: The widget that received the signal
750 * Emitted when a Glk program starts executing in the widget.
752 chimara_glk_signals[STARTED] = g_signal_new ("started",
753 G_OBJECT_CLASS_TYPE(klass), G_SIGNAL_RUN_FIRST,
754 G_STRUCT_OFFSET(ChimaraGlkClass, started), NULL, NULL,
755 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
757 * ChimaraGlk::waiting:
758 * @glk: The widget that received the signal
760 * Emitted when glk_select() is called by the Glk program and the event
761 * queue is empty, which means that the widget is waiting for input.
763 chimara_glk_signals[WAITING] = g_signal_new("waiting",
764 G_OBJECT_CLASS_TYPE(klass), 0,
765 G_STRUCT_OFFSET(ChimaraGlkClass, waiting), NULL, NULL,
766 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
768 * ChimaraGlk::char-input:
769 * @glk: The widget that received the signal
770 * @window_rock: The rock value of the window that received character input
771 * (see <link linkend="chimara-Rocks">Rocks</link>)
772 * @keysym: The key that was typed, in the form of a key symbol from
773 * <filename class="headerfile">gdk/gdkkeysyms.h</filename>
775 * Emitted when a Glk window receives character input.
777 chimara_glk_signals[CHAR_INPUT] = g_signal_new("char-input",
778 G_OBJECT_CLASS_TYPE(klass), 0,
779 G_STRUCT_OFFSET(ChimaraGlkClass, char_input), NULL, NULL,
780 _chimara_marshal_VOID__UINT_UINT,
781 G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_UINT);
783 * ChimaraGlk::line-input:
784 * @glk: The widget that received the signal
785 * @window_rock: The rock value of the window that received line input (see
786 * <link linkend="chimara-Rocks">Rocks</link>)
787 * @text: The text that was typed
789 * Emitted when a Glk window receives line input.
791 chimara_glk_signals[LINE_INPUT] = g_signal_new("line-input",
792 G_OBJECT_CLASS_TYPE(klass), 0,
793 G_STRUCT_OFFSET(ChimaraGlkClass, line_input), NULL, NULL,
794 _chimara_marshal_VOID__UINT_STRING,
795 G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_STRING);
797 * ChimaraGlk::text-buffer-output:
798 * @glk: The widget that received the signal
799 * @window_rock: The rock value of the window that was printed to (see <link
800 * linkend="chimara-Rocks">Rocks</link>)
802 * Emitted when text is printed to a text buffer window.
804 chimara_glk_signals[TEXT_BUFFER_OUTPUT] = g_signal_new("text-buffer-output",
805 G_OBJECT_CLASS_TYPE(klass), 0,
806 G_STRUCT_OFFSET(ChimaraGlkClass, text_buffer_output), NULL, NULL,
807 _chimara_marshal_VOID__UINT_STRING,
808 G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_STRING);
810 * ChimaraGlk::iliad-update-screen:
811 * @self: The widget that received the signal
812 * @typing: Whether to perform a typing or full screen update
814 * Iliad specific signal which is emitted whenever the screen needs to be updated.
815 * Since iliad screen updates are very slow, updating should only be done when
818 chimara_glk_signals[ILIAD_SCREEN_UPDATE] = g_signal_new("iliad-screen-update",
819 G_OBJECT_CLASS_TYPE(klass), 0,
820 G_STRUCT_OFFSET(ChimaraGlkClass, iliad_screen_update), NULL, NULL,
821 _chimara_marshal_VOID__BOOLEAN,
822 G_TYPE_NONE, 1, G_TYPE_BOOLEAN);
826 * ChimaraGlk:interactive:
828 * Sets whether the widget is interactive. A Glk widget is normally
829 * interactive, but in non-interactive mode, keyboard and mouse input are
830 * ignored and the Glk program is controlled by
831 * chimara_glk_feed_char_input() and chimara_glk_feed_line_input().
832 * <quote>More</quote> prompts when a lot of text is printed to a text
833 * buffer are also disabled. This is typically used when you wish to control
834 * an interpreter program by feeding it a predefined list of commands.
836 g_object_class_install_property( object_class, PROP_INTERACTIVE,
837 g_param_spec_boolean("interactive", _("Interactive"),
838 _("Whether user input is expected in the Glk program"),
840 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
843 * ChimaraGlk:protect:
845 * Sets whether the Glk program is allowed to do file operations. In protect
846 * mode, all file operations will fail.
848 g_object_class_install_property(object_class, PROP_PROTECT,
849 g_param_spec_boolean("protect", _("Protected"),
850 _("Whether the Glk program is barred from doing file operations"),
852 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
855 * ChimaraGlk:spacing:
857 * The amount of space between the Glk windows.
859 g_object_class_install_property(object_class, PROP_SPACING,
860 g_param_spec_uint("spacing", _("Spacing"),
861 _("The amount of space between Glk windows"),
863 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
866 * ChimaraGlk:program-name:
868 * The name of the currently running Glk program. You cannot set this
869 * property yourself. It is set to the filename of the plugin when you call
870 * chimara_glk_run(), but the plugin can change it by calling
871 * garglk_set_program_name(). To find out when this information changes,
872 * for example to put the program name in the title bar of a window, connect
873 * to the <code>::notify::program-name</code> signal.
875 g_object_class_install_property(object_class, PROP_PROGRAM_NAME,
876 g_param_spec_string("program-name", _("Program name"),
877 _("Name of the currently running program"),
879 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
882 * ChimaraGlk:program-info:
884 * Information about the currently running Glk program. You cannot set this
885 * property yourself. The plugin can change it by calling
886 * garglk_set_program_info(). See also #ChimaraGlk:program-name.
888 g_object_class_install_property(object_class, PROP_PROGRAM_INFO,
889 g_param_spec_string("program-info", _("Program info"),
890 _("Information about the currently running program"),
892 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
895 * ChimaraGlk:story-name:
897 * The name of the story currently running in the Glk interpreter. You
898 * cannot set this property yourself. It is set to the story filename when
899 * you call chimara_if_run_game(), but the plugin can change it by calling
900 * garglk_set_story_name().
902 * Strictly speaking, this should be a property of #ChimaraIF, but it is
903 * legal for any Glk program to call garglk_set_story_name(), even if it is
904 * not an interpreter and does not load story files.
906 g_object_class_install_property(object_class, PROP_STORY_NAME,
907 g_param_spec_string("story-name", _("Story name"),
908 _("Name of the story currently loaded in the interpreter"),
910 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
913 g_type_class_add_private(klass, sizeof(ChimaraGlkPrivate));
916 /* PUBLIC FUNCTIONS */
919 * chimara_error_quark:
921 * The error domain for errors from Chimara widgets.
923 * Returns: The string <quote>chimara-error-quark</quote> as a <link
924 * linkend="GQuark">GQuark</link>.
927 chimara_error_quark(void)
929 chimara_init(); /* This is a library entry point */
930 return g_quark_from_static_string("chimara-error-quark");
936 * Creates and initializes a new #ChimaraGlk widget.
938 * Return value: a #ChimaraGlk widget, with a floating reference.
941 chimara_glk_new(void)
943 /* This is a library entry point; initialize the library */
946 return GTK_WIDGET(g_object_new(CHIMARA_TYPE_GLK, NULL));
950 * chimara_glk_set_interactive:
951 * @glk: a #ChimaraGlk widget
952 * @interactive: whether the widget should expect user input
954 * Sets the #ChimaraGlk:interactive property of @glk.
957 chimara_glk_set_interactive(ChimaraGlk *glk, gboolean interactive)
959 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
961 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
962 priv->interactive = interactive;
963 g_object_notify(G_OBJECT(glk), "interactive");
967 * chimara_glk_get_interactive:
968 * @glk: a #ChimaraGlk widget
970 * Returns whether @glk is interactive (expecting user input). See
971 * #ChimaraGlk:interactive.
973 * Return value: %TRUE if @glk is interactive.
976 chimara_glk_get_interactive(ChimaraGlk *glk)
978 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
980 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
981 return priv->interactive;
985 * chimara_glk_set_protect:
986 * @glk: a #ChimaraGlk widget
987 * @protect: whether the widget should allow the Glk program to do file
990 * Sets the #ChimaraGlk:protect property of @glk. In protect mode, the Glk
991 * program is not allowed to do file operations.
994 chimara_glk_set_protect(ChimaraGlk *glk, gboolean protect)
996 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
998 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
999 priv->protect = protect;
1000 g_object_notify(G_OBJECT(glk), "protect");
1004 * chimara_glk_get_protect:
1005 * @glk: a #ChimaraGlk widget
1007 * Returns whether @glk is in protect mode (banned from doing file operations).
1008 * See #ChimaraGlk:protect.
1010 * Return value: %TRUE if @glk is in protect mode.
1013 chimara_glk_get_protect(ChimaraGlk *glk)
1015 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1017 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1018 return priv->protect;
1022 * chimara_glk_set_css_to_default:
1023 * @glk: a #ChimaraGlk widget
1025 * Resets the styles for text buffer and text grid windows to their defaults.
1027 * This function is not implemented yet.
1031 chimara_glk_set_css_to_default(ChimaraGlk *glk)
1033 reset_default_styles(glk);
1037 * chimara_glk_set_css_from_file:
1038 * @glk: a #ChimaraGlk widget
1039 * @filename: path to a CSS file, or %NULL
1040 * @error: location to store a <link
1041 * linkend="glib-Error-Reporting">GError</link>, or %NULL
1043 * Sets the styles for text buffer and text grid windows according to the CSS
1044 * file @filename. Note that the styles are set cumulatively on top of whatever
1045 * the styles are at the time this function is called; to reset the styles to
1046 * their defaults, use chimara_glk_set_css_to_default().
1048 * Returns: %TRUE on success, %FALSE if an error occurred, in which case @error
1052 chimara_glk_set_css_from_file(ChimaraGlk *glk, const gchar *filename, GError **error)
1054 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1055 g_return_val_if_fail(filename, FALSE);
1056 g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
1058 int fd = open(filename, O_RDONLY);
1060 *error = g_error_new(G_IO_ERROR, g_io_error_from_errno(errno),
1061 _("Error opening file \"%s\": %s"), filename, g_strerror(errno));
1065 GScanner *scanner = create_css_file_scanner();
1066 g_scanner_input_file(scanner, fd);
1067 scanner->input_name = filename;
1068 scan_css_file(scanner, glk);
1070 /* Set the current style to a copy of the default style */
1071 /* FIXME this is not correct */
1072 copy_default_styles_to_current_styles(glk);
1074 if(close(fd) == -1) {
1075 *error = g_error_new(G_IO_ERROR, g_io_error_from_errno(errno),
1076 _("Error closing file \"%s\": %s"), filename, g_strerror(errno));
1083 * chimara_glk_set_css_from_string:
1084 * @glk: a #ChimaraGlk widget
1085 * @css: a string containing CSS code
1087 * Sets the styles for text buffer and text grid windows according to the CSS
1088 * code @css. Note that the styles are set cumulatively on top of whatever the
1089 * styles are at the time this function is called; to reset the styles to their
1090 * defaults, use chimara_glk_set_css_to_default().
1093 chimara_glk_set_css_from_string(ChimaraGlk *glk, const gchar *css)
1095 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1096 g_return_if_fail(css || *css);
1098 GScanner *scanner = create_css_file_scanner();
1099 g_scanner_input_text(scanner, css, strlen(css));
1100 scanner->input_name = "<string>";
1101 scan_css_file(scanner, glk);
1103 /* Set the current style to a copy of the default style */
1104 /* FIXME this is not correct */
1105 copy_default_styles_to_current_styles(glk);
1109 * chimara_glk_set_spacing:
1110 * @glk: a #ChimaraGlk widget
1111 * @spacing: the number of pixels to put between Glk windows
1113 * Sets the #ChimaraGlk:spacing property of @glk, which is the border width in
1114 * pixels between Glk windows.
1117 chimara_glk_set_spacing(ChimaraGlk *glk, guint spacing)
1119 g_return_if_fail( glk || CHIMARA_IS_GLK(glk) );
1121 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1122 priv->spacing = spacing;
1123 g_object_notify(G_OBJECT(glk), "spacing");
1127 * chimara_glk_get_spacing:
1128 * @glk: a #ChimaraGlk widget
1130 * Gets the value set by chimara_glk_set_spacing().
1132 * Return value: pixels of spacing between Glk windows
1135 chimara_glk_get_spacing(ChimaraGlk *glk)
1137 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), 0);
1139 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1140 return priv->spacing;
1143 struct StartupData {
1144 glk_main_t glk_main;
1145 glkunix_startup_code_t glkunix_startup_code;
1146 glkunix_startup_t args;
1147 ChimaraGlkPrivate *glk_data;
1150 /* glk_enter() is the actual function called in the new thread in which glk_main() runs. */
1152 glk_enter(struct StartupData *startup)
1154 extern GPrivate *glk_data_key;
1155 g_private_set(glk_data_key, startup->glk_data);
1157 /* Acquire the Glk thread's references to the input queues */
1158 g_async_queue_ref(startup->glk_data->char_input_queue);
1159 g_async_queue_ref(startup->glk_data->line_input_queue);
1161 /* Run startup function */
1162 if(startup->glkunix_startup_code) {
1163 startup->glk_data->in_startup = TRUE;
1164 int result = startup->glkunix_startup_code(&startup->args);
1165 startup->glk_data->in_startup = FALSE;
1168 while(i < startup->args.argc)
1169 g_free(startup->args.argv[i++]);
1170 g_free(startup->args.argv);
1176 /* Run main function */
1177 glk_main_t glk_main = startup->glk_main;
1179 /* COMPAT: avoid usage of slices */
1181 g_signal_emit_by_name(startup->glk_data->self, "started");
1183 glk_exit(); /* Run shutdown code in glk_exit() even if glk_main() returns normally */
1184 g_assert_not_reached(); /* because glk_exit() calls g_thread_exit() */
1190 * @glk: a #ChimaraGlk widget
1191 * @plugin: path to a plugin module compiled with <filename
1192 * class="header">glk.h</filename>
1193 * @argc: Number of command line arguments in @argv
1194 * @argv: Array of command line arguments to pass to the plugin
1195 * @error: location to store a <link
1196 * linkend="glib-Error-Reporting">GError</link>, or %NULL
1198 * Opens a Glk program compiled as a plugin. Sorts out its command line
1199 * arguments from #glkunix_arguments, calls its startup function
1200 * glkunix_startup_code(), and then calls its main function glk_main() in
1201 * a separate thread. On failure, returns %FALSE and sets @error.
1203 * The plugin must at least export a glk_main() function; #glkunix_arguments and
1204 * glkunix_startup_code() are optional.
1206 * Return value: %TRUE if the Glk program was started successfully.
1209 chimara_glk_run(ChimaraGlk *glk, const gchar *plugin, int argc, char *argv[], GError **error)
1211 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1212 g_return_val_if_fail(plugin, FALSE);
1213 g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
1215 if(chimara_glk_get_running(glk)) {
1216 g_set_error(error, CHIMARA_ERROR, CHIMARA_PLUGIN_ALREADY_RUNNING, _("There was already a plugin running."));
1220 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1222 /* COMPAT: avoid usage of slices */
1223 struct StartupData *startup = g_new0(struct StartupData,1);
1225 g_assert( g_module_supported() );
1226 /* If there is already a module loaded, free it first -- you see, we want to
1227 * keep modules loaded as long as possible to avoid crashes in stack unwinding */
1228 if( priv->program && !g_module_close(priv->program) )
1229 g_warning( "Error closing module :%s", g_module_error() );
1230 /* Open the module to run */
1231 priv->program = g_module_open(plugin, G_MODULE_BIND_LAZY);
1235 g_set_error(error, CHIMARA_ERROR, CHIMARA_LOAD_MODULE_ERROR, _("Error opening module: %s"), g_module_error());
1238 if( !g_module_symbol(priv->program, "glk_main", (gpointer *) &startup->glk_main) )
1240 g_set_error(error, CHIMARA_ERROR, CHIMARA_NO_GLK_MAIN, _("Error finding glk_main(): %s"), g_module_error());
1244 if( g_module_symbol(priv->program, "glkunix_startup_code", (gpointer *) &startup->glkunix_startup_code) )
1246 glkunix_argumentlist_t *glkunix_arguments;
1248 if( !(g_module_symbol(priv->program, "glkunix_arguments", (gpointer *) &glkunix_arguments)
1249 && parse_command_line(glkunix_arguments, argc, argv, &startup->args)) )
1251 /* arguments could not be parsed, so create data ourselves */
1252 startup->args.argc = 1;
1253 startup->args.argv = g_new0(gchar *, 1);
1256 /* Set the program invocation name */
1257 startup->args.argv[0] = g_strdup(plugin);
1259 startup->glk_data = priv;
1261 /* Set the program name */
1262 priv->program_name = g_path_get_basename(plugin);
1263 g_object_notify(G_OBJECT(glk), "program-name");
1265 /* Run in a separate thread */
1266 priv->thread = g_thread_create((GThreadFunc)glk_enter, startup, TRUE, error);
1268 return !(priv->thread == NULL);
1273 * @glk: a #ChimaraGlk widget
1275 * Signals the Glk program running in @glk to abort. Note that if the program is
1276 * caught in an infinite loop in which glk_tick() is not called, this may not
1280 chimara_glk_stop(ChimaraGlk *glk)
1282 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1283 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1285 /* Don't do anything if not running a program */
1289 if(priv->abort_lock) {
1290 g_mutex_lock(priv->abort_lock);
1291 priv->abort_signalled = TRUE;
1292 g_mutex_unlock(priv->abort_lock);
1293 /* Stop blocking on the event queue condition */
1294 event_throw(glk, evtype_Abort, NULL, 0, 0);
1295 /* Stop blocking on the shutdown key press condition */
1296 g_mutex_lock(priv->shutdown_lock);
1297 g_cond_signal(priv->shutdown_key_pressed);
1298 g_mutex_unlock(priv->shutdown_lock);
1304 * @glk: a #ChimaraGlk widget
1306 * Holds up the main thread and waits for the Glk program running in @glk to
1310 chimara_glk_wait(ChimaraGlk *glk)
1312 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1313 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1314 /* Don't do anything if not running a program */
1317 /* Unlock GDK mutex, because the Glk program might need to use it for shutdown */
1318 gdk_threads_leave();
1319 g_thread_join(priv->thread);
1320 gdk_threads_enter();
1324 * chimara_glk_get_running:
1325 * @glk: a #ChimaraGlk widget
1327 * Use this function to tell whether a program is currently running in the
1330 * Returns: %TRUE if @glk is executing a Glk program, %FALSE otherwise.
1333 chimara_glk_get_running(ChimaraGlk *glk)
1335 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1336 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1337 return priv->running;
1341 * chimara_glk_feed_char_input:
1342 * @glk: a #ChimaraGlk widget
1343 * @keyval: a key symbol as defined in <filename
1344 * class="headerfile">gdk/gdkkeysyms.h</filename>
1346 * Pretend that a key was pressed in the Glk program as a response to a
1347 * character input request. You can call this function even when no window has
1348 * requested character input, in which case the key will be saved for the
1349 * following window that requests character input. This has the disadvantage
1350 * that if more than one window has requested character input, it is arbitrary
1351 * which one gets the key press.
1354 chimara_glk_feed_char_input(ChimaraGlk *glk, guint keyval)
1356 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1357 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1358 g_async_queue_push(priv->char_input_queue, GUINT_TO_POINTER(keyval));
1359 event_throw(glk, evtype_ForcedCharInput, NULL, 0, 0);
1363 * chimara_glk_feed_line_input:
1364 * @glk: a #ChimaraGlk widget
1365 * @text: text to pass to the next line input request
1367 * Pretend that @text was typed in the Glk program as a response to a line input
1368 * request. @text does not need to end with a newline. You can call this
1369 * function even when no window has requested line input, in which case the text
1370 * will be saved for the following window that requests line input. This has the
1371 * disadvantage that if more than one window has requested character input, it
1372 * is arbitrary which one gets the text.
1375 chimara_glk_feed_line_input(ChimaraGlk *glk, const gchar *text)
1377 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1378 g_return_if_fail(text);
1379 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1380 g_async_queue_push(priv->line_input_queue, g_strdup(text));
1381 event_throw(glk, evtype_ForcedLineInput, NULL, 0, 0);