commandline.h

Go to the documentation of this file.

/* SPDX-License-Identifier: MIT */
#ifndef AJA_COMMANDLINE_H
#define AJA_COMMANDLINE_H
 
#include "ajabase/common/export.h"
#include "ajabase/common/variant.h"
 
#include <string>
#include <map>
#include <vector>
 
typedef std::vector<std::string> AJAStringList;
typedef AJAStringList::const_iterator AJAStringListConstIter;
 
typedef enum {
    kOptionSingleDash = 1 << 0,
    kOptionDoubleDash = 1 << 1,
} AJACommandLineOptionFlags;
 
class AJA_EXPORT AJACommandLineOption
{
public:
    AJACommandLineOption();
    AJACommandLineOption(const std::string &name,
                         const std::string &desc = "",
                         const std::string &defaultValue = "");
    AJACommandLineOption(const AJAStringList &names,
                         const std::string &desc = "",
                         const std::string &defaultValue = "");
    virtual ~AJACommandLineOption();
 
    bool AddName(const std::string &name);
 
    AJAStringList Names() const;
 
    bool HaveName(const std::string &name) const;
 
    std::string Desc() const;
 
    void SetDesc(const std::string &desc);
 
    std::string ExtraDesc() const;
 
    void SetExtraDesc(const std::string &desc);
 
    void SetDefaultValue(const std::string &value);
 
    std::string DefaultValue() const;
 
    void AddValue(const std::string &value);
 
    std::string Value(size_t index = 0) const;
 
    AJAStringList Values() const;
 
    void Reset();
 
    bool IsSet() const;
 
    void MarkSet(bool isSet = true);
 
private:
    AJAStringList _names;
    std::string _desc;
    std::string _descExtra;
    AJAStringList _values;
    std::string _defaultValue;
    bool _isSet;
};
 
typedef AJACommandLineOption    AJACmdLineOption;
 
typedef std::vector<AJACommandLineOption> AJACommandLineOptionList;
typedef AJACommandLineOptionList::const_iterator AJACommandLineOptionListIter;
 
class AJACommandLineParser;
typedef std::map<std::string, AJACommandLineParser *> SubParserMap;
typedef SubParserMap::const_iterator SubParserMapConstIter;
typedef std::pair<std::string, AJACommandLineParser*> AJASubParserPair;
 
typedef enum {
    kShortOptionsAsLong   = 1 << 0,
    kNoDefaultHelpOption  = 1 << 1,
    kNoDefaultUsageOption = 1 << 2,
    kErrorOnUnknownArgs   = 1 << 3
} AJACommandLineParserFlags;
 
class AJA_EXPORT AJACommandLineParser
{
public:
    explicit AJACommandLineParser(int flags=0);
    explicit AJACommandLineParser(const std::string &name, int flags=0);
    AJACommandLineParser(const AJACommandLineParser &other);
    ~AJACommandLineParser();
    void operator=(const AJACommandLineParser &other);
 
    void SetFlags(int flags);
 
    void Clear();
 
    void Reset(bool clearAll=false);
 
    void Dump();
 
    bool HaveOption(const std::string &name) const;
 
    bool HavePositionalArg(const std::string &name) const;
 
    AJAStringList PositionalArgs() const;
 
    bool OptionByName(const std::string &name, AJACommandLineOption &opt) const;
 
    bool AddSubParser(AJACommandLineParser *sp);
 
    bool Parse(const AJAStringList &args);
 
    bool Parse(int argc, const char *argv[]);
 
    bool Parse(int argc, char *argv[]);
 
    bool IsSet(const std::string &name) const;
 
    AJAVariant Value(const std::string &name, size_t index = 0) const;
 
    AJAVariantList Values(const std::string &name) const;
 
    std::string ValueString(const std::string &name, size_t index = 0) const;
 
    AJAStringList ValueStrings(const std::string &name) const;
 
    bool AddOption(const AJACommandLineOption &option);
 
    bool AddOptions(const std::vector<AJACommandLineOption> &options);
 
    bool AddHelpOption(bool useShortName=false);
 
    bool AddUsageOption(bool useShortName=false);
 
    std::string Name() const;
 
    void SetUsageText(const std::string &usageText);
 
    std::string UsageText();
 
    void SetHelpText(const std::string &helpText);
 
    std::string HelpText();
 
    std::string CommandName();
 
private:
    static bool hasOptionPrefix(const std::string &name);
    static bool hasAssignmentOperator(const std::string &arg);
 
    void init();
 
    std::string generateHelpText() const;
    std::string generateUsageText() const;
 
    bool setOptionValue(const std::string &name, const std::string &value);
    bool setOption(const std::string &name, bool isSet = true);
 
    int _flags;
    std::string _name;
    std::string _commandName;
    std::string _desc;
    std::string _descExtra;
    std::string _usageText;
    std::string _helpText;
    AJACommandLineOptionList _options;
    AJAStringList _positionalArgs;
    SubParserMap _subParsers;
};
 
typedef AJACommandLineParser    AJACmdLineParser;
 
#endif // AJA_COMMANDLINE_H