[project @ 2000-10-12 16:41:48 by simonpj]
[ghc-hetmet.git] / ghc / compiler / typecheck / TcModule.lhs
index cd82d9e..2058e29 100644 (file)
@@ -11,64 +11,55 @@ module TcModule (
 
 #include "HsVersions.h"
 
-import CmdLineOpts     ( opt_D_dump_tc )
+import CmdLineOpts     ( opt_D_dump_tc, opt_D_dump_types, opt_PprStyle_Debug )
 import HsSyn           ( HsModule(..), HsBinds(..), MonoBinds(..), HsDecl(..) )
+import HsTypes         ( toHsType )
 import RnHsSyn         ( RenamedHsModule )
-import TcHsSyn         ( TcMonoBinds, TypecheckedMonoBinds, 
+import TcHsSyn         ( TypecheckedMonoBinds, 
                          TypecheckedForeignDecl, TypecheckedRuleDecl,
                          zonkTopBinds, zonkForeignExports, zonkRules
                        )
 
 import TcMonad
-import Inst            ( Inst, emptyLIE, plusLIE )
+import Inst            ( emptyLIE, plusLIE )
 import TcBinds         ( tcTopBindsAndThen )
-import TcClassDcl      ( tcClassDecls2 )
+import TcClassDcl      ( tcClassDecls2, mkImplicitClassBinds )
 import TcDefaults      ( tcDefaults )
-import TcEnv           ( tcExtendGlobalValEnv, tcExtendTypeEnv,
-                         getEnvTyCons, getEnvClasses, tcLookupValueMaybe,
-                         explicitLookupValueByKey, tcSetValueEnv,
-                         tcLookupTyCon, initEnv, 
-                         ValueEnv, TcTyThing(..)
+import TcEnv           ( tcExtendGlobalValEnv, tcLookupGlobal_maybe,
+                         tcEnvTyCons, tcEnvClasses, 
+                         tcSetEnv, tcSetInstEnv, initEnv
                        )
-import TcExpr          ( tcId )
 import TcRules         ( tcRules )
 import TcForeign       ( tcForeignImports, tcForeignExports )
 import TcIfaceSig      ( tcInterfaceSigs )
 import TcInstDcls      ( tcInstDecls1, tcInstDecls2 )
-import TcInstUtil      ( buildInstanceEnvs, classDataCon, InstInfo )
+import TcInstUtil      ( buildInstanceEnv, InstInfo )
 import TcSimplify      ( tcSimplifyTop )
 import TcTyClsDecls    ( tcTyAndClassDecls )
-import TcTyDecls       ( mkDataBinds )
-import TcType          ( TcType, typeToTcType,
-                         TcKind, kindToTcKind,
-                         newTyVarTy
-                       )
+import TcTyDecls       ( mkImplicitDataBinds )
 
-import RnMonad         ( RnNameSupply, getIfaceFixities, Fixities, InterfaceDetails )
+import CoreUnfold      ( unfoldingTemplate )
+import Type            ( funResultTy, splitForAllTys )
+import RnMonad         ( RnNameSupply, FixityEnv )
 import Bag             ( isEmptyBag )
-import ErrUtils                ( Message,
-                         pprBagOfErrors, dumpIfSet
+import ErrUtils                ( printErrorsAndWarnings, dumpIfSet )
+import Id              ( idType, idName, idUnfolding )
+import Module           ( pprModuleName, mkThisModule, plusModuleEnv )
+import Name            ( nameOccName, isLocallyDefined, isGlobalName,
+                         toRdrName, nameEnvElts, 
                        )
-import Id              ( Id, idType )
-import Module           ( pprModuleName )
-import Name            ( Name, nameUnique, isLocallyDefined, NamedThing(..) )
-import TyCon           ( TyCon, tyConKind )
-import DataCon         ( dataConId )
-import Class           ( Class, classSelIds, classTyCon )
-import Type            ( mkTyConApp, mkForAllTy,
-                         boxedTypeKind, getTyVar, Type )
-import TysWiredIn      ( unitTy )
-import PrelMods                ( mAIN_Name )
-import PrelInfo                ( main_NAME, thinAirIdNames, setThinAirIds )
-import TcUnify         ( unifyTauTy )
-import Unique          ( Unique  )
+import TyCon           ( TyCon, isDataTyCon, tyConName, tyConGenInfo )
+import OccName         ( isSysOcc )
+import TyCon           ( TyCon, isClassTyCon )
+import Class           ( Class )
+import PrelNames       ( mAIN_Name, mainKey )
 import UniqSupply       ( UniqSupply )
 import Maybes          ( maybeToBool )
 import Util
+import BasicTypes       ( EP(..) )
 import Bag             ( Bag, isEmptyBag )
 import Outputable
 
-import IOExts
 \end{code}
 
 Outside-world interface:
@@ -77,115 +68,125 @@ Outside-world interface:
 -- Convenient type synonyms first:
 data TcResults
   = TcResults {
+       tc_pcs     :: PersistentCompilerState,  -- Augmented with imported information,
+                                               -- (but not stuff from this module)
+       tc_env     :: TypeEnv,                  -- The TypeEnv just for the stuff from this module
        tc_binds   :: TypecheckedMonoBinds,
-       tc_tycons  :: [TyCon],
-       tc_classes :: [Class],
-       tc_insts   :: Bag InstInfo,             -- Instance declaration information
+       tc_insts   :: InstEnv,                  -- Instances, just for this module
        tc_fords   :: [TypecheckedForeignDecl], -- Foreign import & exports.
        tc_rules   :: [TypecheckedRuleDecl],    -- Transformation rules
-       tc_env     :: ValueEnv,
-       tc_thinair :: [Id]                      -- The thin-air Ids
     }
 
 ---------------
 typecheckModule
-       :: UniqSupply
-       -> RnNameSupply
-       -> InterfaceDetails
+       :: PersistentCompilerState
+       -> HomeSymbolTable
        -> RenamedHsModule
-       -> IO (Maybe TcResults)
+       -> IO (Maybe (PersistentCompilerState, TcResults))
+
+typecheckModule pcs hst mod
+  = do { us <- mkSplitUniqSupply 'a' ;
+
+        env <- initTcEnv global_symbol_table global_inst_env ;
 
-typecheckModule us rn_name_supply iface_det mod
-  = initTc us initEnv (tcModule rn_name_supply (getIfaceFixities iface_det) mod)
-                       >>= \ (maybe_result, warns, errs) ->
+        (maybe_result, warns, errs) <- initTc us env (tcModule (pcsPRS pcs) mod)
                
-    print_errs warns   >>
-    print_errs errs    >>
-
-    -- write the thin-air Id map
-    (case maybe_result of
-       Just results -> setThinAirIds (tc_thinair results)
-       Nothing      -> return ()
-    )                                                                  >>
-
-    dumpIfSet opt_D_dump_tc "Typechecked"
-       (case maybe_result of
-           Just results -> ppr (tc_binds results) 
-                           $$ 
-                           pp_rules (tc_rules results)
-           Nothing      -> text "Typecheck failed")    >>
-
-    return (if isEmptyBag errs then 
-               maybe_result 
-           else 
-               Nothing)
+        printErrorsAndWarnings errs warns ;
+       
+        case maybe_result of {
+           Nothing      -> return Nothing ;
+           Just results -> do { 
+
+        dumpIfSet opt_D_dump_types "Type signatures" (dump_sigs results) ;
+         dumpIfSet opt_D_dump_tc    "Typechecked"     (dump_tc   results) ;
+                       
+        if isEmptyBag errs then 
+           return Nothing 
+        else
 
-pp_rules [] = empty
-pp_rules rs = vcat [ptext SLIT("{-# RULES"),
-                   nest 4 (vcat (map ppr rs)),
-                   ptext SLIT("#-}")]
+        let    groups :: FiniteMap Module TypeEnv
+               groups = groupTyThings (nameEnvElts (tc_env results))
+
+               local_type_env :: TypeEnv
+               local_type_env = lookupWithDefaultFM groups this_mod emptyNameEnv
+
+               new_pst :: PackageSymbolTable
+               new_pst = extendTypeEnv (pcsPST pcs) (delFromFM groups this_mod)
+          ;
+        return (Just (pcs {pcsPST = new_pst}, 
+                      results {tc_env = local_type_env}))
+    }}}
+  where
+    global_symbol_table = pcsPST pcs `plusModuleEnv` hst
 
-print_errs errs
-  | isEmptyBag errs = return ()
-  | otherwise       = printErrs (pprBagOfErrors errs)
+    global_inst_env    = foldModuleEnv (plusInstEnv . instEnv) (pcsInsts pcs) gst
+       -- For now, make the total instance envt by simply
+       -- folding together all the instances we can find anywhere
 \end{code}
 
 The internal monster:
 \begin{code}
-tcModule :: RnNameSupply       -- for renaming derivings
-        -> Fixities            -- needed for Show/Read derivings.
+tcModule :: PersistentRenamerState
         -> RenamedHsModule     -- input
-        -> TcM s TcResults     -- output
+        -> TcM TcResults       -- output
 
-tcModule rn_name_supply fixities
-       (HsModule mod_name verion exports imports decls src_loc)
+tcModule prs (HsModule mod_name _ _ _ decls _ src_loc)
   = tcAddSrcLoc src_loc $      -- record where we're starting
 
     fixTc (\ ~(unf_env ,_) ->
-       -- unf_env is used for type-checking interface pragmas
+       -- (unf_env :: TcEnv) is used for type-checking interface pragmas
        -- which is done lazily [ie failure just drops the pragma
        -- without having any global-failure effect].
        -- 
-       -- unf_env is also used to get the pragam info
+       -- unf_env is also used to get the pragama info
        -- for imported dfuns and default methods
 
-           -- The knot for instance information.  This isn't used at all
-           -- till we type-check value declarations
-       fixTc ( \ ~(rec_inst_mapper, _, _, _) ->
-    
                 -- Type-check the type and class decls
-               tcTyAndClassDecls unf_env rec_inst_mapper decls `thenTc` \ env ->
-    
-                   -- Typecheck the instance decls, includes deriving
-               tcSetEnv env (
-               tcInstDecls1 unf_env decls mod_name fixities rn_name_supply
-               )                               `thenTc` \ (inst_info, deriv_binds) ->
-    
-               buildInstanceEnvs inst_info     `thenNF_Tc` \ inst_mapper ->
-    
-               returnTc (inst_mapper, env, inst_info, deriv_binds)
-    
-       -- End of inner fix loop
-       ) `thenTc` \ (_, env, inst_info, deriv_binds) ->
+       tcTyAndClassDecls unf_env decls         `thenTc` \ env ->
+       tcSetEnv env $
+
+                -- Typecheck the instance decls, includes deriving
+       tcInstDecls1 prs unf_env decls 
+                    (mkThisModule mod_name)    `thenTc` \ (inst_info, deriv_binds) ->
     
-       tcSetEnv env            (
+       buildInstanceEnv inst_info      `thenNF_Tc` \ inst_env ->
+
+       tcSetInstEnv inst_env $
+       let
+           classes      = tcEnvClasses env
+           tycons       = tcEnvTyCons env      -- INCLUDES tycons derived from classes
+           local_classes = filter isLocallyDefined classes
+           local_tycons  = [ tc | tc <- tycons,
+                                  isLocallyDefined tc,
+                                  not (isClassTyCon tc)
+                           ]
+                               -- For local_tycons, filter out the ones derived from classes
+                               -- Otherwise the latter show up in interface files
+       in
        
            -- Default declarations
        tcDefaults decls                `thenTc` \ defaulting_tys ->
        tcSetDefaultTys defaulting_tys  $
        
+       -- Interface type signatures
+       -- We tie a knot so that the Ids read out of interfaces are in scope
+       --   when we read their pragmas.
+       -- What we rely on is that pragmas are typechecked lazily; if
+       --   any type errors are found (ie there's an inconsistency)
+       --   we silently discard the pragma
+       -- We must do this before mkImplicitDataBinds (which comes next), since
+       -- the latter looks up unpackCStringId, for example, which is usually 
+       -- imported
+       tcInterfaceSigs unf_env decls           `thenTc` \ sig_ids ->
+       tcExtendGlobalValEnv sig_ids            $
+
        -- Create any necessary record selector Ids and their bindings
        -- "Necessary" includes data and newtype declarations
        -- We don't create bindings for dictionary constructors;
        -- they are always fully applied, and the bindings are just there
        -- to support partial applications
-       let
-           tycons       = getEnvTyCons env
-           classes      = getEnvClasses env
-           local_tycons  = filter isLocallyDefined tycons
-           local_classes = filter isLocallyDefined classes
-       in
-       mkDataBinds tycons              `thenTc` \ (data_ids, data_binds) ->
+       mkImplicitDataBinds tycons              `thenTc`    \ (data_ids, imp_data_binds) ->
+       mkImplicitClassBinds classes            `thenNF_Tc` \ (cls_ids,  imp_cls_binds) ->
        
        -- Extend the global value environment with 
        --      (a) constructors
@@ -194,30 +195,11 @@ tcModule rn_name_supply fixities
        --      (d) default-method ids... where? I can't see where these are
        --          put into the envt, and I'm worried that the zonking phase
        --          will find they aren't there and complain.
-       tcExtendGlobalValEnv data_ids                           $
-       tcExtendGlobalValEnv (concat (map classSelIds classes)) $
-
-       -- Extend the TyCon envt with the tycons corresponding to
-       -- the classes, and the global value environment with the
-       -- corresponding data cons.
-       --  They are mentioned in types in interface files.
-       tcExtendGlobalValEnv (map (dataConId . classDataCon) classes)           $
-        tcExtendTypeEnv [ (getName tycon, (kindToTcKind (tyConKind tycon), Nothing, ATyCon tycon))
-                       | clas <- classes,
-                         let tycon = classTyCon clas
-                       ]                               $
-
-           -- Interface type signatures
-           -- We tie a knot so that the Ids read out of interfaces are in scope
-           --   when we read their pragmas.
-           -- What we rely on is that pragmas are typechecked lazily; if
-           --   any type errors are found (ie there's an inconsistency)
-           --   we silently discard the pragma
-       tcInterfaceSigs unf_env decls           `thenTc` \ sig_ids ->
-       tcExtendGlobalValEnv sig_ids            $
+       tcExtendGlobalValEnv data_ids           $
+       tcExtendGlobalValEnv cls_ids            $
 
            -- foreign import declarations next.
-       tcForeignImports decls          `thenTc`    \ (fo_ids, foi_decls) ->
+       tcForeignImports decls                  `thenTc`    \ (fo_ids, foi_decls) ->
        tcExtendGlobalValEnv fo_ids             $
 
        -- Value declarations next.
@@ -226,7 +208,6 @@ tcModule rn_name_supply fixities
            (\ is_rec binds1 (binds2, thing) -> (binds1 `AndMonoBinds` binds2, thing))
            (get_val_decls decls `ThenBinds` deriv_binds)
            (   tcGetEnv                                `thenNF_Tc` \ env ->
-               tcGetUnique                             `thenNF_Tc` \ uniq ->
                returnTc ((EmptyMonoBinds, env), emptyLIE)
            )                           `thenTc` \ ((val_binds, final_env), lie_valdecls) ->
        tcSetEnv final_env $
@@ -237,7 +218,7 @@ tcModule rn_name_supply fixities
                -- Second pass over class and instance declarations,
                -- to compile the bindings themselves.
        tcInstDecls2  inst_info         `thenNF_Tc` \ (lie_instdecls, inst_binds) ->
-       tcClassDecls2 decls             `thenNF_Tc` \ (lie_clasdecls, cls_binds) ->
+       tcClassDecls2 decls             `thenNF_Tc` \ (lie_clasdecls, cls_dm_binds) ->
        tcRules decls                   `thenNF_Tc` \ (lie_rules,     rules) ->
 
 
@@ -258,8 +239,10 @@ tcModule rn_name_supply fixities
 
                -- Check that Main defines main
        (if mod_name == mAIN_Name then
-               tcLookupValueMaybe main_NAME    `thenNF_Tc` \ maybe_main ->
-               checkTc (maybeToBool maybe_main) noMainErr
+               tcLookupGlobal_maybe mainName           `thenNF_Tc` \ maybe_main ->
+               case maybe_main of
+                  Just (AnId _) -> returnTc ()
+                  other         -> addErrTc noMainErr
         else
                returnTc ()
        )                                       `thenTc_`
@@ -267,35 +250,28 @@ tcModule rn_name_supply fixities
            -- Backsubstitution.    This must be done last.
            -- Even tcSimplifyTop may do some unification.
        let
-           all_binds = data_binds              `AndMonoBinds` 
+           all_binds = imp_data_binds          `AndMonoBinds` 
+                       imp_cls_binds           `AndMonoBinds` 
                        val_binds               `AndMonoBinds`
                        inst_binds              `AndMonoBinds`
-                       cls_binds               `AndMonoBinds`
+                       cls_dm_binds            `AndMonoBinds`
                        const_inst_binds        `AndMonoBinds`
                        foe_binds
        in
        zonkTopBinds all_binds          `thenNF_Tc` \ (all_binds', really_final_env)  ->
-       tcSetValueEnv really_final_env  $
+       tcSetEnv really_final_env       $
+               -- zonkTopBinds puts all the top-level Ids into the tcGEnv
+
        zonkForeignExports foe_decls    `thenNF_Tc` \ foe_decls' ->
        zonkRules rules                 `thenNF_Tc` \ rules' ->
 
-       let
-          thin_air_ids = map (explicitLookupValueByKey really_final_env . nameUnique) thinAirIdNames
-               -- When looking up the thin-air names we must use
-               -- a global env that includes the zonked locally-defined Ids too
-               -- Hence using really_final_env
-       in
        returnTc (really_final_env, 
-                 (TcResults {  tc_binds   = all_binds', 
-                               tc_tycons  = local_tycons,
-                               tc_classes = local_classes,
+                 (TcResults {  tc_env     = tcGEnv really_final_env,
+                               tc_binds   = all_binds', 
                                tc_insts   = inst_info,
                                tc_fords   = foi_decls ++ foe_decls',
-                               tc_rules   = rules',
-                               tc_env     = really_final_env,
-                               tc_thinair = thin_air_ids
+                               tc_rules   = rules'
                 }))
-       )
 
     -- End of outer fix loop
     ) `thenTc` \ (final_env, stuff) ->
@@ -308,6 +284,63 @@ get_val_decls decls = foldr ThenBinds EmptyBinds [binds | ValD binds <- decls]
 \begin{code}
 noMainErr
   = hsep [ptext SLIT("Module"), quotes (pprModuleName mAIN_Name), 
-         ptext SLIT("must include a definition for"), quotes (ppr main_NAME)]
+         ptext SLIT("must include a definition for"), quotes (ptext SLIT("main"))]
 \end{code}
 
+
+%************************************************************************
+%*                                                                     *
+\subsection{Dumping output}
+%*                                                                     *
+%************************************************************************
+
+\begin{code}
+dump_tc results
+  = vcat [ppr (tc_binds results),
+         pp_rules (tc_rules results),
+         ppr_gen_tycons (tc_tycons results)
+    ]
+
+dump_sigs results      -- Print type signatures
+  =    -- Convert to HsType so that we get source-language style printing
+       -- And sort by RdrName
+    vcat $ map ppr_sig $ sortLt lt_sig $
+    [(toRdrName id, toHsType (idType id)) | id <- nameEnvElts (tc_env results), 
+                                           want_sig id
+    ]
+  where
+    lt_sig (n1,_) (n2,_) = n1 < n2
+    ppr_sig (n,t)        = ppr n <+> dcolon <+> ppr t
+
+    want_sig id | opt_PprStyle_Debug = True
+               | otherwise          = isLocallyDefined n && 
+                                      isGlobalName n && 
+                                      not (isSysOcc (nameOccName n))
+                                    where
+                                      n = idName id
+
+ppr_gen_tycons tcs = vcat [ptext SLIT("{-# Generic type constructor details"),
+                          vcat (map ppr_gen_tycon (filter isLocallyDefined tcs)),
+                          ptext SLIT("#-}")
+                    ]
+
+-- x&y are now Id's, not CoreExpr's 
+ppr_gen_tycon tycon 
+  | Just ep <- tyConGenInfo tycon
+  = (ppr tycon <> colon) $$ nest 4 (ppr_ep ep)
+
+  | otherwise = ppr tycon <> colon <+> ptext SLIT("Not derivable")
+
+ppr_ep (EP from to)
+  = vcat [ ptext SLIT("Rep type:") <+> ppr (funResultTy from_tau),
+          ptext SLIT("From:") <+> ppr (unfoldingTemplate (idUnfolding from)),
+          ptext SLIT("To:")   <+> ppr (unfoldingTemplate (idUnfolding to))
+    ]
+  where
+    (_,from_tau) = splitForAllTys (idType from)
+
+pp_rules [] = empty
+pp_rules rs = vcat [ptext SLIT("{-# RULES"),
+                   nest 4 (vcat (map ppr rs)),
+                   ptext SLIT("#-}")]
+\end{code}