@@ -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,
@@ -18,23 +20,22 @@ import Ctype (is_space)
18import Data.Bool (bool)
20import Data.Bool (bool)
19import Data.Char (isPunctuation, isSymbol)
21import Data.Char (isPunctuation, isSymbol)
20import Data.Data hiding (Infix, Prefix)
22import Data.Data hiding (Infix, Prefix)
23+import Data.Functor ((<&>))
21import Data.List (intersperse, sortOn)
24import Data.List (intersperse, sortOn)
22−import Data.List.NonEmpty ((<|), NonEmpty ((:|)))
25+import Data.List.NonEmpty (NonEmpty (..), (<|))
23import qualified Data.List.NonEmpty as NE
26import qualified Data.List.NonEmpty as NE
24import Data.Text (Text)
27import Data.Text (Text)
25import qualified Data.Text as Text
28import qualified Data.Text as Text
27−import OccName (mkVarOcc)
30+import OccName (occNameString)
28import Ormolu.Printer.Combinators
31import Ormolu.Printer.Combinators
32+import Ormolu.Printer.Internal
29import Ormolu.Printer.Meat.Common
33import Ormolu.Printer.Meat.Common
30import {-# SOURCE #-} Ormolu.Printer.Meat.Declaration
34import {-# SOURCE #-} Ormolu.Printer.Meat.Declaration
31import Ormolu.Printer.Meat.Declaration.Signature
35import Ormolu.Printer.Meat.Declaration.Signature
32import Ormolu.Printer.Meat.Type
36import Ormolu.Printer.Meat.Type
33import Ormolu.Printer.Operators
37import Ormolu.Printer.Operators
34import Ormolu.Utils
38import Ormolu.Utils
35−import RdrName (RdrName (..))
36−import RdrName (rdrNameOcc)
37−import SrcLoc (combineSrcSpans, isOneLineSpan)
39-- | Style of a group of equations.
40-- | Style of a group of equations.
40data MatchGroupStyle
41data MatchGroupStyle
@@ -60,16 +61,16 @@ data Placement
60 -- should use it and avoid bumping one level
61 -- should use it and avoid bumping one level
61 -- of indentation
62 -- of indentation
63− deriving (Eq)
64+ deriving (Eq, Show)
65p_valDecl :: HsBindLR GhcPs GhcPs -> R ()
66p_valDecl :: HsBindLR GhcPs GhcPs -> R ()
66p_valDecl = \case
67p_valDecl = \case
67− FunBind NoExt funId funMatches _ _ -> p_funBind funId funMatches
68+ FunBind NoExtField funId funMatches _ _ -> p_funBind funId funMatches
68− PatBind NoExt pat grhss _ -> p_match PatternBind False NoSrcStrict [pat] grhss
69+ PatBind NoExtField pat grhss _ -> p_match PatternBind False NoSrcStrict [pat] grhss
69 VarBind {} -> notImplemented "VarBinds" -- introduced by the type checker
70 VarBind {} -> notImplemented "VarBinds" -- introduced by the type checker
70 AbsBinds {} -> notImplemented "AbsBinds" -- introduced by the type checker
71 AbsBinds {} -> notImplemented "AbsBinds" -- introduced by the type checker
71− PatSynBind NoExt psb -> p_patSynBind psb
72+ PatSynBind NoExtField psb -> p_patSynBind psb
72− XHsBindsLR NoExt -> notImplemented "XHsBindsLR"
73+ XHsBindsLR x -> noExtCon x
74p_funBind ::
75p_funBind ::
75 Located RdrName ->
76 Located RdrName ->
@@ -99,7 +100,7 @@ p_matchGroup' placer render style MG {..} = do
99 Case -> id
100 Case -> id
100 LambdaCase -> id
101 LambdaCase -> id
101 _ -> dontUseBraces
102 _ -> dontUseBraces
102− -- NOTE since we are forcing braces on 'sepSemi' based on 'ob', we have to
103+ -- Since we are forcing braces on 'sepSemi' based on 'ob', we have to
103 -- restore the brace state inside the sepsemi.
104 -- restore the brace state inside the sepsemi.
104 ub <- bool dontUseBraces useBraces <$> canUseBraces
105 ub <- bool dontUseBraces useBraces <$> canUseBraces
105 ob $ sepSemi (located' (ub . p_Match)) (unLoc mg_alts)
106 ob $ sepSemi (located' (ub . p_Match)) (unLoc mg_alts)
@@ -113,8 +114,8 @@ p_matchGroup' placer render style MG {..} = do
113 (matchStrictness m)
114 (matchStrictness m)
116− p_Match _ = notImplemented "XMatch"
117+ p_Match (XMatch x) = noExtCon x
117−p_matchGroup' _ _ _ (XMatchGroup NoExt) = notImplemented "XMatchGroup"
118+p_matchGroup' _ _ _ (XMatchGroup x) = noExtCon x
119-- | Function id obtained through pattern matching on 'FunBind' should not
120-- | Function id obtained through pattern matching on 'FunBind' should not
120-- be used to print the actual equations because the different ‘RdrNames’
121-- be used to print the actual equations because the different ‘RdrNames’
@@ -167,9 +168,9 @@ p_match' ::
167 -- | Equations
168 -- | Equations
168 GRHSs GhcPs (Located body) ->
169 GRHSs GhcPs (Located body) ->
170−p_match' placer render style isInfix strictness m_pats m_grhss = do
171+p_match' placer render style isInfix strictness m_pats GRHSs {..} = do
171− -- NOTE Normally, since patterns may be placed in a multi-line layout, it
172+ -- Normally, since patterns may be placed in a multi-line layout, it is
172− -- is necessary to bump indentation for the pattern group so it's more
173+ -- necessary to bump indentation for the pattern group so it's more
173 -- indented than function name. This in turn means that indentation for
174 -- indented than function name. This in turn means that indentation for
174 -- the body should also be bumped. Normally this would mean that bodies
175 -- the body should also be bumped. Normally this would mean that bodies
175 -- would start with two indentation steps applied, which is ugly, so we
176 -- would start with two indentation steps applied, which is ugly, so we
@@ -179,25 +180,24 @@ p_match' placer render style isInfix strictness m_pats m_grhss = do
179 NoSrcStrict -> return ()
180 NoSrcStrict -> return ()
180 SrcStrict -> txt "!"
181 SrcStrict -> txt "!"
181 SrcLazy -> txt "~"
182 SrcLazy -> txt "~"
182− inci' <- case NE.nonEmpty m_pats of
183+ indentBody <- case NE.nonEmpty m_pats of
183− Nothing -> id <$ case style of
185+ False <$ case style of
184− Function name -> p_rdrName name
186+ Function name -> p_rdrName name
185− _ -> return ()
187+ _ -> return ()
186 Just ne_pats -> do
188 Just ne_pats -> do
187− let combinedSpans =
189+ let combinedSpans = case style of
190+ Function name -> combineSrcSpans (getLoc name) patSpans
188− combineSrcSpans' $
192+ patSpans = combineSrcSpans' (getLoc <$> ne_pats)
191− if isOneLineSpan combinedSpans
193+ indentBody = not (isOneLineSpan combinedSpans)
194 switchLayout [combinedSpans] $ do
194 switchLayout [combinedSpans] $ do
195 let stdCase = sep breakpoint (located' p_pat) m_pats
195 let stdCase = sep breakpoint (located' p_pat) m_pats
196 case style of
196 case style of
197 Function name ->
197 Function name ->
198 p_infixDefHelper
198 p_infixDefHelper
200− inci'
200+ indentBody
201 (p_rdrName name)
201 (p_rdrName name)
202 (located' p_pat <$> m_pats)
202 (located' p_pat <$> m_pats)
203 PatternBind -> stdCase
203 PatternBind -> stdCase
@@ -212,41 +212,32 @@ p_match' placer render style isInfix strictness m_pats m_grhss = do
212 when needsSpace space
212 when needsSpace space
213 sitcc stdCase
213 sitcc stdCase
214 LambdaCase -> stdCase
214 LambdaCase -> stdCase
215− return inci'
215+ return indentBody
216 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
217 -- about putting certain constructions in hanging positions.
217 -- about putting certain constructions in hanging positions.
218 endOfPats = case NE.nonEmpty m_pats of
218 endOfPats = case NE.nonEmpty m_pats of
219 Nothing -> case style of
219 Nothing -> case style of
220− Function name -> (Just . srcSpanEnd . getLoc) name
220+ Function name -> Just (getLoc name)
221 _ -> Nothing
221 _ -> Nothing
222− Just pats -> (Just . srcSpanEnd . getLoc . NE.last) pats
222+ Just pats -> (Just . getLoc . NE.last) pats
223 isCase = \case
223 isCase = \case
224 Case -> True
224 Case -> True
225 LambdaCase -> True
225 LambdaCase -> True
226 _ -> False
226 _ -> False
227− let GRHSs {..} = m_grhss
228 hasGuards = withGuards grhssGRHSs
227 hasGuards = withGuards grhssGRHSs
229− unless (length grhssGRHSs > 1) $ do
231− Function _ | hasGuards -> return ()
232− Function _ -> space >> txt "="
233− PatternBind -> space >> txt "="
234− s | isCase s && hasGuards -> return ()
235− _ -> space >> txt "->"
236− let grhssSpan =
228+ grhssSpan =
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 ->
249− (mkSrcSpan spn (srcSpanStart grhssSpan))
240+ if onTheSameLine spn 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,10 +253,18 @@ p_match' placer render style isInfix strictness m_pats m_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
267+p_match' _ _ _ _ _ _ (XGRHSs x) = noExtCon x
270p_grhs :: GroupStyle -> GRHS GhcPs (LHsExpr GhcPs) -> R ()
269p_grhs :: GroupStyle -> GRHS GhcPs (LHsExpr GhcPs) -> R ()
271p_grhs = p_grhs' exprPlacement p_hsExpr
270p_grhs = p_grhs' exprPlacement p_hsExpr
@@ -279,79 +278,109 @@ p_grhs' ::
279 GroupStyle ->
278 GroupStyle ->
280 GRHS GhcPs (Located body) ->
279 GRHS GhcPs (Located body) ->
282−p_grhs' placer render style (GRHS NoExt guards body) =
281+p_grhs' placer render style (GRHS NoExtField guards body) =
283 case guards of
282 case guards of
284 [] -> p_body
283 [] -> p_body
288− sitcc (sep (comma >> breakpoint) (sitcc . located' p_stmt) xs)
287+ sitcc (sep commaDel (sitcc . located' p_stmt) xs)
290− txt $ case style of
289+ inci $ case style of
291− EqualSign -> "="
290+ EqualSign -> equals
292− RightArrow -> "->"
291+ RightArrow -> txt "->"
293 placeHanging placement p_body
292 placeHanging placement p_body
295 placement =
294 placement =
296 case endOfGuards of
295 case endOfGuards of
297 Nothing -> placer (unLoc body)
296 Nothing -> placer (unLoc body)
298 Just spn ->
297 Just spn ->
299− if isOneLineSpan (mkSrcSpan spn (srcSpanStart (getLoc body)))
298+ if onTheSameLine spn (getLoc body)
300 then placer (unLoc body)
299 then placer (unLoc body)
301 else Normal
300 else Normal
302 endOfGuards =
301 endOfGuards =
303 case NE.nonEmpty guards of
302 case NE.nonEmpty guards of
304 Nothing -> Nothing
303 Nothing -> Nothing
305− Just gs -> (Just . srcSpanEnd . getLoc . NE.last) gs
304+ Just gs -> (Just . getLoc . NE.last) gs
306 p_body = located body render
305 p_body = located body render
307−p_grhs' _ _ _ (XGRHS NoExt) = notImplemented "XGRHS"
306+p_grhs' _ _ _ (XGRHS x) = noExtCon x
309p_hsCmd :: HsCmd GhcPs -> R ()
308p_hsCmd :: HsCmd GhcPs -> R ()
310p_hsCmd = \case
309p_hsCmd = \case
311− HsCmdArrApp NoExt body input arrType _ -> do
310+ HsCmdArrApp NoExtField body input arrType _ -> do
312 located body p_hsExpr
311 located body p_hsExpr
313− space
312+ breakpoint
314− case arrType of
314+ case arrType of
315− HsFirstOrderApp -> txt "-<"
315+ HsFirstOrderApp -> txt "-<"
316− HsHigherOrderApp -> txt "-<<"
316+ HsHigherOrderApp -> txt "-<<"
317− placeHanging (exprPlacement (unLoc input)) $
317+ placeHanging (exprPlacement (unLoc input)) $
318− located input p_hsExpr
318+ located input p_hsExpr
319− HsCmdArrForm NoExt form Prefix _ cmds -> banana $ sitcc $ do
319+ HsCmdArrForm NoExtField form Prefix _ cmds -> banana $ do
320 located form p_hsExpr
320 located form p_hsExpr
321 unless (null cmds) $ do
321 unless (null cmds) $ do
322 breakpoint
322 breakpoint
323 inci (sequence_ (intersperse breakpoint (located' p_hsCmdTop <$> cmds)))
323 inci (sequence_ (intersperse breakpoint (located' p_hsCmdTop <$> cmds)))
324− HsCmdArrForm NoExt form Infix _ [left, right] -> do
324+ HsCmdArrForm NoExtField form Infix _ [left, right] -> do
325 located left p_hsCmdTop
325 located left p_hsCmdTop
327 located form p_hsExpr
327 located form p_hsExpr
328 placeHanging (cmdTopPlacement (unLoc right)) $
328 placeHanging (cmdTopPlacement (unLoc right)) $
329 located right p_hsCmdTop
329 located right p_hsCmdTop
330− HsCmdArrForm NoExt _ Infix _ _ -> notImplemented "HsCmdArrForm"
330+ HsCmdArrForm NoExtField _ Infix _ _ -> notImplemented "HsCmdArrForm"
331 HsCmdApp {} ->
331 HsCmdApp {} ->
332 -- 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
333 -- 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.
334 notImplemented "HsCmdApp"
334 notImplemented "HsCmdApp"
335− HsCmdLam NoExt mgroup -> p_matchGroup' cmdPlacement p_hsCmd Lambda mgroup
335+ HsCmdLam NoExtField mgroup -> p_matchGroup' cmdPlacement p_hsCmd Lambda mgroup
336− HsCmdPar NoExt c -> parens N (located c p_hsCmd)
336+ HsCmdPar NoExtField c -> parens N (located c p_hsCmd)
337− HsCmdCase NoExt e mgroup ->
337+ HsCmdCase NoExtField e mgroup ->
338 p_case cmdPlacement p_hsCmd e mgroup
338 p_case cmdPlacement p_hsCmd e mgroup
339− HsCmdIf NoExt _ if' then' else' ->
339+ HsCmdIf NoExtField _ if' then' else' ->
340 p_if cmdPlacement p_hsCmd if' then' else'
340 p_if cmdPlacement p_hsCmd if' then' else'
341− HsCmdLet NoExt localBinds c ->
341+ HsCmdLet NoExtField localBinds c ->
342 p_let p_hsCmd localBinds c
342 p_let p_hsCmd localBinds c
343− HsCmdDo NoExt es -> do
343+ HsCmdDo NoExtField es -> do
346 inci . located es $
346 inci . located es $
347− sitcc . sep newline (located' (sitcc . p_stmt' cmdPlacement p_hsCmd))
347+ sitcc . sep newline (sitcc . withSpacing (p_stmt' cmdPlacement p_hsCmd))
348 HsCmdWrap {} -> notImplemented "HsCmdWrap"
348 HsCmdWrap {} -> notImplemented "HsCmdWrap"
349− XCmd {} -> notImplemented "XCmd"
349+ XCmd x -> noExtCon x
351p_hsCmdTop :: HsCmdTop GhcPs -> R ()
351p_hsCmdTop :: HsCmdTop GhcPs -> R ()
352p_hsCmdTop = \case
352p_hsCmdTop = \case
353− HsCmdTop NoExt cmd -> located cmd p_hsCmd
353+ HsCmdTop NoExtField cmd -> located cmd p_hsCmd
354− 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)
356p_stmt :: Stmt GhcPs (LHsExpr GhcPs) -> R ()
385p_stmt :: Stmt GhcPs (LHsExpr GhcPs) -> R ()
357p_stmt = p_stmt' exprPlacement p_hsExpr
386p_stmt = p_stmt' exprPlacement p_hsExpr
@@ -366,35 +395,36 @@ p_stmt' ::
366 Stmt GhcPs (Located body) ->
395 Stmt GhcPs (Located body) ->
368p_stmt' placer render = \case
397p_stmt' placer render = \case
369− LastStmt NoExt body _ _ -> located body render
398+ LastStmt NoExtField body _ _ -> located body render
370− BindStmt NoExt l f _ _ -> do
399+ BindStmt NoExtField p f _ _ -> do
371− located l p_pat
400+ located p p_pat
374− let placement =
404+ placement =
375 case f of
405 case f of
376 L l' x ->
406 L l' x ->
377 if isOneLineSpan
407 if isOneLineSpan
378− (mkSrcSpan (srcSpanEnd (getLoc l)) (srcSpanStart l'))
408+ (mkSrcSpan (srcSpanEnd loc) (srcSpanStart l'))
379 then placer x
409 then placer x
380 else Normal
410 else Normal
381− switchLayout [getLoc l, getLoc f] $
411+ switchLayout [loc, getLoc f] $
382 placeHanging placement (located f render)
412 placeHanging placement (located f render)
383 ApplicativeStmt {} -> notImplemented "ApplicativeStmt" -- generated by renamer
413 ApplicativeStmt {} -> notImplemented "ApplicativeStmt" -- generated by renamer
384− BodyStmt NoExt body _ _ -> located body render
414+ BodyStmt NoExtField body _ _ -> located body render
385− LetStmt NoExt binds -> do
415+ LetStmt NoExtField binds -> do
386 txt "let"
416 txt "let"
388 sitcc $ located binds p_hsLocalBinds
418 sitcc $ located binds p_hsLocalBinds
389 ParStmt {} ->
419 ParStmt {} ->
390− -- NOTE 'ParStmt' should always be eliminated in 'gatherStmt' already,
420+ -- 'ParStmt' should always be eliminated in 'gatherStmt' already, such
391− -- such that it never occurs in 'p_stmt''. Consequently, handling it
421+ -- that it never occurs in 'p_stmt''. Consequently, handling it here
392− -- here would be redundant.
422+ -- would be redundant.
393 notImplemented "ParStmt"
423 notImplemented "ParStmt"
394− TransStmt {..} -> do
424+ TransStmt {..} ->
395− -- NOTE 'TransStmt' only needs to account for render printing itself,
425+ -- 'TransStmt' only needs to account for render printing itself, since
396− -- since pretty printing of relevant statements (e.g., in 'trS_stmts')
426+ -- pretty printing of relevant statements (e.g., in 'trS_stmts') is
397− -- is handled through 'gatherStmt'.
427+ -- handled through 'gatherStmt'.
398 case (trS_form, trS_by) of
428 case (trS_form, trS_by) of
399 (ThenForm, Nothing) -> do
429 (ThenForm, Nothing) -> do
400 txt "then"
430 txt "then"
@@ -423,11 +453,11 @@ p_stmt' placer render = \case
423 RecStmt {..} -> do
453 RecStmt {..} -> do
424 txt "rec"
454 txt "rec"
426− sitcc $ sepSemi (located' (p_stmt' placer render)) recS_stmts
456+ sitcc $ sepSemi (withSpacing (p_stmt' placer render)) recS_stmts
427− XStmtLR {} -> notImplemented "XStmtLR"
457+ XStmtLR c -> noExtCon c
429gatherStmt :: ExprLStmt GhcPs -> [[ExprLStmt GhcPs]]
459gatherStmt :: ExprLStmt GhcPs -> [[ExprLStmt GhcPs]]
430−gatherStmt (L _ (ParStmt NoExt block _ _)) =
460+gatherStmt (L _ (ParStmt NoExtField block _ _)) =
431 foldr ((<>) . gatherStmtBlock) [] block
461 foldr ((<>) . gatherStmtBlock) [] block
432gatherStmt (L s stmt@TransStmt {..}) =
462gatherStmt (L s stmt@TransStmt {..}) =
433 foldr liftAppend [] ((gatherStmt <$> trS_stmts) <> pure [[L s stmt]])
463 foldr liftAppend [] ((gatherStmt <$> trS_stmts) <> pure [[L s stmt]])
@@ -436,96 +466,93 @@ gatherStmt stmt = [[stmt]]
436gatherStmtBlock :: ParStmtBlock GhcPs GhcPs -> [[ExprLStmt GhcPs]]
466gatherStmtBlock :: ParStmtBlock GhcPs GhcPs -> [[ExprLStmt GhcPs]]
437gatherStmtBlock (ParStmtBlock _ stmts _ _) =
467gatherStmtBlock (ParStmtBlock _ stmts _ _) =
438 foldr (liftAppend . gatherStmt) [] stmts
468 foldr (liftAppend . gatherStmt) [] stmts
439−gatherStmtBlock XParStmtBlock {} = notImplemented "XParStmtBlock"
469+gatherStmtBlock (XParStmtBlock x) = noExtCon x
441p_hsLocalBinds :: HsLocalBindsLR GhcPs GhcPs -> R ()
471p_hsLocalBinds :: HsLocalBindsLR GhcPs GhcPs -> R ()
442p_hsLocalBinds = \case
472p_hsLocalBinds = \case
443− HsValBinds NoExt (ValBinds NoExt bag lsigs) -> do
473+ HsValBinds NoExtField (ValBinds NoExtField bag lsigs) -> do
446− (srcSpanStart . getLoc)
447− (srcSpanStart . getLoc)
449− (Left <$> bagToList bag) ++ (Right <$> lsigs)
450− p_item (Left x) = located x p_valDecl
451− p_item (Right x) = located x p_sigDecl
452− -- Assigns 'False' to the last element, 'True' to the rest.
453− markInit :: [a] -> [(Bool, a)]
455− markInit (x : []) = [(False, x)]
456− markInit (x : xs) = (True, x) : markInit xs
457− -- NOTE 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
458 -- elements will also contain semicolons and they will confuse the
475 -- elements will also contain semicolons and they will confuse the
459 -- parser. so we request braces around every element except the last.
476 -- parser. so we request braces around every element except the last.
460 br <- layoutToBraces <$> getLayout
477 br <- layoutToBraces <$> getLayout
461− sitcc $
478+ let items =
462− sepSemi
479+ let injectLeft (L l x) = L l (Left x)
463− (\(m, i) -> (if m then br else id) $ p_item i)
480+ injectRight (L l x) = L l (Right x)
464− (markInit $ sortOn ssStart items)
481+ in (injectLeft <$> bagToList bag) ++ (injectRight <$> lsigs)
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)
465− HsValBinds NoExt _ -> notImplemented "HsValBinds"
492+ HsValBinds NoExtField _ -> notImplemented "HsValBinds"
466− HsIPBinds NoExt (IPBinds NoExt xs) ->
493+ HsIPBinds NoExtField (IPBinds NoExtField xs) ->
467 -- Second argument of IPBind is always Left before type-checking.
494 -- Second argument of IPBind is always Left before type-checking.
468− let p_ipBind (IPBind NoExt (Left name) expr) = do
495+ let p_ipBind (IPBind NoExtField (Left name) expr) = do
469 atom name
496 atom name
472 breakpoint
499 breakpoint
473 useBraces $ inci $ located expr p_hsExpr
500 useBraces $ inci $ located expr p_hsExpr
501+ p_ipBind (IPBind NoExtField (Right _) _) =
502+ -- Should only occur after the type checker
474− p_ipBind _ = notImplemented "XHsIPBinds"
503+ notImplemented "IPBind _ (Right _) _"
504+ p_ipBind (XIPBind x) = noExtCon x
475 in sepSemi (located' p_ipBind) xs
505 in sepSemi (located' p_ipBind) xs
476− HsIPBinds NoExt _ -> notImplemented "HsIpBinds"
506+ HsIPBinds NoExtField _ -> notImplemented "HsIpBinds"
477− EmptyLocalBinds NoExt -> return ()
507+ EmptyLocalBinds NoExtField -> return ()
478− XHsLocalBindsLR _ -> notImplemented "XHsLocalBindsLR"
508+ XHsLocalBindsLR x -> noExtCon x
480p_hsRecField ::
510p_hsRecField ::
481 HsRecField' RdrName (LHsExpr GhcPs) ->
511 HsRecField' RdrName (LHsExpr GhcPs) ->
483−p_hsRecField = \HsRecField {..} -> do
513+p_hsRecField HsRecField {..} = do
484 p_rdrName hsRecFieldLbl
514 p_rdrName hsRecFieldLbl
485 unless hsRecPun $ do
515 unless hsRecPun $ do
519+ if onTheSameLine (getLoc hsRecFieldLbl) (getLoc hsRecFieldArg)
488− let placement = exprPlacement (unLoc hsRecFieldArg)
520+ then exprPlacement (unLoc hsRecFieldArg)
489− placeHanging placement $ located hsRecFieldArg p_hsExpr
522+ placeHanging placement (located hsRecFieldArg p_hsExpr)
491−p_hsTupArg :: HsTupArg GhcPs -> R ()
493− Present NoExt x -> located x p_hsExpr
494− Missing NoExt -> pure ()
495− XTupArg {} -> notImplemented "XTupArg"
497p_hsExpr :: HsExpr GhcPs -> R ()
524p_hsExpr :: HsExpr GhcPs -> R ()
498p_hsExpr = p_hsExpr' N
525p_hsExpr = p_hsExpr' N
500p_hsExpr' :: BracketStyle -> HsExpr GhcPs -> R ()
527p_hsExpr' :: BracketStyle -> HsExpr GhcPs -> R ()
501p_hsExpr' s = \case
528p_hsExpr' s = \case
502− HsVar NoExt name -> p_rdrName name
529+ HsVar NoExtField name -> p_rdrName name
503− HsUnboundVar NoExt _ -> notImplemented "HsUnboundVar"
530+ HsUnboundVar NoExtField v -> atom (unboundVarOcc v)
504− HsConLikeOut NoExt _ -> notImplemented "HsConLikeOut"
531+ HsConLikeOut NoExtField _ -> notImplemented "HsConLikeOut"
505− HsRecFld NoExt x ->
532+ HsRecFld NoExtField x ->
506 case x of
533 case x of
507− Unambiguous NoExt name -> p_rdrName name
534+ Unambiguous NoExtField name -> p_rdrName name
508− Ambiguous NoExt name -> p_rdrName name
535+ Ambiguous NoExtField name -> p_rdrName name
509− XAmbiguousFieldOcc NoExt -> notImplemented "XAmbiguousFieldOcc"
536+ XAmbiguousFieldOcc xx -> noExtCon xx
510− HsOverLabel NoExt _ v -> do
537+ HsOverLabel NoExtField _ v -> do
513− HsIPVar NoExt (HsIPName name) -> do
540+ HsIPVar NoExtField (HsIPName name) -> do
515 atom name
542 atom name
516− HsOverLit NoExt v -> atom (ol_val v)
543+ HsOverLit NoExtField v -> atom (ol_val v)
517− HsLit NoExt lit ->
544+ HsLit NoExtField lit ->
518 case lit of
545 case lit of
519 HsString (SourceText stxt) _ -> p_stringLit stxt
546 HsString (SourceText stxt) _ -> p_stringLit stxt
520 HsStringPrim (SourceText stxt) _ -> p_stringLit stxt
547 HsStringPrim (SourceText stxt) _ -> p_stringLit stxt
521 r -> atom r
548 r -> atom r
522− HsLam NoExt mgroup ->
549+ HsLam NoExtField mgroup ->
523 p_matchGroup Lambda mgroup
550 p_matchGroup Lambda mgroup
524− HsLamCase NoExt mgroup -> do
551+ HsLamCase NoExtField mgroup -> do
525 txt "\\case"
552 txt "\\case"
526 breakpoint
553 breakpoint
527 inci (p_matchGroup LambdaCase mgroup)
554 inci (p_matchGroup LambdaCase mgroup)
528− HsApp NoExt f x -> do
555+ HsApp NoExtField f x -> do
529 let -- In order to format function applications with multiple parameters
556 let -- In order to format function applications with multiple parameters
530 -- nicer, traverse the AST to gather the function and all the
557 -- nicer, traverse the AST to gather the function and all the
531 -- parameters together.
558 -- parameters together.
@@ -537,8 +564,10 @@ p_hsExpr' s = \case
537 -- We need to handle the last argument specially if it is a
564 -- We need to handle the last argument specially if it is a
538 -- hanging construct, so separate it from the rest.
565 -- hanging construct, so separate it from the rest.
539 (initp, lastp) = (NE.init args, NE.last args)
566 (initp, lastp) = (NE.init args, NE.last args)
540− initSpan = combineSrcSpans' $ getLoc f :| map getLoc initp
568+ combineSrcSpans' $
569+ getLoc f :| [(srcLocSpan . srcSpanStart . getLoc) lastp]
541− -- Hang the last argument only if the initial arguments spans one
570+ -- Hang the last argument only if the initial arguments span one
543 placement =
572 placement =
544 if isOneLineSpan initSpan
573 if isOneLineSpan initSpan
@@ -550,11 +579,26 @@ p_hsExpr' s = \case
551 case placement of
580 case placement of
552 Normal -> do
581 Normal -> do
582+ let -- Usually we want to bump indentation for arguments for the
583+ -- sake of readability. However, when the function itself is a
584+ -- do-block or case expression it is not a good idea. It seems
585+ -- to be safe to always bump indentation when the function
586+ -- expression is parenthesised.
589+ L _ (HsPar NoExtField _) -> True
590+ L _ (HsAppType NoExtField _ _) -> True
591+ L _ (HsMultiIf NoExtField _) -> True
592+ L spn _ -> isOneLineSpan spn
553− useBraces $ do
595+ SingleLine -> useBraces
554 located func (p_hsExpr' s)
598 located func (p_hsExpr' s)
555 breakpoint
599 breakpoint
556− inci $ sep breakpoint (located' p_hsExpr) initp
600+ inciIf doIndent $ sep breakpoint (located' p_hsExpr) initp
557− inci $ do
601+ inciIf doIndent $ do
558 unless (null initp) breakpoint
602 unless (null initp) breakpoint
559 located lastp p_hsExpr
603 located lastp p_hsExpr
560 Hanging -> do
604 Hanging -> do
@@ -564,75 +608,87 @@ p_hsExpr' s = \case
564 sep breakpoint (located' p_hsExpr) initp
608 sep breakpoint (located' p_hsExpr) initp
565 placeHanging placement $
609 placeHanging placement $
566 located lastp p_hsExpr
610 located lastp p_hsExpr
567− HsAppType a e -> do
611+ HsAppType NoExtField e a -> do
568 located e p_hsExpr
612 located e p_hsExpr
569 breakpoint
613 breakpoint
570 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
572 located (hswc_body a) p_hsType
621 located (hswc_body a) p_hsType
573− OpApp NoExt x op y -> do
622+ OpApp NoExtField x op y -> do
574 let opTree = OpBranch (exprOpTree x) op (exprOpTree y)
623 let opTree = OpBranch (exprOpTree x) op (exprOpTree y)
575− p_exprOpTree True s (reassociateOpTree getOpName opTree)
624+ p_exprOpTree s (reassociateOpTree getOpName opTree)
576− NegApp NoExt e _ -> do
625+ NegApp NoExtField e _ -> do
579 located e p_hsExpr
628 located e p_hsExpr
580− HsPar NoExt e ->
629+ HsPar NoExtField e ->
581 parens s (located e (dontUseBraces . p_hsExpr))
630 parens s (located e (dontUseBraces . p_hsExpr))
582− SectionL NoExt x op -> do
631+ SectionL NoExtField x op -> do
583 located x p_hsExpr
632 located x p_hsExpr
584 breakpoint
633 breakpoint
585 inci (located op p_hsExpr)
634 inci (located op p_hsExpr)
586− SectionR NoExt op x -> do
635+ SectionR NoExtField op x -> do
587 located op p_hsExpr
636 located op p_hsExpr
637+ useRecordDot' <- useRecordDot
638+ let isRecordDot' = isRecordDot (unLoc op) (getLoc x)
588− breakpoint
639+ unless (useRecordDot' && isRecordDot') breakpoint
589 inci (located x p_hsExpr)
640 inci (located x p_hsExpr)
590− ExplicitTuple NoExt args boxity -> do
641+ ExplicitTuple NoExtField args boxity ->
591 let isSection = any (isMissing . unLoc) args
642 let isSection = any (isMissing . unLoc) args
592 isMissing = \case
643 isMissing = \case
593− Missing NoExt -> True
644+ Missing NoExtField -> True
594 _ -> False
645 _ -> 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
595− let parens' =
651+ parens' =
596 case boxity of
652 case boxity of
597 Boxed -> parens
653 Boxed -> parens
598 Unboxed -> parensHash
654 Unboxed -> parensHash
599− if isSection
655+ in if isSection
601− switchLayout [] . parens' s $
657+ switchLayout [] . parens' s $
602− sep comma (located' p_hsTupArg) args
658+ sep comma p_larg args
604− switchLayout (getLoc <$> args) . parens' s . sitcc $
660+ switchLayout (getLoc <$> args) . parens' s $
605− sep (comma >> breakpoint) (sitcc . located' p_hsTupArg) args
661+ sep commaDel p_larg args
606− ExplicitSum NoExt tag arity e ->
662+ ExplicitSum NoExtField tag arity e ->
607 p_unboxedSum N tag arity (located e p_hsExpr)
663 p_unboxedSum N tag arity (located e p_hsExpr)
608− HsCase NoExt e mgroup ->
664+ HsCase NoExtField e mgroup ->
609 p_case exprPlacement p_hsExpr e mgroup
665 p_case exprPlacement p_hsExpr e mgroup
610− HsIf NoExt _ if' then' else' ->
666+ HsIf NoExtField _ if' then' else' ->
611 p_if exprPlacement p_hsExpr if' then' else'
667 p_if exprPlacement p_hsExpr if' then' else'
612− HsMultiIf NoExt guards -> do
668+ HsMultiIf NoExtField guards -> do
614 breakpoint
670 breakpoint
615− inci . sitcc $ sep newline (located' (p_grhs RightArrow)) guards
671+ inci . inci $ sep newline (located' (p_grhs RightArrow)) guards
616− HsLet NoExt localBinds e ->
672+ HsLet NoExtField localBinds e ->
617 p_let p_hsExpr localBinds e
673 p_let p_hsExpr localBinds e
618− HsDo NoExt ctx es -> do
674+ HsDo NoExtField ctx es -> do
619 let doBody header = do
675 let doBody header = do
620 txt header
676 txt header
621 breakpoint
677 breakpoint
622 ub <- layoutToBraces <$> getLayout
678 ub <- layoutToBraces <$> getLayout
625− (located' (ub . p_stmt' exprPlacement (p_hsExpr' S)))
681+ (ub . withSpacing (p_stmt' exprPlacement (p_hsExpr' S)))
626 (unLoc es)
682 (unLoc es)
627− compBody = brackets N $ located es $ \xs -> do
683+ compBody = brackets N . located es $ \xs -> do
628 let p_parBody =
684 let p_parBody =
630− (breakpoint >> txt "| ")
686+ (breakpoint >> txt "|" >> space)
631 p_seqBody
687 p_seqBody
632 p_seqBody =
688 p_seqBody =
635− (comma >> breakpoint)
691+ commaDel
636 (located' (sitcc . p_stmt))
692 (located' (sitcc . p_stmt))
637 stmts = init xs
693 stmts = init xs
638 yield = last xs
694 yield = last xs
@@ -653,88 +709,94 @@ p_hsExpr' s = \case
653 ParStmtCtxt _ -> notImplemented "ParStmtCtxt"
709 ParStmtCtxt _ -> notImplemented "ParStmtCtxt"
654 TransStmtCtxt _ -> notImplemented "TransStmtCtxt"
710 TransStmtCtxt _ -> notImplemented "TransStmtCtxt"
655 ExplicitList _ _ xs ->
711 ExplicitList _ _ xs ->
656− brackets s . sitcc $
712+ brackets s $
657− sep (comma >> breakpoint) (sitcc . located' p_hsExpr) xs
713+ sep commaDel (sitcc . located' p_hsExpr) xs
658 RecordCon {..} -> do
714 RecordCon {..} -> do
659 located rcon_con_name atom
715 located rcon_con_name atom
660 breakpoint
716 breakpoint
661 let HsRecFields {..} = rcon_flds
717 let HsRecFields {..} = rcon_flds
662 updName f =
718 updName f =
663− f
719+ (f :: HsRecField GhcPs (LHsExpr GhcPs))
664 { hsRecFieldLbl = case unLoc $ hsRecFieldLbl f of
720 { hsRecFieldLbl = case unLoc $ hsRecFieldLbl f of
665 FieldOcc _ n -> n
721 FieldOcc _ n -> n
666− XFieldOcc _ -> notImplemented "XFieldOcc"
722+ XFieldOcc x -> noExtCon x
668 fields = located' (p_hsRecField . updName) <$> rec_flds
724 fields = located' (p_hsRecField . updName) <$> rec_flds
670 case rec_dotdot of
726 case rec_dotdot of
671 Just {} -> [txt ".."]
727 Just {} -> [txt ".."]
672 Nothing -> []
728 Nothing -> []
673− inci . braces N . sitcc $
729+ inci . braces N $
674− sep (comma >> breakpoint) sitcc (fields <> dotdot)
730+ sep commaDel sitcc (fields <> dotdot)
675 RecordUpd {..} -> do
731 RecordUpd {..} -> do
676 located rupd_expr p_hsExpr
732 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))
677− breakpoint
740+ unless (useRecordDot' && isPluginForm) breakpoint
678 let updName f =
741 let updName f =
679− f
742+ (f :: HsRecUpdField GhcPs)
680 { hsRecFieldLbl = case unLoc $ hsRecFieldLbl f of
743 { hsRecFieldLbl = case unLoc $ hsRecFieldLbl f of
681 Ambiguous _ n -> n
744 Ambiguous _ n -> n
682 Unambiguous _ n -> n
745 Unambiguous _ n -> n
683− XAmbiguousFieldOcc _ -> notImplemented "XAmbiguousFieldOcc"
746+ XAmbiguousFieldOcc x -> noExtCon x
685− inci . braces N . sitcc $
748+ inci . braces N $
687− (comma >> breakpoint)
750+ commaDel
688 (sitcc . located' (p_hsRecField . updName))
751 (sitcc . located' (p_hsRecField . updName))
689 rupd_flds
752 rupd_flds
690− ExprWithTySig affix x -> sitcc $ do
753+ ExprWithTySig NoExtField x HsWC {hswc_body = HsIB {..}} -> sitcc $ do
691 located x p_hsExpr
754 located x p_hsExpr
694 breakpoint
757 breakpoint
696− let HsWC {..} = affix
697− HsIB {..} = hswc_body
698− located hsib_body p_hsType
758+ inci $ located hsib_body p_hsType
759+ ExprWithTySig NoExtField _ HsWC {hswc_body = XHsImplicitBndrs x} -> noExtCon x
760+ ExprWithTySig NoExtField _ (XHsWildCardBndrs x) -> noExtCon x
699− ArithSeq NoExt _ x -> do
761+ ArithSeq NoExtField _ x ->
700 case x of
762 case x of
701− From from -> brackets s . sitcc $ do
763+ From from -> brackets s $ do
702 located from p_hsExpr
764 located from p_hsExpr
703 breakpoint
765 breakpoint
705− FromThen from next -> brackets s . sitcc $ do
767+ FromThen from next -> brackets s $ do
706− sitcc $ sep (comma >> breakpoint) (located' p_hsExpr) [from, next]
768+ sep commaDel (located' p_hsExpr) [from, next]
707 breakpoint
769 breakpoint
709− FromTo from to -> brackets s . sitcc $ do
771+ FromTo from to -> brackets s $ do
710 located from p_hsExpr
772 located from p_hsExpr
711 breakpoint
773 breakpoint
714 located to p_hsExpr
776 located to p_hsExpr
715− FromThenTo from next to -> brackets s . sitcc $ do
777+ FromThenTo from next to -> brackets s $ do
716− sitcc $ sep (comma >> breakpoint) (located' p_hsExpr) [from, next]
778+ sep commaDel (located' p_hsExpr) [from, next]
717 breakpoint
779 breakpoint
720 located to p_hsExpr
782 located to p_hsExpr
721− HsSCC NoExt _ name x -> do
783+ HsSCC NoExtField _ name x -> do
722 txt "{-# SCC "
784 txt "{-# SCC "
723 atom name
785 atom name
724 txt " #-}"
786 txt " #-}"
725 breakpoint
787 breakpoint
726 located x p_hsExpr
788 located x p_hsExpr
727− HsCoreAnn NoExt _ value x -> do
789+ HsCoreAnn NoExtField _ value x -> do
728 txt "{-# CORE "
790 txt "{-# CORE "
729 atom value
791 atom value
730 txt " #-}"
792 txt " #-}"
731 breakpoint
793 breakpoint
732 located x p_hsExpr
794 located x p_hsExpr
733− HsBracket NoExt x -> p_hsBracket x
795+ HsBracket NoExtField x -> p_hsBracket x
734 HsRnBracketOut {} -> notImplemented "HsRnBracketOut"
796 HsRnBracketOut {} -> notImplemented "HsRnBracketOut"
735 HsTcBracketOut {} -> notImplemented "HsTcBracketOut"
797 HsTcBracketOut {} -> notImplemented "HsTcBracketOut"
736− HsSpliceE NoExt splice -> p_hsSplice splice
798+ HsSpliceE NoExtField splice -> p_hsSplice splice
737− HsProc NoExt p e -> do
799+ HsProc NoExtField p e -> do
738 txt "proc"
800 txt "proc"
739 located p $ \x -> do
801 located p $ \x -> do
740 breakpoint
802 breakpoint
@@ -747,31 +809,11 @@ p_hsExpr' s = \case
747 txt "static"
809 txt "static"
748 breakpoint
810 breakpoint
749 inci (located e p_hsExpr)
811 inci (located e p_hsExpr)
750− HsArrApp NoExt body input arrType cond ->
751− p_hsCmd (HsCmdArrApp NoExt body input arrType cond)
752− HsArrForm NoExt form mfixity cmds ->
753− p_hsCmd (HsCmdArrForm NoExt form Prefix mfixity cmds)
754 HsTick {} -> notImplemented "HsTick"
812 HsTick {} -> notImplemented "HsTick"
755 HsBinTick {} -> notImplemented "HsBinTick"
813 HsBinTick {} -> notImplemented "HsBinTick"
756 HsTickPragma {} -> notImplemented "HsTickPragma"
814 HsTickPragma {} -> notImplemented "HsTickPragma"
757− -- These four constructs should never appear in correct programs.
758− -- See: https://github.com/tweag/ormolu/issues/343
759− EWildPat NoExt -> txt "_"
760− EAsPat NoExt n p -> do
764− EViewPat NoExt p e -> do
769− inci (located e p_hsExpr)
770− ELazyPat NoExt p -> do
773 HsWrap {} -> notImplemented "HsWrap"
815 HsWrap {} -> notImplemented "HsWrap"
774− XExpr {} -> notImplemented "XExpr"
816+ XExpr x -> noExtCon x
776p_patSynBind :: PatSynBind GhcPs GhcPs -> R ()
818p_patSynBind :: PatSynBind GhcPs GhcPs -> R ()
777p_patSynBind PSB {..} = do
819p_patSynBind PSB {..} = do
@@ -783,7 +825,7 @@ p_patSynBind PSB {..} = do
783 breakpoint
825 breakpoint
784 located psb_def p_pat
826 located psb_def p_pat
785 ImplicitBidirectional -> do
827 ImplicitBidirectional -> do
787 breakpoint
829 breakpoint
788 located psb_def p_pat
830 located psb_def p_pat
789 ExplicitBidirectional mgroup -> do
831 ExplicitBidirectional mgroup -> do
@@ -810,8 +852,8 @@ p_patSynBind PSB {..} = do
810 inci $ do
852 inci $ do
811 switchLayout (getLoc . recordPatSynPatVar <$> xs) $ do
853 switchLayout (getLoc . recordPatSynPatVar <$> xs) $ do
812 unless (null xs) breakpoint
854 unless (null xs) breakpoint
813− braces N . sitcc $
855+ braces N $
814− sep (comma >> breakpoint) (p_rdrName . recordPatSynPatVar) xs
856+ sep commaDel (p_rdrName . recordPatSynPatVar) xs
816 InfixCon l r -> do
858 InfixCon l r -> do
817 switchLayout [getLoc l, getLoc r] $ do
859 switchLayout [getLoc l, getLoc r] $ do
@@ -823,7 +865,7 @@ p_patSynBind PSB {..} = do
824 p_rdrName r
866 p_rdrName r
826−p_patSynBind (XPatSynBind NoExt) = notImplemented "XPatSynBind"
868+p_patSynBind (XPatSynBind x) = noExtCon x
829 Data body =>
871 Data body =>
@@ -834,7 +876,7 @@ p_case ::
834 -- | Expression
876 -- | Expression
835 LHsExpr GhcPs ->
877 LHsExpr GhcPs ->
836 -- | Match group
878 -- | Match group
837− (MatchGroup GhcPs (Located body)) ->
879+ MatchGroup GhcPs (Located body) ->
839p_case placer render e mgroup = do
881p_case placer render e mgroup = do
840 txt "case"
882 txt "case"
@@ -865,10 +907,12 @@ p_if placer render if' then' else' = do
865 breakpoint
907 breakpoint
866 inci $ do
908 inci $ do
867 txt "then"
909 txt "then"
868 located then' $ \x ->
911 located then' $ \x ->
869 placeHanging (placer x) (render x)
912 placeHanging (placer x) (render x)
870 breakpoint
913 breakpoint
871 txt "else"
914 txt "else"
872 located else' $ \x ->
916 located else' $ \x ->
873 placeHanging (placer x) (render x)
917 placeHanging (placer x) (render x)
@@ -890,29 +934,29 @@ p_let render localBinds e = sitcc $ do
891p_pat :: Pat GhcPs -> R ()
935p_pat :: Pat GhcPs -> R ()
892p_pat = \case
936p_pat = \case
893− WildPat NoExt -> txt "_"
937+ WildPat NoExtField -> txt "_"
894− VarPat NoExt name -> p_rdrName name
938+ VarPat NoExtField name -> p_rdrName name
895− LazyPat NoExt pat -> do
939+ LazyPat NoExtField pat -> do
897 located pat p_pat
941 located pat p_pat
898− AsPat NoExt name pat -> do
942+ AsPat NoExtField name pat -> do
899 p_rdrName name
943 p_rdrName name
901 located pat p_pat
945 located pat p_pat
902− ParPat NoExt pat ->
946+ ParPat NoExtField pat ->
903 located pat (parens S . p_pat)
947 located pat (parens S . p_pat)
904− BangPat NoExt pat -> do
948+ BangPat NoExtField pat -> do
906 located pat p_pat
950 located pat p_pat
907− ListPat NoExt pats -> do
951+ ListPat NoExtField pats ->
908− brackets S . sitcc $ sep (comma >> breakpoint) (located' p_pat) pats
952+ brackets S $ sep commaDel (located' p_pat) pats
909− TuplePat NoExt pats boxing -> do
953+ TuplePat NoExtField pats boxing -> do
910− let f =
954+ let parens' =
911 case boxing of
955 case boxing of
912 Boxed -> parens S
956 Boxed -> parens S
913 Unboxed -> parensHash S
957 Unboxed -> parensHash S
914− f . sitcc $ sep (comma >> breakpoint) (sitcc . located' p_pat) pats
958+ parens' $ sep commaDel (sitcc . located' p_pat) pats
915− SumPat NoExt pat tag arity ->
959+ SumPat NoExtField pat tag arity ->
916 p_unboxedSum S tag arity (located pat p_pat)
960 p_unboxedSum S tag arity (located pat p_pat)
917 ConPatIn pat details ->
961 ConPatIn pat details ->
918 case details of
962 case details of
@@ -927,38 +971,40 @@ p_pat = \case
927 let f = \case
971 let f = \case
928 Nothing -> txt ".."
972 Nothing -> txt ".."
929 Just x -> located x p_pat_hsRecField
973 Just x -> located x p_pat_hsRecField
930− inci . braces N . sitcc . sep (comma >> breakpoint) f $
974+ inci . braces N . sep commaDel f $
931 case dotdot of
975 case dotdot of
932 Nothing -> Just <$> fields
976 Nothing -> Just <$> fields
933− Just n -> (Just <$> take n fields) ++ [Nothing]
977+ Just (L _ n) -> (Just <$> take n fields) ++ [Nothing]
934− InfixCon x y -> do
978+ InfixCon l r -> do
979+ switchLayout [getLoc l, getLoc r] $ do
935− located x p_pat
980+ located l p_pat
936− space
981+ breakpoint
937− p_rdrName pat
983+ p_rdrName pat
938− breakpoint
984+ space
939− inci (located y p_pat)
985+ located r p_pat
940 ConPatOut {} -> notImplemented "ConPatOut" -- presumably created by renamer?
986 ConPatOut {} -> notImplemented "ConPatOut" -- presumably created by renamer?
941− ViewPat NoExt expr pat -> sitcc $ do
987+ ViewPat NoExtField expr pat -> sitcc $ do
942 located expr p_hsExpr
988 located expr p_hsExpr
945 breakpoint
991 breakpoint
946 inci (located pat p_pat)
992 inci (located pat p_pat)
947− SplicePat NoExt splice -> p_hsSplice splice
993+ SplicePat NoExtField splice -> p_hsSplice splice
948− LitPat NoExt p -> atom p
994+ LitPat NoExtField p -> atom p
949− NPat NoExt v _ _ -> located v (atom . ol_val)
995+ NPat NoExtField v _ _ -> located v (atom . ol_val)
950− NPlusKPat NoExt n k _ _ _ -> sitcc $ do
996+ NPlusKPat NoExtField n k _ _ _ -> sitcc $ do
951 p_rdrName n
997 p_rdrName n
952 breakpoint
998 breakpoint
953 inci $ do
999 inci $ do
956 located k (atom . ol_val)
1002 located k (atom . ol_val)
957− SigPat hswc pat -> do
1003+ SigPat NoExtField pat hswc -> do
958 located pat p_pat
1004 located pat p_pat
959 p_typeAscription hswc
1005 p_typeAscription hswc
960 CoPat {} -> notImplemented "CoPat" -- apparently created at some later stage
1006 CoPat {} -> notImplemented "CoPat" -- apparently created at some later stage
961− XPat NoExt -> notImplemented "XPat"
1007+ XPat x -> noExtCon x
963p_pat_hsRecField :: HsRecField' (FieldOcc GhcPs) (LPat GhcPs) -> R ()
1009p_pat_hsRecField :: HsRecField' (FieldOcc GhcPs) (LPat GhcPs) -> R ()
964p_pat_hsRecField HsRecField {..} = do
1010p_pat_hsRecField HsRecField {..} = do
@@ -966,7 +1012,7 @@ p_pat_hsRecField HsRecField {..} = do
966 p_rdrName (rdrNameFieldOcc x)
1012 p_rdrName (rdrNameFieldOcc x)
967 unless hsRecPun $ do
1013 unless hsRecPun $ do
970 breakpoint
1016 breakpoint
971 inci (located hsRecFieldArg p_pat)
1017 inci (located hsRecFieldArg p_pat)
@@ -975,32 +1021,31 @@ p_unboxedSum s tag arity m = do
975 let before = tag - 1
1021 let before = tag - 1
976 after = arity - before - 1
1022 after = arity - before - 1
977 args = replicate before Nothing <> [Just m] <> replicate after Nothing
1023 args = replicate before Nothing <> [Just m] <> replicate after Nothing
978− f (x, i) = do
1024+ f x =
979− let isFirst = i == 0
980− isLast = i == arity - 1
981 case x :: Maybe (R ()) of
1025 case x :: Maybe (R ()) of
982 Nothing ->
1026 Nothing ->
983− unless (isFirst || isLast) space
1027+ space
984 Just m' -> do
1028 Just m' -> do
985− unless isFirst space
1029+ space
987− unless isLast space
1031+ space
988− parensHash s $ sep (txt "|") f (zip args [0 ..])
1032+ parensHash s $ sep (txt "|") f args
990p_hsSplice :: HsSplice GhcPs -> R ()
1034p_hsSplice :: HsSplice GhcPs -> R ()
991p_hsSplice = \case
1035p_hsSplice = \case
992− HsTypedSplice NoExt deco _ expr -> p_hsSpliceTH True expr deco
1036+ HsTypedSplice NoExtField deco _ expr -> p_hsSpliceTH True expr deco
993− HsUntypedSplice NoExt deco _ expr -> p_hsSpliceTH False expr deco
1037+ HsUntypedSplice NoExtField deco _ expr -> p_hsSpliceTH False expr deco
994− HsQuasiQuote NoExt _ quoterName srcSpan str -> do
1038+ HsQuasiQuote NoExtField _ quoterName srcSpan str -> do
996 p_rdrName (L srcSpan quoterName)
1040 p_rdrName (L srcSpan quoterName)
998− -- NOTE QuasiQuoters often rely on precise custom strings. We cannot do
1042+ -- QuasiQuoters often rely on precise custom strings. We cannot do any
999− -- any formatting here without potentially breaking someone's code.
1043+ -- formatting here without potentially breaking someone's code.
1000 atom str
1044 atom str
1001 txt "|]"
1045 txt "|]"
1002 HsSpliced {} -> notImplemented "HsSpliced"
1046 HsSpliced {} -> notImplemented "HsSpliced"
1003− XSplice {} -> notImplemented "XSplice"
1047+ HsSplicedT {} -> notImplemented "HsSplicedT"
1048+ XSplice x -> noExtCon x
1005p_hsSpliceTH ::
1050p_hsSpliceTH ::
1006 -- | Typed splice?
1051 -- | Typed splice?
@@ -1024,17 +1069,17 @@ p_hsSpliceTH isTyped expr = \case
1025p_hsBracket :: HsBracket GhcPs -> R ()
1070p_hsBracket :: HsBracket GhcPs -> R ()
1026p_hsBracket = \case
1071p_hsBracket = \case
1027− ExpBr NoExt expr -> do
1072+ ExpBr NoExtField expr -> do
1028 anns <- getEnclosingAnns
1073 anns <- getEnclosingAnns
1029 let name = case anns of
1074 let name = case anns of
1030 AnnOpenEQ : _ -> ""
1075 AnnOpenEQ : _ -> ""
1031 _ -> "e"
1076 _ -> "e"
1032 quote name (located expr p_hsExpr)
1077 quote name (located expr p_hsExpr)
1033− PatBr NoExt pat -> quote "p" (located pat p_pat)
1078+ PatBr NoExtField pat -> located pat (quote "p" . p_pat)
1034− DecBrL NoExt decls -> quote "d" (p_hsDecls Free decls)
1079+ DecBrL NoExtField decls -> quote "d" (p_hsDecls Free decls)
1035− DecBrG NoExt _ -> notImplemented "DecBrG" -- result of renamer
1080+ DecBrG NoExtField _ -> notImplemented "DecBrG" -- result of renamer
1036− TypBr NoExt ty -> quote "t" (located ty p_hsType)
1081+ TypBr NoExtField ty -> quote "t" (located ty p_hsType)
1037− VarBr NoExt isSingleQuote name -> do
1082+ VarBr NoExtField isSingleQuote name -> do
1038 txt (bool "''" "'" isSingleQuote)
1083 txt (bool "''" "'" isSingleQuote)
1039 -- 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
1040 -- 'p_rdrName' since the latter expects a "located" thing. The problem
1085 -- 'p_rdrName' since the latter expects a "located" thing. The problem
@@ -1049,13 +1094,13 @@ p_hsBracket = \case
1049 && not (doesNotNeedExtraParens name)
1094 && not (doesNotNeedExtraParens name)
1050 wrapper = if isOperator then parens N else id
1095 wrapper = if isOperator then parens N else id
1051 wrapper $ p_rdrName (noLoc name)
1096 wrapper $ p_rdrName (noLoc name)
1052− TExpBr NoExt expr -> do
1097+ TExpBr NoExtField expr -> do
1053 txt "[||"
1098 txt "[||"
1054 breakpoint'
1099 breakpoint'
1055 located expr p_hsExpr
1100 located expr p_hsExpr
1056 breakpoint'
1101 breakpoint'
1057 txt "||]"
1102 txt "||]"
1058− XBracket {} -> notImplemented "XBracket"
1103+ XBracket x -> noExtCon x
1060 quote :: Text -> R () -> R ()
1105 quote :: Text -> R () -> R ()
1061 quote name body = do
1106 quote name body = do
@@ -1134,9 +1179,9 @@ liftAppend (x : xs) [] = x : xs
1134liftAppend (x : xs) (y : ys) = x <> y : liftAppend xs ys
1179liftAppend (x : xs) (y : ys) = x <> y : liftAppend xs ys
1136getGRHSSpan :: GRHS GhcPs (Located body) -> SrcSpan
1181getGRHSSpan :: GRHS GhcPs (Located body) -> SrcSpan
1137−getGRHSSpan (GRHS NoExt guards body) =
1182+getGRHSSpan (GRHS NoExtField guards body) =
1138 combineSrcSpans' $ getLoc body :| map getLoc guards
1183 combineSrcSpans' $ getLoc body :| map getLoc guards
1139−getGRHSSpan (XGRHS NoExt) = notImplemented "XGRHS"
1184+getGRHSSpan (XGRHS x) = noExtCon x
1141-- | 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
1142-- to separate it from preceding expressions and whether to bump indentation
1187-- to separate it from preceding expressions and whether to bump indentation
@@ -1157,46 +1202,44 @@ blockPlacement ::
1157 (body -> Placement) ->
1202 (body -> Placement) ->
1158 [LGRHS GhcPs (Located body)] ->
1203 [LGRHS GhcPs (Located body)] ->
1159 Placement
1204 Placement
1160−blockPlacement placer [(L _ (GRHS NoExt _ (L _ x)))] = placer x
1205+blockPlacement placer [L _ (GRHS NoExtField _ (L _ x))] = placer x
1161blockPlacement _ _ = Normal
1206blockPlacement _ _ = Normal
1163-- | Check if given command has a hanging form.
1208-- | Check if given command has a hanging form.
1164cmdPlacement :: HsCmd GhcPs -> Placement
1209cmdPlacement :: HsCmd GhcPs -> Placement
1165cmdPlacement = \case
1210cmdPlacement = \case
1166− HsCmdLam NoExt _ -> Hanging
1211+ HsCmdLam NoExtField _ -> Hanging
1167− HsCmdCase NoExt _ _ -> Hanging
1212+ HsCmdCase NoExtField _ _ -> Hanging
1168− HsCmdDo NoExt _ -> Hanging
1213+ HsCmdDo NoExtField _ -> Hanging
1169 _ -> Normal
1214 _ -> Normal
1171cmdTopPlacement :: HsCmdTop GhcPs -> Placement
1216cmdTopPlacement :: HsCmdTop GhcPs -> Placement
1172cmdTopPlacement = \case
1217cmdTopPlacement = \case
1173− HsCmdTop NoExt (L _ x) -> cmdPlacement x
1218+ HsCmdTop NoExtField (L _ x) -> cmdPlacement x
1174− XCmdTop {} -> notImplemented "XCmdTop"
1219+ XCmdTop x -> noExtCon x
1176-- | Check if given expression has a hanging form.
1221-- | Check if given expression has a hanging form.
1177exprPlacement :: HsExpr GhcPs -> Placement
1222exprPlacement :: HsExpr GhcPs -> Placement
1178exprPlacement = \case
1223exprPlacement = \case
1179 -- Only hang lambdas with single line parameter lists
1224 -- Only hang lambdas with single line parameter lists
1180− HsLam NoExt mg -> case mg of
1225+ HsLam NoExtField mg -> case mg of
1181− MG _ (L _ [L _ (Match NoExt _ (x : xs) _)]) _
1226+ MG _ (L _ [L _ (Match NoExtField _ (x : xs) _)]) _
1182 | isOneLineSpan (combineSrcSpans' $ fmap getLoc (x :| xs)) ->
1227 | isOneLineSpan (combineSrcSpans' $ fmap getLoc (x :| xs)) ->
1184 _ -> Normal
1229 _ -> Normal
1185− HsLamCase NoExt _ -> Hanging
1230+ HsLamCase NoExtField _ -> Hanging
1186− HsCase NoExt _ _ -> Hanging
1231+ HsCase NoExtField _ _ -> Hanging
1187− HsDo NoExt DoExpr _ -> Hanging
1232+ HsDo NoExtField DoExpr _ -> Hanging
1188− HsDo NoExt MDoExpr _ -> Hanging
1233+ HsDo NoExtField MDoExpr _ -> Hanging
1189− RecordCon NoExt _ _ -> Hanging
1234+ OpApp NoExtField _ op y ->
1190− -- If the rightmost expression in an operator chain is hanging, make the
1235+ case (fmap getOpNameStr . getOpName . unLoc) op of
1191− -- whole block hanging; so that we can use the common @f = foo $ do@
1193− OpApp NoExt _ _ y -> exprPlacement (unLoc y)
1236+ Just "$" -> exprPlacement (unLoc y)
1194− -- Same thing for function applications (usually with -XBlockArguments)
1237+ _ -> Normal
1195− HsApp NoExt _ y -> exprPlacement (unLoc y)
1238+ HsApp NoExtField _ y -> exprPlacement (unLoc y)
1196− HsProc NoExt (L s _) _ ->
1239+ HsProc NoExtField p _ ->
1197 -- Indentation breaks if pattern is longer than one line and left
1240 -- Indentation breaks if pattern is longer than one line and left
1198 -- hanging. Consequently, only apply hanging when it is safe.
1241 -- hanging. Consequently, only apply hanging when it is safe.
1199− if isOneLineSpan s
1242+ if isOneLineSpan (getLoc p)
1200 then Hanging
1243 then Hanging
1201 else Normal
1244 else Normal
1202 _ -> Normal
1245 _ -> Normal
@@ -1205,30 +1248,31 @@ withGuards :: [LGRHS GhcPs (Located body)] -> Bool
1205withGuards = any (checkOne . unLoc)
1248withGuards = any (checkOne . unLoc)
1207 checkOne :: GRHS GhcPs (Located body) -> Bool
1250 checkOne :: GRHS GhcPs (Located body) -> Bool
1208− checkOne (GRHS NoExt [] _) = False
1251+ checkOne (GRHS NoExtField [] _) = False
1209 checkOne _ = True
1252 checkOne _ = True
1211exprOpTree :: LHsExpr GhcPs -> OpTree (LHsExpr GhcPs) (LHsExpr GhcPs)
1254exprOpTree :: LHsExpr GhcPs -> OpTree (LHsExpr GhcPs) (LHsExpr GhcPs)
1212−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)
1213exprOpTree n = OpNode n
1256exprOpTree n = OpNode n
1215getOpName :: HsExpr GhcPs -> Maybe RdrName
1258getOpName :: HsExpr GhcPs -> Maybe RdrName
1216getOpName = \case
1259getOpName = \case
1217− HsVar NoExt (L _ a) -> Just a
1260+ HsVar NoExtField (L _ a) -> Just a
1218 _ -> Nothing
1261 _ -> Nothing
1263+getOpNameStr :: RdrName -> String
1264+getOpNameStr = occNameString . rdrNameOcc
1220p_exprOpTree ::
1266p_exprOpTree ::
1221− -- | Can use special handling of dollar?
1223 -- | Bracket style to use
1267 -- | Bracket style to use
1224 BracketStyle ->
1268 BracketStyle ->
1225 OpTree (LHsExpr GhcPs) (LHsExpr GhcPs) ->
1269 OpTree (LHsExpr GhcPs) (LHsExpr GhcPs) ->
1227−p_exprOpTree _ s (OpNode x) = located x (p_hsExpr' s)
1271+p_exprOpTree s (OpNode x) = located x (p_hsExpr' s)
1228−p_exprOpTree isDollarSpecial s (OpBranch x op y) = do
1272+p_exprOpTree s (OpBranch x op y) = do
1229− -- NOTE If the beginning of the first argument and the second argument
1273+ -- If the beginning of the first argument and the second argument are on
1230− -- are on the same line, and the second argument has a hanging form, use
1274+ -- the same line, and the second argument has a hanging form, use hanging
1231− -- hanging placement.
1275+ -- placement.
1232 let placement =
1276 let placement =
1233 if isOneLineSpan
1277 if isOneLineSpan
1234 (mkSrcSpan (srcSpanStart (opTreeLoc x)) (srcSpanStart (opTreeLoc y)))
1278 (mkSrcSpan (srcSpanStart (opTreeLoc x)) (srcSpanStart (opTreeLoc y)))
@@ -1236,8 +1280,10 @@ p_exprOpTree isDollarSpecial s (OpBranch x op y) = do
1236 OpNode (L _ n) -> exprPlacement n
1280 OpNode (L _ n) -> exprPlacement n
1237 _ -> Normal
1281 _ -> Normal
1238 else Normal
1282 else Normal
1283+ -- Distinguish holes used in infix notation.
1284+ -- eg. '1 _foo 2' and '1 `_foo` 2'
1239 opWrapper = case unLoc op of
1285 opWrapper = case unLoc op of
1240− EWildPat NoExt -> backticks
1286+ HsUnboundVar NoExtField _ -> backticks
1242 layout <- getLayout
1288 layout <- getLayout
1243 let ub = case layout of
1289 let ub = case layout of
@@ -1245,24 +1291,67 @@ p_exprOpTree isDollarSpecial s (OpBranch x op y) = do
1245 MultiLine -> case placement of
1291 MultiLine -> case placement of
1246 Hanging -> useBraces
1292 Hanging -> useBraces
1247 Normal -> dontUseBraces
1293 Normal -> dontUseBraces
1248− gotDollar = case getOpName (unLoc op) of
1294+ opNameStr = (fmap getOpNameStr . getOpName . unLoc) op
1249− Just rname -> mkVarOcc "$" == (rdrNameOcc rname)
1295+ gotDollar = opNameStr == Just "$"
1296+ gotColon = opNameStr == Just ":"
1297+ gotRecordDot = isRecordDot (unLoc op) (opTreeLoc y)
1299+ switchLayout [opTreeLoc x] $
1301+ p_op = located op (opWrapper . p_hsExpr)
1302+ p_y = switchLayout [opTreeLoc y] (p_exprOpTree N y)
1303+ isSection = case (opTreeLoc x, getLoc op) of
1304+ (RealSrcSpan treeSpan, RealSrcSpan opSpan) ->
1305+ srcSpanEndCol treeSpan /= srcSpanStartCol opSpan
1250 _ -> False
1306 _ -> False
1251− switchLayout [opTreeLoc x]
1307+ isDoBlock = \case
1252− $ ub
1308+ OpNode (L _ HsDo {}) -> True
1253− $ p_exprOpTree (not gotDollar) s x
1309+ _ -> False
1254− let p_op = located op (opWrapper . p_hsExpr)
1310+ useRecordDot' <- useRecordDot
1255− p_y = switchLayout [opTreeLoc y] (p_exprOpTree True N y)
1311+ if
1322+ inciIf (isDoBlock y) p_y
1256− if isDollarSpecial && gotDollar && placement == Normal && isOneLineSpan (opTreeLoc x)
1324+ && isOneLineSpan (opTreeLoc x)
1257− then do
1325+ && placement == Normal -> do
1260− breakpoint
1329+ breakpoint
1261− inci p_y
1330+ inci p_y
1331+ | useRecordDot' && gotRecordDot -> do
1333+ when isSection space
1262− else placeHanging placement $ do
1338+ placeHanging placement $ do
1343+-- | Return 'True' if given expression is a record-dot operator expression.
1345+ -- | Operator expression
1347+ -- | Span of the expression on the right-hand side of the operator
1350+isRecordDot op (RealSrcSpan ySpan) = case op of
1351+ HsVar NoExtField (L (RealSrcSpan opSpan) opName) ->
1352+ (getOpNameStr opName == ".") && (srcSpanEndCol opSpan == srcSpanStartCol ySpan)
1354+isRecordDot _ _ = False
1267-- | Get annotations for the enclosing element.
1356-- | Get annotations for the enclosing element.
1268getEnclosingAnns :: R [AnnKeywordId]
1357getEnclosingAnns :: R [AnnKeywordId]