Language.Haskell.GHC.ExactPrint.Types

Core Types

type Anns = Map AnnKey Annotation

This structure holds a complete set of annotations for an AST

emptyAnns :: Anns

data Annotation

Constructors

Ann

Fields

• annEntryDelta :: !DeltaPos

  Offset used to get to the start of the SrcSpan, from whatever the prior output was, including all annPriorComments (field below).

• annPriorComments :: ![(Comment, DeltaPos)]

  Comments coming after the last non-comment output of the preceding element but before the SrcSpan being annotated by this Annotation. If these are changed then annEntryDelta (field above) must also change to match.

• annFollowingComments :: ![(Comment, DeltaPos)]

  Comments coming after the last output for the element subject to this Annotation. These will only be added by AST transformations, and care must be taken not to disturb layout of following elements.

• annsDP :: ![(KeywordId, DeltaPos)]

  Annotations associated with this element.

• annSortKey :: !(Maybe [SrcSpan])

  Captures the sort order of sub elements. This is needed when the sub-elements have been split (as in a HsLocalBind which holds separate binds and sigs) or for infix patterns where the order has been re-arranged. It is captured explicitly so that after the Delta phase a SrcSpan is used purely as an index into the annotations, allowing transformations of the AST including the introduction of new Located items or re-arranging existing ones.

• annCapturedSpan :: !(Maybe AnnKey)

  Occasionally we must calculate a SrcSpan for an unlocated list of elements which we must remember for the Print phase. e.g. the statements in a HsLet or HsDo. These must be managed as a group because they all need eo be vertically aligned for the Haskell layout rules, and this guarantees this property in the presence of AST edits.

Instances

Eq Annotation

Methods

(==) :: Annotation -> Annotation -> Bool

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

Show Annotation

Methods

showsPrec :: Int -> Annotation -> ShowS

show :: Annotation -> String

showList :: [Annotation] -> ShowS

Outputable Annotation

Methods

ppr :: Annotation -> SDoc

pprPrec :: Rational -> Annotation -> SDoc

Monad m => MonadState (Anns, Int) (TransformT m)

Methods

get :: TransformT m (Anns, Int)

put :: (Anns, Int) -> TransformT m ()

state :: ((Anns, Int) -> (a, (Anns, Int))) -> TransformT m a

annNone :: Annotation

data KeywordId

The different syntactic elements which are not represented in the AST.

Constructors

G AnnKeywordId

A normal keyword

AnnSemiSep

A seperating comma

AnnComment Comment

AnnString String

Used to pass information from Delta to Print when we have to work out details from the original SrcSpan.

AnnUnicode AnnKeywordId

Used to indicate that we should print using unicode syntax if possible.

Instances

Eq KeywordId

Methods

(==) :: KeywordId -> KeywordId -> Bool

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

Ord KeywordId

Methods

compare :: KeywordId -> KeywordId -> Ordering

(<) :: KeywordId -> KeywordId -> Bool

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

(>) :: KeywordId -> KeywordId -> Bool

(>=) :: KeywordId -> KeywordId -> Bool

max :: KeywordId -> KeywordId -> KeywordId

min :: KeywordId -> KeywordId -> KeywordId

Show KeywordId

Methods

showsPrec :: Int -> KeywordId -> ShowS

show :: KeywordId -> String

showList :: [KeywordId] -> ShowS

Outputable KeywordId

Methods

ppr :: KeywordId -> SDoc

pprPrec :: Rational -> KeywordId -> SDoc

data Comment

A Haskell comment. The AnnKeywordId is present if it has been converted from an AnnKeywordId because the annotation must be interleaved into the stream and does not have a well-defined position

Constructors

Comment

Fields

• commentContents :: !String

  The contents of the comment including separators

• commentIdentifier :: !SrcSpan

  Needed to uniquely identify two comments with the same contents

• commentOrigin :: !(Maybe AnnKeywordId)

  We sometimes turn syntax into comments in order to process them properly.

Instances

Eq Comment

Methods

(==) :: Comment -> Comment -> Bool

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

Data Comment

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Comment -> c Comment

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Comment

toConstr :: Comment -> Constr

dataTypeOf :: Comment -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Comment)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Comment)

gmapT :: (forall b. Data b => b -> b) -> Comment -> Comment

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Comment -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Comment -> r

gmapQ :: (forall d. Data d => d -> u) -> Comment -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Comment -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Comment -> m Comment

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Comment -> m Comment

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Comment -> m Comment

Ord Comment

Methods

compare :: Comment -> Comment -> Ordering

(<) :: Comment -> Comment -> Bool

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

(>) :: Comment -> Comment -> Bool

(>=) :: Comment -> Comment -> Bool

max :: Comment -> Comment -> Comment

min :: Comment -> Comment -> Comment

Show Comment

Methods

showsPrec :: Int -> Comment -> ShowS

show :: Comment -> String

showList :: [Comment] -> ShowS

Outputable Comment

Methods

ppr :: Comment -> SDoc

pprPrec :: Rational -> Comment -> SDoc

Positions

type Pos = (Int, Int)

newtype DeltaPos

A relative positions, row then column

Constructors

DP (Int, Int)

Instances

Eq DeltaPos

Methods

(==) :: DeltaPos -> DeltaPos -> Bool

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

Data DeltaPos

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DeltaPos -> c DeltaPos

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DeltaPos

toConstr :: DeltaPos -> Constr

dataTypeOf :: DeltaPos -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DeltaPos)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DeltaPos)

gmapT :: (forall b. Data b => b -> b) -> DeltaPos -> DeltaPos

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DeltaPos -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DeltaPos -> r

gmapQ :: (forall d. Data d => d -> u) -> DeltaPos -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DeltaPos -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DeltaPos -> m DeltaPos

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DeltaPos -> m DeltaPos

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DeltaPos -> m DeltaPos

Ord DeltaPos

Methods

compare :: DeltaPos -> DeltaPos -> Ordering

(<) :: DeltaPos -> DeltaPos -> Bool

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

(>) :: DeltaPos -> DeltaPos -> Bool

(>=) :: DeltaPos -> DeltaPos -> Bool

max :: DeltaPos -> DeltaPos -> DeltaPos

min :: DeltaPos -> DeltaPos -> DeltaPos

Show DeltaPos

Methods

showsPrec :: Int -> DeltaPos -> ShowS

show :: DeltaPos -> String

showList :: [DeltaPos] -> ShowS

Outputable DeltaPos

Methods

ppr :: DeltaPos -> SDoc

pprPrec :: Rational -> DeltaPos -> SDoc

deltaRow :: DeltaPos -> Int

deltaColumn :: DeltaPos -> Int

AnnKey

data AnnKey

For every Located a, use the SrcSpan and constructor name of a as the key, to store the standard annotation. These are used to maintain context in the AP and EP monads

Constructors

AnnKey SrcSpan AnnConName

Instances

Eq AnnKey

Methods

(==) :: AnnKey -> AnnKey -> Bool

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

Ord AnnKey

Methods

compare :: AnnKey -> AnnKey -> Ordering

(<) :: AnnKey -> AnnKey -> Bool

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

(>) :: AnnKey -> AnnKey -> Bool

(>=) :: AnnKey -> AnnKey -> Bool

max :: AnnKey -> AnnKey -> AnnKey

min :: AnnKey -> AnnKey -> AnnKey

Show AnnKey

Methods

showsPrec :: Int -> AnnKey -> ShowS

show :: AnnKey -> String

showList :: [AnnKey] -> ShowS

Outputable AnnKey

Methods

ppr :: AnnKey -> SDoc

pprPrec :: Rational -> AnnKey -> SDoc

Monad m => MonadState (Anns, Int) (TransformT m)

Methods

get :: TransformT m (Anns, Int)

put :: (Anns, Int) -> TransformT m ()

state :: ((Anns, Int) -> (a, (Anns, Int))) -> TransformT m a

mkAnnKey :: Data a => Located a -> AnnKey

Make an unwrapped AnnKey for the LHsDecl case, a normal one otherwise.

data AnnConName

Constructors

CN

Fields

• unConName :: String

Instances

Eq AnnConName

Methods

(==) :: AnnConName -> AnnConName -> Bool

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

Ord AnnConName

Methods

compare :: AnnConName -> AnnConName -> Ordering

(<) :: AnnConName -> AnnConName -> Bool

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

(>) :: AnnConName -> AnnConName -> Bool

(>=) :: AnnConName -> AnnConName -> Bool

max :: AnnConName -> AnnConName -> AnnConName

min :: AnnConName -> AnnConName -> AnnConName

Show AnnConName

Methods

showsPrec :: Int -> AnnConName -> ShowS

show :: AnnConName -> String

showList :: [AnnConName] -> ShowS

Outputable AnnConName

Methods

ppr :: AnnConName -> SDoc

pprPrec :: Rational -> AnnConName -> SDoc

annGetConstr :: Data a => a -> AnnConName

Internal Types

newtype LayoutStartCol

Marks the start column of a layout block.

Constructors

LayoutStartCol

Fields

• getLayoutStartCol :: Int

Instances

Eq LayoutStartCol

Methods

(==) :: LayoutStartCol -> LayoutStartCol -> Bool

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

Num LayoutStartCol

Methods

(+) :: LayoutStartCol -> LayoutStartCol -> LayoutStartCol

(-) :: LayoutStartCol -> LayoutStartCol -> LayoutStartCol

(*) :: LayoutStartCol -> LayoutStartCol -> LayoutStartCol

negate :: LayoutStartCol -> LayoutStartCol

abs :: LayoutStartCol -> LayoutStartCol

signum :: LayoutStartCol -> LayoutStartCol

fromInteger :: Integer -> LayoutStartCol

Show LayoutStartCol

Methods

showsPrec :: Int -> LayoutStartCol -> ShowS

show :: LayoutStartCol -> String

showList :: [LayoutStartCol] -> ShowS

declFun :: (forall a. Data a => Located a -> b) -> LHsDecl RdrName -> b