HIndent.Types

All types.

Documentation

newtype Printer a

A pretty printing monad.

Constructors

Printer

Fields

• runPrinter :: StateT PrintState (MaybeT Identity) a

Instances

Monad Printer

Methods

(>>=) :: Printer a -> (a -> Printer b) -> Printer b

(>>) :: Printer a -> Printer b -> Printer b

return :: a -> Printer a

fail :: String -> Printer a

Functor Printer

Methods

fmap :: (a -> b) -> Printer a -> Printer b

(<$) :: a -> Printer b -> Printer a

Applicative Printer

Methods

pure :: a -> Printer a

(<*>) :: Printer (a -> b) -> Printer a -> Printer b

(*>) :: Printer a -> Printer b -> Printer b

(<*) :: Printer a -> Printer b -> Printer a

Alternative Printer

Methods

empty :: Printer a

(<|>) :: Printer a -> Printer a -> Printer a

some :: Printer a -> Printer [a]

many :: Printer a -> Printer [a]

MonadPlus Printer

Methods

mzero :: Printer a

mplus :: Printer a -> Printer a -> Printer a

MonadState PrintState Printer

Methods

get :: Printer PrintState

put :: PrintState -> Printer ()

state :: (PrintState -> (a, PrintState)) -> Printer a

data PrintState

The state of the pretty printer.

Constructors

PrintState

Fields

• psIndentLevel :: !Int64

  Current indentation level.

• psOutput :: !Builder

  The current output.

• psNewline :: !Bool

  Just outputted a newline?

• psColumn :: !Int64

  Current column.

• psLine :: !Int64

  Current line number.

• psConfig :: !Config

  Config which styles may or may not pay attention to.

• psEolComment :: !Bool

  An end of line comment has just been outputted.

• psInsideCase :: !Bool

  Whether we're in a case statement, used for Rhs printing.

• psParseMode :: !ParseMode

  Mode used to parse the original AST.

Instances

MonadState PrintState Printer

Methods

get :: Printer PrintState

put :: PrintState -> Printer ()

state :: (PrintState -> (a, PrintState)) -> Printer a

data Config

Configurations shared among the different styles. Styles may pay attention to or completely disregard this configuration.

Constructors

Config

Fields

• configMaxColumns :: !Int64

  Maximum columns to fit code into ideally.

• configIndentSpaces :: !Int64

  How many spaces to indent?

• configClearEmptyLines :: !Bool

  Remove spaces on lines that are otherwise empty?

defaultConfig :: Config

Default style configuration.

data NodeInfo

Information for each node in the AST.

Constructors

NodeInfo

Fields

• nodeInfoSpan :: !SrcSpanInfo

  Location info from the parser.

• nodeInfoComments :: ![ComInfo]

  Comments which are attached to this node.

Instances

Data NodeInfo

Methods

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

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

toConstr :: NodeInfo -> Constr

dataTypeOf :: NodeInfo -> DataType

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

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

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

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

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

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

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

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

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

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

Show NodeInfo

Methods

showsPrec :: Int -> NodeInfo -> ShowS

show :: NodeInfo -> String

showList :: [NodeInfo] -> ShowS

data ComInfo

Comment with some more info.

Constructors

ComInfo

Fields

• comInfoComment :: !Comment

  The normal comment type.

• comInfoLocation :: !(Maybe ComInfoLocation)

  Where the comment lies relative to the node.

Instances

Data ComInfo

Methods

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

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

toConstr :: ComInfo -> Constr

dataTypeOf :: ComInfo -> DataType

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

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

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

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

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

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

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

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

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

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

Show ComInfo

Methods

showsPrec :: Int -> ComInfo -> ShowS

show :: ComInfo -> String

showList :: [ComInfo] -> ShowS

data ComInfoLocation

Comment relative locations.

Constructors

Before

After

Instances

Eq ComInfoLocation

Methods

(==) :: ComInfoLocation -> ComInfoLocation -> Bool

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

Data ComInfoLocation

Methods

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

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

toConstr :: ComInfoLocation -> Constr

dataTypeOf :: ComInfoLocation -> DataType

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

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

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

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

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

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

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

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

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

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

Show ComInfoLocation

Methods

showsPrec :: Int -> ComInfoLocation -> ShowS

show :: ComInfoLocation -> String

showList :: [ComInfoLocation] -> ShowS