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