py/bind: bridge in go/doc.Package, add docstrings - fixes #3

sbinet · sbinet · commit 641997e7b297 · 2015-02-02T10:45:05.000+01:00
diff --git a/bind/bind.go b/bind/bind.go
@@ -7,6 +7,7 @@ package bind
 import (
 	"bytes"
 	"fmt"
+	"go/doc"
 	"go/token"
 	"io"
 	"os"
@@ -28,8 +29,71 @@ func (list ErrorList) Error() string {
 	return buf.String()
 }
 
+// Package ties types.Package and ast.Package together
+type Package struct {
+	pkg *types.Package
+	doc *doc.Package
+}
+
+// NewPackage creates a new Package, tying types.Package and ast.Package together.
+func NewPackage(pkg *types.Package, doc *doc.Package) *Package {
+	return &Package{
+		pkg: pkg,
+		doc: doc,
+	}
+}
+
+// Name returns the package name.
+func (p *Package) Name() string {
+	return p.pkg.Name()
+}
+
+// getDoc returns the doc string associated with types.Object
+func (p *Package) getDoc(o types.Object) string {
+	n := o.Name()
+	switch o.(type) {
+	case *types.Const:
+		for _, c := range p.doc.Consts {
+			for _, cn := range c.Names {
+				if n == cn {
+					return c.Doc
+				}
+			}
+		}
+
+	case *types.Var:
+		for _, v := range p.doc.Vars {
+			for _, vn := range v.Names {
+				if n == vn {
+					return v.Doc
+				}
+			}
+		}
+
+	case *types.Func:
+		for _, f := range p.doc.Funcs {
+			if n == f.Name {
+				return f.Doc
+			}
+		}
+
+	case *types.TypeName:
+		for _, t := range p.doc.Types {
+			if n == t.Name {
+				return t.Doc
+			}
+		}
+
+	default:
+		// TODO(sbinet)
+		panic(fmt.Errorf("not yet supported: %v (%T)", o, o))
+	}
+
+	return ""
+}
+
 // GenCPython generates a (C)Python package from a Go package
-func GenCPython(w io.Writer, fset *token.FileSet, pkg *types.Package) error {
+func GenCPython(w io.Writer, fset *token.FileSet, pkg *Package) error {
 	buf := new(bytes.Buffer)
 	gen := &cpyGen{
 		printer: &printer{buf: buf, indentEach: []byte("\t")},
@@ -47,7 +111,7 @@ func GenCPython(w io.Writer, fset *token.FileSet, pkg *types.Package) error {
 }
 
 // GenGo generates a cgo package from a Go package
-func GenGo(w io.Writer, fset *token.FileSet, pkg *types.Package) error {
+func GenGo(w io.Writer, fset *token.FileSet, pkg *Package) error {
 	buf := new(bytes.Buffer)
 	gen := &goGen{
 		printer: &printer{buf: buf, indentEach: []byte("\t")},
diff --git a/bind/gencpy.go b/bind/gencpy.go
@@ -91,7 +91,7 @@ type cpyGen struct {
 	*printer
 
 	fset *token.FileSet
-	pkg  *types.Package
+	pkg  *Package
 	err  ErrorList
 }
 
@@ -100,8 +100,9 @@ func (g *cpyGen) gen() error {
 	g.genPreamble()
 
 	var funcs []string
+	docs := make(map[string]string)
 
-	scope := g.pkg.Scope()
+	scope := g.pkg.pkg.Scope()
 	names := scope.Names()
 	for _, name := range names {
 		obj := scope.Lookup(name)
@@ -122,6 +123,7 @@ func (g *cpyGen) gen() error {
 		case *types.Func:
 			funcs = append(funcs, obj.Name())
 			g.genFunc(obj)
+			docs[obj.Name()] = g.pkg.getDoc(obj)
 
 		case *types.TypeName:
 			named := obj.Type().(*types.Named)
@@ -144,23 +146,23 @@ func (g *cpyGen) gen() error {
 		}
 	}
 
-	g.Printf("static PyMethodDef GoPy_%s_Methods[] = {\n", g.pkg.Name())
+	g.Printf("static PyMethodDef GoPy_%s_Methods[] = {\n", g.pkg.pkg.Name())
 	g.Indent()
 	for _, name := range funcs {
 		//obj := scope.Lookup(name)
 		g.Printf("{%[1]q, %[2]s, METH_VARARGS, %[3]q},\n",
-			name, "gopy_"+name, "doc for: "+g.pkg.Name()+"."+name,
+			name, "gopy_"+name, docs[name],
 		)
 	}
 	g.Printf("{NULL, NULL, 0, NULL}        /* Sentinel */\n")
 	g.Outdent()
 	g.Printf("};\n\n")
 
-	g.Printf("PyMODINIT_FUNC\ninit%[1]s(void)\n{\n", g.pkg.Name())
+	g.Printf("PyMODINIT_FUNC\ninit%[1]s(void)\n{\n", g.pkg.pkg.Name())
 	g.Indent()
 	g.Printf("(void) Py_InitModule3(%[1]q, GoPy_%[1]s_Methods, %[2]q);\n",
-		g.pkg.Name(),
-		"FIXME(sbinet): documentation for package "+g.pkg.Name(),
+		g.pkg.pkg.Name(),
+		g.pkg.doc.Doc,
 	)
 	g.Outdent()
 	g.Printf("}\n\n")
@@ -179,7 +181,7 @@ func (g *cpyGen) genFunc(o *types.Func) {
 static PyObject*
 gopy_%[1]s(PyObject *self, PyObject *args) {
 `,
-		o.Name(), g.pkg.Name(),
+		o.Name(), g.pkg.pkg.Name(),
 	)
 
 	g.Indent()
@@ -283,6 +285,6 @@ func (g *cpyGen) genFuncBody(o *types.Func) {
 }
 
 func (g *cpyGen) genPreamble() {
-	n := g.pkg.Name()
-	g.Printf(cPreamble, n, g.pkg.Path())
+	n := g.pkg.pkg.Name()
+	g.Printf(cPreamble, n, g.pkg.pkg.Path())
 }
diff --git a/bind/gengo.go b/bind/gengo.go
@@ -33,7 +33,7 @@ type goGen struct {
 	*printer
 
 	fset *token.FileSet
-	pkg  *types.Package
+	pkg  *Package
 	err  ErrorList
 }
 
@@ -43,7 +43,7 @@ func (g *goGen) gen() error {
 
 	var funcs []string
 
-	scope := g.pkg.Scope()
+	scope := g.pkg.pkg.Scope()
 	names := scope.Names()
 	for _, name := range names {
 		obj := scope.Lookup(name)
@@ -88,7 +88,7 @@ func (g *goGen) gen() error {
 
 	g.Printf("// Register registers the generated CPython module with the CPython runtime\nfunc Register() {\n")
 	g.Indent()
-	g.Printf("C.init%[1]s()\n", g.pkg.Name())
+	g.Printf("C.init%[1]s()\n", g.pkg.pkg.Name())
 	g.Outdent()
 	g.Printf("}\n")
 
@@ -127,7 +127,7 @@ func (g *goGen) genFuncBody(o *types.Func) {
 
 	g.Printf(
 		"%[3]s%[1]s.%[2]s(",
-		g.pkg.Name(),
+		g.pkg.pkg.Name(),
 		o.Name(),
 		ret,
 	)
@@ -146,6 +146,6 @@ func (g *goGen) genFuncBody(o *types.Func) {
 }
 
 func (g *goGen) genPreamble() {
-	n := g.pkg.Name()
-	g.Printf(goPreamble, n, g.pkg.Path())
+	n := g.pkg.pkg.Name()
+	g.Printf(goPreamble, n, g.pkg.pkg.Path())
 }
