From 35aec6c7f7740f5544dfff31744b74a38dd459f2 Mon Sep 17 00:00:00 2001 From: Robert Griesemer Date: Wed, 10 Mar 2010 15:22:22 -0800 Subject: [PATCH] godoc: provide mode which shows exported interface in "source form" - on the commandline: godoc -x big - in a webpage: provide form parameter ?m=src Known issues: - Positioning of comments incorrect in several cases. Separate CL. - Need a link/menu to switch between different modes of presentation in the web view. R=rsc CC=golang-dev https://golang.org/cl/376041 --- lib/godoc/package.html | 5 +++++ lib/godoc/package.txt | 3 +++ src/cmd/godoc/godoc.go | 36 ++++++++++++++++++++++++------------ src/cmd/godoc/main.go | 9 +++++---- 4 files changed, 37 insertions(+), 16 deletions(-) diff --git a/lib/godoc/package.html b/lib/godoc/package.html index 2113e46bd8a..c0cd18f3133 100644 --- a/lib/godoc/package.html +++ b/lib/godoc/package.html @@ -4,6 +4,11 @@ license that can be found in the LICENSE file. --> +{.section PAst} + 
+	{@|html}
+
+{.end} {.section PDoc} {.section IsPkg} diff --git a/lib/godoc/package.txt b/lib/godoc/package.txt index 77d20f49fd0..b9203ff217a 100644 --- a/lib/godoc/package.txt +++ b/lib/godoc/package.txt @@ -1,3 +1,6 @@ +{.section PAst} +{@} +{.end} {.section PDoc} {.section IsPkg} PACKAGE diff --git a/src/cmd/godoc/godoc.go b/src/cmd/godoc/godoc.go index b16f144e42e..65568a8cf8f 100644 --- a/src/cmd/godoc/godoc.go +++ b/src/cmd/godoc/godoc.go @@ -1087,8 +1087,9 @@ const fakePkgName = "documentation" type PageInfo struct { Dirname string // directory containing the package - PDoc *doc.PackageDoc // nil if no package found - Dirs *DirList // nil if no directory information found + PAst *ast.File // nil if no AST with package exports + PDoc *doc.PackageDoc // nil if no package documentation + Dirs *DirList // nil if no directory information IsPkg bool // false if this is not documenting a real package } @@ -1100,12 +1101,15 @@ type httpHandler struct { } -// getPageInfo returns the PageInfo for a package directory dirname. If -// the parameter try is true, no errors are logged if getPageInfo fails. -// If there is no corresponding package in the directory, PageInfo.PDoc -// is nil. If there are no subdirectories, PageInfo.Dirs is nil. +// getPageInfo returns the PageInfo for a package directory dirname. If the +// parameter genAST is set, an AST containing only the package exports is +// computed (PageInfo.PAst), otherwise package documentation (PageInfo.Doc) +// is extracted from the AST. If the parameter try is set, no errors are +// logged if getPageInfo fails. If there is no corresponding package in the +// directory, PageInfo.PDoc and PageInfo.PExp are nil. If there are no sub- +// directories, PageInfo.Dirs is nil. // -func (h *httpHandler) getPageInfo(dirname, relpath string, try bool) PageInfo { +func (h *httpHandler) getPageInfo(dirname, relpath string, genAST, try bool) PageInfo { // filter function to select the desired .go files filter := func(d *os.Dir) bool { // If we are looking at cmd documentation, only accept @@ -1141,10 +1145,15 @@ func (h *httpHandler) getPageInfo(dirname, relpath string, try bool) PageInfo { } // compute package documentation + var past *ast.File var pdoc *doc.PackageDoc if pkg != nil { ast.PackageExports(pkg) - pdoc = doc.NewPackageDoc(pkg, pathutil.Clean(relpath)) // no trailing '/' in importpath + if genAST { + past = ast.MergePackageFiles(pkg) + } else { + pdoc = doc.NewPackageDoc(pkg, pathutil.Clean(relpath)) // no trailing '/' in importpath + } } // get directory information @@ -1163,7 +1172,7 @@ func (h *httpHandler) getPageInfo(dirname, relpath string, try bool) PageInfo { dir = newDirectory(dirname, 1) } - return PageInfo{dirname, pdoc, dir.listing(true), h.isPkg} + return PageInfo{dirname, past, pdoc, dir.listing(true), h.isPkg} } @@ -1174,7 +1183,7 @@ func (h *httpHandler) ServeHTTP(c *http.Conn, r *http.Request) { relpath := r.URL.Path[len(h.pattern):] abspath := absolutePath(relpath, h.fsRoot) - info := h.getPageInfo(abspath, relpath, false) + info := h.getPageInfo(abspath, relpath, r.FormValue("m") == "src", false) if r.FormValue("f") == "text" { contents := applyTemplate(packageText, "packageText", info) @@ -1183,7 +1192,10 @@ func (h *httpHandler) ServeHTTP(c *http.Conn, r *http.Request) { } var title string - if info.PDoc != nil { + switch { + case info.PAst != nil: + title = "Package " + info.PAst.Name.Name() + case info.PDoc != nil: switch { case h.isPkg: title = "Package " + info.PDoc.PackageName @@ -1194,7 +1206,7 @@ func (h *httpHandler) ServeHTTP(c *http.Conn, r *http.Request) { default: title = "Command " + info.PDoc.PackageName } - } else { + default: title = "Directory " + relativePath(info.Dirname) } diff --git a/src/cmd/godoc/main.go b/src/cmd/godoc/main.go index ded1d3607ad..9f92c6cffcd 100644 --- a/src/cmd/godoc/main.go +++ b/src/cmd/godoc/main.go @@ -47,7 +47,8 @@ var ( httpaddr = flag.String("http", "", "HTTP service address (e.g., ':6060')") // layout control - html = flag.Bool("html", false, "print HTML in command-line mode") + html = flag.Bool("html", false, "print HTML in command-line mode") + genAST = flag.Bool("x", false, "print exported source in command-line mode") ) @@ -240,14 +241,14 @@ func main() { relpath = relativePath(path) } - info := pkgHandler.getPageInfo(abspath, relpath, true) + info := pkgHandler.getPageInfo(abspath, relpath, *genAST, true) - if info.PDoc == nil && info.Dirs == nil { + if info.PAst == nil && info.PDoc == nil && info.Dirs == nil { // try again, this time assume it's a command if len(path) > 0 && path[0] != '/' { abspath = absolutePath(path, cmdHandler.fsRoot) } - info = cmdHandler.getPageInfo(abspath, relpath, false) + info = cmdHandler.getPageInfo(abspath, relpath, false, false) } if info.PDoc != nil && flag.NArg() > 1 {