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