4 #include "chimara-glk-private.h"
7 extern GPrivate *glk_data_key;
10 window_new_common(glui32 rock)
12 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
13 winid_t win = g_new0(struct glk_window_struct, 1);
15 win->magic = MAGIC_WINDOW;
17 if(glk_data->register_obj)
18 win->disprock = (*glk_data->register_obj)(win, gidisp_Class_Window);
20 win->window_node = g_node_new(win);
22 /* Every window has a window stream, but printing to it might have no effect */
23 win->window_stream = stream_new_common(0);
24 win->window_stream->file_mode = filemode_Write;
25 win->window_stream->type = STREAM_TYPE_WINDOW;
26 win->window_stream->window = win;
27 win->window_stream->style = "normal";
29 win->echo_stream = NULL;
30 win->input_request_type = INPUT_REQUEST_NONE;
31 win->line_input_buffer = NULL;
32 win->line_input_buffer_unicode = NULL;
35 /* Initialise the buffer */
36 win->buffer = g_string_sized_new(1024);
38 /* Initialise hyperlink table */
39 win->hyperlinks = g_hash_table_new_full(g_int_hash, g_direct_equal, g_free, g_object_unref);
44 /* Internal function: do all the stuff necessary to close a window. Call only
47 window_close_common(winid_t win, gboolean destroy_node)
49 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
51 if(glk_data->unregister_obj)
53 (*glk_data->unregister_obj)(win, gidisp_Class_Window, win->disprock);
54 win->disprock.ptr = NULL;
58 g_node_destroy(win->window_node);
60 win->magic = MAGIC_FREE;
62 g_list_foreach(win->history, (GFunc)g_free, NULL);
63 g_list_free(win->history);
65 g_string_free(win->buffer, TRUE);
66 g_hash_table_destroy(win->hyperlinks);
67 g_free(win->current_hyperlink);
73 * @win: A window, or %NULL.
74 * @rockptr: Return location for the next window's rock, or %NULL.
76 * This function can be used to iterate through the list of all open windows
77 * (including pair windows.) See <link
78 * linkend="chimara-Iterating-Through-Opaque-Objects">Iterating Through Opaque
81 * As that section describes, the order in which windows are returned is
82 * arbitrary. The root window is not necessarily first, nor is it necessarily
85 * Returns: the next window, or %NULL if there are no more.
88 glk_window_iterate(winid_t win, glui32 *rockptr)
90 VALID_WINDOW_OR_NULL(win, return NULL);
92 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
96 retnode = glk_data->root_window;
99 GNode *node = win->window_node;
100 if( G_NODE_IS_LEAF(node) )
102 while(node && node->next == NULL)
105 retnode = node->next;
110 retnode = g_node_first_child(node);
112 winid_t retval = retnode? (winid_t)retnode->data : NULL;
114 /* Store the window's rock in rockptr */
115 if(retval && rockptr)
116 *rockptr = glk_window_get_rock(retval);
122 * glk_window_get_rock:
125 * Returns @win's rock value. Pair windows always have rock 0; all other windows
126 * return whatever rock value you created them with.
128 * Returns: A rock value.
131 glk_window_get_rock(winid_t win)
133 VALID_WINDOW(win, return 0);
138 * glk_window_get_type:
141 * Returns @win's type, one of %wintype_Blank, %wintype_Pair,
142 * %wintype_TextBuffer, %wintype_TextGrid, or %wintype_Graphics.
144 * Returns: The window's type.
147 glk_window_get_type(winid_t win)
149 VALID_WINDOW(win, return 0);
154 * glk_window_get_parent:
157 * Returns the window which is the parent of @win. If @win is the root window,
158 * this returns %NULL, since the root window has no parent. Remember that the
159 * parent of every window is a pair window; other window types are always
162 * Returns: A window, or %NULL.
165 glk_window_get_parent(winid_t win)
167 VALID_WINDOW(win, return NULL);
168 /* Value will also be NULL if win is the root window */
169 return (winid_t)win->window_node->parent->data;
173 * glk_window_get_sibling:
176 * Returns the other child of @win's parent. If @win is the root window, this
179 * Returns: A window, or %NULL.
182 glk_window_get_sibling(winid_t win)
184 VALID_WINDOW(win, return NULL);
186 if(G_NODE_IS_ROOT(win->window_node))
188 if(win->window_node->next)
189 return (winid_t)win->window_node->next;
190 return (winid_t)win->window_node->prev;
194 * glk_window_get_root:
196 * Returns the root window. If there are no windows, this returns %NULL.
198 * Returns: A window, or %NULL.
201 glk_window_get_root()
203 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
204 if(glk_data->root_window == NULL)
206 return (winid_t)glk_data->root_window->data;
211 * @split: The window to split to create the new window. Must be 0 if there
212 * are no windows yet.
213 * @method: Position of the new window and method of size computation. One of
214 * %winmethod_Above, %winmethod_Below, %winmethod_Left, or %winmethod_Right
215 * OR'ed with %winmethod_Fixed or %winmethod_Proportional. If @wintype is
216 * %wintype_Blank, then %winmethod_Fixed is not allowed.
217 * @size: Size of the new window, in percentage points if @method is
218 * %winmethod_Proportional, otherwise in characters if @wintype is
219 * %wintype_TextBuffer or %wintype_TextGrid, or pixels if @wintype is
221 * @wintype: Type of the new window. One of %wintype_Blank, %wintype_TextGrid,
222 * %wintype_TextBuffer, or %wintype_Graphics.
223 * @rock: The new window's rock value.
225 * Creates a new window. If there are no windows, the first three arguments are
226 * meaningless. @split <emphasis>must</emphasis> be 0, and @method and @size
227 * are ignored. @wintype is the type of window you're creating, and @rock is
228 * the rock (see <link linkend="chimara-Rocks">Rocks</link>).
230 * If any windows exist, new windows must be created by splitting existing
231 * ones. @split is the window you want to split; this <emphasis>must
232 * not</emphasis> be zero. @method is a mask of constants to specify the
233 * direction and the split method (see below). @size is the size of the split.
234 * @wintype is the type of window you're creating, and @rock is the rock.
236 * Remember that it is possible that the library will be unable to create a new
237 * window, in which case glk_window_open() will return %NULL.
240 * It is acceptable to gracefully exit, if the window you are creating is an
241 * important one — such as your first window. But you should not try to
242 * perform any window operation on the id until you have tested to make sure
246 * The examples we've seen so far have the simplest kind of size control. (Yes,
247 * this is <quote>below</quote>.) Every pair is a percentage split, with
250 * <mathphrase>X</mathphrase>
252 * percent going to one side, and
255 * <mathphrase>(100 - X)</mathphrase>
257 * percent going to the other side. If the player resizes the window, the whole
258 * mess expands, contracts, or stretches in a uniform way.
260 * As I said above, you can also make fixed-size splits. This is a little more
261 * complicated, because you have to know how this fixed size is measured.
263 * Sizes are measured in a way which is different for each window type. For
264 * example, a text grid window is measured by the size of its fixed-width font.
265 * You can make a text grid window which is fixed at a height of four rows, or
266 * ten columns. A text buffer window is measured by the size of its font.
269 * Remember that different windows may use different size fonts. Even two
270 * text grid windows may use fixed-size fonts of different sizes.
273 * Graphics windows are measured in pixels, not characters. Blank windows
274 * aren't measured at all; there's no meaningful way to measure them, and
275 * therefore you can't create a blank window of a fixed size, only of a
276 * proportional (percentage) size.
278 * So to create a text buffer window which takes the top 40% of the original
279 * window's space, you would execute
280 * |[ newwin = #glk_window_open(win, #winmethod_Above | #winmethod_Proportional, 40, #wintype_TextBuffer, 0); ]|
282 * To create a text grid which is always five lines high, at the bottom of the
283 * original window, you would do
284 * |[ newwin = #glk_window_open(win, #winmethod_Below | #winmethod_Fixed, 5, #wintype_TextGrid, 0); ]|
286 * Note that the meaning of the @size argument depends on the @method argument.
287 * If the method is %winmethod_Fixed, it also depends on the @wintype argument.
288 * The new window is then called the <quote>key window</quote> of this split,
289 * because its window type determines how the split size is computed.
292 * For %winmethod_Proportional splits, you can still call the new window the
293 * <quote>key window</quote>. But the key window is not important for
294 * proportional splits, because the size will always be computed as a simple
295 * ratio of the available space, not a fixed size of one child window.
298 * This system is more or less peachy as long as all the constraints work out.
299 * What happens when there is a conflict? The rules are simple. Size control
300 * always flows down the tree, and the player is at the top. Let's bring out an
302 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
303 * <entry><mediaobject><imageobject><imagedata fileref="fig5-7a.png"/>
304 * </imageobject></mediaobject></entry>
305 * <entry><mediaobject><textobject><literallayout class="monospaced">
311 * </literallayout></textobject></mediaobject></entry>
312 * </row></tbody></tgroup></informaltable>
314 * First we split A into A and B, with a 50% proportional split. Then we split
315 * A into A and C, with C above, C being a text grid window, and C gets a fixed
316 * size of two rows (as measured in its own font size). A gets whatever remains
317 * of the 50% it had before.
319 * Now the player stretches the window vertically.
320 * <informalfigure><mediaobject><imageobject><imagedata fileref="fig6.png"/>
321 * </imageobject></mediaobject></informalfigure>
323 * The library figures: the topmost split, the original A/B split, is 50-50. So
324 * B gets half the screen space, and the pair window next to it (the lower
325 * <quote>O</quote>) gets the other half. Then it looks at the lower
326 * <quote>O</quote>. C gets two rows; A gets the rest. All done.
328 * Then the user maliciously starts squeezing the window down, in stages:
329 * <informaltable frame="none"><tgroup cols="5"><tbody><row valign="top">
330 * <entry><mediaobject><imageobject><imagedata fileref="fig5-7a.png"/>
331 * </imageobject></mediaobject></entry>
332 * <entry><mediaobject><imageobject><imagedata fileref="fig7b.png"/>
333 * </imageobject></mediaobject></entry>
334 * <entry><mediaobject><imageobject><imagedata fileref="fig7c.png"/>
335 * </imageobject></mediaobject></entry>
336 * <entry><mediaobject><imageobject><imagedata fileref="fig7d.png"/>
337 * </imageobject></mediaobject></entry>
338 * <entry><mediaobject><imageobject><imagedata fileref="fig7e.png"/>
339 * </imageobject></mediaobject></entry>
340 * </row></tbody></tgroup></informaltable>
342 * The logic remains the same. B always gets half the space. At stage 3,
343 * there's no room left for A, so it winds up with zero height. Nothing
344 * displayed in A will be visible. At stage 4, there isn't even room in the
345 * upper 50% to give C its two rows; so it only gets one. Finally, C is
346 * squashed out of existence as well.
348 * When a window winds up undersized, it remembers what size it should be. In
349 * the example above, A remembers that it should be two rows; if the user
350 * expands the window to the original size, it would return to the original
353 * The downward flow of control is a bit harsh. After all, in stage 4, there's
354 * room for C to have its two rows if only B would give up some of its 50%. But
355 * this does not happen.
358 * This makes life much easier for the Glk library. To determine the
359 * configuration of a window, it only needs to look at the window's
360 * ancestors, never at its descendants. So window layout is a simple
361 * recursive algorithm, no backtracking.
364 * What happens when you split a fixed-size window? The resulting pair window
365 * — that is, the two new parts together — retain the same size
366 * constraint as the original window that was split. The key window for the
367 * original split is still the key window for that split, even though it's now
368 * a grandchild instead of a child.
370 * The easy, and correct, way to think about this is that the size constraint
371 * is stored by a window's parent, not the window itself; and a constraint
372 * consists of a pointer to a key window plus a size value.
374 * <informaltable frame="none"><tgroup cols="6"><tbody><row>
375 * <entry><mediaobject><imageobject><imagedata fileref="fig8a.png"/>
376 * </imageobject></mediaobject></entry>
377 * <entry><mediaobject><textobject><literallayout class="monospaced">
379 * </literallayout></textobject></mediaobject></entry>
380 * <entry><mediaobject><imageobject><imagedata fileref="fig8b.png"/>
381 * </imageobject></mediaobject></entry>
382 * <entry><mediaobject><textobject><literallayout class="monospaced">
386 * </literallayout></textobject></mediaobject></entry>
387 * <entry><mediaobject><imageobject><imagedata fileref="fig8c.png"/>
388 * </imageobject></mediaobject></entry>
389 * <entry><mediaobject><textobject><literallayout class="monospaced">
395 * </literallayout></textobject></mediaobject></entry>
396 * </row></tbody></tgroup></informaltable>
397 * After the first split, the new pair window (O1, which covers the whole
398 * screen) knows that its first child (A) is above the second, and gets 50% of
399 * its own area. (A is the key window for this split, but a proportional split
400 * doesn't care about key windows.)
402 * After the second split, all this remains true; O1 knows that its first child
403 * gets 50% of its space, and A is O1's key window. But now O1's first child is
404 * O2 instead of A. The newer pair window (O2) knows that its first child (C)
405 * is above the second, and gets a fixed size of two rows. (As measured in C's
406 * font, because C is O2's key window.)
408 * If we split C, now, the resulting pair will still be two C-font rows high
409 * — that is, tall enough for two lines of whatever font C displays. For
410 * the sake of example, we'll do this vertically.
411 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
412 * <entry><mediaobject><imageobject><imagedata fileref="fig9.png"/>
413 * </imageobject></mediaobject></entry>
414 * <entry><mediaobject><textobject><literallayout class="monospaced">
422 * </literallayout></textobject></mediaobject></entry>
423 * </row></tbody></tgroup></informaltable>
425 * O3 now knows that its children have a 50-50 left-right split. O2 is still
426 * committed to giving its upper child, O3, two C-font rows. Again, this is
427 * because C is O2's key window.
430 * This turns out to be a good idea, because it means that C, the text grid
431 * window, is still two rows high. If O3 had been a upper-lower split, things
432 * wouldn't work out so neatly. But the rules would still apply. If you don't
433 * like this, don't do it.
436 * Returns: the new window, or %NULL on error.
439 glk_window_open(winid_t split, glui32 method, glui32 size, glui32 wintype,
442 VALID_WINDOW_OR_NULL(split, return NULL);
443 g_return_val_if_fail(method == (method & (winmethod_DirMask | winmethod_DivisionMask)), NULL);
444 g_return_val_if_fail(!(((method & winmethod_DivisionMask) == winmethod_Proportional) && size > 100), NULL);
446 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
448 if(split == NULL && glk_data->root_window != NULL)
450 ILLEGAL("Tried to open a new root window, but there is already a root window");
456 /* Create the new window */
457 winid_t win = window_new_common(rock);
464 /* A blank window will be a label without any text */
465 GtkWidget *label = gtk_label_new("");
466 gtk_widget_show(label);
470 /* A blank window has no size */
472 win->unit_height = 0;
476 case wintype_TextGrid:
478 GtkWidget *textview = gtk_text_view_new();
479 GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(textview) );
481 gtk_text_view_set_wrap_mode( GTK_TEXT_VIEW(textview), GTK_WRAP_NONE );
482 gtk_text_view_set_editable( GTK_TEXT_VIEW(textview), FALSE );
483 gtk_widget_show(textview);
485 /* Create the styles available to the window stream */
486 style_init_textgrid(textbuffer);
487 gtk_widget_modify_font( textview, get_current_font(wintype) );
489 win->widget = textview;
490 win->frame = textview;
492 /* Determine the size of a "0" character in pixels */
493 PangoLayout *zero = gtk_widget_create_pango_layout(textview, "0");
494 pango_layout_set_font_description( zero, get_current_font(wintype) );
495 pango_layout_get_pixel_size(zero, &(win->unit_width), &(win->unit_height));
496 g_object_unref(zero);
497 /* width and height are set later */
499 /* Connect signal handlers */
500 win->char_input_keypress_handler = g_signal_connect(textview, "key-press-event", G_CALLBACK(on_char_input_key_press_event), win);
501 g_signal_handler_block(textview, win->char_input_keypress_handler);
502 win->line_input_keypress_handler = g_signal_connect(textview, "key-press-event", G_CALLBACK(on_line_input_key_press_event), win);
503 g_signal_handler_block(textview, win->line_input_keypress_handler);
504 win->shutdown_keypress_handler = g_signal_connect(textview, "key-press-event", G_CALLBACK(on_shutdown_key_press_event), win);
505 g_signal_handler_block(textview, win->shutdown_keypress_handler);
506 win->button_press_event_handler = g_signal_connect( textview, "button-press-event", G_CALLBACK(on_window_button_press), win );
507 g_signal_handler_block(textview, win->button_press_event_handler);
511 case wintype_TextBuffer:
513 GtkWidget *scrolledwindow = gtk_scrolled_window_new(NULL, NULL);
514 GtkWidget *textview = gtk_text_view_new();
515 GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(textview) );
517 gtk_scrolled_window_set_policy( GTK_SCROLLED_WINDOW(scrolledwindow), GTK_POLICY_NEVER, GTK_POLICY_AUTOMATIC );
519 gtk_text_view_set_wrap_mode( GTK_TEXT_VIEW(textview), GTK_WRAP_WORD_CHAR );
520 gtk_text_view_set_editable( GTK_TEXT_VIEW(textview), FALSE );
521 gtk_text_view_set_pixels_inside_wrap( GTK_TEXT_VIEW(textview), 3 );
522 gtk_text_view_set_left_margin( GTK_TEXT_VIEW(textview), 20 );
523 gtk_text_view_set_right_margin( GTK_TEXT_VIEW(textview), 20 );
525 gtk_container_add( GTK_CONTAINER(scrolledwindow), textview );
526 gtk_widget_show_all(scrolledwindow);
528 /* Create the styles available to the window stream */
529 style_init_textbuffer(textbuffer);
530 gtk_widget_modify_font( textview, get_current_font(wintype) );
532 win->widget = textview;
533 win->frame = scrolledwindow;
535 /* Determine the size of a "0" character in pixels */
536 PangoLayout *zero = gtk_widget_create_pango_layout(textview, "0");
537 pango_layout_set_font_description( zero, get_current_font(wintype) );
538 pango_layout_get_pixel_size(zero, &(win->unit_width), &(win->unit_height));
539 g_object_unref(zero);
541 /* Connect signal handlers */
542 win->char_input_keypress_handler = g_signal_connect( textview, "key-press-event", G_CALLBACK(on_char_input_key_press_event), win );
543 g_signal_handler_block(textview, win->char_input_keypress_handler);
544 win->line_input_keypress_handler = g_signal_connect( textview, "key-press-event", G_CALLBACK(on_line_input_key_press_event), win );
545 g_signal_handler_block(textview, win->line_input_keypress_handler);
546 win->shutdown_keypress_handler = g_signal_connect( textview, "key-press-event", G_CALLBACK(on_shutdown_key_press_event), win );
547 g_signal_handler_block(textview, win->shutdown_keypress_handler);
548 win->insert_text_handler = g_signal_connect_after( textbuffer, "insert-text", G_CALLBACK(after_window_insert_text), win );
549 g_signal_handler_block(textbuffer, win->insert_text_handler);
551 /* Create an editable tag to indicate uneditable parts of the window
553 gtk_text_buffer_create_tag(textbuffer, "uneditable", "editable", FALSE, "editable-set", TRUE, NULL);
555 /* Mark the position where the user will input text */
557 gtk_text_buffer_get_end_iter(textbuffer, &end);
558 gtk_text_buffer_create_mark(textbuffer, "input_position", &end, TRUE);
564 ILLEGAL_PARAM("Unknown window type: %u", wintype);
566 g_node_destroy(glk_data->root_window);
567 glk_data->root_window = NULL;
571 /* Set the minimum size to "as small as possible" so it doesn't depend on
572 the size of the window contents */
573 gtk_widget_set_size_request(win->widget, 0, 0);
574 gtk_widget_set_size_request(win->frame, 0, 0);
578 /* When splitting, construct a new parent window
579 * copying most characteristics from the window that is being split */
580 winid_t pair = window_new_common(0);
581 pair->type = wintype_Pair;
583 /* The pair window must know about its children's split method */
584 pair->key_window = win;
585 pair->split_method = method;
586 pair->constraint_size = size;
588 /* Insert the new window into the window tree */
589 if(split->window_node->parent == NULL)
590 glk_data->root_window = pair->window_node;
593 if( split->window_node == g_node_first_sibling(split->window_node) )
594 g_node_prepend(split->window_node->parent, pair->window_node);
596 g_node_append(split->window_node->parent, pair->window_node);
597 g_node_unlink(split->window_node);
599 /* Place the windows in the correct order */
600 switch(method & winmethod_DirMask)
603 case winmethod_Above:
604 g_node_append(pair->window_node, win->window_node);
605 g_node_append(pair->window_node, split->window_node);
607 case winmethod_Right:
608 case winmethod_Below:
609 g_node_append(pair->window_node, split->window_node);
610 g_node_append(pair->window_node, win->window_node);
615 /* Set the window as root window */
616 glk_data->root_window = win->window_node;
619 /* Set the window as a child of the Glk widget, don't trigger an arrange event */
620 g_mutex_lock(glk_data->arrange_lock);
621 glk_data->needs_rearrange = TRUE;
622 glk_data->ignore_next_arrange_event = TRUE;
623 g_mutex_unlock(glk_data->arrange_lock);
624 gtk_widget_set_parent(win->frame, GTK_WIDGET(glk_data->self));
625 gtk_widget_queue_resize(GTK_WIDGET(glk_data->self));
627 /* For text grid windows, fill the buffer with blanks. */
628 if(wintype == wintype_TextGrid)
630 /* Create the cursor position mark */
632 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
633 gtk_text_buffer_get_start_iter(buffer, &begin);
634 gtk_text_buffer_create_mark(buffer, "cursor_position", &begin, TRUE);
638 glk_window_clear(win);
642 /* Internal function: if node's key window is closing_win or one of its
643 children, set node's key window to NULL. */
645 remove_key_windows(GNode *node, winid_t closing_win)
647 winid_t win = (winid_t)node->data;
648 if(win->key_window && (win->key_window == closing_win || g_node_is_ancestor(closing_win->window_node, win->key_window->window_node)))
649 win->key_window = NULL;
650 return FALSE; /* Don't stop the traversal */
653 /* Internal function: destroy this window's GTK widgets, window streams,
654 and those of all its children. GDK threads must be locked. */
656 destroy_windows_below(winid_t win, stream_result_t *result)
661 case wintype_TextGrid:
662 case wintype_TextBuffer:
663 gtk_widget_unparent(win->frame);
667 destroy_windows_below(win->window_node->children->data, NULL);
668 destroy_windows_below(win->window_node->children->next->data, NULL);
672 ILLEGAL_PARAM("Unknown window type: %u", win->type);
675 stream_close_common(win->window_stream, result);
678 /* Internal function: free the winid_t structure of this window and those of all its children */
680 free_winids_below(winid_t win)
682 if(win->type == wintype_Pair) {
683 free_winids_below(win->window_node->children->data);
684 free_winids_below(win->window_node->children->next->data);
686 window_close_common(win, FALSE);
691 * @win: Window to close.
692 * @result: Pointer to a #stream_result_t in which to store the write count.
694 * Closes @win, which is pretty much exactly the opposite of opening a window.
695 * It is legal to close all your windows, or to close the root window (which is
698 * The @result argument is filled with the output character count of the window
699 * stream. See <link linkend="chimara-Streams">Streams</link> and <link
700 * linkend="chimara-Closing-Streams">Closing Streams</link>.
702 * When you close a window (and it is not the root window), the other window
703 * in its pair takes over all the freed-up area. Let's close D, in the current
705 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
706 * <entry><mediaobject><imageobject><imagedata fileref="fig10.png"/>
707 * </imageobject></mediaobject></entry>
708 * <entry><mediaobject><textobject><literallayout class="monospaced">
714 * </literallayout></textobject></mediaobject></entry>
715 * </row></tbody></tgroup></informaltable>
717 * Notice what has happened. D is gone. O3 is gone, and its 50-50 left-right
718 * split has gone with it. The other size constraints are unchanged; O2 is
719 * still committed to giving its upper child two rows, as measured in the font
720 * of O2's key window, which is C. Conveniently, O2's upper child is C, just as
721 * it was before we created D. In fact, now that D is gone, everything is back
722 * to the way it was before we created D.
724 * But what if we had closed C instead of D? We would have gotten this:
725 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
726 * <entry><mediaobject><imageobject><imagedata fileref="fig11.png"/>
727 * </imageobject></mediaobject></entry>
728 * <entry><mediaobject><textobject><literallayout class="monospaced">
734 * </literallayout></textobject></mediaobject></entry>
735 * </row></tbody></tgroup></informaltable>
737 * Again, O3 is gone. But D has collapsed to zero height. This is because its
738 * height is controlled by O2, and O2's key window was C, and C is now gone. O2
739 * no longer has a key window at all, so it cannot compute a height for its
740 * upper child, so it defaults to zero.
743 * This may seem to be an inconvenient choice. That is deliberate. You should
744 * not leave a pair window with no key, and the zero-height default reminds
745 * you not to. You can use glk_window_set_arrangement() to set a new split
746 * measurement and key window. See <link
747 * linkend="chimara-Changing-Window-Constraints">Changing Window
748 * Constraints</link>.
752 glk_window_close(winid_t win, stream_result_t *result)
754 VALID_WINDOW(win, return);
756 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
758 gdk_threads_enter(); /* Prevent redraw while we're trashing the window */
760 /* If any pair windows have this window or its children as a key window,
761 set their key window to NULL */
762 g_node_traverse(glk_data->root_window, G_IN_ORDER, G_TRAVERSE_NON_LEAVES, -1, (GNodeTraverseFunc)remove_key_windows, win);
764 /* Close all the window streams and destroy the widgets of this window
765 and below, before trashing the window tree */
766 destroy_windows_below(win, result);
768 /* Then free the winid_t structures below this node, but not this one itself */
769 if(win->type == wintype_Pair) {
770 free_winids_below(win->window_node->children->data);
771 free_winids_below(win->window_node->children->next->data);
773 /* So now we should be left with a skeleton tree hanging off this node */
775 /* Parent window changes from a split window into the sibling window */
776 /* The parent of any window is either a pair window or NULL */
777 GNode *pair_node = win->window_node->parent;
778 /* If win was not the root window: */
779 if(pair_node != NULL)
781 gboolean new_child_on_left = ( pair_node == g_node_first_sibling(pair_node) );
782 GNode *sibling_node = pair_node->children; /* only one child left */
783 GNode *new_parent_node = pair_node->parent;
784 g_node_unlink(pair_node);
785 g_node_unlink(sibling_node);
786 /* pair_node and sibling_node should now be totally unconnected to the tree */
788 if(new_parent_node == NULL)
790 glk_data->root_window = sibling_node;
794 if(new_child_on_left)
795 g_node_prepend(new_parent_node, sibling_node);
797 g_node_append(new_parent_node, sibling_node);
800 window_close_common( (winid_t) pair_node->data, TRUE);
802 else /* it was the root window */
804 glk_data->root_window = NULL;
807 window_close_common(win, FALSE);
809 /* Schedule a redraw */
810 g_mutex_lock(glk_data->arrange_lock);
811 glk_data->needs_rearrange = TRUE;
812 glk_data->ignore_next_arrange_event = TRUE;
813 g_mutex_unlock(glk_data->arrange_lock);
814 gtk_widget_queue_resize( GTK_WIDGET(glk_data->self) );
822 * Erases @win. The meaning of this depends on the window type.
825 * <term>Text buffer</term>
827 * This may do any number of things, such as delete all text in the window, or
828 * print enough blank lines to scroll all text beyond visibility, or insert a
829 * page-break marker which is treated specially by the display part of the
834 * <term>Text grid</term>
836 * This will clear the window, filling all positions with blanks. The window
837 * cursor is moved to the top left corner (position 0,0).
841 * <term>Graphics</term>
843 * Clears the entire window to its current background color. See <link
844 * linkend="chimara-Graphics-Windows">Graphics Windows</link>.
848 * <term>Other window types</term>
849 * <listitem><para>No effect.</para></listitem>
853 * It is illegal to erase a window which has line input pending.
856 glk_window_clear(winid_t win)
858 VALID_WINDOW(win, return);
859 g_return_if_fail(win->input_request_type != INPUT_REQUEST_LINE && win->input_request_type != INPUT_REQUEST_LINE_UNICODE);
861 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
870 case wintype_TextGrid:
871 /* fill the buffer with blanks */
873 /* Wait for the window's size to be updated */
874 g_mutex_lock(glk_data->arrange_lock);
875 if(glk_data->needs_rearrange)
876 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
877 g_mutex_unlock(glk_data->arrange_lock);
881 /* Manually put newlines at the end of each row of characters in the buffer; manual newlines make resizing the window's grid easier. */
882 gchar *blanks = g_strnfill(win->width, ' ');
883 gchar **blanklines = g_new0(gchar *, win->height + 1);
885 for(count = 0; count < win->height; count++)
886 blanklines[count] = blanks;
887 blanklines[win->height] = NULL;
888 gchar *text = g_strjoinv("\n", blanklines);
889 g_free(blanklines); /* not g_strfreev() */
892 GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
893 gtk_text_buffer_set_text(textbuffer, text, -1);
897 gtk_text_buffer_get_start_iter(textbuffer, &begin);
898 gtk_text_buffer_move_mark_by_name(textbuffer, "cursor_position", &begin);
904 case wintype_TextBuffer:
905 /* delete all text in the window */
909 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
910 GtkTextIter start, end;
911 gtk_text_buffer_get_bounds(buffer, &start, &end);
912 gtk_text_buffer_delete(buffer, &start, &end);
919 ILLEGAL_PARAM("Unknown window type: %d", win->type);
925 * @win: A window, or %NULL.
927 * Sets the current stream to @win's window stream. It is exactly equivalent to
928 * |[ #glk_stream_set_current(#glk_window_get_stream(@win)) ]|
929 * See <link linkend="chimara-Streams">Streams</link>.
931 * <note><title>Chimara</title>
933 * Although this is not mentioned in the specification, @win may also be
934 * %NULL, in which case the current stream is also set to %NULL.
938 glk_set_window(winid_t win)
940 VALID_WINDOW_OR_NULL(win, return);
942 glk_stream_set_current( glk_window_get_stream(win) );
944 glk_stream_set_current(NULL);
948 * glk_window_get_stream:
951 * Returns the stream which is associated with @win. (See <link
952 * linkend="chimara-Window-Streams">Window Streams</link>.) Every window has a
953 * stream which can be printed to, but this may not be useful, depending on the
957 * For example, printing to a blank window's stream has no effect.
960 * Returns: A window stream.
962 strid_t glk_window_get_stream(winid_t win)
964 VALID_WINDOW(win, return NULL);
965 return win->window_stream;
969 * glk_window_set_echo_stream:
971 * @str: A stream to attach to the window, or %NULL.
973 * Sets @win's echo stream to @str, which can be any valid output stream. You
974 * can reset a window to stop echoing by calling
975 * <code>#glk_window_set_echo_stream(@win, %NULL)</code>.
977 * It is illegal to set a window's echo stream to be its
978 * <emphasis>own</emphasis> window stream. That would create an infinite loop,
979 * and is nearly certain to crash the Glk library. It is similarly illegal to
980 * create a longer loop (two or more windows echoing to each other.)
983 glk_window_set_echo_stream(winid_t win, strid_t str)
985 VALID_WINDOW(win, return);
986 VALID_STREAM_OR_NULL(str, return);
988 /* Test for an infinite loop */
990 for(; next && next->type == STREAM_TYPE_WINDOW; next = next->window->echo_stream)
992 if(next == win->window_stream)
994 ILLEGAL("Infinite loop detected");
995 win->echo_stream = NULL;
1000 win->echo_stream = str;
1004 * glk_window_get_echo_stream:
1007 * Returns the echo stream of window @win. Initially, a window has no echo
1008 * stream, so <code>#glk_window_get_echo_stream(@win)</code> will return %NULL.
1010 * Returns: A stream, or %NULL.
1013 glk_window_get_echo_stream(winid_t win)
1015 VALID_WINDOW(win, return NULL);
1016 return win->echo_stream;
1020 * glk_window_get_size:
1022 * @widthptr: Pointer to a location to store the window's width, or %NULL.
1023 * @heightptr: Pointer to a location to store the window's height, or %NULL.
1025 * Simply returns the actual size of the window, in its measurement system.
1026 * As described in <link linkend="chimara-Other-API-Conventions">Other API
1027 * Conventions</link>, either @widthptr or @heightptr can be %NULL, if you
1028 * only want one measurement.
1030 * <note><para>Or, in fact, both, if you want to waste time.</para></note>
1033 glk_window_get_size(winid_t win, glui32 *widthptr, glui32 *heightptr)
1035 VALID_WINDOW(win, return);
1037 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
1043 if(widthptr != NULL)
1045 if(heightptr != NULL)
1049 case wintype_TextGrid:
1050 /* Wait until the window's size is current */
1051 g_mutex_lock(glk_data->arrange_lock);
1052 if(glk_data->needs_rearrange)
1053 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
1054 g_mutex_unlock(glk_data->arrange_lock);
1056 gdk_threads_enter();
1057 /* Cache the width and height */
1058 win->width = (glui32)(win->widget->allocation.width / win->unit_width);
1059 win->height = (glui32)(win->widget->allocation.height / win->unit_height);
1060 gdk_threads_leave();
1062 if(widthptr != NULL)
1063 *widthptr = win->width;
1064 if(heightptr != NULL)
1065 *heightptr = win->height;
1068 case wintype_TextBuffer:
1069 /* Wait until the window's size is current */
1070 g_mutex_lock(glk_data->arrange_lock);
1071 if(glk_data->needs_rearrange)
1072 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
1073 g_mutex_unlock(glk_data->arrange_lock);
1075 gdk_threads_enter();
1076 if(widthptr != NULL)
1077 *widthptr = (glui32)(win->widget->allocation.width / win->unit_width);
1078 if(heightptr != NULL)
1079 *heightptr = (glui32)(win->widget->allocation.height / win->unit_height);
1080 gdk_threads_leave();
1085 ILLEGAL_PARAM("Unknown window type: %u", win->type);
1090 * glk_window_set_arrangement:
1091 * @win: a pair window to rearrange.
1092 * @method: new method of size computation. One of %winmethod_Above,
1093 * %winmethod_Below, %winmethod_Left, or %winmethod_Right OR'ed with
1094 * %winmethod_Fixed or %winmethod_Proportional.
1095 * @size: new size constraint, in percentage points if @method is
1096 * %winmethod_Proportional, otherwise in characters if @win's type is
1097 * %wintype_TextBuffer or %wintype_TextGrid, or pixels if @win's type is
1098 * %wintype_Graphics.
1099 * @keywin: new key window, or %NULL to leave the key window unchanged.
1101 * Changes the size of an existing split — that is, it changes the
1102 * constraint of a given pair window.
1104 * Consider the example above, where D has collapsed to zero height. Say D was a
1105 * text buffer window. You could make a more useful layout by doing
1108 * o2 = #glk_window_get_parent(d);
1109 * glk_window_set_arrangement(o2, #winmethod_Above | #winmethod_Fixed, 3, d);
1111 * That would set D (the upper child of O2) to be O2's key window, and give it a
1112 * fixed size of 3 rows.
1114 * If you later wanted to expand D, you could do
1115 * |[ glk_window_set_arrangement(o2, #winmethod_Above | #winmethod_Fixed, 5, NULL); ]|
1116 * That expands D to five rows. Note that, since O2's key window is already set
1117 * to D, it is not necessary to provide the @keywin argument; you can pass %NULL
1118 * to mean <quote>leave the key window unchanged.</quote>
1120 * If you do change the key window of a pair window, the new key window
1121 * <emphasis>must</emphasis> be a descendant of that pair window. In the current
1122 * example, you could change O2's key window to be A, but not B. The key window
1123 * also cannot be a pair window itself.
1125 * |[ glk_window_set_arrangement(o2, #winmethod_Below | #winmethod_Fixed, 3, NULL); ]|
1126 * This changes the constraint to be on the <emphasis>lower</emphasis> child of
1127 * O2, which is A. The key window is still D; so A would then be three rows high
1128 * as measured in D's font, and D would get the rest of O2's space. That may not
1129 * be what you want. To set A to be three rows high as measured in A's font, you
1131 * |[ glk_window_set_arrangement(o2, #winmethod_Below | #winmethod_Fixed, 3, a); ]|
1133 * Or you could change O2 to a proportional split:
1134 * |[ glk_window_set_arrangement(o2, #winmethod_Below | #winmethod_Proportional, 30, NULL); ]|
1136 * |[ glk_window_set_arrangement(o2, #winmethod_Above | #winmethod_Proportional, 70, NULL); ]|
1137 * These do exactly the same thing, since 30% above is the same as
1138 * 70% below. You don't need to specify a key window with a proportional
1139 * split, so the @keywin argument is %NULL. (You could actually specify either A
1140 * or D as the key window, but it wouldn't affect the result.)
1142 * Whatever constraint you set, glk_window_get_size() will tell you the actual
1143 * window size you got.
1145 * Note that you can resize windows, but you can't flip or rotate them. You
1146 * can't move A above D, or change O2 to a vertical split where A is left or
1149 * To get this effect you could close one of the windows, and re-split the
1150 * other one with glk_window_open().
1154 glk_window_set_arrangement(winid_t win, glui32 method, glui32 size, winid_t keywin)
1156 VALID_WINDOW(win, return);
1157 VALID_WINDOW_OR_NULL(keywin, return);
1158 g_return_if_fail(win->type == wintype_Pair);
1161 g_return_if_fail(keywin->type != wintype_Pair);
1162 g_return_if_fail(g_node_is_ancestor(win->window_node, keywin->window_node));
1164 g_return_if_fail(method == (method & (winmethod_DirMask | winmethod_DivisionMask)));
1165 g_return_if_fail(!(((method & winmethod_DivisionMask) == winmethod_Proportional) && size > 100));
1167 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
1169 win->split_method = method;
1170 win->constraint_size = size;
1172 win->key_window = keywin;
1174 /* Tell GTK to rearrange the windows */
1175 gdk_threads_enter();
1176 g_mutex_lock(glk_data->arrange_lock);
1177 glk_data->needs_rearrange = TRUE;
1178 glk_data->ignore_next_arrange_event = TRUE;
1179 g_mutex_unlock(glk_data->arrange_lock);
1180 gtk_widget_queue_resize(GTK_WIDGET(glk_data->self));
1181 gdk_threads_leave();
1185 * glk_window_get_arrangement:
1186 * @win: a pair window.
1187 * @methodptr: return location for the constraint flags of @win, or %NULL.
1188 * @sizeptr: return location for the constraint size of @win, or %NULL.
1189 * @keywinptr: return location for the key window of @win, or %NULL.
1191 * Queries the constraint of a given pair window.
1194 glk_window_get_arrangement(winid_t win, glui32 *methodptr, glui32 *sizeptr, winid_t *keywinptr)
1196 VALID_WINDOW(win, return);
1197 g_return_if_fail(win->type == wintype_Pair);
1200 *methodptr = win->split_method;
1202 *sizeptr = win->constraint_size;
1204 *keywinptr = win->key_window;
1208 * glk_window_move_cursor:
1209 * @win: A text grid window.
1210 * @xpos: Horizontal cursor position.
1211 * @ypos: Vertical cursor position.
1213 * Sets the cursor position. If you move the cursor right past the end of a
1214 * line, it wraps; the next character which is printed will appear at the
1215 * beginning of the next line.
1217 * If you move the cursor below the last line, or when the cursor reaches the
1218 * end of the last line, it goes <quote>off the screen</quote> and further
1219 * output has no effect. You must call glk_window_move_cursor() or
1220 * glk_window_clear() to move the cursor back into the visible region.
1223 * Note that the arguments of glk_window_move_cursor() are <type>unsigned
1224 * int</type>s. This is okay, since there are no negative positions. If you try
1225 * to pass a negative value, Glk will interpret it as a huge positive value,
1226 * and it will wrap or go off the last line.
1230 * Also note that the output cursor is not necessarily visible. In particular,
1231 * when you are requesting line or character input in a grid window, you cannot
1232 * rely on the cursor position to prompt the player where input is indicated.
1233 * You should print some character prompt at that spot — a
1234 * <quote>></quote> character, for example.
1238 glk_window_move_cursor(winid_t win, glui32 xpos, glui32 ypos)
1240 VALID_WINDOW(win, return);
1241 g_return_if_fail(win->type == wintype_TextGrid);
1243 flush_window_buffer(win);
1245 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
1247 /* Wait until the window's size is current */
1248 g_mutex_lock(glk_data->arrange_lock);
1249 if(glk_data->needs_rearrange)
1250 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
1251 g_mutex_unlock(glk_data->arrange_lock);
1253 /* Don't do anything if the window is shrunk down to nothing */
1254 if(win->width == 0 || win->height == 0)
1257 /* Calculate actual position if cursor is moved past the right edge */
1258 if(xpos >= win->width)
1260 ypos += xpos / win->width;
1264 /* Go to the end if the cursor is moved off the bottom edge */
1265 if(ypos >= win->height)
1267 xpos = win->width - 1;
1268 ypos = win->height - 1;
1271 gdk_threads_enter();
1273 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
1275 /* There must actually be a character at xpos, or the following function will choke */
1276 gtk_text_buffer_get_iter_at_line_offset(buffer, &newpos, ypos, xpos);
1277 gtk_text_buffer_move_mark_by_name(buffer, "cursor_position", &newpos);
1279 gdk_threads_leave();