@@ -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,
@@ -18,22 +20,22 @@ import Ctype (is_space)
1820import Data.Bool (bool)
1921import Data.Char (isPunctuation, isSymbol)
2022import Data.Data hiding (Infix, Prefix)
23+import Data.Functor ((<&>))
2124import Data.List (intersperse, sortOn)
22−import Data.List.NonEmpty ((<|), NonEmpty ((:|)))
25+import Data.List.NonEmpty (NonEmpty (..), (<|))
2326import qualified Data.List.NonEmpty as NE
2427import Data.Text (Text)
2528import qualified Data.Text as Text
2629import GHC
27−import OccName (mkVarOcc)
30+import OccName (occNameString)
2831import Ormolu.Printer.Combinators
32+import Ormolu.Printer.Internal
2933import Ormolu.Printer.Meat.Common
3034import {-# SOURCE #-} Ormolu.Printer.Meat.Declaration
3135import Ormolu.Printer.Meat.Declaration.Signature
3236import Ormolu.Printer.Meat.Type
3337import Ormolu.Printer.Operators
3438import Ormolu.Utils
35−import RdrName (RdrName (..), rdrNameOcc)
36−import SrcLoc (combineSrcSpans, isOneLineSpan)
3739
3840-- | Style of a group of equations.
3941data MatchGroupStyle
@@ -59,16 +61,16 @@ data Placement
5961 -- should use it and avoid bumping one level
6062 -- of indentation
6163 Hanging
62− deriving (Eq)
64+ deriving (Eq, Show)
6365
6466p_valDecl :: HsBindLR GhcPs GhcPs -> R ()
6567p_valDecl = \case
66− FunBind NoExt funId funMatches _ _ -> p_funBind funId funMatches
67− 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
6870 VarBind {} -> notImplemented "VarBinds" -- introduced by the type checker
6971 AbsBinds {} -> notImplemented "AbsBinds" -- introduced by the type checker
70− PatSynBind NoExt psb -> p_patSynBind psb
71− XHsBindsLR NoExt -> notImplemented "XHsBindsLR"
72+ PatSynBind NoExtField psb -> p_patSynBind psb
73+ XHsBindsLR x -> noExtCon x
7274
7375p_funBind ::
7476 Located RdrName ->
@@ -98,7 +100,7 @@ p_matchGroup' placer render style MG {..} = do
98100 Case -> id
99101 LambdaCase -> id
100102 _ -> dontUseBraces
101− -- NOTE since we are forcing braces on 'sepSemi' based on 'ob', we have to
103+ -- Since we are forcing braces on 'sepSemi' based on 'ob', we have to
102104 -- restore the brace state inside the sepsemi.
103105 ub <- bool dontUseBraces useBraces <$> canUseBraces
104106 ob $ sepSemi (located' (ub . p_Match)) (unLoc mg_alts)
@@ -112,8 +114,8 @@ p_matchGroup' placer render style MG {..} = do
112114 (matchStrictness m)
113115 m_pats
114116 m_grhss
115− p_Match _ = notImplemented "XMatch"
116−p_matchGroup' _ _ _ (XMatchGroup NoExt) = notImplemented "XMatchGroup"
117+ p_Match (XMatch x) = noExtCon x
118+p_matchGroup' _ _ _ (XMatchGroup x) = noExtCon x
117119
118120-- | Function id obtained through pattern matching on 'FunBind' should not
119121-- be used to print the actual equations because the different ‘RdrNames’
@@ -167,8 +169,8 @@ p_match' ::
167169 GRHSs GhcPs (Located body) ->
168170 R ()
169171p_match' placer render style isInfix strictness m_pats GRHSs {..} = do
170− -- NOTE Normally, since patterns may be placed in a multi-line layout, it
171− -- is necessary to bump indentation for the pattern group so it's more
172+ -- Normally, since patterns may be placed in a multi-line layout, it is
173+ -- necessary to bump indentation for the pattern group so it's more
172174 -- indented than function name. This in turn means that indentation for
173175 -- the body should also be bumped. Normally this would mean that bodies
174176 -- would start with two indentation steps applied, which is ugly, so we
@@ -178,27 +180,26 @@ p_match' placer render style isInfix strictness m_pats GRHSs {..} = do
178180 NoSrcStrict -> return ()
179181 SrcStrict -> txt "!"
180182 SrcLazy -> txt "~"
181− inci' <- case NE.nonEmpty m_pats of
182− Nothing -> id <$ case style of
183− Function name -> p_rdrName name
184− _ -> return ()
183+ indentBody <- case NE.nonEmpty m_pats of
184+ Nothing ->
185+ False <$ case style of
186+ Function name -> p_rdrName name
187+ _ -> return ()
185188 Just ne_pats -> do
186− let combinedSpans =
187− combineSrcSpans' $
188− getLoc <$> ne_pats
189− inci' =
190− if isOneLineSpan combinedSpans
191− then id
192− 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)
193194 switchLayout [combinedSpans] $ do
194− let stdCase = sep breakpoint p_pat m_pats
195+ let stdCase = sep breakpoint (located' p_pat) m_pats
195196 case style of
196197 Function name ->
197198 p_infixDefHelper
198199 isInfix
199− inci'
200+ indentBody
200201 (p_rdrName name)
201− (p_pat <$> m_pats)
202+ (located' p_pat <$> m_pats)
202203 PatternBind -> stdCase
203204 Case -> stdCase
204205 Lambda -> do
@@ -211,40 +212,32 @@ p_match' placer render style isInfix strictness m_pats GRHSs {..} = do
211212 when needsSpace space
212213 sitcc stdCase
213214 LambdaCase -> stdCase
214− return inci'
215+ return indentBody
215216 let -- Calculate position of end of patterns. This is useful when we decide
216217 -- about putting certain constructions in hanging positions.
217218 endOfPats = case NE.nonEmpty m_pats of
218219 Nothing -> case style of
219− Function name -> (Just . srcSpanEnd . getLoc) name
220+ Function name -> Just (getLoc name)
220221 _ -> Nothing
221− Just pats -> (Just . srcSpanEnd . getLoc . NE.last) pats
222+ Just pats -> (Just . getLoc . NE.last) pats
222223 isCase = \case
223224 Case -> True
224225 LambdaCase -> True
225226 _ -> False
226− let hasGuards = withGuards grhssGRHSs
227− unless (length grhssGRHSs > 1) $
228− case style of
229− Function _ | hasGuards -> return ()
230− Function _ -> space >> txt "="
231− PatternBind -> space >> txt "="
232− s | isCase s && hasGuards -> return ()
233− _ -> space >> txt "->"
234− let grhssSpan =
227+ hasGuards = withGuards grhssGRHSs
228+ grhssSpan =
235229 combineSrcSpans' $
236230 getGRHSSpan . unLoc <$> NE.fromList grhssGRHSs
237231 patGrhssSpan =
238232 maybe
239233 grhssSpan
240− (combineSrcSpans grhssSpan . srcLocSpan)
234+ (combineSrcSpans grhssSpan . srcLocSpan . srcSpanEnd)
241235 endOfPats
242236 placement =
243237 case endOfPats of
244238 Nothing -> blockPlacement placer grhssGRHSs
245239 Just spn ->
246− if isOneLineSpan
247− (mkSrcSpan spn (srcSpanStart grhssSpan))
240+ if onTheSameLine spn grhssSpan
248241 then blockPlacement placer grhssGRHSs
249242 else Normal
250243 p_body = do
@@ -260,11 +253,18 @@ p_match' placer render style isInfix strictness m_pats GRHSs {..} = do
260253 txt "where"
261254 unless whereIsEmpty breakpoint
262255 inci $ located grhssLocalBinds p_hsLocalBinds
263− 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 "->"
264264 switchLayout [patGrhssSpan] $
265265 placeHanging placement p_body
266266 inci p_where
267−p_match' _ _ _ _ _ _ XGRHSs {} = notImplemented "XGRHSs"
267+p_match' _ _ _ _ _ _ (XGRHSs x) = noExtCon x
268268
269269p_grhs :: GroupStyle -> GRHS GhcPs (LHsExpr GhcPs) -> R ()
270270p_grhs = p_grhs' exprPlacement p_hsExpr
@@ -278,79 +278,109 @@ p_grhs' ::
278278 GroupStyle ->
279279 GRHS GhcPs (Located body) ->
280280 R ()
281−p_grhs' placer render style (GRHS NoExt guards body) =
281+p_grhs' placer render style (GRHS NoExtField guards body) =
282282 case guards of
283283 [] -> p_body
284284 xs -> do
285285 txt "|"
286286 space
287− sitcc (sep (comma >> breakpoint) (sitcc . located' p_stmt) xs)
287+ sitcc (sep commaDel (sitcc . located' p_stmt) xs)
288288 space
289− txt $ case style of
290− EqualSign -> "="
291− RightArrow -> "->"
289+ inci $ case style of
290+ EqualSign -> equals
291+ RightArrow -> txt "->"
292292 placeHanging placement p_body
293293 where
294294 placement =
295295 case endOfGuards of
296296 Nothing -> placer (unLoc body)
297297 Just spn ->
298− if isOneLineSpan (mkSrcSpan spn (srcSpanStart (getLoc body)))
298+ if onTheSameLine spn (getLoc body)
299299 then placer (unLoc body)
300300 else Normal
301301 endOfGuards =
302302 case NE.nonEmpty guards of
303303 Nothing -> Nothing
304− Just gs -> (Just . srcSpanEnd . getLoc . NE.last) gs
304+ Just gs -> (Just . getLoc . NE.last) gs
305305 p_body = located body render
306−p_grhs' _ _ _ (XGRHS NoExt) = notImplemented "XGRHS"
306+p_grhs' _ _ _ (XGRHS x) = noExtCon x
307307
308308p_hsCmd :: HsCmd GhcPs -> R ()
309309p_hsCmd = \case
310− HsCmdArrApp NoExt body input arrType _ -> do
310+ HsCmdArrApp NoExtField body input arrType _ -> do
311311 located body p_hsExpr
312− space
313− case arrType of
314− HsFirstOrderApp -> txt "-<"
315− HsHigherOrderApp -> txt "-<<"
316− placeHanging (exprPlacement (unLoc input)) $
317− located input p_hsExpr
318− 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
319320 located form p_hsExpr
320321 unless (null cmds) $ do
321322 breakpoint
322323 inci (sequence_ (intersperse breakpoint (located' p_hsCmdTop <$> cmds)))
323− HsCmdArrForm NoExt form Infix _ [left, right] -> do
324+ HsCmdArrForm NoExtField form Infix _ [left, right] -> do
324325 located left p_hsCmdTop
325326 space
326327 located form p_hsExpr
327328 placeHanging (cmdTopPlacement (unLoc right)) $
328329 located right p_hsCmdTop
329− HsCmdArrForm NoExt _ Infix _ _ -> notImplemented "HsCmdArrForm"
330+ HsCmdArrForm NoExtField _ Infix _ _ -> notImplemented "HsCmdArrForm"
330331 HsCmdApp {} ->
331332 -- XXX Does this ever occur in the syntax tree? It does not seem like it
332333 -- does. Open an issue and ping @yumiova if this ever occurs in output.
333334 notImplemented "HsCmdApp"
334− HsCmdLam NoExt mgroup -> p_matchGroup' cmdPlacement p_hsCmd Lambda mgroup
335− HsCmdPar NoExt c -> parens N (located c p_hsCmd)
336− 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 ->
337338 p_case cmdPlacement p_hsCmd e mgroup
338− HsCmdIf NoExt _ if' then' else' ->
339+ HsCmdIf NoExtField _ if' then' else' ->
339340 p_if cmdPlacement p_hsCmd if' then' else'
340− HsCmdLet NoExt localBinds c ->
341+ HsCmdLet NoExtField localBinds c ->
341342 p_let p_hsCmd localBinds c
342− HsCmdDo NoExt es -> do
343+ HsCmdDo NoExtField es -> do
343344 txt "do"
344345 newline
345346 inci . located es $
346− sitcc . sep newline (located' (sitcc . p_stmt' cmdPlacement p_hsCmd))
347+ sitcc . sep newline (sitcc . withSpacing (p_stmt' cmdPlacement p_hsCmd))
347348 HsCmdWrap {} -> notImplemented "HsCmdWrap"
348− XCmd {} -> notImplemented "XCmd"
349+ XCmd x -> noExtCon x
349350
350351p_hsCmdTop :: HsCmdTop GhcPs -> R ()
351352p_hsCmdTop = \case
352− HsCmdTop NoExt cmd -> located cmd p_hsCmd
353− 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)
354384
355385p_stmt :: Stmt GhcPs (LHsExpr GhcPs) -> R ()
356386p_stmt = p_stmt' exprPlacement p_hsExpr
@@ -365,16 +395,13 @@ p_stmt' ::
365395 Stmt GhcPs (Located body) ->
366396 R ()
367397p_stmt' placer render = \case
368− LastStmt NoExt body _ _ -> located body render
369− BindStmt NoExt p f _ _ -> do
370− p_pat p
398+ LastStmt NoExtField body _ _ -> located body render
399+ BindStmt NoExtField p f _ _ -> do
400+ located p p_pat
371401 space
372402 txt "<-"
373− -- https://gitlab.haskell.org/ghc/ghc/issues/17330
374− let loc = case p of
375− XPat pat -> getLoc pat
376− _ -> error "p_stmt': BindStmt: Pat does not contain a location"
377− let placement =
403+ let loc = getLoc p
404+ placement =
378405 case f of
379406 L l' x ->
380407 if isOneLineSpan
@@ -384,20 +411,20 @@ p_stmt' placer render = \case
384411 switchLayout [loc, getLoc f] $
385412 placeHanging placement (located f render)
386413 ApplicativeStmt {} -> notImplemented "ApplicativeStmt" -- generated by renamer
387− BodyStmt NoExt body _ _ -> located body render
388− LetStmt NoExt binds -> do
414+ BodyStmt NoExtField body _ _ -> located body render
415+ LetStmt NoExtField binds -> do
389416 txt "let"
390417 space
391418 sitcc $ located binds p_hsLocalBinds
392419 ParStmt {} ->
393− -- NOTE 'ParStmt' should always be eliminated in 'gatherStmt' already,
394− -- such that it never occurs in 'p_stmt''. Consequently, handling it
395− -- here would be redundant.
420+ -- 'ParStmt' should always be eliminated in 'gatherStmt' already, such
421+ -- that it never occurs in 'p_stmt''. Consequently, handling it here
422+ -- would be redundant.
396423 notImplemented "ParStmt"
397424 TransStmt {..} ->
398− -- NOTE 'TransStmt' only needs to account for render printing itself,
399− -- since pretty printing of relevant statements (e.g., in 'trS_stmts')
400− -- is handled through 'gatherStmt'.
425+ -- 'TransStmt' only needs to account for render printing itself, since
426+ -- pretty printing of relevant statements (e.g., in 'trS_stmts') is
427+ -- handled through 'gatherStmt'.
401428 case (trS_form, trS_by) of
402429 (ThenForm, Nothing) -> do
403430 txt "then"
@@ -426,11 +453,11 @@ p_stmt' placer render = \case
426453 RecStmt {..} -> do
427454 txt "rec"
428455 space
429− sitcc $ sepSemi (located' (p_stmt' placer render)) recS_stmts
430− XStmtLR {} -> notImplemented "XStmtLR"
456+ sitcc $ sepSemi (withSpacing (p_stmt' placer render)) recS_stmts
457+ XStmtLR c -> noExtCon c
431458
432459gatherStmt :: ExprLStmt GhcPs -> [[ExprLStmt GhcPs]]
433−gatherStmt (L _ (ParStmt NoExt block _ _)) =
460+gatherStmt (L _ (ParStmt NoExtField block _ _)) =
434461 foldr ((<>) . gatherStmtBlock) [] block
435462gatherStmt (L s stmt@TransStmt {..}) =
436463 foldr liftAppend [] ((gatherStmt <$> trS_stmts) <> pure [[L s stmt]])
@@ -439,46 +466,46 @@ gatherStmt stmt = [[stmt]]
439466gatherStmtBlock :: ParStmtBlock GhcPs GhcPs -> [[ExprLStmt GhcPs]]
440467gatherStmtBlock (ParStmtBlock _ stmts _ _) =
441468 foldr (liftAppend . gatherStmt) [] stmts
442−gatherStmtBlock XParStmtBlock {} = notImplemented "XParStmtBlock"
469+gatherStmtBlock (XParStmtBlock x) = noExtCon x
443470
444471p_hsLocalBinds :: HsLocalBindsLR GhcPs GhcPs -> R ()
445472p_hsLocalBinds = \case
446− HsValBinds NoExt (ValBinds NoExt bag lsigs) -> do
447− let ssStart =
448− either
449− (srcSpanStart . getLoc)
450− (srcSpanStart . getLoc)
451− items =
452− (Left <$> bagToList bag) ++ (Right <$> lsigs)
453− p_item (Left x) = located x p_valDecl
454− p_item (Right x) = located x p_sigDecl
455− -- Assigns 'False' to the last element, 'True' to the rest.
456− markInit :: [a] -> [(Bool, a)]
457− markInit [] = []
458− markInit [x] = [(False, x)]
459− markInit (x : xs) = (True, x) : markInit xs
460− -- NOTE When in a single-line layout, there is a chance that the inner
473+ HsValBinds NoExtField (ValBinds NoExtField bag lsigs) -> do
474+ -- When in a single-line layout, there is a chance that the inner
461475 -- elements will also contain semicolons and they will confuse the
462476 -- parser. so we request braces around every element except the last.
463477 br <- layoutToBraces <$> getLayout
464− sitcc $
465− sepSemi
466− (\(m, i) -> (if m then br else id) $ p_item i)
467− (markInit $ sortOn ssStart items)
468− HsValBinds NoExt _ -> notImplemented "HsValBinds"
469− 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) ->
470494 -- Second argument of IPBind is always Left before type-checking.
471− let p_ipBind (IPBind NoExt (Left name) expr) = do
495+ let p_ipBind (IPBind NoExtField (Left name) expr) = do
472496 atom name
473497 space
474− txt "="
498+ equals
475499 breakpoint
476500 useBraces $ inci $ located expr p_hsExpr
477− 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
478505 in sepSemi (located' p_ipBind) xs
479− HsIPBinds NoExt _ -> notImplemented "HsIpBinds"
480− EmptyLocalBinds NoExt -> return ()
481− XHsLocalBindsLR _ -> notImplemented "XHsLocalBindsLR"
506+ HsIPBinds NoExtField _ -> notImplemented "HsIpBinds"
507+ EmptyLocalBinds NoExtField -> return ()
508+ XHsLocalBindsLR x -> noExtCon x
482509
483510p_hsRecField ::
484511 HsRecField' RdrName (LHsExpr GhcPs) ->
@@ -487,48 +514,45 @@ p_hsRecField HsRecField {..} = do
487514 p_rdrName hsRecFieldLbl
488515 unless hsRecPun $ do
489516 space
490− txt "="
491− let placement = exprPlacement (unLoc hsRecFieldArg)
492− placeHanging placement $ located hsRecFieldArg p_hsExpr
493−
494−p_hsTupArg :: HsTupArg GhcPs -> R ()
495−p_hsTupArg = \case
496− Present NoExt x -> located x p_hsExpr
497− Missing NoExt -> pure ()
498− 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)
499523
500524p_hsExpr :: HsExpr GhcPs -> R ()
501525p_hsExpr = p_hsExpr' N
502526
503527p_hsExpr' :: BracketStyle -> HsExpr GhcPs -> R ()
504528p_hsExpr' s = \case
505− HsVar NoExt name -> p_rdrName name
506− HsUnboundVar NoExt _ -> notImplemented "HsUnboundVar"
507− HsConLikeOut NoExt _ -> notImplemented "HsConLikeOut"
508− 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 ->
509533 case x of
510− Unambiguous NoExt name -> p_rdrName name
511− Ambiguous NoExt name -> p_rdrName name
512− XAmbiguousFieldOcc NoExt -> notImplemented "XAmbiguousFieldOcc"
513− 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
514538 txt "#"
515539 atom v
516− HsIPVar NoExt (HsIPName name) -> do
540+ HsIPVar NoExtField (HsIPName name) -> do
517541 txt "?"
518542 atom name
519− HsOverLit NoExt v -> atom (ol_val v)
520− HsLit NoExt lit ->
543+ HsOverLit NoExtField v -> atom (ol_val v)
544+ HsLit NoExtField lit ->
521545 case lit of
522546 HsString (SourceText stxt) _ -> p_stringLit stxt
523547 HsStringPrim (SourceText stxt) _ -> p_stringLit stxt
524548 r -> atom r
525− HsLam NoExt mgroup ->
549+ HsLam NoExtField mgroup ->
526550 p_matchGroup Lambda mgroup
527− HsLamCase NoExt mgroup -> do
551+ HsLamCase NoExtField mgroup -> do
528552 txt "\\case"
529553 breakpoint
530554 inci (p_matchGroup LambdaCase mgroup)
531− HsApp NoExt f x -> do
555+ HsApp NoExtField f x -> do
532556 let -- In order to format function applications with multiple parameters
533557 -- nicer, traverse the AST to gather the function and all the
534558 -- parameters together.
@@ -540,8 +564,10 @@ p_hsExpr' s = \case
540564 -- We need to handle the last argument specially if it is a
541565 -- hanging construct, so separate it from the rest.
542566 (initp, lastp) = (NE.init args, NE.last args)
543− initSpan = combineSrcSpans' $ getLoc f :| map getLoc initp
544− -- Hang the last argument only if the initial arguments spans one
567+ initSpan =
568+ combineSrcSpans' $
569+ getLoc f :| [(srcLocSpan . srcSpanStart . getLoc) lastp]
570+ -- Hang the last argument only if the initial arguments span one
545571 -- line.
546572 placement =
547573 if isOneLineSpan initSpan
@@ -553,11 +579,26 @@ p_hsExpr' s = \case
553579 -- one.
554580 case placement of
555581 Normal -> do
556− useBraces $ do
582+ let -- Usually we want to bump indentation for arguments for the
583+ -- sake of readability. However, when the function itself is a
584+ -- do-block or case expression it is not a good idea. It seems
585+ -- to be safe to always bump indentation when the function
586+ -- expression is parenthesised.
587+ doIndent =
588+ case func of
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
597+ ub $ do
557598 located func (p_hsExpr' s)
558599 breakpoint
559− inci $ sep breakpoint (located' p_hsExpr) initp
560− inci $ do
600+ inciIf doIndent $ sep breakpoint (located' p_hsExpr) initp
601+ inciIf doIndent $ do
561602 unless (null initp) breakpoint
562603 located lastp p_hsExpr
563604 Hanging -> do
@@ -567,75 +608,87 @@ p_hsExpr' s = \case
567608 sep breakpoint (located' p_hsExpr) initp
568609 placeHanging placement $
569610 located lastp p_hsExpr
570− HsAppType NoExt e a -> do
611+ HsAppType NoExtField e a -> do
571612 located e p_hsExpr
572613 breakpoint
573614 inci $ do
574615 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 ()
575621 located (hswc_body a) p_hsType
576− OpApp NoExt x op y -> do
622+ OpApp NoExtField x op y -> do
577623 let opTree = OpBranch (exprOpTree x) op (exprOpTree y)
578− p_exprOpTree True s (reassociateOpTree getOpName opTree)
579− NegApp NoExt e _ -> do
624+ p_exprOpTree s (reassociateOpTree getOpName opTree)
625+ NegApp NoExtField e _ -> do
580626 txt "-"
581627 space
582628 located e p_hsExpr
583− HsPar NoExt e ->
629+ HsPar NoExtField e ->
584630 parens s (located e (dontUseBraces . p_hsExpr))
585− SectionL NoExt x op -> do
631+ SectionL NoExtField x op -> do
586632 located x p_hsExpr
587633 breakpoint
588634 inci (located op p_hsExpr)
589− SectionR NoExt op x -> do
635+ SectionR NoExtField op x -> do
590636 located op p_hsExpr
591− breakpoint
637+ useRecordDot' <- useRecordDot
638+ let isRecordDot' = isRecordDot (unLoc op) (getLoc x)
639+ unless (useRecordDot' && isRecordDot') breakpoint
592640 inci (located x p_hsExpr)
593− ExplicitTuple NoExt args boxity -> do
641+ ExplicitTuple NoExtField args boxity ->
594642 let isSection = any (isMissing . unLoc) args
595643 isMissing = \case
596− Missing NoExt -> True
644+ Missing NoExtField -> True
597645 _ -> False
598− 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' =
599652 case boxity of
600653 Boxed -> parens
601654 Unboxed -> parensHash
602− if isSection
603− then
604− switchLayout [] . parens' s $
605− sep comma (located' p_hsTupArg) args
606− else
607− switchLayout (getLoc <$> args) . parens' s . sitcc $
608− sep (comma >> breakpoint) (sitcc . located' p_hsTupArg) args
609− 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 ->
610663 p_unboxedSum N tag arity (located e p_hsExpr)
611− HsCase NoExt e mgroup ->
664+ HsCase NoExtField e mgroup ->
612665 p_case exprPlacement p_hsExpr e mgroup
613− HsIf NoExt _ if' then' else' ->
666+ HsIf NoExtField _ if' then' else' ->
614667 p_if exprPlacement p_hsExpr if' then' else'
615− HsMultiIf NoExt guards -> do
668+ HsMultiIf NoExtField guards -> do
616669 txt "if"
617670 breakpoint
618− inci . sitcc $ sep newline (located' (p_grhs RightArrow)) guards
619− HsLet NoExt localBinds e ->
671+ inci . inci $ sep newline (located' (p_grhs RightArrow)) guards
672+ HsLet NoExtField localBinds e ->
620673 p_let p_hsExpr localBinds e
621− HsDo NoExt ctx es -> do
674+ HsDo NoExtField ctx es -> do
622675 let doBody header = do
623676 txt header
624677 breakpoint
625678 ub <- layoutToBraces <$> getLayout
626679 inci $
627680 sepSemi
628− (located' (ub . p_stmt' exprPlacement (p_hsExpr' S)))
681+ (ub . withSpacing (p_stmt' exprPlacement (p_hsExpr' S)))
629682 (unLoc es)
630− compBody = brackets N $ located es $ \xs -> do
683+ compBody = brackets N . located es $ \xs -> do
631684 let p_parBody =
632685 sep
633− (breakpoint >> txt "| ")
686+ (breakpoint >> txt "|" >> space)
634687 p_seqBody
635688 p_seqBody =
636689 sitcc
637690 . sep
638− (comma >> breakpoint)
691+ commaDel
639692 (located' (sitcc . p_stmt))
640693 stmts = init xs
641694 yield = last xs
@@ -656,90 +709,96 @@ p_hsExpr' s = \case
656709 ParStmtCtxt _ -> notImplemented "ParStmtCtxt"
657710 TransStmtCtxt _ -> notImplemented "TransStmtCtxt"
658711 ExplicitList _ _ xs ->
659− brackets s . sitcc $
660− sep (comma >> breakpoint) (sitcc . located' p_hsExpr) xs
712+ brackets s $
713+ sep commaDel (sitcc . located' p_hsExpr) xs
661714 RecordCon {..} -> do
662715 located rcon_con_name atom
663716 breakpoint
664717 let HsRecFields {..} = rcon_flds
665718 updName f =
666− f
719+ (f :: HsRecField GhcPs (LHsExpr GhcPs))
667720 { hsRecFieldLbl = case unLoc $ hsRecFieldLbl f of
668721 FieldOcc _ n -> n
669− XFieldOcc _ -> notImplemented "XFieldOcc"
722+ XFieldOcc x -> noExtCon x
670723 }
671724 fields = located' (p_hsRecField . updName) <$> rec_flds
672725 dotdot =
673726 case rec_dotdot of
674727 Just {} -> [txt ".."]
675728 Nothing -> []
676− inci . braces N . sitcc $
677− sep (comma >> breakpoint) sitcc (fields <> dotdot)
729+ inci . braces N $
730+ sep commaDel sitcc (fields <> dotdot)
678731 RecordUpd {..} -> do
679732 located rupd_expr p_hsExpr
680− 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
681741 let updName f =
682− f
742+ (f :: HsRecUpdField GhcPs)
683743 { hsRecFieldLbl = case unLoc $ hsRecFieldLbl f of
684744 Ambiguous _ n -> n
685745 Unambiguous _ n -> n
686− XAmbiguousFieldOcc _ -> notImplemented "XAmbiguousFieldOcc"
746+ XAmbiguousFieldOcc x -> noExtCon x
687747 }
688− inci . braces N . sitcc $
748+ inci . braces N $
689749 sep
690− (comma >> breakpoint)
750+ commaDel
691751 (sitcc . located' (p_hsRecField . updName))
692752 rupd_flds
693− ExprWithTySig NoExt x HsWC {hswc_body = HsIB {..}} -> sitcc $ do
753+ ExprWithTySig NoExtField x HsWC {hswc_body = HsIB {..}} -> sitcc $ do
694754 located x p_hsExpr
695755 space
696756 txt "::"
697757 breakpoint
698758 inci $ located hsib_body p_hsType
699− ExprWithTySig NoExt _ HsWC {hswc_body = XHsImplicitBndrs {}} ->
700− notImplemented "XHsImplicitBndrs"
701− ExprWithTySig NoExt _ XHsWildCardBndrs {} -> notImplemented "XHsWildCardBndrs"
702− ArithSeq NoExt _ x ->
759+ ExprWithTySig NoExtField _ HsWC {hswc_body = XHsImplicitBndrs x} -> noExtCon x
760+ ExprWithTySig NoExtField _ (XHsWildCardBndrs x) -> noExtCon x
761+ ArithSeq NoExtField _ x ->
703762 case x of
704− From from -> brackets s . sitcc $ do
763+ From from -> brackets s $ do
705764 located from p_hsExpr
706765 breakpoint
707766 txt ".."
708− FromThen from next -> brackets s . sitcc $ do
709− sitcc $ sep (comma >> breakpoint) (located' p_hsExpr) [from, next]
767+ FromThen from next -> brackets s $ do
768+ sep commaDel (located' p_hsExpr) [from, next]
710769 breakpoint
711770 txt ".."
712− FromTo from to -> brackets s . sitcc $ do
771+ FromTo from to -> brackets s $ do
713772 located from p_hsExpr
714773 breakpoint
715774 txt ".."
716775 space
717776 located to p_hsExpr
718− FromThenTo from next to -> brackets s . sitcc $ do
719− 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]
720779 breakpoint
721780 txt ".."
722781 space
723782 located to p_hsExpr
724− HsSCC NoExt _ name x -> do
783+ HsSCC NoExtField _ name x -> do
725784 txt "{-# SCC "
726785 atom name
727786 txt " #-}"
728787 breakpoint
729788 located x p_hsExpr
730− HsCoreAnn NoExt _ value x -> do
789+ HsCoreAnn NoExtField _ value x -> do
731790 txt "{-# CORE "
732791 atom value
733792 txt " #-}"
734793 breakpoint
735794 located x p_hsExpr
736− HsBracket NoExt x -> p_hsBracket x
795+ HsBracket NoExtField x -> p_hsBracket x
737796 HsRnBracketOut {} -> notImplemented "HsRnBracketOut"
738797 HsTcBracketOut {} -> notImplemented "HsTcBracketOut"
739− HsSpliceE NoExt splice -> p_hsSplice splice
740− HsProc NoExt p e -> do
798+ HsSpliceE NoExtField splice -> p_hsSplice splice
799+ HsProc NoExtField p e -> do
741800 txt "proc"
742− locatedPat p $ \x -> do
801+ located p $ \x -> do
743802 breakpoint
744803 inci (p_pat x)
745804 breakpoint
@@ -750,31 +809,11 @@ p_hsExpr' s = \case
750809 txt "static"
751810 breakpoint
752811 inci (located e p_hsExpr)
753− HsArrApp NoExt body input arrType cond ->
754− p_hsCmd (HsCmdArrApp NoExt body input arrType cond)
755− HsArrForm NoExt form mfixity cmds ->
756− p_hsCmd (HsCmdArrForm NoExt form Prefix mfixity cmds)
757812 HsTick {} -> notImplemented "HsTick"
758813 HsBinTick {} -> notImplemented "HsBinTick"
759814 HsTickPragma {} -> notImplemented "HsTickPragma"
760− -- These four constructs should never appear in correct programs.
761− -- See: https://github.com/tweag/ormolu/issues/343
762− EWildPat NoExt -> txt "_"
763− EAsPat NoExt n p -> do
764− p_rdrName n
765− txt "@"
766− located p p_hsExpr
767− EViewPat NoExt p e -> do
768− located p p_hsExpr
769− space
770− txt "->"
771− breakpoint
772− inci (located e p_hsExpr)
773− ELazyPat NoExt p -> do
774− txt "~"
775− located p p_hsExpr
776815 HsWrap {} -> notImplemented "HsWrap"
777− XExpr {} -> notImplemented "XExpr"
816+ XExpr x -> noExtCon x
778817
779818p_patSynBind :: PatSynBind GhcPs GhcPs -> R ()
780819p_patSynBind PSB {..} = do
@@ -784,15 +823,15 @@ p_patSynBind PSB {..} = do
784823 Unidirectional -> do
785824 txt "<-"
786825 breakpoint
787− p_pat psb_def
826+ located psb_def p_pat
788827 ImplicitBidirectional -> do
789− txt "="
828+ equals
790829 breakpoint
791− p_pat psb_def
830+ located psb_def p_pat
792831 ExplicitBidirectional mgroup -> do
793832 txt "<-"
794833 breakpoint
795− p_pat psb_def
834+ located psb_def p_pat
796835 newline
797836 txt "where"
798837 newline
@@ -813,8 +852,8 @@ p_patSynBind PSB {..} = do
813852 inci $ do
814853 switchLayout (getLoc . recordPatSynPatVar <$> xs) $ do
815854 unless (null xs) breakpoint
816− braces N . sitcc $
817− sep (comma >> breakpoint) (p_rdrName . recordPatSynPatVar) xs
855+ braces N $
856+ sep commaDel (p_rdrName . recordPatSynPatVar) xs
818857 rhs
819858 InfixCon l r -> do
820859 switchLayout [getLoc l, getLoc r] $ do
@@ -826,7 +865,7 @@ p_patSynBind PSB {..} = do
826865 space
827866 p_rdrName r
828867 inci rhs
829−p_patSynBind (XPatSynBind NoExt) = notImplemented "XPatSynBind"
868+p_patSynBind (XPatSynBind x) = noExtCon x
830869
831870p_case ::
832871 Data body =>
@@ -868,10 +907,12 @@ p_if placer render if' then' else' = do
868907 breakpoint
869908 inci $ do
870909 txt "then"
910+ space
871911 located then' $ \x ->
872912 placeHanging (placer x) (render x)
873913 breakpoint
874914 txt "else"
915+ space
875916 located else' $ \x ->
876917 placeHanging (placer x) (render x)
877918
@@ -893,77 +934,77 @@ p_let render localBinds e = sitcc $ do
893934
894935p_pat :: Pat GhcPs -> R ()
895936p_pat = \case
896− -- Note: starting from GHC 8.8, 'LPat' == 'Pat'. Located 'Pat's are always
897− -- constructed with the 'XPat' constructor, containing a @Located Pat@.
898− XPat pat -> located pat p_pat
899− WildPat NoExt -> txt "_"
900− VarPat NoExt name -> p_rdrName name
901− LazyPat NoExt pat -> do
937+ WildPat NoExtField -> txt "_"
938+ VarPat NoExtField name -> p_rdrName name
939+ LazyPat NoExtField pat -> do
902940 txt "~"
903− p_pat pat
904− AsPat NoExt name pat -> do
941+ located pat p_pat
942+ AsPat NoExtField name pat -> do
905943 p_rdrName name
906944 txt "@"
907− p_pat pat
908− ParPat NoExt pat ->
909− locatedPat pat (parens S . p_pat)
910− 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
911949 txt "!"
912− p_pat pat
913− ListPat NoExt pats ->
914− brackets S . sitcc $ sep (comma >> breakpoint) p_pat pats
915− TuplePat NoExt pats boxing -> do
916− 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' =
917955 case boxing of
918956 Boxed -> parens S
919957 Unboxed -> parensHash S
920− f . sitcc $ sep (comma >> breakpoint) (sitcc . p_pat) pats
921− SumPat NoExt pat tag arity ->
922− 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)
923961 ConPatIn pat details ->
924962 case details of
925963 PrefixCon xs -> sitcc $ do
926964 p_rdrName pat
927965 unless (null xs) $ do
928966 breakpoint
929− inci . sitcc $ sep breakpoint (sitcc . p_pat) xs
967+ inci . sitcc $ sep breakpoint (sitcc . located' p_pat) xs
930968 RecCon (HsRecFields fields dotdot) -> do
931969 p_rdrName pat
932970 breakpoint
933971 let f = \case
934972 Nothing -> txt ".."
935973 Just x -> located x p_pat_hsRecField
936− inci . braces N . sitcc . sep (comma >> breakpoint) f $
974+ inci . braces N . sep commaDel f $
937975 case dotdot of
938976 Nothing -> Just <$> fields
939− Just n -> (Just <$> take n fields) ++ [Nothing]
940− InfixCon x y -> do
941− p_pat x
942− space
943− p_rdrName pat
944− breakpoint
945− 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
946986 ConPatOut {} -> notImplemented "ConPatOut" -- presumably created by renamer?
947− ViewPat NoExt expr pat -> sitcc $ do
987+ ViewPat NoExtField expr pat -> sitcc $ do
948988 located expr p_hsExpr
949989 space
950990 txt "->"
951991 breakpoint
952− inci (p_pat pat)
953− SplicePat NoExt splice -> p_hsSplice splice
954− LitPat NoExt p -> atom p
955− NPat NoExt v _ _ -> located v (atom . ol_val)
956− 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
957997 p_rdrName n
958998 breakpoint
959999 inci $ do
9601000 txt "+"
9611001 space
9621002 located k (atom . ol_val)
963− SigPat NoExt pat hswc -> do
964− p_pat pat
1003+ SigPat NoExtField pat hswc -> do
1004+ located pat p_pat
9651005 p_typeAscription hswc
9661006 CoPat {} -> notImplemented "CoPat" -- apparently created at some later stage
1007+ XPat x -> noExtCon x
9671008
9681009p_pat_hsRecField :: HsRecField' (FieldOcc GhcPs) (LPat GhcPs) -> R ()
9691010p_pat_hsRecField HsRecField {..} = do
@@ -971,42 +1012,40 @@ p_pat_hsRecField HsRecField {..} = do
9711012 p_rdrName (rdrNameFieldOcc x)
9721013 unless hsRecPun $ do
9731014 space
974− txt "="
1015+ equals
9751016 breakpoint
976− inci (p_pat hsRecFieldArg)
1017+ inci (located hsRecFieldArg p_pat)
9771018
9781019p_unboxedSum :: BracketStyle -> ConTag -> Arity -> R () -> R ()
9791020p_unboxedSum s tag arity m = do
9801021 let before = tag - 1
9811022 after = arity - before - 1
9821023 args = replicate before Nothing <> [Just m] <> replicate after Nothing
983− f (x, i) = do
984− let isFirst = i == 0
985− isLast = i == arity - 1
1024+ f x =
9861025 case x :: Maybe (R ()) of
9871026 Nothing ->
988− unless (isFirst || isLast) space
1027+ space
9891028 Just m' -> do
990− unless isFirst space
1029+ space
9911030 m'
992− unless isLast space
993− parensHash s $ sep (txt "|") f (zip args [0 ..])
1031+ space
1032+ parensHash s $ sep (txt "|") f args
9941033
9951034p_hsSplice :: HsSplice GhcPs -> R ()
9961035p_hsSplice = \case
997− HsTypedSplice NoExt deco _ expr -> p_hsSpliceTH True expr deco
998− HsUntypedSplice NoExt deco _ expr -> p_hsSpliceTH False expr deco
999− 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
10001039 txt "["
10011040 p_rdrName (L srcSpan quoterName)
10021041 txt "|"
1003− -- NOTE QuasiQuoters often rely on precise custom strings. We cannot do
1004− -- any formatting here without potentially breaking someone's code.
1042+ -- QuasiQuoters often rely on precise custom strings. We cannot do any
1043+ -- formatting here without potentially breaking someone's code.
10051044 atom str
10061045 txt "|]"
10071046 HsSpliced {} -> notImplemented "HsSpliced"
10081047 HsSplicedT {} -> notImplemented "HsSplicedT"
1009− XSplice {} -> notImplemented "XSplice"
1048+ XSplice x -> noExtCon x
10101049
10111050p_hsSpliceTH ::
10121051 -- | Typed splice?
@@ -1030,17 +1069,17 @@ p_hsSpliceTH isTyped expr = \case
10301069
10311070p_hsBracket :: HsBracket GhcPs -> R ()
10321071p_hsBracket = \case
1033− ExpBr NoExt expr -> do
1072+ ExpBr NoExtField expr -> do
10341073 anns <- getEnclosingAnns
10351074 let name = case anns of
10361075 AnnOpenEQ : _ -> ""
10371076 _ -> "e"
10381077 quote name (located expr p_hsExpr)
1039− PatBr NoExt pat -> quote "p" (p_pat pat)
1040− DecBrL NoExt decls -> quote "d" (p_hsDecls Free decls)
1041− DecBrG NoExt _ -> notImplemented "DecBrG" -- result of renamer
1042− TypBr NoExt ty -> quote "t" (located ty p_hsType)
1043− 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
10441083 txt (bool "''" "'" isSingleQuote)
10451084 -- HACK As you can see we use 'noLoc' here to be able to pass name into
10461085 -- 'p_rdrName' since the latter expects a "located" thing. The problem
@@ -1055,13 +1094,13 @@ p_hsBracket = \case
10551094 && not (doesNotNeedExtraParens name)
10561095 wrapper = if isOperator then parens N else id
10571096 wrapper $ p_rdrName (noLoc name)
1058− TExpBr NoExt expr -> do
1097+ TExpBr NoExtField expr -> do
10591098 txt "[||"
10601099 breakpoint'
10611100 located expr p_hsExpr
10621101 breakpoint'
10631102 txt "||]"
1064− XBracket {} -> notImplemented "XBracket"
1103+ XBracket x -> noExtCon x
10651104 where
10661105 quote :: Text -> R () -> R ()
10671106 quote name body = do
@@ -1140,9 +1179,9 @@ liftAppend (x : xs) [] = x : xs
11401179liftAppend (x : xs) (y : ys) = x <> y : liftAppend xs ys
11411180
11421181getGRHSSpan :: GRHS GhcPs (Located body) -> SrcSpan
1143−getGRHSSpan (GRHS NoExt guards body) =
1182+getGRHSSpan (GRHS NoExtField guards body) =
11441183 combineSrcSpans' $ getLoc body :| map getLoc guards
1145−getGRHSSpan (XGRHS NoExt) = notImplemented "XGRHS"
1184+getGRHSSpan (XGRHS x) = noExtCon x
11461185
11471186-- | Place a thing that may have a hanging form. This function handles how
11481187-- to separate it from preceding expressions and whether to bump indentation
@@ -1163,82 +1202,77 @@ blockPlacement ::
11631202 (body -> Placement) ->
11641203 [LGRHS GhcPs (Located body)] ->
11651204 Placement
1166−blockPlacement placer [L _ (GRHS NoExt _ (L _ x))] = placer x
1205+blockPlacement placer [L _ (GRHS NoExtField _ (L _ x))] = placer x
11671206blockPlacement _ _ = Normal
11681207
11691208-- | Check if given command has a hanging form.
11701209cmdPlacement :: HsCmd GhcPs -> Placement
11711210cmdPlacement = \case
1172− HsCmdLam NoExt _ -> Hanging
1173− HsCmdCase NoExt _ _ -> Hanging
1174− HsCmdDo NoExt _ -> Hanging
1211+ HsCmdLam NoExtField _ -> Hanging
1212+ HsCmdCase NoExtField _ _ -> Hanging
1213+ HsCmdDo NoExtField _ -> Hanging
11751214 _ -> Normal
11761215
11771216cmdTopPlacement :: HsCmdTop GhcPs -> Placement
11781217cmdTopPlacement = \case
1179− HsCmdTop NoExt (L _ x) -> cmdPlacement x
1180− XCmdTop {} -> notImplemented "XCmdTop"
1218+ HsCmdTop NoExtField (L _ x) -> cmdPlacement x
1219+ XCmdTop x -> noExtCon x
11811220
11821221-- | Check if given expression has a hanging form.
11831222exprPlacement :: HsExpr GhcPs -> Placement
11841223exprPlacement = \case
11851224 -- Only hang lambdas with single line parameter lists
1186− HsLam NoExt mg -> case mg of
1187− MG _ (L _ [L _ (Match NoExt _ (x : xs) _)]) _
1225+ HsLam NoExtField mg -> case mg of
1226+ MG _ (L _ [L _ (Match NoExtField _ (x : xs) _)]) _
11881227 | isOneLineSpan (combineSrcSpans' $ fmap getLoc (x :| xs)) ->
11891228 Hanging
11901229 _ -> Normal
1191− HsLamCase NoExt _ -> Hanging
1192− HsCase NoExt _ _ -> Hanging
1193− HsDo NoExt DoExpr _ -> Hanging
1194− HsDo NoExt MDoExpr _ -> Hanging
1195− RecordCon NoExt _ _ -> Hanging
1196− -- If the rightmost expression in an operator chain is hanging, make the
1197− -- whole block hanging; so that we can use the common @f = foo $ do@
1198− -- style.
1199− OpApp NoExt _ _ y -> exprPlacement (unLoc y)
1200− -- Same thing for function applications (usually with -XBlockArguments)
1201− HsApp NoExt _ y -> exprPlacement (unLoc y)
1202− HsProc NoExt p _ ->
1203− -- https://gitlab.haskell.org/ghc/ghc/issues/17330
1204− let loc = case p of
1205− XPat pat -> getLoc pat
1206− _ -> error "exprPlacement: HsProc: Pat does not contain a location"
1207− in -- Indentation breaks if pattern is longer than one line and left
1208− -- hanging. Consequently, only apply hanging when it is safe.
1209− if isOneLineSpan loc
1210− then Hanging
1211− 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
12121245 _ -> Normal
12131246
12141247withGuards :: [LGRHS GhcPs (Located body)] -> Bool
12151248withGuards = any (checkOne . unLoc)
12161249 where
12171250 checkOne :: GRHS GhcPs (Located body) -> Bool
1218− checkOne (GRHS NoExt [] _) = False
1251+ checkOne (GRHS NoExtField [] _) = False
12191252 checkOne _ = True
12201253
12211254exprOpTree :: LHsExpr GhcPs -> OpTree (LHsExpr GhcPs) (LHsExpr GhcPs)
1222−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)
12231256exprOpTree n = OpNode n
12241257
12251258getOpName :: HsExpr GhcPs -> Maybe RdrName
12261259getOpName = \case
1227− HsVar NoExt (L _ a) -> Just a
1260+ HsVar NoExtField (L _ a) -> Just a
12281261 _ -> Nothing
12291262
1263+getOpNameStr :: RdrName -> String
1264+getOpNameStr = occNameString . rdrNameOcc
1265+
12301266p_exprOpTree ::
1231− -- | Can use special handling of dollar?
1232− Bool ->
12331267 -- | Bracket style to use
12341268 BracketStyle ->
12351269 OpTree (LHsExpr GhcPs) (LHsExpr GhcPs) ->
12361270 R ()
1237−p_exprOpTree _ s (OpNode x) = located x (p_hsExpr' s)
1238−p_exprOpTree isDollarSpecial s (OpBranch x op y) = do
1239− -- NOTE If the beginning of the first argument and the second argument
1240− -- are on the same line, and the second argument has a hanging form, use
1241− -- hanging placement.
1271+p_exprOpTree s (OpNode x) = located x (p_hsExpr' s)
1272+p_exprOpTree s (OpBranch x op y) = do
1273+ -- If the beginning of the first argument and the second argument are on
1274+ -- the same line, and the second argument has a hanging form, use hanging
1275+ -- placement.
12421276 let placement =
12431277 if isOneLineSpan
12441278 (mkSrcSpan (srcSpanStart (opTreeLoc x)) (srcSpanStart (opTreeLoc y)))
@@ -1246,8 +1280,10 @@ p_exprOpTree isDollarSpecial s (OpBranch x op y) = do
12461280 OpNode (L _ n) -> exprPlacement n
12471281 _ -> Normal
12481282 else Normal
1283+ -- Distinguish holes used in infix notation.
1284+ -- eg. '1 _foo 2' and '1 `_foo` 2'
12491285 opWrapper = case unLoc op of
1250− EWildPat NoExt -> backticks
1286+ HsUnboundVar NoExtField _ -> backticks
12511287 _ -> id
12521288 layout <- getLayout
12531289 let ub = case layout of
@@ -1255,27 +1291,67 @@ p_exprOpTree isDollarSpecial s (OpBranch x op y) = do
12551291 MultiLine -> case placement of
12561292 Hanging -> useBraces
12571293 Normal -> dontUseBraces
1258− gotDollar = case getOpName (unLoc op) of
1259− Just rname -> mkVarOcc "$" == rdrNameOcc rname
1260− _ -> False
1294+ opNameStr = (fmap getOpNameStr . getOpName . unLoc) op
1295+ gotDollar = opNameStr == Just "$"
1296+ gotColon = opNameStr == Just ":"
1297+ gotRecordDot = isRecordDot (unLoc op) (opTreeLoc y)
12611298 lhs =
12621299 switchLayout [opTreeLoc x] $
1263− p_exprOpTree (not gotDollar) s x
1264− let p_op = located op (opWrapper . p_hsExpr)
1265− p_y = switchLayout [opTreeLoc y] (p_exprOpTree True N y)
1266− if isDollarSpecial && gotDollar && placement == Normal && isOneLineSpan (opTreeLoc x)
1267− then do
1268− useBraces lhs
1269− space
1270− p_op
1271− breakpoint
1272− inci p_y
1273− else do
1274− ub lhs
1275− placeHanging placement $ do
1300+ p_exprOpTree s x
1301+ p_op = located op (opWrapper . p_hsExpr)
1302+ p_y = switchLayout [opTreeLoc y] (p_exprOpTree N y)
1303+ isSection = case (opTreeLoc x, getLoc op) of
1304+ (RealSrcSpan treeSpan, RealSrcSpan opSpan) ->
1305+ srcSpanEndCol treeSpan /= srcSpanStartCol opSpan
1306+ _ -> False
1307+ isDoBlock = \case
1308+ OpNode (L _ HsDo {}) -> True
1309+ _ -> False
1310+ useRecordDot' <- useRecordDot
1311+ if
1312+ | gotColon -> do
1313+ lhs
1314+ space
12761315 p_op
1316+ case placement of
1317+ Hanging -> do
1318+ space
1319+ 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
12771327 space
1328+ p_op
1329+ breakpoint
1330+ inci p_y
1331+ | useRecordDot' && gotRecordDot -> do
1332+ lhs
1333+ when isSection space
1334+ p_op
12781335 p_y
1336+ | otherwise -> do
1337+ ub lhs
1338+ placeHanging placement $ do
1339+ p_op
1340+ space
1341+ p_y
1342+
1343+-- | Return 'True' if given expression is a record-dot operator expression.
1344+isRecordDot ::
1345+ -- | Operator expression
1346+ HsExpr GhcPs ->
1347+ -- | Span of the expression on the right-hand side of the operator
1348+ SrcSpan ->
1349+ Bool
1350+isRecordDot op (RealSrcSpan ySpan) = case op of
1351+ HsVar NoExtField (L (RealSrcSpan opSpan) opName) ->
1352+ (getOpNameStr opName == ".") && (srcSpanEndCol opSpan == srcSpanStartCol ySpan)
1353+ _ -> False
1354+isRecordDot _ _ = False
12791355
12801356-- | Get annotations for the enclosing element.
12811357getEnclosingAnns :: R [AnnKeywordId]