fontcache.cpp

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
 */
 
#include "stdafx.h"
#include "fontcache.h"
#include "fontdetection.h"
#include "blitter/factory.hpp"
#include "gfx_layout.h"
#include "fontcache/spritefontcache.h"
#include "openttd.h"
#include "settings_func.h"
#include "strings_func.h"
#include "viewport_func.h"
#include "window_func.h"
#include "fileio_func.h"
 
#include "safeguards.h"
 
static const int _default_font_height[FS_END]   = {10, 6, 18, 10};
static const int _default_font_ascender[FS_END] = { 8, 5, 15,  8};
 
FontCacheSettings _fcsettings;
 
FontCache::FontCache(FontSize fs) : parent(FontCache::Get(fs)), fs(fs), height(_default_font_height[fs]),
    ascender(_default_font_ascender[fs]), descender(_default_font_ascender[fs] - _default_font_height[fs]),
    units_per_em(1)
{
  assert(this->parent == nullptr || this->fs == this->parent->fs);
  FontCache::caches[this->fs] = this;
  Layouter::ResetFontCache(this->fs);
}
 
FontCache::~FontCache()
{
  assert(this->fs == this->parent->fs);
  FontCache::caches[this->fs] = this->parent;
  Layouter::ResetFontCache(this->fs);
}
 
int FontCache::GetDefaultFontHeight(FontSize fs)
{
  return _default_font_height[fs];
}
 
std::string FontCache::GetName(FontSize fs)
{
  FontCache *fc = FontCache::Get(fs);
  if (fc != nullptr) {
    return fc->GetFontName();
  } else {
    return "[NULL]";
  }
}
 
 
int GetCharacterHeight(FontSize size)
{
  return FontCache::Get(size)->GetHeight();
}
 
 
/* static */ FontCache *FontCache::caches[FS_END];
 
/* static */ void FontCache::InitializeFontCaches()
{
  for (FontSize fs = FS_BEGIN; fs != FS_END; fs++) {
    if (FontCache::caches[fs] == nullptr) new SpriteFontCache(fs); /* FontCache inserts itself into to the cache. */
  }
}
 
/* Check if a glyph should be rendered with anti-aliasing. */
bool GetFontAAState(FontSize size, bool check_blitter)
{
  /* AA is only supported for 32 bpp */
  if (check_blitter && BlitterFactory::GetCurrentBlitter()->GetScreenDepth() != 32) return false;
 
  return _fcsettings.global_aa || GetFontCacheSubSetting(size)->aa;
}
 
void SetFont(FontSize fontsize, const std::string &font, uint size, bool aa)
{
  FontCacheSubSetting *setting = GetFontCacheSubSetting(fontsize);
  bool changed = false;
 
  if (setting->font != font) {
    setting->font = font;
    changed = true;
  }
 
  if (setting->size != size) {
    setting->size = size;
    changed = true;
  }
 
  if (setting->aa != aa) {
    setting->aa = aa;
    changed = true;
  }
 
  if (!changed) return;
 
  if (fontsize != FS_MONO) {
    /* Try to reload only the modified font. */
    FontCacheSettings backup = _fcsettings;
    for (FontSize fs = FS_BEGIN; fs < FS_END; fs++) {
      if (fs == fontsize) continue;
      FontCache *fc = FontCache::Get(fs);
      GetFontCacheSubSetting(fs)->font = fc->HasParent() ? fc->GetFontName() : "";
    }
    CheckForMissingGlyphs();
    _fcsettings = backup;
  } else {
    InitFontCache(true);
  }
 
  LoadStringWidthTable();
  UpdateAllVirtCoords();
  ReInitAllWindows(true);
 
  if (_save_config) SaveToConfig();
}
 
#ifdef WITH_FREETYPE
extern void LoadFreeTypeFont(FontSize fs);
extern void LoadFreeTypeFont(FontSize fs, const std::string &file_name, uint size);
extern void UninitFreeType();
#elif defined(_WIN32)
extern void LoadWin32Font(FontSize fs);
extern void LoadWin32Font(FontSize fs, const std::string &file_name, uint size);
#elif defined(WITH_COCOA)
extern void LoadCoreTextFont(FontSize fs);
extern void LoadCoreTextFont(FontSize fs, const std::string &file_name, uint size);
#endif
 
static void TryLoadDefaultTrueTypeFont([[maybe_unused]] FontSize fs)
{
#if defined(WITH_FREETYPE) || defined(_WIN32) || defined(WITH_COCOA)
  std::string font_name{};
  switch (fs) {
    case FS_NORMAL:
      font_name = "OpenTTD-Sans.ttf";
      break;
    case FS_SMALL:
      font_name = "OpenTTD-Small.ttf";
      break;
    case FS_LARGE:
      font_name = "OpenTTD-Serif.ttf";
      break;
    case FS_MONO:
      font_name = "OpenTTD-Mono.ttf";
      break;
 
    default: NOT_REACHED();
  }
 
  /* Find font file. */
  std::string full_font = FioFindFullPath(BASESET_DIR, font_name);
  if (!full_font.empty()) {
    int size = FontCache::GetDefaultFontHeight(fs);
#ifdef WITH_FREETYPE
    LoadFreeTypeFont(fs, full_font, size);
#elif defined(_WIN32)
    LoadWin32Font(fs, full_font, size);
#elif defined(WITH_COCOA)
    LoadCoreTextFont(fs, full_font, size);
#endif
  }
#endif /* defined(WITH_FREETYPE) || defined(_WIN32) || defined(WITH_COCOA) */
}
 
void InitFontCache(bool monospace)
{
  FontCache::InitializeFontCaches();
 
  for (FontSize fs = FS_BEGIN; fs < FS_END; fs++) {
    if (monospace != (fs == FS_MONO)) continue;
 
    FontCache *fc = FontCache::Get(fs);
    if (fc->HasParent()) delete fc;
 
    if (!_fcsettings.prefer_sprite && GetFontCacheSubSetting(fs)->font.empty()) {
      TryLoadDefaultTrueTypeFont(fs);
    } else {
#ifdef WITH_FREETYPE
      LoadFreeTypeFont(fs);
#elif defined(_WIN32)
      LoadWin32Font(fs);
#elif defined(WITH_COCOA)
      LoadCoreTextFont(fs);
#endif
    }
  }
}
 
void UninitFontCache()
{
  for (FontSize fs = FS_BEGIN; fs < FS_END; fs++) {
    FontCache *fc = FontCache::Get(fs);
    if (fc->HasParent()) delete fc;
  }
 
#ifdef WITH_FREETYPE
  UninitFreeType();
#endif /* WITH_FREETYPE */
}
 
bool HasAntialiasedFonts()
{
  for (FontSize fs = FS_BEGIN; fs < FS_END; fs++) {
    if (!FontCache::Get(fs)->IsBuiltInFont() && GetFontAAState(fs, false)) return true;
  }
 
  return false;
}
 
#if !defined(_WIN32) && !defined(__APPLE__) && !defined(WITH_FONTCONFIG) && !defined(WITH_COCOA)
 
bool SetFallbackFont(FontCacheSettings *, const std::string &, int, MissingGlyphSearcher *) { return false; }
#endif /* !defined(_WIN32) && !defined(__APPLE__) && !defined(WITH_FONTCONFIG) && !defined(WITH_COCOA) */