ssaviz

package

v0.0.0-...-c06eb33 Latest Latest Go to latest Published: Mar 29, 2023 License: Apache-2.0 Imports: 17 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package ssaviz helps user to visualize SSA function.

View Source

const (
	Prog    = "ssaviz"
	Version = "0.1.0"
	Author  = "Shengyu Zhang <silverrainz.me>"
	Desc    = "Visualize Go SSA function using Graphviz"
)

Package meta informations.

View Source

var (
	// Debug decides whether to output debug logs.
	Debug bool
)

This section is empty.

type Attr string

Attr is attribute of vertex and edge of Graphviz.

var (
	Fontame Attr = "Courier New"
)

type Format string

Format is file format of rendered graph.

const (
	DOT Format = "dot"
	SVG Format = "svg"
)

func (s Format) Ext() string

type Graph struct {
	Name string
	Kind Kind
	// contains filtered or unexported fields
}

func Build(kind Kind, f *ssa.Function) (*Graph, error)

Build builds a graph of specific Kind from SSA function.

func (g Graph) Render(format Format) ([]byte, error)

Render renders to specific format. See Format for available formats.

type HTML struct {
	// contains filtered or unexported fields
}

HTML is a HTML report that contains multiple [Graph]s.

func Render(graphs []*Graph) (*HTML, error)

Render renders multiple graphs to a single HTML documentation.

func (r *HTML) Save(path string) error

Save saves HTML report to given path.

func (r *HTML) View() error

View opens the HTML report in system default application.

NOTE: This function will leave a HTML file named "go-ssaviz-*.html" in the default temporary directory if the HTML has never been saved.

type Kind string

Kind is kind of graph.

const (
	CFG Kind = "Control Flow Graph"
)