mirror of
https://github.com/golang/go
synced 2024-11-19 02:34:44 -07:00
9ac8940d29
Phrases like "returns whether or not the image is opaque" could be describing what the function does (it always returns, regardless of the opacity) or what it returns (a boolean indicating the opacity). Even when the "or not" is missing, the phrasing is bizarre. Go with "reports whether", which is still clunky but at least makes it clear we're talking about the return value. R=golang-dev, dsymonds CC=golang-dev https://golang.org/cl/11458046
90 lines
2.2 KiB
Go
90 lines
2.2 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 util contains utility types and functions for godoc.
|
|
package util
|
|
|
|
import (
|
|
pathpkg "path"
|
|
"sync"
|
|
"time"
|
|
"unicode/utf8"
|
|
|
|
"code.google.com/p/go.tools/godoc/vfs"
|
|
)
|
|
|
|
// An RWValue wraps a value and permits mutually exclusive
|
|
// access to it and records the time the value was last set.
|
|
type RWValue struct {
|
|
mutex sync.RWMutex
|
|
value interface{}
|
|
timestamp time.Time // time of last set()
|
|
}
|
|
|
|
func (v *RWValue) Set(value interface{}) {
|
|
v.mutex.Lock()
|
|
v.value = value
|
|
v.timestamp = time.Now()
|
|
v.mutex.Unlock()
|
|
}
|
|
|
|
func (v *RWValue) Get() (interface{}, time.Time) {
|
|
v.mutex.RLock()
|
|
defer v.mutex.RUnlock()
|
|
return v.value, v.timestamp
|
|
}
|
|
|
|
// IsText reports whether a significant prefix of s looks like correct UTF-8;
|
|
// that is, if it is likely that s is human-readable text.
|
|
func IsText(s []byte) bool {
|
|
const max = 1024 // at least utf8.UTFMax
|
|
if len(s) > max {
|
|
s = s[0:max]
|
|
}
|
|
for i, c := range string(s) {
|
|
if i+utf8.UTFMax > len(s) {
|
|
// last char may be incomplete - ignore
|
|
break
|
|
}
|
|
if c == 0xFFFD || c < ' ' && c != '\n' && c != '\t' && c != '\f' {
|
|
// decoding error or control character - not a text file
|
|
return false
|
|
}
|
|
}
|
|
return true
|
|
}
|
|
|
|
// textExt[x] is true if the extension x indicates a text file, and false otherwise.
|
|
var textExt = map[string]bool{
|
|
".css": false, // must be served raw
|
|
".js": false, // must be served raw
|
|
}
|
|
|
|
// IsTextFile reports whether the file has a known extension indicating
|
|
// a text file, or if a significant chunk of the specified file looks like
|
|
// correct UTF-8; that is, if it is likely that the file contains human-
|
|
// readable text.
|
|
func IsTextFile(fs vfs.Opener, filename string) bool {
|
|
// if the extension is known, use it for decision making
|
|
if isText, found := textExt[pathpkg.Ext(filename)]; found {
|
|
return isText
|
|
}
|
|
|
|
// the extension is not known; read an initial chunk
|
|
// of the file and check if it looks like text
|
|
f, err := fs.Open(filename)
|
|
if err != nil {
|
|
return false
|
|
}
|
|
defer f.Close()
|
|
|
|
var buf [1024]byte
|
|
n, err := f.Read(buf[0:])
|
|
if err != nil {
|
|
return false
|
|
}
|
|
|
|
return IsText(buf[0:n])
|
|
}
|