summaryrefslogtreecommitdiff
path: root/xmake/modules/private/action/utils.lua
blob: 5b83a522bf79cec715c34c957b039e21ed1bd1ba (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
--!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        utils.lua
--

-- imports
import("core.base.option")
import("core.project.project")
import("private.detect.check_targetnames")

-- get target name and group pattern from option
function get_target_and_group()
    local targetname
    local group_pattern = option.get("group")
    if group_pattern then
        group_pattern = "^" .. path.pattern(group_pattern) .. "$"
    else
        targetname = option.get("target")
    end
    return targetname, group_pattern
end

-- get target names and group pattern from option
--
-- it supports building multiple targets, e.g. `xmake build target1 target2 ...`
-- and is compatible with the legacy single `target` option passed programmatically.
--
function get_targets_and_group()
    local targetnames
    local group_pattern = option.get("group")
    if group_pattern then
        group_pattern = "^" .. path.pattern(group_pattern) .. "$"
    else
        targetnames = option.get("targets")
        if not targetnames then
            local targetname = option.get("target")
            if targetname then
                targetnames = {targetname}
            end
        end
        if targetnames then
            targetnames = table.wrap(targetnames)
        end
    end
    return targetnames, group_pattern
end

-- get the selected target objects from the given target names
--
-- if explicit target names are given, the matching targets are returned (and checked).
-- otherwise it selects the default/all/group targets, e.g. the actions like
-- build/install/uninstall/package/format share the same selection rule.
--
-- @param targetnames  a list of target names, a single target name, or the magic "__all"/"__def"
-- @param opt          the options, e.g. {group_pattern = ..., all = false}
--
-- @return             the selected target objects (list)
--
function get_targets(targetnames, opt)
    opt = opt or {}

    -- select the explicitly given targets (table.wrap to always get a list back)
    local targets
    if type(targetnames) == "table" or (type(targetnames) == "string" and not targetnames:startswith("__")) then
        targets = assert(check_targetnames(table.wrap(targetnames)))
    else
        -- otherwise select the default/all/group targets
        targets = {}
        local all = opt.all or targetnames == "__all" or option.get("all")
        local group_pattern = opt.group_pattern
        for _, target in ipairs(project.ordertargets()) do
            local group = target:get("group")
            if (target:is_default() and not group_pattern) or all or (group_pattern and group and group:match(group_pattern)) then
                table.insert(targets, target)
            end
        end
    end

    -- remove duplicates, e.g. the same target name may be given more than once
    return table.unique(targets)
end