syntaxapi

type Match struct {
	URI        string
	Pos        term.Coordinates
	Display    string
	ImportPath string
}

type NodeCaptureName uint32

type Parser interface {
	// Search searches for matches in the workspace using the given tree-sitter literal query
	// and a list of capture names that should be returned. An optional set of language names
	// (e.g. "go", "python") restricts the search to files of those languages.
	Search(query string, captureNames []string, languages ...string) (iterator.Iterator[Result], error)
	// SearchNode is implemented with Search by using an internally provided
	// query that is able to capture a known set of tree nodes across programming
	// languages. Multiple node types can be combined using bitwise OR. An
	// optional set of language names (e.g. "go", "python") restricts the search
	// to files of those languages.
	SearchNode(nodeTypes NodeCaptureName, languages ...string) (iterator.Iterator[Result], error)
	// Query searches for matches in a specific file using the given tree-sitter
	// literal query and a list of capture names that should be returned.
	Query(file workspaceapi.URI, query string, captureNames []string) (
		iterator.Iterator[Result], error,
	)
	// QueryNode is implemented with Query by using an internally provided
	// query that is able to capture a known set of tree nodes across
	// programming languages. Multiple node types can be combined using bitwise OR.
	QueryNode(file workspaceapi.URI, nodeTypes NodeCaptureName) (
		iterator.Iterator[Result], error,
	)
	// Highlight returns syntax highlighting locations for the given content,
	// interpreted as belonging to the file identified by uri.
	Highlight(uri workspaceapi.URI, content string) (
		iterator.Iterator[textapi.Location], error,
	)
	// ResolveSymbol resolves a dotted symbol name (e.g. "pkg.Symbol") to the
	// locations that define or reference it across the workspace.
	// Progress, if non-nil, receives incremental updates. ResolveSymbol returns
	// ErrNoDot when the name is not a fully qualified symbol name.
	ResolveSymbol(ctx context.Context, name string, progress Progress) (
		iterator.Iterator[Match], error,
	)
	// ListReferencedSymbols streams the fully qualified names (e.g.
	// "pkg.Symbol") of every package/module-qualified symbol referenced or
	// defined across the workspace, deduplicated by the caller.
	ListReferencedSymbols(ctx context.Context) (iterator.Iterator[string], error)
}

type Progress interface {
	Report(msg string, found int, step, total int64)
}

type ProgressFunc func(msg string, found int, step, total int64)

type Result struct {
	File        workspaceapi.URI
	Text        string
	From        term.Coordinates
	To          term.Coordinates
	CaptureName string
}