HIndent.Types

All types.

Documentation

newtype Printer s a

A pretty printing monad.

Constructors

Printer

Fields

• runPrinter :: StateT (PrintState s) (MaybeT Identity) a

Instances

Monad (Printer s)

Methods

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

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

return :: a -> Printer s a

fail :: String -> Printer s a

Functor (Printer s)

Methods

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

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

Applicative (Printer s)

Methods

pure :: a -> Printer s a

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

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

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

Alternative (Printer s)

Methods

empty :: Printer s a

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

some :: Printer s a -> Printer s [a]

many :: Printer s a -> Printer s [a]

MonadPlus (Printer s)

Methods

mzero :: Printer s a

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

MonadState (PrintState s) (Printer s)

Methods

get :: Printer s (PrintState s)

put :: PrintState s -> Printer s ()

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

data PrintState s

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.

• psUserState :: !s

  User state.

• psExtenders :: ![Extender s]

  Extenders.

• 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.

• psCommentPreprocessor :: forall m. MonadState (PrintState s) m => [Comment] -> m [Comment]

  Preprocessor applied to comments on an AST before printing.

Instances

Eq (PrintState s)

Methods

(==) :: PrintState s -> PrintState s -> Bool

(/=) :: PrintState s -> PrintState s -> Bool

MonadState (PrintState s) (Printer s)

Methods

get :: Printer s (PrintState s)

put :: PrintState s -> Printer s ()

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

data Extender s where

A printer extender. Takes as argument the user state that the printer was run with, and the current node to print. Use prettyNoExt to fallback to the built-in printer.

Constructors

Extender :: forall s a. Typeable a => (a -> Printer s ()) -> Extender s

CatchAll :: forall s. (forall a. Typeable a => s -> a -> Maybe (Printer s ())) -> Extender s

data Style

A printer style.

Constructors

Style

Fields

• styleName :: !Text

  Name of the style, used in the commandline interface.

• styleAuthor :: !Text

  Author of the printer (as opposed to the author of the style).

• styleDescription :: !Text

  Description of the style.

• styleInitialState :: !s

  User state, if needed.

• styleExtenders :: ![Extender s]

  Extenders to the printer.

• styleDefConfig :: !Config

  Default config to use for this style.

• styleCommentPreprocessor :: forall s' m. MonadState (PrintState s') m => [Comment] -> m [Comment]

  Preprocessor to use for comments.

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?

Instances

Default Config

Methods

def :: Config

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