Documentation
¶
Index ¶
- Variables
- func ApplyEdits(before []byte, edits []TextEdit) []byte
- func Compare(a, b Span) int
- func ComparePoint(a, b Point) int
- func CompareURI(a, b URI) int
- func SortTextEdits(d []TextEdit)
- type ComputeEdits
- type Converter
- type FileConverter
- type Hunk
- type Line
- type OpKind
- type Point
- type Range
- type Span
- func (s Span) End() Point
- func (s Span) Format(f fmt.State, c rune)
- func (s Span) HasOffset() bool
- func (s Span) HasPosition() bool
- func (s Span) IsPoint() bool
- func (s Span) IsValid() bool
- func (s *Span) MarshalJSON() ([]byte, error)
- func (s Span) Range(converter *TokenConverter) (Range, error)
- func (s Span) Start() Point
- func (s Span) URI() URI
- func (s *Span) UnmarshalJSON(b []byte) error
- func (s Span) WithAll(c Converter) (Span, error)
- func (s Span) WithOffset(c Converter) (Span, error)
- func (s Span) WithPosition(c Converter) (Span, error)
- type TextEdit
- type TokenConverter
- type URI
- type Unified
Constants ¶
This section is empty.
Variables ¶
var Invalid = Span{/* contains filtered or unexported fields */}
Invalid is a span that reports false from IsValid
Functions ¶
func ApplyEdits ¶
ApplyEdits applies the set of edits to the before and returns the resulting content. It may panic or produce garbage if the edits are not valid for the provided before content.
func ComparePoint ¶
func CompareURI ¶
func SortTextEdits ¶
func SortTextEdits(d []TextEdit)
SortTextEdits attempts to order all edits by their starting points. The sort is stable so that edits with the same starting point will not be reordered.
Types ¶
type ComputeEdits ¶
ComputeEdits is the type for a function that produces a set of edits that convert from the before content to the after content.
type Converter ¶
type Converter interface {
//ToPosition converts from an offset to a line:column pair.
ToPosition(offset int) (int, int, error)
//ToOffset converts from a line:column pair to an offset.
ToOffset(line, col int) (int, error)
}
Converter is the interface to an object that can convert between line:column and offset forms for a single file.
type FileConverter ¶
type FileConverter struct {
// contains filtered or unexported fields
}
func (*FileConverter) ToPosition ¶
func (l *FileConverter) ToPosition(offset int) (int, int, error)
type Hunk ¶
type Hunk struct {
// The line in the original source where the hunk starts.
FromLine int
// The line in the original source where the hunk finishes.
ToLine int
// The set of line based edits to apply.
Lines []Line
}
Hunk represents a contiguous set of line edits to apply.
type Line ¶
type Line struct {
// Kind is the type of line this represents, deletion, insertion or copy.
Kind OpKind
// Content is the content of this line.
// For deletion it is the line being removed, for all others it is the line
// to put in the output.
Content []byte
}
Line represents a single line operation to apply as part of a Hunk.
type OpKind ¶
type OpKind int
OpKind is used to denote the type of operation a line represents.
const ( // Delete is the operation kind for a line that is present in the input // but not in the output. Delete OpKind = iota // Insert is the operation kind for a line that is new in the output. Insert // Equal is the operation kind for a line that is the same in the input and // output, often used to provide context around edited lines. Equal )
type Point ¶
type Point struct {
// contains filtered or unexported fields
}
Point represents a single point within a file. In general this should only be used as part of a Span, as on its own it does not carry enough information.
func (Point) HasPosition ¶
func (*Point) MarshalJSON ¶
func (*Point) UnmarshalJSON ¶
type Range ¶
Range represents a source code range in token.Pos form. It also carries the FileSet that produced the positions, so that it is self contained.
func NewRange ¶
NewRange creates a new Range from a FileSet and two positions. To represent a point pass a 0 as the end pos.
type Span ¶
type Span struct {
// contains filtered or unexported fields
}
Span represents a source code range in standardized form.
func FileSpan ¶
FileSpan returns a span within tok, using converter to translate between offsets and positions.
func (Span) Format ¶
Format implements fmt.Formatter to print the Location in a standard form. The format produced is one that can be read back in using Parse.
func (Span) HasPosition ¶
func (*Span) MarshalJSON ¶
func (Span) Range ¶
func (s Span) Range(converter *TokenConverter) (Range, error)
Range converts a Span to a Range that represents the Span for the supplied File.
func (*Span) UnmarshalJSON ¶
type TextEdit ¶
TextEdit represents a change to a section of a document. The text within the specified span should be replaced by the supplied new text.
type TokenConverter ¶
type TokenConverter struct {
FileConverter
// contains filtered or unexported fields
}
TokenConverter is a Converter backed by a token file set and file. It uses the file set methods to work out the conversions, which makes it fast and does not require the file contents.
func NewContentConverter ¶
func NewContentConverter(filename string, content []byte) *TokenConverter
NewContentConverter returns an implementation of Converter for the given file content.
func NewTokenConverter ¶
func NewTokenConverter(fset *token.FileSet, f *token.File) *TokenConverter
NewTokenConverter returns an implementation of Converter backed by a token.File.
type URI ¶
type URI string
URI represents the full URI for a file.
func URIFromPath ¶
URIFromPath returns a span URI for the supplied file path. It will always have the file scheme.
func URIFromURI ¶
type Unified ¶
type Unified struct {
// From is the name of the original file.
From []byte
// To is the name of the modified file.
To []byte
// Hunks is the set of edit hunks needed to transform the file content.
Hunks []*Hunk
}
Unified represents a set of edits as a unified diff.
Source Files
Directories