2 #include "chimara-glk-private.h"
4 extern ChimaraGlkPrivate *glk_data;
8 * @win: A window, or %NULL.
9 * @rockptr: Return location for the next window's rock, or %NULL.
11 * Iterates over the list of windows; if @win is %NULL, it returns the first
12 * window, otherwise the next window after @win. If there are no more, it
13 * returns #NULL. The window's rock is stored in @rockptr. If you don't want
14 * the rocks to be returned, you may set @rockptr to %NULL.
16 * The order in which windows are returned is arbitrary. The root window is
17 * not necessarily first, nor is it necessarily last. The order may change
18 * every time you create or destroy a window, invalidating the iteration.
20 * Returns: the next window, or %NULL if there are no more.
23 glk_window_iterate(winid_t win, glui32 *rockptr)
28 retnode = glk_data->root_window;
31 GNode *node = win->window_node;
32 if( G_NODE_IS_LEAF(node) )
34 while(node && node->next == NULL)
42 retnode = g_node_first_child(node);
44 winid_t retval = retnode? (winid_t)retnode->data : NULL;
46 /* Store the window's rock in rockptr */
48 *rockptr = glk_window_get_rock(retval);
54 * glk_window_get_rock:
57 * Returns @win's rock value. Pair windows always have rock 0; all other windows
58 * have the rock value you created them with.
60 * Returns: A rock value.
63 glk_window_get_rock(winid_t win)
65 g_return_val_if_fail(win != NULL, 0);
70 * glk_window_get_type:
73 * Returns @win's type, one of #wintype_Blank, #wintype_Pair,
74 * #wintype_TextBuffer, #wintype_TextGrid, or #wintype_Graphics.
76 * Returns: The window's type.
79 glk_window_get_type(winid_t win)
81 g_return_val_if_fail(win != NULL, 0);
86 * glk_window_get_parent:
89 * Returns the window @win's parent window. If @win is the root window, this
90 * returns %NULL, since the root window has no parent. Remember that the parent
91 * of every window is a pair window; other window types are always childless.
93 * Returns: A window, or %NULL.
96 glk_window_get_parent(winid_t win)
98 g_return_val_if_fail(win != NULL, NULL);
99 /* Value will also be NULL if win is the root window */
100 return (winid_t)win->window_node->parent->data;
104 * glk_window_get_sibling:
107 * Returns the other child of the window @win's parent. If @win is the
108 * root window, this returns %NULL.
110 * Returns: A window, or %NULL.
113 glk_window_get_sibling(winid_t win)
115 g_return_val_if_fail(win != NULL, NULL);
117 if(G_NODE_IS_ROOT(win->window_node))
119 if(win->window_node->next)
120 return (winid_t)win->window_node->next;
121 return (winid_t)win->window_node->prev;
125 * glk_window_get_root:
127 * Returns the root window. If there are no windows, this returns %NULL.
129 * Returns: A window, or %NULL.
132 glk_window_get_root()
134 if(glk_data->root_window == NULL)
136 return (winid_t)glk_data->root_window->data;
139 /* Determine the size of a "0" character in pixels */
141 text_window_get_char_size(GtkWidget *textview, int *width, int *height)
143 PangoLayout *zero = gtk_widget_create_pango_layout(textview, "0");
144 pango_layout_get_pixel_size(zero, width, height);
145 g_object_unref(zero);
150 * @split: The window to split to create the new window. Must be 0 if there
151 * are no windows yet.
152 * @method: Position of the new window and method of size computation. One of
153 * #winmethod_Above, #winmethod_Below, #winmethod_Left, or #winmethod_Right
154 * OR'ed with #winmethod_Fixed or #winmethod_Proportional. If @wintype is
155 * #wintype_Blank, then #winmethod_Fixed is not allowed.
156 * @size: Size of the new window, in percentage points if @method is
157 * #winmethod_Proportional, otherwise in characters if @wintype is
158 * #wintype_TextBuffer or #wintype_TextGrid, or pixels if @wintype is
160 * @wintype: Type of the new window. One of #wintype_Blank, #wintype_TextGrid,
161 * #wintype_TextBuffer, or #wintype_Graphics.
162 * @rock: The new window's rock value.
164 * If there are no windows, create a new root window. @split must be 0, and
165 * @method and @size are ignored. Otherwise, split window @split into two, with
166 * position, size, and type specified by @method, @size, and @wintype. See the
167 * Glk documentation for the window placement algorithm.
169 * Returns: the new window, or %NULL on error.
172 glk_window_open(winid_t split, glui32 method, glui32 size, glui32 wintype,
178 g_warning("glk_window_open: splitting of windows not implemented");
183 if(split == NULL && glk_data->root_window != NULL)
185 g_warning("glk_window_open: there is already a root window");
191 /* We only create one window and don't support any more than that */
192 winid_t win = g_new0(struct glk_window_struct, 1);
195 win->window_node = g_node_new(win);
201 /* A blank window will be a label without any text */
202 GtkWidget *label = gtk_label_new("");
203 gtk_widget_show(label);
207 /* A blank window has no size */
209 win->unit_height = 0;
210 /* You can print to a blank window's stream, but it does nothing */
211 win->window_stream = window_stream_new(win);
212 win->echo_stream = NULL;
216 case wintype_TextGrid:
218 GtkWidget *scrolledwindow = gtk_scrolled_window_new(NULL, NULL);
219 GtkWidget *textview = gtk_text_view_new();
221 gtk_scrolled_window_set_policy( GTK_SCROLLED_WINDOW(scrolledwindow), GTK_POLICY_NEVER, GTK_POLICY_NEVER );
223 gtk_text_view_set_wrap_mode( GTK_TEXT_VIEW(textview), GTK_WRAP_CHAR );
224 gtk_text_view_set_editable( GTK_TEXT_VIEW(textview), FALSE );
226 gtk_container_add( GTK_CONTAINER(scrolledwindow), textview );
227 gtk_widget_show_all(scrolledwindow);
229 /* Set the window's font */
230 /* TODO: Use Pango to pick out a monospace font on the system */
231 PangoFontDescription *font = pango_font_description_from_string("Monospace");
232 gtk_widget_modify_font(textview, font);
233 pango_font_description_free(font);
235 win->widget = textview;
236 win->frame = scrolledwindow;
237 text_window_get_char_size( textview, &(win->unit_width), &(win->unit_height) );
239 /* Set the other parameters (width and height are set later) */
240 win->window_stream = window_stream_new(win);
241 win->echo_stream = NULL;
242 win->input_request_type = INPUT_REQUEST_NONE;
243 win->line_input_buffer = NULL;
244 win->line_input_buffer_unicode = NULL;
246 /* Connect signal handlers */
247 win->keypress_handler = g_signal_connect( G_OBJECT(textview), "key-press-event", G_CALLBACK(on_window_key_press_event), win );
248 g_signal_handler_block( G_OBJECT(textview), win->keypress_handler );
252 case wintype_TextBuffer:
254 GtkWidget *scrolledwindow = gtk_scrolled_window_new(NULL, NULL);
255 GtkWidget *textview = gtk_text_view_new();
256 GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(textview) );
258 gtk_text_view_set_wrap_mode( GTK_TEXT_VIEW(textview), GTK_WRAP_WORD_CHAR );
259 gtk_text_view_set_editable( GTK_TEXT_VIEW(textview), FALSE );
261 gtk_container_add( GTK_CONTAINER(scrolledwindow), textview );
262 gtk_widget_show_all(scrolledwindow);
264 win->widget = textview;
265 win->frame = scrolledwindow;
266 text_window_get_char_size( textview, &(win->unit_width), &(win->unit_height) );
268 /* Set the other parameters */
269 win->window_stream = window_stream_new(win);
270 win->echo_stream = NULL;
271 win->input_request_type = INPUT_REQUEST_NONE;
272 win->line_input_buffer = NULL;
273 win->line_input_buffer_unicode = NULL;
275 /* Connect signal handlers */
276 win->keypress_handler = g_signal_connect( G_OBJECT(textview), "key-press-event", G_CALLBACK(on_window_key_press_event), win );
277 g_signal_handler_block( G_OBJECT(textview), win->keypress_handler );
279 win->insert_text_handler = g_signal_connect_after( G_OBJECT(textbuffer), "insert-text", G_CALLBACK(after_window_insert_text), win );
280 g_signal_handler_block( G_OBJECT(textbuffer), win->insert_text_handler );
282 /* Create an editable tag to indicate uneditable parts of the window
284 gtk_text_buffer_create_tag(textbuffer, "uneditable", "editable", FALSE, "editable-set", TRUE, NULL);
286 /* Mark the position where the user will input text */
288 gtk_text_buffer_get_end_iter(textbuffer, &end);
289 gtk_text_buffer_create_mark(textbuffer, "input_position", &end, TRUE);
295 g_warning("%s: unsupported window type", __func__);
297 g_node_destroy(glk_data->root_window);
298 glk_data->root_window = NULL;
304 /* When splitting, construct a new parent window
305 * copying most characteristics from the window that is being split */
306 winid_t pair = g_new0(struct glk_window_struct, 1);
308 pair->type = wintype_Pair;
309 pair->window_node = g_node_new(pair);
310 pair->unit_width = split->unit_width;
311 pair->unit_height = split->unit_height;
312 pair->window_stream = NULL;
313 pair->echo_stream = NULL;
315 /* Insert the new window into the window tree */
316 if(split->window_node->parent == NULL)
318 glk_data->root_window = pair->window_node;
320 g_node_append(split->window_node->parent, pair->window_node);
321 g_node_unlink(split->window_node);
324 /* Keep track of the parent widget of the window that is being split */
325 GtkWidget* old_parent = gtk_widget_get_parent(split->frame);
326 gtk_widget_ref(split->frame);
327 gtk_widget_unparent(split->frame);
329 /* Place the windows in the correct order */
330 switch(method & winmethod_DirMask)
333 pair->widget = gtk_hbox_new(FALSE, 0);
334 gtk_box_pack_end(GTK_BOX(pair->widget), split->frame, TRUE, TRUE, 0);
335 gtk_box_pack_end(GTK_BOX(pair->widget), win->frame, TRUE, TRUE, 0);
336 g_node_append(pair->window_node, split->window_node);
337 g_node_append(pair->window_node, win->window_node);
339 case winmethod_Right:
340 pair->widget = gtk_hbox_new(FALSE, 0);
341 gtk_box_pack_end(GTK_BOX(pair->widget), win->frame, TRUE, TRUE, 0);
342 gtk_box_pack_end(GTK_BOX(pair->widget), split->frame, TRUE, TRUE, 0);
343 g_node_append(pair->window_node, win->window_node);
344 g_node_append(pair->window_node, split->window_node);
346 case winmethod_Above:
347 pair->widget = gtk_vbox_new(FALSE, 0);
348 gtk_box_pack_end(GTK_BOX(pair->widget), split->frame, TRUE, TRUE, 0);
349 gtk_box_pack_end(GTK_BOX(pair->widget), win->frame, TRUE, TRUE, 0);
350 g_node_append(pair->window_node, split->window_node);
351 g_node_append(pair->window_node, win->window_node);
353 case winmethod_Below:
354 pair->widget = gtk_vbox_new(FALSE, 0);
355 gtk_box_pack_end(GTK_BOX(pair->widget), win->frame, TRUE, TRUE, 0);
356 gtk_box_pack_end(GTK_BOX(pair->widget), split->frame, TRUE, TRUE, 0);
357 g_node_append(pair->window_node, win->window_node);
358 g_node_append(pair->window_node, split->window_node);
361 gtk_widget_unref(split->frame);
363 /* TODO: set the new size of the windows */
365 pair->frame = pair->widget;
366 gtk_widget_set_parent(pair->widget, old_parent);
367 gtk_widget_show(pair->widget);
369 /* Set the window as root window */
370 glk_data->root_window = win->window_node;
371 gtk_widget_set_parent(win->frame, GTK_WIDGET(glk_data->self));
372 gtk_widget_queue_resize(GTK_WIDGET(glk_data->self));
375 /* For text grid windows, wait until GTK draws the window (see note in glk_window_get_size() ), calculate the size and fill the buffer with blanks. */
376 if(wintype == wintype_TextGrid)
378 while(win->widget->allocation.width == 1 && win->widget->allocation.height == 1)
380 /* Release the GDK lock momentarily */
383 while(gtk_events_pending())
384 gtk_main_iteration();
386 win->width = (glui32)(win->widget->allocation.width / win->unit_width);
387 win->height = (glui32)(win->widget->allocation.height / win->unit_height);
389 /* Mark the cursor position */
391 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
392 gtk_text_buffer_get_start_iter(buffer, &begin);
393 gtk_text_buffer_create_mark(buffer, "cursor_position", &begin, TRUE);
395 /* Fill the buffer with blanks and move the cursor to the upper left */
397 glk_window_clear(win);
400 /* Apparently this only works after the window has been realized */
401 gtk_text_view_set_overwrite( GTK_TEXT_VIEW(win->widget), TRUE );
411 * @win: Window to close.
412 * @result: Pointer to a #stream_result_t in which to store the write count.
414 * Closes @win, which is pretty much exactly the opposite of opening a window.
415 * It is legal to close all your windows, or to close the root window (which is
418 * The @result argument is filled with the output character count of the window
422 glk_window_close(winid_t win, stream_result_t *result)
426 g_return_if_fail(win != NULL);
433 gtk_widget_destroy(win->widget);
436 case wintype_TextGrid:
437 case wintype_TextBuffer:
438 gtk_widget_destroy(win->frame);
439 /* TODO: Cancel all input requests */
444 GNode* left_child = g_node_first_child(win->window_node);
445 GNode* right_child = g_node_last_child(win->window_node);
447 glk_window_close((winid_t) left_child->data, result);
448 glk_window_close((winid_t) right_child->data, result);
450 gtk_widget_destroy(win->widget);
455 g_warning("%s: unsupported window type", __func__);
460 stream_close_common(win->window_stream, result);
462 /* Parent window changes from a split window into the sibling window */
463 if( (parent_node = win->window_node->parent) != NULL )
465 winid_t pair = (winid_t) parent_node->data;
466 if(parent_node->parent == NULL)
468 if(parent_node->next)
469 glk_data->root_window = parent_node->next;
470 else if(parent_node->prev)
471 glk_data->root_window = parent_node->prev;
473 if(parent_node->next)
474 g_node_append(parent_node->parent, parent_node->next);
475 else if(parent_node->prev)
476 g_node_append(parent_node->parent, parent_node->prev);
479 g_node_unlink(parent_node);
483 g_node_destroy(win->window_node);
493 * Erases the window @win. The meaning of this depends on the window type.
497 * Text buffer: This may do any number of things, such as delete all text in
498 * the window, or print enough blank lines to scroll all text beyond
499 * visibility, or insert a page-break marker which is treated specially by the
500 * display part of the library.
503 * Text grid: This will clear the window, filling all positions with blanks.
504 * The window cursor is moved to the top left corner (position 0,0).
507 * Graphics: Clears the entire window to its current background color.
510 * Other window types: No effect.
514 * It is illegal to erase a window which has line input pending.
517 glk_window_clear(winid_t win)
519 g_return_if_fail(win != NULL);
520 g_return_if_fail(win->input_request_type != INPUT_REQUEST_LINE && win->input_request_type != INPUT_REQUEST_LINE_UNICODE);
529 case wintype_TextGrid:
530 /* fill the buffer with blanks */
534 /* Manually put newlines at the end of each row of characters in the buffer; manual newlines make resizing the window's grid easier. */
535 gchar *blanks = g_strnfill(win->width, ' ');
536 gchar **blanklines = g_new0(gchar *, win->height + 1);
538 for(count = 0; count < win->height; count++)
539 blanklines[count] = blanks;
540 blanklines[win->height] = NULL;
541 gchar *text = g_strjoinv("\n", blanklines);
542 g_free(blanklines); /* not g_strfreev() */
545 GtkTextBuffer *textbuffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
546 gtk_text_buffer_set_text(textbuffer, text, -1);
550 gtk_text_buffer_get_start_iter(textbuffer, &begin);
551 gtk_text_buffer_move_mark_by_name(textbuffer, "cursor_position", &begin);
557 case wintype_TextBuffer:
558 /* delete all text in the window */
562 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
563 GtkTextIter start, end;
564 gtk_text_buffer_get_bounds(buffer, &start, &end);
565 gtk_text_buffer_delete(buffer, &start, &end);
572 g_warning("glk_window_clear: unsupported window type");
580 * Sets the current stream to @win's window stream. It is exactly equivalent to
581 * <informalexample><programlisting>
582 * glk_stream_set_current(glk_window_get_stream(win))
583 * </programlisting></informalexample>
586 glk_set_window(winid_t win)
588 glk_stream_set_current( glk_window_get_stream(win) );
592 * glk_window_get_stream:
595 * Returns the stream which is associated with @win. Every window has a stream
596 * which can be printed to, but this may not be useful, depending on the window
597 * type. (For example, printing to a blank window's stream has no effect.)
599 * Returns: The window stream.
601 strid_t glk_window_get_stream(winid_t win)
603 g_return_val_if_fail(win != NULL, NULL);
604 return win->window_stream;
608 * glk_window_set_echo_stream:
610 * @str: A stream to attach to the window, or %NULL.
612 * Attaches the stream @str to @win as a second stream. Any text printed to the
613 * window is also echoed to this second stream, which is called the window's
616 * Effectively, any call to glk_put_char() (or the other output commands) which
617 * is directed to @win's window stream, is replicated to @win's echo stream.
618 * This also goes for the style commands such as glk_set_style().
620 * Note that the echoing is one-way. You can still print text directly to the
621 * echo stream, and it will go wherever the stream is bound, but it does not
622 * back up and appear in the window.
624 * It is illegal to set a window's echo stream to be its own window stream,
625 * which would create an infinite loop. It is similarly illegal to create a
626 * longer loop (two or more windows echoing to each other.)
628 * You can reset a window to stop echoing by setting @str to %NULL.
631 glk_window_set_echo_stream(winid_t win, strid_t str)
633 g_return_if_fail(win != NULL);
635 /* Test for an infinite loop */
637 for(; next && next->type == STREAM_TYPE_WINDOW; next = next->window->echo_stream)
639 if(next == win->window_stream)
641 g_warning("%s: Infinite loop detected", __func__);
642 win->echo_stream = NULL;
647 win->echo_stream = str;
651 * glk_window_get_echo_stream:
654 * Returns the echo stream of window @win. If the window has no echo stream (as
655 * is initially the case) then this returns %NULL.
657 * Returns: A stream, or %NULL.
660 glk_window_get_echo_stream(winid_t win)
662 g_return_val_if_fail(win != NULL, NULL);
663 return win->echo_stream;
667 * glk_window_get_size:
669 * @widthptr: Pointer to a location to store the window's width, or %NULL.
670 * @heightptr: Pointer to a location to store the window's height, or %NULL.
672 * Simply returns the actual size of the window, in its measurement system.
673 * Either @widthptr or @heightptr can be %NULL, if you only want one
674 * measurement. (Or, in fact, both, if you want to waste time.)
677 glk_window_get_size(winid_t win, glui32 *widthptr, glui32 *heightptr)
679 g_return_if_fail(win != NULL);
686 if(heightptr != NULL)
690 case wintype_TextGrid:
691 /* The text grid caches its width and height */
693 *widthptr = win->width;
694 if(heightptr != NULL)
695 *heightptr = win->height;
698 case wintype_TextBuffer:
699 /* TODO: Glk wants to be able to get its windows' sizes as soon as they are created, but GTK doesn't decide on their sizes until they are drawn. The drawing happens somewhere in an idle function. A good method would be to make an educated guess of the window's size using the ChimaraGlk widget's size. */
701 /*if(win->widget->allocation.width == 1 && win->widget->allocation.height == 1)
703 g_warning("glk_window_get_size: The Glk program requested the size of a window before it was allocated screen space by GTK. The window size is just an educated guess.");
704 guess the size from the parent window;
708 /* Instead, we wait for GTK to draw the widget. This is probably very slow and should be fixed. */
709 while(win->widget->allocation.width == 1 && win->widget->allocation.height == 1)
711 /* Release the GDK lock momentarily */
714 while(gtk_events_pending())
715 gtk_main_iteration();
719 *widthptr = (glui32)(win->widget->allocation.width / win->unit_width);
720 if(heightptr != NULL)
721 *heightptr = (glui32)(win->widget->allocation.height / win->unit_height);
727 g_warning("glk_window_get_size: Unsupported window type");
732 * glk_window_move_cursor:
733 * @win: A text grid window.
734 * @xpos: Horizontal cursor position.
735 * @ypos: Vertical cursor position.
737 * Sets the cursor position. If you move the cursor right past the end of a
738 * line, it wraps; the next character which is printed will appear at the
739 * beginning of the next line.
741 * If you move the cursor below the last line, or when the cursor reaches the
742 * end of the last line, it goes "off the screen" and further output has no
743 * effect. You must call glk_window_move_cursor() or glk_window_clear() to move
744 * the cursor back into the visible region.
747 * Note that the arguments of glk_window_move_cursor() are <type>unsigned
748 * int</type>s. This is okay, since there are no negative positions. If you try
749 * to pass a negative value, Glk will interpret it as a huge positive value,
750 * and it will wrap or go off the last line.
754 * Also note that the output cursor is not necessarily visible. In particular,
755 * when you are requesting line or character input in a grid window, you cannot
756 * rely on the cursor position to prompt the player where input is indicated.
757 * You should print some character prompt at that spot -- a ">" character, for
762 glk_window_move_cursor(winid_t win, glui32 xpos, glui32 ypos)
764 g_return_if_fail(win != NULL);
765 g_return_if_fail(win->type == wintype_TextGrid);
767 /* Calculate actual position if cursor is moved past the right edge */
768 if(xpos >= win->width)
770 ypos += xpos / win->width;
773 /* Go to the end if the cursor is moved off the bottom edge */
774 if(ypos >= win->height)
776 xpos = win->width - 1;
777 ypos = win->height - 1;
782 GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
784 /* There must actually be a character at xpos, or the following function will choke */
785 gtk_text_buffer_get_iter_at_line_offset(buffer, &newpos, ypos, xpos);
786 gtk_text_buffer_move_mark_by_name(buffer, "cursor_position", &newpos);