progress.go 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117
  1. package progress
  2. import (
  3. "bufio"
  4. "fmt"
  5. "io"
  6. "sync"
  7. "time"
  8. )
  9. type State interface {
  10. String() string
  11. }
  12. type Progress struct {
  13. mu sync.Mutex
  14. // buffer output to minimize flickering on all terminals
  15. w *bufio.Writer
  16. pos int
  17. ticker *time.Ticker
  18. states []State
  19. }
  20. func NewProgress(w io.Writer) *Progress {
  21. p := &Progress{w: bufio.NewWriter(w)}
  22. go p.start()
  23. return p
  24. }
  25. func (p *Progress) stop() bool {
  26. for _, state := range p.states {
  27. if spinner, ok := state.(*Spinner); ok {
  28. spinner.Stop()
  29. }
  30. }
  31. if p.ticker != nil {
  32. p.ticker.Stop()
  33. p.ticker = nil
  34. p.render()
  35. return true
  36. }
  37. return false
  38. }
  39. func (p *Progress) Stop() bool {
  40. stopped := p.stop()
  41. if stopped {
  42. fmt.Fprintln(p.w)
  43. }
  44. // show cursor
  45. fmt.Fprint(p.w, "\033[?25h")
  46. p.w.Flush()
  47. return stopped
  48. }
  49. func (p *Progress) StopAndClear() bool {
  50. stopped := p.stop()
  51. if stopped {
  52. // clear all progress lines
  53. for range p.pos - 1 {
  54. fmt.Fprint(p.w, "\033[A")
  55. }
  56. fmt.Fprint(p.w, "\033[2K", "\033[1G")
  57. }
  58. // show cursor
  59. fmt.Fprint(p.w, "\033[?25h")
  60. p.w.Flush()
  61. return stopped
  62. }
  63. func (p *Progress) Add(key string, state State) {
  64. p.mu.Lock()
  65. defer p.mu.Unlock()
  66. p.states = append(p.states, state)
  67. }
  68. func (p *Progress) render() {
  69. p.mu.Lock()
  70. defer p.mu.Unlock()
  71. fmt.Fprint(p.w, "\033[?2026h")
  72. defer fmt.Fprint(p.w, "\033[?2026l")
  73. for range p.pos - 1 {
  74. fmt.Fprint(p.w, "\033[A")
  75. }
  76. fmt.Fprint(p.w, "\033[1G")
  77. // render progress lines
  78. for i, state := range p.states {
  79. fmt.Fprint(p.w, state.String(), "\033[K")
  80. if i < len(p.states)-1 {
  81. fmt.Fprint(p.w, "\n")
  82. }
  83. }
  84. p.pos = len(p.states)
  85. p.w.Flush()
  86. }
  87. func (p *Progress) start() {
  88. p.ticker = time.NewTicker(100 * time.Millisecond)
  89. // hide cursor
  90. fmt.Fprint(p.w, "\033[?25l")
  91. for range p.ticker.C {
  92. p.render()
  93. }
  94. }