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