model

package
v0.1.0-rc.3 Latest Latest
Warning

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

Go to latest
Published: Oct 20, 2025 License: MIT Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ParseScipSymbol

func ParseScipSymbol(sy string) (*scip.Symbol, error)

ParseScipSymbol parses a symbol string into a Symbol, ensuring the package name is set

func ParseScipSymbolToDisplayName

func ParseScipSymbolToDisplayName(symbolStr string) string

ParseScipSymbolToDisplayName parses a symbol and return the displayName

Types

type Descriptor

type Descriptor struct {
	Name          string
	Suffix        scip.Descriptor_Suffix
	Disambiguator string
}

Descriptor represents a symbol descriptor

type Diagnostic

type Diagnostic struct {
	Severity scip.Severity
	Code     string
	Message  string
	Source   string
	Tags     []scip.DiagnosticTag
}

Diagnostic represents a warning or error in a document

type Document

type Document struct {
	Language     string
	RelativePath string
	Occurrences  []*Occurrence
	Symbols      []*SymbolInformation
	SymbolMap    map[string]*SymbolInformation
	Text         string
	Diagnostics  []*protocol.Diagnostic
}

Document represents a document in the SCIP Index

type Occurrence

type Occurrence struct {
	Range                 []int32
	Symbol                string
	SymbolRoles           int32
	OverrideDocumentation []string
	SyntaxKind            scip.SyntaxKind
	Diagnostics           []*Diagnostic
	EnclosingRange        []int32
}

Occurrence represents a symbol occurrence in a document

type Relationship

type Relationship struct {
	Symbol           string
	IsReference      bool
	IsImplementation bool
	IsTypeDefinition bool
	IsDefinition     bool
}

Relationship represents a relationship between two symbols

type ScipPackage

type ScipPackage struct {
	Manager string
	Name    string
	Version string
}

ScipPackage represents a package in the SCIP Index

func (*ScipPackage) ID

func (x *ScipPackage) ID() string

ID returns the ID of the package

type SymbolInformation

type SymbolInformation struct {
	Symbol                 string
	Documentation          []string
	Relationships          []*Relationship
	Kind                   scip.SymbolInformation_Kind
	DisplayName            string
	SignatureDocumentation *Document
	EnclosingSymbol        string
}

SymbolInformation represents a symbol in a document

type SymbolOccurrence

type SymbolOccurrence struct {
	Location   uri.URI
	Occurrence *Occurrence
	Info       *SymbolInformation
}

SymbolOccurrence represents a symbol occurrence in a document

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL