reporting_enumerators.h

// -*-c++-*-
#ifndef STORMM_REPORTING_ENUMERATORS_H
#define STORMM_REPORTING_ENUMERATORS_H
 
#include <string>
#include <vector>
#include "copyright.h"
#include "Constants/behavior.h"
 
namespace stormm {
namespace display {

enum class HelpSignalKind {
  NO_ARGS,       
  NO_ARGS_ONLY,  
  KEYWORD,       
  KEYWORD_ONLY   
};

std::string getEnumerationName(HelpSignalKind input);
 
} // namespace display
 
namespace review {
 
using constants::ExceptionResponse;

enum class OutputScope {
  AVERAGES,          
  OUTLIERS,          
  CLUSTER_AVERAGES,  
  CLUSTER_OUTLIERS,  
  FULL               
};
  
enum class OutputSyntax {
  JSON,        
  MATPLOTLIB,  
  MATRIX_PKG,  
  STANDALONE   
};

enum class DynamicsStepStage {
  BEGIN,              
  NONBONDED_FORCE,    
  ADDED_FORCE,        
  BONDED_FORCE,       
  VELOCITY_UPDATE,    
  RATTLE,             
  COORDINATE_UPDATE,  
  SHAKE               
};

enum class GridFileSyntax {
  MATPLOTLIB,  
  MATRIX_PKG,  
  OPEN_DX,     
  CUBEGEN      
};
  
enum class SectionComponent {
  NARRATIVE,  
  LIST,       
  TABLE,      
  SCRIPT      
};

enum class ListEnumeration {
  BULLET,      
  NUMBERED,    
  ALPHABETIC,  
  ROMAN,       
  NONE         
};

enum class TextEnds {
  AS_IS,   
  NEWLINE  
};

enum class TableContentKind {
  INTEGER,     
  REAL,        
  STRING,      
  OPEN_STRING  
};

enum class SurfaceRender {
  WIRE,     
  SOLID,    
  SCAFFOLD  
};

enum class PsivantColor {
  BLACK,         
  RED,           
  YELLOW,        
  BLUE,          
  PURPLE,        
  GREY,          
  LIGHT_RED,     
  LIGHT_YELLOW,  
  LIGHT_BLUE,    
  LIGHT_PURPLE,  
  WHITE          
};

enum class LinePlotStyle {
  SOLID,  
  DASHED  
};
  
const std::vector<std::string> roman_numerals = { "i", "ii", "iii", "iv", "v", "vi", "vii", "viii",
                                                  "ix", "x", "xi", "xii", "xiii", "xiv", "xv",
                                                  "xvi", "xvii", "xviii", "xix", "xx", "xxi",
                                                  "xxii", "xxiii", "xxiv", "xv", " " };

constexpr int maximum_roman_numeral = 25;

std::string getEnumerationName(OutputScope input);
std::string getEnumerationName(OutputSyntax input);
std::string getEnumerationName(DynamicsStepStage input);
std::string getEnumerationName(GridFileSyntax input);
std::string getEnumerationName(SectionComponent input);
std::string getEnumerationName(ListEnumeration input);
std::string getEnumerationName(TextEnds input);
std::string getEnumerationName(TableContentKind input);
std::string getEnumerationName(SurfaceRender input);
std::string getEnumerationName(LinePlotStyle input);
std::string getEnumerationName(PsivantColor input);

OutputScope translateOutputScope(const std::string &input);
  
SurfaceRender translateSurfaceRender(const std::string &input);

LinePlotStyle translateLinePlotStyle(const std::string &input);

const std::string& toRoman(int x, ExceptionResponse policy = ExceptionResponse::DIE);

std::string encodePsivantColor(PsivantColor color, OutputSyntax syntax);
  
} // namespace review
} // namespace stormm
 
#endif