extractor

Documentation

Index

• func PathStandardize(results []*FileResult, basedir string) error
• func RegisterExtractor(langType core.LangType, extractor Extractor)
• type BaseFileResult
  • func (b *BaseFileResult[T]) IsEmpty() bool
• type Call
• type CallFileResult
• type CallSupport
• type ClassSupport
• type Clazz
• type ClazzFileResult
• type ClazzWithPath
• type DataType
  • func DataTypeOf[T DataType](dataList []T) []DataType
• type DataTypes
• type ExtractType
• type Extractor
  • func GetExtractor(lang core.LangType) Extractor
• type FileResult
• type Function
• type FunctionFileResult
• type FunctionSupport
• type FunctionWithPath
  • func WrapFuncWithPath(f *Function, p string) *FunctionWithPath
  • func (fwp *FunctionWithPath) GetDescWithPath() string
• type Symbol
• type SymbolFileResult
• type SymbolSupport
• type SymbolWithPath

Functions

func PathStandardize

func PathStandardize(results []*FileResult, basedir string) error

func RegisterExtractor

func RegisterExtractor(langType core.LangType, extractor Extractor)

Types

type BaseFileResult

type BaseFileResult[T DataType] struct {
	Path     string        `json:"path"`
	Language core.LangType `json:"language"`
	Type     string        `json:"type"`
	Units    []T           `json:"units"`
}

func (*BaseFileResult[T]) IsEmpty

func (b *BaseFileResult[T]) IsEmpty() bool

type Call

type Call = object.Call

type CallFileResult

type CallFileResult = BaseFileResult[*Call]

type CallSupport

type CallSupport interface {
	IsCall(unit *core.Unit) bool
	ExtractCalls([]*core.Unit) ([]*Call, error)
}

type ClassSupport

type ClassSupport interface {
	IsClass(*core.Unit) bool
	ExtractClasses([]*core.Unit) ([]*Clazz, error)
	ExtractClass(*core.Unit) (*Clazz, error)
}

type Clazz

type Clazz = object.Clazz

type ClazzFileResult

type ClazzFileResult = BaseFileResult[*Clazz]

type ClazzWithPath

type ClazzWithPath struct {
	*Clazz `bson:",inline"`
	Path   string `json:"path"`
}

type DataType

type DataType interface {
	GetIndexName() string // for query and locate from outside
	GetDesc() string      // easy to understand what it actually contains
	GetSpan() *core.Span
}

func DataTypeOf

func DataTypeOf[T DataType](dataList []T) []DataType

type DataTypes

type DataTypes = []DataType

type ExtractType

type ExtractType = string

const (
	TypeExtractFunction ExtractType = "func"
	TypeExtractSymbol   ExtractType = "symbol"
	TypeExtractCall     ExtractType = "call"
	TypeExtractClazz    ExtractType = "class"
)

these extractors are independent with each other

type Extractor

type Extractor interface {
	GetLang() core.LangType
	SymbolSupport
	FunctionSupport
	CallSupport
	ClassSupport
}

Extractor

in tree-sitter, a specific language is ruled by grammar.js. https://github.com/tree-sitter/tree-sitter-java/blob/master/grammar.js

unlike other projects, we will only keep the necessary parts, not the whole grammar rule

func GetExtractor

func GetExtractor(lang core.LangType) Extractor

type FileResult

type FileResult = BaseFileResult[DataType]

type Function

type Function = object.Function

type FunctionFileResult

type FunctionFileResult = BaseFileResult[*Function]

type FunctionSupport

type FunctionSupport interface {
	IsFunction(*core.Unit) bool
	ExtractFunctions([]*core.Unit) ([]*Function, error)
	ExtractFunction(*core.Unit) (*Function, error)
}

type FunctionWithPath

type FunctionWithPath struct {
	*Function `bson:",inline"`
	Path      string `json:"path" bson:"path"`
}

FunctionWithPath original symbol and function do not have a path because they maybe not come from a real file

func WrapFuncWithPath

func WrapFuncWithPath(f *Function, p string) *FunctionWithPath

func (*FunctionWithPath) GetDescWithPath

func (fwp *FunctionWithPath) GetDescWithPath() string

type Symbol

type Symbol = object.Symbol

type SymbolFileResult

type SymbolFileResult = BaseFileResult[*Symbol]

type SymbolSupport

type SymbolSupport interface {
	IsSymbol(*core.Unit) bool
	ExtractSymbols([]*core.Unit) ([]*Symbol, error)
}

type SymbolWithPath

type SymbolWithPath struct {
	*Symbol `bson:",inline"`
	Path    string `json:"path"`
}