cleanup

Author: appgurueu

doc/lua_api.md

@@ -279,7 +279,7 @@ Accepted formats are:
     images: .png, .jpg, .tga
     sounds: .ogg vorbis
     models: .x, .b3d, .obj, (since version 5.10:) .gltf, .glb
-    fonts: .ttf (since version 5.?, see notes below) <!-- TODO before merge -->
+    fonts: .ttf (since version 5.11, see notes below)
 
 Other formats won't be sent to the client (e.g. you can store .blend files
 in a folder for convenience, without the risk that such files are transferred)

src/client/fontengine.cpp

@@ -155,9 +155,7 @@ void FontEngine::readSettings()
 	m_default_bold = g_settings->getBool("font_bold");
 	m_default_italic = g_settings->getBool("font_italic");
 
-	clearCache();
-	updateCache();
-	updateSkin();
+	refresh();
 }
 
 void FontEngine::updateSkin()
@@ -175,25 +173,25 @@ void FontEngine::updateCache()
 	getFont(FONT_SIZE_UNSPECIFIED, FM_Unspecified);
 }
 
+void FontEngine::refresh() {
+	clearCache();
+	updateCache();
+	updateSkin();
+}
+
 void FontEngine::setMediaFont(const std::string &name, const std::string &data)
 {
 	std::string copy = data;
 	irr_ptr<gui::SGUITTFace> face(gui::SGUITTFace::createFace(std::move(copy)));
 	m_media_faces.emplace(name, face);
-	// HACK dedup this
-	clearCache();
-	updateCache();
-	updateSkin();
+	refresh();
 }
 
 void FontEngine::clearMediaFonts()
 {
 	RecursiveMutexAutoLock l(m_font_mutex);
 	m_media_faces.clear();
-	// HACK dedup this
-	clearCache();
-	updateCache();
-	updateSkin();
+	refresh();
 }
 
 gui::IGUIFont *FontEngine::initFont(const FontSpec &spec)
@@ -246,26 +244,29 @@ gui::IGUIFont *FontEngine::initFont(const FontSpec &spec)
 			: (setting_suffix.empty() ? "" : setting_suffix.substr(1));
 	if (media_name == "") media_name = "regular";
 
-	auto it = m_media_faces.find(media_name);
-	if (it != m_media_faces.end()) {
-		auto *face = it->second.get();
-		face->grab();
+	auto createFont = [&](gui::SGUITTFace *face) -> gui::CGUITTFont* {
 		auto *font = gui::CGUITTFont::createTTFont(m_env,
 				face, size, true, true, font_shadow,
 				font_shadow_alpha);
-		
-		if (!font) {
-			errorstream << "FontEngine: Cannot load media font '" << media_name <<
-				"'. Falling back to client settings." << std::endl;
-		}
 
-		// HACK this tidbit is duplicated
+		if (!font) return nullptr;
+
 		if (spec.mode != _FM_Fallback) {
 			FontSpec spec2(spec);
 			spec2.mode = _FM_Fallback;
 			font->setFallback(getFont(spec2, true));
 		}
+
 		return font;
+	};
+
+	auto it = m_media_faces.find(media_name);
+	if (it != m_media_faces.end()) {
+		auto *face = it->second.get();
+		if (auto *font = createFont(face))
+			return font;
+		errorstream << "FontEngine: Cannot load media font '" << media_name <<
+			"'. Falling back to client settings." << std::endl;
 	}
 
 	for (const std::string &font_path : fallback_settings) {
@@ -274,25 +275,11 @@ gui::IGUIFont *FontEngine::initFont(const FontSpec &spec)
 
 		// Grab the face.
 		auto *face = irr::gui::SGUITTFace::loadFace(font_path);
-		gui::CGUITTFont *font = nullptr;
-		if (face) {
-			font = gui::CGUITTFont::createTTFont(m_env,
-					face, size, true, true, font_shadow,
-					font_shadow_alpha);
-		}
+		if (auto *font = face ? createFont(face) : nullptr)
+			return font;
 
-		if (!font) {
-			errorstream << "FontEngine: Cannot load '" << font_path <<
-				"'. Trying to fall back to another path." << std::endl;
-			continue;
-		}
-
-		if (spec.mode != _FM_Fallback) {
-			FontSpec spec2(spec);
-			spec2.mode = _FM_Fallback;
-			font->setFallback(getFont(spec2, true));
-		}
-		return font;
+		errorstream << "FontEngine: Cannot load '" << font_path <<
+			"'. Trying to fall back to another path." << std::endl;
 	}
 	return nullptr;
 }

src/client/fontengine.h

@@ -121,6 +121,12 @@ class FontEngine
 	/** update internal parameters from settings */
 	void readSettings();
 
+	/**
+	 * @brief Set a media-provided font.
+	 * Name should currently be one of
+	 * {regular, bold, italic_bold, mono, mono_bold, mono_bold_italic},
+	 * but arbitrary names are to be supported in the future.
+	 */
 	void setMediaFont(const std::string &name, const std::string &data);
 
 	void clearMediaFonts();
@@ -137,9 +143,11 @@ class FontEngine
 	/** update current minetest skin with font changes */
 	void updateSkin();
 
-	/** clean cache */
 	void clearCache();
 
+	/** refresh after fonts have been changed */
+	void refresh();
+
 	/** pointer to irrlicht gui environment */
 	gui::IGUIEnvironment* m_env = nullptr;
 

src/irrlicht_changes/CGUITTFont.cpp

@@ -32,7 +32,6 @@
 */
 
 #include <cstdlib>
-#include <freetype/freetype.h>
 #include <iostream>
 #include <optional>
 #include "irr_ptr.h"
@@ -261,8 +260,6 @@ void SGUITTGlyph::unload()
 
 //////////////////////
 
-// TODO constructor which takes bogus filename and data
-
 CGUITTFont* CGUITTFont::createTTFont(IGUIEnvironment *env,
 		SGUITTFace *face, u32 size, bool antialias,
 		bool transparency, u32 shadow, u32 shadow_alpha)

src/irrlicht_changes/CGUITTFont.h

@@ -3,6 +3,7 @@
    Copyright (c) 2009-2010 John Norman
    Copyright (c) 2016 Nathanaëlle Courant
    Copyright (c) 2023 Caleb Butler
+   Copyright (c) 2024 Luanti contributors
 
    This software is provided 'as-is', without any express or implied
    warranty. In no event will the authors be held liable for any
@@ -32,24 +33,18 @@
 
 #pragma once
 
-#include <map>
-
 #include <ft2build.h>
 #include FT_FREETYPE_H
 
 #include "IGUIEnvironment.h"
 #include "IGUIFont.h"
 #include "IVideoDriver.h"
 #include "IrrlichtDevice.h"
-#include "SMesh.h"
 #include "util/enriched_string.h"
 #include "util/basic_macros.h"
 
-// TODO these should be in the C++ when the struct is properly split into C++ & header
+#include <map>
 #include <optional>
-#include "irr_ptr.h"
-#include "log.h"
-#include "filesys.h"
 
 namespace irr
 {

src/server.cpp

@@ -2542,7 +2542,6 @@ bool Server::addMediaFile(const std::string &filename,
 		// Translation file formats
 		".tr", ".po", ".mo",
 		// Fonts
-		// TODO throw a warning and ignore file if name is not one of the few recognized ones?
 		".ttf",
 		NULL
 	};