1
"""distutils.unixccompiler
3
Contains the UnixCCompiler class, a subclass of CCompiler that handles
4
the "typical" Unix-style command-line C compiler:
5
* macros defined with -Dname[=value]
6
* macros undefined with -Uname
7
* include search directories specified with -Idir
8
* libraries specified with -lllib
9
* library search directories specified with -Ldir
10
* compile handled by 'cc' (or similar) executable with -c option:
12
* link static library handled by 'ar' command (possibly with 'ranlib')
13
* link shared library handled by 'cc -shared'
16
__revision__ = "$Id: unixccompiler.py 65206 2008-07-23 16:10:53Z georg.brandl $"
20
from distutils import sysconfig
21
from distutils.dep_util import newer
22
from distutils.ccompiler import \
23
CCompiler, gen_preprocess_options, gen_lib_options
24
from distutils.errors import \
25
DistutilsExecError, CompileError, LibError, LinkError
26
from distutils import log
28
# XXX Things not currently handled:
29
# * optimization/debug/warning flags; we just use whatever's in Python's
30
# Makefile and live with it. Is this adequate? If not, we might
31
# have to have a bunch of subclasses GNUCCompiler, SGICCompiler,
32
# SunCCompiler, and I suspect down that road lies madness.
33
# * even if we don't know a warning flag from an optimization flag,
34
# we need some way for outsiders to feed preprocessor/compiler/linker
35
# flags in to us -- eg. a sysadmin might want to mandate certain flags
36
# via a site config file, or a user might want to set something for
37
# compiling this module distribution only via the setup.py command
38
# line, whatever. As long as these options come from something on the
39
# current system, they can be as system-dependent as they like, and we
40
# should just happily stuff them into the preprocessor/compiler/linker
41
# options and carry on.
43
def _darwin_compiler_fixup(compiler_so, cc_args):
45
This function will strip '-isysroot PATH' and '-arch ARCH' from the
46
compile flags if the user has specified one them in extra_compile_flags.
48
This is needed because '-arch ARCH' adds another architecture to the
49
build, without a way to remove an architecture. Furthermore GCC will
50
barf if multiple '-isysroot' arguments are present.
52
stripArch = stripSysroot = False
54
compiler_so = list(compiler_so)
55
kernel_version = os.uname()[2] # 8.4.3
56
major_version = int(kernel_version.split('.')[0])
59
# OSX before 10.4.0, these don't support -arch and -isysroot at
61
stripArch = stripSysroot = True
63
stripArch = '-arch' in cc_args
64
stripSysroot = '-isysroot' in cc_args
66
if stripArch or 'ARCHFLAGS' in os.environ:
69
index = compiler_so.index('-arch')
70
# Strip this argument and the next one:
71
del compiler_so[index:index+2]
75
if 'ARCHFLAGS' in os.environ and not stripArch:
76
# User specified different -arch flags in the environ,
77
# see also distutils.sysconfig
78
compiler_so = compiler_so + os.environ['ARCHFLAGS'].split()
82
index = compiler_so.index('-isysroot')
83
# Strip this argument and the next one:
84
del compiler_so[index:index+2]
88
# Check if the SDK that is used during compilation actually exists,
89
# the universal build requires the usage of a universal SDK and not all
90
# users have that installed by default.
92
if '-isysroot' in cc_args:
93
idx = cc_args.index('-isysroot')
94
sysroot = cc_args[idx+1]
95
elif '-isysroot' in compiler_so:
96
idx = compiler_so.index('-isysroot')
97
sysroot = compiler_so[idx+1]
99
if sysroot and not os.path.isdir(sysroot):
100
log.warn("Compiling with an SDK that doesn't seem to exist: %s",
102
log.warn("Please check your Xcode installation")
106
class UnixCCompiler(CCompiler):
108
compiler_type = 'unix'
110
# These are used by CCompiler in two places: the constructor sets
111
# instance attributes 'preprocessor', 'compiler', etc. from them, and
112
# 'set_executable()' allows any of these to be set. The defaults here
113
# are pretty generic; they will probably have to be set by an outsider
114
# (eg. using information discovered by the sysconfig about building
115
# Python extensions).
116
executables = {'preprocessor' : None,
118
'compiler_so' : ["cc"],
119
'compiler_cxx' : ["cc"],
120
'linker_so' : ["cc", "-shared"],
121
'linker_exe' : ["cc"],
122
'archiver' : ["ar", "-cr"],
126
if sys.platform[:6] == "darwin":
127
executables['ranlib'] = ["ranlib"]
129
# Needed for the filename generation methods provided by the base
130
# class, CCompiler. NB. whoever instantiates/uses a particular
131
# UnixCCompiler instance should set 'shared_lib_ext' -- we set a
132
# reasonable common default here, but it's not necessarily used on all
135
src_extensions = [".c",".C",".cc",".cxx",".cpp",".m"]
137
static_lib_extension = ".a"
138
shared_lib_extension = ".so"
139
dylib_lib_extension = ".dylib"
140
static_lib_format = shared_lib_format = dylib_lib_format = "lib%s%s"
141
if sys.platform == "cygwin":
142
exe_extension = ".exe"
144
def preprocess(self, source, output_file=None, macros=None,
145
include_dirs=None, extra_preargs=None, extra_postargs=None):
146
fixed_args = self._fix_compile_args(None, macros, include_dirs)
147
ignore, macros, include_dirs = fixed_args
148
pp_opts = gen_preprocess_options(macros, include_dirs)
149
pp_args = self.preprocessor + pp_opts
151
pp_args.extend(['-o', output_file])
153
pp_args[:0] = extra_preargs
155
pp_args.extend(extra_postargs)
156
pp_args.append(source)
158
# We need to preprocess: either we're being forced to, or we're
159
# generating output to stdout, or there's a target output file and
160
# the source file is newer than the target (or the target doesn't
162
if self.force or output_file is None or newer(source, output_file):
164
self.mkpath(os.path.dirname(output_file))
167
except DistutilsExecError as msg:
168
raise CompileError(msg)
170
def _compile(self, obj, src, ext, cc_args, extra_postargs, pp_opts):
171
compiler_so = self.compiler_so
172
if sys.platform == 'darwin':
173
compiler_so = _darwin_compiler_fixup(compiler_so, cc_args + extra_postargs)
175
self.spawn(compiler_so + cc_args + [src, '-o', obj] +
177
except DistutilsExecError as msg:
178
raise CompileError(msg)
180
def create_static_lib(self, objects, output_libname,
181
output_dir=None, debug=0, target_lang=None):
182
objects, output_dir = self._fix_object_args(objects, output_dir)
185
self.library_filename(output_libname, output_dir=output_dir)
187
if self._need_link(objects, output_filename):
188
self.mkpath(os.path.dirname(output_filename))
189
self.spawn(self.archiver +
191
objects + self.objects)
193
# Not many Unices required ranlib anymore -- SunOS 4.x is, I
194
# think the only major Unix that does. Maybe we need some
195
# platform intelligence here to skip ranlib if it's not
196
# needed -- or maybe Python's configure script took care of
197
# it for us, hence the check for leading colon.
200
self.spawn(self.ranlib + [output_filename])
201
except DistutilsExecError as msg:
204
log.debug("skipping %s (up-to-date)", output_filename)
206
def link(self, target_desc, objects,
207
output_filename, output_dir=None, libraries=None,
208
library_dirs=None, runtime_library_dirs=None,
209
export_symbols=None, debug=0, extra_preargs=None,
210
extra_postargs=None, build_temp=None, target_lang=None):
211
objects, output_dir = self._fix_object_args(objects, output_dir)
212
fixed_args = self._fix_lib_args(libraries, library_dirs,
213
runtime_library_dirs)
214
libraries, library_dirs, runtime_library_dirs = fixed_args
216
lib_opts = gen_lib_options(self, library_dirs, runtime_library_dirs,
218
if not isinstance(output_dir, (str, type(None))):
219
raise TypeError("'output_dir' must be a string or None")
220
if output_dir is not None:
221
output_filename = os.path.join(output_dir, output_filename)
223
if self._need_link(objects, output_filename):
224
ld_args = (objects + self.objects +
225
lib_opts + ['-o', output_filename])
229
ld_args[:0] = extra_preargs
231
ld_args.extend(extra_postargs)
232
self.mkpath(os.path.dirname(output_filename))
234
if target_desc == CCompiler.EXECUTABLE:
235
linker = self.linker_exe[:]
237
linker = self.linker_so[:]
238
if target_lang == "c++" and self.compiler_cxx:
239
# skip over environment variable settings if /usr/bin/env
240
# is used to set up the linker's environment.
241
# This is needed on OSX. Note: this assumes that the
242
# normal and C++ compiler have the same environment
245
if os.path.basename(linker[0]) == "env":
247
while '=' in linker[i]:
249
linker[i] = self.compiler_cxx[i]
251
if sys.platform == 'darwin':
252
linker = _darwin_compiler_fixup(linker, ld_args)
254
self.spawn(linker + ld_args)
255
except DistutilsExecError as msg:
258
log.debug("skipping %s (up-to-date)", output_filename)
260
# -- Miscellaneous methods -----------------------------------------
261
# These are all used by the 'gen_lib_options() function, in
264
def library_dir_option(self, dir):
267
def runtime_library_dir_option(self, dir):
268
# XXX Hackish, at the very least. See Python bug #445902:
269
# http://sourceforge.net/tracker/index.php
270
# ?func=detail&aid=445902&group_id=5470&atid=105470
271
# Linkers on different platforms need different options to
272
# specify that directories need to be added to the list of
273
# directories searched for dependencies when a dynamic library
274
# is sought. GCC has to be told to pass the -R option through
275
# to the linker, whereas other compilers just know this.
276
# Other compilers may need something slightly different. At
277
# this time, there's no way to determine this information from
278
# the configuration data stored in the Python installation, so
280
compiler = os.path.basename(sysconfig.get_config_var("CC"))
281
if sys.platform[:6] == "darwin":
282
# MacOSX's linker doesn't understand the -R flag at all
284
elif sys.platform[:5] == "hp-ux":
286
elif sys.platform[:7] == "irix646" or sys.platform[:6] == "osf1V5":
287
return ["-rpath", dir]
288
elif compiler[:3] == "gcc" or compiler[:3] == "g++":
289
return "-Wl,-R" + dir
293
def library_option(self, lib):
296
def find_library_file(self, dirs, lib, debug=0):
297
shared_f = self.library_filename(lib, lib_type='shared')
298
dylib_f = self.library_filename(lib, lib_type='dylib')
299
static_f = self.library_filename(lib, lib_type='static')
302
shared = os.path.join(dir, shared_f)
303
dylib = os.path.join(dir, dylib_f)
304
static = os.path.join(dir, static_f)
305
# We're second-guessing the linker here, with not much hard
306
# data to go on: GCC seems to prefer the shared library, so I'm
307
# assuming that *all* Unix C compilers do. And of course I'm
308
# ignoring even GCC's "-static" option. So sue me.
309
if os.path.exists(dylib):
311
elif os.path.exists(shared):
313
elif os.path.exists(static):
316
# Oops, didn't find it in *any* of 'dirs'
added
removed
Lib/distutils/unixccompiler.py
