libchimara/chimara-glk.c

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