cpython-lru_cache-weakref: Lib/distutils/ccompiler.py annotate

annotate Lib/distutils/ccompiler.py @ 79675:c0a2294de787 2.7

Issue #16199: Backport 2to3 typo fix from 3.2.

author	Chris Jerdonek <chris.jerdonek@gmail.com>
date	Thu, 11 Oct 2012 16:15:46 -0700
parents	6240ff5dfebe
children	d4dd297fedb1

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

Mercurial > cpython-lru_cache-weakref

annotate Lib/distutils/ccompiler.py @ 79675:c0a2294de787 2.7