RADCLI.h

Go to the documentation of this file.

#ifndef RADCLI_H
#define RADCLI_H
 
#pragma once
 
#include <RADCore/RADCore.h>
 
#include <map>
#include <optional>
#include <string>
#include <vector>
 
namespace RADCLI {
 
    struct Option {
        std::string name;
        char shortName = '\0';
        std::string description;
        bool requiresValue = false;
        bool required = false;
        std::string defaultValue;
    };
 
    class ParseResult {
    public:
        bool ok() const;
        const std::string& error() const;
        bool has(const std::string& name) const;
        std::string value(const std::string& name, const std::string& defaultValue = {}) const;
        const std::vector<std::string>& positionals() const;
 
    private:
        friend class CommandLineParser;
        bool ok_ = true;
        std::string error_;
        std::map<std::string, std::string> values_;
        std::vector<std::string> present_;
        std::vector<std::string> positionals_;
    };
 
    class CommandLineParser {
    public:
        explicit CommandLineParser(std::string applicationName = {});
        void setDescription(std::string description);
        void addOption(Option option);
        ParseResult parse(int argc, char** argv) const;
        ParseResult parse(const std::vector<std::string>& args) const;
        std::string helpText() const;
 
    private:
        const Option* findLong(const std::string& name) const;
        const Option* findShort(char shortName) const;
 
        std::string applicationName_;
        std::string description_;
        std::vector<Option> options_;
    };
 
    std::optional<std::string> environmentVariable(const std::string& name);
    bool setEnvironmentVariable(const std::string& name, const std::string& value, bool overwrite = true);
    std::string executablePath();
    std::string currentUserName();
    std::string radlibVersionString();
 
} // namespace RADCLI
 
#endif