ArgParser.h

/******************************************************************************
* Copyright (c) ATTX LLC 2024. All Rights Reserved.
*
* This software and associated documentation (the "Software") are the 
* proprietary and confidential information of ATTX, LLC. The Software is 
* furnished under a license agreement between ATTX and the user organization 
* and may be used or copied only in accordance with the terms of the agreement.
* Refer to 'license/attx_license.adoc' for standard license terms.
*
* EXPORT CONTROL NOTICE: THIS SOFTWARE MAY INCLUDE CONTENT CONTROLLED UNDER THE
* INTERNATIONAL TRAFFIC IN ARMS REGULATIONS (ITAR) OR THE EXPORT ADMINISTRATION 
* REGULATIONS (EAR99). No part of the Software may be used, reproduced, or 
* transmitted in any form or by any means, for any purpose, without the express 
* written permission of ATTX, LLC.
******************************************************************************/
#ifndef ARG_PARSER_H
#define ARG_PARSER_H
 
#include <vector>
#include <string>
 
#include "data_management/GraphTreeObject.h"
#include "data_management/DataIO.hpp"
 
namespace modelspace {
 
    const std::string ARG_INDICATOR = "--";
 
    /**
     * @brief   Class to parse arguments from the command line in any language
    */
    class ArgParser {
    public:
        /// @brief Default constructor for the arg parser -- sets name to "args"
        ArgParser(){}
        ~ArgParser() {}
 
        /// @brief Function to get the string value of an arg
        /// @param name The arg to get
        /// @return The arg as a string value. Empty string if arg does not exist
        std::string operator () (const std::string &name) {std::string tmp; get(name, tmp); return tmp;}
 
        /// @brief Function to get the string value of an arg
        /// @param name The arg to get
        /// @param val  The returned value
        /// @return The arg as a string value. Empty string if arg does not exist
        int get(const std::string &name, std::string &val);
 
        /// @brief Function to get the string value of an arg as a double
        /// @param name The arg to get
        /// @param val  The returned value
        /// @return The arg as a double value. Will produce error if value can't be cast to double
        int get(const std::string &name, double &val);
 
        /// @brief Function to get the string value of an arg as an int
        /// @param name The arg to get
        /// @param val  The returned value
        /// @return The arg as an int value. Will produce error if value can't be cast to int
        int get(const std::string &name, int &val);
 
        /// @brief Function to parse argc and argv for string arguments
        /// @param argc C++ argc input
        /// @param argv C++ argv input
        /// @return Error code corresponding to success/failure
        int parseArgs(int argc, char *argv[]);
 
        /// @brief Function to loop through args and parse for values
        /// @param args A std::vector of arguments
        /// @return Error code corresponding to success/failure
        int parseArgs(std::vector<std::string> args);
 
        /// @brief Function to add a default argument that can be overridden from the cmd line
        /// @param name The name of the argument to add
        /// @param val The default value
        void addDefaultArgument(const std::string &name, const std::string &val);
 
        /// @brief Function to add a default argument that can be overridden from the cmd line
        /// @param name The name of the argument to add
        /// @param val The default value
        void addDefaultArgument(const std::string &name, double val);
 
        /// @brief Function to add a default argument that can be overridden from the cmd line
        /// @param name The name of the argument to add
        /// @param val The default value
        void addDefaultArgument(const std::string &name, int val);
 
        /// @brief Function to dump all argument value pairs held in the class
        void dump();
    private:
        // Pair to store key value pairs as <key, value>
        std::vector<std::pair<std::string, std::string>> _key_val_pairs;
 
        // Pair to store default key value pairs that can be overwritten by input arguments
        std::vector<std::pair<std::string, std::string>> _default_key_val_pairs;
    };
 
    /// @brief Function to return whether substr is in parent_str
    /// @param parent_str The string to search
    /// @param substr The string to search for
    /// @return True if substr is in parent_str. False otherwise
    bool contains(const std::string &parent_str, const std::string &substr);
 
    /// @brief Function to trim leading and trailing whitespace from string
    /// @param str The string to trim
    /// @param whitespace The whitespace we're looking to trim off. Defaults to " \t"
    /// @return The trimmed string
    std::string trim(const std::string& str, const std::string& whitespace=" \t");
 
}
 
#endif