show subdirectories if present in a package dir

R=rsc
DELTA=184  (69 added, 73 deleted, 42 changed)
OCL=29178
CL=29253

diff --git a/usr/gri/pretty/dirlist.html b/usr/gri/pretty/dirlist.html
deleted file mode 100644 (file)
index 1220ade..0000000
--- a/usr/gri/pretty/dirlist.html
+++ /dev/null
@@ -1,3 +0,0 @@
-{.repeated section @}
-<a href="{Name|html}/">{Name|html}</a><br />
-{.end}

diff --git a/usr/gri/pretty/dirlist.txt b/usr/gri/pretty/dirlist.txt
deleted file mode 100644 (file)
index 1064a82..0000000
--- a/usr/gri/pretty/dirlist.txt
+++ /dev/null
@@ -1,4 +0,0 @@
-Directories:
-{.repeated section @}
-       {Name}
-{.end}

diff --git a/usr/gri/pretty/godoc.go b/usr/gri/pretty/godoc.go
index 3c6c84cf2664466a848771709902515524716131..8d9de32bb040e60a4ada129ef193a65a3d26d716 100644 (file)
--- a/usr/gri/pretty/godoc.go
+++ b/usr/gri/pretty/godoc.go
@@ -86,14 +86,19 @@ func init() {
 // ----------------------------------------------------------------------------
 // Support
 
+func isDir(name string) bool {
+       d, err := os.Stat(name);
+       return err == nil && d.IsDirectory();
+}
+
+
 func isGoFile(dir *os.Dir) bool {
        return dir.IsRegular() && pathutil.Ext(dir.Name) == ".go";
 }
 
 
-func isDir(name string) bool {
-       d, err := os.Stat(name);
-       return err == nil && d.IsDirectory();
+func isPkgDir(dir *os.Dir) bool {
+       return dir.IsDirectory() && dir.Name != "_obj";
 }
 
 
@@ -287,8 +292,6 @@ func readTemplate(name string) *template.Template {
 var godocHtml *template.Template
 var packageHtml *template.Template
 var packageText *template.Template
-var dirlistHtml *template.Template;
-var dirlistText *template.Template;
 var parseerrorHtml *template.Template;
 var parseerrorText *template.Template;
 
@@ -298,8 +301,6 @@ func readTemplates() {
        godocHtml = readTemplate("godoc.html");
        packageHtml = readTemplate("package.html");
        packageText = readTemplate("package.txt");
-       dirlistHtml = readTemplate("dirlist.html");
-       dirlistText = readTemplate("dirlist.txt");
        parseerrorHtml = readTemplate("parseerror.html");
        parseerrorText = readTemplate("parseerror.txt");
 }
@@ -463,7 +464,7 @@ func findPackage(path string) (*pakDesc, dirList) {
                                panic("internal error: same file added more than once: " + entry.Name);
                        }
                        filenames[entry.Name] = true;
-               case entry.IsDirectory():
+               case isPkgDir(&entry):
                        nsub++;
                }
        }
@@ -474,7 +475,7 @@ func findPackage(path string) (*pakDesc, dirList) {
                subdirs = make(dirList, nsub);
                nsub = 0;
                for i, entry := range list {
-                       if entry.IsDirectory() {
+                       if isPkgDir(&entry) {
                                // make a copy here so sorting (and other code) doesn't
                                // have to make one every time an entry is moved
                                copy := new(os.Dir);
@@ -496,6 +497,10 @@ func findPackage(path string) (*pakDesc, dirList) {
 
 
 func (p *pakDesc) Doc() (*doc.PackageDoc, *parseErrors) {
+       if p == nil {
+               return nil, nil;
+       }
+
        // compute documentation
        var r doc.DocReader;
        i := 0;
@@ -511,12 +516,35 @@ func (p *pakDesc) Doc() (*doc.PackageDoc, *parseErrors) {
                i++;
                r.AddProgram(prog);
        }
+
        return r.Doc(), nil;
 }
 
 
-func servePackage(c *http.Conn, desc *pakDesc) {
-       doc, errors := desc.Doc();
+type PageInfo struct {
+       PDoc *doc.PackageDoc;
+       Dirs dirList;
+}
+
+func servePkg(c *http.Conn, r *http.Request) {
+       path := r.Url.Path;
+       path = path[len(Pkg) : len(path)];
+       desc, dirs := findPackage(path);
+
+       if path == "" {
+               path = ".";  // don't display an empty path
+       }
+
+       // TODO Decide what canonical URL is (w/ or w/o trailing slash)
+       // and make sure it's the one used to get to the page.
+       /*
+       if r.Url.Path != Pkg + info.Path {
+               http.Redirect(c, info.Path, http.StatusMovedPermanently);
+               return;
+       }
+       */
+
+       pdoc, errors := desc.Doc();
        if errors != nil {
                serveParseErrors(c, errors);
                return;
@@ -524,53 +552,19 @@ func servePackage(c *http.Conn, desc *pakDesc) {
 
        var buf io.ByteBuffer;
        if false {      // TODO req.Params["format"] == "text"
-               err := packageText.Execute(doc, &buf);
+               err := packageText.Execute(PageInfo{pdoc, dirs}, &buf);
                if err != nil {
                        log.Stderrf("packageText.Execute: %s", err);
                }
                serveText(c, buf.Data());
                return;
        }
-       err := packageHtml.Execute(doc, &buf);
-       if err != nil {
-               log.Stderrf("packageHtml.Execute: %s", err);
-       }
-       servePage(c, doc.ImportPath + " - Go package documentation", buf.Data());
-}
-
 
-func serveDirList(c *http.Conn, path string, dirs dirList) {
-       var buf io.ByteBuffer;
-       err := dirlistHtml.Execute(dirs, &buf);
+       err := packageHtml.Execute(PageInfo{pdoc, dirs}, &buf);
        if err != nil {
-               log.Stderrf("dirlist.Execute: %s", err);
-       }
-       servePage(c, path + " - Directories", buf.Data());
-}
-
-
-func servePkg(c *http.Conn, r *http.Request) {
-       path := r.Url.Path;
-       path = path[len(Pkg) : len(path)];
-       desc, dirs := findPackage(path);
-       /*
-       // TODO do we still need this?
-       if r.Url.Path != Pkg + info.Path {
-               http.Redirect(c, info.Path, http.StatusMovedPermanently);
-               return;
-       }
-       */
-       if desc != nil {
-               servePackage(c, desc);
-               // TODO should also serve sub-directories if there are any
-       } else {
-               // make sure path is not empty otherwise html links become rooted
-               // and won't work correctly
-               if path == "" {
-                       path = ".";
-               }
-               serveDirList(c, path, dirs);
+               log.Stderrf("packageHtml.Execute: %s", err);
        }
+       servePage(c, path + " - Go package documentation", buf.Data());
 }
 
 
@@ -666,20 +660,11 @@ func main() {
 
        if *html {
                packageText = packageHtml;
-               dirlistText = dirlistHtml;
                parseerrorText = parseerrorHtml;
        }
 
        desc, dirs := findPackage(flag.Arg(0));
-       if desc == nil {
-               err := dirlistText.Execute(dirs, os.Stdout);
-               if err != nil {
-                       log.Stderrf("dirlistText.Execute: %s", err);
-               }
-               os.Exit(0);
-       }
-
-       doc, errors := desc.Doc();
+       pdoc, errors := desc.Doc();
        if errors != nil {
                err := parseerrorText.Execute(errors, os.Stderr);
                if err != nil {
@@ -688,10 +673,10 @@ func main() {
                os.Exit(1);
        }
 
-       if flag.NArg() > 1 {
+       if pdoc != nil && flag.NArg() > 1 {
                args := flag.Args();
-               doc.Filter(args[1 : len(args)]);
+               pdoc.Filter(args[1 : len(args)]);
        }
 
-       packageText.Execute(doc, os.Stdout);
+       packageText.Execute(PageInfo{pdoc, dirs}, os.Stdout);
 }

diff --git a/usr/gri/pretty/package.html b/usr/gri/pretty/package.html
index f9fd763739f168e5d588233c8ebb3df00ee06c24..8d430743c49dfad6aea765c740a8c822da1cb6b2 100644 (file)
--- a/usr/gri/pretty/package.html
+++ b/usr/gri/pretty/package.html
@@ -1,45 +1,54 @@
-<h1>package {PackageName|html}</h1>
-<p><code>import "{ImportPath|html}"</code></p>
-
-{Doc|html-comment}
-{.section Consts}
-       <h2>Constants</h2>
+{.section Dirs}
+       <h2>Subdirectories</h2>
        {.repeated section @}
-               {Doc|html-comment}
-               <pre>{Decl|html}</pre>
+               <a href="{Name|html}/">{Name|html}</a><br />
        {.end}
-{.end}
-{.section Vars}
        <hr />
-       <h2>Variables</h2>
-       {.repeated section @}
-               {Doc|html-comment}
-               <pre>{Decl|html}</pre>
-       {.end}
 {.end}
-{.section Funcs}
-       <hr />
-       {.repeated section @}
-               <h2>func {Name|html}</h2>
-               <p><code>{Decl|html}</code></p>
-               {Doc|html-comment}
+{.section PDoc}
+       <h1>package {PackageName|html}</h1>
+       <p><code>import "{ImportPath|html}"</code></p>
+
+       {Doc|html-comment}
+       {.section Consts}
+               <h2>Constants</h2>
+               {.repeated section @}
+                       {Doc|html-comment}
+                       <pre>{Decl|html}</pre>
+               {.end}
        {.end}
-{.end}
-{.section Types}
-       {.repeated section @}
+       {.section Vars}
                <hr />
-               <h2>type {.section Type}{Name|html}{.end}</h2>
-               {Doc|html-comment}
-               <p><pre>{Decl|html}</pre></p>
-               {.repeated section Factories}
-                       <h3>func {Name|html}</h3>
-                       <p><code>{Decl|html}</code></p>
+               <h2>Variables</h2>
+               {.repeated section @}
                        {Doc|html-comment}
+                       <pre>{Decl|html}</pre>
                {.end}
-               {.repeated section Methods}
-                       <h3>func ({Recv|html}) {Name|html}</h3>
+       {.end}
+       {.section Funcs}
+               <hr />
+               {.repeated section @}
+                       <h2>func {Name|html}</h2>
                        <p><code>{Decl|html}</code></p>
                        {Doc|html-comment}
                {.end}
        {.end}
+       {.section Types}
+               {.repeated section @}
+                       <hr />
+                       <h2>type {.section Type}{Name|html}{.end}</h2>
+                       {Doc|html-comment}
+                       <p><pre>{Decl|html}</pre></p>
+                       {.repeated section Factories}
+                               <h3>func {Name|html}</h3>
+                               <p><code>{Decl|html}</code></p>
+                               {Doc|html-comment}
+                       {.end}
+                       {.repeated section Methods}
+                               <h3>func ({Recv|html}) {Name|html}</h3>
+                               <p><code>{Decl|html}</code></p>
+                               {Doc|html-comment}
+                       {.end}
+               {.end}
+       {.end}
 {.end}

diff --git a/usr/gri/pretty/package.txt b/usr/gri/pretty/package.txt
index 127529e96d9b15cdf36453dea1a444c85bd6df5b..cd8501337e437044d25c7f399235634597d9c07b 100644 (file)
--- a/usr/gri/pretty/package.txt
+++ b/usr/gri/pretty/package.txt
@@ -1,3 +1,11 @@
+{.section Dirs}
+SUBDIRECTORIES
+{.repeated section @}
+       {Name}
+{.end}
+
+{.end}
+{.section PDoc}
 PACKAGE
 
 package {PackageName}
@@ -59,3 +67,4 @@ TYPES
 {.end}
 {.end}
 {.end}
+{.end}