Add Argument header file
Header file for the Argument class that the applications
in this repository can make use of by providing their own
implementations.
Change-Id: I43f733a56bdcd594d733cba2e3ab85f56bdcb673
Signed-off-by: Matt Spinler <spinler@us.ibm.com>
diff --git a/argument.hpp b/argument.hpp
new file mode 100644
index 0000000..f821060
--- /dev/null
+++ b/argument.hpp
@@ -0,0 +1,65 @@
+#pragma once
+
+#include <getopt.h>
+#include <map>
+#include <string>
+
+namespace witherspoon
+{
+namespace power
+{
+
+/** @brief Class - Encapsulates parsing command line options and
+ * populating arguments
+ */
+class ArgumentParser
+{
+ public:
+ ArgumentParser() = delete;
+ ~ArgumentParser() = default;
+ ArgumentParser(const ArgumentParser&) = delete;
+ ArgumentParser& operator=(const ArgumentParser&) = delete;
+ ArgumentParser(ArgumentParser&&) = default;
+ ArgumentParser& operator=(ArgumentParser&&) = default;
+
+ /** @brief Contructs Argument object
+ *
+ * @param[in] argc - the main function's argc passed as is
+ * @param[in] argv - the main function's argv passed as is
+ * @return Object constructed
+ */
+ ArgumentParser(int argc, char** argv);
+
+ /** @brief Given an option, returns its argument(optarg)
+ *
+ * @param[in] opt - command line option string
+ *
+ * @return argument which is a standard optarg
+ */
+ const std::string& operator[](const std::string& opt);
+
+ /** @brief Displays usage
+ *
+ * @param[in] argv - the main function's argv passed as is
+ */
+ static void usage(char** argv);
+
+ /** @brief Set to 'true' when an option is passed */
+ static const std::string trueString;
+
+ /** @brief Set to '' when an option is not passed */
+ static const std::string emptyString;
+
+ private:
+ /** @brief Option to argument mapping */
+ std::map<const std::string, std::string> arguments;
+
+ /** @brief Array of struct options as needed by getopt_long */
+ static const option options[];
+
+ /** @brief optstring as needed by getopt_long */
+ static const char* optionStr;
+};
+
+}
+}