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