:s/char_idx/glyph_idx

anntzer · anntzer · commit 7945e5b782dd · 2019-07-26T10:23:23.000+02:00
... to avoid confusion with the unicode codepoint.  FreeType's doc
mostly uses "glyph index", except that the function to get it is called
FT_Get_Char_Index...
diff --git a/lib/matplotlib/_text_layout.py b/lib/matplotlib/_text_layout.py
@@ -8,8 +8,8 @@
 def layout(string, font, *, kern_mode=KERNING_DEFAULT):
     """
     Render *string* with *font*.  For each character in *string*, yield a
-    (character-index, x-position) pair.  When such a pair is yielded, the
-    font's glyph is set to the corresponding character.
+    (glyph-index, x-position) pair.  When such a pair is yielded, the font's
+    glyph is set to the corresponding character.
 
     Parameters
     ----------
@@ -22,17 +22,17 @@ def layout(string, font, *, kern_mode=KERNING_DEFAULT):
 
     Yields
     ------
-    character_index : int
+    glyph_index : int
     x_position : float
     """
     x = 0
-    last_char_idx = None
+    last_glyph_idx = None
     for char in string:
-        char_idx = font.get_char_index(ord(char))
-        kern = (font.get_kerning(last_char_idx, char_idx, kern_mode)
-                if last_char_idx is not None else 0) / 64
+        glyph_idx = font.get_char_index(ord(char))
+        kern = (font.get_kerning(last_glyph_idx, glyph_idx, kern_mode)
+                if last_glyph_idx is not None else 0) / 64
         x += kern
-        glyph = font.load_glyph(char_idx, flags=LOAD_NO_HINTING)
-        yield char_idx, x
+        glyph = font.load_glyph(glyph_idx, flags=LOAD_NO_HINTING)
+        yield glyph_idx, x
         x += glyph.linearHoriAdvance / 65536
-        last_char_idx = char_idx
+        last_glyph_idx = glyph_idx
diff --git a/lib/matplotlib/backends/backend_ps.py b/lib/matplotlib/backends/backend_ps.py
@@ -625,8 +625,8 @@ def draw_text(self, gc, x, y, s, prop, angle, ismath=False, mtext=None):
             self.set_font(ps_name, prop.get_size_in_points())
 
             thetext = '\n'.join(
-                '%f 0 m /%s glyphshow' % (x, font.get_glyph_name(char_idx))
-                for char_idx, x in _text_layout.layout(s, font))
+                '%f 0 m /%s glyphshow' % (x, font.get_glyph_name(glyph_idx))
+                for glyph_idx, x in _text_layout.layout(s, font))
             self._pswriter.write(f"""\
 gsave
 {x:f} {y:f} translate
