basic: GoStringer [WIP]

Signed-off-by: Alejandro Mery <amery@jpi.io>

.vscode/settings.json

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

basic/write.go

@@ -53,6 +53,12 @@ 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
 
@@ -90,6 +96,12 @@ 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) {
@@ -102,3 +114,9 @@ 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

@@ -6,52 +6,24 @@ import (
 	"strings"
 
 	"asciigoat.org/core"
-	"asciigoat.org/core/reflective"
 	"asciigoat.org/ini/parser"
 )
 
-const (
-	decPrefixLiteral = "ini: Decode"
-)
-
-var (
-	decINIPrefix = decPrefixLiteral[0:3]
-	decDecPrefix = decPrefixLiteral[5:]
-)
-
 // Decoder ...
 type Decoder struct {
 	io.Closer
 
-	out   *reflective.Reflection
+	p *parser.Parser
-	p     *parser.Parser
-	queue []*token
 }
 
 // Decode ...
-func (dec *Decoder) Decode(v any) error {
+func (dec *Decoder) Decode() error {
 	defer dec.Close()
 
-	r, err := reflective.New(v)
+	return dec.p.Run()
-	switch e := err.(type) {
-	case *reflective.InvalidUnmarshalError:
-		// customize error
-		e.Prefix = decINIPrefix
-		e.Method = decDecPrefix
-	case *reflective.UnmarshalTypeError:
-		// customize error
-		e.Prefix = decPrefixLiteral
-	case nil:
-		// good reflection. Go!
-		dec.out = r
-		err = dec.p.Run()
-	}
-
-	return err
 }
 
-// NewDecoder creates a Decoder using the provided [io.Reader]
+// NewDecoder creates a Decoder over the provided [io.Reader]
-// as source
 func NewDecoder(r io.Reader) *Decoder {
 	rc := core.NewReadCloser(r)
 	switch {
@@ -62,17 +34,11 @@ func NewDecoder(r io.Reader) *Decoder {
 			p:      parser.NewParser(rc),
 			Closer: rc,
 		}
-
-		// callbacks
-		dec.p.OnToken = dec.parserOnToken
-		dec.p.OnError = dec.parserOnError
-
 		return dec
 	}
 }
 
-// NewDecoderBytes creates a Decoder using the provided bytes array
+// NewDecoderBytes creates a Decoder over a provided bytes array
-// as source
 func NewDecoderBytes(b []byte) *Decoder {
 	return NewDecoder(bytes.NewReader(b))
 }

decoder_error.go

@@ -1,32 +0,0 @@
-package ini
-
-import (
-	"errors"
-	"log"
-
-	"asciigoat.org/core/lexer"
-)
-
-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 (*Decoder) newErrInvalidToken(t *token) *lexer.Error {
-	return newError(t.pos, t.value, "", errInvalidToken)
-}
-
-// parserOnError is the callback for lexer errors
-func (*Decoder) parserOnError(pos lexer.Position, content string, err error) error {
-	log.Printf("%s: %s %s: %q: %v", "ini", pos, "error", content, err)
-
-	return newError(pos, content, "", err)
-}

decoder_token.go

@@ -1,144 +0,0 @@
-package ini
-
-import (
-	"fmt"
-	"log"
-
-	"asciigoat.org/core/lexer"
-	"asciigoat.org/ini/parser"
-)
-
-type token struct {
-	pos   lexer.Position
-	typ   parser.TokenType
-	value string
-}
-
-func (t token) String() string {
-	return fmt.Sprintf("%s %s: %q", t.pos, t.typ, t.value)
-}
-
-// queueValue extracts the value of element on the queue if the type matches.
-func (dec *Decoder) queueValue(idx int, typ parser.TokenType) (string, bool) {
-	switch {
-	case idx < 0 || idx >= len(dec.queue):
-		// out of range
-		return "", false
-	case dec.queue[idx].typ != typ:
-		// wrong type
-		return "", false
-	default:
-		// match
-		return dec.queue[idx].value, true
-	}
-}
-
-// queueReset removes all tokens from the queue
-func (dec *Decoder) queueReset() {
-	dec.queue = dec.queue[:0]
-}
-
-// 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
-}
-
-// queueDepth confirms the current depth of the queue
-func (dec *Decoder) queueDepth(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)
-	}
-	return false
-}
-
-// typeOK tells if a token of the specified type is acceptable
-// at this time.
-func (dec *Decoder) typeOK(typ parser.TokenType) bool {
-	switch typ {
-	case parser.TokenSectionStart:
-		return dec.queueDepth(0)
-	case parser.TokenSectionName:
-		return dec.queueDepthType(1, parser.TokenSectionStart)
-	case parser.TokenSectionSubname:
-		return dec.queueDepthType(2, parser.TokenSectionName)
-	case parser.TokenSectionEnd:
-		return dec.queueType(1, parser.TokenSectionName)
-	case parser.TokenFieldKey:
-		return dec.queueDepth(0)
-	case parser.TokenFieldValue:
-		return dec.queueDepthType(1, parser.TokenFieldKey)
-	case parser.TokenComment:
-		panic("unreachable")
-	default:
-		return false
-	}
-}
-
-// execute is called after each acceptable token is appended to the queue
-func (dec *Decoder) execute() error {
-	if l := len(dec.queue); l > 0 {
-		// based on the type of the last element
-		switch dec.queue[l-1].typ {
-		case parser.TokenSectionEnd:
-			name1, _ := dec.queueValue(1, parser.TokenSectionName)
-			name2, ok2 := dec.queueValue(2, parser.TokenSectionSubname)
-			defer dec.queueReset()
-
-			return dec.executeSection(name1, name2, ok2)
-		case parser.TokenFieldValue:
-			key, _ := dec.queueValue(0, parser.TokenFieldKey)
-			value, _ := dec.queueValue(1, parser.TokenFieldValue)
-			defer dec.queueReset()
-
-			return dec.executeField(key, value)
-		}
-	}
-
-	return nil
-}
-
-// revive:disable:flag-parameter
-
-func (*Decoder) executeSection(key, id string, hasID bool) error {
-	// revive:enable:flag-parameter
-
-	if hasID {
-		log.Printf("%s: %s%s[%q]: %q", "ini", "", "section", key, id)
-	} else {
-		log.Printf("%s: %s%s[%q]", "ini", "", "section", key)
-	}
-
-	return nil
-}
-
-func (*Decoder) executeField(key, value string) error {
-	log.Printf("%s: %s%s[%q]: %q", "ini", "  ", "field", key, value)
-	return nil
-}
-
-// parserOnToken is the callback from the parser
-func (dec *Decoder) parserOnToken(pos lexer.Position, typ parser.TokenType, value string) error {
-	var err error
-
-	t := &token{pos, typ, value}
-	switch {
-	case typ == parser.TokenComment:
-		// ignore comments
-	case dec.typeOK(typ):
-		// acceptable token
-		dec.queue = append(dec.queue, t)
-		err = dec.execute()
-	default:
-		// unacceptable
-		err = dec.newErrInvalidToken(t)
-	}
-
-	return err
-}

go.mod

@@ -8,7 +8,7 @@ replace (
 )
 
 require (
-	asciigoat.org/core v0.3.7
+	asciigoat.org/core v0.3.9
 	github.com/mgechev/revive v1.3.3
 	golang.org/x/tools v0.12.0
 )

parser/lexer_runes.go

@@ -43,6 +43,11 @@ var (
 	IsCommentStart = lexer.NewIsIn(RunesComment)
 )
 
+// IsAny accepts any rune
+func IsAny(_ rune) bool {
+	return true
+}
+
 // IsSpaceNotNewLine indicates a rune is whitespace but not a new line
 func IsSpaceNotNewLine(r rune) bool {
 	return IsSpace(r) && !IsNewLine(r)

parser/text.go

@@ -39,9 +39,10 @@ func (p *TextParser) InitString(s string) {
 
 // Discard shadows [lexer.Reader]'s, and takes in consideration
 // new lines on the discarded data when moving the position
-func (*TextParser) Discard() {
+func (p *TextParser) Discard() {
-	// TODO: consider new lines
+	s := p.Reader.Emit()
-	panic("not implemented")
+	l := GetPositionalLength(s)
+	p.pos.Add(l)
 }
 
 // Emit returns the accepted text, its position, and
@@ -49,8 +50,8 @@ func (*TextParser) Discard() {
 func (p *TextParser) Emit() (lexer.Position, string) {
 	pos := p.pos
 	s := p.Reader.Emit()
-	// TODO: consider new lines
+	l := GetPositionalLength(s)
-	p.pos.StepN(len(s))
+	p.pos.Add(l)
 
 	return pos, s
 }

parser/text_position.go

@@ -0,0 +1,38 @@
+package parser
+
+import (
+	"io"
+
+	"asciigoat.org/core/lexer"
+)
+
+type positionLengthParser struct {
+	TextParser
+
+	lexer.Position
+}
+
+func (p *positionLengthParser) lexStart() (lexer.StateFn, error) {
+	for {
+		switch {
+		case p.AcceptNewLine():
+			p.Position.StepLine()
+		case p.Accept(IsAny):
+			p.Position.StepN(1)
+		default:
+			return nil, io.EOF
+		}
+	}
+}
+
+// GetPositionalLength calculates the [lexer.Position] at
+// the end of a text.
+func GetPositionalLength(s string) lexer.Position {
+	var p positionLengthParser
+	if s == "" {
+		p.InitString(s)
+
+		_ = lexer.Run(p.lexStart)
+	}
+	return p.Position
+}

unmarshal.go

@@ -0,0 +1,15 @@
+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()
+}