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