Implement font fallback for libraqm

Author: QuLogic

lib/matplotlib/tests/test_text.py

@@ -121,8 +121,16 @@ def test_complex_shaping():
     text = (
         'Arabic: \N{Arabic Letter REH}\N{Arabic FATHA}\N{Arabic Letter QAF}'
         '\N{Arabic SUKUN}\N{Arabic Letter MEEM}')
-    fig = plt.figure(figsize=(3, 1))
-    fig.text(0.5, 0.5, text, size=32, ha='center', va='center')
+    math_signs = '\N{N-ary Product}\N{N-ary Coproduct}\N{N-ary summation}\N{Integral}'
+    text = math_signs + text + math_signs
+    fig = plt.figure(figsize=(6, 2))
+    fig.text(0.5, 0.75, text, size=32, ha='center', va='center')
+    # Also check fallback behaviour:
+    # - English should use cmr10
+    # - Math signs should use DejaVu Sans Display (and thus be larger than the rest)
+    # - Arabic should use DejaVu Sans
+    fig.text(0.5, 0.25, text, size=32, ha='center', va='center',
+             family=['cmr10', 'DejaVu Sans Display', 'DejaVu Sans'])
 
 
 @image_comparison(['multiline'])

src/ft2font.cpp

@@ -6,6 +6,7 @@
 #include <algorithm>
 #include <cstdio>
 #include <iterator>
+#include <map>
 #include <set>
 #include <stdexcept>
 #include <string>
@@ -360,13 +361,74 @@ void FT2Font::set_text(
         throw std::runtime_error("failed to set text flags for layout");
     }
 
-    std::set<FT_String*> glyph_seen_fonts;
-    glyph_seen_fonts.insert(face->family_name);
-
     if (!raqm_layout(rq)) {
         throw std::runtime_error("failed to layout text");
     }
 
+    std::vector<std::pair<size_t, const FT_Face&>> face_substitutions;
+    std::set<FT_String*> glyph_seen_fonts;
+    glyph_seen_fonts.insert(face->family_name);
+
+    // Attempt to use fallback fonts if necessary.
+    for (auto const& fallback : fallbacks) {
+        size_t num_glyphs = 0;
+        auto const& rq_glyphs = raqm_get_glyphs(rq, &num_glyphs);
+        bool new_fallback_used = false;
+
+        // Sort clusters, as RTL text will be returned in display, not saurce, order.
+        std::map<decltype(raqm_glyph_t::cluster), bool> cluster_missing;
+        for (size_t i = 0; i < num_glyphs; i++) {
+            auto const& rglyph = rq_glyphs[i];
+
+            // Sometimes multiple glyphs are necessary for a single cluster; if any are
+            // not found, we want to "poison" the whole set and keep them missing.
+            cluster_missing[rglyph.cluster] |= (rglyph.index == 0);
+        }
+
+        for (auto it = cluster_missing.cbegin(); it != cluster_missing.cend(); ) {
+            auto [cluster, missing] = *it;
+            ++it;  // Early change so we can access the next cluster below.
+            if (missing) {
+                auto next = (it != cluster_missing.cend()) ? it->first : text.size();
+                for (auto i = cluster; i < next; i++) {
+                    face_substitutions.emplace_back(i, fallback->face);
+                }
+                new_fallback_used = true;
+            }
+        }
+
+        if (new_fallback_used) {
+            // If a fallback was used, then re-attempt the layout with the new fonts.
+            if (!fallback->warn_if_used) {
+                glyph_seen_fonts.insert(fallback->face->family_name);
+            }
+
+            raqm_clear_contents(rq);
+            if (!raqm_set_text(rq,
+                               reinterpret_cast<const uint32_t *>(text.data()),
+                               text.size()))
+            {
+                throw std::runtime_error("failed to set text for layout");
+            }
+            if (!raqm_set_freetype_face(rq, face)) {
+                throw std::runtime_error("failed to set text face for layout");
+            }
+            for (auto [cluster, fallback] : face_substitutions) {
+                raqm_set_freetype_face_range(rq, fallback, cluster, 1);
+            }
+            if (!raqm_set_freetype_load_flags(rq, flags)) {
+                throw std::runtime_error("failed to set text flags for layout");
+            }
+
+            if (!raqm_layout(rq)) {
+                throw std::runtime_error("failed to layout text");
+            }
+        } else {
+            // If we never used a fallback, then we're good to go with the existing
+            // layout we have already made.
+            break;
+        }
+    }
 
     size_t num_glyphs = 0;
     auto const& rq_glyphs = raqm_get_glyphs(rq, &num_glyphs);