add option groups

Author: weisslj

Makefile

@@ -1,6 +1,6 @@
 ifdef ICC
 CXX = icpc
-WARN_FLAGS = -O3 -g -Wall -wd981 -wd383 -Werror # -Weffc++
+WARN_FLAGS = -O3 -ipo -g -Wall -wd981 -wd383 -Werror # -Weffc++
 else
 CXX = g++
 WARN_FLAGS = -O3 -g -Wall -Wextra -Wabi -Wctor-dtor-privacy -Wnon-virtual-dtor -Wreorder -Wstrict-null-sentinel -Woverloaded-virtual -Wshadow -Wcast-align -Wpointer-arith -Wwrite-strings -Wundef -Wredundant-decls -Werror # -Weffc++

OptionParser.cpp

@@ -59,7 +59,7 @@ static string str_replace(const string& s, const string& patt, const string& rep
   str_replace(tmp, patt, repl);
   return tmp;
 }
-static string str_format(const string& s, size_t pre, size_t len, bool indent_first) {
+static string str_format(const string& s, size_t pre, size_t len, bool indent_first = true) {
   stringstream ss;
   string p;
   if (indent_first)
@@ -150,6 +150,18 @@ Option& OptionParser::add_option(const vector<string>& v) {
   return option;
 }
 
+OptionParser& OptionParser::add_option_group(const OptionGroup& group) {
+  for (list<Option>::const_iterator oit = group._opts.begin(); oit != group._opts.end(); ++oit) {
+    const Option& option = *oit;
+    for (set<string>::const_iterator it = option._short_opts.begin(); it != option._short_opts.end(); ++it)
+      _optmap_s[*it] = &option;
+    for (set<string>::const_iterator it = option._long_opts.begin(); it != option._long_opts.end(); ++it)
+      _optmap_l[*it] = &option;
+  }
+  _groups.push_back(&group);
+  return *this;
+}
+
 const Option& OptionParser::lookup_short_opt(const string& opt) const {
   optMap::const_iterator it = _optmap_s.find(opt);
   if (it == _optmap_s.end())
@@ -321,15 +333,14 @@ void OptionParser::process_opt(const Option& o, const string& opt, const string&
   }
 }
 
-string OptionParser::format_option_help() const {
+string OptionParser::format_option_help(unsigned int indent /* = 2 */) const {
   stringstream ss;
 
   if (_opts.empty())
     return ss.str();
 
-  ss << _("Options") << ":" << endl;
   for (list<Option>::const_iterator it = _opts.begin(); it != _opts.end(); ++it) {
-    ss << it->format_help();
+    ss << it->format_help(indent);
   }
 
   return ss.str();
@@ -342,12 +353,21 @@ string OptionParser::format_help() const {
     ss << get_usage() << endl;
 
   if (description() != "")
-    ss << str_format(description(), 0, cols(), true) << endl;
+    ss << str_format(description(), 0, cols()) << endl;
 
+  ss << _("Options") << ":" << endl;
   ss << format_option_help();
 
+  for (list<OptionGroup const*>::const_iterator it = _groups.begin(); it != _groups.end(); ++it) {
+    const OptionGroup& group = **it;
+    ss << endl << "  " << group.title() << ":" << endl;
+    if (group.group_description() != "")
+      ss << str_format(group.group_description(), 4, cols()) << endl;
+    ss << group.format_option_help(4);
+  }
+
   if (epilog() != "")
-    ss << endl << str_format(epilog(), 0, cols(), true);
+    ss << endl << str_format(epilog(), 0, cols());
 
   return ss.str();
 }
@@ -438,21 +458,21 @@ string Option::check_type(const string& opt, const string& val) const {
   return err.str();
 }
 
-string Option::format_option_help() const {
+string Option::format_option_help(unsigned int indent /* = 2 */) const {
 
   string mvar_short, mvar_long;
   if (nargs() == 1) {
     string mvar = metavar();
     if (mvar == "") {
       mvar = type();
       transform(mvar.begin(), mvar.end(), mvar.begin(), ::toupper);
-    }
+     }
     mvar_short = " " + mvar;
     mvar_long = "=" + mvar;
   }
 
   stringstream ss;
-  ss << "  ";
+  ss << string(indent, ' ');
 
   if (not _short_opts.empty()) {
     ss << str_join_trans(", ", _short_opts.begin(), _short_opts.end(), str_wrap("-", mvar_short));
@@ -465,9 +485,9 @@ string Option::format_option_help() const {
   return ss.str();
 }
 
-string Option::format_help() const {
+string Option::format_help(unsigned int indent /* = 2 */) const {
   stringstream ss;
-  string h = format_option_help();
+  string h = format_option_help(indent);
   size_t width = cols();
   size_t opt_width = min(width*3/10, 36u);
   bool indent_first = false;

OptionParser.h

@@ -29,9 +29,7 @@
  * - similarity to Python desired for faster learning curve
  *
  * Future work:
- * - option groups
  * - nargs > 1?
- * - code simplification / cleanup
  * - comments?
  *
  * Python only features:
@@ -73,14 +71,15 @@
 namespace optparse {
 
 class OptionParser;
+class OptionGroup;
 class Option;
 class Values;
 class Value;
 class Callback;
 
 typedef std::map<std::string,std::string> strMap;
 typedef std::map<std::string,std::list<std::string> > lstMap;
-typedef std::map<std::string,Option*> optMap;
+typedef std::map<std::string,Option const*> optMap;
 
 //! Class for automatic conversion from string -> anytype
 class Value {
@@ -117,6 +116,7 @@ class Values {
 class OptionParser {
   public:
     OptionParser();
+    virtual ~OptionParser() {}
 
     OptionParser& usage(const std::string& u) { set_usage(u); return *this; }
     OptionParser& version(const std::string& v) { _version = v; return *this; }
@@ -130,6 +130,7 @@ class OptionParser {
     }
     OptionParser& enable_interspersed_args() { _interspersed_args = true; return *this; }
     OptionParser& disable_interspersed_args() { _interspersed_args = false; return *this; }
+    OptionParser& add_option_group(const OptionGroup& group);
 
     const std::string& usage() const { return _usage; }
     const std::string& version() const { return _version; }
@@ -158,7 +159,7 @@ class OptionParser {
     }
 
     std::string format_help() const;
-    std::string format_option_help() const;
+    std::string format_option_help(unsigned int indent = 2) const;
     void print_help() const;
 
     void set_usage(const std::string& u);
@@ -199,14 +200,33 @@ class OptionParser {
     optMap _optmap_s;
     optMap _optmap_l;
     strMap _defaults;
+    std::list<OptionGroup const*> _groups;
 
     std::list<std::string> _remaining;
     std::list<std::string> _leftover;
 };
 
+class OptionGroup : public OptionParser {
+  public:
+    OptionGroup(const OptionParser& p, const std::string& t, const std::string& d = "") :
+      _parser(p), _title(t), _group_description(d) {}
+    virtual ~OptionGroup() {}
+
+    OptionGroup& title(const std::string& t) { _title = t; return *this; }
+    OptionGroup& group_description(const std::string& d) { _group_description = d; return *this; }
+    const std::string& title() const { return _title; }
+    const std::string& group_description() const { return _group_description; }
+
+  private:
+    const OptionParser& _parser;
+    std::string _title;
+    std::string _group_description;
+};
+
 class Option {
   public:
     Option() : _action("store"), _type("string"), _nargs(1), _callback(0) {}
+    virtual ~Option() {}
 
     Option& action(const std::string& a);
     Option& type(const std::string& t) { _type = t; return *this; }
@@ -235,8 +255,8 @@ class Option {
 
   private:
     std::string check_type(const std::string& opt, const std::string& val) const;
-    std::string format_option_help() const;
-    std::string format_help() const;
+    std::string format_option_help(unsigned int indent = 2) const;
+    std::string format_help(unsigned int indent = 2) const;
 
     std::set<std::string> _short_opts;
     std::set<std::string> _long_opts;

README

@@ -28,8 +28,7 @@ Why not use tclap/Opag/Options/CmdLine/Anyoption/Argument_helper/...?
 - similarity to Python desired for faster learning curve
 
 Future work:
-- option groups
-- code simplification / cleanup
+- nargs > 1?
 - comments?
 
 

test.cpp

@@ -101,6 +101,12 @@ int main(int argc, char *argv[])
   MyCallback mc;
   parser.add_option("-K", "--callback") .action("callback") .callback(mc) .help("callback test");
 
+  OptionGroup group = OptionGroup(parser, "Dangerous Options",
+      "Caution: use these options at your own risk. "
+      "It is believed that some of them bite.");
+  group.add_option("-g") .action("store_true") .help("Group option.") .set_default("0");
+  parser.add_option_group(group);
+
   Values& options = parser.parse_args(argc, argv);
   vector<string> args = parser.args();
 
@@ -128,6 +134,7 @@ int main(int argc, char *argv[])
     for (Values::iterator it = options.all("more_milk").begin(); it != options.all("more_milk").end(); ++it)
       out(*it);
   }
+  cout << "group: " << (options.get("g") ? "true" : "false") << endl;
 
   cout << endl << "leftover arguments: " << endl;
   for (vector<string>::const_iterator it = args.begin(); it != args.end(); ++it) {