Safe Haskell	Safe-Inferred

Language.Bash.Word

Contents

Words
Parameters
Process
Manipulation

Description

Bash words and substitutions.

Synopsis

Words

type Word = [Span]Source

A Bash word, broken up into logical spans.

data Span Source

An individual unit of a word.

Constructors

Char Char	A normal character.
Escape Char	An escaped character.
Single Word	A single-quoted string.
Double Word	A double-quoted string.
ANSIC Word	A ANSI C string.
Locale Word	A locale-translated string.
Backquote Word	A backquote-style command substitution. To extract the command string, `unquote` the word inside.
ParamSubst ParamSubst	A parameter substitution.
ArithSubst String	An arithmetic substitution.
CommandSubst String	A command substitution.
ProcessSubst ProcessSubstOp String	A process substitution.

Instances

Eq Span
Read Span
Show Span
IsString Word
Pretty Span

Parameters

data Parameter Source

A parameter name an optional subscript.

Constructors

Parameter String (Maybe Word)

Instances

Eq Parameter
Read Parameter
Show Parameter
Pretty Parameter

data ParamSubst Source

A parameter substitution.

Constructors

Bare
Fields parameter :: Parameter The parameter to substitute.
Brace
Fields indirect :: Bool Use indirect expansion. parameter :: Parameter The parameter to substitute.
Alt
Fields indirect :: Bool Use indirect expansion. parameter :: Parameter The parameter to substitute. testNull :: Bool Test for both existence and null values. altOp :: AltOp The operator. altWord :: Word The alternate word.
Substring
Fields indirect :: Bool Use indirect expansion. parameter :: Parameter The parameter to substitute. subOffset :: Word The substring offset. subLength :: Word The substring length, if any.
Prefix
Fields prefix :: String The variable prefix. modifier :: Char Either `@` of `*`.
Indices
Fields parameter :: Parameter The parameter to substitute.
Length
Fields parameter :: Parameter The parameter to substitute.
Delete
Fields indirect :: Bool Use indirect expansion. parameter :: Parameter The parameter to substitute. longest :: Bool Replace the longest match instead of the shortest match. deleteDirection :: Direction Where to delete from. pattern :: Word The replacement pattern.
Replace
Fields indirect :: Bool Use indirect expansion. parameter :: Parameter The parameter to substitute. replaceAll :: Bool Replace all occurences. replaceDirection :: Maybe Direction Where to replace. pattern :: Word The replacement pattern. replacement :: Word The replacement string.
LetterCase
Fields indirect :: Bool Use indirect expansion. parameter :: Parameter The parameter to substitute. letterCaseOp :: LetterCaseOp Convert to lowercase, not uppercase. convertAll :: Bool Convert all characters, not only the starts of words. pattern :: Word The replacement pattern.

Instances

Eq ParamSubst
Read ParamSubst
Show ParamSubst
Pretty ParamSubst

data AltOp Source

An alternation operator.

Constructors

AltDefault	`-`, `:-`
AltAssign	'=', `:=`
AltError	`?`, `:?`
AltReplace	`+`, `:+`

Instances

Bounded AltOp
Enum AltOp
Eq AltOp
Ord AltOp
Read AltOp
Show AltOp
Pretty AltOp

data LetterCaseOp Source

A letter case operator.

Constructors

ToLower
ToUpper

Instances

Bounded LetterCaseOp
Enum LetterCaseOp
Eq LetterCaseOp
Ord LetterCaseOp
Read LetterCaseOp
Show LetterCaseOp
Pretty LetterCaseOp

data Direction Source

A string direction.

Constructors

Front
Back

Instances

Bounded Direction
Enum Direction
Eq Direction
Ord Direction
Read Direction
Show Direction
Pretty Direction

Process

data ProcessSubstOp Source

A process substitution.

Constructors

ProcessIn	<
ProcessOut	>

Instances

Bounded ProcessSubstOp
Enum ProcessSubstOp
Eq ProcessSubstOp
Ord ProcessSubstOp
Read ProcessSubstOp
Show ProcessSubstOp
Pretty ProcessSubstOp

Manipulation

fromString :: String -> Word Source

Convert a string to an unquoted word.

unquote :: Word -> String Source

Remove all quoting characters from a word.