decorator

Documentation

Index

• func Decorate(fset *token.FileSet, n ast.Node) (dst.Node, error)
• func DecorateFile(fset *token.FileSet, f *ast.File) (*dst.File, error)
• func Fprint(w io.Writer, f *dst.File) error
• func Parse(src interface{}) (*dst.File, error)
• func ParseDir(fset *token.FileSet, dir string, filter func(os.FileInfo) bool, ...) (map[string]*dst.Package, error)
• func ParseFile(fset *token.FileSet, filename string, src interface{}, mode parser.Mode) (*dst.File, error)
• func Print(f *dst.File) error
• func RestoreFile(file *dst.File) (*token.FileSet, *ast.File, error)
• type AstMap
• type Decorator
  • func NewDecorator(fset *token.FileSet) *Decorator
  • func NewDecoratorFromPackage(pkg *packages.Package) *Decorator
  • func NewDecoratorWithImports(fset *token.FileSet, path string, resolver resolver.DecoratorResolver) *Decorator
  • func (d *Decorator) DecorateFile(f *ast.File) (*dst.File, error)
  • func (d *Decorator) DecorateNode(n ast.Node) (dst.Node, error)
  • func (d *Decorator) Parse(src interface{}) (*dst.File, error)
  • func (d *Decorator) ParseDir(dir string, filter func(os.FileInfo) bool, mode parser.Mode) (map[string]*dst.Package, error)
  • func (d *Decorator) ParseFile(filename string, src interface{}, mode parser.Mode) (*dst.File, error)
• type DstMap
• type FileRestorer
  • func (r *FileRestorer) Fprint(w io.Writer, f *dst.File) error
  • func (r *FileRestorer) Print(f *dst.File) error
  • func (r *FileRestorer) RestoreFile(file *dst.File) (*ast.File, error)
• type Map
• type Package
  • func Load(cfg *packages.Config, patterns ...string) ([]*Package, error)
  • func (p *Package) Save() error
  • func (p *Package) SaveWithResolver(resolver resolver.RestorerResolver) error
• type Restorer
  • func NewRestorer() *Restorer
  • func NewRestorerWithImports(path string, resolver resolver.RestorerResolver) *Restorer
  • func (pr *Restorer) FileRestorer() *FileRestorer
  • func (pr *Restorer) Fprint(w io.Writer, f *dst.File) error
  • func (pr *Restorer) Print(f *dst.File) error
  • func (pr *Restorer) RestoreFile(file *dst.File) (*ast.File, error)

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

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

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

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

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

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

type Decorator struct {
	Map                            // Mapping between ast and dst Nodes, Objects and Scopes
	Filenames map[*dst.File]string // Source file names
	Fset      *token.FileSet       // The ast FileSet containing ast decoration info for the files

	// 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
	// By default local idents are left with an empty Path, so they stay local if the local package
	// is renamed. Setting ResolveLocalPath to true prevents this, so all idents will have the
	// package path added.
	ResolveLocalPath bool
}

Decorator converts ast nodes into dst nodes, and converts decoration info from the ast fileset to the dst nodes. Create a new Decorator for each package you need to decorate.

func NewDecorator

func NewDecorator(fset *token.FileSet) *Decorator

NewDecorator returns a new decorator. If fset is nil, a new FileSet is created.

func NewDecoratorFromPackage

func NewDecoratorFromPackage(pkg *packages.Package) *Decorator

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

func NewDecoratorWithImports

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

NewDecoratorWithImports returns a new decorator with import management enabled.

func (*Decorator) DecorateFile

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

DecorateFile decorates *ast.File and returns *dst.File

func (*Decorator) DecorateNode

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

DecorateNode decorates ast.Node and returns dst.Node

func (*Decorator) Parse

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

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

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

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

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
}

FileRestorer restores a specific file with extra options

func (*FileRestorer) Fprint

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

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

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

func (*FileRestorer) RestoreFile

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

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

type Map

type Map struct {
	Ast AstMap
	Dst DstMap
}

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

type Package

type Package struct {
	*packages.Package
	Dir       string
	Decorator *Decorator
	Imports   map[string]*Package
	Syntax    []*dst.File
}

func Load

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

func (*Package) Save

func (p *Package) Save() error

func (*Package) SaveWithResolver

func (p *Package) SaveWithResolver(resolver resolver.RestorerResolver) error

type Restorer

type Restorer struct {
	Map
	Fset   *token.FileSet // Fset is the *token.FileSet in use. Set this to use a pre-existing FileSet.
	Extras bool           // Resore Objects, Scopes etc. Not needed for printing the resultant AST. If set to true, Objects and Scopes must be carefully managed to avoid duplicate nodes.

	// 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
}

Restorer restores dst.Node to ast.Node

func NewRestorer

func NewRestorer() *Restorer

NewRestorer returns a restorer.

func NewRestorerWithImports

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

NewRestorerWithImports returns a restorer with import management attributes set.

func (*Restorer) FileRestorer

func (pr *Restorer) FileRestorer() *FileRestorer

FileRestorer restores a specific file with extra options

func (*Restorer) Fprint

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

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

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

func (*Restorer) RestoreFile

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

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