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