shellstate

Documentation

Index

• Constants
• func ProcessGroupFromContext(ctx context.Context) (int, bool)
• func WithCompletionState(ctx context.Context, state *CompletionState) context.Context
• func WithProcessGroup(ctx context.Context, pgrp int) context.Context
• func WithShellVarAssignments(ctx context.Context, state *ShellVarAssignments) context.Context
• func WithShellVarLookup(ctx context.Context, lookup ShellVarLookup) context.Context
• func WithSignalDispatcher(ctx context.Context, dispatcher SignalDispatcher) context.Context
• func WithSignalFamily(ctx context.Context, family SignalFamily) context.Context
• type CompletionSpec
• type CompletionState
  • func CompletionStateFromContext(ctx context.Context) *CompletionState
  • func NewCompletionState() *CompletionState
  • func (s *CompletionState) Clear()
  • func (s *CompletionState) Delete(name string)
  • func (s *CompletionState) Get(name string) (CompletionSpec, bool)
  • func (s *CompletionState) Keys() []string
  • func (s *CompletionState) Set(name string, spec *CompletionSpec)
  • func (s *CompletionState) Update(name string, fn func(*CompletionSpec)) CompletionSpec
• type ShellVarAssignments
  • func NewShellVarAssignments() *ShellVarAssignments
  • func ShellVarAssignmentsFromContext(ctx context.Context) *ShellVarAssignments
  • func (s *ShellVarAssignments) Set(name, value string)
  • func (s *ShellVarAssignments) Snapshot() map[string]ShellVarUpdate
  • func (s *ShellVarAssignments) Unset(name string)
• type ShellVarLookup
  • func ShellVarLookupFromContext(ctx context.Context) ShellVarLookup
• type ShellVarUpdate
• type SignalDispatcher
  • func SignalDispatcherFromContext(ctx context.Context) SignalDispatcher
• type SignalFamily
  • func SignalFamilyFromContext(ctx context.Context) (SignalFamily, bool)

Constants

const (
	CompletionSpecDefaultKey = "__default__"
	CompletionSpecEmptyKey   = "__empty__"
)

Functions

func ProcessGroupFromContext

func ProcessGroupFromContext(ctx context.Context) (int, bool)

func WithCompletionState

func WithCompletionState(ctx context.Context, state *CompletionState) context.Context

func WithProcessGroup

func WithProcessGroup(ctx context.Context, pgrp int) context.Context

func WithShellVarAssignments

func WithShellVarAssignments(ctx context.Context, state *ShellVarAssignments) context.Context

func WithShellVarLookup

func WithShellVarLookup(ctx context.Context, lookup ShellVarLookup) context.Context

func WithSignalDispatcher

func WithSignalDispatcher(ctx context.Context, dispatcher SignalDispatcher) context.Context

func WithSignalFamily

func WithSignalFamily(ctx context.Context, family SignalFamily) context.Context

Types

type CompletionSpec

type CompletionSpec struct {
	IsDefault   bool
	IsEmptyLine bool
	Wordlist    string
	HasWordlist bool
	Function    string
	HasFunction bool
	Command     string
	HasCommand  bool
	Filter      string
	HasFilter   bool
	Prefix      string
	HasPrefix   bool
	Suffix      string
	HasSuffix   bool
	Options     []string
	Actions     []string
}

type CompletionState

type CompletionState struct {
	// contains filtered or unexported fields
}

func CompletionStateFromContext

func CompletionStateFromContext(ctx context.Context) *CompletionState

func NewCompletionState

func NewCompletionState() *CompletionState

func (*CompletionState) Clear

func (s *CompletionState) Clear()

func (*CompletionState) Delete

func (s *CompletionState) Delete(name string)

func (*CompletionState) Get

func (s *CompletionState) Get(name string) (CompletionSpec, bool)

func (*CompletionState) Keys

func (s *CompletionState) Keys() []string

func (*CompletionState) Set

func (s *CompletionState) Set(name string, spec *CompletionSpec)

func (*CompletionState) Update

func (s *CompletionState) Update(name string, fn func(*CompletionSpec)) CompletionSpec

type ShellVarAssignments

type ShellVarAssignments struct {
	// contains filtered or unexported fields
}

func NewShellVarAssignments

func NewShellVarAssignments() *ShellVarAssignments

func ShellVarAssignmentsFromContext

func ShellVarAssignmentsFromContext(ctx context.Context) *ShellVarAssignments

func (*ShellVarAssignments) Set

func (s *ShellVarAssignments) Set(name, value string)

func (*ShellVarAssignments) Snapshot

func (s *ShellVarAssignments) Snapshot() map[string]ShellVarUpdate

func (*ShellVarAssignments) Unset

func (s *ShellVarAssignments) Unset(name string)

type ShellVarLookup

type ShellVarLookup func(name string) (string, bool)

func ShellVarLookupFromContext

func ShellVarLookupFromContext(ctx context.Context) ShellVarLookup

type ShellVarUpdate

type ShellVarUpdate struct {
	Value string
	Unset bool
}

type SignalDispatcher

type SignalDispatcher func(target string, signal int) error

func SignalDispatcherFromContext

func SignalDispatcherFromContext(ctx context.Context) SignalDispatcher

type SignalFamily

type SignalFamily struct {
	Owner         any
	StablePID     int
	ParentBASHPID int
}

func SignalFamilyFromContext

func SignalFamilyFromContext(ctx context.Context) (SignalFamily, bool)