mirror of
https://github.com/golang/go.git
synced 2025-05-05 23:53:05 +00:00
705bb7ffce
The exported Server becomes handlerServer, and part of Presentation now. Presentation is also now an http.Handler with its own internal mux (a detail, which might go away). main.go becomes ever simpler. R=golang-dev, adg CC=golang-dev https://golang.org/cl/11505043
106 lines
2.6 KiB
Go
106 lines
2.6 KiB
Go
// 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 (
|
|
"net/http"
|
|
"regexp"
|
|
"sync"
|
|
"text/template"
|
|
|
|
"code.google.com/p/go.tools/godoc/vfs/httpfs"
|
|
)
|
|
|
|
// Presentation generates output from a corpus.
|
|
type Presentation struct {
|
|
Corpus *Corpus
|
|
|
|
mux *http.ServeMux
|
|
fileServer http.Handler
|
|
cmdHandler handlerServer
|
|
pkgHandler handlerServer
|
|
|
|
DirlistHTML,
|
|
ErrorHTML,
|
|
ExampleHTML,
|
|
GodocHTML,
|
|
PackageHTML,
|
|
PackageText,
|
|
SearchHTML,
|
|
SearchText,
|
|
SearchDescXML *template.Template
|
|
|
|
// TabWidth optionally specifies the tab width.
|
|
TabWidth int
|
|
|
|
ShowTimestamps bool
|
|
ShowPlayground bool
|
|
ShowExamples bool
|
|
DeclLinks bool
|
|
|
|
// NotesRx optionally specifies a regexp to match
|
|
// notes to render in the output.
|
|
NotesRx *regexp.Regexp
|
|
|
|
// AdjustPageInfoMode optionally specifies a function to
|
|
// modify the PageInfoMode of a request. The default chosen
|
|
// value is provided.
|
|
AdjustPageInfoMode func(req *http.Request, mode PageInfoMode) PageInfoMode
|
|
|
|
initFuncMapOnce sync.Once
|
|
funcMap template.FuncMap
|
|
templateFuncs template.FuncMap
|
|
}
|
|
|
|
// NewPresentation returns a new Presentation from a corpus.
|
|
func NewPresentation(c *Corpus) *Presentation {
|
|
if c == nil {
|
|
panic("nil Corpus")
|
|
}
|
|
p := &Presentation{
|
|
Corpus: c,
|
|
mux: http.NewServeMux(),
|
|
fileServer: http.FileServer(httpfs.New(c.fs)),
|
|
|
|
TabWidth: 4,
|
|
ShowExamples: true,
|
|
DeclLinks: true,
|
|
}
|
|
p.cmdHandler = handlerServer{p, c, "/cmd/", "/src/cmd"}
|
|
p.pkgHandler = handlerServer{p, c, "/pkg/", "/src/pkg"}
|
|
p.cmdHandler.registerWithMux(p.mux)
|
|
p.pkgHandler.registerWithMux(p.mux)
|
|
p.mux.HandleFunc("/", p.ServeFile)
|
|
return p
|
|
}
|
|
|
|
func (p *Presentation) FileServer() http.Handler {
|
|
return p.fileServer
|
|
}
|
|
|
|
func (p *Presentation) ServeHTTP(w http.ResponseWriter, r *http.Request) {
|
|
p.mux.ServeHTTP(w, r)
|
|
}
|
|
|
|
func (p *Presentation) PkgFSRoot() string {
|
|
return p.pkgHandler.fsRoot
|
|
}
|
|
|
|
func (p *Presentation) CmdFSRoot() string {
|
|
return p.cmdHandler.fsRoot
|
|
}
|
|
|
|
// TODO(bradfitz): move this to be a method on Corpus. Just moving code around for now,
|
|
// but this doesn't feel right.
|
|
func (p *Presentation) GetPkgPageInfo(abspath, relpath string, mode PageInfoMode) *PageInfo {
|
|
return p.pkgHandler.GetPageInfo(abspath, relpath, mode)
|
|
}
|
|
|
|
// TODO(bradfitz): move this to be a method on Corpus. Just moving code around for now,
|
|
// but this doesn't feel right.
|
|
func (p *Presentation) GetCmdPageInfo(abspath, relpath string, mode PageInfoMode) *PageInfo {
|
|
return p.cmdHandler.GetPageInfo(abspath, relpath, mode)
|
|
}
|