engine

Documentation

Overview

Package engine is a small real-time Vim emulator: feed it keystrokes, it mutates buffer/cursor/mode state and reports what happened.

Index

• Variables
• type Event
• type EventKind
• type Goal
  • func (g Goal) Met(s *Simulator) bool
• type Mode
• type Pos
• type Simulator
  • func New(lines []string, cursor Pos) *Simulator
  • func (s *Simulator) LastSearch() string
  • func (s *Simulator) Pending() string
  • func (s *Simulator) Press(key string) Event
  • func (s *Simulator) WordAtCursor() string

Variables

var GoalTypes = []string{
	"cursorOnWord", "bufferEquals", "lineDeleted",
	"wordDeleted", "containsText", "searchMatchActive",
}

GoalTypes lists every valid Goal.Type, for content validation.

Types

type Event

type Event struct {
	Kind EventKind
}

type EventKind

type EventKind int

const (
	EvNone EventKind = iota
	EvMoved
	EvEdited
	EvModeChanged
	EvPending
	EvSearchJumped
	EvInvalid
)

type Goal

type Goal struct {
	Type  string   `json:"type"`
	Word  string   `json:"word,omitempty"`
	Line  string   `json:"line,omitempty"`
	Lines []string `json:"lines,omitempty"`
	Text  string   `json:"text,omitempty"`
	Term  string   `json:"term,omitempty"`
}

Goal is a challenge success condition, decoded straight from lesson JSON.

func (Goal) Met

func (g Goal) Met(s *Simulator) bool

type Mode

type Mode int

const (
	ModeNormal Mode = iota
	ModeInsert
	ModeSearch
)

type Pos

type Pos struct{ Row, Col int }

type Simulator

type Simulator struct {
	Buffer []string
	Cursor Pos
	Mode   Mode

	// AllowedKeys restricts normal-mode commands; nil allows everything.
	AllowedKeys map[string]bool

	SearchQuery string
	// contains filtered or unexported fields
}

func New

func New(lines []string, cursor Pos) *Simulator

func (*Simulator) LastSearch

func (s *Simulator) LastSearch() string

func (*Simulator) Pending

func (s *Simulator) Pending() string

Pending returns the visible pending state ("d", "3", "3d", "di", "g") for the HUD.

func (*Simulator) Press

func (s *Simulator) Press(key string) Event

func (*Simulator) WordAtCursor

func (s *Simulator) WordAtCursor() string

WordAtCursor returns the space-delimited word under the cursor, or "".