Files
MeanField_SERiF/docs/man/man3/serif_utils_misc_terminal.3

132 lines
4.4 KiB
Groff
Raw Permalink Normal View History

.TH "serif::utils::misc::terminal" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::utils::misc::terminal
.SH SYNOPSIS
.br
.PP
.SS "Enumerations"
.in +1c
.ti -1c
.RI "enum class \fBANSIColors\fP : int { \fBBLACK\fP = 30, \fBRED\fP = 31, \fBGREEN\fP = 32, \fBYELLOW\fP = 33, \fBBLUE\fP = 34, \fBMAGENTA\fP = 35, \fBCYAN\fP = 36, \fBWHITE\fP = 37, \fBBRIGHT_BLACK\fP = 90, \fBBRIGHT_RED\fP = 91, \fBBRIGHT_GREEN\fP = 92, \fBRESET\fP = 0 }"
.br
.in -1c
.SS "Functions"
.in +1c
.ti -1c
.RI "consteval std::string_view \fBresolve_ansi_color\fP (const \fBANSIColors\fP color) noexcept"
.br
.ti -1c
.RI "bool \fBsupports_ansi\fP (std::FILE *stream=stdout) noexcept"
.br
.in -1c
.SS "Variables"
.in +1c
.ti -1c
.RI "constexpr std::string_view \fBa_black\fP = \fBresolve_ansi_color\fP(\fBANSIColors::BLACK\fP)"
.br
.ti -1c
.RI "constexpr std::string_view \fBa_red\fP = \fBresolve_ansi_color\fP(\fBANSIColors::RED\fP)"
.br
.ti -1c
.RI "constexpr std::string_view \fBa_green\fP = \fBresolve_ansi_color\fP(\fBANSIColors::GREEN\fP)"
.br
.ti -1c
.RI "constexpr std::string_view \fBa_yellow\fP = \fBresolve_ansi_color\fP(\fBANSIColors::YELLOW\fP)"
.br
.ti -1c
.RI "constexpr std::string_view \fBa_blue\fP = \fBresolve_ansi_color\fP(\fBANSIColors::BLUE\fP)"
.br
.ti -1c
.RI "constexpr std::string_view \fBa_magenta\fP = \fBresolve_ansi_color\fP(\fBANSIColors::MAGENTA\fP)"
.br
.ti -1c
.RI "constexpr std::string_view \fBa_cyan\fP = \fBresolve_ansi_color\fP(\fBANSIColors::CYAN\fP)"
.br
.ti -1c
.RI "constexpr std::string_view \fBa_white\fP = \fBresolve_ansi_color\fP(\fBANSIColors::WHITE\fP)"
.br
.ti -1c
.RI "constexpr std::string_view \fBa_bright_black\fP = \fBresolve_ansi_color\fP(\fBANSIColors::BRIGHT_BLACK\fP)"
.br
.ti -1c
.RI "constexpr std::string_view \fBa_bright_red\fP = \fBresolve_ansi_color\fP(\fBANSIColors::BRIGHT_RED\fP)"
.br
.ti -1c
.RI "constexpr std::string_view \fBa_bright_green\fP = \fBresolve_ansi_color\fP(\fBANSIColors::BRIGHT_GREEN\fP)"
.br
.ti -1c
.RI "constexpr std::string_view \fBa_reset\fP = \fBresolve_ansi_color\fP(\fBANSIColors::RESET\fP)"
.br
.in -1c
.SH "Enumeration Type Documentation"
.PP
.SS "enum class \fBserif::utils::misc::terminal::ANSIColors\fP : int\fR [strong]\fP"
.PP
\fBEnumerator\fP
.in +1c
.TP
\f(BIBLACK \fP
.TP
\f(BIRED \fP
.TP
\f(BIGREEN \fP
.TP
\f(BIYELLOW \fP
.TP
\f(BIBLUE \fP
.TP
\f(BIMAGENTA \fP
.TP
\f(BICYAN \fP
.TP
\f(BIWHITE \fP
.TP
\f(BIBRIGHT_BLACK \fP
.TP
\f(BIBRIGHT_RED \fP
.TP
\f(BIBRIGHT_GREEN \fP
.TP
\f(BIRESET \fP
.SH "Function Documentation"
.PP
.SS "std::string_view serif::utils::misc::terminal::resolve_ansi_color (const \fBANSIColors\fP color)\fR [consteval]\fP, \fR [noexcept]\fP"
.SS "bool serif::utils::misc::terminal::supports_ansi (std::FILE * stream = \fRstdout\fP)\fR [inline]\fP, \fR [noexcept]\fP"
.SH "Variable Documentation"
.PP
.SS "std::string_view serif::utils::misc::terminal::a_black = \fBresolve_ansi_color\fP(\fBANSIColors::BLACK\fP)\fR [constexpr]\fP"
.SS "std::string_view serif::utils::misc::terminal::a_blue = \fBresolve_ansi_color\fP(\fBANSIColors::BLUE\fP)\fR [constexpr]\fP"
.SS "std::string_view serif::utils::misc::terminal::a_bright_black = \fBresolve_ansi_color\fP(\fBANSIColors::BRIGHT_BLACK\fP)\fR [constexpr]\fP"
.SS "std::string_view serif::utils::misc::terminal::a_bright_green = \fBresolve_ansi_color\fP(\fBANSIColors::BRIGHT_GREEN\fP)\fR [constexpr]\fP"
.SS "std::string_view serif::utils::misc::terminal::a_bright_red = \fBresolve_ansi_color\fP(\fBANSIColors::BRIGHT_RED\fP)\fR [constexpr]\fP"
.SS "std::string_view serif::utils::misc::terminal::a_cyan = \fBresolve_ansi_color\fP(\fBANSIColors::CYAN\fP)\fR [constexpr]\fP"
.SS "std::string_view serif::utils::misc::terminal::a_green = \fBresolve_ansi_color\fP(\fBANSIColors::GREEN\fP)\fR [constexpr]\fP"
.SS "std::string_view serif::utils::misc::terminal::a_magenta = \fBresolve_ansi_color\fP(\fBANSIColors::MAGENTA\fP)\fR [constexpr]\fP"
.SS "std::string_view serif::utils::misc::terminal::a_red = \fBresolve_ansi_color\fP(\fBANSIColors::RED\fP)\fR [constexpr]\fP"
.SS "std::string_view serif::utils::misc::terminal::a_reset = \fBresolve_ansi_color\fP(\fBANSIColors::RESET\fP)\fR [constexpr]\fP"
.SS "std::string_view serif::utils::misc::terminal::a_white = \fBresolve_ansi_color\fP(\fBANSIColors::WHITE\fP)\fR [constexpr]\fP"
.SS "std::string_view serif::utils::misc::terminal::a_yellow = \fBresolve_ansi_color\fP(\fBANSIColors::YELLOW\fP)\fR [constexpr]\fP"
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.