parse

Documentation

Index

• Variables
• type Adj
• type AstSchema
  • func Parse(pathDir string, skipDirs []string) (AstSchema, error)
• type Graph
  • func NewGraph() *Graph
  • func (g *Graph) AddEdge(from *Node, to *Adj)
  • func (g *Graph) AddNode(node *Node)
  • func (g *Graph) GetAdjacenciesSortedByName(node *Node) []*Adj
  • func (g *Graph) GetAdjacency(node *Node) []*Adj
  • func (g *Graph) GetLeafNodes() []*Node
  • func (g *Graph) GetNodeByName(name string) *Node
  • func (g *Graph) GetNodesSortedByName() []*Node
  • func (g *Graph) TopologicalSort() []*Node
• type Node
  • func (n *Node) MergeAdditionalFields(other *Node)

Variables

var ErrGoModNotFound = errors.New("go mod not found")

Types

type Adj

type Adj struct {
	Node *Node
	Func []string
}

type AstSchema

type AstSchema struct {
	ModulePath string
	Graph      *Graph
}

AstSchema is a simpler presentation of the ast of a project.

func Parse

func Parse(pathDir string, skipDirs []string) (AstSchema, error)

Parse parses the project located under pathDir and returns an AstSchema.

type Graph

type Graph struct {
	Nodes          []*Node            // A slice of pointers to all the nodes in the graph
	Adj            map[*Node][]*Adj   // An adjacency list mapping each node to its adjacent nodes
	NodeByName     map[string]*Node   // A hash map to store nodes by their names
	NodesByPackage map[string][]*Node // A hash map to store nodes by their packages
}

Graph represents the dependency graph.

func NewGraph

func NewGraph() *Graph

func (*Graph) AddEdge

func (g *Graph) AddEdge(from *Node, to *Adj)

AddEdge adds a directed edge between two nodes in the graph.

func (*Graph) AddNode

func (g *Graph) AddNode(node *Node)

AddNode adds a new Node to the graph.

func (*Graph) GetAdjacenciesSortedByName

func (g *Graph) GetAdjacenciesSortedByName(node *Node) []*Adj

GetAdjacenciesSortedByName returns the adjacencies sorted by the adjacent node names.

func (*Graph) GetAdjacency

func (g *Graph) GetAdjacency(node *Node) []*Adj

func (*Graph) GetLeafNodes

func (g *Graph) GetLeafNodes() []*Node

GetLeafNodes returns all the leaf nodes. A leaf node is a node without any inbound nodes.

func (*Graph) GetNodeByName

func (g *Graph) GetNodeByName(name string) *Node

GetNodeByName finds a node by its name in the graph.

func (*Graph) GetNodesSortedByName

func (g *Graph) GetNodesSortedByName() []*Node

GetNodesSortedByName returns all nodes sorted by node name.

func (*Graph) TopologicalSort

func (g *Graph) TopologicalSort() []*Node

TopologicalSort performs a topological sort on the graph.

type Node

type Node struct {
	Name            string // The fully qualified name of the struct, PackageName.StructName
	PackageName     string
	StructName      string
	Methods         []struct_decl.Method
	Doc             string
	External        bool
	InboundEdges    []*Node
	ActualNamedType *types.Named
	P               *packages.Package
	FilePath        string
}

Node represents a node of the dependency graph.

func (*Node) MergeAdditionalFields

func (n *Node) MergeAdditionalFields(other *Node)