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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
--!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 OpportunityLiu
-- @file progress.lua
--
-- imports
import("core.base.option")
import("core.base.object")
import("core.base.colors")
import("core.base.tty")
import("core.theme.theme")
-- define module
local progress = progress or object { _init = { "_RUNNING", "_INDEX", "_STREAM", "_OPT" } }
-- stop the progress indicator, clear written frames
function progress:stop()
if self._RUNNING ~= 0 then
self:clear()
self._RUNNING = 0
self._INDEX = 0
end
end
function progress:_clear()
if self._RUNNING == 1 then
tty.erase_line_to_end()
self._RUNNING = 2
return true
end
end
-- clear previous frame of the progress indicator
function progress:clear()
if self:_clear() then
self._STREAM:flush()
end
end
-- write next frame of the progress indicator
function progress:write()
local chars = self._OPT.chars[self._INDEX % #self._OPT.chars + 1]
tty.cursor_and_attrs_save()
self._STREAM:write(chars)
self._STREAM:flush()
tty.cursor_and_attrs_restore()
self._INDEX = self._INDEX + 1
self._RUNNING = 1
end
-- check if the progress indicator is running
function progress:running()
return self._RUNNING and true or false
end
-- is scroll output?
function _is_scroll()
local is_scroll = _g.is_scroll
if is_scroll == nil then
local style = theme.get("text.build.progress_style") or "scroll"
if style == "scroll" then
is_scroll = true
end
_g.is_scroll = is_scroll
end
return is_scroll
end
-- is multi-row refresh output?
function _is_multirow_refresh()
local is_multirow_refresh = _g.is_multirow_refresh
if is_multirow_refresh == nil then
local style = theme.get("text.build.progress_style")
if style == "multirow_refresh" and tty.has_vtansi() and io.isatty() then
is_multirow_refresh = true
end
_g.is_multirow_refresh = is_multirow_refresh
end
return is_multirow_refresh
end
-- is single-row refresh output?
function _is_singlerow_refresh()
local is_singlerow_refresh = _g.is_singlerow_refresh
if is_singlerow_refresh == nil then
local style = theme.get("text.build.progress_style")
if style == "singlerow_refresh" and tty.has_vtansi() and io.isatty() then
is_singlerow_refresh = true
end
_g.is_singlerow_refresh = is_singlerow_refresh
end
return is_singlerow_refresh
end
-- show progress with verbose information
function _show_progress_with_verbose(progress, format, ...)
progress = type(progress) == "table" and progress:percent() or math.floor(progress)
local progress_prefix = "${color.build.progress}" .. theme.get("text.build.progress_format") .. ":${clear} "
cprint(progress_prefix .. "${dim}" .. format, progress, ...)
end
-- show progress with scroll
function _show_progress_with_scroll(progress, format, ...)
progress = type(progress) == "table" and progress:percent() or math.floor(progress)
local progress_prefix = "${color.build.progress}" .. theme.get("text.build.progress_format") .. ":${clear} "
cprint(progress_prefix .. format, progress, ...)
end
-- show progress with multi-row refresh
-- @see https://github.com/xmake-io/xmake/issues/6805
function _show_progress_with_multirow_refresh(progress, format, ...)
progress = type(progress) == "table" and progress:percent() or math.floor(progress)
local progress_prefix = "${color.build.progress}" .. theme.get("text.build.progress_format") .. ":${clear} "
-- TODO
print("todo")
end
-- show progress with single-row refresh (ninja style)
function _show_progress_with_singlerow_refresh(progress, format, ...)
progress = type(progress) == "table" and progress:percent() or math.floor(progress)
local progress_prefix = "${color.build.progress}" .. theme.get("text.build.progress_format") .. ":${clear} "
tty.erase_line_to_start().cr()
local msg = vformat(progress_prefix .. format, progress, ...)
local msg_plain = colors.translate(msg, {plain = true})
local maxwidth = os.getwinsize().width
if #msg_plain <= maxwidth then
cprintf(msg)
else
-- windows width is too small? strip the partial message in middle
local partlen = math.floor(maxwidth / 2) - 3
local sep = msg_plain:sub(partlen + 1, #msg_plain - partlen - 1)
local split = msg:split(sep, {plain = true, strict = true})
cprintf(table.concat(split, "..."))
end
if math.floor(progress) == 100 then
print("")
_g.showing_without_scroll = false
else
_g.showing_without_scroll = true
end
io.flush()
end
-- showing progress line without scroll?
function showing_without_scroll()
return _g.showing_without_scroll
end
-- show the message with progress
function show(progress, format, ...)
progress = type(progress) == "table" and progress:percent() or math.floor(progress)
local progress_prefix = "${color.build.progress}" .. theme.get("text.build.progress_format") .. ":${clear} "
if option.get("verbose") then
_show_progress_with_verbose(progress, format, ...)
elseif _is_scroll() then
_show_progress_with_scroll(progress, format, ...)
elseif _is_multirow_refresh() then
_show_progress_with_multirow_refresh(progress, format, ...)
elseif _is_singlerow_refresh() then
_show_progress_with_singlerow_refresh(progress, format, ...)
else
_show_progress_with_scroll(progress, format, ...)
end
end
-- get the message text with progress
function text(progress, format, ...)
progress = type(progress) == "table" and progress:percent() or math.floor(progress)
local progress_prefix = "${color.build.progress}" .. theme.get("text.build.progress_format") .. ":${clear} "
if option.get("verbose") then
return string.format(progress_prefix .. "${dim}" .. format, progress, ...)
else
return string.format(progress_prefix .. format, progress, ...)
end
end
-- build a progress indicator
-- @params stream - stream to write to, will use io.stdout if not provided
-- @params opt - options
-- - chars - an array of chars for progress indicator
function new(stream, opt)
stream = stream or io.stdout
opt = opt or {}
if opt.chars == nil or #opt.chars == 0 then
opt.chars = theme.get("text.spinner.chars")
end
return progress {_OPT = opt, _STREAM = stream, _RUNNING = 0, _INDEX = 0}
end
|
