qbit/go
1
0
Fork 0
mirror of https://github.com/golang/go synced 2024-11-26 03:47:57 -07:00
Code Releases Activity

don't show exported methods of non-exported types

Browse Source 
R=rsc
DELTA=44  (10 added, 30 deleted, 4 changed)
OCL=34195
CL=34200
This commit is contained in:
Robert Griesemer 2009-09-01 11:56:42 -07:00
parent 4fe7a38be1
commit e8988bc434
1 changed files with 13 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
src/pkg/go/doc/doc.go
View File

@ -66,36 +66,10 @@ func (doc *docReader) addType(decl *ast.GenDecl) {
} }
var predeclaredTypes = map[string]int {
// basic types
"bool": 0,
"byte": 0,
"int8": 0,
"int16": 0,
"int32": 0,
"int64": 0,
"uint8": 0,
"uint16": 0,
"uint32": 0,
"uint64": 0,
"float32": 0,
"float64": 0,
"string": 0,
// convenience types
"int": 0,
"uint": 0,
"uintptr": 0,
"float": 0,
}
func (doc *docReader) lookupTypeDoc(name string) *typeDoc { func (doc *docReader) lookupTypeDoc(name string) *typeDoc {
if name == "" { if name == "" {
return nil; // no type docs for anonymous types return nil; // no type docs for anonymous types
} }
if _, found := predeclaredTypes[name]; found {
return nil; // no type docs for predeclared types
}
if tdoc, found := doc.types[name]; found { if tdoc, found := doc.types[name]; found {
return tdoc; return tdoc;
} }
@ -109,7 +83,11 @@ func (doc *docReader) lookupTypeDoc(name string) *typeDoc {
func baseTypeName(typ ast.Expr) string { func baseTypeName(typ ast.Expr) string {
switch t := typ.(type) { switch t := typ.(type) {
case *ast.Ident: case *ast.Ident:
// if the type is not exported, the effect to
// a client is as if there were no type name
if t.IsExported() {
return string(t.Value); return string(t.Value);
}
case *ast.StarExpr: case *ast.StarExpr:
return baseTypeName(t.X); return baseTypeName(t.X);
} }
@ -176,13 +154,16 @@ func (doc *docReader) addFunc(fun *ast.FuncDecl) {
if fun.Recv != nil { if fun.Recv != nil {
// method // method
typ := doc.lookupTypeDoc(baseTypeName(fun.Recv.Type)); typ := doc.lookupTypeDoc(baseTypeName(fun.Recv.Type));
// typ should always be != nil since receiver base
// types must be named and cannot be predeclared -
// be conservative and check
if typ != nil { if typ != nil {
// exported receiver type
typ.methods[name] = fun; typ.methods[name] = fun;
return;
} }
// otherwise don't show the method
// TODO(gri): There may be exported methods of non-exported types
// that can be called because of exported values (consts, vars, or
// function results) of that type. Could determine if that is the
// case and then show those methods in an appropriate section.
return;
} }
// perhaps a factory function // perhaps a factory function
@ -193,7 +174,7 @@ func (doc *docReader) addFunc(fun *ast.FuncDecl) {
// exactly one (named or anonymous) result type // exactly one (named or anonymous) result type
typ := doc.lookupTypeDoc(baseTypeName(res.Type)); typ := doc.lookupTypeDoc(baseTypeName(res.Type));
if typ != nil { if typ != nil {
// named result type that is not predeclared // named and exported result type
typ.factories[name] = fun; typ.factories[name] = fun;
return; return;
} }
@ -201,7 +182,6 @@ func (doc *docReader) addFunc(fun *ast.FuncDecl) {
} }
// ordinary function // ordinary function
// (or method that was not associated to a type for some reason)
doc.funcs[name] = fun; doc.funcs[name] = fun;
} }