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"
#include "TableTypes.hpp"
 
namespace geos
{
 
class TableFormatter
{
 
public:
 
  using RowsCellInput = stdVector< stdVector< TableData::CellData > >;
 
  struct CellLayoutRow
  {
    stdVector< TableLayout::CellLayout > cells;
 
    size_t sublinesCount;
  };
 
  using CellLayoutRows = stdVector< CellLayoutRow >;
 
  TableErrorListing & getErrorsList() const
  { return *m_errors; }
 
protected:
 
  PreparedTableLayout const m_tableLayout;
  std::unique_ptr< geos::TableErrorListing > m_errors = std::make_unique< geos::TableErrorListing >();
 
  TableFormatter();
 
  TableFormatter( TableLayout const & tableLayout );
 
  void toStreamImpl( std::ostream & outputStream, string_view content ) const;
};
 
class TableCSVFormatter final : public TableFormatter
{
public:
 
  static constexpr string_view m_separator = ",";
 
  TableCSVFormatter():
    TableFormatter()
  {}
 
  TableCSVFormatter( TableLayout const & tableLayout );
 
  ~TableCSVFormatter();
 
  string headerToString() const;
 
  string dataToString( TableData const & tableData ) const;
 
  template< typename DATASOURCE >
  string toString( DATASOURCE const & tableData ) const;
 
  void headerToStream( std::ostream & outputStream ) const
  { toStreamImpl( outputStream, headerToString() ); }
 
  void dataToStream( std::ostream & outputStream, TableData const & tableData ) const
  { toStreamImpl( outputStream, dataToString( tableData ) ); }
 
  template< typename DATASOURCE >
  void toStream( std::ostream & outputStream, DATASOURCE const & tableData ) const
  { toStreamImpl( outputStream, toString( tableData ) ); }
 
  void showErrors( bool cond )
  { m_showErrors = cond; }
 
private:
  bool m_showErrors = true;
 
};
 
template<>
string TableCSVFormatter::toString< TableData >( TableData const & tableData ) const;
 
 
class TableTextFormatter : public TableFormatter
{
public:
 
  TableTextFormatter():
    TableFormatter()
  {}
 
  TableTextFormatter( TableLayout const & tableLayout );
 
  string toString() const;
 
  template< typename DATASOURCE >
  string toString( DATASOURCE const & tableData ) const;
 
  void toStream( std::ostream & outputStream ) const
  { toStreamImpl( outputStream, toString() ); }
 
  template< typename DATASOURCE >
  void toStream( std::ostream & outputStream, DATASOURCE const & tableData ) const
  { toStreamImpl( outputStream, toString( tableData ) ); }
 
protected:
 
  static constexpr char m_verticalLine = '|';
  static constexpr char m_horizontalLine = '-';
 
  using ColumnWidthModifier = std::function< void ( stdVector< size_t > & ) >;
 
  void initalizeTableGrids( PreparedTableLayout const & tableLayout,
                            TableData const & tableData,
                            CellLayoutRows & dataCellsLayout,
                            CellLayoutRows & headerCellsLayout,
                            CellLayoutRows & errorCellsLayout,
                            size_t & tableTotalWidth,
                            ColumnWidthModifier columnWidthModifier ) const;
 
  void outputTableHeader( std::ostream & tableOutput,
                          PreparedTableLayout const & tableLayout,
                          CellLayoutRows const & headerCellsLayout,
                          string_view separatorLine ) const;
 
  void outputTableData( std::ostream & tableOutput,
                        PreparedTableLayout const & tableLayout,
                        CellLayoutRows const & dataCellsLayout ) const;
 
  void outputTableFooter( std::ostream & tableOutput,
                          PreparedTableLayout const & tableLayout,
                          CellLayoutRows & errorCellsLayout,
                          string_view separatorLine,
                          bool hasData ) const;
 
private:
 
  void outputLines( PreparedTableLayout const & tableLayout,
                    CellLayoutRows const & cellsLayout,
                    std::ostream & tableOutput ) const;
 
  void outputErrors( PreparedTableLayout const & tableLayout,
                     CellLayoutRows & errorCellsLayout,
                     std::ostream & tableOutput ) const;
 
  void populateTitleCellsLayout( PreparedTableLayout const & tableLayout,
                                 CellLayoutRows & headerCellsLayout,
                                 size_t nbVisibleColumn ) const;
 
  void populateHeaderCellsLayout( PreparedTableLayout const & tableLayout,
                                  CellLayoutRows & headerCellsLayout,
                                  size_t nbVisibleColumn ) const;
  void populateDataCellsLayout( PreparedTableLayout const & tableLayout,
                                CellLayoutRows & dataCellsLayout,
                                RowsCellInput const & inputDataValues,
                                size_t const nbVisibleColumn ) const;
 
  void populateErrorCellsLayout( PreparedTableLayout const & tableLayout,
                                 CellLayoutRows & errorCellsLayout,
                                 TableErrorListing const & dataErrors ) const;
 
  void populateDataCellsLayout( PreparedTableLayout const & tableLayout,
                                CellLayoutRows & dataCellsLayout,
                                RowsCellInput const & inputDataValues ) const;
 
  void stretchColumnsByCellsWidth( stdVector< size_t > & columnsWidth,
                                   TableFormatter::CellLayoutRows const & tableGrid ) const;
 
  void stretchColumnsByMergedCellsWidth( stdVector< size_t > & columnsWidth,
                                         TableFormatter::CellLayoutRows & tableGrid,
                                         PreparedTableLayout const & tableLayout,
                                         bool const compress ) const;
 
  void applyColumnsWidth( stdVector< size_t > const & columnsWidth,
                          TableFormatter::CellLayoutRows & tableGrid,
                          PreparedTableLayout const & tableLayout ) const;
 
 
  void formatCell( std::ostream & tableOutput,
                   TableLayout::CellLayout const & cell,
                   size_t idxLine ) const;
 
};
 
template<>
string TableTextFormatter::toString< TableData >( TableData const & tableData ) const;
}
 
#endif /* GEOS_COMMON_FORMAT_TABLE_TABLEFORMATTER_HPP */