4 #include "chimara-glk-private.h"
7 extern GPrivate *glk_data_key;
10 window_new_common(glui32 rock)
12 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
13 winid_t win = g_new0(struct glk_window_struct, 1);
15 win->magic = MAGIC_WINDOW;
17 if(glk_data->register_obj)
18 win->disprock = (*glk_data->register_obj)(win, gidisp_Class_Window);
20 win->window_node = g_node_new(win);
22 /* Every window has a window stream, but printing to it might have no effect */
23 win->window_stream = stream_new_common(0);
24 win->window_stream->file_mode = filemode_Write;
25 win->window_stream->type = STREAM_TYPE_WINDOW;
26 win->window_stream->window = win;
27 win->window_stream->style = "normal";
29 win->echo_stream = NULL;
30 win->input_request_type = INPUT_REQUEST_NONE;
31 win->line_input_buffer = NULL;
32 win->line_input_buffer_unicode = NULL;
35 /* Initialise the buffer */
36 win->buffer = g_string_sized_new(1024);
38 /* Initialise hyperlink table */
39 win->hyperlinks = g_hash_table_new_full(g_int_hash, g_direct_equal, g_free, g_object_unref);
44 /* Internal function: window closing stuff that is safe to call from either the
45 main thread or the Glk thread. */
47 trash_window_thread_independent(ChimaraGlkPrivate *glk_data, winid_t win)
49 win->magic = MAGIC_FREE;
51 g_list_foreach(win->history, (GFunc)g_free, NULL);
52 g_list_free(win->history);
54 g_string_free(win->buffer, TRUE);
55 g_hash_table_destroy(win->hyperlinks);
56 g_free(win->current_hyperlink);
60 /* Internal function: do all the stuff necessary to close a window. Call only
63 window_close_common(winid_t win, gboolean destroy_node)
65 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
67 if(glk_data->unregister_obj)
69 (*glk_data->unregister_obj)(win, gidisp_Class_Window, win->disprock);
70 win->disprock.ptr = NULL;
74 g_node_destroy(win->window_node);
76 trash_window_thread_independent(glk_data, win);
81 * @win: A window, or %NULL.
82 * @rockptr: Return location for the next window's rock, or %NULL.
84 * This function can be used to iterate through the list of all open windows
85 * (including pair windows.) See <link
86 * linkend="chimara-Iterating-Through-Opaque-Objects">Iterating Through Opaque
89 * As that section describes, the order in which windows are returned is
90 * arbitrary. The root window is not necessarily first, nor is it necessarily
93 * Returns: the next window, or %NULL if there are no more.
96 glk_window_iterate(winid_t win, glui32 *rockptr)
98 VALID_WINDOW_OR_NULL(win, return NULL);
100 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
104 retnode = glk_data->root_window;
107 GNode *node = win->window_node;
108 if( G_NODE_IS_LEAF(node) )
110 while(node && node->next == NULL)
113 retnode = node->next;
118 retnode = g_node_first_child(node);
120 winid_t retval = retnode? (winid_t)retnode->data : NULL;
122 /* Store the window's rock in rockptr */
123 if(retval && rockptr)
124 *rockptr = glk_window_get_rock(retval);
130 * glk_window_get_rock:
133 * Returns @win's rock value. Pair windows always have rock 0; all other windows
134 * return whatever rock value you created them with.
136 * Returns: A rock value.
139 glk_window_get_rock(winid_t win)
141 VALID_WINDOW(win, return 0);
146 * glk_window_get_type:
149 * Returns @win's type, one of %wintype_Blank, %wintype_Pair,
150 * %wintype_TextBuffer, %wintype_TextGrid, or %wintype_Graphics.
152 * Returns: The window's type.
155 glk_window_get_type(winid_t win)
157 VALID_WINDOW(win, return 0);
162 * glk_window_get_parent:
165 * Returns the window which is the parent of @win. If @win is the root window,
166 * this returns %NULL, since the root window has no parent. Remember that the
167 * parent of every window is a pair window; other window types are always
170 * Returns: A window, or %NULL.
173 glk_window_get_parent(winid_t win)
175 VALID_WINDOW(win, return NULL);
176 /* Value will also be NULL if win is the root window */
177 return (winid_t)win->window_node->parent->data;
181 * glk_window_get_sibling:
184 * Returns the other child of @win's parent. If @win is the root window, this
187 * Returns: A window, or %NULL.
190 glk_window_get_sibling(winid_t win)
192 VALID_WINDOW(win, return NULL);
194 if(G_NODE_IS_ROOT(win->window_node))
196 if(win->window_node->next)
197 return (winid_t)win->window_node->next;
198 return (winid_t)win->window_node->prev;
202 * glk_window_get_root:
204 * Returns the root window. If there are no windows, this returns %NULL.
206 * Returns: A window, or %NULL.
209 glk_window_get_root()
211 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
212 if(glk_data->root_window == NULL)
214 return (winid_t)glk_data->root_window->data;
219 * @split: The window to split to create the new window. Must be 0 if there
220 * are no windows yet.
221 * @method: Position of the new window and method of size computation. One of
222 * %winmethod_Above, %winmethod_Below, %winmethod_Left, or %winmethod_Right
223 * OR'ed with %winmethod_Fixed or %winmethod_Proportional. If @wintype is
224 * %wintype_Blank, then %winmethod_Fixed is not allowed.
225 * @size: Size of the new window, in percentage points if @method is
226 * %winmethod_Proportional, otherwise in characters if @wintype is
227 * %wintype_TextBuffer or %wintype_TextGrid, or pixels if @wintype is
229 * @wintype: Type of the new window. One of %wintype_Blank, %wintype_TextGrid,
230 * %wintype_TextBuffer, or %wintype_Graphics.
231 * @rock: The new window's rock value.
233 * Creates a new window. If there are no windows, the first three arguments are
234 * meaningless. @split <emphasis>must</emphasis> be 0, and @method and @size
235 * are ignored. @wintype is the type of window you're creating, and @rock is
236 * the rock (see <link linkend="chimara-Rocks">Rocks</link>).
238 * If any windows exist, new windows must be created by splitting existing
239 * ones. @split is the window you want to split; this <emphasis>must
240 * not</emphasis> be zero. @method is a mask of constants to specify the
241 * direction and the split method (see below). @size is the size of the split.
242 * @wintype is the type of window you're creating, and @rock is the rock.
244 * Remember that it is possible that the library will be unable to create a new
245 * window, in which case glk_window_open() will return %NULL.
248 * It is acceptable to gracefully exit, if the window you are creating is an
249 * important one — such as your first window. But you should not try to
250 * perform any window operation on the id until you have tested to make sure
254 * The examples we've seen so far have the simplest kind of size control. (Yes,
255 * this is <quote>below</quote>.) Every pair is a percentage split, with
258 * <mathphrase>X</mathphrase>
260 * percent going to one side, and
263 * <mathphrase>(100 - X)</mathphrase>
265 * percent going to the other side. If the player resizes the window, the whole
266 * mess expands, contracts, or stretches in a uniform way.
268 * As I said above, you can also make fixed-size splits. This is a little more
269 * complicated, because you have to know how this fixed size is measured.
271 * Sizes are measured in a way which is different for each window type. For
272 * example, a text grid window is measured by the size of its fixed-width font.
273 * You can make a text grid window which is fixed at a height of four rows, or
274 * ten columns. A text buffer window is measured by the size of its font.
277 * Remember that different windows may use different size fonts. Even two
278 * text grid windows may use fixed-size fonts of different sizes.
281 * Graphics windows are measured in pixels, not characters. Blank windows
282 * aren't measured at all; there's no meaningful way to measure them, and
283 * therefore you can't create a blank window of a fixed size, only of a
284 * proportional (percentage) size.
286 * So to create a text buffer window which takes the top 40% of the original
287 * window's space, you would execute
288 * |[ newwin = #glk_window_open(win, #winmethod_Above | #winmethod_Proportional, 40, #wintype_TextBuffer, 0); ]|
290 * To create a text grid which is always five lines high, at the bottom of the
291 * original window, you would do
292 * |[ newwin = #glk_window_open(win, #winmethod_Below | #winmethod_Fixed, 5, #wintype_TextGrid, 0); ]|
294 * Note that the meaning of the @size argument depends on the @method argument.
295 * If the method is %winmethod_Fixed, it also depends on the @wintype argument.
296 * The new window is then called the <quote>key window</quote> of this split,
297 * because its window type determines how the split size is computed.
300 * For %winmethod_Proportional splits, you can still call the new window the
301 * <quote>key window</quote>. But the key window is not important for
302 * proportional splits, because the size will always be computed as a simple
303 * ratio of the available space, not a fixed size of one child window.
306 * This system is more or less peachy as long as all the constraints work out.
307 * What happens when there is a conflict? The rules are simple. Size control
308 * always flows down the tree, and the player is at the top. Let's bring out an
310 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
311 * <entry><mediaobject><imageobject><imagedata fileref="fig5-7a.png"/>
312 * </imageobject></mediaobject></entry>
313 * <entry><mediaobject><textobject><literallayout class="monospaced">
319 * </literallayout></textobject></mediaobject></entry>
320 * </row></tbody></tgroup></informaltable>
322 * First we split A into A and B, with a 50% proportional split. Then we split
323 * A into A and C, with C above, C being a text grid window, and C gets a fixed
324 * size of two rows (as measured in its own font size). A gets whatever remains
325 * of the 50% it had before.
327 * Now the player stretches the window vertically.
328 * <informalfigure><mediaobject><imageobject><imagedata fileref="fig6.png"/>
329 * </imageobject></mediaobject></informalfigure>
331 * The library figures: the topmost split, the original A/B split, is 50-50. So
332 * B gets half the screen space, and the pair window next to it (the lower
333 * <quote>O</quote>) gets the other half. Then it looks at the lower
334 * <quote>O</quote>. C gets two rows; A gets the rest. All done.
336 * Then the user maliciously starts squeezing the window down, in stages:
337 * <informaltable frame="none"><tgroup cols="5"><tbody><row valign="top">
338 * <entry><mediaobject><imageobject><imagedata fileref="fig5-7a.png"/>
339 * </imageobject></mediaobject></entry>
340 * <entry><mediaobject><imageobject><imagedata fileref="fig7b.png"/>
341 * </imageobject></mediaobject></entry>
342 * <entry><mediaobject><imageobject><imagedata fileref="fig7c.png"/>
343 * </imageobject></mediaobject></entry>
344 * <entry><mediaobject><imageobject><imagedata fileref="fig7d.png"/>
345 * </imageobject></mediaobject></entry>
346 * <entry><mediaobject><imageobject><imagedata fileref="fig7e.png"/>
347 * </imageobject></mediaobject></entry>
348 * </row></tbody></tgroup></informaltable>
350 * The logic remains the same. B always gets half the space. At stage 3,
351 * there's no room left for A, so it winds up with zero height. Nothing
352 * displayed in A will be visible. At stage 4, there isn't even room in the
353 * upper 50% to give C its two rows; so it only gets one. Finally, C is
354 * squashed out of existence as well.
356 * When a window winds up undersized, it remembers what size it should be. In
357 * the example above, A remembers that it should be two rows; if the user
358 * expands the window to the original size, it would return to the original
361 * The downward flow of control is a bit harsh. After all, in stage 4, there's
362 * room for C to have its two rows if only B would give up some of its 50%. But
363 * this does not happen.
366 * This makes life much easier for the Glk library. To determine the
367 * configuration of a window, it only needs to look at the window's
368 * ancestors, never at its descendants. So window layout is a simple
369 * recursive algorithm, no backtracking.
372 * What happens when you split a fixed-size window? The resulting pair window
373 * — that is, the two new parts together — retain the same size
374 * constraint as the original window that was split. The key window for the
375 * original split is still the key window for that split, even though it's now
376 * a grandchild instead of a child.
378 * The easy, and correct, way to think about this is that the size constraint
379 * is stored by a window's parent, not the window itself; and a constraint
380 * consists of a pointer to a key window plus a size value.
382 * <informaltable frame="none"><tgroup cols="6"><tbody><row>
383 * <entry><mediaobject><imageobject><imagedata fileref="fig8a.png"/>
384 * </imageobject></mediaobject></entry>
385 * <entry><mediaobject><textobject><literallayout class="monospaced">
387 * </literallayout></textobject></mediaobject></entry>
388 * <entry><mediaobject><imageobject><imagedata fileref="fig8b.png"/>
389 * </imageobject></mediaobject></entry>
390 * <entry><mediaobject><textobject><literallayout class="monospaced">
394 * </literallayout></textobject></mediaobject></entry>
395 * <entry><mediaobject><imageobject><imagedata fileref="fig8c.png"/>
396 * </imageobject></mediaobject></entry>
397 * <entry><mediaobject><textobject><literallayout class="monospaced">
403 * </literallayout></textobject></mediaobject></entry>
404 * </row></tbody></tgroup></informaltable>
405 * After the first split, the new pair window (O1, which covers the whole
406 * screen) knows that its first child (A) is above the second, and gets 50% of
407 * its own area. (A is the key window for this split, but a proportional split
408 * doesn't care about key windows.)
410 * After the second split, all this remains true; O1 knows that its first child
411 * gets 50% of its space, and A is O1's key window. But now O1's first child is
412 * O2 instead of A. The newer pair window (O2) knows that its first child (C)
413 * is above the second, and gets a fixed size of two rows. (As measured in C's
414 * font, because C is O2's key window.)
416 * If we split C, now, the resulting pair will still be two C-font rows high
417 * — that is, tall enough for two lines of whatever font C displays. For
418 * the sake of example, we'll do this vertically.
419 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
420 * <entry><mediaobject><imageobject><imagedata fileref="fig9.png"/>
421 * </imageobject></mediaobject></entry>
422 * <entry><mediaobject><textobject><literallayout class="monospaced">
430 * </literallayout></textobject></mediaobject></entry>
431 * </row></tbody></tgroup></informaltable>
433 * O3 now knows that its children have a 50-50 left-right split. O2 is still
434 * committed to giving its upper child, O3, two C-font rows. Again, this is
435 * because C is O2's key window.
438 * This turns out to be a good idea, because it means that C, the text grid
439 * window, is still two rows high. If O3 had been a upper-lower split, things
440 * wouldn't work out so neatly. But the rules would still apply. If you don't
441 * like this, don't do it.
444 * Returns: the new window, or %NULL on error.
447 glk_window_open(winid_t split, glui32 method, glui32 size, glui32 wintype,
450 VALID_WINDOW_OR_NULL(split, return NULL);
451 g_return_val_if_fail(method == (method & (winmethod_DirMask | winmethod_DivisionMask)), NULL);
452 g_return_val_if_fail(!(((method & winmethod_DivisionMask) == winmethod_Proportional) && size > 100), NULL);
454 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
456 if(split == NULL && glk_data->root_window != NULL)
458 ILLEGAL("Tried to open a new root window, but there is already a root window");
464 /* Create the new window */
465 winid_t win = window_new_common(rock);
472 /* A blank window will be a label without any text */
473 GtkWidget *label = gtk_label_new("");
474 gtk_widget_show(label);
478 /* A blank window has no size */
480 win->unit_height = 0;
484 case wintype_TextGrid:
486 GtkWidget *textview = gtk_text_view_new();
487 GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(textview) );
489 gtk_text_view_set_wrap_mode( GTK_TEXT_VIEW(textview), GTK_WRAP_NONE );
490 gtk_text_view_set_editable( GTK_TEXT_VIEW(textview), FALSE );
491 gtk_widget_show(textview);
493 /* Create the styles available to the window stream */
494 style_init_textgrid(textbuffer);
495 gtk_widget_modify_font( textview, get_current_font(wintype) );
497 win->widget = textview;
498 win->frame = textview;
500 /* Determine the size of a "0" character in pixels */
501 PangoLayout *zero = gtk_widget_create_pango_layout(textview, "0");
502 pango_layout_set_font_description( zero, get_current_font(wintype) );
503 pango_layout_get_pixel_size(zero, &(win->unit_width), &(win->unit_height));
504 g_object_unref(zero);
505 /* width and height are set later */
507 /* Connect signal handlers */
508 win->char_input_keypress_handler = g_signal_connect(textview, "key-press-event", G_CALLBACK(on_char_input_key_press_event), win);
509 g_signal_handler_block(textview, win->char_input_keypress_handler);
510 win->line_input_keypress_handler = g_signal_connect(textview, "key-press-event", G_CALLBACK(on_line_input_key_press_event), win);
511 g_signal_handler_block(textview, win->line_input_keypress_handler);
515 case wintype_TextBuffer:
517 GtkWidget *scrolledwindow = gtk_scrolled_window_new(NULL, NULL);
518 GtkWidget *textview = gtk_text_view_new();
519 GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(textview) );
521 gtk_scrolled_window_set_policy( GTK_SCROLLED_WINDOW(scrolledwindow), GTK_POLICY_NEVER, GTK_POLICY_AUTOMATIC );
523 gtk_text_view_set_wrap_mode( GTK_TEXT_VIEW(textview), GTK_WRAP_WORD_CHAR );
524 gtk_text_view_set_editable( GTK_TEXT_VIEW(textview), FALSE );
525 gtk_text_view_set_pixels_inside_wrap( GTK_TEXT_VIEW(textview), 3 );
526 gtk_text_view_set_left_margin( GTK_TEXT_VIEW(textview), 20 );
527 gtk_text_view_set_right_margin( GTK_TEXT_VIEW(textview), 20 );
529 gtk_container_add( GTK_CONTAINER(scrolledwindow), textview );
530 gtk_widget_show_all(scrolledwindow);
532 /* Create the styles available to the window stream */
533 style_init_textbuffer(textbuffer);
534 gtk_widget_modify_font( textview, get_current_font(wintype) );
536 win->widget = textview;
537 win->frame = scrolledwindow;
539 /* Determine the size of a "0" character in pixels */
540 PangoLayout *zero = gtk_widget_create_pango_layout(textview, "0");
541 pango_layout_set_font_description( zero, get_current_font(wintype) );
542 pango_layout_get_pixel_size(zero, &(win->unit_width), &(win->unit_height));
543 g_object_unref(zero);
545 /* Connect signal handlers */
546 win->char_input_keypress_handler = g_signal_connect( textview, "key-press-event", G_CALLBACK(on_char_input_key_press_event), win );
547 g_signal_handler_block(textview, win->char_input_keypress_handler);
548 win->line_input_keypress_handler = g_signal_connect( textview, "key-press-event", G_CALLBACK(on_line_input_key_press_event), win );
549 g_signal_handler_block(textview, win->line_input_keypress_handler);
551 win->insert_text_handler = g_signal_connect_after( textbuffer, "insert-text", G_CALLBACK(after_window_insert_text), win );
552 g_signal_handler_block(textbuffer, win->insert_text_handler);
555 /* Create an editable tag to indicate uneditable parts of the window
557 gtk_text_buffer_create_tag(textbuffer, "uneditable", "editable", FALSE, "editable-set", TRUE, NULL);
559 /* Mark the position where the user will input text */
561 gtk_text_buffer_get_end_iter(textbuffer, &end);
562 gtk_text_buffer_create_mark(textbuffer, "input_position", &end, TRUE);
568 ILLEGAL_PARAM("Unknown window type: %u", wintype);
570 g_node_destroy(glk_data->root_window);
571 glk_data->root_window = NULL;
575 /* Set the minimum size to "as small as possible" so it doesn't depend on
576 the size of the window contents */
577 gtk_widget_set_size_request(win->widget, 0, 0);
578 gtk_widget_set_size_request(win->frame, 0, 0);
582 /* When splitting, construct a new parent window
583 * copying most characteristics from the window that is being split */
584 winid_t pair = window_new_common(0);
585 pair->type = wintype_Pair;
587 /* The pair window must know about its children's split method */
588 pair->key_window = win;
589 pair->split_method = method;
590 pair->constraint_size = size;
592 /* Insert the new window into the window tree */
593 if(split->window_node->parent == NULL)
594 glk_data->root_window = pair->window_node;
597 if( split->window_node == g_node_first_sibling(split->window_node) )
598 g_node_prepend(split->window_node->parent, pair->window_node);
600 g_node_append(split->window_node->parent, pair->window_node);
601 g_node_unlink(split->window_node);
603 /* Place the windows in the correct order */
604 switch(method & winmethod_DirMask)
607 case winmethod_Above:
608 g_node_append(pair->window_node, win->window_node);
609 g_node_append(pair->window_node, split->window_node);
611 case winmethod_Right:
612 case winmethod_Below:
613 g_node_append(pair->window_node, split->window_node);
614 g_node_append(pair->window_node, win->window_node);
619 /* Set the window as root window */
620 glk_data->root_window = win->window_node;
623 /* Set the window as a child of the Glk widget, don't trigger an arrange event */
624 g_mutex_lock(glk_data->arrange_lock);
625 glk_data->needs_rearrange = TRUE;
626 glk_data->ignore_next_arrange_event = TRUE;
627 g_mutex_unlock(glk_data->arrange_lock);
628 gtk_widget_set_parent(win->frame, GTK_WIDGET(glk_data->self));
629 gtk_widget_queue_resize(GTK_WIDGET(glk_data->self));
631 /* For text grid windows, fill the buffer with blanks. */
632 if(wintype == wintype_TextGrid)
634 /* Create the cursor position mark */
636 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
637 gtk_text_buffer_get_start_iter(buffer, &begin);
638 gtk_text_buffer_create_mark(buffer, "cursor_position", &begin, TRUE);
642 glk_window_clear(win);
646 /* Internal function: if node's key window is closing_win or one of its
647 children, set node's key window to NULL. */
649 remove_key_windows(GNode *node, winid_t closing_win)
651 winid_t win = (winid_t)node->data;
652 if(win->key_window && (win->key_window == closing_win || g_node_is_ancestor(closing_win->window_node, win->key_window->window_node)))
653 win->key_window = NULL;
654 return FALSE; /* Don't stop the traversal */
657 /* Internal function: destroy this window's GTK widgets, window streams,
658 and those of all its children. GDK threads must be locked. */
660 destroy_windows_below(winid_t win, stream_result_t *result)
665 case wintype_TextGrid:
666 case wintype_TextBuffer:
667 gtk_widget_unparent(win->frame);
671 destroy_windows_below(win->window_node->children->data, NULL);
672 destroy_windows_below(win->window_node->children->next->data, NULL);
676 ILLEGAL_PARAM("Unknown window type: %u", win->type);
679 stream_close_common(win->window_stream, result);
682 /* Internal function: free the winid_t structure of this window and those of all its children */
684 free_winids_below(winid_t win)
686 if(win->type == wintype_Pair) {
687 free_winids_below(win->window_node->children->data);
688 free_winids_below(win->window_node->children->next->data);
690 window_close_common(win, FALSE);
695 * @win: Window to close.
696 * @result: Pointer to a #stream_result_t in which to store the write count.
698 * Closes @win, which is pretty much exactly the opposite of opening a window.
699 * It is legal to close all your windows, or to close the root window (which is
702 * The @result argument is filled with the output character count of the window
703 * stream. See <link linkend="chimara-Streams">Streams</link> and <link
704 * linkend="chimara-Closing-Streams">Closing Streams</link>.
706 * When you close a window (and it is not the root window), the other window
707 * in its pair takes over all the freed-up area. Let's close D, in the current
709 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
710 * <entry><mediaobject><imageobject><imagedata fileref="fig10.png"/>
711 * </imageobject></mediaobject></entry>
712 * <entry><mediaobject><textobject><literallayout class="monospaced">
718 * </literallayout></textobject></mediaobject></entry>
719 * </row></tbody></tgroup></informaltable>
721 * Notice what has happened. D is gone. O3 is gone, and its 50-50 left-right
722 * split has gone with it. The other size constraints are unchanged; O2 is
723 * still committed to giving its upper child two rows, as measured in the font
724 * of O2's key window, which is C. Conveniently, O2's upper child is C, just as
725 * it was before we created D. In fact, now that D is gone, everything is back
726 * to the way it was before we created D.
728 * But what if we had closed C instead of D? We would have gotten this:
729 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
730 * <entry><mediaobject><imageobject><imagedata fileref="fig11.png"/>
731 * </imageobject></mediaobject></entry>
732 * <entry><mediaobject><textobject><literallayout class="monospaced">
738 * </literallayout></textobject></mediaobject></entry>
739 * </row></tbody></tgroup></informaltable>
741 * Again, O3 is gone. But D has collapsed to zero height. This is because its
742 * height is controlled by O2, and O2's key window was C, and C is now gone. O2
743 * no longer has a key window at all, so it cannot compute a height for its
744 * upper child, so it defaults to zero.
747 * This may seem to be an inconvenient choice. That is deliberate. You should
748 * not leave a pair window with no key, and the zero-height default reminds
749 * you not to. You can use glk_window_set_arrangement() to set a new split
750 * measurement and key window. See <link
751 * linkend="chimara-Changing-Window-Constraints">Changing Window
752 * Constraints</link>.
756 glk_window_close(winid_t win, stream_result_t *result)
758 VALID_WINDOW(win, return);
760 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
762 gdk_threads_enter(); /* Prevent redraw while we're trashing the window */
764 /* If any pair windows have this window or its children as a key window,
765 set their key window to NULL */
766 g_node_traverse(glk_data->root_window, G_IN_ORDER, G_TRAVERSE_NON_LEAVES, -1, (GNodeTraverseFunc)remove_key_windows, win);
768 /* Close all the window streams and destroy the widgets of this window
769 and below, before trashing the window tree */
770 destroy_windows_below(win, result);
772 /* Then free the winid_t structures below this node, but not this one itself */
773 if(win->type == wintype_Pair) {
774 free_winids_below(win->window_node->children->data);
775 free_winids_below(win->window_node->children->next->data);
777 /* So now we should be left with a skeleton tree hanging off this node */
779 /* Parent window changes from a split window into the sibling window */
780 /* The parent of any window is either a pair window or NULL */
781 GNode *pair_node = win->window_node->parent;
782 /* If win was not the root window: */
783 if(pair_node != NULL)
785 gboolean new_child_on_left = ( pair_node == g_node_first_sibling(pair_node) );
786 GNode *sibling_node = pair_node->children; /* only one child left */
787 GNode *new_parent_node = pair_node->parent;
788 g_node_unlink(pair_node);
789 g_node_unlink(sibling_node);
790 /* pair_node and sibling_node should now be totally unconnected to the tree */
792 if(new_parent_node == NULL)
794 glk_data->root_window = sibling_node;
798 if(new_child_on_left)
799 g_node_prepend(new_parent_node, sibling_node);
801 g_node_append(new_parent_node, sibling_node);
804 window_close_common( (winid_t) pair_node->data, TRUE);
806 else /* it was the root window */
808 glk_data->root_window = NULL;
811 window_close_common(win, FALSE);
813 /* Schedule a redraw */
814 g_mutex_lock(glk_data->arrange_lock);
815 glk_data->needs_rearrange = TRUE;
816 glk_data->ignore_next_arrange_event = TRUE;
817 g_mutex_unlock(glk_data->arrange_lock);
818 gtk_widget_queue_resize( GTK_WIDGET(glk_data->self) );
826 * Erases @win. The meaning of this depends on the window type.
829 * <term>Text buffer</term>
831 * This may do any number of things, such as delete all text in the window, or
832 * print enough blank lines to scroll all text beyond visibility, or insert a
833 * page-break marker which is treated specially by the display part of the
838 * <term>Text grid</term>
840 * This will clear the window, filling all positions with blanks. The window
841 * cursor is moved to the top left corner (position 0,0).
845 * <term>Graphics</term>
847 * Clears the entire window to its current background color. See <link
848 * linkend="chimara-Graphics-Windows">Graphics Windows</link>.
852 * <term>Other window types</term>
853 * <listitem><para>No effect.</para></listitem>
857 * It is illegal to erase a window which has line input pending.
860 glk_window_clear(winid_t win)
862 VALID_WINDOW(win, return);
863 g_return_if_fail(win->input_request_type != INPUT_REQUEST_LINE && win->input_request_type != INPUT_REQUEST_LINE_UNICODE);
865 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
874 case wintype_TextGrid:
875 /* fill the buffer with blanks */
877 /* Wait for the window's size to be updated */
878 g_mutex_lock(glk_data->arrange_lock);
879 if(glk_data->needs_rearrange)
880 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
881 g_mutex_unlock(glk_data->arrange_lock);
885 /* Manually put newlines at the end of each row of characters in the buffer; manual newlines make resizing the window's grid easier. */
886 gchar *blanks = g_strnfill(win->width, ' ');
887 gchar **blanklines = g_new0(gchar *, win->height + 1);
889 for(count = 0; count < win->height; count++)
890 blanklines[count] = blanks;
891 blanklines[win->height] = NULL;
892 gchar *text = g_strjoinv("\n", blanklines);
893 g_free(blanklines); /* not g_strfreev() */
896 GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
897 gtk_text_buffer_set_text(textbuffer, text, -1);
901 gtk_text_buffer_get_start_iter(textbuffer, &begin);
902 gtk_text_buffer_move_mark_by_name(textbuffer, "cursor_position", &begin);
908 case wintype_TextBuffer:
909 /* delete all text in the window */
913 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
914 GtkTextIter start, end;
915 gtk_text_buffer_get_bounds(buffer, &start, &end);
916 gtk_text_buffer_delete(buffer, &start, &end);
923 ILLEGAL_PARAM("Unknown window type: %d", win->type);
929 * @win: A window, or %NULL.
931 * Sets the current stream to @win's window stream. It is exactly equivalent to
932 * |[ #glk_stream_set_current(#glk_window_get_stream(@win)) ]|
933 * See <link linkend="chimara-Streams">Streams</link>.
935 * <note><title>Chimara</title>
937 * Although this is not mentioned in the specification, @win may also be
938 * %NULL, in which case the current stream is also set to %NULL.
942 glk_set_window(winid_t win)
944 VALID_WINDOW_OR_NULL(win, return);
946 glk_stream_set_current( glk_window_get_stream(win) );
948 glk_stream_set_current(NULL);
952 * glk_window_get_stream:
955 * Returns the stream which is associated with @win. (See <link
956 * linkend="chimara-Window-Streams">Window Streams</link>.) Every window has a
957 * stream which can be printed to, but this may not be useful, depending on the
961 * For example, printing to a blank window's stream has no effect.
964 * Returns: A window stream.
966 strid_t glk_window_get_stream(winid_t win)
968 VALID_WINDOW(win, return NULL);
969 return win->window_stream;
973 * glk_window_set_echo_stream:
975 * @str: A stream to attach to the window, or %NULL.
977 * Sets @win's echo stream to @str, which can be any valid output stream. You
978 * can reset a window to stop echoing by calling
979 * <code>#glk_window_set_echo_stream(@win, %NULL)</code>.
981 * It is illegal to set a window's echo stream to be its
982 * <emphasis>own</emphasis> window stream. That would create an infinite loop,
983 * and is nearly certain to crash the Glk library. It is similarly illegal to
984 * create a longer loop (two or more windows echoing to each other.)
987 glk_window_set_echo_stream(winid_t win, strid_t str)
989 VALID_WINDOW(win, return);
990 VALID_STREAM_OR_NULL(str, return);
992 /* Test for an infinite loop */
994 for(; next && next->type == STREAM_TYPE_WINDOW; next = next->window->echo_stream)
996 if(next == win->window_stream)
998 ILLEGAL("Infinite loop detected");
999 win->echo_stream = NULL;
1004 win->echo_stream = str;
1008 * glk_window_get_echo_stream:
1011 * Returns the echo stream of window @win. Initially, a window has no echo
1012 * stream, so <code>#glk_window_get_echo_stream(@win)</code> will return %NULL.
1014 * Returns: A stream, or %NULL.
1017 glk_window_get_echo_stream(winid_t win)
1019 VALID_WINDOW(win, return NULL);
1020 return win->echo_stream;
1024 * glk_window_get_size:
1026 * @widthptr: Pointer to a location to store the window's width, or %NULL.
1027 * @heightptr: Pointer to a location to store the window's height, or %NULL.
1029 * Simply returns the actual size of the window, in its measurement system.
1030 * As described in <link linkend="chimara-Other-API-Conventions">Other API
1031 * Conventions</link>, either @widthptr or @heightptr can be %NULL, if you
1032 * only want one measurement.
1034 * <note><para>Or, in fact, both, if you want to waste time.</para></note>
1037 glk_window_get_size(winid_t win, glui32 *widthptr, glui32 *heightptr)
1039 VALID_WINDOW(win, return);
1041 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
1047 if(widthptr != NULL)
1049 if(heightptr != NULL)
1053 case wintype_TextGrid:
1054 /* Wait until the window's size is current */
1055 g_mutex_lock(glk_data->arrange_lock);
1056 if(glk_data->needs_rearrange)
1057 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
1058 g_mutex_unlock(glk_data->arrange_lock);
1060 gdk_threads_enter();
1061 /* Cache the width and height */
1062 win->width = (glui32)(win->widget->allocation.width / win->unit_width);
1063 win->height = (glui32)(win->widget->allocation.height / win->unit_height);
1064 gdk_threads_leave();
1066 if(widthptr != NULL)
1067 *widthptr = win->width;
1068 if(heightptr != NULL)
1069 *heightptr = win->height;
1072 case wintype_TextBuffer:
1073 /* Wait until the window's size is current */
1074 g_mutex_lock(glk_data->arrange_lock);
1075 if(glk_data->needs_rearrange)
1076 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
1077 g_mutex_unlock(glk_data->arrange_lock);
1079 gdk_threads_enter();
1080 if(widthptr != NULL)
1081 *widthptr = (glui32)(win->widget->allocation.width / win->unit_width);
1082 if(heightptr != NULL)
1083 *heightptr = (glui32)(win->widget->allocation.height / win->unit_height);
1084 gdk_threads_leave();
1089 ILLEGAL_PARAM("Unknown window type: %u", win->type);
1094 * glk_window_set_arrangement:
1095 * @win: a pair window to rearrange.
1096 * @method: new method of size computation. One of %winmethod_Above,
1097 * %winmethod_Below, %winmethod_Left, or %winmethod_Right OR'ed with
1098 * %winmethod_Fixed or %winmethod_Proportional.
1099 * @size: new size constraint, in percentage points if @method is
1100 * %winmethod_Proportional, otherwise in characters if @win's type is
1101 * %wintype_TextBuffer or %wintype_TextGrid, or pixels if @win's type is
1102 * %wintype_Graphics.
1103 * @keywin: new key window, or %NULL to leave the key window unchanged.
1105 * Changes the size of an existing split — that is, it changes the
1106 * constraint of a given pair window.
1108 * Consider the example above, where D has collapsed to zero height. Say D was a
1109 * text buffer window. You could make a more useful layout by doing
1112 * o2 = #glk_window_get_parent(d);
1113 * glk_window_set_arrangement(o2, #winmethod_Above | #winmethod_Fixed, 3, d);
1115 * That would set D (the upper child of O2) to be O2's key window, and give it a
1116 * fixed size of 3 rows.
1118 * If you later wanted to expand D, you could do
1119 * |[ glk_window_set_arrangement(o2, #winmethod_Above | #winmethod_Fixed, 5, NULL); ]|
1120 * That expands D to five rows. Note that, since O2's key window is already set
1121 * to D, it is not necessary to provide the @keywin argument; you can pass %NULL
1122 * to mean <quote>leave the key window unchanged.</quote>
1124 * If you do change the key window of a pair window, the new key window
1125 * <emphasis>must</emphasis> be a descendant of that pair window. In the current
1126 * example, you could change O2's key window to be A, but not B. The key window
1127 * also cannot be a pair window itself.
1129 * |[ glk_window_set_arrangement(o2, #winmethod_Below | #winmethod_Fixed, 3, NULL); ]|
1130 * This changes the constraint to be on the <emphasis>lower</emphasis> child of
1131 * O2, which is A. The key window is still D; so A would then be three rows high
1132 * as measured in D's font, and D would get the rest of O2's space. That may not
1133 * be what you want. To set A to be three rows high as measured in A's font, you
1135 * |[ glk_window_set_arrangement(o2, #winmethod_Below | #winmethod_Fixed, 3, a); ]|
1137 * Or you could change O2 to a proportional split:
1138 * |[ glk_window_set_arrangement(o2, #winmethod_Below | #winmethod_Proportional, 30, NULL); ]|
1140 * |[ glk_window_set_arrangement(o2, #winmethod_Above | #winmethod_Proportional, 70, NULL); ]|
1141 * These do exactly the same thing, since 30% above is the same as
1142 * 70% below. You don't need to specify a key window with a proportional
1143 * split, so the @keywin argument is %NULL. (You could actually specify either A
1144 * or D as the key window, but it wouldn't affect the result.)
1146 * Whatever constraint you set, glk_window_get_size() will tell you the actual
1147 * window size you got.
1149 * Note that you can resize windows, but you can't flip or rotate them. You
1150 * can't move A above D, or change O2 to a vertical split where A is left or
1153 * To get this effect you could close one of the windows, and re-split the
1154 * other one with glk_window_open().
1158 glk_window_set_arrangement(winid_t win, glui32 method, glui32 size, winid_t keywin)
1160 VALID_WINDOW(win, return);
1161 VALID_WINDOW_OR_NULL(keywin, return);
1162 g_return_if_fail(win->type == wintype_Pair);
1165 g_return_if_fail(keywin->type != wintype_Pair);
1166 g_return_if_fail(g_node_is_ancestor(win->window_node, keywin->window_node));
1168 g_return_if_fail(method == (method & (winmethod_DirMask | winmethod_DivisionMask)));
1169 g_return_if_fail(!(((method & winmethod_DivisionMask) == winmethod_Proportional) && size > 100));
1171 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
1173 win->split_method = method;
1174 win->constraint_size = size;
1176 win->key_window = keywin;
1178 /* Tell GTK to rearrange the windows */
1179 gdk_threads_enter();
1180 g_mutex_lock(glk_data->arrange_lock);
1181 glk_data->needs_rearrange = TRUE;
1182 glk_data->ignore_next_arrange_event = TRUE;
1183 g_mutex_unlock(glk_data->arrange_lock);
1184 gtk_widget_queue_resize(GTK_WIDGET(glk_data->self));
1185 gdk_threads_leave();
1189 * glk_window_get_arrangement:
1190 * @win: a pair window.
1191 * @methodptr: return location for the constraint flags of @win, or %NULL.
1192 * @sizeptr: return location for the constraint size of @win, or %NULL.
1193 * @keywinptr: return location for the key window of @win, or %NULL.
1195 * Queries the constraint of a given pair window.
1198 glk_window_get_arrangement(winid_t win, glui32 *methodptr, glui32 *sizeptr, winid_t *keywinptr)
1200 VALID_WINDOW(win, return);
1201 g_return_if_fail(win->type == wintype_Pair);
1204 *methodptr = win->split_method;
1206 *sizeptr = win->constraint_size;
1208 *keywinptr = win->key_window;
1212 * glk_window_move_cursor:
1213 * @win: A text grid window.
1214 * @xpos: Horizontal cursor position.
1215 * @ypos: Vertical cursor position.
1217 * Sets the cursor position. If you move the cursor right past the end of a
1218 * line, it wraps; the next character which is printed will appear at the
1219 * beginning of the next line.
1221 * If you move the cursor below the last line, or when the cursor reaches the
1222 * end of the last line, it goes <quote>off the screen</quote> and further
1223 * output has no effect. You must call glk_window_move_cursor() or
1224 * glk_window_clear() to move the cursor back into the visible region.
1227 * Note that the arguments of glk_window_move_cursor() are <type>unsigned
1228 * int</type>s. This is okay, since there are no negative positions. If you try
1229 * to pass a negative value, Glk will interpret it as a huge positive value,
1230 * and it will wrap or go off the last line.
1234 * Also note that the output cursor is not necessarily visible. In particular,
1235 * when you are requesting line or character input in a grid window, you cannot
1236 * rely on the cursor position to prompt the player where input is indicated.
1237 * You should print some character prompt at that spot — a
1238 * <quote>></quote> character, for example.
1242 glk_window_move_cursor(winid_t win, glui32 xpos, glui32 ypos)
1244 VALID_WINDOW(win, return);
1245 g_return_if_fail(win->type == wintype_TextGrid);
1247 flush_window_buffer(win);
1249 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
1251 /* Wait until the window's size is current */
1252 g_mutex_lock(glk_data->arrange_lock);
1253 if(glk_data->needs_rearrange)
1254 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
1255 g_mutex_unlock(glk_data->arrange_lock);
1257 /* Don't do anything if the window is shrunk down to nothing */
1258 if(win->width == 0 || win->height == 0)
1261 /* Calculate actual position if cursor is moved past the right edge */
1262 if(xpos >= win->width)
1264 ypos += xpos / win->width;
1268 /* Go to the end if the cursor is moved off the bottom edge */
1269 if(ypos >= win->height)
1271 xpos = win->width - 1;
1272 ypos = win->height - 1;
1275 gdk_threads_enter();
1277 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
1279 /* There must actually be a character at xpos, or the following function will choke */
1280 gtk_text_buffer_get_iter_at_line_offset(buffer, &newpos, ypos, xpos);
1281 gtk_text_buffer_move_mark_by_name(buffer, "cursor_position", &newpos);
1283 gdk_threads_leave();