Changeset 2406:0ffc78641b34 in lemon-0.x for lemon/arg_parser.h

Timestamp:

03/13/07 13:33:40 (17 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@3237

Message:

Better doc.

File:

• lemon/arg_parser.h (modified) (9 diffs)

lemon/arg_parser.h

@@ -27 +27 @@
 #include <sstream>
 #include <algorithm>
+#include <lemon/error.h>
 
 ///\ingroup misc
@@ -152 +153 @@
                       std::string value="", bool obl=false);
     
-
-
-
-    ///Add a new integer type option
-
-    ///\param name The name of the option. The leading '-' must be omitted.
-    ///\param help A help string.
-    ///\retval value The value of the argument will be written to this variable.
-    ///\param obl Indicate if the option is mandatory.
-    ArgParser &refOption(const std::string &name,
-                    const std::string &help,
-                    int &value, bool obl=false);
-
-    ///Add a new floating type option
-
-    ///\param name The name of the option. The leading '-' must be omitted.
-    ///\param help A help string.
-    ///\retval value The value of the argument will be written to this variable.
-    ///\param obl Indicate if the option is mandatory.
-    ArgParser &refOption(const std::string &name,
-                      const std::string &help,
-                      double &value, bool obl=false);
-
-    ///Add a new bool type option
-
-    ///\param name The name of the option. The leading '-' must be omitted.
-    ///\param help A help string.
-    ///\retval value The value of the argument will be written to this variable.
-    ///\param obl Indicate if the option is mandatory.
-    ////\note A mandatory bool obtion is of very little use.)
-    ArgParser &refOption(const std::string &name,
-                      const std::string &help,
-                      bool &value, bool obl=false);
-
-    ///Add a new string type option
-
-    ///\param name The name of the option. The leading '-' must be omitted.
-    ///\param help A help string.
-    ///\retval value The value of the argument will be written to this variable.
-    ///\param obl Indicate if the option is mandatory.
-    ArgParser &refOption(const std::string &name,
-                      const std::string &help,
-                      std::string &value, bool obl=false);
-    
     ///Bind a function to an option.
 
@@ -203 +160 @@
     ///  must be of type "void f(void *)"
     ///\param data Data to be passed to \c func
+    ArgParser &funcOption(const std::string &name,
+                    const std::string &help,
+                    void (*func)(void *),void *data);
+
+    ///\name Options with an external strorage.
+    ///Using this functions, the value of the option will be directly written
+    ///into a variable once the option appears in the command line.
+
+    ///@{
+
+    ///Add a new integer type option with a storage reference
+
+    ///\param name The name of the option. The leading '-' must be omitted.
+    ///\param help A help string.
+    ///\retval ref The value of the argument will be written to this variable.
+    ///\param obl Indicate if the option is mandatory.
     ArgParser &refOption(const std::string &name,
                     const std::string &help,
-                    void (*func)(void *),void *data);
+                    int &ref, bool obl=false);
+
+    ///Add a new floating type option with a storage reference
+
+    ///\param name The name of the option. The leading '-' must be omitted.
+    ///\param help A help string.
+    ///\retval ref The value of the argument will be written to this variable.
+    ///\param obl Indicate if the option is mandatory.
+    ArgParser &refOption(const std::string &name,
+                      const std::string &help,
+                      double &ref, bool obl=false);
+
+    ///Add a new bool type option with a storage reference
+
+    ///\param name The name of the option. The leading '-' must be omitted.
+    ///\param help A help string.
+    ///\retval ref The value of the argument will be written to this variable.
+    ///\param obl Indicate if the option is mandatory.
+    ////\note A mandatory bool obtion is of very little use.)
+    ArgParser &refOption(const std::string &name,
+                      const std::string &help,
+                      bool &ref, bool obl=false);
+
+    ///Add a new string type option with a storage reference
+
+    ///\param name The name of the option. The leading '-' must be omitted.
+    ///\param help A help string.
+    ///\retval ref The value of the argument will be written to this variable.
+    ///\param obl Indicate if the option is mandatory.
+    ArgParser &refOption(const std::string &name,
+                      const std::string &help,
+                      std::string &ref, bool obl=false);
+    
+    ///@}
+
+    ///\name Option Groups and Synonyms
+    ///
+    
+    ///@{
 
     ///Boundle some options into a group
@@ -222 +233 @@
     ArgParser &onlyOneGroup(const std::string &group);
   
+    ///Make a group mandatory
+
+    ///Using this function, at least one of the members of \c group
+    ///must be given.
+    ArgParser &mandatoryGroup(const std::string &group);
+    
     ///Create synonym to an option
 
@@ -229 +246 @@
                            const std::string &opt);
     
-    ///Make a group mandatory
-
-    ///Using this function, at least one of the members of \c group
-    ///must be given.
-    ArgParser &mandatoryGroup(const std::string &group);
-    
+    ///@}
+
     ///Give help string for non-parsed arguments.
 
@@ -264 +277 @@
     void checkMandatories();
     
-    ///\e
+    ///Start the parsing process
     ArgParser &parse();
 
@@ -281 +294 @@
 
 
+    ///Magic type for operator[]
+    
+    ///This is the type of the return value of ArgParser::operator[]().
+    ///It automatically converts to int, double, bool or std::string, if it
+    ///match the type of the option, otherwise it throws an exception.
+    ///(i.e. it performs runtime type checking).
     class RefType 
     {
@@ -286 +305 @@
       std::string _name;
     public:
+      ///\e
       RefType(ArgParser &p,const std::string &n) :_parser(p),_name(n) {}
+      ///\e
       operator bool() 
       {
         Opts::iterator i = _parser._opts.find(_name);
-        if(i==_parser._opts.end()) exit(3); ///\todo throw exception instead
-        else if(i->second.type!=ArgParser::BOOL) exit(3);
+        if(i==_parser._opts.end()) throw LogicError();
+        else if(i->second.type!=ArgParser::BOOL)
+          throw LogicError();
         else return *(i->second.bool_p);
       }
+      ///\e
       operator std::string()
       {
         Opts::iterator i = _parser._opts.find(_name);
-        if(i==_parser._opts.end()) exit(3); ///\todo throw exception instead
-        else if(i->second.type!=ArgParser::STRING) exit(3);
+        if(i==_parser._opts.end()) throw LogicError();
+        else if(i->second.type!=ArgParser::STRING)
+          throw LogicError();
         else return *(i->second.string_p);
       }
+      ///\e
       operator double() 
       {
         Opts::iterator i = _parser._opts.find(_name);
-        if(i==_parser._opts.end()) exit(3); ///\todo throw exception instead
-        else if(i->second.type!=ArgParser::DOUBLE) exit(3);
+        if(i==_parser._opts.end()) throw LogicError();
+        else if(i->second.type!=ArgParser::DOUBLE) 
+          throw LogicError();
         else return *(i->second.double_p);
       }
+      ///\e
       operator int() 
       {
         Opts::iterator i = _parser._opts.find(_name);
-        if(i==_parser._opts.end()) exit(3); ///\todo throw exception instead
-        else if(i->second.type!=ArgParser::INTEGER) exit(3);
+        if(i==_parser._opts.end()) throw LogicError();
+        else if(i->second.type!=ArgParser::INTEGER)
+          throw LogicError();
         else return *(i->second.int_p);
       }
@@ -318 +346 @@
     };
 
+    ///Give back the value of an option
+    
+    ///Give back the value of an option
+    ///\sa RefType
     RefType operator[](const std::string &n)
     {
       return RefType(*this, n);
-    }
-    
-      
+    }    
+ 
   };
 }