[project @ 2002-09-13 15:02:25 by simonpj]
[ghc-hetmet.git] / ghc / compiler / deSugar / DsMonad.lhs
index 3428be6..9a8b447 100644 (file)
@@ -1,55 +1,50 @@
 %
-% (c) The GRASP/AQUA Project, Glasgow University, 1992-1996
+% (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
 %
 \section[DsMonad]{@DsMonad@: monadery used in desugaring}
 
 \begin{code}
-#include "HsVersions.h"
-
 module DsMonad (
-       SYN_IE(DsM),
-       initDs, returnDs, thenDs, andDs, mapDs, listDs,
-       mapAndUnzipDs, zipWithDs,
+       DsM,
+       initDs, returnDs, thenDs, mapDs, listDs,
+       mapAndUnzipDs, zipWithDs, foldlDs,
        uniqSMtoDsM,
        newTyVarsDs, cloneTyVarsDs,
-       duplicateLocalDs, newSysLocalDs, newSysLocalsDs,
+       duplicateLocalDs, newSysLocalDs, newSysLocalsDs, newUniqueId,
        newFailLocalDs,
        getSrcLocDs, putSrcLocDs,
-       getModuleAndGroupDs,
-       extendEnvDs, lookupEnvDs, 
-       SYN_IE(DsIdEnv),
+       getModuleDs,
+       getUniqueDs, getUniquesDs,
+       getDOptsDs,
+       dsLookupGlobalId, dsLookupTyCon,
 
-       dsShadowWarn, dsIncompleteWarn,
-       SYN_IE(DsWarnings),
-       DsMatchContext(..), DsMatchKind(..), pprDsWarnings,
-        DsWarnFlavour -- Nuke with 1.4
+       DsMetaEnv, DsMetaVal(..), dsLookupMetaEnv, dsExtendMetaEnv,
 
+       dsWarn, 
+       DsWarnings,
+       DsMatchContext(..)
     ) where
 
-IMP_Ubiq()
-
-import Bag             ( emptyBag, snocBag, bagToList, Bag )
-import BasicTypes       ( SYN_IE(Module) )
-import CmdLineOpts     ( opt_PprUserLength )
-import CoreSyn         ( SYN_IE(CoreExpr) )
-import CoreUtils       ( substCoreExpr )
-import HsSyn           ( OutPat )
-import Id              ( mkSysLocal, mkIdWithNewUniq,
-                         lookupIdEnv, growIdEnvList, GenId, SYN_IE(IdEnv),
-                         SYN_IE(Id)
-                       )
-import PprType         ( GenType, GenTyVar )
-import Outputable      ( pprQuote, Outputable(..), PprStyle(..) )
-import Pretty
+#include "HsVersions.h"
+
+import TcHsSyn         ( TypecheckedPat, TypecheckedMatchContext, TypecheckedHsExpr )
+import HscTypes                ( TyThing(..) )
+import Bag             ( emptyBag, snocBag, Bag )
+import TyCon           ( TyCon )
+import ErrUtils        ( WarnMsg )
+import Id              ( mkSysLocal, setIdUnique, Id )
+import Module          ( Module )
+import Var             ( TyVar, setTyVarUnique )
+import Outputable
 import SrcLoc          ( noSrcLoc, SrcLoc )
-import TcHsSyn         ( SYN_IE(TypecheckedPat) )
-import Type             ( SYN_IE(Type) )
-import TyVar           ( nullTyVarEnv, cloneTyVar, GenTyVar{-instance Eq-}, SYN_IE(TyVar) )
-import Unique          ( Unique{-instances-} )
-import UniqSupply      ( splitUniqSupply, getUnique, getUniques,
-                         mapUs, thenUs, returnUs, SYN_IE(UniqSM),
-                         UniqSupply )
-import Util            ( assoc, mapAccumL, zipWithEqual, panic )
+import Type             ( Type )
+import UniqSupply      ( initUs_, getUniqueUs, getUniquesUs, thenUs, returnUs, 
+                         UniqSM, UniqSupply )
+import Unique          ( Unique ) 
+import Name            ( Name, nameOccName )
+import NameEnv
+import OccName          ( occNameFS )
+import CmdLineOpts     ( DynFlags )
 
 infixr 9 `thenDs`
 \end{code}
@@ -58,51 +53,66 @@ Now the mondo monad magic (yes, @DsM@ is a silly name)---carry around
 a @UniqueSupply@ and some annotations, which
 presumably include source-file location information:
 \begin{code}
-type DsM result =
-       UniqSupply
-       -> SrcLoc                -- to put in pattern-matching error msgs
-       -> (Module, Group)       -- module + group name : for SCC profiling
-       -> DsIdEnv
-       -> DsWarnings
-       -> (result, DsWarnings)
-
-type DsWarnings = Bag (DsWarnFlavour, DsMatchContext)
-                                       -- The desugarer reports matches which are
-                                       -- completely shadowed or incomplete patterns
+newtype DsM result
+  = DsM (DsEnv -> DsWarnings -> UniqSM (result, DsWarnings))
+
+unDsM (DsM x) = x      
+
+data DsEnv = DsEnv {
+       ds_dflags :: DynFlags,
+       ds_globals :: Name -> TyThing,  -- Lookup well-known Ids
+       ds_meta    :: DsMetaEnv,        -- Template Haskell bindings
+       ds_loc     :: SrcLoc,           -- to put in pattern-matching error msgs
+       ds_mod     :: Module            -- module: for SCC profiling
+     }
+
+-- Inside [| |] brackets, the desugarer looks 
+-- up variables in the DsMetaEnv
+type DsMetaEnv = NameEnv DsMetaVal
+
+data DsMetaVal
+   = Bound Id          -- Bound by a pattern inside the [| |]. 
+                       -- Will be dynamically alpha renamed.
+                       -- The Id has type String
+
+   | Splice TypecheckedHsExpr  -- These bindings are introduced by
+                               -- the PendingSplices on a HsBracketOut
 
-type Group = FAST_STRING
+instance Monad DsM where
+  return = returnDs
+  (>>=)  = thenDs
+
+type DsWarnings = Bag DsWarning         -- The desugarer reports matches which are
+                                       -- completely shadowed or incomplete patterns
+type DsWarning = (Loc, SDoc)
 
-{-# INLINE andDs #-}
 {-# INLINE thenDs #-}
 {-# INLINE returnDs #-}
 
 -- initDs returns the UniqSupply out the end (not just the result)
 
-initDs  :: UniqSupply
-       -> DsIdEnv
-       -> (Module, Group)      -- module name: for profiling; (group name: from switches)
+initDs  :: DynFlags
+       -> UniqSupply
+       -> (Name -> TyThing)
+       -> Module   -- module name: for profiling
        -> DsM a
        -> (a, DsWarnings)
 
-initDs init_us env module_and_group action
-  = action init_us noSrcLoc module_and_group env emptyBag
+initDs dflags init_us lookup mod (DsM action)
+  = initUs_ init_us (action ds_env emptyBag)
+  where
+    ds_env = DsEnv { ds_dflags = dflags, ds_globals = lookup,
+                    ds_loc = noSrcLoc, ds_mod = mod,
+                    ds_meta = emptyNameEnv }
 
 thenDs :: DsM a -> (a -> DsM b) -> DsM b
-andDs  :: (a -> a -> a) -> DsM a -> DsM a -> DsM a
 
-thenDs m1 m2 us loc mod_and_grp env warns
-  = case splitUniqSupply us                of { (s1, s2) ->
-    case (m1 s1 loc mod_and_grp env warns)  of { (result, warns1) ->
-    m2 result s2 loc mod_and_grp env warns1}}
-
-andDs combiner m1 m2 us loc mod_and_grp env warns
-  = case splitUniqSupply us                of { (s1, s2) ->
-    case (m1 s1 loc mod_and_grp env warns)  of { (result1, warns1) ->
-    case (m2 s2 loc mod_and_grp env warns1) of { (result2, warns2) ->
-    (combiner result1 result2, warns2) }}}
+thenDs (DsM m1) m2 = DsM( \ env warns ->
+    m1 env warns       `thenUs` \ (result, warns1) ->
+    unDsM (m2 result) env warns1)
 
 returnDs :: a -> DsM a
-returnDs result us loc mod_and_grp env warns = (result, warns)
+returnDs result = DsM (\ env warns -> returnUs (result, warns))
 
 listDs :: [DsM a] -> DsM [a]
 listDs []     = returnDs []
@@ -119,6 +129,12 @@ mapDs f (x:xs)
     mapDs f xs `thenDs` \ rs ->
     returnDs (r:rs)
 
+foldlDs :: (a -> b -> DsM a) -> a -> [b] -> DsM a
+
+foldlDs k z []     = returnDs z
+foldlDs k z (x:xs) = k z x `thenDs` \ r ->
+                    foldlDs k r xs
+
 mapAndUnzipDs :: (a -> DsM (b, c)) -> [a] -> DsM ([b], [c])
 
 mapAndUnzipDs f []     = returnDs ([], [])
@@ -142,140 +158,114 @@ functions are defined with it.  The difference in name-strings makes
 it easier to read debugging output.
 
 \begin{code}
-newLocalDs :: FAST_STRING -> Type -> DsM Id
-newLocalDs nm ty us loc mod_and_grp env warns
-  = case (getUnique us) of { assigned_uniq ->
-    (mkSysLocal nm assigned_uniq ty loc, warns) }
-
-newSysLocalDs      = newLocalDs SLIT("ds")
-newSysLocalsDs tys  = mapDs (newLocalDs SLIT("ds")) tys
-newFailLocalDs     = newLocalDs SLIT("fail")
+uniqSMtoDsM :: UniqSM a -> DsM a
+uniqSMtoDsM u_action = DsM(\ env warns -> 
+       u_action        `thenUs` \ res ->
+       returnUs (res, warns))
+
+    
+getUniqueDs :: DsM Unique
+getUniqueDs = DsM (\ env warns -> 
+    getUniqueUs                `thenUs` \ uniq -> 
+    returnUs (uniq, warns))
+
+getUniquesDs :: DsM [Unique]
+getUniquesDs = DsM(\ env warns -> 
+    getUniquesUs               `thenUs` \ uniqs -> 
+    returnUs (uniqs, warns))
+
+-- Make a new Id with the same print name, but different type, and new unique
+newUniqueId :: Name -> Type -> DsM Id
+newUniqueId id ty
+  = getUniqueDs        `thenDs` \ uniq ->
+    returnDs (mkSysLocal (occNameFS (nameOccName id)) uniq ty)
 
 duplicateLocalDs :: Id -> DsM Id
-duplicateLocalDs old_local us loc mod_and_grp env warns
-  = case (getUnique us) of { assigned_uniq ->
-    (mkIdWithNewUniq old_local assigned_uniq, warns) }
+duplicateLocalDs old_local 
+  = getUniqueDs        `thenDs` \ uniq ->
+    returnDs (setIdUnique old_local uniq)
 
-cloneTyVarsDs :: [TyVar] -> DsM [TyVar]
-cloneTyVarsDs tyvars us loc mod_and_grp env warns
-  = case (getUniques (length tyvars) us) of { uniqs ->
-    (zipWithEqual "cloneTyVarsDs" cloneTyVar tyvars uniqs, warns) }
+newSysLocalDs, newFailLocalDs :: Type -> DsM Id
+newSysLocalDs ty
+  = getUniqueDs        `thenDs` \ uniq ->
+    returnDs (mkSysLocal FSLIT("ds") uniq ty)
+
+newSysLocalsDs tys = mapDs newSysLocalDs tys
+
+newFailLocalDs ty 
+  = getUniqueDs        `thenDs` \ uniq ->
+    returnDs (mkSysLocal FSLIT("fail") uniq ty)
+       -- The UserLocal bit just helps make the code a little clearer
 \end{code}
 
 \begin{code}
-newTyVarsDs :: [TyVar] -> DsM [TyVar]
+cloneTyVarsDs :: [TyVar] -> DsM [TyVar]
+cloneTyVarsDs tyvars 
+  = getUniquesDs       `thenDs` \ uniqs ->
+    returnDs (zipWith setTyVarUnique tyvars uniqs)
 
-newTyVarsDs tyvar_tmpls us loc mod_and_grp env warns
-  = case (getUniques (length tyvar_tmpls) us) of { uniqs ->
-    (zipWithEqual "newTyVarsDs" cloneTyVar tyvar_tmpls uniqs, warns) }
+newTyVarsDs :: [TyVar] -> DsM [TyVar]
+newTyVarsDs tyvar_tmpls 
+  = getUniquesDs       `thenDs` \ uniqs ->
+    returnDs (zipWith setTyVarUnique tyvar_tmpls uniqs)
 \end{code}
 
 We can also reach out and either set/grab location information from
 the @SrcLoc@ being carried around.
+
 \begin{code}
-uniqSMtoDsM :: UniqSM a -> DsM a
+getDOptsDs :: DsM DynFlags
+getDOptsDs = DsM(\ env warns -> returnUs (ds_dflags env, warns))
 
-uniqSMtoDsM u_action us loc mod_and_grp env warns
-  = (u_action us, warns)
+getModuleDs :: DsM Module
+getModuleDs = DsM(\ env warns -> returnUs (ds_mod env, warns))
 
 getSrcLocDs :: DsM SrcLoc
-getSrcLocDs us loc mod_and_grp env warns
-  = (loc, warns)
+getSrcLocDs = DsM(\ env warns -> returnUs (ds_loc env, warns))
 
 putSrcLocDs :: SrcLoc -> DsM a -> DsM a
-putSrcLocDs new_loc expr us old_loc mod_and_grp env warns
-  = expr us new_loc mod_and_grp env warns
-
-dsShadowWarn :: DsMatchContext -> DsM ()
-dsShadowWarn cxt us loc mod_and_grp env warns
-  = ((), warns `snocBag` (Shadowed, cxt))
+putSrcLocDs new_loc (DsM expr) = DsM(\ env warns ->
+    expr (env { ds_loc = new_loc }) warns)
 
-dsIncompleteWarn :: DsMatchContext -> DsM ()
-dsIncompleteWarn cxt us loc mod_and_grp env warns
-  = ((), warns `snocBag` (Incomplete, cxt))
+dsWarn :: DsWarning -> DsM ()
+dsWarn warn = DsM(\ env warns -> returnUs ((), warns `snocBag` warn))
 \end{code}
 
 \begin{code}
-getModuleAndGroupDs :: DsM (FAST_STRING, FAST_STRING)
-getModuleAndGroupDs us loc mod_and_grp env warns
-  = (mod_and_grp, warns)
-\end{code}
+dsLookupGlobalId :: Name -> DsM Id
+dsLookupGlobalId name = DsM(\ env warns -> 
+       returnUs (get_id name (ds_globals env name), warns))
 
-\begin{code}
-type DsIdEnv = IdEnv Id
+dsLookupTyCon :: Name -> DsM TyCon
+dsLookupTyCon name = DsM(\ env warns -> 
+       returnUs (get_tycon name (ds_globals env name), warns))
 
-extendEnvDs :: [(Id, Id)] -> DsM a -> DsM a
+get_id name (AnId id) = id
+get_id name other     = pprPanic "dsLookupGlobalId" (ppr name)
 
-extendEnvDs pairs then_do us loc mod_and_grp old_env warns
-  = then_do us loc mod_and_grp (growIdEnvList old_env pairs) warns
+get_tycon name (ATyCon tc) = tc
+get_tycon name other       = pprPanic "dsLookupTyCon" (ppr name)
+\end{code}
+
+\begin{code}
+dsLookupMetaEnv :: Name -> DsM (Maybe DsMetaVal)
+dsLookupMetaEnv name = DsM(\ env warns -> returnUs (lookupNameEnv (ds_meta env) name, warns))
 
-lookupEnvDs :: Id -> DsM Id
-lookupEnvDs id us loc mod_and_grp env warns
-  = (case (lookupIdEnv env id) of
-      Nothing -> id
-      Just xx -> xx,
-     warns)
+dsExtendMetaEnv :: DsMetaEnv -> DsM a -> DsM a
+dsExtendMetaEnv menv (DsM m)
+  = DsM (\ env warns -> m (env { ds_meta = ds_meta env `plusNameEnv` menv }) warns)
 \end{code}
 
+
 %************************************************************************
 %*                                                                     *
-%* type synonym EquationInfo and access functions for its pieces       *
+\subsection{Type synonym @EquationInfo@ and access functions for its pieces}
 %*                                                                     *
 %************************************************************************
 
 \begin{code}
-data DsWarnFlavour = Shadowed | Incomplete deriving ()
-
 data DsMatchContext
-  = DsMatchContext DsMatchKind [TypecheckedPat] SrcLoc
+  = DsMatchContext TypecheckedMatchContext [TypecheckedPat] SrcLoc
   | NoMatchContext
   deriving ()
-
-data DsMatchKind
-  = FunMatch Id
-  | CaseMatch
-  | LambdaMatch
-  | PatBindMatch
-  | DoBindMatch
-  deriving ()
-
-pprDsWarnings :: PprStyle -> DsWarnings -> Doc
-pprDsWarnings sty warns
-  = vcat (map pp_warn (bagToList warns))
-  where
-    pp_warn (flavour, NoMatchContext) = sep [ptext SLIT("Warning: Some match is"), 
-                                              case flavour of
-                                                       Shadowed   -> ptext SLIT("shadowed")
-                                                       Incomplete -> ptext SLIT("possibly incomplete")]
-
-    pp_warn (flavour, DsMatchContext kind pats loc)
-       = hang (hcat [ppr (PprForUser opt_PprUserLength) loc, ptext SLIT(": ")])
-            4 (hang msg
-                    4 (pp_match kind pats))
-       where
-       msg = case flavour of
-               Shadowed   -> ptext SLIT("Warning: Pattern match(es) completely overlapped")     
-               Incomplete -> ptext SLIT("Warning: Possibly incomplete patterns")
-
-    pp_match (FunMatch fun) pats
-      = hsep [ptext SLIT("in the definition of function"), ppr sty fun]
-
-    pp_match CaseMatch pats
-      = hang (ptext SLIT("in a group of case alternatives beginning:"))
-       4 (ppr_pats pats)
-
-    pp_match PatBindMatch pats
-      = hang (ptext SLIT("in a pattern binding:"))
-       4 (ppr_pats pats)
-
-    pp_match LambdaMatch pats
-      = hang (ptext SLIT("in a lambda abstraction:"))
-       4 (ppr_pats pats)
-
-    pp_match DoBindMatch pats
-      = hang (ptext SLIT("in a `do' pattern binding:"))
-       4 (ppr_pats pats)
-
-    ppr_pats pats = pprQuote sty $ \ sty ->
-                   sep [sep (map (ppr sty) pats), ptext SLIT("-> ...")]
 \end{code}