diff --git a/src/console_cmds.cpp b/src/console_cmds.cpp index 3293c4704f..52dfc9cffa 100644 --- a/src/console_cmds.cpp +++ b/src/console_cmds.cpp @@ -2369,7 +2369,7 @@ static bool ConFont(std::span argv) FontCacheSubSetting *setting = GetFontCacheSubSetting(fs); /* Make sure all non sprite fonts are loaded. */ if (!setting->font.empty() && !fc->HasParent()) { - InitFontCache(fs == FS_MONO); + InitFontCache(fs); fc = FontCache::Get(fs); } IConsolePrint(CC_DEFAULT, "{} font:", FontSizeToName(fs)); diff --git a/src/fontcache.cpp b/src/fontcache.cpp index dcdc1804c9..d1be5e6ac2 100644 --- a/src/fontcache.cpp +++ b/src/fontcache.cpp @@ -126,10 +126,10 @@ void SetFont(FontSize fontsize, const std::string &font, uint size) CheckForMissingGlyphs(); _fcsettings = std::move(backup); } else { - InitFontCache(true); + InitFontCache(fontsize); } - LoadStringWidthTable(fontsize == FS_MONO); + LoadStringWidthTable(fontsize); UpdateAllVirtCoords(); ReInitAllWindows(true); @@ -213,15 +213,13 @@ std::string GetFontCacheFontName(FontSize fs) /** * (Re)initialize the font cache related things, i.e. load the non-sprite fonts. - * @param monospace Whether to initialise the monospace or regular fonts. + * @param fontsizes Font sizes to be initialised. */ -void InitFontCache(bool monospace) +void InitFontCache(FontSizes fontsizes) { FontCache::InitializeFontCaches(); - for (FontSize fs = FS_BEGIN; fs < FS_END; fs++) { - if (monospace != (fs == FS_MONO)) continue; - + for (FontSize fs : fontsizes) { FontCache *fc = FontCache::Get(fs); if (fc->HasParent()) delete fc; diff --git a/src/fontcache.h b/src/fontcache.h index 5026694f58..2ee0d240af 100644 --- a/src/fontcache.h +++ b/src/fontcache.h @@ -70,16 +70,6 @@ public: */ virtual int GetFontSize() const { return this->height; } - /** - * Map a SpriteID to the key - * @param key The key to map to. - * @param sprite The sprite that is being mapped. - */ - virtual void SetUnicodeGlyph(char32_t key, SpriteID sprite) = 0; - - /** Initialize the glyph map */ - virtual void InitializeUnicodeGlyphMap() = 0; - /** Clear the font cache. */ virtual void ClearFontCache() = 0; @@ -153,23 +143,9 @@ public: virtual bool IsBuiltInFont() = 0; }; -/** Map a SpriteID to the font size and key */ -inline void SetUnicodeGlyph(FontSize size, char32_t key, SpriteID sprite) +inline void ClearFontCache(FontSizes fontsizes) { - FontCache::Get(size)->SetUnicodeGlyph(key, sprite); -} - -/** Initialize the glyph map */ -inline void InitializeUnicodeGlyphMap() -{ - for (FontSize fs = FS_BEGIN; fs < FS_END; fs++) { - FontCache::Get(fs)->InitializeUnicodeGlyphMap(); - } -} - -inline void ClearFontCache() -{ - for (FontSize fs = FS_BEGIN; fs < FS_END; fs++) { + for (FontSize fs : fontsizes) { FontCache::Get(fs)->ClearFontCache(); } } @@ -231,10 +207,14 @@ inline FontCacheSubSetting *GetFontCacheSubSetting(FontSize fs) uint GetFontCacheFontSize(FontSize fs); std::string GetFontCacheFontName(FontSize fs); -void InitFontCache(bool monospace); +void InitFontCache(FontSizes fontsizes); void UninitFontCache(); bool GetFontAAState(); void SetFont(FontSize fontsize, const std::string &font, uint size); +/* Implemented in spritefontcache.cpp */ +void InitializeUnicodeGlyphMap(); +void SetUnicodeGlyph(FontSize size, char32_t key, SpriteID sprite); + #endif /* FONTCACHE_H */ diff --git a/src/fontcache/spritefontcache.cpp b/src/fontcache/spritefontcache.cpp index cb49ad2817..e2d93189c2 100644 --- a/src/fontcache/spritefontcache.cpp +++ b/src/fontcache/spritefontcache.cpp @@ -10,6 +10,7 @@ #include "../stdafx.h" #include "../fontcache.h" #include "../gfx_layout.h" +#include "../string_func.h" #include "../zoom_func.h" #include "spritefontcache.h" @@ -31,41 +32,43 @@ static int ScaleFontTrad(int value) return UnScaleByZoom(value * ZOOM_BASE, _font_zoom); } -/** - * Create a new sprite font cache. - * @param fs The font size to create the cache for. - */ -SpriteFontCache::SpriteFontCache(FontSize fs) : FontCache(fs) -{ - this->InitializeUnicodeGlyphMap(); - this->height = ScaleGUITrad(FontCache::GetDefaultFontHeight(this->fs)); - this->ascender = (this->height - ScaleFontTrad(FontCache::GetDefaultFontHeight(this->fs))) / 2; -} +static std::array, FS_END> _char_maps{}; ///< Glyph map for each font size. /** * Get SpriteID associated with a character. * @param key Character to find. * @return SpriteID for character, or 0 if not present. */ -SpriteID SpriteFontCache::GetUnicodeGlyph(char32_t key) +static SpriteID GetUnicodeGlyph(FontSize fs, char32_t key) { - const auto found = this->char_map.find(key); - if (found == std::end(this->char_map)) return 0; - return found->second; + auto found = _char_maps[fs].find(key); + if (found != std::end(_char_maps[fs])) return found->second; + return 0; } -void SpriteFontCache::SetUnicodeGlyph(char32_t key, SpriteID sprite) +/** + * Set the SpriteID for a unicode character. + * @param fs Font size to set. + * @param key Unicode character to set. + * @param sprite SpriteID of character. + */ +void SetUnicodeGlyph(FontSize fs, char32_t key, SpriteID sprite) { - this->char_map[key] = sprite; + _char_maps[fs][key] = sprite; } -void SpriteFontCache::InitializeUnicodeGlyphMap() +/** + * Initialize the glyph map for a font size. + * This populates the glyph map with the baseset font sprites. + * @param fs Font size to initialize. + */ +void InitializeUnicodeGlyphMap(FontSize fs) { /* Clear out existing glyph map if it exists */ - this->char_map.clear(); + _char_maps[fs].clear(); SpriteID base; - switch (this->fs) { + switch (fs) { default: NOT_REACHED(); case FS_MONO: // Use normal as default for mono spaced font case FS_NORMAL: base = SPR_ASCII_SPACE; break; @@ -76,24 +79,45 @@ void SpriteFontCache::InitializeUnicodeGlyphMap() for (uint i = ASCII_LETTERSTART; i < 256; i++) { SpriteID sprite = base + i - ASCII_LETTERSTART; if (!SpriteExists(sprite)) continue; - this->SetUnicodeGlyph(i, sprite); - this->SetUnicodeGlyph(i + SCC_SPRITE_START, sprite); + SetUnicodeGlyph(fs, i, sprite); + SetUnicodeGlyph(fs, i + SCC_SPRITE_START, sprite); } + /* Modify map to move non-standard glyphs to a better unicode codepoint. */ for (const auto &unicode_map : _default_unicode_map) { uint8_t key = unicode_map.key; if (key == CLRA) { /* Clear the glyph. This happens if the glyph at this code point * is non-standard and should be accessed by an SCC_xxx enum * entry only. */ - this->SetUnicodeGlyph(unicode_map.code, 0); + SetUnicodeGlyph(fs, unicode_map.code, 0); } else { SpriteID sprite = base + key - ASCII_LETTERSTART; - this->SetUnicodeGlyph(unicode_map.code, sprite); + SetUnicodeGlyph(fs, unicode_map.code, sprite); } } } +/** + * Initialize the glyph map. + */ +void InitializeUnicodeGlyphMap() +{ + for (FontSize fs = FS_BEGIN; fs < FS_END; fs++) { + InitializeUnicodeGlyphMap(fs); + } +} + +/** + * Create a new sprite font cache. + * @param fs The font size to create the cache for. + */ +SpriteFontCache::SpriteFontCache(FontSize fs) : FontCache(fs) +{ + this->height = ScaleGUITrad(FontCache::GetDefaultFontHeight(this->fs)); + this->ascender = (this->height - ScaleFontTrad(FontCache::GetDefaultFontHeight(this->fs))) / 2; +} + void SpriteFontCache::ClearFontCache() { Layouter::ResetFontCache(this->fs); @@ -104,21 +128,21 @@ void SpriteFontCache::ClearFontCache() const Sprite *SpriteFontCache::GetGlyph(GlyphID key) { SpriteID sprite = static_cast(key & ~SPRITE_GLYPH); - if (sprite == 0) sprite = this->GetUnicodeGlyph('?'); + if (sprite == 0) sprite = GetUnicodeGlyph(this->fs, '?'); return GetSprite(sprite, SpriteType::Font); } uint SpriteFontCache::GetGlyphWidth(GlyphID key) { SpriteID sprite = static_cast(key & ~SPRITE_GLYPH); - if (sprite == 0) sprite = this->GetUnicodeGlyph('?'); + if (sprite == 0) sprite = GetUnicodeGlyph(this->fs, '?'); return SpriteExists(sprite) ? GetSprite(sprite, SpriteType::Font)->width + ScaleFontTrad(this->fs != FS_NORMAL ? 1 : 0) : 0; } GlyphID SpriteFontCache::MapCharToGlyph(char32_t key, [[maybe_unused]] bool allow_fallback) { assert(IsPrintable(key)); - SpriteID sprite = this->GetUnicodeGlyph(key); + SpriteID sprite = GetUnicodeGlyph(this->fs, key); if (sprite == 0) return 0; return SPRITE_GLYPH | sprite; } diff --git a/src/fontcache/spritefontcache.h b/src/fontcache/spritefontcache.h index 1f2a09a9c6..5403348cbe 100644 --- a/src/fontcache/spritefontcache.h +++ b/src/fontcache/spritefontcache.h @@ -10,15 +10,12 @@ #ifndef SPRITEFONTCACHE_H #define SPRITEFONTCACHE_H -#include "../string_func.h" #include "../fontcache.h" /** Font cache for fonts that are based on a freetype font. */ class SpriteFontCache : public FontCache { public: SpriteFontCache(FontSize fs); - void SetUnicodeGlyph(char32_t key, SpriteID sprite) override; - void InitializeUnicodeGlyphMap() override; void ClearFontCache() override; const Sprite *GetGlyph(GlyphID key) override; uint GetGlyphWidth(GlyphID key) override; @@ -26,10 +23,6 @@ public: GlyphID MapCharToGlyph(char32_t key, bool allow_fallback = true) override; std::string GetFontName() override { return "sprite"; } bool IsBuiltInFont() override { return true; } - -private: - std::unordered_map char_map{}; ///< Mapping of characters to sprite IDs. - SpriteID GetUnicodeGlyph(char32_t key); }; #endif /* SPRITEFONTCACHE_H */ diff --git a/src/fontcache/truetypefontcache.h b/src/fontcache/truetypefontcache.h index 2ce94c5d35..7714823305 100644 --- a/src/fontcache/truetypefontcache.h +++ b/src/fontcache/truetypefontcache.h @@ -46,8 +46,6 @@ public: TrueTypeFontCache(FontSize fs, int pixels); virtual ~TrueTypeFontCache(); int GetFontSize() const override { return this->used_size; } - void SetUnicodeGlyph(char32_t key, SpriteID sprite) override { this->parent->SetUnicodeGlyph(key, sprite); } - void InitializeUnicodeGlyphMap() override { this->parent->InitializeUnicodeGlyphMap(); } const Sprite *GetGlyph(GlyphID key) override; void ClearFontCache() override; uint GetGlyphWidth(GlyphID key) override; diff --git a/src/gfx.cpp b/src/gfx.cpp index 1add357877..9ba985e971 100644 --- a/src/gfx.cpp +++ b/src/gfx.cpp @@ -8,6 +8,7 @@ /** @file gfx.cpp Handling of drawing text and other gfx related stuff. */ #include "stdafx.h" +#include "gfx_func.h" #include "gfx_layout.h" #include "progress.h" #include "zoom_func.h" @@ -1240,14 +1241,14 @@ static void GfxMainBlitter(const Sprite *sprite, int x, int y, BlitterMode mode, } /** - * Initialize _stringwidth_table cache - * @param monospace Whether to load the monospace cache or the normal fonts. + * Initialize _stringwidth_table cache for the specified font sizes. + * @param fontsizes Font sizes to initialise. */ -void LoadStringWidthTable(bool monospace) +void LoadStringWidthTable(FontSizes fontsizes) { - ClearFontCache(); + ClearFontCache(fontsizes); - for (FontSize fs = monospace ? FS_MONO : FS_BEGIN; fs < (monospace ? FS_END : FS_MONO); fs++) { + for (FontSize fs : fontsizes) { for (uint i = 0; i != 224; i++) { _stringwidth_table[fs][i] = GetGlyphWidth(fs, i + 32); } @@ -1812,7 +1813,7 @@ bool AdjustGUIZoom(bool automatic) if (old_font_zoom != _font_zoom) { GfxClearFontSpriteCache(); } - ClearFontCache(); + ClearFontCache(FONTSIZES_ALL); LoadStringWidthTable(); SetupWidgetDimensions(); diff --git a/src/gfx_func.h b/src/gfx_func.h index 655b167c37..edd5b03d82 100644 --- a/src/gfx_func.h +++ b/src/gfx_func.h @@ -149,7 +149,7 @@ int GetStringHeight(StringID str, int maxw); int GetStringLineCount(std::string_view str, int maxw); Dimension GetStringMultiLineBoundingBox(StringID str, const Dimension &suggestion); Dimension GetStringMultiLineBoundingBox(std::string_view str, const Dimension &suggestion, FontSize fontsize = FS_NORMAL); -void LoadStringWidthTable(bool monospace = false); +void LoadStringWidthTable(FontSizes fontsizes = FONTSIZES_REQUIRED); void DrawDirtyBlocks(); void AddDirtyBlock(int left, int top, int right, int bottom); diff --git a/src/gfx_type.h b/src/gfx_type.h index 664aecaed9..718f7a455d 100644 --- a/src/gfx_type.h +++ b/src/gfx_type.h @@ -258,6 +258,13 @@ enum FontSize : uint8_t { }; DECLARE_INCREMENT_DECREMENT_OPERATORS(FontSize) +using FontSizes = EnumBitSet; + +/** Mask of all possible font sizes. */ +constexpr FontSizes FONTSIZES_ALL{FS_NORMAL, FS_SMALL, FS_LARGE, FS_MONO}; +/** Mask of font sizes required to be present. */ +constexpr FontSizes FONTSIZES_REQUIRED{FS_NORMAL, FS_SMALL, FS_LARGE}; + inline std::string_view FontSizeToName(FontSize fs) { static const std::string_view SIZE_TO_NAME[] = { "medium", "small", "large", "mono" }; diff --git a/src/gfxinit.cpp b/src/gfxinit.cpp index deaaf405b2..20c5e69f11 100644 --- a/src/gfxinit.cpp +++ b/src/gfxinit.cpp @@ -245,7 +245,7 @@ static void RealChangeBlitter(std::string_view repl_blitter) /* Clear caches that might have sprites for another blitter. */ VideoDriver::GetInstance()->ClearSystemSprites(); - ClearFontCache(); + ClearFontCache(FONTSIZES_ALL); GfxClearSpriteCache(); ReInitAllWindows(false); } @@ -326,7 +326,7 @@ void CheckBlitter() { if (!SwitchNewGRFBlitter()) return; - ClearFontCache(); + ClearFontCache(FONTSIZES_ALL); GfxClearSpriteCache(); ReInitAllWindows(false); } @@ -338,7 +338,7 @@ void GfxLoadSprites() SwitchNewGRFBlitter(); VideoDriver::GetInstance()->ClearSystemSprites(); - ClearFontCache(); + ClearFontCache(FONTSIZES_ALL); GfxInitSpriteMem(); LoadSpriteTables(); GfxInitPalettes(); diff --git a/src/openttd.cpp b/src/openttd.cpp index 10ea0951e0..533ee0446a 100644 --- a/src/openttd.cpp +++ b/src/openttd.cpp @@ -700,7 +700,7 @@ int openttd_main(std::span arguments) InitializeLanguagePacks(); /* Initialize the font cache */ - InitFontCache(false); + InitFontCache(FONTSIZES_REQUIRED); /* This must be done early, since functions use the SetWindowDirty* calls */ InitWindowSystem(); diff --git a/src/os/unix/font_unix.cpp b/src/os/unix/font_unix.cpp index 37567537e1..feb96713e5 100644 --- a/src/os/unix/font_unix.cpp +++ b/src/os/unix/font_unix.cpp @@ -182,6 +182,6 @@ bool SetFallbackFont(FontCacheSettings *settings, const std::string &language_is if (best_font == nullptr) return false; callback->SetFontNames(settings, best_font, &best_index); - InitFontCache(callback->Monospace()); + InitFontCache(callback->Monospace() ? FontSizes{FS_MONO} : FONTSIZES_REQUIRED); return true; } diff --git a/src/settings_gui.cpp b/src/settings_gui.cpp index d5f8d50e19..3e9353d488 100644 --- a/src/settings_gui.cpp +++ b/src/settings_gui.cpp @@ -1036,9 +1036,8 @@ struct GameOptionsWindow : Window { this->SetWidgetDisabledState(WID_GO_GUI_FONT_AA, _fcsettings.prefer_sprite); this->SetDirty(); - InitFontCache(false); - InitFontCache(true); - ClearFontCache(); + InitFontCache(FONTSIZES_ALL); + ClearFontCache(FONTSIZES_ALL); CheckForMissingGlyphs(); SetupWidgetDimensions(); UpdateAllVirtCoords(); @@ -1051,7 +1050,7 @@ struct GameOptionsWindow : Window { this->SetWidgetLoweredState(WID_GO_GUI_FONT_AA, _fcsettings.global_aa); MarkWholeScreenDirty(); - ClearFontCache(); + ClearFontCache(FONTSIZES_ALL); break; #endif /* HAS_TRUETYPE_FONT */ diff --git a/src/strings.cpp b/src/strings.cpp index d33535ba92..69d605e86d 100644 --- a/src/strings.cpp +++ b/src/strings.cpp @@ -2278,7 +2278,7 @@ std::string_view GetCurrentLanguageIsoCode() */ bool MissingGlyphSearcher::FindMissingGlyphs() { - InitFontCache(this->Monospace()); + InitFontCache(this->Monospace() ? FontSizes{FS_MONO} : FONTSIZES_REQUIRED); this->Reset(); for (auto text = this->NextString(); text.has_value(); text = this->NextString()) { @@ -2395,7 +2395,7 @@ void CheckForMissingGlyphs(bool base_font, MissingGlyphSearcher *searcher) /* Our fallback font does miss characters too, so keep the * user chosen font as that is more likely to be any good than * the wild guess we made */ - InitFontCache(searcher->Monospace()); + InitFontCache(searcher->Monospace() ? FontSizes{FS_MONO} : FONTSIZES_REQUIRED); } } #endif @@ -2412,12 +2412,12 @@ void CheckForMissingGlyphs(bool base_font, MissingGlyphSearcher *searcher) ShowErrorMessage(GetEncodedString(STR_JUST_RAW_STRING, std::move(err_str)), {}, WL_WARNING); /* Reset the font width */ - LoadStringWidthTable(searcher->Monospace()); + LoadStringWidthTable(searcher->Monospace() ? FontSizes{FS_MONO} : FONTSIZES_REQUIRED); return; } /* Update the font with cache */ - LoadStringWidthTable(searcher->Monospace()); + LoadStringWidthTable(searcher->Monospace() ? FontSizes{FS_MONO} : FONTSIZES_REQUIRED); #if !(defined(WITH_ICU_I18N) && defined(WITH_HARFBUZZ)) && !defined(WITH_UNISCRIBE) && !defined(WITH_COCOA) /* diff --git a/src/tests/mock_fontcache.h b/src/tests/mock_fontcache.h index 5ae4103f65..c159742a31 100644 --- a/src/tests/mock_fontcache.h +++ b/src/tests/mock_fontcache.h @@ -21,8 +21,6 @@ public: this->height = FontCache::GetDefaultFontHeight(this->fs); } - void SetUnicodeGlyph(char32_t, SpriteID) override {} - void InitializeUnicodeGlyphMap() override {} void ClearFontCache() override {} const Sprite *GetGlyph(GlyphID) override { return nullptr; } uint GetGlyphWidth(GlyphID) override { return this->height / 2; }