Flags.h

Go to the documentation of this file.

 
 
 
#include <cstdint>
#include <functional>
#include <map>
#include <string>
#include <variant>
#include <vector>
 
 
namespace scsl {
 
 
enum class FlagType : uint8_t {
    Unknown         = 0, 
    Boolean         = 1, 
    Integer         = 2, 
    UnsignedInteger = 3, 
    SizeT           = 4, 
    String          = 5, 
};
 
 
typedef union {
    unsigned int u; 
    int          i; 
    std::size_t  size; 
    std::string  *s; 
    bool         b; 
} FlagValue;
 
 
typedef struct {
    FlagType    Type; 
    bool        WasSet; 
    std::string Name; 
    std::string Description; 
    FlagValue   Value; 
} Flag;
 
Flag    *NewFlag(std::string fName, FlagType fType, std::string fDescription);
 
class Flags {
public:
    enum class ParseStatus : uint8_t {
        Unknown       = 0,
 
        OK            = 1,
 
        EndOfFlags    = 2,
 
        NotRegistered = 3,
 
        NotEnoughArgs = 4,
    };
 
    static std::string  ParseStatusToString(ParseStatus status);
 
    Flags(std::string fName);
 
    Flags(std::string fName, std::string fDescription);
 
    ~Flags();
 
    bool Register(std::string fName,
              FlagType fType,
              std::string fDescription);
 
    bool Register(std::string fName,
              bool defaultValue,
              std::string fDescription);
 
    bool Register(std::string fName,
              int defaultValue,
              std::string fDescription);
 
    bool Register(std::string fName,
              unsigned int defaultValue,
              std::string fDescription);
 
    bool Register(std::string fName,
              size_t defaultValue,
              std::string fDescription);
 
    bool Register(std::string fName,
              std::string defaultValue,
              std::string fDescription);
 
    bool Register(std::string fName,
              const char *defaultValue,
              std::string fDescription);
 
    size_t Size();
 
    Flag *Lookup(std::string fName);
 
    bool ValueOf(std::string fName, FlagValue &value);
 
    ParseStatus Parse(int argc, char **argv, bool skipFirst=true);
 
    void Usage(std::ostream &os, int exitCode);
 
    size_t NumArgs();
 
    std::vector<std::string> Args();
 
    std::string Arg(size_t index);
 
    bool GetBool(std::string fName, bool &flagValue);
 
    bool GetUnsignedInteger(std::string fName, unsigned int &flagValue);
 
    bool GetInteger(std::string fName, int &flagValue);
 
    bool GetString(std::string fName, std::string &flagValue);
 
    bool GetSizeT(std::string fName, std::size_t &flagValue);
 
private:
    ParseStatus parseArg(int argc, char **argv, int &index);
    Flag *checkGetArg(std::string& fName, FlagType eType);
 
    std::string                   name;
    std::string                   description;
    std::vector<std::string>      args;
    std::map<std::string, Flag *> flags;
};
 
 
} // namespace scsl