libchimara/chimara-glk.c

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