-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Parsing and pretty-printing Bash shell scripts
--   
--   A library for parsing, pretty-printing, and manipulating Bash shell
--   scripts.
@package language-bash
@version 0.11.0


-- | Bash conditional commands.
module Language.Bash.Cond

-- | Bash conditional expressions.
data CondExpr a
Unary :: UnaryOp -> a -> CondExpr a
Binary :: a -> BinaryOp -> a -> CondExpr a
Not :: CondExpr a -> CondExpr a
And :: CondExpr a -> CondExpr a -> CondExpr a
Or :: CondExpr a -> CondExpr a -> CondExpr a

-- | Unary conditional operators.
data UnaryOp

-- | <pre>
--   -b
--   </pre>
BlockFile :: UnaryOp

-- | <pre>
--   -c
--   </pre>
CharacterFile :: UnaryOp

-- | <pre>
--   -d
--   </pre>
Directory :: UnaryOp

-- | <tt>-e</tt>, <tt>-a</tt>
FileExists :: UnaryOp

-- | <pre>
--   -f
--   </pre>
RegularFile :: UnaryOp

-- | <pre>
--   -g
--   </pre>
SetGID :: UnaryOp

-- | <pre>
--   -k
--   </pre>
Sticky :: UnaryOp

-- | <pre>
--   -p
--   </pre>
NamedPipe :: UnaryOp

-- | <pre>
--   -r
--   </pre>
Readable :: UnaryOp

-- | <pre>
--   -s
--   </pre>
FileSize :: UnaryOp

-- | <pre>
--   -t
--   </pre>
Terminal :: UnaryOp

-- | <pre>
--   -u
--   </pre>
SetUID :: UnaryOp

-- | <pre>
--   -w
--   </pre>
Writable :: UnaryOp

-- | <pre>
--   -x
--   </pre>
Executable :: UnaryOp

-- | <pre>
--   -G
--   </pre>
GroupOwned :: UnaryOp

-- | <tt>-L</tt>, <tt>-h</tt>
SymbolicLink :: UnaryOp

-- | <pre>
--   -N
--   </pre>
Modified :: UnaryOp

-- | <pre>
--   -O
--   </pre>
UserOwned :: UnaryOp

-- | <pre>
--   -S
--   </pre>
Socket :: UnaryOp

-- | <pre>
--   -o
--   </pre>
Optname :: UnaryOp

-- | <pre>
--   -v
--   </pre>
Varname :: UnaryOp

-- | <pre>
--   -z
--   </pre>
ZeroString :: UnaryOp

-- | <tt>-n <i>string</i></tt> or <tt><i>string</i></tt>
NonzeroString :: UnaryOp

-- | Binary conditional operators.
data BinaryOp

-- | <pre>
--   -ef
--   </pre>
SameFile :: BinaryOp

-- | <pre>
--   -nt
--   </pre>
NewerThan :: BinaryOp

-- | <pre>
--   -ot
--   </pre>
OlderThan :: BinaryOp

-- | <pre>
--   =~
--   </pre>
StrMatch :: BinaryOp

-- | <tt>==</tt>, <tt>=</tt>
StrEQ :: BinaryOp

-- | <pre>
--   !=
--   </pre>
StrNE :: BinaryOp

-- | <pre>
--   &lt;
--   </pre>
StrLT :: BinaryOp

-- | <pre>
--   &gt;
--   </pre>
StrGT :: BinaryOp

-- | <pre>
--   -eq
--   </pre>
ArithEQ :: BinaryOp

-- | <pre>
--   -ne
--   </pre>
ArithNE :: BinaryOp

-- | <pre>
--   -lt
--   </pre>
ArithLT :: BinaryOp

-- | <pre>
--   -le
--   </pre>
ArithLE :: BinaryOp

-- | <pre>
--   -gt
--   </pre>
ArithGT :: BinaryOp

-- | <pre>
--   -ge
--   </pre>
ArithGE :: BinaryOp

-- | Parse a conditional expression for the Bash <tt>test</tt> builtin.
parseTestExpr :: [String] -> Either ParseError (CondExpr String)
instance GHC.Generics.Generic Language.Bash.Cond.UnaryOp
instance GHC.Enum.Bounded Language.Bash.Cond.UnaryOp
instance GHC.Enum.Enum Language.Bash.Cond.UnaryOp
instance GHC.Show.Show Language.Bash.Cond.UnaryOp
instance GHC.Read.Read Language.Bash.Cond.UnaryOp
instance GHC.Classes.Ord Language.Bash.Cond.UnaryOp
instance GHC.Classes.Eq Language.Bash.Cond.UnaryOp
instance Data.Data.Data Language.Bash.Cond.UnaryOp
instance GHC.Generics.Generic Language.Bash.Cond.BinaryOp
instance GHC.Enum.Bounded Language.Bash.Cond.BinaryOp
instance GHC.Enum.Enum Language.Bash.Cond.BinaryOp
instance GHC.Show.Show Language.Bash.Cond.BinaryOp
instance GHC.Read.Read Language.Bash.Cond.BinaryOp
instance GHC.Classes.Ord Language.Bash.Cond.BinaryOp
instance GHC.Classes.Eq Language.Bash.Cond.BinaryOp
instance Data.Data.Data Language.Bash.Cond.BinaryOp
instance GHC.Generics.Generic (Language.Bash.Cond.CondExpr a)
instance Data.Traversable.Traversable Language.Bash.Cond.CondExpr
instance Data.Foldable.Foldable Language.Bash.Cond.CondExpr
instance GHC.Base.Functor Language.Bash.Cond.CondExpr
instance GHC.Show.Show a => GHC.Show.Show (Language.Bash.Cond.CondExpr a)
instance GHC.Read.Read a => GHC.Read.Read (Language.Bash.Cond.CondExpr a)
instance GHC.Classes.Eq a => GHC.Classes.Eq (Language.Bash.Cond.CondExpr a)
instance Data.Data.Data a => Data.Data.Data (Language.Bash.Cond.CondExpr a)
instance Prettyprinter.Internal.Pretty a => Prettyprinter.Internal.Pretty (Language.Bash.Cond.CondExpr a)
instance Language.Bash.Operator.Operator Language.Bash.Cond.BinaryOp
instance Prettyprinter.Internal.Pretty Language.Bash.Cond.BinaryOp
instance Language.Bash.Operator.Operator Language.Bash.Cond.UnaryOp
instance Prettyprinter.Internal.Pretty Language.Bash.Cond.UnaryOp


-- | Pretty-printing of Bash scripts. This tries to stay close to the
--   format used by the Bash builtin <tt>declare -f</tt>.
module Language.Bash.Pretty

-- | <tt>x $+$ y</tt> concatenates <tt>x</tt> and <tt>y</tt> with a
--   <a>line</a> in between
($+$) :: Doc ann -> Doc ann -> Doc ann

-- | Behaves like <a>$+$</a> except that if one of the documents was empty
--   we do not concatenate at all. <a>mempty</a> is the identity of
--   <a>$+$</a>:
--   
--   <pre>
--   x $++$ mempty == x
--   </pre>
--   
--   and
--   
--   <pre>
--   mempty $++$ y == y
--   </pre>
($++$) :: Doc ann -> Doc ann -> Doc ann

-- | Behaves like <a>&lt;+&gt;</a> except that if one of the documents was
--   empty we do not concatenate at all. <a>mempty</a> is the identity of
--   <a>&lt;+&gt;</a>:
--   
--   <pre>
--   x &lt;++&gt; mempty == x
--   </pre>
--   
--   and
--   
--   <pre>
--   mempty &lt;++&gt; y == y
--   </pre>
(<++>) :: Doc ann -> Doc ann -> Doc ann

-- | Pretty-print to a <a>String</a>.
prettyText :: Pretty a => a -> String


-- | Bash words and substitutions.
module Language.Bash.Word

-- | A Bash word, broken up into logical spans.
type Word = [Span]

-- | An individual unit of a word.
data Span

-- | A normal character.
Char :: Char -> Span

-- | An escaped character.
Escape :: Char -> Span

-- | A single-quoted string.
Single :: Word -> Span

-- | A double-quoted string.
Double :: Word -> Span

-- | A ANSI C string.
ANSIC :: Word -> Span

-- | A locale-translated string.
Locale :: Word -> Span

-- | A backquote-style command substitution. To extract the command string,
--   <a>unquote</a> the word inside.
Backquote :: Word -> Span

-- | A parameter substitution.
ParamSubst :: ParamSubst -> Span

-- | An arithmetic substitution.
ArithSubst :: String -> Span

-- | A command substitution.
CommandSubst :: String -> Span

-- | A process substitution.
ProcessSubst :: ProcessSubstOp -> String -> Span

-- | A parameter name an optional subscript.
data Parameter
Parameter :: String -> Maybe Word -> Parameter

-- | A parameter substitution.
data ParamSubst
Bare :: Parameter -> ParamSubst

-- | The parameter to substitute.
[parameter] :: ParamSubst -> Parameter
Brace :: Bool -> Parameter -> ParamSubst

-- | Use indirect expansion.
[indirect] :: ParamSubst -> Bool

-- | The parameter to substitute.
[parameter] :: ParamSubst -> Parameter
Alt :: Bool -> Parameter -> Bool -> AltOp -> Word -> ParamSubst

-- | Use indirect expansion.
[indirect] :: ParamSubst -> Bool

-- | The parameter to substitute.
[parameter] :: ParamSubst -> Parameter

-- | Test for both existence and null values.
[testNull] :: ParamSubst -> Bool

-- | The operator.
[altOp] :: ParamSubst -> AltOp

-- | The alternate word.
[altWord] :: ParamSubst -> Word
Substring :: Bool -> Parameter -> Word -> Word -> ParamSubst

-- | Use indirect expansion.
[indirect] :: ParamSubst -> Bool

-- | The parameter to substitute.
[parameter] :: ParamSubst -> Parameter

-- | The substring offset.
[subOffset] :: ParamSubst -> Word

-- | The substring length, if any.
[subLength] :: ParamSubst -> Word
Prefix :: String -> Char -> ParamSubst

-- | The variable prefix.
[prefix] :: ParamSubst -> String

-- | Either <tt>@</tt> of <tt>*</tt>.
[modifier] :: ParamSubst -> Char
Indices :: Parameter -> ParamSubst

-- | The parameter to substitute.
[parameter] :: ParamSubst -> Parameter
Length :: Parameter -> ParamSubst

-- | The parameter to substitute.
[parameter] :: ParamSubst -> Parameter
Delete :: Bool -> Parameter -> Bool -> Direction -> Word -> ParamSubst

-- | Use indirect expansion.
[indirect] :: ParamSubst -> Bool

-- | The parameter to substitute.
[parameter] :: ParamSubst -> Parameter

-- | Replace the longest match instead of the shortest match.
[longest] :: ParamSubst -> Bool

-- | Where to delete from.
[deleteDirection] :: ParamSubst -> Direction

-- | The replacement pattern.
[pattern] :: ParamSubst -> Word
Replace :: Bool -> Parameter -> Bool -> Maybe Direction -> Word -> Word -> ParamSubst

-- | Use indirect expansion.
[indirect] :: ParamSubst -> Bool

-- | The parameter to substitute.
[parameter] :: ParamSubst -> Parameter

-- | Replace all occurences.
[replaceAll] :: ParamSubst -> Bool

-- | Where to replace.
[replaceDirection] :: ParamSubst -> Maybe Direction

-- | The replacement pattern.
[pattern] :: ParamSubst -> Word

-- | The replacement string.
[replacement] :: ParamSubst -> Word
LetterCase :: Bool -> Parameter -> LetterCaseOp -> Bool -> Word -> ParamSubst

-- | Use indirect expansion.
[indirect] :: ParamSubst -> Bool

-- | The parameter to substitute.
[parameter] :: ParamSubst -> Parameter

-- | Convert to lowercase, not uppercase.
[letterCaseOp] :: ParamSubst -> LetterCaseOp

-- | Convert all characters, not only the starts of words.
[convertAll] :: ParamSubst -> Bool

-- | The replacement pattern.
[pattern] :: ParamSubst -> Word

-- | An alternation operator.
data AltOp

-- | <a>-</a>, <tt>:-</tt>
AltDefault :: AltOp

-- | '=', <tt>:=</tt>
AltAssign :: AltOp

-- | <tt>?</tt>, <tt>:?</tt>
AltError :: AltOp

-- | <a>+</a>, <tt>:+</tt>
AltReplace :: AltOp

-- | A letter case operator.
data LetterCaseOp
ToLower :: LetterCaseOp
ToUpper :: LetterCaseOp

-- | A string direction.
data Direction
Front :: Direction
Back :: Direction

-- | A process substitution.
data ProcessSubstOp

-- | <pre>
--   &lt;
--   </pre>
ProcessIn :: ProcessSubstOp

-- | <pre>
--   &gt;
--   </pre>
ProcessOut :: ProcessSubstOp

-- | Convert a string to an unquoted word.
stringToWord :: String -> Word

-- | If a word is a plain, unquoted string (e.g. the result of
--   <tt>stringToWord</tt>), returns <tt>Just</tt> that string; otherwise,
--   returns <tt>Nothing</tt>.
wordToString :: Word -> Maybe String

-- | Remove all quoting characters from a word.
unquote :: Word -> String
instance GHC.Generics.Generic Language.Bash.Word.AltOp
instance GHC.Enum.Bounded Language.Bash.Word.AltOp
instance GHC.Enum.Enum Language.Bash.Word.AltOp
instance GHC.Show.Show Language.Bash.Word.AltOp
instance GHC.Read.Read Language.Bash.Word.AltOp
instance GHC.Classes.Ord Language.Bash.Word.AltOp
instance GHC.Classes.Eq Language.Bash.Word.AltOp
instance Data.Data.Data Language.Bash.Word.AltOp
instance GHC.Generics.Generic Language.Bash.Word.LetterCaseOp
instance GHC.Enum.Bounded Language.Bash.Word.LetterCaseOp
instance GHC.Enum.Enum Language.Bash.Word.LetterCaseOp
instance GHC.Show.Show Language.Bash.Word.LetterCaseOp
instance GHC.Read.Read Language.Bash.Word.LetterCaseOp
instance GHC.Classes.Ord Language.Bash.Word.LetterCaseOp
instance GHC.Classes.Eq Language.Bash.Word.LetterCaseOp
instance Data.Data.Data Language.Bash.Word.LetterCaseOp
instance GHC.Generics.Generic Language.Bash.Word.Direction
instance GHC.Enum.Bounded Language.Bash.Word.Direction
instance GHC.Enum.Enum Language.Bash.Word.Direction
instance GHC.Show.Show Language.Bash.Word.Direction
instance GHC.Read.Read Language.Bash.Word.Direction
instance GHC.Classes.Ord Language.Bash.Word.Direction
instance GHC.Classes.Eq Language.Bash.Word.Direction
instance Data.Data.Data Language.Bash.Word.Direction
instance GHC.Generics.Generic Language.Bash.Word.ProcessSubstOp
instance GHC.Enum.Bounded Language.Bash.Word.ProcessSubstOp
instance GHC.Enum.Enum Language.Bash.Word.ProcessSubstOp
instance GHC.Show.Show Language.Bash.Word.ProcessSubstOp
instance GHC.Read.Read Language.Bash.Word.ProcessSubstOp
instance GHC.Classes.Ord Language.Bash.Word.ProcessSubstOp
instance GHC.Classes.Eq Language.Bash.Word.ProcessSubstOp
instance Data.Data.Data Language.Bash.Word.ProcessSubstOp
instance GHC.Generics.Generic Language.Bash.Word.Parameter
instance GHC.Show.Show Language.Bash.Word.Parameter
instance GHC.Read.Read Language.Bash.Word.Parameter
instance GHC.Classes.Eq Language.Bash.Word.Parameter
instance Data.Data.Data Language.Bash.Word.Parameter
instance GHC.Generics.Generic Language.Bash.Word.ParamSubst
instance GHC.Show.Show Language.Bash.Word.ParamSubst
instance GHC.Read.Read Language.Bash.Word.ParamSubst
instance GHC.Classes.Eq Language.Bash.Word.ParamSubst
instance Data.Data.Data Language.Bash.Word.ParamSubst
instance GHC.Generics.Generic Language.Bash.Word.Span
instance GHC.Show.Show Language.Bash.Word.Span
instance GHC.Read.Read Language.Bash.Word.Span
instance GHC.Classes.Eq Language.Bash.Word.Span
instance Data.Data.Data Language.Bash.Word.Span
instance Prettyprinter.Internal.Pretty Language.Bash.Word.Span
instance Prettyprinter.Internal.Pretty [Language.Bash.Word.Word]
instance Prettyprinter.Internal.Pretty Language.Bash.Word.Parameter
instance Prettyprinter.Internal.Pretty Language.Bash.Word.ParamSubst
instance Language.Bash.Operator.Operator Language.Bash.Word.ProcessSubstOp
instance Prettyprinter.Internal.Pretty Language.Bash.Word.ProcessSubstOp
instance Prettyprinter.Internal.Pretty Language.Bash.Word.Direction
instance Language.Bash.Operator.Operator Language.Bash.Word.LetterCaseOp
instance Prettyprinter.Internal.Pretty Language.Bash.Word.LetterCaseOp
instance Language.Bash.Operator.Operator Language.Bash.Word.AltOp
instance Prettyprinter.Internal.Pretty Language.Bash.Word.AltOp


-- | Shell script types.
module Language.Bash.Syntax

-- | A Bash command with redirections.
data Command
Command :: ShellCommand -> [Redir] -> Command

-- | A Bash command.
data ShellCommand

-- | A simple command consisting of assignments followed by words.
SimpleCommand :: [Assign] -> [Word] -> ShellCommand

-- | The shell builtins <tt>declare</tt>, <tt>eval</tt>, <tt>export</tt>,
--   <tt>local</tt>, <tt>readonly</tt>, and <tt>typeset</tt> can accept
--   both assignments and words as arguments.
AssignBuiltin :: Word -> [Either Assign Word] -> ShellCommand

-- | A function name and definition.
FunctionDef :: String -> List -> ShellCommand

-- | A named coprocess.
Coproc :: String -> Command -> ShellCommand

-- | A <tt>(...)</tt> list, denoting a subshell.
Subshell :: List -> ShellCommand

-- | A <tt>{...}</tt> list.
Group :: List -> ShellCommand

-- | An arithmetic expression.
Arith :: String -> ShellCommand

-- | A Bash <tt>[[...]]</tt> conditional expression.
Cond :: CondExpr Word -> ShellCommand

-- | A <tt>for <i>name</i> in <i>words</i></tt> command. If <tt>in
--   <i>words</i></tt> is absent, the word list defaults to <tt>"$@"</tt>.
For :: String -> WordList -> List -> ShellCommand

-- | An arithmetic <tt>for ((...))</tt> command.
ArithFor :: String -> List -> ShellCommand

-- | A <tt>select <i>name</i> in <i>words</i></tt> command. If <tt>in
--   <i>words</i></tt> is absent, the word list defaults to <tt>"$@"</tt>.
Select :: String -> WordList -> List -> ShellCommand

-- | A <tt>case</tt> command.
Case :: Word -> [CaseClause] -> ShellCommand

-- | An <tt>if</tt> command, with a predicate, consequent, and alternative.
--   <tt>elif</tt> clauses are parsed as nested <tt>if</tt> statements.
If :: List -> List -> Maybe List -> ShellCommand

-- | An <tt>until</tt> command.
Until :: List -> List -> ShellCommand

-- | A <tt>while</tt> command.
While :: List -> List -> ShellCommand

-- | A word list or <tt>"$@"</tt>.
data WordList
Args :: WordList
WordList :: [Word] -> WordList

-- | A single case clause.
data CaseClause
CaseClause :: [Word] -> List -> CaseTerm -> CaseClause

-- | A case clause terminator.
data CaseTerm

-- | <pre>
--   ;;
--   </pre>
Break :: CaseTerm

-- | <pre>
--   ;&amp;
--   </pre>
FallThrough :: CaseTerm

-- | <pre>
--   ;;&amp;
--   </pre>
Continue :: CaseTerm

-- | A redirection.
data Redir

-- | A redirection.
Redir :: Maybe IODesc -> RedirOp -> Word -> Redir

-- | An optional file descriptor.
[redirDesc] :: Redir -> Maybe IODesc

-- | The redirection operator.
[redirOp] :: Redir -> RedirOp

-- | The redirection target.
[redirTarget] :: Redir -> Word

-- | A here document.
Heredoc :: HeredocOp -> String -> Bool -> Word -> Redir

-- | The here document operator.
[heredocOp] :: Redir -> HeredocOp

-- | The here document delimiter.
[heredocDelim] :: Redir -> String

-- | <a>True</a> if the delimiter was quoted.
[heredocDelimQuoted] :: Redir -> Bool

-- | 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.
[hereDocument] :: Redir -> Word

-- | A redirection file descriptor.
data IODesc

-- | A file descriptor number.
IONumber :: Int -> IODesc

-- | A variable <tt>{<i>varname</i>}</tt> to allocate a file descriptor
--   for.
IOVar :: String -> IODesc

-- | A redirection operator.
data RedirOp

-- | <pre>
--   &lt;
--   </pre>
In :: RedirOp

-- | <pre>
--   &gt;
--   </pre>
Out :: RedirOp

-- | <pre>
--   &gt;|
--   </pre>
OutOr :: RedirOp

-- | <pre>
--   &gt;&gt;
--   </pre>
Append :: RedirOp

-- | <pre>
--   &amp;&gt;
--   </pre>
AndOut :: RedirOp

-- | <pre>
--   &amp;&gt;&gt;
--   </pre>
AndAppend :: RedirOp

-- | <pre>
--   &lt;&lt;&lt;
--   </pre>
HereString :: RedirOp

-- | <pre>
--   &lt;&amp;
--   </pre>
InAnd :: RedirOp

-- | <pre>
--   &gt;&amp;
--   </pre>
OutAnd :: RedirOp

-- | <pre>
--   &lt;&gt;
--   </pre>
InOut :: RedirOp

-- | A here document operator.
data HeredocOp

-- | <pre>
--   &lt;&lt;
--   </pre>
Here :: HeredocOp

-- | <pre>
--   &lt;&lt;-
--   </pre>
HereStrip :: HeredocOp

-- | A compound list of statements.
newtype List
List :: [Statement] -> List

-- | A single statement in a list.
data Statement
Statement :: AndOr -> ListTerm -> Statement

-- | A statement terminator.
data ListTerm

-- | <pre>
--   ;
--   </pre>
Sequential :: ListTerm

-- | <pre>
--   &amp;
--   </pre>
Asynchronous :: ListTerm

-- | A right-associative list of pipelines.
data AndOr

-- | The last pipeline of a list.
Last :: Pipeline -> AndOr

-- | A <tt>&amp;&amp;</tt> construct.
And :: Pipeline -> AndOr -> AndOr

-- | A <tt>||</tt> construct.
Or :: Pipeline -> AndOr -> AndOr

-- | A (possibly timed or inverted) pipeline, linked with <tt>|</tt> or
--   <tt>|&amp;</tt>.
data Pipeline
Pipeline :: Bool -> Bool -> Bool -> [Command] -> Pipeline

-- | <a>True</a> if the pipeline is timed with <tt>time</tt>.
[timed] :: Pipeline -> Bool

-- | <a>True</a> if the pipeline is timed with the <tt>-p</tt> flag.
[timedPosix] :: Pipeline -> Bool

-- | <a>True</a> if the pipeline is inverted with <tt>!</tt>.
[inverted] :: Pipeline -> Bool

-- | A list of commands, separated by <tt>|</tt>, or <tt>|&amp;</tt>.
--   <tt>command1 |&amp; command2</tt> is treated as a shorthand for
--   <tt>command1 2&gt;&amp;1 | command2</tt>.
[commands] :: Pipeline -> [Command]

-- | An assignment.
data Assign
Assign :: Parameter -> AssignOp -> RValue -> Assign

-- | An assignment operator.
data AssignOp

-- | <pre>
--   =
--   </pre>
Equals :: AssignOp

-- | <pre>
--   +=
--   </pre>
PlusEquals :: AssignOp

-- | The right side of an assignment.
data RValue

-- | A simple word.
RValue :: Word -> RValue

-- | An array assignment, as <tt>(subscript, word)</tt> pairs.
RArray :: [(Maybe Word, Word)] -> RValue
instance GHC.Generics.Generic Language.Bash.Syntax.WordList
instance GHC.Show.Show Language.Bash.Syntax.WordList
instance GHC.Read.Read Language.Bash.Syntax.WordList
instance GHC.Classes.Eq Language.Bash.Syntax.WordList
instance Data.Data.Data Language.Bash.Syntax.WordList
instance GHC.Generics.Generic Language.Bash.Syntax.CaseTerm
instance GHC.Enum.Enum Language.Bash.Syntax.CaseTerm
instance GHC.Enum.Bounded Language.Bash.Syntax.CaseTerm
instance GHC.Show.Show Language.Bash.Syntax.CaseTerm
instance GHC.Read.Read Language.Bash.Syntax.CaseTerm
instance GHC.Classes.Ord Language.Bash.Syntax.CaseTerm
instance GHC.Classes.Eq Language.Bash.Syntax.CaseTerm
instance Data.Data.Data Language.Bash.Syntax.CaseTerm
instance GHC.Generics.Generic Language.Bash.Syntax.IODesc
instance GHC.Show.Show Language.Bash.Syntax.IODesc
instance GHC.Read.Read Language.Bash.Syntax.IODesc
instance GHC.Classes.Eq Language.Bash.Syntax.IODesc
instance Data.Data.Data Language.Bash.Syntax.IODesc
instance GHC.Generics.Generic Language.Bash.Syntax.RedirOp
instance GHC.Enum.Bounded Language.Bash.Syntax.RedirOp
instance GHC.Enum.Enum Language.Bash.Syntax.RedirOp
instance GHC.Show.Show Language.Bash.Syntax.RedirOp
instance GHC.Read.Read Language.Bash.Syntax.RedirOp
instance GHC.Classes.Ord Language.Bash.Syntax.RedirOp
instance GHC.Classes.Eq Language.Bash.Syntax.RedirOp
instance Data.Data.Data Language.Bash.Syntax.RedirOp
instance GHC.Generics.Generic Language.Bash.Syntax.HeredocOp
instance GHC.Enum.Bounded Language.Bash.Syntax.HeredocOp
instance GHC.Enum.Enum Language.Bash.Syntax.HeredocOp
instance GHC.Show.Show Language.Bash.Syntax.HeredocOp
instance GHC.Read.Read Language.Bash.Syntax.HeredocOp
instance GHC.Classes.Ord Language.Bash.Syntax.HeredocOp
instance GHC.Classes.Eq Language.Bash.Syntax.HeredocOp
instance Data.Data.Data Language.Bash.Syntax.HeredocOp
instance GHC.Generics.Generic Language.Bash.Syntax.Redir
instance GHC.Show.Show Language.Bash.Syntax.Redir
instance GHC.Read.Read Language.Bash.Syntax.Redir
instance GHC.Classes.Eq Language.Bash.Syntax.Redir
instance Data.Data.Data Language.Bash.Syntax.Redir
instance GHC.Generics.Generic Language.Bash.Syntax.ListTerm
instance GHC.Enum.Enum Language.Bash.Syntax.ListTerm
instance GHC.Enum.Bounded Language.Bash.Syntax.ListTerm
instance GHC.Show.Show Language.Bash.Syntax.ListTerm
instance GHC.Read.Read Language.Bash.Syntax.ListTerm
instance GHC.Classes.Ord Language.Bash.Syntax.ListTerm
instance GHC.Classes.Eq Language.Bash.Syntax.ListTerm
instance Data.Data.Data Language.Bash.Syntax.ListTerm
instance GHC.Generics.Generic Language.Bash.Syntax.AssignOp
instance GHC.Enum.Enum Language.Bash.Syntax.AssignOp
instance GHC.Enum.Bounded Language.Bash.Syntax.AssignOp
instance GHC.Show.Show Language.Bash.Syntax.AssignOp
instance GHC.Read.Read Language.Bash.Syntax.AssignOp
instance GHC.Classes.Ord Language.Bash.Syntax.AssignOp
instance GHC.Classes.Eq Language.Bash.Syntax.AssignOp
instance Data.Data.Data Language.Bash.Syntax.AssignOp
instance GHC.Generics.Generic Language.Bash.Syntax.RValue
instance GHC.Show.Show Language.Bash.Syntax.RValue
instance GHC.Read.Read Language.Bash.Syntax.RValue
instance GHC.Classes.Eq Language.Bash.Syntax.RValue
instance Data.Data.Data Language.Bash.Syntax.RValue
instance GHC.Generics.Generic Language.Bash.Syntax.Assign
instance GHC.Show.Show Language.Bash.Syntax.Assign
instance GHC.Read.Read Language.Bash.Syntax.Assign
instance GHC.Classes.Eq Language.Bash.Syntax.Assign
instance Data.Data.Data Language.Bash.Syntax.Assign
instance GHC.Generics.Generic Language.Bash.Syntax.CaseClause
instance GHC.Show.Show Language.Bash.Syntax.CaseClause
instance GHC.Read.Read Language.Bash.Syntax.CaseClause
instance GHC.Classes.Eq Language.Bash.Syntax.CaseClause
instance Data.Data.Data Language.Bash.Syntax.CaseClause
instance GHC.Generics.Generic Language.Bash.Syntax.Command
instance GHC.Show.Show Language.Bash.Syntax.Command
instance GHC.Read.Read Language.Bash.Syntax.Command
instance GHC.Classes.Eq Language.Bash.Syntax.Command
instance Data.Data.Data Language.Bash.Syntax.Command
instance GHC.Generics.Generic Language.Bash.Syntax.Pipeline
instance GHC.Show.Show Language.Bash.Syntax.Pipeline
instance GHC.Read.Read Language.Bash.Syntax.Pipeline
instance GHC.Classes.Eq Language.Bash.Syntax.Pipeline
instance Data.Data.Data Language.Bash.Syntax.Pipeline
instance GHC.Generics.Generic Language.Bash.Syntax.AndOr
instance GHC.Show.Show Language.Bash.Syntax.AndOr
instance GHC.Read.Read Language.Bash.Syntax.AndOr
instance GHC.Classes.Eq Language.Bash.Syntax.AndOr
instance Data.Data.Data Language.Bash.Syntax.AndOr
instance GHC.Generics.Generic Language.Bash.Syntax.Statement
instance GHC.Show.Show Language.Bash.Syntax.Statement
instance GHC.Read.Read Language.Bash.Syntax.Statement
instance GHC.Classes.Eq Language.Bash.Syntax.Statement
instance Data.Data.Data Language.Bash.Syntax.Statement
instance GHC.Generics.Generic Language.Bash.Syntax.List
instance GHC.Show.Show Language.Bash.Syntax.List
instance GHC.Read.Read Language.Bash.Syntax.List
instance GHC.Classes.Eq Language.Bash.Syntax.List
instance Data.Data.Data Language.Bash.Syntax.List
instance GHC.Generics.Generic Language.Bash.Syntax.ShellCommand
instance GHC.Show.Show Language.Bash.Syntax.ShellCommand
instance GHC.Read.Read Language.Bash.Syntax.ShellCommand
instance GHC.Classes.Eq Language.Bash.Syntax.ShellCommand
instance Data.Data.Data Language.Bash.Syntax.ShellCommand
instance Prettyprinter.Internal.Pretty Language.Bash.Syntax.Command
instance Language.Bash.Syntax.ToBashDoc Language.Bash.Syntax.Command
instance Prettyprinter.Internal.Pretty Language.Bash.Syntax.ShellCommand
instance Prettyprinter.Internal.Pretty Language.Bash.Syntax.CaseClause
instance Prettyprinter.Internal.Pretty Language.Bash.Syntax.List
instance Prettyprinter.Internal.Pretty Language.Bash.Syntax.Statement
instance Language.Bash.Syntax.ToBashDoc Language.Bash.Syntax.Statement
instance Prettyprinter.Internal.Pretty Language.Bash.Syntax.AndOr
instance Language.Bash.Syntax.ToBashDoc Language.Bash.Syntax.AndOr
instance Prettyprinter.Internal.Pretty Language.Bash.Syntax.Pipeline
instance Language.Bash.Syntax.ToBashDoc Language.Bash.Syntax.Pipeline
instance Prettyprinter.Internal.Pretty Language.Bash.Syntax.Assign
instance Prettyprinter.Internal.Pretty Language.Bash.Syntax.RValue
instance Language.Bash.Operator.Operator Language.Bash.Syntax.AssignOp
instance Prettyprinter.Internal.Pretty Language.Bash.Syntax.AssignOp
instance Language.Bash.Operator.Operator Language.Bash.Syntax.ListTerm
instance Prettyprinter.Internal.Pretty Language.Bash.Syntax.ListTerm
instance Language.Bash.Syntax.ToBashDoc Language.Bash.Syntax.ListTerm
instance Prettyprinter.Internal.Pretty Language.Bash.Syntax.Redir
instance Language.Bash.Operator.Operator Language.Bash.Syntax.HeredocOp
instance Prettyprinter.Internal.Pretty Language.Bash.Syntax.HeredocOp
instance Language.Bash.Operator.Operator Language.Bash.Syntax.RedirOp
instance Prettyprinter.Internal.Pretty Language.Bash.Syntax.RedirOp
instance Prettyprinter.Internal.Pretty Language.Bash.Syntax.IODesc
instance Language.Bash.Operator.Operator Language.Bash.Syntax.CaseTerm
instance Prettyprinter.Internal.Pretty Language.Bash.Syntax.CaseTerm
instance Prettyprinter.Internal.Pretty Language.Bash.Syntax.WordList
instance GHC.Base.Semigroup (Language.Bash.Syntax.BashDoc ann)
instance GHC.Base.Monoid (Language.Bash.Syntax.BashDoc ann)


-- | Word-level parsers.
module Language.Bash.Parse.Word

-- | Skip spaces, tabs, and comments.
skipSpace :: Stream s m Char => ParsecT s u m ()

-- | Parse an arithmetic expression.
arith :: Stream s m Char => ParsecT s u m String

-- | Parse a word.
word :: Stream s m Char => ParsecT s u m Word

-- | Parse a here document as a word. This parses substitutions, but not
--   most quoting.
heredocWord :: Stream s m Char => ParsecT s u m Word

-- | Parse a parameter name.
name :: Stream s m Char => ParsecT s u m String

-- | Parse a function name.
functionName :: Stream s m Char => ParsecT s u m String

-- | Parse a subscript.
subscript :: Stream s m Char => ParsecT s u m Word

-- | Parse an assignment.
assign :: Stream s m Char => ParsecT s u m Assign

-- | Parse the longest available operator from a list.
operator :: Stream s m Char => [String] -> ParsecT s u m String


-- | Bash script and input parsing.
module Language.Bash.Parse

-- | Parse a script or input line into a (possibly empty) list of commands.
parse :: SourceName -> String -> Either ParseError List


-- | Shell expansions.
module Language.Bash.Expand

-- | Brace expand a word.
braceExpand :: Word -> [Word]

-- | A tilde prefix.
data TildePrefix

-- | <pre>
--   ~/foo
--   </pre>
Home :: TildePrefix

-- | <pre>
--   ~fred/foo
--   </pre>
UserHome :: String -> TildePrefix

-- | <pre>
--   ~+/foo
--   </pre>
PWD :: TildePrefix

-- | <pre>
--   ~-/foo
--   </pre>
OldPWD :: TildePrefix

-- | <tt>~N</tt>, <tt>~+N</tt>, <tt>~-N</tt>
Dirs :: Int -> TildePrefix

-- | Strip the tilde prefix of a word, if any.
tildePrefix :: Word -> Maybe (TildePrefix, Word)

-- | Split a word on delimiters.
splitWord :: [Char] -> Word -> [Word]
instance GHC.Show.Show Language.Bash.Expand.TildePrefix
instance GHC.Read.Read Language.Bash.Expand.TildePrefix
instance GHC.Classes.Eq Language.Bash.Expand.TildePrefix
instance Prettyprinter.Internal.Pretty Language.Bash.Expand.TildePrefix