summary_file.h

// -*-c++-*-
#ifndef STORMM_SUMMARY_FILE_H
#define STORMM_SUMMARY_FILE_H
 
#include <fstream>
#include <iostream>
#include <string>
#include <vector>
#include "copyright.h"
#include "FileManagement/file_enumerators.h"
#include "Parsing/textfile.h"
#include "reporting_enumerators.h"
 
namespace stormm {
namespace review {
 
using diskutil::PrintSituation;
  
constexpr int default_output_file_width = 80;
  
int findFormatWidth(const std::ostream *foutp);
  
std::string stormmSplash(int width);
void stormmSplash(std::ofstream *foutp, int width = default_output_file_width);
void stormmSplash(std::ostream *foutp = &std::cout, int width = default_output_file_width);

std::string stormmWatermark(int width);
void stormmWatermark(std::ofstream *foutp, int width = default_output_file_width);
void stormmWatermark(std::ostream *foutp = &std::cout, int width = default_output_file_width);

void summaryHeader(const std::string &description, std::ofstream *foutp, int file_width = -1);

char commentSymbol(OutputSyntax format);
char commentSymbol(GridFileSyntax format);
  
std::string indentText(const std::string &text, const std::string &marker, int indent, int width,
                       bool mark_on_all_lines, TextEnds block_ending = TextEnds::AS_IS);
 
std::string indentText(const std::string &text, int indent, int width,
                       TextEnds block_ending = TextEnds::AS_IS);

std::string protectText(const std::string &text, char protect, int width = -1,
                        TextEnds block_ending = TextEnds::NEWLINE);

void printProtectedText(const std::string &text, char protect, std::ofstream *foutp,
                        int file_width = -1, TextEnds block_ending = TextEnds::NEWLINE);
  
void printProtectedText(const std::string &text, char protect, const std::string &output_file,
                        int file_width = -1, PrintSituation expectation = PrintSituation::APPEND,
                        TextEnds block_ending = TextEnds::NEWLINE);
 
} // namespace review
} // namespace stormm
 
 
#endif