Python code coverage for Lib/packaging/compiler/unixccompiler.py

#	count	content
1	n/a	"""CCompiler implementation for Unix compilers.
2	n/a
3	n/a	This module contains the UnixCCompiler class, a subclass of CCompiler
4	n/a	that handles the "typical" Unix-style command-line C compiler:
5	n/a	* macros defined with -Dname[=value]
6	n/a	* macros undefined with -Uname
7	n/a	* include search directories specified with -Idir
8	n/a	* libraries specified with -lllib
9	n/a	* library search directories specified with -Ldir
10	n/a	* compile handled by 'cc' (or similar) executable with -c option:
11	n/a	compiles .c to .o
12	n/a	* link static library handled by 'ar' command (possibly with 'ranlib')
13	n/a	* link shared library handled by 'cc -shared'
14	n/a	"""
15	n/a
16	n/a	import os, sys
17	n/a
18	n/a	from packaging.util import newer
19	n/a	from packaging.compiler.ccompiler import CCompiler
20	n/a	from packaging.compiler import gen_preprocess_options, gen_lib_options
21	n/a	from packaging.errors import (PackagingExecError, CompileError,
22	n/a	LibError, LinkError)
23	n/a	from packaging import logger
24	n/a	import sysconfig
25	n/a
26	n/a
27	n/a	# XXX Things not currently handled:
28	n/a	# * optimization/debug/warning flags; we just use whatever's in Python's
29	n/a	# Makefile and live with it. Is this adequate? If not, we might
30	n/a	# have to have a bunch of subclasses GNUCCompiler, SGICCompiler,
31	n/a	# SunCCompiler, and I suspect down that road lies madness.
32	n/a	# * even if we don't know a warning flag from an optimization flag,
33	n/a	# we need some way for outsiders to feed preprocessor/compiler/linker
34	n/a	# flags in to us -- eg. a sysadmin might want to mandate certain flags
35	n/a	# via a site config file, or a user might want to set something for
36	n/a	# compiling this module distribution only via the pysetup command
37	n/a	# line, whatever. As long as these options come from something on the
38	n/a	# current system, they can be as system-dependent as they like, and we
39	n/a	# should just happily stuff them into the preprocessor/compiler/linker
40	n/a	# options and carry on.
41	n/a
42	n/a	def _darwin_compiler_fixup(compiler_so, cc_args):
43	n/a	"""
44	n/a	This function will strip '-isysroot PATH' and '-arch ARCH' from the
45	n/a	compile flags if the user has specified one them in extra_compile_flags.
46	n/a
47	n/a	This is needed because '-arch ARCH' adds another architecture to the
48	n/a	build, without a way to remove an architecture. Furthermore GCC will
49	n/a	barf if multiple '-isysroot' arguments are present.
50	n/a	"""
51	n/a	stripArch = stripSysroot = False
52	n/a
53	n/a	compiler_so = list(compiler_so)
54	n/a	kernel_version = os.uname()[2] # 8.4.3
55	n/a	major_version = int(kernel_version.split('.')[0])
56	n/a
57	n/a	if major_version < 8:
58	n/a	# OSX before 10.4.0, these don't support -arch and -isysroot at
59	n/a	# all.
60	n/a	stripArch = stripSysroot = True
61	n/a	else:
62	n/a	stripArch = '-arch' in cc_args
63	n/a	stripSysroot = '-isysroot' in cc_args
64	n/a
65	n/a	if stripArch or 'ARCHFLAGS' in os.environ:
66	n/a	while True:
67	n/a	try:
68	n/a	index = compiler_so.index('-arch')
69	n/a	# Strip this argument and the next one:
70	n/a	del compiler_so[index:index+2]
71	n/a	except ValueError:
72	n/a	break
73	n/a
74	n/a	if 'ARCHFLAGS' in os.environ and not stripArch:
75	n/a	# User specified different -arch flags in the environ,
76	n/a	# see also the sysconfig
77	n/a	compiler_so = compiler_so + os.environ['ARCHFLAGS'].split()
78	n/a
79	n/a	if stripSysroot:
80	n/a	try:
81	n/a	index = compiler_so.index('-isysroot')
82	n/a	# Strip this argument and the next one:
83	n/a	del compiler_so[index:index+2]
84	n/a	except ValueError:
85	n/a	pass
86	n/a
87	n/a	# Check if the SDK that is used during compilation actually exists,
88	n/a	# the universal build requires the usage of a universal SDK and not all
89	n/a	# users have that installed by default.
90	n/a	sysroot = None
91	n/a	if '-isysroot' in cc_args:
92	n/a	idx = cc_args.index('-isysroot')
93	n/a	sysroot = cc_args[idx+1]
94	n/a	elif '-isysroot' in compiler_so:
95	n/a	idx = compiler_so.index('-isysroot')
96	n/a	sysroot = compiler_so[idx+1]
97	n/a
98	n/a	if sysroot and not os.path.isdir(sysroot):
99	n/a	logger.warning(
100	n/a	"compiling with an SDK that doesn't seem to exist: %r;\n"
101	n/a	"please check your Xcode installation", sysroot)
102	n/a
103	n/a	return compiler_so
104	n/a
105	n/a	class UnixCCompiler(CCompiler):
106	n/a
107	n/a	name = 'unix'
108	n/a	description = 'Standard UNIX-style compiler'
109	n/a
110	n/a	# These are used by CCompiler in two places: the constructor sets
111	n/a	# instance attributes 'preprocessor', 'compiler', etc. from them, and
112	n/a	# 'set_executable()' allows any of these to be set. The defaults here
113	n/a	# are pretty generic; they will probably have to be set by an outsider
114	n/a	# (eg. using information discovered by the sysconfig about building
115	n/a	# Python extensions).
116	n/a	executables = {'preprocessor' : None,
117	n/a	'compiler' : ["cc"],
118	n/a	'compiler_so' : ["cc"],
119	n/a	'compiler_cxx' : ["cc"],
120	n/a	'linker_so' : ["cc", "-shared"],
121	n/a	'linker_exe' : ["cc"],
122	n/a	'archiver' : ["ar", "-cr"],
123	n/a	'ranlib' : None,
124	n/a	}
125	n/a
126	n/a	if sys.platform[:6] == "darwin":
127	n/a	executables['ranlib'] = ["ranlib"]
128	n/a
129	n/a	# Needed for the filename generation methods provided by the base
130	n/a	# class, CCompiler. XXX whoever instantiates/uses a particular
131	n/a	# UnixCCompiler instance should set 'shared_lib_ext' -- we set a
132	n/a	# reasonable common default here, but it's not necessarily used on all
133	n/a	# Unices!
134	n/a
135	n/a	src_extensions = [".c",".C",".cc",".cxx",".cpp",".m"]
136	n/a	obj_extension = ".o"
137	n/a	static_lib_extension = ".a"
138	n/a	shared_lib_extension = ".so"
139	n/a	dylib_lib_extension = ".dylib"
140	n/a	static_lib_format = shared_lib_format = dylib_lib_format = "lib%s%s"
141	n/a	if sys.platform == "cygwin":
142	n/a	exe_extension = ".exe"
143	n/a
144	n/a	def preprocess(self, source,
145	n/a	output_file=None, macros=None, include_dirs=None,
146	n/a	extra_preargs=None, extra_postargs=None):
147	n/a	ignore, macros, include_dirs = \
148	n/a	self._fix_compile_args(None, macros, include_dirs)
149	n/a	pp_opts = gen_preprocess_options(macros, include_dirs)
150	n/a	pp_args = self.preprocessor + pp_opts
151	n/a	if output_file:
152	n/a	pp_args.extend(('-o', output_file))
153	n/a	if extra_preargs:
154	n/a	pp_args[:0] = extra_preargs
155	n/a	if extra_postargs:
156	n/a	pp_args.extend(extra_postargs)
157	n/a	pp_args.append(source)
158	n/a
159	n/a	# We need to preprocess: either we're being forced to, or we're
160	n/a	# generating output to stdout, or there's a target output file and
161	n/a	# the source file is newer than the target (or the target doesn't
162	n/a	# exist).
163	n/a	if self.force or output_file is None or newer(source, output_file):
164	n/a	if output_file:
165	n/a	self.mkpath(os.path.dirname(output_file))
166	n/a	try:
167	n/a	self.spawn(pp_args)
168	n/a	except PackagingExecError as msg:
169	n/a	raise CompileError(msg)
170	n/a
171	n/a	def _compile(self, obj, src, ext, cc_args, extra_postargs, pp_opts):
172	n/a	compiler_so = self.compiler_so
173	n/a	if sys.platform == 'darwin':
174	n/a	compiler_so = _darwin_compiler_fixup(compiler_so, cc_args + extra_postargs)
175	n/a	try:
176	n/a	self.spawn(compiler_so + cc_args + [src, '-o', obj] +
177	n/a	extra_postargs)
178	n/a	except PackagingExecError as msg:
179	n/a	raise CompileError(msg)
180	n/a
181	n/a	def create_static_lib(self, objects, output_libname,
182	n/a	output_dir=None, debug=False, target_lang=None):
183	n/a	objects, output_dir = self._fix_object_args(objects, output_dir)
184	n/a
185	n/a	output_filename = \
186	n/a	self.library_filename(output_libname, output_dir=output_dir)
187	n/a
188	n/a	if self._need_link(objects, output_filename):
189	n/a	self.mkpath(os.path.dirname(output_filename))
190	n/a	self.spawn(self.archiver +
191	n/a	[output_filename] +
192	n/a	objects + self.objects)
193	n/a
194	n/a	# Not many Unices required ranlib anymore -- SunOS 4.x is, I
195	n/a	# think the only major Unix that does. Maybe we need some
196	n/a	# platform intelligence here to skip ranlib if it's not
197	n/a	# needed -- or maybe Python's configure script took care of
198	n/a	# it for us, hence the check for leading colon.
199	n/a	if self.ranlib:
200	n/a	try:
201	n/a	self.spawn(self.ranlib + [output_filename])
202	n/a	except PackagingExecError as msg:
203	n/a	raise LibError(msg)
204	n/a	else:
205	n/a	logger.debug("skipping %s (up-to-date)", output_filename)
206	n/a
207	n/a	def link(self, target_desc, objects,
208	n/a	output_filename, output_dir=None, libraries=None,
209	n/a	library_dirs=None, runtime_library_dirs=None,
210	n/a	export_symbols=None, debug=False, extra_preargs=None,
211	n/a	extra_postargs=None, build_temp=None, target_lang=None):
212	n/a	objects, output_dir = self._fix_object_args(objects, output_dir)
213	n/a	libraries, library_dirs, runtime_library_dirs = \
214	n/a	self._fix_lib_args(libraries, library_dirs, runtime_library_dirs)
215	n/a
216	n/a	lib_opts = gen_lib_options(self, library_dirs, runtime_library_dirs,
217	n/a	libraries)
218	n/a	if type(output_dir) not in (str, type(None)):
219	n/a	raise TypeError("'output_dir' must be a string or None")
220	n/a	if output_dir is not None:
221	n/a	output_filename = os.path.join(output_dir, output_filename)
222	n/a
223	n/a	if self._need_link(objects, output_filename):
224	n/a	ld_args = (objects + self.objects +
225	n/a	lib_opts + ['-o', output_filename])
226	n/a	if debug:
227	n/a	ld_args[:0] = ['-g']
228	n/a	if extra_preargs:
229	n/a	ld_args[:0] = extra_preargs
230	n/a	if extra_postargs:
231	n/a	ld_args.extend(extra_postargs)
232	n/a	self.mkpath(os.path.dirname(output_filename))
233	n/a	try:
234	n/a	if target_desc == CCompiler.EXECUTABLE:
235	n/a	linker = self.linker_exe[:]
236	n/a	else:
237	n/a	linker = self.linker_so[:]
238	n/a	if target_lang == "c++" and self.compiler_cxx:
239	n/a	# skip over environment variable settings if /usr/bin/env
240	n/a	# is used to set up the linker's environment.
241	n/a	# This is needed on OSX. Note: this assumes that the
242	n/a	# normal and C++ compiler have the same environment
243	n/a	# settings.
244	n/a	i = 0
245	n/a	if os.path.basename(linker[0]) == "env":
246	n/a	i = 1
247	n/a	while '=' in linker[i]:
248	n/a	i = i + 1
249	n/a
250	n/a	linker[i] = self.compiler_cxx[i]
251	n/a
252	n/a	if sys.platform == 'darwin':
253	n/a	linker = _darwin_compiler_fixup(linker, ld_args)
254	n/a
255	n/a	self.spawn(linker + ld_args)
256	n/a	except PackagingExecError as msg:
257	n/a	raise LinkError(msg)
258	n/a	else:
259	n/a	logger.debug("skipping %s (up-to-date)", output_filename)
260	n/a
261	n/a	# -- Miscellaneous methods -----------------------------------------
262	n/a	# These are all used by the 'gen_lib_options() function, in
263	n/a	# ccompiler.py.
264	n/a
265	n/a	def library_dir_option(self, dir):
266	n/a	return "-L" + dir
267	n/a
268	n/a	def _is_gcc(self, compiler_name):
269	n/a	return "gcc" in compiler_name or "g++" in compiler_name
270	n/a
271	n/a	def runtime_library_dir_option(self, dir):
272	n/a	# XXX Hackish, at the very least. See Python bug #445902:
273	n/a	# http://sourceforge.net/tracker/index.php
274	n/a	# ?func=detail&aid=445902&group_id=5470&atid=105470
275	n/a	# Linkers on different platforms need different options to
276	n/a	# specify that directories need to be added to the list of
277	n/a	# directories searched for dependencies when a dynamic library
278	n/a	# is sought. GCC on GNU systems (Linux, FreeBSD, ...) has to
279	n/a	# be told to pass the -R option through to the linker, whereas
280	n/a	# other compilers and gcc on other systems just know this.
281	n/a	# Other compilers may need something slightly different. At
282	n/a	# this time, there's no way to determine this information from
283	n/a	# the configuration data stored in the Python installation, so
284	n/a	# we use this hack.
285	n/a
286	n/a	compiler = os.path.basename(sysconfig.get_config_var("CC"))
287	n/a	if sys.platform[:6] == "darwin":
288	n/a	# MacOSX's linker doesn't understand the -R flag at all
289	n/a	return "-L" + dir
290	n/a	elif sys.platform[:5] == "hp-ux":
291	n/a	if self._is_gcc(compiler):
292	n/a	return ["-Wl,+s", "-L" + dir]
293	n/a	return ["+s", "-L" + dir]
294	n/a	elif sys.platform[:7] == "irix646" or sys.platform[:6] == "osf1V5":
295	n/a	return ["-rpath", dir]
296	n/a	elif self._is_gcc(compiler):
297	n/a	# gcc on non-GNU systems does not need -Wl, but can
298	n/a	# use it anyway. Since distutils has always passed in
299	n/a	# -Wl whenever gcc was used in the past it is probably
300	n/a	# safest to keep doing so.
301	n/a	if sysconfig.get_config_var("GNULD") == "yes":
302	n/a	# GNU ld needs an extra option to get a RUNPATH
303	n/a	# instead of just an RPATH.
304	n/a	return "-Wl,--enable-new-dtags,-R" + dir
305	n/a	else:
306	n/a	return "-Wl,-R" + dir
307	n/a	elif sys.platform[:3] == "aix":
308	n/a	return "-blibpath:" + dir
309	n/a	else:
310	n/a	# No idea how --enable-new-dtags would be passed on to
311	n/a	# ld if this system was using GNU ld. Don't know if a
312	n/a	# system like this even exists.
313	n/a	return "-R" + dir
314	n/a
315	n/a	def library_option(self, lib):
316	n/a	return "-l" + lib
317	n/a
318	n/a	def find_library_file(self, dirs, lib, debug=False):
319	n/a	shared_f = self.library_filename(lib, lib_type='shared')
320	n/a	dylib_f = self.library_filename(lib, lib_type='dylib')
321	n/a	static_f = self.library_filename(lib, lib_type='static')
322	n/a
323	n/a	for dir in dirs:
324	n/a	shared = os.path.join(dir, shared_f)
325	n/a	dylib = os.path.join(dir, dylib_f)
326	n/a	static = os.path.join(dir, static_f)
327	n/a	# We're second-guessing the linker here, with not much hard
328	n/a	# data to go on: GCC seems to prefer the shared library, so I'm
329	n/a	# assuming that all Unix C compilers do. And of course I'm
330	n/a	# ignoring even GCC's "-static" option. So sue me.
331	n/a	if os.path.exists(dylib):
332	n/a	return dylib
333	n/a	elif os.path.exists(shared):
334	n/a	return shared
335	n/a	elif os.path.exists(static):
336	n/a	return static
337	n/a
338	n/a	# Oops, didn't find it in any of 'dirs'
339	n/a	return None