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