SConsOptions.py.svn-base
上传用户:market2
上传日期:2018-11-18
资源大小:18786k
文件大小:36k
源码类别:

外挂编程

开发平台:

Windows_Unix

  1. #
  2. # Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 The SCons Foundation
  3. #
  4. # Permission is hereby granted, free of charge, to any person obtaining
  5. # a copy of this software and associated documentation files (the
  6. # "Software"), to deal in the Software without restriction, including
  7. # without limitation the rights to use, copy, modify, merge, publish,
  8. # distribute, sublicense, and/or sell copies of the Software, and to
  9. # permit persons to whom the Software is furnished to do so, subject to
  10. # the following conditions:
  11. #
  12. # The above copyright notice and this permission notice shall be included
  13. # in all copies or substantial portions of the Software.
  14. #
  15. # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
  16. # KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  17. # WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  18. # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  19. # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  20. # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  21. # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  22. #
  23. __revision__ = "src/engine/SCons/Script/SConsOptions.py 3057 2008/06/09 22:21:00 knight"
  24. import SCons.compat
  25. import optparse
  26. import re
  27. import string
  28. import sys
  29. import textwrap
  30. try:
  31.     no_hyphen_re = re.compile(r'(s+|(?<=[w!"'&.,?])-{2,}(?=w))')
  32. except re.error:
  33.     # Pre-2.0 Python versions don't have the (?<= negative
  34.     # look-behind assertion.
  35.     no_hyphen_re = re.compile(r'(s+|-*w{2,}-(?=w{2,}))')
  36. try:
  37.     from gettext import gettext
  38. except ImportError:
  39.     def gettext(message):
  40.         return message
  41. _ = gettext
  42. import SCons.Node.FS
  43. import SCons.Warnings
  44. OptionValueError        = optparse.OptionValueError
  45. SUPPRESS_HELP           = optparse.SUPPRESS_HELP
  46. diskcheck_all = SCons.Node.FS.diskcheck_types()
  47. def diskcheck_convert(value):
  48.     if value is None:
  49.         return []
  50.     if not SCons.Util.is_List(value):
  51.         value = string.split(value, ',')
  52.     result = []
  53.     for v in map(string.lower, value):
  54.         if v == 'all':
  55.             result = diskcheck_all
  56.         elif v == 'none':
  57.             result = []
  58.         elif v in diskcheck_all:
  59.             result.append(v)
  60.         else:
  61.             raise ValueError, v
  62.     return result
  63. class SConsValues(optparse.Values):
  64.     """
  65.     Holder class for uniform access to SCons options, regardless
  66.     of whether or not they can be set on the command line or in the
  67.     SConscript files (using the SetOption() function).
  68.     A SCons option value can originate three different ways:
  69.         1)  set on the command line;
  70.         2)  set in an SConscript file;
  71.         3)  the default setting (from the the op.add_option()
  72.             calls in the Parser() function, below).
  73.     The command line always overrides a value set in a SConscript file,
  74.     which in turn always overrides default settings.  Because we want
  75.     to support user-specified options in the SConscript file itself,
  76.     though, we may not know about all of the options when the command
  77.     line is first parsed, so we can't make all the necessary precedence
  78.     decisions at the time the option is configured.
  79.     The solution implemented in this class is to keep these different sets
  80.     of settings separate (command line, SConscript file, and default)
  81.     and to override the __getattr__() method to check them in turn.
  82.     This should allow the rest of the code to just fetch values as
  83.     attributes of an instance of this class, without having to worry
  84.     about where they came from.
  85.     Note that not all command line options are settable from SConscript
  86.     files, and the ones that are must be explicitly added to the
  87.     "settable" list in this class, and optionally validated and coerced
  88.     in the set_option() method.
  89.     """
  90.     def __init__(self, defaults):
  91.         self.__dict__['__defaults__'] = defaults
  92.         self.__dict__['__SConscript_settings__'] = {}
  93.     def __getattr__(self, attr):
  94.         """
  95.         Fetches an options value, checking first for explicit settings
  96.         from the command line (which are direct attributes), then the
  97.         SConscript file settings, then the default values.
  98.         """
  99.         try:
  100.             return self.__dict__[attr]
  101.         except KeyError:
  102.             try:
  103.                 return self.__dict__['__SConscript_settings__'][attr]
  104.             except KeyError:
  105.                 return getattr(self.__dict__['__defaults__'], attr)
  106.     settable = [
  107.         'clean',
  108.         'diskcheck',
  109.         'duplicate',
  110.         'help',
  111.         'implicit_cache',
  112.         'max_drift',
  113.         'no_exec',
  114.         'num_jobs',
  115.         'random',
  116.         'stack_size',
  117.         'warn',
  118.     ]
  119.     def set_option(self, name, value):
  120.         """
  121.         Sets an option from an SConscript file.
  122.         """
  123.         if not name in self.settable:
  124.             raise SCons.Errors.UserError, "This option is not settable from a SConscript file: %s"%name
  125.         if name == 'num_jobs':
  126.             try:
  127.                 value = int(value)
  128.                 if value < 1:
  129.                     raise ValueError
  130.             except ValueError:
  131.                 raise SCons.Errors.UserError, "A positive integer is required: %s"%repr(value)
  132.         elif name == 'max_drift':
  133.             try:
  134.                 value = int(value)
  135.             except ValueError:
  136.                 raise SCons.Errors.UserError, "An integer is required: %s"%repr(value)
  137.         elif name == 'duplicate':
  138.             try:
  139.                 value = str(value)
  140.             except ValueError:
  141.                 raise SCons.Errors.UserError, "A string is required: %s"%repr(value)
  142.             if not value in SCons.Node.FS.Valid_Duplicates:
  143.                 raise SCons.Errors.UserError, "Not a valid duplication style: %s" % value
  144.             # Set the duplicate style right away so it can affect linking
  145.             # of SConscript files.
  146.             SCons.Node.FS.set_duplicate(value)
  147.         elif name == 'diskcheck':
  148.             try:
  149.                 value = diskcheck_convert(value)
  150.             except ValueError, v:
  151.                 raise SCons.Errors.UserError, "Not a valid diskcheck value: %s"%v
  152.             if not self.__dict__.has_key('diskcheck'):
  153.                 # No --diskcheck= option was specified on the command line.
  154.                 # Set this right away so it can affect the rest of the
  155.                 # file/Node lookups while processing the SConscript files.
  156.                 SCons.Node.FS.set_diskcheck(value)
  157.         elif name == 'stack_size':
  158.             try:
  159.                 value = int(value)
  160.             except ValueError:
  161.                 raise SCons.Errors.UserError, "An integer is required: %s"%repr(value)
  162.         elif name == 'warn':
  163.             if SCons.Util.is_String(value):
  164.                 value = [value]
  165.             value = self.__SConscript_settings__.get(name, []) + value
  166.             SCons.Warnings.process_warn_strings(value)
  167.         self.__SConscript_settings__[name] = value
  168. class SConsOption(optparse.Option):
  169.     def convert_value(self, opt, value):
  170.         if value is not None:
  171.             if self.nargs in (1, '?'):
  172.                 return self.check_value(opt, value)
  173.             else:
  174.                 return tuple(map(lambda v, o=opt, s=self: s.check_value(o, v), value))
  175.     def process(self, opt, value, values, parser):
  176.         # First, convert the value(s) to the right type.  Howl if any
  177.         # value(s) are bogus.
  178.         value = self.convert_value(opt, value)
  179.         # And then take whatever action is expected of us.
  180.         # This is a separate method to make life easier for
  181.         # subclasses to add new actions.
  182.         return self.take_action(
  183.             self.action, self.dest, opt, value, values, parser)
  184.     def _check_nargs_optional(self):
  185.         if self.nargs == '?' and self._short_opts:
  186.             fmt = "option %s: nargs='?' is incompatible with short options"
  187.             raise SCons.Errors.UserError, fmt % self._short_opts[0]
  188.     try:
  189.         _orig_CONST_ACTIONS = optparse.Option.CONST_ACTIONS
  190.         _orig_CHECK_METHODS = optparse.Option.CHECK_METHODS
  191.     except AttributeError:
  192.         # optparse.Option had no CONST_ACTIONS before Python 2.5.
  193.         _orig_CONST_ACTIONS = ("store_const",)
  194.         def _check_const(self):
  195.             if self.action not in self.CONST_ACTIONS and self.const is not None:
  196.                 raise OptionError(
  197.                     "'const' must not be supplied for action %r" % self.action,
  198.                     self)
  199.         # optparse.Option collects its list of unbound check functions
  200.         # up front.  This sucks because it means we can't just override
  201.         # the _check_const() function like a normal method, we have to
  202.         # actually replace it in the list.  This seems to be the most
  203.         # straightforward way to do that.
  204.         _orig_CHECK_METHODS = [optparse.Option._check_action,
  205.                      optparse.Option._check_type,
  206.                      optparse.Option._check_choice,
  207.                      optparse.Option._check_dest,
  208.                      _check_const,
  209.                      optparse.Option._check_nargs,
  210.                      optparse.Option._check_callback]
  211.     CHECK_METHODS = _orig_CHECK_METHODS + [_check_nargs_optional]
  212.     CONST_ACTIONS = _orig_CONST_ACTIONS + optparse.Option.TYPED_ACTIONS
  213. class SConsOptionGroup(optparse.OptionGroup):
  214.     """
  215.     A subclass for SCons-specific option groups.
  216.     
  217.     The only difference between this and the base class is that we print
  218.     the group's help text flush left, underneath their own title but
  219.     lined up with the normal "SCons Options".
  220.     """
  221.     def format_help(self, formatter):
  222.         """
  223.         Format an option group's help text, outdenting the title so it's
  224.         flush with the "SCons Options" title we print at the top.
  225.         """
  226.         formatter.dedent()
  227.         result = formatter.format_heading(self.title)
  228.         formatter.indent()
  229.         result = result + optparse.OptionContainer.format_help(self, formatter)
  230.         return result
  231. class SConsOptionParser(optparse.OptionParser):
  232.     preserve_unknown_options = False
  233.     def error(self, msg):
  234.         self.print_usage(sys.stderr)
  235.         sys.stderr.write("SCons error: %sn" % msg)
  236.         sys.exit(2)
  237.     def _process_long_opt(self, rargs, values):
  238.         """
  239.         SCons-specific processing of long options.
  240.         This is copied directly from the normal
  241.         optparse._process_long_opt() method, except that, if configured
  242.         to do so, we catch the exception thrown when an unknown option
  243.         is encountered and just stick it back on the "leftover" arguments
  244.         for later (re-)processing.
  245.         """
  246.         arg = rargs.pop(0)
  247.         # Value explicitly attached to arg?  Pretend it's the next
  248.         # argument.
  249.         if "=" in arg:
  250.             (opt, next_arg) = string.split(arg, "=", 1)
  251.             rargs.insert(0, next_arg)
  252.             had_explicit_value = True
  253.         else:
  254.             opt = arg
  255.             had_explicit_value = False
  256.         try:
  257.             opt = self._match_long_opt(opt)
  258.         except optparse.BadOptionError:
  259.             if self.preserve_unknown_options:
  260.                 # SCons-specific:  if requested, add unknown options to
  261.                 # the "leftover arguments" list for later processing.
  262.                 self.largs.append(arg)
  263.                 if had_explicit_value:
  264.                     # The unknown option will be re-processed later,
  265.                     # so undo the insertion of the explicit value.
  266.                     rargs.pop(0)
  267.                 return
  268.             raise
  269.         option = self._long_opt[opt]
  270.         if option.takes_value():
  271.             nargs = option.nargs
  272.             if nargs == '?':
  273.                 if had_explicit_value:
  274.                     value = rargs.pop(0)
  275.                 else:
  276.                     value = option.const
  277.             elif len(rargs) < nargs:
  278.                 if nargs == 1:
  279.                     self.error(_("%s option requires an argument") % opt)
  280.                 else:
  281.                     self.error(_("%s option requires %d arguments")
  282.                                % (opt, nargs))
  283.             elif nargs == 1:
  284.                 value = rargs.pop(0)
  285.             else:
  286.                 value = tuple(rargs[0:nargs])
  287.                 del rargs[0:nargs]
  288.         elif had_explicit_value:
  289.             self.error(_("%s option does not take a value") % opt)
  290.         else:
  291.             value = None
  292.         option.process(opt, value, values, self)
  293.     def add_local_option(self, *args, **kw):
  294.         """
  295.         Adds a local option to the parser.
  296.         
  297.         This is initiated by a SetOption() call to add a user-defined
  298.         command-line option.  We add the option to a separate option
  299.         group for the local options, creating the group if necessary.
  300.         """
  301.         try:
  302.             group = self.local_option_group
  303.         except AttributeError:
  304.             group = SConsOptionGroup(self, 'Local Options')
  305.             group = self.add_option_group(group)
  306.             self.local_option_group = group
  307.         result = apply(group.add_option, args, kw)
  308.         if result:
  309.             # The option was added succesfully.  We now have to add the
  310.             # default value to our object that holds the default values
  311.             # (so that an attempt to fetch the option's attribute will
  312.             # yield the default value when not overridden) and then
  313.             # we re-parse the leftover command-line options, so that
  314.             # any value overridden on the command line is immediately
  315.             # available if the user turns around and does a GetOption()
  316.             # right away.
  317.             setattr(self.values.__defaults__, result.dest, result.default)
  318.             self.parse_args(self.largs, self.values)
  319.         return result
  320. class SConsIndentedHelpFormatter(optparse.IndentedHelpFormatter):
  321.     def format_usage(self, usage):
  322.         return "usage: %sn" % usage
  323.     def format_heading(self, heading):
  324.         """
  325.         This translates any heading of "options" or "Options" into
  326.         "SCons Options."  Unfortunately, we have to do this here,
  327.         because those titles are hard-coded in the optparse calls.
  328.         """
  329.         if heading == 'options':
  330.             # The versions of optparse.py shipped with Pythons 2.3 and
  331.             # 2.4 pass this in uncapitalized; override that so we get
  332.             # consistent output on all versions.
  333.             heading = "Options"
  334.         if heading == 'Options':
  335.             heading = "SCons Options"
  336.         return optparse.IndentedHelpFormatter.format_heading(self, heading)
  337.     def format_option(self, option):
  338.         """
  339.         A copy of the normal optparse.IndentedHelpFormatter.format_option()
  340.         method.  This has been snarfed so we can modify text wrapping to
  341.         out liking:
  342.         --  add our own regular expression that doesn't break on hyphens
  343.             (so things like --no-print-directory don't get broken); 
  344.         --  wrap the list of options themselves when it's too long
  345.             (the wrapper.fill(opts) call below);
  346.  
  347.         --  set the subsequent_indent when wrapping the help_text.
  348.         """
  349.         # The help for each option consists of two parts:
  350.         #   * the opt strings and metavars
  351.         #     eg. ("-x", or "-fFILENAME, --file=FILENAME")
  352.         #   * the user-supplied help string
  353.         #     eg. ("turn on expert mode", "read data from FILENAME")
  354.         #
  355.         # If possible, we write both of these on the same line:
  356.         #   -x      turn on expert mode
  357.         #
  358.         # But if the opt string list is too long, we put the help
  359.         # string on a second line, indented to the same column it would
  360.         # start in if it fit on the first line.
  361.         #   -fFILENAME, --file=FILENAME
  362.         #           read data from FILENAME
  363.         result = []
  364.         try:
  365.             opts = self.option_strings[option]
  366.         except AttributeError:
  367.             # The Python 2.3 version of optparse attaches this to
  368.             # to the option argument, not to this object.
  369.             opts = option.option_strings
  370.         opt_width = self.help_position - self.current_indent - 2
  371.         if len(opts) > opt_width:
  372.             wrapper = textwrap.TextWrapper(width=self.width,
  373.                                            initial_indent = '  ',
  374.                                            subsequent_indent = '  ')
  375.             wrapper.wordsep_re = no_hyphen_re
  376.             opts = wrapper.fill(opts) + 'n'
  377.             indent_first = self.help_position
  378.         else:                       # start help on same line as opts
  379.             opts = "%*s%-*s  " % (self.current_indent, "", opt_width, opts)
  380.             indent_first = 0
  381.         result.append(opts)
  382.         if option.help:
  383.             try:
  384.                 expand_default = self.expand_default
  385.             except AttributeError:
  386.                 # The HelpFormatter base class in the Python 2.3 version
  387.                 # of optparse has no expand_default() method.
  388.                 help_text = option.help
  389.             else:
  390.                 help_text = expand_default(option)
  391.             # SCons:  indent every line of the help text but the first.
  392.             wrapper = textwrap.TextWrapper(width=self.help_width,
  393.                                            subsequent_indent = '  ')
  394.             wrapper.wordsep_re = no_hyphen_re
  395.             help_lines = wrapper.wrap(help_text)
  396.             result.append("%*s%sn" % (indent_first, "", help_lines[0]))
  397.             for line in help_lines[1:]:
  398.                 result.append("%*s%sn" % (self.help_position, "", line))
  399.         elif opts[-1] != "n":
  400.             result.append("n")
  401.         return string.join(result, "")
  402.     # For consistent help output across Python versions, we provide a
  403.     # subclass copy of format_option_strings() and these two variables.
  404.     # This is necessary (?) for Python2.3, which otherwise concatenates
  405.     # a short option with its metavar.
  406.     _short_opt_fmt = "%s %s"
  407.     _long_opt_fmt = "%s=%s"
  408.     def format_option_strings(self, option):
  409.         """Return a comma-separated list of option strings & metavariables."""
  410.         if option.takes_value():
  411.             metavar = option.metavar or string.upper(option.dest)
  412.             short_opts = []
  413.             for sopt in option._short_opts:
  414.                 short_opts.append(self._short_opt_fmt % (sopt, metavar))
  415.             long_opts = []
  416.             for lopt in option._long_opts:
  417.                 long_opts.append(self._long_opt_fmt % (lopt, metavar))
  418.         else:
  419.             short_opts = option._short_opts
  420.             long_opts = option._long_opts
  421.         if self.short_first:
  422.             opts = short_opts + long_opts
  423.         else:
  424.             opts = long_opts + short_opts
  425.         return string.join(opts, ", ")
  426. def Parser(version):
  427.     """
  428.     Returns an options parser object initialized with the standard
  429.     SCons options.
  430.     """
  431.     formatter = SConsIndentedHelpFormatter(max_help_position=30)
  432.     op = SConsOptionParser(option_class=SConsOption,
  433.                            add_help_option=False,
  434.                            formatter=formatter,
  435.                            usage="usage: scons [OPTION] [TARGET] ...",)
  436.     op.preserve_unknown_options = True
  437.     op.version = version
  438.     # Add the options to the parser we just created.
  439.     #
  440.     # These are in the order we want them to show up in the -H help
  441.     # text, basically alphabetical.  Each op.add_option() call below
  442.     # should have a consistent format:
  443.     #
  444.     #   op.add_option("-L", "--long-option-name",
  445.     #                 nargs=1, type="string",
  446.     #                 dest="long_option_name", default='foo',
  447.     #                 action="callback", callback=opt_long_option,
  448.     #                 help="help text goes here",
  449.     #                 metavar="VAR")
  450.     #
  451.     # Even though the optparse module constructs reasonable default
  452.     # destination names from the long option names, we're going to be
  453.     # explicit about each one for easier readability and so this code
  454.     # will at least show up when grepping the source for option attribute
  455.     # names, or otherwise browsing the source code.
  456.     # options ignored for compatibility
  457.     def opt_ignore(option, opt, value, parser):
  458.         sys.stderr.write("Warning:  ignoring %s optionn" % opt)
  459.     op.add_option("-b", "-d", "-e", "-m", "-S", "-t", "-w",
  460.                   "--environment-overrides",
  461.                   "--no-keep-going",
  462.                   "--no-print-directory",
  463.                   "--print-directory",
  464.                   "--stop",
  465.                   "--touch",
  466.                   action="callback", callback=opt_ignore,
  467.                   help="Ignored for compatibility.")
  468.     op.add_option('-c', '--clean', '--remove',
  469.                   dest="clean", default=False,
  470.                   action="store_true",
  471.                   help="Remove specified targets and dependencies.")
  472.     op.add_option('-C', '--directory',
  473.                   nargs=1, type="string",
  474.                   dest="directory", default=[],
  475.                   action="append",
  476.                   help="Change to DIR before doing anything.",
  477.                   metavar="DIR")
  478.     op.add_option('--cache-debug',
  479.                   nargs=1,
  480.                   dest="cache_debug", default=None,
  481.                   action="store",
  482.                   help="Print CacheDir debug info to FILE.",
  483.                   metavar="FILE")
  484.     op.add_option('--cache-disable', '--no-cache',
  485.                   dest='cache_disable', default=False,
  486.                   action="store_true",
  487.                   help="Do not retrieve built targets from CacheDir.")
  488.     op.add_option('--cache-force', '--cache-populate',
  489.                   dest='cache_force', default=False,
  490.                   action="store_true",
  491.                   help="Copy already-built targets into the CacheDir.")
  492.     op.add_option('--cache-show',
  493.                   dest='cache_show', default=False,
  494.                   action="store_true",
  495.                   help="Print build actions for files from CacheDir.")
  496.     config_options = ["auto", "force" ,"cache"]
  497.     def opt_config(option, opt, value, parser, c_options=config_options):
  498.         if not value in c_options:
  499.             raise OptionValueError("Warning:  %s is not a valid config type" % value)
  500.         setattr(parser.values, option.dest, value)
  501.     opt_config_help = "Controls Configure subsystem: %s." 
  502.                       % string.join(config_options, ", ")
  503.     op.add_option('--config',
  504.                   nargs=1, type="string",
  505.                   dest="config", default="auto",
  506.                   action="callback", callback=opt_config,
  507.                   help = opt_config_help,
  508.                   metavar="MODE")
  509.     op.add_option('-D',
  510.                   dest="climb_up", default=None,
  511.                   action="store_const", const=2,
  512.                   help="Search up directory tree for SConstruct,       "
  513.                        "build all Default() targets.")
  514.     deprecated_debug_options = {
  515.         "dtree"         : '; please use --tree=derived instead',
  516.         "nomemoizer"    : ' and has no effect',
  517.         "stree"         : '; please use --tree=all,status instead',
  518.         "tree"          : '; please use --tree=all instead',
  519.     }
  520.     debug_options = ["count", "explain", "findlibs",
  521.                      "includes", "memoizer", "memory", "objects",
  522.                      "pdb", "presub", "stacktrace",
  523.                      "time"] + deprecated_debug_options.keys()
  524.     def opt_debug(option, opt, value, parser,
  525.                   debug_options=debug_options,
  526.                   deprecated_debug_options=deprecated_debug_options):
  527.         if value in debug_options:
  528.             parser.values.debug.append(value)
  529.             if value in deprecated_debug_options.keys():
  530.                 try:
  531.                     parser.values.delayed_warnings
  532.                 except AttributeError:
  533.                     parser.values.delayed_warnings = []
  534.                 msg = deprecated_debug_options[value]
  535.                 w = "The --debug=%s option is deprecated%s." % (value, msg)
  536.                 t = (SCons.Warnings.DeprecatedWarning, w)
  537.                 parser.values.delayed_warnings.append(t)
  538.         else:
  539.             raise OptionValueError("Warning:  %s is not a valid debug type" % value)
  540.     opt_debug_help = "Print various types of debugging information: %s." 
  541.                      % string.join(debug_options, ", ")
  542.     op.add_option('--debug',
  543.                   nargs=1, type="string",
  544.                   dest="debug", default=[],
  545.                   action="callback", callback=opt_debug,
  546.                   help=opt_debug_help,
  547.                   metavar="TYPE")
  548.     def opt_diskcheck(option, opt, value, parser):
  549.         try:
  550.             diskcheck_value = diskcheck_convert(value)
  551.         except ValueError, e:
  552.             raise OptionValueError("Warning: `%s' is not a valid diskcheck type" % e)
  553.         setattr(parser.values, option.dest, diskcheck_value)
  554.     op.add_option('--diskcheck',
  555.                   nargs=1, type="string",
  556.                   dest='diskcheck', default=None,
  557.                   action="callback", callback=opt_diskcheck,
  558.                   help="Enable specific on-disk checks.",
  559.                   metavar="TYPE")
  560.     def opt_duplicate(option, opt, value, parser):
  561.         if not value in SCons.Node.FS.Valid_Duplicates:
  562.             raise OptionValueError("`%s' is not a valid duplication style." % value)
  563.         setattr(parser.values, option.dest, value)
  564.         # Set the duplicate style right away so it can affect linking
  565.         # of SConscript files.
  566.         SCons.Node.FS.set_duplicate(value)
  567.     opt_duplicate_help = "Set the preferred duplication methods. Must be one of " 
  568.                          + string.join(SCons.Node.FS.Valid_Duplicates, ", ")
  569.     op.add_option('--duplicate',
  570.                   nargs=1, type="string",
  571.                   dest="duplicate", default='hard-soft-copy',
  572.                   action="callback", callback=opt_duplicate,
  573.                   help=opt_duplicate_help)
  574.     op.add_option('-f', '--file', '--makefile', '--sconstruct',
  575.                   nargs=1, type="string",
  576.                   dest="file", default=[],
  577.                   action="append",
  578.                   help="Read FILE as the top-level SConstruct file.")
  579.     op.add_option('-h', '--help',
  580.                   dest="help", default=False,
  581.                   action="store_true",
  582.                   help="Print defined help message, or this one.")
  583.     op.add_option("-H", "--help-options",
  584.                   action="help",
  585.                   help="Print this message and exit.")
  586.     op.add_option('-i', '--ignore-errors',
  587.                   dest='ignore_errors', default=False,
  588.                   action="store_true",
  589.                   help="Ignore errors from build actions.")
  590.     op.add_option('-I', '--include-dir',
  591.                   nargs=1,
  592.                   dest='include_dir', default=[],
  593.                   action="append",
  594.                   help="Search DIR for imported Python modules.",
  595.                   metavar="DIR")
  596.     op.add_option('--implicit-cache',
  597.                   dest='implicit_cache', default=False,
  598.                   action="store_true",
  599.                   help="Cache implicit dependencies")
  600.     def opt_implicit_deps(option, opt, value, parser):
  601.         setattr(parser.values, 'implicit_cache', True)
  602.         setattr(parser.values, option.dest, True)
  603.     op.add_option('--implicit-deps-changed',
  604.                   dest="implicit_deps_changed", default=False,
  605.                   action="callback", callback=opt_implicit_deps,
  606.                   help="Ignore cached implicit dependencies.")
  607.     op.add_option('--implicit-deps-unchanged',
  608.                   dest="implicit_deps_unchanged", default=False,
  609.                   action="callback", callback=opt_implicit_deps,
  610.                   help="Ignore changes in implicit dependencies.")
  611.     op.add_option('--interact', '--interactive',
  612.                   dest='interactive', default=False,
  613.                   action="store_true",
  614.                   help="Run in interactive mode.")
  615.     op.add_option('-j', '--jobs',
  616.                   nargs=1, type="int",
  617.                   dest="num_jobs", default=1,
  618.                   action="store",
  619.                   help="Allow N jobs at once.",
  620.                   metavar="N")
  621.     op.add_option('-k', '--keep-going',
  622.                   dest='keep_going', default=False,
  623.                   action="store_true",
  624.                   help="Keep going when a target can't be made.")
  625.     op.add_option('--max-drift',
  626.                   nargs=1, type="int",
  627.                   dest='max_drift', default=SCons.Node.FS.default_max_drift,
  628.                   action="store",
  629.                   help="Set maximum system clock drift to N seconds.",
  630.                   metavar="N")
  631.     op.add_option('-n', '--no-exec', '--just-print', '--dry-run', '--recon',
  632.                   dest='no_exec', default=False,
  633.                   action="store_true",
  634.                   help="Don't build; just print commands.")
  635.     op.add_option('--no-site-dir',
  636.                   dest='no_site_dir', default=False,
  637.                   action="store_true",
  638.                   help="Don't search or use the usual site_scons dir.")
  639.     op.add_option('--profile',
  640.                   nargs=1,
  641.                   dest="profile_file", default=None,
  642.                   action="store",
  643.                   help="Profile SCons and put results in FILE.",
  644.                   metavar="FILE")
  645.     op.add_option('-q', '--question',
  646.                   dest="question", default=False,
  647.                   action="store_true",
  648.                   help="Don't build; exit status says if up to date.")
  649.     op.add_option('-Q',
  650.                   dest='no_progress', default=False,
  651.                   action="store_true",
  652.                   help="Suppress "Reading/Building" progress messages.")
  653.     op.add_option('--random',
  654.                   dest="random", default=False,
  655.                   action="store_true",
  656.                   help="Build dependencies in random order.")
  657.     op.add_option('-s', '--silent', '--quiet',
  658.                   dest="silent", default=False,
  659.                   action="store_true",
  660.                   help="Don't print commands.")
  661.     op.add_option('--site-dir',
  662.                   nargs=1,
  663.                   dest='site_dir', default=None,
  664.                   action="store",
  665.                   help="Use DIR instead of the usual site_scons dir.",
  666.                   metavar="DIR")
  667.     op.add_option('--stack-size',
  668.                   nargs=1, type="int",
  669.                   dest='stack_size',
  670.                   action="store",
  671.                   help="Set the stack size of the threads used to run jobs to N kilobytes.",
  672.                   metavar="N")
  673.     op.add_option('--taskmastertrace',
  674.                   nargs=1,
  675.                   dest="taskmastertrace_file", default=None,
  676.                   action="store",
  677.                   help="Trace Node evaluation to FILE.",
  678.                   metavar="FILE")
  679.     tree_options = ["all", "derived", "prune", "status"]
  680.     def opt_tree(option, opt, value, parser, tree_options=tree_options):
  681.         import Main
  682.         tp = Main.TreePrinter()
  683.         for o in string.split(value, ','):
  684.             if o == 'all':
  685.                 tp.derived = False
  686.             elif o == 'derived':
  687.                 tp.derived = True
  688.             elif o == 'prune':
  689.                 tp.prune = True
  690.             elif o == 'status':
  691.                 tp.status = True
  692.             else:
  693.                 raise OptionValueError("Warning:  %s is not a valid --tree option" % o)
  694.         parser.values.tree_printers.append(tp)
  695.     opt_tree_help = "Print a dependency tree in various formats: %s." 
  696.                     % string.join(tree_options, ", ")
  697.     op.add_option('--tree',
  698.                   nargs=1, type="string",
  699.                   dest="tree_printers", default=[],
  700.                   action="callback", callback=opt_tree,
  701.                   help=opt_tree_help,
  702.                   metavar="OPTIONS")
  703.     op.add_option('-u', '--up', '--search-up',
  704.                   dest="climb_up", default=0,
  705.                   action="store_const", const=1,
  706.                   help="Search up directory tree for SConstruct,       "
  707.                        "build targets at or below current directory.")
  708.     op.add_option('-U',
  709.                   dest="climb_up", default=0,
  710.                   action="store_const", const=3,
  711.                   help="Search up directory tree for SConstruct,       "
  712.                        "build Default() targets from local SConscript.")
  713.     def opt_version(option, opt, value, parser):
  714.         sys.stdout.write(parser.version + 'n')
  715.         sys.exit(0)
  716.     op.add_option("-v", "--version",
  717.                   action="callback", callback=opt_version,
  718.                   help="Print the SCons version number and exit.")
  719.     def opt_warn(option, opt, value, parser, tree_options=tree_options):
  720.         if SCons.Util.is_String(value):
  721.             value = string.split(value, ',')
  722.         parser.values.warn.extend(value)
  723.     op.add_option('--warn', '--warning',
  724.                   nargs=1, type="string",
  725.                   dest="warn", default=[],
  726.                   action="callback", callback=opt_warn,
  727.                   help="Enable or disable warnings.",
  728.                   metavar="WARNING-SPEC")
  729.     op.add_option('-Y', '--repository', '--srcdir',
  730.                   nargs=1,
  731.                   dest="repository", default=[],
  732.                   action="append",
  733.                   help="Search REPOSITORY for source and target files.")
  734.     # Options from Make and Cons classic that we do not yet support,
  735.     # but which we may support someday and whose (potential) meanings
  736.     # we don't want to change.  These all get a "the -X option is not
  737.     # yet implemented" message and don't show up in the help output.
  738.     def opt_not_yet(option, opt, value, parser):
  739.         msg = "Warning:  the %s option is not yet implementedn" % opt
  740.         sys.stderr.write(msg)
  741.         sys.exit(0)
  742.     op.add_option('-l', '--load-average', '--max-load',
  743.                   nargs=1, type="int",
  744.                   dest="load_average", default=0,
  745.                   action="callback", callback=opt_not_yet,
  746.                   # action="store",
  747.                   # help="Don't start multiple jobs unless load is below "
  748.                   #      "LOAD-AVERAGE."
  749.                   help=SUPPRESS_HELP)
  750.     op.add_option('--list-actions',
  751.                   dest="list_actions",
  752.                   action="callback", callback=opt_not_yet,
  753.                   # help="Don't build; list files and build actions."
  754.                   help=SUPPRESS_HELP)
  755.     op.add_option('--list-derived',
  756.                   dest="list_derived",
  757.                   action="callback", callback=opt_not_yet,
  758.                   # help="Don't build; list files that would be built."
  759.                   help=SUPPRESS_HELP)
  760.     op.add_option('--list-where',
  761.                   dest="list_where",
  762.                   action="callback", callback=opt_not_yet,
  763.                   # help="Don't build; list files and where defined."
  764.                   help=SUPPRESS_HELP)
  765.     op.add_option('-o', '--old-file', '--assume-old',
  766.                   nargs=1, type="string",
  767.                   dest="old_file", default=[],
  768.                   action="callback", callback=opt_not_yet,
  769.                   # action="append",
  770.                   # help = "Consider FILE to be old; don't rebuild it."
  771.                   help=SUPPRESS_HELP)
  772.     op.add_option('--override',
  773.                   nargs=1, type="string",
  774.                   action="callback", callback=opt_not_yet,
  775.                   dest="override",
  776.                   # help="Override variables as specified in FILE."
  777.                   help=SUPPRESS_HELP)
  778.     op.add_option('-p',
  779.                   action="callback", callback=opt_not_yet,
  780.                   dest="p",
  781.                   # help="Print internal environments/objects."
  782.                   help=SUPPRESS_HELP)
  783.     op.add_option('-r', '-R', '--no-builtin-rules', '--no-builtin-variables',
  784.                   action="callback", callback=opt_not_yet,
  785.                   dest="no_builtin_rules",
  786.                   # help="Clear default environments and variables."
  787.                   help=SUPPRESS_HELP)
  788.     op.add_option('--write-filenames',
  789.                   nargs=1, type="string",
  790.                   dest="write_filenames",
  791.                   action="callback", callback=opt_not_yet,
  792.                   # help="Write all filenames examined into FILE."
  793.                   help=SUPPRESS_HELP)
  794.     op.add_option('-W', '--new-file', '--assume-new', '--what-if',
  795.                   nargs=1, type="string",
  796.                   dest="new_file",
  797.                   action="callback", callback=opt_not_yet,
  798.                   # help="Consider FILE to be changed."
  799.                   help=SUPPRESS_HELP)
  800.     op.add_option('--warn-undefined-variables',
  801.                   dest="warn_undefined_variables",
  802.                   action="callback", callback=opt_not_yet,
  803.                   # help="Warn when an undefined variable is referenced."
  804.                   help=SUPPRESS_HELP)
  805.     return op