duingras

duingras

a heavily simplified and cleaned-up fork of rc's go-gap-buffer, primarely for use in duin.

it removes some of the redundant functions, while adding some new stuff too, like undoing and redoing.

available functions

the current functions are currently available and good:

import (
	textbuffer "codeberg.org/kollumos/duingras"
)

tb := textbuffer.New("some text") // init a new text buffer

tb.String()     // get the contents of the buffer as one, whole string
tb.Pair()       // get the contents of the buffer as two strings, left and right of the cursor
tb.LineString() // get the contents of the current line as one, whole string

tb.Column()     // get the current column of the cursor (counting starts at 0)
tb.Line()       // get the current line of the cursor (counting starts at 1)
tb.Position()   // get the current cursor position in bytes (start of the gap)
tb.Length()     // get the length of the contents of the buffer in bytes
tb.LineLength() // get the length of the contents of the current line in bytes
tb.LineCount()  // get the amount of lines

tb.Goto(pos)   // go to specified position in the buffer (or to the end of the buffer with Goto(-1))
tb.HMove(n)    // move the cursor n characters horizontally
tb.VMove(n)    // move the cursor n characters vertically
tb.Home()      // go to the start of the current line
tb.End()       // go to the end of the current line

tb.Insert("some text")  // insert text into the buffer
tb.Delete(n)            // delete n characters forwards or backwards
deleted := tb.Delete(n) // get the deleted characters

tb.Undo() // undo the last action
tb.Redo() // redo the last undone action

planned functions

these functions will be added in sometime, probably:

tb.Anchor()  // get the selection anchor
tb.Select(n) // set the selection anchor n characters before or after the cursor (or stop selection with Select(0))

// possibly maybe also some functions for working with graphemes?

known issues

duingras is not perfect. the following issues haunt me right now:

• tb.Goto(pos) and by extension tb.Undo() and tb.Redo() work on a byte basis, rather than a character basis. this causes these functions to mess up when there's multi-byte characters at play.
• the code does feature some repetition in its code. i'm not sure if this is reasonably fixable, but it irks me.

license

this library is licensed under the MIT license.