cleaned up editor interface

Author: grantnelson-wf

playground/internal/editor/editor.go

@@ -12,17 +12,20 @@ const (
 	// TabWidth is the number of spaces per tab.
 	TabWidth = 4
 
+	EscapeEvent = `escape`
+	SaveEvent   = `save`
+	UndoEvent   = `undo`
+	RedoEvent   = `redo`
+
 	commentPrefix    = `// `
 	commentPrefixLen = len(commentPrefix)
 )
 
 type CodeBoxWrapper interface {
 	Code() string
-	SetCode(code string)
-	EmitSave()
-	EmitEscape()
 	GetSelection() (int, int)
-	SetSelection(start, end int, code string)
+	SetCode(selectionStart, selectionEnd int, code string)
+	EmitEvent(event string)
 }
 
 // MeasureLineLength returns the length of the line.
@@ -103,8 +106,7 @@ func (ce *codeEditor) handleKeyDown(key string, shift, ctrl bool) bool {
 	case `[`:
 		return ce.insertPair(ctrl, `[`, `]`)
 	case `Escape`:
-		ce.EmitEscape()
-		return true
+		return ce.handleEscape()
 	default:
 		return false
 	}
@@ -165,11 +167,7 @@ func (ce *codeEditor) handleSpace(shift, ctrl bool) bool {
 	write(newCode, code[start:])
 
 	start = lineStart + tabs + spaces
-	end = start
-
-	code = newCode.String()
-	ce.SetCode(code)
-	ce.SetSelection(start, end, code)
+	ce.SetCode(start, start, newCode.String())
 	return true
 }
 
@@ -234,9 +232,7 @@ func (ce *codeEditor) addIndents() bool {
 	})
 	write(newCode, code[endLine:])
 
-	code = newCode.String()
-	ce.SetCode(code)
-	ce.SetSelection(newStart, newEnd, code)
+	ce.SetCode(newStart, newEnd, newCode.String())
 	return true
 }
 
@@ -295,9 +291,7 @@ func (ce *codeEditor) removeIndents() bool {
 	})
 	write(newCode, code[endLine:])
 
-	code = newCode.String()
-	ce.SetCode(code)
-	ce.SetSelection(newStart, newEnd, code)
+	ce.SetCode(newStart, newEnd, newCode.String())
 	return true
 }
 
@@ -363,7 +357,12 @@ func (ce *codeEditor) handleSave(shift, ctrl bool) bool {
 		return false
 	}
 
-	ce.EmitSave()
+	ce.EmitEvent(SaveEvent)
+	return true
+}
+
+func (ce *codeEditor) handleEscape() bool {
+	ce.EmitEvent(EscapeEvent)
 	return true
 }
 
@@ -449,9 +448,7 @@ func (ce *codeEditor) addCommenting(startLine, endLine int) {
 	})
 	write(newCode, code[endLine:])
 
-	code = newCode.String()
-	ce.SetCode(code)
-	ce.SetSelection(newStart, newEnd, code)
+	ce.SetCode(newStart, newEnd, newCode.String())
 }
 
 // removeCommenting will uncomment any line that starts with the comment prefix
@@ -483,9 +480,7 @@ func (ce *codeEditor) removeCommenting(startLine, endLine int) {
 	})
 	write(newCode, code[endLine:])
 
-	code = newCode.String()
-	ce.SetCode(code)
-	ce.SetSelection(newStart, newEnd, code)
+	ce.SetCode(newStart, newEnd, newCode.String())
 }
 
 // getSelectedLines returns the start and end character indices of that
@@ -585,9 +580,7 @@ func (ce *codeEditor) insertAtSelection(before, after string, keepSelection bool
 		write(newCode, code[end:])
 	}
 
-	code = newCode.String()
-	ce.SetCode(code)
-	ce.SetSelection(newStart, newEnd, code)
+	ce.SetCode(newStart, newEnd, newCode.String())
 }
 
 func (ce *codeEditor) indentAt(start int) string {

playground/internal/editor/editor_test.go

@@ -1,6 +1,7 @@
 package editor
 
 import (
+	"errors"
 	"reflect"
 	"strings"
 	"testing"
@@ -943,7 +944,9 @@ func Test_Editor_ProcessKeyDown_Callback(t *testing.T) {
 		key:                `s`,
 		ctrl:               true,
 		wantPrefentDefault: true,
-		wantSaveCalls:      1,
+		wantEventCalls: map[string]int{
+			SaveEvent: 1,
+		},
 	})
 
 	runKeyDownTest(t, testKeyDown{
@@ -958,7 +961,9 @@ func Test_Editor_ProcessKeyDown_Callback(t *testing.T) {
 		code:               "func main() {}",
 		key:                `Escape`,
 		wantPrefentDefault: true,
-		wantEscapeCalls:    1,
+		wantEventCalls: map[string]int{
+			EscapeEvent: 1,
+		},
 	})
 }
 
@@ -1135,8 +1140,7 @@ type testKeyDown struct {
 	wantSelectionStart int
 	wantSelectionEnd   int
 	wantPrefentDefault bool
-	wantSaveCalls      int
-	wantEscapeCalls    int
+	wantEventCalls     map[string]int
 }
 
 func runKeyDownTest(t *testing.T, tt testKeyDown) {
@@ -1152,8 +1156,7 @@ func runKeyDownTest(t *testing.T, tt testKeyDown) {
 		check(t, "selectedStart", cb.gotSelectionStart, tt.wantSelectionStart)
 		check(t, "selectedEnd", cb.gotSelectionEnd, tt.wantSelectionEnd)
 		check(t, "preventDefault", gotPreventDefault, tt.wantPrefentDefault)
-		check(t, "saveCalls", cb.getSaveCalls, tt.wantSaveCalls)
-		check(t, "escapeCalls", cb.gotEscapeCalls, tt.wantEscapeCalls)
+		check(t, "eventCalls", cb.gotEventCalls, tt.wantEventCalls)
 	})
 }
 
@@ -1165,25 +1168,29 @@ type fakeCodeBox struct {
 	gotCode           string
 	gotSelectionStart int
 	gotSelectionEnd   int
-	getSaveCalls      int
-	gotEscapeCalls    int
+	gotEventCalls     map[string]int
 }
 
 var _ CodeBoxWrapper = (*fakeCodeBox)(nil)
 
-func (cb *fakeCodeBox) Code() string        { return cb.initCode }
-func (cb *fakeCodeBox) SetCode(code string) { cb.gotCode = code }
-func (cb *fakeCodeBox) EmitSave()           { cb.getSaveCalls++ }
-func (cb *fakeCodeBox) EmitEscape()         { cb.gotEscapeCalls++ }
+func (cb *fakeCodeBox) Code() string { return cb.initCode }
+
+func (cb *fakeCodeBox) EmitEvent(event string) {
+	if cb.gotEventCalls == nil {
+		cb.gotEventCalls = map[string]int{}
+	}
+	cb.gotEventCalls[event]++
+}
 
 func (cb *fakeCodeBox) GetSelection() (int, int) {
 	return cb.initSelectionStart, cb.initSelectionEnd
 }
 
-func (cb *fakeCodeBox) SetSelection(start, end int, _ string) {
-	// the code parameter is unused in this fake implementation
-	// since it should match the gotCode set via SetCode and is only
-	// used when setting the selection after a code change.
+func (cb *fakeCodeBox) SetCode(start, end int, code string) {
+	if cb.gotCode != "" {
+		panic(errors.New(`SetCode called multiple times`))
+	}
+	cb.gotCode = code
 	cb.gotSelectionStart = start
 	cb.gotSelectionEnd = end
 }
@@ -1210,7 +1217,8 @@ func check[T any](t *testing.T, name string, got, want T) {
 		return
 	}
 
-	if reflect.TypeOf(want).Kind() == reflect.Slice {
+	kind := reflect.TypeOf(want).Kind()
+	if kind == reflect.Slice || kind == reflect.Map || kind == reflect.Struct {
 		if diff := cmp.Diff(want, got); len(diff) > 0 {
 			diff = strings.ReplaceAll(diff, "\n", "\n    ")
 			t.Errorf("%s was not as expected:\n"+

playground/internal/react/codeBox.go

@@ -79,14 +79,27 @@ type codeBoxAssistant struct {
 
 var _ editor.CodeBoxWrapper = (*codeBoxAssistant)(nil)
 
-func (cba *codeBoxAssistant) Code() string        { return cba.curCode }
-func (cba *codeBoxAssistant) SetCode(code string) { cba.setCode(code) }
-func (cba *codeBoxAssistant) EmitSave()           { cba.onSave() }
-func (cba *codeBoxAssistant) EmitEscape()         { cba.onEscape() }
+func (cba *codeBoxAssistant) Code() string { return cba.curCode }
 
-// TODO(grantnelson-wf): Implement undo/redo stack since textarea
-// only handles undo/redo itself for non-programmatic changes but
-// doesn't handle undo/redo for when setCode is called.
+func (cba *codeBoxAssistant) EmitEvent(event string) {
+	switch event {
+	case editor.SaveEvent:
+		cba.onSave()
+	case editor.EscapeEvent:
+		cba.onEscape()
+
+	//case editor.UndoEvent, editor.RedoEvent:
+	// TODO(grantnelson-wf): Implement undo/redo stack since textarea
+	// only handles undo/redo itself for non-programmatic changes but
+	// doesn't handle undo/redo for when setCode is called.
+
+	// TODO(grantnelson-wf): If it is possible to detect a paste event,
+	// then cleanup and indent the pasted code automatically.
+
+	default:
+		println("Unknown event was requested to be emitted from CodeBox:", event)
+	}
+}
 
 func (cba *codeBoxAssistant) onInput(e *js.Object) {
 	cba.setCode(e.Get(`target`).Get(`value`).String())
@@ -116,7 +129,10 @@ func (cba *codeBoxAssistant) GetSelection() (int, int) {
 	return start, end
 }
 
-func (cba *codeBoxAssistant) SetSelection(start, end int, code string) {
+func (cba *codeBoxAssistant) SetCode(start, end int, code string) {
+	// Update the code state for react.
+	cba.setCode(code)
+
 	// Pre-update the textarea value so that the caret and scroll can be set
 	// correctly before the next render so that the next render doesn't reset them.
 	cba.textAreaRef.Set(`value`, code)