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