From 1f223324154360019b279f5694d31038ae79fffa Mon Sep 17 00:00:00 2001
From: Bill Kendrick <nbs@sonic.net>
Date: Fri, 9 Dec 2022 22:11:32 -0800
Subject: [PATCH] Use Japanese characters, not "Aa", in font selector when
 available

Also closes https://sourceforge.net/p/tuxpaint/bugs/266/ by
using code based on Pere's patch.  Thanks to Shin-ichi & Pere!
---
 src/fonts.c    | 36 +++++++++++++++++++++++++-----------
 src/po/ja.po   |  2 +-
 src/tuxpaint.c | 24 ++++++++++++++++++++++--
 3 files changed, 48 insertions(+), 14 deletions(-)

diff --git a/src/fonts.c b/src/fonts.c
index b1045bf79..a5e58e15e 100644
--- a/src/fonts.c
+++ b/src/fonts.c
@@ -19,7 +19,7 @@
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
   (See COPYING.txt)
 
-  Last modified: November 14, 2022
+  Last modified: December 9, 2022
 */
 
 #include <stdio.h>
@@ -1568,35 +1568,44 @@ static int do_surfcmp(const SDL_Surface * const *const v1,
 
   if (s1 == s2)
   {
+    /* Should not be receiving the same SDL_Surfaces! */
     fprintf(stderr, "s1==s2?\n");
     return 0;
   }
   if (!s1 || !s2 || !s1->w || !s2->w || !s1->h || !s2->h || !s1->format
       || !s2->format)
   {
+    /* One or the other or both SDL_Surfaces were invalid!? */
     was_bad_font = 1;
     return 0;
   }
   if (s1->format->BytesPerPixel != s2->format->BytesPerPixel)
   {
-    // something really strange and bad happened
+    /* The SDL_Surfaces are in different bit depths!? */
     was_bad_font = 1;
     return s1->format->BytesPerPixel - s2->format->BytesPerPixel;
   }
 
-
+  /* If they are different shapes, sort by their shape
+     (we can quickly tell that they are different) */
   if (s1->w != s2->w)
     return s1->w - s2->w;
   if (s1->h != s2->h)
     return s1->h - s2->h;
 
+  /* Otherwise, compare the pixels in the surfaces
+     (using `memcmp()`) */
   {
     const char *const c1 = (char *const) s1->pixels;
     const char *const c2 = (char *const) s2->pixels;
 
     width = s1->format->BytesPerPixel * s1->w;
-    if (width == s1->pitch)
+    if (width == s1->pitch) {
+      /* Same width, just compare scanline */
       return memcmp(c1, c2, width * s1->h);
+    }
+
+    /* Otherwise, compare pixels */
     cmp = 0;
     i = s1->h;
     while (i--)
@@ -1607,16 +1616,22 @@ static int do_surfcmp(const SDL_Surface * const *const v1,
     }
   }
 
-  return cmp;
+  /* In the end, they were the same! */
+  return 0;
 }
 
 // see if two font surfaces are the same
+// (if two come out identical, we'll set the `was_bad_font` flag)
 static int surfcmp(const void *s1, const void *s2)
 {
   int diff = do_surfcmp(s1, s2);
 
-  if (!diff)
+  if (!diff) {
+#ifdef DEBUG
+    printf("surfcmp found two identical renders!\n");
+#endif
     was_bad_font = 1;
+  }
   return diff;
 }
 
@@ -1656,7 +1671,6 @@ int charset_works(TuxPaint_Font * font, const char *s)
     }
 #endif
 
-/* FIXME: Should the following be in an "#else" block!? -bjk 2009.06.01 */
     if (font->typ == FONT_TYPE_TTF)
     {
       tmp_surf = TTF_RenderUTF8_Blended(font->ttf_font, c, black);
@@ -1664,10 +1678,7 @@ int charset_works(TuxPaint_Font * font, const char *s)
 
     if (!tmp_surf)
     {
-#if 0
-// THREADED_FONTS
-      printf("could not render \"%s\" font\n", TTF_FontFaceFamilyName(font));
-#endif
+      fprintf(stderr, "Could not render font %s\n", font->desc);
       goto out;
     }
     surfs[count++] = tmp_surf;
@@ -1687,6 +1698,9 @@ out:
     }
   }
   free(surfs);
+#ifdef DEBUG
+  printf("charset_works = %d for %s\n", ret, font->desc);
+#endif
   return ret;
 }
 
diff --git a/src/po/ja.po b/src/po/ja.po
index 55cac38d5..2830b0d78 100644
--- a/src/po/ja.po
+++ b/src/po/ja.po
@@ -1247,7 +1247,7 @@ msgstr "さいしょから"
 #. Label for 'Letters' buttons (font selector, down the right when the Text tool is being used); used to show the difference between font faces
 #: ../tuxpaint.c:10776
 msgid "Aa"
-msgstr "Aa"
+msgstr "あぁ"
 
 #  FIXME: Move elsewhere! Or not?!
 #. Admittedly stupid way of determining which keys can be used for
diff --git a/src/tuxpaint.c b/src/tuxpaint.c
index 30990c820..640dc3673 100644
--- a/src/tuxpaint.c
+++ b/src/tuxpaint.c
@@ -10813,9 +10813,29 @@ static void draw_fonts(void)
     if (font < num_font_families)
     {
       SDL_Surface *tmp_surf_1;
+      TuxPaint_Font * fonthandle;
 
-      /* Label for 'Letters' buttons (font selector, down the right when the Text tool is being used); used to show the difference between font faces */
-      tmp_surf_1 = render_text(getfonthandle(font), gettext("Aa"), black);
+      /* Label for 'Letters' buttons (font selector, down the right when
+         the Text or Label tool are being used); used to show the difference
+         between font faces.  (We'll decide whether a font is suitable to
+         use the localized string here, or fallback to "Aa", depending on
+         whether the two glyphs render the same. i.e., if they both come
+         back as identical rectangles, we know the font doesn't adequately
+         support this font.) */
+      fonthandle = getfonthandle(font);
+      if (charset_works(fonthandle, gettext("Aa"))) {
+        /* Use the localized label string (e.g., "あぁ" in Japanese) */
+#ifdef DEBUG
+        printf("Font label '%s' for %s\n", gettext("Aa"), fonthandle->desc);
+#endif
+        tmp_surf_1 = render_text(fonthandle, gettext("Aa"), black);
+      } else {
+        /* Fallback; use the latin "Aa" string */
+#ifdef DEBUG
+        printf("Fallback font label 'Aa' for %s\n", fonthandle->desc);
+#endif
+        tmp_surf_1 = render_text(fonthandle, "Aa", black);
+      }
 
       if (tmp_surf_1 == NULL)
       {