"""distutils.command.build_ext

Implements the Distutils 'build_ext' command, for building extension

modules (currently limited to C extensions, should accommodate C++

extensions ASAP)."""

# This module should be kept compatible with Python 2.1.

__revision__ = "$Id: build_ext.py 65742 2008-08-17 04:16:04Z brett.cannon $"

import sys, os, string, re

from types import *

from site import USER_BASE, USER_SITE

from distutils.core import Command

from distutils.errors import *

from distutils.sysconfig import customize_compiler, get_python_version

from distutils.dep_util import newer_group

from distutils.extension import Extension

from distutils.util import get_platform

from distutils import log

if os.name == 'nt':

    from distutils.msvccompiler import get_build_version

    MSVC_VERSION = int(get_build_version())

# An extension name is just a dot-separated list of Python NAMEs (ie.

# the same as a fully-qualified module name).

extension_name_re = re.compile \

    (r'^[a-zA-Z_][a-zA-Z_0-9]*(\.[a-zA-Z_][a-zA-Z_0-9]*)*$')

def show_compilers ():

    from distutils.ccompiler import show_compilers

    show_compilers()

class build_ext (Command):

    description = "build C/C++ extensions (compile/link to build directory)"

    # XXX thoughts on how to deal with complex command-line options like

    # these, i.e. how to make it so fancy_getopt can suck them off the

    # command line and make it look like setup.py defined the appropriate

    # lists of tuples of what-have-you.

    #   - each command needs a callback to process its command-line options

    #   - Command.__init__() needs access to its share of the whole

    #     command line (must ultimately come from

    #     Distribution.parse_command_line())

    #   - it then calls the current command class' option-parsing

    #     callback to deal with weird options like -D, which have to

    #     parse the option text and churn out some custom data

    #     structure

    #   - that data structure (in this case, a list of 2-tuples)

    #     will then be present in the command object by the time

    #     we get to finalize_options() (i.e. the constructor

    #     takes care of both command-line and client options

    #     in between initialize_options() and finalize_options())

    sep_by = " (separated by '%s')" % os.pathsep

    user_options = [

        ('build-lib=', 'b',

         "directory for compiled extension modules"),

        ('build-temp=', 't',

         "directory for temporary files (build by-products)"),

        ('plat-name=', 'p',

         "platform name to cross-compile for, if supported "

         "(default: %s)" % get_platform()),

        ('inplace', 'i',

         "ignore build-lib and put compiled extensions into the source " +

         "directory alongside your pure Python modules"),

        ('include-dirs=', 'I',

         "list of directories to search for header files" + sep_by),

        ('define=', 'D',

         "C preprocessor macros to define"),

        ('undef=', 'U',

         "C preprocessor macros to undefine"),

        ('libraries=', 'l',

         "external C libraries to link with"),

        ('library-dirs=', 'L',

         "directories to search for external C libraries" + sep_by),

        ('rpath=', 'R',

         "directories to search for shared C libraries at runtime"),

        ('link-objects=', 'O',

         "extra explicit link objects to include in the link"),

        ('debug', 'g',

         "compile/link with debugging information"),

        ('force', 'f',

         "forcibly build everything (ignore file timestamps)"),

        ('compiler=', 'c',

         "specify the compiler type"),

        ('swig-cpp', None,

         "make SWIG create C++ files (default is C)"),

        ('swig-opts=', None,

         "list of SWIG command line options"),

        ('swig=', None,

         "path to the SWIG executable"),

        ('user', None,

         "add user include, library and rpath"),

        ]

    boolean_options = ['inplace', 'debug', 'force', 'swig-cpp', 'user']

    help_options = [

        ('help-compiler', None,

         "list available compilers", show_compilers),

        ]

    def initialize_options (self):

        self.extensions = None

        self.build_lib = None

        self.plat_name = None

        self.build_temp = None

        self.inplace = 0

        self.package = None

        self.include_dirs = None

        self.define = None

        self.undef = None

        self.libraries = None

        self.library_dirs = None

        self.rpath = None

        self.link_objects = None

        self.debug = None

        self.force = None

        self.compiler = None

        self.swig = None

        self.swig_cpp = None

        self.swig_opts = None

        self.user = None

    def finalize_options (self):

        from distutils import sysconfig

        self.set_undefined_options('build',

                                   ('build_lib', 'build_lib'),

                                   ('build_temp', 'build_temp'),

                                   ('compiler', 'compiler'),

                                   ('debug', 'debug'),

                                   ('force', 'force'),

                                   ('plat_name', 'plat_name'),

                                   )

        if self.package is None:

            self.package = self.distribution.ext_package

        self.extensions = self.distribution.ext_modules

        # Make sure Python's include directories (for Python.h, pyconfig.h,

        # etc.) are in the include search path.

        py_include = sysconfig.get_python_inc()

        plat_py_include = sysconfig.get_python_inc(plat_specific=1)

        if self.include_dirs is None:

            self.include_dirs = self.distribution.include_dirs or []

        if type(self.include_dirs) is StringType:

            self.include_dirs = string.split(self.include_dirs, os.pathsep)

        # Put the Python "system" include dir at the end, so that

        # any local include dirs take precedence.

        self.include_dirs.append(py_include)

        if plat_py_include != py_include:

            self.include_dirs.append(plat_py_include)

        if type(self.libraries) is StringType:

            self.libraries = [self.libraries]

        # Life is easier if we're not forever checking for None, so

        # simplify these options to empty lists if unset

        if self.libraries is None:

            self.libraries = []

        if self.library_dirs is None:

            self.library_dirs = []

        elif type(self.library_dirs) is StringType:

            self.library_dirs = string.split(self.library_dirs, os.pathsep)

        if self.rpath is None:

            self.rpath = []

        elif type(self.rpath) is StringType:

            self.rpath = string.split(self.rpath, os.pathsep)

        # for extensions under windows use different directories

        # for Release and Debug builds.

        # also Python's library directory must be appended to library_dirs

        if os.name == 'nt':

            # the 'libs' directory is for binary installs - we assume that

            # must be the *native* platform.  But we don't really support

            # cross-compiling via a binary install anyway, so we let it go.

            self.library_dirs.append(os.path.join(sys.exec_prefix, 'libs'))

            if self.debug:

                self.build_temp = os.path.join(self.build_temp, "Debug")

            else:

                self.build_temp = os.path.join(self.build_temp, "Release")

            # Append the source distribution include and library directories,

            # this allows distutils on windows to work in the source tree

            self.include_dirs.append(os.path.join(sys.exec_prefix, 'PC'))

            if MSVC_VERSION == 9:

                # Use the .lib files for the correct architecture

                if self.plat_name == 'win32':

                    suffix = ''

                else:

                    # win-amd64 or win-ia64

                    suffix = self.plat_name[4:]

                new_lib = os.path.join(sys.exec_prefix, 'PCbuild')

                if suffix:

                    new_lib = os.path.join(new_lib, suffix)

                self.library_dirs.append(new_lib)

            elif MSVC_VERSION == 8:

                self.library_dirs.append(os.path.join(sys.exec_prefix,

                                         'PC', 'VS8.0', 'win32release'))

            elif MSVC_VERSION == 7:

                self.library_dirs.append(os.path.join(sys.exec_prefix,

                                         'PC', 'VS7.1'))

            else:

                self.library_dirs.append(os.path.join(sys.exec_prefix,

                                         'PC', 'VC6'))

        # OS/2 (EMX) doesn't support Debug vs Release builds, but has the

        # import libraries in its "Config" subdirectory

        if os.name == 'os2':

            self.library_dirs.append(os.path.join(sys.exec_prefix, 'Config'))

        # for extensions under Cygwin and AtheOS Python's library directory must be

        # appended to library_dirs

        if sys.platform[:6] == 'cygwin' or sys.platform[:6] == 'atheos':

            if sys.executable.startswith(os.path.join(sys.exec_prefix, "bin")):

                # building third party extensions

                self.library_dirs.append(os.path.join(sys.prefix, "lib",

                                                      "python" + get_python_version(),

                                                      "config"))

            else:

                # building python standard extensions

                self.library_dirs.append('.')

        # for extensions under Linux with a shared Python library,

        # Python's library directory must be appended to library_dirs

        if (sys.platform.startswith('linux') or sys.platform.startswith('gnu')) \

                and sysconfig.get_config_var('Py_ENABLE_SHARED'):

            if sys.executable.startswith(os.path.join(sys.exec_prefix, "bin")):

                # building third party extensions

                self.library_dirs.append(sysconfig.get_config_var('LIBDIR'))

            else:

                # building python standard extensions

                self.library_dirs.append('.')

        # The argument parsing will result in self.define being a string, but

        # it has to be a list of 2-tuples.  All the preprocessor symbols

        # specified by the 'define' option will be set to '1'.  Multiple

        # symbols can be separated with commas.

        if self.define:

            defines = string.split(self.define, ',')

            self.define = map(lambda symbol: (symbol, '1'), defines)

        # The option for macros to undefine is also a string from the

        # option parsing, but has to be a list.  Multiple symbols can also

        # be separated with commas here.

        if self.undef:

            self.undef = string.split(self.undef, ',')

        if self.swig_opts is None:

            self.swig_opts = []

        else:

            self.swig_opts = self.swig_opts.split(' ')

        # Finally add the user include and library directories if requested

        if self.user:

            user_include = os.path.join(USER_BASE, "include")

            user_lib = os.path.join(USER_BASE, "lib")

            if os.path.isdir(user_include):

                self.include_dirs.append(user_include)

            if os.path.isdir(user_lib):

                self.library_dirs.append(user_lib)

                self.rpath.append(user_lib)

    # finalize_options ()

    def run (self):

        from distutils.ccompiler import new_compiler

        # 'self.extensions', as supplied by setup.py, is a list of

        # Extension instances.  See the documentation for Extension (in

        # distutils.extension) for details.

        #

        # For backwards compatibility with Distutils 0.8.2 and earlier, we

        # also allow the 'extensions' list to be a list of tuples:

        #    (ext_name, build_info)

        # where build_info is a dictionary containing everything that

        # Extension instances do except the name, with a few things being

        # differently named.  We convert these 2-tuples to Extension

        # instances as needed.

        if not self.extensions:

            return

        # If we were asked to build any C/C++ libraries, make sure that the

        # directory where we put them is in the library search path for

        # linking extensions.

        if self.distribution.has_c_libraries():

            build_clib = self.get_finalized_command('build_clib')

            self.libraries.extend(build_clib.get_library_names() or [])

            self.library_dirs.append(build_clib.build_clib)

        # Setup the CCompiler object that we'll use to do all the

        # compiling and linking

        self.compiler = new_compiler(compiler=self.compiler,

                                     verbose=self.verbose,

                                     dry_run=self.dry_run,

                                     force=self.force)

        customize_compiler(self.compiler)

        # If we are cross-compiling, init the compiler now (if we are not

        # cross-compiling, init would not hurt, but people may rely on

        # late initialization of compiler even if they shouldn't...)

        if os.name == 'nt' and self.plat_name != get_platform():

            self.compiler.initialize(self.plat_name)

        # And make sure that any compile/link-related options (which might

        # come from the command-line or from the setup script) are set in

        # that CCompiler object -- that way, they automatically apply to

        # all compiling and linking done here.

        if self.include_dirs is not None:

            self.compiler.set_include_dirs(self.include_dirs)

        if self.define is not None:

            # 'define' option is a list of (name,value) tuples

            for (name,value) in self.define:

                self.compiler.define_macro(name, value)

        if self.undef is not None:

            for macro in self.undef:

                self.compiler.undefine_macro(macro)

        if self.libraries is not None:

            self.compiler.set_libraries(self.libraries)

        if self.library_dirs is not None:

            self.compiler.set_library_dirs(self.library_dirs)

        if self.rpath is not None:

            self.compiler.set_runtime_library_dirs(self.rpath)

        if self.link_objects is not None:

            self.compiler.set_link_objects(self.link_objects)

        # Now actually compile and link everything.

        self.build_extensions()

    # run ()

    def check_extensions_list (self, extensions):

        """Ensure that the list of extensions (presumably provided as a

        command option 'extensions') is valid, i.e. it is a list of

        Extension objects.  We also support the old-style list of 2-tuples,

        where the tuples are (ext_name, build_info), which are converted to

        Extension instances here.

        Raise DistutilsSetupError if the structure is invalid anywhere;

        just returns otherwise.

        """

        if type(extensions) is not ListType:

            raise DistutilsSetupError, \

                  "'ext_modules' option must be a list of Extension instances"

        for i in range(len(extensions)):

            ext = extensions[i]

            if isinstance(ext, Extension):

                continue                # OK! (assume type-checking done

                                        # by Extension constructor)

            (ext_name, build_info) = ext

            log.warn(("old-style (ext_name, build_info) tuple found in "

                      "ext_modules for extension '%s'"

                      "-- please convert to Extension instance" % ext_name))

            if type(ext) is not TupleType and len(ext) != 2:

                raise DistutilsSetupError, \

                      ("each element of 'ext_modules' option must be an "

                       "Extension instance or 2-tuple")

            if not (type(ext_name) is StringType and

                    extension_name_re.match(ext_name)):

                raise DistutilsSetupError, \

                      ("first element of each tuple in 'ext_modules' "

                       "must be the extension name (a string)")

            if type(build_info) is not DictionaryType:

                raise DistutilsSetupError, \

                      ("second element of each tuple in 'ext_modules' "

                       "must be a dictionary (build info)")

            # OK, the (ext_name, build_info) dict is type-safe: convert it

            # to an Extension instance.

            ext = Extension(ext_name, build_info['sources'])

            # Easy stuff: one-to-one mapping from dict elements to

            # instance attributes.

            for key in ('include_dirs',

                        'library_dirs',

                        'libraries',

                        'extra_objects',

                        'extra_compile_args',

                        'extra_link_args'):

                val = build_info.get(key)

                if val is not None:

                    setattr(ext, key, val)

            # Medium-easy stuff: same syntax/semantics, different names.

            ext.runtime_library_dirs = build_info.get('rpath')

            if 'def_file' in build_info:

                log.warn("'def_file' element of build info dict "

                         "no longer supported")

            # Non-trivial stuff: 'macros' split into 'define_macros'

            # and 'undef_macros'.

            macros = build_info.get('macros')

            if macros:

                ext.define_macros = []

                ext.undef_macros = []

                for macro in macros:

                    if not (type(macro) is TupleType and

                            1 <= len(macro) <= 2):

                        raise DistutilsSetupError, \

                              ("'macros' element of build info dict "

                               "must be 1- or 2-tuple")

                    if len(macro) == 1:

                        ext.undef_macros.append(macro[0])

                    elif len(macro) == 2:

                        ext.define_macros.append(macro)

            extensions[i] = ext

        # for extensions

    # check_extensions_list ()

    def get_source_files (self):

        self.check_extensions_list(self.extensions)

        filenames = []

        # Wouldn't it be neat if we knew the names of header files too...

        for ext in self.extensions:

            filenames.extend(ext.sources)

        return filenames

    def get_outputs (self):

        # Sanity check the 'extensions' list -- can't assume this is being

        # done in the same run as a 'build_extensions()' call (in fact, we

        # can probably assume that it *isn't*!).

        self.check_extensions_list(self.extensions)

        # And build the list of output (built) filenames.  Note that this

        # ignores the 'inplace' flag, and assumes everything goes in the

        # "build" tree.

        outputs = []

        for ext in self.extensions:

            fullname = self.get_ext_fullname(ext.name)

            outputs.append(os.path.join(self.build_lib,

                                        self.get_ext_filename(fullname)))

        return outputs

    # get_outputs ()

    def build_extensions(self):

        # First, sanity-check the 'extensions' list

        self.check_extensions_list(self.extensions)

        for ext in self.extensions:

            self.build_extension(ext)

    def build_extension(self, ext):

        sources = ext.sources

        if sources is None or type(sources) not in (ListType, TupleType):

            raise DistutilsSetupError, \

                  ("in 'ext_modules' option (extension '%s'), " +

                   "'sources' must be present and must be " +

                   "a list of source filenames") % ext.name

        sources = list(sources)

        fullname = self.get_ext_fullname(ext.name)

        if self.inplace:

            # ignore build-lib -- put the compiled extension into

            # the source tree along with pure Python modules

            modpath = string.split(fullname, '.')

            package = string.join(modpath[0:-1], '.')

            base = modpath[-1]

            build_py = self.get_finalized_command('build_py')

            package_dir = build_py.get_package_dir(package)

            ext_filename = os.path.join(package_dir,

                                        self.get_ext_filename(base))

        else:

            ext_filename = os.path.join(self.build_lib,

                                        self.get_ext_filename(fullname))

        depends = sources + ext.depends

        if not (self.force or newer_group(depends, ext_filename, 'newer')):

            log.debug("skipping '%s' extension (up-to-date)", ext.name)

            return

        else:

            log.info("building '%s' extension", ext.name)

        # First, scan the sources for SWIG definition files (.i), run

        # SWIG on 'em to create .c files, and modify the sources list

        # accordingly.

        sources = self.swig_sources(sources, ext)

        # Next, compile the source code to object files.

        # XXX not honouring 'define_macros' or 'undef_macros' -- the

        # CCompiler API needs to change to accommodate this, and I

        # want to do one thing at a time!

        # Two possible sources for extra compiler arguments:

        #   - 'extra_compile_args' in Extension object

        #   - CFLAGS environment variable (not particularly

        #     elegant, but people seem to expect it and I

        #     guess it's useful)

        # The environment variable should take precedence, and

        # any sensible compiler will give precedence to later

        # command line args.  Hence we combine them in order:

        extra_args = ext.extra_compile_args or []

        macros = ext.define_macros[:]

        for undef in ext.undef_macros:

            macros.append((undef,))

        objects = self.compiler.compile(sources,