SCons/Tool/MSCommon/MSVC/__init__.py

   1 # MIT License
   2 #
   3 # Copyright The SCons Foundation
   4 #
   5 # Permission is hereby granted, free of charge, to any person obtaining
   6 # a copy of this software and associated documentation files (the
   7 # "Software"), to deal in the Software without restriction, including
   8 # without limitation the rights to use, copy, modify, merge, publish,
   9 # distribute, sublicense, and/or sell copies of the Software, and to
  10 # permit persons to whom the Software is furnished to do so, subject to
  11 # the following conditions:
  12 #
  13 # The above copyright notice and this permission notice shall be included
  14 # in all copies or substantial portions of the Software.
  15 #
  16 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
  17 # KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  18 # WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  19 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  20 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  21 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  22 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23
  24 """
  25 Functions for Microsoft Visual C/C++.
  26
  27 The _reset method is used to restore MSVC module data structures to their
  28 initial state for testing purposes.
  29
  30 The _verify method is used as a sanity check that MSVC module data structures
  31 are internally consistent.
  32
  33 Currently:
  34 * _reset is invoked from reset_installed_vcs in the vc module.
  35 * _verify is invoked from the last line in the vc module.
  36 """
  37
  38 from . import Exceptions  # noqa: F401
  39
  40 from . import Config  # noqa: F401
  41 from . import Util  # noqa: F401
  42 from . import Registry  # noqa: F401
  43 from . import Kind  # noqa: F401
  44 from . import SetupEnvDefault  # noqa: F401
  45 from . import Policy  # noqa: F401
  46 from . import WinSDK  # noqa: F401
  47 from . import ScriptArguments  # noqa: F401
  48
  49 from . import Dispatcher as _Dispatcher
  50
  51 def _reset() -> None:
  52     _Dispatcher.reset()
  53
  54 def _verify() -> None:
  55     _Dispatcher.verify()
  56