minetest/src/client/fontengine.h

176 lines
4.6 KiB
C
Raw Normal View History

2014-11-23 13:40:43 +01:00
/*
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
2014-11-23 13:40:43 +01:00
#include <map>
#include "util/basic_macros.h"
#include "irrlichttypes.h"
#include <IGUIFont.h>
#include <IGUISkin.h>
#include <IGUIEnvironment.h>
2014-11-23 13:40:43 +01:00
#include "settings.h"
#include "threading/mutex_auto_lock.h"
2014-11-23 13:40:43 +01:00
#define FONT_SIZE_UNSPECIFIED 0xFFFFFFFF
enum FontMode : u8 {
2014-11-23 13:40:43 +01:00
FM_Standard = 0,
FM_Mono,
_FM_Fallback, // do not use directly
2014-11-23 13:40:43 +01:00
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() const
{
2020-08-23 15:41:04 +02:00
return (mode << 2) | (static_cast<u8>(bold) << 1) | static_cast<u8>(italic);
}
unsigned int size;
FontMode mode;
bool bold;
bool italic;
};
2014-11-23 13:40:43 +01:00
class FontEngine
{
public:
FontEngine(gui::IGUIEnvironment* env);
2014-11-23 13:40:43 +01:00
~FontEngine();
// Get best possible font specified by FontSpec
irr::gui::IGUIFont *getFont(FontSpec spec);
2019-09-10 15:11:26 +02:00
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);
2019-09-10 15:11:26 +02:00
}
2014-11-23 13:40:43 +01:00
/** get text height for a specific font */
unsigned int getTextHeight(const FontSpec &spec);
2014-11-23 13:40:43 +01:00
/** get text width if a text for a specific font */
2019-09-10 15:11:26 +02:00
unsigned int getTextHeight(
2014-11-23 13:40:43 +01:00
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);
2014-11-23 13:40:43 +01:00
}
unsigned int getTextWidth(const std::wstring &text, const FontSpec &spec);
2019-09-10 15:11:26 +02:00
2014-11-23 13:40:43 +01:00
/** get text width if a text for a specific font */
unsigned int getTextWidth(const std::wstring& text,
unsigned int font_size=FONT_SIZE_UNSPECIFIED,
2019-09-10 15:11:26 +02:00
FontMode mode=FM_Unspecified)
{
FontSpec spec(font_size, mode, m_default_bold, m_default_italic);
return getTextWidth(text, spec);
2019-09-10 15:11:26 +02:00
}
unsigned int getTextWidth(const std::string &text, const FontSpec &spec)
2019-09-10 15:11:26 +02:00
{
return getTextWidth(utf8_to_wide(text), spec);
2019-09-10 15:11:26 +02:00
}
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);
2019-09-10 15:11:26 +02:00
}
2014-11-23 13:40:43 +01:00
/** get line height for a specific font (including empty room between lines) */
unsigned int getLineHeight(const FontSpec &spec);
2019-09-10 15:11:26 +02:00
2014-11-23 13:40:43 +01:00
unsigned int getLineHeight(unsigned int font_size=FONT_SIZE_UNSPECIFIED,
2019-09-10 15:11:26 +02:00
FontMode mode=FM_Unspecified)
{
FontSpec spec(font_size, mode, m_default_bold, m_default_italic);
return getLineHeight(spec);
2019-09-10 15:11:26 +02:00
}
2014-11-23 13:40:43 +01:00
/** get default font size */
unsigned int getDefaultFontSize();
/** get font size for a specific mode */
unsigned int getFontSize(FontMode mode);
2014-11-23 13:40:43 +01:00
/** update internal parameters from settings */
void readSettings();
private:
irr::gui::IGUIFont *getFont(FontSpec spec, bool may_fail);
2014-11-23 13:40:43 +01:00
/** update content of font cache in case of a setting change made it invalid */
void updateFontCache();
/** initialize a new TTF font */
gui::IGUIFont *initFont(const FontSpec &spec);
2014-11-23 13:40:43 +01:00
/** initialize a font without freetype */
gui::IGUIFont *initSimpleFont(const FontSpec &spec);
2014-11-23 13:40:43 +01:00
/** update current minetest skin with font changes */
void updateSkin();
/** clean cache */
void cleanCache();
/** pointer to irrlicht gui environment */
gui::IGUIEnvironment* m_env = nullptr;
2014-11-23 13:40:43 +01:00
/** mutex used to protect font init and cache */
std::recursive_mutex m_font_mutex;
2014-11-23 13:40:43 +01:00
/** internal storage for caching fonts of different size */
2019-09-10 15:11:26 +02:00
std::map<unsigned int, irr::gui::IGUIFont*> m_font_cache[FM_MaxMode << 2];
2014-11-23 13:40:43 +01:00
/** default font size to use */
unsigned int m_default_size[FM_MaxMode];
2019-09-10 15:11:26 +02:00
/** default bold and italic */
bool m_default_bold = false;
bool m_default_italic = false;
2019-09-10 15:11:26 +02:00
2014-11-23 13:40:43 +01:00
/** current font engine mode */
FontMode m_currentMode = FM_Standard;
2014-11-23 13:40:43 +01:00
DISABLE_CLASS_COPY(FontEngine);
2014-11-23 13:40:43 +01:00
};
/** interface to access main font engine*/
extern FontEngine* g_fontengine;