print fontname in missing glyph warning + all fallback fonts missing glyph

story645 · story645 · commit c952d155bd5c · 2023-10-04T00:27:41.000-04:00
diff --git a/lib/matplotlib/_text_helpers.py b/lib/matplotlib/_text_helpers.py
@@ -12,11 +12,12 @@
     "LayoutItem", ["ft_object", "char", "glyph_idx", "x", "prev_kern"])
 
 
-def warn_on_missing_glyph(codepoint):
+def warn_on_missing_glyph(codepoint, font_name):
     _api.warn_external(
-        "Glyph {} ({}) missing from current font.".format(
+        "Glyph {} ({}) missing from current font {}.".format(
             codepoint,
-            chr(codepoint).encode("ascii", "namereplace").decode("ascii")))
+            chr(codepoint).encode("ascii", "namereplace").decode("ascii"),
+            font_name))
     block = ("Hebrew" if 0x0590 <= codepoint <= 0x05ff else
              "Arabic" if 0x0600 <= codepoint <= 0x06ff else
              "Devanagari" if 0x0900 <= codepoint <= 0x097f else
diff --git a/lib/matplotlib/tests/test_ft2font.py b/lib/matplotlib/tests/test_ft2font.py
@@ -78,6 +78,20 @@ def test_font_fallback_chinese(fig_test, fig_ref, family_name, file_name):
         fig_test.text(0.05, .85 - 0.15*j, txt, family=test_font)
 
 
+def test_fallback_cascade_missing(recwarn):
+
+    font_list = ['Times New Roman', 'DejaVu Sans']
+    fig = plt.figure()
+    fig.text(.5, .5, "Hello 🙃 World!", family=font_list)
+    fig.canvas.draw()
+    assert all(isinstance(warn.message, UserWarning) for warn in recwarn)
+
+    for warn, font in zip(recwarn, font_list):
+        assert (warn.message.args ==
+                (r"Glyph 128579 (\N{UPSIDE-DOWN FACE}) missing "
+                 + f"from current font {font}.",))
+
+
 @pytest.mark.parametrize(
     "family_name, file_name",
     [
diff --git a/lib/matplotlib/tests/test_text.py b/lib/matplotlib/tests/test_text.py
@@ -817,12 +817,13 @@ def test_pdf_kerning():
 
 def test_unsupported_script(recwarn):
     fig = plt.figure()
-    fig.text(.5, .5, "\N{BENGALI DIGIT ZERO}")
+    t = fig.text(.5, .5, "\N{BENGALI DIGIT ZERO}")
     fig.canvas.draw()
     assert all(isinstance(warn.message, UserWarning) for warn in recwarn)
     assert (
         [warn.message.args for warn in recwarn] ==
-        [(r"Glyph 2534 (\N{BENGALI DIGIT ZERO}) missing from current font.",),
+        [(r"Glyph 2534 (\N{BENGALI DIGIT ZERO}) missing from current font "
+            + f"{t.get_fontname()}.",),
          (r"Matplotlib currently does not support Bengali natively.",)])
 
 
diff --git a/src/ft2font.cpp b/src/ft2font.cpp
@@ -184,11 +184,13 @@ FT2Image::draw_rect_filled(unsigned long x0, unsigned long y0, unsigned long x1,
     m_dirty = true;
 }
 
-static void ft_glyph_warn(FT_ULong charcode)
+static void ft_glyph_warn(FT_ULong charcode, FT_String *family_name)
 {
+    const char* name = (family_name != NULL)?family_name:"UNAVAILABLE";
     PyObject *text_helpers = NULL, *tmp = NULL;
+
     if (!(text_helpers = PyImport_ImportModule("matplotlib._text_helpers")) ||
-        !(tmp = PyObject_CallMethod(text_helpers, "warn_on_missing_glyph", "k", charcode))) {
+        !(tmp = PyObject_CallMethod(text_helpers, "warn_on_missing_glyph", "(k, s)", charcode, family_name))) {
         goto exit;
     }
 exit:
@@ -207,7 +209,7 @@ ft_get_char_index_or_warn(FT_Face face, FT_ULong charcode, bool warn = true)
         return glyph_index;
     }
     if (warn) {
-        ft_glyph_warn(charcode);
+        ft_glyph_warn(charcode, face->family_name);
     }
     return 0;
 }
@@ -515,8 +517,6 @@ void FT2Font::set_text(
                                                  char_to_font, glyph_to_font, codepoints[n], flags,
                                                  charcode_error, glyph_error, false);
         if (!was_found) {
-            ft_glyph_warn((FT_ULong)codepoints[n]);
-
             // render missing glyph tofu
             // come back to top-most font
             ft_object_with_glyph = this;
@@ -582,7 +582,6 @@ void FT2Font::load_char(long charcode, FT_Int32 flags, FT2Font *&ft_object, bool
         bool was_found = load_char_with_fallback(ft_object_with_glyph, final_glyph_index, glyphs, char_to_font,
                                 glyph_to_font, charcode, flags, charcode_error, glyph_error, true);
         if (!was_found) {
-            ft_glyph_warn(charcode);
             if (charcode_error) {
                 throw_ft_error("Could not load charcode", charcode_error);
             }
@@ -609,7 +608,7 @@ void FT2Font::load_char(long charcode, FT_Int32 flags, FT2Font *&ft_object, bool
 
 bool FT2Font::get_char_fallback_index(FT_ULong charcode, int& index) const
 {
-    FT_UInt glyph_index = FT_Get_Char_Index(face, charcode);
+    FT_UInt glyph_index = ft_get_char_index_or_warn(face, charcode);
     if (glyph_index) {
         // -1 means the host has the char and we do not need to fallback
         index = -1;
@@ -642,17 +641,14 @@ bool FT2Font::load_char_with_fallback(FT2Font *&ft_object_with_glyph,
                                       FT_Error &glyph_error,
                                       bool override = false)
 {
-    FT_UInt glyph_index = FT_Get_Char_Index(face, charcode);
-
+    FT_UInt glyph_index = ft_get_char_index_or_warn(face, charcode);
     if (glyph_index || override) {
-        charcode_error = FT_Load_Glyph(face, glyph_index, flags);
-        if (charcode_error) {
+        if (charcode_error=FT_Load_Glyph(face, glyph_index, flags)) {
             return false;
         }
 
         FT_Glyph thisGlyph;
-        glyph_error = FT_Get_Glyph(face->glyph, &thisGlyph);
-        if (glyph_error) {
+        if (glyph_error= FT_Get_Glyph(face->glyph, &thisGlyph)){
             return false;
         }
 
