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, gboolean destroy_node)
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;
49 g_node_destroy(win->window_node);
50 win->magic = MAGIC_FREE;
56 * @win: A window, or %NULL.
57 * @rockptr: Return location for the next window's rock, or %NULL.
59 * This function can be used to iterate through the list of all open windows
60 * (including pair windows.) See <link
61 * linkend="chimara-Iterating-Through-Opaque-Objects">Iterating Through Opaque
64 * As that section describes, the order in which windows are returned is
65 * arbitrary. The root window is not necessarily first, nor is it necessarily
68 * Returns: the next window, or %NULL if there are no more.
71 glk_window_iterate(winid_t win, glui32 *rockptr)
73 VALID_WINDOW_OR_NULL(win, return NULL);
75 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
79 retnode = glk_data->root_window;
82 GNode *node = win->window_node;
83 if( G_NODE_IS_LEAF(node) )
85 while(node && node->next == NULL)
93 retnode = g_node_first_child(node);
95 winid_t retval = retnode? (winid_t)retnode->data : NULL;
97 /* Store the window's rock in rockptr */
99 *rockptr = glk_window_get_rock(retval);
105 * glk_window_get_rock:
108 * Returns @win's rock value. Pair windows always have rock 0; all other windows
109 * return whatever rock value you created them with.
111 * Returns: A rock value.
114 glk_window_get_rock(winid_t win)
116 VALID_WINDOW(win, return 0);
121 * glk_window_get_type:
124 * Returns @win's type, one of %wintype_Blank, %wintype_Pair,
125 * %wintype_TextBuffer, %wintype_TextGrid, or %wintype_Graphics.
127 * Returns: The window's type.
130 glk_window_get_type(winid_t win)
132 VALID_WINDOW(win, return 0);
137 * glk_window_get_parent:
140 * Returns the window which is the parent of @win. If @win is the root window,
141 * this returns %NULL, since the root window has no parent. Remember that the
142 * parent of every window is a pair window; other window types are always
145 * Returns: A window, or %NULL.
148 glk_window_get_parent(winid_t win)
150 VALID_WINDOW(win, return NULL);
151 /* Value will also be NULL if win is the root window */
152 return (winid_t)win->window_node->parent->data;
156 * glk_window_get_sibling:
159 * Returns the other child of @win's parent. If @win is the root window, this
162 * Returns: A window, or %NULL.
165 glk_window_get_sibling(winid_t win)
167 VALID_WINDOW(win, return NULL);
169 if(G_NODE_IS_ROOT(win->window_node))
171 if(win->window_node->next)
172 return (winid_t)win->window_node->next;
173 return (winid_t)win->window_node->prev;
177 * glk_window_get_root:
179 * Returns the root window. If there are no windows, this returns %NULL.
181 * Returns: A window, or %NULL.
184 glk_window_get_root()
186 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
187 if(glk_data->root_window == NULL)
189 return (winid_t)glk_data->root_window->data;
194 * @split: The window to split to create the new window. Must be 0 if there
195 * are no windows yet.
196 * @method: Position of the new window and method of size computation. One of
197 * %winmethod_Above, %winmethod_Below, %winmethod_Left, or %winmethod_Right
198 * OR'ed with %winmethod_Fixed or %winmethod_Proportional. If @wintype is
199 * %wintype_Blank, then %winmethod_Fixed is not allowed.
200 * @size: Size of the new window, in percentage points if @method is
201 * %winmethod_Proportional, otherwise in characters if @wintype is
202 * %wintype_TextBuffer or %wintype_TextGrid, or pixels if @wintype is
204 * @wintype: Type of the new window. One of %wintype_Blank, %wintype_TextGrid,
205 * %wintype_TextBuffer, or %wintype_Graphics.
206 * @rock: The new window's rock value.
208 * Creates a new window. If there are no windows, the first three arguments are
209 * meaningless. @split <emphasis>must</emphasis> be 0, and @method and @size
210 * are ignored. @wintype is the type of window you're creating, and @rock is
211 * the rock (see <link linkend="chimara-Rocks">Rocks</link>).
213 * If any windows exist, new windows must be created by splitting existing
214 * ones. @split is the window you want to split; this <emphasis>must
215 * not</emphasis> be zero. @method is a mask of constants to specify the
216 * direction and the split method (see below). @size is the size of the split.
217 * @wintype is the type of window you're creating, and @rock is the rock.
219 * Remember that it is possible that the library will be unable to create a new
220 * window, in which case glk_window_open() will return %NULL.
223 * It is acceptable to gracefully exit, if the window you are creating is an
224 * important one — such as your first window. But you should not try to
225 * perform any window operation on the id until you have tested to make sure
229 * The examples we've seen so far have the simplest kind of size control. (Yes,
230 * this is <quote>below</quote>.) Every pair is a percentage split, with
233 * <mathphrase>X</mathphrase>
235 * percent going to one side, and
238 * <mathphrase>(100 - X)</mathphrase>
240 * percent going to the other side. If the player resizes the window, the whole
241 * mess expands, contracts, or stretches in a uniform way.
243 * As I said above, you can also make fixed-size splits. This is a little more
244 * complicated, because you have to know how this fixed size is measured.
246 * Sizes are measured in a way which is different for each window type. For
247 * example, a text grid window is measured by the size of its fixed-width font.
248 * You can make a text grid window which is fixed at a height of four rows, or
249 * ten columns. A text buffer window is measured by the size of its font.
252 * Remember that different windows may use different size fonts. Even two
253 * text grid windows may use fixed-size fonts of different sizes.
256 * Graphics windows are measured in pixels, not characters. Blank windows
257 * aren't measured at all; there's no meaningful way to measure them, and
258 * therefore you can't create a blank window of a fixed size, only of a
259 * proportional (percentage) size.
261 * So to create a text buffer window which takes the top 40% of the original
262 * window's space, you would execute
263 * |[ newwin = #glk_window_open(win, #winmethod_Above | #winmethod_Proportional, 40, #wintype_TextBuffer, 0); ]|
265 * To create a text grid which is always five lines high, at the bottom of the
266 * original window, you would do
267 * |[ newwin = #glk_window_open(win, #winmethod_Below | #winmethod_Fixed, 5, #wintype_TextGrid, 0); ]|
269 * Note that the meaning of the @size argument depends on the @method argument.
270 * If the method is %winmethod_Fixed, it also depends on the @wintype argument.
271 * The new window is then called the <quote>key window</quote> of this split,
272 * because its window type determines how the split size is computed.
275 * For %winmethod_Proportional splits, you can still call the new window the
276 * <quote>key window</quote>. But the key window is not important for
277 * proportional splits, because the size will always be computed as a simple
278 * ratio of the available space, not a fixed size of one child window.
281 * This system is more or less peachy as long as all the constraints work out.
282 * What happens when there is a conflict? The rules are simple. Size control
283 * always flows down the tree, and the player is at the top. Let's bring out an
285 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
286 * <entry><mediaobject><imageobject><imagedata fileref="fig5-7a.png"/>
287 * </imageobject></mediaobject></entry>
288 * <entry><mediaobject><textobject><literallayout class="monospaced">
294 * </literallayout></textobject></mediaobject></entry>
295 * </row></tbody></tgroup></informaltable>
297 * First we split A into A and B, with a 50% proportional split. Then we split
298 * A into A and C, with C above, C being a text grid window, and C gets a fixed
299 * size of two rows (as measured in its own font size). A gets whatever remains
300 * of the 50% it had before.
302 * Now the player stretches the window vertically.
303 * <informalfigure><mediaobject><imageobject><imagedata fileref="fig6.png"/>
304 * </imageobject></mediaobject></informalfigure>
306 * The library figures: the topmost split, the original A/B split, is 50-50. So
307 * B gets half the screen space, and the pair window next to it (the lower
308 * <quote>O</quote>) gets the other half. Then it looks at the lower
309 * <quote>O</quote>. C gets two rows; A gets the rest. All done.
311 * Then the user maliciously starts squeezing the window down, in stages:
312 * <informaltable frame="none"><tgroup cols="5"><tbody><row valign="top">
313 * <entry><mediaobject><imageobject><imagedata fileref="fig5-7a.png"/>
314 * </imageobject></mediaobject></entry>
315 * <entry><mediaobject><imageobject><imagedata fileref="fig7b.png"/>
316 * </imageobject></mediaobject></entry>
317 * <entry><mediaobject><imageobject><imagedata fileref="fig7c.png"/>
318 * </imageobject></mediaobject></entry>
319 * <entry><mediaobject><imageobject><imagedata fileref="fig7d.png"/>
320 * </imageobject></mediaobject></entry>
321 * <entry><mediaobject><imageobject><imagedata fileref="fig7e.png"/>
322 * </imageobject></mediaobject></entry>
323 * </row></tbody></tgroup></informaltable>
325 * The logic remains the same. B always gets half the space. At stage 3,
326 * there's no room left for A, so it winds up with zero height. Nothing
327 * displayed in A will be visible. At stage 4, there isn't even room in the
328 * upper 50% to give C its two rows; so it only gets one. Finally, C is
329 * squashed out of existence as well.
331 * When a window winds up undersized, it remembers what size it should be. In
332 * the example above, A remembers that it should be two rows; if the user
333 * expands the window to the original size, it would return to the original
336 * The downward flow of control is a bit harsh. After all, in stage 4, there's
337 * room for C to have its two rows if only B would give up some of its 50%. But
338 * this does not happen.
341 * This makes life much easier for the Glk library. To determine the
342 * configuration of a window, it only needs to look at the window's
343 * ancestors, never at its descendants. So window layout is a simple
344 * recursive algorithm, no backtracking.
347 * What happens when you split a fixed-size window? The resulting pair window
348 * — that is, the two new parts together — retain the same size
349 * constraint as the original window that was split. The key window for the
350 * original split is still the key window for that split, even though it's now
351 * a grandchild instead of a child.
353 * The easy, and correct, way to think about this is that the size constraint
354 * is stored by a window's parent, not the window itself; and a constraint
355 * consists of a pointer to a key window plus a size value.
357 * <informaltable frame="none"><tgroup cols="6"><tbody><row>
358 * <entry><mediaobject><imageobject><imagedata fileref="fig8a.png"/>
359 * </imageobject></mediaobject></entry>
360 * <entry><mediaobject><textobject><literallayout class="monospaced">
362 * </literallayout></textobject></mediaobject></entry>
363 * <entry><mediaobject><imageobject><imagedata fileref="fig8b.png"/>
364 * </imageobject></mediaobject></entry>
365 * <entry><mediaobject><textobject><literallayout class="monospaced">
369 * </literallayout></textobject></mediaobject></entry>
370 * <entry><mediaobject><imageobject><imagedata fileref="fig8c.png"/>
371 * </imageobject></mediaobject></entry>
372 * <entry><mediaobject><textobject><literallayout class="monospaced">
378 * </literallayout></textobject></mediaobject></entry>
379 * </row></tbody></tgroup></informaltable>
380 * After the first split, the new pair window (O1, which covers the whole
381 * screen) knows that its first child (A) is above the second, and gets 50% of
382 * its own area. (A is the key window for this split, but a proportional split
383 * doesn't care about key windows.)
385 * After the second split, all this remains true; O1 knows that its first child
386 * gets 50% of its space, and A is O1's key window. But now O1's first child is
387 * O2 instead of A. The newer pair window (O2) knows that its first child (C)
388 * is above the second, and gets a fixed size of two rows. (As measured in C's
389 * font, because C is O2's key window.)
391 * If we split C, now, the resulting pair will still be two C-font rows high
392 * — that is, tall enough for two lines of whatever font C displays. For
393 * the sake of example, we'll do this vertically.
394 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
395 * <entry><mediaobject><imageobject><imagedata fileref="fig9.png"/>
396 * </imageobject></mediaobject></entry>
397 * <entry><mediaobject><textobject><literallayout class="monospaced">
405 * </literallayout></textobject></mediaobject></entry>
406 * </row></tbody></tgroup></informaltable>
408 * O3 now knows that its children have a 50-50 left-right split. O2 is still
409 * committed to giving its upper child, O3, two C-font rows. Again, this is
410 * because C is O2's key window.
413 * This turns out to be a good idea, because it means that C, the text grid
414 * window, is still two rows high. If O3 had been a upper-lower split, things
415 * wouldn't work out so neatly. But the rules would still apply. If you don't
416 * like this, don't do it.
419 * Returns: the new window, or %NULL on error.
422 glk_window_open(winid_t split, glui32 method, glui32 size, glui32 wintype,
425 VALID_WINDOW_OR_NULL(split, return NULL);
426 g_return_val_if_fail(method == (method & (winmethod_DirMask | winmethod_DivisionMask)), NULL);
427 g_return_val_if_fail(!(((method & winmethod_DivisionMask) == winmethod_Proportional) && size > 100), NULL);
429 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
431 if(split == NULL && glk_data->root_window != NULL)
433 ILLEGAL("Tried to open a new root window, but there is already a root window");
439 /* Create the new window */
440 winid_t win = window_new_common(rock);
447 /* A blank window will be a label without any text */
448 GtkWidget *label = gtk_label_new("");
449 gtk_widget_show(label);
453 /* A blank window has no size */
455 win->unit_height = 0;
459 case wintype_TextGrid:
461 GtkWidget *textview = gtk_text_view_new();
462 GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(textview) );
464 gtk_text_view_set_wrap_mode( GTK_TEXT_VIEW(textview), GTK_WRAP_NONE );
465 gtk_text_view_set_editable( GTK_TEXT_VIEW(textview), FALSE );
466 gtk_widget_show(textview);
468 /* Set the window's font */
469 gtk_widget_modify_font(textview, glk_data->monospace_font_desc);
471 win->widget = textview;
472 win->frame = textview;
474 /* Determine the size of a "0" character in pixels */
475 PangoLayout *zero = gtk_widget_create_pango_layout(textview, "0");
476 pango_layout_set_font_description(zero, glk_data->monospace_font_desc);
477 pango_layout_get_pixel_size(zero, &(win->unit_width), &(win->unit_height));
478 g_object_unref(zero);
479 /* width and height are set later */
481 /* Connect signal handlers */
482 win->keypress_handler = g_signal_connect( G_OBJECT(textview), "key-press-event", G_CALLBACK(on_window_key_press_event), win );
483 g_signal_handler_block( G_OBJECT(textview), win->keypress_handler );
485 /* Create the styles available to the window stream */
486 style_init_textgrid(textbuffer);
490 case wintype_TextBuffer:
492 GtkWidget *scrolledwindow = gtk_scrolled_window_new(NULL, NULL);
493 GtkWidget *textview = gtk_text_view_new();
494 GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(textview) );
496 gtk_scrolled_window_set_policy( GTK_SCROLLED_WINDOW(scrolledwindow), GTK_POLICY_NEVER, GTK_POLICY_AUTOMATIC );
498 gtk_text_view_set_wrap_mode( GTK_TEXT_VIEW(textview), GTK_WRAP_WORD_CHAR );
499 gtk_text_view_set_editable( GTK_TEXT_VIEW(textview), FALSE );
500 gtk_text_view_set_pixels_inside_wrap( GTK_TEXT_VIEW(textview), 3 );
501 gtk_text_view_set_left_margin( GTK_TEXT_VIEW(textview), 20 );
502 gtk_text_view_set_right_margin( GTK_TEXT_VIEW(textview), 20 );
504 gtk_container_add( GTK_CONTAINER(scrolledwindow), textview );
505 gtk_widget_show_all(scrolledwindow);
507 /* Set the window's font */
508 gtk_widget_modify_font(textview, glk_data->default_font_desc);
510 win->widget = textview;
511 win->frame = scrolledwindow;
513 /* Determine the size of a "0" character in pixels */
514 PangoLayout *zero = gtk_widget_create_pango_layout(textview, "0");
515 pango_layout_set_font_description(zero, glk_data->default_font_desc);
516 pango_layout_get_pixel_size(zero, &(win->unit_width), &(win->unit_height));
517 g_object_unref(zero);
519 /* Connect signal handlers */
520 win->keypress_handler = g_signal_connect( G_OBJECT(textview), "key-press-event", G_CALLBACK(on_window_key_press_event), win );
521 g_signal_handler_block( G_OBJECT(textview), win->keypress_handler );
523 win->insert_text_handler = g_signal_connect_after( G_OBJECT(textbuffer), "insert-text", G_CALLBACK(after_window_insert_text), win );
524 g_signal_handler_block( G_OBJECT(textbuffer), win->insert_text_handler );
526 /* Create an editable tag to indicate uneditable parts of the window
528 gtk_text_buffer_create_tag(textbuffer, "uneditable", "editable", FALSE, "editable-set", TRUE, NULL);
530 /* Create the styles available to the window stream */
531 style_init_textbuffer(textbuffer);
533 /* Mark the position where the user will input text */
535 gtk_text_buffer_get_end_iter(textbuffer, &end);
536 gtk_text_buffer_create_mark(textbuffer, "input_position", &end, TRUE);
542 ILLEGAL_PARAM("Unknown window type: %u", wintype);
544 g_node_destroy(glk_data->root_window);
545 glk_data->root_window = NULL;
549 /* Set the minimum size to "as small as possible" so it doesn't depend on
550 the size of the window contents */
551 gtk_widget_set_size_request(win->widget, 0, 0);
552 gtk_widget_set_size_request(win->frame, 0, 0);
556 /* When splitting, construct a new parent window
557 * copying most characteristics from the window that is being split */
558 winid_t pair = window_new_common(0);
559 pair->type = wintype_Pair;
561 /* The pair window must know about its children's split method */
562 pair->key_window = win;
563 pair->split_method = method;
564 pair->constraint_size = size;
566 /* Insert the new window into the window tree */
567 if(split->window_node->parent == NULL)
568 glk_data->root_window = pair->window_node;
571 if( split->window_node == g_node_first_sibling(split->window_node) )
572 g_node_prepend(split->window_node->parent, pair->window_node);
574 g_node_append(split->window_node->parent, pair->window_node);
575 g_node_unlink(split->window_node);
577 /* Place the windows in the correct order */
578 switch(method & winmethod_DirMask)
581 case winmethod_Above:
582 g_node_append(pair->window_node, win->window_node);
583 g_node_append(pair->window_node, split->window_node);
585 case winmethod_Right:
586 case winmethod_Below:
587 g_node_append(pair->window_node, split->window_node);
588 g_node_append(pair->window_node, win->window_node);
593 /* Set the window as root window */
594 glk_data->root_window = win->window_node;
597 /* Set the window as a child of the Glk widget, don't trigger an arrange event */
598 g_mutex_lock(glk_data->arrange_lock);
599 glk_data->needs_rearrange = TRUE;
600 glk_data->ignore_next_arrange_event = TRUE;
601 g_mutex_unlock(glk_data->arrange_lock);
602 gtk_widget_set_parent(win->frame, GTK_WIDGET(glk_data->self));
603 gtk_widget_queue_resize(GTK_WIDGET(glk_data->self));
605 /* For text grid windows, fill the buffer with blanks. */
606 if(wintype == wintype_TextGrid)
608 /* Create the cursor position mark */
610 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
611 gtk_text_buffer_get_start_iter(buffer, &begin);
612 gtk_text_buffer_create_mark(buffer, "cursor_position", &begin, TRUE);
616 glk_window_clear(win);
620 /* Internal function: if node's key window is closing_win or one of its
621 children, set node's key window to NULL. */
623 remove_key_windows(GNode *node, winid_t closing_win)
625 winid_t win = (winid_t)node->data;
626 if(win->key_window && (win->key_window == closing_win || g_node_is_ancestor(closing_win->window_node, win->key_window->window_node)))
627 win->key_window = NULL;
628 return FALSE; /* Don't stop the traversal */
631 /* Internal function: destroy this window's GTK widgets, window streams,
632 and those of all its children. GDK threads must be locked. */
634 destroy_windows_below(winid_t win, stream_result_t *result)
639 case wintype_TextGrid:
640 case wintype_TextBuffer:
641 gtk_widget_unparent(win->frame);
645 destroy_windows_below(win->window_node->children->data, NULL);
646 destroy_windows_below(win->window_node->children->next->data, NULL);
650 ILLEGAL_PARAM("Unknown window type: %u", win->type);
653 stream_close_common(win->window_stream, result);
656 /* Internal function: free the winid_t structure of this window and those of all its children */
658 free_winids_below(winid_t win)
660 if(win->type == wintype_Pair) {
661 free_winids_below(win->window_node->children->data);
662 free_winids_below(win->window_node->children->next->data);
664 window_close_common(win, FALSE);
669 * @win: Window to close.
670 * @result: Pointer to a #stream_result_t in which to store the write count.
672 * Closes @win, which is pretty much exactly the opposite of opening a window.
673 * It is legal to close all your windows, or to close the root window (which is
676 * The @result argument is filled with the output character count of the window
677 * stream. See <link linkend="chimara-Streams">Streams</link> and <link
678 * linkend="chimara-Closing-Streams">Closing Streams</link>.
680 * When you close a window (and it is not the root window), the other window
681 * in its pair takes over all the freed-up area. Let's close D, in the current
683 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
684 * <entry><mediaobject><imageobject><imagedata fileref="fig10.png"/>
685 * </imageobject></mediaobject></entry>
686 * <entry><mediaobject><textobject><literallayout class="monospaced">
692 * </literallayout></textobject></mediaobject></entry>
693 * </row></tbody></tgroup></informaltable>
695 * Notice what has happened. D is gone. O3 is gone, and its 50-50 left-right
696 * split has gone with it. The other size constraints are unchanged; O2 is
697 * still committed to giving its upper child two rows, as measured in the font
698 * of O2's key window, which is C. Conveniently, O2's upper child is C, just as
699 * it was before we created D. In fact, now that D is gone, everything is back
700 * to the way it was before we created D.
702 * But what if we had closed C instead of D? We would have gotten this:
703 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
704 * <entry><mediaobject><imageobject><imagedata fileref="fig11.png"/>
705 * </imageobject></mediaobject></entry>
706 * <entry><mediaobject><textobject><literallayout class="monospaced">
712 * </literallayout></textobject></mediaobject></entry>
713 * </row></tbody></tgroup></informaltable>
715 * Again, O3 is gone. But D has collapsed to zero height. This is because its
716 * height is controlled by O2, and O2's key window was C, and C is now gone. O2
717 * no longer has a key window at all, so it cannot compute a height for its
718 * upper child, so it defaults to zero.
721 * This may seem to be an inconvenient choice. That is deliberate. You should
722 * not leave a pair window with no key, and the zero-height default reminds
723 * you not to. You can use glk_window_set_arrangement() to set a new split
724 * measurement and key window. See <link
725 * linkend="chimara-Changing-Window-Constraints">Changing Window
726 * Constraints</link>.
730 glk_window_close(winid_t win, stream_result_t *result)
732 VALID_WINDOW(win, return);
734 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
736 gdk_threads_enter(); /* Prevent redraw while we're trashing the window */
738 /* If any pair windows have this window or its children as a key window,
739 set their key window to NULL */
740 g_node_traverse(glk_data->root_window, G_IN_ORDER, G_TRAVERSE_NON_LEAVES, -1, (GNodeTraverseFunc)remove_key_windows, win);
742 /* Close all the window streams and destroy the widgets of this window
743 and below, before trashing the window tree */
744 destroy_windows_below(win, result);
746 /* Then free the winid_t structures below this node, but not this one itself */
747 if(win->type == wintype_Pair) {
748 free_winids_below(win->window_node->children->data);
749 free_winids_below(win->window_node->children->next->data);
751 /* So now we should be left with a skeleton tree hanging off this node */
753 /* Parent window changes from a split window into the sibling window */
754 /* The parent of any window is either a pair window or NULL */
755 GNode *pair_node = win->window_node->parent;
756 /* If win was not the root window: */
757 if(pair_node != NULL)
759 gboolean new_child_on_left = ( pair_node == g_node_first_sibling(pair_node) );
760 GNode *sibling_node = pair_node->children; /* only one child left */
761 GNode *new_parent_node = pair_node->parent;
762 g_node_unlink(pair_node);
763 g_node_unlink(sibling_node);
764 /* pair_node and sibling_node should now be totally unconnected to the tree */
766 if(new_parent_node == NULL)
768 glk_data->root_window = sibling_node;
772 if(new_child_on_left)
773 g_node_prepend(new_parent_node, sibling_node);
775 g_node_append(new_parent_node, sibling_node);
778 window_close_common( (winid_t) pair_node->data, TRUE);
780 else /* it was the root window */
782 glk_data->root_window = NULL;
785 window_close_common(win, FALSE);
787 /* Schedule a redraw */
788 g_mutex_lock(glk_data->arrange_lock);
789 glk_data->needs_rearrange = TRUE;
790 glk_data->ignore_next_arrange_event = TRUE;
791 g_mutex_unlock(glk_data->arrange_lock);
792 gtk_widget_queue_resize( GTK_WIDGET(glk_data->self) );
800 * Erases @win. The meaning of this depends on the window type.
803 * <term>Text buffer</term>
805 * This may do any number of things, such as delete all text in the window, or
806 * print enough blank lines to scroll all text beyond visibility, or insert a
807 * page-break marker which is treated specially by the display part of the
812 * <term>Text grid</term>
814 * This will clear the window, filling all positions with blanks. The window
815 * cursor is moved to the top left corner (position 0,0).
819 * <term>Graphics</term>
821 * Clears the entire window to its current background color. See <link
822 * linkend="chimara-Graphics-Windows">Graphics Windows</link>.
826 * <term>Other window types</term>
827 * <listitem><para>No effect.</para></listitem>
831 * It is illegal to erase a window which has line input pending.
834 glk_window_clear(winid_t win)
836 VALID_WINDOW(win, return);
837 g_return_if_fail(win->input_request_type != INPUT_REQUEST_LINE && win->input_request_type != INPUT_REQUEST_LINE_UNICODE);
839 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
848 case wintype_TextGrid:
849 /* fill the buffer with blanks */
851 /* Wait for the window's size to be updated */
852 g_mutex_lock(glk_data->arrange_lock);
853 if(glk_data->needs_rearrange)
854 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
855 g_mutex_unlock(glk_data->arrange_lock);
859 /* Manually put newlines at the end of each row of characters in the buffer; manual newlines make resizing the window's grid easier. */
860 gchar *blanks = g_strnfill(win->width, ' ');
861 gchar **blanklines = g_new0(gchar *, win->height + 1);
863 for(count = 0; count < win->height; count++)
864 blanklines[count] = blanks;
865 blanklines[win->height] = NULL;
866 gchar *text = g_strjoinv("\n", blanklines);
867 g_free(blanklines); /* not g_strfreev() */
870 GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
871 gtk_text_buffer_set_text(textbuffer, text, -1);
875 gtk_text_buffer_get_start_iter(textbuffer, &begin);
876 gtk_text_buffer_move_mark_by_name(textbuffer, "cursor_position", &begin);
882 case wintype_TextBuffer:
883 /* delete all text in the window */
887 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
888 GtkTextIter start, end;
889 gtk_text_buffer_get_bounds(buffer, &start, &end);
890 gtk_text_buffer_delete(buffer, &start, &end);
897 ILLEGAL_PARAM("Unknown window type: %d", win->type);
903 * @win: A window, or %NULL.
905 * Sets the current stream to @win's window stream. It is exactly equivalent to
906 * |[ #glk_stream_set_current(#glk_window_get_stream(@win)) ]|
907 * See <link linkend="chimara-Streams">Streams</link>.
909 * <note><title>Chimara</title>
911 * Although this is not mentioned in the specification, @win may also be
912 * %NULL, in which case the current stream is also set to %NULL.
916 glk_set_window(winid_t win)
918 VALID_WINDOW_OR_NULL(win, return);
920 glk_stream_set_current( glk_window_get_stream(win) );
922 glk_stream_set_current(NULL);
926 * glk_window_get_stream:
929 * Returns the stream which is associated with @win. (See <link
930 * linkend="chimara-Window-Streams">Window Streams</link>.) Every window has a
931 * stream which can be printed to, but this may not be useful, depending on the
935 * For example, printing to a blank window's stream has no effect.
938 * Returns: A window stream.
940 strid_t glk_window_get_stream(winid_t win)
942 VALID_WINDOW(win, return NULL);
943 return win->window_stream;
947 * glk_window_set_echo_stream:
949 * @str: A stream to attach to the window, or %NULL.
951 * Sets @win's echo stream to @str, which can be any valid output stream. You
952 * can reset a window to stop echoing by calling
953 * <code>#glk_window_set_echo_stream(@win, %NULL)</code>.
955 * It is illegal to set a window's echo stream to be its
956 * <emphasis>own</emphasis> window stream. That would create an infinite loop,
957 * and is nearly certain to crash the Glk library. It is similarly illegal to
958 * create a longer loop (two or more windows echoing to each other.)
961 glk_window_set_echo_stream(winid_t win, strid_t str)
963 VALID_WINDOW(win, return);
964 VALID_STREAM_OR_NULL(str, return);
966 /* Test for an infinite loop */
968 for(; next && next->type == STREAM_TYPE_WINDOW; next = next->window->echo_stream)
970 if(next == win->window_stream)
972 ILLEGAL("Infinite loop detected");
973 win->echo_stream = NULL;
978 win->echo_stream = str;
982 * glk_window_get_echo_stream:
985 * Returns the echo stream of window @win. Initially, a window has no echo
986 * stream, so <code>#glk_window_get_echo_stream(@win)</code> will return %NULL.
988 * Returns: A stream, or %NULL.
991 glk_window_get_echo_stream(winid_t win)
993 VALID_WINDOW(win, return NULL);
994 return win->echo_stream;
998 * glk_window_get_size:
1000 * @widthptr: Pointer to a location to store the window's width, or %NULL.
1001 * @heightptr: Pointer to a location to store the window's height, or %NULL.
1003 * Simply returns the actual size of the window, in its measurement system.
1004 * As described in <link linkend="chimara-Other-API-Conventions">Other API
1005 * Conventions</link>, either @widthptr or @heightptr can be %NULL, if you
1006 * only want one measurement.
1008 * <note><para>Or, in fact, both, if you want to waste time.</para></note>
1011 glk_window_get_size(winid_t win, glui32 *widthptr, glui32 *heightptr)
1013 VALID_WINDOW(win, return);
1015 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
1021 if(widthptr != NULL)
1023 if(heightptr != NULL)
1027 case wintype_TextGrid:
1028 /* Wait until the window's size is current */
1029 g_mutex_lock(glk_data->arrange_lock);
1030 if(glk_data->needs_rearrange)
1031 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
1032 g_mutex_unlock(glk_data->arrange_lock);
1034 gdk_threads_enter();
1035 /* Cache the width and height */
1036 win->width = (glui32)(win->widget->allocation.width / win->unit_width);
1037 win->height = (glui32)(win->widget->allocation.height / win->unit_height);
1038 gdk_threads_leave();
1040 if(widthptr != NULL)
1041 *widthptr = win->width;
1042 if(heightptr != NULL)
1043 *heightptr = win->height;
1046 case wintype_TextBuffer:
1047 /* Wait until the window's size is current */
1048 g_mutex_lock(glk_data->arrange_lock);
1049 if(glk_data->needs_rearrange)
1050 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
1051 g_mutex_unlock(glk_data->arrange_lock);
1053 gdk_threads_enter();
1054 if(widthptr != NULL)
1055 *widthptr = (glui32)(win->widget->allocation.width / win->unit_width);
1056 if(heightptr != NULL)
1057 *heightptr = (glui32)(win->widget->allocation.height / win->unit_height);
1058 gdk_threads_leave();
1063 ILLEGAL_PARAM("Unknown window type: %u", win->type);
1068 * glk_window_set_arrangement:
1069 * @win: a pair window to rearrange.
1070 * @method: new method of size computation. One of %winmethod_Above,
1071 * %winmethod_Below, %winmethod_Left, or %winmethod_Right OR'ed with
1072 * %winmethod_Fixed or %winmethod_Proportional.
1073 * @size: new size constraint, in percentage points if @method is
1074 * %winmethod_Proportional, otherwise in characters if @win's type is
1075 * %wintype_TextBuffer or %wintype_TextGrid, or pixels if @win's type is
1076 * %wintype_Graphics.
1077 * @keywin: new key window, or %NULL to leave the key window unchanged.
1079 * Changes the size of an existing split — that is, it changes the
1080 * constraint of a given pair window.
1082 * Consider the example above, where D has collapsed to zero height. Say D was a
1083 * text buffer window. You could make a more useful layout by doing
1086 * o2 = #glk_window_get_parent(d);
1087 * glk_window_set_arrangement(o2, #winmethod_Above | #winmethod_Fixed, 3, d);
1089 * That would set D (the upper child of O2) to be O2's key window, and give it a
1090 * fixed size of 3 rows.
1092 * If you later wanted to expand D, you could do
1093 * |[ glk_window_set_arrangement(o2, #winmethod_Above | #winmethod_Fixed, 5, NULL); ]|
1094 * That expands D to five rows. Note that, since O2's key window is already set
1095 * to D, it is not necessary to provide the @keywin argument; you can pass %NULL
1096 * to mean <quote>leave the key window unchanged.</quote>
1098 * If you do change the key window of a pair window, the new key window
1099 * <emphasis>must</emphasis> be a descendant of that pair window. In the current
1100 * example, you could change O2's key window to be A, but not B. The key window
1101 * also cannot be a pair window itself.
1103 * |[ glk_window_set_arrangement(o2, #winmethod_Below | #winmethod_Fixed, 3, NULL); ]|
1104 * This changes the constraint to be on the <emphasis>lower</emphasis> child of
1105 * O2, which is A. The key window is still D; so A would then be three rows high
1106 * as measured in D's font, and D would get the rest of O2's space. That may not
1107 * be what you want. To set A to be three rows high as measured in A's font, you
1109 * |[ glk_window_set_arrangement(o2, #winmethod_Below | #winmethod_Fixed, 3, a); ]|
1111 * Or you could change O2 to a proportional split:
1112 * |[ glk_window_set_arrangement(o2, #winmethod_Below | #winmethod_Proportional, 30, NULL); ]|
1114 * |[ glk_window_set_arrangement(o2, #winmethod_Above | #winmethod_Proportional, 70, NULL); ]|
1115 * These do exactly the same thing, since 30% above is the same as
1116 * 70% below. You don't need to specify a key window with a proportional
1117 * split, so the @keywin argument is %NULL. (You could actually specify either A
1118 * or D as the key window, but it wouldn't affect the result.)
1120 * Whatever constraint you set, glk_window_get_size() will tell you the actual
1121 * window size you got.
1123 * Note that you can resize windows, but you can't flip or rotate them. You
1124 * can't move A above D, or change O2 to a vertical split where A is left or
1127 * To get this effect you could close one of the windows, and re-split the
1128 * other one with glk_window_open().
1132 glk_window_set_arrangement(winid_t win, glui32 method, glui32 size, winid_t keywin)
1134 VALID_WINDOW(win, return);
1135 VALID_WINDOW_OR_NULL(keywin, return);
1136 g_return_if_fail(win->type == wintype_Pair);
1139 g_return_if_fail(keywin->type != wintype_Pair);
1140 g_return_if_fail(g_node_is_ancestor(win->window_node, keywin->window_node));
1142 g_return_if_fail(method == (method & (winmethod_DirMask | winmethod_DivisionMask)));
1143 g_return_if_fail(!(((method & winmethod_DivisionMask) == winmethod_Proportional) && size > 100));
1145 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
1147 win->split_method = method;
1148 win->constraint_size = size;
1150 win->key_window = keywin;
1152 /* Tell GTK to rearrange the windows */
1153 gdk_threads_enter();
1154 g_mutex_lock(glk_data->arrange_lock);
1155 glk_data->needs_rearrange = TRUE;
1156 glk_data->ignore_next_arrange_event = TRUE;
1157 g_mutex_unlock(glk_data->arrange_lock);
1158 gtk_widget_queue_resize(GTK_WIDGET(glk_data->self));
1159 gdk_threads_leave();
1163 * glk_window_get_arrangement:
1164 * @win: a pair window.
1165 * @methodptr: return location for the constraint flags of @win, or %NULL.
1166 * @sizeptr: return location for the constraint size of @win, or %NULL.
1167 * @keywinptr: return location for the key window of @win, or %NULL.
1169 * Queries the constraint of a given pair window.
1172 glk_window_get_arrangement(winid_t win, glui32 *methodptr, glui32 *sizeptr, winid_t *keywinptr)
1174 VALID_WINDOW(win, return);
1175 g_return_if_fail(win->type == wintype_Pair);
1178 *methodptr = win->split_method;
1180 *sizeptr = win->constraint_size;
1182 *keywinptr = win->key_window;
1186 * glk_window_move_cursor:
1187 * @win: A text grid window.
1188 * @xpos: Horizontal cursor position.
1189 * @ypos: Vertical cursor position.
1191 * Sets the cursor position. If you move the cursor right past the end of a
1192 * line, it wraps; the next character which is printed will appear at the
1193 * beginning of the next line.
1195 * If you move the cursor below the last line, or when the cursor reaches the
1196 * end of the last line, it goes <quote>off the screen</quote> and further
1197 * output has no effect. You must call glk_window_move_cursor() or
1198 * glk_window_clear() to move the cursor back into the visible region.
1201 * Note that the arguments of glk_window_move_cursor() are <type>unsigned
1202 * int</type>s. This is okay, since there are no negative positions. If you try
1203 * to pass a negative value, Glk will interpret it as a huge positive value,
1204 * and it will wrap or go off the last line.
1208 * Also note that the output cursor is not necessarily visible. In particular,
1209 * when you are requesting line or character input in a grid window, you cannot
1210 * rely on the cursor position to prompt the player where input is indicated.
1211 * You should print some character prompt at that spot — a
1212 * <quote>></quote> character, for example.
1216 glk_window_move_cursor(winid_t win, glui32 xpos, glui32 ypos)
1218 VALID_WINDOW(win, return);
1219 g_return_if_fail(win->type == wintype_TextGrid);
1221 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
1223 /* Wait until the window's size is current */
1224 g_mutex_lock(glk_data->arrange_lock);
1225 if(glk_data->needs_rearrange)
1226 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
1227 g_mutex_unlock(glk_data->arrange_lock);
1229 /* Don't do anything if the window is shrunk down to nothing */
1230 if(win->width == 0 || win->height == 0)
1233 /* Calculate actual position if cursor is moved past the right edge */
1234 if(xpos >= win->width)
1236 ypos += xpos / win->width;
1239 /* Go to the end if the cursor is moved off the bottom edge */
1240 if(ypos >= win->height)
1242 xpos = win->width - 1;
1243 ypos = win->height - 1;
1246 gdk_threads_enter();
1248 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
1250 /* There must actually be a character at xpos, or the following function will choke */
1251 gtk_text_buffer_get_iter_at_line_offset(buffer, &newpos, ypos, xpos);
1252 gtk_text_buffer_move_mark_by_name(buffer, "cursor_position", &newpos);
1254 gdk_threads_leave();