Terminal-based user interface toolkit
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 

192 lines
4.1 KiB

package cview
import (
"math"
"sync"
"github.com/gdamore/tcell/v2"
)
// ProgressBar indicates the progress of an operation.
type ProgressBar struct {
*Box
// Rune to use when rendering the empty area of the progress bar.
emptyRune rune
// Color of the empty area of the progress bar.
emptyColor tcell.Color
// Rune to use when rendering the filled area of the progress bar.
filledRune rune
// Color of the filled area of the progress bar.
filledColor tcell.Color
// If set to true, instead of filling from left to right, the bar is filled
// from bottom to top.
vertical bool
// Current progress.
progress int
// Progress required to fill the bar.
max int
sync.RWMutex
}
// NewProgressBar returns a new progress bar.
func NewProgressBar() *ProgressBar {
p := &ProgressBar{
Box: NewBox(),
emptyRune: tcell.RuneBlock,
emptyColor: Styles.PrimitiveBackgroundColor,
filledRune: tcell.RuneBlock,
filledColor: Styles.PrimaryTextColor,
max: 100,
}
p.SetBackgroundColor(Styles.PrimitiveBackgroundColor)
return p
}
// SetEmptyRune sets the rune used for the empty area of the progress bar.
func (p *ProgressBar) SetEmptyRune(empty rune) {
p.Lock()
defer p.Unlock()
p.emptyRune = empty
}
// SetEmptyColor sets the color of the empty area of the progress bar.
func (p *ProgressBar) SetEmptyColor(empty tcell.Color) {
p.Lock()
defer p.Unlock()
p.emptyColor = empty
}
// SetFilledRune sets the rune used for the filled area of the progress bar.
func (p *ProgressBar) SetFilledRune(filled rune) {
p.Lock()
defer p.Unlock()
p.filledRune = filled
}
// SetFilledColor sets the color of the filled area of the progress bar.
func (p *ProgressBar) SetFilledColor(filled tcell.Color) {
p.Lock()
defer p.Unlock()
p.filledColor = filled
}
// SetVertical sets the direction of the progress bar.
func (p *ProgressBar) SetVertical(vertical bool) {
p.Lock()
defer p.Unlock()
p.vertical = vertical
}
// SetMax sets the progress required to fill the bar.
func (p *ProgressBar) SetMax(max int) {
p.Lock()
defer p.Unlock()
p.max = max
}
// GetMax returns the progress required to fill the bar.
func (p *ProgressBar) GetMax() int {
p.RLock()
defer p.RUnlock()
return p.max
}
// AddProgress adds to the current progress.
func (p *ProgressBar) AddProgress(progress int) {
p.Lock()
defer p.Unlock()
p.progress += progress
if p.progress < 0 {
p.progress = 0
} else if p.progress > p.max {
p.progress = p.max
}
}
// SetProgress sets the current progress.
func (p *ProgressBar) SetProgress(progress int) {
p.Lock()
defer p.Unlock()
p.progress = progress
if p.progress < 0 {
p.progress = 0
} else if p.progress > p.max {
p.progress = p.max
}
}
// GetProgress gets the current progress.
func (p *ProgressBar) GetProgress() int {
p.RLock()
defer p.RUnlock()
return p.progress
}
// Complete returns whether the progress bar has been filled.
func (p *ProgressBar) Complete() bool {
p.RLock()
defer p.RUnlock()
return p.progress >= p.max
}
// Draw draws this primitive onto the screen.
func (p *ProgressBar) Draw(screen tcell.Screen) {
if !p.GetVisible() {
return
}
p.Box.Draw(screen)
p.Lock()
defer p.Unlock()
x, y, width, height := p.GetInnerRect()
barSize := height
maxLength := width
if p.vertical {
barSize = width
maxLength = height
}
barLength := int(math.RoundToEven(float64(maxLength) * (float64(p.progress) / float64(p.max))))
if barLength > maxLength {
barLength = maxLength
}
for i := 0; i < barSize; i++ {
for j := 0; j < barLength; j++ {
if p.vertical {
screen.SetContent(x+i, y+(height-1-j), p.filledRune, nil, tcell.StyleDefault.Foreground(p.filledColor).Background(p.backgroundColor))
} else {
screen.SetContent(x+j, y+i, p.filledRune, nil, tcell.StyleDefault.Foreground(p.filledColor).Background(p.backgroundColor))
}
}
for j := barLength; j < maxLength; j++ {
if p.vertical {
screen.SetContent(x+i, y+(height-1-j), p.emptyRune, nil, tcell.StyleDefault.Foreground(p.emptyColor).Background(p.backgroundColor))
} else {
screen.SetContent(x+j, y+i, p.emptyRune, nil, tcell.StyleDefault.Foreground(p.emptyColor).Background(p.backgroundColor))
}
}
}
}