Merge pull request #30 from raghav2005/feature/help-menu

feature/help-menu

Author: metaspartan

README.md

@@ -95,7 +95,8 @@ Options are 'green', 'red', 'blue', 'cyan', 'magenta', 'yellow', and 'white'. (-
 Use the following keys to interact with the application while its running:
 - `q`: Quit the application.
 - `r`: Refresh the UI data manually.
-- `l`: Toggle the current layout.
+- `l`: Toggle the main display's layout.
+- `h`: Toggle the help menu.
 
 ## Example Theme (Green) Screenshot (sudo mactop -c green)
 

main.go

@@ -78,16 +78,17 @@ func (e *EventThrottler) Notify() {
 }
 
 var (
-	cpu1Gauge, cpu2Gauge, gpuGauge, aneGauge        *w.Gauge
-	TotalPowerChart                                 *w.BarChart
-	memoryGauge                                     *w.Gauge
-	modelText, PowerChart, NetworkInfo, ProcessInfo *w.Paragraph
-	grid                                            *ui.Grid
-	powerValues                                     []float64
-	lastUpdateTime                                  time.Time
-	stderrLogger                                    = log.New(os.Stderr, "", 0)
-	currentGridLayout                               = "default"
-	updateInterval                                  = 1000
+	cpu1Gauge, cpu2Gauge, gpuGauge, aneGauge                  *w.Gauge
+	TotalPowerChart                                           *w.BarChart
+	memoryGauge                                               *w.Gauge
+	modelText, PowerChart, NetworkInfo, ProcessInfo, helpText *w.Paragraph
+	grid                                                      *ui.Grid
+	powerValues                                               []float64
+	lastUpdateTime                                            time.Time
+	stderrLogger                                              = log.New(os.Stderr, "", 0)
+	currentGridLayout                                         = "default"
+	showHelp                                                  = false
+	updateInterval                                            = 1000
 )
 
 var (
@@ -104,8 +105,9 @@ var (
 
 func setupUI() {
 	appleSiliconModel := getSOCInfo()
-	modelText = w.NewParagraph()
+	modelText, helpText = w.NewParagraph(), w.NewParagraph()
 	modelText.Title = "Apple Silicon"
+	helpText.Title = "Help Menu"
 	modelName, ok := appleSiliconModel["name"].(string)
 	if !ok {
 		modelName = "Unknown Model"
@@ -129,41 +131,28 @@ func setupUI() {
 		pCoreCount,
 		gpuCoreCount,
 	)
+	helpText.Text = "- r: Refresh the UI data manually\n- l: Toggle the main display's layout\n- h: Toggle this help menu\n- ?: Toggle this help menu\n- q: Quit the application\n- <C-c>: Quit the application"
 	stderrLogger.Printf("Model: %s\nE-Core Count: %d\nP-Core Count: %d\nGPU Core Count: %s",
 		modelName,
 		eCoreCount,
 		pCoreCount,
 		gpuCoreCount,
 	)
 
-	cpu1Gauge = w.NewGauge()
-	cpu1Gauge.Title = "E-CPU Usage"
-	cpu1Gauge.Percent = 0
-	cpu1Gauge.BarColor = ui.ColorGreen
-
-	cpu2Gauge = w.NewGauge()
-	cpu2Gauge.Title = "P-CPU Usage"
-	cpu2Gauge.Percent = 0
-	cpu2Gauge.BarColor = ui.ColorYellow
-
-	gpuGauge = w.NewGauge()
-	gpuGauge.Title = "GPU Usage"
-	gpuGauge.Percent = 0
-	gpuGauge.BarColor = ui.ColorMagenta
-
-	aneGauge = w.NewGauge()
-	aneGauge.Title = "ANE"
-	aneGauge.Percent = 0
-	aneGauge.BarColor = ui.ColorBlue
-
-	PowerChart = w.NewParagraph()
-	PowerChart.Title = "Power Usage"
-
-	NetworkInfo = w.NewParagraph()
-	NetworkInfo.Title = "Network & Disk Info"
+	gauges := []*w.Gauge{
+		w.NewGauge(), w.NewGauge(), w.NewGauge(), w.NewGauge(), w.NewGauge(),
+	}
+	titles := []string{"E-CPU Usage", "P-CPU Usage", "GPU Usage", "ANE", "Memory Usage"}
+	colors := []ui.Color{ui.ColorGreen, ui.ColorYellow, ui.ColorMagenta, ui.ColorBlue, ui.ColorCyan}
+	for i, gauge := range gauges {
+		gauge.Percent = 0
+		gauge.Title = titles[i]
+		gauge.BarColor = colors[i]
+	}
+	cpu1Gauge, cpu2Gauge, gpuGauge, aneGauge, memoryGauge = gauges[0], gauges[1], gauges[2], gauges[3], gauges[4]
 
-	ProcessInfo = w.NewParagraph()
-	ProcessInfo.Title = "Process Info"
+	PowerChart, NetworkInfo, ProcessInfo = w.NewParagraph(), w.NewParagraph(), w.NewParagraph()
+	PowerChart.Title, NetworkInfo.Title, ProcessInfo.Title = "Power Usage", "Network & Disk Info", "Process Info"
 
 	TotalPowerChart = w.NewBarChart()
 	TotalPowerChart.Title = "~ W Total Power"
@@ -175,10 +164,6 @@ func setupUI() {
 	TotalPowerChart.NumFormatter = func(num float64) string {
 		return ""
 	}
-	memoryGauge = w.NewGauge()
-	memoryGauge.Title = "Memory Usage"
-	memoryGauge.Percent = 0
-	memoryGauge.BarColor = ui.ColorCyan
 }
 
 func setupGrid() {
@@ -248,6 +233,31 @@ func switchGridLayout() {
 	}
 }
 
+func toggleHelpMenu() {
+	showHelp = !showHelp
+	if showHelp {
+		newGrid := ui.NewGrid()
+		newGrid.Set(
+			ui.NewRow(1.0,
+				ui.NewCol(1.0, helpText),
+			),
+		)
+		termWidth, termHeight := ui.TerminalDimensions()
+		helpTextGridWidth := termWidth / 3
+		helpTextGridHeight := termHeight / 2
+		x := (termWidth - helpTextGridWidth) / 2
+		y := (termHeight - helpTextGridHeight) / 2
+		newGrid.SetRect(x, y, x+helpTextGridWidth, y+helpTextGridHeight)
+		grid = newGrid
+	} else {
+		currentGridLayout = map[bool]string{
+			true:  "alternative",
+			false: "default",
+		}[currentGridLayout == "default"]
+		switchGridLayout()
+	}
+}
+
 func StderrToLogfile(logfile *os.File) {
 	syscall.Dup2(int(logfile.Fd()), 2)
 }
@@ -431,6 +441,12 @@ func main() {
 				ui.Clear()
 				switchGridLayout()
 				ui.Render(grid)
+			case "h", "?": // "h" or "?" to open help menu
+				termWidth, termHeight := ui.TerminalDimensions()
+				grid.SetRect(0, 0, termWidth, termHeight)
+				ui.Clear()
+				toggleHelpMenu()
+				ui.Render(grid)
 			}
 		case <-done:
 			ui.Close()