🌐 AI搜索 & 代理 主页
Skip to content

Conversation

@QuLogic
Copy link
Member

@QuLogic QuLogic commented Mar 1, 2025

PR summary

Font features allow font designers to provide alternate glyphs or shaping within a single font. These features may be accessed via special tags corresponding to internal tables of glyphs.

The mplcairo backend supports font features via an elaborate re-use of the font file path. This commit adds the API to make this officially supported in the main user API.

At this time, nothing in Matplotlib itself uses these settings, but they will have an effect with libraqm. I am opening this PR early for review of the API while I work through some issues with the latter. Consequently, the What's New note will not show the effect of this API, and there are only smoke tests.

PR checklist

@QuLogic
Copy link
Member Author

QuLogic commented Mar 1, 2025

The What's New entry with libraqm will look something more like this (minus a bug with the kerning, hopefully):
image

@anntzer
Copy link
Contributor

anntzer commented Mar 1, 2025

A difficulty that I've not really handled with mplcairo but warrants at least discussion is what you want to do with subranges. Harfbuzz supports toggling a feature only for some of the characters (see https://harfbuzz.github.io/harfbuzz-hb-common.html#hb-feature-from-string, e.g. aalt[3:5]=2), which mplcairo just forwards directly to harfbuzz, but this can(?) become problematic for multiline inputs, which get fed (by matplotlib) one-line-at-a-time to the rendering machinery, so something like aalt[3:5] likely(?) gets interpreted as "characters 3-to-5 of each line" rather than "characters 3-to-5 of the entire string".

The two main alternatives I can think of are either to do nothing, like mplcairo (subranges are interpreted as "repeated over each line"), or to reparse ranges and reinterpret them as "indices over the full string" (after line splitting, matplotlib tweaks the actual ranges than get fed to harfbuzz when shaping each line).

@anntzer
Copy link
Contributor

anntzer commented Mar 2, 2025

Also, looking at this again, I wonder how well this will interact with font fallback: it seems not unreasonable that two entries in the font fallback list would want to use different font features (e.g., a latin script and a chinese script likely want very different font features). Perhaps the real question here is whether font fallback should really have been implemented by stashing (references to) multiple fonts in a single FontProperties (though I'm not sure I can immediately design something much better), but the PR here makes the question more salient, I'd say.

@QuLogic
Copy link
Member Author

QuLogic commented Mar 22, 2025

Since we have automatic wrapping (Text(..., wrap=True)), I think the only possible implementation is to reparse the ranges ourselves.

For settings across font fallback, I guess that is possible to do, but it might require quite a bit of bookkeeping work.

@anntzer
Copy link
Contributor

anntzer commented Mar 22, 2025

The comments at #29794 (comment) also apply, but because this PR doesn't actually touch the rendering API, I guess it's fine.

@tacaswell
Copy link
Member

Discussed on a developer call we decided to not implement the sub-range application yet. Promoting a tuple of strings to Dict[tuple[int, int], Tuple[str, ...]] is something we can do unambiguously later and given that we expect most strings to be "short", hopefully the demand for mixed language within one Text object will be low.

@anntzer
Copy link
Contributor

anntzer commented May 7, 2025

Even if we don't explicitly support sub-ranges, we still need to decide what happens if someone writes e.g. fontfeatures=["+kern[3:5]"] (where the whole syntax gets interpreted by harfbuzz). It's probably fine to just document the limitation for now ("the interaction of subranges and multiline text is currently unspecified and behavior may change in the future").

@QuLogic
Copy link
Member Author

QuLogic commented May 12, 2025

Since we moved the information from FontProperties to Text, I was actually going to implement the splitting. However, I ran into an issue in that the Text object is only supplied to Renderer.draw_text if the string is not multiline:

mtext = self if len(info) == 1 else None

I tried a small change:

diff --git a/lib/matplotlib/text.py b/lib/matplotlib/text.py
index 3b0de58814..b255a93c52 100644
--- a/lib/matplotlib/text.py
+++ b/lib/matplotlib/text.py
@@ -800,9 +800,7 @@ class Text(Artist):
 
             angle = self.get_rotation()
 
             for line, wh, x, y in info:
-
-                mtext = self if len(info) == 1 else None
                 x = x + posx
                 y = y + posy
                 if renderer.flipy():
@@ -816,14 +814,19 @@ class Text(Artist):
                 else:
                     textrenderer = renderer
 
-                if self.get_usetex():
-                    textrenderer.draw_tex(gc, x, y, clean_line,
-                                          self._fontproperties, angle,
-                                          mtext=mtext)
-                else:
-                    textrenderer.draw_text(gc, x, y, clean_line,
-                                           self._fontproperties, angle,
-                                           ismath=ismath, mtext=mtext)
+                xt, yt = self.get_transform().inverted().transform((x, y))
+                with cbook._setattr_cm(self, _x=xt, _y=yt, _text=clean_line,
+                                       convert_xunits=lambda x: x,
+                                       convert_yunits=lambda y: y,
+                                       _horizontalalignment='left', _verticalalignment='bottom'):
+                    if self.get_usetex():
+                        textrenderer.draw_tex(gc, x, y, clean_line,
+                                              self._fontproperties, angle,
+                                              mtext=self)
+                    else:
+                        textrenderer.draw_text(gc, x, y, clean_line,
+                                               self._fontproperties, angle,
+                                               ismath=ismath, mtext=self)
 
         gc.restore()
         renderer.close_group('text')

AFAICT, only the PGF backend uses mtext and under certain conditions will place the text using the original position and alignment instead of the x/y passed to draw_text. Unfortunately, these don't seem to match (I assume the x/y passed in accounts for the descenders and other flourishes), so this breaks the PGF tests. I wonder if there's a better condition to be put in here:

if mtext and (
(angle == 0 or
mtext.get_rotation_mode() == "anchor") and
mtext.get_verticalalignment() != "center_baseline"):

@QuLogic QuLogic changed the base branch from main to text-overhaul June 5, 2025 01:38
@QuLogic QuLogic moved this to Waiting for other PR in Font and text overhaul Jun 5, 2025
@QuLogic QuLogic moved this from Waiting for other PR to Todo in Font and text overhaul Jun 5, 2025
@QuLogic QuLogic linked an issue Jul 1, 2025 that may be closed by this pull request
@image_comparison(baseline_images=['features.png'], remove_text=False, style='mpl20')
def test_text_features():
fig = plt.figure(figsize=(5, 1.5))
t = fig.text(0, 0.7, 'Default: fi ffi fl st', fontsize=32)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you pad out the label strings to the same size so that the first letters of the example text line up? Does not matter for the machine to check, but makes it a bit easier for the humans to check the differences.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you want it aligned in the input text, or in the resulting image? If I align it in the input, then it's not quite right in the result because it's not monospace:
features
but I could change to right alignment, which would be close, I think?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right alignment looks good, I think:
features

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I spend so much time looking at monospace fonts I forget not all fonts are monospace 🤦🏻 .

Right-align is exactly what I wanted.

@QuLogic QuLogic force-pushed the font-features branch 2 times, most recently from b474c3e to 062b130 Compare September 26, 2025 02:40
Copy link
Member

@ksunden ksunden left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving but not merging because some image change squashing/interactions with other PRs can be handled by @QuLogic

Font features allow font designers to provide alternate glyphs or
shaping within a single font. These features may be accessed via special
tags corresponding to internal tables of glyphs.

The mplcairo backend supports font features via an elaborate re-use of
the font file path [1]. This commit adds the API to make this officially
supported in the main user API.

[1] https://github.com/matplotlib/mplcairo/blob/v0.6.1/README.rst#font-formats-and-features
@QuLogic
Copy link
Member Author

QuLogic commented Oct 3, 2025

Rebased without the image change (moved to text-overhaul-figures branch) so this can be merged. Going to ignore the linting error, as that's known #30626.

@QuLogic QuLogic merged commit a6ac58f into matplotlib:text-overhaul Oct 3, 2025
36 of 37 checks passed
@github-project-automation github-project-automation bot moved this from Ready for Review to Done in Font and text overhaul Oct 3, 2025
@QuLogic QuLogic deleted the font-features branch October 3, 2025 03:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

OTF feature support (alternate figure styles, etc.)

7 participants