porytiles2::TextFormatter Class Reference

Abstract base class for applying text styling with context-aware formatting. More...

#include <text_formatter.hpp>

Inheritance diagram for porytiles2::TextFormatter:

Public Member Functions
virtual	~TextFormatter ()=default
virtual std::string	style (const std::string &text, Style styles) const =0
	Applies styling to a text string.
virtual std::string	format (const std::string &format_str, const std::vector< FormatParam > &params) const
	Formats a string with styled parameters using fmtlib syntax.
template<typename FirstParam , typename... RestParams> requires ( !std::is_same_v<std::decay_t<FirstParam>, std::vector<FormatParam>> && std::is_constructible_v<FormatParam, FirstParam> && (std::is_constructible_v<FormatParam, RestParams> && ...))
std::string	format (const std::string &format_str, FirstParam &&first, RestParams &&...rest) const
	Formats a string with styled parameters using variadic template syntax.

Detailed Description

Abstract base class for applying text styling with context-aware formatting.

TextFormatter provides a polymorphic interface for applying text styles in a way that adapts to the output context. Concrete implementations can choose whether to apply styling based on factors like TTY detection, allowing the same code to produce styled terminal output or plain text for file output.

The class provides two key capabilities:

• style(): Apply Style flags to individual text strings
• format(): Substitute styled FormatParams into format strings using fmtlib syntax

Implementations:

• PlainTextFormatter: Returns text unchanged, stripping all styles (for non-TTY/files)
• AnsiStyledTextFormatter: Applies ANSI escape codes for terminal colors (for TTY)

This class integrates with the error reporting system through FormattableError and UserDiagnostics to provide adaptive styling for diagnostic messages.

Definition at line 235 of file text_formatter.hpp.

Constructor & Destructor Documentation

~TextFormatter()

virtual porytiles2::TextFormatter::~TextFormatter ( )

virtualdefault

Member Function Documentation

format() [1/2]

std::string porytiles2::TextFormatter::format ( const std::string &  format_str, const std::vector< FormatParam > &  params  ) const

virtual

Formats a string with styled parameters using fmtlib syntax.

Substitutes styled FormatParams into a format string using fmtlib's formatting system. Each FormatParam's text is first styled using the style() method, then substituted into the corresponding {} placeholder in the format string.

Example:

 ++
formatter.format("Error in file '{}'", {FormatParam{filename, Style::bold}})

Parameters

format_str	The format string with {} placeholders
params	Vector of FormatParams to substitute into placeholders

Returns

The formatted string with styled parameters substituted

Definition at line 11 of file text_formatter.cpp.

format() [2/2]

template<typename FirstParam , typename... RestParams>
requires ( !std::is_same_v<std::decay_t<FirstParam>, std::vector<FormatParam>> && std::is_constructible_v<FormatParam, FirstParam> && (std::is_constructible_v<FormatParam, RestParams> && ...))

std::string porytiles2::TextFormatter::format ( const std::string &  format_str, FirstParam &&  first, RestParams &&...  rest  ) const

inline

Formats a string with styled parameters using variadic template syntax.

Convenience template that allows passing FormatParams directly as arguments instead of wrapping them in a std::vector. This provides more natural syntax for formatting calls with a known number of parameters.

Example:

 ++
formatter.format("Error in file '{}'", FormatParam{filename, Style::bold | Style::red});
formatter.format("Expected {} but got {}", expected, actual);

This template is disabled when called with a std::vector<FormatParam> to avoid ambiguity with the base implementation.

Template Parameters

FirstParam	Type of the first parameter
RestParams	Types of remaining parameters

Parameters

format_str	The format string with {} placeholders
first	First FormatParam argument
rest	Remaining FormatParam arguments to substitute into placeholders

Returns

The formatted string with styled parameters substituted

Definition at line 301 of file text_formatter.hpp.

style()

virtual std::string porytiles2::TextFormatter::style ( const std::string &  text, Style  styles  ) const

pure virtual

Applies styling to a text string.

Pure virtual method that concrete formatters must implement to apply the specified Style flags to the given text. The implementation determines whether to actually apply styling (ANSI codes) or return the text unchanged (plain text).

Parameters

text	The text to style
styles	The Style flags to apply

Returns

The styled text string (may be unchanged in PlainTextFormatter)

Implemented in porytiles2::PlainTextFormatter, and porytiles2::AnsiStyledTextFormatter.

---

The documentation for this class was generated from the following files:

• Porytiles2/include/porytiles2/utilities/text/text_formatter.hpp
• Porytiles2/lib/utilities/text/text_formatter.cpp