@@ -1,13 +1,15 @@
1−{-# LANGUAGE LambdaCase #-}
1+{-# LANGUAGE LambdaCase #-}
2+{-# LANGUAGE MultiWayIf #-}
23{-# LANGUAGE OverloadedStrings #-}
3−{-# LANGUAGE RecordWildCards #-}
4+{-# LANGUAGE RecordWildCards #-}
5+{-# LANGUAGE TypeApplications #-}
46
57module Ormolu.Printer.Meat.Declaration.Value
6− ( p_valDecl
7− , p_pat
8− , p_hsExpr
9− , p_hsSplice
10− , p_stringLit
8+ ( p_valDecl,
9+ p_pat,
10+ p_hsExpr,
11+ p_hsSplice,
12+ p_stringLit,
1113 )
1214where
1315
@@ -18,24 +20,24 @@ import Ctype (is_space)
1820import Data.Bool (bool)
1921import Data.Char (isPunctuation, isSymbol)
2022import Data.Data hiding (Infix, Prefix)
23+import Data.Functor ((<&>))
2124import Data.List (intersperse, sortOn)
22−import Data.List.NonEmpty (NonEmpty ((:|)))
25+import Data.List.NonEmpty (NonEmpty (..), (<|))
26+import qualified Data.List.NonEmpty as NE
2327import Data.Text (Text)
2428import qualified Data.Text as Text
2529import GHC
30+import OccName (occNameString)
2631import Ormolu.Printer.Combinators
32+import Ormolu.Printer.Internal
2733import Ormolu.Printer.Meat.Common
34+import {-# SOURCE #-} Ormolu.Printer.Meat.Declaration
2835import Ormolu.Printer.Meat.Declaration.Signature
2936import Ormolu.Printer.Meat.Type
3037import Ormolu.Printer.Operators
3138import 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
3639
3740-- | Style of a group of equations.
38−
3941data MatchGroupStyle
4042 = Function (Located RdrName)
4143 | PatternBind
@@ -44,57 +46,61 @@ data MatchGroupStyle
4446 | LambdaCase
4547
4648-- | Style of equations in a group.
47−
4849data GroupStyle
4950 = EqualSign
5051 | RightArrow
5152
5253-- | Expression placement. This marks the places where expressions that
5354-- implement handing forms may use them.
54−
5555data Placement
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
62− deriving (Eq)
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)
6365
6466p_valDecl :: HsBindLR GhcPs GhcPs -> R ()
6567p_valDecl = \case
66− FunBind NoExt funId funMatches _ _ -> p_funBind funId funMatches
67− PatBind NoExt pat grhss _ -> p_match PatternBind False NoSrcStrict [pat] grhss
68+ FunBind NoExtField funId funMatches _ _ -> p_funBind funId funMatches
69+ PatBind NoExtField pat grhss _ -> p_match PatternBind False NoSrcStrict [pat] grhss
6870 VarBind {} -> notImplemented "VarBinds" -- introduced by the type checker
6971 AbsBinds {} -> notImplemented "AbsBinds" -- introduced by the type checker
70− PatSynBind NoExt psb -> p_patSynBind psb
71− XHsBindsLR NoExt -> notImplemented "XHsBindsLR"
72+ PatSynBind NoExtField psb -> p_patSynBind psb
73+ XHsBindsLR x -> noExtCon x
7274
73−p_funBind
74− :: Located RdrName
75− -> MatchGroup GhcPs (LHsExpr GhcPs)
76− -> R ()
75+p_funBind ::
76+ Located RdrName ->
77+ MatchGroup GhcPs (LHsExpr GhcPs) ->
78+ R ()
7779p_funBind name = p_matchGroup (Function name)
7880
79−p_matchGroup
80− :: MatchGroupStyle
81− -> MatchGroup GhcPs (LHsExpr GhcPs)
82− -> R ()
81+p_matchGroup ::
82+ MatchGroupStyle ->
83+ MatchGroup GhcPs (LHsExpr GhcPs) ->
84+ R ()
8385p_matchGroup = p_matchGroup' exprPlacement p_hsExpr
8486
85−p_matchGroup'
86− :: Data body
87− => (body -> Placement) -- ^ How to get body placement
88− -> (body -> R ()) -- ^ How to print body
89− -> MatchGroupStyle -- ^ Style of this group of equations
90− -> MatchGroup GhcPs (Located body) -- ^ Match group
91− -> R ()
92−p_matchGroup' placer pretty style MG {..} = do
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
9399 let ob = case style of
94100 Case -> id
95101 LambdaCase -> id
96102 _ -> dontUseBraces
97− -- NOTE since we are forcing braces on 'sepSemi' based on 'ob', we have to
103+ -- Since we are forcing braces on 'sepSemi' based on 'ob', we have to
98104 -- restore the brace state inside the sepsemi.
99105 ub <- bool dontUseBraces useBraces <$> canUseBraces
100106 ob $ sepSemi (located' (ub . p_Match)) (unLoc mg_alts)
@@ -102,14 +108,14 @@ p_matchGroup' placer pretty style MG {..} = do
102108 p_Match m@Match {..} =
103109 p_match'
104110 placer
105− pretty
111+ render
106112 (adjustMatchGroupStyle m style)
107113 (isInfixMatch m)
108114 (matchStrictness m)
109115 m_pats
110116 m_grhss
111− p_Match _ = notImplemented "XMatch"
112−p_matchGroup' _ _ _ (XMatchGroup NoExt) = notImplemented "XMatchGroup"
117+ p_Match (XMatch x) = noExtCon x
118+p_matchGroup' _ _ _ (XMatchGroup x) = noExtCon x
113119
114120-- | Function id obtained through pattern matching on 'FunBind' should not
115121-- be used to print the actual equations because the different ‘RdrNames’
@@ -117,11 +123,10 @@ p_matchGroup' _ _ _ (XMatchGroup NoExt) = notImplemented "XMatchGroup"
117123-- and paretheses) associated with them. It is necessary to use per-equation
118124-- names obtained from 'm_ctxt' of 'Match'. This function replaces function
119125-- name inside of 'Function' accordingly.
120−
121−adjustMatchGroupStyle
122− :: Match GhcPs body
123− -> MatchGroupStyle
124− -> MatchGroupStyle
126+adjustMatchGroupStyle ::
127+ Match GhcPs body ->
128+ MatchGroupStyle ->
129+ MatchGroupStyle
125130adjustMatchGroupStyle m = \case
126131 Function _ -> (Function . mc_fun . m_ctxt) m
127132 style -> style
@@ -129,31 +134,43 @@ adjustMatchGroupStyle m = \case
129134matchStrictness :: Match id body -> SrcStrictness
130135matchStrictness match =
131136 case m_ctxt match of
132− FunRhs{mc_strictness=s} -> s
137+ FunRhs {mc_strictness = s} -> s
133138 _ -> NoSrcStrict
134139
135−p_match
136− :: MatchGroupStyle -- ^ Style of the group
137− -> Bool -- ^ Is this an infix match?
138− -> SrcStrictness -- ^ Strictness prefix (FunBind)
139− -> [LPat GhcPs] -- ^ Argument patterns
140− -> GRHSs GhcPs (LHsExpr GhcPs) -- ^ Equations
141− -> R ()
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 ()
142152p_match = p_match' exprPlacement p_hsExpr
143153
144−p_match'
145− :: Data body
146− => (body -> Placement) -- ^ How to get body placement
147− -> (body -> R ()) -- ^ How to print body
148− -> MatchGroupStyle -- ^ Style of this group of equations
149− -> Bool -- ^ Is this an infix match?
150− -> SrcStrictness -- ^ Strictness prefix (FunBind)
151− -> [LPat GhcPs] -- ^ Argument patterns
152− -> GRHSs GhcPs (Located body) -- ^ Equations
153− -> R ()
154−p_match' placer pretty style isInfix strictness m_pats m_grhss = do
155− -- NOTE Normally, since patterns may be placed in a multi-line layout, it
156− -- is necessary to bump indentation for the pattern group so it's more
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
157174 -- indented than function name. This in turn means that indentation for
158175 -- the body should also be bumped. Normally this would mean that bodies
159176 -- would start with two indentation steps applied, which is ugly, so we
@@ -163,23 +180,24 @@ p_match' placer pretty style isInfix strictness m_pats m_grhss = do
163180 NoSrcStrict -> return ()
164181 SrcStrict -> txt "!"
165182 SrcLazy -> txt "~"
166− inci' <- case NE.nonEmpty m_pats of
167− Nothing -> id <$ case style of
168− Function name -> p_rdrName name
169− _ -> return ()
183+ indentBody <- case NE.nonEmpty m_pats of
184+ Nothing ->
185+ False <$ case style of
186+ Function name -> p_rdrName name
187+ _ -> return ()
170188 Just ne_pats -> do
171− let combinedSpans = combineSrcSpans' $
172− getLoc <$> ne_pats
173− inci' = if isOneLineSpan combinedSpans
174− then id
175− else inci
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)
176194 switchLayout [combinedSpans] $ do
177195 let stdCase = sep breakpoint (located' p_pat) m_pats
178196 case style of
179197 Function name ->
180198 p_infixDefHelper
181199 isInfix
182− inci'
200+ indentBody
183201 (p_rdrName name)
184202 (located' p_pat <$> m_pats)
185203 PatternBind -> stdCase
@@ -194,46 +212,40 @@ p_match' placer pretty style isInfix strictness m_pats m_grhss = do
194212 when needsSpace space
195213 sitcc stdCase
196214 LambdaCase -> stdCase
197− return inci'
198− let
199− -- Calculate position of end of patterns. This is useful when we decide
200− -- about putting certain constructions in hanging positions.
201− endOfPats = case NE.nonEmpty m_pats of
202− Nothing -> case style of
203− Function name -> (Just . srcSpanEnd . getLoc) name
204− _ -> Nothing
205− Just pats -> (Just . srcSpanEnd . getLoc . NE.last) pats
206− isCase = \case
207− Case -> True
208− LambdaCase -> True
209− _ -> False
210− let GRHSs {..} = m_grhss
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
211227 hasGuards = withGuards grhssGRHSs
212− unless (length grhssGRHSs > 1) $ do
213− case style of
214− Function _ | hasGuards -> return ()
215− Function _ -> space >> txt "="
216− PatternBind -> space >> txt "="
217− s | isCase s && hasGuards -> return ()
218− _ -> space >> txt "->"
219− let grhssSpan = combineSrcSpans' $
220− getGRHSSpan . unLoc <$> NE.fromList grhssGRHSs
221− patGrhssSpan = maybe grhssSpan
222− (combineSrcSpans grhssSpan . srcLocSpan) endOfPats
228+ grhssSpan =
229+ combineSrcSpans' $
230+ getGRHSSpan . unLoc <$> NE.fromList grhssGRHSs
231+ patGrhssSpan =
232+ maybe
233+ grhssSpan
234+ (combineSrcSpans grhssSpan . srcLocSpan . srcSpanEnd)
235+ endOfPats
223236 placement =
224237 case endOfPats of
225238 Nothing -> blockPlacement placer grhssGRHSs
226239 Just spn ->
227− if isOneLineSpan
228− (mkSrcSpan spn (srcSpanStart grhssSpan))
240+ if onTheSameLine spn grhssSpan
229241 then blockPlacement placer grhssGRHSs
230242 else Normal
231243 p_body = do
232244 let groupStyle =
233245 if isCase style && hasGuards
234− then RightArrow
235− else EqualSign
236− sep newline (located' (p_grhs' placer pretty groupStyle)) grhssGRHSs
246+ then RightArrow
247+ else EqualSign
248+ sep newline (located' (p_grhs' placer render groupStyle)) grhssGRHSs
237249 p_where = do
238250 let whereIsEmpty = GHC.isEmptyLocalBindsPR (unLoc grhssLocalBinds)
239251 unless (GHC.eqEmptyLocalBinds (unLoc grhssLocalBinds)) $ do
@@ -241,186 +253,211 @@ p_match' placer pretty style isInfix strictness m_pats m_grhss = do
241253 txt "where"
242254 unless whereIsEmpty breakpoint
243255 inci $ located grhssLocalBinds p_hsLocalBinds
244− inci' $ do
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 "->"
245264 switchLayout [patGrhssSpan] $
246265 placeHanging placement p_body
247266 inci p_where
267+p_match' _ _ _ _ _ _ (XGRHSs x) = noExtCon x
248268
249269p_grhs :: GroupStyle -> GRHS GhcPs (LHsExpr GhcPs) -> R ()
250270p_grhs = p_grhs' exprPlacement p_hsExpr
251271
252−p_grhs'
253− :: Data body
254− => (body -> Placement) -- ^ How to get body placement
255− -> (body -> R ()) -- ^ How to print body
256− -> GroupStyle
257− -> GRHS GhcPs (Located body)
258− -> R ()
259−p_grhs' placer pretty style (GRHS NoExt guards body) =
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) =
260282 case guards of
261283 [] -> p_body
262284 xs -> do
263285 txt "|"
264286 space
265− sitcc (sep (comma >> breakpoint) (sitcc . located' p_stmt) xs)
287+ sitcc (sep commaDel (sitcc . located' p_stmt) xs)
266288 space
267− txt $ case style of
268− EqualSign -> "="
269− RightArrow -> "->"
289+ inci $ case style of
290+ EqualSign -> equals
291+ RightArrow -> txt "->"
270292 placeHanging placement p_body
271293 where
272294 placement =
273295 case endOfGuards of
274296 Nothing -> placer (unLoc body)
275297 Just spn ->
276− if isOneLineSpan (mkSrcSpan spn (srcSpanStart (getLoc body)))
277− then placer (unLoc body)
278− else Normal
298+ if onTheSameLine spn (getLoc body)
299+ then placer (unLoc body)
300+ else Normal
279301 endOfGuards =
280302 case NE.nonEmpty guards of
281303 Nothing -> Nothing
282− Just gs -> (Just . srcSpanEnd . getLoc . NE.last) gs
283− p_body = located body pretty
284−p_grhs' _ _ _ (XGRHS NoExt) = notImplemented "XGRHS"
304+ Just gs -> (Just . getLoc . NE.last) gs
305+ p_body = located body render
306+p_grhs' _ _ _ (XGRHS x) = noExtCon x
285307
286308p_hsCmd :: HsCmd GhcPs -> R ()
287309p_hsCmd = \case
288− HsCmdArrApp NoExt body input arrType _ -> do
310+ HsCmdArrApp NoExtField body input arrType _ -> do
289311 located body p_hsExpr
290− space
291− case arrType of
292− HsFirstOrderApp -> txt "-<"
293− HsHigherOrderApp -> txt "-<<"
294− placeHanging (exprPlacement (unLoc input)) $
295− located input p_hsExpr
296− HsCmdArrForm NoExt form Prefix _ cmds -> banana $ sitcc $ do
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
297320 located form p_hsExpr
298321 unless (null cmds) $ do
299322 breakpoint
300323 inci (sequence_ (intersperse breakpoint (located' p_hsCmdTop <$> cmds)))
301− HsCmdArrForm NoExt form Infix _ [left, right] -> do
324+ HsCmdArrForm NoExtField form Infix _ [left, right] -> do
302325 located left p_hsCmdTop
303326 space
304327 located form p_hsExpr
305328 placeHanging (cmdTopPlacement (unLoc right)) $
306329 located right p_hsCmdTop
307− HsCmdArrForm NoExt _ Infix _ _ -> notImplemented "HsCmdArrForm"
330+ HsCmdArrForm NoExtField _ Infix _ _ -> notImplemented "HsCmdArrForm"
308331 HsCmdApp {} ->
309332 -- XXX Does this ever occur in the syntax tree? It does not seem like it
310333 -- does. Open an issue and ping @yumiova if this ever occurs in output.
311334 notImplemented "HsCmdApp"
312− HsCmdLam NoExt mgroup -> p_matchGroup' cmdPlacement p_hsCmd Lambda mgroup
313− HsCmdPar NoExt c -> parens (located c p_hsCmd)
314− HsCmdCase NoExt e mgroup -> do
315− txt "case"
316− space
317− located e p_hsExpr
318− space
319− txt "of"
320− breakpoint
321− inci (p_matchGroup' cmdPlacement p_hsCmd Case mgroup)
322− HsCmdIf NoExt _ if' then' else' -> do
323− txt "if"
324− space
325− located if' p_hsExpr
326− breakpoint
327− txt "then"
328− located then' $ \x -> do
329− breakpoint
330− inci (p_hsCmd x)
331− breakpoint
332− txt "else"
333− located else' $ \x -> do
334− breakpoint
335− inci (p_hsCmd x)
336− HsCmdLet NoExt localBinds c -> do
337− txt "let"
338− space
339− sitcc (located localBinds p_hsLocalBinds)
340− breakpoint
341− txt "in"
342− space
343− sitcc (located c p_hsCmd)
344− HsCmdDo NoExt es -> do
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
345344 txt "do"
346345 newline
347− inci (located es (sitcc . sep newline (located' (sitcc . p_stmt' p_hsCmd))))
346+ inci . located es $
347+ sitcc . sep newline (sitcc . withSpacing (p_stmt' cmdPlacement p_hsCmd))
348348 HsCmdWrap {} -> notImplemented "HsCmdWrap"
349− XCmd {} -> notImplemented "XCmd"
349+ XCmd x -> noExtCon x
350350
351351p_hsCmdTop :: HsCmdTop GhcPs -> R ()
352352p_hsCmdTop = \case
353− HsCmdTop NoExt cmd -> located cmd p_hsCmd
354− XCmdTop {} -> notImplemented "XHsCmdTop"
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)
355384
356385p_stmt :: Stmt GhcPs (LHsExpr GhcPs) -> R ()
357−p_stmt = p_stmt' p_hsExpr
386+p_stmt = p_stmt' exprPlacement p_hsExpr
358387
359−p_stmt'
360− :: Data body
361− => (body -> R ())
362− -> Stmt GhcPs (Located body)
363− -> R ()
364−p_stmt' pretty = \case
365− LastStmt NoExt body _ _ -> located body pretty
366− BindStmt NoExt l f _ _ -> do
367− located l p_pat
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
368401 space
369402 txt "<-"
370− breakpoint
371− inci (located f pretty)
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)
372413 ApplicativeStmt {} -> notImplemented "ApplicativeStmt" -- generated by renamer
373− BodyStmt NoExt body _ _ -> located body pretty
374− LetStmt NoExt binds -> do
414+ BodyStmt NoExtField body _ _ -> located body render
415+ LetStmt NoExtField binds -> do
375416 txt "let"
376417 space
377418 sitcc $ located binds p_hsLocalBinds
378419 ParStmt {} ->
379− -- NOTE 'ParStmt' should always be eliminated in 'gatherStmt' already,
380− -- such that it never occurs in 'p_stmt''. Consequently, handling it
381− -- here would be redundant.
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.
382423 notImplemented "ParStmt"
383− TransStmt {..} -> do
384− -- NOTE 'TransStmt' only needs to account for pretty printing itself,
385− -- since pretty printing of relevant statements (e.g., in 'trS_stmts')
386− -- is handled through 'gatherStmt'.
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'.
387428 case (trS_form, trS_by) of
388− (ThenForm, Nothing) -> located trS_using $ \x -> do
429+ (ThenForm, Nothing) -> do
389430 txt "then"
390431 breakpoint
391− inci (p_hsExpr x)
432+ inci $ located trS_using p_hsExpr
392433 (ThenForm, Just e) -> do
393− located trS_using $ \x -> do
394− txt "then"
395− breakpoint
396− inci (p_hsExpr x)
434+ txt "then"
397435 breakpoint
398− located e $ \x -> do
399− txt "by"
400− breakpoint
401− inci (p_hsExpr x)
402− (GroupForm, Nothing) -> located trS_using $ \x -> do
436+ inci $ located trS_using p_hsExpr
437+ breakpoint
438+ txt "by"
439+ breakpoint
440+ inci $ located e p_hsExpr
441+ (GroupForm, Nothing) -> do
403442 txt "then group using"
404443 breakpoint
405− inci (p_hsExpr x)
444+ inci $ located trS_using p_hsExpr
406445 (GroupForm, Just e) -> do
407− located e $ \x -> do
408− txt "then group by"
409− breakpoint
410− inci (p_hsExpr x)
446+ txt "then group by"
411447 breakpoint
412− located trS_using $ \x -> do
413− txt "using"
414− breakpoint
415− inci (p_hsExpr x)
448+ inci $ located e p_hsExpr
449+ breakpoint
450+ txt "using"
451+ breakpoint
452+ inci $ located trS_using p_hsExpr
416453 RecStmt {..} -> do
417454 txt "rec"
418455 space
419− sitcc $ sepSemi (located' (p_stmt' pretty)) recS_stmts
420− XStmtLR {} -> notImplemented "XStmtLR"
456+ sitcc $ sepSemi (withSpacing (p_stmt' placer render)) recS_stmts
457+ XStmtLR c -> noExtCon c
421458
422459gatherStmt :: ExprLStmt GhcPs -> [[ExprLStmt GhcPs]]
423−gatherStmt (L _ (ParStmt NoExt block _ _)) =
460+gatherStmt (L _ (ParStmt NoExtField block _ _)) =
424461 foldr ((<>) . gatherStmtBlock) [] block
425462gatherStmt (L s stmt@TransStmt {..}) =
426463 foldr liftAppend [] ((gatherStmt <$> trS_stmts) <> pure [[L s stmt]])
@@ -429,205 +466,230 @@ gatherStmt stmt = [[stmt]]
429466gatherStmtBlock :: ParStmtBlock GhcPs GhcPs -> [[ExprLStmt GhcPs]]
430467gatherStmtBlock (ParStmtBlock _ stmts _ _) =
431468 foldr (liftAppend . gatherStmt) [] stmts
432−gatherStmtBlock XParStmtBlock {} = notImplemented "XParStmtBlock"
469+gatherStmtBlock (XParStmtBlock x) = noExtCon x
433470
434471p_hsLocalBinds :: HsLocalBindsLR GhcPs GhcPs -> R ()
435472p_hsLocalBinds = \case
436− HsValBinds NoExt (ValBinds NoExt bag lsigs) -> do
437− let ssStart = either
438− (srcSpanStart . getLoc)
439− (srcSpanStart . getLoc)
440− items =
441− (Left <$> bagToList bag) ++ (Right <$> lsigs)
442− p_item (Left x) = located x p_valDecl
443− p_item (Right x) = located x p_sigDecl
444− -- Assigns 'False' to the last element, 'True' to the rest.
445− markInit :: [a] -> [(Bool, a)]
446− markInit [] = []
447− markInit (x:[]) = [(False, x)]
448− markInit (x:xs) = (True, x) : markInit xs
449− -- NOTE When in a single-line layout, there is a chance that the inner
473+ HsValBinds NoExtField (ValBinds NoExtField bag lsigs) -> do
474+ -- When in a single-line layout, there is a chance that the inner
450475 -- elements will also contain semicolons and they will confuse the
451476 -- parser. so we request braces around every element except the last.
452− br <- vlayout (return useBraces) (return id)
453− sitcc $ sepSemi
454− (\(m, i) -> (if m then br else id) $ p_item i)
455− (markInit $ sortOn ssStart items)
456− HsValBinds NoExt _ -> notImplemented "HsValBinds"
457− HsIPBinds NoExt (IPBinds NoExt xs) ->
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) ->
458494 -- Second argument of IPBind is always Left before type-checking.
459− let p_ipBind (IPBind NoExt (Left name) expr) = do
495+ let p_ipBind (IPBind NoExtField (Left name) expr) = do
460496 atom name
461497 space
462− txt "="
498+ equals
463499 breakpoint
464500 useBraces $ inci $ located expr p_hsExpr
465− p_ipBind _ = notImplemented "XHsIPBinds"
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
466505 in sepSemi (located' p_ipBind) xs
467− HsIPBinds NoExt _ -> notImplemented "HsIpBinds"
468− EmptyLocalBinds NoExt -> return ()
469− XHsLocalBindsLR _ -> notImplemented "XHsLocalBindsLR"
506+ HsIPBinds NoExtField _ -> notImplemented "HsIpBinds"
507+ EmptyLocalBinds NoExtField -> return ()
508+ XHsLocalBindsLR x -> noExtCon x
470509
471−p_hsRecField
472− :: HsRecField' RdrName (LHsExpr GhcPs)
473− -> R ()
474−p_hsRecField = \HsRecField {..} -> do
510+p_hsRecField ::
511+ HsRecField' RdrName (LHsExpr GhcPs) ->
512+ R ()
513+p_hsRecField HsRecField {..} = do
475514 p_rdrName hsRecFieldLbl
476515 unless hsRecPun $ do
477516 space
478− txt "="
479− let placement = exprPlacement (unLoc hsRecFieldArg)
480− placeHanging placement $ located hsRecFieldArg p_hsExpr
481−
482−p_hsTupArg :: HsTupArg GhcPs -> R ()
483−p_hsTupArg = \case
484− Present NoExt x -> located x p_hsExpr
485− Missing NoExt -> pure ()
486− XTupArg {} -> notImplemented "XTupArg"
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)
487523
488524p_hsExpr :: HsExpr GhcPs -> R ()
489−p_hsExpr = \case
490− HsVar NoExt name -> p_rdrName name
491− HsUnboundVar NoExt _ -> notImplemented "HsUnboundVar"
492− HsConLikeOut NoExt _ -> notImplemented "HsConLikeOut"
493− HsRecFld NoExt x ->
525+p_hsExpr = p_hsExpr' N
526+
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 ->
494533 case x of
495− Unambiguous NoExt name -> p_rdrName name
496− Ambiguous NoExt name -> p_rdrName name
497− XAmbiguousFieldOcc NoExt -> notImplemented "XAmbiguousFieldOcc"
498− HsOverLabel NoExt _ v -> do
534+ Unambiguous NoExtField name -> p_rdrName name
535+ Ambiguous NoExtField name -> p_rdrName name
536+ XAmbiguousFieldOcc xx -> noExtCon xx
537+ HsOverLabel NoExtField _ v -> do
499538 txt "#"
500539 atom v
501− HsIPVar NoExt (HsIPName name) -> do
540+ HsIPVar NoExtField (HsIPName name) -> do
502541 txt "?"
503542 atom name
504− HsOverLit NoExt v -> atom (ol_val v)
505− HsLit NoExt lit ->
543+ HsOverLit NoExtField v -> atom (ol_val v)
544+ HsLit NoExtField lit ->
506545 case lit of
507− HsString (SourceText s) _ -> p_stringLit s
508− HsStringPrim (SourceText s) _ -> p_stringLit s
546+ HsString (SourceText stxt) _ -> p_stringLit stxt
547+ HsStringPrim (SourceText stxt) _ -> p_stringLit stxt
509548 r -> atom r
510− HsLam NoExt mgroup ->
549+ HsLam NoExtField mgroup ->
511550 p_matchGroup Lambda mgroup
512− HsLamCase NoExt mgroup -> do
551+ HsLamCase NoExtField mgroup -> do
513552 txt "\\case"
514553 breakpoint
515554 inci (p_matchGroup LambdaCase mgroup)
516− HsApp NoExt f x -> do
517− -- We hang only the last function argument. In order to do
518− -- this, we only call 'placeHanging' on the topmost 'HsApp',
519− -- and then use 'p_withoutHanging' for the descendants.
520− let p_withoutHanging (HsApp NoExt f' x') = do
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 =
521560 case f' of
522− (L _ (HsApp _ _ _)) -> located f' p_withoutHanging
523− _ -> located f' p_hsExpr
524− breakpoint
525− inci $ located x' p_hsExpr
526− p_withoutHanging e = p_hsExpr e
527− -- Only use the hanging placement if the function spans
528− -- a single line.
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.
529572 placement =
530− if isOneLineSpan (getLoc f)
531− then exprPlacement (unLoc x)
532− else Normal
533− -- We only sit when the last expression is not hanging.
534− -- This is to allow:
535− -- f = foo bar do
536− -- baz
537− sit' = if placement == Normal
538− then sitcc
539− else id
540− sit' $ do
541− useBraces $ located f p_withoutHanging
542− placeHanging placement $
543− located x p_hsExpr
544− HsAppType a e -> do
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
545612 located e p_hsExpr
546613 breakpoint
547614 inci $ do
548615 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 ()
549621 located (hswc_body a) p_hsType
550− OpApp NoExt x op y -> do
622+ OpApp NoExtField x op y -> do
551623 let opTree = OpBranch (exprOpTree x) op (exprOpTree y)
552− getOpName = \case
553− HsVar NoExt (L _ a) -> Just a
554− _ -> Nothing
555− p_exprOpTree (reassociateOpTree getOpName opTree)
556− NegApp NoExt e _ -> do
624+ p_exprOpTree s (reassociateOpTree getOpName opTree)
625+ NegApp NoExtField e _ -> do
557626 txt "-"
558627 space
559628 located e p_hsExpr
560− HsPar NoExt e -> parens (located e p_hsExpr)
561− SectionL NoExt x op -> do
629+ HsPar NoExtField e ->
630+ parens s (located e (dontUseBraces . p_hsExpr))
631+ SectionL NoExtField x op -> do
562632 located x p_hsExpr
563633 breakpoint
564634 inci (located op p_hsExpr)
565− SectionR NoExt op x -> do
635+ SectionR NoExtField op x -> do
566636 located op p_hsExpr
567− breakpoint
637+ useRecordDot' <- useRecordDot
638+ let isRecordDot' = isRecordDot (unLoc op) (getLoc x)
639+ unless (useRecordDot' && isRecordDot') breakpoint
568640 inci (located x p_hsExpr)
569− ExplicitTuple NoExt args boxity -> do
641+ ExplicitTuple NoExtField args boxity ->
570642 let isSection = any (isMissing . unLoc) args
571643 isMissing = \case
572− Missing NoExt -> True
644+ Missing NoExtField -> True
573645 _ -> False
574− let parens' =
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' =
575652 case boxity of
576653 Boxed -> parens
577654 Unboxed -> parensHash
578− if isSection
579− then switchLayout [] . parens' $
580− sep comma (located' p_hsTupArg) args
581− else switchLayout (getLoc <$> args) . parens' . sitcc $
582− sep (comma >> breakpoint) (sitcc . located' p_hsTupArg) args
583− ExplicitSum NoExt tag arity e ->
584− p_unboxedSum tag arity (located e p_hsExpr)
585− HsCase NoExt e mgroup -> do
586− txt "case"
587− space
588− located e p_hsExpr
589− space
590− txt "of"
591− breakpoint
592− inci (p_matchGroup Case mgroup)
593− HsIf NoExt _ if' then' else' -> do
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
594669 txt "if"
595− space
596− located if' p_hsExpr
597670 breakpoint
598− inci $ do
599− txt "then"
600− located then' $ \x ->
601− placeHanging (exprPlacement x) (p_hsExpr x)
602− breakpoint
603− txt "else"
604− located else' $ \x ->
605− placeHanging (exprPlacement x) (p_hsExpr x)
606− HsMultiIf NoExt guards -> do
607− txt "if"
608− breakpoint
609− inci . sitcc $ sep newline (located' (p_grhs RightArrow)) guards
610− HsLet NoExt localBinds e -> sitcc $ do
611− txt "let"
612− space
613− dontUseBraces $ sitcc (located localBinds p_hsLocalBinds)
614− vlayout space (newline >> txt " ")
615− txt "in"
616− space
617− sitcc (located e p_hsExpr)
618− HsDo NoExt ctx es -> do
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
619675 let doBody header = do
620676 txt header
621677 breakpoint
622− ub <- vlayout (return useBraces) (return id)
623− inci $ sepSemi (located' (ub . p_stmt)) (unLoc es)
624− compBody = brackets $ located es $ \xs -> do
625− let p_parBody = sep
626− (breakpoint >> txt "| ")
627− p_seqBody
628− p_seqBody = sitcc . sep
629− (comma >> breakpoint)
630− (located' (sitcc . p_stmt))
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))
631693 stmts = init xs
632694 yield = last xs
633695 lists = foldr (liftAppend . gatherStmt) [] stmts
@@ -641,90 +703,100 @@ p_hsExpr = \case
641703 MDoExpr -> doBody "mdo"
642704 ListComp -> compBody
643705 MonadComp -> notImplemented "MonadComp"
644− ArrowExpr -> notImplemented "ArrowExpr"
706+ ArrowExpr -> notImplemented "ArrowExpr"
645707 GhciStmtCtxt -> notImplemented "GhciStmtCtxt"
646708 PatGuard _ -> notImplemented "PatGuard"
647709 ParStmtCtxt _ -> notImplemented "ParStmtCtxt"
648710 TransStmtCtxt _ -> notImplemented "TransStmtCtxt"
649711 ExplicitList _ _ xs ->
650− brackets . sitcc $ sep (comma >> breakpoint) (sitcc . located' p_hsExpr) xs
712+ brackets s $
713+ sep commaDel (sitcc . located' p_hsExpr) xs
651714 RecordCon {..} -> do
652715 located rcon_con_name atom
653716 breakpoint
654717 let HsRecFields {..} = rcon_flds
655− updName f = f {
656− hsRecFieldLbl = case unLoc $ hsRecFieldLbl f of
657− FieldOcc _ n -> n
658− XFieldOcc _ -> notImplemented "XFieldOcc"
659− }
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+ }
660724 fields = located' (p_hsRecField . updName) <$> rec_flds
661725 dotdot =
662726 case rec_dotdot of
663727 Just {} -> [txt ".."]
664728 Nothing -> []
665− inci . braces . sitcc $ sep (comma >> breakpoint) sitcc (fields <> dotdot)
729+ inci . braces N $
730+ sep commaDel sitcc (fields <> dotdot)
666731 RecordUpd {..} -> do
667732 located rupd_expr p_hsExpr
668− breakpoint
669− let updName f = f {
670− hsRecFieldLbl = case unLoc $ hsRecFieldLbl f of
671− Ambiguous _ n -> n
672− Unambiguous _ n -> n
673− XAmbiguousFieldOcc _ -> notImplemented "XAmbiguousFieldOcc"
674− }
675− inci . braces . sitcc $
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 $
676749 sep
677− (comma >> breakpoint)
750+ commaDel
678751 (sitcc . located' (p_hsRecField . updName))
679752 rupd_flds
680− ExprWithTySig affix x -> sitcc $ do
753+ ExprWithTySig NoExtField x HsWC {hswc_body = HsIB {..}} -> sitcc $ do
681754 located x p_hsExpr
755+ space
756+ txt "::"
682757 breakpoint
683− inci $ do
684− txt "::"
685− space
686− let HsWC {..} = affix
687− HsIB {..} = hswc_body
688− located hsib_body p_hsType
689− ArithSeq NoExt _ x -> do
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 ->
690762 case x of
691− From from -> brackets . sitcc $ do
763+ From from -> brackets s $ do
692764 located from p_hsExpr
693765 breakpoint
694766 txt ".."
695− FromThen from next -> brackets . sitcc $ do
696− sitcc $ sep (comma >> breakpoint) (located' p_hsExpr) [from, next]
767+ FromThen from next -> brackets s $ do
768+ sep commaDel (located' p_hsExpr) [from, next]
697769 breakpoint
698770 txt ".."
699− FromTo from to -> brackets . sitcc $ do
771+ FromTo from to -> brackets s $ do
700772 located from p_hsExpr
701773 breakpoint
702774 txt ".."
703775 space
704776 located to p_hsExpr
705− FromThenTo from next to -> brackets . sitcc $ do
706− sitcc $ sep (comma >> breakpoint) (located' p_hsExpr) [from, next]
777+ FromThenTo from next to -> brackets s $ do
778+ sep commaDel (located' p_hsExpr) [from, next]
707779 breakpoint
708780 txt ".."
709781 space
710782 located to p_hsExpr
711− HsSCC NoExt _ name x -> do
783+ HsSCC NoExtField _ name x -> do
712784 txt "{-# SCC "
713785 atom name
714786 txt " #-}"
715787 breakpoint
716788 located x p_hsExpr
717− HsCoreAnn NoExt _ value x -> do
789+ HsCoreAnn NoExtField _ value x -> do
718790 txt "{-# CORE "
719791 atom value
720792 txt " #-}"
721793 breakpoint
722794 located x p_hsExpr
723− HsBracket NoExt x -> p_hsBracket x
795+ HsBracket NoExtField x -> p_hsBracket x
724796 HsRnBracketOut {} -> notImplemented "HsRnBracketOut"
725797 HsTcBracketOut {} -> notImplemented "HsTcBracketOut"
726− HsSpliceE NoExt splice -> p_hsSplice splice
727− HsProc NoExt p e -> do
798+ HsSpliceE NoExtField splice -> p_hsSplice splice
799+ HsProc NoExtField p e -> do
728800 txt "proc"
729801 located p $ \x -> do
730802 breakpoint
@@ -733,65 +805,46 @@ p_hsExpr = \case
733805 txt "->"
734806 placeHanging (cmdTopPlacement (unLoc e)) $
735807 located e p_hsCmdTop
736− HsStatic _ e -> do
808+ HsStatic _ e -> do
737809 txt "static"
738810 breakpoint
739811 inci (located e p_hsExpr)
740− HsArrApp NoExt body input arrType cond ->
741− p_hsCmd (HsCmdArrApp NoExt body input arrType cond)
742− HsArrForm NoExt form mfixity cmds ->
743− p_hsCmd (HsCmdArrForm NoExt form Prefix mfixity cmds)
744812 HsTick {} -> notImplemented "HsTick"
745813 HsBinTick {} -> notImplemented "HsBinTick"
746814 HsTickPragma {} -> notImplemented "HsTickPragma"
747− -- These four constructs should never appear in correct programs.
748− -- See: https://github.com/tweag/ormolu/issues/343
749− EWildPat NoExt -> txt "_"
750− EAsPat NoExt n p -> do
751− p_rdrName n
752− txt "@"
753− located p p_hsExpr
754− EViewPat NoExt p e -> do
755− located p p_hsExpr
756− space
757− txt "->"
758− breakpoint
759− inci (located e p_hsExpr)
760− ELazyPat NoExt p -> do
761− txt "~"
762− located p p_hsExpr
763815 HsWrap {} -> notImplemented "HsWrap"
764− XExpr {} -> notImplemented "XExpr"
816+ XExpr x -> noExtCon x
765817
766818p_patSynBind :: PatSynBind GhcPs GhcPs -> R ()
767819p_patSynBind PSB {..} = do
768− let rhs = case psb_dir of
769− Unidirectional -> do
770− txt "<-"
771− space
772− located psb_def p_pat
773− ImplicitBidirectional -> do
774− txt "="
775− space
776− located psb_def p_pat
777− ExplicitBidirectional mgroup -> do
778− txt "<-"
779− space
780− located psb_def p_pat
781− newline
782− txt "where"
783− newline
784− inci (p_matchGroup (Function psb_id) mgroup)
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)
785839 txt "pattern"
786840 case psb_args of
787841 PrefixCon xs -> do
788842 space
789843 p_rdrName psb_id
790− inci $ do
844+ inci $ do
791845 switchLayout (getLoc <$> xs) $ do
792846 unless (null xs) breakpoint
793847 sitcc (sep breakpoint p_rdrName xs)
794− breakpoint
795848 rhs
796849 RecCon xs -> do
797850 space
@@ -799,9 +852,8 @@ p_patSynBind PSB {..} = do
799852 inci $ do
800853 switchLayout (getLoc . recordPatSynPatVar <$> xs) $ do
801854 unless (null xs) breakpoint
802− braces . sitcc $
803− sep (comma >> breakpoint) (p_rdrName . recordPatSynPatVar) xs
804− breakpoint
855+ braces N $
856+ sep commaDel (p_rdrName . recordPatSynPatVar) xs
805857 rhs
806858 InfixCon l r -> do
807859 switchLayout [getLoc l, getLoc r] $ do
@@ -812,37 +864,100 @@ p_patSynBind PSB {..} = do
812864 p_rdrName psb_id
813865 space
814866 p_rdrName r
815− inci $ do
816− breakpoint
817− rhs
818−p_patSynBind (XPatSynBind NoExt) = notImplemented "XPatSynBind"
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)
819934
820935p_pat :: Pat GhcPs -> R ()
821936p_pat = \case
822− WildPat NoExt -> txt "_"
823− VarPat NoExt name -> p_rdrName name
824− LazyPat NoExt pat -> do
937+ WildPat NoExtField -> txt "_"
938+ VarPat NoExtField name -> p_rdrName name
939+ LazyPat NoExtField pat -> do
825940 txt "~"
826941 located pat p_pat
827− AsPat NoExt name pat -> do
942+ AsPat NoExtField name pat -> do
828943 p_rdrName name
829944 txt "@"
830945 located pat p_pat
831− ParPat NoExt pat ->
832− located pat (parens . p_pat)
833− BangPat NoExt pat -> do
946+ ParPat NoExtField pat ->
947+ located pat (parens S . p_pat)
948+ BangPat NoExtField pat -> do
834949 txt "!"
835950 located pat p_pat
836− ListPat NoExt pats -> do
837− brackets . sitcc $ sep (comma >> breakpoint) (located' p_pat) pats
838− TuplePat NoExt pats boxing -> do
839− let f =
951+ ListPat NoExtField pats ->
952+ brackets S $ sep commaDel (located' p_pat) pats
953+ TuplePat NoExtField pats boxing -> do
954+ let parens' =
840955 case boxing of
841− Boxed -> parens
842− Unboxed -> parensHash
843− f . sitcc $ sep (comma >> breakpoint) (sitcc . located' p_pat) pats
844− SumPat NoExt pat tag arity ->
845− p_unboxedSum tag arity (located pat p_pat)
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)
846961 ConPatIn pat details ->
847962 case details of
848963 PrefixCon xs -> sitcc $ do
@@ -856,37 +971,40 @@ p_pat = \case
856971 let f = \case
857972 Nothing -> txt ".."
858973 Just x -> located x p_pat_hsRecField
859− inci . braces . sitcc . sep (comma >> breakpoint) f $ case dotdot of
860− Nothing -> Just <$> fields
861− Just n -> (Just <$> take n fields) ++ [Nothing]
862− InfixCon x y -> do
863− located x p_pat
864− space
865− p_rdrName pat
866− breakpoint
867− inci (located y p_pat)
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
868986 ConPatOut {} -> notImplemented "ConPatOut" -- presumably created by renamer?
869− ViewPat NoExt expr pat -> sitcc $ do
987+ ViewPat NoExtField expr pat -> sitcc $ do
870988 located expr p_hsExpr
871989 space
872990 txt "->"
873991 breakpoint
874992 inci (located pat p_pat)
875− SplicePat NoExt splice -> p_hsSplice splice
876− LitPat NoExt p -> atom p
877− NPat NoExt v _ _ -> located v (atom . ol_val)
878− NPlusKPat NoExt n k _ _ _ -> sitcc $ do
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
879997 p_rdrName n
880998 breakpoint
881999 inci $ do
8821000 txt "+"
8831001 space
8841002 located k (atom . ol_val)
885− SigPat hswc pat -> do
1003+ SigPat NoExtField pat hswc -> do
8861004 located pat p_pat
8871005 p_typeAscription hswc
8881006 CoPat {} -> notImplemented "CoPat" -- apparently created at some later stage
889− XPat NoExt -> notImplemented "XPat"
1007+ XPat x -> noExtCon x
8901008
8911009p_pat_hsRecField :: HsRecField' (FieldOcc GhcPs) (LPat GhcPs) -> R ()
8921010p_pat_hsRecField HsRecField {..} = do
@@ -894,51 +1012,53 @@ p_pat_hsRecField HsRecField {..} = do
8941012 p_rdrName (rdrNameFieldOcc x)
8951013 unless hsRecPun $ do
8961014 space
897− txt "="
1015+ equals
8981016 breakpoint
8991017 inci (located hsRecFieldArg p_pat)
9001018
901−p_unboxedSum :: ConTag -> Arity -> R () -> R ()
902−p_unboxedSum tag arity m = do
1019+p_unboxedSum :: BracketStyle -> ConTag -> Arity -> R () -> R ()
1020+p_unboxedSum s tag arity m = do
9031021 let before = tag - 1
9041022 after = arity - before - 1
9051023 args = replicate before Nothing <> [Just m] <> replicate after Nothing
906− f (x,i) = do
907− let isFirst = i == 0
908− isLast = i == arity - 1
1024+ f x =
9091025 case x :: Maybe (R ()) of
9101026 Nothing ->
911− unless (isFirst || isLast) space
1027+ space
9121028 Just m' -> do
913− unless isFirst space
1029+ space
9141030 m'
915− unless isLast space
916− parensHash $ sep (txt "|") f (zip args [0..])
1031+ space
1032+ parensHash s $ sep (txt "|") f args
9171033
9181034p_hsSplice :: HsSplice GhcPs -> R ()
9191035p_hsSplice = \case
920− HsTypedSplice NoExt deco _ expr -> p_hsSpliceTH True expr deco
921− HsUntypedSplice NoExt deco _ expr -> p_hsSpliceTH False expr deco
922− HsQuasiQuote NoExt _ quoterName srcSpan str -> do
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
9231039 txt "["
9241040 p_rdrName (L srcSpan quoterName)
9251041 txt "|"
926− -- NOTE QuasiQuoters often rely on precise custom strings. We cannot do
927− -- any formatting here without potentially breaking someone's code.
1042+ -- QuasiQuoters often rely on precise custom strings. We cannot do any
1043+ -- formatting here without potentially breaking someone's code.
9281044 atom str
9291045 txt "|]"
9301046 HsSpliced {} -> notImplemented "HsSpliced"
931− XSplice {} -> notImplemented "XSplice"
1047+ HsSplicedT {} -> notImplemented "HsSplicedT"
1048+ XSplice x -> noExtCon x
9321049
933−p_hsSpliceTH
934− :: Bool -- ^ Typed splice?
935− -> LHsExpr GhcPs -- ^ Splice expression
936− -> SpliceDecoration -- ^ Splice decoration
937− -> R ()
1050+p_hsSpliceTH ::
1051+ -- | Typed splice?
1052+ Bool ->
1053+ -- | Splice expression
1054+ LHsExpr GhcPs ->
1055+ -- | Splice decoration
1056+ SpliceDecoration ->
1057+ R ()
9381058p_hsSpliceTH isTyped expr = \case
9391059 HasParens -> do
9401060 txt decoSymbol
941− parens (located expr (sitcc . p_hsExpr))
1061+ parens N (located expr (sitcc . p_hsExpr))
9421062 HasDollar -> do
9431063 txt decoSymbol
9441064 located expr (sitcc . p_hsExpr)
@@ -949,17 +1069,17 @@ p_hsSpliceTH isTyped expr = \case
9491069
9501070p_hsBracket :: HsBracket GhcPs -> R ()
9511071p_hsBracket = \case
952− ExpBr NoExt expr -> do
1072+ ExpBr NoExtField expr -> do
9531073 anns <- getEnclosingAnns
9541074 let name = case anns of
955− AnnOpenEQ:_ -> ""
1075+ AnnOpenEQ : _ -> ""
9561076 _ -> "e"
9571077 quote name (located expr p_hsExpr)
958− PatBr NoExt pat -> quote "p" (located pat p_pat)
959− DecBrL NoExt decls -> quote "d" (p_hsDecls Free decls)
960− DecBrG NoExt _ -> notImplemented "DecBrG" -- result of renamer
961− TypBr NoExt ty -> quote "t" (located ty p_hsType)
962− VarBr NoExt isSingleQuote name -> do
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
9631083 txt (bool "''" "'" isSingleQuote)
9641084 -- HACK As you can see we use 'noLoc' here to be able to pass name into
9651085 -- 'p_rdrName' since the latter expects a "located" thing. The problem
@@ -967,19 +1087,20 @@ p_hsBracket = \case
9671087 -- turn makes it impossible to detect if there are parentheses around
9681088 -- it, etc. So we have to add parentheses manually assuming they are
9691089 -- necessary for all operators.
970− let isOperator = all
971− (\i -> isPunctuation i || isSymbol i)
972− (showOutputable (rdrNameOcc name))
973− && not (doesNotNeedExtraParens name)
974− wrapper = if isOperator then parens else id
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
9751096 wrapper $ p_rdrName (noLoc name)
976− TExpBr NoExt expr -> do
1097+ TExpBr NoExtField expr -> do
9771098 txt "[||"
9781099 breakpoint'
9791100 located expr p_hsExpr
9801101 breakpoint'
9811102 txt "||]"
982− XBracket {} -> notImplemented "XBracket"
1103+ XBracket x -> noExtCon x
9831104 where
9841105 quote :: Text -> R () -> R ()
9851106 quote name body = do
@@ -1003,50 +1124,54 @@ p_stringLit src =
10031124 multiLine =
10041125 sitcc $ sep breakpoint (txt . Text.pack) (backslashes s)
10051126 in vlayout singleLine multiLine
1006− where
1007− -- Split a string on gaps (backslash delimited whitespaces)
1008− --
1009− -- > splitGaps "bar\\ \\fo\\&o" == ["bar", "fo\\&o"]
1010− splitGaps :: String -> [String]
1011− splitGaps "" = []
1012− splitGaps s =
1013− let -- A backslash and a whitespace starts a "gap"
1014− p (Just '\\', _, _) = True
1015− p (_, '\\', Just c) | ghcSpace c = False
1016− p _ = True
1017− in case span p (zipPrevNext s) of
1018− (l, r) ->
1019− let -- drop the initial '\', any amount of 'ghcSpace', and another '\'
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 '\'
10201141 r' = drop 1 . dropWhile ghcSpace . drop 1 $ map orig r
1021− in map orig l : splitGaps r'
1022−
1023− -- GHC's definition of whitespaces in strings
1024− -- See: https://gitlab.haskell.org/ghc/ghc/blob/86753475/compiler/parser/Lexer.x#L1653
1025− ghcSpace :: Char -> Bool
1026− ghcSpace c = c <= '\x7f' && is_space c
1027−
1028− -- Add backslashes to the inner side of the strings
1029− --
1030− -- > backslashes ["a", "b", "c"] == ["a\\", "\\b\\", "\\c"]
1031− backslashes :: [String] -> [String]
1032− backslashes (x:y:xs) = (x ++ "\\") : backslashes (('\\' : y) : xs)
1033− backslashes xs = xs
1034−
1035− -- Attaches previous and next items to each list element
1036− zipPrevNext :: [a] -> [(Maybe a, a, Maybe a)]
1037− zipPrevNext xs =
1038− let z = zip (zip (Nothing : map Just xs) xs)
1039− (map Just (tail xs) ++ repeat Nothing)
1040− in map (\((p, x), n) -> (p, x, n)) z
1041−
1042− orig (_, x, _) = x
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
10431162
10441163----------------------------------------------------------------------------
10451164-- Helpers
10461165
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+
10471173-- | Append each element in both lists with semigroups. If one list is shorter
10481174-- than the other, return the rest of the longer list unchanged.
1049−
10501175liftAppend :: Semigroup a => [a] -> [a] -> [a]
10511176liftAppend [] [] = []
10521177liftAppend [] (y : ys) = y : ys
@@ -1054,14 +1179,13 @@ liftAppend (x : xs) [] = x : xs
10541179liftAppend (x : xs) (y : ys) = x <> y : liftAppend xs ys
10551180
10561181getGRHSSpan :: GRHS GhcPs (Located body) -> SrcSpan
1057−getGRHSSpan (GRHS NoExt guards body) =
1182+getGRHSSpan (GRHS NoExtField guards body) =
10581183 combineSrcSpans' $ getLoc body :| map getLoc guards
1059−getGRHSSpan (XGRHS NoExt) = notImplemented "XGRHS"
1184+getGRHSSpan (XGRHS x) = noExtCon x
10601185
10611186-- | Place a thing that may have a hanging form. This function handles how
10621187-- to separate it from preceding expressions and whether to bump indentation
10631188-- depending on what sort of expression we have.
1064−
10651189placeHanging :: Placement -> R () -> R ()
10661190placeHanging placement m =
10671191 case placement of
@@ -1074,102 +1198,165 @@ placeHanging placement m =
10741198
10751199-- | Check if given block contains single expression which has a hanging
10761200-- form.
1077−
1078−blockPlacement
1079− :: (body -> Placement)
1080− -> [LGRHS GhcPs (Located body)]
1081− -> Placement
1082−blockPlacement placer [(L _ (GRHS NoExt _ (L _ x)))] = placer x
1201+blockPlacement ::
1202+ (body -> Placement) ->
1203+ [LGRHS GhcPs (Located body)] ->
1204+ Placement
1205+blockPlacement placer [L _ (GRHS NoExtField _ (L _ x))] = placer x
10831206blockPlacement _ _ = Normal
10841207
10851208-- | Check if given command has a hanging form.
1086−
10871209cmdPlacement :: HsCmd GhcPs -> Placement
10881210cmdPlacement = \case
1089− HsCmdLam NoExt _ -> Hanging
1090− HsCmdCase NoExt _ _ -> Hanging
1091− HsCmdDo NoExt _ -> Hanging
1211+ HsCmdLam NoExtField _ -> Hanging
1212+ HsCmdCase NoExtField _ _ -> Hanging
1213+ HsCmdDo NoExtField _ -> Hanging
10921214 _ -> Normal
10931215
10941216cmdTopPlacement :: HsCmdTop GhcPs -> Placement
10951217cmdTopPlacement = \case
1096− HsCmdTop NoExt (L _ x) -> cmdPlacement x
1097− XCmdTop {} -> notImplemented "XCmdTop"
1218+ HsCmdTop NoExtField (L _ x) -> cmdPlacement x
1219+ XCmdTop x -> noExtCon x
10981220
10991221-- | Check if given expression has a hanging form.
1100−
11011222exprPlacement :: HsExpr GhcPs -> Placement
11021223exprPlacement = \case
11031224 -- Only hang lambdas with single line parameter lists
1104− HsLam NoExt mg -> case mg of
1105− MG _ (L _ [L _ (Match NoExt _ (x:xs) _)]) _
1106− | isOneLineSpan (combineSrcSpans' $ fmap getLoc (x :| xs))
1107− -> Hanging
1225+ HsLam NoExtField mg -> case mg of
1226+ MG _ (L _ [L _ (Match NoExtField _ (x : xs) _)]) _
1227+ | isOneLineSpan (combineSrcSpans' $ fmap getLoc (x :| xs)) ->
1228+ Hanging
11081229 _ -> Normal
1109− HsLamCase NoExt _ -> Hanging
1110− HsCase NoExt _ _ -> Hanging
1111− HsDo NoExt DoExpr _ -> Hanging
1112− HsDo NoExt MDoExpr _ -> Hanging
1113− RecordCon NoExt _ _ -> Hanging
1114− -- If the rightmost expression in an operator chain is hanging, make the
1115− -- whole block hanging; so that we can use the common @f = foo $ do@
1116− -- style.
1117− OpApp NoExt _ _ y -> exprPlacement (unLoc y)
1118− -- Same thing for function applications (usually with -XBlockArguments)
1119− HsApp NoExt _ y -> exprPlacement (unLoc y)
1120− HsProc NoExt (L s _) _ ->
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 _ ->
11211240 -- Indentation breaks if pattern is longer than one line and left
11221241 -- hanging. Consequently, only apply hanging when it is safe.
1123− if isOneLineSpan s
1124− then Hanging
1125− else Normal
1242+ if isOneLineSpan (getLoc p)
1243+ then Hanging
1244+ else Normal
11261245 _ -> Normal
11271246
11281247withGuards :: [LGRHS GhcPs (Located body)] -> Bool
11291248withGuards = any (checkOne . unLoc)
11301249 where
11311250 checkOne :: GRHS GhcPs (Located body) -> Bool
1132− checkOne (GRHS NoExt [] _) = False
1251+ checkOne (GRHS NoExtField [] _) = False
11331252 checkOne _ = True
11341253
11351254exprOpTree :: LHsExpr GhcPs -> OpTree (LHsExpr GhcPs) (LHsExpr GhcPs)
1136−exprOpTree (L _ (OpApp NoExt x op y)) = OpBranch (exprOpTree x) op (exprOpTree y)
1255+exprOpTree (L _ (OpApp NoExtField x op y)) = OpBranch (exprOpTree x) op (exprOpTree y)
11371256exprOpTree n = OpNode n
11381257
1139−p_exprOpTree :: OpTree (LHsExpr GhcPs) (LHsExpr GhcPs) -> R ()
1140−p_exprOpTree (OpNode x) = located x p_hsExpr
1141−p_exprOpTree (OpBranch x op y) = do
1142− -- NOTE If the beginning of the first argument and the second argument
1143− -- are on the same line, and the second argument has a hanging form, use
1144− -- hanging placement.
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.
11451276 let placement =
11461277 if isOneLineSpan
1147− (mkSrcSpan (srcSpanStart (opTreeLoc x)) (srcSpanStart (opTreeLoc y)))
1278+ (mkSrcSpan (srcSpanStart (opTreeLoc x)) (srcSpanStart (opTreeLoc y)))
11481279 then case y of
1149− OpNode (L _ n) -> exprPlacement n
1150− _ -> Normal
1280+ OpNode (L _ n) -> exprPlacement n
1281+ _ -> Normal
11511282 else Normal
1283+ -- Distinguish holes used in infix notation.
1284+ -- eg. '1 _foo 2' and '1 `_foo` 2'
11521285 opWrapper = case unLoc op of
1153− EWildPat NoExt -> backticks
1286+ HsUnboundVar NoExtField _ -> backticks
11541287 _ -> id
1155− ub <- vlayout
1156− (return useBraces)
1157− (return $ case placement of
1158− Hanging -> useBraces
1159− Normal -> dontUseBraces)
1160− switchLayout [opTreeLoc x] $
1161− ub $ p_exprOpTree x
1162− placeHanging placement $ do
1163− located op (opWrapper . p_hsExpr)
1164− space
1165− switchLayout [opTreeLoc y] $
1166− p_exprOpTree y
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
11671342
1168−-- | Get annotations for the enclosing element.
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
11691355
1356+-- | Get annotations for the enclosing element.
11701357getEnclosingAnns :: R [AnnKeywordId]
11711358getEnclosingAnns = do
11721359 e <- getEnclosingSpan (const True)
11731360 case e of
11741361 Nothing -> return []
1175− Just e' -> getAnns (RealSrcSpan e')
1362+ Just e' -> getAnns (RealSrcSpan e')