@@ -1,43 +1,38 @@
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
1310 )
1411where
1512
1613import Bag (bagToList)
1714import BasicTypes
1815import Control.Monad
19−import Ctype (is_space)
2016import Data.Bool (bool)
2117import Data.Char (isPunctuation, isSymbol)
2218import Data.Data hiding (Infix, Prefix)
23−import Data.Functor ((<&>))
2419import Data.List (intersperse, sortOn)
25−import Data.List.NonEmpty (NonEmpty (..), (<|))
26−import qualified Data.List.NonEmpty as NE
20+import Data.List.NonEmpty (NonEmpty ((:|)))
2721import Data.Text (Text)
28−import qualified Data.Text as Text
2922import GHC
30−import OccName (occNameString)
3123import Ormolu.Printer.Combinators
32−import Ormolu.Printer.Internal
3324import Ormolu.Printer.Meat.Common
34−import {-# SOURCE #-} Ormolu.Printer.Meat.Declaration
3525import Ormolu.Printer.Meat.Declaration.Signature
3626import Ormolu.Printer.Meat.Type
37−import Ormolu.Printer.Operators
3827import 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
3933
4034-- | Style of a group of equations.
35+
4136data MatchGroupStyle
4237 = Function (Located RdrName)
4338 | PatternBind
@@ -46,61 +41,56 @@ data MatchGroupStyle
4641 | LambdaCase
4742
4843-- | Style of equations in a group.
44+
4945data GroupStyle
5046 = EqualSign
5147 | RightArrow
5248
5349-- | Expression placement. This marks the places where expressions that
5450-- implement handing forms may use them.
51+
5552data 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)
53+ = Normal -- ^ Multi-line layout should cause
54+ -- insertion of a newline and indentation
55+ -- bump
56+ | Hanging -- ^ Expressions that have hanging form
57+ -- should use it and avoid bumping one level
58+ -- of indentation
6559
6660p_valDecl :: HsBindLR GhcPs GhcPs -> R ()
6761p_valDecl = \case
68− FunBind NoExtField funId funMatches _ _ -> p_funBind funId funMatches
69− PatBind NoExtField pat grhss _ -> p_match PatternBind False NoSrcStrict [pat] grhss
62+ FunBind NoExt funId funMatches _ _ -> p_funBind funId funMatches
63+ PatBind NoExt pat grhss _ -> p_match PatternBind False NoSrcStrict [pat] grhss
7064 VarBind {} -> notImplemented "VarBinds" -- introduced by the type checker
7165 AbsBinds {} -> notImplemented "AbsBinds" -- introduced by the type checker
72− PatSynBind NoExtField psb -> p_patSynBind psb
73− XHsBindsLR x -> noExtCon x
66+ PatSynBind NoExt psb -> p_patSynBind psb
67+ XHsBindsLR NoExt -> notImplemented "XHsBindsLR"
7468
75−p_funBind ::
76− Located RdrName ->
77− MatchGroup GhcPs (LHsExpr GhcPs) ->
78− R ()
69+p_funBind
70+ :: Located RdrName
71+ -> MatchGroup GhcPs (LHsExpr GhcPs)
72+ -> R ()
7973p_funBind name = p_matchGroup (Function name)
8074
81−p_matchGroup ::
82− MatchGroupStyle ->
83− MatchGroup GhcPs (LHsExpr GhcPs) ->
84− R ()
75+p_matchGroup
76+ :: MatchGroupStyle
77+ -> MatchGroup GhcPs (LHsExpr GhcPs)
78+ -> R ()
8579p_matchGroup = p_matchGroup' exprPlacement p_hsExpr
8680
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
81+p_matchGroup'
82+ :: Data body
83+ => (body -> Placement) -- ^ How to get body placement
84+ -> (body -> R ()) -- ^ How to print body
85+ -> MatchGroupStyle -- ^ Style of this group of equations
86+ -> MatchGroup GhcPs (Located body) -- ^ Match group
87+ -> R ()
88+p_matchGroup' placer pretty style MG {..} = do
9989 let ob = case style of
10090 Case -> id
10191 LambdaCase -> id
10292 _ -> 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
10494 -- restore the brace state inside the sepsemi.
10595 ub <- bool dontUseBraces useBraces <$> canUseBraces
10696 ob $ sepSemi (located' (ub . p_Match)) (unLoc mg_alts)
@@ -108,14 +98,14 @@ p_matchGroup' placer render style MG {..} = do
10898 p_Match m@Match {..} =
10999 p_match'
110100 placer
111− render
101+ pretty
112102 (adjustMatchGroupStyle m style)
113103 (isInfixMatch m)
114104 (matchStrictness m)
115105 m_pats
116106 m_grhss
117− p_Match (XMatch x) = noExtCon x
118−p_matchGroup' _ _ _ (XMatchGroup x) = noExtCon x
107+ p_Match _ = notImplemented "XMatch"
108+p_matchGroup' _ _ _ (XMatchGroup NoExt) = notImplemented "XMatchGroup"
119109
120110-- | Function id obtained through pattern matching on 'FunBind' should not
121111-- be used to print the actual equations because the different ‘RdrNames’
@@ -123,10 +113,11 @@ p_matchGroup' _ _ _ (XMatchGroup x) = noExtCon x
123113-- and paretheses) associated with them. It is necessary to use per-equation
124114-- names obtained from 'm_ctxt' of 'Match'. This function replaces function
125115-- name inside of 'Function' accordingly.
126−adjustMatchGroupStyle ::
127− Match GhcPs body ->
128− MatchGroupStyle ->
129− MatchGroupStyle
116+
117+adjustMatchGroupStyle
118+ :: Match GhcPs body
119+ -> MatchGroupStyle
120+ -> MatchGroupStyle
130121adjustMatchGroupStyle m = \case
131122 Function _ -> (Function . mc_fun . m_ctxt) m
132123 style -> style
@@ -134,43 +125,31 @@ adjustMatchGroupStyle m = \case
134125matchStrictness :: Match id body -> SrcStrictness
135126matchStrictness match =
136127 case m_ctxt match of
137− FunRhs {mc_strictness = s} -> s
128+ FunRhs{mc_strictness=s} -> s
138129 _ -> NoSrcStrict
139130
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 ()
131+p_match
132+ :: MatchGroupStyle -- ^ Style of the group
133+ -> Bool -- ^ Is this an infix match?
134+ -> SrcStrictness -- ^ Strictness prefix (FunBind)
135+ -> [LPat GhcPs] -- ^ Argument patterns
136+ -> GRHSs GhcPs (LHsExpr GhcPs) -- ^ Equations
137+ -> R ()
152138p_match = p_match' exprPlacement p_hsExpr
153139
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
140+p_match'
141+ :: Data body
142+ => (body -> Placement) -- ^ How to get body placement
143+ -> (body -> R ()) -- ^ How to print body
144+ -> MatchGroupStyle -- ^ Style of this group of equations
145+ -> Bool -- ^ Is this an infix match?
146+ -> SrcStrictness -- ^ Strictness prefix (FunBind)
147+ -> [LPat GhcPs] -- ^ Argument patterns
148+ -> GRHSs GhcPs (Located body) -- ^ Equations
149+ -> R ()
150+p_match' placer pretty style isInfix strictness m_pats m_grhss = do
151+ -- NOTE Normally, since patterns may be placed in a multi-line layout, it
152+ -- is necessary to bump indentation for the pattern group so it's more
174153 -- indented than function name. This in turn means that indentation for
175154 -- the body should also be bumped. Normally this would mean that bodies
176155 -- 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
180159 NoSrcStrict -> return ()
181160 SrcStrict -> txt "!"
182161 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 ()
162+ inci' <- case NE.nonEmpty m_pats of
163+ Nothing -> id <$ case style of
164+ Function name -> p_rdrName name
165+ _ -> return ()
188166 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)
167+ let combinedSpans = combineSrcSpans' $
168+ getLoc <$> ne_pats
169+ inci' = if isOneLineSpan combinedSpans
170+ then id
171+ else inci
194172 switchLayout [combinedSpans] $ do
195173 let stdCase = sep breakpoint (located' p_pat) m_pats
196174 case style of
197175 Function name ->
198176 p_infixDefHelper
199177 isInfix
200− indentBody
178+ inci'
201179 (p_rdrName name)
202180 (located' p_pat <$> m_pats)
203181 PatternBind -> stdCase
@@ -212,40 +190,46 @@ p_match' placer render style isInfix strictness m_pats GRHSs {..} = do
212190 when needsSpace space
213191 sitcc stdCase
214192 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
193+ return inci'
194+ let
195+ -- Calculate position of end of patterns. This is useful when we decide
196+ -- about putting certain constructions in hanging positions.
197+ endOfPats = case NE.nonEmpty m_pats of
198+ Nothing -> case style of
199+ Function name -> (Just . srcSpanEnd . getLoc) name
200+ _ -> Nothing
201+ Just pats -> (Just . srcSpanEnd . getLoc . NE.last) pats
202+ isCase = \case
203+ Case -> True
204+ LambdaCase -> True
205+ _ -> False
206+ let GRHSs {..} = m_grhss
227207 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
208+ unless (length grhssGRHSs > 1) $ do
209+ case style of
210+ Function _ | hasGuards -> return ()
211+ Function _ -> space >> txt "="
212+ PatternBind -> space >> txt "="
213+ s | isCase s && hasGuards -> return ()
214+ _ -> space >> txt "->"
215+ let grhssSpan = combineSrcSpans' $
216+ getGRHSSpan . unLoc <$> NE.fromList grhssGRHSs
217+ patGrhssSpan = maybe grhssSpan
218+ (combineSrcSpans grhssSpan . srcLocSpan) endOfPats
236219 placement =
237220 case endOfPats of
238221 Nothing -> blockPlacement placer grhssGRHSs
239222 Just spn ->
240− if onTheSameLine spn grhssSpan
223+ if isOneLineSpan
224+ (mkSrcSpan spn (srcSpanStart grhssSpan))
241225 then blockPlacement placer grhssGRHSs
242226 else Normal
243227 p_body = do
244228 let groupStyle =
245229 if isCase style && hasGuards
246− then RightArrow
247− else EqualSign
248− sep newline (located' (p_grhs' placer render groupStyle)) grhssGRHSs
230+ then RightArrow
231+ else EqualSign
232+ sep newline (located' (p_grhs' pretty groupStyle)) grhssGRHSs
249233 p_where = do
250234 let whereIsEmpty = GHC.isEmptyLocalBindsPR (unLoc grhssLocalBinds)
251235 unless (GHC.eqEmptyLocalBinds (unLoc grhssLocalBinds)) $ do
@@ -253,211 +237,175 @@ p_match' placer render style isInfix strictness m_pats GRHSs {..} = do
253237 txt "where"
254238 unless whereIsEmpty breakpoint
255239 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 "->"
240+ inci' $ do
264241 switchLayout [patGrhssSpan] $
265242 placeHanging placement p_body
266243 inci p_where
267−p_match' _ _ _ _ _ _ (XGRHSs x) = noExtCon x
268244
269245p_grhs :: GroupStyle -> GRHS GhcPs (LHsExpr GhcPs) -> R ()
270−p_grhs = p_grhs' exprPlacement p_hsExpr
246+p_grhs = p_grhs' p_hsExpr
271247
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) =
248+p_grhs'
249+ :: Data body
250+ => (body -> R ())
251+ -> GroupStyle
252+ -> GRHS GhcPs (Located body)
253+ -> R ()
254+p_grhs' pretty style (GRHS NoExt guards body) =
282255 case guards of
283256 [] -> p_body
284257 xs -> do
285258 txt "|"
286259 space
287− sitcc (sep commaDel (sitcc . located' p_stmt) xs)
260+ sitcc (sep (comma >> breakpoint) (sitcc . located' p_stmt) xs)
288261 space
289− inci $ case style of
290− EqualSign -> equals
291− RightArrow -> txt "->"
292− placeHanging placement p_body
262+ txt $ case style of
263+ EqualSign -> "="
264+ RightArrow -> "->"
265+ breakpoint
266+ inci p_body
293267 where
294− placement =
295− case endOfGuards of
296− Nothing -> placer (unLoc body)
297− Just spn ->
298− if onTheSameLine spn (getLoc body)
299− then placer (unLoc body)
300− else Normal
301− endOfGuards =
302− case NE.nonEmpty guards of
303− Nothing -> Nothing
304− Just gs -> (Just . getLoc . NE.last) gs
305− p_body = located body render
306−p_grhs' _ _ _ (XGRHS x) = noExtCon x
268+ p_body = located body pretty
269+p_grhs' _ _ (XGRHS NoExt) = notImplemented "XGRHS"
307270
308271p_hsCmd :: HsCmd GhcPs -> R ()
309272p_hsCmd = \case
310− HsCmdArrApp NoExtField body input arrType _ -> do
273+ HsCmdArrApp NoExt body input arrType _ -> do
311274 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
275+ space
276+ case arrType of
277+ HsFirstOrderApp -> txt "-<"
278+ HsHigherOrderApp -> txt "-<<"
279+ placeHanging (exprPlacement (unLoc input)) $
280+ located input p_hsExpr
281+ HsCmdArrForm NoExt form Prefix _ cmds -> banana $ sitcc $ do
320282 located form p_hsExpr
321283 unless (null cmds) $ do
322284 breakpoint
323285 inci (sequence_ (intersperse breakpoint (located' p_hsCmdTop <$> cmds)))
324− HsCmdArrForm NoExtField form Infix _ [left, right] -> do
286+ HsCmdArrForm NoExt form Infix _ [left, right] -> do
325287 located left p_hsCmdTop
326288 space
327289 located form p_hsExpr
328290 placeHanging (cmdTopPlacement (unLoc right)) $
329291 located right p_hsCmdTop
330− HsCmdArrForm NoExtField _ Infix _ _ -> notImplemented "HsCmdArrForm"
292+ HsCmdArrForm NoExt _ Infix _ _ -> notImplemented "HsCmdArrForm"
331293 HsCmdApp {} ->
332294 -- XXX Does this ever occur in the syntax tree? It does not seem like it
333295 -- does. Open an issue and ping @yumiova if this ever occurs in output.
334296 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
297+ HsCmdLam NoExt mgroup -> p_matchGroup' cmdPlacement p_hsCmd Lambda mgroup
298+ HsCmdPar NoExt c -> parens (located c p_hsCmd)
299+ HsCmdCase NoExt e mgroup -> do
300+ txt "case"
301+ space
302+ located e p_hsExpr
303+ space
304+ txt "of"
305+ breakpoint
306+ inci (p_matchGroup' cmdPlacement p_hsCmd Case mgroup)
307+ HsCmdIf NoExt _ if' then' else' -> do
308+ txt "if"
309+ space
310+ located if' p_hsExpr
311+ breakpoint
312+ txt "then"
313+ located then' $ \x -> do
314+ breakpoint
315+ inci (p_hsCmd x)
316+ breakpoint
317+ txt "else"
318+ located else' $ \x -> do
319+ breakpoint
320+ inci (p_hsCmd x)
321+ HsCmdLet NoExt localBinds c -> do
322+ txt "let"
323+ space
324+ sitcc (located localBinds p_hsLocalBinds)
325+ breakpoint
326+ txt "in"
327+ space
328+ sitcc (located c p_hsCmd)
329+ HsCmdDo NoExt es -> do
344330 txt "do"
345331 newline
346− inci . located es $
347− sitcc . sep newline (sitcc . withSpacing (p_stmt' cmdPlacement p_hsCmd))
332+ inci (located es (sitcc . sep newline (located' (sitcc . p_stmt' p_hsCmd))))
348333 HsCmdWrap {} -> notImplemented "HsCmdWrap"
349− XCmd x -> noExtCon x
334+ XCmd {} -> notImplemented "XCmd"
350335
351336p_hsCmdTop :: HsCmdTop GhcPs -> R ()
352337p_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)
338+ HsCmdTop NoExt cmd -> located cmd p_hsCmd
339+ XCmdTop {} -> notImplemented "XHsCmdTop"
384340
385341p_stmt :: Stmt GhcPs (LHsExpr GhcPs) -> R ()
386−p_stmt = p_stmt' exprPlacement p_hsExpr
342+p_stmt = p_stmt' p_hsExpr
387343
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
344+p_stmt'
345+ :: Data body
346+ => (body -> R ())
347+ -> Stmt GhcPs (Located body)
348+ -> R ()
349+p_stmt' pretty = \case
350+ LastStmt NoExt body _ _ -> located body pretty
351+ BindStmt NoExt l f _ _ -> do
352+ located l p_pat
401353 space
402354 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)
355+ breakpoint
356+ inci (located f pretty)
413357 ApplicativeStmt {} -> notImplemented "ApplicativeStmt" -- generated by renamer
414− BodyStmt NoExtField body _ _ -> located body render
415− LetStmt NoExtField binds -> do
358+ BodyStmt NoExt body _ _ -> located body pretty
359+ LetStmt NoExt binds -> do
416360 txt "let"
417361 space
418362 sitcc $ located binds p_hsLocalBinds
419363 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.
364+ -- NOTE 'ParStmt' should always be eliminated in 'gatherStmt' already,
365+ -- such that it never occurs in 'p_stmt''. Consequently, handling it
366+ -- here would be redundant.
423367 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'.
368+ TransStmt {..} -> do
369+ -- NOTE 'TransStmt' only needs to account for pretty printing itself,
370+ -- since pretty printing of relevant statements (e.g., in 'trS_stmts')
371+ -- is handled through 'gatherStmt'.
428372 case (trS_form, trS_by) of
429− (ThenForm, Nothing) -> do
373+ (ThenForm, Nothing) -> located trS_using $ \x -> do
430374 txt "then"
431375 breakpoint
432− inci $ located trS_using p_hsExpr
376+ inci (p_hsExpr x)
433377 (ThenForm, Just e) -> do
434− txt "then"
435− breakpoint
436− inci $ located trS_using p_hsExpr
437− breakpoint
438− txt "by"
378+ located trS_using $ \x -> do
379+ txt "then"
380+ breakpoint
381+ inci (p_hsExpr x)
439382 breakpoint
440− inci $ located e p_hsExpr
441− (GroupForm, Nothing) -> do
383+ located e $ \x -> do
384+ txt "by"
385+ breakpoint
386+ inci (p_hsExpr x)
387+ (GroupForm, Nothing) -> located trS_using $ \x -> do
442388 txt "then group using"
443389 breakpoint
444− inci $ located trS_using p_hsExpr
390+ inci (p_hsExpr x)
445391 (GroupForm, Just e) -> do
446− txt "then group by"
447− breakpoint
448− inci $ located e p_hsExpr
449− breakpoint
450− txt "using"
392+ located e $ \x -> do
393+ txt "then group by"
394+ breakpoint
395+ inci (p_hsExpr x)
451396 breakpoint
452− inci $ located trS_using p_hsExpr
397+ located trS_using $ \x -> do
398+ txt "using"
399+ breakpoint
400+ inci (p_hsExpr x)
453401 RecStmt {..} -> do
454402 txt "rec"
455403 space
456− sitcc $ sepSemi (withSpacing (p_stmt' placer render)) recS_stmts
457− XStmtLR c -> noExtCon c
404+ sitcc $ sepSemi (located' (p_stmt' pretty)) recS_stmts
405+ XStmtLR {} -> notImplemented "XStmtLR"
458406
459407gatherStmt :: ExprLStmt GhcPs -> [[ExprLStmt GhcPs]]
460−gatherStmt (L _ (ParStmt NoExtField block _ _)) =
408+gatherStmt (L _ (ParStmt NoExt block _ _)) =
461409 foldr ((<>) . gatherStmtBlock) [] block
462410gatherStmt (L s stmt@TransStmt {..}) =
463411 foldr liftAppend [] ((gatherStmt <$> trS_stmts) <> pure [[L s stmt]])
@@ -466,230 +414,195 @@ gatherStmt stmt = [[stmt]]
466414gatherStmtBlock :: ParStmtBlock GhcPs GhcPs -> [[ExprLStmt GhcPs]]
467415gatherStmtBlock (ParStmtBlock _ stmts _ _) =
468416 foldr (liftAppend . gatherStmt) [] stmts
469−gatherStmtBlock (XParStmtBlock x) = noExtCon x
417+gatherStmtBlock XParStmtBlock {} = notImplemented "XParStmtBlock"
470418
471419p_hsLocalBinds :: HsLocalBindsLR GhcPs GhcPs -> R ()
472420p_hsLocalBinds = \case
473− HsValBinds NoExtField (ValBinds NoExtField bag lsigs) -> do
474− -- When in a single-line layout, there is a chance that the inner
421+ HsValBinds NoExt (ValBinds NoExt bag lsigs) -> do
422+ let ssStart = either
423+ (srcSpanStart . getLoc)
424+ (srcSpanStart . getLoc)
425+ items =
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)]
431+ markInit [] = []
432+ markInit (x:[]) = [(False, x)]
433+ markInit (x:xs) = (True, x) : markInit xs
434+ -- NOTE When in a single-line layout, there is a chance that the inner
475435 -- elements will also contain semicolons and they will confuse the
476436 -- 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) ->
437+ br <- vlayout (return useBraces) (return id)
438+ sitcc $ sepSemi
439+ (\(m, i) -> (if m then br else id) $ p_item i)
440+ (markInit $ sortOn ssStart items)
441+ HsValBinds NoExt _ -> notImplemented "HsValBinds"
442+ HsIPBinds NoExt (IPBinds NoExt xs) ->
494443 -- 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
496445 atom name
497446 space
498− equals
447+ txt "="
499448 breakpoint
500449 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
450+ p_ipBind _ = notImplemented "XHsIPBinds"
505451 in sepSemi (located' p_ipBind) xs
506− HsIPBinds NoExtField _ -> notImplemented "HsIpBinds"
507− EmptyLocalBinds NoExtField -> return ()
508− XHsLocalBindsLR x -> noExtCon x
452+ HsIPBinds NoExt _ -> notImplemented "HsIpBinds"
453+ EmptyLocalBinds NoExt -> return ()
454+ XHsLocalBindsLR _ -> notImplemented "XHsLocalBindsLR"
509455
510−p_hsRecField ::
511− HsRecField' RdrName (LHsExpr GhcPs) ->
512− R ()
513−p_hsRecField HsRecField {..} = do
514− p_rdrName hsRecFieldLbl
456+p_hsRecField
457+ :: (Data id, Outputable id)
458+ => HsRecField' id (LHsExpr GhcPs)
459+ -> R ()
460+p_hsRecField = \HsRecField {..} -> do
461+ located hsRecFieldLbl atom
515462 unless hsRecPun $ do
516463 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)
464+ txt "="
465+ let placement = exprPlacement (unLoc hsRecFieldArg)
466+ placeHanging placement $ located hsRecFieldArg p_hsExpr
523467
524−p_hsExpr :: HsExpr GhcPs -> R ()
525−p_hsExpr = p_hsExpr' N
468+p_hsTupArg :: HsTupArg GhcPs -> R ()
469+p_hsTupArg = \case
470+ Present NoExt x -> located x p_hsExpr
471+ Missing NoExt -> pure ()
472+ XTupArg {} -> notImplemented "XTupArg"
526473
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 ->
474+p_hsExpr :: HsExpr GhcPs -> R ()
475+p_hsExpr = \case
476+ HsVar NoExt name -> p_rdrName name
477+ HsUnboundVar NoExt _ -> notImplemented "HsUnboundVar"
478+ HsConLikeOut NoExt _ -> notImplemented "HsConLikeOut"
479+ HsRecFld NoExt x ->
533480 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
481+ Unambiguous NoExt name -> p_rdrName name
482+ Ambiguous NoExt name -> p_rdrName name
483+ XAmbiguousFieldOcc NoExt -> notImplemented "XAmbiguousFieldOcc"
484+ HsOverLabel NoExt _ v -> do
538485 txt "#"
539486 atom v
540− HsIPVar NoExtField (HsIPName name) -> do
487+ HsIPVar NoExt (HsIPName name) -> do
541488 txt "?"
542489 atom name
543− HsOverLit NoExtField v -> atom (ol_val v)
544− HsLit NoExtField lit ->
545− case lit of
546− HsString (SourceText stxt) _ -> p_stringLit stxt
547− HsStringPrim (SourceText stxt) _ -> p_stringLit stxt
548− r -> atom r
549− HsLam NoExtField mgroup ->
490+ HsOverLit NoExt v -> atom (ol_val v)
491+ HsLit NoExt lit -> atom lit
492+ HsLam NoExt mgroup ->
550493 p_matchGroup Lambda mgroup
551− HsLamCase NoExtField mgroup -> do
494+ HsLamCase NoExt mgroup -> do
552495 txt "\\case"
553496 breakpoint
554497 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
498+ HsApp NoExt f x -> sitcc $ do
499+ located f p_hsExpr
500+ -- Second argument can be a `do` or `case` block with `-XBlockArguments`.
501+ placeHanging (exprPlacement (unLoc x)) $
502+ located x p_hsExpr
503+ HsAppType a e -> do
612504 located e p_hsExpr
613505 breakpoint
614506 inci $ do
615507 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 ()
621508 located (hswc_body a) p_hsType
622− OpApp NoExtField x op y -> do
623− let opTree = OpBranch (exprOpTree x) op (exprOpTree y)
624− p_exprOpTree s (reassociateOpTree getOpName opTree)
625− NegApp NoExtField e _ -> do
509+ OpApp NoExt x op y -> do
510+ -- NOTE If the beginning of the first argument and the second argument
511+ -- are on the same line, and the second argument has a hanging form, use
512+ -- hanging placement.
513+ let placement =
514+ if isOneLineSpan
515+ (mkSrcSpan (srcSpanStart (getLoc x)) (srcSpanStart (getLoc y)))
516+ then exprPlacement (unLoc y)
517+ else Normal
518+ opWrapper = case unLoc op of
519+ EWildPat NoExt -> backticks
520+ _ -> id
521+ ub <- vlayout
522+ (return useBraces)
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)
529+ space
530+ located y p_hsExpr
531+ NegApp NoExt e _ -> do
626532 txt "-"
627533 space
628534 located e p_hsExpr
629− HsPar NoExtField e ->
630− parens s (located e (dontUseBraces . p_hsExpr))
631− SectionL NoExtField x op -> do
535+ HsPar NoExt e -> parens (located e p_hsExpr)
536+ SectionL NoExt x op -> do
632537 located x p_hsExpr
633538 breakpoint
634539 inci (located op p_hsExpr)
635− SectionR NoExtField op x -> do
540+ SectionR NoExt op x -> do
636541 located op p_hsExpr
637− useRecordDot' <- useRecordDot
638− let isRecordDot' = isRecordDot (unLoc op) (getLoc x)
639− unless (useRecordDot' && isRecordDot') breakpoint
542+ breakpoint
640543 inci (located x p_hsExpr)
641− ExplicitTuple NoExtField args boxity ->
544+ ExplicitTuple NoExt args boxity -> do
642545 let isSection = any (isMissing . unLoc) args
643546 isMissing = \case
644− Missing NoExtField -> True
547+ Missing NoExt -> True
645548 _ -> 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' =
549+ let parens' =
652550 case boxity of
653551 Boxed -> parens
654552 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
553+ if isSection
554+ then switchLayout [] . parens' $
555+ sep comma (located' p_hsTupArg) args
556+ else switchLayout (getLoc <$> args) . parens' . sitcc $
557+ sep (comma >> breakpoint) (sitcc . located' p_hsTupArg) args
558+ ExplicitSum NoExt tag arity e ->
559+ p_unboxedSum tag arity (located e p_hsExpr)
560+ HsCase NoExt e mgroup -> do
561+ txt "case"
562+ space
563+ located e p_hsExpr
564+ space
565+ txt "of"
566+ breakpoint
567+ inci (p_matchGroup Case mgroup)
568+ HsIf NoExt _ if' then' else' -> do
669569 txt "if"
570+ space
571+ located if' p_hsExpr
670572 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
573+ inci $ do
574+ txt "then"
575+ located then' $ \x ->
576+ placeHanging (exprPlacement x) (p_hsExpr x)
577+ breakpoint
578+ txt "else"
579+ located else' $ \x ->
580+ placeHanging (exprPlacement x) (p_hsExpr x)
581+ HsMultiIf NoExt guards -> do
582+ txt "if"
583+ breakpoint
584+ inci . sitcc $ sep newline (located' (p_grhs RightArrow)) guards
585+ HsLet NoExt localBinds e -> sitcc $ do
586+ txt "let"
587+ space
588+ dontUseBraces $ sitcc (located localBinds p_hsLocalBinds)
589+ vlayout space (newline >> txt " ")
590+ txt "in"
591+ space
592+ sitcc (located e p_hsExpr)
593+ HsDo NoExt ctx es -> do
675594 let doBody header = do
676595 txt header
677596 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))
597+ ub <- vlayout (return useBraces) (return id)
598+ inci $ sepSemi (located' (ub . p_stmt)) (unLoc es)
599+ compBody = brackets $ located es $ \xs -> do
600+ let p_parBody = sep
601+ (breakpoint >> txt "| ")
602+ p_seqBody
603+ p_seqBody = sitcc . sep
604+ (comma >> breakpoint)
605+ (located' (sitcc . p_stmt))
693606 stmts = init xs
694607 yield = last xs
695608 lists = foldr (liftAppend . gatherStmt) [] stmts
@@ -703,100 +616,76 @@ p_hsExpr' s = \case
703616 MDoExpr -> doBody "mdo"
704617 ListComp -> compBody
705618 MonadComp -> notImplemented "MonadComp"
706− ArrowExpr -> notImplemented "ArrowExpr"
619+ ArrowExpr -> notImplemented "ArrowExpr"
707620 GhciStmtCtxt -> notImplemented "GhciStmtCtxt"
708621 PatGuard _ -> notImplemented "PatGuard"
709622 ParStmtCtxt _ -> notImplemented "ParStmtCtxt"
710623 TransStmtCtxt _ -> notImplemented "TransStmtCtxt"
711624 ExplicitList _ _ xs ->
712− brackets s $
713− sep commaDel (sitcc . located' p_hsExpr) xs
625+ brackets . sitcc $ sep (comma >> breakpoint) (sitcc . located' p_hsExpr) xs
714626 RecordCon {..} -> do
715627 located rcon_con_name atom
716628 breakpoint
717629 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− }
724− fields = located' (p_hsRecField . updName) <$> rec_flds
630+ fields = located' p_hsRecField <$> rec_flds
725631 dotdot =
726632 case rec_dotdot of
727633 Just {} -> [txt ".."]
728634 Nothing -> []
729− inci . braces N $
730− sep commaDel sitcc (fields <> dotdot)
635+ inci . braces . sitcc $ sep (comma >> breakpoint) sitcc (fields <> dotdot)
731636 RecordUpd {..} -> do
732637 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 $
749− sep
750− commaDel
751− (sitcc . located' (p_hsRecField . updName))
752− rupd_flds
753− ExprWithTySig NoExtField x HsWC {hswc_body = HsIB {..}} -> sitcc $ do
638+ breakpoint
639+ inci . braces . sitcc $
640+ sep (comma >> breakpoint) (sitcc . located' p_hsRecField) rupd_flds
641+ ExprWithTySig affix x -> sitcc $ do
754642 located x p_hsExpr
755− space
756− txt "::"
757643 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 ->
644+ inci $ do
645+ txt "::"
646+ space
647+ let HsWC {..} = affix
648+ HsIB {..} = hswc_body
649+ located hsib_body p_hsType
650+ ArithSeq NoExt _ x -> do
762651 case x of
763− From from -> brackets s $ do
652+ From from -> brackets . sitcc $ do
764653 located from p_hsExpr
765654 breakpoint
766655 txt ".."
767− FromThen from next -> brackets s $ do
768− sep commaDel (located' p_hsExpr) [from, next]
656+ FromThen from next -> brackets . sitcc $ do
657+ sitcc $ sep (comma >> breakpoint) (located' p_hsExpr) [from, next]
769658 breakpoint
770659 txt ".."
771− FromTo from to -> brackets s $ do
660+ FromTo from to -> brackets . sitcc $ do
772661 located from p_hsExpr
773662 breakpoint
774663 txt ".."
775664 space
776665 located to p_hsExpr
777− FromThenTo from next to -> brackets s $ do
778− sep commaDel (located' p_hsExpr) [from, next]
666+ FromThenTo from next to -> brackets . sitcc $ do
667+ sitcc $ sep (comma >> breakpoint) (located' p_hsExpr) [from, next]
779668 breakpoint
780669 txt ".."
781670 space
782671 located to p_hsExpr
783− HsSCC NoExtField _ name x -> do
672+ HsSCC NoExt _ name x -> do
784673 txt "{-# SCC "
785674 atom name
786675 txt " #-}"
787676 breakpoint
788677 located x p_hsExpr
789− HsCoreAnn NoExtField _ value x -> do
678+ HsCoreAnn NoExt _ value x -> do
790679 txt "{-# CORE "
791680 atom value
792681 txt " #-}"
793682 breakpoint
794683 located x p_hsExpr
795− HsBracket NoExtField x -> p_hsBracket x
684+ HsBracket NoExt x -> p_hsBracket x
796685 HsRnBracketOut {} -> notImplemented "HsRnBracketOut"
797686 HsTcBracketOut {} -> notImplemented "HsTcBracketOut"
798− HsSpliceE NoExtField splice -> p_hsSplice splice
799− HsProc NoExtField p e -> do
687+ HsSpliceE NoExt splice -> p_hsSplice splice
688+ HsProc NoExt p e -> do
800689 txt "proc"
801690 located p $ \x -> do
802691 breakpoint
@@ -805,46 +694,65 @@ p_hsExpr' s = \case
805694 txt "->"
806695 placeHanging (cmdTopPlacement (unLoc e)) $
807696 located e p_hsCmdTop
808− HsStatic _ e -> do
697+ HsStatic _ e -> do
809698 txt "static"
810699 breakpoint
811700 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)
812705 HsTick {} -> notImplemented "HsTick"
813706 HsBinTick {} -> notImplemented "HsBinTick"
814707 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
712+ p_rdrName n
713+ txt "@"
714+ located p p_hsExpr
715+ EViewPat NoExt p e -> do
716+ located p p_hsExpr
717+ space
718+ txt "->"
719+ breakpoint
720+ inci (located e p_hsExpr)
721+ ELazyPat NoExt p -> do
722+ txt "~"
723+ located p p_hsExpr
815724 HsWrap {} -> notImplemented "HsWrap"
816− XExpr x -> noExtCon x
725+ XExpr {} -> notImplemented "XExpr"
817726
818727p_patSynBind :: PatSynBind GhcPs GhcPs -> R ()
819728p_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)
729+ let rhs = case psb_dir of
730+ Unidirectional -> do
731+ txt "<-"
732+ space
733+ located psb_def p_pat
734+ ImplicitBidirectional -> do
735+ txt "="
736+ space
737+ located psb_def p_pat
738+ ExplicitBidirectional mgroup -> do
739+ txt "<-"
740+ space
741+ located psb_def p_pat
742+ newline
743+ txt "where"
744+ newline
745+ inci (p_matchGroup (Function psb_id) mgroup)
839746 txt "pattern"
840747 case psb_args of
841748 PrefixCon xs -> do
842749 space
843750 p_rdrName psb_id
844− inci $ do
751+ inci $ do
845752 switchLayout (getLoc <$> xs) $ do
846753 unless (null xs) breakpoint
847754 sitcc (sep breakpoint p_rdrName xs)
755+ breakpoint
848756 rhs
849757 RecCon xs -> do
850758 space
@@ -852,8 +760,9 @@ p_patSynBind PSB {..} = do
852760 inci $ do
853761 switchLayout (getLoc . recordPatSynPatVar <$> xs) $ do
854762 unless (null xs) breakpoint
855− braces N $
856− sep commaDel (p_rdrName . recordPatSynPatVar) xs
763+ braces . sitcc $
764+ sep (comma >> breakpoint) (p_rdrName . recordPatSynPatVar) xs
765+ breakpoint
857766 rhs
858767 InfixCon l r -> do
859768 switchLayout [getLoc l, getLoc r] $ do
@@ -864,100 +773,37 @@ p_patSynBind PSB {..} = do
864773 p_rdrName psb_id
865774 space
866775 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)
776+ inci $ do
777+ breakpoint
778+ rhs
779+p_patSynBind (XPatSynBind NoExt) = notImplemented "XPatSynBind"
934780
935781p_pat :: Pat GhcPs -> R ()
936782p_pat = \case
937− WildPat NoExtField -> txt "_"
938− VarPat NoExtField name -> p_rdrName name
939− LazyPat NoExtField pat -> do
783+ WildPat NoExt -> txt "_"
784+ VarPat NoExt name -> p_rdrName name
785+ LazyPat NoExt pat -> do
940786 txt "~"
941787 located pat p_pat
942− AsPat NoExtField name pat -> do
788+ AsPat NoExt name pat -> do
943789 p_rdrName name
944790 txt "@"
945791 located pat p_pat
946− ParPat NoExtField pat ->
947− located pat (parens S . p_pat)
948− BangPat NoExtField pat -> do
792+ ParPat NoExt pat ->
793+ located pat (parens . p_pat)
794+ BangPat NoExt pat -> do
949795 txt "!"
950796 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' =
797+ ListPat NoExt pats -> do
798+ brackets . sitcc $ sep (comma >> breakpoint) (located' p_pat) pats
799+ TuplePat NoExt pats boxing -> do
800+ let f =
955801 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)
802+ Boxed -> parens
803+ Unboxed -> parensHash
804+ f . sitcc $ sep (comma >> breakpoint) (sitcc . located' p_pat) pats
805+ SumPat NoExt pat tag arity ->
806+ p_unboxedSum tag arity (located pat p_pat)
961807 ConPatIn pat details ->
962808 case details of
963809 PrefixCon xs -> sitcc $ do
@@ -971,40 +817,37 @@ p_pat = \case
971817 let f = \case
972818 Nothing -> txt ".."
973819 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
820+ inci . braces . sitcc . sep (comma >> breakpoint) f $ case dotdot of
821+ Nothing -> Just <$> fields
822+ Just n -> (Just <$> take n fields) ++ [Nothing]
823+ InfixCon x y -> do
824+ located x p_pat
825+ space
826+ p_rdrName pat
827+ breakpoint
828+ inci (located y p_pat)
986829 ConPatOut {} -> notImplemented "ConPatOut" -- presumably created by renamer?
987− ViewPat NoExtField expr pat -> sitcc $ do
830+ ViewPat NoExt expr pat -> sitcc $ do
988831 located expr p_hsExpr
989832 space
990833 txt "->"
991834 breakpoint
992835 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
836+ SplicePat NoExt splice -> p_hsSplice splice
837+ LitPat NoExt p -> atom p
838+ NPat NoExt v _ _ -> located v (atom . ol_val)
839+ NPlusKPat NoExt n k _ _ _ -> sitcc $ do
997840 p_rdrName n
998841 breakpoint
999842 inci $ do
1000843 txt "+"
1001844 space
1002845 located k (atom . ol_val)
1003− SigPat NoExtField pat hswc -> do
846+ SigPat hswc pat -> do
1004847 located pat p_pat
1005848 p_typeAscription hswc
1006849 CoPat {} -> notImplemented "CoPat" -- apparently created at some later stage
1007− XPat x -> noExtCon x
850+ XPat NoExt -> notImplemented "XPat"
1008851
1009852p_pat_hsRecField :: HsRecField' (FieldOcc GhcPs) (LPat GhcPs) -> R ()
1010853p_pat_hsRecField HsRecField {..} = do
@@ -1012,53 +855,51 @@ p_pat_hsRecField HsRecField {..} = do
1012855 p_rdrName (rdrNameFieldOcc x)
1013856 unless hsRecPun $ do
1014857 space
1015− equals
858+ txt "="
1016859 breakpoint
1017860 inci (located hsRecFieldArg p_pat)
1018861
1019−p_unboxedSum :: BracketStyle -> ConTag -> Arity -> R () -> R ()
1020−p_unboxedSum s tag arity m = do
862+p_unboxedSum :: ConTag -> Arity -> R () -> R ()
863+p_unboxedSum tag arity m = do
1021864 let before = tag - 1
1022865 after = arity - before - 1
1023866 args = replicate before Nothing <> [Just m] <> replicate after Nothing
1024− f x =
867+ f (x,i) = do
868+ let isFirst = i == 0
869+ isLast = i == arity - 1
1025870 case x :: Maybe (R ()) of
1026871 Nothing ->
1027− space
872+ unless (isFirst || isLast) space
1028873 Just m' -> do
1029− space
874+ unless isFirst space
1030875 m'
1031− space
1032− parensHash s $ sep (txt "|") f args
876+ unless isLast space
877+ parensHash $ sep (txt "|") f (zip args [0..])
1033878
1034879p_hsSplice :: HsSplice GhcPs -> R ()
1035880p_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
881+ HsTypedSplice NoExt deco _ expr -> p_hsSpliceTH True expr deco
882+ HsUntypedSplice NoExt deco _ expr -> p_hsSpliceTH False expr deco
883+ HsQuasiQuote NoExt _ quoterName srcSpan str -> do
1039884 txt "["
1040885 p_rdrName (L srcSpan quoterName)
1041886 txt "|"
1042− -- QuasiQuoters often rely on precise custom strings. We cannot do any
1043− -- formatting here without potentially breaking someone's code.
887+ -- NOTE QuasiQuoters often rely on precise custom strings. We cannot do
888+ -- any formatting here without potentially breaking someone's code.
1044889 atom str
1045890 txt "|]"
1046891 HsSpliced {} -> notImplemented "HsSpliced"
1047− HsSplicedT {} -> notImplemented "HsSplicedT"
1048− XSplice x -> noExtCon x
892+ XSplice {} -> notImplemented "XSplice"
1049893
1050−p_hsSpliceTH ::
1051− -- | Typed splice?
1052− Bool ->
1053− -- | Splice expression
1054− LHsExpr GhcPs ->
1055− -- | Splice decoration
1056− SpliceDecoration ->
1057− R ()
894+p_hsSpliceTH
895+ :: Bool -- ^ Typed splice?
896+ -> LHsExpr GhcPs -- ^ Splice expression
897+ -> SpliceDecoration -- ^ Splice decoration
898+ -> R ()
1058899p_hsSpliceTH isTyped expr = \case
1059900 HasParens -> do
1060901 txt decoSymbol
1061− parens N (located expr (sitcc . p_hsExpr))
902+ parens (located expr (sitcc . p_hsExpr))
1062903 HasDollar -> do
1063904 txt decoSymbol
1064905 located expr (sitcc . p_hsExpr)
@@ -1069,17 +910,17 @@ p_hsSpliceTH isTyped expr = \case
1069910
1070911p_hsBracket :: HsBracket GhcPs -> R ()
1071912p_hsBracket = \case
1072− ExpBr NoExtField expr -> do
913+ ExpBr NoExt expr -> do
1073914 anns <- getEnclosingAnns
1074915 let name = case anns of
1075− AnnOpenEQ : _ -> ""
916+ AnnOpenEQ:_ -> ""
1076917 _ -> "e"
1077918 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
919+ PatBr NoExt pat -> quote "p" (located pat p_pat)
920+ DecBrL NoExt decls -> quote "d" (p_hsDecls Free decls)
921+ DecBrG NoExt _ -> notImplemented "DecBrG" -- result of renamer
922+ TypBr NoExt ty -> quote "t" (located ty p_hsType)
923+ VarBr NoExt isSingleQuote name -> do
1083924 txt (bool "''" "'" isSingleQuote)
1084925 -- HACK As you can see we use 'noLoc' here to be able to pass name into
1085926 -- 'p_rdrName' since the latter expects a "located" thing. The problem
@@ -1087,20 +928,19 @@ p_hsBracket = \case
1087928 -- turn makes it impossible to detect if there are parentheses around
1088929 -- it, etc. So we have to add parentheses manually assuming they are
1089930 -- 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
931+ let isOperator = all
932+ (\i -> isPunctuation i || isSymbol i)
933+ (showOutputable (rdrNameOcc name))
934+ && not (doesNotNeedExtraParens name)
935+ wrapper = if isOperator then parens else id
1096936 wrapper $ p_rdrName (noLoc name)
1097− TExpBr NoExtField expr -> do
937+ TExpBr NoExt expr -> do
1098938 txt "[||"
1099939 breakpoint'
1100940 located expr p_hsExpr
1101941 breakpoint'
1102942 txt "||]"
1103− XBracket x -> noExtCon x
943+ XBracket {} -> notImplemented "XBracket"
1104944 where
1105945 quote :: Text -> R () -> R ()
1106946 quote name body = do
@@ -1113,65 +953,12 @@ p_hsBracket = \case
1113953 breakpoint'
1114954 txt "|]"
1115955
1116−-- Print the source text of a string literal while indenting
1117−-- gaps correctly.
1118−
1119−p_stringLit :: String -> R ()
1120−p_stringLit src =
1121− let s = splitGaps src
1122− singleLine =
1123− txt $ Text.pack (mconcat s)
1124− multiLine =
1125− sitcc $ sep breakpoint (txt . Text.pack) (backslashes s)
1126− 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 '\'
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
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
1162−
1163956----------------------------------------------------------------------------
1164957-- Helpers
1165958
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−
1173959-- | Append each element in both lists with semigroups. If one list is shorter
1174960-- than the other, return the rest of the longer list unchanged.
961+
1175962liftAppend :: Semigroup a => [a] -> [a] -> [a]
1176963liftAppend [] [] = []
1177964liftAppend [] (y : ys) = y : ys
@@ -1179,13 +966,14 @@ liftAppend (x : xs) [] = x : xs
1179966liftAppend (x : xs) (y : ys) = x <> y : liftAppend xs ys
1180967
1181968getGRHSSpan :: GRHS GhcPs (Located body) -> SrcSpan
1182−getGRHSSpan (GRHS NoExtField guards body) =
969+getGRHSSpan (GRHS NoExt guards body) =
1183970 combineSrcSpans' $ getLoc body :| map getLoc guards
1184−getGRHSSpan (XGRHS x) = noExtCon x
971+getGRHSSpan (XGRHS NoExt) = notImplemented "XGRHS"
1185972
1186973-- | Place a thing that may have a hanging form. This function handles how
1187974-- to separate it from preceding expressions and whether to bump indentation
1188975-- depending on what sort of expression we have.
976+
1189977placeHanging :: Placement -> R () -> R ()
1190978placeHanging placement m =
1191979 case placement of
@@ -1198,165 +986,67 @@ placeHanging placement m =
1198986
1199987-- | Check if given block contains single expression which has a hanging
1200988-- form.
1201−blockPlacement ::
1202− (body -> Placement) ->
1203− [LGRHS GhcPs (Located body)] ->
1204− Placement
1205−blockPlacement placer [L _ (GRHS NoExtField _ (L _ x))] = placer x
989+
990+blockPlacement
991+ :: (body -> Placement)
992+ -> [LGRHS GhcPs (Located body)]
993+ -> Placement
994+blockPlacement placer [(L _ (GRHS NoExt _ (L _ x)))] = placer x
1206995blockPlacement _ _ = Normal
1207996
1208997-- | Check if given command has a hanging form.
998+
1209999cmdPlacement :: HsCmd GhcPs -> Placement
12101000cmdPlacement = \case
1211− HsCmdLam NoExtField _ -> Hanging
1212− HsCmdCase NoExtField _ _ -> Hanging
1213− HsCmdDo NoExtField _ -> Hanging
1001+ HsCmdLam NoExt _ -> Hanging
1002+ HsCmdCase NoExt _ _ -> Hanging
1003+ HsCmdDo NoExt _ -> Hanging
12141004 _ -> Normal
12151005
12161006cmdTopPlacement :: HsCmdTop GhcPs -> Placement
12171007cmdTopPlacement = \case
1218− HsCmdTop NoExtField (L _ x) -> cmdPlacement x
1219− XCmdTop x -> noExtCon x
1008+ HsCmdTop NoExt (L _ x) -> cmdPlacement x
1009+ XCmdTop {} -> notImplemented "XCmdTop"
12201010
12211011-- | Check if given expression has a hanging form.
1012+
12221013exprPlacement :: HsExpr GhcPs -> Placement
12231014exprPlacement = \case
12241015 -- 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
1016+ HsLam NoExt mg -> case mg of
1017+ MG _ (L _ [L _ (Match NoExt _ (x:xs) _)]) _
1018+ | isOneLineSpan (combineSrcSpans' $ fmap getLoc (x :| xs))
1019+ -> Hanging
12291020 _ -> 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 _ ->
1021+ HsLamCase NoExt _ -> Hanging
1022+ HsCase NoExt _ _ -> Hanging
1023+ HsDo NoExt DoExpr _ -> Hanging
1024+ HsDo NoExt MDoExpr _ -> Hanging
1025+ RecordCon NoExt _ _ -> Hanging
1026+ -- If the rightmost expression in an operator chain is hanging, make the
1027+ -- whole block hanging; so that we can use the common @f = foo $ do@
1028+ -- style.
1029+ OpApp NoExt _ _ y -> exprPlacement (unLoc y)
1030+ HsProc NoExt (L s _) _ ->
12401031 -- Indentation breaks if pattern is longer than one line and left
12411032 -- hanging. Consequently, only apply hanging when it is safe.
1242− if isOneLineSpan (getLoc p)
1243− then Hanging
1244− else Normal
1033+ if isOneLineSpan s
1034+ then Hanging
1035+ else Normal
12451036 _ -> Normal
12461037
12471038withGuards :: [LGRHS GhcPs (Located body)] -> Bool
12481039withGuards = any (checkOne . unLoc)
12491040 where
12501041 checkOne :: GRHS GhcPs (Located body) -> Bool
1251− checkOne (GRHS NoExtField [] _) = False
1042+ checkOne (GRHS NoExt [] _) = False
12521043 checkOne _ = True
12531044
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
1257−
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.
1276− let placement =
1277− if isOneLineSpan
1278− (mkSrcSpan (srcSpanStart (opTreeLoc x)) (srcSpanStart (opTreeLoc y)))
1279− then case y of
1280− OpNode (L _ n) -> exprPlacement n
1281− _ -> Normal
1282− else Normal
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
1287− _ -> 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
1355−
13561045-- | Get annotations for the enclosing element.
1046+
13571047getEnclosingAnns :: R [AnnKeywordId]
13581048getEnclosingAnns = do
13591049 e <- getEnclosingSpan (const True)
13601050 case e of
13611051 Nothing -> return []
1362− Just e' -> getAnns (RealSrcSpan e')
1052+ Just e' -> getAnns (RealSrcSpan e')