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 = std::vector< std::vector< TableData::CellData > >;
  using CellLayoutRows = std::vector< std::vector< TableLayout::CellLayout > >;
 
 
protected:
 
  TableLayout m_tableLayout;
 
  TableFormatter() = default;
 
  TableFormatter( TableLayout const & tableLayout );
};
 
class TableCSVFormatter : public TableFormatter
{
public:
 
  TableCSVFormatter():
    TableFormatter( TableLayout() )
  {}
 
  TableCSVFormatter( TableLayout const & tableLayout );
 
  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 );
 
  string toString() const;
 
  template< typename DATASOURCE >
  string toString( DATASOURCE const & tableData ) const;
 
private:
 
  static constexpr char m_verticalLine = '|';
  static constexpr char m_horizontalLine = '-';
 
 
  void initalizeTableLayout( TableLayout & tableLayout,
                             TableData const & tableData,
                             CellLayoutRows & cellsDataLayout,
                             CellLayoutRows & cellsHeaderLayout,
                             string & separatorLine,
                             size_t & nbEnabledColumn ) const;
  void outputTable( TableLayout & tableLayout,
                    std::ostringstream & tableOutput,
                    CellLayoutRows const & cellsHeader,
                    CellLayoutRows const & cellsData,
                    string_view separatorLine,
                    size_t & nbEnabledColumn ) const;
 
  void setLinks( std::vector< TableLayout::Column > & columns ) const;
 
  void populateHeaderCellsLayout( TableLayout & tableLayout,
                                  CellLayoutRows & cellsDataLayout ) const;
 
  void populateDataCellsLayout( TableLayout & tableLayout,
                                CellLayoutRows & cellsDataLayout,
                                RowsCellInput & inputDataValues ) const;
 
  void updateColumnMaxLength( TableLayout & tableLayout,
                              CellLayoutRows & cellHeaderLength,
                              CellLayoutRows & cellsDataLayout ) const;
 
  void adjustTableWidth( TableLayout & tableLayout,
                         CellLayoutRows & cellsHeaderLayout,
                         CellLayoutRows & cellsDataLayout,
                         string & separatorLine,
                         size_t & nbEnabledColumn ) const;
 
  void adjustColumnWidth( CellLayoutRows & cells,
                          size_t nbHiddenColumns,
                          size_t const paddingCharacters ) const;
 
  void outputTitleRow( TableLayout & tableLayout,
                       std::ostringstream & tableOutput,
                       string_view separatorLine ) const;
 
  void formatCell( TableLayout & tableLayout,
                   std::ostringstream & tableOutput,
                   TableLayout::CellLayout const & cell,
                   size_t idxLine ) const;
 
  void outputLines( TableLayout & tableLayout,
                    CellLayoutRows const & cellsLayout,
                    std::ostringstream & tableOutput,
                    std::vector< size_t > const & nbLinesRow,
                    CellType sectionType,
                    string_view separatorLine,
                    size_t & nbEnabledColumn ) const;
};
 
template<>
string TableTextFormatter::toString< TableData >( TableData const & tableData ) const;
}
 
#endif /* GEOS_COMMON_FORMAT_TABLE_TABLEFORMATTER_HPP */