Concrete class that implements an interface to Microsoft Visual C++, as defined by the CCompiler abstract class.
Method | __init__ |
Undocumented |
Method | compile |
Compile one or more source files. |
Method | create |
Link a bunch of stuff together to create a static library file. The "bunch of stuff" consists of the list of object files supplied as 'objects', the extra object files supplied to 'add_link_object()' and/or 'set_link_objects()', the libraries supplied to 'add_library()' and/or 'set_libraries()', and the libraries supplied as 'libraries' (if any). |
Method | find |
Return path to an MSVC executable program. |
Method | find |
Search the specified list of directories for a static or shared library file 'lib' and return the full path to that file. If 'debug' true, look for a debugging version (if that makes sense on the current platform)... |
Method | get |
Get a list of devstudio directories (include, lib or path). |
Method | initialize |
Undocumented |
Method | library |
Return the compiler option to add 'dir' to the list of directories searched for libraries. |
Method | library |
Return the compiler option to add 'lib' to the list of libraries linked into the shared library or executable. |
Method | link |
Link a bunch of stuff together to create an executable or shared library file. |
Method | object |
Undocumented |
Method | runtime |
Return the compiler option to add 'dir' to the list of directories searched for runtime libraries. |
Method | set |
Set environment variable 'name' to an MSVC path type value. |
Class Variable | compiler |
Undocumented |
Class Variable | exe |
Undocumented |
Class Variable | executables |
Undocumented |
Class Variable | obj |
Undocumented |
Class Variable | res |
Undocumented |
Class Variable | shared |
Undocumented |
Class Variable | shared |
Undocumented |
Class Variable | src |
Undocumented |
Class Variable | static |
Undocumented |
Class Variable | static |
Undocumented |
Instance Variable | cc |
Undocumented |
Instance Variable | compile |
Undocumented |
Instance Variable | compile |
Undocumented |
Instance Variable | initialized |
Undocumented |
Instance Variable | ldflags |
Undocumented |
Instance Variable | ldflags |
Undocumented |
Instance Variable | ldflags |
Undocumented |
Instance Variable | lib |
Undocumented |
Instance Variable | linker |
Undocumented |
Instance Variable | mc |
Undocumented |
Instance Variable | preprocess |
Undocumented |
Instance Variable | rc |
Undocumented |
Class Variable | _c |
Undocumented |
Class Variable | _cpp |
Undocumented |
Class Variable | _mc |
Undocumented |
Class Variable | _rc |
Undocumented |
Instance Variable | __arch |
Undocumented |
Instance Variable | __macros |
Undocumented |
Instance Variable | __paths |
Undocumented |
Instance Variable | __product |
Undocumented |
Instance Variable | __root |
Undocumented |
Instance Variable | __version |
Undocumented |
Inherited from CCompiler
:
Method | add |
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()'. |
Method | add |
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). |
Method | add |
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()'. |
Method | add |
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. |
Method | add |
Add 'dir' to the list of directories that will be searched for shared libraries at runtime. |
Method | announce |
Undocumented |
Method | debug |
Undocumented |
Method | define |
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... |
Method | detect |
Detect the language of a given file, or list of files. Uses language_map, and language_order to do the job. |
Method | executable |
Undocumented |
Method | execute |
Undocumented |
Method | has |
Return a boolean indicating whether funcname is provided as a symbol on the current platform. The optional arguments can be used to augment the compilation environment. |
Method | library |
Undocumented |
Method | link |
Undocumented |
Method | link |
Undocumented |
Method | link |
Undocumented |
Method | mkpath |
Undocumented |
Method | move |
Undocumented |
Method | preprocess |
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()'... |
Method | set |
Undocumented |
Method | set |
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... |
Method | set |
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()'... |
Method | set |
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. |
Method | set |
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. |
Method | set |
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). |
Method | set |
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. |
Method | shared |
Undocumented |
Method | spawn |
Undocumented |
Method | undefine |
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)... |
Method | warn |
Undocumented |
Constant | EXECUTABLE |
Undocumented |
Constant | SHARED |
Undocumented |
Constant | SHARED |
Undocumented |
Class Variable | language |
Undocumented |
Class Variable | language |
Undocumented |
Instance Variable | dry |
Undocumented |
Instance Variable | force |
Undocumented |
Instance Variable | include |
include dirs specific to this compiler class |
Instance Variable | libraries |
Undocumented |
Instance Variable | library |
library dirs specific to this compiler class |
Instance Variable | macros |
Undocumented |
Instance Variable | objects |
Undocumented |
Instance Variable | output |
Undocumented |
Instance Variable | runtime |
Undocumented |
Instance Variable | verbose |
Undocumented |
Property | out |
Undocumented |
Static Method | _make |
In order to ensure that a filename always honors the indicated output_dir, make sure it's relative. Ref python/cpython#37775. |
Method | _check |
Ensures that every element of 'definitions' is a valid macro definition, ie. either (name,value) 2-tuple or a (name,) tuple. Do nothing if all definitions are OK, raise TypeError otherwise. |
Method | _compile |
Compile 'src' to product 'obj'. |
Method | _find |
Undocumented |
Method | _fix |
Typecheck and fix-up some of the arguments to the 'compile()' method, and return fixed-up values. Specifically: if 'output_dir' is None, replaces it with 'self.output_dir'; ensures that 'macros' is a list, and augments it with 'self... |
Method | _fix |
Typecheck and fix up some of the arguments supplied to the 'link_*' methods. Specifically: ensure that all arguments are lists, and augment them with their permanent versions (eg. 'self.libraries' augments 'libraries')... |
Method | _fix |
Typecheck and fix up some arguments supplied to various methods. Specifically: ensure that 'objects' is a list; if output_dir is None, replace with self.output_dir. Return fixed versions of 'objects' and 'output_dir'. |
Method | _get |
Undocumented |
Method | _make |
Undocumented |
Method | _need |
Return true if we need to relink the files listed in 'objects' to recreate 'output_file'. |
Method | _prep |
Decide which source files must be recompiled. |
Method | _setup |
Process arguments and decide which source files to compile. |
Compile one or more source files. 'sources' must be a list of filenames, most likely C/C++ files, but in reality anything that can be handled by a particular compiler and compiler class (eg. MSVCCompiler can handle resource files in 'sources'). Return a list of object filenames, one per source filename in 'sources'. Depending on the implementation, not all source files will necessarily be compiled, but all corresponding object filenames will be returned. If 'output_dir' is given, object files will be put under it, while retaining their original path component. That is, "foo/bar.c" normally compiles to "foo/bar.o" (for a Unix implementation); if 'output_dir' is "build", then it would compile to "build/foo/bar.o". 'macros', if given, must be a list of macro definitions. A macro definition is either a (name, value) 2-tuple or a (name,) 1-tuple. The former defines a macro; if the value is None, the macro is defined without an explicit value. The 1-tuple case undefines a macro. Later definitions/redefinitions/ undefinitions take precedence. 'include_dirs', if given, must be a list of strings, the directories to add to the default include file search path for this compilation only. 'debug' is a boolean; if true, the compiler will be instructed to output debug symbols in (or alongside) the object file(s). 'extra_preargs' and 'extra_postargs' are implementation- dependent. On platforms that have the notion of a command-line (e.g. Unix, DOS/Windows), they are most likely lists of strings: extra command-line arguments to prepend/append to the compiler command line. On other platforms, consult the implementation class documentation. In any event, they are intended as an escape hatch for those occasions when the abstract compiler framework doesn't cut the mustard. 'depends', if given, is a list of filenames that all targets depend on. If a source file is older than any file in depends, then the source file will be recompiled. This supports dependency tracking, but only at a coarse granularity. Raises CompileError on failure.
Link a bunch of stuff together to create a static library file. The "bunch of stuff" consists of the list of object files supplied as 'objects', the extra object files supplied to 'add_link_object()' and/or 'set_link_objects()', the libraries supplied to 'add_library()' and/or 'set_libraries()', and the libraries supplied as 'libraries' (if any). 'output_libname' should be a library name, not a filename; the filename will be inferred from the library name. 'output_dir' is the directory where the library file will be put. 'debug' is a boolean; if true, debugging information will be included in the library (note that on most platforms, it is the compile step where this matters: the 'debug' flag is included here just for consistency). 'target_lang' is the target language for which the given objects are being compiled. This allows specific linkage time treatment of certain languages. Raises LibError on failure.
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'.
Search the specified list of directories for a static or shared library file 'lib' and return the full path to that file. If 'debug' true, look for a debugging version (if that makes sense on the current platform). Return None if 'lib' wasn't found in any of the specified directories.
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.
Return the compiler option to add 'lib' to the list of libraries linked into the shared library or executable.
Link a bunch of stuff together to create an executable or shared library file. The "bunch of stuff" consists of the list of object files supplied as 'objects'. 'output_filename' should be a filename. If 'output_dir' is supplied, 'output_filename' is relative to it (i.e. 'output_filename' can provide directory components if needed). 'libraries' is a list of libraries to link against. These are library names, not filenames, since they're translated into filenames in a platform-specific way (eg. "foo" becomes "libfoo.a" on Unix and "foo.lib" on DOS/Windows). However, they can include a directory component, which means the linker will look in that specific directory rather than searching all the normal locations. 'library_dirs', if supplied, should be a list of directories to search for libraries that were specified as bare library names (ie. no directory component). These are on top of the system default and those supplied to 'add_library_dir()' and/or 'set_library_dirs()'. 'runtime_library_dirs' is a list of directories that will be embedded into the shared library and used to search for other shared libraries that *it* depends on at run-time. (This may only be relevant on Unix.) 'export_symbols' is a list of symbols that the shared library will export. (This appears to be relevant only on Windows.) 'debug' is as for 'compile()' and 'create_static_lib()', with the slight distinction that it actually matters on most platforms (as opposed to 'create_static_lib()', which includes a 'debug' flag mostly for form's sake). 'extra_preargs' and 'extra_postargs' are as for 'compile()' (except of course that they supply command-line arguments for the particular linker being used). 'target_lang' is the target language for which the given objects are being compiled. This allows specific linkage time treatment of certain languages. Raises LinkError on failure.
Set environment variable 'name' to an MSVC path type value. This is equivalent to a SET command prior to execution of spawned commands.