Safe Haskell	Safe-Inferred
Language	Haskell2010

Language.Haskell.GHC.ExactPrint.Types

Synopsis

type Anns = Map AnnKey Annotation
emptyAnns :: Anns
data AnnKey = AnnKey RealSrcSpan AnnConName
mkAnnKeyPrim :: Data a => Located a -> AnnKey
mkAnnKeyPrimA :: Data a => LocatedA a -> AnnKey
data AnnConName = CN {
- unConName :: String
}
annGetConstr :: Data a => a -> AnnConName
mkAnnKey :: Data a => Located a -> AnnKey
type Pos = (Int, Int)
annNone :: Annotation
data Annotation = Ann {
- annEntryDelta :: !DeltaPos
- annPriorComments :: ![(Comment, DeltaPos)]
- annFollowingComments :: ![(Comment, DeltaPos)]
- annsDP :: ![(KeywordId, DeltaPos)]
- annSortKey :: !(Maybe [RealSrcSpan])
- annCapturedSpan :: !(Maybe AnnKey)
}
declFun :: (forall a. Data a => LocatedA a -> b) -> LHsDecl GhcPs -> b
data Rigidity
- = NormalLayout
- | RigidLayout
data Comment = Comment {
- commentContents :: !String
- commentAnchor :: !Anchor
- commentOrigin :: !(Maybe AnnKeywordId)
}
data KeywordId
- = G AnnKeywordId
- | AnnSemiSep
- | AnnTypeApp
- | AnnComment Comment
- | AnnString String
newtype LayoutStartCol = LayoutStartCol {
- getLayoutStartCol :: Int
}
showGhc :: Outputable a => a -> String

Documentation

type Anns = Map AnnKey Annotation Source #

This structure holds a complete set of annotations for an AST

emptyAnns :: Anns Source #

data AnnKey Source #

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 RealSrcSpan AnnConName

Instances

Instances details

Data AnnKey Source #
Instance details Defined in Language.Haskell.GHC.ExactPrint.Types Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AnnKey -> c AnnKey # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AnnKey # toConstr :: AnnKey -> Constr # dataTypeOf :: AnnKey -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c AnnKey) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AnnKey) # gmapT :: (forall b. Data b => b -> b) -> AnnKey -> AnnKey # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AnnKey -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AnnKey -> r # gmapQ :: (forall d. Data d => d -> u) -> AnnKey -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> AnnKey -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> AnnKey -> m AnnKey # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AnnKey -> m AnnKey # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AnnKey -> m AnnKey #
Show AnnKey Source #
Instance details Defined in Language.Haskell.GHC.ExactPrint.Types Methods showsPrec :: Int -> AnnKey -> ShowS # show :: AnnKey -> String # showList :: [AnnKey] -> ShowS #
Eq AnnKey Source #
Instance details Defined in Language.Haskell.GHC.ExactPrint.Types Methods (==) :: AnnKey -> AnnKey -> Bool # (/=) :: AnnKey -> AnnKey -> Bool #
Ord AnnKey Source #
Instance details Defined in Language.Haskell.GHC.ExactPrint.Types 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 #
Monad m => MonadState (Anns, Int) (TransformT m) Source #
Instance details Defined in Language.Haskell.GHC.ExactPrint.Transform Methods get :: TransformT m (Anns, Int) # put :: (Anns, Int) -> TransformT m () # state :: ((Anns, Int) -> (a, (Anns, Int))) -> TransformT m a #

mkAnnKeyPrim :: Data a => Located a -> AnnKey Source #

mkAnnKeyPrimA :: Data a => LocatedA a -> AnnKey Source #

data AnnConName Source #

Constructors

CN
Fields unConName :: String

Instances

Instances details

Data AnnConName Source #
Instance details Defined in Language.Haskell.GHC.ExactPrint.Types Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AnnConName -> c AnnConName # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AnnConName # toConstr :: AnnConName -> Constr # dataTypeOf :: AnnConName -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c AnnConName) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AnnConName) # gmapT :: (forall b. Data b => b -> b) -> AnnConName -> AnnConName # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AnnConName -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AnnConName -> r # gmapQ :: (forall d. Data d => d -> u) -> AnnConName -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> AnnConName -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> AnnConName -> m AnnConName # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AnnConName -> m AnnConName # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AnnConName -> m AnnConName #
Show AnnConName Source #
Instance details Defined in Language.Haskell.GHC.ExactPrint.Types Methods showsPrec :: Int -> AnnConName -> ShowS # show :: AnnConName -> String # showList :: [AnnConName] -> ShowS #
Eq AnnConName Source #
Instance details Defined in Language.Haskell.GHC.ExactPrint.Types Methods (==) :: AnnConName -> AnnConName -> Bool # (/=) :: AnnConName -> AnnConName -> Bool #
Ord AnnConName Source #
Instance details Defined in Language.Haskell.GHC.ExactPrint.Types 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 #

annGetConstr :: Data a => a -> AnnConName Source #

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

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

type Pos = (Int, Int) Source #

annNone :: Annotation Source #

data Annotation Source #

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 [RealSrcSpan])
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

Instances details

Eq Annotation Source #
Instance details Defined in Language.Haskell.GHC.ExactPrint.Types Methods (==) :: Annotation -> Annotation -> Bool # (/=) :: Annotation -> Annotation -> Bool #
Monad m => MonadState (Anns, Int) (TransformT m) Source #
Instance details Defined in Language.Haskell.GHC.ExactPrint.Transform Methods get :: TransformT m (Anns, Int) # put :: (Anns, Int) -> TransformT m () # state :: ((Anns, Int) -> (a, (Anns, Int))) -> TransformT m a #

declFun :: (forall a. Data a => LocatedA a -> b) -> LHsDecl GhcPs -> b Source #

data Rigidity Source #

Constructors

NormalLayout
RigidLayout

Instances

Instances details

Show Rigidity Source #
Instance details Defined in Language.Haskell.GHC.ExactPrint.Types Methods showsPrec :: Int -> Rigidity -> ShowS # show :: Rigidity -> String # showList :: [Rigidity] -> ShowS #
Eq Rigidity Source #
Instance details Defined in Language.Haskell.GHC.ExactPrint.Types Methods (==) :: Rigidity -> Rigidity -> Bool # (/=) :: Rigidity -> Rigidity -> Bool #
Ord Rigidity Source #
Instance details Defined in Language.Haskell.GHC.ExactPrint.Types Methods compare :: Rigidity -> Rigidity -> Ordering # (<) :: Rigidity -> Rigidity -> Bool # (<=) :: Rigidity -> Rigidity -> Bool # (>) :: Rigidity -> Rigidity -> Bool # (>=) :: Rigidity -> Rigidity -> Bool # max :: Rigidity -> Rigidity -> Rigidity # min :: Rigidity -> Rigidity -> Rigidity #

data Comment Source #

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 commentAnchor :: !Anchor commentOrigin :: !(Maybe AnnKeywordId) We sometimes turn syntax into comments in order to process them properly.

Instances

Instances details

Show Comment Source #
Instance details Defined in Language.Haskell.GHC.ExactPrint.Types Methods showsPrec :: Int -> Comment -> ShowS # show :: Comment -> String # showList :: [Comment] -> ShowS #
Outputable Comment Source #
Instance details Defined in Language.Haskell.GHC.ExactPrint.Types Methods ppr :: Comment -> SDoc #
Eq Comment Source #
Instance details Defined in Language.Haskell.GHC.ExactPrint.Types Methods (==) :: Comment -> Comment -> Bool # (/=) :: Comment -> Comment -> Bool #
Ord Comment Source #
Instance details Defined in Language.Haskell.GHC.ExactPrint.Types 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 #

data KeywordId Source #

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

Constructors

G AnnKeywordId	A normal keyword
AnnSemiSep	A separating comma
AnnTypeApp	Visible type application annotation
AnnComment Comment
AnnString String	Used to pass information from Delta to Print when we have to work out details from the original SrcSpan.

Instances

Instances details

Show KeywordId Source #
Instance details Defined in Language.Haskell.GHC.ExactPrint.Types Methods showsPrec :: Int -> KeywordId -> ShowS # show :: KeywordId -> String # showList :: [KeywordId] -> ShowS #
Eq KeywordId Source #
Instance details Defined in Language.Haskell.GHC.ExactPrint.Types Methods (==) :: KeywordId -> KeywordId -> Bool # (/=) :: KeywordId -> KeywordId -> Bool #

newtype LayoutStartCol Source #

Marks the start column of a layout block.

Constructors

LayoutStartCol
Fields getLayoutStartCol :: Int

Instances

Instances details

Num LayoutStartCol Source #
Instance details Defined in Language.Haskell.GHC.ExactPrint.Types Methods (+) :: LayoutStartCol -> LayoutStartCol -> LayoutStartCol # (-) :: LayoutStartCol -> LayoutStartCol -> LayoutStartCol # (*) :: LayoutStartCol -> LayoutStartCol -> LayoutStartCol # negate :: LayoutStartCol -> LayoutStartCol # abs :: LayoutStartCol -> LayoutStartCol # signum :: LayoutStartCol -> LayoutStartCol # fromInteger :: Integer -> LayoutStartCol #
Show LayoutStartCol Source #
Instance details Defined in Language.Haskell.GHC.ExactPrint.Types Methods showsPrec :: Int -> LayoutStartCol -> ShowS # show :: LayoutStartCol -> String # showList :: [LayoutStartCol] -> ShowS #
Eq LayoutStartCol Source #
Instance details Defined in Language.Haskell.GHC.ExactPrint.Types Methods (==) :: LayoutStartCol -> LayoutStartCol -> Bool # (/=) :: LayoutStartCol -> LayoutStartCol -> Bool #

showGhc :: Outputable a => a -> String Source #