2008-10-31 Emmanuele Bassi <ebassi@linux.intel.com>

* clutter/pango/cogl-pango-fontmap.c:
	* clutter/pango/cogl-pango-render.c: Whitespace fixes and code
	duplication removal. Plus, start documenting the CoglPango API.

ChangeLog

@@ -1,3 +1,9 @@
+2008-10-31  Emmanuele Bassi  <ebassi@linux.intel.com>
+
+	* clutter/pango/cogl-pango-fontmap.c:
+	* clutter/pango/cogl-pango-render.c: Whitespace fixes and code
+	duplication removal. Plus, start documenting the CoglPango API.
+
 2008-10-31  Matthew Allum  <mallum@openedhand.com>
 
 	* clutter/clutter-texture.c: (clutter_texture_set_filter_quality),

clutter/pango/cogl-pango-fontmap.c

@@ -21,6 +21,14 @@
  * License along with this library. If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * SECTION:cogl-pango
+ * @short_description: COGL-based text rendering using Pango
+ *
+ * FIXME
+ *
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
@@ -40,12 +48,31 @@
 
 static GQuark cogl_pango_font_map_get_renderer_key (void) G_GNUC_CONST;
 
+/**
+ * cogl_pango_font_map_new:
+ *
+ * Creates a new font map.
+ *
+ * Return value: the newly created #PangoFontMap
+ *
+ * Since: 1.0
+ */
 PangoFontMap *
 cogl_pango_font_map_new (void)
 {
   return pango_cairo_font_map_new ();
 }
 
+/**
+ * cogl_pango_font_map_create_context:
+ * @fm: a #CoglPangoFontMap
+ *
+ * Creates a new #PangoContext from the passed font map.
+ *
+ * Return value: the newly created #PangoContext
+ *
+ * Since: 1.0
+ */
 PangoContext *
 cogl_pango_font_map_create_context (CoglPangoFontMap *fm)
 {
@@ -56,6 +83,16 @@ cogl_pango_font_map_create_context (CoglPangoFontMap *fm)
   return pango_cairo_font_map_create_context (PANGO_CAIRO_FONT_MAP (fm));
 }
 
+/**
+ * cogl_pango_font_map_get_renderer:
+ * @fm: a #CoglPangoFontMap
+ *
+ * Retrieves the #CoglPangoRenderer for the passed font map.
+ *
+ * Return value: a #PangoRenderer
+ *
+ * Since: 1.0
+ */
 PangoRenderer *
 cogl_pango_font_map_get_renderer (CoglPangoFontMap *fm)
 {
@@ -82,6 +119,15 @@ cogl_pango_font_map_get_renderer (CoglPangoFontMap *fm)
   return renderer;
 }
 
+/**
+ * cogl_pango_font_map_set_resolution:
+ * @font_map: a #CoglPangoFontMap
+ * @dpi: DPI to set
+ *
+ * Sets the resolution to be used by @font_map at @dpi.
+ *
+ * Since: 1.0
+ */
 void
 cogl_pango_font_map_set_resolution (CoglPangoFontMap *font_map,
 				    double            dpi)
@@ -91,6 +137,14 @@ cogl_pango_font_map_set_resolution (CoglPangoFontMap *font_map,
   pango_cairo_font_map_set_resolution (PANGO_CAIRO_FONT_MAP (font_map), dpi);
 }
 
+/**
+ * cogl_pango_font_map_clear_glyph_cache:
+ * @fm: a #CoglPangoFontMap
+ *
+ * Clears the glyph cache for @fm.
+ *
+ * Since: 1.0
+ */
 void
 cogl_pango_font_map_clear_glyph_cache (CoglPangoFontMap *fm)
 {
@@ -101,6 +155,16 @@ cogl_pango_font_map_clear_glyph_cache (CoglPangoFontMap *fm)
   _cogl_pango_renderer_clear_glyph_cache (COGL_PANGO_RENDERER (renderer));
 }
 
+/**
+ * cogl_pango_font_map_set_use_mipmapping:
+ * @fm: a #CoglPangoFontMap
+ * @value: %TRUE to enable the use of mipmapping
+ *
+ * Sets whether the renderer for the passed font map should use
+ * mipmapping when rendering a #PangoLayout.
+ *
+ * Since: 1.0
+ */
 void
 cogl_pango_font_map_set_use_mipmapping (CoglPangoFontMap *fm,
                                         gboolean          value)
@@ -112,6 +176,17 @@ cogl_pango_font_map_set_use_mipmapping (CoglPangoFontMap *fm,
   _cogl_pango_renderer_set_use_mipmapping (renderer, value);
 }
 
+/**
+ * cogl_pango_font_map_get_use_mipmapping:
+ * @fm: a #CoglPangoFontMap
+ *
+ * Retrieves whether the #CoglPangoRenderer used by @fm will
+ * use mipmapping when rendering the glyphs.
+ *
+ * Return value: %TRUE if mipmapping is used, %FALSE otherwise.
+ *
+ * Since: 1.0
+ */
 gboolean
 cogl_pango_font_map_get_use_mipmapping (CoglPangoFontMap *fm)
 {

clutter/pango/cogl-pango-render.c

@@ -81,10 +81,7 @@ static void cogl_pango_renderer_draw_trapezoid (PangoRenderer    *renderer,
                                                 double            x12,
                                                 double            x22);
 
-static GObjectClass *parent_class = NULL;
+G_DEFINE_TYPE (CoglPangoRenderer, cogl_pango_renderer, PANGO_TYPE_RENDERER);
-
-G_DEFINE_TYPE (CoglPangoRenderer, cogl_pango_renderer,
-	       PANGO_TYPE_RENDERER);
 
 static void
 cogl_pango_renderer_init (CoglPangoRenderer *priv)
@@ -100,8 +97,6 @@ cogl_pango_renderer_class_init (CoglPangoRendererClass *klass)
   GObjectClass *object_class = G_OBJECT_CLASS (klass);
   PangoRendererClass *renderer_class = PANGO_RENDERER_CLASS (klass);
 
-  parent_class = g_type_class_peek_parent (klass);
-
   object_class->finalize = cogl_pango_renderer_finalize;
 
   renderer_class->draw_glyphs = cogl_pango_renderer_draw_glyphs;
@@ -117,9 +112,38 @@ cogl_pango_renderer_finalize (GObject *object)
   cogl_pango_glyph_cache_free (priv->mipmapped_glyph_cache);
   cogl_pango_glyph_cache_free (priv->glyph_cache);
 
-  G_OBJECT_CLASS (parent_class)->finalize (object);
+  G_OBJECT_CLASS (cogl_pango_renderer_parent_class)->finalize (object);
 }
 
+static CoglPangoRenderer *
+cogl_pango_get_renderer_from_context (PangoContext *context)
+{
+  PangoFontMap      *font_map;
+  PangoRenderer     *renderer;
+  CoglPangoFontMap  *font_map_priv;
+
+  font_map = pango_context_get_font_map (context);
+  g_return_val_if_fail (COGL_PANGO_IS_FONT_MAP (font_map), NULL);
+
+  font_map_priv = COGL_PANGO_FONT_MAP (font_map);
+  renderer = cogl_pango_font_map_get_renderer (font_map_priv);
+  g_return_val_if_fail (COGL_PANGO_IS_RENDERER (renderer), NULL);
+
+  return COGL_PANGO_RENDERER (renderer);
+}
+
+/**
+ * cogl_pango_render_layout_subpixel:
+ * @layout: a #PangoLayout
+ * @x: FIXME
+ * @y: FIXME
+ * @color: color to use when rendering the layout
+ * @flags: flags to pass to the renderer
+ *
+ * FIXME
+ *
+ * Since: 1.0
+ */
 void
 cogl_pango_render_layout_subpixel (PangoLayout     *layout,
 				   int              x,
@@ -128,22 +152,30 @@ cogl_pango_render_layout_subpixel (PangoLayout     *layout,
 				   int              flags)
 {
   PangoContext      *context;
-  PangoFontMap         *font_map;
-  PangoRenderer        *renderer;
   CoglPangoRenderer *priv;
 
   context = pango_layout_get_context (layout);
-  font_map = pango_context_get_font_map (context);
+  priv = cogl_pango_get_renderer_from_context (context);
-  g_return_if_fail (COGL_PANGO_IS_FONT_MAP (font_map));
+  if (G_UNLIKELY (!priv))
-  renderer = cogl_pango_font_map_get_renderer
+    return;
-    (COGL_PANGO_FONT_MAP (font_map));
-  priv = COGL_PANGO_RENDERER (renderer);
 
   priv->color = *color;
 
-  pango_renderer_draw_layout (renderer, layout, x, y);
+  pango_renderer_draw_layout (PANGO_RENDERER (priv), layout, x, y);
 }
 
+/**
+ * cogl_pango_render_layout:
+ * @layout: a #PangoLayout
+ * @x: X coordinate to render the layout at
+ * @y: Y coordinate to render the layout at
+ * @color: color to use when rendering the layout
+ * @flags: flags to pass to the renderer
+ *
+ * Renders @layout.
+ *
+ * Since: 1.0
+ */
 void
 cogl_pango_render_layout (PangoLayout     *layout,
                           int              x,
@@ -158,6 +190,17 @@ cogl_pango_render_layout (PangoLayout     *layout,
                                      flags);
 }
 
+/**
+ * cogl_pango_render_layout_line:
+ * @line: a #PangoLayoutLine
+ * @x: X coordinate to render the line at
+ * @y: Y coordinate to render the line at
+ * @color: color to use when rendering the line
+ *
+ * Renders @line at the given coordinates using the given color.
+ *
+ * Since: 1.0
+ */
 void
 cogl_pango_render_layout_line (PangoLayoutLine *line,
                                int              x,
@@ -165,20 +208,16 @@ cogl_pango_render_layout_line (PangoLayoutLine *line,
                                const CoglColor *color)
 {
   PangoContext      *context;
-  PangoFontMap         *font_map;
-  PangoRenderer        *renderer;
   CoglPangoRenderer *priv;
 
   context = pango_layout_get_context (line->layout);
-  font_map = pango_context_get_font_map (context);
+  priv = cogl_pango_get_renderer_from_context (context);
-  g_return_if_fail (COGL_PANGO_IS_FONT_MAP (font_map));
+  if (G_UNLIKELY (!priv))
-  renderer = cogl_pango_font_map_get_renderer
+    return;
-    (COGL_PANGO_FONT_MAP (font_map));
-  priv = COGL_PANGO_RENDERER (renderer);
 
   priv->color = *color;
 
-  pango_renderer_draw_layout_line (renderer, line, x, y);
+  pango_renderer_draw_layout_line (PANGO_RENDERER (priv), line, x, y);
 }
 
 void
@@ -210,12 +249,11 @@ cogl_pango_renderer_get_cached_glyph (PangoRenderer *renderer,
   CoglPangoGlyphCacheValue *value;
   CoglPangoGlyphCache *glyph_cache;
 
-  glyph_cache = priv->use_mipmapping
+  glyph_cache = priv->use_mipmapping ? priv->mipmapped_glyph_cache
-    ? priv->mipmapped_glyph_cache : priv->glyph_cache;
+                                     : priv->glyph_cache;
 
-  if ((value = cogl_pango_glyph_cache_lookup (glyph_cache,
+  value = cogl_pango_glyph_cache_lookup (glyph_cache, font, glyph);
-						 font,
+  if (value == NULL)
-						 glyph)) == NULL)
     {
       cairo_surface_t *surface;
       cairo_t *cr;
@@ -245,8 +283,8 @@ cogl_pango_renderer_get_cached_glyph (PangoRenderer *renderer,
       cairo_surface_flush (surface);
 
       /* Copy the glyph to the cache */
-      value = cogl_pango_glyph_cache_set
+      value =
-	(glyph_cache, font, glyph,
+        cogl_pango_glyph_cache_set (glyph_cache, font, glyph,
                                     cairo_image_surface_get_data (surface),
                                     cairo_image_surface_get_width (surface),
                                     cairo_image_surface_get_height (surface),
@@ -267,21 +305,18 @@ void
 cogl_pango_ensure_glyph_cache_for_layout (PangoLayout *layout)
 {
   PangoContext    *context;
-  PangoFontMap    *fontmap;
   PangoRenderer   *renderer;
   PangoLayoutIter *iter;
  
   g_return_if_fail (PANGO_IS_LAYOUT (layout));
  
-  context = pango_layout_get_context (layout);
-  fontmap = pango_context_get_font_map (context);
-  g_return_if_fail (COGL_PANGO_IS_FONT_MAP (fontmap));
-  renderer = cogl_pango_font_map_get_renderer
-    (COGL_PANGO_FONT_MAP (fontmap));
- 
   if ((iter = pango_layout_get_iter (layout)) == NULL)
     return;
  
+  context = pango_layout_get_context (layout);
+  renderer =
+    PANGO_RENDERER (cogl_pango_get_renderer_from_context (context));
+
   do
     {
       PangoLayoutLine *line;
@@ -379,9 +414,11 @@ cogl_pango_renderer_draw_rectangle (PangoRenderer    *renderer,
 
   cogl_pango_renderer_set_color_for_part (renderer, part);
 
-  cogl_pango_renderer_get_device_units (renderer, x, y,
+  cogl_pango_renderer_get_device_units (renderer,
+                                        x, y,
                                         &x1, &y1);
-  cogl_pango_renderer_get_device_units (renderer, x + width, y + height,
+  cogl_pango_renderer_get_device_units (renderer,
+                                        x + width, y + height,
                                         &x2, &y2);
 
   cogl_rectanglex (x1, y1, x2 - x1, y2 - y1);