libchimara/chimara-glk.c

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