Argx.hpp

Go to the documentation of this file.

/* inc/argx.hpp
 * Owned and created by: pcannon09
 */
 
#pragma once
 
#include "../inc/macros.hpp"
 
#if __cplusplus >= 201103L
#include <string>
#include <vector>
 
#include "../inc/types.hpp"
 
namespace argx
{
    class Argx
    {
    private:
        std::string id;
 
        static std::vector<ARGXOptions> options;
        static std::vector<std::string> *mainArgs;
 
        static unsigned int mainArgc;
 
    public:
        /**
         * @brief Create Argx with the specific `id`, `argc` and `argv`
         * @param id Set the ID of the Argx
         * @param argc Set the `argc` of the `main()` function
         * @param argv Set the `argv` of the `main()` function
         */
        Argx(const std::string &id, int argc, char *argv[]);
        Argx();
        ~Argx();
 
        /**
         * @brief Add param options
         * @param option Add the option to the main params
         */
        void add(ARGXOptions option) const;
 
        /**
         * @brief Get the param from `id`
         * @param id The ID to get
         * @return ARGXParam Returnted parameter to get
         */
        ARGXParam getParam(const std::string& id);
 
        /**
         * @brief Create documentation for the parameters with the specific style, title and main information
         * @param style Set the style using ARGXStyle
         * @param title Title for docs
         * @param Main information
         * @return std::string Documentation as a string
         */
        std::string createDocs(ARGXStyle style, const std::string &title, const std::string &mainInfo);
 
        /**
         * @brief Find parameter index
         */
        int findParam(const std::string& id);
 
        /**
         * @brief Get the main options from the `main()` function as argc
         * @return int Number of params including the executable param
         */
        int getArgc() const;
 
        /**
         * @brief Get if param exists in the param options
         * @param id ID to get
         * @return bool
         */
        bool paramExists(const std::string &id);
 
        /**
         * @brief Compare if `options` contains the required `id`, if the ID does not exist, return false
         * @param options Return ARGXOptions vector
         * @param id ID to find
         * @return bool
         */
        bool compareArgs(std::vector<ARGXOptions> options, std::vector<std::string> argv);
 
        /**
         * @brief Get the sub-param from `id`
         * @param param Original param
         * @param id The ID to get
         * @return bool
         */
        bool getSubParam(const argx::ARGXParam &param, const std::string &id);
 
        /**
         * @brief Get main arguments from `main()` function `argv`
         * @return std::vector<std::string> Vector of strings for main arguments from `argv`
         */
        std::vector<std::string> getMainArgs() const;
 
        /**
         * @brief Get main set options as ARGXOptions
         * @return std::vector<ARGXOptions> Options to return
         */
        std::vector<ARGXOptions> getOptions() const;
 
        /**
         * @brief Get Argx ID
         * @return std::string Argx ID
         */
        std::string getID() const;
    };
}
 
#else
#   error "Must compile with C++11 support or newer"
#   pragma message("Current standard is " ARGX_TOSTRING(__cplusplus))
#endif