{-# LANGUAGE ScopedTypeVariables, BangPatterns #-}
{-# LANGUAGE TypeFamilies #-}

{-# OPTIONS_GHC -Wno-incomplete-uni-patterns   #-}
{-# OPTIONS_GHC -Wno-incomplete-record-updates #-}

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

Renaming and dependency analysis of bindings

This module does renaming and dependency analysis on value bindings in
the abstract syntax.  It does {\em not} do cycle-checks on class or
type-synonym declarations; those cannot be done at this stage because
they may be affected by renaming (which isn't fully worked out yet).
-}

module GHC.Rename.Bind (
   -- Renaming top-level bindings
   rnTopBindsLHS, rnTopBindsBoot, rnValBindsRHS,

   -- Renaming local bindings
   rnLocalBindsAndThen, rnLocalValBindsLHS, rnLocalValBindsRHS,

   -- Other bindings
   rnMethodBinds, renameSigs,
   rnMatchGroup, rnGRHSs, rnGRHS, rnSrcFixityDecl,
   makeMiniFixityEnv, MiniFixityEnv,
   HsSigCtxt(..)
   ) where

import GHC.Prelude

import {-# SOURCE #-} GHC.Rename.Expr( rnLExpr, rnStmts )

import GHC.Hs
import GHC.Tc.Utils.Monad
import GHC.Rename.HsType
import GHC.Rename.Pat
import GHC.Rename.Names
import GHC.Rename.Env
import GHC.Rename.Fixity
import GHC.Rename.Utils ( HsDocContext(..), mapFvRn, extendTyVarEnvFVRn
                        , checkDupRdrNames, warnUnusedLocalBinds
                        , checkUnusedRecordWildcard
                        , checkDupAndShadowedNames, bindLocalNamesFV
                        , addNoNestedForallsContextsErr, checkInferredVars )
import GHC.Driver.Session
import GHC.Unit.Module
import GHC.Types.Name
import GHC.Types.Name.Env
import GHC.Types.Name.Set
import GHC.Types.Name.Reader ( RdrName, rdrNameOcc )
import GHC.Types.SrcLoc as SrcLoc
import GHC.Data.List.SetOps    ( findDupsEq )
import GHC.Types.Basic         ( RecFlag(..), TypeOrKind(..) )
import GHC.Data.Graph.Directed ( SCC(..) )
import GHC.Data.Bag
import GHC.Utils.Misc
import GHC.Utils.Outputable
import GHC.Types.Unique.Set
import GHC.Data.Maybe          ( orElse )
import GHC.Data.OrdList
import qualified GHC.LanguageExtensions as LangExt

import Control.Monad
import Data.Foldable      ( toList )
import Data.List          ( partition, sortBy )
import Data.List.NonEmpty ( NonEmpty(..) )

{-
-- ToDo: Put the annotations into the monad, so that they arrive in the proper
-- place and can be used when complaining.

The code tree received by the function @rnBinds@ contains definitions
in where-clauses which are all apparently mutually recursive, but which may
not really depend upon each other. For example, in the top level program
\begin{verbatim}
f x = y where a = x
              y = x
\end{verbatim}
the definitions of @a@ and @y@ do not depend on each other at all.
Unfortunately, the typechecker cannot always check such definitions.
\footnote{Mycroft, A. 1984. Polymorphic type schemes and recursive
definitions. In Proceedings of the International Symposium on Programming,
Toulouse, pp. 217-39. LNCS 167. Springer Verlag.}
However, the typechecker usually can check definitions in which only the
strongly connected components have been collected into recursive bindings.
This is precisely what the function @rnBinds@ does.

ToDo: deal with case where a single monobinds binds the same variable
twice.

The vertag tag is a unique @Int@; the tags only need to be unique
within one @MonoBinds@, so that unique-Int plumbing is done explicitly
(heavy monad machinery not needed).


************************************************************************
*                                                                      *
* naming conventions                                                   *
*                                                                      *
************************************************************************

\subsection[name-conventions]{Name conventions}

The basic algorithm involves walking over the tree and returning a tuple
containing the new tree plus its free variables. Some functions, such
as those walking polymorphic bindings (HsBinds) and qualifier lists in
list comprehensions (@Quals@), return the variables bound in local
environments. These are then used to calculate the free variables of the
expression evaluated in these environments.

Conventions for variable names are as follows:
\begin{itemize}
\item
new code is given a prime to distinguish it from the old.

\item
a set of variables defined in @Exp@ is written @dvExp@

\item
a set of variables free in @Exp@ is written @fvExp@
\end{itemize}

************************************************************************
*                                                                      *
* analysing polymorphic bindings (HsBindGroup, HsBind)
*                                                                      *
************************************************************************

\subsubsection[dep-HsBinds]{Polymorphic bindings}

Non-recursive expressions are reconstructed without any changes at top
level, although their component expressions may have to be altered.
However, non-recursive expressions are currently not expected as
\Haskell{} programs, and this code should not be executed.

Monomorphic bindings contain information that is returned in a tuple
(a @FlatMonoBinds@) containing:

\begin{enumerate}
\item
a unique @Int@ that serves as the ``vertex tag'' for this binding.

\item
the name of a function or the names in a pattern. These are a set
referred to as @dvLhs@, the defined variables of the left hand side.

\item
the free variables of the body. These are referred to as @fvBody@.

\item
the definition's actual code. This is referred to as just @code@.
\end{enumerate}

The function @nonRecDvFv@ returns two sets of variables. The first is
the set of variables defined in the set of monomorphic bindings, while the
second is the set of free variables in those bindings.

The set of variables defined in a non-recursive binding is just the
union of all of them, as @union@ removes duplicates. However, the
free variables in each successive set of cumulative bindings is the
union of those in the previous set plus those of the newest binding after
the defined variables of the previous set have been removed.

@rnMethodBinds@ deals only with the declarations in class and
instance declarations.  It expects only to see @FunMonoBind@s, and
it expects the global environment to contain bindings for the binders
(which are all class operations).

************************************************************************
*                                                                      *
\subsubsection{ Top-level bindings}
*                                                                      *
************************************************************************
-}

-- for top-level bindings, we need to make top-level names,
-- so we have a different entry point than for local bindings
rnTopBindsLHS :: MiniFixityEnv
              -> HsValBinds GhcPs
              -> RnM (HsValBindsLR GhcRn GhcPs)
rnTopBindsLHS :: MiniFixityEnv -> HsValBinds GhcPs -> RnM (HsValBindsLR GhcRn GhcPs)
rnTopBindsLHS MiniFixityEnv
fix_env HsValBinds GhcPs
binds
  = NameMaker -> HsValBinds GhcPs -> RnM (HsValBindsLR GhcRn GhcPs)
rnValBindsLHS (MiniFixityEnv -> NameMaker
topRecNameMaker MiniFixityEnv
fix_env) HsValBinds GhcPs
binds

rnTopBindsBoot :: NameSet -> HsValBindsLR GhcRn GhcPs
               -> RnM (HsValBinds GhcRn, DefUses)
-- A hs-boot file has no bindings.
-- Return a single HsBindGroup with empty binds and renamed signatures
rnTopBindsBoot :: NameSet
-> HsValBindsLR GhcRn GhcPs -> RnM (HsValBinds GhcRn, DefUses)
rnTopBindsBoot NameSet
bound_names (ValBinds XValBinds GhcRn GhcPs
_ LHsBindsLR GhcRn GhcPs
mbinds [LSig GhcPs]
sigs)
  = do  { Bool -> MsgDoc -> TcRn ()
checkErr (LHsBindsLR GhcRn GhcPs -> Bool
forall idL idR. LHsBindsLR idL idR -> Bool
isEmptyLHsBinds LHsBindsLR GhcRn GhcPs
mbinds) (LHsBindsLR GhcRn GhcPs -> MsgDoc
bindsInHsBootFile LHsBindsLR GhcRn GhcPs
mbinds)
        ; ([LSig GhcRn]
sigs', NameSet
fvs) <- HsSigCtxt -> [LSig GhcPs] -> RnM ([LSig GhcRn], NameSet)
renameSigs (NameSet -> HsSigCtxt
HsBootCtxt NameSet
bound_names) [LSig GhcPs]
sigs
        ; (HsValBinds GhcRn, DefUses) -> RnM (HsValBinds GhcRn, DefUses)
forall (m :: * -> *) a. Monad m => a -> m a
return (XXValBindsLR GhcRn GhcRn -> HsValBinds GhcRn
forall idL idR. XXValBindsLR idL idR -> HsValBindsLR idL idR
XValBindsLR ([(RecFlag, LHsBinds GhcRn)] -> [LSig GhcRn] -> NHsValBindsLR GhcRn
forall idL.
[(RecFlag, LHsBinds idL)] -> [LSig GhcRn] -> NHsValBindsLR idL
NValBinds [] [LSig GhcRn]
sigs'), NameSet -> DefUses
usesOnly NameSet
fvs) }
rnTopBindsBoot NameSet
_ HsValBindsLR GhcRn GhcPs
b = String -> MsgDoc -> RnM (HsValBinds GhcRn, DefUses)
forall a. HasCallStack => String -> MsgDoc -> a
pprPanic String
"rnTopBindsBoot" (HsValBindsLR GhcRn GhcPs -> MsgDoc
forall a. Outputable a => a -> MsgDoc
ppr HsValBindsLR GhcRn GhcPs
b)

{-
*********************************************************
*                                                      *
                HsLocalBinds
*                                                      *
*********************************************************
-}

rnLocalBindsAndThen :: HsLocalBinds GhcPs
                   -> (HsLocalBinds GhcRn -> FreeVars -> RnM (result, FreeVars))
                   -> RnM (result, FreeVars)
-- This version (a) assumes that the binding vars are *not* already in scope
--               (b) removes the binders from the free vars of the thing inside
-- The parser doesn't produce ThenBinds
rnLocalBindsAndThen :: forall result.
HsLocalBinds GhcPs
-> (HsLocalBinds GhcRn -> NameSet -> RnM (result, NameSet))
-> RnM (result, NameSet)
rnLocalBindsAndThen (EmptyLocalBinds XEmptyLocalBinds GhcPs GhcPs
x) HsLocalBinds GhcRn -> NameSet -> RnM (result, NameSet)
thing_inside =
  HsLocalBinds GhcRn -> NameSet -> RnM (result, NameSet)
thing_inside (XEmptyLocalBinds GhcRn GhcRn -> HsLocalBinds GhcRn
forall idL idR. XEmptyLocalBinds idL idR -> HsLocalBindsLR idL idR
EmptyLocalBinds XEmptyLocalBinds GhcPs GhcPs
XEmptyLocalBinds GhcRn GhcRn
x) NameSet
emptyNameSet

rnLocalBindsAndThen (HsValBinds XHsValBinds GhcPs GhcPs
x HsValBinds GhcPs
val_binds) HsLocalBinds GhcRn -> NameSet -> RnM (result, NameSet)
thing_inside
  = HsValBinds GhcPs
-> (HsValBinds GhcRn -> NameSet -> RnM (result, NameSet))
-> RnM (result, NameSet)
forall result.
HsValBinds GhcPs
-> (HsValBinds GhcRn -> NameSet -> RnM (result, NameSet))
-> RnM (result, NameSet)
rnLocalValBindsAndThen HsValBinds GhcPs
val_binds ((HsValBinds GhcRn -> NameSet -> RnM (result, NameSet))
 -> RnM (result, NameSet))
-> (HsValBinds GhcRn -> NameSet -> RnM (result, NameSet))
-> RnM (result, NameSet)
forall a b. (a -> b) -> a -> b
$ \ HsValBinds GhcRn
val_binds' ->
      HsLocalBinds GhcRn -> NameSet -> RnM (result, NameSet)
thing_inside (XHsValBinds GhcRn GhcRn -> HsValBinds GhcRn -> HsLocalBinds GhcRn
forall idL idR.
XHsValBinds idL idR
-> HsValBindsLR idL idR -> HsLocalBindsLR idL idR
HsValBinds XHsValBinds GhcPs GhcPs
XHsValBinds GhcRn GhcRn
x HsValBinds GhcRn
val_binds')

rnLocalBindsAndThen (HsIPBinds XHsIPBinds GhcPs GhcPs
x HsIPBinds GhcPs
binds) HsLocalBinds GhcRn -> NameSet -> RnM (result, NameSet)
thing_inside = do
    (HsIPBinds GhcRn
binds',NameSet
fv_binds) <- HsIPBinds GhcPs -> RnM (HsIPBinds GhcRn, NameSet)
rnIPBinds HsIPBinds GhcPs
binds
    (result
thing, NameSet
fvs_thing) <- HsLocalBinds GhcRn -> NameSet -> RnM (result, NameSet)
thing_inside (XHsIPBinds GhcRn GhcRn -> HsIPBinds GhcRn -> HsLocalBinds GhcRn
forall idL idR.
XHsIPBinds idL idR -> HsIPBinds idR -> HsLocalBindsLR idL idR
HsIPBinds XHsIPBinds GhcPs GhcPs
XHsIPBinds GhcRn GhcRn
x HsIPBinds GhcRn
binds') NameSet
fv_binds
    (result, NameSet) -> RnM (result, NameSet)
forall (m :: * -> *) a. Monad m => a -> m a
return (result
thing, NameSet
fvs_thing NameSet -> NameSet -> NameSet
`plusFV` NameSet
fv_binds)

rnIPBinds :: HsIPBinds GhcPs -> RnM (HsIPBinds GhcRn, FreeVars)
rnIPBinds :: HsIPBinds GhcPs -> RnM (HsIPBinds GhcRn, NameSet)
rnIPBinds (IPBinds XIPBinds GhcPs
_ [LIPBind GhcPs]
ip_binds ) = do
    ([Located (IPBind GhcRn)]
ip_binds', [NameSet]
fvs_s) <- (LIPBind GhcPs
 -> IOEnv (Env TcGblEnv TcLclEnv) (Located (IPBind GhcRn), NameSet))
-> [LIPBind GhcPs]
-> IOEnv
     (Env TcGblEnv TcLclEnv) ([Located (IPBind GhcRn)], [NameSet])
forall (m :: * -> *) a b c.
Applicative m =>
(a -> m (b, c)) -> [a] -> m ([b], [c])
mapAndUnzipM ((IPBind GhcPs -> TcM (IPBind GhcRn, NameSet))
-> LIPBind GhcPs
-> IOEnv (Env TcGblEnv TcLclEnv) (Located (IPBind GhcRn), NameSet)
forall a b c. (a -> TcM (b, c)) -> Located a -> TcM (Located b, c)
wrapLocFstM IPBind GhcPs -> TcM (IPBind GhcRn, NameSet)
rnIPBind) [LIPBind GhcPs]
ip_binds
    (HsIPBinds GhcRn, NameSet) -> RnM (HsIPBinds GhcRn, NameSet)
forall (m :: * -> *) a. Monad m => a -> m a
return (XIPBinds GhcRn -> [Located (IPBind GhcRn)] -> HsIPBinds GhcRn
forall id. XIPBinds id -> [LIPBind id] -> HsIPBinds id
IPBinds NoExtField
XIPBinds GhcRn
noExtField [Located (IPBind GhcRn)]
ip_binds', [NameSet] -> NameSet
plusFVs [NameSet]
fvs_s)

rnIPBind :: IPBind GhcPs -> RnM (IPBind GhcRn, FreeVars)
rnIPBind :: IPBind GhcPs -> TcM (IPBind GhcRn, NameSet)
rnIPBind (IPBind XCIPBind GhcPs
_ ~(Left Located HsIPName
n) LHsExpr GhcPs
expr) = do
    (LHsExpr GhcRn
expr',NameSet
fvExpr) <- LHsExpr GhcPs -> RnM (LHsExpr GhcRn, NameSet)
rnLExpr LHsExpr GhcPs
expr
    (IPBind GhcRn, NameSet) -> TcM (IPBind GhcRn, NameSet)
forall (m :: * -> *) a. Monad m => a -> m a
return (XCIPBind GhcRn
-> Either (Located HsIPName) (IdP GhcRn)
-> LHsExpr GhcRn
-> IPBind GhcRn
forall id.
XCIPBind id
-> Either (Located HsIPName) (IdP id) -> LHsExpr id -> IPBind id
IPBind NoExtField
XCIPBind GhcRn
noExtField (Located HsIPName -> Either (Located HsIPName) Name
forall a b. a -> Either a b
Left Located HsIPName
n) LHsExpr GhcRn
expr', NameSet
fvExpr)

{-
************************************************************************
*                                                                      *
                ValBinds
*                                                                      *
************************************************************************
-}

-- Renaming local binding groups
-- Does duplicate/shadow check
rnLocalValBindsLHS :: MiniFixityEnv
                   -> HsValBinds GhcPs
                   -> RnM ([Name], HsValBindsLR GhcRn GhcPs)
rnLocalValBindsLHS :: MiniFixityEnv
-> HsValBinds GhcPs -> RnM ([Name], HsValBindsLR GhcRn GhcPs)
rnLocalValBindsLHS MiniFixityEnv
fix_env HsValBinds GhcPs
binds
  = do { HsValBindsLR GhcRn GhcPs
binds' <- NameMaker -> HsValBinds GhcPs -> RnM (HsValBindsLR GhcRn GhcPs)
rnValBindsLHS (MiniFixityEnv -> NameMaker
localRecNameMaker MiniFixityEnv
fix_env) HsValBinds GhcPs
binds

         -- Check for duplicates and shadowing
         -- Must do this *after* renaming the patterns
         -- See Note [Collect binders only after renaming] in GHC.Hs.Utils

         -- We need to check for dups here because we
         -- don't don't bind all of the variables from the ValBinds at once
         -- with bindLocatedLocals any more.
         --
         -- Note that we don't want to do this at the top level, since
         -- sorting out duplicates and shadowing there happens elsewhere.
         -- The behavior is even different. For example,
         --   import A(f)
         --   f = ...
         -- should not produce a shadowing warning (but it will produce
         -- an ambiguity warning if you use f), but
         --   import A(f)
         --   g = let f = ... in f
         -- should.
       ; let bound_names :: [IdP GhcRn]
bound_names = HsValBindsLR GhcRn GhcPs -> [IdP GhcRn]
forall (idL :: Pass) (idR :: Pass).
CollectPass (GhcPass idL) =>
HsValBindsLR (GhcPass idL) (GhcPass idR) -> [IdP (GhcPass idL)]
collectHsValBinders HsValBindsLR GhcRn GhcPs
binds'
             -- There should be only Ids, but if there are any bogus
             -- pattern synonyms, we'll collect them anyway, so that
             -- we don't generate subsequent out-of-scope messages
       ; (GlobalRdrEnv, LocalRdrEnv)
envs <- TcRn (GlobalRdrEnv, LocalRdrEnv)
getRdrEnvs
       ; (GlobalRdrEnv, LocalRdrEnv) -> [Name] -> TcRn ()
checkDupAndShadowedNames (GlobalRdrEnv, LocalRdrEnv)
envs [Name]
[IdP GhcRn]
bound_names

       ; ([Name], HsValBindsLR GhcRn GhcPs)
-> RnM ([Name], HsValBindsLR GhcRn GhcPs)
forall (m :: * -> *) a. Monad m => a -> m a
return ([Name]
[IdP GhcRn]
bound_names, HsValBindsLR GhcRn GhcPs
binds') }

-- renames the left-hand sides
-- generic version used both at the top level and for local binds
-- does some error checking, but not what gets done elsewhere at the top level
rnValBindsLHS :: NameMaker
              -> HsValBinds GhcPs
              -> RnM (HsValBindsLR GhcRn GhcPs)
rnValBindsLHS :: NameMaker -> HsValBinds GhcPs -> RnM (HsValBindsLR GhcRn GhcPs)
rnValBindsLHS NameMaker
topP (ValBinds XValBinds GhcPs GhcPs
x LHsBindsLR GhcPs GhcPs
mbinds [LSig GhcPs]
sigs)
  = do { LHsBindsLR GhcRn GhcPs
mbinds' <- (Located (HsBindLR GhcPs GhcPs)
 -> IOEnv
      (Env TcGblEnv TcLclEnv)
      (GenLocated SrcSpan (HsBindLR GhcRn GhcPs)))
-> LHsBindsLR GhcPs GhcPs
-> IOEnv (Env TcGblEnv TcLclEnv) (LHsBindsLR GhcRn GhcPs)
forall (m :: * -> *) a b.
Monad m =>
(a -> m b) -> Bag a -> m (Bag b)
mapBagM ((HsBindLR GhcPs GhcPs -> TcM (HsBindLR GhcRn GhcPs))
-> Located (HsBindLR GhcPs GhcPs)
-> IOEnv
     (Env TcGblEnv TcLclEnv) (GenLocated SrcSpan (HsBindLR GhcRn GhcPs))
forall a b. (a -> TcM b) -> Located a -> TcM (Located b)
wrapLocM (NameMaker
-> MsgDoc -> HsBindLR GhcPs GhcPs -> TcM (HsBindLR GhcRn GhcPs)
rnBindLHS NameMaker
topP MsgDoc
doc)) LHsBindsLR GhcPs GhcPs
mbinds
       ; HsValBindsLR GhcRn GhcPs -> RnM (HsValBindsLR GhcRn GhcPs)
forall (m :: * -> *) a. Monad m => a -> m a
return (HsValBindsLR GhcRn GhcPs -> RnM (HsValBindsLR GhcRn GhcPs))
-> HsValBindsLR GhcRn GhcPs -> RnM (HsValBindsLR GhcRn GhcPs)
forall a b. (a -> b) -> a -> b
$ XValBinds GhcRn GhcPs
-> LHsBindsLR GhcRn GhcPs
-> [LSig GhcPs]
-> HsValBindsLR GhcRn GhcPs
forall idL idR.
XValBinds idL idR
-> LHsBindsLR idL idR -> [LSig idR] -> HsValBindsLR idL idR
ValBinds XValBinds GhcPs GhcPs
XValBinds GhcRn GhcPs
x LHsBindsLR GhcRn GhcPs
mbinds' [LSig GhcPs]
sigs }
  where
    bndrs :: [IdP GhcPs]
bndrs = LHsBindsLR GhcPs GhcPs -> [IdP GhcPs]
forall p idR. CollectPass p => LHsBindsLR p idR -> [IdP p]
collectHsBindsBinders LHsBindsLR GhcPs GhcPs
mbinds
    doc :: MsgDoc
doc   = String -> MsgDoc
text String
"In the binding group for:" MsgDoc -> MsgDoc -> MsgDoc
<+> (RdrName -> MsgDoc) -> [RdrName] -> MsgDoc
forall a. (a -> MsgDoc) -> [a] -> MsgDoc
pprWithCommas RdrName -> MsgDoc
forall a. Outputable a => a -> MsgDoc
ppr [RdrName]
[IdP GhcPs]
bndrs

rnValBindsLHS NameMaker
_ HsValBinds GhcPs
b = String -> MsgDoc -> RnM (HsValBindsLR GhcRn GhcPs)
forall a. HasCallStack => String -> MsgDoc -> a
pprPanic String
"rnValBindsLHSFromDoc" (HsValBinds GhcPs -> MsgDoc
forall a. Outputable a => a -> MsgDoc
ppr HsValBinds GhcPs
b)

-- General version used both from the top-level and for local things
-- Assumes the LHS vars are in scope
--
-- Does not bind the local fixity declarations
rnValBindsRHS :: HsSigCtxt
              -> HsValBindsLR GhcRn GhcPs
              -> RnM (HsValBinds GhcRn, DefUses)

rnValBindsRHS :: HsSigCtxt
-> HsValBindsLR GhcRn GhcPs -> RnM (HsValBinds GhcRn, DefUses)
rnValBindsRHS HsSigCtxt
ctxt (ValBinds XValBinds GhcRn GhcPs
_ LHsBindsLR GhcRn GhcPs
mbinds [LSig GhcPs]
sigs)
  = do { ([LSig GhcRn]
sigs', NameSet
sig_fvs) <- HsSigCtxt -> [LSig GhcPs] -> RnM ([LSig GhcRn], NameSet)
renameSigs HsSigCtxt
ctxt [LSig GhcPs]
sigs
       ; Bag (LHsBind GhcRn, [Name], NameSet)
binds_w_dus <- (GenLocated SrcSpan (HsBindLR GhcRn GhcPs)
 -> IOEnv (Env TcGblEnv TcLclEnv) (LHsBind GhcRn, [Name], NameSet))
-> LHsBindsLR GhcRn GhcPs
-> IOEnv
     (Env TcGblEnv TcLclEnv) (Bag (LHsBind GhcRn, [Name], NameSet))
forall (m :: * -> *) a b.
Monad m =>
(a -> m b) -> Bag a -> m (Bag b)
mapBagM ((Name -> [Name])
-> GenLocated SrcSpan (HsBindLR GhcRn GhcPs)
-> IOEnv (Env TcGblEnv TcLclEnv) (LHsBind GhcRn, [Name], NameSet)
rnLBind ([LSig GhcRn] -> Name -> [Name]
mkScopedTvFn [LSig GhcRn]
sigs')) LHsBindsLR GhcRn GhcPs
mbinds
       ; let !([(RecFlag, LHsBinds GhcRn)]
anal_binds, DefUses
anal_dus) = Bag (LHsBind GhcRn, [Name], NameSet)
-> ([(RecFlag, LHsBinds GhcRn)], DefUses)
depAnalBinds Bag (LHsBind GhcRn, [Name], NameSet)
binds_w_dus

       ; let patsyn_fvs :: NameSet
patsyn_fvs = (PatSynBind GhcRn GhcRn -> NameSet -> NameSet)
-> NameSet -> [PatSynBind GhcRn GhcRn] -> NameSet
forall (t :: * -> *) a b.
Foldable t =>
(a -> b -> b) -> b -> t a -> b
foldr (NameSet -> NameSet -> NameSet
unionNameSet (NameSet -> NameSet -> NameSet)
-> (PatSynBind GhcRn GhcRn -> NameSet)
-> PatSynBind GhcRn GhcRn
-> NameSet
-> NameSet
forall b c a. (b -> c) -> (a -> b) -> a -> c
. PatSynBind GhcRn GhcRn -> NameSet
forall idL idR. PatSynBind idL idR -> XPSB idL idR
psb_ext) NameSet
emptyNameSet ([PatSynBind GhcRn GhcRn] -> NameSet)
-> [PatSynBind GhcRn GhcRn] -> NameSet
forall a b. (a -> b) -> a -> b
$
                          [(RecFlag, LHsBinds GhcRn)] -> [PatSynBind GhcRn GhcRn]
forall id. [(RecFlag, LHsBinds id)] -> [PatSynBind id id]
getPatSynBinds [(RecFlag, LHsBinds GhcRn)]
anal_binds
                -- The uses in binds_w_dus for PatSynBinds do not include
                -- variables used in the patsyn builders; see
                -- Note [Pattern synonym builders don't yield dependencies]
                -- But psb_fvs /does/ include those builder fvs.  So we
                -- add them back in here to avoid bogus warnings about
                -- unused variables (#12548)

             valbind'_dus :: DefUses
valbind'_dus = DefUses
anal_dus DefUses -> DefUses -> DefUses
`plusDU` NameSet -> DefUses
usesOnly NameSet
sig_fvs
                                     DefUses -> DefUses -> DefUses
`plusDU` NameSet -> DefUses
usesOnly NameSet
patsyn_fvs
                            -- Put the sig uses *after* the bindings
                            -- so that the binders are removed from
                            -- the uses in the sigs

        ; (HsValBinds GhcRn, DefUses) -> RnM (HsValBinds GhcRn, DefUses)
forall (m :: * -> *) a. Monad m => a -> m a
return (XXValBindsLR GhcRn GhcRn -> HsValBinds GhcRn
forall idL idR. XXValBindsLR idL idR -> HsValBindsLR idL idR
XValBindsLR ([(RecFlag, LHsBinds GhcRn)] -> [LSig GhcRn] -> NHsValBindsLR GhcRn
forall idL.
[(RecFlag, LHsBinds idL)] -> [LSig GhcRn] -> NHsValBindsLR idL
NValBinds [(RecFlag, LHsBinds GhcRn)]
anal_binds [LSig GhcRn]
sigs'), DefUses
valbind'_dus) }

rnValBindsRHS HsSigCtxt
_ HsValBindsLR GhcRn GhcPs
b = String -> MsgDoc -> RnM (HsValBinds GhcRn, DefUses)
forall a. HasCallStack => String -> MsgDoc -> a
pprPanic String
"rnValBindsRHS" (HsValBindsLR GhcRn GhcPs -> MsgDoc
forall a. Outputable a => a -> MsgDoc
ppr HsValBindsLR GhcRn GhcPs
b)

-- Wrapper for local binds
--
-- The *client* of this function is responsible for checking for unused binders;
-- it doesn't (and can't: we don't have the thing inside the binds) happen here
--
-- The client is also responsible for bringing the fixities into scope
rnLocalValBindsRHS :: NameSet  -- names bound by the LHSes
                   -> HsValBindsLR GhcRn GhcPs
                   -> RnM (HsValBinds GhcRn, DefUses)
rnLocalValBindsRHS :: NameSet
-> HsValBindsLR GhcRn GhcPs -> RnM (HsValBinds GhcRn, DefUses)
rnLocalValBindsRHS NameSet
bound_names HsValBindsLR GhcRn GhcPs
binds
  = HsSigCtxt
-> HsValBindsLR GhcRn GhcPs -> RnM (HsValBinds GhcRn, DefUses)
rnValBindsRHS (NameSet -> HsSigCtxt
LocalBindCtxt NameSet
bound_names) HsValBindsLR GhcRn GhcPs
binds

-- for local binds
-- wrapper that does both the left- and right-hand sides
--
-- here there are no local fixity decls passed in;
-- the local fixity decls come from the ValBinds sigs
rnLocalValBindsAndThen
  :: HsValBinds GhcPs
  -> (HsValBinds GhcRn -> FreeVars -> RnM (result, FreeVars))
  -> RnM (result, FreeVars)
rnLocalValBindsAndThen :: forall result.
HsValBinds GhcPs
-> (HsValBinds GhcRn -> NameSet -> RnM (result, NameSet))
-> RnM (result, NameSet)
rnLocalValBindsAndThen binds :: HsValBinds GhcPs
binds@(ValBinds XValBinds GhcPs GhcPs
_ LHsBindsLR GhcPs GhcPs
_ [LSig GhcPs]
sigs) HsValBinds GhcRn -> NameSet -> RnM (result, NameSet)
thing_inside
 = do   {     -- (A) Create the local fixity environment
          MiniFixityEnv
new_fixities <- [LFixitySig GhcPs] -> RnM MiniFixityEnv
makeMiniFixityEnv [ SrcSpan -> FixitySig GhcPs -> LFixitySig GhcPs
forall l e. l -> e -> GenLocated l e
L SrcSpan
loc FixitySig GhcPs
sig
                                            | L SrcSpan
loc (FixSig XFixSig GhcPs
_ FixitySig GhcPs
sig) <- [LSig GhcPs]
sigs]

              -- (B) Rename the LHSes
        ; ([Name]
bound_names, HsValBindsLR GhcRn GhcPs
new_lhs) <- MiniFixityEnv
-> HsValBinds GhcPs -> RnM ([Name], HsValBindsLR GhcRn GhcPs)
rnLocalValBindsLHS MiniFixityEnv
new_fixities HsValBinds GhcPs
binds

              --     ...and bring them (and their fixities) into scope
        ; [Name] -> RnM (result, NameSet) -> RnM (result, NameSet)
forall a. [Name] -> RnM (a, NameSet) -> RnM (a, NameSet)
bindLocalNamesFV [Name]
bound_names              (RnM (result, NameSet) -> RnM (result, NameSet))
-> RnM (result, NameSet) -> RnM (result, NameSet)
forall a b. (a -> b) -> a -> b
$
          MiniFixityEnv
-> [Name] -> RnM (result, NameSet) -> RnM (result, NameSet)
forall a. MiniFixityEnv -> [Name] -> RnM a -> RnM a
addLocalFixities MiniFixityEnv
new_fixities [Name]
bound_names (RnM (result, NameSet) -> RnM (result, NameSet))
-> RnM (result, NameSet) -> RnM (result, NameSet)
forall a b. (a -> b) -> a -> b
$ do

        {      -- (C) Do the RHS and thing inside
          (HsValBinds GhcRn
binds', DefUses
dus) <- NameSet
-> HsValBindsLR GhcRn GhcPs -> RnM (HsValBinds GhcRn, DefUses)
rnLocalValBindsRHS ([Name] -> NameSet
mkNameSet [Name]
bound_names) HsValBindsLR GhcRn GhcPs
new_lhs
        ; (result
result, NameSet
result_fvs) <- HsValBinds GhcRn -> NameSet -> RnM (result, NameSet)
thing_inside HsValBinds GhcRn
binds' (DefUses -> NameSet
allUses DefUses
dus)

                -- Report unused bindings based on the (accurate)
                -- findUses.  E.g.
                --      let x = x in 3
                -- should report 'x' unused
        ; let real_uses :: NameSet
real_uses = DefUses -> NameSet -> NameSet
findUses DefUses
dus NameSet
result_fvs
              -- Insert fake uses for variables introduced implicitly by
              -- wildcards (#4404)
              rec_uses :: [(SrcSpan, [Name])]
rec_uses = HsValBinds GhcRn -> [(SrcSpan, [Name])]
forall (idR :: Pass).
HsValBindsLR GhcRn (GhcPass idR) -> [(SrcSpan, [Name])]
hsValBindsImplicits HsValBinds GhcRn
binds'
              implicit_uses :: NameSet
implicit_uses = [Name] -> NameSet
mkNameSet ([Name] -> NameSet) -> [Name] -> NameSet
forall a b. (a -> b) -> a -> b
$ ((SrcSpan, [Name]) -> [Name]) -> [(SrcSpan, [Name])] -> [Name]
forall (t :: * -> *) a b. Foldable t => (a -> [b]) -> t a -> [b]
concatMap (SrcSpan, [Name]) -> [Name]
forall a b. (a, b) -> b
snd
                                        ([(SrcSpan, [Name])] -> [Name]) -> [(SrcSpan, [Name])] -> [Name]
forall a b. (a -> b) -> a -> b
$ [(SrcSpan, [Name])]
rec_uses
        ; ((SrcSpan, [Name]) -> TcRn ()) -> [(SrcSpan, [Name])] -> TcRn ()
forall (t :: * -> *) (m :: * -> *) a b.
(Foldable t, Monad m) =>
(a -> m b) -> t a -> m ()
mapM_ (\(SrcSpan
loc, [Name]
ns) ->
                    SrcSpan -> NameSet -> Maybe [Name] -> TcRn ()
checkUnusedRecordWildcard SrcSpan
loc NameSet
real_uses ([Name] -> Maybe [Name]
forall a. a -> Maybe a
Just [Name]
ns))
                [(SrcSpan, [Name])]
rec_uses
        ; [Name] -> NameSet -> TcRn ()
warnUnusedLocalBinds [Name]
bound_names
                                      (NameSet
real_uses NameSet -> NameSet -> NameSet
`unionNameSet` NameSet
implicit_uses)

        ; let
            -- The variables "used" in the val binds are:
            --   (1) the uses of the binds (allUses)
            --   (2) the FVs of the thing-inside
            all_uses :: NameSet
all_uses = DefUses -> NameSet
allUses DefUses
dus NameSet -> NameSet -> NameSet
`plusFV` NameSet
result_fvs
                -- Note [Unused binding hack]
                -- ~~~~~~~~~~~~~~~~~~~~~~~~~~
                -- Note that *in contrast* to the above reporting of
                -- unused bindings, (1) above uses duUses to return *all*
                -- the uses, even if the binding is unused.  Otherwise consider:
                --      x = 3
                --      y = let p = x in 'x'    -- NB: p not used
                -- If we don't "see" the dependency of 'y' on 'x', we may put the
                -- bindings in the wrong order, and the type checker will complain
                -- that x isn't in scope
                --
                -- But note that this means we won't report 'x' as unused,
                -- whereas we would if we had { x = 3; p = x; y = 'x' }

        ; (result, NameSet) -> RnM (result, NameSet)
forall (m :: * -> *) a. Monad m => a -> m a
return (result
result, NameSet
all_uses) }}
                -- The bound names are pruned out of all_uses
                -- by the bindLocalNamesFV call above

rnLocalValBindsAndThen HsValBinds GhcPs
bs HsValBinds GhcRn -> NameSet -> RnM (result, NameSet)
_ = String -> MsgDoc -> RnM (result, NameSet)
forall a. HasCallStack => String -> MsgDoc -> a
pprPanic String
"rnLocalValBindsAndThen" (HsValBinds GhcPs -> MsgDoc
forall a. Outputable a => a -> MsgDoc
ppr HsValBinds GhcPs
bs)


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

-- renaming a single bind

rnBindLHS :: NameMaker
          -> SDoc
          -> HsBind GhcPs
          -- returns the renamed left-hand side,
          -- and the FreeVars *of the LHS*
          -- (i.e., any free variables of the pattern)
          -> RnM (HsBindLR GhcRn GhcPs)

rnBindLHS :: NameMaker
-> MsgDoc -> HsBindLR GhcPs GhcPs -> TcM (HsBindLR GhcRn GhcPs)
rnBindLHS NameMaker
name_maker MsgDoc
_ bind :: HsBindLR GhcPs GhcPs
bind@(PatBind { pat_lhs :: forall idL idR. HsBindLR idL idR -> LPat idL
pat_lhs = LPat GhcPs
pat })
  = do
      -- we don't actually use the FV processing of rnPatsAndThen here
      (Located (Pat GhcRn)
pat',NameSet
pat'_fvs) <- NameMaker -> LPat GhcPs -> RnM (LPat GhcRn, NameSet)
rnBindPat NameMaker
name_maker LPat GhcPs
pat
      HsBindLR GhcRn GhcPs -> TcM (HsBindLR GhcRn GhcPs)
forall (m :: * -> *) a. Monad m => a -> m a
return (HsBindLR GhcPs GhcPs
bind { pat_lhs :: LPat GhcRn
pat_lhs = Located (Pat GhcRn)
LPat GhcRn
pat', pat_ext :: XPatBind GhcRn GhcPs
pat_ext = NameSet
XPatBind GhcRn GhcPs
pat'_fvs })
                -- We temporarily store the pat's FVs in bind_fvs;
                -- gets updated to the FVs of the whole bind
                -- when doing the RHS below

rnBindLHS NameMaker
name_maker MsgDoc
_ bind :: HsBindLR GhcPs GhcPs
bind@(FunBind { fun_id :: forall idL idR. HsBindLR idL idR -> Located (IdP idL)
fun_id = Located (IdP GhcPs)
rdr_name })
  = do { Located Name
name <- NameMaker -> Located RdrName -> RnM (Located Name)
applyNameMaker NameMaker
name_maker Located RdrName
Located (IdP GhcPs)
rdr_name
       ; HsBindLR GhcRn GhcPs -> TcM (HsBindLR GhcRn GhcPs)
forall (m :: * -> *) a. Monad m => a -> m a
return (HsBindLR GhcPs GhcPs
bind { fun_id :: Located (IdP GhcRn)
fun_id = Located Name
Located (IdP GhcRn)
name
                      , fun_ext :: XFunBind GhcRn GhcPs
fun_ext = NoExtField
XFunBind GhcRn GhcPs
noExtField }) }

rnBindLHS NameMaker
name_maker MsgDoc
_ (PatSynBind XPatSynBind GhcPs GhcPs
x psb :: PatSynBind GhcPs GhcPs
psb@PSB{ psb_id :: forall idL idR. PatSynBind idL idR -> Located (IdP idL)
psb_id = Located (IdP GhcPs)
rdrname })
  | NameMaker -> Bool
isTopRecNameMaker NameMaker
name_maker
  = do { (RdrName -> TcRn ()) -> Located RdrName -> TcRn ()
forall a b. (a -> TcM b) -> Located a -> TcM b
addLocM RdrName -> TcRn ()
checkConName Located RdrName
Located (IdP GhcPs)
rdrname
       ; Located Name
name <- Located RdrName -> RnM (Located Name)
lookupLocatedTopBndrRn Located RdrName
Located (IdP GhcPs)
rdrname   -- Should be in scope already
       ; HsBindLR GhcRn GhcPs -> TcM (HsBindLR GhcRn GhcPs)
forall (m :: * -> *) a. Monad m => a -> m a
return (XPatSynBind GhcRn GhcPs
-> PatSynBind GhcRn GhcPs -> HsBindLR GhcRn GhcPs
forall idL idR.
XPatSynBind idL idR -> PatSynBind idL idR -> HsBindLR idL idR
PatSynBind XPatSynBind GhcPs GhcPs
XPatSynBind GhcRn GhcPs
x PatSynBind GhcPs GhcPs
psb{ psb_ext :: XPSB GhcRn GhcPs
psb_ext = NoExtField
XPSB GhcRn GhcPs
noExtField, psb_id :: Located (IdP GhcRn)
psb_id = Located Name
Located (IdP GhcRn)
name }) }

  | Bool
otherwise  -- Pattern synonym, not at top level
  = do { MsgDoc -> TcRn ()
addErr MsgDoc
localPatternSynonymErr  -- Complain, but make up a fake
                                        -- name so that we can carry on
       ; Located Name
name <- NameMaker -> Located RdrName -> RnM (Located Name)
applyNameMaker NameMaker
name_maker Located RdrName
Located (IdP GhcPs)
rdrname
       ; HsBindLR GhcRn GhcPs -> TcM (HsBindLR GhcRn GhcPs)
forall (m :: * -> *) a. Monad m => a -> m a
return (XPatSynBind GhcRn GhcPs
-> PatSynBind GhcRn GhcPs -> HsBindLR GhcRn GhcPs
forall idL idR.
XPatSynBind idL idR -> PatSynBind idL idR -> HsBindLR idL idR
PatSynBind XPatSynBind GhcPs GhcPs
XPatSynBind GhcRn GhcPs
x PatSynBind GhcPs GhcPs
psb{ psb_ext :: XPSB GhcRn GhcPs
psb_ext = NoExtField
XPSB GhcRn GhcPs
noExtField, psb_id :: Located (IdP GhcRn)
psb_id = Located Name
Located (IdP GhcRn)
name }) }
  where
    localPatternSynonymErr :: SDoc
    localPatternSynonymErr :: MsgDoc
localPatternSynonymErr
      = MsgDoc -> Int -> MsgDoc -> MsgDoc
hang (String -> MsgDoc
text String
"Illegal pattern synonym declaration for" MsgDoc -> MsgDoc -> MsgDoc
<+> MsgDoc -> MsgDoc
quotes (Located RdrName -> MsgDoc
forall a. Outputable a => a -> MsgDoc
ppr Located RdrName
Located (IdP GhcPs)
rdrname))
           Int
2 (String -> MsgDoc
text String
"Pattern synonym declarations are only valid at top level")

rnBindLHS NameMaker
_ MsgDoc
_ HsBindLR GhcPs GhcPs
b = String -> MsgDoc -> TcM (HsBindLR GhcRn GhcPs)
forall a. HasCallStack => String -> MsgDoc -> a
pprPanic String
"rnBindHS" (HsBindLR GhcPs GhcPs -> MsgDoc
forall a. Outputable a => a -> MsgDoc
ppr HsBindLR GhcPs GhcPs
b)

rnLBind :: (Name -> [Name])      -- Signature tyvar function
        -> LHsBindLR GhcRn GhcPs
        -> RnM (LHsBind GhcRn, [Name], Uses)
rnLBind :: (Name -> [Name])
-> GenLocated SrcSpan (HsBindLR GhcRn GhcPs)
-> IOEnv (Env TcGblEnv TcLclEnv) (LHsBind GhcRn, [Name], NameSet)
rnLBind Name -> [Name]
sig_fn (L SrcSpan
loc HsBindLR GhcRn GhcPs
bind)
  = SrcSpan
-> IOEnv (Env TcGblEnv TcLclEnv) (LHsBind GhcRn, [Name], NameSet)
-> IOEnv (Env TcGblEnv TcLclEnv) (LHsBind GhcRn, [Name], NameSet)
forall a. SrcSpan -> TcRn a -> TcRn a
setSrcSpan SrcSpan
loc (IOEnv (Env TcGblEnv TcLclEnv) (LHsBind GhcRn, [Name], NameSet)
 -> IOEnv (Env TcGblEnv TcLclEnv) (LHsBind GhcRn, [Name], NameSet))
-> IOEnv (Env TcGblEnv TcLclEnv) (LHsBind GhcRn, [Name], NameSet)
-> IOEnv (Env TcGblEnv TcLclEnv) (LHsBind GhcRn, [Name], NameSet)
forall a b. (a -> b) -> a -> b
$
    do { (HsBind GhcRn
bind', [Name]
bndrs, NameSet
dus) <- (Name -> [Name])
-> HsBindLR GhcRn GhcPs -> RnM (HsBind GhcRn, [Name], NameSet)
rnBind Name -> [Name]
sig_fn HsBindLR GhcRn GhcPs
bind
       ; (LHsBind GhcRn, [Name], NameSet)
-> IOEnv (Env TcGblEnv TcLclEnv) (LHsBind GhcRn, [Name], NameSet)
forall (m :: * -> *) a. Monad m => a -> m a
return (SrcSpan -> HsBind GhcRn -> LHsBind GhcRn
forall l e. l -> e -> GenLocated l e
L SrcSpan
loc HsBind GhcRn
bind', [Name]
bndrs, NameSet
dus) }

-- assumes the left-hands-side vars are in scope
rnBind :: (Name -> [Name])        -- Signature tyvar function
       -> HsBindLR GhcRn GhcPs
       -> RnM (HsBind GhcRn, [Name], Uses)
rnBind :: (Name -> [Name])
-> HsBindLR GhcRn GhcPs -> RnM (HsBind GhcRn, [Name], NameSet)
rnBind Name -> [Name]
_ bind :: HsBindLR GhcRn GhcPs
bind@(PatBind { pat_lhs :: forall idL idR. HsBindLR idL idR -> LPat idL
pat_lhs = LPat GhcRn
pat
                       , pat_rhs :: forall idL idR. HsBindLR idL idR -> GRHSs idR (LHsExpr idR)
pat_rhs = GRHSs GhcPs (LHsExpr GhcPs)
grhss
                                   -- pat fvs were stored in bind_fvs
                                   -- after processing the LHS
                       , pat_ext :: forall idL idR. HsBindLR idL idR -> XPatBind idL idR
pat_ext = XPatBind GhcRn GhcPs
pat_fvs })
  = do  { Module
mod <- IOEnv (Env TcGblEnv TcLclEnv) Module
forall (m :: * -> *). HasModule m => m Module
getModule
        ; (GRHSs GhcRn (LHsExpr GhcRn)
grhss', NameSet
rhs_fvs) <- HsMatchContext GhcRn
-> (LHsExpr GhcPs -> RnM (LHsExpr GhcRn, NameSet))
-> GRHSs GhcPs (LHsExpr GhcPs)
-> RnM (GRHSs GhcRn (LHsExpr GhcRn), NameSet)
forall (body :: * -> *).
HsMatchContext GhcRn
-> (Located (body GhcPs) -> RnM (Located (body GhcRn), NameSet))
-> GRHSs GhcPs (Located (body GhcPs))
-> RnM (GRHSs GhcRn (Located (body GhcRn)), NameSet)
rnGRHSs HsMatchContext GhcRn
forall p. HsMatchContext p
PatBindRhs LHsExpr GhcPs -> RnM (LHsExpr GhcRn, NameSet)
rnLExpr GRHSs GhcPs (LHsExpr GhcPs)
grhss

                -- No scoped type variables for pattern bindings
        ; let all_fvs :: NameSet
all_fvs = NameSet
XPatBind GhcRn GhcPs
pat_fvs NameSet -> NameSet -> NameSet
`plusFV` NameSet
rhs_fvs
              fvs' :: NameSet
fvs'    = (Name -> Bool) -> NameSet -> NameSet
filterNameSet (Module -> Name -> Bool
nameIsLocalOrFrom Module
mod) NameSet
all_fvs
                -- Keep locally-defined Names
                -- As well as dependency analysis, we need these for the
                -- MonoLocalBinds test in GHC.Tc.Gen.Bind.decideGeneralisationPlan
              bndrs :: [IdP GhcRn]
bndrs = LPat GhcRn -> [IdP GhcRn]
forall p. CollectPass p => LPat p -> [IdP p]
collectPatBinders LPat GhcRn
pat
              bind' :: HsBind GhcRn
bind' = HsBindLR GhcRn GhcPs
bind { pat_rhs :: GRHSs GhcRn (LHsExpr GhcRn)
pat_rhs  = GRHSs GhcRn (LHsExpr GhcRn)
grhss'
                           , pat_ext :: XPatBind GhcRn GhcRn
pat_ext = NameSet
XPatBind GhcRn GhcRn
fvs' }

              ok_nobind_pat :: Bool
ok_nobind_pat
                  = -- See Note [Pattern bindings that bind no variables]
                    case Located (Pat GhcRn) -> Pat GhcRn
forall l e. GenLocated l e -> e
unLoc Located (Pat GhcRn)
LPat GhcRn
pat of
                       WildPat {}   -> Bool
True
                       BangPat {}   -> Bool
True -- #9127, #13646
                       SplicePat {} -> Bool
True
                       Pat GhcRn
_            -> Bool
False

        -- Warn if the pattern binds no variables
        -- See Note [Pattern bindings that bind no variables]
        ; WarningFlag -> TcRn () -> TcRn ()
forall gbl lcl.
WarningFlag -> TcRnIf gbl lcl () -> TcRnIf gbl lcl ()
whenWOptM WarningFlag
Opt_WarnUnusedPatternBinds (TcRn () -> TcRn ()) -> TcRn () -> TcRn ()
forall a b. (a -> b) -> a -> b
$
          Bool -> TcRn () -> TcRn ()
forall (f :: * -> *). Applicative f => Bool -> f () -> f ()
when ([Name] -> Bool
forall (t :: * -> *) a. Foldable t => t a -> Bool
null [Name]
[IdP GhcRn]
bndrs Bool -> Bool -> Bool
&& Bool -> Bool
not Bool
ok_nobind_pat) (TcRn () -> TcRn ()) -> TcRn () -> TcRn ()
forall a b. (a -> b) -> a -> b
$
          WarnReason -> MsgDoc -> TcRn ()
addWarn (WarningFlag -> WarnReason
Reason WarningFlag
Opt_WarnUnusedPatternBinds) (MsgDoc -> TcRn ()) -> MsgDoc -> TcRn ()
forall a b. (a -> b) -> a -> b
$
          HsBind GhcRn -> MsgDoc
unusedPatBindWarn HsBind GhcRn
bind'

        ; NameSet
fvs' NameSet
-> RnM (HsBind GhcRn, [Name], NameSet)
-> RnM (HsBind GhcRn, [Name], NameSet)
`seq` -- See Note [Free-variable space leak]
          (HsBind GhcRn, [Name], NameSet)
-> RnM (HsBind GhcRn, [Name], NameSet)
forall (m :: * -> *) a. Monad m => a -> m a
return (HsBind GhcRn
bind', [Name]
[IdP GhcRn]
bndrs, NameSet
all_fvs) }

rnBind Name -> [Name]
sig_fn bind :: HsBindLR GhcRn GhcPs
bind@(FunBind { fun_id :: forall idL idR. HsBindLR idL idR -> Located (IdP idL)
fun_id = Located (IdP GhcRn)
name
                            , fun_matches :: forall idL idR. HsBindLR idL idR -> MatchGroup idR (LHsExpr idR)
fun_matches = MatchGroup GhcPs (LHsExpr GhcPs)
matches })
       -- invariant: no free vars here when it's a FunBind
  = do  { let plain_name :: Name
plain_name = Located Name -> Name
forall l e. GenLocated l e -> e
unLoc Located Name
Located (IdP GhcRn)
name

        ; (MatchGroup GhcRn (LHsExpr GhcRn)
matches', NameSet
rhs_fvs) <- [Name]
-> RnM (MatchGroup GhcRn (LHsExpr GhcRn), NameSet)
-> RnM (MatchGroup GhcRn (LHsExpr GhcRn), NameSet)
forall a. [Name] -> RnM (a, NameSet) -> RnM (a, NameSet)
bindSigTyVarsFV (Name -> [Name]
sig_fn Name
plain_name) (RnM (MatchGroup GhcRn (LHsExpr GhcRn), NameSet)
 -> RnM (MatchGroup GhcRn (LHsExpr GhcRn), NameSet))
-> RnM (MatchGroup GhcRn (LHsExpr GhcRn), NameSet)
-> RnM (MatchGroup GhcRn (LHsExpr GhcRn), NameSet)
forall a b. (a -> b) -> a -> b
$
                                -- bindSigTyVars tests for LangExt.ScopedTyVars
                                 HsMatchContext GhcRn
-> (LHsExpr GhcPs -> RnM (LHsExpr GhcRn, NameSet))
-> MatchGroup GhcPs (LHsExpr GhcPs)
-> RnM (MatchGroup GhcRn (LHsExpr GhcRn), NameSet)
forall (body :: * -> *).
Outputable (body GhcPs) =>
HsMatchContext GhcRn
-> (Located (body GhcPs) -> RnM (Located (body GhcRn), NameSet))
-> MatchGroup GhcPs (Located (body GhcPs))
-> RnM (MatchGroup GhcRn (Located (body GhcRn)), NameSet)
rnMatchGroup (Located (IdP GhcRn) -> HsMatchContext GhcRn
forall p. LIdP p -> HsMatchContext p
mkPrefixFunRhs Located (IdP GhcRn)
name)
                                              LHsExpr GhcPs -> RnM (LHsExpr GhcRn, NameSet)
rnLExpr MatchGroup GhcPs (LHsExpr GhcPs)
matches
        ; let is_infix :: Bool
is_infix = HsBindLR GhcRn GhcPs -> Bool
forall id1 id2. HsBindLR id1 id2 -> Bool
isInfixFunBind HsBindLR GhcRn GhcPs
bind
        ; Bool -> TcRn () -> TcRn ()
forall (f :: * -> *). Applicative f => Bool -> f () -> f ()
when Bool
is_infix (TcRn () -> TcRn ()) -> TcRn () -> TcRn ()
forall a b. (a -> b) -> a -> b
$ Name -> MatchGroup GhcRn (LHsExpr GhcRn) -> TcRn ()
forall body. Name -> MatchGroup GhcRn body -> TcRn ()
checkPrecMatch Name
plain_name MatchGroup GhcRn (LHsExpr GhcRn)
matches'

        ; Module
mod <- IOEnv (Env TcGblEnv TcLclEnv) Module
forall (m :: * -> *). HasModule m => m Module
getModule
        ; let fvs' :: NameSet
fvs' = (Name -> Bool) -> NameSet -> NameSet
filterNameSet (Module -> Name -> Bool
nameIsLocalOrFrom Module
mod) NameSet
rhs_fvs
                -- Keep locally-defined Names
                -- As well as dependency analysis, we need these for the
                -- MonoLocalBinds test in GHC.Tc.Gen.Bind.decideGeneralisationPlan

        ; NameSet
fvs' NameSet
-> RnM (HsBind GhcRn, [Name], NameSet)
-> RnM (HsBind GhcRn, [Name], NameSet)
`seq` -- See Note [Free-variable space leak]
          (HsBind GhcRn, [Name], NameSet)
-> RnM (HsBind GhcRn, [Name], NameSet)
forall (m :: * -> *) a. Monad m => a -> m a
return (HsBindLR GhcRn GhcPs
bind { fun_matches :: MatchGroup GhcRn (LHsExpr GhcRn)
fun_matches = MatchGroup GhcRn (LHsExpr GhcRn)
matches'
                       , fun_ext :: XFunBind GhcRn GhcRn
fun_ext     = NameSet
XFunBind GhcRn GhcRn
fvs' },
                  [Name
plain_name], NameSet
rhs_fvs)
      }

rnBind Name -> [Name]
sig_fn (PatSynBind XPatSynBind GhcRn GhcPs
x PatSynBind GhcRn GhcPs
bind)
  = do  { (PatSynBind GhcRn GhcRn
bind', [Name]
name, NameSet
fvs) <- (Name -> [Name])
-> PatSynBind GhcRn GhcPs
-> RnM (PatSynBind GhcRn GhcRn, [Name], NameSet)
rnPatSynBind Name -> [Name]
sig_fn PatSynBind GhcRn GhcPs
bind
        ; (HsBind GhcRn, [Name], NameSet)
-> RnM (HsBind GhcRn, [Name], NameSet)
forall (m :: * -> *) a. Monad m => a -> m a
return (XPatSynBind GhcRn GhcRn -> PatSynBind GhcRn GhcRn -> HsBind GhcRn
forall idL idR.
XPatSynBind idL idR -> PatSynBind idL idR -> HsBindLR idL idR
PatSynBind XPatSynBind GhcRn GhcPs
XPatSynBind GhcRn GhcRn
x PatSynBind GhcRn GhcRn
bind', [Name]
name, NameSet
fvs) }

rnBind Name -> [Name]
_ HsBindLR GhcRn GhcPs
b = String -> MsgDoc -> RnM (HsBind GhcRn, [Name], NameSet)
forall a. HasCallStack => String -> MsgDoc -> a
pprPanic String
"rnBind" (HsBindLR GhcRn GhcPs -> MsgDoc
forall a. Outputable a => a -> MsgDoc
ppr HsBindLR GhcRn GhcPs
b)

{- Note [Pattern bindings that bind no variables]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Generally, we want to warn about pattern bindings like
  Just _ = e
because they don't do anything!  But we have three exceptions:

* A wildcard pattern
       _ = rhs
  which (a) is not that different from  _v = rhs
        (b) is sometimes used to give a type sig for,
            or an occurrence of, a variable on the RHS

* A strict pattern binding; that is, one with an outermost bang
     !Just _ = e
  This can fail, so unlike the lazy variant, it is not a no-op.
  Moreover, #13646 argues that even for single constructor
  types, you might want to write the constructor.  See also #9127.

* A splice pattern
      $(th-lhs) = rhs
   It is impossible to determine whether or not th-lhs really
   binds any variable. We should disable the warning for any pattern
   which contain splices, but that is a more expensive check.

Note [Free-variable space leak]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
We have
    fvs' = trim fvs
and we seq fvs' before turning it as part of a record.

The reason is that trim is sometimes something like
    \xs -> intersectNameSet (mkNameSet bound_names) xs
and we don't want to retain the list bound_names. This showed up in
trac ticket #1136.
-}

{- *********************************************************************
*                                                                      *
          Dependency analysis and other support functions
*                                                                      *
********************************************************************* -}

depAnalBinds :: Bag (LHsBind GhcRn, [Name], Uses)
             -> ([(RecFlag, LHsBinds GhcRn)], DefUses)
-- Dependency analysis; this is important so that
-- unused-binding reporting is accurate
depAnalBinds :: Bag (LHsBind GhcRn, [Name], NameSet)
-> ([(RecFlag, LHsBinds GhcRn)], DefUses)
depAnalBinds Bag (LHsBind GhcRn, [Name], NameSet)
binds_w_dus
  = ((SCC (LHsBind GhcRn, [Name], NameSet) -> (RecFlag, LHsBinds GhcRn))
-> [SCC (LHsBind GhcRn, [Name], NameSet)]
-> [(RecFlag, LHsBinds GhcRn)]
forall a b. (a -> b) -> [a] -> [b]
map SCC (LHsBind GhcRn, [Name], NameSet) -> (RecFlag, LHsBinds GhcRn)
forall {a} {b} {c}. SCC (a, b, c) -> (RecFlag, Bag a)
get_binds [SCC (LHsBind GhcRn, [Name], NameSet)]
sccs, [(Maybe NameSet, NameSet)] -> DefUses
forall a. [a] -> OrdList a
toOL ([(Maybe NameSet, NameSet)] -> DefUses)
-> [(Maybe NameSet, NameSet)] -> DefUses
forall a b. (a -> b) -> a -> b
$ (SCC (LHsBind GhcRn, [Name], NameSet) -> (Maybe NameSet, NameSet))
-> [SCC (LHsBind GhcRn, [Name], NameSet)]
-> [(Maybe NameSet, NameSet)]
forall a b. (a -> b) -> [a] -> [b]
map SCC (LHsBind GhcRn, [Name], NameSet) -> (Maybe NameSet, NameSet)
forall {a}. SCC (a, [Name], NameSet) -> (Maybe NameSet, NameSet)
get_du [SCC (LHsBind GhcRn, [Name], NameSet)]
sccs)
  where
    sccs :: [SCC (LHsBind GhcRn, [Name], NameSet)]
sccs = ((LHsBind GhcRn, [Name], NameSet) -> [Name])
-> ((LHsBind GhcRn, [Name], NameSet) -> [Name])
-> [(LHsBind GhcRn, [Name], NameSet)]
-> [SCC (LHsBind GhcRn, [Name], NameSet)]
forall node.
(node -> [Name]) -> (node -> [Name]) -> [node] -> [SCC node]
depAnal (\(LHsBind GhcRn
_, [Name]
defs, NameSet
_) -> [Name]
defs)
                   (\(LHsBind GhcRn
_, [Name]
_, NameSet
uses) -> NameSet -> [Name]
forall elt. UniqSet elt -> [elt]
nonDetEltsUniqSet NameSet
uses)
                   -- It's OK to use nonDetEltsUniqSet here as explained in
                   -- Note [depAnal determinism] in GHC.Types.Name.Env.
                   (Bag (LHsBind GhcRn, [Name], NameSet)
-> [(LHsBind GhcRn, [Name], NameSet)]
forall a. Bag a -> [a]
bagToList Bag (LHsBind GhcRn, [Name], NameSet)
binds_w_dus)

    get_binds :: SCC (a, b, c) -> (RecFlag, Bag a)
get_binds (AcyclicSCC (a
bind, b
_, c
_)) = (RecFlag
NonRecursive, a -> Bag a
forall a. a -> Bag a
unitBag a
bind)
    get_binds (CyclicSCC  [(a, b, c)]
binds_w_dus)  = (RecFlag
Recursive, [a] -> Bag a
forall a. [a] -> Bag a
listToBag [a
b | (a
b,b
_,c
_) <- [(a, b, c)]
binds_w_dus])

    get_du :: SCC (a, [Name], NameSet) -> (Maybe NameSet, NameSet)
get_du (AcyclicSCC (a
_, [Name]
bndrs, NameSet
uses)) = (NameSet -> Maybe NameSet
forall a. a -> Maybe a
Just ([Name] -> NameSet
mkNameSet [Name]
bndrs), NameSet
uses)
    get_du (CyclicSCC  [(a, [Name], NameSet)]
binds_w_dus)      = (NameSet -> Maybe NameSet
forall a. a -> Maybe a
Just NameSet
defs, NameSet
uses)
        where
          defs :: NameSet
defs = [Name] -> NameSet
mkNameSet [Name
b | (a
_,[Name]
bs,NameSet
_) <- [(a, [Name], NameSet)]
binds_w_dus, Name
b <- [Name]
bs]
          uses :: NameSet
uses = [NameSet] -> NameSet
unionNameSets [NameSet
u | (a
_,[Name]
_,NameSet
u) <- [(a, [Name], NameSet)]
binds_w_dus]

---------------------
-- Bind the top-level forall'd type variables in the sigs.
-- E.g  f :: forall a. a -> a
--      f = rhs
--      The 'a' scopes over the rhs
--
-- NB: there'll usually be just one (for a function binding)
--     but if there are many, one may shadow the rest; too bad!
--      e.g  x :: forall a. [a] -> [a]
--           y :: forall a. [(a,a)] -> a
--           (x,y) = e
--      In e, 'a' will be in scope, and it'll be the one from 'y'!

mkScopedTvFn :: [LSig GhcRn] -> (Name -> [Name])
-- Return a lookup function that maps an Id Name to the names
-- of the type variables that should scope over its body.
mkScopedTvFn :: [LSig GhcRn] -> Name -> [Name]
mkScopedTvFn [LSig GhcRn]
sigs = \Name
n -> NameEnv [Name] -> Name -> Maybe [Name]
forall a. NameEnv a -> Name -> Maybe a
lookupNameEnv NameEnv [Name]
env Name
n Maybe [Name] -> [Name] -> [Name]
forall a. Maybe a -> a -> a
`orElse` []
  where
    env :: NameEnv [Name]
env = (LSig GhcRn -> Maybe ([Located Name], [Name]))
-> [LSig GhcRn] -> NameEnv [Name]
forall a.
(LSig GhcRn -> Maybe ([Located Name], a))
-> [LSig GhcRn] -> NameEnv a
mkHsSigEnv LSig GhcRn -> Maybe ([Located Name], [Name])
get_scoped_tvs [LSig GhcRn]
sigs

    get_scoped_tvs :: LSig GhcRn -> Maybe ([Located Name], [Name])
    -- Returns (binders, scoped tvs for those binders)
    get_scoped_tvs :: LSig GhcRn -> Maybe ([Located Name], [Name])
get_scoped_tvs (L SrcSpan
_ (ClassOpSig XClassOpSig GhcRn
_ Bool
_ [Located (IdP GhcRn)]
names LHsSigType GhcRn
sig_ty))
      = ([Located Name], [Name]) -> Maybe ([Located Name], [Name])
forall a. a -> Maybe a
Just ([Located Name]
[Located (IdP GhcRn)]
names, LHsSigType GhcRn -> [Name]
hsScopedTvs LHsSigType GhcRn
sig_ty)
    get_scoped_tvs (L SrcSpan
_ (TypeSig XTypeSig GhcRn
_ [Located (IdP GhcRn)]
names LHsSigWcType GhcRn
sig_ty))
      = ([Located Name], [Name]) -> Maybe ([Located Name], [Name])
forall a. a -> Maybe a
Just ([Located Name]
[Located (IdP GhcRn)]
names, LHsSigWcType GhcRn -> [Name]
hsWcScopedTvs LHsSigWcType GhcRn
sig_ty)
    get_scoped_tvs (L SrcSpan
_ (PatSynSig XPatSynSig GhcRn
_ [Located (IdP GhcRn)]
names LHsSigType GhcRn
sig_ty))
      = ([Located Name], [Name]) -> Maybe ([Located Name], [Name])
forall a. a -> Maybe a
Just ([Located Name]
[Located (IdP GhcRn)]
names, LHsSigType GhcRn -> [Name]
hsScopedTvs LHsSigType GhcRn
sig_ty)
    get_scoped_tvs LSig GhcRn
_ = Maybe ([Located Name], [Name])
forall a. Maybe a
Nothing

-- Process the fixity declarations, making a FastString -> (Located Fixity) map
-- (We keep the location around for reporting duplicate fixity declarations.)
--
-- Checks for duplicates, but not that only locally defined things are fixed.
-- Note: for local fixity declarations, duplicates would also be checked in
--       check_sigs below.  But we also use this function at the top level.

makeMiniFixityEnv :: [LFixitySig GhcPs] -> RnM MiniFixityEnv

makeMiniFixityEnv :: [LFixitySig GhcPs] -> RnM MiniFixityEnv
makeMiniFixityEnv [LFixitySig GhcPs]
decls = (MiniFixityEnv -> LFixitySig GhcPs -> RnM MiniFixityEnv)
-> MiniFixityEnv -> [LFixitySig GhcPs] -> RnM MiniFixityEnv
forall (t :: * -> *) (m :: * -> *) b a.
(Foldable t, Monad m) =>
(b -> a -> m b) -> b -> t a -> m b
foldlM MiniFixityEnv -> LFixitySig GhcPs -> RnM MiniFixityEnv
add_one_sig MiniFixityEnv
forall a. FastStringEnv a
emptyFsEnv [LFixitySig GhcPs]
decls
 where
   add_one_sig :: MiniFixityEnv -> LFixitySig GhcPs -> RnM MiniFixityEnv
   add_one_sig :: MiniFixityEnv -> LFixitySig GhcPs -> RnM MiniFixityEnv
add_one_sig MiniFixityEnv
env (L SrcSpan
loc (FixitySig XFixitySig GhcPs
_ [Located (IdP GhcPs)]
names Fixity
fixity)) =
     (MiniFixityEnv
 -> (SrcSpan, SrcSpan, RdrName, Fixity) -> RnM MiniFixityEnv)
-> MiniFixityEnv
-> [(SrcSpan, SrcSpan, RdrName, Fixity)]
-> RnM MiniFixityEnv
forall (t :: * -> *) (m :: * -> *) b a.
(Foldable t, Monad m) =>
(b -> a -> m b) -> b -> t a -> m b
foldlM MiniFixityEnv
-> (SrcSpan, SrcSpan, RdrName, Fixity) -> RnM MiniFixityEnv
forall {e}.
FastStringEnv (GenLocated SrcSpan e)
-> (SrcSpan, SrcSpan, RdrName, e)
-> IOEnv
     (Env TcGblEnv TcLclEnv) (FastStringEnv (GenLocated SrcSpan e))
add_one MiniFixityEnv
env [ (SrcSpan
loc,SrcSpan
name_loc,RdrName
name,Fixity
fixity)
                        | L SrcSpan
name_loc RdrName
name <- [Located RdrName]
[Located (IdP GhcPs)]
names ]

   add_one :: FastStringEnv (GenLocated SrcSpan e)
-> (SrcSpan, SrcSpan, RdrName, e)
-> IOEnv
     (Env TcGblEnv TcLclEnv) (FastStringEnv (GenLocated SrcSpan e))
add_one FastStringEnv (GenLocated SrcSpan e)
env (SrcSpan
loc, SrcSpan
name_loc, RdrName
name,e
fixity) = do
     { -- this fixity decl is a duplicate iff
       -- the ReaderName's OccName's FastString is already in the env
       -- (we only need to check the local fix_env because
       --  definitions of non-local will be caught elsewhere)
       let { fs :: FastString
fs = OccName -> FastString
occNameFS (RdrName -> OccName
rdrNameOcc RdrName
name)
           ; fix_item :: GenLocated SrcSpan e
fix_item = SrcSpan -> e -> GenLocated SrcSpan e
forall l e. l -> e -> GenLocated l e
L SrcSpan
loc e
fixity };

       case FastStringEnv (GenLocated SrcSpan e)
-> FastString -> Maybe (GenLocated SrcSpan e)
forall a. FastStringEnv a -> FastString -> Maybe a
lookupFsEnv FastStringEnv (GenLocated SrcSpan e)
env FastString
fs of
         Maybe (GenLocated SrcSpan e)
Nothing -> FastStringEnv (GenLocated SrcSpan e)
-> IOEnv
     (Env TcGblEnv TcLclEnv) (FastStringEnv (GenLocated SrcSpan e))
forall (m :: * -> *) a. Monad m => a -> m a
return (FastStringEnv (GenLocated SrcSpan e)
 -> IOEnv
      (Env TcGblEnv TcLclEnv) (FastStringEnv (GenLocated SrcSpan e)))
-> FastStringEnv (GenLocated SrcSpan e)
-> IOEnv
     (Env TcGblEnv TcLclEnv) (FastStringEnv (GenLocated SrcSpan e))
forall a b. (a -> b) -> a -> b
$ FastStringEnv (GenLocated SrcSpan e)
-> FastString
-> GenLocated SrcSpan e
-> FastStringEnv (GenLocated SrcSpan e)
forall a. FastStringEnv a -> FastString -> a -> FastStringEnv a
extendFsEnv FastStringEnv (GenLocated SrcSpan e)
env FastString
fs GenLocated SrcSpan e
fix_item
         Just (L SrcSpan
loc' e
_) -> do
           { SrcSpan -> TcRn () -> TcRn ()
forall a. SrcSpan -> TcRn a -> TcRn a
setSrcSpan SrcSpan
loc (TcRn () -> TcRn ()) -> TcRn () -> TcRn ()
forall a b. (a -> b) -> a -> b
$
             SrcSpan -> MsgDoc -> TcRn ()
addErrAt SrcSpan
name_loc (SrcSpan -> RdrName -> MsgDoc
dupFixityDecl SrcSpan
loc' RdrName
name)
           ; FastStringEnv (GenLocated SrcSpan e)
-> IOEnv
     (Env TcGblEnv TcLclEnv) (FastStringEnv (GenLocated SrcSpan e))
forall (m :: * -> *) a. Monad m => a -> m a
return FastStringEnv (GenLocated SrcSpan e)
env}
     }

dupFixityDecl :: SrcSpan -> RdrName -> SDoc
dupFixityDecl :: SrcSpan -> RdrName -> MsgDoc
dupFixityDecl SrcSpan
loc RdrName
rdr_name
  = [MsgDoc] -> MsgDoc
vcat [String -> MsgDoc
text String
"Multiple fixity declarations for" MsgDoc -> MsgDoc -> MsgDoc
<+> MsgDoc -> MsgDoc
quotes (RdrName -> MsgDoc
forall a. Outputable a => a -> MsgDoc
ppr RdrName
rdr_name),
          String -> MsgDoc
text String
"also at " MsgDoc -> MsgDoc -> MsgDoc
<+> SrcSpan -> MsgDoc
forall a. Outputable a => a -> MsgDoc
ppr SrcSpan
loc]


{- *********************************************************************
*                                                                      *
                Pattern synonym bindings
*                                                                      *
********************************************************************* -}

rnPatSynBind :: (Name -> [Name])           -- Signature tyvar function
             -> PatSynBind GhcRn GhcPs
             -> RnM (PatSynBind GhcRn GhcRn, [Name], Uses)
rnPatSynBind :: (Name -> [Name])
-> PatSynBind GhcRn GhcPs
-> RnM (PatSynBind GhcRn GhcRn, [Name], NameSet)
rnPatSynBind Name -> [Name]
sig_fn bind :: PatSynBind GhcRn GhcPs
bind@(PSB { psb_id :: forall idL idR. PatSynBind idL idR -> Located (IdP idL)
psb_id = L SrcSpan
l IdP GhcRn
name
                              , psb_args :: forall idL idR.
PatSynBind idL idR -> HsPatSynDetails (Located (IdP idR))
psb_args = HsPatSynDetails (Located (IdP GhcPs))
details
                              , psb_def :: forall idL idR. PatSynBind idL idR -> LPat idR
psb_def = LPat GhcPs
pat
                              , psb_dir :: forall idL idR. PatSynBind idL idR -> HsPatSynDir idR
psb_dir = HsPatSynDir GhcPs
dir })
       -- invariant: no free vars here when it's a FunBind
  = do  { Bool
pattern_synonym_ok <- Extension -> TcRnIf TcGblEnv TcLclEnv Bool
forall gbl lcl. Extension -> TcRnIf gbl lcl Bool
xoptM Extension
LangExt.PatternSynonyms
        ; Bool -> TcRn () -> TcRn ()
forall (f :: * -> *). Applicative f => Bool -> f () -> f ()
unless Bool
pattern_synonym_ok (MsgDoc -> TcRn ()
addErr MsgDoc
patternSynonymErr)
        ; let scoped_tvs :: [Name]
scoped_tvs = Name -> [Name]
sig_fn Name
IdP GhcRn
name

        ; ((Located (Pat GhcRn)
pat', HsConDetails (Located Name) [RecordPatSynField (Located Name)]
details'), NameSet
fvs1) <- [Name]
-> RnM
     ((Located (Pat GhcRn),
       HsConDetails (Located Name) [RecordPatSynField (Located Name)]),
      NameSet)
-> RnM
     ((Located (Pat GhcRn),
       HsConDetails (Located Name) [RecordPatSynField (Located Name)]),
      NameSet)
forall a. [Name] -> RnM (a, NameSet) -> RnM (a, NameSet)
bindSigTyVarsFV [Name]
scoped_tvs (RnM
   ((Located (Pat GhcRn),
     HsConDetails (Located Name) [RecordPatSynField (Located Name)]),
    NameSet)
 -> RnM
      ((Located (Pat GhcRn),
        HsConDetails (Located Name) [RecordPatSynField (Located Name)]),
       NameSet))
-> RnM
     ((Located (Pat GhcRn),
       HsConDetails (Located Name) [RecordPatSynField (Located Name)]),
      NameSet)
-> RnM
     ((Located (Pat GhcRn),
       HsConDetails (Located Name) [RecordPatSynField (Located Name)]),
      NameSet)
forall a b. (a -> b) -> a -> b
$
                                      HsMatchContext GhcRn
-> LPat GhcPs
-> (LPat GhcRn
    -> RnM
         ((Located (Pat GhcRn),
           HsConDetails (Located Name) [RecordPatSynField (Located Name)]),
          NameSet))
-> RnM
     ((Located (Pat GhcRn),
       HsConDetails (Located Name) [RecordPatSynField (Located Name)]),
      NameSet)
forall a.
HsMatchContext GhcRn
-> LPat GhcPs
-> (LPat GhcRn -> RnM (a, NameSet))
-> RnM (a, NameSet)
rnPat HsMatchContext GhcRn
forall p. HsMatchContext p
PatSyn LPat GhcPs
pat ((LPat GhcRn
  -> RnM
       ((Located (Pat GhcRn),
         HsConDetails (Located Name) [RecordPatSynField (Located Name)]),
        NameSet))
 -> RnM
      ((Located (Pat GhcRn),
        HsConDetails (Located Name) [RecordPatSynField (Located Name)]),
       NameSet))
-> (LPat GhcRn
    -> RnM
         ((Located (Pat GhcRn),
           HsConDetails (Located Name) [RecordPatSynField (Located Name)]),
          NameSet))
-> RnM
     ((Located (Pat GhcRn),
       HsConDetails (Located Name) [RecordPatSynField (Located Name)]),
      NameSet)
forall a b. (a -> b) -> a -> b
$ \LPat GhcRn
pat' ->
         -- We check the 'RdrName's instead of the 'Name's
         -- so that the binding locations are reported
         -- from the left-hand side
            case HsPatSynDetails (Located (IdP GhcPs))
details of
               PrefixCon [Located (IdP GhcPs)]
vars ->
                   do { [Located RdrName] -> TcRn ()
checkDupRdrNames [Located RdrName]
[Located (IdP GhcPs)]
vars
                      ; [Located Name]
names <- (Located RdrName -> RnM (Located Name))
-> [Located RdrName]
-> IOEnv (Env TcGblEnv TcLclEnv) [Located Name]
forall (t :: * -> *) (m :: * -> *) a b.
(Traversable t, Monad m) =>
(a -> m b) -> t a -> m (t b)
mapM Located RdrName -> RnM (Located Name)
lookupPatSynBndr [Located RdrName]
[Located (IdP GhcPs)]
vars
                      ; ((Located (Pat GhcRn),
  HsConDetails (Located Name) [RecordPatSynField (Located Name)]),
 NameSet)
-> RnM
     ((Located (Pat GhcRn),
       HsConDetails (Located Name) [RecordPatSynField (Located Name)]),
      NameSet)
forall (m :: * -> *) a. Monad m => a -> m a
return ( (Located (Pat GhcRn)
LPat GhcRn
pat', [Located Name]
-> HsConDetails (Located Name) [RecordPatSynField (Located Name)]
forall arg rec. [arg] -> HsConDetails arg rec
PrefixCon [Located Name]
names)
                               , [Name] -> NameSet
mkFVs ((Located Name -> Name) -> [Located Name] -> [Name]
forall a b. (a -> b) -> [a] -> [b]
map Located Name -> Name
forall l e. GenLocated l e -> e
unLoc [Located Name]
names)) }
               InfixCon Located (IdP GhcPs)
var1 Located (IdP GhcPs)
var2 ->
                   do { [Located RdrName] -> TcRn ()
checkDupRdrNames [Located RdrName
Located (IdP GhcPs)
var1, Located RdrName
Located (IdP GhcPs)
var2]
                      ; Located Name
name1 <- Located RdrName -> RnM (Located Name)
lookupPatSynBndr Located RdrName
Located (IdP GhcPs)
var1
                      ; Located Name
name2 <- Located RdrName -> RnM (Located Name)
lookupPatSynBndr Located RdrName
Located (IdP GhcPs)
var2
                      -- ; checkPrecMatch -- TODO
                      ; ((Located (Pat GhcRn),
  HsConDetails (Located Name) [RecordPatSynField (Located Name)]),
 NameSet)
-> RnM
     ((Located (Pat GhcRn),
       HsConDetails (Located Name) [RecordPatSynField (Located Name)]),
      NameSet)
forall (m :: * -> *) a. Monad m => a -> m a
return ( (Located (Pat GhcRn)
LPat GhcRn
pat', Located Name
-> Located Name
-> HsConDetails (Located Name) [RecordPatSynField (Located Name)]
forall arg rec. arg -> arg -> HsConDetails arg rec
InfixCon Located Name
name1 Located Name
name2)
                               , [Name] -> NameSet
mkFVs ((Located Name -> Name) -> [Located Name] -> [Name]
forall a b. (a -> b) -> [a] -> [b]
map Located Name -> Name
forall l e. GenLocated l e -> e
unLoc [Located Name
name1, Located Name
name2])) }
               RecCon [RecordPatSynField (Located (IdP GhcPs))]
vars ->
                   do { [Located RdrName] -> TcRn ()
checkDupRdrNames ((RecordPatSynField (Located RdrName) -> Located RdrName)
-> [RecordPatSynField (Located RdrName)] -> [Located RdrName]
forall a b. (a -> b) -> [a] -> [b]
map RecordPatSynField (Located RdrName) -> Located RdrName
forall a. RecordPatSynField a -> a
recordPatSynSelectorId [RecordPatSynField (Located RdrName)]
[RecordPatSynField (Located (IdP GhcPs))]
vars)
                      ; let rnRecordPatSynField :: RecordPatSynField (Located RdrName)
-> IOEnv (Env TcGblEnv TcLclEnv) (RecordPatSynField (Located Name))
rnRecordPatSynField
                              (RecordPatSynField { recordPatSynSelectorId :: forall a. RecordPatSynField a -> a
recordPatSynSelectorId = Located RdrName
visible
                                                 , recordPatSynPatVar :: forall a. RecordPatSynField a -> a
recordPatSynPatVar = Located RdrName
hidden })
                              = do { Located Name
visible' <- Located RdrName -> RnM (Located Name)
lookupLocatedTopBndrRn Located RdrName
visible
                                   ; Located Name
hidden'  <- Located RdrName -> RnM (Located Name)
lookupPatSynBndr Located RdrName
hidden
                                   ; RecordPatSynField (Located Name)
-> IOEnv (Env TcGblEnv TcLclEnv) (RecordPatSynField (Located Name))
forall (m :: * -> *) a. Monad m => a -> m a
return (RecordPatSynField (Located Name)
 -> IOEnv
      (Env TcGblEnv TcLclEnv) (RecordPatSynField (Located Name)))
-> RecordPatSynField (Located Name)
-> IOEnv (Env TcGblEnv TcLclEnv) (RecordPatSynField (Located Name))
forall a b. (a -> b) -> a -> b
$ RecordPatSynField :: forall a. a -> a -> RecordPatSynField a
RecordPatSynField { recordPatSynSelectorId :: Located Name
recordPatSynSelectorId = Located Name
visible'
                                                                , recordPatSynPatVar :: Located Name
recordPatSynPatVar = Located Name
hidden' } }
                      ; [RecordPatSynField (Located Name)]
names <- (RecordPatSynField (Located RdrName)
 -> IOEnv
      (Env TcGblEnv TcLclEnv) (RecordPatSynField (Located Name)))
-> [RecordPatSynField (Located RdrName)]
-> IOEnv (Env TcGblEnv TcLclEnv) [RecordPatSynField (Located Name)]
forall (t :: * -> *) (m :: * -> *) a b.
(Traversable t, Monad m) =>
(a -> m b) -> t a -> m (t b)
mapM RecordPatSynField (Located RdrName)
-> IOEnv (Env TcGblEnv TcLclEnv) (RecordPatSynField (Located Name))
rnRecordPatSynField  [RecordPatSynField (Located RdrName)]
[RecordPatSynField (Located (IdP GhcPs))]
vars
                      ; ((Located (Pat GhcRn),
  HsConDetails (Located Name) [RecordPatSynField (Located Name)]),
 NameSet)
-> RnM
     ((Located (Pat GhcRn),
       HsConDetails (Located Name) [RecordPatSynField (Located Name)]),
      NameSet)
forall (m :: * -> *) a. Monad m => a -> m a
return ( (Located (Pat GhcRn)
LPat GhcRn
pat', [RecordPatSynField (Located Name)]
-> HsConDetails (Located Name) [RecordPatSynField (Located Name)]
forall arg rec. rec -> HsConDetails arg rec
RecCon [RecordPatSynField (Located Name)]
names)
                               , [Name] -> NameSet
mkFVs ((RecordPatSynField (Located Name) -> Name)
-> [RecordPatSynField (Located Name)] -> [Name]
forall a b. (a -> b) -> [a] -> [b]
map (Located Name -> Name
forall l e. GenLocated l e -> e
unLoc (Located Name -> Name)
-> (RecordPatSynField (Located Name) -> Located Name)
-> RecordPatSynField (Located Name)
-> Name
forall b c a. (b -> c) -> (a -> b) -> a -> c
. RecordPatSynField (Located Name) -> Located Name
forall a. RecordPatSynField a -> a
recordPatSynPatVar) [RecordPatSynField (Located Name)]
names)) }

        ; (HsPatSynDir GhcRn
dir', NameSet
fvs2) <- case HsPatSynDir GhcPs
dir of
            HsPatSynDir GhcPs
Unidirectional -> (HsPatSynDir GhcRn, NameSet)
-> IOEnv (Env TcGblEnv TcLclEnv) (HsPatSynDir GhcRn, NameSet)
forall (m :: * -> *) a. Monad m => a -> m a
return (HsPatSynDir GhcRn
forall id. HsPatSynDir id
Unidirectional, NameSet
emptyFVs)
            HsPatSynDir GhcPs
ImplicitBidirectional -> (HsPatSynDir GhcRn, NameSet)
-> IOEnv (Env TcGblEnv TcLclEnv) (HsPatSynDir GhcRn, NameSet)
forall (m :: * -> *) a. Monad m => a -> m a
return (HsPatSynDir GhcRn
forall id. HsPatSynDir id
ImplicitBidirectional, NameSet
emptyFVs)
            ExplicitBidirectional MatchGroup GhcPs (LHsExpr GhcPs)
mg ->
                do { (MatchGroup GhcRn (LHsExpr GhcRn)
mg', NameSet
fvs) <- [Name]
-> RnM (MatchGroup GhcRn (LHsExpr GhcRn), NameSet)
-> RnM (MatchGroup GhcRn (LHsExpr GhcRn), NameSet)
forall a. [Name] -> RnM (a, NameSet) -> RnM (a, NameSet)
bindSigTyVarsFV [Name]
scoped_tvs (RnM (MatchGroup GhcRn (LHsExpr GhcRn), NameSet)
 -> RnM (MatchGroup GhcRn (LHsExpr GhcRn), NameSet))
-> RnM (MatchGroup GhcRn (LHsExpr GhcRn), NameSet)
-> RnM (MatchGroup GhcRn (LHsExpr GhcRn), NameSet)
forall a b. (a -> b) -> a -> b
$
                                   HsMatchContext GhcRn
-> (LHsExpr GhcPs -> RnM (LHsExpr GhcRn, NameSet))
-> MatchGroup GhcPs (LHsExpr GhcPs)
-> RnM (MatchGroup GhcRn (LHsExpr GhcRn), NameSet)
forall (body :: * -> *).
Outputable (body GhcPs) =>
HsMatchContext GhcRn
-> (Located (body GhcPs) -> RnM (Located (body GhcRn), NameSet))
-> MatchGroup GhcPs (Located (body GhcPs))
-> RnM (MatchGroup GhcRn (Located (body GhcRn)), NameSet)
rnMatchGroup (Located (IdP GhcRn) -> HsMatchContext GhcRn
forall p. LIdP p -> HsMatchContext p
mkPrefixFunRhs (SrcSpan -> Name -> Located Name
forall l e. l -> e -> GenLocated l e
L SrcSpan
l Name
IdP GhcRn
name))
                                                LHsExpr GhcPs -> RnM (LHsExpr GhcRn, NameSet)
rnLExpr MatchGroup GhcPs (LHsExpr GhcPs)
mg
                   ; (HsPatSynDir GhcRn, NameSet)
-> IOEnv (Env TcGblEnv TcLclEnv) (HsPatSynDir GhcRn, NameSet)
forall (m :: * -> *) a. Monad m => a -> m a
return (MatchGroup GhcRn (LHsExpr GhcRn) -> HsPatSynDir GhcRn
forall id. MatchGroup id (LHsExpr id) -> HsPatSynDir id
ExplicitBidirectional MatchGroup GhcRn (LHsExpr GhcRn)
mg', NameSet
fvs) }

        ; Module
mod <- IOEnv (Env TcGblEnv TcLclEnv) Module
forall (m :: * -> *). HasModule m => m Module
getModule
        ; let fvs :: NameSet
fvs = NameSet
fvs1 NameSet -> NameSet -> NameSet
`plusFV` NameSet
fvs2
              fvs' :: NameSet
fvs' = (Name -> Bool) -> NameSet -> NameSet
filterNameSet (Module -> Name -> Bool
nameIsLocalOrFrom Module
mod) NameSet
fvs
                -- Keep locally-defined Names
                -- As well as dependency analysis, we need these for the
                -- MonoLocalBinds test in GHC.Tc.Gen.Bind.decideGeneralisationPlan

              bind' :: PatSynBind GhcRn GhcRn
bind' = PatSynBind GhcRn GhcPs
bind{ psb_args :: HsPatSynDetails (Located (IdP GhcRn))
psb_args = HsConDetails (Located Name) [RecordPatSynField (Located Name)]
HsPatSynDetails (Located (IdP GhcRn))
details'
                          , psb_def :: LPat GhcRn
psb_def = Located (Pat GhcRn)
LPat GhcRn
pat'
                          , psb_dir :: HsPatSynDir GhcRn
psb_dir = HsPatSynDir GhcRn
dir'
                          , psb_ext :: XPSB GhcRn GhcRn
psb_ext = NameSet
XPSB GhcRn GhcRn
fvs' }
              selector_names :: [Name]
selector_names = case HsConDetails (Located Name) [RecordPatSynField (Located Name)]
details' of
                                 RecCon [RecordPatSynField (Located Name)]
names ->
                                  (RecordPatSynField (Located Name) -> Name)
-> [RecordPatSynField (Located Name)] -> [Name]
forall a b. (a -> b) -> [a] -> [b]
map (Located Name -> Name
forall l e. GenLocated l e -> e
unLoc (Located Name -> Name)
-> (RecordPatSynField (Located Name) -> Located Name)
-> RecordPatSynField (Located Name)
-> Name
forall b c a. (b -> c) -> (a -> b) -> a -> c
. RecordPatSynField (Located Name) -> Located Name
forall a. RecordPatSynField a -> a
recordPatSynSelectorId) [RecordPatSynField (Located Name)]
names
                                 HsConDetails (Located Name) [RecordPatSynField (Located Name)]
_ -> []

        ; NameSet
fvs' NameSet
-> RnM (PatSynBind GhcRn GhcRn, [Name], NameSet)
-> RnM (PatSynBind GhcRn GhcRn, [Name], NameSet)
`seq` -- See Note [Free-variable space leak]
          (PatSynBind GhcRn GhcRn, [Name], NameSet)
-> RnM (PatSynBind GhcRn GhcRn, [Name], NameSet)
forall (m :: * -> *) a. Monad m => a -> m a
return (PatSynBind GhcRn GhcRn
bind', Name
IdP GhcRn
name Name -> [Name] -> [Name]
forall a. a -> [a] -> [a]
: [Name]
selector_names , NameSet
fvs1)
          -- Why fvs1?  See Note [Pattern synonym builders don't yield dependencies]
      }
  where
    -- See Note [Renaming pattern synonym variables]
    lookupPatSynBndr :: Located RdrName -> RnM (Located Name)
lookupPatSynBndr = (RdrName -> TcM Name) -> Located RdrName -> RnM (Located Name)
forall a b. (a -> TcM b) -> Located a -> TcM (Located b)
wrapLocM RdrName -> TcM Name
lookupLocalOccRn

    patternSynonymErr :: SDoc
    patternSynonymErr :: MsgDoc
patternSynonymErr
      = MsgDoc -> Int -> MsgDoc -> MsgDoc
hang (String -> MsgDoc
text String
"Illegal pattern synonym declaration")
           Int
2 (String -> MsgDoc
text String
"Use -XPatternSynonyms to enable this extension")

{-
Note [Renaming pattern synonym variables]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

We rename pattern synonym declaractions backwards to normal to reuse
the logic already implemented for renaming patterns.

We first rename the RHS of a declaration which brings into
scope the variables bound by the pattern (as they would be
in normal function definitions). We then lookup the variables
which we want to bind in this local environment.

It is crucial that we then only lookup in the *local* environment which
only contains the variables brought into scope by the pattern and nothing
else. Amazingly no-one encountered this bug for 3 GHC versions but
it was possible to define a pattern synonym which referenced global
identifiers and worked correctly.

```
x = 5

pattern P :: Int -> ()
pattern P x <- _

f (P x) = x

> f () = 5
```

See #13470 for the original report.

Note [Pattern synonym builders don't yield dependencies]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
When renaming a pattern synonym that has an explicit builder,
references in the builder definition should not be used when
calculating dependencies. For example, consider the following pattern
synonym definition:

pattern P x <- C1 x where
  P x = f (C1 x)

f (P x) = C2 x

In this case, 'P' needs to be typechecked in two passes:

1. Typecheck the pattern definition of 'P', which fully determines the
   type of 'P'. This step doesn't require knowing anything about 'f',
   since the builder definition is not looked at.

2. Typecheck the builder definition, which needs the typechecked
   definition of 'f' to be in scope; done by calls oo tcPatSynBuilderBind
   in GHC.Tc.Gen.Bind.tcValBinds.

This behaviour is implemented in 'tcValBinds', but it crucially
depends on 'P' not being put in a recursive group with 'f' (which
would make it look like a recursive pattern synonym a la 'pattern P =
P' which is unsound and rejected).

So:
 * We do not include builder fvs in the Uses returned by rnPatSynBind
   (which is then used for dependency analysis)
 * But we /do/ include them in the psb_fvs for the PatSynBind
 * In rnValBinds we record these builder uses, to avoid bogus
   unused-variable warnings (#12548)
-}

{- *********************************************************************
*                                                                      *
                Class/instance method bindings
*                                                                      *
********************************************************************* -}

{- @rnMethodBinds@ is used for the method bindings of a class and an instance
declaration.   Like @rnBinds@ but without dependency analysis.

NOTA BENE: we record each {\em binder} of a method-bind group as a free variable.
That's crucial when dealing with an instance decl:
\begin{verbatim}
        instance Foo (T a) where
           op x = ...
\end{verbatim}
This might be the {\em sole} occurrence of @op@ for an imported class @Foo@,
and unless @op@ occurs we won't treat the type signature of @op@ in the class
decl for @Foo@ as a source of instance-decl gates.  But we should!  Indeed,
in many ways the @op@ in an instance decl is just like an occurrence, not
a binder.
-}

rnMethodBinds :: Bool                   -- True <=> is a class declaration
              -> Name                   -- Class name
              -> [Name]                 -- Type variables from the class/instance header
              -> LHsBinds GhcPs         -- Binds
              -> [LSig GhcPs]           -- and signatures/pragmas
              -> RnM (LHsBinds GhcRn, [LSig GhcRn], FreeVars)
-- Used for
--   * the default method bindings in a class decl
--   * the method bindings in an instance decl
rnMethodBinds :: Bool
-> Name
-> [Name]
-> LHsBindsLR GhcPs GhcPs
-> [LSig GhcPs]
-> RnM (LHsBinds GhcRn, [LSig GhcRn], NameSet)
rnMethodBinds Bool
is_cls_decl Name
cls [Name]
ktv_names LHsBindsLR GhcPs GhcPs
binds [LSig GhcPs]
sigs
  = do { [Located RdrName] -> TcRn ()
checkDupRdrNames (LHsBindsLR GhcPs GhcPs -> [Located (IdP GhcPs)]
forall idL idR. LHsBindsLR idL idR -> [Located (IdP idL)]
collectMethodBinders LHsBindsLR GhcPs GhcPs
binds)
             -- Check that the same method is not given twice in the
             -- same instance decl      instance C T where
             --                       f x = ...
             --                       g y = ...
             --                       f x = ...
             -- We must use checkDupRdrNames because the Name of the
             -- method is the Name of the class selector, whose SrcSpan
             -- points to the class declaration; and we use rnMethodBinds
             -- for instance decls too

       -- Rename the bindings LHSs
       ; LHsBindsLR GhcRn GhcPs
binds' <- (Located (HsBindLR GhcPs GhcPs)
 -> LHsBindsLR GhcRn GhcPs
 -> IOEnv (Env TcGblEnv TcLclEnv) (LHsBindsLR GhcRn GhcPs))
-> LHsBindsLR GhcRn GhcPs
-> LHsBindsLR GhcPs GhcPs
-> IOEnv (Env TcGblEnv TcLclEnv) (LHsBindsLR GhcRn GhcPs)
forall (t :: * -> *) (m :: * -> *) a b.
(Foldable t, Monad m) =>
(a -> b -> m b) -> b -> t a -> m b
foldrM (Bool
-> Name
-> Located (HsBindLR GhcPs GhcPs)
-> LHsBindsLR GhcRn GhcPs
-> IOEnv (Env TcGblEnv TcLclEnv) (LHsBindsLR GhcRn GhcPs)
rnMethodBindLHS Bool
is_cls_decl Name
cls) LHsBindsLR GhcRn GhcPs
forall a. Bag a
emptyBag LHsBindsLR GhcPs GhcPs
binds

       -- Rename the pragmas and signatures
       -- Annoyingly the type variables /are/ in scope for signatures, but
       -- /are not/ in scope in the SPECIALISE instance pramas; e.g.
       --    instance Eq a => Eq (T a) where
       --       (==) :: a -> a -> a
       --       {-# SPECIALISE instance Eq a => Eq (T [a]) #-}
       ; let ([LSig GhcPs]
spec_inst_prags, [LSig GhcPs]
other_sigs) = (LSig GhcPs -> Bool)
-> [LSig GhcPs] -> ([LSig GhcPs], [LSig GhcPs])
forall a. (a -> Bool) -> [a] -> ([a], [a])
partition LSig GhcPs -> Bool
forall name. LSig name -> Bool
isSpecInstLSig [LSig GhcPs]
sigs
             bound_nms :: NameSet
bound_nms = [Name] -> NameSet
mkNameSet (LHsBindsLR GhcRn GhcPs -> [IdP GhcRn]
forall p idR. CollectPass p => LHsBindsLR p idR -> [IdP p]
collectHsBindsBinders LHsBindsLR GhcRn GhcPs
binds')
             sig_ctxt :: HsSigCtxt
sig_ctxt | Bool
is_cls_decl = Name -> HsSigCtxt
ClsDeclCtxt Name
cls
                      | Bool
otherwise   = NameSet -> HsSigCtxt
InstDeclCtxt NameSet
bound_nms
       ; ([LSig GhcRn]
spec_inst_prags', NameSet
sip_fvs) <- HsSigCtxt -> [LSig GhcPs] -> RnM ([LSig GhcRn], NameSet)
renameSigs HsSigCtxt
sig_ctxt [LSig GhcPs]
spec_inst_prags
       ; ([LSig GhcRn]
other_sigs',      NameSet
sig_fvs) <- [Name]
-> RnM ([LSig GhcRn], NameSet) -> RnM ([LSig GhcRn], NameSet)
forall a. [Name] -> RnM (a, NameSet) -> RnM (a, NameSet)
extendTyVarEnvFVRn [Name]
ktv_names (RnM ([LSig GhcRn], NameSet) -> RnM ([LSig GhcRn], NameSet))
-> RnM ([LSig GhcRn], NameSet) -> RnM ([LSig GhcRn], NameSet)
forall a b. (a -> b) -> a -> b
$
                                        HsSigCtxt -> [LSig GhcPs] -> RnM ([LSig GhcRn], NameSet)
renameSigs HsSigCtxt
sig_ctxt [LSig GhcPs]
other_sigs

       -- Rename the bindings RHSs.  Again there's an issue about whether the
       -- type variables from the class/instance head are in scope.
       -- Answer no in Haskell 2010, but yes if you have -XScopedTypeVariables
       ; (LHsBinds GhcRn
binds'', NameSet
bind_fvs) <- [Name]
-> RnM (LHsBinds GhcRn, NameSet) -> RnM (LHsBinds GhcRn, NameSet)
forall a. [Name] -> RnM (a, NameSet) -> RnM (a, NameSet)
bindSigTyVarsFV [Name]
ktv_names (RnM (LHsBinds GhcRn, NameSet) -> RnM (LHsBinds GhcRn, NameSet))
-> RnM (LHsBinds GhcRn, NameSet) -> RnM (LHsBinds GhcRn, NameSet)
forall a b. (a -> b) -> a -> b
$
              do { Bag (LHsBind GhcRn, [Name], NameSet)
binds_w_dus <- (GenLocated SrcSpan (HsBindLR GhcRn GhcPs)
 -> IOEnv (Env TcGblEnv TcLclEnv) (LHsBind GhcRn, [Name], NameSet))
-> LHsBindsLR GhcRn GhcPs
-> IOEnv
     (Env TcGblEnv TcLclEnv) (Bag (LHsBind GhcRn, [Name], NameSet))
forall (m :: * -> *) a b.
Monad m =>
(a -> m b) -> Bag a -> m (Bag b)
mapBagM ((Name -> [Name])
-> GenLocated SrcSpan (HsBindLR GhcRn GhcPs)
-> IOEnv (Env TcGblEnv TcLclEnv) (LHsBind GhcRn, [Name], NameSet)
rnLBind ([LSig GhcRn] -> Name -> [Name]
mkScopedTvFn [LSig GhcRn]
other_sigs')) LHsBindsLR GhcRn GhcPs
binds'
                 ; let bind_fvs :: NameSet
bind_fvs = ((LHsBind GhcRn, [Name], NameSet) -> NameSet -> NameSet)
-> NameSet -> Bag (LHsBind GhcRn, [Name], NameSet) -> NameSet
forall (t :: * -> *) a b.
Foldable t =>
(a -> b -> b) -> b -> t a -> b
foldr (\(LHsBind GhcRn
_,[Name]
_,NameSet
fv1) NameSet
fv2 -> NameSet
fv1 NameSet -> NameSet -> NameSet
`plusFV` NameSet
fv2)
                                           NameSet
emptyFVs Bag (LHsBind GhcRn, [Name], NameSet)
binds_w_dus
                 ; (LHsBinds GhcRn, NameSet) -> RnM (LHsBinds GhcRn, NameSet)
forall (m :: * -> *) a. Monad m => a -> m a
return (((LHsBind GhcRn, [Name], NameSet) -> LHsBind GhcRn)
-> Bag (LHsBind GhcRn, [Name], NameSet) -> LHsBinds GhcRn
forall a b. (a -> b) -> Bag a -> Bag b
mapBag (LHsBind GhcRn, [Name], NameSet) -> LHsBind GhcRn
forall a b c. (a, b, c) -> a
fstOf3 Bag (LHsBind GhcRn, [Name], NameSet)
binds_w_dus, NameSet
bind_fvs) }

       ; (LHsBinds GhcRn, [LSig GhcRn], NameSet)
-> RnM (LHsBinds GhcRn, [LSig GhcRn], NameSet)
forall (m :: * -> *) a. Monad m => a -> m a
return ( LHsBinds GhcRn
binds'', [LSig GhcRn]
spec_inst_prags' [LSig GhcRn] -> [LSig GhcRn] -> [LSig GhcRn]
forall a. [a] -> [a] -> [a]
++ [LSig GhcRn]
other_sigs'
                , NameSet
sig_fvs NameSet -> NameSet -> NameSet
`plusFV` NameSet
sip_fvs NameSet -> NameSet -> NameSet
`plusFV` NameSet
bind_fvs) }

rnMethodBindLHS :: Bool -> Name
                -> LHsBindLR GhcPs GhcPs
                -> LHsBindsLR GhcRn GhcPs
                -> RnM (LHsBindsLR GhcRn GhcPs)
rnMethodBindLHS :: Bool
-> Name
-> Located (HsBindLR GhcPs GhcPs)
-> LHsBindsLR GhcRn GhcPs
-> IOEnv (Env TcGblEnv TcLclEnv) (LHsBindsLR GhcRn GhcPs)
rnMethodBindLHS Bool
_ Name
cls (L SrcSpan
loc bind :: HsBindLR GhcPs GhcPs
bind@(FunBind { fun_id :: forall idL idR. HsBindLR idL idR -> Located (IdP idL)
fun_id = Located (IdP GhcPs)
name })) LHsBindsLR GhcRn GhcPs
rest
  = SrcSpan
-> IOEnv (Env TcGblEnv TcLclEnv) (LHsBindsLR GhcRn GhcPs)
-> IOEnv (Env TcGblEnv TcLclEnv) (LHsBindsLR GhcRn GhcPs)
forall a. SrcSpan -> TcRn a -> TcRn a
setSrcSpan SrcSpan
loc (IOEnv (Env TcGblEnv TcLclEnv) (LHsBindsLR GhcRn GhcPs)
 -> IOEnv (Env TcGblEnv TcLclEnv) (LHsBindsLR GhcRn GhcPs))
-> IOEnv (Env TcGblEnv TcLclEnv) (LHsBindsLR GhcRn GhcPs)
-> IOEnv (Env TcGblEnv TcLclEnv) (LHsBindsLR GhcRn GhcPs)
forall a b. (a -> b) -> a -> b
$ do
    do { Located Name
sel_name <- (RdrName -> TcM Name) -> Located RdrName -> RnM (Located Name)
forall a b. (a -> TcM b) -> Located a -> TcM (Located b)
wrapLocM (Name -> MsgDoc -> RdrName -> TcM Name
lookupInstDeclBndr Name
cls (String -> MsgDoc
text String
"method")) Located RdrName
Located (IdP GhcPs)
name
                     -- We use the selector name as the binder
       ; let bind' :: HsBindLR GhcRn GhcPs
bind' = HsBindLR GhcPs GhcPs
bind { fun_id :: Located (IdP GhcRn)
fun_id = Located Name
Located (IdP GhcRn)
sel_name, fun_ext :: XFunBind GhcRn GhcPs
fun_ext = NoExtField
XFunBind GhcRn GhcPs
noExtField }
       ; LHsBindsLR GhcRn GhcPs
-> IOEnv (Env TcGblEnv TcLclEnv) (LHsBindsLR GhcRn GhcPs)
forall (m :: * -> *) a. Monad m => a -> m a
return (SrcSpan
-> HsBindLR GhcRn GhcPs
-> GenLocated SrcSpan (HsBindLR GhcRn GhcPs)
forall l e. l -> e -> GenLocated l e
L SrcSpan
loc HsBindLR GhcRn GhcPs
bind' GenLocated SrcSpan (HsBindLR GhcRn GhcPs)
-> LHsBindsLR GhcRn GhcPs -> LHsBindsLR GhcRn GhcPs
forall a. a -> Bag a -> Bag a
`consBag` LHsBindsLR GhcRn GhcPs
rest ) }

-- Report error for all other forms of bindings
-- This is why we use a fold rather than map
rnMethodBindLHS Bool
is_cls_decl Name
_ (L SrcSpan
loc HsBindLR GhcPs GhcPs
bind) LHsBindsLR GhcRn GhcPs
rest
  = do { SrcSpan -> MsgDoc -> TcRn ()
addErrAt SrcSpan
loc (MsgDoc -> TcRn ()) -> MsgDoc -> TcRn ()
forall a b. (a -> b) -> a -> b
$
         [MsgDoc] -> MsgDoc
vcat [ MsgDoc
what MsgDoc -> MsgDoc -> MsgDoc
<+> String -> MsgDoc
text String
"not allowed in" MsgDoc -> MsgDoc -> MsgDoc
<+> MsgDoc
decl_sort
              , Int -> MsgDoc -> MsgDoc
nest Int
2 (HsBindLR GhcPs GhcPs -> MsgDoc
forall a. Outputable a => a -> MsgDoc
ppr HsBindLR GhcPs GhcPs
bind) ]
       ; LHsBindsLR GhcRn GhcPs
-> IOEnv (Env TcGblEnv TcLclEnv) (LHsBindsLR GhcRn GhcPs)
forall (m :: * -> *) a. Monad m => a -> m a
return LHsBindsLR GhcRn GhcPs
rest }
  where
    decl_sort :: MsgDoc
decl_sort | Bool
is_cls_decl = String -> MsgDoc
text String
"class declaration:"
              | Bool
otherwise   = String -> MsgDoc
text String
"instance declaration:"
    what :: MsgDoc
what = case HsBindLR GhcPs GhcPs
bind of
              PatBind {}    -> String -> MsgDoc
text String
"Pattern bindings (except simple variables)"
              PatSynBind {} -> String -> MsgDoc
text String
"Pattern synonyms"
                               -- Associated pattern synonyms are not implemented yet
              HsBindLR GhcPs GhcPs
_ -> String -> MsgDoc -> MsgDoc
forall a. HasCallStack => String -> MsgDoc -> a
pprPanic String
"rnMethodBind" (HsBindLR GhcPs GhcPs -> MsgDoc
forall a. Outputable a => a -> MsgDoc
ppr HsBindLR GhcPs GhcPs
bind)

{-
************************************************************************
*                                                                      *
\subsubsection[dep-Sigs]{Signatures (and user-pragmas for values)}
*                                                                      *
************************************************************************

@renameSigs@ checks for:
\begin{enumerate}
\item more than one sig for one thing;
\item signatures given for things not bound here;
\end{enumerate}

At the moment we don't gather free-var info from the types in
signatures.  We'd only need this if we wanted to report unused tyvars.
-}

renameSigs :: HsSigCtxt
           -> [LSig GhcPs]
           -> RnM ([LSig GhcRn], FreeVars)
-- Renames the signatures and performs error checks
renameSigs :: HsSigCtxt -> [LSig GhcPs] -> RnM ([LSig GhcRn], NameSet)
renameSigs HsSigCtxt
ctxt [LSig GhcPs]
sigs
  = do  { (NonEmpty (Located RdrName, Sig GhcPs) -> TcRn ())
-> [NonEmpty (Located RdrName, Sig GhcPs)] -> TcRn ()
forall (t :: * -> *) (m :: * -> *) a b.
(Foldable t, Monad m) =>
(a -> m b) -> t a -> m ()
mapM_ NonEmpty (Located RdrName, Sig GhcPs) -> TcRn ()
dupSigDeclErr ([LSig GhcPs] -> [NonEmpty (Located RdrName, Sig GhcPs)]
findDupSigs [LSig GhcPs]
sigs)

        ; [LSig GhcPs] -> TcRn ()
checkDupMinimalSigs [LSig GhcPs]
sigs

        ; ([LSig GhcRn]
sigs', NameSet
sig_fvs) <- (LSig GhcPs -> RnM (LSig GhcRn, NameSet))
-> [LSig GhcPs] -> RnM ([LSig GhcRn], NameSet)
forall a b. (a -> RnM (b, NameSet)) -> [a] -> RnM ([b], NameSet)
mapFvRn ((Sig GhcPs -> TcM (Sig GhcRn, NameSet))
-> LSig GhcPs -> RnM (LSig GhcRn, NameSet)
forall a b c. (a -> TcM (b, c)) -> Located a -> TcM (Located b, c)
wrapLocFstM (HsSigCtxt -> Sig GhcPs -> TcM (Sig GhcRn, NameSet)
renameSig HsSigCtxt
ctxt)) [LSig GhcPs]
sigs

        ; let ([LSig GhcRn]
good_sigs, [LSig GhcRn]
bad_sigs) = (LSig GhcRn -> Bool)
-> [LSig GhcRn] -> ([LSig GhcRn], [LSig GhcRn])
forall a. (a -> Bool) -> [a] -> ([a], [a])
partition (HsSigCtxt -> LSig GhcRn -> Bool
forall (a :: Pass). HsSigCtxt -> LSig (GhcPass a) -> Bool
okHsSig HsSigCtxt
ctxt) [LSig GhcRn]
sigs'
        ; (LSig GhcRn -> TcRn ()) -> [LSig GhcRn] -> TcRn ()
forall (t :: * -> *) (m :: * -> *) a b.
(Foldable t, Monad m) =>
(a -> m b) -> t a -> m ()
mapM_ LSig GhcRn -> TcRn ()
misplacedSigErr [LSig GhcRn]
bad_sigs                 -- Misplaced

        ; ([LSig GhcRn], NameSet) -> RnM ([LSig GhcRn], NameSet)
forall (m :: * -> *) a. Monad m => a -> m a
return ([LSig GhcRn]
good_sigs, NameSet
sig_fvs) }

----------------------
-- We use lookupSigOccRn in the signatures, which is a little bit unsatisfactory
-- because this won't work for:
--      instance Foo T where
--        {-# INLINE op #-}
--        Baz.op = ...
-- We'll just rename the INLINE prag to refer to whatever other 'op'
-- is in scope.  (I'm assuming that Baz.op isn't in scope unqualified.)
-- Doesn't seem worth much trouble to sort this.

renameSig :: HsSigCtxt -> Sig GhcPs -> RnM (Sig GhcRn, FreeVars)
renameSig :: HsSigCtxt -> Sig GhcPs -> TcM (Sig GhcRn, NameSet)
renameSig HsSigCtxt
_ (IdSig XIdSig GhcPs
_ Id
x)
  = (Sig GhcRn, NameSet) -> TcM (Sig GhcRn, NameSet)
forall (m :: * -> *) a. Monad m => a -> m a
return (XIdSig GhcRn -> Id -> Sig GhcRn
forall pass. XIdSig pass -> Id -> Sig pass
IdSig NoExtField
XIdSig GhcRn
noExtField Id
x, NameSet
emptyFVs)    -- Actually this never occurs

renameSig HsSigCtxt
ctxt sig :: Sig GhcPs
sig@(TypeSig XTypeSig GhcPs
_ [Located (IdP GhcPs)]
vs LHsSigWcType GhcPs
ty)
  = do  { [Located Name]
new_vs <- (Located RdrName -> RnM (Located Name))
-> [Located RdrName]
-> IOEnv (Env TcGblEnv TcLclEnv) [Located Name]
forall (t :: * -> *) (m :: * -> *) a b.
(Traversable t, Monad m) =>
(a -> m b) -> t a -> m (t b)
mapM (HsSigCtxt -> Sig GhcPs -> Located RdrName -> RnM (Located Name)
lookupSigOccRn HsSigCtxt
ctxt Sig GhcPs
sig) [Located RdrName]
[Located (IdP GhcPs)]
vs
        ; let doc :: HsDocContext
doc = MsgDoc -> HsDocContext
TypeSigCtx ([Located RdrName] -> MsgDoc
ppr_sig_bndrs [Located RdrName]
[Located (IdP GhcPs)]
vs)
        ; (LHsSigWcType GhcRn
new_ty, NameSet
fvs) <- HsDocContext
-> LHsSigWcType GhcPs -> RnM (LHsSigWcType GhcRn, NameSet)
rnHsSigWcType HsDocContext
doc LHsSigWcType GhcPs
ty
        ; (Sig GhcRn, NameSet) -> TcM (Sig GhcRn, NameSet)
forall (m :: * -> *) a. Monad m => a -> m a
return (XTypeSig GhcRn
-> [Located (IdP GhcRn)] -> LHsSigWcType GhcRn -> Sig GhcRn
forall pass.
XTypeSig pass
-> [Located (IdP pass)] -> LHsSigWcType pass -> Sig pass
TypeSig NoExtField
XTypeSig GhcRn
noExtField [Located Name]
[Located (IdP GhcRn)]
new_vs LHsSigWcType GhcRn
new_ty, NameSet
fvs) }

renameSig HsSigCtxt
ctxt sig :: Sig GhcPs
sig@(ClassOpSig XClassOpSig GhcPs
_ Bool
is_deflt [Located (IdP GhcPs)]
vs LHsSigType GhcPs
ty)
  = do  { Bool
defaultSigs_on <- Extension -> TcRnIf TcGblEnv TcLclEnv Bool
forall gbl lcl. Extension -> TcRnIf gbl lcl Bool
xoptM Extension
LangExt.DefaultSignatures
        ; Bool -> TcRn () -> TcRn ()
forall (f :: * -> *). Applicative f => Bool -> f () -> f ()
when (Bool
is_deflt Bool -> Bool -> Bool
&& Bool -> Bool
not Bool
defaultSigs_on) (TcRn () -> TcRn ()) -> TcRn () -> TcRn ()
forall a b. (a -> b) -> a -> b
$
          MsgDoc -> TcRn ()
addErr (Sig GhcPs -> MsgDoc
defaultSigErr Sig GhcPs
sig)
        ; [Located Name]
new_v <- (Located RdrName -> RnM (Located Name))
-> [Located RdrName]
-> IOEnv (Env TcGblEnv TcLclEnv) [Located Name]
forall (t :: * -> *) (m :: * -> *) a b.
(Traversable t, Monad m) =>
(a -> m b) -> t a -> m (t b)
mapM (HsSigCtxt -> Sig GhcPs -> Located RdrName -> RnM (Located Name)
lookupSigOccRn HsSigCtxt
ctxt Sig GhcPs
sig) [Located RdrName]
[Located (IdP GhcPs)]
vs
        ; (LHsSigType GhcRn
new_ty, NameSet
fvs) <- HsDocContext
-> TypeOrKind
-> LHsSigType GhcPs
-> RnM (LHsSigType GhcRn, NameSet)
rnHsSigType HsDocContext
ty_ctxt TypeOrKind
TypeLevel LHsSigType GhcPs
ty
        ; (Sig GhcRn, NameSet) -> TcM (Sig GhcRn, NameSet)
forall (m :: * -> *) a. Monad m => a -> m a
return (XClassOpSig GhcRn
-> Bool -> [Located (IdP GhcRn)] -> LHsSigType GhcRn -> Sig GhcRn
forall pass.
XClassOpSig pass
-> Bool -> [Located (IdP pass)] -> LHsSigType pass -> Sig pass
ClassOpSig NoExtField
XClassOpSig GhcRn
noExtField Bool
is_deflt [Located Name]
[Located (IdP GhcRn)]
new_v LHsSigType GhcRn
new_ty, NameSet
fvs) }
  where
    (Located RdrName
v1:[Located RdrName]
_) = [Located RdrName]
[Located (IdP GhcPs)]
vs
    ty_ctxt :: HsDocContext
ty_ctxt = MsgDoc -> HsDocContext
GenericCtx (String -> MsgDoc
text String
"a class method signature for"
                          MsgDoc -> MsgDoc -> MsgDoc
<+> MsgDoc -> MsgDoc
quotes (Located RdrName -> MsgDoc
forall a. Outputable a => a -> MsgDoc
ppr Located RdrName
v1))

renameSig HsSigCtxt
_ (SpecInstSig XSpecInstSig GhcPs
_ SourceText
src LHsSigType GhcPs
ty)
  = do  { HsDocContext -> Maybe MsgDoc -> LHsSigType GhcPs -> TcRn ()
checkInferredVars HsDocContext
doc Maybe MsgDoc
inf_msg LHsSigType GhcPs
ty
        ; (LHsSigType GhcRn
new_ty, NameSet
fvs) <- HsDocContext
-> TypeOrKind
-> LHsSigType GhcPs
-> RnM (LHsSigType GhcRn, NameSet)
rnHsSigType HsDocContext
doc TypeOrKind
TypeLevel LHsSigType GhcPs
ty
          -- Check if there are any nested `forall`s or contexts, which are
          -- illegal in the type of an instance declaration (see
          -- Note [No nested foralls or contexts in instance types] in
          -- GHC.Hs.Type).
        ; HsDocContext -> MsgDoc -> LHsType GhcRn -> TcRn ()
addNoNestedForallsContextsErr HsDocContext
doc (String -> MsgDoc
text String
"SPECIALISE instance type")
            (LHsSigType GhcRn -> LHsType GhcRn
forall (p :: Pass). LHsSigType (GhcPass p) -> LHsType (GhcPass p)
getLHsInstDeclHead LHsSigType GhcRn
new_ty)
        ; (Sig GhcRn, NameSet) -> TcM (Sig GhcRn, NameSet)
forall (m :: * -> *) a. Monad m => a -> m a
return (XSpecInstSig GhcRn -> SourceText -> LHsSigType GhcRn -> Sig GhcRn
forall pass.
XSpecInstSig pass -> SourceText -> LHsSigType pass -> Sig pass
SpecInstSig NoExtField
XSpecInstSig GhcRn
noExtField SourceText
src LHsSigType GhcRn
new_ty,NameSet
fvs) }
  where
    doc :: HsDocContext
doc = HsDocContext
SpecInstSigCtx
    inf_msg :: Maybe MsgDoc
inf_msg = MsgDoc -> Maybe MsgDoc
forall a. a -> Maybe a
Just (String -> MsgDoc
text String
"Inferred type variables are not allowed")

-- {-# SPECIALISE #-} pragmas can refer to imported Ids
-- so, in the top-level case (when mb_names is Nothing)
-- we use lookupOccRn.  If there's both an imported and a local 'f'
-- then the SPECIALISE pragma is ambiguous, unlike all other signatures
renameSig HsSigCtxt
ctxt sig :: Sig GhcPs
sig@(SpecSig XSpecSig GhcPs
_ Located (IdP GhcPs)
v [LHsSigType GhcPs]
tys InlinePragma
inl)
  = do  { Located Name
new_v <- case HsSigCtxt
ctxt of
                     TopSigCtxt {} -> Located RdrName -> RnM (Located Name)
lookupLocatedOccRn Located RdrName
Located (IdP GhcPs)
v
                     HsSigCtxt
_             -> HsSigCtxt -> Sig GhcPs -> Located RdrName -> RnM (Located Name)
lookupSigOccRn HsSigCtxt
ctxt Sig GhcPs
sig Located RdrName
Located (IdP GhcPs)
v
        ; ([LHsSigType GhcRn]
new_ty, NameSet
fvs) <- (([LHsSigType GhcRn], NameSet)
 -> LHsSigType GhcPs
 -> IOEnv (Env TcGblEnv TcLclEnv) ([LHsSigType GhcRn], NameSet))
-> ([LHsSigType GhcRn], NameSet)
-> [LHsSigType GhcPs]
-> IOEnv (Env TcGblEnv TcLclEnv) ([LHsSigType GhcRn], NameSet)
forall (t :: * -> *) (m :: * -> *) b a.
(Foldable t, Monad m) =>
(b -> a -> m b) -> b -> t a -> m b
foldM ([LHsSigType GhcRn], NameSet)
-> LHsSigType GhcPs
-> IOEnv (Env TcGblEnv TcLclEnv) ([LHsSigType GhcRn], NameSet)
do_one ([],NameSet
emptyFVs) [LHsSigType GhcPs]
tys
        ; (Sig GhcRn, NameSet) -> TcM (Sig GhcRn, NameSet)
forall (m :: * -> *) a. Monad m => a -> m a
return (XSpecSig GhcRn
-> Located (IdP GhcRn)
-> [LHsSigType GhcRn]
-> InlinePragma
-> Sig GhcRn
forall pass.
XSpecSig pass
-> Located (IdP pass)
-> [LHsSigType pass]
-> InlinePragma
-> Sig pass
SpecSig NoExtField
XSpecSig GhcRn
noExtField Located Name
Located (IdP GhcRn)
new_v [LHsSigType GhcRn]
new_ty InlinePragma
inl, NameSet
fvs) }
  where
    ty_ctxt :: HsDocContext
ty_ctxt = MsgDoc -> HsDocContext
GenericCtx (String -> MsgDoc
text String
"a SPECIALISE signature for"
                          MsgDoc -> MsgDoc -> MsgDoc
<+> MsgDoc -> MsgDoc
quotes (Located RdrName -> MsgDoc
forall a. Outputable a => a -> MsgDoc
ppr Located RdrName
Located (IdP GhcPs)
v))
    do_one :: ([LHsSigType GhcRn], NameSet)
-> LHsSigType GhcPs
-> IOEnv (Env TcGblEnv TcLclEnv) ([LHsSigType GhcRn], NameSet)
do_one ([LHsSigType GhcRn]
tys,NameSet
fvs) LHsSigType GhcPs
ty
      = do { (LHsSigType GhcRn
new_ty, NameSet
fvs_ty) <- HsDocContext
-> TypeOrKind
-> LHsSigType GhcPs
-> RnM (LHsSigType GhcRn, NameSet)
rnHsSigType HsDocContext
ty_ctxt TypeOrKind
TypeLevel LHsSigType GhcPs
ty
           ; ([LHsSigType GhcRn], NameSet)
-> IOEnv (Env TcGblEnv TcLclEnv) ([LHsSigType GhcRn], NameSet)
forall (m :: * -> *) a. Monad m => a -> m a
return ( LHsSigType GhcRn
new_tyLHsSigType GhcRn -> [LHsSigType GhcRn] -> [LHsSigType GhcRn]
forall a. a -> [a] -> [a]
:[LHsSigType GhcRn]
tys, NameSet
fvs_ty NameSet -> NameSet -> NameSet
`plusFV` NameSet
fvs) }

renameSig HsSigCtxt
ctxt sig :: Sig GhcPs
sig@(InlineSig XInlineSig GhcPs
_ Located (IdP GhcPs)
v InlinePragma
s)
  = do  { Located Name
new_v <- HsSigCtxt -> Sig GhcPs -> Located RdrName -> RnM (Located Name)
lookupSigOccRn HsSigCtxt
ctxt Sig GhcPs
sig Located RdrName
Located (IdP GhcPs)
v
        ; (Sig GhcRn, NameSet) -> TcM (Sig GhcRn, NameSet)
forall (m :: * -> *) a. Monad m => a -> m a
return (XInlineSig GhcRn
-> Located (IdP GhcRn) -> InlinePragma -> Sig GhcRn
forall pass.
XInlineSig pass -> Located (IdP pass) -> InlinePragma -> Sig pass
InlineSig NoExtField
XInlineSig GhcRn
noExtField Located Name
Located (IdP GhcRn)
new_v InlinePragma
s, NameSet
emptyFVs) }

renameSig HsSigCtxt
ctxt (FixSig XFixSig GhcPs
_ FixitySig GhcPs
fsig)
  = do  { FixitySig GhcRn
new_fsig <- HsSigCtxt -> FixitySig GhcPs -> RnM (FixitySig GhcRn)
rnSrcFixityDecl HsSigCtxt
ctxt FixitySig GhcPs
fsig
        ; (Sig GhcRn, NameSet) -> TcM (Sig GhcRn, NameSet)
forall (m :: * -> *) a. Monad m => a -> m a
return (XFixSig GhcRn -> FixitySig GhcRn -> Sig GhcRn
forall pass. XFixSig pass -> FixitySig pass -> Sig pass
FixSig NoExtField
XFixSig GhcRn
noExtField FixitySig GhcRn
new_fsig, NameSet
emptyFVs) }

renameSig HsSigCtxt
ctxt sig :: Sig GhcPs
sig@(MinimalSig XMinimalSig GhcPs
_ SourceText
s (L SrcSpan
l BooleanFormula (Located (IdP GhcPs))
bf))
  = do BooleanFormula (Located Name)
new_bf <- (Located RdrName -> RnM (Located Name))
-> BooleanFormula (Located RdrName)
-> IOEnv (Env TcGblEnv TcLclEnv) (BooleanFormula (Located Name))
forall (t :: * -> *) (f :: * -> *) a b.
(Traversable t, Applicative f) =>
(a -> f b) -> t a -> f (t b)
traverse (HsSigCtxt -> Sig GhcPs -> Located RdrName -> RnM (Located Name)
lookupSigOccRn HsSigCtxt
ctxt Sig GhcPs
sig) BooleanFormula (Located RdrName)
BooleanFormula (Located (IdP GhcPs))
bf
       (Sig GhcRn, NameSet) -> TcM (Sig GhcRn, NameSet)
forall (m :: * -> *) a. Monad m => a -> m a
return (XMinimalSig GhcRn
-> SourceText -> LBooleanFormula (Located (IdP GhcRn)) -> Sig GhcRn
forall pass.
XMinimalSig pass
-> SourceText -> LBooleanFormula (Located (IdP pass)) -> Sig pass
MinimalSig NoExtField
XMinimalSig GhcRn
noExtField SourceText
s (SrcSpan
-> BooleanFormula (Located Name)
-> GenLocated SrcSpan (BooleanFormula (Located Name))
forall l e. l -> e -> GenLocated l e
L SrcSpan
l BooleanFormula (Located Name)
new_bf), NameSet
emptyFVs)

renameSig HsSigCtxt
ctxt sig :: Sig GhcPs
sig@(PatSynSig XPatSynSig GhcPs
_ [Located (IdP GhcPs)]
vs LHsSigType GhcPs
ty)
  = do  { [Located Name]
new_vs <- (Located RdrName -> RnM (Located Name))
-> [Located RdrName]
-> IOEnv (Env TcGblEnv TcLclEnv) [Located Name]
forall (t :: * -> *) (m :: * -> *) a b.
(Traversable t, Monad m) =>
(a -> m b) -> t a -> m (t b)
mapM (HsSigCtxt -> Sig GhcPs -> Located RdrName -> RnM (Located Name)
lookupSigOccRn HsSigCtxt
ctxt Sig GhcPs
sig) [Located RdrName]
[Located (IdP GhcPs)]
vs
        ; (LHsSigType GhcRn
ty', NameSet
fvs) <- HsDocContext
-> TypeOrKind
-> LHsSigType GhcPs
-> RnM (LHsSigType GhcRn, NameSet)
rnHsSigType HsDocContext
ty_ctxt TypeOrKind
TypeLevel LHsSigType GhcPs
ty
        ; (Sig GhcRn, NameSet) -> TcM (Sig GhcRn, NameSet)
forall (m :: * -> *) a. Monad m => a -> m a
return (XPatSynSig GhcRn
-> [Located (IdP GhcRn)] -> LHsSigType GhcRn -> Sig GhcRn
forall pass.
XPatSynSig pass
-> [Located (IdP pass)] -> LHsSigType pass -> Sig pass
PatSynSig NoExtField
XPatSynSig GhcRn
noExtField [Located Name]
[Located (IdP GhcRn)]
new_vs LHsSigType GhcRn
ty', NameSet
fvs) }
  where
    ty_ctxt :: HsDocContext
ty_ctxt = MsgDoc -> HsDocContext
GenericCtx (String -> MsgDoc
text String
"a pattern synonym signature for"
                          MsgDoc -> MsgDoc -> MsgDoc
<+> [Located RdrName] -> MsgDoc
ppr_sig_bndrs [Located RdrName]
[Located (IdP GhcPs)]
vs)

renameSig HsSigCtxt
ctxt sig :: Sig GhcPs
sig@(SCCFunSig XSCCFunSig GhcPs
_ SourceText
st Located (IdP GhcPs)
v Maybe (Located StringLiteral)
s)
  = do  { Located Name
new_v <- HsSigCtxt -> Sig GhcPs -> Located RdrName -> RnM (Located Name)
lookupSigOccRn HsSigCtxt
ctxt Sig GhcPs
sig Located RdrName
Located (IdP GhcPs)
v
        ; (Sig GhcRn, NameSet) -> TcM (Sig GhcRn, NameSet)
forall (m :: * -> *) a. Monad m => a -> m a
return (XSCCFunSig GhcRn
-> SourceText
-> Located (IdP GhcRn)
-> Maybe (Located StringLiteral)
-> Sig GhcRn
forall pass.
XSCCFunSig pass
-> SourceText
-> Located (IdP pass)
-> Maybe (Located StringLiteral)
-> Sig pass
SCCFunSig NoExtField
XSCCFunSig GhcRn
noExtField SourceText
st Located Name
Located (IdP GhcRn)
new_v Maybe (Located StringLiteral)
s, NameSet
emptyFVs) }

-- COMPLETE Sigs can refer to imported IDs which is why we use
-- lookupLocatedOccRn rather than lookupSigOccRn
renameSig HsSigCtxt
_ctxt sig :: Sig GhcPs
sig@(CompleteMatchSig XCompleteMatchSig GhcPs
_ SourceText
s (L SrcSpan
l [Located (IdP GhcPs)]
bf) Maybe (Located (IdP GhcPs))
mty)
  = do [Located Name]
new_bf <- (Located RdrName -> RnM (Located Name))
-> [Located RdrName]
-> IOEnv (Env TcGblEnv TcLclEnv) [Located Name]
forall (t :: * -> *) (f :: * -> *) a b.
(Traversable t, Applicative f) =>
(a -> f b) -> t a -> f (t b)
traverse Located RdrName -> RnM (Located Name)
lookupLocatedOccRn [Located RdrName]
[Located (IdP GhcPs)]
bf
       Maybe (Located Name)
new_mty  <- (Located RdrName -> RnM (Located Name))
-> Maybe (Located RdrName)
-> IOEnv (Env TcGblEnv TcLclEnv) (Maybe (Located Name))
forall (t :: * -> *) (f :: * -> *) a b.
(Traversable t, Applicative f) =>
(a -> f b) -> t a -> f (t b)
traverse Located RdrName -> RnM (Located Name)
lookupLocatedOccRn Maybe (Located RdrName)
Maybe (Located (IdP GhcPs))
mty

       Module
this_mod <- (TcGblEnv -> Module)
-> IOEnv (Env TcGblEnv TcLclEnv) TcGblEnv
-> IOEnv (Env TcGblEnv TcLclEnv) Module
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap TcGblEnv -> Module
tcg_mod IOEnv (Env TcGblEnv TcLclEnv) TcGblEnv
forall gbl lcl. TcRnIf gbl lcl gbl
getGblEnv
       Bool -> TcRn () -> TcRn ()
forall (f :: * -> *). Applicative f => Bool -> f () -> f ()
unless ((Located Name -> Bool) -> [Located Name] -> Bool
forall (t :: * -> *) a. Foldable t => (a -> Bool) -> t a -> Bool
any (Module -> Name -> Bool
nameIsLocalOrFrom Module
this_mod (Name -> Bool) -> (Located Name -> Name) -> Located Name -> Bool
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Located Name -> Name
forall l e. GenLocated l e -> e
unLoc) [Located Name]
new_bf) (TcRn () -> TcRn ()) -> TcRn () -> TcRn ()
forall a b. (a -> b) -> a -> b
$ do
         -- Why 'any'? See Note [Orphan COMPLETE pragmas]
         MsgDoc -> TcRn () -> TcRn ()
forall a. MsgDoc -> TcM a -> TcM a
addErrCtxt (String -> MsgDoc
text String
"In" MsgDoc -> MsgDoc -> MsgDoc
<+> Sig GhcPs -> MsgDoc
forall a. Outputable a => a -> MsgDoc
ppr Sig GhcPs
sig) (TcRn () -> TcRn ()) -> TcRn () -> TcRn ()
forall a b. (a -> b) -> a -> b
$ MsgDoc -> TcRn ()
forall a. MsgDoc -> TcM a
failWithTc MsgDoc
orphanError

       (Sig GhcRn, NameSet) -> TcM (Sig GhcRn, NameSet)
forall (m :: * -> *) a. Monad m => a -> m a
return (XCompleteMatchSig GhcRn
-> SourceText
-> Located [Located (IdP GhcRn)]
-> Maybe (Located (IdP GhcRn))
-> Sig GhcRn
forall pass.
XCompleteMatchSig pass
-> SourceText
-> Located [Located (IdP pass)]
-> Maybe (Located (IdP pass))
-> Sig pass
CompleteMatchSig NoExtField
XCompleteMatchSig GhcRn
noExtField SourceText
s (SrcSpan -> [Located Name] -> GenLocated SrcSpan [Located Name]
forall l e. l -> e -> GenLocated l e
L SrcSpan
l [Located Name]
new_bf) Maybe (Located Name)
Maybe (Located (IdP GhcRn))
new_mty, NameSet
emptyFVs)
  where
    orphanError :: SDoc
    orphanError :: MsgDoc
orphanError =
      String -> MsgDoc
text String
"Orphan COMPLETE pragmas not supported" MsgDoc -> MsgDoc -> MsgDoc
$$
      String -> MsgDoc
text String
"A COMPLETE pragma must mention at least one data constructor" MsgDoc -> MsgDoc -> MsgDoc
$$
      String -> MsgDoc
text String
"or pattern synonym defined in the same module."

{-
Note [Orphan COMPLETE pragmas]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
We define a COMPLETE pragma to be a non-orphan if it includes at least
one conlike defined in the current module. Why is this sufficient?
Well if you have a pattern match

  case expr of
    P1 -> ...
    P2 -> ...
    P3 -> ...

any COMPLETE pragma which mentions a conlike other than P1, P2 or P3
will not be of any use in verifying that the pattern match is
exhaustive. So as we have certainly read the interface files that
define P1, P2 and P3, we will have loaded all non-orphan COMPLETE
pragmas that could be relevant to this pattern match.

For now we simply disallow orphan COMPLETE pragmas, as the added
complexity of supporting them properly doesn't seem worthwhile.
-}

ppr_sig_bndrs :: [Located RdrName] -> SDoc
ppr_sig_bndrs :: [Located RdrName] -> MsgDoc
ppr_sig_bndrs [Located RdrName]
bs = MsgDoc -> MsgDoc
quotes ((Located RdrName -> MsgDoc) -> [Located RdrName] -> MsgDoc
forall a. (a -> MsgDoc) -> [a] -> MsgDoc
pprWithCommas Located RdrName -> MsgDoc
forall a. Outputable a => a -> MsgDoc
ppr [Located RdrName]
bs)

okHsSig :: HsSigCtxt -> LSig (GhcPass a) -> Bool
okHsSig :: forall (a :: Pass). HsSigCtxt -> LSig (GhcPass a) -> Bool
okHsSig HsSigCtxt
ctxt (L SrcSpan
_ Sig (GhcPass a)
sig)
  = case (Sig (GhcPass a)
sig, HsSigCtxt
ctxt) of
     (ClassOpSig {}, ClsDeclCtxt {})  -> Bool
True
     (ClassOpSig {}, InstDeclCtxt {}) -> Bool
True
     (ClassOpSig {}, HsSigCtxt
_)               -> Bool
False

     (TypeSig {}, ClsDeclCtxt {})  -> Bool
False
     (TypeSig {}, InstDeclCtxt {}) -> Bool
False
     (TypeSig {}, HsSigCtxt
_)               -> Bool
True

     (PatSynSig {}, TopSigCtxt{}) -> Bool
True
     (PatSynSig {}, HsSigCtxt
_)            -> Bool
False

     (FixSig {}, InstDeclCtxt {}) -> Bool
False
     (FixSig {}, HsSigCtxt
_)               -> Bool
True

     (IdSig {}, TopSigCtxt {})   -> Bool
True
     (IdSig {}, InstDeclCtxt {}) -> Bool
True
     (IdSig {}, HsSigCtxt
_)               -> Bool
False

     (InlineSig {}, HsBootCtxt {}) -> Bool
False
     (InlineSig {}, HsSigCtxt
_)             -> Bool
True

     (SpecSig {}, TopSigCtxt {})    -> Bool
True
     (SpecSig {}, LocalBindCtxt {}) -> Bool
True
     (SpecSig {}, InstDeclCtxt {})  -> Bool
True
     (SpecSig {}, HsSigCtxt
_)                -> Bool
False

     (SpecInstSig {}, InstDeclCtxt {}) -> Bool
True
     (SpecInstSig {}, HsSigCtxt
_)               -> Bool
False

     (MinimalSig {}, ClsDeclCtxt {}) -> Bool
True
     (MinimalSig {}, HsSigCtxt
_)              -> Bool
False

     (SCCFunSig {}, HsBootCtxt {}) -> Bool
False
     (SCCFunSig {}, HsSigCtxt
_)             -> Bool
True

     (CompleteMatchSig {}, TopSigCtxt {} ) -> Bool
True
     (CompleteMatchSig {}, HsSigCtxt
_)              -> Bool
False

-------------------
findDupSigs :: [LSig GhcPs] -> [NonEmpty (Located RdrName, Sig GhcPs)]
-- Check for duplicates on RdrName version,
-- because renamed version has unboundName for
-- not-in-scope binders, which gives bogus dup-sig errors
-- NB: in a class decl, a 'generic' sig is not considered
--     equal to an ordinary sig, so we allow, say
--           class C a where
--             op :: a -> a
--             default op :: Eq a => a -> a
findDupSigs :: [LSig GhcPs] -> [NonEmpty (Located RdrName, Sig GhcPs)]
findDupSigs [LSig GhcPs]
sigs
  = ((Located RdrName, Sig GhcPs)
 -> (Located RdrName, Sig GhcPs) -> Bool)
-> [(Located RdrName, Sig GhcPs)]
-> [NonEmpty (Located RdrName, Sig GhcPs)]
forall a. (a -> a -> Bool) -> [a] -> [NonEmpty a]
findDupsEq (Located RdrName, Sig GhcPs)
-> (Located RdrName, Sig GhcPs) -> Bool
forall {a} {l} {pass} {l} {pass}.
Eq a =>
(GenLocated l a, Sig pass) -> (GenLocated l a, Sig pass) -> Bool
matching_sig ((LSig GhcPs -> [(Located RdrName, Sig GhcPs)])
-> [LSig GhcPs] -> [(Located RdrName, Sig GhcPs)]
forall (t :: * -> *) a b. Foldable t => (a -> [b]) -> t a -> [b]
concatMap (Sig GhcPs -> [(Located RdrName, Sig GhcPs)]
forall {pass}. Sig pass -> [(Located (IdP pass), Sig pass)]
expand_sig (Sig GhcPs -> [(Located RdrName, Sig GhcPs)])
-> (LSig GhcPs -> Sig GhcPs)
-> LSig GhcPs
-> [(Located RdrName, Sig GhcPs)]
forall b c a. (b -> c) -> (a -> b) -> a -> c
. LSig GhcPs -> Sig GhcPs
forall l e. GenLocated l e -> e
unLoc) [LSig GhcPs]
sigs)
  where
    expand_sig :: Sig pass -> [(Located (IdP pass), Sig pass)]
expand_sig sig :: Sig pass
sig@(FixSig XFixSig pass
_ (FixitySig XFixitySig pass
_ [Located (IdP pass)]
ns Fixity
_)) = [Located (IdP pass)]
-> [Sig pass] -> [(Located (IdP pass), Sig pass)]
forall a b. [a] -> [b] -> [(a, b)]
zip [Located (IdP pass)]
ns (Sig pass -> [Sig pass]
forall a. a -> [a]
repeat Sig pass
sig)
    expand_sig sig :: Sig pass
sig@(InlineSig XInlineSig pass
_ Located (IdP pass)
n InlinePragma
_)             = [(Located (IdP pass)
n,Sig pass
sig)]
    expand_sig sig :: Sig pass
sig@(TypeSig XTypeSig pass
_ [Located (IdP pass)]
ns LHsSigWcType pass
_)              = [(Located (IdP pass)
n,Sig pass
sig) | Located (IdP pass)
n <- [Located (IdP pass)]
ns]
    expand_sig sig :: Sig pass
sig@(ClassOpSig XClassOpSig pass
_ Bool
_ [Located (IdP pass)]
ns LHsSigType pass
_)         = [(Located (IdP pass)
n,Sig pass
sig) | Located (IdP pass)
n <- [Located (IdP pass)]
ns]
    expand_sig sig :: Sig pass
sig@(PatSynSig XPatSynSig pass
_ [Located (IdP pass)]
ns  LHsSigType pass
_ )          = [(Located (IdP pass)
n,Sig pass
sig) | Located (IdP pass)
n <- [Located (IdP pass)]
ns]
    expand_sig sig :: Sig pass
sig@(SCCFunSig XSCCFunSig pass
_ SourceText
_ Located (IdP pass)
n Maybe (Located StringLiteral)
_)           = [(Located (IdP pass)
n,Sig pass
sig)]
    expand_sig Sig pass
_ = []

    matching_sig :: (GenLocated l a, Sig pass) -> (GenLocated l a, Sig pass) -> Bool
matching_sig (L l
_ a
n1,Sig pass
sig1) (L l
_ a
n2,Sig pass
sig2)       = a
n1 a -> a -> Bool
forall a. Eq a => a -> a -> Bool
== a
n2 Bool -> Bool -> Bool
&& Sig pass -> Sig pass -> Bool
forall {pass} {pass}. Sig pass -> Sig pass -> Bool
mtch Sig pass
sig1 Sig pass
sig2
    mtch :: Sig pass -> Sig pass -> Bool
mtch (FixSig {})           (FixSig {})         = Bool
True
    mtch (InlineSig {})        (InlineSig {})      = Bool
True
    mtch (TypeSig {})          (TypeSig {})        = Bool
True
    mtch (ClassOpSig XClassOpSig pass
_ Bool
d1 [Located (IdP pass)]
_ LHsSigType pass
_) (ClassOpSig XClassOpSig pass
_ Bool
d2 [Located (IdP pass)]
_ LHsSigType pass
_) = Bool
d1 Bool -> Bool -> Bool
forall a. Eq a => a -> a -> Bool
== Bool
d2
    mtch (PatSynSig XPatSynSig pass
_ [Located (IdP pass)]
_ LHsSigType pass
_)     (PatSynSig XPatSynSig pass
_ [Located (IdP pass)]
_ LHsSigType pass
_)   = Bool
True
    mtch (SCCFunSig{})         (SCCFunSig{})       = Bool
True
    mtch Sig pass
_ Sig pass
_ = Bool
False

-- Warn about multiple MINIMAL signatures
checkDupMinimalSigs :: [LSig GhcPs] -> RnM ()
checkDupMinimalSigs :: [LSig GhcPs] -> TcRn ()
checkDupMinimalSigs [LSig GhcPs]
sigs
  = case (LSig GhcPs -> Bool) -> [LSig GhcPs] -> [LSig GhcPs]
forall a. (a -> Bool) -> [a] -> [a]
filter LSig GhcPs -> Bool
forall name. LSig name -> Bool
isMinimalLSig [LSig GhcPs]
sigs of
      minSigs :: [LSig GhcPs]
minSigs@(LSig GhcPs
_:LSig GhcPs
_:[LSig GhcPs]
_) -> [LSig GhcPs] -> TcRn ()
dupMinimalSigErr [LSig GhcPs]
minSigs
      [LSig GhcPs]
_ -> () -> TcRn ()
forall (m :: * -> *) a. Monad m => a -> m a
return ()

{-
************************************************************************
*                                                                      *
\subsection{Match}
*                                                                      *
************************************************************************
-}

rnMatchGroup :: Outputable (body GhcPs) => HsMatchContext GhcRn
             -> (Located (body GhcPs) -> RnM (Located (body GhcRn), FreeVars))
             -> MatchGroup GhcPs (Located (body GhcPs))
             -> RnM (MatchGroup GhcRn (Located (body GhcRn)), FreeVars)
rnMatchGroup :: forall (body :: * -> *).
Outputable (body GhcPs) =>
HsMatchContext GhcRn
-> (Located (body GhcPs) -> RnM (Located (body GhcRn), NameSet))
-> MatchGroup GhcPs (Located (body GhcPs))
-> RnM (MatchGroup GhcRn (Located (body GhcRn)), NameSet)
rnMatchGroup HsMatchContext GhcRn
ctxt Located (body GhcPs) -> RnM (Located (body GhcRn), NameSet)
rnBody (MG { mg_alts :: forall p body. MatchGroup p body -> Located [LMatch p body]
mg_alts = L SrcSpan
_ [LMatch GhcPs (Located (body GhcPs))]
ms, mg_origin :: forall p body. MatchGroup p body -> Origin
mg_origin = Origin
origin })
  = do { Bool
empty_case_ok <- Extension -> TcRnIf TcGblEnv TcLclEnv Bool
forall gbl lcl. Extension -> TcRnIf gbl lcl Bool
xoptM Extension
LangExt.EmptyCase
       ; Bool -> TcRn () -> TcRn ()
forall (f :: * -> *). Applicative f => Bool -> f () -> f ()
when ([LMatch GhcPs (Located (body GhcPs))] -> Bool
forall (t :: * -> *) a. Foldable t => t a -> Bool
null [LMatch GhcPs (Located (body GhcPs))]
ms Bool -> Bool -> Bool
&& Bool -> Bool
not Bool
empty_case_ok) (MsgDoc -> TcRn ()
addErr (HsMatchContext GhcRn -> MsgDoc
emptyCaseErr HsMatchContext GhcRn
ctxt))
       ; ([LMatch GhcRn (Located (body GhcRn))]
new_ms, NameSet
ms_fvs) <- (LMatch GhcPs (Located (body GhcPs))
 -> RnM (LMatch GhcRn (Located (body GhcRn)), NameSet))
-> [LMatch GhcPs (Located (body GhcPs))]
-> RnM ([LMatch GhcRn (Located (body GhcRn))], NameSet)
forall a b. (a -> RnM (b, NameSet)) -> [a] -> RnM ([b], NameSet)
mapFvRn (HsMatchContext GhcRn
-> (Located (body GhcPs) -> RnM (Located (body GhcRn), NameSet))
-> LMatch GhcPs (Located (body GhcPs))
-> RnM (LMatch GhcRn (Located (body GhcRn)), NameSet)
forall (body :: * -> *).
Outputable (body GhcPs) =>
HsMatchContext GhcRn
-> (Located (body GhcPs) -> RnM (Located (body GhcRn), NameSet))
-> LMatch GhcPs (Located (body GhcPs))
-> RnM (LMatch GhcRn (Located (body GhcRn)), NameSet)
rnMatch HsMatchContext GhcRn
ctxt Located (body GhcPs) -> RnM (Located (body GhcRn), NameSet)
rnBody) [LMatch GhcPs (Located (body GhcPs))]
ms
       ; (MatchGroup GhcRn (Located (body GhcRn)), NameSet)
-> RnM (MatchGroup GhcRn (Located (body GhcRn)), NameSet)
forall (m :: * -> *) a. Monad m => a -> m a
return (Origin
-> [LMatch GhcRn (Located (body GhcRn))]
-> MatchGroup GhcRn (Located (body GhcRn))
forall name (body :: * -> *).
(XMG name (Located (body name)) ~ NoExtField) =>
Origin
-> [LMatch name (Located (body name))]
-> MatchGroup name (Located (body name))
mkMatchGroup Origin
origin [LMatch GhcRn (Located (body GhcRn))]
new_ms, NameSet
ms_fvs) }

rnMatch :: Outputable (body GhcPs) => HsMatchContext GhcRn
        -> (Located (body GhcPs) -> RnM (Located (body GhcRn), FreeVars))
        -> LMatch GhcPs (Located (body GhcPs))
        -> RnM (LMatch GhcRn (Located (body GhcRn)), FreeVars)
rnMatch :: forall (body :: * -> *).
Outputable (body GhcPs) =>
HsMatchContext GhcRn
-> (Located (body GhcPs) -> RnM (Located (body GhcRn), NameSet))
-> LMatch GhcPs (Located (body GhcPs))
-> RnM (LMatch GhcRn (Located (body GhcRn)), NameSet)
rnMatch HsMatchContext GhcRn
ctxt Located (body GhcPs) -> RnM (Located (body GhcRn), NameSet)
rnBody = (Match GhcPs (Located (body GhcPs))
 -> TcM (Match GhcRn (Located (body GhcRn)), NameSet))
-> Located (Match GhcPs (Located (body GhcPs)))
-> TcM (Located (Match GhcRn (Located (body GhcRn))), NameSet)
forall a b c. (a -> TcM (b, c)) -> Located a -> TcM (Located b, c)
wrapLocFstM (HsMatchContext GhcRn
-> (Located (body GhcPs) -> RnM (Located (body GhcRn), NameSet))
-> Match GhcPs (Located (body GhcPs))
-> TcM (Match GhcRn (Located (body GhcRn)), NameSet)
forall (body :: * -> *).
Outputable (body GhcPs) =>
HsMatchContext GhcRn
-> (Located (body GhcPs) -> RnM (Located (body GhcRn), NameSet))
-> Match GhcPs (Located (body GhcPs))
-> RnM (Match GhcRn (Located (body GhcRn)), NameSet)
rnMatch' HsMatchContext GhcRn
ctxt Located (body GhcPs) -> RnM (Located (body GhcRn), NameSet)
rnBody)

rnMatch' :: Outputable (body GhcPs) => HsMatchContext GhcRn
         -> (Located (body GhcPs) -> RnM (Located (body GhcRn), FreeVars))
         -> Match GhcPs (Located (body GhcPs))
         -> RnM (Match GhcRn (Located (body GhcRn)), FreeVars)
rnMatch' :: forall (body :: * -> *).
Outputable (body GhcPs) =>
HsMatchContext GhcRn
-> (Located (body GhcPs) -> RnM (Located (body GhcRn), NameSet))
-> Match GhcPs (Located (body GhcPs))
-> RnM (Match GhcRn (Located (body GhcRn)), NameSet)
rnMatch' HsMatchContext GhcRn
ctxt Located (body GhcPs) -> RnM (Located (body GhcRn), NameSet)
rnBody (Match { m_ctxt :: forall p body. Match p body -> HsMatchContext (NoGhcTc p)
m_ctxt = HsMatchContext (NoGhcTc GhcPs)
mf, m_pats :: forall p body. Match p body -> [LPat p]
m_pats = [LPat GhcPs]
pats, m_grhss :: forall p body. Match p body -> GRHSs p body
m_grhss = GRHSs GhcPs (Located (body GhcPs))
grhss })
  = do  { -- Note that there are no local fixity decls for matches
        ; HsMatchContext GhcRn
-> [LPat GhcPs]
-> ([LPat GhcRn]
    -> RnM (Match GhcRn (Located (body GhcRn)), NameSet))
-> RnM (Match GhcRn (Located (body GhcRn)), NameSet)
forall a.
HsMatchContext GhcRn
-> [LPat GhcPs]
-> ([LPat GhcRn] -> RnM (a, NameSet))
-> RnM (a, NameSet)
rnPats HsMatchContext GhcRn
ctxt [LPat GhcPs]
pats      (([LPat GhcRn]
  -> RnM (Match GhcRn (Located (body GhcRn)), NameSet))
 -> RnM (Match GhcRn (Located (body GhcRn)), NameSet))
-> ([LPat GhcRn]
    -> RnM (Match GhcRn (Located (body GhcRn)), NameSet))
-> RnM (Match GhcRn (Located (body GhcRn)), NameSet)
forall a b. (a -> b) -> a -> b
$ \ [LPat GhcRn]
pats' -> do
        { (GRHSs GhcRn (Located (body GhcRn))
grhss', NameSet
grhss_fvs) <- HsMatchContext GhcRn
-> (Located (body GhcPs) -> RnM (Located (body GhcRn), NameSet))
-> GRHSs GhcPs (Located (body GhcPs))
-> RnM (GRHSs GhcRn (Located (body GhcRn)), NameSet)
forall (body :: * -> *).
HsMatchContext GhcRn
-> (Located (body GhcPs) -> RnM (Located (body GhcRn), NameSet))
-> GRHSs GhcPs (Located (body GhcPs))
-> RnM (GRHSs GhcRn (Located (body GhcRn)), NameSet)
rnGRHSs HsMatchContext GhcRn
ctxt Located (body GhcPs) -> RnM (Located (body GhcRn), NameSet)
rnBody GRHSs GhcPs (Located (body GhcPs))
grhss
        ; let mf' :: HsMatchContext GhcRn
mf' = case (HsMatchContext GhcRn
ctxt, HsMatchContext GhcPs
HsMatchContext (NoGhcTc GhcPs)
mf) of
                      (FunRhs { mc_fun :: forall p. HsMatchContext p -> LIdP p
mc_fun = L SrcSpan
_ IdP GhcRn
funid }, FunRhs { mc_fun :: forall p. HsMatchContext p -> LIdP p
mc_fun = L SrcSpan
lf IdP GhcPs
_ })
                                            -> HsMatchContext GhcPs
HsMatchContext (NoGhcTc GhcPs)
mf { mc_fun :: Located (IdP GhcRn)
mc_fun = SrcSpan -> Name -> Located Name
forall l e. l -> e -> GenLocated l e
L SrcSpan
lf Name
IdP GhcRn
funid }
                      (HsMatchContext GhcRn, HsMatchContext GhcPs)
_                     -> HsMatchContext GhcRn
ctxt
        ; (Match GhcRn (Located (body GhcRn)), NameSet)
-> RnM (Match GhcRn (Located (body GhcRn)), NameSet)
forall (m :: * -> *) a. Monad m => a -> m a
return (Match :: forall p body.
XCMatch p body
-> HsMatchContext (NoGhcTc p)
-> [LPat p]
-> GRHSs p body
-> Match p body
Match { m_ext :: XCMatch GhcRn (Located (body GhcRn))
m_ext = NoExtField
XCMatch GhcRn (Located (body GhcRn))
noExtField, m_ctxt :: HsMatchContext (NoGhcTc GhcRn)
m_ctxt = HsMatchContext GhcRn
HsMatchContext (NoGhcTc GhcRn)
mf', m_pats :: [LPat GhcRn]
m_pats = [LPat GhcRn]
pats'
                        , m_grhss :: GRHSs GhcRn (Located (body GhcRn))
m_grhss = GRHSs GhcRn (Located (body GhcRn))
grhss'}, NameSet
grhss_fvs ) }}

emptyCaseErr :: HsMatchContext GhcRn -> SDoc
emptyCaseErr :: HsMatchContext GhcRn -> MsgDoc
emptyCaseErr HsMatchContext GhcRn
ctxt = MsgDoc -> Int -> MsgDoc -> MsgDoc
hang (String -> MsgDoc
text String
"Empty list of alternatives in" MsgDoc -> MsgDoc -> MsgDoc
<+> MsgDoc
pp_ctxt)
                       Int
2 (String -> MsgDoc
text String
"Use EmptyCase to allow this")
  where
    pp_ctxt :: MsgDoc
pp_ctxt = case HsMatchContext GhcRn
ctxt of
                HsMatchContext GhcRn
CaseAlt    -> String -> MsgDoc
text String
"case expression"
                HsMatchContext GhcRn
LambdaExpr -> String -> MsgDoc
text String
"\\case expression"
                HsMatchContext GhcRn
_ -> String -> MsgDoc
text String
"(unexpected)" MsgDoc -> MsgDoc -> MsgDoc
<+> HsMatchContext GhcRn -> MsgDoc
forall id. Outputable (IdP id) => HsMatchContext id -> MsgDoc
pprMatchContextNoun HsMatchContext GhcRn
ctxt

{-
************************************************************************
*                                                                      *
\subsubsection{Guarded right-hand sides (GRHSs)}
*                                                                      *
************************************************************************
-}

rnGRHSs :: HsMatchContext GhcRn
        -> (Located (body GhcPs) -> RnM (Located (body GhcRn), FreeVars))
        -> GRHSs GhcPs (Located (body GhcPs))
        -> RnM (GRHSs GhcRn (Located (body GhcRn)), FreeVars)
rnGRHSs :: forall (body :: * -> *).
HsMatchContext GhcRn
-> (Located (body GhcPs) -> RnM (Located (body GhcRn), NameSet))
-> GRHSs GhcPs (Located (body GhcPs))
-> RnM (GRHSs GhcRn (Located (body GhcRn)), NameSet)
rnGRHSs HsMatchContext GhcRn
ctxt Located (body GhcPs) -> RnM (Located (body GhcRn), NameSet)
rnBody (GRHSs XCGRHSs GhcPs (Located (body GhcPs))
_ [LGRHS GhcPs (Located (body GhcPs))]
grhss (L SrcSpan
l HsLocalBinds GhcPs
binds))
  = HsLocalBinds GhcPs
-> (HsLocalBinds GhcRn
    -> NameSet -> RnM (GRHSs GhcRn (Located (body GhcRn)), NameSet))
-> RnM (GRHSs GhcRn (Located (body GhcRn)), NameSet)
forall result.
HsLocalBinds GhcPs
-> (HsLocalBinds GhcRn -> NameSet -> RnM (result, NameSet))
-> RnM (result, NameSet)
rnLocalBindsAndThen HsLocalBinds GhcPs
binds   ((HsLocalBinds GhcRn
  -> NameSet -> RnM (GRHSs GhcRn (Located (body GhcRn)), NameSet))
 -> RnM (GRHSs GhcRn (Located (body GhcRn)), NameSet))
-> (HsLocalBinds GhcRn
    -> NameSet -> RnM (GRHSs GhcRn (Located (body GhcRn)), NameSet))
-> RnM (GRHSs GhcRn (Located (body GhcRn)), NameSet)
forall a b. (a -> b) -> a -> b
$ \ HsLocalBinds GhcRn
binds' NameSet
_ -> do
    ([LGRHS GhcRn (Located (body GhcRn))]
grhss', NameSet
fvGRHSs) <- (LGRHS GhcPs (Located (body GhcPs))
 -> RnM (LGRHS GhcRn (Located (body GhcRn)), NameSet))
-> [LGRHS GhcPs (Located (body GhcPs))]
-> RnM ([LGRHS GhcRn (Located (body GhcRn))], NameSet)
forall a b. (a -> RnM (b, NameSet)) -> [a] -> RnM ([b], NameSet)
mapFvRn (HsMatchContext GhcRn
-> (Located (body GhcPs) -> RnM (Located (body GhcRn), NameSet))
-> LGRHS GhcPs (Located (body GhcPs))
-> RnM (LGRHS GhcRn (Located (body GhcRn)), NameSet)
forall (body :: * -> *).
HsMatchContext GhcRn
-> (Located (body GhcPs) -> RnM (Located (body GhcRn), NameSet))
-> LGRHS GhcPs (Located (body GhcPs))
-> RnM (LGRHS GhcRn (Located (body GhcRn)), NameSet)
rnGRHS HsMatchContext GhcRn
ctxt Located (body GhcPs) -> RnM (Located (body GhcRn), NameSet)
rnBody) [LGRHS GhcPs (Located (body GhcPs))]
grhss
    (GRHSs GhcRn (Located (body GhcRn)), NameSet)
-> RnM (GRHSs GhcRn (Located (body GhcRn)), NameSet)
forall (m :: * -> *) a. Monad m => a -> m a
return (XCGRHSs GhcRn (Located (body GhcRn))
-> [LGRHS GhcRn (Located (body GhcRn))]
-> LHsLocalBinds GhcRn
-> GRHSs GhcRn (Located (body GhcRn))
forall p body.
XCGRHSs p body -> [LGRHS p body] -> LHsLocalBinds p -> GRHSs p body
GRHSs NoExtField
XCGRHSs GhcRn (Located (body GhcRn))
noExtField [LGRHS GhcRn (Located (body GhcRn))]
grhss' (SrcSpan -> HsLocalBinds GhcRn -> LHsLocalBinds GhcRn
forall l e. l -> e -> GenLocated l e
L SrcSpan
l HsLocalBinds GhcRn
binds'), NameSet
fvGRHSs)

rnGRHS :: HsMatchContext GhcRn
       -> (Located (body GhcPs) -> RnM (Located (body GhcRn), FreeVars))
       -> LGRHS GhcPs (Located (body GhcPs))
       -> RnM (LGRHS GhcRn (Located (body GhcRn)), FreeVars)
rnGRHS :: forall (body :: * -> *).
HsMatchContext GhcRn
-> (Located (body GhcPs) -> RnM (Located (body GhcRn), NameSet))
-> LGRHS GhcPs (Located (body GhcPs))
-> RnM (LGRHS GhcRn (Located (body GhcRn)), NameSet)
rnGRHS HsMatchContext GhcRn
ctxt Located (body GhcPs) -> RnM (Located (body GhcRn), NameSet)
rnBody = (GRHS GhcPs (Located (body GhcPs))
 -> TcM (GRHS GhcRn (Located (body GhcRn)), NameSet))
-> Located (GRHS GhcPs (Located (body GhcPs)))
-> TcM (Located (GRHS GhcRn (Located (body GhcRn))), NameSet)
forall a b c. (a -> TcM (b, c)) -> Located a -> TcM (Located b, c)
wrapLocFstM (HsMatchContext GhcRn
-> (Located (body GhcPs) -> RnM (Located (body GhcRn), NameSet))
-> GRHS GhcPs (Located (body GhcPs))
-> TcM (GRHS GhcRn (Located (body GhcRn)), NameSet)
forall (body :: * -> *).
HsMatchContext GhcRn
-> (Located (body GhcPs) -> RnM (Located (body GhcRn), NameSet))
-> GRHS GhcPs (Located (body GhcPs))
-> RnM (GRHS GhcRn (Located (body GhcRn)), NameSet)
rnGRHS' HsMatchContext GhcRn
ctxt Located (body GhcPs) -> RnM (Located (body GhcRn), NameSet)
rnBody)

rnGRHS' :: HsMatchContext GhcRn
        -> (Located (body GhcPs) -> RnM (Located (body GhcRn), FreeVars))
        -> GRHS GhcPs (Located (body GhcPs))
        -> RnM (GRHS GhcRn (Located (body GhcRn)), FreeVars)
rnGRHS' :: forall (body :: * -> *).
HsMatchContext GhcRn
-> (Located (body GhcPs) -> RnM (Located (body GhcRn), NameSet))
-> GRHS GhcPs (Located (body GhcPs))
-> RnM (GRHS GhcRn (Located (body GhcRn)), NameSet)
rnGRHS' HsMatchContext GhcRn
ctxt Located (body GhcPs) -> RnM (Located (body GhcRn), NameSet)
rnBody (GRHS XCGRHS GhcPs (Located (body GhcPs))
_ [GuardLStmt GhcPs]
guards Located (body GhcPs)
rhs)
  = do  { Bool
pattern_guards_allowed <- Extension -> TcRnIf TcGblEnv TcLclEnv Bool
forall gbl lcl. Extension -> TcRnIf gbl lcl Bool
xoptM Extension
LangExt.PatternGuards
        ; (([LStmt GhcRn (LHsExpr GhcRn)]
guards', Located (body GhcRn)
rhs'), NameSet
fvs) <- HsStmtContext GhcRn
-> (LHsExpr GhcPs -> RnM (LHsExpr GhcRn, NameSet))
-> [GuardLStmt GhcPs]
-> ([Name] -> RnM (Located (body GhcRn), NameSet))
-> RnM
     (([LStmt GhcRn (LHsExpr GhcRn)], Located (body GhcRn)), NameSet)
forall (body :: * -> *) thing.
Outputable (body GhcPs) =>
HsStmtContext GhcRn
-> (Located (body GhcPs) -> RnM (Located (body GhcRn), NameSet))
-> [LStmt GhcPs (Located (body GhcPs))]
-> ([Name] -> RnM (thing, NameSet))
-> RnM (([LStmt GhcRn (Located (body GhcRn))], thing), NameSet)
rnStmts (HsMatchContext GhcRn -> HsStmtContext GhcRn
forall p. HsMatchContext p -> HsStmtContext p
PatGuard HsMatchContext GhcRn
ctxt) LHsExpr GhcPs -> RnM (LHsExpr GhcRn, NameSet)
rnLExpr [GuardLStmt GhcPs]
guards (([Name] -> RnM (Located (body GhcRn), NameSet))
 -> RnM
      (([LStmt GhcRn (LHsExpr GhcRn)], Located (body GhcRn)), NameSet))
-> ([Name] -> RnM (Located (body GhcRn), NameSet))
-> RnM
     (([LStmt GhcRn (LHsExpr GhcRn)], Located (body GhcRn)), NameSet)
forall a b. (a -> b) -> a -> b
$ \ [Name]
_ ->
                                    Located (body GhcPs) -> RnM (Located (body GhcRn), NameSet)
rnBody Located (body GhcPs)
rhs

        ; Bool -> TcRn () -> TcRn ()
forall (f :: * -> *). Applicative f => Bool -> f () -> f ()
unless (Bool
pattern_guards_allowed Bool -> Bool -> Bool
|| [LStmt GhcRn (LHsExpr GhcRn)] -> Bool
forall {l} {idL} {idR} {body}.
[GenLocated l (StmtLR idL idR body)] -> Bool
is_standard_guard [LStmt GhcRn (LHsExpr GhcRn)]
guards')
                 (WarnReason -> MsgDoc -> TcRn ()
addWarn WarnReason
NoReason ([LStmt GhcRn (LHsExpr GhcRn)] -> MsgDoc
forall body.
Outputable body =>
[LStmtLR GhcRn GhcRn body] -> MsgDoc
nonStdGuardErr [LStmt GhcRn (LHsExpr GhcRn)]
guards'))

        ; (GRHS GhcRn (Located (body GhcRn)), NameSet)
-> RnM (GRHS GhcRn (Located (body GhcRn)), NameSet)
forall (m :: * -> *) a. Monad m => a -> m a
return (XCGRHS GhcRn (Located (body GhcRn))
-> [LStmt GhcRn (LHsExpr GhcRn)]
-> Located (body GhcRn)
-> GRHS GhcRn (Located (body GhcRn))
forall p body.
XCGRHS p body -> [GuardLStmt p] -> body -> GRHS p body
GRHS NoExtField
XCGRHS GhcRn (Located (body GhcRn))
noExtField [LStmt GhcRn (LHsExpr GhcRn)]
guards' Located (body GhcRn)
rhs', NameSet
fvs) }
  where
        -- Standard Haskell 1.4 guards are just a single boolean
        -- expression, rather than a list of qualifiers as in the
        -- Glasgow extension
    is_standard_guard :: [GenLocated l (StmtLR idL idR body)] -> Bool
is_standard_guard []                  = Bool
True
    is_standard_guard [L l
_ (BodyStmt {})] = Bool
True
    is_standard_guard [GenLocated l (StmtLR idL idR body)]
_                   = Bool
False

{-
*********************************************************
*                                                       *
        Source-code fixity declarations
*                                                       *
*********************************************************
-}

rnSrcFixityDecl :: HsSigCtxt -> FixitySig GhcPs -> RnM (FixitySig GhcRn)
-- Rename a fixity decl, so we can put
-- the renamed decl in the renamed syntax tree
-- Errors if the thing being fixed is not defined locally.
rnSrcFixityDecl :: HsSigCtxt -> FixitySig GhcPs -> RnM (FixitySig GhcRn)
rnSrcFixityDecl HsSigCtxt
sig_ctxt = FixitySig GhcPs -> RnM (FixitySig GhcRn)
rn_decl
  where
    rn_decl :: FixitySig GhcPs -> RnM (FixitySig GhcRn)
        -- GHC extension: look up both the tycon and data con
        -- for con-like things; hence returning a list
        -- If neither are in scope, report an error; otherwise
        -- return a fixity sig for each (slightly odd)
    rn_decl :: FixitySig GhcPs -> RnM (FixitySig GhcRn)
rn_decl (FixitySig XFixitySig GhcPs
_ [Located (IdP GhcPs)]
fnames Fixity
fixity)
      = do [Located Name]
names <- (Located RdrName -> IOEnv (Env TcGblEnv TcLclEnv) [Located Name])
-> [Located RdrName]
-> IOEnv (Env TcGblEnv TcLclEnv) [Located Name]
forall (m :: * -> *) a b. Monad m => (a -> m [b]) -> [a] -> m [b]
concatMapM Located RdrName -> IOEnv (Env TcGblEnv TcLclEnv) [Located Name]
lookup_one [Located RdrName]
[Located (IdP GhcPs)]
fnames
           FixitySig GhcRn -> RnM (FixitySig GhcRn)
forall (m :: * -> *) a. Monad m => a -> m a
return (XFixitySig GhcRn
-> [Located (IdP GhcRn)] -> Fixity -> FixitySig GhcRn
forall pass.
XFixitySig pass -> [Located (IdP pass)] -> Fixity -> FixitySig pass
FixitySig NoExtField
XFixitySig GhcRn
noExtField [Located Name]
[Located (IdP GhcRn)]
names Fixity
fixity)

    lookup_one :: Located RdrName -> RnM [Located Name]
    lookup_one :: Located RdrName -> IOEnv (Env TcGblEnv TcLclEnv) [Located Name]
lookup_one (L SrcSpan
name_loc RdrName
rdr_name)
      = SrcSpan
-> IOEnv (Env TcGblEnv TcLclEnv) [Located Name]
-> IOEnv (Env TcGblEnv TcLclEnv) [Located Name]
forall a. SrcSpan -> TcRn a -> TcRn a
setSrcSpan SrcSpan
name_loc (IOEnv (Env TcGblEnv TcLclEnv) [Located Name]
 -> IOEnv (Env TcGblEnv TcLclEnv) [Located Name])
-> IOEnv (Env TcGblEnv TcLclEnv) [Located Name]
-> IOEnv (Env TcGblEnv TcLclEnv) [Located Name]
forall a b. (a -> b) -> a -> b
$
                    -- This lookup will fail if the name is not defined in the
                    -- same binding group as this fixity declaration.
        do [(RdrName, Name)]
names <- HsSigCtxt -> MsgDoc -> RdrName -> RnM [(RdrName, Name)]
lookupLocalTcNames HsSigCtxt
sig_ctxt MsgDoc
what RdrName
rdr_name
           [Located Name] -> IOEnv (Env TcGblEnv TcLclEnv) [Located Name]
forall (m :: * -> *) a. Monad m => a -> m a
return [ SrcSpan -> Name -> Located Name
forall l e. l -> e -> GenLocated l e
L SrcSpan
name_loc Name
name | (RdrName
_, Name
name) <- [(RdrName, Name)]
names ]
    what :: MsgDoc
what = String -> MsgDoc
text String
"fixity signature"

{-
************************************************************************
*                                                                      *
\subsection{Error messages}
*                                                                      *
************************************************************************
-}

dupSigDeclErr :: NonEmpty (Located RdrName, Sig GhcPs) -> RnM ()
dupSigDeclErr :: NonEmpty (Located RdrName, Sig GhcPs) -> TcRn ()
dupSigDeclErr pairs :: NonEmpty (Located RdrName, Sig GhcPs)
pairs@((L SrcSpan
loc RdrName
name, Sig GhcPs
sig) :| [(Located RdrName, Sig GhcPs)]
_)
  = SrcSpan -> MsgDoc -> TcRn ()
addErrAt SrcSpan
loc (MsgDoc -> TcRn ()) -> MsgDoc -> TcRn ()
forall a b. (a -> b) -> a -> b
$
    [MsgDoc] -> MsgDoc
vcat [ String -> MsgDoc
text String
"Duplicate" MsgDoc -> MsgDoc -> MsgDoc
<+> MsgDoc
what_it_is
           MsgDoc -> MsgDoc -> MsgDoc
<> String -> MsgDoc
text String
"s for" MsgDoc -> MsgDoc -> MsgDoc
<+> MsgDoc -> MsgDoc
quotes (RdrName -> MsgDoc
forall a. Outputable a => a -> MsgDoc
ppr RdrName
name)
         , String -> MsgDoc
text String
"at" MsgDoc -> MsgDoc -> MsgDoc
<+> [MsgDoc] -> MsgDoc
vcat ((SrcSpan -> MsgDoc) -> [SrcSpan] -> [MsgDoc]
forall a b. (a -> b) -> [a] -> [b]
map SrcSpan -> MsgDoc
forall a. Outputable a => a -> MsgDoc
ppr ([SrcSpan] -> [MsgDoc]) -> [SrcSpan] -> [MsgDoc]
forall a b. (a -> b) -> a -> b
$ (SrcSpan -> SrcSpan -> Ordering) -> [SrcSpan] -> [SrcSpan]
forall a. (a -> a -> Ordering) -> [a] -> [a]
sortBy SrcSpan -> SrcSpan -> Ordering
SrcLoc.leftmost_smallest
                                       ([SrcSpan] -> [SrcSpan]) -> [SrcSpan] -> [SrcSpan]
forall a b. (a -> b) -> a -> b
$ ((Located RdrName, Sig GhcPs) -> SrcSpan)
-> [(Located RdrName, Sig GhcPs)] -> [SrcSpan]
forall a b. (a -> b) -> [a] -> [b]
map (Located RdrName -> SrcSpan
forall l e. GenLocated l e -> l
getLoc (Located RdrName -> SrcSpan)
-> ((Located RdrName, Sig GhcPs) -> Located RdrName)
-> (Located RdrName, Sig GhcPs)
-> SrcSpan
forall b c a. (b -> c) -> (a -> b) -> a -> c
. (Located RdrName, Sig GhcPs) -> Located RdrName
forall a b. (a, b) -> a
fst)
                                       ([(Located RdrName, Sig GhcPs)] -> [SrcSpan])
-> [(Located RdrName, Sig GhcPs)] -> [SrcSpan]
forall a b. (a -> b) -> a -> b
$ NonEmpty (Located RdrName, Sig GhcPs)
-> [(Located RdrName, Sig GhcPs)]
forall (t :: * -> *) a. Foldable t => t a -> [a]
toList NonEmpty (Located RdrName, Sig GhcPs)
pairs)
         ]
  where
    what_it_is :: MsgDoc
what_it_is = Sig GhcPs -> MsgDoc
forall name. Sig name -> MsgDoc
hsSigDoc Sig GhcPs
sig

misplacedSigErr :: LSig GhcRn -> RnM ()
misplacedSigErr :: LSig GhcRn -> TcRn ()
misplacedSigErr (L SrcSpan
loc Sig GhcRn
sig)
  = SrcSpan -> MsgDoc -> TcRn ()
addErrAt SrcSpan
loc (MsgDoc -> TcRn ()) -> MsgDoc -> TcRn ()
forall a b. (a -> b) -> a -> b
$
    [MsgDoc] -> MsgDoc
sep [String -> MsgDoc
text String
"Misplaced" MsgDoc -> MsgDoc -> MsgDoc
<+> Sig GhcRn -> MsgDoc
forall name. Sig name -> MsgDoc
hsSigDoc Sig GhcRn
sig MsgDoc -> MsgDoc -> MsgDoc
<> MsgDoc
colon, Sig GhcRn -> MsgDoc
forall a. Outputable a => a -> MsgDoc
ppr Sig GhcRn
sig]

defaultSigErr :: Sig GhcPs -> SDoc
defaultSigErr :: Sig GhcPs -> MsgDoc
defaultSigErr Sig GhcPs
sig = [MsgDoc] -> MsgDoc
vcat [ MsgDoc -> Int -> MsgDoc -> MsgDoc
hang (String -> MsgDoc
text String
"Unexpected default signature:")
                              Int
2 (Sig GhcPs -> MsgDoc
forall a. Outputable a => a -> MsgDoc
ppr Sig GhcPs
sig)
                         , String -> MsgDoc
text String
"Use DefaultSignatures to enable default signatures" ]

bindsInHsBootFile :: LHsBindsLR GhcRn GhcPs -> SDoc
bindsInHsBootFile :: LHsBindsLR GhcRn GhcPs -> MsgDoc
bindsInHsBootFile LHsBindsLR GhcRn GhcPs
mbinds
  = MsgDoc -> Int -> MsgDoc -> MsgDoc
hang (String -> MsgDoc
text String
"Bindings in hs-boot files are not allowed")
       Int
2 (LHsBindsLR GhcRn GhcPs -> MsgDoc
forall a. Outputable a => a -> MsgDoc
ppr LHsBindsLR GhcRn GhcPs
mbinds)

nonStdGuardErr :: Outputable body => [LStmtLR GhcRn GhcRn body] -> SDoc
nonStdGuardErr :: forall body.
Outputable body =>
[LStmtLR GhcRn GhcRn body] -> MsgDoc
nonStdGuardErr [LStmtLR GhcRn GhcRn body]
guards
  = MsgDoc -> Int -> MsgDoc -> MsgDoc
hang (String -> MsgDoc
text String
"accepting non-standard pattern guards (use PatternGuards to suppress this message)")
       Int
4 ([LStmtLR GhcRn GhcRn body] -> MsgDoc
forall a. Outputable a => [a] -> MsgDoc
interpp'SP [LStmtLR GhcRn GhcRn body]
guards)

unusedPatBindWarn :: HsBind GhcRn -> SDoc
unusedPatBindWarn :: HsBind GhcRn -> MsgDoc
unusedPatBindWarn HsBind GhcRn
bind
  = MsgDoc -> Int -> MsgDoc -> MsgDoc
hang (String -> MsgDoc
text String
"This pattern-binding binds no variables:")
       Int
2 (HsBind GhcRn -> MsgDoc
forall a. Outputable a => a -> MsgDoc
ppr HsBind GhcRn
bind)

dupMinimalSigErr :: [LSig GhcPs] -> RnM ()
dupMinimalSigErr :: [LSig GhcPs] -> TcRn ()
dupMinimalSigErr sigs :: [LSig GhcPs]
sigs@(L SrcSpan
loc Sig GhcPs
_ : [LSig GhcPs]
_)
  = SrcSpan -> MsgDoc -> TcRn ()
addErrAt SrcSpan
loc (MsgDoc -> TcRn ()) -> MsgDoc -> TcRn ()
forall a b. (a -> b) -> a -> b
$
    [MsgDoc] -> MsgDoc
vcat [ String -> MsgDoc
text String
"Multiple minimal complete definitions"
         , String -> MsgDoc
text String
"at" MsgDoc -> MsgDoc -> MsgDoc
<+> [MsgDoc] -> MsgDoc
vcat ((SrcSpan -> MsgDoc) -> [SrcSpan] -> [MsgDoc]
forall a b. (a -> b) -> [a] -> [b]
map SrcSpan -> MsgDoc
forall a. Outputable a => a -> MsgDoc
ppr ([SrcSpan] -> [MsgDoc]) -> [SrcSpan] -> [MsgDoc]
forall a b. (a -> b) -> a -> b
$ (SrcSpan -> SrcSpan -> Ordering) -> [SrcSpan] -> [SrcSpan]
forall a. (a -> a -> Ordering) -> [a] -> [a]
sortBy SrcSpan -> SrcSpan -> Ordering
SrcLoc.leftmost_smallest ([SrcSpan] -> [SrcSpan]) -> [SrcSpan] -> [SrcSpan]
forall a b. (a -> b) -> a -> b
$ (LSig GhcPs -> SrcSpan) -> [LSig GhcPs] -> [SrcSpan]
forall a b. (a -> b) -> [a] -> [b]
map LSig GhcPs -> SrcSpan
forall l e. GenLocated l e -> l
getLoc [LSig GhcPs]
sigs)
         , String -> MsgDoc
text String
"Combine alternative minimal complete definitions with `|'" ]
dupMinimalSigErr [] = String -> TcRn ()
forall a. String -> a
panic String
"dupMinimalSigErr"