Collection of helper functions relating to Pango formatting. More...

Classes
struct	error

class	floating_label

struct	floating_label_context
	structure which will hide all current floating labels, and cause floating labels instantiated after it is created to be displayed More...

struct	inverse_table

struct	manager

class	p_font
	Small helper class to make sure the pango font object is destroyed properly. More...

class	pango_text
	Text class. More...

struct	subset_descriptor

Enumerations
enum	ALIGN { LEFT_ALIGN, CENTER_ALIGN, RIGHT_ALIGN }

enum	LABEL_SCROLL_MODE { ANCHOR_LABEL_SCREEN, ANCHOR_LABEL_MAP }

enum	family_class { FONT_SANS_SERIF, FONT_MONOSPACE, FONT_LIGHT, FONT_SCRIPT }
	Font classes for get_font_families(). More...

Functions
int	add_floating_label (const floating_label &flabel)
	add a label floating on the screen above everything else. More...

void	move_floating_label (int handle, double xmove, double ymove)
	moves the floating label given by 'handle' by (xmove,ymove) More...

void	scroll_floating_labels (double xmove, double ymove)
	moves all floating labels that have 'scroll_mode' set to ANCHOR_LABEL_MAP More...

void	remove_floating_label (int handle, int fadeout=0)
	removes the floating label given by 'handle' from the screen More...

void	show_floating_label (int handle, bool show)
	hides or shows a floating label More...

SDL_Rect	get_floating_label_rect (int handle)

void	draw_floating_labels (surface screen)

void	undraw_floating_labels (surface screen)

int	relative_size (int size)

bool	check_font_file (std::string name)
	Test if a font file exists. More...

bool	load_font_config ()

const t_string &	get_font_families (family_class fclass=FONT_SANS_SERIF)
	Returns the currently defined fonts. More...

family_class	str_to_family_class (const std::string &str)

std::string	escape_text (const std::string &text)
	Escapes the pango markup characters in a text. More...

std::string	semi_escape_text (const std::string &text)

bool	looks_like_url (std::string_view str)

std::string	format_as_link (const std::string &link, color_t color)

surface	pango_render_text (const std::string &text, int size, const color_t &color, font::pango_text::FONT_STYLE style=font::pango_text::STYLE_NORMAL, bool use_markup=false, int max_width=-1)
	Returns a SDL surface containing the rendered text. More...

std::pair< int, int >	pango_line_size (const std::string &line, int font_size, font::pango_text::FONT_STYLE font_style=font::pango_text::STYLE_NORMAL)
	Determine the width and height of a line of text given a certain font size. More...

std::string	pango_line_ellipsize (const std::string &text, int font_size, int max_width, font::pango_text::FONT_STYLE font_style=font::pango_text::STYLE_NORMAL)
	If the text exceeds the specified max width, end it with an ellipsis (...) More...

std::string	pango_word_wrap (const std::string &unwrapped_text, int font_size, int max_width, int max_height=-1, int max_lines=-1, bool partial_line=false)
	Uses Pango to word wrap text. More...

SDL_Rect	pango_draw_text (CVideo *gui, const SDL_Rect &area, int size, const color_t &color, const std::string &text, int x, int y, bool use_tooltips=false, pango_text::FONT_STYLE style=pango_text::STYLE_NORMAL)
	Draws text on the screen. More...

SDL_Rect	pango_draw_text (surface &dst, const SDL_Rect &area, int size, const color_t &color, const std::string &text, int x, int y, bool use_tooltips=false, pango_text::FONT_STYLE style=pango_text::STYLE_NORMAL)
	Draws text on a surface. More...

int	pango_line_width (const std::string &line, int font_size, font::pango_text::FONT_STYLE font_style=font::pango_text::STYLE_NORMAL)
	Determine the width of a line of text given a certain font size. More...

static void	unpremultiply (uint8_t &value, const unsigned div)

static void	from_cairo_format (uint32_t &c)
	Converts from cairo-format ARGB32 premultiplied alpha to plain alpha. More...

pango_text &	get_text_renderer ()
	Returns a reference to a static pango_text object. More...

int	get_max_height (unsigned size, font::family_class fclass=font::FONT_SANS_SERIF, pango_text::FONT_STYLE style=pango_text::STYLE_NORMAL)
	Returns the maximum glyph height of a font, in pixels. More...

std::string	span_color (const color_t &color)
	Returns a Pango formatting string using the provided color_t object. More...

std::string	span_color (const color_t &color, const std::string &data)
	Like span_color(const color_t&), but append the data string and a "</span>" tag. More...

std::string	get_pango_color_from_id (const std::string &id)
	Returns a hex color string from a color range. More...

std::string	get_color_string_pango (const std::string &id)
	Returns the name of a color range, colored with its own color. More...

Variables
const int	SIZE_NORMAL = 17

const int	SIZE_TINY = 13 * (SIZE_NORMAL / 17)

const int	SIZE_SMALL = 15 * (SIZE_NORMAL / 17)

const int	SIZE_BUTTON = 16 * (SIZE_NORMAL / 17)

const int	SIZE_BUTTON_SMALL = 14 * (SIZE_NORMAL / 17)

const int	SIZE_15 = 15 * (SIZE_NORMAL / 17)

const int	SIZE_PLUS = 18 * (SIZE_NORMAL / 17)

const int	SIZE_LARGE = 20 * (SIZE_NORMAL / 17)

const int	SIZE_TITLE = 22 * (SIZE_NORMAL / 17)

const int	SIZE_FLOAT_LABEL = 24 * (SIZE_NORMAL / 17)

const int	SIZE_XLARGE = 36 * (SIZE_NORMAL / 17)

const std::size_t	max_text_line_width = 4096

const std::string	ellipsis = "..."

const std::string	nbsp = " "

const std::string	unicode_minus = "-"

const std::string	unicode_en_dash = "–"

const std::string	unicode_em_dash = "—"

const std::string	unicode_figure_dash = "‒"

const std::string	unicode_multiplication_sign = "×"

const std::string	unicode_bullet = "•"

const std::string	weapon_numbers_sep = "×"

const std::string	weapon_details_sep = "–"

const color_t	NORMAL_COLOR {221, 221, 221}

const color_t	GRAY_COLOR {136, 136, 136}

const color_t	LOBBY_COLOR {187, 187, 187}

const color_t	GOOD_COLOR {0 , 181, 26 }

const color_t	BAD_COLOR {255, 0 , 0 }

const color_t	BLACK_COLOR {0 , 0 , 0 }

const color_t	YELLOW_COLOR {255, 255, 0 }

const color_t	BUTTON_COLOR {186, 172, 125}

const color_t	PETRIFIED_COLOR {160, 160, 160}

const color_t	TITLE_COLOR {186, 172, 125}

const color_t	LABEL_COLOR {107, 140, 255}

const color_t	BIGMAP_COLOR {255, 255, 255}

const color_t	DISABLED_COLOR = PETRIFIED_COLOR.inverse()

const color_t	weapon_color {245, 230, 193}

const color_t	good_dmg_color {130, 240, 50 }

const color_t	bad_dmg_color {250, 140, 80 }

const color_t	weapon_details_color {196, 176, 147}

const color_t	inactive_details_color { 86, 86, 86}

const color_t	inactive_ability_color {146, 146, 146}

const color_t	unit_type_color {245, 230, 193}

const color_t	race_color {166, 146, 117}

static const inverse_table	inverse_table_

Detailed Description

Collection of helper functions relating to Pango formatting.

Graphical text output.

This module is used to display and measure text. Text can optionally contain special characters, which may change specified display properties such as colour or font size. If special characters are turned on, they can be escaped, C-style, using backslashes.

Enumeration Type Documentation

◆ ALIGN

enum font::ALIGN

Enumerator
LEFT_ALIGN
CENTER_ALIGN
RIGHT_ALIGN

Definition at line 33 of file floating_label.hpp.

◆ family_class

enum font::family_class

Font classes for get_font_families().

Enumerator
FONT_SANS_SERIF
FONT_MONOSPACE
FONT_LIGHT
FONT_SCRIPT

Definition at line 25 of file font_options.hpp.

◆ LABEL_SCROLL_MODE

enum font::LABEL_SCROLL_MODE

Enumerator
ANCHOR_LABEL_SCREEN
ANCHOR_LABEL_MAP

Definition at line 35 of file floating_label.hpp.

Function Documentation

◆ add_floating_label()

int font::add_floating_label ( const floating_label & flabel )

add a label floating on the screen above everything else.

Returns: a handle to the label which can be used with other label functions

Definition at line 239 of file floating_label.cpp.

Referenced by display_chat_manager::add_chat_message(), display::announce(), terrain_label::draw(), game_display::float_label(), playmp_controller::play_human_turn(), display::set_diagnostic(), CVideo::set_help_string(), show_tooltip(), display::update_display(), and gui::floating_textbox::update_location().

◆ check_font_file()

bool font::check_font_file ( std::string name )

Test if a font file exists.

Definition at line 62 of file font_config.cpp.

References filesystem::ends_with(), filesystem::file_exists(), config::find_child(), game_config::path, and WRN_FT.

◆ draw_floating_labels()

void font::draw_floating_labels ( surface screen )

Definition at line 324 of file floating_label.cpp.

References i.

Referenced by gui2::window::draw(), and display::flip().

◆ escape_text()

std::string font::escape_text ( const std::string & text )

inline

Escapes the pango markup characters in a text.

The markups escaped are the ones used in the pango markup. The special characters are:

<>'"&

The escaping is the same as for HTML.

Parameters

text	The text to escape.

Returns: The escaped text.

Definition at line 32 of file escape.hpp.

References c.

Referenced by about::credits_group::about_group::about_group(), gui2::chatbox::add_active_window_message(), gui2::chatbox::add_active_window_whisper(), gui2::chatbox::add_chat_message(), gui2::dialogs::lua_interpreter::lua_model::add_dialog_message(), gui2::chatbox::add_room_window_message(), gui2::chatbox::add_whisper_window_whisper(), addons_client::delete_remote_addon(), addon_info::display_title(), addons_client::do_check_before_overwriting_addon(), addons_client::download_addon(), addons_client::install_addon(), gui2::dialogs::lua_interpreter::lua_model::lua_model(), gui2::dialogs::formula_debugger::pre_show(), gui2::dialogs::chat_log::model::stream_log(), unit_name(), addons_client::update_last_error(), and addons_client::upload_addon().

◆ format_as_link()

std::string font::format_as_link	(	const std::string &	link,
		color_t	color
	)

inline

Definition at line 31 of file hyperlink.hpp.

References color_t::to_hex_string().

Referenced by font::pango_text::format_links().

◆ from_cairo_format()

static void font::from_cairo_format ( uint32_t & c )

static

Converts from cairo-format ARGB32 premultiplied alpha to plain alpha.

Parameters

c	a uint32 representing the color

Definition at line 616 of file text.cpp.

References a, b, g, and unpremultiply().

Referenced by font::pango_text::rerender().

◆ get_color_string_pango()

std::string font::get_color_string_pango ( const std::string & id )

Returns the name of a color range, colored with its own color.

Parameters

id	The id of the color range.

Definition at line 45 of file text_formatting.cpp.

References _(), get_pango_color_from_id(), and game_config::team_rgb_name.

Referenced by gui2::dialogs::mp_staging::add_side_node().

◆ get_floating_label_rect()

SDL_Rect font::get_floating_label_rect ( int handle )

Definition at line 292 of file floating_label.cpp.

References sdl::empty_rect, and i.

Referenced by display_chat_manager::add_chat_message(), display_chat_manager::prune_chat_messages(), CVideo::set_help_string(), show_tooltip(), and gui::floating_textbox::update_location().

◆ get_font_families()

const t_string & font::get_font_families ( family_class fclass = FONT_SANS_SERIF )

Returns the currently defined fonts.

Definition at line 197 of file font_config.cpp.

References FONT_LIGHT, FONT_MONOSPACE, and FONT_SCRIPT.

Referenced by font::pango_text::calculate_size(), and font::pango_text::get_max_glyph_height().

◆ get_max_height()

int font::get_max_height	(	unsigned	size,
		font::family_class	fclass = `font::FONT_SANS_SERIF`,
		pango_text::FONT_STYLE	style = `pango_text::STYLE_NORMAL`
	)

Returns the maximum glyph height of a font, in pixels.

Parameters

size	Desired font size in pixels.
fclass	Font family to use for measurement.
style	Font style to select the correct variant for measurement.

Returns: The height of the tallest possible glyph for the selected font. More specifically, the result is the sum of the maximum ascent and descent lengths.

Definition at line 929 of file text.cpp.

References font::pango_text::get_max_glyph_height(), get_text_renderer(), font::pango_text::set_family_class(), font::pango_text::set_font_size(), and font::pango_text::set_font_style().

Referenced by gui::textbox::add_text_line(), gui::textbox::textbox(), gui::dialog_frame::top_padding(), and gui2::text_box::update_offsets().

◆ get_pango_color_from_id()

std::string font::get_pango_color_from_id ( const std::string & id )

Returns a hex color string from a color range.

Parameters

id	The id of the color range.

Definition at line 35 of file text_formatting.cpp.

References game_config::team_rgb_colors.

Referenced by gui2::dialogs::mp_join_game::generate_side_list(), and get_color_string_pango().

◆ get_text_renderer()

pango_text & font::get_text_renderer ( )

Returns a reference to a static pango_text object.

Since the class is essentially a render pipeline, there's no need for individual areas of the game to own their own renderers. Not to mention it isn't a trivial class; constructing one is likely to be expensive.

Definition at line 923 of file text.cpp.

Referenced by font::floating_label::create_surface(), gui2::text_shape::draw(), get_max_height(), and display::refresh_report().

◆ load_font_config()

bool font::load_font_config ( )

Definition at line 127 of file font_config.cpp.

References config::child(), config::child_range(), e, ERR_FT, filesystem::get_wml_location(), game::error::message, preprocess_file(), read(), and utils::split().

Referenced by game_launcher::change_language(), do_gameloop(), and test_utils::game_config_manager::game_config_manager().

◆ looks_like_url()

bool font::looks_like_url ( std::string_view str )

inline

Definition at line 26 of file hyperlink.hpp.

Referenced by font::pango_text::format_links(), and font::pango_text::get_link().

◆ move_floating_label()

void font::move_floating_label	(	int	handle,
		double	xmove,
		double	ymove
	)

moves the floating label given by 'handle' by (xmove,ymove)

Definition at line 251 of file floating_label.cpp.

References i.

Referenced by display_chat_manager::prune_chat_messages(), CVideo::set_help_string(), and show_tooltip().

◆ pango_draw_text() [1/2]

SDL_Rect font::pango_draw_text	(	CVideo *	gui,
		const SDL_Rect &	area,
		int	size,
		const color_t &	color,
		const std::string &	text,
		int	x,
		int	y,
		bool	use_tooltips = `false`,
		pango_text::FONT_STYLE	style = `pango_text::STYLE_NORMAL`
	)

Draws text on the screen.

gui can be nullptr, in which case the bounding rectangle will still be returned.

Definition at line 139 of file sdl_ttf_compat.cpp.

References CVideo::getSurface(), and utf8::size().

Referenced by gui::button::calculate_size(), location_palette_item::draw_contents(), gui::button::draw_contents(), draw_label(), gui::menu::draw_row(), gui::dialog_frame::draw_title(), gui::menu::style::item_size(), and pango_line_width().

◆ pango_draw_text() [2/2]

SDL_Rect font::pango_draw_text	(	surface &	dst,
		const SDL_Rect &	area,
		int	size,
		const color_t &	color,
		const std::string &	text,
		int	x,
		int	y,
		bool	use_tooltips = `false`,
		pango_text::FONT_STYLE	style = `pango_text::STYLE_NORMAL`
	)

Draws text on a surface.

The text will be clipped to area. If the text runs outside of area horizontally, an ellipsis will be displayed at the end of it.

If use_tooltips is true, then text with an ellipsis will have a tooltip set for it equivalent to the entire contents of the text.

A bounding rectangle of the text is returned. If dst is nullptr, then the text will not be drawn, and a bounding rectangle only will be returned.

Definition at line 146 of file sdl_ttf_compat.cpp.

References tooltips::add_tooltip(), FONT_SANS_SERIF, s, and sdl_blit().

◆ pango_line_ellipsize()

std::string font::pango_line_ellipsize	(	const std::string &	text,
		int	font_size,
		int	max_width,
		font::pango_text::FONT_STYLE	font_style
	)

If the text exceeds the specified max width, end it with an ellipsis (...)

Definition at line 76 of file sdl_ttf_compat.cpp.

References ellipsis, ucs4::iterator_base< string_type, update_implementation >::end(), pango_line_width(), ucs4::iterator_base< string_type, update_implementation >::substr(), and WRN_FT.

Referenced by pango_line_width(), and help::help_text_area::set_items().

◆ pango_line_size()

std::pair< int, int > font::pango_line_size	(	const std::string &	line,
		int	font_size,
		font::pango_text::FONT_STYLE	font_style
	)

Determine the width and height of a line of text given a certain font size.

Definition at line 60 of file sdl_ttf_compat.cpp.

References FONT_SANS_SERIF, and s.

Referenced by gui::menu::draw_row(), and pango_line_width().

◆ pango_line_width()

int font::pango_line_width	(	const std::string &	line,
		int	font_size,
		font::pango_text::FONT_STYLE	font_style = `font::pango_text::STYLE_NORMAL`
	)

inline

Determine the width of a line of text given a certain font size.

Definition at line 48 of file sdl_ttf_compat.hpp.

References pango_draw_text(), pango_line_ellipsize(), pango_line_size(), pango_word_wrap(), utf8::size(), and font::pango_text::STYLE_NORMAL.

Referenced by help::help_text_area::add_text_item(), gui::textbox::add_text_line(), help::unit_topic_generator::operator()(), pango_line_ellipsize(), help::unit_topic_generator::push_header(), help::push_tab_pair(), and CVideo::set_help_string().

◆ pango_render_text()

surface font::pango_render_text	(	const std::string &	text,
		int	size,
		const color_t &	color,
		font::pango_text::FONT_STYLE	style,
		bool	use_markup,
		int	max_width
	)