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