TableFormatter.hpp

Go to the documentation of this file.

/*
 * ------------------------------------------------------------------------------------------------------------
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (c) 2016-2024 Lawrence Livermore National Security LLC
 * Copyright (c) 2018-2024 TotalEnergies
 * Copyright (c) 2018-2024 The Board of Trustees of the Leland Stanford Junior University
 * Copyright (c) 2023-2024 Chevron
 * Copyright (c) 2019-     GEOS/GEOSX Contributors
 * All rights reserved
 *
 * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
 * ------------------------------------------------------------------------------------------------------------
 */
 
#ifndef GEOS_COMMON_FORMAT_TABLE_TABLEFORMATTER_HPP
#define GEOS_COMMON_FORMAT_TABLE_TABLEFORMATTER_HPP
 
#include "TableData.hpp"
#include "TableLayout.hpp"
 
namespace geos
{
 
class TableFormatter
{
 
protected:
 
  TableLayout m_tableLayout;
 
  TableFormatter() = default;
 
  TableFormatter( TableLayout const & tableLayout );
 
  virtual ~TableFormatter() = default;
};
 
class TableCSVFormatter : public TableFormatter
{
public:
 
  TableCSVFormatter():
    TableFormatter( TableLayout() )
  {}
 
  TableCSVFormatter( TableLayout const & tableLayout );
 
  virtual ~TableCSVFormatter() = default;
 
  string headerToString() const;
 
  string dataToString( TableData const & tableData ) const;
 
  template< typename DATASOURCE >
  string toString( DATASOURCE const & tableData ) const;
 
};
 
template<>
string TableCSVFormatter::toString< TableData >( TableData const & tableData ) const;
 
 
class TableTextFormatter : public TableFormatter
{
public:
 
 
  TableTextFormatter():
    TableFormatter( TableLayout() )
  {}
 
  TableTextFormatter( TableLayout const & tableLayout );
 
 
  virtual ~TableTextFormatter() = default;
 
  string layoutToString() const;
 
  template< typename DATASOURCE >
  string toString( DATASOURCE const & tableData ) const;
 
private:
 
  static constexpr char m_verticalLine = '|';
  static constexpr char m_horizontalLine = '-';
 
  void fillTableColumnsFromRows( std::vector< TableLayout::Column > & columns,
                                 std::vector< std::vector< string > > & tableData ) const;
 
  void outputLayout( std::ostringstream & tableOutput,
                     std::vector< TableLayout::Column > & columns,
                     std::vector< string > const & msgTableError,
                     string & sectionSeparatingLine ) const;
 
  void splitAndSetColumnNames( std::vector< TableLayout::Column > & columns,
                               size_t & largestHeaderVectorSize,
                               std::vector< std::vector< string > > & splitHeaders ) const;
 
  void findAndSetMaxStringSize( std::vector< TableLayout::Column > & columns ) const;
 
  void increaseColumnsSize( std::vector< TableLayout::Column > & columns,
                            integer const extraCharacters ) const;
 
  void computeTableWidth( std::vector< TableLayout::Column > & columns,
                          std::vector< string > const & msgTableError ) const;
 
  void buildTableSeparators( std::vector< TableLayout::Column > const & columns,
                             string & topSeparator,
                             string & sectionSeparatingLine ) const;
 
  void outputTopRows( std::ostringstream & tableOutput,
                      std::vector< string > const & msg,
                      string_view topSeparator,
                      TableLayout::Alignment alignment ) const;
 
  void outputSectionRows( std::vector< TableLayout::Column > const & columns,
                          string_view sectionSeparatingLine,
                          std::ostringstream & rows,
                          integer const nbRows,
                          TableLayout::Section const section ) const;
};
 
template<>
string TableTextFormatter::toString< TableData >( TableData const & tableData ) const;
}
 
#endif /* GEOS_COMMON_FORMAT_TABLE_TABLEFORMATTER_HPP */