| """distutils.ccompiler |
| |
| Contains CCompiler, an abstract base class that defines the interface |
| for the Distutils compiler abstraction model.""" |
| |
| # This module should be kept compatible with Python 1.5.2. |
| |
| __revision__ = "$Id$" |
| |
| import sys, os, re |
| from types import * |
| from copy import copy |
| from distutils.errors import * |
| from distutils.spawn import spawn |
| from distutils.file_util import move_file |
| from distutils.dir_util import mkpath |
| from distutils.dep_util import newer_pairwise, newer_group |
| from distutils.sysconfig import python_build |
| from distutils.util import split_quoted, execute |
| from distutils import log |
| |
| class CCompiler: |
| """Abstract base class to define the interface that must be implemented |
| by real compiler classes. Also has some utility methods used by |
| several compiler classes. |
| |
| The basic idea behind a compiler abstraction class is that each |
| instance can be used for all the compile/link steps in building a |
| single project. Thus, attributes common to all of those compile and |
| link steps -- include directories, macros to define, libraries to link |
| against, etc. -- are attributes of the compiler instance. To allow for |
| variability in how individual files are treated, most of those |
| attributes may be varied on a per-compilation or per-link basis. |
| """ |
| |
| # 'compiler_type' is a class attribute that identifies this class. It |
| # keeps code that wants to know what kind of compiler it's dealing with |
| # from having to import all possible compiler classes just to do an |
| # 'isinstance'. In concrete CCompiler subclasses, 'compiler_type' |
| # should really, really be one of the keys of the 'compiler_class' |
| # dictionary (see below -- used by the 'new_compiler()' factory |
| # function) -- authors of new compiler interface classes are |
| # responsible for updating 'compiler_class'! |
| compiler_type = None |
| |
| # XXX things not handled by this compiler abstraction model: |
| # * client can't provide additional options for a compiler, |
| # e.g. warning, optimization, debugging flags. Perhaps this |
| # should be the domain of concrete compiler abstraction classes |
| # (UnixCCompiler, MSVCCompiler, etc.) -- or perhaps the base |
| # class should have methods for the common ones. |
| # * can't completely override the include or library searchg |
| # path, ie. no "cc -I -Idir1 -Idir2" or "cc -L -Ldir1 -Ldir2". |
| # I'm not sure how widely supported this is even by Unix |
| # compilers, much less on other platforms. And I'm even less |
| # sure how useful it is; maybe for cross-compiling, but |
| # support for that is a ways off. (And anyways, cross |
| # compilers probably have a dedicated binary with the |
| # right paths compiled in. I hope.) |
| # * can't do really freaky things with the library list/library |
| # dirs, e.g. "-Ldir1 -lfoo -Ldir2 -lfoo" to link against |
| # different versions of libfoo.a in different locations. I |
| # think this is useless without the ability to null out the |
| # library search path anyways. |
| |
| |
| # Subclasses that rely on the standard filename generation methods |
| # implemented below should override these; see the comment near |
| # those methods ('object_filenames()' et. al.) for details: |
| src_extensions = None # list of strings |
| obj_extension = None # string |
| static_lib_extension = None |
| shared_lib_extension = None # string |
| static_lib_format = None # format string |
| shared_lib_format = None # prob. same as static_lib_format |
| exe_extension = None # string |
| |
| # Default language settings. language_map is used to detect a source |
| # file or Extension target language, checking source filenames. |
| # language_order is used to detect the language precedence, when deciding |
| # what language to use when mixing source types. For example, if some |
| # extension has two files with ".c" extension, and one with ".cpp", it |
| # is still linked as c++. |
| language_map = {".c" : "c", |
| ".cc" : "c++", |
| ".cpp" : "c++", |
| ".cxx" : "c++", |
| ".m" : "objc", |
| } |
| language_order = ["c++", "objc", "c"] |
| |
| def __init__ (self, |
| verbose=0, |
| dry_run=0, |
| force=0): |
| |
| self.dry_run = dry_run |
| self.force = force |
| self.verbose = verbose |
| |
| # 'output_dir': a common output directory for object, library, |
| # shared object, and shared library files |
| self.output_dir = None |
| |
| # 'macros': a list of macro definitions (or undefinitions). A |
| # macro definition is a 2-tuple (name, value), where the value is |
| # either a string or None (no explicit value). A macro |
| # undefinition is a 1-tuple (name,). |
| self.macros = [] |
| |
| # 'include_dirs': a list of directories to search for include files |
| self.include_dirs = [] |
| |
| # 'libraries': a list of libraries to include in any link |
| # (library names, not filenames: eg. "foo" not "libfoo.a") |
| self.libraries = [] |
| |
| # 'library_dirs': a list of directories to search for libraries |
| self.library_dirs = [] |
| |
| # 'runtime_library_dirs': a list of directories to search for |
| # shared libraries/objects at runtime |
| self.runtime_library_dirs = [] |
| |
| # 'objects': a list of object files (or similar, such as explicitly |
| # named library files) to include on any link |
| self.objects = [] |
| |
| for key in self.executables.keys(): |
| self.set_executable(key, self.executables[key]) |
| |
| # __init__ () |
| |
| |
| def 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()'.) |
| """ |
| |
| # Note that some CCompiler implementation classes will define class |
| # attributes 'cpp', 'cc', etc. with hard-coded executable names; |
| # this is appropriate when a compiler class is for exactly one |
| # compiler/OS combination (eg. MSVCCompiler). Other compiler |
| # classes (UnixCCompiler, in particular) are driven by information |
| # discovered at run-time, since there are many different ways to do |
| # basically the same things with Unix C compilers. |
| |
| for key in args.keys(): |
| if not self.executables.has_key(key): |
| raise ValueError, \ |
| "unknown executable '%s' for class %s" % \ |
| (key, self.__class__.__name__) |
| self.set_executable(key, args[key]) |
| |
| # set_executables () |
| |
| def set_executable(self, key, value): |
| if type(value) is StringType: |
| setattr(self, key, split_quoted(value)) |
| else: |
| setattr(self, key, value) |
| |
| |
| def _find_macro (self, name): |
| i = 0 |
| for defn in self.macros: |
| if defn[0] == name: |
| return i |
| i = i + 1 |
| |
| return None |
| |
| |
| def _check_macro_definitions (self, 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. |
| """ |
| for defn in definitions: |
| if not (type (defn) is TupleType and |
| (len (defn) == 1 or |
| (len (defn) == 2 and |
| (type (defn[1]) is StringType or defn[1] is None))) and |
| type (defn[0]) is StringType): |
| raise TypeError, \ |
| ("invalid macro definition '%s': " % defn) + \ |
| "must be tuple (string,), (string, string), or " + \ |
| "(string, None)" |
| |
| |
| # -- Bookkeeping methods ------------------------------------------- |
| |
| def 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?) |
| """ |
| # Delete from the list of macro definitions/undefinitions if |
| # already there (so that this one will take precedence). |
| i = self._find_macro (name) |
| if i is not None: |
| del self.macros[i] |
| |
| defn = (name, value) |
| self.macros.append (defn) |
| |
| |
| def 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. |
| """ |
| # Delete from the list of macro definitions/undefinitions if |
| # already there (so that this one will take precedence). |
| i = self._find_macro (name) |
| if i is not None: |
| del self.macros[i] |
| |
| undefn = (name,) |
| self.macros.append (undefn) |
| |
| |
| def 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()'. |
| """ |
| self.include_dirs.append (dir) |
| |
| def 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. |
| """ |
| self.include_dirs = copy (dirs) |
| |
| |
| def 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. |
| """ |
| self.libraries.append (libname) |
| |
| def 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. |
| """ |
| self.libraries = copy (libnames) |
| |
| |
| def 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()'. |
| """ |
| self.library_dirs.append (dir) |
| |
| def 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. |
| """ |
| self.library_dirs = copy (dirs) |
| |
| |
| def add_runtime_library_dir (self, dir): |
| """Add 'dir' to the list of directories that will be searched for |
| shared libraries at runtime. |
| """ |
| self.runtime_library_dirs.append (dir) |
| |
| def 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. |
| """ |
| self.runtime_library_dirs = copy (dirs) |
| |
| |
| def 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. |
| """ |
| self.objects.append (object) |
| |
| def 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). |
| """ |
| self.objects = copy (objects) |
| |
| |
| # -- Private utility methods -------------------------------------- |
| # (here for the convenience of subclasses) |
| |
| # Helper method to prep compiler in subclass compile() methods |
| |
| def _setup_compile(self, outdir, macros, incdirs, sources, depends, |
| extra): |
| """Process arguments and decide which source files to compile. |
| |
| Merges _fix_compile_args() and _prep_compile(). |
| """ |
| if outdir is None: |
| outdir = self.output_dir |
| elif type(outdir) is not StringType: |
| raise TypeError, "'output_dir' must be a string or None" |
| |
| if macros is None: |
| macros = self.macros |
| elif type(macros) is ListType: |
| macros = macros + (self.macros or []) |
| else: |
| raise TypeError, "'macros' (if supplied) must be a list of tuples" |
| |
| if incdirs is None: |
| incdirs = self.include_dirs |
| elif type(incdirs) in (ListType, TupleType): |
| incdirs = list(incdirs) + (self.include_dirs or []) |
| else: |
| raise TypeError, \ |
| "'include_dirs' (if supplied) must be a list of strings" |
| |
| if extra is None: |
| extra = [] |
| |
| # Get the list of expected output (object) files |
| objects = self.object_filenames(sources, |
| strip_dir=python_build, |
| output_dir=outdir) |
| assert len(objects) == len(sources) |
| |
| # XXX should redo this code to eliminate skip_source entirely. |
| # XXX instead create build and issue skip messages inline |
| |
| if self.force: |
| skip_source = {} # rebuild everything |
| for source in sources: |
| skip_source[source] = 0 |
| elif depends is None: |
| # If depends is None, figure out which source files we |
| # have to recompile according to a simplistic check. We |
| # just compare the source and object file, no deep |
| # dependency checking involving header files. |
| skip_source = {} # rebuild everything |
| for source in sources: # no wait, rebuild nothing |
| skip_source[source] = 1 |
| |
| n_sources, n_objects = newer_pairwise(sources, objects) |
| for source in n_sources: # no really, only rebuild what's |
| skip_source[source] = 0 # out-of-date |
| else: |
| # If depends is a list of files, then do a different |
| # simplistic check. Assume that each object depends on |
| # its source and all files in the depends list. |
| skip_source = {} |
| # L contains all the depends plus a spot at the end for a |
| # particular source file |
| L = depends[:] + [None] |
| for i in range(len(objects)): |
| source = sources[i] |
| L[-1] = source |
| if newer_group(L, objects[i]): |
| skip_source[source] = 0 |
| else: |
| skip_source[source] = 1 |
| |
| pp_opts = gen_preprocess_options(macros, incdirs) |
| |
| build = {} |
| for i in range(len(sources)): |
| src = sources[i] |
| obj = objects[i] |
| ext = os.path.splitext(src)[1] |
| self.mkpath(os.path.dirname(obj)) |
| if skip_source[src]: |
| log.debug("skipping %s (%s up-to-date)", src, obj) |
| else: |
| build[obj] = src, ext |
| |
| return macros, objects, extra, pp_opts, build |
| |
| def _get_cc_args(self, pp_opts, debug, before): |
| # works for unixccompiler, emxccompiler, cygwinccompiler |
| cc_args = pp_opts + ['-c'] |
| if debug: |
| cc_args[:0] = ['-g'] |
| if before: |
| cc_args[:0] = before |
| return cc_args |
| |
| def _fix_compile_args (self, output_dir, macros, include_dirs): |
| """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.macros'; ensures that |
| 'include_dirs' is a list, and augments it with 'self.include_dirs'. |
| Guarantees that the returned values are of the correct type, |
| i.e. for 'output_dir' either string or None, and for 'macros' and |
| 'include_dirs' either list or None. |
| """ |
| if output_dir is None: |
| output_dir = self.output_dir |
| elif type (output_dir) is not StringType: |
| raise TypeError, "'output_dir' must be a string or None" |
| |
| if macros is None: |
| macros = self.macros |
| elif type (macros) is ListType: |
| macros = macros + (self.macros or []) |
| else: |
| raise TypeError, "'macros' (if supplied) must be a list of tuples" |
| |
| if include_dirs is None: |
| include_dirs = self.include_dirs |
| elif type (include_dirs) in (ListType, TupleType): |
| include_dirs = list (include_dirs) + (self.include_dirs or []) |
| else: |
| raise TypeError, \ |
| "'include_dirs' (if supplied) must be a list of strings" |
| |
| return output_dir, macros, include_dirs |
| |
| # _fix_compile_args () |
| |
| |
| def _prep_compile(self, sources, output_dir, depends=None): |
| """Decide which souce files must be recompiled. |
| |
| Determine the list of object files corresponding to 'sources', |
| and figure out which ones really need to be recompiled. |
| Return a list of all object files and a dictionary telling |
| which source files can be skipped. |
| """ |
| # Get the list of expected output (object) files |
| objects = self.object_filenames(sources, strip_dir=python_build, |
| output_dir=output_dir) |
| assert len(objects) == len(sources) |
| |
| if self.force: |
| skip_source = {} # rebuild everything |
| for source in sources: |
| skip_source[source] = 0 |
| elif depends is None: |
| # If depends is None, figure out which source files we |
| # have to recompile according to a simplistic check. We |
| # just compare the source and object file, no deep |
| # dependency checking involving header files. |
| skip_source = {} # rebuild everything |
| for source in sources: # no wait, rebuild nothing |
| skip_source[source] = 1 |
| |
| n_sources, n_objects = newer_pairwise(sources, objects) |
| for source in n_sources: # no really, only rebuild what's |
| skip_source[source] = 0 # out-of-date |
| else: |
| # If depends is a list of files, then do a different |
| # simplistic check. Assume that each object depends on |
| # its source and all files in the depends list. |
| skip_source = {} |
| # L contains all the depends plus a spot at the end for a |
| # particular source file |
| L = depends[:] + [None] |
| for i in range(len(objects)): |
| source = sources[i] |
| L[-1] = source |
| if newer_group(L, objects[i]): |
| skip_source[source] = 0 |
| else: |
| skip_source[source] = 1 |
| |
| return objects, skip_source |
| |
| # _prep_compile () |
| |
| |
| def _fix_object_args (self, objects, output_dir): |
| """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'. |
| """ |
| if type (objects) not in (ListType, TupleType): |
| raise TypeError, \ |
| "'objects' must be a list or tuple of strings" |
| objects = list (objects) |
| |
| if output_dir is None: |
| output_dir = self.output_dir |
| elif type (output_dir) is not StringType: |
| raise TypeError, "'output_dir' must be a string or None" |
| |
| return (objects, output_dir) |
| |
| |
| def _fix_lib_args (self, libraries, library_dirs, runtime_library_dirs): |
| """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'). Return a tuple with |
| fixed versions of all arguments. |
| """ |
| if libraries is None: |
| libraries = self.libraries |
| elif type (libraries) in (ListType, TupleType): |
| libraries = list (libraries) + (self.libraries or []) |
| else: |
| raise TypeError, \ |
| "'libraries' (if supplied) must be a list of strings" |
| |
| if library_dirs is None: |
| library_dirs = self.library_dirs |
| elif type (library_dirs) in (ListType, TupleType): |
| library_dirs = list (library_dirs) + (self.library_dirs or []) |
| else: |
| raise TypeError, \ |
| "'library_dirs' (if supplied) must be a list of strings" |
| |
| if runtime_library_dirs is None: |
| runtime_library_dirs = self.runtime_library_dirs |
| elif type (runtime_library_dirs) in (ListType, TupleType): |
| runtime_library_dirs = (list (runtime_library_dirs) + |
| (self.runtime_library_dirs or [])) |
| else: |
| raise TypeError, \ |
| "'runtime_library_dirs' (if supplied) " + \ |
| "must be a list of strings" |
| |
| return (libraries, library_dirs, runtime_library_dirs) |
| |
| # _fix_lib_args () |
| |
| |
| def _need_link (self, objects, output_file): |
| """Return true if we need to relink the files listed in 'objects' |
| to recreate 'output_file'. |
| """ |
| if self.force: |
| return 1 |
| else: |
| if self.dry_run: |
| newer = newer_group (objects, output_file, missing='newer') |
| else: |
| newer = newer_group (objects, output_file) |
| return newer |
| |
| # _need_link () |
| |
| def 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. |
| """ |
| if type(sources) is not ListType: |
| sources = [sources] |
| lang = None |
| index = len(self.language_order) |
| for source in sources: |
| base, ext = os.path.splitext(source) |
| extlang = self.language_map.get(ext) |
| try: |
| extindex = self.language_order.index(extlang) |
| if extindex < index: |
| lang = extlang |
| index = extindex |
| except ValueError: |
| pass |
| return lang |
| |
| # detect_language () |
| |
| # -- Worker methods ------------------------------------------------ |
| # (must be implemented by subclasses) |
| |
| def 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. |
| """ |
| pass |
| |
| def compile(self, sources, output_dir=None, macros=None, |
| include_dirs=None, debug=0, extra_preargs=None, |
| extra_postargs=None, depends=None): |
| """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 prepand/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. |
| """ |
| |
| # A concrete compiler class can either override this method |
| # entirely or implement _compile(). |
| |
| macros, objects, extra_postargs, pp_opts, build = \ |
| self._setup_compile(output_dir, macros, include_dirs, sources, |
| depends, extra_postargs) |
| cc_args = self._get_cc_args(pp_opts, debug, extra_preargs) |
| |
| for obj in objects: |
| try: |
| src, ext = build[obj] |
| except KeyError: |
| continue |
| self._compile(obj, src, ext, cc_args, extra_postargs, pp_opts) |
| |
| # Return *all* object filenames, not just the ones we just built. |
| return objects |
| |
| def _compile(self, obj, src, ext, cc_args, extra_postargs, pp_opts): |
| """Compile 'src' to product 'obj'.""" |
| |
| # A concrete compiler class that does not override compile() |
| # should implement _compile(). |
| pass |
| |
| def create_static_lib (self, |
| objects, |
| output_libname, |
| output_dir=None, |
| debug=0, |
| target_lang=None): |
| """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. |
| """ |
| pass |
| |
| |
| # values for target_desc parameter in link() |
| SHARED_OBJECT = "shared_object" |
| SHARED_LIBRARY = "shared_library" |
| EXECUTABLE = "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): |
| """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. |
| """ |
| raise NotImplementedError |
| |
| |
| # Old 'link_*()' methods, rewritten to use the new 'link()' method. |
| |
| def 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): |
| self.link(CCompiler.SHARED_LIBRARY, objects, |
| self.library_filename(output_libname, lib_type='shared'), |
| output_dir, |
| libraries, library_dirs, runtime_library_dirs, |
| export_symbols, debug, |
| extra_preargs, extra_postargs, build_temp, target_lang) |
| |
| |
| def 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): |
| self.link(CCompiler.SHARED_OBJECT, objects, |
| output_filename, output_dir, |
| libraries, library_dirs, runtime_library_dirs, |
| export_symbols, debug, |
| extra_preargs, extra_postargs, build_temp, target_lang) |
| |
| |
| def 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): |
| self.link(CCompiler.EXECUTABLE, objects, |
| self.executable_filename(output_progname), output_dir, |
| libraries, library_dirs, runtime_library_dirs, None, |
| debug, extra_preargs, extra_postargs, None, target_lang) |
| |
| |
| # -- Miscellaneous methods ----------------------------------------- |
| # These are all used by the 'gen_lib_options() function; there is |
| # no appropriate default implementation so subclasses should |
| # implement all of these. |
| |
| def library_dir_option (self, dir): |
| """Return the compiler option to add 'dir' to the list of |
| directories searched for libraries. |
| """ |
| raise NotImplementedError |
| |
| def runtime_library_dir_option (self, dir): |
| """Return the compiler option to add 'dir' to the list of |
| directories searched for runtime libraries. |
| """ |
| raise NotImplementedError |
| |
| def library_option (self, lib): |
| """Return the compiler option to add 'dir' to the list of libraries |
| linked into the shared library or executable. |
| """ |
| raise NotImplementedError |
| |
| def 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. |
| """ |
| |
| # this can't be included at module scope because it tries to |
| # import math which might not be available at that point - maybe |
| # the necessary logic should just be inlined? |
| import tempfile |
| if includes is None: |
| includes = [] |
| if include_dirs is None: |
| include_dirs = [] |
| if libraries is None: |
| libraries = [] |
| if library_dirs is None: |
| library_dirs = [] |
| fd, fname = tempfile.mkstemp(".c", funcname, text=True) |
| f = os.fdopen(fd, "w") |
| for incl in includes: |
| f.write("""#include "%s"\n""" % incl) |
| f.write("""\ |
| main (int argc, char **argv) { |
| %s(); |
| } |
| """ % funcname) |
| f.close() |
| try: |
| objects = self.compile([fname], include_dirs=include_dirs) |
| except CompileError: |
| return False |
| |
| try: |
| self.link_executable(objects, "a.out", |
| libraries=libraries, |
| library_dirs=library_dirs) |
| except (LinkError, TypeError): |
| return False |
| return True |
| |
| def find_library_file (self, dirs, lib, debug=0): |
| """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. |
| """ |
| raise NotImplementedError |
| |
| # -- Filename generation methods ----------------------------------- |
| |
| # The default implementation of the filename generating methods are |
| # prejudiced towards the Unix/DOS/Windows view of the world: |
| # * object files are named by replacing the source file extension |
| # (eg. .c/.cpp -> .o/.obj) |
| # * library files (shared or static) are named by plugging the |
| # library name and extension into a format string, eg. |
| # "lib%s.%s" % (lib_name, ".a") for Unix static libraries |
| # * executables are named by appending an extension (possibly |
| # empty) to the program name: eg. progname + ".exe" for |
| # Windows |
| # |
| # To reduce redundant code, these methods expect to find |
| # several attributes in the current object (presumably defined |
| # as class attributes): |
| # * src_extensions - |
| # list of C/C++ source file extensions, eg. ['.c', '.cpp'] |
| # * obj_extension - |
| # object file extension, eg. '.o' or '.obj' |
| # * static_lib_extension - |
| # extension for static library files, eg. '.a' or '.lib' |
| # * shared_lib_extension - |
| # extension for shared library/object files, eg. '.so', '.dll' |
| # * static_lib_format - |
| # format string for generating static library filenames, |
| # eg. 'lib%s.%s' or '%s.%s' |
| # * shared_lib_format |
| # format string for generating shared library filenames |
| # (probably same as static_lib_format, since the extension |
| # is one of the intended parameters to the format string) |
| # * exe_extension - |
| # extension for executable files, eg. '' or '.exe' |
| |
| def object_filenames(self, source_filenames, strip_dir=0, output_dir=''): |
| if output_dir is None: |
| output_dir = '' |
| obj_names = [] |
| for src_name in source_filenames: |
| base, ext = os.path.splitext(src_name) |
| base = os.path.splitdrive(base)[1] # Chop off the drive |
| base = base[os.path.isabs(base):] # If abs, chop off leading / |
| if ext not in self.src_extensions: |
| raise UnknownFileError, \ |
| "unknown file type '%s' (from '%s')" % (ext, src_name) |
| if strip_dir: |
| base = os.path.basename(base) |
| obj_names.append(os.path.join(output_dir, |
| base + self.obj_extension)) |
| return obj_names |
| |
| def shared_object_filename(self, basename, strip_dir=0, output_dir=''): |
| assert output_dir is not None |
| if strip_dir: |
| basename = os.path.basename (basename) |
| return os.path.join(output_dir, basename + self.shared_lib_extension) |
| |
| def executable_filename(self, basename, strip_dir=0, output_dir=''): |
| assert output_dir is not None |
| if strip_dir: |
| basename = os.path.basename (basename) |
| return os.path.join(output_dir, basename + (self.exe_extension or '')) |
| |
| def library_filename(self, libname, lib_type='static', # or 'shared' |
| strip_dir=0, output_dir=''): |
| assert output_dir is not None |
| if lib_type not in ("static", "shared", "dylib"): |
| raise ValueError, "'lib_type' must be \"static\", \"shared\" or \"dylib\"" |
| fmt = getattr(self, lib_type + "_lib_format") |
| ext = getattr(self, lib_type + "_lib_extension") |
| |
| dir, base = os.path.split (libname) |
| filename = fmt % (base, ext) |
| if strip_dir: |
| dir = '' |
| |
| return os.path.join(output_dir, dir, filename) |
| |
| |
| # -- Utility methods ----------------------------------------------- |
| |
| def announce (self, msg, level=1): |
| log.debug(msg) |
| |
| def debug_print (self, msg): |
| from distutils.debug import DEBUG |
| if DEBUG: |
| print msg |
| |
| def warn (self, msg): |
| sys.stderr.write ("warning: %s\n" % msg) |
| |
| def execute (self, func, args, msg=None, level=1): |
| execute(func, args, msg, self.dry_run) |
| |
| def spawn (self, cmd): |
| spawn (cmd, dry_run=self.dry_run) |
| |
| def move_file (self, src, dst): |
| return move_file (src, dst, dry_run=self.dry_run) |
| |
| def mkpath (self, name, mode=0777): |
| mkpath (name, mode, self.dry_run) |
| |
| |
| # class CCompiler |
| |
| |
| # Map a sys.platform/os.name ('posix', 'nt') to the default compiler |
| # type for that platform. Keys are interpreted as re match |
| # patterns. Order is important; platform mappings are preferred over |
| # OS names. |
| _default_compilers = ( |
| |
| # Platform string mappings |
| |
| # on a cygwin built python we can use gcc like an ordinary UNIXish |
| # compiler |
| ('cygwin.*', 'unix'), |
| ('os2emx', 'emx'), |
| |
| # OS name mappings |
| ('posix', 'unix'), |
| ('nt', 'msvc'), |
| ('mac', 'mwerks'), |
| |
| ) |
| |
| def get_default_compiler(osname=None, platform=None): |
| |
| """ Determine the default compiler to use for the given platform. |
| |
| osname should be one of the standard Python OS names (i.e. the |
| ones returned by os.name) and platform the common value |
| returned by sys.platform for the platform in question. |
| |
| The default values are os.name and sys.platform in case the |
| parameters are not given. |
| |
| """ |
| if osname is None: |
| osname = os.name |
| if platform is None: |
| platform = sys.platform |
| for pattern, compiler in _default_compilers: |
| if re.match(pattern, platform) is not None or \ |
| re.match(pattern, osname) is not None: |
| return compiler |
| # Default to Unix compiler |
| return 'unix' |
| |
| # Map compiler types to (module_name, class_name) pairs -- ie. where to |
| # find the code that implements an interface to this compiler. (The module |
| # is assumed to be in the 'distutils' package.) |
| compiler_class = { 'unix': ('unixccompiler', 'UnixCCompiler', |
| "standard UNIX-style compiler"), |
| 'msvc': ('msvccompiler', 'MSVCCompiler', |
| "Microsoft Visual C++"), |
| 'cygwin': ('cygwinccompiler', 'CygwinCCompiler', |
| "Cygwin port of GNU C Compiler for Win32"), |
| 'mingw32': ('cygwinccompiler', 'Mingw32CCompiler', |
| "Mingw32 port of GNU C Compiler for Win32"), |
| 'bcpp': ('bcppcompiler', 'BCPPCompiler', |
| "Borland C++ Compiler"), |
| 'mwerks': ('mwerkscompiler', 'MWerksCompiler', |
| "MetroWerks CodeWarrior"), |
| 'emx': ('emxccompiler', 'EMXCCompiler', |
| "EMX port of GNU C Compiler for OS/2"), |
| } |
| |
| def show_compilers(): |
| """Print list of available compilers (used by the "--help-compiler" |
| options to "build", "build_ext", "build_clib"). |
| """ |
| # XXX this "knows" that the compiler option it's describing is |
| # "--compiler", which just happens to be the case for the three |
| # commands that use it. |
| from distutils.fancy_getopt import FancyGetopt |
| compilers = [] |
| for compiler in compiler_class.keys(): |
| compilers.append(("compiler="+compiler, None, |
| compiler_class[compiler][2])) |
| compilers.sort() |
| pretty_printer = FancyGetopt(compilers) |
| pretty_printer.print_help("List of available compilers:") |
| |
| |
| def new_compiler (plat=None, |
| compiler=None, |
| verbose=0, |
| dry_run=0, |
| force=0): |
| """Generate an instance of some CCompiler subclass for the supplied |
| platform/compiler combination. 'plat' defaults to 'os.name' |
| (eg. 'posix', 'nt'), and 'compiler' defaults to the default compiler |
| for that platform. Currently only 'posix' and 'nt' are supported, and |
| the default compilers are "traditional Unix interface" (UnixCCompiler |
| class) and Visual C++ (MSVCCompiler class). Note that it's perfectly |
| possible to ask for a Unix compiler object under Windows, and a |
| Microsoft compiler object under Unix -- if you supply a value for |
| 'compiler', 'plat' is ignored. |
| """ |
| if plat is None: |
| plat = os.name |
| |
| try: |
| if compiler is None: |
| compiler = get_default_compiler(plat) |
| |
| (module_name, class_name, long_description) = compiler_class[compiler] |
| except KeyError: |
| msg = "don't know how to compile C/C++ code on platform '%s'" % plat |
| if compiler is not None: |
| msg = msg + " with '%s' compiler" % compiler |
| raise DistutilsPlatformError, msg |
| |
| try: |
| module_name = "distutils." + module_name |
| __import__ (module_name) |
| module = sys.modules[module_name] |
| klass = vars(module)[class_name] |
| except ImportError: |
| raise DistutilsModuleError, \ |
| "can't compile C/C++ code: unable to load module '%s'" % \ |
| module_name |
| except KeyError: |
| raise DistutilsModuleError, \ |
| ("can't compile C/C++ code: unable to find class '%s' " + |
| "in module '%s'") % (class_name, module_name) |
| |
| # XXX The None is necessary to preserve backwards compatibility |
| # with classes that expect verbose to be the first positional |
| # argument. |
| return klass (None, dry_run, force) |
| |
| |
| def gen_preprocess_options (macros, include_dirs): |
| """Generate C pre-processor options (-D, -U, -I) as used by at least |
| two types of compilers: the typical Unix compiler and Visual C++. |
| 'macros' is the usual thing, a list of 1- or 2-tuples, where (name,) |
| means undefine (-U) macro 'name', and (name,value) means define (-D) |
| macro 'name' to 'value'. 'include_dirs' is just a list of directory |
| names to be added to the header file search path (-I). Returns a list |
| of command-line options suitable for either Unix compilers or Visual |
| C++. |
| """ |
| # XXX it would be nice (mainly aesthetic, and so we don't generate |
| # stupid-looking command lines) to go over 'macros' and eliminate |
| # redundant definitions/undefinitions (ie. ensure that only the |
| # latest mention of a particular macro winds up on the command |
| # line). I don't think it's essential, though, since most (all?) |
| # Unix C compilers only pay attention to the latest -D or -U |
| # mention of a macro on their command line. Similar situation for |
| # 'include_dirs'. I'm punting on both for now. Anyways, weeding out |
| # redundancies like this should probably be the province of |
| # CCompiler, since the data structures used are inherited from it |
| # and therefore common to all CCompiler classes. |
| |
| pp_opts = [] |
| for macro in macros: |
| |
| if not (type (macro) is TupleType and |
| 1 <= len (macro) <= 2): |
| raise TypeError, \ |
| ("bad macro definition '%s': " + |
| "each element of 'macros' list must be a 1- or 2-tuple") % \ |
| macro |
| |
| if len (macro) == 1: # undefine this macro |
| pp_opts.append ("-U%s" % macro[0]) |
| elif len (macro) == 2: |
| if macro[1] is None: # define with no explicit value |
| pp_opts.append ("-D%s" % macro[0]) |
| else: |
| # XXX *don't* need to be clever about quoting the |
| # macro value here, because we're going to avoid the |
| # shell at all costs when we spawn the command! |
| pp_opts.append ("-D%s=%s" % macro) |
| |
| for dir in include_dirs: |
| pp_opts.append ("-I%s" % dir) |
| |
| return pp_opts |
| |
| # gen_preprocess_options () |
| |
| |
| def gen_lib_options (compiler, library_dirs, runtime_library_dirs, libraries): |
| """Generate linker options for searching library directories and |
| linking with specific libraries. 'libraries' and 'library_dirs' are, |
| respectively, lists of library names (not filenames!) and search |
| directories. Returns a list of command-line options suitable for use |
| with some compiler (depending on the two format strings passed in). |
| """ |
| lib_opts = [] |
| |
| for dir in library_dirs: |
| lib_opts.append (compiler.library_dir_option (dir)) |
| |
| for dir in runtime_library_dirs: |
| lib_opts.append (compiler.runtime_library_dir_option (dir)) |
| |
| # XXX it's important that we *not* remove redundant library mentions! |
| # sometimes you really do have to say "-lfoo -lbar -lfoo" in order to |
| # resolve all symbols. I just hope we never have to say "-lfoo obj.o |
| # -lbar" to get things to work -- that's certainly a possibility, but a |
| # pretty nasty way to arrange your C code. |
| |
| for lib in libraries: |
| (lib_dir, lib_name) = os.path.split (lib) |
| if lib_dir: |
| lib_file = compiler.find_library_file ([lib_dir], lib_name) |
| if lib_file: |
| lib_opts.append (lib_file) |
| else: |
| compiler.warn ("no library file corresponding to " |
| "'%s' found (skipping)" % lib) |
| else: |
| lib_opts.append (compiler.library_option (lib)) |
| |
| return lib_opts |
| |
| # gen_lib_options () |