@@ -1,38 +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
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
3440-- | Style of a group of equations.
35−
3641data MatchGroupStyle
3742 = Function (Located RdrName)
3843 | PatternBind
@@ -41,56 +46,61 @@ data MatchGroupStyle
4146 | LambdaCase
4247
4348-- | Style of equations in a group.
44−
4549data GroupStyle
4650 = EqualSign
4751 | RightArrow
4852
4953-- | Expression placement. This marks the places where expressions that
5054-- implement handing forms may use them.
51−
5255data Placement
53− = Normal -- ^ Multi-line layout should cause
54− -- insertion of a newline and indentation
55− -- bump
56− | Hanging -- ^ Expressions that have hanging form
57− -- should use it and avoid bumping one level
58− -- 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)
5965
6066p_valDecl :: HsBindLR GhcPs GhcPs -> R ()
6167p_valDecl = \case
62− FunBind NoExt funId funMatches _ _ -> p_funBind funId funMatches
63− 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
6470 VarBind {} -> notImplemented "VarBinds" -- introduced by the type checker
6571 AbsBinds {} -> notImplemented "AbsBinds" -- introduced by the type checker
66− PatSynBind NoExt psb -> p_patSynBind psb
67− XHsBindsLR NoExt -> notImplemented "XHsBindsLR"
72+ PatSynBind NoExtField psb -> p_patSynBind psb
73+ XHsBindsLR x -> noExtCon x
6874
69−p_funBind
70− :: Located RdrName
71− -> MatchGroup GhcPs (LHsExpr GhcPs)
72− -> R ()
75+p_funBind ::
76+ Located RdrName ->
77+ MatchGroup GhcPs (LHsExpr GhcPs) ->
78+ R ()
7379p_funBind name = p_matchGroup (Function name)
7480
75−p_matchGroup
76− :: MatchGroupStyle
77− -> MatchGroup GhcPs (LHsExpr GhcPs)
78− -> R ()
81+p_matchGroup ::
82+ MatchGroupStyle ->
83+ MatchGroup GhcPs (LHsExpr GhcPs) ->
84+ R ()
7985p_matchGroup = p_matchGroup' exprPlacement p_hsExpr
8086
81−p_matchGroup'
82− :: Data body
83− => (body -> Placement) -- ^ How to get body placement
84− -> (body -> R ()) -- ^ How to print body
85− -> MatchGroupStyle -- ^ Style of this group of equations
86− -> MatchGroup GhcPs (Located body) -- ^ Match group
87− -> R ()
88−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
8999 let ob = case style of
90100 Case -> id
91101 LambdaCase -> id
92102 _ -> dontUseBraces
93− -- 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
94104 -- restore the brace state inside the sepsemi.
95105 ub <- bool dontUseBraces useBraces <$> canUseBraces
96106 ob $ sepSemi (located' (ub . p_Match)) (unLoc mg_alts)
@@ -98,14 +108,14 @@ p_matchGroup' placer pretty style MG {..} = do
98108 p_Match m@Match {..} =
99109 p_match'
100110 placer
101− pretty
111+ render
102112 (adjustMatchGroupStyle m style)
103113 (isInfixMatch m)
104114 (matchStrictness m)
105115 m_pats
106116 m_grhss
107− p_Match _ = notImplemented "XMatch"
108−p_matchGroup' _ _ _ (XMatchGroup NoExt) = notImplemented "XMatchGroup"
117+ p_Match (XMatch x) = noExtCon x
118+p_matchGroup' _ _ _ (XMatchGroup x) = noExtCon x
109119
110120-- | Function id obtained through pattern matching on 'FunBind' should not
111121-- be used to print the actual equations because the different ‘RdrNames’
@@ -113,11 +123,10 @@ p_matchGroup' _ _ _ (XMatchGroup NoExt) = notImplemented "XMatchGroup"
113123-- and paretheses) associated with them. It is necessary to use per-equation
114124-- names obtained from 'm_ctxt' of 'Match'. This function replaces function
115125-- name inside of 'Function' accordingly.
116−
117−adjustMatchGroupStyle
118− :: Match GhcPs body
119− -> MatchGroupStyle
120− -> MatchGroupStyle
126+adjustMatchGroupStyle ::
127+ Match GhcPs body ->
128+ MatchGroupStyle ->
129+ MatchGroupStyle
121130adjustMatchGroupStyle m = \case
122131 Function _ -> (Function . mc_fun . m_ctxt) m
123132 style -> style
@@ -125,31 +134,43 @@ adjustMatchGroupStyle m = \case
125134matchStrictness :: Match id body -> SrcStrictness
126135matchStrictness match =
127136 case m_ctxt match of
128− FunRhs{mc_strictness=s} -> s
137+ FunRhs {mc_strictness = s} -> s
129138 _ -> NoSrcStrict
130139
131−p_match
132− :: MatchGroupStyle -- ^ Style of the group
133− -> Bool -- ^ Is this an infix match?
134− -> SrcStrictness -- ^ Strictness prefix (FunBind)
135− -> [LPat GhcPs] -- ^ Argument patterns
136− -> GRHSs GhcPs (LHsExpr GhcPs) -- ^ Equations
137− -> 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 ()
138152p_match = p_match' exprPlacement p_hsExpr
139153
140−p_match'
141− :: Data body
142− => (body -> Placement) -- ^ How to get body placement
143− -> (body -> R ()) -- ^ How to print body
144− -> MatchGroupStyle -- ^ Style of this group of equations
145− -> Bool -- ^ Is this an infix match?
146− -> SrcStrictness -- ^ Strictness prefix (FunBind)
147− -> [LPat GhcPs] -- ^ Argument patterns
148− -> GRHSs GhcPs (Located body) -- ^ Equations
149− -> R ()
150−p_match' placer pretty style isInfix strictness m_pats m_grhss = do
151− -- NOTE Normally, since patterns may be placed in a multi-line layout, it
152− -- 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
153174 -- indented than function name. This in turn means that indentation for
154175 -- the body should also be bumped. Normally this would mean that bodies
155176 -- would start with two indentation steps applied, which is ugly, so we
@@ -159,23 +180,24 @@ p_match' placer pretty style isInfix strictness m_pats m_grhss = do
159180 NoSrcStrict -> return ()
160181 SrcStrict -> txt "!"
161182 SrcLazy -> txt "~"
162− inci' <- case NE.nonEmpty m_pats of
163− Nothing -> id <$ case style of
164− Function name -> p_rdrName name
165− _ -> return ()
183+ indentBody <- case NE.nonEmpty m_pats of
184+ Nothing ->
185+ False <$ case style of
186+ Function name -> p_rdrName name
187+ _ -> return ()
166188 Just ne_pats -> do
167− let combinedSpans = combineSrcSpans' $
168− getLoc <$> ne_pats
169− inci' = if isOneLineSpan combinedSpans
170− then id
171− 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)
172194 switchLayout [combinedSpans] $ do
173195 let stdCase = sep breakpoint (located' p_pat) m_pats
174196 case style of
175197 Function name ->
176198 p_infixDefHelper
177199 isInfix
178− inci'
200+ indentBody
179201 (p_rdrName name)
180202 (located' p_pat <$> m_pats)
181203 PatternBind -> stdCase
@@ -190,46 +212,40 @@ p_match' placer pretty style isInfix strictness m_pats m_grhss = do
190212 when needsSpace space
191213 sitcc stdCase
192214 LambdaCase -> stdCase
193− return inci'
194− let
195− -- Calculate position of end of patterns. This is useful when we decide
196− -- about putting certain constructions in hanging positions.
197− endOfPats = case NE.nonEmpty m_pats of
198− Nothing -> case style of
199− Function name -> (Just . srcSpanEnd . getLoc) name
200− _ -> Nothing
201− Just pats -> (Just . srcSpanEnd . getLoc . NE.last) pats
202− isCase = \case
203− Case -> True
204− LambdaCase -> True
205− _ -> False
206− 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
207227 hasGuards = withGuards grhssGRHSs
208− unless (length grhssGRHSs > 1) $ do
209− case style of
210− Function _ | hasGuards -> return ()
211− Function _ -> space >> txt "="
212− PatternBind -> space >> txt "="
213− s | isCase s && hasGuards -> return ()
214− _ -> space >> txt "->"
215− let grhssSpan = combineSrcSpans' $
216− getGRHSSpan . unLoc <$> NE.fromList grhssGRHSs
217− patGrhssSpan = maybe grhssSpan
218− (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
219236 placement =
220237 case endOfPats of
221238 Nothing -> blockPlacement placer grhssGRHSs
222239 Just spn ->
223− if isOneLineSpan
224− (mkSrcSpan spn (srcSpanStart grhssSpan))
240+ if onTheSameLine spn grhssSpan
225241 then blockPlacement placer grhssGRHSs
226242 else Normal
227243 p_body = do
228244 let groupStyle =
229245 if isCase style && hasGuards
230− then RightArrow
231− else EqualSign
232− sep newline (located' (p_grhs' pretty groupStyle)) grhssGRHSs
246+ then RightArrow
247+ else EqualSign
248+ sep newline (located' (p_grhs' placer render groupStyle)) grhssGRHSs
233249 p_where = do
234250 let whereIsEmpty = GHC.isEmptyLocalBindsPR (unLoc grhssLocalBinds)
235251 unless (GHC.eqEmptyLocalBinds (unLoc grhssLocalBinds)) $ do
@@ -237,175 +253,211 @@ p_match' placer pretty style isInfix strictness m_pats m_grhss = do
237253 txt "where"
238254 unless whereIsEmpty breakpoint
239255 inci $ located grhssLocalBinds p_hsLocalBinds
240− 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 "->"
241264 switchLayout [patGrhssSpan] $
242265 placeHanging placement p_body
243266 inci p_where
267+p_match' _ _ _ _ _ _ (XGRHSs x) = noExtCon x
244268
245269p_grhs :: GroupStyle -> GRHS GhcPs (LHsExpr GhcPs) -> R ()
246−p_grhs = p_grhs' p_hsExpr
270+p_grhs = p_grhs' exprPlacement p_hsExpr
247271
248−p_grhs'
249− :: Data body
250− => (body -> R ())
251− -> GroupStyle
252− -> GRHS GhcPs (Located body)
253− -> R ()
254−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) =
255282 case guards of
256283 [] -> p_body
257284 xs -> do
258285 txt "|"
259286 space
260− sitcc (sep (comma >> breakpoint) (sitcc . located' p_stmt) xs)
287+ sitcc (sep commaDel (sitcc . located' p_stmt) xs)
261288 space
262− txt $ case style of
263− EqualSign -> "="
264− RightArrow -> "->"
265− breakpoint
266− inci p_body
289+ inci $ case style of
290+ EqualSign -> equals
291+ RightArrow -> txt "->"
292+ placeHanging placement p_body
267293 where
268− p_body = located body pretty
269−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
270307
271308p_hsCmd :: HsCmd GhcPs -> R ()
272309p_hsCmd = \case
273− HsCmdArrApp NoExt body input arrType _ -> do
310+ HsCmdArrApp NoExtField body input arrType _ -> do
274311 located body p_hsExpr
275− space
276− case arrType of
277− HsFirstOrderApp -> txt "-<"
278− HsHigherOrderApp -> txt "-<<"
279− placeHanging (exprPlacement (unLoc input)) $
280− located input p_hsExpr
281− 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
282320 located form p_hsExpr
283321 unless (null cmds) $ do
284322 breakpoint
285323 inci (sequence_ (intersperse breakpoint (located' p_hsCmdTop <$> cmds)))
286− HsCmdArrForm NoExt form Infix _ [left, right] -> do
324+ HsCmdArrForm NoExtField form Infix _ [left, right] -> do
287325 located left p_hsCmdTop
288326 space
289327 located form p_hsExpr
290328 placeHanging (cmdTopPlacement (unLoc right)) $
291329 located right p_hsCmdTop
292− HsCmdArrForm NoExt _ Infix _ _ -> notImplemented "HsCmdArrForm"
330+ HsCmdArrForm NoExtField _ Infix _ _ -> notImplemented "HsCmdArrForm"
293331 HsCmdApp {} ->
294332 -- XXX Does this ever occur in the syntax tree? It does not seem like it
295333 -- does. Open an issue and ping @yumiova if this ever occurs in output.
296334 notImplemented "HsCmdApp"
297− HsCmdLam NoExt mgroup -> p_matchGroup' cmdPlacement p_hsCmd Lambda mgroup
298− HsCmdPar NoExt c -> parens (located c p_hsCmd)
299− HsCmdCase NoExt e mgroup -> do
300− txt "case"
301− space
302− located e p_hsExpr
303− space
304− txt "of"
305− breakpoint
306− inci (p_matchGroup' cmdPlacement p_hsCmd Case mgroup)
307− HsCmdIf NoExt _ if' then' else' -> do
308− txt "if"
309− space
310− located if' p_hsExpr
311− breakpoint
312− txt "then"
313− located then' $ \x -> do
314− breakpoint
315− inci (p_hsCmd x)
316− breakpoint
317− txt "else"
318− located else' $ \x -> do
319− breakpoint
320− inci (p_hsCmd x)
321− HsCmdLet NoExt localBinds c -> do
322− txt "let"
323− space
324− sitcc (located localBinds p_hsLocalBinds)
325− breakpoint
326− txt "in"
327− space
328− sitcc (located c p_hsCmd)
329− 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
330344 txt "do"
331345 newline
332− 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))
333348 HsCmdWrap {} -> notImplemented "HsCmdWrap"
334− XCmd {} -> notImplemented "XCmd"
349+ XCmd x -> noExtCon x
335350
336351p_hsCmdTop :: HsCmdTop GhcPs -> R ()
337352p_hsCmdTop = \case
338− HsCmdTop NoExt cmd -> located cmd p_hsCmd
339− 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)
340384
341385p_stmt :: Stmt GhcPs (LHsExpr GhcPs) -> R ()
342−p_stmt = p_stmt' p_hsExpr
386+p_stmt = p_stmt' exprPlacement p_hsExpr
343387
344−p_stmt'
345− :: Data body
346− => (body -> R ())
347− -> Stmt GhcPs (Located body)
348− -> R ()
349−p_stmt' pretty = \case
350− LastStmt NoExt body _ _ -> located body pretty
351− BindStmt NoExt l f _ _ -> do
352− 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
353401 space
354402 txt "<-"
355− breakpoint
356− 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)
357413 ApplicativeStmt {} -> notImplemented "ApplicativeStmt" -- generated by renamer
358− BodyStmt NoExt body _ _ -> located body pretty
359− LetStmt NoExt binds -> do
414+ BodyStmt NoExtField body _ _ -> located body render
415+ LetStmt NoExtField binds -> do
360416 txt "let"
361417 space
362418 sitcc $ located binds p_hsLocalBinds
363419 ParStmt {} ->
364− -- NOTE 'ParStmt' should always be eliminated in 'gatherStmt' already,
365− -- such that it never occurs in 'p_stmt''. Consequently, handling it
366− -- 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.
367423 notImplemented "ParStmt"
368− TransStmt {..} -> do
369− -- NOTE 'TransStmt' only needs to account for pretty printing itself,
370− -- since pretty printing of relevant statements (e.g., in 'trS_stmts')
371− -- 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'.
372428 case (trS_form, trS_by) of
373− (ThenForm, Nothing) -> located trS_using $ \x -> do
429+ (ThenForm, Nothing) -> do
374430 txt "then"
375431 breakpoint
376− inci (p_hsExpr x)
432+ inci $ located trS_using p_hsExpr
377433 (ThenForm, Just e) -> do
378− located trS_using $ \x -> do
379− txt "then"
380− breakpoint
381− inci (p_hsExpr x)
434+ txt "then"
382435 breakpoint
383− located e $ \x -> do
384− txt "by"
385− breakpoint
386− inci (p_hsExpr x)
387− (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
388442 txt "then group using"
389443 breakpoint
390− inci (p_hsExpr x)
444+ inci $ located trS_using p_hsExpr
391445 (GroupForm, Just e) -> do
392− located e $ \x -> do
393− txt "then group by"
394− breakpoint
395− inci (p_hsExpr x)
446+ txt "then group by"
396447 breakpoint
397− located trS_using $ \x -> do
398− txt "using"
399− breakpoint
400− inci (p_hsExpr x)
448+ inci $ located e p_hsExpr
449+ breakpoint
450+ txt "using"
451+ breakpoint
452+ inci $ located trS_using p_hsExpr
401453 RecStmt {..} -> do
402454 txt "rec"
403455 space
404− sitcc $ sepSemi (located' (p_stmt' pretty)) recS_stmts
405− XStmtLR {} -> notImplemented "XStmtLR"
456+ sitcc $ sepSemi (withSpacing (p_stmt' placer render)) recS_stmts
457+ XStmtLR c -> noExtCon c
406458
407459gatherStmt :: ExprLStmt GhcPs -> [[ExprLStmt GhcPs]]
408−gatherStmt (L _ (ParStmt NoExt block _ _)) =
460+gatherStmt (L _ (ParStmt NoExtField block _ _)) =
409461 foldr ((<>) . gatherStmtBlock) [] block
410462gatherStmt (L s stmt@TransStmt {..}) =
411463 foldr liftAppend [] ((gatherStmt <$> trS_stmts) <> pure [[L s stmt]])
@@ -414,195 +466,230 @@ gatherStmt stmt = [[stmt]]
414466gatherStmtBlock :: ParStmtBlock GhcPs GhcPs -> [[ExprLStmt GhcPs]]
415467gatherStmtBlock (ParStmtBlock _ stmts _ _) =
416468 foldr (liftAppend . gatherStmt) [] stmts
417−gatherStmtBlock XParStmtBlock {} = notImplemented "XParStmtBlock"
469+gatherStmtBlock (XParStmtBlock x) = noExtCon x
418470
419471p_hsLocalBinds :: HsLocalBindsLR GhcPs GhcPs -> R ()
420472p_hsLocalBinds = \case
421− HsValBinds NoExt (ValBinds NoExt bag lsigs) -> do
422− let ssStart = either
423− (srcSpanStart . getLoc)
424− (srcSpanStart . getLoc)
425− items =
426− (Left <$> bagToList bag) ++ (Right <$> lsigs)
427− p_item (Left x) = located x p_valDecl
428− p_item (Right x) = located x p_sigDecl
429− -- Assigns 'False' to the last element, 'True' to the rest.
430− markInit :: [a] -> [(Bool, a)]
431− markInit [] = []
432− markInit (x:[]) = [(False, x)]
433− markInit (x:xs) = (True, x) : markInit xs
434− -- 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
435475 -- elements will also contain semicolons and they will confuse the
436476 -- parser. so we request braces around every element except the last.
437− br <- vlayout (return useBraces) (return id)
438− sitcc $ sepSemi
439− (\(m, i) -> (if m then br else id) $ p_item i)
440− (markInit $ sortOn ssStart items)
441− HsValBinds NoExt _ -> notImplemented "HsValBinds"
442− 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) ->
443494 -- Second argument of IPBind is always Left before type-checking.
444− let p_ipBind (IPBind NoExt (Left name) expr) = do
495+ let p_ipBind (IPBind NoExtField (Left name) expr) = do
445496 atom name
446497 space
447− txt "="
498+ equals
448499 breakpoint
449500 useBraces $ inci $ located expr p_hsExpr
450− 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
451505 in sepSemi (located' p_ipBind) xs
452− HsIPBinds NoExt _ -> notImplemented "HsIpBinds"
453− EmptyLocalBinds NoExt -> return ()
454− XHsLocalBindsLR _ -> notImplemented "XHsLocalBindsLR"
506+ HsIPBinds NoExtField _ -> notImplemented "HsIpBinds"
507+ EmptyLocalBinds NoExtField -> return ()
508+ XHsLocalBindsLR x -> noExtCon x
455509
456−p_hsRecField
457− :: (Data id, Outputable id)
458− => HsRecField' id (LHsExpr GhcPs)
459− -> R ()
460−p_hsRecField = \HsRecField {..} -> do
461− located hsRecFieldLbl atom
510+p_hsRecField ::
511+ HsRecField' RdrName (LHsExpr GhcPs) ->
512+ R ()
513+p_hsRecField HsRecField {..} = do
514+ p_rdrName hsRecFieldLbl
462515 unless hsRecPun $ do
463516 space
464− txt "="
465− let placement = exprPlacement (unLoc hsRecFieldArg)
466− placeHanging placement $ located hsRecFieldArg p_hsExpr
467−
468−p_hsTupArg :: HsTupArg GhcPs -> R ()
469−p_hsTupArg = \case
470− Present NoExt x -> located x p_hsExpr
471− Missing NoExt -> pure ()
472− 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)
473523
474524p_hsExpr :: HsExpr GhcPs -> R ()
475−p_hsExpr = \case
476− HsVar NoExt name -> p_rdrName name
477− HsUnboundVar NoExt _ -> notImplemented "HsUnboundVar"
478− HsConLikeOut NoExt _ -> notImplemented "HsConLikeOut"
479− 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 ->
480533 case x of
481− Unambiguous NoExt name -> p_rdrName name
482− Ambiguous NoExt name -> p_rdrName name
483− XAmbiguousFieldOcc NoExt -> notImplemented "XAmbiguousFieldOcc"
484− HsOverLabel NoExt _ v -> do
534+ Unambiguous NoExtField name -> p_rdrName name
535+ Ambiguous NoExtField name -> p_rdrName name
536+ XAmbiguousFieldOcc xx -> noExtCon xx
537+ HsOverLabel NoExtField _ v -> do
485538 txt "#"
486539 atom v
487− HsIPVar NoExt (HsIPName name) -> do
540+ HsIPVar NoExtField (HsIPName name) -> do
488541 txt "?"
489542 atom name
490− HsOverLit NoExt v -> atom (ol_val v)
491− HsLit NoExt lit -> atom lit
492− 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 ->
493550 p_matchGroup Lambda mgroup
494− HsLamCase NoExt mgroup -> do
551+ HsLamCase NoExtField mgroup -> do
495552 txt "\\case"
496553 breakpoint
497554 inci (p_matchGroup LambdaCase mgroup)
498− HsApp NoExt f x -> sitcc $ do
499− located f p_hsExpr
500− -- Second argument can be a `do` or `case` block with `-XBlockArguments`.
501− placeHanging (exprPlacement (unLoc x)) $
502− located x p_hsExpr
503− 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
504612 located e p_hsExpr
505613 breakpoint
506614 inci $ do
507615 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 ()
508621 located (hswc_body a) p_hsType
509− OpApp NoExt x op y -> do
510− -- NOTE If the beginning of the first argument and the second argument
511− -- are on the same line, and the second argument has a hanging form, use
512− -- hanging placement.
513− let placement =
514− if isOneLineSpan
515− (mkSrcSpan (srcSpanStart (getLoc x)) (srcSpanStart (getLoc y)))
516− then exprPlacement (unLoc y)
517− else Normal
518− opWrapper = case unLoc op of
519− EWildPat NoExt -> backticks
520− _ -> id
521− ub <- vlayout
522− (return useBraces)
523− (return $ case placement of
524− Hanging -> useBraces
525− Normal -> dontUseBraces)
526− ub $ located x p_hsExpr
527− placeHanging placement $ do
528− located op (opWrapper . p_hsExpr)
529− space
530− located y p_hsExpr
531− NegApp NoExt e _ -> do
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
532626 txt "-"
533627 space
534628 located e p_hsExpr
535− HsPar NoExt e -> parens (located e p_hsExpr)
536− SectionL NoExt x op -> do
629+ HsPar NoExtField e ->
630+ parens s (located e (dontUseBraces . p_hsExpr))
631+ SectionL NoExtField x op -> do
537632 located x p_hsExpr
538633 breakpoint
539634 inci (located op p_hsExpr)
540− SectionR NoExt op x -> do
635+ SectionR NoExtField op x -> do
541636 located op p_hsExpr
542− breakpoint
637+ useRecordDot' <- useRecordDot
638+ let isRecordDot' = isRecordDot (unLoc op) (getLoc x)
639+ unless (useRecordDot' && isRecordDot') breakpoint
543640 inci (located x p_hsExpr)
544− ExplicitTuple NoExt args boxity -> do
641+ ExplicitTuple NoExtField args boxity ->
545642 let isSection = any (isMissing . unLoc) args
546643 isMissing = \case
547− Missing NoExt -> True
644+ Missing NoExtField -> True
548645 _ -> False
549− 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' =
550652 case boxity of
551653 Boxed -> parens
552654 Unboxed -> parensHash
553− if isSection
554− then switchLayout [] . parens' $
555− sep comma (located' p_hsTupArg) args
556− else switchLayout (getLoc <$> args) . parens' . sitcc $
557− sep (comma >> breakpoint) (sitcc . located' p_hsTupArg) args
558− ExplicitSum NoExt tag arity e ->
559− p_unboxedSum tag arity (located e p_hsExpr)
560− HsCase NoExt e mgroup -> do
561− txt "case"
562− space
563− located e p_hsExpr
564− space
565− txt "of"
566− breakpoint
567− inci (p_matchGroup Case mgroup)
568− HsIf NoExt _ if' then' else' -> do
569− txt "if"
570− space
571− located if' p_hsExpr
572− breakpoint
573− inci $ do
574− txt "then"
575− located then' $ \x ->
576− placeHanging (exprPlacement x) (p_hsExpr x)
577− breakpoint
578− txt "else"
579− located else' $ \x ->
580− placeHanging (exprPlacement x) (p_hsExpr x)
581− HsMultiIf NoExt guards -> 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
582669 txt "if"
583670 breakpoint
584− inci . sitcc $ sep newline (located' (p_grhs RightArrow)) guards
585− HsLet NoExt localBinds e -> sitcc $ do
586− txt "let"
587− space
588− dontUseBraces $ sitcc (located localBinds p_hsLocalBinds)
589− vlayout space (newline >> txt " ")
590− txt "in"
591− space
592− sitcc (located e p_hsExpr)
593− 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
594675 let doBody header = do
595676 txt header
596677 breakpoint
597− ub <- vlayout (return useBraces) (return id)
598− inci $ sepSemi (located' (ub . p_stmt)) (unLoc es)
599− compBody = brackets $ located es $ \xs -> do
600− let p_parBody = sep
601− (breakpoint >> txt "| ")
602− p_seqBody
603− p_seqBody = sitcc . sep
604− (comma >> breakpoint)
605− (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))
606693 stmts = init xs
607694 yield = last xs
608695 lists = foldr (liftAppend . gatherStmt) [] stmts
@@ -616,76 +703,100 @@ p_hsExpr = \case
616703 MDoExpr -> doBody "mdo"
617704 ListComp -> compBody
618705 MonadComp -> notImplemented "MonadComp"
619− ArrowExpr -> notImplemented "ArrowExpr"
706+ ArrowExpr -> notImplemented "ArrowExpr"
620707 GhciStmtCtxt -> notImplemented "GhciStmtCtxt"
621708 PatGuard _ -> notImplemented "PatGuard"
622709 ParStmtCtxt _ -> notImplemented "ParStmtCtxt"
623710 TransStmtCtxt _ -> notImplemented "TransStmtCtxt"
624711 ExplicitList _ _ xs ->
625− brackets . sitcc $ sep (comma >> breakpoint) (sitcc . located' p_hsExpr) xs
712+ brackets s $
713+ sep commaDel (sitcc . located' p_hsExpr) xs
626714 RecordCon {..} -> do
627715 located rcon_con_name atom
628716 breakpoint
629717 let HsRecFields {..} = rcon_flds
630− 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
631725 dotdot =
632726 case rec_dotdot of
633727 Just {} -> [txt ".."]
634728 Nothing -> []
635− inci . braces . sitcc $ sep (comma >> breakpoint) sitcc (fields <> dotdot)
729+ inci . braces N $
730+ sep commaDel sitcc (fields <> dotdot)
636731 RecordUpd {..} -> do
637732 located rupd_expr p_hsExpr
638− breakpoint
639− inci . braces . sitcc $
640− sep (comma >> breakpoint) (sitcc . located' p_hsRecField) rupd_flds
641− 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
642754 located x p_hsExpr
755+ space
756+ txt "::"
643757 breakpoint
644− inci $ do
645− txt "::"
646− space
647− let HsWC {..} = affix
648− HsIB {..} = hswc_body
649− located hsib_body p_hsType
650− 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 ->
651762 case x of
652− From from -> brackets . sitcc $ do
763+ From from -> brackets s $ do
653764 located from p_hsExpr
654765 breakpoint
655766 txt ".."
656− FromThen from next -> brackets . sitcc $ do
657− sitcc $ sep (comma >> breakpoint) (located' p_hsExpr) [from, next]
767+ FromThen from next -> brackets s $ do
768+ sep commaDel (located' p_hsExpr) [from, next]
658769 breakpoint
659770 txt ".."
660− FromTo from to -> brackets . sitcc $ do
771+ FromTo from to -> brackets s $ do
661772 located from p_hsExpr
662773 breakpoint
663774 txt ".."
664775 space
665776 located to p_hsExpr
666− FromThenTo from next to -> brackets . sitcc $ do
667− 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]
668779 breakpoint
669780 txt ".."
670781 space
671782 located to p_hsExpr
672− HsSCC NoExt _ name x -> do
783+ HsSCC NoExtField _ name x -> do
673784 txt "{-# SCC "
674785 atom name
675786 txt " #-}"
676787 breakpoint
677788 located x p_hsExpr
678− HsCoreAnn NoExt _ value x -> do
789+ HsCoreAnn NoExtField _ value x -> do
679790 txt "{-# CORE "
680791 atom value
681792 txt " #-}"
682793 breakpoint
683794 located x p_hsExpr
684− HsBracket NoExt x -> p_hsBracket x
795+ HsBracket NoExtField x -> p_hsBracket x
685796 HsRnBracketOut {} -> notImplemented "HsRnBracketOut"
686797 HsTcBracketOut {} -> notImplemented "HsTcBracketOut"
687− HsSpliceE NoExt splice -> p_hsSplice splice
688− HsProc NoExt p e -> do
798+ HsSpliceE NoExtField splice -> p_hsSplice splice
799+ HsProc NoExtField p e -> do
689800 txt "proc"
690801 located p $ \x -> do
691802 breakpoint
@@ -694,64 +805,46 @@ p_hsExpr = \case
694805 txt "->"
695806 placeHanging (cmdTopPlacement (unLoc e)) $
696807 located e p_hsCmdTop
697− HsStatic _ e -> do
808+ HsStatic _ e -> do
698809 txt "static"
699810 breakpoint
700811 inci (located e p_hsExpr)
701− HsArrApp NoExt body input arrType cond ->
702− p_hsCmd (HsCmdArrApp NoExt body input arrType cond)
703− HsArrForm NoExt form mfixity cmds ->
704− p_hsCmd (HsCmdArrForm NoExt form Prefix mfixity cmds)
705812 HsTick {} -> notImplemented "HsTick"
706813 HsBinTick {} -> notImplemented "HsBinTick"
707814 HsTickPragma {} -> notImplemented "HsTickPragma"
708− -- These four constructs should never appear in correct programs.
709− -- See: https://github.com/tweag/ormolu/issues/343
710− EWildPat NoExt -> txt "_"
711− EAsPat NoExt n p -> do
712− p_rdrName n
713− txt "@"
714− located p p_hsExpr
715− EViewPat NoExt p e -> do
716− located p p_hsExpr
717− space
718− txt "->"
719− breakpoint
720− inci (located e p_hsExpr)
721− ELazyPat NoExt p -> do
722− txt "~"
723− located p p_hsExpr
724815 HsWrap {} -> notImplemented "HsWrap"
725− XExpr {} -> notImplemented "XExpr"
816+ XExpr x -> noExtCon x
726817
727818p_patSynBind :: PatSynBind GhcPs GhcPs -> R ()
728819p_patSynBind PSB {..} = do
729− let rhs = case psb_dir of
730− Unidirectional -> do
731− txt "<-"
732− space
733− located psb_def p_pat
734− ImplicitBidirectional -> do
735− txt "="
736− space
737− located psb_def p_pat
738− ExplicitBidirectional mgroup -> do
739− txt "<-"
740− space
741− located psb_def p_pat
742− newline
743− line (txt "where")
744− 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)
745839 txt "pattern"
746840 case psb_args of
747841 PrefixCon xs -> do
748842 space
749843 p_rdrName psb_id
750− inci $ do
844+ inci $ do
751845 switchLayout (getLoc <$> xs) $ do
752846 unless (null xs) breakpoint
753847 sitcc (sep breakpoint p_rdrName xs)
754− breakpoint
755848 rhs
756849 RecCon xs -> do
757850 space
@@ -759,9 +852,8 @@ p_patSynBind PSB {..} = do
759852 inci $ do
760853 switchLayout (getLoc . recordPatSynPatVar <$> xs) $ do
761854 unless (null xs) breakpoint
762− braces . sitcc $
763− sep (comma >> breakpoint) (p_rdrName . recordPatSynPatVar) xs
764− breakpoint
855+ braces N $
856+ sep commaDel (p_rdrName . recordPatSynPatVar) xs
765857 rhs
766858 InfixCon l r -> do
767859 switchLayout [getLoc l, getLoc r] $ do
@@ -772,37 +864,100 @@ p_patSynBind PSB {..} = do
772864 p_rdrName psb_id
773865 space
774866 p_rdrName r
775− inci $ do
776− breakpoint
777− rhs
778−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)
779934
780935p_pat :: Pat GhcPs -> R ()
781936p_pat = \case
782− WildPat NoExt -> txt "_"
783− VarPat NoExt name -> p_rdrName name
784− LazyPat NoExt pat -> do
937+ WildPat NoExtField -> txt "_"
938+ VarPat NoExtField name -> p_rdrName name
939+ LazyPat NoExtField pat -> do
785940 txt "~"
786941 located pat p_pat
787− AsPat NoExt name pat -> do
942+ AsPat NoExtField name pat -> do
788943 p_rdrName name
789944 txt "@"
790945 located pat p_pat
791− ParPat NoExt pat ->
792− located pat (parens . p_pat)
793− BangPat NoExt pat -> do
946+ ParPat NoExtField pat ->
947+ located pat (parens S . p_pat)
948+ BangPat NoExtField pat -> do
794949 txt "!"
795950 located pat p_pat
796− ListPat NoExt pats -> do
797− brackets . sitcc $ sep (comma >> breakpoint) (located' p_pat) pats
798− TuplePat NoExt pats boxing -> do
799− let f =
951+ ListPat NoExtField pats ->
952+ brackets S $ sep commaDel (located' p_pat) pats
953+ TuplePat NoExtField pats boxing -> do
954+ let parens' =
800955 case boxing of
801− Boxed -> parens
802− Unboxed -> parensHash
803− f . sitcc $ sep (comma >> breakpoint) (sitcc . located' p_pat) pats
804− SumPat NoExt pat tag arity ->
805− 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)
806961 ConPatIn pat details ->
807962 case details of
808963 PrefixCon xs -> sitcc $ do
@@ -816,37 +971,40 @@ p_pat = \case
816971 let f = \case
817972 Nothing -> txt ".."
818973 Just x -> located x p_pat_hsRecField
819− inci . braces . sitcc . sep (comma >> breakpoint) f $ case dotdot of
820− Nothing -> Just <$> fields
821− Just n -> (Just <$> take n fields) ++ [Nothing]
822− InfixCon x y -> do
823− located x p_pat
824− space
825− p_rdrName pat
826− breakpoint
827− 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
828986 ConPatOut {} -> notImplemented "ConPatOut" -- presumably created by renamer?
829− ViewPat NoExt expr pat -> sitcc $ do
987+ ViewPat NoExtField expr pat -> sitcc $ do
830988 located expr p_hsExpr
831989 space
832990 txt "->"
833991 breakpoint
834992 inci (located pat p_pat)
835− SplicePat NoExt splice -> p_hsSplice splice
836− LitPat NoExt p -> atom p
837− NPat NoExt v _ _ -> located v (atom . ol_val)
838− 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
839997 p_rdrName n
840998 breakpoint
841999 inci $ do
8421000 txt "+"
8431001 space
8441002 located k (atom . ol_val)
845− SigPat hswc pat -> do
1003+ SigPat NoExtField pat hswc -> do
8461004 located pat p_pat
8471005 p_typeAscription hswc
8481006 CoPat {} -> notImplemented "CoPat" -- apparently created at some later stage
849− XPat NoExt -> notImplemented "XPat"
1007+ XPat x -> noExtCon x
8501008
8511009p_pat_hsRecField :: HsRecField' (FieldOcc GhcPs) (LPat GhcPs) -> R ()
8521010p_pat_hsRecField HsRecField {..} = do
@@ -854,51 +1012,53 @@ p_pat_hsRecField HsRecField {..} = do
8541012 p_rdrName (rdrNameFieldOcc x)
8551013 unless hsRecPun $ do
8561014 space
857− txt "="
1015+ equals
8581016 breakpoint
8591017 inci (located hsRecFieldArg p_pat)
8601018
861−p_unboxedSum :: ConTag -> Arity -> R () -> R ()
862−p_unboxedSum tag arity m = do
1019+p_unboxedSum :: BracketStyle -> ConTag -> Arity -> R () -> R ()
1020+p_unboxedSum s tag arity m = do
8631021 let before = tag - 1
8641022 after = arity - before - 1
8651023 args = replicate before Nothing <> [Just m] <> replicate after Nothing
866− f (x,i) = do
867− let isFirst = i == 0
868− isLast = i == arity - 1
1024+ f x =
8691025 case x :: Maybe (R ()) of
8701026 Nothing ->
871− unless (isFirst || isLast) space
1027+ space
8721028 Just m' -> do
873− unless isFirst space
1029+ space
8741030 m'
875− unless isLast space
876− parensHash $ sep (txt "|") f (zip args [0..])
1031+ space
1032+ parensHash s $ sep (txt "|") f args
8771033
8781034p_hsSplice :: HsSplice GhcPs -> R ()
8791035p_hsSplice = \case
880− HsTypedSplice NoExt deco _ expr -> p_hsSpliceTH True expr deco
881− HsUntypedSplice NoExt deco _ expr -> p_hsSpliceTH False expr deco
882− 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
8831039 txt "["
8841040 p_rdrName (L srcSpan quoterName)
8851041 txt "|"
886− -- NOTE QuasiQuoters often rely on precise custom strings. We cannot do
887− -- 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.
8881044 atom str
8891045 txt "|]"
8901046 HsSpliced {} -> notImplemented "HsSpliced"
891− XSplice {} -> notImplemented "XSplice"
1047+ HsSplicedT {} -> notImplemented "HsSplicedT"
1048+ XSplice x -> noExtCon x
8921049
893−p_hsSpliceTH
894− :: Bool -- ^ Typed splice?
895− -> LHsExpr GhcPs -- ^ Splice expression
896− -> SpliceDecoration -- ^ Splice decoration
897− -> R ()
1050+p_hsSpliceTH ::
1051+ -- | Typed splice?
1052+ Bool ->
1053+ -- | Splice expression
1054+ LHsExpr GhcPs ->
1055+ -- | Splice decoration
1056+ SpliceDecoration ->
1057+ R ()
8981058p_hsSpliceTH isTyped expr = \case
8991059 HasParens -> do
9001060 txt decoSymbol
901− parens (located expr (sitcc . p_hsExpr))
1061+ parens N (located expr (sitcc . p_hsExpr))
9021062 HasDollar -> do
9031063 txt decoSymbol
9041064 located expr (sitcc . p_hsExpr)
@@ -909,17 +1069,17 @@ p_hsSpliceTH isTyped expr = \case
9091069
9101070p_hsBracket :: HsBracket GhcPs -> R ()
9111071p_hsBracket = \case
912− ExpBr NoExt expr -> do
1072+ ExpBr NoExtField expr -> do
9131073 anns <- getEnclosingAnns
9141074 let name = case anns of
915− AnnOpenEQ:_ -> ""
1075+ AnnOpenEQ : _ -> ""
9161076 _ -> "e"
9171077 quote name (located expr p_hsExpr)
918− PatBr NoExt pat -> quote "p" (located pat p_pat)
919− DecBrL NoExt decls -> quote "d" (p_hsDecls Free decls)
920− DecBrG NoExt _ -> notImplemented "DecBrG" -- result of renamer
921− TypBr NoExt ty -> quote "t" (located ty p_hsType)
922− 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
9231083 txt (bool "''" "'" isSingleQuote)
9241084 -- HACK As you can see we use 'noLoc' here to be able to pass name into
9251085 -- 'p_rdrName' since the latter expects a "located" thing. The problem
@@ -927,19 +1087,20 @@ p_hsBracket = \case
9271087 -- turn makes it impossible to detect if there are parentheses around
9281088 -- it, etc. So we have to add parentheses manually assuming they are
9291089 -- necessary for all operators.
930− let isOperator = all
931− (\i -> isPunctuation i || isSymbol i)
932− (showOutputable (rdrNameOcc name))
933− && not (doesNotNeedExtraParens name)
934− 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
9351096 wrapper $ p_rdrName (noLoc name)
936− TExpBr NoExt expr -> do
1097+ TExpBr NoExtField expr -> do
9371098 txt "[||"
9381099 breakpoint'
9391100 located expr p_hsExpr
9401101 breakpoint'
9411102 txt "||]"
942− XBracket {} -> notImplemented "XBracket"
1103+ XBracket x -> noExtCon x
9431104 where
9441105 quote :: Text -> R () -> R ()
9451106 quote name body = do
@@ -952,12 +1113,65 @@ p_hsBracket = \case
9521113 breakpoint'
9531114 txt "|]"
9541115
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+
9551163----------------------------------------------------------------------------
9561164-- Helpers
9571165
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+
9581173-- | Append each element in both lists with semigroups. If one list is shorter
9591174-- than the other, return the rest of the longer list unchanged.
960−
9611175liftAppend :: Semigroup a => [a] -> [a] -> [a]
9621176liftAppend [] [] = []
9631177liftAppend [] (y : ys) = y : ys
@@ -965,14 +1179,13 @@ liftAppend (x : xs) [] = x : xs
9651179liftAppend (x : xs) (y : ys) = x <> y : liftAppend xs ys
9661180
9671181getGRHSSpan :: GRHS GhcPs (Located body) -> SrcSpan
968−getGRHSSpan (GRHS NoExt guards body) =
1182+getGRHSSpan (GRHS NoExtField guards body) =
9691183 combineSrcSpans' $ getLoc body :| map getLoc guards
970−getGRHSSpan (XGRHS NoExt) = notImplemented "XGRHS"
1184+getGRHSSpan (XGRHS x) = noExtCon x
9711185
9721186-- | Place a thing that may have a hanging form. This function handles how
9731187-- to separate it from preceding expressions and whether to bump indentation
9741188-- depending on what sort of expression we have.
975−
9761189placeHanging :: Placement -> R () -> R ()
9771190placeHanging placement m =
9781191 case placement of
@@ -985,67 +1198,165 @@ placeHanging placement m =
9851198
9861199-- | Check if given block contains single expression which has a hanging
9871200-- form.
988−
989−blockPlacement
990− :: (body -> Placement)
991− -> [LGRHS GhcPs (Located body)]
992− -> Placement
993−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
9941206blockPlacement _ _ = Normal
9951207
9961208-- | Check if given command has a hanging form.
997−
9981209cmdPlacement :: HsCmd GhcPs -> Placement
9991210cmdPlacement = \case
1000− HsCmdLam NoExt _ -> Hanging
1001− HsCmdCase NoExt _ _ -> Hanging
1002− HsCmdDo NoExt _ -> Hanging
1211+ HsCmdLam NoExtField _ -> Hanging
1212+ HsCmdCase NoExtField _ _ -> Hanging
1213+ HsCmdDo NoExtField _ -> Hanging
10031214 _ -> Normal
10041215
10051216cmdTopPlacement :: HsCmdTop GhcPs -> Placement
10061217cmdTopPlacement = \case
1007− HsCmdTop NoExt (L _ x) -> cmdPlacement x
1008− XCmdTop {} -> notImplemented "XCmdTop"
1218+ HsCmdTop NoExtField (L _ x) -> cmdPlacement x
1219+ XCmdTop x -> noExtCon x
10091220
10101221-- | Check if given expression has a hanging form.
1011−
10121222exprPlacement :: HsExpr GhcPs -> Placement
10131223exprPlacement = \case
10141224 -- Only hang lambdas with single line parameter lists
1015− HsLam NoExt mg -> case mg of
1016− MG _ (L _ [L _ (Match NoExt _ (x:xs) _)]) _
1017− | isOneLineSpan (combineSrcSpans' $ fmap getLoc (x :| xs))
1018− -> 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
10191229 _ -> Normal
1020− HsLamCase NoExt _ -> Hanging
1021− HsCase NoExt _ _ -> Hanging
1022− HsDo NoExt DoExpr _ -> Hanging
1023− HsDo NoExt MDoExpr _ -> Hanging
1024− RecordCon NoExt _ _ -> Hanging
1025− -- If the rightmost expression in an operator chain is hanging, make the
1026− -- whole block hanging; so that we can use the common @f = foo $ do@
1027− -- style.
1028− OpApp NoExt _ _ y -> exprPlacement (unLoc y)
1029− 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 _ ->
10301240 -- Indentation breaks if pattern is longer than one line and left
10311241 -- hanging. Consequently, only apply hanging when it is safe.
1032− if isOneLineSpan s
1033− then Hanging
1034− else Normal
1242+ if isOneLineSpan (getLoc p)
1243+ then Hanging
1244+ else Normal
10351245 _ -> Normal
10361246
10371247withGuards :: [LGRHS GhcPs (Located body)] -> Bool
10381248withGuards = any (checkOne . unLoc)
10391249 where
10401250 checkOne :: GRHS GhcPs (Located body) -> Bool
1041− checkOne (GRHS NoExt [] _) = False
1251+ checkOne (GRHS NoExtField [] _) = False
10421252 checkOne _ = True
10431253
1044−-- | Get annotations for the enclosing element.
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
10451265
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.
10461357getEnclosingAnns :: R [AnnKeywordId]
10471358getEnclosingAnns = do
10481359 e <- getEnclosingSpan (const True)
10491360 case e of
10501361 Nothing -> return []
1051− Just e' -> getAnns (RealSrcSpan e')
1362+ Just e' -> getAnns (RealSrcSpan e')