Documentation ¶
Index ¶
- Constants
- Variables
- func BytesToLineStrings(txt []byte, addNewLn bool) []string
- func CountWordsLines(reader io.Reader) (words, lines int)
- func CountWordsLinesRegion(src [][]rune, reg Region) (words, lines int)
- func DiffLinesUnified(astr, bstr []string, context int, afile, adate, bfile, bdate string) []byte
- func FileBytes(fpath string) ([]byte, error)
- func FileRegionBytes(fpath string, stLn, edLn int, preComments bool, lnBack int) []byte
- func PreCommentStart(lns [][]byte, stLn int, comLn, comSt, comEd string, lnBack int) int
- func ReCaseString(str string, c Cases) string
- func SupportedComments(fpath string) (comLn, comSt, comEd string)
- type AdjustPosDel
- type Cases
- type Diffs
- type Edit
- type Match
- func NewMatch(rn []rune, st, ed, ln int) Match
- func Search(reader io.Reader, find []byte, ignoreCase bool) (int, []Match)
- func SearchByteLinesRegexp(src [][]byte, re *regexp.Regexp) (int, []Match)
- func SearchFile(filename string, find []byte, ignoreCase bool) (int, []Match)
- func SearchFileRegexp(filename string, re *regexp.Regexp) (int, []Match)
- func SearchLexItems(src [][]rune, lexs []lex.Line, find []byte, ignoreCase bool) (int, []Match)
- func SearchRegexp(reader io.Reader, re *regexp.Regexp) (int, []Match)
- func SearchRuneLines(src [][]rune, find []byte, ignoreCase bool) (int, []Match)
- type Opts
- type Patch
- type PatchRec
- type Region
- func (tr *Region) AgeMSec() int
- func (tr *Region) AgoMSec(t time.Time) int
- func (tr *Region) Contains(ln int) bool
- func (tr *Region) FromString(link string) bool
- func (tr *Region) IsAfterTime(t time.Time) bool
- func (tr *Region) IsNil() bool
- func (tr *Region) IsSameLine() bool
- func (tr *Region) SinceMSec(earlier *Region) int
- func (tr *Region) TimeNow()
- type Undo
- func (un *Undo) AdjustPos(pos lex.Pos, t time.Time, del AdjustPosDel) lex.Pos
- func (un *Undo) AdjustReg(reg Region) Region
- func (un *Undo) NewGroup()
- func (un *Undo) RedoNext() *Edit
- func (un *Undo) RedoNextIfGroup(gp int) *Edit
- func (un *Undo) Reset()
- func (un *Undo) Save(tbe *Edit)
- func (un *Undo) SaveUndo(tbe *Edit)
- func (un *Undo) UndoPop() *Edit
- func (un *Undo) UndoPopIfGroup(gp int) *Edit
- func (un *Undo) UndoStackSave()
Constants ¶
const ( // IgnoreCase is passed to search functions to indicate case should be ignored IgnoreCase = true // UseCase is passed to search functions to indicate case is relevant UseCase = false )
Variables ¶
var KiT_Cases = kit.Enums.AddEnum(CasesN, kit.NotBitFlag, gist.StylePropProps)
var SearchContext = 30
SearchContext is how much text to include on either side of the search match
var UndoGroupDelayMSec = 250
UndoGroupDelayMSec is number of milliseconds above which a new group is started, for grouping undo events
var UndoTrace = false
UndoTrace -- set to true to get a report of undo actions
Functions ¶
func BytesToLineStrings ¶
BytesToLineStrings returns []string lines If addNewLn is true, each string line has a \n appended at end.
func CountWordsLines ¶ added in v0.9.14
CountWordsLines counts the number of words (aka Fields, space-separated strings) and lines given io.Reader input
func CountWordsLinesRegion ¶ added in v0.9.14
CountWordsLinesRegion counts the number of words (aka Fields, space-separated strings) and lines in given region of source (lines = 1 + End.Ln - Start.Ln)
func DiffLinesUnified ¶
DiffLinesUnified computes the diff between two string arrays (one string per line), returning a unified diff with given amount of context (default of 3 will be used if -1), with given file names and modification dates.
func FileRegionBytes ¶
FileRegionBytes returns the bytes of given file within given start / end lines, either of which might be 0 (in which case full file is returned). If preComments is true, it also automatically includes any comments that might exist just prior to the start line if stLn is > 0, going back a maximum of lnBack lines.
func PreCommentStart ¶
PreCommentStart returns the starting line for comment line(s) that just precede the given stLn line number within the given lines of bytes, using the given line-level and block start / end comment chars. returns stLn if nothing found. Only looks back a total of lnBack lines.
func ReCaseString ¶ added in v0.9.15
ReCaseString changes the case of the string according to the given case type.
func SupportedComments ¶
SupportedComments returns the comment strings for supported file types, and returns the standard C-style comments otherwise.
Types ¶
type AdjustPosDel ¶
type AdjustPosDel int
AdjustPosDel determines what to do with positions within deleted region
const ( // AdjustPosDelErr means return a PosErr when in deleted region AdjustPosDelErr AdjustPosDel = iota // AdjustPosDelStart means return start of deleted region AdjustPosDelStart // AdjustPosDelEnd means return end of deleted region AdjustPosDelEnd )
these are options for what to do with positions within deleted region for the AdjustPos function
type Cases ¶ added in v0.9.15
type Cases int32
Cases are different cases -- Lower, Upper, Camel, etc
const ( LowerCase Cases = iota UpperCase // CamelCase is init-caps CamelCase // LowerCamelCase has first letter lower-case LowerCamelCase // SnakeCase is snake_case -- lower with underbars SnakeCase // UpperSnakeCase is SNAKE_CASE -- upper with underbars UpperSnakeCase // KebabCase is kebab-case -- lower with -'s KebabCase // CasesN is the number of textview states CasesN )
func (*Cases) FromString ¶ added in v0.9.15
func (Cases) MarshalJSON ¶ added in v0.9.15
func (*Cases) UnmarshalJSON ¶ added in v0.9.15
type Diffs ¶
Diffs are raw differences between text, in terms of lines, reporting a sequence of operations that would convert one buffer (a) into the other buffer (b). Each operation is either an 'r' (replace), 'd' (delete), 'i' (insert) or 'e' (equal).
func DiffLines ¶
DiffLines computes the diff between two string arrays (one string per line), reporting a sequence of operations that would convert buffer a into buffer b. Each operation is either an 'r' (replace), 'd' (delete), 'i' (insert) or 'e' (equal). Everything is line-based (0, offset).
func (Diffs) DiffForLine ¶ added in v0.9.13
func (Diffs) Reverse ¶ added in v1.2.2
Reverse returns the reverse-direction diffs, switching a vs. b
type Edit ¶
type Edit struct { Reg Region `` /* 198-byte string literal not displayed */ Text [][]rune `` /* 136-byte string literal not displayed */ Group int `desc:"optional grouping number, for grouping edits in Undo for example"` Delete bool `desc:"action is either a deletion or an insertion"` Rect bool `` /* 154-byte string literal not displayed */ }
Edit describes an edit action to a buffer -- this is the data passed via signals to viewers of the buffer. Actions are only deletions and insertions (a change is a sequence of those, given normal editing processes). The TextBuf always reflects the current state *after* the edit.
func (*Edit) AdjustPos ¶
AdjustPos adjusts the given text position as a function of the edit. if the position was within a deleted region of text, del determines what is returned
func (*Edit) AdjustPosIfAfterTime ¶
AdjustPosIfAfterTime checks the time stamp and IfAfterTime, it adjusts the given text position as a function of the edit del determines what to do with positions within a deleted region either move to start or end of the region, or return an error.
func (*Edit) AdjustReg ¶
AdjustReg adjusts the given text region as a function of the edit, including checking that the timestamp on the region is after the edit time, if the region has a valid Time stamp (otherwise always does adjustment). If the starting position is within a deleted region, it is moved to the end of the deleted region, and if the ending position was within a deleted region, it is moved to the start. If the region becomes empty, RegionNil will be returned.
type Match ¶
type Match struct { Reg Region `desc:"region surrounding the match -- column positions are in runes, not bytes"` Text []byte `desc:"text surrounding the match, at most FileSearchContext on either side (within a single line)"` }
Match records one match for search within file, positions in runes
func NewMatch ¶
NewMatch returns a new Match entry for given rune line with match starting at st and ending before ed, on given line
func Search ¶
Search looks for a string (no regexp) from an io.Reader input stream, using given case-sensitivity. Returns number of occurrences and specific match position list. Column positions are in runes.
func SearchByteLinesRegexp ¶ added in v1.0.2
SearchByteLinesRegexp looks for a regexp within lines of bytes, with given case-sensitivity returning number of occurrences and specific match position list. Column positions are in runes.
func SearchFile ¶
SearchFile looks for a string (no regexp) within a file, in a case-sensitive way, returning number of occurrences and specific match position list -- column positions are in runes.
func SearchFileRegexp ¶ added in v1.0.2
SearchFileRegexp looks for a string (using regexp) within a file, returning number of occurrences and specific match position list -- column positions are in runes.
func SearchLexItems ¶
SearchLexItems looks for a string (no regexp), as entire lexically tagged items, with given case-sensitivity returning number of occurrences and specific match position list. Column positions are in runes.
func SearchRegexp ¶ added in v1.0.2
SearchRegexp looks for a string (using regexp) from an io.Reader input stream. Returns number of occurrences and specific match position list. Column positions are in runes.
type Opts ¶
type Opts struct { gi.EditorPrefs `desc:"editor prefs from gogi prefs"` CommentLn string `desc:"character(s) that start a single-line comment -- if empty then multi-line comment syntax will be used"` CommentSt string `desc:"character(s) that start a multi-line comment or one that requires both start and end"` CommentEd string `desc:"character(s) that end a multi-line comment or one that requires both start and end"` }
Opts contains options for TextBufs -- contains everything necessary to conditionalize editing of a given text file
func (*Opts) CommentStrs ¶
CommentStrs returns the comment start and end strings, using line-based CommentLn first if set and falling back on multi-line / general purpose start / end syntax
func (*Opts) ConfigSupported ¶
ConfigSupported configures options based on the supported language info in GoPi returns true if supported
func (*Opts) IndentChar ¶
IndentChar returns the indent character based on SpaceIndent option
type Patch ¶ added in v1.2.2
type Patch []*PatchRec
Patch is a collection of patch records needed to turn original a buffer into b
type PatchRec ¶ added in v1.2.2
type PatchRec struct { Op difflib.OpCode `desc:"diff operation: 'r', 'd', 'i', 'e'"` Blines []string `desc:"lines from B buffer needed for 'r' and 'i' operations"` }
PatchRec is a self-contained record of a DiffLines result that contains the source lines of the b buffer needed to patch a into b
type Region ¶
type Region struct { Start lex.Pos `desc:"starting position"` End lex.Pos `desc:"ending position: line number is *inclusive* but character position is *exclusive* (-1)"` Time nptime.Time `` /* 131-byte string literal not displayed */ }
Region represents a text region as a start / end position, and includes a Time stamp for when the region was created as valid positions into the TextBuf. The character end position is an *exclusive* position (i.e., the region ends at the character just prior to that character) but the lines are always *inclusive* (i.e., it is the actual line, not the next line).
var RegionNil Region
RegionNil is the empty (zero) text region -- all zeros
func NewRegion ¶
NewRegion creates a new text region using separate line and char values for start and end, and also sets the time stamp to now
func NewRegionLen ¶
NewRegionLen makes a new Region from a starting point and a length along same line
func NewRegionPos ¶
NewRegionPos creates a new text region using position values and also sets the time stamp to now
func (*Region) AgoMSec ¶
AgoMSec returns how long ago this Region's time stamp is relative to given time, in milliseconds.
func (*Region) FromString ¶
FromString decodes text region from a string representation of form: [#]LxxCxx-LxxCxx -- used in e.g., URL links -- returns true if successful
func (*Region) IsAfterTime ¶
IsAfterTime reports if this region's time stamp is after given time value if region Time stamp has not been set, it always returns true
func (*Region) IsNil ¶
IsNil checks if the region is empty, because the start is after or equal to the end
func (*Region) IsSameLine ¶
IsSameLine returns true if region starts and ends on the same line
type Undo ¶
type Undo struct { Off bool `desc:"if true, saving and using undos is turned off (e.g., inactive buffers)"` Stack []*Edit `desc:"undo stack of edits"` UndoStack []*Edit `desc:"undo stack of *undo* edits -- added to whenever an Undo is done -- for emacs-style undo"` Pos int `desc:"undo position in stack"` Group int `desc:"group counter"` Mu sync.Mutex `json:"-" xml:"-" desc:"mutex protecting all updates"` }
Undo is the TextBuf undo manager
func (*Undo) AdjustPos ¶
AdjustPos adjusts given text position, which was recorded at given time for any edits that have taken place since that time (using the Undo stack). del determines what to do with positions within a deleted region -- either move to start or end of the region, or return an error
func (*Undo) AdjustReg ¶
AdjustReg adjusts given text region for any edits that have taken place since time stamp on region (using the Undo stack). If region was wholly within a deleted region, then RegionNil will be returned -- otherwise it is clipped appropriately as function of deletes.
func (*Undo) NewGroup ¶
func (un *Undo) NewGroup()
NewGroup increments the Group counter so subsequent undos will be grouped separately
func (*Undo) RedoNext ¶
RedoNext returns the current item on Stack for Redo, and increments the position returns nil if at end of stack.
func (*Undo) RedoNextIfGroup ¶
RedoNextIfGroup returns the current item on Stack for Redo if it is same group and increments the position. returns nil if at end of stack.
func (*Undo) Save ¶
Save saves given edit to undo stack, with current group marker unless timer interval exceeds UndoGroupDelayMSec since last item.
func (*Undo) SaveUndo ¶
SaveUndo saves given edit to UndoStack (stack of undoes that have have undone..) for emacs mode.
func (*Undo) UndoPop ¶
UndoPop pops the top item off of the stack for use in Undo. returns nil if none.
func (*Undo) UndoPopIfGroup ¶
UndoPopIfGroup pops the top item off of the stack if it is the same as given group
func (*Undo) UndoStackSave ¶
func (un *Undo) UndoStackSave()
UndoStackSave if EmacsUndo mode is active, saves the UndoStack to the regular Undo stack, at the end, and moves undo to the very end. Undo is a constant stream..