make the internal window type more easily inheritable
[mikachu/openbox.git] / render / font.c
index 3d2e1ed..369f262 100644 (file)
@@ -2,7 +2,7 @@
 
    font.c for the Openbox window manager
    Copyright (c) 2006        Mikael Magnusson
-   Copyright (c) 2003        Ben Jansens
+   Copyright (c) 2003-2007   Dana Jansens
    Copyright (c) 2003        Derek Foreman
 
    This program is free software; you can redistribute it and/or modify
 #include <stdlib.h>
 #include <locale.h>
 
-#define OB_SHADOW "shadow"
-#define OB_SHADOW_OFFSET "shadowoffset"
-#define OB_SHADOW_ALPHA "shadowtint"
-
-FcObjectType objs[] = {
-    { OB_SHADOW,        FcTypeBool    },
-    { OB_SHADOW_OFFSET, FcTypeInteger },
-    { OB_SHADOW_ALPHA,  FcTypeInteger  }
-};
-
-static gboolean started = FALSE;
-
-static void font_startup(void)
-{
-    if (!XftInit(0)) {
-        g_warning(_("Couldn't initialize Xft."));
-        exit(EXIT_FAILURE);
-    }
-
-    /* Here we are teaching xft about the shadow, shadowoffset & shadowtint */
-    FcNameRegisterObjectTypes(objs, (sizeof(objs) / sizeof(objs[0])));
-}
-
 static void measure_font(const RrInstance *inst, RrFont *f)
 {
     PangoFontMetrics *metrics;
-    gchar *locale, *p;
-
-    /* get the default language from the locale
-       (based on gtk_get_default_language in gtkmain.c) */
-    locale = g_strdup(setlocale(LC_CTYPE, NULL));
-    if ((p = strchr(locale, '.'))) *p = '\0'; /* strip off the . */
-    if ((p = strchr(locale, '@'))) *p = '\0'; /* strip off the @ */
+    static PangoLanguage *lang = NULL;
+
+    if (lang == NULL) {
+#if PANGO_VERSION_MAJOR > 1 || \
+    (PANGO_VERSION_MAJOR == 1 && PANGO_VERSION_MINOR >= 16)
+        lang = pango_language_get_default();
+#else
+        gchar *locale, *p;
+        /* get the default language from the locale
+           (based on gtk_get_default_language in gtkmain.c) */
+        locale = g_strdup(setlocale(LC_CTYPE, NULL));
+        if ((p = strchr(locale, '.'))) *p = '\0'; /* strip off the . */
+        if ((p = strchr(locale, '@'))) *p = '\0'; /* strip off the @ */
+        lang = pango_language_from_string(locale);
+        g_free(locale);
+#endif
+    }
 
     /* measure the ascent and descent */
-    metrics = pango_context_get_metrics(inst->pango, f->font_desc,
-                                        pango_language_from_string(locale));
+    metrics = pango_context_get_metrics(inst->pango, f->font_desc, lang);
     f->ascent = pango_font_metrics_get_ascent(metrics);
     f->descent = pango_font_metrics_get_descent(metrics);
     pango_font_metrics_unref(metrics);
 
-    g_free(locale);
 }
 
-static RrFont *openfont(const RrInstance *inst, gchar *fontstring)
+RrFont *RrFontOpen(const RrInstance *inst, const gchar *name, gint size,
+                   RrFontWeight weight, RrFontSlant slant)
 {
-    /* This function is called for each font in the theme file. */
-    /* It returns a pointer to a RrFont struct after filling it. */
     RrFont *out;
-    FcPattern *pat;
-    gint tint;
-    gchar *sval;
-    gint ival;
-
-    if (!(pat = XftNameParse(fontstring)))
-        return NULL;
+    PangoWeight pweight;
+    PangoStyle pstyle;
+    PangoAttrList *attrlist;
 
     out = g_new(RrFont, 1);
     out->inst = inst;
+    out->ref = 1;
     out->font_desc = pango_font_description_new();
     out->layout = pango_layout_new(inst->pango);
-
-    /* get the data from the parsed xft string */
-
-    /* get the family */
-    if (FcPatternGetString(pat, "family", 0,
-                           (FcChar8**)&sval) == FcResultMatch)
-        pango_font_description_set_family(out->font_desc, sval);
-    
-    /* get the weight */
-    if (FcPatternGetInteger(pat, "weight", 0, &ival) == FcResultMatch) {
-        if (ival == FC_WEIGHT_LIGHT)
-            pango_font_description_set_weight(out->font_desc,
-                                              PANGO_WEIGHT_LIGHT);
-        else if (ival == FC_WEIGHT_DEMIBOLD)
-            pango_font_description_set_weight(out->font_desc,
-                                              PANGO_WEIGHT_SEMIBOLD);
-        else if (ival == FC_WEIGHT_BOLD)
-            pango_font_description_set_weight(out->font_desc,
-                                              PANGO_WEIGHT_BOLD);
-        else if (ival == FC_WEIGHT_BLACK)
-            pango_font_description_set_weight(out->font_desc,
-                                              PANGO_WEIGHT_ULTRABOLD);
+    out->shortcut_underline = pango_attr_underline_new(PANGO_UNDERLINE_LOW);
+    out->shortcut_underline->start_index = 0;
+    out->shortcut_underline->end_index = 0;
+
+    attrlist = pango_attr_list_new();
+    /* shortcut_underline is owned by the attrlist */
+    pango_attr_list_insert(attrlist, out->shortcut_underline);
+    /* the attributes are owned by the layout */
+    pango_layout_set_attributes(out->layout, attrlist);
+    pango_attr_list_unref(attrlist);
+
+    switch (weight) {
+    case RR_FONTWEIGHT_LIGHT:     pweight = PANGO_WEIGHT_LIGHT;     break;
+    case RR_FONTWEIGHT_NORMAL:    pweight = PANGO_WEIGHT_NORMAL;    break;
+    case RR_FONTWEIGHT_SEMIBOLD:  pweight = PANGO_WEIGHT_SEMIBOLD;  break;
+    case RR_FONTWEIGHT_BOLD:      pweight = PANGO_WEIGHT_BOLD;      break;
+    case RR_FONTWEIGHT_ULTRABOLD: pweight = PANGO_WEIGHT_ULTRABOLD; break;
+    default: g_assert_not_reached();
     }
 
-    /* get the style/slant */
-    if (FcPatternGetInteger(pat, "slant", 0, &ival) == FcResultMatch) {
-        if (ival == FC_SLANT_ITALIC)
-            pango_font_description_set_style(out->font_desc,
-                                             PANGO_STYLE_ITALIC);
-        else if (ival == FC_SLANT_OBLIQUE)
-            pango_font_description_set_style(out->font_desc,
-                                             PANGO_STYLE_OBLIQUE);
+    switch (slant) {
+    case RR_FONTSLANT_NORMAL:  pstyle = PANGO_STYLE_NORMAL;    break;
+    case RR_FONTSLANT_ITALIC:  pstyle = PANGO_STYLE_ITALIC;    break;
+    case RR_FONTSLANT_OBLIQUE: pstyle = PANGO_STYLE_OBLIQUE;   break;
+    default: g_assert_not_reached();
     }
 
-    /* get the size */
-    if (FcPatternGetInteger(pat, "size", 0, &ival) == FcResultMatch)
-        pango_font_description_set_size(out->font_desc, ival * PANGO_SCALE);
-    else if (FcPatternGetInteger(pat, "pixelsize", 0, &ival) == FcResultMatch)
-        pango_font_description_set_absolute_size(out->font_desc,
-                                                 ival * PANGO_SCALE);
-
-    if (FcPatternGetBool(pat, OB_SHADOW, 0, &out->shadow) != FcResultMatch)
-        out->shadow = FALSE;
-
-    if (FcPatternGetInteger(pat, OB_SHADOW_OFFSET, 0, &out->offset) !=
-        FcResultMatch)
-        out->offset = 1;
-
-    if (FcPatternGetInteger(pat, OB_SHADOW_ALPHA, 0, &tint) != FcResultMatch)
-        tint = 25;
-    if (tint > 100) tint = 100;
-    else if (tint < -100) tint = -100;
-    out->tint = tint;
+    /* setup the font */
+    pango_font_description_set_family(out->font_desc, name);
+    pango_font_description_set_weight(out->font_desc, pweight);
+    pango_font_description_set_style(out->font_desc, pstyle);
+    pango_font_description_set_size(out->font_desc, size * PANGO_SCALE);
 
     /* setup the layout */
     pango_layout_set_font_description(out->layout, out->font_desc);
     pango_layout_set_single_paragraph_mode(out->layout, TRUE);
-    pango_layout_set_ellipsize(out->layout, PANGO_ELLIPSIZE_MIDDLE);
 
     /* get the ascent and descent */
     measure_font(inst, out);
@@ -157,60 +116,64 @@ static RrFont *openfont(const RrInstance *inst, gchar *fontstring)
     return out;
 }
 
-RrFont *RrFontOpen(const RrInstance *inst, gchar *fontstring)
+RrFont *RrFontOpenDefault(const RrInstance *inst)
 {
-    RrFont *out;
-
-    if (!started) {
-        font_startup();
-        started = TRUE;
-    }
-
-    if ((out = openfont(inst, fontstring)))
-        return out;
-    g_warning(_("Unable to load font: %s\n"), fontstring);
-    g_warning(_("Trying fallback font: %s\n"), "sans");
-
-    if ((out = openfont(inst, "sans")))
-        return out;
-    g_warning(_("Unable to load font: %s\n"), "sans");
+    return RrFontOpen(inst, RrDefaultFontFamily, RrDefaultFontSize,
+                      RrDefaultFontWeight, RrDefaultFontSlant);
+}
 
-    return NULL;
+void RrFontRef(RrFont *f)
+{
+    ++f->ref;
 }
 
 void RrFontClose(RrFont *f)
 {
     if (f) {
-        g_object_unref(f->layout);
-        pango_font_description_free(f->font_desc);
-        g_free(f);
+        if (--f->ref < 1) {
+            g_object_unref(f->layout);
+            pango_font_description_free(f->font_desc);
+            g_free(f);
+        }
     }
 }
 
 static void font_measure_full(const RrFont *f, const gchar *str,
-                              gint *x, gint *y)
+                              gint *x, gint *y, gint shadow_x, gint shadow_y)
 {
     PangoRectangle rect;
 
     pango_layout_set_text(f->layout, str, -1);
     pango_layout_set_width(f->layout, -1);
-    pango_layout_get_pixel_extents(f->layout, NULL, &rect);
-    *x = rect.width + (f->shadow ? ABS(f->offset) : 0);
-    *y = rect.height + (f->shadow ? ABS(f->offset) : 0);
+
+    /* pango_layout_get_pixel_extents lies! this is the right way to get the
+       size of the text's area */
+    pango_layout_get_extents(f->layout, NULL, &rect);
+#if PANGO_VERSION_MAJOR > 1 || \
+    (PANGO_VERSION_MAJOR == 1 && PANGO_VERSION_MINOR >= 16)
+    /* pass the logical rect as the ink rect, this is on purpose so we get the
+       full area for the text */
+    pango_extents_to_pixels(&rect, NULL);
+#else
+    rect.width = (rect.width + PANGO_SCALE - 1) / PANGO_SCALE;
+    rect.height = (rect.height + PANGO_SCALE - 1) / PANGO_SCALE;
+#endif
+    *x = rect.width + ABS(shadow_x) + 4 /* we put a 2 px edge on each side */;
+    *y = rect.height + ABS(shadow_y);
 }
 
-RrSize *RrFontMeasureString(const RrFont *f, const gchar *str)
+RrSize *RrFontMeasureString(const RrFont *f, const gchar *str,
+                            gint shadow_x, gint shadow_y)
 {
     RrSize *size;
     size = g_new(RrSize, 1);
-    font_measure_full(f, str, &size->width, &size->height);
+    font_measure_full(f, str, &size->width, &size->height, shadow_x, shadow_y);
     return size;
 }
 
-gint RrFontHeight(const RrFont *f)
+gint RrFontHeight(const RrFont *f, gint shadow_y)
 {
-    return (f->ascent + f->descent) / PANGO_SCALE +
-        (f->shadow ? f->offset : 0);
+    return (f->ascent + f->descent) / PANGO_SCALE + ABS(shadow_y);
 }
 
 static inline int font_calculate_baseline(RrFont *f, gint height)
@@ -242,6 +205,8 @@ void RrFontDraw(XftDraw *d, RrTextureText *t, RrRect *area)
     XftColor c;
     gint mw;
     PangoRectangle rect;
+    PangoAttrList *attrlist;
+    PangoEllipsizeMode ell;
 
     /* center the text vertically
        We do this centering based on the 'baseline' since different fonts have
@@ -255,13 +220,31 @@ void RrFontDraw(XftDraw *d, RrTextureText *t, RrRect *area)
     w = area->width - 4;
     h = area->height;
 
+    switch (t->ellipsize) {
+    case RR_ELLIPSIZE_NONE:
+        ell = PANGO_ELLIPSIZE_NONE;
+        break;
+    case RR_ELLIPSIZE_START:
+        ell = PANGO_ELLIPSIZE_START;
+        break;
+    case RR_ELLIPSIZE_MIDDLE:
+        ell = PANGO_ELLIPSIZE_MIDDLE;
+        break;
+    case RR_ELLIPSIZE_END:
+        ell = PANGO_ELLIPSIZE_END;
+        break;
+    }
+
     pango_layout_set_text(t->font->layout, t->string, -1);
     pango_layout_set_width(t->font->layout, w * PANGO_SCALE);
+    pango_layout_set_ellipsize(t->font->layout, ell);
+
+    /* * * end of setting up the layout * * */
 
     pango_layout_get_pixel_extents(t->font->layout, NULL, &rect);
     mw = rect.width;
 
-    /* pango_layout_set_alignment doesn't work with 
+    /* pango_layout_set_alignment doesn't work with
        pango_xft_render_layout_line */
     switch (t->justify) {
     case RR_JUSTIFY_LEFT:
@@ -274,27 +257,29 @@ void RrFontDraw(XftDraw *d, RrTextureText *t, RrRect *area)
         break;
     }
 
-    if (t->font->shadow) {
-        if (t->font->tint >= 0) {
-            c.color.red = 0;
-            c.color.green = 0;
-            c.color.blue = 0;
-            c.color.alpha = 0xffff * t->font->tint / 100;
-            c.pixel = BlackPixel(RrDisplay(t->font->inst),
-                                 RrScreen(t->font->inst));
-        } else {
-            c.color.red = 0xffff;
-            c.color.green = 0xffff;
-            c.color.blue = 0xffff;
-            c.color.alpha = 0xffff * -t->font->tint / 100;
-            c.pixel = WhitePixel(RrDisplay(t->font->inst),
-                                 RrScreen(t->font->inst));
-        }
+    if (t->shadow_offset_x || t->shadow_offset_y) {
+        /* From nvidia's readme (chapter 23):
+
+           When rendering to a 32-bit window, keep in mind that the X RENDER
+           extension, used by most composite managers, expects "premultiplied
+           alpha" colors. This means that if your color has components (r,g,b)
+           and alpha value a, then you must render (a*r, a*g, a*b, a) into the
+           target window.
+        */
+        c.color.red = (t->shadow_color->r | t->shadow_color->r << 8) *
+            t->shadow_alpha / 255;
+        c.color.green = (t->shadow_color->g | t->shadow_color->g << 8) *
+            t->shadow_alpha / 255;
+        c.color.blue = (t->shadow_color->b | t->shadow_color->b << 8) *
+            t->shadow_alpha / 255;
+        c.color.alpha = 0xffff * t->shadow_alpha / 255;
+        c.pixel = t->shadow_color->pixel;
+
         /* see below... */
         pango_xft_render_layout_line
             (d, &c, pango_layout_get_line(t->font->layout, 0),
-             (x + t->font->offset) * PANGO_SCALE,
-             (y + t->font->offset) * PANGO_SCALE);
+             (x + t->shadow_offset_x) * PANGO_SCALE,
+             (y + t->shadow_offset_y) * PANGO_SCALE);
     }
 
     c.color.red = t->color->r | t->color->r << 8;
@@ -303,9 +288,37 @@ void RrFontDraw(XftDraw *d, RrTextureText *t, RrRect *area)
     c.color.alpha = 0xff | 0xff << 8; /* fully opaque text */
     c.pixel = t->color->pixel;
 
+    if (t->shortcut) {
+        const gchar *s = t->string + t->shortcut_pos;
+
+        t->font->shortcut_underline->start_index = t->shortcut_pos;
+        t->font->shortcut_underline->end_index = t->shortcut_pos +
+            (g_utf8_next_char(s) - s);
+
+        /* the attributes are owned by the layout.
+           re-add the attributes to the layout after changing the
+           start and end index */
+        attrlist = pango_layout_get_attributes(t->font->layout);
+        pango_attr_list_ref(attrlist);
+        pango_layout_set_attributes(t->font->layout, attrlist);
+        pango_attr_list_unref(attrlist);
+    }
+
     /* layout_line() uses y to specify the baseline
        The line doesn't need to be freed, it's a part of the layout */
     pango_xft_render_layout_line
         (d, &c, pango_layout_get_line(t->font->layout, 0),
          x * PANGO_SCALE, y * PANGO_SCALE);
+
+    if (t->shortcut) {
+        t->font->shortcut_underline->start_index = 0;
+        t->font->shortcut_underline->end_index = 0;
+        /* the attributes are owned by the layout.
+           re-add the attributes to the layout after changing the
+           start and end index */
+        attrlist = pango_layout_get_attributes(t->font->layout);
+        pango_attr_list_ref(attrlist);
+        pango_layout_set_attributes(t->font->layout, attrlist);
+        pango_attr_list_unref(attrlist);
+    }
 }