package rule import ( "bytes" "fmt" "go/ast" "go/printer" "go/token" "regexp" "github.com/mgechev/revive/lint" ) func isCgoExported(f *ast.FuncDecl) bool { if f.Recv != nil || f.Doc == nil { return false } cgoExport := regexp.MustCompile(fmt.Sprintf("(?m)^//export %s$", regexp.QuoteMeta(f.Name.Name))) for _, c := range f.Doc.List { if cgoExport.MatchString(c.Text) { return true } } return false } func isIdent(expr ast.Expr, ident string) bool { id, ok := expr.(*ast.Ident) return ok && id.Name == ident } // isPkgDot checks if the expression is . func isPkgDot(expr ast.Expr, pkg, name string) bool { sel, ok := expr.(*ast.SelectorExpr) return ok && isIdent(sel.X, pkg) && isIdent(sel.Sel, name) } func srcLine(src []byte, p token.Position) string { // Run to end of line in both directions if not at line start/end. lo, hi := p.Offset, p.Offset+1 for lo > 0 && src[lo-1] != '\n' { lo-- } for hi < len(src) && src[hi-1] != '\n' { hi++ } return string(src[lo:hi]) } // pick yields a list of nodes by picking them from a sub-ast with root node n. // Nodes are selected by applying the fselect function func pick(n ast.Node, fselect func(n ast.Node) bool) []ast.Node { var result []ast.Node if n == nil { return result } onSelect := func(n ast.Node) { result = append(result, n) } p := picker{fselect: fselect, onSelect: onSelect} ast.Walk(p, n) return result } type picker struct { fselect func(n ast.Node) bool onSelect func(n ast.Node) } func (p picker) Visit(node ast.Node) ast.Visitor { if p.fselect == nil { return nil } if p.fselect(node) { p.onSelect(node) } return p } // gofmt returns a string representation of an AST subtree. func gofmt(x any) string { buf := bytes.Buffer{} fs := token.NewFileSet() printer.Fprint(&buf, fs, x) return buf.String() } // checkNumberOfArguments fails if the given number of arguments is not, at least, the expected one func checkNumberOfArguments(expected int, args lint.Arguments, ruleName string) { if len(args) < expected { panic(fmt.Sprintf("not enough arguments for %s rule, expected %d, got %d. Please check the rule's documentation", ruleName, expected, len(args))) } } var directiveCommentRE = regexp.MustCompile("^//(line |extern |export |[a-z0-9]+:[a-z0-9])") // see https://go-review.googlesource.com/c/website/+/442516/1..2/_content/doc/comment.md#494 func isDirectiveComment(line string) bool { return directiveCommentRE.MatchString(line) }