base

Documentation

Index

• Constants
• Variables
• func BoundInt(ival int, minVal int, maxVal int) int
• func BoundInt64(ival int64, minVal int64, maxVal int64) int64
• func CacheEnsureDir(dirName string, cacheKey string, perm os.FileMode, dirDesc string) error
• func EnsureRcFilesDir() (string, error)
• func ExpandHomeDir(pathStr string) string
• func GetDebugRcFileName() string
• func GetDebugReturnStateFileName() string
• func GetErrorCode(err error) string
• func GetHomeDir() string
• func GetRemoteId() (string, error)
• func GetWaveshellHomeDir() string
• func GetWaveshellPath() (string, error)
• func GoArchOptFile(version string, goos string, goarch string) string
• func HasDebugFlag(envMap map[string]string, flagName string) bool
• func InitDebugLog(prefix string)
• func IsOption(argStr string) bool
• func IsWaveSrv() bool
• func Logf(fmtStr string, args ...interface{})
• func SetBuildTime(build string)
• func SetEnableDebugLog(enable bool)
• func TryMkdirs(dirName string, perm os.FileMode, dirDesc string) error
• func ValidGoArch(goos string, goarch string) bool
• type CodedError
  • func CodedErrorf(code string, format string, args ...interface{}) *CodedError
  • func MakeCodedError(code string, err error) *CodedError
  • func (c *CodedError) Error() string
  • func (c *CodedError) Unwrap() error
• type CommandFileNames
• type CommandKey
  • func MakeCommandKey(screenId string, lineId string) CommandKey
  • func (ckey CommandKey) GetCmdId() string
  • func (ckey CommandKey) GetGroupId() string
  • func (ckey CommandKey) GetSessionId() string
  • func (ckey CommandKey) IsEmpty() bool
  • func (ckey CommandKey) Split() (string, string)
  • func (ckey CommandKey) Validate(typeStr string) error
• type OptsIter
  • func MakeOptsIter(opts []string) *OptsIter
  • func (iter *OptsIter) Current() string
  • func (iter *OptsIter) HasNext() bool
  • func (iter *OptsIter) IsNextPlain() bool
  • func (iter *OptsIter) Next() string
  • func (iter *OptsIter) Rest() []string

Constants

const (
	ProcessType_Unknown         = "unknown"
	ProcessType_WaveSrv         = "wavesrv"
	ProcessType_WaveShellSingle = "wsh-1"
	ProcessType_WaveShellServer = "wsh-s"
)

const DebugFlag_LogRcFile = "logrc"

const DebugRcFileName = "debug.rcfile"

const DebugReturnStateFileName = "debug.returnstate"

const DefaultWaveshellHome = "~/.mshell"

const DefaultWaveshellInstallBinDir = "/opt/mshell/bin"

const DefaultWaveshellName = "mshell"

const ForceDebugLog = false

const HomeVarName = "HOME"

const LogFileName = "mshell.log"

const RcFilesDirBaseName = "rcfiles"

const RemoteIdFile = "remoteid"

const SSHCommandVarName = "SSH_COMMAND"

const SessionsDirBaseName = "sessions"

const WaveshellDebugVarName = "MSHELL_DEBUG"

const WaveshellHomeVarName = "MSHELL_HOME"

const WaveshellInstallBinVarName = "MSHELL_INSTALLBIN_PATH"

const WaveshellPathVarName = "MSHELL_PATH"

const WaveshellVersion = "v0.7.0"

Variables

var BuildTime string = "0"

var DebugLogEnabled = false

var DebugLogger *log.Logger

var ProcessType string = ProcessType_Unknown

Functions

func BoundInt

func BoundInt(ival int, minVal int, maxVal int) int

func BoundInt64

func BoundInt64(ival int64, minVal int64, maxVal int64) int64

func CacheEnsureDir

func CacheEnsureDir(dirName string, cacheKey string, perm os.FileMode, dirDesc string) error

func EnsureRcFilesDir

func EnsureRcFilesDir() (string, error)

func ExpandHomeDir

func ExpandHomeDir(pathStr string) string

func GetDebugRcFileName

func GetDebugRcFileName() string

func GetDebugReturnStateFileName

func GetDebugReturnStateFileName() string

func GetErrorCode

func GetErrorCode(err error) string

func GetHomeDir

func GetHomeDir() string

func GetRemoteId

func GetRemoteId() (string, error)

func GetWaveshellHomeDir

func GetWaveshellHomeDir() string

func GetWaveshellPath

func GetWaveshellPath() (string, error)

func GoArchOptFile

func GoArchOptFile(version string, goos string, goarch string) string

func HasDebugFlag

func HasDebugFlag(envMap map[string]string, flagName string) bool

func InitDebugLog

func InitDebugLog(prefix string)

func IsOption

func IsOption(argStr string) bool

func IsWaveSrv

func IsWaveSrv() bool

func Logf

func Logf(fmtStr string, args ...interface{})

func SetBuildTime

func SetBuildTime(build string)

func SetEnableDebugLog

func SetEnableDebugLog(enable bool)

func TryMkdirs

func TryMkdirs(dirName string, perm os.FileMode, dirDesc string) error

func ValidGoArch

func ValidGoArch(goos string, goarch string) bool

Types

type CodedError

type CodedError struct {
	ErrorCode string
	Err       error
}

func CodedErrorf

func CodedErrorf(code string, format string, args ...interface{}) *CodedError

func MakeCodedError

func MakeCodedError(code string, err error) *CodedError

func (*CodedError) Error

func (c *CodedError) Error() string

func (*CodedError) Unwrap

func (c *CodedError) Unwrap() error

type CommandFileNames

type CommandFileNames struct {
	PtyOutFile    string
	StdinFifo     string
	RunnerOutFile string
}

type CommandKey

type CommandKey string

func MakeCommandKey

func MakeCommandKey(screenId string, lineId string) CommandKey

func (CommandKey) GetCmdId

func (ckey CommandKey) GetCmdId() string

func (CommandKey) GetGroupId

func (ckey CommandKey) GetGroupId() string

func (CommandKey) GetSessionId

func (ckey CommandKey) GetSessionId() string

deprecated (use GetGroupId instead)

func (CommandKey) IsEmpty

func (ckey CommandKey) IsEmpty() bool

func (CommandKey) Split

func (ckey CommandKey) Split() (string, string)

func (CommandKey) Validate

func (ckey CommandKey) Validate(typeStr string) error

type OptsIter

type OptsIter struct {
	Pos  int
	Opts []string
}

func MakeOptsIter

func MakeOptsIter(opts []string) *OptsIter

func (*OptsIter) Current

func (iter *OptsIter) Current() string

func (*OptsIter) HasNext

func (iter *OptsIter) HasNext() bool

func (*OptsIter) IsNextPlain

func (iter *OptsIter) IsNextPlain() bool

func (*OptsIter) Next

func (iter *OptsIter) Next() string

func (*OptsIter) Rest

func (iter *OptsIter) Rest() []string