Terminal and file output formatting for deltaFlow. More...

Classes
struct	LicenseLine
	A single line in the license notice box. More...

struct	ProductLine
	A single line in the product info box. More...

Functions
std::string	padRight (const std::string &text, int width)
	Right-pads a string with spaces to the given width.

std::string	centerIn (const std::string &text, int width)
	Centers a string within a given width.

std::string	separator (char ch='=')
	Returns a separator line of the given character.

std::string	center (const std::string &text)
	Returns a centered string within the page width.

std::string	hostname ()
	Returns the machine hostname.

std::vector< LicenseLine >	licenseContent ()
	Returns the license notice content lines.

std::vector< ProductLine >	productContent ()
	Returns the product info box content lines.

std::string	licenseNotice ()
	Returns the plain-text license notice box.

std::string	productBox ()
	Returns the plain-text product info box.

std::string	fileBanner ()
	Returns a full plain-text banner for output/log files.

std::string	sectionHeader (const std::string &title)
	Returns a section header for output files.

std::string	subSectionHeader (const std::string &title)
	Returns a sub-section header for output files.

void	printLicenseNotice ()
	Prints the colored license notice box to terminal.

void	printProductBox ()
	Prints the colored product info box to terminal.

void	printTerminalBanner ()
	Prints the full colored banner to terminal.

void	printSectionHeader (const std::string &title)
	Prints a colored section header to terminal.

Variables
constexpr fmt::rgb	LOGO_COLOR {153, 0, 204}
	deltaFlow logo color

constexpr int	pageWidth = 80
	Standard output page width.

constexpr int	licenseBoxWidth = 67
	License notice box width.

constexpr int	productBoxWidth = 59
	Product info box width.

Detailed Description

Terminal and file output formatting for deltaFlow.

Provides colored terminal banners, plain-text banners for log/output files, section headers, and common formatting constants.

Function Documentation

◆ center()

std::string Display::center ( const std::string & text )

inline

Returns a centered string within the page width.

Parameters

text	Text to center.

Returns: Padded string.

Definition at line 91 of file Display.H.

                                                   {
        return centerIn(text, pageWidth);
    }

References centerIn(), and pageWidth.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ centerIn()

std::string Display::centerIn	(	const std::string &	text,
		int	width
	)

inline

Centers a string within a given width.

Parameters

text	Text to center.
width	Target width.

Returns: Centered string.

Definition at line 72 of file Display.H.

                                                                {
        int left = (width - static_cast<int>(text.size())) / 2;
        return (left > 0) ? std::string(left, ' ') + text : text;
    }

Here is the caller graph for this function:

◆ fileBanner()

std::string Display::fileBanner ( )

inline

Returns a full plain-text banner for output/log files.

Definition at line 217 of file Display.H.

                                  {
        return licenseNotice() + "\n" + productBox();
    }

References licenseNotice(), and productBox().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hostname()

std::string Display::hostname ( )

inline

Returns the machine hostname.

Returns: Hostname string, or "unknown" on failure.

Definition at line 99 of file Display.H.

                                {
        char buf[256];
    #ifdef _WIN32
        DWORD len = sizeof(buf);
        if (GetComputerNameA(buf, &len)) return std::string(buf);
    #else
        if (gethostname(buf, sizeof(buf)) == 0) return std::string(buf);
    #endif
        return "unknown";
    }

Here is the caller graph for this function:

◆ licenseContent()

std::vector< LicenseLine > Display::licenseContent ( )

inline

Returns the license notice content lines.

Shared by licenseNotice() (plain-text) and printLicenseNotice() (colored).

Definition at line 121 of file Display.H.

                                                   {
        constexpr int inner = licenseBoxWidth - 2;
        auto mid = [inner](const std::string& t) { return centerIn(t, inner); };
 
        return {
            {"",                                                            false},
            {mid(R"(   /\\     +)"),                                        true},
            {mid(R"(  /  \\     )"),                                        true},
            {mid(R"( /    \\    )"),                                        true},
            {mid(R"(/      \\   )"),                                        true},
            {mid(R"(=========  -)"),                                        true},
            {mid("deltaFlow  v" + std::string(deltaFlow_VERSION)),          true},
            {"",                                                            false},
            {"  Copyright (c) 2024 Saud Zahir.",                            false},
            {"  All rights reserved.",                                      false},
            {"",                                                            false},
            {"  deltaFlow is free software: you can redistribute it",       false},
            {"  and/or modify it under the terms of the GNU General",       false},
            {"  Public License as published by the Free Software",          false},
            {"  Foundation, either version 3 of the License, or",           false},
            {"  (at your option) any later version.",                       false},
            {"",                                                            false},
            {"  deltaFlow is distributed in the hope that it will be useful,", false},
            {"  but WITHOUT ANY WARRANTY; without even the implied warranty",   false},
            {"  of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.",       false},
            {"  See the GNU General Public License for more details.",          false},
            {"",                                                            false},
            {"  <https://www.gnu.org/licenses/>",                           false},
            {"",                                                            false},
        };
    }

References centerIn(), and licenseBoxWidth.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ licenseNotice()

std::string Display::licenseNotice ( )

inline

Returns the plain-text license notice box.

Definition at line 189 of file Display.H.

                                     {
        constexpr int inner = licenseBoxWidth - 2;
        std::string rule = " " + std::string(licenseBoxWidth, '*') + "\n";
 
        std::string s = rule;
        for (const auto& line : licenseContent())
            s += " *" + padRight(line.text, inner) + "*\n";
        s += rule;
        return s;
    }

References licenseBoxWidth, licenseContent(), and padRight().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ padRight()

std::string Display::padRight	(	const std::string &	text,
		int	width
	)

inline

Right-pads a string with spaces to the given width.

Parameters

text	Input string.
width	Target width.

Returns: Padded string (unchanged if text is already wider).

Definition at line 61 of file Display.H.

                                                                {
        int pad = width - static_cast<int>(text.size());
        return (pad > 0) ? text + std::string(pad, ' ') : text;
    }

Here is the caller graph for this function:

◆ printLicenseNotice()

void Display::printLicenseNotice ( )

inline

Prints the colored license notice box to terminal.

Definition at line 255 of file Display.H.

                                     {
        constexpr int inner = licenseBoxWidth - 2;
        constexpr fmt::rgb BORDER{0x5a, 0x71, 0x79};
 
        auto rule = [&]() {
            fmt::print(fg(BORDER), " {}\n", std::string(licenseBoxWidth, '*'));
        };
 
        rule();
        for (const auto& line : licenseContent()) {
            fmt::rgb color = line.isLogo ? LOGO_COLOR : BORDER;
            fmt::print(fg(BORDER), " *");
            fmt::print(fg(color) | fmt::emphasis::bold, "{}", line.text);
            fmt::print(fg(BORDER), "{}*\n", padRight("", inner - static_cast<int>(line.text.size())));
        }
        rule();
    }

References licenseBoxWidth, licenseContent(), LOGO_COLOR, and padRight().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ printProductBox()

void Display::printProductBox ( )

inline

Prints the colored product info box to terminal.

Definition at line 276 of file Display.H.

                                  {
        constexpr int inner = productBoxWidth - 2;
 
        auto printLine = [&](const std::string& text, fmt::rgb color) {
            fmt::print(fg(fmt::color::white) | fmt::emphasis::bold, "            |");
            fmt::print(fg(color), "{}", padRight(text, inner));
            fmt::print(fg(fmt::color::white) | fmt::emphasis::bold, "|\n");
        };
 
        auto printKV = [&](const std::string& key, const std::string& val,
                           fmt::rgb keyColor, fmt::rgb valColor) {
            int pad = inner - static_cast<int>(key.size()) - static_cast<int>(val.size());
            if (pad < 0) pad = 0;
            fmt::print(fg(fmt::color::white) | fmt::emphasis::bold, "            |");
            fmt::print(fg(keyColor), "{}", key);
            fmt::print(fg(valColor) | fmt::emphasis::bold, "{}", val);
            fmt::print("{}", std::string(pad, ' '));
            fmt::print(fg(fmt::color::white) | fmt::emphasis::bold, "|\n");
        };
 
        fmt::print(fg(fmt::color::white) | fmt::emphasis::bold,
            "             {}\n", std::string(inner, '_'));
 
        for (const auto& p : productContent()) {
            if (p.value.empty())
                printLine(p.key, p.keyColor);
            else
                printKV(p.key, p.value, p.keyColor, p.valColor);
        }
 
        fmt::print(fg(fmt::color::white) | fmt::emphasis::bold,
            "            |{}|\n", std::string(inner, '_'));
    }

References padRight(), productBoxWidth, and productContent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ printSectionHeader()

void Display::printSectionHeader ( const std::string & title )

inline

Prints a colored section header to terminal.

Parameters

title Section title.

Definition at line 325 of file Display.H.

                                                           {
        fmt::print("\n");
        fmt::print(fg(LOGO_COLOR), "{}\n", separator('*'));
        fmt::print("\n");
        fmt::print(fg(LOGO_COLOR) | fmt::emphasis::bold, "{}\n", center(title));
        fmt::print(fg(LOGO_COLOR), "{}\n", center(std::string(title.size() + 4, '-')));
        fmt::print("\n");
        fmt::print(fg(LOGO_COLOR), "{}\n", separator('*'));
        fmt::print("\n");
    }

References center(), LOGO_COLOR, and separator().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ printTerminalBanner()

void Display::printTerminalBanner ( )

inline

Prints the full colored banner to terminal.

Definition at line 313 of file Display.H.

                                      {
        fmt::print("\n");
        printLicenseNotice();
        fmt::print("\n");
        printProductBox();
        fmt::print("\n");
    }

References printLicenseNotice(), and printProductBox().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ productBox()

std::string Display::productBox ( )

inline

Returns the plain-text product info box.

Definition at line 203 of file Display.H.

                                  {
        constexpr int inner = productBoxWidth - 2;
 
        std::string s;
        s += "             " + std::string(inner, '_') + "\n";
        for (const auto& p : productContent())
            s += "            |" + padRight(p.key + p.value, inner) + "|\n";
        s += "            |" + std::string(inner, '_') + "|\n";
        return s;
    }

References padRight(), productBoxWidth, and productContent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ productContent()

std::vector< ProductLine > Display::productContent ( )

inline

Returns the product info box content lines.

Shared by productBox() (plain-text) and printProductBox() (colored).

Definition at line 166 of file Display.H.

                                                   {
        constexpr fmt::rgb INFO{100, 200, 255};
        constexpr fmt::rgb VAL{255, 255, 100};
        constexpr fmt::rgb DIM{180, 180, 180};
 
        return {
            {"",                                                   "", LOGO_COLOR,           {}},
            {"  deltaFlow -- Power Flow Analysis Software",        "", LOGO_COLOR,           {}},
            {"  A Program for Steady-State Power System Analysis", "", DIM,                  {}},
            {"  Version : ", deltaFlow_VERSION,                        INFO,                 VAL},
            {"  CMake   : ", CMake_VERSION,                            INFO,                 VAL},
            {"  GCC     : ", gcc_VERSION,                              INFO,                 VAL},
            {"",                                                   "", LOGO_COLOR,           {}},
            {"  Copyright (c) 2024 ", "Saud Zahir",                    DIM,  fmt::rgb{255, 165, 0}},
            {"  Licensed under GNU GPL v3.0",                      "", fmt::rgb{100,255,100},{}},
            {"",                                                   "", LOGO_COLOR,           {}},
            {"  Hostname  : ", hostname(),                             INFO, fmt::rgb{255, 200, 100}},
        };
    }

References hostname(), INFO, and LOGO_COLOR.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sectionHeader()

std::string Display::sectionHeader ( const std::string & title )

inline

Returns a section header for output files.

Parameters

title Section title.

Returns: Formatted section header string.

Definition at line 226 of file Display.H.

                                                           {
        std::string s;
        s += "\n";
        s += separator('*') + "\n";
        s += "\n";
        s += center(title) + "\n";
        s += center(std::string(title.size() + 4, '-')) + "\n";
        s += "\n";
        s += separator('*') + "\n";
        return s;
    }

References center(), and separator().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ separator()

std::string Display::separator ( char ch = '=' )

inline

Returns a separator line of the given character.

Parameters

ch	Fill character (default: '=').

Returns: String of pageWidth characters.

Definition at line 82 of file Display.H.

                                              {
        return std::string(pageWidth, ch);
    }

References pageWidth.

Here is the caller graph for this function:

◆ subSectionHeader()

std::string Display::subSectionHeader ( const std::string & title )

inline

Returns a sub-section header for output files.

Parameters

title Sub-section title.

Returns: Formatted sub-section header string.

Definition at line 243 of file Display.H.

                                                              {
        std::string s;
        s += "\n";
        s += "   " + std::string(title.size() + 4, '-') + "\n";
        s += "   " + title + "\n";
        s += "   " + std::string(title.size() + 4, '-') + "\n";
        return s;
    }

Variable Documentation

◆ licenseBoxWidth

constexpr int Display::licenseBoxWidth = 67

constexpr

License notice box width.

Definition at line 52 of file Display.H.

◆ LOGO_COLOR

constexpr fmt::rgb Display::LOGO_COLOR {153, 0, 204}

constexpr

deltaFlow logo color

Definition at line 50 of file Display.H.

50{153, 0, 204};

◆ pageWidth

constexpr int Display::pageWidth = 80

constexpr

Standard output page width.

Definition at line 51 of file Display.H.

◆ productBoxWidth

constexpr int Display::productBoxWidth = 59

constexpr

Product info box width.

Definition at line 53 of file Display.H.

Classes

Functions

Variables

Detailed Description

Function Documentation

◆ center()

◆ centerIn()

◆ fileBanner()

◆ hostname()

◆ licenseContent()

◆ licenseNotice()

◆ padRight()

◆ printLicenseNotice()

◆ printProductBox()

◆ printSectionHeader()

◆ printTerminalBanner()

◆ productBox()

◆ productContent()

◆ sectionHeader()

◆ separator()

◆ subSectionHeader()

Variable Documentation

◆ licenseBoxWidth

◆ LOGO_COLOR

◆ pageWidth

◆ productBoxWidth