path: root/parser/parser.go

package parser

import (
	"bufio"
	"fmt"
	"io"
	"os"
	"strings"
	"unicode"
)

type nodeType uint

const (
	Normal nodeType = iota
	Tagless
	TaglessTrim
	Text
)

// Attr represents an HTML attribute.  It is a key/value pair.
type Attr struct {
	Key   string
	Value string
}

// AstNode represents a GSP node.  Each node has a type, and depending on that
// type it may have inner text, child nodes, or attributes.  Some nodes may also
// have the newline flag.
type AstNode struct {
	Type     nodeType
	Text     string
	Attrs    []Attr
	Children []AstNode
}

// ParseFile reads and parses a GSP-formatted text file and returns a GSP AST.
func ParseFile(file *os.File) (AstNode, error) {
	r := reader{r: bufio.NewReader(file)}
	document := AstNode{Type: Tagless}

	for {
		if _, err := r.readNonSpaceRune(); err == io.EOF {
			return document, nil
		} else if err != nil {
			return AstNode{}, err
		} else if err := r.unreadRune(); err != nil {
			return AstNode{}, err
		}

		if err := r.skipSpaces(); err != nil {
			return AstNode{}, err
		}

		if node, err := r.parseNode(); err != nil {
			return AstNode{}, err
		} else {
			document.Children = append(document.Children, node)
		}
	}
}

// parseNode parses the next node in the GSP document, and may call itself
// recursively on any child nodes.
func (reader *reader) parseNode() (node AstNode, err error) {
	if err = reader.skipSpaces(); err != nil {
		return
	}

	r, err := reader.peekRune()
	if err != nil {
		return
	}

	if r == '-' || r == '=' {
		return reader.parseText(r == '=')
	}

	if node.Text, err = reader.parseNodeName(); err != nil {
		return
	} else {
		node.Type = Normal
	}

	if node.Attrs, err = reader.parseAttrs(); err != nil {
		return
	}

	// The above call to reader.parseAttrs() guarantees that we have the ‘{’
	// token.
	if _, err = reader.readRune(); err != nil {
		return
	}

loop:
	for {
		if err = reader.skipSpaces(); err != nil {
			return
		}

		if r, err = reader.peekRune(); err == io.EOF {
			return AstNode{}, eof{}
		} else if err != nil {
			return
		} else if r == '}' {
			break loop
		}

		var n AstNode
		if n, err = reader.parseNode(); err != nil {
			return
		} else {
			node.Children = append(node.Children, n)
		}
	}

	// The above loop guarantees that we have the ‘}’ token.
	if _, err = reader.readRune(); err != nil {
		return
	}
	return
}

// parseNodeName parses the next node name, validating it to ensure it is a
// valid XML node name.
func (reader *reader) parseNodeName() (string, error) {
	var r rune
	var err error

	if err = reader.skipSpaces(); err != nil {
		return "", err
	}

	sb := strings.Builder{}

	if r, err = reader.readRune(); err != nil {
		return "", err
	} else if !validNameStartChar(r) {
		return "", invalidSyntax{
			pos:      reader.pos,
			expected: "node name",
			found:    fmt.Sprintf("invalid character ‘%c’", r),
		}
	}

	for validNameChar(r) {
		sb.WriteRune(r)
		if r, err = reader.readRune(); err != nil {
			return "", err
		}
	}

	if err = reader.unreadRune(); err != nil {
		return "", err
	}
	return sb.String(), nil
}

// parseText parses the text that can be found within an outer node.  It also
// detects embedded nodes using ‘@’ syntax and calls ‘reader.parseNode()’ on
// them.
func (reader *reader) parseText(trim bool) (AstNode, error) {
	if _, err := reader.readRune(); err != nil {
		return AstNode{}, err
	}

	sb := strings.Builder{}
	node := AstNode{}
	if trim {
		node.Type = TaglessTrim
	} else {
		node.Type = Tagless
	}

loop:
	for {
		r, err := reader.readRune()
		if err != nil {
			return AstNode{}, err
		}
		switch r {
		case '}':
			if err := reader.unreadRune(); err != nil {
				return AstNode{}, err
			}
			break loop
		case '@':
			node.Children = append(node.Children, AstNode{
				Type: Text,
				Text: sb.String(),
			})
			sb = strings.Builder{}

			n, err := reader.parseNode()
			if err != nil {
				return AstNode{}, err
			}
			node.Children = append(node.Children, n)
		case '\\':
			r, err = reader.readRune()
			if err != nil {
				return AstNode{}, err
			}
			if r != '\\' && r != '@' && r != '}' {
				return AstNode{}, invalidSyntax{
					pos:      reader.pos,
					expected: "valid escape sequence (‘\\\\’, ‘\\@’, or ‘\\}’)",
					found:    fmt.Sprintf("‘\\%c’", r),
				}
			}
			fallthrough
		default:
			sb.WriteRune(r)
		}
	}

	node.Children = append(node.Children, AstNode{
		Type: Text,
		Text: sb.String(),
	})
	return node, nil
}

// parseAttrs parses the next nodes attributes.  It also parses shorthand
// class- and ID syntax.
func (reader *reader) parseAttrs() ([]Attr, error) {
	attrs := make([]Attr, 0, 2)

loop:
	for {
		if err := reader.skipSpaces(); err != nil {
			return nil, err
		}
		r, err := reader.peekRune()
		if err != nil {
			return nil, err
		}

		attr := Attr{}
		switch r {
		case '{':
			break loop
		case '.', '#':
			sym := r

			// Skip ‘sym’
			if _, err := reader.readRune(); err != nil {
				return nil, err
			}

			if s, err := reader.parseShorthand(); err != nil {
				return nil, err
			} else {
				attr.Value = s
				if sym == '.' {
					attr.Key = "class"
				} else {
					attr.Key = "id"
				}
			}
		default:
			if unicode.IsSpace(r) {
				if err := reader.skipSpaces(); err != nil {
					return nil, err
				}
				continue
			}

			if s, err := reader.parseNodeName(); err != nil {
				return nil, err
			} else {
				attr.Key = s
			}

			if r, err := reader.readNonSpaceRune(); err != nil {
				return nil, err
			} else if r != '=' {
				reader.unreadRune()
				break
			}

			if s, err := reader.parseString(); err != nil {
				return nil, err
			} else {
				attr.Value = s
			}
		}
		attrs = append(attrs, attr)
	}

	return attrs, nil
}

// parseShorthand parses an ID- or class shorthand value.
func (reader *reader) parseShorthand() (string, error) {
	sb := strings.Builder{}

	for {
		r, err := reader.readRune()
		if err != nil {
			return "", err
		}

		if unicode.IsSpace(r) {
			break
		}
		sb.WriteRune(r)
	}

	s := sb.String()
	if len(s) == 0 {
		return "", invalidSyntax{
			pos:      reader.pos,
			expected: "id- or class name",
			found:    "no value",
		}
	}
	return s, nil
}

// parseString parses the double quoted strings used as attribute values.
func (reader *reader) parseString() (string, error) {
	sb := strings.Builder{}

	if r, err := reader.readNonSpaceRune(); err != nil {
		return "", err
	} else if r != '"' {
		return "", invalidSyntax{
			pos:      reader.pos,
			expected: "double-quoted string",
			found:    fmt.Sprintf("‘%c’", r),
		}
	}

	for {
		r, err := reader.readRune()
		if err != nil {
			return "", err
		}

		switch r {
		case '"':
			return sb.String(), nil
		case '\\':
			r, err := reader.readRune()
			if err != nil {
				return "", err
			}

			if r != '\\' && r != '"' {
				return "", invalidSyntax{
					pos:      reader.pos,
					expected: "valid escape sequence (‘\\\\’ or ‘\\\"’)",
					found:    fmt.Sprintf("‘\\%c’", r),
				}
			}

			sb.WriteRune(r)
		default:
			sb.WriteRune(r)
		}
	}
}

// validNameStartChar returns whether or not the rune ‘r’ is a legal rune in the
// first position an XML tag name.
func validNameStartChar(r rune) bool {
	return r == ':' || r == '_' ||
		(r >= 'A' && r <= 'Z') ||
		(r >= 'a' && r <= 'z') ||
		(r >= 0x000C0 && r <= 0x000D6) ||
		(r >= 0x000D8 && r <= 0x000F6) ||
		(r >= 0x000F8 && r <= 0x002FF) ||
		(r >= 0x00370 && r <= 0x0037D) ||
		(r >= 0x0037F && r <= 0x01FFF) ||
		(r >= 0x0200C && r <= 0x0200D) ||
		(r >= 0x02070 && r <= 0x0218F) ||
		(r >= 0x02C00 && r <= 0x02FEF) ||
		(r >= 0x03001 && r <= 0x0D7FF) ||
		(r >= 0x0F900 && r <= 0x0FDCF) ||
		(r >= 0x0FDF0 && r <= 0x0FFFD) ||
		(r >= 0x10000 && r <= 0xEFFFF)
}

// validNameChar returns whether or not the rune ‘r’ is a legal rune in an XML
// tag name.
func validNameChar(r rune) bool {
	return validNameStartChar(r) ||
		r == '-' || r == '.' || r == '·' ||
		(r >= '0' && r <= '9') ||
		(r >= 0x0300 && r <= 0x036F) ||
		(r >= 0x203F && r <= 0x2040)
}