9d4f443d4f1e4c9f6925f25d1dc3dbee02ac9a43
[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 multithreading in any program you use a #ChimaraGlk
55  * widget in. This means including the following incantation at the beginning
56  * of your program:
57  * |[
58  * if(!g_thread_supported())
59  *     g_thread_init(NULL);
60  * gdk_threads_init();
61  * ]|
62  * This initialization must take place <emphasis>before</emphasis> the call to
63  * gtk_init(). In addition to this, you must also protect your call to 
64  * gtk_main() by calling gdk_threads_enter() right before it, and 
65  * gdk_threads_leave() right after it.
66  *
67  * The following sample program shows how to initialize and construct a simple 
68  * GTK window that runs a Glk program:
69  * |[
70  * #include <glib.h>
71  * #include <gtk/gtk.h>
72  * #include <libchimara/chimara-glk.h>
73  *
74  * int
75  * main(int argc, char *argv[])
76  * {
77  *     GtkWidget *window, *glk;
78  *     GError *error = NULL;
79  *     gchar *plugin_argv[] = { "plugin.so", "-option" };
80  *
81  *     /<!---->* Initialize threads and GTK *<!---->/
82  *     if(!g_thread_supported())
83  *         g_thread_init(NULL);
84  *     gdk_threads_init();
85  *     gtk_init(&argc, &argv);
86  *     
87  *     /<!---->* Construct the window and its contents. We quit the GTK main loop
88  *      * when the window's close button is clicked. *<!---->/
89  *     window = gtk_window_new(GTK_WINDOW_TOPLEVEL);
90  *     g_signal_connect(window, "delete-event", G_CALLBACK(gtk_main_quit), NULL);
91  *     glk = chimara_glk_new();
92  *     gtk_container_add(GTK_CONTAINER(window), glk);
93  *     gtk_widget_show_all(window);
94  *
95  *     /<!---->* Add a reference to the ChimaraGlk widget, since we want it to
96  *      * persist after the window's delete-event -- otherwise it will be destroyed
97  *      * with the window. *<!---->/
98  *     g_object_ref(glk);
99  *     
100  *     /<!---->* Start the Glk program in a separate thread *<!---->/
101  *     if(!chimara_glk_run(CHIMARA_GLK(glk), "./plugin.so", 2, plugin_argv, &error))
102  *         g_error("Error starting Glk library: %s\n", error->message);
103  *     
104  *     /<!---->* Start the GTK main loop *<!---->/
105  *     gdk_threads_enter();
106  *     gtk_main();
107  *     gdk_threads_leave();
108  *
109  *     /<!---->* After the GTK main loop exits, signal the Glk program to shut down if
110  *      * it is still running, and wait for it to exit. *<!---->/
111  *     chimara_glk_stop(CHIMARA_GLK(glk));
112  *     chimara_glk_wait(CHIMARA_GLK(glk));
113  *     g_object_unref(glk);
114  *
115  *     return 0;
116  * }
117  * ]|
118  */
119
120 typedef void (* glk_main_t) (void);
121 typedef int (* glkunix_startup_code_t) (glkunix_startup_t*);
122
123 enum {
124     PROP_0,
125     PROP_INTERACTIVE,
126     PROP_PROTECT,
127         PROP_SPACING,
128         PROP_PROGRAM_NAME,
129         PROP_PROGRAM_INFO,
130         PROP_STORY_NAME,
131         PROP_RUNNING
132 };
133
134 enum {
135         STOPPED,
136         STARTED,
137         WAITING,
138         CHAR_INPUT,
139         LINE_INPUT,
140         TEXT_BUFFER_OUTPUT,
141         ILIAD_SCREEN_UPDATE,
142
143         LAST_SIGNAL
144 };
145
146 static guint chimara_glk_signals[LAST_SIGNAL] = { 0 };
147
148 G_DEFINE_TYPE(ChimaraGlk, chimara_glk, GTK_TYPE_CONTAINER);
149
150 static void
151 chimara_glk_init(ChimaraGlk *self)
152 {
153         chimara_init(); /* This is a library entry point */
154
155     gtk_widget_set_has_window(GTK_WIDGET(self), FALSE);
156
157     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(self);
158     
159     priv->self = self;
160     priv->interactive = TRUE;
161         priv->styles = g_new0(StyleSet,1);
162         priv->glk_styles = g_new0(StyleSet,1);
163         priv->final_message = g_strdup("[ The game has finished ]");
164     priv->event_queue = g_queue_new();
165     priv->event_lock = g_mutex_new();
166     priv->event_queue_not_empty = g_cond_new();
167     priv->event_queue_not_full = g_cond_new();
168     priv->abort_lock = g_mutex_new();
169         priv->shutdown_lock = g_mutex_new();
170         priv->shutdown_key_pressed = g_cond_new();
171         priv->arrange_lock = g_mutex_new();
172         priv->rearranged = g_cond_new();
173         priv->char_input_queue = g_async_queue_new();
174         priv->line_input_queue = g_async_queue_new();
175         /* FIXME Should be g_async_queue_new_full(g_free); but only in GTK >= 2.16 */
176         priv->resource_lock = g_mutex_new();
177         priv->resource_loaded = g_cond_new();
178         priv->resource_info_available = g_cond_new();
179
180         style_init(self);
181 }
182
183 static void
184 chimara_glk_set_property(GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
185 {
186     ChimaraGlk *glk = CHIMARA_GLK(object);
187     
188     switch(prop_id) 
189     {
190         case PROP_INTERACTIVE:
191             chimara_glk_set_interactive( glk, g_value_get_boolean(value) );
192             break;
193         case PROP_PROTECT:
194             chimara_glk_set_protect( glk, g_value_get_boolean(value) );
195             break;
196                 case PROP_SPACING:
197                         chimara_glk_set_spacing( glk, g_value_get_uint(value) );
198                         break;
199         default:
200             G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
201     }
202 }
203
204 static void
205 chimara_glk_get_property(GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
206 {
207     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(object);
208     
209     switch(prop_id)
210     {
211         case PROP_INTERACTIVE:
212             g_value_set_boolean(value, priv->interactive);
213             break;
214         case PROP_PROTECT:
215             g_value_set_boolean(value, priv->protect);
216             break;
217                 case PROP_SPACING:
218                         g_value_set_uint(value, priv->spacing);
219                         break;
220                 case PROP_PROGRAM_NAME:
221                         g_value_set_string(value, priv->program_name);
222                         break;
223                 case PROP_PROGRAM_INFO:
224                         g_value_set_string(value, priv->program_info);
225                         break;
226                 case PROP_STORY_NAME:
227                         g_value_set_string(value, priv->story_name);
228                         break;
229                 case PROP_RUNNING:
230                         g_value_set_boolean(value, priv->running);
231                         break;
232                 default:
233             G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
234     }
235 }
236
237 static void
238 chimara_glk_finalize(GObject *object)
239 {
240     ChimaraGlk *self = CHIMARA_GLK(object);
241         CHIMARA_GLK_USE_PRIVATE(self, priv);
242
243         /* Free widget properties */
244         g_free(priv->final_message);
245         /* Free styles */
246         g_hash_table_destroy(priv->styles->text_buffer);
247         g_hash_table_destroy(priv->styles->text_grid);
248         g_hash_table_destroy(priv->glk_styles->text_buffer);
249         g_hash_table_destroy(priv->glk_styles->text_grid);
250
251     /* Free the event queue */
252     g_mutex_lock(priv->event_lock);
253         g_queue_foreach(priv->event_queue, (GFunc)g_free, NULL);
254         g_queue_free(priv->event_queue);
255         g_cond_free(priv->event_queue_not_empty);
256         g_cond_free(priv->event_queue_not_full);
257         priv->event_queue = NULL;
258         g_mutex_unlock(priv->event_lock);
259         g_mutex_free(priv->event_lock);
260     /* Free the abort signaling mechanism */
261         g_mutex_lock(priv->abort_lock);
262         /* Make sure no other thread is busy with this */
263         g_mutex_unlock(priv->abort_lock);
264         g_mutex_free(priv->abort_lock);
265         priv->abort_lock = NULL;
266         /* Free the shutdown keypress signaling mechanism */
267         g_mutex_lock(priv->shutdown_lock);
268         g_cond_free(priv->shutdown_key_pressed);
269         g_mutex_unlock(priv->shutdown_lock);
270         priv->shutdown_lock = NULL;
271         /* Free the window arrangement signaling */
272         g_mutex_lock(priv->arrange_lock);
273         g_cond_free(priv->rearranged);
274         g_mutex_unlock(priv->arrange_lock);
275         g_mutex_free(priv->arrange_lock);
276         priv->arrange_lock = NULL;
277         g_mutex_lock(priv->resource_lock);
278         g_cond_free(priv->resource_loaded);
279         g_cond_free(priv->resource_info_available);
280         g_mutex_unlock(priv->resource_lock);
281         g_mutex_free(priv->resource_lock);
282         g_slist_foreach(priv->image_cache, (GFunc)clear_image_cache, NULL);
283         g_slist_free(priv->image_cache);
284         /* Unref input queues (this should destroy them since any Glk thread has stopped by now */
285         g_async_queue_unref(priv->char_input_queue);
286         g_async_queue_unref(priv->line_input_queue);
287         /* Destroy callback data if ownership retained */
288         if(priv->resource_load_callback_destroy_data)
289                 priv->resource_load_callback_destroy_data(priv->resource_load_callback_data);
290         
291         /* Free other stuff */
292         g_free(priv->current_dir);
293         g_free(priv->program_name);
294         g_free(priv->program_info);
295         g_free(priv->story_name);
296         g_free(priv->styles);
297         g_free(priv->glk_styles);
298
299         /* Chain up to parent */
300     G_OBJECT_CLASS(chimara_glk_parent_class)->finalize(object);
301 }
302
303 /* Implementation of get_request_mode(): Always request constant size */
304 static GtkSizeRequestMode
305 chimara_glk_get_request_mode(GtkWidget *widget)
306 {
307         return GTK_SIZE_REQUEST_CONSTANT_SIZE;
308 }
309
310 /* Minimal implementation of width request. Allocation in Glk is
311 strictly top-down, so we just request our current size by returning 1. */
312 static void
313 chimara_glk_get_preferred_width(GtkWidget *widget, int *minimal, int *natural)
314 {
315     g_return_if_fail(widget || CHIMARA_IS_GLK(widget));
316     g_return_if_fail(minimal);
317     g_return_if_fail(natural);
318
319     *minimal = *natural = 1;
320 }
321
322 /* Minimal implementation of height request. Allocation in Glk is
323 strictly top-down, so we just request our current size by returning 1. */
324 static void
325 chimara_glk_get_preferred_height(GtkWidget *widget, int *minimal, int *natural)
326 {
327     g_return_if_fail(widget || CHIMARA_IS_GLK(widget));
328     g_return_if_fail(minimal);
329     g_return_if_fail(natural);
330
331     *minimal = *natural = 1;
332 }
333
334 /* Recursively give the Glk windows their allocated space. Returns a window
335  containing all children of this window that must be redrawn, or NULL if there 
336  are no children that require redrawing. */
337 static winid_t
338 allocate_recurse(winid_t win, GtkAllocation *allocation, guint spacing)
339 {
340         if(win->type == wintype_Pair)
341         {
342                 glui32 division = win->split_method & winmethod_DivisionMask;
343                 glui32 direction = win->split_method & winmethod_DirMask;
344                 unsigned border = ((win->split_method & winmethod_BorderMask) == winmethod_NoBorder)? 0 : spacing;
345
346                 /* If the space gets too small to honor the spacing property, then just 
347                  ignore spacing in this window and below. */
348                 if( (border > allocation->width && (direction == winmethod_Left || direction == winmethod_Right))
349                    || (border > allocation->height && (direction == winmethod_Above || direction == winmethod_Below)) )
350                         border = 0;
351                 
352                 GtkAllocation child1, child2;
353                 child1.x = allocation->x;
354                 child1.y = allocation->y;
355                 
356                 if(division == winmethod_Fixed)
357                 {
358                         /* If the key window has been closed, then default to 0; otherwise
359                          use the key window to determine the size */
360                         switch(direction)
361                         {
362                                 case winmethod_Left:
363                                         child1.width = win->key_window? 
364                                                 CLAMP(win->constraint_size * win->key_window->unit_width, 0, allocation->width - border) 
365                                                 : 0;
366                                         break;
367                                 case winmethod_Right:
368                                         child2.width = win->key_window? 
369                                                 CLAMP(win->constraint_size * win->key_window->unit_width, 0, allocation->width - border)
370                                                 : 0;
371                                         break;
372                                 case winmethod_Above:
373                                         child1.height = win->key_window? 
374                                                 CLAMP(win->constraint_size * win->key_window->unit_height, 0, allocation->height - border)
375                                                 : 0;
376                                         break;
377                                 case winmethod_Below:
378                                         child2.height = win->key_window?
379                                                 CLAMP(win->constraint_size * win->key_window->unit_height, 0, allocation->height - border)
380                                                 : 0;
381                                         break;
382                         }
383                 }
384                 else /* proportional */
385                 {
386                         gdouble fraction = win->constraint_size / 100.0;
387                         switch(direction)
388                         {
389                                 case winmethod_Left:
390                                         child1.width = MAX(0, (gint)ceil(fraction * (allocation->width - border)) );
391                                         break;
392                                 case winmethod_Right:
393                                         child2.width = MAX(0, (gint)ceil(fraction * (allocation->width - border)) );
394                                         break;
395                                 case winmethod_Above:
396                                         child1.height = MAX(0, (gint)ceil(fraction * (allocation->height - border)) );
397                                         break;
398                                 case winmethod_Below:
399                                         child2.height = MAX(0, (gint)ceil(fraction * (allocation->height - border)) );
400                                         break;
401                         }
402                 }
403                 
404                 /* Fill in the rest of the size requisitions according to the child specified above */
405                 switch(direction)
406                 {
407                         case winmethod_Left:
408                                 child2.width = MAX(0, allocation->width - border - child1.width);
409                                 child2.x = child1.x + child1.width + border;
410                                 child2.y = child1.y;
411                                 child1.height = child2.height = allocation->height;
412                                 break;
413                         case winmethod_Right:
414                                 child1.width = MAX(0, allocation->width - border - child2.width);
415                                 child2.x = child1.x + child1.width + border;
416                                 child2.y = child1.y;
417                                 child1.height = child2.height = allocation->height;
418                                 break;
419                         case winmethod_Above:
420                                 child2.height = MAX(0, allocation->height - border - child1.height);
421                                 child2.x = child1.x;
422                                 child2.y = child1.y + child1.height + border;
423                                 child1.width = child2.width = allocation->width;
424                                 break;
425                         case winmethod_Below:
426                                 child1.height = MAX(0, allocation->height - border - child2.height);
427                                 child2.x = child1.x;
428                                 child2.y = child1.y + child1.height + border;
429                                 child1.width = child2.width = allocation->width;
430                                 break;
431                 }
432                 
433                 /* Recurse */
434                 winid_t arrange1 = allocate_recurse(win->window_node->children->data, &child1, spacing);
435                 winid_t arrange2 = allocate_recurse(win->window_node->children->next->data, &child2, spacing);
436                 if(arrange1 == NULL)
437                         return arrange2;
438                 if(arrange2 == NULL)
439                         return arrange1;
440                 return win;
441         }
442         
443         else if(win->type == wintype_TextGrid)
444         {
445                 /* Pass the size allocation on to the framing widget */
446                 gtk_widget_size_allocate(win->frame, allocation);
447                 /* It says in the spec that when a text grid window is resized smaller,
448                  the bottom or right area is thrown away; when it is resized larger, the
449                  bottom or right area is filled with blanks. */
450                 GtkAllocation widget_allocation;
451                 gtk_widget_get_allocation(win->widget, &widget_allocation);
452                 glui32 new_width = (glui32)(widget_allocation.width / win->unit_width);
453                 glui32 new_height = (glui32)(widget_allocation.height / win->unit_height);
454
455                 if(new_width != win->width || new_height != win->height)
456                 {
457                         // Window has changed size, trim or expand the textbuffer if necessary.
458                         GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
459                         GtkTextIter start, end;
460
461                         // Add or remove lines
462                         if(new_height == 0) {
463                                 gtk_text_buffer_get_start_iter(buffer, &start);
464                                 gtk_text_buffer_get_end_iter(buffer, &end);
465                                 gtk_text_buffer_delete(buffer, &start, &end);
466                         }
467                         else if(new_height < win->height)
468                         {
469                                 // Remove surplus lines
470                                 gtk_text_buffer_get_end_iter(buffer, &end);
471                                 gtk_text_buffer_get_iter_at_line(buffer, &start, new_height-1);
472                                 gtk_text_iter_forward_to_line_end(&start);
473                                 gtk_text_buffer_delete(buffer, &start, &end);
474
475                         }
476                         else if(new_height > win->height)
477                         {
478                                 // Add extra lines
479                                 gint lines_to_add = new_height - win->height;
480                                 gtk_text_buffer_get_end_iter(buffer, &end);
481                                 start = end;
482
483                                 gchar *blanks = g_strnfill(win->width, ' ');
484                                 gchar **blanklines = g_new0(gchar *, lines_to_add + 1);
485                                 int count;
486                                 for(count = 0; count < lines_to_add; count++)
487                                         blanklines[count] = blanks;
488                                 blanklines[lines_to_add] = NULL;
489                                 gchar *vertical_blanks = g_strjoinv("\n", blanklines);
490                                 g_free(blanklines); 
491                                 g_free(blanks);
492
493                                 if(win->height > 0) 
494                                         gtk_text_buffer_insert(buffer, &end, "\n", 1);
495
496                                 gtk_text_buffer_insert(buffer, &end, vertical_blanks, -1);
497                         }
498
499                         // Trim or expand lines
500                         if(new_width < win->width) {
501                                 gtk_text_buffer_get_start_iter(buffer, &start);
502                                 end = start;
503
504                                 gint line;
505                                 for(line = 0; line <= new_height; line++) {
506                                         // Trim the line
507                                         gtk_text_iter_forward_cursor_positions(&start, new_width);
508                                         gtk_text_iter_forward_to_line_end(&end);
509                                         gtk_text_buffer_delete(buffer, &start, &end);
510                                         gtk_text_iter_forward_line(&start);
511                                         end = start;
512                                 }
513                         } else if(new_width > win->width) {
514                                 gint chars_to_add = new_width - win->width;
515                                 gchar *horizontal_blanks = g_strnfill(chars_to_add, ' ');
516
517                                 gtk_text_buffer_get_start_iter(buffer, &start);
518                                 end = start;
519
520                                 gint line;
521                                 for(line = 0; line <= new_height; line++) {
522                                         gtk_text_iter_forward_to_line_end(&start);
523                                         end = start;
524                                         gint start_offset = gtk_text_iter_get_offset(&start);
525                                         gtk_text_buffer_insert(buffer, &end, horizontal_blanks, -1);
526                                         gtk_text_buffer_get_iter_at_offset(buffer, &start, start_offset);
527                                         gtk_text_iter_forward_line(&start);
528                                         end = start;
529                                 }
530
531                                 g_free(horizontal_blanks);
532                         }
533                 }
534         
535                 gboolean arrange = !(win->width == new_width && win->height == new_height);
536                 win->width = new_width;
537                 win->height = new_height;
538                 return arrange? win : NULL;
539         }
540         
541         /* For non-pair, non-text-grid windows, just give them the size */
542         gtk_widget_size_allocate(win->frame, allocation);
543         return NULL;
544 }
545
546 /* Overrides gtk_widget_size_allocate */
547 static void
548 chimara_glk_size_allocate(GtkWidget *widget, GtkAllocation *allocation)
549 {
550     g_return_if_fail(widget);
551     g_return_if_fail(allocation);
552     g_return_if_fail(CHIMARA_IS_GLK(widget));
553     
554     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(widget);
555     
556     gtk_widget_set_allocation(widget, allocation);
557
558     if(priv->root_window) {
559                 GtkAllocation child = *allocation;
560                 winid_t arrange = allocate_recurse(priv->root_window->data, &child, priv->spacing);
561
562                 /* arrange points to a window that contains all text grid and graphics
563                  windows which have been resized */
564                 g_mutex_lock(priv->arrange_lock);
565                 if(!priv->ignore_next_arrange_event)
566                 {
567                         if(arrange)
568                                 event_throw(CHIMARA_GLK(widget), evtype_Arrange, arrange == priv->root_window->data? NULL : arrange, 0, 0);
569                 }
570                 else
571                         priv->ignore_next_arrange_event = FALSE;
572                 priv->needs_rearrange = FALSE;
573                 g_cond_signal(priv->rearranged);
574                 g_mutex_unlock(priv->arrange_lock);
575         }
576 }
577
578 /* Recursively invoke callback() on the GtkWidget of each non-pair window in the tree */
579 static void
580 forall_recurse(winid_t win, GtkCallback callback, gpointer callback_data)
581 {
582         if(win->type == wintype_Pair)
583         {
584                 forall_recurse(win->window_node->children->data, callback, callback_data);
585                 forall_recurse(win->window_node->children->next->data, callback, callback_data);
586         }
587         else
588                 (*callback)(win->frame, callback_data);
589 }
590
591 /* Overrides gtk_container_forall */
592 static void
593 chimara_glk_forall(GtkContainer *container, gboolean include_internals, GtkCallback callback, gpointer callback_data)
594 {
595     g_return_if_fail(container);
596     g_return_if_fail(CHIMARA_IS_GLK(container));
597     
598     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(container);
599     
600         /* All the children are "internal" */
601         if(!include_internals)
602                 return;
603         
604     if(priv->root_window)
605                 forall_recurse(priv->root_window->data, callback, callback_data);
606 }
607
608 static void
609 chimara_glk_stopped(ChimaraGlk *self)
610 {
611     CHIMARA_GLK_USE_PRIVATE(self, priv);
612     priv->running = FALSE;
613     priv->program_name = NULL;
614     g_object_notify(G_OBJECT(self), "program-name");
615     priv->program_info = NULL;
616     g_object_notify(G_OBJECT(self), "program-info");
617     priv->story_name = NULL;
618     g_object_notify(G_OBJECT(self), "story-name");
619 }
620
621 static void
622 chimara_glk_started(ChimaraGlk *self)
623 {
624         CHIMARA_GLK_USE_PRIVATE(self, priv);
625         priv->running = TRUE;
626 }
627
628 static void
629 chimara_glk_waiting(ChimaraGlk *self)
630 {
631         /* Default signal handler */
632 }
633
634 static void
635 chimara_glk_char_input(ChimaraGlk *self, guint window_rock, guint keysym)
636 {
637         /* Default signal handler */
638 }
639
640 static void
641 chimara_glk_line_input(ChimaraGlk *self, guint window_rock, gchar *text)
642 {
643         /* Default signal handler */
644 }
645
646 static void
647 chimara_glk_text_buffer_output(ChimaraGlk *self, guint window_rock, gchar *text)
648 {
649         /* Default signal handler */
650 }
651
652 static void
653 chimara_glk_iliad_screen_update(ChimaraGlk *self, gboolean typing)
654 {
655         /* Default signal handler */
656 }
657
658 static void
659 chimara_glk_class_init(ChimaraGlkClass *klass)
660 {
661     /* Override methods of parent classes */
662     GObjectClass *object_class = G_OBJECT_CLASS(klass);
663     object_class->set_property = chimara_glk_set_property;
664     object_class->get_property = chimara_glk_get_property;
665     object_class->finalize = chimara_glk_finalize;
666     
667     GtkWidgetClass *widget_class = GTK_WIDGET_CLASS(klass);
668     widget_class->get_request_mode = chimara_glk_get_request_mode;
669     widget_class->get_preferred_width = chimara_glk_get_preferred_width;
670     widget_class->get_preferred_height = chimara_glk_get_preferred_height;
671     widget_class->size_allocate = chimara_glk_size_allocate;
672
673     GtkContainerClass *container_class = GTK_CONTAINER_CLASS(klass);
674     container_class->forall = chimara_glk_forall;
675     /* Automatically handle the GtkContainer:border-width property */
676     gtk_container_class_handle_border_width(container_class);
677
678     /* Signals */
679     klass->stopped = chimara_glk_stopped;
680     klass->started = chimara_glk_started;
681     klass->waiting = chimara_glk_waiting;
682     klass->char_input = chimara_glk_char_input;
683     klass->line_input = chimara_glk_line_input;
684     klass->text_buffer_output = chimara_glk_text_buffer_output;
685     klass->iliad_screen_update = chimara_glk_iliad_screen_update;
686
687     /**
688      * ChimaraGlk::stopped:
689      * @glk: The widget that received the signal
690      *
691      * Emitted when the a Glk program finishes executing in the widget, whether
692      * it ended normally, or was interrupted.
693      */ 
694     chimara_glk_signals[STOPPED] = g_signal_new("stopped", 
695         G_OBJECT_CLASS_TYPE(klass), G_SIGNAL_RUN_FIRST, 
696         /* FIXME: Should be G_SIGNAL_RUN_CLEANUP but that segfaults??! */
697         G_STRUCT_OFFSET(ChimaraGlkClass, stopped), NULL, NULL,
698                 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
699         /**
700          * ChimaraGlk::started:
701          * @glk: The widget that received the signal
702          *
703          * Emitted when a Glk program starts executing in the widget.
704          */
705         chimara_glk_signals[STARTED] = g_signal_new ("started",
706                 G_OBJECT_CLASS_TYPE(klass), G_SIGNAL_RUN_FIRST,
707                 G_STRUCT_OFFSET(ChimaraGlkClass, started), NULL, NULL,
708                 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
709         /**
710          * ChimaraGlk::waiting:
711          * @glk: The widget that received the signal
712          * 
713          * Emitted when glk_select() is called by the Glk program and the event
714          * queue is empty, which means that the widget is waiting for input.
715          */
716         chimara_glk_signals[WAITING] = g_signal_new("waiting",
717                 G_OBJECT_CLASS_TYPE(klass), 0,
718                 G_STRUCT_OFFSET(ChimaraGlkClass, waiting), NULL, NULL,
719                 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
720         /**
721          * ChimaraGlk::char-input:
722          * @glk: The widget that received the signal
723          * @window_rock: The rock value of the window that received character input
724          * (see <link linkend="chimara-Rocks">Rocks</link>)
725          * @keysym: The key that was typed, in the form of a key symbol from 
726          * <filename class="headerfile">gdk/gdkkeysyms.h</filename>
727          * 
728          * Emitted when a Glk window receives character input.
729          */
730         chimara_glk_signals[CHAR_INPUT] = g_signal_new("char-input",
731                 G_OBJECT_CLASS_TYPE(klass), 0,
732                 G_STRUCT_OFFSET(ChimaraGlkClass, char_input), NULL, NULL,
733                 _chimara_marshal_VOID__UINT_UINT,
734                 G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_UINT);
735         /**
736          * ChimaraGlk::line-input:
737          * @glk: The widget that received the signal
738          * @window_rock: The rock value of the window that received line input (see
739          * <link linkend="chimara-Rocks">Rocks</link>)
740          * @text: The text that was typed
741          * 
742          * Emitted when a Glk window receives line input.
743          */
744         chimara_glk_signals[LINE_INPUT] = g_signal_new("line-input",
745                 G_OBJECT_CLASS_TYPE(klass), 0,
746                 G_STRUCT_OFFSET(ChimaraGlkClass, line_input), NULL, NULL,
747                 _chimara_marshal_VOID__UINT_STRING,
748                 G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_STRING);
749         /**
750          * ChimaraGlk::text-buffer-output:
751          * @glk: The widget that received the signal
752          * @window_rock: The rock value of the window that was printed to (see <link
753          * linkend="chimara-Rocks">Rocks</link>)
754          * 
755          * Emitted when text is printed to a text buffer window.
756          */
757         chimara_glk_signals[TEXT_BUFFER_OUTPUT] = g_signal_new("text-buffer-output",
758                 G_OBJECT_CLASS_TYPE(klass), 0,
759                 G_STRUCT_OFFSET(ChimaraGlkClass, text_buffer_output), NULL, NULL,
760                 _chimara_marshal_VOID__UINT_STRING,
761                 G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_STRING);
762         /**
763          * ChimaraGlk::iliad-screen-update:
764          * @self: The widget that received the signal
765          * @typing: Whether to perform a typing or full screen update
766          *
767          * Iliad specific signal which is emitted whenever the screen needs to be updated.
768          * Since iliad screen updates are very slow, updating should only be done when
769          * necessary.
770          */
771         chimara_glk_signals[ILIAD_SCREEN_UPDATE] = g_signal_new("iliad-screen-update",
772                 G_OBJECT_CLASS_TYPE(klass), 0,
773                 G_STRUCT_OFFSET(ChimaraGlkClass, iliad_screen_update), NULL, NULL,
774                 _chimara_marshal_VOID__BOOLEAN,
775                 G_TYPE_NONE, 1, G_TYPE_BOOLEAN);
776
777     /* Properties */
778     /**
779      * ChimaraGlk:interactive:
780      *
781      * Sets whether the widget is interactive. A Glk widget is normally 
782      * interactive, but in non-interactive mode, keyboard and mouse input are 
783      * ignored and the Glk program is controlled by 
784      * chimara_glk_feed_char_input() and chimara_glk_feed_line_input(). 
785      * <quote>More</quote> prompts when a lot of text is printed to a text 
786          * buffer are also disabled. This is typically used when you wish to control
787          * an interpreter program by feeding it a predefined list of commands.
788      */
789     g_object_class_install_property( object_class, PROP_INTERACTIVE, 
790                 g_param_spec_boolean("interactive", _("Interactive"),
791         _("Whether user input is expected in the Glk program"),
792         TRUE,
793         G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
794
795         /**
796      * ChimaraGlk:protect:
797      *
798      * Sets whether the Glk program is allowed to do file operations. In protect
799      * mode, all file operations will fail.
800      */
801     g_object_class_install_property(object_class, PROP_PROTECT, 
802                 g_param_spec_boolean("protect", _("Protected"),
803         _("Whether the Glk program is barred from doing file operations"),
804         FALSE,
805         G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
806
807         /**
808          * ChimaraGlk:spacing:
809          *
810          * The amount of space between the Glk windows. This space forms a visible
811          * border between windows; however, if you open a window using the
812          * %winmethod_NoBorder flag, there will be no spacing between it and its
813          * sibling window, no matter what the value of this property is.
814          */
815         g_object_class_install_property(object_class, PROP_SPACING,
816                 g_param_spec_uint("spacing", _("Spacing"),
817                 _("The amount of space between Glk windows"),
818                 0, G_MAXUINT, 0,
819                 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
820         
821         /**
822          * ChimaraGlk:program-name:
823          *
824          * The name of the currently running Glk program. You cannot set this 
825          * property yourself. It is set to the filename of the plugin when you call
826          * chimara_glk_run(), but the plugin can change it by calling 
827          * garglk_set_program_name(). To find out when this information changes,
828          * for example to put the program name in the title bar of a window, connect
829          * to the <code>::notify::program-name</code> signal.
830          */
831         g_object_class_install_property(object_class, PROP_PROGRAM_NAME,
832                 g_param_spec_string("program-name", _("Program name"),
833                 _("Name of the currently running program"),
834                 NULL,
835                 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
836                 
837         /**
838          * ChimaraGlk:program-info:
839          *
840          * Information about the currently running Glk program. You cannot set this
841          * property yourself. The plugin can change it by calling
842          * garglk_set_program_info(). See also #ChimaraGlk:program-name.
843          */
844         g_object_class_install_property(object_class, PROP_PROGRAM_INFO,
845                 g_param_spec_string("program-info", _("Program info"),
846                 _("Information about the currently running program"),
847                 NULL,
848                 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
849         
850         /**
851          * ChimaraGlk:story-name:
852          *
853          * The name of the story currently running in the Glk interpreter. You
854          * cannot set this property yourself. It is set to the story filename when
855          * you call chimara_if_run_game(), but the plugin can change it by calling
856          * garglk_set_story_name().
857          *
858          * Strictly speaking, this should be a property of #ChimaraIF, but it is
859          * legal for any Glk program to call garglk_set_story_name(), even if it is
860          * not an interpreter and does not load story files.
861          */
862         g_object_class_install_property(object_class, PROP_STORY_NAME,
863                 g_param_spec_string("story-name", _("Story name"),
864                 _("Name of the story currently loaded in the interpreter"),
865                 NULL,
866                 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
867         
868         /**
869          * ChimaraGlk:running:
870          *
871          * Whether this Glk widget is currently running a game or not.
872          */
873         g_object_class_install_property(object_class, PROP_RUNNING,
874                 g_param_spec_boolean("running", _("Running"),
875                 _("Whether there is a program currently running"),
876                 FALSE,
877                 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
878
879         /* Private data */
880     g_type_class_add_private(klass, sizeof(ChimaraGlkPrivate));
881 }
882
883 /* PUBLIC FUNCTIONS */
884
885 /**
886  * chimara_error_quark:
887  *
888  * The error domain for errors from Chimara widgets.
889  *
890  * Returns: The string <quote>chimara-error-quark</quote> as a <link 
891  * linkend="GQuark">GQuark</link>.
892  */
893 GQuark
894 chimara_error_quark(void)
895 {
896         chimara_init(); /* This is a library entry point */
897         return g_quark_from_static_string("chimara-error-quark");
898 }
899
900 /**
901  * chimara_glk_new:
902  *
903  * Creates and initializes a new #ChimaraGlk widget.
904  *
905  * Return value: a #ChimaraGlk widget, with a floating reference.
906  */
907 GtkWidget *
908 chimara_glk_new(void)
909 {
910         /* This is a library entry point; initialize the library */
911         chimara_init();
912
913     return GTK_WIDGET(g_object_new(CHIMARA_TYPE_GLK, NULL));
914 }
915
916 /**
917  * chimara_glk_set_interactive:
918  * @glk: a #ChimaraGlk widget
919  * @interactive: whether the widget should expect user input
920  *
921  * Sets the #ChimaraGlk:interactive property of @glk. 
922  */
923 void 
924 chimara_glk_set_interactive(ChimaraGlk *glk, gboolean interactive)
925 {
926     g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
927     
928     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
929     priv->interactive = interactive;
930     g_object_notify(G_OBJECT(glk), "interactive");
931 }
932
933 /**
934  * chimara_glk_get_interactive:
935  * @glk: a #ChimaraGlk widget
936  *
937  * Returns whether @glk is interactive (expecting user input). See 
938  * #ChimaraGlk:interactive.
939  *
940  * Return value: %TRUE if @glk is interactive.
941  */
942 gboolean 
943 chimara_glk_get_interactive(ChimaraGlk *glk)
944 {
945     g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
946     
947     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
948     return priv->interactive;
949 }
950
951 /**
952  * chimara_glk_set_protect:
953  * @glk: a #ChimaraGlk widget
954  * @protect: whether the widget should allow the Glk program to do file 
955  * operations
956  *
957  * Sets the #ChimaraGlk:protect property of @glk. In protect mode, the Glk 
958  * program is not allowed to do file operations.
959  */
960 void 
961 chimara_glk_set_protect(ChimaraGlk *glk, gboolean protect)
962 {
963     g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
964     
965     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
966     priv->protect = protect;
967     g_object_notify(G_OBJECT(glk), "protect");
968 }
969
970 /**
971  * chimara_glk_get_protect:
972  * @glk: a #ChimaraGlk widget
973  *
974  * Returns whether @glk is in protect mode (banned from doing file operations).
975  * See #ChimaraGlk:protect.
976  *
977  * Return value: %TRUE if @glk is in protect mode.
978  */
979 gboolean 
980 chimara_glk_get_protect(ChimaraGlk *glk)
981 {
982     g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
983     
984     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
985     return priv->protect;
986 }
987
988 /**
989  * chimara_glk_set_css_to_default:
990  * @glk: a #ChimaraGlk widget
991  *
992  * Resets the styles for text buffer and text grid windows to their defaults.
993  * <para><warning>
994  *   This function is not implemented yet.
995  * </warning></para>
996  */
997 void
998 chimara_glk_set_css_to_default(ChimaraGlk *glk)
999 {
1000         reset_default_styles(glk);
1001 }
1002
1003 /**
1004  * chimara_glk_set_css_from_file:
1005  * @glk: a #ChimaraGlk widget
1006  * @filename: path to a CSS file, or %NULL
1007  * @error: location to store a <link 
1008  * linkend="glib-Error-Reporting">GError</link>, or %NULL
1009  *
1010  * Sets the styles for text buffer and text grid windows according to the CSS
1011  * file @filename. Note that the styles are set cumulatively on top of whatever
1012  * the styles are at the time this function is called; to reset the styles to
1013  * their defaults, use chimara_glk_set_css_to_default().
1014  *
1015  * Returns: %TRUE on success, %FALSE if an error occurred, in which case @error
1016  * will be set.
1017  */
1018 gboolean 
1019 chimara_glk_set_css_from_file(ChimaraGlk *glk, const gchar *filename, GError **error)
1020 {
1021         g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1022         g_return_val_if_fail(filename, FALSE);
1023         g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
1024
1025         int fd = open(filename, O_RDONLY);
1026         if(fd == -1) {
1027                 if(error)
1028                         *error = g_error_new(G_IO_ERROR, g_io_error_from_errno(errno), 
1029                                 _("Error opening file \"%s\": %s"), filename, g_strerror(errno));
1030                 return FALSE;
1031         }
1032
1033         GScanner *scanner = create_css_file_scanner();
1034         g_scanner_input_file(scanner, fd);
1035         scanner->input_name = filename;
1036         scan_css_file(scanner, glk);
1037
1038         if(close(fd) == -1) {
1039                 if(error)
1040                         *error = g_error_new(G_IO_ERROR, g_io_error_from_errno(errno),
1041                                 _("Error closing file \"%s\": %s"), filename, g_strerror(errno));
1042                 return FALSE;
1043         }
1044         return TRUE;
1045 }
1046
1047 /**
1048  * chimara_glk_set_css_from_string:
1049  * @glk: a #ChimaraGlk widget
1050  * @css: a string containing CSS code
1051  *
1052  * Sets the styles for text buffer and text grid windows according to the CSS
1053  * code @css. Note that the styles are set cumulatively on top of whatever the 
1054  * styles are at the time this function is called; to reset the styles to their
1055  * defaults, use chimara_glk_set_css_to_default().
1056  */
1057 void 
1058 chimara_glk_set_css_from_string(ChimaraGlk *glk, const gchar *css)
1059 {
1060         g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1061         g_return_if_fail(css || *css);
1062         
1063         GScanner *scanner = create_css_file_scanner();
1064         g_scanner_input_text(scanner, css, strlen(css));
1065         scanner->input_name = "<string>";
1066         scan_css_file(scanner, glk);
1067 }
1068
1069 /**
1070  * chimara_glk_set_spacing:
1071  * @glk: a #ChimaraGlk widget
1072  * @spacing: the number of pixels to put between Glk windows
1073  *
1074  * Sets the #ChimaraGlk:spacing property of @glk, which is the border width in
1075  * pixels between Glk windows.
1076  */
1077 void 
1078 chimara_glk_set_spacing(ChimaraGlk *glk, guint spacing)
1079 {
1080         g_return_if_fail( glk || CHIMARA_IS_GLK(glk) );
1081         
1082         ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1083         priv->spacing = spacing;
1084         g_object_notify(G_OBJECT(glk), "spacing");
1085 }
1086
1087 /**
1088  * chimara_glk_get_spacing:
1089  * @glk: a #ChimaraGlk widget
1090  *
1091  * Gets the value set by chimara_glk_set_spacing().
1092  *
1093  * Return value: pixels of spacing between Glk windows
1094  */
1095 guint 
1096 chimara_glk_get_spacing(ChimaraGlk *glk)
1097 {
1098         g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), 0);
1099         
1100         ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1101         return priv->spacing;
1102 }
1103
1104 struct StartupData {
1105         glk_main_t glk_main;
1106         glkunix_startup_code_t glkunix_startup_code;
1107         glkunix_startup_t args;
1108         ChimaraGlkPrivate *glk_data;
1109 };
1110
1111 static void
1112 free_startup_data(struct StartupData *startup)
1113 {
1114         int i = 0;
1115         while(i < startup->args.argc)
1116                 g_free(startup->args.argv[i++]);
1117         g_free(startup->args.argv);
1118 }
1119
1120 /* glk_enter() is the actual function called in the new thread in which glk_main() runs.  */
1121 static gpointer
1122 glk_enter(struct StartupData *startup)
1123 {
1124         extern GPrivate *glk_data_key;
1125         g_private_set(glk_data_key, startup->glk_data);
1126         
1127         /* Acquire the Glk thread's references to the input queues */
1128         g_async_queue_ref(startup->glk_data->char_input_queue);
1129         g_async_queue_ref(startup->glk_data->line_input_queue);
1130         
1131         /* Run startup function */
1132         if(startup->glkunix_startup_code) {
1133                 startup->glk_data->in_startup = TRUE;
1134                 int result = startup->glkunix_startup_code(&startup->args);
1135                 startup->glk_data->in_startup = FALSE;
1136
1137                 if(!result) {
1138                         free_startup_data(startup);
1139                         return NULL;
1140                 }
1141         }
1142         
1143         /* Run main function */
1144         glk_main_t glk_main = startup->glk_main;
1145         
1146         /* COMPAT: avoid usage of slices */
1147         g_free(startup);
1148     g_signal_emit_by_name(startup->glk_data->self, "started");
1149         glk_main();
1150         free_startup_data(startup);
1151         glk_exit(); /* Run shutdown code in glk_exit() even if glk_main() returns normally */
1152         g_assert_not_reached(); /* because glk_exit() calls g_thread_exit() */
1153         return NULL; 
1154 }
1155
1156 /**
1157  * chimara_glk_run:
1158  * @glk: a #ChimaraGlk widget
1159  * @plugin: path to a plugin module compiled with <filename 
1160  * class="header">glk.h</filename>
1161  * @argc: Number of command line arguments in @argv
1162  * @argv: Array of command line arguments to pass to the plugin
1163  * @error: location to store a <link 
1164  * linkend="glib-Error-Reporting">GError</link>, or %NULL
1165  *
1166  * Opens a Glk program compiled as a plugin. Sorts out its command line
1167  * arguments from #glkunix_arguments, calls its startup function
1168  * glkunix_startup_code(), and then calls its main function glk_main() in
1169  * a separate thread. On failure, returns %FALSE and sets @error.
1170  *
1171  * The plugin must at least export a glk_main() function; #glkunix_arguments and
1172  * glkunix_startup_code() are optional.
1173  *
1174  * Return value: %TRUE if the Glk program was started successfully.
1175  */
1176 gboolean
1177 chimara_glk_run(ChimaraGlk *glk, const gchar *plugin, int argc, char *argv[], GError **error)
1178 {
1179     g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1180     g_return_val_if_fail(plugin, FALSE);
1181         g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
1182         
1183         if(chimara_glk_get_running(glk)) {
1184                 g_set_error(error, CHIMARA_ERROR, CHIMARA_PLUGIN_ALREADY_RUNNING, _("There was already a plugin running."));
1185                 return FALSE;
1186         }
1187     
1188     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1189
1190         /* COMPAT: avoid usage of slices */
1191         struct StartupData *startup = g_new0(struct StartupData,1);
1192         
1193     g_assert( g_module_supported() );
1194         /* If there is already a module loaded, free it first -- you see, we want to
1195          * keep modules loaded as long as possible to avoid crashes in stack unwinding */
1196         chimara_glk_unload_plugin(glk);
1197         /* Open the module to run */
1198     priv->program = g_module_open(plugin, G_MODULE_BIND_LAZY);
1199     
1200     if(!priv->program)
1201     {
1202         g_set_error(error, CHIMARA_ERROR, CHIMARA_LOAD_MODULE_ERROR, _("Error opening module: %s"), g_module_error());
1203         return FALSE;
1204     }
1205     if( !g_module_symbol(priv->program, "glk_main", (gpointer *) &startup->glk_main) )
1206     {
1207         g_set_error(error, CHIMARA_ERROR, CHIMARA_NO_GLK_MAIN, _("Error finding glk_main(): %s"), g_module_error());
1208         return FALSE;
1209     }
1210
1211     if( g_module_symbol(priv->program, "glkunix_startup_code", (gpointer *) &startup->glkunix_startup_code) )
1212     {
1213                 glkunix_argumentlist_t *glkunix_arguments;
1214
1215                 if( !(g_module_symbol(priv->program, "glkunix_arguments", (gpointer *) &glkunix_arguments) 
1216                           && parse_command_line(glkunix_arguments, argc, argv, &startup->args)) )
1217                 {
1218                         /* arguments could not be parsed, so create data ourselves */
1219                         startup->args.argc = 1;
1220                         startup->args.argv = g_new0(gchar *, 1);
1221                 }
1222
1223                 /* Set the program invocation name */
1224                 startup->args.argv[0] = g_strdup(plugin);
1225     }
1226         startup->glk_data = priv;
1227         
1228         /* Set the program name */
1229         priv->program_name = g_path_get_basename(plugin);
1230         g_object_notify(G_OBJECT(glk), "program-name");
1231         
1232     /* Run in a separate thread */
1233         priv->thread = g_thread_create((GThreadFunc)glk_enter, startup, TRUE, error);
1234         
1235         return !(priv->thread == NULL);
1236 }
1237
1238 /**
1239  * chimara_glk_run_file:
1240  * @self: a #ChimaraGlk widget
1241  * @plugin_file: a #GFile pointing to a plugin module compiled with <filename
1242  * class="header">glk.h</filename>
1243  * @argc: Number of command line arguments in @argv
1244  * @argv: Array of command line arguments to pass to the plugin
1245  * @error: location to store a <link
1246  * linkend="glib-Error-Reporting">GError</link>, or %NULL
1247  *
1248  * Opens a Glk program compiled as a plugin, from a #GFile. See
1249  * chimara_glk_run() for details.
1250  *
1251  * Return value: %TRUE if the Glk program was started successfully.
1252  */
1253 gboolean
1254 chimara_glk_run_file(ChimaraGlk *self, GFile *plugin_file, int argc, char *argv[], GError **error)
1255 {
1256         g_return_val_if_fail(self || CHIMARA_IS_GLK(self), FALSE);
1257         g_return_val_if_fail(plugin_file || G_IS_FILE(plugin_file), FALSE);
1258         g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
1259
1260         char *path = g_file_get_path(plugin_file);
1261         gboolean retval = chimara_glk_run(self, path, argc, argv, error);
1262         g_free(path);
1263
1264         return retval;
1265 }
1266
1267 /**
1268  * chimara_glk_stop:
1269  * @glk: a #ChimaraGlk widget
1270  *
1271  * Signals the Glk program running in @glk to abort. Note that if the program is
1272  * caught in an infinite loop in which glk_tick() is not called, this may not
1273  * work.
1274  *
1275  * This function does nothing if no Glk program is running.
1276  */
1277 void
1278 chimara_glk_stop(ChimaraGlk *glk)
1279 {
1280     g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1281     CHIMARA_GLK_USE_PRIVATE(glk, priv);
1282
1283     /* Don't do anything if not running a program */
1284     if(!priv->running)
1285         return;
1286     
1287         if(priv->abort_lock) {
1288                 g_mutex_lock(priv->abort_lock);
1289                 priv->abort_signalled = TRUE;
1290                 g_mutex_unlock(priv->abort_lock);
1291                 /* Stop blocking on the event queue condition */
1292                 event_throw(glk, evtype_Abort, NULL, 0, 0);
1293                 /* Stop blocking on the shutdown key press condition */
1294                 g_mutex_lock(priv->shutdown_lock);
1295                 g_cond_signal(priv->shutdown_key_pressed);
1296                 g_mutex_unlock(priv->shutdown_lock);
1297         }
1298 }
1299
1300 /**
1301  * chimara_glk_wait:
1302  * @glk: a #ChimaraGlk widget
1303  *
1304  * Holds up the main thread and waits for the Glk program running in @glk to 
1305  * finish.
1306  *
1307  * This function does nothing if no Glk program is running.
1308  */
1309 void
1310 chimara_glk_wait(ChimaraGlk *glk)
1311 {
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 */
1315     if(!priv->running)
1316         return;
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();
1321 }
1322
1323 /**
1324  * chimara_glk_unload_plugin:
1325  * @glk: a #ChimaraGlk widget
1326  *
1327  * The plugin containing the Glk program is unloaded as late as possible before
1328  * loading a new plugin, in order to prevent crashes while printing stack
1329  * backtraces during debugging. Sometimes this behavior is not desirable. This
1330  * function forces @glk to unload the plugin running in it.
1331  *
1332  * This function does nothing if there is no plugin loaded.
1333  */
1334 void
1335 chimara_glk_unload_plugin(ChimaraGlk *glk)
1336 {
1337         g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1338     CHIMARA_GLK_USE_PRIVATE(glk, priv);
1339         if( priv->program && !g_module_close(priv->program) )
1340                 g_warning( "Error closing module :%s", g_module_error() );
1341 }
1342
1343 /**
1344  * chimara_glk_get_running:
1345  * @glk: a #ChimaraGlk widget
1346  * 
1347  * Use this function to tell whether a program is currently running in the
1348  * widget.
1349  * 
1350  * Returns: %TRUE if @glk is executing a Glk program, %FALSE otherwise.
1351  */
1352 gboolean
1353 chimara_glk_get_running(ChimaraGlk *glk)
1354 {
1355         g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1356         CHIMARA_GLK_USE_PRIVATE(glk, priv);
1357         return priv->running;
1358 }
1359
1360 /**
1361  * chimara_glk_feed_char_input:
1362  * @glk: a #ChimaraGlk widget
1363  * @keyval: a key symbol as defined in <filename 
1364  * class="headerfile">gdk/gdkkeysyms.h</filename>
1365  * 
1366  * Pretend that a key was pressed in the Glk program as a response to a 
1367  * character input request. You can call this function even when no window has
1368  * requested character input, in which case the key will be saved for the 
1369  * following window that requests character input. This has the disadvantage 
1370  * that if more than one window has requested character input, it is arbitrary 
1371  * which one gets the key press.
1372  */
1373 void 
1374 chimara_glk_feed_char_input(ChimaraGlk *glk, guint keyval)
1375 {
1376         g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1377         CHIMARA_GLK_USE_PRIVATE(glk, priv);
1378         g_async_queue_push(priv->char_input_queue, GUINT_TO_POINTER(keyval));
1379         event_throw(glk, evtype_ForcedCharInput, NULL, 0, 0);
1380 }
1381
1382 /**
1383  * chimara_glk_feed_line_input:
1384  * @glk: a #ChimaraGlk widget
1385  * @text: text to pass to the next line input request
1386  * 
1387  * Pretend that @text was typed in the Glk program as a response to a line input
1388  * request. @text does not need to end with a newline. You can call this 
1389  * function even when no window has requested line input, in which case the text
1390  * will be saved for the following window that requests line input. This has the 
1391  * disadvantage that if more than one window has requested line input, it is
1392  * arbitrary which one gets the text.
1393  */
1394 void 
1395 chimara_glk_feed_line_input(ChimaraGlk *glk, const gchar *text)
1396 {
1397         g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1398         g_return_if_fail(text);
1399         CHIMARA_GLK_USE_PRIVATE(glk, priv);
1400         g_async_queue_push(priv->line_input_queue, g_strdup(text));
1401         event_throw(glk, evtype_ForcedLineInput, NULL, 0, 0);
1402 }
1403
1404 /**
1405  * chimara_glk_is_char_input_pending:
1406  * @glk: a #ChimaraGlk widget
1407  *
1408  * Use this function to tell if character input forced by 
1409  * chimara_glk_feed_char_input() has been passed to an input request or not.
1410  *
1411  * Returns: %TRUE if forced character input is pending, %FALSE otherwise.
1412  */
1413 gboolean
1414 chimara_glk_is_char_input_pending(ChimaraGlk *glk)
1415 {
1416         g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1417         CHIMARA_GLK_USE_PRIVATE(glk, priv);
1418         return g_async_queue_length(priv->char_input_queue) > 0;
1419 }
1420
1421 /**
1422  * chimara_glk_is_line_input_pending:
1423  * @glk: a #ChimaraGlk widget
1424  *
1425  * Use this function to tell if line input forced by 
1426  * chimara_glk_feed_line_input() has been passed to an input request or not.
1427  *
1428  * Returns: %TRUE if forced line input is pending, %FALSE otherwise.
1429  */
1430 gboolean
1431 chimara_glk_is_line_input_pending(ChimaraGlk *glk)
1432 {
1433         g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1434         CHIMARA_GLK_USE_PRIVATE(glk, priv);
1435         return g_async_queue_length(priv->line_input_queue) > 0;
1436 }
1437
1438 /**
1439  * chimara_glk_get_tag:
1440  * @glk: a #ChimaraGlk widget
1441  * @window: The type of window to retrieve the tag for
1442  * @name: The name of the tag to retrieve
1443  *
1444  * Use this function to get a #GtkTextTag so style properties can be changed.
1445  * See also chimara_glk_set_css_from_string().
1446  *
1447  * The layout of the text in Chimara is controlled by two sets of tags: one set
1448  * describing the style in text buffers and one for text grids. See also the
1449  * Glk specification for the difference between the two. The main narrative of
1450  * a game is usually rendered in text buffers, whereas text grids are mostly
1451  * used for status bars and in game menus.
1452  *
1453  * The following tag names are supported:
1454  * <itemizedlist>
1455  *      <listitem><para>normal</para></listitem>
1456  *      <listitem><para>emphasized</para></listitem>
1457  *      <listitem><para>preformatted</para></listitem>
1458  *      <listitem><para>header</para></listitem>
1459  *      <listitem><para>subheader</para></listitem>
1460  *      <listitem><para>alert</para></listitem>
1461  *      <listitem><para>note</para></listitem>
1462  *      <listitem><para>block-quote</para></listitem>
1463  *      <listitem><para>input</para></listitem>
1464  *      <listitem><para>user1</para></listitem>
1465  *      <listitem><para>user2</para></listitem>
1466  *      <listitem><para>hyperlink</para></listitem>
1467  *      <listitem><para>pager</para></listitem>
1468  * </itemizedlist>
1469  *
1470  * Returns: (transfer none): The #GtkTextTag corresponding to @name in the
1471  * styles of @window.
1472  */
1473 GtkTextTag *
1474 chimara_glk_get_tag(ChimaraGlk *glk, ChimaraGlkWindowType window, const gchar *name)
1475 {
1476         CHIMARA_GLK_USE_PRIVATE(glk, priv);
1477
1478         switch(window) {
1479         case CHIMARA_GLK_TEXT_BUFFER:
1480                 return GTK_TEXT_TAG( g_hash_table_lookup(priv->styles->text_buffer, name) );
1481                 break;
1482         case CHIMARA_GLK_TEXT_GRID:
1483                 return GTK_TEXT_TAG( g_hash_table_lookup(priv->styles->text_grid, name) );
1484                 break;
1485         default:
1486                 ILLEGAL_PARAM("Unknown window type: %u", window);
1487                 return NULL;
1488         }
1489 }
1490
1491 /**
1492  * chimara_glk_get_tag_names:
1493  * @glk: a #ChimaraGlk widget
1494  * @num_tags: Return location for the number of tag names retrieved.
1495  *
1496  * Retrieves the possible tag names to use in chimara_glk_get_tag().
1497  *
1498  * Returns: (transfer none) (array length=num_tags) (element-type utf8):
1499  * Array of strings containing the tag names. This array is owned by Chimara,
1500  * do not free it.
1501  */
1502 const gchar **
1503 chimara_glk_get_tag_names(ChimaraGlk *glk, unsigned int *num_tags)
1504 {
1505         g_return_val_if_fail(num_tags != NULL, NULL);
1506
1507         *num_tags = CHIMARA_NUM_STYLES;
1508         return style_get_tag_names();
1509 }
1510
1511 /**
1512  * chimara_glk_set_resource_load_callback:
1513  * @glk: a #ChimaraGlk widget
1514  * @func: a function to call for loading resources, or %NULL
1515  * @user_data: user data to pass to @func, or %NULL
1516  * @destroy_user_data: a function to call for freeing @user_data, or %NULL
1517  *
1518  * Sometimes it is preferable to load image and sound resources from somewhere
1519  * else than a Blorb file, for example while developing a game. Section 14 of
1520  * the <ulink url="http://eblong.com/zarf/blorb/blorb.html#s14">Blorb
1521  * specification</ulink> allows for this possibility. This function sets @func
1522  * to be called when the Glk program requests loading an image or sound without
1523  * a Blorb resource map having been loaded, optionally passing @user_data as an 
1524  * extra parameter.
1525  *
1526  * Note that @func is only called if no Blorb resource map has been set; having
1527  * a resource map in place overrides this function.
1528  *
1529  * If you pass non-%NULL for @destroy_user_data, then @glk takes ownership of
1530  * @user_data. When it is not needed anymore, it will be freed by calling
1531  * @destroy_user_data on it. If you wish to retain ownership of @user_data, pass
1532  * %NULL for @destroy_user_data.
1533  *
1534  * To deactivate the callback, call this function with @func set to %NULL.
1535  */
1536 void
1537 chimara_glk_set_resource_load_callback(ChimaraGlk *glk, ChimaraResourceLoadFunc func, gpointer user_data, GDestroyNotify destroy_user_data)
1538 {
1539         CHIMARA_GLK_USE_PRIVATE(glk, priv);
1540
1541         if(priv->resource_load_callback == func
1542                 && priv->resource_load_callback_data == user_data
1543                 && priv->resource_load_callback_destroy_data == destroy_user_data)
1544                 return;
1545
1546         if(priv->resource_load_callback_destroy_data)
1547                 priv->resource_load_callback_destroy_data(priv->resource_load_callback_data);
1548
1549         priv->resource_load_callback = func;
1550         priv->resource_load_callback_data = user_data;
1551         priv->resource_load_callback_destroy_data = destroy_user_data;
1552 }