unixccompiler.py 9.61 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
"""distutils.unixccompiler

Contains the UnixCCompiler class, a subclass of CCompiler that handles
the "typical" Unix-style command-line C compiler:
  * macros defined with -Dname[=value]
  * macros undefined with -Uname
  * include search directories specified with -Idir
  * libraries specified with -lllib
  * library search directories specified with -Ldir
  * compile handled by 'cc' (or similar) executable with -c option:
    compiles .c to .o
  * link static library handled by 'ar' command (possibly with 'ranlib')
  * link shared library handled by 'cc -shared'
"""

# created 1999/07/05, Greg Ward

18
__revision__ = "$Id$"
19

20
import os, sys
21
from types import StringType, NoneType
22
from copy import copy
23

24
from distutils import sysconfig
25
from distutils.dep_util import newer
26
from distutils.ccompiler import \
27 28 29
     CCompiler, gen_preprocess_options, gen_lib_options
from distutils.errors import \
     DistutilsExecError, CompileError, LibError, LinkError
30
from distutils import log
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46

# XXX Things not currently handled:
#   * optimization/debug/warning flags; we just use whatever's in Python's
#     Makefile and live with it.  Is this adequate?  If not, we might
#     have to have a bunch of subclasses GNUCCompiler, SGICCompiler,
#     SunCCompiler, and I suspect down that road lies madness.
#   * even if we don't know a warning flag from an optimization flag,
#     we need some way for outsiders to feed preprocessor/compiler/linker
#     flags in to us -- eg. a sysadmin might want to mandate certain flags
#     via a site config file, or a user might want to set something for
#     compiling this module distribution only via the setup.py command
#     line, whatever.  As long as these options come from something on the
#     current system, they can be as system-dependent as they like, and we
#     should just happily stuff them into the preprocessor/compiler/linker
#     options and carry on.

47
class UnixCCompiler(CCompiler):
48

49 50
    compiler_type = 'unix'

51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
    # These are used by CCompiler in two places: the constructor sets
    # instance attributes 'preprocessor', 'compiler', etc. from them, and
    # 'set_executable()' allows any of these to be set.  The defaults here
    # are pretty generic; they will probably have to be set by an outsider
    # (eg. using information discovered by the sysconfig about building
    # Python extensions).
    executables = {'preprocessor' : None,
                   'compiler'     : ["cc"],
                   'compiler_so'  : ["cc"],
                   'linker_so'    : ["cc", "-shared"],
                   'linker_exe'   : ["cc"],
                   'archiver'     : ["ar", "-cr"],
                   'ranlib'       : None,
                  }

66 67 68
    if sys.platform[:6] == "darwin":
        executables['ranlib'] = ["ranlib"]

69 70 71 72 73 74
    # Needed for the filename generation methods provided by the base
    # class, CCompiler.  NB. whoever instantiates/uses a particular
    # UnixCCompiler instance should set 'shared_lib_ext' -- we set a
    # reasonable common default here, but it's not necessarily used on all
    # Unices!

75
    src_extensions = [".c",".C",".cc",".cxx",".cpp",".m"]
76 77
    obj_extension = ".o"
    static_lib_extension = ".a"
78
    shared_lib_extension = ".so"
79 80
    dylib_lib_extension = ".dylib"
    static_lib_format = shared_lib_format = dylib_lib_format = "lib%s%s"
81

82 83 84 85
    def preprocess(self, source,
                   output_file=None, macros=None, include_dirs=None,
                   extra_preargs=None, extra_postargs=None):
        ignore, macros, include_dirs = \
86 87
            self._fix_compile_args(None, macros, include_dirs)
        pp_opts = gen_preprocess_options(macros, include_dirs)
88
        pp_args = self.preprocessor + pp_opts
89
        if output_file:
90
            pp_args.extend(['-o', output_file])
91
        if extra_preargs:
92
            pp_args[:0] = extra_preargs
93
        if extra_postargs:
94
            pp_args.extend(extra_postargs)
95

96
        # We need to preprocess: either we're being forced to, or we're
Fred Drake's avatar
Fred Drake committed
97 98
        # generating output to stdout, or there's a target output file and
        # the source file is newer than the target (or the target doesn't
99
        # exist).
100
        if self.force or output_file is None or newer(source, output_file):
101 102 103
            if output_file:
                self.mkpath(os.path.dirname(output_file))
            try:
104
                self.spawn(pp_args)
105 106 107
            except DistutilsExecError, msg:
                raise CompileError, msg

108 109 110 111 112 113
    def _compile(self, obj, src, ext, cc_args, extra_postargs, pp_opts):
        try:
            self.spawn(self.compiler_so + cc_args + [src, '-o', obj] +
                       extra_postargs)
        except DistutilsExecError, msg:
            raise CompileError, msg
114

115 116 117
    def create_static_lib(self, objects, output_libname,
                          output_dir=None, debug=0):
        objects, output_dir = self._fix_object_args(objects, output_dir)
118

119
        output_filename = \
120
            self.library_filename(output_libname, output_dir=output_dir)
121

122 123 124 125 126
        if self._need_link(objects, output_filename):
            self.mkpath(os.path.dirname(output_filename))
            self.spawn(self.archiver +
                       [output_filename] +
                       objects + self.objects)
127

128 129 130 131 132
            # Not many Unices required ranlib anymore -- SunOS 4.x is, I
            # think the only major Unix that does.  Maybe we need some
            # platform intelligence here to skip ranlib if it's not
            # needed -- or maybe Python's configure script took care of
            # it for us, hence the check for leading colon.
133
            if self.ranlib:
134
                try:
135
                    self.spawn(self.ranlib + [output_filename])
136 137
                except DistutilsExecError, msg:
                    raise LibError, msg
138
        else:
139
            log.debug("skipping %s (up-to-date)", output_filename)
140

141 142 143 144 145 146 147
    def link(self, target_desc, objects,
             output_filename, output_dir=None, libraries=None,
             library_dirs=None, runtime_library_dirs=None,
             export_symbols=None, debug=0, extra_preargs=None,
             extra_postargs=None, build_temp=None):
        objects, output_dir = self._fix_object_args(objects, output_dir)
        libraries, library_dirs, runtime_library_dirs = \
148
            self._fix_lib_args(libraries, library_dirs, runtime_library_dirs)
149

150
        lib_opts = gen_lib_options(self, library_dirs, runtime_library_dirs,
151 152
                                   libraries)
        if type(output_dir) not in (StringType, NoneType):
153
            raise TypeError, "'output_dir' must be a string or None"
154
        if output_dir is not None:
155
            output_filename = os.path.join(output_dir, output_filename)
156

157
        if self._need_link(objects, output_filename):
Fred Drake's avatar
Fred Drake committed
158
            ld_args = (objects + self.objects +
159
                       lib_opts + ['-o', output_filename])
160 161
            if debug:
                ld_args[:0] = ['-g']
162 163 164
            if extra_preargs:
                ld_args[:0] = extra_preargs
            if extra_postargs:
165 166
                ld_args.extend(extra_postargs)
            self.mkpath(os.path.dirname(output_filename))
167
            try:
Fred Drake's avatar
Fred Drake committed
168
                if target_desc == CCompiler.EXECUTABLE:
169 170 171
                    self.spawn(self.linker_exe + ld_args)
                else:
                    self.spawn(self.linker_so + ld_args)
172 173
            except DistutilsExecError, msg:
                raise LinkError, msg
174
        else:
175
            log.debug("skipping %s (up-to-date)", output_filename)
176

177 178 179
    # -- Miscellaneous methods -----------------------------------------
    # These are all used by the 'gen_lib_options() function, in
    # ccompiler.py.
Fred Drake's avatar
Fred Drake committed
180

181
    def library_dir_option(self, dir):
182 183
        return "-L" + dir

184
    def runtime_library_dir_option(self, dir):
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
        # XXX Hackish, at the very least.  See Python bug #445902:
        # http://sourceforge.net/tracker/index.php
        #   ?func=detail&aid=445902&group_id=5470&atid=105470
        # Linkers on different platforms need different options to
        # specify that directories need to be added to the list of
        # directories searched for dependencies when a dynamic library
        # is sought.  GCC has to be told to pass the -R option through
        # to the linker, whereas other compilers just know this.
        # Other compilers may need something slightly different.  At
        # this time, there's no way to determine this information from
        # the configuration data stored in the Python installation, so
        # we use this hack.
        compiler = os.path.basename(sysconfig.get_config_var("CC"))
        if compiler == "gcc" or compiler == "g++":
            return "-Wl,-R" + dir
        else:
            return "-R" + dir
202

203
    def library_option(self, lib):
204 205
        return "-l" + lib

206
    def find_library_file(self, dirs, lib, debug=0):
207 208 209 210
        shared_f = self.library_filename(lib, lib_type='shared')
        dylib_f = self.library_filename(lib, lib_type='dylib')
        static_f = self.library_filename(lib, lib_type='static')
        
211
        for dir in dirs:
212 213 214
            shared = os.path.join(dir, shared_f)
            dylib = os.path.join(dir, dylib_f)
            static = os.path.join(dir, static_f)
215 216 217 218
            # We're second-guessing the linker here, with not much hard
            # data to go on: GCC seems to prefer the shared library, so I'm
            # assuming that *all* Unix C compilers do.  And of course I'm
            # ignoring even GCC's "-static" option.  So sue me.
219 220 221
            if os.path.exists(dylib):
                return dylib
            elif os.path.exists(shared):
222
                return shared
223
            elif os.path.exists(static):
224
                return static
225 226 227
            
        # Oops, didn't find it in *any* of 'dirs'
        return None