Safe Haskell	None
Language	Haskell2010

Language.Haskell.Brittany.Internal.Types

Documentation

type PPM = MultiRWS '[Map AnnKey Anns, Config, Anns] '[Builder, [BrittanyError], Seq String] '[] #

type PPMLocal = MultiRWS '[Config, Anns] '[Builder, [BrittanyError], Seq String] '[] #

data LayoutState #

Constructors

LayoutState

Fields

_lstate_baseYs :: [Int]
stack of number of current indentation columns (not number of indentations).
_lstate_curYOrAddNewline :: Either Int Int
Either: 1) number of chars in the current line. 2) number of newlines to be inserted before inserting any non-space elements.
_lstate_indLevels :: [Int]
stack of current indentation levels. set for any layout-affected elements such as letdocase/where elements. The main purpose of this member is to properly align comments, as their annotation positions are relative to the current layout indentation level.
_lstate_indLevelLinger :: Int
_lstate_comments :: Anns
_lstate_commentCol :: Maybe Int
_lstate_addSepSpace :: Maybe Int

Instances

Show LayoutState #
Methods showsPrec :: Int -> LayoutState -> ShowS # show :: LayoutState -> String # showList :: [LayoutState] -> ShowS #

lstate_baseY :: LayoutState -> Int #

lstate_indLevel :: LayoutState -> Int #

data BrittanyError #

Constructors

ErrorInput String	parsing failed
ErrorUnusedComment String	internal error: some comment went missing
LayoutWarning String	some warning
Data ast => ErrorUnknownNode String ast	internal error: pretty-printing is not implemented for type of node in the syntax-tree
ErrorOutputCheck	checking the output for syntactic validity failed

data BriSpacing #

Constructors

BriSpacing
Fields _bs_spacePastLineIndent :: Int _bs_spacePastIndent :: Int

data ColSig #

Constructors

ColTyOpPrefix
ColPatternsFuncPrefix
ColPatternsFuncInfix
ColPatterns
ColCasePattern
ColBindingLine (Maybe Text)
ColGuard
ColGuardedBody
ColBindStmt
ColDoLet
ColRecUpdate
ColListComp
ColList
ColApp
ColTuple
ColTuples
ColOpPrefix

Instances

Eq ColSig #
Methods (==) :: ColSig -> ColSig -> Bool # (/=) :: ColSig -> ColSig -> Bool #
Data ColSig #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ColSig -> c ColSig # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ColSig # toConstr :: ColSig -> Constr # dataTypeOf :: ColSig -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c ColSig) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ColSig) # gmapT :: (forall b. Data b => b -> b) -> ColSig -> ColSig # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ColSig -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ColSig -> r # gmapQ :: (forall d. Data d => d -> u) -> ColSig -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ColSig -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ColSig -> m ColSig # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ColSig -> m ColSig # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ColSig -> m ColSig #
Ord ColSig #
Methods compare :: ColSig -> ColSig -> Ordering # (<) :: ColSig -> ColSig -> Bool # (<=) :: ColSig -> ColSig -> Bool # (>) :: ColSig -> ColSig -> Bool # (>=) :: ColSig -> ColSig -> Bool # max :: ColSig -> ColSig -> ColSig # min :: ColSig -> ColSig -> ColSig #
Show ColSig #
Methods showsPrec :: Int -> ColSig -> ShowS # show :: ColSig -> String # showList :: [ColSig] -> ShowS #

data BrIndent #

Constructors

BrIndentNone
BrIndentRegular
BrIndentSpecial Int

Instances

Eq BrIndent #
Methods (==) :: BrIndent -> BrIndent -> Bool # (/=) :: BrIndent -> BrIndent -> Bool #
Data BrIndent #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> BrIndent -> c BrIndent # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c BrIndent # toConstr :: BrIndent -> Constr # dataTypeOf :: BrIndent -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c BrIndent) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c BrIndent) # gmapT :: (forall b. Data b => b -> b) -> BrIndent -> BrIndent # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> BrIndent -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> BrIndent -> r # gmapQ :: (forall d. Data d => d -> u) -> BrIndent -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> BrIndent -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> BrIndent -> m BrIndent # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> BrIndent -> m BrIndent # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> BrIndent -> m BrIndent #
Ord BrIndent #
Methods compare :: BrIndent -> BrIndent -> Ordering # (<) :: BrIndent -> BrIndent -> Bool # (<=) :: BrIndent -> BrIndent -> Bool # (>) :: BrIndent -> BrIndent -> Bool # (>=) :: BrIndent -> BrIndent -> Bool # max :: BrIndent -> BrIndent -> BrIndent # min :: BrIndent -> BrIndent -> BrIndent #
Show BrIndent #
Methods showsPrec :: Int -> BrIndent -> ShowS # show :: BrIndent -> String # showList :: [BrIndent] -> ShowS #

type ToBriDocM = MultiRWS '[Config, Anns] '[[BrittanyError], Seq String] '[NodeAllocIndex] #

type ToBriDoc (sym :: * -> *) = Located (sym RdrName) -> ToBriDocM BriDocNumbered #

type ToBriDoc' sym = Located sym -> ToBriDocM BriDocNumbered #

type ToBriDocC sym c = Located sym -> ToBriDocM c #

data DocMultiLine #

Constructors

MultiLineNo
MultiLinePossible

Instances

Eq DocMultiLine #
Methods (==) :: DocMultiLine -> DocMultiLine -> Bool # (/=) :: DocMultiLine -> DocMultiLine -> Bool #

data BriDoc #

Constructors

BDEmpty
BDLit !Text
BDSeq [BriDoc]
BDCols ColSig [BriDoc]
BDSeparator
BDAddBaseY BrIndent BriDoc
BDBaseYPushCur BriDoc
BDBaseYPop BriDoc
BDIndentLevelPushCur BriDoc
BDIndentLevelPop BriDoc
BDPar
Fields _bdpar_indent :: BrIndent _bdpar_restOfLine :: BriDoc _bdpar_indented :: BriDoc
BDAlt [BriDoc]	BDAddIndent BrIndent (BriDocF f) \| BDNewline
BDForwardLineMode BriDoc
BDExternal AnnKey (Set AnnKey) Bool Text
BDAnnotationPrior AnnKey BriDoc
BDAnnotationKW AnnKey (Maybe AnnKeywordId) BriDoc
BDAnnotationRest AnnKey BriDoc
BDLines [BriDoc]
BDEnsureIndent BrIndent BriDoc
BDForceMultiline BriDoc
BDForceSingleline BriDoc
BDNonBottomSpacing BriDoc
BDSetParSpacing BriDoc
BDForceParSpacing BriDoc
BDDebug String BriDoc

Instances

Eq BriDoc #
Methods (==) :: BriDoc -> BriDoc -> Bool # (/=) :: BriDoc -> BriDoc -> Bool #
Data BriDoc #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> BriDoc -> c BriDoc # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c BriDoc # toConstr :: BriDoc -> Constr # dataTypeOf :: BriDoc -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c BriDoc) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c BriDoc) # gmapT :: (forall b. Data b => b -> b) -> BriDoc -> BriDoc # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> BriDoc -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> BriDoc -> r # gmapQ :: (forall d. Data d => d -> u) -> BriDoc -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> BriDoc -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> BriDoc -> m BriDoc # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> BriDoc -> m BriDoc # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> BriDoc -> m BriDoc #
Ord BriDoc #
Methods compare :: BriDoc -> BriDoc -> Ordering # (<) :: BriDoc -> BriDoc -> Bool # (<=) :: BriDoc -> BriDoc -> Bool # (>) :: BriDoc -> BriDoc -> Bool # (>=) :: BriDoc -> BriDoc -> Bool # max :: BriDoc -> BriDoc -> BriDoc # min :: BriDoc -> BriDoc -> BriDoc #
Uniplate BriDoc #
Methods uniplate :: BriDoc -> (Str BriDoc, Str BriDoc -> BriDoc) # descend :: (BriDoc -> BriDoc) -> BriDoc -> BriDoc # descendM :: Monad m => (BriDoc -> m BriDoc) -> BriDoc -> m BriDoc #

data BriDocF f #

Constructors

BDFEmpty
BDFLit !Text
BDFSeq [f (BriDocF f)]
BDFCols ColSig [f (BriDocF f)]
BDFSeparator
BDFAddBaseY BrIndent (f (BriDocF f))
BDFBaseYPushCur (f (BriDocF f))
BDFBaseYPop (f (BriDocF f))
BDFIndentLevelPushCur (f (BriDocF f))
BDFIndentLevelPop (f (BriDocF f))
BDFPar
Fields _bdfpar_indent :: BrIndent _bdfpar_restOfLine :: f (BriDocF f) _bdfpar_indented :: f (BriDocF f)
BDFAlt [f (BriDocF f)]	BDAddIndent BrIndent (BriDocF f) \| BDNewline
BDFForwardLineMode (f (BriDocF f))
BDFExternal AnnKey (Set AnnKey) Bool Text
BDFAnnotationPrior AnnKey (f (BriDocF f))
BDFAnnotationKW AnnKey (Maybe AnnKeywordId) (f (BriDocF f))
BDFAnnotationRest AnnKey (f (BriDocF f))
BDFLines [f (BriDocF f)]
BDFEnsureIndent BrIndent (f (BriDocF f))
BDFForceMultiline (f (BriDocF f))
BDFForceSingleline (f (BriDocF f))
BDFNonBottomSpacing (f (BriDocF f))
BDFSetParSpacing (f (BriDocF f))
BDFForceParSpacing (f (BriDocF f))
BDFDebug String (f (BriDocF f))

Instances

Data (BriDocF ((,) Int)) #

type BriDocFInt = BriDocF ((,) Int) #

type BriDocNumbered = (Int, BriDocFInt) #

newtype NodeAllocIndex #

Constructors

NodeAllocIndex Int

unwrapBriDocNumbered :: BriDocNumbered -> BriDoc #

isNotEmpty :: BriDoc -> Bool #

briDocSeqSpine :: BriDoc -> () #

briDocForceSpine :: BriDoc -> BriDoc #

data VerticalSpacingPar #

Constructors

VerticalSpacingParNone
VerticalSpacingParSome Int
VerticalSpacingParAlways Int

Instances

Eq VerticalSpacingPar #
Methods (==) :: VerticalSpacingPar -> VerticalSpacingPar -> Bool # (/=) :: VerticalSpacingPar -> VerticalSpacingPar -> Bool #
Show VerticalSpacingPar #
Methods showsPrec :: Int -> VerticalSpacingPar -> ShowS # show :: VerticalSpacingPar -> String # showList :: [VerticalSpacingPar] -> ShowS #

data VerticalSpacing #

Constructors

VerticalSpacing
Fields _vs_sameLine :: !Int _vs_paragraph :: !VerticalSpacingPar _vs_parFlag :: !Bool

Instances

Eq VerticalSpacing #
Methods (==) :: VerticalSpacing -> VerticalSpacing -> Bool # (/=) :: VerticalSpacing -> VerticalSpacing -> Bool #
Show VerticalSpacing #
Methods showsPrec :: Int -> VerticalSpacing -> ShowS # show :: VerticalSpacing -> String # showList :: [VerticalSpacing] -> ShowS #

newtype LineModeValidity a #

Constructors

LineModeValidity (Maybe a)

Instances

Monad LineModeValidity #
Methods (>>=) :: LineModeValidity a -> (a -> LineModeValidity b) -> LineModeValidity b # (>>) :: LineModeValidity a -> LineModeValidity b -> LineModeValidity b # return :: a -> LineModeValidity a # fail :: String -> LineModeValidity a #
Functor LineModeValidity #
Methods fmap :: (a -> b) -> LineModeValidity a -> LineModeValidity b # (<$) :: a -> LineModeValidity b -> LineModeValidity a #
Applicative LineModeValidity #
Methods pure :: a -> LineModeValidity a # (<>) :: LineModeValidity (a -> b) -> LineModeValidity a -> LineModeValidity b # liftA2 :: (a -> b -> c) -> LineModeValidity a -> LineModeValidity b -> LineModeValidity c # (>) :: LineModeValidity a -> LineModeValidity b -> LineModeValidity b # (<*) :: LineModeValidity a -> LineModeValidity b -> LineModeValidity a #
Alternative LineModeValidity #
Methods empty :: LineModeValidity a # (<\|>) :: LineModeValidity a -> LineModeValidity a -> LineModeValidity a # some :: LineModeValidity a -> LineModeValidity [a] # many :: LineModeValidity a -> LineModeValidity [a] #
Show a => Show (LineModeValidity a) #
Methods showsPrec :: Int -> LineModeValidity a -> ShowS # show :: LineModeValidity a -> String # showList :: [LineModeValidity a] -> ShowS #

pattern LineModeValid :: forall t. t -> LineModeValidity t #

pattern LineModeInvalid :: forall t. LineModeValidity t #