libchimara/chimara-glk.c

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