atsf4g_go_robot_util

Documentation

Index

• func AllHelpString(node *CommandNode) string
• func AllHelpStringInner(node *CommandNode) (ret [][]string)
• func ExecuteCommand(root *CommandNode, mgr *base.TaskActionManager, rl *readline.Instance, ...)
• func GetCurrentReadlineInstance() *readline.Instance
• func GetFlagInt32(fs *flag.FlagSet, name string) int32
• func GetFlagString(fs *flag.FlagSet, name string) string
• func GetSetVars(fs *flag.FlagSet) map[string]string
• func HistoryCmd(base.TaskActionImpl, []string) string
• func NewCompleter(root *CommandNode) *readline.PrefixCompleter
• func ParseSetFlags(sets []string) map[string]string
• func QuitCmd(base.TaskActionImpl, []string) string
• func ReadLine(root *CommandNode)
• func RegisterCommand(root *CommandNode, path []string, fn CommandFunc, argsInfo string, desc string, ...)
• func RegisterCommandDefaultTimeout(root *CommandNode, path []string, fn CommandFunc, argsInfo string, desc string, ...)
• func StdoutLog(log string)
• type CommandFunc
• type CommandNode
  • func CreateCommandNode() *CommandNode
  • func FindCommand(root *CommandNode, path string) (args []string, node *CommandNode)
  • func (node *CommandNode) SelfHelpString() []string
• type HistoryManager
  • func NewHistoryManager(file string, cleanDuplicates bool) *HistoryManager
• type StringSliceFlag
  • func (s *StringSliceFlag) Set(val string) error
  • func (s *StringSliceFlag) String() string
• type TaskActionCmd
  • func (t *TaskActionCmd) HookRun() error
  • func (t *TaskActionCmd) Log(format string, a ...any)

Functions

func AllHelpString

func AllHelpString(node *CommandNode) string

func AllHelpStringInner

func AllHelpStringInner(node *CommandNode) (ret [][]string)

func ExecuteCommand

func ExecuteCommand(root *CommandNode, mgr *base.TaskActionManager, rl *readline.Instance, input string)

ExecuteCommand 执行命令

func GetCurrentReadlineInstance

func GetCurrentReadlineInstance() *readline.Instance

func GetFlagInt32

func GetFlagInt32(fs *flag.FlagSet, name string) int32

func GetFlagString

func GetFlagString(fs *flag.FlagSet, name string) string

func GetSetVars

func GetSetVars(fs *flag.FlagSet) map[string]string

GetSetVars 从已解析的 FlagSet 中提取 --set KEY=VALUE 变量并返回 map。

func HistoryCmd

func HistoryCmd(base.TaskActionImpl, []string) string

func NewCompleter

func NewCompleter(root *CommandNode) *readline.PrefixCompleter

构建自动补全器

func ParseSetFlags

func ParseSetFlags(sets []string) map[string]string

ParseSetFlags 将 ["KEY=VALUE", ...] 格式的字符串切片解析为 map。

func QuitCmd

func QuitCmd(base.TaskActionImpl, []string) string

func ReadLine

func ReadLine(root *CommandNode)

func RegisterCommand

func RegisterCommand(root *CommandNode, path []string, fn CommandFunc, argsInfo string, desc string,
	dynamicComplete readline.DynamicCompleteFunc, timeout time.Duration)

func RegisterCommandDefaultTimeout

func RegisterCommandDefaultTimeout(root *CommandNode, path []string, fn CommandFunc, argsInfo string, desc string,
	dynamicComplete readline.DynamicCompleteFunc)

func StdoutLog

func StdoutLog(log string)

Types

type CommandFunc

type CommandFunc func(base.TaskActionImpl, []string) string

type CommandNode

type CommandNode struct {
	Children        map[string]*CommandNode
	Name            string
	FullName        string
	Func            CommandFunc
	ArgsInfo        string
	Desc            string
	DynamicComplete readline.DynamicCompleteFunc
	Timeout         time.Duration
}

func CreateCommandNode

func CreateCommandNode() *CommandNode

func FindCommand

func FindCommand(root *CommandNode, path string) (args []string, node *CommandNode)

FindCommand 根据路径查找命令节点

func (*CommandNode) SelfHelpString

func (node *CommandNode) SelfHelpString() []string

type HistoryManager

type HistoryManager struct {
	File  string
	Items []string
	Set   map[string]struct{}
	// contains filtered or unexported fields
}

func NewHistoryManager

func NewHistoryManager(file string, cleanDuplicates bool) *HistoryManager

type StringSliceFlag

type StringSliceFlag []string

StringSliceFlag 支持多次指定的 flag（如 --set KEY=VAL --set FOO=BAR）

func (*StringSliceFlag) Set

func (s *StringSliceFlag) Set(val string) error

func (*StringSliceFlag) String

func (s *StringSliceFlag) String() string

type TaskActionCmd

type TaskActionCmd struct {
	base.TaskActionBase
	Fn func()
}

func (*TaskActionCmd) HookRun

func (t *TaskActionCmd) HookRun() error

func (*TaskActionCmd) Log

func (t *TaskActionCmd) Log(format string, a ...any)