code

type CodeGraphBuilderConfig struct {
	// Resolve imports to file and load them
	RecursiveImport bool

	// Code analyser concurrency
	Concurrency int
}

type CodeGraphBuilderEvent struct {
	Kind string
	Data interface{}
}

type CodeGraphBuilderEventHandler func(CodeGraphBuilderEvent, CodeGraphBuilderMetrics) error

type CodeGraphBuilderMetrics struct {
	GoRoutineCount int
	ErrorCount     int
	FilesProcessed int
	FilesInQueue   int
	ImportsCount   int
	FunctionsCount int
}

type FileSystemSourceRepositoryConfig struct {
	// List of paths to search for source code
	SourcePaths []string

	// Glob patterns to exclude from source code search
	ExcludedGlobs []string

	// Glob patterns to include in source code search
	IncludedGlobs []string

	// List of paths to search for imported source code
	ImportPaths []string
}

type SourceFile struct {
	// Identifier for the source file. This is dependent on the
	// language on how to uniquely identify a source file
	Id string

	// Repository specific path to the file
	Path string
	// contains filtered or unexported fields
}

type SourceLanguage interface {
	// Get metadata for the source language
	GetMeta() SourceLanguageMeta

	// Parse a source file and return the CST (tree-sitter concrete syntax tree)
	ParseSource(file SourceFile) (*nodes.CST, error)

	// Get import nodes from the CST
	GetImportNodes(cst *nodes.CST) ([]nodes.CSTImportNode, error)

	// Get function declaration nodes from the CST
	GetFunctionDeclarationNodes(cst *nodes.CST) ([]nodes.CSTFunctionNode, error)

	// Get function call nodes from the CST
	GetFunctionCallNodes(cst *nodes.CST) ([]nodes.CSTFunctionCallNode, error)

	// Resolve the import module / package name from relative path
	ResolveImportNameFromPath(relPath string) (string, error)

	// Resolve import name to possible relative file names
	// Multiple paths are possible because an import such
	// as a.b can resolve to a/b.py or a/b/__init__.py depending
	// on language and file system
	ResolveImportPathsFromName(currentFile SourceFile, importName string, includeImports bool) ([]string, error)
}

type SourceLanguageMeta struct {
	SourceFileGlobs []string
}

type SourceRepository interface {
	// Name of the repository
	Name() string

	// Enumerate all source files in the repository. This can be multiple
	// directories for a local source repository
	EnumerateSourceFiles(handler sourceFileHandlerFn) error

	// Get a source file by path. This function enumerates all directories
	// available in the repository to check for existence of the source file by path
	GetSourceFileByPath(path string, includeImports bool) (SourceFile, error)

	// Open a source file for reading
	OpenSourceFile(file SourceFile) (io.ReadCloser, error)

	// Configure the repository for a source language
	ConfigureForLanguage(language SourceLanguage)

	// Get relative path of the source file from the repository root
	// This is useful for constructing the import path. The first match is returned
	GetRelativePath(path string, includeImport bool) (string, error)
}