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
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2014-2024 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
import class TSCBasic.TerminalController
import protocol TSCBasic.WritableByteStream
extension ProgressAnimation {
/// A percent-based progress animation that adapts to the provided output stream.
@_spi(SwiftPMInternal)
public static func percent(
stream: WritableByteStream,
verbose: Bool,
header: String
) -> any ProgressAnimationProtocol {
Self.dynamic(
stream: stream,
verbose: verbose,
ttyTerminalAnimationFactory: { RedrawingPercentProgressAnimation(terminal: $0, header: header) },
dumbTerminalAnimationFactory: { SingleLinePercentProgressAnimation(stream: stream, header: header) },
defaultAnimationFactory: { MultiLinePercentProgressAnimation(stream: stream, header: header) }
)
}
}
/// A redrawing lit-like progress animation.
final class RedrawingPercentProgressAnimation: ProgressAnimationProtocol {
private let terminal: TerminalController
private let header: String
private var hasDisplayedHeader = false
init(terminal: TerminalController, header: String) {
self.terminal = terminal
self.header = header
}
/// Creates repeating string for count times.
/// If count is negative, returns empty string.
private func repeating(string: String, count: Int) -> String {
return String(repeating: string, count: max(count, 0))
}
func update(step: Int, total: Int, text: String) {
assert(step <= total)
let width = terminal.width
if !hasDisplayedHeader {
let spaceCount = width / 2 - header.utf8.count / 2
terminal.write(repeating(string: " ", count: spaceCount))
terminal.write(header, inColor: .cyan, bold: true)
terminal.endLine()
hasDisplayedHeader = true
} else {
terminal.moveCursor(up: 1)
}
terminal.clearLine()
let percentage = step * 100 / total
let paddedPercentage = percentage < 10 ? " \(percentage)" : "\(percentage)"
let prefix = "\(paddedPercentage)% " + terminal.wrap("[", inColor: .green, bold: true)
terminal.write(prefix)
let barWidth = width - prefix.utf8.count
let n = Int(Double(barWidth) * Double(percentage) / 100.0)
terminal.write(repeating(string: "=", count: n) + repeating(string: "-", count: barWidth - n), inColor: .green)
terminal.write("]", inColor: .green, bold: true)
terminal.endLine()
terminal.clearLine()
if text.utf8.count > width {
let prefix = "…"
terminal.write(prefix)
terminal.write(String(text.suffix(width - prefix.utf8.count)))
} else {
terminal.write(text)
}
}
func complete(success: Bool) {
terminal.endLine()
terminal.endLine()
}
func clear() {
terminal.clearLine()
terminal.moveCursor(up: 1)
terminal.clearLine()
}
}
/// A multi-line percent-based progress animation.
final class MultiLinePercentProgressAnimation: ProgressAnimationProtocol {
private struct Info: Equatable {
let percentage: Int
let text: String
}
private let stream: WritableByteStream
private let header: String
private var hasDisplayedHeader = false
private var lastDisplayedText: String? = nil
init(stream: WritableByteStream, header: String) {
self.stream = stream
self.header = header
}
func update(step: Int, total: Int, text: String) {
assert(step <= total)
if !hasDisplayedHeader, !header.isEmpty {
stream.send(header)
stream.send("\n")
stream.flush()
hasDisplayedHeader = true
}
let percentage = step * 100 / total
stream.send("\(percentage)%: ").send(text)
stream.send("\n")
stream.flush()
lastDisplayedText = text
}
func complete(success: Bool) {
}
func clear() {
}
}
|
