codegen

Documentation

Index

• type Generator
  • func NewGenerator(options Options) (*Generator, error)
  • func (g Generator) Generate(w io.Writer) error
• type Method
  • func NewMethod(name string, fi *ast.Field, printer typePrinter, genericTypes genericTypes, ...) (*Method, error)
  • func (m Method) Call() string
  • func (m Method) Declaration() string
  • func (m Method) HasParams() bool
  • func (m Method) HasResults() bool
  • func (m Method) ParamPtrsStruct() string
  • func (m Method) ParamsMap() string
  • func (m Method) ParamsNames() string
  • func (m Method) ParamsStruct() string
  • func (m Method) Pass(prefix string) string
  • func (m Method) ResultsMap() string
  • func (m Method) ResultsNames() string
  • func (m Method) ResultsStruct() string
  • func (m Method) ReturnStruct(structName string) string
  • func (m Method) Signature() string
• type Options
• type PackageCache
  • func NewPackageCache() *PackageCache
  • func (c *PackageCache) Seed(pkgs map[string]*packages.Package)
• type Param
  • func NewParam(name string, fi *ast.Field, usedNames map[string]bool, printer typePrinter, ...) (*Param, error)
  • func (p Param) Pass() string
• type ParamsSlice
  • func (ps ParamsSlice) Pass() string
  • func (ps ParamsSlice) String() string
• type TemplateInputGenerics
• type TemplateInputInterface
• type TemplateInputs
  • func (t TemplateInputs) Import(imports ...string) string

Types

type Generator

type Generator struct {
	Options
	// contains filtered or unexported fields
}

Generator generates decorators for the interface types

func NewGenerator

func NewGenerator(options Options) (*Generator, error)

NewGenerator returns Generator initialized with options

func (Generator) Generate

func (g Generator) Generate(w io.Writer) error

Generate generates code using header and body templates

type Method

type Method struct {
	Doc     []string
	Comment []string
	Name    string
	Params  ParamsSlice
	Results ParamsSlice

	ReturnsError   bool
	AcceptsContext bool
}

Method represents a method's signature

func NewMethod

func NewMethod(name string, fi *ast.Field, printer typePrinter, genericTypes genericTypes, genericParams genericParams) (*Method, error)

NewMethod returns pointer to Signature struct or error

func (Method) Call

func (m Method) Call() string

Call returns a string with the method call

func (Method) Declaration

func (m Method) Declaration() string

Declaration returns a method name followed by it's signature

func (Method) HasParams

func (m Method) HasParams() bool

HasParams returns true if method has params

func (Method) HasResults

func (m Method) HasResults() bool

HasResults returns true if method has results

func (Method) ParamPtrsStruct

func (m Method) ParamPtrsStruct() string

ParamPtrsStruct returns a struct type with pointer fields corresponding to the method params

func (Method) ParamsMap

func (m Method) ParamsMap() string

ParamsMap returns a string representation of the map[string]interface{} filled with method's params

func (Method) ParamsNames

func (m Method) ParamsNames() string

ParamsNames returns a list of method params names

func (Method) ParamsStruct

func (m Method) ParamsStruct() string

ParamsStruct returns a struct type with fields corresponding to the method params

func (Method) Pass

func (m Method) Pass(prefix string) string

Pass returns a return statement followed by the method call

func (Method) ResultsMap

func (m Method) ResultsMap() string

ResultsMap returns a string representation of the map[string]interface{} filled with method's results

func (Method) ResultsNames

func (m Method) ResultsNames() string

ResultsNames returns a list of method results names

func (Method) ResultsStruct

func (m Method) ResultsStruct() string

ResultsStruct returns a struct type with fields corresponding to the method results

func (Method) ReturnStruct

func (m Method) ReturnStruct(structName string) string

ReturnStruct returns return statement with the return params taken from the structName

func (Method) Signature

func (m Method) Signature() string

Signature returns comma separated method's params followed by the comma separated method's results

type Options

type Options struct {
	InterfaceName              string
	Imports                    []string
	SourcePackage              string
	SourcePackageInstance      *packages.Package
	SourcePackageAST           *scanner.Package
	SourcePackageAlias         string
	OutputFile                 string
	DestinationPackageInstance *packages.Package
	HeaderTemplate             string
	BodyTemplate               string
	Vars                       map[string]interface{}
	HeaderVars                 map[string]interface{}
	Funcs                      template.FuncMap
	LocalPrefix                string
	SkipImportsProcessing      bool
	HeaderTemplateParsed       *template.Template
	BodyTemplateParsed         *template.Template
	FileSet                    *token.FileSet
	PackageCache               *PackageCache
}

Options of the NewGenerator constructor

type PackageCache

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

PackageCache caches loaded packages and parsed ASTs to avoid redundant work when multiple interfaces reference the same external packages. All methods are safe for concurrent use by multiple goroutines.

func NewPackageCache

func NewPackageCache() *PackageCache

NewPackageCache returns an empty PackageCache.

func (*PackageCache) Seed

func (c *PackageCache) Seed(pkgs map[string]*packages.Package)

Seed pre-populates the cache with already-loaded packages (e.g. from batch loading).

type Param

type Param struct {
	Doc      []string
	Comment  []string
	Name     string
	Type     string
	Variadic bool
}

Param represents fuction argument or result

func NewParam

func NewParam(name string, fi *ast.Field, usedNames map[string]bool, printer typePrinter, genericTypes genericTypes, genericParams genericParams) (*Param, error)

NewParam returns Param struct

func (Param) Pass

func (p Param) Pass() string

Pass returns a name of the parameter If parameter is variadic it returns a name followed by a ...

type ParamsSlice

type ParamsSlice []Param

ParamsSlice slice of parameters

func (ParamsSlice) Pass

func (ps ParamsSlice) Pass() string

Pass returns comma separated params names to be passed to a function call with respect to variadic functions

func (ParamsSlice) String

func (ps ParamsSlice) String() string

String implements fmt.Stringer

type TemplateInputGenerics

type TemplateInputGenerics struct {
	Types  string
	Params string
}

TemplateInputGenerics subset of generics interface information used for template generation

type TemplateInputInterface

type TemplateInputInterface struct {
	Name     string
	Type     string
	Generics TemplateInputGenerics
	Methods  map[string]Method
}

TemplateInputInterface subset of interface information used for template generation

type TemplateInputs

type TemplateInputs struct {
	Interface TemplateInputInterface
	Vars      map[string]interface{}
	Imports   []string
}

TemplateInputs information passed to template for generation

func (TemplateInputs) Import

func (t TemplateInputs) Import(imports ...string) string

Import generates an import statement using a list of imports from the source file along with the ones from the template itself