document

package module

v0.0.4 Latest Latest Go to latest Published: Feb 3, 2023 License: MIT Imports: 3 Imported by: 3

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/leisure-tools/document

Links

Open Source Insights

Documentation ¶

Index ¶

func Apply(peer, str string, repl []Replacement) string
func As[T any](v any) T
func Isa[T any](v any) bool
func RemoveMarker(tree opTree, name string) opTree
func ShiftDeletesRight(left opTree, right opTree) (opTree, opTree)
func ShiftInsertsRight(left opTree, right opTree) (opTree, opTree)
func SplitNew(tree opTree, offset int) (opTree, opTree)
func SplitOld(tree opTree, offset int) (opTree, opTree)
func SplitOnMarker(tree opTree, name string) (opTree, opTree)
type DeleteOp
- func (d *DeleteOp) GetText() string
- func (d *DeleteOp) Measure() Measure
- func (d *DeleteOp) Merge(doc *Document, offset int)
- func (d *DeleteOp) OpString(offset int) string
- func (d *DeleteOp) String() string
type Document
- func NewDocument(text ...string) *Document
- func (d *Document) Apply(peer string, edits []Replacement)
- func (d *Document) Copy() *Document
- func (d *Document) Edits() []Replacement
- func (d *Document) Freeze() *Document
- func (a *Document) Merge(b *Document)
- func (d *Document) OpString() string
- func (d *Document) OriginalString() string
- func (d *Document) Replace(peer string, start int, length int, str string)
- func (d *Document) ReverseEdits() []Replacement
- func (d *Document) SplitOnMarker(name string) (opTree, opTree)
- func (d *Document) String() string
type Measure
type OpMeasurer
- func (m OpMeasurer) Identity() Measure
- func (m OpMeasurer) Measure(op Operation) Measure
- func (m OpMeasurer) Sum(a Measure, b Measure) Measure
type Operation
type Replacement
type RetainOp
- func (r *RetainOp) GetText() string
- func (r *RetainOp) Measure() Measure
- func (r *RetainOp) Merge(doc *Document, offset int)
- func (r *RetainOp) OpString(offset int) string
- func (r *RetainOp) String() string
type Set
- func NewSet[T comparable](elements ...T) Set[T]
- func (m Set[T]) Add(op T) Set[T]
- func (m Set[T]) Copy() Set[T]
- func (m Set[T]) Has(op T) bool
- func (m Set[T]) Merge(m2 Set[T]) Set[T]
- func (m Set[T]) Union(m2 Set[T]) Set[T]

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Apply ¶

func Apply(peer, str string, repl []Replacement) string

func As ¶ added in v0.0.4

func As[T any](v any) T

func Isa ¶ added in v0.0.4

func Isa[T any](v any) bool

func RemoveMarker ¶ added in v0.0.3

func RemoveMarker(tree opTree, name string) opTree

func ShiftDeletesRight ¶ added in v0.0.4

func ShiftDeletesRight(left opTree, right opTree) (opTree, opTree)

if left ends in deletes and (optionally) markers, shift them to right

func ShiftInsertsRight ¶ added in v0.0.4

func ShiftInsertsRight(left opTree, right opTree) (opTree, opTree)

if left ends in inserts and (optionally) markers, shift them to right

func SplitNew ¶ added in v0.0.4

func SplitNew(tree opTree, offset int) (opTree, opTree)

SplitNew the tree's new text at an offset

func SplitOld ¶ added in v0.0.4

func SplitOld(tree opTree, offset int) (opTree, opTree)

split the tree's old text at an offset

func SplitOnMarker ¶ added in v0.0.3

func SplitOnMarker(tree opTree, name string) (opTree, opTree)

Types ¶

type DeleteOp ¶ added in v0.0.4

type DeleteOp struct {
	Text string
}

func (*DeleteOp) GetText ¶ added in v0.0.4

func (d *DeleteOp) GetText() string

func (*DeleteOp) Measure ¶ added in v0.0.4

func (d *DeleteOp) Measure() Measure

func (*DeleteOp) Merge ¶ added in v0.0.4

func (d *DeleteOp) Merge(doc *Document, offset int)

func (*DeleteOp) OpString ¶ added in v0.0.4

func (d *DeleteOp) OpString(offset int) string

func (*DeleteOp) String ¶ added in v0.0.4

func (d *DeleteOp) String() string

type Document ¶ added in v0.0.3

type Document struct {
	Ops opTree
}

func NewDocument ¶ added in v0.0.4

func NewDocument(text ...string) *Document

func (*Document) Apply ¶ added in v0.0.3

func (d *Document) Apply(peer string, edits []Replacement)

func (*Document) Copy ¶ added in v0.0.3

func (d *Document) Copy() *Document

func (*Document) Edits ¶ added in v0.0.3

func (d *Document) Edits() []Replacement

append Edits that restore the original document

func (*Document) Freeze ¶ added in v0.0.3

func (d *Document) Freeze() *Document

func (*Document) Merge ¶ added in v0.0.3

func (a *Document) Merge(b *Document)

Merge operations from the same ancestor document into this one

func (*Document) OpString ¶ added in v0.0.4

func (d *Document) OpString() string

func (*Document) OriginalString ¶ added in v0.0.3

func (d *Document) OriginalString() string

string for the original document

func (*Document) Replace ¶ added in v0.0.3

func (d *Document) Replace(peer string, start int, length int, str string)

func (*Document) ReverseEdits ¶ added in v0.0.3

func (d *Document) ReverseEdits() []Replacement

append edits that restore the original document

func (*Document) SplitOnMarker ¶ added in v0.0.3

func (d *Document) SplitOnMarker(name string) (opTree, opTree)

func (*Document) String ¶ added in v0.0.3

func (d *Document) String() string

string for the new document

type Measure ¶ added in v0.0.4

type Measure struct {
	OldLen  int
	NewLen  int
	Markers Set[string]
}

type OpMeasurer ¶ added in v0.0.4

type OpMeasurer bool

func (OpMeasurer) Identity ¶ added in v0.0.4

func (m OpMeasurer) Identity() Measure

func (OpMeasurer) Measure ¶ added in v0.0.4

func (m OpMeasurer) Measure(op Operation) Measure

func (OpMeasurer) Sum ¶ added in v0.0.4

func (m OpMeasurer) Sum(a Measure, b Measure) Measure

type Operation ¶ added in v0.0.4

type Operation interface {
	OpString(offset int) string
	GetText() string
	Measure() Measure
	Merge(doc *Document, offset int)
	fmt.Stringer
}

type Replacement ¶

type Replacement struct {
	Offset int
	Length int
	Text   string
}

type RetainOp ¶ added in v0.0.4

type RetainOp struct {
	Text string
}

func (*RetainOp) GetText ¶ added in v0.0.4

func (r *RetainOp) GetText() string

func (*RetainOp) Measure ¶ added in v0.0.4

func (r *RetainOp) Measure() Measure

func (*RetainOp) Merge ¶ added in v0.0.4

func (r *RetainOp) Merge(doc *Document, offset int)

func (*RetainOp) OpString ¶ added in v0.0.4

func (r *RetainOp) OpString(offset int) string

func (*RetainOp) String ¶ added in v0.0.4

func (r *RetainOp) String() string

type Set ¶ added in v0.0.2

type Set[T comparable] map[T]bool

func NewSet ¶ added in v0.0.3

func NewSet[T comparable](elements ...T) Set[T]

func (Set[T]) Add ¶ added in v0.0.3

func (m Set[T]) Add(op T) Set[T]

func (Set[T]) Copy ¶ added in v0.0.4

func (m Set[T]) Copy() Set[T]

func (Set[T]) Has ¶ added in v0.0.3

func (m Set[T]) Has(op T) bool

func (Set[T]) Merge ¶ added in v0.0.3

func (m Set[T]) Merge(m2 Set[T]) Set[T]

func (Set[T]) Union ¶ added in v0.0.3

func (m Set[T]) Union(m2 Set[T]) Set[T]

Source Files ¶

View all Source files

document.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL