libchimara/chimara-glk.c

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