[project @ 2000-08-30 03:01:48 by kglynn]
[ghc-hetmet.git] / ghc / compiler / typecheck / TcModule.lhs
index 517e8b2..34a82d1 100644 (file)
 \begin{code}
 module TcModule (
        typecheckModule,
-       TcResults
+       TcResults(..)
     ) where
 
 #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, zonkTopBinds,
-                         TypecheckedForeignDecl, zonkForeignExports
+import TcHsSyn         ( TcMonoBinds, TypecheckedMonoBinds, 
+                         TypecheckedForeignDecl, TypecheckedRuleDecl,
+                         zonkTopBinds, zonkForeignExports, zonkRules
                        )
 
 import TcMonad
 import Inst            ( 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(..)
+                         getEnvTyCons, getEnvClasses, tcLookupValueByKeyMaybe,
+                         tcSetValueEnv, tcSetInstEnv,
+                         initEnv, 
+                         ValueEnv, 
                        )
-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
-                       )
+import TcTyDecls       ( mkImplicitDataBinds )
+import TcType          ( TcType, TcKind )
 
-import RnMonad         ( RnNameSupply )
+import RnMonad         ( RnNameSupply, FixityEnv )
 import Bag             ( isEmptyBag )
-import ErrUtils                ( ErrMsg, 
-                         pprBagOfErrors, dumpIfSet
+import ErrUtils                ( Message, printErrorsAndWarnings, dumpIfSet )
+import Id              ( Id, idType, idName )
+import Module           ( pprModuleName, mkThisModule )
+import OccName         ( isSysOcc )
+import Name            ( Name, nameUnique, nameOccName, isLocallyDefined, 
+                         toRdrName, nameEnvElts, NamedThing(..)
                        )
-import Id              ( Id, idType )
-import Name            ( Name, nameUnique, isLocallyDefined, pprModule, NamedThing(..) )
-import TyCon           ( TyCon, tyConKind )
-import DataCon         ( dataConId )
+import TyCon           ( TyCon, tyConKind, tyConClass_maybe )
 import Class           ( Class, classSelIds, classTyCon )
-import Type            ( mkTyConApp, Type )
-import TysWiredIn      ( unitTy )
-import PrelMods                ( mAIN )
-import PrelInfo                ( main_NAME, ioTyCon_NAME,
-                         thinAirIdNames, setThinAirIds
-                       )
-import TcUnify         ( unifyTauTy )
-import Unique          ( Unique  )
+import PrelInfo                ( mAIN_Name )
+import Unique          ( Unique, mainKey )
 import UniqSupply       ( UniqSupply )
+import Maybes          ( maybeToBool )
 import Util
 import Bag             ( Bag, isEmptyBag )
 import Outputable
-
-import IOExts
 \end{code}
 
 Outside-world interface:
 \begin{code}
 
 -- Convenient type synonyms first:
-type TcResults
-  = (TypecheckedMonoBinds,
-     [TyCon], [Class],
-     Bag InstInfo,             -- Instance declaration information
-     [TypecheckedForeignDecl], -- foreign import & exports.
-     ValueEnv,
-     [Id]                      -- The thin-air Ids
-     )
+data TcResults
+  = TcResults {
+       tc_binds   :: TypecheckedMonoBinds,
+       tc_tycons  :: [TyCon],
+       tc_classes :: [Class],
+       tc_insts   :: Bag InstInfo,             -- Instance declaration information
+       tc_fords   :: [TypecheckedForeignDecl], -- Foreign import & exports.
+       tc_rules   :: [TypecheckedRuleDecl],    -- Transformation rules
+       tc_env     :: ValueEnv
+    }
 
 ---------------
 typecheckModule
        :: UniqSupply
        -> RnNameSupply
+       -> FixityEnv
        -> RenamedHsModule
        -> IO (Maybe TcResults)
 
-typecheckModule us rn_name_supply mod
-  = initTc us initEnv (tcModule rn_name_supply mod)    >>= \ (maybe_result, warns, errs) ->
+typecheckModule us rn_name_supply fixity_env mod
+  = initTc us initEnv (tcModule rn_name_supply fixity_env mod)         >>= \ (maybe_result, warns, errs) ->
                
-    print_errs warns   >>
-    print_errs errs    >>
-
-    -- write the thin-air Id map
+    printErrorsAndWarnings errs warns          >>
+       
     (case maybe_result of
-       Just (_, _, _, _, _, _, thin_air_ids) -> setThinAirIds thin_air_ids
-       Nothing                               -> return ()
-    )                                                                  >>
-
-    dumpIfSet opt_D_dump_tc "Typechecked"
-       (case maybe_result of
-           Just (binds, _, _, _, _, _, _) -> ppr binds
-           Nothing                       -> text "Typecheck failed")   >>
-
+       Nothing -> return ()
+       Just results -> dumpIfSet opt_D_dump_types "Type signatures" (dump_sigs results) >>
+                       dumpIfSet opt_D_dump_tc    "Typechecked"     (dump_tc   results)
+    )                                          >>
+                       
     return (if isEmptyBag errs then 
                maybe_result 
            else 
                Nothing)
 
-print_errs errs
-  | isEmptyBag errs = return ()
-  | otherwise       = printErrs (pprBagOfErrors errs)
+dump_tc results
+  = ppr (tc_binds results) $$ pp_rules (tc_rules 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 && not (isSysOcc (nameOccName n))
+                                    where
+                                      n = idName id
+
+pp_rules [] = empty
+pp_rules rs = vcat [ptext SLIT("{-# RULES"),
+                   nest 4 (vcat (map ppr rs)),
+                   ptext SLIT("#-}")]
 \end{code}
 
 The internal monster:
 \begin{code}
 tcModule :: RnNameSupply       -- for renaming derivings
+        -> FixityEnv           -- needed for Show/Read derivings.
         -> RenamedHsModule     -- input
         -> TcM s TcResults     -- output
 
-tcModule rn_name_supply
-       (HsModule mod_name verion exports imports decls src_loc)
+tcModule rn_name_supply fixities
+       (HsModule mod_name _ _ _ decls _ src_loc)
   = tcAddSrcLoc src_loc $      -- record where we're starting
 
     fixTc (\ ~(unf_env ,_) ->
@@ -132,43 +144,54 @@ tcModule rn_name_supply
        -- unf_env is also used to get the pragam 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 rn_name_supply
-               )                               `thenTc` \ (inst_info, deriv_binds) ->
+       tcTyAndClassDecls unf_env decls `thenTc` \ env ->
     
-               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) ->
+                -- Typecheck the instance decls, includes deriving
+       tcSetEnv env $
+
+       tcInstDecls1 unf_env decls 
+                    (mkThisModule mod_name)
+                    fixities rn_name_supply    `thenTc` \ (inst_info, deriv_binds) ->
     
-       tcSetEnv env            (
+       buildInstanceEnv inst_info      `thenNF_Tc` \ inst_env ->
+
+       tcSetInstEnv inst_env $
+       let
+           classes      = getEnvClasses env
+           tycons       = getEnvTyCons env     -- INCLUDES tycons derived from classes
+           local_classes = filter isLocallyDefined classes
+           local_tycons  = [ tc | tc <- tycons,
+                                  isLocallyDefined tc,
+                                  Nothing <- [tyConClass_maybe 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
@@ -177,27 +200,8 @@ tcModule rn_name_supply
        --      (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) ->
@@ -220,10 +224,9 @@ tcModule rn_name_supply
                -- 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) ->
 
-       -- Check that "main" has the right signature
-       tcCheckMainSig mod_name         `thenTc_` 
 
             -- Deal with constant or ambiguous InstIds.  How could
             -- there be ambiguous ones?  They can only arise if a
@@ -235,37 +238,44 @@ tcModule rn_name_supply
            lie_alldecls = lie_valdecls  `plusLIE`
                           lie_instdecls `plusLIE`
                           lie_clasdecls `plusLIE`
-                          lie_fodecls
+                          lie_fodecls   `plusLIE`
+                          lie_rules
        in
        tcSimplifyTop lie_alldecls                      `thenTc` \ const_inst_binds ->
 
+               -- Check that Main defines main
+       (if mod_name == mAIN_Name then
+               tcLookupValueByKeyMaybe mainKey         `thenNF_Tc` \ maybe_main ->
+               checkTc (maybeToBool maybe_main) noMainErr
+        else
+               returnTc ()
+       )                                       `thenTc_`
 
            -- Backsubstitution.    This must be done last.
-           -- Even tcCheckMainSig and tcSimplifyTop may do some unification.
+           -- 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  $
-       zonkForeignExports foe_decls    `thenNF_Tc` \ foe_decls' ->
+       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, 
-                 (all_binds', local_tycons, local_classes, inst_info,
-                  foi_decls ++ foe_decls',
-                  really_final_env,
-                  thin_air_ids))
-       )
+                 (TcResults {  tc_binds   = all_binds', 
+                               tc_tycons  = local_tycons,
+                               tc_classes = local_classes,
+                               tc_insts   = inst_info,
+                               tc_fords   = foi_decls ++ foe_decls',
+                               tc_rules   = rules',
+                               tc_env     = really_final_env
+                }))
 
     -- End of outer fix loop
     ) `thenTc` \ (final_env, stuff) ->
@@ -276,42 +286,8 @@ get_val_decls decls = foldr ThenBinds EmptyBinds [binds | ValD binds <- decls]
 
 
 \begin{code}
-tcCheckMainSig mod_name
-  | mod_name /= mAIN
-  = returnTc ()                -- A non-main module
-
-  | otherwise
-  =    -- Check that main is defined
-    tcLookupTyCon ioTyCon_NAME         `thenTc`    \ ioTyCon ->
-    tcLookupValueMaybe main_NAME       `thenNF_Tc` \ maybe_main_id ->
-    case maybe_main_id of {
-       Nothing  -> failWithTc noMainErr ;
-       Just main_id   ->
-
-       -- Check that it has the right type (or a more general one)
-    let 
-       expected_tau = typeToTcType (mkTyConApp ioTyCon [unitTy])
-    in
-    tcId main_NAME                             `thenNF_Tc` \ (_, lie, main_tau) ->
-    tcSetErrCtxt mainTyCheckCtxt $
-    unifyTauTy expected_tau
-              main_tau                 `thenTc_`
-    checkTc (isEmptyBag lie) (mainTyMisMatch expected_tau (idType main_id))
-    }
-
-
-mainTyCheckCtxt
-  = hsep [ptext SLIT("When checking that"), ppr main_NAME, ptext SLIT("has the required type")]
-
 noMainErr
-  = hsep [ptext SLIT("Module"), quotes (pprModule mAIN), 
-         ptext SLIT("must include a definition for"), quotes (ppr main_NAME)]
-
-mainTyMisMatch :: TcType -> TcType -> ErrMsg
-mainTyMisMatch expected actual
-  = hang (hsep [ppr main_NAME, ptext SLIT("has the wrong type")])
-        4 (vcat [
-                       hsep [ptext SLIT("Expected:"), ppr expected],
-                       hsep [ptext SLIT("Inferred:"), ppr actual]
-                    ])
+  = hsep [ptext SLIT("Module"), quotes (pprModuleName mAIN_Name), 
+         ptext SLIT("must include a definition for"), quotes (ptext SLIT("main"))]
 \end{code}
+