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";
30 win->echo_stream = NULL;
31 win->input_request_type = INPUT_REQUEST_NONE;
32 win->line_input_buffer = NULL;
33 win->line_input_buffer_unicode = NULL;
36 /* Initialise the buffer */
37 win->buffer = g_string_sized_new(1024);
39 /* Initialise hyperlink table */
40 win->hyperlinks = g_hash_table_new_full(g_int_hash, g_int_equal, g_free, g_free);
45 /* Internal function: do all the stuff necessary to close a window. Call only
48 window_close_common(winid_t win, gboolean destroy_node)
50 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
52 if(glk_data->unregister_obj)
54 (*glk_data->unregister_obj)(win, gidisp_Class_Window, win->disprock);
55 win->disprock.ptr = NULL;
59 g_node_destroy(win->window_node);
61 win->magic = MAGIC_FREE;
63 g_list_foreach(win->history, (GFunc)g_free, NULL);
64 g_list_free(win->history);
66 g_string_free(win->buffer, TRUE);
67 g_hash_table_destroy(win->hyperlinks);
68 g_free(win->current_hyperlink);
71 g_object_unref(win->pager_layout);
78 * @win: A window, or %NULL.
79 * @rockptr: Return location for the next window's rock, or %NULL.
81 * This function can be used to iterate through the list of all open windows
82 * (including pair windows.) See <link
83 * linkend="chimara-Iterating-Through-Opaque-Objects">Iterating Through Opaque
86 * As that section describes, the order in which windows are returned is
87 * arbitrary. The root window is not necessarily first, nor is it necessarily
90 * Returns: the next window, or %NULL if there are no more.
93 glk_window_iterate(winid_t win, glui32 *rockptr)
95 VALID_WINDOW_OR_NULL(win, return NULL);
97 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
101 retnode = glk_data->root_window;
104 GNode *node = win->window_node;
105 if( G_NODE_IS_LEAF(node) )
107 while(node && node->next == NULL)
110 retnode = node->next;
115 retnode = g_node_first_child(node);
117 winid_t retval = retnode? (winid_t)retnode->data : NULL;
119 /* Store the window's rock in rockptr */
120 if(retval && rockptr)
121 *rockptr = glk_window_get_rock(retval);
127 * glk_window_get_rock:
130 * Returns @win's rock value. Pair windows always have rock 0; all other windows
131 * return whatever rock value you created them with.
133 * Returns: A rock value.
136 glk_window_get_rock(winid_t win)
138 VALID_WINDOW(win, return 0);
143 * glk_window_get_type:
146 * Returns @win's type, one of %wintype_Blank, %wintype_Pair,
147 * %wintype_TextBuffer, %wintype_TextGrid, or %wintype_Graphics.
149 * Returns: The window's type.
152 glk_window_get_type(winid_t win)
154 VALID_WINDOW(win, return 0);
159 * glk_window_get_parent:
162 * Returns the window which is the parent of @win. If @win is the root window,
163 * this returns %NULL, since the root window has no parent. Remember that the
164 * parent of every window is a pair window; other window types are always
167 * Returns: A window, or %NULL.
170 glk_window_get_parent(winid_t win)
172 VALID_WINDOW(win, return NULL);
174 /* Value will also be NULL if win is the root window */
175 if(win->window_node->parent == NULL)
178 return (winid_t)win->window_node->parent->data;
182 * glk_window_get_sibling:
185 * Returns the other child of @win's parent. If @win is the root window, this
188 * Returns: A window, or %NULL.
191 glk_window_get_sibling(winid_t win)
193 VALID_WINDOW(win, return NULL);
195 if(G_NODE_IS_ROOT(win->window_node))
197 if(win->window_node->next)
198 return (winid_t)win->window_node->next;
199 return (winid_t)win->window_node->prev;
203 * glk_window_get_root:
205 * Returns the root window. If there are no windows, this returns %NULL.
207 * Returns: A window, or %NULL.
210 glk_window_get_root()
212 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
213 if(glk_data->root_window == NULL)
215 return (winid_t)glk_data->root_window->data;
220 * @split: The window to split to create the new window. Must be 0 if there
221 * are no windows yet.
222 * @method: Position of the new window and method of size computation. One of
223 * %winmethod_Above, %winmethod_Below, %winmethod_Left, or %winmethod_Right
224 * OR'ed with %winmethod_Fixed or %winmethod_Proportional. If @wintype is
225 * %wintype_Blank, then %winmethod_Fixed is not allowed.
226 * @size: Size of the new window, in percentage points if @method is
227 * %winmethod_Proportional, otherwise in characters if @wintype is
228 * %wintype_TextBuffer or %wintype_TextGrid, or pixels if @wintype is
230 * @wintype: Type of the new window. One of %wintype_Blank, %wintype_TextGrid,
231 * %wintype_TextBuffer, or %wintype_Graphics.
232 * @rock: The new window's rock value.
234 * Creates a new window. If there are no windows, the first three arguments are
235 * meaningless. @split <emphasis>must</emphasis> be 0, and @method and @size
236 * are ignored. @wintype is the type of window you're creating, and @rock is
237 * the rock (see <link linkend="chimara-Rocks">Rocks</link>).
239 * If any windows exist, new windows must be created by splitting existing
240 * ones. @split is the window you want to split; this <emphasis>must
241 * not</emphasis> be zero. @method is a mask of constants to specify the
242 * direction and the split method (see below). @size is the size of the split.
243 * @wintype is the type of window you're creating, and @rock is the rock.
245 * Remember that it is possible that the library will be unable to create a new
246 * window, in which case glk_window_open() will return %NULL.
249 * It is acceptable to gracefully exit, if the window you are creating is an
250 * important one — such as your first window. But you should not try to
251 * perform any window operation on the id until you have tested to make sure
255 * The examples we've seen so far have the simplest kind of size control. (Yes,
256 * this is <quote>below</quote>.) Every pair is a percentage split, with
259 * <mathphrase>X</mathphrase>
261 * percent going to one side, and
264 * <mathphrase>(100 - X)</mathphrase>
266 * percent going to the other side. If the player resizes the window, the whole
267 * mess expands, contracts, or stretches in a uniform way.
269 * As I said above, you can also make fixed-size splits. This is a little more
270 * complicated, because you have to know how this fixed size is measured.
272 * Sizes are measured in a way which is different for each window type. For
273 * example, a text grid window is measured by the size of its fixed-width font.
274 * You can make a text grid window which is fixed at a height of four rows, or
275 * ten columns. A text buffer window is measured by the size of its font.
278 * Remember that different windows may use different size fonts. Even two
279 * text grid windows may use fixed-size fonts of different sizes.
282 * Graphics windows are measured in pixels, not characters. Blank windows
283 * aren't measured at all; there's no meaningful way to measure them, and
284 * therefore you can't create a blank window of a fixed size, only of a
285 * proportional (percentage) size.
287 * So to create a text buffer window which takes the top 40% of the original
288 * window's space, you would execute
289 * |[ newwin = glk_window_open(win, winmethod_Above | winmethod_Proportional, 40, wintype_TextBuffer, 0); ]|
291 * To create a text grid which is always five lines high, at the bottom of the
292 * original window, you would do
293 * |[ newwin = glk_window_open(win, winmethod_Below | winmethod_Fixed, 5, wintype_TextGrid, 0); ]|
295 * Note that the meaning of the @size argument depends on the @method argument.
296 * If the method is %winmethod_Fixed, it also depends on the @wintype argument.
297 * The new window is then called the <quote>key window</quote> of this split,
298 * because its window type determines how the split size is computed.
301 * For %winmethod_Proportional splits, you can still call the new window the
302 * <quote>key window</quote>. But the key window is not important for
303 * proportional splits, because the size will always be computed as a simple
304 * ratio of the available space, not a fixed size of one child window.
307 * This system is more or less peachy as long as all the constraints work out.
308 * What happens when there is a conflict? The rules are simple. Size control
309 * always flows down the tree, and the player is at the top. Let's bring out an
311 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
312 * <entry><mediaobject><imageobject><imagedata fileref="fig5-7a.png"/>
313 * </imageobject></mediaobject></entry>
314 * <entry><mediaobject><textobject><literallayout class="monospaced">
320 * </literallayout></textobject></mediaobject></entry>
321 * </row></tbody></tgroup></informaltable>
323 * First we split A into A and B, with a 50% proportional split. Then we split
324 * A into A and C, with C above, C being a text grid window, and C gets a fixed
325 * size of two rows (as measured in its own font size). A gets whatever remains
326 * of the 50% it had before.
328 * Now the player stretches the window vertically.
329 * <informalfigure><mediaobject><imageobject><imagedata fileref="fig6.png"/>
330 * </imageobject></mediaobject></informalfigure>
332 * The library figures: the topmost split, the original A/B split, is 50-50. So
333 * B gets half the screen space, and the pair window next to it (the lower
334 * <quote>O</quote>) gets the other half. Then it looks at the lower
335 * <quote>O</quote>. C gets two rows; A gets the rest. All done.
337 * Then the user maliciously starts squeezing the window down, in stages:
338 * <informaltable xml:id="chimara-Figure-Squeezing-Window" frame="none">
339 * <tgroup cols="5"><tbody><row valign="top">
340 * <entry><mediaobject><imageobject><imagedata fileref="fig5-7a.png"/>
341 * </imageobject></mediaobject></entry>
342 * <entry><mediaobject><imageobject><imagedata fileref="fig7b.png"/>
343 * </imageobject></mediaobject></entry>
344 * <entry><mediaobject><imageobject><imagedata fileref="fig7c.png"/>
345 * </imageobject></mediaobject></entry>
346 * <entry><mediaobject><imageobject><imagedata fileref="fig7d.png"/>
347 * </imageobject></mediaobject></entry>
348 * <entry><mediaobject><imageobject><imagedata fileref="fig7e.png"/>
349 * </imageobject></mediaobject></entry>
350 * </row></tbody></tgroup></informaltable>
352 * The logic remains the same. B always gets half the space. At stage 3,
353 * there's no room left for A, so it winds up with zero height. Nothing
354 * displayed in A will be visible. At stage 4, there isn't even room in the
355 * upper 50% to give C its two rows; so it only gets one. Finally, C is
356 * squashed out of existence as well.
358 * When a window winds up undersized, it remembers what size it should be. In
359 * the example above, A remembers that it should be two rows; if the user
360 * expands the window to the original size, it would return to the original
363 * The downward flow of control is a bit harsh. After all, in stage 4, there's
364 * room for C to have its two rows if only B would give up some of its 50%. But
365 * this does not happen.
368 * This makes life much easier for the Glk library. To determine the
369 * configuration of a window, it only needs to look at the window's
370 * ancestors, never at its descendants. So window layout is a simple
371 * recursive algorithm, no backtracking.
374 * What happens when you split a fixed-size window? The resulting pair window
375 * — that is, the two new parts together — retain the same size
376 * constraint as the original window that was split. The key window for the
377 * original split is still the key window for that split, even though it's now
378 * a grandchild instead of a child.
380 * The easy, and correct, way to think about this is that the size constraint
381 * is stored by a window's parent, not the window itself; and a constraint
382 * consists of a pointer to a key window plus a size value.
384 * <informaltable frame="none"><tgroup cols="6"><tbody><row>
385 * <entry><mediaobject><imageobject><imagedata fileref="fig8a.png"/>
386 * </imageobject></mediaobject></entry>
387 * <entry><mediaobject><textobject><literallayout class="monospaced">
389 * </literallayout></textobject></mediaobject></entry>
390 * <entry><mediaobject><imageobject><imagedata fileref="fig8b.png"/>
391 * </imageobject></mediaobject></entry>
392 * <entry><mediaobject><textobject><literallayout class="monospaced">
396 * </literallayout></textobject></mediaobject></entry>
397 * <entry><mediaobject><imageobject><imagedata fileref="fig8c.png"/>
398 * </imageobject></mediaobject></entry>
399 * <entry><mediaobject><textobject><literallayout class="monospaced">
405 * </literallayout></textobject></mediaobject></entry>
406 * </row></tbody></tgroup></informaltable>
407 * After the first split, the new pair window (O1, which covers the whole
408 * screen) knows that its first child (A) is above the second, and gets 50% of
409 * its own area. (A is the key window for this split, but a proportional split
410 * doesn't care about key windows.)
412 * After the second split, all this remains true; O1 knows that its first child
413 * gets 50% of its space, and A is O1's key window. But now O1's first child is
414 * O2 instead of A. The newer pair window (O2) knows that its first child (C)
415 * is above the second, and gets a fixed size of two rows. (As measured in C's
416 * font, because C is O2's key window.)
418 * If we split C, now, the resulting pair will still be two C-font rows high
419 * — that is, tall enough for two lines of whatever font C displays. For
420 * the sake of example, we'll do this vertically.
421 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
422 * <entry><mediaobject><imageobject><imagedata fileref="fig9.png"/>
423 * </imageobject></mediaobject></entry>
424 * <entry><mediaobject><textobject><literallayout class="monospaced">
432 * </literallayout></textobject></mediaobject></entry>
433 * </row></tbody></tgroup></informaltable>
435 * O3 now knows that its children have a 50-50 left-right split. O2 is still
436 * committed to giving its upper child, O3, two C-font rows. Again, this is
437 * because C is O2's key window.
440 * This turns out to be a good idea, because it means that C, the text grid
441 * window, is still two rows high. If O3 had been a upper-lower split, things
442 * wouldn't work out so neatly. But the rules would still apply. If you don't
443 * like this, don't do it.
446 * Returns: the new window, or %NULL on error.
449 glk_window_open(winid_t split, glui32 method, glui32 size, glui32 wintype,
452 VALID_WINDOW_OR_NULL(split, return NULL);
453 g_return_val_if_fail(method == (method & (winmethod_DirMask | winmethod_DivisionMask)), NULL);
454 g_return_val_if_fail(!(((method & winmethod_DivisionMask) == winmethod_Proportional) && size > 100), NULL);
456 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
458 if(split == NULL && glk_data->root_window != NULL)
460 ILLEGAL("Tried to open a new root window, but there is already a root window");
466 /* Create the new window */
467 winid_t win = window_new_common(rock);
474 /* A blank window will be a label without any text */
475 GtkWidget *label = gtk_label_new("");
476 gtk_widget_show(label);
480 /* A blank window has no size */
482 win->unit_height = 0;
486 case wintype_TextGrid:
488 GtkWidget *textview = gtk_text_view_new();
489 GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(textview) );
491 gtk_text_view_set_wrap_mode( GTK_TEXT_VIEW(textview), GTK_WRAP_NONE );
492 gtk_text_view_set_editable( GTK_TEXT_VIEW(textview), FALSE );
493 gtk_widget_show(textview);
495 /* Create the styles available to the window stream */
496 style_init_textgrid(textbuffer);
497 gtk_widget_modify_font( textview, get_current_font(wintype) );
499 win->widget = textview;
500 win->frame = textview;
502 /* Determine the size of a "0" character in pixels */
503 PangoLayout *zero = gtk_widget_create_pango_layout(textview, "0");
504 pango_layout_set_font_description( zero, get_current_font(wintype) );
505 pango_layout_get_pixel_size(zero, &(win->unit_width), &(win->unit_height));
506 g_object_unref(zero);
507 /* width and height are set later */
509 /* Connect signal handlers */
510 win->char_input_keypress_handler = g_signal_connect(textview, "key-press-event", G_CALLBACK(on_char_input_key_press_event), win);
511 g_signal_handler_block(textview, win->char_input_keypress_handler);
512 win->line_input_keypress_handler = g_signal_connect(textview, "key-press-event", G_CALLBACK(on_line_input_key_press_event), win);
513 g_signal_handler_block(textview, win->line_input_keypress_handler);
514 win->shutdown_keypress_handler = g_signal_connect(textview, "key-press-event", G_CALLBACK(on_shutdown_key_press_event), win);
515 g_signal_handler_block(textview, win->shutdown_keypress_handler);
516 win->button_press_event_handler = g_signal_connect( textview, "button-press-event", G_CALLBACK(on_window_button_press), win );
517 g_signal_handler_block(textview, win->button_press_event_handler);
521 case wintype_TextBuffer:
523 GtkWidget *scrolledwindow = gtk_scrolled_window_new(NULL, NULL);
524 GtkWidget *textview = gtk_text_view_new();
525 GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(textview) );
527 gtk_scrolled_window_set_policy( GTK_SCROLLED_WINDOW(scrolledwindow), GTK_POLICY_NEVER, GTK_POLICY_AUTOMATIC );
529 gtk_text_view_set_wrap_mode( GTK_TEXT_VIEW(textview), GTK_WRAP_WORD_CHAR );
530 gtk_text_view_set_editable( GTK_TEXT_VIEW(textview), FALSE );
531 gtk_text_view_set_pixels_inside_wrap( GTK_TEXT_VIEW(textview), 3 );
532 gtk_text_view_set_left_margin( GTK_TEXT_VIEW(textview), 20 );
533 gtk_text_view_set_right_margin( GTK_TEXT_VIEW(textview), 20 );
535 gtk_container_add( GTK_CONTAINER(scrolledwindow), textview );
536 gtk_widget_show_all(scrolledwindow);
538 win->widget = textview;
539 win->frame = scrolledwindow;
541 /* Create the styles available to the window stream */
542 style_init_textbuffer(textbuffer);
543 style_init_more_prompt(win);
544 gtk_widget_modify_font( textview, get_current_font(wintype) );
546 /* Determine the size of a "0" character in pixels */
547 PangoLayout *zero = gtk_widget_create_pango_layout(textview, "0");
548 pango_layout_set_font_description( zero, get_current_font(wintype) );
549 pango_layout_get_pixel_size(zero, &(win->unit_width), &(win->unit_height));
550 g_object_unref(zero);
552 /* Connect signal handlers */
555 win->pager_expose_handler = g_signal_connect_after( textview, "expose-event", G_CALLBACK(pager_on_expose), win );
556 g_signal_handler_block(textview, win->pager_expose_handler);
557 win->pager_keypress_handler = g_signal_connect( textview, "key-press-event", G_CALLBACK(pager_on_key_press_event), win );
558 g_signal_handler_block(textview, win->pager_keypress_handler);
559 GtkAdjustment *adj = gtk_scrolled_window_get_vadjustment(GTK_SCROLLED_WINDOW(scrolledwindow));
560 g_signal_connect_after(adj, "value-changed", G_CALLBACK(pager_after_adjustment_changed), win);
562 /* Char and line input */
563 win->char_input_keypress_handler = g_signal_connect( textview, "key-press-event", G_CALLBACK(on_char_input_key_press_event), win );
564 g_signal_handler_block(textview, win->char_input_keypress_handler);
565 win->line_input_keypress_handler = g_signal_connect( textview, "key-press-event", G_CALLBACK(on_line_input_key_press_event), win );
566 g_signal_handler_block(textview, win->line_input_keypress_handler);
567 win->insert_text_handler = g_signal_connect_after( textbuffer, "insert-text", G_CALLBACK(after_window_insert_text), win );
568 g_signal_handler_block(textbuffer, win->insert_text_handler);
570 /* Shutdown key press */
571 win->shutdown_keypress_handler = g_signal_connect( textview, "key-press-event", G_CALLBACK(on_shutdown_key_press_event), win );
572 g_signal_handler_block(textview, win->shutdown_keypress_handler);
574 /* Create an editable tag to indicate uneditable parts of the window
576 gtk_text_buffer_create_tag(textbuffer, "uneditable", "editable", FALSE, "editable-set", TRUE, NULL);
578 /* Mark the position where the user will input text and the end mark */
580 gtk_text_buffer_get_end_iter(textbuffer, &end);
581 gtk_text_buffer_create_mark(textbuffer, "input_position", &end, TRUE);
582 gtk_text_buffer_create_mark(textbuffer, "end_position", &end, FALSE);
584 /* Create the pager position mark; it stands for the last character in the buffer
585 that has been on-screen */
586 gtk_text_buffer_create_mark(textbuffer, "pager_position", &end, TRUE);
590 case wintype_Graphics:
592 GtkWidget *image = gtk_image_new_from_pixmap(NULL, NULL);
593 gtk_widget_show(image);
596 win->unit_height = 1;
599 win->background_color = 0x00FFFFFF;
601 /* Connect signal handlers */
602 win->button_press_event_handler = g_signal_connect(image, "button-press-event", G_CALLBACK(on_window_button_press), win);
603 g_signal_handler_block(image, win->button_press_event_handler);
604 win->shutdown_keypress_handler = g_signal_connect(image, "key-press-event", G_CALLBACK(on_shutdown_key_press_event), win);
605 g_signal_handler_block(image, win->shutdown_keypress_handler);
606 win->size_allocate_handler = g_signal_connect(image, "size-allocate", G_CALLBACK(on_graphics_size_allocate), win);
612 ILLEGAL_PARAM("Unknown window type: %u", wintype);
614 g_node_destroy(glk_data->root_window);
615 glk_data->root_window = NULL;
619 /* Set the minimum size to "as small as possible" so it doesn't depend on
620 the size of the window contents */
621 gtk_widget_set_size_request(win->widget, 0, 0);
622 gtk_widget_set_size_request(win->frame, 0, 0);
626 /* When splitting, construct a new parent window
627 * copying most characteristics from the window that is being split */
628 winid_t pair = window_new_common(0);
629 pair->type = wintype_Pair;
631 /* The pair window must know about its children's split method */
632 pair->key_window = win;
633 pair->split_method = method;
634 pair->constraint_size = size;
636 /* Insert the new window into the window tree */
637 if(split->window_node->parent == NULL)
638 glk_data->root_window = pair->window_node;
641 if( split->window_node == g_node_first_sibling(split->window_node) )
642 g_node_prepend(split->window_node->parent, pair->window_node);
644 g_node_append(split->window_node->parent, pair->window_node);
645 g_node_unlink(split->window_node);
647 /* Place the windows in the correct order */
648 switch(method & winmethod_DirMask)
651 case winmethod_Above:
652 g_node_append(pair->window_node, win->window_node);
653 g_node_append(pair->window_node, split->window_node);
655 case winmethod_Right:
656 case winmethod_Below:
657 g_node_append(pair->window_node, split->window_node);
658 g_node_append(pair->window_node, win->window_node);
663 /* Set the window as root window */
664 glk_data->root_window = win->window_node;
667 /* Set the window as a child of the Glk widget, don't trigger an arrange event */
668 g_mutex_lock(glk_data->arrange_lock);
669 glk_data->needs_rearrange = TRUE;
670 glk_data->ignore_next_arrange_event = TRUE;
671 g_mutex_unlock(glk_data->arrange_lock);
672 gtk_widget_set_parent(win->frame, GTK_WIDGET(glk_data->self));
673 gtk_widget_queue_resize(GTK_WIDGET(glk_data->self));
675 /* For text grid windows, fill the buffer with blanks. */
676 if(wintype == wintype_TextGrid)
678 /* Create the cursor position mark */
680 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
681 gtk_text_buffer_get_start_iter(buffer, &begin);
682 gtk_text_buffer_create_mark(buffer, "cursor_position", &begin, TRUE);
686 glk_window_clear(win);
690 /* Internal function: if node's key window is closing_win or one of its
691 children, set node's key window to NULL. */
693 remove_key_windows(GNode *node, winid_t closing_win)
695 winid_t win = (winid_t)node->data;
696 if(win->key_window && (win->key_window == closing_win || g_node_is_ancestor(closing_win->window_node, win->key_window->window_node)))
697 win->key_window = NULL;
698 return FALSE; /* Don't stop the traversal */
701 /* Internal function: destroy this window's GTK widgets, window streams,
702 and those of all its children. GDK threads must be locked. */
704 destroy_windows_below(winid_t win, stream_result_t *result)
709 case wintype_TextGrid:
710 case wintype_TextBuffer:
711 case wintype_Graphics:
712 gtk_widget_unparent(win->frame);
716 destroy_windows_below(win->window_node->children->data, NULL);
717 destroy_windows_below(win->window_node->children->next->data, NULL);
721 ILLEGAL_PARAM("Unknown window type: %u", win->type);
724 stream_close_common(win->window_stream, result);
727 /* Internal function: free the winid_t structure of this window and those of all its children */
729 free_winids_below(winid_t win)
731 if(win->type == wintype_Pair) {
732 free_winids_below(win->window_node->children->data);
733 free_winids_below(win->window_node->children->next->data);
735 window_close_common(win, FALSE);
740 * @win: Window to close.
741 * @result: Pointer to a #stream_result_t in which to store the write count.
743 * Closes @win, which is pretty much exactly the opposite of opening a window.
744 * It is legal to close all your windows, or to close the root window (which is
747 * The @result argument is filled with the output character count of the window
748 * stream. See <link linkend="chimara-Streams">Streams</link> and <link
749 * linkend="chimara-Closing-Streams">Closing Streams</link>.
751 * When you close a window (and it is not the root window), the other window
752 * in its pair takes over all the freed-up area. Let's close D, in the current
754 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
755 * <entry><mediaobject><imageobject><imagedata fileref="fig10.png"/>
756 * </imageobject></mediaobject></entry>
757 * <entry><mediaobject><textobject><literallayout class="monospaced">
763 * </literallayout></textobject></mediaobject></entry>
764 * </row></tbody></tgroup></informaltable>
766 * Notice what has happened. D is gone. O3 is gone, and its 50-50 left-right
767 * split has gone with it. The other size constraints are unchanged; O2 is
768 * still committed to giving its upper child two rows, as measured in the font
769 * of O2's key window, which is C. Conveniently, O2's upper child is C, just as
770 * it was before we created D. In fact, now that D is gone, everything is back
771 * to the way it was before we created D.
773 * But what if we had closed C instead of D? We would have gotten this:
774 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
775 * <entry><mediaobject><imageobject><imagedata fileref="fig11.png"/>
776 * </imageobject></mediaobject></entry>
777 * <entry><mediaobject><textobject><literallayout class="monospaced">
783 * </literallayout></textobject></mediaobject></entry>
784 * </row></tbody></tgroup></informaltable>
786 * Again, O3 is gone. But D has collapsed to zero height. This is because its
787 * height is controlled by O2, and O2's key window was C, and C is now gone. O2
788 * no longer has a key window at all, so it cannot compute a height for its
789 * upper child, so it defaults to zero.
792 * This may seem to be an inconvenient choice. That is deliberate. You should
793 * not leave a pair window with no key, and the zero-height default reminds
794 * you not to. You can use glk_window_set_arrangement() to set a new split
795 * measurement and key window. See <link
796 * linkend="chimara-Changing-Window-Constraints">Changing Window
797 * Constraints</link>.
801 glk_window_close(winid_t win, stream_result_t *result)
803 VALID_WINDOW(win, return);
805 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
807 gdk_threads_enter(); /* Prevent redraw while we're trashing the window */
809 /* If any pair windows have this window or its children as a key window,
810 set their key window to NULL */
811 g_node_traverse(glk_data->root_window, G_IN_ORDER, G_TRAVERSE_NON_LEAVES, -1, (GNodeTraverseFunc)remove_key_windows, win);
813 /* Close all the window streams and destroy the widgets of this window
814 and below, before trashing the window tree */
815 destroy_windows_below(win, result);
817 /* Then free the winid_t structures below this node, but not this one itself */
818 if(win->type == wintype_Pair) {
819 free_winids_below(win->window_node->children->data);
820 free_winids_below(win->window_node->children->next->data);
822 /* So now we should be left with a skeleton tree hanging off this node */
824 /* Parent window changes from a split window into the sibling window */
825 /* The parent of any window is either a pair window or NULL */
826 GNode *pair_node = win->window_node->parent;
827 /* If win was not the root window: */
828 if(pair_node != NULL)
830 gboolean new_child_on_left = ( pair_node == g_node_first_sibling(pair_node) );
832 /* Lookup our sibling */
833 GNode *sibling_node = pair_node->children;
834 if(sibling_node == win->window_node)
835 sibling_node = sibling_node->next;
837 GNode *new_parent_node = pair_node->parent;
838 g_node_unlink(pair_node);
839 g_node_unlink(sibling_node);
840 /* pair_node and sibling_node should now be totally unconnected to the tree */
842 if(new_parent_node == NULL)
844 glk_data->root_window = sibling_node;
848 if(new_child_on_left)
849 g_node_prepend(new_parent_node, sibling_node);
851 g_node_append(new_parent_node, sibling_node);
854 stream_close_common( ((winid_t) pair_node->data)->window_stream, NULL );
855 window_close_common( (winid_t) pair_node->data, TRUE);
857 else /* it was the root window */
859 glk_data->root_window = NULL;
862 window_close_common(win, FALSE);
864 /* Schedule a redraw */
865 g_mutex_lock(glk_data->arrange_lock);
866 glk_data->needs_rearrange = TRUE;
867 glk_data->ignore_next_arrange_event = TRUE;
868 g_mutex_unlock(glk_data->arrange_lock);
869 gtk_widget_queue_resize( GTK_WIDGET(glk_data->self) );
877 * Erases @win. The meaning of this depends on the window type.
880 * <term>Text buffer</term>
882 * This may do any number of things, such as delete all text in the window, or
883 * print enough blank lines to scroll all text beyond visibility, or insert a
884 * page-break marker which is treated specially by the display part of the
889 * <term>Text grid</term>
891 * This will clear the window, filling all positions with blanks. The window
892 * cursor is moved to the top left corner (position 0,0).
896 * <term>Graphics</term>
898 * Clears the entire window to its current background color. See <link
899 * linkend="chimara-The-Types-of-Windows#wintype-Graphics">Graphics
904 * <term>Other window types</term>
905 * <listitem><para>No effect.</para></listitem>
909 * It is illegal to erase a window which has line input pending.
912 glk_window_clear(winid_t win)
914 VALID_WINDOW(win, return);
915 g_return_if_fail(win->input_request_type != INPUT_REQUEST_LINE && win->input_request_type != INPUT_REQUEST_LINE_UNICODE);
917 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
926 case wintype_TextGrid:
927 /* fill the buffer with blanks */
929 /* Wait for the window's size to be updated */
930 g_mutex_lock(glk_data->arrange_lock);
931 if(glk_data->needs_rearrange)
932 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
933 g_mutex_unlock(glk_data->arrange_lock);
937 /* Manually put newlines at the end of each row of characters in the buffer; manual newlines make resizing the window's grid easier. */
938 gchar *blanks = g_strnfill(win->width, ' ');
939 gchar **blanklines = g_new0(gchar *, win->height + 1);
941 for(count = 0; count < win->height; count++)
942 blanklines[count] = blanks;
943 blanklines[win->height] = NULL;
944 gchar *text = g_strjoinv("\n", blanklines);
945 g_free(blanklines); /* not g_strfreev() */
948 GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
949 gtk_text_buffer_set_text(textbuffer, text, -1);
953 gtk_text_buffer_get_start_iter(textbuffer, &begin);
954 gtk_text_buffer_move_mark_by_name(textbuffer, "cursor_position", &begin);
960 case wintype_TextBuffer:
961 /* delete all text in the window */
965 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
966 GtkTextIter start, end;
967 gtk_text_buffer_get_bounds(buffer, &start, &end);
968 gtk_text_buffer_delete(buffer, &start, &end);
974 case wintype_Graphics:
976 /* Wait for the window's size to be updated */
977 g_mutex_lock(glk_data->arrange_lock);
978 if(glk_data->needs_rearrange)
979 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
980 g_mutex_unlock(glk_data->arrange_lock);
982 glk_window_erase_rect(win, 0, 0, win->widget->allocation.width, win->widget->allocation.height);
987 ILLEGAL_PARAM("Unknown window type: %d", win->type);
993 * @win: A window, or %NULL.
995 * Sets the current stream to @win's window stream. It is exactly equivalent to
996 * |[ glk_stream_set_current(glk_window_get_stream(win)) ]|
997 * See <link linkend="chimara-Streams">Streams</link>.
999 * <note><title>Chimara</title>
1001 * Although this is not mentioned in the specification, @win may also be
1002 * %NULL, in which case the current stream is also set to %NULL.
1006 glk_set_window(winid_t win)
1008 VALID_WINDOW_OR_NULL(win, return);
1010 glk_stream_set_current( glk_window_get_stream(win) );
1012 glk_stream_set_current(NULL);
1016 * glk_window_get_stream:
1019 * Returns the stream which is associated with @win. (See <link
1020 * linkend="chimara-Window-Streams">Window Streams</link>.) Every window has a
1021 * stream which can be printed to, but this may not be useful, depending on the
1025 * For example, printing to a blank window's stream has no effect.
1028 * Returns: A window stream.
1030 strid_t glk_window_get_stream(winid_t win)
1032 VALID_WINDOW(win, return NULL);
1033 return win->window_stream;
1037 * glk_window_set_echo_stream:
1039 * @str: A stream to attach to the window, or %NULL.
1041 * Sets @win's echo stream to @str, which can be any valid output stream. You
1042 * can reset a window to stop echoing by calling
1043 * <code>#glk_window_set_echo_stream(@win, %NULL)</code>.
1045 * It is illegal to set a window's echo stream to be its
1046 * <emphasis>own</emphasis> window stream. That would create an infinite loop,
1047 * and is nearly certain to crash the Glk library. It is similarly illegal to
1048 * create a longer loop (two or more windows echoing to each other.)
1051 glk_window_set_echo_stream(winid_t win, strid_t str)
1053 VALID_WINDOW(win, return);
1054 VALID_STREAM_OR_NULL(str, return);
1056 /* Test for an infinite loop */
1058 for(; next && next->type == STREAM_TYPE_WINDOW; next = next->window->echo_stream)
1060 if(next == win->window_stream)
1062 ILLEGAL("Infinite loop detected");
1063 win->echo_stream = NULL;
1068 win->echo_stream = str;
1072 * glk_window_get_echo_stream:
1075 * Returns the echo stream of window @win. Initially, a window has no echo
1076 * stream, so <code>#glk_window_get_echo_stream(@win)</code> will return %NULL.
1078 * Returns: A stream, or %NULL.
1081 glk_window_get_echo_stream(winid_t win)
1083 VALID_WINDOW(win, return NULL);
1084 return win->echo_stream;
1088 * glk_window_get_size:
1090 * @widthptr: Pointer to a location to store the window's width, or %NULL.
1091 * @heightptr: Pointer to a location to store the window's height, or %NULL.
1093 * Simply returns the actual size of the window, in its measurement system.
1094 * As described in <link linkend="chimara-Other-API-Conventions">Other API
1095 * Conventions</link>, either @widthptr or @heightptr can be %NULL, if you
1096 * only want one measurement.
1098 * <note><para>Or, in fact, both, if you want to waste time.</para></note>
1101 glk_window_get_size(winid_t win, glui32 *widthptr, glui32 *heightptr)
1103 VALID_WINDOW(win, return);
1105 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
1111 if(widthptr != NULL)
1113 if(heightptr != NULL)
1117 case wintype_TextGrid:
1118 /* Wait until the window's size is current */
1119 g_mutex_lock(glk_data->arrange_lock);
1120 if(glk_data->needs_rearrange)
1121 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
1122 g_mutex_unlock(glk_data->arrange_lock);
1124 gdk_threads_enter();
1125 /* Cache the width and height */
1126 win->width = (glui32)(win->widget->allocation.width / win->unit_width);
1127 win->height = (glui32)(win->widget->allocation.height / win->unit_height);
1128 gdk_threads_leave();
1130 if(widthptr != NULL)
1131 *widthptr = win->width;
1132 if(heightptr != NULL)
1133 *heightptr = win->height;
1136 case wintype_TextBuffer:
1137 /* Wait until the window's size is current */
1138 g_mutex_lock(glk_data->arrange_lock);
1139 if(glk_data->needs_rearrange)
1140 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
1141 g_mutex_unlock(glk_data->arrange_lock);
1143 gdk_threads_enter();
1144 if(widthptr != NULL)
1145 *widthptr = (glui32)(win->widget->allocation.width / win->unit_width);
1146 if(heightptr != NULL)
1147 *heightptr = (glui32)(win->widget->allocation.height / win->unit_height);
1148 gdk_threads_leave();
1152 case wintype_Graphics:
1153 g_mutex_lock(glk_data->arrange_lock);
1154 if(glk_data->needs_rearrange)
1155 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
1156 g_mutex_unlock(glk_data->arrange_lock);
1158 gdk_threads_enter();
1159 if(widthptr != NULL)
1160 *widthptr = (glui32)(win->widget->allocation.width);
1161 if(heightptr != NULL)
1162 *heightptr = (glui32)(win->widget->allocation.height);
1163 gdk_threads_leave();
1168 ILLEGAL_PARAM("Unknown window type: %u", win->type);
1173 * glk_window_set_arrangement:
1174 * @win: a pair window to rearrange.
1175 * @method: new method of size computation. One of %winmethod_Above,
1176 * %winmethod_Below, %winmethod_Left, or %winmethod_Right OR'ed with
1177 * %winmethod_Fixed or %winmethod_Proportional.
1178 * @size: new size constraint, in percentage points if @method is
1179 * %winmethod_Proportional, otherwise in characters if @win's type is
1180 * %wintype_TextBuffer or %wintype_TextGrid, or pixels if @win's type is
1181 * %wintype_Graphics.
1182 * @keywin: new key window, or %NULL to leave the key window unchanged.
1184 * Changes the size of an existing split — that is, it changes the
1185 * constraint of a given pair window.
1187 * Consider the example above, where D has collapsed to zero height. Say D was a
1188 * text buffer window. You could make a more useful layout by doing
1191 * o2 = glk_window_get_parent(d);
1192 * glk_window_set_arrangement(o2, winmethod_Above | winmethod_Fixed, 3, d);
1194 * That would set D (the upper child of O2) to be O2's key window, and give it a
1195 * fixed size of 3 rows.
1197 * If you later wanted to expand D, you could do
1198 * |[ glk_window_set_arrangement(o2, winmethod_Above | winmethod_Fixed, 5, NULL); ]|
1199 * That expands D to five rows. Note that, since O2's key window is already set
1200 * to D, it is not necessary to provide the @keywin argument; you can pass %NULL
1201 * to mean <quote>leave the key window unchanged.</quote>
1203 * If you do change the key window of a pair window, the new key window
1204 * <emphasis>must</emphasis> be a descendant of that pair window. In the current
1205 * example, you could change O2's key window to be A, but not B. The key window
1206 * also cannot be a pair window itself.
1208 * |[ glk_window_set_arrangement(o2, winmethod_Below | winmethod_Fixed, 3, NULL); ]|
1209 * This changes the constraint to be on the <emphasis>lower</emphasis> child of
1210 * O2, which is A. The key window is still D; so A would then be three rows high
1211 * as measured in D's font, and D would get the rest of O2's space. That may not
1212 * be what you want. To set A to be three rows high as measured in A's font, you
1214 * |[ glk_window_set_arrangement(o2, winmethod_Below | winmethod_Fixed, 3, a); ]|
1216 * Or you could change O2 to a proportional split:
1217 * |[ glk_window_set_arrangement(o2, winmethod_Below | winmethod_Proportional, 30, NULL); ]|
1219 * |[ glk_window_set_arrangement(o2, winmethod_Above | winmethod_Proportional, 70, NULL); ]|
1220 * These do exactly the same thing, since 30% above is the same as
1221 * 70% below. You don't need to specify a key window with a proportional
1222 * split, so the @keywin argument is %NULL. (You could actually specify either A
1223 * or D as the key window, but it wouldn't affect the result.)
1225 * Whatever constraint you set, glk_window_get_size() will tell you the actual
1226 * window size you got.
1228 * Note that you can resize windows, but you can't flip or rotate them. You
1229 * can't move A above D, or change O2 to a vertical split where A is left or
1232 * To get this effect you could close one of the windows, and re-split the
1233 * other one with glk_window_open().
1237 glk_window_set_arrangement(winid_t win, glui32 method, glui32 size, winid_t keywin)
1239 VALID_WINDOW(win, return);
1240 VALID_WINDOW_OR_NULL(keywin, return);
1241 g_return_if_fail(win->type == wintype_Pair);
1244 g_return_if_fail(keywin->type != wintype_Pair);
1245 g_return_if_fail(g_node_is_ancestor(win->window_node, keywin->window_node));
1247 g_return_if_fail(method == (method & (winmethod_DirMask | winmethod_DivisionMask)));
1248 g_return_if_fail(!(((method & winmethod_DivisionMask) == winmethod_Proportional) && size > 100));
1250 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
1252 win->split_method = method;
1253 win->constraint_size = size;
1255 win->key_window = keywin;
1257 /* Tell GTK to rearrange the windows */
1258 gdk_threads_enter();
1259 g_mutex_lock(glk_data->arrange_lock);
1260 glk_data->needs_rearrange = TRUE;
1261 glk_data->ignore_next_arrange_event = TRUE;
1262 g_mutex_unlock(glk_data->arrange_lock);
1263 gtk_widget_queue_resize(GTK_WIDGET(glk_data->self));
1264 gdk_threads_leave();
1268 * glk_window_get_arrangement:
1269 * @win: a pair window.
1270 * @methodptr: return location for the constraint flags of @win, or %NULL.
1271 * @sizeptr: return location for the constraint size of @win, or %NULL.
1272 * @keywinptr: return location for the key window of @win, or %NULL.
1274 * Queries the constraint of a given pair window.
1277 glk_window_get_arrangement(winid_t win, glui32 *methodptr, glui32 *sizeptr, winid_t *keywinptr)
1279 VALID_WINDOW(win, return);
1280 g_return_if_fail(win->type == wintype_Pair);
1283 *methodptr = win->split_method;
1285 *sizeptr = win->constraint_size;
1287 *keywinptr = win->key_window;
1291 * glk_window_move_cursor:
1292 * @win: A text grid window.
1293 * @xpos: Horizontal cursor position.
1294 * @ypos: Vertical cursor position.
1296 * Sets the cursor position. If you move the cursor right past the end of a
1297 * line, it wraps; the next character which is printed will appear at the
1298 * beginning of the next line.
1300 * If you move the cursor below the last line, or when the cursor reaches the
1301 * end of the last line, it goes <quote>off the screen</quote> and further
1302 * output has no effect. You must call glk_window_move_cursor() or
1303 * glk_window_clear() to move the cursor back into the visible region.
1306 * Note that the arguments of glk_window_move_cursor() are <type>unsigned
1307 * int</type>s. This is okay, since there are no negative positions. If you try
1308 * to pass a negative value, Glk will interpret it as a huge positive value,
1309 * and it will wrap or go off the last line.
1313 * Also note that the output cursor is not necessarily visible. In particular,
1314 * when you are requesting line or character input in a grid window, you cannot
1315 * rely on the cursor position to prompt the player where input is indicated.
1316 * You should print some character prompt at that spot — a
1317 * <quote>></quote> character, for example.
1321 glk_window_move_cursor(winid_t win, glui32 xpos, glui32 ypos)
1323 VALID_WINDOW(win, return);
1324 g_return_if_fail(win->type == wintype_TextGrid);
1326 flush_window_buffer(win);
1328 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
1330 /* Wait until the window's size is current */
1331 g_mutex_lock(glk_data->arrange_lock);
1332 if(glk_data->needs_rearrange)
1333 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
1334 g_mutex_unlock(glk_data->arrange_lock);
1336 /* Don't do anything if the window is shrunk down to nothing */
1337 if(win->width == 0 || win->height == 0)
1340 /* Calculate actual position if cursor is moved past the right edge */
1341 if(xpos >= win->width)
1343 ypos += xpos / win->width;
1347 /* Go to the end if the cursor is moved off the bottom edge */
1348 if(ypos >= win->height)
1350 xpos = win->width - 1;
1351 ypos = win->height - 1;
1354 gdk_threads_enter();
1356 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
1358 /* There must actually be a character at xpos, or the following function will choke */
1359 gtk_text_buffer_get_iter_at_line_offset(buffer, &newpos, ypos, xpos);
1360 gtk_text_buffer_move_mark_by_name(buffer, "cursor_position", &newpos);
1362 gdk_threads_leave();