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