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