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 | |
| 8 | __rcsid__ = "$Id$" |
| 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 | 9b17cb5 | 1999-09-13 03:07:24 +0000 | [diff] [blame] | 15 | from distutils.util import move_file |
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 | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 68 | def __init__ (self, |
| 69 | verbose=0, |
Greg Ward | 3febd60 | 1999-10-03 20:41:02 +0000 | [diff] [blame^] | 70 | dry_run=0, |
| 71 | force=0): |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 72 | |
| 73 | self.verbose = verbose |
| 74 | self.dry_run = dry_run |
Greg Ward | 3febd60 | 1999-10-03 20:41:02 +0000 | [diff] [blame^] | 75 | self.force = force |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 76 | |
Greg Ward | 9b17cb5 | 1999-09-13 03:07:24 +0000 | [diff] [blame] | 77 | # 'output_dir': a common output directory for object, library, |
| 78 | # shared object, and shared library files |
| 79 | self.output_dir = None |
| 80 | |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 81 | # 'macros': a list of macro definitions (or undefinitions). A |
| 82 | # macro definition is a 2-tuple (name, value), where the value is |
| 83 | # either a string or None (no explicit value). A macro |
| 84 | # undefinition is a 1-tuple (name,). |
| 85 | self.macros = [] |
| 86 | |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 87 | # 'include_dirs': a list of directories to search for include files |
| 88 | self.include_dirs = [] |
| 89 | |
| 90 | # 'libraries': a list of libraries to include in any link |
| 91 | # (library names, not filenames: eg. "foo" not "libfoo.a") |
| 92 | self.libraries = [] |
| 93 | |
| 94 | # 'library_dirs': a list of directories to search for libraries |
| 95 | self.library_dirs = [] |
| 96 | |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 97 | # 'runtime_library_dirs': a list of directories to search for |
| 98 | # shared libraries/objects at runtime |
| 99 | self.runtime_library_dirs = [] |
| 100 | |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 101 | # 'objects': a list of object files (or similar, such as explicitly |
| 102 | # named library files) to include on any link |
| 103 | self.objects = [] |
| 104 | |
| 105 | # __init__ () |
| 106 | |
| 107 | |
| 108 | def _find_macro (self, name): |
| 109 | i = 0 |
| 110 | for defn in self.macros: |
| 111 | if defn[0] == name: |
| 112 | return i |
| 113 | i = i + 1 |
| 114 | |
| 115 | return None |
| 116 | |
| 117 | |
| 118 | def _check_macro_definitions (self, definitions): |
| 119 | """Ensures that every element of 'definitions' is a valid macro |
| 120 | definition, ie. either (name,value) 2-tuple or a (name,) |
| 121 | tuple. Do nothing if all definitions are OK, raise |
| 122 | TypeError otherwise.""" |
| 123 | |
| 124 | for defn in definitions: |
| 125 | if not (type (defn) is TupleType and |
| 126 | (len (defn) == 1 or |
| 127 | (len (defn) == 2 and |
| 128 | (type (defn[1]) is StringType or defn[1] is None))) and |
| 129 | type (defn[0]) is StringType): |
| 130 | raise TypeError, \ |
| 131 | ("invalid macro definition '%s': " % defn) + \ |
| 132 | "must be tuple (string,), (string, string), or " + \ |
| 133 | "(string, None)" |
| 134 | |
| 135 | |
| 136 | # -- Bookkeeping methods ------------------------------------------- |
| 137 | |
| 138 | def define_macro (self, name, value=None): |
| 139 | """Define a preprocessor macro for all compilations driven by |
| 140 | this compiler object. The optional parameter 'value' should be |
| 141 | a string; if it is not supplied, then the macro will be defined |
| 142 | without an explicit value and the exact outcome depends on the |
| 143 | compiler used (XXX true? does ANSI say anything about this?)""" |
| 144 | |
| 145 | # Delete from the list of macro definitions/undefinitions if |
| 146 | # already there (so that this one will take precedence). |
| 147 | i = self._find_macro (name) |
| 148 | if i is not None: |
| 149 | del self.macros[i] |
| 150 | |
| 151 | defn = (name, value) |
| 152 | self.macros.append (defn) |
| 153 | |
| 154 | |
| 155 | def undefine_macro (self, name): |
| 156 | """Undefine a preprocessor macro for all compilations driven by |
| 157 | this compiler object. If the same macro is defined by |
| 158 | 'define_macro()' and undefined by 'undefine_macro()' the last |
| 159 | call takes precedence (including multiple redefinitions or |
| 160 | undefinitions). If the macro is redefined/undefined on a |
| 161 | per-compilation basis (ie. in the call to 'compile()'), then |
| 162 | that takes precedence.""" |
| 163 | |
| 164 | # Delete from the list of macro definitions/undefinitions if |
| 165 | # already there (so that this one will take precedence). |
| 166 | i = self._find_macro (name) |
| 167 | if i is not None: |
| 168 | del self.macros[i] |
| 169 | |
| 170 | undefn = (name,) |
| 171 | self.macros.append (undefn) |
| 172 | |
| 173 | |
| 174 | def add_include_dir (self, dir): |
| 175 | """Add 'dir' to the list of directories that will be searched |
| 176 | for header files. The compiler is instructed to search |
| 177 | directories in the order in which they are supplied by |
| 178 | successive calls to 'add_include_dir()'.""" |
| 179 | self.include_dirs.append (dir) |
| 180 | |
| 181 | def set_include_dirs (self, dirs): |
| 182 | """Set the list of directories that will be searched to 'dirs' |
| 183 | (a list of strings). Overrides any preceding calls to |
| 184 | 'add_include_dir()'; subsequence calls to 'add_include_dir()' |
| 185 | add to the list passed to 'set_include_dirs()'. This does |
| 186 | not affect any list of standard include directories that |
| 187 | the compiler may search by default.""" |
| 188 | self.include_dirs = copy (dirs) |
| 189 | |
| 190 | |
| 191 | def add_library (self, libname): |
| 192 | """Add 'libname' to the list of libraries that will be included |
| 193 | in all links driven by this compiler object. Note that |
| 194 | 'libname' should *not* be the name of a file containing a |
| 195 | library, but the name of the library itself: the actual filename |
| 196 | will be inferred by the linker, the compiler, or the compiler |
| 197 | abstraction class (depending on the platform). |
| 198 | |
| 199 | The linker will be instructed to link against libraries in the |
| 200 | order they were supplied to 'add_library()' and/or |
| 201 | 'set_libraries()'. It is perfectly valid to duplicate library |
| 202 | names; the linker will be instructed to link against libraries |
| 203 | as many times as they are mentioned.""" |
| 204 | self.libraries.append (libname) |
| 205 | |
| 206 | def set_libraries (self, libnames): |
| 207 | """Set the list of libraries to be included in all links driven |
| 208 | by this compiler object to 'libnames' (a list of strings). |
| 209 | This does not affect any standard system libraries that the |
| 210 | linker may include by default.""" |
| 211 | |
| 212 | self.libraries = copy (libnames) |
| 213 | |
| 214 | |
| 215 | def add_library_dir (self, dir): |
| 216 | """Add 'dir' to the list of directories that will be searched for |
| 217 | libraries specified to 'add_library()' and 'set_libraries()'. |
| 218 | The linker will be instructed to search for libraries in the |
| 219 | order they are supplied to 'add_library_dir()' and/or |
| 220 | 'set_library_dirs()'.""" |
| 221 | self.library_dirs.append (dir) |
| 222 | |
| 223 | def set_library_dirs (self, dirs): |
| 224 | """Set the list of library search directories to 'dirs' (a list |
| 225 | of strings). This does not affect any standard library |
| 226 | search path that the linker may search by default.""" |
| 227 | self.library_dirs = copy (dirs) |
| 228 | |
| 229 | |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 230 | def add_runtime_library_dir (self, dir): |
| 231 | """Add 'dir' to the list of directories that will be searched for |
| 232 | shared libraries at runtime.""" |
| 233 | self.runtime_library_dirs.append (dir) |
| 234 | |
| 235 | def set_runtime_library_dirs (self, dirs): |
| 236 | """Set the list of directories to search for shared libraries |
| 237 | at runtime to 'dirs' (a list of strings). This does not affect |
| 238 | any standard search path that the runtime linker may search by |
| 239 | default.""" |
| 240 | self.runtime_library_dirs = copy (dirs) |
| 241 | |
| 242 | |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 243 | def add_link_object (self, object): |
| 244 | """Add 'object' to the list of object files (or analogues, such |
| 245 | as explictly named library files or the output of "resource |
| 246 | compilers") to be included in every link driven by this |
| 247 | compiler object.""" |
| 248 | self.objects.append (object) |
| 249 | |
| 250 | def set_link_objects (self, objects): |
| 251 | """Set the list of object files (or analogues) to be included |
| 252 | in every link to 'objects'. This does not affect any |
| 253 | standard object files that the linker may include by default |
| 254 | (such as system libraries).""" |
| 255 | self.objects = copy (objects) |
| 256 | |
| 257 | |
| 258 | # -- Worker methods ------------------------------------------------ |
| 259 | # (must be implemented by subclasses) |
| 260 | |
| 261 | def compile (self, |
| 262 | sources, |
Greg Ward | 9b17cb5 | 1999-09-13 03:07:24 +0000 | [diff] [blame] | 263 | output_dir=None, |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 264 | macros=None, |
Greg Ward | 802d6b7 | 1999-09-29 12:20:55 +0000 | [diff] [blame] | 265 | includes=None, |
| 266 | extra_preargs=None, |
| 267 | extra_postargs=None): |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 268 | """Compile one or more C/C++ source files. 'sources' must be |
| 269 | a list of strings, each one the name of a C/C++ source |
| 270 | file. Return a list of the object filenames generated |
| 271 | (one for each source filename in 'sources'). |
| 272 | |
| 273 | 'macros', if given, must be a list of macro definitions. A |
| 274 | macro definition is either a (name, value) 2-tuple or a (name,) |
| 275 | 1-tuple. The former defines a macro; if the value is None, the |
| 276 | macro is defined without an explicit value. The 1-tuple case |
| 277 | undefines a macro. Later definitions/redefinitions/ |
| 278 | undefinitions take precedence. |
| 279 | |
| 280 | 'includes', if given, must be a list of strings, the directories |
| 281 | to add to the default include file search path for this |
Greg Ward | 802d6b7 | 1999-09-29 12:20:55 +0000 | [diff] [blame] | 282 | compilation only. |
| 283 | |
| 284 | 'extra_preargs' and 'extra_postargs' are optional lists of extra |
| 285 | command-line arguments that will be, respectively, prepended or |
| 286 | appended to the generated command line immediately before |
| 287 | execution. These will most likely be peculiar to the particular |
| 288 | platform and compiler being worked with, but are a necessary |
| 289 | escape hatch for those occasions when the abstract compiler |
| 290 | framework doesn't cut the mustard.""" |
| 291 | |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 292 | pass |
| 293 | |
| 294 | |
| 295 | # XXX this is kind of useless without 'link_binary()' or |
| 296 | # 'link_executable()' or something -- or maybe 'link_static_lib()' |
| 297 | # should not exist at all, and we just have 'link_binary()'? |
| 298 | def link_static_lib (self, |
| 299 | objects, |
| 300 | output_libname, |
Greg Ward | 9b17cb5 | 1999-09-13 03:07:24 +0000 | [diff] [blame] | 301 | output_dir=None, |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 302 | libraries=None, |
Greg Ward | 802d6b7 | 1999-09-29 12:20:55 +0000 | [diff] [blame] | 303 | library_dirs=None, |
| 304 | extra_preargs=None, |
| 305 | extra_postargs=None): |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 306 | """Link a bunch of stuff together to create a static library |
| 307 | file. The "bunch of stuff" consists of the list of object |
| 308 | files supplied as 'objects', the extra object files supplied |
| 309 | to 'add_link_object()' and/or 'set_link_objects()', the |
| 310 | libraries supplied to 'add_library()' and/or |
| 311 | 'set_libraries()', and the libraries supplied as 'libraries' |
| 312 | (if any). |
| 313 | |
| 314 | 'output_libname' should be a library name, not a filename; |
| 315 | the filename will be inferred from the library name. |
| 316 | |
Greg Ward | 3febd60 | 1999-10-03 20:41:02 +0000 | [diff] [blame^] | 317 | 'libraries' is a list of libraries to link against. These are |
| 318 | library names, not filenames, since they're translated into |
| 319 | filenames in a platform-specific way (eg. "foo" becomes |
| 320 | "libfoo.a" on Unix and "foo.lib" on DOS/Windows). However, they |
| 321 | can include a directory component, which means the linker will |
| 322 | look in that specific directory rather than searching all the |
| 323 | normal locations. |
| 324 | |
| 325 | 'library_dirs', if supplied, should be a list of directories to |
| 326 | search for libraries that were specified as bare library names |
| 327 | (ie. no directory component). These are on top of the system |
| 328 | default and those supplied to 'add_library_dir()' and/or |
| 329 | 'set_library_dirs()'. |
Greg Ward | 802d6b7 | 1999-09-29 12:20:55 +0000 | [diff] [blame] | 330 | |
| 331 | 'extra_preargs' and 'extra_postargs' are as for 'compile()' |
| 332 | (except of course that they supply command-line arguments |
| 333 | for the particular linker being used).""" |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 334 | |
| 335 | pass |
| 336 | |
| 337 | |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 338 | def link_shared_lib (self, |
| 339 | objects, |
| 340 | output_libname, |
Greg Ward | 9b17cb5 | 1999-09-13 03:07:24 +0000 | [diff] [blame] | 341 | output_dir=None, |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 342 | libraries=None, |
Greg Ward | 26e48ea | 1999-08-29 18:17:36 +0000 | [diff] [blame] | 343 | library_dirs=None, |
Greg Ward | 802d6b7 | 1999-09-29 12:20:55 +0000 | [diff] [blame] | 344 | extra_preargs=None, |
| 345 | extra_postargs=None): |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 346 | """Link a bunch of stuff together to create a shared library |
| 347 | file. Has the same effect as 'link_static_lib()' except |
| 348 | that the filename inferred from 'output_libname' will most |
| 349 | likely be different, and the type of file generated will |
| 350 | almost certainly be different.""" |
| 351 | pass |
| 352 | |
Greg Ward | 802d6b7 | 1999-09-29 12:20:55 +0000 | [diff] [blame] | 353 | |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 354 | def link_shared_object (self, |
| 355 | objects, |
| 356 | output_filename, |
Greg Ward | 9b17cb5 | 1999-09-13 03:07:24 +0000 | [diff] [blame] | 357 | output_dir=None, |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 358 | libraries=None, |
Greg Ward | 26e48ea | 1999-08-29 18:17:36 +0000 | [diff] [blame] | 359 | library_dirs=None, |
Greg Ward | 802d6b7 | 1999-09-29 12:20:55 +0000 | [diff] [blame] | 360 | extra_preargs=None, |
| 361 | extra_postargs=None): |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 362 | """Link a bunch of stuff together to create a shared object |
Greg Ward | 9b17cb5 | 1999-09-13 03:07:24 +0000 | [diff] [blame] | 363 | file. Much like 'link_shared_lib()', except the output filename |
| 364 | is explicitly supplied as 'output_filename'. If 'output_dir' is |
| 365 | supplied, 'output_filename' is relative to it |
Greg Ward | 802d6b7 | 1999-09-29 12:20:55 +0000 | [diff] [blame] | 366 | (i.e. 'output_filename' can provide directory components if |
Greg Ward | 9b17cb5 | 1999-09-13 03:07:24 +0000 | [diff] [blame] | 367 | needed).""" |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 368 | pass |
| 369 | |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 370 | |
| 371 | # -- Filename mangling methods ------------------------------------- |
| 372 | |
Greg Ward | 9b17cb5 | 1999-09-13 03:07:24 +0000 | [diff] [blame] | 373 | # General principle for the filename-mangling methods: by default, |
| 374 | # don't include a directory component, no matter what the caller |
| 375 | # supplies. Eg. for UnixCCompiler, a source file of "foo/bar/baz.c" |
| 376 | # becomes "baz.o" or "baz.so", etc. (That way, it's easiest for the |
| 377 | # caller to decide where it wants to put/find the output file.) The |
| 378 | # 'output_dir' parameter overrides this, of course -- the directory |
| 379 | # component of the input filenames is replaced by 'output_dir'. |
| 380 | |
| 381 | def object_filenames (self, source_filenames, output_dir=None): |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 382 | """Return the list of object filenames corresponding to each |
| 383 | specified source filename.""" |
| 384 | pass |
| 385 | |
Greg Ward | 26e48ea | 1999-08-29 18:17:36 +0000 | [diff] [blame] | 386 | def shared_object_filename (self, source_filename): |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 387 | """Return the shared object filename corresponding to a |
Greg Ward | 9b17cb5 | 1999-09-13 03:07:24 +0000 | [diff] [blame] | 388 | specified source filename (assuming the same directory).""" |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 389 | pass |
| 390 | |
Greg Ward | 26e48ea | 1999-08-29 18:17:36 +0000 | [diff] [blame] | 391 | def library_filename (self, libname): |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 392 | """Return the static library filename corresponding to the |
| 393 | specified library name.""" |
| 394 | |
| 395 | pass |
| 396 | |
Greg Ward | 26e48ea | 1999-08-29 18:17:36 +0000 | [diff] [blame] | 397 | def shared_library_filename (self, libname): |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 398 | """Return the shared library filename corresponding to the |
| 399 | specified library name.""" |
| 400 | pass |
| 401 | |
Greg Ward | 9b17cb5 | 1999-09-13 03:07:24 +0000 | [diff] [blame] | 402 | # XXX ugh -- these should go! |
Greg Ward | 26e48ea | 1999-08-29 18:17:36 +0000 | [diff] [blame] | 403 | def object_name (self, inname): |
| 404 | """Given a name with no extension, return the name + object extension""" |
| 405 | return inname + self._obj_ext |
| 406 | |
| 407 | def shared_library_name (self, inname): |
| 408 | """Given a name with no extension, return the name + shared object extension""" |
| 409 | return inname + self._shared_lib_ext |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 410 | |
| 411 | # -- Utility methods ----------------------------------------------- |
| 412 | |
Greg Ward | 9b17cb5 | 1999-09-13 03:07:24 +0000 | [diff] [blame] | 413 | def announce (self, msg, level=1): |
| 414 | if self.verbose >= level: |
| 415 | print msg |
| 416 | |
Greg Ward | 3febd60 | 1999-10-03 20:41:02 +0000 | [diff] [blame^] | 417 | def warn (self, msg): |
| 418 | sys.stderr.write ("warning: %s\n" % msg) |
| 419 | |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 420 | def spawn (self, cmd): |
| 421 | spawn (cmd, verbose=self.verbose, dry_run=self.dry_run) |
| 422 | |
Greg Ward | 9b17cb5 | 1999-09-13 03:07:24 +0000 | [diff] [blame] | 423 | def move_file (self, src, dst): |
| 424 | return move_file (src, dst, verbose=self.verbose, dry_run=self.dry_run) |
| 425 | |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 426 | |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 427 | # class CCompiler |
| 428 | |
| 429 | |
Greg Ward | 802d6b7 | 1999-09-29 12:20:55 +0000 | [diff] [blame] | 430 | # Map a platform ('posix', 'nt') to the default compiler type for |
| 431 | # that platform. |
| 432 | default_compiler = { 'posix': 'unix', |
| 433 | 'nt': 'msvc', |
| 434 | } |
| 435 | |
| 436 | # Map compiler types to (module_name, class_name) pairs -- ie. where to |
| 437 | # find the code that implements an interface to this compiler. (The module |
| 438 | # is assumed to be in the 'distutils' package.) |
| 439 | compiler_class = { 'unix': ('unixccompiler', 'UnixCCompiler'), |
| 440 | 'msvc': ('msvccompiler', 'MSVCCompiler'), |
| 441 | } |
| 442 | |
| 443 | |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 444 | def new_compiler (plat=None, |
Greg Ward | 802d6b7 | 1999-09-29 12:20:55 +0000 | [diff] [blame] | 445 | compiler=None, |
Greg Ward | e1aaaa6 | 1999-08-14 23:50:50 +0000 | [diff] [blame] | 446 | verbose=0, |
Greg Ward | 3febd60 | 1999-10-03 20:41:02 +0000 | [diff] [blame^] | 447 | dry_run=0, |
| 448 | force=0): |
Greg Ward | 3f81cf7 | 1999-07-10 02:03:53 +0000 | [diff] [blame] | 449 | |
Greg Ward | 802d6b7 | 1999-09-29 12:20:55 +0000 | [diff] [blame] | 450 | """Generate an instance of some CCompiler subclass for the supplied |
| 451 | platform/compiler combination. 'plat' defaults to 'os.name' |
| 452 | (eg. 'posix', 'nt'), and 'compiler' defaults to the default |
| 453 | compiler for that platform. Currently only 'posix' and 'nt' |
| 454 | are supported, and the default compilers are "traditional Unix |
| 455 | interface" (UnixCCompiler class) and Visual C++ (MSVCCompiler |
| 456 | class). Note that it's perfectly possible to ask for a Unix |
| 457 | compiler object under Windows, and a Microsoft compiler object |
| 458 | under Unix -- if you supply a value for 'compiler', 'plat' |
| 459 | is ignored.""" |
| 460 | |
| 461 | if plat is None: |
| 462 | plat = os.name |
| 463 | |
| 464 | try: |
| 465 | if compiler is None: |
| 466 | compiler = default_compiler[plat] |
| 467 | |
| 468 | (module_name, class_name) = compiler_class[compiler] |
| 469 | except KeyError: |
| 470 | msg = "don't know how to compile C/C++ code on platform '%s'" % plat |
| 471 | if compiler is not None: |
| 472 | msg = msg + " with '%s' compiler" % compiler |
| 473 | raise DistutilsPlatformError, msg |
| 474 | |
| 475 | try: |
| 476 | module_name = "distutils." + module_name |
| 477 | __import__ (module_name) |
| 478 | module = sys.modules[module_name] |
| 479 | klass = vars(module)[class_name] |
| 480 | except ImportError: |
| 481 | raise DistutilsModuleError, \ |
| 482 | "can't compile C/C++ code: unable to load module '%s'" % \ |
| 483 | module_name |
| 484 | except KeyError: |
| 485 | raise DistutilsModuleError, \ |
| 486 | ("can't compile C/C++ code: unable to find class '%s' " + |
| 487 | "in module '%s'") % (class_name, module_name) |
| 488 | |
Greg Ward | 3febd60 | 1999-10-03 20:41:02 +0000 | [diff] [blame^] | 489 | return klass (verbose, dry_run, force) |
Greg Ward | f7a39ec | 1999-09-08 02:29:08 +0000 | [diff] [blame] | 490 | |
| 491 | |
| 492 | def gen_preprocess_options (macros, includes): |
| 493 | """Generate C pre-processor options (-D, -U, -I) as used by at |
| 494 | least two types of compilers: the typical Unix compiler and Visual |
| 495 | C++. 'macros' is the usual thing, a list of 1- or 2-tuples, where |
| 496 | (name,) means undefine (-U) macro 'name', and (name,value) means |
| 497 | define (-D) macro 'name' to 'value'. 'includes' is just a list of |
| 498 | directory names to be added to the header file search path (-I). |
| 499 | Returns a list of command-line options suitable for either |
| 500 | Unix compilers or Visual C++.""" |
| 501 | |
| 502 | # XXX it would be nice (mainly aesthetic, and so we don't generate |
| 503 | # stupid-looking command lines) to go over 'macros' and eliminate |
| 504 | # redundant definitions/undefinitions (ie. ensure that only the |
| 505 | # latest mention of a particular macro winds up on the command |
| 506 | # line). I don't think it's essential, though, since most (all?) |
| 507 | # Unix C compilers only pay attention to the latest -D or -U |
| 508 | # mention of a macro on their command line. Similar situation for |
| 509 | # 'includes'. I'm punting on both for now. Anyways, weeding out |
| 510 | # redundancies like this should probably be the province of |
| 511 | # CCompiler, since the data structures used are inherited from it |
| 512 | # and therefore common to all CCompiler classes. |
| 513 | |
| 514 | pp_opts = [] |
| 515 | for macro in macros: |
Greg Ward | fbf8aff | 1999-09-21 18:35:09 +0000 | [diff] [blame] | 516 | |
| 517 | if not (type (macro) is TupleType and |
| 518 | 1 <= len (macro) <= 2): |
| 519 | raise TypeError, \ |
| 520 | ("bad macro definition '%s': " + |
| 521 | "each element of 'macros' list must be a 1- or 2-tuple") % \ |
| 522 | macro |
| 523 | |
Greg Ward | f7a39ec | 1999-09-08 02:29:08 +0000 | [diff] [blame] | 524 | if len (macro) == 1: # undefine this macro |
| 525 | pp_opts.append ("-U%s" % macro[0]) |
| 526 | elif len (macro) == 2: |
| 527 | if macro[1] is None: # define with no explicit value |
| 528 | pp_opts.append ("-D%s" % macro[0]) |
| 529 | else: |
| 530 | # XXX *don't* need to be clever about quoting the |
| 531 | # macro value here, because we're going to avoid the |
| 532 | # shell at all costs when we spawn the command! |
| 533 | pp_opts.append ("-D%s=%s" % macro) |
| 534 | |
| 535 | for dir in includes: |
| 536 | pp_opts.append ("-I%s" % dir) |
| 537 | |
| 538 | return pp_opts |
| 539 | |
| 540 | # gen_preprocess_options () |
| 541 | |
| 542 | |
Greg Ward | 3febd60 | 1999-10-03 20:41:02 +0000 | [diff] [blame^] | 543 | def gen_lib_options (compiler, library_dirs, libraries): |
Greg Ward | f7a39ec | 1999-09-08 02:29:08 +0000 | [diff] [blame] | 544 | """Generate linker options for searching library directories and |
| 545 | linking with specific libraries. 'libraries' and 'library_dirs' |
| 546 | are, respectively, lists of library names (not filenames!) and |
Greg Ward | 3febd60 | 1999-10-03 20:41:02 +0000 | [diff] [blame^] | 547 | search directories. Returns a list of command-line options suitable |
| 548 | for use with some compiler (depending on the two format strings |
| 549 | passed in).""" |
Greg Ward | f7a39ec | 1999-09-08 02:29:08 +0000 | [diff] [blame] | 550 | |
| 551 | lib_opts = [] |
| 552 | |
| 553 | for dir in library_dirs: |
Greg Ward | 3febd60 | 1999-10-03 20:41:02 +0000 | [diff] [blame^] | 554 | lib_opts.append (compiler.library_dir_option (dir)) |
Greg Ward | f7a39ec | 1999-09-08 02:29:08 +0000 | [diff] [blame] | 555 | |
| 556 | # XXX it's important that we *not* remove redundant library mentions! |
| 557 | # sometimes you really do have to say "-lfoo -lbar -lfoo" in order to |
| 558 | # resolve all symbols. I just hope we never have to say "-lfoo obj.o |
| 559 | # -lbar" to get things to work -- that's certainly a possibility, but a |
| 560 | # pretty nasty way to arrange your C code. |
| 561 | |
| 562 | for lib in libraries: |
Greg Ward | 3febd60 | 1999-10-03 20:41:02 +0000 | [diff] [blame^] | 563 | (lib_dir, lib_name) = os.path.split (lib) |
| 564 | if lib_dir: |
| 565 | lib_file = compiler.find_library_file ([lib_dir], lib_name) |
| 566 | if lib_file: |
| 567 | lib_opts.append (lib_file) |
| 568 | else: |
| 569 | compiler.warn ("no library file corresponding to " |
| 570 | "'%s' found (skipping)" % lib) |
| 571 | else: |
| 572 | lib_opts.append (compiler.library_option (lib)) |
Greg Ward | f7a39ec | 1999-09-08 02:29:08 +0000 | [diff] [blame] | 573 | |
| 574 | return lib_opts |
| 575 | |
| 576 | # _gen_lib_options () |