src/ftxui/dom/table.cpp

Go to the documentation of this file.

// Copyright 2021 Arthur Sonzogni. All rights reserved.
// Use of this source code is governed by the MIT license that can be found in
// the LICENSE file.
#include "ftxui/dom/table.hpp"
 
#include <algorithm>         // for max
#include <initializer_list>  // for initializer_list
#include <memory>   // for allocator, shared_ptr, allocator_traits<>::value_type
#include <utility>  // for move, swap
#include <vector>   // for vector
 
#include "ftxui/dom/elements.hpp"  // for Element, operator|, text, separatorCharacter, Elements, BorderStyle, Decorator, emptyElement, size, gridbox, EQUAL, flex, flex_shrink, HEIGHT, WIDTH
 
namespace ftxui {
namespace {
 
bool IsCell(int x, int y) {
  return x % 2 == 1 && y % 2 == 1;
}
 
// NOLINTNEXTLINE
static std::string table_charset[6][6] = {
    {"┌", "┐", "└", "┘", "─", "│"},  // LIGHT
    {"┏", "┓", "┗", "┛", "╍", "╏"},  // DASHED
    {"┏", "┓", "┗", "┛", "━", "┃"},  // HEAVY
    {"╔", "╗", "╚", "╝", "═", "║"},  // DOUBLE
    {"╭", "╮", "╰", "╯", "─", "│"},  // ROUNDED
    {" ", " ", " ", " ", " ", " "},  // EMPTY
};
 
// Resolve negative indices as counting from the end.
int Wrap(int input, int modulo) {
  return input < 0 ? input + modulo : input;
}
 
bool InRange(int input, int modulo) {
  return input >= 0 && input < modulo;
}
 
void Order(int& a, int& b) {
  if (a >= b) {
    std::swap(a, b);
  }
}
 
}  // namespace
 
/// @brief Create an empty table.
Table::Table() {
  Initialize({});
}
 
/// @brief Create a table from a vector of vector of string.
/// @param input The input data.
Table::Table(const std::vector<std::vector<std::string>>& input) {
  std::vector<std::vector<Element>> output;
  output.reserve(input.size());
  for (const auto& row : input) {
    output.emplace_back();
    auto& output_row = output.back();
    output_row.reserve(row.size());
    for (const auto& cell : row) {
      output_row.push_back(text(std::move(cell)));
    }
  }
  Initialize(std::move(output));
}
 
/// @brief Create a table from a vector of vector of Element
/// @param input The input elements.
Table::Table(std::vector<std::vector<Element>> input) {
  Initialize(std::move(input));
}
 
/// @brief Create a table from a list of list of string.
/// @param init The input data.
Table::Table(std::initializer_list<std::vector<std::string>> init) {
  std::vector<std::vector<Element>> input;
  for (const auto& row : init) {
    std::vector<Element> output_row;
    output_row.reserve(row.size());
    for (const auto& cell : row) {
      output_row.push_back(text(cell));
    }
    input.push_back(std::move(output_row));
  }
  Initialize(std::move(input));
}
 
// private
void Table::Initialize(std::vector<std::vector<Element>> input) {
  input_dim_y_ = static_cast<int>(input.size());
  input_dim_x_ = 0;
  for (auto& row : input) {
    input_dim_x_ = std::max(input_dim_x_, int(row.size()));
  }
 
  dim_y_ = 2 * input_dim_y_ + 1;
  dim_x_ = 2 * input_dim_x_ + 1;
 
  // Reserve space.
  elements_.resize(dim_y_);
  for (int y = 0; y < dim_y_; ++y) {
    elements_[y].resize(dim_x_);
  }
 
  // Transfer elements_ from |input| toward |elements_|.
  {
    int y = 1;
    for (auto& row : input) {
      int x = 1;
      for (auto& cell : row) {
        elements_[y][x] = std::move(cell);
        x += 2;
      }
      y += 2;
    }
  }
 
  // Add empty element for the border.
  for (int y = 0; y < dim_y_; ++y) {
    for (int x = 0; x < dim_x_; ++x) {
      auto& element = elements_[y][x];
 
      if (IsCell(x, y)) {
        if (!element) {
          element = emptyElement();
        }
        continue;
      }
 
      element = emptyElement();
    }
  }
}
 
/// @brief Select a row of the table.
/// @param index The index of the row to select.
/// @note You can use negative index to select from the end.
TableSelection Table::SelectRow(int index) {
  return SelectRectangle(0, -1, index, index);
}
 
/// @brief Select a range of rows of the table.
/// @param row_min The first row to select.
/// @param row_max The last row to select.
/// @note You can use negative index to select from the end.
TableSelection Table::SelectRows(int row_min, int row_max) {
  return SelectRectangle(0, -1, row_min, row_max);
}
 
/// @brief Select a column of the table.
/// @param index The index of the column to select.
/// @note You can use negative index to select from the end.
TableSelection Table::SelectColumn(int index) {
  return SelectRectangle(index, index, 0, -1);
}
 
/// @brief Select a range of columns of the table.
/// @param column_min The first column to select.
/// @param column_max The last column to select.
/// @note You can use negative index to select from the end.
TableSelection Table::SelectColumns(int column_min, int column_max) {
  return SelectRectangle(column_min, column_max, 0, -1);
}
 
/// @brief Select a cell of the table.
/// @param column The column of the cell to select.
/// @param row The row of the cell to select.
/// @note You can use negative index to select from the end.
TableSelection Table::SelectCell(int column, int row) {
  return SelectRectangle(column, column, row, row);
}
 
/// @brief Select a rectangle of the table.
/// @param column_min The first column to select.
/// @param column_max The last column to select.
/// @param row_min The first row to select.
/// @param row_max The last row to select.
/// @note You can use negative index to select from the end.
TableSelection Table::SelectRectangle(int column_min,
                                      int column_max,
                                      int row_min,
                                      int row_max) {
  TableSelection output;  // NOLINT
  output.table_ = this;
 
  column_min = Wrap(column_min, input_dim_x_);
  column_max = Wrap(column_max, input_dim_x_);
  row_min = Wrap(row_min, input_dim_y_);
  row_max = Wrap(row_max, input_dim_y_);
 
  // Out of range indices select nothing.
  if (!InRange(column_min, input_dim_x_) ||
      !InRange(column_max, input_dim_x_) || !InRange(row_min, input_dim_y_) ||
      !InRange(row_max, input_dim_y_)) {
    output.x_min_ = 0;
    output.x_max_ = -1;
    output.y_min_ = 0;
    output.y_max_ = -1;
    return output;
  }
 
  Order(column_min, column_max);
  Order(row_min, row_max);
 
  output.x_min_ = 2 * column_min;
  output.x_max_ = 2 * column_max + 2;
  output.y_min_ = 2 * row_min;
  output.y_max_ = 2 * row_max + 2;
  return output;
}
 
/// @brief Select all the table.
TableSelection Table::SelectAll() {
  TableSelection output;  // NOLINT
  output.table_ = this;
  output.x_min_ = 0;
  output.x_max_ = dim_x_ - 1;
  output.y_min_ = 0;
  output.y_max_ = dim_y_ - 1;
  return output;
}
 
/// @brief Render the table.
/// @return The rendered table. This is an element you can draw.
Element Table::Render() {
  for (int y = 0; y < dim_y_; ++y) {
    for (int x = 0; x < dim_x_; ++x) {
      auto& it = elements_[y][x];
 
      // Line
      if ((x + y) % 2 == 1) {
        it = std::move(it) | flex;
        continue;
      }
 
      // Cells
      if ((x % 2) == 1 && (y % 2) == 1) {
        it = std::move(it) | flex_shrink;
        continue;
      }
 
      // Corners
      it = std::move(it) | size(WIDTH, EQUAL, 0) | size(HEIGHT, EQUAL, 0);
    }
  }
  dim_x_ = 0;
  dim_y_ = 0;
  return gridbox(std::move(elements_));
}
 
/// @brief Apply the `decorator` to the selection.
/// This decorate both the cells, the lines and the corners.
/// @param decorator The decorator to apply.
// NOLINTNEXTLINE
void TableSelection::Decorate(const Decorator& decorator) {
  for (int y = y_min_; y <= y_max_; ++y) {
    for (int x = x_min_; x <= x_max_; ++x) {
      Element& e = table_->elements_[y][x];
      e = std::move(e) | decorator;
    }
  }
}
 
/// @brief Apply the `decorator` to the selection.
/// @param decorator The decorator to apply.
/// This decorate only the cells.
// NOLINTNEXTLINE
void TableSelection::DecorateCells(const Decorator& decorator) {
  for (int y = y_min_; y <= y_max_; ++y) {
    for (int x = x_min_; x <= x_max_; ++x) {
      if (y % 2 == 1 && x % 2 == 1) {
        Element& e = table_->elements_[y][x];
        e = std::move(e) | decorator;
      }
    }
  }
}
 
/// @brief Apply the `decorator` to the selection.
/// This decorate only the lines modulo `modulo` with a shift of `shift`.
/// @param decorator The decorator to apply.
/// @param modulo The modulo of the lines to decorate.
/// @param shift The shift of the lines to decorate.
// NOLINTNEXTLINE
void TableSelection::DecorateAlternateColumn(const Decorator& decorator,
                                             int modulo,
                                             int shift) {
  for (int y = y_min_; y <= y_max_; ++y) {
    for (int x = x_min_; x <= x_max_; ++x) {
      if (y % 2 == 1 && (x / 2) % modulo == shift) {
        Element& e = table_->elements_[y][x];
        e = std::move(e) | decorator;
      }
    }
  }
}
 
/// @brief Apply the `decorator` to the selection.
/// This decorate only the lines modulo `modulo` with a shift of `shift`.
/// @param decorator The decorator to apply.
/// @param modulo The modulo of the lines to decorate.
/// @param shift The shift of the lines to decorate.
// NOLINTNEXTLINE
void TableSelection::DecorateAlternateRow(const Decorator& decorator,
                                          int modulo,
                                          int shift) {
  for (int y = y_min_ + 1; y <= y_max_ - 1; ++y) {
    for (int x = x_min_; x <= x_max_; ++x) {
      if (y % 2 == 1 && (y / 2) % modulo == shift) {
        Element& e = table_->elements_[y][x];
        e = std::move(e) | decorator;
      }
    }
  }
}
 
/// @brief Apply the `decorator` to the selection.
/// This decorate only the corners modulo `modulo` with a shift of `shift`.
/// @param decorator The decorator to apply.
/// @param modulo The modulo of the corners to decorate.
/// @param shift The shift of the corners to decorate.
// NOLINTNEXTLINE
void TableSelection::DecorateCellsAlternateColumn(const Decorator& decorator,
                                                  int modulo,
                                                  int shift) {
  for (int y = y_min_; y <= y_max_; ++y) {
    for (int x = x_min_; x <= x_max_; ++x) {
      if (y % 2 == 1 && x % 2 == 1 && ((x / 2) % modulo == shift)) {
        Element& e = table_->elements_[y][x];
        e = std::move(e) | decorator;
      }
    }
  }
}
 
/// @brief Apply the `decorator` to the selection.
/// This decorate only the corners modulo `modulo` with a shift of `shift`.
/// @param decorator The decorator to apply.
/// @param modulo The modulo of the corners to decorate.
/// @param shift The shift of the corners to decorate.
// NOLINTNEXTLINE
void TableSelection::DecorateCellsAlternateRow(const Decorator& decorator,
                                               int modulo,
                                               int shift) {
  for (int y = y_min_; y <= y_max_; ++y) {
    for (int x = x_min_; x <= x_max_; ++x) {
      if (y % 2 == 1 && x % 2 == 1 && ((y / 2) % modulo == shift)) {
        Element& e = table_->elements_[y][x];
        e = std::move(e) | decorator;
      }
    }
  }
}
 
/// @brief Apply the `decorator` to the border of the selection.
/// @param decorator The decorator to apply.
void TableSelection::DecorateBorder(const Decorator& decorator) {
  for (int x = x_min_; x <= x_max_; ++x) {
    table_->elements_[y_min_][x] =
        std::move(table_->elements_[y_min_][x]) | decorator;
    table_->elements_[y_max_][x] =
        std::move(table_->elements_[y_max_][x]) | decorator;
  }
  for (int y = y_min_ + 1; y <= y_max_ - 1; ++y) {
    table_->elements_[y][x_min_] =
        std::move(table_->elements_[y][x_min_]) | decorator;
    table_->elements_[y][x_max_] =
        std::move(table_->elements_[y][x_max_]) | decorator;
  }
}
 
/// @brief Apply the `decorator` to the left border of the selection.
/// @param decorator The decorator to apply.
void TableSelection::DecorateBorderLeft(const Decorator& decorator) {
  for (int y = y_min_; y <= y_max_; y++) {
    table_->elements_[y][x_min_] =
        std::move(table_->elements_[y][x_min_]) | decorator;
  }
}
 
/// @brief Apply the `decorator` to the right border of the selection.
/// @param decorator The decorator to apply.
void TableSelection::DecorateBorderRight(const Decorator& decorator) {
  for (int y = y_min_; y <= y_max_; y++) {
    table_->elements_[y][x_max_] =
        std::move(table_->elements_[y][x_max_]) | decorator;
  }
}
 
/// @brief Apply the `decorator` to the top border of the selection.
/// @param decorator The decorator to apply.
void TableSelection::DecorateBorderTop(const Decorator& decorator) {
  for (int x = x_min_; x <= x_max_; x++) {
    table_->elements_[y_min_][x] =
        std::move(table_->elements_[y_min_][x]) | decorator;
  }
}
 
/// @brief Apply the `decorator` to the bottom border of the selection.
/// @param decorator The decorator to apply.
void TableSelection::DecorateBorderBottom(const Decorator& decorator) {
  for (int x = x_min_; x <= x_max_; x++) {
    table_->elements_[y_max_][x] =
        std::move(table_->elements_[y_max_][x]) | decorator;
  }
}
 
/// @brief Apply the `decorator` to the separators of the selection.
/// @param decorator The decorator to apply.
void TableSelection::DecorateSeparator(const Decorator& decorator) {
  for (int y = y_min_ + 1; y <= y_max_ - 1; ++y) {
    for (int x = x_min_ + 1; x <= x_max_ - 1; ++x) {
      if (y % 2 == 0 || x % 2 == 0) {
        table_->elements_[y][x] =
            std::move(table_->elements_[y][x]) | decorator;
      }
    }
  }
}
 
/// @brief Apply the `decorator` to the vertical separators of the selection.
/// @param decorator The decorator to apply.
void TableSelection::DecorateSeparatorVertical(const Decorator& decorator) {
  for (int y = y_min_ + 1; y <= y_max_ - 1; ++y) {
    for (int x = x_min_ + 1; x <= x_max_ - 1; ++x) {
      if (x % 2 == 0) {
        table_->elements_[y][x] =
            std::move(table_->elements_[y][x]) | decorator;
      }
    }
  }
}
 
/// @brief Apply the `decorator` to the horizontal separators of the selection.
/// @param decorator The decorator to apply.
void TableSelection::DecorateSeparatorHorizontal(const Decorator& decorator) {
  for (int y = y_min_ + 1; y <= y_max_ - 1; ++y) {
    for (int x = x_min_ + 1; x <= x_max_ - 1; ++x) {
      if (y % 2 == 0) {
        table_->elements_[y][x] =
            std::move(table_->elements_[y][x]) | decorator;
      }
    }
  }
}
 
/// @brief Apply a `border` around the selection.
/// @param border The border style to apply.
void TableSelection::Border(BorderStyle border) {
  if (x_min_ > x_max_ || y_min_ > y_max_) {
    return;
  }
 
  BorderLeft(border);
  BorderRight(border);
  BorderTop(border);
  BorderBottom(border);
 
  // NOLINTNEXTLINE
  table_->elements_[y_min_][x_min_] =
      text(table_charset[border][0]) | automerge;
  // NOLINTNEXTLINE
  table_->elements_[y_min_][x_max_] =
      text(table_charset[border][1]) | automerge;
  // NOLINTNEXTLINE
  table_->elements_[y_max_][x_min_] =
      text(table_charset[border][2]) | automerge;
  // NOLINTNEXTLINE
  table_->elements_[y_max_][x_max_] =
      text(table_charset[border][3]) | automerge;
}
 
/// @brief Apply a `border` around the selection.
/// @param border The border style to apply.
/// @param decorator The decorator to apply.
void TableSelection::Border(BorderStyle border, const Decorator& decorator) {
  Border(border);
  DecorateBorder(decorator);
}
 
/// @brief Draw some separator lines in the selection.
/// @param border The border style to apply.
void TableSelection::Separator(BorderStyle border) {
  for (int y = y_min_ + 1; y <= y_max_ - 1; ++y) {
    for (int x = x_min_ + 1; x <= x_max_ - 1; ++x) {
      if (y % 2 == 0 || x % 2 == 0) {
        Element& e = table_->elements_[y][x];
        e = (y % 2 == 1) ? separatorCharacter(table_charset[border][5]) |
                               automerge  // NOLINT
                         : separatorCharacter(table_charset[border][4]) |
                               automerge;  // NOLINT
      }
    }
  }
}
 
/// @brief Draw some separator lines in the selection.
/// @param border The border style to apply.
/// @param decorator The decorator to apply.
void TableSelection::Separator(BorderStyle border, const Decorator& decorator) {
  Separator(border);
  DecorateSeparator(decorator);
}
 
/// @brief Draw some vertical separator lines in the selection.
/// @param border The border style to apply.
void TableSelection::SeparatorVertical(BorderStyle border) {
  for (int y = y_min_ + 1; y <= y_max_ - 1; ++y) {
    for (int x = x_min_ + 1; x <= x_max_ - 1; ++x) {
      if (x % 2 == 0) {
        table_->elements_[y][x] =
            separatorCharacter(table_charset[border][5]) | automerge;  // NOLINT
      }
    }
  }
}
 
/// @brief Draw some vertical separator lines in the selection.
/// @param border The border style to apply.
/// @param decorator The decorator to apply.
void TableSelection::SeparatorVertical(BorderStyle border,
                                       const Decorator& decorator) {
  SeparatorVertical(border);
  DecorateSeparatorVertical(decorator);
}
 
/// @brief Draw some horizontal separator lines in the selection.
/// @param border The border style to apply.
void TableSelection::SeparatorHorizontal(BorderStyle border) {
  for (int y = y_min_ + 1; y <= y_max_ - 1; ++y) {
    for (int x = x_min_ + 1; x <= x_max_ - 1; ++x) {
      if (y % 2 == 0) {
        table_->elements_[y][x] =
            separatorCharacter(table_charset[border][4]) | automerge;  // NOLINT
      }
    }
  }
}
 
/// @brief Draw some horizontal separator lines in the selection.
/// @param border The border style to apply.
/// @param decorator The decorator to apply.
void TableSelection::SeparatorHorizontal(BorderStyle border,
                                         const Decorator& decorator) {
  SeparatorHorizontal(border);
  DecorateSeparatorHorizontal(decorator);
}
 
/// @brief Draw some separator lines to the left side of the selection.
/// @param border The border style to apply.
void TableSelection::BorderLeft(BorderStyle border) {
  for (int y = y_min_; y <= y_max_; y++) {
    table_->elements_[y][x_min_] =
        separatorCharacter(table_charset[border][5]) | automerge;  // NOLINT
  }
}
 
/// @brief Draw some separator lines to the left side of the selection.
/// @param border The border style to apply.
/// @param decorator The decorator to apply.
void TableSelection::BorderLeft(BorderStyle border,
                                const Decorator& decorator) {
  BorderLeft(border);
  DecorateBorderLeft(decorator);
}
 
/// @brief Draw some separator lines to the right side of the selection.
/// @param border The border style to apply.
void TableSelection::BorderRight(BorderStyle border) {
  for (int y = y_min_; y <= y_max_; y++) {
    table_->elements_[y][x_max_] =
        separatorCharacter(table_charset[border][5]) | automerge;  // NOLINT
  }
}
 
/// @brief Draw some separator lines to the right side of the selection.
/// @param border The border style to apply.
/// @param decorator The decorator to apply.
void TableSelection::BorderRight(BorderStyle border,
                                 const Decorator& decorator) {
  BorderRight(border);
  DecorateBorderRight(decorator);
}
 
/// @brief Draw some separator lines to the top side of the selection.
/// @param border The border style to apply.
void TableSelection::BorderTop(BorderStyle border) {
  for (int x = x_min_; x <= x_max_; x++) {
    table_->elements_[y_min_][x] =
        separatorCharacter(table_charset[border][4]) | automerge;  // NOLINT
  }
}
 
/// @brief Draw some separator lines to the top side of the selection.
/// @param border The border style to apply.
/// @param decorator The decorator to apply.
void TableSelection::BorderTop(BorderStyle border, const Decorator& decorator) {
  BorderTop(border);
  DecorateBorderTop(decorator);
}
 
/// @brief Draw some separator lines to the bottom side of the selection.
/// @param border The border style to apply.
void TableSelection::BorderBottom(BorderStyle border) {
  for (int x = x_min_; x <= x_max_; x++) {
    table_->elements_[y_max_][x] =
        separatorCharacter(table_charset[border][4]) | automerge;  // NOLINT
  }
}
 
/// @brief Draw some separator lines to the bottom side of the selection.
/// @param border The border style to apply.
/// @param decorator The decorator to apply.
void TableSelection::BorderBottom(BorderStyle border,
                                  const Decorator& decorator) {
  BorderBottom(border);
  DecorateBorderBottom(decorator);
}
 
}  // namespace ftxui