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;
34 /* Initialise the buffer */
35 win->buffer = g_string_sized_new(1024);
41 window_close_common(winid_t win, gboolean destroy_node)
43 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
45 if(glk_data->unregister_obj)
47 (*glk_data->unregister_obj)(win, gidisp_Class_Window, win->disprock);
48 win->disprock.ptr = NULL;
52 g_node_destroy(win->window_node);
53 win->magic = MAGIC_FREE;
55 g_string_free(win->buffer, TRUE);
61 * @win: A window, or %NULL.
62 * @rockptr: Return location for the next window's rock, or %NULL.
64 * This function can be used to iterate through the list of all open windows
65 * (including pair windows.) See <link
66 * linkend="chimara-Iterating-Through-Opaque-Objects">Iterating Through Opaque
69 * As that section describes, the order in which windows are returned is
70 * arbitrary. The root window is not necessarily first, nor is it necessarily
73 * Returns: the next window, or %NULL if there are no more.
76 glk_window_iterate(winid_t win, glui32 *rockptr)
78 VALID_WINDOW_OR_NULL(win, return NULL);
80 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
84 retnode = glk_data->root_window;
87 GNode *node = win->window_node;
88 if( G_NODE_IS_LEAF(node) )
90 while(node && node->next == NULL)
98 retnode = g_node_first_child(node);
100 winid_t retval = retnode? (winid_t)retnode->data : NULL;
102 /* Store the window's rock in rockptr */
103 if(retval && rockptr)
104 *rockptr = glk_window_get_rock(retval);
110 * glk_window_get_rock:
113 * Returns @win's rock value. Pair windows always have rock 0; all other windows
114 * return whatever rock value you created them with.
116 * Returns: A rock value.
119 glk_window_get_rock(winid_t win)
121 VALID_WINDOW(win, return 0);
126 * glk_window_get_type:
129 * Returns @win's type, one of %wintype_Blank, %wintype_Pair,
130 * %wintype_TextBuffer, %wintype_TextGrid, or %wintype_Graphics.
132 * Returns: The window's type.
135 glk_window_get_type(winid_t win)
137 VALID_WINDOW(win, return 0);
142 * glk_window_get_parent:
145 * Returns the window which is the parent of @win. If @win is the root window,
146 * this returns %NULL, since the root window has no parent. Remember that the
147 * parent of every window is a pair window; other window types are always
150 * Returns: A window, or %NULL.
153 glk_window_get_parent(winid_t win)
155 VALID_WINDOW(win, return NULL);
156 /* Value will also be NULL if win is the root window */
157 return (winid_t)win->window_node->parent->data;
161 * glk_window_get_sibling:
164 * Returns the other child of @win's parent. If @win is the root window, this
167 * Returns: A window, or %NULL.
170 glk_window_get_sibling(winid_t win)
172 VALID_WINDOW(win, return NULL);
174 if(G_NODE_IS_ROOT(win->window_node))
176 if(win->window_node->next)
177 return (winid_t)win->window_node->next;
178 return (winid_t)win->window_node->prev;
182 * glk_window_get_root:
184 * Returns the root window. If there are no windows, this returns %NULL.
186 * Returns: A window, or %NULL.
189 glk_window_get_root()
191 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
192 if(glk_data->root_window == NULL)
194 return (winid_t)glk_data->root_window->data;
199 * @split: The window to split to create the new window. Must be 0 if there
200 * are no windows yet.
201 * @method: Position of the new window and method of size computation. One of
202 * %winmethod_Above, %winmethod_Below, %winmethod_Left, or %winmethod_Right
203 * OR'ed with %winmethod_Fixed or %winmethod_Proportional. If @wintype is
204 * %wintype_Blank, then %winmethod_Fixed is not allowed.
205 * @size: Size of the new window, in percentage points if @method is
206 * %winmethod_Proportional, otherwise in characters if @wintype is
207 * %wintype_TextBuffer or %wintype_TextGrid, or pixels if @wintype is
209 * @wintype: Type of the new window. One of %wintype_Blank, %wintype_TextGrid,
210 * %wintype_TextBuffer, or %wintype_Graphics.
211 * @rock: The new window's rock value.
213 * Creates a new window. If there are no windows, the first three arguments are
214 * meaningless. @split <emphasis>must</emphasis> be 0, and @method and @size
215 * are ignored. @wintype is the type of window you're creating, and @rock is
216 * the rock (see <link linkend="chimara-Rocks">Rocks</link>).
218 * If any windows exist, new windows must be created by splitting existing
219 * ones. @split is the window you want to split; this <emphasis>must
220 * not</emphasis> be zero. @method is a mask of constants to specify the
221 * direction and the split method (see below). @size is the size of the split.
222 * @wintype is the type of window you're creating, and @rock is the rock.
224 * Remember that it is possible that the library will be unable to create a new
225 * window, in which case glk_window_open() will return %NULL.
228 * It is acceptable to gracefully exit, if the window you are creating is an
229 * important one — such as your first window. But you should not try to
230 * perform any window operation on the id until you have tested to make sure
234 * The examples we've seen so far have the simplest kind of size control. (Yes,
235 * this is <quote>below</quote>.) Every pair is a percentage split, with
238 * <mathphrase>X</mathphrase>
240 * percent going to one side, and
243 * <mathphrase>(100 - X)</mathphrase>
245 * percent going to the other side. If the player resizes the window, the whole
246 * mess expands, contracts, or stretches in a uniform way.
248 * As I said above, you can also make fixed-size splits. This is a little more
249 * complicated, because you have to know how this fixed size is measured.
251 * Sizes are measured in a way which is different for each window type. For
252 * example, a text grid window is measured by the size of its fixed-width font.
253 * You can make a text grid window which is fixed at a height of four rows, or
254 * ten columns. A text buffer window is measured by the size of its font.
257 * Remember that different windows may use different size fonts. Even two
258 * text grid windows may use fixed-size fonts of different sizes.
261 * Graphics windows are measured in pixels, not characters. Blank windows
262 * aren't measured at all; there's no meaningful way to measure them, and
263 * therefore you can't create a blank window of a fixed size, only of a
264 * proportional (percentage) size.
266 * So to create a text buffer window which takes the top 40% of the original
267 * window's space, you would execute
268 * |[ newwin = #glk_window_open(win, #winmethod_Above | #winmethod_Proportional, 40, #wintype_TextBuffer, 0); ]|
270 * To create a text grid which is always five lines high, at the bottom of the
271 * original window, you would do
272 * |[ newwin = #glk_window_open(win, #winmethod_Below | #winmethod_Fixed, 5, #wintype_TextGrid, 0); ]|
274 * Note that the meaning of the @size argument depends on the @method argument.
275 * If the method is %winmethod_Fixed, it also depends on the @wintype argument.
276 * The new window is then called the <quote>key window</quote> of this split,
277 * because its window type determines how the split size is computed.
280 * For %winmethod_Proportional splits, you can still call the new window the
281 * <quote>key window</quote>. But the key window is not important for
282 * proportional splits, because the size will always be computed as a simple
283 * ratio of the available space, not a fixed size of one child window.
286 * This system is more or less peachy as long as all the constraints work out.
287 * What happens when there is a conflict? The rules are simple. Size control
288 * always flows down the tree, and the player is at the top. Let's bring out an
290 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
291 * <entry><mediaobject><imageobject><imagedata fileref="fig5-7a.png"/>
292 * </imageobject></mediaobject></entry>
293 * <entry><mediaobject><textobject><literallayout class="monospaced">
299 * </literallayout></textobject></mediaobject></entry>
300 * </row></tbody></tgroup></informaltable>
302 * First we split A into A and B, with a 50% proportional split. Then we split
303 * A into A and C, with C above, C being a text grid window, and C gets a fixed
304 * size of two rows (as measured in its own font size). A gets whatever remains
305 * of the 50% it had before.
307 * Now the player stretches the window vertically.
308 * <informalfigure><mediaobject><imageobject><imagedata fileref="fig6.png"/>
309 * </imageobject></mediaobject></informalfigure>
311 * The library figures: the topmost split, the original A/B split, is 50-50. So
312 * B gets half the screen space, and the pair window next to it (the lower
313 * <quote>O</quote>) gets the other half. Then it looks at the lower
314 * <quote>O</quote>. C gets two rows; A gets the rest. All done.
316 * Then the user maliciously starts squeezing the window down, in stages:
317 * <informaltable frame="none"><tgroup cols="5"><tbody><row valign="top">
318 * <entry><mediaobject><imageobject><imagedata fileref="fig5-7a.png"/>
319 * </imageobject></mediaobject></entry>
320 * <entry><mediaobject><imageobject><imagedata fileref="fig7b.png"/>
321 * </imageobject></mediaobject></entry>
322 * <entry><mediaobject><imageobject><imagedata fileref="fig7c.png"/>
323 * </imageobject></mediaobject></entry>
324 * <entry><mediaobject><imageobject><imagedata fileref="fig7d.png"/>
325 * </imageobject></mediaobject></entry>
326 * <entry><mediaobject><imageobject><imagedata fileref="fig7e.png"/>
327 * </imageobject></mediaobject></entry>
328 * </row></tbody></tgroup></informaltable>
330 * The logic remains the same. B always gets half the space. At stage 3,
331 * there's no room left for A, so it winds up with zero height. Nothing
332 * displayed in A will be visible. At stage 4, there isn't even room in the
333 * upper 50% to give C its two rows; so it only gets one. Finally, C is
334 * squashed out of existence as well.
336 * When a window winds up undersized, it remembers what size it should be. In
337 * the example above, A remembers that it should be two rows; if the user
338 * expands the window to the original size, it would return to the original
341 * The downward flow of control is a bit harsh. After all, in stage 4, there's
342 * room for C to have its two rows if only B would give up some of its 50%. But
343 * this does not happen.
346 * This makes life much easier for the Glk library. To determine the
347 * configuration of a window, it only needs to look at the window's
348 * ancestors, never at its descendants. So window layout is a simple
349 * recursive algorithm, no backtracking.
352 * What happens when you split a fixed-size window? The resulting pair window
353 * — that is, the two new parts together — retain the same size
354 * constraint as the original window that was split. The key window for the
355 * original split is still the key window for that split, even though it's now
356 * a grandchild instead of a child.
358 * The easy, and correct, way to think about this is that the size constraint
359 * is stored by a window's parent, not the window itself; and a constraint
360 * consists of a pointer to a key window plus a size value.
362 * <informaltable frame="none"><tgroup cols="6"><tbody><row>
363 * <entry><mediaobject><imageobject><imagedata fileref="fig8a.png"/>
364 * </imageobject></mediaobject></entry>
365 * <entry><mediaobject><textobject><literallayout class="monospaced">
367 * </literallayout></textobject></mediaobject></entry>
368 * <entry><mediaobject><imageobject><imagedata fileref="fig8b.png"/>
369 * </imageobject></mediaobject></entry>
370 * <entry><mediaobject><textobject><literallayout class="monospaced">
374 * </literallayout></textobject></mediaobject></entry>
375 * <entry><mediaobject><imageobject><imagedata fileref="fig8c.png"/>
376 * </imageobject></mediaobject></entry>
377 * <entry><mediaobject><textobject><literallayout class="monospaced">
383 * </literallayout></textobject></mediaobject></entry>
384 * </row></tbody></tgroup></informaltable>
385 * After the first split, the new pair window (O1, which covers the whole
386 * screen) knows that its first child (A) is above the second, and gets 50% of
387 * its own area. (A is the key window for this split, but a proportional split
388 * doesn't care about key windows.)
390 * After the second split, all this remains true; O1 knows that its first child
391 * gets 50% of its space, and A is O1's key window. But now O1's first child is
392 * O2 instead of A. The newer pair window (O2) knows that its first child (C)
393 * is above the second, and gets a fixed size of two rows. (As measured in C's
394 * font, because C is O2's key window.)
396 * If we split C, now, the resulting pair will still be two C-font rows high
397 * — that is, tall enough for two lines of whatever font C displays. For
398 * the sake of example, we'll do this vertically.
399 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
400 * <entry><mediaobject><imageobject><imagedata fileref="fig9.png"/>
401 * </imageobject></mediaobject></entry>
402 * <entry><mediaobject><textobject><literallayout class="monospaced">
410 * </literallayout></textobject></mediaobject></entry>
411 * </row></tbody></tgroup></informaltable>
413 * O3 now knows that its children have a 50-50 left-right split. O2 is still
414 * committed to giving its upper child, O3, two C-font rows. Again, this is
415 * because C is O2's key window.
418 * This turns out to be a good idea, because it means that C, the text grid
419 * window, is still two rows high. If O3 had been a upper-lower split, things
420 * wouldn't work out so neatly. But the rules would still apply. If you don't
421 * like this, don't do it.
424 * Returns: the new window, or %NULL on error.
427 glk_window_open(winid_t split, glui32 method, glui32 size, glui32 wintype,
430 VALID_WINDOW_OR_NULL(split, return NULL);
431 g_return_val_if_fail(method == (method & (winmethod_DirMask | winmethod_DivisionMask)), NULL);
432 g_return_val_if_fail(!(((method & winmethod_DivisionMask) == winmethod_Proportional) && size > 100), NULL);
434 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
436 if(split == NULL && glk_data->root_window != NULL)
438 ILLEGAL("Tried to open a new root window, but there is already a root window");
444 /* Create the new window */
445 winid_t win = window_new_common(rock);
452 /* A blank window will be a label without any text */
453 GtkWidget *label = gtk_label_new("");
454 gtk_widget_show(label);
458 /* A blank window has no size */
460 win->unit_height = 0;
464 case wintype_TextGrid:
466 GtkWidget *textview = gtk_text_view_new();
467 GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(textview) );
469 gtk_text_view_set_wrap_mode( GTK_TEXT_VIEW(textview), GTK_WRAP_NONE );
470 gtk_text_view_set_editable( GTK_TEXT_VIEW(textview), FALSE );
471 gtk_widget_show(textview);
473 /* Set the window's font */
474 gtk_widget_modify_font(textview, glk_data->monospace_font_desc);
476 win->widget = textview;
477 win->frame = textview;
479 /* Determine the size of a "0" character in pixels */
480 PangoLayout *zero = gtk_widget_create_pango_layout(textview, "0");
481 pango_layout_set_font_description(zero, glk_data->monospace_font_desc);
482 pango_layout_get_pixel_size(zero, &(win->unit_width), &(win->unit_height));
483 g_object_unref(zero);
484 /* width and height are set later */
486 /* Connect signal handlers */
487 win->keypress_handler = g_signal_connect( G_OBJECT(textview), "key-press-event", G_CALLBACK(on_window_key_press_event), win );
488 g_signal_handler_block( G_OBJECT(textview), win->keypress_handler );
490 gtk_widget_add_events( GTK_WIDGET(textview), GDK_BUTTON_RELEASE_MASK );
491 win->mouse_click_handler = g_signal_connect_after( G_OBJECT(textview), "button-release-event", G_CALLBACK(on_window_button_release_event), win );
492 g_signal_handler_block( G_OBJECT(textview), win->mouse_click_handler );
494 /* Create the styles available to the window stream */
495 style_init_textgrid(textbuffer);
499 case wintype_TextBuffer:
501 GtkWidget *scrolledwindow = gtk_scrolled_window_new(NULL, NULL);
502 GtkWidget *textview = gtk_text_view_new();
503 GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(textview) );
505 gtk_scrolled_window_set_policy( GTK_SCROLLED_WINDOW(scrolledwindow), GTK_POLICY_NEVER, GTK_POLICY_AUTOMATIC );
507 gtk_text_view_set_wrap_mode( GTK_TEXT_VIEW(textview), GTK_WRAP_WORD_CHAR );
508 gtk_text_view_set_editable( GTK_TEXT_VIEW(textview), FALSE );
509 gtk_text_view_set_pixels_inside_wrap( GTK_TEXT_VIEW(textview), 3 );
510 gtk_text_view_set_left_margin( GTK_TEXT_VIEW(textview), 20 );
511 gtk_text_view_set_right_margin( GTK_TEXT_VIEW(textview), 20 );
513 gtk_container_add( GTK_CONTAINER(scrolledwindow), textview );
514 gtk_widget_show_all(scrolledwindow);
516 /* Set the window's font */
517 gtk_widget_modify_font(textview, glk_data->default_font_desc);
519 win->widget = textview;
520 win->frame = scrolledwindow;
522 /* Determine the size of a "0" character in pixels */
523 PangoLayout *zero = gtk_widget_create_pango_layout(textview, "0");
524 pango_layout_set_font_description(zero, glk_data->default_font_desc);
525 pango_layout_get_pixel_size(zero, &(win->unit_width), &(win->unit_height));
526 g_object_unref(zero);
528 /* Connect signal handlers */
529 win->keypress_handler = g_signal_connect( G_OBJECT(textview), "key-press-event", G_CALLBACK(on_window_key_press_event), win );
530 g_signal_handler_block( G_OBJECT(textview), win->keypress_handler );
532 gtk_widget_add_events( GTK_WIDGET(textview), GDK_BUTTON_RELEASE_MASK );
533 win->mouse_click_handler = g_signal_connect_after( G_OBJECT(textview), "button-release-event", G_CALLBACK(on_window_button_release_event), win );
534 g_signal_handler_block( G_OBJECT(textview), win->mouse_click_handler );
536 win->insert_text_handler = g_signal_connect_after( G_OBJECT(textbuffer), "insert-text", G_CALLBACK(after_window_insert_text), win );
537 g_signal_handler_block( G_OBJECT(textbuffer), win->insert_text_handler );
540 /* Create an editable tag to indicate uneditable parts of the window
542 gtk_text_buffer_create_tag(textbuffer, "uneditable", "editable", FALSE, "editable-set", TRUE, NULL);
544 /* Create the styles available to the window stream */
545 style_init_textbuffer(textbuffer);
547 /* Mark the position where the user will input text */
549 gtk_text_buffer_get_end_iter(textbuffer, &end);
550 gtk_text_buffer_create_mark(textbuffer, "input_position", &end, TRUE);
556 ILLEGAL_PARAM("Unknown window type: %u", wintype);
558 g_node_destroy(glk_data->root_window);
559 glk_data->root_window = NULL;
563 /* Set the minimum size to "as small as possible" so it doesn't depend on
564 the size of the window contents */
565 gtk_widget_set_size_request(win->widget, 0, 0);
566 gtk_widget_set_size_request(win->frame, 0, 0);
570 /* When splitting, construct a new parent window
571 * copying most characteristics from the window that is being split */
572 winid_t pair = window_new_common(0);
573 pair->type = wintype_Pair;
575 /* The pair window must know about its children's split method */
576 pair->key_window = win;
577 pair->split_method = method;
578 pair->constraint_size = size;
580 /* Insert the new window into the window tree */
581 if(split->window_node->parent == NULL)
582 glk_data->root_window = pair->window_node;
585 if( split->window_node == g_node_first_sibling(split->window_node) )
586 g_node_prepend(split->window_node->parent, pair->window_node);
588 g_node_append(split->window_node->parent, pair->window_node);
589 g_node_unlink(split->window_node);
591 /* Place the windows in the correct order */
592 switch(method & winmethod_DirMask)
595 case winmethod_Above:
596 g_node_append(pair->window_node, win->window_node);
597 g_node_append(pair->window_node, split->window_node);
599 case winmethod_Right:
600 case winmethod_Below:
601 g_node_append(pair->window_node, split->window_node);
602 g_node_append(pair->window_node, win->window_node);
607 /* Set the window as root window */
608 glk_data->root_window = win->window_node;
611 /* Set the window as a child of the Glk widget, don't trigger an arrange event */
612 g_mutex_lock(glk_data->arrange_lock);
613 glk_data->needs_rearrange = TRUE;
614 glk_data->ignore_next_arrange_event = TRUE;
615 g_mutex_unlock(glk_data->arrange_lock);
616 gtk_widget_set_parent(win->frame, GTK_WIDGET(glk_data->self));
617 gtk_widget_queue_resize(GTK_WIDGET(glk_data->self));
619 /* For text grid windows, fill the buffer with blanks. */
620 if(wintype == wintype_TextGrid)
622 /* Create the cursor position mark */
624 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
625 gtk_text_buffer_get_start_iter(buffer, &begin);
626 gtk_text_buffer_create_mark(buffer, "cursor_position", &begin, TRUE);
630 glk_window_clear(win);
634 /* Internal function: if node's key window is closing_win or one of its
635 children, set node's key window to NULL. */
637 remove_key_windows(GNode *node, winid_t closing_win)
639 winid_t win = (winid_t)node->data;
640 if(win->key_window && (win->key_window == closing_win || g_node_is_ancestor(closing_win->window_node, win->key_window->window_node)))
641 win->key_window = NULL;
642 return FALSE; /* Don't stop the traversal */
645 /* Internal function: destroy this window's GTK widgets, window streams,
646 and those of all its children. GDK threads must be locked. */
648 destroy_windows_below(winid_t win, stream_result_t *result)
653 case wintype_TextGrid:
654 case wintype_TextBuffer:
655 gtk_widget_unparent(win->frame);
659 destroy_windows_below(win->window_node->children->data, NULL);
660 destroy_windows_below(win->window_node->children->next->data, NULL);
664 ILLEGAL_PARAM("Unknown window type: %u", win->type);
667 stream_close_common(win->window_stream, result);
670 /* Internal function: free the winid_t structure of this window and those of all its children */
672 free_winids_below(winid_t win)
674 if(win->type == wintype_Pair) {
675 free_winids_below(win->window_node->children->data);
676 free_winids_below(win->window_node->children->next->data);
678 window_close_common(win, FALSE);
683 * @win: Window to close.
684 * @result: Pointer to a #stream_result_t in which to store the write count.
686 * Closes @win, which is pretty much exactly the opposite of opening a window.
687 * It is legal to close all your windows, or to close the root window (which is
690 * The @result argument is filled with the output character count of the window
691 * stream. See <link linkend="chimara-Streams">Streams</link> and <link
692 * linkend="chimara-Closing-Streams">Closing Streams</link>.
694 * When you close a window (and it is not the root window), the other window
695 * in its pair takes over all the freed-up area. Let's close D, in the current
697 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
698 * <entry><mediaobject><imageobject><imagedata fileref="fig10.png"/>
699 * </imageobject></mediaobject></entry>
700 * <entry><mediaobject><textobject><literallayout class="monospaced">
706 * </literallayout></textobject></mediaobject></entry>
707 * </row></tbody></tgroup></informaltable>
709 * Notice what has happened. D is gone. O3 is gone, and its 50-50 left-right
710 * split has gone with it. The other size constraints are unchanged; O2 is
711 * still committed to giving its upper child two rows, as measured in the font
712 * of O2's key window, which is C. Conveniently, O2's upper child is C, just as
713 * it was before we created D. In fact, now that D is gone, everything is back
714 * to the way it was before we created D.
716 * But what if we had closed C instead of D? We would have gotten this:
717 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
718 * <entry><mediaobject><imageobject><imagedata fileref="fig11.png"/>
719 * </imageobject></mediaobject></entry>
720 * <entry><mediaobject><textobject><literallayout class="monospaced">
726 * </literallayout></textobject></mediaobject></entry>
727 * </row></tbody></tgroup></informaltable>
729 * Again, O3 is gone. But D has collapsed to zero height. This is because its
730 * height is controlled by O2, and O2's key window was C, and C is now gone. O2
731 * no longer has a key window at all, so it cannot compute a height for its
732 * upper child, so it defaults to zero.
735 * This may seem to be an inconvenient choice. That is deliberate. You should
736 * not leave a pair window with no key, and the zero-height default reminds
737 * you not to. You can use glk_window_set_arrangement() to set a new split
738 * measurement and key window. See <link
739 * linkend="chimara-Changing-Window-Constraints">Changing Window
740 * Constraints</link>.
744 glk_window_close(winid_t win, stream_result_t *result)
746 VALID_WINDOW(win, return);
748 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
750 gdk_threads_enter(); /* Prevent redraw while we're trashing the window */
752 /* If any pair windows have this window or its children as a key window,
753 set their key window to NULL */
754 g_node_traverse(glk_data->root_window, G_IN_ORDER, G_TRAVERSE_NON_LEAVES, -1, (GNodeTraverseFunc)remove_key_windows, win);
756 /* Close all the window streams and destroy the widgets of this window
757 and below, before trashing the window tree */
758 destroy_windows_below(win, result);
760 /* Then free the winid_t structures below this node, but not this one itself */
761 if(win->type == wintype_Pair) {
762 free_winids_below(win->window_node->children->data);
763 free_winids_below(win->window_node->children->next->data);
765 /* So now we should be left with a skeleton tree hanging off this node */
767 /* Parent window changes from a split window into the sibling window */
768 /* The parent of any window is either a pair window or NULL */
769 GNode *pair_node = win->window_node->parent;
770 /* If win was not the root window: */
771 if(pair_node != NULL)
773 gboolean new_child_on_left = ( pair_node == g_node_first_sibling(pair_node) );
774 GNode *sibling_node = pair_node->children; /* only one child left */
775 GNode *new_parent_node = pair_node->parent;
776 g_node_unlink(pair_node);
777 g_node_unlink(sibling_node);
778 /* pair_node and sibling_node should now be totally unconnected to the tree */
780 if(new_parent_node == NULL)
782 glk_data->root_window = sibling_node;
786 if(new_child_on_left)
787 g_node_prepend(new_parent_node, sibling_node);
789 g_node_append(new_parent_node, sibling_node);
792 window_close_common( (winid_t) pair_node->data, TRUE);
794 else /* it was the root window */
796 glk_data->root_window = NULL;
799 window_close_common(win, FALSE);
801 /* Schedule a redraw */
802 g_mutex_lock(glk_data->arrange_lock);
803 glk_data->needs_rearrange = TRUE;
804 glk_data->ignore_next_arrange_event = TRUE;
805 g_mutex_unlock(glk_data->arrange_lock);
806 gtk_widget_queue_resize( GTK_WIDGET(glk_data->self) );
814 * Erases @win. The meaning of this depends on the window type.
817 * <term>Text buffer</term>
819 * This may do any number of things, such as delete all text in the window, or
820 * print enough blank lines to scroll all text beyond visibility, or insert a
821 * page-break marker which is treated specially by the display part of the
826 * <term>Text grid</term>
828 * This will clear the window, filling all positions with blanks. The window
829 * cursor is moved to the top left corner (position 0,0).
833 * <term>Graphics</term>
835 * Clears the entire window to its current background color. See <link
836 * linkend="chimara-Graphics-Windows">Graphics Windows</link>.
840 * <term>Other window types</term>
841 * <listitem><para>No effect.</para></listitem>
845 * It is illegal to erase a window which has line input pending.
848 glk_window_clear(winid_t win)
850 VALID_WINDOW(win, return);
851 g_return_if_fail(win->input_request_type != INPUT_REQUEST_LINE && win->input_request_type != INPUT_REQUEST_LINE_UNICODE);
853 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
862 case wintype_TextGrid:
863 /* fill the buffer with blanks */
865 /* Wait for the window's size to be updated */
866 g_mutex_lock(glk_data->arrange_lock);
867 if(glk_data->needs_rearrange)
868 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
869 g_mutex_unlock(glk_data->arrange_lock);
873 /* Manually put newlines at the end of each row of characters in the buffer; manual newlines make resizing the window's grid easier. */
874 gchar *blanks = g_strnfill(win->width, ' ');
875 gchar **blanklines = g_new0(gchar *, win->height + 1);
877 for(count = 0; count < win->height; count++)
878 blanklines[count] = blanks;
879 blanklines[win->height] = NULL;
880 gchar *text = g_strjoinv("\n", blanklines);
881 g_free(blanklines); /* not g_strfreev() */
884 GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
885 gtk_text_buffer_set_text(textbuffer, text, -1);
889 gtk_text_buffer_get_start_iter(textbuffer, &begin);
890 gtk_text_buffer_move_mark_by_name(textbuffer, "cursor_position", &begin);
896 case wintype_TextBuffer:
897 /* delete all text in the window */
901 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
902 GtkTextIter start, end;
903 gtk_text_buffer_get_bounds(buffer, &start, &end);
904 gtk_text_buffer_delete(buffer, &start, &end);
911 ILLEGAL_PARAM("Unknown window type: %d", win->type);
917 * @win: A window, or %NULL.
919 * Sets the current stream to @win's window stream. It is exactly equivalent to
920 * |[ #glk_stream_set_current(#glk_window_get_stream(@win)) ]|
921 * See <link linkend="chimara-Streams">Streams</link>.
923 * <note><title>Chimara</title>
925 * Although this is not mentioned in the specification, @win may also be
926 * %NULL, in which case the current stream is also set to %NULL.
930 glk_set_window(winid_t win)
932 VALID_WINDOW_OR_NULL(win, return);
934 glk_stream_set_current( glk_window_get_stream(win) );
936 glk_stream_set_current(NULL);
940 * glk_window_get_stream:
943 * Returns the stream which is associated with @win. (See <link
944 * linkend="chimara-Window-Streams">Window Streams</link>.) Every window has a
945 * stream which can be printed to, but this may not be useful, depending on the
949 * For example, printing to a blank window's stream has no effect.
952 * Returns: A window stream.
954 strid_t glk_window_get_stream(winid_t win)
956 VALID_WINDOW(win, return NULL);
957 return win->window_stream;
961 * glk_window_set_echo_stream:
963 * @str: A stream to attach to the window, or %NULL.
965 * Sets @win's echo stream to @str, which can be any valid output stream. You
966 * can reset a window to stop echoing by calling
967 * <code>#glk_window_set_echo_stream(@win, %NULL)</code>.
969 * It is illegal to set a window's echo stream to be its
970 * <emphasis>own</emphasis> window stream. That would create an infinite loop,
971 * and is nearly certain to crash the Glk library. It is similarly illegal to
972 * create a longer loop (two or more windows echoing to each other.)
975 glk_window_set_echo_stream(winid_t win, strid_t str)
977 VALID_WINDOW(win, return);
978 VALID_STREAM_OR_NULL(str, return);
980 /* Test for an infinite loop */
982 for(; next && next->type == STREAM_TYPE_WINDOW; next = next->window->echo_stream)
984 if(next == win->window_stream)
986 ILLEGAL("Infinite loop detected");
987 win->echo_stream = NULL;
992 win->echo_stream = str;
996 * glk_window_get_echo_stream:
999 * Returns the echo stream of window @win. Initially, a window has no echo
1000 * stream, so <code>#glk_window_get_echo_stream(@win)</code> will return %NULL.
1002 * Returns: A stream, or %NULL.
1005 glk_window_get_echo_stream(winid_t win)
1007 VALID_WINDOW(win, return NULL);
1008 return win->echo_stream;
1012 * glk_window_get_size:
1014 * @widthptr: Pointer to a location to store the window's width, or %NULL.
1015 * @heightptr: Pointer to a location to store the window's height, or %NULL.
1017 * Simply returns the actual size of the window, in its measurement system.
1018 * As described in <link linkend="chimara-Other-API-Conventions">Other API
1019 * Conventions</link>, either @widthptr or @heightptr can be %NULL, if you
1020 * only want one measurement.
1022 * <note><para>Or, in fact, both, if you want to waste time.</para></note>
1025 glk_window_get_size(winid_t win, glui32 *widthptr, glui32 *heightptr)
1027 VALID_WINDOW(win, return);
1029 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
1035 if(widthptr != NULL)
1037 if(heightptr != NULL)
1041 case wintype_TextGrid:
1042 /* Wait until the window's size is current */
1043 g_mutex_lock(glk_data->arrange_lock);
1044 if(glk_data->needs_rearrange)
1045 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
1046 g_mutex_unlock(glk_data->arrange_lock);
1048 gdk_threads_enter();
1049 /* Cache the width and height */
1050 win->width = (glui32)(win->widget->allocation.width / win->unit_width);
1051 win->height = (glui32)(win->widget->allocation.height / win->unit_height);
1052 gdk_threads_leave();
1054 if(widthptr != NULL)
1055 *widthptr = win->width;
1056 if(heightptr != NULL)
1057 *heightptr = win->height;
1060 case wintype_TextBuffer:
1061 /* Wait until the window's size is current */
1062 g_mutex_lock(glk_data->arrange_lock);
1063 if(glk_data->needs_rearrange)
1064 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
1065 g_mutex_unlock(glk_data->arrange_lock);
1067 gdk_threads_enter();
1068 if(widthptr != NULL)
1069 *widthptr = (glui32)(win->widget->allocation.width / win->unit_width);
1070 if(heightptr != NULL)
1071 *heightptr = (glui32)(win->widget->allocation.height / win->unit_height);
1072 gdk_threads_leave();
1077 ILLEGAL_PARAM("Unknown window type: %u", win->type);
1082 * glk_window_set_arrangement:
1083 * @win: a pair window to rearrange.
1084 * @method: new method of size computation. One of %winmethod_Above,
1085 * %winmethod_Below, %winmethod_Left, or %winmethod_Right OR'ed with
1086 * %winmethod_Fixed or %winmethod_Proportional.
1087 * @size: new size constraint, in percentage points if @method is
1088 * %winmethod_Proportional, otherwise in characters if @win's type is
1089 * %wintype_TextBuffer or %wintype_TextGrid, or pixels if @win's type is
1090 * %wintype_Graphics.
1091 * @keywin: new key window, or %NULL to leave the key window unchanged.
1093 * Changes the size of an existing split — that is, it changes the
1094 * constraint of a given pair window.
1096 * Consider the example above, where D has collapsed to zero height. Say D was a
1097 * text buffer window. You could make a more useful layout by doing
1100 * o2 = #glk_window_get_parent(d);
1101 * glk_window_set_arrangement(o2, #winmethod_Above | #winmethod_Fixed, 3, d);
1103 * That would set D (the upper child of O2) to be O2's key window, and give it a
1104 * fixed size of 3 rows.
1106 * If you later wanted to expand D, you could do
1107 * |[ glk_window_set_arrangement(o2, #winmethod_Above | #winmethod_Fixed, 5, NULL); ]|
1108 * That expands D to five rows. Note that, since O2's key window is already set
1109 * to D, it is not necessary to provide the @keywin argument; you can pass %NULL
1110 * to mean <quote>leave the key window unchanged.</quote>
1112 * If you do change the key window of a pair window, the new key window
1113 * <emphasis>must</emphasis> be a descendant of that pair window. In the current
1114 * example, you could change O2's key window to be A, but not B. The key window
1115 * also cannot be a pair window itself.
1117 * |[ glk_window_set_arrangement(o2, #winmethod_Below | #winmethod_Fixed, 3, NULL); ]|
1118 * This changes the constraint to be on the <emphasis>lower</emphasis> child of
1119 * O2, which is A. The key window is still D; so A would then be three rows high
1120 * as measured in D's font, and D would get the rest of O2's space. That may not
1121 * be what you want. To set A to be three rows high as measured in A's font, you
1123 * |[ glk_window_set_arrangement(o2, #winmethod_Below | #winmethod_Fixed, 3, a); ]|
1125 * Or you could change O2 to a proportional split:
1126 * |[ glk_window_set_arrangement(o2, #winmethod_Below | #winmethod_Proportional, 30, NULL); ]|
1128 * |[ glk_window_set_arrangement(o2, #winmethod_Above | #winmethod_Proportional, 70, NULL); ]|
1129 * These do exactly the same thing, since 30% above is the same as
1130 * 70% below. You don't need to specify a key window with a proportional
1131 * split, so the @keywin argument is %NULL. (You could actually specify either A
1132 * or D as the key window, but it wouldn't affect the result.)
1134 * Whatever constraint you set, glk_window_get_size() will tell you the actual
1135 * window size you got.
1137 * Note that you can resize windows, but you can't flip or rotate them. You
1138 * can't move A above D, or change O2 to a vertical split where A is left or
1141 * To get this effect you could close one of the windows, and re-split the
1142 * other one with glk_window_open().
1146 glk_window_set_arrangement(winid_t win, glui32 method, glui32 size, winid_t keywin)
1148 VALID_WINDOW(win, return);
1149 VALID_WINDOW_OR_NULL(keywin, return);
1150 g_return_if_fail(win->type == wintype_Pair);
1153 g_return_if_fail(keywin->type != wintype_Pair);
1154 g_return_if_fail(g_node_is_ancestor(win->window_node, keywin->window_node));
1156 g_return_if_fail(method == (method & (winmethod_DirMask | winmethod_DivisionMask)));
1157 g_return_if_fail(!(((method & winmethod_DivisionMask) == winmethod_Proportional) && size > 100));
1159 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
1161 win->split_method = method;
1162 win->constraint_size = size;
1164 win->key_window = keywin;
1166 /* Tell GTK to rearrange the windows */
1167 gdk_threads_enter();
1168 g_mutex_lock(glk_data->arrange_lock);
1169 glk_data->needs_rearrange = TRUE;
1170 glk_data->ignore_next_arrange_event = TRUE;
1171 g_mutex_unlock(glk_data->arrange_lock);
1172 gtk_widget_queue_resize(GTK_WIDGET(glk_data->self));
1173 gdk_threads_leave();
1177 * glk_window_get_arrangement:
1178 * @win: a pair window.
1179 * @methodptr: return location for the constraint flags of @win, or %NULL.
1180 * @sizeptr: return location for the constraint size of @win, or %NULL.
1181 * @keywinptr: return location for the key window of @win, or %NULL.
1183 * Queries the constraint of a given pair window.
1186 glk_window_get_arrangement(winid_t win, glui32 *methodptr, glui32 *sizeptr, winid_t *keywinptr)
1188 VALID_WINDOW(win, return);
1189 g_return_if_fail(win->type == wintype_Pair);
1192 *methodptr = win->split_method;
1194 *sizeptr = win->constraint_size;
1196 *keywinptr = win->key_window;
1200 * glk_window_move_cursor:
1201 * @win: A text grid window.
1202 * @xpos: Horizontal cursor position.
1203 * @ypos: Vertical cursor position.
1205 * Sets the cursor position. If you move the cursor right past the end of a
1206 * line, it wraps; the next character which is printed will appear at the
1207 * beginning of the next line.
1209 * If you move the cursor below the last line, or when the cursor reaches the
1210 * end of the last line, it goes <quote>off the screen</quote> and further
1211 * output has no effect. You must call glk_window_move_cursor() or
1212 * glk_window_clear() to move the cursor back into the visible region.
1215 * Note that the arguments of glk_window_move_cursor() are <type>unsigned
1216 * int</type>s. This is okay, since there are no negative positions. If you try
1217 * to pass a negative value, Glk will interpret it as a huge positive value,
1218 * and it will wrap or go off the last line.
1222 * Also note that the output cursor is not necessarily visible. In particular,
1223 * when you are requesting line or character input in a grid window, you cannot
1224 * rely on the cursor position to prompt the player where input is indicated.
1225 * You should print some character prompt at that spot — a
1226 * <quote>></quote> character, for example.
1230 glk_window_move_cursor(winid_t win, glui32 xpos, glui32 ypos)
1232 VALID_WINDOW(win, return);
1233 g_return_if_fail(win->type == wintype_TextGrid);
1235 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
1237 /* Wait until the window's size is current */
1238 g_mutex_lock(glk_data->arrange_lock);
1239 if(glk_data->needs_rearrange)
1240 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
1241 g_mutex_unlock(glk_data->arrange_lock);
1243 /* Don't do anything if the window is shrunk down to nothing */
1244 if(win->width == 0 || win->height == 0)
1247 /* Calculate actual position if cursor is moved past the right edge */
1248 if(xpos >= win->width)
1250 ypos += xpos / win->width;
1253 /* Go to the end if the cursor is moved off the bottom edge */
1254 if(ypos >= win->height)
1256 xpos = win->width - 1;
1257 ypos = win->height - 1;
1260 gdk_threads_enter();
1262 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
1264 /* There must actually be a character at xpos, or the following function will choke */
1265 gtk_text_buffer_get_iter_at_line_offset(buffer, &newpos, ypos, xpos);
1266 gtk_text_buffer_move_mark_by_name(buffer, "cursor_position", &newpos);
1268 gdk_threads_leave();