source_file

Documentation

Overview

Package source_file contains the SourceFile type. This should ideally be in the common package but that would cause an import cycle.

Index

• type SourceFile
  • func NewSourceFile(name string, tb tui.TextBuffer, words []Word) SourceFile
  • func (self *SourceFile) Name() string
  • func (self *SourceFile) NextWord() Optional[Word]
  • func (self *SourceFile) Ok() bool
  • func (self *SourceFile) PeekWord() Optional[Word]
  • func (self *SourceFile) String() string
  • func (self *SourceFile) Text() *tui.TextBuffer
  • func (self *SourceFile) Words() []Word
• type Word
  • func NewWord(original string, slice *tui.TextSlice, index tui.SliceIndex) Word

Types

type SourceFile

type SourceFile struct {
	// contains filtered or unexported fields
}

func NewSourceFile

func NewSourceFile(name string, tb tui.TextBuffer, words []Word) SourceFile

func (*SourceFile) Name

func (self *SourceFile) Name() string

func (*SourceFile) NextWord

func (self *SourceFile) NextWord() Optional[Word]

func (*SourceFile) Ok

func (self *SourceFile) Ok() bool

func (*SourceFile) PeekWord

func (self *SourceFile) PeekWord() Optional[Word]

func (*SourceFile) String

func (self *SourceFile) String() string

func (*SourceFile) Text

func (self *SourceFile) Text() *tui.TextBuffer

func (*SourceFile) Words

func (self *SourceFile) Words() []Word

type Word

type Word struct {
	Original string
	Slice    *tui.TextSlice
	Index    tui.SliceIndex
}

func NewWord

func NewWord(original string, slice *tui.TextSlice, index tui.SliceIndex) Word