/* Global tree of all windows */
static GNode *root_window = NULL;
+/**
+ * glk_window_iterate:
+ * @win: A window, or #NULL.
+ * @rockptr: Return location for the next window's rock, or #NULL.
+ *
+ * Iterates over the list of windows; if @win is #NULL, it returns the first
+ * window, otherwise the next window after @win. If there are no more, it
+ * returns #NULL. The window's rock is stored in @rockptr. If you don't want
+ * the rocks to be returned, you may set @rockptr to #NULL.
+ *
+ * The order in which windows are returned is arbitrary. The root window is
+ * not necessarily first, nor is it necessarily last. The order may change
+ * every time you create or destroy a window, invalidating the iteration.
+ *
+ * Returns: the next window, or #NULL if there are no more.
+ */
+winid_t
+glk_window_iterate(winid_t win, glui32 *rockptr)
+{
+ GNode *retnode;
+
+ if(win == NULL)
+ retnode = root_window;
+ else
+ {
+ GNode *node = win->window_node;
+ if( G_NODE_IS_LEAF(node) )
+ {
+ while(node && node->next == NULL)
+ node = node->parent;
+ if(node)
+ retnode = node->next;
+ else
+ retnode = NULL;
+ }
+ else
+ retnode = g_node_first_child(node);
+ }
+ winid_t retval = retnode? (winid_t)retnode->data : NULL;
+
+ /* Store the window's rock in rockptr */
+ if(retval && rockptr)
+ *rockptr = glk_window_get_rock(retval);
+
+ return retval;
+}
+
+/**
+ * glk_window_get_rock:
+ * @win: A window.
+ *
+ * Returns the window @win's rock value. Pair windows always have rock 0.
+ *
+ * Returns: A rock value.
+ */
+glui32
+glk_window_get_rock(winid_t win)
+{
+ g_return_val_if_fail(win != NULL, 0);
+ return win->rock;
+}
+
+/**
+ * glk_window_get_type:
+ * @win: A window.
+ *
+ * Returns the window @win's type, one of #wintype_Blank, #wintype_Pair,
+ * #wintype_TextBuffer, #wintype_TextGrid, or #wintype_Graphics.
+ *
+ * Returns: The window's type.
+ */
+glui32
+glk_window_get_type(winid_t win)
+{
+ g_return_val_if_fail(win != NULL, 0);
+ return win->window_type;
+}
+
+/**
+ * glk_window_get_parent:
+ * @win: A window.
+ *
+ * Returns the window @win's parent window. If @win is the root window, this
+ * returns #NULL, since the root window has no parent. Remember that the parent
+ * of every window is a pair window; other window types are always childless.
+ *
+ * Returns: A window.
+ */
+winid_t
+glk_window_get_parent(winid_t win)
+{
+ g_return_val_if_fail(win != NULL, NULL);
+ /* Value will also be NULL if win is the root window */
+ return (winid_t)win->window_node->parent->data;
+}
+
+/**
+ * glk_window_get_sibling:
+ * @win: A window.
+ *
+ * Returns the other child of the window @win's parent. If @win is the
+ * root window, this returns #NULL.
+ *
+ * Returns: A window, or NULL.
+ */
+winid_t
+glk_window_get_sibling(winid_t win)
+{
+ g_return_val_if_fail(win != NULL, NULL);
+
+ if(G_NODE_IS_ROOT(win->window_node))
+ return NULL;
+ if(win->window_node->next)
+ return (winid_t)win->window_node->next;
+ return (winid_t)win->window_node->prev;
+}
+
+/**
+ * glk_window_get_root:
+ *
+ * Returns the root window. If there are no windows, this returns #NULL.
+ *
+ * Returns: A window, or #NULL.
+ */
+winid_t
+glk_window_get_root()
+{
+ if(root_window == NULL)
+ return NULL;
+ return (winid_t)root_window->data;
+}
+
/**
* glk_window_open:
* @split: The window to split to create the new window. Must be 0 if there
switch(wintype)
{
+ case wintype_Blank:
+ {
+ /* A blank window will be a label without any text */
+ GtkWidget *window = gtk_label_new("");
+ gtk_box_pack_end(vbox, window, TRUE, TRUE, 0);
+ gtk_widget_show(window);
+
+ new_window->widget = window;
+ /* You can print to a blank window's stream, but it does nothing */
+ new_window->window_stream = window_stream_new(new_window);
+ new_window->echo_stream = NULL;
+ }
+ break;
+
case wintype_TextBuffer:
{
- /* We need to put these declarations inside their own scope */
GtkWidget *scroll_window = gtk_scrolled_window_new(NULL, NULL);
GtkWidget *window = gtk_text_view_new();
gtk_container_add( GTK_CONTAINER(scroll_window), window );
new_window->line_input_buffer_unicode = NULL;
}
break;
+
default:
g_warning("glk_window_open: unsupported window type");
g_free(new_window);
return new_window;
}
+/**
+ * glk_window_clear:
+ * @win: A window.
+ *
+ * Erases the window @win.
+ */
+void
+glk_window_clear(winid_t win)
+{
+ g_return_if_fail(win != NULL);
+
+ switch(win->window_type)
+ {
+ case wintype_Blank:
+ /* do nothing */
+ break;
+
+ case wintype_TextBuffer:
+ /* delete all text in the window */
+ {
+ GtkTextBuffer *buffer =
+ gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
+ GtkTextIter start, end;
+ gtk_text_buffer_get_bounds(buffer, &start, &end);
+ gtk_text_buffer_delete(buffer, &start, &end);
+ }
+ break;
+
+ default:
+ g_warning("glk_window_clear: unsupported window type");
+ }
+}
+
/**
* glk_set_window:
* @win: A window.
*/
strid_t glk_window_get_stream(winid_t win)
{
+ g_return_val_if_fail(win != NULL, NULL);
return win->window_stream;
}
+/**
+ * glk_window_set_echo_stream:
+ * @win: A window.
+ * @str: A stream to attach to the window, or #NULL.
+ *
+ * Attaches the stream @str to @win as a second stream. Any text printed to the
+ * window is also echoed to this second stream, which is called the window's
+ * "echo stream."
+ *
+ * Effectively, any call to glk_put_char() (or the other output commands) which
+ * is directed to @win's window stream, is replicated to @win's echo stream.
+ * This also goes for the style commands such as glk_set_style().
+ *
+ * Note that the echoing is one-way. You can still print text directly to the
+ * echo stream, and it will go wherever the stream is bound, but it does not
+ * back up and appear in the window.
+ *
+ * It is illegal to set a window's echo stream to be its own window stream,
+ * which would create an infinite loop. It is similarly illegal to create a
+ * longer loop (two or more windows echoing to each other.)
+ *
+ * You can reset a window to stop echoing by setting @str to #NULL.
+ */
+void
+glk_window_set_echo_stream(winid_t win, strid_t str)
+{
+ g_return_if_fail(win != NULL);
+
+ /* Test for an infinite loop */
+ strid_t next_str;
+ for(next_str = str;
+ next_str != NULL && next_str->stream_type == STREAM_TYPE_WINDOW;
+ next_str = next_str->window->echo_stream)
+ {
+ if(next_str == win->window_stream)
+ {
+ g_warning("glk_window_set_echo_stream: Infinite loop detected");
+ win->echo_stream = NULL;
+ return;
+ }
+ }
+
+ win->echo_stream = str;
+}
+
+/**
+ * glk_window_get_echo_stream:
+ * @win: A window.
+ *
+ * Returns the echo stream of window @win. If the window has no echo stream (as
+ * is initially the case) then this returns #NULL.
+ *
+ * Returns: A stream, or #NULL.
+ */
+strid_t
+glk_window_get_echo_stream(winid_t win)
+{
+ g_return_val_if_fail(win != NULL, NULL);
+ return win->echo_stream;
+}
+
projects / rodin / chimara.git / blobdiff