utils/text/table.hpp

Go to the documentation of this file.

#ifndef GENESIS_UTILS_TEXT_TABLE_H_
#define GENESIS_UTILS_TEXT_TABLE_H_

/*
    Genesis - A toolkit for working with phylogenetic data.
    Copyright (C) 2014-2019 Lucas Czech and HITS gGmbH

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.

    Contact:
    Lucas Czech <lucas.czech@h-its.org>
    Exelixis Lab, Heidelberg Institute for Theoretical Studies
    Schloss-Wolfsbrunnenweg 35, D-69118 Heidelberg, Germany
*/

#include "genesis/utils/text/style.hpp"

#include <iosfwd>
#include <string>
#include <utility>
#include <vector>

namespace genesis {
namespace utils {

// =================================================================================================
//     Forward Declarations
// =================================================================================================

struct TableLayout;
class Table;

std::ostream& operator << (std::ostream& out, Table const& table);

// =================================================================================================
//     Text Table
// =================================================================================================

class Table
{
    // ---------------------------------------------------------------------
    //     Member Types
    // ---------------------------------------------------------------------

public:

    class Column;

    // ---------------------------------------------------------------------
    //     Constructor and Rule of Five
    // ---------------------------------------------------------------------

public:

    Table() = default;
    ~Table() = default;

    Table( Table const& ) = default;
    Table( Table&& )      = default;

    Table& operator= ( Table const& ) = default;
    Table& operator= ( Table&& )      = default;

    // void swap( Table& other )
    // {
    //     using std::swap;
    // }

    // ---------------------------------------------------------------------
    //     Accessors
    // ---------------------------------------------------------------------

    size_t length() const;

    // ---------------------------------------------------------------------
    //     Modifiers
    // ---------------------------------------------------------------------

    void clear();
    void clear_content();

    Column& add_column( std::string label = "" );

    Table& operator << ( std::string value );
    // Table& operator << ( Style const& value );

    Table& append ( std::string value );
    Table& append ( Style const& style, std::string value );

    Table& line_break();

    // ---------------------------------------------------------------------
    //     Output
    // ---------------------------------------------------------------------

    void write( std::ostream& out ) const;
    void write( std::ostream& out, TableLayout const& layout ) const;

    std::string to_string() const;
    std::string to_string( TableLayout const& layout ) const;

    friend std::ostream& operator << (std::ostream& out, Table const& table);

    // ---------------------------------------------------------------------
    //     Data members
    // ---------------------------------------------------------------------

private:

    size_t current_col_ = 0;
    std::vector<Column> columns_;

};

// =================================================================================================
//     Table Column
// =================================================================================================

class Table::Column
{
    // ---------------------------------------------------------------------
    //     Member Types
    // ---------------------------------------------------------------------

public:

    enum class Justification
    {
        kLeft,
        kRight,
        kCentered
    };

    // ---------------------------------------------------------------------
    //     Constructor and Rule of Five
    // ---------------------------------------------------------------------

public:

    Column() = default;

    explicit Column( std::string const& label, Justification justify = Justification::kLeft )
        : label_( label )
        , just_(  justify )
        , width_( label.size() )
    {}

    ~Column() = default;

    Column( Column const& ) = default;
    Column( Column&& )      = default;

    Column& operator= ( Column const& ) = default;
    Column& operator= ( Column&& )      = default;

    // void swap( Column& other )
    // {
    //     using std::swap;
    // }

    // ---------------------------------------------------------------------
    //     Properties
    // ---------------------------------------------------------------------

    void        label( std::string value );
    std::string label() const;

    void          justify( Justification value );
    Justification justify() const;

    void   width( size_t value );
    size_t width() const;

    void shrink_width();

    // ---------------------------------------------------------------------
    //     Accessors
    // ---------------------------------------------------------------------

    size_t length() const;

    std::string row( size_t i ) const;

    // ---------------------------------------------------------------------
    //     Modifiers
    // ---------------------------------------------------------------------

    void clear_content();

    void append( std::string value );
    void append( Style const& style, std::string value );

    // ---------------------------------------------------------------------
    //     Output
    // ---------------------------------------------------------------------

public:

    void write_row( std::ostream& stream, size_t row ) const;
    void write_label( std::ostream& stream ) const;

private:

    void write( std::ostream& stream, Style style, std::string text ) const;

    // ---------------------------------------------------------------------
    //     Data members
    // ---------------------------------------------------------------------

private:

    std::string   label_ = "";
    Justification just_  = Justification::kLeft;
    size_t        width_ = 0;

    std::vector< std::pair< Style, std::string >> data_;

};

// =================================================================================================
//     TableLayout
// =================================================================================================

struct TableLayout
{
    // ---------------------------------------------------------------------
    //     Member Types
    // ---------------------------------------------------------------------

    struct Line
    {
        bool        enabled      = false;

        std::string left_border  = "";
        std::string filler       = "";
        std::string separator    = " ";
        std::string right_border = "";
    };

    struct Binder
    {
        Binder(TableLayout const& l, Table const& t)
            : layout(l)
            , table(t)
        {}

        TableLayout const& layout;
        Table const& table;

        friend std::ostream& operator << (std::ostream& out, Binder const& binder);
    };

    // ---------------------------------------------------------------------
    //     Operators
    // ---------------------------------------------------------------------

    Binder operator () ( Table const& table );

    // ---------------------------------------------------------------------
    //     Data Members
    // ---------------------------------------------------------------------

    Line top;
    Line header;
    Line separator;
    Line row;
    Line bottom;

};

// ---------------------------------------------------------------------
//     Default Table Layouts
// ---------------------------------------------------------------------

TableLayout minimal_layout();

TableLayout simple_layout(  bool condensed = false );
TableLayout simple_grid(    bool condensed = false );
TableLayout simple_frame(   bool condensed = false );

TableLayout extended_grid(  bool condensed = false );
TableLayout extended_frame( bool condensed = false );

TableLayout double_grid(    bool condensed = false );
TableLayout double_frame(   bool condensed = false );

} // namespace utils
} // namespace genesis

#endif // include guard