3 Copyright (C) 2010-2014 sapier <sapier at gmx dot net>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU Lesser General Public License as published by
7 the Free Software Foundation; either version 2.1 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20 #include "fontengine.h"
22 #include "client/renderingengine.h"
29 #include "irrlicht_changes/CGUITTFont.h"
32 /** maximum size distance for getting a "similar" font size */
33 #define MAX_FONT_SIZE_OFFSET 10
35 /** reference to access font engine, has to be initialized by main */
36 FontEngine* g_fontengine = NULL;
38 /** callback to be used on change of font size setting */
39 static void font_setting_changed(const std::string &name, void *userdata)
41 g_fontengine->readSettings();
44 /******************************************************************************/
45 FontEngine::FontEngine(Settings* main_settings, gui::IGUIEnvironment* env) :
46 m_settings(main_settings),
50 for (u32 &i : m_default_size) {
51 i = (FontMode) FONT_SIZE_UNSPECIFIED;
54 assert(m_settings != NULL); // pre-condition
55 assert(m_env != NULL); // pre-condition
56 assert(m_env->getSkin() != NULL); // pre-condition
60 if (m_currentMode == FM_Standard) {
61 m_settings->registerChangedCallback("font_size", font_setting_changed, NULL);
62 m_settings->registerChangedCallback("font_bold", font_setting_changed, NULL);
63 m_settings->registerChangedCallback("font_italic", font_setting_changed, NULL);
64 m_settings->registerChangedCallback("font_path", font_setting_changed, NULL);
65 m_settings->registerChangedCallback("font_path_bold", font_setting_changed, NULL);
66 m_settings->registerChangedCallback("font_path_italic", font_setting_changed, NULL);
67 m_settings->registerChangedCallback("font_path_bolditalic", font_setting_changed, NULL);
68 m_settings->registerChangedCallback("font_shadow", font_setting_changed, NULL);
69 m_settings->registerChangedCallback("font_shadow_alpha", font_setting_changed, NULL);
71 else if (m_currentMode == FM_Fallback) {
72 m_settings->registerChangedCallback("fallback_font_size", font_setting_changed, NULL);
73 m_settings->registerChangedCallback("fallback_font_path", font_setting_changed, NULL);
74 m_settings->registerChangedCallback("fallback_font_shadow", font_setting_changed, NULL);
75 m_settings->registerChangedCallback("fallback_font_shadow_alpha", font_setting_changed, NULL);
78 m_settings->registerChangedCallback("mono_font_path", font_setting_changed, NULL);
79 m_settings->registerChangedCallback("mono_font_size", font_setting_changed, NULL);
80 m_settings->registerChangedCallback("screen_dpi", font_setting_changed, NULL);
81 m_settings->registerChangedCallback("gui_scaling", font_setting_changed, NULL);
84 /******************************************************************************/
85 FontEngine::~FontEngine()
90 /******************************************************************************/
91 void FontEngine::cleanCache()
93 for (auto &font_cache_it : m_font_cache) {
95 for (auto &font_it : font_cache_it) {
96 font_it.second->drop();
97 font_it.second = NULL;
99 font_cache_it.clear();
103 /******************************************************************************/
104 irr::gui::IGUIFont *FontEngine::getFont(FontSpec spec)
106 if (spec.mode == FM_Unspecified) {
107 spec.mode = m_currentMode;
108 } else if (m_currentMode == FM_Simple) {
109 // Freetype disabled -> Force simple mode
110 spec.mode = (spec.mode == FM_Mono ||
111 spec.mode == FM_SimpleMono) ?
112 FM_SimpleMono : FM_Simple;
113 // Support for those could be added, but who cares?
118 // Fallback to default size
119 if (spec.size == FONT_SIZE_UNSPECIFIED)
120 spec.size = m_default_size[spec.mode];
122 const auto &cache = m_font_cache[spec.getHash()];
123 auto it = cache.find(spec.size);
124 if (it != cache.end())
127 // Font does not yet exist
128 gui::IGUIFont *font = nullptr;
129 if (spec.mode == FM_Simple || spec.mode == FM_SimpleMono)
130 font = initSimpleFont(spec);
132 font = initFont(spec);
134 m_font_cache[spec.getHash()][spec.size] = font;
139 /******************************************************************************/
140 unsigned int FontEngine::getTextHeight(const FontSpec &spec)
142 irr::gui::IGUIFont *font = getFont(spec);
144 // use current skin font as fallback
146 font = m_env->getSkin()->getFont();
148 FATAL_ERROR_IF(font == NULL, "Could not get skin font");
150 return font->getDimension(L"Some unimportant example String").Height;
153 /******************************************************************************/
154 unsigned int FontEngine::getTextWidth(const std::wstring &text, const FontSpec &spec)
156 irr::gui::IGUIFont *font = getFont(spec);
158 // use current skin font as fallback
160 font = m_env->getSkin()->getFont();
162 FATAL_ERROR_IF(font == NULL, "Could not get font");
164 return font->getDimension(text.c_str()).Width;
168 /** get line height for a specific font (including empty room between lines) */
169 unsigned int FontEngine::getLineHeight(const FontSpec &spec)
171 irr::gui::IGUIFont *font = getFont(spec);
173 // use current skin font as fallback
175 font = m_env->getSkin()->getFont();
177 FATAL_ERROR_IF(font == NULL, "Could not get font");
179 return font->getDimension(L"Some unimportant example String").Height
180 + font->getKerningHeight();
183 /******************************************************************************/
184 unsigned int FontEngine::getDefaultFontSize()
186 return m_default_size[m_currentMode];
189 /******************************************************************************/
190 void FontEngine::readSettings()
192 if (USE_FREETYPE && g_settings->getBool("freetype")) {
193 m_default_size[FM_Standard] = m_settings->getU16("font_size");
194 m_default_size[FM_Fallback] = m_settings->getU16("fallback_font_size");
195 m_default_size[FM_Mono] = m_settings->getU16("mono_font_size");
197 m_currentMode = is_yes(gettext("needs_fallback_font")) ?
198 FM_Fallback : FM_Standard;
200 m_default_bold = m_settings->getBool("font_bold");
201 m_default_italic = m_settings->getBool("font_italic");
204 m_currentMode = FM_Simple;
207 m_default_size[FM_Simple] = m_settings->getU16("font_size");
208 m_default_size[FM_SimpleMono] = m_settings->getU16("mono_font_size");
215 /******************************************************************************/
216 void FontEngine::updateSkin()
218 gui::IGUIFont *font = getFont();
221 m_env->getSkin()->setFont(font);
223 errorstream << "FontEngine: Default font file: " <<
224 "\n\t\"" << m_settings->get("font_path") << "\"" <<
225 "\n\trequired for current screen configuration was not found" <<
226 " or was invalid file format." <<
227 "\n\tUsing irrlicht default font." << std::endl;
229 // If we did fail to create a font our own make irrlicht find a default one
230 font = m_env->getSkin()->getFont();
231 FATAL_ERROR_IF(font == NULL, "Could not create/get font");
233 u32 text_height = font->getDimension(L"Hello, world!").Height;
234 infostream << "text_height=" << text_height << std::endl;
237 /******************************************************************************/
238 void FontEngine::updateFontCache()
240 /* the only font to be initialized is default one,
241 * all others are re-initialized on demand */
242 getFont(FONT_SIZE_UNSPECIFIED, FM_Unspecified);
245 /******************************************************************************/
246 gui::IGUIFont *FontEngine::initFont(const FontSpec &spec)
248 assert(spec.mode != FM_Unspecified);
249 assert(spec.size != FONT_SIZE_UNSPECIFIED);
251 std::string setting_prefix = "";
255 setting_prefix = "fallback_";
259 setting_prefix = "mono_";
265 std::string setting_suffix = "";
267 setting_suffix.append("_bold");
269 setting_suffix.append("_italic");
271 u32 size = std::floor(RenderingEngine::getDisplayDensity() *
272 m_settings->getFloat("gui_scaling") * spec.size);
275 errorstream << "FontEngine: attempt to use font size 0" << std::endl;
276 errorstream << " display density: " << RenderingEngine::getDisplayDensity() << std::endl;
281 u16 font_shadow_alpha = 0;
282 g_settings->getU16NoEx(setting_prefix + "font_shadow", font_shadow);
283 g_settings->getU16NoEx(setting_prefix + "font_shadow_alpha",
286 std::string wanted_font_path;
287 wanted_font_path = g_settings->get(setting_prefix + "font_path" + setting_suffix);
289 std::string fallback_settings[] = {
291 m_settings->get("fallback_font_path"),
292 m_settings->getDefault(setting_prefix + "font_path")
296 for (const std::string &font_path : fallback_settings) {
297 irr::gui::IGUIFont *font = gui::CGUITTFont::createTTFont(m_env,
298 font_path.c_str(), size, true, true, font_shadow,
304 errorstream << "FontEngine: Cannot load '" << font_path <<
305 "'. Trying to fall back to another path." << std::endl;
310 errorstream << "minetest can not continue without a valid font. "
311 "Please correct the 'font_path' setting or install the font "
312 "file in the proper location" << std::endl;
314 errorstream << "FontEngine: Tried to load freetype fonts but Minetest was"
315 " not compiled with that library." << std::endl;
320 /** initialize a font without freetype */
321 gui::IGUIFont *FontEngine::initSimpleFont(const FontSpec &spec)
323 assert(spec.mode == FM_Simple || spec.mode == FM_SimpleMono);
324 assert(spec.size != FONT_SIZE_UNSPECIFIED);
326 const std::string &font_path = m_settings->get(
327 (spec.mode == FM_SimpleMono) ? "mono_font_path" : "font_path");
329 size_t pos_dot = font_path.find_last_of('.');
330 std::string basename = font_path;
331 std::string ending = lowercase(font_path.substr(pos_dot));
333 if (ending == ".ttf") {
334 errorstream << "FontEngine: Found font \"" << font_path
335 << "\" but freetype is not available." << std::endl;
339 if (ending == ".xml" || ending == ".png")
340 basename = font_path.substr(0, pos_dot);
342 u32 size = std::floor(
343 RenderingEngine::getDisplayDensity() *
344 m_settings->getFloat("gui_scaling") *
347 irr::gui::IGUIFont *font = nullptr;
348 std::string font_extensions[] = { ".png", ".xml" };
350 // Find nearest matching font scale
351 // Does a "zig-zag motion" (positibe/negative), from 0 to MAX_FONT_SIZE_OFFSET
352 for (s32 zoffset = 0; zoffset < MAX_FONT_SIZE_OFFSET * 2; zoffset++) {
353 std::stringstream path;
356 s32 sign = (zoffset & 1) ? -1 : 1;
357 s32 offset = zoffset >> 1;
359 for (const std::string &ext : font_extensions) {
360 path.str(""); // Clear
361 path << basename << "_" << (size + offset * sign) << ext;
363 if (!fs::PathExists(path.str()))
366 font = m_env->getFont(path.str().c_str());
369 verbosestream << "FontEngine: found font: " << path.str() << std::endl;
380 if (fs::PathExists(font_path)) {
381 font = m_env->getFont(font_path.c_str());
383 verbosestream << "FontEngine: found font: " << font_path << std::endl;