Deprecate framework builtin

Author: jimporter

CHANGES.md

@@ -12,6 +12,9 @@
 - The `install_name` for libraries on macOS now (again) uses `@rpath`-based
   paths prior to installation
 
+### Breaking changes
+- `framework` is now deprecated; use `mopack.yml` instead
+
 ### Bug fixes
 - Automatically update dependencies via `mopack` if the toolchain file has
   changed

bfg9000/builtins/packages.py

@@ -1,10 +1,11 @@
+import warnings
+
 from . import builtin
-from .. import options as opts
 from ..exceptions import PackageResolutionError
 from ..file_types import Executable
 from ..iterutils import default_sentinel, listify
 from ..objutils import objectify
-from ..packages import CommonPackage, Framework, Package, PackageKind
+from ..packages import Framework, FrameworkPackage, Package, PackageKind
 from ..path import Path, Root
 from ..shell import which
 from ..versioning import InvalidSpecifier, SpecifierSet
@@ -47,12 +48,13 @@ def system_executable(context, name, format=None):
 
 @builtin.function()
 def framework(context, name, suffix=None):
+    # TODO: Remove this after 0.8 is released.
+    warnings.warn("'framework' is deprecated; use mopack.yml instead")
+
     env = context.env
     if not env.target_platform.has_frameworks:
         raise PackageResolutionError("{} platform doesn't support frameworks"
                                      .format(env.target_platform.name))
 
-    framework = Framework(name, suffix)
-    return CommonPackage(framework.full_name,
-                         format=env.target_platform.object_format,
-                         link_options=opts.option_list(opts.lib(framework)))
+    return FrameworkPackage(Framework(name, suffix),
+                            format=env.target_platform.object_format)

bfg9000/options.py

@@ -178,6 +178,11 @@ def __init__(self, *args, **kwargs):
                 value = self.__check_type(typ, value)
             setattr(self, name, value)
 
+    @classmethod
+    def alias(cls, fn):
+        cls.registry[fn.__name__] = fn
+        return fn
+
     def matches(self, rhs):
         return self == rhs
 
@@ -239,6 +244,11 @@ class define(Option):
 rpath_link_dir = option('rpath_link_dir', path=path.BasePath)
 
 
+@Option.alias
+def framework(name, suffix=None):
+    return lib(Framework(name, suffix))
+
+
 class gui(Option):
     main: bool = False
 

bfg9000/packages.py

@@ -48,24 +48,6 @@ def __repr__(self):
         )
 
 
-class CommonPackage(Package):
-    def __init__(self, name, submodules=None, version=None, *, format,
-                 compile_options=None, link_options=None):
-        super().__init__(name, submodules, format=format)
-        self.version = version
-
-        # Import this here to avoid circular import.
-        from .options import option_list
-        self._compile_options = compile_options or option_list()
-        self._link_options = link_options or option_list()
-
-    def compile_options(self, compiler, *, raw=False):
-        return self._compile_options
-
-    def link_options(self, linker, *, raw=False):
-        return self._link_options
-
-
 class Framework:
     # A reference to a macOS framework. Can be used in place of Library objects
     # within a Package.
@@ -84,3 +66,20 @@ def __eq__(self, rhs):
 
     def __ne__(self, rhs):
         return not (self == rhs)
+
+
+# TODO: Remove this after 0.8 is released.
+class FrameworkPackage(Package):
+    def __init__(self, framework, *, format):
+        super().__init__(framework.full_name, None, format=format)
+
+        # Import this here to avoid circular import.
+        from . import options as opts
+        self._compile_options = opts.option_list()
+        self._link_options = opts.option_list(opts.framework(framework))
+
+    def compile_options(self, compiler, *, raw=False):
+        return self._compile_options
+
+    def link_options(self, linker, *, raw=False):
+        return self._link_options

bfg9000/tools/mopack.py

@@ -8,7 +8,6 @@
 from .. import shell
 from ..exceptions import PackageResolutionError
 from ..iterutils import iterate
-from ..packages import Framework
 from ..path import Path, Root
 from ..safe_str import safe_format
 
@@ -107,17 +106,6 @@ def get_linkage(env, name, submodules=None, include_path=None, lib_path=None,
         raise PackageResolutionError(msg)
 
 
-def to_frameworks(libs):
-    def convert(lib):
-        if isinstance(lib, dict):
-            if lib['type'] == 'framework':
-                return Framework(lib['name'])
-            raise ValueError('unknown type {!r}'.format(lib['type']))
-        return lib
-
-    return [convert(i) for i in libs]
-
-
 def _dump_yaml(data):
     # `sort_keys` only works on newer versions of PyYAML, so don't worry too
     # much if we can't use it.

doc/about/changes.md

@@ -14,6 +14,9 @@ in progress
 - The `install_name` for libraries on macOS now (again) uses `@rpath`-based
   paths prior to installation
 
+### Breaking changes
+- `framework` is now deprecated; use `mopack.yml` instead
+
 ### Bug fixes
 - Automatically update dependencies via `mopack` if the toolchain file has
   changed

doc/reference/builtins.md

@@ -797,12 +797,6 @@ to modify [static libraries](#static_library).
 
 ## Package resolvers
 
-### framework(*name*, [*suffix*]) { #framework }
-
-Reference a macOS [framework][framework] named *name* with the optional suffix
-*suffix*. Though not a "package" in name, this can be used wherever packages are
-accepted.
-
 ### package(*name*, [*submodules*], [*version*], \*, [*lang*], [*kind*], [*system*]) { #package }
 Availability: `build.bfg`
 {: .subtitle}

test/unit/builtins/test_packages.py

@@ -6,13 +6,10 @@
 from .common import BuiltinTestCase
 from .. import *
 
-from bfg9000 import file_types, options as opts
-from bfg9000.build_inputs import BuildInputs
+from bfg9000 import file_types
 from bfg9000.builtins import builtin, packages, project  # noqa: F401
-from bfg9000.exceptions import PackageResolutionError
 from bfg9000.iterutils import first
-from bfg9000.packages import CommonPackage, Framework
-from bfg9000.path import abspath, Path, Root
+from bfg9000.path import abspath
 from bfg9000.versioning import SpecifierSet, Version
 
 
@@ -66,47 +63,6 @@ def mock_execute_msvc(args, **kwargs):
     return mock_execute_common(args, **kwargs)
 
 
-class TestFramework(TestCase):
-    def _make_context(self, env):
-        build = BuildInputs(env, Path('build.bfg', Root.srcdir))
-        return builtin.BuildContext(env, build, None)
-
-    def test_framework(self):
-        env = make_env('macos')
-        context = self._make_context(env)
-
-        self.assertEqual(
-            context['framework']('name'),
-            CommonPackage('name', format=env.target_platform.object_format,
-                          link_options=opts.option_list(opts.lib(
-                              Framework('name')
-                          )))
-        )
-
-    def test_framework_suffix(self):
-        env = make_env('macos')
-        context = self._make_context(env)
-
-        self.assertEqual(
-            context['framework']('name', 'suffix'),
-            CommonPackage('name,suffix',
-                          format=env.target_platform.object_format,
-                          link_options=opts.option_list(opts.lib(
-                              Framework('name', 'suffix')
-                          )))
-        )
-
-    def test_frameworks_unsupported(self):
-        env = make_env('linux')
-        context = self._make_context(env)
-
-        with self.assertRaises(PackageResolutionError):
-            context['framework']('name')
-
-        with self.assertRaises(PackageResolutionError):
-            context['framework']('name', 'suffix')
-
-
 class TestPackageCc(BuiltinTestCase):
     mock_execute = staticmethod(mock_execute_cc)
     mock_platform = 'linux'

test/unit/tools/cc/test_linker.py

@@ -9,7 +9,6 @@
 from bfg9000.builtins.install import installify
 from bfg9000.file_types import *
 from bfg9000.tools.cc import CcBuilder
-from bfg9000.packages import Framework
 from bfg9000.path import abspath, InstallRoot, Path, Root
 from bfg9000.versioning import Version
 
@@ -202,7 +201,7 @@ def test_flags_lib_dir(self):
 
         # Framework
         self.assertEqual(self.linker.flags(opts.option_list(
-            opts.lib(Framework('cocoa'))
+            opts.framework('cocoa')
         )), [])
 
         # Mixed
@@ -391,7 +390,7 @@ def test_lib_flags_lib(self):
             ), mode='pkg-config')
 
         # Framework
-        fw = opts.lib(Framework('cocoa'))
+        fw = opts.framework('cocoa')
         if self.env.target_platform.genus == 'darwin':
             self.assertEqual(self.linker.lib_flags(opts.option_list(fw)),
                              ['-framework', 'cocoa'])

test/unit/tools/msvc/test_linker.py

@@ -6,7 +6,6 @@
 from bfg9000 import options as opts
 from bfg9000.file_types import *
 from bfg9000.iterutils import merge_dicts
-from bfg9000.packages import Framework
 from bfg9000.path import Path
 from bfg9000.tools.msvc import MsvcBuilder
 
@@ -186,7 +185,7 @@ def test_lib_flags_lib(self):
 
         with self.assertRaises(TypeError):
             self.linker.lib_flags(opts.option_list(
-                opts.lib(Framework('cocoa'))
+                opts.framework('cocoa')
             ))
 
     def test_lib_flags_lib_literal(self):