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 | |
| 16 | # created 1999/07/05, Greg Ward |
| 17 | |
Greg Ward | 3ce77fd | 2000-03-02 01:49:45 +0000 | [diff] [blame] | 18 | __revision__ = "$Id$" |
Greg Ward | 170bdc0 | 1999-07-10 02:04:22 +0000 | [diff] [blame] | 19 | |
Jeremy Hylton | 332a146 | 2002-06-04 20:18:24 +0000 | [diff] [blame] | 20 | import os, sys |
Jeremy Hylton | 022640d | 2002-06-13 15:01:38 +0000 | [diff] [blame] | 21 | from types import StringType, NoneType |
Greg Ward | 8037cb1 | 1999-09-13 03:12:53 +0000 | [diff] [blame] | 22 | from copy import copy |
Jeremy Hylton | 022640d | 2002-06-13 15:01:38 +0000 | [diff] [blame] | 23 | |
Fred Drake | d15db5c | 2001-12-11 05:04:24 +0000 | [diff] [blame] | 24 | from distutils import sysconfig |
Greg Ward | 3ff3b03 | 2000-06-21 02:58:46 +0000 | [diff] [blame] | 25 | from distutils.dep_util import newer |
Greg Ward | d151711 | 2000-05-30 01:56:44 +0000 | [diff] [blame] | 26 | from distutils.ccompiler import \ |
Greg Ward | 3add77f | 2000-05-30 02:02:49 +0000 | [diff] [blame] | 27 | CCompiler, gen_preprocess_options, gen_lib_options |
| 28 | from distutils.errors import \ |
| 29 | DistutilsExecError, CompileError, LibError, LinkError |
Jeremy Hylton | cd8a114 | 2002-06-04 20:14:43 +0000 | [diff] [blame] | 30 | from distutils import log |
Greg Ward | 170bdc0 | 1999-07-10 02:04:22 +0000 | [diff] [blame] | 31 | |
| 32 | # XXX Things not currently handled: |
| 33 | # * optimization/debug/warning flags; we just use whatever's in Python's |
| 34 | # Makefile and live with it. Is this adequate? If not, we might |
| 35 | # have to have a bunch of subclasses GNUCCompiler, SGICCompiler, |
| 36 | # SunCCompiler, and I suspect down that road lies madness. |
| 37 | # * even if we don't know a warning flag from an optimization flag, |
| 38 | # we need some way for outsiders to feed preprocessor/compiler/linker |
| 39 | # flags in to us -- eg. a sysadmin might want to mandate certain flags |
| 40 | # via a site config file, or a user might want to set something for |
| 41 | # compiling this module distribution only via the setup.py command |
| 42 | # line, whatever. As long as these options come from something on the |
| 43 | # current system, they can be as system-dependent as they like, and we |
| 44 | # should just happily stuff them into the preprocessor/compiler/linker |
| 45 | # options and carry on. |
| 46 | |
Jeremy Hylton | 022640d | 2002-06-13 15:01:38 +0000 | [diff] [blame] | 47 | class UnixCCompiler(CCompiler): |
Greg Ward | 170bdc0 | 1999-07-10 02:04:22 +0000 | [diff] [blame] | 48 | |
Greg Ward | 0e3530b | 1999-09-29 12:22:50 +0000 | [diff] [blame] | 49 | compiler_type = 'unix' |
| 50 | |
Greg Ward | 73076ff | 2000-06-25 02:05:29 +0000 | [diff] [blame] | 51 | # These are used by CCompiler in two places: the constructor sets |
| 52 | # instance attributes 'preprocessor', 'compiler', etc. from them, and |
| 53 | # 'set_executable()' allows any of these to be set. The defaults here |
| 54 | # are pretty generic; they will probably have to be set by an outsider |
| 55 | # (eg. using information discovered by the sysconfig about building |
| 56 | # Python extensions). |
| 57 | executables = {'preprocessor' : None, |
| 58 | 'compiler' : ["cc"], |
| 59 | 'compiler_so' : ["cc"], |
| 60 | 'linker_so' : ["cc", "-shared"], |
| 61 | 'linker_exe' : ["cc"], |
| 62 | 'archiver' : ["ar", "-cr"], |
| 63 | 'ranlib' : None, |
| 64 | } |
| 65 | |
Just van Rossum | 005dbb2 | 2002-02-11 15:31:50 +0000 | [diff] [blame] | 66 | if sys.platform[:6] == "darwin": |
| 67 | executables['ranlib'] = ["ranlib"] |
| 68 | |
Greg Ward | 73076ff | 2000-06-25 02:05:29 +0000 | [diff] [blame] | 69 | # Needed for the filename generation methods provided by the base |
| 70 | # class, CCompiler. NB. whoever instantiates/uses a particular |
| 71 | # UnixCCompiler instance should set 'shared_lib_ext' -- we set a |
| 72 | # reasonable common default here, but it's not necessarily used on all |
| 73 | # Unices! |
| 74 | |
Andrew M. Kuchling | 7880e5e | 2001-04-05 15:46:48 +0000 | [diff] [blame] | 75 | src_extensions = [".c",".C",".cc",".cxx",".cpp",".m"] |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame] | 76 | obj_extension = ".o" |
| 77 | static_lib_extension = ".a" |
Greg Ward | 73076ff | 2000-06-25 02:05:29 +0000 | [diff] [blame] | 78 | shared_lib_extension = ".so" |
Jack Jansen | e259e59 | 2001-08-27 15:08:16 +0000 | [diff] [blame] | 79 | dylib_lib_extension = ".dylib" |
| 80 | static_lib_format = shared_lib_format = dylib_lib_format = "lib%s%s" |
Greg Ward | c9f3187 | 2000-01-09 22:47:53 +0000 | [diff] [blame] | 81 | |
Jeremy Hylton | 129b17d | 2002-06-13 15:14:10 +0000 | [diff] [blame] | 82 | def preprocess(self, source, |
| 83 | output_file=None, macros=None, include_dirs=None, |
| 84 | extra_preargs=None, extra_postargs=None): |
| 85 | ignore, macros, include_dirs = \ |
Greg Ward | be86bde | 2000-09-26 01:56:15 +0000 | [diff] [blame] | 86 | self._fix_compile_args(None, macros, include_dirs) |
| 87 | pp_opts = gen_preprocess_options(macros, include_dirs) |
Greg Ward | 73076ff | 2000-06-25 02:05:29 +0000 | [diff] [blame] | 88 | pp_args = self.preprocessor + pp_opts |
Greg Ward | 3ff3b03 | 2000-06-21 02:58:46 +0000 | [diff] [blame] | 89 | if output_file: |
Greg Ward | 73076ff | 2000-06-25 02:05:29 +0000 | [diff] [blame] | 90 | pp_args.extend(['-o', output_file]) |
Greg Ward | 3ff3b03 | 2000-06-21 02:58:46 +0000 | [diff] [blame] | 91 | if extra_preargs: |
Greg Ward | 73076ff | 2000-06-25 02:05:29 +0000 | [diff] [blame] | 92 | pp_args[:0] = extra_preargs |
Greg Ward | 3ff3b03 | 2000-06-21 02:58:46 +0000 | [diff] [blame] | 93 | if extra_postargs: |
Andrew M. Kuchling | 286b107 | 2001-07-16 14:19:20 +0000 | [diff] [blame] | 94 | pp_args.extend(extra_postargs) |
Greg Ward | 3ff3b03 | 2000-06-21 02:58:46 +0000 | [diff] [blame] | 95 | |
Andrew M. Kuchling | 286b107 | 2001-07-16 14:19:20 +0000 | [diff] [blame] | 96 | # 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] | 97 | # generating output to stdout, or there's a target output file and |
| 98 | # 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] | 99 | # exist). |
Guido van Rossum | 63a4740 | 2001-07-16 14:46:13 +0000 | [diff] [blame] | 100 | 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] | 101 | if output_file: |
| 102 | self.mkpath(os.path.dirname(output_file)) |
| 103 | try: |
Greg Ward | be86bde | 2000-09-26 01:56:15 +0000 | [diff] [blame] | 104 | self.spawn(pp_args) |
Greg Ward | 3ff3b03 | 2000-06-21 02:58:46 +0000 | [diff] [blame] | 105 | except DistutilsExecError, msg: |
| 106 | raise CompileError, msg |
| 107 | |
Jeremy Hylton | 1b046e4 | 2002-06-18 18:48:55 +0000 | [diff] [blame] | 108 | def _compile(self, obj, src, ext, cc_args, extra_postargs, pp_opts): |
| 109 | try: |
| 110 | self.spawn(self.compiler_so + cc_args + [src, '-o', obj] + |
| 111 | extra_postargs) |
| 112 | except DistutilsExecError, msg: |
| 113 | raise CompileError, msg |
Greg Ward | 170bdc0 | 1999-07-10 02:04:22 +0000 | [diff] [blame] | 114 | |
Jeremy Hylton | 129b17d | 2002-06-13 15:14:10 +0000 | [diff] [blame] | 115 | def create_static_lib(self, objects, output_libname, |
| 116 | output_dir=None, debug=0): |
| 117 | objects, output_dir = self._fix_object_args(objects, output_dir) |
Greg Ward | c9f3187 | 2000-01-09 22:47:53 +0000 | [diff] [blame] | 118 | |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame] | 119 | output_filename = \ |
Greg Ward | be86bde | 2000-09-26 01:56:15 +0000 | [diff] [blame] | 120 | self.library_filename(output_libname, output_dir=output_dir) |
Greg Ward | c9f3187 | 2000-01-09 22:47:53 +0000 | [diff] [blame] | 121 | |
Greg Ward | be86bde | 2000-09-26 01:56:15 +0000 | [diff] [blame] | 122 | if self._need_link(objects, output_filename): |
| 123 | self.mkpath(os.path.dirname(output_filename)) |
| 124 | self.spawn(self.archiver + |
| 125 | [output_filename] + |
| 126 | objects + self.objects) |
Greg Ward | 1c79330 | 2000-04-14 00:48:15 +0000 | [diff] [blame] | 127 | |
Greg Ward | 8eef583 | 2000-04-14 13:53:34 +0000 | [diff] [blame] | 128 | # Not many Unices required ranlib anymore -- SunOS 4.x is, I |
| 129 | # think the only major Unix that does. Maybe we need some |
| 130 | # platform intelligence here to skip ranlib if it's not |
| 131 | # needed -- or maybe Python's configure script took care of |
| 132 | # it for us, hence the check for leading colon. |
Greg Ward | 73076ff | 2000-06-25 02:05:29 +0000 | [diff] [blame] | 133 | if self.ranlib: |
Greg Ward | d151711 | 2000-05-30 01:56:44 +0000 | [diff] [blame] | 134 | try: |
Greg Ward | be86bde | 2000-09-26 01:56:15 +0000 | [diff] [blame] | 135 | self.spawn(self.ranlib + [output_filename]) |
Greg Ward | d151711 | 2000-05-30 01:56:44 +0000 | [diff] [blame] | 136 | except DistutilsExecError, msg: |
| 137 | raise LibError, msg |
Greg Ward | c9f3187 | 2000-01-09 22:47:53 +0000 | [diff] [blame] | 138 | else: |
Jeremy Hylton | cd8a114 | 2002-06-04 20:14:43 +0000 | [diff] [blame] | 139 | log.debug("skipping %s (up-to-date)", output_filename) |
Greg Ward | c9f3187 | 2000-01-09 22:47:53 +0000 | [diff] [blame] | 140 | |
Jeremy Hylton | 129b17d | 2002-06-13 15:14:10 +0000 | [diff] [blame] | 141 | def link(self, target_desc, objects, |
| 142 | output_filename, output_dir=None, libraries=None, |
| 143 | library_dirs=None, runtime_library_dirs=None, |
| 144 | export_symbols=None, debug=0, extra_preargs=None, |
| 145 | extra_postargs=None, build_temp=None): |
| 146 | objects, output_dir = self._fix_object_args(objects, output_dir) |
| 147 | libraries, library_dirs, runtime_library_dirs = \ |
Greg Ward | be86bde | 2000-09-26 01:56:15 +0000 | [diff] [blame] | 148 | self._fix_lib_args(libraries, library_dirs, runtime_library_dirs) |
Greg Ward | 04d7832 | 1999-12-12 16:57:47 +0000 | [diff] [blame] | 149 | |
Jeremy Hylton | 129b17d | 2002-06-13 15:14:10 +0000 | [diff] [blame] | 150 | lib_opts = gen_lib_options(self, library_dirs, runtime_library_dirs, |
Greg Ward | be86bde | 2000-09-26 01:56:15 +0000 | [diff] [blame] | 151 | libraries) |
| 152 | if type(output_dir) not in (StringType, NoneType): |
Greg Ward | 10ca82b | 2000-02-10 02:51:32 +0000 | [diff] [blame] | 153 | raise TypeError, "'output_dir' must be a string or None" |
Greg Ward | 8037cb1 | 1999-09-13 03:12:53 +0000 | [diff] [blame] | 154 | if output_dir is not None: |
Greg Ward | be86bde | 2000-09-26 01:56:15 +0000 | [diff] [blame] | 155 | output_filename = os.path.join(output_dir, output_filename) |
Greg Ward | 170bdc0 | 1999-07-10 02:04:22 +0000 | [diff] [blame] | 156 | |
Greg Ward | be86bde | 2000-09-26 01:56:15 +0000 | [diff] [blame] | 157 | if self._need_link(objects, output_filename): |
Fred Drake | b94b849 | 2001-12-06 20:51:35 +0000 | [diff] [blame] | 158 | ld_args = (objects + self.objects + |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame] | 159 | lib_opts + ['-o', output_filename]) |
Greg Ward | ba233fb | 2000-02-09 02:17:00 +0000 | [diff] [blame] | 160 | if debug: |
| 161 | ld_args[:0] = ['-g'] |
Greg Ward | 0e3530b | 1999-09-29 12:22:50 +0000 | [diff] [blame] | 162 | if extra_preargs: |
| 163 | ld_args[:0] = extra_preargs |
| 164 | if extra_postargs: |
Greg Ward | be86bde | 2000-09-26 01:56:15 +0000 | [diff] [blame] | 165 | ld_args.extend(extra_postargs) |
| 166 | self.mkpath(os.path.dirname(output_filename)) |
Greg Ward | d151711 | 2000-05-30 01:56:44 +0000 | [diff] [blame] | 167 | try: |
Fred Drake | b94b849 | 2001-12-06 20:51:35 +0000 | [diff] [blame] | 168 | if target_desc == CCompiler.EXECUTABLE: |
Greg Ward | 4240648 | 2000-09-27 02:08:14 +0000 | [diff] [blame] | 169 | self.spawn(self.linker_exe + ld_args) |
| 170 | else: |
| 171 | self.spawn(self.linker_so + ld_args) |
Greg Ward | d151711 | 2000-05-30 01:56:44 +0000 | [diff] [blame] | 172 | except DistutilsExecError, msg: |
| 173 | raise LinkError, msg |
Greg Ward | 8037cb1 | 1999-09-13 03:12:53 +0000 | [diff] [blame] | 174 | else: |
Jeremy Hylton | cd8a114 | 2002-06-04 20:14:43 +0000 | [diff] [blame] | 175 | log.debug("skipping %s (up-to-date)", output_filename) |
Greg Ward | 5e71744 | 1999-08-14 23:53:53 +0000 | [diff] [blame] | 176 | |
Greg Ward | 32c4a8a | 2000-03-06 03:40:29 +0000 | [diff] [blame] | 177 | # -- Miscellaneous methods ----------------------------------------- |
| 178 | # These are all used by the 'gen_lib_options() function, in |
| 179 | # ccompiler.py. |
Fred Drake | b94b849 | 2001-12-06 20:51:35 +0000 | [diff] [blame] | 180 | |
Jeremy Hylton | 28f46e1 | 2002-06-13 14:58:30 +0000 | [diff] [blame] | 181 | def library_dir_option(self, dir): |
Greg Ward | 4fecfce | 1999-10-03 20:45:33 +0000 | [diff] [blame] | 182 | return "-L" + dir |
| 183 | |
Jeremy Hylton | 28f46e1 | 2002-06-13 14:58:30 +0000 | [diff] [blame] | 184 | def runtime_library_dir_option(self, dir): |
Fred Drake | d15db5c | 2001-12-11 05:04:24 +0000 | [diff] [blame] | 185 | # XXX Hackish, at the very least. See Python bug #445902: |
| 186 | # http://sourceforge.net/tracker/index.php |
| 187 | # ?func=detail&aid=445902&group_id=5470&atid=105470 |
| 188 | # Linkers on different platforms need different options to |
| 189 | # specify that directories need to be added to the list of |
| 190 | # directories searched for dependencies when a dynamic library |
| 191 | # is sought. GCC has to be told to pass the -R option through |
| 192 | # to the linker, whereas other compilers just know this. |
| 193 | # Other compilers may need something slightly different. At |
| 194 | # this time, there's no way to determine this information from |
| 195 | # the configuration data stored in the Python installation, so |
| 196 | # we use this hack. |
| 197 | compiler = os.path.basename(sysconfig.get_config_var("CC")) |
| 198 | if compiler == "gcc" or compiler == "g++": |
| 199 | return "-Wl,-R" + dir |
| 200 | else: |
| 201 | return "-R" + dir |
Greg Ward | d03f88a | 2000-03-18 15:19:51 +0000 | [diff] [blame] | 202 | |
Jeremy Hylton | 28f46e1 | 2002-06-13 14:58:30 +0000 | [diff] [blame] | 203 | def library_option(self, lib): |
Greg Ward | 4fecfce | 1999-10-03 20:45:33 +0000 | [diff] [blame] | 204 | return "-l" + lib |
| 205 | |
Jeremy Hylton | 28f46e1 | 2002-06-13 14:58:30 +0000 | [diff] [blame] | 206 | def find_library_file(self, dirs, lib, debug=0): |
Jeremy Hylton | 129b17d | 2002-06-13 15:14:10 +0000 | [diff] [blame] | 207 | shared_f = self.library_filename(lib, lib_type='shared') |
| 208 | dylib_f = self.library_filename(lib, lib_type='dylib') |
| 209 | static_f = self.library_filename(lib, lib_type='static') |
| 210 | |
Greg Ward | 4fecfce | 1999-10-03 20:45:33 +0000 | [diff] [blame] | 211 | for dir in dirs: |
Jeremy Hylton | 129b17d | 2002-06-13 15:14:10 +0000 | [diff] [blame] | 212 | shared = os.path.join(dir, shared_f) |
| 213 | dylib = os.path.join(dir, dylib_f) |
| 214 | static = os.path.join(dir, static_f) |
Greg Ward | 4fecfce | 1999-10-03 20:45:33 +0000 | [diff] [blame] | 215 | # We're second-guessing the linker here, with not much hard |
| 216 | # data to go on: GCC seems to prefer the shared library, so I'm |
| 217 | # assuming that *all* Unix C compilers do. And of course I'm |
| 218 | # ignoring even GCC's "-static" option. So sue me. |
Jack Jansen | e259e59 | 2001-08-27 15:08:16 +0000 | [diff] [blame] | 219 | if os.path.exists(dylib): |
| 220 | return dylib |
| 221 | elif os.path.exists(shared): |
Greg Ward | 4fecfce | 1999-10-03 20:45:33 +0000 | [diff] [blame] | 222 | return shared |
Greg Ward | be86bde | 2000-09-26 01:56:15 +0000 | [diff] [blame] | 223 | elif os.path.exists(static): |
Greg Ward | 4fecfce | 1999-10-03 20:45:33 +0000 | [diff] [blame] | 224 | return static |
Jeremy Hylton | 129b17d | 2002-06-13 15:14:10 +0000 | [diff] [blame] | 225 | |
| 226 | # Oops, didn't find it in *any* of 'dirs' |
| 227 | return None |