Changeset 980

Timestamp:

Oct 22, 2007, 2:55:19 AM (15 years ago)

Author:

Peter

Message:

adding possibility to make option required

Location:

trunk

Files:

• test/commandline_test.cc (modified) (1 diff)
• yat/utility/Option.cc (modified) (2 diffs)
• yat/utility/Option.h (modified) (2 diffs)
• yat/utility/OptionArg.h (modified) (5 diffs)
• yat/utility/OptionFile.cc (modified) (2 diffs)
• yat/utility/OptionFile.h (modified) (1 diff)

trunk/test/commandline_test.cc

@@ -340 +340 @@
     }
   }
+
+
+  error << "Testing OptionArg required ...";
+  {
+    OptionArg<std::string> required(cmd, "required", "required", true); 
+    int ac = 1;
+    char* av[] = { "test_prog" };
+    try{
+      cmd.parse(ac,av);
+      error << "failed\n";
+      ok =false;
+    }
+    catch (...) {
+      error << "ok\n";
+    }
+  }
+
+
   return ok;
 }

trunk/yat/utility/Option.cc

@@ -36 +36 @@
 
   Option::Option(CommandLine& cmd, std::string flag, std::string desc)
-    : description_(desc), present_(false)
+    : cmd_(cmd), description_(desc), present_(false)
   {
     if (flag.empty())
@@ -58 +58 @@
   Option::~Option(void)
   {
+  }
+
+
+  const CommandLine& Option::cmd(void) const
+  {
+    return cmd_;
   }
 

trunk/yat/utility/Option.h

@@ -99 +99 @@
     void validate(void);
 
+  protected:
+    /**
+       \return const reference to CommandLine Option belongs to. 
+     */
+    const CommandLine& cmd(void) const;
+
   private:
     virtual void do_parse(std::vector<std::string>::iterator, 
@@ -124 +130 @@
 
 
+    const CommandLine& cmd_;
     std::string description_;
     std::string long_name_;

trunk/yat/utility/OptionArg.h

@@ -26 +26 @@
 
 #include "Option.h"
+#include "CommandLine.h"
 
 #include <stdexcept>
@@ -56 +57 @@
        "h,help" for having both short and long option name
        \param desc string used in help display
+       \param required If true option must be found in commandline or
+       exception is thrown in validation
     */
-    OptionArg(CommandLine& cmd, std::string name, std::string desc)
-      : Option(cmd, name, desc) {}
+    OptionArg(CommandLine& cmd, std::string name, std::string desc,
+              bool required=false)
+      : Option(cmd, name, desc), required_(required) {}
 
     /**
@@ -65 +69 @@
     T value(void) const { return value_; }
 
+  protected:
+    inline bool required(void) const { return required_; }
+
   private:
-    T def_;
+    bool required_;
     T value_;
 
@@ -73 +80 @@
     {
       if ( first->size()>2 && (*first)[0]=='-' && (*first)[1]!='-'){
-        std::string str("option requires an argument -- ");
-        str += short_name();
-        throw std::runtime_error(str);
+        std::stringstream ss;
+        ss << "option requires an argument -- " << short_name() << "\n"
+           << cmd().try_help();
+        throw std::runtime_error(ss.str());
       }
       if (first+1==last ) {
         if (first->size()>2){
           std::stringstream ss;
-          ss << "option `--" << long_name() << "' requires an argument";
+          ss << "option `--" << long_name() << "' requires an argument\n"
+             << cmd().try_help();
           throw std::runtime_error(ss.str());
         }
         else {
-          std::string str("option requires an argument -- ");
-          str += short_name();
-          throw std::runtime_error(str);
+          std::stringstream ss;
+          ss << "option requires an argument -- " << short_name() << "\n"
+             << cmd().try_help();
+          throw std::runtime_error(ss.str());
         }
       }       
@@ -117 +127 @@
     /**
      */
-    virtual void do_validate(void) const {}
+    void do_validate(void) const 
+    {
+      if (required_ && !present()) {
+        std::stringstream ss;
+        ss << "mandatory opition `";
+        if (long_name().size())
+          ss << long_name();
+        else
+          ss << short_name();
+        ss << "' not given\n";
+        ss << cmd().try_help();
+        throw std::runtime_error(ss.str());
+      }
+      do_validate2();
+    }
 
+
+    virtual void do_validate2(void) const {}
   };
 

trunk/yat/utility/OptionFile.cc

@@ -25 +25 @@
 #include "FileUtil.h"
 
+#include <stdexcept>
 #include <string>
 
@@ -32 +33 @@
 
 
-  OptionFile::OptionFile(CommandLine& cmd, std::string flag, 
-                         std::string desc, bool exist, std::string bits)
-    : OptionArg<std::string>(cmd, flag, desc), exist_(exist), bits_(bits)
-  {
-  }
+  OptionFile::OptionFile(CommandLine& cmd, std::string flag, std::string desc, 
+                         bool required, bool exist, std::string bits)
+    : OptionArg<std::string>(cmd, flag, desc, required), exist_(exist), 
+      bits_(bits) {}
 
 
-  void OptionFile::do_validate() const
+  void OptionFile::do_validate2() const
   {   
     if (!present())

trunk/yat/utility/OptionFile.h

@@ -47 +47 @@
        "f,file" for having both short and long option name
        \param desc string used in help display
+       \param required If true option must be found in commandline or
+       exception is thrown in validation
        \param exist if true File must exist
        \param bits used to check permission on file, see
        FileUtil
     */
-    OptionFile(CommandLine& cmd, std::string name, 
-               std::string desc, bool exist=false, std::string bits=""); 
+    OptionFile(CommandLine& cmd, std::string name, std::string desc, 
+               bool required=false, bool exist=false, std::string bits=""); 
 
 
   private:
-    void do_validate() const;
+    void do_validate2() const;
 
     bool exist_;