blob: 56998c3507e9ff7cf0aecc5fde21b8ce323475da [file] [log] [blame]
Greg Ward170bdc01999-07-10 02:04:22 +00001"""distutils.unixccompiler
2
3Contains the UnixCCompiler class, a subclass of CCompiler that handles
4the "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:
11 compiles .c to .o
12 * link static library handled by 'ar' command (possibly with 'ranlib')
13 * link shared library handled by 'cc -shared'
14"""
15
Greg Ward3ce77fd2000-03-02 01:49:45 +000016__revision__ = "$Id$"
Greg Ward170bdc01999-07-10 02:04:22 +000017
Jeremy Hylton332a1462002-06-04 20:18:24 +000018import os, sys
Jeremy Hylton022640d2002-06-13 15:01:38 +000019from types import StringType, NoneType
Greg Ward8037cb11999-09-13 03:12:53 +000020from copy import copy
Jeremy Hylton022640d2002-06-13 15:01:38 +000021
Fred Draked15db5c2001-12-11 05:04:24 +000022from distutils import sysconfig
Greg Ward3ff3b032000-06-21 02:58:46 +000023from distutils.dep_util import newer
Greg Wardd1517112000-05-30 01:56:44 +000024from distutils.ccompiler import \
Greg Ward3add77f2000-05-30 02:02:49 +000025 CCompiler, gen_preprocess_options, gen_lib_options
26from distutils.errors import \
27 DistutilsExecError, CompileError, LibError, LinkError
Jeremy Hyltoncd8a1142002-06-04 20:14:43 +000028from distutils import log
Greg Ward170bdc01999-07-10 02:04:22 +000029
30# XXX Things not currently handled:
31# * optimization/debug/warning flags; we just use whatever's in Python's
32# Makefile and live with it. Is this adequate? If not, we might
33# have to have a bunch of subclasses GNUCCompiler, SGICCompiler,
34# SunCCompiler, and I suspect down that road lies madness.
35# * even if we don't know a warning flag from an optimization flag,
36# we need some way for outsiders to feed preprocessor/compiler/linker
37# flags in to us -- eg. a sysadmin might want to mandate certain flags
38# via a site config file, or a user might want to set something for
39# compiling this module distribution only via the setup.py command
40# line, whatever. As long as these options come from something on the
41# current system, they can be as system-dependent as they like, and we
42# should just happily stuff them into the preprocessor/compiler/linker
43# options and carry on.
44
Jeremy Hylton022640d2002-06-13 15:01:38 +000045class UnixCCompiler(CCompiler):
Greg Ward170bdc01999-07-10 02:04:22 +000046
Greg Ward0e3530b1999-09-29 12:22:50 +000047 compiler_type = 'unix'
48
Greg Ward73076ff2000-06-25 02:05:29 +000049 # These are used by CCompiler in two places: the constructor sets
50 # instance attributes 'preprocessor', 'compiler', etc. from them, and
51 # 'set_executable()' allows any of these to be set. The defaults here
52 # are pretty generic; they will probably have to be set by an outsider
53 # (eg. using information discovered by the sysconfig about building
54 # Python extensions).
55 executables = {'preprocessor' : None,
56 'compiler' : ["cc"],
57 'compiler_so' : ["cc"],
Gustavo Niemeyer6b016852002-11-05 16:12:02 +000058 'compiler_cxx' : ["cc"],
Greg Ward73076ff2000-06-25 02:05:29 +000059 'linker_so' : ["cc", "-shared"],
60 'linker_exe' : ["cc"],
61 'archiver' : ["ar", "-cr"],
62 'ranlib' : None,
63 }
64
Just van Rossum005dbb22002-02-11 15:31:50 +000065 if sys.platform[:6] == "darwin":
66 executables['ranlib'] = ["ranlib"]
67
Greg Ward73076ff2000-06-25 02:05:29 +000068 # Needed for the filename generation methods provided by the base
69 # class, CCompiler. NB. whoever instantiates/uses a particular
70 # UnixCCompiler instance should set 'shared_lib_ext' -- we set a
71 # reasonable common default here, but it's not necessarily used on all
72 # Unices!
73
Andrew M. Kuchling7880e5e2001-04-05 15:46:48 +000074 src_extensions = [".c",".C",".cc",".cxx",".cpp",".m"]
Greg Ward32c4a8a2000-03-06 03:40:29 +000075 obj_extension = ".o"
76 static_lib_extension = ".a"
Greg Ward73076ff2000-06-25 02:05:29 +000077 shared_lib_extension = ".so"
Jack Jansene259e592001-08-27 15:08:16 +000078 dylib_lib_extension = ".dylib"
79 static_lib_format = shared_lib_format = dylib_lib_format = "lib%s%s"
Jason Tishlerd7e83a12003-04-18 17:27:47 +000080 if sys.platform == "cygwin":
81 exe_extension = ".exe"
Greg Wardc9f31872000-01-09 22:47:53 +000082
Jeremy Hylton129b17d2002-06-13 15:14:10 +000083 def preprocess(self, source,
84 output_file=None, macros=None, include_dirs=None,
85 extra_preargs=None, extra_postargs=None):
86 ignore, macros, include_dirs = \
Greg Wardbe86bde2000-09-26 01:56:15 +000087 self._fix_compile_args(None, macros, include_dirs)
88 pp_opts = gen_preprocess_options(macros, include_dirs)
Greg Ward73076ff2000-06-25 02:05:29 +000089 pp_args = self.preprocessor + pp_opts
Greg Ward3ff3b032000-06-21 02:58:46 +000090 if output_file:
Greg Ward73076ff2000-06-25 02:05:29 +000091 pp_args.extend(['-o', output_file])
Greg Ward3ff3b032000-06-21 02:58:46 +000092 if extra_preargs:
Greg Ward73076ff2000-06-25 02:05:29 +000093 pp_args[:0] = extra_preargs
Greg Ward3ff3b032000-06-21 02:58:46 +000094 if extra_postargs:
Andrew M. Kuchling286b1072001-07-16 14:19:20 +000095 pp_args.extend(extra_postargs)
Andrew M. Kuchlingdf453fd2002-09-09 12:16:58 +000096 pp_args.append(source)
Greg Ward3ff3b032000-06-21 02:58:46 +000097
Andrew M. Kuchling286b1072001-07-16 14:19:20 +000098 # We need to preprocess: either we're being forced to, or we're
Fred Drakeb94b8492001-12-06 20:51:35 +000099 # generating output to stdout, or there's a target output file and
100 # the source file is newer than the target (or the target doesn't
Greg Ward3ff3b032000-06-21 02:58:46 +0000101 # exist).
Guido van Rossum63a47402001-07-16 14:46:13 +0000102 if self.force or output_file is None or newer(source, output_file):
Greg Ward3ff3b032000-06-21 02:58:46 +0000103 if output_file:
104 self.mkpath(os.path.dirname(output_file))
105 try:
Greg Wardbe86bde2000-09-26 01:56:15 +0000106 self.spawn(pp_args)
Greg Ward3ff3b032000-06-21 02:58:46 +0000107 except DistutilsExecError, msg:
108 raise CompileError, msg
109
Jeremy Hylton1b046e42002-06-18 18:48:55 +0000110 def _compile(self, obj, src, ext, cc_args, extra_postargs, pp_opts):
111 try:
112 self.spawn(self.compiler_so + cc_args + [src, '-o', obj] +
113 extra_postargs)
114 except DistutilsExecError, msg:
115 raise CompileError, msg
Greg Ward170bdc01999-07-10 02:04:22 +0000116
Jeremy Hylton129b17d2002-06-13 15:14:10 +0000117 def create_static_lib(self, objects, output_libname,
Gustavo Niemeyer6b016852002-11-05 16:12:02 +0000118 output_dir=None, debug=0, target_lang=None):
Jeremy Hylton129b17d2002-06-13 15:14:10 +0000119 objects, output_dir = self._fix_object_args(objects, output_dir)
Greg Wardc9f31872000-01-09 22:47:53 +0000120
Greg Ward32c4a8a2000-03-06 03:40:29 +0000121 output_filename = \
Greg Wardbe86bde2000-09-26 01:56:15 +0000122 self.library_filename(output_libname, output_dir=output_dir)
Greg Wardc9f31872000-01-09 22:47:53 +0000123
Greg Wardbe86bde2000-09-26 01:56:15 +0000124 if self._need_link(objects, output_filename):
125 self.mkpath(os.path.dirname(output_filename))
126 self.spawn(self.archiver +
127 [output_filename] +
128 objects + self.objects)
Greg Ward1c793302000-04-14 00:48:15 +0000129
Greg Ward8eef5832000-04-14 13:53:34 +0000130 # Not many Unices required ranlib anymore -- SunOS 4.x is, I
131 # think the only major Unix that does. Maybe we need some
132 # platform intelligence here to skip ranlib if it's not
133 # needed -- or maybe Python's configure script took care of
134 # it for us, hence the check for leading colon.
Greg Ward73076ff2000-06-25 02:05:29 +0000135 if self.ranlib:
Greg Wardd1517112000-05-30 01:56:44 +0000136 try:
Greg Wardbe86bde2000-09-26 01:56:15 +0000137 self.spawn(self.ranlib + [output_filename])
Greg Wardd1517112000-05-30 01:56:44 +0000138 except DistutilsExecError, msg:
139 raise LibError, msg
Greg Wardc9f31872000-01-09 22:47:53 +0000140 else:
Jeremy Hyltoncd8a1142002-06-04 20:14:43 +0000141 log.debug("skipping %s (up-to-date)", output_filename)
Greg Wardc9f31872000-01-09 22:47:53 +0000142
Jeremy Hylton129b17d2002-06-13 15:14:10 +0000143 def link(self, target_desc, objects,
144 output_filename, output_dir=None, libraries=None,
145 library_dirs=None, runtime_library_dirs=None,
146 export_symbols=None, debug=0, extra_preargs=None,
Gustavo Niemeyer6b016852002-11-05 16:12:02 +0000147 extra_postargs=None, build_temp=None, target_lang=None):
Jeremy Hylton129b17d2002-06-13 15:14:10 +0000148 objects, output_dir = self._fix_object_args(objects, output_dir)
149 libraries, library_dirs, runtime_library_dirs = \
Greg Wardbe86bde2000-09-26 01:56:15 +0000150 self._fix_lib_args(libraries, library_dirs, runtime_library_dirs)
Greg Ward04d78321999-12-12 16:57:47 +0000151
Jeremy Hylton129b17d2002-06-13 15:14:10 +0000152 lib_opts = gen_lib_options(self, library_dirs, runtime_library_dirs,
Greg Wardbe86bde2000-09-26 01:56:15 +0000153 libraries)
154 if type(output_dir) not in (StringType, NoneType):
Greg Ward10ca82b2000-02-10 02:51:32 +0000155 raise TypeError, "'output_dir' must be a string or None"
Greg Ward8037cb11999-09-13 03:12:53 +0000156 if output_dir is not None:
Greg Wardbe86bde2000-09-26 01:56:15 +0000157 output_filename = os.path.join(output_dir, output_filename)
Greg Ward170bdc01999-07-10 02:04:22 +0000158
Greg Wardbe86bde2000-09-26 01:56:15 +0000159 if self._need_link(objects, output_filename):
Fred Drakeb94b8492001-12-06 20:51:35 +0000160 ld_args = (objects + self.objects +
Greg Ward32c4a8a2000-03-06 03:40:29 +0000161 lib_opts + ['-o', output_filename])
Greg Wardba233fb2000-02-09 02:17:00 +0000162 if debug:
163 ld_args[:0] = ['-g']
Greg Ward0e3530b1999-09-29 12:22:50 +0000164 if extra_preargs:
165 ld_args[:0] = extra_preargs
166 if extra_postargs:
Greg Wardbe86bde2000-09-26 01:56:15 +0000167 ld_args.extend(extra_postargs)
168 self.mkpath(os.path.dirname(output_filename))
Greg Wardd1517112000-05-30 01:56:44 +0000169 try:
Fred Drakeb94b8492001-12-06 20:51:35 +0000170 if target_desc == CCompiler.EXECUTABLE:
Gustavo Niemeyer6b016852002-11-05 16:12:02 +0000171 linker = self.linker_exe[:]
Greg Ward42406482000-09-27 02:08:14 +0000172 else:
Gustavo Niemeyer6b016852002-11-05 16:12:02 +0000173 linker = self.linker_so[:]
174 if target_lang == "c++" and self.compiler_cxx:
175 linker[0] = self.compiler_cxx[0]
176 self.spawn(linker + ld_args)
Greg Wardd1517112000-05-30 01:56:44 +0000177 except DistutilsExecError, msg:
178 raise LinkError, msg
Greg Ward8037cb11999-09-13 03:12:53 +0000179 else:
Jeremy Hyltoncd8a1142002-06-04 20:14:43 +0000180 log.debug("skipping %s (up-to-date)", output_filename)
Greg Ward5e717441999-08-14 23:53:53 +0000181
Greg Ward32c4a8a2000-03-06 03:40:29 +0000182 # -- Miscellaneous methods -----------------------------------------
183 # These are all used by the 'gen_lib_options() function, in
184 # ccompiler.py.
Fred Drakeb94b8492001-12-06 20:51:35 +0000185
Jeremy Hylton28f46e12002-06-13 14:58:30 +0000186 def library_dir_option(self, dir):
Greg Ward4fecfce1999-10-03 20:45:33 +0000187 return "-L" + dir
188
Jeremy Hylton28f46e12002-06-13 14:58:30 +0000189 def runtime_library_dir_option(self, dir):
Fred Draked15db5c2001-12-11 05:04:24 +0000190 # XXX Hackish, at the very least. See Python bug #445902:
191 # http://sourceforge.net/tracker/index.php
192 # ?func=detail&aid=445902&group_id=5470&atid=105470
193 # Linkers on different platforms need different options to
194 # specify that directories need to be added to the list of
195 # directories searched for dependencies when a dynamic library
196 # is sought. GCC has to be told to pass the -R option through
197 # to the linker, whereas other compilers just know this.
198 # Other compilers may need something slightly different. At
199 # this time, there's no way to determine this information from
200 # the configuration data stored in the Python installation, so
201 # we use this hack.
202 compiler = os.path.basename(sysconfig.get_config_var("CC"))
Skip Montanaro628e3bf2002-10-09 21:37:18 +0000203 if sys.platform[:6] == "darwin":
204 # MacOSX's linker doesn't understand the -R flag at all
205 return "-L" + dir
Jack Jansen19c0d942003-06-01 19:27:40 +0000206 elif sys.platform[:5] == "hp-ux":
Martin v. Löwisb71bcb62003-05-31 08:09:21 +0000207 return "+s -L" + dir
Martin v. Löwis061f1322004-08-29 16:40:55 +0000208 elif sys.platform[:7] == "irix646" or sys.platform[:6] == "osf1V5":
209 return ["-rpath", dir]
Jack Jansen19c0d942003-06-01 19:27:40 +0000210 elif compiler[:3] == "gcc" or compiler[:3] == "g++":
Tim Peters182b5ac2004-07-18 06:16:08 +0000211 return "-Wl,-R" + dir
Fred Draked15db5c2001-12-11 05:04:24 +0000212 else:
213 return "-R" + dir
Greg Wardd03f88a2000-03-18 15:19:51 +0000214
Jeremy Hylton28f46e12002-06-13 14:58:30 +0000215 def library_option(self, lib):
Greg Ward4fecfce1999-10-03 20:45:33 +0000216 return "-l" + lib
217
Jeremy Hylton28f46e12002-06-13 14:58:30 +0000218 def find_library_file(self, dirs, lib, debug=0):
Jeremy Hylton129b17d2002-06-13 15:14:10 +0000219 shared_f = self.library_filename(lib, lib_type='shared')
220 dylib_f = self.library_filename(lib, lib_type='dylib')
221 static_f = self.library_filename(lib, lib_type='static')
Tim Peters182b5ac2004-07-18 06:16:08 +0000222
Greg Ward4fecfce1999-10-03 20:45:33 +0000223 for dir in dirs:
Jeremy Hylton129b17d2002-06-13 15:14:10 +0000224 shared = os.path.join(dir, shared_f)
225 dylib = os.path.join(dir, dylib_f)
226 static = os.path.join(dir, static_f)
Greg Ward4fecfce1999-10-03 20:45:33 +0000227 # We're second-guessing the linker here, with not much hard
228 # data to go on: GCC seems to prefer the shared library, so I'm
229 # assuming that *all* Unix C compilers do. And of course I'm
230 # ignoring even GCC's "-static" option. So sue me.
Jack Jansene259e592001-08-27 15:08:16 +0000231 if os.path.exists(dylib):
232 return dylib
233 elif os.path.exists(shared):
Greg Ward4fecfce1999-10-03 20:45:33 +0000234 return shared
Greg Wardbe86bde2000-09-26 01:56:15 +0000235 elif os.path.exists(static):
Greg Ward4fecfce1999-10-03 20:45:33 +0000236 return static
Tim Peters182b5ac2004-07-18 06:16:08 +0000237
Jeremy Hylton129b17d2002-06-13 15:14:10 +0000238 # Oops, didn't find it in *any* of 'dirs'
239 return None