add variable support, implements #10 (#14)

Makefile

@@ -57,8 +57,8 @@ test:
 	go test -v ./...
 
 singletest:
-	@echo "Call like this: ''make singletest TEST=TestPrepareColumns MOD=lib"
+	@echo "Call like this: ''make singletest TEST=TestPrepareColumns"
-	go test -run $(TEST) github.com/tlinden/rpn/$(MOD)
+	go test -run $(TEST)
 
 cover-report:
 	go test ./... -cover -coverprofile=coverage.out

README.md

@@ -21,7 +21,12 @@ Features:
 - provides interactive repl
 - completion
 - history
+- comments (comment character is `#`)
+- variables
 
+## Demo
+
+![asciicast](demo/demo.gif)
 
 ## Working principle
 

calc.go

@@ -33,16 +33,22 @@ type Calc struct {
 	batch        bool
 	stdin        bool
 	showstack    bool
+	intermediate bool
+	notdone      bool // set to true as long as there are items left in the eval loop
 	stack        *Stack
 	history      []string
 	completer    readline.AutoCompleter
 	interpreter  *Interpreter
 	Space        *regexp.Regexp
+	Comment      *regexp.Regexp
+	Register     *regexp.Regexp
 	Constants    []string
 	LuaFunctions []string
 
 	Funcalls      Funcalls
 	BatchFuncalls Funcalls
+
+	Vars map[string]float64
 }
 
 // help for lua functions will be added dynamically
@@ -55,6 +61,7 @@ clear                clear the whole stack
 shift                remove the last element of the stack
 reverse              reverse the stack elements
 swap                 exchange the last two elements
+vars                 show list of variables
 history              display calculation history
 help|?               show this message
 quit|exit|c-d|c-c    exit program
@@ -78,12 +85,16 @@ sum                  sum of all values (alias: +)
 max                  max of all values
 min                  min of all values
 mean                 mean of all values (alias: avg)
-median               median of all values`
+median               median of all values
+
+Register variables:
+>NAME                Put last stack element into variable NAME
+<NAME                Retrieve variable NAME and put onto stack`
 
 // commands, constants and operators,  defined here to feed completion
 // and our mode switch in Eval() dynamically
 const (
-	Commands  string = `dump reverse debug undebug clear batch shift undo help history manual exit quit swap show`
+	Commands  string = `dump reverse debug undebug clear batch shift undo help history manual exit quit swap show vars`
 	Constants string = `Pi Phi Sqrt2 SqrtE SqrtPi SqrtPhi Ln2 Log2E Ln10 Log10E`
 )
 
@@ -125,6 +136,7 @@ func NewCalc() *Calc {
 
 	c.Funcalls = DefineFunctions()
 	c.BatchFuncalls = DefineBatchFunctions()
+	c.Vars = map[string]float64{}
 
 	c.completer = readline.NewPrefixCompleter(
 		// custom lua functions
@@ -133,6 +145,8 @@ func NewCalc() *Calc {
 	)
 
 	c.Space = regexp.MustCompile(`\s+`)
+	c.Comment = regexp.MustCompile(`#.*`) // ignore everything after #
+	c.Register = regexp.MustCompile(`^([<>])([A-Z][A-Z0-9]*)`)
 
 	// pre-calculate mode switching arrays
 	c.Constants = strings.Split(Constants, " ")
@@ -189,13 +203,22 @@ func (c *Calc) Prompt() string {
 
 // the actual work horse, evaluate a line of calc command[s]
 func (c *Calc) Eval(line string) {
-	line = strings.TrimSpace(line)
+	// remove surrounding whitespace and comments, if any
+	line = strings.TrimSpace(c.Comment.ReplaceAllString(line, ""))
 
 	if line == "" {
 		return
 	}
 
-	for _, item := range c.Space.Split(line, -1) {
+	items := c.Space.Split(line, -1)
+
+	for pos, item := range items {
+		if pos+1 < len(items) {
+			c.notdone = true
+		} else {
+			c.notdone = false
+		}
+
 		num, err := strconv.ParseFloat(item, 64)
 
 		if err == nil {
@@ -240,15 +263,28 @@ func (c *Calc) Eval(line string) {
 				continue
 			}
 
+			regmatches := c.Register.FindStringSubmatch(item)
+			if len(regmatches) == 3 {
+				switch regmatches[1] {
+				case ">":
+					c.PutVar(regmatches[2])
+				case "<":
+					c.GetVar(regmatches[2])
+				}
+				continue
+			}
+
 			// management commands
 			switch item {
 			case "?":
 				fallthrough
 			case "help":
 				fmt.Println(Help)
-				fmt.Println("Lua functions:")
+				if len(LuaFuncs) > 0 {
-				for name, function := range LuaFuncs {
+					fmt.Println("Lua functions:")
-					fmt.Printf("%-20s %s\n", name, function.help)
+					for name, function := range LuaFuncs {
+						fmt.Printf("%-20s %s\n", name, function.help)
+					}
 				}
 			case "dump":
 				c.stack.Dump()
@@ -288,6 +324,16 @@ func (c *Calc) Eval(line string) {
 				os.Exit(0)
 			case "manual":
 				man()
+			case "vars":
+				if len(c.Vars) > 0 {
+					fmt.Printf("%-20s     %s\n", "VARIABLE", "VALUE")
+					for k, v := range c.Vars {
+						fmt.Printf("%-20s  -> %.2f\n", k, v)
+					}
+				} else {
+					fmt.Println("no vars registered")
+				}
+
 			default:
 				fmt.Println("unknown command or operator!")
 			}
@@ -376,11 +422,16 @@ func (c *Calc) History(format string, args ...any) {
 
 // print the result
 func (c *Calc) Result() float64 {
-	if !c.stdin {
+	// we only  print the result if it's either  a final result or
-		fmt.Print("= ")
+	// (if it is intermediate) if -i has been given
-	}
+	if c.intermediate || !c.notdone {
+		// only needed in repl
+		if !c.stdin {
+			fmt.Print("= ")
+		}
 
-	fmt.Println(c.stack.Last()[0])
+		fmt.Println(c.stack.Last()[0])
+	}
 
 	return c.stack.Last()[0]
 }
@@ -431,3 +482,24 @@ func (c *Calc) luafunc(funcname string) {
 
 	c.Result()
 }
+
+func (c *Calc) PutVar(name string) {
+	last := c.stack.Last()
+
+	if len(last) == 1 {
+		c.Debug(fmt.Sprintf("register %.2f in %s", last[0], name))
+		c.Vars[name] = last[0]
+	} else {
+		fmt.Println("empty stack")
+	}
+}
+
+func (c *Calc) GetVar(name string) {
+	if _, ok := c.Vars[name]; ok {
+		c.Debug(fmt.Sprintf("retrieve %.2f from %s", c.Vars[name], name))
+		c.stack.Backup()
+		c.stack.Push(c.Vars[name])
+	} else {
+		fmt.Println("variable doesn't exist")
+	}
+}

calc_test.go

@@ -22,6 +22,79 @@ import (
 	"testing"
 )
 
+func TestCommentsAndWhitespace(t *testing.T) {
+	calc := NewCalc()
+
+	var tests = []struct {
+		name string
+		cmd  []string
+		exp  float64 // last element of the stack
+	}{
+		{
+			name: "whitespace prefix",
+			cmd:  []string{"  5"},
+			exp:  5.0,
+		},
+		{
+			name: "whitespace postfix",
+			cmd:  []string{"5  "},
+			exp:  5.0,
+		},
+		{
+			name: "whitespace both",
+			cmd:  []string{"  5   "},
+			exp:  5.0,
+		},
+		{
+			name: "comment line w/ spaces",
+			cmd:  []string{"5", "   #   19"},
+			exp:  5.0,
+		},
+		{
+			name: "comment line w/o spaces",
+			cmd:  []string{"5", `#19`},
+			exp:  5.0,
+		},
+		{
+			name: "inline comment w/ spaces",
+			cmd:  []string{"5   #   19"},
+			exp:  5.0,
+		},
+		{
+			name: "inline comment w/o spaces",
+			cmd:  []string{"5#19"},
+			exp:  5.0,
+		},
+	}
+
+	for _, tt := range tests {
+		testname := fmt.Sprintf("%s .(expect %.2f)",
+			tt.name, tt.exp)
+
+		t.Run(testname, func(t *testing.T) {
+			for _, line := range tt.cmd {
+				calc.Eval(line)
+			}
+			got := calc.stack.Last()
+
+			if len(got) > 0 {
+				if got[0] != tt.exp {
+					t.Errorf("parsing failed:\n+++  got: %f\n--- want: %f",
+						got, tt.exp)
+				}
+			}
+
+			if calc.stack.Len() != 1 {
+				t.Errorf("invalid stack size:\n+++  got: %d\n--- want: 1",
+					calc.stack.Len())
+			}
+
+		})
+
+		calc.stack.Clear()
+	}
+}
+
 func TestCalc(t *testing.T) {
 	calc := NewCalc()
 

demo/Makefile

@@ -0,0 +1,7 @@
+#
+
+
+all:
+	asciinema rec --cols 80 --row 25 -c "env - PS1='> ' PATH=..:$PATH /bin/bash --norc --noprofile" --overwrite demo.cast
+	agg demo.cast demo.gif
+

demo/demo.cast

@@ -0,0 +1,3 @@
+{"version": 2, "width": 80, "height": 25, "timestamp": 1699358215, "env": {"SHELL": "/bin/bash", "TERM": "tmux-256color"}}
+[0.005628, "o", "> "]
+[0.941195, "o", "exit\r\n"]

demo/sessions.txt

@@ -0,0 +1,18 @@
+# demo sessions, used to create an interactive rpn recording
+
+# part 1: interactive
+
+# put some numbers onto the stack
+2 4 6
+8
+10
+
+# take a look at the stack
+dump
+
+# add the last 2
++
+
+# multiply the result and the previous
+*
+

main.go

@@ -30,19 +30,20 @@ import (
 	lua "github.com/yuin/gopher-lua"
 )
 
-const VERSION string = "2.0.3"
+const VERSION string = "2.0.5"
 
 const Usage string = `This is rpn, a reverse polish notation calculator cli.
 
 Usage: rpn [-bdvh] [<operator>]
 
 Options:
-  -b, --batchmode   enable batch mode
+  -b, --batchmode     enable batch mode
-  -d, --debug       enable debug mode
+  -d, --debug         enable debug mode
-  -s, --stack       show last 5 items of the stack (off by default)
+  -s, --stack         show last 5 items of the stack (off by default)
-  -m, --manual      show manual
+  -i  --intermediate  print intermediate results
-  -v, --version     show version
+  -m, --manual        show manual
-  -h, --help        show help
+  -v, --version       show version
+  -h, --help          show help
 
 When <operator>  is given, batch  mode ist automatically  enabled. Use
 this only when working with stdin. E.g.: echo "2 3 4 5" | rpn +
@@ -59,7 +60,9 @@ func main() {
 	configfile := ""
 
 	flag.BoolVarP(&calc.batch, "batchmode", "b", false, "batch mode")
-	flag.BoolVarP(&calc.showstack, "showstack", "s", false, "show stack")
+	flag.BoolVarP(&calc.showstack, "show-stack", "s", false, "show stack")
+	flag.BoolVarP(&calc.intermediate, "showin-termediate", "i", false,
+		"show intermediate results")
 	flag.BoolVarP(&enabledebug, "debug", "d", false, "debug mode")
 	flag.BoolVarP(&showversion, "version", "v", false, "show version")
 	flag.BoolVarP(&showhelp, "help", "h", false, "show usage")

rpn.go

@@ -2,16 +2,19 @@ package main
 
 var manpage = `
 NAME
-    rpn - Reverse Polish Notation Calculator for the commandline
+    rpn - Programmable command-line calculator using reverse polish notation
 
 SYNOPSIS
         Usage: rpn [-bdvh] [<operator>]
     
         Options:
-          -b, --batchmode   enable batch mode
+          -b, --batchmode     enable batch mode
-          -d, --debug       enable debug mode
+          -d, --debug         enable debug mode
-          -v, --version     show version
+          -s, --stack         show last 5 items of the stack (off by default)
-          -h, --help        show help
+          -i  --intermediate  print intermediate results
+          -m, --manual        show manual
+          -v, --version       show version
+          -h, --help          show help
     
         When <operator>  is given, batch  mode ist automatically  enabled. Use
         this only when working with stdin. E.g.: echo "2 3 4 5" | rpn +
@@ -161,6 +164,11 @@ DESCRIPTION
         help|?               show this message
         quit|exit|c-d|c-c    exit program
 
+    Register variables:
+
+        >NAME                Put last stack element into variable NAME
+        <NAME                Retrieve variable NAME and put onto stack
+
     Refer to https://pkg.go.dev/math for details about those functions.
 
 INTERACTIVE REPL
@@ -193,6 +201,24 @@ INTERACTIVE REPL
     ctrl-r
         Search through history.
 
+COMMENTS
+    Lines starting with "#" are being ignored as comments. You can also
+    append comments to rpn input, e.g.:
+
+       # a comment
+       123   # another comment
+
+    In this case only 123 will be added to the stack.
+
+
+VARIABLES
+    You can register the last item of the stack into a variable. Variable
+    names must be all caps. Use the ">NAME" command to put a value into
+    variable "NAME". Use "<NAME" to retrieve the value of variable "NAME"
+    and put it onto the stack.
+
+    The command vars can be used to get a list of all variables.
+
 EXTENDING RPN USING LUA
     You can use a lua script with lua functions to extend the calculator. By
     default the tool looks for "~/.rpn.lua". You can also specify a script

rpn.pod

@@ -1,16 +1,19 @@
 =head1 NAME 
 
-rpn - Reverse Polish Notation Calculator for the commandline
+rpn - Programmable command-line calculator using reverse polish notation
 
 =head1 SYNOPSIS
 
     Usage: rpn [-bdvh] [<operator>]
     
     Options:
-      -b, --batchmode   enable batch mode
+      -b, --batchmode     enable batch mode
-      -d, --debug       enable debug mode
+      -d, --debug         enable debug mode
-      -v, --version     show version
+      -s, --stack         show last 5 items of the stack (off by default)
-      -h, --help        show help
+      -i  --intermediate  print intermediate results
+      -m, --manual        show manual
+      -v, --version       show version
+      -h, --help          show help
     
     When <operator>  is given, batch  mode ist automatically  enabled. Use
     this only when working with stdin. E.g.: echo "2 3 4 5" | rpn +
@@ -169,6 +172,11 @@ Commands:
     quit|exit|c-d|c-c    exit program
 
 
+Register variables:
+
+    >NAME                Put last stack element into variable NAME
+    <NAME                Retrieve variable NAME and put onto stack
+
 Refer to https://pkg.go.dev/math for details about those functions.
 
 =head1 INTERACTIVE REPL
@@ -213,6 +221,25 @@ Search through history.
 
 =back
 
+=head1 COMMENTS
+
+Lines starting with  C<#> are being ignored as comments.  You can also
+append comments to rpn input, e.g.:
+
+   # a comment
+   123   # another comment
+
+In this case only 123 will be added to the stack.
+
+=head1 VARIABLES
+
+You can register the last item  of the stack into a variable. Variable
+names must be  all caps. Use the  ">NAME" command to put  a value into
+variable "NAME". Use "<NAME" to  retrieve the value of variable "NAME"
+and put it onto the stack.
+
+The command B<vars> can be used to get a list of all variables.
+
 =head1 EXTENDING RPN USING LUA
 
 You can use a lua script with lua functions to extend the