fontengine.h

Go to the documentation of this file.

// Luanti
// SPDX-License-Identifier: LGPL-2.1-or-later
// Copyright (C) 2010-2014 sapier <sapier at gmx dot net>
 
#pragma once
 
#include <map>
#include <unordered_map>
#include "irr_ptr.h"
#include "util/basic_macros.h"
#include "irrlichttypes.h"
#include "irrString.h" // utf8_to_wide
#include "threading/mutex_auto_lock.h"
 
namespace gui {
        class IGUIEnvironment;
        class IGUIFont;
}
 
// Luanti namespace
namespace gui {
        struct SGUITTFace;
}
 
#define FONT_SIZE_UNSPECIFIED 0xFFFFFFFF
 
enum FontMode : u8 {
        FM_Standard = 0,

        FM_Mono,

        _FM_Fallback,

        FM_MaxMode,
 
        // ----------------------------

        FM_Unspecified
};
 
struct FontSpec {
        FontSpec(unsigned int font_size, FontMode mode, bool bold, bool italic) :
                size(font_size),
                mode(mode),
                bold(bold),
                italic(italic) {}
 
        static const unsigned VARIANT_BITS = 3;
        static const size_t MAX_VARIANTS = FM_MaxMode << VARIANT_BITS;
 
        u16 getHash() const
        {
                return (mode << VARIANT_BITS)
                        | (static_cast<u8>(allow_server_media) << 2)
                        | (static_cast<u8>(bold) << 1)
                        | static_cast<u8>(italic);
        }
 
        unsigned int size;
        FontMode mode;
        bool bold;
        bool italic;
        bool allow_server_media = true;
};
 
class FontEngine
{
public:
 
        FontEngine(gui::IGUIEnvironment* env);
 
        ~FontEngine();
 
        // Get best possible font specified by FontSpec
        gui::IGUIFont *getFont(FontSpec spec);
 
        gui::IGUIFont *getFont(unsigned int font_size=FONT_SIZE_UNSPECIFIED,
                        FontMode mode=FM_Unspecified)
        {
                FontSpec spec(font_size, mode, m_default_bold, m_default_italic);
                return getFont(spec);
        }

        unsigned int getTextHeight(const FontSpec &spec);

        unsigned int getTextHeight(
                        unsigned int font_size=FONT_SIZE_UNSPECIFIED,
                        FontMode mode=FM_Unspecified)
        {
                FontSpec spec(font_size, mode, m_default_bold, m_default_italic);
                return getTextHeight(spec);
        }
 
        unsigned int getTextWidth(const std::wstring &text, const FontSpec &spec);

        unsigned int getTextWidth(const std::wstring& text,
                        unsigned int font_size=FONT_SIZE_UNSPECIFIED,
                        FontMode mode=FM_Unspecified)
        {
                FontSpec spec(font_size, mode, m_default_bold, m_default_italic);
                return getTextWidth(text, spec);
        }
 
        unsigned int getTextWidth(const std::string &text, const FontSpec &spec)
        {
                return getTextWidth(utf8_to_wide(text), spec);
        }
 
        unsigned int getTextWidth(const std::string& text,
                        unsigned int font_size=FONT_SIZE_UNSPECIFIED,
                        FontMode mode=FM_Unspecified)
        {
                FontSpec spec(font_size, mode, m_default_bold, m_default_italic);
                return getTextWidth(utf8_to_wide(text), spec);
        }

        unsigned int getLineHeight(const FontSpec &spec);
 
        unsigned int getLineHeight(unsigned int font_size=FONT_SIZE_UNSPECIFIED,
                        FontMode mode=FM_Unspecified)
        {
                FontSpec spec(font_size, mode, m_default_bold, m_default_italic);
                return getLineHeight(spec);
        }

        unsigned int getDefaultFontSize();

        unsigned int getFontSize(FontMode mode);

        void readSettings();

        void handleReload();
 
        void setMediaFont(const std::string &name, const std::string &data);
 
        void clearMediaFonts();
 
private:
        gui::IGUIFont *getFont(FontSpec spec, bool may_fail);

        void updateCache();

        gui::IGUIFont *initFont(FontSpec spec);

        void updateSkin();
 
        void clearCache();

        void refresh();
 
        gui::SGUITTFace *getOrLoadFace(const std::string &filename);

        static void fontSettingChanged(const std::string &name, void *userdata);

        gui::IGUIEnvironment* m_env = nullptr;

        std::recursive_mutex m_font_mutex;

        std::map<unsigned int, gui::IGUIFont*> m_font_cache[FontSpec::MAX_VARIANTS];

        std::unordered_map<std::string, irr_ptr<gui::SGUITTFace>> m_local_faces;

        std::unordered_map<std::string, irr_ptr<gui::SGUITTFace>> m_media_faces;

        unsigned int m_default_size[FM_MaxMode];

        bool m_default_bold = false;
        bool m_default_italic = false;

        static const FontMode s_default_font_mode = FM_Standard;
 
        bool m_needs_reload = false;
 
        DISABLE_CLASS_COPY(FontEngine);
};

extern FontEngine* g_fontengine;