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