section_contents.h

// -*-c++-*-
#ifndef STORMM_SECTION_CONTENTS_H
#define STORMM_SECTION_CONTENTS_H
 
#include <fstream>
#include <iostream>
#include <string>
#include <vector>
#include "copyright.h"
#include "FileManagement/file_enumerators.h"
#include "ordered_list.h"
#include "reporting_enumerators.h"
#include "report_table.h"
#include "summary_file.h"
 
namespace stormm {
namespace review {
 
using diskutil::PrintSituation;

class SectionContents {
public:
  
  SectionContents(const std::string &title_in, const std::string &file_name_in, int width_in,
                  bool subsection_in, int section_id_in, int subsection_id_in,
                  ListEnumeration section_marking_in, ListEnumeration subsection_marking_in,
                  OutputSyntax style_in, double table_precision_in);
 
  SectionContents(const std::string &title_in = std::string(""),
                  const std::string &file_name_in = std::string(""),
                  int width_in = default_output_file_width,
                  OutputSyntax style_in = OutputSyntax::STANDALONE,
                  double table_precision_in = 1.0e-6);

  SectionContents(const SectionContents &original) = default;
  SectionContents(SectionContents &&original) = default;
  SectionContents& operator=(const SectionContents &original) = default;
  SectionContents& operator=(SectionContents &&original) = default;

  const std::string& getOutputFileName();

  int getWidth() const;

  OutputSyntax getSyntax() const;

  int getComponentCount() const;
  int getComponentCount(SectionComponent kind) const;

  SectionComponent getComponentType(int index) const;
  
  bool isSubsection() const;
  
  std::string sectionAsString(OutputSyntax alt_style, int alt_width = -1, int alt_section_id = -1,
                              int alt_subsection_id = -1, int list_indent = -1,
                              int nested_list_indent = -1,
                              ListEnumeration list_marking = ListEnumeration::NONE,
                              ListEnumeration nested_list_marking = ListEnumeration::NONE) const;
 
  std::string sectionAsString(int alt_section_id, int alt_subsection_id,
                              int list_indent, int nested_list_indent,
                              ListEnumeration list_numbering = ListEnumeration::NONE,
                              ListEnumeration nested_list_numbering = ListEnumeration::NONE) const;
 
  std::string sectionAsString(int list_indent = -1, int nested_list_indent = -1,
                              ListEnumeration list_numbering = ListEnumeration::NONE,
                              ListEnumeration nested_list_numbering = ListEnumeration::NONE) const;

  void printSection(std::ofstream *foutp, int list_indent = -1, int nested_list_indent = -1,
                    ListEnumeration list_numbering = ListEnumeration::NONE,
                    ListEnumeration nested_list_numbering = ListEnumeration::NONE) const;
  
  void printSection(std::ostream *foutp, int list_indent = -1, int nested_list_indent = -1,
                    ListEnumeration list_numbering = ListEnumeration::NONE,
                    ListEnumeration nested_list_numbering = ListEnumeration::NONE) const;
 
  void printSection(const std::string &alt_file_name,
                    PrintSituation alt_expectation = PrintSituation::APPEND,
                    int list_indent = -1, int nested_list_indent = -1,
                    ListEnumeration list_numbering = ListEnumeration::NONE,
                    ListEnumeration nested_list_numbering = ListEnumeration::NONE) const;
 
  void printSection(int list_indent = -1, int nested_list_indent = -1,
                    ListEnumeration list_numbering = ListEnumeration::NONE,
                    ListEnumeration nested_list_numbering = ListEnumeration::NONE) const;

  void setTitle(const std::string &title_in);
  
  void designateSubsection(bool subsection_in = true);

  void setSectionDetails(int section_id_in);
  void setSectionDetails(ListEnumeration section_marking_in);
  void setSectionDetails(int section_id_in, ListEnumeration section_marking_in);
  
  void reserve(SectionComponent item_kind, int item_count);
  
  void addNarration(const std::string &narration_in);
  void addNarration(const TextFile &narration_in, TextEnds line_endings = TextEnds::AS_IS);

  void addList(const OrderedList &list_in);

  void addTable(const ReportTable &table_in);

  void addScript(const std::string &script_in);
  void addScript(const TextFile &script_in, TextEnds line_endings = TextEnds::AS_IS);
  
private:
  std::string title;                      
  int component_count;                    
  int width;                              
  bool subsection;                        
  int section_id;                         
  int subsection_id;                      
  ListEnumeration section_marking;        
  ListEnumeration subsection_marking;     
  OutputSyntax style;                     
  std::vector<std::string> narrations;    
  std::vector<OrderedList> lists;         
  std::vector<ReportTable> tables;        
  std::vector<std::string> scripts;       
  std::vector<SectionComponent> sources;  
  std::string file_name;                  
  PrintSituation expectation;             

  void validateComponentIndex(int index) const;
};

std::string printAllSections(const std::vector<SectionContents> &info,
                             OutputSyntax style = OutputSyntax::STANDALONE,
                             ListEnumeration numbering = ListEnumeration::NUMBERED,
                             ListEnumeration nested_numbering = ListEnumeration::NUMBERED,
                             int width = -1, int list_indent = -1, int nested_list_indent = -1,
                             ListEnumeration list_numbering = ListEnumeration::NONE,
                             ListEnumeration nested_list_numbering = ListEnumeration::NONE);
 
void printAllSections(std::ofstream *foutp, const std::vector<SectionContents> &info,
                      OutputSyntax style = OutputSyntax::STANDALONE,
                      ListEnumeration numbering = ListEnumeration::NUMBERED,
                      ListEnumeration nested_numbering = ListEnumeration::NUMBERED,
                      int width = -1, int list_indent = -1, int nested_list_indent = -1,
                      ListEnumeration list_numbering = ListEnumeration::NONE,
                      ListEnumeration nested_list_numbering = ListEnumeration::NONE);
 
void printAllSections(const std::string &file_name, const PrintSituation expectation,
                      const std::vector<SectionContents> &info,
                      OutputSyntax style = OutputSyntax::STANDALONE,
                      ListEnumeration numbering = ListEnumeration::NUMBERED,
                      ListEnumeration nested_numbering = ListEnumeration::NUMBERED,
                      int width = -1, int list_indent = -1, int nested_list_indent = -1,
                      ListEnumeration list_numbering = ListEnumeration::NONE,
                      ListEnumeration nested_list_numbering = ListEnumeration::NONE);
 
} // namespace review
} // namespace stormm
 
#endif