Safe Haskell	Safe-Inferred

Language.Bash.Syntax

Contents

Syntax
- Words
- Commands
Lists
Assignments
Syntax elements

Description

Shell script types.

Synopsis

Syntax

Words

type Word = String Source

A Bash word.

type Subscript = Word Source

A variable subscript [...].

Commands

data Command Source

A Bash command with redirections.

Constructors

Command ShellCommand [Redir]

Instances

Eq Command
Read Command
Show Command
Pretty Command

data Redir Source

A redirection.

Constructors

Redir	A redirection.
Fields redirDesc :: Maybe IODesc An optional file descriptor. redirOp :: String The redirection operator. redirTarget :: Word The redirection target.
Heredoc	A here document.
Fields redirOp :: String The redirection operator. heredocDelim :: String The here document delimiter. heredocDelimQuoted :: Bool `True` if the delimiter was quoted. document :: String The document itself.

Instances

Eq Redir
Read Redir
Show Redir
Pretty Redir

data IODesc Source

A redirection file descriptor.

Constructors

IONumber Int	A file descriptor number.
IOVar String	A variable `{varname}` to allocate a file descriptor for.

Instances

Eq IODesc
Read IODesc
Show IODesc
Pretty IODesc

data ShellCommand Source

A Bash command.

Constructors

SimpleCommand [Assign] [Word]	A simple command consisting of assignments followed by words.
AssignBuiltin Word [Either Assign Word]	The shell builtins `declare`, `eval`, `export`, `local`, `readonly`, and `typeset` can accept both assignments and words as arguments.
FunctionDef String List	A function name and definition.
Coproc String Command	A named coprocess.
Subshell List	A `(...)` list, denoting a subshell.
Group List	A `{...}` list.
Arith String	An arithmetic expression.
Cond [Word]	A Bash `[[...]]` conditional expression.
For Word [Word] List	A `for word in words` command. If `in words` is absent, the word list defaults to `"$@"`.
ArithFor String List	An arithmetic `for ((...))` command.
Select Word [Word] List	A `select word in words` command. If `in words` is absent, the word list defaults to `"$@"`.
Case Word [CaseClause]	A `case` command.
If List List (Maybe List)	An `if` command, with a predicate, consequent, and alternative. `elif` clauses are parsed as nested `if` statements.
Until List List	An `until` command.
While List List	A `while` command.

Instances

Eq ShellCommand
Read ShellCommand
Show ShellCommand
Pretty ShellCommand

data CaseClause Source

A single case clause.

Constructors

CaseClause [Word] List CaseTerm

Instances

Eq CaseClause
Read CaseClause
Show CaseClause
Pretty CaseClause

data CaseTerm Source

A case clause terminator.

Constructors

Break	The `;;` operator.
FallThrough	The `;&` operator.
Continue	The `;;&` operator.

Instances

Bounded CaseTerm
Enum CaseTerm
Eq CaseTerm
Ord CaseTerm
Read CaseTerm
Show CaseTerm
Pretty CaseTerm

Lists

newtype List Source

A compound list of statements.

Constructors

List [Statement]

Instances

Eq List
Read List
Show List
Pretty List

data Statement Source

A single statement in a list.

Constructors

Statement AndOr ListTerm

Instances

Eq Statement
Read Statement
Show Statement
Pretty Statement

data ListTerm Source

A statement terminator.

Constructors

Sequential	The `;` operator.
Asynchronous	The `&` operator.

Instances

Bounded ListTerm
Enum ListTerm
Eq ListTerm
Ord ListTerm
Read ListTerm
Show ListTerm
Pretty ListTerm

data AndOr Source

A right-associative list of pipelines.

Constructors

Last Pipeline	The last pipeline of a list.
And Pipeline AndOr	An `&&` construct.
Or Pipeline AndOr	An `\|\|` construct.

Instances

Eq AndOr
Read AndOr
Show AndOr
Pretty AndOr

data Pipeline Source

A (possibly timed or inverted) pipeline, linked with | or |&.

Constructors

Pipeline
Fields timed :: Bool `True` if the pipeline is timed with `time`. timedPosix :: Bool `True` if the pipeline is timed with the `-p` flag. inverted :: Bool `True` if the pipeline is inverted with `!`. commands :: [Command] A list of commands, separated by `\|`, or `\|&`. `command1 \|& command2` is treated as a shorthand for `command1 2>&1 \| command2`.

Instances

Eq Pipeline
Read Pipeline
Show Pipeline
Pretty Pipeline

Assignments

data Assign Source

An assignment.

Constructors

Assign LValue AssignOp RValue

Instances

Eq Assign
Read Assign
Show Assign
Pretty Assign

data LValue Source

The left side of an assignment.

Constructors

LValue String (Maybe Subscript)

Instances

Eq LValue
Read LValue
Show LValue
Pretty LValue

data AssignOp Source

An assignment operator.

Constructors

Equals	The `=` operator.
PlusEquals	The `+=` operator.

Instances

Bounded AssignOp
Enum AssignOp
Eq AssignOp
Ord AssignOp
Read AssignOp
Show AssignOp
Pretty AssignOp

data RValue Source

The right side of an assignment.

Constructors

RValue Word	A simple word.
RArray [(Maybe Subscript, Word)]	An array assignment.

Instances

Eq RValue
Read RValue
Show RValue
Pretty RValue

Syntax elements

reservedWords :: [Word]Source

Shell reserved words.

assignBuiltins :: [Word]Source

Shell assignment builtins. These builtins can take assignments as arguments.

redirOps :: [String]Source

Redirection operators, not including here document operators.

heredocOps :: [String]Source

Here document operators.

controlOps :: [String]Source

Shell control operators.

normalOps :: [String]Source

All normal operators.