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);
45 window_close_common(winid_t win, gboolean destroy_node)
47 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
49 if(glk_data->unregister_obj)
51 (*glk_data->unregister_obj)(win, gidisp_Class_Window, win->disprock);
52 win->disprock.ptr = NULL;
56 g_node_destroy(win->window_node);
57 win->magic = MAGIC_FREE;
59 g_list_foreach(win->history, (GFunc)g_free, NULL);
60 g_list_free(win->history);
62 g_string_free(win->buffer, TRUE);
63 g_hash_table_destroy(win->hyperlinks);
64 g_free(win->current_hyperlink);
70 * @win: A window, or %NULL.
71 * @rockptr: Return location for the next window's rock, or %NULL.
73 * This function can be used to iterate through the list of all open windows
74 * (including pair windows.) See <link
75 * linkend="chimara-Iterating-Through-Opaque-Objects">Iterating Through Opaque
78 * As that section describes, the order in which windows are returned is
79 * arbitrary. The root window is not necessarily first, nor is it necessarily
82 * Returns: the next window, or %NULL if there are no more.
85 glk_window_iterate(winid_t win, glui32 *rockptr)
87 VALID_WINDOW_OR_NULL(win, return NULL);
89 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
93 retnode = glk_data->root_window;
96 GNode *node = win->window_node;
97 if( G_NODE_IS_LEAF(node) )
99 while(node && node->next == NULL)
102 retnode = node->next;
107 retnode = g_node_first_child(node);
109 winid_t retval = retnode? (winid_t)retnode->data : NULL;
111 /* Store the window's rock in rockptr */
112 if(retval && rockptr)
113 *rockptr = glk_window_get_rock(retval);
119 * glk_window_get_rock:
122 * Returns @win's rock value. Pair windows always have rock 0; all other windows
123 * return whatever rock value you created them with.
125 * Returns: A rock value.
128 glk_window_get_rock(winid_t win)
130 VALID_WINDOW(win, return 0);
135 * glk_window_get_type:
138 * Returns @win's type, one of %wintype_Blank, %wintype_Pair,
139 * %wintype_TextBuffer, %wintype_TextGrid, or %wintype_Graphics.
141 * Returns: The window's type.
144 glk_window_get_type(winid_t win)
146 VALID_WINDOW(win, return 0);
151 * glk_window_get_parent:
154 * Returns the window which is the parent of @win. If @win is the root window,
155 * this returns %NULL, since the root window has no parent. Remember that the
156 * parent of every window is a pair window; other window types are always
159 * Returns: A window, or %NULL.
162 glk_window_get_parent(winid_t win)
164 VALID_WINDOW(win, return NULL);
165 /* Value will also be NULL if win is the root window */
166 return (winid_t)win->window_node->parent->data;
170 * glk_window_get_sibling:
173 * Returns the other child of @win's parent. If @win is the root window, this
176 * Returns: A window, or %NULL.
179 glk_window_get_sibling(winid_t win)
181 VALID_WINDOW(win, return NULL);
183 if(G_NODE_IS_ROOT(win->window_node))
185 if(win->window_node->next)
186 return (winid_t)win->window_node->next;
187 return (winid_t)win->window_node->prev;
191 * glk_window_get_root:
193 * Returns the root window. If there are no windows, this returns %NULL.
195 * Returns: A window, or %NULL.
198 glk_window_get_root()
200 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
201 if(glk_data->root_window == NULL)
203 return (winid_t)glk_data->root_window->data;
208 * @split: The window to split to create the new window. Must be 0 if there
209 * are no windows yet.
210 * @method: Position of the new window and method of size computation. One of
211 * %winmethod_Above, %winmethod_Below, %winmethod_Left, or %winmethod_Right
212 * OR'ed with %winmethod_Fixed or %winmethod_Proportional. If @wintype is
213 * %wintype_Blank, then %winmethod_Fixed is not allowed.
214 * @size: Size of the new window, in percentage points if @method is
215 * %winmethod_Proportional, otherwise in characters if @wintype is
216 * %wintype_TextBuffer or %wintype_TextGrid, or pixels if @wintype is
218 * @wintype: Type of the new window. One of %wintype_Blank, %wintype_TextGrid,
219 * %wintype_TextBuffer, or %wintype_Graphics.
220 * @rock: The new window's rock value.
222 * Creates a new window. If there are no windows, the first three arguments are
223 * meaningless. @split <emphasis>must</emphasis> be 0, and @method and @size
224 * are ignored. @wintype is the type of window you're creating, and @rock is
225 * the rock (see <link linkend="chimara-Rocks">Rocks</link>).
227 * If any windows exist, new windows must be created by splitting existing
228 * ones. @split is the window you want to split; this <emphasis>must
229 * not</emphasis> be zero. @method is a mask of constants to specify the
230 * direction and the split method (see below). @size is the size of the split.
231 * @wintype is the type of window you're creating, and @rock is the rock.
233 * Remember that it is possible that the library will be unable to create a new
234 * window, in which case glk_window_open() will return %NULL.
237 * It is acceptable to gracefully exit, if the window you are creating is an
238 * important one — such as your first window. But you should not try to
239 * perform any window operation on the id until you have tested to make sure
243 * The examples we've seen so far have the simplest kind of size control. (Yes,
244 * this is <quote>below</quote>.) Every pair is a percentage split, with
247 * <mathphrase>X</mathphrase>
249 * percent going to one side, and
252 * <mathphrase>(100 - X)</mathphrase>
254 * percent going to the other side. If the player resizes the window, the whole
255 * mess expands, contracts, or stretches in a uniform way.
257 * As I said above, you can also make fixed-size splits. This is a little more
258 * complicated, because you have to know how this fixed size is measured.
260 * Sizes are measured in a way which is different for each window type. For
261 * example, a text grid window is measured by the size of its fixed-width font.
262 * You can make a text grid window which is fixed at a height of four rows, or
263 * ten columns. A text buffer window is measured by the size of its font.
266 * Remember that different windows may use different size fonts. Even two
267 * text grid windows may use fixed-size fonts of different sizes.
270 * Graphics windows are measured in pixels, not characters. Blank windows
271 * aren't measured at all; there's no meaningful way to measure them, and
272 * therefore you can't create a blank window of a fixed size, only of a
273 * proportional (percentage) size.
275 * So to create a text buffer window which takes the top 40% of the original
276 * window's space, you would execute
277 * |[ newwin = #glk_window_open(win, #winmethod_Above | #winmethod_Proportional, 40, #wintype_TextBuffer, 0); ]|
279 * To create a text grid which is always five lines high, at the bottom of the
280 * original window, you would do
281 * |[ newwin = #glk_window_open(win, #winmethod_Below | #winmethod_Fixed, 5, #wintype_TextGrid, 0); ]|
283 * Note that the meaning of the @size argument depends on the @method argument.
284 * If the method is %winmethod_Fixed, it also depends on the @wintype argument.
285 * The new window is then called the <quote>key window</quote> of this split,
286 * because its window type determines how the split size is computed.
289 * For %winmethod_Proportional splits, you can still call the new window the
290 * <quote>key window</quote>. But the key window is not important for
291 * proportional splits, because the size will always be computed as a simple
292 * ratio of the available space, not a fixed size of one child window.
295 * This system is more or less peachy as long as all the constraints work out.
296 * What happens when there is a conflict? The rules are simple. Size control
297 * always flows down the tree, and the player is at the top. Let's bring out an
299 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
300 * <entry><mediaobject><imageobject><imagedata fileref="fig5-7a.png"/>
301 * </imageobject></mediaobject></entry>
302 * <entry><mediaobject><textobject><literallayout class="monospaced">
308 * </literallayout></textobject></mediaobject></entry>
309 * </row></tbody></tgroup></informaltable>
311 * First we split A into A and B, with a 50% proportional split. Then we split
312 * A into A and C, with C above, C being a text grid window, and C gets a fixed
313 * size of two rows (as measured in its own font size). A gets whatever remains
314 * of the 50% it had before.
316 * Now the player stretches the window vertically.
317 * <informalfigure><mediaobject><imageobject><imagedata fileref="fig6.png"/>
318 * </imageobject></mediaobject></informalfigure>
320 * The library figures: the topmost split, the original A/B split, is 50-50. So
321 * B gets half the screen space, and the pair window next to it (the lower
322 * <quote>O</quote>) gets the other half. Then it looks at the lower
323 * <quote>O</quote>. C gets two rows; A gets the rest. All done.
325 * Then the user maliciously starts squeezing the window down, in stages:
326 * <informaltable frame="none"><tgroup cols="5"><tbody><row valign="top">
327 * <entry><mediaobject><imageobject><imagedata fileref="fig5-7a.png"/>
328 * </imageobject></mediaobject></entry>
329 * <entry><mediaobject><imageobject><imagedata fileref="fig7b.png"/>
330 * </imageobject></mediaobject></entry>
331 * <entry><mediaobject><imageobject><imagedata fileref="fig7c.png"/>
332 * </imageobject></mediaobject></entry>
333 * <entry><mediaobject><imageobject><imagedata fileref="fig7d.png"/>
334 * </imageobject></mediaobject></entry>
335 * <entry><mediaobject><imageobject><imagedata fileref="fig7e.png"/>
336 * </imageobject></mediaobject></entry>
337 * </row></tbody></tgroup></informaltable>
339 * The logic remains the same. B always gets half the space. At stage 3,
340 * there's no room left for A, so it winds up with zero height. Nothing
341 * displayed in A will be visible. At stage 4, there isn't even room in the
342 * upper 50% to give C its two rows; so it only gets one. Finally, C is
343 * squashed out of existence as well.
345 * When a window winds up undersized, it remembers what size it should be. In
346 * the example above, A remembers that it should be two rows; if the user
347 * expands the window to the original size, it would return to the original
350 * The downward flow of control is a bit harsh. After all, in stage 4, there's
351 * room for C to have its two rows if only B would give up some of its 50%. But
352 * this does not happen.
355 * This makes life much easier for the Glk library. To determine the
356 * configuration of a window, it only needs to look at the window's
357 * ancestors, never at its descendants. So window layout is a simple
358 * recursive algorithm, no backtracking.
361 * What happens when you split a fixed-size window? The resulting pair window
362 * — that is, the two new parts together — retain the same size
363 * constraint as the original window that was split. The key window for the
364 * original split is still the key window for that split, even though it's now
365 * a grandchild instead of a child.
367 * The easy, and correct, way to think about this is that the size constraint
368 * is stored by a window's parent, not the window itself; and a constraint
369 * consists of a pointer to a key window plus a size value.
371 * <informaltable frame="none"><tgroup cols="6"><tbody><row>
372 * <entry><mediaobject><imageobject><imagedata fileref="fig8a.png"/>
373 * </imageobject></mediaobject></entry>
374 * <entry><mediaobject><textobject><literallayout class="monospaced">
376 * </literallayout></textobject></mediaobject></entry>
377 * <entry><mediaobject><imageobject><imagedata fileref="fig8b.png"/>
378 * </imageobject></mediaobject></entry>
379 * <entry><mediaobject><textobject><literallayout class="monospaced">
383 * </literallayout></textobject></mediaobject></entry>
384 * <entry><mediaobject><imageobject><imagedata fileref="fig8c.png"/>
385 * </imageobject></mediaobject></entry>
386 * <entry><mediaobject><textobject><literallayout class="monospaced">
392 * </literallayout></textobject></mediaobject></entry>
393 * </row></tbody></tgroup></informaltable>
394 * After the first split, the new pair window (O1, which covers the whole
395 * screen) knows that its first child (A) is above the second, and gets 50% of
396 * its own area. (A is the key window for this split, but a proportional split
397 * doesn't care about key windows.)
399 * After the second split, all this remains true; O1 knows that its first child
400 * gets 50% of its space, and A is O1's key window. But now O1's first child is
401 * O2 instead of A. The newer pair window (O2) knows that its first child (C)
402 * is above the second, and gets a fixed size of two rows. (As measured in C's
403 * font, because C is O2's key window.)
405 * If we split C, now, the resulting pair will still be two C-font rows high
406 * — that is, tall enough for two lines of whatever font C displays. For
407 * the sake of example, we'll do this vertically.
408 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
409 * <entry><mediaobject><imageobject><imagedata fileref="fig9.png"/>
410 * </imageobject></mediaobject></entry>
411 * <entry><mediaobject><textobject><literallayout class="monospaced">
419 * </literallayout></textobject></mediaobject></entry>
420 * </row></tbody></tgroup></informaltable>
422 * O3 now knows that its children have a 50-50 left-right split. O2 is still
423 * committed to giving its upper child, O3, two C-font rows. Again, this is
424 * because C is O2's key window.
427 * This turns out to be a good idea, because it means that C, the text grid
428 * window, is still two rows high. If O3 had been a upper-lower split, things
429 * wouldn't work out so neatly. But the rules would still apply. If you don't
430 * like this, don't do it.
433 * Returns: the new window, or %NULL on error.
436 glk_window_open(winid_t split, glui32 method, glui32 size, glui32 wintype,
439 VALID_WINDOW_OR_NULL(split, return NULL);
440 g_return_val_if_fail(method == (method & (winmethod_DirMask | winmethod_DivisionMask)), NULL);
441 g_return_val_if_fail(!(((method & winmethod_DivisionMask) == winmethod_Proportional) && size > 100), NULL);
443 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
445 if(split == NULL && glk_data->root_window != NULL)
447 ILLEGAL("Tried to open a new root window, but there is already a root window");
453 /* Create the new window */
454 winid_t win = window_new_common(rock);
461 /* A blank window will be a label without any text */
462 GtkWidget *label = gtk_label_new("");
463 gtk_widget_show(label);
467 /* A blank window has no size */
469 win->unit_height = 0;
473 case wintype_TextGrid:
475 GtkWidget *textview = gtk_text_view_new();
476 GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(textview) );
478 gtk_text_view_set_wrap_mode( GTK_TEXT_VIEW(textview), GTK_WRAP_NONE );
479 gtk_text_view_set_editable( GTK_TEXT_VIEW(textview), FALSE );
480 gtk_widget_show(textview);
482 /* Create the styles available to the window stream */
483 style_init_textgrid(textbuffer);
484 gtk_widget_modify_font( textview, get_current_font(wintype) );
486 win->widget = textview;
487 win->frame = textview;
489 /* Determine the size of a "0" character in pixels */
490 PangoLayout *zero = gtk_widget_create_pango_layout(textview, "0");
491 pango_layout_set_font_description( zero, get_current_font(wintype) );
492 pango_layout_get_pixel_size(zero, &(win->unit_width), &(win->unit_height));
493 g_object_unref(zero);
494 /* width and height are set later */
496 /* Connect signal handlers */
497 win->char_input_keypress_handler = g_signal_connect(textview, "key-press-event", G_CALLBACK(on_char_input_key_press_event), win);
498 g_signal_handler_block(textview, win->char_input_keypress_handler);
499 win->line_input_keypress_handler = g_signal_connect(textview, "key-press-event", G_CALLBACK(on_line_input_key_press_event), win);
500 g_signal_handler_block(textview, win->line_input_keypress_handler);
504 case wintype_TextBuffer:
506 GtkWidget *scrolledwindow = gtk_scrolled_window_new(NULL, NULL);
507 GtkWidget *textview = gtk_text_view_new();
508 GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(textview) );
510 gtk_scrolled_window_set_policy( GTK_SCROLLED_WINDOW(scrolledwindow), GTK_POLICY_NEVER, GTK_POLICY_AUTOMATIC );
512 gtk_text_view_set_wrap_mode( GTK_TEXT_VIEW(textview), GTK_WRAP_WORD_CHAR );
513 gtk_text_view_set_editable( GTK_TEXT_VIEW(textview), FALSE );
514 gtk_text_view_set_pixels_inside_wrap( GTK_TEXT_VIEW(textview), 3 );
515 gtk_text_view_set_left_margin( GTK_TEXT_VIEW(textview), 20 );
516 gtk_text_view_set_right_margin( GTK_TEXT_VIEW(textview), 20 );
518 gtk_container_add( GTK_CONTAINER(scrolledwindow), textview );
519 gtk_widget_show_all(scrolledwindow);
521 /* Create the styles available to the window stream */
522 style_init_textbuffer(textbuffer);
523 gtk_widget_modify_font( textview, get_current_font(wintype) );
525 win->widget = textview;
526 win->frame = scrolledwindow;
528 /* Determine the size of a "0" character in pixels */
529 PangoLayout *zero = gtk_widget_create_pango_layout(textview, "0");
530 pango_layout_set_font_description( zero, get_current_font(wintype) );
531 pango_layout_get_pixel_size(zero, &(win->unit_width), &(win->unit_height));
532 g_object_unref(zero);
534 /* Connect signal handlers */
535 win->char_input_keypress_handler = g_signal_connect( textview, "key-press-event", G_CALLBACK(on_char_input_key_press_event), win );
536 g_signal_handler_block(textview, win->char_input_keypress_handler);
537 win->line_input_keypress_handler = g_signal_connect( textview, "key-press-event", G_CALLBACK(on_line_input_key_press_event), win );
538 g_signal_handler_block(textview, win->line_input_keypress_handler);
540 win->insert_text_handler = g_signal_connect_after( textbuffer, "insert-text", G_CALLBACK(after_window_insert_text), win );
541 g_signal_handler_block(textbuffer, win->insert_text_handler);
544 /* Create an editable tag to indicate uneditable parts of the window
546 gtk_text_buffer_create_tag(textbuffer, "uneditable", "editable", FALSE, "editable-set", TRUE, NULL);
548 /* Mark the position where the user will input text */
550 gtk_text_buffer_get_end_iter(textbuffer, &end);
551 gtk_text_buffer_create_mark(textbuffer, "input_position", &end, TRUE);
557 ILLEGAL_PARAM("Unknown window type: %u", wintype);
559 g_node_destroy(glk_data->root_window);
560 glk_data->root_window = NULL;
564 /* Set the minimum size to "as small as possible" so it doesn't depend on
565 the size of the window contents */
566 gtk_widget_set_size_request(win->widget, 0, 0);
567 gtk_widget_set_size_request(win->frame, 0, 0);
571 /* When splitting, construct a new parent window
572 * copying most characteristics from the window that is being split */
573 winid_t pair = window_new_common(0);
574 pair->type = wintype_Pair;
576 /* The pair window must know about its children's split method */
577 pair->key_window = win;
578 pair->split_method = method;
579 pair->constraint_size = size;
581 /* Insert the new window into the window tree */
582 if(split->window_node->parent == NULL)
583 glk_data->root_window = pair->window_node;
586 if( split->window_node == g_node_first_sibling(split->window_node) )
587 g_node_prepend(split->window_node->parent, pair->window_node);
589 g_node_append(split->window_node->parent, pair->window_node);
590 g_node_unlink(split->window_node);
592 /* Place the windows in the correct order */
593 switch(method & winmethod_DirMask)
596 case winmethod_Above:
597 g_node_append(pair->window_node, win->window_node);
598 g_node_append(pair->window_node, split->window_node);
600 case winmethod_Right:
601 case winmethod_Below:
602 g_node_append(pair->window_node, split->window_node);
603 g_node_append(pair->window_node, win->window_node);
608 /* Set the window as root window */
609 glk_data->root_window = win->window_node;
612 /* Set the window as a child of the Glk widget, don't trigger an arrange event */
613 g_mutex_lock(glk_data->arrange_lock);
614 glk_data->needs_rearrange = TRUE;
615 glk_data->ignore_next_arrange_event = TRUE;
616 g_mutex_unlock(glk_data->arrange_lock);
617 gtk_widget_set_parent(win->frame, GTK_WIDGET(glk_data->self));
618 gtk_widget_queue_resize(GTK_WIDGET(glk_data->self));
620 /* For text grid windows, fill the buffer with blanks. */
621 if(wintype == wintype_TextGrid)
623 /* Create the cursor position mark */
625 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
626 gtk_text_buffer_get_start_iter(buffer, &begin);
627 gtk_text_buffer_create_mark(buffer, "cursor_position", &begin, TRUE);
631 glk_window_clear(win);
635 /* Internal function: if node's key window is closing_win or one of its
636 children, set node's key window to NULL. */
638 remove_key_windows(GNode *node, winid_t closing_win)
640 winid_t win = (winid_t)node->data;
641 if(win->key_window && (win->key_window == closing_win || g_node_is_ancestor(closing_win->window_node, win->key_window->window_node)))
642 win->key_window = NULL;
643 return FALSE; /* Don't stop the traversal */
646 /* Internal function: destroy this window's GTK widgets, window streams,
647 and those of all its children. GDK threads must be locked. */
649 destroy_windows_below(winid_t win, stream_result_t *result)
654 case wintype_TextGrid:
655 case wintype_TextBuffer:
656 gtk_widget_unparent(win->frame);
660 destroy_windows_below(win->window_node->children->data, NULL);
661 destroy_windows_below(win->window_node->children->next->data, NULL);
665 ILLEGAL_PARAM("Unknown window type: %u", win->type);
668 stream_close_common(win->window_stream, result);
671 /* Internal function: free the winid_t structure of this window and those of all its children */
673 free_winids_below(winid_t win)
675 if(win->type == wintype_Pair) {
676 free_winids_below(win->window_node->children->data);
677 free_winids_below(win->window_node->children->next->data);
679 window_close_common(win, FALSE);
684 * @win: Window to close.
685 * @result: Pointer to a #stream_result_t in which to store the write count.
687 * Closes @win, which is pretty much exactly the opposite of opening a window.
688 * It is legal to close all your windows, or to close the root window (which is
691 * The @result argument is filled with the output character count of the window
692 * stream. See <link linkend="chimara-Streams">Streams</link> and <link
693 * linkend="chimara-Closing-Streams">Closing Streams</link>.
695 * When you close a window (and it is not the root window), the other window
696 * in its pair takes over all the freed-up area. Let's close D, in the current
698 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
699 * <entry><mediaobject><imageobject><imagedata fileref="fig10.png"/>
700 * </imageobject></mediaobject></entry>
701 * <entry><mediaobject><textobject><literallayout class="monospaced">
707 * </literallayout></textobject></mediaobject></entry>
708 * </row></tbody></tgroup></informaltable>
710 * Notice what has happened. D is gone. O3 is gone, and its 50-50 left-right
711 * split has gone with it. The other size constraints are unchanged; O2 is
712 * still committed to giving its upper child two rows, as measured in the font
713 * of O2's key window, which is C. Conveniently, O2's upper child is C, just as
714 * it was before we created D. In fact, now that D is gone, everything is back
715 * to the way it was before we created D.
717 * But what if we had closed C instead of D? We would have gotten this:
718 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
719 * <entry><mediaobject><imageobject><imagedata fileref="fig11.png"/>
720 * </imageobject></mediaobject></entry>
721 * <entry><mediaobject><textobject><literallayout class="monospaced">
727 * </literallayout></textobject></mediaobject></entry>
728 * </row></tbody></tgroup></informaltable>
730 * Again, O3 is gone. But D has collapsed to zero height. This is because its
731 * height is controlled by O2, and O2's key window was C, and C is now gone. O2
732 * no longer has a key window at all, so it cannot compute a height for its
733 * upper child, so it defaults to zero.
736 * This may seem to be an inconvenient choice. That is deliberate. You should
737 * not leave a pair window with no key, and the zero-height default reminds
738 * you not to. You can use glk_window_set_arrangement() to set a new split
739 * measurement and key window. See <link
740 * linkend="chimara-Changing-Window-Constraints">Changing Window
741 * Constraints</link>.
745 glk_window_close(winid_t win, stream_result_t *result)
747 VALID_WINDOW(win, return);
749 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
751 gdk_threads_enter(); /* Prevent redraw while we're trashing the window */
753 /* If any pair windows have this window or its children as a key window,
754 set their key window to NULL */
755 g_node_traverse(glk_data->root_window, G_IN_ORDER, G_TRAVERSE_NON_LEAVES, -1, (GNodeTraverseFunc)remove_key_windows, win);
757 /* Close all the window streams and destroy the widgets of this window
758 and below, before trashing the window tree */
759 destroy_windows_below(win, result);
761 /* Then free the winid_t structures below this node, but not this one itself */
762 if(win->type == wintype_Pair) {
763 free_winids_below(win->window_node->children->data);
764 free_winids_below(win->window_node->children->next->data);
766 /* So now we should be left with a skeleton tree hanging off this node */
768 /* Parent window changes from a split window into the sibling window */
769 /* The parent of any window is either a pair window or NULL */
770 GNode *pair_node = win->window_node->parent;
771 /* If win was not the root window: */
772 if(pair_node != NULL)
774 gboolean new_child_on_left = ( pair_node == g_node_first_sibling(pair_node) );
775 GNode *sibling_node = pair_node->children; /* only one child left */
776 GNode *new_parent_node = pair_node->parent;
777 g_node_unlink(pair_node);
778 g_node_unlink(sibling_node);
779 /* pair_node and sibling_node should now be totally unconnected to the tree */
781 if(new_parent_node == NULL)
783 glk_data->root_window = sibling_node;
787 if(new_child_on_left)
788 g_node_prepend(new_parent_node, sibling_node);
790 g_node_append(new_parent_node, sibling_node);
793 window_close_common( (winid_t) pair_node->data, TRUE);
795 else /* it was the root window */
797 glk_data->root_window = NULL;
800 window_close_common(win, FALSE);
802 /* Schedule a redraw */
803 g_mutex_lock(glk_data->arrange_lock);
804 glk_data->needs_rearrange = TRUE;
805 glk_data->ignore_next_arrange_event = TRUE;
806 g_mutex_unlock(glk_data->arrange_lock);
807 gtk_widget_queue_resize( GTK_WIDGET(glk_data->self) );
815 * Erases @win. The meaning of this depends on the window type.
818 * <term>Text buffer</term>
820 * This may do any number of things, such as delete all text in the window, or
821 * print enough blank lines to scroll all text beyond visibility, or insert a
822 * page-break marker which is treated specially by the display part of the
827 * <term>Text grid</term>
829 * This will clear the window, filling all positions with blanks. The window
830 * cursor is moved to the top left corner (position 0,0).
834 * <term>Graphics</term>
836 * Clears the entire window to its current background color. See <link
837 * linkend="chimara-Graphics-Windows">Graphics Windows</link>.
841 * <term>Other window types</term>
842 * <listitem><para>No effect.</para></listitem>
846 * It is illegal to erase a window which has line input pending.
849 glk_window_clear(winid_t win)
851 VALID_WINDOW(win, return);
852 g_return_if_fail(win->input_request_type != INPUT_REQUEST_LINE && win->input_request_type != INPUT_REQUEST_LINE_UNICODE);
854 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
863 case wintype_TextGrid:
864 /* fill the buffer with blanks */
866 /* Wait for the window's size to be updated */
867 g_mutex_lock(glk_data->arrange_lock);
868 if(glk_data->needs_rearrange)
869 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
870 g_mutex_unlock(glk_data->arrange_lock);
874 /* Manually put newlines at the end of each row of characters in the buffer; manual newlines make resizing the window's grid easier. */
875 gchar *blanks = g_strnfill(win->width, ' ');
876 gchar **blanklines = g_new0(gchar *, win->height + 1);
878 for(count = 0; count < win->height; count++)
879 blanklines[count] = blanks;
880 blanklines[win->height] = NULL;
881 gchar *text = g_strjoinv("\n", blanklines);
882 g_free(blanklines); /* not g_strfreev() */
885 GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
886 gtk_text_buffer_set_text(textbuffer, text, -1);
890 gtk_text_buffer_get_start_iter(textbuffer, &begin);
891 gtk_text_buffer_move_mark_by_name(textbuffer, "cursor_position", &begin);
897 case wintype_TextBuffer:
898 /* delete all text in the window */
902 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
903 GtkTextIter start, end;
904 gtk_text_buffer_get_bounds(buffer, &start, &end);
905 gtk_text_buffer_delete(buffer, &start, &end);
912 ILLEGAL_PARAM("Unknown window type: %d", win->type);
918 * @win: A window, or %NULL.
920 * Sets the current stream to @win's window stream. It is exactly equivalent to
921 * |[ #glk_stream_set_current(#glk_window_get_stream(@win)) ]|
922 * See <link linkend="chimara-Streams">Streams</link>.
924 * <note><title>Chimara</title>
926 * Although this is not mentioned in the specification, @win may also be
927 * %NULL, in which case the current stream is also set to %NULL.
931 glk_set_window(winid_t win)
933 VALID_WINDOW_OR_NULL(win, return);
935 glk_stream_set_current( glk_window_get_stream(win) );
937 glk_stream_set_current(NULL);
941 * glk_window_get_stream:
944 * Returns the stream which is associated with @win. (See <link
945 * linkend="chimara-Window-Streams">Window Streams</link>.) Every window has a
946 * stream which can be printed to, but this may not be useful, depending on the
950 * For example, printing to a blank window's stream has no effect.
953 * Returns: A window stream.
955 strid_t glk_window_get_stream(winid_t win)
957 VALID_WINDOW(win, return NULL);
958 return win->window_stream;
962 * glk_window_set_echo_stream:
964 * @str: A stream to attach to the window, or %NULL.
966 * Sets @win's echo stream to @str, which can be any valid output stream. You
967 * can reset a window to stop echoing by calling
968 * <code>#glk_window_set_echo_stream(@win, %NULL)</code>.
970 * It is illegal to set a window's echo stream to be its
971 * <emphasis>own</emphasis> window stream. That would create an infinite loop,
972 * and is nearly certain to crash the Glk library. It is similarly illegal to
973 * create a longer loop (two or more windows echoing to each other.)
976 glk_window_set_echo_stream(winid_t win, strid_t str)
978 VALID_WINDOW(win, return);
979 VALID_STREAM_OR_NULL(str, return);
981 /* Test for an infinite loop */
983 for(; next && next->type == STREAM_TYPE_WINDOW; next = next->window->echo_stream)
985 if(next == win->window_stream)
987 ILLEGAL("Infinite loop detected");
988 win->echo_stream = NULL;
993 win->echo_stream = str;
997 * glk_window_get_echo_stream:
1000 * Returns the echo stream of window @win. Initially, a window has no echo
1001 * stream, so <code>#glk_window_get_echo_stream(@win)</code> will return %NULL.
1003 * Returns: A stream, or %NULL.
1006 glk_window_get_echo_stream(winid_t win)
1008 VALID_WINDOW(win, return NULL);
1009 return win->echo_stream;
1013 * glk_window_get_size:
1015 * @widthptr: Pointer to a location to store the window's width, or %NULL.
1016 * @heightptr: Pointer to a location to store the window's height, or %NULL.
1018 * Simply returns the actual size of the window, in its measurement system.
1019 * As described in <link linkend="chimara-Other-API-Conventions">Other API
1020 * Conventions</link>, either @widthptr or @heightptr can be %NULL, if you
1021 * only want one measurement.
1023 * <note><para>Or, in fact, both, if you want to waste time.</para></note>
1026 glk_window_get_size(winid_t win, glui32 *widthptr, glui32 *heightptr)
1028 VALID_WINDOW(win, return);
1030 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
1036 if(widthptr != NULL)
1038 if(heightptr != NULL)
1042 case wintype_TextGrid:
1043 /* Wait until the window's size is current */
1044 g_mutex_lock(glk_data->arrange_lock);
1045 if(glk_data->needs_rearrange)
1046 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
1047 g_mutex_unlock(glk_data->arrange_lock);
1049 gdk_threads_enter();
1050 /* Cache the width and height */
1051 win->width = (glui32)(win->widget->allocation.width / win->unit_width);
1052 win->height = (glui32)(win->widget->allocation.height / win->unit_height);
1053 gdk_threads_leave();
1055 if(widthptr != NULL)
1056 *widthptr = win->width;
1057 if(heightptr != NULL)
1058 *heightptr = win->height;
1061 case wintype_TextBuffer:
1062 /* Wait until the window's size is current */
1063 g_mutex_lock(glk_data->arrange_lock);
1064 if(glk_data->needs_rearrange)
1065 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
1066 g_mutex_unlock(glk_data->arrange_lock);
1068 gdk_threads_enter();
1069 if(widthptr != NULL)
1070 *widthptr = (glui32)(win->widget->allocation.width / win->unit_width);
1071 if(heightptr != NULL)
1072 *heightptr = (glui32)(win->widget->allocation.height / win->unit_height);
1073 gdk_threads_leave();
1078 ILLEGAL_PARAM("Unknown window type: %u", win->type);
1083 * glk_window_set_arrangement:
1084 * @win: a pair window to rearrange.
1085 * @method: new method of size computation. One of %winmethod_Above,
1086 * %winmethod_Below, %winmethod_Left, or %winmethod_Right OR'ed with
1087 * %winmethod_Fixed or %winmethod_Proportional.
1088 * @size: new size constraint, in percentage points if @method is
1089 * %winmethod_Proportional, otherwise in characters if @win's type is
1090 * %wintype_TextBuffer or %wintype_TextGrid, or pixels if @win's type is
1091 * %wintype_Graphics.
1092 * @keywin: new key window, or %NULL to leave the key window unchanged.
1094 * Changes the size of an existing split — that is, it changes the
1095 * constraint of a given pair window.
1097 * Consider the example above, where D has collapsed to zero height. Say D was a
1098 * text buffer window. You could make a more useful layout by doing
1101 * o2 = #glk_window_get_parent(d);
1102 * glk_window_set_arrangement(o2, #winmethod_Above | #winmethod_Fixed, 3, d);
1104 * That would set D (the upper child of O2) to be O2's key window, and give it a
1105 * fixed size of 3 rows.
1107 * If you later wanted to expand D, you could do
1108 * |[ glk_window_set_arrangement(o2, #winmethod_Above | #winmethod_Fixed, 5, NULL); ]|
1109 * That expands D to five rows. Note that, since O2's key window is already set
1110 * to D, it is not necessary to provide the @keywin argument; you can pass %NULL
1111 * to mean <quote>leave the key window unchanged.</quote>
1113 * If you do change the key window of a pair window, the new key window
1114 * <emphasis>must</emphasis> be a descendant of that pair window. In the current
1115 * example, you could change O2's key window to be A, but not B. The key window
1116 * also cannot be a pair window itself.
1118 * |[ glk_window_set_arrangement(o2, #winmethod_Below | #winmethod_Fixed, 3, NULL); ]|
1119 * This changes the constraint to be on the <emphasis>lower</emphasis> child of
1120 * O2, which is A. The key window is still D; so A would then be three rows high
1121 * as measured in D's font, and D would get the rest of O2's space. That may not
1122 * be what you want. To set A to be three rows high as measured in A's font, you
1124 * |[ glk_window_set_arrangement(o2, #winmethod_Below | #winmethod_Fixed, 3, a); ]|
1126 * Or you could change O2 to a proportional split:
1127 * |[ glk_window_set_arrangement(o2, #winmethod_Below | #winmethod_Proportional, 30, NULL); ]|
1129 * |[ glk_window_set_arrangement(o2, #winmethod_Above | #winmethod_Proportional, 70, NULL); ]|
1130 * These do exactly the same thing, since 30% above is the same as
1131 * 70% below. You don't need to specify a key window with a proportional
1132 * split, so the @keywin argument is %NULL. (You could actually specify either A
1133 * or D as the key window, but it wouldn't affect the result.)
1135 * Whatever constraint you set, glk_window_get_size() will tell you the actual
1136 * window size you got.
1138 * Note that you can resize windows, but you can't flip or rotate them. You
1139 * can't move A above D, or change O2 to a vertical split where A is left or
1142 * To get this effect you could close one of the windows, and re-split the
1143 * other one with glk_window_open().
1147 glk_window_set_arrangement(winid_t win, glui32 method, glui32 size, winid_t keywin)
1149 VALID_WINDOW(win, return);
1150 VALID_WINDOW_OR_NULL(keywin, return);
1151 g_return_if_fail(win->type == wintype_Pair);
1154 g_return_if_fail(keywin->type != wintype_Pair);
1155 g_return_if_fail(g_node_is_ancestor(win->window_node, keywin->window_node));
1157 g_return_if_fail(method == (method & (winmethod_DirMask | winmethod_DivisionMask)));
1158 g_return_if_fail(!(((method & winmethod_DivisionMask) == winmethod_Proportional) && size > 100));
1160 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
1162 win->split_method = method;
1163 win->constraint_size = size;
1165 win->key_window = keywin;
1167 /* Tell GTK to rearrange the windows */
1168 gdk_threads_enter();
1169 g_mutex_lock(glk_data->arrange_lock);
1170 glk_data->needs_rearrange = TRUE;
1171 glk_data->ignore_next_arrange_event = TRUE;
1172 g_mutex_unlock(glk_data->arrange_lock);
1173 gtk_widget_queue_resize(GTK_WIDGET(glk_data->self));
1174 gdk_threads_leave();
1178 * glk_window_get_arrangement:
1179 * @win: a pair window.
1180 * @methodptr: return location for the constraint flags of @win, or %NULL.
1181 * @sizeptr: return location for the constraint size of @win, or %NULL.
1182 * @keywinptr: return location for the key window of @win, or %NULL.
1184 * Queries the constraint of a given pair window.
1187 glk_window_get_arrangement(winid_t win, glui32 *methodptr, glui32 *sizeptr, winid_t *keywinptr)
1189 VALID_WINDOW(win, return);
1190 g_return_if_fail(win->type == wintype_Pair);
1193 *methodptr = win->split_method;
1195 *sizeptr = win->constraint_size;
1197 *keywinptr = win->key_window;
1201 * glk_window_move_cursor:
1202 * @win: A text grid window.
1203 * @xpos: Horizontal cursor position.
1204 * @ypos: Vertical cursor position.
1206 * Sets the cursor position. If you move the cursor right past the end of a
1207 * line, it wraps; the next character which is printed will appear at the
1208 * beginning of the next line.
1210 * If you move the cursor below the last line, or when the cursor reaches the
1211 * end of the last line, it goes <quote>off the screen</quote> and further
1212 * output has no effect. You must call glk_window_move_cursor() or
1213 * glk_window_clear() to move the cursor back into the visible region.
1216 * Note that the arguments of glk_window_move_cursor() are <type>unsigned
1217 * int</type>s. This is okay, since there are no negative positions. If you try
1218 * to pass a negative value, Glk will interpret it as a huge positive value,
1219 * and it will wrap or go off the last line.
1223 * Also note that the output cursor is not necessarily visible. In particular,
1224 * when you are requesting line or character input in a grid window, you cannot
1225 * rely on the cursor position to prompt the player where input is indicated.
1226 * You should print some character prompt at that spot — a
1227 * <quote>></quote> character, for example.
1231 glk_window_move_cursor(winid_t win, glui32 xpos, glui32 ypos)
1233 VALID_WINDOW(win, return);
1234 g_return_if_fail(win->type == wintype_TextGrid);
1236 flush_window_buffer(win);
1238 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
1240 /* Wait until the window's size is current */
1241 g_mutex_lock(glk_data->arrange_lock);
1242 if(glk_data->needs_rearrange)
1243 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
1244 g_mutex_unlock(glk_data->arrange_lock);
1246 /* Don't do anything if the window is shrunk down to nothing */
1247 if(win->width == 0 || win->height == 0)
1250 /* Calculate actual position if cursor is moved past the right edge */
1251 if(xpos >= win->width)
1253 ypos += xpos / win->width;
1257 /* Go to the end if the cursor is moved off the bottom edge */
1258 if(ypos >= win->height)
1260 xpos = win->width - 1;
1261 ypos = win->height - 1;
1264 gdk_threads_enter();
1266 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
1268 /* There must actually be a character at xpos, or the following function will choke */
1269 gtk_text_buffer_get_iter_at_line_offset(buffer, &newpos, ypos, xpos);
1270 gtk_text_buffer_move_mark_by_name(buffer, "cursor_position", &newpos);
1272 gdk_threads_leave();