Add debug info to compiled VM code

6 files changed, 86 insertions, 9 deletions

diff --git a/pkg/lang/vm/code/code.go b/pkg/lang/vm/code/code.go
index bd25fcd..38bbcf5 100644
--- a/pkg/lang/vm/code/code.go
+++ b/pkg/lang/vm/code/code.go
@@ -8,12 +8,14 @@ import (
 )
 
 type Code struct {
-	code []byte
+	code      []byte
+	debugInfo DebugInfo
 }
 
-func New(code []byte) Code {
+func New(code []byte, info DebugInfo) Code {
 	return Code{
-		code: code,
+		code:      code,
+		debugInfo: info,
 	}
 }
 
@@ -25,6 +27,10 @@ func (c *Code) Code() []byte {
 	return c.code
 }
 
+func (c *Code) Debug() *DebugInfo {
+	return &c.debugInfo
+}
+
 func (c *Code) GetOp(at int) (Op, int) {
 	return Op(c.code[at]), 1
 }
diff --git a/pkg/lang/vm/code/debug.go b/pkg/lang/vm/code/debug.go
new file mode 100644
index 0000000..b96c834
--- /dev/null
+++ b/pkg/lang/vm/code/debug.go
@@ -0,0 +1,31 @@
+package code
+
+import "jinx/pkg/libs/rangemap"
+
+type DebugInfo struct {
+	file     string
+	pcToLine rangemap.RangeMap[int]
+}
+
+func NewDebugInfo(file string) DebugInfo {
+	return DebugInfo{
+		file:     file,
+		pcToLine: rangemap.New[int](),
+	}
+}
+
+func (di *DebugInfo) File() string {
+	return di.file
+}
+
+func (di *DebugInfo) PCToLine(pc int) int {
+	line, ok := di.pcToLine.Get(pc)
+	if !ok {
+		return -1
+	}
+	return *line
+}
+
+func (di *DebugInfo) AppendLine(uptoPc, line int) {
+	di.pcToLine.AppendToLast(uptoPc, line)
+}
diff --git a/pkg/lang/vm/errors.go b/pkg/lang/vm/errors.go
index bbc66b8..37f3542 100644
--- a/pkg/lang/vm/errors.go
+++ b/pkg/lang/vm/errors.go
@@ -9,12 +9,16 @@ import (
 )
 
 type Error struct {
-	Pc  int
-	Err error
+	Pc   int
+	Line int
+	Err  error
 }
 
 func (e Error) Error() string {
-	return fmt.Sprintf("vm error at pc %d: %s", e.Pc, e.Err)
+	if e.Line == -1 {
+		return fmt.Sprintf("vm error at pc %d, unknown line: %v", e.Pc, e.Err)
+	}
+	return fmt.Sprintf("vm error at pc %d, line %d: %v", e.Pc, e.Line, e.Err)
 }
 
 // Fatal errors
diff --git a/pkg/lang/vm/text/compiler.go b/pkg/lang/vm/text/compiler.go
index 2732aea..1480171 100644
--- a/pkg/lang/vm/text/compiler.go
+++ b/pkg/lang/vm/text/compiler.go
@@ -31,6 +31,7 @@ func NewCompiler(src io.Reader) *Compiler {
 
 func (cpl *Compiler) Compile() (code.Code, error) {
 	res := []byte{}
+	info := code.NewDebugInfo("unknown file")
 
 	for {
 		_, eof, err := cpl.src.Peek()
@@ -48,6 +49,11 @@ func (cpl *Compiler) Compile() (code.Code, error) {
 		}
 
 		cpl.codePos += len(line)
+
+		if line != nil {
+			info.AppendLine(cpl.codePos-1, cpl.src.Loc().Row-1)
+		}
+
 		res = append(res, line...)
 	}
 
@@ -55,7 +61,7 @@ func (cpl *Compiler) Compile() (code.Code, error) {
 		return code.Code{}, err
 	}
 
-	return code.New(res), nil
+	return code.New(res, info), nil
 }
 
 func (cpl *Compiler) compileLine() ([]byte, error) {
diff --git a/pkg/lang/vm/text/compiler_test.go b/pkg/lang/vm/text/compiler_test.go
index 237e884..56b886d 100644
--- a/pkg/lang/vm/text/compiler_test.go
+++ b/pkg/lang/vm/text/compiler_test.go
@@ -129,6 +129,35 @@ func TestLabels(t *testing.T) {
 	require.Equal(t, joinSlices(parts), res.Code())
 }
 
+func TestDebugInfo(t *testing.T) {
+	src := `
+	push_int 1
+	push_int 2
+
+	add
+	add
+	
+	@1:
+		nop
+		ret
+	`
+
+	c := text.NewCompiler(strings.NewReader(src))
+	res, err := c.Compile()
+	require.NoError(t, err)
+
+	expected := code.NewDebugInfo("unknown file")
+
+	expected.AppendLine(8, 1)
+	expected.AppendLine(17, 2)
+	expected.AppendLine(18, 4)
+	expected.AppendLine(19, 5)
+	expected.AppendLine(20, 8)
+	expected.AppendLine(21, 9)
+
+	require.Equal(t, expected, *res.Debug())
+}
+
 func opBin(op code.Op) []byte {
 	return []byte{byte(op)}
 }
diff --git a/pkg/lang/vm/vm.go b/pkg/lang/vm/vm.go
index d896d88..7284257 100644
--- a/pkg/lang/vm/vm.go
+++ b/pkg/lang/vm/vm.go
@@ -39,8 +39,9 @@ func (vm *VM) Run() error {
 
 		if decision, err := vm.step(op); err != nil {
 			return Error{
-				Pc:  vm.pc,
-				Err: err,
+				Pc:   vm.pc,
+				Line: vm.code.Debug().PCToLine(vm.pc),
+				Err:  err,
 			}
 		} else if decision == stepDecisionHalt {
 			return nil