summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md11
-rw-r--r--gotop.go21
-rw-r--r--termui/gauge.go3
-rw-r--r--termui/linegraph.go12
-rw-r--r--termui/list.go6
-rw-r--r--termui/sparkline.go4
-rw-r--r--termui/table.go30
-rw-r--r--widgets/help.go4
-rw-r--r--widgets/net.go3
-rw-r--r--widgets/proc.go10
10 files changed, 61 insertions, 43 deletions
diff --git a/README.md b/README.md
index 6e8c829..1884bea 100644
--- a/README.md
+++ b/README.md
@@ -75,15 +75,12 @@ Feel free to add a new one. You can use 256 colors, bold, underline, and reverse
- zooming in and out of graphs
- gopsutil issue for darwin i386
* cleaning up code
- - termui Blocks should ignore writing to the outside area
- - Ignore writes to outside of inner area, or give error?
- - termui Blocks should be indexed at 0, and maybe change X and Y variables too
+ - termui buffers should ignore setting characters outside the widget area
+ - ignore writes or give an error?
+ - termui Blocks should be indexed at 0, and maybe change their X and Y variables too
- remove gotop unique logic from list and table
- turn column width logic into a function
- try to get drawille fork merged upstream
- more documentation
- Draw borders and label after other stuff
- - Only merge stuff in the range
- - Merge should include offset
- - Remove merge from grid buffer function, just render
- - Remove merge altogether
+ - Only merge stuff in the buffer's area?
diff --git a/gotop.go b/gotop.go
index fd9d1cb..9b1ad4f 100644
--- a/gotop.go
+++ b/gotop.go
@@ -16,12 +16,17 @@ import (
const VERSION = "1.0.1"
var (
+ // for when terminal is resized
resized = make(chan bool, 1)
+ // for when help menu is toggled
helpToggled = make(chan bool, 1)
- helpStatus = false
+ // whether help menu is toggled
+ helpStatus = false
+ // proc widget takes longer to load, wait to render until it loads data
procLoaded = make(chan bool, 1)
+ // used to render the proc widget whenever a key is pressed for it
keyPressed = make(chan bool, 1)
colorscheme = colorschemes.Default
@@ -37,7 +42,7 @@ var (
)
// Sets up docopt which is a command line argument parser
-func arguments() {
+func cliArguments() {
usage := `
Usage: gotop [options]
@@ -123,9 +128,11 @@ func termuiColors() {
}
func widgetColors() {
+ // memory widget colors
mem.LineColor["Main"] = ui.Color(colorscheme.MainMem)
mem.LineColor["Swap"] = ui.Color(colorscheme.SwapMem)
+ // cpu widget colors
LineColor := make(map[string]ui.Color)
for i := 0; i < len(cpu.Data); i++ {
LineColor[fmt.Sprintf("CPU%d", i+1)] = ui.Color(colorscheme.CPULines[i])
@@ -134,12 +141,13 @@ func widgetColors() {
}
func main() {
- arguments()
-
- termuiColors()
+ cliArguments()
keyBinds()
+ // need to do this before initializing widgets so that they can inherit the colors
+ termuiColors()
+
cpu = w.NewCPU()
mem = w.NewMem()
proc = w.NewProc(procLoaded, keyPressed)
@@ -149,8 +157,10 @@ func main() {
widgetColors()
+ // blocks till loaded
<-procLoaded
+ // inits termui
err := ui.Init()
if err != nil {
panic(err)
@@ -159,6 +169,7 @@ func main() {
setupGrid()
+ // load help widget after init termui/termbox so that it has access to terminal size
help = w.NewHelpMenu()
ui.On("resize", func(e ui.Event) {
diff --git a/termui/gauge.go b/termui/gauge.go
index 7e6ab7e..11235f4 100644
--- a/termui/gauge.go
+++ b/termui/gauge.go
@@ -36,8 +36,9 @@ func (g *Gauge) Buffer() *Buffer {
// plot percentage
s := strconv.Itoa(g.Percent) + "%" + g.Description
- y := (g.Y + 1) / 2
s = MaxString(s, g.X)
+
+ y := (g.Y + 1) / 2
x := ((g.X - len(s)) + 1) / 2
for i, char := range s {
diff --git a/termui/linegraph.go b/termui/linegraph.go
index acf35fc..7a88566 100644
--- a/termui/linegraph.go
+++ b/termui/linegraph.go
@@ -31,6 +31,7 @@ func NewLineGraph() *LineGraph {
func (lc *LineGraph) Buffer() *Buffer {
buf := lc.Block.Buffer()
c := drawille.NewCanvas()
+ // used to keep track of colors but not write them to the buffer until the end
colors := make([][]Color, lc.X+2)
for i := range colors {
colors[i] = make([]Color, lc.Y+2)
@@ -52,6 +53,7 @@ func (lc *LineGraph) Buffer() *Buffer {
seriesLineColor = lc.DefaultLineColor
}
+ // coordinates of last point
lastY, lastX := -1, -1
// assign colors to `colors` and lines/points to the canvas
for i := len(seriesData) - 1; i >= 0; i-- {
@@ -63,7 +65,7 @@ func (lc *LineGraph) Buffer() *Buffer {
}
if lastY == -1 { // if this is the first point
c.Set(x, y)
- colors[x/2][y/4] = seriesLineColor
+ colors[x/2][y/4] = seriesLineColor // divide by 2 and 4 due to 2x4 dots in braille characters
} else {
c.DrawLine(lastX, lastY, x, y)
for _, p := range drawille.Line(lastX, lastY, x, y) {
@@ -73,20 +75,20 @@ func (lc *LineGraph) Buffer() *Buffer {
lastX, lastY = x, y
}
- // copy drawille and colors to buffer
+ // copy braille and colors to buffer
for y, line := range c.Rows(c.MinX(), c.MinY(), c.MaxX(), c.MaxY()) {
for x, char := range line {
- x /= 3
+ x /= 3 // idk why but it works
if x == 0 {
continue
}
- if char != 10240 {
+ if char != 10240 { // empty braille character
buf.SetCell(x, y, Cell{char, colors[x][y], lc.Bg})
}
}
}
- // Render key
+ // Render key ontop, but let braille be drawn between words
str := fmt.Sprintf("%s %3.0f%%", seriesName, seriesData[len(seriesData)-1])
for k, char := range str {
if char != ' ' {
diff --git a/termui/list.go b/termui/list.go
index f011239..f1908ed 100644
--- a/termui/list.go
+++ b/termui/list.go
@@ -29,12 +29,14 @@ func (bc *List) Buffer() *Buffer {
if y+1 > bc.Y {
break
}
+
fg := Theme.TempLow
if bc.Data[y] >= bc.Threshold {
fg = Theme.TempHigh
}
- r := MaxString(text, (bc.X - 4))
- buf.SetString(1, y+1, r, Theme.Fg, bc.Bg)
+
+ s := MaxString(text, (bc.X - 4))
+ buf.SetString(1, y+1, s, Theme.Fg, bc.Bg)
buf.SetString(bc.X-2, y+1, fmt.Sprintf("%dC", bc.Data[y]), fg, bc.Bg)
}
diff --git a/termui/sparkline.go b/termui/sparkline.go
index 9f3b9ee..c9bcb0d 100644
--- a/termui/sparkline.go
+++ b/termui/sparkline.go
@@ -56,9 +56,9 @@ func (sl *Sparklines) Buffer() *Buffer {
buf.SetString(1, title1Y, title1, line.TitleColor|AttrBold, sl.Bg)
buf.SetString(1, title2Y, title2, line.TitleColor|AttrBold, sl.Bg)
- // sparkline
sparkY := (sl.Y / lc) * (i + 1)
- // finds max used for relative heights
+
+ // finds max data in current view used for relative heights
max := 1
for i := len(line.Data) - 1; i >= 0 && sl.X-((len(line.Data)-1)-i) >= 1; i-- {
if line.Data[i] > max {
diff --git a/termui/table.go b/termui/table.go
index 172ad90..883cda7 100644
--- a/termui/table.go
+++ b/termui/table.go
@@ -8,15 +8,17 @@ import (
// Table tracks all the attributes of a Table instance
type Table struct {
*Block
- Header []string
- Rows [][]string
- Fg Color
- Bg Color
- Cursor Color
+ Header []string
+ Rows [][]string
+ Fg Color
+ Bg Color
+ Cursor Color
+ // the unique column used to keep track of which process we're one
+ // either the PID column or Command column depending on if processes are grouped
UniqueCol int
- pid string
- selected int
- topRow int
+ pid string // used to keep the cursor on the correct process after each update
+ selected int // selected row
+ topRow int // top process in current view
}
// NewTable returns a new Table instance
@@ -32,7 +34,7 @@ func NewTable() *Table {
}
}
-// Buffer ...
+// Buffer implements the Bufferer interface.
func (t *Table) Buffer() *Buffer {
buf := t.Block.Buffer()
@@ -58,9 +60,9 @@ func (t *Table) Buffer() *Buffer {
// total width requires by all 4 columns
contentWidth := gap + cw[0] + gap + cw[1] + gap + cw[2] + gap + cw[3] + gap
- render := 4 // number of columns to iterate through
+ render := 4 // number of columns to render based on the terminal width
- // removes CPU and MEM if there isn't enough room
+ // removes CPU and MEM columns if there isn't enough room
if t.X < (contentWidth - gap - cw[3]) {
render = 2
} else if t.X < contentWidth {
@@ -75,8 +77,6 @@ func (t *Table) Buffer() *Buffer {
}
// prints each row
- // for y, row := range t.Rows {
- // for y := t.topRow; y <= t.topRow+t.Y; y++ {
for rowNum := t.topRow; rowNum < t.topRow+t.Y-1 && rowNum < len(t.Rows); rowNum++ {
row := t.Rows[rowNum]
y := (rowNum + 2) - t.topRow
@@ -92,7 +92,7 @@ func (t *Table) Buffer() *Buffer {
t.selected = rowNum
}
- // prints each string
+ // prints each col of the row
for i := 0; i < render; i++ {
r := MaxString(row[i], t.X-6)
buf.SetString(cp[i], y, r, t.Fg, bg)
@@ -104,6 +104,7 @@ func (t *Table) Buffer() *Buffer {
////////////////////////////////////////////////////////////////////////////////
+// calcPos is used to calculate the cursor position and where in the process list we are located.
func (t *Table) calcPos() {
t.pid = ""
@@ -171,6 +172,7 @@ func (t *Table) Click(x, y int) {
}
}
+// Kill kills process or group of processes.
func (t *Table) Kill() {
t.pid = ""
command := "kill"
diff --git a/widgets/help.go b/widgets/help.go
index 91b65f5..1a8a569 100644
--- a/widgets/help.go
+++ b/widgets/help.go
@@ -25,11 +25,11 @@ Process Sorting:
`
type HelpMenu struct {
- ui.Block
+ *ui.Block
}
func NewHelpMenu() *HelpMenu {
- block := *ui.NewBlock()
+ block := ui.NewBlock()
block.X = 48 // width
block.Y = 15 // height
block.XOffset = (ui.Body.Width - block.X) / 2 // X coordinate
diff --git a/widgets/net.go b/widgets/net.go
index 33743f9..7417d99 100644
--- a/widgets/net.go
+++ b/widgets/net.go
@@ -57,8 +57,9 @@ func (n *Net) update() {
n.recvTotal = recv
n.sentTotal = sent
+ // renders net widget titles
for i := 0; i < 2; i++ {
- var method string
+ var method string // either 'Rx' or 'Tx'
var total uint64
cur := n.Lines[i].Data[len(n.Lines[i].Data)-1]
totalUnit := "B"
diff --git a/widgets/proc.go b/widgets/proc.go
index 4e727f5..248fb7c 100644
--- a/widgets/proc.go
+++ b/widgets/proc.go
@@ -15,7 +15,7 @@ const (
UP = "▲"
)
-// Process represents each process
+// Process represents each process.
type Process struct {
PID int32
Command string
@@ -23,7 +23,7 @@ type Process struct {
Mem float32
}
-// Proc is the widget
+// Proc widget.
type Proc struct {
*ui.Table
cpuCount int
@@ -35,7 +35,7 @@ type Proc struct {
KeyPressed chan bool
}
-// Creates a new Proc widget
+// NewProc creates a new Proc widget.
func NewProc(loaded, keyPressed chan bool) *Proc {
cpuCount, _ := cpu.Counts(false)
p := &Proc{
@@ -70,6 +70,7 @@ func NewProc(loaded, keyPressed chan bool) *Proc {
return p
}
+// update updates proc widget.
func (p *Proc) update() {
psProcs, _ := proc.Processes()
processes := make([]Process, len(psProcs))
@@ -92,7 +93,8 @@ func (p *Proc) update() {
p.Sort()
}
-// Sort sorts either the grouped or ungrouped []Process based on the sortMethod
+// Sort sorts either the grouped or ungrouped []Process based on the sortMethod.
+// Called with every update, when the sort method is changed, and when processes are grouped and ungrouped.
func (p *Proc) Sort() {
p.Header = []string{"Count", "Command", "CPU%", "Mem%"}