git: Line endings of README.txt
[projects/chimara/chimara.git] / libchimara / chimara-glk.c
1 /* licensing and copyright information here */
2
3 #include <sys/types.h>
4 #include <sys/stat.h>
5 #include <fcntl.h>
6 #include <unistd.h>
7 #include <errno.h>
8 #include <math.h>
9 #include <gtk/gtk.h>
10 #include <config.h>
11 #include <glib/gi18n-lib.h>
12 #include <gmodule.h>
13 #include <pango/pango.h>
14 #include <gio/gio.h>
15 #include "chimara-glk.h"
16 #include "chimara-glk-private.h"
17 #include "chimara-marshallers.h"
18 #include "glk.h"
19 #include "abort.h"
20 #include "stream.h"
21 #include "window.h"
22 #include "glkstart.h"
23 #include "glkunix.h"
24 #include "init.h"
25 #include "magic.h"
26 #include "style.h"
27
28 #define CHIMARA_GLK_MIN_WIDTH 0
29 #define CHIMARA_GLK_MIN_HEIGHT 0
30
31 /**
32  * SECTION:chimara-glk
33  * @short_description: Widget which executes a Glk program
34  * @stability: Unstable
35  * 
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.
39  *
40  * On Linux systems, this is a file with a name like 
41  * <filename>plugin.so</filename>. For portability, you can use libtool and 
42  * automake:
43  * |[
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$$"
47  * ]|
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
50  * <ulink 
51  * url="http://www.gnu.org/software/libtool/manual/html_node/Finding-the-dlname.html">
52  * Libtool manual</ulink>).
53  *
54  * You need to initialize GDK threading in any program you use a #ChimaraGlk
55  * widget in.
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.
60  *
61  * The following sample program shows how to initialize and construct a simple 
62  * GTK window that runs a Glk program:
63  * |[
64  * #include <glib.h>
65  * #include <gtk/gtk.h>
66  * #include <libchimara/chimara-glk.h>
67  *
68  * int
69  * main(int argc, char *argv[])
70  * {
71  *     GtkWidget *window, *glk;
72  *     GError *error = NULL;
73  *     gchar *plugin_argv[] = { "plugin.so", "-option" };
74  *
75  *     /<!---->* Initialize threads and GTK *<!---->/
76  *     gdk_threads_init();
77  *     gtk_init(&argc, &argv);
78  *     
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);
86  *
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. *<!---->/
90  *     g_object_ref(glk);
91  *     
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);
95  *     
96  *     /<!---->* Start the GTK main loop *<!---->/
97  *     gdk_threads_enter();
98  *     gtk_main();
99  *     gdk_threads_leave();
100  *
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);
106  *
107  *     return 0;
108  * }
109  * ]|
110  */
111
112 typedef void (* glk_main_t) (void);
113 typedef int (* glkunix_startup_code_t) (glkunix_startup_t*);
114
115 enum {
116     PROP_0,
117     PROP_INTERACTIVE,
118     PROP_PROTECT,
119         PROP_SPACING,
120         PROP_PROGRAM_NAME,
121         PROP_PROGRAM_INFO,
122         PROP_STORY_NAME,
123         PROP_RUNNING
124 };
125
126 enum {
127         STOPPED,
128         STARTED,
129         WAITING,
130         CHAR_INPUT,
131         LINE_INPUT,
132         TEXT_BUFFER_OUTPUT,
133         ILIAD_SCREEN_UPDATE,
134
135         LAST_SIGNAL
136 };
137
138 static guint chimara_glk_signals[LAST_SIGNAL] = { 0 };
139
140 G_DEFINE_TYPE(ChimaraGlk, chimara_glk, GTK_TYPE_CONTAINER);
141
142 static void
143 chimara_glk_init(ChimaraGlk *self)
144 {
145         chimara_init(); /* This is a library entry point */
146
147     gtk_widget_set_has_window(GTK_WIDGET(self), FALSE);
148
149     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(self);
150     
151     priv->self = 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);
160
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);
166
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);
173
174         style_init(self);
175 }
176
177 static void
178 chimara_glk_set_property(GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
179 {
180     ChimaraGlk *glk = CHIMARA_GLK(object);
181     
182     switch(prop_id) 
183     {
184         case PROP_INTERACTIVE:
185             chimara_glk_set_interactive( glk, g_value_get_boolean(value) );
186             break;
187         case PROP_PROTECT:
188             chimara_glk_set_protect( glk, g_value_get_boolean(value) );
189             break;
190                 case PROP_SPACING:
191                         chimara_glk_set_spacing( glk, g_value_get_uint(value) );
192                         break;
193         default:
194             G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
195     }
196 }
197
198 static void
199 chimara_glk_get_property(GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
200 {
201     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(object);
202     
203     switch(prop_id)
204     {
205         case PROP_INTERACTIVE:
206             g_value_set_boolean(value, priv->interactive);
207             break;
208         case PROP_PROTECT:
209             g_value_set_boolean(value, priv->protect);
210             break;
211                 case PROP_SPACING:
212                         g_value_set_uint(value, priv->spacing);
213                         break;
214                 case PROP_PROGRAM_NAME:
215                         g_value_set_string(value, priv->program_name);
216                         break;
217                 case PROP_PROGRAM_INFO:
218                         g_value_set_string(value, priv->program_info);
219                         break;
220                 case PROP_STORY_NAME:
221                         g_value_set_string(value, priv->story_name);
222                         break;
223                 case PROP_RUNNING:
224                         g_value_set_boolean(value, priv->running);
225                         break;
226                 default:
227             G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
228     }
229 }
230
231 static void
232 chimara_glk_finalize(GObject *object)
233 {
234     ChimaraGlk *self = CHIMARA_GLK(object);
235         CHIMARA_GLK_USE_PRIVATE(self, priv);
236         priv->after_finalize = TRUE;
237
238         /* Free widget properties */
239         g_free(priv->final_message);
240         /* Free styles */
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);
246         
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);
256
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);
262
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);
268
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);
274
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);
288         
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);
296
297         /* Chain up to parent */
298     G_OBJECT_CLASS(chimara_glk_parent_class)->finalize(object);
299 }
300
301 /* Internal function: Recursively get the Glk window tree's size request */
302 static void
303 request_recurse(winid_t win, GtkRequisition *requisition, guint spacing)
304 {
305         if(win->type == wintype_Pair)
306         {
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);
311
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;
315
316                 /* If the split is fixed, get the size of the fixed child */
317                 if(division == winmethod_Fixed)
318                 {
319                         switch(direction)
320                         {
321                                 case winmethod_Left:
322                                         child1.width = win->key_window?
323                                                 win->constraint_size * win->key_window->unit_width
324                                                 : 0;
325                                         break;
326                                 case winmethod_Right:
327                                         child2.width = win->key_window?
328                                                 win->constraint_size * win->key_window->unit_width
329                                                 : 0;
330                                         break;
331                                 case winmethod_Above:
332                                         child1.height = win->key_window?
333                                                 win->constraint_size * win->key_window->unit_height
334                                                 : 0;
335                                         break;
336                                 case winmethod_Below:
337                                         child2.height = win->key_window?
338                                                 win->constraint_size * win->key_window->unit_height
339                                                 : 0;
340                                         break;
341                         }
342                 }
343                 
344                 /* Add the children's requests */
345                 switch(direction)
346                 {
347                         case winmethod_Left:
348                         case winmethod_Right:
349                                 requisition->width = child1.width + child2.width + border;
350                                 requisition->height = MAX(child1.height, child2.height);
351                                 break;
352                         case winmethod_Above:
353                         case winmethod_Below:
354                                 requisition->width = MAX(child1.width, child2.width);
355                                 requisition->height = child1.height + child2.height + border;
356                                 break;
357                 }
358         }
359         
360         /* For non-pair windows, just use the size that GTK requests */
361         else
362                 gtk_widget_size_request(win->frame, requisition);
363 }
364
365 /* Overrides gtk_widget_size_request */
366 static void
367 chimara_glk_size_request(GtkWidget *widget, GtkRequisition *requisition)
368 {
369     g_return_if_fail(widget);
370     g_return_if_fail(requisition);
371     g_return_if_fail(CHIMARA_IS_GLK(widget));
372     
373     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(widget);
374     
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) 
378         {
379                 request_recurse(priv->root_window->data, requisition, priv->spacing);
380                 requisition->width += 2 * border_width;
381                 requisition->height += 2 * border_width;
382         } 
383         else 
384         {
385         requisition->width = CHIMARA_GLK_MIN_WIDTH + 2 * border_width;
386         requisition->height = CHIMARA_GLK_MIN_HEIGHT + 2 * border_width;
387     }
388 }
389
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. */
393 static winid_t
394 allocate_recurse(winid_t win, GtkAllocation *allocation, guint spacing)
395 {
396         if(win->type == wintype_Pair)
397         {
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;
401
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)) )
406                         border = 0;
407                 
408                 GtkAllocation child1, child2;
409                 child1.x = allocation->x;
410                 child1.y = allocation->y;
411                 
412                 if(division == winmethod_Fixed)
413                 {
414                         /* If the key window has been closed, then default to 0; otherwise
415                          use the key window to determine the size */
416                         switch(direction)
417                         {
418                                 case winmethod_Left:
419                                         child1.width = win->key_window? 
420                                                 CLAMP(win->constraint_size * win->key_window->unit_width, 0, allocation->width - border) 
421                                                 : 0;
422                                         break;
423                                 case winmethod_Right:
424                                         child2.width = win->key_window? 
425                                                 CLAMP(win->constraint_size * win->key_window->unit_width, 0, allocation->width - border)
426                                                 : 0;
427                                         break;
428                                 case winmethod_Above:
429                                         child1.height = win->key_window? 
430                                                 CLAMP(win->constraint_size * win->key_window->unit_height, 0, allocation->height - border)
431                                                 : 0;
432                                         break;
433                                 case winmethod_Below:
434                                         child2.height = win->key_window?
435                                                 CLAMP(win->constraint_size * win->key_window->unit_height, 0, allocation->height - border)
436                                                 : 0;
437                                         break;
438                         }
439                 }
440                 else /* proportional */
441                 {
442                         gdouble fraction = win->constraint_size / 100.0;
443                         switch(direction)
444                         {
445                                 case winmethod_Left:
446                                         child1.width = MAX(0, (gint)ceil(fraction * (allocation->width - border)) );
447                                         break;
448                                 case winmethod_Right:
449                                         child2.width = MAX(0, (gint)ceil(fraction * (allocation->width - border)) );
450                                         break;
451                                 case winmethod_Above:
452                                         child1.height = MAX(0, (gint)ceil(fraction * (allocation->height - border)) );
453                                         break;
454                                 case winmethod_Below:
455                                         child2.height = MAX(0, (gint)ceil(fraction * (allocation->height - border)) );
456                                         break;
457                         }
458                 }
459                 
460                 /* Fill in the rest of the size requisitions according to the child specified above */
461                 switch(direction)
462                 {
463                         case winmethod_Left:
464                                 child2.width = MAX(0, allocation->width - border - child1.width);
465                                 child2.x = child1.x + child1.width + border;
466                                 child2.y = child1.y;
467                                 child1.height = child2.height = allocation->height;
468                                 break;
469                         case winmethod_Right:
470                                 child1.width = MAX(0, allocation->width - border - child2.width);
471                                 child2.x = child1.x + child1.width + border;
472                                 child2.y = child1.y;
473                                 child1.height = child2.height = allocation->height;
474                                 break;
475                         case winmethod_Above:
476                                 child2.height = MAX(0, allocation->height - border - child1.height);
477                                 child2.x = child1.x;
478                                 child2.y = child1.y + child1.height + border;
479                                 child1.width = child2.width = allocation->width;
480                                 break;
481                         case winmethod_Below:
482                                 child1.height = MAX(0, allocation->height - border - child2.height);
483                                 child2.x = child1.x;
484                                 child2.y = child1.y + child1.height + border;
485                                 child1.width = child2.width = allocation->width;
486                                 break;
487                 }
488                 
489                 /* Recurse */
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);
492                 if(arrange1 == NULL)
493                         return arrange2;
494                 if(arrange2 == NULL)
495                         return arrange1;
496                 return win;
497         }
498         
499         else if(win->type == wintype_TextGrid)
500         {
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);
510
511                 if(new_width != win->width || new_height != win->height)
512                 {
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;
516
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);
522                         }
523                         else if(new_height < win->height)
524                         {
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);
530
531                         }
532                         else if(new_height > win->height)
533                         {
534                                 // Add extra lines
535                                 gint lines_to_add = new_height - win->height;
536                                 gtk_text_buffer_get_end_iter(buffer, &end);
537                                 start = end;
538
539                                 gchar *blanks = g_strnfill(win->width, ' ');
540                                 gchar **blanklines = g_new0(gchar *, lines_to_add + 1);
541                                 int count;
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);
546                                 g_free(blanklines); 
547                                 g_free(blanks);
548
549                                 if(win->height > 0) 
550                                         gtk_text_buffer_insert(buffer, &end, "\n", 1);
551
552                                 gtk_text_buffer_insert(buffer, &end, vertical_blanks, -1);
553                         }
554
555                         // Trim or expand lines
556                         if(new_width < win->width) {
557                                 gtk_text_buffer_get_start_iter(buffer, &start);
558                                 end = start;
559
560                                 gint line;
561                                 for(line = 0; line <= new_height; line++) {
562                                         // Trim the 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);
567                                         end = start;
568                                 }
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, ' ');
572
573                                 gtk_text_buffer_get_start_iter(buffer, &start);
574                                 end = start;
575
576                                 gint line;
577                                 for(line = 0; line <= new_height; line++) {
578                                         gtk_text_iter_forward_to_line_end(&start);
579                                         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);
584                                         end = start;
585                                 }
586
587                                 g_free(horizontal_blanks);
588                         }
589                 }
590         
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;
595         }
596         
597         /* For non-pair, non-text-grid windows, just give them the size */
598         gtk_widget_size_allocate(win->frame, allocation);
599         return NULL;
600 }
601
602 /* Overrides gtk_widget_size_allocate */
603 static void
604 chimara_glk_size_allocate(GtkWidget *widget, GtkAllocation *allocation)
605 {
606     g_return_if_fail(widget);
607     g_return_if_fail(allocation);
608     g_return_if_fail(CHIMARA_IS_GLK(widget));
609     
610     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(widget);
611     
612     gtk_widget_set_allocation(widget, allocation);
613             
614     if(priv->root_window) {
615                 GtkAllocation child;
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);
622                 
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)
627                 {
628                         if(arrange)
629                                 event_throw(CHIMARA_GLK(widget), evtype_Arrange, arrange == priv->root_window->data? NULL : arrange, 0, 0);
630                 }
631                 else
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);
636         }
637 }
638
639 /* Recursively invoke callback() on the GtkWidget of each non-pair window in the tree */
640 static void
641 forall_recurse(winid_t win, GtkCallback callback, gpointer callback_data)
642 {
643         if(win->type == wintype_Pair)
644         {
645                 forall_recurse(win->window_node->children->data, callback, callback_data);
646                 forall_recurse(win->window_node->children->next->data, callback, callback_data);
647         }
648         else
649                 (*callback)(win->frame, callback_data);
650 }
651
652 /* Overrides gtk_container_forall */
653 static void
654 chimara_glk_forall(GtkContainer *container, gboolean include_internals, GtkCallback callback, gpointer callback_data)
655 {
656     g_return_if_fail(container);
657     g_return_if_fail(CHIMARA_IS_GLK(container));
658     
659     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(container);
660     
661         /* All the children are "internal" */
662         if(!include_internals)
663                 return;
664         
665     if(priv->root_window)
666                 forall_recurse(priv->root_window->data, callback, callback_data);
667 }
668
669 static void
670 chimara_glk_stopped(ChimaraGlk *self)
671 {
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");
680 }
681
682 static void
683 chimara_glk_started(ChimaraGlk *self)
684 {
685         CHIMARA_GLK_USE_PRIVATE(self, priv);
686         priv->running = TRUE;
687 }
688
689 static void
690 chimara_glk_class_init(ChimaraGlkClass *klass)
691 {
692     /* Override methods of parent classes */
693     GObjectClass *object_class = G_OBJECT_CLASS(klass);
694     object_class->set_property = chimara_glk_set_property;
695     object_class->get_property = chimara_glk_get_property;
696     object_class->finalize = chimara_glk_finalize;
697     
698     GtkWidgetClass *widget_class = GTK_WIDGET_CLASS(klass);
699     widget_class->size_request = chimara_glk_size_request;
700     widget_class->size_allocate = chimara_glk_size_allocate;
701
702     GtkContainerClass *container_class = GTK_CONTAINER_CLASS(klass);
703     container_class->forall = chimara_glk_forall;
704
705     /* Signals */
706     klass->stopped = chimara_glk_stopped;
707     klass->started = chimara_glk_started;
708
709     /**
710      * ChimaraGlk::stopped:
711      * @glk: The widget that received the signal
712      *
713      * Emitted when the a Glk program finishes executing in the widget, whether
714      * it ended normally, or was interrupted.
715      */ 
716     chimara_glk_signals[STOPPED] = g_signal_new("stopped", 
717         G_OBJECT_CLASS_TYPE(klass), G_SIGNAL_RUN_FIRST, 
718         /* FIXME: Should be G_SIGNAL_RUN_CLEANUP but that segfaults??! */
719         G_STRUCT_OFFSET(ChimaraGlkClass, stopped), NULL, NULL,
720                 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
721         /**
722          * ChimaraGlk::started:
723          * @glk: The widget that received the signal
724          *
725          * Emitted when a Glk program starts executing in the widget.
726          */
727         chimara_glk_signals[STARTED] = g_signal_new ("started",
728                 G_OBJECT_CLASS_TYPE(klass), G_SIGNAL_RUN_FIRST,
729                 G_STRUCT_OFFSET(ChimaraGlkClass, started), NULL, NULL,
730                 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
731         /**
732          * ChimaraGlk::waiting:
733          * @glk: The widget that received the signal
734          * 
735          * Emitted when glk_select() is called by the Glk program and the event
736          * queue is empty, which means that the widget is waiting for input.
737          */
738         chimara_glk_signals[WAITING] = g_signal_new("waiting",
739                 G_OBJECT_CLASS_TYPE(klass), 0,
740                 G_STRUCT_OFFSET(ChimaraGlkClass, waiting), NULL, NULL,
741                 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
742         /**
743          * ChimaraGlk::char-input:
744          * @self: The widget that received the signal
745          * @window_rock: The rock value of the window that received character input
746          * (see <link linkend="chimara-Rocks">Rocks</link>)
747          * @window_id_string: A string value uniquely identifying the window that
748          * received character input
749          * @keysym: The key that was typed, in the form of a key symbol from
750          * <filename class="headerfile">gdk/gdkkeysyms.h</filename>
751          *
752          * Emitted when a Glk window receives character input.
753          * The @window_rock can be used to identify the window.
754          * However, rock values in Glk are allowed to be identical for different
755          * windows, so Chimara also provides a string value with which the window
756          * can be uniquely identified.
757          */
758         chimara_glk_signals[CHAR_INPUT] = g_signal_new("char-input",
759                 G_OBJECT_CLASS_TYPE(klass), 0,
760                 G_STRUCT_OFFSET(ChimaraGlkClass, char_input), NULL, NULL,
761                 _chimara_marshal_VOID__UINT_STRING_UINT,
762                 G_TYPE_NONE, 3, G_TYPE_UINT, G_TYPE_STRING, G_TYPE_UINT);
763         /**
764          * ChimaraGlk::line-input:
765          * @self: The widget that received the signal
766          * @window_rock: The rock value of the window that received line input (see
767          * <link linkend="chimara-Rocks">Rocks</link>)
768          * @window_id_string: A string value uniquely identifying the window that
769          * received the input
770          * @text: The text that was typed
771          *
772          * Emitted when a Glk window receives line input.
773          * The @window_rock can be used to identify the window.
774          * However, rock values in Glk are allowed to be identical for different
775          * windows, so Chimara also provides a string value with which the window
776          * can be uniquely identified.
777          */
778         chimara_glk_signals[LINE_INPUT] = g_signal_new("line-input",
779                 G_OBJECT_CLASS_TYPE(klass), 0,
780                 G_STRUCT_OFFSET(ChimaraGlkClass, line_input), NULL, NULL,
781                 _chimara_marshal_VOID__UINT_STRING_STRING,
782                 G_TYPE_NONE, 3, G_TYPE_UINT, G_TYPE_STRING, G_TYPE_STRING);
783         /**
784          * ChimaraGlk::text-buffer-output:
785          * @self: The widget that received the signal
786          * @window_rock: The rock value of the window that was printed to (see <link
787          * linkend="chimara-Rocks">Rocks</link>)
788          * @window_id_string: A string value uniquely identifying the window that
789          * was printed to
790          *
791          * Emitted when text is printed to a text buffer window.
792          * The @window_rock can be used to identify the window.
793          * However, rock values in Glk are allowed to be identical for different
794          * windows, so Chimara also provides a string value with which the window
795          * can be uniquely identified.
796          */
797         chimara_glk_signals[TEXT_BUFFER_OUTPUT] = g_signal_new("text-buffer-output",
798                 G_OBJECT_CLASS_TYPE(klass), 0,
799                 G_STRUCT_OFFSET(ChimaraGlkClass, text_buffer_output), NULL, NULL,
800                 _chimara_marshal_VOID__UINT_STRING_STRING,
801                 G_TYPE_NONE, 3, G_TYPE_UINT, G_TYPE_STRING, G_TYPE_STRING);
802         /**
803          * ChimaraGlk::iliad-screen-update:
804          * @self: The widget that received the signal
805          * @typing: Whether to perform a typing or full screen update
806          *
807          * Iliad specific signal which is emitted whenever the screen needs to be updated.
808          * Since iliad screen updates are very slow, updating should only be done when
809          * necessary.
810          */
811         chimara_glk_signals[ILIAD_SCREEN_UPDATE] = g_signal_new("iliad-screen-update",
812                 G_OBJECT_CLASS_TYPE(klass), 0,
813                 G_STRUCT_OFFSET(ChimaraGlkClass, iliad_screen_update), NULL, NULL,
814                 _chimara_marshal_VOID__BOOLEAN,
815                 G_TYPE_NONE, 1, G_TYPE_BOOLEAN);
816
817     /* Properties */
818     /**
819      * ChimaraGlk:interactive:
820      *
821      * Sets whether the widget is interactive. A Glk widget is normally 
822      * interactive, but in non-interactive mode, keyboard and mouse input are 
823      * ignored and the Glk program is controlled by 
824      * chimara_glk_feed_char_input() and chimara_glk_feed_line_input(). 
825      * <quote>More</quote> prompts when a lot of text is printed to a text 
826          * buffer are also disabled. This is typically used when you wish to control
827          * an interpreter program by feeding it a predefined list of commands.
828      */
829     g_object_class_install_property( object_class, PROP_INTERACTIVE, 
830                 g_param_spec_boolean("interactive", _("Interactive"),
831         _("Whether user input is expected in the Glk program"),
832         TRUE,
833         G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
834
835         /**
836      * ChimaraGlk:protect:
837      *
838      * Sets whether the Glk program is allowed to do file operations. In protect
839      * mode, all file operations will fail.
840      */
841     g_object_class_install_property(object_class, PROP_PROTECT, 
842                 g_param_spec_boolean("protect", _("Protected"),
843         _("Whether the Glk program is barred from doing file operations"),
844         FALSE,
845         G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
846
847         /**
848          * ChimaraGlk:spacing:
849          *
850          * The amount of space between the Glk windows. This space forms a visible
851          * border between windows; however, if you open a window using the
852          * %winmethod_NoBorder flag, there will be no spacing between it and its
853          * sibling window, no matter what the value of this property is.
854          */
855         g_object_class_install_property(object_class, PROP_SPACING,
856                 g_param_spec_uint("spacing", _("Spacing"),
857                 _("The amount of space between Glk windows"),
858                 0, G_MAXUINT, 0,
859                 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
860         
861         /**
862          * ChimaraGlk:program-name:
863          *
864          * The name of the currently running Glk program. You cannot set this 
865          * property yourself. It is set to the filename of the plugin when you call
866          * chimara_glk_run(), but the plugin can change it by calling 
867          * garglk_set_program_name(). To find out when this information changes,
868          * for example to put the program name in the title bar of a window, connect
869          * to the <code>::notify::program-name</code> signal.
870          */
871         g_object_class_install_property(object_class, PROP_PROGRAM_NAME,
872                 g_param_spec_string("program-name", _("Program name"),
873                 _("Name of the currently running program"),
874                 NULL,
875                 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
876                 
877         /**
878          * ChimaraGlk:program-info:
879          *
880          * Information about the currently running Glk program. You cannot set this
881          * property yourself. The plugin can change it by calling
882          * garglk_set_program_info(). See also #ChimaraGlk:program-name.
883          */
884         g_object_class_install_property(object_class, PROP_PROGRAM_INFO,
885                 g_param_spec_string("program-info", _("Program info"),
886                 _("Information about the currently running program"),
887                 NULL,
888                 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
889         
890         /**
891          * ChimaraGlk:story-name:
892          *
893          * The name of the story currently running in the Glk interpreter. You
894          * cannot set this property yourself. It is set to the story filename when
895          * you call chimara_if_run_game(), but the plugin can change it by calling
896          * garglk_set_story_name().
897          *
898          * Strictly speaking, this should be a property of #ChimaraIF, but it is
899          * legal for any Glk program to call garglk_set_story_name(), even if it is
900          * not an interpreter and does not load story files.
901          */
902         g_object_class_install_property(object_class, PROP_STORY_NAME,
903                 g_param_spec_string("story-name", _("Story name"),
904                 _("Name of the story currently loaded in the interpreter"),
905                 NULL,
906                 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
907         
908         /**
909          * ChimaraGlk:running:
910          *
911          * Whether this Glk widget is currently running a game or not.
912          */
913         g_object_class_install_property(object_class, PROP_RUNNING,
914                 g_param_spec_boolean("running", _("Running"),
915                 _("Whether there is a program currently running"),
916                 FALSE,
917                 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
918
919         /* Private data */
920     g_type_class_add_private(klass, sizeof(ChimaraGlkPrivate));
921 }
922
923 /* PUBLIC FUNCTIONS */
924
925 /**
926  * chimara_error_quark:
927  *
928  * The error domain for errors from Chimara widgets.
929  *
930  * Returns: The string <quote>chimara-error-quark</quote> as a <link 
931  * linkend="GQuark">GQuark</link>.
932  */
933 GQuark
934 chimara_error_quark(void)
935 {
936         chimara_init(); /* This is a library entry point */
937         return g_quark_from_static_string("chimara-error-quark");
938 }
939
940 /**
941  * chimara_glk_new:
942  *
943  * Creates and initializes a new #ChimaraGlk widget.
944  *
945  * Return value: a #ChimaraGlk widget, with a floating reference.
946  */
947 GtkWidget *
948 chimara_glk_new(void)
949 {
950         /* This is a library entry point; initialize the library */
951         chimara_init();
952
953     return GTK_WIDGET(g_object_new(CHIMARA_TYPE_GLK, NULL));
954 }
955
956 /**
957  * chimara_glk_set_interactive:
958  * @glk: a #ChimaraGlk widget
959  * @interactive: whether the widget should expect user input
960  *
961  * Sets the #ChimaraGlk:interactive property of @glk. 
962  */
963 void 
964 chimara_glk_set_interactive(ChimaraGlk *glk, gboolean interactive)
965 {
966     g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
967     
968     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
969     priv->interactive = interactive;
970     g_object_notify(G_OBJECT(glk), "interactive");
971 }
972
973 /**
974  * chimara_glk_get_interactive:
975  * @glk: a #ChimaraGlk widget
976  *
977  * Returns whether @glk is interactive (expecting user input). See 
978  * #ChimaraGlk:interactive.
979  *
980  * Return value: %TRUE if @glk is interactive.
981  */
982 gboolean 
983 chimara_glk_get_interactive(ChimaraGlk *glk)
984 {
985     g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
986     
987     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
988     return priv->interactive;
989 }
990
991 /**
992  * chimara_glk_set_protect:
993  * @glk: a #ChimaraGlk widget
994  * @protect: whether the widget should allow the Glk program to do file 
995  * operations
996  *
997  * Sets the #ChimaraGlk:protect property of @glk. In protect mode, the Glk 
998  * program is not allowed to do file operations.
999  */
1000 void 
1001 chimara_glk_set_protect(ChimaraGlk *glk, gboolean protect)
1002 {
1003     g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1004     
1005     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1006     priv->protect = protect;
1007     g_object_notify(G_OBJECT(glk), "protect");
1008 }
1009
1010 /**
1011  * chimara_glk_get_protect:
1012  * @glk: a #ChimaraGlk widget
1013  *
1014  * Returns whether @glk is in protect mode (banned from doing file operations).
1015  * See #ChimaraGlk:protect.
1016  *
1017  * Return value: %TRUE if @glk is in protect mode.
1018  */
1019 gboolean 
1020 chimara_glk_get_protect(ChimaraGlk *glk)
1021 {
1022     g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1023     
1024     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1025     return priv->protect;
1026 }
1027
1028 /**
1029  * chimara_glk_set_css_to_default:
1030  * @glk: a #ChimaraGlk widget
1031  *
1032  * Resets the styles for text buffer and text grid windows to their defaults.
1033  * <para><warning>
1034  *   This function is not implemented yet.
1035  * </warning></para>
1036  */
1037 void
1038 chimara_glk_set_css_to_default(ChimaraGlk *glk)
1039 {
1040         reset_default_styles(glk);
1041 }
1042
1043 /**
1044  * chimara_glk_set_css_from_file:
1045  * @glk: a #ChimaraGlk widget
1046  * @filename: path to a CSS file, or %NULL
1047  * @error: location to store a <link 
1048  * linkend="glib-Error-Reporting">GError</link>, or %NULL
1049  *
1050  * Sets the styles for text buffer and text grid windows according to the CSS
1051  * file @filename. Note that the styles are set cumulatively on top of whatever
1052  * the styles are at the time this function is called; to reset the styles to
1053  * their defaults, use chimara_glk_set_css_to_default().
1054  *
1055  * Returns: %TRUE on success, %FALSE if an error occurred, in which case @error
1056  * will be set.
1057  */
1058 gboolean 
1059 chimara_glk_set_css_from_file(ChimaraGlk *glk, const gchar *filename, GError **error)
1060 {
1061         g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1062         g_return_val_if_fail(filename, FALSE);
1063         g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
1064
1065         int fd = open(filename, O_RDONLY);
1066         if(fd == -1) {
1067                 if(error)
1068                         *error = g_error_new(G_IO_ERROR, g_io_error_from_errno(errno), 
1069                                 _("Error opening file \"%s\": %s"), filename, g_strerror(errno));
1070                 return FALSE;
1071         }
1072
1073         GScanner *scanner = create_css_file_scanner();
1074         g_scanner_input_file(scanner, fd);
1075         scanner->input_name = filename;
1076         scan_css_file(scanner, glk);
1077
1078         if(close(fd) == -1) {
1079                 if(error)
1080                         *error = g_error_new(G_IO_ERROR, g_io_error_from_errno(errno),
1081                                 _("Error closing file \"%s\": %s"), filename, g_strerror(errno));
1082                 return FALSE;
1083         }
1084         return TRUE;
1085 }
1086
1087 /**
1088  * chimara_glk_set_css_from_string:
1089  * @glk: a #ChimaraGlk widget
1090  * @css: a string containing CSS code
1091  *
1092  * Sets the styles for text buffer and text grid windows according to the CSS
1093  * code @css. Note that the styles are set cumulatively on top of whatever the 
1094  * styles are at the time this function is called; to reset the styles to their
1095  * defaults, use chimara_glk_set_css_to_default().
1096  */
1097 void 
1098 chimara_glk_set_css_from_string(ChimaraGlk *glk, const gchar *css)
1099 {
1100         g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1101         g_return_if_fail(css || *css);
1102         
1103         GScanner *scanner = create_css_file_scanner();
1104         g_scanner_input_text(scanner, css, strlen(css));
1105         scanner->input_name = "<string>";
1106         scan_css_file(scanner, glk);
1107 }
1108
1109 /**
1110  * chimara_glk_set_spacing:
1111  * @glk: a #ChimaraGlk widget
1112  * @spacing: the number of pixels to put between Glk windows
1113  *
1114  * Sets the #ChimaraGlk:spacing property of @glk, which is the border width in
1115  * pixels between Glk windows.
1116  */
1117 void 
1118 chimara_glk_set_spacing(ChimaraGlk *glk, guint spacing)
1119 {
1120         g_return_if_fail( glk || CHIMARA_IS_GLK(glk) );
1121         
1122         ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1123         priv->spacing = spacing;
1124         g_object_notify(G_OBJECT(glk), "spacing");
1125 }
1126
1127 /**
1128  * chimara_glk_get_spacing:
1129  * @glk: a #ChimaraGlk widget
1130  *
1131  * Gets the value set by chimara_glk_set_spacing().
1132  *
1133  * Return value: pixels of spacing between Glk windows
1134  */
1135 guint 
1136 chimara_glk_get_spacing(ChimaraGlk *glk)
1137 {
1138         g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), 0);
1139         
1140         ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1141         return priv->spacing;
1142 }
1143
1144 struct StartupData {
1145         glk_main_t glk_main;
1146         glkunix_startup_code_t glkunix_startup_code;
1147         glkunix_startup_t args;
1148         ChimaraGlkPrivate *glk_data;
1149 };
1150
1151 static void
1152 free_startup_data(struct StartupData *startup)
1153 {
1154         int i = 0;
1155         while(i < startup->args.argc)
1156                 g_free(startup->args.argv[i++]);
1157         g_free(startup->args.argv);
1158         g_slice_free(struct StartupData, startup);
1159 }
1160
1161 /* glk_enter() is the actual function called in the new thread in which
1162 glk_main() runs. Takes ownership of @startup and will free it. */
1163 static gpointer
1164 glk_enter(struct StartupData *startup)
1165 {
1166         extern GPrivate glk_data_key;
1167         g_private_set(&glk_data_key, startup->glk_data);
1168
1169         /* Acquire the Glk thread's references to the input queues */
1170         g_async_queue_ref(startup->glk_data->char_input_queue);
1171         g_async_queue_ref(startup->glk_data->line_input_queue);
1172
1173         /* Run startup function */
1174         if(startup->glkunix_startup_code) {
1175                 startup->glk_data->in_startup = TRUE;
1176                 int result = startup->glkunix_startup_code(&startup->args);
1177                 startup->glk_data->in_startup = FALSE;
1178
1179                 if(!result) {
1180                         free_startup_data(startup);
1181                         return NULL;
1182                 }
1183         }
1184
1185         /* Run main function */
1186         glk_main_t glk_main = startup->glk_main;
1187
1188         g_signal_emit_by_name(startup->glk_data->self, "started");
1189
1190         glk_main();
1191         free_startup_data(startup);
1192         glk_exit(); /* Run shutdown code in glk_exit() even if glk_main() returns normally */
1193         g_assert_not_reached(); /* because glk_exit() calls g_thread_exit() */
1194         return NULL;
1195 }
1196
1197 /**
1198  * chimara_glk_run:
1199  * @glk: a #ChimaraGlk widget
1200  * @plugin: path to a plugin module compiled with <filename 
1201  * class="header">glk.h</filename>
1202  * @argc: Number of command line arguments in @argv
1203  * @argv: Array of command line arguments to pass to the plugin
1204  * @error: location to store a <link 
1205  * linkend="glib-Error-Reporting">GError</link>, or %NULL
1206  *
1207  * Opens a Glk program compiled as a plugin. Sorts out its command line
1208  * arguments from #glkunix_arguments, calls its startup function
1209  * glkunix_startup_code(), and then calls its main function glk_main() in
1210  * a separate thread. On failure, returns %FALSE and sets @error.
1211  *
1212  * The plugin must at least export a glk_main() function; #glkunix_arguments and
1213  * glkunix_startup_code() are optional.
1214  *
1215  * Return value: %TRUE if the Glk program was started successfully.
1216  */
1217 gboolean
1218 chimara_glk_run(ChimaraGlk *glk, const gchar *plugin, int argc, char *argv[], GError **error)
1219 {
1220     g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1221     g_return_val_if_fail(plugin, FALSE);
1222         g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
1223         
1224         if(chimara_glk_get_running(glk)) {
1225                 g_set_error(error, CHIMARA_ERROR, CHIMARA_PLUGIN_ALREADY_RUNNING, _("There was already a plugin running."));
1226                 return FALSE;
1227         }
1228     
1229     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1230
1231         struct StartupData *startup = g_slice_new0(struct StartupData);
1232
1233     g_assert( g_module_supported() );
1234         /* If there is already a module loaded, free it first -- you see, we want to
1235          * keep modules loaded as long as possible to avoid crashes in stack unwinding */
1236         chimara_glk_unload_plugin(glk);
1237         /* Open the module to run */
1238     priv->program = g_module_open(plugin, G_MODULE_BIND_LAZY);
1239     
1240     if(!priv->program)
1241     {
1242         g_set_error(error, CHIMARA_ERROR, CHIMARA_LOAD_MODULE_ERROR, _("Error opening module: %s"), g_module_error());
1243         return FALSE;
1244     }
1245     if( !g_module_symbol(priv->program, "glk_main", (gpointer *) &startup->glk_main) )
1246     {
1247         g_set_error(error, CHIMARA_ERROR, CHIMARA_NO_GLK_MAIN, _("Error finding glk_main(): %s"), g_module_error());
1248         return FALSE;
1249     }
1250
1251     if( g_module_symbol(priv->program, "glkunix_startup_code", (gpointer *) &startup->glkunix_startup_code) )
1252     {
1253                 glkunix_argumentlist_t *glkunix_arguments;
1254
1255                 if( !(g_module_symbol(priv->program, "glkunix_arguments", (gpointer *) &glkunix_arguments) 
1256                           && parse_command_line(glkunix_arguments, argc, argv, &startup->args)) )
1257                 {
1258                         /* arguments could not be parsed, so create data ourselves */
1259                         startup->args.argc = 1;
1260                         startup->args.argv = g_new0(gchar *, 1);
1261                 }
1262
1263                 /* Set the program invocation name */
1264                 startup->args.argv[0] = g_strdup(plugin);
1265     }
1266         startup->glk_data = priv;
1267         
1268         /* Set the program name */
1269         priv->program_name = g_path_get_basename(plugin);
1270         g_object_notify(G_OBJECT(glk), "program-name");
1271
1272         /* Set Glk styles to defaults */
1273         style_reset_glk(glk);
1274
1275     /* Run in a separate thread */
1276         priv->thread = g_thread_try_new("glk", (GThreadFunc)glk_enter, startup, error);
1277
1278         return !(priv->thread == NULL);
1279 }
1280
1281 /**
1282  * chimara_glk_run_file:
1283  * @self: a #ChimaraGlk widget
1284  * @plugin_file: a #GFile pointing to a plugin module compiled with <filename
1285  * class="header">glk.h</filename>
1286  * @argc: Number of command line arguments in @argv
1287  * @argv: Array of command line arguments to pass to the plugin
1288  * @error: location to store a <link
1289  * linkend="glib-Error-Reporting">GError</link>, or %NULL
1290  *
1291  * Opens a Glk program compiled as a plugin, from a #GFile. See
1292  * chimara_glk_run() for details.
1293  *
1294  * Return value: %TRUE if the Glk program was started successfully.
1295  */
1296 gboolean
1297 chimara_glk_run_file(ChimaraGlk *self, GFile *plugin_file, int argc, char *argv[], GError **error)
1298 {
1299         g_return_val_if_fail(self || CHIMARA_IS_GLK(self), FALSE);
1300         g_return_val_if_fail(plugin_file || G_IS_FILE(plugin_file), FALSE);
1301         g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
1302
1303         char *path = g_file_get_path(plugin_file);
1304         gboolean retval = chimara_glk_run(self, path, argc, argv, error);
1305         g_free(path);
1306
1307         return retval;
1308 }
1309
1310 /**
1311  * chimara_glk_stop:
1312  * @glk: a #ChimaraGlk widget
1313  *
1314  * Signals the Glk program running in @glk to abort. Note that if the program is
1315  * caught in an infinite loop in which glk_tick() is not called, this may not
1316  * work.
1317  *
1318  * This function does nothing if no Glk program is running.
1319  */
1320 void
1321 chimara_glk_stop(ChimaraGlk *glk)
1322 {
1323     g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1324     CHIMARA_GLK_USE_PRIVATE(glk, priv);
1325
1326     /* Don't do anything if not running a program */
1327     if(!priv->running)
1328         return;
1329     
1330         if(!priv->after_finalize) {
1331                 g_mutex_lock(&priv->abort_lock);
1332                 priv->abort_signalled = TRUE;
1333                 g_mutex_unlock(&priv->abort_lock);
1334                 /* Stop blocking on the event queue condition */
1335                 event_throw(glk, evtype_Abort, NULL, 0, 0);
1336                 /* Stop blocking on the shutdown key press condition */
1337                 g_mutex_lock(&priv->shutdown_lock);
1338                 g_cond_signal(&priv->shutdown_key_pressed);
1339                 g_mutex_unlock(&priv->shutdown_lock);
1340         }
1341 }
1342
1343 /**
1344  * chimara_glk_wait:
1345  * @glk: a #ChimaraGlk widget
1346  *
1347  * Holds up the main thread and waits for the Glk program running in @glk to 
1348  * finish.
1349  *
1350  * This function does nothing if no Glk program is running.
1351  */
1352 void
1353 chimara_glk_wait(ChimaraGlk *glk)
1354 {
1355     g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1356     CHIMARA_GLK_USE_PRIVATE(glk, priv);
1357     /* Don't do anything if not running a program */
1358     if(!priv->running)
1359         return;
1360         /* Unlock GDK mutex, because the Glk program might need to use it for shutdown */
1361         gdk_threads_leave();
1362     g_thread_join(priv->thread);
1363         gdk_threads_enter();
1364 }
1365
1366 /**
1367  * chimara_glk_unload_plugin:
1368  * @glk: a #ChimaraGlk widget
1369  *
1370  * The plugin containing the Glk program is unloaded as late as possible before
1371  * loading a new plugin, in order to prevent crashes while printing stack
1372  * backtraces during debugging. Sometimes this behavior is not desirable. This
1373  * function forces @glk to unload the plugin running in it.
1374  *
1375  * This function does nothing if there is no plugin loaded.
1376  */
1377 void
1378 chimara_glk_unload_plugin(ChimaraGlk *glk)
1379 {
1380         g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1381     CHIMARA_GLK_USE_PRIVATE(glk, priv);
1382         if( priv->program && !g_module_close(priv->program) )
1383                 g_warning( "Error closing module :%s", g_module_error() );
1384         priv->program = NULL;
1385 }
1386
1387 /**
1388  * chimara_glk_get_running:
1389  * @glk: a #ChimaraGlk widget
1390  * 
1391  * Use this function to tell whether a program is currently running in the
1392  * widget.
1393  * 
1394  * Returns: %TRUE if @glk is executing a Glk program, %FALSE otherwise.
1395  */
1396 gboolean
1397 chimara_glk_get_running(ChimaraGlk *glk)
1398 {
1399         g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1400         CHIMARA_GLK_USE_PRIVATE(glk, priv);
1401         return priv->running;
1402 }
1403
1404 /**
1405  * chimara_glk_feed_char_input:
1406  * @glk: a #ChimaraGlk widget
1407  * @keyval: a key symbol as defined in <filename 
1408  * class="headerfile">gdk/gdkkeysyms.h</filename>
1409  * 
1410  * Pretend that a key was pressed in the Glk program as a response to a 
1411  * character input request. You can call this function even when no window has
1412  * requested character input, in which case the key will be saved for the 
1413  * following window that requests character input. This has the disadvantage 
1414  * that if more than one window has requested character input, it is arbitrary 
1415  * which one gets the key press.
1416  */
1417 void 
1418 chimara_glk_feed_char_input(ChimaraGlk *glk, guint keyval)
1419 {
1420         g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1421         CHIMARA_GLK_USE_PRIVATE(glk, priv);
1422         g_async_queue_push(priv->char_input_queue, GUINT_TO_POINTER(keyval));
1423         event_throw(glk, evtype_ForcedCharInput, NULL, 0, 0);
1424 }
1425
1426 /**
1427  * chimara_glk_feed_line_input:
1428  * @glk: a #ChimaraGlk widget
1429  * @text: text to pass to the next line input request
1430  * 
1431  * Pretend that @text was typed in the Glk program as a response to a line input
1432  * request. @text does not need to end with a newline. You can call this 
1433  * function even when no window has requested line input, in which case the text
1434  * will be saved for the following window that requests line input. This has the 
1435  * disadvantage that if more than one window has requested line input, it is
1436  * arbitrary which one gets the text.
1437  */
1438 void 
1439 chimara_glk_feed_line_input(ChimaraGlk *glk, const gchar *text)
1440 {
1441         g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1442         g_return_if_fail(text);
1443         CHIMARA_GLK_USE_PRIVATE(glk, priv);
1444         g_async_queue_push(priv->line_input_queue, g_strdup(text));
1445         event_throw(glk, evtype_ForcedLineInput, NULL, 0, 0);
1446 }
1447
1448 /**
1449  * chimara_glk_is_char_input_pending:
1450  * @glk: a #ChimaraGlk widget
1451  *
1452  * Use this function to tell if character input forced by 
1453  * chimara_glk_feed_char_input() has been passed to an input request or not.
1454  *
1455  * Returns: %TRUE if forced character input is pending, %FALSE otherwise.
1456  */
1457 gboolean
1458 chimara_glk_is_char_input_pending(ChimaraGlk *glk)
1459 {
1460         g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1461         CHIMARA_GLK_USE_PRIVATE(glk, priv);
1462         return g_async_queue_length(priv->char_input_queue) > 0;
1463 }
1464
1465 /**
1466  * chimara_glk_is_line_input_pending:
1467  * @glk: a #ChimaraGlk widget
1468  *
1469  * Use this function to tell if line input forced by 
1470  * chimara_glk_feed_line_input() has been passed to an input request or not.
1471  *
1472  * Returns: %TRUE if forced line input is pending, %FALSE otherwise.
1473  */
1474 gboolean
1475 chimara_glk_is_line_input_pending(ChimaraGlk *glk)
1476 {
1477         g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1478         CHIMARA_GLK_USE_PRIVATE(glk, priv);
1479         return g_async_queue_length(priv->line_input_queue) > 0;
1480 }
1481
1482 /**
1483  * chimara_glk_get_tag:
1484  * @glk: a #ChimaraGlk widget
1485  * @window: The type of window to retrieve the tag for
1486  * @name: The name of the tag to retrieve
1487  *
1488  * Use this function to get a #GtkTextTag so style properties can be changed.
1489  * See also chimara_glk_set_css_from_string().
1490  *
1491  * The layout of the text in Chimara is controlled by two sets of tags: one set
1492  * describing the style in text buffers and one for text grids. See also the
1493  * Glk specification for the difference between the two. The main narrative of
1494  * a game is usually rendered in text buffers, whereas text grids are mostly
1495  * used for status bars and in game menus.
1496  *
1497  * The following tag names are supported:
1498  * <itemizedlist>
1499  *      <listitem><para>normal</para></listitem>
1500  *      <listitem><para>emphasized</para></listitem>
1501  *      <listitem><para>preformatted</para></listitem>
1502  *      <listitem><para>header</para></listitem>
1503  *      <listitem><para>subheader</para></listitem>
1504  *      <listitem><para>alert</para></listitem>
1505  *      <listitem><para>note</para></listitem>
1506  *      <listitem><para>block-quote</para></listitem>
1507  *      <listitem><para>input</para></listitem>
1508  *      <listitem><para>user1</para></listitem>
1509  *      <listitem><para>user2</para></listitem>
1510  *      <listitem><para>hyperlink</para></listitem>
1511  *      <listitem><para>pager</para></listitem>
1512  * </itemizedlist>
1513  *
1514  * Returns: (transfer none): The #GtkTextTag corresponding to @name in the
1515  * styles of @window.
1516  */
1517 GtkTextTag *
1518 chimara_glk_get_tag(ChimaraGlk *glk, ChimaraGlkWindowType window, const gchar *name)
1519 {
1520         CHIMARA_GLK_USE_PRIVATE(glk, priv);
1521
1522         switch(window) {
1523         case CHIMARA_GLK_TEXT_BUFFER:
1524                 return GTK_TEXT_TAG( g_hash_table_lookup(priv->styles->text_buffer, name) );
1525                 break;
1526         case CHIMARA_GLK_TEXT_GRID:
1527                 return GTK_TEXT_TAG( g_hash_table_lookup(priv->styles->text_grid, name) );
1528                 break;
1529         default:
1530                 ILLEGAL_PARAM("Unknown window type: %u", window);
1531                 return NULL;
1532         }
1533 }
1534
1535 /**
1536  * chimara_glk_get_tag_names:
1537  * @glk: a #ChimaraGlk widget
1538  * @num_tags: Return location for the number of tag names retrieved.
1539  *
1540  * Retrieves the possible tag names to use in chimara_glk_get_tag().
1541  *
1542  * Returns: (transfer none) (array length=num_tags) (element-type utf8):
1543  * Array of strings containing the tag names. This array is owned by Chimara,
1544  * do not free it.
1545  */
1546 const gchar **
1547 chimara_glk_get_tag_names(ChimaraGlk *glk, unsigned int *num_tags)
1548 {
1549         g_return_val_if_fail(num_tags != NULL, NULL);
1550
1551         *num_tags = CHIMARA_NUM_STYLES;
1552         return style_get_tag_names();
1553 }
1554
1555 /**
1556  * chimara_glk_update_style:
1557  * @glk: a #ChimaraGlk widget
1558  *
1559  * Processes style updates and updates the widget to reflect the new style.
1560  * Call this every time you change a property of a #GtkTextTag retrieved by
1561  * chimara_glk_get_tag().
1562  */
1563 void
1564 chimara_glk_update_style(ChimaraGlk *glk)
1565 {
1566         CHIMARA_GLK_USE_PRIVATE(glk, priv);
1567         style_update(glk);
1568
1569         /* Schedule a redraw */
1570         g_mutex_lock(&priv->arrange_lock);
1571         priv->needs_rearrange = TRUE;
1572         priv->ignore_next_arrange_event = TRUE;
1573         g_mutex_unlock(&priv->arrange_lock);
1574         gtk_widget_queue_resize( GTK_WIDGET(priv->self) );
1575 }
1576
1577 /**
1578  * chimara_glk_set_resource_load_callback:
1579  * @glk: a #ChimaraGlk widget
1580  * @func: a function to call for loading resources, or %NULL
1581  * @user_data: user data to pass to @func, or %NULL
1582  * @destroy_user_data: a function to call for freeing @user_data, or %NULL
1583  *
1584  * Sometimes it is preferable to load image and sound resources from somewhere
1585  * else than a Blorb file, for example while developing a game. Section 14 of
1586  * the <ulink url="http://eblong.com/zarf/blorb/blorb.html#s14">Blorb
1587  * specification</ulink> allows for this possibility. This function sets @func
1588  * to be called when the Glk program requests loading an image or sound without
1589  * a Blorb resource map having been loaded, optionally passing @user_data as an 
1590  * extra parameter.
1591  *
1592  * Note that @func is only called if no Blorb resource map has been set; having
1593  * a resource map in place overrides this function.
1594  *
1595  * If you pass non-%NULL for @destroy_user_data, then @glk takes ownership of
1596  * @user_data. When it is not needed anymore, it will be freed by calling
1597  * @destroy_user_data on it. If you wish to retain ownership of @user_data, pass
1598  * %NULL for @destroy_user_data.
1599  *
1600  * To deactivate the callback, call this function with @func set to %NULL.
1601  */
1602 void
1603 chimara_glk_set_resource_load_callback(ChimaraGlk *glk, ChimaraResourceLoadFunc func, gpointer user_data, GDestroyNotify destroy_user_data)
1604 {
1605         CHIMARA_GLK_USE_PRIVATE(glk, priv);
1606
1607         if(priv->resource_load_callback == func
1608                 && priv->resource_load_callback_data == user_data
1609                 && priv->resource_load_callback_destroy_data == destroy_user_data)
1610                 return;
1611
1612         if(priv->resource_load_callback_destroy_data)
1613                 priv->resource_load_callback_destroy_data(priv->resource_load_callback_data);
1614
1615         priv->resource_load_callback = func;
1616         priv->resource_load_callback_data = user_data;
1617         priv->resource_load_callback_destroy_data = destroy_user_data;
1618 }