Add support for customizing font fallback by lhecker · Pull Request #16821 · microsoft/terminal

lhecker · 2024-03-05T17:49:53Z

This adds support for specifying more than one font family using a
syntax that is similar to CSS' font-family property.
The implementation is straight-forward and is effectively
just a wrapper around IDWriteFontFallbackBuilder.

Closes #2664

PR Checklist

Font fallback
- Write "「猫」"
- Use "Consolas" and remember the shape of the glyphs
- Use "Consolas, MS Gothic" and check that it changed ✅
Settings UI autocompletion
- It completes ✅
- It filters ✅
- It recognizes commas and starts a new name ✅
All invalid font names are listed in the warning message ✅

.github/actions/spelling/expect/expect.txt

tools/Lock-CascadiaFont.ps1

lhecker · 2024-03-05T17:50:53Z

src/cascadia/TerminalControl/ControlCore.cpp

-                                                      _actualFont.GetFaceName()) };
-            auto noticeArgs = winrt::make<NoticeEventArgs>(NoticeLevel::Warning, message);
-            _RaiseNoticeHandlers(*this, std::move(noticeArgs));
-        }


This went into TermControl.cpp.

lhecker · 2024-03-05T17:51:35Z

src/cascadia/TerminalControl/EventArgs.h


-        WINRT_PROPERTY(uint64_t, Result);
+        WINRT_PROPERTY(HRESULT, Result);
+        WINRT_PROPERTY(winrt::hstring, Parameter);


This will allow us to carry messages to the warning popup code in TermControl.

lhecker · 2024-03-05T17:52:59Z

src/cascadia/TerminalSettingsEditor/Appearances.cpp

-            }
-        }
-        return _hasPowerlineCharacters.value_or(false);
-    }


Font::HasPowerlineCharacters() was moved to AppearanceViewModel::HasPowerlineCharacters(), because "has" is now a function of >1 fonts (= can't be attached to a single Font instance). The detection itself went into _refreshFontFaceDependents below.

lhecker · 2024-03-05T17:54:05Z

src/cascadia/TerminalSettingsEditor/Appearances.cpp

        // find one axis that does not already exist, and add that
        // if there are no more possible axes to add, the button is disabled so there shouldn't be a way to get here
-        const auto possibleAxesTagsAndNames = ProfileViewModel::FindFontWithLocalizedName(FontFace()).FontAxesTagsAndNames();
+        const auto possibleAxesTagsAndNames = ProfileViewModel::FindFontWithLocalizedName(_primaryFontName).FontAxesTagsAndNames();


These are all placeholders until we refactor the font axis/feature code later on.
Refactoring it as part of this PR was not possible unfortunately.

Just curious as to what the refactor entails - do we need to combine all the possible axes/features for all the fonts in the given family?

Yes. We'll have to basically detach the Font object entirely from axes and features. In my opinion we should move the (re)generation of axes and features from Font, ProfileViewModel, and Appearance all over into AppearanceViewModel.
There, we have access to the parsed list of fonts families (which this PR adds) and this allows us to generate the union of axes and features. Then we can split the collection up into those that are currently in use and those that are still available for selection and expose both lists (in whatever form) to the view.

Also, it may be worth mentioning that we create AppearanceViewModels eagerly when loading the settings UI, which is not great, because this causes all the DirectWrite code to run eagerly too. It'd be nice if they were created lazily somehow. (I mean we don't have to address that now - it's just a thing I noticed.)

lhecker · 2024-03-05T17:55:40Z

src/cascadia/TerminalSettingsEditor/ViewModelHelpers.h


 #define _BASE_OBSERVABLE_PROJECTED_SETTING(target, name) \
 public:                                                  \
-    auto name() const noexcept                           \


WinRT function calls are never noexcept so this was always a lie. 😅

src/cascadia/TerminalControl/Resources/en-US/Resources.resw

src/cascadia/TerminalSettingsEditor/Resources/en-US/Resources.resw

…-fallback

DHowett · 2024-03-26T16:21:58Z

src/inc/til/string.h

+                        // Commas are treated literally inside strings.
+                        break;
+                    }
+                    if (!family.empty())


delayedSpace is ignored here - which I believe is correct?

Yes, because we want to strip trailing whitespace.

zadjii-msft

This is a ✅ EXCEPT for the very scary sounding FindFontWithLocalizedName comment that doesn't have a linked work item. If that's 1.21 blocking, then we need to make sure we get to it.

src/renderer/atlas/AtlasEngine.api.cpp

zadjii-msft · 2024-03-26T16:28:49Z

src/cascadia/TerminalSettingsEditor/Appearances.cpp

+            appearance.FontFace(fontSpec);
+        }
+
+        // TODO: Any use of FindFontWithLocalizedName is broken and requires refactoring in time for version 1.21.


on a scale of 1-scary, this comment sounds scary? Like, ship-blocking scary. Do we have a plan for this?

Font features and axes have multiple blocking bugs right now anyway (I mean even without this PR), so I figured that we can do a follow-up refactoring later where we fix both issues: The existing bugs and the incompatibilities introduced by this one. I'm half done making the changes to fix this and they're highly related.

Mmk. I'll file something and tag you on it just to make sure we don't lose it.

src/inc/til/string.h

src/cascadia/TerminalSettingsEditor/Appearances.xaml

src/cascadia/TerminalSettingsEditor/Appearances.cpp

src/cascadia/TerminalSettingsEditor/Appearances.h

…-fallback

src/renderer/atlas/AtlasEngine.h

* Since `FindFontWithLocalizedName` is broken (intentionally and temporarily until #16943 is fixed) we have to be extra be careful not to return a nullptr `Font`. * Portable builds may not have a broken font cache, but also not have the given font (Cascadia Mono for instance) installed. This requires us to load the nearby fonts even if there aren't any exceptions. ## Validation Steps Performed * Open `src/cascadia/CascadiaResources.build.items` and remove the `Condition` for .ttf files * Deploy on a clean Windows 10 VM * Cascadia Mono loads without issues ✅ * Open the `Settings > Defaults > Appearance`, enter a non-existing font and hit Save * Doesn't crash ✅

Due to #16821 everything about #16104 broke. This PR rights the wrongs by rewriting all the `Font`-based code to not use `Font` at all. Instead we split the font spec once into font families, do a lot of complex logic to split font axes/features into used and unused ones and construct all the UI elements. So. much. boilerplate. code. Closes #16943 ## Validation Steps Performed There are more edge cases than I can list here... Some ideas: * Edit the settings.json with invalid axis/feature keys ✅ * ...out of range values ✅ * Settings UI reloads when the settings.json changes ✅ * Adding axes/features works ✅ * Removing axes/features works ✅ * Resetting axes/features works ✅ * Axes/features apply in the renderer when saving ✅

laurensdc · 2024-07-13T12:46:31Z

This doesn't seem to work?

I'm configuring it as follows:

 "profiles": 
    {
        "defaults": 
        {
            "colorScheme": "One Half Dark",
            "experimental.retroTerminalEffect": false,
            "font": 
            {
                "face": "Comic Code Ligatures, FiraCode Nerd Font Mono",
                "features": {
                    "liga": 1
                },
                "size": 10.0,
                "weight": "light"
            },

            "opacity": 80,
            "useAcrylic": true
        },

and get the following error:

I'm on version 1.20.11781.0

lhecker · 2024-07-13T18:11:05Z

It's in Windows Terminal Preview right now (version 1.21). You can find it in the app store, or here: https://github.com/microsoft/terminal/releases/tag/v1.21.1772.0

laurensdc · 2024-07-13T18:37:38Z

Ah I thought I was going crazy, but makes sense. Thanks a lot! Works like a charm as well!!

## Summary of the Pull Request Replaces the `ComboBox` used for built-in profile icons with an `AutoSuggestBox` to allow for searching. ## References and Relevant Issues Practically plagiarizes #16821 ## Validation Steps Performed ✅ It completes ✅ It filters ## PR Checklist Closes #19457

Add support for customizing font fallback

f3d0ec2

microsoft-github-policy-service bot added Issue-Task It's a feature request, but it doesn't really need a major design. Area-Fonts Related to the font Area-Settings Issues related to settings and customizability, for console or terminal Product-Terminal The new Windows Terminal. labels Mar 5, 2024

github-advanced-security bot found potential problems Mar 5, 2024

View reviewed changes

.github/actions/spelling/expect/expect.txt Fixed Show fixed Hide fixed

tools/Lock-CascadiaFont.ps1 Fixed Show fixed Hide fixed

tools/Lock-CascadiaFont.ps1 Fixed Show fixed Hide fixed

This comment has been minimized.

Sign in to view

lhecker commented Mar 5, 2024

View reviewed changes

Spel

c890a4e

DHowett reviewed Mar 5, 2024

View reviewed changes

lhecker added 2 commits March 6, 2024 02:02

Address feedback

77698da

Spel again

37d7226

zadjii-msft mentioned this pull request Mar 6, 2024

Parse/understand weight suffixes in font names #9744

Open

lhecker added 2 commits March 18, 2024 19:24

Merge remote-tracking branch 'origin/main' into dev/lhecker/2664-font…

3b1a53b

…-fallback

Merge remote-tracking branch 'origin/main' into dev/lhecker/2664-font…

37105d3

…-fallback

DHowett reviewed Mar 26, 2024

View reviewed changes

zadjii-msft reviewed Mar 26, 2024

View reviewed changes

DHowett approved these changes Mar 26, 2024

View reviewed changes

lhecker added 2 commits March 26, 2024 19:47

Merge remote-tracking branch 'origin/main' into dev/lhecker/2664-font…

a7ad1c1

…-fallback

Address feedback (partial)

fa57776

zadjii-msft mentioned this pull request Mar 26, 2024

Any use of FindFontWithLocalizedName is broken and requires refactoring #16943

Closed

zadjii-msft approved these changes Mar 26, 2024

View reviewed changes

Address remaining feedback

116e17d

DHowett approved these changes Mar 26, 2024

View reviewed changes

DHowett added this pull request to the merge queue Mar 26, 2024

github-merge-queue bot removed this pull request from the merge queue due to a conflict with the base branch Mar 26, 2024

Merge branch 'main' into dev/lhecker/2664-font-fallback

b4b1a59

DHowett reviewed Mar 26, 2024

View reviewed changes

src/renderer/atlas/AtlasEngine.h Outdated Show resolved Hide resolved

Update src/renderer/atlas/AtlasEngine.h

13b834b

DHowett enabled auto-merge March 26, 2024 22:41

carlos-zamora approved these changes Mar 26, 2024

View reviewed changes

DHowett added this pull request to the merge queue Mar 26, 2024

Merged via the queue into main with commit de7f931 Mar 26, 2024

DHowett deleted the dev/lhecker/2664-font-fallback branch March 26, 2024 23:38

zadjii-msft mentioned this pull request Apr 1, 2024

Settings Editor is not launching in PGO tests #16960

Closed

lhecker added a commit that referenced this pull request Apr 1, 2024

Fix bugs introduced in #16821 (custom font fallback)

a74d6b5

lhecker mentioned this pull request Apr 16, 2024

Customized fonts not working #17061

Closed

abceleung mentioned this pull request Apr 24, 2024

Add the Nerd Fonts support be5invis/Sarasa-Gothic#379

Closed

lhecker mentioned this pull request Apr 30, 2024

Fix font axes/features settings UI #17164

Merged

carlos-zamora mentioned this pull request Sep 12, 2024

[Windows Terminal - Settings - Defaults]: Unable to navigate 'Font face' suggestions using keyboard in Appearance settings. #17916

Closed

rachartier mentioned this pull request Nov 28, 2024

perf: use blend hl groups sphamba/smear-cursor.nvim#24

Merged

carlos-zamora mentioned this pull request Oct 27, 2025

Enhancement: Add search icon functionality to dropdowns #19457

Closed

carlos-zamora mentioned this pull request Nov 20, 2025

Replace BuiltInIcon ComboBox with AutoSuggestBox #19569

Merged

Conversation

lhecker commented Mar 5, 2024

PR Checklist

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment has been minimized.

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lhecker Mar 6, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lhecker Mar 6, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zadjii-msft left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lhecker Mar 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

laurensdc commented Jul 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lhecker commented Jul 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

laurensdc commented Jul 13, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

lhecker Mar 6, 2024 •

edited

Loading

lhecker Mar 6, 2024 •

edited

Loading

lhecker Mar 26, 2024 •

edited

Loading

laurensdc commented Jul 13, 2024 •

edited

Loading

lhecker commented Jul 13, 2024 •

edited

Loading