4 #include "chimara-glk-private.h"
8 extern GPrivate glk_data_key;
11 window_new_common(glui32 rock)
13 ChimaraGlkPrivate *glk_data = g_private_get(&glk_data_key);
14 winid_t win = g_new0(struct glk_window_struct, 1);
16 win->magic = MAGIC_WINDOW;
18 win->librock = g_strdup_printf("%p", win);
19 if(glk_data->register_obj)
20 win->disprock = (*glk_data->register_obj)(win, gidisp_Class_Window);
22 win->window_node = g_node_new(win);
24 /* Every window has a window stream, but printing to it might have no effect */
25 win->window_stream = stream_new_common(0);
26 win->window_stream->file_mode = filemode_Write;
27 win->window_stream->type = STREAM_TYPE_WINDOW;
28 win->window_stream->window = win;
29 win->window_stream->style = "normal";
30 win->window_stream->glk_style = "normal";
32 win->echo_stream = NULL;
33 win->input_request_type = INPUT_REQUEST_NONE;
34 win->line_input_buffer = NULL;
35 win->line_input_buffer_unicode = NULL;
37 win->echo_line_input = TRUE;
38 win->echo_current_line_input = TRUE;
39 win->extra_line_terminators = NULL;
40 win->current_extra_line_terminators = NULL;
42 /* Initialise the buffer */
43 win->buffer = g_string_sized_new(1024);
45 /* Initialise hyperlink table */
46 win->hyperlinks = g_hash_table_new_full(g_int_hash, g_int_equal, g_free, g_free);
51 /* Internal function: do all the stuff necessary to close a window. Call only
54 window_close_common(winid_t win, gboolean destroy_node)
56 ChimaraGlkPrivate *glk_data = g_private_get(&glk_data_key);
58 if(glk_data->unregister_obj)
60 (*glk_data->unregister_obj)(win, gidisp_Class_Window, win->disprock);
61 win->disprock.ptr = NULL;
65 g_node_destroy(win->window_node);
67 win->magic = MAGIC_FREE;
70 g_list_foreach(win->history, (GFunc)g_free, NULL);
71 g_list_free(win->history);
72 g_slist_free(win->extra_line_terminators);
73 g_slist_free(win->current_extra_line_terminators);
75 g_string_free(win->buffer, TRUE);
76 g_hash_table_destroy(win->hyperlinks);
77 g_free(win->current_hyperlink);
79 if(win->backing_store)
80 cairo_surface_destroy(win->backing_store);
87 * @win: A window, or %NULL.
88 * @rockptr: Return location for the next window's rock, or %NULL.
90 * This function can be used to iterate through the list of all open windows
91 * (including pair windows.) See <link
92 * linkend="chimara-Iterating-Through-Opaque-Objects">Iterating Through Opaque
95 * As that section describes, the order in which windows are returned is
96 * arbitrary. The root window is not necessarily first, nor is it necessarily
99 * Returns: the next window, or %NULL if there are no more.
102 glk_window_iterate(winid_t win, glui32 *rockptr)
104 VALID_WINDOW_OR_NULL(win, return NULL);
106 ChimaraGlkPrivate *glk_data = g_private_get(&glk_data_key);
110 retnode = glk_data->root_window;
113 GNode *node = win->window_node;
114 if( G_NODE_IS_LEAF(node) )
116 while(node && node->next == NULL)
119 retnode = node->next;
124 retnode = g_node_first_child(node);
126 winid_t retval = retnode? (winid_t)retnode->data : NULL;
128 /* Store the window's rock in rockptr */
129 if(retval && rockptr)
130 *rockptr = glk_window_get_rock(retval);
136 * glk_window_get_rock:
139 * Returns @win's rock value. Pair windows always have rock 0; all other windows
140 * return whatever rock value you created them with.
142 * Returns: A rock value.
145 glk_window_get_rock(winid_t win)
147 VALID_WINDOW(win, return 0);
152 * glk_window_get_type:
155 * Returns @win's type, one of %wintype_Blank, %wintype_Pair,
156 * %wintype_TextBuffer, %wintype_TextGrid, or %wintype_Graphics.
158 * Returns: The window's type.
161 glk_window_get_type(winid_t win)
163 VALID_WINDOW(win, return 0);
168 * glk_window_get_parent:
171 * Returns the window which is the parent of @win. If @win is the root window,
172 * this returns %NULL, since the root window has no parent. Remember that the
173 * parent of every window is a pair window; other window types are always
176 * Returns: A window, or %NULL.
179 glk_window_get_parent(winid_t win)
181 VALID_WINDOW(win, return NULL);
183 /* Value will also be NULL if win is the root window */
184 if(win->window_node->parent == NULL)
187 return (winid_t)win->window_node->parent->data;
191 * glk_window_get_sibling:
194 * Returns the other child of @win's parent. If @win is the root window, this
197 * Returns: A window, or %NULL.
200 glk_window_get_sibling(winid_t win)
202 VALID_WINDOW(win, return NULL);
204 if(G_NODE_IS_ROOT(win->window_node))
206 if(win->window_node->next)
207 return (winid_t)win->window_node->next->data;
208 return (winid_t)win->window_node->prev->data;
212 * glk_window_get_root:
214 * Returns the root window. If there are no windows, this returns %NULL.
216 * Returns: A window, or %NULL.
219 glk_window_get_root()
221 ChimaraGlkPrivate *glk_data = g_private_get(&glk_data_key);
222 if(glk_data->root_window == NULL)
224 return (winid_t)glk_data->root_window->data;
229 * @split: The window to split to create the new window. Must be 0 if there
230 * are no windows yet.
231 * @method: Position of the new window and method of size computation. One of
232 * %winmethod_Above, %winmethod_Below, %winmethod_Left, or %winmethod_Right
233 * OR'ed with %winmethod_Fixed or %winmethod_Proportional. If @wintype is
234 * %wintype_Blank, then %winmethod_Fixed is not allowed. May also be OR'ed with
235 * %winmethod_Border or %winmethod_NoBorder.
236 * @size: Size of the new window, in percentage points if @method is
237 * %winmethod_Proportional, otherwise in characters if @wintype is
238 * %wintype_TextBuffer or %wintype_TextGrid, or pixels if @wintype is
240 * @wintype: Type of the new window. One of %wintype_Blank, %wintype_TextGrid,
241 * %wintype_TextBuffer, or %wintype_Graphics.
242 * @rock: The new window's rock value.
244 * Creates a new window. If there are no windows, the first three arguments are
245 * meaningless. @split <emphasis>must</emphasis> be 0, and @method and @size
246 * are ignored. @wintype is the type of window you're creating, and @rock is
247 * the rock (see <link linkend="chimara-Rocks">Rocks</link>).
249 * If any windows exist, new windows must be created by splitting existing
250 * ones. @split is the window you want to split; this <emphasis>must
251 * not</emphasis> be zero. @method specifies the direction and the split method
252 * (see below). @size is the size of the split. @wintype is the type of window
253 * you're creating, and @rock is the rock.
255 * The method argument must be the logical-or of a direction constant
256 * (%winmethod_Above, %winmethod_Below, %winmethod_Left, %winmethod_Right) and a
257 * split-method constant (%winmethod_Fixed, %winmethod_Proportional).
259 * Remember that it is possible that the library will be unable to create a new
260 * window, in which case glk_window_open() will return %NULL.
263 * It is acceptable to gracefully exit, if the window you are creating is an
264 * important one — such as your first window. But you should not try to
265 * perform any window operation on the id until you have tested to make sure
269 * The examples we've seen so far have the simplest kind of size control. (Yes,
270 * this is <quote>below</quote>.) Every pair is a percentage split, with
273 * <mathphrase>X</mathphrase>
275 * percent going to one side, and
278 * <mathphrase>(100 - X)</mathphrase>
280 * percent going to the other side. If the player resizes the window, the whole
281 * mess expands, contracts, or stretches in a uniform way.
283 * As I said above, you can also make fixed-size splits. This is a little more
284 * complicated, because you have to know how this fixed size is measured.
286 * Sizes are measured in a way which is different for each window type. For
287 * example, a text grid window is measured by the size of its fixed-width font.
288 * You can make a text grid window which is fixed at a height of four rows, or
289 * ten columns. A text buffer window is measured by the size of its font.
292 * Remember that different windows may use different size fonts. Even two
293 * text grid windows may use fixed-size fonts of different sizes.
296 * Graphics windows are measured in pixels, not characters. Blank windows
297 * aren't measured at all; there's no meaningful way to measure them, and
298 * therefore you can't create a blank window of a fixed size, only of a
299 * proportional (percentage) size.
301 * So to create a text buffer window which takes the top 40% of the original
302 * window's space, you would execute
303 * |[ newwin = glk_window_open(win, winmethod_Above | winmethod_Proportional, 40, wintype_TextBuffer, 0); ]|
305 * To create a text grid which is always five lines high, at the bottom of the
306 * original window, you would do
307 * |[ newwin = glk_window_open(win, winmethod_Below | winmethod_Fixed, 5, wintype_TextGrid, 0); ]|
309 * Note that the meaning of the @size argument depends on the @method argument.
310 * If the method is %winmethod_Fixed, it also depends on the @wintype argument.
311 * The new window is then called the <quote>key window</quote> of this split,
312 * because its window type determines how the split size is computed.
315 * For %winmethod_Proportional splits, you can still call the new window the
316 * <quote>key window</quote>. But the key window is not important for
317 * proportional splits, because the size will always be computed as a simple
318 * ratio of the available space, not a fixed size of one child window.
321 * This system is more or less peachy as long as all the constraints work out.
322 * What happens when there is a conflict? The rules are simple. Size control
323 * always flows down the tree, and the player is at the top. Let's bring out an
325 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
326 * <entry><mediaobject><imageobject><imagedata fileref="fig5-7a.png"/>
327 * </imageobject></mediaobject></entry>
328 * <entry><mediaobject><textobject><literallayout class="monospaced">
334 * </literallayout></textobject></mediaobject></entry>
335 * </row></tbody></tgroup></informaltable>
337 * First we split A into A and B, with a 50% proportional split. Then we split
338 * A into A and C, with C above, C being a text grid window, and C gets a fixed
339 * size of two rows (as measured in its own font size). A gets whatever remains
340 * of the 50% it had before.
342 * Now the player stretches the window vertically.
343 * <informalfigure><mediaobject><imageobject><imagedata fileref="fig6.png"/>
344 * </imageobject></mediaobject></informalfigure>
346 * The library figures: the topmost split, the original A/B split, is 50-50. So
347 * B gets half the screen space, and the pair window next to it (the lower
348 * <quote>O</quote>) gets the other half. Then it looks at the lower
349 * <quote>O</quote>. C gets two rows; A gets the rest. All done.
351 * Then the user maliciously starts squeezing the window down, in stages:
352 * <informaltable xml:id="chimara-Figure-Squeezing-Window" frame="none">
353 * <tgroup cols="5"><tbody><row valign="top">
354 * <entry><mediaobject><imageobject><imagedata fileref="fig5-7a.png"/>
355 * </imageobject></mediaobject></entry>
356 * <entry><mediaobject><imageobject><imagedata fileref="fig7b.png"/>
357 * </imageobject></mediaobject></entry>
358 * <entry><mediaobject><imageobject><imagedata fileref="fig7c.png"/>
359 * </imageobject></mediaobject></entry>
360 * <entry><mediaobject><imageobject><imagedata fileref="fig7d.png"/>
361 * </imageobject></mediaobject></entry>
362 * <entry><mediaobject><imageobject><imagedata fileref="fig7e.png"/>
363 * </imageobject></mediaobject></entry>
364 * </row></tbody></tgroup></informaltable>
366 * The logic remains the same. B always gets half the space. At stage 3,
367 * there's no room left for A, so it winds up with zero height. Nothing
368 * displayed in A will be visible. At stage 4, there isn't even room in the
369 * upper 50% to give C its two rows; so it only gets one. Finally, C is
370 * squashed out of existence as well.
372 * When a window winds up undersized, it remembers what size it should be. In
373 * the example above, A remembers that it should be two rows; if the user
374 * expands the window to the original size, it would return to the original
377 * The downward flow of control is a bit harsh. After all, in stage 4, there's
378 * room for C to have its two rows if only B would give up some of its 50%. But
379 * this does not happen.
382 * This makes life much easier for the Glk library. To determine the
383 * configuration of a window, it only needs to look at the window's
384 * ancestors, never at its descendants. So window layout is a simple
385 * recursive algorithm, no backtracking.
388 * What happens when you split a fixed-size window? The resulting pair window
389 * — that is, the two new parts together — retain the same size
390 * constraint as the original window that was split. The key window for the
391 * original split is still the key window for that split, even though it's now
392 * a grandchild instead of a child.
394 * The easy, and correct, way to think about this is that the size constraint
395 * is stored by a window's parent, not the window itself; and a constraint
396 * consists of a pointer to a key window plus a size value.
398 * <informaltable frame="none"><tgroup cols="6"><tbody><row>
399 * <entry><mediaobject><imageobject><imagedata fileref="fig8a.png"/>
400 * </imageobject></mediaobject></entry>
401 * <entry><mediaobject><textobject><literallayout class="monospaced">
403 * </literallayout></textobject></mediaobject></entry>
404 * <entry><mediaobject><imageobject><imagedata fileref="fig8b.png"/>
405 * </imageobject></mediaobject></entry>
406 * <entry><mediaobject><textobject><literallayout class="monospaced">
410 * </literallayout></textobject></mediaobject></entry>
411 * <entry><mediaobject><imageobject><imagedata fileref="fig8c.png"/>
412 * </imageobject></mediaobject></entry>
413 * <entry><mediaobject><textobject><literallayout class="monospaced">
419 * </literallayout></textobject></mediaobject></entry>
420 * </row></tbody></tgroup></informaltable>
421 * The initial window is A. After the first split, the new pair window (O1,
422 * which covers the whole screen) knows that its new child (B) is below A, and
423 * gets 50% of its own area. (B is the key window for this split, but a
424 * proportional split doesn't care about key windows.)
426 * After the <emphasis>second</emphasis> split, all this remains true; O1 knows
427 * that its first child gets 50% of its space, and B is O1's key window. But
428 * now O1's first child is O2 instead of A. The newer pair window (O2) knows
429 * that its first child (C) is above the second, and gets a fixed size of two
430 * rows. (As measured in C's font, because C is O2's key window.)
432 * If we split C, now, the resulting pair will still be two C-font rows high
433 * — that is, tall enough for two lines of whatever font C displays. For
434 * the sake of example, we'll do this vertically.
435 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
436 * <entry><mediaobject><imageobject><imagedata fileref="fig9.png"/>
437 * </imageobject></mediaobject></entry>
438 * <entry><mediaobject><textobject><literallayout class="monospaced">
446 * </literallayout></textobject></mediaobject></entry>
447 * </row></tbody></tgroup></informaltable>
449 * O3 now knows that its children have a 50-50 left-right split. O2 is still
450 * committed to giving its upper child, O3, two C-font rows. Again, this is
451 * because C is O2's key window.
454 * This turns out to be a good idea, because it means that C, the text grid
455 * window, is still two rows high. If O3 had been a upper-lower split, things
456 * wouldn't work out so neatly. But the rules would still apply. If you don't
457 * like this, don't do it.
460 * Returns: the new window, or %NULL on error.
463 glk_window_open(winid_t split, glui32 method, glui32 size, glui32 wintype,
466 VALID_WINDOW_OR_NULL(split, return NULL);
467 g_return_val_if_fail(!(((method & winmethod_DivisionMask) == winmethod_Proportional) && size > 100), NULL);
468 if(method != (method & (winmethod_DirMask | winmethod_DivisionMask | winmethod_BorderMask)))
469 WARNING("Unrecognized bits in method constant");
471 ChimaraGlkPrivate *glk_data = g_private_get(&glk_data_key);
473 if(split == NULL && glk_data->root_window != NULL)
475 ILLEGAL("Tried to open a new root window, but there is already a root window");
481 /* Create the new window */
482 winid_t win = window_new_common(rock);
489 /* A blank window will be a label without any text */
490 GtkWidget *label = gtk_label_new("");
491 gtk_widget_show(label);
495 /* A blank window has no size */
497 win->unit_height = 0;
501 case wintype_TextGrid:
503 GtkWidget *textview = gtk_text_view_new();
504 GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(textview) );
506 gtk_text_view_set_wrap_mode( GTK_TEXT_VIEW(textview), GTK_WRAP_NONE );
507 gtk_text_view_set_editable( GTK_TEXT_VIEW(textview), FALSE );
508 gtk_widget_show(textview);
510 /* Create the styles available to the window stream */
511 style_init_textgrid(textbuffer);
512 gtk_widget_modify_font( textview, get_current_font(wintype) );
514 win->widget = textview;
515 win->frame = textview;
517 /* Determine the size of a "0" character in pixels */
518 PangoLayout *zero = gtk_widget_create_pango_layout(textview, "0");
519 pango_layout_set_font_description( zero, get_current_font(wintype) );
520 pango_layout_get_pixel_size(zero, &(win->unit_width), &(win->unit_height));
521 g_object_unref(zero);
522 /* width and height are set later */
524 /* Connect signal handlers */
525 win->char_input_keypress_handler = g_signal_connect(textview, "key-press-event", G_CALLBACK(on_char_input_key_press_event), win);
526 g_signal_handler_block(textview, win->char_input_keypress_handler);
527 win->line_input_keypress_handler = g_signal_connect(textview, "key-press-event", G_CALLBACK(on_line_input_key_press_event), win);
528 g_signal_handler_block(textview, win->line_input_keypress_handler);
529 win->shutdown_keypress_handler = g_signal_connect(textview, "key-press-event", G_CALLBACK(on_shutdown_key_press_event), win);
530 g_signal_handler_block(textview, win->shutdown_keypress_handler);
531 win->button_press_event_handler = g_signal_connect( textview, "button-press-event", G_CALLBACK(on_window_button_press), win );
532 g_signal_handler_block(textview, win->button_press_event_handler);
536 case wintype_TextBuffer:
538 GtkWidget *overlay = gtk_overlay_new();
539 GtkWidget *scrolledwindow = gtk_scrolled_window_new(NULL, NULL);
540 GtkWidget *textview = gtk_text_view_new();
541 GtkWidget *pager = gtk_button_new_with_label("More");
542 GtkWidget *image = gtk_image_new_from_stock(GTK_STOCK_GO_DOWN, GTK_ICON_SIZE_BUTTON);
543 GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(textview) );
545 gtk_scrolled_window_set_policy( GTK_SCROLLED_WINDOW(scrolledwindow), GTK_POLICY_NEVER, GTK_POLICY_AUTOMATIC );
547 gtk_button_set_image( GTK_BUTTON(pager), image );
548 gtk_widget_set_halign(pager, GTK_ALIGN_END);
549 gtk_widget_set_valign(pager, GTK_ALIGN_END);
550 gtk_widget_set_no_show_all(pager, TRUE);
552 gtk_text_view_set_wrap_mode( GTK_TEXT_VIEW(textview), GTK_WRAP_WORD_CHAR );
553 gtk_text_view_set_editable( GTK_TEXT_VIEW(textview), FALSE );
554 gtk_text_view_set_pixels_inside_wrap( GTK_TEXT_VIEW(textview), 3 );
555 gtk_text_view_set_left_margin( GTK_TEXT_VIEW(textview), 20 );
556 gtk_text_view_set_right_margin( GTK_TEXT_VIEW(textview), 20 );
558 gtk_container_add( GTK_CONTAINER(scrolledwindow), textview );
559 gtk_container_add( GTK_CONTAINER(overlay), scrolledwindow );
560 gtk_overlay_add_overlay( GTK_OVERLAY(overlay), pager );
561 gtk_widget_show_all(overlay);
563 win->widget = textview;
564 win->scrolledwindow = scrolledwindow;
566 win->frame = overlay;
568 /* Create the styles available to the window stream */
569 style_init_textbuffer(textbuffer);
570 gtk_widget_modify_font( textview, get_current_font(wintype) );
572 /* Determine the size of a "0" character in pixels */
573 PangoLayout *zero = gtk_widget_create_pango_layout(textview, "0");
574 pango_layout_set_font_description( zero, get_current_font(wintype) );
575 pango_layout_get_pixel_size(zero, &(win->unit_width), &(win->unit_height));
576 g_object_unref(zero);
578 /* Connect signal handlers */
581 g_signal_connect_after( textview, "size-allocate", G_CALLBACK(pager_after_size_allocate), win );
582 win->pager_keypress_handler = g_signal_connect( textview, "key-press-event", G_CALLBACK(pager_on_key_press_event), win );
583 g_signal_handler_block(textview, win->pager_keypress_handler);
584 GtkAdjustment *adj = gtk_scrolled_window_get_vadjustment(GTK_SCROLLED_WINDOW(scrolledwindow));
585 win->pager_adjustment_handler = g_signal_connect_after(adj, "value-changed", G_CALLBACK(pager_after_adjustment_changed), win);
586 g_signal_connect(pager, "clicked", G_CALLBACK(pager_on_clicked), win);
588 /* Char and line input */
589 win->char_input_keypress_handler = g_signal_connect( textview, "key-press-event", G_CALLBACK(on_char_input_key_press_event), win );
590 g_signal_handler_block(textview, win->char_input_keypress_handler);
591 win->line_input_keypress_handler = g_signal_connect( textview, "key-press-event", G_CALLBACK(on_line_input_key_press_event), win );
592 g_signal_handler_block(textview, win->line_input_keypress_handler);
593 win->insert_text_handler = g_signal_connect_after( textbuffer, "insert-text", G_CALLBACK(after_window_insert_text), win );
594 g_signal_handler_block(textbuffer, win->insert_text_handler);
596 /* Shutdown key press */
597 win->shutdown_keypress_handler = g_signal_connect( textview, "key-press-event", G_CALLBACK(on_shutdown_key_press_event), win );
598 g_signal_handler_block(textview, win->shutdown_keypress_handler);
600 /* Create an editable tag to indicate uneditable parts of the window
602 gtk_text_buffer_create_tag(textbuffer, "uneditable", "editable", FALSE, "editable-set", TRUE, NULL);
604 /* Mark the position where the user will input text and the end mark */
606 gtk_text_buffer_get_end_iter(textbuffer, &end);
607 gtk_text_buffer_create_mark(textbuffer, "input_position", &end, TRUE);
608 gtk_text_buffer_create_mark(textbuffer, "end_position", &end, FALSE);
610 /* Create the pager position mark; it stands for the last character in the buffer
611 that has been on-screen */
612 gtk_text_buffer_create_mark(textbuffer, "pager_position", &end, TRUE);
616 case wintype_Graphics:
618 GtkWidget *image = gtk_drawing_area_new();
619 gtk_widget_show(image);
622 win->unit_height = 1;
625 win->background_color = 0x00FFFFFF;
626 win->backing_store = NULL;
628 /* Connect signal handlers */
629 win->button_press_event_handler = g_signal_connect(image, "button-press-event", G_CALLBACK(on_window_button_press), win);
630 g_signal_handler_block(image, win->button_press_event_handler);
631 win->shutdown_keypress_handler = g_signal_connect(image, "key-press-event", G_CALLBACK(on_shutdown_key_press_event), win);
632 g_signal_handler_block(image, win->shutdown_keypress_handler);
633 g_signal_connect(image, "configure-event", G_CALLBACK(on_graphics_configure), win);
634 g_signal_connect(image, "draw", G_CALLBACK(on_graphics_draw), win);
640 ILLEGAL_PARAM("Unknown window type: %u", wintype);
642 g_node_destroy(glk_data->root_window);
643 glk_data->root_window = NULL;
647 /* Set the minimum size to "as small as possible" so it doesn't depend on
648 the size of the window contents */
649 gtk_widget_set_size_request(win->widget, 0, 0);
650 gtk_widget_set_size_request(win->frame, 0, 0);
654 /* When splitting, construct a new parent window
655 * copying most characteristics from the window that is being split */
656 winid_t pair = window_new_common(0);
657 pair->type = wintype_Pair;
659 /* The pair window must know about its children's split method */
660 pair->key_window = win;
661 pair->split_method = method;
662 pair->constraint_size = size;
664 /* Insert the new window into the window tree */
665 if(split->window_node->parent == NULL)
666 glk_data->root_window = pair->window_node;
669 if( split->window_node == g_node_first_sibling(split->window_node) )
670 g_node_prepend(split->window_node->parent, pair->window_node);
672 g_node_append(split->window_node->parent, pair->window_node);
673 g_node_unlink(split->window_node);
675 /* Place the windows in the correct order */
676 switch(method & winmethod_DirMask)
679 case winmethod_Above:
680 g_node_append(pair->window_node, win->window_node);
681 g_node_append(pair->window_node, split->window_node);
683 case winmethod_Right:
684 case winmethod_Below:
685 g_node_append(pair->window_node, split->window_node);
686 g_node_append(pair->window_node, win->window_node);
691 /* Set the window as root window */
692 glk_data->root_window = win->window_node;
695 /* Set the window as a child of the Glk widget, don't trigger an arrange event */
696 g_mutex_lock(&glk_data->arrange_lock);
697 glk_data->needs_rearrange = TRUE;
698 glk_data->ignore_next_arrange_event = TRUE;
699 g_mutex_unlock(&glk_data->arrange_lock);
700 gtk_widget_set_parent(win->frame, GTK_WIDGET(glk_data->self));
701 gtk_widget_queue_resize(GTK_WIDGET(glk_data->self));
703 /* For text grid windows, fill the buffer with blanks. */
704 if(wintype == wintype_TextGrid)
706 /* Create the cursor position mark */
708 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
709 gtk_text_buffer_get_start_iter(buffer, &begin);
710 gtk_text_buffer_create_mark(buffer, "cursor_position", &begin, TRUE);
714 glk_window_clear(win);
718 /* Internal function: if node's key window is closing_win or one of its
719 children, set node's key window to NULL. */
721 remove_key_windows(GNode *node, winid_t closing_win)
723 winid_t win = (winid_t)node->data;
724 if(win->key_window && (win->key_window == closing_win || g_node_is_ancestor(closing_win->window_node, win->key_window->window_node)))
725 win->key_window = NULL;
726 return FALSE; /* Don't stop the traversal */
729 /* Internal function: destroy this window's GTK widgets, window streams,
730 and those of all its children. GDK threads must be locked. */
732 destroy_windows_below(winid_t win, stream_result_t *result)
737 case wintype_TextGrid:
738 case wintype_TextBuffer:
739 case wintype_Graphics:
740 gtk_widget_unparent(win->frame);
744 destroy_windows_below(win->window_node->children->data, NULL);
745 destroy_windows_below(win->window_node->children->next->data, NULL);
749 ILLEGAL_PARAM("Unknown window type: %u", win->type);
752 stream_close_common(win->window_stream, result);
755 /* Internal function: free the winid_t structure of this window and those of all its children */
757 free_winids_below(winid_t win)
759 if(win->type == wintype_Pair) {
760 free_winids_below(win->window_node->children->data);
761 free_winids_below(win->window_node->children->next->data);
763 window_close_common(win, FALSE);
768 * @win: Window to close.
769 * @result: Pointer to a #stream_result_t in which to store the write count.
771 * Closes @win, which is pretty much exactly the opposite of opening a window.
772 * It is legal to close all your windows, or to close the root window (which is
775 * The @result argument is filled with the output character count of the window
776 * stream. See <link linkend="chimara-Streams">Streams</link> and <link
777 * linkend="chimara-Closing-Streams">Closing Streams</link>.
779 * When you close a window (and it is not the root window), the other window
780 * in its pair takes over all the freed-up area. Let's close D, in the current
782 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
783 * <entry><mediaobject><imageobject><imagedata fileref="fig10.png"/>
784 * </imageobject></mediaobject></entry>
785 * <entry><mediaobject><textobject><literallayout class="monospaced">
791 * </literallayout></textobject></mediaobject></entry>
792 * </row></tbody></tgroup></informaltable>
794 * Notice what has happened. D is gone. O3 is gone, and its 50-50 left-right
795 * split has gone with it. The other size constraints are unchanged; O2 is
796 * still committed to giving its upper child two rows, as measured in the font
797 * of O2's key window, which is C. Conveniently, O2's upper child is C, just as
798 * it was before we created D. In fact, now that D is gone, everything is back
799 * to the way it was before we created D.
801 * But what if we had closed C instead of D? We would have gotten this:
802 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
803 * <entry><mediaobject><imageobject><imagedata fileref="fig11.png"/>
804 * </imageobject></mediaobject></entry>
805 * <entry><mediaobject><textobject><literallayout class="monospaced">
811 * </literallayout></textobject></mediaobject></entry>
812 * </row></tbody></tgroup></informaltable>
814 * Again, O3 is gone. But D has collapsed to zero height. This is because its
815 * height is controlled by O2, and O2's key window was C, and C is now gone. O2
816 * no longer has a key window at all, so it cannot compute a height for its
817 * upper child, so it defaults to zero.
820 * This may seem to be an inconvenient choice. That is deliberate. You should
821 * not leave a pair window with no key, and the zero-height default reminds
822 * you not to. You can use glk_window_set_arrangement() to set a new split
823 * measurement and key window. See <link
824 * linkend="chimara-Changing-Window-Constraints">Changing Window
825 * Constraints</link>.
829 glk_window_close(winid_t win, stream_result_t *result)
831 VALID_WINDOW(win, return);
833 ChimaraGlkPrivate *glk_data = g_private_get(&glk_data_key);
835 gdk_threads_enter(); /* Prevent redraw while we're trashing the window */
837 /* If any pair windows have this window or its children as a key window,
838 set their key window to NULL */
839 g_node_traverse(glk_data->root_window, G_IN_ORDER, G_TRAVERSE_NON_LEAVES, -1, (GNodeTraverseFunc)remove_key_windows, win);
841 /* Close all the window streams and destroy the widgets of this window
842 and below, before trashing the window tree */
843 destroy_windows_below(win, result);
845 /* Then free the winid_t structures below this node, but not this one itself */
846 if(win->type == wintype_Pair) {
847 free_winids_below(win->window_node->children->data);
848 free_winids_below(win->window_node->children->next->data);
850 /* So now we should be left with a skeleton tree hanging off this node */
852 /* Parent window changes from a split window into the sibling window */
853 /* The parent of any window is either a pair window or NULL */
854 GNode *pair_node = win->window_node->parent;
855 /* If win was not the root window: */
856 if(pair_node != NULL)
858 gboolean new_child_on_left = ( pair_node == g_node_first_sibling(pair_node) );
860 /* Lookup our sibling */
861 GNode *sibling_node = pair_node->children;
862 if(sibling_node == win->window_node)
863 sibling_node = sibling_node->next;
865 GNode *new_parent_node = pair_node->parent;
866 g_node_unlink(pair_node);
867 g_node_unlink(sibling_node);
868 /* pair_node and sibling_node should now be totally unconnected to the tree */
870 if(new_parent_node == NULL)
872 glk_data->root_window = sibling_node;
876 if(new_child_on_left)
877 g_node_prepend(new_parent_node, sibling_node);
879 g_node_append(new_parent_node, sibling_node);
882 stream_close_common( ((winid_t) pair_node->data)->window_stream, NULL );
883 window_close_common( (winid_t) pair_node->data, TRUE);
885 else /* it was the root window */
887 glk_data->root_window = NULL;
890 window_close_common(win, FALSE);
892 /* Schedule a redraw */
893 g_mutex_lock(&glk_data->arrange_lock);
894 glk_data->needs_rearrange = TRUE;
895 glk_data->ignore_next_arrange_event = TRUE;
896 g_mutex_unlock(&glk_data->arrange_lock);
897 gtk_widget_queue_resize( GTK_WIDGET(glk_data->self) );
905 * Erases @win. The meaning of this depends on the window type.
908 * <term>Text buffer</term>
910 * This may do any number of things, such as delete all text in the window, or
911 * print enough blank lines to scroll all text beyond visibility, or insert a
912 * page-break marker which is treated specially by the display part of the
917 * <term>Text grid</term>
919 * This will clear the window, filling all positions with blanks (in the
920 * normal style). The window cursor is moved to the top left corner (position
925 * <term>Graphics</term>
927 * Clears the entire window to its current background color. See <link
928 * linkend="chimara-The-Types-of-Windows#wintype-Graphics">Graphics
933 * <term>Other window types</term>
934 * <listitem><para>No effect.</para></listitem>
938 * It is illegal to erase a window which has line input pending.
941 glk_window_clear(winid_t win)
943 VALID_WINDOW(win, return);
944 g_return_if_fail(win->input_request_type != INPUT_REQUEST_LINE && win->input_request_type != INPUT_REQUEST_LINE_UNICODE);
946 ChimaraGlkPrivate *glk_data = g_private_get(&glk_data_key);
955 case wintype_TextGrid:
956 /* fill the buffer with blanks */
958 /* Wait for the window's size to be updated */
959 g_mutex_lock(&glk_data->arrange_lock);
960 if(glk_data->needs_rearrange)
961 g_cond_wait(&glk_data->rearranged, &glk_data->arrange_lock);
962 g_mutex_unlock(&glk_data->arrange_lock);
966 /* Manually put newlines at the end of each row of characters in the buffer; manual newlines make resizing the window's grid easier. */
967 gchar *blanks = g_strnfill(win->width, ' ');
968 gchar **blanklines = g_new0(gchar *, win->height + 1);
970 for(count = 0; count < win->height; count++)
971 blanklines[count] = blanks;
972 blanklines[win->height] = NULL;
973 gchar *text = g_strjoinv("\n", blanklines);
974 g_free(blanklines); /* not g_strfreev() */
977 GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
978 gtk_text_buffer_set_text(textbuffer, text, -1);
981 GtkTextIter start, end;
982 gtk_text_buffer_get_start_iter(textbuffer, &start);
983 gtk_text_buffer_get_end_iter(textbuffer, &end);
984 style_apply(win, &start, &end);
986 gtk_text_buffer_move_mark_by_name(textbuffer, "cursor_position", &start);
992 case wintype_TextBuffer:
993 /* delete all text in the window */
997 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
998 GtkTextIter start, end;
999 gtk_text_buffer_get_bounds(buffer, &start, &end);
1000 gtk_text_buffer_delete(buffer, &start, &end);
1002 gdk_threads_leave();
1006 case wintype_Graphics:
1008 GtkAllocation allocation;
1010 /* Wait for the window's size to be updated */
1011 g_mutex_lock(&glk_data->arrange_lock);
1012 if(glk_data->needs_rearrange)
1013 g_cond_wait(&glk_data->rearranged, &glk_data->arrange_lock);
1014 g_mutex_unlock(&glk_data->arrange_lock);
1016 gdk_threads_enter();
1017 gtk_widget_get_allocation(win->widget, &allocation);
1018 gdk_threads_leave();
1020 glk_window_erase_rect(win, 0, 0, allocation.width, allocation.height);
1025 ILLEGAL_PARAM("Unknown window type: %d", win->type);
1031 * @win: A window, or %NULL.
1033 * Sets the current stream to @win's window stream. If @win is %NULL, it is
1035 * |[ glk_stream_set_current(NULL); ]|
1036 * If @win is not %NULL, it is equivalent to
1037 * |[ glk_stream_set_current(glk_window_get_stream(win)); ]|
1038 * See <link linkend="chimara-Streams">Streams</link>.
1041 glk_set_window(winid_t win)
1043 VALID_WINDOW_OR_NULL(win, return);
1045 glk_stream_set_current( glk_window_get_stream(win) );
1047 glk_stream_set_current(NULL);
1051 * glk_window_get_stream:
1054 * Returns the stream which is associated with @win. (See <link
1055 * linkend="chimara-Window-Streams">Window Streams</link>.) Every window has a
1056 * stream which can be printed to, but this may not be useful, depending on the
1060 * For example, printing to a blank window's stream has no effect.
1063 * Returns: A window stream.
1065 strid_t glk_window_get_stream(winid_t win)
1067 VALID_WINDOW(win, return NULL);
1068 return win->window_stream;
1072 * glk_window_set_echo_stream:
1074 * @str: A stream to attach to the window, or %NULL.
1076 * Sets @win's echo stream to @str, which can be any valid output stream. You
1077 * can reset a window to stop echoing by calling
1078 * <code>#glk_window_set_echo_stream(@win, %NULL)</code>.
1080 * It is illegal to set a window's echo stream to be its
1081 * <emphasis>own</emphasis> window stream. That would create an infinite loop,
1082 * and is nearly certain to crash the Glk library. It is similarly illegal to
1083 * create a longer loop (two or more windows echoing to each other.)
1086 glk_window_set_echo_stream(winid_t win, strid_t str)
1088 VALID_WINDOW(win, return);
1089 VALID_STREAM_OR_NULL(str, return);
1091 /* Test for an infinite loop */
1093 for(; next && next->type == STREAM_TYPE_WINDOW; next = next->window->echo_stream)
1095 if(next == win->window_stream)
1097 ILLEGAL("Infinite loop detected");
1098 win->echo_stream = NULL;
1103 win->echo_stream = str;
1107 * glk_window_get_echo_stream:
1110 * Returns the echo stream of window @win. Initially, a window has no echo
1111 * stream, so <code>#glk_window_get_echo_stream(@win)</code> will return %NULL.
1113 * Returns: A stream, or %NULL.
1116 glk_window_get_echo_stream(winid_t win)
1118 VALID_WINDOW(win, return NULL);
1119 return win->echo_stream;
1123 * glk_window_get_size:
1125 * @widthptr: Pointer to a location to store the window's width, or %NULL.
1126 * @heightptr: Pointer to a location to store the window's height, or %NULL.
1128 * Simply returns the actual size of the window, in its measurement system.
1129 * As described in <link linkend="chimara-Other-API-Conventions">Other API
1130 * Conventions</link>, either @widthptr or @heightptr can be %NULL, if you
1131 * only want one measurement.
1133 * <note><para>Or, in fact, both, if you want to waste time.</para></note>
1136 glk_window_get_size(winid_t win, glui32 *widthptr, glui32 *heightptr)
1138 VALID_WINDOW(win, return);
1140 GtkAllocation allocation;
1141 ChimaraGlkPrivate *glk_data = g_private_get(&glk_data_key);
1147 if(widthptr != NULL)
1149 if(heightptr != NULL)
1153 case wintype_TextGrid:
1154 /* Wait until the window's size is current */
1155 g_mutex_lock(&glk_data->arrange_lock);
1156 if(glk_data->needs_rearrange)
1157 g_cond_wait(&glk_data->rearranged, &glk_data->arrange_lock);
1158 g_mutex_unlock(&glk_data->arrange_lock);
1160 gdk_threads_enter();
1161 gtk_widget_get_allocation(win->widget, &allocation);
1162 /* Cache the width and height */
1163 win->width = (glui32)(allocation.width / win->unit_width);
1164 win->height = (glui32)(allocation.height / win->unit_height);
1165 gdk_threads_leave();
1167 if(widthptr != NULL)
1168 *widthptr = win->width;
1169 if(heightptr != NULL)
1170 *heightptr = win->height;
1173 case wintype_TextBuffer:
1174 /* Wait until the window's size is current */
1175 g_mutex_lock(&glk_data->arrange_lock);
1176 if(glk_data->needs_rearrange)
1177 g_cond_wait(&glk_data->rearranged, &glk_data->arrange_lock);
1178 g_mutex_unlock(&glk_data->arrange_lock);
1180 gdk_threads_enter();
1181 gtk_widget_get_allocation(win->widget, &allocation);
1182 if(widthptr != NULL)
1183 *widthptr = (glui32)(allocation.width / win->unit_width);
1184 if(heightptr != NULL)
1185 *heightptr = (glui32)(allocation.height / win->unit_height);
1186 gdk_threads_leave();
1190 case wintype_Graphics:
1191 g_mutex_lock(&glk_data->arrange_lock);
1192 if(glk_data->needs_rearrange)
1193 g_cond_wait(&glk_data->rearranged, &glk_data->arrange_lock);
1194 g_mutex_unlock(&glk_data->arrange_lock);
1196 gdk_threads_enter();
1197 gtk_widget_get_allocation(win->widget, &allocation);
1198 if(widthptr != NULL)
1199 *widthptr = (glui32)(allocation.width);
1200 if(heightptr != NULL)
1201 *heightptr = (glui32)(allocation.height);
1202 gdk_threads_leave();
1207 ILLEGAL_PARAM("Unknown window type: %u", win->type);
1212 * glk_window_set_arrangement:
1213 * @win: a pair window to rearrange.
1214 * @method: new method of size computation. One of %winmethod_Above,
1215 * %winmethod_Below, %winmethod_Left, or %winmethod_Right OR'ed with
1216 * %winmethod_Fixed or %winmethod_Proportional.
1217 * @size: new size constraint, in percentage points if @method is
1218 * %winmethod_Proportional, otherwise in characters if @win's type is
1219 * %wintype_TextBuffer or %wintype_TextGrid, or pixels if @win's type is
1220 * %wintype_Graphics.
1221 * @keywin: new key window, or %NULL to leave the key window unchanged.
1223 * Changes the size of an existing split — that is, it changes the
1224 * constraint of a given pair window.
1226 * Consider the example above, where D has collapsed to zero height. Say D was a
1227 * text buffer window. You could make a more useful layout by doing
1230 * o2 = glk_window_get_parent(d);
1231 * glk_window_set_arrangement(o2, winmethod_Above | winmethod_Fixed, 3, d);
1233 * That would set D (the upper child of O2) to be O2's key window, and give it a
1234 * fixed size of 3 rows.
1236 * If you later wanted to expand D, you could do
1237 * |[ glk_window_set_arrangement(o2, winmethod_Above | winmethod_Fixed, 5, NULL); ]|
1238 * That expands D to five rows. Note that, since O2's key window is already set
1239 * to D, it is not necessary to provide the @keywin argument; you can pass %NULL
1240 * to mean <quote>leave the key window unchanged.</quote>
1242 * If you do change the key window of a pair window, the new key window
1243 * <emphasis>must</emphasis> be a descendant of that pair window. In the current
1244 * example, you could change O2's key window to be A, but not B. The key window
1245 * also cannot be a pair window itself.
1247 * |[ glk_window_set_arrangement(o2, winmethod_Below | winmethod_Fixed, 3, NULL); ]|
1248 * This changes the constraint to be on the <emphasis>lower</emphasis> child of
1249 * O2, which is A. The key window is still D; so A would then be three rows high
1250 * as measured in D's font, and D would get the rest of O2's space. That may not
1251 * be what you want. To set A to be three rows high as measured in A's font, you
1253 * |[ glk_window_set_arrangement(o2, winmethod_Below | winmethod_Fixed, 3, a); ]|
1255 * Or you could change O2 to a proportional split:
1256 * |[ glk_window_set_arrangement(o2, winmethod_Below | winmethod_Proportional, 30, NULL); ]|
1258 * |[ glk_window_set_arrangement(o2, winmethod_Above | winmethod_Proportional, 70, NULL); ]|
1259 * These do exactly the same thing, since 30% above is the same as
1260 * 70% below. You don't need to specify a key window with a proportional
1261 * split, so the @keywin argument is %NULL. (You could actually specify either A
1262 * or D as the key window, but it wouldn't affect the result.)
1264 * Whatever constraint you set, glk_window_get_size() will tell you the actual
1265 * window size you got.
1267 * Note that you can resize windows, and alter the Border/NoBorder flag. But you
1268 * can't flip or rotate them. You can't move A above D, or change O2 to a
1269 * vertical split where A is left or right of D.
1271 * To get this effect you could close one of the windows, and re-split the
1272 * other one with glk_window_open().
1276 glk_window_set_arrangement(winid_t win, glui32 method, glui32 size, winid_t keywin)
1278 VALID_WINDOW(win, return);
1279 VALID_WINDOW_OR_NULL(keywin, return);
1280 g_return_if_fail(win->type == wintype_Pair);
1283 g_return_if_fail(keywin->type != wintype_Pair);
1284 g_return_if_fail(g_node_is_ancestor(win->window_node, keywin->window_node));
1286 g_return_if_fail(method == (method & (winmethod_DirMask | winmethod_DivisionMask)));
1287 g_return_if_fail(!(((method & winmethod_DivisionMask) == winmethod_Proportional) && size > 100));
1289 ChimaraGlkPrivate *glk_data = g_private_get(&glk_data_key);
1291 win->split_method = method;
1292 win->constraint_size = size;
1294 win->key_window = keywin;
1296 /* Tell GTK to rearrange the windows */
1297 gdk_threads_enter();
1298 g_mutex_lock(&glk_data->arrange_lock);
1299 glk_data->needs_rearrange = TRUE;
1300 glk_data->ignore_next_arrange_event = TRUE;
1301 g_mutex_unlock(&glk_data->arrange_lock);
1302 gtk_widget_queue_resize(GTK_WIDGET(glk_data->self));
1303 gdk_threads_leave();
1307 * glk_window_get_arrangement:
1308 * @win: a pair window.
1309 * @methodptr: return location for the constraint flags of @win, or %NULL.
1310 * @sizeptr: return location for the constraint size of @win, or %NULL.
1311 * @keywinptr: return location for the key window of @win, or %NULL.
1313 * Queries the constraint of a given pair window.
1316 glk_window_get_arrangement(winid_t win, glui32 *methodptr, glui32 *sizeptr, winid_t *keywinptr)
1318 VALID_WINDOW(win, return);
1319 g_return_if_fail(win->type == wintype_Pair);
1322 *methodptr = win->split_method;
1324 *sizeptr = win->constraint_size;
1326 *keywinptr = win->key_window;
1330 * glk_window_move_cursor:
1331 * @win: A text grid window.
1332 * @xpos: Horizontal cursor position.
1333 * @ypos: Vertical cursor position.
1335 * Sets the cursor position. If you move the cursor right past the end of a
1336 * line, it wraps; the next character which is printed will appear at the
1337 * beginning of the next line.
1339 * If you move the cursor below the last line, or when the cursor reaches the
1340 * end of the last line, it goes <quote>off the screen</quote> and further
1341 * output has no effect. You must call glk_window_move_cursor() or
1342 * glk_window_clear() to move the cursor back into the visible region.
1345 * Note that the arguments of glk_window_move_cursor() are <type>unsigned
1346 * int</type>s. This is okay, since there are no negative positions. If you try
1347 * to pass a negative value, Glk will interpret it as a huge positive value,
1348 * and it will wrap or go off the last line.
1352 * Also note that the output cursor is not necessarily visible. In particular,
1353 * when you are requesting line or character input in a grid window, you cannot
1354 * rely on the cursor position to prompt the player where input is indicated.
1355 * You should print some character prompt at that spot — a
1356 * <quote>></quote> character, for example.
1360 glk_window_move_cursor(winid_t win, glui32 xpos, glui32 ypos)
1362 VALID_WINDOW(win, return);
1363 g_return_if_fail(win->type == wintype_TextGrid);
1365 flush_window_buffer(win);
1367 ChimaraGlkPrivate *glk_data = g_private_get(&glk_data_key);
1369 /* Wait until the window's size is current */
1370 g_mutex_lock(&glk_data->arrange_lock);
1371 if(glk_data->needs_rearrange)
1372 g_cond_wait(&glk_data->rearranged, &glk_data->arrange_lock);
1373 g_mutex_unlock(&glk_data->arrange_lock);
1375 /* Don't do anything if the window is shrunk down to nothing */
1376 if(win->width == 0 || win->height == 0)
1379 /* Calculate actual position if cursor is moved past the right edge */
1380 if(xpos >= win->width)
1382 ypos += xpos / win->width;
1386 /* Go to the end if the cursor is moved off the bottom edge */
1387 if(ypos >= win->height)
1389 xpos = win->width - 1;
1390 ypos = win->height - 1;
1393 gdk_threads_enter();
1395 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
1397 /* There must actually be a character at xpos, or the following function will choke */
1398 gtk_text_buffer_get_iter_at_line_offset(buffer, &newpos, ypos, xpos);
1399 gtk_text_buffer_move_mark_by_name(buffer, "cursor_position", &newpos);
1401 gdk_threads_leave();