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