goptions.h

Go to the documentation of this file.

#ifndef  GOPTIONS_H
#define  GOPTIONS_H  1
 
#include "goption.h"
#include "gswitch.h"
 
// c++
#include <string>
#include <fstream>
#include <iostream>
#include <map>
#include <vector>
 
class GOptions {
 
public:
 
    GOptions() { return; }
 
    GOptions(int argc, char *argv[], const GOptions &user_defined_options);
 
    void defineSwitch(const std::string &name, const std::string &description);
 
    void defineOption(const GVariable &gvar, const std::string &help);
 
    void defineOption(const std::string &name, const std::string &description, const std::vector <GVariable> &gvars, const std::string &help);
 
    int getScalarInt(const std::string &tag) const;
 
    float getScalarFloat(const std::string &tag) const;
 
    double getScalarDouble(const std::string &tag) const;
 
    std::string getScalarString(const std::string &tag) const;
 
    bool getSwitch(const std::string &tag) const;
 
    inline const YAML::Node getOptionNode(const std::string &tag) const {
        // If the option does not exist, exit with error
        if (!doesOptionExist(tag)) {
            std::cerr << "Option " << tag << " does not exist. Exiting." << std::endl;
            gexit(EC__NOOPTIONFOUND);
        }
        return getOptionIterator(tag)->value.begin()->second;
    }
 
    YAML::Node getOptionMapInNode(string option_name, string map_key);
 
    int getVerbosityFor(const std::string &tag) const;
 
    const std::vector <GOption> &getOptions() const { return goptions; }
 
    const std::map <std::string, GSwitch> &getSwitches() const { return switches; }
 
    inline void addGOptions(const GOptions &goptions_to_add) {
        for (auto gopt: goptions_to_add.getOptions()) {
            goptions.push_back(gopt);
        }
        for (auto sw: goptions_to_add.getSwitches()) {
            switches.insert(sw);
        }
    }
 
    template<typename T>
    T get_variable_in_option(const YAML::Node &node, const string &variable_name, const T &default_value);
 
    std::vector <std::string> getYamlFiles() const { return yaml_files; }
 
private:
 
    std::vector <GOption> goptions;           
    std::map <std::string, GSwitch> switches; 
    std::ofstream *yamlConf;                 
    std::string executableName;              
    std::vector <std::string> yaml_files;     
 
 
    vector <string> findYamls(int argc, char *argv[]);  // finds the yaml specified by command line. Returns "na' if not found.
 
    void setOptionsValuesFromYamlFile(const std::string &yaml);
 
    void setOptionValuesFromCommandLineArgument(const std::string &optionName, const std::string &possibleYamlNode);
 
    bool doesOptionExist(const std::string &tag) const;
 
    std::vector<GOption>::iterator getOptionIterator(const std::string &name);
 
    std::vector<GOption>::const_iterator getOptionIterator(const std::string &name) const;
 
    void printOptionOrSwitchHelp(const std::string &tag) const;
 
    void printHelp() const;
 
    void printWebHelp() const;
 
    void saveOptions() const;
 
    void print_version();
 
 
};
 
// overloaded operator to add option vectors and switch maps
GOptions &operator+=(GOptions &original, const GOptions &optionsToAdd);
 
#endif