4 #include "chimara-glk-private.h"
6 extern GPrivate *glk_data_key;
10 * @win: A window, or %NULL.
11 * @rockptr: Return location for the next window's rock, or %NULL.
13 * This function can be used to iterate through the list of all open windows
14 * (including pair windows.) See <link
15 * linkend="chimara-Iterating-Through-Opaque-Objects">Iterating Through Opaque
18 * As that section describes, the order in which windows are returned is
19 * arbitrary. The root window is not necessarily first, nor is it necessarily
22 * Returns: the next window, or %NULL if there are no more.
25 glk_window_iterate(winid_t win, glui32 *rockptr)
27 VALID_WINDOW_OR_NULL(win, return NULL);
29 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
33 retnode = glk_data->root_window;
36 GNode *node = win->window_node;
37 if( G_NODE_IS_LEAF(node) )
39 while(node && node->next == NULL)
47 retnode = g_node_first_child(node);
49 winid_t retval = retnode? (winid_t)retnode->data : NULL;
51 /* Store the window's rock in rockptr */
53 *rockptr = glk_window_get_rock(retval);
59 * glk_window_get_rock:
62 * Returns @win's rock value. Pair windows always have rock 0; all other windows
63 * return whatever rock value you created them with.
65 * Returns: A rock value.
68 glk_window_get_rock(winid_t win)
70 VALID_WINDOW(win, return 0);
75 * glk_window_get_type:
78 * Returns @win's type, one of %wintype_Blank, %wintype_Pair,
79 * %wintype_TextBuffer, %wintype_TextGrid, or %wintype_Graphics.
81 * Returns: The window's type.
84 glk_window_get_type(winid_t win)
86 VALID_WINDOW(win, return 0);
91 * glk_window_get_parent:
94 * Returns the window which is the parent of @win. If @win is the root window,
95 * this returns %NULL, since the root window has no parent. Remember that the
96 * parent of every window is a pair window; other window types are always
99 * Returns: A window, or %NULL.
102 glk_window_get_parent(winid_t win)
104 VALID_WINDOW(win, return NULL);
105 /* Value will also be NULL if win is the root window */
106 return (winid_t)win->window_node->parent->data;
110 * glk_window_get_sibling:
113 * Returns the other child of @win's parent. If @win is the root window, this
116 * Returns: A window, or %NULL.
119 glk_window_get_sibling(winid_t win)
121 VALID_WINDOW(win, return NULL);
123 if(G_NODE_IS_ROOT(win->window_node))
125 if(win->window_node->next)
126 return (winid_t)win->window_node->next;
127 return (winid_t)win->window_node->prev;
131 * glk_window_get_root:
133 * Returns the root window. If there are no windows, this returns %NULL.
135 * Returns: A window, or %NULL.
138 glk_window_get_root()
140 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
141 if(glk_data->root_window == NULL)
143 return (winid_t)glk_data->root_window->data;
148 * @split: The window to split to create the new window. Must be 0 if there
149 * are no windows yet.
150 * @method: Position of the new window and method of size computation. One of
151 * %winmethod_Above, %winmethod_Below, %winmethod_Left, or %winmethod_Right
152 * OR'ed with %winmethod_Fixed or %winmethod_Proportional. If @wintype is
153 * %wintype_Blank, then %winmethod_Fixed is not allowed.
154 * @size: Size of the new window, in percentage points if @method is
155 * %winmethod_Proportional, otherwise in characters if @wintype is
156 * %wintype_TextBuffer or %wintype_TextGrid, or pixels if @wintype is
158 * @wintype: Type of the new window. One of %wintype_Blank, %wintype_TextGrid,
159 * %wintype_TextBuffer, or %wintype_Graphics.
160 * @rock: The new window's rock value.
162 * Creates a new window. If there are no windows, the first three arguments are
163 * meaningless. @split <emphasis>must</emphasis> be 0, and @method and @size
164 * are ignored. @wintype is the type of window you're creating, and @rock is
165 * the rock (see <link linkend="chimara-Rocks">Rocks</link>).
167 * If any windows exist, new windows must be created by splitting existing
168 * ones. @split is the window you want to split; this <emphasis>must
169 * not</emphasis> be zero. @method is a mask of constants to specify the
170 * direction and the split method (see below). @size is the size of the split.
171 * @wintype is the type of window you're creating, and @rock is the rock.
173 * Remember that it is possible that the library will be unable to create a new
174 * window, in which case glk_window_open() will return %NULL.
177 * It is acceptable to gracefully exit, if the window you are creating is an
178 * important one — such as your first window. But you should not try to
179 * perform any window operation on the id until you have tested to make sure
183 * The examples we've seen so far have the simplest kind of size control. (Yes,
184 * this is <quote>below</quote>.) Every pair is a percentage split, with
187 * <mathphrase>X</mathphrase>
189 * percent going to one side, and
192 * <mathphrase>(100 - X)</mathphrase>
194 * percent going to the other side. If the player resizes the window, the whole
195 * mess expands, contracts, or stretches in a uniform way.
197 * As I said above, you can also make fixed-size splits. This is a little more
198 * complicated, because you have to know how this fixed size is measured.
200 * Sizes are measured in a way which is different for each window type. For
201 * example, a text grid window is measured by the size of its fixed-width font.
202 * You can make a text grid window which is fixed at a height of four rows, or
203 * ten columns. A text buffer window is measured by the size of its font.
206 * Remember that different windows may use different size fonts. Even two
207 * text grid windows may use fixed-size fonts of different sizes.
210 * Graphics windows are measured in pixels, not characters. Blank windows
211 * aren't measured at all; there's no meaningful way to measure them, and
212 * therefore you can't create a blank window of a fixed size, only of a
213 * proportional (percentage) size.
215 * So to create a text buffer window which takes the top 40% of the original
216 * window's space, you would execute
217 * |[ newwin = #glk_window_open(win, #winmethod_Above | #winmethod_Proportional, 40, #wintype_TextBuffer, 0); ]|
219 * To create a text grid which is always five lines high, at the bottom of the
220 * original window, you would do
221 * |[ newwin = #glk_window_open(win, #winmethod_Below | #winmethod_Fixed, 5, #wintype_TextGrid, 0); ]|
223 * Note that the meaning of the @size argument depends on the @method argument.
224 * If the method is %winmethod_Fixed, it also depends on the @wintype argument.
225 * The new window is then called the <quote>key window</quote> of this split,
226 * because its window type determines how the split size is computed.
229 * For %winmethod_Proportional splits, you can still call the new window the
230 * <quote>key window</quote>. But the key window is not important for
231 * proportional splits, because the size will always be computed as a simple
232 * ratio of the available space, not a fixed size of one child window.
235 * This system is more or less peachy as long as all the constraints work out.
236 * What happens when there is a conflict? The rules are simple. Size control
237 * always flows down the tree, and the player is at the top. Let's bring out an
239 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
240 * <entry><mediaobject><imageobject><imagedata fileref="fig5-7a.png"/>
241 * </imageobject></mediaobject></entry>
242 * <entry><mediaobject><textobject><literallayout class="monospaced">
248 * </literallayout></textobject></mediaobject></entry>
249 * </row></tbody></tgroup></informaltable>
251 * First we split A into A and B, with a 50% proportional split. Then we split
252 * A into A and C, with C above, C being a text grid window, and C gets a fixed
253 * size of two rows (as measured in its own font size). A gets whatever remains
254 * of the 50% it had before.
256 * Now the player stretches the window vertically.
257 * <informalfigure><mediaobject><imageobject><imagedata fileref="fig6.png"/>
258 * </imageobject></mediaobject></informalfigure>
260 * The library figures: the topmost split, the original A/B split, is 50-50. So
261 * B gets half the screen space, and the pair window next to it (the lower
262 * <quote>O</quote>) gets the other half. Then it looks at the lower
263 * <quote>O</quote>. C gets two rows; A gets the rest. All done.
265 * Then the user maliciously starts squeezing the window down, in stages:
266 * <informaltable frame="none"><tgroup cols="5"><tbody><row valign="top">
267 * <entry><mediaobject><imageobject><imagedata fileref="fig5-7a.png"/>
268 * </imageobject></mediaobject></entry>
269 * <entry><mediaobject><imageobject><imagedata fileref="fig7b.png"/>
270 * </imageobject></mediaobject></entry>
271 * <entry><mediaobject><imageobject><imagedata fileref="fig7c.png"/>
272 * </imageobject></mediaobject></entry>
273 * <entry><mediaobject><imageobject><imagedata fileref="fig7d.png"/>
274 * </imageobject></mediaobject></entry>
275 * <entry><mediaobject><imageobject><imagedata fileref="fig7e.png"/>
276 * </imageobject></mediaobject></entry>
277 * </row></tbody></tgroup></informaltable>
279 * The logic remains the same. B always gets half the space. At stage 3,
280 * there's no room left for A, so it winds up with zero height. Nothing
281 * displayed in A will be visible. At stage 4, there isn't even room in the
282 * upper 50% to give C its two rows; so it only gets one. Finally, C is
283 * squashed out of existence as well.
285 * When a window winds up undersized, it remembers what size it should be. In
286 * the example above, A remembers that it should be two rows; if the user
287 * expands the window to the original size, it would return to the original
290 * The downward flow of control is a bit harsh. After all, in stage 4, there's
291 * room for C to have its two rows if only B would give up some of its 50%. But
292 * this does not happen.
295 * This makes life much easier for the Glk library. To determine the
296 * configuration of a window, it only needs to look at the window's
297 * ancestors, never at its descendants. So window layout is a simple
298 * recursive algorithm, no backtracking.
301 * What happens when you split a fixed-size window? The resulting pair window
302 * — that is, the two new parts together — retain the same size
303 * constraint as the original window that was split. The key window for the
304 * original split is still the key window for that split, even though it's now
305 * a grandchild instead of a child.
307 * The easy, and correct, way to think about this is that the size constraint
308 * is stored by a window's parent, not the window itself; and a constraint
309 * consists of a pointer to a key window plus a size value.
311 * <informaltable frame="none"><tgroup cols="6"><tbody><row>
312 * <entry><mediaobject><imageobject><imagedata fileref="fig8a.png"/>
313 * </imageobject></mediaobject></entry>
314 * <entry><mediaobject><textobject><literallayout class="monospaced">
316 * </literallayout></textobject></mediaobject></entry>
317 * <entry><mediaobject><imageobject><imagedata fileref="fig8b.png"/>
318 * </imageobject></mediaobject></entry>
319 * <entry><mediaobject><textobject><literallayout class="monospaced">
323 * </literallayout></textobject></mediaobject></entry>
324 * <entry><mediaobject><imageobject><imagedata fileref="fig8c.png"/>
325 * </imageobject></mediaobject></entry>
326 * <entry><mediaobject><textobject><literallayout class="monospaced">
332 * </literallayout></textobject></mediaobject></entry>
333 * </row></tbody></tgroup></informaltable>
334 * After the first split, the new pair window (O1, which covers the whole
335 * screen) knows that its first child (A) is above the second, and gets 50% of
336 * its own area. (A is the key window for this split, but a proportional split
337 * doesn't care about key windows.)
339 * After the second split, all this remains true; O1 knows that its first child
340 * gets 50% of its space, and A is O1's key window. But now O1's first child is
341 * O2 instead of A. The newer pair window (O2) knows that its first child (C)
342 * is above the second, and gets a fixed size of two rows. (As measured in C's
343 * font, because C is O2's key window.)
345 * If we split C, now, the resulting pair will still be two C-font rows high
346 * — that is, tall enough for two lines of whatever font C displays. For
347 * the sake of example, we'll do this vertically.
348 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
349 * <entry><mediaobject><imageobject><imagedata fileref="fig9.png"/>
350 * </imageobject></mediaobject></entry>
351 * <entry><mediaobject><textobject><literallayout class="monospaced">
359 * </literallayout></textobject></mediaobject></entry>
360 * </row></tbody></tgroup></informaltable>
362 * O3 now knows that its children have a 50-50 left-right split. O2 is still
363 * committed to giving its upper child, O3, two C-font rows. Again, this is
364 * because C is O2's key window.
367 * This turns out to be a good idea, because it means that C, the text grid
368 * window, is still two rows high. If O3 had been a upper-lower split, things
369 * wouldn't work out so neatly. But the rules would still apply. If you don't
370 * like this, don't do it.
373 * Returns: the new window, or %NULL on error.
376 glk_window_open(winid_t split, glui32 method, glui32 size, glui32 wintype,
379 VALID_WINDOW_OR_NULL(split, return NULL);
380 g_return_val_if_fail(method == (method & (winmethod_DirMask | winmethod_DivisionMask)), NULL);
381 g_return_val_if_fail(!(((method & winmethod_DivisionMask) == winmethod_Proportional) && size > 100), NULL);
383 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
385 if(split == NULL && glk_data->root_window != NULL)
387 ILLEGAL("Tried to open a new root window, but there is already a root window");
393 /* Create the new window */
394 winid_t win = g_new0(struct glk_window_struct, 1);
395 win->magic = MAGIC_WINDOW;
398 win->window_node = g_node_new(win);
404 /* A blank window will be a label without any text */
405 GtkWidget *label = gtk_label_new("");
406 gtk_widget_show(label);
410 /* A blank window has no size */
412 win->unit_height = 0;
413 /* You can print to a blank window's stream, but it does nothing */
414 win->window_stream = window_stream_new(win);
415 win->echo_stream = NULL;
419 case wintype_TextGrid:
421 GtkWidget *textview = gtk_text_view_new();
423 gtk_text_view_set_wrap_mode( GTK_TEXT_VIEW(textview), GTK_WRAP_NONE );
424 gtk_text_view_set_editable( GTK_TEXT_VIEW(textview), FALSE );
425 gtk_widget_show(textview);
427 /* Set the window's font */
428 gtk_widget_modify_font(textview, glk_data->monospace_font_desc);
430 win->widget = textview;
431 win->frame = textview;
433 /* Determine the size of a "0" character in pixels */
434 PangoLayout *zero = gtk_widget_create_pango_layout(textview, "0");
435 pango_layout_set_font_description(zero, glk_data->monospace_font_desc);
436 pango_layout_get_pixel_size(zero, &(win->unit_width), &(win->unit_height));
437 g_object_unref(zero);
439 /* Set the other parameters (width and height are set later) */
440 win->window_stream = window_stream_new(win);
441 win->echo_stream = NULL;
442 win->input_request_type = INPUT_REQUEST_NONE;
443 win->line_input_buffer = NULL;
444 win->line_input_buffer_unicode = NULL;
446 /* Connect signal handlers */
447 win->keypress_handler = g_signal_connect( G_OBJECT(textview), "key-press-event", G_CALLBACK(on_window_key_press_event), win );
448 g_signal_handler_block( G_OBJECT(textview), win->keypress_handler );
452 case wintype_TextBuffer:
454 GtkWidget *scrolledwindow = gtk_scrolled_window_new(NULL, NULL);
455 GtkWidget *textview = gtk_text_view_new();
456 GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(textview) );
458 gtk_scrolled_window_set_policy( GTK_SCROLLED_WINDOW(scrolledwindow), GTK_POLICY_NEVER, GTK_POLICY_AUTOMATIC );
460 gtk_text_view_set_wrap_mode( GTK_TEXT_VIEW(textview), GTK_WRAP_WORD_CHAR );
461 gtk_text_view_set_editable( GTK_TEXT_VIEW(textview), FALSE );
462 gtk_text_view_set_pixels_inside_wrap( GTK_TEXT_VIEW(textview), 3 );
463 gtk_text_view_set_left_margin( GTK_TEXT_VIEW(textview), 20 );
464 gtk_text_view_set_right_margin( GTK_TEXT_VIEW(textview), 20 );
466 gtk_container_add( GTK_CONTAINER(scrolledwindow), textview );
467 gtk_widget_show_all(scrolledwindow);
469 /* Set the window's font */
470 gtk_widget_modify_font(textview, glk_data->default_font_desc);
472 win->widget = textview;
473 win->frame = scrolledwindow;
475 /* Determine the size of a "0" character in pixels */
476 PangoLayout *zero = gtk_widget_create_pango_layout(textview, "0");
477 pango_layout_set_font_description(zero, glk_data->default_font_desc);
478 pango_layout_get_pixel_size(zero, &(win->unit_width), &(win->unit_height));
479 g_object_unref(zero);
481 /* Set the other parameters */
482 win->window_stream = window_stream_new(win);
483 win->echo_stream = NULL;
484 win->input_request_type = INPUT_REQUEST_NONE;
485 win->line_input_buffer = NULL;
486 win->line_input_buffer_unicode = NULL;
488 /* Connect signal handlers */
489 win->keypress_handler = g_signal_connect( G_OBJECT(textview), "key-press-event", G_CALLBACK(on_window_key_press_event), win );
490 g_signal_handler_block( G_OBJECT(textview), win->keypress_handler );
492 win->insert_text_handler = g_signal_connect_after( G_OBJECT(textbuffer), "insert-text", G_CALLBACK(after_window_insert_text), win );
493 g_signal_handler_block( G_OBJECT(textbuffer), win->insert_text_handler );
495 /* Create an editable tag to indicate uneditable parts of the window
497 gtk_text_buffer_create_tag(textbuffer, "uneditable", "editable", FALSE, "editable-set", TRUE, NULL);
499 /* Create the default styles available to the window stream */
500 style_init_textbuffer(textbuffer);
502 /* Mark the position where the user will input text */
504 gtk_text_buffer_get_end_iter(textbuffer, &end);
505 gtk_text_buffer_create_mark(textbuffer, "input_position", &end, TRUE);
511 ILLEGAL_PARAM("Unknown window type: %u", wintype);
513 g_node_destroy(glk_data->root_window);
514 glk_data->root_window = NULL;
518 /* Set the minimum size to "as small as possible" so it doesn't depend on
519 the size of the window contents */
520 gtk_widget_set_size_request(win->widget, 0, 0);
521 gtk_widget_set_size_request(win->frame, 0, 0);
525 /* When splitting, construct a new parent window
526 * copying most characteristics from the window that is being split */
527 winid_t pair = g_new0(struct glk_window_struct, 1);
528 pair->magic = MAGIC_WINDOW;
530 pair->type = wintype_Pair;
531 pair->window_node = g_node_new(pair);
532 /* You can print to a pair window's window stream, but it has no effect */
533 pair->window_stream = window_stream_new(pair);
534 pair->echo_stream = NULL;
536 /* The pair window must know about its children's split method */
537 pair->key_window = win;
538 pair->split_method = method;
539 pair->constraint_size = size;
541 /* Insert the new window into the window tree */
542 if(split->window_node->parent == NULL)
543 glk_data->root_window = pair->window_node;
546 if( split->window_node == g_node_first_sibling(split->window_node) )
547 g_node_prepend(split->window_node->parent, pair->window_node);
549 g_node_append(split->window_node->parent, pair->window_node);
550 g_node_unlink(split->window_node);
552 /* Place the windows in the correct order */
553 switch(method & winmethod_DirMask)
556 case winmethod_Above:
557 g_node_append(pair->window_node, win->window_node);
558 g_node_append(pair->window_node, split->window_node);
560 case winmethod_Right:
561 case winmethod_Below:
562 g_node_append(pair->window_node, split->window_node);
563 g_node_append(pair->window_node, win->window_node);
568 /* Set the window as root window */
569 glk_data->root_window = win->window_node;
572 /* Set the window as a child of the Glk widget, don't trigger an arrange event */
573 g_mutex_lock(glk_data->arrange_lock);
574 glk_data->needs_rearrange = TRUE;
575 glk_data->ignore_next_arrange_event = TRUE;
576 g_mutex_unlock(glk_data->arrange_lock);
577 gtk_widget_set_parent(win->frame, GTK_WIDGET(glk_data->self));
578 gtk_widget_queue_resize(GTK_WIDGET(glk_data->self));
580 /* For text grid windows, fill the buffer with blanks. */
581 if(wintype == wintype_TextGrid)
583 /* Create the cursor position mark */
585 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
586 gtk_text_buffer_get_start_iter(buffer, &begin);
587 gtk_text_buffer_create_mark(buffer, "cursor_position", &begin, TRUE);
591 glk_window_clear(win);
595 /* Internal function: if node's key window is closing_win or one of its
596 children, set node's key window to NULL. */
598 remove_key_windows(GNode *node, winid_t closing_win)
600 winid_t win = (winid_t)node->data;
601 if(win->key_window && (win->key_window == closing_win || g_node_is_ancestor(closing_win->window_node, win->key_window->window_node)))
602 win->key_window = NULL;
603 return FALSE; /* Don't stop the traversal */
606 /* Internal function: destroy this window's GTK widgets, window streams,
607 and those of all its children. GDK threads must be locked. */
609 destroy_windows_below(winid_t win, stream_result_t *result)
614 case wintype_TextGrid:
615 case wintype_TextBuffer:
616 gtk_widget_unparent(win->frame);
620 destroy_windows_below(win->window_node->children->data, NULL);
621 destroy_windows_below(win->window_node->children->next->data, NULL);
625 ILLEGAL_PARAM("Unknown window type: %u", win->type);
628 stream_close_common(win->window_stream, result);
631 /* Internal function: free the winid_t structure of this window and those of all its children */
633 free_winids_below(winid_t win)
635 if(win->type == wintype_Pair) {
636 free_winids_below(win->window_node->children->data);
637 free_winids_below(win->window_node->children->next->data);
639 win->magic = MAGIC_FREE;
645 * @win: Window to close.
646 * @result: Pointer to a #stream_result_t in which to store the write count.
648 * Closes @win, which is pretty much exactly the opposite of opening a window.
649 * It is legal to close all your windows, or to close the root window (which is
652 * The @result argument is filled with the output character count of the window
653 * stream. See <link linkend="chimara-Streams">Streams</link> and <link
654 * linkend="chimara-Closing-Streams">Closing Streams</link>.
656 * When you close a window (and it is not the root window), the other window
657 * in its pair takes over all the freed-up area. Let's close D, in the current
659 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
660 * <entry><mediaobject><imageobject><imagedata fileref="fig10.png"/>
661 * </imageobject></mediaobject></entry>
662 * <entry><mediaobject><textobject><literallayout class="monospaced">
668 * </literallayout></textobject></mediaobject></entry>
669 * </row></tbody></tgroup></informaltable>
671 * Notice what has happened. D is gone. O3 is gone, and its 50-50 left-right
672 * split has gone with it. The other size constraints are unchanged; O2 is
673 * still committed to giving its upper child two rows, as measured in the font
674 * of O2's key window, which is C. Conveniently, O2's upper child is C, just as
675 * it was before we created D. In fact, now that D is gone, everything is back
676 * to the way it was before we created D.
678 * But what if we had closed C instead of D? We would have gotten this:
679 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
680 * <entry><mediaobject><imageobject><imagedata fileref="fig11.png"/>
681 * </imageobject></mediaobject></entry>
682 * <entry><mediaobject><textobject><literallayout class="monospaced">
688 * </literallayout></textobject></mediaobject></entry>
689 * </row></tbody></tgroup></informaltable>
691 * Again, O3 is gone. But D has collapsed to zero height. This is because its
692 * height is controlled by O2, and O2's key window was C, and C is now gone. O2
693 * no longer has a key window at all, so it cannot compute a height for its
694 * upper child, so it defaults to zero.
697 * This may seem to be an inconvenient choice. That is deliberate. You should
698 * not leave a pair window with no key, and the zero-height default reminds
699 * you not to. You can use glk_window_set_arrangement() to set a new split
700 * measurement and key window. See <link
701 * linkend="chimara-Changing-Window-Constraints">Changing Window
702 * Constraints</link>.
706 glk_window_close(winid_t win, stream_result_t *result)
708 VALID_WINDOW(win, return);
710 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
712 gdk_threads_enter(); /* Prevent redraw while we're trashing the window */
714 /* If any pair windows have this window or its children as a key window,
715 set their key window to NULL */
716 g_node_traverse(glk_data->root_window, G_IN_ORDER, G_TRAVERSE_NON_LEAVES, -1, (GNodeTraverseFunc)remove_key_windows, win);
718 /* Close all the window streams and destroy the widgets of this window
719 and below, before trashing the window tree */
720 destroy_windows_below(win, result);
722 /* Then free the winid_t structures below this node, but not this one itself */
723 if(win->type == wintype_Pair) {
724 free_winids_below(win->window_node->children->data);
725 free_winids_below(win->window_node->children->next->data);
727 /* So now we should be left with a skeleton tree hanging off this node */
729 /* Parent window changes from a split window into the sibling window */
730 /* The parent of any window is either a pair window or NULL */
731 GNode *pair_node = win->window_node->parent;
732 g_node_destroy(win->window_node);
733 /* If win was not the root window: */
734 if(pair_node != NULL)
736 gboolean new_child_on_left = ( pair_node == g_node_first_sibling(pair_node) );
737 GNode *sibling_node = pair_node->children; /* only one child left */
738 GNode *new_parent_node = pair_node->parent;
739 g_node_unlink(pair_node);
740 g_node_unlink(sibling_node);
741 /* pair_node and sibling_node should now be totally unconnected to the tree */
743 if(new_parent_node == NULL)
745 glk_data->root_window = sibling_node;
749 if(new_child_on_left)
750 g_node_prepend(new_parent_node, sibling_node);
752 g_node_append(new_parent_node, sibling_node);
755 winid_t pair = (winid_t) pair_node->data;
756 g_node_destroy(pair_node);
758 pair->magic = MAGIC_FREE;
761 else /* it was the root window */
763 glk_data->root_window = NULL;
766 win->magic = MAGIC_FREE;
769 /* Schedule a redraw */
770 g_mutex_lock(glk_data->arrange_lock);
771 glk_data->needs_rearrange = TRUE;
772 glk_data->ignore_next_arrange_event = TRUE;
773 g_mutex_unlock(glk_data->arrange_lock);
774 gtk_widget_queue_resize( GTK_WIDGET(glk_data->self) );
782 * Erases @win. The meaning of this depends on the window type.
785 * <term>Text buffer</term>
787 * This may do any number of things, such as delete all text in the window, or
788 * print enough blank lines to scroll all text beyond visibility, or insert a
789 * page-break marker which is treated specially by the display part of the
794 * <term>Text grid</term>
796 * This will clear the window, filling all positions with blanks. The window
797 * cursor is moved to the top left corner (position 0,0).
801 * <term>Graphics</term>
803 * Clears the entire window to its current background color. See <link
804 * linkend="chimara-Graphics-Windows">Graphics Windows</link>.
808 * <term>Other window types</term>
809 * <listitem><para>No effect.</para></listitem>
813 * It is illegal to erase a window which has line input pending.
816 glk_window_clear(winid_t win)
818 VALID_WINDOW(win, return);
819 g_return_if_fail(win->input_request_type != INPUT_REQUEST_LINE && win->input_request_type != INPUT_REQUEST_LINE_UNICODE);
821 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
830 case wintype_TextGrid:
831 /* fill the buffer with blanks */
833 /* Wait for the window's size to be updated */
834 g_mutex_lock(glk_data->arrange_lock);
835 if(glk_data->needs_rearrange)
836 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
837 g_mutex_unlock(glk_data->arrange_lock);
841 /* Manually put newlines at the end of each row of characters in the buffer; manual newlines make resizing the window's grid easier. */
842 gchar *blanks = g_strnfill(win->width, ' ');
843 gchar **blanklines = g_new0(gchar *, win->height + 1);
845 for(count = 0; count < win->height; count++)
846 blanklines[count] = blanks;
847 blanklines[win->height] = NULL;
848 gchar *text = g_strjoinv("\n", blanklines);
849 g_free(blanklines); /* not g_strfreev() */
852 GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
853 gtk_text_buffer_set_text(textbuffer, text, -1);
857 gtk_text_buffer_get_start_iter(textbuffer, &begin);
858 gtk_text_buffer_move_mark_by_name(textbuffer, "cursor_position", &begin);
864 case wintype_TextBuffer:
865 /* delete all text in the window */
869 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
870 GtkTextIter start, end;
871 gtk_text_buffer_get_bounds(buffer, &start, &end);
872 gtk_text_buffer_delete(buffer, &start, &end);
879 ILLEGAL_PARAM("Unknown window type: %d", win->type);
887 * Sets the current stream to @win's window stream. It is exactly equivalent to
888 * |[ #glk_stream_set_current(#glk_window_get_stream(@win)) ]|
889 * See <link linkend="chimara-Streams">Streams</link>.
892 glk_set_window(winid_t win)
894 VALID_WINDOW(win, return);
895 glk_stream_set_current( glk_window_get_stream(win) );
899 * glk_window_get_stream:
902 * Returns the stream which is associated with @win. (See <link
903 * linkend="chimara-Window-Streams">Window Streams</link>.) Every window has a
904 * stream which can be printed to, but this may not be useful, depending on the
908 * For example, printing to a blank window's stream has no effect.
911 * Returns: A window stream.
913 strid_t glk_window_get_stream(winid_t win)
915 VALID_WINDOW(win, return NULL);
916 return win->window_stream;
920 * glk_window_set_echo_stream:
922 * @str: A stream to attach to the window, or %NULL.
924 * Sets @win's echo stream to @str, which can be any valid output stream. You
925 * can reset a window to stop echoing by calling
926 * <code>#glk_window_set_echo_stream(@win, %NULL)</code>.
928 * It is illegal to set a window's echo stream to be its
929 * <emphasis>own</emphasis> window stream. That would create an infinite loop,
930 * and is nearly certain to crash the Glk library. It is similarly illegal to
931 * create a longer loop (two or more windows echoing to each other.)
934 glk_window_set_echo_stream(winid_t win, strid_t str)
936 VALID_WINDOW(win, return);
937 VALID_STREAM_OR_NULL(str, return);
939 /* Test for an infinite loop */
941 for(; next && next->type == STREAM_TYPE_WINDOW; next = next->window->echo_stream)
943 if(next == win->window_stream)
945 ILLEGAL("Infinite loop detected");
946 win->echo_stream = NULL;
951 win->echo_stream = str;
955 * glk_window_get_echo_stream:
958 * Returns the echo stream of window @win. Initially, a window has no echo
959 * stream, so <code>#glk_window_get_echo_stream(@win)</code> will return %NULL.
961 * Returns: A stream, or %NULL.
964 glk_window_get_echo_stream(winid_t win)
966 VALID_WINDOW(win, return NULL);
967 return win->echo_stream;
971 * glk_window_get_size:
973 * @widthptr: Pointer to a location to store the window's width, or %NULL.
974 * @heightptr: Pointer to a location to store the window's height, or %NULL.
976 * Simply returns the actual size of the window, in its measurement system.
977 * As described in <link linkend="chimara-Other-API-Conventions">Other API
978 * Conventions</link>, either @widthptr or @heightptr can be %NULL, if you
979 * only want one measurement.
981 * <note><para>Or, in fact, both, if you want to waste time.</para></note>
984 glk_window_get_size(winid_t win, glui32 *widthptr, glui32 *heightptr)
986 VALID_WINDOW(win, return);
988 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
996 if(heightptr != NULL)
1000 case wintype_TextGrid:
1001 /* Wait until the window's size is current */
1002 g_mutex_lock(glk_data->arrange_lock);
1003 if(glk_data->needs_rearrange)
1004 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
1005 g_mutex_unlock(glk_data->arrange_lock);
1007 gdk_threads_enter();
1008 /* Cache the width and height */
1009 win->width = (glui32)(win->widget->allocation.width / win->unit_width);
1010 win->height = (glui32)(win->widget->allocation.height / win->unit_height);
1011 gdk_threads_leave();
1013 if(widthptr != NULL)
1014 *widthptr = win->width;
1015 if(heightptr != NULL)
1016 *heightptr = win->height;
1019 case wintype_TextBuffer:
1020 /* Wait until the window's size is current */
1021 g_mutex_lock(glk_data->arrange_lock);
1022 if(glk_data->needs_rearrange)
1023 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
1024 g_mutex_unlock(glk_data->arrange_lock);
1026 gdk_threads_enter();
1027 if(widthptr != NULL)
1028 *widthptr = (glui32)(win->widget->allocation.width / win->unit_width);
1029 if(heightptr != NULL)
1030 *heightptr = (glui32)(win->widget->allocation.height / win->unit_height);
1031 gdk_threads_leave();
1036 ILLEGAL_PARAM("Unknown window type: %u", win->type);
1041 * glk_window_set_arrangement:
1042 * @win: a pair window to rearrange.
1043 * @method: new method of size computation. One of %winmethod_Above,
1044 * %winmethod_Below, %winmethod_Left, or %winmethod_Right OR'ed with
1045 * %winmethod_Fixed or %winmethod_Proportional.
1046 * @size: new size constraint, in percentage points if @method is
1047 * %winmethod_Proportional, otherwise in characters if @win's type is
1048 * %wintype_TextBuffer or %wintype_TextGrid, or pixels if @win's type is
1049 * %wintype_Graphics.
1050 * @keywin: new key window, or %NULL to leave the key window unchanged.
1052 * Changes the size of an existing split — that is, it changes the
1053 * constraint of a given pair window.
1055 * Consider the example above, where D has collapsed to zero height. Say D was a
1056 * text buffer window. You could make a more useful layout by doing
1059 * o2 = #glk_window_get_parent(d);
1060 * glk_window_set_arrangement(o2, #winmethod_Above | #winmethod_Fixed, 3, d);
1062 * That would set D (the upper child of O2) to be O2's key window, and give it a
1063 * fixed size of 3 rows.
1065 * If you later wanted to expand D, you could do
1066 * |[ glk_window_set_arrangement(o2, #winmethod_Above | #winmethod_Fixed, 5, NULL); ]|
1067 * That expands D to five rows. Note that, since O2's key window is already set
1068 * to D, it is not necessary to provide the @keywin argument; you can pass %NULL
1069 * to mean <quote>leave the key window unchanged.</quote>
1071 * If you do change the key window of a pair window, the new key window
1072 * <emphasis>must</emphasis> be a descendant of that pair window. In the current
1073 * example, you could change O2's key window to be A, but not B. The key window
1074 * also cannot be a pair window itself.
1076 * |[ glk_window_set_arrangement(o2, #winmethod_Below | #winmethod_Fixed, 3, NULL); ]|
1077 * This changes the constraint to be on the <emphasis>lower</emphasis> child of
1078 * O2, which is A. The key window is still D; so A would then be three rows high
1079 * as measured in D's font, and D would get the rest of O2's space. That may not
1080 * be what you want. To set A to be three rows high as measured in A's font, you
1082 * |[ glk_window_set_arrangement(o2, #winmethod_Below | #winmethod_Fixed, 3, a); ]|
1084 * Or you could change O2 to a proportional split:
1085 * |[ glk_window_set_arrangement(o2, #winmethod_Below | #winmethod_Proportional, 30, NULL); ]|
1087 * |[ glk_window_set_arrangement(o2, #winmethod_Above | #winmethod_Proportional, 70, NULL); ]|
1088 * These do exactly the same thing, since 30% above is the same as
1089 * 70% below. You don't need to specify a key window with a proportional
1090 * split, so the @keywin argument is %NULL. (You could actually specify either A
1091 * or D as the key window, but it wouldn't affect the result.)
1093 * Whatever constraint you set, glk_window_get_size() will tell you the actual
1094 * window size you got.
1096 * Note that you can resize windows, but you can't flip or rotate them. You
1097 * can't move A above D, or change O2 to a vertical split where A is left or
1100 * To get this effect you could close one of the windows, and re-split the
1101 * other one with glk_window_open().
1105 glk_window_set_arrangement(winid_t win, glui32 method, glui32 size, winid_t keywin)
1107 VALID_WINDOW(win, return);
1108 VALID_WINDOW_OR_NULL(keywin, return);
1109 g_return_if_fail(win->type == wintype_Pair);
1112 g_return_if_fail(keywin->type != wintype_Pair);
1113 g_return_if_fail(g_node_is_ancestor(win->window_node, keywin->window_node));
1115 g_return_if_fail(method == (method & (winmethod_DirMask | winmethod_DivisionMask)));
1116 g_return_if_fail(!(((method & winmethod_DivisionMask) == winmethod_Proportional) && size > 100));
1118 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
1120 win->split_method = method;
1121 win->constraint_size = size;
1123 win->key_window = keywin;
1125 /* Tell GTK to rearrange the windows */
1126 gdk_threads_enter();
1127 g_mutex_lock(glk_data->arrange_lock);
1128 glk_data->needs_rearrange = TRUE;
1129 glk_data->ignore_next_arrange_event = TRUE;
1130 g_mutex_unlock(glk_data->arrange_lock);
1131 gtk_widget_queue_resize(GTK_WIDGET(glk_data->self));
1132 gdk_threads_leave();
1136 * glk_window_get_arrangement:
1137 * @win: a pair window.
1138 * @methodptr: return location for the constraint flags of @win, or %NULL.
1139 * @sizeptr: return location for the constraint size of @win, or %NULL.
1140 * @keywinptr: return location for the key window of @win, or %NULL.
1142 * Queries the constraint of a given pair window.
1145 glk_window_get_arrangement(winid_t win, glui32 *methodptr, glui32 *sizeptr, winid_t *keywinptr)
1147 VALID_WINDOW(win, return);
1148 g_return_if_fail(win->type == wintype_Pair);
1151 *methodptr = win->split_method;
1153 *sizeptr = win->constraint_size;
1155 *keywinptr = win->key_window;
1159 * glk_window_move_cursor:
1160 * @win: A text grid window.
1161 * @xpos: Horizontal cursor position.
1162 * @ypos: Vertical cursor position.
1164 * Sets the cursor position. If you move the cursor right past the end of a
1165 * line, it wraps; the next character which is printed will appear at the
1166 * beginning of the next line.
1168 * If you move the cursor below the last line, or when the cursor reaches the
1169 * end of the last line, it goes <quote>off the screen</quote> and further
1170 * output has no effect. You must call glk_window_move_cursor() or
1171 * glk_window_clear() to move the cursor back into the visible region.
1174 * Note that the arguments of glk_window_move_cursor() are <type>unsigned
1175 * int</type>s. This is okay, since there are no negative positions. If you try
1176 * to pass a negative value, Glk will interpret it as a huge positive value,
1177 * and it will wrap or go off the last line.
1181 * Also note that the output cursor is not necessarily visible. In particular,
1182 * when you are requesting line or character input in a grid window, you cannot
1183 * rely on the cursor position to prompt the player where input is indicated.
1184 * You should print some character prompt at that spot — a
1185 * <quote>></quote> character, for example.
1189 glk_window_move_cursor(winid_t win, glui32 xpos, glui32 ypos)
1191 VALID_WINDOW(win, return);
1192 g_return_if_fail(win->type == wintype_TextGrid);
1194 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
1196 /* Wait until the window's size is current */
1197 g_mutex_lock(glk_data->arrange_lock);
1198 if(glk_data->needs_rearrange)
1199 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
1200 g_mutex_unlock(glk_data->arrange_lock);
1202 /* Don't do anything if the window is shrunk down to nothing */
1203 if(win->width == 0 || win->height == 0)
1206 /* Calculate actual position if cursor is moved past the right edge */
1207 if(xpos >= win->width)
1209 ypos += xpos / win->width;
1212 /* Go to the end if the cursor is moved off the bottom edge */
1213 if(ypos >= win->height)
1215 xpos = win->width - 1;
1216 ypos = win->height - 1;
1219 gdk_threads_enter();
1221 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
1223 /* There must actually be a character at xpos, or the following function will choke */
1224 gtk_text_buffer_get_iter_at_line_offset(buffer, &newpos, ypos, xpos);
1225 gtk_text_buffer_move_mark_by_name(buffer, "cursor_position", &newpos);
1227 gdk_threads_leave();