tools: golang.org/x/tools/internal/lsp/source Index | Files

package source

import "golang.org/x/tools/internal/lsp/source"

Package source provides core features for use by Go editors and tools.

Index

Package Files

analysis.go completion.go completion_format.go completion_snippet.go deep_completion.go diagnostics.go enums.go folding_range.go format.go highlight.go hover.go identifier.go imports.go options.go references.go rename.go rename_check.go signature_help.go suggested_fix.go symbols.go util.go view.go

Constants

const (
    SingleLine = HoverKind(iota)
    NoDocumentation
    SynopsisDocumentation
    FullDocumentation

    // structured is an experimental setting that returns a structured hover format.
    // This format separates the signature from the documentation, so that the client
    // can do more manipulation of these fields.
    //
    // This should only be used by clients that support this behavior.
    Structured
)
const (
    OptionHandled = OptionState(iota)
    OptionDeprecated
    OptionUnexpected
)
const (
    Go  = FileKind(iota)
    Mod
    Sum
)
const (
    // ParseHeader specifies that the main package declaration and imports are needed.
    // This is the mode used when attempting to examine the package graph structure.
    ParseHeader = ParseMode(iota)

    // ParseExported specifies that the public symbols are needed, but things like
    // private symbols and function bodies are not.
    // This mode is used for things where a package is being consumed only as a
    // dependency.
    ParseExported

    // ParseFull specifies the full AST is needed.
    // This is used for files of direct interest where the entire contents must
    // be considered.
    ParseFull
)
const MaxDeepCompletions = 3

Limit deep completion results because in most cases there are too many to be useful.

Variables

var Analyzers = []*analysis.Analyzer{

    asmdecl.Analyzer,
    assign.Analyzer,
    atomic.Analyzer,
    atomicalign.Analyzer,
    bools.Analyzer,
    buildtag.Analyzer,
    cgocall.Analyzer,
    composite.Analyzer,
    copylock.Analyzer,
    httpresponse.Analyzer,
    loopclosure.Analyzer,
    lostcancel.Analyzer,
    nilfunc.Analyzer,
    printf.Analyzer,
    shift.Analyzer,
    stdmethods.Analyzer,
    structtag.Analyzer,
    tests.Analyzer,
    unmarshal.Analyzer,
    unreachable.Analyzer,
    unsafeptr.Analyzer,
    unusedresult.Analyzer,
}
var (
    DefaultOptions = Options{
        Env:                    os.Environ(),
        TextDocumentSyncKind:   protocol.Incremental,
        HoverKind:              SynopsisDocumentation,
        InsertTextFormat:       protocol.PlainTextTextFormat,
        PreferredContentFormat: protocol.PlainText,
        SupportedCodeActions: map[FileKind]map[protocol.CodeActionKind]bool{
            Go: {
                protocol.SourceOrganizeImports: true,
                protocol.QuickFix:              true,
            },
            Mod: {},
            Sum: {},
        },
        Completion: CompletionOptions{
            Documentation: true,
            Deep:          true,
            FuzzyMatching: true,
        },
    }
)

func CandidateImports Uses

func CandidateImports(ctx context.Context, view View, filename string) (pkgs []imports.ImportFix, err error)

AllImportsFixes formats f for each possible fix to the imports. In addition to returning the result of applying all edits, it returns a list of fixes that could be applied to the file, with the corresponding TextEdits that would be needed to apply that fix.

func Completion Uses

func Completion(ctx context.Context, view View, f GoFile, pos protocol.Position, opts CompletionOptions) ([]CompletionItem, *Selection, error)

Completion returns a list of possible candidates for completion, given a a file and a position.

The selection is computed based on the preceding identifier and can be used by the client to score the quality of the completion. For instance, some clients may tolerate imperfect matches as valid completion results, since users may make typos.

func Diagnostics Uses

func Diagnostics(ctx context.Context, view View, f GoFile, disabledAnalyses map[string]struct{}) (map[span.URI][]Diagnostic, error)

func DocumentSymbols Uses

func DocumentSymbols(ctx context.Context, view View, f GoFile) ([]protocol.DocumentSymbol, error)

func Format Uses

func Format(ctx context.Context, view View, f File) ([]protocol.TextEdit, error)

Format formats a file with a given range.

func FromProtocolEdits Uses

func FromProtocolEdits(m *protocol.ColumnMapper, edits []protocol.TextEdit) ([]diff.TextEdit, error)

func Highlight Uses

func Highlight(ctx context.Context, view View, uri span.URI, pos protocol.Position) ([]protocol.Range, error)

func Imports Uses

func Imports(ctx context.Context, view View, f GoFile, rng span.Range) ([]protocol.TextEdit, error)

Imports formats a file using the goimports tool.

func IsGenerated Uses

func IsGenerated(ctx context.Context, view View, uri span.URI) bool

func ToProtocolEdits Uses

func ToProtocolEdits(m *protocol.ColumnMapper, edits []diff.TextEdit) ([]protocol.TextEdit, error)

type Action Uses

type Action struct {
    Analyzer *analysis.Analyzer
    Pkg      Package
    Deps     []*Action
    // contains filtered or unexported fields
}

An action represents one unit of analysis work: the application of one analysis to one package. Actions form a DAG, both within a package (as different analyzers are applied, either in sequence or parallel), and across packages (as dependencies are analyzed).

func (*Action) String Uses

func (act *Action) String() string

type Cache Uses

type Cache interface {
    // A FileSystem that reads file contents from external storage.
    FileSystem

    // NewSession creates a new Session manager and returns it.
    NewSession(ctx context.Context) Session

    // FileSet returns the shared fileset used by all files in the system.
    FileSet() *token.FileSet

    // TokenHandle returns a TokenHandle for the given file handle.
    TokenHandle(fh FileHandle) TokenHandle

    // ParseGoHandle returns a ParseGoHandle for the given file handle.
    ParseGoHandle(fh FileHandle, mode ParseMode) ParseGoHandle
}

Cache abstracts the core logic of dealing with the environment from the higher level logic that processes the information to produce results. The cache provides access to files and their contents, so the source package does not directly access the file system. A single cache is intended to be process wide, and is the primary point of sharing between all consumers. A cache may have many active sessions at any given time.

type CheckPackageHandle Uses

type CheckPackageHandle interface {
    // ID returns the ID of the package associated with the CheckPackageHandle.
    ID() string

    // ParseGoHandle returns a ParseGoHandle for which to get the package.
    Files() []ParseGoHandle

    // Config is the *packages.Config that the package metadata was loaded with.
    Config() *packages.Config

    // Check returns the type-checked Package for the CheckPackageHandle.
    Check(ctx context.Context) (Package, error)

    // Cached returns the Package for the CheckPackageHandle if it has already been stored.
    Cached(ctx context.Context) (Package, error)
}

CheckPackageHandle represents a handle to a specific version of a package. It is uniquely defined by the file handles that make up the package.

type CompletionItem Uses

type CompletionItem struct {
    // Label is the primary text the user sees for this completion item.
    Label string

    // Detail is supplemental information to present to the user.
    // This often contains the type or return type of the completion item.
    Detail string

    // InsertText is the text to insert if this item is selected.
    // Any of the prefix that has already been typed is not trimmed.
    // The insert text does not contain snippets.
    InsertText string

    Kind CompletionItemKind

    // An optional array of additional TextEdits that are applied when
    // selecting this completion.
    //
    // Additional text edits should be used to change text unrelated to the current cursor position
    // (for example adding an import statement at the top of the file if the completion item will
    // insert an unqualified type).
    AdditionalTextEdits []protocol.TextEdit

    // Depth is how many levels were searched to find this completion.
    // For example when completing "foo<>", "fooBar" is depth 0, and
    // "fooBar.Baz" is depth 1.
    Depth int

    // Score is the internal relevance score.
    // A higher score indicates that this completion item is more relevant.
    Score float64

    // Documentation is the documentation for the completion item.
    Documentation string
    // contains filtered or unexported fields
}

func (*CompletionItem) Snippet Uses

func (i *CompletionItem) Snippet() string

Snippet is a convenience returns the snippet if available, otherwise the InsertText. used for an item, depending on if the callee wants placeholders or not.

type CompletionItemKind Uses

type CompletionItemKind int
const (
    Unknown CompletionItemKind = iota
    InterfaceCompletionItem
    StructCompletionItem
    TypeCompletionItem
    ConstantCompletionItem
    FieldCompletionItem
    ParameterCompletionItem
    VariableCompletionItem
    FunctionCompletionItem
    MethodCompletionItem
    PackageCompletionItem
)

func ParseCompletionItemKind Uses

func ParseCompletionItemKind(s string) CompletionItemKind

func (CompletionItemKind) Format Uses

func (e CompletionItemKind) Format(f fmt.State, c rune)

type CompletionOptions Uses

type CompletionOptions struct {
    Deep              bool
    FuzzyMatching     bool
    Unimported        bool
    Documentation     bool
    FullDocumentation bool
    Placeholders      bool
}

type Declaration Uses

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

func (Declaration) Range Uses

func (s Declaration) Range() (protocol.Range, error)

func (Declaration) Span Uses

func (s Declaration) Span() (span.Span, error)

func (Declaration) URI Uses

func (s Declaration) URI() span.URI

type Diagnostic Uses

type Diagnostic struct {
    URI      span.URI
    Range    protocol.Range
    Message  string
    Source   string
    Severity DiagnosticSeverity

    SuggestedFixes []SuggestedFix
}

type DiagnosticSeverity Uses

type DiagnosticSeverity int
const (
    SeverityWarning DiagnosticSeverity = iota
    SeverityError
)

func ParseDiagnosticSeverity Uses

func ParseDiagnosticSeverity(s string) DiagnosticSeverity

func (DiagnosticSeverity) Format Uses

func (e DiagnosticSeverity) Format(f fmt.State, c rune)

type File Uses

type File interface {
    URI() span.URI
    View() View
    Handle(ctx context.Context) FileHandle
}

File represents a source file of any type.

type FileHandle Uses

type FileHandle interface {
    // FileSystem returns the file system this handle was acquired from.
    FileSystem() FileSystem

    // Identity returns the FileIdentity for the file.
    Identity() FileIdentity

    // Kind returns the FileKind for the file.
    Kind() FileKind

    // Read reads the contents of a file and returns it along with its hash value.
    // If the file is not available, returns a nil slice and an error.
    Read(ctx context.Context) ([]byte, string, error)
}

FileHandle represents a handle to a specific version of a single file from a specific file system.

type FileIdentity Uses

type FileIdentity struct {
    URI     span.URI
    Version string
}

FileIdentity uniquely identifies a file at a version from a FileSystem.

func (FileIdentity) String Uses

func (identity FileIdentity) String() string

type FileKind Uses

type FileKind int

FileKind describes the kind of the file in question. It can be one of Go, mod, or sum.

func DetectLanguage Uses

func DetectLanguage(langID, filename string) FileKind

func (FileKind) String Uses

func (k FileKind) String() string

type FileSystem Uses

type FileSystem interface {
    // GetFile returns a handle for the specified file.
    GetFile(uri span.URI) FileHandle
}

FileSystem is the interface to something that provides file contents.

type FoldingRangeInfo Uses

type FoldingRangeInfo struct {
    Kind protocol.FoldingRangeKind
    // contains filtered or unexported fields
}

func FoldingRange Uses

func FoldingRange(ctx context.Context, view View, f GoFile, lineFoldingOnly bool) (ranges []*FoldingRangeInfo, err error)

FoldingRange gets all of the folding range for f.

func (FoldingRangeInfo) Range Uses

func (s FoldingRangeInfo) Range() (protocol.Range, error)

func (FoldingRangeInfo) Span Uses

func (s FoldingRangeInfo) Span() (span.Span, error)

func (FoldingRangeInfo) URI Uses

func (s FoldingRangeInfo) URI() span.URI

type GoFile Uses

type GoFile interface {
    File

    Builtin() (*ast.File, bool)

    // GetCachedPackage returns the cached package for the file, if any.
    GetCachedPackage(ctx context.Context) (Package, error)

    // GetCachedPackage returns the cached package for the file, if any.
    GetCachedPackages(ctx context.Context) ([]Package, error)

    // GetPackage returns the CheckPackageHandle for the package that this file belongs to.
    GetCheckPackageHandle(ctx context.Context) (CheckPackageHandle, error)

    // GetPackages returns the CheckPackageHandles of the packages that this file belongs to.
    GetCheckPackageHandles(ctx context.Context) ([]CheckPackageHandle, error)

    // GetPackage returns the Package that this file belongs to.
    GetPackage(ctx context.Context) (Package, error)

    // GetPackages returns the Packages that this file belongs to.
    GetPackages(ctx context.Context) ([]Package, error)

    // GetActiveReverseDeps returns the active files belonging to the reverse
    // dependencies of this file's package.
    GetActiveReverseDeps(ctx context.Context) []GoFile
}

GoFile represents a Go source file that has been type-checked.

type HoverInformation Uses

type HoverInformation struct {
    // Signature is the symbol's signature.
    Signature string `json:"signature"`

    // SingleLine is a single line describing the symbol.
    // This is recommended only for use in clients that show a single line for hover.
    SingleLine string `json:"singleLine"`

    // Synopsis is a single sentence synopsis of the symbol's documentation.
    Synopsis string `json:"synopsis"`

    // FullDocumentation is the symbol's full documentation.
    FullDocumentation string `json:"fullDocumentation"`
    // contains filtered or unexported fields
}

type HoverKind Uses

type HoverKind int

type IdentifierInfo Uses

type IdentifierInfo struct {
    Name string
    View View
    File ParseGoHandle

    Type struct {
        Object types.Object
        // contains filtered or unexported fields
    }

    Declaration Declaration
    // contains filtered or unexported fields
}

IdentifierInfo holds information about an identifier in Go source.

func Identifier Uses

func Identifier(ctx context.Context, view View, f GoFile, pos protocol.Position) (*IdentifierInfo, error)

Identifier returns identifier information for a position in a file, accounting for a potentially incomplete selector.

func (*IdentifierInfo) Hover Uses

func (i *IdentifierInfo) Hover(ctx context.Context) (*HoverInformation, error)

func (IdentifierInfo) Range Uses

func (s IdentifierInfo) Range() (protocol.Range, error)

func (*IdentifierInfo) References Uses

func (i *IdentifierInfo) References(ctx context.Context) ([]*ReferenceInfo, error)

References returns a list of references for a given identifier within the packages containing i.File. Declarations appear first in the result.

func (*IdentifierInfo) Rename Uses

func (i *IdentifierInfo) Rename(ctx context.Context, view View, newName string) (map[span.URI][]protocol.TextEdit, error)

Rename returns a map of TextEdits for each file modified when renaming a given identifier within a package.

func (IdentifierInfo) Span Uses

func (s IdentifierInfo) Span() (span.Span, error)

func (IdentifierInfo) URI Uses

func (s IdentifierInfo) URI() span.URI

type ImportFix Uses

type ImportFix struct {
    Fix   *imports.ImportFix
    Edits []protocol.TextEdit
}

func AllImportsFixes Uses

func AllImportsFixes(ctx context.Context, view View, f File) (edits []protocol.TextEdit, editsPerFix []*ImportFix, err error)

AllImportsFixes formats f for each possible fix to the imports. In addition to returning the result of applying all edits, it returns a list of fixes that could be applied to the file, with the corresponding TextEdits that would be needed to apply that fix.

type ModFile Uses

type ModFile interface {
    File
}

type OptionResult Uses

type OptionResult struct {
    Name  string
    Value interface{}
    Error error

    State       OptionState
    Replacement string
}

type OptionResults Uses

type OptionResults []OptionResult

func SetOptions Uses

func SetOptions(options *Options, opts interface{}) OptionResults

type OptionState Uses

type OptionState int

type Options Uses

type Options struct {

    // Env is the current set of environment overrides on this view.
    Env []string

    // BuildFlags is used to adjust the build flags applied to the view.
    BuildFlags []string

    HoverKind        HoverKind
    DisabledAnalyses map[string]struct{}

    WatchFileChanges              bool
    InsertTextFormat              protocol.InsertTextFormat
    ConfigurationSupported        bool
    DynamicConfigurationSupported bool
    DynamicWatchedFilesSupported  bool
    PreferredContentFormat        protocol.MarkupKind
    LineFoldingOnly               bool

    SupportedCodeActions map[FileKind]map[protocol.CodeActionKind]bool

    // TODO: Remove the option once we are certain there are no issues here.
    TextDocumentSyncKind protocol.TextDocumentSyncKind

    Completion CompletionOptions
}

func (*Options) ForClientCapabilities Uses

func (o *Options) ForClientCapabilities(caps protocol.ClientCapabilities)

type Package Uses

type Package interface {
    ID() string
    PkgPath() string
    GetHandles() []ParseGoHandle
    GetSyntax(context.Context) []*ast.File
    GetErrors() []packages.Error
    GetTypes() *types.Package
    GetTypesInfo() *types.Info
    GetTypesSizes() types.Sizes
    IsIllTyped() bool
    GetDiagnostics() []Diagnostic
    SetDiagnostics(a *analysis.Analyzer, diag []Diagnostic)

    // GetImport returns the CheckPackageHandle for a package imported by this package.
    GetImport(ctx context.Context, pkgPath string) (Package, error)

    // GetActionGraph returns the action graph for the given package.
    GetActionGraph(ctx context.Context, a *analysis.Analyzer) (*Action, error)

    // FindFile returns the AST and type information for a file that may
    // belong to or be part of a dependency of the given package.
    FindFile(ctx context.Context, uri span.URI, pos token.Pos) (ParseGoHandle, *ast.File, Package, error)
}

Package represents a Go package that has been type-checked. It maintains only the relevant fields of a *go/packages.Package.

type ParameterInformation Uses

type ParameterInformation struct {
    Label string
}

type ParseGoHandle Uses

type ParseGoHandle interface {
    // File returns a file handle for which to get the AST.
    File() FileHandle

    // Mode returns the parse mode of this handle.
    Mode() ParseMode

    // Parse returns the parsed AST for the file.
    // If the file is not available, returns nil and an error.
    Parse(ctx context.Context) (*ast.File, error)

    // Cached returns the AST for this handle, if it has already been stored.
    Cached(ctx context.Context) (*ast.File, error)
}

ParseGoHandle represents a handle to the AST for a file.

type ParseMode Uses

type ParseMode int

ParseMode controls the content of the AST produced when parsing a source file.

type PrepareItem Uses

type PrepareItem struct {
    Range protocol.Range
    Text  string
}

func PrepareRename Uses

func PrepareRename(ctx context.Context, view View, f GoFile, pos protocol.Position) (*PrepareItem, error)

type ReferenceInfo Uses

type ReferenceInfo struct {
    Name string
    // contains filtered or unexported fields
}

ReferenceInfo holds information about reference to an identifier in Go source.

func (ReferenceInfo) Range Uses

func (s ReferenceInfo) Range() (protocol.Range, error)

func (ReferenceInfo) Span Uses

func (s ReferenceInfo) Span() (span.Span, error)

func (ReferenceInfo) URI Uses

func (s ReferenceInfo) URI() span.URI

type Selection Uses

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

A Selection represents the cursor position and surrounding identifier.

func (Selection) Prefix Uses

func (p Selection) Prefix() string

func (Selection) Range Uses

func (s Selection) Range() (protocol.Range, error)

func (Selection) Span Uses

func (s Selection) Span() (span.Span, error)

func (Selection) URI Uses

func (s Selection) URI() span.URI

type Session Uses

type Session interface {
    // NewView creates a new View and returns it.
    NewView(ctx context.Context, name string, folder span.URI, options Options) View

    // Cache returns the cache that created this session.
    Cache() Cache

    // View returns a view with a matching name, if the session has one.
    View(name string) View

    // ViewOf returns a view corresponding to the given URI.
    ViewOf(uri span.URI) View

    // Views returns the set of active views built by this session.
    Views() []View

    // Shutdown the session and all views it has created.
    Shutdown(ctx context.Context)

    // A FileSystem prefers the contents from overlays, and falls back to the
    // content from the underlying cache if no overlay is present.
    FileSystem

    // DidOpen is invoked each time a file is opened in the editor.
    DidOpen(ctx context.Context, uri span.URI, kind FileKind, text []byte)

    // DidSave is invoked each time an open file is saved in the editor.
    DidSave(uri span.URI)

    // DidClose is invoked each time an open file is closed in the editor.
    DidClose(uri span.URI)

    // IsOpen returns whether the editor currently has a file open.
    IsOpen(uri span.URI) bool

    // Called to set the effective contents of a file from this session.
    SetOverlay(uri span.URI, data []byte) (wasFirstChange bool)

    // DidChangeOutOfBand is called when a file under the root folder
    // changes. The file is not necessarily open in the editor.
    DidChangeOutOfBand(ctx context.Context, f GoFile, change protocol.FileChangeType)

    // Options returns a copy of the SessionOptions for this session.
    Options() Options

    // SetOptions sets the options of this session to new values.
    SetOptions(Options)
}

Session represents a single connection from a client. This is the level at which things like open files are maintained on behalf of the client. A session may have many active views at any given time.

type SignatureInformation Uses

type SignatureInformation struct {
    Label, Documentation string
    Parameters           []ParameterInformation
    ActiveParameter      int
}

func SignatureHelp Uses

func SignatureHelp(ctx context.Context, view View, f GoFile, pos protocol.Position) (*SignatureInformation, error)

type SuggestedFix Uses

type SuggestedFix struct {
    Title string
    Edits []protocol.TextEdit
}

type SumFile Uses

type SumFile interface {
    File
}

type TokenHandle Uses

type TokenHandle interface {
    // File returns a file handle for which to get the *token.File.
    File() FileHandle

    // Token returns the *token.File for the file.
    Token(ctx context.Context) (*token.File, error)
}

TokenHandle represents a handle to the *token.File for a file.

type View Uses

type View interface {
    // Session returns the session that created this view.
    Session() Session

    // Name returns the name this view was constructed with.
    Name() string

    // Folder returns the root folder for this view.
    Folder() span.URI

    // BuiltinPackage returns the ast for the special "builtin" package.
    BuiltinPackage() *ast.Package

    // GetFile returns the file object for a given URI, initializing it
    // if it is not already part of the view.
    GetFile(ctx context.Context, uri span.URI) (File, error)

    // FindFile returns the file object for a given URI if it is
    // already part of the view.
    FindFile(ctx context.Context, uri span.URI) File

    // Called to set the effective contents of a file from this view.
    SetContent(ctx context.Context, uri span.URI, content []byte) (wasFirstChange bool, err error)

    // BackgroundContext returns a context used for all background processing
    // on behalf of this view.
    BackgroundContext() context.Context

    // Shutdown closes this view, and detaches it from it's session.
    Shutdown(ctx context.Context)

    // Ignore returns true if this file should be ignored by this view.
    Ignore(span.URI) bool

    Config(ctx context.Context) *packages.Config

    // RunProcessEnvFunc runs fn with the process env for this view inserted into opts.
    // Note: the process env contains cached module and filesystem state.
    RunProcessEnvFunc(ctx context.Context, fn func(*imports.Options) error, opts *imports.Options) error

    // Options returns a copy of the Options for this view.
    Options() Options

    // SetOptions sets the options of this view to new values.
    // Warning: Do not use this, unless in a test.
    // This function does not correctly invalidate the view when needed.
    SetOptions(Options)
}

View represents a single workspace. This is the level at which we maintain configuration like working directory and build tags.

Package source imports 58 packages (graph) and is imported by 12 packages. Updated 2019-09-16. Refresh now. Tools for package owners.