Fix Windows 10 support for nearby font loading #12554
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| // Copyright (c) Microsoft Corporation. | ||
| // Licensed under the MIT license. | ||
|
|
||
| #pragma once | ||
|
|
||
| namespace Microsoft::Console::Render::FontCache | ||
| { | ||
| namespace details | ||
| { | ||
| inline const std::vector<wil::com_ptr<IDWriteFontFile>>& getNearbyFontFiles(IDWriteFactory5* factory5) | ||
| { | ||
| static const auto fontFiles = [=]() { | ||
| std::vector<wil::com_ptr<IDWriteFontFile>> files; | ||
|
|
||
| const std::filesystem::path module{ wil::GetModuleFileNameW<std::wstring>(nullptr) }; | ||
| const auto folder{ module.parent_path() }; | ||
|
|
||
| for (const auto& p : std::filesystem::directory_iterator(folder)) | ||
| { | ||
| if (til::ends_with(p.path().native(), L".ttf")) | ||
| { | ||
| wil::com_ptr<IDWriteFontFile> fontFile; | ||
| if (SUCCEEDED_LOG(factory5->CreateFontFileReference(p.path().c_str(), nullptr, fontFile.addressof()))) | ||
|
There was a problem hiding this comment. so it's safe to use these objects on different threads because it is a SHARED-type factory? neato There was a problem hiding this comment.
|
||
| { | ||
| files.emplace_back(std::move(fontFile)); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| files.shrink_to_fit(); | ||
| return files; | ||
| }(); | ||
| return fontFiles; | ||
| } | ||
|
|
||
| inline wil::com_ptr<IDWriteFontCollection> getFontCollection(bool forceUpdate) | ||
|
There was a problem hiding this comment. I'm kinda just trusting that this bit of the code will work as expected. I don't totally know the mechanical differences between a There was a problem hiding this comment. BTW the new code is what |
||
| { | ||
| wil::com_ptr<IDWriteFactory> factory; | ||
| THROW_IF_FAILED(DWriteCreateFactory(DWRITE_FACTORY_TYPE_SHARED, __uuidof(factory), reinterpret_cast<::IUnknown**>(factory.addressof()))); | ||
|
|
||
| wil::com_ptr<IDWriteFontCollection> systemFontCollection; | ||
| THROW_IF_FAILED(factory->GetSystemFontCollection(systemFontCollection.addressof(), forceUpdate)); | ||
|
|
||
| if constexpr (Feature_NearbyFontLoading::IsEnabled()) | ||
| { | ||
| // IDWriteFactory5 is supported since Windows 10, build 15021. | ||
| const auto factory5 = factory.try_query<IDWriteFactory5>(); | ||
| if (!factory5) | ||
| { | ||
| return systemFontCollection; | ||
| } | ||
|
|
||
| const auto& nearbyFontFiles = getNearbyFontFiles(factory5.get()); | ||
| if (nearbyFontFiles.empty()) | ||
| { | ||
| return systemFontCollection; | ||
| } | ||
|
|
||
| wil::com_ptr<IDWriteFontSet> systemFontSet; | ||
| // IDWriteFontCollection1 is supported since Windows 7. | ||
| THROW_IF_FAILED(systemFontCollection.query<IDWriteFontCollection1>()->GetFontSet(systemFontSet.addressof())); | ||
|
|
||
| wil::com_ptr<IDWriteFontSetBuilder1> fontSetBuilder; | ||
| THROW_IF_FAILED(factory5->CreateFontSetBuilder(fontSetBuilder.addressof())); | ||
| THROW_IF_FAILED(fontSetBuilder->AddFontSet(systemFontSet.get())); | ||
|
|
||
| for (const auto& file : nearbyFontFiles) | ||
| { | ||
| LOG_IF_FAILED(fontSetBuilder->AddFontFile(file.get())); | ||
| } | ||
|
|
||
| wil::com_ptr<IDWriteFontSet> fontSet; | ||
| THROW_IF_FAILED(fontSetBuilder->CreateFontSet(fontSet.addressof())); | ||
|
|
||
| wil::com_ptr<IDWriteFontCollection1> fontCollection; | ||
| THROW_IF_FAILED(factory5->CreateFontCollectionFromFontSet(fontSet.get(), fontCollection.addressof())); | ||
|
|
||
| return std::move(fontCollection); | ||
| } | ||
| else | ||
| { | ||
| return systemFontCollection; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| inline wil::com_ptr<IDWriteFontCollection> GetCached() | ||
| { | ||
| return details::getFontCollection(false); | ||
| } | ||
|
|
||
| inline wil::com_ptr<IDWriteFontCollection> GetFresh() | ||
| { | ||
| return details::getFontCollection(true); | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Windows Terminal ignores the HRESULT this function returns and will simply crash with a division by 0 error if it wasn't for this new code. This implements font fallback in a similar way as DxEngine does.
In the future Terminal shouldn't ignore the HRESULT and call UpdateFont() with fallback fonts itself until this method succeeds.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should we track this work?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added a short note in #9999.