M3::Utils::TablePrinter Class Reference

Creates fancy formatted text tables for terminal output. More...

#include <Manager/TablePrinter.h>

Collaboration diagram for M3::Utils::TablePrinter:

Public Member Functions
	TablePrinter (std::vector< ColumnSpec > columns)
	Construct a table printer with the specified columns. More...
template<typename... Args>
void	AddRow (Args &&... args)
	Add a row to the table. More...
std::vector< std::string >	Render () const
	Render the complete table, with widths etc. defined by constructor. More...

Private Member Functions
std::vector< std::size_t >	CalculateWidths () const
std::vector< std::string >	MakeHeader () const
std::string	MakeBorder (const std::vector< std::size_t > &widths, const std::string_view left, const std::string_view middle, const std::string_view right, const std::string_view horizontal) const
std::string	MakeRow (const std::vector< std::size_t > &widths, const std::vector< std::string > &row) const

Static Private Member Functions
template<typename T >
static std::string	toString (T &&value)
	Convert a value to a string using stream formatting. More...
static std::string	Truncate (const std::string_view value, const std::size_t width)
	If name is longer than desired name we truncate for example instead of SuperLongBlarb we have SuperLong... More...
static std::string	Align (const std::string_view value, const std::size_t width, const Alignment alignment)
	Alling to values to table deepening on values. More...

Private Attributes
std::vector< ColumnSpec >	_columns
std::vector< std::vector< std::string > >	_rows

Detailed Description

Creates fancy formatted text tables for terminal output.

Author

Kamil Skwarczynski

Definition at line 50 of file TablePrinter.h.

Constructor & Destructor Documentation

TablePrinter()

M3::Utils::TablePrinter::TablePrinter ( std::vector< ColumnSpec >  columns )

inlineexplicit

Construct a table printer with the specified columns.

Definition at line 53 of file TablePrinter.h.

: _columns(std::move(columns)) {}

Member Function Documentation

AddRow()

template<typename... Args>

void M3::Utils::TablePrinter::AddRow ( Args &&...  args )

inline

Add a row to the table.

Definition at line 57 of file TablePrinter.h.

                              {
    _rows.push_back({toString(std::forward<Args>(args))...});
  }

Align()

static std::string M3::Utils::TablePrinter::Align ( const std::string_view  value, const std::size_t  width, const Alignment  alignment  )

inlinestaticprivate

Alling to values to table deepening on values.

Definition at line 114 of file TablePrinter.h.

  {
    if (value.size() >= width){
      return std::string(value);
    }
    const std::size_t padding = width - value.size();
 
    switch (alignment) {
      case Alignment::Left:
        return std::string(value) + std::string(padding, ' ');
 
      case Alignment::Right:
        return std::string(padding, ' ') + std::string(value);
 
      case Alignment::Center: {
        const std::size_t left = padding / 2;
        const std::size_t right = padding - left;
 
        return std::string(left, ' ') + std::string(value) + std::string(right, ' ');
      }
    }
    return std::string(value);
  }

CalculateWidths()

std::vector<std::size_t> M3::Utils::TablePrinter::CalculateWidths ( ) const

inlineprivate

Definition at line 141 of file TablePrinter.h.

  {
    std::vector<std::size_t> widths;
    widths.reserve(_columns.size());
 
    for (std::size_t col = 0; col < _columns.size(); ++col) {
      auto width = _columns[col].name.size();
 
      for (const auto& row : _rows) {
        if (col < row.size()) {
          width = std::max(width, row[col].size());
        }
      }
 
      width = std::max(width, _columns[col].minWidth);
 
      if (_columns[col].maxWidth != 0){
        width = std::min(width, _columns[col].maxWidth);
      }
      widths.push_back(width);
    }
 
    return widths;
  }

MakeBorder()

std::string M3::Utils::TablePrinter::MakeBorder ( const std::vector< std::size_t > &  widths, const std::string_view  left, const std::string_view  middle, const std::string_view  right, const std::string_view  horizontal  ) const

inlineprivate

Definition at line 175 of file TablePrinter.h.

                                                                                            {
    std::string result;
    result += left;
 
    for (std::size_t i = 0; i < widths.size(); ++i) {
      for (std::size_t j = 0; j < widths[i] + 2; ++j) {
        result += horizontal;
      }
      if (i + 1 < widths.size()) result += middle;
    }
 
    result += right;
    return result;
  }

MakeHeader()

std::vector<std::string> M3::Utils::TablePrinter::MakeHeader ( ) const

inlineprivate

Definition at line 166 of file TablePrinter.h.

  {
    std::vector<std::string> header(_columns.size());
    for (std::size_t i = 0; i < _columns.size(); i++) {
      header[i] = _columns[i].name;
    }
    return header;
  }

MakeRow()

std::string M3::Utils::TablePrinter::MakeRow ( const std::vector< std::size_t > &  widths, const std::vector< std::string > &  row  ) const

inlineprivate

Definition at line 192 of file TablePrinter.h.

                                                             {
    std::string result = "│";
 
    for (std::size_t col = 0; col < widths.size(); ++col) {
      std::string value;
 
      if (col < row.size()){
        value = Truncate(row[col], widths[col]);
      }
      value = Align(value, widths[col], _columns[col].alignment);
 
      result += " ";
      result += value;
      result += " │";
    }
    return result;
  }

Render()

std::vector<std::string> M3::Utils::TablePrinter::Render ( ) const

inline

Render the complete table, with widths etc. defined by constructor.

Definition at line 63 of file TablePrinter.h.

  {
    if (_columns.empty()) return {};
 
    const auto widths = CalculateWidths();
 
    std::vector<std::string> result;
    result.reserve(_rows.size() + 4);
 
    // ┌──────┬────────┐
    result.push_back(MakeBorder(widths, "┌", "┬", "┐", "─"));
 
    // │ Name │ Value  │
    result.push_back(MakeRow(widths, MakeHeader()));
 
    // ├──────┼────────┤
    result.push_back(MakeBorder(widths, "├", "┼", "┤", "─"));
 
    // data rows
    for (const auto& row : _rows)
      result.push_back(MakeRow(widths, row));
 
    // └──────┴────────┘
    result.push_back(MakeBorder(widths, "└", "┴", "┘", "─"));
 
    return result;
  }

toString()

template<typename T >

static std::string M3::Utils::TablePrinter::toString ( T &&  value )

inlinestaticprivate

Convert a value to a string using stream formatting.

Definition at line 96 of file TablePrinter.h.

  {
    std::ostringstream os;
    os << std::forward<T>(value);
    return os.str();
  }

Truncate()

static std::string M3::Utils::TablePrinter::Truncate ( const std::string_view  value, const std::size_t  width  )

inlinestaticprivate

If name is longer than desired name we truncate for example instead of SuperLongBlarb we have SuperLong...

Definition at line 103 of file TablePrinter.h.

  {
    if (value.size() <= width) return std::string(value);
 
    if (width == 0) return {};
 
    if (width == 1) return "…";
 
    return std::string(value.substr(0, width - 1)) + "…";
  }

Member Data Documentation

_columns

std::vector<ColumnSpec> M3::Utils::TablePrinter::_columns

private

Definition at line 92 of file TablePrinter.h.

_rows

std::vector<std::vector<std::string> > M3::Utils::TablePrinter::_rows

private

Definition at line 93 of file TablePrinter.h.

---

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

• Manager/TablePrinter.h