mirror of
https://github.com/golang/go
synced 2024-09-30 16:08:36 -06:00
16d1af8d88
This CL groups the package list into two groups - standard library(GOROOT), and third-party code(GOPATH). It also wraps the list with a collapsible div header used in the package documentation page. This makes the entire page easy to view and manage, and also makes it consistent with the rest of the pages. To implement this, a new function was added to the filesystem interface which returns the root type of the filesystem. In most cases, it is either GOROOT or GOPATH. There are other kinds of filesystems which are not used in the home page, so additional values have been added to satisfy the interface. A side effect of this is that the html template code has become a bit spaghetti-like with if conditions all over. This is because the same template is used to render a package directory as well as the package home page. A better way is to use two separate templates for the different tasks. This cleans out a lot of the if conditions and make for a much cleaner code. This has been taken care in CL 101295. Fixes golang/go#3305 Fixes golang/go#15020 Change-Id: I876357dc76280a7df2ed08d7c6bc53d9a41e69ab Reviewed-on: https://go-review.googlesource.com/95835 Run-TryBot: Andrew Bonventre <andybons@golang.org> TryBot-Result: Gobot Gobot <gobot@golang.org> Reviewed-by: Andrew Bonventre <andybons@golang.org>
59 lines
1.6 KiB
Go
59 lines
1.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 vfs defines types for abstract file system access and provides an
|
|
// implementation accessing the file system of the underlying OS.
|
|
package vfs // import "golang.org/x/tools/godoc/vfs"
|
|
|
|
import (
|
|
"io"
|
|
"io/ioutil"
|
|
"os"
|
|
)
|
|
|
|
// RootType indicates the type of files contained within a directory.
|
|
//
|
|
// The two main types are a GOROOT or a GOPATH directory.
|
|
type RootType string
|
|
|
|
const (
|
|
RootTypeGoRoot RootType = "GOROOT"
|
|
RootTypeGoPath RootType = "GOPATH"
|
|
RootTypeStandAlone RootType = "StandAlone" // used by emptyvfs
|
|
RootTypeAsset RootType = "Assets" // serves static assets using mapfs
|
|
)
|
|
|
|
// The FileSystem interface specifies the methods godoc is using
|
|
// to access the file system for which it serves documentation.
|
|
type FileSystem interface {
|
|
Opener
|
|
Lstat(path string) (os.FileInfo, error)
|
|
Stat(path string) (os.FileInfo, error)
|
|
ReadDir(path string) ([]os.FileInfo, error)
|
|
RootType(path string) RootType
|
|
String() string
|
|
}
|
|
|
|
// Opener is a minimal virtual filesystem that can only open regular files.
|
|
type Opener interface {
|
|
Open(name string) (ReadSeekCloser, error)
|
|
}
|
|
|
|
// A ReadSeekCloser can Read, Seek, and Close.
|
|
type ReadSeekCloser interface {
|
|
io.Reader
|
|
io.Seeker
|
|
io.Closer
|
|
}
|
|
|
|
// ReadFile reads the file named by path from fs and returns the contents.
|
|
func ReadFile(fs Opener, path string) ([]byte, error) {
|
|
rc, err := fs.Open(path)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
defer rc.Close()
|
|
return ioutil.ReadAll(rc)
|
|
}
|