[pango] Add tests for PangoLayout

[Matthias Clasen <matthiasc src gnome org>]

commit 0068b78276c4ac7df95d97fa270a5e8ca4b58348
Author: Matthias Clasen <mclasen redhat com>
Date:   Sat Aug 30 20:20:00 2014 -0400

    Add tests for PangoLayout
    
    This tests works similar to the markup parser tests -
    we populate a layout with known data, and then compare
    a dump of its properties with expected output.

 tests/Makefile.am              |   23 ++-
 tests/layouts/valid-1.expected |   35 +++
 tests/layouts/valid-1.markup   |    2 +
 tests/layouts/valid-2.expected |   34 +++
 tests/layouts/valid-2.markup   |    2 +
 tests/test-layout.c            |  487 ++++++++++++++++++++++++++++++++++++++++
 6 files changed, 580 insertions(+), 3 deletions(-)
---
diff --git a/tests/Makefile.am b/tests/Makefile.am
index d889183..b9ed313 100644
--- a/tests/Makefile.am
+++ b/tests/Makefile.am
@@ -43,7 +43,14 @@ TESTS_ENVIRONMENT =                    \
    G_TEST_BUILDDIR=$(abs_builddir)     \
    PANGO_RC_FILE=./pangorc
 
-check_PROGRAMS = testboundaries testboundaries_ucd testcolor testscript markup-parse
+check_PROGRAMS =                       \
+       testboundaries                  \
+       testboundaries_ucd              \
+       testcolor                       \
+       testscript                      \
+       markup-parse                    \
+       test-layout                     \
+       $(NULL)
 
 if HAVE_CAIRO
 check_PROGRAMS += testiter test-pangocairo-threads
@@ -66,6 +73,7 @@ test_ot_tags_LDADD = $(TEST_PANGOFT2_LIBS) $(GLIB_LIBS)
 test_pangocairo_threads_LDADD = $(TEST_PANGOCAIRO_LIBS) $(CAIRO_LIBS) $(GLIB_LIBS)
 dump_boundaries_LDADD = $(TEST_PANGO_LIBS) $(GLIB_LIBS)
 markup_parse_LDADD = $(TEST_PANGOCAIRO_LIBS) $(GLIB_LIBS)
+test_layout_LDADD = $(TEST_PANGOCAIRO_LIBS) $(GLIB_LIBS)
 
 if HAVE_CXX
 check_PROGRAMS += cxx-test
@@ -90,7 +98,15 @@ markup_tests = \
 all_markup_data = \
        $(addprefix markups/,$(markup_tests:=.markup) $(markup_tests:=.expected))
 
-EXTRA_DIST += $(all_markup_data)
+layout_tests = \
+       valid-1 valid-2 \
+       $(NULL)
+
+all_layout_data = \
+       $(addprefix layouts/,$(layout_tests:=.markup) $(layout_tests:=.expected))
+       
+
+EXTRA_DIST += $(all_markup_data) $(all_layout_data)
 
 if BUILDOPT_INSTALL_TESTS
 insttestdir=$(libexecdir)/installed-tests/$(PACKAGE)
@@ -101,7 +117,8 @@ nobase_testdata_DATA =              \
        all-unicode.txt         \
        boundaries.utf8         \
        GraphemeBreakTest.txt   \
-       $(all_markup_data)
+       $(all_markup_data)      \
+       $(all_layout_data)
 
 testmetadir = $(datadir)/installed-tests/$(PACKAGE)
 testmeta_DATA = $(check_PROGRAMS:=.test)
diff --git a/tests/layouts/valid-1.expected b/tests/layouts/valid-1.expected
new file mode 100644
index 0000000..5cf99a0
--- /dev/null
+++ b/tests/layouts/valid-1.expected
@@ -0,0 +1,35 @@
+This is a test of the automatic emergency brake!
+
+---
+
+wrapped: 0
+ellipsized: 1
+lines: 2
+width: 225280
+
+---
+
+range 0 22
+range 22 41
+[22 41] foreground #00000000ffff
+[22 41] underline 1
+range 41 2147483647
+
+---
+
+i=1, index=0, paragraph-start=1, dir=ltr 'This is a test of the automatic emergency brake!
+'
+i=2, index=49, paragraph-start=1, dir=ltr ''
+
+---
+
+i=1, index=0, chars=22, level=0, gravity=south, flags=0, font=Cantarell 11, script=latin, language=c, 'This 
is a test of the '
+i=2, index=22, chars=11, level=0, gravity=south, flags=0, font=Cantarell 11, script=latin, language=c, 
'automatic e'
+  [22 41] foreground #00000000ffff
+  [22 41] underline 1
+i=3, index=33, chars=15, level=0, gravity=south, flags=0, font=Cantarell 11, script=common, language=c, 
'mergency brake!'
+  [0 2147483647] fallback 0
+  [22 41] foreground #00000000ffff
+  [22 41] underline 1
+i=4, index=48, no run, line end
+i=5, index=49, no run, line end
diff --git a/tests/layouts/valid-1.markup b/tests/layouts/valid-1.markup
new file mode 100644
index 0000000..780e683
--- /dev/null
+++ b/tests/layouts/valid-1.markup
@@ -0,0 +1,2 @@
+width=220,ellipsize=end
+This is a test of the <span foreground="#0000ff" underline="single">automatic emergency</span> brake!
diff --git a/tests/layouts/valid-2.expected b/tests/layouts/valid-2.expected
new file mode 100644
index 0000000..c98bfd5
--- /dev/null
+++ b/tests/layouts/valid-2.expected
@@ -0,0 +1,34 @@
+test the blue drink after dinner
+
+---
+
+wrapped: 0
+ellipsized: 0
+lines: 2
+
+---
+
+range 0 9
+range 9 13
+[9 13] style 2
+range 13 20
+range 20 25
+[20 25] underline 1
+range 25 2147483647
+
+---
+
+i=1, index=0, paragraph-start=1, dir=ltr 'test the blue drink after dinner
+'
+i=2, index=33, paragraph-start=1, dir=ltr ''
+
+---
+
+i=1, index=0, chars=9, level=0, gravity=south, flags=0, font=Cantarell 11, script=latin, language=c, 'test 
the '
+i=2, index=9, chars=4, level=0, gravity=south, flags=0, font=Cantarell Oblique 11, script=latin, language=c, 
'blue'
+i=3, index=13, chars=7, level=0, gravity=south, flags=0, font=Cantarell 11, script=latin, language=c, ' 
drink '
+i=4, index=20, chars=5, level=0, gravity=south, flags=0, font=Cantarell 11, script=latin, language=c, 'after'
+  [20 25] underline 1
+i=5, index=25, chars=7, level=0, gravity=south, flags=0, font=Cantarell 11, script=latin, language=c, ' 
dinner'
+i=6, index=32, no run, line end
+i=7, index=33, no run, line end
diff --git a/tests/layouts/valid-2.markup b/tests/layouts/valid-2.markup
new file mode 100644
index 0000000..677f26f
--- /dev/null
+++ b/tests/layouts/valid-2.markup
@@ -0,0 +1,2 @@
+
+test the <i>blue</i> drink <u>after</u> dinner
diff --git a/tests/test-layout.c b/tests/test-layout.c
new file mode 100644
index 0000000..25b8114
--- /dev/null
+++ b/tests/test-layout.c
@@ -0,0 +1,487 @@
+/* Pango
+ * test-layout.c: Test Pango Layout
+ *
+ * Copyright (C) 2014 Red Hat, Inc
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.         See the GNU
+ * Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ */
+
+#include <glib.h>
+#include <string.h>
+#include <locale.h>
+
+#include <pango/pangocairo.h>
+
+static PangoContext *context;
+
+static void
+print_attr (PangoAttribute *attr, GString *string)
+{
+  g_string_append_printf (string, "[%d %d] ", attr->start_index, attr->end_index);
+  switch (attr->klass->type)
+    {
+    case PANGO_ATTR_LANGUAGE:
+      g_string_append_printf (string,"language %s\n", pango_language_to_string (((PangoAttrLanguage 
*)attr)->value));
+      break;
+    case PANGO_ATTR_FAMILY:
+      g_string_append_printf (string,"family %s\n", ((PangoAttrString *)attr)->value);
+      break;
+    case PANGO_ATTR_STYLE:
+      g_string_append_printf (string,"style %d\n", ((PangoAttrInt *)attr)->value);
+      break;
+    case PANGO_ATTR_WEIGHT:
+      g_string_append_printf (string,"weight %d\n", ((PangoAttrInt *)attr)->value);
+      break;
+    case PANGO_ATTR_VARIANT:
+      g_string_append_printf (string,"variant %d\n", ((PangoAttrInt *)attr)->value);
+      break;
+    case PANGO_ATTR_STRETCH:
+      g_string_append_printf (string,"stretch %d\n", ((PangoAttrInt *)attr)->value);
+      break;
+    case PANGO_ATTR_SIZE:
+      g_string_append_printf (string,"size %d\n", ((PangoAttrSize *)attr)->size);
+      break;
+    case PANGO_ATTR_FONT_DESC:
+      g_string_append_printf (string,"font %s\n", pango_font_description_to_string (((PangoAttrFontDesc 
*)attr)->desc));
+      break;
+    case PANGO_ATTR_FOREGROUND:
+      g_string_append_printf (string,"foreground %s\n", pango_color_to_string (&((PangoAttrColor 
*)attr)->color));
+      break;
+    case PANGO_ATTR_BACKGROUND:
+      g_string_append_printf (string,"background %s\n", pango_color_to_string (&((PangoAttrColor 
*)attr)->color));
+      break;
+    case PANGO_ATTR_UNDERLINE:
+      g_string_append_printf (string,"underline %d\n", ((PangoAttrInt *)attr)->value);
+      break;
+    case PANGO_ATTR_STRIKETHROUGH:
+      g_string_append_printf (string,"strikethrough %d\n", ((PangoAttrInt *)attr)->value);
+      break;
+    case PANGO_ATTR_RISE:
+      g_string_append_printf (string,"rise %d\n", ((PangoAttrInt *)attr)->value);
+      break;
+    case PANGO_ATTR_SHAPE:
+      g_string_append_printf (string,"shape\n");
+      break;
+    case PANGO_ATTR_SCALE:
+      g_string_append_printf (string,"scale %f\n", ((PangoAttrFloat *)attr)->value);
+      break;
+    case PANGO_ATTR_FALLBACK:
+      g_string_append_printf (string,"fallback %d\n", ((PangoAttrInt *)attr)->value);
+      break;
+    case PANGO_ATTR_LETTER_SPACING:
+      g_string_append_printf (string,"letter-spacing %d\n", ((PangoAttrInt *)attr)->value);
+      break;
+    case PANGO_ATTR_UNDERLINE_COLOR:
+      g_string_append_printf (string,"underline-color %s\n", pango_color_to_string (&((PangoAttrColor 
*)attr)->color));
+      break;
+    case PANGO_ATTR_STRIKETHROUGH_COLOR:
+      g_string_append_printf (string,"strikethrough-color %s\n", pango_color_to_string (&((PangoAttrColor 
*)attr)->color));
+      break;
+    case PANGO_ATTR_ABSOLUTE_SIZE:
+      g_string_append_printf (string,"absolute-size %d\n", ((PangoAttrSize *)attr)->size);
+      break;
+    case PANGO_ATTR_GRAVITY:
+      g_string_append_printf (string,"gravity %d\n", ((PangoAttrInt *)attr)->value);
+      break;
+    case PANGO_ATTR_GRAVITY_HINT:
+      g_string_append_printf (string,"gravity-hint %d\n", ((PangoAttrInt *)attr)->value);
+      break;
+    default:
+      g_assert_not_reached ();
+      break;
+    }
+}
+
+static void
+dump_attrs (PangoAttrList *attrs, GString *string)
+{
+  PangoAttrIterator *iter;
+
+  iter = pango_attr_list_get_iterator (attrs);
+  do {
+    gint start, end;
+    GSList *list, *l;
+
+    pango_attr_iterator_range (iter, &start, &end);
+    g_string_append_printf (string, "range %d %d\n", start, end);
+    list = pango_attr_iterator_get_attrs (iter);
+    for (l = list; l; l = l->next)
+      {
+        PangoAttribute *attr = l->data;
+        print_attr (attr, string);
+      }
+    g_slist_free_full (list, (GDestroyNotify)pango_attribute_destroy);
+  } while (pango_attr_iterator_next (iter));
+
+  pango_attr_iterator_destroy (iter);
+}
+
+static void
+dump_extra_attrs (GSList *attrs, GString *string)
+{
+  GSList *l;
+
+  for (l = attrs; l; l = l->next)
+    {
+      PangoAttribute *attr = l->data;
+
+      g_string_append (string, "  ");
+      print_attr (attr, string);
+    }
+}
+
+static const gchar *
+enum_value_nick (GType type, gint value)
+{
+  GEnumClass *eclass;
+  GEnumValue *ev;
+
+  eclass = g_type_class_ref (type);
+  ev = g_enum_get_value (eclass, value);
+  g_type_class_unref (eclass);
+
+  if (ev)
+    return ev->value_nick;
+  else
+    return "?";
+}
+
+static const gchar *
+direction_name (PangoDirection dir)
+{
+  return enum_value_nick (PANGO_TYPE_DIRECTION, dir);
+}
+
+static const gchar *
+gravity_name (PangoGravity gravity)
+{
+  return enum_value_nick (PANGO_TYPE_GRAVITY, gravity);  
+}
+
+static const gchar *
+script_name (PangoScript script)
+{
+  return enum_value_nick (PANGO_TYPE_SCRIPT, script);
+}
+
+static gchar *
+font_name (PangoFont *font)
+{
+  PangoFontDescription *desc;
+  gchar *name;
+
+  desc = pango_font_describe (font);
+  name = pango_font_description_to_string (desc);
+  pango_font_description_free (desc);
+
+  return name;
+}
+
+static void
+dump_lines (PangoLayout *layout, GString *string)
+{
+  PangoLayoutIter *iter;
+  const gchar *text;
+  gint index, index2;
+  gboolean has_more;
+  gchar *char_str;
+  gint i;
+  PangoLayoutLine *line;
+
+  text = pango_layout_get_text (layout);
+  iter = pango_layout_get_iter (layout);
+
+  has_more = TRUE;
+  index = pango_layout_iter_get_index (iter);
+  i = 0;
+  while (has_more)
+    {
+      line = pango_layout_iter_get_line (iter);
+      has_more = pango_layout_iter_next_line (iter);
+      i++;
+
+      if (has_more)
+        {
+          index2 = pango_layout_iter_get_index (iter);
+          char_str = g_strndup (text + index, index2 - index);          
+        }
+      else
+        {
+          char_str = g_strdup (text + index);
+        }
+
+      g_string_append_printf (string, "i=%d, index=%d, paragraph-start=%d, dir=%s '%s'\n",
+                              i, index, line->is_paragraph_start, direction_name (line->resolved_dir), 
+                              char_str);
+      g_free (char_str);
+
+      index = index2;
+    }
+  pango_layout_iter_free (iter);
+}
+
+static void
+dump_runs (PangoLayout *layout, GString *string)
+{
+  PangoLayoutIter *iter;
+  PangoLayoutRun *run;
+  PangoItem *item;
+  const gchar *text;
+  gint index, index2;
+  gboolean has_more;
+  gchar *char_str;
+  gint i;
+  gchar *font;
+
+  text = pango_layout_get_text (layout);
+  iter = pango_layout_get_iter (layout);
+
+  has_more = TRUE;
+  index = pango_layout_iter_get_index (iter);
+  i = 0;
+  while (has_more)
+    {
+      run = pango_layout_iter_get_run (iter);
+      has_more = pango_layout_iter_next_run (iter);
+      i++;
+
+      if (has_more)
+        {
+          index2 = pango_layout_iter_get_index (iter);
+          char_str = g_strndup (text + index, index2 - index);          
+        }
+      else
+        {
+          char_str = g_strdup (text + index);
+        }
+
+      if (run)
+        {
+          item = ((PangoGlyphItem*)run)->item;
+          font = font_name (item->analysis.font);
+          g_string_append_printf (string, "i=%d, index=%d, chars=%d, level=%d, gravity=%s, flags=%d, 
font=%s, script=%s, language=%s, '%s'\n",
+                                  i, index, item->num_chars, item->analysis.level,
+                                  gravity_name (item->analysis.gravity),
+                                  item->analysis.flags,
+                                  font,
+                                  script_name (item->analysis.script),
+                                  pango_language_to_string (item->analysis.language),
+                                  char_str);
+          dump_extra_attrs (item->analysis.extra_attrs, string);
+          g_free (font);
+        }
+      else
+        {
+          g_string_append_printf (string, "i=%d, index=%d, no run, line end\n",
+                                  i, index);
+        }
+
+      g_free (char_str);
+      index = index2;
+    }
+  pango_layout_iter_free (iter);
+}
+
+static void
+parse_params (const gchar        *str,
+              gint               *width,
+              gint               *ellipsize_at,
+              PangoEllipsizeMode *ellipsize,
+              PangoWrapMode      *wrap)
+{
+  gchar **strings;
+  gchar **str2;
+  gint i;
+  GEnumClass *eclass;
+  GEnumValue *ev;
+
+  strings = g_strsplit (str, ",", -1);
+  for (i = 0; strings[i]; i++)
+    {
+      str2 = g_strsplit (strings[i], "=", -1);
+      if (strcmp (str2[0], "width") == 0)
+        *width = (gint) g_ascii_strtoll (str2[1], NULL, 10);
+      else if (strcmp (str2[0], "ellipsize-at") == 0)
+        *ellipsize_at = (gint) g_ascii_strtoll (str2[1], NULL, 10);
+      else if (strcmp (str2[0], "ellipsize") == 0)
+        {
+          eclass = g_type_class_ref (PANGO_TYPE_ELLIPSIZE_MODE);
+          ev = g_enum_get_value_by_name (eclass, str2[1]);
+          if (!ev)
+            ev = g_enum_get_value_by_nick (eclass, str2[1]);
+          if (ev)
+            *ellipsize = ev->value;
+          g_type_class_unref (eclass);
+        }
+      else if (strcmp (str2[0], "wrap") == 0)
+        {
+          eclass = g_type_class_ref (PANGO_TYPE_WRAP_MODE);
+          ev = g_enum_get_value_by_name (eclass, str2[1]);
+          if (!ev)
+            ev = g_enum_get_value_by_nick (eclass, str2[1]);
+          if (ev)
+            *wrap = ev->value;
+          g_type_class_unref (eclass);
+        }
+      g_strfreev (str2);
+    }
+  g_strfreev (strings);
+}
+
+static void
+test_file (const gchar *filename, GString *string)
+{
+  gchar *contents;
+  gchar *markup;
+  gsize  length;
+  GError *error = NULL;
+  PangoLayout *layout;
+  gchar *p;
+  gint width = 0;
+  gint ellipsize_at = 0;
+  PangoEllipsizeMode ellipsize = PANGO_ELLIPSIZE_NONE;
+  PangoWrapMode wrap = PANGO_WRAP_WORD;
+
+  if (!g_file_get_contents (filename, &contents, &length, &error))
+    {
+      fprintf (stderr, "%s\n", error->message);
+      g_error_free (error);
+      return;
+    }
+
+  p = strchr (contents, '\n');
+  g_assert (p);
+  markup = p + 1;
+  *p = '\0';
+
+  parse_params (contents, &width, &ellipsize_at, &ellipsize, &wrap);
+
+  layout = pango_layout_new (context);
+  pango_layout_set_markup (layout, markup, length);
+  g_free (contents);
+
+  if (width != 0)
+    pango_layout_set_width (layout, width * PANGO_SCALE);
+  pango_layout_set_ellipsize (layout, ellipsize);
+  pango_layout_set_wrap (layout, wrap);
+
+  g_string_append (string, pango_layout_get_text (layout));
+  g_string_append (string, "\n---\n\n");
+  g_string_append_printf (string, "wrapped: %d\n", pango_layout_is_wrapped (layout));
+  g_string_append_printf (string, "ellipsized: %d\n", pango_layout_is_ellipsized (layout));
+  g_string_append_printf (string, "lines: %d\n", pango_layout_get_line_count (layout));
+  if (width != 0)
+    g_string_append_printf (string, "width: %d\n", pango_layout_get_width (layout));
+  g_string_append (string, "\n---\n\n");
+   dump_attrs (pango_layout_get_attributes (layout), string);
+  g_string_append (string, "\n---\n\n");
+  dump_lines (layout, string);
+  g_string_append (string, "\n---\n\n");
+  dump_runs (layout, string);
+
+  g_object_unref (layout);
+}
+
+static gchar *
+get_expected_filename (const gchar *filename)
+{
+  gchar *f, *p, *expected;
+
+  f = g_strdup (filename);
+  p = strstr (f, ".markup");
+  if (p)
+    *p = 0;
+  expected = g_strconcat (f, ".expected", NULL);
+
+  g_free (f);
+
+  return expected;
+}
+
+static void
+test_layout (gconstpointer d)
+{
+  const gchar *filename = d;
+  gchar *expected_file;
+  gchar *expected;
+  GError *error = NULL;
+  GString *string;
+
+  expected_file = get_expected_filename (filename);
+
+  string = g_string_sized_new (0);
+
+  test_file (filename, string);
+
+  g_file_get_contents (expected_file, &expected, NULL, &error);
+  g_assert_no_error (error);
+  g_assert_cmpstr (string->str, ==, expected);
+  g_free (expected);
+
+  g_string_free (string, TRUE);
+
+  g_free (expected_file);
+}
+
+int
+main (int argc, char *argv[])
+{
+  GDir *dir;
+  GError *error = NULL;
+  const gchar *name;
+  gchar *path;
+  PangoFontDescription *desc;
+
+  g_setenv ("LC_ALL", "C", TRUE);
+  setlocale (LC_ALL, "");
+
+  g_test_init (&argc, &argv, NULL);
+
+  context = pango_font_map_create_context (pango_cairo_font_map_get_default ());
+  desc = pango_font_description_from_string ("Cantarell 11");
+  pango_context_set_font_description (context, desc);
+  pango_font_description_free (desc); 
+
+  /* allow to easily generate expected output for new test cases */
+  if (argc > 1)
+    {
+      GString *string;
+
+      string = g_string_sized_new (0);
+      test_file (argv[1], string);
+      g_print ("%s", string->str);
+
+      return 0;
+    }
+
+  path = g_test_build_filename (G_TEST_DIST, "layouts", NULL);
+  dir = g_dir_open (path, 0, &error);
+  g_free (path);
+  g_assert_no_error (error);
+  while ((name = g_dir_read_name (dir)) != NULL)
+    {
+      if (!strstr (name, "markup"))
+        continue;
+
+      path = g_strdup_printf ("/layout/%s", name);
+      g_test_add_data_func_full (path, g_test_build_filename (G_TEST_DIST, "layouts", name, NULL),
+                                 test_layout, g_free);
+      g_free (path);
+    }
+  g_dir_close (dir);
+
+  return g_test_run ();
+}