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 | |
| 6 | # created 1999/07/05, Greg Ward |
| 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 | |
Greg Ward | 802d6b7 | 1999-09-29 12:20:55 +0000 | [diff] [blame] | 10 | import sys, os |
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 | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame^] | 15 | from distutils.util import move_file, mkpath, newer_pairwise, newer_group |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 16 | |
| 17 | |
| 18 | class CCompiler: |
| 19 | """Abstract base class to define the interface that must be implemented |
| 20 | by real compiler abstraction classes. Might have some use as a |
| 21 | place for shared code, but it's not yet clear what code can be |
| 22 | shared between compiler abstraction models for different platforms. |
| 23 | |
| 24 | The basic idea behind a compiler abstraction class is that each |
| 25 | instance can be used for all the compile/link steps in building |
| 26 | a single project. Thus, attributes common to all of those compile |
| 27 | and link steps -- include directories, macros to define, libraries |
| 28 | to link against, etc. -- are attributes of the compiler instance. |
| 29 | To allow for variability in how individual files are treated, |
| 30 | most (all?) of those attributes may be varied on a per-compilation |
| 31 | or per-link basis.""" |
| 32 | |
Greg Ward | 802d6b7 | 1999-09-29 12:20:55 +0000 | [diff] [blame] | 33 | # 'compiler_type' is a class attribute that identifies this class. It |
| 34 | # keeps code that wants to know what kind of compiler it's dealing with |
| 35 | # from having to import all possible compiler classes just to do an |
| 36 | # 'isinstance'. In concrete CCompiler subclasses, 'compiler_type' |
| 37 | # should really, really be one of the keys of the 'compiler_class' |
| 38 | # dictionary (see below -- used by the 'new_compiler()' factory |
| 39 | # function) -- authors of new compiler interface classes are |
| 40 | # responsible for updating 'compiler_class'! |
| 41 | compiler_type = None |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 42 | |
| 43 | # XXX things not handled by this compiler abstraction model: |
| 44 | # * client can't provide additional options for a compiler, |
| 45 | # e.g. warning, optimization, debugging flags. Perhaps this |
| 46 | # should be the domain of concrete compiler abstraction classes |
| 47 | # (UnixCCompiler, MSVCCompiler, etc.) -- or perhaps the base |
| 48 | # class should have methods for the common ones. |
| 49 | # * can't put output files (object files, libraries, whatever) |
| 50 | # into a separate directory from their inputs. Should this be |
| 51 | # handled by an 'output_dir' attribute of the whole object, or a |
| 52 | # parameter to the compile/link_* methods, or both? |
| 53 | # * can't completely override the include or library searchg |
| 54 | # path, ie. no "cc -I -Idir1 -Idir2" or "cc -L -Ldir1 -Ldir2". |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 55 | # I'm not sure how widely supported this is even by Unix |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 56 | # compilers, much less on other platforms. And I'm even less |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 57 | # sure how useful it is; maybe for cross-compiling, but |
| 58 | # support for that is a ways off. (And anyways, cross |
| 59 | # compilers probably have a dedicated binary with the |
| 60 | # right paths compiled in. I hope.) |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 61 | # * can't do really freaky things with the library list/library |
| 62 | # dirs, e.g. "-Ldir1 -lfoo -Ldir2 -lfoo" to link against |
| 63 | # different versions of libfoo.a in different locations. I |
| 64 | # think this is useless without the ability to null out the |
| 65 | # library search path anyways. |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 66 | |
| 67 | |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame^] | 68 | # Subclasses that rely on the standard filename generation methods |
| 69 | # implemented below should override these; see the comment near |
| 70 | # those methods ('object_filenames()' et. al.) for details: |
| 71 | src_extensions = None # list of strings |
| 72 | obj_extension = None # string |
| 73 | static_lib_extension = None |
| 74 | shared_lib_extension = None # string |
| 75 | static_lib_format = None # format string |
| 76 | shared_lib_format = None # prob. same as static_lib_format |
| 77 | exe_extension = None # string |
| 78 | |
| 79 | |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 80 | def __init__ (self, |
| 81 | verbose=0, |
Greg Ward | 3febd60 | 1999-10-03 20:41:02 +0000 | [diff] [blame] | 82 | dry_run=0, |
| 83 | force=0): |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 84 | |
| 85 | self.verbose = verbose |
| 86 | self.dry_run = dry_run |
Greg Ward | 3febd60 | 1999-10-03 20:41:02 +0000 | [diff] [blame] | 87 | self.force = force |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 88 | |
Greg Ward | 9b17cb5 | 1999-09-13 03:07:24 +0000 | [diff] [blame] | 89 | # 'output_dir': a common output directory for object, library, |
| 90 | # shared object, and shared library files |
| 91 | self.output_dir = None |
| 92 | |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 93 | # 'macros': a list of macro definitions (or undefinitions). A |
| 94 | # macro definition is a 2-tuple (name, value), where the value is |
| 95 | # either a string or None (no explicit value). A macro |
| 96 | # undefinition is a 1-tuple (name,). |
| 97 | self.macros = [] |
| 98 | |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 99 | # 'include_dirs': a list of directories to search for include files |
| 100 | self.include_dirs = [] |
| 101 | |
| 102 | # 'libraries': a list of libraries to include in any link |
| 103 | # (library names, not filenames: eg. "foo" not "libfoo.a") |
| 104 | self.libraries = [] |
| 105 | |
| 106 | # 'library_dirs': a list of directories to search for libraries |
| 107 | self.library_dirs = [] |
| 108 | |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 109 | # 'runtime_library_dirs': a list of directories to search for |
| 110 | # shared libraries/objects at runtime |
| 111 | self.runtime_library_dirs = [] |
| 112 | |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 113 | # 'objects': a list of object files (or similar, such as explicitly |
| 114 | # named library files) to include on any link |
| 115 | self.objects = [] |
| 116 | |
| 117 | # __init__ () |
| 118 | |
| 119 | |
| 120 | def _find_macro (self, name): |
| 121 | i = 0 |
| 122 | for defn in self.macros: |
| 123 | if defn[0] == name: |
| 124 | return i |
| 125 | i = i + 1 |
| 126 | |
| 127 | return None |
| 128 | |
| 129 | |
| 130 | def _check_macro_definitions (self, definitions): |
| 131 | """Ensures that every element of 'definitions' is a valid macro |
| 132 | definition, ie. either (name,value) 2-tuple or a (name,) |
| 133 | tuple. Do nothing if all definitions are OK, raise |
| 134 | TypeError otherwise.""" |
| 135 | |
| 136 | for defn in definitions: |
| 137 | if not (type (defn) is TupleType and |
| 138 | (len (defn) == 1 or |
| 139 | (len (defn) == 2 and |
| 140 | (type (defn[1]) is StringType or defn[1] is None))) and |
| 141 | type (defn[0]) is StringType): |
| 142 | raise TypeError, \ |
| 143 | ("invalid macro definition '%s': " % defn) + \ |
| 144 | "must be tuple (string,), (string, string), or " + \ |
| 145 | "(string, None)" |
| 146 | |
| 147 | |
| 148 | # -- Bookkeeping methods ------------------------------------------- |
| 149 | |
| 150 | def define_macro (self, name, value=None): |
| 151 | """Define a preprocessor macro for all compilations driven by |
| 152 | this compiler object. The optional parameter 'value' should be |
| 153 | a string; if it is not supplied, then the macro will be defined |
| 154 | without an explicit value and the exact outcome depends on the |
| 155 | compiler used (XXX true? does ANSI say anything about this?)""" |
| 156 | |
| 157 | # Delete from the list of macro definitions/undefinitions if |
| 158 | # already there (so that this one will take precedence). |
| 159 | i = self._find_macro (name) |
| 160 | if i is not None: |
| 161 | del self.macros[i] |
| 162 | |
| 163 | defn = (name, value) |
| 164 | self.macros.append (defn) |
| 165 | |
| 166 | |
| 167 | def undefine_macro (self, name): |
| 168 | """Undefine a preprocessor macro for all compilations driven by |
| 169 | this compiler object. If the same macro is defined by |
| 170 | 'define_macro()' and undefined by 'undefine_macro()' the last |
| 171 | call takes precedence (including multiple redefinitions or |
| 172 | undefinitions). If the macro is redefined/undefined on a |
| 173 | per-compilation basis (ie. in the call to 'compile()'), then |
| 174 | that takes precedence.""" |
| 175 | |
| 176 | # Delete from the list of macro definitions/undefinitions if |
| 177 | # already there (so that this one will take precedence). |
| 178 | i = self._find_macro (name) |
| 179 | if i is not None: |
| 180 | del self.macros[i] |
| 181 | |
| 182 | undefn = (name,) |
| 183 | self.macros.append (undefn) |
| 184 | |
| 185 | |
| 186 | def add_include_dir (self, dir): |
| 187 | """Add 'dir' to the list of directories that will be searched |
| 188 | for header files. The compiler is instructed to search |
| 189 | directories in the order in which they are supplied by |
| 190 | successive calls to 'add_include_dir()'.""" |
| 191 | self.include_dirs.append (dir) |
| 192 | |
| 193 | def set_include_dirs (self, dirs): |
| 194 | """Set the list of directories that will be searched to 'dirs' |
| 195 | (a list of strings). Overrides any preceding calls to |
| 196 | 'add_include_dir()'; subsequence calls to 'add_include_dir()' |
| 197 | add to the list passed to 'set_include_dirs()'. This does |
| 198 | not affect any list of standard include directories that |
| 199 | the compiler may search by default.""" |
| 200 | self.include_dirs = copy (dirs) |
| 201 | |
| 202 | |
| 203 | def add_library (self, libname): |
| 204 | """Add 'libname' to the list of libraries that will be included |
| 205 | in all links driven by this compiler object. Note that |
| 206 | 'libname' should *not* be the name of a file containing a |
| 207 | library, but the name of the library itself: the actual filename |
| 208 | will be inferred by the linker, the compiler, or the compiler |
| 209 | abstraction class (depending on the platform). |
| 210 | |
| 211 | The linker will be instructed to link against libraries in the |
| 212 | order they were supplied to 'add_library()' and/or |
| 213 | 'set_libraries()'. It is perfectly valid to duplicate library |
| 214 | names; the linker will be instructed to link against libraries |
| 215 | as many times as they are mentioned.""" |
| 216 | self.libraries.append (libname) |
| 217 | |
| 218 | def set_libraries (self, libnames): |
| 219 | """Set the list of libraries to be included in all links driven |
| 220 | by this compiler object to 'libnames' (a list of strings). |
| 221 | This does not affect any standard system libraries that the |
| 222 | linker may include by default.""" |
| 223 | |
| 224 | self.libraries = copy (libnames) |
| 225 | |
| 226 | |
| 227 | def add_library_dir (self, dir): |
| 228 | """Add 'dir' to the list of directories that will be searched for |
| 229 | libraries specified to 'add_library()' and 'set_libraries()'. |
| 230 | The linker will be instructed to search for libraries in the |
| 231 | order they are supplied to 'add_library_dir()' and/or |
| 232 | 'set_library_dirs()'.""" |
| 233 | self.library_dirs.append (dir) |
| 234 | |
| 235 | def set_library_dirs (self, dirs): |
| 236 | """Set the list of library search directories to 'dirs' (a list |
| 237 | of strings). This does not affect any standard library |
| 238 | search path that the linker may search by default.""" |
| 239 | self.library_dirs = copy (dirs) |
| 240 | |
| 241 | |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 242 | def add_runtime_library_dir (self, dir): |
| 243 | """Add 'dir' to the list of directories that will be searched for |
| 244 | shared libraries at runtime.""" |
| 245 | self.runtime_library_dirs.append (dir) |
| 246 | |
| 247 | def set_runtime_library_dirs (self, dirs): |
| 248 | """Set the list of directories to search for shared libraries |
| 249 | at runtime to 'dirs' (a list of strings). This does not affect |
| 250 | any standard search path that the runtime linker may search by |
| 251 | default.""" |
| 252 | self.runtime_library_dirs = copy (dirs) |
| 253 | |
| 254 | |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 255 | def add_link_object (self, object): |
| 256 | """Add 'object' to the list of object files (or analogues, such |
| 257 | as explictly named library files or the output of "resource |
| 258 | compilers") to be included in every link driven by this |
| 259 | compiler object.""" |
| 260 | self.objects.append (object) |
| 261 | |
| 262 | def set_link_objects (self, objects): |
| 263 | """Set the list of object files (or analogues) to be included |
| 264 | in every link to 'objects'. This does not affect any |
| 265 | standard object files that the linker may include by default |
| 266 | (such as system libraries).""" |
| 267 | self.objects = copy (objects) |
| 268 | |
| 269 | |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame^] | 270 | # -- Priviate utility methods -------------------------------------- |
| 271 | # (here for the convenience of subclasses) |
| 272 | |
| 273 | def _fix_compile_args (self, output_dir, macros, include_dirs): |
| 274 | """Typecheck and fix-up some of the arguments to the 'compile()' method, |
| 275 | and return fixed-up values. Specifically: if 'output_dir' is |
| 276 | None, replaces it with 'self.output_dir'; ensures that 'macros' |
| 277 | is a list, and augments it with 'self.macros'; ensures that |
| 278 | 'include_dirs' is a list, and augments it with |
| 279 | 'self.include_dirs'. Guarantees that the returned values are of |
| 280 | the correct type, i.e. for 'output_dir' either string or None, |
| 281 | and for 'macros' and 'include_dirs' either list or None.""" |
| 282 | |
| 283 | if output_dir is None: |
| 284 | output_dir = self.output_dir |
| 285 | elif type (output_dir) is not StringType: |
| 286 | raise TypeError, "'output_dir' must be a string or None" |
| 287 | |
| 288 | if macros is None: |
| 289 | macros = self.macros |
| 290 | elif type (macros) is ListType: |
| 291 | macros = macros + (self.macros or []) |
| 292 | else: |
| 293 | raise TypeError, \ |
| 294 | "'macros' (if supplied) must be a list of tuples" |
| 295 | |
| 296 | if include_dirs is None: |
| 297 | include_dirs = self.include_dirs |
| 298 | elif type (include_dirs) in (ListType, TupleType): |
| 299 | include_dirs = list (include_dirs) + (self.include_dirs or []) |
| 300 | else: |
| 301 | raise TypeError, \ |
| 302 | "'include_dirs' (if supplied) must be a list of strings" |
| 303 | |
| 304 | return (output_dir, macros, include_dirs) |
| 305 | |
| 306 | # _fix_compile_args () |
| 307 | |
| 308 | |
| 309 | def _prep_compile (self, sources, output_dir): |
| 310 | """Determine the list of object files corresponding to 'sources', and |
| 311 | figure out which ones really need to be recompiled. Return a list |
| 312 | of all object files and a dictionary telling which source files can |
| 313 | be skipped.""" |
| 314 | |
| 315 | # Get the list of expected output (object) files |
| 316 | objects = self.object_filenames (sources, |
| 317 | output_dir=output_dir) |
| 318 | |
| 319 | if self.force: |
| 320 | skip_source = {} # rebuild everything |
| 321 | for source in sources: |
| 322 | skip_source[source] = 0 |
| 323 | else: |
| 324 | # Figure out which source files we have to recompile according |
| 325 | # to a simplistic check -- we just compare the source and |
| 326 | # object file, no deep dependency checking involving header |
| 327 | # files. |
| 328 | skip_source = {} # rebuild everything |
| 329 | for source in sources: # no wait, rebuild nothing |
| 330 | skip_source[source] = 1 |
| 331 | |
| 332 | (n_sources, n_objects) = newer_pairwise (sources, objects) |
| 333 | for source in n_sources: # no really, only rebuild what's out-of-date |
| 334 | skip_source[source] = 0 |
| 335 | |
| 336 | return (objects, skip_source) |
| 337 | |
| 338 | # _prep_compile () |
| 339 | |
| 340 | |
| 341 | def _fix_link_args (self, objects, output_dir, |
| 342 | takes_libs=0, libraries=None, library_dirs=None): |
| 343 | """Typecheck and fix up some of the arguments supplied to the |
| 344 | 'link_*' methods and return the fixed values. Specifically: |
| 345 | ensure that 'objects' is a list; if output_dir is None, use |
| 346 | self.output_dir; ensure that 'libraries' and 'library_dirs' are |
| 347 | both lists, and augment them with 'self.libraries' and |
| 348 | 'self.library_dirs'. If 'takes_libs' is true, return a tuple |
| 349 | (objects, output_dir, libraries, library_dirs; else return |
| 350 | (objects, output_dir).""" |
| 351 | |
| 352 | if type (objects) not in (ListType, TupleType): |
| 353 | raise TypeError, \ |
| 354 | "'objects' must be a list or tuple of strings" |
| 355 | objects = list (objects) |
| 356 | |
| 357 | if output_dir is None: |
| 358 | output_dir = self.output_dir |
| 359 | elif type (output_dir) is not StringType: |
| 360 | raise TypeError, "'output_dir' must be a string or None" |
| 361 | |
| 362 | if takes_libs: |
| 363 | if libraries is None: |
| 364 | libraries = self.libraries |
| 365 | elif type (libraries) in (ListType, TupleType): |
| 366 | libraries = list (libraries) + (self.libraries or []) |
| 367 | else: |
| 368 | raise TypeError, \ |
| 369 | "'libraries' (if supplied) must be a list of strings" |
| 370 | |
| 371 | if library_dirs is None: |
| 372 | library_dirs = self.library_dirs |
| 373 | elif type (library_dirs) in (ListType, TupleType): |
| 374 | library_dirs = list (library_dirs) + (self.library_dirs or []) |
| 375 | else: |
| 376 | raise TypeError, \ |
| 377 | "'library_dirs' (if supplied) must be a list of strings" |
| 378 | |
| 379 | return (objects, output_dir, libraries, library_dirs) |
| 380 | else: |
| 381 | return (objects, output_dir) |
| 382 | |
| 383 | # _fix_link_args () |
| 384 | |
| 385 | |
| 386 | def _need_link (self, objects, output_file): |
| 387 | """Return true if we need to relink the files listed in 'objects' to |
| 388 | recreate 'output_file'.""" |
| 389 | |
| 390 | if self.force: |
| 391 | return 1 |
| 392 | else: |
| 393 | if self.dry_run: |
| 394 | newer = newer_group (objects, output_file, missing='newer') |
| 395 | else: |
| 396 | newer = newer_group (objects, output_file) |
| 397 | return newer |
| 398 | |
| 399 | # _need_link () |
| 400 | |
| 401 | |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 402 | # -- Worker methods ------------------------------------------------ |
| 403 | # (must be implemented by subclasses) |
| 404 | |
| 405 | def compile (self, |
| 406 | sources, |
Greg Ward | 9b17cb5 | 1999-09-13 03:07:24 +0000 | [diff] [blame] | 407 | output_dir=None, |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 408 | macros=None, |
Greg Ward | 0bdd90a | 1999-12-12 17:19:58 +0000 | [diff] [blame] | 409 | include_dirs=None, |
Greg Ward | 3c045a5 | 2000-02-09 02:16:14 +0000 | [diff] [blame] | 410 | debug=0, |
Greg Ward | 802d6b7 | 1999-09-29 12:20:55 +0000 | [diff] [blame] | 411 | extra_preargs=None, |
| 412 | extra_postargs=None): |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 413 | """Compile one or more C/C++ source files. 'sources' must be |
| 414 | a list of strings, each one the name of a C/C++ source |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame^] | 415 | file. Return a list of object filenames, one per source |
| 416 | filename in 'sources'. Depending on the implementation, |
| 417 | not all source files will necessarily be compiled, but |
| 418 | all corresponding object filenames will be returned. |
| 419 | |
| 420 | If 'output_dir' is given, object files will be put under it, |
| 421 | while retaining their original path component. That is, |
| 422 | "foo/bar.c" normally compiles to "foo/bar.o" (for a Unix |
| 423 | implementation); if 'output_dir' is "build", then it would |
| 424 | compile to "build/foo/bar.o". |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 425 | |
| 426 | 'macros', if given, must be a list of macro definitions. A |
| 427 | macro definition is either a (name, value) 2-tuple or a (name,) |
| 428 | 1-tuple. The former defines a macro; if the value is None, the |
| 429 | macro is defined without an explicit value. The 1-tuple case |
| 430 | undefines a macro. Later definitions/redefinitions/ |
| 431 | undefinitions take precedence. |
| 432 | |
Greg Ward | 3c045a5 | 2000-02-09 02:16:14 +0000 | [diff] [blame] | 433 | 'include_dirs', if given, must be a list of strings, the |
| 434 | directories to add to the default include file search path for |
| 435 | this compilation only. |
| 436 | |
| 437 | 'debug' is a boolean; if true, the compiler will be instructed |
| 438 | to output debug symbols in (or alongside) the object file(s). |
Greg Ward | 802d6b7 | 1999-09-29 12:20:55 +0000 | [diff] [blame] | 439 | |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame^] | 440 | 'extra_preargs' and 'extra_postargs' are implementation- |
| 441 | dependent. On platforms that have the notion of a command-line |
| 442 | (e.g. Unix, DOS/Windows), they are most likely lists of strings: |
| 443 | extra command-line arguments to prepand/append to the compiler |
| 444 | command line. On other platforms, consult the implementation |
| 445 | class documentation. In any event, they are intended as an |
Greg Ward | 802d6b7 | 1999-09-29 12:20:55 +0000 | [diff] [blame] | 446 | escape hatch for those occasions when the abstract compiler |
| 447 | framework doesn't cut the mustard.""" |
| 448 | |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 449 | pass |
| 450 | |
| 451 | |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 452 | def link_static_lib (self, |
| 453 | objects, |
| 454 | output_libname, |
Greg Ward | 3c045a5 | 2000-02-09 02:16:14 +0000 | [diff] [blame] | 455 | output_dir=None, |
| 456 | debug=0): |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 457 | """Link a bunch of stuff together to create a static library |
| 458 | file. The "bunch of stuff" consists of the list of object |
| 459 | files supplied as 'objects', the extra object files supplied |
| 460 | to 'add_link_object()' and/or 'set_link_objects()', the |
| 461 | libraries supplied to 'add_library()' and/or |
| 462 | 'set_libraries()', and the libraries supplied as 'libraries' |
| 463 | (if any). |
| 464 | |
Greg Ward | 3c045a5 | 2000-02-09 02:16:14 +0000 | [diff] [blame] | 465 | 'output_libname' should be a library name, not a filename; the |
| 466 | filename will be inferred from the library name. 'output_dir' |
| 467 | is the directory where the library file will be put. |
| 468 | |
| 469 | 'debug' is a boolean; if true, debugging information will be |
| 470 | included in the library (note that on most platforms, it is the |
| 471 | compile step where this matters: the 'debug' flag is included |
| 472 | here just for consistency).""" |
| 473 | |
| 474 | pass |
| 475 | |
| 476 | |
| 477 | def link_shared_lib (self, |
| 478 | objects, |
| 479 | output_libname, |
| 480 | output_dir=None, |
| 481 | libraries=None, |
| 482 | library_dirs=None, |
| 483 | debug=0, |
| 484 | extra_preargs=None, |
| 485 | extra_postargs=None): |
| 486 | """Link a bunch of stuff together to create a shared library |
| 487 | file. Has the same effect as 'link_static_lib()' except |
| 488 | that the filename inferred from 'output_libname' will most |
| 489 | likely be different, and the type of file generated will |
| 490 | almost certainly be different |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 491 | |
Greg Ward | 3febd60 | 1999-10-03 20:41:02 +0000 | [diff] [blame] | 492 | 'libraries' is a list of libraries to link against. These are |
| 493 | library names, not filenames, since they're translated into |
| 494 | filenames in a platform-specific way (eg. "foo" becomes |
| 495 | "libfoo.a" on Unix and "foo.lib" on DOS/Windows). However, they |
| 496 | can include a directory component, which means the linker will |
| 497 | look in that specific directory rather than searching all the |
| 498 | normal locations. |
| 499 | |
| 500 | 'library_dirs', if supplied, should be a list of directories to |
| 501 | search for libraries that were specified as bare library names |
| 502 | (ie. no directory component). These are on top of the system |
| 503 | default and those supplied to 'add_library_dir()' and/or |
| 504 | 'set_library_dirs()'. |
Greg Ward | 802d6b7 | 1999-09-29 12:20:55 +0000 | [diff] [blame] | 505 | |
Greg Ward | 3c045a5 | 2000-02-09 02:16:14 +0000 | [diff] [blame] | 506 | 'debug' is as for 'compile()' and 'link_static_lib()', with the |
| 507 | slight distinction that it actually matters on most platforms |
| 508 | (as opposed to 'link_static_lib()', which includes a 'debug' |
| 509 | flag mostly for form's sake). |
| 510 | |
Greg Ward | 802d6b7 | 1999-09-29 12:20:55 +0000 | [diff] [blame] | 511 | 'extra_preargs' and 'extra_postargs' are as for 'compile()' |
| 512 | (except of course that they supply command-line arguments |
Greg Ward | 3c045a5 | 2000-02-09 02:16:14 +0000 | [diff] [blame] | 513 | for the particular linker being used).""" |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 514 | |
| 515 | pass |
| 516 | |
| 517 | |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 518 | def link_shared_object (self, |
| 519 | objects, |
| 520 | output_filename, |
Greg Ward | 9b17cb5 | 1999-09-13 03:07:24 +0000 | [diff] [blame] | 521 | output_dir=None, |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 522 | libraries=None, |
Greg Ward | 26e48ea | 1999-08-29 18:17:36 +0000 | [diff] [blame] | 523 | library_dirs=None, |
Greg Ward | 3c045a5 | 2000-02-09 02:16:14 +0000 | [diff] [blame] | 524 | debug=0, |
Greg Ward | 802d6b7 | 1999-09-29 12:20:55 +0000 | [diff] [blame] | 525 | extra_preargs=None, |
| 526 | extra_postargs=None): |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 527 | """Link a bunch of stuff together to create a shared object |
Greg Ward | 9b17cb5 | 1999-09-13 03:07:24 +0000 | [diff] [blame] | 528 | file. Much like 'link_shared_lib()', except the output filename |
| 529 | is explicitly supplied as 'output_filename'. If 'output_dir' is |
| 530 | supplied, 'output_filename' is relative to it |
Greg Ward | 802d6b7 | 1999-09-29 12:20:55 +0000 | [diff] [blame] | 531 | (i.e. 'output_filename' can provide directory components if |
Greg Ward | 9b17cb5 | 1999-09-13 03:07:24 +0000 | [diff] [blame] | 532 | needed).""" |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 533 | pass |
| 534 | |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 535 | |
Greg Ward | 5baf1c2 | 2000-01-09 22:41:02 +0000 | [diff] [blame] | 536 | def link_executable (self, |
| 537 | objects, |
| 538 | output_progname, |
| 539 | output_dir=None, |
| 540 | libraries=None, |
| 541 | library_dirs=None, |
Greg Ward | 3c045a5 | 2000-02-09 02:16:14 +0000 | [diff] [blame] | 542 | debug=0, |
Greg Ward | 5baf1c2 | 2000-01-09 22:41:02 +0000 | [diff] [blame] | 543 | extra_preargs=None, |
| 544 | extra_postargs=None): |
| 545 | """Link a bunch of stuff together to create a binary executable |
| 546 | file. The "bunch of stuff" is as for 'link_static_lib()'. |
| 547 | 'output_progname' should be the base name of the executable |
| 548 | program--e.g. on Unix the same as the output filename, but |
| 549 | on DOS/Windows ".exe" will be appended.""" |
| 550 | pass |
| 551 | |
| 552 | |
| 553 | |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame^] | 554 | # -- Filename generation methods ----------------------------------- |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 555 | |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame^] | 556 | # The default implementation of the filename generating methods are |
| 557 | # prejudiced towards the Unix/DOS/Windows view of the world: |
| 558 | # * object files are named by replacing the source file extension |
| 559 | # (eg. .c/.cpp -> .o/.obj) |
| 560 | # * library files (shared or static) are named by plugging the |
| 561 | # library name and extension into a format string, eg. |
| 562 | # "lib%s.%s" % (lib_name, ".a") for Unix static libraries |
| 563 | # * executables are named by appending an extension (possibly |
| 564 | # empty) to the program name: eg. progname + ".exe" for |
| 565 | # Windows |
| 566 | # |
| 567 | # To reduce redundant code, these methods expect to find |
| 568 | # several attributes in the current object (presumably defined |
| 569 | # as class attributes): |
| 570 | # * src_extensions - |
| 571 | # list of C/C++ source file extensions, eg. ['.c', '.cpp'] |
| 572 | # * obj_extension - |
| 573 | # object file extension, eg. '.o' or '.obj' |
| 574 | # * static_lib_extension - |
| 575 | # extension for static library files, eg. '.a' or '.lib' |
| 576 | # * shared_lib_extension - |
| 577 | # extension for shared library/object files, eg. '.so', '.dll' |
| 578 | # * static_lib_format - |
| 579 | # format string for generating static library filenames, |
| 580 | # eg. 'lib%s.%s' or '%s.%s' |
| 581 | # * shared_lib_format |
| 582 | # format string for generating shared library filenames |
| 583 | # (probably same as static_lib_format, since the extension |
| 584 | # is one of the intended parameters to the format string) |
| 585 | # * exe_extension - |
| 586 | # extension for executable files, eg. '' or '.exe' |
Greg Ward | 9b17cb5 | 1999-09-13 03:07:24 +0000 | [diff] [blame] | 587 | |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame^] | 588 | def object_filenames (self, |
| 589 | source_filenames, |
| 590 | strip_dir=0, |
| 591 | output_dir=''): |
| 592 | if output_dir is None: output_dir = '' |
| 593 | obj_names = [] |
| 594 | for src_name in source_filenames: |
| 595 | (base, ext) = os.path.splitext (src_name) |
| 596 | if ext not in self.src_extensions: |
| 597 | continue |
| 598 | if strip_dir: |
| 599 | base = os.path.basename (base) |
| 600 | obj_names.append (os.path.join (output_dir, |
| 601 | base + self.obj_extension)) |
| 602 | return obj_names |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 603 | |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame^] | 604 | # object_filenames () |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 605 | |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 606 | |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame^] | 607 | def shared_object_filename (self, |
| 608 | basename, |
| 609 | strip_dir=0, |
| 610 | output_dir=''): |
| 611 | if output_dir is None: output_dir = '' |
| 612 | if strip_dir: |
| 613 | basename = os.path.basename (basename) |
| 614 | return os.path.join (output_dir, basename + self.shared_lib_extension) |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 615 | |
Greg Ward | 26e48ea | 1999-08-29 18:17:36 +0000 | [diff] [blame] | 616 | |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame^] | 617 | def library_filename (self, |
| 618 | libname, |
| 619 | lib_type='static', # or 'shared' |
| 620 | strip_dir=0, |
| 621 | output_dir=''): |
| 622 | |
| 623 | if output_dir is None: output_dir = '' |
| 624 | if lib_type not in ("static","shared"): |
| 625 | raise ValueError, "'lib_type' must be \"static\" or \"shared\"" |
| 626 | fmt = getattr (self, lib_type + "_lib_format") |
| 627 | ext = getattr (self, lib_type + "_lib_extension") |
| 628 | |
| 629 | (dir, base) = os.path.split (libname) |
| 630 | filename = fmt % (base, ext) |
| 631 | if strip_dir: |
| 632 | dir = '' |
| 633 | |
| 634 | return os.path.join (output_dir, dir, filename) |
| 635 | |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 636 | |
| 637 | # -- Utility methods ----------------------------------------------- |
| 638 | |
Greg Ward | 9b17cb5 | 1999-09-13 03:07:24 +0000 | [diff] [blame] | 639 | def announce (self, msg, level=1): |
| 640 | if self.verbose >= level: |
| 641 | print msg |
| 642 | |
Greg Ward | 3febd60 | 1999-10-03 20:41:02 +0000 | [diff] [blame] | 643 | def warn (self, msg): |
| 644 | sys.stderr.write ("warning: %s\n" % msg) |
| 645 | |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 646 | def spawn (self, cmd): |
| 647 | spawn (cmd, verbose=self.verbose, dry_run=self.dry_run) |
| 648 | |
Greg Ward | 9b17cb5 | 1999-09-13 03:07:24 +0000 | [diff] [blame] | 649 | def move_file (self, src, dst): |
| 650 | return move_file (src, dst, verbose=self.verbose, dry_run=self.dry_run) |
| 651 | |
Greg Ward | 013f0c8 | 2000-03-01 14:43:12 +0000 | [diff] [blame] | 652 | def mkpath (self, name, mode=0777): |
| 653 | mkpath (name, mode, self.verbose, self.dry_run) |
| 654 | |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 655 | |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 656 | # class CCompiler |
| 657 | |
| 658 | |
Greg Ward | 802d6b7 | 1999-09-29 12:20:55 +0000 | [diff] [blame] | 659 | # Map a platform ('posix', 'nt') to the default compiler type for |
| 660 | # that platform. |
| 661 | default_compiler = { 'posix': 'unix', |
| 662 | 'nt': 'msvc', |
| 663 | } |
| 664 | |
| 665 | # Map compiler types to (module_name, class_name) pairs -- ie. where to |
| 666 | # find the code that implements an interface to this compiler. (The module |
| 667 | # is assumed to be in the 'distutils' package.) |
| 668 | compiler_class = { 'unix': ('unixccompiler', 'UnixCCompiler'), |
| 669 | 'msvc': ('msvccompiler', 'MSVCCompiler'), |
| 670 | } |
| 671 | |
| 672 | |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 673 | def new_compiler (plat=None, |
Greg Ward | 802d6b7 | 1999-09-29 12:20:55 +0000 | [diff] [blame] | 674 | compiler=None, |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 675 | verbose=0, |
Greg Ward | 3febd60 | 1999-10-03 20:41:02 +0000 | [diff] [blame] | 676 | dry_run=0, |
| 677 | force=0): |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 678 | |
Greg Ward | 802d6b7 | 1999-09-29 12:20:55 +0000 | [diff] [blame] | 679 | """Generate an instance of some CCompiler subclass for the supplied |
| 680 | platform/compiler combination. 'plat' defaults to 'os.name' |
| 681 | (eg. 'posix', 'nt'), and 'compiler' defaults to the default |
| 682 | compiler for that platform. Currently only 'posix' and 'nt' |
| 683 | are supported, and the default compilers are "traditional Unix |
| 684 | interface" (UnixCCompiler class) and Visual C++ (MSVCCompiler |
| 685 | class). Note that it's perfectly possible to ask for a Unix |
| 686 | compiler object under Windows, and a Microsoft compiler object |
| 687 | under Unix -- if you supply a value for 'compiler', 'plat' |
| 688 | is ignored.""" |
| 689 | |
| 690 | if plat is None: |
| 691 | plat = os.name |
| 692 | |
| 693 | try: |
| 694 | if compiler is None: |
| 695 | compiler = default_compiler[plat] |
| 696 | |
| 697 | (module_name, class_name) = compiler_class[compiler] |
| 698 | except KeyError: |
| 699 | msg = "don't know how to compile C/C++ code on platform '%s'" % plat |
| 700 | if compiler is not None: |
| 701 | msg = msg + " with '%s' compiler" % compiler |
| 702 | raise DistutilsPlatformError, msg |
| 703 | |
| 704 | try: |
| 705 | module_name = "distutils." + module_name |
| 706 | __import__ (module_name) |
| 707 | module = sys.modules[module_name] |
| 708 | klass = vars(module)[class_name] |
| 709 | except ImportError: |
| 710 | raise DistutilsModuleError, \ |
| 711 | "can't compile C/C++ code: unable to load module '%s'" % \ |
| 712 | module_name |
| 713 | except KeyError: |
| 714 | raise DistutilsModuleError, \ |
| 715 | ("can't compile C/C++ code: unable to find class '%s' " + |
| 716 | "in module '%s'") % (class_name, module_name) |
| 717 | |
Greg Ward | 3febd60 | 1999-10-03 20:41:02 +0000 | [diff] [blame] | 718 | return klass (verbose, dry_run, force) |
Greg Ward | f7a39ec | 1999-09-08 02:29:08 +0000 | [diff] [blame] | 719 | |
| 720 | |
Greg Ward | 0bdd90a | 1999-12-12 17:19:58 +0000 | [diff] [blame] | 721 | def gen_preprocess_options (macros, include_dirs): |
Greg Ward | f7a39ec | 1999-09-08 02:29:08 +0000 | [diff] [blame] | 722 | """Generate C pre-processor options (-D, -U, -I) as used by at |
| 723 | least two types of compilers: the typical Unix compiler and Visual |
| 724 | C++. 'macros' is the usual thing, a list of 1- or 2-tuples, where |
| 725 | (name,) means undefine (-U) macro 'name', and (name,value) means |
Greg Ward | 0bdd90a | 1999-12-12 17:19:58 +0000 | [diff] [blame] | 726 | define (-D) macro 'name' to 'value'. 'include_dirs' is just a list of |
Greg Ward | f7a39ec | 1999-09-08 02:29:08 +0000 | [diff] [blame] | 727 | directory names to be added to the header file search path (-I). |
| 728 | Returns a list of command-line options suitable for either |
| 729 | Unix compilers or Visual C++.""" |
| 730 | |
| 731 | # XXX it would be nice (mainly aesthetic, and so we don't generate |
| 732 | # stupid-looking command lines) to go over 'macros' and eliminate |
| 733 | # redundant definitions/undefinitions (ie. ensure that only the |
| 734 | # latest mention of a particular macro winds up on the command |
| 735 | # line). I don't think it's essential, though, since most (all?) |
| 736 | # Unix C compilers only pay attention to the latest -D or -U |
| 737 | # mention of a macro on their command line. Similar situation for |
Greg Ward | 0bdd90a | 1999-12-12 17:19:58 +0000 | [diff] [blame] | 738 | # 'include_dirs'. I'm punting on both for now. Anyways, weeding out |
Greg Ward | f7a39ec | 1999-09-08 02:29:08 +0000 | [diff] [blame] | 739 | # redundancies like this should probably be the province of |
| 740 | # CCompiler, since the data structures used are inherited from it |
| 741 | # and therefore common to all CCompiler classes. |
| 742 | |
| 743 | pp_opts = [] |
| 744 | for macro in macros: |
Greg Ward | fbf8aff | 1999-09-21 18:35:09 +0000 | [diff] [blame] | 745 | |
| 746 | if not (type (macro) is TupleType and |
| 747 | 1 <= len (macro) <= 2): |
| 748 | raise TypeError, \ |
| 749 | ("bad macro definition '%s': " + |
| 750 | "each element of 'macros' list must be a 1- or 2-tuple") % \ |
| 751 | macro |
| 752 | |
Greg Ward | f7a39ec | 1999-09-08 02:29:08 +0000 | [diff] [blame] | 753 | if len (macro) == 1: # undefine this macro |
| 754 | pp_opts.append ("-U%s" % macro[0]) |
| 755 | elif len (macro) == 2: |
| 756 | if macro[1] is None: # define with no explicit value |
| 757 | pp_opts.append ("-D%s" % macro[0]) |
| 758 | else: |
| 759 | # XXX *don't* need to be clever about quoting the |
| 760 | # macro value here, because we're going to avoid the |
| 761 | # shell at all costs when we spawn the command! |
| 762 | pp_opts.append ("-D%s=%s" % macro) |
| 763 | |
Greg Ward | 0bdd90a | 1999-12-12 17:19:58 +0000 | [diff] [blame] | 764 | for dir in include_dirs: |
Greg Ward | f7a39ec | 1999-09-08 02:29:08 +0000 | [diff] [blame] | 765 | pp_opts.append ("-I%s" % dir) |
| 766 | |
| 767 | return pp_opts |
| 768 | |
| 769 | # gen_preprocess_options () |
| 770 | |
| 771 | |
Greg Ward | 3febd60 | 1999-10-03 20:41:02 +0000 | [diff] [blame] | 772 | def gen_lib_options (compiler, library_dirs, libraries): |
Greg Ward | f7a39ec | 1999-09-08 02:29:08 +0000 | [diff] [blame] | 773 | """Generate linker options for searching library directories and |
| 774 | linking with specific libraries. 'libraries' and 'library_dirs' |
| 775 | are, respectively, lists of library names (not filenames!) and |
Greg Ward | 3febd60 | 1999-10-03 20:41:02 +0000 | [diff] [blame] | 776 | search directories. Returns a list of command-line options suitable |
| 777 | for use with some compiler (depending on the two format strings |
| 778 | passed in).""" |
Greg Ward | f7a39ec | 1999-09-08 02:29:08 +0000 | [diff] [blame] | 779 | |
| 780 | lib_opts = [] |
| 781 | |
| 782 | for dir in library_dirs: |
Greg Ward | 3febd60 | 1999-10-03 20:41:02 +0000 | [diff] [blame] | 783 | lib_opts.append (compiler.library_dir_option (dir)) |
Greg Ward | f7a39ec | 1999-09-08 02:29:08 +0000 | [diff] [blame] | 784 | |
| 785 | # XXX it's important that we *not* remove redundant library mentions! |
| 786 | # sometimes you really do have to say "-lfoo -lbar -lfoo" in order to |
| 787 | # resolve all symbols. I just hope we never have to say "-lfoo obj.o |
| 788 | # -lbar" to get things to work -- that's certainly a possibility, but a |
| 789 | # pretty nasty way to arrange your C code. |
| 790 | |
| 791 | for lib in libraries: |
Greg Ward | 3febd60 | 1999-10-03 20:41:02 +0000 | [diff] [blame] | 792 | (lib_dir, lib_name) = os.path.split (lib) |
| 793 | if lib_dir: |
| 794 | lib_file = compiler.find_library_file ([lib_dir], lib_name) |
| 795 | if lib_file: |
| 796 | lib_opts.append (lib_file) |
| 797 | else: |
| 798 | compiler.warn ("no library file corresponding to " |
| 799 | "'%s' found (skipping)" % lib) |
| 800 | else: |
| 801 | lib_opts.append (compiler.library_option (lib)) |
Greg Ward | f7a39ec | 1999-09-08 02:29:08 +0000 | [diff] [blame] | 802 | |
| 803 | return lib_opts |
| 804 | |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame^] | 805 | # gen_lib_options () |