decorator

package
v0.16.0 Latest Latest
Warning

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

Go to latest
Published: Nov 28, 2018 License: MIT Imports: 19 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Decorate

func Decorate(fset *token.FileSet, n ast.Node) (dst.Node, error)

Decorate decorates an ast.Node and returns a dst.Node.

func DecorateFile added in v0.1.0

func DecorateFile(fset *token.FileSet, f *ast.File) (*dst.File, error)

Decorate decorates a *ast.File and returns a *dst.File.

func Fprint

func Fprint(w io.Writer, f *dst.File) error

Fprint uses format.Node to print a *dst.File to a writer

func Parse

func Parse(src interface{}) (*dst.File, error)

Parse uses parser.ParseFile to parse and decorate a Go source file. The src parameter should be string, []byte, or io.Reader.

func ParseDir added in v0.1.0

func ParseDir(fset *token.FileSet, dir string, filter func(os.FileInfo) bool, mode parser.Mode) (map[string]*dst.Package, error)

ParseDir uses parser.ParseDir to parse and decorate a directory containing Go source. The ParseComments flag is added to mode if it doesn't exist.

func ParseFile added in v0.1.0

func ParseFile(fset *token.FileSet, filename string, src interface{}, mode parser.Mode) (*dst.File, error)

ParseFile uses parser.ParseFile to parse and decorate a Go source file. The ParseComments flag is added to mode if it doesn't exist.

func Print

func Print(f *dst.File) error

Print uses format.Node to print a *dst.File to stdout

func RestoreFile added in v0.16.0

func RestoreFile(file *dst.File) (*token.FileSet, *ast.File, error)

RestoreFile restores a *dst.File to a *token.FileSet and a *ast.File

Types

type AstMap added in v0.9.0

type AstMap struct {
	Nodes   map[dst.Node]ast.Node       // Mapping from dst to ast Nodes
	Objects map[*dst.Object]*ast.Object // Mapping from dst to ast Objects
	Scopes  map[*dst.Scope]*ast.Scope   // Mapping from dst to ast Scopes
}

AstMap holds a record of the mapping from dst to ast nodes, objects and scopes.

type Decorator added in v0.1.0

type Decorator struct {
	Map
	Filenames map[*dst.File]string // Source file names
	Fset      *token.FileSet

	// If a Resolver is provided, it is used to resolve remote identifiers from *ast.Ident and
	// *ast.SelectorExpr nodes. Usually a remote identifier is a SelectorExpr qualified identifier,
	// but in the case of dot-imports they can be simply Ident nodes. During decoration, remote
	// identifiers are replaced with *dst.Ident with Path set to the path of imported package.
	Resolver resolver.DecoratorResolver
	// Local package path - required if Resolver is set.
	Path string
}

func NewDecorator added in v0.16.0

func NewDecorator(fset *token.FileSet) *Decorator

NewDecorator returns a new decorator.

func NewDecoratorFromPackage added in v0.16.0

func NewDecoratorFromPackage(pkg *packages.Package) *Decorator

NewDecoratorFromPackage returns a new decorator configured to decorate files in pkg.

func NewDecoratorWithImports added in v0.16.0

func NewDecoratorWithImports(fset *token.FileSet, path string, resolver resolver.DecoratorResolver) *Decorator

NewDecoratorWithImports returns a new decorator with import management enabled.

func (*Decorator) DecorateFile added in v0.11.0

func (d *Decorator) DecorateFile(f *ast.File) (*dst.File, error)

func (*Decorator) DecorateNode added in v0.11.0

func (d *Decorator) DecorateNode(n ast.Node) (dst.Node, error)

Decorate decorates an ast.Node and returns a dst.Node

func (*Decorator) Parse added in v0.12.2

func (d *Decorator) Parse(src interface{}) (*dst.File, error)

Parse uses parser.ParseFile to parse and decorate a Go source file. The src parameter should be string, []byte, or io.Reader.

func (*Decorator) ParseDir added in v0.12.2

func (d *Decorator) ParseDir(dir string, filter func(os.FileInfo) bool, mode parser.Mode) (map[string]*dst.Package, error)

ParseDir uses parser.ParseDir to parse and decorate a directory containing Go source. The ParseComments flag is added to mode if it doesn't exist.

func (*Decorator) ParseFile added in v0.12.2

func (d *Decorator) ParseFile(filename string, src interface{}, mode parser.Mode) (*dst.File, error)

ParseFile uses parser.ParseFile to parse and decorate a Go source file. The ParseComments flag is added to mode if it doesn't exist.

type DstMap added in v0.9.0

type DstMap struct {
	Nodes   map[ast.Node]dst.Node       // Mapping from ast to dst Nodes
	Objects map[*ast.Object]*dst.Object // Mapping from ast to dst Objects
	Scopes  map[*ast.Scope]*dst.Scope   // Mapping from ast to dst Scopes
}

DstMap holds a record of the mapping from ast to dst nodes, objects and scopes.

type FileRestorer added in v0.11.0

type FileRestorer struct {
	*Restorer
	Alias map[string]string // Map of package path -> package alias for imports
	Name  string            // The name of the restored file in the FileSet. Can usually be left empty.
	// contains filtered or unexported fields
}

func (*FileRestorer) Fprint added in v0.16.0

func (r *FileRestorer) Fprint(w io.Writer, f *dst.File) error

Fprint uses format.Node to print a *dst.File to a writer

func (*FileRestorer) Print added in v0.16.0

func (r *FileRestorer) Print(f *dst.File) error

Print uses format.Node to print a *dst.File to stdout

func (*FileRestorer) RestoreFile added in v0.16.0

func (r *FileRestorer) RestoreFile(file *dst.File) (*ast.File, error)

RestoreFile restores a *dst.File to *ast.File

type Map added in v0.9.0

type Map struct {
	Ast AstMap
	Dst DstMap
}

Map holds a record of the mapping between ast and dst nodes, objects and scopes.

type Package added in v0.11.0

type Package struct {
	*packages.Package
	Dir       string
	Decorator *Decorator
	Files     []*dst.File
}

func Load added in v0.11.0

func Load(cfg *packages.Config, patterns ...string) ([]*Package, error)

func (*Package) Save added in v0.11.0

func (p *Package) Save() error

type Restorer added in v0.1.0

type Restorer struct {
	Map
	Fset *token.FileSet // Fset is the *token.FileSet in use. Set this to use a pre-existing FileSet.

	// If a Resolver is provided, the names of all imported packages are resolved, and the imports
	// block is updated. All remote identifiers are updated (sometimes this involves changing
	// SelectorExpr.X.Name, or even swapping between Ident and SelectorExpr). To force specific
	// import alias names, use the FileRestorer.Alias map.
	Resolver resolver.RestorerResolver
	// Local package path - required if Resolver is set.
	Path string
}

func NewRestorer added in v0.1.0

func NewRestorer() *Restorer

NewRestorer returns a restorer.

func NewRestorerWithImports added in v0.11.0

func NewRestorerWithImports(path string, resolver resolver.RestorerResolver) *Restorer

NewRestorerWithImports returns a restorer with import management attributes set.

func (*Restorer) FileRestorer added in v0.11.0

func (pr *Restorer) FileRestorer() *FileRestorer

func (*Restorer) Fprint added in v0.11.0

func (pr *Restorer) Fprint(w io.Writer, f *dst.File) error

Fprint uses format.Node to print a *dst.File to a writer

func (*Restorer) Print added in v0.11.0

func (pr *Restorer) Print(f *dst.File) error

Print uses format.Node to print a *dst.File to stdout

func (*Restorer) RestoreFile added in v0.1.0

func (pr *Restorer) RestoreFile(file *dst.File) (*ast.File, error)

RestoreFile restores a *dst.File to an *ast.File

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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