fbxsdkbuilder inherits from distutilbuilder

builder.py

-# Copyright (c) 2020, Riverbank Computing Limited
-# All rights reserved.
-#
-# This copy of SIP is licensed for use under the terms of the SIP License
-# Agreement.  See the file LICENSE for more details.
-#
-# This copy of SIP may also used under the terms of the GNU General Public
-# License v2 or v3 as published by the Free Software Foundation which can be
-# found in the files LICENSE-GPL2 and LICENSE-GPL3 included in this package.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
-# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-# POSSIBILITY OF SUCH DAMAGE.
-
-
-from distutils.command.build_ext import build_ext
-from distutils.dist import Distribution
-from distutils.extension import Extension
-from distutils.log import ERROR, INFO, set_threshold
-
-import os
-import sys
-
-from sipbuild.buildable import BuildableModule
-from sipbuild.builder import Builder
-from sipbuild.exceptions import UserException
-from sipbuild.installable import Installable
-
-
-class FBXSDKBuilder(Builder):
-    """ The implementation of a distutils-based project builder. """
-
-    def build_executable(self, buildable, *, fatal=True):
-        """ Build an executable from a BuildableExecutable object and return
-        the relative pathname of the executable.
-        """
-
-        raise UserException("DistutilsBuilder cannot build executables")
-
-    def build_project(self, target_dir, *, wheel_tag=None):
-        """ Build the project. """
-
-        for buildable in self.project.buildables:
-            if isinstance(buildable, BuildableModule):
-                if buildable.static:
-                    raise UserException(
-                            "DistutilsBuilder cannot build static modules")
-
-                self._build_extension_module(buildable)
-            else:
-                raise UserException(
-                        "DistutilsBuilder cannot build '{0}' buildables".format(
-                                type(buildable).__name__))
-
-    def install_project(self, target_dir, *, wheel_tag=None):
-        """ Install the project into a target directory. """
-
-        project = self.project
-
-        installed = []
-
-        # Install any project-level installables.
-        for installable in project.installables:
-            installable.install(target_dir, installed)
-
-        # Install any installables from built buildables.
-        for buildable in project.buildables:
-            for installable in buildable.installables:
-                installable.install(target_dir, installed)
-
-        if project.distinfo:
-            from sipbuild.distinfo import create_distinfo
-
-            create_distinfo(project.get_distinfo_dir(target_dir), wheel_tag,
-                    installed, project.metadata, project.get_requires_dists(),
-                    project.root_dir, project.console_scripts,
-                    project.gui_scripts)
-
-    def _build_extension_module(self, buildable):
-        """ Build an extension module from the sources. """
-
-        project = self.project
-
-        set_threshold(INFO if project.verbose else ERROR)
-
-        distribution = Distribution()
-
-        module_builder = ExtensionCommand(distribution, buildable)
-        module_builder.build_lib = buildable.build_dir
-        module_builder.debug = buildable.debug
-
-        if buildable.debug:
-            # Enable assert().
-            module_builder.undef = 'NDEBUG'
-
-        module_builder.ensure_finalized()
-
-        # Convert the #defines.
-        define_macros = []
-        for macro in buildable.define_macros:
-            parts = macro.split('=', maxsplit=1)
-            name = parts[0]
-            try:
-                value = parts[1]
-            except IndexError:
-                value = None
-
-            define_macros.append((name, value))
-
-        buildable.make_names_relative()
-
-        if sys.platform == "linux":
-            linux_static_libs = [ os.path.abspath(a) for a in project.linux_static_libraries ]
-            extra_compile_args = [ "-std=c++11" ]
-        else:
-            linux_static_libs = []
-            extra_compile_args = []
-
-
-        module_builder.extensions = [
-            Extension(buildable.fq_name, buildable.sources,
-                    define_macros=define_macros,
-                    include_dirs=buildable.include_dirs,
-                    libraries=buildable.libraries,
-                    library_dirs=buildable.library_dirs,
-                    extra_link_args=linux_static_libs,
-			extra_compile_args=extra_compile_args)]
-
-        project.progress(
-                "Compiling the '{0}' module".format(buildable.fq_name))
-
-        saved_cwd = os.getcwd()
-        os.chdir(buildable.build_dir)
-
-        try:
-            module_builder.run()
-        except Exception as e:
-            raise UserException(
-                    "Unable to compile the '{0}' module".format(
-                            buildable.fq_name),
-                    detail=str(e))
-
-        # Add the extension module to the buildable's list of installables.
-        installable = Installable('module',
-                target_subdir=buildable.get_install_subdir())
-        installable.files.append(
-                module_builder.get_ext_fullpath(buildable.fq_name))
-        buildable.installables.append(installable)
-
-        os.chdir(saved_cwd)
-
-
-class ExtensionCommand(build_ext):
-    """ Extend the distutils command to build an extension module. """
-
-    def __init__(self, distribution, buildable):
-        """ Initialise the object. """
-
-        super().__init__(distribution)
-
-        self._buildable = buildable
-
-    def get_ext_filename(self, ext_name):
-        """ Reimplemented to handle modules that use the limited API. """
-
-        return os.path.join(*ext_name.split('.')) + self._buildable.get_module_extension()
+from distutils.command.build_ext import build_ext
+from distutils.dist import Distribution
+from distutils.extension import Extension
+from distutils.log import ERROR, INFO, set_threshold
+
+import os
+import sys
+
+from sipbuild.buildable import BuildableModule
+from sipbuild.distutils_builder import DistutilsBuilder, ExtensionCommand
+from sipbuild.exceptions import UserException
+from sipbuild.installable import Installable
+
+
+class FBXSDKBuilder(DistutilsBuilder):
+    """ Custom Builder for FBX SDK"""
+
+    def _build_extension_module(self, buildable):
+
+        project = self.project
+
+        set_threshold(INFO if project.verbose else ERROR)
+
+        distribution = Distribution()
+
+        module_builder = ExtensionCommand(distribution, buildable)
+        module_builder.build_lib = buildable.build_dir
+        module_builder.debug = buildable.debug
+
+        module_builder.ensure_finalized()
+
+        define_macros = []
+        for macro in buildable.define_macros:
+            parts = macro.split("=", maxsplit=1)
+            name = parts[0]
+            try:
+                value = parts[1]
+            except IndexError:
+                value = None
+
+            define_macros.append((name, value))
+
+        buildable.make_names_relative()
+
+        if sys.platform == "linux":
+            linux_static_libs = [
+                os.path.abspath(a) for a in project.linux_static_libraries
+            ]
+            extra_compile_args = ["-std=c++11"]
+        else:
+            linux_static_libs = []
+            extra_compile_args = []
+
+        module_builder.extensions = [
+            Extension(
+                buildable.fq_name,
+                buildable.sources,
+                define_macros=define_macros,
+                include_dirs=buildable.include_dirs,
+                libraries=buildable.libraries,
+                library_dirs=buildable.library_dirs,
+                extra_link_args=linux_static_libs,
+                extra_compile_args=extra_compile_args,
+            )
+        ]
+
+        project.progress(
+            "Compiling the '{0}' module".format(buildable.fq_name)
+        )
+
+        saved_cwd = os.getcwd()
+        os.chdir(buildable.build_dir)
+
+        try:
+            module_builder.run()
+        except Exception as e:
+            raise UserException(
+                "Unable to compile the '{0}' module".format(buildable.fq_name),
+                detail=str(e),
+            )
+
+        installable = Installable(
+            "module", target_subdir=buildable.get_install_subdir()
+        )
+        installable.files.append(
+            module_builder.get_ext_fullpath(buildable.fq_name)
+        )
+        buildable.installables.append(installable)
+
+        os.chdir(saved_cwd)