Merge pull request 'parser: introduce NewError() and ErrPlusPosition()' (#8)

Reviewed-on: #8

.vscode/settings.json

@@ -1,7 +0,0 @@
-{
-    "cSpell.words": [
-        "asciigoat",
-        "Subname",
-        "unescapes"
-    ]
-}

basic/error.go

@@ -4,28 +4,19 @@ import (
 	"errors"
 
 	"asciigoat.org/core/lexer"
+	"asciigoat.org/ini/parser"
 )
 
 var (
 	errInvalidToken = errors.New("invalid token")
 )
 
-func newError(pos lexer.Position, content, hint string, err error) *lexer.Error {
-	return &lexer.Error{
-		Line:    pos.Line,
-		Column:  pos.Column,
-		Content: content,
-		Hint:    hint,
-		Err:     err,
-	}
-}
-
 func newErrInvalidToken(t *token) *lexer.Error {
-	return newError(t.pos, t.value, "", errInvalidToken)
+	return parser.NewError(t.pos, t.value, "", errInvalidToken)
 }
 
 func (dec *decoder) OnError(pos lexer.Position, content string, err error) error {
-	err = newError(pos, content, "", err)
+	err = parser.NewError(pos, content, "", err)
 	dec.executeFinal()
 	return err
 }

basic/token.go

@@ -32,21 +32,21 @@ func (dec *decoder) executeFinal() {
 func (dec *decoder) execute(typ parser.TokenType) {
 	switch typ {
 	case parser.TokenSectionEnd:
-		name1, ok1 := dec.queueValue(1, parser.TokenSectionName)
+		name1, ok1 := dec.getValue(1, parser.TokenSectionName)
 
 		if ok1 {
-			name2, ok2 := dec.queueValue(2, parser.TokenSectionSubname)
+			name2, ok2 := dec.getValue(2, parser.TokenSectionSubname)
 
 			dec.addSection(name1, name2, ok2)
 		}
 
-		dec.queueReset()
+		dec.reset()
 	case parser.TokenFieldValue:
-		key, _ := dec.queueValue(0, parser.TokenFieldKey)
-		value, _ := dec.queueValue(1, parser.TokenFieldValue)
+		key, _ := dec.getValue(0, parser.TokenFieldKey)
+		value, _ := dec.getValue(1, parser.TokenFieldValue)
 
 		dec.addField(key, value)
-		dec.queueReset()
+		dec.reset()
 	}
 }
 
@@ -82,8 +82,7 @@ func (dec *decoder) addField(key, value string) {
 	}
 }
 
-// queueValue extracts the value of element on the queue if the type matches.
-func (dec *decoder) queueValue(idx int, typ parser.TokenType) (string, bool) {
+func (dec *decoder) getValue(idx int, typ parser.TokenType) (string, bool) {
 	switch {
 	case idx < 0 || idx >= len(dec.queue):
 		// out of range
@@ -96,48 +95,40 @@ func (dec *decoder) queueValue(idx int, typ parser.TokenType) (string, bool) {
 	}
 }
 
-// queueReset removes all tokens from the queue
-func (dec *decoder) queueReset() {
+func (dec *decoder) reset() {
 	dec.queue = dec.queue[:0]
 }
 
-// queueDepth confirms the current depth of the queue
-func (dec *decoder) queueDepth(depth int) bool {
+func (dec *decoder) depth(depth int) bool {
 	return len(dec.queue) == depth
 }
 
-// queueDepthType confirms the current depth of the queue and the type of the last
-// element.
-func (dec *decoder) queueDepthType(depth int, typ parser.TokenType) bool {
-	if dec.queueDepth(depth) {
-		return dec.queueType(depth-1, typ)
+func (dec *decoder) depthAfter(depth int, typ parser.TokenType) bool {
+	_, ok := dec.getValue(depth-1, typ)
+	if ok {
+		return len(dec.queue) == depth
 	}
 	return false
 }
 
-// queueType tells if the specified element on the queue is of the required type.
-func (dec *decoder) queueType(idx int, typ parser.TokenType) bool {
-	_, ok := dec.queueValue(idx, typ)
-	return ok
-}
-
 func (dec *decoder) typeOK(typ parser.TokenType) bool {
 	switch typ {
 	case parser.TokenSectionStart, parser.TokenFieldKey:
 		// first token only
-		return dec.queueDepth(0)
+		return dec.depth(0)
 	case parser.TokenSectionName:
 		// right after TokenSectionStart
-		return dec.queueDepthType(1, parser.TokenSectionStart)
+		return dec.depthAfter(1, parser.TokenSectionStart)
 	case parser.TokenSectionSubname:
 		// right after TokenSectionName
-		return dec.queueDepthType(2, parser.TokenSectionName)
+		return dec.depthAfter(2, parser.TokenSectionName)
 	case parser.TokenSectionEnd:
 		// only on a section with name
-		return dec.queueType(1, parser.TokenSectionName)
+		_, ok := dec.getValue(1, parser.TokenSectionName)
+		return ok
 	case parser.TokenFieldValue:
 		// right after a TokenFieldKey
-		return dec.queueDepthType(1, parser.TokenFieldKey)
+		return dec.depthAfter(1, parser.TokenFieldKey)
 	default:
 		// never
 		return false
@@ -158,8 +149,6 @@ func (dec *decoder) OnToken(pos lexer.Position, typ parser.TokenType, value stri
 		return nil
 	default:
 		// unacceptable
-		err := newErrInvalidToken(t)
-		dec.executeFinal()
-		return err
+		return newErrInvalidToken(t)
 	}
 }

basic/write.go

@@ -53,12 +53,6 @@ func (field Field) String() string {
 	return buf.String()
 }
 
-// GoString generates a string output for "%#v"
-func (*Field) GoString() string {
-	var buf bytes.Buffer
-	return buf.String()
-}
-
 func writeSectionToBuffer(w *bytes.Buffer, sec *Section, nl string) int {
 	var written, n int
 
@@ -96,12 +90,6 @@ func (sec *Section) String() string {
 	return buf.String()
 }
 
-// GoString generates a string output for "%#v"
-func (*Section) GoString() string {
-	var buf bytes.Buffer
-	return buf.String()
-}
-
 // WriteTo writes a INI representation of the document
 // onto the provided writer.
 func (doc *Document) WriteTo(w io.Writer) (int64, error) {
@@ -114,9 +102,3 @@ func (doc *Document) String() string {
 	buf := doc.AsBuffer(WriteNewLine)
 	return buf.String()
 }
-
-// GoString generates a string output for "%#v"
-func (Document) GoString() string {
-	var buf bytes.Buffer
-	return buf.String()
-}

decoder.go

@@ -1,49 +0,0 @@
-package ini
-
-import (
-	"bytes"
-	"io"
-	"strings"
-
-	"asciigoat.org/core"
-	"asciigoat.org/ini/parser"
-)
-
-// Decoder ...
-type Decoder struct {
-	io.Closer
-
-	p *parser.Parser
-}
-
-// Decode ...
-func (dec *Decoder) Decode() error {
-	defer dec.Close()
-
-	return dec.p.Run()
-}
-
-// NewDecoder creates a Decoder over the provided [io.Reader]
-func NewDecoder(r io.Reader) *Decoder {
-	rc := core.NewReadCloser(r)
-	switch {
-	case rc == nil:
-		return nil
-	default:
-		dec := &Decoder{
-			p:      parser.NewParser(rc),
-			Closer: rc,
-		}
-		return dec
-	}
-}
-
-// NewDecoderBytes creates a Decoder over a provided bytes array
-func NewDecoderBytes(b []byte) *Decoder {
-	return NewDecoder(bytes.NewReader(b))
-}
-
-// NewDecoderString creates a Decoder over a provided string of data
-func NewDecoderString(s string) *Decoder {
-	return NewDecoder(strings.NewReader(s))
-}

go.mod

@@ -2,11 +2,6 @@ module asciigoat.org/ini
 
 go 1.19
 
-replace (
-	asciigoat.org/core => ../core
-	darvaza.org/core => ../../darvaza.org/core
-)
-
 require (
 	asciigoat.org/core v0.3.9
 	github.com/mgechev/revive v1.3.3

go.sum

@@ -1,3 +1,5 @@
+asciigoat.org/core v0.3.9 h1:hgDDz4ecm3ZvehX++m8A/IzAt+B5oDPiRtxatzfUHPQ=
+asciigoat.org/core v0.3.9/go.mod h1:CAaHwyw8MpAq4a1MYtN2dxJrsK+hmIdW50OndaQZYPI=
 github.com/BurntSushi/toml v1.3.2 h1:o7IhLm0Msx3BaB+n3Ag7L8EVlByGnpq14C4YWiu/gL8=
 github.com/BurntSushi/toml v1.3.2/go.mod h1:CxXYINrC8qIiEnFrOxCa7Jy5BFHlXnUU2pbicEuybxQ=
 github.com/chavacava/garif v0.1.0 h1:2JHa3hbYf5D9dsgseMKAmc/MZ109otzgNFk5s87H9Pc=

parser/error.go

@@ -0,0 +1,27 @@
+package parser
+
+import (
+	"asciigoat.org/core/lexer"
+)
+
+// NewError creates a lexer.Error using a lexer.Position
+func NewError(pos lexer.Position, content, hint string, err error) *lexer.Error {
+	return &lexer.Error{
+		Line:    pos.Line,
+		Column:  pos.Column,
+		Content: content,
+		Hint:    hint,
+		Err:     err,
+	}
+}
+
+// ErrPlusPosition returns a copy of the given [lexer.Error]
+// offsetting the Line/Column information.
+func ErrPlusPosition(pos lexer.Position, e *lexer.Error) *lexer.Error {
+	pos.Add(lexer.Position{
+		Line:   e.Line,
+		Column: e.Column,
+	})
+
+	return NewError(pos, e.Content, e.Hint, e.Err)
+}

parser/parser.go

@@ -31,13 +31,7 @@ func defaultOnToken(pos lexer.Position, typ TokenType, value string) error {
 func defaultOnError(pos lexer.Position, content string, err error) error {
 	log.Printf("%s:%v:%v: %q: %s", "error", pos.Line, pos.Column, content, err)
 
-	return lexer.Error{
-		Line:   pos.Line,
-		Column: pos.Column,
-
-		Content: content,
-		Err:     err,
-	}
+	return NewError(pos, content, "", err)
 }
 
 func (p *Parser) setDefaults() {

unmarshal.go

@@ -1,15 +0,0 @@
-package ini
-
-import "io"
-
-// ReadInto ...
-func ReadInto(v any, r io.Reader) error {
-	dec := NewDecoder(r)
-
-	return dec.Unmarshal(v)
-}
-
-// Unmarshal ...
-func (dec *Decoder) Unmarshal(any) error {
-	return dec.p.Run()
-}