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