17db96d56Sopenharmony_ci"""distutils.command.build_ext
27db96d56Sopenharmony_ci
37db96d56Sopenharmony_ciImplements the Distutils 'build_ext' command, for building extension
47db96d56Sopenharmony_cimodules (currently limited to C extensions, should accommodate C++
57db96d56Sopenharmony_ciextensions ASAP)."""
67db96d56Sopenharmony_ci
77db96d56Sopenharmony_ciimport contextlib
87db96d56Sopenharmony_ciimport os
97db96d56Sopenharmony_ciimport re
107db96d56Sopenharmony_ciimport sys
117db96d56Sopenharmony_cifrom distutils.core import Command
127db96d56Sopenharmony_cifrom distutils.errors import *
137db96d56Sopenharmony_cifrom distutils.sysconfig import customize_compiler, get_python_version
147db96d56Sopenharmony_cifrom distutils.sysconfig import get_config_h_filename
157db96d56Sopenharmony_cifrom distutils.dep_util import newer_group
167db96d56Sopenharmony_cifrom distutils.extension import Extension
177db96d56Sopenharmony_cifrom distutils.util import get_platform
187db96d56Sopenharmony_cifrom distutils import log
197db96d56Sopenharmony_ci
207db96d56Sopenharmony_cifrom site import USER_BASE
217db96d56Sopenharmony_ci
227db96d56Sopenharmony_ci# An extension name is just a dot-separated list of Python NAMEs (ie.
237db96d56Sopenharmony_ci# the same as a fully-qualified module name).
247db96d56Sopenharmony_ciextension_name_re = re.compile \
257db96d56Sopenharmony_ci    (r'^[a-zA-Z_][a-zA-Z_0-9]*(\.[a-zA-Z_][a-zA-Z_0-9]*)*$')
267db96d56Sopenharmony_ci
277db96d56Sopenharmony_ci
287db96d56Sopenharmony_cidef show_compilers ():
297db96d56Sopenharmony_ci    from distutils.ccompiler import show_compilers
307db96d56Sopenharmony_ci    show_compilers()
317db96d56Sopenharmony_ci
327db96d56Sopenharmony_ci
337db96d56Sopenharmony_ciclass build_ext(Command):
347db96d56Sopenharmony_ci
357db96d56Sopenharmony_ci    description = "build C/C++ extensions (compile/link to build directory)"
367db96d56Sopenharmony_ci
377db96d56Sopenharmony_ci    # XXX thoughts on how to deal with complex command-line options like
387db96d56Sopenharmony_ci    # these, i.e. how to make it so fancy_getopt can suck them off the
397db96d56Sopenharmony_ci    # command line and make it look like setup.py defined the appropriate
407db96d56Sopenharmony_ci    # lists of tuples of what-have-you.
417db96d56Sopenharmony_ci    #   - each command needs a callback to process its command-line options
427db96d56Sopenharmony_ci    #   - Command.__init__() needs access to its share of the whole
437db96d56Sopenharmony_ci    #     command line (must ultimately come from
447db96d56Sopenharmony_ci    #     Distribution.parse_command_line())
457db96d56Sopenharmony_ci    #   - it then calls the current command class' option-parsing
467db96d56Sopenharmony_ci    #     callback to deal with weird options like -D, which have to
477db96d56Sopenharmony_ci    #     parse the option text and churn out some custom data
487db96d56Sopenharmony_ci    #     structure
497db96d56Sopenharmony_ci    #   - that data structure (in this case, a list of 2-tuples)
507db96d56Sopenharmony_ci    #     will then be present in the command object by the time
517db96d56Sopenharmony_ci    #     we get to finalize_options() (i.e. the constructor
527db96d56Sopenharmony_ci    #     takes care of both command-line and client options
537db96d56Sopenharmony_ci    #     in between initialize_options() and finalize_options())
547db96d56Sopenharmony_ci
557db96d56Sopenharmony_ci    sep_by = " (separated by '%s')" % os.pathsep
567db96d56Sopenharmony_ci    user_options = [
577db96d56Sopenharmony_ci        ('build-lib=', 'b',
587db96d56Sopenharmony_ci         "directory for compiled extension modules"),
597db96d56Sopenharmony_ci        ('build-temp=', 't',
607db96d56Sopenharmony_ci         "directory for temporary files (build by-products)"),
617db96d56Sopenharmony_ci        ('plat-name=', 'p',
627db96d56Sopenharmony_ci         "platform name to cross-compile for, if supported "
637db96d56Sopenharmony_ci         "(default: %s)" % get_platform()),
647db96d56Sopenharmony_ci        ('inplace', 'i',
657db96d56Sopenharmony_ci         "ignore build-lib and put compiled extensions into the source " +
667db96d56Sopenharmony_ci         "directory alongside your pure Python modules"),
677db96d56Sopenharmony_ci        ('include-dirs=', 'I',
687db96d56Sopenharmony_ci         "list of directories to search for header files" + sep_by),
697db96d56Sopenharmony_ci        ('define=', 'D',
707db96d56Sopenharmony_ci         "C preprocessor macros to define"),
717db96d56Sopenharmony_ci        ('undef=', 'U',
727db96d56Sopenharmony_ci         "C preprocessor macros to undefine"),
737db96d56Sopenharmony_ci        ('libraries=', 'l',
747db96d56Sopenharmony_ci         "external C libraries to link with"),
757db96d56Sopenharmony_ci        ('library-dirs=', 'L',
767db96d56Sopenharmony_ci         "directories to search for external C libraries" + sep_by),
777db96d56Sopenharmony_ci        ('rpath=', 'R',
787db96d56Sopenharmony_ci         "directories to search for shared C libraries at runtime"),
797db96d56Sopenharmony_ci        ('link-objects=', 'O',
807db96d56Sopenharmony_ci         "extra explicit link objects to include in the link"),
817db96d56Sopenharmony_ci        ('debug', 'g',
827db96d56Sopenharmony_ci         "compile/link with debugging information"),
837db96d56Sopenharmony_ci        ('force', 'f',
847db96d56Sopenharmony_ci         "forcibly build everything (ignore file timestamps)"),
857db96d56Sopenharmony_ci        ('compiler=', 'c',
867db96d56Sopenharmony_ci         "specify the compiler type"),
877db96d56Sopenharmony_ci        ('parallel=', 'j',
887db96d56Sopenharmony_ci         "number of parallel build jobs"),
897db96d56Sopenharmony_ci        ('swig-cpp', None,
907db96d56Sopenharmony_ci         "make SWIG create C++ files (default is C)"),
917db96d56Sopenharmony_ci        ('swig-opts=', None,
927db96d56Sopenharmony_ci         "list of SWIG command line options"),
937db96d56Sopenharmony_ci        ('swig=', None,
947db96d56Sopenharmony_ci         "path to the SWIG executable"),
957db96d56Sopenharmony_ci        ('user', None,
967db96d56Sopenharmony_ci         "add user include, library and rpath")
977db96d56Sopenharmony_ci        ]
987db96d56Sopenharmony_ci
997db96d56Sopenharmony_ci    boolean_options = ['inplace', 'debug', 'force', 'swig-cpp', 'user']
1007db96d56Sopenharmony_ci
1017db96d56Sopenharmony_ci    help_options = [
1027db96d56Sopenharmony_ci        ('help-compiler', None,
1037db96d56Sopenharmony_ci         "list available compilers", show_compilers),
1047db96d56Sopenharmony_ci        ]
1057db96d56Sopenharmony_ci
1067db96d56Sopenharmony_ci    def initialize_options(self):
1077db96d56Sopenharmony_ci        self.extensions = None
1087db96d56Sopenharmony_ci        self.build_lib = None
1097db96d56Sopenharmony_ci        self.plat_name = None
1107db96d56Sopenharmony_ci        self.build_temp = None
1117db96d56Sopenharmony_ci        self.inplace = 0
1127db96d56Sopenharmony_ci        self.package = None
1137db96d56Sopenharmony_ci
1147db96d56Sopenharmony_ci        self.include_dirs = None
1157db96d56Sopenharmony_ci        self.define = None
1167db96d56Sopenharmony_ci        self.undef = None
1177db96d56Sopenharmony_ci        self.libraries = None
1187db96d56Sopenharmony_ci        self.library_dirs = None
1197db96d56Sopenharmony_ci        self.rpath = None
1207db96d56Sopenharmony_ci        self.link_objects = None
1217db96d56Sopenharmony_ci        self.debug = None
1227db96d56Sopenharmony_ci        self.force = None
1237db96d56Sopenharmony_ci        self.compiler = None
1247db96d56Sopenharmony_ci        self.swig = None
1257db96d56Sopenharmony_ci        self.swig_cpp = None
1267db96d56Sopenharmony_ci        self.swig_opts = None
1277db96d56Sopenharmony_ci        self.user = None
1287db96d56Sopenharmony_ci        self.parallel = None
1297db96d56Sopenharmony_ci
1307db96d56Sopenharmony_ci    def finalize_options(self):
1317db96d56Sopenharmony_ci        from distutils import sysconfig
1327db96d56Sopenharmony_ci
1337db96d56Sopenharmony_ci        self.set_undefined_options('build',
1347db96d56Sopenharmony_ci                                   ('build_lib', 'build_lib'),
1357db96d56Sopenharmony_ci                                   ('build_temp', 'build_temp'),
1367db96d56Sopenharmony_ci                                   ('compiler', 'compiler'),
1377db96d56Sopenharmony_ci                                   ('debug', 'debug'),
1387db96d56Sopenharmony_ci                                   ('force', 'force'),
1397db96d56Sopenharmony_ci                                   ('parallel', 'parallel'),
1407db96d56Sopenharmony_ci                                   ('plat_name', 'plat_name'),
1417db96d56Sopenharmony_ci                                   )
1427db96d56Sopenharmony_ci
1437db96d56Sopenharmony_ci        if self.package is None:
1447db96d56Sopenharmony_ci            self.package = self.distribution.ext_package
1457db96d56Sopenharmony_ci
1467db96d56Sopenharmony_ci        self.extensions = self.distribution.ext_modules
1477db96d56Sopenharmony_ci
1487db96d56Sopenharmony_ci        # Make sure Python's include directories (for Python.h, pyconfig.h,
1497db96d56Sopenharmony_ci        # etc.) are in the include search path.
1507db96d56Sopenharmony_ci        py_include = sysconfig.get_python_inc()
1517db96d56Sopenharmony_ci        plat_py_include = sysconfig.get_python_inc(plat_specific=1)
1527db96d56Sopenharmony_ci        if self.include_dirs is None:
1537db96d56Sopenharmony_ci            self.include_dirs = self.distribution.include_dirs or []
1547db96d56Sopenharmony_ci        if isinstance(self.include_dirs, str):
1557db96d56Sopenharmony_ci            self.include_dirs = self.include_dirs.split(os.pathsep)
1567db96d56Sopenharmony_ci
1577db96d56Sopenharmony_ci        # If in a virtualenv, add its include directory
1587db96d56Sopenharmony_ci        # Issue 16116
1597db96d56Sopenharmony_ci        if sys.exec_prefix != sys.base_exec_prefix:
1607db96d56Sopenharmony_ci            self.include_dirs.append(os.path.join(sys.exec_prefix, 'include'))
1617db96d56Sopenharmony_ci
1627db96d56Sopenharmony_ci        # Put the Python "system" include dir at the end, so that
1637db96d56Sopenharmony_ci        # any local include dirs take precedence.
1647db96d56Sopenharmony_ci        self.include_dirs.extend(py_include.split(os.path.pathsep))
1657db96d56Sopenharmony_ci        if plat_py_include != py_include:
1667db96d56Sopenharmony_ci            self.include_dirs.extend(
1677db96d56Sopenharmony_ci                plat_py_include.split(os.path.pathsep))
1687db96d56Sopenharmony_ci
1697db96d56Sopenharmony_ci        self.ensure_string_list('libraries')
1707db96d56Sopenharmony_ci        self.ensure_string_list('link_objects')
1717db96d56Sopenharmony_ci
1727db96d56Sopenharmony_ci        # Life is easier if we're not forever checking for None, so
1737db96d56Sopenharmony_ci        # simplify these options to empty lists if unset
1747db96d56Sopenharmony_ci        if self.libraries is None:
1757db96d56Sopenharmony_ci            self.libraries = []
1767db96d56Sopenharmony_ci        if self.library_dirs is None:
1777db96d56Sopenharmony_ci            self.library_dirs = []
1787db96d56Sopenharmony_ci        elif isinstance(self.library_dirs, str):
1797db96d56Sopenharmony_ci            self.library_dirs = self.library_dirs.split(os.pathsep)
1807db96d56Sopenharmony_ci
1817db96d56Sopenharmony_ci        if self.rpath is None:
1827db96d56Sopenharmony_ci            self.rpath = []
1837db96d56Sopenharmony_ci        elif isinstance(self.rpath, str):
1847db96d56Sopenharmony_ci            self.rpath = self.rpath.split(os.pathsep)
1857db96d56Sopenharmony_ci
1867db96d56Sopenharmony_ci        # for extensions under windows use different directories
1877db96d56Sopenharmony_ci        # for Release and Debug builds.
1887db96d56Sopenharmony_ci        # also Python's library directory must be appended to library_dirs
1897db96d56Sopenharmony_ci        if os.name == 'nt':
1907db96d56Sopenharmony_ci            # the 'libs' directory is for binary installs - we assume that
1917db96d56Sopenharmony_ci            # must be the *native* platform.  But we don't really support
1927db96d56Sopenharmony_ci            # cross-compiling via a binary install anyway, so we let it go.
1937db96d56Sopenharmony_ci            self.library_dirs.append(os.path.join(sys.exec_prefix, 'libs'))
1947db96d56Sopenharmony_ci            if sys.base_exec_prefix != sys.prefix:  # Issue 16116
1957db96d56Sopenharmony_ci                self.library_dirs.append(os.path.join(sys.base_exec_prefix, 'libs'))
1967db96d56Sopenharmony_ci            if self.debug:
1977db96d56Sopenharmony_ci                self.build_temp = os.path.join(self.build_temp, "Debug")
1987db96d56Sopenharmony_ci            else:
1997db96d56Sopenharmony_ci                self.build_temp = os.path.join(self.build_temp, "Release")
2007db96d56Sopenharmony_ci
2017db96d56Sopenharmony_ci            # Append the source distribution include and library directories,
2027db96d56Sopenharmony_ci            # this allows distutils on windows to work in the source tree
2037db96d56Sopenharmony_ci            self.include_dirs.append(os.path.dirname(get_config_h_filename()))
2047db96d56Sopenharmony_ci            _sys_home = getattr(sys, '_home', None)
2057db96d56Sopenharmony_ci            if _sys_home:
2067db96d56Sopenharmony_ci                self.library_dirs.append(_sys_home)
2077db96d56Sopenharmony_ci
2087db96d56Sopenharmony_ci            # Use the .lib files for the correct architecture
2097db96d56Sopenharmony_ci            if self.plat_name == 'win32':
2107db96d56Sopenharmony_ci                suffix = 'win32'
2117db96d56Sopenharmony_ci            else:
2127db96d56Sopenharmony_ci                # win-amd64
2137db96d56Sopenharmony_ci                suffix = self.plat_name[4:]
2147db96d56Sopenharmony_ci            new_lib = os.path.join(sys.exec_prefix, 'PCbuild')
2157db96d56Sopenharmony_ci            if suffix:
2167db96d56Sopenharmony_ci                new_lib = os.path.join(new_lib, suffix)
2177db96d56Sopenharmony_ci            self.library_dirs.append(new_lib)
2187db96d56Sopenharmony_ci
2197db96d56Sopenharmony_ci        # For extensions under Cygwin, Python's library directory must be
2207db96d56Sopenharmony_ci        # appended to library_dirs
2217db96d56Sopenharmony_ci        if sys.platform[:6] == 'cygwin':
2227db96d56Sopenharmony_ci            if sys.executable.startswith(os.path.join(sys.exec_prefix, "bin")):
2237db96d56Sopenharmony_ci                # building third party extensions
2247db96d56Sopenharmony_ci                self.library_dirs.append(os.path.join(sys.prefix, "lib",
2257db96d56Sopenharmony_ci                                                      "python" + get_python_version(),
2267db96d56Sopenharmony_ci                                                      "config"))
2277db96d56Sopenharmony_ci            else:
2287db96d56Sopenharmony_ci                # building python standard extensions
2297db96d56Sopenharmony_ci                self.library_dirs.append('.')
2307db96d56Sopenharmony_ci
2317db96d56Sopenharmony_ci        # For building extensions with a shared Python library,
2327db96d56Sopenharmony_ci        # Python's library directory must be appended to library_dirs
2337db96d56Sopenharmony_ci        # See Issues: #1600860, #4366
2347db96d56Sopenharmony_ci        if (sysconfig.get_config_var('Py_ENABLE_SHARED')):
2357db96d56Sopenharmony_ci            if not sysconfig.python_build:
2367db96d56Sopenharmony_ci                # building third party extensions
2377db96d56Sopenharmony_ci                self.library_dirs.append(sysconfig.get_config_var('LIBDIR'))
2387db96d56Sopenharmony_ci            else:
2397db96d56Sopenharmony_ci                # building python standard extensions
2407db96d56Sopenharmony_ci                self.library_dirs.append('.')
2417db96d56Sopenharmony_ci
2427db96d56Sopenharmony_ci        # The argument parsing will result in self.define being a string, but
2437db96d56Sopenharmony_ci        # it has to be a list of 2-tuples.  All the preprocessor symbols
2447db96d56Sopenharmony_ci        # specified by the 'define' option will be set to '1'.  Multiple
2457db96d56Sopenharmony_ci        # symbols can be separated with commas.
2467db96d56Sopenharmony_ci
2477db96d56Sopenharmony_ci        if self.define:
2487db96d56Sopenharmony_ci            defines = self.define.split(',')
2497db96d56Sopenharmony_ci            self.define = [(symbol, '1') for symbol in defines]
2507db96d56Sopenharmony_ci
2517db96d56Sopenharmony_ci        # The option for macros to undefine is also a string from the
2527db96d56Sopenharmony_ci        # option parsing, but has to be a list.  Multiple symbols can also
2537db96d56Sopenharmony_ci        # be separated with commas here.
2547db96d56Sopenharmony_ci        if self.undef:
2557db96d56Sopenharmony_ci            self.undef = self.undef.split(',')
2567db96d56Sopenharmony_ci
2577db96d56Sopenharmony_ci        if self.swig_opts is None:
2587db96d56Sopenharmony_ci            self.swig_opts = []
2597db96d56Sopenharmony_ci        else:
2607db96d56Sopenharmony_ci            self.swig_opts = self.swig_opts.split(' ')
2617db96d56Sopenharmony_ci
2627db96d56Sopenharmony_ci        # Finally add the user include and library directories if requested
2637db96d56Sopenharmony_ci        if self.user:
2647db96d56Sopenharmony_ci            user_include = os.path.join(USER_BASE, "include")
2657db96d56Sopenharmony_ci            user_lib = os.path.join(USER_BASE, "lib")
2667db96d56Sopenharmony_ci            if os.path.isdir(user_include):
2677db96d56Sopenharmony_ci                self.include_dirs.append(user_include)
2687db96d56Sopenharmony_ci            if os.path.isdir(user_lib):
2697db96d56Sopenharmony_ci                self.library_dirs.append(user_lib)
2707db96d56Sopenharmony_ci                self.rpath.append(user_lib)
2717db96d56Sopenharmony_ci
2727db96d56Sopenharmony_ci        if isinstance(self.parallel, str):
2737db96d56Sopenharmony_ci            try:
2747db96d56Sopenharmony_ci                self.parallel = int(self.parallel)
2757db96d56Sopenharmony_ci            except ValueError:
2767db96d56Sopenharmony_ci                raise DistutilsOptionError("parallel should be an integer")
2777db96d56Sopenharmony_ci
2787db96d56Sopenharmony_ci    def run(self):
2797db96d56Sopenharmony_ci        from distutils.ccompiler import new_compiler
2807db96d56Sopenharmony_ci
2817db96d56Sopenharmony_ci        # 'self.extensions', as supplied by setup.py, is a list of
2827db96d56Sopenharmony_ci        # Extension instances.  See the documentation for Extension (in
2837db96d56Sopenharmony_ci        # distutils.extension) for details.
2847db96d56Sopenharmony_ci        #
2857db96d56Sopenharmony_ci        # For backwards compatibility with Distutils 0.8.2 and earlier, we
2867db96d56Sopenharmony_ci        # also allow the 'extensions' list to be a list of tuples:
2877db96d56Sopenharmony_ci        #    (ext_name, build_info)
2887db96d56Sopenharmony_ci        # where build_info is a dictionary containing everything that
2897db96d56Sopenharmony_ci        # Extension instances do except the name, with a few things being
2907db96d56Sopenharmony_ci        # differently named.  We convert these 2-tuples to Extension
2917db96d56Sopenharmony_ci        # instances as needed.
2927db96d56Sopenharmony_ci
2937db96d56Sopenharmony_ci        if not self.extensions:
2947db96d56Sopenharmony_ci            return
2957db96d56Sopenharmony_ci
2967db96d56Sopenharmony_ci        # If we were asked to build any C/C++ libraries, make sure that the
2977db96d56Sopenharmony_ci        # directory where we put them is in the library search path for
2987db96d56Sopenharmony_ci        # linking extensions.
2997db96d56Sopenharmony_ci        if self.distribution.has_c_libraries():
3007db96d56Sopenharmony_ci            build_clib = self.get_finalized_command('build_clib')
3017db96d56Sopenharmony_ci            self.libraries.extend(build_clib.get_library_names() or [])
3027db96d56Sopenharmony_ci            self.library_dirs.append(build_clib.build_clib)
3037db96d56Sopenharmony_ci
3047db96d56Sopenharmony_ci        # Setup the CCompiler object that we'll use to do all the
3057db96d56Sopenharmony_ci        # compiling and linking
3067db96d56Sopenharmony_ci        self.compiler = new_compiler(compiler=self.compiler,
3077db96d56Sopenharmony_ci                                     verbose=self.verbose,
3087db96d56Sopenharmony_ci                                     dry_run=self.dry_run,
3097db96d56Sopenharmony_ci                                     force=self.force)
3107db96d56Sopenharmony_ci        customize_compiler(self.compiler)
3117db96d56Sopenharmony_ci        # If we are cross-compiling, init the compiler now (if we are not
3127db96d56Sopenharmony_ci        # cross-compiling, init would not hurt, but people may rely on
3137db96d56Sopenharmony_ci        # late initialization of compiler even if they shouldn't...)
3147db96d56Sopenharmony_ci        if os.name == 'nt' and self.plat_name != get_platform():
3157db96d56Sopenharmony_ci            self.compiler.initialize(self.plat_name)
3167db96d56Sopenharmony_ci
3177db96d56Sopenharmony_ci        # And make sure that any compile/link-related options (which might
3187db96d56Sopenharmony_ci        # come from the command-line or from the setup script) are set in
3197db96d56Sopenharmony_ci        # that CCompiler object -- that way, they automatically apply to
3207db96d56Sopenharmony_ci        # all compiling and linking done here.
3217db96d56Sopenharmony_ci        if self.include_dirs is not None:
3227db96d56Sopenharmony_ci            self.compiler.set_include_dirs(self.include_dirs)
3237db96d56Sopenharmony_ci        if self.define is not None:
3247db96d56Sopenharmony_ci            # 'define' option is a list of (name,value) tuples
3257db96d56Sopenharmony_ci            for (name, value) in self.define:
3267db96d56Sopenharmony_ci                self.compiler.define_macro(name, value)
3277db96d56Sopenharmony_ci        if self.undef is not None:
3287db96d56Sopenharmony_ci            for macro in self.undef:
3297db96d56Sopenharmony_ci                self.compiler.undefine_macro(macro)
3307db96d56Sopenharmony_ci        if self.libraries is not None:
3317db96d56Sopenharmony_ci            self.compiler.set_libraries(self.libraries)
3327db96d56Sopenharmony_ci        if self.library_dirs is not None:
3337db96d56Sopenharmony_ci            self.compiler.set_library_dirs(self.library_dirs)
3347db96d56Sopenharmony_ci        if self.rpath is not None:
3357db96d56Sopenharmony_ci            self.compiler.set_runtime_library_dirs(self.rpath)
3367db96d56Sopenharmony_ci        if self.link_objects is not None:
3377db96d56Sopenharmony_ci            self.compiler.set_link_objects(self.link_objects)
3387db96d56Sopenharmony_ci
3397db96d56Sopenharmony_ci        # Now actually compile and link everything.
3407db96d56Sopenharmony_ci        self.build_extensions()
3417db96d56Sopenharmony_ci
3427db96d56Sopenharmony_ci    def check_extensions_list(self, extensions):
3437db96d56Sopenharmony_ci        """Ensure that the list of extensions (presumably provided as a
3447db96d56Sopenharmony_ci        command option 'extensions') is valid, i.e. it is a list of
3457db96d56Sopenharmony_ci        Extension objects.  We also support the old-style list of 2-tuples,
3467db96d56Sopenharmony_ci        where the tuples are (ext_name, build_info), which are converted to
3477db96d56Sopenharmony_ci        Extension instances here.
3487db96d56Sopenharmony_ci
3497db96d56Sopenharmony_ci        Raise DistutilsSetupError if the structure is invalid anywhere;
3507db96d56Sopenharmony_ci        just returns otherwise.
3517db96d56Sopenharmony_ci        """
3527db96d56Sopenharmony_ci        if not isinstance(extensions, list):
3537db96d56Sopenharmony_ci            raise DistutilsSetupError(
3547db96d56Sopenharmony_ci                  "'ext_modules' option must be a list of Extension instances")
3557db96d56Sopenharmony_ci
3567db96d56Sopenharmony_ci        for i, ext in enumerate(extensions):
3577db96d56Sopenharmony_ci            if isinstance(ext, Extension):
3587db96d56Sopenharmony_ci                continue                # OK! (assume type-checking done
3597db96d56Sopenharmony_ci                                        # by Extension constructor)
3607db96d56Sopenharmony_ci
3617db96d56Sopenharmony_ci            if not isinstance(ext, tuple) or len(ext) != 2:
3627db96d56Sopenharmony_ci                raise DistutilsSetupError(
3637db96d56Sopenharmony_ci                       "each element of 'ext_modules' option must be an "
3647db96d56Sopenharmony_ci                       "Extension instance or 2-tuple")
3657db96d56Sopenharmony_ci
3667db96d56Sopenharmony_ci            ext_name, build_info = ext
3677db96d56Sopenharmony_ci
3687db96d56Sopenharmony_ci            log.warn("old-style (ext_name, build_info) tuple found in "
3697db96d56Sopenharmony_ci                     "ext_modules for extension '%s' "
3707db96d56Sopenharmony_ci                     "-- please convert to Extension instance", ext_name)
3717db96d56Sopenharmony_ci
3727db96d56Sopenharmony_ci            if not (isinstance(ext_name, str) and
3737db96d56Sopenharmony_ci                    extension_name_re.match(ext_name)):
3747db96d56Sopenharmony_ci                raise DistutilsSetupError(
3757db96d56Sopenharmony_ci                       "first element of each tuple in 'ext_modules' "
3767db96d56Sopenharmony_ci                       "must be the extension name (a string)")
3777db96d56Sopenharmony_ci
3787db96d56Sopenharmony_ci            if not isinstance(build_info, dict):
3797db96d56Sopenharmony_ci                raise DistutilsSetupError(
3807db96d56Sopenharmony_ci                       "second element of each tuple in 'ext_modules' "
3817db96d56Sopenharmony_ci                       "must be a dictionary (build info)")
3827db96d56Sopenharmony_ci
3837db96d56Sopenharmony_ci            # OK, the (ext_name, build_info) dict is type-safe: convert it
3847db96d56Sopenharmony_ci            # to an Extension instance.
3857db96d56Sopenharmony_ci            ext = Extension(ext_name, build_info['sources'])
3867db96d56Sopenharmony_ci
3877db96d56Sopenharmony_ci            # Easy stuff: one-to-one mapping from dict elements to
3887db96d56Sopenharmony_ci            # instance attributes.
3897db96d56Sopenharmony_ci            for key in ('include_dirs', 'library_dirs', 'libraries',
3907db96d56Sopenharmony_ci                        'extra_objects', 'extra_compile_args',
3917db96d56Sopenharmony_ci                        'extra_link_args'):
3927db96d56Sopenharmony_ci                val = build_info.get(key)
3937db96d56Sopenharmony_ci                if val is not None:
3947db96d56Sopenharmony_ci                    setattr(ext, key, val)
3957db96d56Sopenharmony_ci
3967db96d56Sopenharmony_ci            # Medium-easy stuff: same syntax/semantics, different names.
3977db96d56Sopenharmony_ci            ext.runtime_library_dirs = build_info.get('rpath')
3987db96d56Sopenharmony_ci            if 'def_file' in build_info:
3997db96d56Sopenharmony_ci                log.warn("'def_file' element of build info dict "
4007db96d56Sopenharmony_ci                         "no longer supported")
4017db96d56Sopenharmony_ci
4027db96d56Sopenharmony_ci            # Non-trivial stuff: 'macros' split into 'define_macros'
4037db96d56Sopenharmony_ci            # and 'undef_macros'.
4047db96d56Sopenharmony_ci            macros = build_info.get('macros')
4057db96d56Sopenharmony_ci            if macros:
4067db96d56Sopenharmony_ci                ext.define_macros = []
4077db96d56Sopenharmony_ci                ext.undef_macros = []
4087db96d56Sopenharmony_ci                for macro in macros:
4097db96d56Sopenharmony_ci                    if not (isinstance(macro, tuple) and len(macro) in (1, 2)):
4107db96d56Sopenharmony_ci                        raise DistutilsSetupError(
4117db96d56Sopenharmony_ci                              "'macros' element of build info dict "
4127db96d56Sopenharmony_ci                              "must be 1- or 2-tuple")
4137db96d56Sopenharmony_ci                    if len(macro) == 1:
4147db96d56Sopenharmony_ci                        ext.undef_macros.append(macro[0])
4157db96d56Sopenharmony_ci                    elif len(macro) == 2:
4167db96d56Sopenharmony_ci                        ext.define_macros.append(macro)
4177db96d56Sopenharmony_ci
4187db96d56Sopenharmony_ci            extensions[i] = ext
4197db96d56Sopenharmony_ci
4207db96d56Sopenharmony_ci    def get_source_files(self):
4217db96d56Sopenharmony_ci        self.check_extensions_list(self.extensions)
4227db96d56Sopenharmony_ci        filenames = []
4237db96d56Sopenharmony_ci
4247db96d56Sopenharmony_ci        # Wouldn't it be neat if we knew the names of header files too...
4257db96d56Sopenharmony_ci        for ext in self.extensions:
4267db96d56Sopenharmony_ci            filenames.extend(ext.sources)
4277db96d56Sopenharmony_ci        return filenames
4287db96d56Sopenharmony_ci
4297db96d56Sopenharmony_ci    def get_outputs(self):
4307db96d56Sopenharmony_ci        # Sanity check the 'extensions' list -- can't assume this is being
4317db96d56Sopenharmony_ci        # done in the same run as a 'build_extensions()' call (in fact, we
4327db96d56Sopenharmony_ci        # can probably assume that it *isn't*!).
4337db96d56Sopenharmony_ci        self.check_extensions_list(self.extensions)
4347db96d56Sopenharmony_ci
4357db96d56Sopenharmony_ci        # And build the list of output (built) filenames.  Note that this
4367db96d56Sopenharmony_ci        # ignores the 'inplace' flag, and assumes everything goes in the
4377db96d56Sopenharmony_ci        # "build" tree.
4387db96d56Sopenharmony_ci        outputs = []
4397db96d56Sopenharmony_ci        for ext in self.extensions:
4407db96d56Sopenharmony_ci            outputs.append(self.get_ext_fullpath(ext.name))
4417db96d56Sopenharmony_ci        return outputs
4427db96d56Sopenharmony_ci
4437db96d56Sopenharmony_ci    def build_extensions(self):
4447db96d56Sopenharmony_ci        # First, sanity-check the 'extensions' list
4457db96d56Sopenharmony_ci        self.check_extensions_list(self.extensions)
4467db96d56Sopenharmony_ci        if self.parallel:
4477db96d56Sopenharmony_ci            self._build_extensions_parallel()
4487db96d56Sopenharmony_ci        else:
4497db96d56Sopenharmony_ci            self._build_extensions_serial()
4507db96d56Sopenharmony_ci
4517db96d56Sopenharmony_ci    def _build_extensions_parallel(self):
4527db96d56Sopenharmony_ci        workers = self.parallel
4537db96d56Sopenharmony_ci        if self.parallel is True:
4547db96d56Sopenharmony_ci            workers = os.cpu_count()  # may return None
4557db96d56Sopenharmony_ci        try:
4567db96d56Sopenharmony_ci            from concurrent.futures import ThreadPoolExecutor
4577db96d56Sopenharmony_ci        except ImportError:
4587db96d56Sopenharmony_ci            workers = None
4597db96d56Sopenharmony_ci
4607db96d56Sopenharmony_ci        if workers is None:
4617db96d56Sopenharmony_ci            self._build_extensions_serial()
4627db96d56Sopenharmony_ci            return
4637db96d56Sopenharmony_ci
4647db96d56Sopenharmony_ci        with ThreadPoolExecutor(max_workers=workers) as executor:
4657db96d56Sopenharmony_ci            futures = [executor.submit(self.build_extension, ext)
4667db96d56Sopenharmony_ci                       for ext in self.extensions]
4677db96d56Sopenharmony_ci            for ext, fut in zip(self.extensions, futures):
4687db96d56Sopenharmony_ci                with self._filter_build_errors(ext):
4697db96d56Sopenharmony_ci                    fut.result()
4707db96d56Sopenharmony_ci
4717db96d56Sopenharmony_ci    def _build_extensions_serial(self):
4727db96d56Sopenharmony_ci        for ext in self.extensions:
4737db96d56Sopenharmony_ci            with self._filter_build_errors(ext):
4747db96d56Sopenharmony_ci                self.build_extension(ext)
4757db96d56Sopenharmony_ci
4767db96d56Sopenharmony_ci    @contextlib.contextmanager
4777db96d56Sopenharmony_ci    def _filter_build_errors(self, ext):
4787db96d56Sopenharmony_ci        try:
4797db96d56Sopenharmony_ci            yield
4807db96d56Sopenharmony_ci        except (CCompilerError, DistutilsError, CompileError) as e:
4817db96d56Sopenharmony_ci            if not ext.optional:
4827db96d56Sopenharmony_ci                raise
4837db96d56Sopenharmony_ci            self.warn('building extension "%s" failed: %s' %
4847db96d56Sopenharmony_ci                      (ext.name, e))
4857db96d56Sopenharmony_ci
4867db96d56Sopenharmony_ci    def build_extension(self, ext):
4877db96d56Sopenharmony_ci        sources = ext.sources
4887db96d56Sopenharmony_ci        if sources is None or not isinstance(sources, (list, tuple)):
4897db96d56Sopenharmony_ci            raise DistutilsSetupError(
4907db96d56Sopenharmony_ci                  "in 'ext_modules' option (extension '%s'), "
4917db96d56Sopenharmony_ci                  "'sources' must be present and must be "
4927db96d56Sopenharmony_ci                  "a list of source filenames" % ext.name)
4937db96d56Sopenharmony_ci        # sort to make the resulting .so file build reproducible
4947db96d56Sopenharmony_ci        sources = sorted(sources)
4957db96d56Sopenharmony_ci
4967db96d56Sopenharmony_ci        ext_path = self.get_ext_fullpath(ext.name)
4977db96d56Sopenharmony_ci        depends = sources + ext.depends
4987db96d56Sopenharmony_ci        if not (self.force or newer_group(depends, ext_path, 'newer')):
4997db96d56Sopenharmony_ci            log.debug("skipping '%s' extension (up-to-date)", ext.name)
5007db96d56Sopenharmony_ci            return
5017db96d56Sopenharmony_ci        else:
5027db96d56Sopenharmony_ci            log.info("building '%s' extension", ext.name)
5037db96d56Sopenharmony_ci
5047db96d56Sopenharmony_ci        # First, scan the sources for SWIG definition files (.i), run
5057db96d56Sopenharmony_ci        # SWIG on 'em to create .c files, and modify the sources list
5067db96d56Sopenharmony_ci        # accordingly.
5077db96d56Sopenharmony_ci        sources = self.swig_sources(sources, ext)
5087db96d56Sopenharmony_ci
5097db96d56Sopenharmony_ci        # Next, compile the source code to object files.
5107db96d56Sopenharmony_ci
5117db96d56Sopenharmony_ci        # XXX not honouring 'define_macros' or 'undef_macros' -- the
5127db96d56Sopenharmony_ci        # CCompiler API needs to change to accommodate this, and I
5137db96d56Sopenharmony_ci        # want to do one thing at a time!
5147db96d56Sopenharmony_ci
5157db96d56Sopenharmony_ci        # Two possible sources for extra compiler arguments:
5167db96d56Sopenharmony_ci        #   - 'extra_compile_args' in Extension object
5177db96d56Sopenharmony_ci        #   - CFLAGS environment variable (not particularly
5187db96d56Sopenharmony_ci        #     elegant, but people seem to expect it and I
5197db96d56Sopenharmony_ci        #     guess it's useful)
5207db96d56Sopenharmony_ci        # The environment variable should take precedence, and
5217db96d56Sopenharmony_ci        # any sensible compiler will give precedence to later
5227db96d56Sopenharmony_ci        # command line args.  Hence we combine them in order:
5237db96d56Sopenharmony_ci        extra_args = ext.extra_compile_args or []
5247db96d56Sopenharmony_ci
5257db96d56Sopenharmony_ci        macros = ext.define_macros[:]
5267db96d56Sopenharmony_ci        for undef in ext.undef_macros:
5277db96d56Sopenharmony_ci            macros.append((undef,))
5287db96d56Sopenharmony_ci
5297db96d56Sopenharmony_ci        objects = self.compiler.compile(sources,
5307db96d56Sopenharmony_ci                                         output_dir=self.build_temp,
5317db96d56Sopenharmony_ci                                         macros=macros,
5327db96d56Sopenharmony_ci                                         include_dirs=ext.include_dirs,
5337db96d56Sopenharmony_ci                                         debug=self.debug,
5347db96d56Sopenharmony_ci                                         extra_postargs=extra_args,
5357db96d56Sopenharmony_ci                                         depends=ext.depends)
5367db96d56Sopenharmony_ci
5377db96d56Sopenharmony_ci        # XXX outdated variable, kept here in case third-part code
5387db96d56Sopenharmony_ci        # needs it.
5397db96d56Sopenharmony_ci        self._built_objects = objects[:]
5407db96d56Sopenharmony_ci
5417db96d56Sopenharmony_ci        # Now link the object files together into a "shared object" --
5427db96d56Sopenharmony_ci        # of course, first we have to figure out all the other things
5437db96d56Sopenharmony_ci        # that go into the mix.
5447db96d56Sopenharmony_ci        if ext.extra_objects:
5457db96d56Sopenharmony_ci            objects.extend(ext.extra_objects)
5467db96d56Sopenharmony_ci        extra_args = ext.extra_link_args or []
5477db96d56Sopenharmony_ci
5487db96d56Sopenharmony_ci        # Detect target language, if not provided
5497db96d56Sopenharmony_ci        language = ext.language or self.compiler.detect_language(sources)
5507db96d56Sopenharmony_ci
5517db96d56Sopenharmony_ci        self.compiler.link_shared_object(
5527db96d56Sopenharmony_ci            objects, ext_path,
5537db96d56Sopenharmony_ci            libraries=self.get_libraries(ext),
5547db96d56Sopenharmony_ci            library_dirs=ext.library_dirs,
5557db96d56Sopenharmony_ci            runtime_library_dirs=ext.runtime_library_dirs,
5567db96d56Sopenharmony_ci            extra_postargs=extra_args,
5577db96d56Sopenharmony_ci            export_symbols=self.get_export_symbols(ext),
5587db96d56Sopenharmony_ci            debug=self.debug,
5597db96d56Sopenharmony_ci            build_temp=self.build_temp,
5607db96d56Sopenharmony_ci            target_lang=language)
5617db96d56Sopenharmony_ci
5627db96d56Sopenharmony_ci    def swig_sources(self, sources, extension):
5637db96d56Sopenharmony_ci        """Walk the list of source files in 'sources', looking for SWIG
5647db96d56Sopenharmony_ci        interface (.i) files.  Run SWIG on all that are found, and
5657db96d56Sopenharmony_ci        return a modified 'sources' list with SWIG source files replaced
5667db96d56Sopenharmony_ci        by the generated C (or C++) files.
5677db96d56Sopenharmony_ci        """
5687db96d56Sopenharmony_ci        new_sources = []
5697db96d56Sopenharmony_ci        swig_sources = []
5707db96d56Sopenharmony_ci        swig_targets = {}
5717db96d56Sopenharmony_ci
5727db96d56Sopenharmony_ci        # XXX this drops generated C/C++ files into the source tree, which
5737db96d56Sopenharmony_ci        # is fine for developers who want to distribute the generated
5747db96d56Sopenharmony_ci        # source -- but there should be an option to put SWIG output in
5757db96d56Sopenharmony_ci        # the temp dir.
5767db96d56Sopenharmony_ci
5777db96d56Sopenharmony_ci        if self.swig_cpp:
5787db96d56Sopenharmony_ci            log.warn("--swig-cpp is deprecated - use --swig-opts=-c++")
5797db96d56Sopenharmony_ci
5807db96d56Sopenharmony_ci        if self.swig_cpp or ('-c++' in self.swig_opts) or \
5817db96d56Sopenharmony_ci           ('-c++' in extension.swig_opts):
5827db96d56Sopenharmony_ci            target_ext = '.cpp'
5837db96d56Sopenharmony_ci        else:
5847db96d56Sopenharmony_ci            target_ext = '.c'
5857db96d56Sopenharmony_ci
5867db96d56Sopenharmony_ci        for source in sources:
5877db96d56Sopenharmony_ci            (base, ext) = os.path.splitext(source)
5887db96d56Sopenharmony_ci            if ext == ".i":             # SWIG interface file
5897db96d56Sopenharmony_ci                new_sources.append(base + '_wrap' + target_ext)
5907db96d56Sopenharmony_ci                swig_sources.append(source)
5917db96d56Sopenharmony_ci                swig_targets[source] = new_sources[-1]
5927db96d56Sopenharmony_ci            else:
5937db96d56Sopenharmony_ci                new_sources.append(source)
5947db96d56Sopenharmony_ci
5957db96d56Sopenharmony_ci        if not swig_sources:
5967db96d56Sopenharmony_ci            return new_sources
5977db96d56Sopenharmony_ci
5987db96d56Sopenharmony_ci        swig = self.swig or self.find_swig()
5997db96d56Sopenharmony_ci        swig_cmd = [swig, "-python"]
6007db96d56Sopenharmony_ci        swig_cmd.extend(self.swig_opts)
6017db96d56Sopenharmony_ci        if self.swig_cpp:
6027db96d56Sopenharmony_ci            swig_cmd.append("-c++")
6037db96d56Sopenharmony_ci
6047db96d56Sopenharmony_ci        # Do not override commandline arguments
6057db96d56Sopenharmony_ci        if not self.swig_opts:
6067db96d56Sopenharmony_ci            for o in extension.swig_opts:
6077db96d56Sopenharmony_ci                swig_cmd.append(o)
6087db96d56Sopenharmony_ci
6097db96d56Sopenharmony_ci        for source in swig_sources:
6107db96d56Sopenharmony_ci            target = swig_targets[source]
6117db96d56Sopenharmony_ci            log.info("swigging %s to %s", source, target)
6127db96d56Sopenharmony_ci            self.spawn(swig_cmd + ["-o", target, source])
6137db96d56Sopenharmony_ci
6147db96d56Sopenharmony_ci        return new_sources
6157db96d56Sopenharmony_ci
6167db96d56Sopenharmony_ci    def find_swig(self):
6177db96d56Sopenharmony_ci        """Return the name of the SWIG executable.  On Unix, this is
6187db96d56Sopenharmony_ci        just "swig" -- it should be in the PATH.  Tries a bit harder on
6197db96d56Sopenharmony_ci        Windows.
6207db96d56Sopenharmony_ci        """
6217db96d56Sopenharmony_ci        if os.name == "posix":
6227db96d56Sopenharmony_ci            return "swig"
6237db96d56Sopenharmony_ci        elif os.name == "nt":
6247db96d56Sopenharmony_ci            # Look for SWIG in its standard installation directory on
6257db96d56Sopenharmony_ci            # Windows (or so I presume!).  If we find it there, great;
6267db96d56Sopenharmony_ci            # if not, act like Unix and assume it's in the PATH.
6277db96d56Sopenharmony_ci            for vers in ("1.3", "1.2", "1.1"):
6287db96d56Sopenharmony_ci                fn = os.path.join("c:\\swig%s" % vers, "swig.exe")
6297db96d56Sopenharmony_ci                if os.path.isfile(fn):
6307db96d56Sopenharmony_ci                    return fn
6317db96d56Sopenharmony_ci            else:
6327db96d56Sopenharmony_ci                return "swig.exe"
6337db96d56Sopenharmony_ci        else:
6347db96d56Sopenharmony_ci            raise DistutilsPlatformError(
6357db96d56Sopenharmony_ci                  "I don't know how to find (much less run) SWIG "
6367db96d56Sopenharmony_ci                  "on platform '%s'" % os.name)
6377db96d56Sopenharmony_ci
6387db96d56Sopenharmony_ci    # -- Name generators -----------------------------------------------
6397db96d56Sopenharmony_ci    # (extension names, filenames, whatever)
6407db96d56Sopenharmony_ci    def get_ext_fullpath(self, ext_name):
6417db96d56Sopenharmony_ci        """Returns the path of the filename for a given extension.
6427db96d56Sopenharmony_ci
6437db96d56Sopenharmony_ci        The file is located in `build_lib` or directly in the package
6447db96d56Sopenharmony_ci        (inplace option).
6457db96d56Sopenharmony_ci        """
6467db96d56Sopenharmony_ci        fullname = self.get_ext_fullname(ext_name)
6477db96d56Sopenharmony_ci        modpath = fullname.split('.')
6487db96d56Sopenharmony_ci        filename = self.get_ext_filename(modpath[-1])
6497db96d56Sopenharmony_ci
6507db96d56Sopenharmony_ci        if not self.inplace:
6517db96d56Sopenharmony_ci            # no further work needed
6527db96d56Sopenharmony_ci            # returning :
6537db96d56Sopenharmony_ci            #   build_dir/package/path/filename
6547db96d56Sopenharmony_ci            filename = os.path.join(*modpath[:-1]+[filename])
6557db96d56Sopenharmony_ci            return os.path.join(self.build_lib, filename)
6567db96d56Sopenharmony_ci
6577db96d56Sopenharmony_ci        # the inplace option requires to find the package directory
6587db96d56Sopenharmony_ci        # using the build_py command for that
6597db96d56Sopenharmony_ci        package = '.'.join(modpath[0:-1])
6607db96d56Sopenharmony_ci        build_py = self.get_finalized_command('build_py')
6617db96d56Sopenharmony_ci        package_dir = os.path.abspath(build_py.get_package_dir(package))
6627db96d56Sopenharmony_ci
6637db96d56Sopenharmony_ci        # returning
6647db96d56Sopenharmony_ci        #   package_dir/filename
6657db96d56Sopenharmony_ci        return os.path.join(package_dir, filename)
6667db96d56Sopenharmony_ci
6677db96d56Sopenharmony_ci    def get_ext_fullname(self, ext_name):
6687db96d56Sopenharmony_ci        """Returns the fullname of a given extension name.
6697db96d56Sopenharmony_ci
6707db96d56Sopenharmony_ci        Adds the `package.` prefix"""
6717db96d56Sopenharmony_ci        if self.package is None:
6727db96d56Sopenharmony_ci            return ext_name
6737db96d56Sopenharmony_ci        else:
6747db96d56Sopenharmony_ci            return self.package + '.' + ext_name
6757db96d56Sopenharmony_ci
6767db96d56Sopenharmony_ci    def get_ext_filename(self, ext_name):
6777db96d56Sopenharmony_ci        r"""Convert the name of an extension (eg. "foo.bar") into the name
6787db96d56Sopenharmony_ci        of the file from which it will be loaded (eg. "foo/bar.so", or
6797db96d56Sopenharmony_ci        "foo\bar.pyd").
6807db96d56Sopenharmony_ci        """
6817db96d56Sopenharmony_ci        from distutils.sysconfig import get_config_var
6827db96d56Sopenharmony_ci        ext_path = ext_name.split('.')
6837db96d56Sopenharmony_ci        ext_suffix = get_config_var('EXT_SUFFIX')
6847db96d56Sopenharmony_ci        return os.path.join(*ext_path) + ext_suffix
6857db96d56Sopenharmony_ci
6867db96d56Sopenharmony_ci    def get_export_symbols(self, ext):
6877db96d56Sopenharmony_ci        """Return the list of symbols that a shared extension has to
6887db96d56Sopenharmony_ci        export.  This either uses 'ext.export_symbols' or, if it's not
6897db96d56Sopenharmony_ci        provided, "PyInit_" + module_name.  Only relevant on Windows, where
6907db96d56Sopenharmony_ci        the .pyd file (DLL) must export the module "PyInit_" function.
6917db96d56Sopenharmony_ci        """
6927db96d56Sopenharmony_ci        suffix = '_' + ext.name.split('.')[-1]
6937db96d56Sopenharmony_ci        try:
6947db96d56Sopenharmony_ci            # Unicode module name support as defined in PEP-489
6957db96d56Sopenharmony_ci            # https://peps.python.org/pep-0489/#export-hook-name
6967db96d56Sopenharmony_ci            suffix.encode('ascii')
6977db96d56Sopenharmony_ci        except UnicodeEncodeError:
6987db96d56Sopenharmony_ci            suffix = 'U' + suffix.encode('punycode').replace(b'-', b'_').decode('ascii')
6997db96d56Sopenharmony_ci
7007db96d56Sopenharmony_ci        initfunc_name = "PyInit" + suffix
7017db96d56Sopenharmony_ci        if initfunc_name not in ext.export_symbols:
7027db96d56Sopenharmony_ci            ext.export_symbols.append(initfunc_name)
7037db96d56Sopenharmony_ci        return ext.export_symbols
7047db96d56Sopenharmony_ci
7057db96d56Sopenharmony_ci    def get_libraries(self, ext):
7067db96d56Sopenharmony_ci        """Return the list of libraries to link against when building a
7077db96d56Sopenharmony_ci        shared extension.  On most platforms, this is just 'ext.libraries';
7087db96d56Sopenharmony_ci        on Windows, we add the Python library (eg. python20.dll).
7097db96d56Sopenharmony_ci        """
7107db96d56Sopenharmony_ci        # The python library is always needed on Windows.  For MSVC, this
7117db96d56Sopenharmony_ci        # is redundant, since the library is mentioned in a pragma in
7127db96d56Sopenharmony_ci        # pyconfig.h that MSVC groks.  The other Windows compilers all seem
7137db96d56Sopenharmony_ci        # to need it mentioned explicitly, though, so that's what we do.
7147db96d56Sopenharmony_ci        # Append '_d' to the python import library on debug builds.
7157db96d56Sopenharmony_ci        if sys.platform == "win32":
7167db96d56Sopenharmony_ci            from distutils._msvccompiler import MSVCCompiler
7177db96d56Sopenharmony_ci            if not isinstance(self.compiler, MSVCCompiler):
7187db96d56Sopenharmony_ci                template = "python%d%d"
7197db96d56Sopenharmony_ci                if self.debug:
7207db96d56Sopenharmony_ci                    template = template + '_d'
7217db96d56Sopenharmony_ci                pythonlib = (template %
7227db96d56Sopenharmony_ci                       (sys.hexversion >> 24, (sys.hexversion >> 16) & 0xff))
7237db96d56Sopenharmony_ci                # don't extend ext.libraries, it may be shared with other
7247db96d56Sopenharmony_ci                # extensions, it is a reference to the original list
7257db96d56Sopenharmony_ci                return ext.libraries + [pythonlib]
7267db96d56Sopenharmony_ci        else:
7277db96d56Sopenharmony_ci            # On Android only the main executable and LD_PRELOADs are considered
7287db96d56Sopenharmony_ci            # to be RTLD_GLOBAL, all the dependencies of the main executable
7297db96d56Sopenharmony_ci            # remain RTLD_LOCAL and so the shared libraries must be linked with
7307db96d56Sopenharmony_ci            # libpython when python is built with a shared python library (issue
7317db96d56Sopenharmony_ci            # bpo-21536).
7327db96d56Sopenharmony_ci            # On Cygwin (and if required, other POSIX-like platforms based on
7337db96d56Sopenharmony_ci            # Windows like MinGW) it is simply necessary that all symbols in
7347db96d56Sopenharmony_ci            # shared libraries are resolved at link time.
7357db96d56Sopenharmony_ci            from distutils.sysconfig import get_config_var
7367db96d56Sopenharmony_ci            link_libpython = False
7377db96d56Sopenharmony_ci            if get_config_var('Py_ENABLE_SHARED'):
7387db96d56Sopenharmony_ci                # A native build on an Android device or on Cygwin
7397db96d56Sopenharmony_ci                if hasattr(sys, 'getandroidapilevel'):
7407db96d56Sopenharmony_ci                    link_libpython = True
7417db96d56Sopenharmony_ci                elif sys.platform == 'cygwin':
7427db96d56Sopenharmony_ci                    link_libpython = True
7437db96d56Sopenharmony_ci                elif '_PYTHON_HOST_PLATFORM' in os.environ:
7447db96d56Sopenharmony_ci                    # We are cross-compiling for one of the relevant platforms
7457db96d56Sopenharmony_ci                    if get_config_var('ANDROID_API_LEVEL') != 0:
7467db96d56Sopenharmony_ci                        link_libpython = True
7477db96d56Sopenharmony_ci                    elif get_config_var('MACHDEP') == 'cygwin':
7487db96d56Sopenharmony_ci                        link_libpython = True
7497db96d56Sopenharmony_ci
7507db96d56Sopenharmony_ci            if link_libpython:
7517db96d56Sopenharmony_ci                ldversion = get_config_var('LDVERSION')
7527db96d56Sopenharmony_ci                return ext.libraries + ['python' + ldversion]
7537db96d56Sopenharmony_ci
7547db96d56Sopenharmony_ci        return ext.libraries
755