@@ -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,23 +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 (..))
36−import RdrName (rdrNameOcc)
37−import SrcLoc (combineSrcSpans, isOneLineSpan)
3839
3940-- | Style of a group of equations.
4041data MatchGroupStyle
@@ -60,16 +61,16 @@ data Placement
6061 -- should use it and avoid bumping one level
6162 -- of indentation
6263 Hanging
63− deriving (Eq)
64+ deriving (Eq, Show)
6465
6566p_valDecl :: HsBindLR GhcPs GhcPs -> R ()
6667p_valDecl = \case
67− FunBind NoExt funId funMatches _ _ -> p_funBind funId funMatches
68− 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
6970 VarBind {} -> notImplemented "VarBinds" -- introduced by the type checker
7071 AbsBinds {} -> notImplemented "AbsBinds" -- introduced by the type checker
71− PatSynBind NoExt psb -> p_patSynBind psb
72− XHsBindsLR NoExt -> notImplemented "XHsBindsLR"
72+ PatSynBind NoExtField psb -> p_patSynBind psb
73+ XHsBindsLR x -> noExtCon x
7374
7475p_funBind ::
7576 Located RdrName ->
@@ -99,7 +100,7 @@ p_matchGroup' placer render style MG {..} = do
99100 Case -> id
100101 LambdaCase -> id
101102 _ -> dontUseBraces
102− -- 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
103104 -- restore the brace state inside the sepsemi.
104105 ub <- bool dontUseBraces useBraces <$> canUseBraces
105106 ob $ sepSemi (located' (ub . p_Match)) (unLoc mg_alts)
@@ -113,8 +114,8 @@ p_matchGroup' placer render style MG {..} = do
113114 (matchStrictness m)
114115 m_pats
115116 m_grhss
116− p_Match _ = notImplemented "XMatch"
117−p_matchGroup' _ _ _ (XMatchGroup NoExt) = notImplemented "XMatchGroup"
117+ p_Match (XMatch x) = noExtCon x
118+p_matchGroup' _ _ _ (XMatchGroup x) = noExtCon x
118119
119120-- | Function id obtained through pattern matching on 'FunBind' should not
120121-- be used to print the actual equations because the different ‘RdrNames’
@@ -167,9 +168,9 @@ p_match' ::
167168 -- | Equations
168169 GRHSs GhcPs (Located body) ->
169170 R ()
170−p_match' placer render style isInfix strictness m_pats m_grhss = do
171− -- NOTE Normally, since patterns may be placed in a multi-line layout, it
172− -- is necessary to bump indentation for the pattern group so it's more
171+p_match' placer render style isInfix strictness m_pats GRHSs {..} = do
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
173174 -- indented than function name. This in turn means that indentation for
174175 -- the body should also be bumped. Normally this would mean that bodies
175176 -- would start with two indentation steps applied, which is ugly, so we
@@ -179,27 +180,26 @@ p_match' placer render style isInfix strictness m_pats m_grhss = do
179180 NoSrcStrict -> return ()
180181 SrcStrict -> txt "!"
181182 SrcLazy -> txt "~"
182− inci' <- case NE.nonEmpty m_pats of
183− Nothing -> id <$ case style of
184− Function name -> p_rdrName name
185− _ -> return ()
183+ indentBody <- case NE.nonEmpty m_pats of
184+ Nothing ->
185+ False <$ case style of
186+ Function name -> p_rdrName name
187+ _ -> return ()
186188 Just ne_pats -> do
187− let combinedSpans =
188− combineSrcSpans' $
189− getLoc <$> ne_pats
190− inci' =
191− if isOneLineSpan combinedSpans
192− then id
193− 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)
194194 switchLayout [combinedSpans] $ do
195− let stdCase = sep breakpoint p_pat m_pats
195+ let stdCase = sep breakpoint (located' p_pat) m_pats
196196 case style of
197197 Function name ->
198198 p_infixDefHelper
199199 isInfix
200− inci'
200+ indentBody
201201 (p_rdrName name)
202− (p_pat <$> m_pats)
202+ (located' p_pat <$> m_pats)
203203 PatternBind -> stdCase
204204 Case -> stdCase
205205 Lambda -> do
@@ -212,41 +212,32 @@ p_match' placer render style isInfix strictness m_pats m_grhss = do
212212 when needsSpace space
213213 sitcc stdCase
214214 LambdaCase -> stdCase
215− return inci'
215+ return indentBody
216216 let -- Calculate position of end of patterns. This is useful when we decide
217217 -- about putting certain constructions in hanging positions.
218218 endOfPats = case NE.nonEmpty m_pats of
219219 Nothing -> case style of
220− Function name -> (Just . srcSpanEnd . getLoc) name
220+ Function name -> Just (getLoc name)
221221 _ -> Nothing
222− Just pats -> (Just . srcSpanEnd . getLoc . NE.last) pats
222+ Just pats -> (Just . getLoc . NE.last) pats
223223 isCase = \case
224224 Case -> True
225225 LambdaCase -> True
226226 _ -> False
227− let GRHSs {..} = m_grhss
228227 hasGuards = withGuards grhssGRHSs
229− unless (length grhssGRHSs > 1) $ do
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 =
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,10 +253,18 @@ p_match' placer render style isInfix strictness m_pats m_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
267+p_match' _ _ _ _ _ _ (XGRHSs x) = noExtCon x
269268
270269p_grhs :: GroupStyle -> GRHS GhcPs (LHsExpr GhcPs) -> R ()
271270p_grhs = p_grhs' exprPlacement p_hsExpr
@@ -279,79 +278,109 @@ p_grhs' ::
279278 GroupStyle ->
280279 GRHS GhcPs (Located body) ->
281280 R ()
282−p_grhs' placer render style (GRHS NoExt guards body) =
281+p_grhs' placer render style (GRHS NoExtField guards body) =
283282 case guards of
284283 [] -> p_body
285284 xs -> do
286285 txt "|"
287286 space
288− sitcc (sep (comma >> breakpoint) (sitcc . located' p_stmt) xs)
287+ sitcc (sep commaDel (sitcc . located' p_stmt) xs)
289288 space
290− txt $ case style of
291− EqualSign -> "="
292− RightArrow -> "->"
289+ inci $ case style of
290+ EqualSign -> equals
291+ RightArrow -> txt "->"
293292 placeHanging placement p_body
294293 where
295294 placement =
296295 case endOfGuards of
297296 Nothing -> placer (unLoc body)
298297 Just spn ->
299− if isOneLineSpan (mkSrcSpan spn (srcSpanStart (getLoc body)))
298+ if onTheSameLine spn (getLoc body)
300299 then placer (unLoc body)
301300 else Normal
302301 endOfGuards =
303302 case NE.nonEmpty guards of
304303 Nothing -> Nothing
305− Just gs -> (Just . srcSpanEnd . getLoc . NE.last) gs
304+ Just gs -> (Just . getLoc . NE.last) gs
306305 p_body = located body render
307−p_grhs' _ _ _ (XGRHS NoExt) = notImplemented "XGRHS"
306+p_grhs' _ _ _ (XGRHS x) = noExtCon x
308307
309308p_hsCmd :: HsCmd GhcPs -> R ()
310309p_hsCmd = \case
311− HsCmdArrApp NoExt body input arrType _ -> do
310+ HsCmdArrApp NoExtField body input arrType _ -> do
312311 located body p_hsExpr
313− space
314− case arrType of
315− HsFirstOrderApp -> txt "-<"
316− HsHigherOrderApp -> txt "-<<"
317− placeHanging (exprPlacement (unLoc input)) $
318− located input p_hsExpr
319− 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
320320 located form p_hsExpr
321321 unless (null cmds) $ do
322322 breakpoint
323323 inci (sequence_ (intersperse breakpoint (located' p_hsCmdTop <$> cmds)))
324− HsCmdArrForm NoExt form Infix _ [left, right] -> do
324+ HsCmdArrForm NoExtField form Infix _ [left, right] -> do
325325 located left p_hsCmdTop
326326 space
327327 located form p_hsExpr
328328 placeHanging (cmdTopPlacement (unLoc right)) $
329329 located right p_hsCmdTop
330− HsCmdArrForm NoExt _ Infix _ _ -> notImplemented "HsCmdArrForm"
330+ HsCmdArrForm NoExtField _ Infix _ _ -> notImplemented "HsCmdArrForm"
331331 HsCmdApp {} ->
332332 -- XXX Does this ever occur in the syntax tree? It does not seem like it
333333 -- does. Open an issue and ping @yumiova if this ever occurs in output.
334334 notImplemented "HsCmdApp"
335− HsCmdLam NoExt mgroup -> p_matchGroup' cmdPlacement p_hsCmd Lambda mgroup
336− HsCmdPar NoExt c -> parens N (located c p_hsCmd)
337− 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 ->
338338 p_case cmdPlacement p_hsCmd e mgroup
339− HsCmdIf NoExt _ if' then' else' ->
339+ HsCmdIf NoExtField _ if' then' else' ->
340340 p_if cmdPlacement p_hsCmd if' then' else'
341− HsCmdLet NoExt localBinds c ->
341+ HsCmdLet NoExtField localBinds c ->
342342 p_let p_hsCmd localBinds c
343− HsCmdDo NoExt es -> do
343+ HsCmdDo NoExtField es -> do
344344 txt "do"
345345 newline
346346 inci . located es $
347− sitcc . sep newline (located' (sitcc . p_stmt' cmdPlacement p_hsCmd))
347+ sitcc . sep newline (sitcc . withSpacing (p_stmt' cmdPlacement p_hsCmd))
348348 HsCmdWrap {} -> notImplemented "HsCmdWrap"
349− XCmd {} -> notImplemented "XCmd"
349+ XCmd x -> noExtCon x
350350
351351p_hsCmdTop :: HsCmdTop GhcPs -> R ()
352352p_hsCmdTop = \case
353− HsCmdTop NoExt cmd -> located cmd p_hsCmd
354− 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)
355384
356385p_stmt :: Stmt GhcPs (LHsExpr GhcPs) -> R ()
357386p_stmt = p_stmt' exprPlacement p_hsExpr
@@ -366,16 +395,13 @@ p_stmt' ::
366395 Stmt GhcPs (Located body) ->
367396 R ()
368397p_stmt' placer render = \case
369− LastStmt NoExt body _ _ -> located body render
370− BindStmt NoExt p f _ _ -> do
371− p_pat p
398+ LastStmt NoExtField body _ _ -> located body render
399+ BindStmt NoExtField p f _ _ -> do
400+ located p p_pat
372401 space
373402 txt "<-"
374− -- https://gitlab.haskell.org/ghc/ghc/issues/17330
375− let loc = case p of
376− XPat pat -> getLoc pat
377− _ -> error "p_stmt': BindStmt: Pat does not contain a location"
378− let placement =
403+ let loc = getLoc p
404+ placement =
379405 case f of
380406 L l' x ->
381407 if isOneLineSpan
@@ -385,20 +411,20 @@ p_stmt' placer render = \case
385411 switchLayout [loc, getLoc f] $
386412 placeHanging placement (located f render)
387413 ApplicativeStmt {} -> notImplemented "ApplicativeStmt" -- generated by renamer
388− BodyStmt NoExt body _ _ -> located body render
389− LetStmt NoExt binds -> do
414+ BodyStmt NoExtField body _ _ -> located body render
415+ LetStmt NoExtField binds -> do
390416 txt "let"
391417 space
392418 sitcc $ located binds p_hsLocalBinds
393419 ParStmt {} ->
394− -- NOTE 'ParStmt' should always be eliminated in 'gatherStmt' already,
395− -- such that it never occurs in 'p_stmt''. Consequently, handling it
396− -- 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.
397423 notImplemented "ParStmt"
398− TransStmt {..} -> do
399− -- NOTE 'TransStmt' only needs to account for render printing itself,
400− -- since pretty printing of relevant statements (e.g., in 'trS_stmts')
401− -- is handled through 'gatherStmt'.
424+ TransStmt {..} ->
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'.
402428 case (trS_form, trS_by) of
403429 (ThenForm, Nothing) -> do
404430 txt "then"
@@ -427,11 +453,11 @@ p_stmt' placer render = \case
427453 RecStmt {..} -> do
428454 txt "rec"
429455 space
430− sitcc $ sepSemi (located' (p_stmt' placer render)) recS_stmts
431− XStmtLR {} -> notImplemented "XStmtLR"
456+ sitcc $ sepSemi (withSpacing (p_stmt' placer render)) recS_stmts
457+ XStmtLR c -> noExtCon c
432458
433459gatherStmt :: ExprLStmt GhcPs -> [[ExprLStmt GhcPs]]
434−gatherStmt (L _ (ParStmt NoExt block _ _)) =
460+gatherStmt (L _ (ParStmt NoExtField block _ _)) =
435461 foldr ((<>) . gatherStmtBlock) [] block
436462gatherStmt (L s stmt@TransStmt {..}) =
437463 foldr liftAppend [] ((gatherStmt <$> trS_stmts) <> pure [[L s stmt]])
@@ -440,96 +466,93 @@ gatherStmt stmt = [[stmt]]
440466gatherStmtBlock :: ParStmtBlock GhcPs GhcPs -> [[ExprLStmt GhcPs]]
441467gatherStmtBlock (ParStmtBlock _ stmts _ _) =
442468 foldr (liftAppend . gatherStmt) [] stmts
443−gatherStmtBlock XParStmtBlock {} = notImplemented "XParStmtBlock"
469+gatherStmtBlock (XParStmtBlock x) = noExtCon x
444470
445471p_hsLocalBinds :: HsLocalBindsLR GhcPs GhcPs -> R ()
446472p_hsLocalBinds = \case
447− HsValBinds NoExt (ValBinds NoExt bag lsigs) -> do
448− let ssStart =
449− either
450− (srcSpanStart . getLoc)
451− (srcSpanStart . getLoc)
452− items =
453− (Left <$> bagToList bag) ++ (Right <$> lsigs)
454− p_item (Left x) = located x p_valDecl
455− p_item (Right x) = located x p_sigDecl
456− -- Assigns 'False' to the last element, 'True' to the rest.
457− markInit :: [a] -> [(Bool, a)]
458− markInit [] = []
459− markInit (x : []) = [(False, x)]
460− markInit (x : xs) = (True, x) : markInit xs
461− -- 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
462475 -- elements will also contain semicolons and they will confuse the
463476 -- parser. so we request braces around every element except the last.
464477 br <- layoutToBraces <$> getLayout
465− sitcc $
466− sepSemi
467− (\(m, i) -> (if m then br else id) $ p_item i)
468− (markInit $ sortOn ssStart items)
469− HsValBinds NoExt _ -> notImplemented "HsValBinds"
470− 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) ->
471494 -- Second argument of IPBind is always Left before type-checking.
472− let p_ipBind (IPBind NoExt (Left name) expr) = do
495+ let p_ipBind (IPBind NoExtField (Left name) expr) = do
473496 atom name
474497 space
475− txt "="
498+ equals
476499 breakpoint
477500 useBraces $ inci $ located expr p_hsExpr
478− 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
479505 in sepSemi (located' p_ipBind) xs
480− HsIPBinds NoExt _ -> notImplemented "HsIpBinds"
481− EmptyLocalBinds NoExt -> return ()
482− XHsLocalBindsLR _ -> notImplemented "XHsLocalBindsLR"
506+ HsIPBinds NoExtField _ -> notImplemented "HsIpBinds"
507+ EmptyLocalBinds NoExtField -> return ()
508+ XHsLocalBindsLR x -> noExtCon x
483509
484510p_hsRecField ::
485511 HsRecField' RdrName (LHsExpr GhcPs) ->
486512 R ()
487−p_hsRecField = \HsRecField {..} -> do
513+p_hsRecField HsRecField {..} = do
488514 p_rdrName hsRecFieldLbl
489515 unless hsRecPun $ do
490516 space
491− txt "="
492− let placement = exprPlacement (unLoc hsRecFieldArg)
493− placeHanging placement $ located hsRecFieldArg p_hsExpr
494−
495−p_hsTupArg :: HsTupArg GhcPs -> R ()
496−p_hsTupArg = \case
497− Present NoExt x -> located x p_hsExpr
498− Missing NoExt -> pure ()
499− 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)
500523
501524p_hsExpr :: HsExpr GhcPs -> R ()
502525p_hsExpr = p_hsExpr' N
503526
504527p_hsExpr' :: BracketStyle -> HsExpr GhcPs -> R ()
505528p_hsExpr' s = \case
506− HsVar NoExt name -> p_rdrName name
507− HsUnboundVar NoExt _ -> notImplemented "HsUnboundVar"
508− HsConLikeOut NoExt _ -> notImplemented "HsConLikeOut"
509− 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 ->
510533 case x of
511− Unambiguous NoExt name -> p_rdrName name
512− Ambiguous NoExt name -> p_rdrName name
513− XAmbiguousFieldOcc NoExt -> notImplemented "XAmbiguousFieldOcc"
514− 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
515538 txt "#"
516539 atom v
517− HsIPVar NoExt (HsIPName name) -> do
540+ HsIPVar NoExtField (HsIPName name) -> do
518541 txt "?"
519542 atom name
520− HsOverLit NoExt v -> atom (ol_val v)
521− HsLit NoExt lit ->
543+ HsOverLit NoExtField v -> atom (ol_val v)
544+ HsLit NoExtField lit ->
522545 case lit of
523546 HsString (SourceText stxt) _ -> p_stringLit stxt
524547 HsStringPrim (SourceText stxt) _ -> p_stringLit stxt
525548 r -> atom r
526− HsLam NoExt mgroup ->
549+ HsLam NoExtField mgroup ->
527550 p_matchGroup Lambda mgroup
528− HsLamCase NoExt mgroup -> do
551+ HsLamCase NoExtField mgroup -> do
529552 txt "\\case"
530553 breakpoint
531554 inci (p_matchGroup LambdaCase mgroup)
532− HsApp NoExt f x -> do
555+ HsApp NoExtField f x -> do
533556 let -- In order to format function applications with multiple parameters
534557 -- nicer, traverse the AST to gather the function and all the
535558 -- parameters together.
@@ -541,8 +564,10 @@ p_hsExpr' s = \case
541564 -- We need to handle the last argument specially if it is a
542565 -- hanging construct, so separate it from the rest.
543566 (initp, lastp) = (NE.init args, NE.last args)
544− initSpan = combineSrcSpans' $ getLoc f :| map getLoc initp
545− -- 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
546571 -- line.
547572 placement =
548573 if isOneLineSpan initSpan
@@ -554,11 +579,26 @@ p_hsExpr' s = \case
554579 -- one.
555580 case placement of
556581 Normal -> do
557− 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
558598 located func (p_hsExpr' s)
559599 breakpoint
560− inci $ sep breakpoint (located' p_hsExpr) initp
561− inci $ do
600+ inciIf doIndent $ sep breakpoint (located' p_hsExpr) initp
601+ inciIf doIndent $ do
562602 unless (null initp) breakpoint
563603 located lastp p_hsExpr
564604 Hanging -> do
@@ -568,75 +608,87 @@ p_hsExpr' s = \case
568608 sep breakpoint (located' p_hsExpr) initp
569609 placeHanging placement $
570610 located lastp p_hsExpr
571− HsAppType NoExt e a -> do
611+ HsAppType NoExtField e a -> do
572612 located e p_hsExpr
573613 breakpoint
574614 inci $ do
575615 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 ()
576621 located (hswc_body a) p_hsType
577− OpApp NoExt x op y -> do
622+ OpApp NoExtField x op y -> do
578623 let opTree = OpBranch (exprOpTree x) op (exprOpTree y)
579− p_exprOpTree True s (reassociateOpTree getOpName opTree)
580− NegApp NoExt e _ -> do
624+ p_exprOpTree s (reassociateOpTree getOpName opTree)
625+ NegApp NoExtField e _ -> do
581626 txt "-"
582627 space
583628 located e p_hsExpr
584− HsPar NoExt e ->
629+ HsPar NoExtField e ->
585630 parens s (located e (dontUseBraces . p_hsExpr))
586− SectionL NoExt x op -> do
631+ SectionL NoExtField x op -> do
587632 located x p_hsExpr
588633 breakpoint
589634 inci (located op p_hsExpr)
590− SectionR NoExt op x -> do
635+ SectionR NoExtField op x -> do
591636 located op p_hsExpr
592− breakpoint
637+ useRecordDot' <- useRecordDot
638+ let isRecordDot' = isRecordDot (unLoc op) (getLoc x)
639+ unless (useRecordDot' && isRecordDot') breakpoint
593640 inci (located x p_hsExpr)
594− ExplicitTuple NoExt args boxity -> do
641+ ExplicitTuple NoExtField args boxity ->
595642 let isSection = any (isMissing . unLoc) args
596643 isMissing = \case
597− Missing NoExt -> True
644+ Missing NoExtField -> True
598645 _ -> False
599− 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' =
600652 case boxity of
601653 Boxed -> parens
602654 Unboxed -> parensHash
603− if isSection
604− then
605− switchLayout [] . parens' s $
606− sep comma (located' p_hsTupArg) args
607− else
608− switchLayout (getLoc <$> args) . parens' s . sitcc $
609− sep (comma >> breakpoint) (sitcc . located' p_hsTupArg) args
610− 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 ->
611663 p_unboxedSum N tag arity (located e p_hsExpr)
612− HsCase NoExt e mgroup ->
664+ HsCase NoExtField e mgroup ->
613665 p_case exprPlacement p_hsExpr e mgroup
614− HsIf NoExt _ if' then' else' ->
666+ HsIf NoExtField _ if' then' else' ->
615667 p_if exprPlacement p_hsExpr if' then' else'
616− HsMultiIf NoExt guards -> do
668+ HsMultiIf NoExtField guards -> do
617669 txt "if"
618670 breakpoint
619− inci . sitcc $ sep newline (located' (p_grhs RightArrow)) guards
620− HsLet NoExt localBinds e ->
671+ inci . inci $ sep newline (located' (p_grhs RightArrow)) guards
672+ HsLet NoExtField localBinds e ->
621673 p_let p_hsExpr localBinds e
622− HsDo NoExt ctx es -> do
674+ HsDo NoExtField ctx es -> do
623675 let doBody header = do
624676 txt header
625677 breakpoint
626678 ub <- layoutToBraces <$> getLayout
627679 inci $
628680 sepSemi
629− (located' (ub . p_stmt' exprPlacement (p_hsExpr' S)))
681+ (ub . withSpacing (p_stmt' exprPlacement (p_hsExpr' S)))
630682 (unLoc es)
631− compBody = brackets N $ located es $ \xs -> do
683+ compBody = brackets N . located es $ \xs -> do
632684 let p_parBody =
633685 sep
634− (breakpoint >> txt "| ")
686+ (breakpoint >> txt "|" >> space)
635687 p_seqBody
636688 p_seqBody =
637689 sitcc
638690 . sep
639− (comma >> breakpoint)
691+ commaDel
640692 (located' (sitcc . p_stmt))
641693 stmts = init xs
642694 yield = last xs
@@ -657,90 +709,96 @@ p_hsExpr' s = \case
657709 ParStmtCtxt _ -> notImplemented "ParStmtCtxt"
658710 TransStmtCtxt _ -> notImplemented "TransStmtCtxt"
659711 ExplicitList _ _ xs ->
660− brackets s . sitcc $
661− sep (comma >> breakpoint) (sitcc . located' p_hsExpr) xs
712+ brackets s $
713+ sep commaDel (sitcc . located' p_hsExpr) xs
662714 RecordCon {..} -> do
663715 located rcon_con_name atom
664716 breakpoint
665717 let HsRecFields {..} = rcon_flds
666718 updName f =
667− f
719+ (f :: HsRecField GhcPs (LHsExpr GhcPs))
668720 { hsRecFieldLbl = case unLoc $ hsRecFieldLbl f of
669721 FieldOcc _ n -> n
670− XFieldOcc _ -> notImplemented "XFieldOcc"
722+ XFieldOcc x -> noExtCon x
671723 }
672724 fields = located' (p_hsRecField . updName) <$> rec_flds
673725 dotdot =
674726 case rec_dotdot of
675727 Just {} -> [txt ".."]
676728 Nothing -> []
677− inci . braces N . sitcc $
678− sep (comma >> breakpoint) sitcc (fields <> dotdot)
729+ inci . braces N $
730+ sep commaDel sitcc (fields <> dotdot)
679731 RecordUpd {..} -> do
680732 located rupd_expr p_hsExpr
681− 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
682741 let updName f =
683− f
742+ (f :: HsRecUpdField GhcPs)
684743 { hsRecFieldLbl = case unLoc $ hsRecFieldLbl f of
685744 Ambiguous _ n -> n
686745 Unambiguous _ n -> n
687− XAmbiguousFieldOcc _ -> notImplemented "XAmbiguousFieldOcc"
746+ XAmbiguousFieldOcc x -> noExtCon x
688747 }
689− inci . braces N . sitcc $
748+ inci . braces N $
690749 sep
691− (comma >> breakpoint)
750+ commaDel
692751 (sitcc . located' (p_hsRecField . updName))
693752 rupd_flds
694− ExprWithTySig NoExt x affix -> sitcc $ do
753+ ExprWithTySig NoExtField x HsWC {hswc_body = HsIB {..}} -> sitcc $ do
695754 located x p_hsExpr
696755 space
697756 txt "::"
698757 breakpoint
699− inci $ do
700− let HsWC {..} = affix
701− HsIB {..} = hswc_body
702− located hsib_body p_hsType
703− ArithSeq NoExt _ x -> do
758+ inci $ located hsib_body p_hsType
759+ ExprWithTySig NoExtField _ HsWC {hswc_body = XHsImplicitBndrs x} -> noExtCon x
760+ ExprWithTySig NoExtField _ (XHsWildCardBndrs x) -> noExtCon x
761+ ArithSeq NoExtField _ x ->
704762 case x of
705− From from -> brackets s . sitcc $ do
763+ From from -> brackets s $ do
706764 located from p_hsExpr
707765 breakpoint
708766 txt ".."
709− FromThen from next -> brackets s . sitcc $ do
710− sitcc $ sep (comma >> breakpoint) (located' p_hsExpr) [from, next]
767+ FromThen from next -> brackets s $ do
768+ sep commaDel (located' p_hsExpr) [from, next]
711769 breakpoint
712770 txt ".."
713− FromTo from to -> brackets s . sitcc $ do
771+ FromTo from to -> brackets s $ do
714772 located from p_hsExpr
715773 breakpoint
716774 txt ".."
717775 space
718776 located to p_hsExpr
719− FromThenTo from next to -> brackets s . sitcc $ do
720− 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]
721779 breakpoint
722780 txt ".."
723781 space
724782 located to p_hsExpr
725− HsSCC NoExt _ name x -> do
783+ HsSCC NoExtField _ name x -> do
726784 txt "{-# SCC "
727785 atom name
728786 txt " #-}"
729787 breakpoint
730788 located x p_hsExpr
731− HsCoreAnn NoExt _ value x -> do
789+ HsCoreAnn NoExtField _ value x -> do
732790 txt "{-# CORE "
733791 atom value
734792 txt " #-}"
735793 breakpoint
736794 located x p_hsExpr
737− HsBracket NoExt x -> p_hsBracket x
795+ HsBracket NoExtField x -> p_hsBracket x
738796 HsRnBracketOut {} -> notImplemented "HsRnBracketOut"
739797 HsTcBracketOut {} -> notImplemented "HsTcBracketOut"
740− HsSpliceE NoExt splice -> p_hsSplice splice
741− HsProc NoExt p e -> do
798+ HsSpliceE NoExtField splice -> p_hsSplice splice
799+ HsProc NoExtField p e -> do
742800 txt "proc"
743− locatedPat p $ \x -> do
801+ located p $ \x -> do
744802 breakpoint
745803 inci (p_pat x)
746804 breakpoint
@@ -751,31 +809,11 @@ p_hsExpr' s = \case
751809 txt "static"
752810 breakpoint
753811 inci (located e p_hsExpr)
754− HsArrApp NoExt body input arrType cond ->
755− p_hsCmd (HsCmdArrApp NoExt body input arrType cond)
756− HsArrForm NoExt form mfixity cmds ->
757− p_hsCmd (HsCmdArrForm NoExt form Prefix mfixity cmds)
758812 HsTick {} -> notImplemented "HsTick"
759813 HsBinTick {} -> notImplemented "HsBinTick"
760814 HsTickPragma {} -> notImplemented "HsTickPragma"
761− -- These four constructs should never appear in correct programs.
762− -- See: https://github.com/tweag/ormolu/issues/343
763− EWildPat NoExt -> txt "_"
764− EAsPat NoExt n p -> do
765− p_rdrName n
766− txt "@"
767− located p p_hsExpr
768− EViewPat NoExt p e -> do
769− located p p_hsExpr
770− space
771− txt "->"
772− breakpoint
773− inci (located e p_hsExpr)
774− ELazyPat NoExt p -> do
775− txt "~"
776− located p p_hsExpr
777815 HsWrap {} -> notImplemented "HsWrap"
778− XExpr {} -> notImplemented "XExpr"
816+ XExpr x -> noExtCon x
779817
780818p_patSynBind :: PatSynBind GhcPs GhcPs -> R ()
781819p_patSynBind PSB {..} = do
@@ -785,15 +823,15 @@ p_patSynBind PSB {..} = do
785823 Unidirectional -> do
786824 txt "<-"
787825 breakpoint
788− p_pat psb_def
826+ located psb_def p_pat
789827 ImplicitBidirectional -> do
790− txt "="
828+ equals
791829 breakpoint
792− p_pat psb_def
830+ located psb_def p_pat
793831 ExplicitBidirectional mgroup -> do
794832 txt "<-"
795833 breakpoint
796− p_pat psb_def
834+ located psb_def p_pat
797835 newline
798836 txt "where"
799837 newline
@@ -814,8 +852,8 @@ p_patSynBind PSB {..} = do
814852 inci $ do
815853 switchLayout (getLoc . recordPatSynPatVar <$> xs) $ do
816854 unless (null xs) breakpoint
817− braces N . sitcc $
818− sep (comma >> breakpoint) (p_rdrName . recordPatSynPatVar) xs
855+ braces N $
856+ sep commaDel (p_rdrName . recordPatSynPatVar) xs
819857 rhs
820858 InfixCon l r -> do
821859 switchLayout [getLoc l, getLoc r] $ do
@@ -827,7 +865,7 @@ p_patSynBind PSB {..} = do
827865 space
828866 p_rdrName r
829867 inci rhs
830−p_patSynBind (XPatSynBind NoExt) = notImplemented "XPatSynBind"
868+p_patSynBind (XPatSynBind x) = noExtCon x
831869
832870p_case ::
833871 Data body =>
@@ -838,7 +876,7 @@ p_case ::
838876 -- | Expression
839877 LHsExpr GhcPs ->
840878 -- | Match group
841− (MatchGroup GhcPs (Located body)) ->
879+ MatchGroup GhcPs (Located body) ->
842880 R ()
843881p_case placer render e mgroup = do
844882 txt "case"
@@ -869,10 +907,12 @@ p_if placer render if' then' else' = do
869907 breakpoint
870908 inci $ do
871909 txt "then"
910+ space
872911 located then' $ \x ->
873912 placeHanging (placer x) (render x)
874913 breakpoint
875914 txt "else"
915+ space
876916 located else' $ \x ->
877917 placeHanging (placer x) (render x)
878918
@@ -894,77 +934,77 @@ p_let render localBinds e = sitcc $ do
894934
895935p_pat :: Pat GhcPs -> R ()
896936p_pat = \case
897− -- Note: starting from GHC 8.8, 'LPat' == 'Pat'. Located 'Pat's are always
898− -- constructed with the 'XPat' constructor, containing a @Located Pat@.
899− XPat pat -> located pat p_pat
900− WildPat NoExt -> txt "_"
901− VarPat NoExt name -> p_rdrName name
902− LazyPat NoExt pat -> do
937+ WildPat NoExtField -> txt "_"
938+ VarPat NoExtField name -> p_rdrName name
939+ LazyPat NoExtField pat -> do
903940 txt "~"
904− p_pat pat
905− AsPat NoExt name pat -> do
941+ located pat p_pat
942+ AsPat NoExtField name pat -> do
906943 p_rdrName name
907944 txt "@"
908− p_pat pat
909− ParPat NoExt pat ->
910− locatedPat pat (parens S . p_pat)
911− 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
912949 txt "!"
913− p_pat pat
914− ListPat NoExt pats -> do
915− brackets S . sitcc $ sep (comma >> breakpoint) p_pat pats
916− TuplePat NoExt pats boxing -> do
917− 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' =
918955 case boxing of
919956 Boxed -> parens S
920957 Unboxed -> parensHash S
921− f . sitcc $ sep (comma >> breakpoint) (sitcc . p_pat) pats
922− SumPat NoExt pat tag arity ->
923− 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)
924961 ConPatIn pat details ->
925962 case details of
926963 PrefixCon xs -> sitcc $ do
927964 p_rdrName pat
928965 unless (null xs) $ do
929966 breakpoint
930− inci . sitcc $ sep breakpoint (sitcc . p_pat) xs
967+ inci . sitcc $ sep breakpoint (sitcc . located' p_pat) xs
931968 RecCon (HsRecFields fields dotdot) -> do
932969 p_rdrName pat
933970 breakpoint
934971 let f = \case
935972 Nothing -> txt ".."
936973 Just x -> located x p_pat_hsRecField
937− inci . braces N . sitcc . sep (comma >> breakpoint) f $
974+ inci . braces N . sep commaDel f $
938975 case dotdot of
939976 Nothing -> Just <$> fields
940− Just n -> (Just <$> take n fields) ++ [Nothing]
941− InfixCon x y -> do
942− p_pat x
943− space
944− p_rdrName pat
945− breakpoint
946− 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
947986 ConPatOut {} -> notImplemented "ConPatOut" -- presumably created by renamer?
948− ViewPat NoExt expr pat -> sitcc $ do
987+ ViewPat NoExtField expr pat -> sitcc $ do
949988 located expr p_hsExpr
950989 space
951990 txt "->"
952991 breakpoint
953− inci (p_pat pat)
954− SplicePat NoExt splice -> p_hsSplice splice
955− LitPat NoExt p -> atom p
956− NPat NoExt v _ _ -> located v (atom . ol_val)
957− 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
958997 p_rdrName n
959998 breakpoint
960999 inci $ do
9611000 txt "+"
9621001 space
9631002 located k (atom . ol_val)
964− SigPat NoExt pat hswc -> do
965− p_pat pat
1003+ SigPat NoExtField pat hswc -> do
1004+ located pat p_pat
9661005 p_typeAscription hswc
9671006 CoPat {} -> notImplemented "CoPat" -- apparently created at some later stage
1007+ XPat x -> noExtCon x
9681008
9691009p_pat_hsRecField :: HsRecField' (FieldOcc GhcPs) (LPat GhcPs) -> R ()
9701010p_pat_hsRecField HsRecField {..} = do
@@ -972,42 +1012,40 @@ p_pat_hsRecField HsRecField {..} = do
9721012 p_rdrName (rdrNameFieldOcc x)
9731013 unless hsRecPun $ do
9741014 space
975− txt "="
1015+ equals
9761016 breakpoint
977− inci (p_pat hsRecFieldArg)
1017+ inci (located hsRecFieldArg p_pat)
9781018
9791019p_unboxedSum :: BracketStyle -> ConTag -> Arity -> R () -> R ()
9801020p_unboxedSum s tag arity m = do
9811021 let before = tag - 1
9821022 after = arity - before - 1
9831023 args = replicate before Nothing <> [Just m] <> replicate after Nothing
984− f (x, i) = do
985− let isFirst = i == 0
986− isLast = i == arity - 1
1024+ f x =
9871025 case x :: Maybe (R ()) of
9881026 Nothing ->
989− unless (isFirst || isLast) space
1027+ space
9901028 Just m' -> do
991− unless isFirst space
1029+ space
9921030 m'
993− unless isLast space
994− parensHash s $ sep (txt "|") f (zip args [0 ..])
1031+ space
1032+ parensHash s $ sep (txt "|") f args
9951033
9961034p_hsSplice :: HsSplice GhcPs -> R ()
9971035p_hsSplice = \case
998− HsTypedSplice NoExt deco _ expr -> p_hsSpliceTH True expr deco
999− HsUntypedSplice NoExt deco _ expr -> p_hsSpliceTH False expr deco
1000− 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
10011039 txt "["
10021040 p_rdrName (L srcSpan quoterName)
10031041 txt "|"
1004− -- NOTE QuasiQuoters often rely on precise custom strings. We cannot do
1005− -- 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.
10061044 atom str
10071045 txt "|]"
10081046 HsSpliced {} -> notImplemented "HsSpliced"
10091047 HsSplicedT {} -> notImplemented "HsSplicedT"
1010− XSplice {} -> notImplemented "XSplice"
1048+ XSplice x -> noExtCon x
10111049
10121050p_hsSpliceTH ::
10131051 -- | Typed splice?
@@ -1031,17 +1069,17 @@ p_hsSpliceTH isTyped expr = \case
10311069
10321070p_hsBracket :: HsBracket GhcPs -> R ()
10331071p_hsBracket = \case
1034− ExpBr NoExt expr -> do
1072+ ExpBr NoExtField expr -> do
10351073 anns <- getEnclosingAnns
10361074 let name = case anns of
10371075 AnnOpenEQ : _ -> ""
10381076 _ -> "e"
10391077 quote name (located expr p_hsExpr)
1040− PatBr NoExt pat -> quote "p" (p_pat pat)
1041− DecBrL NoExt decls -> quote "d" (p_hsDecls Free decls)
1042− DecBrG NoExt _ -> notImplemented "DecBrG" -- result of renamer
1043− TypBr NoExt ty -> quote "t" (located ty p_hsType)
1044− 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
10451083 txt (bool "''" "'" isSingleQuote)
10461084 -- HACK As you can see we use 'noLoc' here to be able to pass name into
10471085 -- 'p_rdrName' since the latter expects a "located" thing. The problem
@@ -1056,13 +1094,13 @@ p_hsBracket = \case
10561094 && not (doesNotNeedExtraParens name)
10571095 wrapper = if isOperator then parens N else id
10581096 wrapper $ p_rdrName (noLoc name)
1059− TExpBr NoExt expr -> do
1097+ TExpBr NoExtField expr -> do
10601098 txt "[||"
10611099 breakpoint'
10621100 located expr p_hsExpr
10631101 breakpoint'
10641102 txt "||]"
1065− XBracket {} -> notImplemented "XBracket"
1103+ XBracket x -> noExtCon x
10661104 where
10671105 quote :: Text -> R () -> R ()
10681106 quote name body = do
@@ -1141,9 +1179,9 @@ liftAppend (x : xs) [] = x : xs
11411179liftAppend (x : xs) (y : ys) = x <> y : liftAppend xs ys
11421180
11431181getGRHSSpan :: GRHS GhcPs (Located body) -> SrcSpan
1144−getGRHSSpan (GRHS NoExt guards body) =
1182+getGRHSSpan (GRHS NoExtField guards body) =
11451183 combineSrcSpans' $ getLoc body :| map getLoc guards
1146−getGRHSSpan (XGRHS NoExt) = notImplemented "XGRHS"
1184+getGRHSSpan (XGRHS x) = noExtCon x
11471185
11481186-- | Place a thing that may have a hanging form. This function handles how
11491187-- to separate it from preceding expressions and whether to bump indentation
@@ -1164,82 +1202,77 @@ blockPlacement ::
11641202 (body -> Placement) ->
11651203 [LGRHS GhcPs (Located body)] ->
11661204 Placement
1167−blockPlacement placer [(L _ (GRHS NoExt _ (L _ x)))] = placer x
1205+blockPlacement placer [L _ (GRHS NoExtField _ (L _ x))] = placer x
11681206blockPlacement _ _ = Normal
11691207
11701208-- | Check if given command has a hanging form.
11711209cmdPlacement :: HsCmd GhcPs -> Placement
11721210cmdPlacement = \case
1173− HsCmdLam NoExt _ -> Hanging
1174− HsCmdCase NoExt _ _ -> Hanging
1175− HsCmdDo NoExt _ -> Hanging
1211+ HsCmdLam NoExtField _ -> Hanging
1212+ HsCmdCase NoExtField _ _ -> Hanging
1213+ HsCmdDo NoExtField _ -> Hanging
11761214 _ -> Normal
11771215
11781216cmdTopPlacement :: HsCmdTop GhcPs -> Placement
11791217cmdTopPlacement = \case
1180− HsCmdTop NoExt (L _ x) -> cmdPlacement x
1181− XCmdTop {} -> notImplemented "XCmdTop"
1218+ HsCmdTop NoExtField (L _ x) -> cmdPlacement x
1219+ XCmdTop x -> noExtCon x
11821220
11831221-- | Check if given expression has a hanging form.
11841222exprPlacement :: HsExpr GhcPs -> Placement
11851223exprPlacement = \case
11861224 -- Only hang lambdas with single line parameter lists
1187− HsLam NoExt mg -> case mg of
1188− MG _ (L _ [L _ (Match NoExt _ (x : xs) _)]) _
1225+ HsLam NoExtField mg -> case mg of
1226+ MG _ (L _ [L _ (Match NoExtField _ (x : xs) _)]) _
11891227 | isOneLineSpan (combineSrcSpans' $ fmap getLoc (x :| xs)) ->
11901228 Hanging
11911229 _ -> Normal
1192− HsLamCase NoExt _ -> Hanging
1193− HsCase NoExt _ _ -> Hanging
1194− HsDo NoExt DoExpr _ -> Hanging
1195− HsDo NoExt MDoExpr _ -> Hanging
1196− RecordCon NoExt _ _ -> Hanging
1197− -- If the rightmost expression in an operator chain is hanging, make the
1198− -- whole block hanging; so that we can use the common @f = foo $ do@
1199− -- style.
1200− OpApp NoExt _ _ y -> exprPlacement (unLoc y)
1201− -- Same thing for function applications (usually with -XBlockArguments)
1202− HsApp NoExt _ y -> exprPlacement (unLoc y)
1203− HsProc NoExt p _ ->
1204− -- https://gitlab.haskell.org/ghc/ghc/issues/17330
1205− let loc = case p of
1206− XPat pat -> getLoc pat
1207− _ -> error "exprPlacement: HsProc: Pat does not contain a location"
1208− in -- Indentation breaks if pattern is longer than one line and left
1209− -- hanging. Consequently, only apply hanging when it is safe.
1210− if isOneLineSpan loc
1211− then Hanging
1212− 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
12131245 _ -> Normal
12141246
12151247withGuards :: [LGRHS GhcPs (Located body)] -> Bool
12161248withGuards = any (checkOne . unLoc)
12171249 where
12181250 checkOne :: GRHS GhcPs (Located body) -> Bool
1219− checkOne (GRHS NoExt [] _) = False
1251+ checkOne (GRHS NoExtField [] _) = False
12201252 checkOne _ = True
12211253
12221254exprOpTree :: LHsExpr GhcPs -> OpTree (LHsExpr GhcPs) (LHsExpr GhcPs)
1223−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)
12241256exprOpTree n = OpNode n
12251257
12261258getOpName :: HsExpr GhcPs -> Maybe RdrName
12271259getOpName = \case
1228− HsVar NoExt (L _ a) -> Just a
1260+ HsVar NoExtField (L _ a) -> Just a
12291261 _ -> Nothing
12301262
1263+getOpNameStr :: RdrName -> String
1264+getOpNameStr = occNameString . rdrNameOcc
1265+
12311266p_exprOpTree ::
1232− -- | Can use special handling of dollar?
1233− Bool ->
12341267 -- | Bracket style to use
12351268 BracketStyle ->
12361269 OpTree (LHsExpr GhcPs) (LHsExpr GhcPs) ->
12371270 R ()
1238−p_exprOpTree _ s (OpNode x) = located x (p_hsExpr' s)
1239−p_exprOpTree isDollarSpecial s (OpBranch x op y) = do
1240− -- NOTE If the beginning of the first argument and the second argument
1241− -- are on the same line, and the second argument has a hanging form, use
1242− -- 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.
12431276 let placement =
12441277 if isOneLineSpan
12451278 (mkSrcSpan (srcSpanStart (opTreeLoc x)) (srcSpanStart (opTreeLoc y)))
@@ -1247,8 +1280,10 @@ p_exprOpTree isDollarSpecial s (OpBranch x op y) = do
12471280 OpNode (L _ n) -> exprPlacement n
12481281 _ -> Normal
12491282 else Normal
1283+ -- Distinguish holes used in infix notation.
1284+ -- eg. '1 _foo 2' and '1 `_foo` 2'
12501285 opWrapper = case unLoc op of
1251− EWildPat NoExt -> backticks
1286+ HsUnboundVar NoExtField _ -> backticks
12521287 _ -> id
12531288 layout <- getLayout
12541289 let ub = case layout of
@@ -1256,27 +1291,67 @@ p_exprOpTree isDollarSpecial s (OpBranch x op y) = do
12561291 MultiLine -> case placement of
12571292 Hanging -> useBraces
12581293 Normal -> dontUseBraces
1259− gotDollar = case getOpName (unLoc op) of
1260− Just rname -> mkVarOcc "$" == (rdrNameOcc rname)
1261− _ -> False
1294+ opNameStr = (fmap getOpNameStr . getOpName . unLoc) op
1295+ gotDollar = opNameStr == Just "$"
1296+ gotColon = opNameStr == Just ":"
1297+ gotRecordDot = isRecordDot (unLoc op) (opTreeLoc y)
12621298 lhs =
12631299 switchLayout [opTreeLoc x] $
1264− p_exprOpTree (not gotDollar) s x
1265− let p_op = located op (opWrapper . p_hsExpr)
1266− p_y = switchLayout [opTreeLoc y] (p_exprOpTree True N y)
1267− if isDollarSpecial && gotDollar && placement == Normal && isOneLineSpan (opTreeLoc x)
1268− then do
1269− useBraces lhs
1270− space
1271− p_op
1272− breakpoint
1273− inci p_y
1274− else do
1275− ub lhs
1276− 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
12771315 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
12781327 space
1328+ p_op
1329+ breakpoint
1330+ inci p_y
1331+ | useRecordDot' && gotRecordDot -> do
1332+ lhs
1333+ when isSection space
1334+ p_op
12791335 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
12801355
12811356-- | Get annotations for the enclosing element.
12821357getEnclosingAnns :: R [AnnKeywordId]