internal

Documentation

Index

• type Layout
• type PackageLoaderFunc
• type Packagist
  • func (p *Packagist) Inspect(patterns ...string) (TypeMap, error)
• type PathFilterFunc
  • func CreatePathFilterFunc(include, exclude []string) PathFilterFunc
• type PathMap
• type PathReplaceFunc
  • func CreatePathReplaceFunc(list []string) PathReplaceFunc
• type QualifierFunc
• type TreeWalk
  • func (t *TreeWalk) Walk(m PathMap) error
• type TypeMap

Types

type Layout

type Layout interface {
	Enter(path string, last bool)
	Print(line string, first, last bool)
	Leave(path string, last bool)
}

The Layout interface shapes a type visitor.

type PackageLoaderFunc

type PackageLoaderFunc func(*packages.Config, ...string) ([]*packages.Package, error)

PackageLoaderFunc returns the Go packages named by the given patterns.

type Packagist

type Packagist struct {
	PackageLoaderFunc PackageLoaderFunc
	PathFilterFunc    PathFilterFunc

	IncludeUnexported bool
	IncludeTestFiles  bool
	// contains filtered or unexported fields
}

Packagist carries inspection meta data.

func (*Packagist) Inspect

func (p *Packagist) Inspect(patterns ...string) (TypeMap, error)

Inspect finds matching types in the packages named by the given patterns.

type PathFilterFunc

type PathFilterFunc func(string) bool

PathFilterFunc is a simple string filtering/matching function.

func CreatePathFilterFunc

func CreatePathFilterFunc(include, exclude []string) PathFilterFunc

CreatePathFilterFunc gets a list of text patterns which are converted to regular expressions. The result of this function is a PathFilterFunc which can be used as a filter for matching patterns against strings.

type PathMap

type PathMap map[string]string

PathMap carries the mapping between the fully qualified import paths and their type projections.

type PathReplaceFunc

type PathReplaceFunc func(string) string

PathReplaceFunc is a simple string replacement function.

func CreatePathReplaceFunc

func CreatePathReplaceFunc(list []string) PathReplaceFunc

CreatePathReplaceFunc returns the default path and name relocation function. The result is basically sanitized but bad input will lead to bad output.

type QualifierFunc

type QualifierFunc func(p types.Package) string

QualifierFunc returns the type qualifier (path) of a package.

type TreeWalk

type TreeWalk struct {
	Layout
	// contains filtered or unexported fields
}

TreeWalk knows about Layout.

func (*TreeWalk) Walk

func (t *TreeWalk) Walk(m PathMap) error

Walk traverses a PathMap according to the paths.

type TypeMap

type TypeMap map[string]types.Type

TypeMap is a set of types indexed by their package import paths.