{-# LANGUAGE LambdaCase #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE PatternSynonyms #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE ViewPatterns #-}

-- | Rendering of declarations.
module Ormolu.Printer.Meat.Declaration
  ( p_hsDecls,
    p_hsDeclsRespectGrouping,
  )
where

import Data.List (sort)
import Data.List.NonEmpty (NonEmpty (..), (<|))
import qualified Data.List.NonEmpty as NE
import GHC.Hs
import GHC.Types.Name.Occurrence (occNameFS)
import GHC.Types.Name.Reader
import GHC.Types.SrcLoc
import Ormolu.Config (SourceType (SignatureSource))
import Ormolu.Printer.Combinators
import Ormolu.Printer.Meat.Common
import Ormolu.Printer.Meat.Declaration.Annotation
import Ormolu.Printer.Meat.Declaration.Class
import Ormolu.Printer.Meat.Declaration.Data
import Ormolu.Printer.Meat.Declaration.Default
import Ormolu.Printer.Meat.Declaration.Foreign
import Ormolu.Printer.Meat.Declaration.Instance
import Ormolu.Printer.Meat.Declaration.RoleAnnotation
import Ormolu.Printer.Meat.Declaration.Rule
import Ormolu.Printer.Meat.Declaration.Signature
import Ormolu.Printer.Meat.Declaration.Splice
import Ormolu.Printer.Meat.Declaration.Type
import Ormolu.Printer.Meat.Declaration.TypeFamily
import Ormolu.Printer.Meat.Declaration.Value
import Ormolu.Printer.Meat.Declaration.Warning
import Ormolu.Printer.Meat.Type
import Ormolu.Utils

data UserGrouping
  = -- | Always put newlines where we think they should be
    Disregard
  | -- | Respect user preferences regarding grouping
    Respect
  deriving (UserGrouping -> UserGrouping -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: UserGrouping -> UserGrouping -> Bool
$c/= :: UserGrouping -> UserGrouping -> Bool
== :: UserGrouping -> UserGrouping -> Bool
$c== :: UserGrouping -> UserGrouping -> Bool
Eq, Int -> UserGrouping -> ShowS
[UserGrouping] -> ShowS
UserGrouping -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [UserGrouping] -> ShowS
$cshowList :: [UserGrouping] -> ShowS
show :: UserGrouping -> String
$cshow :: UserGrouping -> String
showsPrec :: Int -> UserGrouping -> ShowS
$cshowsPrec :: Int -> UserGrouping -> ShowS
Show)

p_hsDecls :: FamilyStyle -> [LHsDecl GhcPs] -> R ()
p_hsDecls :: FamilyStyle -> [LHsDecl GhcPs] -> R ()
p_hsDecls = UserGrouping -> FamilyStyle -> [LHsDecl GhcPs] -> R ()
p_hsDecls' UserGrouping
Disregard

-- | Like 'p_hsDecls' but respects user choices regarding grouping. If the
-- user omits newlines between declarations, we also omit them in most
-- cases, except when said declarations have associated Haddocks.
--
-- Does some normalization (compress subsequent newlines into a single one)
p_hsDeclsRespectGrouping :: FamilyStyle -> [LHsDecl GhcPs] -> R ()
p_hsDeclsRespectGrouping :: FamilyStyle -> [LHsDecl GhcPs] -> R ()
p_hsDeclsRespectGrouping = UserGrouping -> FamilyStyle -> [LHsDecl GhcPs] -> R ()
p_hsDecls' UserGrouping
Respect

p_hsDecls' :: UserGrouping -> FamilyStyle -> [LHsDecl GhcPs] -> R ()
p_hsDecls' :: UserGrouping -> FamilyStyle -> [LHsDecl GhcPs] -> R ()
p_hsDecls' UserGrouping
grouping FamilyStyle
style [LHsDecl GhcPs]
decls = do
  Bool
isSig <- (forall a. Eq a => a -> a -> Bool
== SourceType
SignatureSource) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> R SourceType
askSourceType
  forall a. (a -> R ()) -> [a] -> R ()
sepSemi forall a. a -> a
id forall a b. (a -> b) -> a -> b
$
    -- Return a list of rendered declarations, adding a newline to separate
    -- groups.
    case Bool -> [LHsDecl GhcPs] -> [NonEmpty (LHsDecl GhcPs)]
groupDecls Bool
isSig [LHsDecl GhcPs]
decls of
      [] -> []
      (NonEmpty (LHsDecl GhcPs)
x : [NonEmpty (LHsDecl GhcPs)]
xs) -> NonEmpty
  (GenLocated (SrcSpanAnn' (EpAnn AnnListItem)) (HsDecl GhcPs))
-> [R ()]
renderGroup NonEmpty (LHsDecl GhcPs)
x forall a. [a] -> [a] -> [a]
++ forall (t :: * -> *) a. Foldable t => t [a] -> [a]
concat (forall a b c. (a -> b -> c) -> [a] -> [b] -> [c]
zipWith NonEmpty
  (GenLocated (SrcSpanAnn' (EpAnn AnnListItem)) (HsDecl GhcPs))
-> NonEmpty
     (GenLocated (SrcSpanAnn' (EpAnn AnnListItem)) (HsDecl GhcPs))
-> [R ()]
renderGroupWithPrev (NonEmpty (LHsDecl GhcPs)
x forall a. a -> [a] -> [a]
: [NonEmpty (LHsDecl GhcPs)]
xs) [NonEmpty (LHsDecl GhcPs)]
xs)
  where
    renderGroup :: NonEmpty
  (GenLocated (SrcSpanAnn' (EpAnn AnnListItem)) (HsDecl GhcPs))
-> [R ()]
renderGroup = forall a. NonEmpty a -> [a]
NE.toList forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap (forall l a. HasSrcSpan l => (a -> R ()) -> GenLocated l a -> R ()
located' forall a b. (a -> b) -> a -> b
$ R () -> R ()
dontUseBraces forall b c a. (b -> c) -> (a -> b) -> a -> c
. FamilyStyle -> HsDecl GhcPs -> R ()
p_hsDecl FamilyStyle
style)
    renderGroupWithPrev :: NonEmpty
  (GenLocated (SrcSpanAnn' (EpAnn AnnListItem)) (HsDecl GhcPs))
-> NonEmpty
     (GenLocated (SrcSpanAnn' (EpAnn AnnListItem)) (HsDecl GhcPs))
-> [R ()]
renderGroupWithPrev NonEmpty
  (GenLocated (SrcSpanAnn' (EpAnn AnnListItem)) (HsDecl GhcPs))
prev NonEmpty
  (GenLocated (SrcSpanAnn' (EpAnn AnnListItem)) (HsDecl GhcPs))
curr =
      -- We can omit a blank line when the user didn't add one, but we must
      -- ensure we always add blank lines around documented declarations
      case UserGrouping
grouping of
        UserGrouping
Disregard ->
          R ()
declNewline forall a. a -> [a] -> [a]
: NonEmpty
  (GenLocated (SrcSpanAnn' (EpAnn AnnListItem)) (HsDecl GhcPs))
-> [R ()]
renderGroup NonEmpty
  (GenLocated (SrcSpanAnn' (EpAnn AnnListItem)) (HsDecl GhcPs))
curr
        UserGrouping
Respect ->
          if forall a. (a -> SrcSpan) -> NonEmpty a -> NonEmpty a -> Bool
separatedByBlankNE forall a e. GenLocated (SrcSpanAnn' a) e -> SrcSpan
getLocA NonEmpty
  (GenLocated (SrcSpanAnn' (EpAnn AnnListItem)) (HsDecl GhcPs))
prev NonEmpty
  (GenLocated (SrcSpanAnn' (EpAnn AnnListItem)) (HsDecl GhcPs))
curr
            Bool -> Bool -> Bool
|| NonEmpty (LHsDecl GhcPs) -> Bool
isDocumented NonEmpty
  (GenLocated (SrcSpanAnn' (EpAnn AnnListItem)) (HsDecl GhcPs))
prev
            Bool -> Bool -> Bool
|| NonEmpty (LHsDecl GhcPs) -> Bool
isDocumented NonEmpty
  (GenLocated (SrcSpanAnn' (EpAnn AnnListItem)) (HsDecl GhcPs))
curr
            then R ()
declNewline forall a. a -> [a] -> [a]
: NonEmpty
  (GenLocated (SrcSpanAnn' (EpAnn AnnListItem)) (HsDecl GhcPs))
-> [R ()]
renderGroup NonEmpty
  (GenLocated (SrcSpanAnn' (EpAnn AnnListItem)) (HsDecl GhcPs))
curr
            else NonEmpty
  (GenLocated (SrcSpanAnn' (EpAnn AnnListItem)) (HsDecl GhcPs))
-> [R ()]
renderGroup NonEmpty
  (GenLocated (SrcSpanAnn' (EpAnn AnnListItem)) (HsDecl GhcPs))
curr

-- | Is a declaration group documented?
isDocumented :: NonEmpty (LHsDecl GhcPs) -> Bool
isDocumented :: NonEmpty (LHsDecl GhcPs) -> Bool
isDocumented = forall (t :: * -> *) a. Foldable t => (a -> Bool) -> t a -> Bool
any (HsDecl GhcPs -> Bool
isHaddock forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall l e. GenLocated l e -> e
unLoc)
  where
    isHaddock :: HsDecl GhcPs -> Bool
isHaddock HsDecl GhcPs
DocNext = Bool
True
    isHaddock HsDecl GhcPs
DocPrev = Bool
True
    isHaddock HsDecl GhcPs
_ = Bool
False

-- | Group relevant declarations together.
groupDecls ::
  -- | Is the source a signature file?
  Bool ->
  -- | List of declarations
  [LHsDecl GhcPs] ->
  [NonEmpty (LHsDecl GhcPs)]
groupDecls :: Bool -> [LHsDecl GhcPs] -> [NonEmpty (LHsDecl GhcPs)]
groupDecls Bool
_ [] = []
groupDecls Bool
isSig (l :: LHsDecl GhcPs
l@(L SrcSpanAnn' (EpAnn AnnListItem)
_ HsDecl GhcPs
DocNext) : [LHsDecl GhcPs]
xs) =
  -- If the first element is a doc string for next element, just include it
  -- in the next block:
  case Bool -> [LHsDecl GhcPs] -> [NonEmpty (LHsDecl GhcPs)]
groupDecls Bool
isSig [LHsDecl GhcPs]
xs of
    [] -> [LHsDecl GhcPs
l forall a. a -> [a] -> NonEmpty a
:| []]
    (NonEmpty (LHsDecl GhcPs)
x : [NonEmpty (LHsDecl GhcPs)]
xs') -> (LHsDecl GhcPs
l forall a. a -> NonEmpty a -> NonEmpty a
<| NonEmpty (LHsDecl GhcPs)
x) forall a. a -> [a] -> [a]
: [NonEmpty (LHsDecl GhcPs)]
xs'
groupDecls Bool
isSig (LHsDecl GhcPs
header : [LHsDecl GhcPs]
xs) =
  let ([(GenLocated (SrcSpanAnn' (EpAnn AnnListItem)) (HsDecl GhcPs),
  GenLocated (SrcSpanAnn' (EpAnn AnnListItem)) (HsDecl GhcPs))]
grp, [(GenLocated (SrcSpanAnn' (EpAnn AnnListItem)) (HsDecl GhcPs),
  GenLocated (SrcSpanAnn' (EpAnn AnnListItem)) (HsDecl GhcPs))]
rest) = forall a b c. (a -> b -> c) -> b -> a -> c
flip forall a. (a -> Bool) -> [a] -> ([a], [a])
span (forall a b. [a] -> [b] -> [(a, b)]
zip (LHsDecl GhcPs
header forall a. a -> [a] -> [a]
: [LHsDecl GhcPs]
xs) [LHsDecl GhcPs]
xs) forall a b. (a -> b) -> a -> b
$ \(GenLocated (SrcSpanAnn' (EpAnn AnnListItem)) (HsDecl GhcPs)
previous, GenLocated (SrcSpanAnn' (EpAnn AnnListItem)) (HsDecl GhcPs)
current) ->
        let relevantToHdr :: Bool
relevantToHdr = LHsDecl GhcPs -> LHsDecl GhcPs -> Bool
groupedDecls LHsDecl GhcPs
header GenLocated (SrcSpanAnn' (EpAnn AnnListItem)) (HsDecl GhcPs)
current
            relevantToPrev :: Bool
relevantToPrev = LHsDecl GhcPs -> LHsDecl GhcPs -> Bool
groupedDecls GenLocated (SrcSpanAnn' (EpAnn AnnListItem)) (HsDecl GhcPs)
previous GenLocated (SrcSpanAnn' (EpAnn AnnListItem)) (HsDecl GhcPs)
current
            isDeclSeries :: Bool
isDeclSeries = Bool -> Bool
not Bool
isSig Bool -> Bool -> Bool
&& LHsDecl GhcPs -> LHsDecl GhcPs -> Bool
declSeries GenLocated (SrcSpanAnn' (EpAnn AnnListItem)) (HsDecl GhcPs)
previous GenLocated (SrcSpanAnn' (EpAnn AnnListItem)) (HsDecl GhcPs)
current
         in Bool
isDeclSeries Bool -> Bool -> Bool
|| Bool
relevantToHdr Bool -> Bool -> Bool
|| Bool
relevantToPrev
   in (LHsDecl GhcPs
header forall a. a -> [a] -> NonEmpty a
:| forall a b. (a -> b) -> [a] -> [b]
map forall a b. (a, b) -> b
snd [(GenLocated (SrcSpanAnn' (EpAnn AnnListItem)) (HsDecl GhcPs),
  GenLocated (SrcSpanAnn' (EpAnn AnnListItem)) (HsDecl GhcPs))]
grp) forall a. a -> [a] -> [a]
: Bool -> [LHsDecl GhcPs] -> [NonEmpty (LHsDecl GhcPs)]
groupDecls Bool
isSig (forall a b. (a -> b) -> [a] -> [b]
map forall a b. (a, b) -> b
snd [(GenLocated (SrcSpanAnn' (EpAnn AnnListItem)) (HsDecl GhcPs),
  GenLocated (SrcSpanAnn' (EpAnn AnnListItem)) (HsDecl GhcPs))]
rest)

p_hsDecl :: FamilyStyle -> HsDecl GhcPs -> R ()
p_hsDecl :: FamilyStyle -> HsDecl GhcPs -> R ()
p_hsDecl FamilyStyle
style = \case
  TyClD XTyClD GhcPs
_ TyClDecl GhcPs
x -> FamilyStyle -> TyClDecl GhcPs -> R ()
p_tyClDecl FamilyStyle
style TyClDecl GhcPs
x
  ValD XValD GhcPs
_ HsBind GhcPs
x -> HsBind GhcPs -> R ()
p_valDecl HsBind GhcPs
x
  SigD XSigD GhcPs
_ Sig GhcPs
x -> Sig GhcPs -> R ()
p_sigDecl Sig GhcPs
x
  InstD XInstD GhcPs
_ InstDecl GhcPs
x -> FamilyStyle -> InstDecl GhcPs -> R ()
p_instDecl FamilyStyle
style InstDecl GhcPs
x
  DerivD XDerivD GhcPs
_ DerivDecl GhcPs
x -> DerivDecl GhcPs -> R ()
p_standaloneDerivDecl DerivDecl GhcPs
x
  DefD XDefD GhcPs
_ DefaultDecl GhcPs
x -> DefaultDecl GhcPs -> R ()
p_defaultDecl DefaultDecl GhcPs
x
  ForD XForD GhcPs
_ ForeignDecl GhcPs
x -> ForeignDecl GhcPs -> R ()
p_foreignDecl ForeignDecl GhcPs
x
  WarningD XWarningD GhcPs
_ WarnDecls GhcPs
x -> WarnDecls GhcPs -> R ()
p_warnDecls WarnDecls GhcPs
x
  AnnD XAnnD GhcPs
_ AnnDecl GhcPs
x -> AnnDecl GhcPs -> R ()
p_annDecl AnnDecl GhcPs
x
  RuleD XRuleD GhcPs
_ RuleDecls GhcPs
x -> RuleDecls GhcPs -> R ()
p_ruleDecls RuleDecls GhcPs
x
  SpliceD XSpliceD GhcPs
_ SpliceDecl GhcPs
x -> SpliceDecl GhcPs -> R ()
p_spliceDecl SpliceDecl GhcPs
x
  DocD XDocD GhcPs
_ DocDecl GhcPs
docDecl ->
    case DocDecl GhcPs
docDecl of
      DocCommentNext LHsDoc GhcPs
str -> HaddockStyle -> Bool -> LHsDoc GhcPs -> R ()
p_hsDoc HaddockStyle
Pipe Bool
False LHsDoc GhcPs
str
      DocCommentPrev LHsDoc GhcPs
str -> HaddockStyle -> Bool -> LHsDoc GhcPs -> R ()
p_hsDoc HaddockStyle
Caret Bool
False LHsDoc GhcPs
str
      DocCommentNamed String
name LHsDoc GhcPs
str -> HaddockStyle -> Bool -> LHsDoc GhcPs -> R ()
p_hsDoc (String -> HaddockStyle
Named String
name) Bool
False LHsDoc GhcPs
str
      DocGroup Int
n LHsDoc GhcPs
str -> HaddockStyle -> Bool -> LHsDoc GhcPs -> R ()
p_hsDoc (Int -> HaddockStyle
Asterisk Int
n) Bool
False LHsDoc GhcPs
str
  RoleAnnotD XRoleAnnotD GhcPs
_ RoleAnnotDecl GhcPs
x -> RoleAnnotDecl GhcPs -> R ()
p_roleAnnot RoleAnnotDecl GhcPs
x
  KindSigD XKindSigD GhcPs
_ StandaloneKindSig GhcPs
s -> StandaloneKindSig GhcPs -> R ()
p_standaloneKindSig StandaloneKindSig GhcPs
s

p_tyClDecl :: FamilyStyle -> TyClDecl GhcPs -> R ()
p_tyClDecl :: FamilyStyle -> TyClDecl GhcPs -> R ()
p_tyClDecl FamilyStyle
style = \case
  FamDecl XFamDecl GhcPs
_ FamilyDecl GhcPs
x -> FamilyStyle -> FamilyDecl GhcPs -> R ()
p_famDecl FamilyStyle
style FamilyDecl GhcPs
x
  SynDecl {LHsQTyVars GhcPs
LHsType GhcPs
LIdP GhcPs
XSynDecl GhcPs
LexicalFixity
tcdSExt :: forall pass. TyClDecl pass -> XSynDecl pass
tcdLName :: forall pass. TyClDecl pass -> LIdP pass
tcdTyVars :: forall pass. TyClDecl pass -> LHsQTyVars pass
tcdFixity :: forall pass. TyClDecl pass -> LexicalFixity
tcdRhs :: forall pass. TyClDecl pass -> LHsType pass
tcdRhs :: LHsType GhcPs
tcdFixity :: LexicalFixity
tcdTyVars :: LHsQTyVars GhcPs
tcdLName :: LIdP GhcPs
tcdSExt :: XSynDecl GhcPs
..} -> LocatedN RdrName
-> LexicalFixity -> LHsQTyVars GhcPs -> LHsType GhcPs -> R ()
p_synDecl LIdP GhcPs
tcdLName LexicalFixity
tcdFixity LHsQTyVars GhcPs
tcdTyVars LHsType GhcPs
tcdRhs
  DataDecl {HsDataDefn GhcPs
LHsQTyVars GhcPs
LIdP GhcPs
XDataDecl GhcPs
LexicalFixity
tcdDExt :: forall pass. TyClDecl pass -> XDataDecl pass
tcdDataDefn :: forall pass. TyClDecl pass -> HsDataDefn pass
tcdDataDefn :: HsDataDefn GhcPs
tcdFixity :: LexicalFixity
tcdTyVars :: LHsQTyVars GhcPs
tcdLName :: LIdP GhcPs
tcdDExt :: XDataDecl GhcPs
tcdLName :: forall pass. TyClDecl pass -> LIdP pass
tcdTyVars :: forall pass. TyClDecl pass -> LHsQTyVars pass
tcdFixity :: forall pass. TyClDecl pass -> LexicalFixity
..} ->
    FamilyStyle
-> LocatedN RdrName
-> HsTyPats GhcPs
-> LexicalFixity
-> HsDataDefn GhcPs
-> R ()
p_dataDecl
      FamilyStyle
Associated
      LIdP GhcPs
tcdLName
      (LHsQTyVars GhcPs -> HsTyPats GhcPs
tyVarsToTyPats LHsQTyVars GhcPs
tcdTyVars)
      LexicalFixity
tcdFixity
      HsDataDefn GhcPs
tcdDataDefn
  ClassDecl {[LHsFunDep GhcPs]
[LFamilyDecl GhcPs]
[LTyFamDefltDecl GhcPs]
[LDocDecl GhcPs]
[LSig GhcPs]
Maybe (LHsContext GhcPs)
LHsQTyVars GhcPs
LIdP GhcPs
XClassDecl GhcPs
LexicalFixity
LHsBinds GhcPs
tcdCExt :: forall pass. TyClDecl pass -> XClassDecl pass
tcdCtxt :: forall pass. TyClDecl pass -> Maybe (LHsContext pass)
tcdFDs :: forall pass. TyClDecl pass -> [LHsFunDep pass]
tcdSigs :: forall pass. TyClDecl pass -> [LSig pass]
tcdMeths :: forall pass. TyClDecl pass -> LHsBinds pass
tcdATs :: forall pass. TyClDecl pass -> [LFamilyDecl pass]
tcdATDefs :: forall pass. TyClDecl pass -> [LTyFamDefltDecl pass]
tcdDocs :: forall pass. TyClDecl pass -> [LDocDecl pass]
tcdDocs :: [LDocDecl GhcPs]
tcdATDefs :: [LTyFamDefltDecl GhcPs]
tcdATs :: [LFamilyDecl GhcPs]
tcdMeths :: LHsBinds GhcPs
tcdSigs :: [LSig GhcPs]
tcdFDs :: [LHsFunDep GhcPs]
tcdFixity :: LexicalFixity
tcdTyVars :: LHsQTyVars GhcPs
tcdLName :: LIdP GhcPs
tcdCtxt :: Maybe (LHsContext GhcPs)
tcdCExt :: XClassDecl GhcPs
tcdLName :: forall pass. TyClDecl pass -> LIdP pass
tcdTyVars :: forall pass. TyClDecl pass -> LHsQTyVars pass
tcdFixity :: forall pass. TyClDecl pass -> LexicalFixity
..} ->
    Maybe (LHsContext GhcPs)
-> LocatedN RdrName
-> LHsQTyVars GhcPs
-> LexicalFixity
-> [LHsFunDep GhcPs]
-> [LSig GhcPs]
-> LHsBinds GhcPs
-> [LFamilyDecl GhcPs]
-> [LTyFamDefltDecl GhcPs]
-> [LDocDecl GhcPs]
-> R ()
p_classDecl
      Maybe (LHsContext GhcPs)
tcdCtxt
      LIdP GhcPs
tcdLName
      LHsQTyVars GhcPs
tcdTyVars
      LexicalFixity
tcdFixity
      [LHsFunDep GhcPs]
tcdFDs
      [LSig GhcPs]
tcdSigs
      LHsBinds GhcPs
tcdMeths
      [LFamilyDecl GhcPs]
tcdATs
      [LTyFamDefltDecl GhcPs]
tcdATDefs
      [LDocDecl GhcPs]
tcdDocs

p_instDecl :: FamilyStyle -> InstDecl GhcPs -> R ()
p_instDecl :: FamilyStyle -> InstDecl GhcPs -> R ()
p_instDecl FamilyStyle
style = \case
  ClsInstD XClsInstD GhcPs
_ ClsInstDecl GhcPs
x -> ClsInstDecl GhcPs -> R ()
p_clsInstDecl ClsInstDecl GhcPs
x
  TyFamInstD XTyFamInstD GhcPs
_ TyFamInstDecl GhcPs
x -> FamilyStyle -> TyFamInstDecl GhcPs -> R ()
p_tyFamInstDecl FamilyStyle
style TyFamInstDecl GhcPs
x
  DataFamInstD XDataFamInstD GhcPs
_ DataFamInstDecl GhcPs
x -> FamilyStyle -> DataFamInstDecl GhcPs -> R ()
p_dataFamInstDecl FamilyStyle
style DataFamInstDecl GhcPs
x

-- | Determine if these declarations should be grouped together.
groupedDecls ::
  LHsDecl GhcPs ->
  LHsDecl GhcPs ->
  Bool
groupedDecls :: LHsDecl GhcPs -> LHsDecl GhcPs -> Bool
groupedDecls (L (forall a. SrcSpanAnn' a -> SrcSpan
locA -> SrcSpan
l_x) HsDecl GhcPs
x') (L (forall a. SrcSpanAnn' a -> SrcSpan
locA -> SrcSpan
l_y) HsDecl GhcPs
y') =
  case (HsDecl GhcPs
x', HsDecl GhcPs
y') of
    (TypeSignature [RdrName]
ns, FunctionBody [RdrName]
ns') -> [RdrName]
ns forall a. Ord a => [a] -> [a] -> Bool
`intersects` [RdrName]
ns'
    (TypeSignature [RdrName]
ns, DefaultSignature [RdrName]
ns') -> [RdrName]
ns forall a. Ord a => [a] -> [a] -> Bool
`intersects` [RdrName]
ns'
    (DefaultSignature [RdrName]
ns, TypeSignature [RdrName]
ns') -> [RdrName]
ns forall a. Ord a => [a] -> [a] -> Bool
`intersects` [RdrName]
ns'
    (DefaultSignature [RdrName]
ns, FunctionBody [RdrName]
ns') -> [RdrName]
ns forall a. Ord a => [a] -> [a] -> Bool
`intersects` [RdrName]
ns'
    (HsDecl GhcPs
x, FunctionBody [RdrName]
ns) | Just [RdrName]
ns' <- HsDecl GhcPs -> Maybe [RdrName]
isPragma HsDecl GhcPs
x -> [RdrName]
ns forall a. Ord a => [a] -> [a] -> Bool
`intersects` [RdrName]
ns'
    (FunctionBody [RdrName]
ns, HsDecl GhcPs
x) | Just [RdrName]
ns' <- HsDecl GhcPs -> Maybe [RdrName]
isPragma HsDecl GhcPs
x -> [RdrName]
ns forall a. Ord a => [a] -> [a] -> Bool
`intersects` [RdrName]
ns'
    (HsDecl GhcPs
x, DataDeclaration RdrName
n) | Just [RdrName]
ns <- HsDecl GhcPs -> Maybe [RdrName]
isPragma HsDecl GhcPs
x -> RdrName
n forall (t :: * -> *) a. (Foldable t, Eq a) => a -> t a -> Bool
`elem` [RdrName]
ns
    (DataDeclaration RdrName
n, HsDecl GhcPs
x)
      | Just [RdrName]
ns <- HsDecl GhcPs -> Maybe [RdrName]
isPragma HsDecl GhcPs
x ->
          let f :: RdrName -> FastString
f = OccName -> FastString
occNameFS forall b c a. (b -> c) -> (a -> b) -> a -> c
. RdrName -> OccName
rdrNameOcc in RdrName -> FastString
f RdrName
n forall (t :: * -> *) a. (Foldable t, Eq a) => a -> t a -> Bool
`elem` forall a b. (a -> b) -> [a] -> [b]
map RdrName -> FastString
f [RdrName]
ns
    (HsDecl GhcPs
x, HsDecl GhcPs
y)
      | Just [RdrName]
ns <- HsDecl GhcPs -> Maybe [RdrName]
isPragma HsDecl GhcPs
x,
        Just [RdrName]
ns' <- HsDecl GhcPs -> Maybe [RdrName]
isPragma HsDecl GhcPs
y ->
          [RdrName]
ns forall a. Ord a => [a] -> [a] -> Bool
`intersects` [RdrName]
ns'
    (HsDecl GhcPs
x, TypeSignature [RdrName]
ns) | Just [RdrName]
ns' <- HsDecl GhcPs -> Maybe [RdrName]
isPragma HsDecl GhcPs
x -> [RdrName]
ns forall a. Ord a => [a] -> [a] -> Bool
`intersects` [RdrName]
ns'
    (TypeSignature [RdrName]
ns, HsDecl GhcPs
x) | Just [RdrName]
ns' <- HsDecl GhcPs -> Maybe [RdrName]
isPragma HsDecl GhcPs
x -> [RdrName]
ns forall a. Ord a => [a] -> [a] -> Bool
`intersects` [RdrName]
ns'
    (PatternSignature [RdrName]
ns, Pattern RdrName
n) -> RdrName
n forall (t :: * -> *) a. (Foldable t, Eq a) => a -> t a -> Bool
`elem` [RdrName]
ns
    (KindSignature RdrName
n, DataDeclaration RdrName
n') -> RdrName
n forall a. Eq a => a -> a -> Bool
== RdrName
n'
    (KindSignature RdrName
n, ClassDeclaration RdrName
n') -> RdrName
n forall a. Eq a => a -> a -> Bool
== RdrName
n'
    (KindSignature RdrName
n, FamilyDeclaration RdrName
n') -> RdrName
n forall a. Eq a => a -> a -> Bool
== RdrName
n'
    (KindSignature RdrName
n, TypeSynonym RdrName
n') -> RdrName
n forall a. Eq a => a -> a -> Bool
== RdrName
n'
    -- Special case for TH splices, we look at locations
    (HsDecl GhcPs
Splice, HsDecl GhcPs
Splice) -> Bool -> Bool
not (forall a. (a -> SrcSpan) -> a -> a -> Bool
separatedByBlank forall a. a -> a
id SrcSpan
l_x SrcSpan
l_y)
    -- This looks only at Haddocks, normal comments are handled elsewhere
    (HsDecl GhcPs
DocNext, HsDecl GhcPs
_) -> Bool
True
    (HsDecl GhcPs
_, HsDecl GhcPs
DocPrev) -> Bool
True
    (HsDecl GhcPs, HsDecl GhcPs)
_ -> Bool
False

-- | Detect declaration series that should not have blanks between them.
declSeries ::
  LHsDecl GhcPs ->
  LHsDecl GhcPs ->
  Bool
declSeries :: LHsDecl GhcPs -> LHsDecl GhcPs -> Bool
declSeries (L SrcSpanAnn' (EpAnn AnnListItem)
_ HsDecl GhcPs
x) (L SrcSpanAnn' (EpAnn AnnListItem)
_ HsDecl GhcPs
y) =
  case (HsDecl GhcPs
x, HsDecl GhcPs
y) of
    ( SigD XSigD GhcPs
_ (TypeSig XTypeSig GhcPs
_ [LIdP GhcPs]
_ LHsSigWcType GhcPs
_),
      SigD XSigD GhcPs
_ (TypeSig XTypeSig GhcPs
_ [LIdP GhcPs]
_ LHsSigWcType GhcPs
_)
      ) -> Bool
True
    (HsDecl GhcPs, HsDecl GhcPs)
_ -> Bool
False

intersects :: Ord a => [a] -> [a] -> Bool
intersects :: forall a. Ord a => [a] -> [a] -> Bool
intersects [a]
a [a]
b = forall a. Ord a => [a] -> [a] -> Bool
go (forall a. Ord a => [a] -> [a]
sort [a]
a) (forall a. Ord a => [a] -> [a]
sort [a]
b)
  where
    go :: Ord a => [a] -> [a] -> Bool
    go :: forall a. Ord a => [a] -> [a] -> Bool
go [a]
_ [] = Bool
False
    go [] [a]
_ = Bool
False
    go (a
x : [a]
xs) (a
y : [a]
ys)
      | a
x forall a. Ord a => a -> a -> Bool
< a
y = forall a. Ord a => [a] -> [a] -> Bool
go [a]
xs (a
y forall a. a -> [a] -> [a]
: [a]
ys)
      | a
x forall a. Ord a => a -> a -> Bool
> a
y = forall a. Ord a => [a] -> [a] -> Bool
go (a
x forall a. a -> [a] -> [a]
: [a]
xs) [a]
ys
      | Bool
otherwise = Bool
True

isPragma ::
  HsDecl GhcPs ->
  Maybe [RdrName]
isPragma :: HsDecl GhcPs -> Maybe [RdrName]
isPragma = \case
  InlinePragma RdrName
n -> forall a. a -> Maybe a
Just [RdrName
n]
  SpecializePragma RdrName
n -> forall a. a -> Maybe a
Just [RdrName
n]
  SCCPragma RdrName
n -> forall a. a -> Maybe a
Just [RdrName
n]
  AnnTypePragma RdrName
n -> forall a. a -> Maybe a
Just [RdrName
n]
  AnnValuePragma RdrName
n -> forall a. a -> Maybe a
Just [RdrName
n]
  WarningPragma [RdrName]
n -> forall a. a -> Maybe a
Just [RdrName]
n
  HsDecl GhcPs
_ -> forall a. Maybe a
Nothing

-- Declarations that do not refer to names

pattern Splice :: HsDecl GhcPs
pattern $mSplice :: forall {r}. HsDecl GhcPs -> ((# #) -> r) -> ((# #) -> r) -> r
Splice <- SpliceD _ (SpliceDecl _ _ _)

-- Declarations referring to a single name

pattern
  InlinePragma,
  SpecializePragma,
  SCCPragma,
  AnnTypePragma,
  AnnValuePragma,
  Pattern,
  DataDeclaration,
  ClassDeclaration,
  KindSignature,
  FamilyDeclaration,
  TypeSynonym ::
    RdrName -> HsDecl GhcPs
pattern $mInlinePragma :: forall {r}. HsDecl GhcPs -> (RdrName -> r) -> ((# #) -> r) -> r
InlinePragma n <- SigD _ (InlineSig _ (L _ n) _)
pattern $mSpecializePragma :: forall {r}. HsDecl GhcPs -> (RdrName -> r) -> ((# #) -> r) -> r
SpecializePragma n <- SigD _ (SpecSig _ (L _ n) _ _)
pattern $mSCCPragma :: forall {r}. HsDecl GhcPs -> (RdrName -> r) -> ((# #) -> r) -> r
SCCPragma n <- SigD _ (SCCFunSig _ _ (L _ n) _)
pattern $mAnnTypePragma :: forall {r}. HsDecl GhcPs -> (RdrName -> r) -> ((# #) -> r) -> r
AnnTypePragma n <- AnnD _ (HsAnnotation _ _ (TypeAnnProvenance (L _ n)) _)
pattern $mAnnValuePragma :: forall {r}. HsDecl GhcPs -> (RdrName -> r) -> ((# #) -> r) -> r
AnnValuePragma n <- AnnD _ (HsAnnotation _ _ (ValueAnnProvenance (L _ n)) _)
pattern $mPattern :: forall {r}. HsDecl GhcPs -> (RdrName -> r) -> ((# #) -> r) -> r
Pattern n <- ValD _ (PatSynBind _ (PSB _ (L _ n) _ _ _))
pattern $mDataDeclaration :: forall {r}. HsDecl GhcPs -> (RdrName -> r) -> ((# #) -> r) -> r
DataDeclaration n <- TyClD _ (DataDecl _ (L _ n) _ _ _)
pattern $mClassDeclaration :: forall {r}. HsDecl GhcPs -> (RdrName -> r) -> ((# #) -> r) -> r
ClassDeclaration n <- TyClD _ (ClassDecl _ _ (L _ n) _ _ _ _ _ _ _ _)
pattern $mKindSignature :: forall {r}. HsDecl GhcPs -> (RdrName -> r) -> ((# #) -> r) -> r
KindSignature n <- KindSigD _ (StandaloneKindSig _ (L _ n) _)
pattern $mFamilyDeclaration :: forall {r}. HsDecl GhcPs -> (RdrName -> r) -> ((# #) -> r) -> r
FamilyDeclaration n <- TyClD _ (FamDecl _ (FamilyDecl _ _ _ (L _ n) _ _ _ _))
pattern $mTypeSynonym :: forall {r}. HsDecl GhcPs -> (RdrName -> r) -> ((# #) -> r) -> r
TypeSynonym n <- TyClD _ (SynDecl _ (L _ n) _ _ _)

-- Declarations which can refer to multiple names

pattern
  TypeSignature,
  DefaultSignature,
  FunctionBody,
  PatternSignature,
  WarningPragma ::
    [RdrName] -> HsDecl GhcPs
pattern $mTypeSignature :: forall {r}. HsDecl GhcPs -> ([RdrName] -> r) -> ((# #) -> r) -> r
TypeSignature n <- (sigRdrNames -> Just n)
pattern $mDefaultSignature :: forall {r}. HsDecl GhcPs -> ([RdrName] -> r) -> ((# #) -> r) -> r
DefaultSignature n <- (defSigRdrNames -> Just n)
pattern $mFunctionBody :: forall {r}. HsDecl GhcPs -> ([RdrName] -> r) -> ((# #) -> r) -> r
FunctionBody n <- (funRdrNames -> Just n)
pattern $mPatternSignature :: forall {r}. HsDecl GhcPs -> ([RdrName] -> r) -> ((# #) -> r) -> r
PatternSignature n <- (patSigRdrNames -> Just n)
pattern $mWarningPragma :: forall {r}. HsDecl GhcPs -> ([RdrName] -> r) -> ((# #) -> r) -> r
WarningPragma n <- (warnSigRdrNames -> Just n)

pattern DocNext, DocPrev :: HsDecl GhcPs
pattern $mDocNext :: forall {r}. HsDecl GhcPs -> ((# #) -> r) -> ((# #) -> r) -> r
DocNext <- (DocD _ (DocCommentNext _))
pattern $mDocPrev :: forall {r}. HsDecl GhcPs -> ((# #) -> r) -> ((# #) -> r) -> r
DocPrev <- (DocD _ (DocCommentPrev _))

sigRdrNames :: HsDecl GhcPs -> Maybe [RdrName]
sigRdrNames :: HsDecl GhcPs -> Maybe [RdrName]
sigRdrNames (SigD XSigD GhcPs
_ (TypeSig XTypeSig GhcPs
_ [LIdP GhcPs]
ns LHsSigWcType GhcPs
_)) = forall a. a -> Maybe a
Just forall a b. (a -> b) -> a -> b
$ forall a b. (a -> b) -> [a] -> [b]
map forall l e. GenLocated l e -> e
unLoc [LIdP GhcPs]
ns
sigRdrNames (SigD XSigD GhcPs
_ (ClassOpSig XClassOpSig GhcPs
_ Bool
_ [LIdP GhcPs]
ns LHsSigType GhcPs
_)) = forall a. a -> Maybe a
Just forall a b. (a -> b) -> a -> b
$ forall a b. (a -> b) -> [a] -> [b]
map forall l e. GenLocated l e -> e
unLoc [LIdP GhcPs]
ns
sigRdrNames (SigD XSigD GhcPs
_ (PatSynSig XPatSynSig GhcPs
_ [LIdP GhcPs]
ns LHsSigType GhcPs
_)) = forall a. a -> Maybe a
Just forall a b. (a -> b) -> a -> b
$ forall a b. (a -> b) -> [a] -> [b]
map forall l e. GenLocated l e -> e
unLoc [LIdP GhcPs]
ns
sigRdrNames HsDecl GhcPs
_ = forall a. Maybe a
Nothing

defSigRdrNames :: HsDecl GhcPs -> Maybe [RdrName]
defSigRdrNames :: HsDecl GhcPs -> Maybe [RdrName]
defSigRdrNames (SigD XSigD GhcPs
_ (ClassOpSig XClassOpSig GhcPs
_ Bool
True [LIdP GhcPs]
ns LHsSigType GhcPs
_)) = forall a. a -> Maybe a
Just forall a b. (a -> b) -> a -> b
$ forall a b. (a -> b) -> [a] -> [b]
map forall l e. GenLocated l e -> e
unLoc [LIdP GhcPs]
ns
defSigRdrNames HsDecl GhcPs
_ = forall a. Maybe a
Nothing

funRdrNames :: HsDecl GhcPs -> Maybe [RdrName]
funRdrNames :: HsDecl GhcPs -> Maybe [RdrName]
funRdrNames (ValD XValD GhcPs
_ (FunBind XFunBind GhcPs GhcPs
_ (L SrcSpanAnnN
_ RdrName
n) MatchGroup GhcPs (XRec GhcPs (HsExpr GhcPs))
_ [CoreTickish]
_)) = forall a. a -> Maybe a
Just [RdrName
n]
funRdrNames (ValD XValD GhcPs
_ (PatBind XPatBind GhcPs GhcPs
_ (L SrcSpanAnn' (EpAnn AnnListItem)
_ Pat GhcPs
n) GRHSs GhcPs (XRec GhcPs (HsExpr GhcPs))
_ ([CoreTickish], [[CoreTickish]])
_)) = forall a. a -> Maybe a
Just forall a b. (a -> b) -> a -> b
$ Pat GhcPs -> [RdrName]
patBindNames Pat GhcPs
n
funRdrNames HsDecl GhcPs
_ = forall a. Maybe a
Nothing

patSigRdrNames :: HsDecl GhcPs -> Maybe [RdrName]
patSigRdrNames :: HsDecl GhcPs -> Maybe [RdrName]
patSigRdrNames (SigD XSigD GhcPs
_ (PatSynSig XPatSynSig GhcPs
_ [LIdP GhcPs]
ns LHsSigType GhcPs
_)) = forall a. a -> Maybe a
Just forall a b. (a -> b) -> a -> b
$ forall a b. (a -> b) -> [a] -> [b]
map forall l e. GenLocated l e -> e
unLoc [LIdP GhcPs]
ns
patSigRdrNames HsDecl GhcPs
_ = forall a. Maybe a
Nothing

warnSigRdrNames :: HsDecl GhcPs -> Maybe [RdrName]
warnSigRdrNames :: HsDecl GhcPs -> Maybe [RdrName]
warnSigRdrNames (WarningD XWarningD GhcPs
_ (Warnings XWarnings GhcPs
_ SourceText
_ [LWarnDecl GhcPs]
ws)) = forall a. a -> Maybe a
Just forall a b. (a -> b) -> a -> b
$
  forall a b c. (a -> b -> c) -> b -> a -> c
flip forall (t :: * -> *) a b. Foldable t => (a -> [b]) -> t a -> [b]
concatMap [LWarnDecl GhcPs]
ws forall a b. (a -> b) -> a -> b
$
    \(L SrcSpanAnn' (EpAnn AnnListItem)
_ (Warning XWarning GhcPs
_ [LIdP GhcPs]
ns WarningTxt GhcPs
_)) -> forall a b. (a -> b) -> [a] -> [b]
map forall l e. GenLocated l e -> e
unLoc [LIdP GhcPs]
ns
warnSigRdrNames HsDecl GhcPs
_ = forall a. Maybe a
Nothing

patBindNames :: Pat GhcPs -> [RdrName]
patBindNames :: Pat GhcPs -> [RdrName]
patBindNames (TuplePat XTuplePat GhcPs
_ [LPat GhcPs]
ps Boxity
_) = forall (t :: * -> *) a b. Foldable t => (a -> [b]) -> t a -> [b]
concatMap (Pat GhcPs -> [RdrName]
patBindNames forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall l e. GenLocated l e -> e
unLoc) [LPat GhcPs]
ps
patBindNames (VarPat XVarPat GhcPs
_ (L SrcSpanAnnN
_ RdrName
n)) = [RdrName
n]
patBindNames (WildPat XWildPat GhcPs
_) = []
patBindNames (LazyPat XLazyPat GhcPs
_ (L SrcSpanAnn' (EpAnn AnnListItem)
_ Pat GhcPs
p)) = Pat GhcPs -> [RdrName]
patBindNames Pat GhcPs
p
patBindNames (BangPat XBangPat GhcPs
_ (L SrcSpanAnn' (EpAnn AnnListItem)
_ Pat GhcPs
p)) = Pat GhcPs -> [RdrName]
patBindNames Pat GhcPs
p
patBindNames (ParPat XParPat GhcPs
_ LHsToken "(" GhcPs
_ (L SrcSpanAnn' (EpAnn AnnListItem)
_ Pat GhcPs
p) LHsToken ")" GhcPs
_) = Pat GhcPs -> [RdrName]
patBindNames Pat GhcPs
p
patBindNames (ListPat XListPat GhcPs
_ [LPat GhcPs]
ps) = forall (t :: * -> *) a b. Foldable t => (a -> [b]) -> t a -> [b]
concatMap (Pat GhcPs -> [RdrName]
patBindNames forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall l e. GenLocated l e -> e
unLoc) [LPat GhcPs]
ps
patBindNames (AsPat XAsPat GhcPs
_ (L SrcSpanAnnN
_ RdrName
n) (L SrcSpanAnn' (EpAnn AnnListItem)
_ Pat GhcPs
p)) = RdrName
n forall a. a -> [a] -> [a]
: Pat GhcPs -> [RdrName]
patBindNames Pat GhcPs
p
patBindNames (SumPat XSumPat GhcPs
_ (L SrcSpanAnn' (EpAnn AnnListItem)
_ Pat GhcPs
p) Int
_ Int
_) = Pat GhcPs -> [RdrName]
patBindNames Pat GhcPs
p
patBindNames (ViewPat XViewPat GhcPs
_ XRec GhcPs (HsExpr GhcPs)
_ (L SrcSpanAnn' (EpAnn AnnListItem)
_ Pat GhcPs
p)) = Pat GhcPs -> [RdrName]
patBindNames Pat GhcPs
p
patBindNames (SplicePat XSplicePat GhcPs
_ HsSplice GhcPs
_) = []
patBindNames (LitPat XLitPat GhcPs
_ HsLit GhcPs
_) = []
patBindNames (SigPat XSigPat GhcPs
_ (L SrcSpanAnn' (EpAnn AnnListItem)
_ Pat GhcPs
p) HsPatSigType (NoGhcTc GhcPs)
_) = Pat GhcPs -> [RdrName]
patBindNames Pat GhcPs
p
patBindNames (NPat XNPat GhcPs
_ XRec GhcPs (HsOverLit GhcPs)
_ Maybe (SyntaxExpr GhcPs)
_ SyntaxExpr GhcPs
_) = []
patBindNames (NPlusKPat XNPlusKPat GhcPs
_ (L SrcSpanAnnN
_ RdrName
n) XRec GhcPs (HsOverLit GhcPs)
_ HsOverLit GhcPs
_ SyntaxExpr GhcPs
_ SyntaxExpr GhcPs
_) = [RdrName
n]
patBindNames (ConPat XConPat GhcPs
_ XRec GhcPs (ConLikeP GhcPs)
_ HsConPatDetails GhcPs
d) = forall (t :: * -> *) a b. Foldable t => (a -> [b]) -> t a -> [b]
concatMap (Pat GhcPs -> [RdrName]
patBindNames forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall l e. GenLocated l e -> e
unLoc) (forall p. UnXRec p => HsConPatDetails p -> [LPat p]
hsConPatArgs HsConPatDetails GhcPs
d)