[WIP] Improve SCons AddOption option handling

SCons/Script/SConsOptions.py

@@ -359,43 +359,60 @@ def reparse_local_options(self):
         This would lead to further confusion, because we might want
         to add another option "--myarg" later on (see issue #2929).
 
+        The implementation proved to be problematic in the case of
+        space-separation (--arg opt) style, where the arg gets
+        separated from the opt. So now we try to figure out if there
+        are nargs and pop them off largs.
         """
         rargs = []
-        largs_restore = []
+        largs = []
         # Loop over all remaining arguments
         skip = False
-        for l in self.largs:
+
+        for idx, larg in enumerate(self.largs):
             if skip:
                 # Accept all remaining arguments as they are
-                largs_restore.append(l)
+                largs.append(larg)
             else:
-                if len(l) > 2 and l[0:2] == "--":
+                if len(larg) > 2 and larg[0:2] == "--":
                     # Check long option
-                    lopt = (l,)
-                    if "=" in l:
+                    if "=" in larg:
                         # Split into option and value
-                        lopt = l.split("=", 1)
+                        lopt = larg.split("=", 1)
+                    else:
+                        lopt = [larg]
 
                     if lopt[0] in self._long_opt:
                         # Argument is already known
-                        rargs.append('='.join(lopt))
+                        if len(lopt) > 1:
+                            # "--opt=arg" style, join it back up
+                            rargs.append('='.join(lopt))
+                        else:
+                            rargs.append(larg)
+                            # maybe "--opt arg" style, pull matching args
+                            option = self._long_opt[larg]
+                            if option.takes_value():
+                                for _ in range(option.nargs):
+                                    try:
+                                        rargs.append(self.largs.pop(idx + 1))
+                                    except IndexError:
+                                        # missing args, will be handled later
+                                        pass
                     else:
                         # Not known yet, so reject for now
-                        largs_restore.append('='.join(lopt))
+                        largs.append('='.join(lopt))
                 else:
-                    if l == "--" or l == "-":
+                    if larg in ("--", "-"):
                         # Stop normal processing and don't
                         # process the rest of the command-line opts
-                        largs_restore.append(l)
                         skip = True
-                    else:
-                        rargs.append(l)
+                    largs.append(larg)
 
         # Parse the filtered list
         self.parse_args(rargs, self.values)
         # Restore the list of remaining arguments for the
         # next call of AddOption/add_local_option...
-        self.largs = self.largs + largs_restore
+        self.largs = largs
 
     def add_local_option(self, *args, **kw):
         """

test/AddOption/args-and-targets.py

@@ -0,0 +1,61 @@
+#!/usr/bin/env python
+#
+# __COPYRIGHT__
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be included
+# in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
+# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+
+__revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"
+
+"""
+Verify that when an option is specified which takes args,
+those do not end up treated as targets.
+"""
+
+import TestSCons
+
+test = TestSCons.TestSCons()
+
+test.write('SConstruct', """\
+env = Environment()
+AddOption('--extra',
+          nargs=1,
+          dest='extra',
+          action='store',
+          type='string',
+          metavar='ARG1',
+          default=(),
+          help='An argument to the option')
+print(str(GetOption('extra')))
+print(COMMAND_LINE_TARGETS)
+""")
+
+# arg using =
+test.run('-Q -q --extra=A TARG', status=1, stdout="A\n['TARG']\n")
+# arg not using =
+test.run('-Q -q --extra A TARG', status=1, stdout="A\n['TARG']\n")
+
+test.pass_test()
+
+# Local Variables:
+# tab-width:4
+# indent-tabs-mode:nil
+# End:
+# vim: set expandtab tabstop=4 shiftwidth=4:

test/AddOption/multi-arg.py

@@ -0,0 +1,103 @@
+#!/usr/bin/env python
+#
+# __COPYRIGHT__
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be included
+# in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
+# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+
+__revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"
+
+"""
+Verify that when an option is specified with nargs > 1,
+SCons consumes those correctly into the args.
+"""
+
+import TestSCons
+
+test = TestSCons.TestSCons()
+
+# First, test an option with nargs=2 and no others:
+test.write('SConstruct', """\
+env = Environment()
+AddOption('--extras',
+          nargs=2,
+          dest='extras',
+          action='store',
+          type='string',
+          metavar='FILE1 FILE2',
+          default=(),
+          help='two extra files to install')
+print(str(GetOption('extras')))
+""")
+
+# no args
+test.run('-Q -q .', stdout="()\n")
+# one arg, should fail
+test.run('-Q -q . --extras A', status=2, stderr="""\
+usage: scons [OPTION] [TARGET] ...
+
+SCons Error: --extras option requires 2 arguments
+""")
+# two args
+test.run('-Q -q . --extras A B', status=1, stdout="('A', 'B')\n")
+# -- means the rest are not processed as args
+test.run('-Q -q . -- --extras A B', status=1, stdout="()\n")
+
+# Now test what has been a bug: another option is
+# also defined, this impacts the collection of args for the nargs>1 opt
+test.write('SConstruct', """\
+env = Environment()
+AddOption('--prefix',
+          nargs=1,
+          dest='prefix',
+          action='store',
+          type='string',
+          metavar='DIR',
+          help='installation prefix')
+AddOption('--extras',
+          nargs=2,
+          dest='extras',
+          action='store',
+          type='string',
+          metavar='FILE1 FILE2',
+          default=(),
+          help='two extra files to install')
+print(str(GetOption('prefix')))
+print(str(GetOption('extras')))
+""")
+
+# no options
+test.run('-Q -q .', stdout="None\n()\n")
+# one single-arg option
+test.run('-Q -q . --prefix=/home/foo', stdout="/home/foo\n()\n")
+# one two-arg option
+test.run('-Q -q . --extras A B', status=1, stdout="None\n('A', 'B')\n")
+# single-arg option followed by two-arg option
+test.run('-Q -q . --prefix=/home/foo --extras A B', status=1, stdout="/home/foo\n('A', 'B')\n")
+# two-arg option followed by single-arg option
+test.run('-Q -q . --extras A B --prefix=/home/foo', status=1, stdout="/home/foo\n('A', 'B')\n")
+
+test.pass_test()
+
+# Local Variables:
+# tab-width:4
+# indent-tabs-mode:nil
+# End:
+# vim: set expandtab tabstop=4 shiftwidth=4: