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 "chimara-glk.h"
  15 #include "chimara-glk-private.h"
  16 #include "chimara-marshallers.h"
  17 #include "glk.h"
  18 #include "abort.h"
  19 #include "stream.h"
  20 #include "window.h"
  21 #include "glkstart.h"
  22 #include "glkunix.h"
  23 #include "init.h"
  24 #include "magic.h"
  25
  26 #define CHIMARA_GLK_MIN_WIDTH 0
  27 #define CHIMARA_GLK_MIN_HEIGHT 0
  28
  29 /**
  30  * SECTION:chimara-glk
  31  * @short_description: Widget which executes a Glk program
  32  * @stability: Unstable
  33  * @include: libchimara/chimara-glk.h
  34  *
  35  * The #ChimaraGlk widget opens and runs a Glk program. The program must be
  36  * compiled as a plugin module, with a function <function>glk_main()</function>
  37  * that the Glk library can hook into.
  38  *
  39  * On Linux systems, this is a file with a name like
  40  * <filename>plugin.so</filename>. For portability, you can use libtool and
  41  * automake:
  42  * |[
  43  * pkglib_LTLIBRARIES = plugin.la
  44  * plugin_la_SOURCES = plugin.c foo.c bar.c
  45  * plugin_la_LDFLAGS = -module -shared -avoid-version -export-symbols-regex "^glk_main$$"
  46  * ]|
  47  * This will produce <filename>plugin.la</filename> which is a text file
  48  * containing the correct plugin file to open (see the relevant section of the
  49  * <ulink
  50  * url="http://www.gnu.org/software/libtool/manual/html_node/Finding-the-dlname.html">
  51  * Libtool manual</ulink>).
  52  *
  53  * You need to initialize multithreading in any program you use a #ChimaraGlk
  54  * widget in. This means including the following incantation at the beginning
  55  * of your program:
  56  * |[
  57  * if(!g_thread_supported())
  58  *     g_thread_init(NULL);
  59  * gdk_threads_init();
  60  * ]|
  61  * This initialization must take place <emphasis>before</emphasis> the call to
  62  * gtk_init(). In addition to this, you must also protect your call to
  63  * gtk_main() by calling gdk_threads_enter() right before it, and
  64  * gdk_threads_leave() right after it.
  65  *
  66  * The following sample program shows how to initialize and construct a simple
  67  * GTK window that runs a Glk program:
  68  * |[
  69  * #include <glib.h>
  70  * #include <gtk/gtk.h>
  71  * #include <libchimara/chimara-glk.h>
  72  *
  73  * static gboolean
  74  * quit(void)
  75  * {
  76  *     gtk_main_quit();
  77  *     return TRUE;
  78  * }
  79  *
  80  * int
  81  * main(int argc, char *argv[])
  82  * {
  83  *     GtkWidget *window, *glk;
  84  *     GError *error = NULL;
  85  *     gchar *plugin_argv[] = { "plugin.so", "-option" };
  86  *
  87  *     /<!---->* Initialize threads and GTK *<!---->/
  88  *     if(!g_thread_supported())
  89  *         g_thread_init(NULL);
  90  *     gdk_threads_init();
  91  *     gtk_init(&argc, &argv);
  92  *
  93  *     /<!---->* Construct the window and its contents. We quit the GTK main loop
  94  *      * when the window's close button is clicked. *<!---->/
  95  *     window = gtk_window_new(GTK_WINDOW_TOPLEVEL);
  96  *     g_signal_connect(window, "delete-event", G_CALLBACK(quit), NULL);
  97  *     glk = chimara_glk_new();
  98  *     gtk_container_add(GTK_CONTAINER(window), glk);
  99  *     gtk_widget_show_all(window);
 100  *
 101  *     /<!---->* Start the Glk program in a separate thread *<!---->/
 102  *     if(!chimara_glk_run(CHIMARA_GLK(glk), "./plugin.so", 2, plugin_argv, &error))
 103  *         g_error("Error starting Glk library: %s\n", error->message);
 104  *
 105  *     /<!---->* Start the GTK main loop *<!---->/
 106  *     gdk_threads_enter();
 107  *     gtk_main();
 108  *     gdk_threads_leave();
 109  *
 110  *     /<!---->* After the GTK main loop exits, signal the Glk program to shut down if
 111  *      * it is still running, and wait for it to exit. *<!---->/
 112  *     chimara_glk_stop(CHIMARA_GLK(glk));
 113  *     chimara_glk_wait(CHIMARA_GLK(glk));
 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         /* Should be g_async_queue_new_full(g_free); but only in GTK >= 2.16 */
 181         priv->resource_lock = g_mutex_new();
 182         priv->resource_loaded = g_cond_new();
 183         priv->resource_info_available = g_cond_new();
 184         priv->image_cache = NULL;
 185         priv->program_name = NULL;
 186         priv->program_info = NULL;
 187         priv->story_name = NULL;
 188         priv->interrupt_handler = NULL;
 189     priv->root_window = NULL;
 190     priv->fileref_list = NULL;
 191     priv->current_stream = NULL;
 192     priv->stream_list = NULL;
 193         priv->timer_id = 0;
 194         priv->in_startup = FALSE;
 195         priv->current_dir = NULL;
 196
 197         style_init(self);
 198 }
 199
 200 static void
 201 chimara_glk_set_property(GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
 202 {
 203     ChimaraGlk *glk = CHIMARA_GLK(object);
 204
 205     switch(prop_id)
 206     {
 207         case PROP_INTERACTIVE:
 208             chimara_glk_set_interactive( glk, g_value_get_boolean(value) );
 209             break;
 210         case PROP_PROTECT:
 211             chimara_glk_set_protect( glk, g_value_get_boolean(value) );
 212             break;
 213                 case PROP_SPACING:
 214                         chimara_glk_set_spacing( glk, g_value_get_uint(value) );
 215                         break;
 216         default:
 217             G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
 218     }
 219 }
 220
 221 static void
 222 chimara_glk_get_property(GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
 223 {
 224     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(object);
 225
 226     switch(prop_id)
 227     {
 228         case PROP_INTERACTIVE:
 229             g_value_set_boolean(value, priv->interactive);
 230             break;
 231         case PROP_PROTECT:
 232             g_value_set_boolean(value, priv->protect);
 233             break;
 234                 case PROP_SPACING:
 235                         g_value_set_uint(value, priv->spacing);
 236                         break;
 237                 case PROP_PROGRAM_NAME:
 238                         g_value_set_string(value, priv->program_name);
 239                         break;
 240                 case PROP_PROGRAM_INFO:
 241                         g_value_set_string(value, priv->program_info);
 242                         break;
 243                 case PROP_STORY_NAME:
 244                         g_value_set_string(value, priv->story_name);
 245                         break;
 246                 default:
 247             G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
 248     }
 249 }
 250
 251 static void
 252 chimara_glk_finalize(GObject *object)
 253 {
 254     ChimaraGlk *self = CHIMARA_GLK(object);
 255         CHIMARA_GLK_USE_PRIVATE(self, priv);
 256
 257         /* Free widget properties */
 258         g_free(priv->final_message);
 259         /* Free styles */
 260         g_hash_table_destroy(priv->styles->text_buffer);
 261         g_hash_table_destroy(priv->styles->text_grid);
 262         g_hash_table_destroy(priv->glk_styles->text_buffer);
 263         g_hash_table_destroy(priv->glk_styles->text_grid);
 264         pango_attr_list_unref(priv->pager_attr_list);
 265
 266     /* Free the event queue */
 267     g_mutex_lock(priv->event_lock);
 268         g_queue_foreach(priv->event_queue, (GFunc)g_free, NULL);
 269         g_queue_free(priv->event_queue);
 270         g_cond_free(priv->event_queue_not_empty);
 271         g_cond_free(priv->event_queue_not_full);
 272         priv->event_queue = NULL;
 273         g_mutex_unlock(priv->event_lock);
 274         g_mutex_free(priv->event_lock);
 275     /* Free the abort signaling mechanism */
 276         g_mutex_lock(priv->abort_lock);
 277         /* Make sure no other thread is busy with this */
 278         g_mutex_unlock(priv->abort_lock);
 279         g_mutex_free(priv->abort_lock);
 280         priv->abort_lock = NULL;
 281         /* Free the shutdown keypress signaling mechanism */
 282         g_mutex_lock(priv->shutdown_lock);
 283         g_cond_free(priv->shutdown_key_pressed);
 284         g_mutex_unlock(priv->shutdown_lock);
 285         priv->shutdown_lock = NULL;
 286         /* Free the window arrangement signaling */
 287         g_mutex_lock(priv->arrange_lock);
 288         g_cond_free(priv->rearranged);
 289         g_mutex_unlock(priv->arrange_lock);
 290         g_mutex_free(priv->arrange_lock);
 291         priv->arrange_lock = NULL;
 292         g_mutex_lock(priv->resource_lock);
 293         g_cond_free(priv->resource_loaded);
 294         g_cond_free(priv->resource_info_available);
 295         g_mutex_unlock(priv->resource_lock);
 296         g_mutex_free(priv->resource_lock);
 297         g_slist_foreach(priv->image_cache, (GFunc)clear_image_cache, NULL);
 298         g_slist_free(priv->image_cache);
 299         /* Unref input queues (this should destroy them since any Glk thread has stopped by now */
 300         g_async_queue_unref(priv->char_input_queue);
 301         g_async_queue_unref(priv->line_input_queue);
 302
 303         /* Free other stuff */
 304         g_free(priv->current_dir);
 305         g_free(priv->program_name);
 306         g_free(priv->program_info);
 307         g_free(priv->story_name);
 308
 309         /* Chain up to parent */
 310     G_OBJECT_CLASS(chimara_glk_parent_class)->finalize(object);
 311 }
 312
 313 /* Internal function: Recursively get the Glk window tree's size request */
 314 static void
 315 request_recurse(winid_t win, GtkRequisition *requisition, guint spacing)
 316 {
 317         if(win->type == wintype_Pair)
 318         {
 319                 /* Get children's size requests */
 320                 GtkRequisition child1, child2;
 321                 request_recurse(win->window_node->children->data, &child1, spacing);
 322                 request_recurse(win->window_node->children->next->data, &child2, spacing);
 323
 324                 glui32 division = win->split_method & winmethod_DivisionMask;
 325                 glui32 direction = win->split_method & winmethod_DirMask;
 326
 327                 /* If the split is fixed, get the size of the fixed child */
 328                 if(division == winmethod_Fixed)
 329                 {
 330                         switch(direction)
 331                         {
 332                                 case winmethod_Left:
 333                                         child1.width = win->key_window?
 334                                                 win->constraint_size * win->key_window->unit_width
 335                                                 : 0;
 336                                         break;
 337                                 case winmethod_Right:
 338                                         child2.width = win->key_window?
 339                                                 win->constraint_size * win->key_window->unit_width
 340                                                 : 0;
 341                                         break;
 342                                 case winmethod_Above:
 343                                         child1.height = win->key_window?
 344                                                 win->constraint_size * win->key_window->unit_height
 345                                                 : 0;
 346                                         break;
 347                                 case winmethod_Below:
 348                                         child2.height = win->key_window?
 349                                                 win->constraint_size * win->key_window->unit_height
 350                                                 : 0;
 351                                         break;
 352                         }
 353                 }
 354
 355                 /* Add the children's requests */
 356                 switch(direction)
 357                 {
 358                         case winmethod_Left:
 359                         case winmethod_Right:
 360                                 requisition->width = child1.width + child2.width + spacing;
 361                                 requisition->height = MAX(child1.height, child2.height);
 362                                 break;
 363                         case winmethod_Above:
 364                         case winmethod_Below:
 365                                 requisition->width = MAX(child1.width, child2.width);
 366                                 requisition->height = child1.height + child2.height + spacing;
 367                                 break;
 368                 }
 369         }
 370
 371         /* For non-pair windows, just use the size that GTK requests */
 372         else
 373                 gtk_widget_size_request(win->frame, requisition);
 374 }
 375
 376 /* Overrides gtk_widget_size_request */
 377 static void
 378 chimara_glk_size_request(GtkWidget *widget, GtkRequisition *requisition)
 379 {
 380     g_return_if_fail(widget);
 381     g_return_if_fail(requisition);
 382     g_return_if_fail(CHIMARA_IS_GLK(widget));
 383
 384     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(widget);
 385
 386     /* For now, just pass the size request on to the root Glk window */
 387     if(priv->root_window)
 388         {
 389                 request_recurse(priv->root_window->data, requisition, priv->spacing);
 390                 requisition->width += 2 * GTK_CONTAINER(widget)->border_width;
 391                 requisition->height += 2 * GTK_CONTAINER(widget)->border_width;
 392         }
 393         else
 394         {
 395         requisition->width = CHIMARA_GLK_MIN_WIDTH + 2 * GTK_CONTAINER(widget)->border_width;
 396         requisition->height = CHIMARA_GLK_MIN_HEIGHT + 2 * GTK_CONTAINER(widget)->border_width;
 397     }
 398 }
 399
 400 /* Recursively give the Glk windows their allocated space. Returns a window
 401  containing all children of this window that must be redrawn, or NULL if there
 402  are no children that require redrawing. */
 403 static winid_t
 404 allocate_recurse(winid_t win, GtkAllocation *allocation, guint spacing)
 405 {
 406         if(win->type == wintype_Pair)
 407         {
 408                 glui32 division = win->split_method & winmethod_DivisionMask;
 409                 glui32 direction = win->split_method & winmethod_DirMask;
 410
 411                 /* If the space gets too small to honor the spacing property, then just
 412                  ignore spacing in this window and below. */
 413                 if( (spacing > allocation->width && (direction == winmethod_Left || direction == winmethod_Right))
 414                    || (spacing > allocation->height && (direction == winmethod_Above || direction == winmethod_Below)) )
 415                         spacing = 0;
 416
 417                 GtkAllocation child1, child2;
 418                 child1.x = allocation->x;
 419                 child1.y = allocation->y;
 420
 421                 if(division == winmethod_Fixed)
 422                 {
 423                         /* If the key window has been closed, then default to 0; otherwise
 424                          use the key window to determine the size */
 425                         switch(direction)
 426                         {
 427                                 case winmethod_Left:
 428                                         child1.width = win->key_window?
 429                                                 CLAMP(win->constraint_size * win->key_window->unit_width, 0, allocation->width - spacing)
 430                                                 : 0;
 431                                         break;
 432                                 case winmethod_Right:
 433                                         child2.width = win->key_window?
 434                                                 CLAMP(win->constraint_size * win->key_window->unit_width, 0, allocation->width - spacing)
 435                                                 : 0;
 436                                         break;
 437                                 case winmethod_Above:
 438                                         child1.height = win->key_window?
 439                                                 CLAMP(win->constraint_size * win->key_window->unit_height, 0, allocation->height - spacing)
 440                                                 : 0;
 441                                         break;
 442                                 case winmethod_Below:
 443                                         child2.height = win->key_window?
 444                                                 CLAMP(win->constraint_size * win->key_window->unit_height, 0, allocation->height - spacing)
 445                                                 : 0;
 446                                         break;
 447                         }
 448                 }
 449                 else /* proportional */
 450                 {
 451                         gdouble fraction = win->constraint_size / 100.0;
 452                         switch(direction)
 453                         {
 454                                 case winmethod_Left:
 455                                         child1.width = MAX(0, (gint)ceil(fraction * (allocation->width - spacing)) );
 456                                         break;
 457                                 case winmethod_Right:
 458                                         child2.width = MAX(0, (gint)ceil(fraction * (allocation->width - spacing)) );
 459                                         break;
 460                                 case winmethod_Above:
 461                                         child1.height = MAX(0, (gint)ceil(fraction * (allocation->height - spacing)) );
 462                                         break;
 463                                 case winmethod_Below:
 464                                         child2.height = MAX(0, (gint)ceil(fraction * (allocation->height - spacing)) );
 465                                         break;
 466                         }
 467                 }
 468
 469                 /* Fill in the rest of the size requisitions according to the child specified above */
 470                 switch(direction)
 471                 {
 472                         case winmethod_Left:
 473                                 child2.width = MAX(0, allocation->width - spacing - child1.width);
 474                                 child2.x = child1.x + child1.width + spacing;
 475                                 child2.y = child1.y;
 476                                 child1.height = child2.height = allocation->height;
 477                                 break;
 478                         case winmethod_Right:
 479                                 child1.width = MAX(0, allocation->width - spacing - child2.width);
 480                                 child2.x = child1.x + child1.width + spacing;
 481                                 child2.y = child1.y;
 482                                 child1.height = child2.height = allocation->height;
 483                                 break;
 484                         case winmethod_Above:
 485                                 child2.height = MAX(0, allocation->height - spacing - child1.height);
 486                                 child2.x = child1.x;
 487                                 child2.y = child1.y + child1.height + spacing;
 488                                 child1.width = child2.width = allocation->width;
 489                                 break;
 490                         case winmethod_Below:
 491                                 child1.height = MAX(0, allocation->height - spacing - child2.height);
 492                                 child2.x = child1.x;
 493                                 child2.y = child1.y + child1.height + spacing;
 494                                 child1.width = child2.width = allocation->width;
 495                                 break;
 496                 }
 497
 498                 /* Recurse */
 499                 winid_t arrange1 = allocate_recurse(win->window_node->children->data, &child1, spacing);
 500                 winid_t arrange2 = allocate_recurse(win->window_node->children->next->data, &child2, spacing);
 501                 if(arrange1 == NULL)
 502                         return arrange2;
 503                 if(arrange2 == NULL)
 504                         return arrange1;
 505                 return win;
 506         }
 507
 508         else if(win->type == wintype_TextGrid)
 509         {
 510                 /* Pass the size allocation on to the framing widget */
 511                 gtk_widget_size_allocate(win->frame, allocation);
 512                 /* It says in the spec that when a text grid window is resized smaller,
 513                  the bottom or right area is thrown away; when it is resized larger, the
 514                  bottom or right area is filled with blanks. */
 515                 glui32 newwidth = (glui32)(win->widget->allocation.width / win->unit_width);
 516                 glui32 newheight = (glui32)(win->widget->allocation.height / win->unit_height);
 517                 gint line;
 518                 GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
 519                 GtkTextIter start, end;
 520
 521                 for(line = 0; line < win->height; line++)
 522                 {
 523                         gtk_text_buffer_get_iter_at_line(textbuffer, &start, line);
 524                         /* If this line is going to fall off the bottom, delete it */
 525                         if(line >= newheight)
 526                         {
 527                                 end = start;
 528                                 gtk_text_iter_forward_to_line_end(&end);
 529                                 gtk_text_iter_forward_char(&end);
 530                                 gtk_text_buffer_delete(textbuffer, &start, &end);
 531                                 break;
 532                         }
 533                         /* If this line is not long enough, add spaces on the end */
 534                         if(newwidth > win->width)
 535                         {
 536                                 gchar *spaces = g_strnfill(newwidth - win->width, ' ');
 537                                 gtk_text_iter_forward_to_line_end(&start);
 538                                 gtk_text_buffer_insert(textbuffer, &start, spaces, -1);
 539                                 g_free(spaces);
 540                         }
 541                         /* But if it's too long, delete characters from the end */
 542                         else if(newwidth < win->width)
 543                         {
 544                                 end = start;
 545                                 gtk_text_iter_forward_chars(&start, newwidth);
 546                                 gtk_text_iter_forward_to_line_end(&end);
 547                                 gtk_text_buffer_delete(textbuffer, &start, &end);
 548                         }
 549                         /* Note: if the widths are equal, do nothing */
 550                 }
 551                 /* Add blank lines if there aren't enough lines to fit the new size */
 552                 if(newheight > win->height)
 553                 {
 554                         gchar *blanks = g_strnfill(win->width, ' ');
 555                     gchar **blanklines = g_new0(gchar *, (newheight - win->height) + 1);
 556                     int count;
 557                     for(count = 0; count < newheight - win->height; count++)
 558                         blanklines[count] = blanks;
 559                     blanklines[newheight - win->height] = NULL;
 560                     gchar *text = g_strjoinv("\n", blanklines);
 561                     g_free(blanklines); /* not g_strfreev() */
 562                     g_free(blanks);
 563
 564                         gtk_text_buffer_get_end_iter(textbuffer, &start);
 565                         gtk_text_buffer_insert(textbuffer, &start, "\n", -1);
 566                     gtk_text_buffer_insert(textbuffer, &start, text, -1);
 567                     g_free(text);
 568                 }
 569
 570                 gboolean arrange = !(win->width == newwidth && win->height == newheight);
 571                 win->width = newwidth;
 572                 win->height = newheight;
 573                 return arrange? win : NULL;
 574         }
 575
 576         /* For non-pair, non-text-grid windows, just give them the size */
 577         gtk_widget_size_allocate(win->frame, allocation);
 578         return NULL;
 579 }
 580
 581 /* Overrides gtk_widget_size_allocate */
 582 static void
 583 chimara_glk_size_allocate(GtkWidget *widget, GtkAllocation *allocation)
 584 {
 585     g_return_if_fail(widget);
 586     g_return_if_fail(allocation);
 587     g_return_if_fail(CHIMARA_IS_GLK(widget));
 588
 589     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(widget);
 590
 591     widget->allocation = *allocation;
 592
 593     if(priv->root_window) {
 594                 GtkAllocation child;
 595                 child.x = allocation->x + GTK_CONTAINER(widget)->border_width;
 596                 child.y = allocation->y + GTK_CONTAINER(widget)->border_width;
 597                 child.width = CLAMP(allocation->width - 2 * GTK_CONTAINER(widget)->border_width, 0, allocation->width);
 598                 child.height = CLAMP(allocation->height - 2 * GTK_CONTAINER(widget)->border_width, 0, allocation->height);
 599                 winid_t arrange = allocate_recurse(priv->root_window->data, &child, priv->spacing);
 600
 601                 /* arrange points to a window that contains all text grid and graphics
 602                  windows which have been resized */
 603                 g_mutex_lock(priv->arrange_lock);
 604                 if(!priv->ignore_next_arrange_event)
 605                 {
 606                         if(arrange)
 607                                 event_throw(CHIMARA_GLK(widget), evtype_Arrange, arrange == priv->root_window->data? NULL : arrange, 0, 0);
 608                 }
 609                 else
 610                         priv->ignore_next_arrange_event = FALSE;
 611                 priv->needs_rearrange = FALSE;
 612                 g_cond_signal(priv->rearranged);
 613                 g_mutex_unlock(priv->arrange_lock);
 614         }
 615 }
 616
 617 /* Recursively invoke callback() on the GtkWidget of each non-pair window in the tree */
 618 static void
 619 forall_recurse(winid_t win, GtkCallback callback, gpointer callback_data)
 620 {
 621         if(win->type == wintype_Pair)
 622         {
 623                 forall_recurse(win->window_node->children->data, callback, callback_data);
 624                 forall_recurse(win->window_node->children->next->data, callback, callback_data);
 625         }
 626         else
 627                 (*callback)(win->frame, callback_data);
 628 }
 629
 630 /* Overrides gtk_container_forall */
 631 static void
 632 chimara_glk_forall(GtkContainer *container, gboolean include_internals, GtkCallback callback, gpointer callback_data)
 633 {
 634     g_return_if_fail(container);
 635     g_return_if_fail(CHIMARA_IS_GLK(container));
 636
 637     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(container);
 638
 639         /* All the children are "internal" */
 640         if(!include_internals)
 641                 return;
 642
 643     if(priv->root_window)
 644                 forall_recurse(priv->root_window->data, callback, callback_data);
 645 }
 646
 647 static void
 648 chimara_glk_stopped(ChimaraGlk *self)
 649 {
 650     CHIMARA_GLK_USE_PRIVATE(self, priv);
 651     priv->running = FALSE;
 652     priv->program_name = NULL;
 653     g_object_notify(G_OBJECT(self), "program-name");
 654     priv->program_info = NULL;
 655     g_object_notify(G_OBJECT(self), "program-info");
 656     priv->story_name = NULL;
 657     g_object_notify(G_OBJECT(self), "story-name");
 658 }
 659
 660 static void
 661 chimara_glk_started(ChimaraGlk *self)
 662 {
 663         CHIMARA_GLK_USE_PRIVATE(self, priv);
 664         priv->running = TRUE;
 665 }
 666
 667 static void
 668 chimara_glk_waiting(ChimaraGlk *self)
 669 {
 670         /* Default signal handler */
 671 }
 672
 673 static void
 674 chimara_glk_char_input(ChimaraGlk *self, guint window_rock, guint keysym)
 675 {
 676         /* Default signal handler */
 677 }
 678
 679 static void
 680 chimara_glk_line_input(ChimaraGlk *self, guint window_rock, gchar *text)
 681 {
 682         /* Default signal handler */
 683 }
 684
 685 static void
 686 chimara_glk_text_buffer_output(ChimaraGlk *self, guint window_rock, gchar *text)
 687 {
 688         /* Default signal handler */
 689 }
 690
 691 static void
 692 chimara_glk_iliad_screen_update(ChimaraGlk *self, gboolean typing)
 693 {
 694         /* Default signal handler */
 695 }
 696
 697 /* COMPAT: G_PARAM_STATIC_STRINGS only appeared in GTK 2.13.0 */
 698 #ifndef G_PARAM_STATIC_STRINGS
 699
 700 /* COMPAT: G_PARAM_STATIC_NAME and friends only appeared in GTK 2.8 */
 701 #if GTK_CHECK_VERSION(2,8,0)
 702 #define G_PARAM_STATIC_STRINGS (G_PARAM_STATIC_NAME | G_PARAM_STATIC_NICK | G_PARAM_STATIC_BLURB)
 703 #else
 704 #define G_PARAM_STATIC_STRINGS (0)
 705 #endif
 706
 707 #endif
 708
 709 static void
 710 chimara_glk_class_init(ChimaraGlkClass *klass)
 711 {
 712     /* Override methods of parent classes */
 713     GObjectClass *object_class = G_OBJECT_CLASS(klass);
 714     object_class->set_property = chimara_glk_set_property;
 715     object_class->get_property = chimara_glk_get_property;
 716     object_class->finalize = chimara_glk_finalize;
 717
 718     GtkWidgetClass *widget_class = GTK_WIDGET_CLASS(klass);
 719     widget_class->size_request = chimara_glk_size_request;
 720     widget_class->size_allocate = chimara_glk_size_allocate;
 721
 722     GtkContainerClass *container_class = GTK_CONTAINER_CLASS(klass);
 723     container_class->forall = chimara_glk_forall;
 724
 725     /* Signals */
 726     klass->stopped = chimara_glk_stopped;
 727     klass->started = chimara_glk_started;
 728     klass->waiting = chimara_glk_waiting;
 729     klass->char_input = chimara_glk_char_input;
 730     klass->line_input = chimara_glk_line_input;
 731     klass->text_buffer_output = chimara_glk_text_buffer_output;
 732     klass->iliad_screen_update = chimara_glk_iliad_screen_update;
 733
 734     /**
 735      * ChimaraGlk::stopped:
 736      * @glk: The widget that received the signal
 737      *
 738      * Emitted when the a Glk program finishes executing in the widget, whether
 739      * it ended normally, or was interrupted.
 740      */
 741     chimara_glk_signals[STOPPED] = g_signal_new("stopped",
 742         G_OBJECT_CLASS_TYPE(klass), G_SIGNAL_RUN_FIRST,
 743         /* FIXME: Should be G_SIGNAL_RUN_CLEANUP but that segfaults??! */
 744         G_STRUCT_OFFSET(ChimaraGlkClass, stopped), NULL, NULL,
 745                 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
 746         /**
 747          * ChimaraGlk::started:
 748          * @glk: The widget that received the signal
 749          *
 750          * Emitted when a Glk program starts executing in the widget.
 751          */
 752         chimara_glk_signals[STARTED] = g_signal_new ("started",
 753                 G_OBJECT_CLASS_TYPE(klass), G_SIGNAL_RUN_FIRST,
 754                 G_STRUCT_OFFSET(ChimaraGlkClass, started), NULL, NULL,
 755                 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
 756         /**
 757          * ChimaraGlk::waiting:
 758          * @glk: The widget that received the signal
 759          *
 760          * Emitted when glk_select() is called by the Glk program and the event
 761          * queue is empty, which means that the widget is waiting for input.
 762          */
 763         chimara_glk_signals[WAITING] = g_signal_new("waiting",
 764                 G_OBJECT_CLASS_TYPE(klass), 0,
 765                 G_STRUCT_OFFSET(ChimaraGlkClass, waiting), NULL, NULL,
 766                 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
 767         /**
 768          * ChimaraGlk::char-input:
 769          * @glk: The widget that received the signal
 770          * @window_rock: The rock value of the window that received character input
 771          * (see <link linkend="chimara-Rocks">Rocks</link>)
 772          * @keysym: The key that was typed, in the form of a key symbol from
 773          * <filename class="headerfile">gdk/gdkkeysyms.h</filename>
 774          *
 775          * Emitted when a Glk window receives character input.
 776          */
 777         chimara_glk_signals[CHAR_INPUT] = g_signal_new("char-input",
 778                 G_OBJECT_CLASS_TYPE(klass), 0,
 779                 G_STRUCT_OFFSET(ChimaraGlkClass, char_input), NULL, NULL,
 780                 _chimara_marshal_VOID__UINT_UINT,
 781                 G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_UINT);
 782         /**
 783          * ChimaraGlk::line-input:
 784          * @glk: The widget that received the signal
 785          * @window_rock: The rock value of the window that received line input (see
 786          * <link linkend="chimara-Rocks">Rocks</link>)
 787          * @text: The text that was typed
 788          *
 789          * Emitted when a Glk window receives line input.
 790          */
 791         chimara_glk_signals[LINE_INPUT] = g_signal_new("line-input",
 792                 G_OBJECT_CLASS_TYPE(klass), 0,
 793                 G_STRUCT_OFFSET(ChimaraGlkClass, line_input), NULL, NULL,
 794                 _chimara_marshal_VOID__UINT_STRING,
 795                 G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_STRING);
 796         /**
 797          * ChimaraGlk::text-buffer-output:
 798          * @glk: The widget that received the signal
 799          * @window_rock: The rock value of the window that was printed to (see <link
 800          * linkend="chimara-Rocks">Rocks</link>)
 801          *
 802          * Emitted when text is printed to a text buffer window.
 803          */
 804         chimara_glk_signals[TEXT_BUFFER_OUTPUT] = g_signal_new("text-buffer-output",
 805                 G_OBJECT_CLASS_TYPE(klass), 0,
 806                 G_STRUCT_OFFSET(ChimaraGlkClass, text_buffer_output), NULL, NULL,
 807                 _chimara_marshal_VOID__UINT_STRING,
 808                 G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_STRING);
 809         /**
 810          * ChimaraGlk::iliad-update-screen:
 811          * @self: The widget that received the signal
 812          * @typing: Whether to perform a typing or full screen update
 813          *
 814          * Iliad specific signal which is emitted whenever the screen needs to be updated.
 815          * Since iliad screen updates are very slow, updating should only be done when
 816          * necessary.
 817          */
 818         chimara_glk_signals[ILIAD_SCREEN_UPDATE] = g_signal_new("iliad-screen-update",
 819                 G_OBJECT_CLASS_TYPE(klass), 0,
 820                 G_STRUCT_OFFSET(ChimaraGlkClass, iliad_screen_update), NULL, NULL,
 821                 _chimara_marshal_VOID__BOOLEAN,
 822                 G_TYPE_NONE, 1, G_TYPE_BOOLEAN);
 823
 824     /* Properties */
 825     /**
 826      * ChimaraGlk:interactive:
 827      *
 828      * Sets whether the widget is interactive. A Glk widget is normally
 829      * interactive, but in non-interactive mode, keyboard and mouse input are
 830      * ignored and the Glk program is controlled by
 831      * chimara_glk_feed_char_input() and chimara_glk_feed_line_input().
 832      * <quote>More</quote> prompts when a lot of text is printed to a text
 833          * buffer are also disabled. This is typically used when you wish to control
 834          * an interpreter program by feeding it a predefined list of commands.
 835      */
 836     g_object_class_install_property( object_class, PROP_INTERACTIVE,
 837                 g_param_spec_boolean("interactive", _("Interactive"),
 838         _("Whether user input is expected in the Glk program"),
 839         TRUE,
 840         G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
 841
 842         /**
 843      * ChimaraGlk:protect:
 844      *
 845      * Sets whether the Glk program is allowed to do file operations. In protect
 846      * mode, all file operations will fail.
 847      */
 848     g_object_class_install_property(object_class, PROP_PROTECT,
 849                 g_param_spec_boolean("protect", _("Protected"),
 850         _("Whether the Glk program is barred from doing file operations"),
 851         FALSE,
 852         G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
 853
 854         /**
 855          * ChimaraGlk:spacing:
 856          *
 857          * The amount of space between the Glk windows.
 858          */
 859         g_object_class_install_property(object_class, PROP_SPACING,
 860                 g_param_spec_uint("spacing", _("Spacing"),
 861                 _("The amount of space between Glk windows"),
 862                 0, G_MAXUINT, 0,
 863                 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
 864
 865         /**
 866          * ChimaraGlk:program-name:
 867          *
 868          * The name of the currently running Glk program. You cannot set this
 869          * property yourself. It is set to the filename of the plugin when you call
 870          * chimara_glk_run(), but the plugin can change it by calling
 871          * garglk_set_program_name(). To find out when this information changes,
 872          * for example to put the program name in the title bar of a window, connect
 873          * to the <code>::notify::program-name</code> signal.
 874          */
 875         g_object_class_install_property(object_class, PROP_PROGRAM_NAME,
 876                 g_param_spec_string("program-name", _("Program name"),
 877                 _("Name of the currently running program"),
 878                 NULL,
 879                 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
 880
 881         /**
 882          * ChimaraGlk:program-info:
 883          *
 884          * Information about the currently running Glk program. You cannot set this
 885          * property yourself. The plugin can change it by calling
 886          * garglk_set_program_info(). See also #ChimaraGlk:program-name.
 887          */
 888         g_object_class_install_property(object_class, PROP_PROGRAM_INFO,
 889                 g_param_spec_string("program-info", _("Program info"),
 890                 _("Information about the currently running program"),
 891                 NULL,
 892                 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
 893
 894         /**
 895          * ChimaraGlk:story-name:
 896          *
 897          * The name of the story currently running in the Glk interpreter. You
 898          * cannot set this property yourself. It is set to the story filename when
 899          * you call chimara_if_run_game(), but the plugin can change it by calling
 900          * garglk_set_story_name().
 901          *
 902          * Strictly speaking, this should be a property of #ChimaraIF, but it is
 903          * legal for any Glk program to call garglk_set_story_name(), even if it is
 904          * not an interpreter and does not load story files.
 905          */
 906         g_object_class_install_property(object_class, PROP_STORY_NAME,
 907                 g_param_spec_string("story-name", _("Story name"),
 908                 _("Name of the story currently loaded in the interpreter"),
 909                 NULL,
 910                 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
 911
 912         /* Private data */
 913     g_type_class_add_private(klass, sizeof(ChimaraGlkPrivate));
 914 }
 915
 916 /* PUBLIC FUNCTIONS */
 917
 918 /**
 919  * chimara_error_quark:
 920  *
 921  * The error domain for errors from Chimara widgets.
 922  *
 923  * Returns: The string <quote>chimara-error-quark</quote> as a <link
 924  * linkend="GQuark">GQuark</link>.
 925  */
 926 GQuark
 927 chimara_error_quark(void)
 928 {
 929         chimara_init(); /* This is a library entry point */
 930         return g_quark_from_static_string("chimara-error-quark");
 931 }
 932
 933 /**
 934  * chimara_glk_new:
 935  *
 936  * Creates and initializes a new #ChimaraGlk widget.
 937  *
 938  * Return value: a #ChimaraGlk widget, with a floating reference.
 939  */
 940 GtkWidget *
 941 chimara_glk_new(void)
 942 {
 943         /* This is a library entry point; initialize the library */
 944         chimara_init();
 945
 946     return GTK_WIDGET(g_object_new(CHIMARA_TYPE_GLK, NULL));
 947 }
 948
 949 /**
 950  * chimara_glk_set_interactive:
 951  * @glk: a #ChimaraGlk widget
 952  * @interactive: whether the widget should expect user input
 953  *
 954  * Sets the #ChimaraGlk:interactive property of @glk.
 955  */
 956 void
 957 chimara_glk_set_interactive(ChimaraGlk *glk, gboolean interactive)
 958 {
 959     g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
 960
 961     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
 962     priv->interactive = interactive;
 963     g_object_notify(G_OBJECT(glk), "interactive");
 964 }
 965
 966 /**
 967  * chimara_glk_get_interactive:
 968  * @glk: a #ChimaraGlk widget
 969  *
 970  * Returns whether @glk is interactive (expecting user input). See
 971  * #ChimaraGlk:interactive.
 972  *
 973  * Return value: %TRUE if @glk is interactive.
 974  */
 975 gboolean
 976 chimara_glk_get_interactive(ChimaraGlk *glk)
 977 {
 978     g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
 979
 980     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
 981     return priv->interactive;
 982 }
 983
 984 /**
 985  * chimara_glk_set_protect:
 986  * @glk: a #ChimaraGlk widget
 987  * @protect: whether the widget should allow the Glk program to do file
 988  * operations
 989  *
 990  * Sets the #ChimaraGlk:protect property of @glk. In protect mode, the Glk
 991  * program is not allowed to do file operations.
 992  */
 993 void
 994 chimara_glk_set_protect(ChimaraGlk *glk, gboolean protect)
 995 {
 996     g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
 997
 998     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
 999     priv->protect = protect;
1000     g_object_notify(G_OBJECT(glk), "protect");
1001 }
1002
1003 /**
1004  * chimara_glk_get_protect:
1005  * @glk: a #ChimaraGlk widget
1006  *
1007  * Returns whether @glk is in protect mode (banned from doing file operations).
1008  * See #ChimaraGlk:protect.
1009  *
1010  * Return value: %TRUE if @glk is in protect mode.
1011  */
1012 gboolean
1013 chimara_glk_get_protect(ChimaraGlk *glk)
1014 {
1015     g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1016
1017     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1018     return priv->protect;
1019 }
1020
1021 /**
1022  * chimara_glk_set_css_to_default:
1023  * @glk: a #ChimaraGlk widget
1024  *
1025  * Resets the styles for text buffer and text grid windows to their defaults.
1026  * <para><warning>
1027  *   This function is not implemented yet.
1028  * </warning></para>
1029  */
1030 void
1031 chimara_glk_set_css_to_default(ChimaraGlk *glk)
1032 {
1033         reset_default_styles(glk);
1034 }
1035
1036 /**
1037  * chimara_glk_set_css_from_file:
1038  * @glk: a #ChimaraGlk widget
1039  * @filename: path to a CSS file, or %NULL
1040  * @error: location to store a <link
1041  * linkend="glib-Error-Reporting">GError</link>, or %NULL
1042  *
1043  * Sets the styles for text buffer and text grid windows according to the CSS
1044  * file @filename. Note that the styles are set cumulatively on top of whatever
1045  * the styles are at the time this function is called; to reset the styles to
1046  * their defaults, use chimara_glk_set_css_to_default().
1047  *
1048  * Returns: %TRUE on success, %FALSE if an error occurred, in which case @error
1049  * will be set.
1050  */
1051 gboolean
1052 chimara_glk_set_css_from_file(ChimaraGlk *glk, const gchar *filename, GError **error)
1053 {
1054         g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1055         g_return_val_if_fail(filename, FALSE);
1056         g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
1057
1058         int fd = open(filename, O_RDONLY);
1059         if(fd == -1) {
1060                 *error = g_error_new(G_IO_ERROR, g_io_error_from_errno(errno),
1061                     _("Error opening file \"%s\": %s"), filename, g_strerror(errno));
1062                 return FALSE;
1063         }
1064
1065         GScanner *scanner = create_css_file_scanner();
1066         g_scanner_input_file(scanner, fd);
1067         scanner->input_name = filename;
1068         scan_css_file(scanner, glk);
1069
1070         if(close(fd) == -1) {
1071                 *error = g_error_new(G_IO_ERROR, g_io_error_from_errno(errno),
1072                     _("Error closing file \"%s\": %s"), filename, g_strerror(errno));
1073                 return FALSE;
1074         }
1075         return TRUE;
1076 }
1077
1078 /**
1079  * chimara_glk_set_css_from_string:
1080  * @glk: a #ChimaraGlk widget
1081  * @css: a string containing CSS code
1082  *
1083  * Sets the styles for text buffer and text grid windows according to the CSS
1084  * code @css. Note that the styles are set cumulatively on top of whatever the
1085  * styles are at the time this function is called; to reset the styles to their
1086  * defaults, use chimara_glk_set_css_to_default().
1087  */
1088 void
1089 chimara_glk_set_css_from_string(ChimaraGlk *glk, const gchar *css)
1090 {
1091         g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1092         g_return_if_fail(css || *css);
1093
1094         GScanner *scanner = create_css_file_scanner();
1095         g_scanner_input_text(scanner, css, strlen(css));
1096         scanner->input_name = "<string>";
1097         scan_css_file(scanner, glk);
1098 }
1099
1100 /**
1101  * chimara_glk_set_spacing:
1102  * @glk: a #ChimaraGlk widget
1103  * @spacing: the number of pixels to put between Glk windows
1104  *
1105  * Sets the #ChimaraGlk:spacing property of @glk, which is the border width in
1106  * pixels between Glk windows.
1107  */
1108 void
1109 chimara_glk_set_spacing(ChimaraGlk *glk, guint spacing)
1110 {
1111         g_return_if_fail( glk || CHIMARA_IS_GLK(glk) );
1112
1113         ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1114         priv->spacing = spacing;
1115         g_object_notify(G_OBJECT(glk), "spacing");
1116 }
1117
1118 /**
1119  * chimara_glk_get_spacing:
1120  * @glk: a #ChimaraGlk widget
1121  *
1122  * Gets the value set by chimara_glk_set_spacing().
1123  *
1124  * Return value: pixels of spacing between Glk windows
1125  */
1126 guint
1127 chimara_glk_get_spacing(ChimaraGlk *glk)
1128 {
1129         g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), 0);
1130
1131         ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1132         return priv->spacing;
1133 }
1134
1135 struct StartupData {
1136         glk_main_t glk_main;
1137         glkunix_startup_code_t glkunix_startup_code;
1138         glkunix_startup_t args;
1139         ChimaraGlkPrivate *glk_data;
1140 };
1141
1142 /* glk_enter() is the actual function called in the new thread in which glk_main() runs.  */
1143 static gpointer
1144 glk_enter(struct StartupData *startup)
1145 {
1146         extern GPrivate *glk_data_key;
1147         g_private_set(glk_data_key, startup->glk_data);
1148
1149         /* Acquire the Glk thread's references to the input queues */
1150         g_async_queue_ref(startup->glk_data->char_input_queue);
1151         g_async_queue_ref(startup->glk_data->line_input_queue);
1152
1153         /* Run startup function */
1154         if(startup->glkunix_startup_code) {
1155                 startup->glk_data->in_startup = TRUE;
1156                 int result = startup->glkunix_startup_code(&startup->args);
1157                 startup->glk_data->in_startup = FALSE;
1158
1159                 int i = 0;
1160                 while(i < startup->args.argc)
1161                         g_free(startup->args.argv[i++]);
1162                 g_free(startup->args.argv);
1163
1164                 if(!result)
1165                         return NULL;
1166         }
1167
1168         /* Run main function */
1169         glk_main_t glk_main = startup->glk_main;
1170
1171         /* COMPAT: avoid usage of slices */
1172         g_free(startup);
1173     g_signal_emit_by_name(startup->glk_data->self, "started");
1174         glk_main();
1175         glk_exit(); /* Run shutdown code in glk_exit() even if glk_main() returns normally */
1176         g_assert_not_reached(); /* because glk_exit() calls g_thread_exit() */
1177         return NULL;
1178 }
1179
1180 /**
1181  * chimara_glk_run:
1182  * @glk: a #ChimaraGlk widget
1183  * @plugin: path to a plugin module compiled with <filename
1184  * class="header">glk.h</filename>
1185  * @argc: Number of command line arguments in @argv
1186  * @argv: Array of command line arguments to pass to the plugin
1187  * @error: location to store a <link
1188  * linkend="glib-Error-Reporting">GError</link>, or %NULL
1189  *
1190  * Opens a Glk program compiled as a plugin. Sorts out its command line
1191  * arguments from #glkunix_arguments, calls its startup function
1192  * glkunix_startup_code(), and then calls its main function glk_main() in
1193  * a separate thread. On failure, returns %FALSE and sets @error.
1194  *
1195  * The plugin must at least export a glk_main() function; #glkunix_arguments and
1196  * glkunix_startup_code() are optional.
1197  *
1198  * Return value: %TRUE if the Glk program was started successfully.
1199  */
1200 gboolean
1201 chimara_glk_run(ChimaraGlk *glk, const gchar *plugin, int argc, char *argv[], GError **error)
1202 {
1203     g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1204     g_return_val_if_fail(plugin, FALSE);
1205         g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
1206
1207         if(chimara_glk_get_running(glk)) {
1208                 g_set_error(error, CHIMARA_ERROR, CHIMARA_PLUGIN_ALREADY_RUNNING, _("There was already a plugin running."));
1209                 return FALSE;
1210         }
1211
1212     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1213
1214         /* COMPAT: avoid usage of slices */
1215         struct StartupData *startup = g_new0(struct StartupData,1);
1216
1217     g_assert( g_module_supported() );
1218         /* If there is already a module loaded, free it first -- you see, we want to
1219          * keep modules loaded as long as possible to avoid crashes in stack unwinding */
1220         if( priv->program && !g_module_close(priv->program) )
1221                 g_warning( "Error closing module :%s", g_module_error() );
1222         /* Open the module to run */
1223     priv->program = g_module_open(plugin, G_MODULE_BIND_LAZY);
1224
1225     if(!priv->program)
1226     {
1227         g_set_error(error, CHIMARA_ERROR, CHIMARA_LOAD_MODULE_ERROR, _("Error opening module: %s"), g_module_error());
1228         return FALSE;
1229     }
1230     if( !g_module_symbol(priv->program, "glk_main", (gpointer *) &startup->glk_main) )
1231     {
1232         g_set_error(error, CHIMARA_ERROR, CHIMARA_NO_GLK_MAIN, _("Error finding glk_main(): %s"), g_module_error());
1233         return FALSE;
1234     }
1235
1236     if( g_module_symbol(priv->program, "glkunix_startup_code", (gpointer *) &startup->glkunix_startup_code) )
1237     {
1238                 glkunix_argumentlist_t *glkunix_arguments;
1239
1240                 if( !(g_module_symbol(priv->program, "glkunix_arguments", (gpointer *) &glkunix_arguments)
1241                           && parse_command_line(glkunix_arguments, argc, argv, &startup->args)) )
1242                 {
1243                         /* arguments could not be parsed, so create data ourselves */
1244                         startup->args.argc = 1;
1245                         startup->args.argv = g_new0(gchar *, 1);
1246                 }
1247
1248                 /* Set the program invocation name */
1249                 startup->args.argv[0] = g_strdup(plugin);
1250     }
1251         startup->glk_data = priv;
1252
1253         /* Set the program name */
1254         priv->program_name = g_path_get_basename(plugin);
1255         g_object_notify(G_OBJECT(glk), "program-name");
1256
1257     /* Run in a separate thread */
1258         priv->thread = g_thread_create((GThreadFunc)glk_enter, startup, TRUE, error);
1259
1260         return !(priv->thread == NULL);
1261 }
1262
1263 /**
1264  * chimara_glk_stop:
1265  * @glk: a #ChimaraGlk widget
1266  *
1267  * Signals the Glk program running in @glk to abort. Note that if the program is
1268  * caught in an infinite loop in which glk_tick() is not called, this may not
1269  * work.
1270  */
1271 void
1272 chimara_glk_stop(ChimaraGlk *glk)
1273 {
1274     g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1275     CHIMARA_GLK_USE_PRIVATE(glk, priv);
1276
1277     /* Don't do anything if not running a program */
1278     if(!priv->running)
1279         return;
1280
1281         if(priv->abort_lock) {
1282                 g_mutex_lock(priv->abort_lock);
1283                 priv->abort_signalled = TRUE;
1284                 g_mutex_unlock(priv->abort_lock);
1285                 /* Stop blocking on the event queue condition */
1286                 event_throw(glk, evtype_Abort, NULL, 0, 0);
1287                 /* Stop blocking on the shutdown key press condition */
1288                 g_mutex_lock(priv->shutdown_lock);
1289                 g_cond_signal(priv->shutdown_key_pressed);
1290                 g_mutex_unlock(priv->shutdown_lock);
1291         }
1292 }
1293
1294 /**
1295  * chimara_glk_wait:
1296  * @glk: a #ChimaraGlk widget
1297  *
1298  * Holds up the main thread and waits for the Glk program running in @glk to
1299  * finish.
1300  */
1301 void
1302 chimara_glk_wait(ChimaraGlk *glk)
1303 {
1304     g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1305     CHIMARA_GLK_USE_PRIVATE(glk, priv);
1306     /* Don't do anything if not running a program */
1307     if(!priv->running)
1308         return;
1309         /* Unlock GDK mutex, because the Glk program might need to use it for shutdown */
1310         gdk_threads_leave();
1311     g_thread_join(priv->thread);
1312         gdk_threads_enter();
1313 }
1314
1315 /**
1316  * chimara_glk_get_running:
1317  * @glk: a #ChimaraGlk widget
1318  *
1319  * Use this function to tell whether a program is currently running in the
1320  * widget.
1321  *
1322  * Returns: %TRUE if @glk is executing a Glk program, %FALSE otherwise.
1323  */
1324 gboolean
1325 chimara_glk_get_running(ChimaraGlk *glk)
1326 {
1327         g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1328         CHIMARA_GLK_USE_PRIVATE(glk, priv);
1329         return priv->running;
1330 }
1331
1332 /**
1333  * chimara_glk_feed_char_input:
1334  * @glk: a #ChimaraGlk widget
1335  * @keyval: a key symbol as defined in <filename
1336  * class="headerfile">gdk/gdkkeysyms.h</filename>
1337  *
1338  * Pretend that a key was pressed in the Glk program as a response to a
1339  * character input request. You can call this function even when no window has
1340  * requested character input, in which case the key will be saved for the
1341  * following window that requests character input. This has the disadvantage
1342  * that if more than one window has requested character input, it is arbitrary
1343  * which one gets the key press.
1344  */
1345 void
1346 chimara_glk_feed_char_input(ChimaraGlk *glk, guint keyval)
1347 {
1348         g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1349         CHIMARA_GLK_USE_PRIVATE(glk, priv);
1350         g_async_queue_push(priv->char_input_queue, GUINT_TO_POINTER(keyval));
1351         event_throw(glk, evtype_ForcedCharInput, NULL, 0, 0);
1352 }
1353
1354 /**
1355  * chimara_glk_feed_line_input:
1356  * @glk: a #ChimaraGlk widget
1357  * @text: text to pass to the next line input request
1358  *
1359  * Pretend that @text was typed in the Glk program as a response to a line input
1360  * request. @text does not need to end with a newline. You can call this
1361  * function even when no window has requested line input, in which case the text
1362  * will be saved for the following window that requests line input. This has the
1363  * disadvantage that if more than one window has requested character input, it
1364  * is arbitrary which one gets the text.
1365  */
1366 void
1367 chimara_glk_feed_line_input(ChimaraGlk *glk, const gchar *text)
1368 {
1369         g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1370         g_return_if_fail(text);
1371         CHIMARA_GLK_USE_PRIVATE(glk, priv);
1372         g_async_queue_push(priv->line_input_queue, g_strdup(text));
1373         event_throw(glk, evtype_ForcedLineInput, NULL, 0, 0);
1374 }