grapher

Documentation

Overview

TODO(sqs): remove this file

Index

• Variables
• func NormalizeData(unitType, dir string, o *Output) error
• func PopulateImpliedFields(repo, commitID, unitType, unit string, o *Output)
• func Register(emptySourceUnit unit.SourceUnit, grapher Grapher)
• func UnresolvedInternalRefs(currentRepoURI string, refs []*graph.Ref, defs []*graph.Def) map[graph.DefKey][]*graph.Ref
• type GraphUnitRule
  • func (r *GraphUnitRule) Prereqs() []string
  • func (r *GraphUnitRule) Recipes() []string
  • func (r *GraphUnitRule) SourceUnit() *unit.SourceUnit
  • func (r *GraphUnitRule) Target() string
• type Grapher
• type MultiError
  • func ValidateDefs(defs []*graph.Def) (errs MultiError)
  • func ValidateRefs(refs []*graph.Ref) (errs MultiError)
  • func (e MultiError) Error() string
• type Output

Variables

var Graphers = make(map[reflect.Type]Grapher)

Graphers holds all registered graphers.

Functions

func NormalizeData

func NormalizeData(unitType, dir string, o *Output) error

NormalizeData sorts data and performs other postprocessing.

func PopulateImpliedFields

func PopulateImpliedFields(repo, commitID, unitType, unit string, o *Output)

PopulateImpliedFields fills in fields on graph data objects that individual toolchains leave blank but that are implied by the source unit the graph data objects were built from.

func Register

func Register(emptySourceUnit unit.SourceUnit, grapher Grapher)

Register sets the grapher to be used for source units of the given type. If Register is called twice with the same name or if grapher is nil, it panics

func UnresolvedInternalRefs

func UnresolvedInternalRefs(currentRepoURI string, refs []*graph.Ref, defs []*graph.Def) map[graph.DefKey][]*graph.Ref

UnresolvedInternalRefs returns a map of unresolved internal refs, keyed on the (nonexistent) defs they point to. CurrentRepoURI must be the repo URI of the repo the refs and defs were built from. It is used to determine whether a ref is an internal ref or not. Only internal refs can be checked in this way because checking resolution to external defs would require loading external data, which is outside the scope of this function.

Types

type GraphUnitRule

type GraphUnitRule struct {
	Unit *unit.SourceUnit
	Tool *srclib.ToolRef
	// contains filtered or unexported fields
}

func (*GraphUnitRule) Prereqs

func (r *GraphUnitRule) Prereqs() []string

func (*GraphUnitRule) Recipes

func (r *GraphUnitRule) Recipes() []string

func (*GraphUnitRule) SourceUnit

func (r *GraphUnitRule) SourceUnit() *unit.SourceUnit

func (*GraphUnitRule) Target

func (r *GraphUnitRule) Target() string

type Grapher

type Grapher interface {
	Graph(dir string, unit *unit.SourceUnit, c *config.Repository) (*Output, error)
}

type MultiError

type MultiError []error

func ValidateDefs

func ValidateDefs(defs []*graph.Def) (errs MultiError)

func ValidateRefs

func ValidateRefs(refs []*graph.Ref) (errs MultiError)

func (MultiError) Error

func (e MultiError) Error() string

type Output

type Output struct {
	Defs []*graph.Def `json:",omitempty"`
	Refs []*graph.Ref `json:",omitempty"`
	Docs []*graph.Doc `json:",omitempty"`
	Anns []*ann.Ann   `json:",omitempty"`
}

START Output OMIT Output is produced by grapher tools.