Language.Haskell.GHC.ExactPrint.Utils

Manipulating Positons

ss2pos :: SrcSpan -> Pos

ss2posEnd :: SrcSpan -> Pos

undelta :: Pos -> DeltaPos -> LayoutStartCol -> Pos

Apply the delta to the current position, taking into account the current column offset if advancing to a new line

isPointSrcSpan :: SrcSpan -> Bool

Checks whether a SrcSpan has zero length.

pos2delta :: Pos -> Pos -> DeltaPos

Convert the start of the second Pos to be an offset from the first. The assumption is the reference starts before the second Pos

ss2delta :: Pos -> SrcSpan -> DeltaPos

Create a delta from the current position to the start of the given SrcSpan.

addDP :: DeltaPos -> DeltaPos -> DeltaPos

Add together two DeltaPos taking into account newlines

DP (0, 1) `addDP` DP (0, 2) == DP (0, 3)
DP (0, 9) `addDP` DP (1, 5) == DP (1, 5)
DP (1, 4) `addDP` DP (1, 3) == DP (2, 3)

spanLength :: SrcSpan -> Int

isGoodDelta :: DeltaPos -> Bool

A good delta has no negative values.

Manipulating Comments

mkComment :: String -> SrcSpan -> Comment

mkKWComment :: AnnKeywordId -> SrcSpan -> Comment

Makes a comment which originates from a specific keyword.

dpFromString :: String -> DeltaPos

Calculates the distance from the start of a string to the end of a string.

comment2dp :: (Comment, DeltaPos) -> (KeywordId, DeltaPos)

extractComments :: ApiAnns -> [Comment]

GHC Functions

srcSpanStartLine :: SrcSpan -> Int

srcSpanEndLine :: SrcSpan -> Int

srcSpanStartColumn :: SrcSpan -> Int

srcSpanEndColumn :: SrcSpan -> Int

rdrName2String :: RdrName -> String

isSymbolRdrName :: RdrName -> Bool

tokComment :: Located AnnotationComment -> Comment

isListComp :: HsStmtContext name -> Bool

isGadt :: [LConDecl name] -> Bool

isExactName :: Data name => name -> Bool

Manipulating Annotations

getAnnotationEP :: Data a => Located a -> Anns -> Maybe Annotation

annTrueEntryDelta :: Annotation -> DeltaPos

The "true entry" is the distance from the last concrete element to the start of the current element.

annCommentEntryDelta :: Annotation -> DeltaPos -> DeltaPos

Take an annotation and a required "true entry" and calculate an equivalent one relative to the last comment in the annPriorComments.

annLeadingCommentEntryDelta :: Annotation -> DeltaPos

Return the DP of the first item that generates output, either a comment or the entry DP

General Utility

orderByKey :: [(SrcSpan, a)] -> [SrcSpan] -> [(SrcSpan, a)]

Given a list of items and a list of keys, returns a list of items ordered by their position in the list of keys.

AST Context management

setAcs :: Set AstContext -> AstContextSet -> AstContextSet

Put the provided context elements into the existing set with fresh level counts

setAcsWithLevel :: Ord a => Set a -> Int -> ACS' a -> ACS' a

Put the provided context elements into the existing set with given level counts setAcsWithLevel :: Set.Set AstContext -> Int -> AstContextSet -> AstContextSet setAcsWithLevel ctxt level (ACS a) = ACS a' where upd s (k,v) = Map.insert k v s a' = foldl' upd a $ zip (Set.toList ctxt) (repeat level)

unsetAcs :: Ord a => a -> ACS' a -> ACS' a

Remove the provided context element from the existing set unsetAcs :: AstContext -> AstContextSet -> AstContextSet

inAcs :: Ord a => Set a -> ACS' a -> Bool

Are any of the contexts currently active? inAcs :: Set.Set AstContext -> AstContextSet -> Bool

pushAcs :: ACS' a -> ACS' a

propagate the ACS down a level, dropping all values which hit zero pushAcs :: AstContextSet -> AstContextSet

bumpAcs :: ACS' a -> ACS' a

Sometimes we have to pass the context down unchanged. Bump each count up by one so that it is unchanged after a pushAcs call. bumpAcs :: AstContextSet -> AstContextSet

For tests

debug :: c -> String -> c

Provide a version of trace that comes at the end of the line, so it can easily be commented out when debugging different things.

debugP :: String -> c -> c

Provide a version of trace for the Pretty module, which can be enabled separately from debug and debugM

debugM :: Monad m => String -> m ()

warn :: c -> String -> c

showGhc :: Outputable a => a -> String

Show a GHC.Outputable structure

showAnnData :: Data a => Anns -> Int -> a -> String

Show a GHC AST with interleaved Annotation information.

occAttributes :: OccName -> String

showSDoc_ :: SDoc -> String

showSDocDebug_ :: SDoc -> String

ghead :: String -> [a] -> a

glast :: String -> [a] -> a

gtail :: String -> [a] -> [a]

gfromJust :: String -> Maybe a -> a