Language.Haskell.GHC.ExactPrint.Transform · ghc-exactprint-1.10.0.0

The Transform Monad

7 declarations

typetype Transform = TransformT Identity

Monad type for updating the AST and managing the annotations at the same time. The W state is used to generate logging information if required.

newtypenewtype TransformT (m :: Type -> Type) a

#

Monad transformer version of Transform monad

Constructors

TransformT
- unTransformT :: RWST () [String] Int m a

Instances9MonadTrans, MonadReader, MonadState, Monad, Functor, MonadFail, …

MonadTrans TransformTDefined in ghc-exactprint-1.10.0.0 · Language.Haskell.GHC.ExactPrint.Transform
Monad m => MonadReader () (TransformT m)Defined in ghc-exactprint-1.10.0.0 · Language.Haskell.GHC.ExactPrint.Transform
Monad m => MonadState Int (TransformT m)Defined in ghc-exactprint-1.10.0.0 · Language.Haskell.GHC.ExactPrint.Transform
Monad m => Monad (TransformT m)Defined in ghc-exactprint-1.10.0.0 · Language.Haskell.GHC.ExactPrint.Transform
Functor m => Functor (TransformT m)Defined in ghc-exactprint-1.10.0.0 · Language.Haskell.GHC.ExactPrint.Transform
MonadFail m => MonadFail (TransformT m)Defined in ghc-exactprint-1.10.0.0 · Language.Haskell.GHC.ExactPrint.Transform
Monad m => Applicative (TransformT m)Defined in ghc-exactprint-1.10.0.0 · Language.Haskell.GHC.ExactPrint.Transform
Monad m => HasTransform (TransformT m)Defined in ghc-exactprint-1.10.0.0 · Language.Haskell.GHC.ExactPrint.Transform
Monad m => MonadWriter [String] (TransformT m)Defined in ghc-exactprint-1.10.0.0 · Language.Haskell.GHC.ExactPrint.Transform

valuehoistTransform :: (forall x. m x -> n x) -> TransformT m a -> TransformT n a

#

Change inner monad of TransformT.

valuerunTransform :: Transform a -> (a, Int, [String])

#

Run a transformation in the Transform monad, returning the updated annotations and any logging generated via logTr

valuerunTransformT :: TransformT m a -> m (a, Int, [String])

#

valuerunTransformFrom :: Int -> Transform a -> (a, Int, [String])

#

Run a transformation in the Transform monad, returning the updated annotations and any logging generated via logTr, allocating any new SrcSpans from the provided initial value.

valuerunTransformFromT :: Int -> TransformT m a -> m (a, Int, [String])

#

Run a monad transformer stack for the TransformT monad transformer

Transform monad operations

3 declarations

valuelogTr :: Monad m => String -> TransformT m ()

#

Log a string to the output of the Monad

valuelogDataWithAnnsTr :: (Monad m, Data a) => String -> a -> TransformT m ()

#

Log a representation of the given AST with annotations to the output of the Monad

valueuniqueSrcSpanT :: Monad m => TransformT m SrcSpan

#

If we need to add new elements to the AST, they need their own SrcSpan for this. This should no longer be needed, we use an EpaDelta location instead.

Managing declarations, in Transform monad

classclass Monad m => HasTransform (m :: Type -> Type) where

#

Used to integrate a Transform into other Monad stacks

Methods

liftT :: Transform a -> m a

Instances1HasTransform

Monad m => HasTransform (TransformT m)Defined in ghc-exactprint-1.10.0.0 · Language.Haskell.GHC.ExactPrint.Transform

classclass Data t => HasDecls t where

#

Provide a means to get and process the immediate child declarations of a given AST element.

Methods

hsDecls :: t -> [LHsDecl GhcPs]
Return the HsDecls that are directly enclosed in the given syntax phrase. They are always returned in the wrapped HsDecl form, even if orginating in local decls. This is safe, as annotations never attach to the wrapper, only to the wrapped item.
replaceDecls :: t -> [LHsDecl GhcPs] -> t
Replace the directly enclosed decl list by the given decl list. As parto of replacing it will update list order annotations, and rebalance comments and other layout changes as needed.
For example, a call on replaceDecls for a wrapped FunBind having no where clause will convert
```
-- |This is a function
foo = x -- comment1
```
in to
```
-- |This is a function
foo = x -- comment1
  where
    nn = 2
```

Instances5HasDecls

HasDecls ParsedSourceDefined in ghc-exactprint-1.10.0.0 · Language.Haskell.GHC.ExactPrint.Transform
HasDecls (LocatedA (HsDecl GhcPs))Defined in ghc-exactprint-1.10.0.0 · Language.Haskell.GHC.ExactPrint.Transform
HasDecls (LocatedA (HsExpr GhcPs))Defined in ghc-exactprint-1.10.0.0 · Language.Haskell.GHC.ExactPrint.Transform
HasDecls (LocatedA (Match GhcPs (LocatedA (HsExpr GhcPs))))Defined in ghc-exactprint-1.10.0.0 · Language.Haskell.GHC.ExactPrint.Transform
HasDecls (LocatedA (Stmt GhcPs (LocatedA (HsExpr GhcPs))))Defined in ghc-exactprint-1.10.0.0 · Language.Haskell.GHC.ExactPrint.Transform

valuehsDeclsPatBind :: LHsBind GhcPs -> [LHsDecl GhcPs]

#

Extract the immediate declarations for a PatBind. This cannot be a member of HasDecls because a FunBind is not idempotent for hsDecls / replaceDecls. hsDeclsPatBind / replaceDeclsPatBind is idempotent.

valuehsDeclsPatBindD :: LHsDecl GhcPs -> [LHsDecl GhcPs]

#

Extract the immediate declarations for a PatBind wrapped in a ValD. This cannot be a member of HasDecls because a FunBind is not idempotent for hsDecls / replaceDecls. hsDeclsPatBindD / replaceDeclsPatBindD is idempotent.

valuereplaceDeclsPatBind :: LHsBind GhcPs -> [LHsDecl GhcPs] -> LHsBind GhcPs

#

Replace the immediate declarations for a PatBind. This cannot be a member of HasDecls because a FunBind is not idempotent for hsDecls / replaceDecls. hsDeclsPatBind / replaceDeclsPatBind is idempotent.

valuereplaceDeclsPatBindD :: LHsDecl GhcPs -> [LHsDecl GhcPs] -> LHsDecl GhcPs

#

Replace the immediate declarations for a PatBind wrapped in a ValD. This cannot be a member of HasDecls because a FunBind is not idempotent for hsDecls / replaceDecls. hsDeclsPatBindD / replaceDeclsPatBindD is idempotent.

valuemodifyDeclsT

:: (HasDecls t, HasTransform m)
=> [LHsDecl GhcPs] -> m [LHsDecl GhcPs]
-> t
-> m t

#

Apply a transformation to the decls contained in t

valuemodifyValD

:: SrcSpan
-> Decl
-> PMatch -> [Decl] -> ([Decl], Maybe t)
-> (Decl, Maybe t)

#

Modify a LHsBind wrapped in a ValD. For a PatBind the declarations are extracted and returned after modification. For a FunBind the supplied SrcSpan is used to identify the specific Match to be transformed, for when there are multiple of them.

Utility, does not manage layout

valuehsDeclsValBinds :: HsValBindsLR GhcPs GhcPs -> [LHsDecl GhcPs]

#

valuereplaceDeclsValbinds

#

Utility function for returning decls to HsLocalBinds. Use with care, as this does not manage the declaration order, the ordering should be done by the calling function from the HsLocalBinds context in the AST.

datadata WithWhere

#

WithWhere WithoutWhere

Instances2Eq, Show

Eq WithWhereDefined in ghc-exactprint-1.10.0.0 · Language.Haskell.GHC.ExactPrint.Transform
Show WithWhereDefined in ghc-exactprint-1.10.0.0 · Language.Haskell.GHC.ExactPrint.Transform

New gen functions

valuenoAnnSrcSpanDP :: NoAnn ann => DeltaPos -> EpAnn ann

#

Create a SrcSpanAnn with a MovedAnchor operation using the given DeltaPos.

valuenoAnnSrcSpanDP0 :: NoAnn ann => EpAnn ann

#

valuenoAnnSrcSpanDP1 :: NoAnn ann => EpAnn ann

#

valuenoAnnSrcSpanDPn :: NoAnn ann => Int -> EpAnn ann

#

valued0 :: EpaLocation

#

valued1 :: EpaLocation

#

valuedn :: Int -> EpaLocation

#

valueaddComma :: SrcSpanAnnA -> SrcSpanAnnA

#

Managing lists, Transform monad

valueinsertAt

:: HasDecls ast
=> LHsDecl GhcPs -> [LHsDecl GhcPs] -> [LHsDecl GhcPs]
-> ast
-> LHsDecl GhcPs
-> ast

#

Insert a declaration into an AST element having sub-declarations (HasDecls) according to the given location function.

valueinsertAtStart :: HasDecls ast => ast -> LHsDecl GhcPs -> ast

#

Insert a declaration at the beginning or end of the subdecls of the given AST item

valueinsertAtEnd :: HasDecls ast => ast -> LHsDecl GhcPs -> ast

#

Insert a declaration at the beginning or end of the subdecls of the given AST item

valueinsertAfter

:: HasDecls (LocatedA ast)
=> LocatedA old
-> LocatedA ast
-> LHsDecl GhcPs
-> LocatedA ast

#

Insert a declaration at a specific location in the subdecls of the given AST item

valueinsertBefore

:: HasDecls (LocatedA ast)
=> LocatedA old
-> LocatedA ast
-> LHsDecl GhcPs
-> LocatedA ast

#

Insert a declaration at a specific location in the subdecls of the given AST item

Low level operations used in HasDecls

valuebalanceComments

#

The GHC parser puts all comments appearing between the end of one AST item and the beginning of the next as annPriorComments for the second one. This function takes two adjacent AST items and moves any annPriorComments from the second one to the annFollowingComments of the first if they belong to it instead. This is typically required before deleting or duplicating either of the AST elements.

valuebalanceCommentsList :: [LHsDecl GhcPs] -> [LHsDecl GhcPs]

#

If we compile in haddock mode we get DocDecls, which we strip out while exact printing. Make sure we do not balance any comments on to them be stripping them out here already.

valuebalanceCommentsListA :: [LocatedA a] -> [LocatedA a]

#

valueanchorEof :: ParsedSource -> ParsedSource

#

Managing lists, pure functions

valuecaptureOrderBinds :: [LHsDecl GhcPs] -> AnnSortKey BindTag

#

valuecaptureLineSpacing :: [LocatedA e] -> [LocatedA e]

#

valuecaptureMatchLineSpacing :: LHsDecl GhcPs -> LHsDecl GhcPs

#

valuecaptureTypeSigSpacing :: LHsDecl GhcPs -> LHsDecl GhcPs

#

Operations

1 declaration

valueisUniqueSrcSpan :: SrcSpan -> Bool

#

Test whether a given SrcSpan was generated by uniqueSrcSpanT

Pure functions

9 declarations

valuesetEntryDP :: LocatedAn t a -> DeltaPos -> LocatedAn t a

#

Set the true entry DeltaPos from the annotation for a given AST element. This is the DeltaPos ignoring any comments.

valuesetEntryDPDecl :: LHsDecl GhcPs -> DeltaPos -> LHsDecl GhcPs

#

valuegetEntryDP :: LocatedAn t a -> DeltaPos

#

valuetransferEntryDP

:: (Typeable t1, Typeable t2)
=> LocatedAn t1 a
-> LocatedAn t2 b
-> LocatedAn t2 b

#

Take the annEntryDelta associated with the first item and associate it with the second. Also transfer any comments occurring before it.

valuetransferEntryDP' :: LHsDecl GhcPs -> LHsDecl GhcPs -> LHsDecl GhcPs

#

Take the annEntryDelta associated with the first item and associate it with the second. Also transfer any comments occurring before it. TODO: call transferEntryDP, and use pushDeclDP

valuewrapSig :: LSig GhcPs -> LHsDecl GhcPs

#

Convert a LSig into a LHsDecl

valuewrapDecl :: LHsBind GhcPs -> LHsDecl GhcPs

#

Convert a LHsBind into a LHsDecl

valuedecl2Sig :: LHsDecl GhcPs -> [LSig GhcPs]

#

Pure function to convert a LSig to a LHsBind. This does nothing to any annotations that may be attached to either of the elements. It is used as a utility function in replaceDecls

valuedecl2Bind :: LHsDecl GhcPs -> [LHsBind GhcPs]

#

Pure function to convert a LHsDecl to a LHsBind. This does nothing to any annotations that may be attached to either of the elements. It is used as a utility function in replaceDecls