@@ -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
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
40+-- | Style of a group of equations.
3441data MatchGroupStyle
3542 = Function (Located RdrName)
3643 | PatternBind
@@ -38,55 +45,62 @@ 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 ()
5767p_valDecl = \case
58− FunBind NoExt funId funMatches _ _ -> p_funBind funId funMatches
59− 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
6070 VarBind {} -> notImplemented "VarBinds" -- introduced by the type checker
6171 AbsBinds {} -> notImplemented "AbsBinds" -- introduced by the type checker
62− PatSynBind NoExt psb -> p_patSynBind psb
63− XHsBindsLR NoExt -> notImplemented "XHsBindsLR"
72+ PatSynBind NoExtField psb -> p_patSynBind psb
73+ XHsBindsLR x -> noExtCon x
6474
65−p_funBind
66− :: Located RdrName
67− -> MatchGroup GhcPs (LHsExpr GhcPs)
68− -> R ()
75+p_funBind ::
76+ Located RdrName ->
77+ MatchGroup GhcPs (LHsExpr GhcPs) ->
78+ R ()
6979p_funBind name = p_matchGroup (Function name)
7080
71−p_matchGroup
72− :: MatchGroupStyle
73− -> MatchGroup GhcPs (LHsExpr GhcPs)
74− -> R ()
81+p_matchGroup ::
82+ MatchGroupStyle ->
83+ MatchGroup GhcPs (LHsExpr GhcPs) ->
84+ R ()
7585p_matchGroup = p_matchGroup' exprPlacement p_hsExpr
7686
77−p_matchGroup'
78− :: Data body
79− => (body -> Placement)
80− -> (body -> R ())
81− -> MatchGroupStyle
82− -> MatchGroup GhcPs (Located body)
83− -> R ()
84−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
8599 let ob = case style of
86100 Case -> id
87101 LambdaCase -> id
88102 _ -> dontUseBraces
89− -- 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
90104 -- restore the brace state inside the sepsemi.
91105 ub <- bool dontUseBraces useBraces <$> canUseBraces
92106 ob $ sepSemi (located' (ub . p_Match)) (unLoc mg_alts)
@@ -94,14 +108,14 @@ p_matchGroup' placer pretty style MG {..} = do
94108 p_Match m@Match {..} =
95109 p_match'
96110 placer
97− pretty
111+ render
98112 (adjustMatchGroupStyle m style)
99113 (isInfixMatch m)
100114 (matchStrictness m)
101115 m_pats
102116 m_grhss
103− p_Match _ = notImplemented "XMatch"
104−p_matchGroup' _ _ _ (XMatchGroup NoExt) = notImplemented "XMatchGroup"
117+ p_Match (XMatch x) = noExtCon x
118+p_matchGroup' _ _ _ (XMatchGroup x) = noExtCon x
105119
106120-- | Function id obtained through pattern matching on 'FunBind' should not
107121-- be used to print the actual equations because the different ‘RdrNames’
@@ -109,11 +123,10 @@ p_matchGroup' _ _ _ (XMatchGroup NoExt) = notImplemented "XMatchGroup"
109123-- and paretheses) associated with them. It is necessary to use per-equation
110124-- names obtained from 'm_ctxt' of 'Match'. This function replaces function
111125-- name inside of 'Function' accordingly.
112−
113−adjustMatchGroupStyle
114− :: Match GhcPs body
115− -> MatchGroupStyle
116− -> MatchGroupStyle
126+adjustMatchGroupStyle ::
127+ Match GhcPs body ->
128+ MatchGroupStyle ->
129+ MatchGroupStyle
117130adjustMatchGroupStyle m = \case
118131 Function _ -> (Function . mc_fun . m_ctxt) m
119132 style -> style
@@ -121,31 +134,43 @@ adjustMatchGroupStyle m = \case
121134matchStrictness :: Match id body -> SrcStrictness
122135matchStrictness match =
123136 case m_ctxt match of
124− FunRhs{mc_strictness=s} -> s
137+ FunRhs {mc_strictness = s} -> s
125138 _ -> NoSrcStrict
126139
127−p_match
128− :: MatchGroupStyle
129− -> Bool -- ^ Is this an infix match?
130− -> SrcStrictness -- ^ Strictness prefix (FunBind)
131− -> [LPat GhcPs]
132− -> GRHSs GhcPs (LHsExpr GhcPs)
133− -> 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 ()
134152p_match = p_match' exprPlacement p_hsExpr
135153
136−p_match'
137− :: Data body
138− => (body -> Placement)
139− -> (body -> R ())
140− -> MatchGroupStyle
141− -> Bool -- ^ Is this an infix match?
142− -> SrcStrictness -- ^ Strictness prefix (FunBind)
143− -> [LPat GhcPs]
144− -> GRHSs GhcPs (Located body)
145− -> R ()
146−p_match' placer pretty style isInfix strictness m_pats m_grhss = do
147− -- NOTE Normally, since patterns may be placed in a multi-line layout, it
148− -- 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
149174 -- indented than function name. This in turn means that indentation for
150175 -- the body should also be bumped. Normally this would mean that bodies
151176 -- would start with two indentation steps applied, which is ugly, so we
@@ -155,23 +180,24 @@ p_match' placer pretty style isInfix strictness m_pats m_grhss = do
155180 NoSrcStrict -> return ()
156181 SrcStrict -> txt "!"
157182 SrcLazy -> txt "~"
158− inci' <- case NE.nonEmpty m_pats of
159− Nothing -> id <$ case style of
160− Function name -> p_rdrName name
161− _ -> return ()
183+ indentBody <- case NE.nonEmpty m_pats of
184+ Nothing ->
185+ False <$ case style of
186+ Function name -> p_rdrName name
187+ _ -> return ()
162188 Just ne_pats -> do
163− let combinedSpans = combineSrcSpans' $
164− getLoc <$> ne_pats
165− inci' = if isOneLineSpan combinedSpans
166− then id
167− 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)
168194 switchLayout [combinedSpans] $ do
169195 let stdCase = sep breakpoint (located' p_pat) m_pats
170196 case style of
171197 Function name ->
172198 p_infixDefHelper
173199 isInfix
174− inci'
200+ indentBody
175201 (p_rdrName name)
176202 (located' p_pat <$> m_pats)
177203 PatternBind -> stdCase
@@ -186,46 +212,40 @@ p_match' placer pretty style isInfix strictness m_pats m_grhss = do
186212 when needsSpace space
187213 sitcc stdCase
188214 LambdaCase -> stdCase
189− return inci'
190− let
191− -- Calculate position of end of patterns. This is useful when we decide
192− -- about putting certain constructions in hanging positions.
193− endOfPats = case NE.nonEmpty m_pats of
194− Nothing -> case style of
195− Function name -> (Just . srcSpanEnd . getLoc) name
196− _ -> Nothing
197− Just pats -> (Just . srcSpanEnd . getLoc . NE.last) pats
198− isCase = \case
199− Case -> True
200− LambdaCase -> True
201− _ -> False
202− 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
203227 hasGuards = withGuards grhssGRHSs
204− unless (length grhssGRHSs > 1) $ do
205− case style of
206− Function _ | hasGuards -> return ()
207− Function _ -> space >> txt "="
208− PatternBind -> space >> txt "="
209− s | isCase s && hasGuards -> return ()
210− _ -> space >> txt "->"
211− let grhssSpan = combineSrcSpans' $
212− getGRHSSpan . unLoc <$> NE.fromList grhssGRHSs
213− patGrhssSpan = maybe grhssSpan
214− (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
215236 placement =
216237 case endOfPats of
217238 Nothing -> blockPlacement placer grhssGRHSs
218239 Just spn ->
219− if isOneLineSpan
220− (mkSrcSpan spn (srcSpanStart grhssSpan))
240+ if onTheSameLine spn grhssSpan
221241 then blockPlacement placer grhssGRHSs
222242 else Normal
223243 p_body = do
224244 let groupStyle =
225245 if isCase style && hasGuards
226− then RightArrow
227− else EqualSign
228− sep newline (located' (p_grhs' pretty groupStyle)) grhssGRHSs
246+ then RightArrow
247+ else EqualSign
248+ sep newline (located' (p_grhs' placer render groupStyle)) grhssGRHSs
229249 p_where = do
230250 let whereIsEmpty = GHC.isEmptyLocalBindsPR (unLoc grhssLocalBinds)
231251 unless (GHC.eqEmptyLocalBinds (unLoc grhssLocalBinds)) $ do
@@ -233,175 +253,211 @@ p_match' placer pretty style isInfix strictness m_pats m_grhss = do
233253 txt "where"
234254 unless whereIsEmpty breakpoint
235255 inci $ located grhssLocalBinds p_hsLocalBinds
236− 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 "->"
237264 switchLayout [patGrhssSpan] $
238265 placeHanging placement p_body
239266 inci p_where
267+p_match' _ _ _ _ _ _ (XGRHSs x) = noExtCon x
240268
241269p_grhs :: GroupStyle -> GRHS GhcPs (LHsExpr GhcPs) -> R ()
242−p_grhs = p_grhs' p_hsExpr
270+p_grhs = p_grhs' exprPlacement p_hsExpr
243271
244−p_grhs'
245− :: Data body
246− => (body -> R ())
247− -> GroupStyle
248− -> GRHS GhcPs (Located body)
249− -> R ()
250−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) =
251282 case guards of
252283 [] -> p_body
253284 xs -> do
254285 txt "|"
255286 space
256− sitcc (sep (comma >> breakpoint) (sitcc . located' p_stmt) xs)
287+ sitcc (sep commaDel (sitcc . located' p_stmt) xs)
257288 space
258− txt $ case style of
259− EqualSign -> "="
260− RightArrow -> "->"
261− breakpoint
262− inci p_body
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− space
272− case arrType of
273− HsFirstOrderApp -> txt "-<"
274− HsHigherOrderApp -> txt "-<<"
275− placeHanging (exprPlacement (unLoc input)) $
276− located input p_hsExpr
277− 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
278320 located form p_hsExpr
279321 unless (null cmds) $ do
280322 breakpoint
281323 inci (sequence_ (intersperse breakpoint (located' p_hsCmdTop <$> cmds)))
282− HsCmdArrForm NoExt form Infix _ [left, right] -> do
324+ HsCmdArrForm NoExtField form Infix _ [left, right] -> do
283325 located left p_hsCmdTop
284326 space
285327 located form p_hsExpr
286328 placeHanging (cmdTopPlacement (unLoc right)) $
287329 located right p_hsCmdTop
288− HsCmdArrForm NoExt _ Infix _ _ -> notImplemented "HsCmdArrForm"
330+ HsCmdArrForm NoExtField _ Infix _ _ -> notImplemented "HsCmdArrForm"
289331 HsCmdApp {} ->
290332 -- XXX Does this ever occur in the syntax tree? It does not seem like it
291333 -- does. Open an issue and ping @yumiova if this ever occurs in output.
292334 notImplemented "HsCmdApp"
293− HsCmdLam NoExt mgroup -> p_matchGroup' cmdPlacement p_hsCmd Lambda mgroup
294− HsCmdPar NoExt c -> parens (located c p_hsCmd)
295− HsCmdCase NoExt e mgroup -> do
296− txt "case"
297− space
298− located e p_hsExpr
299− space
300− txt "of"
301− breakpoint
302− inci (p_matchGroup' cmdPlacement p_hsCmd Case mgroup)
303− HsCmdIf NoExt _ if' then' else' -> do
304− txt "if"
305− space
306− located if' p_hsExpr
307− breakpoint
308− txt "then"
309− located then' $ \x -> do
310− breakpoint
311− inci (p_hsCmd x)
312− breakpoint
313− txt "else"
314− located else' $ \x -> do
315− breakpoint
316− inci (p_hsCmd x)
317− HsCmdLet NoExt localBinds c -> do
318− txt "let"
319− space
320− sitcc (located localBinds p_hsLocalBinds)
321− breakpoint
322− txt "in"
323− space
324− sitcc (located c p_hsCmd)
325− 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
326344 txt "do"
327345 newline
328− 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))
329348 HsCmdWrap {} -> notImplemented "HsCmdWrap"
330− XCmd {} -> notImplemented "XCmd"
349+ XCmd x -> noExtCon x
331350
332351p_hsCmdTop :: HsCmdTop GhcPs -> R ()
333352p_hsCmdTop = \case
334− HsCmdTop NoExt cmd -> located cmd p_hsCmd
335− 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)
336384
337385p_stmt :: Stmt GhcPs (LHsExpr GhcPs) -> R ()
338−p_stmt = p_stmt' p_hsExpr
386+p_stmt = p_stmt' exprPlacement p_hsExpr
339387
340−p_stmt'
341− :: Data body
342− => (body -> R ())
343− -> Stmt GhcPs (Located body)
344− -> R ()
345−p_stmt' pretty = \case
346− LastStmt NoExt body _ _ -> located body pretty
347− BindStmt NoExt l f _ _ -> do
348− 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
349401 space
350402 txt "<-"
351− breakpoint
352− 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)
353413 ApplicativeStmt {} -> notImplemented "ApplicativeStmt" -- generated by renamer
354− BodyStmt NoExt body _ _ -> located body pretty
355− LetStmt NoExt binds -> do
414+ BodyStmt NoExtField body _ _ -> located body render
415+ LetStmt NoExtField binds -> do
356416 txt "let"
357417 space
358418 sitcc $ located binds p_hsLocalBinds
359419 ParStmt {} ->
360− -- NOTE 'ParStmt' should always be eliminated in 'gatherStmt' already,
361− -- such that it never occurs in 'p_stmt''. Consequently, handling it
362− -- 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.
363423 notImplemented "ParStmt"
364− TransStmt {..} -> do
365− -- NOTE 'TransStmt' only needs to account for pretty printing itself,
366− -- since pretty printing of relevant statements (e.g., in 'trS_stmts')
367− -- 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'.
368428 case (trS_form, trS_by) of
369− (ThenForm, Nothing) -> located trS_using $ \x -> do
429+ (ThenForm, Nothing) -> do
370430 txt "then"
371431 breakpoint
372− inci (p_hsExpr x)
432+ inci $ located trS_using p_hsExpr
373433 (ThenForm, Just e) -> do
374− located trS_using $ \x -> do
375− txt "then"
376− breakpoint
377− inci (p_hsExpr x)
434+ txt "then"
378435 breakpoint
379− located e $ \x -> do
380− txt "by"
381− breakpoint
382− inci (p_hsExpr x)
383− (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
384442 txt "then group using"
385443 breakpoint
386− inci (p_hsExpr x)
444+ inci $ located trS_using p_hsExpr
387445 (GroupForm, Just e) -> do
388− located e $ \x -> do
389− txt "then group by"
390− breakpoint
391− inci (p_hsExpr x)
446+ txt "then group by"
392447 breakpoint
393− located trS_using $ \x -> do
394− txt "using"
395− breakpoint
396− inci (p_hsExpr x)
448+ inci $ located e p_hsExpr
449+ breakpoint
450+ txt "using"
451+ breakpoint
452+ inci $ located trS_using p_hsExpr
397453 RecStmt {..} -> do
398454 txt "rec"
399455 space
400− sitcc $ sepSemi (located' (p_stmt' pretty)) recS_stmts
401− XStmtLR {} -> notImplemented "XStmtLR"
456+ sitcc $ sepSemi (withSpacing (p_stmt' placer render)) recS_stmts
457+ XStmtLR c -> noExtCon c
402458
403459gatherStmt :: ExprLStmt GhcPs -> [[ExprLStmt GhcPs]]
404−gatherStmt (L _ (ParStmt NoExt block _ _)) =
460+gatherStmt (L _ (ParStmt NoExtField block _ _)) =
405461 foldr ((<>) . gatherStmtBlock) [] block
406462gatherStmt (L s stmt@TransStmt {..}) =
407463 foldr liftAppend [] ((gatherStmt <$> trS_stmts) <> pure [[L s stmt]])
@@ -410,195 +466,230 @@ gatherStmt stmt = [[stmt]]
410466gatherStmtBlock :: ParStmtBlock GhcPs GhcPs -> [[ExprLStmt GhcPs]]
411467gatherStmtBlock (ParStmtBlock _ stmts _ _) =
412468 foldr (liftAppend . gatherStmt) [] stmts
413−gatherStmtBlock XParStmtBlock {} = notImplemented "XParStmtBlock"
469+gatherStmtBlock (XParStmtBlock x) = noExtCon x
414470
415471p_hsLocalBinds :: HsLocalBindsLR GhcPs GhcPs -> R ()
416472p_hsLocalBinds = \case
417− HsValBinds NoExt (ValBinds NoExt bag lsigs) -> do
418− let ssStart = either
419− (srcSpanStart . getLoc)
420− (srcSpanStart . getLoc)
421− items =
422− (Left <$> bagToList bag) ++ (Right <$> lsigs)
423− p_item (Left x) = located x p_valDecl
424− p_item (Right x) = located x p_sigDecl
425− -- Assigns 'False' to the last element, 'True' to the rest.
426− markInit :: [a] -> [(Bool, a)]
427− markInit [] = []
428− markInit (x:[]) = [(False, x)]
429− markInit (x:xs) = (True, x) : markInit xs
430− -- 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
431475 -- elements will also contain semicolons and they will confuse the
432476 -- parser. so we request braces around every element except the last.
433− br <- vlayout (return useBraces) (return id)
434− sitcc $ sepSemi
435− (\(m, i) -> (if m then br else id) $ p_item i)
436− (markInit $ sortOn ssStart items)
437− HsValBinds NoExt _ -> notImplemented "HsValBinds"
438− 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) ->
439494 -- Second argument of IPBind is always Left before type-checking.
440− let p_ipBind (IPBind NoExt (Left name) expr) = do
495+ let p_ipBind (IPBind NoExtField (Left name) expr) = do
441496 atom name
442497 space
443− txt "="
498+ equals
444499 breakpoint
445500 useBraces $ inci $ located expr p_hsExpr
446− 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
447505 in sepSemi (located' p_ipBind) xs
448− HsIPBinds NoExt _ -> notImplemented "HsIpBinds"
449− EmptyLocalBinds NoExt -> return ()
450− XHsLocalBindsLR _ -> notImplemented "XHsLocalBindsLR"
506+ HsIPBinds NoExtField _ -> notImplemented "HsIpBinds"
507+ EmptyLocalBinds NoExtField -> return ()
508+ XHsLocalBindsLR x -> noExtCon x
451509
452−p_hsRecField
453− :: (Data id, Outputable id)
454− => HsRecField' id (LHsExpr GhcPs)
455− -> R ()
456−p_hsRecField = \HsRecField {..} -> do
457− located hsRecFieldLbl atom
510+p_hsRecField ::
511+ HsRecField' RdrName (LHsExpr GhcPs) ->
512+ R ()
513+p_hsRecField HsRecField {..} = do
514+ p_rdrName hsRecFieldLbl
458515 unless hsRecPun $ do
459516 space
460− txt "="
461− let placement = exprPlacement (unLoc hsRecFieldArg)
462− placeHanging placement $ located hsRecFieldArg p_hsExpr
463−
464−p_hsTupArg :: HsTupArg GhcPs -> R ()
465−p_hsTupArg = \case
466− Present NoExt x -> located x p_hsExpr
467− Missing NoExt -> pure ()
468− 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)
469523
470524p_hsExpr :: HsExpr GhcPs -> R ()
471−p_hsExpr = \case
472− HsVar NoExt name -> p_rdrName name
473− HsUnboundVar NoExt _ -> notImplemented "HsUnboundVar"
474− HsConLikeOut NoExt _ -> notImplemented "HsConLikeOut"
475− 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 ->
476533 case x of
477− Unambiguous NoExt name -> p_rdrName name
478− Ambiguous NoExt name -> p_rdrName name
479− XAmbiguousFieldOcc NoExt -> notImplemented "XAmbiguousFieldOcc"
480− 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
481538 txt "#"
482539 atom v
483− HsIPVar NoExt (HsIPName name) -> do
540+ HsIPVar NoExtField (HsIPName name) -> do
484541 txt "?"
485542 atom name
486− HsOverLit NoExt v -> atom (ol_val v)
487− HsLit NoExt lit -> atom lit
488− 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 ->
489550 p_matchGroup Lambda mgroup
490− HsLamCase NoExt mgroup -> do
551+ HsLamCase NoExtField mgroup -> do
491552 txt "\\case"
492− newline
553+ breakpoint
493554 inci (p_matchGroup LambdaCase mgroup)
494− HsApp NoExt f x -> sitcc $ do
495− located f p_hsExpr
496− -- Second argument can be a `do` or `case` block with `-XBlockArguments`.
497− placeHanging (exprPlacement (unLoc x)) $
498− located x p_hsExpr
499− 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
500612 located e p_hsExpr
501613 breakpoint
502614 inci $ do
503615 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 ()
504621 located (hswc_body a) p_hsType
505− OpApp NoExt x op y -> do
506− -- NOTE If the beginning of the first argument and the second argument
507− -- are on the same line, and the second argument has a hanging form, use
508− -- hanging placement.
509− let placement =
510− if isOneLineSpan
511− (mkSrcSpan (srcSpanStart (getLoc x)) (srcSpanStart (getLoc y)))
512− then exprPlacement (unLoc y)
513− else Normal
514− opWrapper = case unLoc op of
515− EWildPat NoExt -> backticks
516− _ -> id
517− ub <- vlayout
518− (return useBraces)
519− (return $ case placement of
520− Hanging -> useBraces
521− Normal -> dontUseBraces)
522− ub $ located x p_hsExpr
523− placeHanging placement $ do
524− located op (opWrapper . p_hsExpr)
525− space
526− located y p_hsExpr
527− 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
528626 txt "-"
529627 space
530628 located e p_hsExpr
531− HsPar NoExt e -> parens (located e p_hsExpr)
532− SectionL NoExt x op -> do
629+ HsPar NoExtField e ->
630+ parens s (located e (dontUseBraces . p_hsExpr))
631+ SectionL NoExtField x op -> do
533632 located x p_hsExpr
534633 breakpoint
535634 inci (located op p_hsExpr)
536− SectionR NoExt op x -> do
635+ SectionR NoExtField op x -> do
537636 located op p_hsExpr
538− breakpoint
637+ useRecordDot' <- useRecordDot
638+ let isRecordDot' = isRecordDot (unLoc op) (getLoc x)
639+ unless (useRecordDot' && isRecordDot') breakpoint
539640 inci (located x p_hsExpr)
540− ExplicitTuple NoExt args boxity -> do
641+ ExplicitTuple NoExtField args boxity ->
541642 let isSection = any (isMissing . unLoc) args
542643 isMissing = \case
543− Missing NoExt -> True
644+ Missing NoExtField -> True
544645 _ -> False
545− 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' =
546652 case boxity of
547653 Boxed -> parens
548654 Unboxed -> parensHash
549− if isSection
550− then switchLayout [] . parens' $
551− sep comma (located' p_hsTupArg) args
552− else switchLayout (getLoc <$> args) . parens' . sitcc $
553− sep (comma >> breakpoint) (sitcc . located' p_hsTupArg) args
554− ExplicitSum NoExt tag arity e ->
555− p_unboxedSum tag arity (located e p_hsExpr)
556− HsCase NoExt e mgroup -> do
557− txt "case"
558− space
559− located e p_hsExpr
560− space
561− txt "of"
562− breakpoint
563− inci (p_matchGroup Case mgroup)
564− HsIf NoExt _ if' then' else' -> do
565− txt "if"
566− space
567− located if' p_hsExpr
568− breakpoint
569− inci $ do
570− txt "then"
571− located then' $ \x ->
572− placeHanging (exprPlacement x) (p_hsExpr x)
573− breakpoint
574− txt "else"
575− located else' $ \x ->
576− placeHanging (exprPlacement x) (p_hsExpr x)
577− 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
578669 txt "if"
579670 breakpoint
580− inci . sitcc $ sep newline (located' (p_grhs RightArrow)) guards
581− HsLet NoExt localBinds e -> sitcc $ do
582− txt "let"
583− space
584− dontUseBraces $ sitcc (located localBinds p_hsLocalBinds)
585− vlayout space (newline >> txt " ")
586− txt "in"
587− space
588− sitcc (located e p_hsExpr)
589− 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
590675 let doBody header = do
591676 txt header
592677 breakpoint
593− ub <- vlayout (return useBraces) (return id)
594− inci $ sepSemi (located' (ub . p_stmt)) (unLoc es)
595− compBody = brackets $ located es $ \xs -> do
596− let p_parBody = sep
597− (breakpoint >> txt "| ")
598− p_seqBody
599− p_seqBody = sitcc . sep
600− (comma >> breakpoint)
601− (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))
602693 stmts = init xs
603694 yield = last xs
604695 lists = foldr (liftAppend . gatherStmt) [] stmts
@@ -612,76 +703,100 @@ p_hsExpr = \case
612703 MDoExpr -> doBody "mdo"
613704 ListComp -> compBody
614705 MonadComp -> notImplemented "MonadComp"
615− ArrowExpr -> notImplemented "ArrowExpr"
706+ ArrowExpr -> notImplemented "ArrowExpr"
616707 GhciStmtCtxt -> notImplemented "GhciStmtCtxt"
617708 PatGuard _ -> notImplemented "PatGuard"
618709 ParStmtCtxt _ -> notImplemented "ParStmtCtxt"
619710 TransStmtCtxt _ -> notImplemented "TransStmtCtxt"
620711 ExplicitList _ _ xs ->
621− brackets . sitcc $ sep (comma >> breakpoint) (sitcc . located' p_hsExpr) xs
712+ brackets s $
713+ sep commaDel (sitcc . located' p_hsExpr) xs
622714 RecordCon {..} -> do
623715 located rcon_con_name atom
624716 breakpoint
625717 let HsRecFields {..} = rcon_flds
626− 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
627725 dotdot =
628726 case rec_dotdot of
629727 Just {} -> [txt ".."]
630728 Nothing -> []
631− inci . braces . sitcc $ sep (comma >> breakpoint) sitcc (fields <> dotdot)
729+ inci . braces N $
730+ sep commaDel sitcc (fields <> dotdot)
632731 RecordUpd {..} -> do
633732 located rupd_expr p_hsExpr
634− breakpoint
635− inci . braces . sitcc $
636− sep (comma >> breakpoint) (sitcc . located' p_hsRecField) rupd_flds
637− 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
638754 located x p_hsExpr
755+ space
756+ txt "::"
639757 breakpoint
640− inci $ do
641− txt "::"
642− space
643− let HsWC {..} = affix
644− HsIB {..} = hswc_body
645− located hsib_body p_hsType
646− 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 ->
647762 case x of
648− From from -> brackets . sitcc $ do
763+ From from -> brackets s $ do
649764 located from p_hsExpr
650765 breakpoint
651766 txt ".."
652− FromThen from next -> brackets . sitcc $ do
653− sitcc $ sep (comma >> breakpoint) (located' p_hsExpr) [from, next]
767+ FromThen from next -> brackets s $ do
768+ sep commaDel (located' p_hsExpr) [from, next]
654769 breakpoint
655770 txt ".."
656− FromTo from to -> brackets . sitcc $ do
771+ FromTo from to -> brackets s $ do
657772 located from p_hsExpr
658773 breakpoint
659774 txt ".."
660775 space
661776 located to p_hsExpr
662− FromThenTo from next to -> brackets . sitcc $ do
663− 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]
664779 breakpoint
665780 txt ".."
666781 space
667782 located to p_hsExpr
668− HsSCC NoExt _ name x -> do
783+ HsSCC NoExtField _ name x -> do
669784 txt "{-# SCC "
670785 atom name
671786 txt " #-}"
672787 breakpoint
673788 located x p_hsExpr
674− HsCoreAnn NoExt _ value x -> do
789+ HsCoreAnn NoExtField _ value x -> do
675790 txt "{-# CORE "
676791 atom value
677792 txt " #-}"
678793 breakpoint
679794 located x p_hsExpr
680− HsBracket NoExt x -> p_hsBracket x
795+ HsBracket NoExtField x -> p_hsBracket x
681796 HsRnBracketOut {} -> notImplemented "HsRnBracketOut"
682797 HsTcBracketOut {} -> notImplemented "HsTcBracketOut"
683− HsSpliceE NoExt splice -> p_hsSplice splice
684− HsProc NoExt p e -> do
798+ HsSpliceE NoExtField splice -> p_hsSplice splice
799+ HsProc NoExtField p e -> do
685800 txt "proc"
686801 located p $ \x -> do
687802 breakpoint
@@ -690,96 +805,159 @@ p_hsExpr = \case
690805 txt "->"
691806 placeHanging (cmdTopPlacement (unLoc e)) $
692807 located e p_hsCmdTop
693− HsStatic _ e -> do
808+ HsStatic _ e -> do
694809 txt "static"
695810 breakpoint
696811 inci (located e p_hsExpr)
697− HsArrApp NoExt body input arrType cond ->
698− p_hsCmd (HsCmdArrApp NoExt body input arrType cond)
699− HsArrForm NoExt form mfixity cmds ->
700− p_hsCmd (HsCmdArrForm NoExt form Prefix mfixity cmds)
701812 HsTick {} -> notImplemented "HsTick"
702813 HsBinTick {} -> notImplemented "HsBinTick"
703814 HsTickPragma {} -> notImplemented "HsTickPragma"
704− EWildPat NoExt -> txt "_"
705− EAsPat {} -> notImplemented "EAsPat"
706− EViewPat {} -> notImplemented "EViewPat"
707− ELazyPat {} -> notImplemented "ELazyPat"
708815 HsWrap {} -> notImplemented "HsWrap"
709− XExpr {} -> notImplemented "XExpr"
816+ XExpr x -> noExtCon x
710817
711818p_patSynBind :: PatSynBind GhcPs GhcPs -> R ()
712819p_patSynBind PSB {..} = do
713− txt "pattern"
714− space
715− case psb_dir of
716− Unidirectional -> do
717− p_rdrName psb_id
718− inci $ do
719− p_patSynDetails psb_args
820+ let rhs = do
720821 space
721− txt "<-"
722− breakpoint
723− located psb_def p_pat
724− ImplicitBidirectional -> do
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
725843 p_rdrName psb_id
726844 inci $ do
727− p_patSynDetails psb_args
728− space
729− txt "="
730− breakpoint
731− located psb_def p_pat
732− 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
733851 p_rdrName psb_id
734852 inci $ do
735− p_patSynDetails psb_args
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
736860 space
737− txt "<-"
861+ p_rdrName l
738862 breakpoint
739− located psb_def p_pat
740− newline
741− line (txt "where")
742− inci (p_matchGroup (Function psb_id) mgroup)
743−p_patSynBind (XPatSynBind NoExt) = notImplemented "XPatSynBind"
863+ inci $ do
864+ p_rdrName psb_id
865+ space
866+ p_rdrName r
867+ inci rhs
868+p_patSynBind (XPatSynBind x) = noExtCon x
744869
745−p_patSynDetails :: HsPatSynDetails (Located RdrName) -> R ()
746−p_patSynDetails = \case
747− PrefixCon xs ->
748− switchLayout (getLoc <$> xs) $ do
749− unless (null xs) breakpoint
750− sitcc (sep breakpoint p_rdrName xs)
751− RecCon xs ->
752− switchLayout (getLoc . recordPatSynPatVar <$> xs) $ do
753− unless (null xs) breakpoint
754− braces . sitcc $ sep (comma >> breakpoint) (p_rdrName . recordPatSynPatVar) xs
755− InfixCon _ _ -> notImplemented "InfixCon"
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)
756934
757935p_pat :: Pat GhcPs -> R ()
758936p_pat = \case
759− WildPat NoExt -> txt "_"
760− VarPat NoExt name -> p_rdrName name
761− LazyPat NoExt pat -> do
937+ WildPat NoExtField -> txt "_"
938+ VarPat NoExtField name -> p_rdrName name
939+ LazyPat NoExtField pat -> do
762940 txt "~"
763941 located pat p_pat
764− AsPat NoExt name pat -> do
942+ AsPat NoExtField name pat -> do
765943 p_rdrName name
766944 txt "@"
767945 located pat p_pat
768− ParPat NoExt pat ->
769− located pat (parens . p_pat)
770− BangPat NoExt pat -> do
946+ ParPat NoExtField pat ->
947+ located pat (parens S . p_pat)
948+ BangPat NoExtField pat -> do
771949 txt "!"
772950 located pat p_pat
773− ListPat NoExt pats -> do
774− brackets . sitcc $ sep (comma >> breakpoint) (located' p_pat) pats
775− TuplePat NoExt pats boxing -> do
776− let f =
951+ ListPat NoExtField pats ->
952+ brackets S $ sep commaDel (located' p_pat) pats
953+ TuplePat NoExtField pats boxing -> do
954+ let parens' =
777955 case boxing of
778− Boxed -> parens
779− Unboxed -> parensHash
780− f . sitcc $ sep (comma >> breakpoint) (sitcc . located' p_pat) pats
781− SumPat NoExt pat tag arity ->
782− 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)
783961 ConPatIn pat details ->
784962 case details of
785963 PrefixCon xs -> sitcc $ do
@@ -793,37 +971,40 @@ p_pat = \case
793971 let f = \case
794972 Nothing -> txt ".."
795973 Just x -> located x p_pat_hsRecField
796− inci . braces . sitcc . sep (comma >> breakpoint) f $ case dotdot of
797− Nothing -> Just <$> fields
798− Just n -> (Just <$> take n fields) ++ [Nothing]
799− InfixCon x y -> do
800− located x p_pat
801− space
802− p_rdrName pat
803− breakpoint
804− 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
805986 ConPatOut {} -> notImplemented "ConPatOut" -- presumably created by renamer?
806− ViewPat NoExt expr pat -> sitcc $ do
987+ ViewPat NoExtField expr pat -> sitcc $ do
807988 located expr p_hsExpr
808989 space
809990 txt "->"
810991 breakpoint
811992 inci (located pat p_pat)
812− SplicePat NoExt splice -> p_hsSplice splice
813− LitPat NoExt p -> atom p
814− NPat NoExt v _ _ -> located v (atom . ol_val)
815− 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
816997 p_rdrName n
817998 breakpoint
818999 inci $ do
8191000 txt "+"
8201001 space
8211002 located k (atom . ol_val)
822− SigPat hswc pat -> do
1003+ SigPat NoExtField pat hswc -> do
8231004 located pat p_pat
8241005 p_typeAscription hswc
8251006 CoPat {} -> notImplemented "CoPat" -- apparently created at some later stage
826− XPat NoExt -> notImplemented "XPat"
1007+ XPat x -> noExtCon x
8271008
8281009p_pat_hsRecField :: HsRecField' (FieldOcc GhcPs) (LPat GhcPs) -> R ()
8291010p_pat_hsRecField HsRecField {..} = do
@@ -831,72 +1012,74 @@ p_pat_hsRecField HsRecField {..} = do
8311012 p_rdrName (rdrNameFieldOcc x)
8321013 unless hsRecPun $ do
8331014 space
834− txt "="
1015+ equals
8351016 breakpoint
8361017 inci (located hsRecFieldArg p_pat)
8371018
838−p_unboxedSum :: ConTag -> Arity -> R () -> R ()
839−p_unboxedSum tag arity m = do
1019+p_unboxedSum :: BracketStyle -> ConTag -> Arity -> R () -> R ()
1020+p_unboxedSum s tag arity m = do
8401021 let before = tag - 1
8411022 after = arity - before - 1
8421023 args = replicate before Nothing <> [Just m] <> replicate after Nothing
843− f (x,i) = do
844− let isFirst = i == 0
845− isLast = i == arity - 1
1024+ f x =
8461025 case x :: Maybe (R ()) of
8471026 Nothing ->
848− unless (isFirst || isLast) space
1027+ space
8491028 Just m' -> do
850− unless isFirst space
1029+ space
8511030 m'
852− unless isLast space
853− parensHash $ sep (txt "|") f (zip args [0..])
1031+ space
1032+ parensHash s $ sep (txt "|") f args
8541033
8551034p_hsSplice :: HsSplice GhcPs -> R ()
8561035p_hsSplice = \case
857− HsTypedSplice NoExt deco _ expr -> p_hsSpliceTH True expr deco
858− HsUntypedSplice NoExt deco _ expr -> p_hsSpliceTH False expr deco
859− 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
8601039 txt "["
8611040 p_rdrName (L srcSpan quoterName)
8621041 txt "|"
863− -- NOTE QuasiQuoters often rely on precise custom strings. We cannot do
864− -- 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.
8651044 atom str
8661045 txt "|]"
8671046 HsSpliced {} -> notImplemented "HsSpliced"
868− XSplice {} -> notImplemented "XSplice"
1047+ HsSplicedT {} -> notImplemented "HsSplicedT"
1048+ XSplice x -> noExtCon x
8691049
870−p_hsSpliceTH
871− :: Bool -- ^ Typed splice?
872− -> LHsExpr GhcPs -- ^ Splice expression
873− -> SpliceDecoration -- ^ Splice decoration
874− -> R ()
1050+p_hsSpliceTH ::
1051+ -- | Typed splice?
1052+ Bool ->
1053+ -- | Splice expression
1054+ LHsExpr GhcPs ->
1055+ -- | Splice decoration
1056+ SpliceDecoration ->
1057+ R ()
8751058p_hsSpliceTH isTyped expr = \case
8761059 HasParens -> do
8771060 txt decoSymbol
878− parens (located expr (sitcc . p_hsExpr))
1061+ parens N (located expr (sitcc . p_hsExpr))
8791062 HasDollar -> do
8801063 txt decoSymbol
8811064 located expr (sitcc . p_hsExpr)
882− NoParens -> do
1065+ NoParens ->
8831066 located expr (sitcc . p_hsExpr)
8841067 where
8851068 decoSymbol = if isTyped then "$$" else "$"
8861069
8871070p_hsBracket :: HsBracket GhcPs -> R ()
8881071p_hsBracket = \case
889− ExpBr NoExt expr -> do
1072+ ExpBr NoExtField expr -> do
8901073 anns <- getEnclosingAnns
8911074 let name = case anns of
892− AnnOpenEQ:_ -> ""
1075+ AnnOpenEQ : _ -> ""
8931076 _ -> "e"
8941077 quote name (located expr p_hsExpr)
895− PatBr NoExt pat -> quote "p" (located pat p_pat)
896− DecBrL NoExt decls -> quote "d" (p_hsDecls Free decls)
897− DecBrG NoExt _ -> notImplemented "DecBrG" -- result of renamer
898− TypBr NoExt ty -> quote "t" (located ty p_hsType)
899− 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
9001083 txt (bool "''" "'" isSingleQuote)
9011084 -- HACK As you can see we use 'noLoc' here to be able to pass name into
9021085 -- 'p_rdrName' since the latter expects a "located" thing. The problem
@@ -904,19 +1087,20 @@ p_hsBracket = \case
9041087 -- turn makes it impossible to detect if there are parentheses around
9051088 -- it, etc. So we have to add parentheses manually assuming they are
9061089 -- necessary for all operators.
907− let isOperator = all
908− (\i -> isPunctuation i || isSymbol i)
909− (showOutputable (rdrNameOcc name))
910− && not (doesNotNeedExtraParens name)
911− 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
9121096 wrapper $ p_rdrName (noLoc name)
913− TExpBr NoExt expr -> do
1097+ TExpBr NoExtField expr -> do
9141098 txt "[||"
9151099 breakpoint'
9161100 located expr p_hsExpr
9171101 breakpoint'
9181102 txt "||]"
919− XBracket {} -> notImplemented "XBracket"
1103+ XBracket x -> noExtCon x
9201104 where
9211105 quote :: Text -> R () -> R ()
9221106 quote name body = do
@@ -929,12 +1113,65 @@ p_hsBracket = \case
9291113 breakpoint'
9301114 txt "|]"
9311115
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+
9321163----------------------------------------------------------------------------
9331164-- Helpers
9341165
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+
9351173-- | Append each element in both lists with semigroups. If one list is shorter
9361174-- than the other, return the rest of the longer list unchanged.
937−
9381175liftAppend :: Semigroup a => [a] -> [a] -> [a]
9391176liftAppend [] [] = []
9401177liftAppend [] (y : ys) = y : ys
@@ -942,16 +1179,15 @@ liftAppend (x : xs) [] = x : xs
9421179liftAppend (x : xs) (y : ys) = x <> y : liftAppend xs ys
9431180
9441181getGRHSSpan :: GRHS GhcPs (Located body) -> SrcSpan
945−getGRHSSpan (GRHS NoExt guards body) =
1182+getGRHSSpan (GRHS NoExtField guards body) =
9461183 combineSrcSpans' $ getLoc body :| map getLoc guards
947−getGRHSSpan (XGRHS NoExt) = notImplemented "XGRHS"
1184+getGRHSSpan (XGRHS x) = noExtCon x
9481185
9491186-- | Place a thing that may have a hanging form. This function handles how
9501187-- to separate it from preceding expressions and whether to bump indentation
9511188-- depending on what sort of expression we have.
952−
9531189placeHanging :: Placement -> R () -> R ()
954−placeHanging placement m = do
1190+placeHanging placement m =
9551191 case placement of
9561192 Hanging -> do
9571193 space
@@ -962,67 +1198,165 @@ placeHanging placement m = do
9621198
9631199-- | Check if given block contains single expression which has a hanging
9641200-- form.
965−
966−blockPlacement
967− :: (body -> Placement)
968− -> [LGRHS GhcPs (Located body)]
969− -> Placement
970−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
9711206blockPlacement _ _ = Normal
9721207
9731208-- | Check if given command has a hanging form.
974−
9751209cmdPlacement :: HsCmd GhcPs -> Placement
9761210cmdPlacement = \case
977− HsCmdLam NoExt _ -> Hanging
978− HsCmdCase NoExt _ _ -> Hanging
979− HsCmdDo NoExt _ -> Hanging
1211+ HsCmdLam NoExtField _ -> Hanging
1212+ HsCmdCase NoExtField _ _ -> Hanging
1213+ HsCmdDo NoExtField _ -> Hanging
9801214 _ -> Normal
9811215
9821216cmdTopPlacement :: HsCmdTop GhcPs -> Placement
9831217cmdTopPlacement = \case
984− HsCmdTop NoExt (L _ x) -> cmdPlacement x
985− XCmdTop {} -> notImplemented "XCmdTop"
1218+ HsCmdTop NoExtField (L _ x) -> cmdPlacement x
1219+ XCmdTop x -> noExtCon x
9861220
9871221-- | Check if given expression has a hanging form.
988−
9891222exprPlacement :: HsExpr GhcPs -> Placement
9901223exprPlacement = \case
9911224 -- Only hang lambdas with single line parameter lists
992− HsLam NoExt mg -> case mg of
993− MG _ (L _ [L _ (Match NoExt _ (x:xs) _)]) _
994− | isOneLineSpan (combineSrcSpans' $ fmap getLoc (x :| xs))
995− -> 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
9961229 _ -> Normal
997− HsLamCase NoExt _ -> Hanging
998− HsCase NoExt _ _ -> Hanging
999− HsDo NoExt DoExpr _ -> Hanging
1000− HsDo NoExt MDoExpr _ -> Hanging
1001− RecordCon NoExt _ _ -> Hanging
1002− -- If the rightmost expression in an operator chain is hanging, make the
1003− -- whole block hanging; so that we can use the common @f = foo $ do@
1004− -- style.
1005− OpApp NoExt _ _ y -> exprPlacement (unLoc y)
1006− 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 _ ->
10071240 -- Indentation breaks if pattern is longer than one line and left
10081241 -- hanging. Consequently, only apply hanging when it is safe.
1009− if isOneLineSpan s
1010− then Hanging
1011− else Normal
1242+ if isOneLineSpan (getLoc p)
1243+ then Hanging
1244+ else Normal
10121245 _ -> Normal
10131246
10141247withGuards :: [LGRHS GhcPs (Located body)] -> Bool
10151248withGuards = any (checkOne . unLoc)
10161249 where
10171250 checkOne :: GRHS GhcPs (Located body) -> Bool
1018− checkOne (GRHS NoExt [] _) = False
1251+ checkOne (GRHS NoExtField [] _) = False
10191252 checkOne _ = True
10201253
1021−-- | 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
10221265
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.
10231357getEnclosingAnns :: R [AnnKeywordId]
10241358getEnclosingAnns = do
10251359 e <- getEnclosingSpan (const True)
10261360 case e of
10271361 Nothing -> return []
1028− Just e' -> getAnns (RealSrcSpan e')
1362+ Just e' -> getAnns (RealSrcSpan e')