Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 1 | """distutils.ccompiler |
| 2 | |
| 3 | Contains CCompiler, an abstract base class that defines the interface |
| 4 | for the Distutils compiler abstraction model.""" |
| 5 | |
Greg Ward | 3ce77fd | 2000-03-02 01:49:45 +0000 | [diff] [blame] | 6 | __revision__ = "$Id$" |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 7 | |
Tarek Ziadé | 3679727 | 2010-07-22 12:50:05 +0000 | [diff] [blame^] | 8 | import sys, os, re |
| 9 | from distutils.errors import * |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 10 | from distutils.spawn import spawn |
Greg Ward | e5c62bf | 2000-06-25 02:08:18 +0000 | [diff] [blame] | 11 | from distutils.file_util import move_file |
| 12 | from distutils.dir_util import mkpath |
Tarek Ziadé | 3679727 | 2010-07-22 12:50:05 +0000 | [diff] [blame^] | 13 | from distutils.dep_util import newer_pairwise, newer_group |
Greg Ward | 9dddbb4 | 2000-08-02 01:38:20 +0000 | [diff] [blame] | 14 | from distutils.util import split_quoted, execute |
Jeremy Hylton | cd8a114 | 2002-06-04 20:14:43 +0000 | [diff] [blame] | 15 | from distutils import log |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 16 | |
| 17 | class CCompiler: |
| 18 | """Abstract base class to define the interface that must be implemented |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 19 | by real compiler classes. Also has some utility methods used by |
| 20 | several compiler classes. |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 21 | |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 22 | The basic idea behind a compiler abstraction class is that each |
| 23 | instance can be used for all the compile/link steps in building a |
| 24 | single project. Thus, attributes common to all of those compile and |
| 25 | link steps -- include directories, macros to define, libraries to link |
| 26 | against, etc. -- are attributes of the compiler instance. To allow for |
| 27 | variability in how individual files are treated, most of those |
| 28 | attributes may be varied on a per-compilation or per-link basis. |
| 29 | """ |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 30 | |
Greg Ward | 802d6b7 | 1999-09-29 12:20:55 +0000 | [diff] [blame] | 31 | # 'compiler_type' is a class attribute that identifies this class. It |
| 32 | # keeps code that wants to know what kind of compiler it's dealing with |
| 33 | # from having to import all possible compiler classes just to do an |
| 34 | # 'isinstance'. In concrete CCompiler subclasses, 'compiler_type' |
| 35 | # should really, really be one of the keys of the 'compiler_class' |
| 36 | # dictionary (see below -- used by the 'new_compiler()' factory |
| 37 | # function) -- authors of new compiler interface classes are |
| 38 | # responsible for updating 'compiler_class'! |
| 39 | compiler_type = None |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 40 | |
| 41 | # XXX things not handled by this compiler abstraction model: |
| 42 | # * client can't provide additional options for a compiler, |
| 43 | # e.g. warning, optimization, debugging flags. Perhaps this |
| 44 | # should be the domain of concrete compiler abstraction classes |
| 45 | # (UnixCCompiler, MSVCCompiler, etc.) -- or perhaps the base |
| 46 | # class should have methods for the common ones. |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 47 | # * can't completely override the include or library searchg |
| 48 | # path, ie. no "cc -I -Idir1 -Idir2" or "cc -L -Ldir1 -Ldir2". |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 49 | # I'm not sure how widely supported this is even by Unix |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 50 | # compilers, much less on other platforms. And I'm even less |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 51 | # sure how useful it is; maybe for cross-compiling, but |
| 52 | # support for that is a ways off. (And anyways, cross |
| 53 | # compilers probably have a dedicated binary with the |
| 54 | # right paths compiled in. I hope.) |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 55 | # * can't do really freaky things with the library list/library |
| 56 | # dirs, e.g. "-Ldir1 -lfoo -Ldir2 -lfoo" to link against |
| 57 | # different versions of libfoo.a in different locations. I |
| 58 | # think this is useless without the ability to null out the |
| 59 | # library search path anyways. |
Fred Drake | b94b849 | 2001-12-06 20:51:35 +0000 | [diff] [blame] | 60 | |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 61 | |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame] | 62 | # Subclasses that rely on the standard filename generation methods |
| 63 | # implemented below should override these; see the comment near |
| 64 | # those methods ('object_filenames()' et. al.) for details: |
| 65 | src_extensions = None # list of strings |
| 66 | obj_extension = None # string |
| 67 | static_lib_extension = None |
| 68 | shared_lib_extension = None # string |
| 69 | static_lib_format = None # format string |
| 70 | shared_lib_format = None # prob. same as static_lib_format |
| 71 | exe_extension = None # string |
| 72 | |
Gustavo Niemeyer | 6b01685 | 2002-11-05 16:12:02 +0000 | [diff] [blame] | 73 | # Default language settings. language_map is used to detect a source |
| 74 | # file or Extension target language, checking source filenames. |
| 75 | # language_order is used to detect the language precedence, when deciding |
| 76 | # what language to use when mixing source types. For example, if some |
| 77 | # extension has two files with ".c" extension, and one with ".cpp", it |
| 78 | # is still linked as c++. |
| 79 | language_map = {".c" : "c", |
| 80 | ".cc" : "c++", |
| 81 | ".cpp" : "c++", |
| 82 | ".cxx" : "c++", |
| 83 | ".m" : "objc", |
| 84 | } |
| 85 | language_order = ["c++", "objc", "c"] |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame] | 86 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 87 | def __init__(self, verbose=0, dry_run=0, force=0): |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 88 | self.dry_run = dry_run |
Greg Ward | 3febd60 | 1999-10-03 20:41:02 +0000 | [diff] [blame] | 89 | self.force = force |
Skip Montanaro | 70e1d9b | 2002-10-01 17:39:59 +0000 | [diff] [blame] | 90 | self.verbose = verbose |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 91 | |
Greg Ward | 9b17cb5 | 1999-09-13 03:07:24 +0000 | [diff] [blame] | 92 | # 'output_dir': a common output directory for object, library, |
| 93 | # shared object, and shared library files |
| 94 | self.output_dir = None |
| 95 | |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 96 | # 'macros': a list of macro definitions (or undefinitions). A |
| 97 | # macro definition is a 2-tuple (name, value), where the value is |
| 98 | # either a string or None (no explicit value). A macro |
| 99 | # undefinition is a 1-tuple (name,). |
| 100 | self.macros = [] |
| 101 | |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 102 | # 'include_dirs': a list of directories to search for include files |
| 103 | self.include_dirs = [] |
| 104 | |
| 105 | # 'libraries': a list of libraries to include in any link |
| 106 | # (library names, not filenames: eg. "foo" not "libfoo.a") |
| 107 | self.libraries = [] |
| 108 | |
| 109 | # 'library_dirs': a list of directories to search for libraries |
| 110 | self.library_dirs = [] |
| 111 | |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 112 | # 'runtime_library_dirs': a list of directories to search for |
| 113 | # shared libraries/objects at runtime |
| 114 | self.runtime_library_dirs = [] |
| 115 | |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 116 | # 'objects': a list of object files (or similar, such as explicitly |
| 117 | # named library files) to include on any link |
| 118 | self.objects = [] |
| 119 | |
Greg Ward | e5c62bf | 2000-06-25 02:08:18 +0000 | [diff] [blame] | 120 | for key in self.executables.keys(): |
| 121 | self.set_executable(key, self.executables[key]) |
| 122 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 123 | def set_executables(self, **kwargs): |
Greg Ward | e5c62bf | 2000-06-25 02:08:18 +0000 | [diff] [blame] | 124 | """Define the executables (and options for them) that will be run |
| 125 | to perform the various stages of compilation. The exact set of |
| 126 | executables that may be specified here depends on the compiler |
| 127 | class (via the 'executables' class attribute), but most will have: |
| 128 | compiler the C/C++ compiler |
| 129 | linker_so linker used to create shared objects and libraries |
| 130 | linker_exe linker used to create binary executables |
| 131 | archiver static library creator |
| 132 | |
| 133 | On platforms with a command-line (Unix, DOS/Windows), each of these |
| 134 | is a string that will be split into executable name and (optional) |
| 135 | list of arguments. (Splitting the string is done similarly to how |
| 136 | Unix shells operate: words are delimited by spaces, but quotes and |
| 137 | backslashes can override this. See |
| 138 | 'distutils.util.split_quoted()'.) |
| 139 | """ |
| 140 | |
| 141 | # Note that some CCompiler implementation classes will define class |
| 142 | # attributes 'cpp', 'cc', etc. with hard-coded executable names; |
| 143 | # this is appropriate when a compiler class is for exactly one |
| 144 | # compiler/OS combination (eg. MSVCCompiler). Other compiler |
| 145 | # classes (UnixCCompiler, in particular) are driven by information |
| 146 | # discovered at run-time, since there are many different ways to do |
| 147 | # basically the same things with Unix C compilers. |
| 148 | |
Christian Heimes | c3f30c4 | 2008-02-22 16:37:40 +0000 | [diff] [blame] | 149 | for key in kwargs: |
Guido van Rossum | e2b70bc | 2006-08-18 22:13:04 +0000 | [diff] [blame] | 150 | if key not in self.executables: |
Christian Heimes | c3f30c4 | 2008-02-22 16:37:40 +0000 | [diff] [blame] | 151 | raise ValueError("unknown executable '%s' for class %s" % |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 152 | (key, self.__class__.__name__)) |
Christian Heimes | c3f30c4 | 2008-02-22 16:37:40 +0000 | [diff] [blame] | 153 | self.set_executable(key, kwargs[key]) |
Greg Ward | e5c62bf | 2000-06-25 02:08:18 +0000 | [diff] [blame] | 154 | |
| 155 | def set_executable(self, key, value): |
Guido van Rossum | 3172c5d | 2007-10-16 18:12:55 +0000 | [diff] [blame] | 156 | if isinstance(value, str): |
Greg Ward | e5c62bf | 2000-06-25 02:08:18 +0000 | [diff] [blame] | 157 | setattr(self, key, split_quoted(value)) |
| 158 | else: |
| 159 | setattr(self, key, value) |
Fred Drake | b94b849 | 2001-12-06 20:51:35 +0000 | [diff] [blame] | 160 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 161 | def _find_macro(self, name): |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 162 | i = 0 |
| 163 | for defn in self.macros: |
| 164 | if defn[0] == name: |
| 165 | return i |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 166 | i += 1 |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 167 | return None |
| 168 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 169 | def _check_macro_definitions(self, definitions): |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 170 | """Ensures that every element of 'definitions' is a valid macro |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 171 | definition, ie. either (name,value) 2-tuple or a (name,) tuple. Do |
| 172 | nothing if all definitions are OK, raise TypeError otherwise. |
| 173 | """ |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 174 | for defn in definitions: |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 175 | if not (isinstance(defn, tuple) and |
| 176 | (len(defn) in (1, 2) and |
Guido van Rossum | 3172c5d | 2007-10-16 18:12:55 +0000 | [diff] [blame] | 177 | (isinstance (defn[1], str) or defn[1] is None)) and |
| 178 | isinstance (defn[0], str)): |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 179 | raise TypeError(("invalid macro definition '%s': " % defn) + \ |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 180 | "must be tuple (string,), (string, string), or " + \ |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 181 | "(string, None)") |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 182 | |
| 183 | |
| 184 | # -- Bookkeeping methods ------------------------------------------- |
| 185 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 186 | def define_macro(self, name, value=None): |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 187 | """Define a preprocessor macro for all compilations driven by this |
| 188 | compiler object. The optional parameter 'value' should be a |
| 189 | string; if it is not supplied, then the macro will be defined |
| 190 | without an explicit value and the exact outcome depends on the |
| 191 | compiler used (XXX true? does ANSI say anything about this?) |
| 192 | """ |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 193 | # Delete from the list of macro definitions/undefinitions if |
| 194 | # already there (so that this one will take precedence). |
| 195 | i = self._find_macro (name) |
| 196 | if i is not None: |
| 197 | del self.macros[i] |
| 198 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 199 | self.macros.append((name, value)) |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 200 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 201 | def undefine_macro(self, name): |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 202 | """Undefine a preprocessor macro for all compilations driven by |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 203 | this compiler object. If the same macro is defined by |
| 204 | 'define_macro()' and undefined by 'undefine_macro()' the last call |
| 205 | takes precedence (including multiple redefinitions or |
| 206 | undefinitions). If the macro is redefined/undefined on a |
| 207 | per-compilation basis (ie. in the call to 'compile()'), then that |
| 208 | takes precedence. |
| 209 | """ |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 210 | # Delete from the list of macro definitions/undefinitions if |
| 211 | # already there (so that this one will take precedence). |
| 212 | i = self._find_macro (name) |
| 213 | if i is not None: |
| 214 | del self.macros[i] |
| 215 | |
| 216 | undefn = (name,) |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 217 | self.macros.append(undefn) |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 218 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 219 | def add_include_dir(self, dir): |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 220 | """Add 'dir' to the list of directories that will be searched for |
| 221 | header files. The compiler is instructed to search directories in |
| 222 | the order in which they are supplied by successive calls to |
| 223 | 'add_include_dir()'. |
| 224 | """ |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 225 | self.include_dirs.append(dir) |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 226 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 227 | def set_include_dirs(self, dirs): |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 228 | """Set the list of directories that will be searched to 'dirs' (a |
| 229 | list of strings). Overrides any preceding calls to |
| 230 | 'add_include_dir()'; subsequence calls to 'add_include_dir()' add |
| 231 | to the list passed to 'set_include_dirs()'. This does not affect |
| 232 | any list of standard include directories that the compiler may |
| 233 | search by default. |
| 234 | """ |
Antoine Pitrou | 56a00de | 2009-05-15 17:34:21 +0000 | [diff] [blame] | 235 | self.include_dirs = dirs[:] |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 236 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 237 | def add_library(self, libname): |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 238 | """Add 'libname' to the list of libraries that will be included in |
| 239 | all links driven by this compiler object. Note that 'libname' |
| 240 | should *not* be the name of a file containing a library, but the |
| 241 | name of the library itself: the actual filename will be inferred by |
| 242 | the linker, the compiler, or the compiler class (depending on the |
| 243 | platform). |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 244 | |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 245 | The linker will be instructed to link against libraries in the |
| 246 | order they were supplied to 'add_library()' and/or |
| 247 | 'set_libraries()'. It is perfectly valid to duplicate library |
| 248 | names; the linker will be instructed to link against libraries as |
| 249 | many times as they are mentioned. |
| 250 | """ |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 251 | self.libraries.append(libname) |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 252 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 253 | def set_libraries(self, libnames): |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 254 | """Set the list of libraries to be included in all links driven by |
| 255 | this compiler object to 'libnames' (a list of strings). This does |
| 256 | not affect any standard system libraries that the linker may |
| 257 | include by default. |
| 258 | """ |
Antoine Pitrou | 56a00de | 2009-05-15 17:34:21 +0000 | [diff] [blame] | 259 | self.libraries = libnames[:] |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 260 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 261 | def add_library_dir(self, dir): |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 262 | """Add 'dir' to the list of directories that will be searched for |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 263 | libraries specified to 'add_library()' and 'set_libraries()'. The |
| 264 | linker will be instructed to search for libraries in the order they |
| 265 | are supplied to 'add_library_dir()' and/or 'set_library_dirs()'. |
| 266 | """ |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 267 | self.library_dirs.append(dir) |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 268 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 269 | def set_library_dirs(self, dirs): |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 270 | """Set the list of library search directories to 'dirs' (a list of |
| 271 | strings). This does not affect any standard library search path |
| 272 | that the linker may search by default. |
| 273 | """ |
Antoine Pitrou | 56a00de | 2009-05-15 17:34:21 +0000 | [diff] [blame] | 274 | self.library_dirs = dirs[:] |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 275 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 276 | def add_runtime_library_dir(self, dir): |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 277 | """Add 'dir' to the list of directories that will be searched for |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 278 | shared libraries at runtime. |
| 279 | """ |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 280 | self.runtime_library_dirs.append(dir) |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 281 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 282 | def set_runtime_library_dirs(self, dirs): |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 283 | """Set the list of directories to search for shared libraries at |
| 284 | runtime to 'dirs' (a list of strings). This does not affect any |
| 285 | standard search path that the runtime linker may search by |
| 286 | default. |
| 287 | """ |
Antoine Pitrou | 56a00de | 2009-05-15 17:34:21 +0000 | [diff] [blame] | 288 | self.runtime_library_dirs = dirs[:] |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 289 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 290 | def add_link_object(self, object): |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 291 | """Add 'object' to the list of object files (or analogues, such as |
Greg Ward | 612eb9f | 2000-07-27 02:13:20 +0000 | [diff] [blame] | 292 | explicitly named library files or the output of "resource |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 293 | compilers") to be included in every link driven by this compiler |
| 294 | object. |
| 295 | """ |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 296 | self.objects.append(object) |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 297 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 298 | def set_link_objects(self, objects): |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 299 | """Set the list of object files (or analogues) to be included in |
| 300 | every link to 'objects'. This does not affect any standard object |
| 301 | files that the linker may include by default (such as system |
| 302 | libraries). |
| 303 | """ |
Antoine Pitrou | 56a00de | 2009-05-15 17:34:21 +0000 | [diff] [blame] | 304 | self.objects = objects[:] |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 305 | |
| 306 | |
Thomas Heller | e650080 | 2002-04-25 17:03:30 +0000 | [diff] [blame] | 307 | # -- Private utility methods -------------------------------------- |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame] | 308 | # (here for the convenience of subclasses) |
| 309 | |
Jeremy Hylton | 59b103c | 2002-06-13 17:26:30 +0000 | [diff] [blame] | 310 | # Helper method to prep compiler in subclass compile() methods |
| 311 | |
| 312 | def _setup_compile(self, outdir, macros, incdirs, sources, depends, |
| 313 | extra): |
Tarek Ziadé | ac4e6ea | 2010-01-11 23:15:52 +0000 | [diff] [blame] | 314 | """Process arguments and decide which source files to compile.""" |
Jeremy Hylton | 59b103c | 2002-06-13 17:26:30 +0000 | [diff] [blame] | 315 | if outdir is None: |
| 316 | outdir = self.output_dir |
Guido van Rossum | 3172c5d | 2007-10-16 18:12:55 +0000 | [diff] [blame] | 317 | elif not isinstance(outdir, str): |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 318 | raise TypeError("'output_dir' must be a string or None") |
Jeremy Hylton | 59b103c | 2002-06-13 17:26:30 +0000 | [diff] [blame] | 319 | |
| 320 | if macros is None: |
| 321 | macros = self.macros |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 322 | elif isinstance(macros, list): |
Jeremy Hylton | 59b103c | 2002-06-13 17:26:30 +0000 | [diff] [blame] | 323 | macros = macros + (self.macros or []) |
| 324 | else: |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 325 | raise TypeError("'macros' (if supplied) must be a list of tuples") |
Jeremy Hylton | 59b103c | 2002-06-13 17:26:30 +0000 | [diff] [blame] | 326 | |
| 327 | if incdirs is None: |
| 328 | incdirs = self.include_dirs |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 329 | elif isinstance(incdirs, (list, tuple)): |
Jeremy Hylton | 59b103c | 2002-06-13 17:26:30 +0000 | [diff] [blame] | 330 | incdirs = list(incdirs) + (self.include_dirs or []) |
| 331 | else: |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 332 | raise TypeError( |
| 333 | "'include_dirs' (if supplied) must be a list of strings") |
Jeremy Hylton | 59b103c | 2002-06-13 17:26:30 +0000 | [diff] [blame] | 334 | |
| 335 | if extra is None: |
| 336 | extra = [] |
| 337 | |
| 338 | # Get the list of expected output (object) files |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 339 | objects = self.object_filenames(sources, strip_dir=0, |
Andrew M. Kuchling | 8c6e0ec | 2002-12-29 17:00:57 +0000 | [diff] [blame] | 340 | output_dir=outdir) |
Jeremy Hylton | 59b103c | 2002-06-13 17:26:30 +0000 | [diff] [blame] | 341 | assert len(objects) == len(sources) |
| 342 | |
Jeremy Hylton | 59b103c | 2002-06-13 17:26:30 +0000 | [diff] [blame] | 343 | pp_opts = gen_preprocess_options(macros, incdirs) |
| 344 | |
| 345 | build = {} |
| 346 | for i in range(len(sources)): |
| 347 | src = sources[i] |
| 348 | obj = objects[i] |
| 349 | ext = os.path.splitext(src)[1] |
| 350 | self.mkpath(os.path.dirname(obj)) |
Tarek Ziadé | ac4e6ea | 2010-01-11 23:15:52 +0000 | [diff] [blame] | 351 | build[obj] = (src, ext) |
Jeremy Hylton | 59b103c | 2002-06-13 17:26:30 +0000 | [diff] [blame] | 352 | |
| 353 | return macros, objects, extra, pp_opts, build |
| 354 | |
| 355 | def _get_cc_args(self, pp_opts, debug, before): |
| 356 | # works for unixccompiler, emxccompiler, cygwinccompiler |
| 357 | cc_args = pp_opts + ['-c'] |
| 358 | if debug: |
| 359 | cc_args[:0] = ['-g'] |
| 360 | if before: |
| 361 | cc_args[:0] = before |
| 362 | return cc_args |
| 363 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 364 | def _fix_compile_args(self, output_dir, macros, include_dirs): |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 365 | """Typecheck and fix-up some of the arguments to the 'compile()' |
| 366 | method, and return fixed-up values. Specifically: if 'output_dir' |
| 367 | is None, replaces it with 'self.output_dir'; ensures that 'macros' |
| 368 | is a list, and augments it with 'self.macros'; ensures that |
| 369 | 'include_dirs' is a list, and augments it with 'self.include_dirs'. |
| 370 | Guarantees that the returned values are of the correct type, |
| 371 | i.e. for 'output_dir' either string or None, and for 'macros' and |
| 372 | 'include_dirs' either list or None. |
| 373 | """ |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame] | 374 | if output_dir is None: |
| 375 | output_dir = self.output_dir |
Guido van Rossum | 3172c5d | 2007-10-16 18:12:55 +0000 | [diff] [blame] | 376 | elif not isinstance(output_dir, str): |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 377 | raise TypeError("'output_dir' must be a string or None") |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame] | 378 | |
| 379 | if macros is None: |
| 380 | macros = self.macros |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 381 | elif isinstance(macros, list): |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame] | 382 | macros = macros + (self.macros or []) |
| 383 | else: |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 384 | raise TypeError("'macros' (if supplied) must be a list of tuples") |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame] | 385 | |
| 386 | if include_dirs is None: |
| 387 | include_dirs = self.include_dirs |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 388 | elif isinstance(include_dirs, (list, tuple)): |
| 389 | include_dirs = list(include_dirs) + (self.include_dirs or []) |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame] | 390 | else: |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 391 | raise TypeError( |
| 392 | "'include_dirs' (if supplied) must be a list of strings") |
Fred Drake | b94b849 | 2001-12-06 20:51:35 +0000 | [diff] [blame] | 393 | |
Jeremy Hylton | 59b103c | 2002-06-13 17:26:30 +0000 | [diff] [blame] | 394 | return output_dir, macros, include_dirs |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame] | 395 | |
Tarek Ziadé | 3679727 | 2010-07-22 12:50:05 +0000 | [diff] [blame^] | 396 | def _prep_compile(self, sources, output_dir, depends=None): |
| 397 | """Decide which souce files must be recompiled. |
| 398 | |
| 399 | Determine the list of object files corresponding to 'sources', |
| 400 | and figure out which ones really need to be recompiled. |
| 401 | Return a list of all object files and a dictionary telling |
| 402 | which source files can be skipped. |
| 403 | """ |
| 404 | # Get the list of expected output (object) files |
| 405 | objects = self.object_filenames(sources, output_dir=output_dir) |
| 406 | assert len(objects) == len(sources) |
| 407 | |
| 408 | # Return an empty dict for the "which source files can be skipped" |
| 409 | # return value to preserve API compatibility. |
| 410 | return objects, {} |
| 411 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 412 | def _fix_object_args(self, objects, output_dir): |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 413 | """Typecheck and fix up some arguments supplied to various methods. |
| 414 | Specifically: ensure that 'objects' is a list; if output_dir is |
| 415 | None, replace with self.output_dir. Return fixed versions of |
| 416 | 'objects' and 'output_dir'. |
| 417 | """ |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 418 | if not isinstance(objects, (list, tuple)): |
| 419 | raise TypeError("'objects' must be a list or tuple of strings") |
| 420 | objects = list(objects) |
Fred Drake | b94b849 | 2001-12-06 20:51:35 +0000 | [diff] [blame] | 421 | |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame] | 422 | if output_dir is None: |
| 423 | output_dir = self.output_dir |
Guido van Rossum | 3172c5d | 2007-10-16 18:12:55 +0000 | [diff] [blame] | 424 | elif not isinstance(output_dir, str): |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 425 | raise TypeError("'output_dir' must be a string or None") |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame] | 426 | |
Greg Ward | f10f95d | 2000-03-26 21:37:09 +0000 | [diff] [blame] | 427 | return (objects, output_dir) |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame] | 428 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 429 | def _fix_lib_args(self, libraries, library_dirs, runtime_library_dirs): |
Greg Ward | f10f95d | 2000-03-26 21:37:09 +0000 | [diff] [blame] | 430 | """Typecheck and fix up some of the arguments supplied to the |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 431 | 'link_*' methods. Specifically: ensure that all arguments are |
| 432 | lists, and augment them with their permanent versions |
| 433 | (eg. 'self.libraries' augments 'libraries'). Return a tuple with |
| 434 | fixed versions of all arguments. |
| 435 | """ |
Greg Ward | f10f95d | 2000-03-26 21:37:09 +0000 | [diff] [blame] | 436 | if libraries is None: |
| 437 | libraries = self.libraries |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 438 | elif isinstance(libraries, (list, tuple)): |
Greg Ward | f10f95d | 2000-03-26 21:37:09 +0000 | [diff] [blame] | 439 | libraries = list (libraries) + (self.libraries or []) |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame] | 440 | else: |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 441 | raise TypeError( |
| 442 | "'libraries' (if supplied) must be a list of strings") |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame] | 443 | |
Greg Ward | f10f95d | 2000-03-26 21:37:09 +0000 | [diff] [blame] | 444 | if library_dirs is None: |
| 445 | library_dirs = self.library_dirs |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 446 | elif isinstance(library_dirs, (list, tuple)): |
Greg Ward | f10f95d | 2000-03-26 21:37:09 +0000 | [diff] [blame] | 447 | library_dirs = list (library_dirs) + (self.library_dirs or []) |
| 448 | else: |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 449 | raise TypeError( |
| 450 | "'library_dirs' (if supplied) must be a list of strings") |
Greg Ward | f10f95d | 2000-03-26 21:37:09 +0000 | [diff] [blame] | 451 | |
| 452 | if runtime_library_dirs is None: |
| 453 | runtime_library_dirs = self.runtime_library_dirs |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 454 | elif isinstance(runtime_library_dirs, (list, tuple)): |
| 455 | runtime_library_dirs = (list(runtime_library_dirs) + |
Greg Ward | f10f95d | 2000-03-26 21:37:09 +0000 | [diff] [blame] | 456 | (self.runtime_library_dirs or [])) |
| 457 | else: |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 458 | raise TypeError("'runtime_library_dirs' (if supplied) " |
| 459 | "must be a list of strings") |
Greg Ward | f10f95d | 2000-03-26 21:37:09 +0000 | [diff] [blame] | 460 | |
| 461 | return (libraries, library_dirs, runtime_library_dirs) |
| 462 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 463 | def _need_link(self, objects, output_file): |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 464 | """Return true if we need to relink the files listed in 'objects' |
| 465 | to recreate 'output_file'. |
| 466 | """ |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame] | 467 | if self.force: |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 468 | return True |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame] | 469 | else: |
| 470 | if self.dry_run: |
| 471 | newer = newer_group (objects, output_file, missing='newer') |
| 472 | else: |
| 473 | newer = newer_group (objects, output_file) |
| 474 | return newer |
| 475 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 476 | def detect_language(self, sources): |
Gustavo Niemeyer | 6b01685 | 2002-11-05 16:12:02 +0000 | [diff] [blame] | 477 | """Detect the language of a given file, or list of files. Uses |
| 478 | language_map, and language_order to do the job. |
| 479 | """ |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 480 | if not isinstance(sources, list): |
Gustavo Niemeyer | 6b01685 | 2002-11-05 16:12:02 +0000 | [diff] [blame] | 481 | sources = [sources] |
| 482 | lang = None |
| 483 | index = len(self.language_order) |
| 484 | for source in sources: |
| 485 | base, ext = os.path.splitext(source) |
| 486 | extlang = self.language_map.get(ext) |
| 487 | try: |
| 488 | extindex = self.language_order.index(extlang) |
| 489 | if extindex < index: |
| 490 | lang = extlang |
| 491 | index = extindex |
| 492 | except ValueError: |
| 493 | pass |
| 494 | return lang |
| 495 | |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame] | 496 | |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 497 | # -- Worker methods ------------------------------------------------ |
| 498 | # (must be implemented by subclasses) |
| 499 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 500 | def preprocess(self, source, output_file=None, macros=None, |
| 501 | include_dirs=None, extra_preargs=None, extra_postargs=None): |
Greg Ward | 3ff3b03 | 2000-06-21 02:58:46 +0000 | [diff] [blame] | 502 | """Preprocess a single C/C++ source file, named in 'source'. |
| 503 | Output will be written to file named 'output_file', or stdout if |
| 504 | 'output_file' not supplied. 'macros' is a list of macro |
| 505 | definitions as for 'compile()', which will augment the macros set |
| 506 | with 'define_macro()' and 'undefine_macro()'. 'include_dirs' is a |
| 507 | list of directory names that will be added to the default list. |
Greg Ward | e5c62bf | 2000-06-25 02:08:18 +0000 | [diff] [blame] | 508 | |
| 509 | Raises PreprocessError on failure. |
Greg Ward | 3ff3b03 | 2000-06-21 02:58:46 +0000 | [diff] [blame] | 510 | """ |
| 511 | pass |
| 512 | |
Jeremy Hylton | 59b103c | 2002-06-13 17:26:30 +0000 | [diff] [blame] | 513 | def compile(self, sources, output_dir=None, macros=None, |
| 514 | include_dirs=None, debug=0, extra_preargs=None, |
| 515 | extra_postargs=None, depends=None): |
| 516 | """Compile one or more source files. |
| 517 | |
| 518 | 'sources' must be a list of filenames, most likely C/C++ |
| 519 | files, but in reality anything that can be handled by a |
| 520 | particular compiler and compiler class (eg. MSVCCompiler can |
| 521 | handle resource files in 'sources'). Return a list of object |
| 522 | filenames, one per source filename in 'sources'. Depending on |
| 523 | the implementation, not all source files will necessarily be |
| 524 | compiled, but all corresponding object filenames will be |
| 525 | returned. |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame] | 526 | |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 527 | If 'output_dir' is given, object files will be put under it, while |
| 528 | retaining their original path component. That is, "foo/bar.c" |
| 529 | normally compiles to "foo/bar.o" (for a Unix implementation); if |
| 530 | 'output_dir' is "build", then it would compile to |
| 531 | "build/foo/bar.o". |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 532 | |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 533 | 'macros', if given, must be a list of macro definitions. A macro |
| 534 | definition is either a (name, value) 2-tuple or a (name,) 1-tuple. |
| 535 | The former defines a macro; if the value is None, the macro is |
| 536 | defined without an explicit value. The 1-tuple case undefines a |
| 537 | macro. Later definitions/redefinitions/ undefinitions take |
| 538 | precedence. |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 539 | |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 540 | 'include_dirs', if given, must be a list of strings, the |
| 541 | directories to add to the default include file search path for this |
| 542 | compilation only. |
Greg Ward | 3c045a5 | 2000-02-09 02:16:14 +0000 | [diff] [blame] | 543 | |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 544 | 'debug' is a boolean; if true, the compiler will be instructed to |
| 545 | output debug symbols in (or alongside) the object file(s). |
Greg Ward | 802d6b7 | 1999-09-29 12:20:55 +0000 | [diff] [blame] | 546 | |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 547 | 'extra_preargs' and 'extra_postargs' are implementation- dependent. |
| 548 | On platforms that have the notion of a command-line (e.g. Unix, |
| 549 | DOS/Windows), they are most likely lists of strings: extra |
| 550 | command-line arguments to prepand/append to the compiler command |
| 551 | line. On other platforms, consult the implementation class |
| 552 | documentation. In any event, they are intended as an escape hatch |
| 553 | for those occasions when the abstract compiler framework doesn't |
| 554 | cut the mustard. |
Greg Ward | d151711 | 2000-05-30 01:56:44 +0000 | [diff] [blame] | 555 | |
Jeremy Hylton | 59b103c | 2002-06-13 17:26:30 +0000 | [diff] [blame] | 556 | 'depends', if given, is a list of filenames that all targets |
| 557 | depend on. If a source file is older than any file in |
| 558 | depends, then the source file will be recompiled. This |
| 559 | supports dependency tracking, but only at a coarse |
| 560 | granularity. |
| 561 | |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 562 | Raises CompileError on failure. |
| 563 | """ |
Jeremy Hylton | 6e08d22 | 2002-06-18 18:42:41 +0000 | [diff] [blame] | 564 | # A concrete compiler class can either override this method |
| 565 | # entirely or implement _compile(). |
Jeremy Hylton | 6e08d22 | 2002-06-18 18:42:41 +0000 | [diff] [blame] | 566 | macros, objects, extra_postargs, pp_opts, build = \ |
| 567 | self._setup_compile(output_dir, macros, include_dirs, sources, |
| 568 | depends, extra_postargs) |
| 569 | cc_args = self._get_cc_args(pp_opts, debug, extra_preargs) |
| 570 | |
Thomas Heller | 9436a75 | 2003-12-05 20:12:23 +0000 | [diff] [blame] | 571 | for obj in objects: |
| 572 | try: |
| 573 | src, ext = build[obj] |
| 574 | except KeyError: |
| 575 | continue |
Jeremy Hylton | 6e08d22 | 2002-06-18 18:42:41 +0000 | [diff] [blame] | 576 | self._compile(obj, src, ext, cc_args, extra_postargs, pp_opts) |
| 577 | |
| 578 | # Return *all* object filenames, not just the ones we just built. |
| 579 | return objects |
| 580 | |
| 581 | def _compile(self, obj, src, ext, cc_args, extra_postargs, pp_opts): |
| 582 | """Compile 'src' to product 'obj'.""" |
Jeremy Hylton | 6e08d22 | 2002-06-18 18:42:41 +0000 | [diff] [blame] | 583 | # A concrete compiler class that does not override compile() |
| 584 | # should implement _compile(). |
| 585 | pass |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 586 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 587 | def create_static_lib(self, objects, output_libname, output_dir=None, |
| 588 | debug=0, target_lang=None): |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 589 | """Link a bunch of stuff together to create a static library file. |
| 590 | The "bunch of stuff" consists of the list of object files supplied |
| 591 | as 'objects', the extra object files supplied to |
| 592 | 'add_link_object()' and/or 'set_link_objects()', the libraries |
| 593 | supplied to 'add_library()' and/or 'set_libraries()', and the |
| 594 | libraries supplied as 'libraries' (if any). |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 595 | |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 596 | 'output_libname' should be a library name, not a filename; the |
| 597 | filename will be inferred from the library name. 'output_dir' is |
| 598 | the directory where the library file will be put. |
Greg Ward | 3c045a5 | 2000-02-09 02:16:14 +0000 | [diff] [blame] | 599 | |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 600 | 'debug' is a boolean; if true, debugging information will be |
| 601 | included in the library (note that on most platforms, it is the |
| 602 | compile step where this matters: the 'debug' flag is included here |
| 603 | just for consistency). |
Greg Ward | d151711 | 2000-05-30 01:56:44 +0000 | [diff] [blame] | 604 | |
Gustavo Niemeyer | 6b01685 | 2002-11-05 16:12:02 +0000 | [diff] [blame] | 605 | 'target_lang' is the target language for which the given objects |
| 606 | are being compiled. This allows specific linkage time treatment of |
| 607 | certain languages. |
| 608 | |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 609 | Raises LibError on failure. |
| 610 | """ |
Greg Ward | 3c045a5 | 2000-02-09 02:16:14 +0000 | [diff] [blame] | 611 | pass |
Fred Drake | b94b849 | 2001-12-06 20:51:35 +0000 | [diff] [blame] | 612 | |
Tarek Ziadé | 3679727 | 2010-07-22 12:50:05 +0000 | [diff] [blame^] | 613 | |
Greg Ward | 4240648 | 2000-09-27 02:08:14 +0000 | [diff] [blame] | 614 | # values for target_desc parameter in link() |
| 615 | SHARED_OBJECT = "shared_object" |
| 616 | SHARED_LIBRARY = "shared_library" |
| 617 | EXECUTABLE = "executable" |
| 618 | |
Tarek Ziadé | 3679727 | 2010-07-22 12:50:05 +0000 | [diff] [blame^] | 619 | def link(self, |
| 620 | target_desc, |
| 621 | objects, |
| 622 | output_filename, |
| 623 | output_dir=None, |
| 624 | libraries=None, |
| 625 | library_dirs=None, |
| 626 | runtime_library_dirs=None, |
| 627 | export_symbols=None, |
| 628 | debug=0, |
| 629 | extra_preargs=None, |
| 630 | extra_postargs=None, |
| 631 | build_temp=None, |
| 632 | target_lang=None): |
Greg Ward | 4240648 | 2000-09-27 02:08:14 +0000 | [diff] [blame] | 633 | """Link a bunch of stuff together to create an executable or |
| 634 | shared library file. |
| 635 | |
| 636 | The "bunch of stuff" consists of the list of object files supplied |
| 637 | as 'objects'. 'output_filename' should be a filename. If |
| 638 | 'output_dir' is supplied, 'output_filename' is relative to it |
| 639 | (i.e. 'output_filename' can provide directory components if |
| 640 | needed). |
Greg Ward | 3febd60 | 1999-10-03 20:41:02 +0000 | [diff] [blame] | 641 | |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 642 | 'libraries' is a list of libraries to link against. These are |
| 643 | library names, not filenames, since they're translated into |
| 644 | filenames in a platform-specific way (eg. "foo" becomes "libfoo.a" |
| 645 | on Unix and "foo.lib" on DOS/Windows). However, they can include a |
| 646 | directory component, which means the linker will look in that |
| 647 | specific directory rather than searching all the normal locations. |
Greg Ward | 5299b6a | 2000-05-20 13:23:21 +0000 | [diff] [blame] | 648 | |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 649 | 'library_dirs', if supplied, should be a list of directories to |
| 650 | search for libraries that were specified as bare library names |
| 651 | (ie. no directory component). These are on top of the system |
| 652 | default and those supplied to 'add_library_dir()' and/or |
| 653 | 'set_library_dirs()'. 'runtime_library_dirs' is a list of |
| 654 | directories that will be embedded into the shared library and used |
| 655 | to search for other shared libraries that *it* depends on at |
| 656 | run-time. (This may only be relevant on Unix.) |
Greg Ward | 802d6b7 | 1999-09-29 12:20:55 +0000 | [diff] [blame] | 657 | |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 658 | 'export_symbols' is a list of symbols that the shared library will |
| 659 | export. (This appears to be relevant only on Windows.) |
Greg Ward | 3c045a5 | 2000-02-09 02:16:14 +0000 | [diff] [blame] | 660 | |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 661 | 'debug' is as for 'compile()' and 'create_static_lib()', with the |
| 662 | slight distinction that it actually matters on most platforms (as |
| 663 | opposed to 'create_static_lib()', which includes a 'debug' flag |
| 664 | mostly for form's sake). |
Greg Ward | d151711 | 2000-05-30 01:56:44 +0000 | [diff] [blame] | 665 | |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 666 | 'extra_preargs' and 'extra_postargs' are as for 'compile()' (except |
| 667 | of course that they supply command-line arguments for the |
| 668 | particular linker being used). |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 669 | |
Gustavo Niemeyer | 6b01685 | 2002-11-05 16:12:02 +0000 | [diff] [blame] | 670 | 'target_lang' is the target language for which the given objects |
| 671 | are being compiled. This allows specific linkage time treatment of |
| 672 | certain languages. |
| 673 | |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 674 | Raises LinkError on failure. |
| 675 | """ |
Greg Ward | 4240648 | 2000-09-27 02:08:14 +0000 | [diff] [blame] | 676 | raise NotImplementedError |
| 677 | |
Fred Drake | b94b849 | 2001-12-06 20:51:35 +0000 | [diff] [blame] | 678 | |
Greg Ward | 264cf74 | 2000-09-27 02:24:21 +0000 | [diff] [blame] | 679 | # Old 'link_*()' methods, rewritten to use the new 'link()' method. |
Greg Ward | 4240648 | 2000-09-27 02:08:14 +0000 | [diff] [blame] | 680 | |
Tarek Ziadé | 3679727 | 2010-07-22 12:50:05 +0000 | [diff] [blame^] | 681 | def link_shared_lib(self, |
| 682 | objects, |
| 683 | output_libname, |
| 684 | output_dir=None, |
| 685 | libraries=None, |
| 686 | library_dirs=None, |
| 687 | runtime_library_dirs=None, |
| 688 | export_symbols=None, |
| 689 | debug=0, |
| 690 | extra_preargs=None, |
| 691 | extra_postargs=None, |
| 692 | build_temp=None, |
| 693 | target_lang=None): |
Fred Drake | b94b849 | 2001-12-06 20:51:35 +0000 | [diff] [blame] | 694 | self.link(CCompiler.SHARED_LIBRARY, objects, |
Greg Ward | 4240648 | 2000-09-27 02:08:14 +0000 | [diff] [blame] | 695 | self.library_filename(output_libname, lib_type='shared'), |
| 696 | output_dir, |
| 697 | libraries, library_dirs, runtime_library_dirs, |
| 698 | export_symbols, debug, |
Gustavo Niemeyer | 6b01685 | 2002-11-05 16:12:02 +0000 | [diff] [blame] | 699 | extra_preargs, extra_postargs, build_temp, target_lang) |
Fred Drake | b94b849 | 2001-12-06 20:51:35 +0000 | [diff] [blame] | 700 | |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 701 | |
Tarek Ziadé | 3679727 | 2010-07-22 12:50:05 +0000 | [diff] [blame^] | 702 | def link_shared_object(self, |
| 703 | objects, |
| 704 | output_filename, |
| 705 | output_dir=None, |
| 706 | libraries=None, |
| 707 | library_dirs=None, |
| 708 | runtime_library_dirs=None, |
| 709 | export_symbols=None, |
| 710 | debug=0, |
| 711 | extra_preargs=None, |
| 712 | extra_postargs=None, |
| 713 | build_temp=None, |
| 714 | target_lang=None): |
Greg Ward | 4240648 | 2000-09-27 02:08:14 +0000 | [diff] [blame] | 715 | self.link(CCompiler.SHARED_OBJECT, objects, |
| 716 | output_filename, output_dir, |
| 717 | libraries, library_dirs, runtime_library_dirs, |
| 718 | export_symbols, debug, |
Gustavo Niemeyer | 6b01685 | 2002-11-05 16:12:02 +0000 | [diff] [blame] | 719 | extra_preargs, extra_postargs, build_temp, target_lang) |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 720 | |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 721 | |
Tarek Ziadé | 3679727 | 2010-07-22 12:50:05 +0000 | [diff] [blame^] | 722 | def link_executable(self, |
| 723 | objects, |
| 724 | output_progname, |
| 725 | output_dir=None, |
| 726 | libraries=None, |
| 727 | library_dirs=None, |
| 728 | runtime_library_dirs=None, |
| 729 | debug=0, |
| 730 | extra_preargs=None, |
| 731 | extra_postargs=None, |
| 732 | target_lang=None): |
Fred Drake | b94b849 | 2001-12-06 20:51:35 +0000 | [diff] [blame] | 733 | self.link(CCompiler.EXECUTABLE, objects, |
Greg Ward | 264cf74 | 2000-09-27 02:24:21 +0000 | [diff] [blame] | 734 | self.executable_filename(output_progname), output_dir, |
Fred Drake | b94b849 | 2001-12-06 20:51:35 +0000 | [diff] [blame] | 735 | libraries, library_dirs, runtime_library_dirs, None, |
Gustavo Niemeyer | 6b01685 | 2002-11-05 16:12:02 +0000 | [diff] [blame] | 736 | debug, extra_preargs, extra_postargs, None, target_lang) |
Greg Ward | 5baf1c2 | 2000-01-09 22:41:02 +0000 | [diff] [blame] | 737 | |
| 738 | |
Greg Ward | f7edea7 | 2000-05-20 13:31:32 +0000 | [diff] [blame] | 739 | # -- Miscellaneous methods ----------------------------------------- |
| 740 | # These are all used by the 'gen_lib_options() function; there is |
| 741 | # no appropriate default implementation so subclasses should |
| 742 | # implement all of these. |
| 743 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 744 | def library_dir_option(self, dir): |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 745 | """Return the compiler option to add 'dir' to the list of |
| 746 | directories searched for libraries. |
| 747 | """ |
Greg Ward | f7edea7 | 2000-05-20 13:31:32 +0000 | [diff] [blame] | 748 | raise NotImplementedError |
| 749 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 750 | def runtime_library_dir_option(self, dir): |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 751 | """Return the compiler option to add 'dir' to the list of |
| 752 | directories searched for runtime libraries. |
| 753 | """ |
Greg Ward | f7edea7 | 2000-05-20 13:31:32 +0000 | [diff] [blame] | 754 | raise NotImplementedError |
| 755 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 756 | def library_option(self, lib): |
Greg Ward | f7edea7 | 2000-05-20 13:31:32 +0000 | [diff] [blame] | 757 | """Return the compiler option to add 'dir' to the list of libraries |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 758 | linked into the shared library or executable. |
| 759 | """ |
Greg Ward | f7edea7 | 2000-05-20 13:31:32 +0000 | [diff] [blame] | 760 | raise NotImplementedError |
| 761 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 762 | def has_function(self, funcname, includes=None, include_dirs=None, |
| 763 | libraries=None, library_dirs=None): |
Skip Montanaro | fa01261 | 2003-04-24 19:49:23 +0000 | [diff] [blame] | 764 | """Return a boolean indicating whether funcname is supported on |
| 765 | the current platform. The optional arguments can be used to |
| 766 | augment the compilation environment. |
| 767 | """ |
Skip Montanaro | fa01261 | 2003-04-24 19:49:23 +0000 | [diff] [blame] | 768 | # this can't be included at module scope because it tries to |
| 769 | # import math which might not be available at that point - maybe |
| 770 | # the necessary logic should just be inlined? |
| 771 | import tempfile |
| 772 | if includes is None: |
| 773 | includes = [] |
| 774 | if include_dirs is None: |
| 775 | include_dirs = [] |
| 776 | if libraries is None: |
| 777 | libraries = [] |
| 778 | if library_dirs is None: |
| 779 | library_dirs = [] |
| 780 | fd, fname = tempfile.mkstemp(".c", funcname, text=True) |
| 781 | f = os.fdopen(fd, "w") |
| 782 | for incl in includes: |
| 783 | f.write("""#include "%s"\n""" % incl) |
| 784 | f.write("""\ |
| 785 | main (int argc, char **argv) { |
| 786 | %s(); |
| 787 | } |
| 788 | """ % funcname) |
| 789 | f.close() |
| 790 | try: |
| 791 | objects = self.compile([fname], include_dirs=include_dirs) |
| 792 | except CompileError: |
| 793 | return False |
| 794 | |
| 795 | try: |
| 796 | self.link_executable(objects, "a.out", |
| 797 | libraries=libraries, |
| 798 | library_dirs=library_dirs) |
| 799 | except (LinkError, TypeError): |
| 800 | return False |
| 801 | return True |
| 802 | |
Greg Ward | e5e6015 | 2000-08-04 01:28:39 +0000 | [diff] [blame] | 803 | def find_library_file (self, dirs, lib, debug=0): |
Greg Ward | f7edea7 | 2000-05-20 13:31:32 +0000 | [diff] [blame] | 804 | """Search the specified list of directories for a static or shared |
Greg Ward | e5e6015 | 2000-08-04 01:28:39 +0000 | [diff] [blame] | 805 | library file 'lib' and return the full path to that file. If |
| 806 | 'debug' true, look for a debugging version (if that makes sense on |
| 807 | the current platform). Return None if 'lib' wasn't found in any of |
| 808 | the specified directories. |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 809 | """ |
Greg Ward | f7edea7 | 2000-05-20 13:31:32 +0000 | [diff] [blame] | 810 | raise NotImplementedError |
| 811 | |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame] | 812 | # -- Filename generation methods ----------------------------------- |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 813 | |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame] | 814 | # The default implementation of the filename generating methods are |
| 815 | # prejudiced towards the Unix/DOS/Windows view of the world: |
| 816 | # * object files are named by replacing the source file extension |
| 817 | # (eg. .c/.cpp -> .o/.obj) |
| 818 | # * library files (shared or static) are named by plugging the |
| 819 | # library name and extension into a format string, eg. |
| 820 | # "lib%s.%s" % (lib_name, ".a") for Unix static libraries |
| 821 | # * executables are named by appending an extension (possibly |
| 822 | # empty) to the program name: eg. progname + ".exe" for |
| 823 | # Windows |
| 824 | # |
| 825 | # To reduce redundant code, these methods expect to find |
| 826 | # several attributes in the current object (presumably defined |
| 827 | # as class attributes): |
| 828 | # * src_extensions - |
| 829 | # list of C/C++ source file extensions, eg. ['.c', '.cpp'] |
| 830 | # * obj_extension - |
| 831 | # object file extension, eg. '.o' or '.obj' |
| 832 | # * static_lib_extension - |
| 833 | # extension for static library files, eg. '.a' or '.lib' |
| 834 | # * shared_lib_extension - |
| 835 | # extension for shared library/object files, eg. '.so', '.dll' |
| 836 | # * static_lib_format - |
| 837 | # format string for generating static library filenames, |
| 838 | # eg. 'lib%s.%s' or '%s.%s' |
| 839 | # * shared_lib_format |
| 840 | # format string for generating shared library filenames |
| 841 | # (probably same as static_lib_format, since the extension |
| 842 | # is one of the intended parameters to the format string) |
| 843 | # * exe_extension - |
| 844 | # extension for executable files, eg. '' or '.exe' |
Greg Ward | 9b17cb5 | 1999-09-13 03:07:24 +0000 | [diff] [blame] | 845 | |
Jeremy Hylton | 59b103c | 2002-06-13 17:26:30 +0000 | [diff] [blame] | 846 | def object_filenames(self, source_filenames, strip_dir=0, output_dir=''): |
Guido van Rossum | cc3a6df | 2002-10-01 04:14:17 +0000 | [diff] [blame] | 847 | if output_dir is None: |
| 848 | output_dir = '' |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame] | 849 | obj_names = [] |
| 850 | for src_name in source_filenames: |
Jeremy Hylton | 59b103c | 2002-06-13 17:26:30 +0000 | [diff] [blame] | 851 | base, ext = os.path.splitext(src_name) |
Andrew M. Kuchling | 10da45e | 2003-02-26 18:52:07 +0000 | [diff] [blame] | 852 | base = os.path.splitdrive(base)[1] # Chop off the drive |
| 853 | base = base[os.path.isabs(base):] # If abs, chop off leading / |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame] | 854 | if ext not in self.src_extensions: |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 855 | raise UnknownFileError( |
| 856 | "unknown file type '%s' (from '%s')" % (ext, src_name)) |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame] | 857 | if strip_dir: |
Jeremy Hylton | 59b103c | 2002-06-13 17:26:30 +0000 | [diff] [blame] | 858 | base = os.path.basename(base) |
| 859 | obj_names.append(os.path.join(output_dir, |
| 860 | base + self.obj_extension)) |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame] | 861 | return obj_names |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 862 | |
Jeremy Hylton | 59b103c | 2002-06-13 17:26:30 +0000 | [diff] [blame] | 863 | def shared_object_filename(self, basename, strip_dir=0, output_dir=''): |
| 864 | assert output_dir is not None |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame] | 865 | if strip_dir: |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 866 | basename = os.path.basename(basename) |
Jeremy Hylton | 59b103c | 2002-06-13 17:26:30 +0000 | [diff] [blame] | 867 | return os.path.join(output_dir, basename + self.shared_lib_extension) |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 868 | |
Jeremy Hylton | 59b103c | 2002-06-13 17:26:30 +0000 | [diff] [blame] | 869 | def executable_filename(self, basename, strip_dir=0, output_dir=''): |
| 870 | assert output_dir is not None |
Greg Ward | 4240648 | 2000-09-27 02:08:14 +0000 | [diff] [blame] | 871 | if strip_dir: |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 872 | basename = os.path.basename(basename) |
Greg Ward | 4240648 | 2000-09-27 02:08:14 +0000 | [diff] [blame] | 873 | return os.path.join(output_dir, basename + (self.exe_extension or '')) |
Greg Ward | 26e48ea | 1999-08-29 18:17:36 +0000 | [diff] [blame] | 874 | |
Jeremy Hylton | 59b103c | 2002-06-13 17:26:30 +0000 | [diff] [blame] | 875 | def library_filename(self, libname, lib_type='static', # or 'shared' |
| 876 | strip_dir=0, output_dir=''): |
| 877 | assert output_dir is not None |
| 878 | if lib_type not in ("static", "shared", "dylib"): |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 879 | raise ValueError( |
| 880 | "'lib_type' must be \"static\", \"shared\" or \"dylib\"") |
Jeremy Hylton | 59b103c | 2002-06-13 17:26:30 +0000 | [diff] [blame] | 881 | fmt = getattr(self, lib_type + "_lib_format") |
| 882 | ext = getattr(self, lib_type + "_lib_extension") |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame] | 883 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 884 | dir, base = os.path.split(libname) |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame] | 885 | filename = fmt % (base, ext) |
| 886 | if strip_dir: |
| 887 | dir = '' |
| 888 | |
Jeremy Hylton | 59b103c | 2002-06-13 17:26:30 +0000 | [diff] [blame] | 889 | return os.path.join(output_dir, dir, filename) |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame] | 890 | |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 891 | |
| 892 | # -- Utility methods ----------------------------------------------- |
| 893 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 894 | def announce(self, msg, level=1): |
Jeremy Hylton | cd8a114 | 2002-06-04 20:14:43 +0000 | [diff] [blame] | 895 | log.debug(msg) |
Greg Ward | 9b17cb5 | 1999-09-13 03:07:24 +0000 | [diff] [blame] | 896 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 897 | def debug_print(self, msg): |
Jeremy Hylton | fcd7353 | 2002-09-11 16:31:53 +0000 | [diff] [blame] | 898 | from distutils.debug import DEBUG |
Greg Ward | f813e59 | 2000-08-04 01:31:13 +0000 | [diff] [blame] | 899 | if DEBUG: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 900 | print(msg) |
Greg Ward | f813e59 | 2000-08-04 01:31:13 +0000 | [diff] [blame] | 901 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 902 | def warn(self, msg): |
| 903 | sys.stderr.write("warning: %s\n" % msg) |
Greg Ward | 3febd60 | 1999-10-03 20:41:02 +0000 | [diff] [blame] | 904 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 905 | def execute(self, func, args, msg=None, level=1): |
Jeremy Hylton | cd8a114 | 2002-06-04 20:14:43 +0000 | [diff] [blame] | 906 | execute(func, args, msg, self.dry_run) |
Greg Ward | 9dddbb4 | 2000-08-02 01:38:20 +0000 | [diff] [blame] | 907 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 908 | def spawn(self, cmd): |
| 909 | spawn(cmd, dry_run=self.dry_run) |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 910 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 911 | def move_file(self, src, dst): |
| 912 | return move_file(src, dst, dry_run=self.dry_run) |
Greg Ward | 9b17cb5 | 1999-09-13 03:07:24 +0000 | [diff] [blame] | 913 | |
Tarek Ziadé | 3679727 | 2010-07-22 12:50:05 +0000 | [diff] [blame^] | 914 | def mkpath (self, name, mode=0o777): |
Benjamin Peterson | 6ebe78f | 2008-12-21 00:06:59 +0000 | [diff] [blame] | 915 | mkpath(name, mode, dry_run=self.dry_run) |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 916 | |
| 917 | |
Marc-André Lemburg | 636b906 | 2001-02-19 09:20:04 +0000 | [diff] [blame] | 918 | # Map a sys.platform/os.name ('posix', 'nt') to the default compiler |
| 919 | # type for that platform. Keys are interpreted as re match |
| 920 | # patterns. Order is important; platform mappings are preferred over |
| 921 | # OS names. |
| 922 | _default_compilers = ( |
| 923 | |
| 924 | # Platform string mappings |
Andrew M. Kuchling | a34dbe0 | 2001-02-27 19:13:15 +0000 | [diff] [blame] | 925 | |
| 926 | # on a cygwin built python we can use gcc like an ordinary UNIXish |
| 927 | # compiler |
| 928 | ('cygwin.*', 'unix'), |
Marc-André Lemburg | 2544f51 | 2002-01-31 18:56:00 +0000 | [diff] [blame] | 929 | ('os2emx', 'emx'), |
Fred Drake | b94b849 | 2001-12-06 20:51:35 +0000 | [diff] [blame] | 930 | |
Marc-André Lemburg | 636b906 | 2001-02-19 09:20:04 +0000 | [diff] [blame] | 931 | # OS name mappings |
| 932 | ('posix', 'unix'), |
| 933 | ('nt', 'msvc'), |
Fred Drake | b94b849 | 2001-12-06 20:51:35 +0000 | [diff] [blame] | 934 | |
Marc-André Lemburg | 636b906 | 2001-02-19 09:20:04 +0000 | [diff] [blame] | 935 | ) |
| 936 | |
| 937 | def get_default_compiler(osname=None, platform=None): |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 938 | """Determine the default compiler to use for the given platform. |
Marc-André Lemburg | 636b906 | 2001-02-19 09:20:04 +0000 | [diff] [blame] | 939 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 940 | osname should be one of the standard Python OS names (i.e. the |
| 941 | ones returned by os.name) and platform the common value |
| 942 | returned by sys.platform for the platform in question. |
Marc-André Lemburg | 636b906 | 2001-02-19 09:20:04 +0000 | [diff] [blame] | 943 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 944 | The default values are os.name and sys.platform in case the |
| 945 | parameters are not given. |
Marc-André Lemburg | 636b906 | 2001-02-19 09:20:04 +0000 | [diff] [blame] | 946 | """ |
| 947 | if osname is None: |
| 948 | osname = os.name |
| 949 | if platform is None: |
| 950 | platform = sys.platform |
| 951 | for pattern, compiler in _default_compilers: |
| 952 | if re.match(pattern, platform) is not None or \ |
| 953 | re.match(pattern, osname) is not None: |
| 954 | return compiler |
| 955 | # Default to Unix compiler |
| 956 | return 'unix' |
Greg Ward | 802d6b7 | 1999-09-29 12:20:55 +0000 | [diff] [blame] | 957 | |
| 958 | # Map compiler types to (module_name, class_name) pairs -- ie. where to |
| 959 | # find the code that implements an interface to this compiler. (The module |
| 960 | # is assumed to be in the 'distutils' package.) |
Greg Ward | 2ff7887 | 2000-06-24 00:23:20 +0000 | [diff] [blame] | 961 | compiler_class = { 'unix': ('unixccompiler', 'UnixCCompiler', |
| 962 | "standard UNIX-style compiler"), |
| 963 | 'msvc': ('msvccompiler', 'MSVCCompiler', |
| 964 | "Microsoft Visual C++"), |
| 965 | 'cygwin': ('cygwinccompiler', 'CygwinCCompiler', |
| 966 | "Cygwin port of GNU C Compiler for Win32"), |
| 967 | 'mingw32': ('cygwinccompiler', 'Mingw32CCompiler', |
| 968 | "Mingw32 port of GNU C Compiler for Win32"), |
Greg Ward | bfc79d6 | 2000-06-28 01:29:09 +0000 | [diff] [blame] | 969 | 'bcpp': ('bcppcompiler', 'BCPPCompiler', |
| 970 | "Borland C++ Compiler"), |
Marc-André Lemburg | 2544f51 | 2002-01-31 18:56:00 +0000 | [diff] [blame] | 971 | 'emx': ('emxccompiler', 'EMXCCompiler', |
| 972 | "EMX port of GNU C Compiler for OS/2"), |
Greg Ward | 802d6b7 | 1999-09-29 12:20:55 +0000 | [diff] [blame] | 973 | } |
| 974 | |
Greg Ward | 9d17a7a | 2000-06-07 03:00:06 +0000 | [diff] [blame] | 975 | def show_compilers(): |
Greg Ward | 2ff7887 | 2000-06-24 00:23:20 +0000 | [diff] [blame] | 976 | """Print list of available compilers (used by the "--help-compiler" |
| 977 | options to "build", "build_ext", "build_clib"). |
| 978 | """ |
| 979 | # XXX this "knows" that the compiler option it's describing is |
| 980 | # "--compiler", which just happens to be the case for the three |
| 981 | # commands that use it. |
Fred Drake | b94b849 | 2001-12-06 20:51:35 +0000 | [diff] [blame] | 982 | from distutils.fancy_getopt import FancyGetopt |
Greg Ward | 2ff7887 | 2000-06-24 00:23:20 +0000 | [diff] [blame] | 983 | compilers = [] |
Greg Ward | 9d17a7a | 2000-06-07 03:00:06 +0000 | [diff] [blame] | 984 | for compiler in compiler_class.keys(): |
Jeremy Hylton | 65d6edb | 2000-07-07 20:45:21 +0000 | [diff] [blame] | 985 | compilers.append(("compiler="+compiler, None, |
Greg Ward | 2ff7887 | 2000-06-24 00:23:20 +0000 | [diff] [blame] | 986 | compiler_class[compiler][2])) |
| 987 | compilers.sort() |
| 988 | pretty_printer = FancyGetopt(compilers) |
Greg Ward | 9d17a7a | 2000-06-07 03:00:06 +0000 | [diff] [blame] | 989 | pretty_printer.print_help("List of available compilers:") |
Fred Drake | b94b849 | 2001-12-06 20:51:35 +0000 | [diff] [blame] | 990 | |
Greg Ward | 802d6b7 | 1999-09-29 12:20:55 +0000 | [diff] [blame] | 991 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 992 | def new_compiler(plat=None, compiler=None, verbose=0, dry_run=0, force=0): |
Greg Ward | 802d6b7 | 1999-09-29 12:20:55 +0000 | [diff] [blame] | 993 | """Generate an instance of some CCompiler subclass for the supplied |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 994 | platform/compiler combination. 'plat' defaults to 'os.name' |
| 995 | (eg. 'posix', 'nt'), and 'compiler' defaults to the default compiler |
| 996 | for that platform. Currently only 'posix' and 'nt' are supported, and |
| 997 | the default compilers are "traditional Unix interface" (UnixCCompiler |
| 998 | class) and Visual C++ (MSVCCompiler class). Note that it's perfectly |
| 999 | possible to ask for a Unix compiler object under Windows, and a |
| 1000 | Microsoft compiler object under Unix -- if you supply a value for |
| 1001 | 'compiler', 'plat' is ignored. |
| 1002 | """ |
Greg Ward | 802d6b7 | 1999-09-29 12:20:55 +0000 | [diff] [blame] | 1003 | if plat is None: |
| 1004 | plat = os.name |
| 1005 | |
| 1006 | try: |
| 1007 | if compiler is None: |
Marc-André Lemburg | 636b906 | 2001-02-19 09:20:04 +0000 | [diff] [blame] | 1008 | compiler = get_default_compiler(plat) |
Fred Drake | b94b849 | 2001-12-06 20:51:35 +0000 | [diff] [blame] | 1009 | |
Greg Ward | 2ff7887 | 2000-06-24 00:23:20 +0000 | [diff] [blame] | 1010 | (module_name, class_name, long_description) = compiler_class[compiler] |
Greg Ward | 802d6b7 | 1999-09-29 12:20:55 +0000 | [diff] [blame] | 1011 | except KeyError: |
| 1012 | msg = "don't know how to compile C/C++ code on platform '%s'" % plat |
| 1013 | if compiler is not None: |
| 1014 | msg = msg + " with '%s' compiler" % compiler |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 1015 | raise DistutilsPlatformError(msg) |
Fred Drake | b94b849 | 2001-12-06 20:51:35 +0000 | [diff] [blame] | 1016 | |
Greg Ward | 802d6b7 | 1999-09-29 12:20:55 +0000 | [diff] [blame] | 1017 | try: |
| 1018 | module_name = "distutils." + module_name |
| 1019 | __import__ (module_name) |
| 1020 | module = sys.modules[module_name] |
| 1021 | klass = vars(module)[class_name] |
| 1022 | except ImportError: |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 1023 | raise DistutilsModuleError( |
Greg Ward | 802d6b7 | 1999-09-29 12:20:55 +0000 | [diff] [blame] | 1024 | "can't compile C/C++ code: unable to load module '%s'" % \ |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 1025 | module_name) |
Greg Ward | 802d6b7 | 1999-09-29 12:20:55 +0000 | [diff] [blame] | 1026 | except KeyError: |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 1027 | raise DistutilsModuleError( |
| 1028 | "can't compile C/C++ code: unable to find class '%s' " |
| 1029 | "in module '%s'" % (class_name, module_name)) |
Greg Ward | 802d6b7 | 1999-09-29 12:20:55 +0000 | [diff] [blame] | 1030 | |
Jeremy Hylton | cd8a114 | 2002-06-04 20:14:43 +0000 | [diff] [blame] | 1031 | # XXX The None is necessary to preserve backwards compatibility |
| 1032 | # with classes that expect verbose to be the first positional |
| 1033 | # argument. |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 1034 | return klass(None, dry_run, force) |
Greg Ward | f7a39ec | 1999-09-08 02:29:08 +0000 | [diff] [blame] | 1035 | |
| 1036 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 1037 | def gen_preprocess_options(macros, include_dirs): |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 1038 | """Generate C pre-processor options (-D, -U, -I) as used by at least |
| 1039 | two types of compilers: the typical Unix compiler and Visual C++. |
| 1040 | 'macros' is the usual thing, a list of 1- or 2-tuples, where (name,) |
| 1041 | means undefine (-U) macro 'name', and (name,value) means define (-D) |
| 1042 | macro 'name' to 'value'. 'include_dirs' is just a list of directory |
| 1043 | names to be added to the header file search path (-I). Returns a list |
| 1044 | of command-line options suitable for either Unix compilers or Visual |
| 1045 | C++. |
| 1046 | """ |
Greg Ward | f7a39ec | 1999-09-08 02:29:08 +0000 | [diff] [blame] | 1047 | # XXX it would be nice (mainly aesthetic, and so we don't generate |
| 1048 | # stupid-looking command lines) to go over 'macros' and eliminate |
| 1049 | # redundant definitions/undefinitions (ie. ensure that only the |
| 1050 | # latest mention of a particular macro winds up on the command |
| 1051 | # line). I don't think it's essential, though, since most (all?) |
| 1052 | # Unix C compilers only pay attention to the latest -D or -U |
| 1053 | # mention of a macro on their command line. Similar situation for |
Greg Ward | 0bdd90a | 1999-12-12 17:19:58 +0000 | [diff] [blame] | 1054 | # 'include_dirs'. I'm punting on both for now. Anyways, weeding out |
Greg Ward | f7a39ec | 1999-09-08 02:29:08 +0000 | [diff] [blame] | 1055 | # redundancies like this should probably be the province of |
| 1056 | # CCompiler, since the data structures used are inherited from it |
| 1057 | # and therefore common to all CCompiler classes. |
Greg Ward | f7a39ec | 1999-09-08 02:29:08 +0000 | [diff] [blame] | 1058 | pp_opts = [] |
| 1059 | for macro in macros: |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 1060 | if not (isinstance(macro, tuple) and 1 <= len(macro) <= 2): |
| 1061 | raise TypeError( |
| 1062 | "bad macro definition '%s': " |
| 1063 | "each element of 'macros' list must be a 1- or 2-tuple" |
| 1064 | % macro) |
Greg Ward | fbf8aff | 1999-09-21 18:35:09 +0000 | [diff] [blame] | 1065 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 1066 | if len(macro) == 1: # undefine this macro |
| 1067 | pp_opts.append("-U%s" % macro[0]) |
| 1068 | elif len(macro) == 2: |
Greg Ward | f7a39ec | 1999-09-08 02:29:08 +0000 | [diff] [blame] | 1069 | if macro[1] is None: # define with no explicit value |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 1070 | pp_opts.append("-D%s" % macro[0]) |
Greg Ward | f7a39ec | 1999-09-08 02:29:08 +0000 | [diff] [blame] | 1071 | else: |
| 1072 | # XXX *don't* need to be clever about quoting the |
| 1073 | # macro value here, because we're going to avoid the |
| 1074 | # shell at all costs when we spawn the command! |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 1075 | pp_opts.append("-D%s=%s" % macro) |
Greg Ward | f7a39ec | 1999-09-08 02:29:08 +0000 | [diff] [blame] | 1076 | |
Greg Ward | 0bdd90a | 1999-12-12 17:19:58 +0000 | [diff] [blame] | 1077 | for dir in include_dirs: |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 1078 | pp_opts.append("-I%s" % dir) |
Greg Ward | f7a39ec | 1999-09-08 02:29:08 +0000 | [diff] [blame] | 1079 | return pp_opts |
| 1080 | |
Greg Ward | f7a39ec | 1999-09-08 02:29:08 +0000 | [diff] [blame] | 1081 | |
Tarek Ziadé | 3679727 | 2010-07-22 12:50:05 +0000 | [diff] [blame^] | 1082 | def gen_lib_options (compiler, library_dirs, runtime_library_dirs, libraries): |
Greg Ward | f7a39ec | 1999-09-08 02:29:08 +0000 | [diff] [blame] | 1083 | """Generate linker options for searching library directories and |
Tarek Ziadé | 3679727 | 2010-07-22 12:50:05 +0000 | [diff] [blame^] | 1084 | linking with specific libraries. 'libraries' and 'library_dirs' are, |
| 1085 | respectively, lists of library names (not filenames!) and search |
| 1086 | directories. Returns a list of command-line options suitable for use |
| 1087 | with some compiler (depending on the two format strings passed in). |
Greg Ward | c3a43b4 | 2000-06-24 18:10:48 +0000 | [diff] [blame] | 1088 | """ |
Greg Ward | f7a39ec | 1999-09-08 02:29:08 +0000 | [diff] [blame] | 1089 | lib_opts = [] |
| 1090 | |
| 1091 | for dir in library_dirs: |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 1092 | lib_opts.append(compiler.library_dir_option(dir)) |
Greg Ward | f7a39ec | 1999-09-08 02:29:08 +0000 | [diff] [blame] | 1093 | |
Greg Ward | d03f88a | 2000-03-18 15:19:51 +0000 | [diff] [blame] | 1094 | for dir in runtime_library_dirs: |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 1095 | opt = compiler.runtime_library_dir_option(dir) |
| 1096 | if isinstance(opt, list): |
Tarek Ziadé | 3679727 | 2010-07-22 12:50:05 +0000 | [diff] [blame^] | 1097 | lib_opts = lib_opts + opt |
Martin v. Löwis | 061f132 | 2004-08-29 16:40:55 +0000 | [diff] [blame] | 1098 | else: |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 1099 | lib_opts.append(opt) |
Greg Ward | d03f88a | 2000-03-18 15:19:51 +0000 | [diff] [blame] | 1100 | |
Greg Ward | f7a39ec | 1999-09-08 02:29:08 +0000 | [diff] [blame] | 1101 | # XXX it's important that we *not* remove redundant library mentions! |
| 1102 | # sometimes you really do have to say "-lfoo -lbar -lfoo" in order to |
| 1103 | # resolve all symbols. I just hope we never have to say "-lfoo obj.o |
| 1104 | # -lbar" to get things to work -- that's certainly a possibility, but a |
| 1105 | # pretty nasty way to arrange your C code. |
| 1106 | |
| 1107 | for lib in libraries: |
Tarek Ziadé | 3679727 | 2010-07-22 12:50:05 +0000 | [diff] [blame^] | 1108 | (lib_dir, lib_name) = os.path.split(lib) |
| 1109 | if lib_dir: |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 1110 | lib_file = compiler.find_library_file([lib_dir], lib_name) |
Tarek Ziadé | 3679727 | 2010-07-22 12:50:05 +0000 | [diff] [blame^] | 1111 | if lib_file: |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 1112 | lib_opts.append(lib_file) |
Greg Ward | 3febd60 | 1999-10-03 20:41:02 +0000 | [diff] [blame] | 1113 | else: |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 1114 | compiler.warn("no library file corresponding to " |
| 1115 | "'%s' found (skipping)" % lib) |
Greg Ward | 3febd60 | 1999-10-03 20:41:02 +0000 | [diff] [blame] | 1116 | else: |
Tarek Ziadé | 3679727 | 2010-07-22 12:50:05 +0000 | [diff] [blame^] | 1117 | lib_opts.append(compiler.library_option (lib)) |
Greg Ward | f7a39ec | 1999-09-08 02:29:08 +0000 | [diff] [blame] | 1118 | return lib_opts |