Safe Haskell	Safe
Language	Haskell98

Language.Bash.Syntax

Contents

Commands
Redirections
Lists
Assignments

Description

Shell script types.

Synopsis

Commands

data Command Source

A Bash command with redirections.

Constructors

Command ShellCommand [Redir]

Instances

Eq Command Source
Data Command Source
Read Command Source
Show Command Source
Pretty Command Source

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 (CondExpr Word)	A Bash `[[...]]` conditional expression.
For String WordList List	A `for name in words` command. If `in words` is absent, the word list defaults to `"$@"`.
ArithFor String List	An arithmetic `for ((...))` command.
Select String WordList List	A `select name 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 Source
Data ShellCommand Source
Read ShellCommand Source
Show ShellCommand Source
Pretty ShellCommand Source

data WordList Source

A word list or "$@".

Constructors

Args
WordList [Word]

Instances

Eq WordList Source
Data WordList Source
Read WordList Source
Show WordList Source
Pretty WordList Source

data CaseClause Source

A single case clause.

Constructors

CaseClause [Word] List CaseTerm

Instances

Eq CaseClause Source
Data CaseClause Source
Read CaseClause Source
Show CaseClause Source
Pretty CaseClause Source

data CaseTerm Source

A case clause terminator.

Constructors

Break	;;
FallThrough	;&
Continue	;;&

Instances

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

Redirections

data Redir Source

A redirection.

Constructors

Redir	A redirection.
Fields redirDesc :: Maybe IODesc An optional file descriptor. redirOp :: RedirOp The redirection operator. redirTarget :: Word The redirection target.
Heredoc	A here document.
Fields heredocOp :: HeredocOp The here document operator. heredocDelim :: String The here document delimiter. heredocDelimQuoted :: Bool `True` if the delimiter was quoted. hereDocument :: Word The document itself, if the delimiter was quoted, no expansions are parsed. If the delimiter was not quoted, parameter, arithmetic and command substitutions take place.

Instances

Eq Redir Source
Data Redir Source
Read Redir Source
Show Redir Source
Pretty Redir Source

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 Source
Data IODesc Source
Read IODesc Source
Show IODesc Source
Pretty IODesc Source

data RedirOp Source

A redirection operator.

Constructors

In	<
Out	>
OutOr	>\|
Append	>>
AndOut	&>
AndAppend	&>>
HereString	<<<
InAnd	<&
OutAnd	>&
InOut	<>

Instances

Bounded RedirOp Source
Enum RedirOp Source
Eq RedirOp Source
Data RedirOp Source
Ord RedirOp Source
Read RedirOp Source
Show RedirOp Source
Pretty RedirOp Source

data HeredocOp Source

A here document operator.

Constructors

Here	<<
HereStrip	<<-

Instances

Bounded HeredocOp Source
Enum HeredocOp Source
Eq HeredocOp Source
Data HeredocOp Source
Ord HeredocOp Source
Read HeredocOp Source
Show HeredocOp Source
Pretty HeredocOp Source

Lists

newtype List Source

A compound list of statements.

Constructors

List [Statement]

Instances

Eq List Source
Data List Source
Read List Source
Show List Source
Pretty List Source

data Statement Source

A single statement in a list.

Constructors

Statement AndOr ListTerm

Instances

Eq Statement Source
Data Statement Source
Read Statement Source
Show Statement Source
Pretty Statement Source

data ListTerm Source

A statement terminator.

Constructors

Sequential	;
Asynchronous	&

Instances

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

data AndOr Source

A right-associative list of pipelines.

Constructors

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

Instances

Eq AndOr Source
Data AndOr Source
Read AndOr Source
Show AndOr Source
Pretty AndOr Source

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 Source
Data Pipeline Source
Read Pipeline Source
Show Pipeline Source
Pretty Pipeline Source

Assignments

data Assign Source

An assignment.

Constructors

Assign Parameter AssignOp RValue

Instances

Eq Assign Source
Data Assign Source
Read Assign Source
Show Assign Source
Pretty Assign Source

data AssignOp Source

An assignment operator.

Constructors

Equals	=
PlusEquals	+=

Instances

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

data RValue Source

The right side of an assignment.

Constructors

RValue Word	A simple word.
RArray [(Maybe Word, Word)]	An array assignment, as `(subscript, word)` pairs.

Instances

Eq RValue Source
Data RValue Source
Read RValue Source
Show RValue Source
Pretty RValue Source