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, "expose-event", G_CALLBACK(pager_after_expose_event), win );
557 g_signal_connect_after( textview, "size-request", G_CALLBACK(pager_after_size_request), win );
558 win->pager_expose_handler = g_signal_connect_after( textview, "expose-event", G_CALLBACK(pager_on_expose), win );
559 g_signal_handler_block(textview, win->pager_expose_handler);
560 win->pager_keypress_handler = g_signal_connect( textview, "key-press-event", G_CALLBACK(pager_on_key_press_event), win );
561 g_signal_handler_block(textview, win->pager_keypress_handler);
562 GtkAdjustment *adj = gtk_scrolled_window_get_vadjustment(GTK_SCROLLED_WINDOW(scrolledwindow));
563 win->pager_adjustment_handler = g_signal_connect_after(adj, "value-changed", G_CALLBACK(pager_after_adjustment_changed), win);
565 /* Char and line input */
566 win->char_input_keypress_handler = g_signal_connect( textview, "key-press-event", G_CALLBACK(on_char_input_key_press_event), win );
567 g_signal_handler_block(textview, win->char_input_keypress_handler);
568 win->line_input_keypress_handler = g_signal_connect( textview, "key-press-event", G_CALLBACK(on_line_input_key_press_event), win );
569 g_signal_handler_block(textview, win->line_input_keypress_handler);
570 win->insert_text_handler = g_signal_connect_after( textbuffer, "insert-text", G_CALLBACK(after_window_insert_text), win );
571 g_signal_handler_block(textbuffer, win->insert_text_handler);
573 /* Shutdown key press */
574 win->shutdown_keypress_handler = g_signal_connect( textview, "key-press-event", G_CALLBACK(on_shutdown_key_press_event), win );
575 g_signal_handler_block(textview, win->shutdown_keypress_handler);
577 /* Create an editable tag to indicate uneditable parts of the window
579 gtk_text_buffer_create_tag(textbuffer, "uneditable", "editable", FALSE, "editable-set", TRUE, NULL);
581 /* Mark the position where the user will input text and the end mark */
583 gtk_text_buffer_get_end_iter(textbuffer, &end);
584 gtk_text_buffer_create_mark(textbuffer, "input_position", &end, TRUE);
585 gtk_text_buffer_create_mark(textbuffer, "end_position", &end, FALSE);
587 /* Create the pager position mark; it stands for the last character in the buffer
588 that has been on-screen */
589 GtkTextMark *pager_position = gtk_text_buffer_create_mark(textbuffer, "pager_position", &end, TRUE);
590 gtk_text_mark_set_visible(pager_position, TRUE);
594 case wintype_Graphics:
596 GtkWidget *image = gtk_image_new_from_pixmap(NULL, NULL);
597 gtk_widget_show(image);
600 win->unit_height = 1;
603 win->background_color = 0x00FFFFFF;
605 /* Connect signal handlers */
606 win->button_press_event_handler = g_signal_connect(image, "button-press-event", G_CALLBACK(on_window_button_press), win);
607 g_signal_handler_block(image, win->button_press_event_handler);
608 win->shutdown_keypress_handler = g_signal_connect(image, "key-press-event", G_CALLBACK(on_shutdown_key_press_event), win);
609 g_signal_handler_block(image, win->shutdown_keypress_handler);
610 win->size_allocate_handler = g_signal_connect(image, "size-allocate", G_CALLBACK(on_graphics_size_allocate), win);
616 ILLEGAL_PARAM("Unknown window type: %u", wintype);
618 g_node_destroy(glk_data->root_window);
619 glk_data->root_window = NULL;
623 /* Set the minimum size to "as small as possible" so it doesn't depend on
624 the size of the window contents */
625 gtk_widget_set_size_request(win->widget, 0, 0);
626 gtk_widget_set_size_request(win->frame, 0, 0);
630 /* When splitting, construct a new parent window
631 * copying most characteristics from the window that is being split */
632 winid_t pair = window_new_common(0);
633 pair->type = wintype_Pair;
635 /* The pair window must know about its children's split method */
636 pair->key_window = win;
637 pair->split_method = method;
638 pair->constraint_size = size;
640 /* Insert the new window into the window tree */
641 if(split->window_node->parent == NULL)
642 glk_data->root_window = pair->window_node;
645 if( split->window_node == g_node_first_sibling(split->window_node) )
646 g_node_prepend(split->window_node->parent, pair->window_node);
648 g_node_append(split->window_node->parent, pair->window_node);
649 g_node_unlink(split->window_node);
651 /* Place the windows in the correct order */
652 switch(method & winmethod_DirMask)
655 case winmethod_Above:
656 g_node_append(pair->window_node, win->window_node);
657 g_node_append(pair->window_node, split->window_node);
659 case winmethod_Right:
660 case winmethod_Below:
661 g_node_append(pair->window_node, split->window_node);
662 g_node_append(pair->window_node, win->window_node);
667 /* Set the window as root window */
668 glk_data->root_window = win->window_node;
671 /* Set the window as a child of the Glk widget, don't trigger an arrange event */
672 g_mutex_lock(glk_data->arrange_lock);
673 glk_data->needs_rearrange = TRUE;
674 glk_data->ignore_next_arrange_event = TRUE;
675 g_mutex_unlock(glk_data->arrange_lock);
676 gtk_widget_set_parent(win->frame, GTK_WIDGET(glk_data->self));
677 gtk_widget_queue_resize(GTK_WIDGET(glk_data->self));
679 /* For text grid windows, fill the buffer with blanks. */
680 if(wintype == wintype_TextGrid)
682 /* Create the cursor position mark */
684 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
685 gtk_text_buffer_get_start_iter(buffer, &begin);
686 gtk_text_buffer_create_mark(buffer, "cursor_position", &begin, TRUE);
690 glk_window_clear(win);
694 /* Internal function: if node's key window is closing_win or one of its
695 children, set node's key window to NULL. */
697 remove_key_windows(GNode *node, winid_t closing_win)
699 winid_t win = (winid_t)node->data;
700 if(win->key_window && (win->key_window == closing_win || g_node_is_ancestor(closing_win->window_node, win->key_window->window_node)))
701 win->key_window = NULL;
702 return FALSE; /* Don't stop the traversal */
705 /* Internal function: destroy this window's GTK widgets, window streams,
706 and those of all its children. GDK threads must be locked. */
708 destroy_windows_below(winid_t win, stream_result_t *result)
713 case wintype_TextGrid:
714 case wintype_TextBuffer:
715 case wintype_Graphics:
716 gtk_widget_unparent(win->frame);
720 destroy_windows_below(win->window_node->children->data, NULL);
721 destroy_windows_below(win->window_node->children->next->data, NULL);
725 ILLEGAL_PARAM("Unknown window type: %u", win->type);
728 stream_close_common(win->window_stream, result);
731 /* Internal function: free the winid_t structure of this window and those of all its children */
733 free_winids_below(winid_t win)
735 if(win->type == wintype_Pair) {
736 free_winids_below(win->window_node->children->data);
737 free_winids_below(win->window_node->children->next->data);
739 window_close_common(win, FALSE);
744 * @win: Window to close.
745 * @result: Pointer to a #stream_result_t in which to store the write count.
747 * Closes @win, which is pretty much exactly the opposite of opening a window.
748 * It is legal to close all your windows, or to close the root window (which is
751 * The @result argument is filled with the output character count of the window
752 * stream. See <link linkend="chimara-Streams">Streams</link> and <link
753 * linkend="chimara-Closing-Streams">Closing Streams</link>.
755 * When you close a window (and it is not the root window), the other window
756 * in its pair takes over all the freed-up area. Let's close D, in the current
758 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
759 * <entry><mediaobject><imageobject><imagedata fileref="fig10.png"/>
760 * </imageobject></mediaobject></entry>
761 * <entry><mediaobject><textobject><literallayout class="monospaced">
767 * </literallayout></textobject></mediaobject></entry>
768 * </row></tbody></tgroup></informaltable>
770 * Notice what has happened. D is gone. O3 is gone, and its 50-50 left-right
771 * split has gone with it. The other size constraints are unchanged; O2 is
772 * still committed to giving its upper child two rows, as measured in the font
773 * of O2's key window, which is C. Conveniently, O2's upper child is C, just as
774 * it was before we created D. In fact, now that D is gone, everything is back
775 * to the way it was before we created D.
777 * But what if we had closed C instead of D? We would have gotten this:
778 * <informaltable frame="none"><tgroup cols="2"><tbody><row>
779 * <entry><mediaobject><imageobject><imagedata fileref="fig11.png"/>
780 * </imageobject></mediaobject></entry>
781 * <entry><mediaobject><textobject><literallayout class="monospaced">
787 * </literallayout></textobject></mediaobject></entry>
788 * </row></tbody></tgroup></informaltable>
790 * Again, O3 is gone. But D has collapsed to zero height. This is because its
791 * height is controlled by O2, and O2's key window was C, and C is now gone. O2
792 * no longer has a key window at all, so it cannot compute a height for its
793 * upper child, so it defaults to zero.
796 * This may seem to be an inconvenient choice. That is deliberate. You should
797 * not leave a pair window with no key, and the zero-height default reminds
798 * you not to. You can use glk_window_set_arrangement() to set a new split
799 * measurement and key window. See <link
800 * linkend="chimara-Changing-Window-Constraints">Changing Window
801 * Constraints</link>.
805 glk_window_close(winid_t win, stream_result_t *result)
807 VALID_WINDOW(win, return);
809 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
811 gdk_threads_enter(); /* Prevent redraw while we're trashing the window */
813 /* If any pair windows have this window or its children as a key window,
814 set their key window to NULL */
815 g_node_traverse(glk_data->root_window, G_IN_ORDER, G_TRAVERSE_NON_LEAVES, -1, (GNodeTraverseFunc)remove_key_windows, win);
817 /* Close all the window streams and destroy the widgets of this window
818 and below, before trashing the window tree */
819 destroy_windows_below(win, result);
821 /* Then free the winid_t structures below this node, but not this one itself */
822 if(win->type == wintype_Pair) {
823 free_winids_below(win->window_node->children->data);
824 free_winids_below(win->window_node->children->next->data);
826 /* So now we should be left with a skeleton tree hanging off this node */
828 /* Parent window changes from a split window into the sibling window */
829 /* The parent of any window is either a pair window or NULL */
830 GNode *pair_node = win->window_node->parent;
831 /* If win was not the root window: */
832 if(pair_node != NULL)
834 gboolean new_child_on_left = ( pair_node == g_node_first_sibling(pair_node) );
836 /* Lookup our sibling */
837 GNode *sibling_node = pair_node->children;
838 if(sibling_node == win->window_node)
839 sibling_node = sibling_node->next;
841 GNode *new_parent_node = pair_node->parent;
842 g_node_unlink(pair_node);
843 g_node_unlink(sibling_node);
844 /* pair_node and sibling_node should now be totally unconnected to the tree */
846 if(new_parent_node == NULL)
848 glk_data->root_window = sibling_node;
852 if(new_child_on_left)
853 g_node_prepend(new_parent_node, sibling_node);
855 g_node_append(new_parent_node, sibling_node);
858 stream_close_common( ((winid_t) pair_node->data)->window_stream, NULL );
859 window_close_common( (winid_t) pair_node->data, TRUE);
861 else /* it was the root window */
863 glk_data->root_window = NULL;
866 window_close_common(win, FALSE);
868 /* Schedule a redraw */
869 g_mutex_lock(glk_data->arrange_lock);
870 glk_data->needs_rearrange = TRUE;
871 glk_data->ignore_next_arrange_event = TRUE;
872 g_mutex_unlock(glk_data->arrange_lock);
873 gtk_widget_queue_resize( GTK_WIDGET(glk_data->self) );
881 * Erases @win. The meaning of this depends on the window type.
884 * <term>Text buffer</term>
886 * This may do any number of things, such as delete all text in the window, or
887 * print enough blank lines to scroll all text beyond visibility, or insert a
888 * page-break marker which is treated specially by the display part of the
893 * <term>Text grid</term>
895 * This will clear the window, filling all positions with blanks. The window
896 * cursor is moved to the top left corner (position 0,0).
900 * <term>Graphics</term>
902 * Clears the entire window to its current background color. See <link
903 * linkend="chimara-The-Types-of-Windows#wintype-Graphics">Graphics
908 * <term>Other window types</term>
909 * <listitem><para>No effect.</para></listitem>
913 * It is illegal to erase a window which has line input pending.
916 glk_window_clear(winid_t win)
918 VALID_WINDOW(win, return);
919 g_return_if_fail(win->input_request_type != INPUT_REQUEST_LINE && win->input_request_type != INPUT_REQUEST_LINE_UNICODE);
921 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
930 case wintype_TextGrid:
931 /* fill the buffer with blanks */
933 /* Wait for the window's size to be updated */
934 g_mutex_lock(glk_data->arrange_lock);
935 if(glk_data->needs_rearrange)
936 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
937 g_mutex_unlock(glk_data->arrange_lock);
941 /* Manually put newlines at the end of each row of characters in the buffer; manual newlines make resizing the window's grid easier. */
942 gchar *blanks = g_strnfill(win->width, ' ');
943 gchar **blanklines = g_new0(gchar *, win->height + 1);
945 for(count = 0; count < win->height; count++)
946 blanklines[count] = blanks;
947 blanklines[win->height] = NULL;
948 gchar *text = g_strjoinv("\n", blanklines);
949 g_free(blanklines); /* not g_strfreev() */
952 GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
953 gtk_text_buffer_set_text(textbuffer, text, -1);
957 gtk_text_buffer_get_start_iter(textbuffer, &begin);
958 gtk_text_buffer_move_mark_by_name(textbuffer, "cursor_position", &begin);
964 case wintype_TextBuffer:
965 /* delete all text in the window */
969 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
970 GtkTextIter start, end;
971 gtk_text_buffer_get_bounds(buffer, &start, &end);
972 gtk_text_buffer_delete(buffer, &start, &end);
978 case wintype_Graphics:
980 /* Wait for the window's size to be updated */
981 g_mutex_lock(glk_data->arrange_lock);
982 if(glk_data->needs_rearrange)
983 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
984 g_mutex_unlock(glk_data->arrange_lock);
986 glk_window_erase_rect(win, 0, 0, win->widget->allocation.width, win->widget->allocation.height);
991 ILLEGAL_PARAM("Unknown window type: %d", win->type);
997 * @win: A window, or %NULL.
999 * Sets the current stream to @win's window stream. It is exactly equivalent to
1000 * |[ glk_stream_set_current(glk_window_get_stream(win)) ]|
1001 * See <link linkend="chimara-Streams">Streams</link>.
1003 * <note><title>Chimara</title>
1005 * Although this is not mentioned in the specification, @win may also be
1006 * %NULL, in which case the current stream is also set to %NULL.
1010 glk_set_window(winid_t win)
1012 VALID_WINDOW_OR_NULL(win, return);
1014 glk_stream_set_current( glk_window_get_stream(win) );
1016 glk_stream_set_current(NULL);
1020 * glk_window_get_stream:
1023 * Returns the stream which is associated with @win. (See <link
1024 * linkend="chimara-Window-Streams">Window Streams</link>.) Every window has a
1025 * stream which can be printed to, but this may not be useful, depending on the
1029 * For example, printing to a blank window's stream has no effect.
1032 * Returns: A window stream.
1034 strid_t glk_window_get_stream(winid_t win)
1036 VALID_WINDOW(win, return NULL);
1037 return win->window_stream;
1041 * glk_window_set_echo_stream:
1043 * @str: A stream to attach to the window, or %NULL.
1045 * Sets @win's echo stream to @str, which can be any valid output stream. You
1046 * can reset a window to stop echoing by calling
1047 * <code>#glk_window_set_echo_stream(@win, %NULL)</code>.
1049 * It is illegal to set a window's echo stream to be its
1050 * <emphasis>own</emphasis> window stream. That would create an infinite loop,
1051 * and is nearly certain to crash the Glk library. It is similarly illegal to
1052 * create a longer loop (two or more windows echoing to each other.)
1055 glk_window_set_echo_stream(winid_t win, strid_t str)
1057 VALID_WINDOW(win, return);
1058 VALID_STREAM_OR_NULL(str, return);
1060 /* Test for an infinite loop */
1062 for(; next && next->type == STREAM_TYPE_WINDOW; next = next->window->echo_stream)
1064 if(next == win->window_stream)
1066 ILLEGAL("Infinite loop detected");
1067 win->echo_stream = NULL;
1072 win->echo_stream = str;
1076 * glk_window_get_echo_stream:
1079 * Returns the echo stream of window @win. Initially, a window has no echo
1080 * stream, so <code>#glk_window_get_echo_stream(@win)</code> will return %NULL.
1082 * Returns: A stream, or %NULL.
1085 glk_window_get_echo_stream(winid_t win)
1087 VALID_WINDOW(win, return NULL);
1088 return win->echo_stream;
1092 * glk_window_get_size:
1094 * @widthptr: Pointer to a location to store the window's width, or %NULL.
1095 * @heightptr: Pointer to a location to store the window's height, or %NULL.
1097 * Simply returns the actual size of the window, in its measurement system.
1098 * As described in <link linkend="chimara-Other-API-Conventions">Other API
1099 * Conventions</link>, either @widthptr or @heightptr can be %NULL, if you
1100 * only want one measurement.
1102 * <note><para>Or, in fact, both, if you want to waste time.</para></note>
1105 glk_window_get_size(winid_t win, glui32 *widthptr, glui32 *heightptr)
1107 VALID_WINDOW(win, return);
1109 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
1115 if(widthptr != NULL)
1117 if(heightptr != NULL)
1121 case wintype_TextGrid:
1122 /* Wait until the window's size is current */
1123 g_mutex_lock(glk_data->arrange_lock);
1124 if(glk_data->needs_rearrange)
1125 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
1126 g_mutex_unlock(glk_data->arrange_lock);
1128 gdk_threads_enter();
1129 /* Cache the width and height */
1130 win->width = (glui32)(win->widget->allocation.width / win->unit_width);
1131 win->height = (glui32)(win->widget->allocation.height / win->unit_height);
1132 gdk_threads_leave();
1134 if(widthptr != NULL)
1135 *widthptr = win->width;
1136 if(heightptr != NULL)
1137 *heightptr = win->height;
1140 case wintype_TextBuffer:
1141 /* Wait until the window's size is current */
1142 g_mutex_lock(glk_data->arrange_lock);
1143 if(glk_data->needs_rearrange)
1144 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
1145 g_mutex_unlock(glk_data->arrange_lock);
1147 gdk_threads_enter();
1148 if(widthptr != NULL)
1149 *widthptr = (glui32)(win->widget->allocation.width / win->unit_width);
1150 if(heightptr != NULL)
1151 *heightptr = (glui32)(win->widget->allocation.height / win->unit_height);
1152 gdk_threads_leave();
1156 case wintype_Graphics:
1157 g_mutex_lock(glk_data->arrange_lock);
1158 if(glk_data->needs_rearrange)
1159 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
1160 g_mutex_unlock(glk_data->arrange_lock);
1162 gdk_threads_enter();
1163 if(widthptr != NULL)
1164 *widthptr = (glui32)(win->widget->allocation.width);
1165 if(heightptr != NULL)
1166 *heightptr = (glui32)(win->widget->allocation.height);
1167 gdk_threads_leave();
1172 ILLEGAL_PARAM("Unknown window type: %u", win->type);
1177 * glk_window_set_arrangement:
1178 * @win: a pair window to rearrange.
1179 * @method: new method of size computation. One of %winmethod_Above,
1180 * %winmethod_Below, %winmethod_Left, or %winmethod_Right OR'ed with
1181 * %winmethod_Fixed or %winmethod_Proportional.
1182 * @size: new size constraint, in percentage points if @method is
1183 * %winmethod_Proportional, otherwise in characters if @win's type is
1184 * %wintype_TextBuffer or %wintype_TextGrid, or pixels if @win's type is
1185 * %wintype_Graphics.
1186 * @keywin: new key window, or %NULL to leave the key window unchanged.
1188 * Changes the size of an existing split — that is, it changes the
1189 * constraint of a given pair window.
1191 * Consider the example above, where D has collapsed to zero height. Say D was a
1192 * text buffer window. You could make a more useful layout by doing
1195 * o2 = glk_window_get_parent(d);
1196 * glk_window_set_arrangement(o2, winmethod_Above | winmethod_Fixed, 3, d);
1198 * That would set D (the upper child of O2) to be O2's key window, and give it a
1199 * fixed size of 3 rows.
1201 * If you later wanted to expand D, you could do
1202 * |[ glk_window_set_arrangement(o2, winmethod_Above | winmethod_Fixed, 5, NULL); ]|
1203 * That expands D to five rows. Note that, since O2's key window is already set
1204 * to D, it is not necessary to provide the @keywin argument; you can pass %NULL
1205 * to mean <quote>leave the key window unchanged.</quote>
1207 * If you do change the key window of a pair window, the new key window
1208 * <emphasis>must</emphasis> be a descendant of that pair window. In the current
1209 * example, you could change O2's key window to be A, but not B. The key window
1210 * also cannot be a pair window itself.
1212 * |[ glk_window_set_arrangement(o2, winmethod_Below | winmethod_Fixed, 3, NULL); ]|
1213 * This changes the constraint to be on the <emphasis>lower</emphasis> child of
1214 * O2, which is A. The key window is still D; so A would then be three rows high
1215 * as measured in D's font, and D would get the rest of O2's space. That may not
1216 * be what you want. To set A to be three rows high as measured in A's font, you
1218 * |[ glk_window_set_arrangement(o2, winmethod_Below | winmethod_Fixed, 3, a); ]|
1220 * Or you could change O2 to a proportional split:
1221 * |[ glk_window_set_arrangement(o2, winmethod_Below | winmethod_Proportional, 30, NULL); ]|
1223 * |[ glk_window_set_arrangement(o2, winmethod_Above | winmethod_Proportional, 70, NULL); ]|
1224 * These do exactly the same thing, since 30% above is the same as
1225 * 70% below. You don't need to specify a key window with a proportional
1226 * split, so the @keywin argument is %NULL. (You could actually specify either A
1227 * or D as the key window, but it wouldn't affect the result.)
1229 * Whatever constraint you set, glk_window_get_size() will tell you the actual
1230 * window size you got.
1232 * Note that you can resize windows, but you can't flip or rotate them. You
1233 * can't move A above D, or change O2 to a vertical split where A is left or
1236 * To get this effect you could close one of the windows, and re-split the
1237 * other one with glk_window_open().
1241 glk_window_set_arrangement(winid_t win, glui32 method, glui32 size, winid_t keywin)
1243 VALID_WINDOW(win, return);
1244 VALID_WINDOW_OR_NULL(keywin, return);
1245 g_return_if_fail(win->type == wintype_Pair);
1248 g_return_if_fail(keywin->type != wintype_Pair);
1249 g_return_if_fail(g_node_is_ancestor(win->window_node, keywin->window_node));
1251 g_return_if_fail(method == (method & (winmethod_DirMask | winmethod_DivisionMask)));
1252 g_return_if_fail(!(((method & winmethod_DivisionMask) == winmethod_Proportional) && size > 100));
1254 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
1256 win->split_method = method;
1257 win->constraint_size = size;
1259 win->key_window = keywin;
1261 /* Tell GTK to rearrange the windows */
1262 gdk_threads_enter();
1263 g_mutex_lock(glk_data->arrange_lock);
1264 glk_data->needs_rearrange = TRUE;
1265 glk_data->ignore_next_arrange_event = TRUE;
1266 g_mutex_unlock(glk_data->arrange_lock);
1267 gtk_widget_queue_resize(GTK_WIDGET(glk_data->self));
1268 gdk_threads_leave();
1272 * glk_window_get_arrangement:
1273 * @win: a pair window.
1274 * @methodptr: return location for the constraint flags of @win, or %NULL.
1275 * @sizeptr: return location for the constraint size of @win, or %NULL.
1276 * @keywinptr: return location for the key window of @win, or %NULL.
1278 * Queries the constraint of a given pair window.
1281 glk_window_get_arrangement(winid_t win, glui32 *methodptr, glui32 *sizeptr, winid_t *keywinptr)
1283 VALID_WINDOW(win, return);
1284 g_return_if_fail(win->type == wintype_Pair);
1287 *methodptr = win->split_method;
1289 *sizeptr = win->constraint_size;
1291 *keywinptr = win->key_window;
1295 * glk_window_move_cursor:
1296 * @win: A text grid window.
1297 * @xpos: Horizontal cursor position.
1298 * @ypos: Vertical cursor position.
1300 * Sets the cursor position. If you move the cursor right past the end of a
1301 * line, it wraps; the next character which is printed will appear at the
1302 * beginning of the next line.
1304 * If you move the cursor below the last line, or when the cursor reaches the
1305 * end of the last line, it goes <quote>off the screen</quote> and further
1306 * output has no effect. You must call glk_window_move_cursor() or
1307 * glk_window_clear() to move the cursor back into the visible region.
1310 * Note that the arguments of glk_window_move_cursor() are <type>unsigned
1311 * int</type>s. This is okay, since there are no negative positions. If you try
1312 * to pass a negative value, Glk will interpret it as a huge positive value,
1313 * and it will wrap or go off the last line.
1317 * Also note that the output cursor is not necessarily visible. In particular,
1318 * when you are requesting line or character input in a grid window, you cannot
1319 * rely on the cursor position to prompt the player where input is indicated.
1320 * You should print some character prompt at that spot — a
1321 * <quote>></quote> character, for example.
1325 glk_window_move_cursor(winid_t win, glui32 xpos, glui32 ypos)
1327 VALID_WINDOW(win, return);
1328 g_return_if_fail(win->type == wintype_TextGrid);
1330 flush_window_buffer(win);
1332 ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
1334 /* Wait until the window's size is current */
1335 g_mutex_lock(glk_data->arrange_lock);
1336 if(glk_data->needs_rearrange)
1337 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
1338 g_mutex_unlock(glk_data->arrange_lock);
1340 /* Don't do anything if the window is shrunk down to nothing */
1341 if(win->width == 0 || win->height == 0)
1344 /* Calculate actual position if cursor is moved past the right edge */
1345 if(xpos >= win->width)
1347 ypos += xpos / win->width;
1351 /* Go to the end if the cursor is moved off the bottom edge */
1352 if(ypos >= win->height)
1354 xpos = win->width - 1;
1355 ypos = win->height - 1;
1358 gdk_threads_enter();
1360 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
1362 /* There must actually be a character at xpos, or the following function will choke */
1363 gtk_text_buffer_get_iter_at_line_offset(buffer, &newpos, ypos, xpos);
1364 gtk_text_buffer_move_mark_by_name(buffer, "cursor_position", &newpos);
1366 gdk_threads_leave();