*
* So to create a text buffer window which takes the top 40% of the original
* window's space, you would execute
- * <informalexample><programlisting>
- * newwin = #glk_window_open(win, #winmethod_Above | #winmethod_Proportional, 40, #wintype_TextBuffer, 0);
- * </programlisting></informalexample>
+ * |[ newwin = #glk_window_open(win, #winmethod_Above | #winmethod_Proportional, 40, #wintype_TextBuffer, 0); ]|
*
* To create a text grid which is always five lines high, at the bottom of the
* original window, you would do
- * <informalexample><programlisting>
- * newwin = #glk_window_open(win, #winmethod_Below | #winmethod_Fixed, 5, #wintype_TextGrid, 0);
- * </programlisting></informalexample>
+ * |[ newwin = #glk_window_open(win, #winmethod_Below | #winmethod_Fixed, 5, #wintype_TextGrid, 0); ]|
*
* Note that the meaning of the @size argument depends on the @method argument.
* If the method is #winmethod_Fixed, it also depends on the @wintype argument.
* What happens when there is a conflict? The rules are simple. Size control
* always flows down the tree, and the player is at the top. Let's bring out an
* example:
- * <mediaobject><textobject><phrase>Screen shot 5</phrase></textobject>
- * </mediaobject>
+ * <informaltable frame="none"><tgroup cols="2"><tbody><row>
+ * <entry><mediaobject><imageobject><imagedata fileref="fig5-7a.png"/>
+ * </imageobject></mediaobject></entry>
+ * <entry><mediaobject><textobject><literallayout class="monospaced">
+ * O
+ * / \
+ * O B
+ * / \
+ * A C
+ * </literallayout></textobject></mediaobject></entry>
+ * </row></tbody></tgroup></informaltable>
*
* First we split A into A and B, with a 50% proportional split. Then we split
* A into A and C, with C above, C being a text grid window, and C gets a fixed
* of the 50% it had before.
*
* Now the player stretches the window vertically.
- * <mediaobject><textobject><phrase>Screen shot 6</phrase></textobject>
- * </mediaobject>
+ * <informalfigure><mediaobject><imageobject><imagedata fileref="fig6.png"/>
+ * </imageobject></mediaobject></informalfigure>
*
* The library figures: the topmost split, the original A/B split, is 50-50. So
* B gets half the screen space, and the pair window next to it (the lower
* <quote>O</quote>. C gets two rows; A gets the rest. All done.
*
* Then the user maliciously starts squeezing the window down, in stages:
- * <mediaobject id="chimara-Figure-Squeezing-Window"><textobject><phrase>
- * Screen shot 7</phrase></textobject></mediaobject>
+ * <informaltable frame="none"><tgroup cols="5"><tbody><row valign="top">
+ * <entry><mediaobject><imageobject><imagedata fileref="fig5-7a.png"/>
+ * </imageobject></mediaobject></entry>
+ * <entry><mediaobject><imageobject><imagedata fileref="fig7b.png"/>
+ * </imageobject></mediaobject></entry>
+ * <entry><mediaobject><imageobject><imagedata fileref="fig7c.png"/>
+ * </imageobject></mediaobject></entry>
+ * <entry><mediaobject><imageobject><imagedata fileref="fig7d.png"/>
+ * </imageobject></mediaobject></entry>
+ * <entry><mediaobject><imageobject><imagedata fileref="fig7e.png"/>
+ * </imageobject></mediaobject></entry>
+ * </row></tbody></tgroup></informaltable>
*
* The logic remains the same. B always gets half the space. At stage 3,
* there's no room left for A, so it winds up with zero height. Nothing
* is stored by a window's parent, not the window itself; and a constraint
* consists of a pointer to a key window plus a size value.
*
- * <mediaobject><textobject><phrase>Screen shot 8</phrase></textobject>
- * </mediaobject>
+ * <informaltable frame="none"><tgroup cols="6"><tbody><row>
+ * <entry><mediaobject><imageobject><imagedata fileref="fig8a.png"/>
+ * </imageobject></mediaobject></entry>
+ * <entry><mediaobject><textobject><literallayout class="monospaced">
+ * A
+ * </literallayout></textobject></mediaobject></entry>
+ * <entry><mediaobject><imageobject><imagedata fileref="fig8b.png"/>
+ * </imageobject></mediaobject></entry>
+ * <entry><mediaobject><textobject><literallayout class="monospaced">
+ * O1
+ * / \
+ * A B
+ * </literallayout></textobject></mediaobject></entry>
+ * <entry><mediaobject><imageobject><imagedata fileref="fig8c.png"/>
+ * </imageobject></mediaobject></entry>
+ * <entry><mediaobject><textobject><literallayout class="monospaced">
+ * O1
+ * / \
+ * O2 B
+ * / \
+ * A C
+ * </literallayout></textobject></mediaobject></entry>
+ * </row></tbody></tgroup></informaltable>
* After the first split, the new pair window (O1, which covers the whole
* screen) knows that its first child (A) is above the second, and gets 50% of
* its own area. (A is the key window for this split, but a proportional split
* If we split C, now, the resulting pair will still be two C-font rows high
* — that is, tall enough for two lines of whatever font C displays. For
* the sake of example, we'll do this vertically.
- * <mediaobject><textobject><phrase>Screen shot 9</phrase></textobject>
- * </mediaobject>
+ * <informaltable frame="none"><tgroup cols="2"><tbody><row>
+ * <entry><mediaobject><imageobject><imagedata fileref="fig9.png"/>
+ * </imageobject></mediaobject></entry>
+ * <entry><mediaobject><textobject><literallayout class="monospaced">
+ * O1
+ * / \
+ * O2 B
+ * / \
+ * A O3
+ * / \
+ * C D
+ * </literallayout></textobject></mediaobject></entry>
+ * </row></tbody></tgroup></informaltable>
*
* O3 now knows that its children have a 50-50 left-right split. O2 is still
* committed to giving its upper child, O3, two C-font rows. Again, this is
case wintype_TextGrid:
{
- GtkWidget *scrolledwindow = gtk_scrolled_window_new(NULL, NULL);
GtkWidget *textview = gtk_text_view_new();
-
- gtk_scrolled_window_set_policy( GTK_SCROLLED_WINDOW(scrolledwindow), GTK_POLICY_NEVER, GTK_POLICY_NEVER );
-
- gtk_text_view_set_wrap_mode( GTK_TEXT_VIEW(textview), GTK_WRAP_CHAR );
+
+ gtk_text_view_set_wrap_mode( GTK_TEXT_VIEW(textview), GTK_WRAP_NONE );
gtk_text_view_set_editable( GTK_TEXT_VIEW(textview), FALSE );
-
- gtk_container_add( GTK_CONTAINER(scrolledwindow), textview );
- gtk_widget_show_all(scrolledwindow);
+ gtk_widget_show(textview);
/* Set the window's font */
gtk_widget_modify_font(textview, glk_data->monospace_font_desc);
win->widget = textview;
- win->frame = scrolledwindow;
+ win->frame = textview;
/* Determine the size of a "0" character in pixels */
PangoLayout *zero = gtk_widget_create_pango_layout(textview, "0");
(for line input) */
gtk_text_buffer_create_tag(textbuffer, "uneditable", "editable", FALSE, "editable-set", TRUE, NULL);
+ /* Create the default styles available to the window stream */
+ style_init_textbuffer(textbuffer);
+
/* Mark the position where the user will input text */
GtkTextIter end;
gtk_text_buffer_get_end_iter(textbuffer, &end);
return NULL;
}
+ /* Set the minimum size to "as small as possible" so it doesn't depend on
+ the size of the window contents */
+ gtk_widget_set_size_request(win->widget, 0, 0);
+ gtk_widget_set_size_request(win->frame, 0, 0);
+
if(split)
{
/* When splitting, construct a new parent window
pair->rock = 0;
pair->type = wintype_Pair;
pair->window_node = g_node_new(pair);
- pair->window_stream = NULL;
+ /* You can print to a pair window's window stream, but it has no effect */
+ pair->window_stream = window_stream_new(pair);
pair->echo_stream = NULL;
/* The pair window must know about its children's split method */
/* Insert the new window into the window tree */
if(split->window_node->parent == NULL)
- {
glk_data->root_window = pair->window_node;
- } else {
- g_node_append(split->window_node->parent, pair->window_node);
+ else
+ {
+ if( split->window_node == g_node_first_sibling(split->window_node) )
+ g_node_prepend(split->window_node->parent, pair->window_node);
+ else
+ g_node_append(split->window_node->parent, pair->window_node);
g_node_unlink(split->window_node);
}
/* Place the windows in the correct order */
/* Set the window as a child of the Glk widget */
gtk_widget_set_parent(win->frame, GTK_WIDGET(glk_data->self));
gtk_widget_queue_resize(GTK_WIDGET(glk_data->self));
-
- /* 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. */
+
+ gdk_threads_leave();
+
+ /* For blank or pair windows, this is almost a no-op. For text grid and
+ text buffer windows, this will wait for GTK to draw the window. Otherwise,
+ opening a window and getting its size immediately will give you the wrong
+ size. */
+ glk_window_get_size(win, NULL, NULL);
+
+ /* For text grid windows, fill the buffer with blanks. */
if(wintype == wintype_TextGrid)
{
- while(win->widget->allocation.width == 1 && win->widget->allocation.height == 1)
- {
- /* Release the GDK lock momentarily */
- gdk_threads_leave();
- gdk_threads_enter();
- while(gtk_events_pending())
- gtk_main_iteration();
- }
- win->width = (glui32)(win->widget->allocation.width / win->unit_width);
- win->height = (glui32)(win->widget->allocation.height / win->unit_height);
-
- /* Mark the cursor position */
+ /* Create the cursor position mark */
+ gdk_threads_enter();
GtkTextIter begin;
GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
gtk_text_buffer_get_start_iter(buffer, &begin);
gtk_text_buffer_create_mark(buffer, "cursor_position", &begin, TRUE);
-
- /* Fill the buffer with blanks and move the cursor to the upper left */
gdk_threads_leave();
+
+ /* Fill the buffer with blanks and move the cursor to the upper left */
glk_window_clear(win);
- gdk_threads_enter();
}
- gdk_threads_leave();
-
return win;
}
+/* Internal function: if node's key window is closing_win or one of its
+ children, set node's key window to NULL. */
+static gboolean
+remove_key_windows(GNode *node, winid_t closing_win)
+{
+ winid_t win = (winid_t)node->data;
+ if(win->key_window && (win->key_window == closing_win || g_node_is_ancestor(closing_win->window_node, win->key_window->window_node)))
+ win->key_window = NULL;
+ return FALSE; /* Don't stop the traversal */
+}
+
+/* Internal function: destroy this window's GTK widgets, window streams,
+ and those of all its children */
+static void
+destroy_windows_below(winid_t win, stream_result_t *result)
+{
+ switch(win->type)
+ {
+ case wintype_Blank:
+ gdk_threads_enter();
+ gtk_widget_unparent(win->widget);
+ gdk_threads_leave();
+ break;
+
+ case wintype_TextGrid:
+ case wintype_TextBuffer:
+ gdk_threads_enter();
+ gtk_widget_unparent(win->frame);
+ gdk_threads_leave();
+ /* TODO: Cancel all input requests */
+ break;
+
+ case wintype_Pair:
+ destroy_windows_below(win->window_node->children->data, NULL);
+ destroy_windows_below(win->window_node->children->next->data, NULL);
+ break;
+
+ default:
+ ILLEGAL_PARAM("Unknown window type: %u", win->type);
+ return;
+ }
+ stream_close_common(win->window_stream, result);
+}
+
+/* Internal function: free the winid_t structure of this window and those of all its children */
+static void
+free_winids_below(winid_t win)
+{
+ if(win->type == wintype_Pair) {
+ free_winids_below(win->window_node->children->data);
+ free_winids_below(win->window_node->children->next->data);
+ }
+ win->magic = MAGIC_FREE;
+ g_free(win);
+}
+
/**
* glk_window_close:
* @win: Window to close.
* When you close a window (and it is not the root window), the other window
* in its pair takes over all the freed-up area. Let's close D, in the current
* example:
- * <mediaobject><textobject><phrase>Screen shot 10</phrase></textobject>
- * </mediaobject>
+ * <informaltable frame="none"><tgroup cols="2"><tbody><row>
+ * <entry><mediaobject><imageobject><imagedata fileref="fig10.png"/>
+ * </imageobject></mediaobject></entry>
+ * <entry><mediaobject><textobject><literallayout class="monospaced">
+ * O1
+ * / \
+ * O2 B
+ * / \
+ * A C
+ * </literallayout></textobject></mediaobject></entry>
+ * </row></tbody></tgroup></informaltable>
*
* Notice what has happened. D is gone. O3 is gone, and its 50-50 left-right
* split has gone with it. The other size constraints are unchanged; O2 is
* to the way it was before we created D.
*
* But what if we had closed C instead of D? We would have gotten this:
- * <mediaobject><textobject><phrase>Screen shot 11</phrase></textobject>
- * </mediaobject>
+ * <informaltable frame="none"><tgroup cols="2"><tbody><row>
+ * <entry><mediaobject><imageobject><imagedata fileref="fig11.png"/>
+ * </imageobject></mediaobject></entry>
+ * <entry><mediaobject><textobject><literallayout class="monospaced">
+ * O1
+ * / \
+ * O2 B
+ * / \
+ * A D
+ * </literallayout></textobject></mediaobject></entry>
+ * </row></tbody></tgroup></informaltable>
*
* Again, O3 is gone. But D has collapsed to zero height. This is because its
* height is controlled by O2, and O2's key window was C, and C is now gone. O2
glk_window_close(winid_t win, stream_result_t *result)
{
VALID_WINDOW(win, return);
-
- /* First close the window stream before trashing the window tree */
- stream_close_common(win->window_stream, result);
- switch(win->type)
- {
- case wintype_Blank:
- gdk_threads_enter();
- gtk_widget_unparent(win->widget);
- gdk_threads_leave();
- break;
+ /* If any pair windows have this window or its children as a key window,
+ set their key window to NULL */
+ g_node_traverse(glk_data->root_window, G_IN_ORDER, G_TRAVERSE_NON_LEAVES, -1, (GNodeTraverseFunc)remove_key_windows, win);
- case wintype_TextGrid:
- case wintype_TextBuffer:
- gdk_threads_enter();
- gtk_widget_unparent(win->frame);
- gdk_threads_leave();
- /* TODO: Cancel all input requests */
- break;
-
- case wintype_Pair:
- {
- GNode *left = win->window_node->children;
- GNode *right = win->window_node->children->next;
- glk_window_close(left->data, NULL);
- glk_window_close(right->data, NULL);
- }
- break;
-
- default:
- ILLEGAL_PARAM("Unknown window type: %u", win->type);
- return;
+ /* Close all the window streams and destroy the widgets of this window
+ and below, before trashing the window tree */
+ destroy_windows_below(win, result);
+
+ /* Then free the winid_t structures below this node, but not this one itself */
+ if(win->type == wintype_Pair) {
+ free_winids_below(win->window_node->children->data);
+ free_winids_below(win->window_node->children->next->data);
}
-
- /* Parent window changes from a split window into the sibling window */
+ /* So now we should be left with a skeleton tree hanging off this node */
+
+ /* Parent window changes from a split window into the sibling window */
+ /* The parent of any window is either a pair window or NULL */
GNode *pair_node = win->window_node->parent;
g_node_destroy(win->window_node);
- /* If win was not the root window, or was not unhooked from the tree: */
+ /* If win was not the root window: */
if(pair_node != NULL)
{
gboolean new_child_on_left = ( pair_node == g_node_first_sibling(pair_node) );
pair->magic = MAGIC_FREE;
g_free(pair);
+ }
+ else /* it was the root window */
+ {
+ glk_data->root_window = NULL;
}
win->magic = MAGIC_FREE;
/* Schedule a redraw */
gdk_threads_enter();
gtk_widget_queue_resize( GTK_WIDGET(glk_data->self) );
+ gdk_window_process_all_updates();
gdk_threads_leave();
}
break;
case wintype_TextGrid:
- /* The text grid caches its width and height */
+ gdk_threads_enter();
+ /* Wait for the window to be drawn, and then cache the width and height */
+ gdk_window_process_all_updates();
+ while(win->widget->allocation.width == 1 && win->widget->allocation.height == 1)
+ {
+ /* Release the GDK lock momentarily */
+ gdk_threads_leave();
+ gdk_threads_enter();
+ while(gtk_events_pending())
+ gtk_main_iteration();
+ }
+
+ win->width = (glui32)(win->widget->allocation.width / win->unit_width);
+ win->height = (glui32)(win->widget->allocation.height / win->unit_height);
+ gdk_threads_leave();
+
if(widthptr != NULL)
*widthptr = win->width;
if(heightptr != NULL)
} */
/* Instead, we wait for GTK to draw the widget. This is probably very slow and should be fixed. */
- while(win->widget->allocation.width == 1 && win->widget->allocation.height == 1)
+ gdk_window_process_all_updates();
+ while(win->widget->allocation.width == 1 && win->widget->allocation.height == 1)
{
/* Release the GDK lock momentarily */
gdk_threads_leave();
projects / rodin / chimara.git / blobdiff