@@ -1,47 +1,43 @@
1−{-# LANGUAGE LambdaCase #-}
1+{-# LANGUAGE LambdaCase #-}
2+{-# LANGUAGE MultiWayIf #-}
2{-# LANGUAGE OverloadedStrings #-}
3{-# LANGUAGE OverloadedStrings #-}
3−{-# LANGUAGE RecordWildCards #-}
4+{-# LANGUAGE RecordWildCards #-}
5+{-# LANGUAGE TypeApplications #-}
5module Ormolu.Printer.Meat.Declaration.Value
7module Ormolu.Printer.Meat.Declaration.Value
6− ( p_valDecl
8+ ( p_valDecl,
10import Bag (bagToList)
16import Bag (bagToList)
11import BasicTypes
17import BasicTypes
12import Control.Monad
18import Control.Monad
13−import Data.Data
19+import Ctype (is_space)
14−import Data.List (sortOn)
20+import Data.Bool (bool)
21+import Data.Char (isPunctuation, isSymbol)
22+import Data.Data hiding (Infix, Prefix)
23+import Data.Functor ((<&>))
24+import Data.List (intersperse, sortOn)
25+import Data.List.NonEmpty (NonEmpty (..), (<|))
26+import qualified Data.List.NonEmpty as NE
27+import Data.Text (Text)
28+import qualified Data.Text as Text
30+import OccName (occNameString)
16import Ormolu.Printer.Combinators
31import Ormolu.Printer.Combinators
32+import Ormolu.Printer.Internal
17import Ormolu.Printer.Meat.Common
33import Ormolu.Printer.Meat.Common
18−import Ormolu.Printer.Meat.Declaration.Pat
34+import {-# SOURCE #-} Ormolu.Printer.Meat.Declaration
19import Ormolu.Printer.Meat.Declaration.Signature
35import Ormolu.Printer.Meat.Declaration.Signature
20import Ormolu.Printer.Meat.Type
36import Ormolu.Printer.Meat.Type
37+import Ormolu.Printer.Operators
21import Ormolu.Utils
38import Ormolu.Utils
22−import Outputable (Outputable (..))
23−import SrcLoc (isOneLineSpan)
24−import qualified Data.List.NonEmpty as NE
26−p_valDecl :: HsBindLR GhcPs GhcPs -> R ()
27−p_valDecl = line . p_valDecl'
29−p_valDecl' :: HsBindLR GhcPs GhcPs -> R ()
31− FunBind NoExt funId funMatches _ _ -> p_funBind funId funMatches
32− PatBind NoExt pat grhss _ -> p_match PatternBind [pat] grhss
33− VarBind {} -> error "VarBinds are introduced by the type checker"
34− AbsBinds {} -> error "AbsBinds are introduced by the type checker"
35− PatSynBind NoExt psb -> p_patSynBind psb
36− XHsBindsLR NoExt -> notImplemented "XHsBindsLR"
40− -> MatchGroup GhcPs (LHsExpr GhcPs)
42−p_funBind name mgroup =
43− p_matchGroup (Function name) mgroup
40+-- | Style of a group of equations.
45data MatchGroupStyle
41data MatchGroupStyle
46 = Function (Located RdrName)
42 = Function (Located RdrName)
47 | PatternBind
43 | PatternBind
@@ -49,365 +45,1318 @@ data MatchGroupStyle
50 | LambdaCase
46 | LambdaCase
52−p_matchGroup
48+-- | Style of equations in a group.
53− :: MatchGroupStyle
49+data GroupStyle
54− -> MatchGroup GhcPs (LHsExpr GhcPs)
50+ = EqualSign
55− -> R ()
51+ | RightArrow
56−p_matchGroup style MG {..} =
52+
57− locatedVia Nothing mg_alts $
53+-- | Expression placement. This marks the places where expressions that
58− newlineSep (located' (\Match {..} -> p_match style m_pats m_grhss))
54+-- implement handing forms may use them.
59−p_matchGroup _ (XMatchGroup NoExt) = notImplemented "XMatchGroup"
55+data Placement
60−
56+ = -- | Multi-line layout should cause
61−p_match
57+ -- insertion of a newline and indentation
62− :: MatchGroupStyle
58+ -- bump
63− -> [LPat GhcPs]
59+ Normal
64− -> GRHSs GhcPs (LHsExpr GhcPs)
60+ | -- | Expressions that have hanging form
65− -> R ()
61+ -- should use it and avoid bumping one level
66−p_match style m_pats m_grhss = do
62+ -- of indentation
67− case style of
63+ Hanging
68− Function name -> p_rdrName name
64+ deriving (Eq, Show)
70− -- NOTE Normally, since patterns may be placed in a multi-line layout, it
66+p_valDecl :: HsBindLR GhcPs GhcPs -> R ()
71− -- is necessary to bump indentation for the pattern group so it's more
67+p_valDecl = \case
68+ FunBind NoExtField funId funMatches _ _ -> p_funBind funId funMatches
69+ PatBind NoExtField pat grhss _ -> p_match PatternBind False NoSrcStrict [pat] grhss
70+ VarBind {} -> notImplemented "VarBinds" -- introduced by the type checker
71+ AbsBinds {} -> notImplemented "AbsBinds" -- introduced by the type checker
72+ PatSynBind NoExtField psb -> p_patSynBind psb
73+ XHsBindsLR x -> noExtCon x
77+ MatchGroup GhcPs (LHsExpr GhcPs) ->
79+p_funBind name = p_matchGroup (Function name)
83+ MatchGroup GhcPs (LHsExpr GhcPs) ->
85+p_matchGroup = p_matchGroup' exprPlacement p_hsExpr
89+ -- | How to get body placement
90+ (body -> Placement) ->
91+ -- | How to print body
93+ -- | Style of this group of equations
96+ MatchGroup GhcPs (Located body) ->
98+p_matchGroup' placer render style MG {..} = do
99+ let ob = case style of
103+ -- Since we are forcing braces on 'sepSemi' based on 'ob', we have to
104+ -- restore the brace state inside the sepsemi.
105+ ub <- bool dontUseBraces useBraces <$> canUseBraces
106+ ob $ sepSemi (located' (ub . p_Match)) (unLoc mg_alts)
108+ p_Match m@Match {..} =
112+ (adjustMatchGroupStyle m style)
117+ p_Match (XMatch x) = noExtCon x
118+p_matchGroup' _ _ _ (XMatchGroup x) = noExtCon x
120+-- | Function id obtained through pattern matching on 'FunBind' should not
121+-- be used to print the actual equations because the different ‘RdrNames’
122+-- used in the equations may have different “decorations” (such as backticks
123+-- and paretheses) associated with them. It is necessary to use per-equation
124+-- names obtained from 'm_ctxt' of 'Match'. This function replaces function
125+-- name inside of 'Function' accordingly.
126+adjustMatchGroupStyle ::
130+adjustMatchGroupStyle m = \case
131+ Function _ -> (Function . mc_fun . m_ctxt) m
134+matchStrictness :: Match id body -> SrcStrictness
135+matchStrictness match =
136+ case m_ctxt match of
137+ FunRhs {mc_strictness = s} -> s
141+ -- | Style of the group
143+ -- | Is this an infix match?
145+ -- | Strictness prefix (FunBind)
147+ -- | Argument patterns
150+ GRHSs GhcPs (LHsExpr GhcPs) ->
152+p_match = p_match' exprPlacement p_hsExpr
156+ -- | How to get body placement
157+ (body -> Placement) ->
158+ -- | How to print body
160+ -- | Style of this group of equations
162+ -- | Is this an infix match?
164+ -- | Strictness prefix (FunBind)
166+ -- | Argument patterns
169+ GRHSs GhcPs (Located body) ->
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
72 -- indented than function name. This in turn means that indentation for
174 -- indented than function name. This in turn means that indentation for
73 -- the body should also be bumped. Normally this would mean that bodies
175 -- the body should also be bumped. Normally this would mean that bodies
74 -- would start with two indentation steps applied, which is ugly, so we
176 -- would start with two indentation steps applied, which is ugly, so we
75 -- need to be a bit more clever here and bump indentation level only when
177 -- need to be a bit more clever here and bump indentation level only when
76 -- pattern group is multiline.
178 -- pattern group is multiline.
77− inci' <- case NE.nonEmpty m_pats of
179+ case strictness of
78− Nothing -> return id
180+ NoSrcStrict -> return ()
181+ SrcStrict -> txt "!"
183+ indentBody <- case NE.nonEmpty m_pats of
185+ False <$ case style of
186+ Function name -> p_rdrName name
79 Just ne_pats -> do
188 Just ne_pats -> do
80− let combinedSpans = combineSrcSpans' $
189+ let combinedSpans = case style of
81− getSpan <$> ne_pats
190+ Function name -> combineSrcSpans (getLoc name) patSpans
82− inci' = if isOneLineSpan combinedSpans
191+ _ -> patSpans
83− then id
192+ patSpans = combineSrcSpans' (getLoc <$> ne_pats)
84− else inci
193+ indentBody = not (isOneLineSpan combinedSpans)
85− switchLayout combinedSpans $ do
194+ switchLayout [combinedSpans] $ do
195+ let stdCase = sep breakpoint (located' p_pat) m_pats
86 case style of
196 case style of
87− Function _ -> breakpoint
197+ Function name ->
88− PatternBind -> return ()
198+ p_infixDefHelper
89− Case -> return ()
199+ isInfix
90− Lambda -> txt "\\"
200+ indentBody
91− LambdaCase -> return ()
201+ (p_rdrName name)
92− let wrapper = case style of
202+ (located' p_pat <$> m_pats)
93− Function _ -> inci'
203+ PatternBind -> stdCase
94− _ -> id
204+ Case -> stdCase
95− wrapper (velt' (located' p_pat <$> m_pats))
205+ Lambda -> do
96− return inci'
206+ let needsSpace = case unLoc (NE.head ne_pats) of
97− inci' $ do
207+ LazyPat _ _ -> True
98− let GRHSs {..} = m_grhss
208+ BangPat _ _ -> True
99− unless (length grhssGRHSs > 1) $ do
209+ SplicePat _ _ -> True
100− space
210+ _ -> False
101− txt $ case style of
211+ txt "\\"
102− Function _ -> "="
212+ when needsSpace space
103− PatternBind -> "="
213+ sitcc stdCase
104− _ -> "->"
214+ LambdaCase -> stdCase
105− let combinedSpans = combineSrcSpans' $
215+ return indentBody
106− getGRHSSpan . unL <$> NE.fromList grhssGRHSs
216+ let -- Calculate position of end of patterns. This is useful when we decide
107− case style of
217+ -- about putting certain constructions in hanging positions.
108− Lambda -> breakpoint
218+ endOfPats = case NE.nonEmpty m_pats of
109− _ -> return ()
219+ Nothing -> case style of
110− switchLayout combinedSpans . inci $ do
220+ Function name -> Just (getLoc name)
222+ Just pats -> (Just . getLoc . NE.last) pats
227+ hasGuards = withGuards grhssGRHSs
230+ getGRHSSpan . unLoc <$> NE.fromList grhssGRHSs
234+ (combineSrcSpans grhssSpan . srcLocSpan . srcSpanEnd)
238+ Nothing -> blockPlacement placer grhssGRHSs
240+ if onTheSameLine spn grhssSpan
241+ then blockPlacement placer grhssGRHSs
245+ if isCase style && hasGuards
248+ sep newline (located' (p_grhs' placer render groupStyle)) grhssGRHSs
250+ let whereIsEmpty = GHC.isEmptyLocalBindsPR (unLoc grhssLocalBinds)
251+ unless (GHC.eqEmptyLocalBinds (unLoc grhssLocalBinds)) $ do
254+ unless whereIsEmpty breakpoint
255+ inci $ located grhssLocalBinds p_hsLocalBinds
256+ inciIf indentBody $ do
257+ unless (length grhssGRHSs > 1) $
111 case style of
258 case style of
112− Lambda -> return ()
259+ Function _ | hasGuards -> return ()
113− _ -> breakpoint
260+ Function _ -> space >> inci equals
114− newlineSep (located' (p_grhs Guard)) grhssGRHSs
261+ PatternBind -> space >> inci equals
115− unless (GHC.isEmptyLocalBindsPR (unL grhssLocalBinds)) $ do
262+ s | isCase s && hasGuards -> return ()
116− newline
263+ _ -> space >> txt "->"
117− line (txt "where")
264+ switchLayout [patGrhssSpan] $
118− inci (located grhssLocalBinds p_hsLocalBinds)
265+ placeHanging placement p_body
120−data GroupStyle
267+p_match' _ _ _ _ _ _ (XGRHSs x) = noExtCon x
124p_grhs :: GroupStyle -> GRHS GhcPs (LHsExpr GhcPs) -> R ()
269p_grhs :: GroupStyle -> GRHS GhcPs (LHsExpr GhcPs) -> R ()
125−p_grhs style (GRHS NoExt guards body) =
270+p_grhs = p_grhs' exprPlacement p_hsExpr
274+ -- | How to get body placement
275+ (body -> Placement) ->
276+ -- | How to print body
279+ GRHS GhcPs (Located body) ->
281+p_grhs' placer render style (GRHS NoExtField guards body) =
126 case guards of
282 case guards of
127 [] -> p_body
283 [] -> p_body
129− txt "| "
285+ txt "|"
130− velt $ withSep comma (located' p_stmt) xs
132− txt $ case style of
287+ sitcc (sep commaDel (sitcc . located' p_stmt) xs)
133− Guard -> "="
288+ space
134− MultiIf -> "->"
289+ inci $ case style of
135− breakpoint
290+ EqualSign -> equals
136− inci p_body
291+ RightArrow -> txt "->"
292+ placeHanging placement p_body
138− p_body = located body p_hsExpr
294+ placement =
139−p_grhs _ (XGRHS NoExt) = notImplemented "XGRHS"
295+ case endOfGuards of
296+ Nothing -> placer (unLoc body)
298+ if onTheSameLine spn (getLoc body)
299+ then placer (unLoc body)
302+ case NE.nonEmpty guards of
304+ Just gs -> (Just . getLoc . NE.last) gs
305+ p_body = located body render
306+p_grhs' _ _ _ (XGRHS x) = noExtCon x
308+p_hsCmd :: HsCmd GhcPs -> R ()
310+ HsCmdArrApp NoExtField body input arrType _ -> do
311+ located body p_hsExpr
315+ HsFirstOrderApp -> txt "-<"
316+ HsHigherOrderApp -> txt "-<<"
317+ placeHanging (exprPlacement (unLoc input)) $
318+ located input p_hsExpr
319+ HsCmdArrForm NoExtField form Prefix _ cmds -> banana $ do
320+ located form p_hsExpr
321+ unless (null cmds) $ do
323+ inci (sequence_ (intersperse breakpoint (located' p_hsCmdTop <$> cmds)))
324+ HsCmdArrForm NoExtField form Infix _ [left, right] -> do
325+ located left p_hsCmdTop
327+ located form p_hsExpr
328+ placeHanging (cmdTopPlacement (unLoc right)) $
329+ located right p_hsCmdTop
330+ HsCmdArrForm NoExtField _ Infix _ _ -> notImplemented "HsCmdArrForm"
332+ -- XXX Does this ever occur in the syntax tree? It does not seem like it
333+ -- does. Open an issue and ping @yumiova if this ever occurs in output.
334+ notImplemented "HsCmdApp"
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
347+ sitcc . sep newline (sitcc . withSpacing (p_stmt' cmdPlacement p_hsCmd))
348+ HsCmdWrap {} -> notImplemented "HsCmdWrap"
349+ XCmd x -> noExtCon x
351+p_hsCmdTop :: HsCmdTop GhcPs -> R ()
353+ HsCmdTop NoExtField cmd -> located cmd p_hsCmd
354+ XCmdTop x -> noExtCon x
356+-- | Render an expression preserving blank lines between such consecutive
357+-- expressions found in the original source code.
359+ -- | Rendering function
361+ -- | Entity to render
364+withSpacing f l = located l $ \x -> do
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
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)
141p_stmt :: Stmt GhcPs (LHsExpr GhcPs) -> R ()
385p_stmt :: Stmt GhcPs (LHsExpr GhcPs) -> R ()
142−p_stmt = \case
386+p_stmt = p_stmt' exprPlacement p_hsExpr
143− LastStmt {} -> notImplemented "do notation"
387+
144− BindStmt {} -> notImplemented "do notation"
388+p_stmt' ::
145− ApplicativeStmt {} -> notImplemented "applicative stmt"
389+ Data body =>
146− BodyStmt NoExt body _ _ -> located body p_hsExpr
390+ -- | Placer
147− LetStmt NoExt binds -> located binds p_hsLocalBinds
391+ (body -> Placement) ->
148− ParStmt {} -> notImplemented "ParStmt"
392+ -- | Render
149− TransStmt {} -> notImplemented "TransStmt"
393+ (body -> R ()) ->
150− RecStmt {} -> notImplemented "RecStmt"
394+ -- | Statement to render
151− XStmtLR {} -> notImplemented "XStmtLR"
395+ Stmt GhcPs (Located body) ->
397+p_stmt' placer render = \case
398+ LastStmt NoExtField body _ _ -> located body render
399+ BindStmt NoExtField p f _ _ -> do
408+ (mkSrcSpan (srcSpanEnd loc) (srcSpanStart l'))
411+ switchLayout [loc, getLoc f] $
412+ placeHanging placement (located f render)
413+ ApplicativeStmt {} -> notImplemented "ApplicativeStmt" -- generated by renamer
414+ BodyStmt NoExtField body _ _ -> located body render
415+ LetStmt NoExtField binds -> do
418+ sitcc $ located binds p_hsLocalBinds
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.
423+ notImplemented "ParStmt"
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'.
428+ case (trS_form, trS_by) of
429+ (ThenForm, Nothing) -> do
432+ inci $ located trS_using p_hsExpr
433+ (ThenForm, Just e) -> do
436+ inci $ located trS_using p_hsExpr
440+ inci $ located e p_hsExpr
441+ (GroupForm, Nothing) -> do
442+ txt "then group using"
444+ inci $ located trS_using p_hsExpr
445+ (GroupForm, Just e) -> do
448+ inci $ located e p_hsExpr
452+ inci $ located trS_using p_hsExpr
456+ sitcc $ sepSemi (withSpacing (p_stmt' placer render)) recS_stmts
457+ XStmtLR c -> noExtCon c
459+gatherStmt :: ExprLStmt GhcPs -> [[ExprLStmt GhcPs]]
460+gatherStmt (L _ (ParStmt NoExtField block _ _)) =
461+ foldr ((<>) . gatherStmtBlock) [] block
462+gatherStmt (L s stmt@TransStmt {..}) =
463+ foldr liftAppend [] ((gatherStmt <$> trS_stmts) <> pure [[L s stmt]])
464+gatherStmt stmt = [[stmt]]
466+gatherStmtBlock :: ParStmtBlock GhcPs GhcPs -> [[ExprLStmt GhcPs]]
467+gatherStmtBlock (ParStmtBlock _ stmts _ _) =
468+ foldr (liftAppend . gatherStmt) [] stmts
469+gatherStmtBlock (XParStmtBlock x) = noExtCon x
153p_hsLocalBinds :: HsLocalBindsLR GhcPs GhcPs -> R ()
471p_hsLocalBinds :: HsLocalBindsLR GhcPs GhcPs -> R ()
154p_hsLocalBinds = \case
472p_hsLocalBinds = \case
155− HsValBinds NoExt (ValBinds NoExt bag lsigs) -> do
473+ HsValBinds NoExtField (ValBinds NoExtField bag lsigs) -> do
156− let ssStart = either
474+ -- When in a single-line layout, there is a chance that the inner
157− (srcSpanStart . getSpan)
475+ -- elements will also contain semicolons and they will confuse the
158− (srcSpanStart . getSpan)
476+ -- parser. so we request braces around every element except the last.
159− items =
477+ br <- layoutToBraces <$> getLayout
160− (Left <$> bagToList bag) ++ (Right <$> lsigs)
478+ let items =
161− p_item (Left x) = located x p_valDecl'
479+ let injectLeft (L l x) = L l (Left x)
162− p_item (Right x) = located x p_sigDecl'
480+ injectRight (L l x) = L l (Right x)
163− newlineSep p_item (sortOn ssStart items)
481+ in (injectLeft <$> bagToList bag) ++ (injectRight <$> lsigs)
164− HsValBinds NoExt _ -> notImplemented "HsValBinds"
482+ positionToBracing = \case
165− HsIPBinds NoExt _ -> notImplemented "HsIPBinds"
483+ SinglePos -> id
166− EmptyLocalBinds NoExt -> return ()
484+ FirstPos -> br
167− XHsLocalBindsLR _ -> notImplemented "XHsLocalBindsLR"
485+ MiddlePos -> br
169−p_hsRecField
487+ p_item' (p, item) =
170− :: (Data id, Outputable id)
488+ positionToBracing p $
171− => HsRecField' id (LHsExpr GhcPs)
489+ withSpacing (either p_valDecl p_sigDecl) item
172− -> R ()
490+ binds = sortOn (srcSpanStart . getLoc) items
173−p_hsRecField = \HsRecField {..} -> do
491+ sitcc $ sepSemi p_item' (attachRelativePos binds)
174− located hsRecFieldLbl atom
492+ HsValBinds NoExtField _ -> notImplemented "HsValBinds"
175− unless hsRecPun $ do
493+ HsIPBinds NoExtField (IPBinds NoExtField xs) ->
176− txt " = "
494+ -- Second argument of IPBind is always Left before type-checking.
177− located hsRecFieldArg p_hsExpr
495+ let p_ipBind (IPBind NoExtField (Left name) expr) = do
179−p_hsTupArg :: HsTupArg GhcPs -> R ()
497+ space
180−p_hsTupArg = \case
498+ equals
181− Present NoExt x -> located x p_hsExpr
499+ breakpoint
182− Missing NoExt -> pure ()
500+ useBraces $ inci $ located expr p_hsExpr
183− XTupArg {} -> notImplemented "XTupArg"
501+ p_ipBind (IPBind NoExtField (Right _) _) =
502+ -- Should only occur after the type checker
503+ notImplemented "IPBind _ (Right _) _"
504+ p_ipBind (XIPBind x) = noExtCon x
505+ in sepSemi (located' p_ipBind) xs
506+ HsIPBinds NoExtField _ -> notImplemented "HsIpBinds"
507+ EmptyLocalBinds NoExtField -> return ()
508+ XHsLocalBindsLR x -> noExtCon x
511+ HsRecField' RdrName (LHsExpr GhcPs) ->
513+p_hsRecField HsRecField {..} = do
514+ p_rdrName hsRecFieldLbl
515+ unless hsRecPun $ do
519+ if onTheSameLine (getLoc hsRecFieldLbl) (getLoc hsRecFieldArg)
520+ then exprPlacement (unLoc hsRecFieldArg)
522+ placeHanging placement (located hsRecFieldArg p_hsExpr)
185p_hsExpr :: HsExpr GhcPs -> R ()
524p_hsExpr :: HsExpr GhcPs -> R ()
186−p_hsExpr = \case
525+p_hsExpr = p_hsExpr' N
187− HsVar NoExt name -> p_rdrName name
526+
188− HsUnboundVar NoExt _ -> notImplemented "HsUnboundVar"
527+p_hsExpr' :: BracketStyle -> HsExpr GhcPs -> R ()
189− HsConLikeOut NoExt _ -> notImplemented "HsConLikeOut"
528+p_hsExpr' s = \case
190− HsRecFld NoExt x ->
529+ HsVar NoExtField name -> p_rdrName name
530+ HsUnboundVar NoExtField v -> atom (unboundVarOcc v)
531+ HsConLikeOut NoExtField _ -> notImplemented "HsConLikeOut"
532+ HsRecFld NoExtField x ->
191 case x of
533 case x of
192− Unambiguous NoExt name -> p_rdrName name
534+ Unambiguous NoExtField name -> p_rdrName name
193− Ambiguous NoExt name -> p_rdrName name
535+ Ambiguous NoExtField name -> p_rdrName name
194− XAmbiguousFieldOcc NoExt -> notImplemented "XAmbiguousFieldOcc"
536+ XAmbiguousFieldOcc xx -> noExtCon xx
195− HsOverLabel NoExt _ v -> do
537+ HsOverLabel NoExtField _ v -> do
198− HsIPVar NoExt (HsIPName name) -> atom name
540+ HsIPVar NoExtField (HsIPName name) -> do
199− HsOverLit NoExt v -> atom (ol_val v)
541+ txt "?"
200− HsLit NoExt lit -> atom lit
542+ atom name
201− HsLam NoExt mgroup ->
543+ HsOverLit NoExtField v -> atom (ol_val v)
544+ HsLit NoExtField lit ->
546+ HsString (SourceText stxt) _ -> p_stringLit stxt
547+ HsStringPrim (SourceText stxt) _ -> p_stringLit stxt
549+ HsLam NoExtField mgroup ->
202 p_matchGroup Lambda mgroup
550 p_matchGroup Lambda mgroup
203− HsLamCase NoExt mgroup -> do
551+ HsLamCase NoExtField mgroup -> do
204 txt "\\case"
552 txt "\\case"
206− inci (p_matchGroup LambdaCase mgroup)
207− HsApp NoExt f x -> do
209 breakpoint
553 breakpoint
210− inci (located x p_hsExpr)
554+ inci (p_matchGroup LambdaCase mgroup)
211− 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 =
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)
569+ getLoc f :| [(srcLocSpan . srcSpanStart . getLoc) lastp]
570+ -- Hang the last argument only if the initial arguments span one
573+ if isOneLineSpan initSpan
574+ then exprPlacement (unLoc lastp)
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
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.
589+ L _ (HsPar NoExtField _) -> True
590+ L _ (HsAppType NoExtField _ _) -> True
591+ L _ (HsMultiIf NoExtField _) -> True
592+ L spn _ -> isOneLineSpan spn
595+ SingleLine -> useBraces
598+ located func (p_hsExpr' s)
600+ inciIf doIndent $ sep breakpoint (located' p_hsExpr) initp
601+ inciIf doIndent $ do
602+ unless (null initp) breakpoint
603+ located lastp p_hsExpr
605+ useBraces . switchLayout [initSpan] $ do
606+ located func (p_hsExpr' s)
608+ sep breakpoint (located' p_hsExpr) initp
609+ placeHanging placement $
610+ located lastp p_hsExpr
611+ HsAppType NoExtField e a -> do
212 located e p_hsExpr
612 located e p_hsExpr
213 breakpoint
613 breakpoint
214 inci $ do
614 inci $ do
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
216 located (hswc_body a) p_hsType
621 located (hswc_body a) p_hsType
217− OpApp NoExt x op y -> do
622+ OpApp NoExtField x op y -> do
218− located x p_hsExpr
623+ let opTree = OpBranch (exprOpTree x) op (exprOpTree y)
219− space
624+ p_exprOpTree s (reassociateOpTree getOpName opTree)
220− located op p_hsExpr
625+ NegApp NoExtField e _ -> do
222− inci (located y p_hsExpr)
223− NegApp NoExt e _ -> do
225 located e p_hsExpr
628 located e p_hsExpr
226− HsPar NoExt e -> parens (located e p_hsExpr)
629+ HsPar NoExtField e ->
227− SectionL NoExt x op -> do
630+ parens s (located e (dontUseBraces . p_hsExpr))
631+ SectionL NoExtField x op -> do
228 located x p_hsExpr
632 located x p_hsExpr
229 breakpoint
633 breakpoint
230 inci (located op p_hsExpr)
634 inci (located op p_hsExpr)
231− SectionR NoExt op x -> do
635+ SectionR NoExtField op x -> do
232 located op p_hsExpr
636 located op p_hsExpr
233− breakpoint
637+ useRecordDot' <- useRecordDot
638+ let isRecordDot' = isRecordDot (unLoc op) (getLoc x)
639+ unless (useRecordDot' && isRecordDot') breakpoint
234 inci (located x p_hsExpr)
640 inci (located x p_hsExpr)
235− ExplicitTuple NoExt args boxity -> do
641+ ExplicitTuple NoExtField args boxity ->
236− let isSection = any (isMissing . unL) args
642+ let isSection = any (isMissing . unLoc) args
237 isMissing = \case
643 isMissing = \case
238− Missing NoExt -> True
644+ Missing NoExtField -> True
239 _ -> False
645 _ -> False
240− 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
241 case boxity of
652 case boxity of
242 Boxed -> parens
653 Boxed -> parens
243 Unboxed -> parensHash
654 Unboxed -> parensHash
244− parens' $ if isSection
655+ in if isSection
245− then sequence_ (withSep (txt ",") (located' p_hsTupArg) args)
656+ then
246− else velt (withSep comma (located' p_hsTupArg) args)
657+ switchLayout [] . parens' s $
247− ExplicitSum NoExt tag arity e -> do
658+ sep comma p_larg args
248− let before = tag - 1
659+ else
249− after = arity - before - 1
660+ switchLayout (getLoc <$> args) . parens' s $
250− args = replicate before Nothing <> [Just e] <> replicate after Nothing
661+ sep commaDel p_larg args
251− f (x,i) = do
662+ ExplicitSum NoExtField tag arity e ->
252− let isFirst = i == 0
663+ p_unboxedSum N tag arity (located e p_hsExpr)
253− isLast = i == arity - 1
664+ HsCase NoExtField e mgroup ->
254− case x of
665+ p_case exprPlacement p_hsExpr e mgroup
255− Nothing ->
666+ HsIf NoExtField _ if' then' else' ->
256− unless (isFirst || isLast) space
667+ p_if exprPlacement p_hsExpr if' then' else'
257− Just l -> do
668+ HsMultiIf NoExtField guards -> do
258− unless isFirst space
669+ txt "if"
261− parensHash $ sequence_ (withSep (txt "|") f (zip args [0..]))
262− HsCase NoExt e mgroup -> do
267− inci (p_matchGroup Case mgroup)
268− HsIf NoExt _ if' then' else' -> do
270− located if' p_hsExpr
271 breakpoint
670 breakpoint
272− txt "then"
671+ inci . inci $ sep newline (located' (p_grhs RightArrow)) guards
273− located then' $ \x -> do
672+ HsLet NoExtField localBinds e ->
274− breakpoint
673+ p_let p_hsExpr localBinds e
275− inci (p_hsExpr x)
674+ HsDo NoExtField ctx es -> do
276− breakpoint
675+ let doBody header = do
277− txt "else"
676+ txt header
278− located else' $ \x -> do
677+ breakpoint
279− breakpoint
678+ ub <- layoutToBraces <$> getLayout
280− inci (p_hsExpr x)
679+ inci $
281− HsMultiIf NoExt guards -> do
680+ sepSemi
282− txt "if "
681+ (ub . withSpacing (p_stmt' exprPlacement (p_hsExpr' S)))
283− sitcc $ newlineSep (located' (p_grhs MultiIf)) guards
682+ (unLoc es)
284− HsLet NoExt localBinds e -> do
683+ compBody = brackets N . located es $ \xs -> do
285− txt "let "
684+ let p_parBody =
286− sitcc (located localBinds p_hsLocalBinds)
685+ sep
287− breakpoint
686+ (breakpoint >> txt "|" >> space)
288− txt "in "
687+ p_seqBody
289− sitcc (located e p_hsExpr)
688+ p_seqBody =
290− HsDo {} -> notImplemented "HsDo"
689+ sitcc
291− ExplicitList _ _ xs -> do
690+ . sep
292− brackets $ velt (withSep comma (located' p_hsExpr) xs)
691+ commaDel
692+ (located' (sitcc . p_stmt))
695+ lists = foldr (liftAppend . gatherStmt) [] stmts
696+ located yield p_stmt
702+ DoExpr -> doBody "do"
703+ MDoExpr -> doBody "mdo"
704+ ListComp -> compBody
705+ MonadComp -> notImplemented "MonadComp"
706+ ArrowExpr -> notImplemented "ArrowExpr"
707+ GhciStmtCtxt -> notImplemented "GhciStmtCtxt"
708+ PatGuard _ -> notImplemented "PatGuard"
709+ ParStmtCtxt _ -> notImplemented "ParStmtCtxt"
710+ TransStmtCtxt _ -> notImplemented "TransStmtCtxt"
711+ ExplicitList _ _ xs ->
713+ sep commaDel (sitcc . located' p_hsExpr) xs
293 RecordCon {..} -> do
714 RecordCon {..} -> do
294 located rcon_con_name atom
715 located rcon_con_name atom
295 breakpoint
716 breakpoint
296 let HsRecFields {..} = rcon_flds
717 let HsRecFields {..} = rcon_flds
297− fields = located' p_hsRecField <$> rec_flds
718+ updName f =
719+ (f :: HsRecField GhcPs (LHsExpr GhcPs))
720+ { hsRecFieldLbl = case unLoc $ hsRecFieldLbl f of
722+ XFieldOcc x -> noExtCon x
724+ fields = located' (p_hsRecField . updName) <$> rec_flds
299 case rec_dotdot of
726 case rec_dotdot of
300 Just {} -> [txt ".."]
727 Just {} -> [txt ".."]
301 Nothing -> []
728 Nothing -> []
302− inci $ braces $ velt (withSep comma id (fields <> dotdot))
729+ inci . braces N $
730+ sep commaDel sitcc (fields <> dotdot)
303 RecordUpd {..} -> do
731 RecordUpd {..} -> do
304 located rupd_expr p_hsExpr
732 located rupd_expr p_hsExpr
305− breakpoint
733+ useRecordDot' <- useRecordDot
306− inci $ braces $ velt (withSep comma (located' p_hsRecField) rupd_flds)
734+ let mrs sp = case getLoc sp of
307− ExprWithTySig affix x -> do
735+ RealSrcSpan r -> Just r
738+ ((1 +) . srcSpanEndCol <$> mrs rupd_expr)
739+ == (srcSpanStartCol <$> mrs (head rupd_flds))
740+ unless (useRecordDot' && isPluginForm) breakpoint
742+ (f :: HsRecUpdField GhcPs)
743+ { hsRecFieldLbl = case unLoc $ hsRecFieldLbl f of
745+ Unambiguous _ n -> n
746+ XAmbiguousFieldOcc x -> noExtCon x
751+ (sitcc . located' (p_hsRecField . updName))
753+ ExprWithTySig NoExtField x HsWC {hswc_body = HsIB {..}} -> sitcc $ do
308 located x p_hsExpr
754 located x p_hsExpr
309 breakpoint
757 breakpoint
310− inci $ do
758+ inci $ located hsib_body p_hsType
311− txt ":: "
759+ ExprWithTySig NoExtField _ HsWC {hswc_body = XHsImplicitBndrs x} -> noExtCon x
312− let HsWC {..} = affix
760+ ExprWithTySig NoExtField _ (XHsWildCardBndrs x) -> noExtCon x
313− HsIB {..} = hswc_body
761+ ArithSeq NoExtField _ x ->
314− located hsib_body p_hsType
315− ArithSeq NoExt _ x -> do
316− let breakpoint' = vlayout (return ()) newline
317 case x of
762 case x of
318− From from -> brackets $ do
763+ From from -> brackets s $ do
319 located from p_hsExpr
764 located from p_hsExpr
320− breakpoint'
765+ breakpoint
322− FromThen from next -> brackets $ do
767+ FromThen from next -> brackets s $ do
323− velt (withSep comma (located' p_hsExpr) [from, next])
768+ sep commaDel (located' p_hsExpr) [from, next]
324− breakpoint'
769+ breakpoint
326− FromTo from to -> brackets $ do
771+ FromTo from to -> brackets s $ do
327 located from p_hsExpr
772 located from p_hsExpr
328− breakpoint'
773+ breakpoint
329− txt ".. "
774+ txt ".."
330 located to p_hsExpr
776 located to p_hsExpr
331− FromThenTo from next to -> brackets $ do
777+ FromThenTo from next to -> brackets s $ do
332− velt (withSep comma (located' p_hsExpr) [from, next])
778+ sep commaDel (located' p_hsExpr) [from, next]
333− breakpoint'
779+ breakpoint
334− txt ".. "
780+ txt ".."
335 located to p_hsExpr
782 located to p_hsExpr
336− HsSCC NoExt _ name x -> do
783+ HsSCC NoExtField _ name x -> do
337 txt "{-# SCC "
784 txt "{-# SCC "
338 atom name
785 atom name
339 txt " #-}"
786 txt " #-}"
340 breakpoint
787 breakpoint
341 located x p_hsExpr
788 located x p_hsExpr
342− HsCoreAnn NoExt _ value x -> do
789+ HsCoreAnn NoExtField _ value x -> do
343 txt "{-# CORE "
790 txt "{-# CORE "
344 atom value
791 atom value
345 txt " #-}"
792 txt " #-}"
346 breakpoint
793 breakpoint
347 located x p_hsExpr
794 located x p_hsExpr
348− HsBracket {} -> notImplemented "HsBracket"
795+ HsBracket NoExtField x -> p_hsBracket x
349 HsRnBracketOut {} -> notImplemented "HsRnBracketOut"
796 HsRnBracketOut {} -> notImplemented "HsRnBracketOut"
350 HsTcBracketOut {} -> notImplemented "HsTcBracketOut"
797 HsTcBracketOut {} -> notImplemented "HsTcBracketOut"
351− HsSpliceE {} -> notImplemented "HsSpliceE"
798+ HsSpliceE NoExtField splice -> p_hsSplice splice
352− HsProc {} -> notImplemented "HsProc"
799+ HsProc NoExtField p e -> do
353− HsStatic _ e -> do
800+ txt "proc"
801+ located p $ \x -> do
806+ placeHanging (cmdTopPlacement (unLoc e)) $
807+ located e p_hsCmdTop
354 txt "static"
809 txt "static"
355 breakpoint
810 breakpoint
356 inci (located e p_hsExpr)
811 inci (located e p_hsExpr)
357− HsArrApp {} -> notImplemented "HsArrApp"
358− HsArrForm {} -> notImplemented "HsArrForm"
359 HsTick {} -> notImplemented "HsTick"
812 HsTick {} -> notImplemented "HsTick"
360 HsBinTick {} -> notImplemented "HsBinTick"
813 HsBinTick {} -> notImplemented "HsBinTick"
361 HsTickPragma {} -> notImplemented "HsTickPragma"
814 HsTickPragma {} -> notImplemented "HsTickPragma"
362− EWildPat NoExt -> txt "_"
363− EAsPat {} -> notImplemented "EAsPat"
364− EViewPat {} -> notImplemented "EViewPat"
365− ELazyPat {} -> notImplemented "ELazyPat"
366 HsWrap {} -> notImplemented "HsWrap"
815 HsWrap {} -> notImplemented "HsWrap"
367− XExpr {} -> notImplemented "XExpr"
816+ XExpr x -> noExtCon x
369p_patSynBind :: PatSynBind GhcPs GhcPs -> R ()
818p_patSynBind :: PatSynBind GhcPs GhcPs -> R ()
370p_patSynBind PSB {..} = do
819p_patSynBind PSB {..} = do
371− txt "pattern "
820+ let rhs = do
372− case psb_dir of
821+ space
373− Unidirectional -> do
822+ case psb_dir of
374− p_rdrName psb_id
823+ Unidirectional -> do
826+ located psb_def p_pat
827+ ImplicitBidirectional -> do
830+ located psb_def p_pat
831+ ExplicitBidirectional mgroup -> do
834+ located psb_def p_pat
838+ inci (p_matchGroup (Function psb_id) mgroup)
376− p_patSynDetails psb_args
379− inci (located psb_def p_pat)
380− ImplicitBidirectional -> do
381 p_rdrName psb_id
843 p_rdrName psb_id
845+ switchLayout (getLoc <$> xs) $ do
846+ unless (null xs) breakpoint
847+ sitcc (sep breakpoint p_rdrName xs)
383− p_patSynDetails psb_args
386− located psb_def p_pat
387− ExplicitBidirectional mgroup -> do
388 p_rdrName psb_id
851 p_rdrName psb_id
853+ switchLayout (getLoc . recordPatSynPatVar <$> xs) $ do
854+ unless (null xs) breakpoint
856+ sep commaDel (p_rdrName . recordPatSynPatVar) xs
859+ switchLayout [getLoc l, getLoc r] $ do
868+p_patSynBind (XPatSynBind x) = noExtCon x
873+ (body -> Placement) ->
879+ MatchGroup GhcPs (Located body) ->
881+p_case placer render e mgroup = do
888+ inci (p_matchGroup' placer render Case mgroup)
893+ (body -> Placement) ->
903+p_if placer render if' then' else' = do
906+ located if' p_hsExpr
911+ located then' $ \x ->
912+ placeHanging (placer x) (render x)
916+ located else' $ \x ->
917+ placeHanging (placer x) (render x)
923+ Located (HsLocalBindsLR GhcPs GhcPs) ->
926+p_let render localBinds e = sitcc $ do
929+ dontUseBraces $ sitcc (located localBinds p_hsLocalBinds)
930+ vlayout space (newline >> txt " ")
933+ sitcc (located e render)
935+p_pat :: Pat GhcPs -> R ()
937+ WildPat NoExtField -> txt "_"
938+ VarPat NoExtField name -> p_rdrName name
939+ LazyPat NoExtField pat -> do
942+ AsPat NoExtField name pat -> do
946+ ParPat NoExtField pat ->
947+ located pat (parens S . p_pat)
948+ BangPat NoExtField pat -> do
951+ ListPat NoExtField pats ->
952+ brackets S $ sep commaDel (located' p_pat) pats
953+ TuplePat NoExtField pats boxing -> do
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)
961+ ConPatIn pat details ->
963+ PrefixCon xs -> sitcc $ do
965+ unless (null xs) $ do
967+ inci . sitcc $ sep breakpoint (sitcc . located' p_pat) xs
968+ RecCon (HsRecFields fields dotdot) -> do
973+ Just x -> located x p_pat_hsRecField
974+ inci . braces N . sep commaDel f $
976+ Nothing -> Just <$> fields
977+ Just (L _ n) -> (Just <$> take n fields) ++ [Nothing]
979+ switchLayout [getLoc l, getLoc r] $ do
986+ ConPatOut {} -> notImplemented "ConPatOut" -- presumably created by renamer?
987+ ViewPat NoExtField expr pat -> sitcc $ do
988+ located expr p_hsExpr
992+ inci (located pat p_pat)
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
390− p_patSynDetails psb_args
1002+ located k (atom . ol_val)
391− txt " <-"
1003+ SigPat NoExtField pat hswc -> do
392− breakpoint
1004+ located pat p_pat
393− inci (located psb_def p_pat)
1005+ p_typeAscription hswc
394− newline
1006+ CoPat {} -> notImplemented "CoPat" -- apparently created at some later stage
1007+ XPat x -> noExtCon x
1009+p_pat_hsRecField :: HsRecField' (FieldOcc GhcPs) (LPat GhcPs) -> R ()
1010+p_pat_hsRecField HsRecField {..} = do
1011+ located hsRecFieldLbl $ \x ->
1012+ p_rdrName (rdrNameFieldOcc x)
1013+ unless hsRecPun $ do
1017+ inci (located hsRecFieldArg p_pat)
1019+p_unboxedSum :: BracketStyle -> ConTag -> Arity -> R () -> R ()
1020+p_unboxedSum s tag arity m = do
1021+ let before = tag - 1
1022+ after = arity - before - 1
1023+ args = replicate before Nothing <> [Just m] <> replicate after Nothing
1025+ case x :: Maybe (R ()) of
1032+ parensHash s $ sep (txt "|") f args
1034+p_hsSplice :: HsSplice GhcPs -> R ()
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
1040+ p_rdrName (L srcSpan quoterName)
1042+ -- QuasiQuoters often rely on precise custom strings. We cannot do any
1043+ -- formatting here without potentially breaking someone's code.
1046+ HsSpliced {} -> notImplemented "HsSpliced"
1047+ HsSplicedT {} -> notImplemented "HsSplicedT"
1048+ XSplice x -> noExtCon x
1053+ -- | Splice expression
1055+ -- | Splice decoration
1056+ SpliceDecoration ->
1058+p_hsSpliceTH isTyped expr = \case
1061+ parens N (located expr (sitcc . p_hsExpr))
1064+ located expr (sitcc . p_hsExpr)
1066+ located expr (sitcc . p_hsExpr)
1068+ decoSymbol = if isTyped then "$$" else "$"
1070+p_hsBracket :: HsBracket GhcPs -> R ()
1072+ ExpBr NoExtField expr -> do
1073+ anns <- getEnclosingAnns
1074+ let name = case anns of
1075+ AnnOpenEQ : _ -> ""
1077+ quote name (located expr p_hsExpr)
1078+ PatBr NoExtField pat -> located pat (quote "p" . p_pat)
1079+ DecBrL NoExtField decls -> quote "d" (p_hsDecls Free decls)
1080+ DecBrG NoExtField _ -> notImplemented "DecBrG" -- result of renamer
1081+ TypBr NoExtField ty -> quote "t" (located ty p_hsType)
1082+ VarBr NoExtField isSingleQuote name -> do
1083+ txt (bool "''" "'" isSingleQuote)
1084+ -- HACK As you can see we use 'noLoc' here to be able to pass name into
1085+ -- 'p_rdrName' since the latter expects a "located" thing. The problem
1086+ -- is that 'VarBr' doesn't provide us with location of the name. This in
1087+ -- turn makes it impossible to detect if there are parentheses around
1088+ -- it, etc. So we have to add parentheses manually assuming they are
1089+ -- necessary for all operators.
1092+ (\i -> isPunctuation i || isSymbol i)
1093+ (showOutputable (rdrNameOcc name))
1094+ && not (doesNotNeedExtraParens name)
1095+ wrapper = if isOperator then parens N else id
1096+ wrapper $ p_rdrName (noLoc name)
1097+ TExpBr NoExtField expr -> do
1100+ located expr p_hsExpr
1103+ XBracket x -> noExtCon x
1105+ quote :: Text -> R () -> R ()
1106+ quote name body = do
395 inci $ do
1111 inci $ do
396− line (txt "where")
1112+ dontUseBraces body
397− inci (p_matchGroup (Function psb_id) mgroup)
1113+ breakpoint'
398−p_patSynBind (XPatSynBind NoExt) = notImplemented "XPatSynBind"
1114+ txt "|]"
400−p_patSynDetails :: HsPatSynDetails (Located RdrName) -> R ()
1116+-- Print the source text of a string literal while indenting
401−p_patSynDetails = \case
1117+-- gaps correctly.
402− PrefixCon xs ->
1118+
403− velt' (p_rdrName <$> xs)
1119+p_stringLit :: String -> R ()
404− RecCon xs ->
1120+p_stringLit src =
405− velt' (p_rdrName . recordPatSynPatVar <$> xs)
1121+ let s = splitGaps src
406− InfixCon _ _ -> notImplemented "InfixCon"
1122+ singleLine =
1123+ txt $ Text.pack (mconcat s)
1125+ sitcc $ sep breakpoint (txt . Text.pack) (backslashes s)
1126+ in vlayout singleLine multiLine
1128+ -- Split a string on gaps (backslash delimited whitespaces)
1130+ -- > splitGaps "bar\\ \\fo\\&o" == ["bar", "fo\\&o"]
1131+ splitGaps :: String -> [String]
1134+ let -- A backslash and a whitespace starts a "gap"
1135+ p (Just '\\', _, _) = True
1136+ p (_, '\\', Just c) | ghcSpace c = False
1138+ in case span p (zipPrevNext s) of
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
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)]
1158+ (zip (Nothing : map Just xs) xs)
1159+ (map Just (tail xs) ++ repeat Nothing)
1160+ in map (\((p, x), n) -> (p, x, n)) z
408----------------------------------------------------------------------------
1163----------------------------------------------------------------------------
409-- Helpers
1164-- Helpers
411−getGRHSSpan :: GRHS GhcPs (LHsExpr GhcPs) -> SrcSpan
1166+-- | Return the wrapping function controlling the use of braces according to
412−getGRHSSpan (GRHS NoExt _ body) = getSpan body
1167+-- the current layout.
413−getGRHSSpan (XGRHS NoExt) = notImplemented "XGRHS"
1168+layoutToBraces :: Layout -> R () -> R ()
1169+layoutToBraces = \case
1170+ SingleLine -> useBraces
1173+-- | Append each element in both lists with semigroups. If one list is shorter
1174+-- than the other, return the rest of the longer list unchanged.
1175+liftAppend :: Semigroup a => [a] -> [a] -> [a]
1176+liftAppend [] [] = []
1177+liftAppend [] (y : ys) = y : ys
1178+liftAppend (x : xs) [] = x : xs
1179+liftAppend (x : xs) (y : ys) = x <> y : liftAppend xs ys
1181+getGRHSSpan :: GRHS GhcPs (Located body) -> SrcSpan
1182+getGRHSSpan (GRHS NoExtField guards body) =
1183+ combineSrcSpans' $ getLoc body :| map getLoc guards
1184+getGRHSSpan (XGRHS x) = noExtCon x
1186+-- | Place a thing that may have a hanging form. This function handles how
1187+-- to separate it from preceding expressions and whether to bump indentation
1188+-- depending on what sort of expression we have.
1189+placeHanging :: Placement -> R () -> R ()
1190+placeHanging placement m =
1199+-- | Check if given block contains single expression which has a hanging
1202+ (body -> Placement) ->
1203+ [LGRHS GhcPs (Located body)] ->
1205+blockPlacement placer [L _ (GRHS NoExtField _ (L _ x))] = placer x
1206+blockPlacement _ _ = Normal
1208+-- | Check if given command has a hanging form.
1209+cmdPlacement :: HsCmd GhcPs -> Placement
1210+cmdPlacement = \case
1211+ HsCmdLam NoExtField _ -> Hanging
1212+ HsCmdCase NoExtField _ _ -> Hanging
1213+ HsCmdDo NoExtField _ -> Hanging
1216+cmdTopPlacement :: HsCmdTop GhcPs -> Placement
1217+cmdTopPlacement = \case
1218+ HsCmdTop NoExtField (L _ x) -> cmdPlacement x
1219+ XCmdTop x -> noExtCon x
1221+-- | Check if given expression has a hanging form.
1222+exprPlacement :: HsExpr GhcPs -> Placement
1223+exprPlacement = \case
1224+ -- Only hang lambdas with single line parameter lists
1225+ HsLam NoExtField mg -> case mg of
1226+ MG _ (L _ [L _ (Match NoExtField _ (x : xs) _)]) _
1227+ | isOneLineSpan (combineSrcSpans' $ fmap getLoc (x :| xs)) ->
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)
1238+ HsApp NoExtField _ y -> exprPlacement (unLoc y)
1239+ HsProc NoExtField p _ ->
1240+ -- Indentation breaks if pattern is longer than one line and left
1241+ -- hanging. Consequently, only apply hanging when it is safe.
1242+ if isOneLineSpan (getLoc p)
1247+withGuards :: [LGRHS GhcPs (Located body)] -> Bool
1248+withGuards = any (checkOne . unLoc)
1250+ checkOne :: GRHS GhcPs (Located body) -> Bool
1251+ checkOne (GRHS NoExtField [] _) = False
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
1258+getOpName :: HsExpr GhcPs -> Maybe RdrName
1260+ HsVar NoExtField (L _ a) -> Just a
1263+getOpNameStr :: RdrName -> String
1264+getOpNameStr = occNameString . rdrNameOcc
1267+ -- | Bracket style to use
1269+ OpTree (LHsExpr GhcPs) (LHsExpr GhcPs) ->
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
1278+ (mkSrcSpan (srcSpanStart (opTreeLoc x)) (srcSpanStart (opTreeLoc y)))
1280+ OpNode (L _ n) -> exprPlacement n
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
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)
1299+ switchLayout [opTreeLoc 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
1308+ OpNode (L _ HsDo {}) -> True
1310+ useRecordDot' <- useRecordDot
1322+ inciIf (isDoBlock y) p_y
1324+ && isOneLineSpan (opTreeLoc x)
1325+ && placement == Normal -> do
1331+ | useRecordDot' && gotRecordDot -> do
1333+ when isSection space
1338+ placeHanging placement $ do
1343+-- | Return 'True' if given expression is a record-dot operator expression.
1345+ -- | Operator expression
1347+ -- | Span of the expression on the right-hand side of the operator
1350+isRecordDot op (RealSrcSpan ySpan) = case op of
1351+ HsVar NoExtField (L (RealSrcSpan opSpan) opName) ->
1352+ (getOpNameStr opName == ".") && (srcSpanEndCol opSpan == srcSpanStartCol ySpan)
1354+isRecordDot _ _ = False
1356+-- | Get annotations for the enclosing element.
1357+getEnclosingAnns :: R [AnnKeywordId]
1358+getEnclosingAnns = do
1359+ e <- getEnclosingSpan (const True)
1361+ Nothing -> return []
1362+ Just e' -> getAnns (RealSrcSpan e')