annotators

Documentation

Overview

This file contains an example annotator that attaches metadata to Bad nodes The metadata is a simple counter that is attached to each Bad node

All the functionality in this file is for demonstration purposes only

Index

• Constants
• type BadAnnotator
  • func (a *BadAnnotator) VisitBadDecl(b *ast.BadDecl) ast.VisitResult
  • func (a *BadAnnotator) VisitBadExpr(b *ast.BadExpr) ast.VisitResult
  • func (a *BadAnnotator) VisitBadStmt(b *ast.BadStmt) ast.VisitResult
• type BadMeta
  • func (m *BadMeta) Kind() ast.MetadataKind
  • func (m *BadMeta) String() string
• type ConstFuncParamAnnotator
  • func (a *ConstFuncParamAnnotator) ShouldVisit(node ast.Node) bool
  • func (a *ConstFuncParamAnnotator) VisitAssignStmt(stmt *ast.AssignStmt) ast.VisitResult
  • func (a *ConstFuncParamAnnotator) VisitFuncCall(call *ast.FuncCall) ast.VisitResult
  • func (a *ConstFuncParamAnnotator) VisitFuncDecl(decl *ast.FuncDecl) ast.VisitResult
• type ConstFuncParamMeta
  • func (m ConstFuncParamMeta) Kind() ast.MetadataKind
  • func (m ConstFuncParamMeta) String() string

Constants

const ConstFuncParamMetaKind ast.MetadataKind = "ConstFuncParam"

Types

type BadAnnotator

type BadAnnotator struct {
	ast.BaseVisitor // provides useful utilities, like getting the current module
	// contains filtered or unexported fields
}

example annotator

func (*BadAnnotator) VisitBadDecl

func (a *BadAnnotator) VisitBadDecl(b *ast.BadDecl) ast.VisitResult

func (*BadAnnotator) VisitBadExpr

func (a *BadAnnotator) VisitBadExpr(b *ast.BadExpr) ast.VisitResult

func (*BadAnnotator) VisitBadStmt

func (a *BadAnnotator) VisitBadStmt(b *ast.BadStmt) ast.VisitResult

type BadMeta

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

example metadata

func (*BadMeta) Kind

func (m *BadMeta) Kind() ast.MetadataKind

func (*BadMeta) String

func (m *BadMeta) String() string

type ConstFuncParamAnnotator

type ConstFuncParamAnnotator struct {
	ast.BaseVisitor
	// contains filtered or unexported fields
}

func (*ConstFuncParamAnnotator) ShouldVisit

func (a *ConstFuncParamAnnotator) ShouldVisit(node ast.Node) bool

func (*ConstFuncParamAnnotator) VisitAssignStmt

func (a *ConstFuncParamAnnotator) VisitAssignStmt(stmt *ast.AssignStmt) ast.VisitResult

func (*ConstFuncParamAnnotator) VisitFuncCall

func (a *ConstFuncParamAnnotator) VisitFuncCall(call *ast.FuncCall) ast.VisitResult

func (*ConstFuncParamAnnotator) VisitFuncDecl

func (a *ConstFuncParamAnnotator) VisitFuncDecl(decl *ast.FuncDecl) ast.VisitResult

type ConstFuncParamMeta

type ConstFuncParamMeta struct {
	// wether each parameter is const
	IsConst map[string]bool
}

func (ConstFuncParamMeta) Kind

func (m ConstFuncParamMeta) Kind() ast.MetadataKind

func (ConstFuncParamMeta) String

func (m ConstFuncParamMeta) String() string