query

package

v0.6.0 Latest Latest Go to latest Published: Jan 25, 2023 License: Apache-2.0 Imports: 4 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/klothoplatform/klotho

Links

Open Source Insights

Documentation ¶

Index ¶

func Collect[T any](f NextFunc[T]) []T
func FirstAncestorOfType(node *sitter.Node, ptype string) *sitter.Node
func NodeContentEquals(node *sitter.Node, src []byte, s string) bool
func NodeContentRegex(node *sitter.Node, src []byte, regex *regexp.Regexp) bool
func NodeContentStartWith(node *sitter.Node, src []byte, s string) bool
type AllOf
- func (a AllOf[T]) Test(input T, source []byte) bool
type Cache
- func (m *Cache) AddQuery(lang core.LanguageId, name string, query *sitter.Query)
- func (m *Cache) GetQuery(lang core.LanguageId, name string) (*sitter.Query, bool)
type HasContent
- func (hc HasContent) Test(node *sitter.Node, source []byte) bool
type HasParent
- func (hp HasParent) Test(node *sitter.Node, source []byte) bool
type Is
- func (a Is[T]) Test(_ T, _ []byte) bool
type MatchNodes
type NextFunc
- func Select[T any](source []byte, query NextFunc[MatchNodes], selector Selector[T]) NextFunc[T]
- func SelectIf[T any](source []byte, query NextFunc[MatchNodes], selector Selector[T], ...) NextFunc[T]
type NextMatchFunc
- func Exec(lang core.SourceLanguage, c *sitter.Node, q string) NextMatchFunc
type Param
- func (wp Param) Test(nodes MatchNodes, source []byte) bool
type Predicate
type Reference
- func FindReferencesInFile(file *core.SourceFile, matchRefQuery string, ...) []Reference
- func FindReferencesInUnit(lang *core.SourceLanguage, unit *core.ExecutionUnit, matchRefQuery string, ...) []Reference
type Selector
- func ContentOf(filter Selector[*sitter.Node]) Selector[string]
- func ParamNamed(paramName string) Selector[*sitter.Node]
type Type
- func (ot Type) Test(node *sitter.Node, _ []byte) bool

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Collect ¶

func Collect[T any](f NextFunc[T]) []T

func FirstAncestorOfType ¶

func FirstAncestorOfType(node *sitter.Node, ptype string) *sitter.Node

func NodeContentEquals ¶

func NodeContentEquals(node *sitter.Node, src []byte, s string) bool

func NodeContentRegex ¶

func NodeContentRegex(node *sitter.Node, src []byte, regex *regexp.Regexp) bool

func NodeContentStartWith ¶

func NodeContentStartWith(node *sitter.Node, src []byte, s string) bool

Types ¶

type AllOf ¶

type AllOf[T any] []Predicate[T]

func (AllOf[T]) Test ¶

func (a AllOf[T]) Test(input T, source []byte) bool

type Cache ¶

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

Cache stores queries by language ID in a threadsafe manner

func (*Cache) AddQuery ¶

func (m *Cache) AddQuery(lang core.LanguageId, name string, query *sitter.Query)

AddQuery adds a new query to the cache

func (*Cache) GetQuery ¶

func (m *Cache) GetQuery(lang core.LanguageId, name string) (*sitter.Query, bool)

GetQuery gets the *sitter.Query instance associated with the provided language ID and name combination

type HasContent ¶

type HasContent string

func (HasContent) Test ¶

func (hc HasContent) Test(node *sitter.Node, source []byte) bool

type HasParent ¶

type HasParent struct {
	With Predicate[*sitter.Node]
}

func (HasParent) Test ¶

func (hp HasParent) Test(node *sitter.Node, source []byte) bool

type Is ¶

type Is[T any] bool

func (Is[T]) Test ¶

func (a Is[T]) Test(_ T, _ []byte) bool

type MatchNodes ¶

type MatchNodes = map[string]*sitter.Node

type NextFunc ¶

type NextFunc[T any] func() (T, bool)

func Select ¶

func Select[T any](source []byte, query NextFunc[MatchNodes], selector Selector[T]) NextFunc[T]

func SelectIf ¶

func SelectIf[T any](source []byte, query NextFunc[MatchNodes], selector Selector[T], predicate Predicate[MatchNodes]) NextFunc[T]

type NextMatchFunc ¶

type NextMatchFunc = NextFunc[MatchNodes]

func Exec ¶

func Exec(lang core.SourceLanguage, c *sitter.Node, q string) NextMatchFunc

Exec returns a function that acts as an iterator, each call will loop over the next match lazily and populate the results map with a mapping of field name as defined in the query to mapped node.

type Param ¶

type Param struct {
	Named   string
	Matches Predicate[*sitter.Node]
}

func (Param) Test ¶

func (wp Param) Test(nodes MatchNodes, source []byte) bool

type Predicate ¶

type Predicate[T any] interface {
	Test(input T, source []byte) bool
}

Predicate takes some value and the program source, and returns a bool.

type Reference ¶

type Reference struct {
	File        *core.SourceFile
	QueryResult map[string]*sitter.Node
}

func FindReferencesInFile ¶

func FindReferencesInFile(
	file *core.SourceFile,
	matchRefQuery string,
	validate func(map[string]*sitter.Node, *core.SourceFile) bool,
) []Reference

func FindReferencesInUnit ¶

func FindReferencesInUnit(
	lang *core.SourceLanguage,
	unit *core.ExecutionUnit,
	matchRefQuery string,
	validate func(map[string]*sitter.Node, *core.SourceFile) bool,
) []Reference

type Selector ¶

type Selector[T any] func(MatchNodes, []byte) (T, bool)

Selector takes a MatchNodes and the program source, and optionally returns some value.

func ContentOf ¶

func ContentOf(filter Selector[*sitter.Node]) Selector[string]

func ParamNamed ¶

func ParamNamed(paramName string) Selector[*sitter.Node]

ParamNamed is a Selector that returns a param from the MatchNodes by name, if such a param exists.

type Type ¶

type Type string

func (Type) Test ¶

func (ot Type) Test(node *sitter.Node, _ []byte) bool

Source Files ¶

View all Source files

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