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