Backend support for using dynamic styles. See also Ticket #49.
[rodin/chimara.git] / libchimara / window.c
index c835ccb31534e8f4816cca5aa397f2322d70864f..826eacd288a146ddeb06a51a2957331af9802d60 100644 (file)
@@ -3,6 +3,7 @@
 #include "magic.h"
 #include "chimara-glk-private.h"
 #include "gi_dispa.h"
+#include "pager.h"
 
 extern GPrivate *glk_data_key;
 
@@ -25,28 +26,51 @@ window_new_common(glui32 rock)
        win->window_stream->type = STREAM_TYPE_WINDOW;
        win->window_stream->window = win;
        win->window_stream->style = "normal";
-       
+       win->window_stream->glk_style = "normal";
+
        win->echo_stream = NULL;
        win->input_request_type = INPUT_REQUEST_NONE;
        win->line_input_buffer = NULL;
        win->line_input_buffer_unicode = NULL;
+       win->history = NULL;
 
+       /* Initialise the buffer */
+       win->buffer = g_string_sized_new(1024);
+
+       /* Initialise hyperlink table */
+       win->hyperlinks = g_hash_table_new_full(g_int_hash, g_int_equal, g_free, g_free);
+       
        return win;
 }
 
+/* Internal function: do all the stuff necessary to close a window. Call only
+ from Glk thread. */
 static void
-window_close_common(winid_t win)
+window_close_common(winid_t win, gboolean destroy_node)
 {
        ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
-       
+
        if(glk_data->unregister_obj) 
        {
         (*glk_data->unregister_obj)(win, gidisp_Class_Window, win->disprock);
         win->disprock.ptr = NULL;
     }
-
-       g_node_destroy(win->window_node);
+       
+       if(destroy_node)
+               g_node_destroy(win->window_node);
+       
        win->magic = MAGIC_FREE;
+       
+       g_list_foreach(win->history, (GFunc)g_free, NULL);
+       g_list_free(win->history);
+       
+       g_string_free(win->buffer, TRUE);
+       g_hash_table_destroy(win->hyperlinks);
+       g_free(win->current_hyperlink);
+
+       if(win->pager_layout)
+               g_object_unref(win->pager_layout);
+
        g_free(win);
 }
 
@@ -147,7 +171,11 @@ winid_t
 glk_window_get_parent(winid_t win)
 {
        VALID_WINDOW(win, return NULL);
+
        /* Value will also be NULL if win is the root window */
+       if(win->window_node->parent == NULL)
+               return NULL;
+
        return (winid_t)win->window_node->parent->data;
 }
 
@@ -259,11 +287,11 @@ glk_window_get_root()
  * 
  * So to create a text buffer window which takes the top 40% of the original
  * window's space, you would execute
- * |[ newwin = #glk_window_open(win, #winmethod_Above | #winmethod_Proportional, 40, #wintype_TextBuffer, 0); ]|
+ * |[ 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
- * |[ newwin = #glk_window_open(win, #winmethod_Below | #winmethod_Fixed, 5, #wintype_TextGrid, 0); ]|
+ * |[ 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.
@@ -308,7 +336,8 @@ glk_window_get_root()
  * <quote>O</quote>. C gets two rows; A gets the rest. All done.
  * 
  * Then the user maliciously starts squeezing the window down, in stages:
- * <informaltable frame="none"><tgroup cols="5"><tbody><row valign="top">
+ * <informaltable xml:id="chimara-Figure-Squeezing-Window" 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"/>
@@ -464,25 +493,29 @@ glk_window_open(winid_t split, glui32 method, glui32 size, glui32 wintype,
                    gtk_text_view_set_editable( GTK_TEXT_VIEW(textview), FALSE );
                        gtk_widget_show(textview);
                                
-                       /* Set the window's font */
-                       gtk_widget_modify_font(textview, glk_data->monospace_font_desc);
+                       /* Create the styles available to the window stream */
+                       style_init_textgrid(textbuffer);
+                       gtk_widget_modify_font( textview, get_current_font(wintype) );
                    
                    win->widget = textview;
                    win->frame = textview;
                        
                        /* Determine the size of a "0" character in pixels */
                        PangoLayout *zero = gtk_widget_create_pango_layout(textview, "0");
-                       pango_layout_set_font_description(zero, glk_data->monospace_font_desc);
+                       pango_layout_set_font_description( zero, get_current_font(wintype) );
                        pango_layout_get_pixel_size(zero, &(win->unit_width), &(win->unit_height));
                        g_object_unref(zero);
                        /* width and height are set later */
                        
                        /* Connect signal handlers */
-                       win->keypress_handler = g_signal_connect( G_OBJECT(textview), "key-press-event", G_CALLBACK(on_window_key_press_event), win );
-                       g_signal_handler_block( G_OBJECT(textview), win->keypress_handler );
-
-                       /* Create the styles available to the window stream */
-                       style_init_textgrid(textbuffer);
+                       win->char_input_keypress_handler = g_signal_connect(textview, "key-press-event", G_CALLBACK(on_char_input_key_press_event), win);
+                       g_signal_handler_block(textview, win->char_input_keypress_handler);
+                       win->line_input_keypress_handler = g_signal_connect(textview, "key-press-event", G_CALLBACK(on_line_input_key_press_event), win);
+                       g_signal_handler_block(textview, win->line_input_keypress_handler);
+                       win->shutdown_keypress_handler = g_signal_connect(textview, "key-press-event", G_CALLBACK(on_shutdown_key_press_event), win);
+                       g_signal_handler_block(textview, win->shutdown_keypress_handler);
+                       win->button_press_event_handler = g_signal_connect( textview, "button-press-event", G_CALLBACK(on_window_button_press), win );
+                       g_signal_handler_block(textview, win->button_press_event_handler);
                }
                    break;
                
@@ -503,38 +536,80 @@ glk_window_open(winid_t split, glui32 method, glui32 size, glui32 wintype,
                        gtk_container_add( GTK_CONTAINER(scrolledwindow), textview );
                        gtk_widget_show_all(scrolledwindow);
 
-                       /* Set the window's font */
-                       gtk_widget_modify_font(textview, glk_data->default_font_desc);
-                       
                        win->widget = textview;
                        win->frame = scrolledwindow;
                        
+                       /* Create the styles available to the window stream */
+                       style_init_textbuffer(textbuffer);
+                       style_init_more_prompt(win);
+                       gtk_widget_modify_font( textview, get_current_font(wintype) );
+                       
                        /* Determine the size of a "0" character in pixels */
                        PangoLayout *zero = gtk_widget_create_pango_layout(textview, "0");
-                       pango_layout_set_font_description(zero, glk_data->default_font_desc);
+                       pango_layout_set_font_description( zero, get_current_font(wintype) );
                        pango_layout_get_pixel_size(zero, &(win->unit_width), &(win->unit_height));
                        g_object_unref(zero);
 
                        /* Connect signal handlers */
-                       win->keypress_handler = g_signal_connect( G_OBJECT(textview), "key-press-event", G_CALLBACK(on_window_key_press_event), win );
-                       g_signal_handler_block( G_OBJECT(textview), win->keypress_handler );
+                       
+                       /* Pager */
+                       //g_signal_connect_after( textview, "expose-event", G_CALLBACK(pager_after_expose_event), win );
+                       g_signal_connect_after( textview, "size-request", G_CALLBACK(pager_after_size_request), win );
+                       win->pager_expose_handler = g_signal_connect_after( textview, "expose-event", G_CALLBACK(pager_on_expose), win );
+                       g_signal_handler_block(textview, win->pager_expose_handler);
+                       win->pager_keypress_handler = g_signal_connect( textview, "key-press-event", G_CALLBACK(pager_on_key_press_event), win );
+                       g_signal_handler_block(textview, win->pager_keypress_handler);
+                       GtkAdjustment *adj = gtk_scrolled_window_get_vadjustment(GTK_SCROLLED_WINDOW(scrolledwindow));
+                       win->pager_adjustment_handler = g_signal_connect_after(adj, "value-changed", G_CALLBACK(pager_after_adjustment_changed), win);
 
-                       win->insert_text_handler = g_signal_connect_after( G_OBJECT(textbuffer), "insert-text", G_CALLBACK(after_window_insert_text), win );
-                       g_signal_handler_block( G_OBJECT(textbuffer), win->insert_text_handler );
+                       /* Char and line input */
+                       win->char_input_keypress_handler = g_signal_connect( textview, "key-press-event", G_CALLBACK(on_char_input_key_press_event), win );
+                       g_signal_handler_block(textview, win->char_input_keypress_handler);
+                       win->line_input_keypress_handler = g_signal_connect( textview, "key-press-event", G_CALLBACK(on_line_input_key_press_event), win );
+                       g_signal_handler_block(textview, win->line_input_keypress_handler);
+                       win->insert_text_handler = g_signal_connect_after( textbuffer, "insert-text", G_CALLBACK(after_window_insert_text), win );
+                       g_signal_handler_block(textbuffer, win->insert_text_handler);
+
+                       /* Shutdown key press */
+                       win->shutdown_keypress_handler = g_signal_connect( textview, "key-press-event", G_CALLBACK(on_shutdown_key_press_event), win );
+                       g_signal_handler_block(textview, win->shutdown_keypress_handler);                       
 
                        /* Create an editable tag to indicate uneditable parts of the window
                        (for line input) */
                        gtk_text_buffer_create_tag(textbuffer, "uneditable", "editable", FALSE, "editable-set", TRUE, NULL);
 
-                       /* Create the styles available to the window stream */
-                       style_init_textbuffer(textbuffer);
-
-                       /* Mark the position where the user will input text */
+                       /* Mark the position where the user will input text and the end mark */
                        GtkTextIter end;
                        gtk_text_buffer_get_end_iter(textbuffer, &end);
                        gtk_text_buffer_create_mark(textbuffer, "input_position", &end, TRUE);
+                       gtk_text_buffer_create_mark(textbuffer, "end_position", &end, FALSE);
+
+                       /* Create the pager position mark; it stands for the last character in the buffer
+                        that has been on-screen */
+                       GtkTextMark *pager_position = gtk_text_buffer_create_mark(textbuffer, "pager_position", &end, TRUE);
+                       gtk_text_mark_set_visible(pager_position, TRUE);
                }
                        break;
+
+               case wintype_Graphics:
+               {
+                   GtkWidget *image = gtk_image_new_from_pixmap(NULL, NULL);
+                       gtk_widget_show(image);
+
+                       win->unit_width = 1;
+                       win->unit_height = 1;
+                   win->widget = image;
+                   win->frame = image;
+                       win->background_color = 0x00FFFFFF;
+                               
+                       /* Connect signal handlers */
+                       win->button_press_event_handler = g_signal_connect(image, "button-press-event", G_CALLBACK(on_window_button_press), win);
+                       g_signal_handler_block(image, win->button_press_event_handler);
+                       win->shutdown_keypress_handler = g_signal_connect(image, "key-press-event", G_CALLBACK(on_shutdown_key_press_event), win);
+                       g_signal_handler_block(image, win->shutdown_keypress_handler);                  
+                       win->size_allocate_handler = g_signal_connect(image, "size-allocate", G_CALLBACK(on_graphics_size_allocate), win);
+               }
+                   break;
                        
                default:
                        gdk_threads_leave();
@@ -637,6 +712,7 @@ destroy_windows_below(winid_t win, stream_result_t *result)
                case wintype_Blank:
            case wintype_TextGrid:
                case wintype_TextBuffer:
+               case wintype_Graphics:
                        gtk_widget_unparent(win->frame);
                        break;
 
@@ -660,7 +736,7 @@ free_winids_below(winid_t win)
                free_winids_below(win->window_node->children->data);
                free_winids_below(win->window_node->children->next->data);
        }
-       window_close_common(win);
+       window_close_common(win, FALSE);
 }
 
 /**
@@ -756,7 +832,12 @@ glk_window_close(winid_t win, stream_result_t *result)
        if(pair_node != NULL)
        {
                gboolean new_child_on_left = ( pair_node == g_node_first_sibling(pair_node) );
-               GNode *sibling_node = pair_node->children; /* only one child left */
+
+               /* Lookup our sibling */
+               GNode *sibling_node = pair_node->children;
+               if(sibling_node == win->window_node)
+                       sibling_node = sibling_node->next;
+
                GNode *new_parent_node = pair_node->parent;
                g_node_unlink(pair_node);
                g_node_unlink(sibling_node);
@@ -774,14 +855,15 @@ glk_window_close(winid_t win, stream_result_t *result)
                                g_node_append(new_parent_node, sibling_node);
                }
 
-               window_close_common( (winid_t) pair_node->data );
+               stream_close_common( ((winid_t) pair_node->data)->window_stream, NULL );
+               window_close_common( (winid_t) pair_node->data, TRUE);
        } 
        else /* it was the root window */
        {
                glk_data->root_window = NULL;
        }
 
-       window_close_common(win);
+       window_close_common(win, FALSE);
 
        /* Schedule a redraw */
        g_mutex_lock(glk_data->arrange_lock);
@@ -818,7 +900,8 @@ glk_window_close(winid_t win, stream_result_t *result)
  *  <term>Graphics</term>
  *  <listitem><para>
  *   Clears the entire window to its current background color. See <link
- *   linkend="chimara-Graphics-Windows">Graphics Windows</link>.
+ *   linkend="chimara-The-Types-of-Windows&num;wintype-Graphics">Graphics 
+ *   Windows</link>.
  *  </para></listitem>
  * </varlistentry>
  * <varlistentry>
@@ -891,6 +974,18 @@ glk_window_clear(winid_t win)
                        gdk_threads_leave();
                }
                        break;
+
+               case wintype_Graphics:
+               {
+                       /* Wait for the window's size to be updated */
+                       g_mutex_lock(glk_data->arrange_lock);
+                       if(glk_data->needs_rearrange)
+                               g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
+                       g_mutex_unlock(glk_data->arrange_lock);
+
+                       glk_window_erase_rect(win, 0, 0, win->widget->allocation.width, win->widget->allocation.height);
+               }
+                       break;
                
                default:
                        ILLEGAL_PARAM("Unknown window type: %d", win->type);
@@ -902,7 +997,7 @@ glk_window_clear(winid_t win)
  * @win: A window, or %NULL.
  *
  * Sets the current stream to @win's window stream. It is exactly equivalent to
- * |[ #glk_stream_set_current(#glk_window_get_stream(@win)) ]| 
+ * |[ glk_stream_set_current(glk_window_get_stream(win)) ]| 
  * See <link linkend="chimara-Streams">Streams</link>.
  *
  * <note><title>Chimara</title>
@@ -1056,6 +1151,21 @@ glk_window_get_size(winid_t win, glui32 *widthptr, glui32 *heightptr)
                 *heightptr = (glui32)(win->widget->allocation.height / win->unit_height);
             gdk_threads_leave();
             
+            break;
+
+               case wintype_Graphics:
+                       g_mutex_lock(glk_data->arrange_lock);
+                       if(glk_data->needs_rearrange)
+                               g_cond_wait(glk_data->rearranged, glk_data->arrange_lock);
+                       g_mutex_unlock(glk_data->arrange_lock);
+                       
+            gdk_threads_enter();
+            if(widthptr != NULL)
+                *widthptr = (glui32)(win->widget->allocation.width);
+            if(heightptr != NULL)
+                *heightptr = (glui32)(win->widget->allocation.height);
+            gdk_threads_leave();
+            
             break;
             
         default:
@@ -1081,15 +1191,15 @@ glk_window_get_size(winid_t win, glui32 *widthptr, glui32 *heightptr)
  * Consider the example above, where D has collapsed to zero height. Say D was a
  * text buffer window. You could make a more useful layout by doing
  * |[
- * #winid_t o2;
- * o2 = #glk_window_get_parent(d);
- * glk_window_set_arrangement(o2, #winmethod_Above | #winmethod_Fixed, 3, d);
+ * winid_t o2;
+ * o2 = glk_window_get_parent(d);
+ * glk_window_set_arrangement(o2, winmethod_Above | winmethod_Fixed, 3, d);
  * ]|
  * That would set D (the upper child of O2) to be O2's key window, and give it a
  * fixed size of 3 rows.
  * 
  * If you later wanted to expand D, you could do
- * |[ glk_window_set_arrangement(o2, #winmethod_Above | #winmethod_Fixed, 5, NULL); ]|
+ * |[ glk_window_set_arrangement(o2, winmethod_Above | winmethod_Fixed, 5, NULL); ]|
  * That expands D to five rows. Note that, since O2's key window is already set 
  * to D, it is not necessary to provide the @keywin argument; you can pass %NULL
  * to mean <quote>leave the key window unchanged.</quote>
@@ -1099,18 +1209,18 @@ glk_window_get_size(winid_t win, glui32 *widthptr, glui32 *heightptr)
  * example, you could change O2's key window to be A, but not B. The key window
  * also cannot be a pair window itself.
  * 
- * |[ glk_window_set_arrangement(o2, #winmethod_Below | #winmethod_Fixed, 3, NULL); ]|
+ * |[ glk_window_set_arrangement(o2, winmethod_Below | winmethod_Fixed, 3, NULL); ]|
  * This changes the constraint to be on the <emphasis>lower</emphasis> child of 
  * O2, which is A. The key window is still D; so A would then be three rows high
  * as measured in D's font, and D would get the rest of O2's space. That may not
  * be what you want. To set A to be three rows high as measured in A's font, you
  * would do
- * |[ glk_window_set_arrangement(o2, #winmethod_Below | #winmethod_Fixed, 3, a); ]|
+ * |[ glk_window_set_arrangement(o2, winmethod_Below | winmethod_Fixed, 3, a); ]|
  * 
  * Or you could change O2 to a proportional split:
- * |[ glk_window_set_arrangement(o2, #winmethod_Below | #winmethod_Proportional, 30, NULL); ]|
+ * |[ glk_window_set_arrangement(o2, winmethod_Below | winmethod_Proportional, 30, NULL); ]|
  * or
- * |[ glk_window_set_arrangement(o2, #winmethod_Above | #winmethod_Proportional, 70, NULL); ]|
+ * |[ glk_window_set_arrangement(o2, winmethod_Above | winmethod_Proportional, 70, NULL); ]|
  * These do exactly the same thing, since 30&percnt; above is the same as 
  * 70&percnt; below. You don't need to specify a key window with a proportional
  * split, so the @keywin argument is %NULL. (You could actually specify either A
@@ -1217,6 +1327,8 @@ glk_window_move_cursor(winid_t win, glui32 xpos, glui32 ypos)
        VALID_WINDOW(win, return);
        g_return_if_fail(win->type == wintype_TextGrid);
 
+       flush_window_buffer(win);
+
        ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
        
        /* Wait until the window's size is current */
@@ -1235,6 +1347,7 @@ glk_window_move_cursor(winid_t win, glui32 xpos, glui32 ypos)
            ypos += xpos / win->width;
            xpos %= win->width;
        }
+
        /* Go to the end if the cursor is moved off the bottom edge */
        if(ypos >= win->height)
        {