From 24adee85717a9bc61013b6b12fd81135d856d33d Mon Sep 17 00:00:00 2001
From: Karen Arutyunov <karen@codesynthesis.com>
Date: Fri, 18 Feb 2022 16:20:27 +0300
Subject: Factor out common CLI types (scanners, etc)

---
 libbuild2/script/builtin-options.hxx | 366 +++++------------------------------
 1 file changed, 47 insertions(+), 319 deletions(-)

(limited to 'libbuild2/script/builtin-options.hxx')

diff --git a/libbuild2/script/builtin-options.hxx b/libbuild2/script/builtin-options.hxx
index d665279..9089d46 100644
--- a/libbuild2/script/builtin-options.hxx
+++ b/libbuild2/script/builtin-options.hxx
@@ -12,282 +12,10 @@
 //
 // End prologue.
 
-#include <vector>
-#include <iosfwd>
-#include <string>
-#include <cstddef>
-#include <exception>
-
-#ifndef CLI_POTENTIALLY_UNUSED
-#  if defined(_MSC_VER) || defined(__xlC__)
-#    define CLI_POTENTIALLY_UNUSED(x) (void*)&x
-#  else
-#    define CLI_POTENTIALLY_UNUSED(x) (void)x
-#  endif
-#endif
-
-namespace build2
-{
-  namespace script
-  {
-    namespace cli
-    {
-      class unknown_mode
-      {
-        public:
-        enum value
-        {
-          skip,
-          stop,
-          fail
-        };
-
-        unknown_mode (value);
-
-        operator value () const 
-        {
-          return v_;
-        }
-
-        private:
-        value v_;
-      };
-
-      // Exceptions.
-      //
-
-      class exception: public std::exception
-      {
-        public:
-        virtual void
-        print (::std::ostream&) const = 0;
-      };
-
-      ::std::ostream&
-      operator<< (::std::ostream&, const exception&);
-
-      class unknown_option: public exception
-      {
-        public:
-        virtual
-        ~unknown_option () throw ();
-
-        unknown_option (const std::string& option);
-
-        const std::string&
-        option () const;
-
-        virtual void
-        print (::std::ostream&) const;
-
-        virtual const char*
-        what () const throw ();
-
-        private:
-        std::string option_;
-      };
-
-      class unknown_argument: public exception
-      {
-        public:
-        virtual
-        ~unknown_argument () throw ();
-
-        unknown_argument (const std::string& argument);
-
-        const std::string&
-        argument () const;
-
-        virtual void
-        print (::std::ostream&) const;
-
-        virtual const char*
-        what () const throw ();
-
-        private:
-        std::string argument_;
-      };
-
-      class missing_value: public exception
-      {
-        public:
-        virtual
-        ~missing_value () throw ();
-
-        missing_value (const std::string& option);
-
-        const std::string&
-        option () const;
-
-        virtual void
-        print (::std::ostream&) const;
-
-        virtual const char*
-        what () const throw ();
-
-        private:
-        std::string option_;
-      };
-
-      class invalid_value: public exception
-      {
-        public:
-        virtual
-        ~invalid_value () throw ();
-
-        invalid_value (const std::string& option,
-                       const std::string& value,
-                       const std::string& message = std::string ());
-
-        const std::string&
-        option () const;
-
-        const std::string&
-        value () const;
-
-        const std::string&
-        message () const;
-
-        virtual void
-        print (::std::ostream&) const;
-
-        virtual const char*
-        what () const throw ();
-
-        private:
-        std::string option_;
-        std::string value_;
-        std::string message_;
-      };
-
-      class eos_reached: public exception
-      {
-        public:
-        virtual void
-        print (::std::ostream&) const;
-
-        virtual const char*
-        what () const throw ();
-      };
-
-      // Command line argument scanner interface.
-      //
-      // The values returned by next() are guaranteed to be valid
-      // for the two previous arguments up until a call to a third
-      // peek() or next().
-      //
-      // The position() function returns a monotonically-increasing
-      // number which, if stored, can later be used to determine the
-      // relative position of the argument returned by the following
-      // call to next(). Note that if multiple scanners are used to
-      // extract arguments from multiple sources, then the end
-      // position of the previous scanner should be used as the
-      // start position of the next.
-      //
-      class scanner
-      {
-        public:
-        virtual
-        ~scanner ();
-
-        virtual bool
-        more () = 0;
-
-        virtual const char*
-        peek () = 0;
-
-        virtual const char*
-        next () = 0;
-
-        virtual void
-        skip () = 0;
-
-        virtual std::size_t
-        position () = 0;
-      };
-
-      class argv_scanner: public scanner
-      {
-        public:
-        argv_scanner (int& argc,
-                      char** argv,
-                      bool erase = false,
-                      std::size_t start_position = 0);
-
-        argv_scanner (int start,
-                      int& argc,
-                      char** argv,
-                      bool erase = false,
-                      std::size_t start_position = 0);
-
-        int
-        end () const;
-
-        virtual bool
-        more ();
-
-        virtual const char*
-        peek ();
-
-        virtual const char*
-        next ();
-
-        virtual void
-        skip ();
-
-        virtual std::size_t
-        position ();
-
-        protected:
-        std::size_t start_position_;
-        int i_;
-        int& argc_;
-        char** argv_;
-        bool erase_;
-      };
-
-      class vector_scanner: public scanner
-      {
-        public:
-        vector_scanner (const std::vector<std::string>&,
-                        std::size_t start = 0,
-                        std::size_t start_position = 0);
-
-        std::size_t
-        end () const;
-
-        void
-        reset (std::size_t start = 0, std::size_t start_position = 0);
-
-        virtual bool
-        more ();
-
-        virtual const char*
-        peek ();
-
-        virtual const char*
-        next ();
-
-        virtual void
-        skip ();
-
-        virtual std::size_t
-        position ();
-
-        private:
-        std::size_t start_position_;
-        const std::vector<std::string>& v_;
-        std::size_t i_;
-      };
-
-      template <typename X>
-      struct parser;
-    }
-  }
-}
-
 #include <libbuild2/types.hxx>
 
+#include <libbuild2/common-options.hxx>
+
 namespace build2
 {
   namespace script
@@ -300,34 +28,34 @@ namespace build2
       set_options (int& argc,
                    char** argv,
                    bool erase = false,
-                   ::build2::script::cli::unknown_mode option = ::build2::script::cli::unknown_mode::fail,
-                   ::build2::script::cli::unknown_mode argument = ::build2::script::cli::unknown_mode::stop);
+                   ::build2::build::cli::unknown_mode option = ::build2::build::cli::unknown_mode::fail,
+                   ::build2::build::cli::unknown_mode argument = ::build2::build::cli::unknown_mode::stop);
 
       set_options (int start,
                    int& argc,
                    char** argv,
                    bool erase = false,
-                   ::build2::script::cli::unknown_mode option = ::build2::script::cli::unknown_mode::fail,
-                   ::build2::script::cli::unknown_mode argument = ::build2::script::cli::unknown_mode::stop);
+                   ::build2::build::cli::unknown_mode option = ::build2::build::cli::unknown_mode::fail,
+                   ::build2::build::cli::unknown_mode argument = ::build2::build::cli::unknown_mode::stop);
 
       set_options (int& argc,
                    char** argv,
                    int& end,
                    bool erase = false,
-                   ::build2::script::cli::unknown_mode option = ::build2::script::cli::unknown_mode::fail,
-                   ::build2::script::cli::unknown_mode argument = ::build2::script::cli::unknown_mode::stop);
+                   ::build2::build::cli::unknown_mode option = ::build2::build::cli::unknown_mode::fail,
+                   ::build2::build::cli::unknown_mode argument = ::build2::build::cli::unknown_mode::stop);
 
       set_options (int start,
                    int& argc,
                    char** argv,
                    int& end,
                    bool erase = false,
-                   ::build2::script::cli::unknown_mode option = ::build2::script::cli::unknown_mode::fail,
-                   ::build2::script::cli::unknown_mode argument = ::build2::script::cli::unknown_mode::stop);
+                   ::build2::build::cli::unknown_mode option = ::build2::build::cli::unknown_mode::fail,
+                   ::build2::build::cli::unknown_mode argument = ::build2::build::cli::unknown_mode::stop);
 
-      set_options (::build2::script::cli::scanner&,
-                   ::build2::script::cli::unknown_mode option = ::build2::script::cli::unknown_mode::fail,
-                   ::build2::script::cli::unknown_mode argument = ::build2::script::cli::unknown_mode::stop);
+      set_options (::build2::build::cli::scanner&,
+                   ::build2::build::cli::unknown_mode option = ::build2::build::cli::unknown_mode::fail,
+                   ::build2::build::cli::unknown_mode argument = ::build2::build::cli::unknown_mode::stop);
 
       // Option accessors and modifiers.
       //
@@ -362,13 +90,13 @@ namespace build2
       //
       protected:
       bool
-      _parse (const char*, ::build2::script::cli::scanner&);
+      _parse (const char*, ::build2::build::cli::scanner&);
 
       private:
       bool
-      _parse (::build2::script::cli::scanner&,
-              ::build2::script::cli::unknown_mode option,
-              ::build2::script::cli::unknown_mode argument);
+      _parse (::build2::build::cli::scanner&,
+              ::build2::build::cli::unknown_mode option,
+              ::build2::build::cli::unknown_mode argument);
 
       public:
       bool exact_;
@@ -384,34 +112,34 @@ namespace build2
       timeout_options (int& argc,
                        char** argv,
                        bool erase = false,
-                       ::build2::script::cli::unknown_mode option = ::build2::script::cli::unknown_mode::fail,
-                       ::build2::script::cli::unknown_mode argument = ::build2::script::cli::unknown_mode::stop);
+                       ::build2::build::cli::unknown_mode option = ::build2::build::cli::unknown_mode::fail,
+                       ::build2::build::cli::unknown_mode argument = ::build2::build::cli::unknown_mode::stop);
 
       timeout_options (int start,
                        int& argc,
                        char** argv,
                        bool erase = false,
-                       ::build2::script::cli::unknown_mode option = ::build2::script::cli::unknown_mode::fail,
-                       ::build2::script::cli::unknown_mode argument = ::build2::script::cli::unknown_mode::stop);
+                       ::build2::build::cli::unknown_mode option = ::build2::build::cli::unknown_mode::fail,
+                       ::build2::build::cli::unknown_mode argument = ::build2::build::cli::unknown_mode::stop);
 
       timeout_options (int& argc,
                        char** argv,
                        int& end,
                        bool erase = false,
-                       ::build2::script::cli::unknown_mode option = ::build2::script::cli::unknown_mode::fail,
-                       ::build2::script::cli::unknown_mode argument = ::build2::script::cli::unknown_mode::stop);
+                       ::build2::build::cli::unknown_mode option = ::build2::build::cli::unknown_mode::fail,
+                       ::build2::build::cli::unknown_mode argument = ::build2::build::cli::unknown_mode::stop);
 
       timeout_options (int start,
                        int& argc,
                        char** argv,
                        int& end,
                        bool erase = false,
-                       ::build2::script::cli::unknown_mode option = ::build2::script::cli::unknown_mode::fail,
-                       ::build2::script::cli::unknown_mode argument = ::build2::script::cli::unknown_mode::stop);
+                       ::build2::build::cli::unknown_mode option = ::build2::build::cli::unknown_mode::fail,
+                       ::build2::build::cli::unknown_mode argument = ::build2::build::cli::unknown_mode::stop);
 
-      timeout_options (::build2::script::cli::scanner&,
-                       ::build2::script::cli::unknown_mode option = ::build2::script::cli::unknown_mode::fail,
-                       ::build2::script::cli::unknown_mode argument = ::build2::script::cli::unknown_mode::stop);
+      timeout_options (::build2::build::cli::scanner&,
+                       ::build2::build::cli::unknown_mode option = ::build2::build::cli::unknown_mode::fail,
+                       ::build2::build::cli::unknown_mode argument = ::build2::build::cli::unknown_mode::stop);
 
       // Option accessors and modifiers.
       //
@@ -428,13 +156,13 @@ namespace build2
       //
       protected:
       bool
-      _parse (const char*, ::build2::script::cli::scanner&);
+      _parse (const char*, ::build2::build::cli::scanner&);
 
       private:
       bool
-      _parse (::build2::script::cli::scanner&,
-              ::build2::script::cli::unknown_mode option,
-              ::build2::script::cli::unknown_mode argument);
+      _parse (::build2::build::cli::scanner&,
+              ::build2::build::cli::unknown_mode option,
+              ::build2::build::cli::unknown_mode argument);
 
       public:
       bool success_;
@@ -448,34 +176,34 @@ namespace build2
       export_options (int& argc,
                       char** argv,
                       bool erase = false,
-                      ::build2::script::cli::unknown_mode option = ::build2::script::cli::unknown_mode::fail,
-                      ::build2::script::cli::unknown_mode argument = ::build2::script::cli::unknown_mode::stop);
+                      ::build2::build::cli::unknown_mode option = ::build2::build::cli::unknown_mode::fail,
+                      ::build2::build::cli::unknown_mode argument = ::build2::build::cli::unknown_mode::stop);
 
       export_options (int start,
                       int& argc,
                       char** argv,
                       bool erase = false,
-                      ::build2::script::cli::unknown_mode option = ::build2::script::cli::unknown_mode::fail,
-                      ::build2::script::cli::unknown_mode argument = ::build2::script::cli::unknown_mode::stop);
+                      ::build2::build::cli::unknown_mode option = ::build2::build::cli::unknown_mode::fail,
+                      ::build2::build::cli::unknown_mode argument = ::build2::build::cli::unknown_mode::stop);
 
       export_options (int& argc,
                       char** argv,
                       int& end,
                       bool erase = false,
-                      ::build2::script::cli::unknown_mode option = ::build2::script::cli::unknown_mode::fail,
-                      ::build2::script::cli::unknown_mode argument = ::build2::script::cli::unknown_mode::stop);
+                      ::build2::build::cli::unknown_mode option = ::build2::build::cli::unknown_mode::fail,
+                      ::build2::build::cli::unknown_mode argument = ::build2::build::cli::unknown_mode::stop);
 
       export_options (int start,
                       int& argc,
                       char** argv,
                       int& end,
                       bool erase = false,
-                      ::build2::script::cli::unknown_mode option = ::build2::script::cli::unknown_mode::fail,
-                      ::build2::script::cli::unknown_mode argument = ::build2::script::cli::unknown_mode::stop);
+                      ::build2::build::cli::unknown_mode option = ::build2::build::cli::unknown_mode::fail,
+                      ::build2::build::cli::unknown_mode argument = ::build2::build::cli::unknown_mode::stop);
 
-      export_options (::build2::script::cli::scanner&,
-                      ::build2::script::cli::unknown_mode option = ::build2::script::cli::unknown_mode::fail,
-                      ::build2::script::cli::unknown_mode argument = ::build2::script::cli::unknown_mode::stop);
+      export_options (::build2::build::cli::scanner&,
+                      ::build2::build::cli::unknown_mode option = ::build2::build::cli::unknown_mode::fail,
+                      ::build2::build::cli::unknown_mode argument = ::build2::build::cli::unknown_mode::stop);
 
       // Option accessors and modifiers.
       //
@@ -513,13 +241,13 @@ namespace build2
       //
       protected:
       bool
-      _parse (const char*, ::build2::script::cli::scanner&);
+      _parse (const char*, ::build2::build::cli::scanner&);
 
       private:
       bool
-      _parse (::build2::script::cli::scanner&,
-              ::build2::script::cli::unknown_mode option,
-              ::build2::script::cli::unknown_mode argument);
+      _parse (::build2::build::cli::scanner&,
+              ::build2::build::cli::unknown_mode option,
+              ::build2::build::cli::unknown_mode argument);
 
       public:
       vector<string> unset_;
-- 
cgit v1.1