arg_iface.hpp

Go to the documentation of this file.

 
#ifndef ARGS__ARG_IFACE_HPP__INCLUDED
#define ARGS__ARG_IFACE_HPP__INCLUDED
 
// Args include.
#include "utils.hpp"
#include "types.hpp"
#include "enums.hpp"
 
 
namespace Args {
 
class Context;
class CmdLine;
 
 
//
// ArgIface
//
 
class ArgIface {
 
    friend class CmdLine;
    friend class GroupIface;
    friend class Command;
 
public:
    ArgIface()
        :   m_cmdLine( nullptr )
    {
    }
 
    virtual ~ArgIface()
    {
    }
 
    virtual ArgType type() const = 0;
 
    virtual String name() const = 0;
 
    virtual bool isWithValue() const = 0;
 
    virtual bool isRequired() const = 0;
 
    virtual bool isDefined() const = 0;
 
    virtual const String & flag() const = 0;
 
    virtual const String & argumentName() const = 0;
 
    virtual const String & valueSpecifier() const = 0;
 
    virtual const String & description() const = 0;
 
    virtual const String & longDescription() const = 0;
 
    CmdLine * cmdLine() const
    {
        return m_cmdLine;
    }
 
    virtual bool isMisspelledName(
        const String & name,
        StringList & possibleNames ) const = 0;
 
    virtual void clear() = 0;
 
protected:
    virtual ArgIface * findArgument(
        const String & name ) = 0;
 
    virtual void process(
        Context & context ) = 0;
 
    virtual void checkCorrectnessBeforeParsing(
        StringList & flags,
        StringList & names ) const = 0;
 
    virtual void checkCorrectnessAfterParsing() const = 0;
 
    virtual void setCmdLine( CmdLine * cmdLine )
    {
        m_cmdLine = cmdLine;
    }
 
private:
    DISABLE_COPY( ArgIface )
 
    
    CmdLine * m_cmdLine;
}; // class ArgIface
 
} /* namespace Args */
 
#endif // ARGS__ARG_IFACE_HPP__INCLUDED