Language.Haskell.Stylish.Printer

Documentation

newtype Printer a

Printer that keeps state of file

Constructors

Printer (ReaderT PrinterConfig (State PrinterState) a)

Instances

Monad Printer

Defined in Language.Haskell.Stylish.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

Defined in Language.Haskell.Stylish.Printer

Methods

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

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

Applicative Printer

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

MonadState PrinterState Printer

Defined in Language.Haskell.Stylish.Printer

Methods

get :: Printer PrinterState

put :: PrinterState -> Printer ()

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

MonadReader PrinterConfig Printer

Defined in Language.Haskell.Stylish.Printer

Methods

ask :: Printer PrinterConfig

local :: (PrinterConfig -> PrinterConfig) -> Printer a -> Printer a

reader :: (PrinterConfig -> a) -> Printer a

data PrinterConfig

Configuration for printer, currently empty

Constructors

PrinterConfig

Fields

• columns :: !(Maybe Int)

Instances

MonadReader PrinterConfig Printer

Defined in Language.Haskell.Stylish.Printer

Methods

ask :: Printer PrinterConfig

local :: (PrinterConfig -> PrinterConfig) -> Printer a -> Printer a

reader :: (PrinterConfig -> a) -> Printer a

data PrinterState

State of printer

Constructors

PrinterState

Fields

• lines :: !Lines
• linePos :: !Int
• currentLine :: !String
• pendingComments :: ![RealLocated AnnotationComment]
• parsedModule :: !Module

Instances

MonadState PrinterState Printer

Defined in Language.Haskell.Stylish.Printer

Methods

get :: Printer PrinterState

put :: PrinterState -> Printer ()

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

Alias

type P = Printer

Shorthand for Printer monad

Functions to use the printer

runPrinter :: PrinterConfig -> [RealLocated AnnotationComment] -> Module -> Printer a -> (a, Lines)

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

runPrinter_ :: PrinterConfig -> [RealLocated AnnotationComment] -> Module -> Printer a -> Lines

Run printer to get printed lines only

Combinators

comma :: P ()

Print a comma

dot :: P ()

Print a dot

getAnnot :: SrcSpan -> P [AnnKeywordId]

Get all annotations for SrcSpan

getCurrentLine :: P String

Get current line

getCurrentLineLength :: P Int

Get current line length

getDocstrPrev :: SrcSpan -> P (Maybe AnnotationComment)

Get a docstring on the start line of SrcSpan that is a -- ^ comment

newline :: P ()

Print a newline

parenthesize :: P a -> P a

Add parens around a printed action

peekNextCommentPos :: P (Maybe SrcSpan)

Peek at the next comment in the state

prefix :: P a -> P b -> P b

Prefix a printer with another one

putComment :: AnnotationComment -> P ()

Print any comment

putEolComment :: SrcSpan -> P ()

Given the current start line of SrcSpan, remove and put EOL comment for same line

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

Print an Outputable

putAllSpanComments :: P () -> SrcSpan -> P ()

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

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

Check condition post action, and use fallback if false

putType :: Located (HsType GhcPs) -> P ()

Print type

putRdrName :: Located RdrName -> P ()

Print a RdrName

putText :: String -> P ()

Print text

removeCommentTo :: SrcSpan -> P [AnnotationComment]

Removes comments from the state up to start line of SrcSpan and returns the ones that were removed

removeCommentToEnd :: SrcSpan -> P [AnnotationComment]

Removes comments from the state up to end line of SrcSpan and returns the ones that were removed

removeLineComment :: Int -> P (Maybe AnnotationComment)

Gets comment on supplied line and removes it from the state

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

Add separator between each element of the given printers

groupAttachedComments :: [Located a] -> P [([AnnotationComment], NonEmpty (Located a))]

Get attached comments belonging to '[Located a]' given

space :: P ()

Print a space

spaces :: Int -> P ()

Print a number of spaces

suffix :: P a -> P b -> P a

Suffix a printer with another one

pad :: Int -> P ()

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

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

wrapping

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