Greg Ward | 170bdc0 | 1999-07-10 02:04:22 +0000 | [diff] [blame] | 1 | """distutils.unixccompiler |
| 2 | |
| 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: |
| 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 Ward | 3ce77fd | 2000-03-02 01:49:45 +0000 | [diff] [blame] | 16 | __revision__ = "$Id$" |
Greg Ward | 170bdc0 | 1999-07-10 02:04:22 +0000 | [diff] [blame] | 17 | |
Jeremy Hylton | 332a146 | 2002-06-04 20:18:24 +0000 | [diff] [blame] | 18 | import os, sys |
Jeremy Hylton | 022640d | 2002-06-13 15:01:38 +0000 | [diff] [blame] | 19 | from types import StringType, NoneType |
Greg Ward | 8037cb1 | 1999-09-13 03:12:53 +0000 | [diff] [blame] | 20 | from copy import copy |
Jeremy Hylton | 022640d | 2002-06-13 15:01:38 +0000 | [diff] [blame] | 21 | |
Fred Drake | d15db5c | 2001-12-11 05:04:24 +0000 | [diff] [blame] | 22 | from distutils import sysconfig |
Greg Ward | 3ff3b03 | 2000-06-21 02:58:46 +0000 | [diff] [blame] | 23 | from distutils.dep_util import newer |
Greg Ward | d151711 | 2000-05-30 01:56:44 +0000 | [diff] [blame] | 24 | from distutils.ccompiler import \ |
Greg Ward | 3add77f | 2000-05-30 02:02:49 +0000 | [diff] [blame] | 25 | CCompiler, gen_preprocess_options, gen_lib_options |
| 26 | from distutils.errors import \ |
| 27 | DistutilsExecError, CompileError, LibError, LinkError |
Jeremy Hylton | cd8a114 | 2002-06-04 20:14:43 +0000 | [diff] [blame] | 28 | from distutils import log |
Greg Ward | 170bdc0 | 1999-07-10 02:04:22 +0000 | [diff] [blame] | 29 | |
| 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 Hylton | 022640d | 2002-06-13 15:01:38 +0000 | [diff] [blame] | 45 | class UnixCCompiler(CCompiler): |
Greg Ward | 170bdc0 | 1999-07-10 02:04:22 +0000 | [diff] [blame] | 46 | |
Greg Ward | 0e3530b | 1999-09-29 12:22:50 +0000 | [diff] [blame] | 47 | compiler_type = 'unix' |
| 48 | |
Greg Ward | 73076ff | 2000-06-25 02:05:29 +0000 | [diff] [blame] | 49 | # 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 Niemeyer | 6b01685 | 2002-11-05 16:12:02 +0000 | [diff] [blame] | 58 | 'compiler_cxx' : ["cc"], |
Greg Ward | 73076ff | 2000-06-25 02:05:29 +0000 | [diff] [blame] | 59 | 'linker_so' : ["cc", "-shared"], |
| 60 | 'linker_exe' : ["cc"], |
| 61 | 'archiver' : ["ar", "-cr"], |
| 62 | 'ranlib' : None, |
| 63 | } |
| 64 | |
Just van Rossum | 005dbb2 | 2002-02-11 15:31:50 +0000 | [diff] [blame] | 65 | if sys.platform[:6] == "darwin": |
| 66 | executables['ranlib'] = ["ranlib"] |
| 67 | |
Greg Ward | 73076ff | 2000-06-25 02:05:29 +0000 | [diff] [blame] | 68 | # 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. Kuchling | 7880e5e | 2001-04-05 15:46:48 +0000 | [diff] [blame] | 74 | src_extensions = [".c",".C",".cc",".cxx",".cpp",".m"] |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame] | 75 | obj_extension = ".o" |
| 76 | static_lib_extension = ".a" |
Greg Ward | 73076ff | 2000-06-25 02:05:29 +0000 | [diff] [blame] | 77 | shared_lib_extension = ".so" |
Jack Jansen | e259e59 | 2001-08-27 15:08:16 +0000 | [diff] [blame] | 78 | dylib_lib_extension = ".dylib" |
| 79 | static_lib_format = shared_lib_format = dylib_lib_format = "lib%s%s" |
Jason Tishler | d7e83a1 | 2003-04-18 17:27:47 +0000 | [diff] [blame] | 80 | if sys.platform == "cygwin": |
| 81 | exe_extension = ".exe" |
Greg Ward | c9f3187 | 2000-01-09 22:47:53 +0000 | [diff] [blame] | 82 | |
Jeremy Hylton | 129b17d | 2002-06-13 15:14:10 +0000 | [diff] [blame] | 83 | 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 Ward | be86bde | 2000-09-26 01:56:15 +0000 | [diff] [blame] | 87 | self._fix_compile_args(None, macros, include_dirs) |
| 88 | pp_opts = gen_preprocess_options(macros, include_dirs) |
Greg Ward | 73076ff | 2000-06-25 02:05:29 +0000 | [diff] [blame] | 89 | pp_args = self.preprocessor + pp_opts |
Greg Ward | 3ff3b03 | 2000-06-21 02:58:46 +0000 | [diff] [blame] | 90 | if output_file: |
Greg Ward | 73076ff | 2000-06-25 02:05:29 +0000 | [diff] [blame] | 91 | pp_args.extend(['-o', output_file]) |
Greg Ward | 3ff3b03 | 2000-06-21 02:58:46 +0000 | [diff] [blame] | 92 | if extra_preargs: |
Greg Ward | 73076ff | 2000-06-25 02:05:29 +0000 | [diff] [blame] | 93 | pp_args[:0] = extra_preargs |
Greg Ward | 3ff3b03 | 2000-06-21 02:58:46 +0000 | [diff] [blame] | 94 | if extra_postargs: |
Andrew M. Kuchling | 286b107 | 2001-07-16 14:19:20 +0000 | [diff] [blame] | 95 | pp_args.extend(extra_postargs) |
Andrew M. Kuchling | df453fd | 2002-09-09 12:16:58 +0000 | [diff] [blame] | 96 | pp_args.append(source) |
Greg Ward | 3ff3b03 | 2000-06-21 02:58:46 +0000 | [diff] [blame] | 97 | |
Andrew M. Kuchling | 286b107 | 2001-07-16 14:19:20 +0000 | [diff] [blame] | 98 | # We need to preprocess: either we're being forced to, or we're |
Fred Drake | b94b849 | 2001-12-06 20:51:35 +0000 | [diff] [blame] | 99 | # 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 Ward | 3ff3b03 | 2000-06-21 02:58:46 +0000 | [diff] [blame] | 101 | # exist). |
Guido van Rossum | 63a4740 | 2001-07-16 14:46:13 +0000 | [diff] [blame] | 102 | if self.force or output_file is None or newer(source, output_file): |
Greg Ward | 3ff3b03 | 2000-06-21 02:58:46 +0000 | [diff] [blame] | 103 | if output_file: |
| 104 | self.mkpath(os.path.dirname(output_file)) |
| 105 | try: |
Greg Ward | be86bde | 2000-09-26 01:56:15 +0000 | [diff] [blame] | 106 | self.spawn(pp_args) |
Greg Ward | 3ff3b03 | 2000-06-21 02:58:46 +0000 | [diff] [blame] | 107 | except DistutilsExecError, msg: |
| 108 | raise CompileError, msg |
| 109 | |
Jeremy Hylton | 1b046e4 | 2002-06-18 18:48:55 +0000 | [diff] [blame] | 110 | 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 Ward | 170bdc0 | 1999-07-10 02:04:22 +0000 | [diff] [blame] | 116 | |
Jeremy Hylton | 129b17d | 2002-06-13 15:14:10 +0000 | [diff] [blame] | 117 | def create_static_lib(self, objects, output_libname, |
Gustavo Niemeyer | 6b01685 | 2002-11-05 16:12:02 +0000 | [diff] [blame] | 118 | output_dir=None, debug=0, target_lang=None): |
Jeremy Hylton | 129b17d | 2002-06-13 15:14:10 +0000 | [diff] [blame] | 119 | objects, output_dir = self._fix_object_args(objects, output_dir) |
Greg Ward | c9f3187 | 2000-01-09 22:47:53 +0000 | [diff] [blame] | 120 | |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame] | 121 | output_filename = \ |
Greg Ward | be86bde | 2000-09-26 01:56:15 +0000 | [diff] [blame] | 122 | self.library_filename(output_libname, output_dir=output_dir) |
Greg Ward | c9f3187 | 2000-01-09 22:47:53 +0000 | [diff] [blame] | 123 | |
Greg Ward | be86bde | 2000-09-26 01:56:15 +0000 | [diff] [blame] | 124 | 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 Ward | 1c79330 | 2000-04-14 00:48:15 +0000 | [diff] [blame] | 129 | |
Greg Ward | 8eef583 | 2000-04-14 13:53:34 +0000 | [diff] [blame] | 130 | # 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 Ward | 73076ff | 2000-06-25 02:05:29 +0000 | [diff] [blame] | 135 | if self.ranlib: |
Greg Ward | d151711 | 2000-05-30 01:56:44 +0000 | [diff] [blame] | 136 | try: |
Greg Ward | be86bde | 2000-09-26 01:56:15 +0000 | [diff] [blame] | 137 | self.spawn(self.ranlib + [output_filename]) |
Greg Ward | d151711 | 2000-05-30 01:56:44 +0000 | [diff] [blame] | 138 | except DistutilsExecError, msg: |
| 139 | raise LibError, msg |
Greg Ward | c9f3187 | 2000-01-09 22:47:53 +0000 | [diff] [blame] | 140 | else: |
Jeremy Hylton | cd8a114 | 2002-06-04 20:14:43 +0000 | [diff] [blame] | 141 | log.debug("skipping %s (up-to-date)", output_filename) |
Greg Ward | c9f3187 | 2000-01-09 22:47:53 +0000 | [diff] [blame] | 142 | |
Jeremy Hylton | 129b17d | 2002-06-13 15:14:10 +0000 | [diff] [blame] | 143 | 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 Niemeyer | 6b01685 | 2002-11-05 16:12:02 +0000 | [diff] [blame] | 147 | extra_postargs=None, build_temp=None, target_lang=None): |
Jeremy Hylton | 129b17d | 2002-06-13 15:14:10 +0000 | [diff] [blame] | 148 | objects, output_dir = self._fix_object_args(objects, output_dir) |
| 149 | libraries, library_dirs, runtime_library_dirs = \ |
Greg Ward | be86bde | 2000-09-26 01:56:15 +0000 | [diff] [blame] | 150 | self._fix_lib_args(libraries, library_dirs, runtime_library_dirs) |
Greg Ward | 04d7832 | 1999-12-12 16:57:47 +0000 | [diff] [blame] | 151 | |
Jeremy Hylton | 129b17d | 2002-06-13 15:14:10 +0000 | [diff] [blame] | 152 | lib_opts = gen_lib_options(self, library_dirs, runtime_library_dirs, |
Greg Ward | be86bde | 2000-09-26 01:56:15 +0000 | [diff] [blame] | 153 | libraries) |
| 154 | if type(output_dir) not in (StringType, NoneType): |
Greg Ward | 10ca82b | 2000-02-10 02:51:32 +0000 | [diff] [blame] | 155 | raise TypeError, "'output_dir' must be a string or None" |
Greg Ward | 8037cb1 | 1999-09-13 03:12:53 +0000 | [diff] [blame] | 156 | if output_dir is not None: |
Greg Ward | be86bde | 2000-09-26 01:56:15 +0000 | [diff] [blame] | 157 | output_filename = os.path.join(output_dir, output_filename) |
Greg Ward | 170bdc0 | 1999-07-10 02:04:22 +0000 | [diff] [blame] | 158 | |
Greg Ward | be86bde | 2000-09-26 01:56:15 +0000 | [diff] [blame] | 159 | if self._need_link(objects, output_filename): |
Fred Drake | b94b849 | 2001-12-06 20:51:35 +0000 | [diff] [blame] | 160 | ld_args = (objects + self.objects + |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame] | 161 | lib_opts + ['-o', output_filename]) |
Greg Ward | ba233fb | 2000-02-09 02:17:00 +0000 | [diff] [blame] | 162 | if debug: |
| 163 | ld_args[:0] = ['-g'] |
Greg Ward | 0e3530b | 1999-09-29 12:22:50 +0000 | [diff] [blame] | 164 | if extra_preargs: |
| 165 | ld_args[:0] = extra_preargs |
| 166 | if extra_postargs: |
Greg Ward | be86bde | 2000-09-26 01:56:15 +0000 | [diff] [blame] | 167 | ld_args.extend(extra_postargs) |
| 168 | self.mkpath(os.path.dirname(output_filename)) |
Greg Ward | d151711 | 2000-05-30 01:56:44 +0000 | [diff] [blame] | 169 | try: |
Fred Drake | b94b849 | 2001-12-06 20:51:35 +0000 | [diff] [blame] | 170 | if target_desc == CCompiler.EXECUTABLE: |
Gustavo Niemeyer | 6b01685 | 2002-11-05 16:12:02 +0000 | [diff] [blame] | 171 | linker = self.linker_exe[:] |
Greg Ward | 4240648 | 2000-09-27 02:08:14 +0000 | [diff] [blame] | 172 | else: |
Gustavo Niemeyer | 6b01685 | 2002-11-05 16:12:02 +0000 | [diff] [blame] | 173 | 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 Ward | d151711 | 2000-05-30 01:56:44 +0000 | [diff] [blame] | 177 | except DistutilsExecError, msg: |
| 178 | raise LinkError, msg |
Greg Ward | 8037cb1 | 1999-09-13 03:12:53 +0000 | [diff] [blame] | 179 | else: |
Jeremy Hylton | cd8a114 | 2002-06-04 20:14:43 +0000 | [diff] [blame] | 180 | log.debug("skipping %s (up-to-date)", output_filename) |
Greg Ward | 5e71744 | 1999-08-14 23:53:53 +0000 | [diff] [blame] | 181 | |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame] | 182 | # -- Miscellaneous methods ----------------------------------------- |
| 183 | # These are all used by the 'gen_lib_options() function, in |
| 184 | # ccompiler.py. |
Fred Drake | b94b849 | 2001-12-06 20:51:35 +0000 | [diff] [blame] | 185 | |
Jeremy Hylton | 28f46e1 | 2002-06-13 14:58:30 +0000 | [diff] [blame] | 186 | def library_dir_option(self, dir): |
Greg Ward | 4fecfce | 1999-10-03 20:45:33 +0000 | [diff] [blame] | 187 | return "-L" + dir |
| 188 | |
Jeremy Hylton | 28f46e1 | 2002-06-13 14:58:30 +0000 | [diff] [blame] | 189 | def runtime_library_dir_option(self, dir): |
Fred Drake | d15db5c | 2001-12-11 05:04:24 +0000 | [diff] [blame] | 190 | # 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 Montanaro | 628e3bf | 2002-10-09 21:37:18 +0000 | [diff] [blame] | 203 | if sys.platform[:6] == "darwin": |
| 204 | # MacOSX's linker doesn't understand the -R flag at all |
| 205 | return "-L" + dir |
Martin v. Löwis | b71bcb6 | 2003-05-31 08:09:21 +0000 | [diff] [blame] | 206 | elif sys.platform[:5] == "hp-ux": |
| 207 | return "+s -L" + dir |
| 208 | elif compiler[:3] == "gcc" or compiler[:3] == "g++": |
| 209 | return "-Wl,-R" + dir |
Fred Drake | d15db5c | 2001-12-11 05:04:24 +0000 | [diff] [blame] | 210 | else: |
| 211 | return "-R" + dir |
Greg Ward | d03f88a | 2000-03-18 15:19:51 +0000 | [diff] [blame] | 212 | |
Jeremy Hylton | 28f46e1 | 2002-06-13 14:58:30 +0000 | [diff] [blame] | 213 | def library_option(self, lib): |
Greg Ward | 4fecfce | 1999-10-03 20:45:33 +0000 | [diff] [blame] | 214 | return "-l" + lib |
| 215 | |
Jeremy Hylton | 28f46e1 | 2002-06-13 14:58:30 +0000 | [diff] [blame] | 216 | def find_library_file(self, dirs, lib, debug=0): |
Jeremy Hylton | 129b17d | 2002-06-13 15:14:10 +0000 | [diff] [blame] | 217 | shared_f = self.library_filename(lib, lib_type='shared') |
| 218 | dylib_f = self.library_filename(lib, lib_type='dylib') |
| 219 | static_f = self.library_filename(lib, lib_type='static') |
| 220 | |
Greg Ward | 4fecfce | 1999-10-03 20:45:33 +0000 | [diff] [blame] | 221 | for dir in dirs: |
Jeremy Hylton | 129b17d | 2002-06-13 15:14:10 +0000 | [diff] [blame] | 222 | shared = os.path.join(dir, shared_f) |
| 223 | dylib = os.path.join(dir, dylib_f) |
| 224 | static = os.path.join(dir, static_f) |
Greg Ward | 4fecfce | 1999-10-03 20:45:33 +0000 | [diff] [blame] | 225 | # We're second-guessing the linker here, with not much hard |
| 226 | # data to go on: GCC seems to prefer the shared library, so I'm |
| 227 | # assuming that *all* Unix C compilers do. And of course I'm |
| 228 | # ignoring even GCC's "-static" option. So sue me. |
Jack Jansen | e259e59 | 2001-08-27 15:08:16 +0000 | [diff] [blame] | 229 | if os.path.exists(dylib): |
| 230 | return dylib |
| 231 | elif os.path.exists(shared): |
Greg Ward | 4fecfce | 1999-10-03 20:45:33 +0000 | [diff] [blame] | 232 | return shared |
Greg Ward | be86bde | 2000-09-26 01:56:15 +0000 | [diff] [blame] | 233 | elif os.path.exists(static): |
Greg Ward | 4fecfce | 1999-10-03 20:45:33 +0000 | [diff] [blame] | 234 | return static |
Jeremy Hylton | 129b17d | 2002-06-13 15:14:10 +0000 | [diff] [blame] | 235 | |
| 236 | # Oops, didn't find it in *any* of 'dirs' |
| 237 | return None |