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);
562 case wintype_Graphics:
564 GtkWidget *image = gtk_image_new_from_pixmap(NULL, NULL);
565 gtk_widget_show(image);
568 win->unit_height = 1;
571 win->background_color = 0x00FFFFFF;
573 /* Connect signal handlers */
574 win->button_press_event_handler = g_signal_connect(image, "button-press-event", G_CALLBACK(on_window_button_press), win);
575 g_signal_handler_block(image, win->button_press_event_handler);
576 win->shutdown_keypress_handler = g_signal_connect(image, "key-press-event", G_CALLBACK(on_shutdown_key_press_event), win);
577 g_signal_handler_block(image, win->shutdown_keypress_handler);
578 win->size_allocate_handler = g_signal_connect(image, "size-allocate", G_CALLBACK(on_graphics_size_allocate), win);
584 ILLEGAL_PARAM("Unknown window type: %u", wintype);
586 g_node_destroy(glk_data->root_window);
587 glk_data->root_window = NULL;
591 /* Set the minimum size to "as small as possible" so it doesn't depend on
592 the size of the window contents */
593 gtk_widget_set_size_request(win->widget, 0, 0);
594 gtk_widget_set_size_request(win->frame, 0, 0);
598 /* When splitting, construct a new parent window
599 * copying most characteristics from the window that is being split */
600 winid_t pair = window_new_common(0);
601 pair->type = wintype_Pair;
603 /* The pair window must know about its children's split method */
604 pair->key_window = win;
605 pair->split_method = method;
606 pair->constraint_size = size;
608 /* Insert the new window into the window tree */
609 if(split->window_node->parent == NULL)
610 glk_data->root_window = pair->window_node;
613 if( split->window_node == g_node_first_sibling(split->window_node) )
614 g_node_prepend(split->window_node->parent, pair->window_node);
616 g_node_append(split->window_node->parent, pair->window_node);
617 g_node_unlink(split->window_node);
619 /* Place the windows in the correct order */
620 switch(method & winmethod_DirMask)
623 case winmethod_Above:
624 g_node_append(pair->window_node, win->window_node);
625 g_node_append(pair->window_node, split->window_node);
627 case winmethod_Right:
628 case winmethod_Below:
629 g_node_append(pair->window_node, split->window_node);
630 g_node_append(pair->window_node, win->window_node);
635 /* Set the window as root window */
636 glk_data->root_window = win->window_node;
639 /* Set the window as a child of the Glk widget, don't trigger an arrange event */
640 g_mutex_lock(glk_data->arrange_lock);
641 glk_data->needs_rearrange = TRUE;
642 glk_data->ignore_next_arrange_event = TRUE;
643 g_mutex_unlock(glk_data->arrange_lock);
644 gtk_widget_set_parent(win->frame, GTK_WIDGET(glk_data->self));
645 gtk_widget_queue_resize(GTK_WIDGET(glk_data->self));
647 /* For text grid windows, fill the buffer with blanks. */
648 if(wintype == wintype_TextGrid)
650 /* Create the cursor position mark */
652 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
653 gtk_text_buffer_get_start_iter(buffer, &begin);
654 gtk_text_buffer_create_mark(buffer, "cursor_position", &begin, TRUE);
658 glk_window_clear(win);
662 /* Internal function: if node's key window is closing_win or one of its
663 children, set node's key window to NULL. */
665 remove_key_windows(GNode *node, winid_t closing_win)
667 winid_t win = (winid_t)node->data;
668 if(win->key_window && (win->key_window == closing_win || g_node_is_ancestor(closing_win->window_node, win->key_window->window_node)))
669 win->key_window = NULL;
670 return FALSE; /* Don't stop the traversal */
673 /* Internal function: destroy this window's GTK widgets, window streams,
674 and those of all its children. GDK threads must be locked. */
676 destroy_windows_below(winid_t win, stream_result_t *result)
681 case wintype_TextGrid:
682 case wintype_TextBuffer:
683 case wintype_Graphics:
684 gtk_widget_unparent(win->frame);
688 destroy_windows_below(win->window_node->children->data, NULL);
689 destroy_windows_below(win->window_node->children->next->data, NULL);
693 ILLEGAL_PARAM("Unknown window type: %u", win->type);
696 stream_close_common(win->window_stream, result);
699 /* Internal function: free the winid_t structure of this window and those of all its children */
701 free_winids_below(winid_t win)
703 if(win->type == wintype_Pair) {
704 free_winids_below(win->window_node->children->data);
705 free_winids_below(win->window_node->children->next->data);
707 window_close_common(win, FALSE);
712 * @win: Window to close.
713 * @result: Pointer to a #stream_result_t in which to store the write count.
715 * Closes @win, which is pretty much exactly the opposite of opening a window.
716 * It is legal to close all your windows, or to close the root window (which is
719 * The @result argument is filled with the output character count of the window
720 * stream. See <link linkend="chimara-Streams">Streams</link> and <link
721 * linkend="chimara-Closing-Streams">Closing Streams</link>.
723 * When you close a window (and it is not the root window), the other window
724 * in its pair takes over all the freed-up area. Let's close D, in the current
726 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
727 * <entry><mediaobject><imageobject><imagedata fileref="fig10.png"/>
728 * </imageobject></mediaobject></entry>
729 * <entry><mediaobject><textobject><literallayout class="monospaced">
735 * </literallayout></textobject></mediaobject></entry>
736 * </row></tbody></tgroup></informaltable>
738 * Notice what has happened. D is gone. O3 is gone, and its 50-50 left-right
739 * split has gone with it. The other size constraints are unchanged; O2 is
740 * still committed to giving its upper child two rows, as measured in the font
741 * of O2's key window, which is C. Conveniently, O2's upper child is C, just as
742 * it was before we created D. In fact, now that D is gone, everything is back
743 * to the way it was before we created D.
745 * But what if we had closed C instead of D? We would have gotten this:
746 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
747 * <entry><mediaobject><imageobject><imagedata fileref="fig11.png"/>
748 * </imageobject></mediaobject></entry>
749 * <entry><mediaobject><textobject><literallayout class="monospaced">
755 * </literallayout></textobject></mediaobject></entry>
756 * </row></tbody></tgroup></informaltable>
758 * Again, O3 is gone. But D has collapsed to zero height. This is because its
759 * height is controlled by O2, and O2's key window was C, and C is now gone. O2
760 * no longer has a key window at all, so it cannot compute a height for its
761 * upper child, so it defaults to zero.
764 * This may seem to be an inconvenient choice. That is deliberate. You should
765 * not leave a pair window with no key, and the zero-height default reminds
766 * you not to. You can use glk_window_set_arrangement() to set a new split
767 * measurement and key window. See <link
768 * linkend="chimara-Changing-Window-Constraints">Changing Window
769 * Constraints</link>.
773 glk_window_close(winid_t win, stream_result_t *result)
775 VALID_WINDOW(win, return);
777 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
779 gdk_threads_enter(); /* Prevent redraw while we're trashing the window */
781 /* If any pair windows have this window or its children as a key window,
782 set their key window to NULL */
783 g_node_traverse(glk_data->root_window, G_IN_ORDER, G_TRAVERSE_NON_LEAVES, -1, (GNodeTraverseFunc)remove_key_windows, win);
785 /* Close all the window streams and destroy the widgets of this window
786 and below, before trashing the window tree */
787 destroy_windows_below(win, result);
789 /* Then free the winid_t structures below this node, but not this one itself */
790 if(win->type == wintype_Pair) {
791 free_winids_below(win->window_node->children->data);
792 free_winids_below(win->window_node->children->next->data);
794 /* So now we should be left with a skeleton tree hanging off this node */
796 /* Parent window changes from a split window into the sibling window */
797 /* The parent of any window is either a pair window or NULL */
798 GNode *pair_node = win->window_node->parent;
799 /* If win was not the root window: */
800 if(pair_node != NULL)
802 gboolean new_child_on_left = ( pair_node == g_node_first_sibling(pair_node) );
803 GNode *sibling_node = pair_node->children; /* only one child left */
804 GNode *new_parent_node = pair_node->parent;
805 g_node_unlink(pair_node);
806 g_node_unlink(sibling_node);
807 /* pair_node and sibling_node should now be totally unconnected to the tree */
809 if(new_parent_node == NULL)
811 glk_data->root_window = sibling_node;
815 if(new_child_on_left)
816 g_node_prepend(new_parent_node, sibling_node);
818 g_node_append(new_parent_node, sibling_node);
821 window_close_common( (winid_t) pair_node->data, TRUE);
823 else /* it was the root window */
825 glk_data->root_window = NULL;
828 window_close_common(win, FALSE);
830 /* Schedule a redraw */
831 g_mutex_lock(glk_data->arrange_lock);
832 glk_data->needs_rearrange = TRUE;
833 glk_data->ignore_next_arrange_event = TRUE;
834 g_mutex_unlock(glk_data->arrange_lock);
835 gtk_widget_queue_resize( GTK_WIDGET(glk_data->self) );
843 * Erases @win. The meaning of this depends on the window type.
846 * <term>Text buffer</term>
848 * This may do any number of things, such as delete all text in the window, or
849 * print enough blank lines to scroll all text beyond visibility, or insert a
850 * page-break marker which is treated specially by the display part of the
855 * <term>Text grid</term>
857 * This will clear the window, filling all positions with blanks. The window
858 * cursor is moved to the top left corner (position 0,0).
862 * <term>Graphics</term>
864 * Clears the entire window to its current background color. See <link
865 * linkend="chimara-Graphics-Windows">Graphics Windows</link>.
869 * <term>Other window types</term>
870 * <listitem><para>No effect.</para></listitem>
874 * It is illegal to erase a window which has line input pending.
877 glk_window_clear(winid_t win)
879 VALID_WINDOW(win, return);
880 g_return_if_fail(win->input_request_type != INPUT_REQUEST_LINE && win->input_request_type != INPUT_REQUEST_LINE_UNICODE);
882 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
891 case wintype_TextGrid:
892 /* fill the buffer with blanks */
894 /* Wait for the window's size to be updated */
895 g_mutex_lock(glk_data->arrange_lock);
896 if(glk_data->needs_rearrange)
897 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
898 g_mutex_unlock(glk_data->arrange_lock);
902 /* Manually put newlines at the end of each row of characters in the buffer; manual newlines make resizing the window's grid easier. */
903 gchar *blanks = g_strnfill(win->width, ' ');
904 gchar **blanklines = g_new0(gchar *, win->height + 1);
906 for(count = 0; count < win->height; count++)
907 blanklines[count] = blanks;
908 blanklines[win->height] = NULL;
909 gchar *text = g_strjoinv("\n", blanklines);
910 g_free(blanklines); /* not g_strfreev() */
913 GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
914 gtk_text_buffer_set_text(textbuffer, text, -1);
918 gtk_text_buffer_get_start_iter(textbuffer, &begin);
919 gtk_text_buffer_move_mark_by_name(textbuffer, "cursor_position", &begin);
925 case wintype_TextBuffer:
926 /* delete all text in the window */
930 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
931 GtkTextIter start, end;
932 gtk_text_buffer_get_bounds(buffer, &start, &end);
933 gtk_text_buffer_delete(buffer, &start, &end);
939 case wintype_Graphics:
941 /* Wait for the window's size to be updated */
942 g_mutex_lock(glk_data->arrange_lock);
943 if(glk_data->needs_rearrange)
944 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
945 g_mutex_unlock(glk_data->arrange_lock);
947 glk_window_erase_rect(win, 0, 0, win->widget->allocation.width, win->widget->allocation.height);
952 ILLEGAL_PARAM("Unknown window type: %d", win->type);
958 * @win: A window, or %NULL.
960 * Sets the current stream to @win's window stream. It is exactly equivalent to
961 * |[ #glk_stream_set_current(#glk_window_get_stream(@win)) ]|
962 * See <link linkend="chimara-Streams">Streams</link>.
964 * <note><title>Chimara</title>
966 * Although this is not mentioned in the specification, @win may also be
967 * %NULL, in which case the current stream is also set to %NULL.
971 glk_set_window(winid_t win)
973 VALID_WINDOW_OR_NULL(win, return);
975 glk_stream_set_current( glk_window_get_stream(win) );
977 glk_stream_set_current(NULL);
981 * glk_window_get_stream:
984 * Returns the stream which is associated with @win. (See <link
985 * linkend="chimara-Window-Streams">Window Streams</link>.) Every window has a
986 * stream which can be printed to, but this may not be useful, depending on the
990 * For example, printing to a blank window's stream has no effect.
993 * Returns: A window stream.
995 strid_t glk_window_get_stream(winid_t win)
997 VALID_WINDOW(win, return NULL);
998 return win->window_stream;
1002 * glk_window_set_echo_stream:
1004 * @str: A stream to attach to the window, or %NULL.
1006 * Sets @win's echo stream to @str, which can be any valid output stream. You
1007 * can reset a window to stop echoing by calling
1008 * <code>#glk_window_set_echo_stream(@win, %NULL)</code>.
1010 * It is illegal to set a window's echo stream to be its
1011 * <emphasis>own</emphasis> window stream. That would create an infinite loop,
1012 * and is nearly certain to crash the Glk library. It is similarly illegal to
1013 * create a longer loop (two or more windows echoing to each other.)
1016 glk_window_set_echo_stream(winid_t win, strid_t str)
1018 VALID_WINDOW(win, return);
1019 VALID_STREAM_OR_NULL(str, return);
1021 /* Test for an infinite loop */
1023 for(; next && next->type == STREAM_TYPE_WINDOW; next = next->window->echo_stream)
1025 if(next == win->window_stream)
1027 ILLEGAL("Infinite loop detected");
1028 win->echo_stream = NULL;
1033 win->echo_stream = str;
1037 * glk_window_get_echo_stream:
1040 * Returns the echo stream of window @win. Initially, a window has no echo
1041 * stream, so <code>#glk_window_get_echo_stream(@win)</code> will return %NULL.
1043 * Returns: A stream, or %NULL.
1046 glk_window_get_echo_stream(winid_t win)
1048 VALID_WINDOW(win, return NULL);
1049 return win->echo_stream;
1053 * glk_window_get_size:
1055 * @widthptr: Pointer to a location to store the window's width, or %NULL.
1056 * @heightptr: Pointer to a location to store the window's height, or %NULL.
1058 * Simply returns the actual size of the window, in its measurement system.
1059 * As described in <link linkend="chimara-Other-API-Conventions">Other API
1060 * Conventions</link>, either @widthptr or @heightptr can be %NULL, if you
1061 * only want one measurement.
1063 * <note><para>Or, in fact, both, if you want to waste time.</para></note>
1066 glk_window_get_size(winid_t win, glui32 *widthptr, glui32 *heightptr)
1068 VALID_WINDOW(win, return);
1070 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
1076 if(widthptr != NULL)
1078 if(heightptr != NULL)
1082 case wintype_TextGrid:
1083 /* Wait until the window's size is current */
1084 g_mutex_lock(glk_data->arrange_lock);
1085 if(glk_data->needs_rearrange)
1086 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
1087 g_mutex_unlock(glk_data->arrange_lock);
1089 gdk_threads_enter();
1090 /* Cache the width and height */
1091 win->width = (glui32)(win->widget->allocation.width / win->unit_width);
1092 win->height = (glui32)(win->widget->allocation.height / win->unit_height);
1093 gdk_threads_leave();
1095 if(widthptr != NULL)
1096 *widthptr = win->width;
1097 if(heightptr != NULL)
1098 *heightptr = win->height;
1101 case wintype_TextBuffer:
1102 /* Wait until the window's size is current */
1103 g_mutex_lock(glk_data->arrange_lock);
1104 if(glk_data->needs_rearrange)
1105 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
1106 g_mutex_unlock(glk_data->arrange_lock);
1108 gdk_threads_enter();
1109 if(widthptr != NULL)
1110 *widthptr = (glui32)(win->widget->allocation.width / win->unit_width);
1111 if(heightptr != NULL)
1112 *heightptr = (glui32)(win->widget->allocation.height / win->unit_height);
1113 gdk_threads_leave();
1117 case wintype_Graphics:
1118 g_mutex_lock(glk_data->arrange_lock);
1119 if(glk_data->needs_rearrange)
1120 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
1121 g_mutex_unlock(glk_data->arrange_lock);
1123 gdk_threads_enter();
1124 if(widthptr != NULL)
1125 *widthptr = (glui32)(win->widget->allocation.width);
1126 if(heightptr != NULL)
1127 *heightptr = (glui32)(win->widget->allocation.height);
1128 gdk_threads_leave();
1133 ILLEGAL_PARAM("Unknown window type: %u", win->type);
1138 * glk_window_set_arrangement:
1139 * @win: a pair window to rearrange.
1140 * @method: new method of size computation. One of %winmethod_Above,
1141 * %winmethod_Below, %winmethod_Left, or %winmethod_Right OR'ed with
1142 * %winmethod_Fixed or %winmethod_Proportional.
1143 * @size: new size constraint, in percentage points if @method is
1144 * %winmethod_Proportional, otherwise in characters if @win's type is
1145 * %wintype_TextBuffer or %wintype_TextGrid, or pixels if @win's type is
1146 * %wintype_Graphics.
1147 * @keywin: new key window, or %NULL to leave the key window unchanged.
1149 * Changes the size of an existing split — that is, it changes the
1150 * constraint of a given pair window.
1152 * Consider the example above, where D has collapsed to zero height. Say D was a
1153 * text buffer window. You could make a more useful layout by doing
1156 * o2 = #glk_window_get_parent(d);
1157 * glk_window_set_arrangement(o2, #winmethod_Above | #winmethod_Fixed, 3, d);
1159 * That would set D (the upper child of O2) to be O2's key window, and give it a
1160 * fixed size of 3 rows.
1162 * If you later wanted to expand D, you could do
1163 * |[ glk_window_set_arrangement(o2, #winmethod_Above | #winmethod_Fixed, 5, NULL); ]|
1164 * That expands D to five rows. Note that, since O2's key window is already set
1165 * to D, it is not necessary to provide the @keywin argument; you can pass %NULL
1166 * to mean <quote>leave the key window unchanged.</quote>
1168 * If you do change the key window of a pair window, the new key window
1169 * <emphasis>must</emphasis> be a descendant of that pair window. In the current
1170 * example, you could change O2's key window to be A, but not B. The key window
1171 * also cannot be a pair window itself.
1173 * |[ glk_window_set_arrangement(o2, #winmethod_Below | #winmethod_Fixed, 3, NULL); ]|
1174 * This changes the constraint to be on the <emphasis>lower</emphasis> child of
1175 * O2, which is A. The key window is still D; so A would then be three rows high
1176 * as measured in D's font, and D would get the rest of O2's space. That may not
1177 * be what you want. To set A to be three rows high as measured in A's font, you
1179 * |[ glk_window_set_arrangement(o2, #winmethod_Below | #winmethod_Fixed, 3, a); ]|
1181 * Or you could change O2 to a proportional split:
1182 * |[ glk_window_set_arrangement(o2, #winmethod_Below | #winmethod_Proportional, 30, NULL); ]|
1184 * |[ glk_window_set_arrangement(o2, #winmethod_Above | #winmethod_Proportional, 70, NULL); ]|
1185 * These do exactly the same thing, since 30% above is the same as
1186 * 70% below. You don't need to specify a key window with a proportional
1187 * split, so the @keywin argument is %NULL. (You could actually specify either A
1188 * or D as the key window, but it wouldn't affect the result.)
1190 * Whatever constraint you set, glk_window_get_size() will tell you the actual
1191 * window size you got.
1193 * Note that you can resize windows, but you can't flip or rotate them. You
1194 * can't move A above D, or change O2 to a vertical split where A is left or
1197 * To get this effect you could close one of the windows, and re-split the
1198 * other one with glk_window_open().
1202 glk_window_set_arrangement(winid_t win, glui32 method, glui32 size, winid_t keywin)
1204 VALID_WINDOW(win, return);
1205 VALID_WINDOW_OR_NULL(keywin, return);
1206 g_return_if_fail(win->type == wintype_Pair);
1209 g_return_if_fail(keywin->type != wintype_Pair);
1210 g_return_if_fail(g_node_is_ancestor(win->window_node, keywin->window_node));
1212 g_return_if_fail(method == (method & (winmethod_DirMask | winmethod_DivisionMask)));
1213 g_return_if_fail(!(((method & winmethod_DivisionMask) == winmethod_Proportional) && size > 100));
1215 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
1217 win->split_method = method;
1218 win->constraint_size = size;
1220 win->key_window = keywin;
1222 /* Tell GTK to rearrange the windows */
1223 gdk_threads_enter();
1224 g_mutex_lock(glk_data->arrange_lock);
1225 glk_data->needs_rearrange = TRUE;
1226 glk_data->ignore_next_arrange_event = TRUE;
1227 g_mutex_unlock(glk_data->arrange_lock);
1228 gtk_widget_queue_resize(GTK_WIDGET(glk_data->self));
1229 gdk_threads_leave();
1233 * glk_window_get_arrangement:
1234 * @win: a pair window.
1235 * @methodptr: return location for the constraint flags of @win, or %NULL.
1236 * @sizeptr: return location for the constraint size of @win, or %NULL.
1237 * @keywinptr: return location for the key window of @win, or %NULL.
1239 * Queries the constraint of a given pair window.
1242 glk_window_get_arrangement(winid_t win, glui32 *methodptr, glui32 *sizeptr, winid_t *keywinptr)
1244 VALID_WINDOW(win, return);
1245 g_return_if_fail(win->type == wintype_Pair);
1248 *methodptr = win->split_method;
1250 *sizeptr = win->constraint_size;
1252 *keywinptr = win->key_window;
1256 * glk_window_move_cursor:
1257 * @win: A text grid window.
1258 * @xpos: Horizontal cursor position.
1259 * @ypos: Vertical cursor position.
1261 * Sets the cursor position. If you move the cursor right past the end of a
1262 * line, it wraps; the next character which is printed will appear at the
1263 * beginning of the next line.
1265 * If you move the cursor below the last line, or when the cursor reaches the
1266 * end of the last line, it goes <quote>off the screen</quote> and further
1267 * output has no effect. You must call glk_window_move_cursor() or
1268 * glk_window_clear() to move the cursor back into the visible region.
1271 * Note that the arguments of glk_window_move_cursor() are <type>unsigned
1272 * int</type>s. This is okay, since there are no negative positions. If you try
1273 * to pass a negative value, Glk will interpret it as a huge positive value,
1274 * and it will wrap or go off the last line.
1278 * Also note that the output cursor is not necessarily visible. In particular,
1279 * when you are requesting line or character input in a grid window, you cannot
1280 * rely on the cursor position to prompt the player where input is indicated.
1281 * You should print some character prompt at that spot — a
1282 * <quote>></quote> character, for example.
1286 glk_window_move_cursor(winid_t win, glui32 xpos, glui32 ypos)
1288 VALID_WINDOW(win, return);
1289 g_return_if_fail(win->type == wintype_TextGrid);
1291 flush_window_buffer(win);
1293 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
1295 /* Wait until the window's size is current */
1296 g_mutex_lock(glk_data->arrange_lock);
1297 if(glk_data->needs_rearrange)
1298 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
1299 g_mutex_unlock(glk_data->arrange_lock);
1301 /* Don't do anything if the window is shrunk down to nothing */
1302 if(win->width == 0 || win->height == 0)
1305 /* Calculate actual position if cursor is moved past the right edge */
1306 if(xpos >= win->width)
1308 ypos += xpos / win->width;
1312 /* Go to the end if the cursor is moved off the bottom edge */
1313 if(ypos >= win->height)
1315 xpos = win->width - 1;
1316 ypos = win->height - 1;
1319 gdk_threads_enter();
1321 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
1323 /* There must actually be a character at xpos, or the following function will choke */
1324 gtk_text_buffer_get_iter_at_line_offset(buffer, &newpos, ypos, xpos);
1325 gtk_text_buffer_move_mark_by_name(buffer, "cursor_position", &newpos);
1327 gdk_threads_leave();