government / src / sexpr / reader.go

@ 18f7f5ebceecb0e295c3daf959d352ed8b8b9694 | history


package sexpr

import (
	"fmt"
	"math"
	"regexp"
	"strconv"
)

// Reader parses source text into values by recursive descent over the
// grammar:
//
//	datum = atom | string | "'" datum | "(" list
//	list  = ")" | datum { datum } [ "." datum ] ")"
//
// The reader also records where each list starts, so errors can point at
// source positions, and keeps the comments it passes, so tests can read
// their annotations.
type Reader struct {
	lex       *Lexer
	peeked    *Token
	positions map[*Pair]Pos
	comments  []Token
	lastEnd   Pos
}

func NewReader(src string) *Reader {
	return &Reader{lex: NewLexer(src), positions: map[*Pair]Pos{}}
}

// Position returns where a list read by r starts: its "(" or, for 'x, its
// quote mark. Atoms have no recorded position.
func (r *Reader) Position(v Value) (Pos, bool) {
	p, ok := v.(*Pair)
	if !ok {
		return Pos{}, false
	}
	pos, ok := r.positions[p]
	return pos, ok
}

// Comments returns the comments read so far, in source order.
func (r *Reader) Comments() []Token {
	return r.comments
}

// ReadAll returns every top-level form in src.
func ReadAll(src string) ([]Value, error) {
	r := NewReader(src)
	var forms []Value
	for {
		v, err := r.Read()
		if err != nil {
			return nil, err
		}
		if v == nil {
			return forms, nil
		}
		forms = append(forms, v)
	}
}

// Read returns the next top-level form, or nil at end of input.
func (r *Reader) Read() (Value, error) {
	v, _, err := r.ReadWithPos()
	return v, err
}

// ReadWithPos is Read that also returns where the form starts.
func (r *Reader) ReadWithPos() (Value, Pos, error) {
	d, err := r.ReadDatum()
	if err != nil || d == nil {
		return nil, Pos{}, err
	}
	return d.Value, d.Start, nil
}

// ReadDatum returns the next top-level form as a datum, or nil at end of
// input. Notes are not attached yet: a comment may describe a datum read
// later, so ReadProgram attaches them once everything is read.
func (r *Reader) ReadDatum() (*Datum, error) {
	t, err := r.peek()
	if err != nil {
		return nil, err
	}
	if t.Kind == TokEOF {
		return nil, nil
	}
	return r.datum()
}

func (r *Reader) datum() (*Datum, error) {
	t, err := r.next()
	if err != nil {
		return nil, err
	}
	switch t.Kind {
	case TokAtom:
		v, err := parseAtom(t)
		if err != nil {
			return nil, err
		}
		return &Datum{Value: v, Start: t.Pos, End: t.End}, nil
	case TokString:
		return &Datum{Value: String(t.Text), Start: t.Pos, End: t.End}, nil
	case TokQuote:
		next, err := r.peek()
		if err != nil {
			return nil, err
		}
		if next.Kind == TokEOF || next.Kind == TokRParen {
			return nil, &SyntaxError{Pos: t.Pos, Msg: "' must be followed by a value", Incomplete: next.Kind == TokEOF}
		}
		inner, err := r.datum()
		if err != nil {
			return nil, err
		}
		// 'x is (quote x): a list whose first element is the quote mark.
		quote := &Datum{Value: Symbol("quote"), Start: t.Pos, End: t.End}
		d := &Datum{Value: List(quote.Value, inner.Value), Start: t.Pos, End: inner.End, Elems: []*Datum{quote, inner}}
		r.record(d)
		return d, nil
	case TokLParen:
		d, err := r.list(t.Pos)
		if err != nil {
			return nil, err
		}
		d.Start, d.End = t.Pos, r.lastEnd
		r.record(d)
		return d, nil
	case TokRParen:
		return nil, &SyntaxError{Pos: t.Pos, Msg: "unexpected )"}
	case TokDot:
		return nil, &SyntaxError{Pos: t.Pos, Msg: "unexpected . outside a list"}
	}
	panic(fmt.Sprintf("sexpr: reader got token %v", t.Kind))
}

// list parses the rest of a list after its "(". Errors about a missing ")"
// point at the "(" that opened the list, which is where the mistake usually
// is.
func (r *Reader) list(open Pos) (*Datum, error) {
	var items []*Datum
	for {
		t, err := r.peek()
		if err != nil {
			return nil, err
		}
		switch t.Kind {
		case TokEOF:
			return nil, &SyntaxError{Pos: open, Msg: "unterminated list", Incomplete: true}
		case TokRParen:
			r.next()
			return listDatum(items, nil, nil), nil
		case TokDot:
			if len(items) == 0 {
				return nil, &SyntaxError{Pos: t.Pos, Msg: "a dotted pair needs a value before ."}
			}
			r.next()
			dot := &Datum{Value: Symbol("."), Start: t.Pos, End: t.End, Dot: true}
			return r.dottedTail(dot, open, items)
		}
		d, err := r.datum()
		if err != nil {
			return nil, err
		}
		items = append(items, d)
	}
}

// listDatum builds the datum for a list of items with an optional dotted
// tail. A tail that is a list, or (), is no dotted pair: its elements just
// continue this list, so they become this datum's elements too, and the
// "." and the tail's own parentheses leave no datum behind.
func listDatum(items []*Datum, dot, tail *Datum) *Datum {
	d := &Datum{Elems: items}
	values := make([]Value, len(items))
	for i, item := range items {
		values[i] = item.Value
	}
	if tail == nil {
		d.Value = List(values...)
		return d
	}
	d.Value = ListWithTail(tail.Value, values...)
	switch tail.Value.(type) {
	case *Pair:
		d.Elems = append(d.Elems, tail.Elems...)
	case Empty:
	default:
		d.Elems = append(d.Elems, dot, tail)
	}
	return d
}

// dottedTail parses the single value after "." and the ")" that must follow
// it: a pair has exactly one cdr.
func (r *Reader) dottedTail(dot *Datum, open Pos, items []*Datum) (*Datum, error) {
	t, err := r.peek()
	if err != nil {
		return nil, err
	}
	switch t.Kind {
	case TokRParen, TokEOF:
		return nil, &SyntaxError{Pos: dot.Start, Msg: "expected a value after .", Incomplete: t.Kind == TokEOF}
	case TokDot:
		return nil, &SyntaxError{Pos: t.Pos, Msg: "only one . is allowed in a list"}
	}
	tail, err := r.datum()
	if err != nil {
		return nil, err
	}
	t, err = r.next()
	if err != nil {
		return nil, err
	}
	switch t.Kind {
	case TokRParen:
		return listDatum(items, dot, tail), nil
	case TokEOF:
		return nil, &SyntaxError{Pos: open, Msg: "unterminated list", Incomplete: true}
	case TokDot:
		return nil, &SyntaxError{Pos: t.Pos, Msg: "only one . is allowed in a list"}
	}
	return nil, &SyntaxError{Pos: t.Pos, Msg: "expected ) after the value following ."}
}

// record remembers where a list starts, so errors can point at it.
func (r *Reader) record(d *Datum) {
	if p, ok := d.Value.(*Pair); ok {
		r.positions[p] = d.Start
	}
}

// next and peek give the reader one token of lookahead, which is all this
// grammar needs (it is LL(1)). Comments are set aside here.
func (r *Reader) next() (Token, error) {
	if r.peeked != nil {
		t := *r.peeked
		r.peeked = nil
		r.lastEnd = t.End
		return t, nil
	}
	t, err := r.fetch()
	if err == nil {
		r.lastEnd = t.End
	}
	return t, err
}

func (r *Reader) fetch() (Token, error) {
	for {
		t, err := r.lex.Next()
		if err != nil || t.Kind != TokComment {
			return t, err
		}
		r.comments = append(r.comments, t)
	}
}

func (r *Reader) peek() (Token, error) {
	if r.peeked == nil {
		t, err := r.fetch()
		if err != nil {
			return Token{}, err
		}
		r.peeked = &t
	}
	return *r.peeked, nil
}

var (
	intPattern   = regexp.MustCompile(`^-?(0|[1-9][0-9]*)$`)
	floatPattern = regexp.MustCompile(`^-?[0-9]+\.[0-9]+([eE][-+]?[0-9]+)?$`)
	// Anything starting like a number must be a valid one, so "007", "1."
	// and ".5" are errors rather than surprising symbols.
	numberLike = regexp.MustCompile(`^[-+]?\.?[0-9]`)
)

func parseAtom(t Token) (Value, error) {
	switch t.Text {
	case "T":
		return T, nil
	case "F":
		return F, nil
	}
	v, ok, err := ParseNumber(t.Text)
	if err != nil {
		return nil, &SyntaxError{Pos: t.Pos, Msg: err.Error()}
	}
	if ok {
		return v, nil
	}
	return Symbol(t.Text), nil
}

// ParseNumber reads s as a number literal. ok is false when s does not start
// like a number, so it is a symbol. The OID decoder uses this too, so a
// payload is a valid integer, float or symbol exactly when the same text is
// in source.
func ParseNumber(s string) (v Value, ok bool, err error) {
	switch {
	case intPattern.MatchString(s):
		n, err := strconv.ParseInt(s, 10, 64)
		if err != nil {
			return nil, true, fmt.Errorf("integer %s does not fit in 64 bits", s)
		}
		return Int(n), true, nil
	case floatPattern.MatchString(s):
		f, err := strconv.ParseFloat(s, 64)
		if err != nil || math.IsInf(f, 0) {
			return nil, true, fmt.Errorf("float %s is out of range", s)
		}
		return Float(f), true, nil
	case numberLike.MatchString(s):
		return nil, true, fmt.Errorf("malformed number %s", s)
	}
	return nil, false, nil
}