{-# LANGUAGE ConstraintKinds #-}
{-# LANGUAGE DeriveDataTypeable #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE FlexibleInstances #-}
{-# LANGUAGE LambdaCase #-}
{-# LANGUAGE ScopedTypeVariables #-}
{-# LANGUAGE TypeApplications #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE UndecidableInstances #-} -- Wrinkle in Note [Trees That Grow]
                                      -- in module Language.Haskell.Syntax.Extension

{-# OPTIONS_GHC -Wno-orphans #-} -- Outputable

{-
(c) The University of Glasgow 2006
(c) The GRASP/AQUA Project, Glasgow University, 1992-1998

\section[HsBinds]{Abstract syntax: top-level bindings and signatures}

Datatype for: @BindGroup@, @Bind@, @Sig@, @Bind@.
-}

module GHC.Hs.Binds
  ( module Language.Haskell.Syntax.Binds
  , module GHC.Hs.Binds
  ) where

import GHC.Prelude

import Language.Haskell.Syntax.Binds

import {-# SOURCE #-} GHC.Hs.Expr ( pprExpr, pprFunBind, pprPatBind )
import {-# SOURCE #-} GHC.Hs.Pat  (pprLPat )

import Language.Haskell.Syntax.Extension
import GHC.Hs.Extension
import GHC.Parser.Annotation
import GHC.Hs.Type
import GHC.Tc.Types.Evidence
import GHC.Core.Type
import GHC.Types.Name.Set
import GHC.Types.Basic
import GHC.Types.SourceText
import GHC.Types.SrcLoc as SrcLoc
import GHC.Data.Bag
import GHC.Data.FastString
import GHC.Data.BooleanFormula (LBooleanFormula)
import GHC.Types.Name.Reader
import GHC.Types.Name
import GHC.Types.Id

import GHC.Utils.Outputable
import GHC.Utils.Panic

import Data.List (sortBy)
import Data.Function
import Data.Data (Data)

{-
************************************************************************
*                                                                      *
\subsection{Bindings: @BindGroup@}
*                                                                      *
************************************************************************

Global bindings (where clauses)
-}

-- the ...LR datatypes are parametrized by two id types,
-- one for the left and one for the right.

type instance XHsValBinds      (GhcPass pL) (GhcPass pR) = EpAnn AnnList
type instance XHsIPBinds       (GhcPass pL) (GhcPass pR) = EpAnn AnnList
type instance XEmptyLocalBinds (GhcPass pL) (GhcPass pR) = NoExtField
type instance XXHsLocalBindsLR (GhcPass pL) (GhcPass pR) = NoExtCon

-- ---------------------------------------------------------------------
-- Deal with ValBindsOut

-- TODO: make this the only type for ValBinds
data NHsValBindsLR idL
  = NValBinds
      [(RecFlag, LHsBinds idL)]
      [LSig GhcRn]

type instance XValBinds    (GhcPass pL) (GhcPass pR) = AnnSortKey
type instance XXValBindsLR (GhcPass pL) (GhcPass pR)
            = NHsValBindsLR (GhcPass pL)

-- ---------------------------------------------------------------------

type instance XFunBind    (GhcPass pL) GhcPs = NoExtField
type instance XFunBind    (GhcPass pL) GhcRn = NameSet    -- Free variables
type instance XFunBind    (GhcPass pL) GhcTc = HsWrapper  -- See comments on FunBind.fun_ext

type instance XPatBind    GhcPs (GhcPass pR) = EpAnn [AddEpAnn]
type instance XPatBind    GhcRn (GhcPass pR) = NameSet -- Free variables
type instance XPatBind    GhcTc (GhcPass pR) = Type    -- Type of the GRHSs

type instance XVarBind    (GhcPass pL) (GhcPass pR) = NoExtField
type instance XAbsBinds   (GhcPass pL) (GhcPass pR) = NoExtField
type instance XPatSynBind (GhcPass pL) (GhcPass pR) = NoExtField
type instance XXHsBindsLR (GhcPass pL) (GhcPass pR) = NoExtCon

type instance XABE       (GhcPass p) = NoExtField
type instance XXABExport (GhcPass p) = NoExtCon

type instance XPSB         (GhcPass idL) GhcPs = EpAnn [AddEpAnn]
type instance XPSB         (GhcPass idL) GhcRn = NameSet
type instance XPSB         (GhcPass idL) GhcTc = NameSet

type instance XXPatSynBind (GhcPass idL) (GhcPass idR) = NoExtCon

{-
Note [AbsBinds]
~~~~~~~~~~~~~~~
The AbsBinds constructor is used in the output of the type checker, to
record *typechecked* and *generalised* bindings.  Specifically

         AbsBinds { abs_tvs      = tvs
                  , abs_ev_vars  = [d1,d2]
                  , abs_exports  = [ABE { abe_poly = fp, abe_mono = fm
                                        , abe_wrap = fwrap }
                                    ABE { slly for g } ]
                  , abs_ev_binds = DBINDS
                  , abs_binds    = BIND[fm,gm] }

where 'BIND' binds the monomorphic Ids 'fm' and 'gm', means

        fp = fwrap [/\ tvs. \d1 d2. letrec { DBINDS        ]
                   [                       ; BIND[fm,gm] } ]
                   [                 in fm                 ]

        gp = ...same again, with gm instead of fm

The 'fwrap' is an impedance-matcher that typically does nothing; see
Note [ABExport wrapper].

This is a pretty bad translation, because it duplicates all the bindings.
So the desugarer tries to do a better job:

        fp = /\ [a,b] -> \ [d1,d2] -> case tp [a,b] [d1,d2] of
                                        (fm,gm) -> fm
        ..ditto for gp..

        tp = /\ [a,b] -> \ [d1,d2] -> letrec { DBINDS; BIND }
                                      in (fm,gm)

In general:

  * abs_tvs are the type variables over which the binding group is
    generalised
  * abs_ev_var are the evidence variables (usually dictionaries)
    over which the binding group is generalised
  * abs_binds are the monomorphic bindings
  * abs_ex_binds are the evidence bindings that wrap the abs_binds
  * abs_exports connects the monomorphic Ids bound by abs_binds
    with the polymorphic Ids bound by the AbsBinds itself.

For example, consider a module M, with this top-level binding, where
there is no type signature for M.reverse,
    M.reverse []     = []
    M.reverse (x:xs) = M.reverse xs ++ [x]

In Hindley-Milner, a recursive binding is typechecked with the
*recursive* uses being *monomorphic*.  So after typechecking *and*
desugaring we will get something like this

    M.reverse :: forall a. [a] -> [a]
      = /\a. letrec
                reverse :: [a] -> [a] = \xs -> case xs of
                                                []     -> []
                                                (x:xs) -> reverse xs ++ [x]
             in reverse

Notice that 'M.reverse' is polymorphic as expected, but there is a local
definition for plain 'reverse' which is *monomorphic*.  The type variable
'a' scopes over the entire letrec.

That's after desugaring.  What about after type checking but before
desugaring?  That's where AbsBinds comes in.  It looks like this:

   AbsBinds { abs_tvs     = [a]
            , abs_ev_vars = []
            , abs_exports = [ABE { abe_poly = M.reverse :: forall a. [a] -> [a],
                                 , abe_mono = reverse :: [a] -> [a]}]
            , abs_ev_binds = {}
            , abs_binds = { reverse :: [a] -> [a]
                               = \xs -> case xs of
                                            []     -> []
                                            (x:xs) -> reverse xs ++ [x] } }

Here,

  * abs_tvs says what type variables are abstracted over the binding
    group, just 'a' in this case.
  * abs_binds is the *monomorphic* bindings of the group
  * abs_exports describes how to get the polymorphic Id 'M.reverse'
    from the monomorphic one 'reverse'

Notice that the *original* function (the polymorphic one you thought
you were defining) appears in the abe_poly field of the
abs_exports. The bindings in abs_binds are for fresh, local, Ids with
a *monomorphic* Id.

If there is a group of mutually recursive (see Note [Polymorphic
recursion]) functions without type signatures, we get one AbsBinds
with the monomorphic versions of the bindings in abs_binds, and one
element of abe_exports for each variable bound in the mutually
recursive group.  This is true even for pattern bindings.  Example:
        (f,g) = (\x -> x, f)
After type checking we get
   AbsBinds { abs_tvs     = [a]
            , abs_exports = [ ABE { abe_poly = M.f :: forall a. a -> a
                                  , abe_mono = f :: a -> a }
                            , ABE { abe_poly = M.g :: forall a. a -> a
                                  , abe_mono = g :: a -> a }]
            , abs_binds = { (f,g) = (\x -> x, f) }

Note [Polymorphic recursion]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Consider
   Rec { f x = ...(g ef)...

       ; g :: forall a. [a] -> [a]
       ; g y = ...(f eg)...  }

These bindings /are/ mutually recursive (f calls g, and g calls f).
But we can use the type signature for g to break the recursion,
like this:

  1. Add g :: forall a. [a] -> [a] to the type environment

  2. Typecheck the definition of f, all by itself,
     including generalising it to find its most general
     type, say f :: forall b. b -> b -> [b]

  3. Extend the type environment with that type for f

  4. Typecheck the definition of g, all by itself,
     checking that it has the type claimed by its signature

Steps 2 and 4 each generate a separate AbsBinds, so we end
up with
   Rec { AbsBinds { ...for f ... }
       ; AbsBinds { ...for g ... } }

This approach allows both f and to call each other
polymorphically, even though only g has a signature.

We get an AbsBinds that encompasses multiple source-program
bindings only when
 * Each binding in the group has at least one binder that
   lacks a user type signature
 * The group forms a strongly connected component


Note [The abs_sig field of AbsBinds]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The abs_sig field supports a couple of special cases for bindings.
Consider

  x :: Num a => (# a, a #)
  x = (# 3, 4 #)

The general desugaring for AbsBinds would give

  x = /\a. \ ($dNum :: Num a) ->
      letrec xm = (# fromInteger $dNum 3, fromInteger $dNum 4 #) in
      xm

But that has an illegal let-binding for an unboxed tuple.  In this
case we'd prefer to generate the (more direct)

  x = /\ a. \ ($dNum :: Num a) ->
     (# fromInteger $dNum 3, fromInteger $dNum 4 #)

A similar thing happens with representation-polymorphic defns
(#11405):

  undef :: forall (r :: RuntimeRep) (a :: TYPE r). HasCallStack => a
  undef = error "undef"

Again, the vanilla desugaring gives a local let-binding for a
representation-polymorphic (undefm :: a), which is illegal.  But
again we can desugar without a let:

  undef = /\ a. \ (d:HasCallStack) -> error a d "undef"

The abs_sig field supports this direct desugaring, with no local
let-binding.  When abs_sig = True

 * the abs_binds is single FunBind

 * the abs_exports is a singleton

 * we have a complete type sig for binder
   and hence the abs_binds is non-recursive
   (it binds the mono_id but refers to the poly_id

These properties are exploited in GHC.HsToCore.Binds.dsAbsBinds to
generate code without a let-binding.

Note [ABExport wrapper]
~~~~~~~~~~~~~~~~~~~~~~~
Consider
   (f,g) = (\x.x, \y.y)
This ultimately desugars to something like this:
   tup :: forall a b. (a->a, b->b)
   tup = /\a b. (\x:a.x, \y:b.y)
   f :: forall a. a -> a
   f = /\a. case tup a Any of
               (fm::a->a,gm:Any->Any) -> fm
   ...similarly for g...

The abe_wrap field deals with impedance-matching between
    (/\a b. case tup a b of { (f,g) -> f })
and the thing we really want, which may have fewer type
variables.  The action happens in GHC.Tc.Gen.Bind.mkExport.

Note [Bind free vars]
~~~~~~~~~~~~~~~~~~~~~
The bind_fvs field of FunBind and PatBind records the free variables
of the definition.  It is used for the following purposes

a) Dependency analysis prior to type checking
    (see GHC.Tc.Gen.Bind.tc_group)

b) Deciding whether we can do generalisation of the binding
    (see GHC.Tc.Gen.Bind.decideGeneralisationPlan)

c) Deciding whether the binding can be used in static forms
    (see GHC.Tc.Gen.Expr.checkClosedInStaticForm for the HsStatic case and
     GHC.Tc.Gen.Bind.isClosedBndrGroup).

Specifically,

  * bind_fvs includes all free vars that are defined in this module
    (including top-level things and lexically scoped type variables)

  * bind_fvs excludes imported vars; this is just to keep the set smaller

  * Before renaming, and after typechecking, the field is unused;
    it's just an error thunk
-}

instance (OutputableBndrId pl, OutputableBndrId pr)
        => Outputable (HsLocalBindsLR (GhcPass pl) (GhcPass pr)) where
  ppr :: HsLocalBindsLR (GhcPass pl) (GhcPass pr) -> SDoc
ppr (HsValBinds XHsValBinds (GhcPass pl) (GhcPass pr)
_ HsValBindsLR (GhcPass pl) (GhcPass pr)
bs)   = forall a. Outputable a => a -> SDoc
ppr HsValBindsLR (GhcPass pl) (GhcPass pr)
bs
  ppr (HsIPBinds XHsIPBinds (GhcPass pl) (GhcPass pr)
_ HsIPBinds (GhcPass pr)
bs)    = forall a. Outputable a => a -> SDoc
ppr HsIPBinds (GhcPass pr)
bs
  ppr (EmptyLocalBinds XEmptyLocalBinds (GhcPass pl) (GhcPass pr)
_) = SDoc
empty

instance (OutputableBndrId pl, OutputableBndrId pr)
        => Outputable (HsValBindsLR (GhcPass pl) (GhcPass pr)) where
  ppr :: HsValBindsLR (GhcPass pl) (GhcPass pr) -> SDoc
ppr (ValBinds XValBinds (GhcPass pl) (GhcPass pr)
_ LHsBindsLR (GhcPass pl) (GhcPass pr)
binds [LSig (GhcPass pr)]
sigs)
   = [SDoc] -> SDoc
pprDeclList (forall (idL :: Pass) (idR :: Pass) (id2 :: Pass).
(OutputableBndrId idL, OutputableBndrId idR,
 OutputableBndrId id2) =>
LHsBindsLR (GhcPass idL) (GhcPass idR)
-> [LSig (GhcPass id2)] -> [SDoc]
pprLHsBindsForUser LHsBindsLR (GhcPass pl) (GhcPass pr)
binds [LSig (GhcPass pr)]
sigs)

  ppr (XValBindsLR (NValBinds [(RecFlag, LHsBinds (GhcPass pl))]
sccs [LSig GhcRn]
sigs))
    = (Bool -> SDoc) -> SDoc
getPprDebug forall a b. (a -> b) -> a -> b
$ \case
        -- Print with sccs showing
        Bool
True  -> [SDoc] -> SDoc
vcat (forall a b. (a -> b) -> [a] -> [b]
map forall a. Outputable a => a -> SDoc
ppr [LSig GhcRn]
sigs) SDoc -> SDoc -> SDoc
$$ [SDoc] -> SDoc
vcat (forall a b. (a -> b) -> [a] -> [b]
map forall {idL :: Pass} {idR :: Pass}.
(OutputableBndr (IdGhcP idL), OutputableBndr (IdGhcP idR),
 OutputableBndr (IdGhcP (NoGhcTcPass idL)),
 OutputableBndr (IdGhcP (NoGhcTcPass idR)), IsPass idL, IsPass idR,
 Outputable (GenLocated (Anno (IdGhcP idL)) (IdGhcP idL)),
 Outputable (GenLocated (Anno (IdGhcP idR)) (IdGhcP idR)),
 Outputable
   (GenLocated
      (Anno (IdGhcP (NoGhcTcPass idL))) (IdGhcP (NoGhcTcPass idL))),
 Outputable
   (GenLocated
      (Anno (IdGhcP (NoGhcTcPass idR))) (IdGhcP (NoGhcTcPass idR)))) =>
(RecFlag,
 Bag
   (GenLocated SrcSpanAnnA (HsBindLR (GhcPass idL) (GhcPass idR))))
-> SDoc
ppr_scc [(RecFlag, LHsBinds (GhcPass pl))]
sccs)
        Bool
False -> [SDoc] -> SDoc
pprDeclList (forall (idL :: Pass) (idR :: Pass) (id2 :: Pass).
(OutputableBndrId idL, OutputableBndrId idR,
 OutputableBndrId id2) =>
LHsBindsLR (GhcPass idL) (GhcPass idR)
-> [LSig (GhcPass id2)] -> [SDoc]
pprLHsBindsForUser (forall a. [Bag a] -> Bag a
unionManyBags (forall a b. (a -> b) -> [a] -> [b]
map forall a b. (a, b) -> b
snd [(RecFlag, LHsBinds (GhcPass pl))]
sccs)) [LSig GhcRn]
sigs)
   where
     ppr_scc :: (RecFlag,
 Bag
   (GenLocated SrcSpanAnnA (HsBindLR (GhcPass idL) (GhcPass idR))))
-> SDoc
ppr_scc (RecFlag
rec_flag, Bag (GenLocated SrcSpanAnnA (HsBindLR (GhcPass idL) (GhcPass idR)))
binds) = RecFlag -> SDoc
pp_rec RecFlag
rec_flag SDoc -> SDoc -> SDoc
<+> forall (idL :: Pass) (idR :: Pass).
(OutputableBndrId idL, OutputableBndrId idR) =>
LHsBindsLR (GhcPass idL) (GhcPass idR) -> SDoc
pprLHsBinds Bag (GenLocated SrcSpanAnnA (HsBindLR (GhcPass idL) (GhcPass idR)))
binds
     pp_rec :: RecFlag -> SDoc
pp_rec RecFlag
Recursive    = String -> SDoc
text String
"rec"
     pp_rec RecFlag
NonRecursive = String -> SDoc
text String
"nonrec"

pprLHsBinds :: (OutputableBndrId idL, OutputableBndrId idR)
            => LHsBindsLR (GhcPass idL) (GhcPass idR) -> SDoc
pprLHsBinds :: forall (idL :: Pass) (idR :: Pass).
(OutputableBndrId idL, OutputableBndrId idR) =>
LHsBindsLR (GhcPass idL) (GhcPass idR) -> SDoc
pprLHsBinds LHsBindsLR (GhcPass idL) (GhcPass idR)
binds
  | forall (idL :: Pass) idR. LHsBindsLR (GhcPass idL) idR -> Bool
isEmptyLHsBinds LHsBindsLR (GhcPass idL) (GhcPass idR)
binds = SDoc
empty
  | Bool
otherwise = [SDoc] -> SDoc
pprDeclList (forall a b. (a -> b) -> [a] -> [b]
map forall a. Outputable a => a -> SDoc
ppr (forall a. Bag a -> [a]
bagToList LHsBindsLR (GhcPass idL) (GhcPass idR)
binds))

pprLHsBindsForUser :: (OutputableBndrId idL,
                       OutputableBndrId idR,
                       OutputableBndrId id2)
     => LHsBindsLR (GhcPass idL) (GhcPass idR) -> [LSig (GhcPass id2)] -> [SDoc]
--  pprLHsBindsForUser is different to pprLHsBinds because
--  a) No braces: 'let' and 'where' include a list of HsBindGroups
--     and we don't want several groups of bindings each
--     with braces around
--  b) Sort by location before printing
--  c) Include signatures
pprLHsBindsForUser :: forall (idL :: Pass) (idR :: Pass) (id2 :: Pass).
(OutputableBndrId idL, OutputableBndrId idR,
 OutputableBndrId id2) =>
LHsBindsLR (GhcPass idL) (GhcPass idR)
-> [LSig (GhcPass id2)] -> [SDoc]
pprLHsBindsForUser LHsBindsLR (GhcPass idL) (GhcPass idR)
binds [LSig (GhcPass id2)]
sigs
  = forall a b. (a -> b) -> [a] -> [b]
map forall a b. (a, b) -> b
snd (forall {b}. [(SrcSpan, b)] -> [(SrcSpan, b)]
sort_by_loc [(SrcSpan, SDoc)]
decls)
  where

    decls :: [(SrcSpan, SDoc)]
    decls :: [(SrcSpan, SDoc)]
decls = [(forall a. SrcSpanAnn' a -> SrcSpan
locA SrcSpanAnnA
loc, forall a. Outputable a => a -> SDoc
ppr Sig (GhcPass id2)
sig)  | L SrcSpanAnnA
loc Sig (GhcPass id2)
sig <- [LSig (GhcPass id2)]
sigs] forall a. [a] -> [a] -> [a]
++
            [(forall a. SrcSpanAnn' a -> SrcSpan
locA SrcSpanAnnA
loc, forall a. Outputable a => a -> SDoc
ppr HsBindLR (GhcPass idL) (GhcPass idR)
bind) | L SrcSpanAnnA
loc HsBindLR (GhcPass idL) (GhcPass idR)
bind <- forall a. Bag a -> [a]
bagToList LHsBindsLR (GhcPass idL) (GhcPass idR)
binds]

    sort_by_loc :: [(SrcSpan, b)] -> [(SrcSpan, b)]
sort_by_loc [(SrcSpan, b)]
decls = forall a. (a -> a -> Ordering) -> [a] -> [a]
sortBy (SrcSpan -> SrcSpan -> Ordering
SrcLoc.leftmost_smallest forall b c a. (b -> b -> c) -> (a -> b) -> a -> a -> c
`on` forall a b. (a, b) -> a
fst) [(SrcSpan, b)]
decls

pprDeclList :: [SDoc] -> SDoc   -- Braces with a space
-- Print a bunch of declarations
-- One could choose  { d1; d2; ... }, using 'sep'
-- or      d1
--         d2
--         ..
--    using vcat
-- At the moment we chose the latter
-- Also we do the 'pprDeeperList' thing.
pprDeclList :: [SDoc] -> SDoc
pprDeclList [SDoc]
ds = ([SDoc] -> SDoc) -> [SDoc] -> SDoc
pprDeeperList [SDoc] -> SDoc
vcat [SDoc]
ds

------------
emptyLocalBinds :: HsLocalBindsLR (GhcPass a) (GhcPass b)
emptyLocalBinds :: forall (a :: Pass) (b :: Pass).
HsLocalBindsLR (GhcPass a) (GhcPass b)
emptyLocalBinds = forall idL idR. XEmptyLocalBinds idL idR -> HsLocalBindsLR idL idR
EmptyLocalBinds NoExtField
noExtField

eqEmptyLocalBinds :: HsLocalBindsLR a b -> Bool
eqEmptyLocalBinds :: forall a b. HsLocalBindsLR a b -> Bool
eqEmptyLocalBinds (EmptyLocalBinds XEmptyLocalBinds a b
_) = Bool
True
eqEmptyLocalBinds HsLocalBindsLR a b
_                   = Bool
False

isEmptyValBinds :: HsValBindsLR (GhcPass a) (GhcPass b) -> Bool
isEmptyValBinds :: forall (a :: Pass) (b :: Pass).
HsValBindsLR (GhcPass a) (GhcPass b) -> Bool
isEmptyValBinds (ValBinds XValBinds (GhcPass a) (GhcPass b)
_ LHsBindsLR (GhcPass a) (GhcPass b)
ds [LSig (GhcPass b)]
sigs)  = forall (idL :: Pass) idR. LHsBindsLR (GhcPass idL) idR -> Bool
isEmptyLHsBinds LHsBindsLR (GhcPass a) (GhcPass b)
ds Bool -> Bool -> Bool
&& forall (t :: * -> *) a. Foldable t => t a -> Bool
null [LSig (GhcPass b)]
sigs
isEmptyValBinds (XValBindsLR (NValBinds [(RecFlag, LHsBinds (GhcPass a))]
ds [LSig GhcRn]
sigs)) = forall (t :: * -> *) a. Foldable t => t a -> Bool
null [(RecFlag, LHsBinds (GhcPass a))]
ds Bool -> Bool -> Bool
&& forall (t :: * -> *) a. Foldable t => t a -> Bool
null [LSig GhcRn]
sigs

emptyValBindsIn, emptyValBindsOut :: HsValBindsLR (GhcPass a) (GhcPass b)
emptyValBindsIn :: forall (a :: Pass) (b :: Pass).
HsValBindsLR (GhcPass a) (GhcPass b)
emptyValBindsIn  = forall idL idR.
XValBinds idL idR
-> LHsBindsLR idL idR -> [LSig idR] -> HsValBindsLR idL idR
ValBinds AnnSortKey
NoAnnSortKey forall a. Bag a
emptyBag []
emptyValBindsOut :: forall (a :: Pass) (b :: Pass).
HsValBindsLR (GhcPass a) (GhcPass b)
emptyValBindsOut = forall idL idR. XXValBindsLR idL idR -> HsValBindsLR idL idR
XValBindsLR (forall idL.
[(RecFlag, LHsBinds idL)] -> [LSig GhcRn] -> NHsValBindsLR idL
NValBinds [] [])

emptyLHsBinds :: LHsBindsLR (GhcPass idL) idR
emptyLHsBinds :: forall (idL :: Pass) idR. LHsBindsLR (GhcPass idL) idR
emptyLHsBinds = forall a. Bag a
emptyBag

isEmptyLHsBinds :: LHsBindsLR (GhcPass idL) idR -> Bool
isEmptyLHsBinds :: forall (idL :: Pass) idR. LHsBindsLR (GhcPass idL) idR -> Bool
isEmptyLHsBinds = forall a. Bag a -> Bool
isEmptyBag

------------
plusHsValBinds :: HsValBinds (GhcPass a) -> HsValBinds (GhcPass a)
               -> HsValBinds(GhcPass a)
plusHsValBinds :: forall (a :: Pass).
HsValBinds (GhcPass a)
-> HsValBinds (GhcPass a) -> HsValBinds (GhcPass a)
plusHsValBinds (ValBinds XValBinds (GhcPass a) (GhcPass a)
_ LHsBindsLR (GhcPass a) (GhcPass a)
ds1 [LSig (GhcPass a)]
sigs1) (ValBinds XValBinds (GhcPass a) (GhcPass a)
_ LHsBindsLR (GhcPass a) (GhcPass a)
ds2 [LSig (GhcPass a)]
sigs2)
  = forall idL idR.
XValBinds idL idR
-> LHsBindsLR idL idR -> [LSig idR] -> HsValBindsLR idL idR
ValBinds AnnSortKey
NoAnnSortKey (LHsBindsLR (GhcPass a) (GhcPass a)
ds1 forall a. Bag a -> Bag a -> Bag a
`unionBags` LHsBindsLR (GhcPass a) (GhcPass a)
ds2) ([LSig (GhcPass a)]
sigs1 forall a. [a] -> [a] -> [a]
++ [LSig (GhcPass a)]
sigs2)
plusHsValBinds (XValBindsLR (NValBinds [(RecFlag, LHsBindsLR (GhcPass a) (GhcPass a))]
ds1 [LSig GhcRn]
sigs1))
               (XValBindsLR (NValBinds [(RecFlag, LHsBindsLR (GhcPass a) (GhcPass a))]
ds2 [LSig GhcRn]
sigs2))
  = forall idL idR. XXValBindsLR idL idR -> HsValBindsLR idL idR
XValBindsLR (forall idL.
[(RecFlag, LHsBinds idL)] -> [LSig GhcRn] -> NHsValBindsLR idL
NValBinds ([(RecFlag, LHsBindsLR (GhcPass a) (GhcPass a))]
ds1 forall a. [a] -> [a] -> [a]
++ [(RecFlag, LHsBindsLR (GhcPass a) (GhcPass a))]
ds2) ([LSig GhcRn]
sigs1 forall a. [a] -> [a] -> [a]
++ [LSig GhcRn]
sigs2))
plusHsValBinds HsValBindsLR (GhcPass a) (GhcPass a)
_ HsValBindsLR (GhcPass a) (GhcPass a)
_
  = forall a. String -> a
panic String
"HsBinds.plusHsValBinds"

instance (OutputableBndrId pl, OutputableBndrId pr)
         => Outputable (HsBindLR (GhcPass pl) (GhcPass pr)) where
    ppr :: HsBindLR (GhcPass pl) (GhcPass pr) -> SDoc
ppr HsBindLR (GhcPass pl) (GhcPass pr)
mbind = forall (pl :: Pass) (pr :: Pass).
(OutputableBndrId pl, OutputableBndrId pr) =>
HsBindLR (GhcPass pl) (GhcPass pr) -> SDoc
ppr_monobind HsBindLR (GhcPass pl) (GhcPass pr)
mbind

ppr_monobind :: forall idL idR.
                (OutputableBndrId idL, OutputableBndrId idR)
             => HsBindLR (GhcPass idL) (GhcPass idR) -> SDoc

ppr_monobind :: forall (pl :: Pass) (pr :: Pass).
(OutputableBndrId pl, OutputableBndrId pr) =>
HsBindLR (GhcPass pl) (GhcPass pr) -> SDoc
ppr_monobind (PatBind { pat_lhs :: forall idL idR. HsBindLR idL idR -> LPat idL
pat_lhs = LPat (GhcPass idL)
pat, pat_rhs :: forall idL idR. HsBindLR idL idR -> GRHSs idR (LHsExpr idR)
pat_rhs = GRHSs (GhcPass idR) (LHsExpr (GhcPass idR))
grhss })
  = forall (bndr :: Pass) (p :: Pass).
(OutputableBndrId bndr, OutputableBndrId p) =>
LPat (GhcPass bndr)
-> GRHSs (GhcPass p) (LHsExpr (GhcPass p)) -> SDoc
pprPatBind LPat (GhcPass idL)
pat GRHSs (GhcPass idR) (LHsExpr (GhcPass idR))
grhss
ppr_monobind (VarBind { var_id :: forall idL idR. HsBindLR idL idR -> IdP idL
var_id = IdP (GhcPass idL)
var, var_rhs :: forall idL idR. HsBindLR idL idR -> LHsExpr idR
var_rhs = LHsExpr (GhcPass idR)
rhs })
  = [SDoc] -> SDoc
sep [forall a. OutputableBndr a => BindingSite -> a -> SDoc
pprBndr BindingSite
CasePatBind IdP (GhcPass idL)
var, Int -> SDoc -> SDoc
nest Int
2 forall a b. (a -> b) -> a -> b
$ SDoc
equals SDoc -> SDoc -> SDoc
<+> forall (p :: Pass).
OutputableBndrId p =>
HsExpr (GhcPass p) -> SDoc
pprExpr (forall l e. GenLocated l e -> e
unLoc LHsExpr (GhcPass idR)
rhs)]
ppr_monobind (FunBind { fun_id :: forall idL idR. HsBindLR idL idR -> LIdP idL
fun_id = LIdP (GhcPass idL)
fun,
                        fun_matches :: forall idL idR. HsBindLR idL idR -> MatchGroup idR (LHsExpr idR)
fun_matches = MatchGroup (GhcPass idR) (LHsExpr (GhcPass idR))
matches,
                        fun_tick :: forall idL idR. HsBindLR idL idR -> [CoreTickish]
fun_tick = [CoreTickish]
ticks,
                        fun_ext :: forall idL idR. HsBindLR idL idR -> XFunBind idL idR
fun_ext = XFunBind (GhcPass idL) (GhcPass idR)
wrap })
  = SDoc -> SDoc -> SDoc
pprTicks SDoc
empty (if forall (t :: * -> *) a. Foldable t => t a -> Bool
null [CoreTickish]
ticks then SDoc
empty
                    else String -> SDoc
text String
"-- ticks = " SDoc -> SDoc -> SDoc
<> forall a. Outputable a => a -> SDoc
ppr [CoreTickish]
ticks)
    SDoc -> SDoc -> SDoc
$$  SDoc -> SDoc
whenPprDebug (forall a. OutputableBndr a => BindingSite -> a -> SDoc
pprBndr BindingSite
LetBind (forall l e. GenLocated l e -> e
unLoc LIdP (GhcPass idL)
fun))
    SDoc -> SDoc -> SDoc
$$  forall (idR :: Pass).
OutputableBndrId idR =>
MatchGroup (GhcPass idR) (LHsExpr (GhcPass idR)) -> SDoc
pprFunBind  MatchGroup (GhcPass idR) (LHsExpr (GhcPass idR))
matches
    SDoc -> SDoc -> SDoc
$$  SDoc -> SDoc
whenPprDebug (forall (p :: Pass).
IsPass p =>
((p ~ 'Typechecked) => SDoc) -> SDoc
pprIfTc @idR forall a b. (a -> b) -> a -> b
$ forall a. Outputable a => a -> SDoc
ppr XFunBind (GhcPass idL) (GhcPass idR)
wrap)

ppr_monobind (PatSynBind XPatSynBind (GhcPass idL) (GhcPass idR)
_ PatSynBind (GhcPass idL) (GhcPass idR)
psb) = forall a. Outputable a => a -> SDoc
ppr PatSynBind (GhcPass idL) (GhcPass idR)
psb
ppr_monobind (AbsBinds { abs_tvs :: forall idL idR. HsBindLR idL idR -> [TyVar]
abs_tvs = [TyVar]
tyvars, abs_ev_vars :: forall idL idR. HsBindLR idL idR -> [TyVar]
abs_ev_vars = [TyVar]
dictvars
                       , abs_exports :: forall idL idR. HsBindLR idL idR -> [ABExport idL]
abs_exports = [ABExport (GhcPass idL)]
exports, abs_binds :: forall idL idR. HsBindLR idL idR -> LHsBinds idL
abs_binds = LHsBinds (GhcPass idL)
val_binds
                       , abs_ev_binds :: forall idL idR. HsBindLR idL idR -> [TcEvBinds]
abs_ev_binds = [TcEvBinds]
ev_binds })
  = forall a. (SDocContext -> a) -> (a -> SDoc) -> SDoc
sdocOption SDocContext -> Bool
sdocPrintTypecheckerElaboration forall a b. (a -> b) -> a -> b
$ \case
      Bool
False -> forall (idL :: Pass) (idR :: Pass).
(OutputableBndrId idL, OutputableBndrId idR) =>
LHsBindsLR (GhcPass idL) (GhcPass idR) -> SDoc
pprLHsBinds LHsBinds (GhcPass idL)
val_binds
      Bool
True  -> -- Show extra information (bug number: #10662)
               SDoc -> Int -> SDoc -> SDoc
hang (String -> SDoc
text String
"AbsBinds"
                     SDoc -> SDoc -> SDoc
<+> [SDoc] -> SDoc
sep [ SDoc -> SDoc
brackets (forall a. Outputable a => [a] -> SDoc
interpp'SP [TyVar]
tyvars)
                             , SDoc -> SDoc
brackets (forall a. Outputable a => [a] -> SDoc
interpp'SP [TyVar]
dictvars) ])
                  Int
2 forall a b. (a -> b) -> a -> b
$ SDoc -> SDoc
braces forall a b. (a -> b) -> a -> b
$ [SDoc] -> SDoc
vcat
               [ String -> SDoc
text String
"Exports:" SDoc -> SDoc -> SDoc
<+>
                   SDoc -> SDoc
brackets ([SDoc] -> SDoc
sep (SDoc -> [SDoc] -> [SDoc]
punctuate SDoc
comma (forall a b. (a -> b) -> [a] -> [b]
map forall a. Outputable a => a -> SDoc
ppr [ABExport (GhcPass idL)]
exports)))
               , String -> SDoc
text String
"Exported types:" SDoc -> SDoc -> SDoc
<+>
                   [SDoc] -> SDoc
vcat [forall a. OutputableBndr a => BindingSite -> a -> SDoc
pprBndr BindingSite
LetBind (forall p. ABExport p -> IdP p
abe_poly ABExport (GhcPass idL)
ex) | ABExport (GhcPass idL)
ex <- [ABExport (GhcPass idL)]
exports]
               , String -> SDoc
text String
"Binds:" SDoc -> SDoc -> SDoc
<+> forall (idL :: Pass) (idR :: Pass).
(OutputableBndrId idL, OutputableBndrId idR) =>
LHsBindsLR (GhcPass idL) (GhcPass idR) -> SDoc
pprLHsBinds LHsBinds (GhcPass idL)
val_binds
               , forall (p :: Pass).
IsPass p =>
((p ~ 'Typechecked) => SDoc) -> SDoc
pprIfTc @idR (String -> SDoc
text String
"Evidence:" SDoc -> SDoc -> SDoc
<+> forall a. Outputable a => a -> SDoc
ppr [TcEvBinds]
ev_binds)
               ]

instance OutputableBndrId p => Outputable (ABExport (GhcPass p)) where
  ppr :: ABExport (GhcPass p) -> SDoc
ppr (ABE { abe_wrap :: forall p. ABExport p -> HsWrapper
abe_wrap = HsWrapper
wrap, abe_poly :: forall p. ABExport p -> IdP p
abe_poly = IdP (GhcPass p)
gbl, abe_mono :: forall p. ABExport p -> IdP p
abe_mono = IdP (GhcPass p)
lcl, abe_prags :: forall p. ABExport p -> TcSpecPrags
abe_prags = TcSpecPrags
prags })
    = [SDoc] -> SDoc
vcat [ [SDoc] -> SDoc
sep [ forall a. Outputable a => a -> SDoc
ppr IdP (GhcPass p)
gbl, Int -> SDoc -> SDoc
nest Int
2 (String -> SDoc
text String
"<=" SDoc -> SDoc -> SDoc
<+> forall a. Outputable a => a -> SDoc
ppr IdP (GhcPass p)
lcl) ]
           , Int -> SDoc -> SDoc
nest Int
2 (TcSpecPrags -> SDoc
pprTcSpecPrags TcSpecPrags
prags)
           , forall (p :: Pass).
IsPass p =>
((p ~ 'Typechecked) => SDoc) -> SDoc
pprIfTc @p forall a b. (a -> b) -> a -> b
$ Int -> SDoc -> SDoc
nest Int
2 (String -> SDoc
text String
"wrap:" SDoc -> SDoc -> SDoc
<+> forall a. Outputable a => a -> SDoc
ppr HsWrapper
wrap) ]

instance (OutputableBndrId l, OutputableBndrId r)
          => Outputable (PatSynBind (GhcPass l) (GhcPass r)) where
  ppr :: PatSynBind (GhcPass l) (GhcPass r) -> SDoc
ppr (PSB{ psb_id :: forall idL idR. PatSynBind idL idR -> LIdP idL
psb_id = (L Anno (IdGhcP l)
_ IdGhcP l
psyn), psb_args :: forall idL idR. PatSynBind idL idR -> HsPatSynDetails idR
psb_args = HsPatSynDetails (GhcPass r)
details, psb_def :: forall idL idR. PatSynBind idL idR -> LPat idR
psb_def = LPat (GhcPass r)
pat,
            psb_dir :: forall idL idR. PatSynBind idL idR -> HsPatSynDir idR
psb_dir = HsPatSynDir (GhcPass r)
dir })
      = SDoc
ppr_lhs SDoc -> SDoc -> SDoc
<+> SDoc
ppr_rhs
    where
      ppr_lhs :: SDoc
ppr_lhs = String -> SDoc
text String
"pattern" SDoc -> SDoc -> SDoc
<+> SDoc
ppr_details
      ppr_simple :: SDoc -> SDoc
ppr_simple SDoc
syntax = SDoc
syntax SDoc -> SDoc -> SDoc
<+> forall (p :: Pass). OutputableBndrId p => LPat (GhcPass p) -> SDoc
pprLPat LPat (GhcPass r)
pat

      ppr_details :: SDoc
ppr_details = case HsPatSynDetails (GhcPass r)
details of
          InfixCon LIdP (GhcPass r)
v1 LIdP (GhcPass r)
v2 -> [SDoc] -> SDoc
hsep [GenLocated (Anno (IdGhcP r)) (IdGhcP r) -> SDoc
ppr_v LIdP (GhcPass r)
v1, forall a. OutputableBndr a => a -> SDoc
pprInfixOcc IdGhcP l
psyn, GenLocated (Anno (IdGhcP r)) (IdGhcP r) -> SDoc
ppr_v  LIdP (GhcPass r)
v2]
            where
                ppr_v :: GenLocated (Anno (IdGhcP r)) (IdGhcP r) -> SDoc
ppr_v GenLocated (Anno (IdGhcP r)) (IdGhcP r)
v = case forall (p :: Pass). IsPass p => GhcPass p
ghcPass @r of
                    GhcPass r
GhcPs -> forall a. Outputable a => a -> SDoc
ppr GenLocated (Anno (IdGhcP r)) (IdGhcP r)
v
                    GhcPass r
GhcRn -> forall a. Outputable a => a -> SDoc
ppr GenLocated (Anno (IdGhcP r)) (IdGhcP r)
v
                    GhcPass r
GhcTc -> forall a. Outputable a => a -> SDoc
ppr GenLocated (Anno (IdGhcP r)) (IdGhcP r)
v
          PrefixCon [Void]
_ [LIdP (GhcPass r)]
vs -> [SDoc] -> SDoc
hsep (forall a. OutputableBndr a => a -> SDoc
pprPrefixOcc IdGhcP l
psyn forall a. a -> [a] -> [a]
: forall a b. (a -> b) -> [a] -> [b]
map GenLocated (Anno (IdGhcP r)) (IdGhcP r) -> SDoc
ppr_v [LIdP (GhcPass r)]
vs)
            where
                ppr_v :: GenLocated (Anno (IdGhcP r)) (IdGhcP r) -> SDoc
ppr_v GenLocated (Anno (IdGhcP r)) (IdGhcP r)
v = case forall (p :: Pass). IsPass p => GhcPass p
ghcPass @r of
                    GhcPass r
GhcPs -> forall a. Outputable a => a -> SDoc
ppr GenLocated (Anno (IdGhcP r)) (IdGhcP r)
v
                    GhcPass r
GhcRn -> forall a. Outputable a => a -> SDoc
ppr GenLocated (Anno (IdGhcP r)) (IdGhcP r)
v
                    GhcPass r
GhcTc -> forall a. Outputable a => a -> SDoc
ppr GenLocated (Anno (IdGhcP r)) (IdGhcP r)
v
          RecCon [RecordPatSynField (GhcPass r)]
vs      -> forall a. OutputableBndr a => a -> SDoc
pprPrefixOcc IdGhcP l
psyn
                            SDoc -> SDoc -> SDoc
<> SDoc -> SDoc
braces ([SDoc] -> SDoc
sep (SDoc -> [SDoc] -> [SDoc]
punctuate SDoc
comma (forall a b. (a -> b) -> [a] -> [b]
map RecordPatSynField (GhcPass r) -> SDoc
ppr_v [RecordPatSynField (GhcPass r)]
vs)))
            where
                ppr_v :: RecordPatSynField (GhcPass r) -> SDoc
ppr_v RecordPatSynField (GhcPass r)
v = case forall (p :: Pass). IsPass p => GhcPass p
ghcPass @r of
                    GhcPass r
GhcPs -> forall a. Outputable a => a -> SDoc
ppr RecordPatSynField (GhcPass r)
v
                    GhcPass r
GhcRn -> forall a. Outputable a => a -> SDoc
ppr RecordPatSynField (GhcPass r)
v
                    GhcPass r
GhcTc -> forall a. Outputable a => a -> SDoc
ppr RecordPatSynField (GhcPass r)
v

      ppr_rhs :: SDoc
ppr_rhs = case HsPatSynDir (GhcPass r)
dir of
          HsPatSynDir (GhcPass r)
Unidirectional           -> SDoc -> SDoc
ppr_simple (String -> SDoc
text String
"<-")
          HsPatSynDir (GhcPass r)
ImplicitBidirectional    -> SDoc -> SDoc
ppr_simple SDoc
equals
          ExplicitBidirectional MatchGroup (GhcPass r) (LHsExpr (GhcPass r))
mg -> SDoc -> SDoc
ppr_simple (String -> SDoc
text String
"<-") SDoc -> SDoc -> SDoc
<+> PtrString -> SDoc
ptext (String -> PtrString
sLit String
"where") SDoc -> SDoc -> SDoc
$$
                                      (Int -> SDoc -> SDoc
nest Int
2 forall a b. (a -> b) -> a -> b
$ forall (idR :: Pass).
OutputableBndrId idR =>
MatchGroup (GhcPass idR) (LHsExpr (GhcPass idR)) -> SDoc
pprFunBind MatchGroup (GhcPass r) (LHsExpr (GhcPass r))
mg)

pprTicks :: SDoc -> SDoc -> SDoc
-- Print stuff about ticks only when -dppr-debug is on, to avoid
-- them appearing in error messages (from the desugarer); see # 3263
-- Also print ticks in dumpStyle, so that -ddump-hpc actually does
-- something useful.
pprTicks :: SDoc -> SDoc -> SDoc
pprTicks SDoc
pp_no_debug SDoc
pp_when_debug
  = (PprStyle -> SDoc) -> SDoc
getPprStyle forall a b. (a -> b) -> a -> b
$ \PprStyle
sty ->
    (Bool -> SDoc) -> SDoc
getPprDebug forall a b. (a -> b) -> a -> b
$ \Bool
debug ->
      if Bool
debug Bool -> Bool -> Bool
|| PprStyle -> Bool
dumpStyle PprStyle
sty
         then SDoc
pp_when_debug
         else SDoc
pp_no_debug

{-
************************************************************************
*                                                                      *
                Implicit parameter bindings
*                                                                      *
************************************************************************
-}

type instance XIPBinds       GhcPs = NoExtField
type instance XIPBinds       GhcRn = NoExtField
type instance XIPBinds       GhcTc = TcEvBinds -- binds uses of the
                                               -- implicit parameters


type instance XXHsIPBinds    (GhcPass p) = NoExtCon

isEmptyIPBindsPR :: HsIPBinds (GhcPass p) -> Bool
isEmptyIPBindsPR :: forall (p :: Pass). HsIPBinds (GhcPass p) -> Bool
isEmptyIPBindsPR (IPBinds XIPBinds (GhcPass p)
_ [LIPBind (GhcPass p)]
is) = forall (t :: * -> *) a. Foldable t => t a -> Bool
null [LIPBind (GhcPass p)]
is

isEmptyIPBindsTc :: HsIPBinds GhcTc -> Bool
isEmptyIPBindsTc :: HsIPBinds (GhcPass 'Typechecked) -> Bool
isEmptyIPBindsTc (IPBinds XIPBinds (GhcPass 'Typechecked)
ds [LIPBind (GhcPass 'Typechecked)]
is) = forall (t :: * -> *) a. Foldable t => t a -> Bool
null [LIPBind (GhcPass 'Typechecked)]
is Bool -> Bool -> Bool
&& TcEvBinds -> Bool
isEmptyTcEvBinds XIPBinds (GhcPass 'Typechecked)
ds

type instance XCIPBind    (GhcPass p) = EpAnn [AddEpAnn]
type instance XXIPBind    (GhcPass p) = NoExtCon

instance OutputableBndrId p
       => Outputable (HsIPBinds (GhcPass p)) where
  ppr :: HsIPBinds (GhcPass p) -> SDoc
ppr (IPBinds XIPBinds (GhcPass p)
ds [LIPBind (GhcPass p)]
bs) = ([SDoc] -> SDoc) -> [SDoc] -> SDoc
pprDeeperList [SDoc] -> SDoc
vcat (forall a b. (a -> b) -> [a] -> [b]
map forall a. Outputable a => a -> SDoc
ppr [LIPBind (GhcPass p)]
bs)
                        SDoc -> SDoc -> SDoc
$$ SDoc -> SDoc
whenPprDebug (forall (p :: Pass).
IsPass p =>
((p ~ 'Typechecked) => SDoc) -> SDoc
pprIfTc @p forall a b. (a -> b) -> a -> b
$ forall a. Outputable a => a -> SDoc
ppr XIPBinds (GhcPass p)
ds)

instance OutputableBndrId p => Outputable (IPBind (GhcPass p)) where
  ppr :: IPBind (GhcPass p) -> SDoc
ppr (IPBind XCIPBind (GhcPass p)
_ Either (XRec (GhcPass p) HsIPName) (IdP (GhcPass p))
lr LHsExpr (GhcPass p)
rhs) = SDoc
name SDoc -> SDoc -> SDoc
<+> SDoc
equals SDoc -> SDoc -> SDoc
<+> forall (p :: Pass).
OutputableBndrId p =>
HsExpr (GhcPass p) -> SDoc
pprExpr (forall l e. GenLocated l e -> e
unLoc LHsExpr (GhcPass p)
rhs)
    where name :: SDoc
name = case Either (XRec (GhcPass p) HsIPName) (IdP (GhcPass p))
lr of
                   Left (L SrcSpan
_ HsIPName
ip) -> forall a. OutputableBndr a => BindingSite -> a -> SDoc
pprBndr BindingSite
LetBind HsIPName
ip
                   Right     IdP (GhcPass p)
id  -> forall a. OutputableBndr a => BindingSite -> a -> SDoc
pprBndr BindingSite
LetBind IdP (GhcPass p)
id

{-
************************************************************************
*                                                                      *
\subsection{@Sig@: type signatures and value-modifying user pragmas}
*                                                                      *
************************************************************************
-}

type instance XTypeSig          (GhcPass p) = EpAnn AnnSig
type instance XPatSynSig        (GhcPass p) = EpAnn AnnSig
type instance XClassOpSig       (GhcPass p) = EpAnn AnnSig
type instance XIdSig            (GhcPass p) = NoExtField -- No anns, generated
type instance XFixSig           (GhcPass p) = EpAnn [AddEpAnn]
type instance XInlineSig        (GhcPass p) = EpAnn [AddEpAnn]
type instance XSpecSig          (GhcPass p) = EpAnn [AddEpAnn]
type instance XSpecInstSig      (GhcPass p) = EpAnn [AddEpAnn]
type instance XMinimalSig       (GhcPass p) = EpAnn [AddEpAnn]
type instance XSCCFunSig        (GhcPass p) = EpAnn [AddEpAnn]
type instance XCompleteMatchSig (GhcPass p) = EpAnn [AddEpAnn]

type instance XXSig             (GhcPass p) = NoExtCon

type instance XFixitySig  (GhcPass p) = NoExtField
type instance XXFixitySig (GhcPass p) = NoExtCon

data AnnSig
  = AnnSig {
      AnnSig -> AddEpAnn
asDcolon :: AddEpAnn, -- Not an EpaAnchor to capture unicode option
      AnnSig -> [AddEpAnn]
asRest   :: [AddEpAnn]
      } deriving Typeable AnnSig
AnnSig -> DataType
AnnSig -> Constr
(forall b. Data b => b -> b) -> AnnSig -> AnnSig
forall a.
Typeable a
-> (forall (c :: * -> *).
    (forall d b. Data d => c (d -> b) -> d -> c b)
    -> (forall g. g -> c g) -> a -> c a)
-> (forall (c :: * -> *).
    (forall b r. Data b => c (b -> r) -> c r)
    -> (forall r. r -> c r) -> Constr -> c a)
-> (a -> Constr)
-> (a -> DataType)
-> (forall (t :: * -> *) (c :: * -> *).
    Typeable t =>
    (forall d. Data d => c (t d)) -> Maybe (c a))
-> (forall (t :: * -> * -> *) (c :: * -> *).
    Typeable t =>
    (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c a))
-> ((forall b. Data b => b -> b) -> a -> a)
-> (forall r r'.
    (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> a -> r)
-> (forall r r'.
    (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> a -> r)
-> (forall u. (forall d. Data d => d -> u) -> a -> [u])
-> (forall u. Int -> (forall d. Data d => d -> u) -> a -> u)
-> (forall (m :: * -> *).
    Monad m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> Data a
forall u. Int -> (forall d. Data d => d -> u) -> AnnSig -> u
forall u. (forall d. Data d => d -> u) -> AnnSig -> [u]
forall r r'.
(r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AnnSig -> r
forall r r'.
(r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AnnSig -> r
forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d) -> AnnSig -> m AnnSig
forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> AnnSig -> m AnnSig
forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c AnnSig
forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> AnnSig -> c AnnSig
forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c AnnSig)
forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AnnSig)
gmapMo :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> AnnSig -> m AnnSig
$cgmapMo :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> AnnSig -> m AnnSig
gmapMp :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> AnnSig -> m AnnSig
$cgmapMp :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> AnnSig -> m AnnSig
gmapM :: forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d) -> AnnSig -> m AnnSig
$cgmapM :: forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d) -> AnnSig -> m AnnSig
gmapQi :: forall u. Int -> (forall d. Data d => d -> u) -> AnnSig -> u
$cgmapQi :: forall u. Int -> (forall d. Data d => d -> u) -> AnnSig -> u
gmapQ :: forall u. (forall d. Data d => d -> u) -> AnnSig -> [u]
$cgmapQ :: forall u. (forall d. Data d => d -> u) -> AnnSig -> [u]
gmapQr :: forall r r'.
(r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AnnSig -> r
$cgmapQr :: forall r r'.
(r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AnnSig -> r
gmapQl :: forall r r'.
(r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AnnSig -> r
$cgmapQl :: forall r r'.
(r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AnnSig -> r
gmapT :: (forall b. Data b => b -> b) -> AnnSig -> AnnSig
$cgmapT :: (forall b. Data b => b -> b) -> AnnSig -> AnnSig
dataCast2 :: forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AnnSig)
$cdataCast2 :: forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AnnSig)
dataCast1 :: forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c AnnSig)
$cdataCast1 :: forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c AnnSig)
dataTypeOf :: AnnSig -> DataType
$cdataTypeOf :: AnnSig -> DataType
toConstr :: AnnSig -> Constr
$ctoConstr :: AnnSig -> Constr
gunfold :: forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c AnnSig
$cgunfold :: forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c AnnSig
gfoldl :: forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> AnnSig -> c AnnSig
$cgfoldl :: forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> AnnSig -> c AnnSig
Data


instance OutputableBndrId p => Outputable (Sig (GhcPass p)) where
    ppr :: Sig (GhcPass p) -> SDoc
ppr Sig (GhcPass p)
sig = forall (p :: Pass). OutputableBndrId p => Sig (GhcPass p) -> SDoc
ppr_sig Sig (GhcPass p)
sig

ppr_sig :: forall p. OutputableBndrId p
        => Sig (GhcPass p) -> SDoc
ppr_sig :: forall (p :: Pass). OutputableBndrId p => Sig (GhcPass p) -> SDoc
ppr_sig (TypeSig XTypeSig (GhcPass p)
_ [LIdP (GhcPass p)]
vars LHsSigWcType (GhcPass p)
ty)  = forall id. OutputableBndr id => [id] -> SDoc -> SDoc
pprVarSig (forall a b. (a -> b) -> [a] -> [b]
map forall l e. GenLocated l e -> e
unLoc [LIdP (GhcPass p)]
vars) (forall a. Outputable a => a -> SDoc
ppr LHsSigWcType (GhcPass p)
ty)
ppr_sig (ClassOpSig XClassOpSig (GhcPass p)
_ Bool
is_deflt [LIdP (GhcPass p)]
vars LHsSigType (GhcPass p)
ty)
  | Bool
is_deflt                 = String -> SDoc
text String
"default" SDoc -> SDoc -> SDoc
<+> forall id. OutputableBndr id => [id] -> SDoc -> SDoc
pprVarSig (forall a b. (a -> b) -> [a] -> [b]
map forall l e. GenLocated l e -> e
unLoc [LIdP (GhcPass p)]
vars) (forall a. Outputable a => a -> SDoc
ppr LHsSigType (GhcPass p)
ty)
  | Bool
otherwise                = forall id. OutputableBndr id => [id] -> SDoc -> SDoc
pprVarSig (forall a b. (a -> b) -> [a] -> [b]
map forall l e. GenLocated l e -> e
unLoc [LIdP (GhcPass p)]
vars) (forall a. Outputable a => a -> SDoc
ppr LHsSigType (GhcPass p)
ty)
ppr_sig (IdSig XIdSig (GhcPass p)
_ TyVar
id)         = forall id. OutputableBndr id => [id] -> SDoc -> SDoc
pprVarSig [TyVar
id] (forall a. Outputable a => a -> SDoc
ppr (TyVar -> Kind
varType TyVar
id))
ppr_sig (FixSig XFixSig (GhcPass p)
_ FixitySig (GhcPass p)
fix_sig)   = forall a. Outputable a => a -> SDoc
ppr FixitySig (GhcPass p)
fix_sig
ppr_sig (SpecSig XSpecSig (GhcPass p)
_ LIdP (GhcPass p)
var [LHsSigType (GhcPass p)]
ty inl :: InlinePragma
inl@(InlinePragma { inl_inline :: InlinePragma -> InlineSpec
inl_inline = InlineSpec
spec }))
  = SourceText -> String -> SDoc -> SDoc
pragSrcBrackets (InlinePragma -> SourceText
inl_src InlinePragma
inl) String
pragmaSrc (forall id. OutputableBndr id => id -> SDoc -> InlinePragma -> SDoc
pprSpec (forall l e. GenLocated l e -> e
unLoc LIdP (GhcPass p)
var)
                                             (forall a. Outputable a => [a] -> SDoc
interpp'SP [LHsSigType (GhcPass p)]
ty) InlinePragma
inl)
    where
      pragmaSrc :: String
pragmaSrc = case InlineSpec
spec of
        InlineSpec
NoUserInlinePrag -> String
"{-# SPECIALISE"
        InlineSpec
_                -> String
"{-# SPECIALISE_INLINE"
ppr_sig (InlineSig XInlineSig (GhcPass p)
_ LIdP (GhcPass p)
var InlinePragma
inl)
  = SourceText -> String -> SDoc -> SDoc
pragSrcBrackets (InlinePragma -> SourceText
inl_src InlinePragma
inl) String
"{-# INLINE"  (InlinePragma -> SDoc
pprInline InlinePragma
inl
                                   SDoc -> SDoc -> SDoc
<+> forall a. OutputableBndr a => a -> SDoc
pprPrefixOcc (forall l e. GenLocated l e -> e
unLoc LIdP (GhcPass p)
var))
ppr_sig (SpecInstSig XSpecInstSig (GhcPass p)
_ SourceText
src LHsSigType (GhcPass p)
ty)
  = SourceText -> String -> SDoc -> SDoc
pragSrcBrackets SourceText
src String
"{-# pragma" (String -> SDoc
text String
"instance" SDoc -> SDoc -> SDoc
<+> forall a. Outputable a => a -> SDoc
ppr LHsSigType (GhcPass p)
ty)
ppr_sig (MinimalSig XMinimalSig (GhcPass p)
_ SourceText
src LBooleanFormula (LIdP (GhcPass p))
bf)
  = SourceText -> String -> SDoc -> SDoc
pragSrcBrackets SourceText
src String
"{-# MINIMAL" (forall name l.
OutputableBndr name =>
LBooleanFormula (GenLocated l name) -> SDoc
pprMinimalSig LBooleanFormula (LIdP (GhcPass p))
bf)
ppr_sig (PatSynSig XPatSynSig (GhcPass p)
_ [LIdP (GhcPass p)]
names LHsSigType (GhcPass p)
sig_ty)
  = String -> SDoc
text String
"pattern" SDoc -> SDoc -> SDoc
<+> forall id. OutputableBndr id => [id] -> SDoc -> SDoc
pprVarSig (forall a b. (a -> b) -> [a] -> [b]
map forall l e. GenLocated l e -> e
unLoc [LIdP (GhcPass p)]
names) (forall a. Outputable a => a -> SDoc
ppr LHsSigType (GhcPass p)
sig_ty)
ppr_sig (SCCFunSig XSCCFunSig (GhcPass p)
_ SourceText
src LIdP (GhcPass p)
fn Maybe (XRec (GhcPass p) StringLiteral)
mlabel)
  = SourceText -> String -> SDoc -> SDoc
pragSrcBrackets SourceText
src String
"{-# SCC" (SDoc
ppr_fn SDoc -> SDoc -> SDoc
<+> forall b a. b -> (a -> b) -> Maybe a -> b
maybe SDoc
empty forall a. Outputable a => a -> SDoc
ppr Maybe (XRec (GhcPass p) StringLiteral)
mlabel )
      where
        ppr_fn :: SDoc
ppr_fn = case forall (p :: Pass). IsPass p => GhcPass p
ghcPass @p of
          GhcPass p
GhcPs -> forall a. Outputable a => a -> SDoc
ppr LIdP (GhcPass p)
fn
          GhcPass p
GhcRn -> forall a. Outputable a => a -> SDoc
ppr LIdP (GhcPass p)
fn
          GhcPass p
GhcTc -> forall a. Outputable a => a -> SDoc
ppr LIdP (GhcPass p)
fn
ppr_sig (CompleteMatchSig XCompleteMatchSig (GhcPass p)
_ SourceText
src XRec (GhcPass p) [LIdP (GhcPass p)]
cs Maybe (LIdP (GhcPass p))
mty)
  = SourceText -> String -> SDoc -> SDoc
pragSrcBrackets SourceText
src String
"{-# COMPLETE"
      (([SDoc] -> SDoc
hsep (SDoc -> [SDoc] -> [SDoc]
punctuate SDoc
comma (forall a b. (a -> b) -> [a] -> [b]
map GenLocated (Anno (IdGhcP p)) (IdGhcP p) -> SDoc
ppr_n (forall l e. GenLocated l e -> e
unLoc XRec (GhcPass p) [LIdP (GhcPass p)]
cs))))
        SDoc -> SDoc -> SDoc
<+> SDoc
opt_sig)
  where
    opt_sig :: SDoc
opt_sig = forall b a. b -> (a -> b) -> Maybe a -> b
maybe SDoc
empty ((\IdGhcP p
t -> SDoc
dcolon SDoc -> SDoc -> SDoc
<+> forall a. Outputable a => a -> SDoc
ppr IdGhcP p
t) forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall l e. GenLocated l e -> e
unLoc) Maybe (LIdP (GhcPass p))
mty
    ppr_n :: GenLocated (Anno (IdGhcP p)) (IdGhcP p) -> SDoc
ppr_n GenLocated (Anno (IdGhcP p)) (IdGhcP p)
n = case forall (p :: Pass). IsPass p => GhcPass p
ghcPass @p of
        GhcPass p
GhcPs -> forall a. Outputable a => a -> SDoc
ppr GenLocated (Anno (IdGhcP p)) (IdGhcP p)
n
        GhcPass p
GhcRn -> forall a. Outputable a => a -> SDoc
ppr GenLocated (Anno (IdGhcP p)) (IdGhcP p)
n
        GhcPass p
GhcTc -> forall a. Outputable a => a -> SDoc
ppr GenLocated (Anno (IdGhcP p)) (IdGhcP p)
n

instance OutputableBndrId p
       => Outputable (FixitySig (GhcPass p)) where
  ppr :: FixitySig (GhcPass p) -> SDoc
ppr (FixitySig XFixitySig (GhcPass p)
_ [LIdP (GhcPass p)]
names Fixity
fixity) = [SDoc] -> SDoc
sep [forall a. Outputable a => a -> SDoc
ppr Fixity
fixity, SDoc
pprops]
    where
      pprops :: SDoc
pprops = [SDoc] -> SDoc
hsep forall a b. (a -> b) -> a -> b
$ SDoc -> [SDoc] -> [SDoc]
punctuate SDoc
comma (forall a b. (a -> b) -> [a] -> [b]
map (forall a. OutputableBndr a => a -> SDoc
pprInfixOcc forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall l e. GenLocated l e -> e
unLoc) [LIdP (GhcPass p)]
names)

pragBrackets :: SDoc -> SDoc
pragBrackets :: SDoc -> SDoc
pragBrackets SDoc
doc = String -> SDoc
text String
"{-#" SDoc -> SDoc -> SDoc
<+> SDoc
doc SDoc -> SDoc -> SDoc
<+> String -> SDoc
text String
"#-}"

-- | Using SourceText in case the pragma was spelled differently or used mixed
-- case
pragSrcBrackets :: SourceText -> String -> SDoc -> SDoc
pragSrcBrackets :: SourceText -> String -> SDoc -> SDoc
pragSrcBrackets (SourceText String
src) String
_   SDoc
doc = String -> SDoc
text String
src SDoc -> SDoc -> SDoc
<+> SDoc
doc SDoc -> SDoc -> SDoc
<+> String -> SDoc
text String
"#-}"
pragSrcBrackets SourceText
NoSourceText     String
alt SDoc
doc = String -> SDoc
text String
alt SDoc -> SDoc -> SDoc
<+> SDoc
doc SDoc -> SDoc -> SDoc
<+> String -> SDoc
text String
"#-}"

pprVarSig :: (OutputableBndr id) => [id] -> SDoc -> SDoc
pprVarSig :: forall id. OutputableBndr id => [id] -> SDoc -> SDoc
pprVarSig [id]
vars SDoc
pp_ty = [SDoc] -> SDoc
sep [SDoc
pprvars SDoc -> SDoc -> SDoc
<+> SDoc
dcolon, Int -> SDoc -> SDoc
nest Int
2 SDoc
pp_ty]
  where
    pprvars :: SDoc
pprvars = [SDoc] -> SDoc
hsep forall a b. (a -> b) -> a -> b
$ SDoc -> [SDoc] -> [SDoc]
punctuate SDoc
comma (forall a b. (a -> b) -> [a] -> [b]
map forall a. OutputableBndr a => a -> SDoc
pprPrefixOcc [id]
vars)

pprSpec :: (OutputableBndr id) => id -> SDoc -> InlinePragma -> SDoc
pprSpec :: forall id. OutputableBndr id => id -> SDoc -> InlinePragma -> SDoc
pprSpec id
var SDoc
pp_ty InlinePragma
inl = SDoc
pp_inl SDoc -> SDoc -> SDoc
<+> forall id. OutputableBndr id => [id] -> SDoc -> SDoc
pprVarSig [id
var] SDoc
pp_ty
  where
    pp_inl :: SDoc
pp_inl | InlinePragma -> Bool
isDefaultInlinePragma InlinePragma
inl = SDoc
empty
           | Bool
otherwise = InlinePragma -> SDoc
pprInline InlinePragma
inl

pprTcSpecPrags :: TcSpecPrags -> SDoc
pprTcSpecPrags :: TcSpecPrags -> SDoc
pprTcSpecPrags TcSpecPrags
IsDefaultMethod = String -> SDoc
text String
"<default method>"
pprTcSpecPrags (SpecPrags [LTcSpecPrag]
ps)  = [SDoc] -> SDoc
vcat (forall a b. (a -> b) -> [a] -> [b]
map (forall a. Outputable a => a -> SDoc
ppr forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall l e. GenLocated l e -> e
unLoc) [LTcSpecPrag]
ps)

instance Outputable TcSpecPrag where
  ppr :: TcSpecPrag -> SDoc
ppr (SpecPrag TyVar
var HsWrapper
_ InlinePragma
inl)
    = String -> SDoc
text String
"SPECIALIZE" SDoc -> SDoc -> SDoc
<+> forall id. OutputableBndr id => id -> SDoc -> InlinePragma -> SDoc
pprSpec TyVar
var (String -> SDoc
text String
"<type>") InlinePragma
inl

pprMinimalSig :: (OutputableBndr name)
              => LBooleanFormula (GenLocated l name) -> SDoc
pprMinimalSig :: forall name l.
OutputableBndr name =>
LBooleanFormula (GenLocated l name) -> SDoc
pprMinimalSig (L SrcSpanAnnL
_ BooleanFormula (GenLocated l name)
bf) = forall a. Outputable a => a -> SDoc
ppr (forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap forall l e. GenLocated l e -> e
unLoc BooleanFormula (GenLocated l name)
bf)

{-
************************************************************************
*                                                                      *
\subsection{Anno instances}
*                                                                      *
************************************************************************
-}

type instance Anno (HsBindLR (GhcPass idL) (GhcPass idR)) = SrcSpanAnnA
type instance Anno (IPBind (GhcPass p)) = SrcSpanAnnA
type instance Anno (Sig (GhcPass p)) = SrcSpanAnnA

-- For CompleteMatchSig
type instance Anno [LocatedN RdrName] = SrcSpan
type instance Anno [LocatedN Name]    = SrcSpan
type instance Anno [LocatedN Id]      = SrcSpan

type instance Anno (FixitySig (GhcPass p)) = SrcSpanAnnA

type instance Anno StringLiteral = SrcSpan
type instance Anno (LocatedN RdrName) = SrcSpan
type instance Anno (LocatedN Name) = SrcSpan
type instance Anno (LocatedN Id) = SrcSpan