distutils.msvccompiler
index
/usr/local/lib/python2.3/distutils/msvccompiler.py

distutils.msvccompiler
 
Contains MSVCCompiler, an implementation of the abstract CCompiler class
for the Microsoft Visual Studio.

 
Modules
       
distutils.log
os
string
sys

 
Classes
       
distutils.ccompiler.CCompiler
MSVCCompiler
MacroExpander

 
class MSVCCompiler(distutils.ccompiler.CCompiler)
    Concrete class that implements an interface to Microsoft Visual C++,
as defined by the CCompiler abstract class.
 
  Methods defined here:
__init__(self, verbose=0, dry_run=0, force=0)
compile(self, sources, output_dir=None, macros=None, include_dirs=None, debug=0, extra_preargs=None, extra_postargs=None, depends=None)
create_static_lib(self, objects, output_libname, output_dir=None, debug=0, target_lang=None)
find_exe(self, exe)
Return path to an MSVC executable program.
 
Tries to find the program in several places: first, one of the
MSVC program search paths from the registry; next, the directories
in the PATH environment variable.  If any of those work, return an
absolute path that is known to exist.  If none of them work, just
return the original program name, 'exe'.
find_library_file(self, dirs, lib, debug=0)
get_msvc_paths(self, path, platform='x86')
Get a list of devstudio directories (include, lib or path).
 
Return a list of strings.  The list will be empty if unable to
access the registry or appropriate registry keys not found.
library_dir_option(self, dir)
library_option(self, lib)
link(self, target_desc, objects, output_filename, output_dir=None, libraries=None, library_dirs=None, runtime_library_dirs=None, export_symbols=None, debug=0, extra_preargs=None, extra_postargs=None, build_temp=None, target_lang=None)
object_filenames(self, source_filenames, strip_dir=0, output_dir='')
runtime_library_dir_option(self, dir)
set_path_env_var(self, name)
Set environment variable 'name' to an MSVC path type value.
 
This is equivalent to a SET command prior to execution of spawned
commands.

Data and other attributes defined here:
compiler_type = 'msvc'
exe_extension = '.exe'
executables = {}
obj_extension = '.obj'
res_extension = '.res'
shared_lib_extension = '.dll'
shared_lib_format = '%s%s'
src_extensions = ['.c', '.cc', '.cpp', '.cxx', '.rc', '.mc']
static_lib_extension = '.lib'
static_lib_format = '%s%s'

Methods inherited from distutils.ccompiler.CCompiler:
add_include_dir(self, dir)
Add 'dir' to the list of directories that will be searched for
header files.  The compiler is instructed to search directories in
the order in which they are supplied by successive calls to
'add_include_dir()'.
add_library(self, libname)
Add 'libname' to the list of libraries that will be included in
all links driven by this compiler object.  Note that 'libname'
should *not* be the name of a file containing a library, but the
name of the library itself: the actual filename will be inferred by
the linker, the compiler, or the compiler class (depending on the
platform).
 
The linker will be instructed to link against libraries in the
order they were supplied to 'add_library()' and/or
'set_libraries()'.  It is perfectly valid to duplicate library
names; the linker will be instructed to link against libraries as
many times as they are mentioned.
add_library_dir(self, dir)
Add 'dir' to the list of directories that will be searched for
libraries specified to 'add_library()' and 'set_libraries()'.  The
linker will be instructed to search for libraries in the order they
are supplied to 'add_library_dir()' and/or 'set_library_dirs()'.
add_link_object(self, object)
Add 'object' to the list of object files (or analogues, such as
explicitly named library files or the output of "resource
compilers") to be included in every link driven by this compiler
object.
add_runtime_library_dir(self, dir)
Add 'dir' to the list of directories that will be searched for
shared libraries at runtime.
announce(self, msg, level=1)
debug_print(self, msg)
define_macro(self, name, value=None)
Define a preprocessor macro for all compilations driven by this
compiler object.  The optional parameter 'value' should be a
string; if it is not supplied, then the macro will be defined
without an explicit value and the exact outcome depends on the
compiler used (XXX true? does ANSI say anything about this?)
detect_language(self, sources)
Detect the language of a given file, or list of files. Uses
language_map, and language_order to do the job.
executable_filename(self, basename, strip_dir=0, output_dir='')
execute(self, func, args, msg=None, level=1)
has_function(self, funcname, includes=None, include_dirs=None, libraries=None, library_dirs=None)
Return a boolean indicating whether funcname is supported on
the current platform.  The optional arguments can be used to
augment the compilation environment.
library_filename(self, libname, lib_type='static', strip_dir=0, output_dir='')
link_executable(self, objects, output_progname, output_dir=None, libraries=None, library_dirs=None, runtime_library_dirs=None, debug=0, extra_preargs=None, extra_postargs=None, target_lang=None)
link_shared_lib(self, objects, output_libname, output_dir=None, libraries=None, library_dirs=None, runtime_library_dirs=None, export_symbols=None, debug=0, extra_preargs=None, extra_postargs=None, build_temp=None, target_lang=None)
link_shared_object(self, objects, output_filename, output_dir=None, libraries=None, library_dirs=None, runtime_library_dirs=None, export_symbols=None, debug=0, extra_preargs=None, extra_postargs=None, build_temp=None, target_lang=None)
mkpath(self, name, mode=511)
move_file(self, src, dst)
preprocess(self, source, output_file=None, macros=None, include_dirs=None, extra_preargs=None, extra_postargs=None)
Preprocess a single C/C++ source file, named in 'source'.
Output will be written to file named 'output_file', or stdout if
'output_file' not supplied.  'macros' is a list of macro
definitions as for 'compile()', which will augment the macros set
with 'define_macro()' and 'undefine_macro()'.  'include_dirs' is a
list of directory names that will be added to the default list.
 
Raises PreprocessError on failure.
set_executable(self, key, value)
set_executables(self, **args)
Define the executables (and options for them) that will be run
to perform the various stages of compilation.  The exact set of
executables that may be specified here depends on the compiler
class (via the 'executables' class attribute), but most will have:
  compiler      the C/C++ compiler
  linker_so     linker used to create shared objects and libraries
  linker_exe    linker used to create binary executables
  archiver      static library creator
 
On platforms with a command-line (Unix, DOS/Windows), each of these
is a string that will be split into executable name and (optional)
list of arguments.  (Splitting the string is done similarly to how
Unix shells operate: words are delimited by spaces, but quotes and
backslashes can override this.  See
'distutils.util.split_quoted()'.)
set_include_dirs(self, dirs)
Set the list of directories that will be searched to 'dirs' (a
list of strings).  Overrides any preceding calls to
'add_include_dir()'; subsequence calls to 'add_include_dir()' add
to the list passed to 'set_include_dirs()'.  This does not affect
any list of standard include directories that the compiler may
search by default.
set_libraries(self, libnames)
Set the list of libraries to be included in all links driven by
this compiler object to 'libnames' (a list of strings).  This does
not affect any standard system libraries that the linker may
include by default.
set_library_dirs(self, dirs)
Set the list of library search directories to 'dirs' (a list of
strings).  This does not affect any standard library search path
that the linker may search by default.
set_link_objects(self, objects)
Set the list of object files (or analogues) to be included in
every link to 'objects'.  This does not affect any standard object
files that the linker may include by default (such as system
libraries).
set_runtime_library_dirs(self, dirs)
Set the list of directories to search for shared libraries at
runtime to 'dirs' (a list of strings).  This does not affect any
standard search path that the runtime linker may search by
default.
shared_object_filename(self, basename, strip_dir=0, output_dir='')
spawn(self, cmd)
undefine_macro(self, name)
Undefine a preprocessor macro for all compilations driven by
this compiler object.  If the same macro is defined by
'define_macro()' and undefined by 'undefine_macro()' the last call
takes precedence (including multiple redefinitions or
undefinitions).  If the macro is redefined/undefined on a
per-compilation basis (ie. in the call to 'compile()'), then that
takes precedence.
warn(self, msg)

Data and other attributes inherited from distutils.ccompiler.CCompiler:
EXECUTABLE = 'executable'
SHARED_LIBRARY = 'shared_library'
SHARED_OBJECT = 'shared_object'
language_map = {'.c': 'c', '.cc': 'c++', '.cpp': 'c++', '.cxx': 'c++', '.m': 'objc'}
language_order = ['c++', 'objc', 'c']

 
class MacroExpander
     Methods defined here:
__init__(self, version)
load_macros(self, version)
set_macro(self, macro, path, key)
sub(self, s)

 
Functions
       
convert_mbcs(s)
get_build_version()
Return the version of MSVC that was used to build Python.
 
For Python 2.3 and up, the version number is included in
sys.version.  For earlier versions, assume the compiler is MSVC 6.
read_keys(base, key)
Return list of registry keys.
read_values(base, key)
Return dict of registry keys and values.
 
All names are converted to lowercase.

 
Data
        __revision__ = '$Id: msvccompiler.py,v 1.57.6.1 2003/11/28 19:35:48 theller Exp $'