span

Documentation

Overview

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

Index

• Variables
• func Compare(a, b Span) int
• func ComparePoint(a, b Point) int
• func CompareURI(a, b URI) int
• func ToUTF16Column(p Point, content []byte) (int, error)
• type Converter
• type Point
  • func FromUTF16Column(p Point, chr int, content []byte) (Point, error)
  • func NewPoint(line, col, offset int) Point
  • func (p Point) Column() int
  • func (p Point) HasOffset() bool
  • func (p Point) HasPosition() bool
  • func (p Point) IsValid() bool
  • func (p Point) Line() int
  • func (p *Point) MarshalJSON() ([]byte, error)
  • func (p Point) Offset() int
  • func (p *Point) UnmarshalJSON(b []byte) error
• type PosConverter
  • func NewContentConverter(filename string, content []byte) *PosConverter
  • func NewPosConverter(fset *loc.FileSet, f *loc.File) *PosConverter
  • func (l *PosConverter) ToOffset(line, col int) (int, error)
  • func (l *PosConverter) ToPosition(offset int) (int, int, error)
• type Range
  • func NewRange(fset *loc.FileSet, start, end loc.Pos) Range
  • func (r Range) IsPoint() bool
  • func (r Range) Span() (Span, error)
• type Span
  • func New(uri URI, start Point, end Point) Span
  • func Parse(input string) 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 *PosConverter) (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 URI
  • func URIFromPath(path string) URI
  • func URIFromURI(s string) URI
  • func URINormalizeAuthority(s string) URI
  • func (uri URI) Filename() string
  • func (uri URI) IsFile() bool

Variables

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

Invalid is a span that reports false from IsValid

Functions

func Compare

func Compare(a, b Span) int

func ComparePoint

func ComparePoint(a, b Point) int

func CompareURI

func CompareURI(a, b URI) int

func ToUTF16Column

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.

Types

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

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

func NewPoint(line, col, offset int) Point

func (Point) Column

func (p Point) Column() int

func (Point) HasOffset

func (p Point) HasOffset() bool

func (Point) HasPosition

func (p Point) HasPosition() bool

func (Point) IsValid

func (p Point) IsValid() bool

func (Point) Line

func (p Point) Line() int

func (*Point) MarshalJSON

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

func (Point) Offset

func (p Point) Offset() int

func (*Point) UnmarshalJSON

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

type PosConverter

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

PosConverter is a Converter backed by a loc 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) *PosConverter

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

func NewPosConverter

func NewPosConverter(fset *loc.FileSet, f *loc.File) *PosConverter

NewPosConverter returns an implementation of Converter backed by a loc.File.

func (*PosConverter) ToOffset

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

func (*PosConverter) ToPosition

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

type Range

type Range struct {
	FileSet   *loc.FileSet
	Start     loc.Pos
	End       loc.Pos
	Converter Converter
}

Range represents a source code range in loc.Pos form. It also carries the FileSet that produced the positions, so that it is self contained.

func NewRange

func NewRange(fset *loc.FileSet, start, end loc.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

func (r Range) IsPoint() bool

IsPoint returns true if the range represents a single point.

func (Range) Span

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

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

Span represents a source code range in standardized form.

func New

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

func Parse

func Parse(input string) Span

Parse returns the location represented by the input. Only file paths are accepted, not URIs. The returned span will be normalized, and thus if printed may produce a different string.

func (Span) End

func (s Span) End() Point

func (Span) Format

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

func (s Span) HasOffset() bool

func (Span) HasPosition

func (s Span) HasPosition() bool

func (Span) IsPoint

func (s Span) IsPoint() bool

func (Span) IsValid

func (s Span) IsValid() bool

func (*Span) MarshalJSON

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

func (Span) Range

func (s Span) Range(converter *PosConverter) (Range, error)

Range converts a Span to a Range that represents the Span for the supplied File.

func (Span) Start

func (s Span) Start() Point

func (Span) URI

func (s Span) URI() URI

func (*Span) UnmarshalJSON

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

func (Span) WithAll

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

func (Span) WithOffset

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

func (Span) WithPosition

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

type URI

type URI string

URI represents the full URI for a file.

func URIFromPath

func URIFromPath(path string) URI

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

func URIFromURI

func URIFromURI(s string) URI

func URINormalizeAuthority

func URINormalizeAuthority(s string) URI

vscode URIs with 'untitled' scheme is using %2B instead of + inside the authority string, which does not conform to RFC3986. Remove as soon as this issue is fixed: https://github.com/microsoft/vscode/issues/133955

func (URI) Filename

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.

func (URI) IsFile

func (uri URI) IsFile() bool