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;
38 window_close_common(winid_t win)
40 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
42 if(glk_data->unregister_obj)
44 (*glk_data->unregister_obj)(win, gidisp_Class_Window, win->disprock);
45 win->disprock.ptr = NULL;
48 g_node_destroy(win->window_node);
49 win->magic = MAGIC_FREE;
55 * @win: A window, or %NULL.
56 * @rockptr: Return location for the next window's rock, or %NULL.
58 * This function can be used to iterate through the list of all open windows
59 * (including pair windows.) See <link
60 * linkend="chimara-Iterating-Through-Opaque-Objects">Iterating Through Opaque
63 * As that section describes, the order in which windows are returned is
64 * arbitrary. The root window is not necessarily first, nor is it necessarily
67 * Returns: the next window, or %NULL if there are no more.
70 glk_window_iterate(winid_t win, glui32 *rockptr)
72 VALID_WINDOW_OR_NULL(win, return NULL);
74 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
78 retnode = glk_data->root_window;
81 GNode *node = win->window_node;
82 if( G_NODE_IS_LEAF(node) )
84 while(node && node->next == NULL)
92 retnode = g_node_first_child(node);
94 winid_t retval = retnode? (winid_t)retnode->data : NULL;
96 /* Store the window's rock in rockptr */
98 *rockptr = glk_window_get_rock(retval);
104 * glk_window_get_rock:
107 * Returns @win's rock value. Pair windows always have rock 0; all other windows
108 * return whatever rock value you created them with.
110 * Returns: A rock value.
113 glk_window_get_rock(winid_t win)
115 VALID_WINDOW(win, return 0);
120 * glk_window_get_type:
123 * Returns @win's type, one of %wintype_Blank, %wintype_Pair,
124 * %wintype_TextBuffer, %wintype_TextGrid, or %wintype_Graphics.
126 * Returns: The window's type.
129 glk_window_get_type(winid_t win)
131 VALID_WINDOW(win, return 0);
136 * glk_window_get_parent:
139 * Returns the window which is the parent of @win. If @win is the root window,
140 * this returns %NULL, since the root window has no parent. Remember that the
141 * parent of every window is a pair window; other window types are always
144 * Returns: A window, or %NULL.
147 glk_window_get_parent(winid_t win)
149 VALID_WINDOW(win, return NULL);
150 /* Value will also be NULL if win is the root window */
151 return (winid_t)win->window_node->parent->data;
155 * glk_window_get_sibling:
158 * Returns the other child of @win's parent. If @win is the root window, this
161 * Returns: A window, or %NULL.
164 glk_window_get_sibling(winid_t win)
166 VALID_WINDOW(win, return NULL);
168 if(G_NODE_IS_ROOT(win->window_node))
170 if(win->window_node->next)
171 return (winid_t)win->window_node->next;
172 return (winid_t)win->window_node->prev;
176 * glk_window_get_root:
178 * Returns the root window. If there are no windows, this returns %NULL.
180 * Returns: A window, or %NULL.
183 glk_window_get_root()
185 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
186 if(glk_data->root_window == NULL)
188 return (winid_t)glk_data->root_window->data;
193 * @split: The window to split to create the new window. Must be 0 if there
194 * are no windows yet.
195 * @method: Position of the new window and method of size computation. One of
196 * %winmethod_Above, %winmethod_Below, %winmethod_Left, or %winmethod_Right
197 * OR'ed with %winmethod_Fixed or %winmethod_Proportional. If @wintype is
198 * %wintype_Blank, then %winmethod_Fixed is not allowed.
199 * @size: Size of the new window, in percentage points if @method is
200 * %winmethod_Proportional, otherwise in characters if @wintype is
201 * %wintype_TextBuffer or %wintype_TextGrid, or pixels if @wintype is
203 * @wintype: Type of the new window. One of %wintype_Blank, %wintype_TextGrid,
204 * %wintype_TextBuffer, or %wintype_Graphics.
205 * @rock: The new window's rock value.
207 * Creates a new window. If there are no windows, the first three arguments are
208 * meaningless. @split <emphasis>must</emphasis> be 0, and @method and @size
209 * are ignored. @wintype is the type of window you're creating, and @rock is
210 * the rock (see <link linkend="chimara-Rocks">Rocks</link>).
212 * If any windows exist, new windows must be created by splitting existing
213 * ones. @split is the window you want to split; this <emphasis>must
214 * not</emphasis> be zero. @method is a mask of constants to specify the
215 * direction and the split method (see below). @size is the size of the split.
216 * @wintype is the type of window you're creating, and @rock is the rock.
218 * Remember that it is possible that the library will be unable to create a new
219 * window, in which case glk_window_open() will return %NULL.
222 * It is acceptable to gracefully exit, if the window you are creating is an
223 * important one — such as your first window. But you should not try to
224 * perform any window operation on the id until you have tested to make sure
228 * The examples we've seen so far have the simplest kind of size control. (Yes,
229 * this is <quote>below</quote>.) Every pair is a percentage split, with
232 * <mathphrase>X</mathphrase>
234 * percent going to one side, and
237 * <mathphrase>(100 - X)</mathphrase>
239 * percent going to the other side. If the player resizes the window, the whole
240 * mess expands, contracts, or stretches in a uniform way.
242 * As I said above, you can also make fixed-size splits. This is a little more
243 * complicated, because you have to know how this fixed size is measured.
245 * Sizes are measured in a way which is different for each window type. For
246 * example, a text grid window is measured by the size of its fixed-width font.
247 * You can make a text grid window which is fixed at a height of four rows, or
248 * ten columns. A text buffer window is measured by the size of its font.
251 * Remember that different windows may use different size fonts. Even two
252 * text grid windows may use fixed-size fonts of different sizes.
255 * Graphics windows are measured in pixels, not characters. Blank windows
256 * aren't measured at all; there's no meaningful way to measure them, and
257 * therefore you can't create a blank window of a fixed size, only of a
258 * proportional (percentage) size.
260 * So to create a text buffer window which takes the top 40% of the original
261 * window's space, you would execute
262 * |[ newwin = #glk_window_open(win, #winmethod_Above | #winmethod_Proportional, 40, #wintype_TextBuffer, 0); ]|
264 * To create a text grid which is always five lines high, at the bottom of the
265 * original window, you would do
266 * |[ newwin = #glk_window_open(win, #winmethod_Below | #winmethod_Fixed, 5, #wintype_TextGrid, 0); ]|
268 * Note that the meaning of the @size argument depends on the @method argument.
269 * If the method is %winmethod_Fixed, it also depends on the @wintype argument.
270 * The new window is then called the <quote>key window</quote> of this split,
271 * because its window type determines how the split size is computed.
274 * For %winmethod_Proportional splits, you can still call the new window the
275 * <quote>key window</quote>. But the key window is not important for
276 * proportional splits, because the size will always be computed as a simple
277 * ratio of the available space, not a fixed size of one child window.
280 * This system is more or less peachy as long as all the constraints work out.
281 * What happens when there is a conflict? The rules are simple. Size control
282 * always flows down the tree, and the player is at the top. Let's bring out an
284 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
285 * <entry><mediaobject><imageobject><imagedata fileref="fig5-7a.png"/>
286 * </imageobject></mediaobject></entry>
287 * <entry><mediaobject><textobject><literallayout class="monospaced">
293 * </literallayout></textobject></mediaobject></entry>
294 * </row></tbody></tgroup></informaltable>
296 * First we split A into A and B, with a 50% proportional split. Then we split
297 * A into A and C, with C above, C being a text grid window, and C gets a fixed
298 * size of two rows (as measured in its own font size). A gets whatever remains
299 * of the 50% it had before.
301 * Now the player stretches the window vertically.
302 * <informalfigure><mediaobject><imageobject><imagedata fileref="fig6.png"/>
303 * </imageobject></mediaobject></informalfigure>
305 * The library figures: the topmost split, the original A/B split, is 50-50. So
306 * B gets half the screen space, and the pair window next to it (the lower
307 * <quote>O</quote>) gets the other half. Then it looks at the lower
308 * <quote>O</quote>. C gets two rows; A gets the rest. All done.
310 * Then the user maliciously starts squeezing the window down, in stages:
311 * <informaltable frame="none"><tgroup cols="5"><tbody><row valign="top">
312 * <entry><mediaobject><imageobject><imagedata fileref="fig5-7a.png"/>
313 * </imageobject></mediaobject></entry>
314 * <entry><mediaobject><imageobject><imagedata fileref="fig7b.png"/>
315 * </imageobject></mediaobject></entry>
316 * <entry><mediaobject><imageobject><imagedata fileref="fig7c.png"/>
317 * </imageobject></mediaobject></entry>
318 * <entry><mediaobject><imageobject><imagedata fileref="fig7d.png"/>
319 * </imageobject></mediaobject></entry>
320 * <entry><mediaobject><imageobject><imagedata fileref="fig7e.png"/>
321 * </imageobject></mediaobject></entry>
322 * </row></tbody></tgroup></informaltable>
324 * The logic remains the same. B always gets half the space. At stage 3,
325 * there's no room left for A, so it winds up with zero height. Nothing
326 * displayed in A will be visible. At stage 4, there isn't even room in the
327 * upper 50% to give C its two rows; so it only gets one. Finally, C is
328 * squashed out of existence as well.
330 * When a window winds up undersized, it remembers what size it should be. In
331 * the example above, A remembers that it should be two rows; if the user
332 * expands the window to the original size, it would return to the original
335 * The downward flow of control is a bit harsh. After all, in stage 4, there's
336 * room for C to have its two rows if only B would give up some of its 50%. But
337 * this does not happen.
340 * This makes life much easier for the Glk library. To determine the
341 * configuration of a window, it only needs to look at the window's
342 * ancestors, never at its descendants. So window layout is a simple
343 * recursive algorithm, no backtracking.
346 * What happens when you split a fixed-size window? The resulting pair window
347 * — that is, the two new parts together — retain the same size
348 * constraint as the original window that was split. The key window for the
349 * original split is still the key window for that split, even though it's now
350 * a grandchild instead of a child.
352 * The easy, and correct, way to think about this is that the size constraint
353 * is stored by a window's parent, not the window itself; and a constraint
354 * consists of a pointer to a key window plus a size value.
356 * <informaltable frame="none"><tgroup cols="6"><tbody><row>
357 * <entry><mediaobject><imageobject><imagedata fileref="fig8a.png"/>
358 * </imageobject></mediaobject></entry>
359 * <entry><mediaobject><textobject><literallayout class="monospaced">
361 * </literallayout></textobject></mediaobject></entry>
362 * <entry><mediaobject><imageobject><imagedata fileref="fig8b.png"/>
363 * </imageobject></mediaobject></entry>
364 * <entry><mediaobject><textobject><literallayout class="monospaced">
368 * </literallayout></textobject></mediaobject></entry>
369 * <entry><mediaobject><imageobject><imagedata fileref="fig8c.png"/>
370 * </imageobject></mediaobject></entry>
371 * <entry><mediaobject><textobject><literallayout class="monospaced">
377 * </literallayout></textobject></mediaobject></entry>
378 * </row></tbody></tgroup></informaltable>
379 * After the first split, the new pair window (O1, which covers the whole
380 * screen) knows that its first child (A) is above the second, and gets 50% of
381 * its own area. (A is the key window for this split, but a proportional split
382 * doesn't care about key windows.)
384 * After the second split, all this remains true; O1 knows that its first child
385 * gets 50% of its space, and A is O1's key window. But now O1's first child is
386 * O2 instead of A. The newer pair window (O2) knows that its first child (C)
387 * is above the second, and gets a fixed size of two rows. (As measured in C's
388 * font, because C is O2's key window.)
390 * If we split C, now, the resulting pair will still be two C-font rows high
391 * — that is, tall enough for two lines of whatever font C displays. For
392 * the sake of example, we'll do this vertically.
393 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
394 * <entry><mediaobject><imageobject><imagedata fileref="fig9.png"/>
395 * </imageobject></mediaobject></entry>
396 * <entry><mediaobject><textobject><literallayout class="monospaced">
404 * </literallayout></textobject></mediaobject></entry>
405 * </row></tbody></tgroup></informaltable>
407 * O3 now knows that its children have a 50-50 left-right split. O2 is still
408 * committed to giving its upper child, O3, two C-font rows. Again, this is
409 * because C is O2's key window.
412 * This turns out to be a good idea, because it means that C, the text grid
413 * window, is still two rows high. If O3 had been a upper-lower split, things
414 * wouldn't work out so neatly. But the rules would still apply. If you don't
415 * like this, don't do it.
418 * Returns: the new window, or %NULL on error.
421 glk_window_open(winid_t split, glui32 method, glui32 size, glui32 wintype,
424 VALID_WINDOW_OR_NULL(split, return NULL);
425 g_return_val_if_fail(method == (method & (winmethod_DirMask | winmethod_DivisionMask)), NULL);
426 g_return_val_if_fail(!(((method & winmethod_DivisionMask) == winmethod_Proportional) && size > 100), NULL);
428 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
430 if(split == NULL && glk_data->root_window != NULL)
432 ILLEGAL("Tried to open a new root window, but there is already a root window");
438 /* Create the new window */
439 winid_t win = window_new_common(rock);
446 /* A blank window will be a label without any text */
447 GtkWidget *label = gtk_label_new("");
448 gtk_widget_show(label);
452 /* A blank window has no size */
454 win->unit_height = 0;
458 case wintype_TextGrid:
460 GtkWidget *textview = gtk_text_view_new();
461 GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(textview) );
463 gtk_text_view_set_wrap_mode( GTK_TEXT_VIEW(textview), GTK_WRAP_NONE );
464 gtk_text_view_set_editable( GTK_TEXT_VIEW(textview), FALSE );
465 gtk_widget_show(textview);
467 /* Set the window's font */
468 gtk_widget_modify_font(textview, glk_data->monospace_font_desc);
470 win->widget = textview;
471 win->frame = textview;
473 /* Determine the size of a "0" character in pixels */
474 PangoLayout *zero = gtk_widget_create_pango_layout(textview, "0");
475 pango_layout_set_font_description(zero, glk_data->monospace_font_desc);
476 pango_layout_get_pixel_size(zero, &(win->unit_width), &(win->unit_height));
477 g_object_unref(zero);
478 /* width and height are set later */
480 /* Connect signal handlers */
481 win->keypress_handler = g_signal_connect( G_OBJECT(textview), "key-press-event", G_CALLBACK(on_window_key_press_event), win );
482 g_signal_handler_block( G_OBJECT(textview), win->keypress_handler );
484 /* Create the styles available to the window stream */
485 style_init_textgrid(textbuffer);
489 case wintype_TextBuffer:
491 GtkWidget *scrolledwindow = gtk_scrolled_window_new(NULL, NULL);
492 GtkWidget *textview = gtk_text_view_new();
493 GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(textview) );
495 gtk_scrolled_window_set_policy( GTK_SCROLLED_WINDOW(scrolledwindow), GTK_POLICY_NEVER, GTK_POLICY_AUTOMATIC );
497 gtk_text_view_set_wrap_mode( GTK_TEXT_VIEW(textview), GTK_WRAP_WORD_CHAR );
498 gtk_text_view_set_editable( GTK_TEXT_VIEW(textview), FALSE );
499 gtk_text_view_set_pixels_inside_wrap( GTK_TEXT_VIEW(textview), 3 );
500 gtk_text_view_set_left_margin( GTK_TEXT_VIEW(textview), 20 );
501 gtk_text_view_set_right_margin( GTK_TEXT_VIEW(textview), 20 );
503 gtk_container_add( GTK_CONTAINER(scrolledwindow), textview );
504 gtk_widget_show_all(scrolledwindow);
506 /* Set the window's font */
507 gtk_widget_modify_font(textview, glk_data->default_font_desc);
509 win->widget = textview;
510 win->frame = scrolledwindow;
512 /* Determine the size of a "0" character in pixels */
513 PangoLayout *zero = gtk_widget_create_pango_layout(textview, "0");
514 pango_layout_set_font_description(zero, glk_data->default_font_desc);
515 pango_layout_get_pixel_size(zero, &(win->unit_width), &(win->unit_height));
516 g_object_unref(zero);
518 /* Connect signal handlers */
519 win->keypress_handler = g_signal_connect( G_OBJECT(textview), "key-press-event", G_CALLBACK(on_window_key_press_event), win );
520 g_signal_handler_block( G_OBJECT(textview), win->keypress_handler );
522 win->insert_text_handler = g_signal_connect_after( G_OBJECT(textbuffer), "insert-text", G_CALLBACK(after_window_insert_text), win );
523 g_signal_handler_block( G_OBJECT(textbuffer), win->insert_text_handler );
525 /* Create an editable tag to indicate uneditable parts of the window
527 gtk_text_buffer_create_tag(textbuffer, "uneditable", "editable", FALSE, "editable-set", TRUE, NULL);
529 /* Create the styles available to the window stream */
530 style_init_textbuffer(textbuffer);
532 /* Mark the position where the user will input text */
534 gtk_text_buffer_get_end_iter(textbuffer, &end);
535 gtk_text_buffer_create_mark(textbuffer, "input_position", &end, TRUE);
541 ILLEGAL_PARAM("Unknown window type: %u", wintype);
543 g_node_destroy(glk_data->root_window);
544 glk_data->root_window = NULL;
548 /* Set the minimum size to "as small as possible" so it doesn't depend on
549 the size of the window contents */
550 gtk_widget_set_size_request(win->widget, 0, 0);
551 gtk_widget_set_size_request(win->frame, 0, 0);
555 /* When splitting, construct a new parent window
556 * copying most characteristics from the window that is being split */
557 winid_t pair = window_new_common(0);
558 pair->type = wintype_Pair;
560 /* The pair window must know about its children's split method */
561 pair->key_window = win;
562 pair->split_method = method;
563 pair->constraint_size = size;
565 /* Insert the new window into the window tree */
566 if(split->window_node->parent == NULL)
567 glk_data->root_window = pair->window_node;
570 if( split->window_node == g_node_first_sibling(split->window_node) )
571 g_node_prepend(split->window_node->parent, pair->window_node);
573 g_node_append(split->window_node->parent, pair->window_node);
574 g_node_unlink(split->window_node);
576 /* Place the windows in the correct order */
577 switch(method & winmethod_DirMask)
580 case winmethod_Above:
581 g_node_append(pair->window_node, win->window_node);
582 g_node_append(pair->window_node, split->window_node);
584 case winmethod_Right:
585 case winmethod_Below:
586 g_node_append(pair->window_node, split->window_node);
587 g_node_append(pair->window_node, win->window_node);
592 /* Set the window as root window */
593 glk_data->root_window = win->window_node;
596 /* Set the window as a child of the Glk widget, don't trigger an arrange event */
597 g_mutex_lock(glk_data->arrange_lock);
598 glk_data->needs_rearrange = TRUE;
599 glk_data->ignore_next_arrange_event = TRUE;
600 g_mutex_unlock(glk_data->arrange_lock);
601 gtk_widget_set_parent(win->frame, GTK_WIDGET(glk_data->self));
602 gtk_widget_queue_resize(GTK_WIDGET(glk_data->self));
604 /* For text grid windows, fill the buffer with blanks. */
605 if(wintype == wintype_TextGrid)
607 /* Create the cursor position mark */
609 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
610 gtk_text_buffer_get_start_iter(buffer, &begin);
611 gtk_text_buffer_create_mark(buffer, "cursor_position", &begin, TRUE);
615 glk_window_clear(win);
619 /* Internal function: if node's key window is closing_win or one of its
620 children, set node's key window to NULL. */
622 remove_key_windows(GNode *node, winid_t closing_win)
624 winid_t win = (winid_t)node->data;
625 if(win->key_window && (win->key_window == closing_win || g_node_is_ancestor(closing_win->window_node, win->key_window->window_node)))
626 win->key_window = NULL;
627 return FALSE; /* Don't stop the traversal */
630 /* Internal function: destroy this window's GTK widgets, window streams,
631 and those of all its children. GDK threads must be locked. */
633 destroy_windows_below(winid_t win, stream_result_t *result)
638 case wintype_TextGrid:
639 case wintype_TextBuffer:
640 gtk_widget_unparent(win->frame);
644 destroy_windows_below(win->window_node->children->data, NULL);
645 destroy_windows_below(win->window_node->children->next->data, NULL);
649 ILLEGAL_PARAM("Unknown window type: %u", win->type);
652 stream_close_common(win->window_stream, result);
655 /* Internal function: free the winid_t structure of this window and those of all its children */
657 free_winids_below(winid_t win)
659 if(win->type == wintype_Pair) {
660 free_winids_below(win->window_node->children->data);
661 free_winids_below(win->window_node->children->next->data);
663 window_close_common(win);
668 * @win: Window to close.
669 * @result: Pointer to a #stream_result_t in which to store the write count.
671 * Closes @win, which is pretty much exactly the opposite of opening a window.
672 * It is legal to close all your windows, or to close the root window (which is
675 * The @result argument is filled with the output character count of the window
676 * stream. See <link linkend="chimara-Streams">Streams</link> and <link
677 * linkend="chimara-Closing-Streams">Closing Streams</link>.
679 * When you close a window (and it is not the root window), the other window
680 * in its pair takes over all the freed-up area. Let's close D, in the current
682 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
683 * <entry><mediaobject><imageobject><imagedata fileref="fig10.png"/>
684 * </imageobject></mediaobject></entry>
685 * <entry><mediaobject><textobject><literallayout class="monospaced">
691 * </literallayout></textobject></mediaobject></entry>
692 * </row></tbody></tgroup></informaltable>
694 * Notice what has happened. D is gone. O3 is gone, and its 50-50 left-right
695 * split has gone with it. The other size constraints are unchanged; O2 is
696 * still committed to giving its upper child two rows, as measured in the font
697 * of O2's key window, which is C. Conveniently, O2's upper child is C, just as
698 * it was before we created D. In fact, now that D is gone, everything is back
699 * to the way it was before we created D.
701 * But what if we had closed C instead of D? We would have gotten this:
702 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
703 * <entry><mediaobject><imageobject><imagedata fileref="fig11.png"/>
704 * </imageobject></mediaobject></entry>
705 * <entry><mediaobject><textobject><literallayout class="monospaced">
711 * </literallayout></textobject></mediaobject></entry>
712 * </row></tbody></tgroup></informaltable>
714 * Again, O3 is gone. But D has collapsed to zero height. This is because its
715 * height is controlled by O2, and O2's key window was C, and C is now gone. O2
716 * no longer has a key window at all, so it cannot compute a height for its
717 * upper child, so it defaults to zero.
720 * This may seem to be an inconvenient choice. That is deliberate. You should
721 * not leave a pair window with no key, and the zero-height default reminds
722 * you not to. You can use glk_window_set_arrangement() to set a new split
723 * measurement and key window. See <link
724 * linkend="chimara-Changing-Window-Constraints">Changing Window
725 * Constraints</link>.
729 glk_window_close(winid_t win, stream_result_t *result)
731 VALID_WINDOW(win, return);
733 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
735 gdk_threads_enter(); /* Prevent redraw while we're trashing the window */
737 /* If any pair windows have this window or its children as a key window,
738 set their key window to NULL */
739 g_node_traverse(glk_data->root_window, G_IN_ORDER, G_TRAVERSE_NON_LEAVES, -1, (GNodeTraverseFunc)remove_key_windows, win);
741 /* Close all the window streams and destroy the widgets of this window
742 and below, before trashing the window tree */
743 destroy_windows_below(win, result);
745 /* Then free the winid_t structures below this node, but not this one itself */
746 if(win->type == wintype_Pair) {
747 free_winids_below(win->window_node->children->data);
748 free_winids_below(win->window_node->children->next->data);
750 /* So now we should be left with a skeleton tree hanging off this node */
752 /* Parent window changes from a split window into the sibling window */
753 /* The parent of any window is either a pair window or NULL */
754 GNode *pair_node = win->window_node->parent;
755 /* If win was not the root window: */
756 if(pair_node != NULL)
758 gboolean new_child_on_left = ( pair_node == g_node_first_sibling(pair_node) );
759 GNode *sibling_node = pair_node->children; /* only one child left */
760 GNode *new_parent_node = pair_node->parent;
761 g_node_unlink(pair_node);
762 g_node_unlink(sibling_node);
763 /* pair_node and sibling_node should now be totally unconnected to the tree */
765 if(new_parent_node == NULL)
767 glk_data->root_window = sibling_node;
771 if(new_child_on_left)
772 g_node_prepend(new_parent_node, sibling_node);
774 g_node_append(new_parent_node, sibling_node);
777 window_close_common( (winid_t) pair_node->data );
779 else /* it was the root window */
781 glk_data->root_window = NULL;
784 window_close_common(win);
786 /* Schedule a redraw */
787 g_mutex_lock(glk_data->arrange_lock);
788 glk_data->needs_rearrange = TRUE;
789 glk_data->ignore_next_arrange_event = TRUE;
790 g_mutex_unlock(glk_data->arrange_lock);
791 gtk_widget_queue_resize( GTK_WIDGET(glk_data->self) );
799 * Erases @win. The meaning of this depends on the window type.
802 * <term>Text buffer</term>
804 * This may do any number of things, such as delete all text in the window, or
805 * print enough blank lines to scroll all text beyond visibility, or insert a
806 * page-break marker which is treated specially by the display part of the
811 * <term>Text grid</term>
813 * This will clear the window, filling all positions with blanks. The window
814 * cursor is moved to the top left corner (position 0,0).
818 * <term>Graphics</term>
820 * Clears the entire window to its current background color. See <link
821 * linkend="chimara-Graphics-Windows">Graphics Windows</link>.
825 * <term>Other window types</term>
826 * <listitem><para>No effect.</para></listitem>
830 * It is illegal to erase a window which has line input pending.
833 glk_window_clear(winid_t win)
835 VALID_WINDOW(win, return);
836 g_return_if_fail(win->input_request_type != INPUT_REQUEST_LINE && win->input_request_type != INPUT_REQUEST_LINE_UNICODE);
838 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
847 case wintype_TextGrid:
848 /* fill the buffer with blanks */
850 /* Wait for the window's size to be updated */
851 g_mutex_lock(glk_data->arrange_lock);
852 if(glk_data->needs_rearrange)
853 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
854 g_mutex_unlock(glk_data->arrange_lock);
858 /* Manually put newlines at the end of each row of characters in the buffer; manual newlines make resizing the window's grid easier. */
859 gchar *blanks = g_strnfill(win->width, ' ');
860 gchar **blanklines = g_new0(gchar *, win->height + 1);
862 for(count = 0; count < win->height; count++)
863 blanklines[count] = blanks;
864 blanklines[win->height] = NULL;
865 gchar *text = g_strjoinv("\n", blanklines);
866 g_free(blanklines); /* not g_strfreev() */
869 GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
870 gtk_text_buffer_set_text(textbuffer, text, -1);
874 gtk_text_buffer_get_start_iter(textbuffer, &begin);
875 gtk_text_buffer_move_mark_by_name(textbuffer, "cursor_position", &begin);
881 case wintype_TextBuffer:
882 /* delete all text in the window */
886 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
887 GtkTextIter start, end;
888 gtk_text_buffer_get_bounds(buffer, &start, &end);
889 gtk_text_buffer_delete(buffer, &start, &end);
896 ILLEGAL_PARAM("Unknown window type: %d", win->type);
902 * @win: A window, or %NULL.
904 * Sets the current stream to @win's window stream. It is exactly equivalent to
905 * |[ #glk_stream_set_current(#glk_window_get_stream(@win)) ]|
906 * See <link linkend="chimara-Streams">Streams</link>.
908 * <note><title>Chimara</title>
910 * Although this is not mentioned in the specification, @win may also be
911 * %NULL, in which case the current stream is also set to %NULL.
915 glk_set_window(winid_t win)
917 VALID_WINDOW_OR_NULL(win, return);
919 glk_stream_set_current( glk_window_get_stream(win) );
921 glk_stream_set_current(NULL);
925 * glk_window_get_stream:
928 * Returns the stream which is associated with @win. (See <link
929 * linkend="chimara-Window-Streams">Window Streams</link>.) Every window has a
930 * stream which can be printed to, but this may not be useful, depending on the
934 * For example, printing to a blank window's stream has no effect.
937 * Returns: A window stream.
939 strid_t glk_window_get_stream(winid_t win)
941 VALID_WINDOW(win, return NULL);
942 return win->window_stream;
946 * glk_window_set_echo_stream:
948 * @str: A stream to attach to the window, or %NULL.
950 * Sets @win's echo stream to @str, which can be any valid output stream. You
951 * can reset a window to stop echoing by calling
952 * <code>#glk_window_set_echo_stream(@win, %NULL)</code>.
954 * It is illegal to set a window's echo stream to be its
955 * <emphasis>own</emphasis> window stream. That would create an infinite loop,
956 * and is nearly certain to crash the Glk library. It is similarly illegal to
957 * create a longer loop (two or more windows echoing to each other.)
960 glk_window_set_echo_stream(winid_t win, strid_t str)
962 VALID_WINDOW(win, return);
963 VALID_STREAM_OR_NULL(str, return);
965 /* Test for an infinite loop */
967 for(; next && next->type == STREAM_TYPE_WINDOW; next = next->window->echo_stream)
969 if(next == win->window_stream)
971 ILLEGAL("Infinite loop detected");
972 win->echo_stream = NULL;
977 win->echo_stream = str;
981 * glk_window_get_echo_stream:
984 * Returns the echo stream of window @win. Initially, a window has no echo
985 * stream, so <code>#glk_window_get_echo_stream(@win)</code> will return %NULL.
987 * Returns: A stream, or %NULL.
990 glk_window_get_echo_stream(winid_t win)
992 VALID_WINDOW(win, return NULL);
993 return win->echo_stream;
997 * glk_window_get_size:
999 * @widthptr: Pointer to a location to store the window's width, or %NULL.
1000 * @heightptr: Pointer to a location to store the window's height, or %NULL.
1002 * Simply returns the actual size of the window, in its measurement system.
1003 * As described in <link linkend="chimara-Other-API-Conventions">Other API
1004 * Conventions</link>, either @widthptr or @heightptr can be %NULL, if you
1005 * only want one measurement.
1007 * <note><para>Or, in fact, both, if you want to waste time.</para></note>
1010 glk_window_get_size(winid_t win, glui32 *widthptr, glui32 *heightptr)
1012 VALID_WINDOW(win, return);
1014 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
1020 if(widthptr != NULL)
1022 if(heightptr != NULL)
1026 case wintype_TextGrid:
1027 /* Wait until the window's size is current */
1028 g_mutex_lock(glk_data->arrange_lock);
1029 if(glk_data->needs_rearrange)
1030 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
1031 g_mutex_unlock(glk_data->arrange_lock);
1033 gdk_threads_enter();
1034 /* Cache the width and height */
1035 win->width = (glui32)(win->widget->allocation.width / win->unit_width);
1036 win->height = (glui32)(win->widget->allocation.height / win->unit_height);
1037 gdk_threads_leave();
1039 if(widthptr != NULL)
1040 *widthptr = win->width;
1041 if(heightptr != NULL)
1042 *heightptr = win->height;
1045 case wintype_TextBuffer:
1046 /* Wait until the window's size is current */
1047 g_mutex_lock(glk_data->arrange_lock);
1048 if(glk_data->needs_rearrange)
1049 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
1050 g_mutex_unlock(glk_data->arrange_lock);
1052 gdk_threads_enter();
1053 if(widthptr != NULL)
1054 *widthptr = (glui32)(win->widget->allocation.width / win->unit_width);
1055 if(heightptr != NULL)
1056 *heightptr = (glui32)(win->widget->allocation.height / win->unit_height);
1057 gdk_threads_leave();
1062 ILLEGAL_PARAM("Unknown window type: %u", win->type);
1067 * glk_window_set_arrangement:
1068 * @win: a pair window to rearrange.
1069 * @method: new method of size computation. One of %winmethod_Above,
1070 * %winmethod_Below, %winmethod_Left, or %winmethod_Right OR'ed with
1071 * %winmethod_Fixed or %winmethod_Proportional.
1072 * @size: new size constraint, in percentage points if @method is
1073 * %winmethod_Proportional, otherwise in characters if @win's type is
1074 * %wintype_TextBuffer or %wintype_TextGrid, or pixels if @win's type is
1075 * %wintype_Graphics.
1076 * @keywin: new key window, or %NULL to leave the key window unchanged.
1078 * Changes the size of an existing split — that is, it changes the
1079 * constraint of a given pair window.
1081 * Consider the example above, where D has collapsed to zero height. Say D was a
1082 * text buffer window. You could make a more useful layout by doing
1085 * o2 = #glk_window_get_parent(d);
1086 * glk_window_set_arrangement(o2, #winmethod_Above | #winmethod_Fixed, 3, d);
1088 * That would set D (the upper child of O2) to be O2's key window, and give it a
1089 * fixed size of 3 rows.
1091 * If you later wanted to expand D, you could do
1092 * |[ glk_window_set_arrangement(o2, #winmethod_Above | #winmethod_Fixed, 5, NULL); ]|
1093 * That expands D to five rows. Note that, since O2's key window is already set
1094 * to D, it is not necessary to provide the @keywin argument; you can pass %NULL
1095 * to mean <quote>leave the key window unchanged.</quote>
1097 * If you do change the key window of a pair window, the new key window
1098 * <emphasis>must</emphasis> be a descendant of that pair window. In the current
1099 * example, you could change O2's key window to be A, but not B. The key window
1100 * also cannot be a pair window itself.
1102 * |[ glk_window_set_arrangement(o2, #winmethod_Below | #winmethod_Fixed, 3, NULL); ]|
1103 * This changes the constraint to be on the <emphasis>lower</emphasis> child of
1104 * O2, which is A. The key window is still D; so A would then be three rows high
1105 * as measured in D's font, and D would get the rest of O2's space. That may not
1106 * be what you want. To set A to be three rows high as measured in A's font, you
1108 * |[ glk_window_set_arrangement(o2, #winmethod_Below | #winmethod_Fixed, 3, a); ]|
1110 * Or you could change O2 to a proportional split:
1111 * |[ glk_window_set_arrangement(o2, #winmethod_Below | #winmethod_Proportional, 30, NULL); ]|
1113 * |[ glk_window_set_arrangement(o2, #winmethod_Above | #winmethod_Proportional, 70, NULL); ]|
1114 * These do exactly the same thing, since 30% above is the same as
1115 * 70% below. You don't need to specify a key window with a proportional
1116 * split, so the @keywin argument is %NULL. (You could actually specify either A
1117 * or D as the key window, but it wouldn't affect the result.)
1119 * Whatever constraint you set, glk_window_get_size() will tell you the actual
1120 * window size you got.
1122 * Note that you can resize windows, but you can't flip or rotate them. You
1123 * can't move A above D, or change O2 to a vertical split where A is left or
1126 * To get this effect you could close one of the windows, and re-split the
1127 * other one with glk_window_open().
1131 glk_window_set_arrangement(winid_t win, glui32 method, glui32 size, winid_t keywin)
1133 VALID_WINDOW(win, return);
1134 VALID_WINDOW_OR_NULL(keywin, return);
1135 g_return_if_fail(win->type == wintype_Pair);
1138 g_return_if_fail(keywin->type != wintype_Pair);
1139 g_return_if_fail(g_node_is_ancestor(win->window_node, keywin->window_node));
1141 g_return_if_fail(method == (method & (winmethod_DirMask | winmethod_DivisionMask)));
1142 g_return_if_fail(!(((method & winmethod_DivisionMask) == winmethod_Proportional) && size > 100));
1144 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
1146 win->split_method = method;
1147 win->constraint_size = size;
1149 win->key_window = keywin;
1151 /* Tell GTK to rearrange the windows */
1152 gdk_threads_enter();
1153 g_mutex_lock(glk_data->arrange_lock);
1154 glk_data->needs_rearrange = TRUE;
1155 glk_data->ignore_next_arrange_event = TRUE;
1156 g_mutex_unlock(glk_data->arrange_lock);
1157 gtk_widget_queue_resize(GTK_WIDGET(glk_data->self));
1158 gdk_threads_leave();
1162 * glk_window_get_arrangement:
1163 * @win: a pair window.
1164 * @methodptr: return location for the constraint flags of @win, or %NULL.
1165 * @sizeptr: return location for the constraint size of @win, or %NULL.
1166 * @keywinptr: return location for the key window of @win, or %NULL.
1168 * Queries the constraint of a given pair window.
1171 glk_window_get_arrangement(winid_t win, glui32 *methodptr, glui32 *sizeptr, winid_t *keywinptr)
1173 VALID_WINDOW(win, return);
1174 g_return_if_fail(win->type == wintype_Pair);
1177 *methodptr = win->split_method;
1179 *sizeptr = win->constraint_size;
1181 *keywinptr = win->key_window;
1185 * glk_window_move_cursor:
1186 * @win: A text grid window.
1187 * @xpos: Horizontal cursor position.
1188 * @ypos: Vertical cursor position.
1190 * Sets the cursor position. If you move the cursor right past the end of a
1191 * line, it wraps; the next character which is printed will appear at the
1192 * beginning of the next line.
1194 * If you move the cursor below the last line, or when the cursor reaches the
1195 * end of the last line, it goes <quote>off the screen</quote> and further
1196 * output has no effect. You must call glk_window_move_cursor() or
1197 * glk_window_clear() to move the cursor back into the visible region.
1200 * Note that the arguments of glk_window_move_cursor() are <type>unsigned
1201 * int</type>s. This is okay, since there are no negative positions. If you try
1202 * to pass a negative value, Glk will interpret it as a huge positive value,
1203 * and it will wrap or go off the last line.
1207 * Also note that the output cursor is not necessarily visible. In particular,
1208 * when you are requesting line or character input in a grid window, you cannot
1209 * rely on the cursor position to prompt the player where input is indicated.
1210 * You should print some character prompt at that spot — a
1211 * <quote>></quote> character, for example.
1215 glk_window_move_cursor(winid_t win, glui32 xpos, glui32 ypos)
1217 VALID_WINDOW(win, return);
1218 g_return_if_fail(win->type == wintype_TextGrid);
1220 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
1222 /* Wait until the window's size is current */
1223 g_mutex_lock(glk_data->arrange_lock);
1224 if(glk_data->needs_rearrange)
1225 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
1226 g_mutex_unlock(glk_data->arrange_lock);
1228 /* Don't do anything if the window is shrunk down to nothing */
1229 if(win->width == 0 || win->height == 0)
1232 /* Calculate actual position if cursor is moved past the right edge */
1233 if(xpos >= win->width)
1235 ypos += xpos / win->width;
1238 /* Go to the end if the cursor is moved off the bottom edge */
1239 if(ypos >= win->height)
1241 xpos = win->width - 1;
1242 ypos = win->height - 1;
1245 gdk_threads_enter();
1247 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
1249 /* There must actually be a character at xpos, or the following function will choke */
1250 gtk_text_buffer_get_iter_at_line_offset(buffer, &newpos, ypos, xpos);
1251 gtk_text_buffer_move_mark_by_name(buffer, "cursor_position", &newpos);
1253 gdk_threads_leave();