fontengine.h

Go to the documentation of this file.

/*
Minetest
Copyright (C) 2010-2014 sapier <sapier at gmx dot net>
 
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
 
This program 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 Lesser General Public License for more details.
 
You should have received a copy of the GNU Lesser General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
 
#pragma once
 
#include <map>
#include <vector>
#include "util/basic_macros.h"
#include "irrlichttypes.h"
#include <IGUIFont.h>
#include <IGUISkin.h>
#include <IGUIEnvironment.h>
#include "settings.h"
 
#define FONT_SIZE_UNSPECIFIED 0xFFFFFFFF
 
enum FontMode : u8 {
    FM_Standard = 0,
    FM_Mono,
    FM_Fallback,
    FM_Simple,
    FM_SimpleMono,
    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) {}
 
    u16 getHash()
    {
        return (mode << 2) | (static_cast<u8>(bold) << 1) | static_cast<u8>(italic);
    }
 
    unsigned int size;
    FontMode mode;
    bool bold;
    bool italic;
};
 
class FontEngine
{
public:
 
    FontEngine(gui::IGUIEnvironment* env);
 
    ~FontEngine();
 
    // Get best possible font specified by FontSpec
    irr::gui::IGUIFont *getFont(FontSpec spec);
 
    irr::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();
 
private:
    void updateFontCache();
 
    gui::IGUIFont *initFont(const FontSpec &spec);
 
    gui::IGUIFont *initSimpleFont(const FontSpec &spec);
 
    void updateSkin();
 
    void cleanCache();
 
    gui::IGUIEnvironment* m_env = nullptr;
 
    std::map<unsigned int, irr::gui::IGUIFont*> m_font_cache[FM_MaxMode << 2];
 
    unsigned int m_default_size[FM_MaxMode];
 
    bool m_default_bold = false;
    bool m_default_italic = false;
 
    FontMode m_currentMode = FM_Standard;
 
    DISABLE_CLASS_COPY(FontEngine);
};
 
extern FontEngine* g_fontengine;