libchimara/chimara-glk.c

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