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 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
|
package pterm
import (
"io"
"time"
"github.com/pterm/pterm/internal"
)
var activeSpinnerPrinters []*SpinnerPrinter
// DefaultSpinner is the default SpinnerPrinter.
var DefaultSpinner = SpinnerPrinter{
Sequence: []string{"▀ ", " ▀", " ▄", "▄ "},
Style: &ThemeDefault.SpinnerStyle,
Delay: time.Millisecond * 200,
ShowTimer: true,
TimerRoundingFactor: time.Second,
TimerStyle: &ThemeDefault.TimerStyle,
MessageStyle: &ThemeDefault.SpinnerTextStyle,
InfoPrinter: &Info,
SuccessPrinter: &Success,
FailPrinter: &Error,
WarningPrinter: &Warning,
}
// SpinnerPrinter is a loading animation, which can be used if the progress is unknown.
// It's an animation loop, which can have a text and supports throwing errors or warnings.
// A TextPrinter is used to display all outputs, after the SpinnerPrinter is done.
type SpinnerPrinter struct {
Text string
Sequence []string
Style *Style
Delay time.Duration
MessageStyle *Style
InfoPrinter TextPrinter
SuccessPrinter TextPrinter
FailPrinter TextPrinter
WarningPrinter TextPrinter
RemoveWhenDone bool
ShowTimer bool
TimerRoundingFactor time.Duration
TimerStyle *Style
IsActive bool
startedAt time.Time
currentSequence string
Writer io.Writer
}
// WithText adds a text to the SpinnerPrinter.
func (s SpinnerPrinter) WithText(text string) *SpinnerPrinter {
s.Text = text
return &s
}
// WithSequence adds a sequence to the SpinnerPrinter.
func (s SpinnerPrinter) WithSequence(sequence ...string) *SpinnerPrinter {
s.Sequence = sequence
return &s
}
// WithStyle adds a style to the SpinnerPrinter.
func (s SpinnerPrinter) WithStyle(style *Style) *SpinnerPrinter {
s.Style = style
return &s
}
// WithDelay adds a delay to the SpinnerPrinter.
func (s SpinnerPrinter) WithDelay(delay time.Duration) *SpinnerPrinter {
s.Delay = delay
return &s
}
// WithMessageStyle adds a style to the SpinnerPrinter message.
func (s SpinnerPrinter) WithMessageStyle(style *Style) *SpinnerPrinter {
s.MessageStyle = style
return &s
}
// WithRemoveWhenDone removes the SpinnerPrinter after it is done.
func (s SpinnerPrinter) WithRemoveWhenDone(b ...bool) *SpinnerPrinter {
s.RemoveWhenDone = internal.WithBoolean(b)
return &s
}
// WithShowTimer shows how long the spinner is running.
func (s SpinnerPrinter) WithShowTimer(b ...bool) *SpinnerPrinter {
s.ShowTimer = internal.WithBoolean(b)
return &s
}
// WithTimerRoundingFactor sets the rounding factor for the timer.
func (s SpinnerPrinter) WithTimerRoundingFactor(factor time.Duration) *SpinnerPrinter {
s.TimerRoundingFactor = factor
return &s
}
// WithTimerStyle adds a style to the SpinnerPrinter timer.
func (s SpinnerPrinter) WithTimerStyle(style *Style) *SpinnerPrinter {
s.TimerStyle = style
return &s
}
// WithWriter sets the custom Writer.
func (p SpinnerPrinter) WithWriter(writer io.Writer) *SpinnerPrinter {
p.Writer = writer
return &p
}
// SetWriter sets the custom Writer.
func (p *SpinnerPrinter) SetWriter(writer io.Writer) {
p.Writer = writer
}
// UpdateText updates the message of the active SpinnerPrinter.
// Can be used live.
func (s *SpinnerPrinter) UpdateText(text string) {
s.Text = text
if !RawOutput {
Fprinto(s.Writer, s.Style.Sprint(s.currentSequence)+" "+s.MessageStyle.Sprint(s.Text))
} else {
Fprintln(s.Writer, s.Text)
}
}
// Start the SpinnerPrinter.
func (s SpinnerPrinter) Start(text ...interface{}) (*SpinnerPrinter, error) {
s.IsActive = true
s.startedAt = time.Now()
activeSpinnerPrinters = append(activeSpinnerPrinters, &s)
if len(text) != 0 {
s.Text = Sprint(text...)
}
if RawOutput {
Fprintln(s.Writer, s.Text)
}
go func() {
for s.IsActive {
for _, seq := range s.Sequence {
if !s.IsActive {
continue
}
if RawOutput {
time.Sleep(s.Delay)
continue
}
var timer string
if s.ShowTimer {
timer = " (" + time.Since(s.startedAt).Round(s.TimerRoundingFactor).String() + ")"
}
Fprinto(s.Writer, s.Style.Sprint(seq)+" "+s.MessageStyle.Sprint(s.Text)+s.TimerStyle.Sprint(timer))
s.currentSequence = seq
time.Sleep(s.Delay)
}
}
}()
return &s, nil
}
// Stop terminates the SpinnerPrinter immediately.
// The SpinnerPrinter will not resolve into anything.
func (s *SpinnerPrinter) Stop() error {
if !s.IsActive {
return nil
}
s.IsActive = false
if s.RemoveWhenDone {
fClearLine(s.Writer)
Fprinto(s.Writer)
} else {
Fprintln(s.Writer)
}
return nil
}
// GenericStart runs Start, but returns a LivePrinter.
// This is used for the interface LivePrinter.
// You most likely want to use Start instead of this in your program.
func (s *SpinnerPrinter) GenericStart() (*LivePrinter, error) {
p2, _ := s.Start()
lp := LivePrinter(p2)
return &lp, nil
}
// GenericStop runs Stop, but returns a LivePrinter.
// This is used for the interface LivePrinter.
// You most likely want to use Stop instead of this in your program.
func (s *SpinnerPrinter) GenericStop() (*LivePrinter, error) {
_ = s.Stop()
lp := LivePrinter(s)
return &lp, nil
}
// Info displays an info message
// If no message is given, the text of the SpinnerPrinter will be reused as the default message.
func (s *SpinnerPrinter) Info(message ...interface{}) {
if s.InfoPrinter == nil {
s.InfoPrinter = &Info
}
if len(message) == 0 {
message = []interface{}{s.Text}
}
fClearLine(s.Writer)
Fprinto(s.Writer, s.InfoPrinter.Sprint(message...))
_ = s.Stop()
}
// Success displays the success printer.
// If no message is given, the text of the SpinnerPrinter will be reused as the default message.
func (s *SpinnerPrinter) Success(message ...interface{}) {
if s.SuccessPrinter == nil {
s.SuccessPrinter = &Success
}
if len(message) == 0 {
message = []interface{}{s.Text}
}
fClearLine(s.Writer)
Fprinto(s.Writer, s.SuccessPrinter.Sprint(message...))
_ = s.Stop()
}
// Fail displays the fail printer.
// If no message is given, the text of the SpinnerPrinter will be reused as the default message.
func (s *SpinnerPrinter) Fail(message ...interface{}) {
if s.FailPrinter == nil {
s.FailPrinter = &Error
}
if len(message) == 0 {
message = []interface{}{s.Text}
}
fClearLine(s.Writer)
Fprinto(s.Writer, s.FailPrinter.Sprint(message...))
_ = s.Stop()
}
// Warning displays the warning printer.
// If no message is given, the text of the SpinnerPrinter will be reused as the default message.
func (s *SpinnerPrinter) Warning(message ...interface{}) {
if s.WarningPrinter == nil {
s.WarningPrinter = &Warning
}
if len(message) == 0 {
message = []interface{}{s.Text}
}
fClearLine(s.Writer)
Fprinto(s.Writer, s.WarningPrinter.Sprint(message...))
_ = s.Stop()
}
|