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

外挂编程

开发平台:

Windows_Unix

  1. """SCons.Executor
  2. A module for executing actions with specific lists of target and source
  3. Nodes.
  4. """
  5. #
  6. # Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 The SCons Foundation
  7. #
  8. # Permission is hereby granted, free of charge, to any person obtaining
  9. # a copy of this software and associated documentation files (the
  10. # "Software"), to deal in the Software without restriction, including
  11. # without limitation the rights to use, copy, modify, merge, publish,
  12. # distribute, sublicense, and/or sell copies of the Software, and to
  13. # permit persons to whom the Software is furnished to do so, subject to
  14. # the following conditions:
  15. #
  16. # The above copyright notice and this permission notice shall be included
  17. # in all copies or substantial portions of the Software.
  18. #
  19. # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
  20. # KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  21. # WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  22. # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  23. # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  24. # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  25. # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  26. #
  27. __revision__ = "src/engine/SCons/Executor.py 3057 2008/06/09 22:21:00 knight"
  28. import string
  29. from SCons.Debug import logInstanceCreation
  30. import SCons.Errors
  31. import SCons.Memoize
  32. class Executor:
  33.     """A class for controlling instances of executing an action.
  34.     This largely exists to hold a single association of an action,
  35.     environment, list of environment override dictionaries, targets
  36.     and sources for later processing as needed.
  37.     """
  38.     if SCons.Memoize.use_memoizer:
  39.         __metaclass__ = SCons.Memoize.Memoized_Metaclass
  40.     memoizer_counters = []
  41.     def __init__(self, action, env=None, overridelist=[{}],
  42.                  targets=[], sources=[], builder_kw={}):
  43.         if __debug__: logInstanceCreation(self, 'Executor.Executor')
  44.         self.set_action_list(action)
  45.         self.pre_actions = []
  46.         self.post_actions = []
  47.         self.env = env
  48.         self.overridelist = overridelist
  49.         self.targets = targets
  50.         self.sources = sources[:]
  51.         self.sources_need_sorting = False
  52.         self.builder_kw = builder_kw
  53.         self._memo = {}
  54.     def set_action_list(self, action):
  55.         import SCons.Util
  56.         if not SCons.Util.is_List(action):
  57.             if not action:
  58.                 import SCons.Errors
  59.                 raise SCons.Errors.UserError, "Executor must have an action."
  60.             action = [action]
  61.         self.action_list = action
  62.     def get_action_list(self):
  63.         return self.pre_actions + self.action_list + self.post_actions
  64.     memoizer_counters.append(SCons.Memoize.CountValue('get_build_env'))
  65.     def get_build_env(self):
  66.         """Fetch or create the appropriate build Environment
  67.         for this Executor.
  68.         """
  69.         try:
  70.             return self._memo['get_build_env']
  71.         except KeyError:
  72.             pass
  73.         # Create the build environment instance with appropriate
  74.         # overrides.  These get evaluated against the current
  75.         # environment's construction variables so that users can
  76.         # add to existing values by referencing the variable in
  77.         # the expansion.
  78.         overrides = {}
  79.         for odict in self.overridelist:
  80.             overrides.update(odict)
  81.         import SCons.Defaults
  82.         env = self.env or SCons.Defaults.DefaultEnvironment()
  83.         build_env = env.Override(overrides)
  84.         self._memo['get_build_env'] = build_env
  85.         return build_env
  86.     def get_build_scanner_path(self, scanner):
  87.         """Fetch the scanner path for this executor's targets and sources.
  88.         """
  89.         env = self.get_build_env()
  90.         try:
  91.             cwd = self.targets[0].cwd
  92.         except (IndexError, AttributeError):
  93.             cwd = None
  94.         return scanner.path(env, cwd, self.targets, self.get_sources())
  95.     def get_kw(self, kw={}):
  96.         result = self.builder_kw.copy()
  97.         result.update(kw)
  98.         return result
  99.     def do_nothing(self, target, kw):
  100.         return 0
  101.     def do_execute(self, target, kw):
  102.         """Actually execute the action list."""
  103.         env = self.get_build_env()
  104.         kw = self.get_kw(kw)
  105.         status = 0
  106.         for act in self.get_action_list():
  107.             status = apply(act, (self.targets, self.get_sources(), env), kw)
  108.             if isinstance(status, SCons.Errors.BuildError):
  109.                 status.executor = self
  110.                 raise status
  111.             elif status:
  112.                 msg = "Error %s" % status
  113.                 raise SCons.Errors.BuildError(errstr=msg, executor=self, action=act)
  114.         return status
  115.     # use extra indirection because with new-style objects (Python 2.2
  116.     # and above) we can't override special methods, and nullify() needs
  117.     # to be able to do this.
  118.     def __call__(self, target, **kw):
  119.         return self.do_execute(target, kw)
  120.     def cleanup(self):
  121.         self._memo = {}
  122.     def add_sources(self, sources):
  123.         """Add source files to this Executor's list.  This is necessary
  124.         for "multi" Builders that can be called repeatedly to build up
  125.         a source file list for a given target."""
  126.         self.sources.extend(sources)
  127.         self.sources_need_sorting = True
  128.     def get_sources(self):
  129.         if self.sources_need_sorting:
  130.             self.sources = SCons.Util.uniquer_hashables(self.sources)
  131.             self.sources_need_sorting = False
  132.         return self.sources
  133.     def prepare(self):
  134.         """
  135.         Preparatory checks for whether this Executor can go ahead
  136.         and (try to) build its targets.
  137.         """
  138.         for s in self.get_sources():
  139.             if s.missing():
  140.                 msg = "Source `%s' not found, needed by target `%s'."
  141.                 raise SCons.Errors.StopError, msg % (s, self.targets[0])
  142.     def add_pre_action(self, action):
  143.         self.pre_actions.append(action)
  144.     def add_post_action(self, action):
  145.         self.post_actions.append(action)
  146.     # another extra indirection for new-style objects and nullify...
  147.     def my_str(self):
  148.         env = self.get_build_env()
  149.         get = lambda action, t=self.targets, s=self.get_sources(), e=env: 
  150.                      action.genstring(t, s, e)
  151.         return string.join(map(get, self.get_action_list()), "n")
  152.     def __str__(self):
  153.         return self.my_str()
  154.     def nullify(self):
  155.         self.cleanup()
  156.         self.do_execute = self.do_nothing
  157.         self.my_str     = lambda S=self: ''
  158.     memoizer_counters.append(SCons.Memoize.CountValue('get_contents'))
  159.     def get_contents(self):
  160.         """Fetch the signature contents.  This is the main reason this
  161.         class exists, so we can compute this once and cache it regardless
  162.         of how many target or source Nodes there are.
  163.         """
  164.         try:
  165.             return self._memo['get_contents']
  166.         except KeyError:
  167.             pass
  168.         env = self.get_build_env()
  169.         get = lambda action, t=self.targets, s=self.get_sources(), e=env: 
  170.                      action.get_contents(t, s, e)
  171.         result = string.join(map(get, self.get_action_list()), "")
  172.         self._memo['get_contents'] = result
  173.         return result
  174.     def get_timestamp(self):
  175.         """Fetch a time stamp for this Executor.  We don't have one, of
  176.         course (only files do), but this is the interface used by the
  177.         timestamp module.
  178.         """
  179.         return 0
  180.     def scan_targets(self, scanner):
  181.         self.scan(scanner, self.targets)
  182.     def scan_sources(self, scanner):
  183.         if self.sources:
  184.             self.scan(scanner, self.get_sources())
  185.     def scan(self, scanner, node_list):
  186.         """Scan a list of this Executor's files (targets or sources) for
  187.         implicit dependencies and update all of the targets with them.
  188.         This essentially short-circuits an N*M scan of the sources for
  189.         each individual target, which is a hell of a lot more efficient.
  190.         """
  191.         env = self.get_build_env()
  192.         deps = []
  193.         if scanner:
  194.             for node in node_list:
  195.                 node.disambiguate()
  196.                 s = scanner.select(node)
  197.                 if not s:
  198.                     continue
  199.                 path = self.get_build_scanner_path(s)
  200.                 deps.extend(node.get_implicit_deps(env, s, path))
  201.         else:
  202.             kw = self.get_kw()
  203.             for node in node_list:
  204.                 node.disambiguate()
  205.                 scanner = node.get_env_scanner(env, kw)
  206.                 if not scanner:
  207.                     continue
  208.                 scanner = scanner.select(node)
  209.                 if not scanner:
  210.                     continue
  211.                 path = self.get_build_scanner_path(scanner)
  212.                 deps.extend(node.get_implicit_deps(env, scanner, path))
  213.         deps.extend(self.get_implicit_deps())
  214.         for tgt in self.targets:
  215.             tgt.add_to_implicit(deps)
  216.     def _get_unignored_sources_key(self, ignore=()):
  217.         return tuple(ignore)
  218.     memoizer_counters.append(SCons.Memoize.CountDict('get_unignored_sources', _get_unignored_sources_key))
  219.     def get_unignored_sources(self, ignore=()):
  220.         ignore = tuple(ignore)
  221.         try:
  222.             memo_dict = self._memo['get_unignored_sources']
  223.         except KeyError:
  224.             memo_dict = {}
  225.             self._memo['get_unignored_sources'] = memo_dict
  226.         else:
  227.             try:
  228.                 return memo_dict[ignore]
  229.             except KeyError:
  230.                 pass
  231.         sourcelist = self.get_sources()
  232.         if ignore:
  233.             idict = {}
  234.             for i in ignore:
  235.                 idict[i] = 1
  236.             sourcelist = filter(lambda s, i=idict: not i.has_key(s), sourcelist)
  237.         memo_dict[ignore] = sourcelist
  238.         return sourcelist
  239.     def _process_sources_key(self, func, ignore=()):
  240.         return (func, tuple(ignore))
  241.     memoizer_counters.append(SCons.Memoize.CountDict('process_sources', _process_sources_key))
  242.     def process_sources(self, func, ignore=()):
  243.         memo_key = (func, tuple(ignore))
  244.         try:
  245.             memo_dict = self._memo['process_sources']
  246.         except KeyError:
  247.             memo_dict = {}
  248.             self._memo['process_sources'] = memo_dict
  249.         else:
  250.             try:
  251.                 return memo_dict[memo_key]
  252.             except KeyError:
  253.                 pass
  254.         result = map(func, self.get_unignored_sources(ignore))
  255.         memo_dict[memo_key] = result
  256.         return result
  257.     def get_implicit_deps(self):
  258.         """Return the executor's implicit dependencies, i.e. the nodes of
  259.         the commands to be executed."""
  260.         result = []
  261.         build_env = self.get_build_env()
  262.         for act in self.get_action_list():
  263.             result.extend(act.get_implicit_deps(self.targets, self.get_sources(), build_env))
  264.         return result
  265. _Executor = Executor
  266. class Null(_Executor):
  267.     """A null Executor, with a null build Environment, that does
  268.     nothing when the rest of the methods call it.
  269.     This might be able to disapper when we refactor things to
  270.     disassociate Builders from Nodes entirely, so we're not
  271.     going to worry about unit tests for this--at least for now.
  272.     """
  273.     def __init__(self, *args, **kw):
  274.         if __debug__: logInstanceCreation(self, 'Executor.Null')
  275.         kw['action'] = []
  276.         apply(_Executor.__init__, (self,), kw)
  277.     def get_build_env(self):
  278.         import SCons.Util
  279.         class NullEnvironment(SCons.Util.Null):
  280.             import SCons.CacheDir
  281.             _CacheDir_path = None
  282.             _CacheDir = SCons.CacheDir.CacheDir(None)
  283.             def get_CacheDir(self):
  284.                 return self._CacheDir
  285.         return NullEnvironment()
  286.     def get_build_scanner_path(self):
  287.         return None
  288.     def cleanup(self):
  289.         pass
  290.     def prepare(self):
  291.         pass