stylish-haskell-0.14.6.0: Haskell code prettifier

Safe Haskell	Safe-Inferred
Language	Haskell2010

Language.Haskell.Stylish.Printer

Contents

Alias
Functions to use the printer
- Combinators
- Advanced combinators

Synopsis

newtype Printer a = Printer (ReaderT PrinterConfig (State PrinterState) a)
data PrinterConfig = PrinterConfig {
- columns :: !(Maybe Int)
}
data PrinterState = PrinterState {
- lines :: !Lines
- linePos :: !Int
- currentLine :: !String
}
type P = Printer
runPrinter :: PrinterConfig -> Printer a -> (a, Lines)
runPrinter_ :: PrinterConfig -> Printer a -> Lines
comma :: P ()
dot :: P ()
getCurrentLine :: P String
getCurrentLineLength :: P Int
newline :: P ()
parenthesize :: P a -> P a
prefix :: P a -> P b -> P b
putComment :: EpaComment -> P ()
putMaybeLineComment :: Maybe EpaComment -> P ()
putOutputable :: Outputable a => a -> P ()
putCond :: (PrinterState -> Bool) -> P b -> P b -> P b
putType :: LHsType GhcPs -> P ()
putRdrName :: GenLocated SrcSpanAnnN RdrName -> P ()
putText :: String -> P ()
sep :: P a -> [P a] -> P ()
space :: P ()
spaces :: Int -> P ()
suffix :: P a -> P b -> P a
pad :: Int -> P ()
withColumns :: Maybe Int -> P a -> P a
modifyCurrentLine :: (String -> String) -> P ()
wrapping :: P a -> P a -> P a

Documentation

newtype Printer a Source #

Printer that keeps state of file

Constructors

Printer (ReaderT PrinterConfig (State PrinterState) a)

Instances

Instances details

Applicative Printer Source #
Instance details Defined in Language.Haskell.Stylish.Printer Methods pure :: a -> Printer a # (<>) :: Printer (a -> b) -> Printer a -> Printer b # liftA2 :: (a -> b -> c) -> Printer a -> Printer b -> Printer c # (>) :: Printer a -> Printer b -> Printer b # (<*) :: Printer a -> Printer b -> Printer a #
Functor Printer Source #
Instance details Defined in Language.Haskell.Stylish.Printer Methods fmap :: (a -> b) -> Printer a -> Printer b # (<$) :: a -> Printer b -> Printer a #
Monad Printer Source #
Instance details Defined in Language.Haskell.Stylish.Printer Methods (>>=) :: Printer a -> (a -> Printer b) -> Printer b # (>>) :: Printer a -> Printer b -> Printer b # return :: a -> Printer a #
MonadReader PrinterConfig Printer Source #
Instance details Defined in Language.Haskell.Stylish.Printer Methods ask :: Printer PrinterConfig # local :: (PrinterConfig -> PrinterConfig) -> Printer a -> Printer a # reader :: (PrinterConfig -> a) -> Printer a #
MonadState PrinterState Printer Source #
Instance details Defined in Language.Haskell.Stylish.Printer Methods get :: Printer PrinterState # put :: PrinterState -> Printer () # state :: (PrinterState -> (a, PrinterState)) -> Printer a #

data PrinterConfig Source #

Configuration for printer, currently empty

Constructors

PrinterConfig
Fields columns :: !(Maybe Int)

Instances

Instances details

MonadReader PrinterConfig Printer Source #
Instance details Defined in Language.Haskell.Stylish.Printer Methods ask :: Printer PrinterConfig # local :: (PrinterConfig -> PrinterConfig) -> Printer a -> Printer a # reader :: (PrinterConfig -> a) -> Printer a #

data PrinterState Source #

State of printer

Constructors

PrinterState
Fields lines :: !Lines linePos :: !Int currentLine :: !String

Instances

Instances details

MonadState PrinterState Printer Source #
Instance details Defined in Language.Haskell.Stylish.Printer Methods get :: Printer PrinterState # put :: PrinterState -> Printer () # state :: (PrinterState -> (a, PrinterState)) -> Printer a #

Alias

type P = Printer Source #

Shorthand for Printer monad

Functions to use the printer

runPrinter :: PrinterConfig -> Printer a -> (a, Lines) Source #

Run printer to get printed lines out of module as well as return value of monad

runPrinter_ :: PrinterConfig -> Printer a -> Lines Source #

Run printer to get printed lines only

Combinators

comma :: P () Source #

Print a comma

dot :: P () Source #

Print a dot

getCurrentLine :: P String Source #

Get current line

getCurrentLineLength :: P Int Source #

Get current line length

newline :: P () Source #

Print a newline

parenthesize :: P a -> P a Source #

Add parens around a printed action

prefix :: P a -> P b -> P b Source #

Prefix a printer with another one

putComment :: EpaComment -> P () Source #

Put all comments that has positions within SrcSpan and separate by passed P ()

Print any comment

putMaybeLineComment :: Maybe EpaComment -> P () Source #

putOutputable :: Outputable a => a -> P () Source #

Print an Outputable

putCond :: (PrinterState -> Bool) -> P b -> P b -> P b Source #

Check condition post action, and use fallback if false

putType :: LHsType GhcPs -> P () Source #

Print type

putRdrName :: GenLocated SrcSpanAnnN RdrName -> P () Source #

Print a RdrName

putText :: String -> P () Source #

Print text

sep :: P a -> [P a] -> P () Source #

Add separator between each element of the given printers

space :: P () Source #

Print a space

spaces :: Int -> P () Source #

Print a number of spaces

suffix :: P a -> P b -> P a Source #

Suffix a printer with another one

pad :: Int -> P () Source #

Indent to a given number of spaces. If the current line already exceeds that number in length, nothing happens.

Advanced combinators

withColumns :: Maybe Int -> P a -> P a Source #

modifyCurrentLine :: (String -> String) -> P () Source #

wrapping Source #

Arguments

:: P a	First printer to run
-> P a	Printer to run if first printer violates max columns
-> P a	Result of either the first or the second printer