@@ -1,36 +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
13−import Ormolu.Printer.Internal
1416import Bag (bagToList)
1517import BasicTypes
1618import Control.Monad
19+import Ctype (is_space)
1720import Data.Bool (bool)
18−import Data.Char (isPunctuation)
21+import Data.Char (isPunctuation, isSymbol)
1922import Data.Data hiding (Infix, Prefix)
23+import Data.Functor ((<&>))
2024import Data.List (intersperse, sortOn)
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
37+import Ormolu.Printer.Operators
2738import Ormolu.Utils
28−import Outputable (Outputable (..))
29−import RdrName (rdrNameOcc)
30−import SrcLoc (combineSrcSpans, isOneLineSpan)
31−import qualified Data.List.NonEmpty as NE
32−import {-# SOURCE #-} Ormolu.Printer.Meat.Declaration
3339
40+-- | Style of a group of equations.
3441data MatchGroupStyle
3542 = Function (Located RdrName)
3643 | PatternBind
@@ -38,66 +45,77 @@ data MatchGroupStyle
3845 | Lambda
3946 | LambdaCase
4047
48+-- | Style of equations in a group.
4149data GroupStyle
4250 = EqualSign
4351 | RightArrow
4452
4553-- | Expression placement. This marks the places where expressions that
4654-- implement handing forms may use them.
47−
4855data Placement
49− = Normal -- ^ Multi-line layout should cause
50− -- insertion of a newline and indentation
51− -- bump
52− | Hanging -- ^ Expressions that have hanging form
53− -- should use it and avoid bumping one level
54− -- 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)
5565
5666p_valDecl :: HsBindLR GhcPs GhcPs -> R ()
57−p_valDecl = line . p_valDecl'
58−
59−p_valDecl' :: HsBindLR GhcPs GhcPs -> R ()
60−p_valDecl' = \case
61− FunBind NoExt funId funMatches _ _ -> p_funBind funId funMatches
62− PatBind NoExt pat grhss _ -> p_match PatternBind False NoSrcStrict [pat] grhss
67+p_valDecl = \case
68+ FunBind NoExtField funId funMatches _ _ -> p_funBind funId funMatches
69+ PatBind NoExtField pat grhss _ -> p_match PatternBind False NoSrcStrict [pat] grhss
6370 VarBind {} -> notImplemented "VarBinds" -- introduced by the type checker
6471 AbsBinds {} -> notImplemented "AbsBinds" -- introduced by the type checker
65− PatSynBind NoExt psb -> p_patSynBind psb
66− XHsBindsLR NoExt -> notImplemented "XHsBindsLR"
72+ PatSynBind NoExtField psb -> p_patSynBind psb
73+ XHsBindsLR x -> noExtCon x
6774
68−p_funBind
69− :: Located RdrName
70− -> MatchGroup GhcPs (LHsExpr GhcPs)
71− -> R ()
75+p_funBind ::
76+ Located RdrName ->
77+ MatchGroup GhcPs (LHsExpr GhcPs) ->
78+ R ()
7279p_funBind name = p_matchGroup (Function name)
7380
74−p_matchGroup
75− :: MatchGroupStyle
76− -> MatchGroup GhcPs (LHsExpr GhcPs)
77− -> R ()
81+p_matchGroup ::
82+ MatchGroupStyle ->
83+ MatchGroup GhcPs (LHsExpr GhcPs) ->
84+ R ()
7885p_matchGroup = p_matchGroup' exprPlacement p_hsExpr
7986
80−p_matchGroup'
81− :: Data body
82− => (body -> Placement)
83− -> (body -> R ())
84− -> MatchGroupStyle
85− -> MatchGroup GhcPs (Located body)
86− -> R ()
87−p_matchGroup' placer pretty style MG {..} =
88− sep newline (located' p_Match) (unLoc mg_alts)
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
99+ let ob = case style of
100+ Case -> id
101+ LambdaCase -> id
102+ _ -> dontUseBraces
103+ -- Since we are forcing braces on 'sepSemi' based on 'ob', we have to
104+ -- restore the brace state inside the sepsemi.
105+ ub <- bool dontUseBraces useBraces <$> canUseBraces
106+ ob $ sepSemi (located' (ub . p_Match)) (unLoc mg_alts)
89107 where
90108 p_Match m@Match {..} =
91109 p_match'
92110 placer
93− pretty
111+ render
94112 (adjustMatchGroupStyle m style)
95113 (isInfixMatch m)
96114 (matchStrictness m)
97115 m_pats
98116 m_grhss
99− p_Match _ = notImplemented "XMatch"
100−p_matchGroup' _ _ _ (XMatchGroup NoExt) = notImplemented "XMatchGroup"
117+ p_Match (XMatch x) = noExtCon x
118+p_matchGroup' _ _ _ (XMatchGroup x) = noExtCon x
101119
102120-- | Function id obtained through pattern matching on 'FunBind' should not
103121-- be used to print the actual equations because the different ‘RdrNames’
@@ -105,11 +123,10 @@ p_matchGroup' _ _ _ (XMatchGroup NoExt) = notImplemented "XMatchGroup"
105123-- and paretheses) associated with them. It is necessary to use per-equation
106124-- names obtained from 'm_ctxt' of 'Match'. This function replaces function
107125-- name inside of 'Function' accordingly.
108−
109−adjustMatchGroupStyle
110− :: Match GhcPs body
111− -> MatchGroupStyle
112− -> MatchGroupStyle
126+adjustMatchGroupStyle ::
127+ Match GhcPs body ->
128+ MatchGroupStyle ->
129+ MatchGroupStyle
113130adjustMatchGroupStyle m = \case
114131 Function _ -> (Function . mc_fun . m_ctxt) m
115132 style -> style
@@ -117,31 +134,43 @@ adjustMatchGroupStyle m = \case
117134matchStrictness :: Match id body -> SrcStrictness
118135matchStrictness match =
119136 case m_ctxt match of
120− FunRhs{mc_strictness=s} -> s
137+ FunRhs {mc_strictness = s} -> s
121138 _ -> NoSrcStrict
122139
123−p_match
124− :: MatchGroupStyle
125− -> Bool -- ^ Is this an infix match?
126− -> SrcStrictness -- ^ Strictness prefix (FunBind)
127− -> [LPat GhcPs]
128− -> GRHSs GhcPs (LHsExpr GhcPs)
129− -> 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 ()
130152p_match = p_match' exprPlacement p_hsExpr
131153
132−p_match'
133− :: Data body
134− => (body -> Placement)
135− -> (body -> R ())
136− -> MatchGroupStyle
137− -> Bool -- ^ Is this an infix match?
138− -> SrcStrictness -- ^ Strictness prefix (FunBind)
139− -> [LPat GhcPs]
140− -> GRHSs GhcPs (Located body)
141− -> R ()
142−p_match' placer pretty style isInfix strictness m_pats m_grhss = do
143− -- NOTE Normally, since patterns may be placed in a multi-line layout, it
144− -- 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
145174 -- indented than function name. This in turn means that indentation for
146175 -- the body should also be bumped. Normally this would mean that bodies
147176 -- would start with two indentation steps applied, which is ugly, so we
@@ -151,23 +180,24 @@ p_match' placer pretty style isInfix strictness m_pats m_grhss = do
151180 NoSrcStrict -> return ()
152181 SrcStrict -> txt "!"
153182 SrcLazy -> txt "~"
154− inci' <- case NE.nonEmpty m_pats of
155− Nothing -> id <$ case style of
156− Function name -> p_rdrName name
157− _ -> return ()
183+ indentBody <- case NE.nonEmpty m_pats of
184+ Nothing ->
185+ False <$ case style of
186+ Function name -> p_rdrName name
187+ _ -> return ()
158188 Just ne_pats -> do
159− let combinedSpans = combineSrcSpans' $
160− getLoc <$> ne_pats
161− inci' = if isOneLineSpan combinedSpans
162− then id
163− 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)
164194 switchLayout [combinedSpans] $ do
165195 let stdCase = sep breakpoint (located' p_pat) m_pats
166196 case style of
167197 Function name ->
168198 p_infixDefHelper
169199 isInfix
170− inci'
200+ indentBody
171201 (p_rdrName name)
172202 (located' p_pat <$> m_pats)
173203 PatternBind -> stdCase
@@ -178,222 +208,256 @@ p_match' placer pretty style isInfix strictness m_pats m_grhss = do
178208 BangPat _ _ -> True
179209 SplicePat _ _ -> True
180210 _ -> False
181− txt (if needsSpace then "\\ " else "\\")
182− stdCase
211+ txt "\\"
212+ when needsSpace space
213+ sitcc stdCase
183214 LambdaCase -> stdCase
184− return inci'
185−
186− let
187− -- Calculate position of end of patterns. This is useful when we decide
188− -- about putting certain constructions in hanging positions.
189− endOfPats = case NE.nonEmpty m_pats of
190− Nothing -> case style of
191− Function name -> (Just . srcSpanEnd . getLoc) name
192− _ -> Nothing
193− Just pats -> (Just . srcSpanEnd . getLoc . NE.last) pats
194− isCase = \case
195− Case -> True
196− LambdaCase -> True
197− _ -> False
198− inci' $ do
199− let GRHSs {..} = m_grhss
200− hasGuards = withGuards grhssGRHSs
201− unless (length grhssGRHSs > 1) $ do
202− case style of
203− Function _ | hasGuards -> return ()
204− Function _ -> txt " ="
205− PatternBind -> txt " ="
206− s | isCase s && hasGuards -> return ()
207− _ -> txt " ->"
208− let grhssSpan = combineSrcSpans' $
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
227+ hasGuards = withGuards grhssGRHSs
228+ grhssSpan =
229+ combineSrcSpans' $
209230 getGRHSSpan . unLoc <$> NE.fromList grhssGRHSs
210− patGrhssSpan = maybe grhssSpan
211− (combineSrcSpans grhssSpan . srcLocSpan) endOfPats
212− placement =
213− case endOfPats of
214− Nothing -> blockPlacement placer grhssGRHSs
215− Just spn ->
216− if isOneLineSpan
217− (mkSrcSpan spn (srcSpanStart grhssSpan))
218− then blockPlacement placer grhssGRHSs
219− else Normal
220− inciLocalBinds = case placement of
221− Normal -> id
222− Hanging -> inci
223− p_body = do
224− let groupStyle =
225− if isCase style && hasGuards
231+ patGrhssSpan =
232+ maybe
233+ grhssSpan
234+ (combineSrcSpans grhssSpan . srcLocSpan . srcSpanEnd)
235+ endOfPats
236+ placement =
237+ case endOfPats of
238+ Nothing -> blockPlacement placer grhssGRHSs
239+ Just spn ->
240+ if onTheSameLine spn grhssSpan
241+ then blockPlacement placer grhssGRHSs
242+ else Normal
243+ p_body = do
244+ let groupStyle =
245+ if isCase style && hasGuards
226246 then RightArrow
227247 else EqualSign
228− sep newline (located' (p_grhs' pretty groupStyle)) grhssGRHSs
229− let whereLocation = combineSrcSpans patGrhssSpan $ getLoc grhssLocalBinds
230− whereIsEmpty = GHC.isEmptyLocalBindsPR (unLoc grhssLocalBinds)
231− unless (GHC.eqEmptyLocalBinds (unLoc grhssLocalBinds))
232− . inciLocalBinds
233− . switchLayout [whereLocation] $ do
234− if whereIsEmpty then newline else breakpoint
235− txt "where"
236− unless whereIsEmpty $ do
237− breakpoint
238− inci (located grhssLocalBinds p_hsLocalBinds)
248+ sep newline (located' (p_grhs' placer render groupStyle)) grhssGRHSs
249+ p_where = do
250+ let whereIsEmpty = GHC.isEmptyLocalBindsPR (unLoc grhssLocalBinds)
251+ unless (GHC.eqEmptyLocalBinds (unLoc grhssLocalBinds)) $ do
252+ breakpoint
253+ txt "where"
254+ unless whereIsEmpty breakpoint
255+ inci $ located grhssLocalBinds p_hsLocalBinds
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 "->"
239264 switchLayout [patGrhssSpan] $
240265 placeHanging placement p_body
266+ inci p_where
267+p_match' _ _ _ _ _ _ (XGRHSs x) = noExtCon x
241268
242269p_grhs :: GroupStyle -> GRHS GhcPs (LHsExpr GhcPs) -> R ()
243−p_grhs = p_grhs' p_hsExpr
244−
245−p_grhs'
246− :: Data body
247− => (body -> R ())
248− -> GroupStyle
249− -> GRHS GhcPs (Located body)
250− -> R ()
251−p_grhs' pretty style (GRHS NoExt guards body) =
270+p_grhs = p_grhs' exprPlacement p_hsExpr
271+
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) =
252282 case guards of
253283 [] -> p_body
254284 xs -> do
255− txt "| "
256− sitcc (sep (comma >> breakpoint) (sitcc . located' p_stmt) xs)
285+ txt "|"
257286 space
258− txt $ case style of
259− EqualSign -> "="
260− RightArrow -> "->"
261− breakpoint
262− inci p_body
287+ sitcc (sep commaDel (sitcc . located' p_stmt) xs)
288+ space
289+ inci $ case style of
290+ EqualSign -> equals
291+ RightArrow -> txt "->"
292+ placeHanging placement p_body
263293 where
264− p_body = located body pretty
265−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
266307
267308p_hsCmd :: HsCmd GhcPs -> R ()
268309p_hsCmd = \case
269− HsCmdArrApp NoExt body input arrType _ -> do
310+ HsCmdArrApp NoExtField body input arrType _ -> do
270311 located body p_hsExpr
271− txt $ case arrType of
272− HsFirstOrderApp -> " -<"
273− HsHigherOrderApp -> " -<<"
274− placeHanging (exprPlacement (unLoc input)) $
275− located input p_hsExpr
276− 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
277320 located form p_hsExpr
278321 unless (null cmds) $ do
279322 breakpoint
280323 inci (sequence_ (intersperse breakpoint (located' p_hsCmdTop <$> cmds)))
281− HsCmdArrForm NoExt form Infix _ [left, right] -> do
324+ HsCmdArrForm NoExtField form Infix _ [left, right] -> do
282325 located left p_hsCmdTop
283326 space
284327 located form p_hsExpr
285328 placeHanging (cmdTopPlacement (unLoc right)) $
286329 located right p_hsCmdTop
287− HsCmdArrForm NoExt _ Infix _ _ -> notImplemented "HsCmdArrForm"
330+ HsCmdArrForm NoExtField _ Infix _ _ -> notImplemented "HsCmdArrForm"
288331 HsCmdApp {} ->
289332 -- XXX Does this ever occur in the syntax tree? It does not seem like it
290333 -- does. Open an issue and ping @yumiova if this ever occurs in output.
291334 notImplemented "HsCmdApp"
292− HsCmdLam NoExt mgroup -> p_matchGroup' cmdPlacement p_hsCmd Lambda mgroup
293− HsCmdPar NoExt c -> parens (located c p_hsCmd)
294− HsCmdCase NoExt e mgroup -> do
295− txt "case "
296− located e p_hsExpr
297− txt " of"
298− breakpoint
299− inci (p_matchGroup' cmdPlacement p_hsCmd Case mgroup)
300− HsCmdIf NoExt _ if' then' else' -> do
301− txt "if "
302− located if' p_hsExpr
303− breakpoint
304− txt "then"
305− located then' $ \x -> do
306− breakpoint
307− inci (p_hsCmd x)
308− breakpoint
309− txt "else"
310− located else' $ \x -> do
311− breakpoint
312− inci (p_hsCmd x)
313− HsCmdLet NoExt localBinds c -> do
314− txt "let "
315− sitcc (located localBinds p_hsLocalBinds)
316− breakpoint
317− txt "in "
318− sitcc (located c p_hsCmd)
319− 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
320344 txt "do"
321345 newline
322− 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))
323348 HsCmdWrap {} -> notImplemented "HsCmdWrap"
324− XCmd {} -> notImplemented "XCmd"
349+ XCmd x -> noExtCon x
325350
326351p_hsCmdTop :: HsCmdTop GhcPs -> R ()
327352p_hsCmdTop = \case
328− HsCmdTop NoExt cmd -> located cmd p_hsCmd
329− 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)
330384
331385p_stmt :: Stmt GhcPs (LHsExpr GhcPs) -> R ()
332−p_stmt = p_stmt' p_hsExpr
333−
334−p_stmt'
335− :: Data body
336− => (body -> R ())
337− -> Stmt GhcPs (Located body)
338− -> R ()
339−p_stmt' pretty = \case
340− LastStmt NoExt body _ _ -> located body pretty
341− BindStmt NoExt l f _ _ -> do
342− located l p_pat
386+p_stmt = p_stmt' exprPlacement p_hsExpr
387+
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
343401 space
344402 txt "<-"
345− breakpoint
346− 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)
347413 ApplicativeStmt {} -> notImplemented "ApplicativeStmt" -- generated by renamer
348− BodyStmt NoExt body _ _ -> located body pretty
349− LetStmt NoExt binds -> do
350− txt "let "
414+ BodyStmt NoExtField body _ _ -> located body render
415+ LetStmt NoExtField binds -> do
416+ txt "let"
417+ space
351418 sitcc $ located binds p_hsLocalBinds
352419 ParStmt {} ->
353− -- NOTE 'ParStmt' should always be eliminated in 'gatherStmt' already,
354− -- such that it never occurs in 'p_stmt''. Consequently, handling it
355− -- 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.
356423 notImplemented "ParStmt"
357− TransStmt {..} -> do
358− -- NOTE 'TransStmt' only needs to account for pretty printing itself,
359− -- since pretty printing of relevant statements (e.g., in 'trS_stmts')
360− -- 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'.
361428 case (trS_form, trS_by) of
362− (ThenForm, Nothing) -> located trS_using $ \x -> do
429+ (ThenForm, Nothing) -> do
363430 txt "then"
364431 breakpoint
365− inci (p_hsExpr x)
432+ inci $ located trS_using p_hsExpr
366433 (ThenForm, Just e) -> do
367− located trS_using $ \x -> do
368− txt "then"
369− breakpoint
370− inci (p_hsExpr x)
434+ txt "then"
371435 breakpoint
372− located e $ \x -> do
373− txt "by"
374− breakpoint
375− inci (p_hsExpr x)
376− (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
377442 txt "then group using"
378443 breakpoint
379− inci (p_hsExpr x)
444+ inci $ located trS_using p_hsExpr
380445 (GroupForm, Just e) -> do
381− located e $ \x -> do
382− txt "then group by"
383− breakpoint
384− inci (p_hsExpr x)
446+ txt "then group by"
385447 breakpoint
386− located trS_using $ \x -> do
387− txt "using"
388− breakpoint
389− inci (p_hsExpr x)
448+ inci $ located e p_hsExpr
449+ breakpoint
450+ txt "using"
451+ breakpoint
452+ inci $ located trS_using p_hsExpr
390453 RecStmt {..} -> do
391− txt "rec "
392− sitcc $ sep newline (located' (p_stmt' pretty)) recS_stmts
393− XStmtLR {} -> notImplemented "XStmtLR"
454+ txt "rec"
455+ space
456+ sitcc $ sepSemi (withSpacing (p_stmt' placer render)) recS_stmts
457+ XStmtLR c -> noExtCon c
394458
395459gatherStmt :: ExprLStmt GhcPs -> [[ExprLStmt GhcPs]]
396−gatherStmt (L _ (ParStmt NoExt block _ _)) =
460+gatherStmt (L _ (ParStmt NoExtField block _ _)) =
397461 foldr ((<>) . gatherStmtBlock) [] block
398462gatherStmt (L s stmt@TransStmt {..}) =
399463 foldr liftAppend [] ((gatherStmt <$> trS_stmts) <> pure [[L s stmt]])
@@ -402,239 +466,337 @@ gatherStmt stmt = [[stmt]]
402466gatherStmtBlock :: ParStmtBlock GhcPs GhcPs -> [[ExprLStmt GhcPs]]
403467gatherStmtBlock (ParStmtBlock _ stmts _ _) =
404468 foldr (liftAppend . gatherStmt) [] stmts
405−gatherStmtBlock XParStmtBlock {} = notImplemented "XParStmtBlock"
469+gatherStmtBlock (XParStmtBlock x) = noExtCon x
406470
407471p_hsLocalBinds :: HsLocalBindsLR GhcPs GhcPs -> R ()
408472p_hsLocalBinds = \case
409− HsValBinds NoExt (ValBinds NoExt bag lsigs) -> do
410− let ssStart = either
411− (srcSpanStart . getLoc)
412− (srcSpanStart . getLoc)
413− items =
414− (Left <$> bagToList bag) ++ (Right <$> lsigs)
415− p_item (Left x) = located x p_valDecl'
416− p_item (Right x) = located x p_sigDecl'
417− sitcc $ sep newline (sitcc . p_item) (sortOn ssStart items)
418− HsValBinds NoExt _ -> notImplemented "HsValBinds"
419− HsIPBinds NoExt _ -> notImplemented "HsIPBinds"
420− EmptyLocalBinds NoExt -> return ()
421− XHsLocalBindsLR _ -> notImplemented "XHsLocalBindsLR"
422−
423−p_hsRecField
424− :: (Data id, Outputable id)
425− => HsRecField' id (LHsExpr GhcPs)
426− -> R ()
427−p_hsRecField = \HsRecField {..} -> do
428− located hsRecFieldLbl atom
429− unless hsRecPun $ do
430− txt " = "
431− located hsRecFieldArg p_hsExpr
473+ HsValBinds NoExtField (ValBinds NoExtField bag lsigs) -> do
474+ -- When in a single-line layout, there is a chance that the inner
475+ -- elements will also contain semicolons and they will confuse the
476+ -- parser. so we request braces around every element except the last.
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) ->
494+ -- Second argument of IPBind is always Left before type-checking.
495+ let p_ipBind (IPBind NoExtField (Left name) expr) = do
496+ atom name
497+ space
498+ equals
499+ breakpoint
500+ useBraces $ inci $ located expr p_hsExpr
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
505+ in sepSemi (located' p_ipBind) xs
506+ HsIPBinds NoExtField _ -> notImplemented "HsIpBinds"
507+ EmptyLocalBinds NoExtField -> return ()
508+ XHsLocalBindsLR x -> noExtCon x
432509
433−p_hsTupArg :: HsTupArg GhcPs -> R ()
434−p_hsTupArg = \case
435− Present NoExt x -> located x p_hsExpr
436− Missing NoExt -> pure ()
437− XTupArg {} -> notImplemented "XTupArg"
510+p_hsRecField ::
511+ HsRecField' RdrName (LHsExpr GhcPs) ->
512+ R ()
513+p_hsRecField HsRecField {..} = do
514+ p_rdrName hsRecFieldLbl
515+ unless hsRecPun $ do
516+ space
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)
438523
439524p_hsExpr :: HsExpr GhcPs -> R ()
440−p_hsExpr = \case
441− HsVar NoExt name -> p_rdrName name
442− HsUnboundVar NoExt _ -> notImplemented "HsUnboundVar"
443− HsConLikeOut NoExt _ -> notImplemented "HsConLikeOut"
444− 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 ->
445533 case x of
446− Unambiguous NoExt name -> p_rdrName name
447− Ambiguous NoExt name -> p_rdrName name
448− XAmbiguousFieldOcc NoExt -> notImplemented "XAmbiguousFieldOcc"
449− 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
450538 txt "#"
451539 atom v
452− HsIPVar NoExt (HsIPName name) -> do
540+ HsIPVar NoExtField (HsIPName name) -> do
453541 txt "?"
454542 atom name
455− HsOverLit NoExt v -> atom (ol_val v)
456− HsLit NoExt lit -> atom lit
457− 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 ->
458550 p_matchGroup Lambda mgroup
459− HsLamCase NoExt mgroup -> do
551+ HsLamCase NoExtField mgroup -> do
460552 txt "\\case"
461− newline
462− inci (p_matchGroup LambdaCase mgroup)
463− HsApp NoExt f x -> sitcc $ do
464− located f p_hsExpr
465553 breakpoint
466− inci (located x p_hsExpr)
467− HsAppType a e -> do
554+ inci (p_matchGroup LambdaCase mgroup)
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
468612 located e p_hsExpr
469613 breakpoint
470614 inci $ do
471615 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 ()
472621 located (hswc_body a) p_hsType
473− OpApp NoExt x op y -> do
474− located x p_hsExpr
622+ OpApp NoExtField x op y -> do
623+ let opTree = OpBranch (exprOpTree x) op (exprOpTree y)
624+ p_exprOpTree s (reassociateOpTree getOpName opTree)
625+ NegApp NoExtField e _ -> do
626+ txt "-"
475627 space
476− let opWrapper = case unLoc op of
477− EWildPat NoExt -> backticks
478− _ -> id
479− -- NOTE Sometimes operator may be displaced from the line by comments,
480− -- it still should be more indented to remain valid code.
481− inci $ located op (opWrapper . p_hsExpr)
482− let placement =
483− -- NOTE If end of operator and start of second argument are on
484− -- different lines, always use normal placement.
485− if isOneLineSpan
486− (mkSrcSpan (srcSpanEnd (getLoc op)) (srcSpanStart (getLoc y)))
487− then exprPlacement (unLoc y)
488− else Normal
489− placeHanging placement $
490− located y p_hsExpr
491− NegApp NoExt e _ -> do
492− txt "- "
493628 located e p_hsExpr
494− HsPar NoExt e -> parens (located e p_hsExpr)
495− SectionL NoExt x op -> do
629+ HsPar NoExtField e ->
630+ parens s (located e (dontUseBraces . p_hsExpr))
631+ SectionL NoExtField x op -> do
496632 located x p_hsExpr
497633 breakpoint
498634 inci (located op p_hsExpr)
499− SectionR NoExt op x -> do
635+ SectionR NoExtField op x -> do
500636 located op p_hsExpr
501− breakpoint
637+ useRecordDot' <- useRecordDot
638+ let isRecordDot' = isRecordDot (unLoc op) (getLoc x)
639+ unless (useRecordDot' && isRecordDot') breakpoint
502640 inci (located x p_hsExpr)
503− ExplicitTuple NoExt args boxity -> do
641+ ExplicitTuple NoExtField args boxity ->
504642 let isSection = any (isMissing . unLoc) args
505643 isMissing = \case
506− Missing NoExt -> True
644+ Missing NoExtField -> True
507645 _ -> False
508− 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' =
509652 case boxity of
510653 Boxed -> parens
511654 Unboxed -> parensHash
512− if isSection
513− then switchLayout [] . parens' $
514− sep comma (located' p_hsTupArg) args
515− else switchLayout (getLoc <$> args) . parens' . sitcc $
516− sep (comma >> breakpoint) (sitcc . located' p_hsTupArg) args
517− ExplicitSum NoExt tag arity e ->
518− p_unboxedSum tag arity (located e p_hsExpr)
519− HsCase NoExt e mgroup -> do
520− txt "case "
521− located e p_hsExpr
522− txt " of"
523− breakpoint
524− inci (p_matchGroup Case mgroup)
525− HsIf NoExt _ if' then' else' -> do
526− txt "if "
527− located if' p_hsExpr
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
669+ txt "if"
528670 breakpoint
529− txt "then"
530− located then' $ \x -> do
531− breakpoint
532− inci (p_hsExpr x)
533− breakpoint
534− txt "else"
535− located else' $ \x -> do
536− breakpoint
537− inci (p_hsExpr x)
538− HsMultiIf NoExt guards -> do
539− txt "if "
540− sitcc $ sep newline (located' (p_grhs RightArrow)) guards
541− HsLet NoExt localBinds e -> do
542− txt "let "
543− sitcc (located localBinds p_hsLocalBinds)
544− vlayout space (newline >> space)
545− txt "in "
546− sitcc (located e p_hsExpr)
547− 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
548675 let doBody header = do
549676 txt header
550− newline
551− inci $ located es (sep newline (located' (sitcc . p_stmt)))
552− compBody = brackets $ located es $ \xs -> do
553− let p_parBody = sitcc . sep
554− (breakpoint >> txt "| ")
555− p_seqBody
556− p_seqBody = sitcc . sep
557− (comma >> breakpoint)
558− (located' (sitcc . p_stmt))
677+ breakpoint
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))
559693 stmts = init xs
560694 yield = last xs
561695 lists = foldr (liftAppend . gatherStmt) [] stmts
562696 located yield p_stmt
563697 breakpoint
564− txt "| "
698+ txt "|"
699+ space
565700 p_parBody lists
566701 case ctx of
567702 DoExpr -> doBody "do"
568703 MDoExpr -> doBody "mdo"
569704 ListComp -> compBody
570705 MonadComp -> notImplemented "MonadComp"
571− ArrowExpr -> notImplemented "ArrowExpr"
706+ ArrowExpr -> notImplemented "ArrowExpr"
572707 GhciStmtCtxt -> notImplemented "GhciStmtCtxt"
573708 PatGuard _ -> notImplemented "PatGuard"
574709 ParStmtCtxt _ -> notImplemented "ParStmtCtxt"
575710 TransStmtCtxt _ -> notImplemented "TransStmtCtxt"
576711 ExplicitList _ _ xs ->
577− brackets . sitcc $ sep (comma >> breakpoint) (sitcc . located' p_hsExpr) xs
712+ brackets s $
713+ sep commaDel (sitcc . located' p_hsExpr) xs
578714 RecordCon {..} -> do
579715 located rcon_con_name atom
580716 breakpoint
581717 let HsRecFields {..} = rcon_flds
582− 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
583725 dotdot =
584726 case rec_dotdot of
585727 Just {} -> [txt ".."]
586728 Nothing -> []
587− inci . braces . sitcc $ sep (comma >> breakpoint) sitcc (fields <> dotdot)
729+ inci . braces N $
730+ sep commaDel sitcc (fields <> dotdot)
588731 RecordUpd {..} -> do
589732 located rupd_expr p_hsExpr
590− breakpoint
591− inci . braces . sitcc $
592− sep (comma >> breakpoint) (sitcc . located' p_hsRecField) rupd_flds
593− 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
594754 located x p_hsExpr
755+ space
756+ txt "::"
595757 breakpoint
596− inci $ do
597− txt ":: "
598− let HsWC {..} = affix
599− HsIB {..} = hswc_body
600− located hsib_body p_hsType
601− 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 ->
602762 case x of
603− From from -> brackets . sitcc $ do
763+ From from -> brackets s $ do
604764 located from p_hsExpr
605765 breakpoint
606766 txt ".."
607− FromThen from next -> brackets . sitcc $ do
608− sitcc $ sep (comma >> breakpoint) (located' p_hsExpr) [from, next]
767+ FromThen from next -> brackets s $ do
768+ sep commaDel (located' p_hsExpr) [from, next]
609769 breakpoint
610770 txt ".."
611− FromTo from to -> brackets . sitcc $ do
771+ FromTo from to -> brackets s $ do
612772 located from p_hsExpr
613773 breakpoint
614− txt ".. "
774+ txt ".."
775+ space
615776 located to p_hsExpr
616− FromThenTo from next to -> brackets . sitcc $ do
617− 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]
618779 breakpoint
619− txt ".. "
780+ txt ".."
781+ space
620782 located to p_hsExpr
621− HsSCC NoExt _ name x -> do
783+ HsSCC NoExtField _ name x -> do
622784 txt "{-# SCC "
623785 atom name
624786 txt " #-}"
625787 breakpoint
626788 located x p_hsExpr
627− HsCoreAnn NoExt _ value x -> do
789+ HsCoreAnn NoExtField _ value x -> do
628790 txt "{-# CORE "
629791 atom value
630792 txt " #-}"
631793 breakpoint
632794 located x p_hsExpr
633− HsBracket NoExt x -> p_hsBracket x
795+ HsBracket NoExtField x -> p_hsBracket x
634796 HsRnBracketOut {} -> notImplemented "HsRnBracketOut"
635797 HsTcBracketOut {} -> notImplemented "HsTcBracketOut"
636− HsSpliceE NoExt splice -> p_hsSplice splice
637− HsProc NoExt p e -> do
798+ HsSpliceE NoExtField splice -> p_hsSplice splice
799+ HsProc NoExtField p e -> do
638800 txt "proc"
639801 located p $ \x -> do
640802 breakpoint
@@ -643,92 +805,159 @@ p_hsExpr = \case
643805 txt "->"
644806 placeHanging (cmdTopPlacement (unLoc e)) $
645807 located e p_hsCmdTop
646− HsStatic _ e -> do
808+ HsStatic _ e -> do
647809 txt "static"
648810 breakpoint
649811 inci (located e p_hsExpr)
650− HsArrApp NoExt body input arrType cond ->
651− p_hsCmd (HsCmdArrApp NoExt body input arrType cond)
652− HsArrForm NoExt form mfixity cmds ->
653− p_hsCmd (HsCmdArrForm NoExt form Prefix mfixity cmds)
654812 HsTick {} -> notImplemented "HsTick"
655813 HsBinTick {} -> notImplemented "HsBinTick"
656814 HsTickPragma {} -> notImplemented "HsTickPragma"
657− EWildPat NoExt -> txt "_"
658− EAsPat {} -> notImplemented "EAsPat"
659− EViewPat {} -> notImplemented "EViewPat"
660− ELazyPat {} -> notImplemented "ELazyPat"
661815 HsWrap {} -> notImplemented "HsWrap"
662− XExpr {} -> notImplemented "XExpr"
816+ XExpr x -> noExtCon x
663817
664818p_patSynBind :: PatSynBind GhcPs GhcPs -> R ()
665819p_patSynBind PSB {..} = do
666− txt "pattern "
667− case psb_dir of
668− Unidirectional -> do
669− p_rdrName psb_id
670− inci $ do
671− p_patSynDetails psb_args
672− txt " <-"
673− breakpoint
674− located psb_def p_pat
675− ImplicitBidirectional -> do
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)
839+ txt "pattern"
840+ case psb_args of
841+ PrefixCon xs -> do
842+ space
676843 p_rdrName psb_id
677844 inci $ do
678− p_patSynDetails psb_args
679− txt " ="
680− breakpoint
681− located psb_def p_pat
682− ExplicitBidirectional mgroup -> do
845+ switchLayout (getLoc <$> xs) $ do
846+ unless (null xs) breakpoint
847+ sitcc (sep breakpoint p_rdrName xs)
848+ rhs
849+ RecCon xs -> do
850+ space
683851 p_rdrName psb_id
684852 inci $ do
685− p_patSynDetails psb_args
686− txt " <-"
853+ switchLayout (getLoc . recordPatSynPatVar <$> xs) $ do
854+ unless (null xs) breakpoint
855+ braces N $
856+ sep commaDel (p_rdrName . recordPatSynPatVar) xs
857+ rhs
858+ InfixCon l r -> do
859+ switchLayout [getLoc l, getLoc r] $ do
860+ space
861+ p_rdrName l
687862 breakpoint
688− located psb_def p_pat
689− newline
690− line (txt "where")
691− inci (p_matchGroup (Function psb_id) mgroup)
692−p_patSynBind (XPatSynBind NoExt) = notImplemented "XPatSynBind"
693−
694−p_patSynDetails :: HsPatSynDetails (Located RdrName) -> R ()
695−p_patSynDetails = \case
696− PrefixCon xs ->
697− switchLayout (getLoc <$> xs) $ do
698− unless (null xs) breakpoint
699− sitcc (sep breakpoint p_rdrName xs)
700− RecCon xs ->
701− switchLayout (getLoc . recordPatSynPatVar <$> xs) $ do
702− unless (null xs) breakpoint
703− braces . sitcc $ sep (comma >> breakpoint) (p_rdrName . recordPatSynPatVar) xs
704− InfixCon _ _ -> notImplemented "InfixCon"
863+ inci $ do
864+ p_rdrName psb_id
865+ space
866+ p_rdrName r
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)
705934
706935p_pat :: Pat GhcPs -> R ()
707936p_pat = \case
708− WildPat NoExt -> txt "_"
709− VarPat NoExt name -> p_rdrName name
710− LazyPat NoExt pat -> do
937+ WildPat NoExtField -> txt "_"
938+ VarPat NoExtField name -> p_rdrName name
939+ LazyPat NoExtField pat -> do
711940 txt "~"
712941 located pat p_pat
713− AsPat NoExt name pat -> do
942+ AsPat NoExtField name pat -> do
714943 p_rdrName name
715944 txt "@"
716945 located pat p_pat
717− ParPat NoExt pat ->
718− located pat (parens . p_pat)
719− BangPat NoExt pat -> do
946+ ParPat NoExtField pat ->
947+ located pat (parens S . p_pat)
948+ BangPat NoExtField pat -> do
720949 txt "!"
721950 located pat p_pat
722− ListPat NoExt pats -> do
723− brackets . sitcc $ sep (comma >> breakpoint) (located' p_pat) pats
724− TuplePat NoExt pats boxing -> do
725− let f =
951+ ListPat NoExtField pats ->
952+ brackets S $ sep commaDel (located' p_pat) pats
953+ TuplePat NoExtField pats boxing -> do
954+ let parens' =
726955 case boxing of
727− Boxed -> parens
728− Unboxed -> parensHash
729− f . sitcc $ sep (comma >> breakpoint) (sitcc . located' p_pat) pats
730− SumPat NoExt pat tag arity ->
731− 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)
732961 ConPatIn pat details ->
733962 case details of
734963 PrefixCon xs -> sitcc $ do
@@ -742,102 +971,115 @@ p_pat = \case
742971 let f = \case
743972 Nothing -> txt ".."
744973 Just x -> located x p_pat_hsRecField
745− inci . braces . sitcc . sep (comma >> breakpoint) f $ case dotdot of
746− Nothing -> Just <$> fields
747− Just n -> (Just <$> take n fields) ++ [Nothing]
748− InfixCon x y -> do
749− located x p_pat
750− space
751− p_rdrName pat
752− breakpoint
753− 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
754986 ConPatOut {} -> notImplemented "ConPatOut" -- presumably created by renamer?
755− ViewPat NoExt expr pat -> sitcc $ do
987+ ViewPat NoExtField expr pat -> sitcc $ do
756988 located expr p_hsExpr
757− txt " ->"
989+ space
990+ txt "->"
758991 breakpoint
759992 inci (located pat p_pat)
760− SplicePat NoExt splice -> p_hsSplice splice
761− LitPat NoExt p -> atom p
762− NPat NoExt v _ _ -> located v (atom . ol_val)
763− 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
764997 p_rdrName n
765998 breakpoint
766999 inci $ do
767− txt "+ "
1000+ txt "+"
1001+ space
7681002 located k (atom . ol_val)
769− SigPat hswc pat -> do
1003+ SigPat NoExtField pat hswc -> do
7701004 located pat p_pat
7711005 p_typeAscription hswc
7721006 CoPat {} -> notImplemented "CoPat" -- apparently created at some later stage
773− XPat NoExt -> notImplemented "XPat"
1007+ XPat x -> noExtCon x
7741008
7751009p_pat_hsRecField :: HsRecField' (FieldOcc GhcPs) (LPat GhcPs) -> R ()
7761010p_pat_hsRecField HsRecField {..} = do
7771011 located hsRecFieldLbl $ \x ->
7781012 p_rdrName (rdrNameFieldOcc x)
7791013 unless hsRecPun $ do
780− txt " ="
1014+ space
1015+ equals
7811016 breakpoint
7821017 inci (located hsRecFieldArg p_pat)
7831018
784−p_unboxedSum :: ConTag -> Arity -> R () -> R ()
785−p_unboxedSum tag arity m = do
1019+p_unboxedSum :: BracketStyle -> ConTag -> Arity -> R () -> R ()
1020+p_unboxedSum s tag arity m = do
7861021 let before = tag - 1
7871022 after = arity - before - 1
7881023 args = replicate before Nothing <> [Just m] <> replicate after Nothing
789− f (x,i) = do
790− let isFirst = i == 0
791− isLast = i == arity - 1
1024+ f x =
7921025 case x :: Maybe (R ()) of
7931026 Nothing ->
794− unless (isFirst || isLast) space
1027+ space
7951028 Just m' -> do
796− unless isFirst space
1029+ space
7971030 m'
798− unless isLast space
799− parensHash $ sep (txt "|") f (zip args [0..])
1031+ space
1032+ parensHash s $ sep (txt "|") f args
8001033
8011034p_hsSplice :: HsSplice GhcPs -> R ()
8021035p_hsSplice = \case
803− HsTypedSplice NoExt deco _ expr -> p_hsSpliceTH True expr deco
804− HsUntypedSplice NoExt deco _ expr -> p_hsSpliceTH False expr deco
805− 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
8061039 txt "["
8071040 p_rdrName (L srcSpan quoterName)
8081041 txt "|"
809− -- NOTE QuasiQuoters often rely on precise custom strings. We cannot do
810− -- 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.
8111044 atom str
8121045 txt "|]"
8131046 HsSpliced {} -> notImplemented "HsSpliced"
814− XSplice {} -> notImplemented "XSplice"
1047+ HsSplicedT {} -> notImplemented "HsSplicedT"
1048+ XSplice x -> noExtCon x
8151049
816−p_hsSpliceTH
817− :: Bool -- ^ Typed splice?
818− -> LHsExpr GhcPs -- ^ Splice expression
819− -> SpliceDecoration -- ^ Splice decoration
820− -> R ()
1050+p_hsSpliceTH ::
1051+ -- | Typed splice?
1052+ Bool ->
1053+ -- | Splice expression
1054+ LHsExpr GhcPs ->
1055+ -- | Splice decoration
1056+ SpliceDecoration ->
1057+ R ()
8211058p_hsSpliceTH isTyped expr = \case
8221059 HasParens -> do
8231060 txt decoSymbol
824− parens (located expr (sitcc . p_hsExpr))
1061+ parens N (located expr (sitcc . p_hsExpr))
8251062 HasDollar -> do
8261063 txt decoSymbol
8271064 located expr (sitcc . p_hsExpr)
828− NoParens -> do
1065+ NoParens ->
8291066 located expr (sitcc . p_hsExpr)
8301067 where
8311068 decoSymbol = if isTyped then "$$" else "$"
8321069
8331070p_hsBracket :: HsBracket GhcPs -> R ()
8341071p_hsBracket = \case
835− ExpBr NoExt expr -> quote "e" (located expr p_hsExpr)
836− PatBr NoExt pat -> quote "p" (located pat p_pat)
837− DecBrL NoExt decls -> quote "d" (p_hsDecls Free decls)
838− DecBrG NoExt _ -> notImplemented "DecBrG" -- result of renamer
839− TypBr NoExt ty -> quote "t" (located ty p_hsType)
840− VarBr NoExt isSingleQuote name -> do
1072+ ExpBr NoExtField expr -> do
1073+ anns <- getEnclosingAnns
1074+ let name = case anns of
1075+ AnnOpenEQ : _ -> ""
1076+ _ -> "e"
1077+ quote name (located expr p_hsExpr)
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
8411083 txt (bool "''" "'" isSingleQuote)
8421084 -- HACK As you can see we use 'noLoc' here to be able to pass name into
8431085 -- 'p_rdrName' since the latter expects a "located" thing. The problem
@@ -845,17 +1087,20 @@ p_hsBracket = \case
8451087 -- turn makes it impossible to detect if there are parentheses around
8461088 -- it, etc. So we have to add parentheses manually assuming they are
8471089 -- necessary for all operators.
848− let isOperator = any isPunctuation (showOutputable (rdrNameOcc name))
849− && not (doesNotNeedExtraParens name)
850− 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
8511096 wrapper $ p_rdrName (noLoc name)
852− TExpBr NoExt expr -> do
1097+ TExpBr NoExtField expr -> do
8531098 txt "[||"
8541099 breakpoint'
8551100 located expr p_hsExpr
8561101 breakpoint'
8571102 txt "||]"
858− XBracket {} -> notImplemented "XBracket"
1103+ XBracket x -> noExtCon x
8591104 where
8601105 quote :: Text -> R () -> R ()
8611106 quote name body = do
@@ -863,16 +1108,70 @@ p_hsBracket = \case
8631108 txt name
8641109 txt "|"
8651110 breakpoint'
866− body
867− breakpoint'
868− txt "|]"
1111+ inci $ do
1112+ dontUseBraces body
1113+ breakpoint'
1114+ txt "|]"
1115+
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
8691162
8701163----------------------------------------------------------------------------
8711164-- Helpers
8721165
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+
8731173-- | Append each element in both lists with semigroups. If one list is shorter
8741174-- than the other, return the rest of the longer list unchanged.
875−
8761175liftAppend :: Semigroup a => [a] -> [a] -> [a]
8771176liftAppend [] [] = []
8781177liftAppend [] (y : ys) = y : ys
@@ -880,15 +1179,15 @@ liftAppend (x : xs) [] = x : xs
8801179liftAppend (x : xs) (y : ys) = x <> y : liftAppend xs ys
8811180
8821181getGRHSSpan :: GRHS GhcPs (Located body) -> SrcSpan
883−getGRHSSpan (GRHS NoExt _ body) = getLoc body
884−getGRHSSpan (XGRHS NoExt) = notImplemented "XGRHS"
1182+getGRHSSpan (GRHS NoExtField guards body) =
1183+ combineSrcSpans' $ getLoc body :| map getLoc guards
1184+getGRHSSpan (XGRHS x) = noExtCon x
8851185
8861186-- | Place a thing that may have a hanging form. This function handles how
8871187-- to separate it from preceding expressions and whether to bump indentation
8881188-- depending on what sort of expression we have.
889−
8901189placeHanging :: Placement -> R () -> R ()
891−placeHanging placement m = do
1190+placeHanging placement m =
8921191 case placement of
8931192 Hanging -> do
8941193 space
@@ -899,49 +1198,165 @@ placeHanging placement m = do
8991198
9001199-- | Check if given block contains single expression which has a hanging
9011200-- form.
902−
903−blockPlacement
904− :: (body -> Placement)
905− -> [LGRHS GhcPs (Located body)]
906− -> Placement
907−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
9081206blockPlacement _ _ = Normal
9091207
9101208-- | Check if given command has a hanging form.
911−
9121209cmdPlacement :: HsCmd GhcPs -> Placement
9131210cmdPlacement = \case
914− HsCmdLam NoExt _ -> Hanging
915− HsCmdCase NoExt _ _ -> Hanging
916− HsCmdDo NoExt _ -> Hanging
1211+ HsCmdLam NoExtField _ -> Hanging
1212+ HsCmdCase NoExtField _ _ -> Hanging
1213+ HsCmdDo NoExtField _ -> Hanging
9171214 _ -> Normal
9181215
9191216cmdTopPlacement :: HsCmdTop GhcPs -> Placement
9201217cmdTopPlacement = \case
921− HsCmdTop NoExt (L _ x) -> cmdPlacement x
922− XCmdTop {} -> notImplemented "XCmdTop"
1218+ HsCmdTop NoExtField (L _ x) -> cmdPlacement x
1219+ XCmdTop x -> noExtCon x
9231220
9241221-- | Check if given expression has a hanging form.
925−
9261222exprPlacement :: HsExpr GhcPs -> Placement
9271223exprPlacement = \case
928− HsLam NoExt _ -> Hanging
929− HsLamCase NoExt _ -> Hanging
930− HsCase NoExt _ _ -> Hanging
931− HsDo NoExt DoExpr _ -> Hanging
932− HsDo NoExt MDoExpr _ -> Hanging
933− RecordCon NoExt _ _ -> Hanging
934− HsProc NoExt (L s _) _ ->
935− -- Indentation breaks if pattern is longer than one line and left hanging.
936− -- Consequently, only apply hanging when it is safe.
937− if isOneLineSpan s
938− then Hanging
939− else Normal
1224+ -- Only hang lambdas with single line parameter lists
1225+ HsLam NoExtField mg -> case mg of
1226+ MG _ (L _ [L _ (Match NoExtField _ (x : xs) _)]) _
1227+ | isOneLineSpan (combineSrcSpans' $ fmap getLoc (x :| xs)) ->
1228+ Hanging
1229+ _ -> Normal
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 _ ->
1240+ -- Indentation breaks if pattern is longer than one line and left
1241+ -- hanging. Consequently, only apply hanging when it is safe.
1242+ if isOneLineSpan (getLoc p)
1243+ then Hanging
1244+ else Normal
9401245 _ -> Normal
9411246
9421247withGuards :: [LGRHS GhcPs (Located body)] -> Bool
9431248withGuards = any (checkOne . unLoc)
9441249 where
9451250 checkOne :: GRHS GhcPs (Located body) -> Bool
946− checkOne (GRHS NoExt [] _) = False
1251+ checkOne (GRHS NoExtField [] _) = False
9471252 checkOne _ = True
1253+
1254+exprOpTree :: LHsExpr GhcPs -> OpTree (LHsExpr GhcPs) (LHsExpr GhcPs)
1255+exprOpTree (L _ (OpApp NoExtField x op y)) = OpBranch (exprOpTree x) op (exprOpTree y)
1256+exprOpTree n = OpNode n
1257+
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.
1276+ let placement =
1277+ if isOneLineSpan
1278+ (mkSrcSpan (srcSpanStart (opTreeLoc x)) (srcSpanStart (opTreeLoc y)))
1279+ then case y of
1280+ OpNode (L _ n) -> exprPlacement n
1281+ _ -> Normal
1282+ else Normal
1283+ -- Distinguish holes used in infix notation.
1284+ -- eg. '1 _foo 2' and '1 `_foo` 2'
1285+ opWrapper = case unLoc op of
1286+ HsUnboundVar NoExtField _ -> backticks
1287+ _ -> id
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
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
1355+
1356+-- | Get annotations for the enclosing element.
1357+getEnclosingAnns :: R [AnnKeywordId]
1358+getEnclosingAnns = do
1359+ e <- getEnclosingSpan (const True)
1360+ case e of
1361+ Nothing -> return []
1362+ Just e' -> getAnns (RealSrcSpan e')