Language.Bash.Word

Bash words and substitutions.

Words

type Word = [Span]

A Bash word, broken up into logical spans.

data Span

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

Methods

(==) :: Span -> Span -> Bool

(/=) :: Span -> Span -> Bool

Data Span

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Span -> c Span

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Span

toConstr :: Span -> Constr

dataTypeOf :: Span -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Span)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Span)

gmapT :: (forall b. Data b => b -> b) -> Span -> Span

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Span -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Span -> r

gmapQ :: (forall d. Data d => d -> u) -> Span -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Span -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Span -> m Span

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Span -> m Span

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Span -> m Span

Read Span

Methods

readsPrec :: Int -> ReadS Span

readList :: ReadS [Span]

readPrec :: ReadPrec Span

readListPrec :: ReadPrec [Span]

Show Span

Methods

showsPrec :: Int -> Span -> ShowS

show :: Span -> String

showList :: [Span] -> ShowS

Pretty Span

Methods

pretty :: Span -> Doc

prettyList :: [Span] -> Doc

Parameters

data Parameter

A parameter name an optional subscript.

Constructors

Parameter String (Maybe Word)

Instances

Eq Parameter

Methods

(==) :: Parameter -> Parameter -> Bool

(/=) :: Parameter -> Parameter -> Bool

Data Parameter

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Parameter -> c Parameter

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Parameter

toConstr :: Parameter -> Constr

dataTypeOf :: Parameter -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Parameter)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Parameter)

gmapT :: (forall b. Data b => b -> b) -> Parameter -> Parameter

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Parameter -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Parameter -> r

gmapQ :: (forall d. Data d => d -> u) -> Parameter -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Parameter -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Parameter -> m Parameter

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Parameter -> m Parameter

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Parameter -> m Parameter

Read Parameter

Methods

readsPrec :: Int -> ReadS Parameter

readList :: ReadS [Parameter]

readPrec :: ReadPrec Parameter

readListPrec :: ReadPrec [Parameter]

Show Parameter

Methods

showsPrec :: Int -> Parameter -> ShowS

show :: Parameter -> String

showList :: [Parameter] -> ShowS

Pretty Parameter

Methods

pretty :: Parameter -> Doc

prettyList :: [Parameter] -> Doc

data ParamSubst

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

Methods

(==) :: ParamSubst -> ParamSubst -> Bool

(/=) :: ParamSubst -> ParamSubst -> Bool

Data ParamSubst

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ParamSubst -> c ParamSubst

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ParamSubst

toConstr :: ParamSubst -> Constr

dataTypeOf :: ParamSubst -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ParamSubst)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ParamSubst)

gmapT :: (forall b. Data b => b -> b) -> ParamSubst -> ParamSubst

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ParamSubst -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ParamSubst -> r

gmapQ :: (forall d. Data d => d -> u) -> ParamSubst -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ParamSubst -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ParamSubst -> m ParamSubst

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ParamSubst -> m ParamSubst

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ParamSubst -> m ParamSubst

Read ParamSubst

Methods

readsPrec :: Int -> ReadS ParamSubst

readList :: ReadS [ParamSubst]

readPrec :: ReadPrec ParamSubst

readListPrec :: ReadPrec [ParamSubst]

Show ParamSubst

Methods

showsPrec :: Int -> ParamSubst -> ShowS

show :: ParamSubst -> String

showList :: [ParamSubst] -> ShowS

Pretty ParamSubst

Methods

pretty :: ParamSubst -> Doc

prettyList :: [ParamSubst] -> Doc

data AltOp

An alternation operator.

Constructors

AltDefault

-, :-

AltAssign

'=', :=

AltError

?, :?

AltReplace

+, :+

Instances

Bounded AltOp

Methods

minBound :: AltOp

maxBound :: AltOp

Enum AltOp

Methods

succ :: AltOp -> AltOp

pred :: AltOp -> AltOp

toEnum :: Int -> AltOp

fromEnum :: AltOp -> Int

enumFrom :: AltOp -> [AltOp]

enumFromThen :: AltOp -> AltOp -> [AltOp]

enumFromTo :: AltOp -> AltOp -> [AltOp]

enumFromThenTo :: AltOp -> AltOp -> AltOp -> [AltOp]

Eq AltOp

Methods

(==) :: AltOp -> AltOp -> Bool

(/=) :: AltOp -> AltOp -> Bool

Data AltOp

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AltOp -> c AltOp

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AltOp

toConstr :: AltOp -> Constr

dataTypeOf :: AltOp -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c AltOp)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AltOp)

gmapT :: (forall b. Data b => b -> b) -> AltOp -> AltOp

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AltOp -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AltOp -> r

gmapQ :: (forall d. Data d => d -> u) -> AltOp -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> AltOp -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> AltOp -> m AltOp

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AltOp -> m AltOp

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AltOp -> m AltOp

Ord AltOp

Methods

compare :: AltOp -> AltOp -> Ordering

(<) :: AltOp -> AltOp -> Bool

(<=) :: AltOp -> AltOp -> Bool

(>) :: AltOp -> AltOp -> Bool

(>=) :: AltOp -> AltOp -> Bool

max :: AltOp -> AltOp -> AltOp

min :: AltOp -> AltOp -> AltOp

Read AltOp

Methods

readsPrec :: Int -> ReadS AltOp

readList :: ReadS [AltOp]

readPrec :: ReadPrec AltOp

readListPrec :: ReadPrec [AltOp]

Show AltOp

Methods

showsPrec :: Int -> AltOp -> ShowS

show :: AltOp -> String

showList :: [AltOp] -> ShowS

Pretty AltOp

Methods

pretty :: AltOp -> Doc

prettyList :: [AltOp] -> Doc

data LetterCaseOp

A letter case operator.

Constructors

ToLower

ToUpper

Instances

Bounded LetterCaseOp

Methods

minBound :: LetterCaseOp

maxBound :: LetterCaseOp

Enum LetterCaseOp

Methods

succ :: LetterCaseOp -> LetterCaseOp

pred :: LetterCaseOp -> LetterCaseOp

toEnum :: Int -> LetterCaseOp

fromEnum :: LetterCaseOp -> Int

enumFrom :: LetterCaseOp -> [LetterCaseOp]

enumFromThen :: LetterCaseOp -> LetterCaseOp -> [LetterCaseOp]

enumFromTo :: LetterCaseOp -> LetterCaseOp -> [LetterCaseOp]

enumFromThenTo :: LetterCaseOp -> LetterCaseOp -> LetterCaseOp -> [LetterCaseOp]

Eq LetterCaseOp

Methods

(==) :: LetterCaseOp -> LetterCaseOp -> Bool

(/=) :: LetterCaseOp -> LetterCaseOp -> Bool

Data LetterCaseOp

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> LetterCaseOp -> c LetterCaseOp

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c LetterCaseOp

toConstr :: LetterCaseOp -> Constr

dataTypeOf :: LetterCaseOp -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c LetterCaseOp)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c LetterCaseOp)

gmapT :: (forall b. Data b => b -> b) -> LetterCaseOp -> LetterCaseOp

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> LetterCaseOp -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> LetterCaseOp -> r

gmapQ :: (forall d. Data d => d -> u) -> LetterCaseOp -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> LetterCaseOp -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> LetterCaseOp -> m LetterCaseOp

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> LetterCaseOp -> m LetterCaseOp

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> LetterCaseOp -> m LetterCaseOp

Ord LetterCaseOp

Methods

compare :: LetterCaseOp -> LetterCaseOp -> Ordering

(<) :: LetterCaseOp -> LetterCaseOp -> Bool

(<=) :: LetterCaseOp -> LetterCaseOp -> Bool

(>) :: LetterCaseOp -> LetterCaseOp -> Bool

(>=) :: LetterCaseOp -> LetterCaseOp -> Bool

max :: LetterCaseOp -> LetterCaseOp -> LetterCaseOp

min :: LetterCaseOp -> LetterCaseOp -> LetterCaseOp

Read LetterCaseOp

Methods

readsPrec :: Int -> ReadS LetterCaseOp

readList :: ReadS [LetterCaseOp]

readPrec :: ReadPrec LetterCaseOp

readListPrec :: ReadPrec [LetterCaseOp]

Show LetterCaseOp

Methods

showsPrec :: Int -> LetterCaseOp -> ShowS

show :: LetterCaseOp -> String

showList :: [LetterCaseOp] -> ShowS

Pretty LetterCaseOp

Methods

pretty :: LetterCaseOp -> Doc

prettyList :: [LetterCaseOp] -> Doc

data Direction

A string direction.

Constructors

Front

Back

Instances

Bounded Direction

Methods

minBound :: Direction

maxBound :: Direction

Enum Direction

Methods

succ :: Direction -> Direction

pred :: Direction -> Direction

toEnum :: Int -> Direction

fromEnum :: Direction -> Int

enumFrom :: Direction -> [Direction]

enumFromThen :: Direction -> Direction -> [Direction]

enumFromTo :: Direction -> Direction -> [Direction]

enumFromThenTo :: Direction -> Direction -> Direction -> [Direction]

Eq Direction

Methods

(==) :: Direction -> Direction -> Bool

(/=) :: Direction -> Direction -> Bool

Data Direction

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Direction -> c Direction

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Direction

toConstr :: Direction -> Constr

dataTypeOf :: Direction -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Direction)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Direction)

gmapT :: (forall b. Data b => b -> b) -> Direction -> Direction

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Direction -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Direction -> r

gmapQ :: (forall d. Data d => d -> u) -> Direction -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Direction -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Direction -> m Direction

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Direction -> m Direction

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Direction -> m Direction

Ord Direction

Methods

compare :: Direction -> Direction -> Ordering

(<) :: Direction -> Direction -> Bool

(<=) :: Direction -> Direction -> Bool

(>) :: Direction -> Direction -> Bool

(>=) :: Direction -> Direction -> Bool

max :: Direction -> Direction -> Direction

min :: Direction -> Direction -> Direction

Read Direction

Methods

readsPrec :: Int -> ReadS Direction

readList :: ReadS [Direction]

readPrec :: ReadPrec Direction

readListPrec :: ReadPrec [Direction]

Show Direction

Methods

showsPrec :: Int -> Direction -> ShowS

show :: Direction -> String

showList :: [Direction] -> ShowS

Pretty Direction

Methods

pretty :: Direction -> Doc

prettyList :: [Direction] -> Doc

Process

data ProcessSubstOp

A process substitution.

Constructors

ProcessIn

<

ProcessOut

>

Instances

Bounded ProcessSubstOp

Methods

minBound :: ProcessSubstOp

maxBound :: ProcessSubstOp

Enum ProcessSubstOp

Methods

succ :: ProcessSubstOp -> ProcessSubstOp

pred :: ProcessSubstOp -> ProcessSubstOp

toEnum :: Int -> ProcessSubstOp

fromEnum :: ProcessSubstOp -> Int

enumFrom :: ProcessSubstOp -> [ProcessSubstOp]

enumFromThen :: ProcessSubstOp -> ProcessSubstOp -> [ProcessSubstOp]

enumFromTo :: ProcessSubstOp -> ProcessSubstOp -> [ProcessSubstOp]

enumFromThenTo :: ProcessSubstOp -> ProcessSubstOp -> ProcessSubstOp -> [ProcessSubstOp]

Eq ProcessSubstOp

Methods

(==) :: ProcessSubstOp -> ProcessSubstOp -> Bool

(/=) :: ProcessSubstOp -> ProcessSubstOp -> Bool

Data ProcessSubstOp

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ProcessSubstOp -> c ProcessSubstOp

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ProcessSubstOp

toConstr :: ProcessSubstOp -> Constr

dataTypeOf :: ProcessSubstOp -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ProcessSubstOp)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ProcessSubstOp)

gmapT :: (forall b. Data b => b -> b) -> ProcessSubstOp -> ProcessSubstOp

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ProcessSubstOp -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ProcessSubstOp -> r

gmapQ :: (forall d. Data d => d -> u) -> ProcessSubstOp -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ProcessSubstOp -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ProcessSubstOp -> m ProcessSubstOp

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ProcessSubstOp -> m ProcessSubstOp

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ProcessSubstOp -> m ProcessSubstOp

Ord ProcessSubstOp

Methods

compare :: ProcessSubstOp -> ProcessSubstOp -> Ordering

(<) :: ProcessSubstOp -> ProcessSubstOp -> Bool

(<=) :: ProcessSubstOp -> ProcessSubstOp -> Bool

(>) :: ProcessSubstOp -> ProcessSubstOp -> Bool

(>=) :: ProcessSubstOp -> ProcessSubstOp -> Bool

max :: ProcessSubstOp -> ProcessSubstOp -> ProcessSubstOp

min :: ProcessSubstOp -> ProcessSubstOp -> ProcessSubstOp

Read ProcessSubstOp

Methods

readsPrec :: Int -> ReadS ProcessSubstOp

readList :: ReadS [ProcessSubstOp]

readPrec :: ReadPrec ProcessSubstOp

readListPrec :: ReadPrec [ProcessSubstOp]

Show ProcessSubstOp

Methods

showsPrec :: Int -> ProcessSubstOp -> ShowS

show :: ProcessSubstOp -> String

showList :: [ProcessSubstOp] -> ShowS

Pretty ProcessSubstOp

Methods

pretty :: ProcessSubstOp -> Doc

prettyList :: [ProcessSubstOp] -> Doc

Manipulation

stringToWord :: String -> Word

Convert a string to an unquoted word.

unquote :: Word -> String

Remove all quoting characters from a word.