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

外挂编程

开发平台:

Windows_Unix

  1. """SCons.Variables.PathVariable
  2. This file defines an option type for SCons implementing path settings.
  3. To be used whenever a a user-specified path override should be allowed.
  4. Arguments to PathVariable are:
  5.   option-name  = name of this option on the command line (e.g. "prefix")
  6.   option-help  = help string for option
  7.   option-dflt  = default value for this option
  8.   validator    = [optional] validator for option value.  Predefined
  9.                  validators are:
  10.                      PathAccept -- accepts any path setting; no validation
  11.                      PathIsDir  -- path must be an existing directory
  12.                      PathIsDirCreate -- path must be a dir; will create
  13.                      PathIsFile -- path must be a file
  14.                      PathExists -- path must exist (any type) [default]
  15.                  The validator is a function that is called and which
  16.                  should return True or False to indicate if the path
  17.                  is valid.  The arguments to the validator function
  18.                  are: (key, val, env).  The key is the name of the
  19.                  option, the val is the path specified for the option,
  20.                  and the env is the env to which the Otions have been
  21.                  added.
  22. Usage example:
  23.   Examples:
  24.       prefix=/usr/local
  25.   opts = Variables()
  26.   opts = Variables()
  27.   opts.Add(PathVariable('qtdir',
  28.                       'where the root of Qt is installed',
  29.                       qtdir, PathIsDir))
  30.   opts.Add(PathVariable('qt_includes',
  31.                       'where the Qt includes are installed',
  32.                       '$qtdir/includes', PathIsDirCreate))
  33.   opts.Add(PathVariable('qt_libraries',
  34.                       'where the Qt library is installed',
  35.                       '$qtdir/lib'))
  36. """
  37. #
  38. # Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 The SCons Foundation
  39. #
  40. # Permission is hereby granted, free of charge, to any person obtaining
  41. # a copy of this software and associated documentation files (the
  42. # "Software"), to deal in the Software without restriction, including
  43. # without limitation the rights to use, copy, modify, merge, publish,
  44. # distribute, sublicense, and/or sell copies of the Software, and to
  45. # permit persons to whom the Software is furnished to do so, subject to
  46. # the following conditions:
  47. #
  48. # The above copyright notice and this permission notice shall be included
  49. # in all copies or substantial portions of the Software.
  50. #
  51. # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
  52. # KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  53. # WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  54. # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  55. # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  56. # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  57. # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  58. #
  59. __revision__ = "src/engine/SCons/Variables/PathVariable.py 3057 2008/06/09 22:21:00 knight"
  60. __all__ = ['PathVariable',]
  61. import os
  62. import os.path
  63. import SCons.Errors
  64. class _PathVariableClass:
  65.     def PathAccept(self, key, val, env):
  66.         """Accepts any path, no checking done."""
  67.         pass
  68.     
  69.     def PathIsDir(self, key, val, env):
  70.         """Validator to check if Path is a directory."""
  71.         if not os.path.isdir(val):
  72.             if os.path.isfile(val):
  73.                 m = 'Directory path for option %s is a file: %s'
  74.             else:
  75.                 m = 'Directory path for option %s does not exist: %s'
  76.             raise SCons.Errors.UserError(m % (key, val))
  77.     def PathIsDirCreate(self, key, val, env):
  78.         """Validator to check if Path is a directory,
  79.            creating it if it does not exist."""
  80.         if os.path.isfile(val):
  81.             m = 'Path for option %s is a file, not a directory: %s'
  82.             raise SCons.Errors.UserError(m % (key, val))
  83.         if not os.path.isdir(val):
  84.             os.makedirs(val)
  85.     def PathIsFile(self, key, val, env):
  86.         """validator to check if Path is a file"""
  87.         if not os.path.isfile(val):
  88.             if os.path.isdir(val):
  89.                 m = 'File path for option %s is a directory: %s'
  90.             else:
  91.                 m = 'File path for option %s does not exist: %s'
  92.             raise SCons.Errors.UserError(m % (key, val))
  93.     def PathExists(self, key, val, env):
  94.         """validator to check if Path exists"""
  95.         if not os.path.exists(val):
  96.             m = 'Path for option %s does not exist: %s'
  97.             raise SCons.Errors.UserError(m % (key, val))
  98.     def __call__(self, key, help, default, validator=None):
  99.         # NB: searchfunc is currenty undocumented and unsupported
  100.         """
  101.         The input parameters describe a 'path list' option, thus they
  102.         are returned with the correct converter and validator appended. The
  103.         result is usable for input to opts.Add() .
  104.         The 'default' option specifies the default path to use if the
  105.         user does not specify an override with this option.
  106.         validator is a validator, see this file for examples
  107.         """
  108.         if validator is None:
  109.             validator = self.PathExists
  110.         if SCons.Util.is_List(key) or SCons.Util.is_Tuple(key):
  111.             return (key, '%s ( /path/to/%s )' % (help, key[0]), default,
  112.                     validator, None)
  113.         else:
  114.             return (key, '%s ( /path/to/%s )' % (help, key), default,
  115.                     validator, None)
  116. PathVariable = _PathVariableClass()