grapher

package
v0.0.19 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 15, 2014 License: BSD-3-Clause, MIT Imports: 17 Imported by: 0

Documentation

Overview

TODO(sqs): remove this file

Index

Constants

This section is empty.

Variables

View Source
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 added in v0.0.7

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

func (*GraphUnitRule) Prereqs added in v0.0.7

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

func (*GraphUnitRule) Recipes added in v0.0.7

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

func (*GraphUnitRule) Target added in v0.0.7

func (r *GraphUnitRule) Target() string

type Grapher

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

type MultiError added in v0.0.16

type MultiError []error

func ValidateRefs added in v0.0.16

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

func (MultiError) Error added in v0.0.16

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).

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL