comp

Documentation

Overview

scripthaus completion

Index

• Constants
• Variables
• func RegisterSimpleCompFn(compType string, fn SimpleCompGenFnType)
• func SortCompReturnEntries(c *CompReturn)
• type CompContext
• type CompEntry
• type CompPoint
  • func ParseCompPoint(cmdStr utilfn.StrWithPos) *CompPoint
  • func (p *CompPoint) FullyExtend(crtn *CompReturn) utilfn.StrWithPos
• type CompReturn
  • func CombineCompReturn(compType string, c1 *CompReturn, c2 *CompReturn) *CompReturn
  • func DoCompGen(ctx context.Context, cmdStr utilfn.StrWithPos, compCtx CompContext) (*CompReturn, *utilfn.StrWithPos, error)
  • func DoCompGenOld(ctx context.Context, sp utilfn.StrWithPos, compCtx CompContext) (*CompReturn, *utilfn.StrWithPos, error)
  • func DoSimpleComp(ctx context.Context, compType string, prefix string, compCtx CompContext, ...) (*CompReturn, error)
  • func (c *CompReturn) GetCompDisplayStrs() []string
  • func (c *CompReturn) GetCompStrs() []string
• type ParsedWord
• type SimpleCompGenFnType

Constants

const (
	// local to simplecomp
	CGTypeCommand  = "command"
	CGTypeFile     = "file"
	CGTypeDir      = "directory"
	CGTypeVariable = "variable"

	// implemented in cmdrunner
	CGTypeMeta        = "metacmd"
	CGTypeCommandMeta = "command+meta"

	CGTypeRemote         = "remote"
	CGTypeRemoteInstance = "remoteinstance"
	CGTypeGlobalCmd      = "globalcmd"
)

const (
	QuoteTypeLiteral = ""
	QuoteTypeDQ      = "\""
	QuoteTypeANSI    = "$'"
	QuoteTypeSQ      = "'"
)

const MaxCompQuoteLen = 5000

Variables

var SimpleCompGenFns map[string]SimpleCompGenFnType

Functions

func RegisterSimpleCompFn

func RegisterSimpleCompFn(compType string, fn SimpleCompGenFnType)

func SortCompReturnEntries

func SortCompReturnEntries(c *CompReturn)

Types

type CompContext

type CompContext struct {
	RemotePtr  *sstore.RemotePtrType
	Cwd        string
	ForDisplay bool
}

type CompEntry

type CompEntry struct {
	Word      string
	IsMetaCmd bool
}

directories will have a trailing "/"

type CompPoint

type CompPoint struct {
	StmtStr     string
	Words       []ParsedWord
	CompWord    int
	CompWordPos int
	Prefix      string
	Suffix      string
}

func ParseCompPoint

func ParseCompPoint(cmdStr utilfn.StrWithPos) *CompPoint

func (*CompPoint) FullyExtend

func (p *CompPoint) FullyExtend(crtn *CompReturn) utilfn.StrWithPos

type CompReturn

type CompReturn struct {
	CompType string
	Entries  []CompEntry
	HasMore  bool
}

func CombineCompReturn

func CombineCompReturn(compType string, c1 *CompReturn, c2 *CompReturn) *CompReturn

func DoCompGen

func DoCompGen(ctx context.Context, cmdStr utilfn.StrWithPos, compCtx CompContext) (*CompReturn, *utilfn.StrWithPos, error)

func DoCompGenOld

func DoCompGenOld(ctx context.Context, sp utilfn.StrWithPos, compCtx CompContext) (*CompReturn, *utilfn.StrWithPos, error)

func DoSimpleComp

func DoSimpleComp(ctx context.Context, compType string, prefix string, compCtx CompContext, args []interface{}) (*CompReturn, error)

func (*CompReturn) GetCompDisplayStrs

func (c *CompReturn) GetCompDisplayStrs() []string

func (*CompReturn) GetCompStrs

func (c *CompReturn) GetCompStrs() []string

type ParsedWord

type ParsedWord struct {
	Offset      int
	Word        *syntax.Word
	PartialWord string
	Prefix      string
}

type SimpleCompGenFnType

type SimpleCompGenFnType = func(ctx context.Context, prefix string, compCtx CompContext, args []interface{}) (*CompReturn, error)