cache

package
v0.1.7 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 27, 2026 License: Apache-2.0 Imports: 18 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewOverlayFS 

func NewOverlayFS(delegate FileSource) *overlayFS

Types

type ChangeResult added in v0.1.7 

type ChangeResult struct {
	// Gen is the generation this change produced. Compare it against
	// View.IsCurrent before publishing derived results.
	Gen uint64

	// Affected holds the changed URIs first, in order, then their
	// transitive dependents, deduped. Edges were refreshed from an eager
	// re-parse of the changed files, so it reflects the change.
	Affected []uri.URI
}

ChangeResult reports what a batch of changes did: the new generation and the affected URIs (changed files plus their transitive dependents).

type DiskFile 

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

A DiskFile is a file on the filesystem, or a failure to read one. It implements the source.FileHandle interface.

func (*DiskFile) Content 

func (h *DiskFile) Content() ([]byte, error)

func (*DiskFile) URI 

func (h *DiskFile) URI() uri.URI

func (*DiskFile) Version 

func (h *DiskFile) Version() int32

type FileChange 

type FileChange struct {
	URI     uri.URI
	Version int
	Content []byte
	From    FileChangeType
}

func FileChangeFromLSPDidChange 

func FileChangeFromLSPDidChange(params *protocol.DidChangeTextDocumentParams) []*FileChange

FileChangeFromLSPDidChange converts a didChange payload into file changes. The server advertises whole-document sync, so whole-document events map one-to-one; incremental (partial) events are a client protocol violation and are skipped.

func (*FileChange) FullContent 

func (f *FileChange) FullContent() []byte

type FileChangeType 

type FileChangeType string
const (
	FileChangeTypeInitialize FileChangeType = "Initialize"
	FileChangeTypeDidOpen    FileChangeType = "DidOpen"
	FileChangeTypeDidChange  FileChangeType = "DidChange"
	FileChangeTypeDidClose   FileChangeType = "DidClose"
)

type FileHandle 

type FileHandle interface {
	// URI is the URI for this file handle.
	// TODO(rfindley): this is not actually well-defined. In some cases, there
	// may be more than one URI that resolve to the same FileHandle. Which one is
	// this?
	URI() uri.URI
	// Version returns the file version, as defined by the LSP client.
	// For on-disk file handles, Version returns 0.
	Version() int32
	// Content returns the contents of a file.
	// If the file is not available, returns a nil slice and an error.
	Content() ([]byte, error)
}

A FileHandle represents the URI, content, and optional version of a file tracked by the LSP session.

File content may be provided by the file system or from an overlay for an open file with unsaved edits. A FileHandle may record an attempt to read a non-existent file, in which case Content returns an error.

type FileID 

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

A FileID uniquely identifies a file in the file system.

If GetFileID(name1) returns the same ID as GetFileID(name2), the two file names denote the same file. A FileID is comparable, and thus suitable for use as a map key.

func GetFileID 

func GetFileID(filename string) (FileID, time.Time, error)

GetFileID returns the file system's identifier for the file, and its modification time. Like os.Stat, it reads through symbolic links.

type FileIndex added in v0.1.2 

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

FileIndex is the per-file semantic index: the file's definitions, enum values, name references, and annotation names, extracted in a single AST walk and cached with the parse. A re-parse replaces the whole ParsedFile, so the index never goes stale.

The index answers "what does this file contain". Cross-file questions — "where is this name defined", "who references it" — belong to source.Index, which composes FileIndexes over the include graph.

func (*FileIndex) Defs added in v0.1.2 

func (x *FileIndex) Defs() map[string]syntax.Node

Defs returns the file's top-level definitions indexed by name: structs, unions, exceptions, enums, services, consts, and typedefs. The node's concrete type identifies the definition kind.

func (*FileIndex) EnumValues added in v0.1.2 

func (x *FileIndex) EnumValues() map[string]*syntax.Identifier

EnumValues returns the file's enum value names indexed by name.

func (*FileIndex) References added in v0.1.2 

func (x *FileIndex) References() []Reference

References returns every name reference in the file, in document order: field and signature type references, constant value identifiers, and service extends references.

type FileSource 

type FileSource interface {
	// ReadFile returns the FileHandle for a given URI, either by
	// reading the content of the file or by obtaining it from a cache.
	ReadFile(ctx context.Context, uri uri.URI) (FileHandle, error)
	// WalkFiles calls fn for every file under root, recursively, in
	// lexical order. The caller filters by kind (e.g. extension). An
	// error returned by fn stops the walk; per-entry failures (missing
	// roots, permissions) are the implementation's to skip or report.
	WalkFiles(ctx context.Context, root uri.URI, fn func(uri.URI) error) error
}

A FileSource maps URIs to FileHandles.

func NewMemFS added in v0.1.4 

func NewMemFS(files map[uri.URI][]byte) FileSource

NewMemFS returns a FileSource backed by files; nil is an empty tree.

func NewMemoizedFS added in v0.1.7 

func NewMemoizedFS() FileSource

NewMemoizedFS returns the production disk file source: reads stat first and memoize by inode+mtime.

type Overlay 

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

An Overlay is a file open in the editor. It may have unsaved edits. It implements the source.FileHandle interface.

func NewOverlay 

func NewOverlay(uri uri.URI, content []byte, version int32) *Overlay

func (*Overlay) Content 

func (o *Overlay) Content() ([]byte, error)

func (*Overlay) URI 

func (o *Overlay) URI() uri.URI

func (*Overlay) Version 

func (o *Overlay) Version() int32

type ParsedFile 

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

func Parse 

func Parse(fh FileHandle) (*ParsedFile, error)

Parse lexes and parses the file content into a ParsedFile.

func (*ParsedFile) AST 

func (p *ParsedFile) AST() *syntax.Document

func (*ParsedFile) AggregatedError 

func (p *ParsedFile) AggregatedError() error

func (*ParsedFile) Definitions 

func (p *ParsedFile) Definitions() map[string]syntax.Node

Definitions returns the file's top-level definitions indexed by name: structs, unions, exceptions, enums, services, consts, and typedefs. The node's concrete type identifies the definition kind.

func (*ParsedFile) EnumValues 

func (p *ParsedFile) EnumValues() map[string]*syntax.Identifier

EnumValues returns the file's enum value names indexed by name.

func (*ParsedFile) Errors 

func (p *ParsedFile) Errors() []syntax.Error

func (*ParsedFile) Index added in v0.1.2 

func (p *ParsedFile) Index() *FileIndex

Index returns the file's semantic index: definitions, enum values, name references, and annotation names from a single AST walk.

func (*ParsedFile) Mapper 

func (p *ParsedFile) Mapper() *mapper.Mapper

func (*ParsedFile) Tokens 

func (p *ParsedFile) Tokens() map[string]struct{}

Tokens returns the identifier tokens of the file, computed once and reused. A re-parse replaces the whole ParsedFile, so the cache never goes stale.

func (*ParsedFile) URI added in v0.1.2 

func (p *ParsedFile) URI() uri.URI

URI returns the URI of the parsed file.

type RefKind added in v0.1.2 

type RefKind uint8

RefKind classifies a name reference by the grammar slot it sits in. The slot decides what the reference can legally point at: an exception is only referenced from signatures, an enum value only from value positions. 

const (
	// RefFieldType is a type reference in a field-ish position: struct,
	// union, and exception fields, typedef targets, and const types.
	RefFieldType RefKind = iota + 1
	// RefSignatureType is a type reference in a service signature: a
	// function return type, argument, or throws member.
	RefSignatureType
	// RefConstValue is an identifier in a constant value position: a field
	// default or a const value, possibly qualified ("Color.RED").
	RefConstValue
	// RefServiceExtends is a service extends reference.
	RefServiceExtends
)

type Reference added in v0.1.2 

type Reference struct {
	Kind RefKind

	// Name is the reference text as written: "User", "shared.User", or
	// "shared.thrift.User".
	Name string

	// Node carries the reference's position: *syntax.Identifier for type
	// and service references, *syntax.ConstValue for value references.
	// Ranges come from the owning file's AST and mapper.
	Node syntax.Node
}

Reference is one name occurrence that resolves to a definition somewhere: in this file or in an included one. It is a raw fact — the name text as written, uninterpreted. Qualifier parsing ("shared.User" vs "shared.thrift.User") and definition matching live in the source layer, which knows the include graph.

type Resolver 

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

Resolver provides centralized include path resolution.

func (*Resolver) GetIncludePath 

func (r *Resolver) GetIncludePath(ast *syntax.Document, includeName string) string

GetIncludePath returns the include path text for a given include name. Returns empty string if not found.

func (*Resolver) GetIncludeURI 

func (r *Resolver) GetIncludeURI(cur uri.URI, ast *syntax.Document, includeName string) uri.URI

GetIncludeURI returns the URI for an included file by include name. Returns empty URI if not found.

func (*Resolver) IncludePaths 

func (r *Resolver) IncludePaths() []string

IncludePaths returns the include paths configured for this resolver.

func (*Resolver) ResolveInclude 

func (r *Resolver) ResolveInclude(cur uri.URI, includePath string) uri.URI

ResolveInclude resolves an include path to a file URI. It first tries relative to the current file, then tries each include path.

type Session 

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

func NewSession 

func NewSession(fs FileSource) *Session

func (*Session) AddView 

func (s *Session) AddView(folder uri.URI, includePaths []string) *View

AddView registers a view for the workspace folder, returning the existing view when the folder is already tracked. includePaths and AddView registers a view for the workspace folder, returning the existing view when the folder is already tracked. includePaths is the folder's resolved include configuration; the view fixes it at creation.

func (Session) Forget 

func (fs Session) Forget(uri uri.URI)

Forget drops the overlay for uri, falling back to disk content.

func (Session) HasOverlay 

func (fs Session) HasOverlay(uri uri.URI) bool

HasOverlay reports whether uri has an open overlay.

func (Session) ReadFile 

func (fs Session) ReadFile(ctx context.Context, uri uri.URI) (FileHandle, error)

func (*Session) RemoveView 

func (s *Session) RemoveView(folder uri.URI)

RemoveView drops the view for the workspace folder and forgets every cached file-to-view mapping that pointed at it, so ViewOf re-resolves against the remaining folders.

func (Session) Update 

func (fs Session) Update(_ context.Context, changes []*FileChange) error

Update applies changes to the overlay set. DidClose changes remove the overlay; all other types create or replace it.

func (*Session) UpdateOverlayFS 

func (s *Session) UpdateOverlayFS(ctx context.Context, changes []*FileChange) error

func (*Session) ViewOf 

func (s *Session) ViewOf(fileURI uri.URI) (*View, error)

func (*Session) Views 

func (s *Session) Views() []*View

Views returns the workspace folders' views.

func (*Session) WalkFiles added in v0.1.4 

func (s *Session) WalkFiles(ctx context.Context, root uri.URI, fn func(uri.URI) error) error

WalkFiles enumerates the file source under root. Open overlays are already known to the session via didOpen, so this walks the underlying source (the disk in production).

type View 

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

View is one workspace folder's file store: parsed files, the include graph between them, and the include configuration that applies to them.

Concurrency: entries and edges are guarded by mu; reads share immutable values, writes replace entries wholesale. gen bumps on every Update; asynchronous work compares its captured generation against View.IsCurrent to drop superseded results.

func BuildViewForTest added in v0.1.7 

func BuildViewForTest(files []*FileChange) *View

func BuildViewForTestWithPaths added in v0.1.7 

func BuildViewForTestWithPaths(includePaths []string, files []*FileChange) *View

BuildViewForTestWithPaths is BuildViewForTest with configured include paths, for cross-project include resolution tests.

func NewView 

func NewView(folder uri.URI, fs FileSource, includePaths []string) *View

func (*View) ContainsFile 

func (v *View) ContainsFile(uri uri.URI) bool

func (*View) Dependents added in v0.1.7 

func (v *View) Dependents(file uri.URI) []uri.URI

Dependents returns every file that directly or transitively includes file, including file itself when a cycle leads back to it. The result is sorted ascending by URI.

func (*View) FileKnown 

func (v *View) FileKnown(u uri.URI) bool

FileKnown reports whether the view tracks uri.

func (*View) Folder 

func (v *View) Folder() uri.URI

Folder returns the workspace folder the view covers.

func (*View) Generation added in v0.1.7 

func (v *View) Generation() uint64

Generation returns the view's change counter. It increments on every FileChange; asynchronous work captures it and re-checks before publishing.

func (*View) Includers added in v0.1.7 

func (v *View) Includers(file uri.URI) []uri.URI

Includers returns the files that include file directly, sorted ascending by URI.

func (*View) Includes added in v0.1.7 

func (v *View) Includes(file uri.URI) []uri.URI

Includes returns the files file includes directly, sorted ascending by URI.

func (*View) IsCurrent 

func (v *View) IsCurrent(gen uint64) bool

IsCurrent reports whether gen is still the view's latest generation. Used by asynchronous work to drop results that a newer change superseded.

func (*View) KnownFiles 

func (v *View) KnownFiles() []uri.URI

KnownFiles returns the tracked file URIs of the view, sorted for deterministic iteration.

func (*View) Parse added in v0.1.7 

func (v *View) Parse(ctx context.Context, u uri.URI) (*ParsedFile, error)

Parse returns the cached parse of uri, parsing it on first use. A parse failure (unreadable file) is not cached; syntax errors are carried on the ParsedFile itself.

func (*View) ReadFile added in v0.1.7 

func (v *View) ReadFile(ctx context.Context, u uri.URI) (FileHandle, error)

ReadFile returns the current content of uri: the editor overlay for open files, the memoized disk content otherwise. Content is not cached on the view — the file sources already memoize it.

func (*View) Resolver added in v0.1.7 

func (v *View) Resolver() *Resolver

Resolver returns a resolver for the view's include paths.

func (*View) TokensForFile added in v0.1.7 

func (v *View) TokensForFile(file uri.URI) map[string]struct{}

TokensForFile returns the identifier tokens of file and its transitively included files. Only already-parsed files contribute; nothing is forced.

func (*View) Update added in v0.1.7 

func (v *View) Update(ctx context.Context, changes ...*FileChange) ChangeResult

Update applies changes to the view: it invalidates the changed files' entries and re-parses them, so their include edges are fresh before any request observes the change. It returns what changed; publishing derived results (diagnostics) is the caller's policy.

func (*View) WalkFiles added in v0.1.4 

func (v *View) WalkFiles(ctx context.Context, root uri.URI, fn func(uri.URI) error) error

WalkFiles enumerates the view's file source under root: the disk in production, the in-memory tree in tests.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.