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