[pango/wip/otte/testrandom] tests: Add spiced up wrapping tests

[Benjamin Otte <otte src gnome org>]

commit c6e7cda106cc149912dafefc5c43a26ed3d67204
Author: Benjamin Otte <otte redhat com>
Date:   Fri Nov 12 03:14:34 2021 +0100

    tests: Add spiced up wrapping tests
    
    * Generate random string that looks like a sentence.
    * Measure the size at 100 random widths.
    * assert that for those widths, when sorted, the measured widths
      are increasing and the heights are decreasing.
    
    * Generate random string that looks like a sentence.
    * Generate a 2nd string adding hyphen + newline after every char of
      original string.
    * Assert that wrap-char wrap with width=0 is not larger than the width
      of the 2nd string
    
    The tests also generate random strings in LTR, RTL or both at the same
    time to spice the test up even more.
    It does that by picking random words out of hunspell directories, and if
    none are installed, it falls back to lorem ipsum.

 tests/meson.build  |   3 +-
 tests/testrandom.c | 321 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 323 insertions(+), 1 deletion(-)
---
diff --git a/tests/meson.build b/tests/meson.build
index 90bb94ba..81170c15 100644
--- a/tests/meson.build
+++ b/tests/meson.build
@@ -52,7 +52,8 @@ if cairo_dep.found()
     [ 'testmisc', [ 'testmisc.c' ], [ libpangocairo_dep, libpangoft2_dep, glib_dep, harfbuzz_dep ] ],
     [ 'cxx-test', [ 'cxx-test.cpp' ], [ libpangocairo_dep, gobject_dep, harfbuzz_dep ] ],
     [ 'test-harfbuzz', [ 'test-harfbuzz.c' ], [ libpangocairo_dep, gobject_dep, harfbuzz_dep ] ],
-    [ 'test-break', [ 'test-break.c', 'test-common.c', 'validate-log-attrs.c' ], [libpangocairo_dep, 
glib_dep, harfbuzz_dep ] ]
+    [ 'test-break', [ 'test-break.c', 'test-common.c', 'validate-log-attrs.c' ], [libpangocairo_dep, 
glib_dep, harfbuzz_dep ] ],
+    [ 'testrandom', [ 'testrandom.c' ], [ libpangocairo_dep, gio_dep ] ],
   ]
 
   if pango_cairo_backends.contains('png')
diff --git a/tests/testrandom.c b/tests/testrandom.c
new file mode 100644
index 00000000..332376b6
--- /dev/null
+++ b/tests/testrandom.c
@@ -0,0 +1,321 @@
+/* Pango
+ * testmisc.c: Test program for miscellaneous things
+ *
+ * Copyright (C) 2021 Benjamin Otte
+ *
+ * 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 "config.h"
+
+#include <locale.h>
+#include <gio/gio.h>
+#include <pango/pangocairo.h>
+
+#define N_SENTENCES 20
+
+static char **ltr_words;
+static gsize n_ltr_words;
+static char **rtl_words;
+static gsize n_rtl_words;
+
+static const char *
+random_word (PangoDirection dir)
+{
+  switch (dir)
+    {
+      case PANGO_DIRECTION_LTR:
+        return ltr_words[g_test_rand_int_range (0, n_ltr_words)];
+      case PANGO_DIRECTION_RTL:
+        return rtl_words[g_test_rand_int_range (0, n_rtl_words)];
+      case PANGO_DIRECTION_TTB_LTR:
+      case PANGO_DIRECTION_TTB_RTL:
+      case PANGO_DIRECTION_WEAK_LTR:
+      case PANGO_DIRECTION_WEAK_RTL:
+      case PANGO_DIRECTION_NEUTRAL:
+      default:
+        return random_word (g_test_rand_bit () ? PANGO_DIRECTION_LTR : PANGO_DIRECTION_RTL);
+    }
+}
+
+static char *
+create_random_sentence (PangoDirection dir)
+{
+  GString *string = g_string_new (NULL);
+  gsize i, n_words;
+
+  n_words = g_test_rand_int_range (0, 15);
+  for (i = 0; i < n_words; i++)
+    {
+      if (i > 0)
+        {
+          if (g_random_int_range (0, 10) == 0)
+            g_string_append_c (string, ',');
+          g_string_append_c (string, ' ');
+        }
+      g_string_append (string, random_word (dir));
+    }
+
+  i = g_test_rand_int_range(0, 4);
+  if (i > 0)
+    g_string_append_c (string, "!.?"[i - 1]);
+
+  return g_string_free (string, FALSE);
+}
+
+typedef struct
+{
+  int set_width;
+  int width;
+  int height;
+} Size;
+
+static int
+compare_size (gconstpointer a,
+              gconstpointer b,
+              gpointer      unused)
+{
+  return ((const Size *) a)->set_width - ((const Size *) b)->set_width;
+}
+
+static void
+layout_check_size (PangoLayout *layout,
+                   int          width,
+                   Size        *out_size)
+{
+  out_size->set_width = width;
+  pango_layout_set_width (layout, width);
+  pango_layout_get_size (layout, &out_size->width, &out_size->height);
+}
+
+static void
+test_wrap_char (gconstpointer data)
+{
+  PangoDirection dir = GPOINTER_TO_UINT (data);
+  PangoFontDescription *desc;
+  PangoContext *context;
+  PangoLayout *layout;
+  char *sentence;
+  Size min, max;
+  Size sizes[100];
+  gsize i, j;
+
+  context = pango_font_map_create_context (pango_cairo_font_map_get_default ());
+  desc = pango_font_description_from_string ("Sans 10");
+  layout = pango_layout_new (context);
+  pango_layout_set_font_description (layout, desc);
+  pango_font_description_free (desc);
+  pango_layout_set_wrap (layout, PANGO_WRAP_WORD_CHAR);
+
+  for (j = 0; j < N_SENTENCES; j++)
+    {
+      sentence = create_random_sentence (dir);
+      pango_layout_set_text (layout, sentence, -1);
+      g_test_message ("%s", sentence);
+      g_free (sentence);
+
+      layout_check_size (layout, -1, &max);
+      layout_check_size (layout, 0, &min);
+      g_assert_cmpint (min.width, <=, max.width);
+      g_assert_cmpint (min.height, >=, max.height);
+
+      for (i = 0; i < G_N_ELEMENTS (sizes); i++)
+        {
+          layout_check_size (layout, g_test_rand_int_range (0, min.width + max.width + 1), &sizes[i]);
+        }
+
+      g_qsort_with_data (sizes, G_N_ELEMENTS (sizes), sizeof (Size), compare_size, NULL);
+
+      g_assert_cmpint (sizes[0].width, >=, min.width);
+      g_assert_cmpint (sizes[0].height, <=, min.height);
+
+      for (i = 1; i < G_N_ELEMENTS (sizes); i++)
+        {
+          g_test_message ("widths %u, %u", sizes[i-1].set_width, sizes[i].set_width);
+          g_assert_cmpint (sizes[i-1].set_width, <=, sizes[i].set_width);
+          g_assert_cmpint (sizes[i-1].width, <=, sizes[i].width);
+          g_assert_cmpint (sizes[i-1].height, >=, sizes[i].height);
+          if (sizes[i-1].width == sizes[i].width &&
+              /* need to make sure we're over the min size, otherwise "ll W"
+               * might be broken to "l- l W" or not depending on set width */
+              sizes[i-1].set_width >= min.width)
+            g_assert_cmpint (sizes[i-1].height, ==, sizes[i].height);
+        }
+
+      if (sizes[i-1].set_width >= max.width)
+        {
+          g_assert_cmpint (sizes[i-1].width, ==, max.width);
+          g_assert_cmpint (sizes[i-1].height, ==, max.height);
+        }
+      else
+        {
+          g_assert_cmpint (sizes[i-1].width, <, max.width);
+          g_assert_cmpint (sizes[i-1].height, >, max.height);
+        }
+    }
+
+  g_object_unref (layout);
+  g_object_unref (context);
+}
+
+static void
+test_wrap_char_min_width (gconstpointer data)
+{
+  PangoDirection dir = GPOINTER_TO_UINT (data);
+  PangoFontDescription *desc;
+  PangoContext *context;
+  PangoLayout *test_layout, *ref_layout;
+  char *sentence, *s;
+  GString *ref_string;
+  gsize j;
+  int test_width, ref_width;
+
+  context = pango_font_map_create_context (pango_cairo_font_map_get_default ());
+  desc = pango_font_description_from_string ("Sans 10");
+  ref_layout = pango_layout_new (context);
+  pango_layout_set_font_description (ref_layout, desc);
+  test_layout = pango_layout_new (context);
+  pango_layout_set_font_description (test_layout, desc);
+  pango_layout_set_wrap (test_layout, PANGO_WRAP_WORD_CHAR);
+  pango_layout_set_width (test_layout, 0);
+  pango_font_description_free (desc);
+
+  for (j = 0; j < N_SENTENCES; j++)
+    {
+      sentence = create_random_sentence (dir);
+      pango_layout_set_text (test_layout, sentence, -1);
+      g_test_message ("%s", sentence);
+      ref_string = g_string_new ("");
+      for (s = sentence; *s; s = g_utf8_next_char (s))
+        {
+          g_string_append_unichar (ref_string, g_utf8_get_char (s));
+          g_string_append_unichar (ref_string, g_test_rand_bit () ? 0x2010 : '-');
+          g_string_append_c (ref_string, '\n');
+        }
+      pango_layout_set_text (ref_layout, ref_string->str, ref_string->len);
+      g_string_free (ref_string, TRUE);
+      g_free (sentence);
+
+      pango_layout_get_size (test_layout, &test_width, NULL);
+      pango_layout_get_size (ref_layout, &ref_width, NULL);
+
+      g_assert_cmpint (test_width, <=, ref_width);
+    }
+
+  g_object_unref (test_layout);
+  g_object_unref (ref_layout);
+  g_object_unref (context);
+}
+
+static char **
+load_hunspell_words (const char  *language)
+{
+  char *path;
+  GBytes *bytes;
+  GFile *file;
+  char **words;
+  gsize i;
+
+  path = g_strdup_printf ("/usr/share/myspell/%s.dic", language);
+  file = g_file_new_for_path (path);
+  g_free (path);
+  bytes = g_file_load_bytes (file, NULL, NULL, NULL);
+  g_object_unref (file);
+  if (bytes == NULL)
+    return NULL;
+
+  words = g_strsplit (g_bytes_get_data (bytes, NULL), "\n", -1);
+  g_bytes_unref (bytes);
+
+  if (words == NULL || words[0] == NULL)
+    {
+      g_free (words);
+      return NULL;
+    }
+
+  for (i = 1; words[i]; i++)
+    {
+      char *slash = strchr (words[i], '/');
+      if (slash)
+        *slash = 0;
+    }
+
+  return words;
+}
+
+static char **
+init_ltr_words (void)
+{
+  GFile *file;
+  GBytes *bytes;
+  char **result;
+
+  result = load_hunspell_words ("en_US");
+  if (result)
+    return result;
+
+  file = g_file_new_for_path ("/usr/share/dict/words");
+  bytes = g_file_load_bytes (file, NULL, NULL, NULL);
+  g_object_unref (file);
+  if (bytes)
+    {
+      result = g_strsplit (g_bytes_get_data (bytes, NULL), "\n", -1);
+      g_bytes_unref (bytes);
+      return result;
+    }
+
+  return g_strsplit ("lorem ipsum dolor sit amet consectetur adipisci elit sed eiusmod tempor incidunt 
labore et dolore magna aliqua ut enim ad minim veniam quis nostrud exercitation ullamco laboris nisi ut 
aliquid ex ea commodi consequat", " ", -1);
+}
+
+static char **
+init_rtl_words (void)
+{
+  char **result;
+
+  result = load_hunspell_words ("he_IL");
+  if (result)
+    return result;
+
+  return g_strsplit ("לורם איפסום דולור סיט אמט קונסקטטור אדיפיסינג אלית קולורס מונפרד אדנדום סילקוף מרגשי 
ומרגשח עמחליף לפרומי בלוף קינץ תתיח לרעח לת צשחמי צש בליא מנסוטו צמלח לביקו ננבי צמוקו בלוקריה שיצמה ברורק 
להאמית קרהשק סכעיט דז מא מנכם למטכין נשואי מנורךגולר מונפרר סוברט לורם שבצק יהול לכנוץ בעריר גק ליץ ושבעגט 
ושבעגט לבם סולגק בראיט ולחת צורק מונחף בגורמי מגמש תרבנך וסתעד לכנו סתשם השמה - לתכי מורגם בורק? לתיג ישבעס", 
" ", -1);
+}
+
+int
+main (int argc, char *argv[])
+{
+  int result;
+
+  g_test_init (&argc, &argv, NULL);
+  setlocale (LC_ALL, "");
+
+  ltr_words = init_ltr_words ();
+  n_ltr_words = g_strv_length (ltr_words);
+  rtl_words = init_rtl_words ();
+  n_rtl_words = g_strv_length (rtl_words);
+
+  g_test_add_data_func ("/layout/ltr/wrap-char", GUINT_TO_POINTER (PANGO_DIRECTION_LTR), test_wrap_char);
+  g_test_add_data_func ("/layout/rtl/wrap-char", GUINT_TO_POINTER (PANGO_DIRECTION_RTL), test_wrap_char);
+  g_test_add_data_func ("/layout/any/wrap-char", GUINT_TO_POINTER (PANGO_DIRECTION_NEUTRAL), test_wrap_char);
+  g_test_add_data_func ("/layout/ltr/wrap-char-min-width", GUINT_TO_POINTER (PANGO_DIRECTION_LTR), 
test_wrap_char_min_width);
+  g_test_add_data_func ("/layout/rtl/wrap-char-min-width", GUINT_TO_POINTER (PANGO_DIRECTION_RTL), 
test_wrap_char_min_width);
+  g_test_add_data_func ("/layout/any/wrap-char-min-width", GUINT_TO_POINTER (PANGO_DIRECTION_NEUTRAL), 
test_wrap_char_min_width);
+
+  result = g_test_run ();
+
+  g_strfreev (ltr_words);
+  g_strfreev (rtl_words);
+
+  return result;
+}