src/chimara-glk.c

   1 /* licensing and copyright information here */
   2
   3 #include <math.h>
   4 #include <gtk/gtk.h>
   5 #include <glib/gi18n.h>
   6 #include <gmodule.h>
   7 #include <pango/pango.h>
   8 #include "chimara-glk.h"
   9 #include "chimara-glk-private.h"
  10 #include "glk.h"
  11 #include "abort.h"
  12 #include "window.h"
  13
  14 #define CHIMARA_GLK_MIN_WIDTH 0
  15 #define CHIMARA_GLK_MIN_HEIGHT 0
  16
  17 /**
  18  * SECTION:chimara-glk
  19  * @short_description: Widget which executes a Glk program
  20  * @stability: Unstable
  21  * @include: chimara/chimara-glk.h
  22  *
  23  * The ChimaraGlk widget opens and runs a Glk program. The program must be
  24  * compiled as a plugin module, with a function <function>glk_main()</function>
  25  * that the Glk library can hook into.
  26  *
  27  * On Linux systems, this is a file with a name like
  28  * <filename>plugin.so</filename>. For portability, you can use libtool and
  29  * automake:
  30  * <informalexample><programlisting>
  31  * pkglib_LTLIBRARIES = plugin.la
  32  * plugin_la_SOURCES = plugin.c foo.c bar.c
  33  * plugin_la_LDFLAGS = -module -shared -avoid-version -export-symbols-regex "^glk_main$$"
  34  * </programlisting></informalexample>
  35  * This will produce <filename>plugin.la</filename> which is a text file
  36  * containing the correct plugin file to open (see the relevant section of the
  37  * <ulink
  38  * url="http://www.gnu.org/software/libtool/manual/html_node/Finding-the-dlname.html">
  39  * Libtool manual</ulink>).
  40  */
  41
  42 typedef void (* glk_main_t) (void);
  43
  44 enum {
  45     PROP_0,
  46     PROP_INTERACTIVE,
  47     PROP_PROTECT,
  48         PROP_DEFAULT_FONT_DESCRIPTION,
  49         PROP_MONOSPACE_FONT_DESCRIPTION,
  50         PROP_SPACING
  51 };
  52
  53 enum {
  54         STOPPED,
  55         STARTED,
  56
  57         LAST_SIGNAL
  58 };
  59
  60 static guint chimara_glk_signals[LAST_SIGNAL] = { 0 };
  61
  62 G_DEFINE_TYPE(ChimaraGlk, chimara_glk, GTK_TYPE_CONTAINER);
  63
  64 static void
  65 chimara_glk_init(ChimaraGlk *self)
  66 {
  67     GTK_WIDGET_SET_FLAGS(GTK_WIDGET(self), GTK_NO_WINDOW);
  68
  69     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(self);
  70
  71     priv->self = self;
  72     priv->interactive = TRUE;
  73     priv->protect = FALSE;
  74         priv->default_font_desc = pango_font_description_from_string("Sans");
  75         priv->monospace_font_desc = pango_font_description_from_string("Monospace");
  76     priv->program = NULL;
  77     priv->thread = NULL;
  78     priv->event_queue = NULL;
  79     priv->event_lock = NULL;
  80     priv->event_queue_not_empty = NULL;
  81     priv->event_queue_not_full = NULL;
  82     priv->abort_lock = NULL;
  83     priv->abort_signalled = FALSE;
  84     priv->interrupt_handler = NULL;
  85     priv->root_window = NULL;
  86     priv->fileref_list = NULL;
  87     priv->current_stream = NULL;
  88     priv->stream_list = NULL;
  89 }
  90
  91 static void
  92 chimara_glk_set_property(GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
  93 {
  94     ChimaraGlk *glk = CHIMARA_GLK(object);
  95
  96     switch(prop_id)
  97     {
  98         case PROP_INTERACTIVE:
  99             chimara_glk_set_interactive( glk, g_value_get_boolean(value) );
 100             break;
 101         case PROP_PROTECT:
 102             chimara_glk_set_protect( glk, g_value_get_boolean(value) );
 103             break;
 104                 case PROP_DEFAULT_FONT_DESCRIPTION:
 105                         chimara_glk_set_default_font_description( glk, (PangoFontDescription *)g_value_get_pointer(value) );
 106                         break;
 107                 case PROP_MONOSPACE_FONT_DESCRIPTION:
 108                         chimara_glk_set_monospace_font_description( glk, (PangoFontDescription *)g_value_get_pointer(value) );
 109                         break;
 110                 case PROP_SPACING:
 111                         chimara_glk_set_spacing( glk, g_value_get_uint(value) );
 112                         break;
 113         default:
 114             G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
 115     }
 116 }
 117
 118 static void
 119 chimara_glk_get_property(GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
 120 {
 121     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(object);
 122
 123     switch(prop_id)
 124     {
 125         case PROP_INTERACTIVE:
 126             g_value_set_boolean(value, priv->interactive);
 127             break;
 128         case PROP_PROTECT:
 129             g_value_set_boolean(value, priv->protect);
 130             break;
 131                 case PROP_DEFAULT_FONT_DESCRIPTION:
 132                         g_value_set_pointer(value, priv->default_font_desc);
 133                         break;
 134                 case PROP_MONOSPACE_FONT_DESCRIPTION:
 135                         g_value_set_pointer(value, priv->monospace_font_desc);
 136                         break;
 137                 case PROP_SPACING:
 138                         g_value_set_uint(value, priv->spacing);
 139                         break;
 140         default:
 141             G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
 142     }
 143 }
 144
 145 static void
 146 chimara_glk_finalize(GObject *object)
 147 {
 148     ChimaraGlk *self = CHIMARA_GLK(object);
 149     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(self);
 150
 151     /* Free the event queue */
 152     g_mutex_lock(priv->event_lock);
 153         g_queue_foreach(priv->event_queue, (GFunc)g_free, NULL);
 154         g_queue_free(priv->event_queue);
 155         g_cond_free(priv->event_queue_not_empty);
 156         g_cond_free(priv->event_queue_not_full);
 157         priv->event_queue = NULL;
 158         g_mutex_unlock(priv->event_lock);
 159         g_mutex_free(priv->event_lock);
 160
 161         /* Free the abort signalling mechanism */
 162         g_mutex_lock(priv->abort_lock);
 163         /* Make sure no other thread is busy with this */
 164         g_mutex_unlock(priv->abort_lock);
 165         g_mutex_free(priv->abort_lock);
 166         priv->abort_lock = NULL;
 167
 168         /* Free private data */
 169         pango_font_description_free(priv->default_font_desc);
 170         pango_font_description_free(priv->monospace_font_desc);
 171
 172     G_OBJECT_CLASS(chimara_glk_parent_class)->finalize(object);
 173 }
 174
 175 /* Internal function: Recursively get the Glk window tree's size request */
 176 static void
 177 request_recurse(winid_t win, GtkRequisition *requisition, guint spacing)
 178 {
 179         if(win->type == wintype_Pair)
 180         {
 181                 /* Get children's size requests */
 182                 GtkRequisition child1, child2;
 183                 request_recurse(win->window_node->children->data, &child1, spacing);
 184                 request_recurse(win->window_node->children->next->data, &child2, spacing);
 185
 186                 /* If the split is fixed, get the size of the fixed child */
 187                 if((win->split_method & winmethod_DivisionMask) == winmethod_Fixed)
 188                 {
 189                         switch(win->split_method & winmethod_DirMask)
 190                         {
 191                                 case winmethod_Left:
 192                                         child1.width = win->constraint_size * win->key_window->unit_width;
 193                                         break;
 194                                 case winmethod_Right:
 195                                         child2.width = win->constraint_size * win->key_window->unit_width;
 196                                         break;
 197                                 case winmethod_Above:
 198                                         child1.height = win->constraint_size * win->key_window->unit_height;
 199                                         break;
 200                                 case winmethod_Below:
 201                                         child2.height = win->constraint_size * win->key_window->unit_height;
 202                                         break;
 203                         }
 204                 }
 205
 206                 /* Add the children's requests */
 207                 switch(win->split_method & winmethod_DirMask)
 208                 {
 209                         case winmethod_Left:
 210                         case winmethod_Right:
 211                                 requisition->width = child1.width + child2.width + spacing;
 212                                 requisition->height = MAX(child1.height, child2.height);
 213                                 break;
 214                         case winmethod_Above:
 215                         case winmethod_Below:
 216                                 requisition->width = MAX(child1.width, child2.width);
 217                                 requisition->height = child1.height + child2.height + spacing;
 218                                 break;
 219                 }
 220         }
 221
 222         /* For non-pair windows, just use the size that GTK requests */
 223         else
 224                 gtk_widget_size_request(win->frame, requisition);
 225 }
 226
 227 /* Overrides gtk_widget_size_request */
 228 static void
 229 chimara_glk_size_request(GtkWidget *widget, GtkRequisition *requisition)
 230 {
 231     g_return_if_fail(widget);
 232     g_return_if_fail(requisition);
 233     g_return_if_fail(CHIMARA_IS_GLK(widget));
 234
 235     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(widget);
 236
 237     /* For now, just pass the size request on to the root Glk window */
 238     if(priv->root_window)
 239         {
 240                 request_recurse(priv->root_window->data, requisition, priv->spacing);
 241                 requisition->width += 2 * GTK_CONTAINER(widget)->border_width;
 242                 requisition->height += 2 * GTK_CONTAINER(widget)->border_width;
 243         }
 244         else
 245         {
 246         requisition->width = CHIMARA_GLK_MIN_WIDTH + 2 * GTK_CONTAINER(widget)->border_width;
 247         requisition->height = CHIMARA_GLK_MIN_HEIGHT + 2 * GTK_CONTAINER(widget)->border_width;
 248     }
 249 }
 250
 251 /* Recursively give the Glk windows their allocated space */
 252 static void
 253 allocate_recurse(winid_t win, GtkAllocation *allocation, guint spacing)
 254 {
 255         if(win->type == wintype_Pair)
 256         {
 257                 GtkAllocation child1, child2;
 258                 child1.x = allocation->x;
 259                 child1.y = allocation->y;
 260
 261                 if((win->split_method & winmethod_DivisionMask) == winmethod_Fixed)
 262                 {
 263                         switch(win->split_method & winmethod_DirMask)
 264                         {
 265                                 case winmethod_Left:
 266                                         child1.width = CLAMP(win->constraint_size * win->key_window->unit_width, 0, allocation->width - spacing);
 267                                         break;
 268                                 case winmethod_Right:
 269                                         child2.width = CLAMP(win->constraint_size * win->key_window->unit_width, 0, allocation->width - spacing);
 270                                         break;
 271                                 case winmethod_Above:
 272                                         child1.height = CLAMP(win->constraint_size * win->key_window->unit_height, 0, allocation->height - spacing);
 273                                         break;
 274                                 case winmethod_Below:
 275                                         child2.height = CLAMP(win->constraint_size * win->key_window->unit_height, 0, allocation->height - spacing);
 276                                         break;
 277                         }
 278                 }
 279                 else /* proportional */
 280                 {
 281                         gdouble fraction = win->constraint_size / 100.0;
 282                         switch(win->split_method & winmethod_DirMask)
 283                         {
 284                                 case winmethod_Left:
 285                                         child1.width = (glui32) ceil( fraction * (allocation->width - spacing) );
 286                                         break;
 287                                 case winmethod_Right:
 288                                         child2.width = (glui32) ceil( fraction * (allocation->width - spacing) );
 289                                         break;
 290                                 case winmethod_Above:
 291                                         child1.height = (glui32) ceil( fraction * (allocation->height - spacing) );
 292                                         break;
 293                                 case winmethod_Below:
 294                                         child2.height = (glui32) ceil( fraction * (allocation->height - spacing) );
 295                                         break;
 296                         }
 297                 }
 298
 299                 /* Fill in the rest of the size requisitions according to the child specified above */
 300                 switch(win->split_method & winmethod_DirMask)
 301                 {
 302                         case winmethod_Left:
 303                                 child2.width = allocation->width - spacing - child1.width;
 304                                 child2.x = child1.x + child1.width + spacing;
 305                                 child2.y = child1.y;
 306                                 child1.height = child2.height = allocation->height;
 307                                 break;
 308                         case winmethod_Right:
 309                                 child1.width = allocation->width - spacing - child2.width;
 310                                 child2.x = child1.x + child1.width + spacing;
 311                                 child2.y = child1.y;
 312                                 child1.height = child2.height = allocation->height;
 313                                 break;
 314                         case winmethod_Above:
 315                                 child2.height = allocation->height - spacing - child1.height;
 316                                 child2.x = child1.x;
 317                                 child2.y = child1.y + child1.height + spacing;
 318                                 child1.width = child2.width = allocation->width;
 319                                 break;
 320                         case winmethod_Below:
 321                                 child1.height = allocation->height - spacing - child2.height;
 322                                 child2.x = child1.x;
 323                                 child2.y = child1.y + child1.height + spacing;
 324                                 child1.width = child2.width = allocation->width;
 325                                 break;
 326                 }
 327
 328                 /* Recurse */
 329                 allocate_recurse(win->window_node->children->data, &child1, spacing);
 330                 allocate_recurse(win->window_node->children->next->data, &child2, spacing);
 331         }
 332
 333         /* For non-pair windows, just give them the size */
 334         else
 335                 gtk_widget_size_allocate(win->frame, allocation);
 336 }
 337
 338 /* Overrides gtk_widget_size_allocate */
 339 static void
 340 chimara_glk_size_allocate(GtkWidget *widget, GtkAllocation *allocation)
 341 {
 342     g_return_if_fail(widget);
 343     g_return_if_fail(allocation);
 344     g_return_if_fail(CHIMARA_IS_GLK(widget));
 345
 346     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(widget);
 347
 348     widget->allocation = *allocation;
 349
 350     if(priv->root_window) {
 351                 GtkAllocation child;
 352                 child.x = allocation->x + GTK_CONTAINER(widget)->border_width;
 353                 child.y = allocation->y + GTK_CONTAINER(widget)->border_width;
 354                 child.width = CLAMP(allocation->width - 2 * GTK_CONTAINER(widget)->border_width, 0, allocation->width);
 355                 child.height = CLAMP(allocation->height - 2 * GTK_CONTAINER(widget)->border_width, 0, allocation->height);
 356                 allocate_recurse(priv->root_window->data, &child, priv->spacing);
 357         }
 358 }
 359
 360 /* Recursively invoke callback() on the GtkWidget of each non-pair window in the tree */
 361 static void
 362 forall_recurse(winid_t win, GtkCallback callback, gpointer callback_data)
 363 {
 364         if(win->type == wintype_Pair)
 365         {
 366                 forall_recurse(win->window_node->children->data, callback, callback_data);
 367                 forall_recurse(win->window_node->children->next->data, callback, callback_data);
 368         }
 369         else
 370                 (*callback)(win->frame, callback_data);
 371 }
 372
 373 /* Overrides gtk_container_forall */
 374 static void
 375 chimara_glk_forall(GtkContainer *container, gboolean include_internals, GtkCallback callback, gpointer callback_data)
 376 {
 377     g_return_if_fail(container);
 378     g_return_if_fail(CHIMARA_IS_GLK(container));
 379
 380     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(container);
 381
 382         /* All the children are "internal" */
 383         if(!include_internals)
 384                 return;
 385
 386     if(priv->root_window)
 387                 forall_recurse(priv->root_window->data, callback, callback_data);
 388 }
 389
 390 static void
 391 chimara_glk_stopped(ChimaraGlk *self)
 392 {
 393     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(self);
 394
 395     /* Free the plugin */
 396         if( priv->program && !g_module_close(priv->program) )
 397             g_warning( "Error closing module: %s", g_module_error() );
 398 }
 399
 400 static void
 401 chimara_glk_started(ChimaraGlk *self)
 402 {
 403         /* TODO: Add default signal handler implementation here */
 404 }
 405
 406 /* G_PARAM_STATIC_STRINGS only appeared in GTK 2.13.0 */
 407 #ifndef G_PARAM_STATIC_STRINGS
 408 #define G_PARAM_STATIC_STRINGS (G_PARAM_STATIC_NAME | G_PARAM_STATIC_NICK | G_PARAM_STATIC_BLURB)
 409 #endif
 410
 411 static void
 412 chimara_glk_class_init(ChimaraGlkClass *klass)
 413 {
 414     /* Override methods of parent classes */
 415     GObjectClass *object_class = G_OBJECT_CLASS(klass);
 416     object_class->set_property = chimara_glk_set_property;
 417     object_class->get_property = chimara_glk_get_property;
 418     object_class->finalize = chimara_glk_finalize;
 419
 420     GtkWidgetClass *widget_class = GTK_WIDGET_CLASS(klass);
 421     widget_class->size_request = chimara_glk_size_request;
 422     widget_class->size_allocate = chimara_glk_size_allocate;
 423
 424     GtkContainerClass *container_class = GTK_CONTAINER_CLASS(klass);
 425     container_class->forall = chimara_glk_forall;
 426
 427     /* Signals */
 428     klass->stopped = chimara_glk_stopped;
 429     klass->started = chimara_glk_started;
 430     /**
 431      * ChimaraGlk::stopped:
 432      * @glk: The widget that received the signal
 433      *
 434      * The ::stopped signal is emitted when the a Glk program finishes
 435      * executing in the widget, whether it ended normally, or was interrupted.
 436      */
 437     chimara_glk_signals[STOPPED] = g_signal_new("stopped",
 438         G_OBJECT_CLASS_TYPE(klass), 0,
 439         G_STRUCT_OFFSET(ChimaraGlkClass, stopped), NULL, NULL,
 440                 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
 441         /**
 442          * ChimaraGlk::started:
 443          * @glk: The widget that received the signal
 444          *
 445          * The ::started signal is emitted when a Glk program starts executing in
 446          * the widget.
 447          */
 448         chimara_glk_signals[STARTED] = g_signal_new ("started",
 449                 G_OBJECT_CLASS_TYPE (klass), 0,
 450                 G_STRUCT_OFFSET(ChimaraGlkClass, started), NULL, NULL,
 451                 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
 452
 453     /* Properties */
 454     /**
 455      * ChimaraGlk:interactive:
 456      *
 457      * Sets whether the widget is interactive. A Glk widget is normally
 458      * interactive, but in non-interactive mode, keyboard and mouse input are
 459      * ignored and the Glk program is controlled by chimara_glk_feed_text().
 460      * <quote>More</quote> prompts when a lot of text is printed to a text
 461          * buffer are also disabled. This is typically used when you wish to control
 462          * an interpreter program by feeding it a predefined list of commands.
 463      */
 464     g_object_class_install_property( object_class, PROP_INTERACTIVE,
 465                 g_param_spec_boolean("interactive", _("Interactive"),
 466         _("Whether user input is expected in the Glk program"),
 467         TRUE,
 468         G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
 469
 470         /**
 471      * ChimaraGlk:protect:
 472      *
 473      * Sets whether the Glk program is allowed to do file operations. In protect
 474      * mode, all file operations will fail.
 475      */
 476     g_object_class_install_property(object_class, PROP_PROTECT,
 477                 g_param_spec_boolean("protect", _("Protected"),
 478         _("Whether the Glk program is barred from doing file operations"),
 479         FALSE,
 480         G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
 481
 482         /* We can't use G_PARAM_CONSTRUCT on these because then the constructor will
 483          initialize them with NULL */
 484         /**
 485          * ChimaraGlk:default-font-description:
 486          *
 487          * Pointer to a #PangoFontDescription describing the default proportional
 488          * font, to be used in text buffer windows for example.
 489          *
 490          * Default value: font description created from the string
 491          * <quote>Sans</quote>
 492          */
 493         g_object_class_install_property(object_class, PROP_DEFAULT_FONT_DESCRIPTION,
 494                 g_param_spec_pointer("default-font-description", _("Default Font"),
 495                 _("Font description of the default proportional font"),
 496                 G_PARAM_READWRITE | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
 497
 498         /**
 499          * ChimaraGlk:monospace-font-description:
 500          *
 501          * Pointer to a #PangoFontDescription describing the default monospace font,
 502          * to be used in text grid windows and #style_Preformatted, for example.
 503          *
 504          * Default value: font description created from the string
 505          * <quote>Monospace</quote>
 506          */
 507         g_object_class_install_property(object_class, PROP_MONOSPACE_FONT_DESCRIPTION,
 508                 g_param_spec_pointer("monospace-font-description", _("Monospace Font"),
 509                 _("Font description of the default monospace font"),
 510                 G_PARAM_READWRITE | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
 511
 512         /**
 513          * ChimaraGlk:spacing:
 514          *
 515          * The amount of space between the Glk windows.
 516          */
 517         g_object_class_install_property(object_class, PROP_SPACING,
 518                 g_param_spec_uint("spacing", _("Spacing"),
 519                 _("The amount of space between Glk windows"),
 520                 0, G_MAXUINT, 0,
 521                 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
 522
 523     /* Private data */
 524     g_type_class_add_private(klass, sizeof(ChimaraGlkPrivate));
 525 }
 526
 527 /* PUBLIC FUNCTIONS */
 528
 529 /**
 530  * chimara_glk_new:
 531  *
 532  * Creates and initializes a new #ChimaraGlk widget.
 533  *
 534  * Return value: a #ChimaraGlk widget, with a floating reference.
 535  */
 536 GtkWidget *
 537 chimara_glk_new(void)
 538 {
 539     ChimaraGlk *self = CHIMARA_GLK(g_object_new(CHIMARA_TYPE_GLK, NULL));
 540     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(self);
 541
 542     priv->event_queue = g_queue_new();
 543     priv->event_lock = g_mutex_new();
 544     priv->event_queue_not_empty = g_cond_new();
 545     priv->event_queue_not_full = g_cond_new();
 546     priv->abort_lock = g_mutex_new();
 547
 548     return GTK_WIDGET(self);
 549 }
 550
 551 /**
 552  * chimara_glk_set_interactive:
 553  * @glk: a #ChimaraGlk widget
 554  * @interactive: whether the widget should expect user input
 555  *
 556  * Sets the #ChimaraGlk:interactive property of @glk.
 557  */
 558 void
 559 chimara_glk_set_interactive(ChimaraGlk *glk, gboolean interactive)
 560 {
 561     g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
 562
 563     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
 564     priv->interactive = interactive;
 565 }
 566
 567 /**
 568  * chimara_glk_get_interactive:
 569  * @glk: a #ChimaraGlk widget
 570  *
 571  * Returns whether @glk is interactive (expecting user input). See
 572  * #ChimaraGlk:interactive.
 573  *
 574  * Return value: %TRUE if @glk is interactive.
 575  */
 576 gboolean
 577 chimara_glk_get_interactive(ChimaraGlk *glk)
 578 {
 579     g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
 580
 581     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
 582     return priv->interactive;
 583 }
 584
 585 /**
 586  * chimara_glk_set_protect:
 587  * @glk: a #ChimaraGlk widget
 588  * @protect: whether the widget should allow the Glk program to do file
 589  * operations
 590  *
 591  * Sets the #ChimaraGlk:protect property of @glk. In protect mode, the Glk
 592  * program is not allowed to do file operations.
 593  */
 594 void
 595 chimara_glk_set_protect(ChimaraGlk *glk, gboolean protect)
 596 {
 597     g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
 598
 599     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
 600     priv->protect = protect;
 601 }
 602
 603 /**
 604  * chimara_glk_get_protect:
 605  * @glk: a #ChimaraGlk widget
 606  *
 607  * Returns whether @glk is in protect mode (banned from doing file operations).
 608  * See #ChimaraGlk:protect.
 609  *
 610  * Return value: %TRUE if @glk is in protect mode.
 611  */
 612 gboolean
 613 chimara_glk_get_protect(ChimaraGlk *glk)
 614 {
 615     g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
 616
 617     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
 618     return priv->protect;
 619 }
 620
 621 /**
 622  * chimara_glk_set_default_font_description:
 623  * @glk: a #ChimaraGlk widget
 624  * @font: a #PangoFontDescription
 625  *
 626  * Sets @glk's default proportional font. See
 627  * #ChimaraGlk:default-font-description.
 628  */
 629 void
 630 chimara_glk_set_default_font_description(ChimaraGlk *glk, PangoFontDescription *font)
 631 {
 632         g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
 633         g_return_if_fail(font);
 634
 635         ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
 636         pango_font_description_free(priv->default_font_desc);
 637         priv->default_font_desc = pango_font_description_copy(font);
 638
 639         /* TODO: Apply the font description to all the windows and recalculate the sizes */
 640 }
 641
 642 /**
 643  * chimara_glk_set_default_font_string:
 644  * @glk: a #ChimaraGlk widget
 645  * @font: string representation of a font description
 646  *
 647  * Sets @glk's default proportional font according to the string @font, which
 648  * must be a string in the form <quote><replaceable>FAMILY-LIST</replaceable>
 649  * [<replaceable>STYLE-OPTIONS</replaceable>]
 650  * [<replaceable>SIZE</replaceable>]</quote>, such as <quote>Charter,Utopia
 651  * Italic 12</quote> or <quote>Sans</quote>. See
 652  * #ChimaraGlk:default-font-description.
 653  */
 654 void
 655 chimara_glk_set_default_font_string(ChimaraGlk *glk, const gchar *font)
 656 {
 657         g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
 658         g_return_if_fail(font || *font);
 659
 660         PangoFontDescription *fontdesc = pango_font_description_from_string(font);
 661         g_return_if_fail(fontdesc);
 662
 663         ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
 664         pango_font_description_free(priv->default_font_desc);
 665         priv->default_font_desc = fontdesc;
 666
 667         /* TODO: Apply the font description to all the windows and recalculate the sizes */
 668 }
 669
 670 /**
 671  * chimara_glk_get_default_font_description:
 672  * @glk: a #ChimaraGlk widget
 673  *
 674  * Returns @glk's default proportional font.
 675  *
 676  * Return value: a newly-allocated #PangoFontDescription which must be freed
 677  * using pango_font_description_free(), or %NULL on error.
 678  */
 679 PangoFontDescription *
 680 chimara_glk_get_default_font_description(ChimaraGlk *glk)
 681 {
 682         g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), NULL);
 683
 684         ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
 685         return pango_font_description_copy(priv->default_font_desc);
 686 }
 687
 688 /**
 689  * chimara_glk_set_monospace_font_description:
 690  * @glk: a #ChimaraGlk widget
 691  * @font: a #PangoFontDescription
 692  *
 693  * Sets @glk's default monospace font. See
 694  * #ChimaraGlk:monospace-font-description.
 695  */
 696 void
 697 chimara_glk_set_monospace_font_description(ChimaraGlk *glk, PangoFontDescription *font)
 698 {
 699         g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
 700         g_return_if_fail(font);
 701
 702         ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
 703         pango_font_description_free(priv->monospace_font_desc);
 704         priv->monospace_font_desc = pango_font_description_copy(font);
 705
 706         /* TODO: Apply the font description to all the windows and recalculate the sizes */
 707 }
 708
 709 /**
 710  * chimara_glk_set_monospace_font_string:
 711  * @glk: a #ChimaraGlk widget
 712  * @font: string representation of a font description
 713  *
 714  * Sets @glk's default monospace font according to the string @font, which must
 715  * be a string in the form <quote><replaceable>FAMILY-LIST</replaceable>
 716  * [<replaceable>STYLE-OPTIONS</replaceable>]
 717  * [<replaceable>SIZE</replaceable>]</quote>, such as <quote>Courier
 718  * Bold 12</quote> or <quote>Monospace</quote>. See
 719  * #ChimaraGlk:monospace-font-description.
 720  */
 721 void
 722 chimara_glk_set_monospace_font_string(ChimaraGlk *glk, const gchar *font)
 723 {
 724         g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
 725         g_return_if_fail(font || *font);
 726
 727         PangoFontDescription *fontdesc = pango_font_description_from_string(font);
 728         g_return_if_fail(fontdesc);
 729
 730         ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
 731         pango_font_description_free(priv->monospace_font_desc);
 732         priv->monospace_font_desc = fontdesc;
 733
 734         /* TODO: Apply the font description to all the windows and recalculate the sizes */
 735 }
 736
 737 /**
 738  * chimara_glk_get_monospace_font_description:
 739  * @glk: a #ChimaraGlk widget
 740  *
 741  * Returns @glk's default monospace font.
 742  *
 743  * Return value: a newly-allocated #PangoFontDescription which must be freed
 744  * using pango_font_description_free(), or %NULL on error.
 745  */
 746 PangoFontDescription *
 747 chimara_glk_get_monospace_font_description(ChimaraGlk *glk)
 748 {
 749         g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), NULL);
 750
 751         ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
 752         return pango_font_description_copy(priv->monospace_font_desc);
 753 }
 754
 755 /**
 756  * chimara_glk_set_spacing:
 757  * @glk: a #ChimaraGlk widget
 758  * @spacing: the number of pixels to put between Glk windows
 759  *
 760  * Sets the #ChimaraGlk:spacing property of @glk, which is the border width in
 761  * pixels between Glk windows.
 762  */
 763 void
 764 chimara_glk_set_spacing(ChimaraGlk *glk, guint spacing)
 765 {
 766         g_return_if_fail( glk || CHIMARA_IS_GLK(glk) );
 767
 768         ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
 769         priv->spacing = spacing;
 770 }
 771
 772 /**
 773  * chimara_glk_get_spacing:
 774  * @glk: a #ChimaraGlk widget
 775  *
 776  * Gets the value set by chimara_glk_set_spacing().
 777  *
 778  * Return value: pixels of spacing between Glk windows
 779  */
 780 guint
 781 chimara_glk_get_spacing(ChimaraGlk *glk)
 782 {
 783         g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), 0);
 784
 785         ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
 786         return priv->spacing;
 787 }
 788
 789 /* glk_enter() is the actual function called in the new thread in which glk_main() runs.  */
 790 static gpointer
 791 glk_enter(gpointer glk_main)
 792 {
 793     extern ChimaraGlkPrivate *glk_data;
 794     g_signal_emit_by_name(glk_data->self, "started");
 795         ((glk_main_t)glk_main)();
 796         g_signal_emit_by_name(glk_data->self, "stopped");
 797         return NULL;
 798 }
 799
 800 /**
 801  * chimara_glk_run:
 802  * @glk: a #ChimaraGlk widget
 803  * @plugin: path to a plugin module compiled with <filename
 804  * class="header">glk.h</filename>
 805  * @error: location to store a <link linkend="glib-GError">GError</link>, or
 806  * %NULL
 807  *
 808  * Opens a Glk program compiled as a plugin and runs its glk_main() function in
 809  * a separate thread. On failure, returns %FALSE and sets @error.
 810  *
 811  * Return value: %TRUE if the Glk program was started successfully.
 812  */
 813 gboolean
 814 chimara_glk_run(ChimaraGlk *glk, gchar *plugin, GError **error)
 815 {
 816     g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
 817     g_return_val_if_fail(plugin, FALSE);
 818
 819     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
 820
 821     /* Open the module to run */
 822     glk_main_t glk_main;
 823     g_assert( g_module_supported() );
 824     priv->program = g_module_open(plugin, G_MODULE_BIND_LAZY);
 825
 826     if(!priv->program)
 827     {
 828         g_warning( "Error opening module: %s", g_module_error() );
 829         return FALSE;
 830     }
 831     if( !g_module_symbol(priv->program, "glk_main", (gpointer *) &glk_main) )
 832     {
 833         g_warning( "Error finding glk_main(): %s", g_module_error() );
 834         return FALSE;
 835     }
 836
 837     extern ChimaraGlkPrivate *glk_data;
 838     /* Set the thread's private data */
 839     /* TODO: Do this with a GPrivate */
 840     glk_data = priv;
 841
 842     /* Run in a separate thread */
 843         priv->thread = g_thread_create(glk_enter, glk_main, TRUE, error);
 844
 845         return !(priv->thread == NULL);
 846 }
 847
 848 /**
 849  * chimara_glk_stop:
 850  * @glk: a #ChimaraGlk widget
 851  *
 852  * Signals the Glk program running in @glk to abort. Note that if the program is
 853  * caught in an infinite loop in which glk_tick() is not called, this may not
 854  * work.
 855  */
 856 void
 857 chimara_glk_stop(ChimaraGlk *glk)
 858 {
 859     g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
 860     /* TODO: check if glk is actually running a program */
 861     signal_abort();
 862 }
 863
 864 /**
 865  * chimara_glk_wait:
 866  * @glk: a #ChimaraGlk widget
 867  *
 868  * Holds up the main thread and waits for the Glk program running in @glk to
 869  * finish.
 870  */
 871 void
 872 chimara_glk_wait(ChimaraGlk *glk)
 873 {
 874     g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
 875
 876     ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
 877     g_thread_join(priv->thread);
 878 }