Merge pull request #3878 from hannes-steffenhagen-diffblue/feature-command_line_iterator

Add cmdlinet::option_names

Author: tautschnig

src/util/cmdline.cpp

@@ -247,3 +247,82 @@ bool cmdlinet::parse(int argc, const char **argv, const char *optstring)
 
   return false;
 }
+
+cmdlinet::option_namest cmdlinet::option_names() const
+{
+  return option_namest{*this};
+}
+
+cmdlinet::option_namest::option_names_iteratort::option_names_iteratort(
+  const cmdlinet *command_line,
+  std::size_t index)
+  : command_line(command_line), index(index)
+{
+  goto_next_valid_index();
+}
+
+cmdlinet::option_namest::option_names_iteratort &
+cmdlinet::option_namest::option_names_iteratort::operator++()
+{
+  PRECONDITION(command_line != nullptr);
+  ++index;
+  goto_next_valid_index();
+  return *this;
+}
+bool cmdlinet::option_namest::option_names_iteratort::is_valid_index() const
+{
+  PRECONDITION(command_line != nullptr);
+  auto const &options = command_line->options;
+  return index < options.size() && options[index].isset &&
+         options[index].islong;
+}
+
+void cmdlinet::option_namest::option_names_iteratort::goto_next_valid_index()
+{
+  PRECONDITION(command_line != nullptr);
+  while(index < command_line->options.size() && !is_valid_index())
+  {
+    ++index;
+  }
+}
+
+const cmdlinet::option_namest::option_names_iteratort
+cmdlinet::option_namest::option_names_iteratort::operator++(int dummy)
+{
+  return ++option_names_iteratort(*this);
+}
+
+const std::string &cmdlinet::option_namest::option_names_iteratort::operator*()
+{
+  PRECONDITION(command_line != nullptr);
+  return command_line->options.at(index).optstring;
+}
+
+bool cmdlinet::option_namest::option_names_iteratort::
+operator==(const cmdlinet::option_namest::option_names_iteratort &other)
+{
+  PRECONDITION(command_line != nullptr && command_line == other.command_line);
+  return index == other.index;
+}
+
+bool cmdlinet::option_namest::option_names_iteratort::
+operator!=(const cmdlinet::option_namest::option_names_iteratort &other)
+{
+  PRECONDITION(command_line != nullptr && command_line == other.command_line);
+  return index != other.index;
+}
+
+cmdlinet::option_namest::option_namest(const cmdlinet &command_line)
+  : command_line(command_line)
+{
+}
+
+cmdlinet::option_namest::option_names_iteratort cmdlinet::option_namest::begin()
+{
+  return option_names_iteratort(&command_line, 0);
+}
+
+cmdlinet::option_namest::option_names_iteratort cmdlinet::option_namest::end()
+{
+  return option_names_iteratort(&command_line, command_line.options.size());
+}

src/util/cmdline.h

@@ -10,9 +10,10 @@ Author: Daniel Kroening, [email protected]
 #ifndef CPROVER_UTIL_CMDLINE_H
 #define CPROVER_UTIL_CMDLINE_H
 
-#include <vector>
+#include <limits>
 #include <list>
 #include <string>
+#include <vector>
 
 #include "optional.h"
 
@@ -40,6 +41,46 @@ class cmdlinet
     return getoptnr(option).has_value();
   }
 
+  struct option_namest
+  {
+    explicit option_namest(const cmdlinet &command_line);
+    struct option_names_iteratort
+      : public std::iterator<std::forward_iterator_tag, std::string>
+    {
+      option_names_iteratort() = default;
+      explicit option_names_iteratort(
+        const cmdlinet *command_line,
+        std::size_t index);
+      option_names_iteratort(const option_names_iteratort &other) = default;
+      option_names_iteratort(option_names_iteratort &&other) = default;
+      option_names_iteratort &
+      operator=(const option_names_iteratort &) = default;
+      option_names_iteratort &operator=(option_names_iteratort &&) = default;
+
+      option_names_iteratort &operator++();
+      const option_names_iteratort operator++(int);
+      const std::string &operator*();
+
+      bool operator==(const option_names_iteratort &other);
+      bool operator!=(const option_names_iteratort &other);
+
+    private:
+      const cmdlinet *command_line = nullptr;
+      std::size_t index = std::numeric_limits<std::size_t>::max();
+      bool is_valid_index() const;
+      void goto_next_valid_index();
+    };
+    option_names_iteratort begin();
+    option_names_iteratort end();
+
+  private:
+    const cmdlinet &command_line;
+  };
+
+  /// Pseudo-object that can be used to iterate over
+  /// options in this cmdlinet (should not outlive this)
+  option_namest option_names() const;
+
   typedef std::vector<std::string> argst;
   argst args;
   std::string unknown_arg;

unit/util/cmdline.cpp

@@ -6,6 +6,7 @@ Author: Diffblue Ltd.
 
 \*******************************************************************/
 
+#include <array>
 #include <testing-utils/use_catch.h>
 #include <util/cmdline.h>
 
@@ -17,3 +18,28 @@ TEST_CASE("cmdlinet::has_option", "[core][util][cmdline]")
   REQUIRE(cmdline.has_option("b"));
   REQUIRE(!cmdline.has_option("c"));
 }
+
+TEST_CASE("cmdline::option_names", "[core][util][cmdline]")
+{
+  cmdlinet cmdline;
+  std::array<const char *, 5> args = {
+    {"-f", "--a", "--b", "--c-with-arg", "c-arg"}};
+  REQUIRE(!cmdline.parse(
+    args.size(),
+    args.data(),
+    "?f"
+    "(a)"
+    "(b)"
+    "(c-with-arg):"
+    "(notset)"));
+  auto option_names = std::vector<std::string>{};
+  for(auto const &option_name : cmdline.option_names())
+  {
+    option_names.push_back(option_name);
+  }
+  REQUIRE(option_names.size() == 3);
+  REQUIRE(option_names[0] == "a");
+  REQUIRE(option_names[1] == "b");
+  REQUIRE(option_names[2] == "c-with-arg");
+  REQUIRE(cmdline.get_value(option_names[2].c_str()) == "c-arg");
+}