Language.Bash.PrettyPrinter.State

Pretty printer state, used within a state monad computation.

Documentation

data PPState

State of pretty printing -- string being built, indent levels, present column, brace nesting.

Constructors

PPState

Fields

indents :: [Word]

curly :: [()]

round :: [()]

columns :: Word

separated :: Bool

string :: Builder

Instances

Show PPState

render :: PPState -> State PPState () -> Builder

Produce a builder from a pretty printer state computation.

renderBytes :: PPState -> State PPState () -> ByteString

nlCol :: Word -> PPState

Pretty printer state starting on a new line indented to the given column.

data PPOp

Operations we can perform while pretty printing.

Constructors

Indent Word

Indent by N spaces.

Outdent

Remove an indentation level.

Bytes ByteString

Add bytes to the script.

Newline

Move to newline.

WordSeparator

Separate words with space.

Curly Bool

Introduce a level of braces.

Round Bool

Introduce a level of parens.

op :: PPState -> PPOp -> PPState

Apply an operation to a state.

opM :: [PPOp] -> State PPState ()

nl :: State PPState ()

hang :: ByteString -> State PPState ()

hangWord :: ByteString -> State PPState ()

word :: ByteString -> State PPState ()

wordcat :: [ByteString] -> State PPState ()

outdent :: State PPState ()

inword :: ByteString -> State PPState ()

outword :: ByteString -> State PPState ()

curlyOpen :: State PPState ()

curlyClose :: State PPState ()

roundOpen :: State PPState ()

roundClose :: State PPState ()

indentPadToNextWord :: State PPState ()

This procedure is used in printing statements within evals, to set up indentation correctly for lines following the first line. It ensures that the second and following lines are printed aligned with the first character of the first line of the statement, not the first character of the $(, >( or <( enclosing the eval.