4 #include "chimara-glk-private.h"
8 extern GPrivate *glk_data_key;
11 window_new_common(glui32 rock)
13 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
14 winid_t win = g_new0(struct glk_window_struct, 1);
16 win->magic = MAGIC_WINDOW;
18 if(glk_data->register_obj)
19 win->disprock = (*glk_data->register_obj)(win, gidisp_Class_Window);
21 win->window_node = g_node_new(win);
23 /* Every window has a window stream, but printing to it might have no effect */
24 win->window_stream = stream_new_common(0);
25 win->window_stream->file_mode = filemode_Write;
26 win->window_stream->type = STREAM_TYPE_WINDOW;
27 win->window_stream->window = win;
28 win->window_stream->style = "normal";
29 win->window_stream->glk_style = "normal";
31 win->echo_stream = NULL;
32 win->input_request_type = INPUT_REQUEST_NONE;
33 win->line_input_buffer = NULL;
34 win->line_input_buffer_unicode = NULL;
37 /* Initialise the buffer */
38 win->buffer = g_string_sized_new(1024);
40 /* Initialise hyperlink table */
41 win->hyperlinks = g_hash_table_new_full(g_int_hash, g_int_equal, g_free, g_free);
46 /* Internal function: do all the stuff necessary to close a window. Call only
49 window_close_common(winid_t win, gboolean destroy_node)
51 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
53 if(glk_data->unregister_obj)
55 (*glk_data->unregister_obj)(win, gidisp_Class_Window, win->disprock);
56 win->disprock.ptr = NULL;
60 g_node_destroy(win->window_node);
62 win->magic = MAGIC_FREE;
64 g_list_foreach(win->history, (GFunc)g_free, NULL);
65 g_list_free(win->history);
67 g_string_free(win->buffer, TRUE);
68 g_hash_table_destroy(win->hyperlinks);
69 g_free(win->current_hyperlink);
72 g_object_unref(win->pager_layout);
79 * @win: A window, or %NULL.
80 * @rockptr: Return location for the next window's rock, or %NULL.
82 * This function can be used to iterate through the list of all open windows
83 * (including pair windows.) See <link
84 * linkend="chimara-Iterating-Through-Opaque-Objects">Iterating Through Opaque
87 * As that section describes, the order in which windows are returned is
88 * arbitrary. The root window is not necessarily first, nor is it necessarily
91 * Returns: the next window, or %NULL if there are no more.
94 glk_window_iterate(winid_t win, glui32 *rockptr)
96 VALID_WINDOW_OR_NULL(win, return NULL);
98 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
102 retnode = glk_data->root_window;
105 GNode *node = win->window_node;
106 if( G_NODE_IS_LEAF(node) )
108 while(node && node->next == NULL)
111 retnode = node->next;
116 retnode = g_node_first_child(node);
118 winid_t retval = retnode? (winid_t)retnode->data : NULL;
120 /* Store the window's rock in rockptr */
121 if(retval && rockptr)
122 *rockptr = glk_window_get_rock(retval);
128 * glk_window_get_rock:
131 * Returns @win's rock value. Pair windows always have rock 0; all other windows
132 * return whatever rock value you created them with.
134 * Returns: A rock value.
137 glk_window_get_rock(winid_t win)
139 VALID_WINDOW(win, return 0);
144 * glk_window_get_type:
147 * Returns @win's type, one of %wintype_Blank, %wintype_Pair,
148 * %wintype_TextBuffer, %wintype_TextGrid, or %wintype_Graphics.
150 * Returns: The window's type.
153 glk_window_get_type(winid_t win)
155 VALID_WINDOW(win, return 0);
160 * glk_window_get_parent:
163 * Returns the window which is the parent of @win. If @win is the root window,
164 * this returns %NULL, since the root window has no parent. Remember that the
165 * parent of every window is a pair window; other window types are always
168 * Returns: A window, or %NULL.
171 glk_window_get_parent(winid_t win)
173 VALID_WINDOW(win, return NULL);
175 /* Value will also be NULL if win is the root window */
176 if(win->window_node->parent == NULL)
179 return (winid_t)win->window_node->parent->data;
183 * glk_window_get_sibling:
186 * Returns the other child of @win's parent. If @win is the root window, this
189 * Returns: A window, or %NULL.
192 glk_window_get_sibling(winid_t win)
194 VALID_WINDOW(win, return NULL);
196 if(G_NODE_IS_ROOT(win->window_node))
198 if(win->window_node->next)
199 return (winid_t)win->window_node->next;
200 return (winid_t)win->window_node->prev;
204 * glk_window_get_root:
206 * Returns the root window. If there are no windows, this returns %NULL.
208 * Returns: A window, or %NULL.
211 glk_window_get_root()
213 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
214 if(glk_data->root_window == NULL)
216 return (winid_t)glk_data->root_window->data;
221 * @split: The window to split to create the new window. Must be 0 if there
222 * are no windows yet.
223 * @method: Position of the new window and method of size computation. One of
224 * %winmethod_Above, %winmethod_Below, %winmethod_Left, or %winmethod_Right
225 * OR'ed with %winmethod_Fixed or %winmethod_Proportional. If @wintype is
226 * %wintype_Blank, then %winmethod_Fixed is not allowed.
227 * @size: Size of the new window, in percentage points if @method is
228 * %winmethod_Proportional, otherwise in characters if @wintype is
229 * %wintype_TextBuffer or %wintype_TextGrid, or pixels if @wintype is
231 * @wintype: Type of the new window. One of %wintype_Blank, %wintype_TextGrid,
232 * %wintype_TextBuffer, or %wintype_Graphics.
233 * @rock: The new window's rock value.
235 * Creates a new window. If there are no windows, the first three arguments are
236 * meaningless. @split <emphasis>must</emphasis> be 0, and @method and @size
237 * are ignored. @wintype is the type of window you're creating, and @rock is
238 * the rock (see <link linkend="chimara-Rocks">Rocks</link>).
240 * If any windows exist, new windows must be created by splitting existing
241 * ones. @split is the window you want to split; this <emphasis>must
242 * not</emphasis> be zero. @method is a mask of constants to specify the
243 * direction and the split method (see below). @size is the size of the split.
244 * @wintype is the type of window you're creating, and @rock is the rock.
246 * Remember that it is possible that the library will be unable to create a new
247 * window, in which case glk_window_open() will return %NULL.
250 * It is acceptable to gracefully exit, if the window you are creating is an
251 * important one — such as your first window. But you should not try to
252 * perform any window operation on the id until you have tested to make sure
256 * The examples we've seen so far have the simplest kind of size control. (Yes,
257 * this is <quote>below</quote>.) Every pair is a percentage split, with
260 * <mathphrase>X</mathphrase>
262 * percent going to one side, and
265 * <mathphrase>(100 - X)</mathphrase>
267 * percent going to the other side. If the player resizes the window, the whole
268 * mess expands, contracts, or stretches in a uniform way.
270 * As I said above, you can also make fixed-size splits. This is a little more
271 * complicated, because you have to know how this fixed size is measured.
273 * Sizes are measured in a way which is different for each window type. For
274 * example, a text grid window is measured by the size of its fixed-width font.
275 * You can make a text grid window which is fixed at a height of four rows, or
276 * ten columns. A text buffer window is measured by the size of its font.
279 * Remember that different windows may use different size fonts. Even two
280 * text grid windows may use fixed-size fonts of different sizes.
283 * Graphics windows are measured in pixels, not characters. Blank windows
284 * aren't measured at all; there's no meaningful way to measure them, and
285 * therefore you can't create a blank window of a fixed size, only of a
286 * proportional (percentage) size.
288 * So to create a text buffer window which takes the top 40% of the original
289 * window's space, you would execute
290 * |[ newwin = glk_window_open(win, winmethod_Above | winmethod_Proportional, 40, wintype_TextBuffer, 0); ]|
292 * To create a text grid which is always five lines high, at the bottom of the
293 * original window, you would do
294 * |[ newwin = glk_window_open(win, winmethod_Below | winmethod_Fixed, 5, wintype_TextGrid, 0); ]|
296 * Note that the meaning of the @size argument depends on the @method argument.
297 * If the method is %winmethod_Fixed, it also depends on the @wintype argument.
298 * The new window is then called the <quote>key window</quote> of this split,
299 * because its window type determines how the split size is computed.
302 * For %winmethod_Proportional splits, you can still call the new window the
303 * <quote>key window</quote>. But the key window is not important for
304 * proportional splits, because the size will always be computed as a simple
305 * ratio of the available space, not a fixed size of one child window.
308 * This system is more or less peachy as long as all the constraints work out.
309 * What happens when there is a conflict? The rules are simple. Size control
310 * always flows down the tree, and the player is at the top. Let's bring out an
312 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
313 * <entry><mediaobject><imageobject><imagedata fileref="fig5-7a.png"/>
314 * </imageobject></mediaobject></entry>
315 * <entry><mediaobject><textobject><literallayout class="monospaced">
321 * </literallayout></textobject></mediaobject></entry>
322 * </row></tbody></tgroup></informaltable>
324 * First we split A into A and B, with a 50% proportional split. Then we split
325 * A into A and C, with C above, C being a text grid window, and C gets a fixed
326 * size of two rows (as measured in its own font size). A gets whatever remains
327 * of the 50% it had before.
329 * Now the player stretches the window vertically.
330 * <informalfigure><mediaobject><imageobject><imagedata fileref="fig6.png"/>
331 * </imageobject></mediaobject></informalfigure>
333 * The library figures: the topmost split, the original A/B split, is 50-50. So
334 * B gets half the screen space, and the pair window next to it (the lower
335 * <quote>O</quote>) gets the other half. Then it looks at the lower
336 * <quote>O</quote>. C gets two rows; A gets the rest. All done.
338 * Then the user maliciously starts squeezing the window down, in stages:
339 * <informaltable xml:id="chimara-Figure-Squeezing-Window" frame="none">
340 * <tgroup cols="5"><tbody><row valign="top">
341 * <entry><mediaobject><imageobject><imagedata fileref="fig5-7a.png"/>
342 * </imageobject></mediaobject></entry>
343 * <entry><mediaobject><imageobject><imagedata fileref="fig7b.png"/>
344 * </imageobject></mediaobject></entry>
345 * <entry><mediaobject><imageobject><imagedata fileref="fig7c.png"/>
346 * </imageobject></mediaobject></entry>
347 * <entry><mediaobject><imageobject><imagedata fileref="fig7d.png"/>
348 * </imageobject></mediaobject></entry>
349 * <entry><mediaobject><imageobject><imagedata fileref="fig7e.png"/>
350 * </imageobject></mediaobject></entry>
351 * </row></tbody></tgroup></informaltable>
353 * The logic remains the same. B always gets half the space. At stage 3,
354 * there's no room left for A, so it winds up with zero height. Nothing
355 * displayed in A will be visible. At stage 4, there isn't even room in the
356 * upper 50% to give C its two rows; so it only gets one. Finally, C is
357 * squashed out of existence as well.
359 * When a window winds up undersized, it remembers what size it should be. In
360 * the example above, A remembers that it should be two rows; if the user
361 * expands the window to the original size, it would return to the original
364 * The downward flow of control is a bit harsh. After all, in stage 4, there's
365 * room for C to have its two rows if only B would give up some of its 50%. But
366 * this does not happen.
369 * This makes life much easier for the Glk library. To determine the
370 * configuration of a window, it only needs to look at the window's
371 * ancestors, never at its descendants. So window layout is a simple
372 * recursive algorithm, no backtracking.
375 * What happens when you split a fixed-size window? The resulting pair window
376 * — that is, the two new parts together — retain the same size
377 * constraint as the original window that was split. The key window for the
378 * original split is still the key window for that split, even though it's now
379 * a grandchild instead of a child.
381 * The easy, and correct, way to think about this is that the size constraint
382 * is stored by a window's parent, not the window itself; and a constraint
383 * consists of a pointer to a key window plus a size value.
385 * <informaltable frame="none"><tgroup cols="6"><tbody><row>
386 * <entry><mediaobject><imageobject><imagedata fileref="fig8a.png"/>
387 * </imageobject></mediaobject></entry>
388 * <entry><mediaobject><textobject><literallayout class="monospaced">
390 * </literallayout></textobject></mediaobject></entry>
391 * <entry><mediaobject><imageobject><imagedata fileref="fig8b.png"/>
392 * </imageobject></mediaobject></entry>
393 * <entry><mediaobject><textobject><literallayout class="monospaced">
397 * </literallayout></textobject></mediaobject></entry>
398 * <entry><mediaobject><imageobject><imagedata fileref="fig8c.png"/>
399 * </imageobject></mediaobject></entry>
400 * <entry><mediaobject><textobject><literallayout class="monospaced">
406 * </literallayout></textobject></mediaobject></entry>
407 * </row></tbody></tgroup></informaltable>
408 * After the first split, the new pair window (O1, which covers the whole
409 * screen) knows that its first child (A) is above the second, and gets 50% of
410 * its own area. (A is the key window for this split, but a proportional split
411 * doesn't care about key windows.)
413 * After the second split, all this remains true; O1 knows that its first child
414 * gets 50% of its space, and A is O1's key window. But now O1's first child is
415 * O2 instead of A. The newer pair window (O2) knows that its first child (C)
416 * is above the second, and gets a fixed size of two rows. (As measured in C's
417 * font, because C is O2's key window.)
419 * If we split C, now, the resulting pair will still be two C-font rows high
420 * — that is, tall enough for two lines of whatever font C displays. For
421 * the sake of example, we'll do this vertically.
422 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
423 * <entry><mediaobject><imageobject><imagedata fileref="fig9.png"/>
424 * </imageobject></mediaobject></entry>
425 * <entry><mediaobject><textobject><literallayout class="monospaced">
433 * </literallayout></textobject></mediaobject></entry>
434 * </row></tbody></tgroup></informaltable>
436 * O3 now knows that its children have a 50-50 left-right split. O2 is still
437 * committed to giving its upper child, O3, two C-font rows. Again, this is
438 * because C is O2's key window.
441 * This turns out to be a good idea, because it means that C, the text grid
442 * window, is still two rows high. If O3 had been a upper-lower split, things
443 * wouldn't work out so neatly. But the rules would still apply. If you don't
444 * like this, don't do it.
447 * Returns: the new window, or %NULL on error.
450 glk_window_open(winid_t split, glui32 method, glui32 size, glui32 wintype,
453 VALID_WINDOW_OR_NULL(split, return NULL);
454 g_return_val_if_fail(method == (method & (winmethod_DirMask | winmethod_DivisionMask)), NULL);
455 g_return_val_if_fail(!(((method & winmethod_DivisionMask) == winmethod_Proportional) && size > 100), NULL);
457 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
459 if(split == NULL && glk_data->root_window != NULL)
461 ILLEGAL("Tried to open a new root window, but there is already a root window");
467 /* Create the new window */
468 winid_t win = window_new_common(rock);
475 /* A blank window will be a label without any text */
476 GtkWidget *label = gtk_label_new("");
477 gtk_widget_show(label);
481 /* A blank window has no size */
483 win->unit_height = 0;
487 case wintype_TextGrid:
489 GtkWidget *textview = gtk_text_view_new();
490 GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(textview) );
492 gtk_text_view_set_wrap_mode( GTK_TEXT_VIEW(textview), GTK_WRAP_NONE );
493 gtk_text_view_set_editable( GTK_TEXT_VIEW(textview), FALSE );
494 gtk_widget_show(textview);
496 /* Create the styles available to the window stream */
497 style_init_textgrid(textbuffer);
498 gtk_widget_modify_font( textview, get_current_font(wintype) );
500 win->widget = textview;
501 win->frame = textview;
503 /* Determine the size of a "0" character in pixels */
504 PangoLayout *zero = gtk_widget_create_pango_layout(textview, "0");
505 pango_layout_set_font_description( zero, get_current_font(wintype) );
506 pango_layout_get_pixel_size(zero, &(win->unit_width), &(win->unit_height));
507 g_object_unref(zero);
508 /* width and height are set later */
510 /* Connect signal handlers */
511 win->char_input_keypress_handler = g_signal_connect(textview, "key-press-event", G_CALLBACK(on_char_input_key_press_event), win);
512 g_signal_handler_block(textview, win->char_input_keypress_handler);
513 win->line_input_keypress_handler = g_signal_connect(textview, "key-press-event", G_CALLBACK(on_line_input_key_press_event), win);
514 g_signal_handler_block(textview, win->line_input_keypress_handler);
515 win->shutdown_keypress_handler = g_signal_connect(textview, "key-press-event", G_CALLBACK(on_shutdown_key_press_event), win);
516 g_signal_handler_block(textview, win->shutdown_keypress_handler);
517 win->button_press_event_handler = g_signal_connect( textview, "button-press-event", G_CALLBACK(on_window_button_press), win );
518 g_signal_handler_block(textview, win->button_press_event_handler);
522 case wintype_TextBuffer:
524 GtkWidget *scrolledwindow = gtk_scrolled_window_new(NULL, NULL);
525 GtkWidget *textview = gtk_text_view_new();
526 GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(textview) );
528 gtk_scrolled_window_set_policy( GTK_SCROLLED_WINDOW(scrolledwindow), GTK_POLICY_NEVER, GTK_POLICY_AUTOMATIC );
530 gtk_text_view_set_wrap_mode( GTK_TEXT_VIEW(textview), GTK_WRAP_WORD_CHAR );
531 gtk_text_view_set_editable( GTK_TEXT_VIEW(textview), FALSE );
532 gtk_text_view_set_pixels_inside_wrap( GTK_TEXT_VIEW(textview), 3 );
533 gtk_text_view_set_left_margin( GTK_TEXT_VIEW(textview), 20 );
534 gtk_text_view_set_right_margin( GTK_TEXT_VIEW(textview), 20 );
536 gtk_container_add( GTK_CONTAINER(scrolledwindow), textview );
537 gtk_widget_show_all(scrolledwindow);
539 win->widget = textview;
540 win->frame = scrolledwindow;
542 /* Create the styles available to the window stream */
543 style_init_textbuffer(textbuffer);
544 style_init_more_prompt(win);
545 gtk_widget_modify_font( textview, get_current_font(wintype) );
547 /* Determine the size of a "0" character in pixels */
548 PangoLayout *zero = gtk_widget_create_pango_layout(textview, "0");
549 pango_layout_set_font_description( zero, get_current_font(wintype) );
550 pango_layout_get_pixel_size(zero, &(win->unit_width), &(win->unit_height));
551 g_object_unref(zero);
553 /* Connect signal handlers */
556 g_signal_connect_after( textview, "size-request", G_CALLBACK(pager_after_size_request), win );
557 win->pager_expose_handler = g_signal_connect_after( textview, "expose-event", G_CALLBACK(pager_on_expose), win );
558 g_signal_handler_block(textview, win->pager_expose_handler);
559 win->pager_keypress_handler = g_signal_connect( textview, "key-press-event", G_CALLBACK(pager_on_key_press_event), win );
560 g_signal_handler_block(textview, win->pager_keypress_handler);
561 GtkAdjustment *adj = gtk_scrolled_window_get_vadjustment(GTK_SCROLLED_WINDOW(scrolledwindow));
562 win->pager_adjustment_handler = g_signal_connect_after(adj, "value-changed", G_CALLBACK(pager_after_adjustment_changed), win);
564 /* Char and line input */
565 win->char_input_keypress_handler = g_signal_connect( textview, "key-press-event", G_CALLBACK(on_char_input_key_press_event), win );
566 g_signal_handler_block(textview, win->char_input_keypress_handler);
567 win->line_input_keypress_handler = g_signal_connect( textview, "key-press-event", G_CALLBACK(on_line_input_key_press_event), win );
568 g_signal_handler_block(textview, win->line_input_keypress_handler);
569 win->insert_text_handler = g_signal_connect_after( textbuffer, "insert-text", G_CALLBACK(after_window_insert_text), win );
570 g_signal_handler_block(textbuffer, win->insert_text_handler);
572 /* Shutdown key press */
573 win->shutdown_keypress_handler = g_signal_connect( textview, "key-press-event", G_CALLBACK(on_shutdown_key_press_event), win );
574 g_signal_handler_block(textview, win->shutdown_keypress_handler);
576 /* Create an editable tag to indicate uneditable parts of the window
578 gtk_text_buffer_create_tag(textbuffer, "uneditable", "editable", FALSE, "editable-set", TRUE, NULL);
580 /* Mark the position where the user will input text and the end mark */
582 gtk_text_buffer_get_end_iter(textbuffer, &end);
583 gtk_text_buffer_create_mark(textbuffer, "input_position", &end, TRUE);
584 gtk_text_buffer_create_mark(textbuffer, "end_position", &end, FALSE);
586 /* Create the pager position mark; it stands for the last character in the buffer
587 that has been on-screen */
588 gtk_text_buffer_create_mark(textbuffer, "pager_position", &end, TRUE);
592 case wintype_Graphics:
594 GtkWidget *image = gtk_image_new_from_pixmap(NULL, NULL);
595 gtk_widget_show(image);
598 win->unit_height = 1;
601 win->background_color = 0x00FFFFFF;
603 /* Connect signal handlers */
604 win->button_press_event_handler = g_signal_connect(image, "button-press-event", G_CALLBACK(on_window_button_press), win);
605 g_signal_handler_block(image, win->button_press_event_handler);
606 win->shutdown_keypress_handler = g_signal_connect(image, "key-press-event", G_CALLBACK(on_shutdown_key_press_event), win);
607 g_signal_handler_block(image, win->shutdown_keypress_handler);
608 win->size_allocate_handler = g_signal_connect(image, "size-allocate", G_CALLBACK(on_graphics_size_allocate), win);
614 ILLEGAL_PARAM("Unknown window type: %u", wintype);
616 g_node_destroy(glk_data->root_window);
617 glk_data->root_window = NULL;
621 /* Set the minimum size to "as small as possible" so it doesn't depend on
622 the size of the window contents */
623 gtk_widget_set_size_request(win->widget, 0, 0);
624 gtk_widget_set_size_request(win->frame, 0, 0);
628 /* When splitting, construct a new parent window
629 * copying most characteristics from the window that is being split */
630 winid_t pair = window_new_common(0);
631 pair->type = wintype_Pair;
633 /* The pair window must know about its children's split method */
634 pair->key_window = win;
635 pair->split_method = method;
636 pair->constraint_size = size;
638 /* Insert the new window into the window tree */
639 if(split->window_node->parent == NULL)
640 glk_data->root_window = pair->window_node;
643 if( split->window_node == g_node_first_sibling(split->window_node) )
644 g_node_prepend(split->window_node->parent, pair->window_node);
646 g_node_append(split->window_node->parent, pair->window_node);
647 g_node_unlink(split->window_node);
649 /* Place the windows in the correct order */
650 switch(method & winmethod_DirMask)
653 case winmethod_Above:
654 g_node_append(pair->window_node, win->window_node);
655 g_node_append(pair->window_node, split->window_node);
657 case winmethod_Right:
658 case winmethod_Below:
659 g_node_append(pair->window_node, split->window_node);
660 g_node_append(pair->window_node, win->window_node);
665 /* Set the window as root window */
666 glk_data->root_window = win->window_node;
669 /* Set the window as a child of the Glk widget, don't trigger an arrange event */
670 g_mutex_lock(glk_data->arrange_lock);
671 glk_data->needs_rearrange = TRUE;
672 glk_data->ignore_next_arrange_event = TRUE;
673 g_mutex_unlock(glk_data->arrange_lock);
674 gtk_widget_set_parent(win->frame, GTK_WIDGET(glk_data->self));
675 gtk_widget_queue_resize(GTK_WIDGET(glk_data->self));
677 /* For text grid windows, fill the buffer with blanks. */
678 if(wintype == wintype_TextGrid)
680 /* Create the cursor position mark */
682 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
683 gtk_text_buffer_get_start_iter(buffer, &begin);
684 gtk_text_buffer_create_mark(buffer, "cursor_position", &begin, TRUE);
688 glk_window_clear(win);
692 /* Internal function: if node's key window is closing_win or one of its
693 children, set node's key window to NULL. */
695 remove_key_windows(GNode *node, winid_t closing_win)
697 winid_t win = (winid_t)node->data;
698 if(win->key_window && (win->key_window == closing_win || g_node_is_ancestor(closing_win->window_node, win->key_window->window_node)))
699 win->key_window = NULL;
700 return FALSE; /* Don't stop the traversal */
703 /* Internal function: destroy this window's GTK widgets, window streams,
704 and those of all its children. GDK threads must be locked. */
706 destroy_windows_below(winid_t win, stream_result_t *result)
711 case wintype_TextGrid:
712 case wintype_TextBuffer:
713 case wintype_Graphics:
714 gtk_widget_unparent(win->frame);
718 destroy_windows_below(win->window_node->children->data, NULL);
719 destroy_windows_below(win->window_node->children->next->data, NULL);
723 ILLEGAL_PARAM("Unknown window type: %u", win->type);
726 stream_close_common(win->window_stream, result);
729 /* Internal function: free the winid_t structure of this window and those of all its children */
731 free_winids_below(winid_t win)
733 if(win->type == wintype_Pair) {
734 free_winids_below(win->window_node->children->data);
735 free_winids_below(win->window_node->children->next->data);
737 window_close_common(win, FALSE);
742 * @win: Window to close.
743 * @result: Pointer to a #stream_result_t in which to store the write count.
745 * Closes @win, which is pretty much exactly the opposite of opening a window.
746 * It is legal to close all your windows, or to close the root window (which is
749 * The @result argument is filled with the output character count of the window
750 * stream. See <link linkend="chimara-Streams">Streams</link> and <link
751 * linkend="chimara-Closing-Streams">Closing Streams</link>.
753 * When you close a window (and it is not the root window), the other window
754 * in its pair takes over all the freed-up area. Let's close D, in the current
756 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
757 * <entry><mediaobject><imageobject><imagedata fileref="fig10.png"/>
758 * </imageobject></mediaobject></entry>
759 * <entry><mediaobject><textobject><literallayout class="monospaced">
765 * </literallayout></textobject></mediaobject></entry>
766 * </row></tbody></tgroup></informaltable>
768 * Notice what has happened. D is gone. O3 is gone, and its 50-50 left-right
769 * split has gone with it. The other size constraints are unchanged; O2 is
770 * still committed to giving its upper child two rows, as measured in the font
771 * of O2's key window, which is C. Conveniently, O2's upper child is C, just as
772 * it was before we created D. In fact, now that D is gone, everything is back
773 * to the way it was before we created D.
775 * But what if we had closed C instead of D? We would have gotten this:
776 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
777 * <entry><mediaobject><imageobject><imagedata fileref="fig11.png"/>
778 * </imageobject></mediaobject></entry>
779 * <entry><mediaobject><textobject><literallayout class="monospaced">
785 * </literallayout></textobject></mediaobject></entry>
786 * </row></tbody></tgroup></informaltable>
788 * Again, O3 is gone. But D has collapsed to zero height. This is because its
789 * height is controlled by O2, and O2's key window was C, and C is now gone. O2
790 * no longer has a key window at all, so it cannot compute a height for its
791 * upper child, so it defaults to zero.
794 * This may seem to be an inconvenient choice. That is deliberate. You should
795 * not leave a pair window with no key, and the zero-height default reminds
796 * you not to. You can use glk_window_set_arrangement() to set a new split
797 * measurement and key window. See <link
798 * linkend="chimara-Changing-Window-Constraints">Changing Window
799 * Constraints</link>.
803 glk_window_close(winid_t win, stream_result_t *result)
805 VALID_WINDOW(win, return);
807 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
809 gdk_threads_enter(); /* Prevent redraw while we're trashing the window */
811 /* If any pair windows have this window or its children as a key window,
812 set their key window to NULL */
813 g_node_traverse(glk_data->root_window, G_IN_ORDER, G_TRAVERSE_NON_LEAVES, -1, (GNodeTraverseFunc)remove_key_windows, win);
815 /* Close all the window streams and destroy the widgets of this window
816 and below, before trashing the window tree */
817 destroy_windows_below(win, result);
819 /* Then free the winid_t structures below this node, but not this one itself */
820 if(win->type == wintype_Pair) {
821 free_winids_below(win->window_node->children->data);
822 free_winids_below(win->window_node->children->next->data);
824 /* So now we should be left with a skeleton tree hanging off this node */
826 /* Parent window changes from a split window into the sibling window */
827 /* The parent of any window is either a pair window or NULL */
828 GNode *pair_node = win->window_node->parent;
829 /* If win was not the root window: */
830 if(pair_node != NULL)
832 gboolean new_child_on_left = ( pair_node == g_node_first_sibling(pair_node) );
834 /* Lookup our sibling */
835 GNode *sibling_node = pair_node->children;
836 if(sibling_node == win->window_node)
837 sibling_node = sibling_node->next;
839 GNode *new_parent_node = pair_node->parent;
840 g_node_unlink(pair_node);
841 g_node_unlink(sibling_node);
842 /* pair_node and sibling_node should now be totally unconnected to the tree */
844 if(new_parent_node == NULL)
846 glk_data->root_window = sibling_node;
850 if(new_child_on_left)
851 g_node_prepend(new_parent_node, sibling_node);
853 g_node_append(new_parent_node, sibling_node);
856 stream_close_common( ((winid_t) pair_node->data)->window_stream, NULL );
857 window_close_common( (winid_t) pair_node->data, TRUE);
859 else /* it was the root window */
861 glk_data->root_window = NULL;
864 window_close_common(win, FALSE);
866 /* Schedule a redraw */
867 g_mutex_lock(glk_data->arrange_lock);
868 glk_data->needs_rearrange = TRUE;
869 glk_data->ignore_next_arrange_event = TRUE;
870 g_mutex_unlock(glk_data->arrange_lock);
871 gtk_widget_queue_resize( GTK_WIDGET(glk_data->self) );
879 * Erases @win. The meaning of this depends on the window type.
882 * <term>Text buffer</term>
884 * This may do any number of things, such as delete all text in the window, or
885 * print enough blank lines to scroll all text beyond visibility, or insert a
886 * page-break marker which is treated specially by the display part of the
891 * <term>Text grid</term>
893 * This will clear the window, filling all positions with blanks. The window
894 * cursor is moved to the top left corner (position 0,0).
898 * <term>Graphics</term>
900 * Clears the entire window to its current background color. See <link
901 * linkend="chimara-The-Types-of-Windows#wintype-Graphics">Graphics
906 * <term>Other window types</term>
907 * <listitem><para>No effect.</para></listitem>
911 * It is illegal to erase a window which has line input pending.
914 glk_window_clear(winid_t win)
916 VALID_WINDOW(win, return);
917 g_return_if_fail(win->input_request_type != INPUT_REQUEST_LINE && win->input_request_type != INPUT_REQUEST_LINE_UNICODE);
919 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
928 case wintype_TextGrid:
929 /* fill the buffer with blanks */
931 /* Wait for the window's size to be updated */
932 g_mutex_lock(glk_data->arrange_lock);
933 if(glk_data->needs_rearrange)
934 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
935 g_mutex_unlock(glk_data->arrange_lock);
939 /* Manually put newlines at the end of each row of characters in the buffer; manual newlines make resizing the window's grid easier. */
940 gchar *blanks = g_strnfill(win->width, ' ');
941 gchar **blanklines = g_new0(gchar *, win->height + 1);
943 for(count = 0; count < win->height; count++)
944 blanklines[count] = blanks;
945 blanklines[win->height] = NULL;
946 gchar *text = g_strjoinv("\n", blanklines);
947 g_free(blanklines); /* not g_strfreev() */
950 GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
951 gtk_text_buffer_set_text(textbuffer, text, -1);
955 gtk_text_buffer_get_start_iter(textbuffer, &begin);
956 gtk_text_buffer_move_mark_by_name(textbuffer, "cursor_position", &begin);
962 case wintype_TextBuffer:
963 /* delete all text in the window */
967 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
968 GtkTextIter start, end;
969 gtk_text_buffer_get_bounds(buffer, &start, &end);
970 gtk_text_buffer_delete(buffer, &start, &end);
976 case wintype_Graphics:
978 /* Wait for the window's size to be updated */
979 g_mutex_lock(glk_data->arrange_lock);
980 if(glk_data->needs_rearrange)
981 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
982 g_mutex_unlock(glk_data->arrange_lock);
984 glk_window_erase_rect(win, 0, 0, win->widget->allocation.width, win->widget->allocation.height);
989 ILLEGAL_PARAM("Unknown window type: %d", win->type);
995 * @win: A window, or %NULL.
997 * Sets the current stream to @win's window stream. It is exactly equivalent to
998 * |[ glk_stream_set_current(glk_window_get_stream(win)) ]|
999 * See <link linkend="chimara-Streams">Streams</link>.
1001 * <note><title>Chimara</title>
1003 * Although this is not mentioned in the specification, @win may also be
1004 * %NULL, in which case the current stream is also set to %NULL.
1008 glk_set_window(winid_t win)
1010 VALID_WINDOW_OR_NULL(win, return);
1012 glk_stream_set_current( glk_window_get_stream(win) );
1014 glk_stream_set_current(NULL);
1018 * glk_window_get_stream:
1021 * Returns the stream which is associated with @win. (See <link
1022 * linkend="chimara-Window-Streams">Window Streams</link>.) Every window has a
1023 * stream which can be printed to, but this may not be useful, depending on the
1027 * For example, printing to a blank window's stream has no effect.
1030 * Returns: A window stream.
1032 strid_t glk_window_get_stream(winid_t win)
1034 VALID_WINDOW(win, return NULL);
1035 return win->window_stream;
1039 * glk_window_set_echo_stream:
1041 * @str: A stream to attach to the window, or %NULL.
1043 * Sets @win's echo stream to @str, which can be any valid output stream. You
1044 * can reset a window to stop echoing by calling
1045 * <code>#glk_window_set_echo_stream(@win, %NULL)</code>.
1047 * It is illegal to set a window's echo stream to be its
1048 * <emphasis>own</emphasis> window stream. That would create an infinite loop,
1049 * and is nearly certain to crash the Glk library. It is similarly illegal to
1050 * create a longer loop (two or more windows echoing to each other.)
1053 glk_window_set_echo_stream(winid_t win, strid_t str)
1055 VALID_WINDOW(win, return);
1056 VALID_STREAM_OR_NULL(str, return);
1058 /* Test for an infinite loop */
1060 for(; next && next->type == STREAM_TYPE_WINDOW; next = next->window->echo_stream)
1062 if(next == win->window_stream)
1064 ILLEGAL("Infinite loop detected");
1065 win->echo_stream = NULL;
1070 win->echo_stream = str;
1074 * glk_window_get_echo_stream:
1077 * Returns the echo stream of window @win. Initially, a window has no echo
1078 * stream, so <code>#glk_window_get_echo_stream(@win)</code> will return %NULL.
1080 * Returns: A stream, or %NULL.
1083 glk_window_get_echo_stream(winid_t win)
1085 VALID_WINDOW(win, return NULL);
1086 return win->echo_stream;
1090 * glk_window_get_size:
1092 * @widthptr: Pointer to a location to store the window's width, or %NULL.
1093 * @heightptr: Pointer to a location to store the window's height, or %NULL.
1095 * Simply returns the actual size of the window, in its measurement system.
1096 * As described in <link linkend="chimara-Other-API-Conventions">Other API
1097 * Conventions</link>, either @widthptr or @heightptr can be %NULL, if you
1098 * only want one measurement.
1100 * <note><para>Or, in fact, both, if you want to waste time.</para></note>
1103 glk_window_get_size(winid_t win, glui32 *widthptr, glui32 *heightptr)
1105 VALID_WINDOW(win, return);
1107 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
1113 if(widthptr != NULL)
1115 if(heightptr != NULL)
1119 case wintype_TextGrid:
1120 /* Wait until the window's size is current */
1121 g_mutex_lock(glk_data->arrange_lock);
1122 if(glk_data->needs_rearrange)
1123 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
1124 g_mutex_unlock(glk_data->arrange_lock);
1126 gdk_threads_enter();
1127 /* Cache the width and height */
1128 win->width = (glui32)(win->widget->allocation.width / win->unit_width);
1129 win->height = (glui32)(win->widget->allocation.height / win->unit_height);
1130 gdk_threads_leave();
1132 if(widthptr != NULL)
1133 *widthptr = win->width;
1134 if(heightptr != NULL)
1135 *heightptr = win->height;
1138 case wintype_TextBuffer:
1139 /* Wait until the window's size is current */
1140 g_mutex_lock(glk_data->arrange_lock);
1141 if(glk_data->needs_rearrange)
1142 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
1143 g_mutex_unlock(glk_data->arrange_lock);
1145 gdk_threads_enter();
1146 if(widthptr != NULL)
1147 *widthptr = (glui32)(win->widget->allocation.width / win->unit_width);
1148 if(heightptr != NULL)
1149 *heightptr = (glui32)(win->widget->allocation.height / win->unit_height);
1150 gdk_threads_leave();
1154 case wintype_Graphics:
1155 g_mutex_lock(glk_data->arrange_lock);
1156 if(glk_data->needs_rearrange)
1157 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
1158 g_mutex_unlock(glk_data->arrange_lock);
1160 gdk_threads_enter();
1161 if(widthptr != NULL)
1162 *widthptr = (glui32)(win->widget->allocation.width);
1163 if(heightptr != NULL)
1164 *heightptr = (glui32)(win->widget->allocation.height);
1165 gdk_threads_leave();
1170 ILLEGAL_PARAM("Unknown window type: %u", win->type);
1175 * glk_window_set_arrangement:
1176 * @win: a pair window to rearrange.
1177 * @method: new method of size computation. One of %winmethod_Above,
1178 * %winmethod_Below, %winmethod_Left, or %winmethod_Right OR'ed with
1179 * %winmethod_Fixed or %winmethod_Proportional.
1180 * @size: new size constraint, in percentage points if @method is
1181 * %winmethod_Proportional, otherwise in characters if @win's type is
1182 * %wintype_TextBuffer or %wintype_TextGrid, or pixels if @win's type is
1183 * %wintype_Graphics.
1184 * @keywin: new key window, or %NULL to leave the key window unchanged.
1186 * Changes the size of an existing split — that is, it changes the
1187 * constraint of a given pair window.
1189 * Consider the example above, where D has collapsed to zero height. Say D was a
1190 * text buffer window. You could make a more useful layout by doing
1193 * o2 = glk_window_get_parent(d);
1194 * glk_window_set_arrangement(o2, winmethod_Above | winmethod_Fixed, 3, d);
1196 * That would set D (the upper child of O2) to be O2's key window, and give it a
1197 * fixed size of 3 rows.
1199 * If you later wanted to expand D, you could do
1200 * |[ glk_window_set_arrangement(o2, winmethod_Above | winmethod_Fixed, 5, NULL); ]|
1201 * That expands D to five rows. Note that, since O2's key window is already set
1202 * to D, it is not necessary to provide the @keywin argument; you can pass %NULL
1203 * to mean <quote>leave the key window unchanged.</quote>
1205 * If you do change the key window of a pair window, the new key window
1206 * <emphasis>must</emphasis> be a descendant of that pair window. In the current
1207 * example, you could change O2's key window to be A, but not B. The key window
1208 * also cannot be a pair window itself.
1210 * |[ glk_window_set_arrangement(o2, winmethod_Below | winmethod_Fixed, 3, NULL); ]|
1211 * This changes the constraint to be on the <emphasis>lower</emphasis> child of
1212 * O2, which is A. The key window is still D; so A would then be three rows high
1213 * as measured in D's font, and D would get the rest of O2's space. That may not
1214 * be what you want. To set A to be three rows high as measured in A's font, you
1216 * |[ glk_window_set_arrangement(o2, winmethod_Below | winmethod_Fixed, 3, a); ]|
1218 * Or you could change O2 to a proportional split:
1219 * |[ glk_window_set_arrangement(o2, winmethod_Below | winmethod_Proportional, 30, NULL); ]|
1221 * |[ glk_window_set_arrangement(o2, winmethod_Above | winmethod_Proportional, 70, NULL); ]|
1222 * These do exactly the same thing, since 30% above is the same as
1223 * 70% below. You don't need to specify a key window with a proportional
1224 * split, so the @keywin argument is %NULL. (You could actually specify either A
1225 * or D as the key window, but it wouldn't affect the result.)
1227 * Whatever constraint you set, glk_window_get_size() will tell you the actual
1228 * window size you got.
1230 * Note that you can resize windows, but you can't flip or rotate them. You
1231 * can't move A above D, or change O2 to a vertical split where A is left or
1234 * To get this effect you could close one of the windows, and re-split the
1235 * other one with glk_window_open().
1239 glk_window_set_arrangement(winid_t win, glui32 method, glui32 size, winid_t keywin)
1241 VALID_WINDOW(win, return);
1242 VALID_WINDOW_OR_NULL(keywin, return);
1243 g_return_if_fail(win->type == wintype_Pair);
1246 g_return_if_fail(keywin->type != wintype_Pair);
1247 g_return_if_fail(g_node_is_ancestor(win->window_node, keywin->window_node));
1249 g_return_if_fail(method == (method & (winmethod_DirMask | winmethod_DivisionMask)));
1250 g_return_if_fail(!(((method & winmethod_DivisionMask) == winmethod_Proportional) && size > 100));
1252 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
1254 win->split_method = method;
1255 win->constraint_size = size;
1257 win->key_window = keywin;
1259 /* Tell GTK to rearrange the windows */
1260 gdk_threads_enter();
1261 g_mutex_lock(glk_data->arrange_lock);
1262 glk_data->needs_rearrange = TRUE;
1263 glk_data->ignore_next_arrange_event = TRUE;
1264 g_mutex_unlock(glk_data->arrange_lock);
1265 gtk_widget_queue_resize(GTK_WIDGET(glk_data->self));
1266 gdk_threads_leave();
1270 * glk_window_get_arrangement:
1271 * @win: a pair window.
1272 * @methodptr: return location for the constraint flags of @win, or %NULL.
1273 * @sizeptr: return location for the constraint size of @win, or %NULL.
1274 * @keywinptr: return location for the key window of @win, or %NULL.
1276 * Queries the constraint of a given pair window.
1279 glk_window_get_arrangement(winid_t win, glui32 *methodptr, glui32 *sizeptr, winid_t *keywinptr)
1281 VALID_WINDOW(win, return);
1282 g_return_if_fail(win->type == wintype_Pair);
1285 *methodptr = win->split_method;
1287 *sizeptr = win->constraint_size;
1289 *keywinptr = win->key_window;
1293 * glk_window_move_cursor:
1294 * @win: A text grid window.
1295 * @xpos: Horizontal cursor position.
1296 * @ypos: Vertical cursor position.
1298 * Sets the cursor position. If you move the cursor right past the end of a
1299 * line, it wraps; the next character which is printed will appear at the
1300 * beginning of the next line.
1302 * If you move the cursor below the last line, or when the cursor reaches the
1303 * end of the last line, it goes <quote>off the screen</quote> and further
1304 * output has no effect. You must call glk_window_move_cursor() or
1305 * glk_window_clear() to move the cursor back into the visible region.
1308 * Note that the arguments of glk_window_move_cursor() are <type>unsigned
1309 * int</type>s. This is okay, since there are no negative positions. If you try
1310 * to pass a negative value, Glk will interpret it as a huge positive value,
1311 * and it will wrap or go off the last line.
1315 * Also note that the output cursor is not necessarily visible. In particular,
1316 * when you are requesting line or character input in a grid window, you cannot
1317 * rely on the cursor position to prompt the player where input is indicated.
1318 * You should print some character prompt at that spot — a
1319 * <quote>></quote> character, for example.
1323 glk_window_move_cursor(winid_t win, glui32 xpos, glui32 ypos)
1325 VALID_WINDOW(win, return);
1326 g_return_if_fail(win->type == wintype_TextGrid);
1328 flush_window_buffer(win);
1330 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
1332 /* Wait until the window's size is current */
1333 g_mutex_lock(glk_data->arrange_lock);
1334 if(glk_data->needs_rearrange)
1335 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
1336 g_mutex_unlock(glk_data->arrange_lock);
1338 /* Don't do anything if the window is shrunk down to nothing */
1339 if(win->width == 0 || win->height == 0)
1342 /* Calculate actual position if cursor is moved past the right edge */
1343 if(xpos >= win->width)
1345 ypos += xpos / win->width;
1349 /* Go to the end if the cursor is moved off the bottom edge */
1350 if(ypos >= win->height)
1352 xpos = win->width - 1;
1353 ypos = win->height - 1;
1356 gdk_threads_enter();
1358 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
1360 /* There must actually be a character at xpos, or the following function will choke */
1361 gtk_text_buffer_get_iter_at_line_offset(buffer, &newpos, ypos, xpos);
1362 gtk_text_buffer_move_mark_by_name(buffer, "cursor_position", &newpos);
1364 gdk_threads_leave();