core

type Analyzer interface {
	Analyze() (*Results, error)
	RootPath() string

	AddDefinition(definition *definitions.Definition)
	RegisterStatAccumulator(statType string, merger StatAccumulatorFunction)
	RegisterView(viewFactory *ViewFactory)
	RegisterFileAnalyzer(analyzer FileAnalyzer)
	RegisterFileResultsEditor(editor FileResultsEditor)
	RegisterResultsEditor(editor ResultsEditor)
}

type Column struct {
	Name string
	Type ColumnType
}

type ColumnType int

type Config struct {
	// RootPath is the path to the root directory of the codebase to analyze. If not specified, the current working directory is used.
	RootPath string
	// Extensions are the extensions to use for the analysis.
	Extensions []Extension
}

type Extension interface {
	Init(settings Analyzer) error
}

type FileAnalyzer interface {
	AnalyzeFile(file.File) *file.Results
}

type FileResultsEditor interface {
	EditFileResults(all []*file.Results)
}

type Results struct {
	RootDirectory string

	Snippets            []*file.Snippet
	SnippetsByFile      file.SnippetGroup
	SnippetsByDirectory file.SnippetGroup
	SnippetsByComponent file.SnippetGroup
	SnippetsByType      file.SnippetGroup

	Stats            *file.Stats
	StatsByFile      file.StatsGroup
	StatsByDirectory file.StatsGroup
	StatsByComponent file.StatsGroup

	Connections     []*component.Connection
	ConnectionsFrom map[string][]*component.Connection
	ConnectionsTo   map[string][]*component.Connection

	FileToComponent map[string]string
	FileToDirectory map[string]string

	ComponentToFiles map[string][]string
	DirectoryToFiles map[string][]string

	ComponentGraph *component.Graph

	Views []*View
	// contains filtered or unexported fields
}

type ResultsEditor interface {
	EditResults(results *Results)
}

type Row struct {
	Data RowData
}

type RowData map[string]interface{}

type StatAccumulatorFunction func(statsToMerge []interface{}) interface{}

type View struct {
	Name    string
	Columns []*Column
	Rows    []*Row
}

type ViewFactory struct {
	Name           string
	CreateViewFunc ViewFactoryFunction
}

type ViewFactoryFunction func(results *Results) *View