// Copyright 2013 The Go Authors. All rights reserved. // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. package godoc import ( "bytes" "fmt" "go/ast" "go/build" "go/printer" "io" "log" "os" pathpkg "path" "path/filepath" "regexp" "strings" "code.google.com/p/go.tools/godoc/vfs" ) const ( target = "/target" cmdPrefix = "cmd/" srcPrefix = "src/" toolsPath = "code.google.com/p/go.tools/cmd/" ) // CommandLine returns godoc results to w. // Note that it may add a /target path to fs. func CommandLine(w io.Writer, fs vfs.NameSpace, pres *Presentation, args []string) error { path := args[0] srcMode := pres.SrcMode cmdMode := strings.HasPrefix(path, cmdPrefix) if strings.HasPrefix(path, srcPrefix) { path = strings.TrimPrefix(path, srcPrefix) srcMode = true } var abspath, relpath string if cmdMode { path = strings.TrimPrefix(path, cmdPrefix) } else { abspath, relpath = paths(fs, pres, path) } var mode PageInfoMode if relpath == "builtin" { // the fake built-in package contains unexported identifiers mode = NoFiltering | NoFactoryFuncs } if srcMode { // only filter exports if we don't have explicit command-line filter arguments if len(args) > 1 { mode |= NoFiltering } mode |= ShowSource } // First, try as package unless forced as command. var info *PageInfo if !cmdMode { info = pres.GetPkgPageInfo(abspath, relpath, mode) } // Second, try as command (if the path is not absolute). var cinfo *PageInfo if !filepath.IsAbs(path) { // First try go.tools/cmd. abspath = pathpkg.Join(pres.PkgFSRoot(), toolsPath+path) cinfo = pres.GetCmdPageInfo(abspath, relpath, mode) if cinfo.IsEmpty() { // Then try $GOROOT/cmd. abspath = pathpkg.Join(pres.CmdFSRoot(), path) cinfo = pres.GetCmdPageInfo(abspath, relpath, mode) } } // determine what to use if info == nil || info.IsEmpty() { if cinfo != nil && !cinfo.IsEmpty() { // only cinfo exists - switch to cinfo info = cinfo } } else if cinfo != nil && !cinfo.IsEmpty() { // both info and cinfo exist - use cinfo if info // contains only subdirectory information if info.PAst == nil && info.PDoc == nil { info = cinfo } else { fmt.Fprintf(w, "use 'godoc %s%s' for documentation on the %s command \n\n", cmdPrefix, relpath, relpath) } } if info == nil { return fmt.Errorf("%s: no such directory or package", args[0]) } if info.Err != nil { return info.Err } if info.PDoc != nil && info.PDoc.ImportPath == target { // Replace virtual /target with actual argument from command line. info.PDoc.ImportPath = args[0] } // If we have more than one argument, use the remaining arguments for filtering. if len(args) > 1 { filterInfo(pres, args[1:], info) } packageText := pres.PackageText if pres.HTMLMode { packageText = pres.PackageHTML } if err := packageText.Execute(w, info); err != nil { return err } return nil } // paths determines the paths to use. // // If we are passed an operating system path like . or ./foo or /foo/bar or c:\mysrc, // we need to map that path somewhere in the fs name space so that routines // like getPageInfo will see it. We use the arbitrarily-chosen virtual path "/target" // for this. That is, if we get passed a directory like the above, we map that // directory so that getPageInfo sees it as /target. // Returns the absolute and relative paths. func paths(fs vfs.NameSpace, pres *Presentation, path string) (string, string) { if filepath.IsAbs(path) { fs.Bind(target, vfs.OS(path), "/", vfs.BindReplace) return target, target } if build.IsLocalImport(path) { cwd, _ := os.Getwd() // ignore errors path = filepath.Join(cwd, path) fs.Bind(target, vfs.OS(path), "/", vfs.BindReplace) return target, target } if bp, _ := build.Import(path, "", build.FindOnly); bp.Dir != "" && bp.ImportPath != "" { fs.Bind(target, vfs.OS(bp.Dir), "/", vfs.BindReplace) return target, bp.ImportPath } return pathpkg.Join(pres.PkgFSRoot(), path), path } func filterInfo(pres *Presentation, args []string, info *PageInfo) { rx, err := makeRx(args) if err != nil { log.Fatalf("illegal regular expression from %v: %v", args, err) } filter := func(s string) bool { return rx.MatchString(s) } switch { case info.PAst != nil: cmap := ast.NewCommentMap(info.FSet, info.PAst, info.PAst.Comments) ast.FilterFile(info.PAst, filter) // Special case: Don't use templates for printing // so we only get the filtered declarations without // package clause or extra whitespace. for i, d := range info.PAst.Decls { // determine the comments associated with d only comments := cmap.Filter(d).Comments() cn := &printer.CommentedNode{Node: d, Comments: comments} if i > 0 { fmt.Println() } if pres.HTMLMode { var buf bytes.Buffer pres.WriteNode(&buf, info.FSet, cn) FormatText(os.Stdout, buf.Bytes(), -1, true, "", nil) } else { pres.WriteNode(os.Stdout, info.FSet, cn) } fmt.Println() } return case info.PDoc != nil: info.PDoc.Filter(filter) } } // Does s look like a regular expression? func isRegexp(s string) bool { return strings.IndexAny(s, ".(|)*+?^$[]") >= 0 } // Make a regular expression of the form // names[0]|names[1]|...names[len(names)-1]. // Returns an error if the regular expression is illegal. func makeRx(names []string) (*regexp.Regexp, error) { if len(names) == 0 { return nil, fmt.Errorf("no expression provided") } s := "" for i, name := range names { if i > 0 { s += "|" } if isRegexp(name) { s += name } else { s += "^" + name + "$" // must match exactly } } return regexp.Compile(s) }