| commit | 02bea03babeebb49198bfb45f2fed12a81c2e642 | [log] [tgz] |
|---|---|---|
| author | Alan Donovan <adonovan@google.com> | Wed Jan 04 18:52:54 2023 -0500 |
| committer | Alan Donovan <adonovan@google.com> | Thu Jan 05 18:54:28 2023 +0000 |
| tree | e31082ab406f86ff14f3d4e4a19f6ace7fd8bb05 | |
| parent | a4455febdef318395153612ab0489e96418ec51b [diff] |
gopls/internal/lsp/protocol: simplify ColumnMapper
This change decouples ColumnMapper from go/token.
Its TokFile field is now unexported and fully
encapsulated and will be removed in a follow-up;
it serves only as a line-number table.
ColumnMapper now provides only mapping between
byte offsets and columns, in three different
units (UTF-8, UTF-16, and runes).
Three operations that require both a Mapper and
a token.File--and require then to be consistent with
each other--have been moved to ParsedGoFile:
(Pos, PosRange, and RangeToSpanRange).
This is another step to keeping the use of token.Pos
close to its token.File or FileSet, and using
byte offsets and ColumnMappers more broadly.
MappedRange now holds a ParsedGoFile and (internally)
a start/end Pos pair, making it self-contained for all
conversions. (The File field is unfortunately public
for now due to one tricky use; fixing it would have
expanded this already large CL.)
I'm not sure whether MappedRange carries its weight;
I think it might be clearer for all users to simply
expand it out (i.e. hold a ColumnMapper and two byte
offsets), making one less creature in the zoo.
Numerous calls to NewMappedRange followed by .Range()
have been reduced to pgf.PosRange().
Also:
- New ColumnMapper methods:
OffsetSpan
OffsetPoint
- safetoken.Offsets(start, end) is the plural of Offset(pos).
- span.ToPosition renamed span.OffsetToLineCol8.
- span.NewTokenFile inlined into sole caller.
- avoid embedding of MappedRange, as it makes the references
hard to see. (Embedded fields are both a def and a ref but
gopls cross-references is confused by that.)
- findLinksInString uses offsets now.
Change-Id: I2c775e181e456604e2ce977d618b0f1ec8e76903
Reviewed-on: https://go-review.googlesource.com/c/tools/+/460615
Run-TryBot: Alan Donovan <adonovan@google.com>
TryBot-Result: Gopher Robot <gobot@golang.org>
Reviewed-by: Robert Findley <rfindley@google.com>
gopls-CI: kokoro <noreply+kokoro@google.com>
This repository provides the golang.org/x/tools module, comprising various tools and packages mostly for static analysis of Go programs, some of which are listed below. Use the “Go reference” link above for more information about any package.
It also contains the golang.org/x/tools/gopls module, whose root package is a language-server protocol (LSP) server for Go. An LSP server analyses the source code of a project and responds to requests from a wide range of editors such as VSCode and Vim, allowing them to support IDE-like functionality.
Selected commands:
cmd/goimports formats a Go program like go fmt and additionally inserts import statements for any packages required by the file after it is edited.cmd/callgraph prints the call graph of a Go program.cmd/digraph is a utility for manipulating directed graphs in textual notation.cmd/stringer generates declarations (including a String method) for “enum” types.cmd/toolstash is a utility to simplify working with multiple versions of the Go toolchain.These commands may be fetched with a command such as
go install golang.org/x/tools/cmd/goimports@latest
Selected packages:
go/ssa provides a static single-assignment form (SSA) intermediate representation (IR) for Go programs, similar to a typical compiler, for use by analysis tools.
go/packages provides a simple interface for loading, parsing, and type checking a complete Go program from source code.
go/analysis provides a framework for modular static analysis of Go programs.
go/callgraph provides call graphs of Go programs using a variety of algorithms with different trade-offs.
go/ast/inspector provides an optimized means of traversing a Go parse tree for use in analysis tools.
go/cfg provides a simple control-flow graph (CFG) for a Go function.
go/expect reads Go source files used as test inputs and interprets special comments within them as queries or assertions for testing.
go/gcexportdata and go/gccgoexportdata read and write the binary files containing type information used by the standard and gccgo compilers.
go/types/objectpath provides a stable naming scheme for named entities (“objects”) in the go/types API.
Numerous other packages provide more esoteric functionality.
This repository uses Gerrit for code changes. To learn how to submit changes, see https://golang.org/doc/contribute.html.
The main issue tracker for the tools repository is located at https://github.com/golang/go/issues. Prefix your issue with “x/tools/(your subdir):” in the subject line, so it is easy to find.
This repository uses prettier to format JS and CSS files.
The version of prettier used is 1.18.2.
It is encouraged that all JS and CSS code be run through this before submitting a change. However, it is not a strict requirement enforced by CI.