scip

type Controller interface {
	StartupInfo(ctx context.Context) (ulspplugin.PluginInfo, error)
	GetDocumentSymbols(ctx context.Context, workspaceRoot string, uri string) ([]*model.SymbolOccurrence, error)
	GetSymbolDefinitionOccurrence(ctx context.Context, workspaceRoot string, descriptors []model.Descriptor, version string) (*model.SymbolOccurrence, error)
}

type FileInfo struct {
	URI          uri.URI
	Document     *model.Document
	Package      *PackageMeta
	Locals       map[string]*SymbolData
	Definitions  map[string]*SymbolData
	ExternalRefs []*FileOccurences
}

type FileOccurences struct {
	Occurrences []*model.Occurrence
	// contains filtered or unexported fields
}

type IndexLoadStatus string

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

type PackageID string

type PackageMeta struct {
	Pkg *model.ScipPackage
	// SymbolData maps from symbol moniker to a data provider
	SymbolData map[string]*SymbolData
	// contains filtered or unexported fields
}

type Params struct {
	fx.In

	Sessions   session.Repository
	IdeGateway ideclient.Gateway
	Logger     *zap.SugaredLogger
	Config     config.Provider
	Stats      tally.Scope
	FS         fs.UlspFS

	PluginDocSync     docsync.Controller
	PluginDiagnostics diagnostics.Controller
}

type Registry interface {
	LoadConcurrency() int
	SetDocumentLoadedCallback(func(*model.Document))
	LoadIndex(indexReader io.ReadSeeker) error
	LoadIndexFile(indexPath string) error
	DidOpen(uri uri.URI, text string) error
	DidClose(uri uri.URI) error
	// GetSymbolInformation returns the symbol information for a given position (does not require a full loaded index)
	GetSymbolOccurrence(uri uri.URI, loc protocol.Position) (*model.SymbolOccurrence, error)
	// GetSymbolDefinitionOccurrence returns the definition occurrence for a given symbol
	GetSymbolDefinitionOccurrence(descriptors []model.Descriptor, version string) (*model.SymbolOccurrence, error)
	// Definition returns the source occurence and the definition occurence for a given position
	Definition(uri uri.URI, loc protocol.Position) (*model.SymbolOccurrence, *model.SymbolOccurrence, error)
	// References returns the locations a symbol is referenced at in the entire index
	References(uri uri.URI, loc protocol.Position) ([]protocol.Location, error)
	// Hover returns the hover information for a given position, as well as it's occurrence
	Hover(uri uri.URI, loc protocol.Position) (string, *model.Occurrence, error)
	// DocumentSymbols returns the document symbols for a given document
	DocumentSymbols(uri uri.URI) ([]*model.SymbolOccurrence, error)
	// Diagnostics returns the diagnostics for a given document
	Diagnostics(uri uri.URI) ([]*model.Diagnostic, error)
	GetSymbolForPosition(uri uri.URI, loc protocol.Position) (*model.Occurrence, *SymbolData, error)
	GetDocumentSymbolForFile(uri uri.URI) (*[]*SymbolData, error)
	GetFileInfo(uri uri.URI) *FileInfo
	GetPackageInfo(pkgID PackageID) *PackageMeta
	// GetURI gets the full path to a document as an LSP uri.
	GetURI(relPath string) uri.URI
}

type SymbolData struct {
	Info       *model.SymbolInformation
	Definition *model.Occurrence
	Location   *protocol.LocationLink
	// References stores all the locations this symbol is referenced.
	// This is indexed by package that References it for easy updating when a package gets a new index.
	// This is further aligned as an array of files so we can return an organized result of References when requested.
	References map[PackageID][]*FileOccurences
	// contains filtered or unexported fields
}