From 26bbb2b2f7aa12fb04b348d62924bb97dac64845 Mon Sep 17 00:00:00 2001 From: Robert Griesemer Date: Thu, 12 May 2011 09:01:10 -0700 Subject: [PATCH] go/doc, godoc: when filtering for godoc, don't remove elements of a declaration Partially revert CL 4518050. In go/doc.go, instead of calling the go/ast filter functions, implement the corresponding match functions that do no remove declaration elements. Fixes #1803. R=rsc CC=golang-dev https://golang.org/cl/4517055 --- src/pkg/go/doc/doc.go | 58 ++++++++++++++++++++++++++++++++++++++----- 1 file changed, 52 insertions(+), 6 deletions(-) diff --git a/src/pkg/go/doc/doc.go b/src/pkg/go/doc/doc.go index 5b58871250..a7a7e0a325 100644 --- a/src/pkg/go/doc/doc.go +++ b/src/pkg/go/doc/doc.go @@ -569,10 +569,56 @@ func (doc *docReader) newDoc(importpath string, filenames []string) *PackageDoc // ---------------------------------------------------------------------------- // Filtering by name -func filterValueDocs(a []*ValueDoc, f ast.Filter) []*ValueDoc { +type Filter func(string) bool + + +func matchFields(fields *ast.FieldList, f Filter) bool { + if fields != nil { + for _, field := range fields.List { + for _, name := range field.Names { + if f(name.Name) { + return true + } + } + } + } + return false +} + + +func matchDecl(d *ast.GenDecl, f Filter) bool { + for _, d := range d.Specs { + switch v := d.(type) { + case *ast.ValueSpec: + for _, name := range v.Names { + if f(name.Name) { + return true + } + } + case *ast.TypeSpec: + if f(v.Name.Name) { + return true + } + switch t := v.Type.(type) { + case *ast.StructType: + if matchFields(t.Fields, f) { + return true + } + case *ast.InterfaceType: + if matchFields(t.Methods, f) { + return true + } + } + } + } + return false +} + + +func filterValueDocs(a []*ValueDoc, f Filter) []*ValueDoc { w := 0 for _, vd := range a { - if ast.FilterDecl(vd.Decl, f) { + if matchDecl(vd.Decl, f) { a[w] = vd w++ } @@ -581,7 +627,7 @@ func filterValueDocs(a []*ValueDoc, f ast.Filter) []*ValueDoc { } -func filterFuncDocs(a []*FuncDoc, f ast.Filter) []*FuncDoc { +func filterFuncDocs(a []*FuncDoc, f Filter) []*FuncDoc { w := 0 for _, fd := range a { if f(fd.Name) { @@ -593,11 +639,11 @@ func filterFuncDocs(a []*FuncDoc, f ast.Filter) []*FuncDoc { } -func filterTypeDocs(a []*TypeDoc, f ast.Filter) []*TypeDoc { +func filterTypeDocs(a []*TypeDoc, f Filter) []*TypeDoc { w := 0 for _, td := range a { n := 0 // number of matches - if ast.FilterDecl(td.Decl, f) { + if matchDecl(td.Decl, f) { n = 1 } else { // type name doesn't match, but we may have matching consts, vars, factories or methods @@ -619,7 +665,7 @@ func filterTypeDocs(a []*TypeDoc, f ast.Filter) []*TypeDoc { // Filter eliminates documentation for names that don't pass through the filter f. // TODO: Recognize "Type.Method" as a name. // -func (p *PackageDoc) Filter(f ast.Filter) { +func (p *PackageDoc) Filter(f Filter) { p.Consts = filterValueDocs(p.Consts, f) p.Vars = filterValueDocs(p.Vars, f) p.Types = filterTypeDocs(p.Types, f) -- 2.50.0