LogPart.hpp

Go to the documentation of this file.

/*
 * ------------------------------------------------------------------------------------------------------------
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (c) 2018-2020 Lawrence Livermore National Security LLC
 * Copyright (c) 2018-2020 The Board of Trustees of the Leland Stanford Junior University
 * Copyright (c) 2018-2020 TotalEnergies
 * Copyright (c) 2019-     GEOSX Contributors
 * All rights reserved
 *
 * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
 * ------------------------------------------------------------------------------------------------------------
 */
 
#ifndef GEOS_COMMON_FORMAT_LOGPART_HPP
#define GEOS_COMMON_FORMAT_LOGPART_HPP
 
#include "common/DataTypes.hpp"
#include "common/format/Format.hpp"
#include "common/format/StringUtilities.hpp"
 
namespace geos
{
 
using namespace stringutilities;
class LogPart
{
public:
 
  LogPart( string_view logPartTitle, bool enableOutput );
 
  template< typename ... Args >
  void addDescription( string_view name, Args const & ... args );
 
  void addDescription( string_view description );
 
  template< typename ... Args >
  void addEndDescription( string_view name, Args const & ... args );
 
  void addEndDescription( string_view description );
 
  void setMinWidth( size_t const & minWidth );
 
  void setMaxWidth( size_t const & maxWidth );
 
  void begin( std::ostream & os = std::cout );
 
  void end( std::ostream & oss = std::cout );
 
  void enableOutput( bool enabled )
  { m_enableOutput = enabled; }
 
private:
 
  struct Description
  {
    stdVector< stdVector< string > > m_names;
    stdVector< stdVector< string > > m_values;
  };
 
  struct FormattedDescription
  {
    string m_title;
    stdVector< string > m_lines;
    size_t m_maxNameWidth;
    size_t m_maxValueWidth;
  };
 
  Description m_startDescription = { {}, {} };
  Description m_endDescription  = { {}, {} };
 
  FormattedDescription m_formattedStartDescription = {  "", {}, 0, 0 };
  FormattedDescription m_formattedEndDescription  = { "", {}, 0, 0 };
 
  size_t m_width = 100;
  size_t m_minWidth = 100;
  size_t m_maxWidth = 100;
  static constexpr size_t m_borderMargin = 2;
  static constexpr size_t m_nbBorderChar = 2;
  char const m_borderCharacter = '#';
  static constexpr string_view m_prefixEndTitle = "End of ";
  static constexpr string_view m_delimiter = " : ";
  bool m_enableOutput = true;
 
  template< typename ... Args >
  void addDescriptionBySection( Description & description, FormattedDescription & formattedDescription,
                                string_view name, Args const &... args );
 
  void formatDescriptions( LogPart::Description & description,
                           FormattedDescription & formattedDescription );
 
  string outputTitle( FormattedDescription & formattedDescription );
 
  string outputDescription( FormattedDescription & formattedDescription );
};
 
template< typename ... Args >
void LogPart::addDescriptionBySection( Description & description, FormattedDescription & formattedDescription,
                                       string_view name, Args const &... args )
{
  stdVector< string > values;
  size_t & formattedDescriptionMaxWidth = formattedDescription.m_maxValueWidth;
  size_t & formattedDescriptionNameWidth = formattedDescription.m_maxNameWidth;
  ( [&] {
    static_assert( has_formatter_v< decltype(args) >,
                   "Argument passed cannot be converted to string" );
    string const value = GEOS_FMT( "{}", args );
 
    stdVector< string_view > dividedDescriptionValues =
      divideLines< string_view >( formattedDescriptionMaxWidth, value );
    values.insert( values.end(), dividedDescriptionValues.begin(), dividedDescriptionValues.end() );
  } (), ...);
 
  description.m_values.push_back( values );
 
  size_t nameWidth = 0;
  stdVector< string > nameLines = divideLines< string >( nameWidth, name );
  if( nameWidth == 0 )
    nameWidth = name.size();
  formattedDescriptionNameWidth = std::max( formattedDescriptionNameWidth, nameWidth );
 
  description.m_names.push_back( nameLines );
 
  size_t const totalDecorationWidth = m_nbBorderChar * 2 + m_borderMargin * 2;
  size_t const logPartTotalWidth =  formattedDescriptionNameWidth +
                                   formattedDescriptionMaxWidth +
                                   totalDecorationWidth;
  m_width = std::max( m_width, logPartTotalWidth );
  m_width = std::max( m_width, formattedDescription.m_title.size());
}
 
template< typename ... Args >
void LogPart::addDescription( string_view name, Args const &... args )
{
  addDescriptionBySection( m_startDescription, m_formattedStartDescription, name, args ... );
}
 
template< typename ... Args >
void LogPart::addEndDescription( string_view name, Args const &... args )
{
  addDescriptionBySection( m_endDescription, m_formattedEndDescription, name, args ... );
}
 
}
 
#endif