CLI for C++ Project Page

CLI for C++ Home Page

---

Option.h

Go to the documentation of this file.

/*
 * Copyright (c) 2005 John H. Poplett. All rights reserved.
 * 
 * This software is provided 'as-is', without any express or implied
 * warranty. In no event will the authors be held liable for any damages
 * arising from the use of this software.
 * 
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 * 
 *     1. The origin of this software must not be misrepresented; you must
 *     not claim that you wrote the original software. If you use this
 *     software in a product, an acknowledgment in the product documentation
 *     would be appreciated but is not required.
 * 
 *     2. Altered source versions must be plainly marked as such, and must
 *     not be misrepresented as being the original software.
 * 
 *     3. This notice may not be removed or altered from any source
 *     distribution.
 */
#ifndef _Option_h_included
#define  _Option_h_included

#include <string>
#include <vector>

namespace CLI {

class Option {
    public:
        enum Args {
            NO_ARGS,
            ONE_ARG,
            AT_LEAST_ONE_ARG,
            MANY_ARGS
        };

        Option();

        Option(const Option&);
        Option& operator=(const Option&);

        Option(const char* const option, const bool hasArg, const char* const description);

        Option(const char* const option, const Args takesArgs, const char* const description);

        Option(const char* const option, const char* const description);

        Option(const char* const option, const char* const longOption, const bool hasArg, const char* const description);
        Option(const char* const option, const char* const longOption, const Args takesArgs, const char* const description);


        ~Option();

        std::string getArgName() const;

        std::string getOpt() const;
        std::string getLongOpt() const;
        bool hasLongOpt() const;

        std::string getDescription() const;

        int getId() const;

        std::string getValue() const;

        std::string getValue(const char* const defaultValue) const;


        std::string getValue(const unsigned index) const;

        std::vector<std::string> getValues() const;

        bool hasArgName() const;

        bool hasArg() const;
        bool hasArgs() const;

        void setArgName(const std::string& argName);

        void setArgs(const Args takesArgs);

        void addValue(const std::string& value);

    private:
        class Implementation;
        Implementation* impl_;
};


} 

#endif // #ifndef _Option_h_included

---

hosts this site.

Send comments to: John Poplett