@@ -1,15 +1,13 @@
1−{-# LANGUAGE LambdaCase #-}
2−{-# LANGUAGE MultiWayIf #-}
1+{-# LANGUAGE LambdaCase #-}
32{-# LANGUAGE OverloadedStrings #-}
4−{-# LANGUAGE RecordWildCards #-}
5−{-# LANGUAGE TypeApplications #-}
3+{-# LANGUAGE RecordWildCards #-}
64
75module Ormolu.Printer.Meat.Declaration.Value
8− ( p_valDecl,
9− p_pat,
10− p_hsExpr,
11− p_hsSplice,
12− p_stringLit,
6+ ( p_valDecl
7+ , p_pat
8+ , p_hsExpr
9+ , p_hsSplice
10+ , p_stringLit
1311 )
1412where
1513
@@ -20,24 +18,24 @@ import Ctype (is_space)
2018import Data.Bool (bool)
2119import Data.Char (isPunctuation, isSymbol)
2220import Data.Data hiding (Infix, Prefix)
23−import Data.Functor ((<&>))
2421import Data.List (intersperse, sortOn)
25−import Data.List.NonEmpty (NonEmpty (..), (<|))
26−import qualified Data.List.NonEmpty as NE
22+import Data.List.NonEmpty (NonEmpty ((:|)))
2723import Data.Text (Text)
2824import qualified Data.Text as Text
2925import GHC
30−import OccName (occNameString)
3126import Ormolu.Printer.Combinators
32−import Ormolu.Printer.Internal
3327import Ormolu.Printer.Meat.Common
34−import {-# SOURCE #-} Ormolu.Printer.Meat.Declaration
3528import Ormolu.Printer.Meat.Declaration.Signature
3629import Ormolu.Printer.Meat.Type
3730import Ormolu.Printer.Operators
3831import 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
3936
4037-- | Style of a group of equations.
38+
4139data MatchGroupStyle
4240 = Function (Located RdrName)
4341 | PatternBind
@@ -46,61 +44,56 @@ data MatchGroupStyle
4644 | LambdaCase
4745
4846-- | Style of equations in a group.
47+
4948data GroupStyle
5049 = EqualSign
5150 | RightArrow
5251
5352-- | Expression placement. This marks the places where expressions that
5453-- implement handing forms may use them.
54+
5555data Placement
56− = -- | Multi-line layout should cause
57− -- insertion of a newline and indentation
58− -- bump
59− Normal
60− | -- | Expressions that have hanging form
61− -- should use it and avoid bumping one level
62− -- of indentation
63− Hanging
64− deriving (Eq, Show)
56+ = Normal -- ^ Multi-line layout should cause
57+ -- insertion of a newline and indentation
58+ -- bump
59+ | Hanging -- ^ Expressions that have hanging form
60+ -- should use it and avoid bumping one level
61+ -- of indentation
6562
6663p_valDecl :: HsBindLR GhcPs GhcPs -> R ()
6764p_valDecl = \case
68− FunBind NoExtField funId funMatches _ _ -> p_funBind funId funMatches
69− PatBind NoExtField pat grhss _ -> p_match PatternBind False NoSrcStrict [pat] grhss
65+ FunBind NoExt funId funMatches _ _ -> p_funBind funId funMatches
66+ PatBind NoExt pat grhss _ -> p_match PatternBind False NoSrcStrict [pat] grhss
7067 VarBind {} -> notImplemented "VarBinds" -- introduced by the type checker
7168 AbsBinds {} -> notImplemented "AbsBinds" -- introduced by the type checker
72− PatSynBind NoExtField psb -> p_patSynBind psb
73− XHsBindsLR x -> noExtCon x
69+ PatSynBind NoExt psb -> p_patSynBind psb
70+ XHsBindsLR NoExt -> notImplemented "XHsBindsLR"
7471
75−p_funBind ::
76− Located RdrName ->
77− MatchGroup GhcPs (LHsExpr GhcPs) ->
78− R ()
72+p_funBind
73+ :: Located RdrName
74+ -> MatchGroup GhcPs (LHsExpr GhcPs)
75+ -> R ()
7976p_funBind name = p_matchGroup (Function name)
8077
81−p_matchGroup ::
82− MatchGroupStyle ->
83− MatchGroup GhcPs (LHsExpr GhcPs) ->
84− R ()
78+p_matchGroup
79+ :: MatchGroupStyle
80+ -> MatchGroup GhcPs (LHsExpr GhcPs)
81+ -> R ()
8582p_matchGroup = p_matchGroup' exprPlacement p_hsExpr
8683
87−p_matchGroup' ::
88− Data body =>
89− -- | How to get body placement
90− (body -> Placement) ->
91− -- | How to print body
92− (body -> R ()) ->
93− -- | Style of this group of equations
94− MatchGroupStyle ->
95− -- | Match group
96− MatchGroup GhcPs (Located body) ->
97− R ()
98−p_matchGroup' placer render style MG {..} = do
84+p_matchGroup'
85+ :: Data body
86+ => (body -> Placement) -- ^ How to get body placement
87+ -> (body -> R ()) -- ^ How to print body
88+ -> MatchGroupStyle -- ^ Style of this group of equations
89+ -> MatchGroup GhcPs (Located body) -- ^ Match group
90+ -> R ()
91+p_matchGroup' placer pretty style MG {..} = do
9992 let ob = case style of
10093 Case -> id
10194 LambdaCase -> id
10295 _ -> dontUseBraces
103− -- Since we are forcing braces on 'sepSemi' based on 'ob', we have to
96+ -- NOTE since we are forcing braces on 'sepSemi' based on 'ob', we have to
10497 -- restore the brace state inside the sepsemi.
10598 ub <- bool dontUseBraces useBraces <$> canUseBraces
10699 ob $ sepSemi (located' (ub . p_Match)) (unLoc mg_alts)
@@ -108,14 +101,14 @@ p_matchGroup' placer render style MG {..} = do
108101 p_Match m@Match {..} =
109102 p_match'
110103 placer
111− render
104+ pretty
112105 (adjustMatchGroupStyle m style)
113106 (isInfixMatch m)
114107 (matchStrictness m)
115108 m_pats
116109 m_grhss
117− p_Match (XMatch x) = noExtCon x
118−p_matchGroup' _ _ _ (XMatchGroup x) = noExtCon x
110+ p_Match _ = notImplemented "XMatch"
111+p_matchGroup' _ _ _ (XMatchGroup NoExt) = notImplemented "XMatchGroup"
119112
120113-- | Function id obtained through pattern matching on 'FunBind' should not
121114-- be used to print the actual equations because the different ‘RdrNames’
@@ -123,10 +116,11 @@ p_matchGroup' _ _ _ (XMatchGroup x) = noExtCon x
123116-- and paretheses) associated with them. It is necessary to use per-equation
124117-- names obtained from 'm_ctxt' of 'Match'. This function replaces function
125118-- name inside of 'Function' accordingly.
126−adjustMatchGroupStyle ::
127− Match GhcPs body ->
128− MatchGroupStyle ->
129− MatchGroupStyle
119+
120+adjustMatchGroupStyle
121+ :: Match GhcPs body
122+ -> MatchGroupStyle
123+ -> MatchGroupStyle
130124adjustMatchGroupStyle m = \case
131125 Function _ -> (Function . mc_fun . m_ctxt) m
132126 style -> style
@@ -134,43 +128,31 @@ adjustMatchGroupStyle m = \case
134128matchStrictness :: Match id body -> SrcStrictness
135129matchStrictness match =
136130 case m_ctxt match of
137− FunRhs {mc_strictness = s} -> s
131+ FunRhs{mc_strictness=s} -> s
138132 _ -> NoSrcStrict
139133
140−p_match ::
141− -- | Style of the group
142− MatchGroupStyle ->
143− -- | Is this an infix match?
144− Bool ->
145− -- | Strictness prefix (FunBind)
146− SrcStrictness ->
147− -- | Argument patterns
148− [LPat GhcPs] ->
149− -- | Equations
150− GRHSs GhcPs (LHsExpr GhcPs) ->
151− R ()
134+p_match
135+ :: MatchGroupStyle -- ^ Style of the group
136+ -> Bool -- ^ Is this an infix match?
137+ -> SrcStrictness -- ^ Strictness prefix (FunBind)
138+ -> [LPat GhcPs] -- ^ Argument patterns
139+ -> GRHSs GhcPs (LHsExpr GhcPs) -- ^ Equations
140+ -> R ()
152141p_match = p_match' exprPlacement p_hsExpr
153142
154−p_match' ::
155− Data body =>
156− -- | How to get body placement
157− (body -> Placement) ->
158− -- | How to print body
159− (body -> R ()) ->
160− -- | Style of this group of equations
161− MatchGroupStyle ->
162− -- | Is this an infix match?
163− Bool ->
164− -- | Strictness prefix (FunBind)
165− SrcStrictness ->
166− -- | Argument patterns
167− [LPat GhcPs] ->
168− -- | Equations
169− GRHSs GhcPs (Located body) ->
170− R ()
171−p_match' placer render style isInfix strictness m_pats GRHSs {..} = do
172− -- Normally, since patterns may be placed in a multi-line layout, it is
173− -- necessary to bump indentation for the pattern group so it's more
143+p_match'
144+ :: Data body
145+ => (body -> Placement) -- ^ How to get body placement
146+ -> (body -> R ()) -- ^ How to print body
147+ -> MatchGroupStyle -- ^ Style of this group of equations
148+ -> Bool -- ^ Is this an infix match?
149+ -> SrcStrictness -- ^ Strictness prefix (FunBind)
150+ -> [LPat GhcPs] -- ^ Argument patterns
151+ -> GRHSs GhcPs (Located body) -- ^ Equations
152+ -> R ()
153+p_match' placer pretty style isInfix strictness m_pats m_grhss = do
154+ -- NOTE Normally, since patterns may be placed in a multi-line layout, it
155+ -- is necessary to bump indentation for the pattern group so it's more
174156 -- indented than function name. This in turn means that indentation for
175157 -- the body should also be bumped. Normally this would mean that bodies
176158 -- would start with two indentation steps applied, which is ugly, so we
@@ -180,24 +162,23 @@ p_match' placer render style isInfix strictness m_pats GRHSs {..} = do
180162 NoSrcStrict -> return ()
181163 SrcStrict -> txt "!"
182164 SrcLazy -> txt "~"
183− indentBody <- case NE.nonEmpty m_pats of
184− Nothing ->
185− False <$ case style of
186− Function name -> p_rdrName name
187− _ -> return ()
165+ inci' <- case NE.nonEmpty m_pats of
166+ Nothing -> id <$ case style of
167+ Function name -> p_rdrName name
168+ _ -> return ()
188169 Just ne_pats -> do
189− let combinedSpans = case style of
190− Function name -> combineSrcSpans (getLoc name) patSpans
191− _ -> patSpans
192− patSpans = combineSrcSpans' (getLoc <$> ne_pats)
193− indentBody = not (isOneLineSpan combinedSpans)
170+ let combinedSpans = combineSrcSpans' $
171+ getLoc <$> ne_pats
172+ inci' = if isOneLineSpan combinedSpans
173+ then id
174+ else inci
194175 switchLayout [combinedSpans] $ do
195176 let stdCase = sep breakpoint (located' p_pat) m_pats
196177 case style of
197178 Function name ->
198179 p_infixDefHelper
199180 isInfix
200− indentBody
181+ inci'
201182 (p_rdrName name)
202183 (located' p_pat <$> m_pats)
203184 PatternBind -> stdCase
@@ -212,40 +193,46 @@ p_match' placer render style isInfix strictness m_pats GRHSs {..} = do
212193 when needsSpace space
213194 sitcc stdCase
214195 LambdaCase -> stdCase
215− return indentBody
216− let -- Calculate position of end of patterns. This is useful when we decide
217− -- about putting certain constructions in hanging positions.
218− endOfPats = case NE.nonEmpty m_pats of
219− Nothing -> case style of
220− Function name -> Just (getLoc name)
221− _ -> Nothing
222− Just pats -> (Just . getLoc . NE.last) pats
223− isCase = \case
224− Case -> True
225− LambdaCase -> True
226− _ -> False
196+ return inci'
197+ let
198+ -- Calculate position of end of patterns. This is useful when we decide
199+ -- about putting certain constructions in hanging positions.
200+ endOfPats = case NE.nonEmpty m_pats of
201+ Nothing -> case style of
202+ Function name -> (Just . srcSpanEnd . getLoc) name
203+ _ -> Nothing
204+ Just pats -> (Just . srcSpanEnd . getLoc . NE.last) pats
205+ isCase = \case
206+ Case -> True
207+ LambdaCase -> True
208+ _ -> False
209+ let GRHSs {..} = m_grhss
227210 hasGuards = withGuards grhssGRHSs
228− grhssSpan =
229− combineSrcSpans' $
230− getGRHSSpan . unLoc <$> NE.fromList grhssGRHSs
231− patGrhssSpan =
232− maybe
233− grhssSpan
234− (combineSrcSpans grhssSpan . srcLocSpan . srcSpanEnd)
235− endOfPats
211+ unless (length grhssGRHSs > 1) $ do
212+ case style of
213+ Function _ | hasGuards -> return ()
214+ Function _ -> space >> txt "="
215+ PatternBind -> space >> txt "="
216+ s | isCase s && hasGuards -> return ()
217+ _ -> space >> txt "->"
218+ let grhssSpan = combineSrcSpans' $
219+ getGRHSSpan . unLoc <$> NE.fromList grhssGRHSs
220+ patGrhssSpan = maybe grhssSpan
221+ (combineSrcSpans grhssSpan . srcLocSpan) endOfPats
236222 placement =
237223 case endOfPats of
238224 Nothing -> blockPlacement placer grhssGRHSs
239225 Just spn ->
240− if onTheSameLine spn grhssSpan
226+ if isOneLineSpan
227+ (mkSrcSpan spn (srcSpanStart grhssSpan))
241228 then blockPlacement placer grhssGRHSs
242229 else Normal
243230 p_body = do
244231 let groupStyle =
245232 if isCase style && hasGuards
246− then RightArrow
247− else EqualSign
248− sep newline (located' (p_grhs' placer render groupStyle)) grhssGRHSs
233+ then RightArrow
234+ else EqualSign
235+ sep newline (located' (p_grhs' placer pretty groupStyle)) grhssGRHSs
249236 p_where = do
250237 let whereIsEmpty = GHC.isEmptyLocalBindsPR (unLoc grhssLocalBinds)
251238 unless (GHC.eqEmptyLocalBinds (unLoc grhssLocalBinds)) $ do
@@ -253,211 +240,186 @@ p_match' placer render style isInfix strictness m_pats GRHSs {..} = do
253240 txt "where"
254241 unless whereIsEmpty breakpoint
255242 inci $ located grhssLocalBinds p_hsLocalBinds
256− inciIf indentBody $ do
257− unless (length grhssGRHSs > 1) $
258− case style of
259− Function _ | hasGuards -> return ()
260− Function _ -> space >> inci equals
261− PatternBind -> space >> inci equals
262− s | isCase s && hasGuards -> return ()
263− _ -> space >> txt "->"
243+ inci' $ do
264244 switchLayout [patGrhssSpan] $
265245 placeHanging placement p_body
266246 inci p_where
267−p_match' _ _ _ _ _ _ (XGRHSs x) = noExtCon x
268247
269248p_grhs :: GroupStyle -> GRHS GhcPs (LHsExpr GhcPs) -> R ()
270249p_grhs = p_grhs' exprPlacement p_hsExpr
271250
272−p_grhs' ::
273− Data body =>
274− -- | How to get body placement
275− (body -> Placement) ->
276− -- | How to print body
277− (body -> R ()) ->
278− GroupStyle ->
279− GRHS GhcPs (Located body) ->
280− R ()
281−p_grhs' placer render style (GRHS NoExtField guards body) =
251+p_grhs'
252+ :: Data body
253+ => (body -> Placement) -- ^ How to get body placement
254+ -> (body -> R ()) -- ^ How to print body
255+ -> GroupStyle
256+ -> GRHS GhcPs (Located body)
257+ -> R ()
258+p_grhs' placer pretty style (GRHS NoExt guards body) =
282259 case guards of
283260 [] -> p_body
284261 xs -> do
285262 txt "|"
286263 space
287− sitcc (sep commaDel (sitcc . located' p_stmt) xs)
264+ sitcc (sep (comma >> breakpoint) (sitcc . located' p_stmt) xs)
288265 space
289− inci $ case style of
290− EqualSign -> equals
291− RightArrow -> txt "->"
266+ txt $ case style of
267+ EqualSign -> "="
268+ RightArrow -> "->"
292269 placeHanging placement p_body
293270 where
294271 placement =
295272 case endOfGuards of
296273 Nothing -> placer (unLoc body)
297274 Just spn ->
298− if onTheSameLine spn (getLoc body)
299− then placer (unLoc body)
300− else Normal
275+ if isOneLineSpan (mkSrcSpan spn (srcSpanStart (getLoc body)))
276+ then placer (unLoc body)
277+ else Normal
301278 endOfGuards =
302279 case NE.nonEmpty guards of
303280 Nothing -> Nothing
304− Just gs -> (Just . getLoc . NE.last) gs
305− p_body = located body render
306−p_grhs' _ _ _ (XGRHS x) = noExtCon x
281+ Just gs -> (Just . srcSpanEnd . getLoc . NE.last) gs
282+ p_body = located body pretty
283+p_grhs' _ _ _ (XGRHS NoExt) = notImplemented "XGRHS"
307284
308285p_hsCmd :: HsCmd GhcPs -> R ()
309286p_hsCmd = \case
310− HsCmdArrApp NoExtField body input arrType _ -> do
287+ HsCmdArrApp NoExt body input arrType _ -> do
311288 located body p_hsExpr
312− breakpoint
313− inci $ do
314− case arrType of
315− HsFirstOrderApp -> txt "-<"
316− HsHigherOrderApp -> txt "-<<"
317− placeHanging (exprPlacement (unLoc input)) $
318− located input p_hsExpr
319− HsCmdArrForm NoExtField form Prefix _ cmds -> banana $ do
289+ space
290+ case arrType of
291+ HsFirstOrderApp -> txt "-<"
292+ HsHigherOrderApp -> txt "-<<"
293+ placeHanging (exprPlacement (unLoc input)) $
294+ located input p_hsExpr
295+ HsCmdArrForm NoExt form Prefix _ cmds -> banana $ sitcc $ do
320296 located form p_hsExpr
321297 unless (null cmds) $ do
322298 breakpoint
323299 inci (sequence_ (intersperse breakpoint (located' p_hsCmdTop <$> cmds)))
324− HsCmdArrForm NoExtField form Infix _ [left, right] -> do
300+ HsCmdArrForm NoExt form Infix _ [left, right] -> do
325301 located left p_hsCmdTop
326302 space
327303 located form p_hsExpr
328304 placeHanging (cmdTopPlacement (unLoc right)) $
329305 located right p_hsCmdTop
330− HsCmdArrForm NoExtField _ Infix _ _ -> notImplemented "HsCmdArrForm"
306+ HsCmdArrForm NoExt _ Infix _ _ -> notImplemented "HsCmdArrForm"
331307 HsCmdApp {} ->
332308 -- XXX Does this ever occur in the syntax tree? It does not seem like it
333309 -- does. Open an issue and ping @yumiova if this ever occurs in output.
334310 notImplemented "HsCmdApp"
335− HsCmdLam NoExtField mgroup -> p_matchGroup' cmdPlacement p_hsCmd Lambda mgroup
336− HsCmdPar NoExtField c -> parens N (located c p_hsCmd)
337− HsCmdCase NoExtField e mgroup ->
338− p_case cmdPlacement p_hsCmd e mgroup
339− HsCmdIf NoExtField _ if' then' else' ->
340− p_if cmdPlacement p_hsCmd if' then' else'
341− HsCmdLet NoExtField localBinds c ->
342− p_let p_hsCmd localBinds c
343− HsCmdDo NoExtField es -> do
311+ HsCmdLam NoExt mgroup -> p_matchGroup' cmdPlacement p_hsCmd Lambda mgroup
312+ HsCmdPar NoExt c -> parens (located c p_hsCmd)
313+ HsCmdCase NoExt e mgroup -> do
314+ txt "case"
315+ space
316+ located e p_hsExpr
317+ space
318+ txt "of"
319+ breakpoint
320+ inci (p_matchGroup' cmdPlacement p_hsCmd Case mgroup)
321+ HsCmdIf NoExt _ if' then' else' -> do
322+ txt "if"
323+ space
324+ located if' p_hsExpr
325+ breakpoint
326+ txt "then"
327+ located then' $ \x -> do
328+ breakpoint
329+ inci (p_hsCmd x)
330+ breakpoint
331+ txt "else"
332+ located else' $ \x -> do
333+ breakpoint
334+ inci (p_hsCmd x)
335+ HsCmdLet NoExt localBinds c -> do
336+ txt "let"
337+ space
338+ sitcc (located localBinds p_hsLocalBinds)
339+ breakpoint
340+ txt "in"
341+ space
342+ sitcc (located c p_hsCmd)
343+ HsCmdDo NoExt es -> do
344344 txt "do"
345345 newline
346− inci . located es $
347− sitcc . sep newline (sitcc . withSpacing (p_stmt' cmdPlacement p_hsCmd))
346+ inci (located es (sitcc . sep newline (located' (sitcc . p_stmt' p_hsCmd))))
348347 HsCmdWrap {} -> notImplemented "HsCmdWrap"
349− XCmd x -> noExtCon x
348+ XCmd {} -> notImplemented "XCmd"
350349
351350p_hsCmdTop :: HsCmdTop GhcPs -> R ()
352351p_hsCmdTop = \case
353− HsCmdTop NoExtField cmd -> located cmd p_hsCmd
354− XCmdTop x -> noExtCon x
355−
356−-- | Render an expression preserving blank lines between such consecutive
357−-- expressions found in the original source code.
358−withSpacing ::
359− -- | Rendering function
360− (a -> R ()) ->
361− -- | Entity to render
362− Located a ->
363− R ()
364−withSpacing f l = located l $ \x -> do
365− case getLoc l of
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
374− then newline
375− else return ()
376− _ -> return ()
377− f x
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)
352+ HsCmdTop NoExt cmd -> located cmd p_hsCmd
353+ XCmdTop {} -> notImplemented "XHsCmdTop"
384354
385355p_stmt :: Stmt GhcPs (LHsExpr GhcPs) -> R ()
386−p_stmt = p_stmt' exprPlacement p_hsExpr
356+p_stmt = p_stmt' p_hsExpr
387357
388−p_stmt' ::
389− Data body =>
390− -- | Placer
391− (body -> Placement) ->
392− -- | Render
393− (body -> R ()) ->
394− -- | Statement to render
395− Stmt GhcPs (Located body) ->
396− R ()
397−p_stmt' placer render = \case
398− LastStmt NoExtField body _ _ -> located body render
399− BindStmt NoExtField p f _ _ -> do
400− located p p_pat
358+p_stmt'
359+ :: Data body
360+ => (body -> R ())
361+ -> Stmt GhcPs (Located body)
362+ -> R ()
363+p_stmt' pretty = \case
364+ LastStmt NoExt body _ _ -> located body pretty
365+ BindStmt NoExt l f _ _ -> do
366+ located l p_pat
401367 space
402368 txt "<-"
403− let loc = getLoc p
404− placement =
405− case f of
406− L l' x ->
407− if isOneLineSpan
408− (mkSrcSpan (srcSpanEnd loc) (srcSpanStart l'))
409− then placer x
410− else Normal
411− switchLayout [loc, getLoc f] $
412− placeHanging placement (located f render)
369+ breakpoint
370+ inci (located f pretty)
413371 ApplicativeStmt {} -> notImplemented "ApplicativeStmt" -- generated by renamer
414− BodyStmt NoExtField body _ _ -> located body render
415− LetStmt NoExtField binds -> do
372+ BodyStmt NoExt body _ _ -> located body pretty
373+ LetStmt NoExt binds -> do
416374 txt "let"
417375 space
418376 sitcc $ located binds p_hsLocalBinds
419377 ParStmt {} ->
420− -- 'ParStmt' should always be eliminated in 'gatherStmt' already, such
421− -- that it never occurs in 'p_stmt''. Consequently, handling it here
422− -- would be redundant.
378+ -- NOTE 'ParStmt' should always be eliminated in 'gatherStmt' already,
379+ -- such that it never occurs in 'p_stmt''. Consequently, handling it
380+ -- here would be redundant.
423381 notImplemented "ParStmt"
424− TransStmt {..} ->
425− -- 'TransStmt' only needs to account for render printing itself, since
426− -- pretty printing of relevant statements (e.g., in 'trS_stmts') is
427− -- handled through 'gatherStmt'.
382+ TransStmt {..} -> do
383+ -- NOTE 'TransStmt' only needs to account for pretty printing itself,
384+ -- since pretty printing of relevant statements (e.g., in 'trS_stmts')
385+ -- is handled through 'gatherStmt'.
428386 case (trS_form, trS_by) of
429− (ThenForm, Nothing) -> do
387+ (ThenForm, Nothing) -> located trS_using $ \x -> do
430388 txt "then"
431389 breakpoint
432− inci $ located trS_using p_hsExpr
390+ inci (p_hsExpr x)
433391 (ThenForm, Just e) -> do
434− txt "then"
435− breakpoint
436− inci $ located trS_using p_hsExpr
437− breakpoint
438− txt "by"
392+ located trS_using $ \x -> do
393+ txt "then"
394+ breakpoint
395+ inci (p_hsExpr x)
439396 breakpoint
440− inci $ located e p_hsExpr
441− (GroupForm, Nothing) -> do
397+ located e $ \x -> do
398+ txt "by"
399+ breakpoint
400+ inci (p_hsExpr x)
401+ (GroupForm, Nothing) -> located trS_using $ \x -> do
442402 txt "then group using"
443403 breakpoint
444− inci $ located trS_using p_hsExpr
404+ inci (p_hsExpr x)
445405 (GroupForm, Just e) -> do
446− txt "then group by"
447− breakpoint
448− inci $ located e p_hsExpr
449− breakpoint
450− txt "using"
406+ located e $ \x -> do
407+ txt "then group by"
408+ breakpoint
409+ inci (p_hsExpr x)
451410 breakpoint
452− inci $ located trS_using p_hsExpr
411+ located trS_using $ \x -> do
412+ txt "using"
413+ breakpoint
414+ inci (p_hsExpr x)
453415 RecStmt {..} -> do
454416 txt "rec"
455417 space
456− sitcc $ sepSemi (withSpacing (p_stmt' placer render)) recS_stmts
457− XStmtLR c -> noExtCon c
418+ sitcc $ sepSemi (located' (p_stmt' pretty)) recS_stmts
419+ XStmtLR {} -> notImplemented "XStmtLR"
458420
459421gatherStmt :: ExprLStmt GhcPs -> [[ExprLStmt GhcPs]]
460−gatherStmt (L _ (ParStmt NoExtField block _ _)) =
422+gatherStmt (L _ (ParStmt NoExt block _ _)) =
461423 foldr ((<>) . gatherStmtBlock) [] block
462424gatherStmt (L s stmt@TransStmt {..}) =
463425 foldr liftAppend [] ((gatherStmt <$> trS_stmts) <> pure [[L s stmt]])
@@ -466,230 +428,182 @@ gatherStmt stmt = [[stmt]]
466428gatherStmtBlock :: ParStmtBlock GhcPs GhcPs -> [[ExprLStmt GhcPs]]
467429gatherStmtBlock (ParStmtBlock _ stmts _ _) =
468430 foldr (liftAppend . gatherStmt) [] stmts
469−gatherStmtBlock (XParStmtBlock x) = noExtCon x
431+gatherStmtBlock XParStmtBlock {} = notImplemented "XParStmtBlock"
470432
471433p_hsLocalBinds :: HsLocalBindsLR GhcPs GhcPs -> R ()
472434p_hsLocalBinds = \case
473− HsValBinds NoExtField (ValBinds NoExtField bag lsigs) -> do
474− -- When in a single-line layout, there is a chance that the inner
435+ HsValBinds NoExt (ValBinds NoExt bag lsigs) -> do
436+ let ssStart = either
437+ (srcSpanStart . getLoc)
438+ (srcSpanStart . getLoc)
439+ items =
440+ (Left <$> bagToList bag) ++ (Right <$> lsigs)
441+ p_item (Left x) = located x p_valDecl
442+ p_item (Right x) = located x p_sigDecl
443+ -- Assigns 'False' to the last element, 'True' to the rest.
444+ markInit :: [a] -> [(Bool, a)]
445+ markInit [] = []
446+ markInit (x:[]) = [(False, x)]
447+ markInit (x:xs) = (True, x) : markInit xs
448+ -- NOTE When in a single-line layout, there is a chance that the inner
475449 -- elements will also contain semicolons and they will confuse the
476450 -- parser. so we request braces around every element except the last.
477− br <- layoutToBraces <$> getLayout
478− let items =
479− let injectLeft (L l x) = L l (Left x)
480− injectRight (L l x) = L l (Right x)
481− in (injectLeft <$> bagToList bag) ++ (injectRight <$> lsigs)
482− positionToBracing = \case
483− SinglePos -> id
484− FirstPos -> br
485− MiddlePos -> br
486− LastPos -> id
487− p_item' (p, item) =
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"
493− HsIPBinds NoExtField (IPBinds NoExtField xs) ->
451+ br <- vlayout (return useBraces) (return id)
452+ sitcc $ sepSemi
453+ (\(m, i) -> (if m then br else id) $ p_item i)
454+ (markInit $ sortOn ssStart items)
455+ HsValBinds NoExt _ -> notImplemented "HsValBinds"
456+ HsIPBinds NoExt (IPBinds NoExt xs) ->
494457 -- Second argument of IPBind is always Left before type-checking.
495− let p_ipBind (IPBind NoExtField (Left name) expr) = do
458+ let p_ipBind (IPBind NoExt (Left name) expr) = do
496459 atom name
497460 space
498− equals
461+ txt "="
499462 breakpoint
500463 useBraces $ inci $ located expr p_hsExpr
501− p_ipBind (IPBind NoExtField (Right _) _) =
502− -- Should only occur after the type checker
503− notImplemented "IPBind _ (Right _) _"
504− p_ipBind (XIPBind x) = noExtCon x
464+ p_ipBind _ = notImplemented "XHsIPBinds"
505465 in sepSemi (located' p_ipBind) xs
506− HsIPBinds NoExtField _ -> notImplemented "HsIpBinds"
507− EmptyLocalBinds NoExtField -> return ()
508− XHsLocalBindsLR x -> noExtCon x
466+ HsIPBinds NoExt _ -> notImplemented "HsIpBinds"
467+ EmptyLocalBinds NoExt -> return ()
468+ XHsLocalBindsLR _ -> notImplemented "XHsLocalBindsLR"
509469
510−p_hsRecField ::
511− HsRecField' RdrName (LHsExpr GhcPs) ->
512− R ()
513−p_hsRecField HsRecField {..} = do
470+p_hsRecField
471+ :: HsRecField' RdrName (LHsExpr GhcPs)
472+ -> R ()
473+p_hsRecField = \HsRecField {..} -> do
514474 p_rdrName hsRecFieldLbl
515475 unless hsRecPun $ do
516476 space
517− equals
518− let placement =
519− if onTheSameLine (getLoc hsRecFieldLbl) (getLoc hsRecFieldArg)
520− then exprPlacement (unLoc hsRecFieldArg)
521− else Normal
522− placeHanging placement (located hsRecFieldArg p_hsExpr)
477+ txt "="
478+ let placement = exprPlacement (unLoc hsRecFieldArg)
479+ placeHanging placement $ located hsRecFieldArg p_hsExpr
523480
524−p_hsExpr :: HsExpr GhcPs -> R ()
525−p_hsExpr = p_hsExpr' N
481+p_hsTupArg :: HsTupArg GhcPs -> R ()
482+p_hsTupArg = \case
483+ Present NoExt x -> located x p_hsExpr
484+ Missing NoExt -> pure ()
485+ XTupArg {} -> notImplemented "XTupArg"
526486
527−p_hsExpr' :: BracketStyle -> HsExpr GhcPs -> R ()
528−p_hsExpr' s = \case
529− HsVar NoExtField name -> p_rdrName name
530− HsUnboundVar NoExtField v -> atom (unboundVarOcc v)
531− HsConLikeOut NoExtField _ -> notImplemented "HsConLikeOut"
532− HsRecFld NoExtField x ->
487+p_hsExpr :: HsExpr GhcPs -> R ()
488+p_hsExpr = \case
489+ HsVar NoExt name -> p_rdrName name
490+ HsUnboundVar NoExt _ -> notImplemented "HsUnboundVar"
491+ HsConLikeOut NoExt _ -> notImplemented "HsConLikeOut"
492+ HsRecFld NoExt x ->
533493 case x of
534− Unambiguous NoExtField name -> p_rdrName name
535− Ambiguous NoExtField name -> p_rdrName name
536− XAmbiguousFieldOcc xx -> noExtCon xx
537− HsOverLabel NoExtField _ v -> do
494+ Unambiguous NoExt name -> p_rdrName name
495+ Ambiguous NoExt name -> p_rdrName name
496+ XAmbiguousFieldOcc NoExt -> notImplemented "XAmbiguousFieldOcc"
497+ HsOverLabel NoExt _ v -> do
538498 txt "#"
539499 atom v
540− HsIPVar NoExtField (HsIPName name) -> do
500+ HsIPVar NoExt (HsIPName name) -> do
541501 txt "?"
542502 atom name
543− HsOverLit NoExtField v -> atom (ol_val v)
544− HsLit NoExtField lit ->
503+ HsOverLit NoExt v -> atom (ol_val v)
504+ HsLit NoExt lit ->
545505 case lit of
546− HsString (SourceText stxt) _ -> p_stringLit stxt
547− HsStringPrim (SourceText stxt) _ -> p_stringLit stxt
506+ HsString (SourceText s) _ -> p_stringLit s
507+ HsStringPrim (SourceText s) _ -> p_stringLit s
548508 r -> atom r
549− HsLam NoExtField mgroup ->
509+ HsLam NoExt mgroup ->
550510 p_matchGroup Lambda mgroup
551− HsLamCase NoExtField mgroup -> do
511+ HsLamCase NoExt mgroup -> do
552512 txt "\\case"
553513 breakpoint
554514 inci (p_matchGroup LambdaCase mgroup)
555− HsApp NoExtField f x -> do
556− let -- In order to format function applications with multiple parameters
557− -- nicer, traverse the AST to gather the function and all the
558− -- parameters together.
559− gatherArgs f' knownArgs =
560− case f' of
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)
567− initSpan =
568− combineSrcSpans' $
569− getLoc f :| [(srcLocSpan . srcSpanStart . getLoc) lastp]
570− -- Hang the last argument only if the initial arguments span one
571− -- line.
572− placement =
573− if isOneLineSpan initSpan
574− then exprPlacement (unLoc lastp)
575− else Normal
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
579− -- one.
580− case placement of
581− Normal -> do
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.
587− doIndent =
588− case func of
589− L _ (HsPar NoExtField _) -> True
590− L _ (HsAppType NoExtField _ _) -> True
591− L _ (HsMultiIf NoExtField _) -> True
592− L spn _ -> isOneLineSpan spn
593− ub <-
594− getLayout <&> \case
595− SingleLine -> useBraces
596− MultiLine -> id
597− ub $ do
598− located func (p_hsExpr' s)
599− breakpoint
600− inciIf doIndent $ sep breakpoint (located' p_hsExpr) initp
601− inciIf doIndent $ do
602− unless (null initp) breakpoint
603− located lastp p_hsExpr
604− Hanging -> do
605− useBraces . switchLayout [initSpan] $ do
606− located func (p_hsExpr' s)
607− breakpoint
608− sep breakpoint (located' p_hsExpr) initp
609− placeHanging placement $
610− located lastp p_hsExpr
611− HsAppType NoExtField e a -> do
515+ HsApp NoExt f x -> sitcc $ do
516+ located f p_hsExpr
517+ -- Second argument can be a `do` or `case` block with `-XBlockArguments`.
518+ placeHanging (exprPlacement (unLoc x)) $
519+ located x p_hsExpr
520+ HsAppType a e -> do
612521 located e p_hsExpr
613522 breakpoint
614523 inci $ do
615524 txt "@"
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
620− _ -> return ()
621525 located (hswc_body a) p_hsType
622− OpApp NoExtField x op y -> do
526+ OpApp NoExt x op y -> do
623527 let opTree = OpBranch (exprOpTree x) op (exprOpTree y)
624− p_exprOpTree s (reassociateOpTree getOpName opTree)
625− NegApp NoExtField e _ -> do
528+ getOpName = \case
529+ HsVar NoExt (L _ a) -> Just a
530+ _ -> Nothing
531+ p_exprOpTree (reassociateOpTree getOpName opTree)
532+ NegApp NoExt e _ -> do
626533 txt "-"
627534 space
628535 located e p_hsExpr
629− HsPar NoExtField e ->
630− parens s (located e (dontUseBraces . p_hsExpr))
631− SectionL NoExtField x op -> do
536+ HsPar NoExt e -> parens (located e p_hsExpr)
537+ SectionL NoExt x op -> do
632538 located x p_hsExpr
633539 breakpoint
634540 inci (located op p_hsExpr)
635− SectionR NoExtField op x -> do
541+ SectionR NoExt op x -> do
636542 located op p_hsExpr
637− useRecordDot' <- useRecordDot
638− let isRecordDot' = isRecordDot (unLoc op) (getLoc x)
639− unless (useRecordDot' && isRecordDot') breakpoint
543+ breakpoint
640544 inci (located x p_hsExpr)
641− ExplicitTuple NoExtField args boxity ->
545+ ExplicitTuple NoExt args boxity -> do
642546 let isSection = any (isMissing . unLoc) args
643547 isMissing = \case
644− Missing NoExtField -> True
548+ Missing NoExt -> True
645549 _ -> False
646− p_arg = \case
647− Present NoExtField x -> located x p_hsExpr
648− Missing NoExtField -> pure ()
649− XTupArg x -> noExtCon x
650− p_larg = sitcc . located' p_arg
651− parens' =
550+ let parens' =
652551 case boxity of
653552 Boxed -> parens
654553 Unboxed -> parensHash
655− in if isSection
656− then
657− switchLayout [] . parens' s $
658− sep comma p_larg args
659− else
660− switchLayout (getLoc <$> args) . parens' s $
661− sep commaDel p_larg args
662− ExplicitSum NoExtField tag arity e ->
663− p_unboxedSum N tag arity (located e p_hsExpr)
664− HsCase NoExtField e mgroup ->
665− p_case exprPlacement p_hsExpr e mgroup
666− HsIf NoExtField _ if' then' else' ->
667− p_if exprPlacement p_hsExpr if' then' else'
668− HsMultiIf NoExtField guards -> do
554+ if isSection
555+ then switchLayout [] . parens' $
556+ sep comma (located' p_hsTupArg) args
557+ else switchLayout (getLoc <$> args) . parens' . sitcc $
558+ sep (comma >> breakpoint) (sitcc . located' p_hsTupArg) args
559+ ExplicitSum NoExt tag arity e ->
560+ p_unboxedSum tag arity (located e p_hsExpr)
561+ HsCase NoExt e mgroup -> do
562+ txt "case"
563+ space
564+ located e p_hsExpr
565+ space
566+ txt "of"
567+ breakpoint
568+ inci (p_matchGroup Case mgroup)
569+ HsIf NoExt _ if' then' else' -> do
570+ txt "if"
571+ space
572+ located if' p_hsExpr
573+ breakpoint
574+ inci $ do
575+ txt "then"
576+ located then' $ \x ->
577+ placeHanging (exprPlacement x) (p_hsExpr x)
578+ breakpoint
579+ txt "else"
580+ located else' $ \x ->
581+ placeHanging (exprPlacement x) (p_hsExpr x)
582+ HsMultiIf NoExt guards -> do
669583 txt "if"
670584 breakpoint
671− inci . inci $ sep newline (located' (p_grhs RightArrow)) guards
672− HsLet NoExtField localBinds e ->
673− p_let p_hsExpr localBinds e
674− HsDo NoExtField ctx es -> do
585+ inci . sitcc $ sep newline (located' (p_grhs RightArrow)) guards
586+ HsLet NoExt localBinds e -> sitcc $ do
587+ txt "let"
588+ space
589+ dontUseBraces $ sitcc (located localBinds p_hsLocalBinds)
590+ vlayout space (newline >> txt " ")
591+ txt "in"
592+ space
593+ sitcc (located e p_hsExpr)
594+ HsDo NoExt ctx es -> do
675595 let doBody header = do
676596 txt header
677597 breakpoint
678− ub <- layoutToBraces <$> getLayout
679− inci $
680− sepSemi
681− (ub . withSpacing (p_stmt' exprPlacement (p_hsExpr' S)))
682− (unLoc es)
683− compBody = brackets N . located es $ \xs -> do
684− let p_parBody =
685− sep
686− (breakpoint >> txt "|" >> space)
687− p_seqBody
688− p_seqBody =
689− sitcc
690− . sep
691− commaDel
692− (located' (sitcc . p_stmt))
598+ ub <- vlayout (return useBraces) (return id)
599+ inci $ sepSemi (located' (ub . p_stmt)) (unLoc es)
600+ compBody = brackets $ located es $ \xs -> do
601+ let p_parBody = sep
602+ (breakpoint >> txt "| ")
603+ p_seqBody
604+ p_seqBody = sitcc . sep
605+ (comma >> breakpoint)
606+ (located' (sitcc . p_stmt))
693607 stmts = init xs
694608 yield = last xs
695609 lists = foldr (liftAppend . gatherStmt) [] stmts
@@ -703,100 +617,90 @@ p_hsExpr' s = \case
703617 MDoExpr -> doBody "mdo"
704618 ListComp -> compBody
705619 MonadComp -> notImplemented "MonadComp"
706− ArrowExpr -> notImplemented "ArrowExpr"
620+ ArrowExpr -> notImplemented "ArrowExpr"
707621 GhciStmtCtxt -> notImplemented "GhciStmtCtxt"
708622 PatGuard _ -> notImplemented "PatGuard"
709623 ParStmtCtxt _ -> notImplemented "ParStmtCtxt"
710624 TransStmtCtxt _ -> notImplemented "TransStmtCtxt"
711625 ExplicitList _ _ xs ->
712− brackets s $
713− sep commaDel (sitcc . located' p_hsExpr) xs
626+ brackets . sitcc $ sep (comma >> breakpoint) (sitcc . located' p_hsExpr) xs
714627 RecordCon {..} -> do
715628 located rcon_con_name atom
716629 breakpoint
717630 let HsRecFields {..} = rcon_flds
718− updName f =
719− (f :: HsRecField GhcPs (LHsExpr GhcPs))
720− { hsRecFieldLbl = case unLoc $ hsRecFieldLbl f of
721− FieldOcc _ n -> n
722− XFieldOcc x -> noExtCon x
723− }
631+ updName f = f {
632+ hsRecFieldLbl = case unLoc $ hsRecFieldLbl f of
633+ FieldOcc _ n -> n
634+ XFieldOcc _ -> notImplemented "XFieldOcc"
635+ }
724636 fields = located' (p_hsRecField . updName) <$> rec_flds
725637 dotdot =
726638 case rec_dotdot of
727639 Just {} -> [txt ".."]
728640 Nothing -> []
729− inci . braces N $
730− sep commaDel sitcc (fields <> dotdot)
641+ inci . braces . sitcc $ sep (comma >> breakpoint) sitcc (fields <> dotdot)
731642 RecordUpd {..} -> do
732643 located rupd_expr p_hsExpr
733− useRecordDot' <- useRecordDot
734− let mrs sp = case getLoc sp of
735− RealSrcSpan r -> Just r
736− _ -> Nothing
737− let isPluginForm =
738− ((1 +) . srcSpanEndCol <$> mrs rupd_expr)
739− == (srcSpanStartCol <$> mrs (head rupd_flds))
740− unless (useRecordDot' && isPluginForm) breakpoint
741− let updName f =
742− (f :: HsRecUpdField GhcPs)
743− { hsRecFieldLbl = case unLoc $ hsRecFieldLbl f of
744− Ambiguous _ n -> n
745− Unambiguous _ n -> n
746− XAmbiguousFieldOcc x -> noExtCon x
747− }
748− inci . braces N $
644+ breakpoint
645+ let updName f = f {
646+ hsRecFieldLbl = case unLoc $ hsRecFieldLbl f of
647+ Ambiguous _ n -> n
648+ Unambiguous _ n -> n
649+ XAmbiguousFieldOcc _ -> notImplemented "XAmbiguousFieldOcc"
650+ }
651+ inci . braces . sitcc $
749652 sep
750− commaDel
653+ (comma >> breakpoint)
751654 (sitcc . located' (p_hsRecField . updName))
752655 rupd_flds
753− ExprWithTySig NoExtField x HsWC {hswc_body = HsIB {..}} -> sitcc $ do
656+ ExprWithTySig affix x -> sitcc $ do
754657 located x p_hsExpr
755− space
756− txt "::"
757658 breakpoint
758− inci $ 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 ->
659+ inci $ do
660+ txt "::"
661+ space
662+ let HsWC {..} = affix
663+ HsIB {..} = hswc_body
664+ located hsib_body p_hsType
665+ ArithSeq NoExt _ x -> do
762666 case x of
763− From from -> brackets s $ do
667+ From from -> brackets . sitcc $ do
764668 located from p_hsExpr
765669 breakpoint
766670 txt ".."
767− FromThen from next -> brackets s $ do
768− sep commaDel (located' p_hsExpr) [from, next]
671+ FromThen from next -> brackets . sitcc $ do
672+ sitcc $ sep (comma >> breakpoint) (located' p_hsExpr) [from, next]
769673 breakpoint
770674 txt ".."
771− FromTo from to -> brackets s $ do
675+ FromTo from to -> brackets . sitcc $ do
772676 located from p_hsExpr
773677 breakpoint
774678 txt ".."
775679 space
776680 located to p_hsExpr
777− FromThenTo from next to -> brackets s $ do
778− sep commaDel (located' p_hsExpr) [from, next]
681+ FromThenTo from next to -> brackets . sitcc $ do
682+ sitcc $ sep (comma >> breakpoint) (located' p_hsExpr) [from, next]
779683 breakpoint
780684 txt ".."
781685 space
782686 located to p_hsExpr
783− HsSCC NoExtField _ name x -> do
687+ HsSCC NoExt _ name x -> do
784688 txt "{-# SCC "
785689 atom name
786690 txt " #-}"
787691 breakpoint
788692 located x p_hsExpr
789− HsCoreAnn NoExtField _ value x -> do
693+ HsCoreAnn NoExt _ value x -> do
790694 txt "{-# CORE "
791695 atom value
792696 txt " #-}"
793697 breakpoint
794698 located x p_hsExpr
795− HsBracket NoExtField x -> p_hsBracket x
699+ HsBracket NoExt x -> p_hsBracket x
796700 HsRnBracketOut {} -> notImplemented "HsRnBracketOut"
797701 HsTcBracketOut {} -> notImplemented "HsTcBracketOut"
798− HsSpliceE NoExtField splice -> p_hsSplice splice
799− HsProc NoExtField p e -> do
702+ HsSpliceE NoExt splice -> p_hsSplice splice
703+ HsProc NoExt p e -> do
800704 txt "proc"
801705 located p $ \x -> do
802706 breakpoint
@@ -805,46 +709,65 @@ p_hsExpr' s = \case
805709 txt "->"
806710 placeHanging (cmdTopPlacement (unLoc e)) $
807711 located e p_hsCmdTop
808− HsStatic _ e -> do
712+ HsStatic _ e -> do
809713 txt "static"
810714 breakpoint
811715 inci (located e p_hsExpr)
716+ HsArrApp NoExt body input arrType cond ->
717+ p_hsCmd (HsCmdArrApp NoExt body input arrType cond)
718+ HsArrForm NoExt form mfixity cmds ->
719+ p_hsCmd (HsCmdArrForm NoExt form Prefix mfixity cmds)
812720 HsTick {} -> notImplemented "HsTick"
813721 HsBinTick {} -> notImplemented "HsBinTick"
814722 HsTickPragma {} -> notImplemented "HsTickPragma"
723+ -- These four constructs should never appear in correct programs.
724+ -- See: https://github.com/tweag/ormolu/issues/343
725+ EWildPat NoExt -> txt "_"
726+ EAsPat NoExt n p -> do
727+ p_rdrName n
728+ txt "@"
729+ located p p_hsExpr
730+ EViewPat NoExt p e -> do
731+ located p p_hsExpr
732+ space
733+ txt "->"
734+ breakpoint
735+ inci (located e p_hsExpr)
736+ ELazyPat NoExt p -> do
737+ txt "~"
738+ located p p_hsExpr
815739 HsWrap {} -> notImplemented "HsWrap"
816− XExpr x -> noExtCon x
740+ XExpr {} -> notImplemented "XExpr"
817741
818742p_patSynBind :: PatSynBind GhcPs GhcPs -> R ()
819743p_patSynBind PSB {..} = do
820− let rhs = do
821− space
822− case psb_dir of
823− Unidirectional -> do
824− txt "<-"
825− breakpoint
826− located psb_def p_pat
827− ImplicitBidirectional -> do
828− equals
829− breakpoint
830− located psb_def p_pat
831− ExplicitBidirectional mgroup -> do
832− txt "<-"
833− breakpoint
834− located psb_def p_pat
835− newline
836− txt "where"
837− newline
838− inci (p_matchGroup (Function psb_id) mgroup)
744+ let rhs = case psb_dir of
745+ Unidirectional -> do
746+ txt "<-"
747+ space
748+ located psb_def p_pat
749+ ImplicitBidirectional -> do
750+ txt "="
751+ space
752+ located psb_def p_pat
753+ ExplicitBidirectional mgroup -> do
754+ txt "<-"
755+ space
756+ located psb_def p_pat
757+ newline
758+ txt "where"
759+ newline
760+ inci (p_matchGroup (Function psb_id) mgroup)
839761 txt "pattern"
840762 case psb_args of
841763 PrefixCon xs -> do
842764 space
843765 p_rdrName psb_id
844− inci $ do
766+ inci $ do
845767 switchLayout (getLoc <$> xs) $ do
846768 unless (null xs) breakpoint
847769 sitcc (sep breakpoint p_rdrName xs)
770+ breakpoint
848771 rhs
849772 RecCon xs -> do
850773 space
@@ -852,8 +775,9 @@ p_patSynBind PSB {..} = do
852775 inci $ do
853776 switchLayout (getLoc . recordPatSynPatVar <$> xs) $ do
854777 unless (null xs) breakpoint
855− braces N $
856− sep commaDel (p_rdrName . recordPatSynPatVar) xs
778+ braces . sitcc $
779+ sep (comma >> breakpoint) (p_rdrName . recordPatSynPatVar) xs
780+ breakpoint
857781 rhs
858782 InfixCon l r -> do
859783 switchLayout [getLoc l, getLoc r] $ do
@@ -864,100 +788,37 @@ p_patSynBind PSB {..} = do
864788 p_rdrName psb_id
865789 space
866790 p_rdrName r
867− inci rhs
868−p_patSynBind (XPatSynBind x) = noExtCon x
869−
870−p_case ::
871− Data body =>
872− -- | Placer
873− (body -> Placement) ->
874− -- | Render
875− (body -> R ()) ->
876− -- | Expression
877− LHsExpr GhcPs ->
878− -- | Match group
879− MatchGroup GhcPs (Located body) ->
880− R ()
881−p_case placer render e mgroup = do
882− txt "case"
883− space
884− located e p_hsExpr
885− space
886− txt "of"
887− breakpoint
888− inci (p_matchGroup' placer render Case mgroup)
889−
890−p_if ::
891− Data body =>
892− -- | Placer
893− (body -> Placement) ->
894− -- | Render
895− (body -> R ()) ->
896− -- | If
897− LHsExpr GhcPs ->
898− -- | Then
899− Located body ->
900− -- | Else
901− Located body ->
902− R ()
903−p_if placer render if' then' else' = do
904− txt "if"
905− space
906− located if' p_hsExpr
907− breakpoint
908− inci $ do
909− txt "then"
910− space
911− located then' $ \x ->
912− placeHanging (placer x) (render x)
913− breakpoint
914− txt "else"
915− space
916− located else' $ \x ->
917− placeHanging (placer x) (render x)
918−
919−p_let ::
920− Data body =>
921− -- | Render
922− (body -> R ()) ->
923− Located (HsLocalBindsLR GhcPs GhcPs) ->
924− Located body ->
925− R ()
926−p_let render localBinds e = sitcc $ do
927− txt "let"
928− space
929− dontUseBraces $ sitcc (located localBinds p_hsLocalBinds)
930− vlayout space (newline >> txt " ")
931− txt "in"
932− space
933− sitcc (located e render)
791+ inci $ do
792+ breakpoint
793+ rhs
794+p_patSynBind (XPatSynBind NoExt) = notImplemented "XPatSynBind"
934795
935796p_pat :: Pat GhcPs -> R ()
936797p_pat = \case
937− WildPat NoExtField -> txt "_"
938− VarPat NoExtField name -> p_rdrName name
939− LazyPat NoExtField pat -> do
798+ WildPat NoExt -> txt "_"
799+ VarPat NoExt name -> p_rdrName name
800+ LazyPat NoExt pat -> do
940801 txt "~"
941802 located pat p_pat
942− AsPat NoExtField name pat -> do
803+ AsPat NoExt name pat -> do
943804 p_rdrName name
944805 txt "@"
945806 located pat p_pat
946− ParPat NoExtField pat ->
947− located pat (parens S . p_pat)
948− BangPat NoExtField pat -> do
807+ ParPat NoExt pat ->
808+ located pat (parens . p_pat)
809+ BangPat NoExt pat -> do
949810 txt "!"
950811 located pat p_pat
951− ListPat NoExtField pats ->
952− brackets S $ sep commaDel (located' p_pat) pats
953− TuplePat NoExtField pats boxing -> do
954− let parens' =
812+ ListPat NoExt pats -> do
813+ brackets . sitcc $ sep (comma >> breakpoint) (located' p_pat) pats
814+ TuplePat NoExt pats boxing -> do
815+ let f =
955816 case boxing of
956− Boxed -> parens S
957− Unboxed -> parensHash S
958− parens' $ sep commaDel (sitcc . located' p_pat) pats
959− SumPat NoExtField pat tag arity ->
960− p_unboxedSum S tag arity (located pat p_pat)
817+ Boxed -> parens
818+ Unboxed -> parensHash
819+ f . sitcc $ sep (comma >> breakpoint) (sitcc . located' p_pat) pats
820+ SumPat NoExt pat tag arity ->
821+ p_unboxedSum tag arity (located pat p_pat)
961822 ConPatIn pat details ->
962823 case details of
963824 PrefixCon xs -> sitcc $ do
@@ -971,40 +832,37 @@ p_pat = \case
971832 let f = \case
972833 Nothing -> txt ".."
973834 Just x -> located x p_pat_hsRecField
974− inci . braces N . sep commaDel f $
975− case dotdot of
976− Nothing -> Just <$> fields
977− Just (L _ n) -> (Just <$> take n fields) ++ [Nothing]
978− InfixCon l r -> do
979− switchLayout [getLoc l, getLoc r] $ do
980− located l p_pat
981− breakpoint
982− inci $ do
983− p_rdrName pat
984− space
985− located r p_pat
835+ inci . braces . sitcc . sep (comma >> breakpoint) f $ case dotdot of
836+ Nothing -> Just <$> fields
837+ Just n -> (Just <$> take n fields) ++ [Nothing]
838+ InfixCon x y -> do
839+ located x p_pat
840+ space
841+ p_rdrName pat
842+ breakpoint
843+ inci (located y p_pat)
986844 ConPatOut {} -> notImplemented "ConPatOut" -- presumably created by renamer?
987− ViewPat NoExtField expr pat -> sitcc $ do
845+ ViewPat NoExt expr pat -> sitcc $ do
988846 located expr p_hsExpr
989847 space
990848 txt "->"
991849 breakpoint
992850 inci (located pat p_pat)
993− SplicePat NoExtField splice -> p_hsSplice splice
994− LitPat NoExtField p -> atom p
995− NPat NoExtField v _ _ -> located v (atom . ol_val)
996− NPlusKPat NoExtField n k _ _ _ -> sitcc $ do
851+ SplicePat NoExt splice -> p_hsSplice splice
852+ LitPat NoExt p -> atom p
853+ NPat NoExt v _ _ -> located v (atom . ol_val)
854+ NPlusKPat NoExt n k _ _ _ -> sitcc $ do
997855 p_rdrName n
998856 breakpoint
999857 inci $ do
1000858 txt "+"
1001859 space
1002860 located k (atom . ol_val)
1003− SigPat NoExtField pat hswc -> do
861+ SigPat hswc pat -> do
1004862 located pat p_pat
1005863 p_typeAscription hswc
1006864 CoPat {} -> notImplemented "CoPat" -- apparently created at some later stage
1007− XPat x -> noExtCon x
865+ XPat NoExt -> notImplemented "XPat"
1008866
1009867p_pat_hsRecField :: HsRecField' (FieldOcc GhcPs) (LPat GhcPs) -> R ()
1010868p_pat_hsRecField HsRecField {..} = do
@@ -1012,53 +870,51 @@ p_pat_hsRecField HsRecField {..} = do
1012870 p_rdrName (rdrNameFieldOcc x)
1013871 unless hsRecPun $ do
1014872 space
1015− equals
873+ txt "="
1016874 breakpoint
1017875 inci (located hsRecFieldArg p_pat)
1018876
1019−p_unboxedSum :: BracketStyle -> ConTag -> Arity -> R () -> R ()
1020−p_unboxedSum s tag arity m = do
877+p_unboxedSum :: ConTag -> Arity -> R () -> R ()
878+p_unboxedSum tag arity m = do
1021879 let before = tag - 1
1022880 after = arity - before - 1
1023881 args = replicate before Nothing <> [Just m] <> replicate after Nothing
1024− f x =
882+ f (x,i) = do
883+ let isFirst = i == 0
884+ isLast = i == arity - 1
1025885 case x :: Maybe (R ()) of
1026886 Nothing ->
1027− space
887+ unless (isFirst || isLast) space
1028888 Just m' -> do
1029− space
889+ unless isFirst space
1030890 m'
1031− space
1032− parensHash s $ sep (txt "|") f args
891+ unless isLast space
892+ parensHash $ sep (txt "|") f (zip args [0..])
1033893
1034894p_hsSplice :: HsSplice GhcPs -> R ()
1035895p_hsSplice = \case
1036− HsTypedSplice NoExtField deco _ expr -> p_hsSpliceTH True expr deco
1037− HsUntypedSplice NoExtField deco _ expr -> p_hsSpliceTH False expr deco
1038− HsQuasiQuote NoExtField _ quoterName srcSpan str -> do
896+ HsTypedSplice NoExt deco _ expr -> p_hsSpliceTH True expr deco
897+ HsUntypedSplice NoExt deco _ expr -> p_hsSpliceTH False expr deco
898+ HsQuasiQuote NoExt _ quoterName srcSpan str -> do
1039899 txt "["
1040900 p_rdrName (L srcSpan quoterName)
1041901 txt "|"
1042− -- QuasiQuoters often rely on precise custom strings. We cannot do any
1043− -- formatting here without potentially breaking someone's code.
902+ -- NOTE QuasiQuoters often rely on precise custom strings. We cannot do
903+ -- any formatting here without potentially breaking someone's code.
1044904 atom str
1045905 txt "|]"
1046906 HsSpliced {} -> notImplemented "HsSpliced"
1047− HsSplicedT {} -> notImplemented "HsSplicedT"
1048− XSplice x -> noExtCon x
907+ XSplice {} -> notImplemented "XSplice"
1049908
1050−p_hsSpliceTH ::
1051− -- | Typed splice?
1052− Bool ->
1053− -- | Splice expression
1054− LHsExpr GhcPs ->
1055− -- | Splice decoration
1056− SpliceDecoration ->
1057− R ()
909+p_hsSpliceTH
910+ :: Bool -- ^ Typed splice?
911+ -> LHsExpr GhcPs -- ^ Splice expression
912+ -> SpliceDecoration -- ^ Splice decoration
913+ -> R ()
1058914p_hsSpliceTH isTyped expr = \case
1059915 HasParens -> do
1060916 txt decoSymbol
1061− parens N (located expr (sitcc . p_hsExpr))
917+ parens (located expr (sitcc . p_hsExpr))
1062918 HasDollar -> do
1063919 txt decoSymbol
1064920 located expr (sitcc . p_hsExpr)
@@ -1069,17 +925,17 @@ p_hsSpliceTH isTyped expr = \case
1069925
1070926p_hsBracket :: HsBracket GhcPs -> R ()
1071927p_hsBracket = \case
1072− ExpBr NoExtField expr -> do
928+ ExpBr NoExt expr -> do
1073929 anns <- getEnclosingAnns
1074930 let name = case anns of
1075− AnnOpenEQ : _ -> ""
931+ AnnOpenEQ:_ -> ""
1076932 _ -> "e"
1077933 quote name (located expr p_hsExpr)
1078− PatBr NoExtField pat -> located pat (quote "p" . p_pat)
1079− DecBrL NoExtField decls -> quote "d" (p_hsDecls Free decls)
1080− DecBrG NoExtField _ -> notImplemented "DecBrG" -- result of renamer
1081− TypBr NoExtField ty -> quote "t" (located ty p_hsType)
1082− VarBr NoExtField isSingleQuote name -> do
934+ PatBr NoExt pat -> quote "p" (located pat p_pat)
935+ DecBrL NoExt decls -> quote "d" (p_hsDecls Free decls)
936+ DecBrG NoExt _ -> notImplemented "DecBrG" -- result of renamer
937+ TypBr NoExt ty -> quote "t" (located ty p_hsType)
938+ VarBr NoExt isSingleQuote name -> do
1083939 txt (bool "''" "'" isSingleQuote)
1084940 -- HACK As you can see we use 'noLoc' here to be able to pass name into
1085941 -- 'p_rdrName' since the latter expects a "located" thing. The problem
@@ -1087,20 +943,19 @@ p_hsBracket = \case
1087943 -- turn makes it impossible to detect if there are parentheses around
1088944 -- it, etc. So we have to add parentheses manually assuming they are
1089945 -- necessary for all operators.
1090− let isOperator =
1091− all
1092− (\i -> isPunctuation i || isSymbol i)
1093− (showOutputable (rdrNameOcc name))
1094− && not (doesNotNeedExtraParens name)
1095− wrapper = if isOperator then parens N else id
946+ let isOperator = all
947+ (\i -> isPunctuation i || isSymbol i)
948+ (showOutputable (rdrNameOcc name))
949+ && not (doesNotNeedExtraParens name)
950+ wrapper = if isOperator then parens else id
1096951 wrapper $ p_rdrName (noLoc name)
1097− TExpBr NoExtField expr -> do
952+ TExpBr NoExt expr -> do
1098953 txt "[||"
1099954 breakpoint'
1100955 located expr p_hsExpr
1101956 breakpoint'
1102957 txt "||]"
1103− XBracket x -> noExtCon x
958+ XBracket {} -> notImplemented "XBracket"
1104959 where
1105960 quote :: Text -> R () -> R ()
1106961 quote name body = do
@@ -1124,54 +979,50 @@ p_stringLit src =
1124979 multiLine =
1125980 sitcc $ sep breakpoint (txt . Text.pack) (backslashes s)
1126981 in vlayout singleLine multiLine
1127− where
1128− -- Split a string on gaps (backslash delimited whitespaces)
1129− --
1130− -- > splitGaps "bar\\ \\fo\\&o" == ["bar", "fo\\&o"]
1131− splitGaps :: String -> [String]
1132− splitGaps "" = []
1133− splitGaps s =
1134− let -- A backslash and a whitespace starts a "gap"
1135− p (Just '\\', _, _) = True
1136− p (_, '\\', Just c) | ghcSpace c = False
1137− p _ = True
1138− in case span p (zipPrevNext s) of
1139− (l, r) ->
1140− let -- drop the initial '\', any amount of 'ghcSpace', and another '\'
982+ where
983+ -- Split a string on gaps (backslash delimited whitespaces)
984+ --
985+ -- > splitGaps "bar\\ \\fo\\&o" == ["bar", "fo\\&o"]
986+ splitGaps :: String -> [String]
987+ splitGaps "" = []
988+ splitGaps s =
989+ let -- A backslash and a whitespace starts a "gap"
990+ p (Just '\\', _, _) = True
991+ p (_, '\\', Just c) | ghcSpace c = False
992+ p _ = True
993+ in case span p (zipPrevNext s) of
994+ (l, r) ->
995+ let -- drop the initial '\', any amount of 'ghcSpace', and another '\'
1141996 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
1148− --
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)]
1155− zipPrevNext xs =
1156− let z =
1157− zip
1158− (zip (Nothing : map Just xs) xs)
1159− (map Just (tail xs) ++ repeat Nothing)
1160− in map (\((p, x), n) -> (p, x, n)) z
1161− orig (_, x, _) = x
997+ in map orig l : splitGaps r'
998+
999+ -- GHC's definition of whitespaces in strings
1000+ -- See: https://gitlab.haskell.org/ghc/ghc/blob/86753475/compiler/parser/Lexer.x#L1653
1001+ ghcSpace :: Char -> Bool
1002+ ghcSpace c = c <= '\x7f' && is_space c
1003+
1004+ -- Add backslashes to the inner side of the strings
1005+ --
1006+ -- > backslashes ["a", "b", "c"] == ["a\\", "\\b\\", "\\c"]
1007+ backslashes :: [String] -> [String]
1008+ backslashes (x:y:xs) = (x ++ "\\") : backslashes (('\\' : y) : xs)
1009+ backslashes xs = xs
1010+
1011+ -- Attaches previous and next items to each list element
1012+ zipPrevNext :: [a] -> [(Maybe a, a, Maybe a)]
1013+ zipPrevNext xs =
1014+ let z = zip (zip (Nothing : map Just xs) xs)
1015+ (map Just (tail xs) ++ repeat Nothing)
1016+ in map (\((p, x), n) -> (p, x, n)) z
1017+
1018+ orig (_, x, _) = x
11621019
11631020----------------------------------------------------------------------------
11641021-- Helpers
11651022
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
1171− MultiLine -> id
1172−
11731023-- | Append each element in both lists with semigroups. If one list is shorter
11741024-- than the other, return the rest of the longer list unchanged.
1025+
11751026liftAppend :: Semigroup a => [a] -> [a] -> [a]
11761027liftAppend [] [] = []
11771028liftAppend [] (y : ys) = y : ys
@@ -1179,13 +1030,14 @@ liftAppend (x : xs) [] = x : xs
11791030liftAppend (x : xs) (y : ys) = x <> y : liftAppend xs ys
11801031
11811032getGRHSSpan :: GRHS GhcPs (Located body) -> SrcSpan
1182−getGRHSSpan (GRHS NoExtField guards body) =
1033+getGRHSSpan (GRHS NoExt guards body) =
11831034 combineSrcSpans' $ getLoc body :| map getLoc guards
1184−getGRHSSpan (XGRHS x) = noExtCon x
1035+getGRHSSpan (XGRHS NoExt) = notImplemented "XGRHS"
11851036
11861037-- | Place a thing that may have a hanging form. This function handles how
11871038-- to separate it from preceding expressions and whether to bump indentation
11881039-- depending on what sort of expression we have.
1040+
11891041placeHanging :: Placement -> R () -> R ()
11901042placeHanging placement m =
11911043 case placement of
@@ -1198,165 +1050,100 @@ placeHanging placement m =
11981050
11991051-- | Check if given block contains single expression which has a hanging
12001052-- form.
1201−blockPlacement ::
1202− (body -> Placement) ->
1203− [LGRHS GhcPs (Located body)] ->
1204− Placement
1205−blockPlacement placer [L _ (GRHS NoExtField _ (L _ x))] = placer x
1053+
1054+blockPlacement
1055+ :: (body -> Placement)
1056+ -> [LGRHS GhcPs (Located body)]
1057+ -> Placement
1058+blockPlacement placer [(L _ (GRHS NoExt _ (L _ x)))] = placer x
12061059blockPlacement _ _ = Normal
12071060
12081061-- | Check if given command has a hanging form.
1062+
12091063cmdPlacement :: HsCmd GhcPs -> Placement
12101064cmdPlacement = \case
1211− HsCmdLam NoExtField _ -> Hanging
1212− HsCmdCase NoExtField _ _ -> Hanging
1213− HsCmdDo NoExtField _ -> Hanging
1065+ HsCmdLam NoExt _ -> Hanging
1066+ HsCmdCase NoExt _ _ -> Hanging
1067+ HsCmdDo NoExt _ -> Hanging
12141068 _ -> Normal
12151069
12161070cmdTopPlacement :: HsCmdTop GhcPs -> Placement
12171071cmdTopPlacement = \case
1218− HsCmdTop NoExtField (L _ x) -> cmdPlacement x
1219− XCmdTop x -> noExtCon x
1072+ HsCmdTop NoExt (L _ x) -> cmdPlacement x
1073+ XCmdTop {} -> notImplemented "XCmdTop"
12201074
12211075-- | Check if given expression has a hanging form.
1076+
12221077exprPlacement :: HsExpr GhcPs -> Placement
12231078exprPlacement = \case
12241079 -- Only hang lambdas with single line parameter lists
1225− HsLam NoExtField mg -> case mg of
1226− MG _ (L _ [L _ (Match NoExtField _ (x : xs) _)]) _
1227− | isOneLineSpan (combineSrcSpans' $ fmap getLoc (x :| xs)) ->
1228− Hanging
1080+ HsLam NoExt mg -> case mg of
1081+ MG _ (L _ [L _ (Match NoExt _ (x:xs) _)]) _
1082+ | isOneLineSpan (combineSrcSpans' $ fmap getLoc (x :| xs))
1083+ -> Hanging
12291084 _ -> Normal
1230− HsLamCase NoExtField _ -> Hanging
1231− HsCase NoExtField _ _ -> Hanging
1232− HsDo NoExtField DoExpr _ -> Hanging
1233− HsDo NoExtField MDoExpr _ -> Hanging
1234− OpApp NoExtField _ op y ->
1235− case (fmap getOpNameStr . getOpName . unLoc) op of
1236− Just "$" -> exprPlacement (unLoc y)
1237− _ -> Normal
1238− HsApp NoExtField _ y -> exprPlacement (unLoc y)
1239− HsProc NoExtField p _ ->
1085+ HsLamCase NoExt _ -> Hanging
1086+ HsCase NoExt _ _ -> Hanging
1087+ HsDo NoExt DoExpr _ -> Hanging
1088+ HsDo NoExt MDoExpr _ -> Hanging
1089+ RecordCon NoExt _ _ -> Hanging
1090+ -- If the rightmost expression in an operator chain is hanging, make the
1091+ -- whole block hanging; so that we can use the common @f = foo $ do@
1092+ -- style.
1093+ OpApp NoExt _ _ y -> exprPlacement (unLoc y)
1094+ HsProc NoExt (L s _) _ ->
12401095 -- Indentation breaks if pattern is longer than one line and left
12411096 -- hanging. Consequently, only apply hanging when it is safe.
1242− if isOneLineSpan (getLoc p)
1243− then Hanging
1244− else Normal
1097+ if isOneLineSpan s
1098+ then Hanging
1099+ else Normal
12451100 _ -> Normal
12461101
12471102withGuards :: [LGRHS GhcPs (Located body)] -> Bool
12481103withGuards = any (checkOne . unLoc)
12491104 where
12501105 checkOne :: GRHS GhcPs (Located body) -> Bool
1251− checkOne (GRHS NoExtField [] _) = False
1106+ checkOne (GRHS NoExt [] _) = False
12521107 checkOne _ = True
12531108
12541109exprOpTree :: LHsExpr GhcPs -> OpTree (LHsExpr GhcPs) (LHsExpr GhcPs)
1255−exprOpTree (L _ (OpApp NoExtField x op y)) = OpBranch (exprOpTree x) op (exprOpTree y)
1110+exprOpTree (L _ (OpApp NoExt x op y)) = OpBranch (exprOpTree x) op (exprOpTree y)
12561111exprOpTree n = OpNode n
12571112
1258−getOpName :: HsExpr GhcPs -> Maybe RdrName
1259−getOpName = \case
1260− HsVar NoExtField (L _ a) -> Just a
1261− _ -> Nothing
1262−
1263−getOpNameStr :: RdrName -> String
1264−getOpNameStr = occNameString . rdrNameOcc
1265−
1266−p_exprOpTree ::
1267− -- | Bracket style to use
1268− BracketStyle ->
1269− OpTree (LHsExpr GhcPs) (LHsExpr GhcPs) ->
1270− R ()
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
1275− -- placement.
1113+p_exprOpTree :: OpTree (LHsExpr GhcPs) (LHsExpr GhcPs) -> R ()
1114+p_exprOpTree (OpNode x) = located x p_hsExpr
1115+p_exprOpTree (OpBranch x op y) = do
1116+ -- NOTE If the beginning of the first argument and the second argument
1117+ -- are on the same line, and the second argument has a hanging form, use
1118+ -- hanging placement.
12761119 let placement =
12771120 if isOneLineSpan
1278− (mkSrcSpan (srcSpanStart (opTreeLoc x)) (srcSpanStart (opTreeLoc y)))
1121+ (mkSrcSpan (srcSpanStart (opTreeLoc x)) (srcSpanStart (opTreeLoc y)))
12791122 then case y of
1280− OpNode (L _ n) -> exprPlacement n
1281− _ -> Normal
1123+ OpNode (L _ n) -> exprPlacement n
1124+ _ -> Normal
12821125 else Normal
1283− -- Distinguish holes used in infix notation.
1284− -- eg. '1 _foo 2' and '1 `_foo` 2'
12851126 opWrapper = case unLoc op of
1286− HsUnboundVar NoExtField _ -> backticks
1127+ EWildPat NoExt -> backticks
12871128 _ -> id
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)
1298− lhs =
1299− switchLayout [opTreeLoc x] $
1300− p_exprOpTree s 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
1306− _ -> False
1307− isDoBlock = \case
1308− OpNode (L _ HsDo {}) -> True
1309− _ -> False
1310− useRecordDot' <- useRecordDot
1311− if
1312− | gotColon -> do
1313− lhs
1314− space
1315− p_op
1316− case placement of
1317− Hanging -> do
1318− space
1319− p_y
1320− Normal -> do
1321− breakpoint
1322− inciIf (isDoBlock y) p_y
1323− | gotDollar
1324− && isOneLineSpan (opTreeLoc x)
1325− && placement == Normal -> do
1326− useBraces lhs
1327− space
1328− p_op
1329− breakpoint
1330− inci p_y
1331− | useRecordDot' && gotRecordDot -> do
1332− lhs
1333− when isSection space
1334− p_op
1335− p_y
1336− | otherwise -> do
1337− ub lhs
1338− placeHanging placement $ do
1339− p_op
1340− space
1341− p_y
1342−
1343−-- | Return 'True' if given expression is a record-dot operator expression.
1344−isRecordDot ::
1345− -- | Operator expression
1346− HsExpr GhcPs ->
1347− -- | Span of the expression on the right-hand side of the operator
1348− SrcSpan ->
1349− Bool
1350−isRecordDot op (RealSrcSpan ySpan) = case op of
1351− HsVar NoExtField (L (RealSrcSpan opSpan) opName) ->
1352− (getOpNameStr opName == ".") && (srcSpanEndCol opSpan == srcSpanStartCol ySpan)
1353− _ -> False
1354−isRecordDot _ _ = False
1129+ ub <- vlayout
1130+ (return useBraces)
1131+ (return $ case placement of
1132+ Hanging -> useBraces
1133+ Normal -> dontUseBraces)
1134+ switchLayout [opTreeLoc x] $
1135+ ub $ p_exprOpTree x
1136+ placeHanging placement $ do
1137+ located op (opWrapper . p_hsExpr)
1138+ space
1139+ switchLayout [opTreeLoc y] $
1140+ p_exprOpTree y
13551141
13561142-- | Get annotations for the enclosing element.
1143+
13571144getEnclosingAnns :: R [AnnKeywordId]
13581145getEnclosingAnns = do
13591146 e <- getEnclosingSpan (const True)
13601147 case e of
13611148 Nothing -> return []
1362− Just e' -> getAnns (RealSrcSpan e')
1149+ Just e' -> getAnns (RealSrcSpan e')