module Language.Haskell.GHC.ExactPrint.Pretty
(
addAnnotationsForPretty
) where
import Language.Haskell.GHC.ExactPrint.Types
import Language.Haskell.GHC.ExactPrint.Utils
import Language.Haskell.GHC.ExactPrint.Annotate
import Control.Monad.RWS
import Control.Monad.Trans.Free
import Data.Generics
import Data.List
import Data.Ord (comparing)
#if __GLASGOW_HASKELL__ <= 710
import qualified BooleanFormula as GHC
import qualified Outputable as GHC
#endif
import qualified GHC
import qualified Data.Map as Map
import qualified Data.Set as Set
addAnnotationsForPretty :: (Annotate a) => [Comment] -> GHC.Located a -> Anns -> Anns
addAnnotationsForPretty cs ast ans
= runPrettyWithComments opts cs (annotate ast) ans (0,0)
where
opts = prettyOptions NormalLayout
type Pretty a = RWS PrettyOptions PrettyWriter PrettyState a
runPrettyWithComments :: PrettyOptions -> [Comment] -> Annotated () -> Anns -> Pos -> Anns
runPrettyWithComments opts cs action ans priorEnd =
mkAnns . snd
. (\next -> execRWS next opts (defaultPrettyState cs priorEnd ans))
. prettyInterpret $ action
where
mkAnns :: PrettyWriter -> Anns
mkAnns = f . dwAnns
f :: Monoid a => Endo a -> a
f = ($ mempty) . appEndo
data PrettyOptions = PrettyOptions
{
curSrcSpan :: !GHC.SrcSpan
, annConName :: !AnnConName
, drRigidity :: !Rigidity
, prContext :: !AstContextSet
} deriving Show
data PrettyWriter = PrettyWriter
{
dwAnns :: Endo (Map.Map AnnKey Annotation)
, annKds :: ![(KeywordId, DeltaPos)]
, sortKeys :: !(Maybe [GHC.SrcSpan])
, dwCapturedSpan :: !(First AnnKey)
, prLayoutContext :: !(ACS' AstContext)
}
data PrettyState = PrettyState
{
priorEndPosition :: !Pos
, apComments :: ![Comment]
, apMarkLayout :: Bool
, apLayoutStart :: LayoutStartCol
, apNoPrecedingSpace :: Bool
}
instance Monoid PrettyWriter where
mempty = PrettyWriter mempty mempty mempty mempty mempty
(PrettyWriter a b e g i) `mappend` (PrettyWriter c d f h j)
= PrettyWriter (a <> c) (b <> d) (e <> f) (g <> h) (i <> j)
prettyOptions :: Rigidity -> PrettyOptions
prettyOptions ridigity =
PrettyOptions
{ curSrcSpan = GHC.noSrcSpan
, annConName = annGetConstr ()
, drRigidity = ridigity
, prContext = defaultACS
}
defaultPrettyState :: [Comment] -> Pos -> Anns -> PrettyState
defaultPrettyState injectedComments priorEnd _ans =
PrettyState
{ priorEndPosition = priorEnd
, apComments = cs ++ injectedComments
, apLayoutStart = 1
, apMarkLayout = False
, apNoPrecedingSpace = False
}
where
cs :: [Comment]
cs = []
prettyInterpret :: Annotated a -> Pretty a
prettyInterpret = iterTM go
where
go :: AnnotationF (Pretty a) -> Pretty a
go (MarkPrim kwid _ next) = addPrettyAnnotation (G kwid) >> next
go (MarkPPOptional _kwid _ next) = next
go (MarkEOF next) = addEofAnnotation >> next
go (MarkExternal _ss akwid _ next) = addPrettyAnnotation (G akwid) >> next
go (MarkOutside akwid kwid next) = addPrettyAnnotationsOutside akwid kwid >> next
go (MarkInside akwid next) = addPrettyAnnotationsInside akwid >> next
go (MarkMany akwid next) = addPrettyAnnotation (G akwid) >> next
go (MarkManyOptional _akwid next) = next
go (MarkOffsetPrim akwid n _ next) = addPrettyAnnotationLs akwid n >> next
go (MarkOffsetPrimOptional _akwid _n _ next) = next
go (WithAST lss prog next) = withAST lss (prettyInterpret prog) >> next
go (CountAnns kwid next) = countAnnsPretty kwid >>= next
go (WithSortKey kws next) = withSortKey kws >> next
go (WithSortKeyContexts ctx kws next) = withSortKeyContexts ctx kws >> next
go (SetLayoutFlag r action next) = do
rigidity <- asks drRigidity
(if r <= rigidity then setLayoutFlag else id) (prettyInterpret action)
next
go (StoreOriginalSrcSpan l key next) = storeOriginalSrcSpanPretty l key >>= next
go (MarkAnnBeforeAnn _ann1 _ann2 next) = next
go (GetSrcSpanForKw ss kw next) = getSrcSpanForKw ss kw >>= next
#if __GLASGOW_HASKELL__ <= 710
go (StoreString s ss next) = storeString s ss >> next
#endif
go (AnnotationsToComments kws next) = annotationsToCommentsPretty kws >> next
#if __GLASGOW_HASKELL__ <= 710
go (AnnotationsToCommentsBF bf kws next) = annotationsToCommentsBFPretty bf kws >> next
go (FinalizeBF l next) = finalizeBFPretty l >> next
#endif
go (SetContextLevel ctxt lvl action next) = setContextPretty ctxt lvl (prettyInterpret action) >> next
go (UnsetContext ctxt action next) = unsetContextPretty ctxt (prettyInterpret action) >> next
go (IfInContext ctxt ia ea next) = ifInContextPretty ctxt ia ea >> next
go (TellContext c next) = tellContext c >> next
addEofAnnotation :: Pretty ()
addEofAnnotation = do
tellKd (G GHC.AnnEofPos, DP (1,0))
addPrettyAnnotation :: KeywordId -> Pretty ()
addPrettyAnnotation ann = do
noPrec <- gets apNoPrecedingSpace
ctx <- asks prContext
_ <- debugP ("Pretty.addPrettyAnnotation:=" ++ showGhc (ann,noPrec,ctx)) $ asks prContext
let
dp = case ann of
(G GHC.AnnAs) -> tellKd (ann,DP (0,1))
(G GHC.AnnAt) -> tellKd (ann,DP (0,1))
(G GHC.AnnBang) -> tellKd (ann,DP (0,1))
(G GHC.AnnBackquote) -> tellKd (ann,DP (0,1))
(G GHC.AnnBy) -> tellKd (ann,DP (0,1))
(G GHC.AnnCase ) -> tellKd (ann,DP (0,1))
(G GHC.AnnClass) -> tellKd (ann,DP (0,1))
(G GHC.AnnClose) -> tellKd (ann,DP (0,1))
(G GHC.AnnCloseC) -> tellKd (ann,DP (0,0))
(G GHC.AnnDcolon) -> tellKd (ann,DP (0,1))
(G GHC.AnnDeriving) -> tellKd (ann,DP (0,1))
(G GHC.AnnDo) -> tellKd (ann,DP (0,1))
(G GHC.AnnElse) -> tellKd (ann,DP (1,2))
(G GHC.AnnEqual) -> tellKd (ann,DP (0,1))
(G GHC.AnnExport) -> tellKd (ann,DP (0,1))
(G GHC.AnnFamily) -> tellKd (ann,DP (0,1))
(G GHC.AnnForall) -> tellKd (ann,DP (0,1))
(G GHC.AnnGroup) -> tellKd (ann,DP (0,1))
(G GHC.AnnHiding) -> tellKd (ann,DP (0,1))
(G GHC.AnnImport) -> tellKd (ann,DP (0,1))
(G GHC.AnnIf) -> tellKd (ann,DP (0,1))
(G GHC.AnnIn) -> tellKd (ann,DP (1,0))
(G GHC.AnnInstance) -> tellKd (ann,DP (0,1))
(G GHC.AnnLam) -> tellKd (ann,DP (0,1))
(G GHC.AnnMinus) -> tellKd (ann,DP (0,1))
(G GHC.AnnModule) -> tellKd (ann,DP (0,1))
(G GHC.AnnOf) -> tellKd (ann,DP (0,1))
(G GHC.AnnOpenC) -> tellKd (ann,DP (0,0))
(G GHC.AnnOpenPE) -> tellKd (ann,DP (0,1))
(G GHC.AnnQualified) -> tellKd (ann,DP (0,1))
(G GHC.AnnRarrow) -> tellKd (ann,DP (0,1))
(G GHC.AnnRole) -> tellKd (ann,DP (0,1))
(G GHC.AnnSafe) -> tellKd (ann,DP (0,1))
(G GHC.AnnSimpleQuote) -> tellKd (ann,DP (0,1))
(G GHC.AnnThTyQuote) -> tellKd (ann,DP (0,1))
(G GHC.AnnThen) -> tellKd (ann,DP (1,2))
(G GHC.AnnTilde) -> tellKd (ann,DP (0,1))
(G GHC.AnnType) -> tellKd (ann,DP (0,1))
(G GHC.AnnUsing) -> tellKd (ann,DP (0,1))
(G GHC.AnnVal) -> tellKd (ann,DP (0,1))
(G GHC.AnnValStr) -> tellKd (ann,DP (0,1))
(G GHC.AnnVbar) -> tellKd (ann,DP (0,1))
(G GHC.AnnWhere) -> tellKd (ann,DP (1,2))
_ -> tellKd (ann,DP (0,0))
fromNoPrecedingSpace (tellKd (ann,DP (0,0))) dp
addPrettyAnnotationsOutside :: GHC.AnnKeywordId -> KeywordId -> Pretty ()
addPrettyAnnotationsOutside _akwid AnnSemiSep = return ()
addPrettyAnnotationsOutside _akwid kwid = addPrettyAnnotation kwid
addPrettyAnnotationsInside :: GHC.AnnKeywordId -> Pretty ()
addPrettyAnnotationsInside _ann = return ()
addPrettyAnnotationLs :: GHC.AnnKeywordId -> Int -> Pretty ()
addPrettyAnnotationLs ann _off = addPrettyAnnotation (G ann)
#if __GLASGOW_HASKELL__ <= 710
getUnallocatedComments :: Pretty [Comment]
getUnallocatedComments = gets apComments
putUnallocatedComments :: [Comment] -> Pretty ()
putUnallocatedComments cs = modify (\s -> s { apComments = cs } )
#endif
withSrcSpanPretty :: Data a => GHC.Located a -> Pretty b -> Pretty b
withSrcSpanPretty (GHC.L l a) action = do
(_,w) <- listen (return () :: Pretty ())
_ <- debugP ("withSrcSpanPretty: prLayoutContext w=" ++ show (prLayoutContext w) ) (return ())
local (\s -> s { curSrcSpan = l
, annConName = annGetConstr a
, prContext = (pushAcs (prContext s)) <> (prLayoutContext w)
})
action
withAST :: Data a
=> GHC.Located a
-> Pretty b -> Pretty b
withAST lss@(GHC.L ss t) action = do
return () `debug` ("Pretty.withAST:enter 1:(ss)=" ++ showGhc (ss,showConstr (toConstr t)))
withSrcSpanPretty lss $ do
return () `debug` ("Pretty.withAST:enter:(ss)=" ++ showGhc (ss,showConstr (toConstr t)))
let maskWriter s = s { annKds = []
, sortKeys = Nothing
, dwCapturedSpan = mempty
}
#if __GLASGOW_HASKELL__ <= 710
let spanStart = ss2pos ss
cs <- do
if GHC.isGoodSrcSpan ss
then
commentAllocation (priorComment spanStart) return
else
return []
#else
let cs = []
#endif
ctx <- asks prContext
noPrec <- gets apNoPrecedingSpace
edp <- debugP ("Pretty.withAST:enter:(ss,constr,noPrec,ctx)=" ++ showGhc (ss,showConstr (toConstr t),noPrec,ctx)) $ entryDpFor ctx t
let ctx1 = debugP ("Pretty.withAST:edp:(ss,constr,edp)=" ++ showGhc (ss,showConstr (toConstr t),edp)) ctx
(res, w) <- if inAcs (Set.fromList [ListItem,TopLevel]) ctx1
then
censor maskWriter (listen (setNoPrecedingSpace action))
else
censor maskWriter (listen action)
let kds = annKds w
an = Ann
{ annEntryDelta = edp
, annPriorComments = cs
, annFollowingComments = []
, annsDP = kds
, annSortKey = sortKeys w
, annCapturedSpan = getFirst $ dwCapturedSpan w
}
addAnnotationsPretty an
`debug` ("Pretty.withAST:(annkey,an)=" ++ show (mkAnnKey lss,an))
return res
entryDpFor :: Typeable a => AstContextSet -> a -> Pretty DeltaPos
entryDpFor ctx a = (def `extQ` grhs) a
where
lineDefault = if inAcs (Set.singleton AdvanceLine) ctx
then 1 else 0
noAdvanceLine = inAcs (Set.singleton NoAdvanceLine) ctx &&
inAcs (Set.singleton ListStart) ctx
def :: a -> Pretty DeltaPos
def _ =
debugP ("entryDpFor:(topLevel,listStart,inList,noAdvanceLine,ctx)=" ++ show (topLevel,listStart,inList,noAdvanceLine,ctx)) $
if noAdvanceLine
then return (DP (0,1))
else
if listStart
then return (DP (1,2))
else if inList
then if topLevel then return (DP (2,0)) else return (DP (1,0))
else if topLevel then return (DP (2,0)) else return (DP (lineDefault,0))
topLevel = inAcs (Set.singleton TopLevel) ctx
listStart = inAcs (Set.singleton ListStart) ctx
&& not (inAcs (Set.singleton TopLevel) ctx)
inList = inAcs (Set.singleton ListItem) ctx
inLambda = inAcs (Set.singleton LambdaExpr) ctx
grhs :: GHC.GRHS GHC.RdrName (GHC.LHsExpr GHC.RdrName) -> Pretty DeltaPos
grhs _ = do
if inLambda
then return (DP (0,1))
else return (DP (1,2))
fromNoPrecedingSpace :: Pretty a -> Pretty a -> Pretty a
fromNoPrecedingSpace def lay = do
PrettyState{apNoPrecedingSpace} <- get
if apNoPrecedingSpace
then do
modify (\s -> s { apNoPrecedingSpace = False
})
debugP ("fromNoPrecedingSpace:def") def
else
debugP ("fromNoPrecedingSpace:lay") lay
addAnnotationsPretty :: Annotation -> Pretty ()
addAnnotationsPretty ann = do
l <- ask
return () `debug` ("addAnnotationsPretty:=" ++ showGhc (curSrcSpan l,prContext l))
tellFinalAnn (getAnnKey l,ann)
getAnnKey :: PrettyOptions -> AnnKey
getAnnKey PrettyOptions {curSrcSpan, annConName}
= AnnKey curSrcSpan annConName
countAnnsPretty :: GHC.AnnKeywordId -> Pretty Int
countAnnsPretty _ann = return 0
withSortKey :: [(GHC.SrcSpan, Annotated b)] -> Pretty ()
withSortKey kws =
let order = sortBy (comparing fst) kws
in do
tellSortKey (map fst order)
mapM_ (prettyInterpret . snd) order
withSortKeyContexts :: ListContexts -> [(GHC.SrcSpan, Annotated ())] -> Pretty ()
withSortKeyContexts ctxts kws =
let order = sortBy (comparing fst) kws
in do
tellSortKey (map fst order)
withSortKeyContextsHelper prettyInterpret ctxts order
storeOriginalSrcSpanPretty :: GHC.SrcSpan -> AnnKey -> Pretty AnnKey
storeOriginalSrcSpanPretty _s key = do
tellCapturedSpan key
return key
getSrcSpanForKw :: GHC.SrcSpan -> GHC.AnnKeywordId -> Pretty GHC.SrcSpan
getSrcSpanForKw ss _kw = return ss
#if __GLASGOW_HASKELL__ <= 710
storeString :: String -> GHC.SrcSpan -> Pretty ()
storeString s _ss = addPrettyAnnotation (AnnString s)
#endif
setLayoutFlag :: Pretty () -> Pretty ()
setLayoutFlag action = do
oldLay <- gets apLayoutStart
modify (\s -> s { apMarkLayout = True } )
let reset = modify (\s -> s { apMarkLayout = False
, apLayoutStart = oldLay })
action <* reset
setNoPrecedingSpace :: Pretty a -> Pretty a
setNoPrecedingSpace action = do
oldVal <- gets apNoPrecedingSpace
modify (\s -> s { apNoPrecedingSpace = True } )
let reset = modify (\s -> s { apNoPrecedingSpace = oldVal })
action <* reset
setContextPretty :: Set.Set AstContext -> Int -> Pretty () -> Pretty ()
setContextPretty ctxt lvl =
local (\s -> s { prContext = setAcsWithLevel ctxt lvl (prContext s) } )
unsetContextPretty :: AstContext -> Pretty () -> Pretty ()
unsetContextPretty ctxt =
local (\s -> s { prContext = unsetAcs ctxt (prContext s) } )
ifInContextPretty :: Set.Set AstContext -> Annotated () -> Annotated () -> Pretty ()
ifInContextPretty ctxt ifAction elseAction = do
cur <- asks prContext
let inContext = inAcs ctxt cur
if inContext
then prettyInterpret ifAction
else prettyInterpret elseAction
annotationsToCommentsPretty :: [GHC.AnnKeywordId] -> Pretty ()
annotationsToCommentsPretty _kws = return ()
#if __GLASGOW_HASKELL__ <= 710
annotationsToCommentsBFPretty :: (GHC.Outputable a) => GHC.BooleanFormula (GHC.Located a) -> [GHC.AnnKeywordId] -> Pretty ()
annotationsToCommentsBFPretty bf _kws = do
cs <- debugP ("annotationsToCommentsBFPretty:" ++ showGhc (bf,makeBooleanFormulaAnns bf)) $ gets apComments
let
kws = makeBooleanFormulaAnns bf
newComments = map (uncurry mkKWComment ) kws
putUnallocatedComments (cs ++ newComments)
finalizeBFPretty :: GHC.SrcSpan -> Pretty ()
finalizeBFPretty _ss = do
commentAllocation (const True) (mapM_ (uncurry addPrettyComment))
return ()
#endif
#if __GLASGOW_HASKELL__ <= 710
priorComment :: Pos -> Comment -> Bool
priorComment start c = (ss2pos . commentIdentifier $ c) < start
allocateComments :: (Comment -> Bool) -> [Comment] -> ([Comment], [Comment])
allocateComments = partition
#endif
#if __GLASGOW_HASKELL__ <= 710
commentAllocation :: (Comment -> Bool)
-> ([(Comment, DeltaPos)] -> Pretty a)
-> Pretty a
commentAllocation p k = do
cs <- getUnallocatedComments
let (allocated,cs') = allocateComments p cs
putUnallocatedComments cs'
k =<< mapM makeDeltaComment (sortBy (comparing commentIdentifier) allocated)
makeDeltaComment :: Comment -> Pretty (Comment, DeltaPos)
makeDeltaComment c = do
return (c, DP (0,1))
addPrettyComment :: Comment -> DeltaPos -> Pretty ()
addPrettyComment d p = do
tellKd (AnnComment d, p)
#endif
tellFinalAnn :: (AnnKey, Annotation) -> Pretty ()
tellFinalAnn (k, v) =
tell (mempty { dwAnns = Endo (Map.insert k v) })
tellCapturedSpan :: AnnKey -> Pretty ()
tellCapturedSpan key = tell ( mempty { dwCapturedSpan = First $ Just key })
tellKd :: (KeywordId, DeltaPos) -> Pretty ()
tellKd kd = tell (mempty { annKds = [kd] })
tellSortKey :: [GHC.SrcSpan] -> Pretty ()
tellSortKey xs = tell (mempty { sortKeys = Just xs } )
tellContext :: Set.Set AstContext -> Pretty ()
tellContext lc = tell (mempty { prLayoutContext = setAcsWithLevel lc 2 mempty} )