tools: golang.org/x/tools/internal/span Index | Files

package span

import "golang.org/x/tools/internal/span"

Package span contains support for representing with positions and ranges in text files.

Index

Package Files

parse.go span.go token.go token112.go uri.go utf16.go

Variables

var Invalid = Span{/* contains filtered or unexported fields */}

Invalid is a span that reports false from IsValid

func Compare Uses

func Compare(a, b Span) int

func ComparePoint Uses

func ComparePoint(a, b Point) int

func CompareURI Uses

func CompareURI(a, b URI) int

func ToUTF16Column Uses

func ToUTF16Column(p Point, content []byte) (int, error)

ToUTF16Column calculates the utf16 column expressed by the point given the supplied file contents. This is used to convert from the native (always in bytes) column representation and the utf16 counts used by some editors.

type Converter Uses

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 Point Uses

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 FromUTF16Column Uses

func FromUTF16Column(p Point, chr int, content []byte) (Point, error)

FromUTF16Column advances the point by the utf16 character offset given the supplied line contents. This is used to convert from the utf16 counts used by some editors to the native (always in bytes) column representation.

func NewPoint Uses

func NewPoint(line, col, offset int) Point

func (Point) Column Uses

func (p Point) Column() int

func (Point) HasOffset Uses

func (p Point) HasOffset() bool

func (Point) HasPosition Uses

func (p Point) HasPosition() bool

func (Point) IsValid Uses

func (p Point) IsValid() bool

func (Point) Line Uses

func (p Point) Line() int

func (*Point) MarshalJSON Uses

func (p *Point) MarshalJSON() ([]byte, error)

func (Point) Offset Uses

func (p Point) Offset() int

func (*Point) UnmarshalJSON Uses

func (p *Point) UnmarshalJSON(b []byte) error

type Range Uses

type Range struct {
    FileSet *token.FileSet
    Start   token.Pos
    End     token.Pos
}

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 Uses

func NewRange(fset *token.FileSet, start, end token.Pos) Range

NewRange creates a new Range from a FileSet and two positions. To represent a point pass a 0 as the end pos.

func (Range) IsPoint Uses

func (r Range) IsPoint() bool

IsPoint returns true if the range represents a single point.

func (Range) Span Uses

func (r Range) Span() (Span, error)

Span converts a Range to a Span that represents the Range. It will fill in all the members of the Span, calculating the line and column information.

type Span Uses

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

Span represents a source code range in standardized form.

func New Uses

func New(uri URI, start Point, end Point) Span

func Parse Uses

func Parse(input string) Span

Parse returns the location represented by the input. All inputs are valid locations, as they can always be a pure filename. The returned span will be normalized, and thus if printed may produce a different string.

func (Span) End Uses

func (s Span) End() Point

func (Span) Format Uses

func (s Span) Format(f fmt.State, c rune)

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) HasOffset Uses

func (s Span) HasOffset() bool

func (Span) HasPosition Uses

func (s Span) HasPosition() bool

func (Span) IsPoint Uses

func (s Span) IsPoint() bool

func (Span) IsValid Uses

func (s Span) IsValid() bool

func (*Span) MarshalJSON Uses

func (s *Span) MarshalJSON() ([]byte, error)

func (Span) Range Uses

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) Start Uses

func (s Span) Start() Point

func (Span) URI Uses

func (s Span) URI() URI

func (*Span) UnmarshalJSON Uses

func (s *Span) UnmarshalJSON(b []byte) error

func (Span) WithAll Uses

func (s Span) WithAll(c Converter) (Span, error)

func (Span) WithOffset Uses

func (s Span) WithOffset(c Converter) (Span, error)

func (Span) WithPosition Uses

func (s Span) WithPosition(c Converter) (Span, error)

type TokenConverter Uses

type TokenConverter struct {
    // 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 Uses

func NewContentConverter(filename string, content []byte) *TokenConverter

NewContentConverter returns an implementation of Converter for the given file content.

func NewTokenConverter Uses

func NewTokenConverter(fset *token.FileSet, f *token.File) *TokenConverter

NewTokenConverter returns an implementation of Converter backed by a token.File.

func (*TokenConverter) ToOffset Uses

func (l *TokenConverter) ToOffset(line, col int) (int, error)

func (*TokenConverter) ToPosition Uses

func (l *TokenConverter) ToPosition(offset int) (int, int, error)

type URI Uses

type URI string

URI represents the full URI for a file.

func FileURI Uses

func FileURI(path string) URI

FileURI returns a span URI for the supplied file path. It will always have the file scheme.

func NewURI Uses

func NewURI(s string) URI

NewURI returns a span URI for the string. It will attempt to detect if the string is a file path or uri.

func (URI) Filename Uses

func (uri URI) Filename() string

Filename returns the file path for the given URI. It is an error to call this on a URI that is not a valid filename.

Package span imports 13 packages (graph) and is imported by 33 packages. Updated 2019-11-14. Refresh now. Tools for package owners.