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 else if(win->type == wintype_TextGrid)
335 /* Pass the size allocation on to the framing widget */
336 gtk_widget_size_allocate(win->frame, allocation);
337 /* It says in the spec that when a text grid window is resized smaller,
338 the bottom or right area is thrown away; when it is resized larger, the
339 bottom or right area is filled with blanks. */
340 glui32 newwidth = (glui32)(win->widget->allocation.width / win->unit_width);
341 glui32 newheight = (glui32)(win->widget->allocation.height / win->unit_height);
343 GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
344 GtkTextIter start, end;
346 for(line = 0; line < win->height; line++)
348 gtk_text_buffer_get_iter_at_line(textbuffer, &start, line);
349 /* If this line is going to fall off the bottom, delete it */
350 if(line >= newheight)
353 gtk_text_iter_forward_to_line_end(&end);
354 gtk_text_iter_forward_char(&end);
355 gtk_text_buffer_delete(textbuffer, &start, &end);
358 /* If this line is not long enough, add spaces on the end */
359 if(newwidth > win->width)
361 gchar *spaces = g_strnfill(newwidth - win->width, ' ');
362 gtk_text_iter_forward_to_line_end(&start);
363 gtk_text_buffer_insert(textbuffer, &start, spaces, -1);
366 /* But if it's too long, delete characters from the end */
367 else if(newwidth < win->width)
370 gtk_text_iter_forward_chars(&start, newwidth);
371 gtk_text_iter_forward_to_line_end(&end);
372 gtk_text_buffer_delete(textbuffer, &start, &end);
374 /* Note: if the widths are equal, do nothing */
376 /* Add blank lines if there aren't enough lines to fit the new size */
377 if(newheight > win->height)
379 gchar *blanks = g_strnfill(win->width, ' ');
380 gchar **blanklines = g_new0(gchar *, (newheight - win->height) + 1);
382 for(count = 0; count < newheight - win->height; count++)
383 blanklines[count] = blanks;
384 blanklines[newheight - win->height] = NULL;
385 gchar *text = g_strjoinv("\n", blanklines);
386 g_free(blanklines); /* not g_strfreev() */
389 gtk_text_buffer_get_end_iter(textbuffer, &start);
390 gtk_text_buffer_insert(textbuffer, &start, "\n", -1);
391 gtk_text_buffer_insert(textbuffer, &start, text, -1);
395 win->width = newwidth;
396 win->height = newheight;
399 /* For non-pair, non-text-grid windows, just give them the size */
401 gtk_widget_size_allocate(win->frame, allocation);
404 /* Overrides gtk_widget_size_allocate */
406 chimara_glk_size_allocate(GtkWidget *widget, GtkAllocation *allocation)
408 g_return_if_fail(widget);
409 g_return_if_fail(allocation);
410 g_return_if_fail(CHIMARA_IS_GLK(widget));
412 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(widget);
414 widget->allocation = *allocation;
416 if(priv->root_window) {
418 child.x = allocation->x + GTK_CONTAINER(widget)->border_width;
419 child.y = allocation->y + GTK_CONTAINER(widget)->border_width;
420 child.width = CLAMP(allocation->width - 2 * GTK_CONTAINER(widget)->border_width, 0, allocation->width);
421 child.height = CLAMP(allocation->height - 2 * GTK_CONTAINER(widget)->border_width, 0, allocation->height);
422 allocate_recurse(priv->root_window->data, &child, priv->spacing);
426 /* Recursively invoke callback() on the GtkWidget of each non-pair window in the tree */
428 forall_recurse(winid_t win, GtkCallback callback, gpointer callback_data)
430 if(win->type == wintype_Pair)
432 forall_recurse(win->window_node->children->data, callback, callback_data);
433 forall_recurse(win->window_node->children->next->data, callback, callback_data);
436 (*callback)(win->frame, callback_data);
439 /* Overrides gtk_container_forall */
441 chimara_glk_forall(GtkContainer *container, gboolean include_internals, GtkCallback callback, gpointer callback_data)
443 g_return_if_fail(container);
444 g_return_if_fail(CHIMARA_IS_GLK(container));
446 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(container);
448 /* All the children are "internal" */
449 if(!include_internals)
452 if(priv->root_window)
453 forall_recurse(priv->root_window->data, callback, callback_data);
457 chimara_glk_stopped(ChimaraGlk *self)
459 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(self);
461 /* Free the plugin */
462 if( priv->program && !g_module_close(priv->program) )
463 g_warning( "Error closing module: %s", g_module_error() );
467 chimara_glk_started(ChimaraGlk *self)
469 /* TODO: Add default signal handler implementation here */
472 /* G_PARAM_STATIC_STRINGS only appeared in GTK 2.13.0 */
473 #ifndef G_PARAM_STATIC_STRINGS
474 #define G_PARAM_STATIC_STRINGS (G_PARAM_STATIC_NAME | G_PARAM_STATIC_NICK | G_PARAM_STATIC_BLURB)
478 chimara_glk_class_init(ChimaraGlkClass *klass)
480 /* Override methods of parent classes */
481 GObjectClass *object_class = G_OBJECT_CLASS(klass);
482 object_class->set_property = chimara_glk_set_property;
483 object_class->get_property = chimara_glk_get_property;
484 object_class->finalize = chimara_glk_finalize;
486 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS(klass);
487 widget_class->size_request = chimara_glk_size_request;
488 widget_class->size_allocate = chimara_glk_size_allocate;
490 GtkContainerClass *container_class = GTK_CONTAINER_CLASS(klass);
491 container_class->forall = chimara_glk_forall;
494 klass->stopped = chimara_glk_stopped;
495 klass->started = chimara_glk_started;
497 * ChimaraGlk::stopped:
498 * @glk: The widget that received the signal
500 * The ::stopped signal is emitted when the a Glk program finishes
501 * executing in the widget, whether it ended normally, or was interrupted.
503 chimara_glk_signals[STOPPED] = g_signal_new("stopped",
504 G_OBJECT_CLASS_TYPE(klass), 0,
505 G_STRUCT_OFFSET(ChimaraGlkClass, stopped), NULL, NULL,
506 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
508 * ChimaraGlk::started:
509 * @glk: The widget that received the signal
511 * The ::started signal is emitted when a Glk program starts executing in
514 chimara_glk_signals[STARTED] = g_signal_new ("started",
515 G_OBJECT_CLASS_TYPE (klass), 0,
516 G_STRUCT_OFFSET(ChimaraGlkClass, started), NULL, NULL,
517 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
521 * ChimaraGlk:interactive:
523 * Sets whether the widget is interactive. A Glk widget is normally
524 * interactive, but in non-interactive mode, keyboard and mouse input are
525 * ignored and the Glk program is controlled by chimara_glk_feed_text().
526 * <quote>More</quote> prompts when a lot of text is printed to a text
527 * buffer are also disabled. This is typically used when you wish to control
528 * an interpreter program by feeding it a predefined list of commands.
530 g_object_class_install_property( object_class, PROP_INTERACTIVE,
531 g_param_spec_boolean("interactive", _("Interactive"),
532 _("Whether user input is expected in the Glk program"),
534 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
537 * ChimaraGlk:protect:
539 * Sets whether the Glk program is allowed to do file operations. In protect
540 * mode, all file operations will fail.
542 g_object_class_install_property(object_class, PROP_PROTECT,
543 g_param_spec_boolean("protect", _("Protected"),
544 _("Whether the Glk program is barred from doing file operations"),
546 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
548 /* We can't use G_PARAM_CONSTRUCT on these because then the constructor will
549 initialize them with NULL */
551 * ChimaraGlk:default-font-description:
553 * Pointer to a #PangoFontDescription describing the default proportional
554 * font, to be used in text buffer windows for example.
556 * Default value: font description created from the string
557 * <quote>Sans</quote>
559 g_object_class_install_property(object_class, PROP_DEFAULT_FONT_DESCRIPTION,
560 g_param_spec_pointer("default-font-description", _("Default Font"),
561 _("Font description of the default proportional font"),
562 G_PARAM_READWRITE | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
565 * ChimaraGlk:monospace-font-description:
567 * Pointer to a #PangoFontDescription describing the default monospace font,
568 * to be used in text grid windows and #style_Preformatted, for example.
570 * Default value: font description created from the string
571 * <quote>Monospace</quote>
573 g_object_class_install_property(object_class, PROP_MONOSPACE_FONT_DESCRIPTION,
574 g_param_spec_pointer("monospace-font-description", _("Monospace Font"),
575 _("Font description of the default monospace font"),
576 G_PARAM_READWRITE | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
579 * ChimaraGlk:spacing:
581 * The amount of space between the Glk windows.
583 g_object_class_install_property(object_class, PROP_SPACING,
584 g_param_spec_uint("spacing", _("Spacing"),
585 _("The amount of space between Glk windows"),
587 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
590 g_type_class_add_private(klass, sizeof(ChimaraGlkPrivate));
593 /* PUBLIC FUNCTIONS */
598 * Creates and initializes a new #ChimaraGlk widget.
600 * Return value: a #ChimaraGlk widget, with a floating reference.
603 chimara_glk_new(void)
605 ChimaraGlk *self = CHIMARA_GLK(g_object_new(CHIMARA_TYPE_GLK, NULL));
606 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(self);
608 priv->event_queue = g_queue_new();
609 priv->event_lock = g_mutex_new();
610 priv->event_queue_not_empty = g_cond_new();
611 priv->event_queue_not_full = g_cond_new();
612 priv->abort_lock = g_mutex_new();
614 return GTK_WIDGET(self);
618 * chimara_glk_set_interactive:
619 * @glk: a #ChimaraGlk widget
620 * @interactive: whether the widget should expect user input
622 * Sets the #ChimaraGlk:interactive property of @glk.
625 chimara_glk_set_interactive(ChimaraGlk *glk, gboolean interactive)
627 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
629 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
630 priv->interactive = interactive;
634 * chimara_glk_get_interactive:
635 * @glk: a #ChimaraGlk widget
637 * Returns whether @glk is interactive (expecting user input). See
638 * #ChimaraGlk:interactive.
640 * Return value: %TRUE if @glk is interactive.
643 chimara_glk_get_interactive(ChimaraGlk *glk)
645 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
647 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
648 return priv->interactive;
652 * chimara_glk_set_protect:
653 * @glk: a #ChimaraGlk widget
654 * @protect: whether the widget should allow the Glk program to do file
657 * Sets the #ChimaraGlk:protect property of @glk. In protect mode, the Glk
658 * program is not allowed to do file operations.
661 chimara_glk_set_protect(ChimaraGlk *glk, gboolean protect)
663 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
665 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
666 priv->protect = protect;
670 * chimara_glk_get_protect:
671 * @glk: a #ChimaraGlk widget
673 * Returns whether @glk is in protect mode (banned from doing file operations).
674 * See #ChimaraGlk:protect.
676 * Return value: %TRUE if @glk is in protect mode.
679 chimara_glk_get_protect(ChimaraGlk *glk)
681 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
683 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
684 return priv->protect;
688 * chimara_glk_set_default_font_description:
689 * @glk: a #ChimaraGlk widget
690 * @font: a #PangoFontDescription
692 * Sets @glk's default proportional font. See
693 * #ChimaraGlk:default-font-description.
696 chimara_glk_set_default_font_description(ChimaraGlk *glk, PangoFontDescription *font)
698 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
699 g_return_if_fail(font);
701 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
702 pango_font_description_free(priv->default_font_desc);
703 priv->default_font_desc = pango_font_description_copy(font);
705 /* TODO: Apply the font description to all the windows and recalculate the sizes */
709 * chimara_glk_set_default_font_string:
710 * @glk: a #ChimaraGlk widget
711 * @font: string representation of a font description
713 * Sets @glk's default proportional font according to the string @font, which
714 * must be a string in the form <quote><replaceable>FAMILY-LIST</replaceable>
715 * [<replaceable>STYLE-OPTIONS</replaceable>]
716 * [<replaceable>SIZE</replaceable>]</quote>, such as <quote>Charter,Utopia
717 * Italic 12</quote> or <quote>Sans</quote>. See
718 * #ChimaraGlk:default-font-description.
721 chimara_glk_set_default_font_string(ChimaraGlk *glk, const gchar *font)
723 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
724 g_return_if_fail(font || *font);
726 PangoFontDescription *fontdesc = pango_font_description_from_string(font);
727 g_return_if_fail(fontdesc);
729 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
730 pango_font_description_free(priv->default_font_desc);
731 priv->default_font_desc = fontdesc;
733 /* TODO: Apply the font description to all the windows and recalculate the sizes */
737 * chimara_glk_get_default_font_description:
738 * @glk: a #ChimaraGlk widget
740 * Returns @glk's default proportional font.
742 * Return value: a newly-allocated #PangoFontDescription which must be freed
743 * using pango_font_description_free(), or %NULL on error.
745 PangoFontDescription *
746 chimara_glk_get_default_font_description(ChimaraGlk *glk)
748 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), NULL);
750 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
751 return pango_font_description_copy(priv->default_font_desc);
755 * chimara_glk_set_monospace_font_description:
756 * @glk: a #ChimaraGlk widget
757 * @font: a #PangoFontDescription
759 * Sets @glk's default monospace font. See
760 * #ChimaraGlk:monospace-font-description.
763 chimara_glk_set_monospace_font_description(ChimaraGlk *glk, PangoFontDescription *font)
765 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
766 g_return_if_fail(font);
768 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
769 pango_font_description_free(priv->monospace_font_desc);
770 priv->monospace_font_desc = pango_font_description_copy(font);
772 /* TODO: Apply the font description to all the windows and recalculate the sizes */
776 * chimara_glk_set_monospace_font_string:
777 * @glk: a #ChimaraGlk widget
778 * @font: string representation of a font description
780 * Sets @glk's default monospace font according to the string @font, which must
781 * be a string in the form <quote><replaceable>FAMILY-LIST</replaceable>
782 * [<replaceable>STYLE-OPTIONS</replaceable>]
783 * [<replaceable>SIZE</replaceable>]</quote>, such as <quote>Courier
784 * Bold 12</quote> or <quote>Monospace</quote>. See
785 * #ChimaraGlk:monospace-font-description.
788 chimara_glk_set_monospace_font_string(ChimaraGlk *glk, const gchar *font)
790 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
791 g_return_if_fail(font || *font);
793 PangoFontDescription *fontdesc = pango_font_description_from_string(font);
794 g_return_if_fail(fontdesc);
796 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
797 pango_font_description_free(priv->monospace_font_desc);
798 priv->monospace_font_desc = fontdesc;
800 /* TODO: Apply the font description to all the windows and recalculate the sizes */
804 * chimara_glk_get_monospace_font_description:
805 * @glk: a #ChimaraGlk widget
807 * Returns @glk's default monospace font.
809 * Return value: a newly-allocated #PangoFontDescription which must be freed
810 * using pango_font_description_free(), or %NULL on error.
812 PangoFontDescription *
813 chimara_glk_get_monospace_font_description(ChimaraGlk *glk)
815 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), NULL);
817 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
818 return pango_font_description_copy(priv->monospace_font_desc);
822 * chimara_glk_set_spacing:
823 * @glk: a #ChimaraGlk widget
824 * @spacing: the number of pixels to put between Glk windows
826 * Sets the #ChimaraGlk:spacing property of @glk, which is the border width in
827 * pixels between Glk windows.
830 chimara_glk_set_spacing(ChimaraGlk *glk, guint spacing)
832 g_return_if_fail( glk || CHIMARA_IS_GLK(glk) );
834 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
835 priv->spacing = spacing;
839 * chimara_glk_get_spacing:
840 * @glk: a #ChimaraGlk widget
842 * Gets the value set by chimara_glk_set_spacing().
844 * Return value: pixels of spacing between Glk windows
847 chimara_glk_get_spacing(ChimaraGlk *glk)
849 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), 0);
851 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
852 return priv->spacing;
855 /* glk_enter() is the actual function called in the new thread in which glk_main() runs. */
857 glk_enter(gpointer glk_main)
859 extern ChimaraGlkPrivate *glk_data;
860 g_signal_emit_by_name(glk_data->self, "started");
861 ((glk_main_t)glk_main)();
862 g_signal_emit_by_name(glk_data->self, "stopped");
868 * @glk: a #ChimaraGlk widget
869 * @plugin: path to a plugin module compiled with <filename
870 * class="header">glk.h</filename>
871 * @error: location to store a <link linkend="glib-GError">GError</link>, or
874 * Opens a Glk program compiled as a plugin and runs its glk_main() function in
875 * a separate thread. On failure, returns %FALSE and sets @error.
877 * Return value: %TRUE if the Glk program was started successfully.
880 chimara_glk_run(ChimaraGlk *glk, gchar *plugin, GError **error)
882 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
883 g_return_val_if_fail(plugin, FALSE);
885 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
887 /* Open the module to run */
889 g_assert( g_module_supported() );
890 priv->program = g_module_open(plugin, G_MODULE_BIND_LAZY);
894 g_warning( "Error opening module: %s", g_module_error() );
897 if( !g_module_symbol(priv->program, "glk_main", (gpointer *) &glk_main) )
899 g_warning( "Error finding glk_main(): %s", g_module_error() );
903 extern ChimaraGlkPrivate *glk_data;
904 /* Set the thread's private data */
905 /* TODO: Do this with a GPrivate */
908 /* Run in a separate thread */
909 priv->thread = g_thread_create(glk_enter, glk_main, TRUE, error);
911 return !(priv->thread == NULL);
916 * @glk: a #ChimaraGlk widget
918 * Signals the Glk program running in @glk to abort. Note that if the program is
919 * caught in an infinite loop in which glk_tick() is not called, this may not
923 chimara_glk_stop(ChimaraGlk *glk)
925 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
926 /* TODO: check if glk is actually running a program */
932 * @glk: a #ChimaraGlk widget
934 * Holds up the main thread and waits for the Glk program running in @glk to
938 chimara_glk_wait(ChimaraGlk *glk)
940 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
942 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
943 g_thread_join(priv->thread);