f9842f5 · ormolu · git.iko.soy

git.iko.soy/ormolu

Add newlines between most declarations in a type class instance

Certain other kinds of declarations, such as instance signatures (e.g., from `InstanceSigs`) and bindings, are grouped together without newlines. The process for determining which declarations are grouped reuses the same logic as for modules and type classes.

commitf9842f5942e149f0b7f1bc3531857386c78bf383 authoryumiova <yumiova@protonmail.ch> dateThu 27 Jun 2019, 19:46 (7 years ago) parent3c506ec

9 files changed+46−22

compare with master

unifiedsplit

data/examples/declaration/instance/associated-data-out.hs+4

@@ -1,15 +1,19 @@

11{-# LANGUAGE TypeFamilies #-}

22instance Foo Int where

34 data Bar Int = IntBar Int Int

56instance Foo Double where

68 newtype Bar Double

79 = DoubleBar

810 Double

911 Double

1012

1113instance Foo [a] where

14+

1215 data Bar [a]

1316 = ListBar [Bar a]

17+

1418 data Baz [a]

1519 = ListBaz

data/examples/declaration/instance/associated-types-out.hs+3

@@ -1,12 +1,15 @@

11{-# LANGUAGE TypeFamilies #-}

22instance Foo Int where

34 type Bar Int = Double

56instance Foo Double where

68 type

79 Bar

810 Double =

911 [Double]

12+

1013 type

1114 Baz Double =

1215 [Double]

data/examples/declaration/instance/contexts-out.hs+2

@@ -1,4 +1,5 @@

11instance Eq a => Eq [a] where

23 (==) _ _ = False

45instance ( Ord a

@@ -6,4 +7,5 @@ instance ( Ord a

67 )

78 => Ord

89 (a, b) where

10+

911 compare _ _ = GT

data/examples/declaration/instance/instance-sigs-out.hs+4

@@ -1,9 +1,11 @@

11{-# LANGUAGE InstanceSigs #-}

22instance Eq Int where

34 (==) :: Int -> Int -> Bool

45 (==) _ _ = False

67instance Ord Int where

79 compare

810 :: Int

911 -> Int

@@ -14,10 +16,12 @@ instance Ord Int where

1416 GT

1517

1618instance Applicative [] where

19+

1720 pure

1821 :: a

1922 -> [a]

2023 pure a = [a]

24+

2125 (<*>)

2226 :: [a] -> [a] -> [a]

2327 (<*>) _ _ = []

data/examples/declaration/instance/multi-parameter-out.hs+3

@@ -1,6 +1,9 @@

11instance MonadReader a ((->) a) where

23 ask = id

45instance MonadState s (State s) where

57 get = State.get

69 put = State.put

data/examples/declaration/instance/overlappable-instances-out.hs+4

@@ -1,11 +1,15 @@

11instance {-# OVERLAPPABLE #-} Eq Int where

23 (==) _ _ = False

45instance {-# OVERLAPPING #-} Ord Int where

57 compare _ _ = GT

79instance {-# OVERLAPS #-} Eq Double where

10+

811 (==) _ _ = False

912

1013instance {-# INCOHERENT #-} Ord Double where

14+

1115 compare _ _ = GT

data/examples/declaration/instance/single-parameter-out.hs+3

@@ -1,7 +1,10 @@

11instance Monoid Int where

23 (<>) x y = x + y

45instance Enum Int where

57 fromEnum x = x

69 toEnum = \x ->

710 x

data/examples/declaration/signature/specialize/specialize-instance-out.hs+4

@@ -3,12 +3,16 @@ data Foo a = Foo a

33data VT v m r = VT v m r

55instance (Eq a) => Eq (Foo a) where

67 {-# SPECIALIZE instance Eq (Foo [(Int, Bar)]) #-}

79 (==) (Foo a) (Foo b) = (==) a b

810

911instance (Num r, V.Vector v r, Factored m r) => Num (VT v m r) where

12+

1013 {-# SPECIALIZE instance

1114 ( Factored m Int => Num (VT U.Vector m Int)

1215 )

1316 #-}

17+

1418 VT x + VT y = VT $ V.zipWith (+) x y

src/Ormolu/Printer/Meat/Declaration/Instance.hs+19−22

@@ -15,17 +15,16 @@ where

1515import BasicTypes

1616import Control.Arrow

1717import Data.Foldable

18−import Data.Function

1918import Data.List (sortBy)

19+import Data.Ord (comparing)

2020import GHC

2121import Ormolu.Printer.Combinators

2222import Ormolu.Printer.Meat.Common

2323import Ormolu.Printer.Meat.Declaration.Data

24−import Ormolu.Printer.Meat.Declaration.Signature

2524import Ormolu.Printer.Meat.Declaration.TypeFamily

26−import Ormolu.Printer.Meat.Declaration.Value

2725import Ormolu.Printer.Meat.Type

2826import Ormolu.Utils

27+import {-# SOURCE #-} Ormolu.Printer.Meat.Declaration

2928

3029p_standaloneDerivDecl :: DerivDecl GhcPs -> R ()

3130p_standaloneDerivDecl DerivDecl {..} = do

@@ -75,26 +74,24 @@ p_clsInstDecl = \case

7574 -- location order. This happens because different declarations are stored in

7675 -- different lists. Consequently, to get all the declarations in proper

7776 -- order, they need to be manually sorted.

78− let binds = (getLoc &&& located' p_valDecl) <$> cid_binds

79− sigs = (getLoc &&& located' p_sigDecl) <$> cid_sigs

80− tyfam_insts =

81− (getLoc &&& located' (p_tyFamInstDecl Associated)) <$>

82− cid_tyfam_insts

83− datafam_insts =

84− (getLoc &&& located' (p_dataFamInstDecl Associated)) <$>

85− cid_datafam_insts

86− decls =

77+ let sigs = (getLoc &&& fmap (SigD NoExt)) <$> cid_sigs

78+ vals = (getLoc &&& fmap (ValD NoExt)) <$> toList cid_binds

79+ tyFamInsts =

80+ ( getLoc &&& fmap (InstD NoExt . TyFamInstD NoExt)

81+ ) <$> cid_tyfam_insts

82+ dataFamInsts =

83+ ( getLoc &&& fmap (InstD NoExt . DataFamInstD NoExt)

84+ ) <$> cid_datafam_insts

85+ allDecls =

8786 snd <$>

88− sortBy

89− (compare `on` fst)

90− (toList binds <> sigs <> tyfam_insts <> datafam_insts)

91− if not (null decls)

92− then do

93− txt " where"

94− newline

95− inci (sequence_ decls)

96− else do

97− newline

87+ sortBy (comparing fst) (sigs <> vals <> tyFamInsts <> dataFamInsts)

88+ if not (null allDecls)

89+ then do

90+ txt " where"

91+ newline -- Ensure line is added after where clause.

92+ newline -- Add newline before first declaration.

93+ inci (p_hsDecls Associated allDecls)

94+ else newline

9895 XClsInstDecl NoExt -> notImplemented "XClsInstDecl"

9996

10097p_tyFamInstDecl :: FamilyStyle -> TyFamInstDecl GhcPs -> R ()