first commit

1 files changed, 189 insertions, 0 deletions

diff --git a/gapbuffer/gap.go b/gapbuffer/gap.go
new file mode 100644
index 0000000..5bf9ca6
--- /dev/null
+++ b/gapbuffer/gap.go
@@ -0,0 +1,189 @@
+package gapbuffer
+
+import (
+	"errors"
+	"io"
+)
+
+// BUFSIZE is the initial size of the Buffer when calling New().
+const BUFSIZE = 64
+
+// ErrOutOfRange is returned when given position is out of range for the buffer.
+var ErrOutOfRange = errors.New("index out of range")
+
+type Buffer struct {
+	data  []byte
+	start int // gap start, is considered empty
+	end   int // gap end, holds next byte counting from before the gap
+}
+
+func New() *Buffer {
+	return &Buffer{
+		data:  make([]byte, BUFSIZE),
+		start: 0,
+		end:   BUFSIZE,
+	}
+}
+
+func (b *Buffer) Bytes() []byte {
+	buf := make([]byte, b.Len())
+	b.ReadAt(buf, 0)
+	return buf
+}
+
+// Destroy will erase the Buffer by zeroising all fields.
+func (b *Buffer) Destroy() {
+	b.start = 0
+	b.end = len(b.data)
+}
+
+// Byte returns current byte right after the gap. If the gap is at the end, the return will be 0.
+func (b *Buffer) Byte() byte {
+	if b.end >= len(b.data) {
+		return 0 // EOF
+	}
+
+	return b.data[b.end]
+}
+
+// ByteAt returns the byte at the given offset, ignoring and hiding the gap.
+func (b *Buffer) ByteAt(offset int) (byte, error) {
+	if offset >= b.start {
+		offset += b.gapLen()
+	}
+
+	if offset < 0 {
+		return 0, ErrOutOfRange
+	}
+	if offset >= len(b.data) {
+		return 0, io.EOF
+	}
+
+	return b.data[offset], nil
+}
+
+// gapLen returns the length of the gap.
+func (b *Buffer) gapLen() int {
+	return b.end - b.start
+}
+
+// Len returns the length of actual data.
+func (b *Buffer) Len() int {
+	return len(b.data) - b.gapLen()
+}
+
+// Cap returns the capacity of the Buffer, including the gap.
+func (b *Buffer) Cap() int {
+	return cap(b.data)
+}
+
+// Pos returns the current start position of the gap. This is where next write will appear.
+func (b *Buffer) Pos() int {
+	return b.start
+}
+
+// Seek is moving the gap to a given offset from origin.
+func (b *Buffer) Seek(newpos int) {
+	// out of range
+	if newpos < 0 {
+		b.Seek(0)
+		return
+	}
+	if newpos > b.Len() {
+		b.Seek(b.Len())
+		return
+	}
+
+	if newpos < b.start { // move backwards
+		for b.start > newpos {
+			b.backward()
+		}
+	} else if newpos > b.start { // move forward
+		for b.start < newpos {
+			b.forward()
+		}
+	}
+}
+
+// Forward is moving the gap one byte forward.
+func (b *Buffer) forward() {
+	if b.end >= len(b.data) {
+		return
+	}
+	b.data[b.start] = b.data[b.end]
+	b.start++
+	b.end++
+}
+
+// Backward is moving the gap one byte backwards.
+func (b *Buffer) backward() {
+	if b.start <= 0 {
+		return
+	}
+	b.data[b.end-1] = b.data[b.start-1]
+	b.start--
+	b.end--
+}
+
+// Delete will expand the gap by 1, deleting the character before the gap. Returns the byte that was deleted.
+func (b *Buffer) Delete() byte {
+	if b.start-1 < 0 {
+		return 0
+	}
+	b.start--
+	return b.data[b.start]
+}
+
+// Write writes p into the Buffer at current gap position. The Buffer will expand if needed and this is the only time any new memory allocation is done. The resizing and expanding strategy is handled by the underlying internal byte slice. Cap() will return the size of this slice.
+//
+// It will never return any other error than nil.
+func (b *Buffer) Write(p []byte) (int, error) {
+	if p == nil {
+		return 0, nil
+	}
+	for _, c := range p {
+		if b.gapLen() == 0 {
+			oldpos := b.start
+			b.Seek(cap(b.data))
+
+			b.data = append(b.data, 0)
+			exp := cap(b.data)
+			b.end += exp + 1
+
+			fill := make([]byte, exp)
+			b.data = append(b.data, fill...)
+
+			b.Seek(oldpos)
+		}
+		b.data[b.start] = c
+		b.start++
+	}
+	return len(p), nil
+}
+
+// Read implements io.Reader, returning number of bytes from the Buffer while ignoring the gap.
+func (b *Buffer) Read(p []byte) (int, error) {
+	return b.ReadAt(p, b.end)
+}
+
+// ReadAt fills p with bytes starting at offset from the Buffer, ignoring the gap. Returns number of bytes and an error.
+func (b *Buffer) ReadAt(p []byte, offset int) (n int, err error) {
+	if offset < 0 {
+		return 0, ErrOutOfRange
+	}
+	if offset >= b.Len() {
+		return 0, io.EOF
+	}
+
+	for n = 0; n < len(p) && offset < b.Len(); n++ {
+		c, err := b.ByteAt(offset)
+		if err != nil {
+			return n, err
+		}
+
+		p[n] = c
+		offset++
+	}
+
+	return n, nil
+}