ccompiler.py 46.4 KB
Newer Older
1 2 3 4 5
"""distutils.ccompiler

Contains CCompiler, an abstract base class that defines the interface
for the Distutils compiler abstraction model."""

6
__revision__ = "$Id$"
7

8 9
import sys, os, re
from distutils.errors import *
10
from distutils.spawn import spawn
11 12
from distutils.file_util import move_file
from distutils.dir_util import mkpath
13
from distutils.dep_util import newer_pairwise, newer_group
14
from distutils.util import split_quoted, execute
15
from distutils import log
16 17 18

class CCompiler:
    """Abstract base class to define the interface that must be implemented
19 20 21 22 23 24 25 26 27 28 29
    by real compiler classes.  Also has some utility methods used by
    several compiler classes.

    The basic idea behind a compiler abstraction class is that each
    instance can be used for all the compile/link steps in building a
    single project.  Thus, attributes common to all of those compile and
    link steps -- include directories, macros to define, libraries to link
    against, etc. -- are attributes of the compiler instance.  To allow for
    variability in how individual files are treated, most of those
    attributes may be varied on a per-compilation or per-link basis.
    """
30

31 32 33 34 35 36 37 38 39
    # 'compiler_type' is a class attribute that identifies this class.  It
    # keeps code that wants to know what kind of compiler it's dealing with
    # from having to import all possible compiler classes just to do an
    # 'isinstance'.  In concrete CCompiler subclasses, 'compiler_type'
    # should really, really be one of the keys of the 'compiler_class'
    # dictionary (see below -- used by the 'new_compiler()' factory
    # function) -- authors of new compiler interface classes are
    # responsible for updating 'compiler_class'!
    compiler_type = None
40 41 42 43 44 45 46 47 48

    # XXX things not handled by this compiler abstraction model:
    #   * client can't provide additional options for a compiler,
    #     e.g. warning, optimization, debugging flags.  Perhaps this
    #     should be the domain of concrete compiler abstraction classes
    #     (UnixCCompiler, MSVCCompiler, etc.) -- or perhaps the base
    #     class should have methods for the common ones.
    #   * can't completely override the include or library searchg
    #     path, ie. no "cc -I -Idir1 -Idir2" or "cc -L -Ldir1 -Ldir2".
49
    #     I'm not sure how widely supported this is even by Unix
50
    #     compilers, much less on other platforms.  And I'm even less
51 52 53 54
    #     sure how useful it is; maybe for cross-compiling, but
    #     support for that is a ways off.  (And anyways, cross
    #     compilers probably have a dedicated binary with the
    #     right paths compiled in.  I hope.)
55 56 57 58 59
    #   * can't do really freaky things with the library list/library
    #     dirs, e.g. "-Ldir1 -lfoo -Ldir2 -lfoo" to link against
    #     different versions of libfoo.a in different locations.  I
    #     think this is useless without the ability to null out the
    #     library search path anyways.
Fred Drake's avatar
Fred Drake committed
60

61

62 63 64 65 66 67 68 69 70 71 72
    # Subclasses that rely on the standard filename generation methods
    # implemented below should override these; see the comment near
    # those methods ('object_filenames()' et. al.) for details:
    src_extensions = None               # list of strings
    obj_extension = None                # string
    static_lib_extension = None
    shared_lib_extension = None         # string
    static_lib_format = None            # format string
    shared_lib_format = None            # prob. same as static_lib_format
    exe_extension = None                # string

73 74 75 76 77 78 79 80 81 82 83 84 85
    # Default language settings. language_map is used to detect a source
    # file or Extension target language, checking source filenames.
    # language_order is used to detect the language precedence, when deciding
    # what language to use when mixing source types. For example, if some
    # extension has two files with ".c" extension, and one with ".cpp", it
    # is still linked as c++.
    language_map = {".c"   : "c",
                    ".cc"  : "c++",
                    ".cpp" : "c++",
                    ".cxx" : "c++",
                    ".m"   : "objc",
                   }
    language_order = ["c++", "objc", "c"]
86

87
    def __init__(self, verbose=0, dry_run=0, force=0):
88
        self.dry_run = dry_run
89
        self.force = force
90
        self.verbose = verbose
91

92 93 94 95
        # 'output_dir': a common output directory for object, library,
        # shared object, and shared library files
        self.output_dir = None

96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
        # 'macros': a list of macro definitions (or undefinitions).  A
        # macro definition is a 2-tuple (name, value), where the value is
        # either a string or None (no explicit value).  A macro
        # undefinition is a 1-tuple (name,).
        self.macros = []

        # 'include_dirs': a list of directories to search for include files
        self.include_dirs = []

        # 'libraries': a list of libraries to include in any link
        # (library names, not filenames: eg. "foo" not "libfoo.a")
        self.libraries = []

        # 'library_dirs': a list of directories to search for libraries
        self.library_dirs = []

112 113 114 115
        # 'runtime_library_dirs': a list of directories to search for
        # shared libraries/objects at runtime
        self.runtime_library_dirs = []

116 117 118 119
        # 'objects': a list of object files (or similar, such as explicitly
        # named library files) to include on any link
        self.objects = []

120 121 122
        for key in self.executables.keys():
            self.set_executable(key, self.executables[key])

123
    def set_executables(self, **kwargs):
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
        """Define the executables (and options for them) that will be run
        to perform the various stages of compilation.  The exact set of
        executables that may be specified here depends on the compiler
        class (via the 'executables' class attribute), but most will have:
          compiler      the C/C++ compiler
          linker_so     linker used to create shared objects and libraries
          linker_exe    linker used to create binary executables
          archiver      static library creator

        On platforms with a command-line (Unix, DOS/Windows), each of these
        is a string that will be split into executable name and (optional)
        list of arguments.  (Splitting the string is done similarly to how
        Unix shells operate: words are delimited by spaces, but quotes and
        backslashes can override this.  See
        'distutils.util.split_quoted()'.)
        """

        # Note that some CCompiler implementation classes will define class
        # attributes 'cpp', 'cc', etc. with hard-coded executable names;
        # this is appropriate when a compiler class is for exactly one
        # compiler/OS combination (eg. MSVCCompiler).  Other compiler
        # classes (UnixCCompiler, in particular) are driven by information
        # discovered at run-time, since there are many different ways to do
        # basically the same things with Unix C compilers.

Christian Heimes's avatar
Christian Heimes committed
149
        for key in kwargs:
150
            if key not in self.executables:
Christian Heimes's avatar
Christian Heimes committed
151
                raise ValueError("unknown executable '%s' for class %s" %
152
                      (key, self.__class__.__name__))
Christian Heimes's avatar
Christian Heimes committed
153
            self.set_executable(key, kwargs[key])
154 155

    def set_executable(self, key, value):
156
        if isinstance(value, str):
157 158 159
            setattr(self, key, split_quoted(value))
        else:
            setattr(self, key, value)
Fred Drake's avatar
Fred Drake committed
160

161
    def _find_macro(self, name):
162 163 164 165
        i = 0
        for defn in self.macros:
            if defn[0] == name:
                return i
166
            i += 1
167 168
        return None

169
    def _check_macro_definitions(self, definitions):
170
        """Ensures that every element of 'definitions' is a valid macro
171 172 173
        definition, ie. either (name,value) 2-tuple or a (name,) tuple.  Do
        nothing if all definitions are OK, raise TypeError otherwise.
        """
174
        for defn in definitions:
175 176
            if not (isinstance(defn, tuple) and
                    (len(defn) in (1, 2) and
177 178
                      (isinstance (defn[1], str) or defn[1] is None)) and
                    isinstance (defn[0], str)):
179
                raise TypeError(("invalid macro definition '%s': " % defn) + \
180
                      "must be tuple (string,), (string, string), or " + \
181
                      "(string, None)")
182 183 184 185


    # -- Bookkeeping methods -------------------------------------------

186
    def define_macro(self, name, value=None):
187 188 189 190 191 192
        """Define a preprocessor macro for all compilations driven by this
        compiler object.  The optional parameter 'value' should be a
        string; if it is not supplied, then the macro will be defined
        without an explicit value and the exact outcome depends on the
        compiler used (XXX true? does ANSI say anything about this?)
        """
193 194 195 196 197 198
        # Delete from the list of macro definitions/undefinitions if
        # already there (so that this one will take precedence).
        i = self._find_macro (name)
        if i is not None:
            del self.macros[i]

199
        self.macros.append((name, value))
200

201
    def undefine_macro(self, name):
202
        """Undefine a preprocessor macro for all compilations driven by
203 204 205 206 207 208 209
        this compiler object.  If the same macro is defined by
        'define_macro()' and undefined by 'undefine_macro()' the last call
        takes precedence (including multiple redefinitions or
        undefinitions).  If the macro is redefined/undefined on a
        per-compilation basis (ie. in the call to 'compile()'), then that
        takes precedence.
        """
210 211 212 213 214 215 216
        # Delete from the list of macro definitions/undefinitions if
        # already there (so that this one will take precedence).
        i = self._find_macro (name)
        if i is not None:
            del self.macros[i]

        undefn = (name,)
217
        self.macros.append(undefn)
218

219
    def add_include_dir(self, dir):
220 221 222 223 224
        """Add 'dir' to the list of directories that will be searched for
        header files.  The compiler is instructed to search directories in
        the order in which they are supplied by successive calls to
        'add_include_dir()'.
        """
225
        self.include_dirs.append(dir)
226

227
    def set_include_dirs(self, dirs):
228 229 230 231 232 233 234
        """Set the list of directories that will be searched to 'dirs' (a
        list of strings).  Overrides any preceding calls to
        'add_include_dir()'; subsequence calls to 'add_include_dir()' add
        to the list passed to 'set_include_dirs()'.  This does not affect
        any list of standard include directories that the compiler may
        search by default.
        """
235
        self.include_dirs = dirs[:]
236

237
    def add_library(self, libname):
238 239 240 241 242 243 244 245 246 247 248 249 250
        """Add 'libname' to the list of libraries that will be included in
        all links driven by this compiler object.  Note that 'libname'
        should *not* be the name of a file containing a library, but the
        name of the library itself: the actual filename will be inferred by
        the linker, the compiler, or the compiler class (depending on the
        platform).

        The linker will be instructed to link against libraries in the
        order they were supplied to 'add_library()' and/or
        'set_libraries()'.  It is perfectly valid to duplicate library
        names; the linker will be instructed to link against libraries as
        many times as they are mentioned.
        """
251
        self.libraries.append(libname)
252

253
    def set_libraries(self, libnames):
254 255 256 257 258
        """Set the list of libraries to be included in all links driven by
        this compiler object to 'libnames' (a list of strings).  This does
        not affect any standard system libraries that the linker may
        include by default.
        """
259
        self.libraries = libnames[:]
260

261
    def add_library_dir(self, dir):
262
        """Add 'dir' to the list of directories that will be searched for
263 264 265 266
        libraries specified to 'add_library()' and 'set_libraries()'.  The
        linker will be instructed to search for libraries in the order they
        are supplied to 'add_library_dir()' and/or 'set_library_dirs()'.
        """
267
        self.library_dirs.append(dir)
268

269
    def set_library_dirs(self, dirs):
270 271 272 273
        """Set the list of library search directories to 'dirs' (a list of
        strings).  This does not affect any standard library search path
        that the linker may search by default.
        """
274
        self.library_dirs = dirs[:]
275

276
    def add_runtime_library_dir(self, dir):
277
        """Add 'dir' to the list of directories that will be searched for
278 279
        shared libraries at runtime.
        """
280
        self.runtime_library_dirs.append(dir)
281

282
    def set_runtime_library_dirs(self, dirs):
283 284 285 286 287
        """Set the list of directories to search for shared libraries at
        runtime to 'dirs' (a list of strings).  This does not affect any
        standard search path that the runtime linker may search by
        default.
        """
288
        self.runtime_library_dirs = dirs[:]
289

290
    def add_link_object(self, object):
291
        """Add 'object' to the list of object files (or analogues, such as
292
        explicitly named library files or the output of "resource
293 294 295
        compilers") to be included in every link driven by this compiler
        object.
        """
296
        self.objects.append(object)
297

298
    def set_link_objects(self, objects):
299 300 301 302 303
        """Set the list of object files (or analogues) to be included in
        every link to 'objects'.  This does not affect any standard object
        files that the linker may include by default (such as system
        libraries).
        """
304
        self.objects = objects[:]
305 306


Thomas Heller's avatar
Thomas Heller committed
307
    # -- Private utility methods --------------------------------------
308 309
    # (here for the convenience of subclasses)

310 311 312 313
    # Helper method to prep compiler in subclass compile() methods

    def _setup_compile(self, outdir, macros, incdirs, sources, depends,
                       extra):
314
        """Process arguments and decide which source files to compile."""
315 316
        if outdir is None:
            outdir = self.output_dir
317
        elif not isinstance(outdir, str):
318
            raise TypeError("'output_dir' must be a string or None")
319 320 321

        if macros is None:
            macros = self.macros
322
        elif isinstance(macros, list):
323 324
            macros = macros + (self.macros or [])
        else:
325
            raise TypeError("'macros' (if supplied) must be a list of tuples")
326 327 328

        if incdirs is None:
            incdirs = self.include_dirs
329
        elif isinstance(incdirs, (list, tuple)):
330 331
            incdirs = list(incdirs) + (self.include_dirs or [])
        else:
332 333
            raise TypeError(
                  "'include_dirs' (if supplied) must be a list of strings")
334 335 336 337 338

        if extra is None:
            extra = []

        # Get the list of expected output (object) files
339
        objects = self.object_filenames(sources, strip_dir=0,
340
                                        output_dir=outdir)
341 342 343 344 345 346 347 348 349 350
        assert len(objects) == len(sources)

        pp_opts = gen_preprocess_options(macros, incdirs)

        build = {}
        for i in range(len(sources)):
            src = sources[i]
            obj = objects[i]
            ext = os.path.splitext(src)[1]
            self.mkpath(os.path.dirname(obj))
351
            build[obj] = (src, ext)
352 353 354 355 356 357 358 359 360 361 362 363

        return macros, objects, extra, pp_opts, build

    def _get_cc_args(self, pp_opts, debug, before):
        # works for unixccompiler, emxccompiler, cygwinccompiler
        cc_args = pp_opts + ['-c']
        if debug:
            cc_args[:0] = ['-g']
        if before:
            cc_args[:0] = before
        return cc_args

364
    def _fix_compile_args(self, output_dir, macros, include_dirs):
365 366 367 368 369 370 371 372 373
        """Typecheck and fix-up some of the arguments to the 'compile()'
        method, and return fixed-up values.  Specifically: if 'output_dir'
        is None, replaces it with 'self.output_dir'; ensures that 'macros'
        is a list, and augments it with 'self.macros'; ensures that
        'include_dirs' is a list, and augments it with 'self.include_dirs'.
        Guarantees that the returned values are of the correct type,
        i.e. for 'output_dir' either string or None, and for 'macros' and
        'include_dirs' either list or None.
        """
374 375
        if output_dir is None:
            output_dir = self.output_dir
376
        elif not isinstance(output_dir, str):
377
            raise TypeError("'output_dir' must be a string or None")
378 379 380

        if macros is None:
            macros = self.macros
381
        elif isinstance(macros, list):
382 383
            macros = macros + (self.macros or [])
        else:
384
            raise TypeError("'macros' (if supplied) must be a list of tuples")
385 386 387

        if include_dirs is None:
            include_dirs = self.include_dirs
388 389
        elif isinstance(include_dirs, (list, tuple)):
            include_dirs = list(include_dirs) + (self.include_dirs or [])
390
        else:
391 392
            raise TypeError(
                  "'include_dirs' (if supplied) must be a list of strings")
Fred Drake's avatar
Fred Drake committed
393

394
        return output_dir, macros, include_dirs
395

396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
    def _prep_compile(self, sources, output_dir, depends=None):
        """Decide which souce files must be recompiled.

        Determine the list of object files corresponding to 'sources',
        and figure out which ones really need to be recompiled.
        Return a list of all object files and a dictionary telling
        which source files can be skipped.
        """
        # Get the list of expected output (object) files
        objects = self.object_filenames(sources, output_dir=output_dir)
        assert len(objects) == len(sources)

        # Return an empty dict for the "which source files can be skipped"
        # return value to preserve API compatibility.
        return objects, {}

412
    def _fix_object_args(self, objects, output_dir):
413 414 415 416 417
        """Typecheck and fix up some arguments supplied to various methods.
        Specifically: ensure that 'objects' is a list; if output_dir is
        None, replace with self.output_dir.  Return fixed versions of
        'objects' and 'output_dir'.
        """
418 419 420
        if not isinstance(objects, (list, tuple)):
            raise TypeError("'objects' must be a list or tuple of strings")
        objects = list(objects)
Fred Drake's avatar
Fred Drake committed
421

422 423
        if output_dir is None:
            output_dir = self.output_dir
424
        elif not isinstance(output_dir, str):
425
            raise TypeError("'output_dir' must be a string or None")
426

427
        return (objects, output_dir)
428

429
    def _fix_lib_args(self, libraries, library_dirs, runtime_library_dirs):
430
        """Typecheck and fix up some of the arguments supplied to the
431 432 433 434 435
        'link_*' methods.  Specifically: ensure that all arguments are
        lists, and augment them with their permanent versions
        (eg. 'self.libraries' augments 'libraries').  Return a tuple with
        fixed versions of all arguments.
        """
436 437
        if libraries is None:
            libraries = self.libraries
438
        elif isinstance(libraries, (list, tuple)):
439 440
            libraries = list (libraries) + (self.libraries or [])
        else:
441 442
            raise TypeError(
                  "'libraries' (if supplied) must be a list of strings")
443 444 445

        if library_dirs is None:
            library_dirs = self.library_dirs
446
        elif isinstance(library_dirs, (list, tuple)):
447
            library_dirs = list (library_dirs) + (self.library_dirs or [])
448
        else:
449 450
            raise TypeError(
                  "'library_dirs' (if supplied) must be a list of strings")
451 452 453

        if runtime_library_dirs is None:
            runtime_library_dirs = self.runtime_library_dirs
454 455
        elif isinstance(runtime_library_dirs, (list, tuple)):
            runtime_library_dirs = (list(runtime_library_dirs) +
456 457
                                    (self.runtime_library_dirs or []))
        else:
458 459
            raise TypeError("'runtime_library_dirs' (if supplied) "
                            "must be a list of strings")
460 461

        return (libraries, library_dirs, runtime_library_dirs)
462

463
    def _need_link(self, objects, output_file):
464 465 466
        """Return true if we need to relink the files listed in 'objects'
        to recreate 'output_file'.
        """
467
        if self.force:
468
            return True
469 470 471 472 473 474 475
        else:
            if self.dry_run:
                newer = newer_group (objects, output_file, missing='newer')
            else:
                newer = newer_group (objects, output_file)
            return newer

476
    def detect_language(self, sources):
477 478 479
        """Detect the language of a given file, or list of files. Uses
        language_map, and language_order to do the job.
        """
480
        if not isinstance(sources, list):
481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
            sources = [sources]
        lang = None
        index = len(self.language_order)
        for source in sources:
            base, ext = os.path.splitext(source)
            extlang = self.language_map.get(ext)
            try:
                extindex = self.language_order.index(extlang)
                if extindex < index:
                    lang = extlang
                    index = extindex
            except ValueError:
                pass
        return lang

496

497 498 499
    # -- Worker methods ------------------------------------------------
    # (must be implemented by subclasses)

500 501
    def preprocess(self, source, output_file=None, macros=None,
                   include_dirs=None, extra_preargs=None, extra_postargs=None):
502 503 504 505 506 507
        """Preprocess a single C/C++ source file, named in 'source'.
        Output will be written to file named 'output_file', or stdout if
        'output_file' not supplied.  'macros' is a list of macro
        definitions as for 'compile()', which will augment the macros set
        with 'define_macro()' and 'undefine_macro()'.  'include_dirs' is a
        list of directory names that will be added to the default list.
508 509

        Raises PreprocessError on failure.
510 511 512
        """
        pass

513 514 515 516 517 518 519 520 521 522 523 524 525
    def compile(self, sources, output_dir=None, macros=None,
                include_dirs=None, debug=0, extra_preargs=None,
                extra_postargs=None, depends=None):
        """Compile one or more source files.

        'sources' must be a list of filenames, most likely C/C++
        files, but in reality anything that can be handled by a
        particular compiler and compiler class (eg. MSVCCompiler can
        handle resource files in 'sources').  Return a list of object
        filenames, one per source filename in 'sources'.  Depending on
        the implementation, not all source files will necessarily be
        compiled, but all corresponding object filenames will be
        returned.
526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555

        If 'output_dir' is given, object files will be put under it, while
        retaining their original path component.  That is, "foo/bar.c"
        normally compiles to "foo/bar.o" (for a Unix implementation); if
        'output_dir' is "build", then it would compile to
        "build/foo/bar.o".

        'macros', if given, must be a list of macro definitions.  A macro
        definition is either a (name, value) 2-tuple or a (name,) 1-tuple.
        The former defines a macro; if the value is None, the macro is
        defined without an explicit value.  The 1-tuple case undefines a
        macro.  Later definitions/redefinitions/ undefinitions take
        precedence.

        'include_dirs', if given, must be a list of strings, the
        directories to add to the default include file search path for this
        compilation only.

        'debug' is a boolean; if true, the compiler will be instructed to
        output debug symbols in (or alongside) the object file(s).

        'extra_preargs' and 'extra_postargs' are implementation- dependent.
        On platforms that have the notion of a command-line (e.g. Unix,
        DOS/Windows), they are most likely lists of strings: extra
        command-line arguments to prepand/append to the compiler command
        line.  On other platforms, consult the implementation class
        documentation.  In any event, they are intended as an escape hatch
        for those occasions when the abstract compiler framework doesn't
        cut the mustard.

556 557 558 559 560 561
        'depends', if given, is a list of filenames that all targets
        depend on.  If a source file is older than any file in
        depends, then the source file will be recompiled.  This
        supports dependency tracking, but only at a coarse
        granularity.

562 563
        Raises CompileError on failure.
        """
564 565 566 567 568 569 570
        # A concrete compiler class can either override this method
        # entirely or implement _compile().
        macros, objects, extra_postargs, pp_opts, build = \
                self._setup_compile(output_dir, macros, include_dirs, sources,
                                    depends, extra_postargs)
        cc_args = self._get_cc_args(pp_opts, debug, extra_preargs)

571 572 573 574 575
        for obj in objects:
            try:
                src, ext = build[obj]
            except KeyError:
                continue
576 577 578 579 580 581 582 583 584 585
            self._compile(obj, src, ext, cc_args, extra_postargs, pp_opts)

        # Return *all* object filenames, not just the ones we just built.
        return objects

    def _compile(self, obj, src, ext, cc_args, extra_postargs, pp_opts):
        """Compile 'src' to product 'obj'."""
        # A concrete compiler class that does not override compile()
        # should implement _compile().
        pass
586

587 588
    def create_static_lib(self, objects, output_libname, output_dir=None,
                          debug=0, target_lang=None):
589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604
        """Link a bunch of stuff together to create a static library file.
        The "bunch of stuff" consists of the list of object files supplied
        as 'objects', the extra object files supplied to
        'add_link_object()' and/or 'set_link_objects()', the libraries
        supplied to 'add_library()' and/or 'set_libraries()', and the
        libraries supplied as 'libraries' (if any).

        'output_libname' should be a library name, not a filename; the
        filename will be inferred from the library name.  'output_dir' is
        the directory where the library file will be put.

        'debug' is a boolean; if true, debugging information will be
        included in the library (note that on most platforms, it is the
        compile step where this matters: the 'debug' flag is included here
        just for consistency).

605 606 607 608
        'target_lang' is the target language for which the given objects
        are being compiled. This allows specific linkage time treatment of
        certain languages.

609 610
        Raises LibError on failure.
        """
611
        pass
Fred Drake's avatar
Fred Drake committed
612

613

614 615 616 617 618
    # values for target_desc parameter in link()
    SHARED_OBJECT = "shared_object"
    SHARED_LIBRARY = "shared_library"
    EXECUTABLE = "executable"

619 620 621 622 623 624 625 626 627 628 629 630 631 632
    def link(self,
             target_desc,
             objects,
             output_filename,
             output_dir=None,
             libraries=None,
             library_dirs=None,
             runtime_library_dirs=None,
             export_symbols=None,
             debug=0,
             extra_preargs=None,
             extra_postargs=None,
             build_temp=None,
             target_lang=None):
633 634 635 636 637 638 639 640
        """Link a bunch of stuff together to create an executable or
        shared library file.

        The "bunch of stuff" consists of the list of object files supplied
        as 'objects'.  'output_filename' should be a filename.  If
        'output_dir' is supplied, 'output_filename' is relative to it
        (i.e. 'output_filename' can provide directory components if
        needed).
641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669

        'libraries' is a list of libraries to link against.  These are
        library names, not filenames, since they're translated into
        filenames in a platform-specific way (eg. "foo" becomes "libfoo.a"
        on Unix and "foo.lib" on DOS/Windows).  However, they can include a
        directory component, which means the linker will look in that
        specific directory rather than searching all the normal locations.

        'library_dirs', if supplied, should be a list of directories to
        search for libraries that were specified as bare library names
        (ie. no directory component).  These are on top of the system
        default and those supplied to 'add_library_dir()' and/or
        'set_library_dirs()'.  'runtime_library_dirs' is a list of
        directories that will be embedded into the shared library and used
        to search for other shared libraries that *it* depends on at
        run-time.  (This may only be relevant on Unix.)

        'export_symbols' is a list of symbols that the shared library will
        export.  (This appears to be relevant only on Windows.)

        'debug' is as for 'compile()' and 'create_static_lib()', with the
        slight distinction that it actually matters on most platforms (as
        opposed to 'create_static_lib()', which includes a 'debug' flag
        mostly for form's sake).

        'extra_preargs' and 'extra_postargs' are as for 'compile()' (except
        of course that they supply command-line arguments for the
        particular linker being used).

670 671 672 673
        'target_lang' is the target language for which the given objects
        are being compiled. This allows specific linkage time treatment of
        certain languages.

674 675
        Raises LinkError on failure.
        """
676 677
        raise NotImplementedError

Fred Drake's avatar
Fred Drake committed
678

679
    # Old 'link_*()' methods, rewritten to use the new 'link()' method.
680

681 682 683 684 685 686 687 688 689 690 691 692 693
    def link_shared_lib(self,
                        objects,
                        output_libname,
                        output_dir=None,
                        libraries=None,
                        library_dirs=None,
                        runtime_library_dirs=None,
                        export_symbols=None,
                        debug=0,
                        extra_preargs=None,
                        extra_postargs=None,
                        build_temp=None,
                        target_lang=None):
Fred Drake's avatar
Fred Drake committed
694
        self.link(CCompiler.SHARED_LIBRARY, objects,
695 696 697 698
                  self.library_filename(output_libname, lib_type='shared'),
                  output_dir,
                  libraries, library_dirs, runtime_library_dirs,
                  export_symbols, debug,
699
                  extra_preargs, extra_postargs, build_temp, target_lang)
Fred Drake's avatar
Fred Drake committed
700

701

702 703 704 705 706 707 708 709 710 711 712 713 714
    def link_shared_object(self,
                           objects,
                           output_filename,
                           output_dir=None,
                           libraries=None,
                           library_dirs=None,
                           runtime_library_dirs=None,
                           export_symbols=None,
                           debug=0,
                           extra_preargs=None,
                           extra_postargs=None,
                           build_temp=None,
                           target_lang=None):
715 716 717 718
        self.link(CCompiler.SHARED_OBJECT, objects,
                  output_filename, output_dir,
                  libraries, library_dirs, runtime_library_dirs,
                  export_symbols, debug,
719
                  extra_preargs, extra_postargs, build_temp, target_lang)
720

721

722 723 724 725 726 727 728 729 730 731 732
    def link_executable(self,
                        objects,
                        output_progname,
                        output_dir=None,
                        libraries=None,
                        library_dirs=None,
                        runtime_library_dirs=None,
                        debug=0,
                        extra_preargs=None,
                        extra_postargs=None,
                        target_lang=None):
Fred Drake's avatar
Fred Drake committed
733
        self.link(CCompiler.EXECUTABLE, objects,
734
                  self.executable_filename(output_progname), output_dir,
Fred Drake's avatar
Fred Drake committed
735
                  libraries, library_dirs, runtime_library_dirs, None,
736
                  debug, extra_preargs, extra_postargs, None, target_lang)
737 738


739 740 741 742 743
    # -- Miscellaneous methods -----------------------------------------
    # These are all used by the 'gen_lib_options() function; there is
    # no appropriate default implementation so subclasses should
    # implement all of these.

744
    def library_dir_option(self, dir):
745 746 747
        """Return the compiler option to add 'dir' to the list of
        directories searched for libraries.
        """
748 749
        raise NotImplementedError

750
    def runtime_library_dir_option(self, dir):
751 752 753
        """Return the compiler option to add 'dir' to the list of
        directories searched for runtime libraries.
        """
754 755
        raise NotImplementedError

756
    def library_option(self, lib):
757
        """Return the compiler option to add 'dir' to the list of libraries
758 759
        linked into the shared library or executable.
        """
760 761
        raise NotImplementedError

762 763
    def has_function(self, funcname, includes=None, include_dirs=None,
                     libraries=None, library_dirs=None):
764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802
        """Return a boolean indicating whether funcname is supported on
        the current platform.  The optional arguments can be used to
        augment the compilation environment.
        """
        # this can't be included at module scope because it tries to
        # import math which might not be available at that point - maybe
        # the necessary logic should just be inlined?
        import tempfile
        if includes is None:
            includes = []
        if include_dirs is None:
            include_dirs = []
        if libraries is None:
            libraries = []
        if library_dirs is None:
            library_dirs = []
        fd, fname = tempfile.mkstemp(".c", funcname, text=True)
        f = os.fdopen(fd, "w")
        for incl in includes:
            f.write("""#include "%s"\n""" % incl)
        f.write("""\
main (int argc, char **argv) {
    %s();
}
""" % funcname)
        f.close()
        try:
            objects = self.compile([fname], include_dirs=include_dirs)
        except CompileError:
            return False

        try:
            self.link_executable(objects, "a.out",
                                 libraries=libraries,
                                 library_dirs=library_dirs)
        except (LinkError, TypeError):
            return False
        return True

803
    def find_library_file (self, dirs, lib, debug=0):
804
        """Search the specified list of directories for a static or shared
805 806 807 808
        library file 'lib' and return the full path to that file.  If
        'debug' true, look for a debugging version (if that makes sense on
        the current platform).  Return None if 'lib' wasn't found in any of
        the specified directories.
809
        """
810 811
        raise NotImplementedError

812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845
    # -- Filename generation methods -----------------------------------

    # The default implementation of the filename generating methods are
    # prejudiced towards the Unix/DOS/Windows view of the world:
    #   * object files are named by replacing the source file extension
    #     (eg. .c/.cpp -> .o/.obj)
    #   * library files (shared or static) are named by plugging the
    #     library name and extension into a format string, eg.
    #     "lib%s.%s" % (lib_name, ".a") for Unix static libraries
    #   * executables are named by appending an extension (possibly
    #     empty) to the program name: eg. progname + ".exe" for
    #     Windows
    #
    # To reduce redundant code, these methods expect to find
    # several attributes in the current object (presumably defined
    # as class attributes):
    #   * src_extensions -
    #     list of C/C++ source file extensions, eg. ['.c', '.cpp']
    #   * obj_extension -
    #     object file extension, eg. '.o' or '.obj'
    #   * static_lib_extension -
    #     extension for static library files, eg. '.a' or '.lib'
    #   * shared_lib_extension -
    #     extension for shared library/object files, eg. '.so', '.dll'
    #   * static_lib_format -
    #     format string for generating static library filenames,
    #     eg. 'lib%s.%s' or '%s.%s'
    #   * shared_lib_format
    #     format string for generating shared library filenames
    #     (probably same as static_lib_format, since the extension
    #     is one of the intended parameters to the format string)
    #   * exe_extension -
    #     extension for executable files, eg. '' or '.exe'

846
    def object_filenames(self, source_filenames, strip_dir=0, output_dir=''):
847 848
        if output_dir is None:
            output_dir = ''
849 850
        obj_names = []
        for src_name in source_filenames:
851
            base, ext = os.path.splitext(src_name)
852 853
            base = os.path.splitdrive(base)[1] # Chop off the drive
            base = base[os.path.isabs(base):]  # If abs, chop off leading /
854
            if ext not in self.src_extensions:
855 856
                raise UnknownFileError(
                      "unknown file type '%s' (from '%s')" % (ext, src_name))
857
            if strip_dir:
858 859 860
                base = os.path.basename(base)
            obj_names.append(os.path.join(output_dir,
                                          base + self.obj_extension))
861 862
        return obj_names

863 864
    def shared_object_filename(self, basename, strip_dir=0, output_dir=''):
        assert output_dir is not None
865
        if strip_dir:
866
            basename = os.path.basename(basename)
867
        return os.path.join(output_dir, basename + self.shared_lib_extension)
868

869 870
    def executable_filename(self, basename, strip_dir=0, output_dir=''):
        assert output_dir is not None
871
        if strip_dir:
872
            basename = os.path.basename(basename)
873
        return os.path.join(output_dir, basename + (self.exe_extension or ''))
874

875 876 877 878
    def library_filename(self, libname, lib_type='static',     # or 'shared'
                         strip_dir=0, output_dir=''):
        assert output_dir is not None
        if lib_type not in ("static", "shared", "dylib"):
879 880
            raise ValueError(
                  "'lib_type' must be \"static\", \"shared\" or \"dylib\"")
881 882
        fmt = getattr(self, lib_type + "_lib_format")
        ext = getattr(self, lib_type + "_lib_extension")
883

884
        dir, base = os.path.split(libname)
885 886 887 888
        filename = fmt % (base, ext)
        if strip_dir:
            dir = ''

889
        return os.path.join(output_dir, dir, filename)
Greg Ward's avatar
Greg Ward committed
890

891 892 893

    # -- Utility methods -----------------------------------------------

894
    def announce(self, msg, level=1):
895
        log.debug(msg)
896

897
    def debug_print(self, msg):
898
        from distutils.debug import DEBUG
Greg Ward's avatar
Greg Ward committed
899
        if DEBUG:
900
            print(msg)
Greg Ward's avatar
Greg Ward committed
901

902 903
    def warn(self, msg):
        sys.stderr.write("warning: %s\n" % msg)
904

905
    def execute(self, func, args, msg=None, level=1):
906
        execute(func, args, msg, self.dry_run)
907

908 909
    def spawn(self, cmd):
        spawn(cmd, dry_run=self.dry_run)
910

911 912
    def move_file(self, src, dst):
        return move_file(src, dst, dry_run=self.dry_run)
913

914
    def mkpath (self, name, mode=0o777):
Benjamin Peterson's avatar
Benjamin Peterson committed
915
        mkpath(name, mode, dry_run=self.dry_run)
916 917


918 919 920 921 922 923 924
# Map a sys.platform/os.name ('posix', 'nt') to the default compiler
# type for that platform. Keys are interpreted as re match
# patterns. Order is important; platform mappings are preferred over
# OS names.
_default_compilers = (

    # Platform string mappings
925 926 927 928

    # on a cygwin built python we can use gcc like an ordinary UNIXish
    # compiler
    ('cygwin.*', 'unix'),
929
    ('os2emx', 'emx'),
Fred Drake's avatar
Fred Drake committed
930

931 932 933
    # OS name mappings
    ('posix', 'unix'),
    ('nt', 'msvc'),
Fred Drake's avatar
Fred Drake committed
934

935 936 937
    )

def get_default_compiler(osname=None, platform=None):
938
    """Determine the default compiler to use for the given platform.
939

940 941 942
       osname should be one of the standard Python OS names (i.e. the
       ones returned by os.name) and platform the common value
       returned by sys.platform for the platform in question.
943

944 945
       The default values are os.name and sys.platform in case the
       parameters are not given.
946 947 948 949 950 951 952 953 954 955 956
    """
    if osname is None:
        osname = os.name
    if platform is None:
        platform = sys.platform
    for pattern, compiler in _default_compilers:
        if re.match(pattern, platform) is not None or \
           re.match(pattern, osname) is not None:
            return compiler
    # Default to Unix compiler
    return 'unix'
957 958 959 960

# Map compiler types to (module_name, class_name) pairs -- ie. where to
# find the code that implements an interface to this compiler.  (The module
# is assumed to be in the 'distutils' package.)
961 962 963 964 965 966 967 968
compiler_class = { 'unix':    ('unixccompiler', 'UnixCCompiler',
                               "standard UNIX-style compiler"),
                   'msvc':    ('msvccompiler', 'MSVCCompiler',
                               "Microsoft Visual C++"),
                   'cygwin':  ('cygwinccompiler', 'CygwinCCompiler',
                               "Cygwin port of GNU C Compiler for Win32"),
                   'mingw32': ('cygwinccompiler', 'Mingw32CCompiler',
                               "Mingw32 port of GNU C Compiler for Win32"),
969 970
                   'bcpp':    ('bcppcompiler', 'BCPPCompiler',
                               "Borland C++ Compiler"),
971 972
                   'emx':     ('emxccompiler', 'EMXCCompiler',
                               "EMX port of GNU C Compiler for OS/2"),
973 974
                 }

975
def show_compilers():
976 977 978 979 980 981
    """Print list of available compilers (used by the "--help-compiler"
    options to "build", "build_ext", "build_clib").
    """
    # XXX this "knows" that the compiler option it's describing is
    # "--compiler", which just happens to be the case for the three
    # commands that use it.
Fred Drake's avatar
Fred Drake committed
982
    from distutils.fancy_getopt import FancyGetopt
983
    compilers = []
984
    for compiler in compiler_class.keys():
985
        compilers.append(("compiler="+compiler, None,
986 987 988
                          compiler_class[compiler][2]))
    compilers.sort()
    pretty_printer = FancyGetopt(compilers)
989
    pretty_printer.print_help("List of available compilers:")
Fred Drake's avatar
Fred Drake committed
990

991

992
def new_compiler(plat=None, compiler=None, verbose=0, dry_run=0, force=0):
993
    """Generate an instance of some CCompiler subclass for the supplied
994 995 996 997 998 999 1000 1001 1002
    platform/compiler combination.  'plat' defaults to 'os.name'
    (eg. 'posix', 'nt'), and 'compiler' defaults to the default compiler
    for that platform.  Currently only 'posix' and 'nt' are supported, and
    the default compilers are "traditional Unix interface" (UnixCCompiler
    class) and Visual C++ (MSVCCompiler class).  Note that it's perfectly
    possible to ask for a Unix compiler object under Windows, and a
    Microsoft compiler object under Unix -- if you supply a value for
    'compiler', 'plat' is ignored.
    """
1003 1004 1005 1006 1007
    if plat is None:
        plat = os.name

    try:
        if compiler is None:
1008
            compiler = get_default_compiler(plat)
Fred Drake's avatar
Fred Drake committed
1009

1010
        (module_name, class_name, long_description) = compiler_class[compiler]
1011 1012 1013 1014
    except KeyError:
        msg = "don't know how to compile C/C++ code on platform '%s'" % plat
        if compiler is not None:
            msg = msg + " with '%s' compiler" % compiler
1015
        raise DistutilsPlatformError(msg)
Fred Drake's avatar
Fred Drake committed
1016

1017 1018 1019 1020 1021 1022
    try:
        module_name = "distutils." + module_name
        __import__ (module_name)
        module = sys.modules[module_name]
        klass = vars(module)[class_name]
    except ImportError:
1023
        raise DistutilsModuleError(
1024
              "can't compile C/C++ code: unable to load module '%s'" % \
1025
              module_name)
1026
    except KeyError:
1027 1028 1029
        raise DistutilsModuleError(
               "can't compile C/C++ code: unable to find class '%s' "
               "in module '%s'" % (class_name, module_name))
1030

1031 1032 1033
    # XXX The None is necessary to preserve backwards compatibility
    # with classes that expect verbose to be the first positional
    # argument.
1034
    return klass(None, dry_run, force)
1035 1036


1037
def gen_preprocess_options(macros, include_dirs):
1038 1039 1040 1041 1042 1043 1044 1045 1046
    """Generate C pre-processor options (-D, -U, -I) as used by at least
    two types of compilers: the typical Unix compiler and Visual C++.
    'macros' is the usual thing, a list of 1- or 2-tuples, where (name,)
    means undefine (-U) macro 'name', and (name,value) means define (-D)
    macro 'name' to 'value'.  'include_dirs' is just a list of directory
    names to be added to the header file search path (-I).  Returns a list
    of command-line options suitable for either Unix compilers or Visual
    C++.
    """
1047 1048 1049 1050 1051 1052 1053
    # XXX it would be nice (mainly aesthetic, and so we don't generate
    # stupid-looking command lines) to go over 'macros' and eliminate
    # redundant definitions/undefinitions (ie. ensure that only the
    # latest mention of a particular macro winds up on the command
    # line).  I don't think it's essential, though, since most (all?)
    # Unix C compilers only pay attention to the latest -D or -U
    # mention of a macro on their command line.  Similar situation for
1054
    # 'include_dirs'.  I'm punting on both for now.  Anyways, weeding out
1055 1056 1057 1058 1059
    # redundancies like this should probably be the province of
    # CCompiler, since the data structures used are inherited from it
    # and therefore common to all CCompiler classes.
    pp_opts = []
    for macro in macros:
1060 1061 1062 1063 1064 1065 1066 1067 1068
        if not (isinstance(macro, tuple) and 1 <= len(macro) <= 2):
            raise TypeError(
                  "bad macro definition '%s': "
                  "each element of 'macros' list must be a 1- or 2-tuple"
                  % macro)

        if len(macro) == 1:        # undefine this macro
            pp_opts.append("-U%s" % macro[0])
        elif len(macro) == 2:
1069
            if macro[1] is None:    # define with no explicit value
1070
                pp_opts.append("-D%s" % macro[0])
1071 1072 1073 1074
            else:
                # XXX *don't* need to be clever about quoting the
                # macro value here, because we're going to avoid the
                # shell at all costs when we spawn the command!
1075
                pp_opts.append("-D%s=%s" % macro)
1076

1077
    for dir in include_dirs:
1078
        pp_opts.append("-I%s" % dir)
1079 1080 1081
    return pp_opts


1082
def gen_lib_options (compiler, library_dirs, runtime_library_dirs, libraries):
1083
    """Generate linker options for searching library directories and
1084 1085 1086 1087
    linking with specific libraries.  'libraries' and 'library_dirs' are,
    respectively, lists of library names (not filenames!) and search
    directories.  Returns a list of command-line options suitable for use
    with some compiler (depending on the two format strings passed in).
1088
    """
1089 1090 1091
    lib_opts = []

    for dir in library_dirs:
1092
        lib_opts.append(compiler.library_dir_option(dir))
1093

1094
    for dir in runtime_library_dirs:
1095 1096
        opt = compiler.runtime_library_dir_option(dir)
        if isinstance(opt, list):
1097
            lib_opts = lib_opts + opt
1098
        else:
1099
            lib_opts.append(opt)
1100

1101 1102 1103 1104 1105 1106 1107
    # XXX it's important that we *not* remove redundant library mentions!
    # sometimes you really do have to say "-lfoo -lbar -lfoo" in order to
    # resolve all symbols.  I just hope we never have to say "-lfoo obj.o
    # -lbar" to get things to work -- that's certainly a possibility, but a
    # pretty nasty way to arrange your C code.

    for lib in libraries:
1108 1109
        (lib_dir, lib_name) = os.path.split(lib)
        if lib_dir:
1110
            lib_file = compiler.find_library_file([lib_dir], lib_name)
1111
            if lib_file:
1112
                lib_opts.append(lib_file)
1113
            else:
1114 1115
                compiler.warn("no library file corresponding to "
                              "'%s' found (skipping)" % lib)
1116
        else:
1117
            lib_opts.append(compiler.library_option (lib))
1118
    return lib_opts