@@ -1,36 +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,
9− , p_hsSplice
11+ p_hsSplice,
13−import Ormolu.Printer.Internal
14import Bag (bagToList)
16import Bag (bagToList)
15import BasicTypes
17import BasicTypes
16import Control.Monad
18import Control.Monad
19+import Ctype (is_space)
17import Data.Bool (bool)
20import Data.Bool (bool)
18−import Data.Char (isPunctuation)
21+import Data.Char (isPunctuation, isSymbol)
19import Data.Data hiding (Infix, Prefix)
22import Data.Data hiding (Infix, Prefix)
23+import Data.Functor ((<&>))
20import Data.List (intersperse, sortOn)
24import Data.List (intersperse, sortOn)
25+import Data.List.NonEmpty (NonEmpty (..), (<|))
26+import qualified Data.List.NonEmpty as NE
21import Data.Text (Text)
27import Data.Text (Text)
28+import qualified Data.Text as Text
30+import OccName (occNameString)
23import Ormolu.Printer.Combinators
31import Ormolu.Printer.Combinators
32+import Ormolu.Printer.Internal
24import Ormolu.Printer.Meat.Common
33import Ormolu.Printer.Meat.Common
34+import {-# SOURCE #-} Ormolu.Printer.Meat.Declaration
25import Ormolu.Printer.Meat.Declaration.Signature
35import Ormolu.Printer.Meat.Declaration.Signature
26import Ormolu.Printer.Meat.Type
36import Ormolu.Printer.Meat.Type
37+import Ormolu.Printer.Operators
27import Ormolu.Utils
38import Ormolu.Utils
28−import Outputable (Outputable (..))
29−import RdrName (rdrNameOcc)
30−import SrcLoc (combineSrcSpans, isOneLineSpan)
31−import qualified Data.List.NonEmpty as NE
32−import {-# SOURCE #-} Ormolu.Printer.Meat.Declaration
40+-- | Style of a group of equations.
34data MatchGroupStyle
41data MatchGroupStyle
35 = Function (Located RdrName)
42 = Function (Located RdrName)
36 | PatternBind
43 | PatternBind
@@ -38,87 +45,132 @@ data MatchGroupStyle
39 | LambdaCase
46 | LambdaCase
48+-- | Style of equations in a group.
41data GroupStyle
49data GroupStyle
42 = EqualSign
50 = EqualSign
43 | RightArrow
51 | RightArrow
45-- | Expression placement. This marks the places where expressions that
53-- | Expression placement. This marks the places where expressions that
46-- implement handing forms may use them.
54-- implement handing forms may use them.
48data Placement
55data Placement
49− = Normal -- ^ Multi-line layout should cause
56+ = -- | Multi-line layout should cause
50− -- insertion of a newline and indentation
57+ -- insertion of a newline and indentation
52− | Hanging -- ^ Expressions that have hanging form
60+ | -- | Expressions that have hanging form
53− -- should use it and avoid bumping one level
61+ -- should use it and avoid bumping one level
54− -- of indentation
62+ -- of indentation
56p_valDecl :: HsBindLR GhcPs GhcPs -> R ()
66p_valDecl :: HsBindLR GhcPs GhcPs -> R ()
57−p_valDecl = line . p_valDecl'
67+p_valDecl = \case
59−p_valDecl' :: HsBindLR GhcPs GhcPs -> R ()
61− FunBind NoExt funId funMatches _ _ -> p_funBind funId funMatches
68+ FunBind NoExtField funId funMatches _ _ -> p_funBind funId funMatches
62− PatBind NoExt pat grhss _ -> p_match PatternBind False NoSrcStrict [pat] grhss
69+ PatBind NoExtField pat grhss _ -> p_match PatternBind False NoSrcStrict [pat] grhss
63 VarBind {} -> notImplemented "VarBinds" -- introduced by the type checker
70 VarBind {} -> notImplemented "VarBinds" -- introduced by the type checker
64 AbsBinds {} -> notImplemented "AbsBinds" -- introduced by the type checker
71 AbsBinds {} -> notImplemented "AbsBinds" -- introduced by the type checker
65− PatSynBind NoExt psb -> p_patSynBind psb
72+ PatSynBind NoExtField psb -> p_patSynBind psb
66− XHsBindsLR NoExt -> notImplemented "XHsBindsLR"
73+ XHsBindsLR x -> noExtCon x
68−p_funBind
75+p_funBind ::
69− :: Located RdrName
76+ Located RdrName ->
70− -> MatchGroup GhcPs (LHsExpr GhcPs)
77+ MatchGroup GhcPs (LHsExpr GhcPs) ->
72−p_funBind name mgroup =
73− p_matchGroup (Function name) mgroup
79+p_funBind name = p_matchGroup (Function name)
75−p_matchGroup
81+p_matchGroup ::
76− :: MatchGroupStyle
82+ MatchGroupStyle ->
77− -> MatchGroup GhcPs (LHsExpr GhcPs)
83+ MatchGroup GhcPs (LHsExpr GhcPs) ->
79p_matchGroup = p_matchGroup' exprPlacement p_hsExpr
85p_matchGroup = p_matchGroup' exprPlacement p_hsExpr
81−p_matchGroup'
87+p_matchGroup' ::
82− :: Data body
88+ Data body =>
89+ -- | How to get body placement
83− => (body -> Placement)
90+ (body -> Placement) ->
91+ -- | How to print body
84− -> (body -> R ())
92+ (body -> R ()) ->
85− -> MatchGroupStyle
93+ -- | Style of this group of equations
86− -> MatchGroup GhcPs (Located body)
96+ MatchGroup GhcPs (Located body) ->
88−p_matchGroup' placer pretty style MG {..} =
98+p_matchGroup' placer render style MG {..} = do
89− sep newline (located' (\m@Match {..} ->
99+ let ob = case style of
90− p_match' placer pretty style (isInfixMatch m) (matchStrictness m) m_pats m_grhss))
100+ Case -> id
91− (unLoc mg_alts)
101+ LambdaCase -> 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)
117+ p_Match (XMatch x) = noExtCon x
92−p_matchGroup' _ _ _ (XMatchGroup NoExt) = notImplemented "XMatchGroup"
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
94matchStrictness :: Match id body -> SrcStrictness
134matchStrictness :: Match id body -> SrcStrictness
95matchStrictness match =
135matchStrictness match =
96 case m_ctxt match of
136 case m_ctxt match of
97− FunRhs{mc_strictness=s} -> s
137+ FunRhs {mc_strictness = s} -> s
98 _ -> NoSrcStrict
138 _ -> NoSrcStrict
100−p_match
140+p_match ::
141+ -- | Style of the group
101− :: MatchGroupStyle
142+ MatchGroupStyle ->
102− -> Bool -- ^ Is this an infix match?
143+ -- | Is this an infix match?
103− -> SrcStrictness -- ^ Strictness prefix (FunBind)
145+ -- | Strictness prefix (FunBind)
147+ -- | Argument patterns
104− -> [LPat GhcPs]
148+ [LPat GhcPs] ->
105− -> GRHSs GhcPs (LHsExpr GhcPs)
150+ GRHSs GhcPs (LHsExpr GhcPs) ->
107p_match = p_match' exprPlacement p_hsExpr
152p_match = p_match' exprPlacement p_hsExpr
109−p_match'
154+p_match' ::
110− :: Data body
155+ Data body =>
156+ -- | How to get body placement
111− => (body -> Placement)
157+ (body -> Placement) ->
158+ -- | How to print body
112− -> (body -> R ())
159+ (body -> R ()) ->
160+ -- | Style of this group of equations
113− -> MatchGroupStyle
161+ MatchGroupStyle ->
114− -> Bool -- ^ Is this an infix match?
162+ -- | Is this an infix match?
115− -> SrcStrictness -- ^ Strictness prefix (FunBind)
164+ -- | Strictness prefix (FunBind)
166+ -- | Argument patterns
116− -> [LPat GhcPs]
167+ [LPat GhcPs] ->
117− -> GRHSs GhcPs (Located body)
169+ GRHSs GhcPs (Located body) ->
119−p_match' placer pretty style isInfix strictness m_pats m_grhss = do
171+p_match' placer render style isInfix strictness m_pats GRHSs {..} = do
120− -- 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
121− -- 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
122 -- indented than function name. This in turn means that indentation for
174 -- indented than function name. This in turn means that indentation for
123 -- 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
124 -- 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
@@ -128,23 +180,24 @@ p_match' placer pretty style isInfix strictness m_pats m_grhss = do
128 NoSrcStrict -> return ()
180 NoSrcStrict -> return ()
129 SrcStrict -> txt "!"
181 SrcStrict -> txt "!"
130 SrcLazy -> txt "~"
182 SrcLazy -> txt "~"
131− inci' <- case NE.nonEmpty m_pats of
183+ indentBody <- case NE.nonEmpty m_pats of
132− Nothing -> id <$ case style of
185+ False <$ case style of
133− Function name -> p_rdrName name
186+ Function name -> p_rdrName name
134− _ -> return ()
187+ _ -> return ()
135 Just ne_pats -> do
188 Just ne_pats -> do
136− let combinedSpans = combineSrcSpans' $
189+ let combinedSpans = case style of
190+ Function name -> combineSrcSpans (getLoc name) patSpans
137− getLoc <$> ne_pats
192+ patSpans = combineSrcSpans' (getLoc <$> ne_pats)
138− inci' = if isOneLineSpan combinedSpans
193+ indentBody = not (isOneLineSpan combinedSpans)
141 switchLayout [combinedSpans] $ do
194 switchLayout [combinedSpans] $ do
142 let stdCase = sep breakpoint (located' p_pat) m_pats
195 let stdCase = sep breakpoint (located' p_pat) m_pats
143 case style of
196 case style of
144 Function name ->
197 Function name ->
145 p_infixDefHelper
198 p_infixDefHelper
147− inci'
200+ indentBody
148 (p_rdrName name)
201 (p_rdrName name)
149 (located' p_pat <$> m_pats)
202 (located' p_pat <$> m_pats)
150 PatternBind -> stdCase
203 PatternBind -> stdCase
@@ -155,225 +208,256 @@ p_match' placer pretty style isInfix strictness m_pats m_grhss = do
155 BangPat _ _ -> True
208 BangPat _ _ -> True
156 SplicePat _ _ -> True
209 SplicePat _ _ -> True
157 _ -> False
210 _ -> False
158− txt (if needsSpace then "\\ " else "\\")
212+ when needsSpace space
159− stdCase
213+ sitcc stdCase
160 LambdaCase -> stdCase
214 LambdaCase -> stdCase
161− return inci'
215+ return indentBody
164− -- Calculate position of end of patterns. This is useful when we decide
216+ let -- Calculate position of end of patterns. This is useful when we decide
165− -- about putting certain constructions in hanging positions.
217+ -- about putting certain constructions in hanging positions.
166− endOfPats = case NE.nonEmpty m_pats of
218+ endOfPats = case NE.nonEmpty m_pats of
167− Nothing -> case style of
219+ Nothing -> case style of
168− Function name -> (Just . srcSpanEnd . getLoc) name
220+ Function name -> Just (getLoc name)
169− _ -> Nothing
221+ _ -> Nothing
170− Just pats -> (Just . srcSpanEnd . getLoc . NE.last) pats
222+ Just pats -> (Just . getLoc . NE.last) pats
171− isCase = \case
223+ isCase = \case
172− Case -> True
224+ Case -> True
173− LambdaCase -> True
225+ LambdaCase -> True
174− _ -> False
226+ _ -> False
176− let GRHSs {..} = m_grhss
177− hasGuards = withGuards grhssGRHSs
227+ hasGuards = withGuards grhssGRHSs
178− unless (length grhssGRHSs > 1) $ do
228+ grhssSpan =
180− Function _ | hasGuards -> return ()
181− Function _ -> txt " ="
182− PatternBind -> txt " ="
183− s | isCase s && hasGuards -> return ()
185− let grhssSpan = combineSrcSpans' $
229+ combineSrcSpans' $
186 getGRHSSpan . unLoc <$> NE.fromList grhssGRHSs
230 getGRHSSpan . unLoc <$> NE.fromList grhssGRHSs
187− patGrhssSpan = maybe grhssSpan
231+ patGrhssSpan =
188− (combineSrcSpans grhssSpan . srcLocSpan) endOfPats
234+ (combineSrcSpans grhssSpan . srcLocSpan . srcSpanEnd)
189− placement =
236+ placement =
190− case endOfPats of
237+ case endOfPats of
191− Nothing -> blockPlacement placer grhssGRHSs
238+ Nothing -> blockPlacement placer grhssGRHSs
192− Just spn ->
239+ Just spn ->
194− (mkSrcSpan spn (srcSpanStart grhssSpan))
240+ if onTheSameLine spn grhssSpan
195− then blockPlacement placer grhssGRHSs
241+ then blockPlacement placer grhssGRHSs
196− else Normal
242+ else Normal
197− inciLocalBinds = case placement of
200− p_body = do
243+ p_body = do
201− let groupStyle =
244+ let groupStyle =
202− if isCase style && hasGuards
245+ if isCase style && hasGuards
203 then RightArrow
246 then RightArrow
204 else EqualSign
247 else EqualSign
205− sep newline (located' (p_grhs' pretty groupStyle)) grhssGRHSs
248+ sep newline (located' (p_grhs' placer render groupStyle)) grhssGRHSs
206− let whereLocation = combineSrcSpans patGrhssSpan $ getLoc grhssLocalBinds
249+ p_where = do
207− whereIsEmpty = GHC.isEmptyLocalBindsPR (unLoc grhssLocalBinds)
250+ let whereIsEmpty = GHC.isEmptyLocalBindsPR (unLoc grhssLocalBinds)
208− unless (GHC.eqEmptyLocalBinds (unLoc grhssLocalBinds))
251+ unless (GHC.eqEmptyLocalBinds (unLoc grhssLocalBinds)) $ do
210− . switchLayout [whereLocation] $ do
211− if whereIsEmpty then newline else breakpoint
252+ breakpoint
212− txt "where"
253+ txt "where"
213− unless whereIsEmpty $ do
254+ unless whereIsEmpty breakpoint
215− inci (located grhssLocalBinds p_hsLocalBinds)
255+ inci $ located grhssLocalBinds p_hsLocalBinds
256+ inciIf indentBody $ do
257+ unless (length grhssGRHSs > 1) $
216− case style of
258+ case style of
217− Lambda -> placeHanging placement $
259+ Function _ | hasGuards -> return ()
218− switchLayout [patGrhssSpan] p_body
260+ Function _ -> space >> inci equals
261+ PatternBind -> space >> inci equals
262+ s | isCase s && hasGuards -> return ()
263+ _ -> space >> txt "->"
219− _ -> switchLayout [patGrhssSpan] $
264+ switchLayout [patGrhssSpan] $
220− placeHanging placement p_body
265+ placeHanging placement p_body
267+p_match' _ _ _ _ _ _ (XGRHSs x) = noExtCon x
222p_grhs :: GroupStyle -> GRHS GhcPs (LHsExpr GhcPs) -> R ()
269p_grhs :: GroupStyle -> GRHS GhcPs (LHsExpr GhcPs) -> R ()
223−p_grhs = p_grhs' p_hsExpr
270+p_grhs = p_grhs' exprPlacement p_hsExpr
225−p_grhs'
272+p_grhs' ::
226− :: Data body
273+ Data body =>
274+ -- | How to get body placement
275+ (body -> Placement) ->
276+ -- | How to print body
227− => (body -> R ())
277+ (body -> R ()) ->
228− -> GroupStyle
278+ GroupStyle ->
229− -> GRHS GhcPs (Located body)
279+ GRHS GhcPs (Located body) ->
231−p_grhs' pretty style (GRHS NoExt guards body) =
281+p_grhs' placer render style (GRHS NoExtField guards body) =
232 case guards of
282 case guards of
233 [] -> p_body
283 [] -> p_body
235− txt "| "
285+ txt "|"
236− sitcc (sep (comma >> breakpoint) (sitcc . located' p_stmt) xs)
287+ sitcc (sep commaDel (sitcc . located' p_stmt) xs)
238− txt $ case style of
289+ inci $ case style of
239− EqualSign -> "="
290+ EqualSign -> equals
240− RightArrow -> "->"
291+ RightArrow -> txt "->"
241− 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
244− p_body = located body pretty
305+ p_body = located body render
245−p_grhs' _ _ (XGRHS NoExt) = notImplemented "XGRHS"
306+p_grhs' _ _ _ (XGRHS x) = noExtCon x
247p_hsCmd :: HsCmd GhcPs -> R ()
308p_hsCmd :: HsCmd GhcPs -> R ()
248p_hsCmd = \case
309p_hsCmd = \case
249− HsCmdArrApp NoExt body input arrType _ -> do
310+ HsCmdArrApp NoExtField body input arrType _ -> do
250 located body p_hsExpr
311 located body p_hsExpr
251− txt $ case arrType of
314+ case arrType of
252− HsFirstOrderApp -> " -<"
315+ HsFirstOrderApp -> txt "-<"
253− HsHigherOrderApp -> " -<<"
316+ HsHigherOrderApp -> txt "-<<"
254− placeHanging (exprPlacement (unLoc input)) $
317+ placeHanging (exprPlacement (unLoc input)) $
255− located input p_hsExpr
318+ located input p_hsExpr
256− HsCmdArrForm NoExt form Prefix _ cmds -> banana $ sitcc $ do
319+ HsCmdArrForm NoExtField form Prefix _ cmds -> banana $ do
257 located form p_hsExpr
320 located form p_hsExpr
258 unless (null cmds) $ do
321 unless (null cmds) $ do
259 breakpoint
322 breakpoint
260 inci (sequence_ (intersperse breakpoint (located' p_hsCmdTop <$> cmds)))
323 inci (sequence_ (intersperse breakpoint (located' p_hsCmdTop <$> cmds)))
261− HsCmdArrForm NoExt form Infix _ [left, right] -> do
324+ HsCmdArrForm NoExtField form Infix _ [left, right] -> do
262 located left p_hsCmdTop
325 located left p_hsCmdTop
264 located form p_hsExpr
327 located form p_hsExpr
265 placeHanging (cmdTopPlacement (unLoc right)) $
328 placeHanging (cmdTopPlacement (unLoc right)) $
266 located right p_hsCmdTop
329 located right p_hsCmdTop
267− HsCmdArrForm NoExt _ Infix _ _ -> notImplemented "HsCmdArrForm"
330+ HsCmdArrForm NoExtField _ Infix _ _ -> notImplemented "HsCmdArrForm"
268 HsCmdApp {} ->
331 HsCmdApp {} ->
269 -- XXX Does this ever occur in the syntax tree? It does not seem like it
332 -- XXX Does this ever occur in the syntax tree? It does not seem like it
270 -- does. Open an issue and ping @yumiova if this ever occurs in output.
333 -- does. Open an issue and ping @yumiova if this ever occurs in output.
271 notImplemented "HsCmdApp"
334 notImplemented "HsCmdApp"
272− HsCmdLam NoExt mgroup -> p_matchGroup' cmdPlacement p_hsCmd Lambda mgroup
335+ HsCmdLam NoExtField mgroup -> p_matchGroup' cmdPlacement p_hsCmd Lambda mgroup
273− HsCmdPar NoExt c -> parens (located c p_hsCmd)
336+ HsCmdPar NoExtField c -> parens N (located c p_hsCmd)
274− HsCmdCase NoExt e mgroup -> do
337+ HsCmdCase NoExtField e mgroup ->
279− inci (p_matchGroup' cmdPlacement p_hsCmd Case mgroup)
338+ p_case cmdPlacement p_hsCmd e mgroup
280− HsCmdIf NoExt _ if' then' else' -> do
339+ HsCmdIf NoExtField _ if' then' else' ->
281− txt "if "
340+ p_if cmdPlacement p_hsCmd if' then' else'
282− located if' p_hsExpr
285− located then' $ \x -> do
290− located else' $ \x -> do
293− HsCmdLet NoExt localBinds c -> do
341+ HsCmdLet NoExtField localBinds c ->
294− txt "let "
342+ p_let p_hsCmd localBinds c
295− sitcc (located localBinds p_hsLocalBinds)
298− sitcc (located c p_hsCmd)
299− HsCmdDo NoExt es -> do
343+ HsCmdDo NoExtField es -> do
302− inci (located es (sitcc . sep newline (located' (sitcc . p_stmt' p_hsCmd))))
347+ sitcc . sep newline (sitcc . withSpacing (p_stmt' cmdPlacement p_hsCmd))
303 HsCmdWrap {} -> notImplemented "HsCmdWrap"
348 HsCmdWrap {} -> notImplemented "HsCmdWrap"
304− XCmd {} -> notImplemented "XCmd"
349+ XCmd x -> noExtCon x
306p_hsCmdTop :: HsCmdTop GhcPs -> R ()
351p_hsCmdTop :: HsCmdTop GhcPs -> R ()
307p_hsCmdTop = \case
352p_hsCmdTop = \case
308− HsCmdTop NoExt cmd -> located cmd p_hsCmd
353+ HsCmdTop NoExtField cmd -> located cmd p_hsCmd
309− XCmdTop {} -> notImplemented "XHsCmdTop"
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)
311p_stmt :: Stmt GhcPs (LHsExpr GhcPs) -> R ()
385p_stmt :: Stmt GhcPs (LHsExpr GhcPs) -> R ()
312−p_stmt = p_stmt' p_hsExpr
386+p_stmt = p_stmt' exprPlacement p_hsExpr
314−p_stmt'
388+p_stmt' ::
315− :: Data body
389+ Data body =>
316− => (body -> R ())
391+ (body -> Placement) ->
394+ -- | Statement to render
317− -> Stmt GhcPs (Located body)
395+ Stmt GhcPs (Located body) ->
319−p_stmt' pretty = \case
397+p_stmt' placer render = \case
320− LastStmt NoExt body _ _ -> located body pretty
398+ LastStmt NoExtField body _ _ -> located body render
321− BindStmt NoExt l f _ _ -> do
399+ BindStmt NoExtField p f _ _ -> do
322− located l p_pat
400+ located p p_pat
325− breakpoint
403+ let loc = getLoc p
326− inci (located f pretty)
404+ placement =
408+ (mkSrcSpan (srcSpanEnd loc) (srcSpanStart l'))
411+ switchLayout [loc, getLoc f] $
412+ placeHanging placement (located f render)
327 ApplicativeStmt {} -> notImplemented "ApplicativeStmt" -- generated by renamer
413 ApplicativeStmt {} -> notImplemented "ApplicativeStmt" -- generated by renamer
328− BodyStmt NoExt body _ _ -> located body pretty
414+ BodyStmt NoExtField body _ _ -> located body render
329− LetStmt NoExt binds -> do
415+ LetStmt NoExtField binds -> do
330− txt "let "
416+ txt "let"
331 sitcc $ located binds p_hsLocalBinds
418 sitcc $ located binds p_hsLocalBinds
332 ParStmt {} ->
419 ParStmt {} ->
333− -- NOTE 'ParStmt' should always be eliminated in 'gatherStmt' already,
420+ -- 'ParStmt' should always be eliminated in 'gatherStmt' already, such
334− -- such that it never occurs in 'p_stmt''. Consequently, handling it
421+ -- that it never occurs in 'p_stmt''. Consequently, handling it here
335− -- here would be redundant.
422+ -- would be redundant.
336 notImplemented "ParStmt"
423 notImplemented "ParStmt"
337− TransStmt {..} -> do
424+ TransStmt {..} ->
338− -- NOTE 'TransStmt' only needs to account for pretty printing itself,
425+ -- 'TransStmt' only needs to account for render printing itself, since
339− -- since pretty printing of relevant statements (e.g., in 'trS_stmts')
426+ -- pretty printing of relevant statements (e.g., in 'trS_stmts') is
340− -- is handled through 'gatherStmt'.
427+ -- handled through 'gatherStmt'.
341 case (trS_form, trS_by) of
428 case (trS_form, trS_by) of
342− (ThenForm, Nothing) -> located trS_using $ \x -> do
429+ (ThenForm, Nothing) -> do
343 txt "then"
430 txt "then"
344 breakpoint
431 breakpoint
345− inci (p_hsExpr x)
432+ inci $ located trS_using p_hsExpr
346 (ThenForm, Just e) -> do
433 (ThenForm, Just e) -> do
347− located trS_using $ \x -> do
348− txt "then"
434+ txt "then"
351 breakpoint
435 breakpoint
352− located e $ \x -> do
436+ inci $ located trS_using p_hsExpr
353− txt "by"
438+ txt "by"
354− breakpoint
439+ breakpoint
355− inci (p_hsExpr x)
440+ inci $ located e p_hsExpr
356− (GroupForm, Nothing) -> located trS_using $ \x -> do
441+ (GroupForm, Nothing) -> do
357 txt "then group using"
442 txt "then group using"
358 breakpoint
443 breakpoint
359− inci (p_hsExpr x)
444+ inci $ located trS_using p_hsExpr
360 (GroupForm, Just e) -> do
445 (GroupForm, Just e) -> do
361− located e $ \x -> do
362− txt "then group by"
446+ txt "then group by"
365 breakpoint
447 breakpoint
366− located trS_using $ \x -> do
448+ inci $ located e p_hsExpr
367− txt "using"
450+ txt "using"
368− breakpoint
451+ breakpoint
369− inci (p_hsExpr x)
452+ inci $ located trS_using p_hsExpr
370 RecStmt {..} -> do
453 RecStmt {..} -> do
371− txt "rec "
454+ txt "rec"
372− sitcc $ sep newline (located' (p_stmt' pretty)) recS_stmts
456+ sitcc $ sepSemi (withSpacing (p_stmt' placer render)) recS_stmts
373− XStmtLR {} -> notImplemented "XStmtLR"
457+ XStmtLR c -> noExtCon c
375gatherStmt :: ExprLStmt GhcPs -> [[ExprLStmt GhcPs]]
459gatherStmt :: ExprLStmt GhcPs -> [[ExprLStmt GhcPs]]
376−gatherStmt (L _ (ParStmt NoExt block _ _)) =
460+gatherStmt (L _ (ParStmt NoExtField block _ _)) =
377 foldr ((<>) . gatherStmtBlock) [] block
461 foldr ((<>) . gatherStmtBlock) [] block
378gatherStmt (L s stmt@TransStmt {..}) =
462gatherStmt (L s stmt@TransStmt {..}) =
379 foldr liftAppend [] ((gatherStmt <$> trS_stmts) <> pure [[L s stmt]])
463 foldr liftAppend [] ((gatherStmt <$> trS_stmts) <> pure [[L s stmt]])
@@ -382,323 +466,498 @@ gatherStmt stmt = [[stmt]]
382gatherStmtBlock :: ParStmtBlock GhcPs GhcPs -> [[ExprLStmt GhcPs]]
466gatherStmtBlock :: ParStmtBlock GhcPs GhcPs -> [[ExprLStmt GhcPs]]
383gatherStmtBlock (ParStmtBlock _ stmts _ _) =
467gatherStmtBlock (ParStmtBlock _ stmts _ _) =
384 foldr (liftAppend . gatherStmt) [] stmts
468 foldr (liftAppend . gatherStmt) [] stmts
385−gatherStmtBlock XParStmtBlock {} = notImplemented "XParStmtBlock"
469+gatherStmtBlock (XParStmtBlock x) = noExtCon x
387p_hsLocalBinds :: HsLocalBindsLR GhcPs GhcPs -> R ()
471p_hsLocalBinds :: HsLocalBindsLR GhcPs GhcPs -> R ()
388p_hsLocalBinds = \case
472p_hsLocalBinds = \case
389− HsValBinds NoExt (ValBinds NoExt bag lsigs) -> do
473+ HsValBinds NoExtField (ValBinds NoExtField bag lsigs) -> do
390− let ssStart = either
474+ -- When in a single-line layout, there is a chance that the inner
391− (srcSpanStart . getLoc)
475+ -- elements will also contain semicolons and they will confuse the
392− (srcSpanStart . getLoc)
476+ -- parser. so we request braces around every element except the last.
393− items =
477+ br <- layoutToBraces <$> getLayout
479+ let injectLeft (L l x) = L l (Left x)
480+ injectRight (L l x) = L l (Right x)
394− (Left <$> bagToList bag) ++ (Right <$> lsigs)
481+ in (injectLeft <$> bagToList bag) ++ (injectRight <$> lsigs)
395− p_item (Left x) = located x p_valDecl'
482+ positionToBracing = \case
396− p_item (Right x) = located x p_sigDecl'
483+ SinglePos -> id
397− sitcc $ sep newline (sitcc . 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)
398− HsValBinds NoExt _ -> notImplemented "HsValBinds"
492+ HsValBinds NoExtField _ -> notImplemented "HsValBinds"
399− 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"
400− EmptyLocalBinds NoExt -> return ()
507+ EmptyLocalBinds NoExtField -> return ()
401− XHsLocalBindsLR _ -> notImplemented "XHsLocalBindsLR"
508+ XHsLocalBindsLR x -> noExtCon x
404− :: (Data id, Outputable id)
405− => HsRecField' id (LHsExpr GhcPs)
407−p_hsRecField = \HsRecField {..} -> do
408− located hsRecFieldLbl atom
409− unless hsRecPun $ do
411− located hsRecFieldArg p_hsExpr
413−p_hsTupArg :: HsTupArg GhcPs -> R ()
510+p_hsRecField ::
414−p_hsTupArg = \case
511+ HsRecField' RdrName (LHsExpr GhcPs) ->
415− Present NoExt x -> located x p_hsExpr
512+ R ()
416− Missing NoExt -> pure ()
513+p_hsRecField HsRecField {..} = do
417− XTupArg {} -> notImplemented "XTupArg"
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)
419p_hsExpr :: HsExpr GhcPs -> R ()
524p_hsExpr :: HsExpr GhcPs -> R ()
420−p_hsExpr = \case
525+p_hsExpr = p_hsExpr' N
527+p_hsExpr' :: BracketStyle -> HsExpr GhcPs -> R ()
421− HsVar NoExt name -> p_rdrName name
529+ HsVar NoExtField name -> p_rdrName name
422− HsUnboundVar NoExt _ -> notImplemented "HsUnboundVar"
530+ HsUnboundVar NoExtField v -> atom (unboundVarOcc v)
423− HsConLikeOut NoExt _ -> notImplemented "HsConLikeOut"
531+ HsConLikeOut NoExtField _ -> notImplemented "HsConLikeOut"
424− HsRecFld NoExt x ->
532+ HsRecFld NoExtField x ->
425 case x of
533 case x of
426− Unambiguous NoExt name -> p_rdrName name
534+ Unambiguous NoExtField name -> p_rdrName name
427− Ambiguous NoExt name -> p_rdrName name
535+ Ambiguous NoExtField name -> p_rdrName name
428− XAmbiguousFieldOcc NoExt -> notImplemented "XAmbiguousFieldOcc"
536+ XAmbiguousFieldOcc xx -> noExtCon xx
429− HsOverLabel NoExt _ v -> do
537+ HsOverLabel NoExtField _ v -> do
432− HsIPVar NoExt (HsIPName name) -> do
540+ HsIPVar NoExtField (HsIPName name) -> do
434 atom name
542 atom name
435− HsOverLit NoExt v -> atom (ol_val v)
543+ HsOverLit NoExtField v -> atom (ol_val v)
436− HsLit NoExt lit -> atom lit
544+ HsLit NoExtField lit ->
546+ HsString (SourceText stxt) _ -> p_stringLit stxt
547+ HsStringPrim (SourceText stxt) _ -> p_stringLit stxt
437− HsLam NoExt mgroup ->
549+ HsLam NoExtField mgroup ->
438 p_matchGroup Lambda mgroup
550 p_matchGroup Lambda mgroup
439− HsLamCase NoExt mgroup -> do
551+ HsLamCase NoExtField mgroup -> do
440 txt "\\case"
552 txt "\\case"
442− inci (p_matchGroup LambdaCase mgroup)
443− HsApp NoExt f x -> sitcc $ do
445 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
446− 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
447− HsAppType a e -> do
611+ HsAppType NoExtField e a -> do
448 located e p_hsExpr
612 located e p_hsExpr
449 breakpoint
613 breakpoint
450 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
452 located (hswc_body a) p_hsType
621 located (hswc_body a) p_hsType
453− OpApp NoExt x op y -> do
622+ OpApp NoExtField x op y -> do
454− located x p_hsExpr
623+ let opTree = OpBranch (exprOpTree x) op (exprOpTree y)
624+ p_exprOpTree s (reassociateOpTree getOpName opTree)
625+ NegApp NoExtField e _ -> do
456− let opWrapper = case unLoc op of
457− EWildPat NoExt -> backticks
459− located op (opWrapper . p_hsExpr)
460− placeHanging (exprPlacement (unLoc y)) $
462− NegApp NoExt e _ -> do
464 located e p_hsExpr
628 located e p_hsExpr
629+ HsPar NoExtField e ->
465− HsPar NoExt e -> parens (located e p_hsExpr)
630+ parens s (located e (dontUseBraces . p_hsExpr))
466− SectionL NoExt x op -> do
631+ SectionL NoExtField x op -> do
467 located x p_hsExpr
632 located x p_hsExpr
468 breakpoint
633 breakpoint
469 inci (located op p_hsExpr)
634 inci (located op p_hsExpr)
470− SectionR NoExt op x -> do
635+ SectionR NoExtField op x -> do
471 located op p_hsExpr
636 located op p_hsExpr
637+ useRecordDot' <- useRecordDot
638+ let isRecordDot' = isRecordDot (unLoc op) (getLoc x)
472− breakpoint
639+ unless (useRecordDot' && isRecordDot') breakpoint
473 inci (located x p_hsExpr)
640 inci (located x p_hsExpr)
474− ExplicitTuple NoExt args boxity -> do
641+ ExplicitTuple NoExtField args boxity ->
475 let isSection = any (isMissing . unLoc) args
642 let isSection = any (isMissing . unLoc) args
476 isMissing = \case
643 isMissing = \case
477− Missing NoExt -> True
644+ Missing NoExtField -> True
478 _ -> 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
479− let parens' =
651+ parens' =
480 case boxity of
652 case boxity of
481 Boxed -> parens
653 Boxed -> parens
482 Unboxed -> parensHash
654 Unboxed -> parensHash
483− if isSection
655+ in if isSection
484− then switchLayout [] . parens' $
657+ switchLayout [] . parens' s $
485− sep comma (located' p_hsTupArg) args
658+ sep comma p_larg args
486− else switchLayout (getLoc <$> args) . parens' . sitcc $
660+ switchLayout (getLoc <$> args) . parens' s $
487− sep (comma >> breakpoint) (sitcc . located' p_hsTupArg) args
661+ sep commaDel p_larg args
488− ExplicitSum NoExt tag arity e ->
662+ ExplicitSum NoExtField tag arity e ->
489− p_unboxedSum tag arity (located e p_hsExpr)
663+ p_unboxedSum N tag arity (located e p_hsExpr)
490− HsCase NoExt e mgroup -> do
664+ HsCase NoExtField e mgroup ->
491− txt "case "
665+ p_case exprPlacement p_hsExpr e mgroup
495− inci (p_matchGroup Case mgroup)
496− HsIf NoExt _ if' then' else' -> do
666+ HsIf NoExtField _ if' then' else' ->
667+ p_if exprPlacement p_hsExpr if' then' else'
668+ HsMultiIf NoExtField guards -> do
497− txt "if "
669+ txt "if"
498− located if' p_hsExpr
499 breakpoint
670 breakpoint
501− located then' $ \x -> do
506− located else' $ \x -> do
509− HsMultiIf NoExt guards -> do
511− sitcc $ sep newline (located' (p_grhs RightArrow)) guards
671+ inci . inci $ sep newline (located' (p_grhs RightArrow)) guards
512− HsLet NoExt localBinds e -> do
672+ HsLet NoExtField localBinds e ->
513− txt "let "
673+ p_let p_hsExpr localBinds e
514− sitcc (located localBinds p_hsLocalBinds)
515− vlayout space (newline >> space)
517− sitcc (located e p_hsExpr)
518− HsDo NoExt ctx es -> do
674+ HsDo NoExtField ctx es -> do
519 let doBody header = do
675 let doBody header = do
520 txt header
676 txt header
521− newline
677+ breakpoint
522− inci $ located es (sep newline (located' (sitcc . p_stmt)))
678+ ub <- layoutToBraces <$> getLayout
681+ (ub . withSpacing (p_stmt' exprPlacement (p_hsExpr' S)))
523− compBody = brackets $ located es $ \xs -> do
683+ compBody = brackets N . located es $ \xs -> do
524− let p_parBody = sitcc . sep
684+ let p_parBody =
525− (breakpoint >> txt "| ")
686+ (breakpoint >> txt "|" >> space)
526− p_seqBody
687+ p_seqBody
527− p_seqBody = sitcc . sep
688+ p_seqBody =
528− (comma >> breakpoint)
689+ sitcc
529− (located' (sitcc . p_stmt))
692+ (located' (sitcc . p_stmt))
530 stmts = init xs
693 stmts = init xs
531 yield = last xs
694 yield = last xs
532 lists = foldr (liftAppend . gatherStmt) [] stmts
695 lists = foldr (liftAppend . gatherStmt) [] stmts
533 located yield p_stmt
696 located yield p_stmt
534 breakpoint
697 breakpoint
535− txt "| "
698+ txt "|"
536 p_parBody lists
700 p_parBody lists
537 case ctx of
701 case ctx of
538 DoExpr -> doBody "do"
702 DoExpr -> doBody "do"
539 MDoExpr -> doBody "mdo"
703 MDoExpr -> doBody "mdo"
540 ListComp -> compBody
704 ListComp -> compBody
541 MonadComp -> notImplemented "MonadComp"
705 MonadComp -> notImplemented "MonadComp"
542− ArrowExpr -> notImplemented "ArrowExpr"
706+ ArrowExpr -> notImplemented "ArrowExpr"
543 GhciStmtCtxt -> notImplemented "GhciStmtCtxt"
707 GhciStmtCtxt -> notImplemented "GhciStmtCtxt"
544 PatGuard _ -> notImplemented "PatGuard"
708 PatGuard _ -> notImplemented "PatGuard"
545 ParStmtCtxt _ -> notImplemented "ParStmtCtxt"
709 ParStmtCtxt _ -> notImplemented "ParStmtCtxt"
546 TransStmtCtxt _ -> notImplemented "TransStmtCtxt"
710 TransStmtCtxt _ -> notImplemented "TransStmtCtxt"
547 ExplicitList _ _ xs ->
711 ExplicitList _ _ xs ->
548− brackets . sitcc $ sep (comma >> breakpoint) (sitcc . located' p_hsExpr) xs
713+ sep commaDel (sitcc . located' p_hsExpr) xs
549 RecordCon {..} -> do
714 RecordCon {..} -> do
550 located rcon_con_name atom
715 located rcon_con_name atom
551 breakpoint
716 breakpoint
552 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
553− fields = located' p_hsRecField <$> rec_flds
724+ fields = located' (p_hsRecField . updName) <$> rec_flds
555 case rec_dotdot of
726 case rec_dotdot of
556 Just {} -> [txt ".."]
727 Just {} -> [txt ".."]
557 Nothing -> []
728 Nothing -> []
558− inci . braces . sitcc $ sep (comma >> breakpoint) sitcc (fields <> dotdot)
730+ sep commaDel sitcc (fields <> dotdot)
559 RecordUpd {..} -> do
731 RecordUpd {..} -> do
560 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))
561− 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
562− inci . braces . sitcc $
748+ inci . braces N $
563− sep (comma >> breakpoint) (sitcc . located' p_hsRecField) rupd_flds
751+ (sitcc . located' (p_hsRecField . updName))
564− ExprWithTySig affix x -> sitcc $ do
753+ ExprWithTySig NoExtField x HsWC {hswc_body = HsIB {..}} -> sitcc $ do
565 located x p_hsExpr
754 located x p_hsExpr
566 breakpoint
757 breakpoint
569− let HsWC {..} = affix
570− HsIB {..} = hswc_body
571− 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
572− ArithSeq NoExt _ x -> do
761+ ArithSeq NoExtField _ x ->
573 case x of
762 case x of
574− From from -> brackets . sitcc $ do
763+ From from -> brackets s $ do
575 located from p_hsExpr
764 located from p_hsExpr
576 breakpoint
765 breakpoint
578− FromThen from next -> brackets . sitcc $ do
767+ FromThen from next -> brackets s $ do
579− sitcc $ sep (comma >> breakpoint) (located' p_hsExpr) [from, next]
768+ sep commaDel (located' p_hsExpr) [from, next]
580 breakpoint
769 breakpoint
582− FromTo from to -> brackets . sitcc $ do
771+ FromTo from to -> brackets s $ do
583 located from p_hsExpr
772 located from p_hsExpr
584 breakpoint
773 breakpoint
585− txt ".. "
774+ txt ".."
586 located to p_hsExpr
776 located to p_hsExpr
587− FromThenTo from next to -> brackets . sitcc $ do
777+ FromThenTo from next to -> brackets s $ do
588− sitcc $ sep (comma >> breakpoint) (located' p_hsExpr) [from, next]
778+ sep commaDel (located' p_hsExpr) [from, next]
589 breakpoint
779 breakpoint
590− txt ".. "
780+ txt ".."
591 located to p_hsExpr
782 located to p_hsExpr
592− HsSCC NoExt _ name x -> do
783+ HsSCC NoExtField _ name x -> do
593 txt "{-# SCC "
784 txt "{-# SCC "
594 atom name
785 atom name
595 txt " #-}"
786 txt " #-}"
596 breakpoint
787 breakpoint
597 located x p_hsExpr
788 located x p_hsExpr
598− HsCoreAnn NoExt _ value x -> do
789+ HsCoreAnn NoExtField _ value x -> do
599 txt "{-# CORE "
790 txt "{-# CORE "
600 atom value
791 atom value
601 txt " #-}"
792 txt " #-}"
602 breakpoint
793 breakpoint
603 located x p_hsExpr
794 located x p_hsExpr
604− HsBracket NoExt x -> p_hsBracket x
795+ HsBracket NoExtField x -> p_hsBracket x
605 HsRnBracketOut {} -> notImplemented "HsRnBracketOut"
796 HsRnBracketOut {} -> notImplemented "HsRnBracketOut"
606 HsTcBracketOut {} -> notImplemented "HsTcBracketOut"
797 HsTcBracketOut {} -> notImplemented "HsTcBracketOut"
607− HsSpliceE NoExt splice -> p_hsSplice splice
798+ HsSpliceE NoExtField splice -> p_hsSplice splice
608− HsProc NoExt p e -> do
799+ HsProc NoExtField p e -> do
609 txt "proc"
800 txt "proc"
610 located p $ \x -> do
801 located p $ \x -> do
611 breakpoint
802 breakpoint
612 inci (p_pat x)
803 inci (p_pat x)
613 breakpoint
804 breakpoint
615− placeHanging (cmdTopPlacement (unLoc e)) (located e p_hsCmdTop)
806+ placeHanging (cmdTopPlacement (unLoc e)) $
807+ located e p_hsCmdTop
616− HsStatic _ e -> do
808+ HsStatic _ e -> do
617 txt "static"
809 txt "static"
618 breakpoint
810 breakpoint
619 inci (located e p_hsExpr)
811 inci (located e p_hsExpr)
620− HsArrApp NoExt body input arrType cond ->
621− p_hsCmd (HsCmdArrApp NoExt body input arrType cond)
622− HsArrForm NoExt form mfixity cmds ->
623− p_hsCmd (HsCmdArrForm NoExt form Prefix mfixity cmds)
624 HsTick {} -> notImplemented "HsTick"
812 HsTick {} -> notImplemented "HsTick"
625 HsBinTick {} -> notImplemented "HsBinTick"
813 HsBinTick {} -> notImplemented "HsBinTick"
626 HsTickPragma {} -> notImplemented "HsTickPragma"
814 HsTickPragma {} -> notImplemented "HsTickPragma"
627− EWildPat NoExt -> txt "_"
628− EAsPat {} -> notImplemented "EAsPat"
629− EViewPat {} -> notImplemented "EViewPat"
630− ELazyPat {} -> notImplemented "ELazyPat"
631 HsWrap {} -> notImplemented "HsWrap"
815 HsWrap {} -> notImplemented "HsWrap"
632− XExpr {} -> notImplemented "XExpr"
816+ XExpr x -> noExtCon x
634p_patSynBind :: PatSynBind GhcPs GhcPs -> R ()
818p_patSynBind :: PatSynBind GhcPs GhcPs -> R ()
635p_patSynBind PSB {..} = do
819p_patSynBind PSB {..} = do
636− txt "pattern "
820+ let rhs = do
637− case psb_dir of
822+ case psb_dir of
638− Unidirectional -> do
823+ Unidirectional -> do
639− p_rdrName psb_id
824+ txt "<-"
640− inci $ do
825+ breakpoint
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)
641− p_patSynDetails psb_args
840+ case psb_args of
642− txt " <-"
841+ PrefixCon xs -> do
643− breakpoint
842+ space
644− located psb_def p_pat
645− ImplicitBidirectional -> do
646 p_rdrName psb_id
843 p_rdrName psb_id
647 inci $ do
844 inci $ do
648− p_patSynDetails psb_args
845+ switchLayout (getLoc <$> xs) $ do
650− breakpoint
846+ unless (null xs) breakpoint
651− located psb_def p_pat
847+ sitcc (sep breakpoint p_rdrName xs)
652− ExplicitBidirectional mgroup -> do
848+ rhs
653 p_rdrName psb_id
851 p_rdrName psb_id
654 inci $ do
852 inci $ do
655− p_patSynDetails psb_args
853+ switchLayout (getLoc . recordPatSynPatVar <$> xs) $ do
656− txt " <-"
854+ unless (null xs) breakpoint
856+ sep commaDel (p_rdrName . recordPatSynPatVar) xs
859+ switchLayout [getLoc l, getLoc r] $ do
657 breakpoint
862 breakpoint
658− located psb_def p_pat
863+ inci $ do
659− newline
864+ p_rdrName psb_id
660− line (txt "where")
865+ space
661− inci (p_matchGroup (Function psb_id) mgroup)
866+ p_rdrName r
662−p_patSynBind (XPatSynBind NoExt) = notImplemented "XPatSynBind"
868+p_patSynBind (XPatSynBind x) = noExtCon x
664−p_patSynDetails :: HsPatSynDetails (Located RdrName) -> R ()
870+p_case ::
665−p_patSynDetails = \case
871+ Data body =>
666− PrefixCon xs ->
872+ -- | Placer
667− switchLayout (getLoc <$> xs) $ do
873+ (body -> Placement) ->
668− unless (null xs) breakpoint
874+ -- | Render
669− sitcc (sep breakpoint p_rdrName xs)
875+ (body -> R ()) ->
670− RecCon xs ->
876+ -- | Expression
671− switchLayout (getLoc . recordPatSynPatVar <$> xs) $ do
877+ LHsExpr GhcPs ->
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)
672− unless (null xs) breakpoint
913+ breakpoint
673− braces . sitcc $ sep (comma >> breakpoint) (p_rdrName . recordPatSynPatVar) xs
914+ txt "else"
674− InfixCon _ _ -> notImplemented "InfixCon"
915+ space
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)
676p_pat :: Pat GhcPs -> R ()
935p_pat :: Pat GhcPs -> R ()
677p_pat = \case
936p_pat = \case
678− WildPat NoExt -> txt "_"
937+ WildPat NoExtField -> txt "_"
679− VarPat NoExt name -> p_rdrName name
938+ VarPat NoExtField name -> p_rdrName name
680− LazyPat NoExt pat -> do
939+ LazyPat NoExtField pat -> do
682 located pat p_pat
941 located pat p_pat
683− AsPat NoExt name pat -> do
942+ AsPat NoExtField name pat -> do
684 p_rdrName name
943 p_rdrName name
686 located pat p_pat
945 located pat p_pat
687− ParPat NoExt pat ->
946+ ParPat NoExtField pat ->
688− located pat (parens . p_pat)
947+ located pat (parens S . p_pat)
689− BangPat NoExt pat -> do
948+ BangPat NoExtField pat -> do
691 located pat p_pat
950 located pat p_pat
692− ListPat NoExt pats -> do
951+ ListPat NoExtField pats ->
693− brackets . sitcc $ sep (comma >> breakpoint) (located' p_pat) pats
952+ brackets S $ sep commaDel (located' p_pat) pats
694− TuplePat NoExt pats boxing -> do
953+ TuplePat NoExtField pats boxing -> do
695− let f =
954+ let parens' =
696 case boxing of
955 case boxing of
697− Boxed -> parens
956+ Boxed -> parens S
698− Unboxed -> parensHash
957+ Unboxed -> parensHash S
699− f . sitcc $ sep (comma >> breakpoint) (sitcc . located' p_pat) pats
958+ parens' $ sep commaDel (sitcc . located' p_pat) pats
700− SumPat NoExt pat tag arity ->
959+ SumPat NoExtField pat tag arity ->
701− p_unboxedSum tag arity (located pat p_pat)
960+ p_unboxedSum S tag arity (located pat p_pat)
702 ConPatIn pat details ->
961 ConPatIn pat details ->
703 case details of
962 case details of
704 PrefixCon xs -> sitcc $ do
963 PrefixCon xs -> sitcc $ do
@@ -712,102 +971,115 @@ p_pat = \case
712 let f = \case
971 let f = \case
713 Nothing -> txt ".."
972 Nothing -> txt ".."
714 Just x -> located x p_pat_hsRecField
973 Just x -> located x p_pat_hsRecField
974+ inci . braces N . sep commaDel f $
715− inci . braces . sitcc . sep (comma >> breakpoint) f $ case dotdot of
975+ case dotdot of
716− Nothing -> Just <$> fields
976+ Nothing -> Just <$> fields
717− Just n -> (Just <$> take n fields) ++ [Nothing]
977+ Just (L _ n) -> (Just <$> take n fields) ++ [Nothing]
718− InfixCon x y -> do
978+ InfixCon l r -> do
979+ switchLayout [getLoc l, getLoc r] $ do
719− located x p_pat
980+ located l p_pat
720− space
981+ breakpoint
721− p_rdrName pat
983+ p_rdrName pat
722− breakpoint
984+ space
723− inci (located y p_pat)
985+ located r p_pat
724 ConPatOut {} -> notImplemented "ConPatOut" -- presumably created by renamer?
986 ConPatOut {} -> notImplemented "ConPatOut" -- presumably created by renamer?
725− ViewPat NoExt expr pat -> sitcc $ do
987+ ViewPat NoExtField expr pat -> sitcc $ do
726 located expr p_hsExpr
988 located expr p_hsExpr
727− txt " ->"
990+ txt "->"
728 breakpoint
991 breakpoint
729 inci (located pat p_pat)
992 inci (located pat p_pat)
730− SplicePat NoExt splice -> p_hsSplice splice
993+ SplicePat NoExtField splice -> p_hsSplice splice
731− LitPat NoExt p -> atom p
994+ LitPat NoExtField p -> atom p
732− NPat NoExt v _ _ -> located v (atom . ol_val)
995+ NPat NoExtField v _ _ -> located v (atom . ol_val)
733− NPlusKPat NoExt n k _ _ _ -> sitcc $ do
996+ NPlusKPat NoExtField n k _ _ _ -> sitcc $ do
734 p_rdrName n
997 p_rdrName n
735 breakpoint
998 breakpoint
736 inci $ do
999 inci $ do
737− txt "+ "
1000+ txt "+"
738 located k (atom . ol_val)
1002 located k (atom . ol_val)
739− SigPat hswc pat -> do
1003+ SigPat NoExtField pat hswc -> do
740 located pat p_pat
1004 located pat p_pat
741 p_typeAscription hswc
1005 p_typeAscription hswc
742 CoPat {} -> notImplemented "CoPat" -- apparently created at some later stage
1006 CoPat {} -> notImplemented "CoPat" -- apparently created at some later stage
743− XPat NoExt -> notImplemented "XPat"
1007+ XPat x -> noExtCon x
745p_pat_hsRecField :: HsRecField' (FieldOcc GhcPs) (LPat GhcPs) -> R ()
1009p_pat_hsRecField :: HsRecField' (FieldOcc GhcPs) (LPat GhcPs) -> R ()
746p_pat_hsRecField HsRecField {..} = do
1010p_pat_hsRecField HsRecField {..} = do
747 located hsRecFieldLbl $ \x ->
1011 located hsRecFieldLbl $ \x ->
748 p_rdrName (rdrNameFieldOcc x)
1012 p_rdrName (rdrNameFieldOcc x)
749 unless hsRecPun $ do
1013 unless hsRecPun $ do
751 breakpoint
1016 breakpoint
752 inci (located hsRecFieldArg p_pat)
1017 inci (located hsRecFieldArg p_pat)
754−p_unboxedSum :: ConTag -> Arity -> R () -> R ()
1019+p_unboxedSum :: BracketStyle -> ConTag -> Arity -> R () -> R ()
755−p_unboxedSum tag arity m = do
1020+p_unboxedSum s tag arity m = do
756 let before = tag - 1
1021 let before = tag - 1
757 after = arity - before - 1
1022 after = arity - before - 1
758 args = replicate before Nothing <> [Just m] <> replicate after Nothing
1023 args = replicate before Nothing <> [Just m] <> replicate after Nothing
759− f (x,i) = do
1024+ f x =
760− let isFirst = i == 0
761− isLast = i == arity - 1
762 case x :: Maybe (R ()) of
1025 case x :: Maybe (R ()) of
763 Nothing ->
1026 Nothing ->
764− unless (isFirst || isLast) space
1027+ space
765 Just m' -> do
1028 Just m' -> do
766− unless isFirst space
1029+ space
768− unless isLast space
1031+ space
769− parensHash $ sep (txt "|") f (zip args [0..])
1032+ parensHash s $ sep (txt "|") f args
771p_hsSplice :: HsSplice GhcPs -> R ()
1034p_hsSplice :: HsSplice GhcPs -> R ()
772p_hsSplice = \case
1035p_hsSplice = \case
773− HsTypedSplice NoExt deco _ expr -> p_hsSpliceTH True expr deco
1036+ HsTypedSplice NoExtField deco _ expr -> p_hsSpliceTH True expr deco
774− HsUntypedSplice NoExt deco _ expr -> p_hsSpliceTH False expr deco
1037+ HsUntypedSplice NoExtField deco _ expr -> p_hsSpliceTH False expr deco
775− HsQuasiQuote NoExt _ quoterName srcSpan str -> do
1038+ HsQuasiQuote NoExtField _ quoterName srcSpan str -> do
777 p_rdrName (L srcSpan quoterName)
1040 p_rdrName (L srcSpan quoterName)
779− -- NOTE QuasiQuoters often rely on precise custom strings. We cannot do
1042+ -- QuasiQuoters often rely on precise custom strings. We cannot do any
780− -- any formatting here without potentially breaking someone's code.
1043+ -- formatting here without potentially breaking someone's code.
781 atom str
1044 atom str
782 txt "|]"
1045 txt "|]"
783 HsSpliced {} -> notImplemented "HsSpliced"
1046 HsSpliced {} -> notImplemented "HsSpliced"
784− XSplice {} -> notImplemented "XSplice"
1047+ HsSplicedT {} -> notImplemented "HsSplicedT"
1048+ XSplice x -> noExtCon x
786−p_hsSpliceTH
1050+p_hsSpliceTH ::
787− :: Bool -- ^ Typed splice?
1051+ -- | Typed splice?
1053+ -- | Splice expression
788− -> LHsExpr GhcPs -- ^ Splice expression
1054+ LHsExpr GhcPs ->
1055+ -- | Splice decoration
789− -> SpliceDecoration -- ^ Splice decoration
1056+ SpliceDecoration ->
791p_hsSpliceTH isTyped expr = \case
1058p_hsSpliceTH isTyped expr = \case
792 HasParens -> do
1059 HasParens -> do
793 txt decoSymbol
1060 txt decoSymbol
794− parens (located expr (sitcc . p_hsExpr))
1061+ parens N (located expr (sitcc . p_hsExpr))
795 HasDollar -> do
1062 HasDollar -> do
796 txt decoSymbol
1063 txt decoSymbol
797 located expr (sitcc . p_hsExpr)
1064 located expr (sitcc . p_hsExpr)
798− NoParens -> do
1065+ NoParens ->
799 located expr (sitcc . p_hsExpr)
1066 located expr (sitcc . p_hsExpr)
801 decoSymbol = if isTyped then "$$" else "$"
1068 decoSymbol = if isTyped then "$$" else "$"
803p_hsBracket :: HsBracket GhcPs -> R ()
1070p_hsBracket :: HsBracket GhcPs -> R ()
804p_hsBracket = \case
1071p_hsBracket = \case
1072+ ExpBr NoExtField expr -> do
1073+ anns <- getEnclosingAnns
1074+ let name = case anns of
1075+ AnnOpenEQ : _ -> ""
805− ExpBr NoExt expr -> quote "e" (located expr p_hsExpr)
1077+ quote name (located expr p_hsExpr)
806− PatBr NoExt pat -> quote "p" (located pat p_pat)
1078+ PatBr NoExtField pat -> located pat (quote "p" . p_pat)
807− DecBrL NoExt decls -> quote "d" (p_hsDecls Free decls)
1079+ DecBrL NoExtField decls -> quote "d" (p_hsDecls Free decls)
808− DecBrG NoExt _ -> notImplemented "DecBrG" -- result of renamer
1080+ DecBrG NoExtField _ -> notImplemented "DecBrG" -- result of renamer
809− TypBr NoExt ty -> quote "t" (located ty p_hsType)
1081+ TypBr NoExtField ty -> quote "t" (located ty p_hsType)
810− VarBr NoExt isSingleQuote name -> do
1082+ VarBr NoExtField isSingleQuote name -> do
811 txt (bool "''" "'" isSingleQuote)
1083 txt (bool "''" "'" isSingleQuote)
812 -- HACK As you can see we use 'noLoc' here to be able to pass name into
1084 -- HACK As you can see we use 'noLoc' here to be able to pass name into
813 -- 'p_rdrName' since the latter expects a "located" thing. The problem
1085 -- 'p_rdrName' since the latter expects a "located" thing. The problem
@@ -815,17 +1087,20 @@ p_hsBracket = \case
815 -- turn makes it impossible to detect if there are parentheses around
1087 -- turn makes it impossible to detect if there are parentheses around
816 -- it, etc. So we have to add parentheses manually assuming they are
1088 -- it, etc. So we have to add parentheses manually assuming they are
817 -- necessary for all operators.
1089 -- necessary for all operators.
1092+ (\i -> isPunctuation i || isSymbol i)
818− let isOperator = any isPunctuation (showOutputable (rdrNameOcc name))
1093+ (showOutputable (rdrNameOcc name))
819− && not (doesNotNeedExtraParens name)
1094+ && not (doesNotNeedExtraParens name)
820− wrapper = if isOperator then parens else id
1095+ wrapper = if isOperator then parens N else id
821 wrapper $ p_rdrName (noLoc name)
1096 wrapper $ p_rdrName (noLoc name)
822− TExpBr NoExt expr -> do
1097+ TExpBr NoExtField expr -> do
823 txt "[||"
1098 txt "[||"
824 breakpoint'
1099 breakpoint'
825 located expr p_hsExpr
1100 located expr p_hsExpr
826 breakpoint'
1101 breakpoint'
827 txt "||]"
1102 txt "||]"
828− XBracket {} -> notImplemented "XBracket"
1103+ XBracket x -> noExtCon x
830 quote :: Text -> R () -> R ()
1105 quote :: Text -> R () -> R ()
831 quote name body = do
1106 quote name body = do
@@ -833,16 +1108,70 @@ p_hsBracket = \case
833 txt name
1108 txt name
835 breakpoint'
1110 breakpoint'
837− breakpoint'
1113+ breakpoint'
838− 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
840----------------------------------------------------------------------------
1163----------------------------------------------------------------------------
841-- 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
843-- | Append each element in both lists with semigroups. If one list is shorter
1173-- | Append each element in both lists with semigroups. If one list is shorter
844-- than the other, return the rest of the longer list unchanged.
1174-- than the other, return the rest of the longer list unchanged.
846liftAppend :: Semigroup a => [a] -> [a] -> [a]
1175liftAppend :: Semigroup a => [a] -> [a] -> [a]
847liftAppend [] [] = []
1176liftAppend [] [] = []
848liftAppend [] (y : ys) = y : ys
1177liftAppend [] (y : ys) = y : ys
@@ -850,15 +1179,15 @@ liftAppend (x : xs) [] = x : xs
850liftAppend (x : xs) (y : ys) = x <> y : liftAppend xs ys
1179liftAppend (x : xs) (y : ys) = x <> y : liftAppend xs ys
852getGRHSSpan :: GRHS GhcPs (Located body) -> SrcSpan
1181getGRHSSpan :: GRHS GhcPs (Located body) -> SrcSpan
853−getGRHSSpan (GRHS NoExt _ body) = getLoc body
1182+getGRHSSpan (GRHS NoExtField guards body) =
1183+ combineSrcSpans' $ getLoc body :| map getLoc guards
854−getGRHSSpan (XGRHS NoExt) = notImplemented "XGRHS"
1184+getGRHSSpan (XGRHS x) = noExtCon x
856-- | 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
857-- to separate it from preceding expressions and whether to bump indentation
1187-- to separate it from preceding expressions and whether to bump indentation
858-- depending on what sort of expression we have.
1188-- depending on what sort of expression we have.
860placeHanging :: Placement -> R () -> R ()
1189placeHanging :: Placement -> R () -> R ()
861−placeHanging placement m = do
1190+placeHanging placement m =
862 case placement of
1191 case placement of
863 Hanging -> do
1192 Hanging -> do
@@ -869,49 +1198,165 @@ placeHanging placement m = do
870-- | Check if given block contains single expression which has a hanging
1199-- | Check if given block contains single expression which has a hanging
873−blockPlacement
1201+blockPlacement ::
874− :: (body -> Placement)
1202+ (body -> Placement) ->
875− -> [LGRHS GhcPs (Located body)]
1203+ [LGRHS GhcPs (Located body)] ->
876− -> Placement
1204+ Placement
877−blockPlacement placer [(L _ (GRHS NoExt _ (L _ x)))] = placer x
1205+blockPlacement placer [L _ (GRHS NoExtField _ (L _ x))] = placer x
878blockPlacement _ _ = Normal
1206blockPlacement _ _ = Normal
880-- | Check if given command has a hanging form.
1208-- | Check if given command has a hanging form.
882cmdPlacement :: HsCmd GhcPs -> Placement
1209cmdPlacement :: HsCmd GhcPs -> Placement
883cmdPlacement = \case
1210cmdPlacement = \case
884− HsCmdLam NoExt _ -> Hanging
1211+ HsCmdLam NoExtField _ -> Hanging
885− HsCmdCase NoExt _ _ -> Hanging
1212+ HsCmdCase NoExtField _ _ -> Hanging
886− HsCmdDo NoExt _ -> Hanging
1213+ HsCmdDo NoExtField _ -> Hanging
887 _ -> Normal
1214 _ -> Normal
889cmdTopPlacement :: HsCmdTop GhcPs -> Placement
1216cmdTopPlacement :: HsCmdTop GhcPs -> Placement
890cmdTopPlacement = \case
1217cmdTopPlacement = \case
891− HsCmdTop NoExt (L _ x) -> cmdPlacement x
1218+ HsCmdTop NoExtField (L _ x) -> cmdPlacement x
892− XCmdTop {} -> notImplemented "XCmdTop"
1219+ XCmdTop x -> noExtCon x
894-- | Check if given expression has a hanging form.
1221-- | Check if given expression has a hanging form.
896exprPlacement :: HsExpr GhcPs -> Placement
1222exprPlacement :: HsExpr GhcPs -> Placement
897exprPlacement = \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)) ->
898− HsLam NoExt _ -> Hanging
1228+ Hanging
899− HsLamCase NoExt _ -> Hanging
1230+ HsLamCase NoExtField _ -> Hanging
900− HsCase NoExt _ _ -> Hanging
1231+ HsCase NoExtField _ _ -> Hanging
901− HsDo NoExt DoExpr _ -> Hanging
1232+ HsDo NoExtField DoExpr _ -> Hanging
902− HsDo NoExt MDoExpr _ -> Hanging
1233+ HsDo NoExtField MDoExpr _ -> Hanging
903− RecordCon NoExt _ _ -> 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)
904− HsProc NoExt (L s _) _ ->
1239+ HsProc NoExtField p _ ->
905− -- Indentation breaks if pattern is longer than one line and left hanging.
1240+ -- Indentation breaks if pattern is longer than one line and left
906− -- Consequently, only apply hanging when it is safe.
1241+ -- hanging. Consequently, only apply hanging when it is safe.
907− if isOneLineSpan s
1242+ if isOneLineSpan (getLoc p)
908− then Hanging
1243+ then Hanging
909− else Normal
1244+ else Normal
910 _ -> Normal
1245 _ -> Normal
912withGuards :: [LGRHS GhcPs (Located body)] -> Bool
1247withGuards :: [LGRHS GhcPs (Located body)] -> Bool
913withGuards = any (checkOne . unLoc)
1248withGuards = any (checkOne . unLoc)
915 checkOne :: GRHS GhcPs (Located body) -> Bool
1250 checkOne :: GRHS GhcPs (Located body) -> Bool
916− checkOne (GRHS NoExt [] _) = False
1251+ checkOne (GRHS NoExtField [] _) = False
917 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')