basic: rename and document queue related methods

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

.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
 }

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/comma_array.go

@@ -1,90 +0,0 @@
-package parser
-
-import (
-	"asciigoat.org/core/lexer"
-)
-
-type commaArrayParser struct {
-	TextParser
-
-	out []string
-}
-
-func (p *commaArrayParser) lexStart() (lexer.StateFn, error) {
-	for {
-		r, _, err := p.ReadRune()
-		switch {
-		case err != nil:
-			// EOF
-			return nil, err
-		case r == RuneQuotes:
-			// Quoted Value
-			return p.lexQuotedString, nil
-		case IsNewLine(r):
-			// new lines are acceptable when parsing a string for
-			// comma delimited arrays. but make sure we discard it
-			// complete
-			p.UnreadRune()
-			p.AcceptNewLine()
-			p.Discard()
-		case lexer.IsSpace(r):
-			// discard whitespace outside quotes
-			p.Discard()
-		default:
-			p.UnreadRune()
-			return p.lexWord, nil
-		}
-	}
-}
-
-func (p *commaArrayParser) lexWord() (lexer.StateFn, error) {
-	for {
-		r, _, err := p.ReadRune()
-		switch {
-		case err != nil:
-			// done. store what we got and move on
-			_, s := p.Emit()
-			p.out = append(p.out, s)
-			return nil, err
-		case r == RuneEscape:
-			// escaped
-			r2, _, err := p.ReadRune()
-			switch {
-			case err != nil:
-				// incomplete
-				return nil, NewErrIncompleteEscaped(&p.TextParser)
-			case IsNewLine(r2):
-				// escaped new line
-				p.UnreadRune()
-				p.AcceptNewLine()
-			}
-		}
-	}
-}
-
-func (p *commaArrayParser) lexQuotedString() (lexer.StateFn, error) {
-	s, err := lexQuotedString(&p.TextParser)
-	if err != nil {
-		return nil, err
-	}
-
-	p.Discard()
-	p.out = append(p.out, s)
-	return p.lexStart, nil
-}
-
-func (p *commaArrayParser) Run() ([]string, error) {
-	err := lexer.Run(p.lexStart)
-
-	return p.out, err
-}
-
-// SplitCommaArray splits
-func SplitCommaArray(s string) ([]string, error) {
-	if s != "" {
-		var p commaArrayParser
-		p.InitString(s)
-		return p.Run()
-	}
-	return nil, nil
-}

parser/error.go

@@ -1,11 +1,20 @@
 package parser
 
 import (
-	"io/fs"
-
 	"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 {
@@ -14,38 +23,5 @@ func ErrPlusPosition(pos lexer.Position, e *lexer.Error) *lexer.Error {
 		Column: e.Column,
 	})
 
-	return &lexer.Error{
+	return NewError(pos, e.Content, e.Hint, e.Err)
-		Line:    pos.Line,
-		Column:  pos.Column,
-		Content: e.Content,
-		Hint:    e.Hint,
-		Err:     e.Err,
-	}
-}
-
-// NewErrIncompleteQuotedString returns a [lexer.Error]
-// indicating the quoted string being parsed wasn't correctly
-// terminated
-func NewErrIncompleteQuotedString(p *TextParser) *lexer.Error {
-	return newErrIncomplete(p, "incomplete quoted string")
-}
-
-// NewErrIncompleteEscaped returns a [lexer.Error]
-// indicating the text being parsed wasn't correctly
-// terminated
-func NewErrIncompleteEscaped(p *TextParser) *lexer.Error {
-	return newErrIncomplete(p, "incomplete escaped string")
-}
-
-func newErrIncomplete(p *TextParser, hint string) *lexer.Error {
-	pos, s := p.Emit()
-	pos.Add(GetPositionalLength(s))
-
-	return &lexer.Error{
-		Line:    pos.Line,
-		Column:  pos.Column,
-		Content: s,
-		Hint:    hint,
-		Err:     fs.ErrInvalid,
-	}
 }

parser/lexer_runes.go

@@ -7,13 +7,11 @@ import (
 )
 
 const (
-	RuneComment      = ';'  // RuneComment is the standard INI comment character
+	RuneComment      = ';' // RuneComment is the standard dosini comment character
 	RuneCommentExtra = '#' // RuneCommentExtra is UNIX shell's comment character
 	RuneSectionStart = '[' // RuneSectionStart indicates the start of a section declaration
-	RuneSectionEnd   = ']'  // RuneSectionEnd indicates the end of a section declaration
+	RuneSectionEnd   = ']' // RuneSectionEnd indiciates the end of a section declaration
 	RuneFieldEqual   = '=' // RuneFieldEqual separates field keys from their values
-	RuneQuotes       = '"'  // RuneQuotes indicates the start and end of a quoted value
-	RuneEscape       = '\\' // RuneEscape indicates the next rune is escaped
 )
 
 var (
@@ -29,8 +27,6 @@ var (
 		RuneSectionStart,
 		RuneSectionEnd,
 		RuneFieldEqual,
-		RuneQuotes,
-		RuneEscape,
 	})
 )
 

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{
+	return NewError(pos, content, "", err)
-		Line:   pos.Line,
-		Column: pos.Column,
-
-		Content: content,
-		Err:     err,
-	}
 }
 
 func (p *Parser) setDefaults() {

parser/text_quoted.go

@@ -1,112 +0,0 @@
-package parser
-
-import (
-	"asciigoat.org/core/lexer"
-)
-
-// AcceptQuotedString consumes a quoted string from the source
-// and returns it unquoted.
-func (p *TextParser) AcceptQuotedString() (string, bool, error) {
-	r, _, err := p.ReadRune()
-	switch {
-	case err != nil:
-		// nothing here
-		return "", false, err
-	case r != RuneQuotes:
-		// not for us
-		p.UnreadRune()
-		return "", false, nil
-	default:
-		// let's roll
-		s, err := lexQuotedString(p)
-		switch {
-		case err != nil:
-			// bad quoted string
-			return "", false, err
-		default:
-			// success
-			return s, true, nil
-		}
-	}
-}
-
-func lexQuotedString(p *TextParser) (string, *lexer.Error) {
-	s, ok, err := lexQuotedStringNoEscape(p)
-	switch {
-	case err != nil:
-		return "", err
-	case ok:
-		return s, nil
-	default:
-		// escape character detected
-		return lexQuotedStringEscaped(p)
-	}
-}
-
-func lexQuotedStringNoEscape(p *TextParser) (string, bool, *lexer.Error) {
-	for {
-		r, _, err := p.ReadRune()
-		switch {
-		case err != nil:
-			// incomplete
-			return "", false, NewErrIncompleteQuotedString(p)
-		case r == RuneQuotes:
-			// end, just remove the quotes
-			s := p.String()
-			l := len(s)
-			return s[1 : l-2], true, nil
-		case r == RuneEscape:
-			// things just got complicated...
-			return "", false, nil
-		case IsNewLine(r):
-			// new lines within quoted values are acceptable
-			p.UnreadRune()
-			p.AcceptNewLine()
-		default:
-			// continue
-		}
-	}
-}
-
-func lexQuotedStringEscaped(*TextParser) (string, *lexer.Error) {
-	return "", nil
-}
-
-//	// escaped. append partial
-//	mark = lexQuotedAppendPartial(p, &buf, mark)
-//
-//	r2, _, err := p.ReadRune()
-//	switch {
-//	case err != nil:
-//		// incomplete
-//		return "", NewErrIncompleteQuotedString(p)
-//	case IsNewLine(r2):
-//		// escaped new line
-//		p.UnreadRune()
-//		p.AcceptNewLine()
-//		mark = lexQuotedAppendNewLine(p, &buf, mark)
-//	default:
-//		// bad escaped
-//	}
-
-// Unquoted removes quotes and unescapes the content
-func Unquoted(s string) (string, error) {
-	var p TextParser
-	if s == "" {
-		return "", nil
-	}
-
-	p.InitString(s)
-	unquoted, ok, err := p.AcceptQuotedString()
-	switch {
-	case err != nil:
-		// bad string
-		return "", err
-	case ok:
-		// success
-		return unquoted, nil
-	default:
-		// not quoted
-		return s, nil
-	}
-}