grapher

Documentation

Overview

TODO(sqs): remove this file

Index

• Variables
• func NormalizeData(o *Output) error
• func Register(emptySourceUnit unit.SourceUnit, grapher Grapher)
• type GraphUnitRule
  • func (r *GraphUnitRule) Prereqs() []string
  • func (r *GraphUnitRule) Recipes() []string
  • func (r *GraphUnitRule) Target() string
• type Grapher
• type MultiError
  • func ValidateRefs(refs []*graph.Ref) (errs MultiError)
  • func (e MultiError) Error() string
• type Output
  • func Graph(dir string, u *unit.SourceUnit, c *config.Repository) (*Output, error)

Variables

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

Graphers holds all registered graphers.

Functions

func NormalizeData

func NormalizeData(o *Output) error

NormalizeData sorts data.

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

Types

type GraphUnitRule

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

func (*GraphUnitRule) Prereqs

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

func (*GraphUnitRule) Recipes

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

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 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"`
}

START Output OMIT Output is produced by grapher tools.

func Graph

func Graph(dir string, u *unit.SourceUnit, c *config.Repository) (*Output, error)

Graph uses the registered grapher (if any) to graph the source unit (whose repository is cloned to dir).