@@ -1,32 +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,
8− , p_hsExpr
10+ p_hsExpr,
12import Bag (bagToList)
16import Bag (bagToList)
13import BasicTypes
17import BasicTypes
14import Control.Monad
18import Control.Monad
15−import Data.Data
19+import Ctype (is_space)
16−import Data.List (sortOn)
20+import Data.Bool (bool)
17−import Data.String (fromString)
21+import Data.Char (isPunctuation, isSymbol)
18−import FastString as GHC
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)
20import Ormolu.Printer.Combinators
31import Ormolu.Printer.Combinators
32+import Ormolu.Printer.Internal
21import Ormolu.Printer.Meat.Common
33import Ormolu.Printer.Meat.Common
34+import {-# SOURCE #-} Ormolu.Printer.Meat.Declaration
22import Ormolu.Printer.Meat.Declaration.Signature
35import Ormolu.Printer.Meat.Declaration.Signature
23import Ormolu.Printer.Meat.Type
36import Ormolu.Printer.Meat.Type
37+import Ormolu.Printer.Operators
24import Ormolu.Utils
38import Ormolu.Utils
25−import Outputable (Outputable (..))
26−import SrcLoc (isOneLineSpan)
27−import qualified Data.List.NonEmpty as NE
28−import qualified Data.Text as T
40+-- | Style of a group of equations.
30data MatchGroupStyle
41data MatchGroupStyle
31 = Function (Located RdrName)
42 = Function (Located RdrName)
32 | PatternBind
43 | PatternBind
@@ -34,565 +45,1149 @@ data MatchGroupStyle
35 | LambdaCase
46 | LambdaCase
48+-- | Style of equations in a group.
37data GroupStyle
49data GroupStyle
38 = EqualSign
50 = EqualSign
39 | RightArrow
51 | RightArrow
41-- | Expression placement. This marks the places where expressions that
53-- | Expression placement. This marks the places where expressions that
42-- implement handing forms may use them.
54-- implement handing forms may use them.
44data Placement
55data Placement
45− = Normal -- ^ Multi-line layout should cause
56+ = -- | Multi-line layout should cause
46− -- insertion of a newline and indentation
57+ -- insertion of a newline and indentation
48− | Hanging -- ^ Expressions that have hanging form
60+ | -- | Expressions that have hanging form
49− -- should use it and avoid bumping one level
61+ -- should use it and avoid bumping one level
50− -- of indentation
62+ -- of indentation
52p_valDecl :: HsBindLR GhcPs GhcPs -> R ()
66p_valDecl :: HsBindLR GhcPs GhcPs -> R ()
53−p_valDecl = line . p_valDecl'
67+p_valDecl = \case
55−p_valDecl' :: HsBindLR GhcPs GhcPs -> R ()
57− FunBind NoExt funId funMatches _ _ -> p_funBind funId funMatches
68+ FunBind NoExtField funId funMatches _ _ -> p_funBind funId funMatches
58− PatBind NoExt pat grhss _ -> p_match PatternBind False [pat] grhss
69+ PatBind NoExtField pat grhss _ -> p_match PatternBind False NoSrcStrict [pat] grhss
59 VarBind {} -> notImplemented "VarBinds" -- introduced by the type checker
70 VarBind {} -> notImplemented "VarBinds" -- introduced by the type checker
60 AbsBinds {} -> notImplemented "AbsBinds" -- introduced by the type checker
71 AbsBinds {} -> notImplemented "AbsBinds" -- introduced by the type checker
61− PatSynBind NoExt psb -> p_patSynBind psb
72+ PatSynBind NoExtField psb -> p_patSynBind psb
62− XHsBindsLR NoExt -> notImplemented "XHsBindsLR"
73+ XHsBindsLR x -> noExtCon x
64−p_funBind
75+p_funBind ::
65− :: Located RdrName
76+ Located RdrName ->
66− -> MatchGroup GhcPs (LHsExpr GhcPs)
77+ MatchGroup GhcPs (LHsExpr GhcPs) ->
68−p_funBind name mgroup =
69− p_matchGroup (Function name) mgroup
79+p_funBind name = p_matchGroup (Function name)
71−p_matchGroup
81+p_matchGroup ::
72− :: MatchGroupStyle
82+ MatchGroupStyle ->
73− -> MatchGroup GhcPs (LHsExpr GhcPs)
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) ->
75−p_matchGroup style MG {..} =
98+p_matchGroup' placer render style MG {..} = do
76− locatedVia Nothing mg_alts $
99+ let ob = case style of
77− newlineSep (located' (\m@Match {..} ->
100+ Case -> id
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)
78− p_match style (isInfixMatch m) m_pats m_grhss))
113+ (isInfixMatch m)
79−p_matchGroup _ (XMatchGroup NoExt) = notImplemented "XMatchGroup"
114+ (matchStrictness m)
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
81−p_match
154+p_match' ::
82− :: MatchGroupStyle
155+ Data body =>
156+ -- | How to get body placement
157+ (body -> Placement) ->
158+ -- | How to print body
160+ -- | Style of this group of equations
83− -> Bool -- ^ Is this an infix match?
162+ -- | Is this an infix match?
164+ -- | Strictness prefix (FunBind)
166+ -- | Argument patterns
84− -> [LPat GhcPs]
167+ [LPat GhcPs] ->
85− -> GRHSs GhcPs (LHsExpr GhcPs)
169+ GRHSs GhcPs (Located body) ->
87−p_match style isInfix m_pats m_grhss = do
171+p_match' placer render style isInfix strictness m_pats GRHSs {..} = do
88− -- NOTE Normally, since patterns may be placed in a multi-line layout, it
172+ -- Normally, since patterns may be placed in a multi-line layout, it is
89− -- is necessary to bump indentation for the pattern group so it's more
173+ -- necessary to bump indentation for the pattern group so it's more
90 -- indented than function name. This in turn means that indentation for
174 -- indented than function name. This in turn means that indentation for
91 -- 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
92 -- 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
93 -- 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
94 -- pattern group is multiline.
178 -- pattern group is multiline.
180+ NoSrcStrict -> return ()
181+ SrcStrict -> txt "!"
95− inci' <- case NE.nonEmpty m_pats of
183+ indentBody <- case NE.nonEmpty m_pats of
96− Nothing -> id <$ case style of
185+ False <$ case style of
97− Function name -> p_rdrName name
186+ Function name -> p_rdrName name
98− _ -> return ()
187+ _ -> return ()
99 Just ne_pats -> do
188 Just ne_pats -> do
100− let combinedSpans = combineSrcSpans' $
189+ let combinedSpans = case style of
190+ Function name -> combineSrcSpans (getLoc name) patSpans
101− getLoc <$> ne_pats
192+ patSpans = combineSrcSpans' (getLoc <$> ne_pats)
102− inci' = if isOneLineSpan combinedSpans
193+ indentBody = not (isOneLineSpan combinedSpans)
105− switchLayout combinedSpans $ do
194+ switchLayout [combinedSpans] $ do
106− let stdCase = velt' (located' p_pat <$> m_pats)
195+ let stdCase = sep breakpoint (located' p_pat) m_pats
107 case style of
196 case style of
108 Function name ->
197 Function name ->
109 p_infixDefHelper
198 p_infixDefHelper
111− inci'
200+ indentBody
112 (p_rdrName name)
201 (p_rdrName name)
113 (located' p_pat <$> m_pats)
202 (located' p_pat <$> m_pats)
114 PatternBind -> stdCase
203 PatternBind -> stdCase
115 Case -> stdCase
204 Case -> stdCase
116 Lambda -> do
205 Lambda -> do
206+ let needsSpace = case unLoc (NE.head ne_pats) of
209+ SplicePat _ _ -> True
212+ when needsSpace space
118− stdCase
213+ sitcc stdCase
119 LambdaCase -> stdCase
214 LambdaCase -> stdCase
120− return inci'
215+ return indentBody
121− inci' $ do
216+ let -- Calculate position of end of patterns. This is useful when we decide
122− let GRHSs {..} = m_grhss
217+ -- about putting certain constructions in hanging positions.
123− hasGuards = withGuards grhssGRHSs
218+ endOfPats = case NE.nonEmpty m_pats of
124− unless (length grhssGRHSs > 1) $ do
125− case style of
219+ Nothing -> case style of
126− Function _ -> txt " ="
220+ Function name -> Just (getLoc name)
127− PatternBind -> txt " ="
221+ _ -> Nothing
128− Case -> unless hasGuards (txt " ->")
222+ Just pats -> (Just . getLoc . NE.last) pats
129− _ -> txt " ->"
223+ isCase = \case
227+ hasGuards = withGuards grhssGRHSs
130− let combinedSpans = combineSrcSpans' $
229+ combineSrcSpans' $
131 getGRHSSpan . unLoc <$> NE.fromList grhssGRHSs
230 getGRHSSpan . unLoc <$> NE.fromList grhssGRHSs
234+ (combineSrcSpans grhssSpan . srcLocSpan . srcSpanEnd)
132− placement = blockPlacement grhssGRHSs
238+ Nothing -> blockPlacement placer grhssGRHSs
133− inciLocalBinds = case placement of
239+ Just spn ->
240+ if onTheSameLine spn grhssSpan
241+ then blockPlacement placer grhssGRHSs
134− Normal -> id
242+ else Normal
136− p_body = do
243+ p_body = do
137− let groupStyle =
244+ let groupStyle =
140− if hasGuards
245+ if isCase style && hasGuards
141− then RightArrow
246+ then RightArrow
142− else EqualSign
247+ else EqualSign
144− newlineSep (located' (p_grhs groupStyle)) grhssGRHSs
248+ sep newline (located' (p_grhs' placer render groupStyle)) grhssGRHSs
145− unless
249+ p_where = do
146− (GHC.isEmptyLocalBindsPR (unLoc grhssLocalBinds))
250+ let whereIsEmpty = GHC.isEmptyLocalBindsPR (unLoc grhssLocalBinds)
147− (inciLocalBinds $ do
251+ unless (GHC.eqEmptyLocalBinds (unLoc grhssLocalBinds)) $ do
148− newline
252+ breakpoint
149− line (txt "where")
253+ txt "where"
254+ unless whereIsEmpty breakpoint
150− inci (located grhssLocalBinds p_hsLocalBinds)
255+ inci $ located grhssLocalBinds p_hsLocalBinds
151− )
256+ inciIf indentBody $ do
257+ unless (length grhssGRHSs > 1) $
152− case style of
258+ case style of
153− Lambda -> placeHanging placement $
259+ Function _ | hasGuards -> return ()
154− switchLayout combinedSpans p_body
260+ Function _ -> space >> inci equals
261+ PatternBind -> space >> inci equals
262+ s | isCase s && hasGuards -> return ()
263+ _ -> space >> txt "->"
155− _ -> switchLayout combinedSpans $
264+ switchLayout [patGrhssSpan] $
156− placeHanging placement p_body
265+ placeHanging placement p_body
267+p_match' _ _ _ _ _ _ (XGRHSs x) = noExtCon x
158p_grhs :: GroupStyle -> GRHS GhcPs (LHsExpr GhcPs) -> R ()
269p_grhs :: GroupStyle -> GRHS GhcPs (LHsExpr GhcPs) -> R ()
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) ->
159−p_grhs style (GRHS NoExt guards body) =
281+p_grhs' placer render style (GRHS NoExtField guards body) =
160 case guards of
282 case guards of
161 [] -> p_body
283 [] -> p_body
163− txt "| "
285+ txt "|"
164− velt $ withSep comma (located' p_stmt) xs
287+ sitcc (sep commaDel (sitcc . located' p_stmt) xs)
166− txt $ case style of
289+ inci $ case style of
167− EqualSign -> "="
290+ EqualSign -> equals
168− RightArrow -> "->"
291+ RightArrow -> txt "->"
169− breakpoint
292+ placeHanging placement p_body
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
172− p_body = located body p_hsExpr
305+ p_body = located body render
173−p_grhs _ (XGRHS NoExt) = notImplemented "XGRHS"
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)
175p_stmt :: Stmt GhcPs (LHsExpr GhcPs) -> R ()
385p_stmt :: Stmt GhcPs (LHsExpr GhcPs) -> R ()
176−p_stmt = \case
386+p_stmt = p_stmt' exprPlacement p_hsExpr
177− LastStmt NoExt _ _ _ ->
387+
178− notImplemented "LastStmt" -- only available after renamer
388+p_stmt' ::
391+ (body -> Placement) ->
394+ -- | Statement to render
395+ Stmt GhcPs (Located body) ->
397+p_stmt' placer render = \case
398+ LastStmt NoExtField body _ _ -> located body render
179− BindStmt NoExt l f _ _ -> do
399+ BindStmt NoExtField p f _ _ -> do
180− located l p_pat
400+ located p p_pat
183− breakpoint
403+ let loc = getLoc p
184− inci (located f p_hsExpr)
404+ placement =
408+ (mkSrcSpan (srcSpanEnd loc) (srcSpanStart l'))
411+ switchLayout [loc, getLoc f] $
412+ placeHanging placement (located f render)
185− ApplicativeStmt {} -> notImplemented "ApplicativeStmt"
413+ ApplicativeStmt {} -> notImplemented "ApplicativeStmt" -- generated by renamer
186− BodyStmt NoExt body _ _ -> located body p_hsExpr
414+ BodyStmt NoExtField body _ _ -> located body render
187− LetStmt NoExt binds -> do
415+ LetStmt NoExtField binds -> do
188− txt "let "
416+ txt "let"
189 sitcc $ located binds p_hsLocalBinds
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.
190− ParStmt {} -> notImplemented "ParStmt"
423+ notImplemented "ParStmt"
191− TransStmt {} -> notImplemented "TransStmt"
424+ TransStmt {..} ->
192− RecStmt {} -> notImplemented "RecStmt"
425+ -- 'TransStmt' only needs to account for render printing itself, since
193− XStmtLR {} -> notImplemented "XStmtLR"
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
195p_hsLocalBinds :: HsLocalBindsLR GhcPs GhcPs -> R ()
471p_hsLocalBinds :: HsLocalBindsLR GhcPs GhcPs -> R ()
196p_hsLocalBinds = \case
472p_hsLocalBinds = \case
197− HsValBinds NoExt (ValBinds NoExt bag lsigs) -> do
473+ HsValBinds NoExtField (ValBinds NoExtField bag lsigs) -> do
198− let ssStart = either
474+ -- When in a single-line layout, there is a chance that the inner
199− (srcSpanStart . getLoc)
475+ -- elements will also contain semicolons and they will confuse the
200− (srcSpanStart . getLoc)
476+ -- parser. so we request braces around every element except the last.
201− items =
477+ br <- layoutToBraces <$> getLayout
479+ let injectLeft (L l x) = L l (Left x)
480+ injectRight (L l x) = L l (Right x)
202− (Left <$> bagToList bag) ++ (Right <$> lsigs)
481+ in (injectLeft <$> bagToList bag) ++ (injectRight <$> lsigs)
203− p_item (Left x) = located x p_valDecl'
482+ positionToBracing = \case
204− p_item (Right x) = located x p_sigDecl'
483+ SinglePos -> id
205− newlineSep p_item (sortOn ssStart items)
484+ FirstPos -> br
488+ positionToBracing p $
489+ withSpacing (either p_valDecl p_sigDecl) item
490+ binds = sortOn (srcSpanStart . getLoc) items
491+ sitcc $ sepSemi p_item' (attachRelativePos binds)
206− HsValBinds NoExt _ -> notImplemented "HsValBinds"
492+ HsValBinds NoExtField _ -> notImplemented "HsValBinds"
207− HsIPBinds NoExt _ -> notImplemented "HsIPBinds"
493+ HsIPBinds NoExtField (IPBinds NoExtField xs) ->
494+ -- Second argument of IPBind is always Left before type-checking.
495+ let p_ipBind (IPBind NoExtField (Left name) expr) = do
500+ useBraces $ inci $ located expr p_hsExpr
501+ p_ipBind (IPBind NoExtField (Right _) _) =
502+ -- Should only occur after the type checker
503+ notImplemented "IPBind _ (Right _) _"
504+ p_ipBind (XIPBind x) = noExtCon x
505+ in sepSemi (located' p_ipBind) xs
506+ HsIPBinds NoExtField _ -> notImplemented "HsIpBinds"
208− EmptyLocalBinds NoExt -> return ()
507+ EmptyLocalBinds NoExtField -> return ()
209− XHsLocalBindsLR _ -> notImplemented "XHsLocalBindsLR"
508+ XHsLocalBindsLR x -> noExtCon x
211−p_hsRecField
510+p_hsRecField ::
212− :: (Data id, Outputable id)
213− => HsRecField' id (LHsExpr GhcPs)
511+ HsRecField' RdrName (LHsExpr GhcPs) ->
215−p_hsRecField = \HsRecField {..} -> do
513+p_hsRecField HsRecField {..} = do
216− located hsRecFieldLbl atom
514+ p_rdrName hsRecFieldLbl
217− unless hsRecPun $ do
515+ unless hsRecPun $ do
219− located hsRecFieldArg p_hsExpr
517+ equals
221−p_hsTupArg :: HsTupArg GhcPs -> R ()
519+ if onTheSameLine (getLoc hsRecFieldLbl) (getLoc hsRecFieldArg)
222−p_hsTupArg = \case
520+ then exprPlacement (unLoc hsRecFieldArg)
223− Present NoExt x -> located x p_hsExpr
521+ else Normal
224− Missing NoExt -> pure ()
522+ placeHanging placement (located hsRecFieldArg p_hsExpr)
225− XTupArg {} -> notImplemented "XTupArg"
227p_hsExpr :: HsExpr GhcPs -> R ()
524p_hsExpr :: HsExpr GhcPs -> R ()
228−p_hsExpr = \case
525+p_hsExpr = p_hsExpr' N
527+p_hsExpr' :: BracketStyle -> HsExpr GhcPs -> R ()
229− HsVar NoExt name -> p_rdrName name
529+ HsVar NoExtField name -> p_rdrName name
230− HsUnboundVar NoExt _ -> notImplemented "HsUnboundVar"
530+ HsUnboundVar NoExtField v -> atom (unboundVarOcc v)
231− HsConLikeOut NoExt _ -> notImplemented "HsConLikeOut"
531+ HsConLikeOut NoExtField _ -> notImplemented "HsConLikeOut"
232− HsRecFld NoExt x ->
532+ HsRecFld NoExtField x ->
233 case x of
533 case x of
234− Unambiguous NoExt name -> p_rdrName name
534+ Unambiguous NoExtField name -> p_rdrName name
235− Ambiguous NoExt name -> p_rdrName name
535+ Ambiguous NoExtField name -> p_rdrName name
236− XAmbiguousFieldOcc NoExt -> notImplemented "XAmbiguousFieldOcc"
536+ XAmbiguousFieldOcc xx -> noExtCon xx
237− HsOverLabel NoExt _ v -> do
537+ HsOverLabel NoExtField _ v -> do
240− HsIPVar NoExt (HsIPName name) -> do
540+ HsIPVar NoExtField (HsIPName name) -> do
242 atom name
542 atom name
243− HsOverLit NoExt v -> atom (ol_val v)
543+ HsOverLit NoExtField v -> atom (ol_val v)
244− HsLit NoExt lit -> atom lit
544+ HsLit NoExtField lit ->
546+ HsString (SourceText stxt) _ -> p_stringLit stxt
547+ HsStringPrim (SourceText stxt) _ -> p_stringLit stxt
245− HsLam NoExt mgroup ->
549+ HsLam NoExtField mgroup ->
246 p_matchGroup Lambda mgroup
550 p_matchGroup Lambda mgroup
247− HsLamCase NoExt mgroup -> do
551+ HsLamCase NoExtField mgroup -> do
248 txt "\\case"
552 txt "\\case"
250− inci (p_matchGroup LambdaCase mgroup)
251− HsApp NoExt f x -> do
253 breakpoint
553 breakpoint
554+ inci (p_matchGroup LambdaCase mgroup)
555+ HsApp NoExtField f x -> do
556+ let -- In order to format function applications with multiple parameters
557+ -- nicer, traverse the AST to gather the function and all the
558+ -- parameters together.
559+ gatherArgs f' knownArgs =
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
254− inci (located x p_hsExpr)
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
255− HsAppType a e -> do
611+ HsAppType NoExtField e a -> do
256 located e p_hsExpr
612 located e p_hsExpr
257 breakpoint
613 breakpoint
258 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
260 located (hswc_body a) p_hsType
621 located (hswc_body a) p_hsType
261− OpApp NoExt x op y -> do
622+ OpApp NoExtField x op y -> do
262− located x p_hsExpr
623+ let opTree = OpBranch (exprOpTree x) op (exprOpTree y)
263− space
624+ p_exprOpTree s (reassociateOpTree getOpName opTree)
265− placeHanging (exprPlacement (unLoc y)) $
267− NegApp NoExt e _ -> do
625+ NegApp NoExtField e _ -> do
269 located e p_hsExpr
628 located e p_hsExpr
629+ HsPar NoExtField e ->
270− HsPar NoExt e -> parens (located e p_hsExpr)
630+ parens s (located e (dontUseBraces . p_hsExpr))
271− SectionL NoExt x op -> do
631+ SectionL NoExtField x op -> do
272 located x p_hsExpr
632 located x p_hsExpr
273 breakpoint
633 breakpoint
274 inci (located op p_hsExpr)
634 inci (located op p_hsExpr)
275− SectionR NoExt op x -> do
635+ SectionR NoExtField op x -> do
276 located op p_hsExpr
636 located op p_hsExpr
637+ useRecordDot' <- useRecordDot
638+ let isRecordDot' = isRecordDot (unLoc op) (getLoc x)
277− breakpoint
639+ unless (useRecordDot' && isRecordDot') breakpoint
278 inci (located x p_hsExpr)
640 inci (located x p_hsExpr)
279− ExplicitTuple NoExt args boxity -> do
641+ ExplicitTuple NoExtField args boxity ->
280 let isSection = any (isMissing . unLoc) args
642 let isSection = any (isMissing . unLoc) args
281 isMissing = \case
643 isMissing = \case
282− Missing NoExt -> True
644+ Missing NoExtField -> True
283 _ -> False
645 _ -> False
647+ Present NoExtField x -> located x p_hsExpr
648+ Missing NoExtField -> pure ()
649+ XTupArg x -> noExtCon x
650+ p_larg = sitcc . located' p_arg
284− let parens' =
651+ parens' =
285 case boxity of
652 case boxity of
286 Boxed -> parens
653 Boxed -> parens
287 Unboxed -> parensHash
654 Unboxed -> parensHash
288− parens' $ if isSection
655+ in if isSection
289− then sequence_ (withSep (txt ",") (located' p_hsTupArg) args)
656+ then
290− else velt (withSep comma (located' p_hsTupArg) args)
657+ switchLayout [] . parens' s $
658+ sep comma p_larg args
660+ switchLayout (getLoc <$> args) . parens' s $
661+ sep commaDel p_larg args
291− ExplicitSum NoExt tag arity e -> do
662+ ExplicitSum NoExtField tag arity e ->
292− let before = tag - 1
293− after = arity - before - 1
294− args = replicate before Nothing <> [Just e] <> replicate after Nothing
296− let isFirst = i == 0
297− isLast = i == arity - 1
300− unless (isFirst || isLast) space
302− unless isFirst space
303− located l p_hsExpr
663+ p_unboxedSum N tag arity (located e p_hsExpr)
305− parensHash $ sequence_ (withSep (txt "|") f (zip args [0..]))
306− HsCase NoExt e mgroup -> do
664+ HsCase NoExtField e mgroup ->
307− txt "case "
665+ p_case exprPlacement p_hsExpr e mgroup
308− located e p_hsExpr
666+ HsIf NoExtField _ if' then' else' ->
667+ p_if exprPlacement p_hsExpr if' then' else'
668+ HsMultiIf NoExtField guards -> do
309− txt " of"
669+ txt "if"
310 breakpoint
670 breakpoint
311− inci (p_matchGroup Case mgroup)
312− HsIf NoExt _ if' then' else' -> do
314− located if' p_hsExpr
317− located then' $ \x -> do
322− located else' $ \x -> do
325− HsMultiIf NoExt guards -> do
327− sitcc $ newlineSep (located' (p_grhs RightArrow)) guards
671+ inci . inci $ sep newline (located' (p_grhs RightArrow)) guards
328− HsLet NoExt localBinds e -> do
672+ HsLet NoExtField localBinds e ->
329− txt "let "
673+ p_let p_hsExpr localBinds e
330− sitcc (located localBinds p_hsLocalBinds)
333− sitcc (located e p_hsExpr)
334− HsDo NoExt ctx es -> do
674+ HsDo NoExtField ctx es -> do
675+ let doBody header = do
678+ ub <- layoutToBraces <$> getLayout
681+ (ub . withSpacing (p_stmt' exprPlacement (p_hsExpr' S)))
683+ compBody = brackets N . located es $ \xs -> do
686+ (breakpoint >> txt "|" >> space)
692+ (located' (sitcc . p_stmt))
695+ lists = foldr (liftAppend . gatherStmt) [] stmts
696+ located yield p_stmt
335 case ctx of
701 case ctx of
336− DoExpr -> txt "do"
702+ DoExpr -> doBody "do"
337− MDoExpr -> txt "mdo"
703+ MDoExpr -> doBody "mdo"
338− ListComp -> notImplemented "ListComp"
704+ ListComp -> compBody
339 MonadComp -> notImplemented "MonadComp"
705 MonadComp -> notImplemented "MonadComp"
340− ArrowExpr -> notImplemented "ArrowExpr"
706+ ArrowExpr -> notImplemented "ArrowExpr"
341 GhciStmtCtxt -> notImplemented "GhciStmtCtxt"
707 GhciStmtCtxt -> notImplemented "GhciStmtCtxt"
342 PatGuard _ -> notImplemented "PatGuard"
708 PatGuard _ -> notImplemented "PatGuard"
343 ParStmtCtxt _ -> notImplemented "ParStmtCtxt"
709 ParStmtCtxt _ -> notImplemented "ParStmtCtxt"
344 TransStmtCtxt _ -> notImplemented "TransStmtCtxt"
710 TransStmtCtxt _ -> notImplemented "TransStmtCtxt"
346− inci $ located es (newlineSep (located' (sitcc . p_stmt)))
347 ExplicitList _ _ xs ->
711 ExplicitList _ _ xs ->
348− brackets $ velt (withSep comma (located' p_hsExpr) xs)
713+ sep commaDel (sitcc . located' p_hsExpr) xs
349 RecordCon {..} -> do
714 RecordCon {..} -> do
350 located rcon_con_name atom
715 located rcon_con_name atom
351 breakpoint
716 breakpoint
352 let HsRecFields {..} = rcon_flds
717 let HsRecFields {..} = rcon_flds
719+ (f :: HsRecField GhcPs (LHsExpr GhcPs))
720+ { hsRecFieldLbl = case unLoc $ hsRecFieldLbl f of
722+ XFieldOcc x -> noExtCon x
353− fields = located' p_hsRecField <$> rec_flds
724+ fields = located' (p_hsRecField . updName) <$> rec_flds
355 case rec_dotdot of
726 case rec_dotdot of
356 Just {} -> [txt ".."]
727 Just {} -> [txt ".."]
357 Nothing -> []
728 Nothing -> []
358− inci $ braces $ velt (withSep comma id (fields <> dotdot))
729+ inci . braces N $
730+ sep commaDel sitcc (fields <> dotdot)
359 RecordUpd {..} -> do
731 RecordUpd {..} -> do
360 located rupd_expr p_hsExpr
732 located rupd_expr p_hsExpr
733+ useRecordDot' <- useRecordDot
734+ let mrs sp = case getLoc sp of
735+ RealSrcSpan r -> Just r
738+ ((1 +) . srcSpanEndCol <$> mrs rupd_expr)
739+ == (srcSpanStartCol <$> mrs (head rupd_flds))
361− breakpoint
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
362− inci $ braces $ velt (withSep comma (located' p_hsRecField) rupd_flds)
751+ (sitcc . located' (p_hsRecField . updName))
363− ExprWithTySig affix x -> sitcc $ do
753+ ExprWithTySig NoExtField x HsWC {hswc_body = HsIB {..}} -> sitcc $ do
364 located x p_hsExpr
754 located x p_hsExpr
365 breakpoint
757 breakpoint
368− let HsWC {..} = affix
369− HsIB {..} = hswc_body
370− located hsib_body p_hsType
758+ inci $ located hsib_body p_hsType
759+ ExprWithTySig NoExtField _ HsWC {hswc_body = XHsImplicitBndrs x} -> noExtCon x
760+ ExprWithTySig NoExtField _ (XHsWildCardBndrs x) -> noExtCon x
371− ArithSeq NoExt _ x -> do
761+ ArithSeq NoExtField _ x ->
372− let breakpoint' = vlayout (return ()) newline
373 case x of
762 case x of
374− From from -> brackets $ do
763+ From from -> brackets s $ do
375 located from p_hsExpr
764 located from p_hsExpr
376− breakpoint'
765+ breakpoint
378− FromThen from next -> brackets $ do
767+ FromThen from next -> brackets s $ do
379− velt (withSep comma (located' p_hsExpr) [from, next])
768+ sep commaDel (located' p_hsExpr) [from, next]
380− breakpoint'
769+ breakpoint
382− FromTo from to -> brackets $ do
771+ FromTo from to -> brackets s $ do
383 located from p_hsExpr
772 located from p_hsExpr
384− breakpoint'
773+ breakpoint
385− txt ".. "
774+ txt ".."
386 located to p_hsExpr
776 located to p_hsExpr
387− FromThenTo from next to -> brackets $ do
777+ FromThenTo from next to -> brackets s $ do
388− velt (withSep comma (located' p_hsExpr) [from, next])
778+ sep commaDel (located' p_hsExpr) [from, next]
389− breakpoint'
779+ breakpoint
390− txt ".. "
780+ txt ".."
391 located to p_hsExpr
782 located to p_hsExpr
392− HsSCC NoExt _ name x -> do
783+ HsSCC NoExtField _ name x -> do
393 txt "{-# SCC "
784 txt "{-# SCC "
394 atom name
785 atom name
395 txt " #-}"
786 txt " #-}"
396 breakpoint
787 breakpoint
397 located x p_hsExpr
788 located x p_hsExpr
398− HsCoreAnn NoExt _ value x -> do
789+ HsCoreAnn NoExtField _ value x -> do
399 txt "{-# CORE "
790 txt "{-# CORE "
400 atom value
791 atom value
401 txt " #-}"
792 txt " #-}"
402 breakpoint
793 breakpoint
403 located x p_hsExpr
794 located x p_hsExpr
404− HsBracket {} -> notImplemented "HsBracket"
795+ HsBracket NoExtField x -> p_hsBracket x
405 HsRnBracketOut {} -> notImplemented "HsRnBracketOut"
796 HsRnBracketOut {} -> notImplemented "HsRnBracketOut"
406 HsTcBracketOut {} -> notImplemented "HsTcBracketOut"
797 HsTcBracketOut {} -> notImplemented "HsTcBracketOut"
407− HsSpliceE NoExt splice -> p_hsSplice splice
798+ HsSpliceE NoExtField splice -> p_hsSplice splice
408− HsProc {} -> notImplemented "HsProc"
799+ HsProc NoExtField p e -> do
801+ located p $ \x -> do
806+ placeHanging (cmdTopPlacement (unLoc e)) $
807+ located e p_hsCmdTop
409− HsStatic _ e -> do
808+ HsStatic _ e -> do
410 txt "static"
809 txt "static"
411 breakpoint
810 breakpoint
412 inci (located e p_hsExpr)
811 inci (located e p_hsExpr)
413− HsArrApp {} -> notImplemented "HsArrApp"
414− HsArrForm {} -> notImplemented "HsArrForm"
415 HsTick {} -> notImplemented "HsTick"
812 HsTick {} -> notImplemented "HsTick"
416 HsBinTick {} -> notImplemented "HsBinTick"
813 HsBinTick {} -> notImplemented "HsBinTick"
417 HsTickPragma {} -> notImplemented "HsTickPragma"
814 HsTickPragma {} -> notImplemented "HsTickPragma"
418− EWildPat NoExt -> txt "_"
419− EAsPat {} -> notImplemented "EAsPat"
420− EViewPat {} -> notImplemented "EViewPat"
421− ELazyPat {} -> notImplemented "ELazyPat"
422 HsWrap {} -> notImplemented "HsWrap"
815 HsWrap {} -> notImplemented "HsWrap"
423− XExpr {} -> notImplemented "XExpr"
816+ XExpr x -> noExtCon x
425p_patSynBind :: PatSynBind GhcPs GhcPs -> R ()
818p_patSynBind :: PatSynBind GhcPs GhcPs -> R ()
426p_patSynBind PSB {..} = do
819p_patSynBind PSB {..} = do
427− txt "pattern "
820+ let rhs = do
428− case psb_dir of
822+ case psb_dir of
429− Unidirectional -> do
823+ Unidirectional -> do
430− p_rdrName psb_id
824+ txt "<-"
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)
432− p_patSynDetails psb_args
435− inci (located psb_def p_pat)
436− ImplicitBidirectional -> do
437 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)
439− p_patSynDetails psb_args
442− located psb_def p_pat
443− ExplicitBidirectional mgroup -> do
444 p_rdrName psb_id
851 p_rdrName psb_id
446− p_patSynDetails psb_args
449− inci (located psb_def p_pat)
451 inci $ do
852 inci $ do
452− line (txt "where")
853+ switchLayout (getLoc . recordPatSynPatVar <$> xs) $ do
453− inci (p_matchGroup (Function psb_id) mgroup)
854+ unless (null xs) breakpoint
856+ sep commaDel (p_rdrName . recordPatSynPatVar) xs
859+ switchLayout [getLoc l, getLoc r] $ do
454−p_patSynBind (XPatSynBind NoExt) = notImplemented "XPatSynBind"
868+p_patSynBind (XPatSynBind x) = noExtCon x
456−p_patSynDetails :: HsPatSynDetails (Located RdrName) -> R ()
870+p_case ::
457−p_patSynDetails = \case
871+ Data body =>
458− PrefixCon xs ->
872+ -- | Placer
459− velt' (p_rdrName <$> xs)
873+ (body -> Placement) ->
460− RecCon xs ->
874+ -- | Render
461− velt' (p_rdrName . recordPatSynPatVar <$> xs)
875+ (body -> R ()) ->
462− InfixCon _ _ -> notImplemented "InfixCon"
876+ -- | Expression
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)
464p_pat :: Pat GhcPs -> R ()
935p_pat :: Pat GhcPs -> R ()
465p_pat = \case
936p_pat = \case
466− WildPat NoExt -> txt "_"
937+ WildPat NoExtField -> txt "_"
467− VarPat NoExt name -> p_rdrName name
938+ VarPat NoExtField name -> p_rdrName name
468− LazyPat NoExt pat -> do
939+ LazyPat NoExtField pat -> do
470 located pat p_pat
941 located pat p_pat
471− AsPat NoExt name pat -> do
942+ AsPat NoExtField name pat -> do
472 p_rdrName name
943 p_rdrName name
474 located pat p_pat
945 located pat p_pat
475− ParPat NoExt pat ->
946+ ParPat NoExtField pat ->
476− located pat (parens . p_pat)
947+ located pat (parens S . p_pat)
477− BangPat NoExt pat -> do
948+ BangPat NoExtField pat -> do
479 located pat p_pat
950 located pat p_pat
480− ListPat NoExt pats -> do
951+ ListPat NoExtField pats ->
481− brackets $ velt (withSep comma (located' p_pat) pats)
952+ brackets S $ sep commaDel (located' p_pat) pats
482− TuplePat NoExt pats boxing -> do
953+ TuplePat NoExtField pats boxing -> do
483− let f =
954+ let parens' =
484 case boxing of
955 case boxing of
485− Boxed -> parens
956+ Boxed -> parens S
486− Unboxed -> parensHash
957+ Unboxed -> parensHash S
487− f $ velt (withSep comma (located' p_pat) pats)
958+ parens' $ sep commaDel (sitcc . located' p_pat) pats
488− SumPat NoExt pat _ _ -> do
959+ SumPat NoExtField pat tag arity ->
489− -- XXX I'm not sure about this one.
490− located pat p_pat
960+ p_unboxedSum S tag arity (located pat p_pat)
491 ConPatIn pat details ->
961 ConPatIn pat details ->
492 case details of
962 case details of
493 PrefixCon xs -> sitcc $ do
963 PrefixCon xs -> sitcc $ do
494 p_rdrName pat
964 p_rdrName pat
495 unless (null xs) $ do
965 unless (null xs) $ do
496 breakpoint
966 breakpoint
497− inci $ velt' (located' p_pat <$> xs)
967+ inci . sitcc $ sep breakpoint (sitcc . located' p_pat) xs
498 RecCon (HsRecFields fields dotdot) -> do
968 RecCon (HsRecFields fields dotdot) -> do
499 p_rdrName pat
969 p_rdrName pat
500 breakpoint
970 breakpoint
501 let f = \case
971 let f = \case
502 Nothing -> txt ".."
972 Nothing -> txt ".."
503 Just x -> located x p_pat_hsRecField
973 Just x -> located x p_pat_hsRecField
974+ inci . braces N . sep commaDel f $
504− inci . braces . velt . withSep comma f $ case dotdot of
975+ case dotdot of
505− Nothing -> Just <$> fields
976+ Nothing -> Just <$> fields
506− Just n -> (Just <$> take n fields) ++ [Nothing]
977+ Just (L _ n) -> (Just <$> take n fields) ++ [Nothing]
507− InfixCon x y -> do
978+ InfixCon l r -> do
979+ switchLayout [getLoc l, getLoc r] $ do
508− located x p_pat
980+ located l p_pat
509− space
981+ breakpoint
510− p_rdrName pat
983+ p_rdrName pat
511− breakpoint
984+ space
512− inci (located y p_pat)
985+ located r p_pat
513− ConPatOut {} -> notImplemented "ConPatOut"
986+ ConPatOut {} -> notImplemented "ConPatOut" -- presumably created by renamer?
514− ViewPat NoExt expr pat -> sitcc $ do
987+ ViewPat NoExtField expr pat -> sitcc $ do
515 located expr p_hsExpr
988 located expr p_hsExpr
516− txt " ->"
990+ txt "->"
517 breakpoint
991 breakpoint
518 inci (located pat p_pat)
992 inci (located pat p_pat)
519− SplicePat NoExt splice -> p_hsSplice splice
993+ SplicePat NoExtField splice -> p_hsSplice splice
520− LitPat NoExt p -> atom p
994+ LitPat NoExtField p -> atom p
521− NPat NoExt v _ _ -> located v (atom . ol_val)
995+ NPat NoExtField v _ _ -> located v (atom . ol_val)
522− NPlusKPat NoExt n k _ _ _ -> sitcc $ do
996+ NPlusKPat NoExtField n k _ _ _ -> sitcc $ do
523 p_rdrName n
997 p_rdrName n
524 breakpoint
998 breakpoint
525 inci $ do
999 inci $ do
526− txt "+ "
1000+ txt "+"
527 located k (atom . ol_val)
1002 located k (atom . ol_val)
528− SigPat hswc pat -> do
1003+ SigPat NoExtField pat hswc -> do
529 located pat p_pat
1004 located pat p_pat
530 p_typeAscription hswc
1005 p_typeAscription hswc
531− CoPat {} -> notImplemented "CoPat"
1006+ CoPat {} -> notImplemented "CoPat" -- apparently created at some later stage
532− XPat NoExt -> notImplemented "XPat"
1007+ XPat x -> noExtCon x
534p_pat_hsRecField :: HsRecField' (FieldOcc GhcPs) (LPat GhcPs) -> R ()
1009p_pat_hsRecField :: HsRecField' (FieldOcc GhcPs) (LPat GhcPs) -> R ()
535p_pat_hsRecField HsRecField {..} = do
1010p_pat_hsRecField HsRecField {..} = do
536 located hsRecFieldLbl $ \x ->
1011 located hsRecFieldLbl $ \x ->
537 p_rdrName (rdrNameFieldOcc x)
1012 p_rdrName (rdrNameFieldOcc x)
538 unless hsRecPun $ do
1013 unless hsRecPun $ do
540 breakpoint
1016 breakpoint
541 inci (located hsRecFieldArg p_pat)
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
543p_hsSplice :: HsSplice GhcPs -> R ()
1034p_hsSplice :: HsSplice GhcPs -> R ()
544p_hsSplice = \case
1035p_hsSplice = \case
545− HsTypedSplice NoExt deco _ expr -> p_hsSpliceTH True expr deco
1036+ HsTypedSplice NoExtField deco _ expr -> p_hsSpliceTH True expr deco
546− HsUntypedSplice NoExt deco _ expr -> p_hsSpliceTH False expr deco
1037+ HsUntypedSplice NoExtField deco _ expr -> p_hsSpliceTH False expr deco
547− HsQuasiQuote NoExt _ quoterName srcSpan str -> do
1038+ HsQuasiQuote NoExtField _ quoterName srcSpan str -> do
548− let locatedQuoterName = L srcSpan quoterName
1040+ p_rdrName (L srcSpan quoterName)
549− p_quasiQuote locatedQuoterName $ do
1041+ txt "|"
550− let p x = unless (T.null x) (txt x)
1042+ -- QuasiQuoters often rely on precise custom strings. We cannot do any
551− newlineSep (p . T.strip) (T.lines . T.strip . fromString . GHC.unpackFS $ str)
1043+ -- formatting here without potentially breaking someone's code.
552 HsSpliced {} -> notImplemented "HsSpliced"
1046 HsSpliced {} -> notImplemented "HsSpliced"
553− XSplice {} -> notImplemented "XSplice"
1047+ HsSplicedT {} -> notImplemented "HsSplicedT"
1048+ XSplice x -> noExtCon x
555−p_hsSpliceTH
1050+p_hsSpliceTH ::
556− :: Bool -- ^ Typed splice?
1051+ -- | Typed splice?
1053+ -- | Splice expression
557− -> LHsExpr GhcPs -- ^ Splice expression
1054+ LHsExpr GhcPs ->
1055+ -- | Splice decoration
558− -> SpliceDecoration -- ^ Splice decoration
1056+ SpliceDecoration ->
560p_hsSpliceTH isTyped expr = \case
1058p_hsSpliceTH isTyped expr = \case
561 HasParens -> do
1059 HasParens -> do
562 txt decoSymbol
1060 txt decoSymbol
563− parens (located expr p_hsExpr)
1061+ parens N (located expr (sitcc . p_hsExpr))
564 HasDollar -> do
1062 HasDollar -> do
565 txt decoSymbol
1063 txt decoSymbol
566− located expr p_hsExpr
1064+ located expr (sitcc . p_hsExpr)
567− NoParens -> do
1065+ NoParens ->
568− located expr p_hsExpr
1066+ located expr (sitcc . p_hsExpr)
570 decoSymbol = if isTyped then "$$" else "$"
1068 decoSymbol = if isTyped then "$$" else "$"
572−p_quasiQuote :: Located RdrName -> R () -> R ()
1070+p_hsBracket :: HsBracket GhcPs -> R ()
573−p_quasiQuote quoter m = do
1071+p_hsBracket = \case
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
574− txt "["
1098+ txt "[||"
575− p_rdrName quoter
1099+ breakpoint'
1100+ located expr p_hsExpr
576− txt "|"
1102+ txt "||]"
577− let breakpoint' = vlayout (return ()) newline
1103+ XBracket x -> noExtCon x
1105+ quote :: Text -> R () -> R ()
1106+ quote name body = do
578− breakpoint'
1110+ breakpoint'
579− inci m
1111+ inci $ do
580− breakpoint'
1113+ breakpoint'
581− txt "|]"
1114+ txt "|]"
1116+-- Print the source text of a string literal while indenting
1119+p_stringLit :: String -> R ()
1121+ let s = splitGaps src
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
583----------------------------------------------------------------------------
1163----------------------------------------------------------------------------
584-- Helpers
1164-- Helpers
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
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
586−getGRHSSpan :: GRHS GhcPs (LHsExpr GhcPs) -> SrcSpan
1181+getGRHSSpan :: GRHS GhcPs (Located body) -> SrcSpan
587−getGRHSSpan (GRHS NoExt _ body) = getLoc body
1182+getGRHSSpan (GRHS NoExtField guards body) =
1183+ combineSrcSpans' $ getLoc body :| map getLoc guards
588−getGRHSSpan (XGRHS NoExt) = notImplemented "XGRHS"
1184+getGRHSSpan (XGRHS x) = noExtCon x
590-- | Place a thing that may have a hanging form. This function handles how
1186-- | Place a thing that may have a hanging form. This function handles how
591-- to separate it from preceding expressions and whether to bump indentation
1187-- to separate it from preceding expressions and whether to bump indentation
592-- depending on what sort of expression we have.
1188-- depending on what sort of expression we have.
594placeHanging :: Placement -> R () -> R ()
1189placeHanging :: Placement -> R () -> R ()
595−placeHanging placement m = do
1190+placeHanging placement m =
596 case placement of
1191 case placement of
597 Hanging -> do
1192 Hanging -> do
@@ -603,25 +1198,165 @@ placeHanging placement m = do
604-- | Check if given block contains single expression which has a hanging
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
607−blockPlacement :: [LGRHS GhcPs (LHsExpr GhcPs)] -> Placement
1208+-- | Check if given command has a hanging form.
608−blockPlacement [(L _ (GRHS NoExt _ (L _ e)))] = exprPlacement e
1209+cmdPlacement :: HsCmd GhcPs -> Placement
1210+cmdPlacement = \case
1211+ HsCmdLam NoExtField _ -> Hanging
1212+ HsCmdCase NoExtField _ _ -> Hanging
1213+ HsCmdDo NoExtField _ -> Hanging
609−blockPlacement _ = Normal
1214+ _ -> Normal
611−-- | Check if given expression has hinging a form.
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.
613exprPlacement :: HsExpr GhcPs -> Placement
1222exprPlacement :: HsExpr GhcPs -> Placement
614exprPlacement = \case
1223exprPlacement = \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)) ->
615− HsLam NoExt _ -> Hanging
1228+ Hanging
616− HsLamCase NoExt _ -> Hanging
1230+ HsLamCase NoExtField _ -> Hanging
617− HsCase NoExt _ _ -> Hanging
1231+ HsCase NoExtField _ _ -> Hanging
618− HsDo NoExt _ _ -> 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)
619− RecordCon NoExt _ _ -> Hanging
1243+ then Hanging
620 _ -> Normal
1245 _ -> Normal
622−withGuards :: [LGRHS GhcPs (LHsExpr GhcPs)] -> Bool
1247+withGuards :: [LGRHS GhcPs (Located body)] -> Bool
623withGuards = any (checkOne . unLoc)
1248withGuards = any (checkOne . unLoc)
625− checkOne :: GRHS GhcPs (LHsExpr GhcPs) -> Bool
1250+ checkOne :: GRHS GhcPs (Located body) -> Bool
626− checkOne (GRHS NoExt [] _) = False
1251+ checkOne (GRHS NoExtField [] _) = False
627 checkOne _ = True
1252 checkOne _ = True
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')