Push and Pop added

errors.go

@@ -6,4 +6,5 @@ import (
 
 var (
 	ErrNothingToUnread = adverr.NewErrTmpl("ErrNothingToUnread", "Unreading failed because there wasn't any Read yet")
+	ErrPopFailed       = adverr.NewErrTmpl("ErrPopFailed", "stack cannot be popped. It was never pushed")
 )

go.mod

@@ -5,4 +5,7 @@ go 1.19
 require (
 	git.milar.in/milarin/adverr v1.1.0
 	git.milar.in/milarin/ds v0.0.2
+	git.milar.in/milarin/slices v0.0.8
 )
+
+require git.milar.in/milarin/gmath v0.0.3 // indirect

go.sum

@@ -1,8 +1,8 @@
 git.milar.in/milarin/adverr v1.1.0 h1:jD9WnOvs40lfMhvqQ7cllOaRJNBMWr1f07/s9jAadp0=
 git.milar.in/milarin/adverr v1.1.0/go.mod h1:joU9sBb7ySyNv4SpTXB0Z4o1mjXsArBw4N27wjgzj9E=
-git.milar.in/milarin/ds v0.0.0-20230120204927-7dc44b9cd222 h1:r7gcMqltPqk9U2/+LzEN5dooZ5wiQ8C7SI/nK6T0KjA=
-git.milar.in/milarin/ds v0.0.0-20230120204927-7dc44b9cd222/go.mod h1:HJK7QERcRvV9j7xzEocrKUtW+1q4JB1Ly4Bj54chfwI=
-git.milar.in/milarin/ds v0.0.1 h1:ov4Rp+QiB3xtmV0a4eC+LluxWEOvbykgW+wCchYEp9o=
-git.milar.in/milarin/ds v0.0.1/go.mod h1:HJK7QERcRvV9j7xzEocrKUtW+1q4JB1Ly4Bj54chfwI=
 git.milar.in/milarin/ds v0.0.2 h1:vCA3mDxZUNfvHpzrdz7SeBUKiPn74NTopo915IUG7I0=
 git.milar.in/milarin/ds v0.0.2/go.mod h1:HJK7QERcRvV9j7xzEocrKUtW+1q4JB1Ly4Bj54chfwI=
+git.milar.in/milarin/gmath v0.0.3 h1:ii6rKNItS55O/wtIFhD1cTN2BMwDZjTBmiOocKURvxM=
+git.milar.in/milarin/gmath v0.0.3/go.mod h1:HDLftG5RLpiNGKiIWh+O2G1PYkNzyLDADO8Cd/1abiE=
+git.milar.in/milarin/slices v0.0.8 h1:qN9TE3tkArdTixMKSnwvNPcApwAjxpLVwA5a9k1rm2s=
+git.milar.in/milarin/slices v0.0.8/go.mod h1:qMhdtMnfWswc1rHpwgNw33lB84aNEkdBn5BDiYA+G3k=

position.go

@@ -10,7 +10,7 @@ func (p *Position) Advance(rn rune) {
 	p.Index++
 	if rn == '\n' {
 		p.Line++
-		p.Column = 0
+		p.Column = 1
 	} else {
 		p.Column++
 	}

reader.go

@@ -6,22 +6,31 @@ import (
 	"strings"
 
 	"git.milar.in/milarin/ds"
+	"git.milar.in/milarin/slices"
 )
 
 type Reader struct {
-	buf ds.Stack[posRune]
+	buf     ds.Stack[posRune]
-	src *bufio.Reader
+	indices ds.Stack[uint64]
-	pos *Position
+	index   uint64
+	src     *bufio.Reader
+	pos     *Position
 }
 
-func NewReader(r io.Reader) *Reader {
+func New(r io.Reader) *Reader {
 	return &Reader{
-		buf: ds.NewArrayStack[posRune](),
+		buf:     ds.NewArrayStack[posRune](),
-		src: bufio.NewReader(r),
+		src:     bufio.NewReader(r),
-		pos: &Position{},
+		pos:     &Position{Index: 0, Line: 1, Column: 1},
+		index:   0,
+		indices: ds.NewArrayStack[uint64](),
 	}
 }
 
+func NewFromString(str string) *Reader {
+	return New(strings.NewReader(str))
+}
+
 func (r *Reader) psrn(rn rune) posRune {
 	return posRune{
 		Rune: rn,
@@ -29,8 +38,8 @@ func (r *Reader) psrn(rn rune) posRune {
 	}
 }
 
-func (r *Reader) Pos() (index, line, column int) {
+func (r *Reader) Pos() Position {
-	return r.pos.Index, r.pos.Line, r.pos.Column
+	return *r.pos
 }
 
 // Rune returns the next rune in r
@@ -39,10 +48,15 @@ func (r *Reader) Rune() (rune, error) {
 	if err == nil {
 		r.buf.Push(r.psrn(rn))
 		r.pos.Advance(rn)
+		r.index++
 	}
 	return rn, err
 }
 
+func (r *Reader) Buffered() int {
+	return r.src.Buffered()
+}
+
 // PeekRune returns the next rune in r without advancing reader position.
 // The next read will return the same rune again.
 func (r *Reader) PeekRune() (rune, error) {
@@ -58,6 +72,22 @@ func (r *Reader) PeekRune() (rune, error) {
 	return rn, nil
 }
 
+// String returns the next len runes in r as a string.
+// If an error occurs, both the already read string and the error will be returned
+func (r *Reader) String(len int) (string, error) {
+	str := ""
+
+	for i := 0; i < len; i++ {
+		rn, err := r.Rune()
+		if err != nil {
+			return str, err
+		}
+		str += string(rn)
+	}
+
+	return str, nil
+}
+
 // UnreadRune unreads the last rune.
 // The next read will include the unread rune.
 // It returns ErrNothingToUnread if there wasn't any read yet
@@ -75,6 +105,8 @@ func (r *Reader) UnreadRune() error {
 		r.src = prependRune(rn.Rune, r.src)
 	}
 
+	r.index--
+
 	return nil
 }
 
@@ -92,16 +124,27 @@ func (r *Reader) UnreadString(str string) error {
 	return r.UnreadRune()
 }
 
-// StringWhile reads runes and calls f for each one.
+// UnreadRunes calls UnreadRune n times
-// It returns all runes as a string for which f returned true.
+func (r *Reader) UnreadRunes(n int) error {
-// It stops when f returns false or an error occured.
+	for i := 0; i < n; i++ {
-// The rune for which f returned false will not be unread.
+		err := r.UnreadRune()
-func (r *Reader) StringWhile(f func(rn rune) bool) (string, error) {
+		if err != nil {
+			return err
+		}
+	}
+	return nil
+}
+
+// StringWhile reads runes and calls all functions for each one.
+// It returns all runes as a string for which any function returned true.
+// It stops when all functions returned false or an error occured.
+// The rune for which that function returned false will not be unread.
+func (r *Reader) StringWhile(f ...RuneFunc) (string, error) {
 	s := new(strings.Builder)
 
 	var rn rune
 	var err error
-	for rn, err = r.Rune(); err == nil && f(rn); rn, err = r.Rune() {
+	for rn, err = r.Rune(); err == nil && findFirstTrue(rn, f); rn, err = r.Rune() {
 		s.WriteRune(rn)
 	}
 
@@ -109,8 +152,8 @@ func (r *Reader) StringWhile(f func(rn rune) bool) (string, error) {
 }
 
 // PeekStringWhile acts as StringWhile but does not advance reader position
-func (r *Reader) PeekStringWhile(f func(rn rune) bool) (string, error) {
+func (r *Reader) PeekStringWhile(f ...RuneFunc) (string, error) {
-	str, err := r.StringWhile(f)
+	str, err := r.StringWhile(f...)
 	if err != nil {
 		return "", err
 	}
@@ -122,14 +165,17 @@ func (r *Reader) PeekStringWhile(f func(rn rune) bool) (string, error) {
 	return str, nil
 }
 
-// StringUntil is a shorthand for r.StringWhile(func(rn rune) bool { return !f(rn) })
+// StringUntil reads runes and calls all functions for each one.
-func (r *Reader) StringUntil(f func(rn rune) bool) (string, error) {
+// It returns all runes as a string for which all functions returned true.
-	return r.StringWhile(func(rn rune) bool { return !f(rn) })
+// It stops when any function returns false or an error occured.
+// The rune for which that function returned false will not be unread.
+func (r *Reader) StringUntil(f ...RuneFunc) (string, error) {
+	return r.StringWhile(func(rn rune) bool { return !findFirstTrue(rn, f) })
 }
 
 // PeekStringUntil acts as StringUntil but does not advance reader position
-func (r *Reader) PeekStringUntil(f func(rn rune) bool) (string, error) {
+func (r *Reader) PeekStringUntil(f ...RuneFunc) (string, error) {
-	str, err := r.StringUntil(f)
+	str, err := r.StringUntil(f...)
 	if err != nil {
 		return "", err
 	}
@@ -141,8 +187,115 @@ func (r *Reader) PeekStringUntil(f func(rn rune) bool) (string, error) {
 	return str, nil
 }
 
-// Commit clears the internal buffer and therefore removes all data which were already read.
+// SkipUntil acts as StringUntil but discards the string
-// After calling Commit any unreads will return ErrNothingToUnread until another read occured.
+// The rune for which that function returned false will be unread.
-func (r *Reader) Commit() {
+func (r *Reader) SkipUntil(f ...RuneFunc) error {
-	r.buf.Clear()
+	_, err := r.StringUntil(f...)
+	if err != nil {
+		return err
+	}
+	return r.UnreadRune()
+}
+
+// SkipWhile acts as StringWhile but discards the string.
+// The rune for which that function returned false will be unread.
+func (r *Reader) SkipWhile(f ...RuneFunc) error {
+	_, err := r.StringWhile(f...)
+	if err != nil {
+		return err
+	}
+	return r.UnreadRune()
+}
+
+// ExpectRune returns true if any function returns true for the next rune read from r
+func (r *Reader) ExpectRune(f ...RuneFunc) (bool, error) {
+	rn, err := r.Rune()
+	if err != nil {
+		return false, err
+	}
+	return findFirstTrue(rn, f), nil
+}
+
+// ExpectString calls ExpectRune for each rune in str successively.
+// If the expected string was not found, all read runes will be unread
+func (r *Reader) ExpectString(str string) (bool, error) {
+	read := 0
+	for _, rn := range str {
+		ok, err := r.ExpectRune(Is(rn))
+		if err != nil {
+			return false, err
+		}
+
+		read++
+
+		if !ok {
+			if err := r.UnreadRunes(read); err != nil {
+				return false, err
+			}
+			return false, nil
+		}
+	}
+
+	return true, nil
+}
+
+// ExpectOneOfString calls ExpectString for each string successively
+// and returns the string which first matched.
+// The boolean value is true if any string was found.
+// The returned string will not be unread.
+func (r *Reader) ExpectOneOfString(str ...string) (string, bool, error) {
+	for _, s := range str {
+		ok, err := r.ExpectString(s)
+		if err != nil {
+			return "", false, err
+		}
+
+		if ok {
+			return s, true, nil
+		}
+	}
+
+	return "", false, nil
+}
+
+func (r *Reader) Push() {
+	r.indices.Push(r.index)
+}
+
+func (r *Reader) Pop() ([]rune, error) {
+	if r.indices.Empty() {
+		return nil, ErrPopFailed.New()
+	}
+
+	lastIndex := r.indices.Pop()
+	currentIndex := r.index
+	if lastIndex < currentIndex {
+		values := make([]rune, 0, int(currentIndex-lastIndex))
+		for i := 0; i < int(currentIndex-lastIndex); i++ {
+			err := r.UnreadRune()
+			if err != nil {
+				return nil, err
+			}
+
+			value, err := r.PeekRune()
+			if err != nil {
+				return nil, err
+			}
+
+			values = append(values, value)
+		}
+		return slices.Reverse(values), nil
+	} else if lastIndex > currentIndex {
+		values := make([]rune, 0, int(lastIndex-currentIndex))
+		for i := 0; i < int(lastIndex-currentIndex); i++ {
+			value, err := r.Rune()
+			if err != nil {
+				return nil, err
+			}
+			values = append(values, value)
+		}
+		return values, nil
+	}
+
+	return []rune{}, nil
 }

reader_test.go

@@ -7,12 +7,12 @@ import (
 )
 
 func TestPos(t *testing.T) {
-	r := NewReader(strings.NewReader("hello world\nsecond line"))
+	r := New(strings.NewReader("hello world\nsecond line"))
 
 	unread := false
 	for rn, err := r.Rune(); err == nil; rn, err = r.Rune() {
-		index, line, col := r.Pos()
+		pos := r.Pos()
-		fmt.Println(string(rn), index, line, col)
+		fmt.Println(string(rn), pos.Index, pos.Line, pos.Column)
 
 		if !unread && rn == '\n' {
 			for i := 0; i < 5; i++ {
@@ -24,13 +24,13 @@ func TestPos(t *testing.T) {
 }
 
 func TestEOF(t *testing.T) {
-	r := NewReader(strings.NewReader("hello world\nasddsa"))
+	r := New(strings.NewReader("hello world\nasddsa"))
 
-	for line, err := r.StringUntil(isNewline); err == nil; line, err = r.StringUntil(isNewline) {
+	var line string
+	var err error
+	for line, err = r.StringUntil(IsNewLine); err == nil; line, err = r.StringUntil(IsNewLine) {
 		fmt.Println(line, err)
 	}
-}
 
-func isNewline(rn rune) bool {
+	fmt.Println(line, err)
-	return rn == '\n'
 }

runefunc.go

@@ -0,0 +1,56 @@
+package bufr
+
+import "git.milar.in/milarin/ds"
+
+type RuneFunc = func(rn rune) bool
+
+func IsNewLine(rn rune) bool {
+	return rn == '\n'
+}
+
+func IsSpace(rn rune) bool {
+	return rn == ' '
+}
+
+func IsTab(rn rune) bool {
+	return rn == '\t'
+}
+
+func IsWhitespace(rn rune) bool {
+	return IsSpace(rn) || IsTab(rn) || IsNewLine(rn)
+}
+
+func And(f ...RuneFunc) RuneFunc {
+	return func(rn rune) bool {
+		return findFirstFalse(rn, f)
+	}
+}
+
+func Or(f ...RuneFunc) RuneFunc {
+	return func(rn rune) bool {
+		return findFirstTrue(rn, f)
+	}
+}
+
+func Not(f RuneFunc) RuneFunc {
+	return func(rn rune) bool {
+		return !f(rn)
+	}
+}
+
+func Is(rn rune) RuneFunc {
+	return func(r rune) bool {
+		return rn == r
+	}
+}
+
+func OneOf(runes string) RuneFunc {
+	m := ds.NewSet[rune]()
+	for _, rn := range runes {
+		m.Add(rn)
+	}
+
+	return func(r rune) bool {
+		return m.Has(r)
+	}
+}

utils.go

@@ -13,3 +13,21 @@ func prependString(str string, r io.Reader) *bufio.Reader {
 func prependRune(rn rune, r io.Reader) *bufio.Reader {
 	return prependString(string(rn), r)
 }
+
+func findFirstTrue(rn rune, functions []RuneFunc) bool {
+	for _, f := range functions {
+		if f(rn) {
+			return true
+		}
+	}
+	return false
+}
+
+func findFirstFalse(rn rune, functions []RuneFunc) bool {
+	for _, f := range functions {
+		if !f(rn) {
+			return false
+		}
+	}
+	return true
+}