Remove warnings
[anna.git] / include / anna / core / util / CommandLine.hpp
index a869f4e..6cd4c78 100644 (file)
@@ -1,37 +1,9 @@
-// ANNA - Anna is Not Nothingness Anymore
-//
-// (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
-//
-// http://redmine.teslayout.com/projects/anna-suite
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions
-// are met:
-//
-//     * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-//     * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-//     *  Neither the name of the copyright holder nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-//
-// Authors: eduardo.ramos.testillano@gmail.com
-//          cisco.tierra@gmail.com
+// ANNA - Anna is Not Nothingness Anymore                                                         //
+//                                                                                                //
+// (c) Copyright 2005-2015 Eduardo Ramos Testillano & Francisco Ruiz Rayo                         //
+//                                                                                                //
+// See project site at http://redmine.teslayout.com/projects/anna-suite                           //
+// See accompanying file LICENSE or copy at http://www.teslayout.com/projects/public/anna.LICENSE //
 
 
 #ifndef anna_core_util_CommandLine_hpp
@@ -94,12 +66,11 @@ public:
 
      @param argv Conjunto de cadenas que se reciben de la linea de comandos.
      @param argc Numero de cadenas recibidas.
+     @param positionalArguments Enables positional arguments. An offset will be applied to start command-line interpretation.
+     These positional arguments are mandatory, and the user could retrieve their values through #getPositional. By default no
+     positional arguments are specified.
   */
-  void initialize(const char** argv, const int argc) throw() {
-    a_argv = argv;
-    a_argc = argc;
-    a_wasParsed = false;
-  }
+  void initialize(const char** argv, const int argc, int positionalArguments = 0) throw(RuntimeException);
 
   /**
      Register an argument name in our application
@@ -113,6 +84,19 @@ public:
    */
   void add(const char* argumentExpression, Argument::Type type, const char* comment, const bool needValue = true) throw();
 
+  /**
+     Gets a positional argument. There must be registered or NULL will be returned.
+
+     @param position Argument position from 1 to N
+
+     @return Value of mandatory positional argument with position provided
+  */
+  const char *getPositional(int position) const throw() {
+    const char *result = NULL;
+    if ((position > 0) && (position <= a_positionalArguments)) result = a_argv[position];
+    return result;
+  }
+
   /**
      Obtiene el valor asociado al argumento recibido como parametro.
      El valor devuelto puede ser NULL en caso de que el argumento no sea
@@ -209,19 +193,20 @@ private:
 
   protected:
     std::string a_name1, a_name2;
-    const char* a_comment;
-    char* a_value;
     Argument::Type a_type;
+    const char* a_comment;
     bool a_needValue;
     bool a_isOn;
+    char* a_value;
   };
 
   const char **a_argv;
   int a_argc;
   bool a_wasParsed;
   std::vector <Variable*> a_arguments;
+  int a_positionalArguments;
 
-  CommandLine() : a_argv(NULL), a_argc(0)  {;}
+  CommandLine() : a_argv(NULL), a_argc(0), a_positionalArguments(0)  {;}
 
   bool analize() throw();
   const Variable* search(const char *argumentExpression) const throw();