namelist_emulator.h

// -*-c++-*-
#ifndef STORMM_NAMELIST_EMULATOR_H
#define STORMM_NAMELIST_EMULATOR_H
 
#include <fstream>
#include <iostream>
#include <string>
#include <vector>
#include "copyright.h"
#include "Constants/behavior.h"
#include "DataTypes/common_types.h"
#include "FileManagement/file_enumerators.h"
#include "Reporting/error_format.h"
#include "Reporting/summary_file.h"
#include "namelist_element.h"
#include "namelist_enumerators.h"
 
namespace stormm {
namespace namelist {
 
using constants::CaseSensitivity;
using constants::ExceptionResponse;
using data_types::isFloatingPointScalarType;
using data_types::isSignedIntegralScalarType;
using data_types::isUnsignedIntegralScalarType;
using diskutil::PrintSituation;
using review::default_output_file_width;
  
class NamelistEmulator {
public:

  NamelistEmulator(const std::string &title_in,
                   CaseSensitivity casing_in = CaseSensitivity::AUTOMATIC,
           ExceptionResponse unknown_keyword_policy = ExceptionResponse::WARN,
                   const std::string &help_in = std::string("No description provided"),
                   bool cli_content_in = false);

  const std::string& getTitle() const;

  bool isCommandLineContent() const;
  
  int getKeywordCount() const;

  CaseSensitivity getCaseSensitivity() const;

  ExceptionResponse getPolicy() const;

  const std::string& getKeyword(size_t index) const;

  NamelistType getKeywordKind(const std::string &keyword_query) const;

  int getKeywordEntries(const std::string &keyword_query) const;

  int getSubKeyCount(const std::string &keyword_query) const;
  
  InputStatus getKeywordStatus(const std::string &keyword_query) const;
  InputStatus getKeywordStatus(const std::string &keyword_query, const std::string &sub_key,
                               int repeat_no = 0) const;

  bool hasKeyword(const std::string &query) const;
  bool hasKeyword(const std::string &query, NamelistType query_kind) const;
  
  bool getBoolValue(const std::string &keyword_query) const;
  bool getBoolValue(const std::string &keyword_query, const std::string &sub_key,
                   int index = 0) const;
  
  int getIntValue(const std::string &keyword_query, int index = 0) const;
  int getIntValue(const std::string &keyword_query, const std::string &sub_key,
                  int index = 0) const;

  double getRealValue(const std::string &keyword_query, int index = 0) const;
  double getRealValue(const std::string &keyword_query, const std::string &sub_key,
                      int index = 0) const;

  const std::string& getStringValue(const std::string &keyword_query, int index = 0) const;
  const std::string& getStringValue(const std::string &keyword_query, const std::string &sub_key,
                                    int index = 0) const;

  std::vector<bool> getAllBoolValues(const std::string &keyword_query,
                                    const std::string &sub_key) const;
  
  std::vector<int> getAllIntValues(const std::string &keyword_query,
                                   const std::string &sub_key = std::string("")) const;

  std::vector<double> getAllRealValues(const std::string &keyword_query,
                                       const std::string &sub_key = std::string("")) const;

  std::vector<std::string>
  getAllStringValues(const std::string &keyword_query,
                     const std::string &sub_key = std::string("")) const;

  const std::string& getHelp() const;
  const std::string& getHelp(const std::string &keyword_query) const;
  const std::string& getHelp(const std::string &keyword_query, const std::string &sub_key) const;

  const NamelistEmulator* getSelfPointer() const;
  
  template <typename T>
  void assignVariable(T *var, double mult, const std::string &keyword_query, int index = 0) const;
 
  template <typename T>
  void assignVariable(T *var, const std::string &keyword_query, int index = 0) const;
 
  void assignVariable(std::string *var, double mult, const std::string &keyword_query,
                      int index = 0) const;
 
  void assignVariable(std::string *var, const std::string &keyword_query, int index = 0) const;
  
  template <typename T>
  void assignVariable(T *var_x, T *var_y, T *var_z, double mult, const std::string &keyword_query,
                      int index = 0) const;
 
  template <typename T>
  void assignVariable(T *var_x, T *var_y, T *var_z, const std::string &keyword_query,
                      int index = 0) const;
 
  template <typename T>
  void assignVariable(T *var, const std::string &keyword_query, const std::string &sub_key,
                      int index = 0) const;
 
  template <typename T>
  void assignVariable(T *var, double mult, const std::string &keyword_query,
                      const std::string &sub_key, int index = 0) const;
 
  void assignVariable(std::string *var, double mult, const std::string &keyword_query,
                      const std::string &sub_key, int index = 0) const;
 
  void assignVariable(std::string *var, const std::string &keyword_query,
                      const std::string &sub_key, int index = 0) const;
 
  template <typename T>
  void assignVariable(T *var_x, T *var_y, T *var_z, double mult, const std::string &keyword_query,
                      const std::string &sub_key, int index = 0) const;
 
  template <typename T>
  void assignVariable(T *var_x, T *var_y, T *var_z, const std::string &keyword_query,
                      const std::string &sub_key, int index = 0) const;

  void setTitle(const std::string &title_in);

  void setCommandLineContent(bool cli_content_in = true);
  
  void addKeyword(const std::vector<NamelistElement> &new_keys);
 
  void addKeywords(const std::vector<NamelistElement> &new_keys);
 
  void addKeyword(const NamelistElement &new_key);
 
  void addKeyword(const std::string &keyword_in, NamelistType kind_in,
                  const std::string &default_in = std::string(""),
                  DefaultIsObligatory obligate = DefaultIsObligatory::NO,
                  InputRepeats rep_in = InputRepeats::NO,
                  const std::string &help_in = std::string("No description provided"));
 
  void addKeyword(const std::string keyword_in, const std::vector<std::string> &sub_keys_in,
                  const std::vector<NamelistType> &sub_kinds_in,
                  const std::vector<std::string> &default_list,
                  DefaultIsObligatory obligate_list = DefaultIsObligatory::NO,
                  InputRepeats rep_in = InputRepeats::NO,
                  const std::string &help_in = std::string("No description provided"),
                  const std::vector<std::string> &sub_help_in =
                  std::vector<std::string>(1, "No description provided"),
                  const std::vector<KeyRequirement> &template_requirements_in = {});
 
  void addKeyword(const NamelistEmulator *other, const std::string &query);
 
  void addKeyword(const NamelistEmulator &other, const std::string &query);

  //         call the eponymous member function in an individual NamelistElement.
  void setDefaultValue(const std::string &key, const std::string &modified_default,
                       int default_idx = 0);
  void setDefaultValue(const std::string &key, const std::vector<std::string> &modified_defaults,
                       const std::vector<std::string> &sub_key_specs);
  
  void addDefaultValue(const std::string &key, const std::string &next_default);

  void activateBool(const std::string &key);
  void activateBool(const std::string &key, const std::string &sub_key);

  int assignElement(const std::string &key, const std::string &value);
  int assignElement(const std::string &key, const std::string &sub_key, const std::string &value);

  void triggerResizeBuffer(const std::string &key);

  void addHelp(const std::string &blurb);
  void addHelp(const std::string &key, const std::string &blurb);
  void addHelp(const std::string &key, const std::string &sub_key, const std::string &blurb);

  void addCategory(const std::string &new_category);

  void categorizeKeyword(const std::string &key, const std::string &category_label);

  void setImperative(const std::string &key, KeyRequirement req);
  void setImperative(const std::vector<std::string> &directives);
  void setImperative(const std::string &key, const std::vector<std::string> &directives);

  void printKeywordDocumentation(int p_idx, int name_width, int kw_kind_width,
                                 const std::string &kw_dflt) const;

  std::string convertDefaultToString(const NamelistElement &tkw) const;

  void printHelp() const;

  std::string printContents(int file_width = default_output_file_width, int max_entry_counts = 4,
                            NamelistIntroduction print_decor = NamelistIntroduction::HEADER) const;
  
  void printContents(std::ostream *foutp, int file_width = default_output_file_width,
                     int max_entry_counts = 4,
                     NamelistIntroduction print_decor = NamelistIntroduction::HEADER) const;
 
  void printContents(std::ofstream *foutp, int file_width = default_output_file_width,
                     int max_entry_counts = 4,
                     NamelistIntroduction print_decor = NamelistIntroduction::HEADER) const;
 
  void printContents(const std::string &file_name, PrintSituation expectation,
                     int file_width = default_output_file_width, int max_entry_counts = 4,
                     NamelistIntroduction print_decor = NamelistIntroduction::HEADER) const;
 
private:
  bool cli_content;                        
  std::string title;                       
  std::vector<NamelistElement> keywords;   
  CaseSensitivity casing;                  
  ExceptionResponse policy;                
  std::string help_message;                
  std::vector<std::string> category_names; 

  std::vector<std::vector<std::string>> categories;

  int findIndexByKeyword(const std::string &query) const;

  void verifyEstablishment(const std::string &keyword_query, const size_t p_index,
                           const char* caller) const;
};
 
} // namespace namelist
} // namespace stormm
 
#include "namelist_emulator.tpp"
 
#endif