Merge pull request #6116 from xmake-io/iar

Add support for IAR ARM embedded toolchain

11 files changed, 593 insertions, 0 deletions

diff --git a/CHANGELOG.md b/CHANGELOG.md
index be165a285..ccafe2cf1 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -12,6 +12,7 @@
 * [#6054](https://github.com/xmake-io/xmake/issues/6054): Add xmake bundle for linux
 * [#6071](https://github.com/xmake-io/xmake/issues/6071): Improve to download package for git url, support for sparse-checkout
 * [#5163](https://github.com/xmake-io/xmake/issues/5163): Support TI-CGT C2000/C6000 compiler
+* [#5344](https://github.com/xmake-io/xmake/issues/5344): Support IAR ARM C/C++ compiler
 * [#5554](https://github.com/xmake-io/xmake/issues/5554): Add custom unknown toolchains support
 
 ### Changes
@@ -1952,6 +1953,7 @@
 * [#6054](https://github.com/xmake-io/xmake/issues/6054): 为 linux 添加 xmake bundle 包
 * [#6071](https://github.com/xmake-io/xmake/issues/6071): 改进 git 包下载，支持仅仅 clone 指定子目录
 * [#5163](https://github.com/xmake-io/xmake/issues/5163): 支持 TI-CGT C2000/C6000 编译器
+* [#5344](https://github.com/xmake-io/xmake/issues/5344): 支持 IAR ARM C/C++ 编译器
 * [#5554](https://github.com/xmake-io/xmake/issues/5554): 添加自定义未知工具链支持
 
 ### 改进
diff --git a/README.md b/README.md
index 88105aaa6..25e3247d5 100644
--- a/README.md
+++ b/README.md
@@ -248,6 +248,7 @@ cosmocc       build-once run-anywhere
 hdk           Harmony SDK
 ti-c2000      TI-CGT C2000 compiler
 ti-c6000      TI-CGT C6000 compiler
+iararm        IAR ARM C/C++ Compiler
 ```
 
 ## Supported languages
diff --git a/README_zh.md b/README_zh.md
index 8ac310a44..ba8929c26 100644
--- a/README_zh.md
+++ b/README_zh.md
@@ -309,6 +309,7 @@ cosmocc       build-once run-anywhere
 hdk           Harmony SDK
 ti-c2000      TI-CGT C2000 compiler
 ti-c6000      TI-CGT C6000 compiler
+iararm        IAR ARM C/C++ Compiler
 ```
 
 ## 支持语言
diff --git a/xmake/modules/core/tools/iarchive.lua b/xmake/modules/core/tools/iarchive.lua
new file mode 100644
index 000000000..2813650f9
--- /dev/null
+++ b/xmake/modules/core/tools/iarchive.lua
@@ -0,0 +1,25 @@
+--!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, TBOOX Open Source Group.
+--
+-- @author      ruki
+-- @file        iarchive.lua
+--
+
+inherit("ar")
+
+function init(self)
+    self:set("arflags", "--create")
+end
diff --git a/xmake/modules/core/tools/iccarm.lua b/xmake/modules/core/tools/iccarm.lua
new file mode 100644
index 000000000..4764761a1
--- /dev/null
+++ b/xmake/modules/core/tools/iccarm.lua
@@ -0,0 +1,155 @@
+--!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, TBOOX Open Source Group.
+--
+-- @author      ruki
+-- @file        iccarm.lua
+--
+
+-- imports
+import("core.base.option")
+import("core.base.global")
+import("core.project.policy")
+import("core.language.language")
+import("utils.progress")
+
+-- init it
+function init(self)
+end
+
+-- make the symbol flag
+function nf_symbol(self, level)
+    -- only for source kind
+    local kind = self:kind()
+    if language.sourcekinds()[kind] then
+        local maps = _g.symbol_maps
+        if not maps then
+            maps =
+            {
+                debug  = "--debug"
+            }
+            _g.symbol_maps = maps
+        end
+        return maps[level .. '_' .. kind] or maps[level]
+    end
+end
+
+-- make the optimize flag
+function nf_optimize(self, level)
+    local maps =
+    {
+        none       = "-On"
+    ,   fast       = "-Ol"
+    ,   faster     = "-Om"
+    ,   fastest    = "-Oh"
+    ,   smallest   = "-Ohz"
+    ,   aggressive = "-Ohs"
+    }
+    return maps[level]
+end
+
+-- make the vector extension flag
+function nf_vectorext(self, extension)
+    local maps = {
+        all = "--vectorize"
+    }
+    return maps[extension]
+end
+
+-- make the language flag
+function nf_language(self, stdname)
+    if _g.cmaps == nil then
+        _g.cmaps = {
+            c89 = "--c89"
+        }
+    end
+    return _g.cmaps[stdname]
+end
+
+-- make the define flag
+function nf_define(self, macro)
+    return "-D" .. macro
+end
+
+-- make the undefine flag
+function nf_undefine(self, macro)
+    return "-U" .. macro
+end
+
+-- make the includedir flag
+function nf_includedir(self, dir)
+    return {"-I" .. dir}
+end
+
+-- make the compile arguments list
+function compargv(self, sourcefile, objectfile, flags)
+    return self:program(), table.join("-c", flags, "-o", objectfile, sourcefile)
+end
+
+-- compile the source file
+function compile(self, sourcefile, objectfile, dependinfo, flags, opt)
+    os.mkdir(path.directory(objectfile))
+    try
+    {
+        function ()
+            local compflags = flags
+            local outdata, errdata = os.iorunv(compargv(self, sourcefile, objectfile, compflags))
+            return (outdata or "") .. (errdata or "")
+        end,
+        catch
+        {
+            function (errors)
+
+                -- try removing the old object file for forcing to rebuild this source file
+                os.tryrm(objectfile)
+
+                -- find the start line of error
+                local lines = tostring(errors):split("\n")
+                local start = 0
+                for index, line in ipairs(lines) do
+                    if line:find("error:", 1, true) or line:find("错误：", 1, true) then
+                        start = index
+                        break
+                    end
+                end
+
+                -- get 16 lines of errors
+                if start > 0 or not option.get("verbose") then
+                    if start == 0 then start = 1 end
+                    errors = table.concat(table.slice(lines, start, start + ((#lines - start > 16) and 16 or (#lines - start))), "\n")
+                end
+
+                -- raise compiling errors
+                raise(errors)
+            end
+        },
+        finally
+        {
+            function (ok, warnings)
+
+                -- print some warnings
+                if warnings and #warnings > 0 and not warnings:find("Warnings: none", 1, true) and policy.build_warnings(opt) then
+                    if progress.showing_without_scroll() then
+                        print("")
+                    end
+                    cprint("${color.warning}%s", table.concat(table.slice(warnings:split('\n'), 1, 8), '\n'))
+                end
+            end
+        }
+    }
+end
+
+
+
diff --git a/xmake/modules/core/tools/iccarm/has_flags.lua b/xmake/modules/core/tools/iccarm/has_flags.lua
new file mode 100644
index 000000000..60701136a
--- /dev/null
+++ b/xmake/modules/core/tools/iccarm/has_flags.lua
@@ -0,0 +1,121 @@
+--!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, TBOOX Open Source Group.
+--
+-- @author      ruki
+-- @file        has_flags.lua
+--
+
+-- imports
+import("core.cache.detectcache")
+import("core.language.language")
+
+-- is linker?
+function _islinker(flags, opt)
+    local toolkind = opt.toolkind or ""
+    return toolkind == "ld" or toolkind == "sh" or toolkind:endswith("ld") or toolkind:endswith("sh")
+end
+
+-- try running
+function _try_running(program, argv, opt)
+    local errors = nil
+    return try { function () os.runv(program, argv, opt); return true end, catch { function (errs) errors = (errs or ""):trim() end }}, errors
+end
+
+-- attempt to check it from known flags
+function _check_from_knownargs(flags, opt, islinker)
+    local flag = flags[1]
+    if not islinker then
+        if flag:startswith("-D") or
+           flag:startswith("-U") or
+           flag:startswith("-I") then
+            return true
+        end
+    end
+end
+
+-- attempt to check it from the argument list
+function _check_from_arglist(flags, opt, islinker)
+    local key = "core.tools.iccarm." .. (islinker and "has_ldflags" or "has_cflags")
+    local flagskey = opt.program .. "_" .. (opt.programver or "")
+    local allflags = detectcache:get2(key, flagskey)
+    if not allflags then
+        allflags = {}
+        local arglist = try {function () return os.iorunv(opt.program, {"--help"}, {envs = opt.envs}) end}
+        if arglist then
+            for arg in arglist:gmatch("%s+(%-[%-%a%d]+)%s+") do
+                allflags[arg] = true
+            end
+        end
+        detectcache:set2(key, flagskey, allflags)
+        detectcache:save()
+    end
+    local flag = flags[1]
+    return allflags[flag]
+end
+
+-- get extension
+function _get_extension(opt)
+    -- @note we need to detect extension for ndk/clang++.exe: warning: treating 'c' input as 'c++' when in C++ mode, this behavior is deprecated [-Wdeprecated]
+    return (opt.program:endswith("++") or opt.flagkind == "cxxflags") and ".cpp" or (table.wrap(language.sourcekinds()[opt.toolkind or "cc"])[1] or ".c")
+end
+
+-- try running to check flags
+function _check_try_running(flags, opt, islinker)
+
+    -- make an stub source file
+    local snippet = opt.snippet or "int main(int argc, char** argv)\n{return 0;}\n"
+    local sourcefile = os.tmpfile("iccarm_has_flags:" .. snippet) .. _get_extension(opt)
+    if not os.isfile(sourcefile) then
+        io.writefile(sourcefile, snippet)
+    end
+
+    -- check flags for linker
+    local tmpfile = os.tmpfile()
+    if islinker then
+        return _try_running(opt.program, table.join(flags, "-o", tmpfile, sourcefile), opt)
+    end
+
+    -- check flags for compiler
+    -- @note we cannot use os.nuldev() as the output file, maybe run failed for some flags, e.g. --coverage
+    return _try_running(opt.program, table.join(flags, "-c", "-o", tmpfile, sourcefile), opt)
+end
+
+-- has_flags(flags)?
+--
+-- @param opt   the argument options, e.g. {toolname = "", program = "", programver = "", toolkind = "[cc|cxx|ld|ar|sh|gc|mm|mxx]"}
+--
+-- @return      true or false
+--
+function main(flags, opt)
+
+    -- is linker?
+    opt = opt or {}
+    local islinker = _islinker(flags, opt)
+
+    -- attempt to check it from the argument list
+    if not opt.tryrun then
+        if _check_from_arglist(flags, opt, islinker) then
+            return true
+        end
+        if _check_from_knownargs(flags, opt, islinker) then
+            return true
+        end
+    end
+
+    -- try running to check it
+    return _check_try_running(flags, opt, islinker)
+end
+
diff --git a/xmake/modules/core/tools/ilinkarm.lua b/xmake/modules/core/tools/ilinkarm.lua
new file mode 100644
index 000000000..9fbb03639
--- /dev/null
+++ b/xmake/modules/core/tools/ilinkarm.lua
@@ -0,0 +1,73 @@
+--!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, TBOOX Open Source Group.
+--
+-- @author      ruki
+-- @file        ilinkarm.lua
+--
+
+-- imports
+import("core.base.option")
+import("core.base.global")
+import("core.project.policy")
+import("core.language.language")
+import("utils.progress")
+
+-- make the strip flag
+function nf_strip(self, level)
+    local maps = {
+        debug = "--strip"
+    ,   all   = "--strip"
+    }
+    return maps[level]
+end
+
+-- make the link flag
+function nf_link(self, lib)
+    return "-l" .. lib
+end
+
+-- make the syslink flag
+function nf_syslink(self, lib)
+    return nf_link(self, lib)
+end
+
+-- make the linkdir flag
+function nf_linkdir(self, dir)
+    return {"-L" .. path.translate(dir)}
+end
+
+-- make the link arguments list
+function linkargv(self, objectfiles, targetkind, targetfile, flags, opt)
+    local argv = table.join("-o", targetfile, objectfiles, flags)
+    return self:program(), argv
+end
+
+-- link the target file
+--
+-- maybe we need to use os.vrunv() to show link output when enable verbose information
+-- @see https://github.com/xmake-io/xmake/discussions/2916
+--
+function link(self, objectfiles, targetkind, targetfile, flags, opt)
+    opt = opt or {}
+    os.mkdir(path.directory(targetfile))
+    local program, argv = linkargv(self, objectfiles, targetkind, targetfile, flags)
+    if option.get("verbose") then
+        os.execv(program, argv, {envs = self:runenvs(), shell = opt.shell})
+    else
+        os.vrunv(program, argv, {envs = self:runenvs(), shell = opt.shell})
+    end
+end
+
diff --git a/xmake/modules/detect/tools/find_iarchive.lua b/xmake/modules/detect/tools/find_iarchive.lua
new file mode 100644
index 000000000..fda783449
--- /dev/null
+++ b/xmake/modules/detect/tools/find_iarchive.lua
@@ -0,0 +1,57 @@
+--!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, TBOOX Open Source Group.
+--
+-- @author      ruki
+-- @file        find_iarchive.lua
+--
+
+-- imports
+import("lib.detect.find_program")
+import("lib.detect.find_programver")
+import("detect.sdks.find_iarsdk")
+
+-- find iarchive
+--
+-- @param opt   the argument options, e.g. {version = true}
+--
+-- @return      program, version
+--
+-- @code
+--
+-- local iarchive = find_iarchive()
+-- local iarchive, version = find_iarchive({program = "iarchive", version = true})
+--
+-- @endcode
+--
+function main(opt)
+    opt = opt or {}
+
+    -- find program
+    local program = find_program(opt.program or "iarchive.exe", opt)
+    if not program then
+        local iarsdk = find_iarsdk()
+        if iarsdk and iarsdk.sdkdir then
+            program = find_program(path.join(iarsdk.sdkdir, "bin", "iarchive.exe"), opt)
+        end
+    end
+
+    -- find program version
+    local version = nil
+    if program and opt.version then
+        version = find_programver(program, opt)
+    end
+    return program, version
+end
diff --git a/xmake/modules/detect/tools/find_iasmarm.lua b/xmake/modules/detect/tools/find_iasmarm.lua
new file mode 100644
index 000000000..0cba9a347
--- /dev/null
+++ b/xmake/modules/detect/tools/find_iasmarm.lua
@@ -0,0 +1,57 @@
+--!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, TBOOX Open Source Group.
+--
+-- @author      ruki
+-- @file        find_iasmarm.lua
+--
+
+-- imports
+import("lib.detect.find_program")
+import("lib.detect.find_programver")
+import("detect.sdks.find_iarsdk")
+
+-- find iasmarm
+--
+-- @param opt   the argument options, e.g. {version = true}
+--
+-- @return      program, version
+--
+-- @code
+--
+-- local iasmarm = find_iasmarm()
+-- local iasmarm, version = find_iasmarm({program = "iasmarm", version = true})
+--
+-- @endcode
+--
+function main(opt)
+    opt = opt or {}
+
+    -- find program
+    local program = find_program(opt.program or "iasmarm.exe", opt)
+    if not program then
+        local iarsdk = find_iarsdk()
+        if iarsdk and iarsdk.sdkdir then
+            program = find_program(path.join(iarsdk.sdkdir, "bin", "iasmarm.exe"), opt)
+        end
+    end
+
+    -- find program version
+    local version = nil
+    if program and opt.version then
+        version = find_programver(program, opt)
+    end
+    return program, version
+end
diff --git a/xmake/modules/detect/tools/find_ilinkarm.lua b/xmake/modules/detect/tools/find_ilinkarm.lua
new file mode 100644
index 000000000..53c19612d
--- /dev/null
+++ b/xmake/modules/detect/tools/find_ilinkarm.lua
@@ -0,0 +1,57 @@
+--!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, TBOOX Open Source Group.
+--
+-- @author      ruki
+-- @file        find_ilinkarm.lua
+--
+
+-- imports
+import("lib.detect.find_program")
+import("lib.detect.find_programver")
+import("detect.sdks.find_iarsdk")
+
+-- find ilinkarm
+--
+-- @param opt   the argument options, e.g. {version = true}
+--
+-- @return      program, version
+--
+-- @code
+--
+-- local ilinkarm = find_ilinkarm()
+-- local ilinkarm, version = find_ilinkarm({program = "ilinkarm", version = true})
+--
+-- @endcode
+--
+function main(opt)
+    opt = opt or {}
+
+    -- find program
+    local program = find_program(opt.program or "ilinkarm.exe", opt)
+    if not program then
+        local iarsdk = find_iarsdk()
+        if iarsdk and iarsdk.sdkdir then
+            program = find_program(path.join(iarsdk.sdkdir, "bin", "ilinkarm.exe"), opt)
+        end
+    end
+
+    -- find program version
+    local version = nil
+    if program and opt.version then
+        version = find_programver(program, opt)
+    end
+    return program, version
+end
diff --git a/xmake/toolchains/iararm/xmake.lua b/xmake/toolchains/iararm/xmake.lua
new file mode 100644
index 000000000..d213802c9
--- /dev/null
+++ b/xmake/toolchains/iararm/xmake.lua
@@ -0,0 +1,44 @@
+--!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, TBOOX Open Source Group.
+--
+-- @author      ruki
+-- @file        xmake.lua
+--
+
+toolchain("iararm")
+    set_kind("standalone")
+    set_homepage("https://www.iar.com/products/architectures/arm/iar-embedded-workbench-for-arm/")
+    set_description("IAR ARM C/C++ Compiler")
+
+    set_toolset("cc", "iccarm")
+    set_toolset("cxx", "iccarm")
+    set_toolset("ld", "ilinkarm")
+    set_toolset("sh", "ilinkarm")
+    set_toolset("ar", "iarchive")
+    set_toolset("as", "iccarm")
+
+    on_check(function (toolchain)
+        return import("lib.detect.find_tool")("iccarm")
+    end)
+
+    on_load(function (toolchain)
+        local arch = toolchain:arch()
+        if arch then
+            toolchain:add("cxflags", "--cpu " .. arch)
+            toolchain:add("asflags", "--cpu " .. arch)
+            toolchain:add("ldflags", "--cpu " .. arch)
+        end
+    end)