1 /* licensing and copyright information here */
6 #include <glib/gi18n-lib.h>
8 #include <pango/pango.h>
9 #include "chimara-glk.h"
10 #include "chimara-glk-private.h"
11 #include "chimara-marshallers.h"
19 #define CHIMARA_GLK_MIN_WIDTH 0
20 #define CHIMARA_GLK_MIN_HEIGHT 0
24 * @short_description: Widget which executes a Glk program
25 * @stability: Unstable
26 * @include: chimara/chimara-glk.h
28 * The #ChimaraGlk widget opens and runs a Glk program. The program must be
29 * compiled as a plugin module, with a function <function>glk_main()</function>
30 * that the Glk library can hook into.
32 * On Linux systems, this is a file with a name like
33 * <filename>plugin.so</filename>. For portability, you can use libtool and
36 * pkglib_LTLIBRARIES = plugin.la
37 * plugin_la_SOURCES = plugin.c foo.c bar.c
38 * plugin_la_LDFLAGS = -module -shared -avoid-version -export-symbols-regex "^glk_main$$"
40 * This will produce <filename>plugin.la</filename> which is a text file
41 * containing the correct plugin file to open (see the relevant section of the
43 * url="http://www.gnu.org/software/libtool/manual/html_node/Finding-the-dlname.html">
44 * Libtool manual</ulink>).
47 typedef void (* glk_main_t) (void);
48 typedef int (* glkunix_startup_code_t) (glkunix_startup_t*);
54 PROP_DEFAULT_FONT_DESCRIPTION,
55 PROP_MONOSPACE_FONT_DESCRIPTION,
70 static guint chimara_glk_signals[LAST_SIGNAL] = { 0 };
72 G_DEFINE_TYPE(ChimaraGlk, chimara_glk, GTK_TYPE_CONTAINER);
75 chimara_glk_init(ChimaraGlk *self)
77 GTK_WIDGET_SET_FLAGS(GTK_WIDGET(self), GTK_NO_WINDOW);
79 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(self);
82 priv->interactive = TRUE;
83 priv->protect = FALSE;
84 priv->default_font_desc = pango_font_description_from_string("Sans");
85 priv->monospace_font_desc = pango_font_description_from_string("Monospace");
86 priv->css_file = "style.css";
87 priv->default_styles = g_new0(StyleSet,1);
88 priv->current_styles = g_new0(StyleSet,1);
89 priv->running = FALSE;
92 priv->event_queue = g_queue_new();
93 priv->event_lock = g_mutex_new();
94 priv->event_queue_not_empty = g_cond_new();
95 priv->event_queue_not_full = g_cond_new();
96 priv->abort_lock = g_mutex_new();
97 priv->abort_signalled = FALSE;
98 priv->arrange_lock = g_mutex_new();
99 priv->rearranged = g_cond_new();
100 priv->needs_rearrange = FALSE;
101 priv->ignore_next_arrange_event = FALSE;
102 priv->char_input_queue = g_async_queue_new();
103 priv->line_input_queue = g_async_queue_new();
104 /* Should be g_async_queue_new_full(g_free); but only in GTK >= 2.16 */
105 priv->interrupt_handler = NULL;
106 priv->root_window = NULL;
107 priv->fileref_list = NULL;
108 priv->current_stream = NULL;
109 priv->stream_list = NULL;
111 priv->in_startup = FALSE;
112 priv->current_dir = NULL;
116 chimara_glk_set_property(GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
118 ChimaraGlk *glk = CHIMARA_GLK(object);
122 case PROP_INTERACTIVE:
123 chimara_glk_set_interactive( glk, g_value_get_boolean(value) );
126 chimara_glk_set_protect( glk, g_value_get_boolean(value) );
128 case PROP_DEFAULT_FONT_DESCRIPTION:
129 chimara_glk_set_default_font_description( glk, (PangoFontDescription *)g_value_get_pointer(value) );
131 case PROP_MONOSPACE_FONT_DESCRIPTION:
132 chimara_glk_set_monospace_font_description( glk, (PangoFontDescription *)g_value_get_pointer(value) );
135 chimara_glk_set_spacing( glk, g_value_get_uint(value) );
138 G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
143 chimara_glk_get_property(GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
145 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(object);
149 case PROP_INTERACTIVE:
150 g_value_set_boolean(value, priv->interactive);
153 g_value_set_boolean(value, priv->protect);
155 case PROP_DEFAULT_FONT_DESCRIPTION:
156 g_value_set_pointer(value, priv->default_font_desc);
158 case PROP_MONOSPACE_FONT_DESCRIPTION:
159 g_value_set_pointer(value, priv->monospace_font_desc);
162 g_value_set_uint(value, priv->spacing);
165 G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
170 chimara_glk_finalize(GObject *object)
172 ChimaraGlk *self = CHIMARA_GLK(object);
173 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(self);
175 /* Free the event queue */
176 g_mutex_lock(priv->event_lock);
177 g_queue_foreach(priv->event_queue, (GFunc)g_free, NULL);
178 g_queue_free(priv->event_queue);
179 g_cond_free(priv->event_queue_not_empty);
180 g_cond_free(priv->event_queue_not_full);
181 priv->event_queue = NULL;
182 g_mutex_unlock(priv->event_lock);
183 g_mutex_free(priv->event_lock);
185 /* Free the abort signaling mechanism */
186 g_mutex_lock(priv->abort_lock);
187 /* Make sure no other thread is busy with this */
188 g_mutex_unlock(priv->abort_lock);
189 g_mutex_free(priv->abort_lock);
190 priv->abort_lock = NULL;
192 /* Free the window arrangement signaling */
193 g_mutex_lock(priv->arrange_lock);
194 g_cond_free(priv->rearranged);
195 g_mutex_unlock(priv->arrange_lock);
196 g_mutex_free(priv->arrange_lock);
197 priv->arrange_lock = NULL;
199 /* Unref input queues */
200 g_async_queue_unref(priv->char_input_queue);
201 g_async_queue_unref(priv->line_input_queue);
203 /* Free private data */
204 pango_font_description_free(priv->default_font_desc);
205 pango_font_description_free(priv->monospace_font_desc);
206 g_free(priv->current_dir);
207 g_hash_table_destroy(priv->default_styles->text_buffer);
208 g_hash_table_destroy(priv->default_styles->text_grid);
209 g_hash_table_destroy(priv->current_styles->text_buffer);
210 g_hash_table_destroy(priv->current_styles->text_grid);
212 G_OBJECT_CLASS(chimara_glk_parent_class)->finalize(object);
215 /* Internal function: Recursively get the Glk window tree's size request */
217 request_recurse(winid_t win, GtkRequisition *requisition, guint spacing)
219 if(win->type == wintype_Pair)
221 /* Get children's size requests */
222 GtkRequisition child1, child2;
223 request_recurse(win->window_node->children->data, &child1, spacing);
224 request_recurse(win->window_node->children->next->data, &child2, spacing);
226 glui32 division = win->split_method & winmethod_DivisionMask;
227 glui32 direction = win->split_method & winmethod_DirMask;
229 /* If the split is fixed, get the size of the fixed child */
230 if(division == winmethod_Fixed)
235 child1.width = win->key_window?
236 win->constraint_size * win->key_window->unit_width
239 case winmethod_Right:
240 child2.width = win->key_window?
241 win->constraint_size * win->key_window->unit_width
244 case winmethod_Above:
245 child1.height = win->key_window?
246 win->constraint_size * win->key_window->unit_height
249 case winmethod_Below:
250 child2.height = win->key_window?
251 win->constraint_size * win->key_window->unit_height
257 /* Add the children's requests */
261 case winmethod_Right:
262 requisition->width = child1.width + child2.width + spacing;
263 requisition->height = MAX(child1.height, child2.height);
265 case winmethod_Above:
266 case winmethod_Below:
267 requisition->width = MAX(child1.width, child2.width);
268 requisition->height = child1.height + child2.height + spacing;
273 /* For non-pair windows, just use the size that GTK requests */
275 gtk_widget_size_request(win->frame, requisition);
278 /* Overrides gtk_widget_size_request */
280 chimara_glk_size_request(GtkWidget *widget, GtkRequisition *requisition)
282 g_return_if_fail(widget);
283 g_return_if_fail(requisition);
284 g_return_if_fail(CHIMARA_IS_GLK(widget));
286 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(widget);
288 /* For now, just pass the size request on to the root Glk window */
289 if(priv->root_window)
291 request_recurse(priv->root_window->data, requisition, priv->spacing);
292 requisition->width += 2 * GTK_CONTAINER(widget)->border_width;
293 requisition->height += 2 * GTK_CONTAINER(widget)->border_width;
297 requisition->width = CHIMARA_GLK_MIN_WIDTH + 2 * GTK_CONTAINER(widget)->border_width;
298 requisition->height = CHIMARA_GLK_MIN_HEIGHT + 2 * GTK_CONTAINER(widget)->border_width;
302 /* Recursively give the Glk windows their allocated space. Returns a window
303 containing all children of this window that must be redrawn, or NULL if there
304 are no children that require redrawing. */
306 allocate_recurse(winid_t win, GtkAllocation *allocation, guint spacing)
308 if(win->type == wintype_Pair)
310 glui32 division = win->split_method & winmethod_DivisionMask;
311 glui32 direction = win->split_method & winmethod_DirMask;
313 /* If the space gets too small to honor the spacing property, then just
314 ignore spacing in this window and below. */
315 if( (spacing > allocation->width && (direction == winmethod_Left || direction == winmethod_Right))
316 || (spacing > allocation->height && (direction == winmethod_Above || direction == winmethod_Below)) )
319 GtkAllocation child1, child2;
320 child1.x = allocation->x;
321 child1.y = allocation->y;
323 if(division == winmethod_Fixed)
325 /* If the key window has been closed, then default to 0; otherwise
326 use the key window to determine the size */
330 child1.width = win->key_window?
331 CLAMP(win->constraint_size * win->key_window->unit_width, 0, allocation->width - spacing)
334 case winmethod_Right:
335 child2.width = win->key_window?
336 CLAMP(win->constraint_size * win->key_window->unit_width, 0, allocation->width - spacing)
339 case winmethod_Above:
340 child1.height = win->key_window?
341 CLAMP(win->constraint_size * win->key_window->unit_height, 0, allocation->height - spacing)
344 case winmethod_Below:
345 child2.height = win->key_window?
346 CLAMP(win->constraint_size * win->key_window->unit_height, 0, allocation->height - spacing)
351 else /* proportional */
353 gdouble fraction = win->constraint_size / 100.0;
357 child1.width = MAX(0, (gint)ceil(fraction * (allocation->width - spacing)) );
359 case winmethod_Right:
360 child2.width = MAX(0, (gint)ceil(fraction * (allocation->width - spacing)) );
362 case winmethod_Above:
363 child1.height = MAX(0, (gint)ceil(fraction * (allocation->height - spacing)) );
365 case winmethod_Below:
366 child2.height = MAX(0, (gint)ceil(fraction * (allocation->height - spacing)) );
371 /* Fill in the rest of the size requisitions according to the child specified above */
375 child2.width = MAX(0, allocation->width - spacing - child1.width);
376 child2.x = child1.x + child1.width + spacing;
378 child1.height = child2.height = allocation->height;
380 case winmethod_Right:
381 child1.width = MAX(0, allocation->width - spacing - child2.width);
382 child2.x = child1.x + child1.width + spacing;
384 child1.height = child2.height = allocation->height;
386 case winmethod_Above:
387 child2.height = MAX(0, allocation->height - spacing - child1.height);
389 child2.y = child1.y + child1.height + spacing;
390 child1.width = child2.width = allocation->width;
392 case winmethod_Below:
393 child1.height = MAX(0, allocation->height - spacing - child2.height);
395 child2.y = child1.y + child1.height + spacing;
396 child1.width = child2.width = allocation->width;
401 winid_t arrange1 = allocate_recurse(win->window_node->children->data, &child1, spacing);
402 winid_t arrange2 = allocate_recurse(win->window_node->children->next->data, &child2, spacing);
410 else if(win->type == wintype_TextGrid)
412 /* Pass the size allocation on to the framing widget */
413 gtk_widget_size_allocate(win->frame, allocation);
414 /* It says in the spec that when a text grid window is resized smaller,
415 the bottom or right area is thrown away; when it is resized larger, the
416 bottom or right area is filled with blanks. */
417 glui32 newwidth = (glui32)(win->widget->allocation.width / win->unit_width);
418 glui32 newheight = (glui32)(win->widget->allocation.height / win->unit_height);
420 GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
421 GtkTextIter start, end;
423 for(line = 0; line < win->height; line++)
425 gtk_text_buffer_get_iter_at_line(textbuffer, &start, line);
426 /* If this line is going to fall off the bottom, delete it */
427 if(line >= newheight)
430 gtk_text_iter_forward_to_line_end(&end);
431 gtk_text_iter_forward_char(&end);
432 gtk_text_buffer_delete(textbuffer, &start, &end);
435 /* If this line is not long enough, add spaces on the end */
436 if(newwidth > win->width)
438 gchar *spaces = g_strnfill(newwidth - win->width, ' ');
439 gtk_text_iter_forward_to_line_end(&start);
440 gtk_text_buffer_insert(textbuffer, &start, spaces, -1);
443 /* But if it's too long, delete characters from the end */
444 else if(newwidth < win->width)
447 gtk_text_iter_forward_chars(&start, newwidth);
448 gtk_text_iter_forward_to_line_end(&end);
449 gtk_text_buffer_delete(textbuffer, &start, &end);
451 /* Note: if the widths are equal, do nothing */
453 /* Add blank lines if there aren't enough lines to fit the new size */
454 if(newheight > win->height)
456 gchar *blanks = g_strnfill(win->width, ' ');
457 gchar **blanklines = g_new0(gchar *, (newheight - win->height) + 1);
459 for(count = 0; count < newheight - win->height; count++)
460 blanklines[count] = blanks;
461 blanklines[newheight - win->height] = NULL;
462 gchar *text = g_strjoinv("\n", blanklines);
463 g_free(blanklines); /* not g_strfreev() */
466 gtk_text_buffer_get_end_iter(textbuffer, &start);
467 gtk_text_buffer_insert(textbuffer, &start, "\n", -1);
468 gtk_text_buffer_insert(textbuffer, &start, text, -1);
472 gboolean arrange = !(win->width == newwidth && win->height == newheight);
473 win->width = newwidth;
474 win->height = newheight;
475 return arrange? win : NULL;
478 /* For non-pair, non-text-grid windows, just give them the size */
479 gtk_widget_size_allocate(win->frame, allocation);
483 /* Overrides gtk_widget_size_allocate */
485 chimara_glk_size_allocate(GtkWidget *widget, GtkAllocation *allocation)
487 g_return_if_fail(widget);
488 g_return_if_fail(allocation);
489 g_return_if_fail(CHIMARA_IS_GLK(widget));
491 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(widget);
493 widget->allocation = *allocation;
495 if(priv->root_window) {
497 child.x = allocation->x + GTK_CONTAINER(widget)->border_width;
498 child.y = allocation->y + GTK_CONTAINER(widget)->border_width;
499 child.width = CLAMP(allocation->width - 2 * GTK_CONTAINER(widget)->border_width, 0, allocation->width);
500 child.height = CLAMP(allocation->height - 2 * GTK_CONTAINER(widget)->border_width, 0, allocation->height);
501 winid_t arrange = allocate_recurse(priv->root_window->data, &child, priv->spacing);
503 /* arrange points to a window that contains all text grid and graphics
504 windows which have been resized */
505 g_mutex_lock(priv->arrange_lock);
506 if(!priv->ignore_next_arrange_event)
509 event_throw(CHIMARA_GLK(widget), evtype_Arrange, arrange == priv->root_window->data? NULL : arrange, 0, 0);
512 priv->ignore_next_arrange_event = FALSE;
513 priv->needs_rearrange = FALSE;
514 g_cond_signal(priv->rearranged);
515 g_mutex_unlock(priv->arrange_lock);
519 /* Recursively invoke callback() on the GtkWidget of each non-pair window in the tree */
521 forall_recurse(winid_t win, GtkCallback callback, gpointer callback_data)
523 if(win->type == wintype_Pair)
525 forall_recurse(win->window_node->children->data, callback, callback_data);
526 forall_recurse(win->window_node->children->next->data, callback, callback_data);
529 (*callback)(win->frame, callback_data);
532 /* Overrides gtk_container_forall */
534 chimara_glk_forall(GtkContainer *container, gboolean include_internals, GtkCallback callback, gpointer callback_data)
536 g_return_if_fail(container);
537 g_return_if_fail(CHIMARA_IS_GLK(container));
539 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(container);
541 /* All the children are "internal" */
542 if(!include_internals)
545 if(priv->root_window)
546 forall_recurse(priv->root_window->data, callback, callback_data);
550 chimara_glk_stopped(ChimaraGlk *self)
552 CHIMARA_GLK_USE_PRIVATE(self, priv);
553 priv->running = FALSE;
555 /* Free the plugin */
556 if( priv->program && !g_module_close(priv->program) )
557 g_warning( "Error closing module: %s", g_module_error() );
561 chimara_glk_started(ChimaraGlk *self)
563 CHIMARA_GLK_USE_PRIVATE(self, priv);
564 priv->running = TRUE;
568 chimara_glk_waiting(ChimaraGlk *self)
570 /* Default signal handler */
574 chimara_glk_char_input(ChimaraGlk *self, guint window_rock, guint keysym)
576 /* Default signal handler */
580 chimara_glk_line_input(ChimaraGlk *self, guint window_rock, gchar *text)
582 /* Default signal handler */
586 chimara_glk_text_buffer_output(ChimaraGlk *self, guint window_rock, gchar *text)
588 /* Default signal handler */
591 /* G_PARAM_STATIC_STRINGS only appeared in GTK 2.13.0 */
592 #ifndef G_PARAM_STATIC_STRINGS
593 #define G_PARAM_STATIC_STRINGS (G_PARAM_STATIC_NAME | G_PARAM_STATIC_NICK | G_PARAM_STATIC_BLURB)
597 chimara_glk_class_init(ChimaraGlkClass *klass)
599 /* Override methods of parent classes */
600 GObjectClass *object_class = G_OBJECT_CLASS(klass);
601 object_class->set_property = chimara_glk_set_property;
602 object_class->get_property = chimara_glk_get_property;
603 object_class->finalize = chimara_glk_finalize;
605 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS(klass);
606 widget_class->size_request = chimara_glk_size_request;
607 widget_class->size_allocate = chimara_glk_size_allocate;
609 GtkContainerClass *container_class = GTK_CONTAINER_CLASS(klass);
610 container_class->forall = chimara_glk_forall;
613 klass->stopped = chimara_glk_stopped;
614 klass->started = chimara_glk_started;
615 klass->waiting = chimara_glk_waiting;
616 klass->char_input = chimara_glk_char_input;
617 klass->line_input = chimara_glk_line_input;
618 klass->text_buffer_output = chimara_glk_text_buffer_output;
620 * ChimaraGlk::stopped:
621 * @glk: The widget that received the signal
623 * Emitted when the a Glk program finishes executing in the widget, whether
624 * it ended normally, or was interrupted.
626 chimara_glk_signals[STOPPED] = g_signal_new("stopped",
627 G_OBJECT_CLASS_TYPE(klass), 0,
628 /* FIXME: Should be G_SIGNAL_RUN_CLEANUP but that segfaults??! */
629 G_STRUCT_OFFSET(ChimaraGlkClass, stopped), NULL, NULL,
630 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
632 * ChimaraGlk::started:
633 * @glk: The widget that received the signal
635 * Emitted when a Glk program starts executing in the widget.
637 chimara_glk_signals[STARTED] = g_signal_new ("started",
638 G_OBJECT_CLASS_TYPE(klass), 0,
639 G_STRUCT_OFFSET(ChimaraGlkClass, started), NULL, NULL,
640 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
642 * ChimaraGlk::waiting:
643 * @glk: The widget that received the signal
645 * Emitted when glk_select() is called by the Glk program and the event
646 * queue is empty, which means that the widget is waiting for input.
648 chimara_glk_signals[WAITING] = g_signal_new("waiting",
649 G_OBJECT_CLASS_TYPE(klass), 0,
650 G_STRUCT_OFFSET(ChimaraGlkClass, waiting), NULL, NULL,
651 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
653 * ChimaraGlk::char-input:
654 * @glk: The widget that received the signal
655 * @window_rock: The rock value of the window that received character input
656 * (see <link linkend="chimara-Rocks">Rocks</link>)
657 * @keysym: The key that was typed, in the form of a key symbol from
658 * <filename class="headerfile">gdk/gdkkeysyms.h</filename>
660 * Emitted when a Glk window receives character input.
662 chimara_glk_signals[CHAR_INPUT] = g_signal_new("char-input",
663 G_OBJECT_CLASS_TYPE(klass), 0,
664 G_STRUCT_OFFSET(ChimaraGlkClass, char_input), NULL, NULL,
665 chimara_marshal_VOID__UINT_UINT,
666 G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_UINT);
668 * ChimaraGlk::line-input:
669 * @glk: The widget that received the signal
670 * @window_rock: The rock value of the window that received line input (see
671 * <link linkend="chimara-Rocks">Rocks</link>)
672 * @text: The text that was typed
674 * Emitted when a Glk window receives line input.
676 chimara_glk_signals[LINE_INPUT] = g_signal_new("line-input",
677 G_OBJECT_CLASS_TYPE(klass), 0,
678 G_STRUCT_OFFSET(ChimaraGlkClass, line_input), NULL, NULL,
679 chimara_marshal_VOID__UINT_STRING,
680 G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_STRING);
682 * ChimaraGlk::text-buffer-output:
683 * @glk: The widget that received the signal
684 * @window_rock: The rock value of the window that was printed to (see <link
685 * linkend="chimara-Rocks">Rocks</link>)
687 * Emitted when text is printed to a text buffer window.
689 chimara_glk_signals[TEXT_BUFFER_OUTPUT] = g_signal_new("text-buffer-output",
690 G_OBJECT_CLASS_TYPE(klass), 0,
691 G_STRUCT_OFFSET(ChimaraGlkClass, text_buffer_output), NULL, NULL,
692 chimara_marshal_VOID__UINT_STRING,
693 G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_STRING);
697 * ChimaraGlk:interactive:
699 * Sets whether the widget is interactive. A Glk widget is normally
700 * interactive, but in non-interactive mode, keyboard and mouse input are
701 * ignored and the Glk program is controlled by chimara_glk_feed_text().
702 * <quote>More</quote> prompts when a lot of text is printed to a text
703 * buffer are also disabled. This is typically used when you wish to control
704 * an interpreter program by feeding it a predefined list of commands.
706 g_object_class_install_property( object_class, PROP_INTERACTIVE,
707 g_param_spec_boolean("interactive", _("Interactive"),
708 _("Whether user input is expected in the Glk program"),
710 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
713 * ChimaraGlk:protect:
715 * Sets whether the Glk program is allowed to do file operations. In protect
716 * mode, all file operations will fail.
718 g_object_class_install_property(object_class, PROP_PROTECT,
719 g_param_spec_boolean("protect", _("Protected"),
720 _("Whether the Glk program is barred from doing file operations"),
722 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
724 /* We can't use G_PARAM_CONSTRUCT on these because then the constructor will
725 initialize them with NULL */
727 * ChimaraGlk:default-font-description:
729 * Pointer to a #PangoFontDescription describing the default proportional
730 * font, to be used in text buffer windows for example.
732 * Default value: font description created from the string
733 * <quote>Sans</quote>
735 g_object_class_install_property(object_class, PROP_DEFAULT_FONT_DESCRIPTION,
736 g_param_spec_pointer("default-font-description", _("Default Font"),
737 _("Font description of the default proportional font"),
738 G_PARAM_READWRITE | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
741 * ChimaraGlk:monospace-font-description:
743 * Pointer to a #PangoFontDescription describing the default monospace font,
744 * to be used in text grid windows and %style_Preformatted, for example.
746 * Default value: font description created from the string
747 * <quote>Monospace</quote>
749 g_object_class_install_property(object_class, PROP_MONOSPACE_FONT_DESCRIPTION,
750 g_param_spec_pointer("monospace-font-description", _("Monospace Font"),
751 _("Font description of the default monospace font"),
752 G_PARAM_READWRITE | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
755 * ChimaraGlk:spacing:
757 * The amount of space between the Glk windows.
759 g_object_class_install_property(object_class, PROP_SPACING,
760 g_param_spec_uint("spacing", _("Spacing"),
761 _("The amount of space between Glk windows"),
763 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS) );
766 g_type_class_add_private(klass, sizeof(ChimaraGlkPrivate));
769 /* PUBLIC FUNCTIONS */
772 * chimara_error_quark:
774 * The error domain for errors from Chimara widgets.
776 * Returns: The string <quote>chimara-error-quark</quote> as a <link
777 * linkend="GQuark">GQuark</link>.
780 chimara_error_quark(void)
782 chimara_init(); /* This is a library entry point */
783 return g_quark_from_static_string("chimara-error-quark");
789 * Creates and initializes a new #ChimaraGlk widget.
791 * Return value: a #ChimaraGlk widget, with a floating reference.
794 chimara_glk_new(void)
796 /* This is a library entry point; initialize the library */
799 return GTK_WIDGET(g_object_new(CHIMARA_TYPE_GLK, NULL));
803 * chimara_glk_set_interactive:
804 * @glk: a #ChimaraGlk widget
805 * @interactive: whether the widget should expect user input
807 * Sets the #ChimaraGlk:interactive property of @glk.
810 chimara_glk_set_interactive(ChimaraGlk *glk, gboolean interactive)
812 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
814 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
815 priv->interactive = interactive;
819 * chimara_glk_get_interactive:
820 * @glk: a #ChimaraGlk widget
822 * Returns whether @glk is interactive (expecting user input). See
823 * #ChimaraGlk:interactive.
825 * Return value: %TRUE if @glk is interactive.
828 chimara_glk_get_interactive(ChimaraGlk *glk)
830 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
832 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
833 return priv->interactive;
837 * chimara_glk_set_protect:
838 * @glk: a #ChimaraGlk widget
839 * @protect: whether the widget should allow the Glk program to do file
842 * Sets the #ChimaraGlk:protect property of @glk. In protect mode, the Glk
843 * program is not allowed to do file operations.
846 chimara_glk_set_protect(ChimaraGlk *glk, gboolean protect)
848 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
850 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
851 priv->protect = protect;
855 * chimara_glk_get_protect:
856 * @glk: a #ChimaraGlk widget
858 * Returns whether @glk is in protect mode (banned from doing file operations).
859 * See #ChimaraGlk:protect.
861 * Return value: %TRUE if @glk is in protect mode.
864 chimara_glk_get_protect(ChimaraGlk *glk)
866 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
868 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
869 return priv->protect;
873 * chimara_glk_set_default_font_description:
874 * @glk: a #ChimaraGlk widget
875 * @font: a #PangoFontDescription
877 * Sets @glk's default proportional font. See
878 * #ChimaraGlk:default-font-description.
881 chimara_glk_set_default_font_description(ChimaraGlk *glk, PangoFontDescription *font)
883 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
884 g_return_if_fail(font);
886 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
887 pango_font_description_free(priv->default_font_desc);
888 priv->default_font_desc = pango_font_description_copy(font);
890 /* TODO: Apply the font description to all the windows and recalculate the sizes */
894 * chimara_glk_set_default_font_string:
895 * @glk: a #ChimaraGlk widget
896 * @font: string representation of a font description
898 * Sets @glk's default proportional font according to the string @font, which
899 * must be a string in the form <quote><replaceable>FAMILY-LIST</replaceable>
900 * [<replaceable>STYLE-OPTIONS</replaceable>]
901 * [<replaceable>SIZE</replaceable>]</quote>, such as <quote>Charter,Utopia
902 * Italic 12</quote> or <quote>Sans</quote>. See
903 * #ChimaraGlk:default-font-description.
906 chimara_glk_set_default_font_string(ChimaraGlk *glk, const gchar *font)
908 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
909 g_return_if_fail(font || *font);
911 PangoFontDescription *fontdesc = pango_font_description_from_string(font);
912 g_return_if_fail(fontdesc);
914 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
915 pango_font_description_free(priv->default_font_desc);
916 priv->default_font_desc = fontdesc;
918 /* TODO: Apply the font description to all the windows and recalculate the sizes */
922 * chimara_glk_get_default_font_description:
923 * @glk: a #ChimaraGlk widget
925 * Returns @glk's default proportional font.
927 * Return value: a newly-allocated #PangoFontDescription which must be freed
928 * using pango_font_description_free(), or %NULL on error.
930 PangoFontDescription *
931 chimara_glk_get_default_font_description(ChimaraGlk *glk)
933 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), NULL);
935 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
936 return pango_font_description_copy(priv->default_font_desc);
940 * chimara_glk_set_monospace_font_description:
941 * @glk: a #ChimaraGlk widget
942 * @font: a #PangoFontDescription
944 * Sets @glk's default monospace font. See
945 * #ChimaraGlk:monospace-font-description.
948 chimara_glk_set_monospace_font_description(ChimaraGlk *glk, PangoFontDescription *font)
950 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
951 g_return_if_fail(font);
953 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
954 pango_font_description_free(priv->monospace_font_desc);
955 priv->monospace_font_desc = pango_font_description_copy(font);
957 /* TODO: Apply the font description to all the windows and recalculate the sizes */
961 * chimara_glk_set_monospace_font_string:
962 * @glk: a #ChimaraGlk widget
963 * @font: string representation of a font description
965 * Sets @glk's default monospace font according to the string @font, which must
966 * be a string in the form <quote><replaceable>FAMILY-LIST</replaceable>
967 * [<replaceable>STYLE-OPTIONS</replaceable>]
968 * [<replaceable>SIZE</replaceable>]</quote>, such as <quote>Courier
969 * Bold 12</quote> or <quote>Monospace</quote>. See
970 * #ChimaraGlk:monospace-font-description.
973 chimara_glk_set_monospace_font_string(ChimaraGlk *glk, const gchar *font)
975 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
976 g_return_if_fail(font || *font);
978 PangoFontDescription *fontdesc = pango_font_description_from_string(font);
979 g_return_if_fail(fontdesc);
981 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
982 pango_font_description_free(priv->monospace_font_desc);
983 priv->monospace_font_desc = fontdesc;
985 /* TODO: Apply the font description to all the windows and recalculate the sizes */
989 * chimara_glk_get_monospace_font_description:
990 * @glk: a #ChimaraGlk widget
992 * Returns @glk's default monospace font.
994 * Return value: a newly-allocated #PangoFontDescription which must be freed
995 * using pango_font_description_free(), or %NULL on error.
997 PangoFontDescription *
998 chimara_glk_get_monospace_font_description(ChimaraGlk *glk)
1000 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), NULL);
1002 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1003 return pango_font_description_copy(priv->monospace_font_desc);
1007 * chimara_glk_set_spacing:
1008 * @glk: a #ChimaraGlk widget
1009 * @spacing: the number of pixels to put between Glk windows
1011 * Sets the #ChimaraGlk:spacing property of @glk, which is the border width in
1012 * pixels between Glk windows.
1015 chimara_glk_set_spacing(ChimaraGlk *glk, guint spacing)
1017 g_return_if_fail( glk || CHIMARA_IS_GLK(glk) );
1019 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1020 priv->spacing = spacing;
1024 * chimara_glk_get_spacing:
1025 * @glk: a #ChimaraGlk widget
1027 * Gets the value set by chimara_glk_set_spacing().
1029 * Return value: pixels of spacing between Glk windows
1032 chimara_glk_get_spacing(ChimaraGlk *glk)
1034 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), 0);
1036 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1037 return priv->spacing;
1040 struct StartupData {
1041 glk_main_t glk_main;
1042 glkunix_startup_code_t glkunix_startup_code;
1043 glkunix_startup_t args;
1044 ChimaraGlkPrivate *glk_data;
1047 /* glk_enter() is the actual function called in the new thread in which glk_main() runs. */
1049 glk_enter(struct StartupData *startup)
1051 extern GPrivate *glk_data_key;
1052 g_private_set(glk_data_key, startup->glk_data);
1054 g_async_queue_ref(startup->glk_data->char_input_queue);
1055 g_async_queue_ref(startup->glk_data->line_input_queue);
1057 /* Run startup function */
1058 if(startup->glkunix_startup_code) {
1059 startup->glk_data->in_startup = TRUE;
1060 int result = startup->glkunix_startup_code(&startup->args);
1061 startup->glk_data->in_startup = FALSE;
1064 while(i < startup->args.argc)
1065 g_free(startup->args.argv[i++]);
1066 g_free(startup->args.argv);
1072 /* Run main function */
1073 g_signal_emit_by_name(startup->glk_data->self, "started");
1074 (startup->glk_main)();
1075 g_signal_emit_by_name(startup->glk_data->self, "stopped");
1076 g_slice_free(struct StartupData, startup);
1082 * @glk: a #ChimaraGlk widget
1083 * @plugin: path to a plugin module compiled with <filename
1084 * class="header">glk.h</filename>
1085 * @argc: Number of command line arguments in @argv
1086 * @argv: Array of command line arguments to pass to the plugin
1087 * @error: location to store a <link linkend="glib-GError">GError</link>, or
1090 * Opens a Glk program compiled as a plugin. Sorts out its command line
1091 * arguments from #glkunix_arguments, calls its startup function
1092 * glkunix_startup_code(), and then calls its main function glk_main() in
1093 * a separate thread. On failure, returns %FALSE and sets @error.
1095 * The plugin must at least export a glk_main() function; #glkunix_arguments and
1096 * glkunix_startup_code() are optional.
1098 * Return value: %TRUE if the Glk program was started successfully.
1101 chimara_glk_run(ChimaraGlk *glk, const gchar *plugin, int argc, char *argv[], GError **error)
1103 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1104 g_return_val_if_fail(plugin, FALSE);
1106 ChimaraGlkPrivate *priv = CHIMARA_GLK_PRIVATE(glk);
1107 struct StartupData *startup = g_slice_new0(struct StartupData);
1109 /* Open the module to run */
1110 g_assert( g_module_supported() );
1111 priv->program = g_module_open(plugin, G_MODULE_BIND_LAZY);
1115 g_set_error(error, CHIMARA_ERROR, CHIMARA_LOAD_MODULE_ERROR, _("Error opening module: %s"), g_module_error());
1118 if( !g_module_symbol(priv->program, "glk_main", (gpointer *) &startup->glk_main) )
1120 g_set_error(error, CHIMARA_ERROR, CHIMARA_NO_GLK_MAIN, _("Error finding glk_main(): %s"), g_module_error());
1124 if( g_module_symbol(priv->program, "glkunix_startup_code", (gpointer *) &startup->glkunix_startup_code) )
1126 glkunix_argumentlist_t *glkunix_arguments;
1128 if( !(g_module_symbol(priv->program, "glkunix_arguments", (gpointer *) &glkunix_arguments)
1129 && parse_command_line(glkunix_arguments, argc, argv, &startup->args)) )
1131 /* arguments could not be parsed, so create data ourselves */
1132 startup->args.argc = 1;
1133 startup->args.argv = g_new0(gchar *, 1);
1136 /* Set the program name */
1137 startup->args.argv[0] = g_strdup(plugin);
1139 startup->glk_data = priv;
1141 /* Run in a separate thread */
1142 priv->thread = g_thread_create((GThreadFunc)glk_enter, startup, TRUE, error);
1144 return !(priv->thread == NULL);
1149 * @glk: a #ChimaraGlk widget
1151 * Signals the Glk program running in @glk to abort. Note that if the program is
1152 * caught in an infinite loop in which glk_tick() is not called, this may not
1156 chimara_glk_stop(ChimaraGlk *glk)
1158 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1159 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1160 /* Don't do anything if not running a program */
1164 if(priv->abort_lock) {
1165 g_mutex_lock(priv->abort_lock);
1166 priv->abort_signalled = TRUE;
1167 g_mutex_unlock(priv->abort_lock);
1168 /* Stop blocking on the event queue condition */
1169 event_throw(glk, evtype_Abort, NULL, 0, 0);
1175 * @glk: a #ChimaraGlk widget
1177 * Holds up the main thread and waits for the Glk program running in @glk to
1181 chimara_glk_wait(ChimaraGlk *glk)
1183 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1184 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1185 /* Don't do anything if not running a program */
1188 g_thread_join(priv->thread);
1192 * chimara_glk_get_running:
1193 * @glk: a #ChimaraGlk widget
1195 * Use this function to tell whether a program is currently running in the
1198 * Returns: %TRUE if @glk is executing a Glk program, %FALSE otherwise.
1201 chimara_glk_get_running(ChimaraGlk *glk)
1203 g_return_val_if_fail(glk || CHIMARA_IS_GLK(glk), FALSE);
1204 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1205 return priv->running;
1209 * chimara_glk_feed_char_input:
1210 * @glk: a #ChimaraGlk widget
1211 * @keyval: a key symbol as defined in <filename
1212 * class="headerfile">gdk/gdkkeysyms.h</filename>
1214 * Pretend that a key was pressed in the Glk program as a response to a
1215 * character input request. You can call this function even when no window has
1216 * requested character input, in which case the key will be saved for the
1217 * following window that requests character input. This has the disadvantage
1218 * that if more than one window has requested character input, it is arbitrary
1219 * which one gets the key press.
1222 chimara_glk_feed_char_input(ChimaraGlk *glk, guint keyval)
1224 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1225 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1226 g_async_queue_push(priv->char_input_queue, GUINT_TO_POINTER(keyval));
1227 event_throw(glk, evtype_ForcedCharInput, NULL, 0, 0);
1231 * chimara_glk_feed_line_input:
1232 * @glk: a #ChimaraGlk widget
1233 * @text: text to pass to the next line input request
1235 * Pretend that @text was typed in the Glk program as a response to a line input
1236 * request. @text does not need to end with a newline. You can call this
1237 * function even when no window has requested line input, in which case the text
1238 * will be saved for the following window that requests line input. This has the
1239 * disadvantage that if more than one window has requested character input, it
1240 * is arbitrary which one gets the text.
1243 chimara_glk_feed_line_input(ChimaraGlk *glk, const gchar *text)
1245 g_return_if_fail(glk || CHIMARA_IS_GLK(glk));
1246 g_return_if_fail(text);
1247 CHIMARA_GLK_USE_PRIVATE(glk, priv);
1248 g_async_queue_push(priv->line_input_queue, g_strdup(text));
1249 event_throw(glk, evtype_ForcedLineInput, NULL, 0, 0);