@@ -1,6 +1,8 @@
11{-# LANGUAGE LambdaCase #-}
2+{-# LANGUAGE MultiWayIf #-}
23{-# LANGUAGE OverloadedStrings #-}
34{-# LANGUAGE RecordWildCards #-}
5+{-# LANGUAGE TypeApplications #-}
46
57module Ormolu.Printer.Meat.Declaration.Value
68 ( p_valDecl,
@@ -20,12 +22,12 @@ import Data.Char (isPunctuation, isSymbol)
2022import Data.Data hiding (Infix, Prefix)
2123import Data.Functor ((<&>))
2224import Data.List (intersperse, sortOn)
23−import Data.List.NonEmpty ((<|), NonEmpty ((:|)))
25+import Data.List.NonEmpty (NonEmpty (..), (<|))
2426import qualified Data.List.NonEmpty as NE
2527import Data.Text (Text)
2628import qualified Data.Text as Text
2729import GHC
28−import OccName (mkVarOcc)
30+import OccName (occNameString)
2931import Ormolu.Printer.Combinators
3032import Ormolu.Printer.Internal
3133import Ormolu.Printer.Meat.Common
@@ -34,8 +36,6 @@ import Ormolu.Printer.Meat.Declaration.Signature
3436import Ormolu.Printer.Meat.Type
3537import Ormolu.Printer.Operators
3638import Ormolu.Utils
37−import RdrName (RdrName (..), rdrNameOcc)
38−import SrcLoc (combineSrcSpans, isOneLineSpan)
3939
4040-- | Style of a group of equations.
4141data MatchGroupStyle
@@ -61,16 +61,16 @@ data Placement
6161 -- should use it and avoid bumping one level
6262 -- of indentation
6363 Hanging
64− deriving (Eq)
64+ deriving (Eq, Show)
6565
6666p_valDecl :: HsBindLR GhcPs GhcPs -> R ()
6767p_valDecl = \case
68− FunBind NoExt funId funMatches _ _ -> p_funBind funId funMatches
69− PatBind NoExt pat grhss _ -> p_match PatternBind False NoSrcStrict [pat] grhss
68+ FunBind NoExtField funId funMatches _ _ -> p_funBind funId funMatches
69+ PatBind NoExtField pat grhss _ -> p_match PatternBind False NoSrcStrict [pat] grhss
7070 VarBind {} -> notImplemented "VarBinds" -- introduced by the type checker
7171 AbsBinds {} -> notImplemented "AbsBinds" -- introduced by the type checker
72− PatSynBind NoExt psb -> p_patSynBind psb
73− XHsBindsLR NoExt -> notImplemented "XHsBindsLR"
72+ PatSynBind NoExtField psb -> p_patSynBind psb
73+ XHsBindsLR x -> noExtCon x
7474
7575p_funBind ::
7676 Located RdrName ->
@@ -114,8 +114,8 @@ p_matchGroup' placer render style MG {..} = do
114114 (matchStrictness m)
115115 m_pats
116116 m_grhss
117− p_Match _ = notImplemented "XMatch"
118−p_matchGroup' _ _ _ (XMatchGroup NoExt) = notImplemented "XMatchGroup"
117+ p_Match (XMatch x) = noExtCon x
118+p_matchGroup' _ _ _ (XMatchGroup x) = noExtCon x
119119
120120-- | Function id obtained through pattern matching on 'FunBind' should not
121121-- be used to print the actual equations because the different ‘RdrNames’
@@ -180,27 +180,26 @@ p_match' placer render style isInfix strictness m_pats GRHSs {..} = do
180180 NoSrcStrict -> return ()
181181 SrcStrict -> txt "!"
182182 SrcLazy -> txt "~"
183− inci' <- case NE.nonEmpty m_pats of
184− Nothing -> id <$ case style of
185− Function name -> p_rdrName name
186− _ -> return ()
183+ indentBody <- case NE.nonEmpty m_pats of
184+ Nothing ->
185+ False <$ case style of
186+ Function name -> p_rdrName name
187+ _ -> return ()
187188 Just ne_pats -> do
188− let combinedSpans =
189− combineSrcSpans' $
190− getLoc <$> ne_pats
191− inci' =
192− if isOneLineSpan combinedSpans
193− then id
194− else inci
189+ let combinedSpans = case style of
190+ Function name -> combineSrcSpans (getLoc name) patSpans
191+ _ -> patSpans
192+ patSpans = combineSrcSpans' (getLoc <$> ne_pats)
193+ indentBody = not (isOneLineSpan combinedSpans)
195194 switchLayout [combinedSpans] $ do
196− let stdCase = sep breakpoint p_pat m_pats
195+ let stdCase = sep breakpoint (located' p_pat) m_pats
197196 case style of
198197 Function name ->
199198 p_infixDefHelper
200199 isInfix
201− inci'
200+ indentBody
202201 (p_rdrName name)
203− (p_pat <$> m_pats)
202+ (located' p_pat <$> m_pats)
204203 PatternBind -> stdCase
205204 Case -> stdCase
206205 Lambda -> do
@@ -213,40 +212,32 @@ p_match' placer render style isInfix strictness m_pats GRHSs {..} = do
213212 when needsSpace space
214213 sitcc stdCase
215214 LambdaCase -> stdCase
216− return inci'
215+ return indentBody
217216 let -- Calculate position of end of patterns. This is useful when we decide
218217 -- about putting certain constructions in hanging positions.
219218 endOfPats = case NE.nonEmpty m_pats of
220219 Nothing -> case style of
221− Function name -> (Just . srcSpanEnd . getLoc) name
220+ Function name -> Just (getLoc name)
222221 _ -> Nothing
223− Just pats -> (Just . srcSpanEnd . getLoc . NE.last) pats
222+ Just pats -> (Just . getLoc . NE.last) pats
224223 isCase = \case
225224 Case -> True
226225 LambdaCase -> True
227226 _ -> False
228− let hasGuards = withGuards grhssGRHSs
229− unless (length grhssGRHSs > 1) $
230− case style of
231− Function _ | hasGuards -> return ()
232− Function _ -> space >> txt "="
233− PatternBind -> space >> txt "="
234− s | isCase s && hasGuards -> return ()
235− _ -> space >> txt "->"
236− let grhssSpan =
227+ hasGuards = withGuards grhssGRHSs
228+ grhssSpan =
237229 combineSrcSpans' $
238230 getGRHSSpan . unLoc <$> NE.fromList grhssGRHSs
239231 patGrhssSpan =
240232 maybe
241233 grhssSpan
242− (combineSrcSpans grhssSpan . srcLocSpan)
234+ (combineSrcSpans grhssSpan . srcLocSpan . srcSpanEnd)
243235 endOfPats
244236 placement =
245237 case endOfPats of
246238 Nothing -> blockPlacement placer grhssGRHSs
247239 Just spn ->
248− if isOneLineSpan
249− (mkSrcSpan spn (srcSpanStart grhssSpan))
240+ if onTheSameLine spn grhssSpan
250241 then blockPlacement placer grhssGRHSs
251242 else Normal
252243 p_body = do
@@ -262,11 +253,18 @@ p_match' placer render style isInfix strictness m_pats GRHSs {..} = do
262253 txt "where"
263254 unless whereIsEmpty breakpoint
264255 inci $ located grhssLocalBinds p_hsLocalBinds
265− inci' $ do
256+ inciIf indentBody $ do
257+ unless (length grhssGRHSs > 1) $
258+ case style of
259+ Function _ | hasGuards -> return ()
260+ Function _ -> space >> inci equals
261+ PatternBind -> space >> inci equals
262+ s | isCase s && hasGuards -> return ()
263+ _ -> space >> txt "->"
266264 switchLayout [patGrhssSpan] $
267265 placeHanging placement p_body
268266 inci p_where
269−p_match' _ _ _ _ _ _ XGRHSs {} = notImplemented "XGRHSs"
267+p_match' _ _ _ _ _ _ (XGRHSs x) = noExtCon x
270268
271269p_grhs :: GroupStyle -> GRHS GhcPs (LHsExpr GhcPs) -> R ()
272270p_grhs = p_grhs' exprPlacement p_hsExpr
@@ -280,79 +278,109 @@ p_grhs' ::
280278 GroupStyle ->
281279 GRHS GhcPs (Located body) ->
282280 R ()
283−p_grhs' placer render style (GRHS NoExt guards body) =
281+p_grhs' placer render style (GRHS NoExtField guards body) =
284282 case guards of
285283 [] -> p_body
286284 xs -> do
287285 txt "|"
288286 space
289− sitcc (sep (comma >> breakpoint) (sitcc . located' p_stmt) xs)
287+ sitcc (sep commaDel (sitcc . located' p_stmt) xs)
290288 space
291− txt $ case style of
292− EqualSign -> "="
293− RightArrow -> "->"
289+ inci $ case style of
290+ EqualSign -> equals
291+ RightArrow -> txt "->"
294292 placeHanging placement p_body
295293 where
296294 placement =
297295 case endOfGuards of
298296 Nothing -> placer (unLoc body)
299297 Just spn ->
300− if isOneLineSpan (mkSrcSpan spn (srcSpanStart (getLoc body)))
298+ if onTheSameLine spn (getLoc body)
301299 then placer (unLoc body)
302300 else Normal
303301 endOfGuards =
304302 case NE.nonEmpty guards of
305303 Nothing -> Nothing
306− Just gs -> (Just . srcSpanEnd . getLoc . NE.last) gs
304+ Just gs -> (Just . getLoc . NE.last) gs
307305 p_body = located body render
308−p_grhs' _ _ _ (XGRHS NoExt) = notImplemented "XGRHS"
306+p_grhs' _ _ _ (XGRHS x) = noExtCon x
309307
310308p_hsCmd :: HsCmd GhcPs -> R ()
311309p_hsCmd = \case
312− HsCmdArrApp NoExt body input arrType _ -> do
310+ HsCmdArrApp NoExtField body input arrType _ -> do
313311 located body p_hsExpr
314− space
315− case arrType of
316− HsFirstOrderApp -> txt "-<"
317− HsHigherOrderApp -> txt "-<<"
318− placeHanging (exprPlacement (unLoc input)) $
319− located input p_hsExpr
320− HsCmdArrForm NoExt form Prefix _ cmds -> banana $ sitcc $ do
312+ breakpoint
313+ inci $ do
314+ case arrType of
315+ HsFirstOrderApp -> txt "-<"
316+ HsHigherOrderApp -> txt "-<<"
317+ placeHanging (exprPlacement (unLoc input)) $
318+ located input p_hsExpr
319+ HsCmdArrForm NoExtField form Prefix _ cmds -> banana $ do
321320 located form p_hsExpr
322321 unless (null cmds) $ do
323322 breakpoint
324323 inci (sequence_ (intersperse breakpoint (located' p_hsCmdTop <$> cmds)))
325− HsCmdArrForm NoExt form Infix _ [left, right] -> do
324+ HsCmdArrForm NoExtField form Infix _ [left, right] -> do
326325 located left p_hsCmdTop
327326 space
328327 located form p_hsExpr
329328 placeHanging (cmdTopPlacement (unLoc right)) $
330329 located right p_hsCmdTop
331− HsCmdArrForm NoExt _ Infix _ _ -> notImplemented "HsCmdArrForm"
330+ HsCmdArrForm NoExtField _ Infix _ _ -> notImplemented "HsCmdArrForm"
332331 HsCmdApp {} ->
333332 -- XXX Does this ever occur in the syntax tree? It does not seem like it
334333 -- does. Open an issue and ping @yumiova if this ever occurs in output.
335334 notImplemented "HsCmdApp"
336− HsCmdLam NoExt mgroup -> p_matchGroup' cmdPlacement p_hsCmd Lambda mgroup
337− HsCmdPar NoExt c -> parens N (located c p_hsCmd)
338− HsCmdCase NoExt e mgroup ->
335+ HsCmdLam NoExtField mgroup -> p_matchGroup' cmdPlacement p_hsCmd Lambda mgroup
336+ HsCmdPar NoExtField c -> parens N (located c p_hsCmd)
337+ HsCmdCase NoExtField e mgroup ->
339338 p_case cmdPlacement p_hsCmd e mgroup
340− HsCmdIf NoExt _ if' then' else' ->
339+ HsCmdIf NoExtField _ if' then' else' ->
341340 p_if cmdPlacement p_hsCmd if' then' else'
342− HsCmdLet NoExt localBinds c ->
341+ HsCmdLet NoExtField localBinds c ->
343342 p_let p_hsCmd localBinds c
344− HsCmdDo NoExt es -> do
343+ HsCmdDo NoExtField es -> do
345344 txt "do"
346345 newline
347346 inci . located es $
348− sitcc . sep newline (located' (sitcc . p_stmt' cmdPlacement p_hsCmd))
347+ sitcc . sep newline (sitcc . withSpacing (p_stmt' cmdPlacement p_hsCmd))
349348 HsCmdWrap {} -> notImplemented "HsCmdWrap"
350− XCmd {} -> notImplemented "XCmd"
349+ XCmd x -> noExtCon x
351350
352351p_hsCmdTop :: HsCmdTop GhcPs -> R ()
353352p_hsCmdTop = \case
354− HsCmdTop NoExt cmd -> located cmd p_hsCmd
355− XCmdTop {} -> notImplemented "XHsCmdTop"
353+ HsCmdTop NoExtField cmd -> located cmd p_hsCmd
354+ XCmdTop x -> noExtCon x
355+
356+-- | Render an expression preserving blank lines between such consecutive
357+-- expressions found in the original source code.
358+withSpacing ::
359+ -- | Rendering function
360+ (a -> R ()) ->
361+ -- | Entity to render
362+ Located a ->
363+ R ()
364+withSpacing f l = located l $ \x -> do
365+ case getLoc l of
366+ UnhelpfulSpan _ -> f x
367+ RealSrcSpan currentSpn -> do
368+ getSpanMark >>= \case
369+ -- Spacing before comments will be handled by the code
370+ -- that prints comments, so we just have to deal with
371+ -- blank lines between statements here.
372+ Just (StatementSpan lastSpn) ->
373+ if srcSpanStartLine currentSpn > srcSpanEndLine lastSpn + 1
374+ then newline
375+ else return ()
376+ _ -> return ()
377+ f x
378+ -- In some cases the (f x) expression may insert a new mark. We want
379+ -- to be careful not to override comment marks.
380+ getSpanMark >>= \case
381+ Just (HaddockSpan _ _) -> return ()
382+ Just (CommentSpan _) -> return ()
383+ _ -> setSpanMark (StatementSpan currentSpn)
356384
357385p_stmt :: Stmt GhcPs (LHsExpr GhcPs) -> R ()
358386p_stmt = p_stmt' exprPlacement p_hsExpr
@@ -367,16 +395,13 @@ p_stmt' ::
367395 Stmt GhcPs (Located body) ->
368396 R ()
369397p_stmt' placer render = \case
370− LastStmt NoExt body _ _ -> located body render
371− BindStmt NoExt p f _ _ -> do
372− p_pat p
398+ LastStmt NoExtField body _ _ -> located body render
399+ BindStmt NoExtField p f _ _ -> do
400+ located p p_pat
373401 space
374402 txt "<-"
375− -- https://gitlab.haskell.org/ghc/ghc/issues/17330
376− let loc = case p of
377− XPat pat -> getLoc pat
378− _ -> error "p_stmt': BindStmt: Pat does not contain a location"
379− let placement =
403+ let loc = getLoc p
404+ placement =
380405 case f of
381406 L l' x ->
382407 if isOneLineSpan
@@ -386,8 +411,8 @@ p_stmt' placer render = \case
386411 switchLayout [loc, getLoc f] $
387412 placeHanging placement (located f render)
388413 ApplicativeStmt {} -> notImplemented "ApplicativeStmt" -- generated by renamer
389− BodyStmt NoExt body _ _ -> located body render
390− LetStmt NoExt binds -> do
414+ BodyStmt NoExtField body _ _ -> located body render
415+ LetStmt NoExtField binds -> do
391416 txt "let"
392417 space
393418 sitcc $ located binds p_hsLocalBinds
@@ -428,11 +453,11 @@ p_stmt' placer render = \case
428453 RecStmt {..} -> do
429454 txt "rec"
430455 space
431− sitcc $ sepSemi (located' (p_stmt' placer render)) recS_stmts
432− XStmtLR {} -> notImplemented "XStmtLR"
456+ sitcc $ sepSemi (withSpacing (p_stmt' placer render)) recS_stmts
457+ XStmtLR c -> noExtCon c
433458
434459gatherStmt :: ExprLStmt GhcPs -> [[ExprLStmt GhcPs]]
435−gatherStmt (L _ (ParStmt NoExt block _ _)) =
460+gatherStmt (L _ (ParStmt NoExtField block _ _)) =
436461 foldr ((<>) . gatherStmtBlock) [] block
437462gatherStmt (L s stmt@TransStmt {..}) =
438463 foldr liftAppend [] ((gatherStmt <$> trS_stmts) <> pure [[L s stmt]])
@@ -441,46 +466,46 @@ gatherStmt stmt = [[stmt]]
441466gatherStmtBlock :: ParStmtBlock GhcPs GhcPs -> [[ExprLStmt GhcPs]]
442467gatherStmtBlock (ParStmtBlock _ stmts _ _) =
443468 foldr (liftAppend . gatherStmt) [] stmts
444−gatherStmtBlock XParStmtBlock {} = notImplemented "XParStmtBlock"
469+gatherStmtBlock (XParStmtBlock x) = noExtCon x
445470
446471p_hsLocalBinds :: HsLocalBindsLR GhcPs GhcPs -> R ()
447472p_hsLocalBinds = \case
448− HsValBinds NoExt (ValBinds NoExt bag lsigs) -> do
449− let ssStart =
450− either
451− (srcSpanStart . getLoc)
452− (srcSpanStart . getLoc)
453− items =
454− (Left <$> bagToList bag) ++ (Right <$> lsigs)
455− p_item (Left x) = located x p_valDecl
456− p_item (Right x) = located x p_sigDecl
457− -- Assigns 'False' to the last element, 'True' to the rest.
458− markInit :: [a] -> [(Bool, a)]
459− markInit [] = []
460− markInit [x] = [(False, x)]
461− markInit (x : xs) = (True, x) : markInit xs
473+ HsValBinds NoExtField (ValBinds NoExtField bag lsigs) -> do
462474 -- When in a single-line layout, there is a chance that the inner
463475 -- elements will also contain semicolons and they will confuse the
464476 -- parser. so we request braces around every element except the last.
465477 br <- layoutToBraces <$> getLayout
466− sitcc $
467− sepSemi
468− (\(m, i) -> (if m then br else id) $ p_item i)
469− (markInit $ sortOn ssStart items)
470− HsValBinds NoExt _ -> notImplemented "HsValBinds"
471− HsIPBinds NoExt (IPBinds NoExt xs) ->
478+ let items =
479+ let injectLeft (L l x) = L l (Left x)
480+ injectRight (L l x) = L l (Right x)
481+ in (injectLeft <$> bagToList bag) ++ (injectRight <$> lsigs)
482+ positionToBracing = \case
483+ SinglePos -> id
484+ FirstPos -> br
485+ MiddlePos -> br
486+ LastPos -> id
487+ p_item' (p, item) =
488+ positionToBracing p $
489+ withSpacing (either p_valDecl p_sigDecl) item
490+ binds = sortOn (srcSpanStart . getLoc) items
491+ sitcc $ sepSemi p_item' (attachRelativePos binds)
492+ HsValBinds NoExtField _ -> notImplemented "HsValBinds"
493+ HsIPBinds NoExtField (IPBinds NoExtField xs) ->
472494 -- Second argument of IPBind is always Left before type-checking.
473− let p_ipBind (IPBind NoExt (Left name) expr) = do
495+ let p_ipBind (IPBind NoExtField (Left name) expr) = do
474496 atom name
475497 space
476− txt "="
498+ equals
477499 breakpoint
478500 useBraces $ inci $ located expr p_hsExpr
479− p_ipBind _ = notImplemented "XHsIPBinds"
501+ p_ipBind (IPBind NoExtField (Right _) _) =
502+ -- Should only occur after the type checker
503+ notImplemented "IPBind _ (Right _) _"
504+ p_ipBind (XIPBind x) = noExtCon x
480505 in sepSemi (located' p_ipBind) xs
481− HsIPBinds NoExt _ -> notImplemented "HsIpBinds"
482− EmptyLocalBinds NoExt -> return ()
483− XHsLocalBindsLR _ -> notImplemented "XHsLocalBindsLR"
506+ HsIPBinds NoExtField _ -> notImplemented "HsIpBinds"
507+ EmptyLocalBinds NoExtField -> return ()
508+ XHsLocalBindsLR x -> noExtCon x
484509
485510p_hsRecField ::
486511 HsRecField' RdrName (LHsExpr GhcPs) ->
@@ -489,48 +514,45 @@ p_hsRecField HsRecField {..} = do
489514 p_rdrName hsRecFieldLbl
490515 unless hsRecPun $ do
491516 space
492− txt "="
493− let placement = exprPlacement (unLoc hsRecFieldArg)
494− placeHanging placement $ located hsRecFieldArg p_hsExpr
495−
496−p_hsTupArg :: HsTupArg GhcPs -> R ()
497−p_hsTupArg = \case
498− Present NoExt x -> located x p_hsExpr
499− Missing NoExt -> pure ()
500− XTupArg {} -> notImplemented "XTupArg"
517+ equals
518+ let placement =
519+ if onTheSameLine (getLoc hsRecFieldLbl) (getLoc hsRecFieldArg)
520+ then exprPlacement (unLoc hsRecFieldArg)
521+ else Normal
522+ placeHanging placement (located hsRecFieldArg p_hsExpr)
501523
502524p_hsExpr :: HsExpr GhcPs -> R ()
503525p_hsExpr = p_hsExpr' N
504526
505527p_hsExpr' :: BracketStyle -> HsExpr GhcPs -> R ()
506528p_hsExpr' s = \case
507− HsVar NoExt name -> p_rdrName name
508− HsUnboundVar NoExt _ -> notImplemented "HsUnboundVar"
509− HsConLikeOut NoExt _ -> notImplemented "HsConLikeOut"
510− HsRecFld NoExt x ->
529+ HsVar NoExtField name -> p_rdrName name
530+ HsUnboundVar NoExtField v -> atom (unboundVarOcc v)
531+ HsConLikeOut NoExtField _ -> notImplemented "HsConLikeOut"
532+ HsRecFld NoExtField x ->
511533 case x of
512− Unambiguous NoExt name -> p_rdrName name
513− Ambiguous NoExt name -> p_rdrName name
514− XAmbiguousFieldOcc NoExt -> notImplemented "XAmbiguousFieldOcc"
515− HsOverLabel NoExt _ v -> do
534+ Unambiguous NoExtField name -> p_rdrName name
535+ Ambiguous NoExtField name -> p_rdrName name
536+ XAmbiguousFieldOcc xx -> noExtCon xx
537+ HsOverLabel NoExtField _ v -> do
516538 txt "#"
517539 atom v
518− HsIPVar NoExt (HsIPName name) -> do
540+ HsIPVar NoExtField (HsIPName name) -> do
519541 txt "?"
520542 atom name
521− HsOverLit NoExt v -> atom (ol_val v)
522− HsLit NoExt lit ->
543+ HsOverLit NoExtField v -> atom (ol_val v)
544+ HsLit NoExtField lit ->
523545 case lit of
524546 HsString (SourceText stxt) _ -> p_stringLit stxt
525547 HsStringPrim (SourceText stxt) _ -> p_stringLit stxt
526548 r -> atom r
527− HsLam NoExt mgroup ->
549+ HsLam NoExtField mgroup ->
528550 p_matchGroup Lambda mgroup
529− HsLamCase NoExt mgroup -> do
551+ HsLamCase NoExtField mgroup -> do
530552 txt "\\case"
531553 breakpoint
532554 inci (p_matchGroup LambdaCase mgroup)
533− HsApp NoExt f x -> do
555+ HsApp NoExtField f x -> do
534556 let -- In order to format function applications with multiple parameters
535557 -- nicer, traverse the AST to gather the function and all the
536558 -- parameters together.
@@ -562,23 +584,21 @@ p_hsExpr' s = \case
562584 -- do-block or case expression it is not a good idea. It seems
563585 -- to be safe to always bump indentation when the function
564586 -- expression is parenthesised.
565− indent =
587+ doIndent =
566588 case func of
567− L _ (HsPar NoExt _) -> inci
568− L _ (HsAppType NoExt _ _) -> inci
569− L _ (HsMultiIf NoExt _) -> inci
570− L spn _ ->
571− if isOneLineSpan spn
572− then inci
573− else id
574− ub <- getLayout <&> \case
575− SingleLine -> useBraces
576− MultiLine -> id
589+ L _ (HsPar NoExtField _) -> True
590+ L _ (HsAppType NoExtField _ _) -> True
591+ L _ (HsMultiIf NoExtField _) -> True
592+ L spn _ -> isOneLineSpan spn
593+ ub <-
594+ getLayout <&> \case
595+ SingleLine -> useBraces
596+ MultiLine -> id
577597 ub $ do
578598 located func (p_hsExpr' s)
579599 breakpoint
580− indent $ sep breakpoint (located' p_hsExpr) initp
581− indent $ do
600+ inciIf doIndent $ sep breakpoint (located' p_hsExpr) initp
601+ inciIf doIndent $ do
582602 unless (null initp) breakpoint
583603 located lastp p_hsExpr
584604 Hanging -> do
@@ -588,76 +608,87 @@ p_hsExpr' s = \case
588608 sep breakpoint (located' p_hsExpr) initp
589609 placeHanging placement $
590610 located lastp p_hsExpr
591− HsAppType NoExt e a -> do
611+ HsAppType NoExtField e a -> do
592612 located e p_hsExpr
593613 breakpoint
594614 inci $ do
595615 txt "@"
616+ -- Insert a space when the type is represented as a TH splice to avoid
617+ -- gluing @ and $ together.
618+ case unLoc (hswc_body a) of
619+ HsSpliceTy {} -> space
620+ _ -> return ()
596621 located (hswc_body a) p_hsType
597− OpApp NoExt x op y -> do
622+ OpApp NoExtField x op y -> do
598623 let opTree = OpBranch (exprOpTree x) op (exprOpTree y)
599− p_exprOpTree True s (reassociateOpTree getOpName opTree)
600− NegApp NoExt e _ -> do
624+ p_exprOpTree s (reassociateOpTree getOpName opTree)
625+ NegApp NoExtField e _ -> do
601626 txt "-"
602627 space
603628 located e p_hsExpr
604− HsPar NoExt e ->
629+ HsPar NoExtField e ->
605630 parens s (located e (dontUseBraces . p_hsExpr))
606− SectionL NoExt x op -> do
631+ SectionL NoExtField x op -> do
607632 located x p_hsExpr
608633 breakpoint
609634 inci (located op p_hsExpr)
610− SectionR NoExt op x -> do
635+ SectionR NoExtField op x -> do
611636 located op p_hsExpr
612637 useRecordDot' <- useRecordDot
613638 let isRecordDot' = isRecordDot (unLoc op) (getLoc x)
614639 unless (useRecordDot' && isRecordDot') breakpoint
615640 inci (located x p_hsExpr)
616− ExplicitTuple NoExt args boxity -> do
641+ ExplicitTuple NoExtField args boxity ->
617642 let isSection = any (isMissing . unLoc) args
618643 isMissing = \case
619− Missing NoExt -> True
644+ Missing NoExtField -> True
620645 _ -> False
621− let parens' =
646+ p_arg = \case
647+ Present NoExtField x -> located x p_hsExpr
648+ Missing NoExtField -> pure ()
649+ XTupArg x -> noExtCon x
650+ p_larg = sitcc . located' p_arg
651+ parens' =
622652 case boxity of
623653 Boxed -> parens
624654 Unboxed -> parensHash
625− if isSection
626− then
627− switchLayout [] . parens' s $
628− sep comma (located' p_hsTupArg) args
629− else
630− switchLayout (getLoc <$> args) . parens' s . sitcc $
631− sep (comma >> breakpoint) (sitcc . located' p_hsTupArg) args
632− ExplicitSum NoExt tag arity e ->
655+ in if isSection
656+ then
657+ switchLayout [] . parens' s $
658+ sep comma p_larg args
659+ else
660+ switchLayout (getLoc <$> args) . parens' s $
661+ sep commaDel p_larg args
662+ ExplicitSum NoExtField tag arity e ->
633663 p_unboxedSum N tag arity (located e p_hsExpr)
634− HsCase NoExt e mgroup ->
664+ HsCase NoExtField e mgroup ->
635665 p_case exprPlacement p_hsExpr e mgroup
636− HsIf NoExt _ if' then' else' ->
666+ HsIf NoExtField _ if' then' else' ->
637667 p_if exprPlacement p_hsExpr if' then' else'
638− HsMultiIf NoExt guards -> do
639− txt "if "
640− inci . inci . sitcc $ sep newline (located' (p_grhs RightArrow)) guards
641− HsLet NoExt localBinds e ->
668+ HsMultiIf NoExtField guards -> do
669+ txt "if"
670+ breakpoint
671+ inci . inci $ sep newline (located' (p_grhs RightArrow)) guards
672+ HsLet NoExtField localBinds e ->
642673 p_let p_hsExpr localBinds e
643− HsDo NoExt ctx es -> do
674+ HsDo NoExtField ctx es -> do
644675 let doBody header = do
645676 txt header
646677 breakpoint
647678 ub <- layoutToBraces <$> getLayout
648679 inci $
649680 sepSemi
650− (located' (ub . p_stmt' exprPlacement (p_hsExpr' S)))
681+ (ub . withSpacing (p_stmt' exprPlacement (p_hsExpr' S)))
651682 (unLoc es)
652− compBody = brackets N $ located es $ \xs -> do
683+ compBody = brackets N . located es $ \xs -> do
653684 let p_parBody =
654685 sep
655− (breakpoint >> txt "| ")
686+ (breakpoint >> txt "|" >> space)
656687 p_seqBody
657688 p_seqBody =
658689 sitcc
659690 . sep
660− (comma >> breakpoint)
691+ commaDel
661692 (located' (sitcc . p_stmt))
662693 stmts = init xs
663694 yield = last xs
@@ -678,90 +709,96 @@ p_hsExpr' s = \case
678709 ParStmtCtxt _ -> notImplemented "ParStmtCtxt"
679710 TransStmtCtxt _ -> notImplemented "TransStmtCtxt"
680711 ExplicitList _ _ xs ->
681− brackets s . sitcc $
682− sep (comma >> breakpoint) (sitcc . located' p_hsExpr) xs
712+ brackets s $
713+ sep commaDel (sitcc . located' p_hsExpr) xs
683714 RecordCon {..} -> do
684715 located rcon_con_name atom
685716 breakpoint
686717 let HsRecFields {..} = rcon_flds
687718 updName f =
688− f
719+ (f :: HsRecField GhcPs (LHsExpr GhcPs))
689720 { hsRecFieldLbl = case unLoc $ hsRecFieldLbl f of
690721 FieldOcc _ n -> n
691− XFieldOcc _ -> notImplemented "XFieldOcc"
722+ XFieldOcc x -> noExtCon x
692723 }
693724 fields = located' (p_hsRecField . updName) <$> rec_flds
694725 dotdot =
695726 case rec_dotdot of
696727 Just {} -> [txt ".."]
697728 Nothing -> []
698− inci . braces N . sitcc $
699− sep (comma >> breakpoint) sitcc (fields <> dotdot)
729+ inci . braces N $
730+ sep commaDel sitcc (fields <> dotdot)
700731 RecordUpd {..} -> do
701732 located rupd_expr p_hsExpr
702− breakpoint
733+ useRecordDot' <- useRecordDot
734+ let mrs sp = case getLoc sp of
735+ RealSrcSpan r -> Just r
736+ _ -> Nothing
737+ let isPluginForm =
738+ ((1 +) . srcSpanEndCol <$> mrs rupd_expr)
739+ == (srcSpanStartCol <$> mrs (head rupd_flds))
740+ unless (useRecordDot' && isPluginForm) breakpoint
703741 let updName f =
704− f
742+ (f :: HsRecUpdField GhcPs)
705743 { hsRecFieldLbl = case unLoc $ hsRecFieldLbl f of
706744 Ambiguous _ n -> n
707745 Unambiguous _ n -> n
708− XAmbiguousFieldOcc _ -> notImplemented "XAmbiguousFieldOcc"
746+ XAmbiguousFieldOcc x -> noExtCon x
709747 }
710− inci . braces N . sitcc $
748+ inci . braces N $
711749 sep
712− (comma >> breakpoint)
750+ commaDel
713751 (sitcc . located' (p_hsRecField . updName))
714752 rupd_flds
715− ExprWithTySig NoExt x HsWC {hswc_body = HsIB {..}} -> sitcc $ do
753+ ExprWithTySig NoExtField x HsWC {hswc_body = HsIB {..}} -> sitcc $ do
716754 located x p_hsExpr
717755 space
718756 txt "::"
719757 breakpoint
720758 inci $ located hsib_body p_hsType
721− ExprWithTySig NoExt _ HsWC {hswc_body = XHsImplicitBndrs {}} ->
722− notImplemented "XHsImplicitBndrs"
723− ExprWithTySig NoExt _ XHsWildCardBndrs {} -> notImplemented "XHsWildCardBndrs"
724− ArithSeq NoExt _ x ->
759+ ExprWithTySig NoExtField _ HsWC {hswc_body = XHsImplicitBndrs x} -> noExtCon x
760+ ExprWithTySig NoExtField _ (XHsWildCardBndrs x) -> noExtCon x
761+ ArithSeq NoExtField _ x ->
725762 case x of
726− From from -> brackets s . sitcc $ do
763+ From from -> brackets s $ do
727764 located from p_hsExpr
728765 breakpoint
729766 txt ".."
730− FromThen from next -> brackets s . sitcc $ do
731− sitcc $ sep (comma >> breakpoint) (located' p_hsExpr) [from, next]
767+ FromThen from next -> brackets s $ do
768+ sep commaDel (located' p_hsExpr) [from, next]
732769 breakpoint
733770 txt ".."
734− FromTo from to -> brackets s . sitcc $ do
771+ FromTo from to -> brackets s $ do
735772 located from p_hsExpr
736773 breakpoint
737774 txt ".."
738775 space
739776 located to p_hsExpr
740− FromThenTo from next to -> brackets s . sitcc $ do
741− sitcc $ sep (comma >> breakpoint) (located' p_hsExpr) [from, next]
777+ FromThenTo from next to -> brackets s $ do
778+ sep commaDel (located' p_hsExpr) [from, next]
742779 breakpoint
743780 txt ".."
744781 space
745782 located to p_hsExpr
746− HsSCC NoExt _ name x -> do
783+ HsSCC NoExtField _ name x -> do
747784 txt "{-# SCC "
748785 atom name
749786 txt " #-}"
750787 breakpoint
751788 located x p_hsExpr
752− HsCoreAnn NoExt _ value x -> do
789+ HsCoreAnn NoExtField _ value x -> do
753790 txt "{-# CORE "
754791 atom value
755792 txt " #-}"
756793 breakpoint
757794 located x p_hsExpr
758− HsBracket NoExt x -> p_hsBracket x
795+ HsBracket NoExtField x -> p_hsBracket x
759796 HsRnBracketOut {} -> notImplemented "HsRnBracketOut"
760797 HsTcBracketOut {} -> notImplemented "HsTcBracketOut"
761− HsSpliceE NoExt splice -> p_hsSplice splice
762− HsProc NoExt p e -> do
798+ HsSpliceE NoExtField splice -> p_hsSplice splice
799+ HsProc NoExtField p e -> do
763800 txt "proc"
764− locatedPat p $ \x -> do
801+ located p $ \x -> do
765802 breakpoint
766803 inci (p_pat x)
767804 breakpoint
@@ -772,31 +809,11 @@ p_hsExpr' s = \case
772809 txt "static"
773810 breakpoint
774811 inci (located e p_hsExpr)
775− HsArrApp NoExt body input arrType cond ->
776− p_hsCmd (HsCmdArrApp NoExt body input arrType cond)
777− HsArrForm NoExt form mfixity cmds ->
778− p_hsCmd (HsCmdArrForm NoExt form Prefix mfixity cmds)
779812 HsTick {} -> notImplemented "HsTick"
780813 HsBinTick {} -> notImplemented "HsBinTick"
781814 HsTickPragma {} -> notImplemented "HsTickPragma"
782− -- These four constructs should never appear in correct programs.
783− -- See: https://github.com/tweag/ormolu/issues/343
784− EWildPat NoExt -> txt "_"
785− EAsPat NoExt n p -> do
786− p_rdrName n
787− txt "@"
788− located p p_hsExpr
789− EViewPat NoExt p e -> do
790− located p p_hsExpr
791− space
792− txt "->"
793− breakpoint
794− inci (located e p_hsExpr)
795− ELazyPat NoExt p -> do
796− txt "~"
797− located p p_hsExpr
798815 HsWrap {} -> notImplemented "HsWrap"
799− XExpr {} -> notImplemented "XExpr"
816+ XExpr x -> noExtCon x
800817
801818p_patSynBind :: PatSynBind GhcPs GhcPs -> R ()
802819p_patSynBind PSB {..} = do
@@ -806,15 +823,15 @@ p_patSynBind PSB {..} = do
806823 Unidirectional -> do
807824 txt "<-"
808825 breakpoint
809− p_pat psb_def
826+ located psb_def p_pat
810827 ImplicitBidirectional -> do
811− txt "="
828+ equals
812829 breakpoint
813− p_pat psb_def
830+ located psb_def p_pat
814831 ExplicitBidirectional mgroup -> do
815832 txt "<-"
816833 breakpoint
817− p_pat psb_def
834+ located psb_def p_pat
818835 newline
819836 txt "where"
820837 newline
@@ -835,8 +852,8 @@ p_patSynBind PSB {..} = do
835852 inci $ do
836853 switchLayout (getLoc . recordPatSynPatVar <$> xs) $ do
837854 unless (null xs) breakpoint
838− braces N . sitcc $
839− sep (comma >> breakpoint) (p_rdrName . recordPatSynPatVar) xs
855+ braces N $
856+ sep commaDel (p_rdrName . recordPatSynPatVar) xs
840857 rhs
841858 InfixCon l r -> do
842859 switchLayout [getLoc l, getLoc r] $ do
@@ -848,7 +865,7 @@ p_patSynBind PSB {..} = do
848865 space
849866 p_rdrName r
850867 inci rhs
851−p_patSynBind (XPatSynBind NoExt) = notImplemented "XPatSynBind"
868+p_patSynBind (XPatSynBind x) = noExtCon x
852869
853870p_case ::
854871 Data body =>
@@ -890,10 +907,12 @@ p_if placer render if' then' else' = do
890907 breakpoint
891908 inci $ do
892909 txt "then"
910+ space
893911 located then' $ \x ->
894912 placeHanging (placer x) (render x)
895913 breakpoint
896914 txt "else"
915+ space
897916 located else' $ \x ->
898917 placeHanging (placer x) (render x)
899918
@@ -915,77 +934,77 @@ p_let render localBinds e = sitcc $ do
915934
916935p_pat :: Pat GhcPs -> R ()
917936p_pat = \case
918− -- Note: starting from GHC 8.8, 'LPat' == 'Pat'. Located 'Pat's are always
919− -- constructed with the 'XPat' constructor, containing a @Located Pat@.
920− XPat pat -> located pat p_pat
921− WildPat NoExt -> txt "_"
922− VarPat NoExt name -> p_rdrName name
923− LazyPat NoExt pat -> do
937+ WildPat NoExtField -> txt "_"
938+ VarPat NoExtField name -> p_rdrName name
939+ LazyPat NoExtField pat -> do
924940 txt "~"
925− p_pat pat
926− AsPat NoExt name pat -> do
941+ located pat p_pat
942+ AsPat NoExtField name pat -> do
927943 p_rdrName name
928944 txt "@"
929− p_pat pat
930− ParPat NoExt pat ->
931− locatedPat pat (parens S . p_pat)
932− BangPat NoExt pat -> do
945+ located pat p_pat
946+ ParPat NoExtField pat ->
947+ located pat (parens S . p_pat)
948+ BangPat NoExtField pat -> do
933949 txt "!"
934− p_pat pat
935− ListPat NoExt pats ->
936− brackets S . sitcc $ sep (comma >> breakpoint) p_pat pats
937− TuplePat NoExt pats boxing -> do
938− let f =
950+ located pat p_pat
951+ ListPat NoExtField pats ->
952+ brackets S $ sep commaDel (located' p_pat) pats
953+ TuplePat NoExtField pats boxing -> do
954+ let parens' =
939955 case boxing of
940956 Boxed -> parens S
941957 Unboxed -> parensHash S
942− f . sitcc $ sep (comma >> breakpoint) (sitcc . p_pat) pats
943− SumPat NoExt pat tag arity ->
944− p_unboxedSum S tag arity (p_pat pat)
958+ parens' $ sep commaDel (sitcc . located' p_pat) pats
959+ SumPat NoExtField pat tag arity ->
960+ p_unboxedSum S tag arity (located pat p_pat)
945961 ConPatIn pat details ->
946962 case details of
947963 PrefixCon xs -> sitcc $ do
948964 p_rdrName pat
949965 unless (null xs) $ do
950966 breakpoint
951− inci . sitcc $ sep breakpoint (sitcc . p_pat) xs
967+ inci . sitcc $ sep breakpoint (sitcc . located' p_pat) xs
952968 RecCon (HsRecFields fields dotdot) -> do
953969 p_rdrName pat
954970 breakpoint
955971 let f = \case
956972 Nothing -> txt ".."
957973 Just x -> located x p_pat_hsRecField
958− inci . braces N . sitcc . sep (comma >> breakpoint) f $
974+ inci . braces N . sep commaDel f $
959975 case dotdot of
960976 Nothing -> Just <$> fields
961− Just n -> (Just <$> take n fields) ++ [Nothing]
962− InfixCon x y -> do
963− p_pat x
964− space
965− p_rdrName pat
966− breakpoint
967− inci (p_pat y)
977+ Just (L _ n) -> (Just <$> take n fields) ++ [Nothing]
978+ InfixCon l r -> do
979+ switchLayout [getLoc l, getLoc r] $ do
980+ located l p_pat
981+ breakpoint
982+ inci $ do
983+ p_rdrName pat
984+ space
985+ located r p_pat
968986 ConPatOut {} -> notImplemented "ConPatOut" -- presumably created by renamer?
969− ViewPat NoExt expr pat -> sitcc $ do
987+ ViewPat NoExtField expr pat -> sitcc $ do
970988 located expr p_hsExpr
971989 space
972990 txt "->"
973991 breakpoint
974− inci (p_pat pat)
975− SplicePat NoExt splice -> p_hsSplice splice
976− LitPat NoExt p -> atom p
977− NPat NoExt v _ _ -> located v (atom . ol_val)
978− NPlusKPat NoExt n k _ _ _ -> sitcc $ do
992+ inci (located pat p_pat)
993+ SplicePat NoExtField splice -> p_hsSplice splice
994+ LitPat NoExtField p -> atom p
995+ NPat NoExtField v _ _ -> located v (atom . ol_val)
996+ NPlusKPat NoExtField n k _ _ _ -> sitcc $ do
979997 p_rdrName n
980998 breakpoint
981999 inci $ do
9821000 txt "+"
9831001 space
9841002 located k (atom . ol_val)
985− SigPat NoExt pat hswc -> do
986− p_pat pat
1003+ SigPat NoExtField pat hswc -> do
1004+ located pat p_pat
9871005 p_typeAscription hswc
9881006 CoPat {} -> notImplemented "CoPat" -- apparently created at some later stage
1007+ XPat x -> noExtCon x
9891008
9901009p_pat_hsRecField :: HsRecField' (FieldOcc GhcPs) (LPat GhcPs) -> R ()
9911010p_pat_hsRecField HsRecField {..} = do
@@ -993,32 +1012,30 @@ p_pat_hsRecField HsRecField {..} = do
9931012 p_rdrName (rdrNameFieldOcc x)
9941013 unless hsRecPun $ do
9951014 space
996− txt "="
1015+ equals
9971016 breakpoint
998− inci (p_pat hsRecFieldArg)
1017+ inci (located hsRecFieldArg p_pat)
9991018
10001019p_unboxedSum :: BracketStyle -> ConTag -> Arity -> R () -> R ()
10011020p_unboxedSum s tag arity m = do
10021021 let before = tag - 1
10031022 after = arity - before - 1
10041023 args = replicate before Nothing <> [Just m] <> replicate after Nothing
1005− f (x, i) = do
1006− let isFirst = i == 0
1007− isLast = i == arity - 1
1024+ f x =
10081025 case x :: Maybe (R ()) of
10091026 Nothing ->
1010− unless (isFirst || isLast) space
1027+ space
10111028 Just m' -> do
1012− unless isFirst space
1029+ space
10131030 m'
1014− unless isLast space
1015− parensHash s $ sep (txt "|") f (zip args [0 ..])
1031+ space
1032+ parensHash s $ sep (txt "|") f args
10161033
10171034p_hsSplice :: HsSplice GhcPs -> R ()
10181035p_hsSplice = \case
1019− HsTypedSplice NoExt deco _ expr -> p_hsSpliceTH True expr deco
1020− HsUntypedSplice NoExt deco _ expr -> p_hsSpliceTH False expr deco
1021− HsQuasiQuote NoExt _ quoterName srcSpan str -> do
1036+ HsTypedSplice NoExtField deco _ expr -> p_hsSpliceTH True expr deco
1037+ HsUntypedSplice NoExtField deco _ expr -> p_hsSpliceTH False expr deco
1038+ HsQuasiQuote NoExtField _ quoterName srcSpan str -> do
10221039 txt "["
10231040 p_rdrName (L srcSpan quoterName)
10241041 txt "|"
@@ -1028,7 +1045,7 @@ p_hsSplice = \case
10281045 txt "|]"
10291046 HsSpliced {} -> notImplemented "HsSpliced"
10301047 HsSplicedT {} -> notImplemented "HsSplicedT"
1031− XSplice {} -> notImplemented "XSplice"
1048+ XSplice x -> noExtCon x
10321049
10331050p_hsSpliceTH ::
10341051 -- | Typed splice?
@@ -1052,17 +1069,17 @@ p_hsSpliceTH isTyped expr = \case
10521069
10531070p_hsBracket :: HsBracket GhcPs -> R ()
10541071p_hsBracket = \case
1055− ExpBr NoExt expr -> do
1072+ ExpBr NoExtField expr -> do
10561073 anns <- getEnclosingAnns
10571074 let name = case anns of
10581075 AnnOpenEQ : _ -> ""
10591076 _ -> "e"
10601077 quote name (located expr p_hsExpr)
1061− PatBr NoExt pat -> quote "p" (p_pat pat)
1062− DecBrL NoExt decls -> quote "d" (p_hsDecls Free decls)
1063− DecBrG NoExt _ -> notImplemented "DecBrG" -- result of renamer
1064− TypBr NoExt ty -> quote "t" (located ty p_hsType)
1065− VarBr NoExt isSingleQuote name -> do
1078+ PatBr NoExtField pat -> located pat (quote "p" . p_pat)
1079+ DecBrL NoExtField decls -> quote "d" (p_hsDecls Free decls)
1080+ DecBrG NoExtField _ -> notImplemented "DecBrG" -- result of renamer
1081+ TypBr NoExtField ty -> quote "t" (located ty p_hsType)
1082+ VarBr NoExtField isSingleQuote name -> do
10661083 txt (bool "''" "'" isSingleQuote)
10671084 -- HACK As you can see we use 'noLoc' here to be able to pass name into
10681085 -- 'p_rdrName' since the latter expects a "located" thing. The problem
@@ -1077,13 +1094,13 @@ p_hsBracket = \case
10771094 && not (doesNotNeedExtraParens name)
10781095 wrapper = if isOperator then parens N else id
10791096 wrapper $ p_rdrName (noLoc name)
1080− TExpBr NoExt expr -> do
1097+ TExpBr NoExtField expr -> do
10811098 txt "[||"
10821099 breakpoint'
10831100 located expr p_hsExpr
10841101 breakpoint'
10851102 txt "||]"
1086− XBracket {} -> notImplemented "XBracket"
1103+ XBracket x -> noExtCon x
10871104 where
10881105 quote :: Text -> R () -> R ()
10891106 quote name body = do
@@ -1162,9 +1179,9 @@ liftAppend (x : xs) [] = x : xs
11621179liftAppend (x : xs) (y : ys) = x <> y : liftAppend xs ys
11631180
11641181getGRHSSpan :: GRHS GhcPs (Located body) -> SrcSpan
1165−getGRHSSpan (GRHS NoExt guards body) =
1182+getGRHSSpan (GRHS NoExtField guards body) =
11661183 combineSrcSpans' $ getLoc body :| map getLoc guards
1167−getGRHSSpan (XGRHS NoExt) = notImplemented "XGRHS"
1184+getGRHSSpan (XGRHS x) = noExtCon x
11681185
11691186-- | Place a thing that may have a hanging form. This function handles how
11701187-- to separate it from preceding expressions and whether to bump indentation
@@ -1185,78 +1202,74 @@ blockPlacement ::
11851202 (body -> Placement) ->
11861203 [LGRHS GhcPs (Located body)] ->
11871204 Placement
1188−blockPlacement placer [L _ (GRHS NoExt _ (L _ x))] = placer x
1205+blockPlacement placer [L _ (GRHS NoExtField _ (L _ x))] = placer x
11891206blockPlacement _ _ = Normal
11901207
11911208-- | Check if given command has a hanging form.
11921209cmdPlacement :: HsCmd GhcPs -> Placement
11931210cmdPlacement = \case
1194− HsCmdLam NoExt _ -> Hanging
1195− HsCmdCase NoExt _ _ -> Hanging
1196− HsCmdDo NoExt _ -> Hanging
1211+ HsCmdLam NoExtField _ -> Hanging
1212+ HsCmdCase NoExtField _ _ -> Hanging
1213+ HsCmdDo NoExtField _ -> Hanging
11971214 _ -> Normal
11981215
11991216cmdTopPlacement :: HsCmdTop GhcPs -> Placement
12001217cmdTopPlacement = \case
1201− HsCmdTop NoExt (L _ x) -> cmdPlacement x
1202− XCmdTop {} -> notImplemented "XCmdTop"
1218+ HsCmdTop NoExtField (L _ x) -> cmdPlacement x
1219+ XCmdTop x -> noExtCon x
12031220
12041221-- | Check if given expression has a hanging form.
12051222exprPlacement :: HsExpr GhcPs -> Placement
12061223exprPlacement = \case
12071224 -- Only hang lambdas with single line parameter lists
1208− HsLam NoExt mg -> case mg of
1209− MG _ (L _ [L _ (Match NoExt _ (x : xs) _)]) _
1225+ HsLam NoExtField mg -> case mg of
1226+ MG _ (L _ [L _ (Match NoExtField _ (x : xs) _)]) _
12101227 | isOneLineSpan (combineSrcSpans' $ fmap getLoc (x :| xs)) ->
12111228 Hanging
12121229 _ -> Normal
1213− HsLamCase NoExt _ -> Hanging
1214− HsCase NoExt _ _ -> Hanging
1215− HsDo NoExt DoExpr _ -> Hanging
1216− HsDo NoExt MDoExpr _ -> Hanging
1217− -- If the rightmost expression in an operator chain is hanging, make the
1218− -- whole block hanging; so that we can use the common @f = foo $ do@
1219− -- style.
1220− OpApp NoExt _ _ y -> exprPlacement (unLoc y)
1221− -- Same thing for function applications (usually with -XBlockArguments)
1222− HsApp NoExt _ y -> exprPlacement (unLoc y)
1223− HsProc NoExt p _ ->
1224− -- https://gitlab.haskell.org/ghc/ghc/issues/17330
1225− let loc = case p of
1226− XPat pat -> getLoc pat
1227− _ -> error "exprPlacement: HsProc: Pat does not contain a location"
1228− in -- Indentation breaks if pattern is longer than one line and left
1229− -- hanging. Consequently, only apply hanging when it is safe.
1230− if isOneLineSpan loc
1231− then Hanging
1232− else Normal
1230+ HsLamCase NoExtField _ -> Hanging
1231+ HsCase NoExtField _ _ -> Hanging
1232+ HsDo NoExtField DoExpr _ -> Hanging
1233+ HsDo NoExtField MDoExpr _ -> Hanging
1234+ OpApp NoExtField _ op y ->
1235+ case (fmap getOpNameStr . getOpName . unLoc) op of
1236+ Just "$" -> exprPlacement (unLoc y)
1237+ _ -> Normal
1238+ HsApp NoExtField _ y -> exprPlacement (unLoc y)
1239+ HsProc NoExtField p _ ->
1240+ -- Indentation breaks if pattern is longer than one line and left
1241+ -- hanging. Consequently, only apply hanging when it is safe.
1242+ if isOneLineSpan (getLoc p)
1243+ then Hanging
1244+ else Normal
12331245 _ -> Normal
12341246
12351247withGuards :: [LGRHS GhcPs (Located body)] -> Bool
12361248withGuards = any (checkOne . unLoc)
12371249 where
12381250 checkOne :: GRHS GhcPs (Located body) -> Bool
1239− checkOne (GRHS NoExt [] _) = False
1251+ checkOne (GRHS NoExtField [] _) = False
12401252 checkOne _ = True
12411253
12421254exprOpTree :: LHsExpr GhcPs -> OpTree (LHsExpr GhcPs) (LHsExpr GhcPs)
1243−exprOpTree (L _ (OpApp NoExt x op y)) = OpBranch (exprOpTree x) op (exprOpTree y)
1255+exprOpTree (L _ (OpApp NoExtField x op y)) = OpBranch (exprOpTree x) op (exprOpTree y)
12441256exprOpTree n = OpNode n
12451257
12461258getOpName :: HsExpr GhcPs -> Maybe RdrName
12471259getOpName = \case
1248− HsVar NoExt (L _ a) -> Just a
1260+ HsVar NoExtField (L _ a) -> Just a
12491261 _ -> Nothing
12501262
1263+getOpNameStr :: RdrName -> String
1264+getOpNameStr = occNameString . rdrNameOcc
1265+
12511266p_exprOpTree ::
1252− -- | Can use special handling of dollar?
1253− Bool ->
12541267 -- | Bracket style to use
12551268 BracketStyle ->
12561269 OpTree (LHsExpr GhcPs) (LHsExpr GhcPs) ->
12571270 R ()
1258−p_exprOpTree _ s (OpNode x) = located x (p_hsExpr' s)
1259−p_exprOpTree isDollarSpecial s (OpBranch x op y) = do
1271+p_exprOpTree s (OpNode x) = located x (p_hsExpr' s)
1272+p_exprOpTree s (OpBranch x op y) = do
12601273 -- If the beginning of the first argument and the second argument are on
12611274 -- the same line, and the second argument has a hanging form, use hanging
12621275 -- placement.
@@ -1267,8 +1280,10 @@ p_exprOpTree isDollarSpecial s (OpBranch x op y) = do
12671280 OpNode (L _ n) -> exprPlacement n
12681281 _ -> Normal
12691282 else Normal
1283+ -- Distinguish holes used in infix notation.
1284+ -- eg. '1 _foo 2' and '1 `_foo` 2'
12701285 opWrapper = case unLoc op of
1271− EWildPat NoExt -> backticks
1286+ HsUnboundVar NoExtField _ -> backticks
12721287 _ -> id
12731288 layout <- getLayout
12741289 let ub = case layout of
@@ -1276,44 +1291,54 @@ p_exprOpTree isDollarSpecial s (OpBranch x op y) = do
12761291 MultiLine -> case placement of
12771292 Hanging -> useBraces
12781293 Normal -> dontUseBraces
1279− gotDollar = case getOpName (unLoc op) of
1280− Just rname -> mkVarOcc "$" == rdrNameOcc rname
1281− _ -> False
1294+ opNameStr = (fmap getOpNameStr . getOpName . unLoc) op
1295+ gotDollar = opNameStr == Just "$"
1296+ gotColon = opNameStr == Just ":"
1297+ gotRecordDot = isRecordDot (unLoc op) (opTreeLoc y)
12821298 lhs =
12831299 switchLayout [opTreeLoc x] $
1284− p_exprOpTree (not gotDollar) s x
1285− let p_op = located op (opWrapper . p_hsExpr)
1286− p_y = switchLayout [opTreeLoc y] (p_exprOpTree True N y)
1300+ p_exprOpTree s x
1301+ p_op = located op (opWrapper . p_hsExpr)
1302+ p_y = switchLayout [opTreeLoc y] (p_exprOpTree N y)
12871303 isSection = case (opTreeLoc x, getLoc op) of
12881304 (RealSrcSpan treeSpan, RealSrcSpan opSpan) ->
12891305 srcSpanEndCol treeSpan /= srcSpanStartCol opSpan
12901306 _ -> False
1307+ isDoBlock = \case
1308+ OpNode (L _ HsDo {}) -> True
1309+ _ -> False
12911310 useRecordDot' <- useRecordDot
1292− let isRecordDot' = isRecordDot (unLoc op) (opTreeLoc y)
1293− if useRecordDot' && isRecordDot'
1294− then do
1295− lhs
1296− when isSection space
1297− p_op
1298− p_y
1299− else
1300− if isDollarSpecial
1301− && gotDollar
1302− && placement
1303− == Normal
1304− && isOneLineSpan (opTreeLoc x)
1305− then do
1306− useBraces lhs
1307− space
1308− p_op
1309− breakpoint
1310− inci p_y
1311− else do
1312− ub lhs
1313− placeHanging placement $ do
1314− p_op
1311+ if
1312+ | gotColon -> do
1313+ lhs
1314+ space
1315+ p_op
1316+ case placement of
1317+ Hanging -> do
13151318 space
13161319 p_y
1320+ Normal -> do
1321+ breakpoint
1322+ inciIf (isDoBlock y) p_y
1323+ | gotDollar
1324+ && isOneLineSpan (opTreeLoc x)
1325+ && placement == Normal -> do
1326+ useBraces lhs
1327+ space
1328+ p_op
1329+ breakpoint
1330+ inci p_y
1331+ | useRecordDot' && gotRecordDot -> do
1332+ lhs
1333+ when isSection space
1334+ p_op
1335+ p_y
1336+ | otherwise -> do
1337+ ub lhs
1338+ placeHanging placement $ do
1339+ p_op
1340+ space
1341+ p_y
13171342
13181343-- | Return 'True' if given expression is a record-dot operator expression.
13191344isRecordDot ::
@@ -1323,15 +1348,11 @@ isRecordDot ::
13231348 SrcSpan ->
13241349 Bool
13251350isRecordDot op (RealSrcSpan ySpan) = case op of
1326− HsVar NoExt (L (RealSrcSpan opSpan) opName) ->
1327− isDot opName && (srcSpanEndCol opSpan == srcSpanStartCol ySpan)
1351+ HsVar NoExtField (L (RealSrcSpan opSpan) opName) ->
1352+ (getOpNameStr opName == ".") && (srcSpanEndCol opSpan == srcSpanStartCol ySpan)
13281353 _ -> False
13291354isRecordDot _ _ = False
13301355
1331−-- | Check whether a given 'RdrName' is the dot operator.
1332−isDot :: RdrName -> Bool
1333−isDot name = rdrNameOcc name == mkVarOcc "."
1334−
13351356-- | Get annotations for the enclosing element.
13361357getEnclosingAnns :: R [AnnKeywordId]
13371358getEnclosingAnns = do