util

Documentation

Overview

Package util contains utility functions.

Index

• Constants
• Variables
• func CatError(err error, more error) error
• func Catch(perr *error)
• func CeilDiv(a, b int) int
• func DeepPrint(x interface{}) string
• func DontSearch(exe string) bool
• func EachExecutable(paths []string, f func(string))
• func FindContext(text string, pos int) (lineno, colno int, line string)
• func FindFirstEOL(s string) int
• func FindLastSOL(s string) int
• func ForceWcwidth(s string, width int) string
• func FullNames(dir string) []string
• func GetHome(uname string) (string, error)
• func GetLogger(prefix string) *log.Logger
• func Getwd() string
• func IsExecutable(path string) bool
• func MatchSubseq(s, pattern string) bool
• func NthRune(s string, n int) (rune, error)
• func OverrideWcwidth(r rune, w int)
• func Search(paths []string, exe string) (string, error)
• func SetOutputFile(fname string) error
• func SubstringByRune(s string, low, high int) (string, error)
• func Throw(err error)
• func TildeAbbr(path string) string
• func TrimEachLineWcwidth(s string, width int) string
• func TrimWcwidth(s string, wmax int) string
• func UnoverrideWcwidth(r rune)
• func Wcswidth(s string) (w int)
• func Wcwidth(r rune) int
• type Errors
  • func (es *Errors) Append(e error)
  • func (es *Errors) Error() string
• type Pprinter
• type SourceContext
  • func (sc *SourceContext) Pprint(w io.Writer, sourceIndent string)
• type Thrown

Constants

const (
	MaxUint = ^uint(0)
	MinUint = 0
	MaxInt  = int(MaxUint >> 1)
	MinInt  = -MaxInt - 1
)

Variables

var (
	ErrNotExecutable = errors.New("not executable")
	ErrNotFound      = errors.New("not found")
)

var CulpritStyle = "1;4"

var ErrIndexOutOfRange = errors.New("substring out of range")

ErrIndexOutOfRange is returned when out-of-range errors occur.

Functions

func CatError

func CatError(err error, more error) error

func Catch

func Catch(perr *error)

Catch tries to catch an error thrown by Throw and stop the panic. If the panic is not caused by Throw, the panic is not stopped.

func CeilDiv

func CeilDiv(a, b int) int

CeilDiv computes ceil(float(a)/b) without using float arithmetics.

func DeepPrint

func DeepPrint(x interface{}) string

DeepPrint is like printing with the %#v formatter of fmt, but it prints pointer fields recursively.

func DontSearch

func DontSearch(exe string) bool

DontSearch determines whether the path to an external command should be taken literally and not searched.

func EachExecutable

func EachExecutable(paths []string, f func(string))

EachExecutable calls f for each executable file in paths.

func FindContext

func FindContext(text string, pos int) (lineno, colno int, line string)

FindContext takes a position in a text and finds its line number, corresponding line and column numbers. Line and column numbers are counted from 0. Used in diagnostic messages.

func FindFirstEOL

func FindFirstEOL(s string) int

FindFirstEOL returns the index of the first '\n'. When there is no '\n', the length of s is returned.

func FindLastSOL

func FindLastSOL(s string) int

FindLastSOL returns an index just after the last '\n'.

func ForceWcwidth

func ForceWcwidth(s string, width int) string

ForceWcwidth forces the string s to the given display width by trimming and padding.

func FullNames

func FullNames(dir string) []string

FullNames returns the full names of non-hidden files under a directory. The directory name should end in a slash. If the directory cannot be listed, it returns nil.

The output should be the same as globbing dir + "*". It is used for testing globbing.

func GetHome

func GetHome(uname string) (string, error)

GetHome finds the home directory of a specified user. When given an empty string, it finds the home directory of the current user.

func GetLogger

func GetLogger(prefix string) *log.Logger

GetLogger gets a logger with a prefix.

func Getwd

func Getwd() string

Getwd returns path of the working directory in a format suitable as the prompt.

func IsExecutable

func IsExecutable(path string) bool

IsExecutable determines whether path refers to an executable file.

func MatchSubseq

func MatchSubseq(s, pattern string) bool

MatchSubseq returns whether pattern is a subsequence of s.

func NthRune

func NthRune(s string, n int) (rune, error)

NthRune returns the n-th rune of s.

func OverrideWcwidth

func OverrideWcwidth(r rune, w int)

OverrideWcwidth overrides the wcwidth of a rune to be a specific non-negative value. OverrideWcwidth panics if w < 0.

func Search

func Search(paths []string, exe string) (string, error)

Search tries to resolve an external command and return the full (possibly relative) path.

func SetOutputFile

func SetOutputFile(fname string) error

func SubstringByRune

func SubstringByRune(s string, low, high int) (string, error)

SubstringByRune returns the range of the i-th rune (inclusive) through the j-th rune (exclusive) in s.

func Throw

func Throw(err error)

Throw panics with err wrapped properly so that it can be catched by Catch.

func TildeAbbr

func TildeAbbr(path string) string

TildeAbbr abbreviates the user's home directory to ~.

func TrimEachLineWcwidth

func TrimEachLineWcwidth(s string, width int) string

func TrimWcwidth

func TrimWcwidth(s string, wmax int) string

TrimWcwidth trims the string s so that it has a width of at most wmax.

func UnoverrideWcwidth

func UnoverrideWcwidth(r rune)

UnoverrideWcwidth removes the override of a rune.

func Wcswidth

func Wcswidth(s string) (w int)

Wcswidth returns the width of a string when displayed on the terminal, assuming no soft line breaks.

func Wcwidth

func Wcwidth(r rune) int

Wcwidth returns the width of a rune when displayed on the terminal.

Types

type Errors

type Errors struct {
	Errors []error
}

Errors pack multiple errors into one error.

func (*Errors) Append

func (es *Errors) Append(e error)

func (*Errors) Error

func (es *Errors) Error() string

type Pprinter

type Pprinter interface {
	Pprint(indent string) string
}

type SourceContext

type SourceContext struct {
	Name   string
	Source string
	Begin  int
	End    int
	Next   *SourceContext
}

func (*SourceContext) Pprint

func (sc *SourceContext) Pprint(w io.Writer, sourceIndent string)

type Thrown

type Thrown struct {
	Error error
}

Thrown wraps an error that was raised by Throw, so that it can be recognized by Catch.