1 /* licensing and copyright information here */
5 #include <glib/gi18n.h>
7 #include <pango/pango.h>
8 #include "chimara-glk.h"
9 #include "chimara-glk-private.h"
14 #define CHIMARA_GLK_MIN_WIDTH 0
15 #define CHIMARA_GLK_MIN_HEIGHT 0
19 * @short_description: Widget which executes a Glk program
20 * @stability: Unstable
21 * @include: chimara/chimara-glk.h
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.
27 * On Linux systems, this is a file with a name like
28 * <filename>plugin.so</filename>. For portability, you can use libtool and
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
38 * url="http://www.gnu.org/software/libtool/manual/html_node/Finding-the-dlname.html">
39 * Libtool manual</ulink>).
42 typedef void (* glk_main_t) (void);
48 PROP_DEFAULT_FONT_DESCRIPTION,
49 PROP_MONOSPACE_FONT_DESCRIPTION,
60 static guint chimara_glk_signals[LAST_SIGNAL] = { 0 };
62 G_DEFINE_TYPE(ChimaraGlk, chimara_glk, GTK_TYPE_CONTAINER);
65 chimara_glk_init(ChimaraGlk *self)
67 GTK_WIDGET_SET_FLAGS(GTK_WIDGET(self), GTK_NO_WINDOW);
69 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(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");
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;
92 chimara_glk_set_property(GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
94 ChimaraGlk *glk = CHIMARA_GLK(object);
98 case PROP_INTERACTIVE:
99 chimara_glk_set_interactive( glk, g_value_get_boolean(value) );
102 chimara_glk_set_protect( glk, g_value_get_boolean(value) );
104 case PROP_DEFAULT_FONT_DESCRIPTION:
105 chimara_glk_set_default_font_description( glk, (PangoFontDescription *)g_value_get_pointer(value) );
107 case PROP_MONOSPACE_FONT_DESCRIPTION:
108 chimara_glk_set_monospace_font_description( glk, (PangoFontDescription *)g_value_get_pointer(value) );
111 chimara_glk_set_spacing( glk, g_value_get_uint(value) );
114 G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
119 chimara_glk_get_property(GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
121 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(object);
125 case PROP_INTERACTIVE:
126 g_value_set_boolean(value, priv->interactive);
129 g_value_set_boolean(value, priv->protect);
131 case PROP_DEFAULT_FONT_DESCRIPTION:
132 g_value_set_pointer(value, priv->default_font_desc);
134 case PROP_MONOSPACE_FONT_DESCRIPTION:
135 g_value_set_pointer(value, priv->monospace_font_desc);
138 g_value_set_uint(value, priv->spacing);
141 G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
146 chimara_glk_finalize(GObject *object)
148 ChimaraGlk *self = CHIMARA_GLK(object);
149 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(self);
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);
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;
168 /* Free private data */
169 pango_font_description_free(priv->default_font_desc);
170 pango_font_description_free(priv->monospace_font_desc);
172 G_OBJECT_CLASS(chimara_glk_parent_class)->finalize(object);
175 /* Internal function: Recursively get the Glk window tree's size request */
177 request_recurse(winid_t win, GtkRequisition *requisition, guint spacing)
179 if(win->type == wintype_Pair)
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);
186 /* If the split is fixed, get the size of the fixed child */
187 if((win->split_method & winmethod_DivisionMask) == winmethod_Fixed)
189 switch(win->split_method & winmethod_DirMask)
192 child1.width = win->constraint_size * win->key_window->unit_width;
194 case winmethod_Right:
195 child2.width = win->constraint_size * win->key_window->unit_width;
197 case winmethod_Above:
198 child1.height = win->constraint_size * win->key_window->unit_height;
200 case winmethod_Below:
201 child2.height = win->constraint_size * win->key_window->unit_height;
206 /* Add the children's requests */
207 switch(win->split_method & winmethod_DirMask)
210 case winmethod_Right:
211 requisition->width = child1.width + child2.width + spacing;
212 requisition->height = MAX(child1.height, child2.height);
214 case winmethod_Above:
215 case winmethod_Below:
216 requisition->width = MAX(child1.width, child2.width);
217 requisition->height = child1.height + child2.height + spacing;
222 /* For non-pair windows, just use the size that GTK requests */
224 gtk_widget_size_request(win->frame, requisition);
227 /* Overrides gtk_widget_size_request */
229 chimara_glk_size_request(GtkWidget *widget, GtkRequisition *requisition)
231 g_return_if_fail(widget);
232 g_return_if_fail(requisition);
233 g_return_if_fail(CHIMARA_IS_GLK(widget));
235 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(widget);
237 /* For now, just pass the size request on to the root Glk window */
238 if(priv->root_window)
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;
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;
251 /* Recursively give the Glk windows their allocated space */
253 allocate_recurse(winid_t win, GtkAllocation *allocation, guint spacing)
255 if(win->type == wintype_Pair)
257 GtkAllocation child1, child2;
258 child1.x = allocation->x;
259 child1.y = allocation->y;
261 if((win->split_method & winmethod_DivisionMask) == winmethod_Fixed)
263 switch(win->split_method & winmethod_DirMask)
266 child1.width = CLAMP(win->constraint_size * win->key_window->unit_width, 0, allocation->width - spacing);
268 case winmethod_Right:
269 child2.width = CLAMP(win->constraint_size * win->key_window->unit_width, 0, allocation->width - spacing);
271 case winmethod_Above:
272 child1.height = CLAMP(win->constraint_size * win->key_window->unit_height, 0, allocation->height - spacing);
274 case winmethod_Below:
275 child2.height = CLAMP(win->constraint_size * win->key_window->unit_height, 0, allocation->height - spacing);
279 else /* proportional */
281 gdouble fraction = win->constraint_size / 100.0;
282 switch(win->split_method & winmethod_DirMask)
285 child1.width = (glui32) ceil( fraction * (allocation->width - spacing) );
287 case winmethod_Right:
288 child2.width = (glui32) ceil( fraction * (allocation->width - spacing) );
290 case winmethod_Above:
291 child1.height = (glui32) ceil( fraction * (allocation->height - spacing) );
293 case winmethod_Below:
294 child2.height = (glui32) ceil( fraction * (allocation->height - spacing) );
299 /* Fill in the rest of the size requisitions according to the child specified above */
300 switch(win->split_method & winmethod_DirMask)
303 child2.width = allocation->width - spacing - child1.width;
304 child2.x = child1.x + child1.width + spacing;
306 child1.height = child2.height = allocation->height;
308 case winmethod_Right:
309 child1.width = allocation->width - spacing - child2.width;
310 child2.x = child1.x + child1.width + spacing;
312 child1.height = child2.height = allocation->height;
314 case winmethod_Above:
315 child2.height = allocation->height - spacing - child1.height;
317 child2.y = child1.y + child1.height + spacing;
318 child1.width = child2.width = allocation->width;
320 case winmethod_Below:
321 child1.height = allocation->height - spacing - child2.height;
323 child2.y = child1.y + child1.height + spacing;
324 child1.width = child2.width = allocation->width;
329 allocate_recurse(win->window_node->children->data, &child1, spacing);
330 allocate_recurse(win->window_node->children->next->data, &child2, spacing);
333 /* For non-pair windows, just give them the size */
335 gtk_widget_size_allocate(win->frame, allocation);
338 /* Overrides gtk_widget_size_allocate */
340 chimara_glk_size_allocate(GtkWidget *widget, GtkAllocation *allocation)
342 g_return_if_fail(widget);
343 g_return_if_fail(allocation);
344 g_return_if_fail(CHIMARA_IS_GLK(widget));
346 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(widget);
348 widget->allocation = *allocation;
350 if(priv->root_window) {
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);
360 /* Recursively invoke callback() on the GtkWidget of each non-pair window in the tree */
362 forall_recurse(winid_t win, GtkCallback callback, gpointer callback_data)
364 if(win->type == wintype_Pair)
366 forall_recurse(win->window_node->children->data, callback, callback_data);
367 forall_recurse(win->window_node->children->next->data, callback, callback_data);
370 (*callback)(win->frame, callback_data);
373 /* Overrides gtk_container_forall */
375 chimara_glk_forall(GtkContainer *container, gboolean include_internals, GtkCallback callback, gpointer callback_data)
377 g_return_if_fail(container);
378 g_return_if_fail(CHIMARA_IS_GLK(container));
380 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(container);
382 /* All the children are "internal" */
383 if(!include_internals)
386 if(priv->root_window)
387 forall_recurse(priv->root_window->data, callback, callback_data);
391 chimara_glk_stopped(ChimaraGlk *self)
393 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(self);
395 /* Free the plugin */
396 if( priv->program && !g_module_close(priv->program) )
397 g_warning( "Error closing module: %s", g_module_error() );
401 chimara_glk_started(ChimaraGlk *self)
403 /* TODO: Add default signal handler implementation here */
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)
412 chimara_glk_class_init(ChimaraGlkClass *klass)
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;
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;
424 GtkContainerClass *container_class = GTK_CONTAINER_CLASS(klass);
425 container_class->forall = chimara_glk_forall;
428 klass->stopped = chimara_glk_stopped;
429 klass->started = chimara_glk_started;
431 * ChimaraGlk::stopped:
432 * @glk: The widget that received the signal
434 * The ::stopped signal is emitted when the a Glk program finishes
435 * executing in the widget, whether it ended normally, or was interrupted.
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);
442 * ChimaraGlk::started:
443 * @glk: The widget that received the signal
445 * The ::started signal is emitted when a Glk program starts executing in
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);
455 * ChimaraGlk:interactive:
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.
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"),
468 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
471 * ChimaraGlk:protect:
473 * Sets whether the Glk program is allowed to do file operations. In protect
474 * mode, all file operations will fail.
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"),
480 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
482 /* We can't use G_PARAM_CONSTRUCT on these because then the constructor will
483 initialize them with NULL */
485 * ChimaraGlk:default-font-description:
487 * Pointer to a #PangoFontDescription describing the default proportional
488 * font, to be used in text buffer windows for example.
490 * Default value: font description created from the string
491 * <quote>Sans</quote>
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) );
499 * ChimaraGlk:monospace-font-description:
501 * Pointer to a #PangoFontDescription describing the default monospace font,
502 * to be used in text grid windows and #style_Preformatted, for example.
504 * Default value: font description created from the string
505 * <quote>Monospace</quote>
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) );
513 * ChimaraGlk:spacing:
515 * The amount of space between the Glk windows.
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"),
521 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
524 g_type_class_add_private(klass, sizeof(ChimaraGlkPrivate));
527 /* PUBLIC FUNCTIONS */
532 * Creates and initializes a new #ChimaraGlk widget.
534 * Return value: a #ChimaraGlk widget, with a floating reference.
537 chimara_glk_new(void)
539 ChimaraGlk *self = CHIMARA_GLK(g_object_new(CHIMARA_TYPE_GLK, NULL));
540 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(self);
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();
548 return GTK_WIDGET(self);
552 * chimara_glk_set_interactive:
553 * @glk: a #ChimaraGlk widget
554 * @interactive: whether the widget should expect user input
556 * Sets the #ChimaraGlk:interactive property of @glk.
559 chimara_glk_set_interactive(ChimaraGlk *glk, gboolean interactive)
561 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
563 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
564 priv->interactive = interactive;
568 * chimara_glk_get_interactive:
569 * @glk: a #ChimaraGlk widget
571 * Returns whether @glk is interactive (expecting user input). See
572 * #ChimaraGlk:interactive.
574 * Return value: %TRUE if @glk is interactive.
577 chimara_glk_get_interactive(ChimaraGlk *glk)
579 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
581 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
582 return priv->interactive;
586 * chimara_glk_set_protect:
587 * @glk: a #ChimaraGlk widget
588 * @protect: whether the widget should allow the Glk program to do file
591 * Sets the #ChimaraGlk:protect property of @glk. In protect mode, the Glk
592 * program is not allowed to do file operations.
595 chimara_glk_set_protect(ChimaraGlk *glk, gboolean protect)
597 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
599 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
600 priv->protect = protect;
604 * chimara_glk_get_protect:
605 * @glk: a #ChimaraGlk widget
607 * Returns whether @glk is in protect mode (banned from doing file operations).
608 * See #ChimaraGlk:protect.
610 * Return value: %TRUE if @glk is in protect mode.
613 chimara_glk_get_protect(ChimaraGlk *glk)
615 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
617 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
618 return priv->protect;
622 * chimara_glk_set_default_font_description:
623 * @glk: a #ChimaraGlk widget
624 * @font: a #PangoFontDescription
626 * Sets @glk's default proportional font. See
627 * #ChimaraGlk:default-font-description.
630 chimara_glk_set_default_font_description(ChimaraGlk *glk, PangoFontDescription *font)
632 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
633 g_return_if_fail(font);
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);
639 /* TODO: Apply the font description to all the windows and recalculate the sizes */
643 * chimara_glk_set_default_font_string:
644 * @glk: a #ChimaraGlk widget
645 * @font: string representation of a font description
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.
655 chimara_glk_set_default_font_string(ChimaraGlk *glk, const gchar *font)
657 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
658 g_return_if_fail(font || *font);
660 PangoFontDescription *fontdesc = pango_font_description_from_string(font);
661 g_return_if_fail(fontdesc);
663 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
664 pango_font_description_free(priv->default_font_desc);
665 priv->default_font_desc = fontdesc;
667 /* TODO: Apply the font description to all the windows and recalculate the sizes */
671 * chimara_glk_get_default_font_description:
672 * @glk: a #ChimaraGlk widget
674 * Returns @glk's default proportional font.
676 * Return value: a newly-allocated #PangoFontDescription which must be freed
677 * using pango_font_description_free(), or %NULL on error.
679 PangoFontDescription *
680 chimara_glk_get_default_font_description(ChimaraGlk *glk)
682 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), NULL);
684 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
685 return pango_font_description_copy(priv->default_font_desc);
689 * chimara_glk_set_monospace_font_description:
690 * @glk: a #ChimaraGlk widget
691 * @font: a #PangoFontDescription
693 * Sets @glk's default monospace font. See
694 * #ChimaraGlk:monospace-font-description.
697 chimara_glk_set_monospace_font_description(ChimaraGlk *glk, PangoFontDescription *font)
699 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
700 g_return_if_fail(font);
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);
706 /* TODO: Apply the font description to all the windows and recalculate the sizes */
710 * chimara_glk_set_monospace_font_string:
711 * @glk: a #ChimaraGlk widget
712 * @font: string representation of a font description
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.
722 chimara_glk_set_monospace_font_string(ChimaraGlk *glk, const gchar *font)
724 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
725 g_return_if_fail(font || *font);
727 PangoFontDescription *fontdesc = pango_font_description_from_string(font);
728 g_return_if_fail(fontdesc);
730 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
731 pango_font_description_free(priv->monospace_font_desc);
732 priv->monospace_font_desc = fontdesc;
734 /* TODO: Apply the font description to all the windows and recalculate the sizes */
738 * chimara_glk_get_monospace_font_description:
739 * @glk: a #ChimaraGlk widget
741 * Returns @glk's default monospace font.
743 * Return value: a newly-allocated #PangoFontDescription which must be freed
744 * using pango_font_description_free(), or %NULL on error.
746 PangoFontDescription *
747 chimara_glk_get_monospace_font_description(ChimaraGlk *glk)
749 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), NULL);
751 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
752 return pango_font_description_copy(priv->monospace_font_desc);
756 * chimara_glk_set_spacing:
757 * @glk: a #ChimaraGlk widget
758 * @spacing: the number of pixels to put between Glk windows
760 * Sets the #ChimaraGlk:spacing property of @glk, which is the border width in
761 * pixels between Glk windows.
764 chimara_glk_set_spacing(ChimaraGlk *glk, guint spacing)
766 g_return_if_fail( glk || CHIMARA_IS_GLK(glk) );
768 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
769 priv->spacing = spacing;
773 * chimara_glk_get_spacing:
774 * @glk: a #ChimaraGlk widget
776 * Gets the value set by chimara_glk_set_spacing().
778 * Return value: pixels of spacing between Glk windows
781 chimara_glk_get_spacing(ChimaraGlk *glk)
783 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), 0);
785 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
786 return priv->spacing;
789 /* glk_enter() is the actual function called in the new thread in which glk_main() runs. */
791 glk_enter(gpointer glk_main)
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");
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
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.
811 * Return value: %TRUE if the Glk program was started successfully.
814 chimara_glk_run(ChimaraGlk *glk, gchar *plugin, GError **error)
816 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
817 g_return_val_if_fail(plugin, FALSE);
819 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
821 /* Open the module to run */
823 g_assert( g_module_supported() );
824 priv->program = g_module_open(plugin, G_MODULE_BIND_LAZY);
828 g_warning( "Error opening module: %s", g_module_error() );
831 if( !g_module_symbol(priv->program, "glk_main", (gpointer *) &glk_main) )
833 g_warning( "Error finding glk_main(): %s", g_module_error() );
837 extern ChimaraGlkPrivate *glk_data;
838 /* Set the thread's private data */
839 /* TODO: Do this with a GPrivate */
842 /* Run in a separate thread */
843 priv->thread = g_thread_create(glk_enter, glk_main, TRUE, error);
845 return !(priv->thread == NULL);
850 * @glk: a #ChimaraGlk widget
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
857 chimara_glk_stop(ChimaraGlk *glk)
859 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
860 /* TODO: check if glk is actually running a program */
866 * @glk: a #ChimaraGlk widget
868 * Holds up the main thread and waits for the Glk program running in @glk to
872 chimara_glk_wait(ChimaraGlk *glk)
874 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
876 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
877 g_thread_join(priv->thread);