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