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  * @include: libchimara/chimara-glk.h
  36  *
  37  * The #ChimaraGlk widget opens and runs a Glk program. The program must be
  38  * compiled as a plugin module, with a function <function>glk_main()</function>
  39  * that the Glk library can hook into.
  40  *
  41  * On Linux systems, this is a file with a name like
  42  * <filename>plugin.so</filename>. For portability, you can use libtool and
  43  * automake:
  44  * |[
  45  * pkglib_LTLIBRARIES = plugin.la
  46  * plugin_la_SOURCES = plugin.c foo.c bar.c
  47  * plugin_la_LDFLAGS = -module -shared -avoid-version -export-symbols-regex "^glk_main$$"
  48  * ]|
  49  * This will produce <filename>plugin.la</filename> which is a text file
  50  * containing the correct plugin file to open (see the relevant section of the
  51  * <ulink
  52  * url="http://www.gnu.org/software/libtool/manual/html_node/Finding-the-dlname.html">
  53  * Libtool manual</ulink>).
  54  *
  55  * You need to initialize multithreading in any program you use a #ChimaraGlk
  56  * widget in. This means including the following incantation at the beginning
  57  * of your program:
  58  * |[
  59  * if(!g_thread_supported())
  60  *     g_thread_init(NULL);
  61  * gdk_threads_init();
  62  * ]|
  63  * This initialization must take place <emphasis>before</emphasis> the call to
  64  * gtk_init(). In addition to this, you must also protect your call to
  65  * gtk_main() by calling gdk_threads_enter() right before it, and
  66  * gdk_threads_leave() right after it.
  67  *
  68  * The following sample program shows how to initialize and construct a simple
  69  * GTK window that runs a Glk program:
  70  * |[
  71  * #include <glib.h>
  72  * #include <gtk/gtk.h>
  73  * #include <libchimara/chimara-glk.h>
  74  *
  75  * int
  76  * main(int argc, char *argv[])
  77  * {
  78  *     GtkWidget *window, *glk;
  79  *     GError *error = NULL;
  80  *     gchar *plugin_argv[] = { "plugin.so", "-option" };
  81  *
  82  *     /<!---->* Initialize threads and GTK *<!---->/
  83  *     if(!g_thread_supported())
  84  *         g_thread_init(NULL);
  85  *     gdk_threads_init();
  86  *     gtk_init(&argc, &argv);
  87  *
  88  *     /<!---->* Construct the window and its contents. We quit the GTK main loop
  89  *      * when the window's close button is clicked. *<!---->/
  90  *     window = gtk_window_new(GTK_WINDOW_TOPLEVEL);
  91  *     g_signal_connect(window, "delete-event", G_CALLBACK(gtk_main_quit), NULL);
  92  *     glk = chimara_glk_new();
  93  *     gtk_container_add(GTK_CONTAINER(window), glk);
  94  *     gtk_widget_show_all(window);
  95  *
  96  *     /<!---->* Add a reference to the ChimaraGlk widget, since we want it to
  97  *      * persist after the window's delete-event -- otherwise it will be destroyed
  98  *      * with the window. *<!---->/
  99  *     g_object_ref(glk);
 100  *
 101  *     /<!---->* Start the Glk program in a separate thread *<!---->/
 102  *     if(!chimara_glk_run(CHIMARA_GLK(glk), "./plugin.so", 2, plugin_argv, &error))
 103  *         g_error("Error starting Glk library: %s\n", error->message);
 104  *
 105  *     /<!---->* Start the GTK main loop *<!---->/
 106  *     gdk_threads_enter();
 107  *     gtk_main();
 108  *     gdk_threads_leave();
 109  *
 110  *     /<!---->* After the GTK main loop exits, signal the Glk program to shut down if
 111  *      * it is still running, and wait for it to exit. *<!---->/
 112  *     chimara_glk_stop(CHIMARA_GLK(glk));
 113  *     chimara_glk_wait(CHIMARA_GLK(glk));
 114  *     g_object_unref(glk);
 115  *
 116  *     return 0;
 117  * }
 118  * ]|
 119  */
 120
 121 typedef void (* glk_main_t) (void);
 122 typedef int (* glkunix_startup_code_t) (glkunix_startup_t*);
 123
 124 enum {
 125     PROP_0,
 126     PROP_INTERACTIVE,
 127     PROP_PROTECT,
 128         PROP_SPACING,
 129         PROP_PROGRAM_NAME,
 130         PROP_PROGRAM_INFO,
 131         PROP_STORY_NAME
 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     GTK_WIDGET_SET_FLAGS(GTK_WIDGET(self), GTK_NO_WINDOW);
 154
 155     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(self);
 156
 157     priv->self = self;
 158     priv->interactive = TRUE;
 159     priv->protect = FALSE;
 160         priv->styles = g_new0(StyleSet,1);
 161         priv->glk_styles = g_new0(StyleSet,1);
 162         priv->pager_attr_list = pango_attr_list_new();
 163         priv->final_message = g_strdup("[ The game has finished ]");
 164         priv->running = FALSE;
 165     priv->program = NULL;
 166     priv->thread = NULL;
 167     priv->event_queue = g_queue_new();
 168     priv->event_lock = g_mutex_new();
 169     priv->event_queue_not_empty = g_cond_new();
 170     priv->event_queue_not_full = g_cond_new();
 171     priv->abort_lock = g_mutex_new();
 172     priv->abort_signalled = FALSE;
 173         priv->shutdown_lock = g_mutex_new();
 174         priv->shutdown_key_pressed = g_cond_new();
 175         priv->arrange_lock = g_mutex_new();
 176         priv->rearranged = g_cond_new();
 177         priv->needs_rearrange = FALSE;
 178         priv->ignore_next_arrange_event = FALSE;
 179         priv->char_input_queue = g_async_queue_new();
 180         priv->line_input_queue = g_async_queue_new();
 181         /* Should be g_async_queue_new_full(g_free); but only in GTK >= 2.16 */
 182         priv->resource_map = NULL;
 183         priv->open_external_blorb = FALSE;
 184         priv->external_blorb_pathname = 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                 default:
 253             G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
 254     }
 255 }
 256
 257 static void
 258 chimara_glk_finalize(GObject *object)
 259 {
 260     ChimaraGlk *self = CHIMARA_GLK(object);
 261         CHIMARA_GLK_USE_PRIVATE(self, priv);
 262
 263         /* Free widget properties */
 264         g_free(priv->final_message);
 265         /* Free styles */
 266         g_hash_table_destroy(priv->styles->text_buffer);
 267         g_hash_table_destroy(priv->styles->text_grid);
 268         g_hash_table_destroy(priv->glk_styles->text_buffer);
 269         g_hash_table_destroy(priv->glk_styles->text_grid);
 270         pango_attr_list_unref(priv->pager_attr_list);
 271
 272     /* Free the event queue */
 273     g_mutex_lock(priv->event_lock);
 274         g_queue_foreach(priv->event_queue, (GFunc)g_free, NULL);
 275         g_queue_free(priv->event_queue);
 276         g_cond_free(priv->event_queue_not_empty);
 277         g_cond_free(priv->event_queue_not_full);
 278         priv->event_queue = NULL;
 279         g_mutex_unlock(priv->event_lock);
 280         g_mutex_free(priv->event_lock);
 281     /* Free the abort signaling mechanism */
 282         g_mutex_lock(priv->abort_lock);
 283         /* Make sure no other thread is busy with this */
 284         g_mutex_unlock(priv->abort_lock);
 285         g_mutex_free(priv->abort_lock);
 286         priv->abort_lock = NULL;
 287         /* Free the shutdown keypress signaling mechanism */
 288         g_mutex_lock(priv->shutdown_lock);
 289         g_cond_free(priv->shutdown_key_pressed);
 290         g_mutex_unlock(priv->shutdown_lock);
 291         priv->shutdown_lock = NULL;
 292         /* Free the window arrangement signaling */
 293         g_mutex_lock(priv->arrange_lock);
 294         g_cond_free(priv->rearranged);
 295         g_mutex_unlock(priv->arrange_lock);
 296         g_mutex_free(priv->arrange_lock);
 297         priv->arrange_lock = NULL;
 298         g_mutex_lock(priv->resource_lock);
 299         g_cond_free(priv->resource_loaded);
 300         g_cond_free(priv->resource_info_available);
 301         g_mutex_unlock(priv->resource_lock);
 302         g_mutex_free(priv->resource_lock);
 303         g_slist_foreach(priv->image_cache, (GFunc)clear_image_cache, NULL);
 304         g_slist_free(priv->image_cache);
 305         /* Unref input queues (this should destroy them since any Glk thread has stopped by now */
 306         g_async_queue_unref(priv->char_input_queue);
 307         g_async_queue_unref(priv->line_input_queue);
 308
 309         /* Free other stuff */
 310         g_free(priv->current_dir);
 311         g_free(priv->program_name);
 312         g_free(priv->program_info);
 313         g_free(priv->story_name);
 314         g_free(priv->styles);
 315         g_free(priv->glk_styles);
 316
 317         /* Chain up to parent */
 318     G_OBJECT_CLASS(chimara_glk_parent_class)->finalize(object);
 319 }
 320
 321 /* Internal function: Recursively get the Glk window tree's size request */
 322 static void
 323 request_recurse(winid_t win, GtkRequisition *requisition, guint spacing)
 324 {
 325         if(win->type == wintype_Pair)
 326         {
 327                 /* Get children's size requests */
 328                 GtkRequisition child1, child2;
 329                 request_recurse(win->window_node->children->data, &child1, spacing);
 330                 request_recurse(win->window_node->children->next->data, &child2, spacing);
 331
 332                 glui32 division = win->split_method & winmethod_DivisionMask;
 333                 glui32 direction = win->split_method & winmethod_DirMask;
 334
 335                 /* If the split is fixed, get the size of the fixed child */
 336                 if(division == winmethod_Fixed)
 337                 {
 338                         switch(direction)
 339                         {
 340                                 case winmethod_Left:
 341                                         child1.width = win->key_window?
 342                                                 win->constraint_size * win->key_window->unit_width
 343                                                 : 0;
 344                                         break;
 345                                 case winmethod_Right:
 346                                         child2.width = win->key_window?
 347                                                 win->constraint_size * win->key_window->unit_width
 348                                                 : 0;
 349                                         break;
 350                                 case winmethod_Above:
 351                                         child1.height = win->key_window?
 352                                                 win->constraint_size * win->key_window->unit_height
 353                                                 : 0;
 354                                         break;
 355                                 case winmethod_Below:
 356                                         child2.height = win->key_window?
 357                                                 win->constraint_size * win->key_window->unit_height
 358                                                 : 0;
 359                                         break;
 360                         }
 361                 }
 362
 363                 /* Add the children's requests */
 364                 switch(direction)
 365                 {
 366                         case winmethod_Left:
 367                         case winmethod_Right:
 368                                 requisition->width = child1.width + child2.width + spacing;
 369                                 requisition->height = MAX(child1.height, child2.height);
 370                                 break;
 371                         case winmethod_Above:
 372                         case winmethod_Below:
 373                                 requisition->width = MAX(child1.width, child2.width);
 374                                 requisition->height = child1.height + child2.height + spacing;
 375                                 break;
 376                 }
 377         }
 378
 379         /* For non-pair windows, just use the size that GTK requests */
 380         else
 381                 gtk_widget_size_request(win->frame, requisition);
 382 }
 383
 384 /* Overrides gtk_widget_size_request */
 385 static void
 386 chimara_glk_size_request(GtkWidget *widget, GtkRequisition *requisition)
 387 {
 388     g_return_if_fail(widget);
 389     g_return_if_fail(requisition);
 390     g_return_if_fail(CHIMARA_IS_GLK(widget));
 391
 392     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(widget);
 393
 394     /* For now, just pass the size request on to the root Glk window */
 395     if(priv->root_window)
 396         {
 397                 request_recurse(priv->root_window->data, requisition, priv->spacing);
 398                 requisition->width += 2 * GTK_CONTAINER(widget)->border_width;
 399                 requisition->height += 2 * GTK_CONTAINER(widget)->border_width;
 400         }
 401         else
 402         {
 403         requisition->width = CHIMARA_GLK_MIN_WIDTH + 2 * GTK_CONTAINER(widget)->border_width;
 404         requisition->height = CHIMARA_GLK_MIN_HEIGHT + 2 * GTK_CONTAINER(widget)->border_width;
 405     }
 406 }
 407
 408 /* Recursively give the Glk windows their allocated space. Returns a window
 409  containing all children of this window that must be redrawn, or NULL if there
 410  are no children that require redrawing. */
 411 static winid_t
 412 allocate_recurse(winid_t win, GtkAllocation *allocation, guint spacing)
 413 {
 414         if(win->type == wintype_Pair)
 415         {
 416                 glui32 division = win->split_method & winmethod_DivisionMask;
 417                 glui32 direction = win->split_method & winmethod_DirMask;
 418
 419                 /* If the space gets too small to honor the spacing property, then just
 420                  ignore spacing in this window and below. */
 421                 if( (spacing > allocation->width && (direction == winmethod_Left || direction == winmethod_Right))
 422                    || (spacing > allocation->height && (direction == winmethod_Above || direction == winmethod_Below)) )
 423                         spacing = 0;
 424
 425                 GtkAllocation child1, child2;
 426                 child1.x = allocation->x;
 427                 child1.y = allocation->y;
 428
 429                 if(division == winmethod_Fixed)
 430                 {
 431                         /* If the key window has been closed, then default to 0; otherwise
 432                          use the key window to determine the size */
 433                         switch(direction)
 434                         {
 435                                 case winmethod_Left:
 436                                         child1.width = win->key_window?
 437                                                 CLAMP(win->constraint_size * win->key_window->unit_width, 0, allocation->width - spacing)
 438                                                 : 0;
 439                                         break;
 440                                 case winmethod_Right:
 441                                         child2.width = win->key_window?
 442                                                 CLAMP(win->constraint_size * win->key_window->unit_width, 0, allocation->width - spacing)
 443                                                 : 0;
 444                                         break;
 445                                 case winmethod_Above:
 446                                         child1.height = win->key_window?
 447                                                 CLAMP(win->constraint_size * win->key_window->unit_height, 0, allocation->height - spacing)
 448                                                 : 0;
 449                                         break;
 450                                 case winmethod_Below:
 451                                         child2.height = win->key_window?
 452                                                 CLAMP(win->constraint_size * win->key_window->unit_height, 0, allocation->height - spacing)
 453                                                 : 0;
 454                                         break;
 455                         }
 456                 }
 457                 else /* proportional */
 458                 {
 459                         gdouble fraction = win->constraint_size / 100.0;
 460                         switch(direction)
 461                         {
 462                                 case winmethod_Left:
 463                                         child1.width = MAX(0, (gint)ceil(fraction * (allocation->width - spacing)) );
 464                                         break;
 465                                 case winmethod_Right:
 466                                         child2.width = MAX(0, (gint)ceil(fraction * (allocation->width - spacing)) );
 467                                         break;
 468                                 case winmethod_Above:
 469                                         child1.height = MAX(0, (gint)ceil(fraction * (allocation->height - spacing)) );
 470                                         break;
 471                                 case winmethod_Below:
 472                                         child2.height = MAX(0, (gint)ceil(fraction * (allocation->height - spacing)) );
 473                                         break;
 474                         }
 475                 }
 476
 477                 /* Fill in the rest of the size requisitions according to the child specified above */
 478                 switch(direction)
 479                 {
 480                         case winmethod_Left:
 481                                 child2.width = MAX(0, allocation->width - spacing - child1.width);
 482                                 child2.x = child1.x + child1.width + spacing;
 483                                 child2.y = child1.y;
 484                                 child1.height = child2.height = allocation->height;
 485                                 break;
 486                         case winmethod_Right:
 487                                 child1.width = MAX(0, allocation->width - spacing - child2.width);
 488                                 child2.x = child1.x + child1.width + spacing;
 489                                 child2.y = child1.y;
 490                                 child1.height = child2.height = allocation->height;
 491                                 break;
 492                         case winmethod_Above:
 493                                 child2.height = MAX(0, allocation->height - spacing - child1.height);
 494                                 child2.x = child1.x;
 495                                 child2.y = child1.y + child1.height + spacing;
 496                                 child1.width = child2.width = allocation->width;
 497                                 break;
 498                         case winmethod_Below:
 499                                 child1.height = MAX(0, allocation->height - spacing - child2.height);
 500                                 child2.x = child1.x;
 501                                 child2.y = child1.y + child1.height + spacing;
 502                                 child1.width = child2.width = allocation->width;
 503                                 break;
 504                 }
 505
 506                 /* Recurse */
 507                 winid_t arrange1 = allocate_recurse(win->window_node->children->data, &child1, spacing);
 508                 winid_t arrange2 = allocate_recurse(win->window_node->children->next->data, &child2, spacing);
 509                 if(arrange1 == NULL)
 510                         return arrange2;
 511                 if(arrange2 == NULL)
 512                         return arrange1;
 513                 return win;
 514         }
 515
 516         else if(win->type == wintype_TextGrid)
 517         {
 518                 /* Pass the size allocation on to the framing widget */
 519                 gtk_widget_size_allocate(win->frame, allocation);
 520                 /* It says in the spec that when a text grid window is resized smaller,
 521                  the bottom or right area is thrown away; when it is resized larger, the
 522                  bottom or right area is filled with blanks. */
 523                 glui32 newwidth = (glui32)(win->widget->allocation.width / win->unit_width);
 524                 glui32 newheight = (glui32)(win->widget->allocation.height / win->unit_height);
 525                 gint line;
 526                 GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
 527                 GtkTextIter start, end;
 528
 529                 for(line = 0; line < win->height; line++)
 530                 {
 531                         gtk_text_buffer_get_iter_at_line(textbuffer, &start, line);
 532                         /* If this line is going to fall off the bottom, delete it */
 533                         if(line >= newheight)
 534                         {
 535                                 end = start;
 536                                 gtk_text_iter_forward_to_line_end(&end);
 537                                 gtk_text_iter_forward_char(&end);
 538                                 gtk_text_buffer_delete(textbuffer, &start, &end);
 539                                 break;
 540                         }
 541                         /* If this line is not long enough, add spaces on the end */
 542                         if(newwidth > win->width)
 543                         {
 544                                 gchar *spaces = g_strnfill(newwidth - win->width, ' ');
 545                                 gtk_text_iter_forward_to_line_end(&start);
 546                                 gtk_text_buffer_insert(textbuffer, &start, spaces, -1);
 547                                 g_free(spaces);
 548                         }
 549                         /* But if it's too long, delete characters from the end */
 550                         else if(newwidth < win->width)
 551                         {
 552                                 end = start;
 553                                 gtk_text_iter_forward_chars(&start, newwidth);
 554                                 gtk_text_iter_forward_to_line_end(&end);
 555                                 gtk_text_buffer_delete(textbuffer, &start, &end);
 556                         }
 557                         /* Note: if the widths are equal, do nothing */
 558                 }
 559                 /* Add blank lines if there aren't enough lines to fit the new size */
 560                 if(newheight > win->height)
 561                 {
 562                         gchar *blanks = g_strnfill(win->width, ' ');
 563                     gchar **blanklines = g_new0(gchar *, (newheight - win->height) + 1);
 564                     int count;
 565                     for(count = 0; count < newheight - win->height; count++)
 566                         blanklines[count] = blanks;
 567                     blanklines[newheight - win->height] = NULL;
 568                     gchar *text = g_strjoinv("\n", blanklines);
 569                     g_free(blanklines); /* not g_strfreev() */
 570                     g_free(blanks);
 571
 572                         gtk_text_buffer_get_end_iter(textbuffer, &start);
 573                         gtk_text_buffer_insert(textbuffer, &start, "\n", -1);
 574                     gtk_text_buffer_insert(textbuffer, &start, text, -1);
 575                     g_free(text);
 576                 }
 577
 578                 gboolean arrange = !(win->width == newwidth && win->height == newheight);
 579                 win->width = newwidth;
 580                 win->height = newheight;
 581                 return arrange? win : NULL;
 582         }
 583
 584         /* For non-pair, non-text-grid windows, just give them the size */
 585         gtk_widget_size_allocate(win->frame, allocation);
 586         return NULL;
 587 }
 588
 589 /* Overrides gtk_widget_size_allocate */
 590 static void
 591 chimara_glk_size_allocate(GtkWidget *widget, GtkAllocation *allocation)
 592 {
 593     g_return_if_fail(widget);
 594     g_return_if_fail(allocation);
 595     g_return_if_fail(CHIMARA_IS_GLK(widget));
 596
 597     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(widget);
 598
 599     widget->allocation = *allocation;
 600
 601     if(priv->root_window) {
 602                 GtkAllocation child;
 603                 child.x = allocation->x + GTK_CONTAINER(widget)->border_width;
 604                 child.y = allocation->y + GTK_CONTAINER(widget)->border_width;
 605                 child.width = CLAMP(allocation->width - 2 * GTK_CONTAINER(widget)->border_width, 0, allocation->width);
 606                 child.height = CLAMP(allocation->height - 2 * GTK_CONTAINER(widget)->border_width, 0, allocation->height);
 607                 winid_t arrange = allocate_recurse(priv->root_window->data, &child, priv->spacing);
 608
 609                 /* arrange points to a window that contains all text grid and graphics
 610                  windows which have been resized */
 611                 g_mutex_lock(priv->arrange_lock);
 612                 if(!priv->ignore_next_arrange_event)
 613                 {
 614                         if(arrange)
 615                                 event_throw(CHIMARA_GLK(widget), evtype_Arrange, arrange == priv->root_window->data? NULL : arrange, 0, 0);
 616                 }
 617                 else
 618                         priv->ignore_next_arrange_event = FALSE;
 619                 priv->needs_rearrange = FALSE;
 620                 g_cond_signal(priv->rearranged);
 621                 g_mutex_unlock(priv->arrange_lock);
 622         }
 623 }
 624
 625 /* Recursively invoke callback() on the GtkWidget of each non-pair window in the tree */
 626 static void
 627 forall_recurse(winid_t win, GtkCallback callback, gpointer callback_data)
 628 {
 629         if(win->type == wintype_Pair)
 630         {
 631                 forall_recurse(win->window_node->children->data, callback, callback_data);
 632                 forall_recurse(win->window_node->children->next->data, callback, callback_data);
 633         }
 634         else
 635                 (*callback)(win->frame, callback_data);
 636 }
 637
 638 /* Overrides gtk_container_forall */
 639 static void
 640 chimara_glk_forall(GtkContainer *container, gboolean include_internals, GtkCallback callback, gpointer callback_data)
 641 {
 642     g_return_if_fail(container);
 643     g_return_if_fail(CHIMARA_IS_GLK(container));
 644
 645     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(container);
 646
 647         /* All the children are "internal" */
 648         if(!include_internals)
 649                 return;
 650
 651     if(priv->root_window)
 652                 forall_recurse(priv->root_window->data, callback, callback_data);
 653 }
 654
 655 static void
 656 chimara_glk_stopped(ChimaraGlk *self)
 657 {
 658     CHIMARA_GLK_USE_PRIVATE(self, priv);
 659     priv->running = FALSE;
 660     priv->program_name = NULL;
 661     g_object_notify(G_OBJECT(self), "program-name");
 662     priv->program_info = NULL;
 663     g_object_notify(G_OBJECT(self), "program-info");
 664     priv->story_name = NULL;
 665     g_object_notify(G_OBJECT(self), "story-name");
 666 }
 667
 668 static void
 669 chimara_glk_started(ChimaraGlk *self)
 670 {
 671         CHIMARA_GLK_USE_PRIVATE(self, priv);
 672         priv->running = TRUE;
 673 }
 674
 675 static void
 676 chimara_glk_waiting(ChimaraGlk *self)
 677 {
 678         /* Default signal handler */
 679 }
 680
 681 static void
 682 chimara_glk_char_input(ChimaraGlk *self, guint window_rock, guint keysym)
 683 {
 684         /* Default signal handler */
 685 }
 686
 687 static void
 688 chimara_glk_line_input(ChimaraGlk *self, guint window_rock, gchar *text)
 689 {
 690         /* Default signal handler */
 691 }
 692
 693 static void
 694 chimara_glk_text_buffer_output(ChimaraGlk *self, guint window_rock, gchar *text)
 695 {
 696         /* Default signal handler */
 697 }
 698
 699 static void
 700 chimara_glk_iliad_screen_update(ChimaraGlk *self, gboolean typing)
 701 {
 702         /* Default signal handler */
 703 }
 704
 705 /* COMPAT: G_PARAM_STATIC_STRINGS only appeared in GTK 2.13.0 */
 706 #ifndef G_PARAM_STATIC_STRINGS
 707
 708 /* COMPAT: G_PARAM_STATIC_NAME and friends only appeared in GTK 2.8 */
 709 #if GTK_CHECK_VERSION(2,8,0)
 710 #define G_PARAM_STATIC_STRINGS (G_PARAM_STATIC_NAME | G_PARAM_STATIC_NICK | G_PARAM_STATIC_BLURB)
 711 #else
 712 #define G_PARAM_STATIC_STRINGS (0)
 713 #endif
 714
 715 #endif
 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-update-screen:
 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.
 866          */
 867         g_object_class_install_property(object_class, PROP_SPACING,
 868                 g_param_spec_uint("spacing", _("Spacing"),
 869                 _("The amount of space between Glk windows"),
 870                 0, G_MAXUINT, 0,
 871                 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
 872
 873         /**
 874          * ChimaraGlk:program-name:
 875          *
 876          * The name of the currently running Glk program. You cannot set this
 877          * property yourself. It is set to the filename of the plugin when you call
 878          * chimara_glk_run(), but the plugin can change it by calling
 879          * garglk_set_program_name(). To find out when this information changes,
 880          * for example to put the program name in the title bar of a window, connect
 881          * to the <code>::notify::program-name</code> signal.
 882          */
 883         g_object_class_install_property(object_class, PROP_PROGRAM_NAME,
 884                 g_param_spec_string("program-name", _("Program name"),
 885                 _("Name of the currently running program"),
 886                 NULL,
 887                 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
 888
 889         /**
 890          * ChimaraGlk:program-info:
 891          *
 892          * Information about the currently running Glk program. You cannot set this
 893          * property yourself. The plugin can change it by calling
 894          * garglk_set_program_info(). See also #ChimaraGlk:program-name.
 895          */
 896         g_object_class_install_property(object_class, PROP_PROGRAM_INFO,
 897                 g_param_spec_string("program-info", _("Program info"),
 898                 _("Information about the currently running program"),
 899                 NULL,
 900                 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
 901
 902         /**
 903          * ChimaraGlk:story-name:
 904          *
 905          * The name of the story currently running in the Glk interpreter. You
 906          * cannot set this property yourself. It is set to the story filename when
 907          * you call chimara_if_run_game(), but the plugin can change it by calling
 908          * garglk_set_story_name().
 909          *
 910          * Strictly speaking, this should be a property of #ChimaraIF, but it is
 911          * legal for any Glk program to call garglk_set_story_name(), even if it is
 912          * not an interpreter and does not load story files.
 913          */
 914         g_object_class_install_property(object_class, PROP_STORY_NAME,
 915                 g_param_spec_string("story-name", _("Story name"),
 916                 _("Name of the story currently loaded in the interpreter"),
 917                 NULL,
 918                 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS) );
 919
 920         /* Private data */
 921     g_type_class_add_private(klass, sizeof(ChimaraGlkPrivate));
 922 }
 923
 924 /* PUBLIC FUNCTIONS */
 925
 926 /**
 927  * chimara_error_quark:
 928  *
 929  * The error domain for errors from Chimara widgets.
 930  *
 931  * Returns: The string <quote>chimara-error-quark</quote> as a <link
 932  * linkend="GQuark">GQuark</link>.
 933  */
 934 GQuark
 935 chimara_error_quark(void)
 936 {
 937         chimara_init(); /* This is a library entry point */
 938         return g_quark_from_static_string("chimara-error-quark");
 939 }
 940
 941 /**
 942  * chimara_glk_new:
 943  *
 944  * Creates and initializes a new #ChimaraGlk widget.
 945  *
 946  * Return value: a #ChimaraGlk widget, with a floating reference.
 947  */
 948 GtkWidget *
 949 chimara_glk_new(void)
 950 {
 951         /* This is a library entry point; initialize the library */
 952         chimara_init();
 953
 954     return GTK_WIDGET(g_object_new(CHIMARA_TYPE_GLK, NULL));
 955 }
 956
 957 /**
 958  * chimara_glk_set_interactive:
 959  * @glk: a #ChimaraGlk widget
 960  * @interactive: whether the widget should expect user input
 961  *
 962  * Sets the #ChimaraGlk:interactive property of @glk.
 963  */
 964 void
 965 chimara_glk_set_interactive(ChimaraGlk *glk, gboolean interactive)
 966 {
 967     g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
 968
 969     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
 970     priv->interactive = interactive;
 971     g_object_notify(G_OBJECT(glk), "interactive");
 972 }
 973
 974 /**
 975  * chimara_glk_get_interactive:
 976  * @glk: a #ChimaraGlk widget
 977  *
 978  * Returns whether @glk is interactive (expecting user input). See
 979  * #ChimaraGlk:interactive.
 980  *
 981  * Return value: %TRUE if @glk is interactive.
 982  */
 983 gboolean
 984 chimara_glk_get_interactive(ChimaraGlk *glk)
 985 {
 986     g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
 987
 988     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
 989     return priv->interactive;
 990 }
 991
 992 /**
 993  * chimara_glk_set_protect:
 994  * @glk: a #ChimaraGlk widget
 995  * @protect: whether the widget should allow the Glk program to do file
 996  * operations
 997  *
 998  * Sets the #ChimaraGlk:protect property of @glk. In protect mode, the Glk
 999  * program is not allowed to do file operations.
1000  */
1001 void
1002 chimara_glk_set_protect(ChimaraGlk *glk, gboolean protect)
1003 {
1004     g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1005
1006     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1007     priv->protect = protect;
1008     g_object_notify(G_OBJECT(glk), "protect");
1009 }
1010
1011 /**
1012  * chimara_glk_get_protect:
1013  * @glk: a #ChimaraGlk widget
1014  *
1015  * Returns whether @glk is in protect mode (banned from doing file operations).
1016  * See #ChimaraGlk:protect.
1017  *
1018  * Return value: %TRUE if @glk is in protect mode.
1019  */
1020 gboolean
1021 chimara_glk_get_protect(ChimaraGlk *glk)
1022 {
1023     g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1024
1025     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1026     return priv->protect;
1027 }
1028
1029 /**
1030  * chimara_glk_set_css_to_default:
1031  * @glk: a #ChimaraGlk widget
1032  *
1033  * Resets the styles for text buffer and text grid windows to their defaults.
1034  * <para><warning>
1035  *   This function is not implemented yet.
1036  * </warning></para>
1037  */
1038 void
1039 chimara_glk_set_css_to_default(ChimaraGlk *glk)
1040 {
1041         reset_default_styles(glk);
1042 }
1043
1044 /**
1045  * chimara_glk_set_css_from_file:
1046  * @glk: a #ChimaraGlk widget
1047  * @filename: path to a CSS file, or %NULL
1048  * @error: location to store a <link
1049  * linkend="glib-Error-Reporting">GError</link>, or %NULL
1050  *
1051  * Sets the styles for text buffer and text grid windows according to the CSS
1052  * file @filename. Note that the styles are set cumulatively on top of whatever
1053  * the styles are at the time this function is called; to reset the styles to
1054  * their defaults, use chimara_glk_set_css_to_default().
1055  *
1056  * Returns: %TRUE on success, %FALSE if an error occurred, in which case @error
1057  * will be set.
1058  */
1059 gboolean
1060 chimara_glk_set_css_from_file(ChimaraGlk *glk, const gchar *filename, GError **error)
1061 {
1062         g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1063         g_return_val_if_fail(filename, FALSE);
1064         g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
1065
1066         int fd = open(filename, O_RDONLY);
1067         if(fd == -1) {
1068                 *error = g_error_new(G_IO_ERROR, g_io_error_from_errno(errno),
1069                     _("Error opening file \"%s\": %s"), filename, g_strerror(errno));
1070                 return FALSE;
1071         }
1072
1073         GScanner *scanner = create_css_file_scanner();
1074         g_scanner_input_file(scanner, fd);
1075         scanner->input_name = filename;
1076         scan_css_file(scanner, glk);
1077
1078         if(close(fd) == -1) {
1079                 *error = g_error_new(G_IO_ERROR, g_io_error_from_errno(errno),
1080                     _("Error closing file \"%s\": %s"), filename, g_strerror(errno));
1081                 return FALSE;
1082         }
1083         return TRUE;
1084 }
1085
1086 /**
1087  * chimara_glk_set_css_from_string:
1088  * @glk: a #ChimaraGlk widget
1089  * @css: a string containing CSS code
1090  *
1091  * Sets the styles for text buffer and text grid windows according to the CSS
1092  * code @css. Note that the styles are set cumulatively on top of whatever the
1093  * styles are at the time this function is called; to reset the styles to their
1094  * defaults, use chimara_glk_set_css_to_default().
1095  */
1096 void
1097 chimara_glk_set_css_from_string(ChimaraGlk *glk, const gchar *css)
1098 {
1099         g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1100         g_return_if_fail(css || *css);
1101
1102         GScanner *scanner = create_css_file_scanner();
1103         g_scanner_input_text(scanner, css, strlen(css));
1104         scanner->input_name = "<string>";
1105         scan_css_file(scanner, glk);
1106 }
1107
1108 /**
1109  * chimara_glk_set_spacing:
1110  * @glk: a #ChimaraGlk widget
1111  * @spacing: the number of pixels to put between Glk windows
1112  *
1113  * Sets the #ChimaraGlk:spacing property of @glk, which is the border width in
1114  * pixels between Glk windows.
1115  */
1116 void
1117 chimara_glk_set_spacing(ChimaraGlk *glk, guint spacing)
1118 {
1119         g_return_if_fail( glk || CHIMARA_IS_GLK(glk) );
1120
1121         ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1122         priv->spacing = spacing;
1123         g_object_notify(G_OBJECT(glk), "spacing");
1124 }
1125
1126 /**
1127  * chimara_glk_get_spacing:
1128  * @glk: a #ChimaraGlk widget
1129  *
1130  * Gets the value set by chimara_glk_set_spacing().
1131  *
1132  * Return value: pixels of spacing between Glk windows
1133  */
1134 guint
1135 chimara_glk_get_spacing(ChimaraGlk *glk)
1136 {
1137         g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), 0);
1138
1139         ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1140         return priv->spacing;
1141 }
1142
1143 struct StartupData {
1144         glk_main_t glk_main;
1145         glkunix_startup_code_t glkunix_startup_code;
1146         glkunix_startup_t args;
1147         ChimaraGlkPrivate *glk_data;
1148 };
1149
1150 /* glk_enter() is the actual function called in the new thread in which glk_main() runs.  */
1151 static gpointer
1152 glk_enter(struct StartupData *startup)
1153 {
1154         extern GPrivate *glk_data_key;
1155         g_private_set(glk_data_key, startup->glk_data);
1156
1157         /* Acquire the Glk thread's references to the input queues */
1158         g_async_queue_ref(startup->glk_data->char_input_queue);
1159         g_async_queue_ref(startup->glk_data->line_input_queue);
1160
1161         /* Run startup function */
1162         if(startup->glkunix_startup_code) {
1163                 startup->glk_data->in_startup = TRUE;
1164                 int result = startup->glkunix_startup_code(&startup->args);
1165                 startup->glk_data->in_startup = FALSE;
1166
1167                 int i = 0;
1168                 while(i < startup->args.argc)
1169                         g_free(startup->args.argv[i++]);
1170                 g_free(startup->args.argv);
1171
1172                 if(!result)
1173                         return NULL;
1174         }
1175
1176         /* Open external Blorb file if specified */
1177         if(startup->glk_data->open_external_blorb) {
1178                 glkunix_set_base_file(startup->glk_data->external_blorb_pathname);
1179                 gchar *basename = g_path_get_basename(startup->glk_data->external_blorb_pathname);
1180                 frefid_t blorbref = glk_fileref_create_by_name(fileusage_BinaryMode | fileusage_Data, basename, 0);
1181                 g_free(basename);
1182                 strid_t blorbfile = glk_stream_open_file(blorbref, filemode_Read, 0);
1183                 giblorb_set_resource_map(blorbfile);
1184                 glk_fileref_destroy(blorbref);
1185                 g_printerr("Opening external blorb file\n");
1186         }
1187
1188         /* Run main function */
1189         glk_main_t glk_main = startup->glk_main;
1190
1191         /* COMPAT: avoid usage of slices */
1192         g_free(startup);
1193     g_signal_emit_by_name(startup->glk_data->self, "started");
1194         glk_main();
1195         glk_exit(); /* Run shutdown code in glk_exit() even if glk_main() returns normally */
1196         g_assert_not_reached(); /* because glk_exit() calls g_thread_exit() */
1197         return NULL;
1198 }
1199
1200 /**
1201  * chimara_glk_run:
1202  * @glk: a #ChimaraGlk widget
1203  * @plugin: path to a plugin module compiled with <filename
1204  * class="header">glk.h</filename>
1205  * @argc: Number of command line arguments in @argv
1206  * @argv: Array of command line arguments to pass to the plugin
1207  * @error: location to store a <link
1208  * linkend="glib-Error-Reporting">GError</link>, or %NULL
1209  *
1210  * Opens a Glk program compiled as a plugin. Sorts out its command line
1211  * arguments from #glkunix_arguments, calls its startup function
1212  * glkunix_startup_code(), and then calls its main function glk_main() in
1213  * a separate thread. On failure, returns %FALSE and sets @error.
1214  *
1215  * The plugin must at least export a glk_main() function; #glkunix_arguments and
1216  * glkunix_startup_code() are optional.
1217  *
1218  * Return value: %TRUE if the Glk program was started successfully.
1219  */
1220 gboolean
1221 chimara_glk_run(ChimaraGlk *glk, const gchar *plugin, int argc, char *argv[], GError **error)
1222 {
1223     g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1224     g_return_val_if_fail(plugin, FALSE);
1225         g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
1226
1227         if(chimara_glk_get_running(glk)) {
1228                 g_set_error(error, CHIMARA_ERROR, CHIMARA_PLUGIN_ALREADY_RUNNING, _("There was already a plugin running."));
1229                 return FALSE;
1230         }
1231
1232     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1233
1234         /* COMPAT: avoid usage of slices */
1235         struct StartupData *startup = g_new0(struct StartupData,1);
1236
1237     g_assert( g_module_supported() );
1238         /* If there is already a module loaded, free it first -- you see, we want to
1239          * keep modules loaded as long as possible to avoid crashes in stack unwinding */
1240         if( priv->program && !g_module_close(priv->program) )
1241                 g_warning( "Error closing module :%s", g_module_error() );
1242         /* Open the module to run */
1243     priv->program = g_module_open(plugin, G_MODULE_BIND_LAZY);
1244
1245     if(!priv->program)
1246     {
1247         g_set_error(error, CHIMARA_ERROR, CHIMARA_LOAD_MODULE_ERROR, _("Error opening module: %s"), g_module_error());
1248         return FALSE;
1249     }
1250     if( !g_module_symbol(priv->program, "glk_main", (gpointer *) &startup->glk_main) )
1251     {
1252         g_set_error(error, CHIMARA_ERROR, CHIMARA_NO_GLK_MAIN, _("Error finding glk_main(): %s"), g_module_error());
1253         return FALSE;
1254     }
1255
1256     if( g_module_symbol(priv->program, "glkunix_startup_code", (gpointer *) &startup->glkunix_startup_code) )
1257     {
1258                 glkunix_argumentlist_t *glkunix_arguments;
1259
1260                 if( !(g_module_symbol(priv->program, "glkunix_arguments", (gpointer *) &glkunix_arguments)
1261                           && parse_command_line(glkunix_arguments, argc, argv, &startup->args)) )
1262                 {
1263                         /* arguments could not be parsed, so create data ourselves */
1264                         startup->args.argc = 1;
1265                         startup->args.argv = g_new0(gchar *, 1);
1266                 }
1267
1268                 /* Set the program invocation name */
1269                 startup->args.argv[0] = g_strdup(plugin);
1270     }
1271         startup->glk_data = priv;
1272
1273         /* Set the program name */
1274         priv->program_name = g_path_get_basename(plugin);
1275         g_object_notify(G_OBJECT(glk), "program-name");
1276
1277     /* Run in a separate thread */
1278         priv->thread = g_thread_create((GThreadFunc)glk_enter, startup, TRUE, error);
1279
1280         return !(priv->thread == NULL);
1281 }
1282
1283 /**
1284  * chimara_glk_stop:
1285  * @glk: a #ChimaraGlk widget
1286  *
1287  * Signals the Glk program running in @glk to abort. Note that if the program is
1288  * caught in an infinite loop in which glk_tick() is not called, this may not
1289  * work.
1290  */
1291 void
1292 chimara_glk_stop(ChimaraGlk *glk)
1293 {
1294     g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1295     CHIMARA_GLK_USE_PRIVATE(glk, priv);
1296
1297     /* Don't do anything if not running a program */
1298     if(!priv->running)
1299         return;
1300
1301         if(priv->abort_lock) {
1302                 g_mutex_lock(priv->abort_lock);
1303                 priv->abort_signalled = TRUE;
1304                 g_mutex_unlock(priv->abort_lock);
1305                 /* Stop blocking on the event queue condition */
1306                 event_throw(glk, evtype_Abort, NULL, 0, 0);
1307                 /* Stop blocking on the shutdown key press condition */
1308                 g_mutex_lock(priv->shutdown_lock);
1309                 g_cond_signal(priv->shutdown_key_pressed);
1310                 g_mutex_unlock(priv->shutdown_lock);
1311         }
1312 }
1313
1314 /**
1315  * chimara_glk_wait:
1316  * @glk: a #ChimaraGlk widget
1317  *
1318  * Holds up the main thread and waits for the Glk program running in @glk to
1319  * finish.
1320  */
1321 void
1322 chimara_glk_wait(ChimaraGlk *glk)
1323 {
1324     g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1325     CHIMARA_GLK_USE_PRIVATE(glk, priv);
1326     /* Don't do anything if not running a program */
1327     if(!priv->running)
1328         return;
1329         /* Unlock GDK mutex, because the Glk program might need to use it for shutdown */
1330         gdk_threads_leave();
1331     g_thread_join(priv->thread);
1332         gdk_threads_enter();
1333 }
1334
1335 /**
1336  * chimara_glk_get_running:
1337  * @glk: a #ChimaraGlk widget
1338  *
1339  * Use this function to tell whether a program is currently running in the
1340  * widget.
1341  *
1342  * Returns: %TRUE if @glk is executing a Glk program, %FALSE otherwise.
1343  */
1344 gboolean
1345 chimara_glk_get_running(ChimaraGlk *glk)
1346 {
1347         g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1348         CHIMARA_GLK_USE_PRIVATE(glk, priv);
1349         return priv->running;
1350 }
1351
1352 /**
1353  * chimara_glk_feed_char_input:
1354  * @glk: a #ChimaraGlk widget
1355  * @keyval: a key symbol as defined in <filename
1356  * class="headerfile">gdk/gdkkeysyms.h</filename>
1357  *
1358  * Pretend that a key was pressed in the Glk program as a response to a
1359  * character input request. You can call this function even when no window has
1360  * requested character input, in which case the key will be saved for the
1361  * following window that requests character input. This has the disadvantage
1362  * that if more than one window has requested character input, it is arbitrary
1363  * which one gets the key press.
1364  */
1365 void
1366 chimara_glk_feed_char_input(ChimaraGlk *glk, guint keyval)
1367 {
1368         g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1369         CHIMARA_GLK_USE_PRIVATE(glk, priv);
1370         g_async_queue_push(priv->char_input_queue, GUINT_TO_POINTER(keyval));
1371         event_throw(glk, evtype_ForcedCharInput, NULL, 0, 0);
1372 }
1373
1374 /**
1375  * chimara_glk_feed_line_input:
1376  * @glk: a #ChimaraGlk widget
1377  * @text: text to pass to the next line input request
1378  *
1379  * Pretend that @text was typed in the Glk program as a response to a line input
1380  * request. @text does not need to end with a newline. You can call this
1381  * function even when no window has requested line input, in which case the text
1382  * will be saved for the following window that requests line input. This has the
1383  * disadvantage that if more than one window has requested line input, it is
1384  * arbitrary which one gets the text.
1385  */
1386 void
1387 chimara_glk_feed_line_input(ChimaraGlk *glk, const gchar *text)
1388 {
1389         g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1390         g_return_if_fail(text);
1391         CHIMARA_GLK_USE_PRIVATE(glk, priv);
1392         g_async_queue_push(priv->line_input_queue, g_strdup(text));
1393         event_throw(glk, evtype_ForcedLineInput, NULL, 0, 0);
1394 }
1395
1396 /**
1397  * chimara_glk_is_char_input_pending:
1398  * @glk: a #ChimaraGlk widget
1399  *
1400  * Use this function to tell if character input forced by
1401  * chimara_glk_feed_char_input() has been passed to an input request or not.
1402  *
1403  * Returns: %TRUE if forced character input is pending, %FALSE otherwise.
1404  */
1405 gboolean
1406 chimara_glk_is_char_input_pending(ChimaraGlk *glk)
1407 {
1408         g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1409         CHIMARA_GLK_USE_PRIVATE(glk, priv);
1410         return g_async_queue_length(priv->char_input_queue) > 0;
1411 }
1412
1413 /**
1414  * chimara_glk_is_line_input_pending:
1415  * @glk: a #ChimaraGlk widget
1416  *
1417  * Use this function to tell if line input forced by
1418  * chimara_glk_feed_line_input() has been passed to an input request or not.
1419  *
1420  * Returns: %TRUE if forced line input is pending, %FALSE otherwise.
1421  */
1422 gboolean
1423 chimara_glk_is_line_input_pending(ChimaraGlk *glk)
1424 {
1425         g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1426         CHIMARA_GLK_USE_PRIVATE(glk, priv);
1427         return g_async_queue_length(priv->line_input_queue) > 0;
1428 }
1429
1430 /**
1431  * chimara_glk_get_tag:
1432  * @glk: a #ChimarGlk widget
1433  * @window: The type of window to retrieve the tag for
1434  * @name: The name of the tag to retrieve
1435  *
1436  * Use this function to get a #GtkTextTag so style properties can be changed.
1437  * See also #chimara_glk_set_css_from_string.
1438  *
1439  * The layout of the text in Chimara is controlled by two sets of tags: one set
1440  * describing the style in text buffers and one for text grids. See also the
1441  * GLK specification for the difference between the two. The main narrative of
1442  * a game is usually rendered in text buffers, whereas text grids are mostly
1443  * used for status bars and in game menus.
1444  *
1445  * The following tag names are supported:
1446  * <itemizedlist>
1447  *      <listitem><para>normal</para></listitem>
1448  *      <listitem><para>emphasized</para></listitem>
1449  *      <listitem><para>preformatted</para></listitem>
1450  *      <listitem><para>header</para></listitem>
1451  *      <listitem><para>subheader</para></listitem>
1452  *      <listitem><para>alert</para></listitem>
1453  *      <listitem><para>note</para></listitem>
1454  *      <listitem><para>block-quote</para></listitem>
1455  *      <listitem><para>input</para></listitem>
1456  *      <listitem><para>user1</para></listitem>
1457  *      <listitem><para>user2</para></listitem>
1458  *      <listitem><para>hyperlink</para></listitem>
1459  *      <listitem><para>pager</para></listitem>
1460  * </itenizedlist>
1461  */
1462 GtkTextTag*
1463 chimara_glk_get_tag(ChimaraGlk *glk, ChimaraGlkWindowType window, const gchar *name)
1464 {
1465         CHIMARA_GLK_USE_PRIVATE(glk, priv);
1466
1467         switch(window) {
1468         case CHIMARA_GLK_TEXT_BUFFER:
1469                 return GTK_TEXT_TAG( g_hash_table_lookup(priv->styles->text_buffer, name) );
1470                 break;
1471         case CHIMARA_GLK_TEXT_GRID:
1472                 return GTK_TEXT_TAG( g_hash_table_lookup(priv->styles->text_grid, name) );
1473                 break;
1474         default:
1475                 ILLEGAL_PARAM("Unknown window type: %u", window);
1476                 return NULL;
1477         }
1478 }
1479
1480 /**
1481  * chimara_glk_get_tag:
1482  * @glk: a #ChimarGlk widget
1483  *
1484  * Retrieves the possible tag names to use in #chimara_glk_get_tag.
1485  */
1486 const gchar**
1487 chimara_glk_get_tag_names(ChimaraGlk *glk)
1488 {
1489         return style_get_tag_names();
1490 }
1491
1492 /**
1493  * chimara_glk_get_num_tag_names:
1494  * @glk: a #ChimaraGlk widget
1495  *
1496  * Retrieves the number of style tags returned by #chimara_glk_get_tag_names.
1497  */
1498 gint
1499 chimara_glk_get_num_tag_names(ChimaraGlk *glk)
1500 {
1501         return CHIMARA_NUM_STYLES;
1502 }
1503
1504 /**
1505  * chimara_glk_update_style:
1506  * @glk: a #ChimaraGlk widget
1507  *
1508  * Processes style updates and updates the widget to reflect the new style.
1509  * Call this every time you change a property of a #GtkTextTag retrieved by
1510  * #chimara_glk_get_tag.
1511  */
1512 void
1513 chimara_glk_update_style(ChimaraGlk *glk)
1514 {
1515         CHIMARA_GLK_USE_PRIVATE(glk, priv);
1516         style_update(glk);
1517
1518         /* Schedule a redraw */
1519         g_mutex_lock(priv->arrange_lock);
1520         priv->needs_rearrange = TRUE;
1521         priv->ignore_next_arrange_event = TRUE;
1522         g_mutex_unlock(priv->arrange_lock);
1523         gtk_widget_queue_resize( GTK_WIDGET(priv->self) );
1524 }
1525
1526 /**
1527  * chimara_glk_set_resource_load_callback:
1528  * @glk: a #ChimaraGlk widget
1529  * @func: a function to call for loading resources, or %NULL
1530  * @user_data: user data to pass to @func, or %NULL
1531  *
1532  * Sometimes it is preferable to load image and sound resources from somewhere
1533  * else than a Blorb file, for example while developing a game. Section 14 of
1534  * the <ulink url="http://eblong.com/zarf/blorb/blorb.html#s14">Blorb
1535  * specification</ulink> allows for this possibility. This function sets @func
1536  * to be called when the Glk program requests loading an image or sound without
1537  * a Blorb resource map having been loaded, optionally passing @user_data as an
1538  * extra parameter.
1539  *
1540  * Note that @func is only called if no Blorb resource map has been set; having
1541  * a resource map in place overrides this function.
1542  *
1543  * To deactivate the callback, call this function with @func set to %NULL.
1544  */
1545 void
1546 chimara_glk_set_resource_load_callback(ChimaraGlk *glk, ChimaraResourceLoadFunc func, gpointer user_data)
1547 {
1548         CHIMARA_GLK_USE_PRIVATE(glk, priv);
1549         priv->resource_load_callback = func;
1550         priv->resource_load_callback_data = user_data;
1551 }