OptionBuilder.h

Go to the documentation of this file.

#ifndef STORM_SETTINGS_OPTIONBUILDER_H_
#define STORM_SETTINGS_OPTIONBUILDER_H_
 
#include <boost/algorithm/string.hpp>
#include <cstdint>
#include <iostream>
#include <memory>
#include <string>
#include <unordered_set>
#include <vector>
 
#include "storm/settings/ArgumentBase.h"
#include "storm/settings/ArgumentType.h"
#include "storm/settings/Option.h"
 
#include "storm/exceptions/IllegalArgumentException.h"
#include "storm/exceptions/IllegalFunctionCallException.h"
#include "storm/utility/macros.h"
 
namespace storm {
namespace settings {
 
class OptionBuilder {
   public:
    OptionBuilder(std::string const& moduleName, std::string const& longName, bool requireModulePrefix, std::string const& description)
        : longName(longName),
          shortName(""),
          hasShortName(false),
          description(description),
          moduleName(moduleName),
          requireModulePrefix(requireModulePrefix),
          isRequired(false),
          isAdvanced(false),
          isBuild(false),
          arguments(),
          argumentNameSet() {
        // Intentionally left empty.
    }
 
    OptionBuilder& setShortName(std::string const& shortName) {
        this->shortName = shortName;
        this->hasShortName = true;
        return *this;
    }
 
    OptionBuilder& setIsRequired(bool isRequired) {
        this->isRequired = isRequired;
        return *this;
    }
 
    OptionBuilder& setIsAdvanced(bool isAdvanced = true) {
        this->isAdvanced = isAdvanced;
        return *this;
    }
 
    OptionBuilder& addArgument(std::shared_ptr<ArgumentBase> argument) {
        STORM_LOG_THROW(!this->isBuild, storm::exceptions::IllegalFunctionCallException,
                        "Cannot add an argument to an option builder that was already used to build the option.");
        STORM_LOG_THROW(this->arguments.empty() || argument->getIsOptional() || !this->arguments.back()->getIsOptional(),
                        storm::exceptions::IllegalArgumentException, "Unable to add non-optional argument after an option that is optional.");
 
        std::string lowerArgumentName = boost::algorithm::to_lower_copy(argument->getName());
        STORM_LOG_THROW(argumentNameSet.find(lowerArgumentName) == argumentNameSet.end(), storm::exceptions::IllegalArgumentException,
                        "Unable to add argument to option, because it already has an argument with the same name.");
 
        argumentNameSet.insert(lowerArgumentName);
        this->arguments.push_back(argument);
 
        return *this;
    }
 
    std::shared_ptr<Option> build() {
        STORM_LOG_THROW(!this->isBuild, storm::exceptions::IllegalFunctionCallException, "Cannot rebuild an option with one builder.");
        this->isBuild = true;
 
        if (this->hasShortName) {
            return std::shared_ptr<Option>(new Option(this->moduleName, this->longName, this->shortName, this->description, this->isRequired,
                                                      this->requireModulePrefix, this->isAdvanced, this->arguments));
        } else {
            return std::shared_ptr<Option>(new Option(this->moduleName, this->longName, this->description, this->isRequired, this->requireModulePrefix,
                                                      this->isAdvanced, this->arguments));
        }
    }
 
   private:
    // The long name of the option.
    std::string longName;
 
    // A possible short name of the option or the empty string in case the option does not have a short name.
    std::string shortName;
 
    // A flag indicating whether the option has a short name.
    bool hasShortName;
 
    // The description of the option.
    std::string description;
 
    // The name of the module to which this option belongs.
    std::string moduleName;
 
    // A flag indicating whether the option has to be prefixed with the module name.
    bool requireModulePrefix;
 
    // A flag indicating whether the option is required.
    bool isRequired;
 
    // A flag that indicates whether this option is only displayed in the advanced help.
    bool isAdvanced;
 
    // A flag indicating whether the builder has already been used to build an option.
    bool isBuild;
 
    // The arguments of the option that is being built.
    std::vector<std::shared_ptr<ArgumentBase>> arguments;
 
    // The names of the arguments of the option.
    std::unordered_set<std::string> argumentNameSet;
};
}  // namespace settings
}  // namespace storm
 
#endif  // STORM_SETTINGS_OPTIONBUILDER_H_