HIndent.Types

All types.

Documentation

newtype Printer a

A pretty printing monad.

Constructors

Printer

Fields

• runPrinter :: StateT PrintState (MaybeT Identity) a

Instances

Monad Printer

Defined in HIndent.Types

Methods

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

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

return :: a -> Printer a

Functor Printer

Defined in HIndent.Types

Methods

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

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

Applicative Printer

Defined in HIndent.Types

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

MonadPlus Printer

Defined in HIndent.Types

Methods

mzero :: Printer a

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

Alternative Printer

Defined in HIndent.Types

Methods

empty :: Printer a

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

some :: Printer a -> Printer [a]

many :: Printer a -> Printer [a]

MonadState PrintState Printer

Defined in HIndent.Types

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, i.e. every time there's a new-line, output this many spaces.

• psOutput :: !Builder

  The current output bytestring builder.

• psNewline :: !Bool

  Just outputted a newline?

• psColumn :: !Int64

  Current column.

• psLine :: !Int64

  Current line number.

• psConfig :: !Config

  Configuration of max colums and indentation style.

• psInsideCase :: !Bool

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

• psFitOnOneLine :: !Bool

  Bail out if we need to print beyond the current line or the maximum column.

• psEolComment :: !Bool

Instances

MonadState PrintState Printer

Defined in HIndent.Types

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?

• configTrailingNewline :: !Bool

  End with a newline.

• configSortImports :: !Bool

  Sort imports in groups.

• configLineBreaks :: [String]

  Break line when meets these operators.

• configExtensions :: [Extension]

  Extra language extensions enabled by default.

Instances

FromJSON Config

Defined in HIndent.Types

Methods

parseJSON :: Value -> Parser Config

parseJSONList :: Value -> Parser [Config]

readExtension :: (Monad m, MonadFail m) => String -> m Extension

Parse an extension.

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 :: ![NodeComment]

  Comments attached to this node.

Instances

Show NodeInfo

Defined in HIndent.Types

Methods

showsPrec :: Int -> NodeInfo -> ShowS

show :: NodeInfo -> String

showList :: [NodeInfo] -> ShowS

data NodeComment

Comment associated with a node. SrcSpan is the original source span of the comment.

Constructors

CommentSameLine SrcSpan SomeComment

CommentAfterLine SrcSpan SomeComment

CommentBeforeLine SrcSpan SomeComment

Instances

Eq NodeComment

Defined in HIndent.Types

Methods

(==) :: NodeComment -> NodeComment -> Bool

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

Ord NodeComment

Defined in HIndent.Types

Methods

compare :: NodeComment -> NodeComment -> Ordering

(<) :: NodeComment -> NodeComment -> Bool

(<=) :: NodeComment -> NodeComment -> Bool

(>) :: NodeComment -> NodeComment -> Bool

(>=) :: NodeComment -> NodeComment -> Bool

max :: NodeComment -> NodeComment -> NodeComment

min :: NodeComment -> NodeComment -> NodeComment

Show NodeComment

Defined in HIndent.Types

Methods

showsPrec :: Int -> NodeComment -> ShowS

show :: NodeComment -> String

showList :: [NodeComment] -> ShowS

data SomeComment

Some comment to print.

Constructors

EndOfLine String

MultiLine String

Instances

Eq SomeComment

Defined in HIndent.Types

Methods

(==) :: SomeComment -> SomeComment -> Bool

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

Ord SomeComment

Defined in HIndent.Types

Methods

compare :: SomeComment -> SomeComment -> Ordering

(<) :: SomeComment -> SomeComment -> Bool

(<=) :: SomeComment -> SomeComment -> Bool

(>) :: SomeComment -> SomeComment -> Bool

(>=) :: SomeComment -> SomeComment -> Bool

max :: SomeComment -> SomeComment -> SomeComment

min :: SomeComment -> SomeComment -> SomeComment

Show SomeComment

Defined in HIndent.Types

Methods

showsPrec :: Int -> SomeComment -> ShowS

show :: SomeComment -> String

showList :: [SomeComment] -> ShowS