Added Cli class

Author: tyler-gilbert

doxyfile

@@ -38,7 +38,7 @@ PROJECT_NAME           = StratifyLib
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 2.0.0
+PROJECT_NUMBER         = 2.1.0
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

include/sys.hpp

@@ -20,6 +20,7 @@ namespace sys {};
 #include "sys/Dbug.hpp"
 #include "sys/DbugStdout.hpp"
 #include "sys/DbugUart.hpp"
+#include "sys/Cli.hpp"
 #endif
 
 #include "sys/Trace.hpp"

include/sys/Cli.hpp

@@ -0,0 +1,120 @@
+/*! \file */ //Copyright 2011-2016 Tyler Gilbert; All Rights Reserved
+
+#ifndef SYS_CLI_HPP_
+#define SYS_CLI_HPP_
+
+#include "../var/String.hpp"
+#include "../var/Token.hpp"
+
+namespace sys {
+
+
+/*! \brief Command Line Interface class
+ * \details This class contains methods to help analyze input from the
+ * command line.
+ */
+class Cli {
+public:
+
+	/*! \details Construct a new object to parse and handle command line interface arguments */
+	Cli(int argc, char * argv[]);
+
+	/*! \details Set the version of the program */
+	void set_version(const char * version){ m_version = version; }
+
+	/*! \details Set the publisher of the program */
+	void set_publisher(const char * publisher){ m_publisher = publisher; }
+
+	/*! \details Print the version, name and publisher on the stdout */
+	void print_version();
+
+	/*! \details Access the program version */
+	const char * version() const { return m_version; }
+
+	/*! \details Access the program publisher */
+	const char * publisher() const { return m_publisher; }
+
+	/*! \details Access the program name */
+	const char * name() const { return m_name; }
+
+	/*! \details Return the argument offset by value as a var::String */
+	var::String at(u16 value);
+
+	/*! \details Return the argument offset by value as a pio_t value */
+	pio_t pio_at(u16 value);
+
+	/*! \details Return the argument offset by value as an int value */
+	int value_at(u16 value);
+
+	/*! \details This method returns true if \a value is one of the options
+	 *
+	 * @param value A pointer to the option string to search for
+	 * @return True if value is any of the options available
+	 *
+	 * For example,
+	 *
+	 *    program --version -i text.txt
+	 *
+	 * is_option("--version") will return true.
+	 *
+	 */
+	bool is_option(const char * value);
+
+	/*! \details Get the argument of an option as a var::String
+	 *
+	 * @param option The option to match
+	 * @return A String containing the option argument
+	 *
+	 * For example, take the given command line
+	 *    program -i filename.txt
+	 *
+	 *  get_option_argument("-i") will return a String containing "filename.txt"
+	 *
+	 *
+	 */
+	var::String get_option_argument(const char * option);
+
+	/*! \details Get the argument of an option as a var::String
+	 *
+	 * @param option The option to match
+	 * @return The value of the argument or 0 if the option wasn't found
+	 *
+	 * For example, take the given command line
+	 *    program -i 10
+	 *
+	 *  get_option_argument("-i") will return 10
+	 *
+	 *
+	 */
+	int get_option_value(const char * option);
+
+	/*! \details Get the argument of an option as a var::String
+	 *
+	 * @param option The option to match
+	 * @return The value of the argument or 0 if the option wasn't found
+	 *
+	 * For example, take the given command line
+	 *    program -i 2.1
+	 *
+	 *  get_option_argument("-i") will return port = 2 and pin = 1
+	 *
+	 *
+	 */
+	pio_t get_option_pio(const char * option);
+
+
+	int size() const { return m_argc; }
+
+private:
+	u16 m_argc;
+	char ** m_argv;
+	var::String m_version;
+	var::String m_publisher;
+	var::String m_name;
+
+
+};
+
+} /* namespace sys */
+
+#endif /* SYS_CLI_HPP_ */

src/sys/Cli.cpp

@@ -0,0 +1,104 @@
+/*! \file */ //Copyright 2011-2016 Tyler Gilbert; All Rights Reserved
+
+#include "sys/Cli.hpp"
+
+using namespace var;
+
+namespace sys {
+
+Cli::Cli(int argc, char * argv[]){
+	if( argc < 0 ){
+		argc = 0;
+	}
+	m_argc = argc;
+	m_argv = argv;
+
+	if( argc > 0 ){
+		m_name = argv[0];
+	}
+}
+
+void Cli::print_version(){
+	printf("%s version: %s by %s\n", m_name.c_str(), m_version.c_str(), m_publisher.c_str());
+}
+
+String Cli::at(u16 value){
+	String arg;
+	if( value < m_argc ){
+		arg.assign(m_argv[value]);
+	}
+	return arg;
+}
+
+String Cli::get_option_argument(const char * option){
+	u16 args;
+	for(args = 0; args < m_argc; args++){
+		if( at(args) == option ){
+			return at(args+1);
+		}
+	}
+	return String();
+}
+
+bool Cli::is_option(const char * value){
+	u16 i;
+	for(i=0; i < m_argc; i++){
+		if( at(i) == value ){
+			return true;
+		}
+	}
+	return false;
+}
+
+int Cli::get_option_value(const char * option){
+	String arg = get_option_argument(option);
+	if( arg.empty() ){
+		return 0;
+	}
+	return arg.atoi();
+}
+
+pio_t Cli::get_option_pio(const char * option){
+	pio_t pio;
+	Token arg;
+	arg.assign(get_option_argument(option).c_str());
+	arg.parse(".");
+
+	if( arg.size() == 2 ){
+		pio.port = atoi(arg.at(0));
+		pio.pin = atoi(arg.at(1));
+	} else {
+		pio.port = 255;
+		pio.pin = 255;
+	}
+
+	return pio;
+}
+
+pio_t Cli::pio_at(u16 value){
+	pio_t pio;
+	Token arg;
+
+	arg.assign( at(value).c_str() );
+	arg.parse(".");
+
+	if( arg.size() == 2 ){
+		pio.port = atoi(arg.at(0));
+		pio.pin = atoi(arg.at(1));
+	} else {
+		pio.port = 255;
+		pio.pin = 255;
+	}
+
+	return pio;
+}
+
+int Cli::value_at(u16 value){
+	return at(value).atoi();
+}
+
+
+
+
+
+} /* namespace sys */