@@ -1,39 +1,43 @@
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
8+ ( p_valDecl,
9+ p_pat,
10+ p_hsExpr,
11+ p_hsSplice,
12+ p_stringLit,
1013 )
1114where
1215
1316import Bag (bagToList)
1417import BasicTypes
1518import Control.Monad
19+import Ctype (is_space)
1620import Data.Bool (bool)
1721import Data.Char (isPunctuation, isSymbol)
1822import Data.Data hiding (Infix, Prefix)
23+import Data.Functor ((<&>))
1924import Data.List (intersperse, sortOn)
20−import Data.List.NonEmpty (NonEmpty ((:|)))
25+import Data.List.NonEmpty (NonEmpty (..), (<|))
26+import qualified Data.List.NonEmpty as NE
2127import Data.Text (Text)
28+import qualified Data.Text as Text
2229import GHC
30+import OccName (occNameString)
2331import Ormolu.Printer.Combinators
32+import Ormolu.Printer.Internal
2433import Ormolu.Printer.Meat.Common
34+import {-# SOURCE #-} Ormolu.Printer.Meat.Declaration
2535import Ormolu.Printer.Meat.Declaration.Signature
2636import Ormolu.Printer.Meat.Type
2737import Ormolu.Printer.Operators
2838import Ormolu.Utils
29−import Outputable (Outputable (..))
30−import RdrName (rdrNameOcc)
31−import SrcLoc (combineSrcSpans, isOneLineSpan)
32−import qualified Data.List.NonEmpty as NE
33−import {-# SOURCE #-} Ormolu.Printer.Meat.Declaration
3439
3540-- | Style of a group of equations.
36−
3741data MatchGroupStyle
3842 = Function (Located RdrName)
3943 | PatternBind
@@ -42,56 +46,61 @@ data MatchGroupStyle
4246 | LambdaCase
4347
4448-- | Style of equations in a group.
45−
4649data GroupStyle
4750 = EqualSign
4851 | RightArrow
4952
5053-- | Expression placement. This marks the places where expressions that
5154-- implement handing forms may use them.
52−
5355data Placement
54− = Normal -- ^ Multi-line layout should cause
55− -- insertion of a newline and indentation
56− -- bump
57− | Hanging -- ^ Expressions that have hanging form
58− -- should use it and avoid bumping one level
59− -- of indentation
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)
6065
6166p_valDecl :: HsBindLR GhcPs GhcPs -> R ()
6267p_valDecl = \case
63− FunBind NoExt funId funMatches _ _ -> p_funBind funId funMatches
64− 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
6570 VarBind {} -> notImplemented "VarBinds" -- introduced by the type checker
6671 AbsBinds {} -> notImplemented "AbsBinds" -- introduced by the type checker
67− PatSynBind NoExt psb -> p_patSynBind psb
68− XHsBindsLR NoExt -> notImplemented "XHsBindsLR"
72+ PatSynBind NoExtField psb -> p_patSynBind psb
73+ XHsBindsLR x -> noExtCon x
6974
70−p_funBind
71− :: Located RdrName
72− -> MatchGroup GhcPs (LHsExpr GhcPs)
73− -> R ()
75+p_funBind ::
76+ Located RdrName ->
77+ MatchGroup GhcPs (LHsExpr GhcPs) ->
78+ R ()
7479p_funBind name = p_matchGroup (Function name)
7580
76−p_matchGroup
77− :: MatchGroupStyle
78− -> MatchGroup GhcPs (LHsExpr GhcPs)
79− -> R ()
81+p_matchGroup ::
82+ MatchGroupStyle ->
83+ MatchGroup GhcPs (LHsExpr GhcPs) ->
84+ R ()
8085p_matchGroup = p_matchGroup' exprPlacement p_hsExpr
8186
82−p_matchGroup'
83− :: Data body
84− => (body -> Placement) -- ^ How to get body placement
85− -> (body -> R ()) -- ^ How to print body
86− -> MatchGroupStyle -- ^ Style of this group of equations
87− -> MatchGroup GhcPs (Located body) -- ^ Match group
88− -> R ()
89−p_matchGroup' placer pretty style MG {..} = do
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 ()
98+p_matchGroup' placer render style MG {..} = do
9099 let ob = case style of
91100 Case -> id
92101 LambdaCase -> id
93102 _ -> dontUseBraces
94− -- 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
95104 -- restore the brace state inside the sepsemi.
96105 ub <- bool dontUseBraces useBraces <$> canUseBraces
97106 ob $ sepSemi (located' (ub . p_Match)) (unLoc mg_alts)
@@ -99,14 +108,14 @@ p_matchGroup' placer pretty style MG {..} = do
99108 p_Match m@Match {..} =
100109 p_match'
101110 placer
102− pretty
111+ render
103112 (adjustMatchGroupStyle m style)
104113 (isInfixMatch m)
105114 (matchStrictness m)
106115 m_pats
107116 m_grhss
108− p_Match _ = notImplemented "XMatch"
109−p_matchGroup' _ _ _ (XMatchGroup NoExt) = notImplemented "XMatchGroup"
117+ p_Match (XMatch x) = noExtCon x
118+p_matchGroup' _ _ _ (XMatchGroup x) = noExtCon x
110119
111120-- | Function id obtained through pattern matching on 'FunBind' should not
112121-- be used to print the actual equations because the different ‘RdrNames’
@@ -114,11 +123,10 @@ p_matchGroup' _ _ _ (XMatchGroup NoExt) = notImplemented "XMatchGroup"
114123-- and paretheses) associated with them. It is necessary to use per-equation
115124-- names obtained from 'm_ctxt' of 'Match'. This function replaces function
116125-- name inside of 'Function' accordingly.
117−
118−adjustMatchGroupStyle
119− :: Match GhcPs body
120− -> MatchGroupStyle
121− -> MatchGroupStyle
126+adjustMatchGroupStyle ::
127+ Match GhcPs body ->
128+ MatchGroupStyle ->
129+ MatchGroupStyle
122130adjustMatchGroupStyle m = \case
123131 Function _ -> (Function . mc_fun . m_ctxt) m
124132 style -> style
@@ -126,31 +134,43 @@ adjustMatchGroupStyle m = \case
126134matchStrictness :: Match id body -> SrcStrictness
127135matchStrictness match =
128136 case m_ctxt match of
129− FunRhs{mc_strictness=s} -> s
137+ FunRhs {mc_strictness = s} -> s
130138 _ -> NoSrcStrict
131139
132−p_match
133− :: MatchGroupStyle -- ^ Style of the group
134− -> Bool -- ^ Is this an infix match?
135− -> SrcStrictness -- ^ Strictness prefix (FunBind)
136− -> [LPat GhcPs] -- ^ Argument patterns
137− -> GRHSs GhcPs (LHsExpr GhcPs) -- ^ Equations
138− -> 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 ()
139152p_match = p_match' exprPlacement p_hsExpr
140153
141−p_match'
142− :: Data body
143− => (body -> Placement) -- ^ How to get body placement
144− -> (body -> R ()) -- ^ How to print body
145− -> MatchGroupStyle -- ^ Style of this group of equations
146− -> Bool -- ^ Is this an infix match?
147− -> SrcStrictness -- ^ Strictness prefix (FunBind)
148− -> [LPat GhcPs] -- ^ Argument patterns
149− -> GRHSs GhcPs (Located body) -- ^ Equations
150− -> R ()
151−p_match' placer pretty style isInfix strictness m_pats m_grhss = do
152− -- NOTE Normally, since patterns may be placed in a multi-line layout, it
153− -- 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
154174 -- indented than function name. This in turn means that indentation for
155175 -- the body should also be bumped. Normally this would mean that bodies
156176 -- would start with two indentation steps applied, which is ugly, so we
@@ -160,23 +180,24 @@ p_match' placer pretty style isInfix strictness m_pats m_grhss = do
160180 NoSrcStrict -> return ()
161181 SrcStrict -> txt "!"
162182 SrcLazy -> txt "~"
163− inci' <- case NE.nonEmpty m_pats of
164− Nothing -> id <$ case style of
165− Function name -> p_rdrName name
166− _ -> return ()
183+ indentBody <- case NE.nonEmpty m_pats of
184+ Nothing ->
185+ False <$ case style of
186+ Function name -> p_rdrName name
187+ _ -> return ()
167188 Just ne_pats -> do
168− let combinedSpans = combineSrcSpans' $
169− getLoc <$> ne_pats
170− inci' = if isOneLineSpan combinedSpans
171− then id
172− 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)
173194 switchLayout [combinedSpans] $ do
174195 let stdCase = sep breakpoint (located' p_pat) m_pats
175196 case style of
176197 Function name ->
177198 p_infixDefHelper
178199 isInfix
179− inci'
200+ indentBody
180201 (p_rdrName name)
181202 (located' p_pat <$> m_pats)
182203 PatternBind -> stdCase
@@ -191,46 +212,40 @@ p_match' placer pretty style isInfix strictness m_pats m_grhss = do
191212 when needsSpace space
192213 sitcc stdCase
193214 LambdaCase -> stdCase
194− return inci'
195− let
196− -- Calculate position of end of patterns. This is useful when we decide
197− -- about putting certain constructions in hanging positions.
198− endOfPats = case NE.nonEmpty m_pats of
199− Nothing -> case style of
200− Function name -> (Just . srcSpanEnd . getLoc) name
201− _ -> Nothing
202− Just pats -> (Just . srcSpanEnd . getLoc . NE.last) pats
203− isCase = \case
204− Case -> True
205− LambdaCase -> True
206− _ -> False
207− 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
208227 hasGuards = withGuards grhssGRHSs
209− unless (length grhssGRHSs > 1) $ do
210− case style of
211− Function _ | hasGuards -> return ()
212− Function _ -> space >> txt "="
213− PatternBind -> space >> txt "="
214− s | isCase s && hasGuards -> return ()
215− _ -> space >> txt "->"
216− let grhssSpan = combineSrcSpans' $
217− getGRHSSpan . unLoc <$> NE.fromList grhssGRHSs
218− patGrhssSpan = maybe grhssSpan
219− (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
220236 placement =
221237 case endOfPats of
222238 Nothing -> blockPlacement placer grhssGRHSs
223239 Just spn ->
224− if isOneLineSpan
225− (mkSrcSpan spn (srcSpanStart grhssSpan))
240+ if onTheSameLine spn grhssSpan
226241 then blockPlacement placer grhssGRHSs
227242 else Normal
228243 p_body = do
229244 let groupStyle =
230245 if isCase style && hasGuards
231− then RightArrow
232− else EqualSign
233− sep newline (located' (p_grhs' pretty groupStyle)) grhssGRHSs
246+ then RightArrow
247+ else EqualSign
248+ sep newline (located' (p_grhs' placer render groupStyle)) grhssGRHSs
234249 p_where = do
235250 let whereIsEmpty = GHC.isEmptyLocalBindsPR (unLoc grhssLocalBinds)
236251 unless (GHC.eqEmptyLocalBinds (unLoc grhssLocalBinds)) $ do
@@ -238,175 +253,211 @@ p_match' placer pretty style isInfix strictness m_pats m_grhss = do
238253 txt "where"
239254 unless whereIsEmpty breakpoint
240255 inci $ located grhssLocalBinds p_hsLocalBinds
241− 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 "->"
242264 switchLayout [patGrhssSpan] $
243265 placeHanging placement p_body
244266 inci p_where
267+p_match' _ _ _ _ _ _ (XGRHSs x) = noExtCon x
245268
246269p_grhs :: GroupStyle -> GRHS GhcPs (LHsExpr GhcPs) -> R ()
247−p_grhs = p_grhs' p_hsExpr
270+p_grhs = p_grhs' exprPlacement p_hsExpr
248271
249−p_grhs'
250− :: Data body
251− => (body -> R ())
252− -> GroupStyle
253− -> GRHS GhcPs (Located body)
254− -> R ()
255−p_grhs' pretty 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) =
256282 case guards of
257283 [] -> p_body
258284 xs -> do
259285 txt "|"
260286 space
261− sitcc (sep (comma >> breakpoint) (sitcc . located' p_stmt) xs)
287+ sitcc (sep commaDel (sitcc . located' p_stmt) xs)
262288 space
263− txt $ case style of
264− EqualSign -> "="
265− RightArrow -> "->"
266− breakpoint
267− inci p_body
289+ inci $ case style of
290+ EqualSign -> equals
291+ RightArrow -> txt "->"
292+ placeHanging placement p_body
268293 where
269− p_body = located body pretty
270−p_grhs' _ _ (XGRHS NoExt) = notImplemented "XGRHS"
294+ placement =
295+ case endOfGuards of
296+ Nothing -> placer (unLoc body)
297+ Just spn ->
298+ if onTheSameLine spn (getLoc body)
299+ then placer (unLoc body)
300+ else Normal
301+ endOfGuards =
302+ case NE.nonEmpty guards of
303+ Nothing -> Nothing
304+ Just gs -> (Just . getLoc . NE.last) gs
305+ p_body = located body render
306+p_grhs' _ _ _ (XGRHS x) = noExtCon x
271307
272308p_hsCmd :: HsCmd GhcPs -> R ()
273309p_hsCmd = \case
274− HsCmdArrApp NoExt body input arrType _ -> do
310+ HsCmdArrApp NoExtField body input arrType _ -> do
275311 located body p_hsExpr
276− space
277− case arrType of
278− HsFirstOrderApp -> txt "-<"
279− HsHigherOrderApp -> txt "-<<"
280− placeHanging (exprPlacement (unLoc input)) $
281− located input p_hsExpr
282− 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
283320 located form p_hsExpr
284321 unless (null cmds) $ do
285322 breakpoint
286323 inci (sequence_ (intersperse breakpoint (located' p_hsCmdTop <$> cmds)))
287− HsCmdArrForm NoExt form Infix _ [left, right] -> do
324+ HsCmdArrForm NoExtField form Infix _ [left, right] -> do
288325 located left p_hsCmdTop
289326 space
290327 located form p_hsExpr
291328 placeHanging (cmdTopPlacement (unLoc right)) $
292329 located right p_hsCmdTop
293− HsCmdArrForm NoExt _ Infix _ _ -> notImplemented "HsCmdArrForm"
330+ HsCmdArrForm NoExtField _ Infix _ _ -> notImplemented "HsCmdArrForm"
294331 HsCmdApp {} ->
295332 -- XXX Does this ever occur in the syntax tree? It does not seem like it
296333 -- does. Open an issue and ping @yumiova if this ever occurs in output.
297334 notImplemented "HsCmdApp"
298− HsCmdLam NoExt mgroup -> p_matchGroup' cmdPlacement p_hsCmd Lambda mgroup
299− HsCmdPar NoExt c -> parens (located c p_hsCmd)
300− HsCmdCase NoExt e mgroup -> do
301− txt "case"
302− space
303− located e p_hsExpr
304− space
305− txt "of"
306− breakpoint
307− inci (p_matchGroup' cmdPlacement p_hsCmd Case mgroup)
308− HsCmdIf NoExt _ if' then' else' -> do
309− txt "if"
310− space
311− located if' p_hsExpr
312− breakpoint
313− txt "then"
314− located then' $ \x -> do
315− breakpoint
316− inci (p_hsCmd x)
317− breakpoint
318− txt "else"
319− located else' $ \x -> do
320− breakpoint
321− inci (p_hsCmd x)
322− HsCmdLet NoExt localBinds c -> do
323− txt "let"
324− space
325− sitcc (located localBinds p_hsLocalBinds)
326− breakpoint
327− txt "in"
328− space
329− sitcc (located c p_hsCmd)
330− HsCmdDo NoExt es -> do
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 ->
338+ p_case cmdPlacement p_hsCmd e mgroup
339+ HsCmdIf NoExtField _ if' then' else' ->
340+ p_if cmdPlacement p_hsCmd if' then' else'
341+ HsCmdLet NoExtField localBinds c ->
342+ p_let p_hsCmd localBinds c
343+ HsCmdDo NoExtField es -> do
331344 txt "do"
332345 newline
333− inci (located es (sitcc . sep newline (located' (sitcc . p_stmt' p_hsCmd))))
346+ inci . located es $
347+ sitcc . sep newline (sitcc . withSpacing (p_stmt' cmdPlacement p_hsCmd))
334348 HsCmdWrap {} -> notImplemented "HsCmdWrap"
335− XCmd {} -> notImplemented "XCmd"
349+ XCmd x -> noExtCon x
336350
337351p_hsCmdTop :: HsCmdTop GhcPs -> R ()
338352p_hsCmdTop = \case
339− HsCmdTop NoExt cmd -> located cmd p_hsCmd
340− 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)
341384
342385p_stmt :: Stmt GhcPs (LHsExpr GhcPs) -> R ()
343−p_stmt = p_stmt' p_hsExpr
386+p_stmt = p_stmt' exprPlacement p_hsExpr
344387
345−p_stmt'
346− :: Data body
347− => (body -> R ())
348− -> Stmt GhcPs (Located body)
349− -> R ()
350−p_stmt' pretty = \case
351− LastStmt NoExt body _ _ -> located body pretty
352− BindStmt NoExt l f _ _ -> do
353− located l p_pat
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 ()
397+p_stmt' placer render = \case
398+ LastStmt NoExtField body _ _ -> located body render
399+ BindStmt NoExtField p f _ _ -> do
400+ located p p_pat
354401 space
355402 txt "<-"
356− breakpoint
357− inci (located f pretty)
403+ let loc = getLoc p
404+ placement =
405+ case f of
406+ L l' x ->
407+ if isOneLineSpan
408+ (mkSrcSpan (srcSpanEnd loc) (srcSpanStart l'))
409+ then placer x
410+ else Normal
411+ switchLayout [loc, getLoc f] $
412+ placeHanging placement (located f render)
358413 ApplicativeStmt {} -> notImplemented "ApplicativeStmt" -- generated by renamer
359− BodyStmt NoExt body _ _ -> located body pretty
360− LetStmt NoExt binds -> do
414+ BodyStmt NoExtField body _ _ -> located body render
415+ LetStmt NoExtField binds -> do
361416 txt "let"
362417 space
363418 sitcc $ located binds p_hsLocalBinds
364419 ParStmt {} ->
365− -- NOTE 'ParStmt' should always be eliminated in 'gatherStmt' already,
366− -- such that it never occurs in 'p_stmt''. Consequently, handling it
367− -- 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.
368423 notImplemented "ParStmt"
369− TransStmt {..} -> do
370− -- NOTE 'TransStmt' only needs to account for pretty printing itself,
371− -- since pretty printing of relevant statements (e.g., in 'trS_stmts')
372− -- 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'.
373428 case (trS_form, trS_by) of
374− (ThenForm, Nothing) -> located trS_using $ \x -> do
429+ (ThenForm, Nothing) -> do
375430 txt "then"
376431 breakpoint
377− inci (p_hsExpr x)
432+ inci $ located trS_using p_hsExpr
378433 (ThenForm, Just e) -> do
379− located trS_using $ \x -> do
380− txt "then"
381− breakpoint
382− inci (p_hsExpr x)
434+ txt "then"
383435 breakpoint
384− located e $ \x -> do
385− txt "by"
386− breakpoint
387− inci (p_hsExpr x)
388− (GroupForm, Nothing) -> located trS_using $ \x -> do
436+ inci $ located trS_using p_hsExpr
437+ breakpoint
438+ txt "by"
439+ breakpoint
440+ inci $ located e p_hsExpr
441+ (GroupForm, Nothing) -> do
389442 txt "then group using"
390443 breakpoint
391− inci (p_hsExpr x)
444+ inci $ located trS_using p_hsExpr
392445 (GroupForm, Just e) -> do
393− located e $ \x -> do
394− txt "then group by"
395− breakpoint
396− inci (p_hsExpr x)
446+ txt "then group by"
397447 breakpoint
398− located trS_using $ \x -> do
399− txt "using"
400− breakpoint
401− inci (p_hsExpr x)
448+ inci $ located e p_hsExpr
449+ breakpoint
450+ txt "using"
451+ breakpoint
452+ inci $ located trS_using p_hsExpr
402453 RecStmt {..} -> do
403454 txt "rec"
404455 space
405− sitcc $ sepSemi (located' (p_stmt' pretty)) recS_stmts
406− XStmtLR {} -> notImplemented "XStmtLR"
456+ sitcc $ sepSemi (withSpacing (p_stmt' placer render)) recS_stmts
457+ XStmtLR c -> noExtCon c
407458
408459gatherStmt :: ExprLStmt GhcPs -> [[ExprLStmt GhcPs]]
409−gatherStmt (L _ (ParStmt NoExt block _ _)) =
460+gatherStmt (L _ (ParStmt NoExtField block _ _)) =
410461 foldr ((<>) . gatherStmtBlock) [] block
411462gatherStmt (L s stmt@TransStmt {..}) =
412463 foldr liftAppend [] ((gatherStmt <$> trS_stmts) <> pure [[L s stmt]])
@@ -415,179 +466,230 @@ gatherStmt stmt = [[stmt]]
415466gatherStmtBlock :: ParStmtBlock GhcPs GhcPs -> [[ExprLStmt GhcPs]]
416467gatherStmtBlock (ParStmtBlock _ stmts _ _) =
417468 foldr (liftAppend . gatherStmt) [] stmts
418−gatherStmtBlock XParStmtBlock {} = notImplemented "XParStmtBlock"
469+gatherStmtBlock (XParStmtBlock x) = noExtCon x
419470
420471p_hsLocalBinds :: HsLocalBindsLR GhcPs GhcPs -> R ()
421472p_hsLocalBinds = \case
422− HsValBinds NoExt (ValBinds NoExt bag lsigs) -> do
423− let ssStart = either
424− (srcSpanStart . getLoc)
425− (srcSpanStart . getLoc)
426− items =
427− (Left <$> bagToList bag) ++ (Right <$> lsigs)
428− p_item (Left x) = located x p_valDecl
429− p_item (Right x) = located x p_sigDecl
430− -- Assigns 'False' to the last element, 'True' to the rest.
431− markInit :: [a] -> [(Bool, a)]
432− markInit [] = []
433− markInit (x:[]) = [(False, x)]
434− markInit (x:xs) = (True, x) : markInit xs
435− -- 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
436475 -- elements will also contain semicolons and they will confuse the
437476 -- parser. so we request braces around every element except the last.
438− br <- vlayout (return useBraces) (return id)
439− sitcc $ sepSemi
440− (\(m, i) -> (if m then br else id) $ p_item i)
441− (markInit $ sortOn ssStart items)
442− HsValBinds NoExt _ -> notImplemented "HsValBinds"
443− HsIPBinds NoExt (IPBinds NoExt xs) ->
477+ br <- layoutToBraces <$> getLayout
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) ->
444494 -- Second argument of IPBind is always Left before type-checking.
445− let p_ipBind (IPBind NoExt (Left name) expr) = do
495+ let p_ipBind (IPBind NoExtField (Left name) expr) = do
446496 atom name
447497 space
448− txt "="
498+ equals
449499 breakpoint
450500 useBraces $ inci $ located expr p_hsExpr
451− 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
452505 in sepSemi (located' p_ipBind) xs
453− HsIPBinds NoExt _ -> notImplemented "HsIpBinds"
454− EmptyLocalBinds NoExt -> return ()
455− XHsLocalBindsLR _ -> notImplemented "XHsLocalBindsLR"
506+ HsIPBinds NoExtField _ -> notImplemented "HsIpBinds"
507+ EmptyLocalBinds NoExtField -> return ()
508+ XHsLocalBindsLR x -> noExtCon x
456509
457−p_hsRecField
458− :: (Data id, Outputable id)
459− => HsRecField' id (LHsExpr GhcPs)
460− -> R ()
461−p_hsRecField = \HsRecField {..} -> do
462− located hsRecFieldLbl atom
510+p_hsRecField ::
511+ HsRecField' RdrName (LHsExpr GhcPs) ->
512+ R ()
513+p_hsRecField HsRecField {..} = do
514+ p_rdrName hsRecFieldLbl
463515 unless hsRecPun $ do
464516 space
465− txt "="
466− let placement = exprPlacement (unLoc hsRecFieldArg)
467− placeHanging placement $ located hsRecFieldArg p_hsExpr
468−
469−p_hsTupArg :: HsTupArg GhcPs -> R ()
470−p_hsTupArg = \case
471− Present NoExt x -> located x p_hsExpr
472− Missing NoExt -> pure ()
473− 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)
474523
475524p_hsExpr :: HsExpr GhcPs -> R ()
476−p_hsExpr = \case
477− HsVar NoExt name -> p_rdrName name
478− HsUnboundVar NoExt _ -> notImplemented "HsUnboundVar"
479− HsConLikeOut NoExt _ -> notImplemented "HsConLikeOut"
480− HsRecFld NoExt x ->
525+p_hsExpr = p_hsExpr' N
526+
527+p_hsExpr' :: BracketStyle -> HsExpr GhcPs -> R ()
528+p_hsExpr' s = \case
529+ HsVar NoExtField name -> p_rdrName name
530+ HsUnboundVar NoExtField v -> atom (unboundVarOcc v)
531+ HsConLikeOut NoExtField _ -> notImplemented "HsConLikeOut"
532+ HsRecFld NoExtField x ->
481533 case x of
482− Unambiguous NoExt name -> p_rdrName name
483− Ambiguous NoExt name -> p_rdrName name
484− XAmbiguousFieldOcc NoExt -> notImplemented "XAmbiguousFieldOcc"
485− 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
486538 txt "#"
487539 atom v
488− HsIPVar NoExt (HsIPName name) -> do
540+ HsIPVar NoExtField (HsIPName name) -> do
489541 txt "?"
490542 atom name
491− HsOverLit NoExt v -> atom (ol_val v)
492− HsLit NoExt lit -> atom lit
493− HsLam NoExt mgroup ->
543+ HsOverLit NoExtField v -> atom (ol_val v)
544+ HsLit NoExtField lit ->
545+ case lit of
546+ HsString (SourceText stxt) _ -> p_stringLit stxt
547+ HsStringPrim (SourceText stxt) _ -> p_stringLit stxt
548+ r -> atom r
549+ HsLam NoExtField mgroup ->
494550 p_matchGroup Lambda mgroup
495− HsLamCase NoExt mgroup -> do
551+ HsLamCase NoExtField mgroup -> do
496552 txt "\\case"
497553 breakpoint
498554 inci (p_matchGroup LambdaCase mgroup)
499− HsApp NoExt f x -> sitcc $ do
500− located f p_hsExpr
501− -- Second argument can be a `do` or `case` block with `-XBlockArguments`.
502− placeHanging (exprPlacement (unLoc x)) $
503− located x p_hsExpr
504− HsAppType a e -> 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 =
560+ case f' of
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.
572+ placement =
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
505612 located e p_hsExpr
506613 breakpoint
507614 inci $ do
508615 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 ()
509621 located (hswc_body a) p_hsType
510− OpApp NoExt x op y -> do
622+ OpApp NoExtField x op y -> do
511623 let opTree = OpBranch (exprOpTree x) op (exprOpTree y)
512− getOpName = \case
513− HsVar NoExt (L _ a) -> Just a
514− _ -> Nothing
515− p_exprOpTree (reassociateOpTree getOpName opTree)
516− NegApp NoExt e _ -> do
624+ p_exprOpTree s (reassociateOpTree getOpName opTree)
625+ NegApp NoExtField e _ -> do
517626 txt "-"
518627 space
519628 located e p_hsExpr
520− HsPar NoExt e -> parens (located e p_hsExpr)
521− SectionL NoExt x op -> do
629+ HsPar NoExtField e ->
630+ parens s (located e (dontUseBraces . p_hsExpr))
631+ SectionL NoExtField x op -> do
522632 located x p_hsExpr
523633 breakpoint
524634 inci (located op p_hsExpr)
525− SectionR NoExt op x -> do
635+ SectionR NoExtField op x -> do
526636 located op p_hsExpr
527− breakpoint
637+ useRecordDot' <- useRecordDot
638+ let isRecordDot' = isRecordDot (unLoc op) (getLoc x)
639+ unless (useRecordDot' && isRecordDot') breakpoint
528640 inci (located x p_hsExpr)
529− ExplicitTuple NoExt args boxity -> do
641+ ExplicitTuple NoExtField args boxity ->
530642 let isSection = any (isMissing . unLoc) args
531643 isMissing = \case
532− Missing NoExt -> True
644+ Missing NoExtField -> True
533645 _ -> False
534− 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' =
535652 case boxity of
536653 Boxed -> parens
537654 Unboxed -> parensHash
538− if isSection
539− then switchLayout [] . parens' $
540− sep comma (located' p_hsTupArg) args
541− else switchLayout (getLoc <$> args) . parens' . sitcc $
542− sep (comma >> breakpoint) (sitcc . located' p_hsTupArg) args
543− ExplicitSum NoExt tag arity e ->
544− p_unboxedSum tag arity (located e p_hsExpr)
545− HsCase NoExt e mgroup -> do
546− txt "case"
547− space
548− located e p_hsExpr
549− space
550− txt "of"
551− breakpoint
552− inci (p_matchGroup Case mgroup)
553− HsIf NoExt _ if' then' else' -> do
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 ->
663+ p_unboxedSum N tag arity (located e p_hsExpr)
664+ HsCase NoExtField e mgroup ->
665+ p_case exprPlacement p_hsExpr e mgroup
666+ HsIf NoExtField _ if' then' else' ->
667+ p_if exprPlacement p_hsExpr if' then' else'
668+ HsMultiIf NoExtField guards -> do
554669 txt "if"
555− space
556− located if' p_hsExpr
557670 breakpoint
558− inci $ do
559− txt "then"
560− located then' $ \x ->
561− placeHanging (exprPlacement x) (p_hsExpr x)
562− breakpoint
563− txt "else"
564− located else' $ \x ->
565− placeHanging (exprPlacement x) (p_hsExpr x)
566− HsMultiIf NoExt guards -> do
567− txt "if"
568− breakpoint
569− inci . sitcc $ sep newline (located' (p_grhs RightArrow)) guards
570− HsLet NoExt localBinds e -> sitcc $ do
571− txt "let"
572− space
573− dontUseBraces $ sitcc (located localBinds p_hsLocalBinds)
574− vlayout space (newline >> txt " ")
575− txt "in"
576− space
577− sitcc (located e p_hsExpr)
578− HsDo NoExt ctx es -> do
671+ inci . inci $ sep newline (located' (p_grhs RightArrow)) guards
672+ HsLet NoExtField localBinds e ->
673+ p_let p_hsExpr localBinds e
674+ HsDo NoExtField ctx es -> do
579675 let doBody header = do
580676 txt header
581677 breakpoint
582− ub <- vlayout (return useBraces) (return id)
583− inci $ sepSemi (located' (ub . p_stmt)) (unLoc es)
584− compBody = brackets $ located es $ \xs -> do
585− let p_parBody = sep
586− (breakpoint >> txt "| ")
587− p_seqBody
588− p_seqBody = sitcc . sep
589− (comma >> breakpoint)
590− (located' (sitcc . p_stmt))
678+ ub <- layoutToBraces <$> getLayout
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))
591693 stmts = init xs
592694 yield = last xs
593695 lists = foldr (liftAppend . gatherStmt) [] stmts
@@ -601,76 +703,100 @@ p_hsExpr = \case
601703 MDoExpr -> doBody "mdo"
602704 ListComp -> compBody
603705 MonadComp -> notImplemented "MonadComp"
604− ArrowExpr -> notImplemented "ArrowExpr"
706+ ArrowExpr -> notImplemented "ArrowExpr"
605707 GhciStmtCtxt -> notImplemented "GhciStmtCtxt"
606708 PatGuard _ -> notImplemented "PatGuard"
607709 ParStmtCtxt _ -> notImplemented "ParStmtCtxt"
608710 TransStmtCtxt _ -> notImplemented "TransStmtCtxt"
609711 ExplicitList _ _ xs ->
610− brackets . sitcc $ sep (comma >> breakpoint) (sitcc . located' p_hsExpr) xs
712+ brackets s $
713+ sep commaDel (sitcc . located' p_hsExpr) xs
611714 RecordCon {..} -> do
612715 located rcon_con_name atom
613716 breakpoint
614717 let HsRecFields {..} = rcon_flds
615− fields = located' p_hsRecField <$> rec_flds
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+ }
724+ fields = located' (p_hsRecField . updName) <$> rec_flds
616725 dotdot =
617726 case rec_dotdot of
618727 Just {} -> [txt ".."]
619728 Nothing -> []
620− inci . braces . sitcc $ sep (comma >> breakpoint) sitcc (fields <> dotdot)
729+ inci . braces N $
730+ sep commaDel sitcc (fields <> dotdot)
621731 RecordUpd {..} -> do
622732 located rupd_expr p_hsExpr
623− breakpoint
624− inci . braces . sitcc $
625− sep (comma >> breakpoint) (sitcc . located' p_hsRecField) rupd_flds
626− ExprWithTySig affix x -> sitcc $ do
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 $
749+ sep
750+ commaDel
751+ (sitcc . located' (p_hsRecField . updName))
752+ rupd_flds
753+ ExprWithTySig NoExtField x HsWC {hswc_body = HsIB {..}} -> sitcc $ do
627754 located x p_hsExpr
755+ space
756+ txt "::"
628757 breakpoint
629− inci $ do
630− txt "::"
631− space
632− let HsWC {..} = affix
633− HsIB {..} = hswc_body
634− located hsib_body p_hsType
635− 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 ->
636762 case x of
637− From from -> brackets . sitcc $ do
763+ From from -> brackets s $ do
638764 located from p_hsExpr
639765 breakpoint
640766 txt ".."
641− FromThen from next -> brackets . sitcc $ do
642− sitcc $ sep (comma >> breakpoint) (located' p_hsExpr) [from, next]
767+ FromThen from next -> brackets s $ do
768+ sep commaDel (located' p_hsExpr) [from, next]
643769 breakpoint
644770 txt ".."
645− FromTo from to -> brackets . sitcc $ do
771+ FromTo from to -> brackets s $ do
646772 located from p_hsExpr
647773 breakpoint
648774 txt ".."
649775 space
650776 located to p_hsExpr
651− FromThenTo from next to -> brackets . sitcc $ do
652− 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]
653779 breakpoint
654780 txt ".."
655781 space
656782 located to p_hsExpr
657− HsSCC NoExt _ name x -> do
783+ HsSCC NoExtField _ name x -> do
658784 txt "{-# SCC "
659785 atom name
660786 txt " #-}"
661787 breakpoint
662788 located x p_hsExpr
663− HsCoreAnn NoExt _ value x -> do
789+ HsCoreAnn NoExtField _ value x -> do
664790 txt "{-# CORE "
665791 atom value
666792 txt " #-}"
667793 breakpoint
668794 located x p_hsExpr
669− HsBracket NoExt x -> p_hsBracket x
795+ HsBracket NoExtField x -> p_hsBracket x
670796 HsRnBracketOut {} -> notImplemented "HsRnBracketOut"
671797 HsTcBracketOut {} -> notImplemented "HsTcBracketOut"
672− HsSpliceE NoExt splice -> p_hsSplice splice
673− HsProc NoExt p e -> do
798+ HsSpliceE NoExtField splice -> p_hsSplice splice
799+ HsProc NoExtField p e -> do
674800 txt "proc"
675801 located p $ \x -> do
676802 breakpoint
@@ -679,65 +805,46 @@ p_hsExpr = \case
679805 txt "->"
680806 placeHanging (cmdTopPlacement (unLoc e)) $
681807 located e p_hsCmdTop
682− HsStatic _ e -> do
808+ HsStatic _ e -> do
683809 txt "static"
684810 breakpoint
685811 inci (located e p_hsExpr)
686− HsArrApp NoExt body input arrType cond ->
687− p_hsCmd (HsCmdArrApp NoExt body input arrType cond)
688− HsArrForm NoExt form mfixity cmds ->
689− p_hsCmd (HsCmdArrForm NoExt form Prefix mfixity cmds)
690812 HsTick {} -> notImplemented "HsTick"
691813 HsBinTick {} -> notImplemented "HsBinTick"
692814 HsTickPragma {} -> notImplemented "HsTickPragma"
693− -- These four constructs should never appear in correct programs.
694− -- See: https://github.com/tweag/ormolu/issues/343
695− EWildPat NoExt -> txt "_"
696− EAsPat NoExt n p -> do
697− p_rdrName n
698− txt "@"
699− located p p_hsExpr
700− EViewPat NoExt p e -> do
701− located p p_hsExpr
702− space
703− txt "->"
704− breakpoint
705− inci (located e p_hsExpr)
706− ELazyPat NoExt p -> do
707− txt "~"
708− located p p_hsExpr
709815 HsWrap {} -> notImplemented "HsWrap"
710− XExpr {} -> notImplemented "XExpr"
816+ XExpr x -> noExtCon x
711817
712818p_patSynBind :: PatSynBind GhcPs GhcPs -> R ()
713819p_patSynBind PSB {..} = do
714− let rhs = case psb_dir of
715− Unidirectional -> do
716− txt "<-"
717− space
718− located psb_def p_pat
719− ImplicitBidirectional -> do
720− txt "="
721− space
722− located psb_def p_pat
723− ExplicitBidirectional mgroup -> do
724− txt "<-"
725− space
726− located psb_def p_pat
727− newline
728− txt "where"
729− newline
730− inci (p_matchGroup (Function psb_id) mgroup)
820+ let rhs = do
821+ space
822+ case psb_dir of
823+ Unidirectional -> do
824+ txt "<-"
825+ breakpoint
826+ located psb_def p_pat
827+ ImplicitBidirectional -> do
828+ equals
829+ breakpoint
830+ located psb_def p_pat
831+ ExplicitBidirectional mgroup -> do
832+ txt "<-"
833+ breakpoint
834+ located psb_def p_pat
835+ newline
836+ txt "where"
837+ newline
838+ inci (p_matchGroup (Function psb_id) mgroup)
731839 txt "pattern"
732840 case psb_args of
733841 PrefixCon xs -> do
734842 space
735843 p_rdrName psb_id
736− inci $ do
844+ inci $ do
737845 switchLayout (getLoc <$> xs) $ do
738846 unless (null xs) breakpoint
739847 sitcc (sep breakpoint p_rdrName xs)
740− breakpoint
741848 rhs
742849 RecCon xs -> do
743850 space
@@ -745,9 +852,8 @@ p_patSynBind PSB {..} = do
745852 inci $ do
746853 switchLayout (getLoc . recordPatSynPatVar <$> xs) $ do
747854 unless (null xs) breakpoint
748− braces . sitcc $
749− sep (comma >> breakpoint) (p_rdrName . recordPatSynPatVar) xs
750− breakpoint
855+ braces N $
856+ sep commaDel (p_rdrName . recordPatSynPatVar) xs
751857 rhs
752858 InfixCon l r -> do
753859 switchLayout [getLoc l, getLoc r] $ do
@@ -758,37 +864,100 @@ p_patSynBind PSB {..} = do
758864 p_rdrName psb_id
759865 space
760866 p_rdrName r
761− inci $ do
762− breakpoint
763− rhs
764−p_patSynBind (XPatSynBind NoExt) = notImplemented "XPatSynBind"
867+ inci rhs
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 ()
881+p_case placer render e mgroup = do
882+ txt "case"
883+ space
884+ located e p_hsExpr
885+ space
886+ txt "of"
887+ breakpoint
888+ inci (p_matchGroup' placer render Case mgroup)
889+
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 ()
903+p_if placer render if' then' else' = do
904+ txt "if"
905+ space
906+ located if' p_hsExpr
907+ breakpoint
908+ inci $ do
909+ txt "then"
910+ space
911+ located then' $ \x ->
912+ placeHanging (placer x) (render x)
913+ breakpoint
914+ txt "else"
915+ space
916+ located else' $ \x ->
917+ placeHanging (placer x) (render x)
918+
919+p_let ::
920+ Data body =>
921+ -- | Render
922+ (body -> R ()) ->
923+ Located (HsLocalBindsLR GhcPs GhcPs) ->
924+ Located body ->
925+ R ()
926+p_let render localBinds e = sitcc $ do
927+ txt "let"
928+ space
929+ dontUseBraces $ sitcc (located localBinds p_hsLocalBinds)
930+ vlayout space (newline >> txt " ")
931+ txt "in"
932+ space
933+ sitcc (located e render)
765934
766935p_pat :: Pat GhcPs -> R ()
767936p_pat = \case
768− WildPat NoExt -> txt "_"
769− VarPat NoExt name -> p_rdrName name
770− LazyPat NoExt pat -> do
937+ WildPat NoExtField -> txt "_"
938+ VarPat NoExtField name -> p_rdrName name
939+ LazyPat NoExtField pat -> do
771940 txt "~"
772941 located pat p_pat
773− AsPat NoExt name pat -> do
942+ AsPat NoExtField name pat -> do
774943 p_rdrName name
775944 txt "@"
776945 located pat p_pat
777− ParPat NoExt pat ->
778− located pat (parens . p_pat)
779− BangPat NoExt pat -> do
946+ ParPat NoExtField pat ->
947+ located pat (parens S . p_pat)
948+ BangPat NoExtField pat -> do
780949 txt "!"
781950 located pat p_pat
782− ListPat NoExt pats -> do
783− brackets . sitcc $ sep (comma >> breakpoint) (located' p_pat) pats
784− TuplePat NoExt pats boxing -> do
785− let f =
951+ ListPat NoExtField pats ->
952+ brackets S $ sep commaDel (located' p_pat) pats
953+ TuplePat NoExtField pats boxing -> do
954+ let parens' =
786955 case boxing of
787− Boxed -> parens
788− Unboxed -> parensHash
789− f . sitcc $ sep (comma >> breakpoint) (sitcc . located' p_pat) pats
790− SumPat NoExt pat tag arity ->
791− p_unboxedSum tag arity (located pat p_pat)
956+ Boxed -> parens S
957+ Unboxed -> parensHash S
958+ parens' $ sep commaDel (sitcc . located' p_pat) pats
959+ SumPat NoExtField pat tag arity ->
960+ p_unboxedSum S tag arity (located pat p_pat)
792961 ConPatIn pat details ->
793962 case details of
794963 PrefixCon xs -> sitcc $ do
@@ -802,37 +971,40 @@ p_pat = \case
802971 let f = \case
803972 Nothing -> txt ".."
804973 Just x -> located x p_pat_hsRecField
805− inci . braces . sitcc . sep (comma >> breakpoint) f $ case dotdot of
806− Nothing -> Just <$> fields
807− Just n -> (Just <$> take n fields) ++ [Nothing]
808− InfixCon x y -> do
809− located x p_pat
810− space
811− p_rdrName pat
812− breakpoint
813− inci (located y p_pat)
974+ inci . braces N . sep commaDel f $
975+ case dotdot of
976+ Nothing -> Just <$> fields
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
814986 ConPatOut {} -> notImplemented "ConPatOut" -- presumably created by renamer?
815− ViewPat NoExt expr pat -> sitcc $ do
987+ ViewPat NoExtField expr pat -> sitcc $ do
816988 located expr p_hsExpr
817989 space
818990 txt "->"
819991 breakpoint
820992 inci (located pat p_pat)
821− SplicePat NoExt splice -> p_hsSplice splice
822− LitPat NoExt p -> atom p
823− NPat NoExt v _ _ -> located v (atom . ol_val)
824− 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
825997 p_rdrName n
826998 breakpoint
827999 inci $ do
8281000 txt "+"
8291001 space
8301002 located k (atom . ol_val)
831− SigPat hswc pat -> do
1003+ SigPat NoExtField pat hswc -> do
8321004 located pat p_pat
8331005 p_typeAscription hswc
8341006 CoPat {} -> notImplemented "CoPat" -- apparently created at some later stage
835− XPat NoExt -> notImplemented "XPat"
1007+ XPat x -> noExtCon x
8361008
8371009p_pat_hsRecField :: HsRecField' (FieldOcc GhcPs) (LPat GhcPs) -> R ()
8381010p_pat_hsRecField HsRecField {..} = do
@@ -840,51 +1012,53 @@ p_pat_hsRecField HsRecField {..} = do
8401012 p_rdrName (rdrNameFieldOcc x)
8411013 unless hsRecPun $ do
8421014 space
843− txt "="
1015+ equals
8441016 breakpoint
8451017 inci (located hsRecFieldArg p_pat)
8461018
847−p_unboxedSum :: ConTag -> Arity -> R () -> R ()
848−p_unboxedSum tag arity m = do
1019+p_unboxedSum :: BracketStyle -> ConTag -> Arity -> R () -> R ()
1020+p_unboxedSum s tag arity m = do
8491021 let before = tag - 1
8501022 after = arity - before - 1
8511023 args = replicate before Nothing <> [Just m] <> replicate after Nothing
852− f (x,i) = do
853− let isFirst = i == 0
854− isLast = i == arity - 1
1024+ f x =
8551025 case x :: Maybe (R ()) of
8561026 Nothing ->
857− unless (isFirst || isLast) space
1027+ space
8581028 Just m' -> do
859− unless isFirst space
1029+ space
8601030 m'
861− unless isLast space
862− parensHash $ sep (txt "|") f (zip args [0..])
1031+ space
1032+ parensHash s $ sep (txt "|") f args
8631033
8641034p_hsSplice :: HsSplice GhcPs -> R ()
8651035p_hsSplice = \case
866− HsTypedSplice NoExt deco _ expr -> p_hsSpliceTH True expr deco
867− HsUntypedSplice NoExt deco _ expr -> p_hsSpliceTH False expr deco
868− 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
8691039 txt "["
8701040 p_rdrName (L srcSpan quoterName)
8711041 txt "|"
872− -- NOTE QuasiQuoters often rely on precise custom strings. We cannot do
873− -- 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.
8741044 atom str
8751045 txt "|]"
8761046 HsSpliced {} -> notImplemented "HsSpliced"
877− XSplice {} -> notImplemented "XSplice"
1047+ HsSplicedT {} -> notImplemented "HsSplicedT"
1048+ XSplice x -> noExtCon x
8781049
879−p_hsSpliceTH
880− :: Bool -- ^ Typed splice?
881− -> LHsExpr GhcPs -- ^ Splice expression
882− -> SpliceDecoration -- ^ Splice decoration
883− -> R ()
1050+p_hsSpliceTH ::
1051+ -- | Typed splice?
1052+ Bool ->
1053+ -- | Splice expression
1054+ LHsExpr GhcPs ->
1055+ -- | Splice decoration
1056+ SpliceDecoration ->
1057+ R ()
8841058p_hsSpliceTH isTyped expr = \case
8851059 HasParens -> do
8861060 txt decoSymbol
887− parens (located expr (sitcc . p_hsExpr))
1061+ parens N (located expr (sitcc . p_hsExpr))
8881062 HasDollar -> do
8891063 txt decoSymbol
8901064 located expr (sitcc . p_hsExpr)
@@ -895,17 +1069,17 @@ p_hsSpliceTH isTyped expr = \case
8951069
8961070p_hsBracket :: HsBracket GhcPs -> R ()
8971071p_hsBracket = \case
898− ExpBr NoExt expr -> do
1072+ ExpBr NoExtField expr -> do
8991073 anns <- getEnclosingAnns
9001074 let name = case anns of
901− AnnOpenEQ:_ -> ""
1075+ AnnOpenEQ : _ -> ""
9021076 _ -> "e"
9031077 quote name (located expr p_hsExpr)
904− PatBr NoExt pat -> quote "p" (located pat p_pat)
905− DecBrL NoExt decls -> quote "d" (p_hsDecls Free decls)
906− DecBrG NoExt _ -> notImplemented "DecBrG" -- result of renamer
907− TypBr NoExt ty -> quote "t" (located ty p_hsType)
908− 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
9091083 txt (bool "''" "'" isSingleQuote)
9101084 -- HACK As you can see we use 'noLoc' here to be able to pass name into
9111085 -- 'p_rdrName' since the latter expects a "located" thing. The problem
@@ -913,19 +1087,20 @@ p_hsBracket = \case
9131087 -- turn makes it impossible to detect if there are parentheses around
9141088 -- it, etc. So we have to add parentheses manually assuming they are
9151089 -- necessary for all operators.
916− let isOperator = all
917− (\i -> isPunctuation i || isSymbol i)
918− (showOutputable (rdrNameOcc name))
919− && not (doesNotNeedExtraParens name)
920− wrapper = if isOperator then parens else id
1090+ let isOperator =
1091+ all
1092+ (\i -> isPunctuation i || isSymbol i)
1093+ (showOutputable (rdrNameOcc name))
1094+ && not (doesNotNeedExtraParens name)
1095+ wrapper = if isOperator then parens N else id
9211096 wrapper $ p_rdrName (noLoc name)
922− TExpBr NoExt expr -> do
1097+ TExpBr NoExtField expr -> do
9231098 txt "[||"
9241099 breakpoint'
9251100 located expr p_hsExpr
9261101 breakpoint'
9271102 txt "||]"
928− XBracket {} -> notImplemented "XBracket"
1103+ XBracket x -> noExtCon x
9291104 where
9301105 quote :: Text -> R () -> R ()
9311106 quote name body = do
@@ -938,12 +1113,65 @@ p_hsBracket = \case
9381113 breakpoint'
9391114 txt "|]"
9401115
1116+-- Print the source text of a string literal while indenting
1117+-- gaps correctly.
1118+
1119+p_stringLit :: String -> R ()
1120+p_stringLit src =
1121+ let s = splitGaps src
1122+ singleLine =
1123+ txt $ Text.pack (mconcat s)
1124+ multiLine =
1125+ sitcc $ sep breakpoint (txt . Text.pack) (backslashes s)
1126+ in vlayout singleLine multiLine
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 '\'
1141+ r' = drop 1 . dropWhile ghcSpace . drop 1 $ map orig r
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
1162+
9411163----------------------------------------------------------------------------
9421164-- Helpers
9431165
1166+-- | Return the wrapping function controlling the use of braces according to
1167+-- the current layout.
1168+layoutToBraces :: Layout -> R () -> R ()
1169+layoutToBraces = \case
1170+ SingleLine -> useBraces
1171+ MultiLine -> id
1172+
9441173-- | Append each element in both lists with semigroups. If one list is shorter
9451174-- than the other, return the rest of the longer list unchanged.
946−
9471175liftAppend :: Semigroup a => [a] -> [a] -> [a]
9481176liftAppend [] [] = []
9491177liftAppend [] (y : ys) = y : ys
@@ -951,14 +1179,13 @@ liftAppend (x : xs) [] = x : xs
9511179liftAppend (x : xs) (y : ys) = x <> y : liftAppend xs ys
9521180
9531181getGRHSSpan :: GRHS GhcPs (Located body) -> SrcSpan
954−getGRHSSpan (GRHS NoExt guards body) =
1182+getGRHSSpan (GRHS NoExtField guards body) =
9551183 combineSrcSpans' $ getLoc body :| map getLoc guards
956−getGRHSSpan (XGRHS NoExt) = notImplemented "XGRHS"
1184+getGRHSSpan (XGRHS x) = noExtCon x
9571185
9581186-- | Place a thing that may have a hanging form. This function handles how
9591187-- to separate it from preceding expressions and whether to bump indentation
9601188-- depending on what sort of expression we have.
961−
9621189placeHanging :: Placement -> R () -> R ()
9631190placeHanging placement m =
9641191 case placement of
@@ -971,100 +1198,165 @@ placeHanging placement m =
9711198
9721199-- | Check if given block contains single expression which has a hanging
9731200-- form.
974−
975−blockPlacement
976− :: (body -> Placement)
977− -> [LGRHS GhcPs (Located body)]
978− -> Placement
979−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
9801206blockPlacement _ _ = Normal
9811207
9821208-- | Check if given command has a hanging form.
983−
9841209cmdPlacement :: HsCmd GhcPs -> Placement
9851210cmdPlacement = \case
986− HsCmdLam NoExt _ -> Hanging
987− HsCmdCase NoExt _ _ -> Hanging
988− HsCmdDo NoExt _ -> Hanging
1211+ HsCmdLam NoExtField _ -> Hanging
1212+ HsCmdCase NoExtField _ _ -> Hanging
1213+ HsCmdDo NoExtField _ -> Hanging
9891214 _ -> Normal
9901215
9911216cmdTopPlacement :: HsCmdTop GhcPs -> Placement
9921217cmdTopPlacement = \case
993− HsCmdTop NoExt (L _ x) -> cmdPlacement x
994− XCmdTop {} -> notImplemented "XCmdTop"
1218+ HsCmdTop NoExtField (L _ x) -> cmdPlacement x
1219+ XCmdTop x -> noExtCon x
9951220
9961221-- | Check if given expression has a hanging form.
997−
9981222exprPlacement :: HsExpr GhcPs -> Placement
9991223exprPlacement = \case
10001224 -- Only hang lambdas with single line parameter lists
1001− HsLam NoExt mg -> case mg of
1002− MG _ (L _ [L _ (Match NoExt _ (x:xs) _)]) _
1003− | isOneLineSpan (combineSrcSpans' $ fmap getLoc (x :| xs))
1004− -> 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
10051229 _ -> Normal
1006− HsLamCase NoExt _ -> Hanging
1007− HsCase NoExt _ _ -> Hanging
1008− HsDo NoExt DoExpr _ -> Hanging
1009− HsDo NoExt MDoExpr _ -> Hanging
1010− RecordCon NoExt _ _ -> Hanging
1011− -- If the rightmost expression in an operator chain is hanging, make the
1012− -- whole block hanging; so that we can use the common @f = foo $ do@
1013− -- style.
1014− OpApp NoExt _ _ y -> exprPlacement (unLoc y)
1015− 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 _ ->
10161240 -- Indentation breaks if pattern is longer than one line and left
10171241 -- hanging. Consequently, only apply hanging when it is safe.
1018− if isOneLineSpan s
1019− then Hanging
1020− else Normal
1242+ if isOneLineSpan (getLoc p)
1243+ then Hanging
1244+ else Normal
10211245 _ -> Normal
10221246
10231247withGuards :: [LGRHS GhcPs (Located body)] -> Bool
10241248withGuards = any (checkOne . unLoc)
10251249 where
10261250 checkOne :: GRHS GhcPs (Located body) -> Bool
1027− checkOne (GRHS NoExt [] _) = False
1251+ checkOne (GRHS NoExtField [] _) = False
10281252 checkOne _ = True
10291253
10301254exprOpTree :: LHsExpr GhcPs -> OpTree (LHsExpr GhcPs) (LHsExpr GhcPs)
1031−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)
10321256exprOpTree n = OpNode n
10331257
1034−p_exprOpTree :: OpTree (LHsExpr GhcPs) (LHsExpr GhcPs) -> R ()
1035−p_exprOpTree (OpNode x) = located x p_hsExpr
1036−p_exprOpTree (OpBranch x op y) = do
1037− -- NOTE If the beginning of the first argument and the second argument
1038− -- are on the same line, and the second argument has a hanging form, use
1039− -- hanging placement.
1258+getOpName :: HsExpr GhcPs -> Maybe RdrName
1259+getOpName = \case
1260+ HsVar NoExtField (L _ a) -> Just a
1261+ _ -> Nothing
1262+
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.
10401276 let placement =
10411277 if isOneLineSpan
1042− (mkSrcSpan (srcSpanStart (opTreeLoc x)) (srcSpanStart (opTreeLoc y)))
1278+ (mkSrcSpan (srcSpanStart (opTreeLoc x)) (srcSpanStart (opTreeLoc y)))
10431279 then case y of
1044− OpNode (L _ n) -> exprPlacement n
1045− _ -> Normal
1280+ OpNode (L _ n) -> exprPlacement n
1281+ _ -> Normal
10461282 else Normal
1283+ -- Distinguish holes used in infix notation.
1284+ -- eg. '1 _foo 2' and '1 `_foo` 2'
10471285 opWrapper = case unLoc op of
1048− EWildPat NoExt -> backticks
1286+ HsUnboundVar NoExtField _ -> backticks
10491287 _ -> id
1050− ub <- vlayout
1051− (return useBraces)
1052− (return $ case placement of
1053− Hanging -> useBraces
1054− Normal -> dontUseBraces)
1055− switchLayout [opTreeLoc x] $
1056− ub $ p_exprOpTree x
1057− placeHanging placement $ do
1058− located op (opWrapper . p_hsExpr)
1059− space
1060− switchLayout [opTreeLoc y] $
1061− p_exprOpTree y
1288+ layout <- getLayout
1289+ let ub = case layout of
1290+ SingleLine -> useBraces
1291+ MultiLine -> case placement of
1292+ Hanging -> useBraces
1293+ Normal -> dontUseBraces
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
1306+ _ -> False
1307+ isDoBlock = \case
1308+ OpNode (L _ HsDo {}) -> True
1309+ _ -> False
1310+ useRecordDot' <- useRecordDot
1311+ if
1312+ | gotColon -> do
1313+ lhs
1314+ space
1315+ 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
1327+ space
1328+ p_op
1329+ breakpoint
1330+ inci p_y
1331+ | useRecordDot' && gotRecordDot -> do
1332+ lhs
1333+ when isSection space
1334+ p_op
1335+ p_y
1336+ | otherwise -> do
1337+ ub lhs
1338+ placeHanging placement $ do
1339+ p_op
1340+ space
1341+ p_y
10621342
1063−-- | Get annotations for the enclosing element.
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
10641355
1356+-- | Get annotations for the enclosing element.
10651357getEnclosingAnns :: R [AnnKeywordId]
10661358getEnclosingAnns = do
10671359 e <- getEnclosingSpan (const True)
10681360 case e of
10691361 Nothing -> return []
1070− Just e' -> getAnns (RealSrcSpan e')
1362+ Just e' -> getAnns (RealSrcSpan e')