commandline.h

Go to the documentation of this file.

/* SPDX-License-Identifier: MIT */
#ifndef AJA_COMMANDLINE_H
#define AJA_COMMANDLINE_H
 
#include "ajabase/common/types.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);
    AJACommandLineOption(const std::string &name,
                         const std::string &desc);
    AJACommandLineOption(const std::string &name,
                         const std::string &desc,
                         const std::string &defaultValue);
    AJACommandLineOption(const AJAStringList &names);
    AJACommandLineOption(const AJAStringList &names,
                         const std::string &desc);
    AJACommandLineOption(const AJAStringList &names,
                         const std::string &desc,
                         const std::string &defaultValue);
    virtual ~AJACommandLineOption();
 
    bool AddName(const std::string &name);
 
    AJAStringList GetNames() const;
 
    std::string GetDesc() const;
 
    void SetDesc(const std::string &desc);
 
    std::string GetExtraDesc() const;
 
    void SetExtraDesc(const std::string &desc);
 
    void SetDefaultValue(const std::string &value);
 
    std::string GetDefaultValue() const;
 
    void AddValue(const std::string &value);
    std::string GetValue(size_t index = 0) const;
    AJAStringList GetValues() const;
 
private:
    AJAStringList mNames;
    std::string mDesc;
    std::string mDescExtra;
    AJAStringList mValues;
    std::string mDefaultValue;
};
 
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;
 
struct OptionEntry {
    int pos;
    std::string value;
};
typedef std::map<std::string, OptionEntry> OptionEntryMap;
 
typedef enum {
    kShortOptionsAsLong = 1 << 0,
} 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 Reset(bool clearAll=false);
    void Dump();
 
    bool OptionByName(const std::string &name, AJACommandLineOption &opt) const;
    bool AddSubParser(AJACommandLineParser *sp);
    void ParseArgs(const AJAStringList &args);
    void ParseArgs(int argc, const char *argv[]);
    void ParseArgs(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();
    std::string GetName() const;
    void SetUsageText(const std::string &usageText);
    std::string GetUsageText() const;
    void SetHelpText(const std::string &helpText);
    std::string GetHelpText() const;
    std::string GetCommandName();
    AJAStringList GetKnownOptions();
    AJAStringList GetUnknownOptions();
 
private:
    static bool hasOptionPrefix(const std::string &name);
    bool reverseOptionSearch(AJAStringListConstIter *iter, const AJAStringList &args, const std::string &arg, int prefixSize, AJACommandLineOption &opt);
    bool parseValue(const std::string &arg, std::string &value);
    bool parseOptionValue(const std::string &name, const std::string &arg, AJAStringList::const_iterator *iter, AJAStringList::const_iterator end);
    bool setOptionValue(const std::string &name, const std::string &value);
    std::string removePrefix(const std::string &name, int &count);
 
    int mFlags;
    std::string mName;
    std::string mCommandName;
    std::string mDesc;
    std::string mDescExtra;
    std::string mUsageText;
    std::string mHelpText;
    AJACommandLineOptionList mOptions;
    AJAStringList mKnownOptions;
    AJAStringList mUnknownOptions;
    SubParserMap mSubParsers;
};
 
typedef AJACommandLineParser    AJACmdLineParser;
 
#endif // AJA_COMMANDLINE_H