Expand description
Defines abstract representations of the shell source.
Modules§
- builder
- Defines an interfaces to receive parse data and construct ASTs.
Structs§
- AndOr
List - A nonempty list of
AndOrcommands, e.g.foo && bar || baz. - Atomic
TopLevel Command - A top-level representation of a shell command. Uses
Arcwrappers for function declarations. - Atomic
TopLevel Word - A top-level representation of a shell word. Uses
Arcwrappers for function declarations. - Compound
Command - A class of commands where redirection is applied to a command group.
- Guard
Body Pair - A grouping of guard and body commands.
- Pattern
Body Pair - A grouping of patterns and body commands.
- Simple
Command - The simplest possible command: an executable with arguments, environment variable assignments, and redirections.
- TopLevel
Command - A top-level representation of a shell command. Uses
Rcwrappers for function declarations. - TopLevel
Word - A top-level representation of a shell word. Uses
Rcwrappers for function declarations.
Enums§
- AndOr
- A command which conditionally runs based on the exit status of the previous command.
- Arithmetic
- Represents an expression within an arithmetic subsitution.
- Command
- Represents any valid shell command.
- Complex
Word - Represents whitespace delimited text.
- Compound
Command Kind - A specific kind of a
CompoundCommand. - Listable
Command - Commands that can be used within an and/or list.
- Parameter
- Represents reading a parameter (or variable) value, e.g.
$foo. - Parameter
Substitution - A parameter substitution, e.g.
${param-word}. - Pipeable
Command - Commands that can be used within a pipeline.
- Redirect
- Represents redirecting a command’s file descriptors.
- Redirect
OrCmd Word - Represents a parsed redirect or a defined command or command argument.
- Redirect
OrEnv Var - Represents a parsed redirect or a defined environment variable at the start of a command.
- Simple
Word - Represents the smallest fragment of any text.
- Word
- Represents whitespace delimited single, double, or non quoted text.
Type Aliases§
- Atomic
Command List - A type alias over an and/or list of conventional shell commands.
- Atomic
Shell Pipeable Command - A type alias for the default hiearchy to represent pipeable commands,
using
Arcwrappers around function declarations. - Command
List - A type alias over an and/or list of conventional shell commands.
- Default
AndOr List - Type alias for the default
AndOrListrepresentation. - Default
Arithmetic - Type alias for the default
Arithmeticrepresentation. - Default
Command - Type alias for the default
Commandrepresentation. - Default
Complex Word - Type alias for the default
ComplexWordrepresentation. - Default
Compound Command - Type alias for the default
CompoundCommandKindrepresentation. - Default
Compound Command Kind - Type alias for the default
CompoundCommandKindrepresentation. - Default
Listable Command - Type alias for the default
ListableCommandrepresentation. - Default
Parameter - Type alias for the default
Parameterrepresentation. - Default
Parameter Substitution - Type alias for the default
ParameterSubstitutionrepresentation. - Default
Pipeable Command - Type alias for the default
PipeableCommandrepresentation. - Default
Redirect - Type alias for the default
Redirectrepresentation. - Default
Simple Command - Type alias for the default
SimpleCommandrepresentation. - Default
Simple Word - Type alias for the default
SimpleWordrepresentation. - Default
Word - Type alias for the default
Wordrepresentation. - Shell
Compound Command - A type alias for the default hiearchy for representing compound shell commands.
- Shell
Pipeable Command - A type alias for the default hiearchy to represent pipeable commands,
using
Rcwrappers around function declarations. - Shell
Word - A type alias for the default hiearchy for representing shell words.