argParse.hpp

/**************************************************************************************************
 * Copyright (c) 2023-2025 NWSOFT                                                                 *
 *                                                                                                *
 * Permission is hereby granted, free of charge, to any person obtaining a copy                   *
 * of this software and associated documentation files (the "Software"), to deal                  *
 * in the Software without restriction, including without limitation the rights                   *
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell                      *
 * copies of the Software, and to permit persons to whom the Software is                          *
 * furnished to do so, subject to the following conditions:                                       *
 *                                                                                                *
 * The above copyright notice and this permission notice shall be included in all                 *
 * copies or substantial portions of the Software.                                                *
 *                                                                                                *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR                     *
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,                       *
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE                    *
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER                         *
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,                  *
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE                  *
 * SOFTWARE.                                                                                      *
 **************************************************************************************************/

 
#pragma once
 
#include <map>
#include <regex>
#include <string>
#include <unordered_map>
#include <vector>

namespace steppable::__internals::utils
{
    using PosArgs = std::vector<std::string>;

    // language=RegExp
    [[maybe_unused]] const std::regex KEYWORD_ARG_REGEX(R"(^-([a-zA-Z]*):(-?[0-9]+)$)"); // NOLINT(cert-err58-cpp)

    // language=RegExp
    [[maybe_unused]] const std::regex SWITCH_REGEX(R"(^([-+])([a-zA-Z]*)$)"); // NOLINT(cert-err58-cpp)

    class ProgramArgs
    {
    private:
        std::unordered_map<std::string, bool> switches;
        std::map<std::string, std::string> switchDescriptions;

        std::vector<std::string> posArgs; // Names are used for error messages only.
        std::map<char, std::string> posArgDescriptions;
        std::vector<bool> posArgIsNumber;

        std::unordered_map<std::string, int> keywordArgs;
        std::map<std::string, std::string> keywordArgDescriptions;

        int argc;

        std::vector<std::string> argv;

        std::string programName;
 
    public:
        ProgramArgs(int _argc, const char** argv);

        void parseArgs();

        void addSwitch(const std::string& name, bool defaultValue, const std::string& description = "");

        void addPosArg(char name,
                       const std::string& description = "",
                       bool requiresNumber = true); // Positional arguments are always required and ordered

        void addKeywordArg(const std::string& name, int defaultValue, const std::string& description = "");

        [[nodiscard]] std::string getPosArg(size_t index) const;

        int getKeywordArgument(const std::string& name);

        bool getSwitch(const std::string& name);

        void printUsage(const std::string& reason = "") const;
    };
} // namespace steppable::__internals::utils