Merge pull request #7696 from xmake-io/addon

Add addon support for plugins

1 files changed, 50 insertions, 0 deletions

diff --git a/xmake/modules/private/action/require/impl/actions/install.lua b/xmake/modules/private/action/require/impl/actions/install.lua
index 7fb54a951..7ddb66cca 100644
--- a/xmake/modules/private/action/require/impl/actions/install.lua
+++ b/xmake/modules/private/action/require/impl/actions/install.lua
@@ -22,6 +22,7 @@
 import("core.base.option")
 import("core.base.tty")
 import("core.package.package", {alias = "core_package"})
+import("core.package.addon")
 import("core.project.target")
 import("core.project.project")
 import("core.platform.platform")
@@ -283,6 +284,50 @@ function _merge_staticlibs(package)
     end
 end
 
+-- register the installed addon, so that xmake can find its payloads, e.g. plugins
+--
+-- @note the addon manifest(addon.lua) is only read when installing it, everything which
+-- is needed later is recorded in the addons registry, @see core/package/addon.lua
+--
+function _register_addon(package)
+
+    -- get the addon deps from the package recipe
+    local deps
+    for _, dep in ipairs(package:plaindeps() or {}) do
+        if dep:is_addon() then
+            deps = deps or {}
+            table.insert(deps, dep:name())
+        end
+    end
+
+    -- the addon describes itself? we prefer its own description
+    --
+    -- @note the deps are duplicated in its manifest, but the recipe is authoritative,
+    -- xmake needs them before downloading the addon sources, so we only report the
+    -- mismatch, they must be kept in sync
+    --
+    local description = package:description()
+    local manifest = package:data("addon.manifest")
+    if manifest then
+        description = manifest.description or description
+        for _, dep in ipairs(manifest.deps) do
+            if not (deps and table.contains(deps, dep)) then
+                wprint("addon(%s): dep(%s) is declared in its manifest, but not in the package recipe!",
+                    package:name(), dep)
+            end
+        end
+    end
+
+    -- we also record where it comes from, so that the projects can lock it,
+    -- @see xmake/modules/private/action/addon/impl/install_addons.lua
+    local repo = package:repo()
+    addon.register(package:name(), package:version_str() or "latest",
+        {description = description, deps = deps,
+         repo = repo and {url = repo:url(), commit = repo:commit(), branch = repo:branch()} or nil,
+         manifest_deps = manifest and manifest.deps or nil,
+         globalmodules = manifest and #manifest.globalmodules > 0 and manifest.globalmodules or nil})
+end
+
 -- get failed install directory
 function _get_installdir_failed(package)
     return path.join(package:cachedir(), "installdir.failed")
@@ -499,6 +544,11 @@ function main(package)
 
                     -- save the package info to the manifest file
                     package:manifest_save()
+
+                    -- register this addon, so that xmake can find its payloads, e.g. plugins
+                    if package:is_addon() then
+                        _register_addon(package)
+                    end
                     installed_now = true
                 end
             end