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