prettify examples: add main demo screen to select specific examples

.github/workflows/go.yml

@@ -30,7 +30,4 @@ jobs:
       - name: Build
         run: |
           cd _examples/
-          for file in *.go
-          do
-            go build $file
-          done
+          go build .

_examples/README.md

@@ -0,0 +1,47 @@
+## Examples
+
+Each of the samples in `_examples` demonstrates a specific aspect of the API.
+
+Each can be run be alone or selected from the 'main' example.
+
+### Build & run
+
+```
+gocui $ cd _examples/
+
+_examples $ go run . --help
+usage:
+go run .        : select a demo from the gui and run it
+go run . <demo> : run the 'demo' argument
+
+  where 'demo' can be one of: 
+    active
+    bufs
+    colors
+    colors-256
+    colors-true
+    custom-frames
+    demo
+    dynamic
+    flow-layout
+    goroutine
+    hello
+    keybinds
+    layout
+    mask
+    mouse
+    on-top
+    overlap
+    size
+    stdin
+    table
+    title
+    widgets
+    wrap
+
+```
+
+### Select a demo through the gui
+
+<img src="demo_screen.png" alt="Demo Screen" width="500"/>
+

_examples/active.go

@@ -12,29 +12,29 @@ import (
 	"github.com/awesome-gocui/gocui"
 )
 
-var (
-	viewArr = []string{"v1", "v2", "v3", "v4"}
-	active  = 0
-)
+type demoActive struct {
+	viewArr []string
+	active  int
+}
 
-func setCurrentViewOnTop(g *gocui.Gui, name string) (*gocui.View, error) {
+func (d *demoActive) setCurrentViewOnTop(g *gocui.Gui, name string) (*gocui.View, error) {
 	if _, err := g.SetCurrentView(name); err != nil {
 		return nil, err
 	}
 	return g.SetViewOnTop(name)
 }
 
-func nextView(g *gocui.Gui, v *gocui.View) error {
-	nextIndex := (active + 1) % len(viewArr)
-	name := viewArr[nextIndex]
+func (d *demoActive) nextView(g *gocui.Gui, v *gocui.View) error {
+	nextIndex := (d.active + 1) % len(d.viewArr)
+	name := d.viewArr[nextIndex]
 
 	out, err := g.View("v2")
 	if err != nil {
 		return err
 	}
 	fmt.Fprintln(out, "Going from view "+v.Name()+" to "+name)
 
-	if _, err := setCurrentViewOnTop(g, name); err != nil {
+	if _, err := d.setCurrentViewOnTop(g, name); err != nil {
 		return err
 	}
 
@@ -44,11 +44,11 @@ func nextView(g *gocui.Gui, v *gocui.View) error {
 		g.Cursor = false
 	}
 
-	active = nextIndex
+	d.active = nextIndex
 	return nil
 }
 
-func layout(g *gocui.Gui) error {
+func (d *demoActive) layout(g *gocui.Gui) error {
 	maxX, maxY := g.Size()
 	if v, err := g.SetView("v1", 0, 0, maxX/2-1, maxY/2-1, 0); err != nil {
 		if !errors.Is(err, gocui.ErrUnknownView) {
@@ -58,7 +58,7 @@ func layout(g *gocui.Gui) error {
 		v.Editable = true
 		v.Wrap = true
 
-		if _, err = setCurrentViewOnTop(g, "v1"); err != nil {
+		if _, err = d.setCurrentViewOnTop(g, "v1"); err != nil {
 			return err
 		}
 	}
@@ -90,11 +90,15 @@ func layout(g *gocui.Gui) error {
 	return nil
 }
 
-func quit(g *gocui.Gui, v *gocui.View) error {
+func (d *demoActive) quit(*gocui.Gui, *gocui.View) error {
 	return gocui.ErrQuit
 }
 
-func main() {
+func mainActive() {
+	d := &demoActive{
+		viewArr: []string{"v1", "v2", "v3", "v4"},
+		active:  0,
+	}
 	g, err := gocui.NewGui(gocui.OutputNormal, true)
 	if err != nil {
 		log.Panicln(err)
@@ -105,12 +109,12 @@ func main() {
 	g.Cursor = true
 	g.SelFgColor = gocui.ColorGreen
 
-	g.SetManagerFunc(layout)
+	g.SetManagerFunc(d.layout)
 
-	if err := g.SetKeybinding("", gocui.KeyCtrlC, gocui.ModNone, quit); err != nil {
+	if err := g.SetKeybinding("", gocui.KeyCtrlC, gocui.ModNone, d.quit); err != nil {
 		log.Panicln(err)
 	}
-	if err := g.SetKeybinding("", gocui.KeyTab, gocui.ModNone, nextView); err != nil {
+	if err := g.SetKeybinding("", gocui.KeyTab, gocui.ModNone, d.nextView); err != nil {
 		log.Panicln(err)
 	}
 

_examples/bufs.go

@@ -14,20 +14,22 @@ import (
 	"github.com/awesome-gocui/gocui"
 )
 
-var vbuf, buf string
+type demoBufs struct {
+	vbuf, buf string
+}
 
-func quit(g *gocui.Gui, v *gocui.View) error {
-	vbuf = v.ViewBuffer()
-	buf = v.Buffer()
+func (d *demoBufs) quit(_ *gocui.Gui, v *gocui.View) error {
+	d.vbuf = v.ViewBuffer()
+	d.buf = v.Buffer()
 	return gocui.ErrQuit
 }
 
-func overwrite(g *gocui.Gui, v *gocui.View) error {
+func (d *demoBufs) overwrite(g *gocui.Gui, v *gocui.View) error {
 	v.Overwrite = !v.Overwrite
 	return nil
 }
 
-func layout(g *gocui.Gui) error {
+func (d *demoBufs) layout(g *gocui.Gui) error {
 	_, maxY := g.Size()
 	if v, err := g.SetView("main", 0, 0, 20, maxY-1, 0); err != nil {
 		if !errors.Is(err, gocui.ErrUnknownView) {
@@ -42,21 +44,23 @@ func layout(g *gocui.Gui) error {
 	return nil
 }
 
-func main() {
+func mainBufs() {
 	g, err := gocui.NewGui(gocui.OutputNormal, true)
 	if err != nil {
 		log.Panicln(err)
 	}
 
+	d := &demoBufs{}
+
 	g.Cursor = true
 	g.Mouse = true
 
-	g.SetManagerFunc(layout)
+	g.SetManagerFunc(d.layout)
 
-	if err := g.SetKeybinding("main", gocui.KeyCtrlC, gocui.ModNone, quit); err != nil {
+	if err := g.SetKeybinding("main", gocui.KeyCtrlC, gocui.ModNone, d.quit); err != nil {
 		log.Panicln(err)
 	}
-	if err := g.SetKeybinding("main", gocui.KeyCtrlI, gocui.ModNone, overwrite); err != nil {
+	if err := g.SetKeybinding("main", gocui.KeyCtrlI, gocui.ModNone, d.overwrite); err != nil {
 		log.Panicln(err)
 	}
 
@@ -66,6 +70,6 @@ func main() {
 
 	g.Close()
 
-	fmt.Printf("VBUF:\n%s\n", vbuf)
-	fmt.Printf("BUF:\n%s\n", buf)
+	fmt.Printf("VBUF:\n%s\n", d.vbuf)
+	fmt.Printf("BUF:\n%s\n", d.buf)
 }

_examples/colors.go

@@ -12,16 +12,21 @@ import (
 	"github.com/awesome-gocui/gocui"
 )
 
-func main() {
+type demoColors struct {
+}
+
+func mainColors() {
 	g, err := gocui.NewGui(gocui.OutputNormal, true)
 	if err != nil {
 		log.Panicln(err)
 	}
 	defer g.Close()
 
-	g.SetManagerFunc(layout)
+	d := &demoColors{}
+
+	g.SetManagerFunc(d.layout)
 
-	if err := g.SetKeybinding("", gocui.KeyCtrlC, gocui.ModNone, quit); err != nil {
+	if err := g.SetKeybinding("", gocui.KeyCtrlC, gocui.ModNone, d.quit); err != nil {
 		log.Panicln(err)
 	}
 
@@ -30,7 +35,7 @@ func main() {
 	}
 }
 
-func layout(g *gocui.Gui) error {
+func (d *demoColors) layout(g *gocui.Gui) error {
 	maxX, maxY := g.Size()
 	if v, err := g.SetView("colors", maxX/2-7, maxY/2-12, maxX/2+7, maxY/2+13, 0); err != nil {
 		if !errors.Is(err, gocui.ErrUnknownView) {
@@ -48,6 +53,6 @@ func layout(g *gocui.Gui) error {
 	return nil
 }
 
-func quit(g *gocui.Gui, v *gocui.View) error {
+func (d *demoColors) quit(*gocui.Gui, *gocui.View) error {
 	return gocui.ErrQuit
 }

_examples/colors256.go

@@ -12,17 +12,20 @@ import (
 	"github.com/awesome-gocui/gocui"
 )
 
-func main() {
+type demoColors256 struct{}
+
+func mainColors256() {
 	g, err := gocui.NewGui(gocui.Output256, true)
 
 	if err != nil {
 		log.Panicln(err)
 	}
 	defer g.Close()
 
-	g.SetManagerFunc(layout)
+	d := demoColors256{}
+	g.SetManagerFunc(d.layout)
 
-	if err := g.SetKeybinding("", gocui.KeyCtrlC, gocui.ModNone, quit); err != nil {
+	if err := g.SetKeybinding("", gocui.KeyCtrlC, gocui.ModNone, d.quit); err != nil {
 		log.Panicln(err)
 	}
 
@@ -31,7 +34,7 @@ func main() {
 	}
 }
 
-func layout(g *gocui.Gui) error {
+func (d *demoColors256) layout(g *gocui.Gui) error {
 	maxX, maxY := g.Size()
 	if v, err := g.SetView("colors", -1, -1, maxX, maxY, 0); err != nil {
 		if !errors.Is(err, gocui.ErrUnknownView) {
@@ -73,6 +76,6 @@ func layout(g *gocui.Gui) error {
 	return nil
 }
 
-func quit(g *gocui.Gui, v *gocui.View) error {
+func (d *demoColors256) quit(*gocui.Gui, *gocui.View) error {
 	return gocui.ErrQuit
 }

_examples/colorstrue.go

@@ -14,9 +14,11 @@ import (
 	colorful "github.com/lucasb-eyer/go-colorful"
 )
 
-var dark = false
+type demoColorsTrue struct {
+	dark bool
+}
 
-func main() {
+func mainColorsTrue() {
 	os.Setenv("COLORTERM", "truecolor")
 	g, err := gocui.NewGui(gocui.OutputTrue, true)
 
@@ -25,19 +27,20 @@ func main() {
 	}
 	defer g.Close()
 
-	g.SetManagerFunc(layout)
+	d := &demoColorsTrue{dark: false}
+	g.SetManagerFunc(d.layout)
 
-	if err := g.SetKeybinding("", gocui.KeyCtrlC, gocui.ModNone, quit); err != nil {
+	if err := g.SetKeybinding("", gocui.KeyCtrlC, gocui.ModNone, d.quit); err != nil {
 		log.Panicln(err)
 	}
 
 	if err := g.SetKeybinding("", gocui.KeyCtrlR, gocui.ModNone, func(g *gocui.Gui, v *gocui.View) error {
-		if dark {
-			dark = false
+		if d.dark {
+			d.dark = false
 		} else {
-			dark = true
+			d.dark = true
 		}
-		displayHsv(v)
+		d.displayHsv(v)
 
 		return nil
 	}); err != nil {
@@ -49,7 +52,7 @@ func main() {
 	}
 }
 
-func layout(g *gocui.Gui) error {
+func (d *demoColorsTrue) layout(g *gocui.Gui) error {
 	maxX, maxY := g.Size()
 	rows := 33
 	cols := 182
@@ -66,7 +69,7 @@ func layout(g *gocui.Gui) error {
 		}
 
 		v.FrameColor = gocui.GetColor("#FFAA55")
-		displayHsv(v)
+		d.displayHsv(v)
 
 		if _, err := g.SetCurrentView("colors"); err != nil {
 			return err
@@ -75,15 +78,15 @@ func layout(g *gocui.Gui) error {
 	return nil
 }
 
-func displayHsv(v *gocui.View) {
+func (d *demoColorsTrue) displayHsv(v *gocui.View) {
 	v.Clear()
 	str := ""
 	// HSV color space (lines are value or saturation)
 	for i := 50; i > 0; i -= 2 {
 		// Hue
 		for j := 0; j < 360; j += 2 {
-			ir, ig, ib := hsv(j, i-1)
-			ir2, ig2, ib2 := hsv(j, i)
+			ir, ig, ib := d.hsv(j, i-1)
+			ir2, ig2, ib2 := d.hsv(j, i)
 			str += fmt.Sprintf("\x1b[48;2;%d;%d;%dm\x1b[38;2;%d;%d;%dm▀\x1b[0m", ir, ig, ib, ir2, ig2, ib2)
 		}
 		str += "\n"
@@ -96,15 +99,15 @@ func displayHsv(v *gocui.View) {
 	fmt.Fprint(v, "Example should enable true color, but if it doesn't work run this command: \x1b[0mexport COLORTERM=truecolor")
 }
 
-func hsv(hue, sv int) (uint32, uint32, uint32) {
-	if !dark {
+func (d *demoColorsTrue) hsv(hue, sv int) (uint32, uint32, uint32) {
+	if !d.dark {
 		ir, ig, ib, _ := colorful.Hsv(float64(hue), float64(sv)/50, float64(1)).RGBA()
 		return ir >> 8, ig >> 8, ib >> 8
 	}
 	ir, ig, ib, _ := colorful.Hsv(float64(hue), float64(1), float64(sv)/50).RGBA()
 	return ir >> 8, ig >> 8, ib >> 8
 }
 
-func quit(g *gocui.Gui, v *gocui.View) error {
+func (d *demoColorsTrue) quit(*gocui.Gui, *gocui.View) error {
 	return gocui.ErrQuit
 }