File: multi_bar.go

package info (click to toggle)
tiup 1.16.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 6,384 kB
  • sloc: sh: 1,988; makefile: 138; sql: 16
file content (119 lines) | stat: -rw-r--r-- 2,612 bytes parent folder | download
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
// Copyright 2020 PingCAP, Inc.
//
// 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,
// See the License for the specific language governing permissions and
// limitations under the License.

package progress

import (
	"bufio"
	"fmt"
	"os"
	"strings"

	"github.com/mattn/go-runewidth"
)

// MultiBarItem controls a bar item inside MultiBar.
type MultiBarItem struct {
	core singleBarCore
}

// UpdateDisplay updates the display property of this bar item.
// This function is thread safe.
func (i *MultiBarItem) UpdateDisplay(newDisplay *DisplayProps) {
	i.core.displayProps.Store(newDisplay)
}

// MultiBar renders multiple progress bars.
type MultiBar struct {
	prefix string

	bars     []*MultiBarItem
	renderer *renderer
}

// NewMultiBar creates a new MultiBar.
func NewMultiBar(prefix string) *MultiBar {
	b := &MultiBar{
		prefix:   prefix,
		bars:     make([]*MultiBarItem, 0),
		renderer: newRenderer(),
	}
	b.renderer.renderFn = b.render
	return b
}

// AddBar adds a new bar item.
// This function is not thread safe. Must be called before render loop is started.
func (b *MultiBar) AddBar(prefix string) *MultiBarItem {
	i := &MultiBarItem{
		core: newSingleBarCore(prefix),
	}
	b.bars = append(b.bars, i)
	return i
}

// StartRenderLoop starts the render loop.
// This function is thread safe.
func (b *MultiBar) StartRenderLoop() {
	b.preRender()
	b.renderer.startRenderLoop()
}

// StopRenderLoop stops the render loop.
// This function is thread safe.
func (b *MultiBar) StopRenderLoop() {
	b.renderer.stopRenderLoop()
}

func (b *MultiBar) preRender() {
	// Preserve space for the bar
	fmt.Print(strings.Repeat("\n", len(b.bars)+1))
}

func (b *MultiBar) render() {
	f := bufio.NewWriter(os.Stdout)

	y := int(termSizeHeight.Load()) - 1
	movedY := 0
	for i := len(b.bars) - 1; i >= 0; i-- {
		moveCursorUp(f, 1)
		y--
		movedY++

		bar := b.bars[i]
		moveCursorToLineStart(f)
		clearLine(f)
		bar.core.renderTo(f)

		if y == 0 {
			break
		}
	}

	// render multi bar prefix
	if y > 0 {
		moveCursorUp(f, 1)
		movedY++

		moveCursorToLineStart(f)
		clearLine(f)
		width := int(termSizeWidth.Load())
		prefix := runewidth.Truncate(b.prefix, width, "...")
		_, _ = fmt.Fprint(f, prefix)
	}

	moveCursorDown(f, movedY)
	moveCursorToLineStart(f)
	clearLine(f)
	_ = f.Flush()
}