@@ -1,13 +1,15 @@
1−{-# LANGUAGE LambdaCase #-}
1+{-# LANGUAGE LambdaCase #-}
2+{-# LANGUAGE MultiWayIf #-}
23{-# LANGUAGE OverloadedStrings #-}
3−{-# LANGUAGE RecordWildCards #-}
4+{-# LANGUAGE RecordWildCards #-}
5+{-# LANGUAGE TypeApplications #-}
46
57module Ormolu.Printer.Meat.Declaration.Value
6− ( p_valDecl
7− , p_pat
8− , p_hsExpr
9− , p_hsSplice
10− , p_stringLit
8+ ( p_valDecl,
9+ p_pat,
10+ p_hsExpr,
11+ p_hsSplice,
12+ p_stringLit,
1113 )
1214where
1315
@@ -18,26 +20,24 @@ import Ctype (is_space)
1820import Data.Bool (bool)
1921import Data.Char (isPunctuation, isSymbol)
2022import Data.Data hiding (Infix, Prefix)
23+import Data.Functor ((<&>))
2124import Data.List (intersperse, sortOn)
22−import Data.List.NonEmpty (NonEmpty ((:|)))
25+import Data.List.NonEmpty (NonEmpty (..), (<|))
26+import qualified Data.List.NonEmpty as NE
2327import Data.Text (Text)
28+import qualified Data.Text as Text
2429import GHC
25−import OccName (mkVarOcc)
30+import OccName (occNameString)
2631import Ormolu.Printer.Combinators
32+import Ormolu.Printer.Internal
2733import Ormolu.Printer.Meat.Common
34+import {-# SOURCE #-} Ormolu.Printer.Meat.Declaration
2835import Ormolu.Printer.Meat.Declaration.Signature
2936import Ormolu.Printer.Meat.Type
3037import Ormolu.Printer.Operators
3138import Ormolu.Utils
32−import RdrName (RdrName (..))
33−import RdrName (rdrNameOcc)
34−import SrcLoc (combineSrcSpans, isOneLineSpan)
35−import qualified Data.List.NonEmpty as NE
36−import qualified Data.Text as Text
37−import {-# SOURCE #-} Ormolu.Printer.Meat.Declaration
3839
3940-- | Style of a group of equations.
40−
4141data MatchGroupStyle
4242 = Function (Located RdrName)
4343 | PatternBind
@@ -46,57 +46,61 @@ data MatchGroupStyle
4646 | LambdaCase
4747
4848-- | Style of equations in a group.
49−
5049data GroupStyle
5150 = EqualSign
5251 | RightArrow
5352
5453-- | Expression placement. This marks the places where expressions that
5554-- implement handing forms may use them.
56−
5755data Placement
58− = Normal -- ^ Multi-line layout should cause
59− -- insertion of a newline and indentation
60− -- bump
61− | Hanging -- ^ Expressions that have hanging form
62− -- should use it and avoid bumping one level
63− -- of indentation
64− deriving (Eq)
56+ = -- | Multi-line layout should cause
57+ -- insertion of a newline and indentation
58+ -- bump
59+ Normal
60+ | -- | Expressions that have hanging form
61+ -- should use it and avoid bumping one level
62+ -- of indentation
63+ Hanging
64+ deriving (Eq, Show)
6565
6666p_valDecl :: HsBindLR GhcPs GhcPs -> R ()
6767p_valDecl = \case
68− FunBind NoExt funId funMatches _ _ -> p_funBind funId funMatches
69− PatBind NoExt pat grhss _ -> p_match PatternBind False NoSrcStrict [pat] grhss
68+ FunBind NoExtField funId funMatches _ _ -> p_funBind funId funMatches
69+ PatBind NoExtField pat grhss _ -> p_match PatternBind False NoSrcStrict [pat] grhss
7070 VarBind {} -> notImplemented "VarBinds" -- introduced by the type checker
7171 AbsBinds {} -> notImplemented "AbsBinds" -- introduced by the type checker
72− PatSynBind NoExt psb -> p_patSynBind psb
73− XHsBindsLR NoExt -> notImplemented "XHsBindsLR"
72+ PatSynBind NoExtField psb -> p_patSynBind psb
73+ XHsBindsLR x -> noExtCon x
7474
75−p_funBind
76− :: Located RdrName
77− -> MatchGroup GhcPs (LHsExpr GhcPs)
78− -> R ()
75+p_funBind ::
76+ Located RdrName ->
77+ MatchGroup GhcPs (LHsExpr GhcPs) ->
78+ R ()
7979p_funBind name = p_matchGroup (Function name)
8080
81−p_matchGroup
82− :: MatchGroupStyle
83− -> MatchGroup GhcPs (LHsExpr GhcPs)
84− -> R ()
81+p_matchGroup ::
82+ MatchGroupStyle ->
83+ MatchGroup GhcPs (LHsExpr GhcPs) ->
84+ R ()
8585p_matchGroup = p_matchGroup' exprPlacement p_hsExpr
8686
87−p_matchGroup'
88− :: Data body
89− => (body -> Placement) -- ^ How to get body placement
90− -> (body -> R ()) -- ^ How to print body
91− -> MatchGroupStyle -- ^ Style of this group of equations
92− -> MatchGroup GhcPs (Located body) -- ^ Match group
93− -> R ()
87+p_matchGroup' ::
88+ Data body =>
89+ -- | How to get body placement
90+ (body -> Placement) ->
91+ -- | How to print body
92+ (body -> R ()) ->
93+ -- | Style of this group of equations
94+ MatchGroupStyle ->
95+ -- | Match group
96+ MatchGroup GhcPs (Located body) ->
97+ R ()
9498p_matchGroup' placer render style MG {..} = do
9599 let ob = case style of
96100 Case -> id
97101 LambdaCase -> id
98102 _ -> dontUseBraces
99− -- 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
100104 -- restore the brace state inside the sepsemi.
101105 ub <- bool dontUseBraces useBraces <$> canUseBraces
102106 ob $ sepSemi (located' (ub . p_Match)) (unLoc mg_alts)
@@ -110,8 +114,8 @@ p_matchGroup' placer render style MG {..} = do
110114 (matchStrictness m)
111115 m_pats
112116 m_grhss
113− p_Match _ = notImplemented "XMatch"
114−p_matchGroup' _ _ _ (XMatchGroup NoExt) = notImplemented "XMatchGroup"
117+ p_Match (XMatch x) = noExtCon x
118+p_matchGroup' _ _ _ (XMatchGroup x) = noExtCon x
115119
116120-- | Function id obtained through pattern matching on 'FunBind' should not
117121-- be used to print the actual equations because the different ‘RdrNames’
@@ -119,11 +123,10 @@ p_matchGroup' _ _ _ (XMatchGroup NoExt) = notImplemented "XMatchGroup"
119123-- and paretheses) associated with them. It is necessary to use per-equation
120124-- names obtained from 'm_ctxt' of 'Match'. This function replaces function
121125-- name inside of 'Function' accordingly.
122−
123−adjustMatchGroupStyle
124− :: Match GhcPs body
125− -> MatchGroupStyle
126− -> MatchGroupStyle
126+adjustMatchGroupStyle ::
127+ Match GhcPs body ->
128+ MatchGroupStyle ->
129+ MatchGroupStyle
127130adjustMatchGroupStyle m = \case
128131 Function _ -> (Function . mc_fun . m_ctxt) m
129132 style -> style
@@ -131,31 +134,43 @@ adjustMatchGroupStyle m = \case
131134matchStrictness :: Match id body -> SrcStrictness
132135matchStrictness match =
133136 case m_ctxt match of
134− FunRhs{mc_strictness=s} -> s
137+ FunRhs {mc_strictness = s} -> s
135138 _ -> NoSrcStrict
136139
137−p_match
138− :: MatchGroupStyle -- ^ Style of the group
139− -> Bool -- ^ Is this an infix match?
140− -> SrcStrictness -- ^ Strictness prefix (FunBind)
141− -> [LPat GhcPs] -- ^ Argument patterns
142− -> GRHSs GhcPs (LHsExpr GhcPs) -- ^ Equations
143− -> R ()
140+p_match ::
141+ -- | Style of the group
142+ MatchGroupStyle ->
143+ -- | Is this an infix match?
144+ Bool ->
145+ -- | Strictness prefix (FunBind)
146+ SrcStrictness ->
147+ -- | Argument patterns
148+ [LPat GhcPs] ->
149+ -- | Equations
150+ GRHSs GhcPs (LHsExpr GhcPs) ->
151+ R ()
144152p_match = p_match' exprPlacement p_hsExpr
145153
146−p_match'
147− :: Data body
148− => (body -> Placement) -- ^ How to get body placement
149− -> (body -> R ()) -- ^ How to print body
150− -> MatchGroupStyle -- ^ Style of this group of equations
151− -> Bool -- ^ Is this an infix match?
152− -> SrcStrictness -- ^ Strictness prefix (FunBind)
153− -> [LPat GhcPs] -- ^ Argument patterns
154− -> GRHSs GhcPs (Located body) -- ^ Equations
155− -> R ()
156−p_match' placer render style isInfix strictness m_pats m_grhss = do
157− -- NOTE Normally, since patterns may be placed in a multi-line layout, it
158− -- is necessary to bump indentation for the pattern group so it's more
154+p_match' ::
155+ Data body =>
156+ -- | How to get body placement
157+ (body -> Placement) ->
158+ -- | How to print body
159+ (body -> R ()) ->
160+ -- | Style of this group of equations
161+ MatchGroupStyle ->
162+ -- | Is this an infix match?
163+ Bool ->
164+ -- | Strictness prefix (FunBind)
165+ SrcStrictness ->
166+ -- | Argument patterns
167+ [LPat GhcPs] ->
168+ -- | Equations
169+ GRHSs GhcPs (Located body) ->
170+ R ()
171+p_match' placer render style isInfix strictness m_pats GRHSs {..} = do
172+ -- Normally, since patterns may be placed in a multi-line layout, it is
173+ -- necessary to bump indentation for the pattern group so it's more
159174 -- indented than function name. This in turn means that indentation for
160175 -- the body should also be bumped. Normally this would mean that bodies
161176 -- would start with two indentation steps applied, which is ugly, so we
@@ -165,23 +180,24 @@ p_match' placer render style isInfix strictness m_pats m_grhss = do
165180 NoSrcStrict -> return ()
166181 SrcStrict -> txt "!"
167182 SrcLazy -> txt "~"
168− inci' <- case NE.nonEmpty m_pats of
169− Nothing -> id <$ case style of
170− Function name -> p_rdrName name
171− _ -> return ()
183+ indentBody <- case NE.nonEmpty m_pats of
184+ Nothing ->
185+ False <$ case style of
186+ Function name -> p_rdrName name
187+ _ -> return ()
172188 Just ne_pats -> do
173− let combinedSpans = combineSrcSpans' $
174− getLoc <$> ne_pats
175− inci' = if isOneLineSpan combinedSpans
176− then id
177− else inci
189+ let combinedSpans = case style of
190+ Function name -> combineSrcSpans (getLoc name) patSpans
191+ _ -> patSpans
192+ patSpans = combineSrcSpans' (getLoc <$> ne_pats)
193+ indentBody = not (isOneLineSpan combinedSpans)
178194 switchLayout [combinedSpans] $ do
179195 let stdCase = sep breakpoint (located' p_pat) m_pats
180196 case style of
181197 Function name ->
182198 p_infixDefHelper
183199 isInfix
184− inci'
200+ indentBody
185201 (p_rdrName name)
186202 (located' p_pat <$> m_pats)
187203 PatternBind -> stdCase
@@ -196,45 +212,39 @@ p_match' placer render style isInfix strictness m_pats m_grhss = do
196212 when needsSpace space
197213 sitcc stdCase
198214 LambdaCase -> stdCase
199− return inci'
200− let
201− -- Calculate position of end of patterns. This is useful when we decide
202− -- about putting certain constructions in hanging positions.
203− endOfPats = case NE.nonEmpty m_pats of
204− Nothing -> case style of
205− Function name -> (Just . srcSpanEnd . getLoc) name
206− _ -> Nothing
207− Just pats -> (Just . srcSpanEnd . getLoc . NE.last) pats
208− isCase = \case
209− Case -> True
210− LambdaCase -> True
211− _ -> False
212− let GRHSs {..} = m_grhss
215+ return indentBody
216+ let -- Calculate position of end of patterns. This is useful when we decide
217+ -- about putting certain constructions in hanging positions.
218+ endOfPats = case NE.nonEmpty m_pats of
219+ Nothing -> case style of
220+ Function name -> Just (getLoc name)
221+ _ -> Nothing
222+ Just pats -> (Just . getLoc . NE.last) pats
223+ isCase = \case
224+ Case -> True
225+ LambdaCase -> True
226+ _ -> False
213227 hasGuards = withGuards grhssGRHSs
214− unless (length grhssGRHSs > 1) $ do
215− case style of
216− Function _ | hasGuards -> return ()
217− Function _ -> space >> txt "="
218− PatternBind -> space >> txt "="
219− s | isCase s && hasGuards -> return ()
220− _ -> space >> txt "->"
221− let grhssSpan = combineSrcSpans' $
222− getGRHSSpan . unLoc <$> NE.fromList grhssGRHSs
223− patGrhssSpan = maybe grhssSpan
224− (combineSrcSpans grhssSpan . srcLocSpan) endOfPats
228+ grhssSpan =
229+ combineSrcSpans' $
230+ getGRHSSpan . unLoc <$> NE.fromList grhssGRHSs
231+ patGrhssSpan =
232+ maybe
233+ grhssSpan
234+ (combineSrcSpans grhssSpan . srcLocSpan . srcSpanEnd)
235+ endOfPats
225236 placement =
226237 case endOfPats of
227238 Nothing -> blockPlacement placer grhssGRHSs
228239 Just spn ->
229− if isOneLineSpan
230− (mkSrcSpan spn (srcSpanStart grhssSpan))
240+ if onTheSameLine spn grhssSpan
231241 then blockPlacement placer grhssGRHSs
232242 else Normal
233243 p_body = do
234244 let groupStyle =
235245 if isCase style && hasGuards
236− then RightArrow
237− else EqualSign
246+ then RightArrow
247+ else EqualSign
238248 sep newline (located' (p_grhs' placer render groupStyle)) grhssGRHSs
239249 p_where = do
240250 let whereIsEmpty = GHC.isEmptyLocalBindsPR (unLoc grhssLocalBinds)
@@ -243,134 +253,178 @@ p_match' placer render style isInfix strictness m_pats m_grhss = do
243253 txt "where"
244254 unless whereIsEmpty breakpoint
245255 inci $ located grhssLocalBinds p_hsLocalBinds
246− inci' $ do
256+ inciIf indentBody $ do
257+ unless (length grhssGRHSs > 1) $
258+ case style of
259+ Function _ | hasGuards -> return ()
260+ Function _ -> space >> inci equals
261+ PatternBind -> space >> inci equals
262+ s | isCase s && hasGuards -> return ()
263+ _ -> space >> txt "->"
247264 switchLayout [patGrhssSpan] $
248265 placeHanging placement p_body
249266 inci p_where
267+p_match' _ _ _ _ _ _ (XGRHSs x) = noExtCon x
250268
251269p_grhs :: GroupStyle -> GRHS GhcPs (LHsExpr GhcPs) -> R ()
252270p_grhs = p_grhs' exprPlacement p_hsExpr
253271
254−p_grhs'
255− :: Data body
256− => (body -> Placement) -- ^ How to get body placement
257− -> (body -> R ()) -- ^ How to print body
258− -> GroupStyle
259− -> GRHS GhcPs (Located body)
260− -> R ()
261−p_grhs' placer render style (GRHS NoExt guards body) =
272+p_grhs' ::
273+ Data body =>
274+ -- | How to get body placement
275+ (body -> Placement) ->
276+ -- | How to print body
277+ (body -> R ()) ->
278+ GroupStyle ->
279+ GRHS GhcPs (Located body) ->
280+ R ()
281+p_grhs' placer render style (GRHS NoExtField guards body) =
262282 case guards of
263283 [] -> p_body
264284 xs -> do
265285 txt "|"
266286 space
267− sitcc (sep (comma >> breakpoint) (sitcc . located' p_stmt) xs)
287+ sitcc (sep commaDel (sitcc . located' p_stmt) xs)
268288 space
269− txt $ case style of
270− EqualSign -> "="
271− RightArrow -> "->"
289+ inci $ case style of
290+ EqualSign -> equals
291+ RightArrow -> txt "->"
272292 placeHanging placement p_body
273293 where
274294 placement =
275295 case endOfGuards of
276296 Nothing -> placer (unLoc body)
277297 Just spn ->
278− if isOneLineSpan (mkSrcSpan spn (srcSpanStart (getLoc body)))
279− then placer (unLoc body)
280− else Normal
298+ if onTheSameLine spn (getLoc body)
299+ then placer (unLoc body)
300+ else Normal
281301 endOfGuards =
282302 case NE.nonEmpty guards of
283303 Nothing -> Nothing
284− Just gs -> (Just . srcSpanEnd . getLoc . NE.last) gs
304+ Just gs -> (Just . getLoc . NE.last) gs
285305 p_body = located body render
286−p_grhs' _ _ _ (XGRHS NoExt) = notImplemented "XGRHS"
306+p_grhs' _ _ _ (XGRHS x) = noExtCon x
287307
288308p_hsCmd :: HsCmd GhcPs -> R ()
289309p_hsCmd = \case
290− HsCmdArrApp NoExt body input arrType _ -> do
310+ HsCmdArrApp NoExtField body input arrType _ -> do
291311 located body p_hsExpr
292− space
293− case arrType of
294− HsFirstOrderApp -> txt "-<"
295− HsHigherOrderApp -> txt "-<<"
296− placeHanging (exprPlacement (unLoc input)) $
297− located input p_hsExpr
298− HsCmdArrForm NoExt form Prefix _ cmds -> banana $ sitcc $ do
312+ breakpoint
313+ inci $ do
314+ case arrType of
315+ HsFirstOrderApp -> txt "-<"
316+ HsHigherOrderApp -> txt "-<<"
317+ placeHanging (exprPlacement (unLoc input)) $
318+ located input p_hsExpr
319+ HsCmdArrForm NoExtField form Prefix _ cmds -> banana $ do
299320 located form p_hsExpr
300321 unless (null cmds) $ do
301322 breakpoint
302323 inci (sequence_ (intersperse breakpoint (located' p_hsCmdTop <$> cmds)))
303− HsCmdArrForm NoExt form Infix _ [left, right] -> do
324+ HsCmdArrForm NoExtField form Infix _ [left, right] -> do
304325 located left p_hsCmdTop
305326 space
306327 located form p_hsExpr
307328 placeHanging (cmdTopPlacement (unLoc right)) $
308329 located right p_hsCmdTop
309− HsCmdArrForm NoExt _ Infix _ _ -> notImplemented "HsCmdArrForm"
330+ HsCmdArrForm NoExtField _ Infix _ _ -> notImplemented "HsCmdArrForm"
310331 HsCmdApp {} ->
311332 -- XXX Does this ever occur in the syntax tree? It does not seem like it
312333 -- does. Open an issue and ping @yumiova if this ever occurs in output.
313334 notImplemented "HsCmdApp"
314− HsCmdLam NoExt mgroup -> p_matchGroup' cmdPlacement p_hsCmd Lambda mgroup
315− HsCmdPar NoExt c -> parens N (located c p_hsCmd)
316− HsCmdCase NoExt e mgroup ->
335+ HsCmdLam NoExtField mgroup -> p_matchGroup' cmdPlacement p_hsCmd Lambda mgroup
336+ HsCmdPar NoExtField c -> parens N (located c p_hsCmd)
337+ HsCmdCase NoExtField e mgroup ->
317338 p_case cmdPlacement p_hsCmd e mgroup
318− HsCmdIf NoExt _ if' then' else' ->
339+ HsCmdIf NoExtField _ if' then' else' ->
319340 p_if cmdPlacement p_hsCmd if' then' else'
320− HsCmdLet NoExt localBinds c ->
341+ HsCmdLet NoExtField localBinds c ->
321342 p_let p_hsCmd localBinds c
322− HsCmdDo NoExt es -> do
343+ HsCmdDo NoExtField es -> do
323344 txt "do"
324345 newline
325346 inci . located es $
326− sitcc . sep newline (located' (sitcc . p_stmt' cmdPlacement p_hsCmd))
347+ sitcc . sep newline (sitcc . withSpacing (p_stmt' cmdPlacement p_hsCmd))
327348 HsCmdWrap {} -> notImplemented "HsCmdWrap"
328− XCmd {} -> notImplemented "XCmd"
349+ XCmd x -> noExtCon x
329350
330351p_hsCmdTop :: HsCmdTop GhcPs -> R ()
331352p_hsCmdTop = \case
332− HsCmdTop NoExt cmd -> located cmd p_hsCmd
333− XCmdTop {} -> notImplemented "XHsCmdTop"
353+ HsCmdTop NoExtField cmd -> located cmd p_hsCmd
354+ XCmdTop x -> noExtCon x
355+
356+-- | Render an expression preserving blank lines between such consecutive
357+-- expressions found in the original source code.
358+withSpacing ::
359+ -- | Rendering function
360+ (a -> R ()) ->
361+ -- | Entity to render
362+ Located a ->
363+ R ()
364+withSpacing f l = located l $ \x -> do
365+ case getLoc l of
366+ UnhelpfulSpan _ -> f x
367+ RealSrcSpan currentSpn -> do
368+ getSpanMark >>= \case
369+ -- Spacing before comments will be handled by the code
370+ -- that prints comments, so we just have to deal with
371+ -- blank lines between statements here.
372+ Just (StatementSpan lastSpn) ->
373+ if srcSpanStartLine currentSpn > srcSpanEndLine lastSpn + 1
374+ then newline
375+ else return ()
376+ _ -> return ()
377+ f x
378+ -- In some cases the (f x) expression may insert a new mark. We want
379+ -- to be careful not to override comment marks.
380+ getSpanMark >>= \case
381+ Just (HaddockSpan _ _) -> return ()
382+ Just (CommentSpan _) -> return ()
383+ _ -> setSpanMark (StatementSpan currentSpn)
334384
335385p_stmt :: Stmt GhcPs (LHsExpr GhcPs) -> R ()
336386p_stmt = p_stmt' exprPlacement p_hsExpr
337387
338−p_stmt'
339− :: Data body
340− => (body -> Placement) -- ^ Placer
341− -> (body -> R ()) -- ^ Render
342− -> Stmt GhcPs (Located body) -- ^ Statement to render
343− -> R ()
388+p_stmt' ::
389+ Data body =>
390+ -- | Placer
391+ (body -> Placement) ->
392+ -- | Render
393+ (body -> R ()) ->
394+ -- | Statement to render
395+ Stmt GhcPs (Located body) ->
396+ R ()
344397p_stmt' placer render = \case
345− LastStmt NoExt body _ _ -> located body render
346− BindStmt NoExt l f _ _ -> do
347− located l p_pat
398+ LastStmt NoExtField body _ _ -> located body render
399+ BindStmt NoExtField p f _ _ -> do
400+ located p p_pat
348401 space
349402 txt "<-"
350− let placement =
403+ let loc = getLoc p
404+ placement =
351405 case f of
352406 L l' x ->
353407 if isOneLineSpan
354− (mkSrcSpan (srcSpanEnd (getLoc l)) (srcSpanStart l'))
408+ (mkSrcSpan (srcSpanEnd loc) (srcSpanStart l'))
355409 then placer x
356410 else Normal
357− switchLayout [getLoc l, getLoc f] $
411+ switchLayout [loc, getLoc f] $
358412 placeHanging placement (located f render)
359413 ApplicativeStmt {} -> notImplemented "ApplicativeStmt" -- generated by renamer
360− BodyStmt NoExt body _ _ -> located body render
361− LetStmt NoExt binds -> do
414+ BodyStmt NoExtField body _ _ -> located body render
415+ LetStmt NoExtField binds -> do
362416 txt "let"
363417 space
364418 sitcc $ located binds p_hsLocalBinds
365419 ParStmt {} ->
366− -- NOTE 'ParStmt' should always be eliminated in 'gatherStmt' already,
367− -- such that it never occurs in 'p_stmt''. Consequently, handling it
368− -- here would be redundant.
420+ -- 'ParStmt' should always be eliminated in 'gatherStmt' already, such
421+ -- that it never occurs in 'p_stmt''. Consequently, handling it here
422+ -- would be redundant.
369423 notImplemented "ParStmt"
370− TransStmt {..} -> do
371− -- NOTE 'TransStmt' only needs to account for render printing itself,
372− -- since pretty printing of relevant statements (e.g., in 'trS_stmts')
373− -- is handled through 'gatherStmt'.
424+ TransStmt {..} ->
425+ -- 'TransStmt' only needs to account for render printing itself, since
426+ -- pretty printing of relevant statements (e.g., in 'trS_stmts') is
427+ -- handled through 'gatherStmt'.
374428 case (trS_form, trS_by) of
375429 (ThenForm, Nothing) -> do
376430 txt "then"
@@ -399,11 +453,11 @@ p_stmt' placer render = \case
399453 RecStmt {..} -> do
400454 txt "rec"
401455 space
402− sitcc $ sepSemi (located' (p_stmt' placer render)) recS_stmts
403− XStmtLR {} -> notImplemented "XStmtLR"
456+ sitcc $ sepSemi (withSpacing (p_stmt' placer render)) recS_stmts
457+ XStmtLR c -> noExtCon c
404458
405459gatherStmt :: ExprLStmt GhcPs -> [[ExprLStmt GhcPs]]
406−gatherStmt (L _ (ParStmt NoExt block _ _)) =
460+gatherStmt (L _ (ParStmt NoExtField block _ _)) =
407461 foldr ((<>) . gatherStmtBlock) [] block
408462gatherStmt (L s stmt@TransStmt {..}) =
409463 foldr liftAppend [] ((gatherStmt <$> trS_stmts) <> pure [[L s stmt]])
@@ -412,184 +466,230 @@ gatherStmt stmt = [[stmt]]
412466gatherStmtBlock :: ParStmtBlock GhcPs GhcPs -> [[ExprLStmt GhcPs]]
413467gatherStmtBlock (ParStmtBlock _ stmts _ _) =
414468 foldr (liftAppend . gatherStmt) [] stmts
415−gatherStmtBlock XParStmtBlock {} = notImplemented "XParStmtBlock"
469+gatherStmtBlock (XParStmtBlock x) = noExtCon x
416470
417471p_hsLocalBinds :: HsLocalBindsLR GhcPs GhcPs -> R ()
418472p_hsLocalBinds = \case
419− HsValBinds NoExt (ValBinds NoExt bag lsigs) -> do
420− let ssStart = either
421− (srcSpanStart . getLoc)
422− (srcSpanStart . getLoc)
423− items =
424− (Left <$> bagToList bag) ++ (Right <$> lsigs)
425− p_item (Left x) = located x p_valDecl
426− p_item (Right x) = located x p_sigDecl
427− -- Assigns 'False' to the last element, 'True' to the rest.
428− markInit :: [a] -> [(Bool, a)]
429− markInit [] = []
430− markInit (x:[]) = [(False, x)]
431− markInit (x:xs) = (True, x) : markInit xs
432− -- NOTE When in a single-line layout, there is a chance that the inner
473+ HsValBinds NoExtField (ValBinds NoExtField bag lsigs) -> do
474+ -- When in a single-line layout, there is a chance that the inner
433475 -- elements will also contain semicolons and they will confuse the
434476 -- parser. so we request braces around every element except the last.
435477 br <- layoutToBraces <$> getLayout
436− sitcc $ sepSemi
437− (\(m, i) -> (if m then br else id) $ p_item i)
438− (markInit $ sortOn ssStart items)
439− HsValBinds NoExt _ -> notImplemented "HsValBinds"
440− HsIPBinds NoExt (IPBinds NoExt xs) ->
478+ let items =
479+ let injectLeft (L l x) = L l (Left x)
480+ injectRight (L l x) = L l (Right x)
481+ in (injectLeft <$> bagToList bag) ++ (injectRight <$> lsigs)
482+ positionToBracing = \case
483+ SinglePos -> id
484+ FirstPos -> br
485+ MiddlePos -> br
486+ LastPos -> id
487+ p_item' (p, item) =
488+ positionToBracing p $
489+ withSpacing (either p_valDecl p_sigDecl) item
490+ binds = sortOn (srcSpanStart . getLoc) items
491+ sitcc $ sepSemi p_item' (attachRelativePos binds)
492+ HsValBinds NoExtField _ -> notImplemented "HsValBinds"
493+ HsIPBinds NoExtField (IPBinds NoExtField xs) ->
441494 -- Second argument of IPBind is always Left before type-checking.
442− let p_ipBind (IPBind NoExt (Left name) expr) = do
495+ let p_ipBind (IPBind NoExtField (Left name) expr) = do
443496 atom name
444497 space
445− txt "="
498+ equals
446499 breakpoint
447500 useBraces $ inci $ located expr p_hsExpr
448− p_ipBind _ = notImplemented "XHsIPBinds"
501+ p_ipBind (IPBind NoExtField (Right _) _) =
502+ -- Should only occur after the type checker
503+ notImplemented "IPBind _ (Right _) _"
504+ p_ipBind (XIPBind x) = noExtCon x
449505 in sepSemi (located' p_ipBind) xs
450− HsIPBinds NoExt _ -> notImplemented "HsIpBinds"
451− EmptyLocalBinds NoExt -> return ()
452− XHsLocalBindsLR _ -> notImplemented "XHsLocalBindsLR"
453−
454−p_hsRecField
455− :: HsRecField' RdrName (LHsExpr GhcPs)
456− -> R ()
457−p_hsRecField = \HsRecField {..} -> do
506+ HsIPBinds NoExtField _ -> notImplemented "HsIpBinds"
507+ EmptyLocalBinds NoExtField -> return ()
508+ XHsLocalBindsLR x -> noExtCon x
509+
510+p_hsRecField ::
511+ HsRecField' RdrName (LHsExpr GhcPs) ->
512+ R ()
513+p_hsRecField HsRecField {..} = do
458514 p_rdrName hsRecFieldLbl
459515 unless hsRecPun $ do
460516 space
461− txt "="
462− let placement = exprPlacement (unLoc hsRecFieldArg)
463− placeHanging placement $ located hsRecFieldArg p_hsExpr
464−
465−p_hsTupArg :: HsTupArg GhcPs -> R ()
466−p_hsTupArg = \case
467− Present NoExt x -> located x p_hsExpr
468− Missing NoExt -> pure ()
469− XTupArg {} -> notImplemented "XTupArg"
517+ equals
518+ let placement =
519+ if onTheSameLine (getLoc hsRecFieldLbl) (getLoc hsRecFieldArg)
520+ then exprPlacement (unLoc hsRecFieldArg)
521+ else Normal
522+ placeHanging placement (located hsRecFieldArg p_hsExpr)
470523
471524p_hsExpr :: HsExpr GhcPs -> R ()
472525p_hsExpr = p_hsExpr' N
473526
474527p_hsExpr' :: BracketStyle -> HsExpr GhcPs -> R ()
475528p_hsExpr' s = \case
476− HsVar NoExt name -> p_rdrName name
477− HsUnboundVar NoExt _ -> notImplemented "HsUnboundVar"
478− HsConLikeOut NoExt _ -> notImplemented "HsConLikeOut"
479− HsRecFld NoExt x ->
529+ HsVar NoExtField name -> p_rdrName name
530+ HsUnboundVar NoExtField v -> atom (unboundVarOcc v)
531+ HsConLikeOut NoExtField _ -> notImplemented "HsConLikeOut"
532+ HsRecFld NoExtField x ->
480533 case x of
481− Unambiguous NoExt name -> p_rdrName name
482− Ambiguous NoExt name -> p_rdrName name
483− XAmbiguousFieldOcc NoExt -> notImplemented "XAmbiguousFieldOcc"
484− HsOverLabel NoExt _ v -> do
534+ Unambiguous NoExtField name -> p_rdrName name
535+ Ambiguous NoExtField name -> p_rdrName name
536+ XAmbiguousFieldOcc xx -> noExtCon xx
537+ HsOverLabel NoExtField _ v -> do
485538 txt "#"
486539 atom v
487− HsIPVar NoExt (HsIPName name) -> do
540+ HsIPVar NoExtField (HsIPName name) -> do
488541 txt "?"
489542 atom name
490− HsOverLit NoExt v -> atom (ol_val v)
491− HsLit NoExt lit ->
543+ HsOverLit NoExtField v -> atom (ol_val v)
544+ HsLit NoExtField lit ->
492545 case lit of
493546 HsString (SourceText stxt) _ -> p_stringLit stxt
494547 HsStringPrim (SourceText stxt) _ -> p_stringLit stxt
495548 r -> atom r
496− HsLam NoExt mgroup ->
549+ HsLam NoExtField mgroup ->
497550 p_matchGroup Lambda mgroup
498− HsLamCase NoExt mgroup -> do
551+ HsLamCase NoExtField mgroup -> do
499552 txt "\\case"
500553 breakpoint
501554 inci (p_matchGroup LambdaCase mgroup)
502− HsApp NoExt f x -> do
503− -- We hang only the last function argument. In order to do
504− -- this, we only call 'placeHanging' on the topmost 'HsApp',
505− -- and then use 'p_withoutHanging' for the descendants.
506− let p_withoutHanging (HsApp NoExt f' x') = do
555+ HsApp NoExtField f x -> do
556+ let -- In order to format function applications with multiple parameters
557+ -- nicer, traverse the AST to gather the function and all the
558+ -- parameters together.
559+ gatherArgs f' knownArgs =
507560 case f' of
508− L _ (HsApp _ _ _) -> located f' p_withoutHanging
509− _ -> located f' (p_hsExpr' s)
510− breakpoint
511− inci $ located x' p_hsExpr
512− p_withoutHanging e = p_hsExpr e
513− -- Only use the hanging placement if the function spans
514− -- a single line.
561+ L _ (HsApp _ l r) -> gatherArgs l (r <| knownArgs)
562+ _ -> (f', knownArgs)
563+ (func, args) = gatherArgs f (x :| [])
564+ -- We need to handle the last argument specially if it is a
565+ -- hanging construct, so separate it from the rest.
566+ (initp, lastp) = (NE.init args, NE.last args)
567+ initSpan =
568+ combineSrcSpans' $
569+ getLoc f :| [(srcLocSpan . srcSpanStart . getLoc) lastp]
570+ -- Hang the last argument only if the initial arguments span one
571+ -- line.
515572 placement =
516− if isOneLineSpan (getLoc f)
517− then exprPlacement (unLoc x)
518− else Normal
519− -- We only sit when the last expression is not hanging.
520− -- This is to allow:
521− -- f = foo bar do
522− -- baz
523− sit' = if placement == Normal
524− then sitcc
525− else id
526− sit' $ do
527− useBraces $ located f p_withoutHanging
528− placeHanging placement $
529− located x p_hsExpr
530− HsAppType a e -> do
573+ if isOneLineSpan initSpan
574+ then exprPlacement (unLoc lastp)
575+ else Normal
576+ -- If the last argument is not hanging, just separate every argument as
577+ -- usual. If it is hanging, print the initial arguments and hang the
578+ -- last one. Also, use braces around the every argument except the last
579+ -- one.
580+ case placement of
581+ Normal -> do
582+ let -- Usually we want to bump indentation for arguments for the
583+ -- sake of readability. However, when the function itself is a
584+ -- do-block or case expression it is not a good idea. It seems
585+ -- to be safe to always bump indentation when the function
586+ -- expression is parenthesised.
587+ doIndent =
588+ case func of
589+ L _ (HsPar NoExtField _) -> True
590+ L _ (HsAppType NoExtField _ _) -> True
591+ L _ (HsMultiIf NoExtField _) -> True
592+ L spn _ -> isOneLineSpan spn
593+ ub <-
594+ getLayout <&> \case
595+ SingleLine -> useBraces
596+ MultiLine -> id
597+ ub $ do
598+ located func (p_hsExpr' s)
599+ breakpoint
600+ inciIf doIndent $ sep breakpoint (located' p_hsExpr) initp
601+ inciIf doIndent $ do
602+ unless (null initp) breakpoint
603+ located lastp p_hsExpr
604+ Hanging -> do
605+ useBraces . switchLayout [initSpan] $ do
606+ located func (p_hsExpr' s)
607+ breakpoint
608+ sep breakpoint (located' p_hsExpr) initp
609+ placeHanging placement $
610+ located lastp p_hsExpr
611+ HsAppType NoExtField e a -> do
531612 located e p_hsExpr
532613 breakpoint
533614 inci $ do
534615 txt "@"
616+ -- Insert a space when the type is represented as a TH splice to avoid
617+ -- gluing @ and $ together.
618+ case unLoc (hswc_body a) of
619+ HsSpliceTy {} -> space
620+ _ -> return ()
535621 located (hswc_body a) p_hsType
536− OpApp NoExt x op y -> do
622+ OpApp NoExtField x op y -> do
537623 let opTree = OpBranch (exprOpTree x) op (exprOpTree y)
538− p_exprOpTree True s (reassociateOpTree getOpName opTree)
539− NegApp NoExt e _ -> do
624+ p_exprOpTree s (reassociateOpTree getOpName opTree)
625+ NegApp NoExtField e _ -> do
540626 txt "-"
541627 space
542628 located e p_hsExpr
543− HsPar NoExt e -> parens s (located e p_hsExpr)
544− SectionL NoExt x op -> do
629+ HsPar NoExtField e ->
630+ parens s (located e (dontUseBraces . p_hsExpr))
631+ SectionL NoExtField x op -> do
545632 located x p_hsExpr
546633 breakpoint
547634 inci (located op p_hsExpr)
548− SectionR NoExt op x -> do
635+ SectionR NoExtField op x -> do
549636 located op p_hsExpr
550− breakpoint
637+ useRecordDot' <- useRecordDot
638+ let isRecordDot' = isRecordDot (unLoc op) (getLoc x)
639+ unless (useRecordDot' && isRecordDot') breakpoint
551640 inci (located x p_hsExpr)
552− ExplicitTuple NoExt args boxity -> do
641+ ExplicitTuple NoExtField args boxity ->
553642 let isSection = any (isMissing . unLoc) args
554643 isMissing = \case
555− Missing NoExt -> True
644+ Missing NoExtField -> True
556645 _ -> False
557− let parens' =
646+ p_arg = \case
647+ Present NoExtField x -> located x p_hsExpr
648+ Missing NoExtField -> pure ()
649+ XTupArg x -> noExtCon x
650+ p_larg = sitcc . located' p_arg
651+ parens' =
558652 case boxity of
559653 Boxed -> parens
560654 Unboxed -> parensHash
561− if isSection
562− then switchLayout [] . parens' s $
563− sep comma (located' p_hsTupArg) args
564− else switchLayout (getLoc <$> args) . parens' s . sitcc $
565− sep (comma >> breakpoint) (sitcc . located' p_hsTupArg) args
566− ExplicitSum NoExt tag arity e ->
655+ in if isSection
656+ then
657+ switchLayout [] . parens' s $
658+ sep comma p_larg args
659+ else
660+ switchLayout (getLoc <$> args) . parens' s $
661+ sep commaDel p_larg args
662+ ExplicitSum NoExtField tag arity e ->
567663 p_unboxedSum N tag arity (located e p_hsExpr)
568− HsCase NoExt e mgroup ->
664+ HsCase NoExtField e mgroup ->
569665 p_case exprPlacement p_hsExpr e mgroup
570− HsIf NoExt _ if' then' else' ->
666+ HsIf NoExtField _ if' then' else' ->
571667 p_if exprPlacement p_hsExpr if' then' else'
572− HsMultiIf NoExt guards -> do
668+ HsMultiIf NoExtField guards -> do
573669 txt "if"
574670 breakpoint
575− inci . sitcc $ sep newline (located' (p_grhs RightArrow)) guards
576− HsLet NoExt localBinds e ->
671+ inci . inci $ sep newline (located' (p_grhs RightArrow)) guards
672+ HsLet NoExtField localBinds e ->
577673 p_let p_hsExpr localBinds e
578− HsDo NoExt ctx es -> do
674+ HsDo NoExtField ctx es -> do
579675 let doBody header = do
580676 txt header
581677 breakpoint
582678 ub <- layoutToBraces <$> getLayout
583− inci $ sepSemi
584− (located' (ub . p_stmt' exprPlacement (p_hsExpr' S)))
585− (unLoc es)
586− compBody = brackets N $ located es $ \xs -> do
587− let p_parBody = sep
588− (breakpoint >> txt "| ")
589− p_seqBody
590− p_seqBody = sitcc . sep
591− (comma >> breakpoint)
592− (located' (sitcc . p_stmt))
679+ inci $
680+ sepSemi
681+ (ub . withSpacing (p_stmt' exprPlacement (p_hsExpr' S)))
682+ (unLoc es)
683+ compBody = brackets N . located es $ \xs -> do
684+ let p_parBody =
685+ sep
686+ (breakpoint >> txt "|" >> space)
687+ p_seqBody
688+ p_seqBody =
689+ sitcc
690+ . sep
691+ commaDel
692+ (located' (sitcc . p_stmt))
593693 stmts = init xs
594694 yield = last xs
595695 lists = foldr (liftAppend . gatherStmt) [] stmts
@@ -603,92 +703,100 @@ p_hsExpr' s = \case
603703 MDoExpr -> doBody "mdo"
604704 ListComp -> compBody
605705 MonadComp -> notImplemented "MonadComp"
606− ArrowExpr -> notImplemented "ArrowExpr"
706+ ArrowExpr -> notImplemented "ArrowExpr"
607707 GhciStmtCtxt -> notImplemented "GhciStmtCtxt"
608708 PatGuard _ -> notImplemented "PatGuard"
609709 ParStmtCtxt _ -> notImplemented "ParStmtCtxt"
610710 TransStmtCtxt _ -> notImplemented "TransStmtCtxt"
611711 ExplicitList _ _ xs ->
612− brackets s . sitcc $
613− sep (comma >> breakpoint) (sitcc . located' p_hsExpr) xs
712+ brackets s $
713+ sep commaDel (sitcc . located' p_hsExpr) xs
614714 RecordCon {..} -> do
615715 located rcon_con_name atom
616716 breakpoint
617717 let HsRecFields {..} = rcon_flds
618− updName f = f {
619− hsRecFieldLbl = case unLoc $ hsRecFieldLbl f of
620− FieldOcc _ n -> n
621− XFieldOcc _ -> notImplemented "XFieldOcc"
622− }
718+ updName f =
719+ (f :: HsRecField GhcPs (LHsExpr GhcPs))
720+ { hsRecFieldLbl = case unLoc $ hsRecFieldLbl f of
721+ FieldOcc _ n -> n
722+ XFieldOcc x -> noExtCon x
723+ }
623724 fields = located' (p_hsRecField . updName) <$> rec_flds
624725 dotdot =
625726 case rec_dotdot of
626727 Just {} -> [txt ".."]
627728 Nothing -> []
628− inci . braces N . sitcc $
629− sep (comma >> breakpoint) sitcc (fields <> dotdot)
729+ inci . braces N $
730+ sep commaDel sitcc (fields <> dotdot)
630731 RecordUpd {..} -> do
631732 located rupd_expr p_hsExpr
632− breakpoint
633− let updName f = f {
634− hsRecFieldLbl = case unLoc $ hsRecFieldLbl f of
635− Ambiguous _ n -> n
636− Unambiguous _ n -> n
637− XAmbiguousFieldOcc _ -> notImplemented "XAmbiguousFieldOcc"
638− }
639− inci . braces N . sitcc $
733+ useRecordDot' <- useRecordDot
734+ let mrs sp = case getLoc sp of
735+ RealSrcSpan r -> Just r
736+ _ -> Nothing
737+ let isPluginForm =
738+ ((1 +) . srcSpanEndCol <$> mrs rupd_expr)
739+ == (srcSpanStartCol <$> mrs (head rupd_flds))
740+ unless (useRecordDot' && isPluginForm) breakpoint
741+ let updName f =
742+ (f :: HsRecUpdField GhcPs)
743+ { hsRecFieldLbl = case unLoc $ hsRecFieldLbl f of
744+ Ambiguous _ n -> n
745+ Unambiguous _ n -> n
746+ XAmbiguousFieldOcc x -> noExtCon x
747+ }
748+ inci . braces N $
640749 sep
641− (comma >> breakpoint)
750+ commaDel
642751 (sitcc . located' (p_hsRecField . updName))
643752 rupd_flds
644− ExprWithTySig affix x -> sitcc $ do
753+ ExprWithTySig NoExtField x HsWC {hswc_body = HsIB {..}} -> sitcc $ do
645754 located x p_hsExpr
646755 space
647756 txt "::"
648757 breakpoint
649− inci $ do
650− let HsWC {..} = affix
651− HsIB {..} = hswc_body
652− located hsib_body p_hsType
653− ArithSeq NoExt _ x -> do
758+ inci $ located hsib_body p_hsType
759+ ExprWithTySig NoExtField _ HsWC {hswc_body = XHsImplicitBndrs x} -> noExtCon x
760+ ExprWithTySig NoExtField _ (XHsWildCardBndrs x) -> noExtCon x
761+ ArithSeq NoExtField _ x ->
654762 case x of
655− From from -> brackets s . sitcc $ do
763+ From from -> brackets s $ do
656764 located from p_hsExpr
657765 breakpoint
658766 txt ".."
659− FromThen from next -> brackets s . sitcc $ do
660− sitcc $ sep (comma >> breakpoint) (located' p_hsExpr) [from, next]
767+ FromThen from next -> brackets s $ do
768+ sep commaDel (located' p_hsExpr) [from, next]
661769 breakpoint
662770 txt ".."
663− FromTo from to -> brackets s . sitcc $ do
771+ FromTo from to -> brackets s $ do
664772 located from p_hsExpr
665773 breakpoint
666774 txt ".."
667775 space
668776 located to p_hsExpr
669− FromThenTo from next to -> brackets s . sitcc $ do
670− sitcc $ sep (comma >> breakpoint) (located' p_hsExpr) [from, next]
777+ FromThenTo from next to -> brackets s $ do
778+ sep commaDel (located' p_hsExpr) [from, next]
671779 breakpoint
672780 txt ".."
673781 space
674782 located to p_hsExpr
675− HsSCC NoExt _ name x -> do
783+ HsSCC NoExtField _ name x -> do
676784 txt "{-# SCC "
677785 atom name
678786 txt " #-}"
679787 breakpoint
680788 located x p_hsExpr
681− HsCoreAnn NoExt _ value x -> do
789+ HsCoreAnn NoExtField _ value x -> do
682790 txt "{-# CORE "
683791 atom value
684792 txt " #-}"
685793 breakpoint
686794 located x p_hsExpr
687− HsBracket NoExt x -> p_hsBracket x
795+ HsBracket NoExtField x -> p_hsBracket x
688796 HsRnBracketOut {} -> notImplemented "HsRnBracketOut"
689797 HsTcBracketOut {} -> notImplemented "HsTcBracketOut"
690− HsSpliceE NoExt splice -> p_hsSplice splice
691− HsProc NoExt p e -> do
798+ HsSpliceE NoExtField splice -> p_hsSplice splice
799+ HsProc NoExtField p e -> do
692800 txt "proc"
693801 located p $ \x -> do
694802 breakpoint
@@ -697,35 +805,15 @@ p_hsExpr' s = \case
697805 txt "->"
698806 placeHanging (cmdTopPlacement (unLoc e)) $
699807 located e p_hsCmdTop
700− HsStatic _ e -> do
808+ HsStatic _ e -> do
701809 txt "static"
702810 breakpoint
703811 inci (located e p_hsExpr)
704− HsArrApp NoExt body input arrType cond ->
705− p_hsCmd (HsCmdArrApp NoExt body input arrType cond)
706− HsArrForm NoExt form mfixity cmds ->
707− p_hsCmd (HsCmdArrForm NoExt form Prefix mfixity cmds)
708812 HsTick {} -> notImplemented "HsTick"
709813 HsBinTick {} -> notImplemented "HsBinTick"
710814 HsTickPragma {} -> notImplemented "HsTickPragma"
711− -- These four constructs should never appear in correct programs.
712− -- See: https://github.com/tweag/ormolu/issues/343
713− EWildPat NoExt -> txt "_"
714− EAsPat NoExt n p -> do
715− p_rdrName n
716− txt "@"
717− located p p_hsExpr
718− EViewPat NoExt p e -> do
719− located p p_hsExpr
720− space
721− txt "->"
722− breakpoint
723− inci (located e p_hsExpr)
724− ELazyPat NoExt p -> do
725− txt "~"
726− located p p_hsExpr
727815 HsWrap {} -> notImplemented "HsWrap"
728− XExpr {} -> notImplemented "XExpr"
816+ XExpr x -> noExtCon x
729817
730818p_patSynBind :: PatSynBind GhcPs GhcPs -> R ()
731819p_patSynBind PSB {..} = do
@@ -736,8 +824,8 @@ p_patSynBind PSB {..} = do
736824 txt "<-"
737825 breakpoint
738826 located psb_def p_pat
739− ImplicitBidirectional -> do
740− txt "="
827+ ImplicitBidirectional -> do
828+ equals
741829 breakpoint
742830 located psb_def p_pat
743831 ExplicitBidirectional mgroup -> do
@@ -753,7 +841,7 @@ p_patSynBind PSB {..} = do
753841 PrefixCon xs -> do
754842 space
755843 p_rdrName psb_id
756− inci $ do
844+ inci $ do
757845 switchLayout (getLoc <$> xs) $ do
758846 unless (null xs) breakpoint
759847 sitcc (sep breakpoint p_rdrName xs)
@@ -764,8 +852,8 @@ p_patSynBind PSB {..} = do
764852 inci $ do
765853 switchLayout (getLoc . recordPatSynPatVar <$> xs) $ do
766854 unless (null xs) breakpoint
767− braces N . sitcc $
768− sep (comma >> breakpoint) (p_rdrName . recordPatSynPatVar) xs
855+ braces N $
856+ sep commaDel (p_rdrName . recordPatSynPatVar) xs
769857 rhs
770858 InfixCon l r -> do
771859 switchLayout [getLoc l, getLoc r] $ do
@@ -777,15 +865,19 @@ p_patSynBind PSB {..} = do
777865 space
778866 p_rdrName r
779867 inci rhs
780−p_patSynBind (XPatSynBind NoExt) = notImplemented "XPatSynBind"
781−
782−p_case
783− :: Data body
784− => (body -> Placement) -- ^ Placer
785− -> (body -> R ()) -- ^ Render
786− -> LHsExpr GhcPs -- ^ Expression
787− -> (MatchGroup GhcPs (Located body)) -- ^ Match group
788− -> R ()
868+p_patSynBind (XPatSynBind x) = noExtCon x
869+
870+p_case ::
871+ Data body =>
872+ -- | Placer
873+ (body -> Placement) ->
874+ -- | Render
875+ (body -> R ()) ->
876+ -- | Expression
877+ LHsExpr GhcPs ->
878+ -- | Match group
879+ MatchGroup GhcPs (Located body) ->
880+ R ()
789881p_case placer render e mgroup = do
790882 txt "case"
791883 space
@@ -795,14 +887,19 @@ p_case placer render e mgroup = do
795887 breakpoint
796888 inci (p_matchGroup' placer render Case mgroup)
797889
798−p_if
799− :: Data body
800− => (body -> Placement) -- ^ Placer
801− -> (body -> R ()) -- ^ Render
802− -> LHsExpr GhcPs -- ^ If
803− -> Located body -- ^ Then
804− -> Located body -- ^ Else
805− -> R ()
890+p_if ::
891+ Data body =>
892+ -- | Placer
893+ (body -> Placement) ->
894+ -- | Render
895+ (body -> R ()) ->
896+ -- | If
897+ LHsExpr GhcPs ->
898+ -- | Then
899+ Located body ->
900+ -- | Else
901+ Located body ->
902+ R ()
806903p_if placer render if' then' else' = do
807904 txt "if"
808905 space
@@ -810,19 +907,22 @@ p_if placer render if' then' else' = do
810907 breakpoint
811908 inci $ do
812909 txt "then"
910+ space
813911 located then' $ \x ->
814912 placeHanging (placer x) (render x)
815913 breakpoint
816914 txt "else"
915+ space
817916 located else' $ \x ->
818917 placeHanging (placer x) (render x)
819918
820−p_let
821− :: Data body
822− => (body -> R ()) -- ^ Render
823− -> Located (HsLocalBindsLR GhcPs GhcPs)
824− -> Located body
825− -> R ()
919+p_let ::
920+ Data body =>
921+ -- | Render
922+ (body -> R ()) ->
923+ Located (HsLocalBindsLR GhcPs GhcPs) ->
924+ Located body ->
925+ R ()
826926p_let render localBinds e = sitcc $ do
827927 txt "let"
828928 space
@@ -834,29 +934,29 @@ p_let render localBinds e = sitcc $ do
834934
835935p_pat :: Pat GhcPs -> R ()
836936p_pat = \case
837− WildPat NoExt -> txt "_"
838− VarPat NoExt name -> p_rdrName name
839− LazyPat NoExt pat -> do
937+ WildPat NoExtField -> txt "_"
938+ VarPat NoExtField name -> p_rdrName name
939+ LazyPat NoExtField pat -> do
840940 txt "~"
841941 located pat p_pat
842− AsPat NoExt name pat -> do
942+ AsPat NoExtField name pat -> do
843943 p_rdrName name
844944 txt "@"
845945 located pat p_pat
846− ParPat NoExt pat ->
946+ ParPat NoExtField pat ->
847947 located pat (parens S . p_pat)
848− BangPat NoExt pat -> do
948+ BangPat NoExtField pat -> do
849949 txt "!"
850950 located pat p_pat
851− ListPat NoExt pats -> do
852− brackets S . sitcc $ sep (comma >> breakpoint) (located' p_pat) pats
853− TuplePat NoExt pats boxing -> do
854− let f =
951+ ListPat NoExtField pats ->
952+ brackets S $ sep commaDel (located' p_pat) pats
953+ TuplePat NoExtField pats boxing -> do
954+ let parens' =
855955 case boxing of
856956 Boxed -> parens S
857957 Unboxed -> parensHash S
858− f . sitcc $ sep (comma >> breakpoint) (sitcc . located' p_pat) pats
859− SumPat NoExt pat tag arity ->
958+ parens' $ sep commaDel (sitcc . located' p_pat) pats
959+ SumPat NoExtField pat tag arity ->
860960 p_unboxedSum S tag arity (located pat p_pat)
861961 ConPatIn pat details ->
862962 case details of
@@ -871,38 +971,40 @@ p_pat = \case
871971 let f = \case
872972 Nothing -> txt ".."
873973 Just x -> located x p_pat_hsRecField
874− inci . braces N . sitcc . sep (comma >> breakpoint) f $
974+ inci . braces N . sep commaDel f $
875975 case dotdot of
876976 Nothing -> Just <$> fields
877− Just n -> (Just <$> take n fields) ++ [Nothing]
878− InfixCon x y -> do
879− located x p_pat
880− space
881− p_rdrName pat
882− breakpoint
883− inci (located y p_pat)
977+ Just (L _ n) -> (Just <$> take n fields) ++ [Nothing]
978+ InfixCon l r -> do
979+ switchLayout [getLoc l, getLoc r] $ do
980+ located l p_pat
981+ breakpoint
982+ inci $ do
983+ p_rdrName pat
984+ space
985+ located r p_pat
884986 ConPatOut {} -> notImplemented "ConPatOut" -- presumably created by renamer?
885− ViewPat NoExt expr pat -> sitcc $ do
987+ ViewPat NoExtField expr pat -> sitcc $ do
886988 located expr p_hsExpr
887989 space
888990 txt "->"
889991 breakpoint
890992 inci (located pat p_pat)
891− SplicePat NoExt splice -> p_hsSplice splice
892− LitPat NoExt p -> atom p
893− NPat NoExt v _ _ -> located v (atom . ol_val)
894− NPlusKPat NoExt n k _ _ _ -> sitcc $ do
993+ SplicePat NoExtField splice -> p_hsSplice splice
994+ LitPat NoExtField p -> atom p
995+ NPat NoExtField v _ _ -> located v (atom . ol_val)
996+ NPlusKPat NoExtField n k _ _ _ -> sitcc $ do
895997 p_rdrName n
896998 breakpoint
897999 inci $ do
8981000 txt "+"
8991001 space
9001002 located k (atom . ol_val)
901− SigPat hswc pat -> do
1003+ SigPat NoExtField pat hswc -> do
9021004 located pat p_pat
9031005 p_typeAscription hswc
9041006 CoPat {} -> notImplemented "CoPat" -- apparently created at some later stage
905− XPat NoExt -> notImplemented "XPat"
1007+ XPat x -> noExtCon x
9061008
9071009p_pat_hsRecField :: HsRecField' (FieldOcc GhcPs) (LPat GhcPs) -> R ()
9081010p_pat_hsRecField HsRecField {..} = do
@@ -910,7 +1012,7 @@ p_pat_hsRecField HsRecField {..} = do
9101012 p_rdrName (rdrNameFieldOcc x)
9111013 unless hsRecPun $ do
9121014 space
913− txt "="
1015+ equals
9141016 breakpoint
9151017 inci (located hsRecFieldArg p_pat)
9161018
@@ -919,38 +1021,40 @@ p_unboxedSum s tag arity m = do
9191021 let before = tag - 1
9201022 after = arity - before - 1
9211023 args = replicate before Nothing <> [Just m] <> replicate after Nothing
922− f (x,i) = do
923− let isFirst = i == 0
924− isLast = i == arity - 1
1024+ f x =
9251025 case x :: Maybe (R ()) of
9261026 Nothing ->
927− unless (isFirst || isLast) space
1027+ space
9281028 Just m' -> do
929− unless isFirst space
1029+ space
9301030 m'
931− unless isLast space
932− parensHash s $ sep (txt "|") f (zip args [0..])
1031+ space
1032+ parensHash s $ sep (txt "|") f args
9331033
9341034p_hsSplice :: HsSplice GhcPs -> R ()
9351035p_hsSplice = \case
936− HsTypedSplice NoExt deco _ expr -> p_hsSpliceTH True expr deco
937− HsUntypedSplice NoExt deco _ expr -> p_hsSpliceTH False expr deco
938− HsQuasiQuote NoExt _ quoterName srcSpan str -> do
1036+ HsTypedSplice NoExtField deco _ expr -> p_hsSpliceTH True expr deco
1037+ HsUntypedSplice NoExtField deco _ expr -> p_hsSpliceTH False expr deco
1038+ HsQuasiQuote NoExtField _ quoterName srcSpan str -> do
9391039 txt "["
9401040 p_rdrName (L srcSpan quoterName)
9411041 txt "|"
942− -- NOTE QuasiQuoters often rely on precise custom strings. We cannot do
943− -- any formatting here without potentially breaking someone's code.
1042+ -- QuasiQuoters often rely on precise custom strings. We cannot do any
1043+ -- formatting here without potentially breaking someone's code.
9441044 atom str
9451045 txt "|]"
9461046 HsSpliced {} -> notImplemented "HsSpliced"
947− XSplice {} -> notImplemented "XSplice"
948−
949−p_hsSpliceTH
950− :: Bool -- ^ Typed splice?
951− -> LHsExpr GhcPs -- ^ Splice expression
952− -> SpliceDecoration -- ^ Splice decoration
953− -> R ()
1047+ HsSplicedT {} -> notImplemented "HsSplicedT"
1048+ XSplice x -> noExtCon x
1049+
1050+p_hsSpliceTH ::
1051+ -- | Typed splice?
1052+ Bool ->
1053+ -- | Splice expression
1054+ LHsExpr GhcPs ->
1055+ -- | Splice decoration
1056+ SpliceDecoration ->
1057+ R ()
9541058p_hsSpliceTH isTyped expr = \case
9551059 HasParens -> do
9561060 txt decoSymbol
@@ -965,17 +1069,17 @@ p_hsSpliceTH isTyped expr = \case
9651069
9661070p_hsBracket :: HsBracket GhcPs -> R ()
9671071p_hsBracket = \case
968− ExpBr NoExt expr -> do
1072+ ExpBr NoExtField expr -> do
9691073 anns <- getEnclosingAnns
9701074 let name = case anns of
971− AnnOpenEQ:_ -> ""
1075+ AnnOpenEQ : _ -> ""
9721076 _ -> "e"
9731077 quote name (located expr p_hsExpr)
974− PatBr NoExt pat -> quote "p" (located pat p_pat)
975− DecBrL NoExt decls -> quote "d" (p_hsDecls Free decls)
976− DecBrG NoExt _ -> notImplemented "DecBrG" -- result of renamer
977− TypBr NoExt ty -> quote "t" (located ty p_hsType)
978− VarBr NoExt isSingleQuote name -> do
1078+ PatBr NoExtField pat -> located pat (quote "p" . p_pat)
1079+ DecBrL NoExtField decls -> quote "d" (p_hsDecls Free decls)
1080+ DecBrG NoExtField _ -> notImplemented "DecBrG" -- result of renamer
1081+ TypBr NoExtField ty -> quote "t" (located ty p_hsType)
1082+ VarBr NoExtField isSingleQuote name -> do
9791083 txt (bool "''" "'" isSingleQuote)
9801084 -- HACK As you can see we use 'noLoc' here to be able to pass name into
9811085 -- 'p_rdrName' since the latter expects a "located" thing. The problem
@@ -983,19 +1087,20 @@ p_hsBracket = \case
9831087 -- turn makes it impossible to detect if there are parentheses around
9841088 -- it, etc. So we have to add parentheses manually assuming they are
9851089 -- necessary for all operators.
986− let isOperator = all
987− (\i -> isPunctuation i || isSymbol i)
988− (showOutputable (rdrNameOcc name))
989− && not (doesNotNeedExtraParens name)
1090+ let isOperator =
1091+ all
1092+ (\i -> isPunctuation i || isSymbol i)
1093+ (showOutputable (rdrNameOcc name))
1094+ && not (doesNotNeedExtraParens name)
9901095 wrapper = if isOperator then parens N else id
9911096 wrapper $ p_rdrName (noLoc name)
992− TExpBr NoExt expr -> do
1097+ TExpBr NoExtField expr -> do
9931098 txt "[||"
9941099 breakpoint'
9951100 located expr p_hsExpr
9961101 breakpoint'
9971102 txt "||]"
998− XBracket {} -> notImplemented "XBracket"
1103+ XBracket x -> noExtCon x
9991104 where
10001105 quote :: Text -> R () -> R ()
10011106 quote name body = do
@@ -1019,50 +1124,47 @@ p_stringLit src =
10191124 multiLine =
10201125 sitcc $ sep breakpoint (txt . Text.pack) (backslashes s)
10211126 in vlayout singleLine multiLine
1022− where
1023− -- Split a string on gaps (backslash delimited whitespaces)
1024− --
1025− -- > splitGaps "bar\\ \\fo\\&o" == ["bar", "fo\\&o"]
1026− splitGaps :: String -> [String]
1027− splitGaps "" = []
1028− splitGaps s =
1029− let -- A backslash and a whitespace starts a "gap"
1030− p (Just '\\', _, _) = True
1031− p (_, '\\', Just c) | ghcSpace c = False
1032− p _ = True
1033− in case span p (zipPrevNext s) of
1034− (l, r) ->
1035− let -- drop the initial '\', any amount of 'ghcSpace', and another '\'
1127+ where
1128+ -- Split a string on gaps (backslash delimited whitespaces)
1129+ --
1130+ -- > splitGaps "bar\\ \\fo\\&o" == ["bar", "fo\\&o"]
1131+ splitGaps :: String -> [String]
1132+ splitGaps "" = []
1133+ splitGaps s =
1134+ let -- A backslash and a whitespace starts a "gap"
1135+ p (Just '\\', _, _) = True
1136+ p (_, '\\', Just c) | ghcSpace c = False
1137+ p _ = True
1138+ in case span p (zipPrevNext s) of
1139+ (l, r) ->
1140+ let -- drop the initial '\', any amount of 'ghcSpace', and another '\'
10361141 r' = drop 1 . dropWhile ghcSpace . drop 1 $ map orig r
1037− in map orig l : splitGaps r'
1038−
1039− -- GHC's definition of whitespaces in strings
1040− -- See: https://gitlab.haskell.org/ghc/ghc/blob/86753475/compiler/parser/Lexer.x#L1653
1041− ghcSpace :: Char -> Bool
1042− ghcSpace c = c <= '\x7f' && is_space c
1043−
1044− -- Add backslashes to the inner side of the strings
1045− --
1046− -- > backslashes ["a", "b", "c"] == ["a\\", "\\b\\", "\\c"]
1047− backslashes :: [String] -> [String]
1048− backslashes (x:y:xs) = (x ++ "\\") : backslashes (('\\' : y) : xs)
1049− backslashes xs = xs
1050−
1051− -- Attaches previous and next items to each list element
1052− zipPrevNext :: [a] -> [(Maybe a, a, Maybe a)]
1053− zipPrevNext xs =
1054− let z = zip (zip (Nothing : map Just xs) xs)
1055− (map Just (tail xs) ++ repeat Nothing)
1056− in map (\((p, x), n) -> (p, x, n)) z
1057−
1058− orig (_, x, _) = x
1142+ in map orig l : splitGaps r'
1143+ -- GHC's definition of whitespaces in strings
1144+ -- See: https://gitlab.haskell.org/ghc/ghc/blob/86753475/compiler/parser/Lexer.x#L1653
1145+ ghcSpace :: Char -> Bool
1146+ ghcSpace c = c <= '\x7f' && is_space c
1147+ -- Add backslashes to the inner side of the strings
1148+ --
1149+ -- > backslashes ["a", "b", "c"] == ["a\\", "\\b\\", "\\c"]
1150+ backslashes :: [String] -> [String]
1151+ backslashes (x : y : xs) = (x ++ "\\") : backslashes (('\\' : y) : xs)
1152+ backslashes xs = xs
1153+ -- Attaches previous and next items to each list element
1154+ zipPrevNext :: [a] -> [(Maybe a, a, Maybe a)]
1155+ zipPrevNext xs =
1156+ let z =
1157+ zip
1158+ (zip (Nothing : map Just xs) xs)
1159+ (map Just (tail xs) ++ repeat Nothing)
1160+ in map (\((p, x), n) -> (p, x, n)) z
1161+ orig (_, x, _) = x
10591162
10601163----------------------------------------------------------------------------
10611164-- Helpers
10621165
10631166-- | Return the wrapping function controlling the use of braces according to
10641167-- the current layout.
1065−
10661168layoutToBraces :: Layout -> R () -> R ()
10671169layoutToBraces = \case
10681170 SingleLine -> useBraces
@@ -1070,7 +1172,6 @@ layoutToBraces = \case
10701172
10711173-- | Append each element in both lists with semigroups. If one list is shorter
10721174-- than the other, return the rest of the longer list unchanged.
1073−
10741175liftAppend :: Semigroup a => [a] -> [a] -> [a]
10751176liftAppend [] [] = []
10761177liftAppend [] (y : ys) = y : ys
@@ -1078,14 +1179,13 @@ liftAppend (x : xs) [] = x : xs
10781179liftAppend (x : xs) (y : ys) = x <> y : liftAppend xs ys
10791180
10801181getGRHSSpan :: GRHS GhcPs (Located body) -> SrcSpan
1081−getGRHSSpan (GRHS NoExt guards body) =
1182+getGRHSSpan (GRHS NoExtField guards body) =
10821183 combineSrcSpans' $ getLoc body :| map getLoc guards
1083−getGRHSSpan (XGRHS NoExt) = notImplemented "XGRHS"
1184+getGRHSSpan (XGRHS x) = noExtCon x
10841185
10851186-- | Place a thing that may have a hanging form. This function handles how
10861187-- to separate it from preceding expressions and whether to bump indentation
10871188-- depending on what sort of expression we have.
1088−
10891189placeHanging :: Placement -> R () -> R ()
10901190placeHanging placement m =
10911191 case placement of
@@ -1098,92 +1198,92 @@ placeHanging placement m =
10981198
10991199-- | Check if given block contains single expression which has a hanging
11001200-- form.
1101−
1102−blockPlacement
1103− :: (body -> Placement)
1104− -> [LGRHS GhcPs (Located body)]
1105− -> Placement
1106−blockPlacement placer [(L _ (GRHS NoExt _ (L _ x)))] = placer x
1201+blockPlacement ::
1202+ (body -> Placement) ->
1203+ [LGRHS GhcPs (Located body)] ->
1204+ Placement
1205+blockPlacement placer [L _ (GRHS NoExtField _ (L _ x))] = placer x
11071206blockPlacement _ _ = Normal
11081207
11091208-- | Check if given command has a hanging form.
1110−
11111209cmdPlacement :: HsCmd GhcPs -> Placement
11121210cmdPlacement = \case
1113− HsCmdLam NoExt _ -> Hanging
1114− HsCmdCase NoExt _ _ -> Hanging
1115− HsCmdDo NoExt _ -> Hanging
1211+ HsCmdLam NoExtField _ -> Hanging
1212+ HsCmdCase NoExtField _ _ -> Hanging
1213+ HsCmdDo NoExtField _ -> Hanging
11161214 _ -> Normal
11171215
11181216cmdTopPlacement :: HsCmdTop GhcPs -> Placement
11191217cmdTopPlacement = \case
1120− HsCmdTop NoExt (L _ x) -> cmdPlacement x
1121− XCmdTop {} -> notImplemented "XCmdTop"
1218+ HsCmdTop NoExtField (L _ x) -> cmdPlacement x
1219+ XCmdTop x -> noExtCon x
11221220
11231221-- | Check if given expression has a hanging form.
1124−
11251222exprPlacement :: HsExpr GhcPs -> Placement
11261223exprPlacement = \case
11271224 -- Only hang lambdas with single line parameter lists
1128− HsLam NoExt mg -> case mg of
1129− MG _ (L _ [L _ (Match NoExt _ (x:xs) _)]) _
1130− | isOneLineSpan (combineSrcSpans' $ fmap getLoc (x :| xs))
1131− -> Hanging
1225+ HsLam NoExtField mg -> case mg of
1226+ MG _ (L _ [L _ (Match NoExtField _ (x : xs) _)]) _
1227+ | isOneLineSpan (combineSrcSpans' $ fmap getLoc (x :| xs)) ->
1228+ Hanging
11321229 _ -> Normal
1133− HsLamCase NoExt _ -> Hanging
1134− HsCase NoExt _ _ -> Hanging
1135− HsDo NoExt DoExpr _ -> Hanging
1136− HsDo NoExt MDoExpr _ -> Hanging
1137− RecordCon NoExt _ _ -> Hanging
1138− -- If the rightmost expression in an operator chain is hanging, make the
1139− -- whole block hanging; so that we can use the common @f = foo $ do@
1140− -- style.
1141− OpApp NoExt _ _ y -> exprPlacement (unLoc y)
1142− -- Same thing for function applications (usually with -XBlockArguments)
1143− HsApp NoExt _ y -> exprPlacement (unLoc y)
1144− HsProc NoExt (L s _) _ ->
1230+ HsLamCase NoExtField _ -> Hanging
1231+ HsCase NoExtField _ _ -> Hanging
1232+ HsDo NoExtField DoExpr _ -> Hanging
1233+ HsDo NoExtField MDoExpr _ -> Hanging
1234+ OpApp NoExtField _ op y ->
1235+ case (fmap getOpNameStr . getOpName . unLoc) op of
1236+ Just "$" -> exprPlacement (unLoc y)
1237+ _ -> Normal
1238+ HsApp NoExtField _ y -> exprPlacement (unLoc y)
1239+ HsProc NoExtField p _ ->
11451240 -- Indentation breaks if pattern is longer than one line and left
11461241 -- hanging. Consequently, only apply hanging when it is safe.
1147− if isOneLineSpan s
1148− then Hanging
1149− else Normal
1242+ if isOneLineSpan (getLoc p)
1243+ then Hanging
1244+ else Normal
11501245 _ -> Normal
11511246
11521247withGuards :: [LGRHS GhcPs (Located body)] -> Bool
11531248withGuards = any (checkOne . unLoc)
11541249 where
11551250 checkOne :: GRHS GhcPs (Located body) -> Bool
1156− checkOne (GRHS NoExt [] _) = False
1251+ checkOne (GRHS NoExtField [] _) = False
11571252 checkOne _ = True
11581253
11591254exprOpTree :: LHsExpr GhcPs -> OpTree (LHsExpr GhcPs) (LHsExpr GhcPs)
1160−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)
11611256exprOpTree n = OpNode n
11621257
11631258getOpName :: HsExpr GhcPs -> Maybe RdrName
11641259getOpName = \case
1165− HsVar NoExt (L _ a) -> Just a
1260+ HsVar NoExtField (L _ a) -> Just a
11661261 _ -> Nothing
11671262
1168−p_exprOpTree
1169− :: Bool -- ^ Can use special handling of dollar?
1170− -> BracketStyle -- ^ Bracket style to use
1171− -> OpTree (LHsExpr GhcPs) (LHsExpr GhcPs)
1172− -> R ()
1173−p_exprOpTree _ s (OpNode x) = located x (p_hsExpr' s)
1174−p_exprOpTree isDollarSpecial s (OpBranch x op y) = do
1175− -- NOTE If the beginning of the first argument and the second argument
1176− -- are on the same line, and the second argument has a hanging form, use
1177− -- hanging placement.
1263+getOpNameStr :: RdrName -> String
1264+getOpNameStr = occNameString . rdrNameOcc
1265+
1266+p_exprOpTree ::
1267+ -- | Bracket style to use
1268+ BracketStyle ->
1269+ OpTree (LHsExpr GhcPs) (LHsExpr GhcPs) ->
1270+ R ()
1271+p_exprOpTree s (OpNode x) = located x (p_hsExpr' s)
1272+p_exprOpTree s (OpBranch x op y) = do
1273+ -- If the beginning of the first argument and the second argument are on
1274+ -- the same line, and the second argument has a hanging form, use hanging
1275+ -- placement.
11781276 let placement =
11791277 if isOneLineSpan
1180− (mkSrcSpan (srcSpanStart (opTreeLoc x)) (srcSpanStart (opTreeLoc y)))
1278+ (mkSrcSpan (srcSpanStart (opTreeLoc x)) (srcSpanStart (opTreeLoc y)))
11811279 then case y of
1182− OpNode (L _ n) -> exprPlacement n
1183− _ -> Normal
1280+ OpNode (L _ n) -> exprPlacement n
1281+ _ -> Normal
11841282 else Normal
1283+ -- Distinguish holes used in infix notation.
1284+ -- eg. '1 _foo 2' and '1 `_foo` 2'
11851285 opWrapper = case unLoc op of
1186− EWildPat NoExt -> backticks
1286+ HsUnboundVar NoExtField _ -> backticks
11871287 _ -> id
11881288 layout <- getLayout
11891289 let ub = case layout of
@@ -1191,30 +1291,72 @@ p_exprOpTree isDollarSpecial s (OpBranch x op y) = do
11911291 MultiLine -> case placement of
11921292 Hanging -> useBraces
11931293 Normal -> dontUseBraces
1194− gotDollar = case getOpName (unLoc op) of
1195− Just rname -> mkVarOcc "$" == (rdrNameOcc rname)
1294+ opNameStr = (fmap getOpNameStr . getOpName . unLoc) op
1295+ gotDollar = opNameStr == Just "$"
1296+ gotColon = opNameStr == Just ":"
1297+ gotRecordDot = isRecordDot (unLoc op) (opTreeLoc y)
1298+ lhs =
1299+ switchLayout [opTreeLoc x] $
1300+ p_exprOpTree s x
1301+ p_op = located op (opWrapper . p_hsExpr)
1302+ p_y = switchLayout [opTreeLoc y] (p_exprOpTree N y)
1303+ isSection = case (opTreeLoc x, getLoc op) of
1304+ (RealSrcSpan treeSpan, RealSrcSpan opSpan) ->
1305+ srcSpanEndCol treeSpan /= srcSpanStartCol opSpan
11961306 _ -> False
1197− switchLayout [opTreeLoc x] $
1198− ub $ p_exprOpTree (not gotDollar) s x
1199− let p_op = located op (opWrapper . p_hsExpr)
1200− p_y = switchLayout [opTreeLoc y] (p_exprOpTree True N y)
1201− if isDollarSpecial && gotDollar && placement == Normal && isOneLineSpan (opTreeLoc x)
1202− then do
1203− space
1204− p_op
1205− breakpoint
1206− inci p_y
1207− else
1208− placeHanging placement $ do
1307+ isDoBlock = \case
1308+ OpNode (L _ HsDo {}) -> True
1309+ _ -> False
1310+ useRecordDot' <- useRecordDot
1311+ if
1312+ | gotColon -> do
1313+ lhs
1314+ space
12091315 p_op
1316+ case placement of
1317+ Hanging -> do
1318+ space
1319+ p_y
1320+ Normal -> do
1321+ breakpoint
1322+ inciIf (isDoBlock y) p_y
1323+ | gotDollar
1324+ && isOneLineSpan (opTreeLoc x)
1325+ && placement == Normal -> do
1326+ useBraces lhs
12101327 space
1328+ p_op
1329+ breakpoint
1330+ inci p_y
1331+ | useRecordDot' && gotRecordDot -> do
1332+ lhs
1333+ when isSection space
1334+ p_op
12111335 p_y
1336+ | otherwise -> do
1337+ ub lhs
1338+ placeHanging placement $ do
1339+ p_op
1340+ space
1341+ p_y
1342+
1343+-- | Return 'True' if given expression is a record-dot operator expression.
1344+isRecordDot ::
1345+ -- | Operator expression
1346+ HsExpr GhcPs ->
1347+ -- | Span of the expression on the right-hand side of the operator
1348+ SrcSpan ->
1349+ Bool
1350+isRecordDot op (RealSrcSpan ySpan) = case op of
1351+ HsVar NoExtField (L (RealSrcSpan opSpan) opName) ->
1352+ (getOpNameStr opName == ".") && (srcSpanEndCol opSpan == srcSpanStartCol ySpan)
1353+ _ -> False
1354+isRecordDot _ _ = False
12121355
12131356-- | Get annotations for the enclosing element.
1214−
12151357getEnclosingAnns :: R [AnnKeywordId]
12161358getEnclosingAnns = do
12171359 e <- getEnclosingSpan (const True)
12181360 case e of
12191361 Nothing -> return []
1220− Just e' -> getAnns (RealSrcSpan e')
1362+ Just e' -> getAnns (RealSrcSpan e')