@@ -1,6 +1,8 @@
1{-# LANGUAGE LambdaCase #-}
1{-# LANGUAGE LambdaCase #-}
2+{-# LANGUAGE MultiWayIf #-}
2{-# LANGUAGE OverloadedStrings #-}
3{-# LANGUAGE OverloadedStrings #-}
3{-# LANGUAGE RecordWildCards #-}
4{-# LANGUAGE RecordWildCards #-}
5+{-# LANGUAGE TypeApplications #-}
5module Ormolu.Printer.Meat.Declaration.Value
7module Ormolu.Printer.Meat.Declaration.Value
6 ( p_valDecl,
8 ( p_valDecl,
@@ -20,12 +22,12 @@ import Data.Char (isPunctuation, isSymbol)
20import Data.Data hiding (Infix, Prefix)
22import Data.Data hiding (Infix, Prefix)
21import Data.Functor ((<&>))
23import Data.Functor ((<&>))
22import Data.List (intersperse, sortOn)
24import Data.List (intersperse, sortOn)
23−import Data.List.NonEmpty ((<|), NonEmpty ((:|)))
25+import Data.List.NonEmpty (NonEmpty (..), (<|))
24import qualified Data.List.NonEmpty as NE
26import qualified Data.List.NonEmpty as NE
25import Data.Text (Text)
27import Data.Text (Text)
26import qualified Data.Text as Text
28import qualified Data.Text as Text
28−import OccName (mkVarOcc)
30+import OccName (occNameString)
29import Ormolu.Printer.Combinators
31import Ormolu.Printer.Combinators
30import Ormolu.Printer.Internal
32import Ormolu.Printer.Internal
31import Ormolu.Printer.Meat.Common
33import Ormolu.Printer.Meat.Common
@@ -34,8 +36,6 @@ import Ormolu.Printer.Meat.Declaration.Signature
34import Ormolu.Printer.Meat.Type
36import Ormolu.Printer.Meat.Type
35import Ormolu.Printer.Operators
37import Ormolu.Printer.Operators
36import Ormolu.Utils
38import Ormolu.Utils
37−import RdrName (RdrName (..), rdrNameOcc)
38−import SrcLoc (combineSrcSpans, isOneLineSpan)
40-- | Style of a group of equations.
40-- | Style of a group of equations.
41data MatchGroupStyle
41data MatchGroupStyle
@@ -61,16 +61,16 @@ data Placement
61 -- should use it and avoid bumping one level
61 -- should use it and avoid bumping one level
62 -- of indentation
62 -- of indentation
64− deriving (Eq)
64+ deriving (Eq, Show)
66p_valDecl :: HsBindLR GhcPs GhcPs -> R ()
66p_valDecl :: HsBindLR GhcPs GhcPs -> R ()
67p_valDecl = \case
67p_valDecl = \case
68− FunBind NoExt funId funMatches _ _ -> p_funBind funId funMatches
68+ FunBind NoExtField funId funMatches _ _ -> p_funBind funId funMatches
69− PatBind NoExt pat grhss _ -> p_match PatternBind False NoSrcStrict [pat] grhss
69+ PatBind NoExtField pat grhss _ -> p_match PatternBind False NoSrcStrict [pat] grhss
70 VarBind {} -> notImplemented "VarBinds" -- introduced by the type checker
70 VarBind {} -> notImplemented "VarBinds" -- introduced by the type checker
71 AbsBinds {} -> notImplemented "AbsBinds" -- introduced by the type checker
71 AbsBinds {} -> notImplemented "AbsBinds" -- introduced by the type checker
72− PatSynBind NoExt psb -> p_patSynBind psb
72+ PatSynBind NoExtField psb -> p_patSynBind psb
73− XHsBindsLR NoExt -> notImplemented "XHsBindsLR"
73+ XHsBindsLR x -> noExtCon x
75p_funBind ::
75p_funBind ::
76 Located RdrName ->
76 Located RdrName ->
@@ -114,8 +114,8 @@ p_matchGroup' placer render style MG {..} = do
114 (matchStrictness m)
114 (matchStrictness m)
117− p_Match _ = notImplemented "XMatch"
117+ p_Match (XMatch x) = noExtCon x
118−p_matchGroup' _ _ _ (XMatchGroup NoExt) = notImplemented "XMatchGroup"
118+p_matchGroup' _ _ _ (XMatchGroup x) = noExtCon x
120-- | Function id obtained through pattern matching on 'FunBind' should not
120-- | Function id obtained through pattern matching on 'FunBind' should not
121-- be used to print the actual equations because the different ‘RdrNames’
121-- be used to print the actual equations because the different ‘RdrNames’
@@ -180,27 +180,26 @@ p_match' placer render style isInfix strictness m_pats GRHSs {..} = do
180 NoSrcStrict -> return ()
180 NoSrcStrict -> return ()
181 SrcStrict -> txt "!"
181 SrcStrict -> txt "!"
182 SrcLazy -> txt "~"
182 SrcLazy -> txt "~"
183− inci' <- case NE.nonEmpty m_pats of
183+ indentBody <- case NE.nonEmpty m_pats of
184− Nothing -> id <$ case style of
184+ Nothing ->
185− Function name -> p_rdrName name
185+ False <$ case style of
186− _ -> return ()
186+ Function name -> p_rdrName name
187 Just ne_pats -> do
188 Just ne_pats -> do
188− let combinedSpans =
189+ let combinedSpans = case style of
189− combineSrcSpans' $
190+ Function name -> combineSrcSpans (getLoc name) patSpans
190− getLoc <$> ne_pats
191+ _ -> patSpans
191− inci' =
192+ patSpans = combineSrcSpans' (getLoc <$> ne_pats)
192− if isOneLineSpan combinedSpans
193+ indentBody = not (isOneLineSpan combinedSpans)
195 switchLayout [combinedSpans] $ do
194 switchLayout [combinedSpans] $ do
196− let stdCase = sep breakpoint p_pat m_pats
195+ let stdCase = sep breakpoint (located' p_pat) m_pats
197 case style of
196 case style of
198 Function name ->
197 Function name ->
199 p_infixDefHelper
198 p_infixDefHelper
201− inci'
200+ indentBody
202 (p_rdrName name)
201 (p_rdrName name)
203− (p_pat <$> m_pats)
202+ (located' p_pat <$> m_pats)
204 PatternBind -> stdCase
203 PatternBind -> stdCase
205 Case -> stdCase
204 Case -> stdCase
206 Lambda -> do
205 Lambda -> do
@@ -213,40 +212,32 @@ p_match' placer render style isInfix strictness m_pats GRHSs {..} = do
213 when needsSpace space
212 when needsSpace space
214 sitcc stdCase
213 sitcc stdCase
215 LambdaCase -> stdCase
214 LambdaCase -> stdCase
216− return inci'
215+ return indentBody
217 let -- Calculate position of end of patterns. This is useful when we decide
216 let -- Calculate position of end of patterns. This is useful when we decide
218 -- about putting certain constructions in hanging positions.
217 -- about putting certain constructions in hanging positions.
219 endOfPats = case NE.nonEmpty m_pats of
218 endOfPats = case NE.nonEmpty m_pats of
220 Nothing -> case style of
219 Nothing -> case style of
221− Function name -> (Just . srcSpanEnd . getLoc) name
220+ Function name -> Just (getLoc name)
222 _ -> Nothing
221 _ -> Nothing
223− Just pats -> (Just . srcSpanEnd . getLoc . NE.last) pats
222+ Just pats -> (Just . getLoc . NE.last) pats
224 isCase = \case
223 isCase = \case
225 Case -> True
224 Case -> True
226 LambdaCase -> True
225 LambdaCase -> True
227 _ -> False
226 _ -> False
228− let hasGuards = withGuards grhssGRHSs
227+ hasGuards = withGuards grhssGRHSs
229− unless (length grhssGRHSs > 1) $
228+ grhssSpan =
231− Function _ | hasGuards -> return ()
232− Function _ -> space >> txt "="
233− PatternBind -> space >> txt "="
234− s | isCase s && hasGuards -> return ()
235− _ -> space >> txt "->"
237 combineSrcSpans' $
229 combineSrcSpans' $
238 getGRHSSpan . unLoc <$> NE.fromList grhssGRHSs
230 getGRHSSpan . unLoc <$> NE.fromList grhssGRHSs
239 patGrhssSpan =
231 patGrhssSpan =
241 grhssSpan
233 grhssSpan
242− (combineSrcSpans grhssSpan . srcLocSpan)
234+ (combineSrcSpans grhssSpan . srcLocSpan . srcSpanEnd)
243 endOfPats
235 endOfPats
244 placement =
236 placement =
245 case endOfPats of
237 case endOfPats of
246 Nothing -> blockPlacement placer grhssGRHSs
238 Nothing -> blockPlacement placer grhssGRHSs
247 Just spn ->
239 Just spn ->
248− if isOneLineSpan
240+ if onTheSameLine spn grhssSpan
249− (mkSrcSpan spn (srcSpanStart grhssSpan))
250 then blockPlacement placer grhssGRHSs
241 then blockPlacement placer grhssGRHSs
251 else Normal
242 else Normal
252 p_body = do
243 p_body = do
@@ -262,11 +253,18 @@ p_match' placer render style isInfix strictness m_pats GRHSs {..} = do
262 txt "where"
253 txt "where"
263 unless whereIsEmpty breakpoint
254 unless whereIsEmpty breakpoint
264 inci $ located grhssLocalBinds p_hsLocalBinds
255 inci $ located grhssLocalBinds p_hsLocalBinds
265− inci' $ do
256+ inciIf indentBody $ do
257+ unless (length grhssGRHSs > 1) $
259+ Function _ | hasGuards -> return ()
260+ Function _ -> space >> inci equals
261+ PatternBind -> space >> inci equals
262+ s | isCase s && hasGuards -> return ()
263+ _ -> space >> txt "->"
266 switchLayout [patGrhssSpan] $
264 switchLayout [patGrhssSpan] $
267 placeHanging placement p_body
265 placeHanging placement p_body
268 inci p_where
266 inci p_where
269−p_match' _ _ _ _ _ _ XGRHSs {} = notImplemented "XGRHSs"
267+p_match' _ _ _ _ _ _ (XGRHSs x) = noExtCon x
271p_grhs :: GroupStyle -> GRHS GhcPs (LHsExpr GhcPs) -> R ()
269p_grhs :: GroupStyle -> GRHS GhcPs (LHsExpr GhcPs) -> R ()
272p_grhs = p_grhs' exprPlacement p_hsExpr
270p_grhs = p_grhs' exprPlacement p_hsExpr
@@ -280,79 +278,109 @@ p_grhs' ::
280 GroupStyle ->
278 GroupStyle ->
281 GRHS GhcPs (Located body) ->
279 GRHS GhcPs (Located body) ->
283−p_grhs' placer render style (GRHS NoExt guards body) =
281+p_grhs' placer render style (GRHS NoExtField guards body) =
284 case guards of
282 case guards of
285 [] -> p_body
283 [] -> p_body
289− sitcc (sep (comma >> breakpoint) (sitcc . located' p_stmt) xs)
287+ sitcc (sep commaDel (sitcc . located' p_stmt) xs)
291− txt $ case style of
289+ inci $ case style of
292− EqualSign -> "="
290+ EqualSign -> equals
293− RightArrow -> "->"
291+ RightArrow -> txt "->"
294 placeHanging placement p_body
292 placeHanging placement p_body
296 placement =
294 placement =
297 case endOfGuards of
295 case endOfGuards of
298 Nothing -> placer (unLoc body)
296 Nothing -> placer (unLoc body)
299 Just spn ->
297 Just spn ->
300− if isOneLineSpan (mkSrcSpan spn (srcSpanStart (getLoc body)))
298+ if onTheSameLine spn (getLoc body)
301 then placer (unLoc body)
299 then placer (unLoc body)
302 else Normal
300 else Normal
303 endOfGuards =
301 endOfGuards =
304 case NE.nonEmpty guards of
302 case NE.nonEmpty guards of
305 Nothing -> Nothing
303 Nothing -> Nothing
306− Just gs -> (Just . srcSpanEnd . getLoc . NE.last) gs
304+ Just gs -> (Just . getLoc . NE.last) gs
307 p_body = located body render
305 p_body = located body render
308−p_grhs' _ _ _ (XGRHS NoExt) = notImplemented "XGRHS"
306+p_grhs' _ _ _ (XGRHS x) = noExtCon x
310p_hsCmd :: HsCmd GhcPs -> R ()
308p_hsCmd :: HsCmd GhcPs -> R ()
311p_hsCmd = \case
309p_hsCmd = \case
312− HsCmdArrApp NoExt body input arrType _ -> do
310+ HsCmdArrApp NoExtField body input arrType _ -> do
313 located body p_hsExpr
311 located body p_hsExpr
314− space
312+ breakpoint
315− case arrType of
313+ inci $ do
316− HsFirstOrderApp -> txt "-<"
314+ case arrType of
317− HsHigherOrderApp -> txt "-<<"
315+ HsFirstOrderApp -> txt "-<"
318− placeHanging (exprPlacement (unLoc input)) $
316+ HsHigherOrderApp -> txt "-<<"
319− located input p_hsExpr
317+ placeHanging (exprPlacement (unLoc input)) $
320− HsCmdArrForm NoExt form Prefix _ cmds -> banana $ sitcc $ do
318+ located input p_hsExpr
319+ HsCmdArrForm NoExtField form Prefix _ cmds -> banana $ do
321 located form p_hsExpr
320 located form p_hsExpr
322 unless (null cmds) $ do
321 unless (null cmds) $ do
323 breakpoint
322 breakpoint
324 inci (sequence_ (intersperse breakpoint (located' p_hsCmdTop <$> cmds)))
323 inci (sequence_ (intersperse breakpoint (located' p_hsCmdTop <$> cmds)))
325− HsCmdArrForm NoExt form Infix _ [left, right] -> do
324+ HsCmdArrForm NoExtField form Infix _ [left, right] -> do
326 located left p_hsCmdTop
325 located left p_hsCmdTop
328 located form p_hsExpr
327 located form p_hsExpr
329 placeHanging (cmdTopPlacement (unLoc right)) $
328 placeHanging (cmdTopPlacement (unLoc right)) $
330 located right p_hsCmdTop
329 located right p_hsCmdTop
331− HsCmdArrForm NoExt _ Infix _ _ -> notImplemented "HsCmdArrForm"
330+ HsCmdArrForm NoExtField _ Infix _ _ -> notImplemented "HsCmdArrForm"
332 HsCmdApp {} ->
331 HsCmdApp {} ->
333 -- XXX Does this ever occur in the syntax tree? It does not seem like it
332 -- XXX Does this ever occur in the syntax tree? It does not seem like it
334 -- does. Open an issue and ping @yumiova if this ever occurs in output.
333 -- does. Open an issue and ping @yumiova if this ever occurs in output.
335 notImplemented "HsCmdApp"
334 notImplemented "HsCmdApp"
336− HsCmdLam NoExt mgroup -> p_matchGroup' cmdPlacement p_hsCmd Lambda mgroup
335+ HsCmdLam NoExtField mgroup -> p_matchGroup' cmdPlacement p_hsCmd Lambda mgroup
337− HsCmdPar NoExt c -> parens N (located c p_hsCmd)
336+ HsCmdPar NoExtField c -> parens N (located c p_hsCmd)
338− HsCmdCase NoExt e mgroup ->
337+ HsCmdCase NoExtField e mgroup ->
339 p_case cmdPlacement p_hsCmd e mgroup
338 p_case cmdPlacement p_hsCmd e mgroup
340− HsCmdIf NoExt _ if' then' else' ->
339+ HsCmdIf NoExtField _ if' then' else' ->
341 p_if cmdPlacement p_hsCmd if' then' else'
340 p_if cmdPlacement p_hsCmd if' then' else'
342− HsCmdLet NoExt localBinds c ->
341+ HsCmdLet NoExtField localBinds c ->
343 p_let p_hsCmd localBinds c
342 p_let p_hsCmd localBinds c
344− HsCmdDo NoExt es -> do
343+ HsCmdDo NoExtField es -> do
347 inci . located es $
346 inci . located es $
348− sitcc . sep newline (located' (sitcc . p_stmt' cmdPlacement p_hsCmd))
347+ sitcc . sep newline (sitcc . withSpacing (p_stmt' cmdPlacement p_hsCmd))
349 HsCmdWrap {} -> notImplemented "HsCmdWrap"
348 HsCmdWrap {} -> notImplemented "HsCmdWrap"
350− XCmd {} -> notImplemented "XCmd"
349+ XCmd x -> noExtCon x
352p_hsCmdTop :: HsCmdTop GhcPs -> R ()
351p_hsCmdTop :: HsCmdTop GhcPs -> R ()
353p_hsCmdTop = \case
352p_hsCmdTop = \case
354− HsCmdTop NoExt cmd -> located cmd p_hsCmd
353+ HsCmdTop NoExtField cmd -> located cmd p_hsCmd
355− XCmdTop {} -> notImplemented "XHsCmdTop"
354+ XCmdTop x -> noExtCon x
356+-- | Render an expression preserving blank lines between such consecutive
357+-- expressions found in the original source code.
359+ -- | Rendering function
361+ -- | Entity to render
364+withSpacing f l = located l $ \x -> do
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
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)
357p_stmt :: Stmt GhcPs (LHsExpr GhcPs) -> R ()
385p_stmt :: Stmt GhcPs (LHsExpr GhcPs) -> R ()
358p_stmt = p_stmt' exprPlacement p_hsExpr
386p_stmt = p_stmt' exprPlacement p_hsExpr
@@ -367,16 +395,13 @@ p_stmt' ::
367 Stmt GhcPs (Located body) ->
395 Stmt GhcPs (Located body) ->
369p_stmt' placer render = \case
397p_stmt' placer render = \case
370− LastStmt NoExt body _ _ -> located body render
398+ LastStmt NoExtField body _ _ -> located body render
371− BindStmt NoExt p f _ _ -> do
399+ BindStmt NoExtField p f _ _ -> do
372− p_pat p
400+ located p p_pat
375− -- https://gitlab.haskell.org/ghc/ghc/issues/17330
403+ let loc = getLoc p
376− let loc = case p of
404+ placement =
377− XPat pat -> getLoc pat
378− _ -> error "p_stmt': BindStmt: Pat does not contain a location"
380 case f of
405 case f of
381 L l' x ->
406 L l' x ->
382 if isOneLineSpan
407 if isOneLineSpan
@@ -386,8 +411,8 @@ p_stmt' placer render = \case
386 switchLayout [loc, getLoc f] $
411 switchLayout [loc, getLoc f] $
387 placeHanging placement (located f render)
412 placeHanging placement (located f render)
388 ApplicativeStmt {} -> notImplemented "ApplicativeStmt" -- generated by renamer
413 ApplicativeStmt {} -> notImplemented "ApplicativeStmt" -- generated by renamer
389− BodyStmt NoExt body _ _ -> located body render
414+ BodyStmt NoExtField body _ _ -> located body render
390− LetStmt NoExt binds -> do
415+ LetStmt NoExtField binds -> do
391 txt "let"
416 txt "let"
393 sitcc $ located binds p_hsLocalBinds
418 sitcc $ located binds p_hsLocalBinds
@@ -428,11 +453,11 @@ p_stmt' placer render = \case
428 RecStmt {..} -> do
453 RecStmt {..} -> do
429 txt "rec"
454 txt "rec"
431− sitcc $ sepSemi (located' (p_stmt' placer render)) recS_stmts
456+ sitcc $ sepSemi (withSpacing (p_stmt' placer render)) recS_stmts
432− XStmtLR {} -> notImplemented "XStmtLR"
457+ XStmtLR c -> noExtCon c
434gatherStmt :: ExprLStmt GhcPs -> [[ExprLStmt GhcPs]]
459gatherStmt :: ExprLStmt GhcPs -> [[ExprLStmt GhcPs]]
435−gatherStmt (L _ (ParStmt NoExt block _ _)) =
460+gatherStmt (L _ (ParStmt NoExtField block _ _)) =
436 foldr ((<>) . gatherStmtBlock) [] block
461 foldr ((<>) . gatherStmtBlock) [] block
437gatherStmt (L s stmt@TransStmt {..}) =
462gatherStmt (L s stmt@TransStmt {..}) =
438 foldr liftAppend [] ((gatherStmt <$> trS_stmts) <> pure [[L s stmt]])
463 foldr liftAppend [] ((gatherStmt <$> trS_stmts) <> pure [[L s stmt]])
@@ -441,46 +466,46 @@ gatherStmt stmt = [[stmt]]
441gatherStmtBlock :: ParStmtBlock GhcPs GhcPs -> [[ExprLStmt GhcPs]]
466gatherStmtBlock :: ParStmtBlock GhcPs GhcPs -> [[ExprLStmt GhcPs]]
442gatherStmtBlock (ParStmtBlock _ stmts _ _) =
467gatherStmtBlock (ParStmtBlock _ stmts _ _) =
443 foldr (liftAppend . gatherStmt) [] stmts
468 foldr (liftAppend . gatherStmt) [] stmts
444−gatherStmtBlock XParStmtBlock {} = notImplemented "XParStmtBlock"
469+gatherStmtBlock (XParStmtBlock x) = noExtCon x
446p_hsLocalBinds :: HsLocalBindsLR GhcPs GhcPs -> R ()
471p_hsLocalBinds :: HsLocalBindsLR GhcPs GhcPs -> R ()
447p_hsLocalBinds = \case
472p_hsLocalBinds = \case
448− HsValBinds NoExt (ValBinds NoExt bag lsigs) -> do
473+ HsValBinds NoExtField (ValBinds NoExtField bag lsigs) -> do
451− (srcSpanStart . getLoc)
452− (srcSpanStart . getLoc)
454− (Left <$> bagToList bag) ++ (Right <$> lsigs)
455− p_item (Left x) = located x p_valDecl
456− p_item (Right x) = located x p_sigDecl
457− -- Assigns 'False' to the last element, 'True' to the rest.
458− markInit :: [a] -> [(Bool, a)]
460− markInit [x] = [(False, x)]
461− markInit (x : xs) = (True, x) : markInit xs
462 -- When in a single-line layout, there is a chance that the inner
474 -- When in a single-line layout, there is a chance that the inner
463 -- elements will also contain semicolons and they will confuse the
475 -- elements will also contain semicolons and they will confuse the
464 -- parser. so we request braces around every element except the last.
476 -- parser. so we request braces around every element except the last.
465 br <- layoutToBraces <$> getLayout
477 br <- layoutToBraces <$> getLayout
466− sitcc $
478+ let items =
467− sepSemi
479+ let injectLeft (L l x) = L l (Left x)
468− (\(m, i) -> (if m then br else id) $ p_item i)
480+ injectRight (L l x) = L l (Right x)
469− (markInit $ sortOn ssStart items)
481+ in (injectLeft <$> bagToList bag) ++ (injectRight <$> lsigs)
470− HsValBinds NoExt _ -> notImplemented "HsValBinds"
482+ positionToBracing = \case
471− HsIPBinds NoExt (IPBinds NoExt xs) ->
483+ SinglePos -> id
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) ->
472 -- Second argument of IPBind is always Left before type-checking.
494 -- Second argument of IPBind is always Left before type-checking.
473− let p_ipBind (IPBind NoExt (Left name) expr) = do
495+ let p_ipBind (IPBind NoExtField (Left name) expr) = do
474 atom name
496 atom name
477 breakpoint
499 breakpoint
478 useBraces $ inci $ located expr p_hsExpr
500 useBraces $ inci $ located expr p_hsExpr
479− p_ipBind _ = notImplemented "XHsIPBinds"
501+ p_ipBind (IPBind NoExtField (Right _) _) =
502+ -- Should only occur after the type checker
503+ notImplemented "IPBind _ (Right _) _"
504+ p_ipBind (XIPBind x) = noExtCon x
480 in sepSemi (located' p_ipBind) xs
505 in sepSemi (located' p_ipBind) xs
481− HsIPBinds NoExt _ -> notImplemented "HsIpBinds"
506+ HsIPBinds NoExtField _ -> notImplemented "HsIpBinds"
482− EmptyLocalBinds NoExt -> return ()
507+ EmptyLocalBinds NoExtField -> return ()
483− XHsLocalBindsLR _ -> notImplemented "XHsLocalBindsLR"
508+ XHsLocalBindsLR x -> noExtCon x
485p_hsRecField ::
510p_hsRecField ::
486 HsRecField' RdrName (LHsExpr GhcPs) ->
511 HsRecField' RdrName (LHsExpr GhcPs) ->
@@ -489,48 +514,45 @@ p_hsRecField HsRecField {..} = do
489 p_rdrName hsRecFieldLbl
514 p_rdrName hsRecFieldLbl
490 unless hsRecPun $ do
515 unless hsRecPun $ do
493− let placement = exprPlacement (unLoc hsRecFieldArg)
518+ let placement =
494− placeHanging placement $ located hsRecFieldArg p_hsExpr
519+ if onTheSameLine (getLoc hsRecFieldLbl) (getLoc hsRecFieldArg)
495−
520+ then exprPlacement (unLoc hsRecFieldArg)
496−p_hsTupArg :: HsTupArg GhcPs -> R ()
521+ else Normal
497−p_hsTupArg = \case
522+ placeHanging placement (located hsRecFieldArg p_hsExpr)
498− Present NoExt x -> located x p_hsExpr
499− Missing NoExt -> pure ()
500− XTupArg {} -> notImplemented "XTupArg"
502p_hsExpr :: HsExpr GhcPs -> R ()
524p_hsExpr :: HsExpr GhcPs -> R ()
503p_hsExpr = p_hsExpr' N
525p_hsExpr = p_hsExpr' N
505p_hsExpr' :: BracketStyle -> HsExpr GhcPs -> R ()
527p_hsExpr' :: BracketStyle -> HsExpr GhcPs -> R ()
506p_hsExpr' s = \case
528p_hsExpr' s = \case
507− HsVar NoExt name -> p_rdrName name
529+ HsVar NoExtField name -> p_rdrName name
508− HsUnboundVar NoExt _ -> notImplemented "HsUnboundVar"
530+ HsUnboundVar NoExtField v -> atom (unboundVarOcc v)
509− HsConLikeOut NoExt _ -> notImplemented "HsConLikeOut"
531+ HsConLikeOut NoExtField _ -> notImplemented "HsConLikeOut"
510− HsRecFld NoExt x ->
532+ HsRecFld NoExtField x ->
511 case x of
533 case x of
512− Unambiguous NoExt name -> p_rdrName name
534+ Unambiguous NoExtField name -> p_rdrName name
513− Ambiguous NoExt name -> p_rdrName name
535+ Ambiguous NoExtField name -> p_rdrName name
514− XAmbiguousFieldOcc NoExt -> notImplemented "XAmbiguousFieldOcc"
536+ XAmbiguousFieldOcc xx -> noExtCon xx
515− HsOverLabel NoExt _ v -> do
537+ HsOverLabel NoExtField _ v -> do
518− HsIPVar NoExt (HsIPName name) -> do
540+ HsIPVar NoExtField (HsIPName name) -> do
520 atom name
542 atom name
521− HsOverLit NoExt v -> atom (ol_val v)
543+ HsOverLit NoExtField v -> atom (ol_val v)
522− HsLit NoExt lit ->
544+ HsLit NoExtField lit ->
523 case lit of
545 case lit of
524 HsString (SourceText stxt) _ -> p_stringLit stxt
546 HsString (SourceText stxt) _ -> p_stringLit stxt
525 HsStringPrim (SourceText stxt) _ -> p_stringLit stxt
547 HsStringPrim (SourceText stxt) _ -> p_stringLit stxt
526 r -> atom r
548 r -> atom r
527− HsLam NoExt mgroup ->
549+ HsLam NoExtField mgroup ->
528 p_matchGroup Lambda mgroup
550 p_matchGroup Lambda mgroup
529− HsLamCase NoExt mgroup -> do
551+ HsLamCase NoExtField mgroup -> do
530 txt "\\case"
552 txt "\\case"
531 breakpoint
553 breakpoint
532 inci (p_matchGroup LambdaCase mgroup)
554 inci (p_matchGroup LambdaCase mgroup)
533− HsApp NoExt f x -> do
555+ HsApp NoExtField f x -> do
534 let -- In order to format function applications with multiple parameters
556 let -- In order to format function applications with multiple parameters
535 -- nicer, traverse the AST to gather the function and all the
557 -- nicer, traverse the AST to gather the function and all the
536 -- parameters together.
558 -- parameters together.
@@ -562,23 +584,21 @@ p_hsExpr' s = \case
562 -- do-block or case expression it is not a good idea. It seems
584 -- do-block or case expression it is not a good idea. It seems
563 -- to be safe to always bump indentation when the function
585 -- to be safe to always bump indentation when the function
564 -- expression is parenthesised.
586 -- expression is parenthesised.
565− indent =
587+ doIndent =
566 case func of
588 case func of
567− L _ (HsPar NoExt _) -> inci
589+ L _ (HsPar NoExtField _) -> True
568− L _ (HsAppType NoExt _ _) -> inci
590+ L _ (HsAppType NoExtField _ _) -> True
569− L _ (HsMultiIf NoExt _) -> inci
591+ L _ (HsMultiIf NoExtField _) -> True
570− L spn _ ->
592+ L spn _ -> isOneLineSpan spn
571− if isOneLineSpan spn
593+ ub <-
572− then inci
594+ getLayout <&> \case
573− else id
595+ SingleLine -> useBraces
574− ub <- getLayout <&> \case
596+ MultiLine -> id
575− SingleLine -> useBraces
578 located func (p_hsExpr' s)
598 located func (p_hsExpr' s)
579 breakpoint
599 breakpoint
580− indent $ sep breakpoint (located' p_hsExpr) initp
600+ inciIf doIndent $ sep breakpoint (located' p_hsExpr) initp
581− indent $ do
601+ inciIf doIndent $ do
582 unless (null initp) breakpoint
602 unless (null initp) breakpoint
583 located lastp p_hsExpr
603 located lastp p_hsExpr
584 Hanging -> do
604 Hanging -> do
@@ -588,76 +608,87 @@ p_hsExpr' s = \case
588 sep breakpoint (located' p_hsExpr) initp
608 sep breakpoint (located' p_hsExpr) initp
589 placeHanging placement $
609 placeHanging placement $
590 located lastp p_hsExpr
610 located lastp p_hsExpr
591− HsAppType NoExt e a -> do
611+ HsAppType NoExtField e a -> do
592 located e p_hsExpr
612 located e p_hsExpr
593 breakpoint
613 breakpoint
594 inci $ do
614 inci $ do
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
596 located (hswc_body a) p_hsType
621 located (hswc_body a) p_hsType
597− OpApp NoExt x op y -> do
622+ OpApp NoExtField x op y -> do
598 let opTree = OpBranch (exprOpTree x) op (exprOpTree y)
623 let opTree = OpBranch (exprOpTree x) op (exprOpTree y)
599− p_exprOpTree True s (reassociateOpTree getOpName opTree)
624+ p_exprOpTree s (reassociateOpTree getOpName opTree)
600− NegApp NoExt e _ -> do
625+ NegApp NoExtField e _ -> do
603 located e p_hsExpr
628 located e p_hsExpr
604− HsPar NoExt e ->
629+ HsPar NoExtField e ->
605 parens s (located e (dontUseBraces . p_hsExpr))
630 parens s (located e (dontUseBraces . p_hsExpr))
606− SectionL NoExt x op -> do
631+ SectionL NoExtField x op -> do
607 located x p_hsExpr
632 located x p_hsExpr
608 breakpoint
633 breakpoint
609 inci (located op p_hsExpr)
634 inci (located op p_hsExpr)
610− SectionR NoExt op x -> do
635+ SectionR NoExtField op x -> do
611 located op p_hsExpr
636 located op p_hsExpr
612 useRecordDot' <- useRecordDot
637 useRecordDot' <- useRecordDot
613 let isRecordDot' = isRecordDot (unLoc op) (getLoc x)
638 let isRecordDot' = isRecordDot (unLoc op) (getLoc x)
614 unless (useRecordDot' && isRecordDot') breakpoint
639 unless (useRecordDot' && isRecordDot') breakpoint
615 inci (located x p_hsExpr)
640 inci (located x p_hsExpr)
616− ExplicitTuple NoExt args boxity -> do
641+ ExplicitTuple NoExtField args boxity ->
617 let isSection = any (isMissing . unLoc) args
642 let isSection = any (isMissing . unLoc) args
618 isMissing = \case
643 isMissing = \case
619− Missing NoExt -> True
644+ Missing NoExtField -> True
620 _ -> False
645 _ -> False
621− let parens' =
646+ p_arg = \case
647+ Present NoExtField x -> located x p_hsExpr
648+ Missing NoExtField -> pure ()
649+ XTupArg x -> noExtCon x
650+ p_larg = sitcc . located' p_arg
622 case boxity of
652 case boxity of
623 Boxed -> parens
653 Boxed -> parens
624 Unboxed -> parensHash
654 Unboxed -> parensHash
625− if isSection
655+ in if isSection
627− switchLayout [] . parens' s $
657+ switchLayout [] . parens' s $
628− sep comma (located' p_hsTupArg) args
658+ sep comma p_larg args
630− switchLayout (getLoc <$> args) . parens' s . sitcc $
660+ switchLayout (getLoc <$> args) . parens' s $
631− sep (comma >> breakpoint) (sitcc . located' p_hsTupArg) args
661+ sep commaDel p_larg args
632− ExplicitSum NoExt tag arity e ->
662+ ExplicitSum NoExtField tag arity e ->
633 p_unboxedSum N tag arity (located e p_hsExpr)
663 p_unboxedSum N tag arity (located e p_hsExpr)
634− HsCase NoExt e mgroup ->
664+ HsCase NoExtField e mgroup ->
635 p_case exprPlacement p_hsExpr e mgroup
665 p_case exprPlacement p_hsExpr e mgroup
636− HsIf NoExt _ if' then' else' ->
666+ HsIf NoExtField _ if' then' else' ->
637 p_if exprPlacement p_hsExpr if' then' else'
667 p_if exprPlacement p_hsExpr if' then' else'
638− HsMultiIf NoExt guards -> do
668+ HsMultiIf NoExtField guards -> do
639− txt "if "
669+ txt "if"
640− inci . inci . sitcc $ sep newline (located' (p_grhs RightArrow)) guards
670+ breakpoint
641− HsLet NoExt localBinds e ->
671+ inci . inci $ sep newline (located' (p_grhs RightArrow)) guards
672+ HsLet NoExtField localBinds e ->
642 p_let p_hsExpr localBinds e
673 p_let p_hsExpr localBinds e
643− HsDo NoExt ctx es -> do
674+ HsDo NoExtField ctx es -> do
644 let doBody header = do
675 let doBody header = do
645 txt header
676 txt header
646 breakpoint
677 breakpoint
647 ub <- layoutToBraces <$> getLayout
678 ub <- layoutToBraces <$> getLayout
650− (located' (ub . p_stmt' exprPlacement (p_hsExpr' S)))
681+ (ub . withSpacing (p_stmt' exprPlacement (p_hsExpr' S)))
651 (unLoc es)
682 (unLoc es)
652− compBody = brackets N $ located es $ \xs -> do
683+ compBody = brackets N . located es $ \xs -> do
653 let p_parBody =
684 let p_parBody =
655− (breakpoint >> txt "| ")
686+ (breakpoint >> txt "|" >> space)
656 p_seqBody
687 p_seqBody
657 p_seqBody =
688 p_seqBody =
660− (comma >> breakpoint)
691+ commaDel
661 (located' (sitcc . p_stmt))
692 (located' (sitcc . p_stmt))
662 stmts = init xs
693 stmts = init xs
663 yield = last xs
694 yield = last xs
@@ -678,90 +709,96 @@ p_hsExpr' s = \case
678 ParStmtCtxt _ -> notImplemented "ParStmtCtxt"
709 ParStmtCtxt _ -> notImplemented "ParStmtCtxt"
679 TransStmtCtxt _ -> notImplemented "TransStmtCtxt"
710 TransStmtCtxt _ -> notImplemented "TransStmtCtxt"
680 ExplicitList _ _ xs ->
711 ExplicitList _ _ xs ->
681− brackets s . sitcc $
712+ brackets s $
682− sep (comma >> breakpoint) (sitcc . located' p_hsExpr) xs
713+ sep commaDel (sitcc . located' p_hsExpr) xs
683 RecordCon {..} -> do
714 RecordCon {..} -> do
684 located rcon_con_name atom
715 located rcon_con_name atom
685 breakpoint
716 breakpoint
686 let HsRecFields {..} = rcon_flds
717 let HsRecFields {..} = rcon_flds
687 updName f =
718 updName f =
688− f
719+ (f :: HsRecField GhcPs (LHsExpr GhcPs))
689 { hsRecFieldLbl = case unLoc $ hsRecFieldLbl f of
720 { hsRecFieldLbl = case unLoc $ hsRecFieldLbl f of
690 FieldOcc _ n -> n
721 FieldOcc _ n -> n
691− XFieldOcc _ -> notImplemented "XFieldOcc"
722+ XFieldOcc x -> noExtCon x
693 fields = located' (p_hsRecField . updName) <$> rec_flds
724 fields = located' (p_hsRecField . updName) <$> rec_flds
695 case rec_dotdot of
726 case rec_dotdot of
696 Just {} -> [txt ".."]
727 Just {} -> [txt ".."]
697 Nothing -> []
728 Nothing -> []
698− inci . braces N . sitcc $
729+ inci . braces N $
699− sep (comma >> breakpoint) sitcc (fields <> dotdot)
730+ sep commaDel sitcc (fields <> dotdot)
700 RecordUpd {..} -> do
731 RecordUpd {..} -> do
701 located rupd_expr p_hsExpr
732 located rupd_expr p_hsExpr
702− breakpoint
733+ useRecordDot' <- useRecordDot
734+ let mrs sp = case getLoc sp of
735+ RealSrcSpan r -> Just r
738+ ((1 +) . srcSpanEndCol <$> mrs rupd_expr)
739+ == (srcSpanStartCol <$> mrs (head rupd_flds))
740+ unless (useRecordDot' && isPluginForm) breakpoint
703 let updName f =
741 let updName f =
704− f
742+ (f :: HsRecUpdField GhcPs)
705 { hsRecFieldLbl = case unLoc $ hsRecFieldLbl f of
743 { hsRecFieldLbl = case unLoc $ hsRecFieldLbl f of
706 Ambiguous _ n -> n
744 Ambiguous _ n -> n
707 Unambiguous _ n -> n
745 Unambiguous _ n -> n
708− XAmbiguousFieldOcc _ -> notImplemented "XAmbiguousFieldOcc"
746+ XAmbiguousFieldOcc x -> noExtCon x
710− inci . braces N . sitcc $
748+ inci . braces N $
712− (comma >> breakpoint)
750+ commaDel
713 (sitcc . located' (p_hsRecField . updName))
751 (sitcc . located' (p_hsRecField . updName))
714 rupd_flds
752 rupd_flds
715− ExprWithTySig NoExt x HsWC {hswc_body = HsIB {..}} -> sitcc $ do
753+ ExprWithTySig NoExtField x HsWC {hswc_body = HsIB {..}} -> sitcc $ do
716 located x p_hsExpr
754 located x p_hsExpr
719 breakpoint
757 breakpoint
720 inci $ located hsib_body p_hsType
758 inci $ located hsib_body p_hsType
721− ExprWithTySig NoExt _ HsWC {hswc_body = XHsImplicitBndrs {}} ->
759+ ExprWithTySig NoExtField _ HsWC {hswc_body = XHsImplicitBndrs x} -> noExtCon x
722− notImplemented "XHsImplicitBndrs"
760+ ExprWithTySig NoExtField _ (XHsWildCardBndrs x) -> noExtCon x
723− ExprWithTySig NoExt _ XHsWildCardBndrs {} -> notImplemented "XHsWildCardBndrs"
761+ ArithSeq NoExtField _ x ->
724− ArithSeq NoExt _ x ->
725 case x of
762 case x of
726− From from -> brackets s . sitcc $ do
763+ From from -> brackets s $ do
727 located from p_hsExpr
764 located from p_hsExpr
728 breakpoint
765 breakpoint
730− FromThen from next -> brackets s . sitcc $ do
767+ FromThen from next -> brackets s $ do
731− sitcc $ sep (comma >> breakpoint) (located' p_hsExpr) [from, next]
768+ sep commaDel (located' p_hsExpr) [from, next]
732 breakpoint
769 breakpoint
734− FromTo from to -> brackets s . sitcc $ do
771+ FromTo from to -> brackets s $ do
735 located from p_hsExpr
772 located from p_hsExpr
736 breakpoint
773 breakpoint
739 located to p_hsExpr
776 located to p_hsExpr
740− FromThenTo from next to -> brackets s . sitcc $ do
777+ FromThenTo from next to -> brackets s $ do
741− sitcc $ sep (comma >> breakpoint) (located' p_hsExpr) [from, next]
778+ sep commaDel (located' p_hsExpr) [from, next]
742 breakpoint
779 breakpoint
745 located to p_hsExpr
782 located to p_hsExpr
746− HsSCC NoExt _ name x -> do
783+ HsSCC NoExtField _ name x -> do
747 txt "{-# SCC "
784 txt "{-# SCC "
748 atom name
785 atom name
749 txt " #-}"
786 txt " #-}"
750 breakpoint
787 breakpoint
751 located x p_hsExpr
788 located x p_hsExpr
752− HsCoreAnn NoExt _ value x -> do
789+ HsCoreAnn NoExtField _ value x -> do
753 txt "{-# CORE "
790 txt "{-# CORE "
754 atom value
791 atom value
755 txt " #-}"
792 txt " #-}"
756 breakpoint
793 breakpoint
757 located x p_hsExpr
794 located x p_hsExpr
758− HsBracket NoExt x -> p_hsBracket x
795+ HsBracket NoExtField x -> p_hsBracket x
759 HsRnBracketOut {} -> notImplemented "HsRnBracketOut"
796 HsRnBracketOut {} -> notImplemented "HsRnBracketOut"
760 HsTcBracketOut {} -> notImplemented "HsTcBracketOut"
797 HsTcBracketOut {} -> notImplemented "HsTcBracketOut"
761− HsSpliceE NoExt splice -> p_hsSplice splice
798+ HsSpliceE NoExtField splice -> p_hsSplice splice
762− HsProc NoExt p e -> do
799+ HsProc NoExtField p e -> do
763 txt "proc"
800 txt "proc"
764− locatedPat p $ \x -> do
801+ located p $ \x -> do
765 breakpoint
802 breakpoint
766 inci (p_pat x)
803 inci (p_pat x)
767 breakpoint
804 breakpoint
@@ -772,31 +809,11 @@ p_hsExpr' s = \case
772 txt "static"
809 txt "static"
773 breakpoint
810 breakpoint
774 inci (located e p_hsExpr)
811 inci (located e p_hsExpr)
775− HsArrApp NoExt body input arrType cond ->
776− p_hsCmd (HsCmdArrApp NoExt body input arrType cond)
777− HsArrForm NoExt form mfixity cmds ->
778− p_hsCmd (HsCmdArrForm NoExt form Prefix mfixity cmds)
779 HsTick {} -> notImplemented "HsTick"
812 HsTick {} -> notImplemented "HsTick"
780 HsBinTick {} -> notImplemented "HsBinTick"
813 HsBinTick {} -> notImplemented "HsBinTick"
781 HsTickPragma {} -> notImplemented "HsTickPragma"
814 HsTickPragma {} -> notImplemented "HsTickPragma"
782− -- These four constructs should never appear in correct programs.
783− -- See: https://github.com/tweag/ormolu/issues/343
784− EWildPat NoExt -> txt "_"
785− EAsPat NoExt n p -> do
789− EViewPat NoExt p e -> do
794− inci (located e p_hsExpr)
795− ELazyPat NoExt p -> do
798 HsWrap {} -> notImplemented "HsWrap"
815 HsWrap {} -> notImplemented "HsWrap"
799− XExpr {} -> notImplemented "XExpr"
816+ XExpr x -> noExtCon x
801p_patSynBind :: PatSynBind GhcPs GhcPs -> R ()
818p_patSynBind :: PatSynBind GhcPs GhcPs -> R ()
802p_patSynBind PSB {..} = do
819p_patSynBind PSB {..} = do
@@ -806,15 +823,15 @@ p_patSynBind PSB {..} = do
806 Unidirectional -> do
823 Unidirectional -> do
808 breakpoint
825 breakpoint
809− p_pat psb_def
826+ located psb_def p_pat
810 ImplicitBidirectional -> do
827 ImplicitBidirectional -> do
812 breakpoint
829 breakpoint
813− p_pat psb_def
830+ located psb_def p_pat
814 ExplicitBidirectional mgroup -> do
831 ExplicitBidirectional mgroup -> do
816 breakpoint
833 breakpoint
817− p_pat psb_def
834+ located psb_def p_pat
819 txt "where"
836 txt "where"
@@ -835,8 +852,8 @@ p_patSynBind PSB {..} = do
835 inci $ do
852 inci $ do
836 switchLayout (getLoc . recordPatSynPatVar <$> xs) $ do
853 switchLayout (getLoc . recordPatSynPatVar <$> xs) $ do
837 unless (null xs) breakpoint
854 unless (null xs) breakpoint
838− braces N . sitcc $
855+ braces N $
839− sep (comma >> breakpoint) (p_rdrName . recordPatSynPatVar) xs
856+ sep commaDel (p_rdrName . recordPatSynPatVar) xs
841 InfixCon l r -> do
858 InfixCon l r -> do
842 switchLayout [getLoc l, getLoc r] $ do
859 switchLayout [getLoc l, getLoc r] $ do
@@ -848,7 +865,7 @@ p_patSynBind PSB {..} = do
849 p_rdrName r
866 p_rdrName r
851−p_patSynBind (XPatSynBind NoExt) = notImplemented "XPatSynBind"
868+p_patSynBind (XPatSynBind x) = noExtCon x
854 Data body =>
871 Data body =>
@@ -890,10 +907,12 @@ p_if placer render if' then' else' = do
890 breakpoint
907 breakpoint
891 inci $ do
908 inci $ do
892 txt "then"
909 txt "then"
893 located then' $ \x ->
911 located then' $ \x ->
894 placeHanging (placer x) (render x)
912 placeHanging (placer x) (render x)
895 breakpoint
913 breakpoint
896 txt "else"
914 txt "else"
897 located else' $ \x ->
916 located else' $ \x ->
898 placeHanging (placer x) (render x)
917 placeHanging (placer x) (render x)
@@ -915,77 +934,77 @@ p_let render localBinds e = sitcc $ do
916p_pat :: Pat GhcPs -> R ()
935p_pat :: Pat GhcPs -> R ()
917p_pat = \case
936p_pat = \case
918− -- Note: starting from GHC 8.8, 'LPat' == 'Pat'. Located 'Pat's are always
937+ WildPat NoExtField -> txt "_"
919− -- constructed with the 'XPat' constructor, containing a @Located Pat@.
938+ VarPat NoExtField name -> p_rdrName name
920− XPat pat -> located pat p_pat
939+ LazyPat NoExtField pat -> do
921− WildPat NoExt -> txt "_"
922− VarPat NoExt name -> p_rdrName name
923− LazyPat NoExt pat -> do
925− p_pat pat
941+ located pat p_pat
926− AsPat NoExt name pat -> do
942+ AsPat NoExtField name pat -> do
927 p_rdrName name
943 p_rdrName name
929− p_pat pat
945+ located pat p_pat
930− ParPat NoExt pat ->
946+ ParPat NoExtField pat ->
931− locatedPat pat (parens S . p_pat)
947+ located pat (parens S . p_pat)
932− BangPat NoExt pat -> do
948+ BangPat NoExtField pat -> do
934− p_pat pat
950+ located pat p_pat
935− ListPat NoExt pats ->
951+ ListPat NoExtField pats ->
936− brackets S . sitcc $ sep (comma >> breakpoint) p_pat pats
952+ brackets S $ sep commaDel (located' p_pat) pats
937− TuplePat NoExt pats boxing -> do
953+ TuplePat NoExtField pats boxing -> do
938− let f =
954+ let parens' =
939 case boxing of
955 case boxing of
940 Boxed -> parens S
956 Boxed -> parens S
941 Unboxed -> parensHash S
957 Unboxed -> parensHash S
942− f . sitcc $ sep (comma >> breakpoint) (sitcc . p_pat) pats
958+ parens' $ sep commaDel (sitcc . located' p_pat) pats
943− SumPat NoExt pat tag arity ->
959+ SumPat NoExtField pat tag arity ->
944− p_unboxedSum S tag arity (p_pat pat)
960+ p_unboxedSum S tag arity (located pat p_pat)
945 ConPatIn pat details ->
961 ConPatIn pat details ->
946 case details of
962 case details of
947 PrefixCon xs -> sitcc $ do
963 PrefixCon xs -> sitcc $ do
948 p_rdrName pat
964 p_rdrName pat
949 unless (null xs) $ do
965 unless (null xs) $ do
950 breakpoint
966 breakpoint
951− inci . sitcc $ sep breakpoint (sitcc . p_pat) xs
967+ inci . sitcc $ sep breakpoint (sitcc . located' p_pat) xs
952 RecCon (HsRecFields fields dotdot) -> do
968 RecCon (HsRecFields fields dotdot) -> do
953 p_rdrName pat
969 p_rdrName pat
954 breakpoint
970 breakpoint
955 let f = \case
971 let f = \case
956 Nothing -> txt ".."
972 Nothing -> txt ".."
957 Just x -> located x p_pat_hsRecField
973 Just x -> located x p_pat_hsRecField
958− inci . braces N . sitcc . sep (comma >> breakpoint) f $
974+ inci . braces N . sep commaDel f $
959 case dotdot of
975 case dotdot of
960 Nothing -> Just <$> fields
976 Nothing -> Just <$> fields
961− Just n -> (Just <$> take n fields) ++ [Nothing]
977+ Just (L _ n) -> (Just <$> take n fields) ++ [Nothing]
962− InfixCon x y -> do
978+ InfixCon l r -> do
963− p_pat x
979+ switchLayout [getLoc l, getLoc r] $ do
964− space
980+ located l p_pat
965− p_rdrName pat
981+ breakpoint
966− breakpoint
982+ inci $ do
967− inci (p_pat y)
983+ p_rdrName pat
968 ConPatOut {} -> notImplemented "ConPatOut" -- presumably created by renamer?
986 ConPatOut {} -> notImplemented "ConPatOut" -- presumably created by renamer?
969− ViewPat NoExt expr pat -> sitcc $ do
987+ ViewPat NoExtField expr pat -> sitcc $ do
970 located expr p_hsExpr
988 located expr p_hsExpr
973 breakpoint
991 breakpoint
974− inci (p_pat pat)
992+ inci (located pat p_pat)
975− SplicePat NoExt splice -> p_hsSplice splice
993+ SplicePat NoExtField splice -> p_hsSplice splice
976− LitPat NoExt p -> atom p
994+ LitPat NoExtField p -> atom p
977− NPat NoExt v _ _ -> located v (atom . ol_val)
995+ NPat NoExtField v _ _ -> located v (atom . ol_val)
978− NPlusKPat NoExt n k _ _ _ -> sitcc $ do
996+ NPlusKPat NoExtField n k _ _ _ -> sitcc $ do
979 p_rdrName n
997 p_rdrName n
980 breakpoint
998 breakpoint
981 inci $ do
999 inci $ do
984 located k (atom . ol_val)
1002 located k (atom . ol_val)
985− SigPat NoExt pat hswc -> do
1003+ SigPat NoExtField pat hswc -> do
986− p_pat pat
1004+ located pat p_pat
987 p_typeAscription hswc
1005 p_typeAscription hswc
988 CoPat {} -> notImplemented "CoPat" -- apparently created at some later stage
1006 CoPat {} -> notImplemented "CoPat" -- apparently created at some later stage
1007+ XPat x -> noExtCon x
990p_pat_hsRecField :: HsRecField' (FieldOcc GhcPs) (LPat GhcPs) -> R ()
1009p_pat_hsRecField :: HsRecField' (FieldOcc GhcPs) (LPat GhcPs) -> R ()
991p_pat_hsRecField HsRecField {..} = do
1010p_pat_hsRecField HsRecField {..} = do
@@ -993,32 +1012,30 @@ p_pat_hsRecField HsRecField {..} = do
993 p_rdrName (rdrNameFieldOcc x)
1012 p_rdrName (rdrNameFieldOcc x)
994 unless hsRecPun $ do
1013 unless hsRecPun $ do
997 breakpoint
1016 breakpoint
998− inci (p_pat hsRecFieldArg)
1017+ inci (located hsRecFieldArg p_pat)
1000p_unboxedSum :: BracketStyle -> ConTag -> Arity -> R () -> R ()
1019p_unboxedSum :: BracketStyle -> ConTag -> Arity -> R () -> R ()
1001p_unboxedSum s tag arity m = do
1020p_unboxedSum s tag arity m = do
1002 let before = tag - 1
1021 let before = tag - 1
1003 after = arity - before - 1
1022 after = arity - before - 1
1004 args = replicate before Nothing <> [Just m] <> replicate after Nothing
1023 args = replicate before Nothing <> [Just m] <> replicate after Nothing
1005− f (x, i) = do
1024+ f x =
1006− let isFirst = i == 0
1007− isLast = i == arity - 1
1008 case x :: Maybe (R ()) of
1025 case x :: Maybe (R ()) of
1009 Nothing ->
1026 Nothing ->
1010− unless (isFirst || isLast) space
1027+ space
1011 Just m' -> do
1028 Just m' -> do
1012− unless isFirst space
1029+ space
1014− unless isLast space
1031+ space
1015− parensHash s $ sep (txt "|") f (zip args [0 ..])
1032+ parensHash s $ sep (txt "|") f args
1017p_hsSplice :: HsSplice GhcPs -> R ()
1034p_hsSplice :: HsSplice GhcPs -> R ()
1018p_hsSplice = \case
1035p_hsSplice = \case
1019− HsTypedSplice NoExt deco _ expr -> p_hsSpliceTH True expr deco
1036+ HsTypedSplice NoExtField deco _ expr -> p_hsSpliceTH True expr deco
1020− HsUntypedSplice NoExt deco _ expr -> p_hsSpliceTH False expr deco
1037+ HsUntypedSplice NoExtField deco _ expr -> p_hsSpliceTH False expr deco
1021− HsQuasiQuote NoExt _ quoterName srcSpan str -> do
1038+ HsQuasiQuote NoExtField _ quoterName srcSpan str -> do
1023 p_rdrName (L srcSpan quoterName)
1040 p_rdrName (L srcSpan quoterName)
@@ -1028,7 +1045,7 @@ p_hsSplice = \case
1028 txt "|]"
1045 txt "|]"
1029 HsSpliced {} -> notImplemented "HsSpliced"
1046 HsSpliced {} -> notImplemented "HsSpliced"
1030 HsSplicedT {} -> notImplemented "HsSplicedT"
1047 HsSplicedT {} -> notImplemented "HsSplicedT"
1031− XSplice {} -> notImplemented "XSplice"
1048+ XSplice x -> noExtCon x
1033p_hsSpliceTH ::
1050p_hsSpliceTH ::
1034 -- | Typed splice?
1051 -- | Typed splice?
@@ -1052,17 +1069,17 @@ p_hsSpliceTH isTyped expr = \case
1053p_hsBracket :: HsBracket GhcPs -> R ()
1070p_hsBracket :: HsBracket GhcPs -> R ()
1054p_hsBracket = \case
1071p_hsBracket = \case
1055− ExpBr NoExt expr -> do
1072+ ExpBr NoExtField expr -> do
1056 anns <- getEnclosingAnns
1073 anns <- getEnclosingAnns
1057 let name = case anns of
1074 let name = case anns of
1058 AnnOpenEQ : _ -> ""
1075 AnnOpenEQ : _ -> ""
1059 _ -> "e"
1076 _ -> "e"
1060 quote name (located expr p_hsExpr)
1077 quote name (located expr p_hsExpr)
1061− PatBr NoExt pat -> quote "p" (p_pat pat)
1078+ PatBr NoExtField pat -> located pat (quote "p" . p_pat)
1062− DecBrL NoExt decls -> quote "d" (p_hsDecls Free decls)
1079+ DecBrL NoExtField decls -> quote "d" (p_hsDecls Free decls)
1063− DecBrG NoExt _ -> notImplemented "DecBrG" -- result of renamer
1080+ DecBrG NoExtField _ -> notImplemented "DecBrG" -- result of renamer
1064− TypBr NoExt ty -> quote "t" (located ty p_hsType)
1081+ TypBr NoExtField ty -> quote "t" (located ty p_hsType)
1065− VarBr NoExt isSingleQuote name -> do
1082+ VarBr NoExtField isSingleQuote name -> do
1066 txt (bool "''" "'" isSingleQuote)
1083 txt (bool "''" "'" isSingleQuote)
1067 -- HACK As you can see we use 'noLoc' here to be able to pass name into
1084 -- HACK As you can see we use 'noLoc' here to be able to pass name into
1068 -- 'p_rdrName' since the latter expects a "located" thing. The problem
1085 -- 'p_rdrName' since the latter expects a "located" thing. The problem
@@ -1077,13 +1094,13 @@ p_hsBracket = \case
1077 && not (doesNotNeedExtraParens name)
1094 && not (doesNotNeedExtraParens name)
1078 wrapper = if isOperator then parens N else id
1095 wrapper = if isOperator then parens N else id
1079 wrapper $ p_rdrName (noLoc name)
1096 wrapper $ p_rdrName (noLoc name)
1080− TExpBr NoExt expr -> do
1097+ TExpBr NoExtField expr -> do
1081 txt "[||"
1098 txt "[||"
1082 breakpoint'
1099 breakpoint'
1083 located expr p_hsExpr
1100 located expr p_hsExpr
1084 breakpoint'
1101 breakpoint'
1085 txt "||]"
1102 txt "||]"
1086− XBracket {} -> notImplemented "XBracket"
1103+ XBracket x -> noExtCon x
1088 quote :: Text -> R () -> R ()
1105 quote :: Text -> R () -> R ()
1089 quote name body = do
1106 quote name body = do
@@ -1162,9 +1179,9 @@ liftAppend (x : xs) [] = x : xs
1162liftAppend (x : xs) (y : ys) = x <> y : liftAppend xs ys
1179liftAppend (x : xs) (y : ys) = x <> y : liftAppend xs ys
1164getGRHSSpan :: GRHS GhcPs (Located body) -> SrcSpan
1181getGRHSSpan :: GRHS GhcPs (Located body) -> SrcSpan
1165−getGRHSSpan (GRHS NoExt guards body) =
1182+getGRHSSpan (GRHS NoExtField guards body) =
1166 combineSrcSpans' $ getLoc body :| map getLoc guards
1183 combineSrcSpans' $ getLoc body :| map getLoc guards
1167−getGRHSSpan (XGRHS NoExt) = notImplemented "XGRHS"
1184+getGRHSSpan (XGRHS x) = noExtCon x
1169-- | Place a thing that may have a hanging form. This function handles how
1186-- | Place a thing that may have a hanging form. This function handles how
1170-- to separate it from preceding expressions and whether to bump indentation
1187-- to separate it from preceding expressions and whether to bump indentation
@@ -1185,78 +1202,74 @@ blockPlacement ::
1185 (body -> Placement) ->
1202 (body -> Placement) ->
1186 [LGRHS GhcPs (Located body)] ->
1203 [LGRHS GhcPs (Located body)] ->
1187 Placement
1204 Placement
1188−blockPlacement placer [L _ (GRHS NoExt _ (L _ x))] = placer x
1205+blockPlacement placer [L _ (GRHS NoExtField _ (L _ x))] = placer x
1189blockPlacement _ _ = Normal
1206blockPlacement _ _ = Normal
1191-- | Check if given command has a hanging form.
1208-- | Check if given command has a hanging form.
1192cmdPlacement :: HsCmd GhcPs -> Placement
1209cmdPlacement :: HsCmd GhcPs -> Placement
1193cmdPlacement = \case
1210cmdPlacement = \case
1194− HsCmdLam NoExt _ -> Hanging
1211+ HsCmdLam NoExtField _ -> Hanging
1195− HsCmdCase NoExt _ _ -> Hanging
1212+ HsCmdCase NoExtField _ _ -> Hanging
1196− HsCmdDo NoExt _ -> Hanging
1213+ HsCmdDo NoExtField _ -> Hanging
1197 _ -> Normal
1214 _ -> Normal
1199cmdTopPlacement :: HsCmdTop GhcPs -> Placement
1216cmdTopPlacement :: HsCmdTop GhcPs -> Placement
1200cmdTopPlacement = \case
1217cmdTopPlacement = \case
1201− HsCmdTop NoExt (L _ x) -> cmdPlacement x
1218+ HsCmdTop NoExtField (L _ x) -> cmdPlacement x
1202− XCmdTop {} -> notImplemented "XCmdTop"
1219+ XCmdTop x -> noExtCon x
1204-- | Check if given expression has a hanging form.
1221-- | Check if given expression has a hanging form.
1205exprPlacement :: HsExpr GhcPs -> Placement
1222exprPlacement :: HsExpr GhcPs -> Placement
1206exprPlacement = \case
1223exprPlacement = \case
1207 -- Only hang lambdas with single line parameter lists
1224 -- Only hang lambdas with single line parameter lists
1208− HsLam NoExt mg -> case mg of
1225+ HsLam NoExtField mg -> case mg of
1209− MG _ (L _ [L _ (Match NoExt _ (x : xs) _)]) _
1226+ MG _ (L _ [L _ (Match NoExtField _ (x : xs) _)]) _
1210 | isOneLineSpan (combineSrcSpans' $ fmap getLoc (x :| xs)) ->
1227 | isOneLineSpan (combineSrcSpans' $ fmap getLoc (x :| xs)) ->
1212 _ -> Normal
1229 _ -> Normal
1213− HsLamCase NoExt _ -> Hanging
1230+ HsLamCase NoExtField _ -> Hanging
1214− HsCase NoExt _ _ -> Hanging
1231+ HsCase NoExtField _ _ -> Hanging
1215− HsDo NoExt DoExpr _ -> Hanging
1232+ HsDo NoExtField DoExpr _ -> Hanging
1216− HsDo NoExt MDoExpr _ -> Hanging
1233+ HsDo NoExtField MDoExpr _ -> Hanging
1217− -- If the rightmost expression in an operator chain is hanging, make the
1234+ OpApp NoExtField _ op y ->
1218− -- whole block hanging; so that we can use the common @f = foo $ do@
1235+ case (fmap getOpNameStr . getOpName . unLoc) op of
1219− -- style.
1236+ Just "$" -> exprPlacement (unLoc y)
1220− OpApp NoExt _ _ y -> exprPlacement (unLoc y)
1237+ _ -> Normal
1221− -- Same thing for function applications (usually with -XBlockArguments)
1238+ HsApp NoExtField _ y -> exprPlacement (unLoc y)
1222− HsApp NoExt _ y -> exprPlacement (unLoc y)
1239+ HsProc NoExtField p _ ->
1223− HsProc NoExt p _ ->
1240+ -- Indentation breaks if pattern is longer than one line and left
1224− -- https://gitlab.haskell.org/ghc/ghc/issues/17330
1241+ -- hanging. Consequently, only apply hanging when it is safe.
1225− let loc = case p of
1242+ if isOneLineSpan (getLoc p)
1226− XPat pat -> getLoc pat
1243+ then Hanging
1227− _ -> error "exprPlacement: HsProc: Pat does not contain a location"
1244+ else Normal
1228− in -- Indentation breaks if pattern is longer than one line and left
1229− -- hanging. Consequently, only apply hanging when it is safe.
1230− if isOneLineSpan loc
1233 _ -> Normal
1245 _ -> Normal
1235withGuards :: [LGRHS GhcPs (Located body)] -> Bool
1247withGuards :: [LGRHS GhcPs (Located body)] -> Bool
1236withGuards = any (checkOne . unLoc)
1248withGuards = any (checkOne . unLoc)
1238 checkOne :: GRHS GhcPs (Located body) -> Bool
1250 checkOne :: GRHS GhcPs (Located body) -> Bool
1239− checkOne (GRHS NoExt [] _) = False
1251+ checkOne (GRHS NoExtField [] _) = False
1240 checkOne _ = True
1252 checkOne _ = True
1242exprOpTree :: LHsExpr GhcPs -> OpTree (LHsExpr GhcPs) (LHsExpr GhcPs)
1254exprOpTree :: LHsExpr GhcPs -> OpTree (LHsExpr GhcPs) (LHsExpr GhcPs)
1243−exprOpTree (L _ (OpApp NoExt x op y)) = OpBranch (exprOpTree x) op (exprOpTree y)
1255+exprOpTree (L _ (OpApp NoExtField x op y)) = OpBranch (exprOpTree x) op (exprOpTree y)
1244exprOpTree n = OpNode n
1256exprOpTree n = OpNode n
1246getOpName :: HsExpr GhcPs -> Maybe RdrName
1258getOpName :: HsExpr GhcPs -> Maybe RdrName
1247getOpName = \case
1259getOpName = \case
1248− HsVar NoExt (L _ a) -> Just a
1260+ HsVar NoExtField (L _ a) -> Just a
1249 _ -> Nothing
1261 _ -> Nothing
1263+getOpNameStr :: RdrName -> String
1264+getOpNameStr = occNameString . rdrNameOcc
1251p_exprOpTree ::
1266p_exprOpTree ::
1252− -- | Can use special handling of dollar?
1254 -- | Bracket style to use
1267 -- | Bracket style to use
1255 BracketStyle ->
1268 BracketStyle ->
1256 OpTree (LHsExpr GhcPs) (LHsExpr GhcPs) ->
1269 OpTree (LHsExpr GhcPs) (LHsExpr GhcPs) ->
1258−p_exprOpTree _ s (OpNode x) = located x (p_hsExpr' s)
1271+p_exprOpTree s (OpNode x) = located x (p_hsExpr' s)
1259−p_exprOpTree isDollarSpecial s (OpBranch x op y) = do
1272+p_exprOpTree s (OpBranch x op y) = do
1260 -- If the beginning of the first argument and the second argument are on
1273 -- If the beginning of the first argument and the second argument are on
1261 -- the same line, and the second argument has a hanging form, use hanging
1274 -- the same line, and the second argument has a hanging form, use hanging
1262 -- placement.
1275 -- placement.
@@ -1267,8 +1280,10 @@ p_exprOpTree isDollarSpecial s (OpBranch x op y) = do
1267 OpNode (L _ n) -> exprPlacement n
1280 OpNode (L _ n) -> exprPlacement n
1268 _ -> Normal
1281 _ -> Normal
1269 else Normal
1282 else Normal
1283+ -- Distinguish holes used in infix notation.
1284+ -- eg. '1 _foo 2' and '1 `_foo` 2'
1270 opWrapper = case unLoc op of
1285 opWrapper = case unLoc op of
1271− EWildPat NoExt -> backticks
1286+ HsUnboundVar NoExtField _ -> backticks
1273 layout <- getLayout
1288 layout <- getLayout
1274 let ub = case layout of
1289 let ub = case layout of
@@ -1276,44 +1291,54 @@ p_exprOpTree isDollarSpecial s (OpBranch x op y) = do
1276 MultiLine -> case placement of
1291 MultiLine -> case placement of
1277 Hanging -> useBraces
1292 Hanging -> useBraces
1278 Normal -> dontUseBraces
1293 Normal -> dontUseBraces
1279− gotDollar = case getOpName (unLoc op) of
1294+ opNameStr = (fmap getOpNameStr . getOpName . unLoc) op
1280− Just rname -> mkVarOcc "$" == rdrNameOcc rname
1295+ gotDollar = opNameStr == Just "$"
1281− _ -> False
1296+ gotColon = opNameStr == Just ":"
1297+ gotRecordDot = isRecordDot (unLoc op) (opTreeLoc y)
1283 switchLayout [opTreeLoc x] $
1299 switchLayout [opTreeLoc x] $
1284− p_exprOpTree (not gotDollar) s x
1300+ p_exprOpTree s x
1285− let p_op = located op (opWrapper . p_hsExpr)
1301+ p_op = located op (opWrapper . p_hsExpr)
1286− p_y = switchLayout [opTreeLoc y] (p_exprOpTree True N y)
1302+ p_y = switchLayout [opTreeLoc y] (p_exprOpTree N y)
1287 isSection = case (opTreeLoc x, getLoc op) of
1303 isSection = case (opTreeLoc x, getLoc op) of
1288 (RealSrcSpan treeSpan, RealSrcSpan opSpan) ->
1304 (RealSrcSpan treeSpan, RealSrcSpan opSpan) ->
1289 srcSpanEndCol treeSpan /= srcSpanStartCol opSpan
1305 srcSpanEndCol treeSpan /= srcSpanStartCol opSpan
1290 _ -> False
1306 _ -> False
1308+ OpNode (L _ HsDo {}) -> True
1291 useRecordDot' <- useRecordDot
1310 useRecordDot' <- useRecordDot
1292− let isRecordDot' = isRecordDot (unLoc op) (opTreeLoc y)
1311+ if
1293− if useRecordDot' && isRecordDot'
1312+ | gotColon -> do
1296− when isSection space
1315+ p_op
1297− p_op
1316+ case placement of
1298− p_y
1317+ Hanging -> do
1304− && isOneLineSpan (opTreeLoc x)
1313− placeHanging placement $ do
1322+ inciIf (isDoBlock y) p_y
1324+ && isOneLineSpan (opTreeLoc x)
1325+ && placement == Normal -> do
1331+ | useRecordDot' && gotRecordDot -> do
1333+ when isSection space
1338+ placeHanging placement $ do
1318-- | Return 'True' if given expression is a record-dot operator expression.
1343-- | Return 'True' if given expression is a record-dot operator expression.
1319isRecordDot ::
1344isRecordDot ::
@@ -1323,15 +1348,11 @@ isRecordDot ::
1323 SrcSpan ->
1348 SrcSpan ->
1325isRecordDot op (RealSrcSpan ySpan) = case op of
1350isRecordDot op (RealSrcSpan ySpan) = case op of
1326− HsVar NoExt (L (RealSrcSpan opSpan) opName) ->
1351+ HsVar NoExtField (L (RealSrcSpan opSpan) opName) ->
1327− isDot opName && (srcSpanEndCol opSpan == srcSpanStartCol ySpan)
1352+ (getOpNameStr opName == ".") && (srcSpanEndCol opSpan == srcSpanStartCol ySpan)
1328 _ -> False
1353 _ -> False
1329isRecordDot _ _ = False
1354isRecordDot _ _ = False
1331−-- | Check whether a given 'RdrName' is the dot operator.
1332−isDot :: RdrName -> Bool
1333−isDot name = rdrNameOcc name == mkVarOcc "."
1335-- | Get annotations for the enclosing element.
1356-- | Get annotations for the enclosing element.
1336getEnclosingAnns :: R [AnnKeywordId]
1357getEnclosingAnns :: R [AnnKeywordId]
1337getEnclosingAnns = do
1358getEnclosingAnns = do