@@ -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,25 +180,24 @@ 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
195195 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)
202202 (located' p_pat <$> m_pats)
203203 PatternBind -> stdCase
@@ -212,40 +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 =
240− maybe grhssSpan
241− (combineSrcSpans grhssSpan . srcLocSpan)
232+ maybe
233+ grhssSpan
234+ (combineSrcSpans grhssSpan . srcLocSpan . srcSpanEnd)
242235 endOfPats
243236 placement =
244237 case endOfPats of
245238 Nothing -> blockPlacement placer grhssGRHSs
246239 Just spn ->
247− if isOneLineSpan
248− (mkSrcSpan spn (srcSpanStart grhssSpan))
240+ if onTheSameLine spn grhssSpan
249241 then blockPlacement placer grhssGRHSs
250242 else Normal
251243 p_body = do
@@ -261,10 +253,18 @@ p_match' placer render style isInfix strictness m_pats m_grhss = do
261253 txt "where"
262254 unless whereIsEmpty breakpoint
263255 inci $ located grhssLocalBinds p_hsLocalBinds
264− 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 "->"
265264 switchLayout [patGrhssSpan] $
266265 placeHanging placement p_body
267266 inci p_where
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,35 +395,36 @@ p_stmt' ::
365395 Stmt GhcPs (Located body) ->
366396 R ()
367397p_stmt' placer render = \case
368− LastStmt NoExt body _ _ -> located body render
369− BindStmt NoExt l f _ _ -> do
370− located l p_pat
398+ LastStmt NoExtField body _ _ -> located body render
399+ BindStmt NoExtField p f _ _ -> do
400+ located p p_pat
371401 space
372402 txt "<-"
373− let placement =
403+ let loc = getLoc p
404+ placement =
374405 case f of
375406 L l' x ->
376407 if isOneLineSpan
377− (mkSrcSpan (srcSpanEnd (getLoc l)) (srcSpanStart l'))
408+ (mkSrcSpan (srcSpanEnd loc) (srcSpanStart l'))
378409 then placer x
379410 else Normal
380− switchLayout [getLoc l, getLoc f] $
411+ switchLayout [loc, getLoc f] $
381412 placeHanging placement (located f render)
382413 ApplicativeStmt {} -> notImplemented "ApplicativeStmt" -- generated by renamer
383− BodyStmt NoExt body _ _ -> located body render
384− LetStmt NoExt binds -> do
414+ BodyStmt NoExtField body _ _ -> located body render
415+ LetStmt NoExtField binds -> do
385416 txt "let"
386417 space
387418 sitcc $ located binds p_hsLocalBinds
388419 ParStmt {} ->
389− -- NOTE 'ParStmt' should always be eliminated in 'gatherStmt' already,
390− -- such that it never occurs in 'p_stmt''. Consequently, handling it
391− -- 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.
392423 notImplemented "ParStmt"
393− TransStmt {..} -> do
394− -- NOTE 'TransStmt' only needs to account for render printing itself,
395− -- since pretty printing of relevant statements (e.g., in 'trS_stmts')
396− -- 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'.
397428 case (trS_form, trS_by) of
398429 (ThenForm, Nothing) -> do
399430 txt "then"
@@ -422,11 +453,11 @@ p_stmt' placer render = \case
422453 RecStmt {..} -> do
423454 txt "rec"
424455 space
425− sitcc $ sepSemi (located' (p_stmt' placer render)) recS_stmts
426− XStmtLR {} -> notImplemented "XStmtLR"
456+ sitcc $ sepSemi (withSpacing (p_stmt' placer render)) recS_stmts
457+ XStmtLR c -> noExtCon c
427458
428459gatherStmt :: ExprLStmt GhcPs -> [[ExprLStmt GhcPs]]
429−gatherStmt (L _ (ParStmt NoExt block _ _)) =
460+gatherStmt (L _ (ParStmt NoExtField block _ _)) =
430461 foldr ((<>) . gatherStmtBlock) [] block
431462gatherStmt (L s stmt@TransStmt {..}) =
432463 foldr liftAppend [] ((gatherStmt <$> trS_stmts) <> pure [[L s stmt]])
@@ -435,193 +466,230 @@ gatherStmt stmt = [[stmt]]
435466gatherStmtBlock :: ParStmtBlock GhcPs GhcPs -> [[ExprLStmt GhcPs]]
436467gatherStmtBlock (ParStmtBlock _ stmts _ _) =
437468 foldr (liftAppend . gatherStmt) [] stmts
438−gatherStmtBlock XParStmtBlock {} = notImplemented "XParStmtBlock"
469+gatherStmtBlock (XParStmtBlock x) = noExtCon x
439470
440471p_hsLocalBinds :: HsLocalBindsLR GhcPs GhcPs -> R ()
441472p_hsLocalBinds = \case
442− HsValBinds NoExt (ValBinds NoExt bag lsigs) -> do
443− let ssStart =
444− either
445− (srcSpanStart . getLoc)
446− (srcSpanStart . getLoc)
447− items =
448− (Left <$> bagToList bag) ++ (Right <$> lsigs)
449− p_item (Left x) = located x p_valDecl
450− p_item (Right x) = located x p_sigDecl
451− -- Assigns 'False' to the last element, 'True' to the rest.
452− markInit :: [a] -> [(Bool, a)]
453− markInit [] = []
454− markInit (x : []) = [(False, x)]
455− markInit (x : xs) = (True, x) : markInit xs
456− -- 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
457475 -- elements will also contain semicolons and they will confuse the
458476 -- parser. so we request braces around every element except the last.
459477 br <- layoutToBraces <$> getLayout
460− sitcc $
461− sepSemi
462− (\(m, i) -> (if m then br else id) $ p_item i)
463− (markInit $ sortOn ssStart items)
464− HsValBinds NoExt _ -> notImplemented "HsValBinds"
465− 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) ->
466494 -- Second argument of IPBind is always Left before type-checking.
467− let p_ipBind (IPBind NoExt (Left name) expr) = do
495+ let p_ipBind (IPBind NoExtField (Left name) expr) = do
468496 atom name
469497 space
470− txt "="
498+ equals
471499 breakpoint
472500 useBraces $ inci $ located expr p_hsExpr
473− 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
474505 in sepSemi (located' p_ipBind) xs
475− HsIPBinds NoExt _ -> notImplemented "HsIpBinds"
476− EmptyLocalBinds NoExt -> return ()
477− XHsLocalBindsLR _ -> notImplemented "XHsLocalBindsLR"
506+ HsIPBinds NoExtField _ -> notImplemented "HsIpBinds"
507+ EmptyLocalBinds NoExtField -> return ()
508+ XHsLocalBindsLR x -> noExtCon x
478509
479510p_hsRecField ::
480511 HsRecField' RdrName (LHsExpr GhcPs) ->
481512 R ()
482−p_hsRecField = \HsRecField {..} -> do
513+p_hsRecField HsRecField {..} = do
483514 p_rdrName hsRecFieldLbl
484515 unless hsRecPun $ do
485516 space
486− txt "="
487− let placement = exprPlacement (unLoc hsRecFieldArg)
488− placeHanging placement $ located hsRecFieldArg p_hsExpr
489−
490−p_hsTupArg :: HsTupArg GhcPs -> R ()
491−p_hsTupArg = \case
492− Present NoExt x -> located x p_hsExpr
493− Missing NoExt -> pure ()
494− 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)
495523
496524p_hsExpr :: HsExpr GhcPs -> R ()
497525p_hsExpr = p_hsExpr' N
498526
499527p_hsExpr' :: BracketStyle -> HsExpr GhcPs -> R ()
500528p_hsExpr' s = \case
501− HsVar NoExt name -> p_rdrName name
502− HsUnboundVar NoExt _ -> notImplemented "HsUnboundVar"
503− HsConLikeOut NoExt _ -> notImplemented "HsConLikeOut"
504− 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 ->
505533 case x of
506− Unambiguous NoExt name -> p_rdrName name
507− Ambiguous NoExt name -> p_rdrName name
508− XAmbiguousFieldOcc NoExt -> notImplemented "XAmbiguousFieldOcc"
509− 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
510538 txt "#"
511539 atom v
512− HsIPVar NoExt (HsIPName name) -> do
540+ HsIPVar NoExtField (HsIPName name) -> do
513541 txt "?"
514542 atom name
515− HsOverLit NoExt v -> atom (ol_val v)
516− HsLit NoExt lit ->
543+ HsOverLit NoExtField v -> atom (ol_val v)
544+ HsLit NoExtField lit ->
517545 case lit of
518546 HsString (SourceText stxt) _ -> p_stringLit stxt
519547 HsStringPrim (SourceText stxt) _ -> p_stringLit stxt
520548 r -> atom r
521− HsLam NoExt mgroup ->
549+ HsLam NoExtField mgroup ->
522550 p_matchGroup Lambda mgroup
523− HsLamCase NoExt mgroup -> do
551+ HsLamCase NoExtField mgroup -> do
524552 txt "\\case"
525553 breakpoint
526554 inci (p_matchGroup LambdaCase mgroup)
527− HsApp NoExt f x -> do
528− -- We hang only the last function argument. In order to do
529− -- this, we only call 'placeHanging' on the topmost 'HsApp',
530− -- and then use 'p_withoutHanging' for the descendants.
531− let p_withoutHanging (HsApp NoExt f' x') = do
555+ HsApp NoExtField f x -> do
556+ let -- In order to format function applications with multiple parameters
557+ -- nicer, traverse the AST to gather the function and all the
558+ -- parameters together.
559+ gatherArgs f' knownArgs =
532560 case f' of
533− L _ (HsApp _ _ _) -> located f' p_withoutHanging
534− _ -> located f' (p_hsExpr' s)
535− breakpoint
536− inci $ located x' p_hsExpr
537− p_withoutHanging e = p_hsExpr e
538− -- Only use the hanging placement if the function spans
539− -- a single line.
561+ L _ (HsApp _ l r) -> gatherArgs l (r <| knownArgs)
562+ _ -> (f', knownArgs)
563+ (func, args) = gatherArgs f (x :| [])
564+ -- We need to handle the last argument specially if it is a
565+ -- hanging construct, so separate it from the rest.
566+ (initp, lastp) = (NE.init args, NE.last args)
567+ initSpan =
568+ combineSrcSpans' $
569+ getLoc f :| [(srcLocSpan . srcSpanStart . getLoc) lastp]
570+ -- Hang the last argument only if the initial arguments span one
571+ -- line.
540572 placement =
541− if isOneLineSpan (getLoc f)
542− then exprPlacement (unLoc x)
573+ if isOneLineSpan initSpan
574+ then exprPlacement (unLoc lastp)
543575 else Normal
544− -- We only sit when the last expression is not hanging.
545− -- This is to allow:
546− -- f = foo bar do
547− -- baz
548− sit' =
549− if placement == Normal
550− then sitcc
551− else id
552− sit' $ do
553− useBraces $ located f p_withoutHanging
554− placeHanging placement $
555− located x p_hsExpr
556− HsAppType a e -> do
576+ -- If the last argument is not hanging, just separate every argument as
577+ -- usual. If it is hanging, print the initial arguments and hang the
578+ -- last one. Also, use braces around the every argument except the last
579+ -- one.
580+ case placement of
581+ Normal -> 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
598+ located func (p_hsExpr' s)
599+ breakpoint
600+ inciIf doIndent $ sep breakpoint (located' p_hsExpr) initp
601+ inciIf doIndent $ do
602+ unless (null initp) breakpoint
603+ located lastp p_hsExpr
604+ Hanging -> do
605+ useBraces . switchLayout [initSpan] $ do
606+ located func (p_hsExpr' s)
607+ breakpoint
608+ sep breakpoint (located' p_hsExpr) initp
609+ placeHanging placement $
610+ located lastp p_hsExpr
611+ HsAppType NoExtField e a -> do
557612 located e p_hsExpr
558613 breakpoint
559614 inci $ do
560615 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 ()
561621 located (hswc_body a) p_hsType
562− OpApp NoExt x op y -> do
622+ OpApp NoExtField x op y -> do
563623 let opTree = OpBranch (exprOpTree x) op (exprOpTree y)
564− p_exprOpTree True s (reassociateOpTree getOpName opTree)
565− NegApp NoExt e _ -> do
624+ p_exprOpTree s (reassociateOpTree getOpName opTree)
625+ NegApp NoExtField e _ -> do
566626 txt "-"
567627 space
568628 located e p_hsExpr
569− HsPar NoExt e -> parens s (located e p_hsExpr)
570− SectionL NoExt x op -> do
629+ HsPar NoExtField e ->
630+ parens s (located e (dontUseBraces . p_hsExpr))
631+ SectionL NoExtField x op -> do
571632 located x p_hsExpr
572633 breakpoint
573634 inci (located op p_hsExpr)
574− SectionR NoExt op x -> do
635+ SectionR NoExtField op x -> do
575636 located op p_hsExpr
576− breakpoint
637+ useRecordDot' <- useRecordDot
638+ let isRecordDot' = isRecordDot (unLoc op) (getLoc x)
639+ unless (useRecordDot' && isRecordDot') breakpoint
577640 inci (located x p_hsExpr)
578− ExplicitTuple NoExt args boxity -> do
641+ ExplicitTuple NoExtField args boxity ->
579642 let isSection = any (isMissing . unLoc) args
580643 isMissing = \case
581− Missing NoExt -> True
644+ Missing NoExtField -> True
582645 _ -> False
583− 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' =
584652 case boxity of
585653 Boxed -> parens
586654 Unboxed -> parensHash
587− if isSection
588− then
589− switchLayout [] . parens' s $
590− sep comma (located' p_hsTupArg) args
591− else
592− switchLayout (getLoc <$> args) . parens' s . sitcc $
593− sep (comma >> breakpoint) (sitcc . located' p_hsTupArg) args
594− 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 ->
595663 p_unboxedSum N tag arity (located e p_hsExpr)
596− HsCase NoExt e mgroup ->
664+ HsCase NoExtField e mgroup ->
597665 p_case exprPlacement p_hsExpr e mgroup
598− HsIf NoExt _ if' then' else' ->
666+ HsIf NoExtField _ if' then' else' ->
599667 p_if exprPlacement p_hsExpr if' then' else'
600− HsMultiIf NoExt guards -> do
668+ HsMultiIf NoExtField guards -> do
601669 txt "if"
602670 breakpoint
603− inci . sitcc $ sep newline (located' (p_grhs RightArrow)) guards
604− HsLet NoExt localBinds e ->
671+ inci . inci $ sep newline (located' (p_grhs RightArrow)) guards
672+ HsLet NoExtField localBinds e ->
605673 p_let p_hsExpr localBinds e
606− HsDo NoExt ctx es -> do
674+ HsDo NoExtField ctx es -> do
607675 let doBody header = do
608676 txt header
609677 breakpoint
610678 ub <- layoutToBraces <$> getLayout
611679 inci $
612680 sepSemi
613− (located' (ub . p_stmt' exprPlacement (p_hsExpr' S)))
681+ (ub . withSpacing (p_stmt' exprPlacement (p_hsExpr' S)))
614682 (unLoc es)
615− compBody = brackets N $ located es $ \xs -> do
683+ compBody = brackets N . located es $ \xs -> do
616684 let p_parBody =
617685 sep
618− (breakpoint >> txt "| ")
686+ (breakpoint >> txt "|" >> space)
619687 p_seqBody
620688 p_seqBody =
621689 sitcc
622690 . sep
623− (comma >> breakpoint)
624− (located' (sitcc . p_stmt))
691+ commaDel
692+ (located' (sitcc . p_stmt))
625693 stmts = init xs
626694 yield = last xs
627695 lists = foldr (liftAppend . gatherStmt) [] stmts
@@ -641,88 +709,94 @@ p_hsExpr' s = \case
641709 ParStmtCtxt _ -> notImplemented "ParStmtCtxt"
642710 TransStmtCtxt _ -> notImplemented "TransStmtCtxt"
643711 ExplicitList _ _ xs ->
644− brackets s . sitcc $
645− sep (comma >> breakpoint) (sitcc . located' p_hsExpr) xs
712+ brackets s $
713+ sep commaDel (sitcc . located' p_hsExpr) xs
646714 RecordCon {..} -> do
647715 located rcon_con_name atom
648716 breakpoint
649717 let HsRecFields {..} = rcon_flds
650718 updName f =
651− f
719+ (f :: HsRecField GhcPs (LHsExpr GhcPs))
652720 { hsRecFieldLbl = case unLoc $ hsRecFieldLbl f of
653721 FieldOcc _ n -> n
654− XFieldOcc _ -> notImplemented "XFieldOcc"
722+ XFieldOcc x -> noExtCon x
655723 }
656724 fields = located' (p_hsRecField . updName) <$> rec_flds
657725 dotdot =
658726 case rec_dotdot of
659727 Just {} -> [txt ".."]
660728 Nothing -> []
661− inci . braces N . sitcc $
662− sep (comma >> breakpoint) sitcc (fields <> dotdot)
729+ inci . braces N $
730+ sep commaDel sitcc (fields <> dotdot)
663731 RecordUpd {..} -> do
664732 located rupd_expr p_hsExpr
665− 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
666741 let updName f =
667− f
742+ (f :: HsRecUpdField GhcPs)
668743 { hsRecFieldLbl = case unLoc $ hsRecFieldLbl f of
669744 Ambiguous _ n -> n
670745 Unambiguous _ n -> n
671− XAmbiguousFieldOcc _ -> notImplemented "XAmbiguousFieldOcc"
746+ XAmbiguousFieldOcc x -> noExtCon x
672747 }
673− inci . braces N . sitcc $
748+ inci . braces N $
674749 sep
675− (comma >> breakpoint)
750+ commaDel
676751 (sitcc . located' (p_hsRecField . updName))
677752 rupd_flds
678− ExprWithTySig affix x -> sitcc $ do
753+ ExprWithTySig NoExtField x HsWC {hswc_body = HsIB {..}} -> sitcc $ do
679754 located x p_hsExpr
680755 space
681756 txt "::"
682757 breakpoint
683− inci $ do
684− let HsWC {..} = affix
685− HsIB {..} = hswc_body
686− located hsib_body p_hsType
687− 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 ->
688762 case x of
689− From from -> brackets s . sitcc $ do
763+ From from -> brackets s $ do
690764 located from p_hsExpr
691765 breakpoint
692766 txt ".."
693− FromThen from next -> brackets s . sitcc $ do
694− sitcc $ sep (comma >> breakpoint) (located' p_hsExpr) [from, next]
767+ FromThen from next -> brackets s $ do
768+ sep commaDel (located' p_hsExpr) [from, next]
695769 breakpoint
696770 txt ".."
697− FromTo from to -> brackets s . sitcc $ do
771+ FromTo from to -> brackets s $ do
698772 located from p_hsExpr
699773 breakpoint
700774 txt ".."
701775 space
702776 located to p_hsExpr
703− FromThenTo from next to -> brackets s . sitcc $ do
704− 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]
705779 breakpoint
706780 txt ".."
707781 space
708782 located to p_hsExpr
709− HsSCC NoExt _ name x -> do
783+ HsSCC NoExtField _ name x -> do
710784 txt "{-# SCC "
711785 atom name
712786 txt " #-}"
713787 breakpoint
714788 located x p_hsExpr
715− HsCoreAnn NoExt _ value x -> do
789+ HsCoreAnn NoExtField _ value x -> do
716790 txt "{-# CORE "
717791 atom value
718792 txt " #-}"
719793 breakpoint
720794 located x p_hsExpr
721− HsBracket NoExt x -> p_hsBracket x
795+ HsBracket NoExtField x -> p_hsBracket x
722796 HsRnBracketOut {} -> notImplemented "HsRnBracketOut"
723797 HsTcBracketOut {} -> notImplemented "HsTcBracketOut"
724− HsSpliceE NoExt splice -> p_hsSplice splice
725− HsProc NoExt p e -> do
798+ HsSpliceE NoExtField splice -> p_hsSplice splice
799+ HsProc NoExtField p e -> do
726800 txt "proc"
727801 located p $ \x -> do
728802 breakpoint
@@ -735,31 +809,11 @@ p_hsExpr' s = \case
735809 txt "static"
736810 breakpoint
737811 inci (located e p_hsExpr)
738− HsArrApp NoExt body input arrType cond ->
739− p_hsCmd (HsCmdArrApp NoExt body input arrType cond)
740− HsArrForm NoExt form mfixity cmds ->
741− p_hsCmd (HsCmdArrForm NoExt form Prefix mfixity cmds)
742812 HsTick {} -> notImplemented "HsTick"
743813 HsBinTick {} -> notImplemented "HsBinTick"
744814 HsTickPragma {} -> notImplemented "HsTickPragma"
745− -- These four constructs should never appear in correct programs.
746− -- See: https://github.com/tweag/ormolu/issues/343
747− EWildPat NoExt -> txt "_"
748− EAsPat NoExt n p -> do
749− p_rdrName n
750− txt "@"
751− located p p_hsExpr
752− EViewPat NoExt p e -> do
753− located p p_hsExpr
754− space
755− txt "->"
756− breakpoint
757− inci (located e p_hsExpr)
758− ELazyPat NoExt p -> do
759− txt "~"
760− located p p_hsExpr
761815 HsWrap {} -> notImplemented "HsWrap"
762− XExpr {} -> notImplemented "XExpr"
816+ XExpr x -> noExtCon x
763817
764818p_patSynBind :: PatSynBind GhcPs GhcPs -> R ()
765819p_patSynBind PSB {..} = do
@@ -771,7 +825,7 @@ p_patSynBind PSB {..} = do
771825 breakpoint
772826 located psb_def p_pat
773827 ImplicitBidirectional -> do
774− txt "="
828+ equals
775829 breakpoint
776830 located psb_def p_pat
777831 ExplicitBidirectional mgroup -> do
@@ -798,8 +852,8 @@ p_patSynBind PSB {..} = do
798852 inci $ do
799853 switchLayout (getLoc . recordPatSynPatVar <$> xs) $ do
800854 unless (null xs) breakpoint
801− braces N . sitcc $
802− sep (comma >> breakpoint) (p_rdrName . recordPatSynPatVar) xs
855+ braces N $
856+ sep commaDel (p_rdrName . recordPatSynPatVar) xs
803857 rhs
804858 InfixCon l r -> do
805859 switchLayout [getLoc l, getLoc r] $ do
@@ -811,7 +865,7 @@ p_patSynBind PSB {..} = do
811865 space
812866 p_rdrName r
813867 inci rhs
814−p_patSynBind (XPatSynBind NoExt) = notImplemented "XPatSynBind"
868+p_patSynBind (XPatSynBind x) = noExtCon x
815869
816870p_case ::
817871 Data body =>
@@ -822,7 +876,7 @@ p_case ::
822876 -- | Expression
823877 LHsExpr GhcPs ->
824878 -- | Match group
825− (MatchGroup GhcPs (Located body)) ->
879+ MatchGroup GhcPs (Located body) ->
826880 R ()
827881p_case placer render e mgroup = do
828882 txt "case"
@@ -853,10 +907,12 @@ p_if placer render if' then' else' = do
853907 breakpoint
854908 inci $ do
855909 txt "then"
910+ space
856911 located then' $ \x ->
857912 placeHanging (placer x) (render x)
858913 breakpoint
859914 txt "else"
915+ space
860916 located else' $ \x ->
861917 placeHanging (placer x) (render x)
862918
@@ -878,29 +934,29 @@ p_let render localBinds e = sitcc $ do
878934
879935p_pat :: Pat GhcPs -> R ()
880936p_pat = \case
881− WildPat NoExt -> txt "_"
882− VarPat NoExt name -> p_rdrName name
883− LazyPat NoExt pat -> do
937+ WildPat NoExtField -> txt "_"
938+ VarPat NoExtField name -> p_rdrName name
939+ LazyPat NoExtField pat -> do
884940 txt "~"
885941 located pat p_pat
886− AsPat NoExt name pat -> do
942+ AsPat NoExtField name pat -> do
887943 p_rdrName name
888944 txt "@"
889945 located pat p_pat
890− ParPat NoExt pat ->
946+ ParPat NoExtField pat ->
891947 located pat (parens S . p_pat)
892− BangPat NoExt pat -> do
948+ BangPat NoExtField pat -> do
893949 txt "!"
894950 located pat p_pat
895− ListPat NoExt pats -> do
896− brackets S . sitcc $ sep (comma >> breakpoint) (located' p_pat) pats
897− TuplePat NoExt pats boxing -> do
898− let f =
951+ ListPat NoExtField pats ->
952+ brackets S $ sep commaDel (located' p_pat) pats
953+ TuplePat NoExtField pats boxing -> do
954+ let parens' =
899955 case boxing of
900956 Boxed -> parens S
901957 Unboxed -> parensHash S
902− f . sitcc $ sep (comma >> breakpoint) (sitcc . located' p_pat) pats
903− SumPat NoExt pat tag arity ->
958+ parens' $ sep commaDel (sitcc . located' p_pat) pats
959+ SumPat NoExtField pat tag arity ->
904960 p_unboxedSum S tag arity (located pat p_pat)
905961 ConPatIn pat details ->
906962 case details of
@@ -915,38 +971,40 @@ p_pat = \case
915971 let f = \case
916972 Nothing -> txt ".."
917973 Just x -> located x p_pat_hsRecField
918− inci . braces N . sitcc . sep (comma >> breakpoint) f $
974+ inci . braces N . sep commaDel f $
919975 case dotdot of
920976 Nothing -> Just <$> fields
921− Just n -> (Just <$> take n fields) ++ [Nothing]
922− InfixCon x y -> do
923− located x p_pat
924− space
925− p_rdrName pat
926− breakpoint
927− inci (located y p_pat)
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
928986 ConPatOut {} -> notImplemented "ConPatOut" -- presumably created by renamer?
929− ViewPat NoExt expr pat -> sitcc $ do
987+ ViewPat NoExtField expr pat -> sitcc $ do
930988 located expr p_hsExpr
931989 space
932990 txt "->"
933991 breakpoint
934992 inci (located pat p_pat)
935− SplicePat NoExt splice -> p_hsSplice splice
936− LitPat NoExt p -> atom p
937− NPat NoExt v _ _ -> located v (atom . ol_val)
938− NPlusKPat NoExt n k _ _ _ -> sitcc $ do
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
939997 p_rdrName n
940998 breakpoint
941999 inci $ do
9421000 txt "+"
9431001 space
9441002 located k (atom . ol_val)
945− SigPat hswc pat -> do
1003+ SigPat NoExtField pat hswc -> do
9461004 located pat p_pat
9471005 p_typeAscription hswc
9481006 CoPat {} -> notImplemented "CoPat" -- apparently created at some later stage
949− XPat NoExt -> notImplemented "XPat"
1007+ XPat x -> noExtCon x
9501008
9511009p_pat_hsRecField :: HsRecField' (FieldOcc GhcPs) (LPat GhcPs) -> R ()
9521010p_pat_hsRecField HsRecField {..} = do
@@ -954,7 +1012,7 @@ p_pat_hsRecField HsRecField {..} = do
9541012 p_rdrName (rdrNameFieldOcc x)
9551013 unless hsRecPun $ do
9561014 space
957− txt "="
1015+ equals
9581016 breakpoint
9591017 inci (located hsRecFieldArg p_pat)
9601018
@@ -963,32 +1021,31 @@ p_unboxedSum s tag arity m = do
9631021 let before = tag - 1
9641022 after = arity - before - 1
9651023 args = replicate before Nothing <> [Just m] <> replicate after Nothing
966− f (x, i) = do
967− let isFirst = i == 0
968− isLast = i == arity - 1
1024+ f x =
9691025 case x :: Maybe (R ()) of
9701026 Nothing ->
971− unless (isFirst || isLast) space
1027+ space
9721028 Just m' -> do
973− unless isFirst space
1029+ space
9741030 m'
975− unless isLast space
976− parensHash s $ sep (txt "|") f (zip args [0 ..])
1031+ space
1032+ parensHash s $ sep (txt "|") f args
9771033
9781034p_hsSplice :: HsSplice GhcPs -> R ()
9791035p_hsSplice = \case
980− HsTypedSplice NoExt deco _ expr -> p_hsSpliceTH True expr deco
981− HsUntypedSplice NoExt deco _ expr -> p_hsSpliceTH False expr deco
982− 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
9831039 txt "["
9841040 p_rdrName (L srcSpan quoterName)
9851041 txt "|"
986− -- NOTE QuasiQuoters often rely on precise custom strings. We cannot do
987− -- 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.
9881044 atom str
9891045 txt "|]"
9901046 HsSpliced {} -> notImplemented "HsSpliced"
991− XSplice {} -> notImplemented "XSplice"
1047+ HsSplicedT {} -> notImplemented "HsSplicedT"
1048+ XSplice x -> noExtCon x
9921049
9931050p_hsSpliceTH ::
9941051 -- | Typed splice?
@@ -1012,17 +1069,17 @@ p_hsSpliceTH isTyped expr = \case
10121069
10131070p_hsBracket :: HsBracket GhcPs -> R ()
10141071p_hsBracket = \case
1015− ExpBr NoExt expr -> do
1072+ ExpBr NoExtField expr -> do
10161073 anns <- getEnclosingAnns
10171074 let name = case anns of
10181075 AnnOpenEQ : _ -> ""
10191076 _ -> "e"
10201077 quote name (located expr p_hsExpr)
1021− PatBr NoExt pat -> quote "p" (located pat p_pat)
1022− DecBrL NoExt decls -> quote "d" (p_hsDecls Free decls)
1023− DecBrG NoExt _ -> notImplemented "DecBrG" -- result of renamer
1024− TypBr NoExt ty -> quote "t" (located ty p_hsType)
1025− 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
10261083 txt (bool "''" "'" isSingleQuote)
10271084 -- HACK As you can see we use 'noLoc' here to be able to pass name into
10281085 -- 'p_rdrName' since the latter expects a "located" thing. The problem
@@ -1037,13 +1094,13 @@ p_hsBracket = \case
10371094 && not (doesNotNeedExtraParens name)
10381095 wrapper = if isOperator then parens N else id
10391096 wrapper $ p_rdrName (noLoc name)
1040− TExpBr NoExt expr -> do
1097+ TExpBr NoExtField expr -> do
10411098 txt "[||"
10421099 breakpoint'
10431100 located expr p_hsExpr
10441101 breakpoint'
10451102 txt "||]"
1046− XBracket {} -> notImplemented "XBracket"
1103+ XBracket x -> noExtCon x
10471104 where
10481105 quote :: Text -> R () -> R ()
10491106 quote name body = do
@@ -1097,7 +1154,8 @@ p_stringLit src =
10971154 zipPrevNext :: [a] -> [(Maybe a, a, Maybe a)]
10981155 zipPrevNext xs =
10991156 let z =
1100− zip (zip (Nothing : map Just xs) xs)
1157+ zip
1158+ (zip (Nothing : map Just xs) xs)
11011159 (map Just (tail xs) ++ repeat Nothing)
11021160 in map (\((p, x), n) -> (p, x, n)) z
11031161 orig (_, x, _) = x
@@ -1121,9 +1179,9 @@ liftAppend (x : xs) [] = x : xs
11211179liftAppend (x : xs) (y : ys) = x <> y : liftAppend xs ys
11221180
11231181getGRHSSpan :: GRHS GhcPs (Located body) -> SrcSpan
1124−getGRHSSpan (GRHS NoExt guards body) =
1182+getGRHSSpan (GRHS NoExtField guards body) =
11251183 combineSrcSpans' $ getLoc body :| map getLoc guards
1126−getGRHSSpan (XGRHS NoExt) = notImplemented "XGRHS"
1184+getGRHSSpan (XGRHS x) = noExtCon x
11271185
11281186-- | Place a thing that may have a hanging form. This function handles how
11291187-- to separate it from preceding expressions and whether to bump indentation
@@ -1144,46 +1202,44 @@ blockPlacement ::
11441202 (body -> Placement) ->
11451203 [LGRHS GhcPs (Located body)] ->
11461204 Placement
1147−blockPlacement placer [(L _ (GRHS NoExt _ (L _ x)))] = placer x
1205+blockPlacement placer [L _ (GRHS NoExtField _ (L _ x))] = placer x
11481206blockPlacement _ _ = Normal
11491207
11501208-- | Check if given command has a hanging form.
11511209cmdPlacement :: HsCmd GhcPs -> Placement
11521210cmdPlacement = \case
1153− HsCmdLam NoExt _ -> Hanging
1154− HsCmdCase NoExt _ _ -> Hanging
1155− HsCmdDo NoExt _ -> Hanging
1211+ HsCmdLam NoExtField _ -> Hanging
1212+ HsCmdCase NoExtField _ _ -> Hanging
1213+ HsCmdDo NoExtField _ -> Hanging
11561214 _ -> Normal
11571215
11581216cmdTopPlacement :: HsCmdTop GhcPs -> Placement
11591217cmdTopPlacement = \case
1160− HsCmdTop NoExt (L _ x) -> cmdPlacement x
1161− XCmdTop {} -> notImplemented "XCmdTop"
1218+ HsCmdTop NoExtField (L _ x) -> cmdPlacement x
1219+ XCmdTop x -> noExtCon x
11621220
11631221-- | Check if given expression has a hanging form.
11641222exprPlacement :: HsExpr GhcPs -> Placement
11651223exprPlacement = \case
11661224 -- Only hang lambdas with single line parameter lists
1167− HsLam NoExt mg -> case mg of
1168− MG _ (L _ [L _ (Match NoExt _ (x : xs) _)]) _
1225+ HsLam NoExtField mg -> case mg of
1226+ MG _ (L _ [L _ (Match NoExtField _ (x : xs) _)]) _
11691227 | isOneLineSpan (combineSrcSpans' $ fmap getLoc (x :| xs)) ->
11701228 Hanging
11711229 _ -> Normal
1172− HsLamCase NoExt _ -> Hanging
1173− HsCase NoExt _ _ -> Hanging
1174− HsDo NoExt DoExpr _ -> Hanging
1175− HsDo NoExt MDoExpr _ -> Hanging
1176− RecordCon NoExt _ _ -> Hanging
1177− -- If the rightmost expression in an operator chain is hanging, make the
1178− -- whole block hanging; so that we can use the common @f = foo $ do@
1179− -- style.
1180− OpApp NoExt _ _ y -> exprPlacement (unLoc y)
1181− -- Same thing for function applications (usually with -XBlockArguments)
1182− HsApp NoExt _ y -> exprPlacement (unLoc y)
1183− HsProc NoExt (L s _) _ ->
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 _ ->
11841240 -- Indentation breaks if pattern is longer than one line and left
11851241 -- hanging. Consequently, only apply hanging when it is safe.
1186− if isOneLineSpan s
1242+ if isOneLineSpan (getLoc p)
11871243 then Hanging
11881244 else Normal
11891245 _ -> Normal
@@ -1192,39 +1248,42 @@ withGuards :: [LGRHS GhcPs (Located body)] -> Bool
11921248withGuards = any (checkOne . unLoc)
11931249 where
11941250 checkOne :: GRHS GhcPs (Located body) -> Bool
1195− checkOne (GRHS NoExt [] _) = False
1251+ checkOne (GRHS NoExtField [] _) = False
11961252 checkOne _ = True
11971253
11981254exprOpTree :: LHsExpr GhcPs -> OpTree (LHsExpr GhcPs) (LHsExpr GhcPs)
1199−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)
12001256exprOpTree n = OpNode n
12011257
12021258getOpName :: HsExpr GhcPs -> Maybe RdrName
12031259getOpName = \case
1204− HsVar NoExt (L _ a) -> Just a
1260+ HsVar NoExtField (L _ a) -> Just a
12051261 _ -> Nothing
12061262
1263+getOpNameStr :: RdrName -> String
1264+getOpNameStr = occNameString . rdrNameOcc
1265+
12071266p_exprOpTree ::
1208− -- | Can use special handling of dollar?
1209− Bool ->
12101267 -- | Bracket style to use
12111268 BracketStyle ->
12121269 OpTree (LHsExpr GhcPs) (LHsExpr GhcPs) ->
12131270 R ()
1214−p_exprOpTree _ s (OpNode x) = located x (p_hsExpr' s)
1215−p_exprOpTree isDollarSpecial s (OpBranch x op y) = do
1216− -- NOTE If the beginning of the first argument and the second argument
1217− -- are on the same line, and the second argument has a hanging form, use
1218− -- 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.
12191276 let placement =
12201277 if isOneLineSpan
1221− (mkSrcSpan (srcSpanStart (opTreeLoc x)) (srcSpanStart (opTreeLoc y)))
1278+ (mkSrcSpan (srcSpanStart (opTreeLoc x)) (srcSpanStart (opTreeLoc y)))
12221279 then case y of
12231280 OpNode (L _ n) -> exprPlacement n
12241281 _ -> Normal
12251282 else Normal
1283+ -- Distinguish holes used in infix notation.
1284+ -- eg. '1 _foo 2' and '1 `_foo` 2'
12261285 opWrapper = case unLoc op of
1227− EWildPat NoExt -> backticks
1286+ HsUnboundVar NoExtField _ -> backticks
12281287 _ -> id
12291288 layout <- getLayout
12301289 let ub = case layout of
@@ -1232,24 +1291,67 @@ p_exprOpTree isDollarSpecial s (OpBranch x op y) = do
12321291 MultiLine -> case placement of
12331292 Hanging -> useBraces
12341293 Normal -> dontUseBraces
1235− gotDollar = case getOpName (unLoc op) of
1236− Just rname -> mkVarOcc "$" == (rdrNameOcc rname)
1294+ opNameStr = (fmap getOpNameStr . getOpName . unLoc) op
1295+ gotDollar = opNameStr == Just "$"
1296+ gotColon = opNameStr == Just ":"
1297+ gotRecordDot = isRecordDot (unLoc op) (opTreeLoc y)
1298+ lhs =
1299+ switchLayout [opTreeLoc x] $
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
12371306 _ -> False
1238− switchLayout [opTreeLoc x]
1239− $ ub
1240− $ p_exprOpTree (not gotDollar) s x
1241− let p_op = located op (opWrapper . p_hsExpr)
1242− p_y = switchLayout [opTreeLoc y] (p_exprOpTree True N y)
1243− if isDollarSpecial && gotDollar && placement == Normal && isOneLineSpan (opTreeLoc x)
1244− then do
1245− space
1246− p_op
1247− breakpoint
1248− inci p_y
1249− else placeHanging placement $ do
1250− p_op
1251− space
1252− p_y
1307+ isDoBlock = \case
1308+ OpNode (L _ HsDo {}) -> True
1309+ _ -> False
1310+ useRecordDot' <- useRecordDot
1311+ if
1312+ | gotColon -> do
1313+ lhs
1314+ space
1315+ 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
1327+ space
1328+ p_op
1329+ breakpoint
1330+ inci p_y
1331+ | useRecordDot' && gotRecordDot -> do
1332+ lhs
1333+ when isSection space
1334+ p_op
1335+ p_y
1336+ | otherwise -> do
1337+ ub lhs
1338+ placeHanging placement $ do
1339+ p_op
1340+ space
1341+ p_y
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
12531355
12541356-- | Get annotations for the enclosing element.
12551357getEnclosingAnns :: R [AnnKeywordId]