summaryrefslogtreecommitdiff
path: root/xmake/core/sandbox/modules/utils.lua
blob: df90492be3bf46a2f02c168e64cdc5814a88be93 (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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
--!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
--

-- load modules
local io         = require("base/io")
local os         = require("base/os")
local utils      = require("base/utils")
local colors     = require("base/colors")
local option     = require("base/option")
local log        = require("base/log")
local deprecated = require("base/deprecated")
local binutils   = require("base/binutils")
local try        = require("sandbox/modules/try")
local catch      = require("sandbox/modules/catch")
local vformat    = require("sandbox/modules/vformat")

-- define module
local sandbox_utils = sandbox_utils or {}

-- inherit some builtin interfaces
sandbox_utils.dump    = utils.dump -- do not change to a function call to utils.dump since debug.getinfo is called in utils.dump to get caller info
sandbox_utils.confirm = utils.confirm
sandbox_utils.error   = utils.error
sandbox_utils.warning = utils.warning
sandbox_utils.trycall = utils.trycall

-- print each arguments
function sandbox_utils._print(...)
    local args = {}
    for _, arg in ipairs({...}) do
        if type(arg) == "string" then
            table.insert(args, vformat(arg))
        else
            table.insert(args, arg)
        end
    end
    utils._print(table.unpack(args))
    log:printv(table.unpack(args))
end

-- print format string with newline
-- print builtin-variables with $(var)
-- print multi-variables with raw lua action
--
function sandbox_utils.print(format, ...)
    if type(format) == "string" and format:find("%", 1, true) then
        local args = {...}
        try {
            function ()
                local message = vformat(format, table.unpack(args))
                utils._print(message)
                log:printv(message)
            end,
            catch {
                function (errors)
                    sandbox_utils._print(format, table.unpack(args))
                end
            }
        }
    else
        sandbox_utils._print(format, ...)
    end
end

-- print format string and the builtin variables without newline
function sandbox_utils.printf(format, ...)
    local message = vformat(format, ...)
    utils._iowrite(message)
    log:write(message)
end

-- print format string, the builtin variables and colors with newline
function sandbox_utils.cprint(format, ...)
    local message = vformat(format, ...)
    utils._print(colors.translate(message))
    if log:file() then
        log:printv(colors.ignore(message))
    end
end

-- print format string, the builtin variables and colors without newline
function sandbox_utils.cprintf(format, ...)
    local message = vformat(format, ...)
    utils._iowrite(colors.translate(message))
    if log:file() then
        log:write(colors.ignore(message))
    end
end

-- print the verbose information
function sandbox_utils.vprint(format, ...)
    if option.get("verbose") then
        sandbox_utils.print(format, ...)
    end
end

-- print the verbose information without newline
function sandbox_utils.vprintf(format, ...)
    if option.get("verbose") then
        sandbox_utils.printf(format, ...)
    end
end

-- print the diagnosis information
function sandbox_utils.dprint(format, ...)
    if option.get("diagnosis") then
        sandbox_utils.print(format, ...)
    end
end

-- print the diagnosis information without newline
function sandbox_utils.dprintf(format, ...)
    if option.get("diagnosis") then
        sandbox_utils.printf(format, ...)
    end
end

-- print the warning information
function sandbox_utils.wprint(format, ...)
    utils.warning(vformat(format, ...))
end

-- assert
function sandbox_utils.assert(value, format, ...)
    if not value then
        if format ~= nil then
            os.raiselevel(2, format, ...)
        else
            os.raiselevel(2, "assertion failed!")
        end
    end
    return value
end

-- generate c/c++ code from the binary file (deprecated, use binutils.bin2c instead)
function sandbox_utils.bin2c(binaryfile, outputfile, opt)
    deprecated.add("binutils.bin2c", "utils.bin2c")
    return binutils.bin2c(binaryfile, outputfile, opt)
end

-- return module
return sandbox_utils