class documentation

Undocumented

Method create_static_lib 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_library_file Second-guess the linker with not much hard data to go on: GCC seems to prefer the shared library, so assume that *all* Unix C compilers do, ignoring even GCC's "-static" option.
Method library_dir_option Return the compiler option to add 'dir' to the list of directories searched for libraries.
Method library_option 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 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 runtime_library_dir_option Return the compiler option to add 'dir' to the list of directories searched for runtime libraries.
Class Variable compiler_type Undocumented
Class Variable dylib_lib_extension Undocumented
Class Variable dylib_lib_format Undocumented
Class Variable exe_extension Undocumented
Class Variable executables Undocumented
Class Variable obj_extension Undocumented
Class Variable shared_lib_extension Undocumented
Class Variable shared_lib_format Undocumented
Class Variable src_extensions Undocumented
Class Variable static_lib_extension Undocumented
Class Variable static_lib_format Undocumented
Class Variable xcode_stub_lib_extension Undocumented
Static Method _library_root macOS users can specify an alternate SDK using'-isysroot'. Calculate the SDK root if it is specified.
Method _compile Compile 'src' to product 'obj'.
Method _is_gcc Undocumented

Inherited from CCompiler:

Method __init__ Undocumented
Method add_include_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()'.
Method add_library 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_library_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()'.
Method add_link_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.
Method add_runtime_library_dir Add 'dir' to the list of directories that will be searched for shared libraries at runtime.
Method announce Undocumented
Method compile Compile one or more source files.
Method debug_print Undocumented
Method define_macro 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_language Detect the language of a given file, or list of files. Uses language_map, and language_order to do the job.
Method executable_filename Undocumented
Method execute Undocumented
Method has_function 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_filename Undocumented
Method link_executable Undocumented
Method link_shared_lib Undocumented
Method link_shared_object Undocumented
Method mkpath Undocumented
Method move_file Undocumented
Method object_filenames Undocumented
Method set_executable Undocumented
Method set_executables 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_include_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()'...
Method set_libraries 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_library_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.
Method set_link_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).
Method set_runtime_library_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.
Method shared_object_filename Undocumented
Method spawn Undocumented
Method undefine_macro 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_LIBRARY Undocumented
Constant SHARED_OBJECT Undocumented
Class Variable language_map Undocumented
Class Variable language_order Undocumented
Instance Variable dry_run Undocumented
Instance Variable force Undocumented
Instance Variable include_dirs include dirs specific to this compiler class
Instance Variable libraries Undocumented
Instance Variable library_dirs library dirs specific to this compiler class
Instance Variable macros Undocumented
Instance Variable objects Undocumented
Instance Variable output_dir Undocumented
Instance Variable runtime_library_dirs Undocumented
Instance Variable verbose Undocumented
Property out_extensions Undocumented
Static Method _make_relative In order to ensure that a filename always honors the indicated output_dir, make sure it's relative. Ref python/cpython#37775.
Method _check_macro_definitions 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 _find_macro Undocumented
Method _fix_compile_args 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_lib_args 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_object_args 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_cc_args Undocumented
Method _make_out_path Undocumented
Method _need_link Return true if we need to relink the files listed in 'objects' to recreate 'output_file'.
Method _prep_compile Decide which source files must be recompiled.
Method _setup_compile Process arguments and decide which source files to compile.
def create_static_lib(self, objects, output_libname, output_dir=None, debug=0, target_lang=None): (source)

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.

def find_library_file(self, dirs, lib, debug=0): (source)

Second-guess the linker with not much hard data to go on: GCC seems to prefer the shared library, so assume that *all* Unix C compilers do, ignoring even GCC's "-static" option. >>> compiler = UnixCCompiler() >>> compiler._library_root = lambda dir: dir >>> monkeypatch = getfixture('monkeypatch') >>> monkeypatch.setattr(os.path, 'exists', lambda d: 'existing' in d) >>> dirs = ('/foo/bar/missing', '/foo/bar/existing') >>> compiler.find_library_file(dirs, 'abc').replace('\\', '/') '/foo/bar/existing/libabc.dylib' >>> compiler.find_library_file(reversed(dirs), 'abc').replace('\\', '/') '/foo/bar/existing/libabc.dylib' >>> monkeypatch.setattr(os.path, 'exists', ... lambda d: 'existing' in d and '.a' in d) >>> compiler.find_library_file(dirs, 'abc').replace('\\', '/') '/foo/bar/existing/libabc.a' >>> compiler.find_library_file(reversed(dirs), 'abc').replace('\\', '/') '/foo/bar/existing/libabc.a'

def library_dir_option(self, dir): (source)

Return the compiler option to add 'dir' to the list of directories searched for libraries.

def library_option(self, lib): (source)

Return the compiler option to add 'lib' to the list of libraries linked into the shared library or executable.

def 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): (source)

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.

def preprocess(self, source, output_file=None, macros=None, include_dirs=None, extra_preargs=None, extra_postargs=None): (source)

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.

def runtime_library_dir_option(self, dir): (source)

Return the compiler option to add 'dir' to the list of directories searched for runtime libraries.

dylib_lib_extension: str = (source)
executables: dict = (source)

Undocumented

xcode_stub_lib_extension: str = (source)

Undocumented

@staticmethod
def _library_root(dir): (source)

macOS users can specify an alternate SDK using'-isysroot'. Calculate the SDK root if it is specified. Note that, as of Xcode 7, Apple SDKs may contain textual stub libraries with .tbd extensions rather than the normal .dylib shared libraries installed in /. The Apple compiler tool chain handles this transparently but it can cause problems for programs that are being built with an SDK and searching for specific libraries. Callers of find_library_file need to keep in mind that the base filename of the returned SDK library file might have a different extension from that of the library file installed on the running system, for example: /Applications/Xcode.app/Contents/Developer/Platforms/ MacOSX.platform/Developer/SDKs/MacOSX10.11.sdk/ usr/lib/libedit.tbd vs /usr/lib/libedit.dylib

def _compile(self, obj, src, ext, cc_args, extra_postargs, pp_opts): (source)
def _is_gcc(self): (source)

Undocumented