PrintTable.hpp

/*------------------------------------------------------------------------*/
/*                 Copyright 2010 Sandia Corporation.                     */
/*  Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive   */
/*  license for use of this work by or on behalf of the U.S. Government.  */
/*  Export of this program may require a license from the                 */
/*  United States Government.                                             */
/*------------------------------------------------------------------------*/

#ifndef stk_util_util_PrintTable_hpp
#define stk_util_util_PrintTable_hpp

#include <vector>
#include <string>
#include <sstream>

namespace stk {

class PrintTable
{
  template<typename T>
  friend PrintTable &operator<<(PrintTable &table, const T &t);

public:
  typedef std::string::size_type ColumnWidth;
  typedef std::vector<ColumnWidth> ColumnWidthVector;

  struct Cell
  {
    enum Flags {
      SPAN = 0x01
    };

    enum Justification {
      LEFT    = 1,
      RIGHT   = 2,
      CENTER    = 3,
      JUSTIFY_MASK  = 0x0F,
      TRUNC   = 0x10,
      ENDS    = 0x20
    };

    Cell()
      : m_string(),
  m_flags(0),
  m_justification(RIGHT | TRUNC),
  m_indent(0),
  m_width(0)
    {}

    std::string     m_string;
    int       m_flags;
    int       m_justification;
    ColumnWidth                 m_indent;
    ColumnWidth                 m_width;
  };

  typedef std::vector<Cell> Row;
  typedef std::vector<Row> Table;

  enum Flags {
    AUTO_END_COL                = 0x01,
    COMMA_SEPARATED_VALUES      = 0x02,
    PRINT_TRANSPOSED            = 0x04
  };

  PrintTable()
    : m_flags(AUTO_END_COL),
      m_tableWidth(0)
  {
    m_table.push_back(Row());
  }

  explicit PrintTable(std::ostream &os)
    : m_flags(AUTO_END_COL),
      m_commentPrefix(),
      m_tableWidth(0)
  {
    m_table.push_back(Row());
  }

private:
  PrintTable(const PrintTable &);
  PrintTable &operator=(const PrintTable &);

public:
  ~PrintTable()
  {}
  
  Row::size_type headerSize() const {
    return m_header.empty() ? 0 : m_header.begin()->size();
  }

  Table::size_type size() const {
    return m_table.size();
  }

  bool autoEndCol() const {
    return m_flags & AUTO_END_COL;
  }

  PrintTable &setAutoEndCol(bool auto_end_col = true) {
    if (auto_end_col)
      m_flags |= AUTO_END_COL;
    else
      m_flags &= ~AUTO_END_COL;
    return *this;
  }

  bool commaSeparatedValues() const {
    return m_flags & COMMA_SEPARATED_VALUES;
  }

  PrintTable &setCommaSeparatedValues(bool comma_separated_values = true) {
    if (comma_separated_values)
      m_flags |= COMMA_SEPARATED_VALUES;
    else
      m_flags &= ~COMMA_SEPARATED_VALUES;
    return *this;
  }

  PrintTable &setCommentPrefix(const std::string &comment_prefix) {
    m_commentPrefix = comment_prefix;
    return *this;
  }

  const std::string &getCommentPrefix() const {
    return m_commentPrefix;
  }

  PrintTable &setTitle(const std::string &title){
    m_title = title;
    return *this;
  }

  const std::string &getTitle() const {
    return m_title;
  }

  PrintTable& operator<<(PrintTable& (*f)(PrintTable&)) {
    f(*this);
    return *this;

  }

  PrintTable& operator<<(std::ios_base& (*f)(std::ios_base&)) {
    f(m_currentString);
    return *this;
  }

  PrintTable &push() {
    ++m_currentCell.m_indent;
    return *this;
  }

  PrintTable &span() {
    m_currentCell.m_flags |= Cell::SPAN;
    return *this;
  }

  PrintTable &pop() {
    if (m_currentCell.m_indent != 0)
      --m_currentCell.m_indent;

    return *this;
  }

  PrintTable &cell_width(ColumnWidth width) {
    m_currentCell.m_width = width;

    return *this;
  }

  PrintTable &indent(ColumnWidth indent) {
    m_currentCell.m_indent = indent;

    return *this;
  }

  PrintTable &justify(int justification) {
    m_currentCell.m_justification = justification;

    return *this;
  }

  PrintTable &end_col();

  PrintTable &end_row();

  PrintTable &at(size_t row, size_t col);

  PrintTable &end_header() {
    m_header.push_back(m_table.back());
    m_table.pop_back();
    m_table.push_back(Row());
    return *this;
  }

  PrintTable &end_format() {
    m_format = m_table.back();
    m_table.pop_back();
    m_table.push_back(Row());
    return *this;
  }

  void calculate_column_widths() const;

  void transpose_table() const;

  std::ostream &print(std::ostream &os) const;

  std::ostream &printRow(std::ostream &os, const Row &row) const;

  std::ostream &printHeaderBar(std::ostream &os) const;

  std::ostream &csvPrint(std::ostream &os) const;

private:
  void normalize_table(int row, int col);

private:
  std::string     m_title;
  Table       m_header;
  Row       m_format;
  Table       m_table;
  Cell        m_currentCell;
  std::ostringstream    m_currentString;
  int       m_flags;
  std::string                   m_commentPrefix;
  mutable ColumnWidthVector m_columnWidth;
  mutable ColumnWidth         m_tableWidth;
};


template<typename T>
PrintTable &operator<<(PrintTable &table, const T &t) {
  table.m_currentString << t;
  if (table.autoEndCol())
    table.end_col();

  return table;
}


struct cell_width
{
  cell_width(PrintTable::ColumnWidth width)
    : m_width(width)
  {}

  PrintTable::ColumnWidth m_width;
};


struct at
{
  at(size_t row, size_t col)
    : m_row(row),
      m_col(col)
  {}

  size_t                        m_row;
  size_t                        m_col; 
};


struct indent
{
  indent(PrintTable::ColumnWidth indent)
    : m_indent(indent)
  {}

  PrintTable::ColumnWidth m_indent;
};


struct justify
{
  justify(int justify)
    : m_justify(justify)
  {}

  int   m_justify;
};


inline PrintTable &operator<<(PrintTable &tout, const cell_width &m) {
  tout.cell_width(m.m_width);
  return tout;
}

inline PrintTable &operator<<(PrintTable &tout, const at &m) {
  tout.at(m.m_row, m.m_col);
  return tout;
}

inline PrintTable &operator<<(PrintTable &tout, const indent &m) {
  tout.indent(m.m_indent);
  return tout;
}

inline PrintTable &operator<<(PrintTable &tout, const justify &m) {
  tout.justify(m.m_justify);
  return tout;
}

inline PrintTable &end_col(PrintTable &tout) {
  return tout.end_col();
}

inline PrintTable &end_row(PrintTable &tout) {
  return tout.end_row();
}

inline PrintTable &end_header(PrintTable &tout) {
  return tout.end_header();
}

inline PrintTable &end_format(PrintTable &tout) {
  return tout.end_format();
}

inline PrintTable &push(PrintTable &tout) {
  return tout.push();
}

inline PrintTable &pop(PrintTable &tout) {
  return tout.pop();
}

inline PrintTable &span(PrintTable &tout) {
  return tout.span();
}

inline std::ostream &operator<<(std::ostream &os, const PrintTable &table){
  return table.print(os);
}

} // namespace sierra

#endif // stk_util_util_PrintTable_hpp