Merge pull request #7062 from xmake-io/dmg

Add dmg xpack format

7 files changed, 247 insertions, 2 deletions

diff --git a/xmake/modules/detect/tools/find_hdiutil.lua b/xmake/modules/detect/tools/find_hdiutil.lua
new file mode 100644
index 000000000..c2d0d2a3b
--- /dev/null
+++ b/xmake/modules/detect/tools/find_hdiutil.lua
@@ -0,0 +1,64 @@
+--!A cross-platform build utility based on Lua
+--
+-- Licensed under the Apache License, Version 2.0 (the "License");
+-- you may not use this file except in compliance with the License.
+-- You may obtain a copy of the License at
+--
+--     http://www.apache.org/licenses/LICENSE-2.0
+--
+-- Unless required by applicable law or agreed to in writing, software
+-- distributed under the License is distributed on an "AS IS" BASIS,
+-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+-- See the License for the specific language governing permissions and
+-- limitations under the License.
+--
+-- Copyright (C) 2015-present, Xmake Open Source Community.
+--
+-- @author      ruki
+-- @file        find_hdiutil.lua
+--
+
+-- imports
+import("lib.detect.find_program")
+import("lib.detect.find_programver")
+
+-- find hdiutil
+--
+-- @param opt   the argument options, e.g. {version = true}
+--
+-- @return      program, version
+--
+-- @code
+--
+-- local hdiutil = find_hdiutil()
+-- local hdiutil, version = find_hdiutil({version = true})
+--
+-- @endcode
+--
+function main(opt)
+
+    -- only for macosx
+    if not is_host("macosx") then
+        return
+    end
+
+    -- init options
+    opt = opt or {}
+    opt.check = opt.check or "help"
+
+    -- find program
+    local program = find_program(opt.program or "hdiutil", opt)
+
+    -- find program version
+    local version = nil
+    if program and opt and opt.version then
+        opt.command = opt.command or "info"
+        opt.parse = opt.parse or function (output)
+            -- extract version from "framework : 671.140.2" or "driver : 671.140.2"
+            return output:match("framework%s*:%s*(%d+%.%d+%.%d+)") or output:match("driver%s*:%s*(%d+%.%d+%.%d+)")
+        end
+        version = find_programver(program, opt)
+    end
+    return program, version
+end
+
diff --git a/xmake/plugins/pack/batchcmds.lua b/xmake/plugins/pack/batchcmds.lua
index b67d66b5b..09b42d7c9 100644
--- a/xmake/plugins/pack/batchcmds.lua
+++ b/xmake/plugins/pack/batchcmds.lua
@@ -334,6 +334,17 @@ function _on_target_installcmd(target, batchcmds_, opt)
         return
     end
 
+    -- check if target rules have on_installcmd, use rule's logic first
+    local done = false
+    for _, r in ipairs(target:orderules()) do
+        local on_installcmd = r:script("installcmd")
+        if on_installcmd then
+            on_installcmd(target, batchcmds_, opt)
+            done = true
+        end
+    end
+    if done then return end
+
     -- install target binaries
     local scripts = {
         binary     = _on_target_installcmd_binary,
@@ -416,6 +427,17 @@ function _on_target_uninstallcmd(target, batchcmds_, opt)
         return
     end
 
+    -- check if target rules have on_uninstallcmd, use rule's logic first
+    local done = false
+    for _, r in ipairs(target:orderules()) do
+        local on_uninstallcmd = r:script("uninstallcmd")
+        if on_uninstallcmd then
+            on_uninstallcmd(target, batchcmds_, opt)
+            done = true
+        end
+    end
+    if done then return end
+
     -- uninstall target binaries
     local scripts = {
         binary     = _on_target_uninstallcmd_binary,
diff --git a/xmake/plugins/pack/dmg/main.lua b/xmake/plugins/pack/dmg/main.lua
new file mode 100644
index 000000000..54fb30f5a
--- /dev/null
+++ b/xmake/plugins/pack/dmg/main.lua
@@ -0,0 +1,85 @@
+--!A cross-platform build utility based on Lua
+--
+-- Licensed under the Apache License, Version 2.0 (the "License");
+-- you may not use this file except in compliance with the License.
+-- You may obtain a copy of the License at
+--
+--     http://www.apache.org/licenses/LICENSE-2.0
+--
+-- Unless required by applicable law or agreed to in writing, software
+-- distributed under the License is distributed on an "AS IS" BASIS,
+-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+-- See the License for the specific language governing permissions and
+-- limitations under the License.
+--
+-- Copyright (C) 2015-present, Xmake Open Source Community.
+--
+-- @author      ruki
+-- @file        main.lua
+--
+
+-- imports
+import("core.base.option")
+import("lib.detect.find_tool")
+import(".batchcmds")
+
+-- pack dmg package
+function _pack_dmg(package)
+
+    -- check platform
+    assert(package:is_plat("macosx"), "dmg format only supports macOS platform!")
+
+    -- get hdiutil
+    local hdiutil = find_tool("hdiutil")
+    assert(hdiutil, "hdiutil not found! Please install Xcode Command Line Tools.")
+
+    -- archive binary files
+    batchcmds.get_installcmds(package):runcmds()
+    for _, component in table.orderpairs(package:components()) do
+        if component:get("default") ~= false then
+            batchcmds.get_installcmds(component):runcmds()
+        end
+    end
+
+    -- get install root directory
+    local rootdir = package:install_rootdir()
+    assert(os.isdir(rootdir), "install root directory not found: %s", rootdir)
+
+    -- get output file
+    local outputfile = package:outputfile()
+    os.tryrm(outputfile)
+
+    -- create directory for DMG in builddir
+    local builddir = package:builddir()
+    local dmgdir = path.join(builddir, "dmg")
+    os.tryrm(dmgdir)
+    os.mkdir(dmgdir)
+
+    -- copy files to DMG directory
+    local dmgname = path.basename(outputfile, ".dmg")
+    local dmgcontentdir = path.join(dmgdir, dmgname)
+    os.cp(rootdir, dmgcontentdir)
+
+    -- create DMG using hdiutil
+    -- create a read-only DMG with UDZO format (compressed)
+    local argv = {
+        "create",
+        "-volname", package:title() or package:name() or dmgname,
+        "-srcfolder", dmgcontentdir,
+        "-ov",
+        "-format", "UDZO",
+        outputfile
+    }
+
+    -- run hdiutil
+    os.vrunv(hdiutil.program, argv)
+
+    -- verify DMG was created
+    assert(os.isfile(outputfile), "generate %s failed!", outputfile)
+end
+
+function main(package)
+    cprint("packing %s .. ", package:outputfile())
+    _pack_dmg(package)
+end
+
diff --git a/xmake/plugins/pack/xpack.lua b/xmake/plugins/pack/xpack.lua
index 6382a7370..1e39d6a83 100644
--- a/xmake/plugins/pack/xpack.lua
+++ b/xmake/plugins/pack/xpack.lua
@@ -205,6 +205,7 @@ function xpack:inputkind()
             nsis     = "binary",
             zip      = "binary",
             targz    = "binary",
+            dmg      = "binary",
             srczip   = "source",
             srctargz = "source",
             runself  = "source",
@@ -224,6 +225,7 @@ function xpack:outputkind()
         nsis     = "binary",
         zip      = "binary",
         targz    = "binary",
+        dmg      = "binary",
         srczip   = "source",
         srctargz = "source",
         runself  = "source",
@@ -373,6 +375,7 @@ function xpack:extension()
             nsis     = ".exe",
             zip      = ".zip",
             targz    = ".tar.gz",
+            dmg      = ".dmg",
             srczip   = ".zip",
             srctargz = ".tar.gz",
             runself  = ".gz.run",
diff --git a/xmake/rules/xcode/application/build.lua b/xmake/rules/xcode/application/build.lua
index a98baf57a..8ea734d28 100644
--- a/xmake/rules/xcode/application/build.lua
+++ b/xmake/rules/xcode/application/build.lua
@@ -24,8 +24,6 @@ import("core.theme.theme")
 import("core.project.depend")
 import("private.tools.codesign")
 import("utils.progress")
-
--- main entry
 function main (target, opt)
 
     -- get app and resources directory
diff --git a/xmake/rules/xcode/application/installcmd.lua b/xmake/rules/xcode/application/installcmd.lua
new file mode 100644
index 000000000..c08a0fede
--- /dev/null
+++ b/xmake/rules/xcode/application/installcmd.lua
@@ -0,0 +1,70 @@
+--!A cross-platform build utility based on Lua
+--
+-- Licensed under the Apache License, Version 2.0 (the "License");
+-- you may not use this file except in compliance with the License.
+-- You may obtain a copy of the License at
+--
+--     http://www.apache.org/licenses/LICENSE-2.0
+--
+-- Unless required by applicable law or agreed to in writing, software
+-- distributed under the License is distributed on an "AS IS" BASIS,
+-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+-- See the License for the specific language governing permissions and
+-- limitations under the License.
+--
+-- Copyright (C) 2015-present, Xmake Open Source Community.
+--
+-- @author      ruki
+-- @file        installcmd.lua
+--
+
+-- install application for xpack
+function main(target, batchcmds, opt)
+    local package = opt.package
+    
+    -- only for macosx when packing
+    if not target:is_plat("macosx") then
+        return
+    end
+
+    -- only for xpack (package exists)
+    if not package then
+        return
+    end
+
+    -- get app directory
+    local appdir = target:data("xcode.bundle.rootdir")
+    if not appdir or not os.isdir(appdir) then
+        return
+    end
+
+    -- get install directory
+    -- for dmg packing, we install .app to the root of install directory
+    local installdir = package:installdir()
+    if not installdir then
+        return
+    end
+
+    -- copy .app to install directory
+    local appname = path.filename(appdir)
+    local dstappdir = path.join(installdir, appname)
+    batchcmds:cp(appdir, dstappdir, {symlink = true})
+
+    -- install target files (skip binary installation)
+    local srcfiles, dstfiles = target:installfiles(installdir)
+    if srcfiles and dstfiles then
+        for idx, srcfile in ipairs(srcfiles) do
+            batchcmds:cp(srcfile, dstfiles[idx], {symlink = true})
+        end
+    end
+    -- install dependent target files
+    for _, dep in ipairs(target:orderdeps()) do
+        local srcfiles, dstfiles = dep:installfiles(installdir, {interface = true})
+        if srcfiles and dstfiles then
+            for idx, srcfile in ipairs(srcfiles) do
+                batchcmds:cp(srcfile, dstfiles[idx], {symlink = true})
+            end
+        end
+    end
+end
+
diff --git a/xmake/rules/xcode/application/xmake.lua b/xmake/rules/xcode/application/xmake.lua
index ecffaeeac..8af79a585 100644
--- a/xmake/rules/xcode/application/xmake.lua
+++ b/xmake/rules/xcode/application/xmake.lua
@@ -36,6 +36,9 @@ rule("xcode.application")
     -- install application
     on_install("install")
 
+    -- install application for xpack
+    on_installcmd("installcmd")
+
     -- uninstall application
     on_uninstall("uninstall")