typast

Documentation

Index

• func ParseRawAnnot(raw string) (tagName, tagAttrs string)
• func StructTag(tag *ast.BasicLit) reflect.StructTag
• type AnnotateProject
  • func (a *AnnotateProject) Execute(c *typgo.Context) error
  • func (a *AnnotateProject) Task() *typgo.Task
• type Annotation
  • func (a *Annotation) Annotate() Processor
  • func (a *Annotation) Process(c *typgo.Context, directives Directives) error
• type Annotator
• type Decl
• type Directive
  • func (d *Directive) Package() string
• type Directives
  • func (s *Directives) AddDecl(file File, declType Type)
• type Field
• type FieldList
• type File
• type FilePaths
  • func (f FilePaths) Walk() []string
• type Filter
• type Filters
  • func (f Filters) IsAllowed(d *Directive) bool
• type FuncDecl
  • func (f *FuncDecl) GetDocs() []string
  • func (f *FuncDecl) GetName() string
  • func (f *FuncDecl) IsMethod() bool
• type FuncFilter
  • func (*FuncFilter) IsAllowed(d *Directive) bool
• type GenDecl
• type ImportAliases
  • func NewImportAliases() *ImportAliases
  • func (i *ImportAliases) Append(pkg string) string
• type InterfaceDecl
• type InterfaceFilter
  • func (*InterfaceFilter) IsAllowed(d *Directive) bool
• type Layouts
  • func (l Layouts) Walk() []string
• type NewFilter
  • func (n NewFilter) IsAllowed(d *Directive) bool
• type NewProcessor
  • func (p NewProcessor) Process(c *typgo.Context, d Directives) error
• type Processor
• type PublicFilter
  • func (*PublicFilter) IsAllowed(d *Directive) bool
• type Signature
  • func (s Signature) String() string
• type StructDecl
• type StructFilter
  • func (*StructFilter) IsAllowed(d *Directive) bool
• type TagNameFilter
  • func (t TagNameFilter) IsAllowed(d *Directive) bool
• type Type
• type TypeDecl
  • func (t *TypeDecl) GetDocs() []string
  • func (t *TypeDecl) GetName() string
• type Walker

Functions

func ParseRawAnnot

func ParseRawAnnot(raw string) (tagName, tagAttrs string)

ParseRawAnnot parse raw string to annotation

func StructTag

func StructTag(tag *ast.BasicLit) reflect.StructTag

StructTag create struct tag

Types

type AnnotateProject

type AnnotateProject struct {
	Walker     Walker
	Annotators []Annotator
}

AnnotateProject task

func (*AnnotateProject) Execute

func (a *AnnotateProject) Execute(c *typgo.Context) error

Execute annotation

func (*AnnotateProject) Task

func (a *AnnotateProject) Task() *typgo.Task

Task to annotate

type Annotation

type Annotation struct {
	Filter    Filter
	Processor Processor
}

func (*Annotation) Annotate

func (a *Annotation) Annotate() Processor

func (*Annotation) Process

func (a *Annotation) Process(c *typgo.Context, directives Directives) error

type Annotator

type Annotator interface {
	Annotate() Processor
}

type Decl

type Decl struct {
	File
	Type
}

Decl stand of declaration

type Directive

type Directive struct {
	TagName  string            `json:"tag_name"`
	TagParam reflect.StructTag `json:"tag_param"`
	*Decl    `json:"decl"`
}

Directive that contain extra additional information

func (*Directive) Package

func (d *Directive) Package() string

Package of annotation

type Directives

type Directives []*Directive

func (*Directives) AddDecl

func (s *Directives) AddDecl(file File, declType Type)

AddDecl add declaration

type Field

type Field struct {
	Names []string
	Type  string
	reflect.StructTag
}

Field information

type FieldList

type FieldList struct {
	List []*Field
}

FieldList function parameter

type File

type File struct {
	Path    string
	Package string
}

File information

type FilePaths

type FilePaths []string

func (FilePaths) Walk

func (f FilePaths) Walk() []string

type Filter

type Filter interface {
	IsAllowed(d *Directive) bool
}

type Filters

type Filters []Filter

func (Filters) IsAllowed

func (f Filters) IsAllowed(d *Directive) bool

type FuncDecl

type FuncDecl struct {
	Name   string
	Docs   []string
	Recv   *FieldList
	Params *FieldList
}

FuncDecl function declaration

func (*FuncDecl) GetDocs

func (f *FuncDecl) GetDocs() []string

GetDocs comment documentation

func (*FuncDecl) GetName

func (f *FuncDecl) GetName() string

GetName of declaration

func (*FuncDecl) IsMethod

func (f *FuncDecl) IsMethod() bool

IsMethod return true if function is method (has receiver argument)

type FuncFilter

type FuncFilter struct{}

func (*FuncFilter) IsAllowed

func (*FuncFilter) IsAllowed(d *Directive) bool

type GenDecl

type GenDecl struct {
	Docs []string
}

GenDecl generic declaration

type ImportAliases

type ImportAliases struct {
	Map map[string]string // key is import package , value is import alias
	// contains filtered or unexported fields
}

ImportAliases ...

func NewImportAliases

func NewImportAliases() *ImportAliases

NewImportAliases return new constructor of ImportAliasess

func (*ImportAliases) Append

func (i *ImportAliases) Append(pkg string) string

Append package to map

type InterfaceDecl

type InterfaceDecl struct {
	TypeDecl
}

InterfaceDecl interface declaration

type InterfaceFilter

type InterfaceFilter struct{}

func (*InterfaceFilter) IsAllowed

func (*InterfaceFilter) IsAllowed(d *Directive) bool

type Layouts

type Layouts []string

func (Layouts) Walk

func (l Layouts) Walk() []string

type NewFilter

type NewFilter func(d *Directive) bool

func (NewFilter) IsAllowed

func (n NewFilter) IsAllowed(d *Directive) bool

type NewProcessor

type NewProcessor func(*typgo.Context, Directives) error

func (NewProcessor) Process

func (p NewProcessor) Process(c *typgo.Context, d Directives) error

type Processor

type Processor interface {
	Process(*typgo.Context, Directives) error
}

type PublicFilter

type PublicFilter struct{}

func (*PublicFilter) IsAllowed

func (*PublicFilter) IsAllowed(d *Directive) bool

type Signature

type Signature struct {
	TagName string
}

Signature for code generation by annotation

func (Signature) String

func (s Signature) String() string

type StructDecl

type StructDecl struct {
	TypeDecl
	Fields []*Field
}

StructDecl struct declaration

type StructFilter

type StructFilter struct{}

func (*StructFilter) IsAllowed

func (*StructFilter) IsAllowed(d *Directive) bool

type TagNameFilter

type TagNameFilter []string

func (TagNameFilter) IsAllowed

func (t TagNameFilter) IsAllowed(d *Directive) bool

type Type

type Type interface {
	GetName() string
	GetDocs() []string
}

Type declaratio type

type TypeDecl

type TypeDecl struct {
	GenDecl
	Name string
	Docs []string
}

TypeDecl type declaration

func (*TypeDecl) GetDocs

func (t *TypeDecl) GetDocs() []string

GetDocs get doc

func (*TypeDecl) GetName

func (t *TypeDecl) GetName() string

GetName get name

type Walker

type Walker interface {
	Walk() []string
}