command_line_parser.h

// -*-c++-*-
#ifndef STORMM_COMMAND_LINE_PARSER_H
#define STORMM_COMMAND_LINE_PARSER_H
 
#include <map>
#include <string>
#include <vector>
#include "copyright.h"
#include "namelist_emulator.h"
#include "namelist_inventory.h"
 
namespace stormm {
namespace namelist {

const char default_stormm_input_deck[] = "stormm.in";
const char default_stormm_input_topology[] = "prmtop";
const char default_stormm_input_coordinates[] = "inpcrd";
const char default_stormm_report_file[] = "stormm_report.m";
const char default_stormm_output_trajectory[] = "mdcrd";
const char default_stormm_output_checkpoint[] = "mdrst";  

class CommandLineParser {
public:

  CommandLineParser(const std::string &program_name_in, const std::string &program_description,
                    const std::vector<std::string> &noted_imports_in = {},
                    ExceptionResponse policy_in = ExceptionResponse::WARN);
 
  CommandLineParser(const std::string &program_name_in, const std::string &program_description,
                    ExceptionResponse policy_in);

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

  std::string getInputAsString(int width = 0) const;

  bool doesProgramExitOnHelp() const;
  
  void activateHelpOnNoArgs();

  void suppressHelpOnNoArgs();

  void activateExitOnHelp();

  void preventExitOnHelp();

  void addStandardAmberInputs(const std::vector<std::string> &cli_keys);
  void addStandardAmberInputs(const char* key_a, const char* key_b = nullptr,
                              const char* key_c = nullptr, const char* key_d = nullptr);
  void addStandardAmberInputs();

  void addStandardBenchmarkingInputs(const std::vector<std::string> &cli_keys);
  void addStandardBenchmarkingInputs(const char* key_a, const char* key_b = nullptr,
                                     const char* key_c = nullptr, const char* key_d = nullptr);  
  void addStandardBenchmarkingInputs();

  void addStandardApplicationInputs(const std::vector<std::string> &cli_keys);
  void addStandardApplicationInputs(const char* key_a, const char* key_b = nullptr,
                                    const char* key_c = nullptr, const char* key_d = nullptr);
  void addStandardApplicationInputs();
  
  const NamelistEmulator* getNamelistPointer() const;
  NamelistEmulator* getNamelistPointer();

  void parseUserInput(int argc, const char* argv[]);

  void coordinateWithPartner(CommandLineParser *other);
  
  void addControlBlocks(const std::vector<std::string> &list);

  void addCustomNamelists(const std::vector<NamelistToken> &custom_namelists_in);
  
private:
 
  ExceptionResponse policy;  
  int arg_count;             
  std::string program_name;  
  std::string executable;    
  NamelistEmulator cli_nml;  
  bool help_on_no_args;      
  bool exit_on_help;         
  bool lead_parser;          
  
  std::vector<std::string> command_line_text;

  std::vector<std::string> control_blocks;
  
  std::vector<CommandLineParser*> coordinations;

  std::map<std::string, NamelistType> excluded_keys;

  std::vector<std::string> noted_imports;

  std::vector<NamelistToken> custom_namelists;
};
  
} // namespace namelist
} // namespace stormm
 
#endif