Fix documentation typo
[projects/chimara/chimara.git] / libchimara / style.c
index 6cd3bd0b53762ec243c4170b0b6246218800e513..125dbd6d38128c41032eba935b7a34a4c1d25ca7 100644 (file)
@@ -13,7 +13,6 @@ extern GPrivate *glk_data_key;
 static gboolean style_accept(GScanner *scanner, GTokenType token);
 static gboolean style_accept_style_selector(GScanner *scanner, ChimaraGlk *glk);
 static gboolean style_accept_style_hint(GScanner *scanner, GtkTextTag *current_tag);
-static void style_add_tag_to_textbuffer(gpointer key, gpointer tag, gpointer tag_table);
 static void style_copy_tag_to_textbuffer(gpointer key, gpointer tag, gpointer target_table);
 static void text_tag_to_attr_list(GtkTextTag *tag, PangoAttrList *list);
 GtkTextTag* gtk_text_tag_copy(GtkTextTag *tag);
@@ -147,6 +146,9 @@ style_init_textbuffer(GtkTextBuffer *buffer)
 
        /* Copy the override text tags to the textbuffers's tag table */
        g_hash_table_foreach(glk_data->glk_styles->text_buffer, style_copy_tag_to_textbuffer, gtk_text_buffer_get_tag_table(buffer));
+
+       /* Assign the 'default' tag the lowest priority */
+       gtk_text_tag_set_priority( gtk_text_tag_table_lookup(gtk_text_buffer_get_tag_table(buffer), "default"), 0 );
 }
 
 
@@ -163,17 +165,9 @@ style_init_textgrid(GtkTextBuffer *buffer)
 
        /* Copy the current text tags to the textbuffers's tag table */
        g_hash_table_foreach(glk_data->glk_styles->text_grid, style_copy_tag_to_textbuffer, gtk_text_buffer_get_tag_table(buffer));
-}
-
-/* Internal function used to iterate over the default text tag table, applying them to a textbuffer */
-static void
-style_add_tag_to_textbuffer(gpointer key, gpointer tag, gpointer tag_table)
-{
-       g_return_if_fail(key != NULL);
-       g_return_if_fail(tag != NULL);
-       g_return_if_fail(tag_table != NULL);
 
-       gtk_text_tag_table_add(tag_table, tag);
+       /* Assign the 'default' tag the lowest priority */
+       gtk_text_tag_set_priority( gtk_text_tag_table_lookup(gtk_text_buffer_get_tag_table(buffer), "default"), 0 );
 }
 
 /* Internal function used to iterate over a style table, copying it */
@@ -245,136 +239,108 @@ style_init(ChimaraGlk *glk)
        GHashTable *glk_text_buffer_styles = g_hash_table_new_full(g_str_hash, g_str_equal, NULL, g_object_unref);
        GtkTextTag *tag;
 
-       PangoFontDescription *default_font_desc = pango_font_description_from_string("Serif");
-       PangoFontDescription *monospace_font_desc = pango_font_description_from_string("Monospace");
-       
        /* Initialise the default styles for a text grid */
        tag = gtk_text_tag_new("default");
-       g_object_set(tag, "font-desc", monospace_font_desc, NULL);
+       g_object_set(tag, "family", "Monospace", "family-set", TRUE, NULL);
        g_hash_table_insert(default_text_grid_styles, "default", tag);
 
        tag = gtk_text_tag_new("normal");
-       //g_object_set(tag, "font-desc", monospace_font_desc, NULL);
        g_hash_table_insert(default_text_grid_styles, "normal", tag);
 
        tag = gtk_text_tag_new("emphasized");
-       //g_object_set(tag, "font-desc", monospace_font_desc, "style", PANGO_STYLE_ITALIC, "style-set", TRUE, NULL);
        g_object_set(tag, "style", PANGO_STYLE_ITALIC, "style-set", TRUE, NULL);
        g_hash_table_insert(default_text_grid_styles, "emphasized", tag);
 
        tag = gtk_text_tag_new("preformatted");
-       g_object_set(tag, "font-desc", monospace_font_desc, NULL);
        g_hash_table_insert(default_text_grid_styles, "preformatted", tag);
 
        tag = gtk_text_tag_new("header");
-       //g_object_set(tag, "font-desc", monospace_font_desc, "weight", PANGO_WEIGHT_BOLD, NULL);
-       g_object_set(tag, "weight", PANGO_WEIGHT_BOLD, NULL);
+       g_object_set(tag, "weight", PANGO_WEIGHT_BOLD, "weight-set", TRUE, NULL);
        g_hash_table_insert(default_text_grid_styles, "header", tag);
 
        tag = gtk_text_tag_new("subheader");
-       //g_object_set(tag, "font-desc", monospace_font_desc, "weight", PANGO_WEIGHT_BOLD, NULL);
-       g_object_set(tag, "weight", PANGO_WEIGHT_BOLD, NULL);
+       g_object_set(tag, "weight", PANGO_WEIGHT_BOLD, "weight-set", TRUE, NULL);
        g_hash_table_insert(default_text_grid_styles, "subheader", tag);
 
        tag = gtk_text_tag_new("alert");
-       //g_object_set(tag, "font-desc", monospace_font_desc, "foreground", "#aa0000", "weight", PANGO_WEIGHT_BOLD, NULL);
-       g_object_set(tag, "foreground", "#aa0000", "weight", PANGO_WEIGHT_BOLD, NULL);
+       g_object_set(tag, "foreground", "#aa0000", "foreground-set", TRUE, "weight", PANGO_WEIGHT_BOLD, "weight-set", TRUE, NULL);
        g_hash_table_insert(default_text_grid_styles, "alert", tag);
 
        tag = gtk_text_tag_new("note");
-       //g_object_set(tag, "font-desc", monospace_font_desc, "foreground", "#aaaa00", "weight", PANGO_WEIGHT_BOLD, NULL);
-       g_object_set(tag, "foreground", "#aaaa00", "weight", PANGO_WEIGHT_BOLD, NULL);
+       g_object_set(tag, "foreground", "#aaaa00", "foreground-set", TRUE, "weight", PANGO_WEIGHT_BOLD, "weight-set", TRUE, NULL);
        g_hash_table_insert(default_text_grid_styles, "note", tag);
 
        tag = gtk_text_tag_new("block-quote");
-       //g_object_set(tag, "font-desc", monospace_font_desc, "style", PANGO_STYLE_ITALIC, "style-set", TRUE, NULL);
        g_object_set(tag, "style", PANGO_STYLE_ITALIC, "style-set", TRUE, NULL);
        g_hash_table_insert(default_text_grid_styles, "block-quote", tag);
 
        tag = gtk_text_tag_new("input");
-       //g_object_set(tag, "font-desc", monospace_font_desc, NULL);
        g_hash_table_insert(default_text_grid_styles, "input", tag);
 
        tag = gtk_text_tag_new("user1");
-       //g_object_set(tag, "font-desc", monospace_font_desc, NULL);
        g_hash_table_insert(default_text_grid_styles, "user1", tag);
 
        tag = gtk_text_tag_new("user2");
-       //g_object_set(tag, "font-desc", monospace_font_desc, NULL);
        g_hash_table_insert(default_text_grid_styles, "user2", tag);
 
        tag = gtk_text_tag_new("hyperlink");
-       g_object_set(tag, "foreground", "#0000ff", "underline", PANGO_UNDERLINE_SINGLE, "underline-set", TRUE, NULL);
+       g_object_set(tag, "foreground", "#0000ff", "foreground-set", TRUE, "underline", PANGO_UNDERLINE_SINGLE, "underline-set", TRUE, NULL);
        g_hash_table_insert(default_text_grid_styles, "hyperlink", tag);
 
        /* Initialise the default styles for a text buffer */
        tag = gtk_text_tag_new("default");
-       g_object_set(tag, "font-desc", default_font_desc, NULL);
+       g_object_set(tag, "family", "Serif", "family-set", TRUE, NULL);
        g_hash_table_insert(default_text_buffer_styles, "default", tag);
 
        tag = gtk_text_tag_new("normal");
-       //g_object_set(tag, "font-desc", default_font_desc, NULL);
        g_hash_table_insert(default_text_buffer_styles, "normal", tag);
 
        tag = gtk_text_tag_new("emphasized");
-       //g_object_set(tag, "font-desc", default_font_desc, "style", PANGO_STYLE_ITALIC, "style-set", TRUE, NULL);
        g_object_set(tag, "style", PANGO_STYLE_ITALIC, "style-set", TRUE, NULL);
        g_hash_table_insert(default_text_buffer_styles, "emphasized", tag);
 
        tag = gtk_text_tag_new("preformatted");
-       g_object_set(tag, "font-desc", monospace_font_desc, NULL);
+       g_object_set(tag, "family", "Monospace", "family-set", TRUE, NULL);
        g_hash_table_insert(default_text_buffer_styles, "preformatted", tag);
 
        tag = gtk_text_tag_new("header");
-       //g_object_set(tag, "font-desc", default_font_desc, "size-points", 18.0, "weight", PANGO_WEIGHT_BOLD, NULL);
-       g_object_set(tag, "weight", PANGO_WEIGHT_BOLD, NULL);
+       g_object_set(tag, "weight", PANGO_WEIGHT_BOLD, "weight-set", TRUE, NULL);
        g_hash_table_insert(default_text_buffer_styles, "header", tag);
 
        tag = gtk_text_tag_new("subheader");
-       //g_object_set(tag, "font-desc", default_font_desc, "size-points", 14.0, "weight", PANGO_WEIGHT_BOLD, NULL);
-       g_object_set(tag, "weight", PANGO_WEIGHT_BOLD, NULL);
+       g_object_set(tag, "weight", PANGO_WEIGHT_BOLD, "weight-set", TRUE, NULL);
        g_hash_table_insert(default_text_buffer_styles, "subheader", tag);
 
        tag = gtk_text_tag_new("alert");
-       //g_object_set(tag, "font-desc", default_font_desc, "foreground", "#aa0000", "weight", PANGO_WEIGHT_BOLD, NULL);
-       g_object_set(tag, "foreground", "#aa0000", "weight", PANGO_WEIGHT_BOLD, NULL);
+       g_object_set(tag, "foreground", "#aa0000", "foreground-set", TRUE, "weight", PANGO_WEIGHT_BOLD, "weight-set", TRUE, NULL);
        g_hash_table_insert(default_text_buffer_styles, "alert", tag);
 
        tag = gtk_text_tag_new("note");
-       //g_object_set(tag, "font-desc", default_font_desc, "foreground", "#aaaa00", "weight", PANGO_WEIGHT_BOLD, NULL);
-       g_object_set(tag, "foreground", "#aaaa00", "weight", PANGO_WEIGHT_BOLD, NULL);
+       g_object_set(tag, "foreground", "#aaaa00", "foreground-set", TRUE, "weight", PANGO_WEIGHT_BOLD, "weight-set", TRUE, NULL);
        g_hash_table_insert(default_text_buffer_styles, "note", tag);
 
        tag = gtk_text_tag_new("block-quote");
-       //g_object_set(tag, "font-desc", default_font_desc, "justification", GTK_JUSTIFY_CENTER, "style", PANGO_STYLE_ITALIC, "style-set", TRUE, NULL);
-       g_object_set(tag, "justification", GTK_JUSTIFY_CENTER, "style", PANGO_STYLE_ITALIC, "style-set", TRUE, NULL);
+       g_object_set(tag, "justification", GTK_JUSTIFY_CENTER, "justification-set", TRUE, "style", PANGO_STYLE_ITALIC, "style-set", TRUE, NULL);
        g_hash_table_insert(default_text_buffer_styles, "block-quote", tag);
 
        tag = gtk_text_tag_new("input");
-       //g_object_set(tag, "font-desc", default_font_desc, NULL);
        g_hash_table_insert(default_text_buffer_styles, "input", tag);
 
        tag = gtk_text_tag_new("user1");
-       //g_object_set(tag, "font-desc", default_font_desc, NULL);
        g_hash_table_insert(default_text_buffer_styles, "user1", tag);
 
        tag = gtk_text_tag_new("user2");
-       //g_object_set(tag, "font-desc", default_font_desc, NULL);
        g_hash_table_insert(default_text_buffer_styles, "user2", tag);
 
        tag = gtk_text_tag_new("hyperlink");
-       //g_object_set(tag, "font-desc", default_font_desc, "foreground", "#0000ff", "underline", PANGO_UNDERLINE_SINGLE, "underline-set", TRUE, NULL);
-       g_object_set(tag, "foreground", "#0000ff", "underline", PANGO_UNDERLINE_SINGLE, "underline-set", TRUE, NULL);
+       g_object_set(tag, "foreground", "#0000ff", "foreground-set", TRUE, "underline", PANGO_UNDERLINE_SINGLE, "underline-set", TRUE, NULL);
        g_hash_table_insert(default_text_buffer_styles, "hyperlink", tag);
 
        GtkTextTag *pager_tag = gtk_text_tag_new("pager");
-       g_object_set(pager_tag, "font-desc", default_font_desc, "foreground", "#ffffff", "background", "#000000", NULL);
+       g_object_set(pager_tag, "family", "Monospace", "family-set", TRUE, "foreground", "#ffffff", "foreground-set", TRUE, "background", "#000000", "background-set", TRUE, NULL);
        g_hash_table_insert(default_text_buffer_styles, "pager", pager_tag);
        text_tag_to_attr_list(pager_tag, priv->pager_attr_list);
 
-       pango_font_description_free(default_font_desc);
-       pango_font_description_free(monospace_font_desc);
-       
        priv->styles->text_grid = default_text_grid_styles;
        priv->styles->text_buffer = default_text_buffer_styles;
 
@@ -400,21 +366,6 @@ reset_default_styles(ChimaraGlk *glk)
        /* TODO: write this function */
 }
 
-/* Copy the default styles to the current styles
- FIXME: This function is temporary and will not be needed later on */
-void
-copy_default_styles_to_current_styles(ChimaraGlk *glk)
-{
-       /*
-       CHIMARA_GLK_USE_PRIVATE(glk, priv);
-       g_hash_table_foreach(priv->styles->text_grid, style_table_copy, priv->glk_styles->text_grid);
-       g_hash_table_foreach(priv->styles->text_buffer, style_table_copy, priv->glk_styles->text_buffer);
-
-       GtkTextTag *pager_tag = GTK_TEXT_TAG( g_hash_table_lookup(priv->styles->text_buffer, "pager") );
-       text_tag_to_attr_list(pager_tag, priv->pager_attr_list);
-       */
-}
-
 /* Create the CSS file scanner */
 GScanner *
 create_css_file_scanner(void)
@@ -432,8 +383,6 @@ create_css_file_scanner(void)
 void
 scan_css_file(GScanner *scanner, ChimaraGlk *glk)
 {
-       CHIMARA_GLK_USE_PRIVATE(glk, priv);
-
        while( g_scanner_peek_next_token(scanner) != G_TOKEN_EOF) {
                if( !style_accept_style_selector(scanner, glk) )
                        break;
@@ -442,8 +391,7 @@ scan_css_file(GScanner *scanner, ChimaraGlk *glk)
        g_scanner_destroy(scanner);
 
        /* Update the pager prompt to the new style */
-       GtkTextTag *pager_tag = GTK_TEXT_TAG( g_hash_table_lookup(priv->styles->text_buffer, "pager") );
-       text_tag_to_attr_list(pager_tag, priv->pager_attr_list);
+       style_update(glk);
 }
 
 /* Internal function: parses a token */
@@ -672,6 +620,26 @@ glkcolor_to_gdkcolor(glui32 val, GdkColor *color)
        color->blue = 256 * (val & 0x0000ff);
 }
 
+/* Internal function: parses a glk color to a hex string */
+gchar*
+glkcolor_to_hex(glui32 val)
+{
+       return g_strdup_printf("%04X%04X%04X",
+               256 * ((val & 0xff0000) >> 16),
+               256 * ((val & 0x00ff00) >> 8),
+               256 * (val & 0x0000ff)
+       );
+}
+
+/* Internal function: parses a gdk color to a hex string */
+gchar*
+gdkcolor_to_hex(GdkColor *color)
+{
+       return g_strdup_printf("%04X%04X%04X",
+               color->red, color->green, color->blue
+       );
+}
+
 /* Internal function: parses a GdkColor to a glk color */
 static glui32
 gdkcolor_to_glkcolor(GdkColor *color)
@@ -753,11 +721,18 @@ apply_stylehint_to_tag(GtkTextTag *tag, glui32 wintype, glui32 styl, glui32 hint
        case stylehint_Proportional:
        {
                gchar *font_family;
-               GtkTextTag *font_tag = g_hash_table_lookup(
-                   wintype == wintype_TextBuffer? glk_data->styles->text_buffer : glk_data->styles->text_grid,
-                   val? "default" : "preformatted");
-               g_object_get(font_tag, "family", &font_family, NULL);
-               g_object_set(tag_object, "family", font_family, "family-set", TRUE, NULL);
+               gboolean family_set;
+
+               if(wintype != wintype_TextBuffer) {
+                       if(val)
+                               WARNING("Style hint 'propotional' only supported on text buffers.");
+
+                       break;
+               }
+
+               GtkTextTag *font_tag = g_hash_table_lookup(glk_data->styles->text_buffer, val? "default" : "preformatted");
+               g_object_get(font_tag, "family", &font_family, "family-set", &family_set, NULL);
+               g_object_set(tag_object, "family", font_family, "family-set", family_set, NULL);
                g_free(font_family);
        }
                break;
@@ -1082,6 +1057,9 @@ glk_style_distinguish(winid_t win, glui32 styl1, glui32 styl2)
  *   colors are reversed.</para></listitem>
  * </varlistentry>
  * </variablelist>
+ * Signed values, such as the %stylehint_Weight value, are cast to
+ * <type>glui32</type>. They may be cast to <type>glsi32</type> to be dealt with
+ * in a more natural context.
  * 
  * Returns: TRUE upon successul retrieval, otherwise FALSE.
  */
@@ -1124,17 +1102,17 @@ get_current_font(guint32 wintype)
        switch(wintype) {
        case wintype_TextGrid:
                tag = g_hash_table_lookup(glk_data->styles->text_grid, "default");
+               return pango_font_description_from_string("Monospace");
                break;
        case wintype_TextBuffer:
                tag = g_hash_table_lookup(glk_data->styles->text_buffer, "default");
+               return pango_font_description_from_string("Serif");
                break;
        default:
                return NULL;
        }
 
        PangoFontDescription *font;
-       g_object_get( G_OBJECT(tag), "font-desc", &font, NULL );
-
        return font;
 }
 
@@ -1172,7 +1150,8 @@ text_tag_to_attr_list(GtkTextTag *tag, PangoAttrList *list)
        }
 
        /* Font description updates the following properties simultaniously:
-        * family, style, weight, variant, stretch, size
+        * family, style, weight, variant, stretch, size.
+        * FIXME: Except it doesn't really.
         */
        g_object_get(tag, "font-desc", &font_desc, NULL);
        pango_attr_list_insert(
@@ -1196,7 +1175,7 @@ text_tag_to_attr_list(GtkTextTag *tag, PangoAttrList *list)
        }
 }
 
-/* Update pager and reverse video tags */
+/* Update pager tag */
 void
 style_update(ChimaraGlk *glk)
 {