elvish/edit/ls-colors.go

212 lines
6.0 KiB
Go
Raw Normal View History

2014-03-08 15:43:05 +08:00
package edit
import (
"os"
"path"
"strings"
"syscall"
)
2016-02-12 20:31:24 +08:00
// Color files based on their various features.
//
2014-03-08 15:43:05 +08:00
// This is a reverse-engineered implementation of the parsing and
// interpretation of the LS_COLORS environmental variable used by GNU
// coreutils.
type fileFeature int
const (
featureInvalid fileFeature = iota
featureOrphanedSymlink
featureSymlink
featureMultiHardLink
featureNamedPipe
featureSocket
featureDoor
featureBlockDevice
featureCharDevice
featureWorldWritableStickyDirectory
featureWorldWritableDirectory
featureStickyDirectory
featureDirectory
featureCapability
featureSetuid
featureSetgid
featureExecutable
featureRegular
)
var featureForName = map[string]fileFeature{
"rs": featureRegular,
"di": featureDirectory,
"ln": featureSymlink,
"mh": featureMultiHardLink,
"pi": featureNamedPipe,
"so": featureSocket,
"do": featureDoor,
"bd": featureBlockDevice,
"cd": featureCharDevice,
"or": featureOrphanedSymlink,
"su": featureSetuid,
"sg": featureSetgid,
"ca": featureCapability,
"tw": featureWorldWritableStickyDirectory,
"ow": featureWorldWritableDirectory,
"st": featureStickyDirectory,
"ex": featureExecutable,
}
type lsColor struct {
2016-01-31 09:36:26 +08:00
styleForFeature map[fileFeature]string
styleForExt map[string]string
2014-03-08 15:43:05 +08:00
}
const defaultLsColorString = `rs=:di=01;34:ln=01;36:mh=:pi=40;33:so=01;35:do=01;35:bd=40;33;01:cd=40;33;01:or=40;31;01:su=37;41:sg=30;43:ca=30;41:tw=30;42:ow=34;42:st=37;44:ex=01;32:*.tar=01;31:*.tgz=01;31:*.arc=01;31:*.arj=01;31:*.taz=01;31:*.lha=01;31:*.lz4=01;31:*.lzh=01;31:*.lzma=01;31:*.tlz=01;31:*.txz=01;31:*.tzo=01;31:*.t7z=01;31:*.zip=01;31:*.z=01;31:*.Z=01;31:*.dz=01;31:*.gz=01;31:*.lrz=01;31:*.lz=01;31:*.lzo=01;31:*.xz=01;31:*.bz2=01;31:*.bz=01;31:*.tbz=01;31:*.tbz2=01;31:*.tz=01;31:*.deb=01;31:*.rpm=01;31:*.jar=01;31:*.war=01;31:*.ear=01;31:*.sar=01;31:*.rar=01;31:*.alz=01;31:*.ace=01;31:*.zoo=01;31:*.cpio=01;31:*.7z=01;31:*.rz=01;31:*.cab=01;31:*.jpg=01;35:*.jpeg=01;35:*.gif=01;35:*.bmp=01;35:*.pbm=01;35:*.pgm=01;35:*.ppm=01;35:*.tga=01;35:*.xbm=01;35:*.xpm=01;35:*.tif=01;35:*.tiff=01;35:*.png=01;35:*.svg=01;35:*.svgz=01;35:*.mng=01;35:*.pcx=01;35:*.mov=01;35:*.mpg=01;35:*.mpeg=01;35:*.m2v=01;35:*.mkv=01;35:*.webm=01;35:*.ogm=01;35:*.mp4=01;35:*.m4v=01;35:*.mp4v=01;35:*.vob=01;35:*.qt=01;35:*.nuv=01;35:*.wmv=01;35:*.asf=01;35:*.rm=01;35:*.rmvb=01;35:*.flc=01;35:*.avi=01;35:*.fli=01;35:*.flv=01;35:*.gl=01;35:*.dl=01;35:*.xcf=01;35:*.xwd=01;35:*.yuv=01;35:*.cgm=01;35:*.emf=01;35:*.axv=01;35:*.anx=01;35:*.ogv=01;35:*.ogx=01;35:*.aac=36:*.au=36:*.flac=36:*.mid=36:*.midi=36:*.mka=36:*.mp3=36:*.mpc=36:*.ogg=36:*.ra=36:*.wav=36:*.axa=36:*.oga=36:*.spx=36:*.xspf=36:`
2014-03-08 15:43:05 +08:00
2016-10-10 23:58:53 +08:00
func getLsColorString() string {
lsColorString := os.Getenv("LS_COLORS")
if len(lsColorString) == 0 {
return defaultLsColorString
}
return lsColorString
}
func getLsColor() *lsColor {
return parseLsColor(getLsColorString())
}
2014-03-08 15:43:05 +08:00
2015-01-23 07:38:44 +08:00
// parseLsColor parses a string in the LS_COLORS format into lsColor. Erroneous
// fields are silently ignored.
2014-03-08 15:43:05 +08:00
func parseLsColor(s string) *lsColor {
lc := &lsColor{make(map[fileFeature]string), make(map[string]string)}
for _, spec := range strings.Split(s, ":") {
words := strings.Split(spec, "=")
if len(words) != 2 {
continue
}
key, value := words[0], words[1]
2016-10-10 23:58:53 +08:00
filterValues := []string{}
for _, splitValue := range strings.Split(value, ";") {
if strings.Count(splitValue, "0") == len(splitValue) {
continue
}
filterValues = append(filterValues, splitValue)
}
if len(filterValues) == 0 {
continue
}
value = strings.Join(filterValues, ";")
2014-03-08 15:43:05 +08:00
if strings.HasPrefix(key, "*.") {
2016-01-31 09:36:26 +08:00
lc.styleForExt[key[2:]] = value
2014-03-08 15:43:05 +08:00
} else {
feature, ok := featureForName[key]
if !ok {
continue
}
2016-01-31 09:36:26 +08:00
lc.styleForFeature[feature] = value
2014-03-08 15:43:05 +08:00
}
}
return lc
}
2014-03-08 16:05:13 +08:00
func is(u, p uint32) bool {
return u&p == p
}
2014-10-01 08:07:11 +08:00
// Weirdly, permission masks for group and other are missing on platforms other
// than linux, darwin and netbsd. So we replicate some of them here.
const (
S_IWOTH = 0x2 // Writable by other
S_IXGRP = 0x8 // Executable by group
S_IXOTH = 0x1 // Executable by other
)
2014-03-08 15:43:05 +08:00
func determineFeature(fname string, mh bool) (fileFeature, error) {
var stat syscall.Stat_t
err := syscall.Lstat(fname, &stat)
2014-03-08 15:43:05 +08:00
if err != nil {
return 0, err
}
2014-09-28 00:17:55 +08:00
// The type of syscall.Stat_t.Mode is uint32 on Linux and uint16 on Mac
m := (uint32)(stat.Mode)
2014-03-08 15:43:05 +08:00
// Symlink and OrphanedSymlink has highest precedence
2014-03-08 16:05:13 +08:00
if is(m, syscall.S_IFLNK) {
2014-03-08 15:43:05 +08:00
_, err := os.Stat(fname)
2015-02-25 04:38:50 +08:00
if err != nil {
2014-03-08 15:43:05 +08:00
return featureOrphanedSymlink, nil
}
2015-02-25 04:38:50 +08:00
return featureSymlink, nil
2014-03-08 15:43:05 +08:00
}
// featureMultiHardLink
if mh && stat.Nlink > 1 {
return featureMultiHardLink, nil
}
// type bits features
switch {
2014-03-08 16:05:13 +08:00
case is(m, syscall.S_IFIFO):
2014-03-08 15:43:05 +08:00
return featureNamedPipe, nil
2014-03-08 16:05:13 +08:00
case is(m, syscall.S_IFSOCK):
2014-03-08 15:43:05 +08:00
return featureSocket, nil
/*
case m | syscall.S_IFDOOR != 0:
return featureDoor, nil
*/
2014-03-08 16:05:13 +08:00
case is(m, syscall.S_IFBLK):
2014-03-08 15:43:05 +08:00
return featureBlockDevice, nil
2014-03-08 16:05:13 +08:00
case is(m, syscall.S_IFCHR):
2014-03-08 15:43:05 +08:00
return featureCharDevice, nil
2014-03-08 16:05:13 +08:00
case is(m, syscall.S_IFDIR):
2014-03-08 15:43:05 +08:00
// Perm bits features for directory
switch {
2014-10-01 08:07:11 +08:00
case is(m, S_IWOTH|syscall.S_ISVTX):
2014-03-08 15:43:05 +08:00
return featureWorldWritableStickyDirectory, nil
2014-10-01 08:07:11 +08:00
case is(m, S_IWOTH):
2014-03-08 15:43:05 +08:00
return featureWorldWritableDirectory, nil
2014-03-08 16:05:13 +08:00
case is(m, syscall.S_ISVTX):
2014-03-08 15:43:05 +08:00
return featureStickyDirectory, nil
default:
return featureDirectory, nil
}
}
// TODO(xiaq): Support featureCapacity
// Perm bits features for regular files
switch {
2014-03-08 16:05:13 +08:00
case is(m, syscall.S_ISUID):
2014-03-08 15:43:05 +08:00
return featureSetuid, nil
2014-03-08 16:05:13 +08:00
case is(m, syscall.S_ISGID):
2014-03-08 15:43:05 +08:00
return featureSetgid, nil
2014-10-01 08:07:11 +08:00
case m&(syscall.S_IXUSR|S_IXGRP|S_IXOTH) != 0:
2014-03-08 15:43:05 +08:00
return featureExecutable, nil
}
// Check extension
return featureRegular, nil
}
2016-01-31 09:36:26 +08:00
func (lc *lsColor) getStyle(fname string) string {
mh := strings.Trim(lc.styleForFeature[featureMultiHardLink], "0") != ""
2014-03-08 15:43:05 +08:00
// TODO Handle error from determineFeature
feature, _ := determineFeature(fname, mh)
if feature == featureRegular {
if ext := path.Ext(fname); ext != "" {
2016-01-31 09:36:26 +08:00
if style, ok := lc.styleForExt[ext]; ok {
return style
2014-03-08 15:43:05 +08:00
}
}
}
2016-01-31 09:36:26 +08:00
return lc.styleForFeature[feature]
2014-03-08 15:43:05 +08:00
}