Implement unicode normalization
[projects/chimara/chimara.git] / libchimara / window.c
1 #include <glib.h>
2 #include "window.h"
3 #include "magic.h"
4 #include "chimara-glk-private.h"
5 #include "gi_dispa.h"
6 #include "pager.h"
7
8 extern GPrivate *glk_data_key;
9
10 static winid_t
11 window_new_common(glui32 rock)
12 {
13         ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
14         winid_t win = g_new0(struct glk_window_struct, 1);
15         
16         win->magic = MAGIC_WINDOW;
17         win->rock = rock;
18         if(glk_data->register_obj)
19                 win->disprock = (*glk_data->register_obj)(win, gidisp_Class_Window);
20         
21         win->window_node = g_node_new(win);
22         
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";
30
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;
35         win->history = NULL;
36
37         /* Initialise the buffer */
38         win->buffer = g_string_sized_new(1024);
39
40         /* Initialise hyperlink table */
41         win->hyperlinks = g_hash_table_new_full(g_int_hash, g_int_equal, g_free, g_free);
42         
43         return win;
44 }
45
46 /* Internal function: do all the stuff necessary to close a window. Call only
47  from Glk thread. */
48 static void
49 window_close_common(winid_t win, gboolean destroy_node)
50 {
51         ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
52
53         if(glk_data->unregister_obj) 
54         {
55         (*glk_data->unregister_obj)(win, gidisp_Class_Window, win->disprock);
56         win->disprock.ptr = NULL;
57     }
58         
59         if(destroy_node)
60                 g_node_destroy(win->window_node);
61         
62         win->magic = MAGIC_FREE;
63         
64         g_list_foreach(win->history, (GFunc)g_free, NULL);
65         g_list_free(win->history);
66         
67         g_string_free(win->buffer, TRUE);
68         g_hash_table_destroy(win->hyperlinks);
69         g_free(win->current_hyperlink);
70
71         if(win->pager_layout)
72                 g_object_unref(win->pager_layout);
73
74         g_free(win);
75 }
76
77 /**
78  * glk_window_iterate:
79  * @win: A window, or %NULL.
80  * @rockptr: Return location for the next window's rock, or %NULL.
81  *
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
85  * Objects</link>.
86  *
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
89  * last.
90  *
91  * Returns: the next window, or %NULL if there are no more.
92  */
93 winid_t
94 glk_window_iterate(winid_t win, glui32 *rockptr)
95 {
96         VALID_WINDOW_OR_NULL(win, return NULL);
97         
98         ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
99         GNode *retnode;
100         
101         if(win == NULL)
102                 retnode = glk_data->root_window;
103         else
104         {
105                 GNode *node = win->window_node;
106                 if( G_NODE_IS_LEAF(node) )
107                 {
108                         while(node && node->next == NULL)
109                                 node = node->parent;
110                         if(node)
111                                 retnode = node->next;
112                         else
113                                 retnode = NULL;
114                 }
115                 else
116                         retnode = g_node_first_child(node);
117         }
118         winid_t retval = retnode? (winid_t)retnode->data : NULL;
119                 
120         /* Store the window's rock in rockptr */
121         if(retval && rockptr)
122                 *rockptr = glk_window_get_rock(retval);
123                 
124         return retval;
125 }
126
127 /**
128  * glk_window_get_rock:
129  * @win: A window.
130  * 
131  * Returns @win's rock value. Pair windows always have rock 0; all other windows
132  * return whatever rock value you created them with.
133  *
134  * Returns: A rock value.
135  */
136 glui32
137 glk_window_get_rock(winid_t win)
138 {
139         VALID_WINDOW(win, return 0);
140         return win->rock;
141 }
142
143 /**
144  * glk_window_get_type:
145  * @win: A window.
146  *
147  * Returns @win's type, one of %wintype_Blank, %wintype_Pair,
148  * %wintype_TextBuffer, %wintype_TextGrid, or %wintype_Graphics.
149  *
150  * Returns: The window's type.
151  */
152 glui32
153 glk_window_get_type(winid_t win)
154 {
155         VALID_WINDOW(win, return 0);
156         return win->type;
157 }
158
159 /**
160  * glk_window_get_parent:
161  * @win: A window.
162  *
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
166  * childless.
167  *
168  * Returns: A window, or %NULL.
169  */
170 winid_t
171 glk_window_get_parent(winid_t win)
172 {
173         VALID_WINDOW(win, return NULL);
174
175         /* Value will also be NULL if win is the root window */
176         if(win->window_node->parent == NULL)
177                 return NULL;
178
179         return (winid_t)win->window_node->parent->data;
180 }
181
182 /**
183  * glk_window_get_sibling:
184  * @win: A window.
185  *
186  * Returns the other child of @win's parent. If @win is the root window, this
187  * returns %NULL.
188  *
189  * Returns: A window, or %NULL.
190  */
191 winid_t
192 glk_window_get_sibling(winid_t win)
193 {
194         VALID_WINDOW(win, return NULL);
195         
196         if(G_NODE_IS_ROOT(win->window_node))
197                 return NULL;
198         if(win->window_node->next)
199                 return (winid_t)win->window_node->next;
200         return (winid_t)win->window_node->prev;
201 }
202
203 /**
204  * glk_window_get_root:
205  * 
206  * Returns the root window. If there are no windows, this returns %NULL.
207  *
208  * Returns: A window, or %NULL.
209  */
210 winid_t
211 glk_window_get_root()
212 {
213         ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
214         if(glk_data->root_window == NULL)
215                 return NULL;
216         return (winid_t)glk_data->root_window->data;
217 }
218
219 /**
220  * glk_window_open:
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. May also be OR'ed with
227  * %winmethod_Border or %winmethod_NoBorder.
228  * @size: Size of the new window, in percentage points if @method is
229  * %winmethod_Proportional, otherwise in characters if @wintype is 
230  * %wintype_TextBuffer or %wintype_TextGrid, or pixels if @wintype is
231  * %wintype_Graphics.
232  * @wintype: Type of the new window. One of %wintype_Blank, %wintype_TextGrid,
233  * %wintype_TextBuffer, or %wintype_Graphics.
234  * @rock: The new window's rock value.
235  *
236  * Creates a new window. If there are no windows, the first three arguments are
237  * meaningless. @split <emphasis>must</emphasis> be 0, and @method and @size
238  * are ignored. @wintype is the type of window you're creating, and @rock is
239  * the rock (see <link linkend="chimara-Rocks">Rocks</link>).
240  *
241  * If any windows exist, new windows must be created by splitting existing
242  * ones. @split is the window you want to split; this <emphasis>must 
243  * not</emphasis> be zero. @method specifies the direction and the split method
244  * (see below). @size is the size of the split. @wintype is the type of window
245  * you're creating, and @rock is the rock.
246  *
247  * The method argument must be the logical-or of a direction constant
248  * (%winmethod_Above, %winmethod_Below, %winmethod_Left, %winmethod_Right) and a
249  * split-method constant (%winmethod_Fixed, %winmethod_Proportional).
250  *
251  * Remember that it is possible that the library will be unable to create a new
252  * window, in which case glk_window_open() will return %NULL.
253  * 
254  * <note><para>
255  *   It is acceptable to gracefully exit, if the window you are creating is an
256  *   important one &mdash; such as your first window. But you should not try to
257  *   perform any window operation on the id until you have tested to make sure
258  *   it is non-zero.
259  * </para></note>
260  * 
261  * The examples we've seen so far have the simplest kind of size control. (Yes,
262  * this is <quote>below</quote>.) Every pair is a percentage split, with 
263  * <inlineequation>
264  *   <alt>X</alt>
265  *   <mathphrase>X</mathphrase>
266  * </inlineequation>
267  * percent going to one side, and 
268  * <inlineequation>
269  *   <alt>(100-X)</alt>
270  *   <mathphrase>(100 - X)</mathphrase>
271  * </inlineequation> 
272  * percent going to the other side. If the player resizes the window, the whole
273  * mess expands, contracts, or stretches in a uniform way.
274  * 
275  * As I said above, you can also make fixed-size splits. This is a little more
276  * complicated, because you have to know how this fixed size is measured.
277  * 
278  * Sizes are measured in a way which is different for each window type. For
279  * example, a text grid window is measured by the size of its fixed-width font.
280  * You can make a text grid window which is fixed at a height of four rows, or
281  * ten columns. A text buffer window is measured by the size of its font.
282  * 
283  * <note><para>
284  *   Remember that different windows may use different size fonts. Even two
285  *   text grid windows may use fixed-size fonts of different sizes.
286  * </para></note>
287  *
288  * Graphics windows are measured in pixels, not characters. Blank windows
289  * aren't measured at all; there's no meaningful way to measure them, and
290  * therefore you can't create a blank window of a fixed size, only of a
291  * proportional (percentage) size.
292  * 
293  * So to create a text buffer window which takes the top 40% of the original
294  * window's space, you would execute
295  * |[ newwin = glk_window_open(win, winmethod_Above | winmethod_Proportional, 40, wintype_TextBuffer, 0); ]|
296  *
297  * To create a text grid which is always five lines high, at the bottom of the
298  * original window, you would do
299  * |[ newwin = glk_window_open(win, winmethod_Below | winmethod_Fixed, 5, wintype_TextGrid, 0); ]|
300  * 
301  * Note that the meaning of the @size argument depends on the @method argument.
302  * If the method is %winmethod_Fixed, it also depends on the @wintype argument.
303  * The new window is then called the <quote>key window</quote> of this split,
304  * because its window type determines how the split size is computed.
305  * 
306  * <note><para>
307  *   For %winmethod_Proportional splits, you can still call the new window the
308  *   <quote>key window</quote>. But the key window is not important for
309  *   proportional splits, because the size will always be computed as a simple
310  *   ratio of the available space, not a fixed size of one child window.
311  * </para></note>
312  * 
313  * This system is more or less peachy as long as all the constraints work out.
314  * What happens when there is a conflict? The rules are simple. Size control
315  * always flows down the tree, and the player is at the top. Let's bring out an
316  * example:
317  * <informaltable frame="none"><tgroup cols="2"><tbody><row>
318  * <entry><mediaobject><imageobject><imagedata fileref="fig5-7a.png"/>
319  * </imageobject></mediaobject></entry>
320  * <entry><mediaobject><textobject><literallayout class="monospaced">
321  *      O
322  *     / \
323  *    O   B
324  *   / \
325  *  A   C
326  * </literallayout></textobject></mediaobject></entry>
327  * </row></tbody></tgroup></informaltable>
328  * 
329  * First we split A into A and B, with a 50% proportional split. Then we split
330  * A into A and C, with C above, C being a text grid window, and C gets a fixed
331  * size of two rows (as measured in its own font size). A gets whatever remains
332  * of the 50% it had before.
333  * 
334  * Now the player stretches the window vertically.
335  * <informalfigure><mediaobject><imageobject><imagedata fileref="fig6.png"/>
336  * </imageobject></mediaobject></informalfigure>
337  * 
338  * The library figures: the topmost split, the original A/B split, is 50-50. So
339  * B gets half the screen space, and the pair window next to it (the lower
340  * <quote>O</quote>) gets the other half. Then it looks at the lower 
341  * <quote>O</quote>. C gets two rows; A gets the rest. All done.
342  * 
343  * Then the user maliciously starts squeezing the window down, in stages:
344  * <informaltable xml:id="chimara-Figure-Squeezing-Window" frame="none">
345  * <tgroup cols="5"><tbody><row valign="top">
346  * <entry><mediaobject><imageobject><imagedata fileref="fig5-7a.png"/>
347  * </imageobject></mediaobject></entry>
348  * <entry><mediaobject><imageobject><imagedata fileref="fig7b.png"/>
349  * </imageobject></mediaobject></entry>
350  * <entry><mediaobject><imageobject><imagedata fileref="fig7c.png"/>
351  * </imageobject></mediaobject></entry>
352  * <entry><mediaobject><imageobject><imagedata fileref="fig7d.png"/>
353  * </imageobject></mediaobject></entry>
354  * <entry><mediaobject><imageobject><imagedata fileref="fig7e.png"/>
355  * </imageobject></mediaobject></entry>
356  * </row></tbody></tgroup></informaltable>
357  * 
358  * The logic remains the same. B always gets half the space. At stage 3,
359  * there's no room left for A, so it winds up with zero height. Nothing
360  * displayed in A will be visible. At stage 4, there isn't even room in the
361  * upper 50% to give C its two rows; so it only gets one. Finally, C is
362  * squashed out of existence as well.
363  * 
364  * When a window winds up undersized, it remembers what size it should be. In
365  * the example above, A remembers that it should be two rows; if the user
366  * expands the window to the original size, it would return to the original
367  * layout.
368  * 
369  * The downward flow of control is a bit harsh. After all, in stage 4, there's
370  * room for C to have its two rows if only B would give up some of its 50%. But
371  * this does not happen.
372  * 
373  * <note><para>
374  *   This makes life much easier for the Glk library. To determine the
375  *   configuration of a window, it only needs to look at the window's
376  *   ancestors, never at its descendants. So window layout is a simple
377  *   recursive algorithm, no backtracking.
378  * </para></note>
379  * 
380  * What happens when you split a fixed-size window? The resulting pair window
381  * &mdash; that is, the two new parts together &mdash; retain the same size
382  * constraint as the original window that was split. The key window for the
383  * original split is still the key window for that split, even though it's now
384  * a grandchild instead of a child.
385  * 
386  * The easy, and correct, way to think about this is that the size constraint
387  * is stored by a window's parent, not the window itself; and a constraint
388  * consists of a pointer to a key window plus a size value.
389  * 
390  * <informaltable frame="none"><tgroup cols="6"><tbody><row>
391  * <entry><mediaobject><imageobject><imagedata fileref="fig8a.png"/>
392  * </imageobject></mediaobject></entry>
393  * <entry><mediaobject><textobject><literallayout class="monospaced">
394  *  A   
395  * </literallayout></textobject></mediaobject></entry>
396  * <entry><mediaobject><imageobject><imagedata fileref="fig8b.png"/>
397  * </imageobject></mediaobject></entry>
398  * <entry><mediaobject><textobject><literallayout class="monospaced">
399  *    O1  
400  *   / \  
401  *  A   B 
402  * </literallayout></textobject></mediaobject></entry> 
403  * <entry><mediaobject><imageobject><imagedata fileref="fig8c.png"/>
404  * </imageobject></mediaobject></entry>
405  * <entry><mediaobject><textobject><literallayout class="monospaced">
406  *      O1  
407  *     / \  
408  *    O2  B 
409  *   / \    
410  *  A   C   
411  * </literallayout></textobject></mediaobject></entry> 
412  * </row></tbody></tgroup></informaltable>
413  * After the first split, the new pair window (O1, which covers the whole
414  * screen) knows that its first child (A) is above the second, and gets 50% of
415  * its own area. (A is the key window for this split, but a proportional split
416  * doesn't care about key windows.)
417  * 
418  * After the second split, all this remains true; O1 knows that its first child
419  * gets 50% of its space, and A is O1's key window. But now O1's first child is
420  * O2 instead of A. The newer pair window (O2) knows that its first child (C)
421  * is above the second, and gets a fixed size of two rows. (As measured in C's
422  * font, because C is O2's key window.)
423  * 
424  * If we split C, now, the resulting pair will still be two C-font rows high
425  * &mdash; that is, tall enough for two lines of whatever font C displays. For
426  * the sake of example, we'll do this vertically.
427  * <informaltable frame="none"><tgroup cols="2"><tbody><row>
428  * <entry><mediaobject><imageobject><imagedata fileref="fig9.png"/>
429  * </imageobject></mediaobject></entry>
430  * <entry><mediaobject><textobject><literallayout class="monospaced">
431  *      O1
432  *     / \
433  *    O2  B
434  *   / \
435  *  A   O3
436  *     / \
437  *    C   D
438  * </literallayout></textobject></mediaobject></entry> 
439  * </row></tbody></tgroup></informaltable>
440  * 
441  * O3 now knows that its children have a 50-50 left-right split. O2 is still
442  * committed to giving its upper child, O3, two C-font rows. Again, this is
443  * because C is O2's key window. 
444  *
445  * <note><para>
446  *   This turns out to be a good idea, because it means that C, the text grid
447  *   window, is still two rows high. If O3 had been a upper-lower split, things
448  *   wouldn't work out so neatly. But the rules would still apply. If you don't
449  *   like this, don't do it.
450  * </para></note>
451  *
452  * Returns: the new window, or %NULL on error.
453  */
454 winid_t
455 glk_window_open(winid_t split, glui32 method, glui32 size, glui32 wintype, 
456                 glui32 rock)
457 {
458         VALID_WINDOW_OR_NULL(split, return NULL);
459         g_return_val_if_fail(method == (method & (winmethod_DirMask | winmethod_DivisionMask)), NULL);
460         g_return_val_if_fail(!(((method & winmethod_DivisionMask) == winmethod_Proportional) && size > 100), NULL);     
461
462         ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
463         
464         if(split == NULL && glk_data->root_window != NULL)
465         {
466                 ILLEGAL("Tried to open a new root window, but there is already a root window");
467                 return NULL;
468         }
469         
470         gdk_threads_enter();
471         
472         /* Create the new window */
473         winid_t win = window_new_common(rock);
474         win->type = wintype;
475
476         switch(wintype)
477         {
478                 case wintype_Blank:
479                 {
480                         /* A blank window will be a label without any text */
481                         GtkWidget *label = gtk_label_new("");
482                         gtk_widget_show(label);
483                         
484                         win->widget = label;
485                         win->frame = label;
486                         /* A blank window has no size */
487                         win->unit_width = 0;
488                         win->unit_height = 0;
489                 }
490                         break;
491                 
492                 case wintype_TextGrid:
493                 {
494                     GtkWidget *textview = gtk_text_view_new();
495                         GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(textview) );
496
497                     gtk_text_view_set_wrap_mode( GTK_TEXT_VIEW(textview), GTK_WRAP_NONE );
498                     gtk_text_view_set_editable( GTK_TEXT_VIEW(textview), FALSE );
499                         gtk_widget_show(textview);
500                                 
501                         /* Create the styles available to the window stream */
502                         style_init_textgrid(textbuffer);
503                         gtk_widget_modify_font( textview, get_current_font(wintype) );
504                     
505                     win->widget = textview;
506                     win->frame = textview;
507                         
508                         /* Determine the size of a "0" character in pixels */
509                         PangoLayout *zero = gtk_widget_create_pango_layout(textview, "0");
510                         pango_layout_set_font_description( zero, get_current_font(wintype) );
511                         pango_layout_get_pixel_size(zero, &(win->unit_width), &(win->unit_height));
512                         g_object_unref(zero);
513                         /* width and height are set later */
514                         
515                         /* Connect signal handlers */
516                         win->char_input_keypress_handler = g_signal_connect(textview, "key-press-event", G_CALLBACK(on_char_input_key_press_event), win);
517                         g_signal_handler_block(textview, win->char_input_keypress_handler);
518                         win->line_input_keypress_handler = g_signal_connect(textview, "key-press-event", G_CALLBACK(on_line_input_key_press_event), win);
519                         g_signal_handler_block(textview, win->line_input_keypress_handler);
520                         win->shutdown_keypress_handler = g_signal_connect(textview, "key-press-event", G_CALLBACK(on_shutdown_key_press_event), win);
521                         g_signal_handler_block(textview, win->shutdown_keypress_handler);
522                         win->button_press_event_handler = g_signal_connect( textview, "button-press-event", G_CALLBACK(on_window_button_press), win );
523                         g_signal_handler_block(textview, win->button_press_event_handler);
524                 }
525                     break;
526                 
527                 case wintype_TextBuffer:
528                 {
529                         GtkWidget *scrolledwindow = gtk_scrolled_window_new(NULL, NULL);
530                         GtkWidget *textview = gtk_text_view_new();
531                         GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(textview) );
532
533                         gtk_scrolled_window_set_policy( GTK_SCROLLED_WINDOW(scrolledwindow), GTK_POLICY_NEVER, GTK_POLICY_AUTOMATIC );
534                         
535                         gtk_text_view_set_wrap_mode( GTK_TEXT_VIEW(textview), GTK_WRAP_WORD_CHAR );
536                         gtk_text_view_set_editable( GTK_TEXT_VIEW(textview), FALSE );
537                         gtk_text_view_set_pixels_inside_wrap( GTK_TEXT_VIEW(textview), 3 );
538                         gtk_text_view_set_left_margin( GTK_TEXT_VIEW(textview), 20 );
539                         gtk_text_view_set_right_margin( GTK_TEXT_VIEW(textview), 20 );
540
541                         gtk_container_add( GTK_CONTAINER(scrolledwindow), textview );
542                         gtk_widget_show_all(scrolledwindow);
543
544                         win->widget = textview;
545                         win->frame = scrolledwindow;
546                         
547                         /* Create the styles available to the window stream */
548                         style_init_textbuffer(textbuffer);
549                         style_init_more_prompt(win);
550                         gtk_widget_modify_font( textview, get_current_font(wintype) );
551                         
552                         /* Determine the size of a "0" character in pixels */
553                         PangoLayout *zero = gtk_widget_create_pango_layout(textview, "0");
554                         pango_layout_set_font_description( zero, get_current_font(wintype) );
555                         pango_layout_get_pixel_size(zero, &(win->unit_width), &(win->unit_height));
556                         g_object_unref(zero);
557
558                         /* Connect signal handlers */
559                         
560                         /* Pager */
561                         g_signal_connect_after( textview, "size-request", G_CALLBACK(pager_after_size_request), win );
562                         win->pager_expose_handler = g_signal_connect_after( textview, "expose-event", G_CALLBACK(pager_on_expose), win );
563                         g_signal_handler_block(textview, win->pager_expose_handler);
564                         win->pager_keypress_handler = g_signal_connect( textview, "key-press-event", G_CALLBACK(pager_on_key_press_event), win );
565                         g_signal_handler_block(textview, win->pager_keypress_handler);
566                         GtkAdjustment *adj = gtk_scrolled_window_get_vadjustment(GTK_SCROLLED_WINDOW(scrolledwindow));
567                         win->pager_adjustment_handler = g_signal_connect_after(adj, "value-changed", G_CALLBACK(pager_after_adjustment_changed), win);
568
569                         /* Char and line input */
570                         win->char_input_keypress_handler = g_signal_connect( textview, "key-press-event", G_CALLBACK(on_char_input_key_press_event), win );
571                         g_signal_handler_block(textview, win->char_input_keypress_handler);
572                         win->line_input_keypress_handler = g_signal_connect( textview, "key-press-event", G_CALLBACK(on_line_input_key_press_event), win );
573                         g_signal_handler_block(textview, win->line_input_keypress_handler);
574                         win->insert_text_handler = g_signal_connect_after( textbuffer, "insert-text", G_CALLBACK(after_window_insert_text), win );
575                         g_signal_handler_block(textbuffer, win->insert_text_handler);
576
577                         /* Shutdown key press */
578                         win->shutdown_keypress_handler = g_signal_connect( textview, "key-press-event", G_CALLBACK(on_shutdown_key_press_event), win );
579                         g_signal_handler_block(textview, win->shutdown_keypress_handler);                       
580
581                         /* Create an editable tag to indicate uneditable parts of the window
582                         (for line input) */
583                         gtk_text_buffer_create_tag(textbuffer, "uneditable", "editable", FALSE, "editable-set", TRUE, NULL);
584
585                         /* Mark the position where the user will input text and the end mark */
586                         GtkTextIter end;
587                         gtk_text_buffer_get_end_iter(textbuffer, &end);
588                         gtk_text_buffer_create_mark(textbuffer, "input_position", &end, TRUE);
589                         gtk_text_buffer_create_mark(textbuffer, "end_position", &end, FALSE);
590
591                         /* Create the pager position mark; it stands for the last character in the buffer
592                          that has been on-screen */
593                         gtk_text_buffer_create_mark(textbuffer, "pager_position", &end, TRUE);
594                 }
595                         break;
596
597                 case wintype_Graphics:
598                 {
599                     GtkWidget *image = gtk_image_new_from_pixmap(NULL, NULL);
600                         gtk_widget_show(image);
601
602                         win->unit_width = 1;
603                         win->unit_height = 1;
604                     win->widget = image;
605                     win->frame = image;
606                         win->background_color = 0x00FFFFFF;
607                                 
608                         /* Connect signal handlers */
609                         win->button_press_event_handler = g_signal_connect(image, "button-press-event", G_CALLBACK(on_window_button_press), win);
610                         g_signal_handler_block(image, win->button_press_event_handler);
611                         win->shutdown_keypress_handler = g_signal_connect(image, "key-press-event", G_CALLBACK(on_shutdown_key_press_event), win);
612                         g_signal_handler_block(image, win->shutdown_keypress_handler);                  
613                         win->size_allocate_handler = g_signal_connect(image, "size-allocate", G_CALLBACK(on_graphics_size_allocate), win);
614                 }
615                     break;
616                         
617                 default:
618                         gdk_threads_leave();
619                         ILLEGAL_PARAM("Unknown window type: %u", wintype);
620                         g_free(win);
621                         g_node_destroy(glk_data->root_window);
622                         glk_data->root_window = NULL;
623                         return NULL;
624         }
625
626         /* Set the minimum size to "as small as possible" so it doesn't depend on
627          the size of the window contents */
628         gtk_widget_set_size_request(win->widget, 0, 0);
629         gtk_widget_set_size_request(win->frame, 0, 0);
630         
631         if(split)
632         {
633                 /* When splitting, construct a new parent window
634                  * copying most characteristics from the window that is being split */
635                 winid_t pair = window_new_common(0);
636                 pair->type = wintype_Pair;
637
638                 /* The pair window must know about its children's split method */
639                 pair->key_window = win;
640                 pair->split_method = method;
641                 pair->constraint_size = size;
642                 
643                 /* Insert the new window into the window tree */
644                 if(split->window_node->parent == NULL)
645                         glk_data->root_window = pair->window_node;
646                 else 
647                 {
648                         if( split->window_node == g_node_first_sibling(split->window_node) )
649                                 g_node_prepend(split->window_node->parent, pair->window_node);
650                         else
651                                 g_node_append(split->window_node->parent, pair->window_node);
652                         g_node_unlink(split->window_node);
653                 }
654                 /* Place the windows in the correct order */
655                 switch(method & winmethod_DirMask)
656                 {
657                         case winmethod_Left:
658                         case winmethod_Above:
659                                 g_node_append(pair->window_node, win->window_node);
660                                 g_node_append(pair->window_node, split->window_node);
661                                 break;
662                         case winmethod_Right:
663                         case winmethod_Below:
664                                 g_node_append(pair->window_node, split->window_node);
665                                 g_node_append(pair->window_node, win->window_node);
666                                 break;
667                 }
668
669         } else {
670                 /* Set the window as root window */
671                 glk_data->root_window = win->window_node;
672         }
673
674         /* Set the window as a child of the Glk widget, don't trigger an arrange event */
675         g_mutex_lock(glk_data->arrange_lock);
676         glk_data->needs_rearrange = TRUE;
677         glk_data->ignore_next_arrange_event = TRUE;
678         g_mutex_unlock(glk_data->arrange_lock);
679         gtk_widget_set_parent(win->frame, GTK_WIDGET(glk_data->self));
680         gtk_widget_queue_resize(GTK_WIDGET(glk_data->self));
681         
682     /* For text grid windows, fill the buffer with blanks. */
683     if(wintype == wintype_TextGrid)
684     {
685         /* Create the cursor position mark */
686         GtkTextIter begin;
687         GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
688         gtk_text_buffer_get_start_iter(buffer, &begin);
689         gtk_text_buffer_create_mark(buffer, "cursor_position", &begin, TRUE);
690         }
691
692         gdk_threads_leave();
693     glk_window_clear(win);
694         return win;
695 }
696
697 /* Internal function: if node's key window is closing_win or one of its
698  children, set node's key window to NULL. */
699 static gboolean 
700 remove_key_windows(GNode *node, winid_t closing_win)
701 {
702         winid_t win = (winid_t)node->data;
703         if(win->key_window && (win->key_window == closing_win || g_node_is_ancestor(closing_win->window_node, win->key_window->window_node)))
704                 win->key_window = NULL;
705         return FALSE; /* Don't stop the traversal */
706 }
707
708 /* Internal function: destroy this window's GTK widgets, window streams, 
709  and those of all its children. GDK threads must be locked. */
710 static void
711 destroy_windows_below(winid_t win, stream_result_t *result)
712 {
713         switch(win->type)
714         {
715                 case wintype_Blank:
716             case wintype_TextGrid:
717                 case wintype_TextBuffer:
718                 case wintype_Graphics:
719                         gtk_widget_unparent(win->frame);
720                         break;
721
722                 case wintype_Pair:
723                         destroy_windows_below(win->window_node->children->data, NULL);
724                         destroy_windows_below(win->window_node->children->next->data, NULL);
725                         break;
726
727                 default:
728                         ILLEGAL_PARAM("Unknown window type: %u", win->type);
729                         return;
730         }
731         stream_close_common(win->window_stream, result);
732 }
733
734 /* Internal function: free the winid_t structure of this window and those of all its children */
735 static void
736 free_winids_below(winid_t win)
737 {
738         if(win->type == wintype_Pair) {
739                 free_winids_below(win->window_node->children->data);
740                 free_winids_below(win->window_node->children->next->data);
741         }
742         window_close_common(win, FALSE);
743 }
744
745 /**
746  * glk_window_close:
747  * @win: Window to close.
748  * @result: Pointer to a #stream_result_t in which to store the write count.
749  *
750  * Closes @win, which is pretty much exactly the opposite of opening a window.
751  * It is legal to close all your windows, or to close the root window (which is
752  * the same thing.) 
753  *
754  * The @result argument is filled with the output character count of the window
755  * stream. See <link linkend="chimara-Streams">Streams</link> and <link
756  * linkend="chimara-Closing-Streams">Closing Streams</link>.
757  * 
758  * When you close a window (and it is not the root window), the other window
759  * in its pair takes over all the freed-up area. Let's close D, in the current
760  * example:
761  * <informaltable frame="none"><tgroup cols="2"><tbody><row>
762  * <entry><mediaobject><imageobject><imagedata fileref="fig10.png"/>
763  * </imageobject></mediaobject></entry>
764  * <entry><mediaobject><textobject><literallayout class="monospaced">
765  *      O1
766  *     / \
767  *    O2  B
768  *   / \
769  *  A   C
770  * </literallayout></textobject></mediaobject></entry> 
771  * </row></tbody></tgroup></informaltable>
772  * 
773  * Notice what has happened. D is gone. O3 is gone, and its 50-50 left-right
774  * split has gone with it. The other size constraints are unchanged; O2 is
775  * still committed to giving its upper child two rows, as measured in the font
776  * of O2's key window, which is C. Conveniently, O2's upper child is C, just as
777  * it was before we created D. In fact, now that D is gone, everything is back
778  * to the way it was before we created D.
779  * 
780  * But what if we had closed C instead of D? We would have gotten this:
781  * <informaltable frame="none"><tgroup cols="2"><tbody><row>
782  * <entry><mediaobject><imageobject><imagedata fileref="fig11.png"/>
783  * </imageobject></mediaobject></entry>
784  * <entry><mediaobject><textobject><literallayout class="monospaced">
785  *      O1
786  *     / \
787  *    O2  B
788  *   / \
789  *  A   D
790  * </literallayout></textobject></mediaobject></entry> 
791  * </row></tbody></tgroup></informaltable>
792  * 
793  * Again, O3 is gone. But D has collapsed to zero height. This is because its
794  * height is controlled by O2, and O2's key window was C, and C is now gone. O2
795  * no longer has a key window at all, so it cannot compute a height for its
796  * upper child, so it defaults to zero.
797  * 
798  * <note><para>
799  *   This may seem to be an inconvenient choice. That is deliberate. You should
800  *   not leave a pair window with no key, and the zero-height default reminds
801  *   you not to. You can use glk_window_set_arrangement() to set a new split
802  *   measurement and key window. See <link 
803  *   linkend="chimara-Changing-Window-Constraints">Changing Window
804  *   Constraints</link>.
805  * </para></note>
806  */
807 void
808 glk_window_close(winid_t win, stream_result_t *result)
809 {
810         VALID_WINDOW(win, return);
811
812         ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
813         
814         gdk_threads_enter(); /* Prevent redraw while we're trashing the window */
815         
816         /* If any pair windows have this window or its children as a key window,
817          set their key window to NULL */
818         g_node_traverse(glk_data->root_window, G_IN_ORDER, G_TRAVERSE_NON_LEAVES, -1, (GNodeTraverseFunc)remove_key_windows, win);
819         
820         /* Close all the window streams and destroy the widgets of this window
821          and below, before trashing the window tree */
822         destroy_windows_below(win, result);
823         
824         /* Then free the winid_t structures below this node, but not this one itself */
825         if(win->type == wintype_Pair) {
826                 free_winids_below(win->window_node->children->data);
827                 free_winids_below(win->window_node->children->next->data);
828         }
829         /* So now we should be left with a skeleton tree hanging off this node */       
830         
831         /* Parent window changes from a split window into the sibling window */
832         /* The parent of any window is either a pair window or NULL */
833         GNode *pair_node = win->window_node->parent;
834         /* If win was not the root window: */
835         if(pair_node != NULL)
836         {
837                 gboolean new_child_on_left = ( pair_node == g_node_first_sibling(pair_node) );
838
839                 /* Lookup our sibling */
840                 GNode *sibling_node = pair_node->children;
841                 if(sibling_node == win->window_node)
842                         sibling_node = sibling_node->next;
843
844                 GNode *new_parent_node = pair_node->parent;
845                 g_node_unlink(pair_node);
846                 g_node_unlink(sibling_node);
847                 /* pair_node and sibling_node should now be totally unconnected to the tree */
848                 
849                 if(new_parent_node == NULL)
850                 {
851                         glk_data->root_window = sibling_node;
852                 } 
853                 else 
854                 {
855                         if(new_child_on_left)
856                                 g_node_prepend(new_parent_node, sibling_node);
857                         else
858                                 g_node_append(new_parent_node, sibling_node);
859                 }
860
861                 stream_close_common( ((winid_t) pair_node->data)->window_stream, NULL );
862                 window_close_common( (winid_t) pair_node->data, TRUE);
863         } 
864         else /* it was the root window */
865         {
866                 glk_data->root_window = NULL;
867         }
868
869         window_close_common(win, FALSE);
870
871         /* Schedule a redraw */
872         g_mutex_lock(glk_data->arrange_lock);
873         glk_data->needs_rearrange = TRUE;
874         glk_data->ignore_next_arrange_event = TRUE;
875         g_mutex_unlock(glk_data->arrange_lock);
876         gtk_widget_queue_resize( GTK_WIDGET(glk_data->self) );
877         gdk_threads_leave();
878 }
879
880 /**
881  * glk_window_clear:
882  * @win: A window.
883  *
884  * Erases @win. The meaning of this depends on the window type.
885  * <variablelist>
886  * <varlistentry>
887  *  <term>Text buffer</term>
888  *  <listitem><para>
889  *   This may do any number of things, such as delete all text in the window, or
890  *   print enough blank lines to scroll all text beyond visibility, or insert a
891  *   page-break marker which is treated specially by the display part of the
892  *   library.
893  *  </para></listitem>
894  * </varlistentry>
895  * <varlistentry>
896  *  <term>Text grid</term>
897  *  <listitem><para>
898  *   This will clear the window, filling all positions with blanks (in the
899  *   normal style). The window cursor is moved to the top left corner (position
900  *   0,0).
901  *  </para></listitem>
902  * </varlistentry>
903  * <varlistentry>
904  *  <term>Graphics</term>
905  *  <listitem><para>
906  *   Clears the entire window to its current background color. See <link
907  *   linkend="chimara-The-Types-of-Windows&num;wintype-Graphics">Graphics 
908  *   Windows</link>.
909  *  </para></listitem>
910  * </varlistentry>
911  * <varlistentry>
912  *  <term>Other window types</term>
913  *  <listitem><para>No effect.</para></listitem>
914  * </varlistentry>
915  * </variablelist>
916  *
917  * It is illegal to erase a window which has line input pending. 
918  */
919 void
920 glk_window_clear(winid_t win)
921 {
922         VALID_WINDOW(win, return);
923         g_return_if_fail(win->input_request_type != INPUT_REQUEST_LINE && win->input_request_type != INPUT_REQUEST_LINE_UNICODE);
924
925         ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
926         
927         switch(win->type)
928         {
929                 case wintype_Blank:
930                 case wintype_Pair:
931                         /* do nothing */
932                         break;
933                 
934                 case wintype_TextGrid:
935                     /* fill the buffer with blanks */
936                 {
937                         /* Wait for the window's size to be updated */
938                         g_mutex_lock(glk_data->arrange_lock);
939                         if(glk_data->needs_rearrange)
940                                 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
941                         g_mutex_unlock(glk_data->arrange_lock);
942                         
943                     gdk_threads_enter();
944                     
945             /* Manually put newlines at the end of each row of characters in the buffer; manual newlines make resizing the window's grid easier. */
946             gchar *blanks = g_strnfill(win->width, ' ');
947             gchar **blanklines = g_new0(gchar *, win->height + 1);
948             int count;
949             for(count = 0; count < win->height; count++)
950                 blanklines[count] = blanks;
951             blanklines[win->height] = NULL;
952             gchar *text = g_strjoinv("\n", blanklines);
953             g_free(blanklines); /* not g_strfreev() */
954             g_free(blanks);
955             
956             GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
957             gtk_text_buffer_set_text(textbuffer, text, -1);
958             g_free(text);
959             
960             GtkTextIter start, end;
961             gtk_text_buffer_get_start_iter(textbuffer, &start);
962             gtk_text_buffer_get_end_iter(textbuffer, &end);
963
964                         /* Determine default style */
965                         GtkTextTagTable *tags = gtk_text_buffer_get_tag_table(textbuffer);
966                         GtkTextTag *default_tag = gtk_text_tag_table_lookup(tags, "default");
967                         GtkTextTag *style_tag = gtk_text_tag_table_lookup(tags, "normal");
968                         GtkTextTag *glk_style_tag = gtk_text_tag_table_lookup(tags, "normal");
969
970                         // Default style
971                         gtk_text_buffer_apply_tag(textbuffer, default_tag, &start, &end);
972
973                         // Player's style overrides
974                         gtk_text_buffer_apply_tag(textbuffer, style_tag, &start, &end);
975
976                         // GLK Program's style overrides
977                         gtk_text_buffer_apply_tag(textbuffer, glk_style_tag, &start, &end);
978
979                         if(win->zcolor != NULL)
980                                 gtk_text_buffer_apply_tag(textbuffer, win->zcolor, &start, &end);
981
982             gtk_text_buffer_move_mark_by_name(textbuffer, "cursor_position", &start);
983                     
984                     gdk_threads_leave();
985                 }
986                     break;
987                 
988                 case wintype_TextBuffer:
989                         /* delete all text in the window */
990                 {
991                         gdk_threads_enter();
992
993                         GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
994                         GtkTextIter start, end;
995                         gtk_text_buffer_get_bounds(buffer, &start, &end);
996                         gtk_text_buffer_delete(buffer, &start, &end);
997
998                         gdk_threads_leave();
999                 }
1000                         break;
1001
1002                 case wintype_Graphics:
1003                 {
1004                         /* Wait for the window's size to be updated */
1005                         g_mutex_lock(glk_data->arrange_lock);
1006                         if(glk_data->needs_rearrange)
1007                                 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
1008                         g_mutex_unlock(glk_data->arrange_lock);
1009
1010                         glk_window_erase_rect(win, 0, 0, win->widget->allocation.width, win->widget->allocation.height);
1011                 }
1012                         break;
1013                 
1014                 default:
1015                         ILLEGAL_PARAM("Unknown window type: %d", win->type);
1016         }
1017 }
1018
1019 /**
1020  * glk_set_window:
1021  * @win: A window, or %NULL.
1022  *
1023  * Sets the current stream to @win's window stream. If @win is %NULL, it is
1024  * equivalent to
1025  * |[ glk_stream_set_current(NULL); ]|
1026  * If @win is not %NULL, it is equivalent to
1027  * |[ glk_stream_set_current(glk_window_get_stream(win)); ]|
1028  * See <link linkend="chimara-Streams">Streams</link>.
1029  */
1030 void
1031 glk_set_window(winid_t win)
1032 {
1033         VALID_WINDOW_OR_NULL(win, return);
1034         if(win)
1035                 glk_stream_set_current( glk_window_get_stream(win) );
1036         else
1037                 glk_stream_set_current(NULL);
1038 }
1039
1040 /**
1041  * glk_window_get_stream:
1042  * @win: A window.
1043  *
1044  * Returns the stream which is associated with @win. (See <link 
1045  * linkend="chimara-Window-Streams">Window Streams</link>.) Every window has a
1046  * stream which can be printed to, but this may not be useful, depending on the
1047  * window type.
1048  * 
1049  * <note><para>
1050  *   For example, printing to a blank window's stream has no effect.
1051  * </para></note>
1052  *
1053  * Returns: A window stream.
1054  */
1055 strid_t glk_window_get_stream(winid_t win)
1056 {
1057         VALID_WINDOW(win, return NULL);
1058         return win->window_stream;
1059 }
1060
1061 /**
1062  * glk_window_set_echo_stream:
1063  * @win: A window.
1064  * @str: A stream to attach to the window, or %NULL.
1065  *
1066  * Sets @win's echo stream to @str, which can be any valid output stream. You
1067  * can reset a window to stop echoing by calling 
1068  * <code>#glk_window_set_echo_stream(@win, %NULL)</code>.
1069  *
1070  * It is illegal to set a window's echo stream to be its 
1071  * <emphasis>own</emphasis> window stream. That would create an infinite loop,
1072  * and is nearly certain to crash the Glk library. It is similarly illegal to
1073  * create a longer loop (two or more windows echoing to each other.)
1074  */
1075 void
1076 glk_window_set_echo_stream(winid_t win, strid_t str)
1077 {
1078         VALID_WINDOW(win, return);
1079         VALID_STREAM_OR_NULL(str, return);
1080         
1081         /* Test for an infinite loop */
1082         strid_t next = str;
1083         for(; next && next->type == STREAM_TYPE_WINDOW; next = next->window->echo_stream)
1084         {
1085                 if(next == win->window_stream)
1086                 {
1087                         ILLEGAL("Infinite loop detected");
1088                         win->echo_stream = NULL;
1089                         return;
1090                 }
1091         }
1092         
1093         win->echo_stream = str;
1094 }
1095
1096 /**
1097  * glk_window_get_echo_stream:
1098  * @win: A window.
1099  *
1100  * Returns the echo stream of window @win. Initially, a window has no echo
1101  * stream, so <code>#glk_window_get_echo_stream(@win)</code> will return %NULL.
1102  *
1103  * Returns: A stream, or %NULL.
1104  */
1105 strid_t
1106 glk_window_get_echo_stream(winid_t win)
1107 {
1108         VALID_WINDOW(win, return NULL);
1109         return win->echo_stream;
1110 }
1111
1112 /**
1113  * glk_window_get_size:
1114  * @win: A window.
1115  * @widthptr: Pointer to a location to store the window's width, or %NULL.
1116  * @heightptr: Pointer to a location to store the window's height, or %NULL.
1117  *
1118  * Simply returns the actual size of the window, in its measurement system.
1119  * As described in <link linkend="chimara-Other-API-Conventions">Other API 
1120  * Conventions</link>, either @widthptr or @heightptr can be %NULL, if you
1121  * only want one measurement. 
1122  *
1123  * <note><para>Or, in fact, both, if you want to waste time.</para></note>
1124  */
1125 void
1126 glk_window_get_size(winid_t win, glui32 *widthptr, glui32 *heightptr)
1127 {
1128         VALID_WINDOW(win, return);
1129
1130         ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
1131         
1132     switch(win->type)
1133     {
1134         case wintype_Blank:
1135                 case wintype_Pair:
1136             if(widthptr != NULL)
1137                 *widthptr = 0;
1138             if(heightptr != NULL)
1139                 *heightptr = 0;
1140             break;
1141             
1142         case wintype_TextGrid:
1143                         /* Wait until the window's size is current */
1144                         g_mutex_lock(glk_data->arrange_lock);
1145                         if(glk_data->needs_rearrange)
1146                                 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
1147                         g_mutex_unlock(glk_data->arrange_lock);
1148                         
1149                         gdk_threads_enter();
1150                         /* Cache the width and height */
1151                         win->width = (glui32)(win->widget->allocation.width / win->unit_width);
1152                     win->height = (glui32)(win->widget->allocation.height / win->unit_height);
1153             gdk_threads_leave();
1154                         
1155             if(widthptr != NULL)
1156                 *widthptr = win->width;
1157             if(heightptr != NULL)
1158                 *heightptr = win->height;
1159             break;
1160             
1161         case wintype_TextBuffer:
1162             /* Wait until the window's size is current */
1163                         g_mutex_lock(glk_data->arrange_lock);
1164                         if(glk_data->needs_rearrange)
1165                                 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
1166                         g_mutex_unlock(glk_data->arrange_lock);
1167                         
1168             gdk_threads_enter();
1169             if(widthptr != NULL)
1170                 *widthptr = (glui32)(win->widget->allocation.width / win->unit_width);
1171             if(heightptr != NULL)
1172                 *heightptr = (glui32)(win->widget->allocation.height / win->unit_height);
1173             gdk_threads_leave();
1174             
1175             break;
1176
1177                 case wintype_Graphics:
1178                         g_mutex_lock(glk_data->arrange_lock);
1179                         if(glk_data->needs_rearrange)
1180                                 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
1181                         g_mutex_unlock(glk_data->arrange_lock);
1182                         
1183             gdk_threads_enter();
1184             if(widthptr != NULL)
1185                 *widthptr = (glui32)(win->widget->allocation.width);
1186             if(heightptr != NULL)
1187                 *heightptr = (glui32)(win->widget->allocation.height);
1188             gdk_threads_leave();
1189             
1190             break;
1191             
1192         default:
1193             ILLEGAL_PARAM("Unknown window type: %u", win->type);
1194     }
1195 }
1196
1197 /**
1198  * glk_window_set_arrangement:
1199  * @win: a pair window to rearrange.
1200  * @method: new method of size computation. One of %winmethod_Above, 
1201  * %winmethod_Below, %winmethod_Left, or %winmethod_Right OR'ed with 
1202  * %winmethod_Fixed or %winmethod_Proportional.
1203  * @size: new size constraint, in percentage points if @method is
1204  * %winmethod_Proportional, otherwise in characters if @win's type is 
1205  * %wintype_TextBuffer or %wintype_TextGrid, or pixels if @win's type is
1206  * %wintype_Graphics.
1207  * @keywin: new key window, or %NULL to leave the key window unchanged.
1208  *
1209  * Changes the size of an existing split &mdash; that is, it changes the 
1210  * constraint of a given pair window.
1211  * 
1212  * Consider the example above, where D has collapsed to zero height. Say D was a
1213  * text buffer window. You could make a more useful layout by doing
1214  * |[
1215  * winid_t o2;
1216  * o2 = glk_window_get_parent(d);
1217  * glk_window_set_arrangement(o2, winmethod_Above | winmethod_Fixed, 3, d);
1218  * ]|
1219  * That would set D (the upper child of O2) to be O2's key window, and give it a
1220  * fixed size of 3 rows.
1221  * 
1222  * If you later wanted to expand D, you could do
1223  * |[ glk_window_set_arrangement(o2, winmethod_Above | winmethod_Fixed, 5, NULL); ]|
1224  * That expands D to five rows. Note that, since O2's key window is already set 
1225  * to D, it is not necessary to provide the @keywin argument; you can pass %NULL
1226  * to mean <quote>leave the key window unchanged.</quote>
1227  * 
1228  * If you do change the key window of a pair window, the new key window 
1229  * <emphasis>must</emphasis> be a descendant of that pair window. In the current
1230  * example, you could change O2's key window to be A, but not B. The key window
1231  * also cannot be a pair window itself.
1232  * 
1233  * |[ glk_window_set_arrangement(o2, winmethod_Below | winmethod_Fixed, 3, NULL); ]|
1234  * This changes the constraint to be on the <emphasis>lower</emphasis> child of 
1235  * O2, which is A. The key window is still D; so A would then be three rows high
1236  * as measured in D's font, and D would get the rest of O2's space. That may not
1237  * be what you want. To set A to be three rows high as measured in A's font, you
1238  * would do
1239  * |[ glk_window_set_arrangement(o2, winmethod_Below | winmethod_Fixed, 3, a); ]|
1240  * 
1241  * Or you could change O2 to a proportional split:
1242  * |[ glk_window_set_arrangement(o2, winmethod_Below | winmethod_Proportional, 30, NULL); ]|
1243  * or
1244  * |[ glk_window_set_arrangement(o2, winmethod_Above | winmethod_Proportional, 70, NULL); ]|
1245  * These do exactly the same thing, since 30&percnt; above is the same as 
1246  * 70&percnt; below. You don't need to specify a key window with a proportional
1247  * split, so the @keywin argument is %NULL. (You could actually specify either A
1248  * or D as the key window, but it wouldn't affect the result.)
1249  * 
1250  * Whatever constraint you set, glk_window_get_size() will tell you the actual 
1251  * window size you got.
1252  * 
1253  * Note that you can resize windows, and alter the Border/NoBorder flag. But you
1254  * can't flip or rotate them. You can't move A above D, or change O2 to a
1255  * vertical split where A is left or right of D.
1256  * <note><para>
1257  *   To get this effect you could close one of the windows, and re-split the 
1258  *   other one with glk_window_open().
1259  * </para></note>
1260  */
1261 void
1262 glk_window_set_arrangement(winid_t win, glui32 method, glui32 size, winid_t keywin)
1263 {
1264         VALID_WINDOW(win, return);
1265         VALID_WINDOW_OR_NULL(keywin, return);
1266         g_return_if_fail(win->type == wintype_Pair);
1267         if(keywin)
1268         {
1269                 g_return_if_fail(keywin->type != wintype_Pair);
1270                 g_return_if_fail(g_node_is_ancestor(win->window_node, keywin->window_node));
1271         }
1272         g_return_if_fail(method == (method & (winmethod_DirMask | winmethod_DivisionMask)));
1273         g_return_if_fail(!(((method & winmethod_DivisionMask) == winmethod_Proportional) && size > 100));
1274
1275         ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
1276         
1277         win->split_method = method;
1278         win->constraint_size = size;
1279         if(keywin)
1280                 win->key_window = keywin;
1281
1282         /* Tell GTK to rearrange the windows */
1283         gdk_threads_enter();
1284         g_mutex_lock(glk_data->arrange_lock);
1285         glk_data->needs_rearrange = TRUE;
1286         glk_data->ignore_next_arrange_event = TRUE;
1287         g_mutex_unlock(glk_data->arrange_lock);
1288         gtk_widget_queue_resize(GTK_WIDGET(glk_data->self));
1289         gdk_threads_leave();
1290 }
1291
1292 /**
1293  * glk_window_get_arrangement:
1294  * @win: a pair window.
1295  * @methodptr: return location for the constraint flags of @win, or %NULL.
1296  * @sizeptr: return location for the constraint size of @win, or %NULL.
1297  * @keywinptr: return location for the key window of @win, or %NULL.
1298  *
1299  * Queries the constraint of a given pair window.
1300  */
1301 void
1302 glk_window_get_arrangement(winid_t win, glui32 *methodptr, glui32 *sizeptr, winid_t *keywinptr)
1303 {
1304         VALID_WINDOW(win, return);
1305         g_return_if_fail(win->type == wintype_Pair);
1306         
1307         if(methodptr)
1308                 *methodptr = win->split_method;
1309         if(sizeptr)
1310                 *sizeptr = win->constraint_size;
1311         if(keywinptr)
1312                 *keywinptr = win->key_window;
1313 }
1314
1315 /**
1316  * glk_window_move_cursor:
1317  * @win: A text grid window.
1318  * @xpos: Horizontal cursor position.
1319  * @ypos: Vertical cursor position.
1320  * 
1321  * Sets the cursor position. If you move the cursor right past the end of a 
1322  * line, it wraps; the next character which is printed will appear at the
1323  * beginning of the next line.
1324  * 
1325  * If you move the cursor below the last line, or when the cursor reaches the
1326  * end of the last line, it goes <quote>off the screen</quote> and further
1327  * output has no effect. You must call glk_window_move_cursor() or
1328  * glk_window_clear() to move the cursor back into the visible region.
1329  * 
1330  * <note><para>
1331  *  Note that the arguments of glk_window_move_cursor() are <type>unsigned 
1332  *  int</type>s. This is okay, since there are no negative positions. If you try
1333  *  to pass a negative value, Glk will interpret it as a huge positive value,
1334  *  and it will wrap or go off the last line.
1335  * </para></note>
1336  *
1337  * <note><para>
1338  *  Also note that the output cursor is not necessarily visible. In particular,
1339  *  when you are requesting line or character input in a grid window, you cannot
1340  *  rely on the cursor position to prompt the player where input is indicated.
1341  *  You should print some character prompt at that spot &mdash; a 
1342  *  <quote>&gt;</quote> character, for example.
1343  * </para></note>
1344  */
1345 void
1346 glk_window_move_cursor(winid_t win, glui32 xpos, glui32 ypos)
1347 {
1348         VALID_WINDOW(win, return);
1349         g_return_if_fail(win->type == wintype_TextGrid);
1350
1351         flush_window_buffer(win);
1352
1353         ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
1354         
1355         /* Wait until the window's size is current */
1356         g_mutex_lock(glk_data->arrange_lock);
1357         if(glk_data->needs_rearrange)
1358                 g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
1359         g_mutex_unlock(glk_data->arrange_lock);
1360
1361         /* Don't do anything if the window is shrunk down to nothing */
1362         if(win->width == 0 || win->height == 0)
1363                 return;
1364         
1365         /* Calculate actual position if cursor is moved past the right edge */
1366         if(xpos >= win->width)
1367         {
1368             ypos += xpos / win->width;
1369             xpos %= win->width;
1370         }
1371
1372         /* Go to the end if the cursor is moved off the bottom edge */
1373         if(ypos >= win->height)
1374         {
1375             xpos = win->width - 1;
1376             ypos = win->height - 1;
1377         }
1378         
1379         gdk_threads_enter();
1380         
1381         GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
1382         GtkTextIter newpos;
1383         /* There must actually be a character at xpos, or the following function will choke */
1384         gtk_text_buffer_get_iter_at_line_offset(buffer, &newpos, ypos, xpos);
1385         gtk_text_buffer_move_mark_by_name(buffer, "cursor_position", &newpos);
1386         
1387         gdk_threads_leave();
1388 }