shell

Documentation

Index

• func Escape(s string) string
• func EscapeBytes(s []byte) []byte
• func EscapeBytesNoQuotes(s []byte) []byte
• func EscapeNoQuotes(s string) string
• func IsCommandSeparator(text string) bool
• func Split(text string) []string
• func Unescape(text string) string
• func UnescapeBytes(b []byte) []byte
• func UnescapeCLike(text string, buffer *bytes.Buffer, pos int) int
• type BashProxy
  • func (s *BashProxy) Escape(text string) string
  • func (s *BashProxy) GetCommandLine() (string, int)
  • func (s *BashProxy) PrintUpdateCommandLineEvalStr(commandLine string, cursorPos int)
  • func (s *BashProxy) Split(text string) []Token
  • func (s *BashProxy) Unescape(text string) string
• type Proxy
  • func GetBashProxy() Proxy
  • func GetProxy() Proxy
  • func GetSupportedProxy() Proxy
  • func GetZshProxy() Proxy
  • func MustGetSupportedProxy() Proxy
• type Token
  • func SplitToTokens(text string) []Token
• type ZshProxy
  • func (s *ZshProxy) Escape(text string) string
  • func (s *ZshProxy) GetCommandLine() (string, int)
  • func (s *ZshProxy) PrintUpdateCommandLineEvalStr(commandLine string, cursorPos int)
  • func (s *ZshProxy) Split(text string) []Token
  • func (s *ZshProxy) Unescape(text string) string

Functions

func Escape

func Escape(s string) string

Escape escapes a string for shell.

func EscapeBytes

func EscapeBytes(s []byte) []byte

EscapeBytes escapes a byte array for shell.

func EscapeBytesNoQuotes

func EscapeBytesNoQuotes(s []byte) []byte

Escape escapes a byte array with backslashes.

func EscapeNoQuotes

func EscapeNoQuotes(s string) string

Escape escapes a string with backslashes.

func IsCommandSeparator

func IsCommandSeparator(text string) bool

func Split

func Split(text string) []string

Split splits a whole command line into tokens. Example: "cat fi\ le.txt|grep -V ^# >'out$$.txt' # Find non-comment lines." -> output: cat, fi\ le.txt, |, grep, -V, ^#, >, 'out$$.txt', # Find non-comment lines.

func Unescape

func Unescape(text string) string

func UnescapeBytes

func UnescapeBytes(b []byte) []byte

func UnescapeCLike

func UnescapeCLike(text string, buffer *bytes.Buffer, pos int) int

Types

type BashProxy

type BashProxy struct {
}

func (*BashProxy) Escape

func (s *BashProxy) Escape(text string) string

func (*BashProxy) GetCommandLine

func (s *BashProxy) GetCommandLine() (string, int)

GetCommandLine return the current command line and the cursor position from the READLINE_* environmental variables.

func (*BashProxy) PrintUpdateCommandLineEvalStr

func (s *BashProxy) PrintUpdateCommandLineEvalStr(commandLine string, cursorPos int)

PrintUpdateCommandLineEvalStr prints a string that can be evaled by bash to update the READLINE_* environmental variables to update the current command line.

func (*BashProxy) Split

func (s *BashProxy) Split(text string) []Token

func (*BashProxy) Unescape

func (s *BashProxy) Unescape(text string) string

type Proxy

type Proxy interface {
	GetCommandLine() (commandLine string, cursorPos int)
	PrintUpdateCommandLineEvalStr(commandLine string, cursorPos int)
	Split(text string) []Token
	Escape(text string) string
	Unescape(text string) string
}

func GetBashProxy

func GetBashProxy() Proxy

func GetProxy

func GetProxy() Proxy

func GetSupportedProxy

func GetSupportedProxy() Proxy

func GetZshProxy

func GetZshProxy() Proxy

func MustGetSupportedProxy

func MustGetSupportedProxy() Proxy

type Token

type Token struct {
	Word  string
	Index int
}

func SplitToTokens

func SplitToTokens(text string) []Token

type ZshProxy

type ZshProxy struct {
}

func (*ZshProxy) Escape

func (s *ZshProxy) Escape(text string) string

func (*ZshProxy) GetCommandLine

func (s *ZshProxy) GetCommandLine() (string, int)

func (*ZshProxy) PrintUpdateCommandLineEvalStr

func (s *ZshProxy) PrintUpdateCommandLineEvalStr(commandLine string, cursorPos int)

func (*ZshProxy) Split

func (s *ZshProxy) Split(text string) []Token

func (*ZshProxy) Unescape

func (s *ZshProxy) Unescape(text string) string