[project @ 2002-02-27 15:53:46 by simonpj]
[ghc-hetmet.git] / ghc / compiler / main / MkIface.lhs
index 8cbf484..bce2bb3 100644 (file)
@@ -7,7 +7,8 @@
 \begin{code}
 module MkIface ( 
        mkFinalIface,
-       pprModDetails, pprIface, pprUsage
+       pprModDetails, pprIface, pprUsage,
+       ifaceTyThing,
   ) where
 
 #include "HsVersions.h"
@@ -15,18 +16,20 @@ module MkIface (
 import HsSyn
 import HsCore          ( HsIdInfo(..), UfExpr(..), toUfExpr, toUfBndr )
 import HsTypes         ( toHsTyVars )
-import BasicTypes      ( Fixity(..), NewOrData(..),
-                         Version, initialVersion, bumpVersion, 
+import TysPrim         ( alphaTyVars )
+import BasicTypes      ( NewOrData(..), Activation(..),
+                         Version, initialVersion, bumpVersion 
                        )
+import NewDemand       ( isTopSig )
 import RnMonad
 import RnHsSyn         ( RenamedInstDecl, RenamedTyClDecl )
 import HscTypes                ( VersionInfo(..), ModIface(..), ModDetails(..),
-                         ModuleLocation(..), GhciMode(..),
+                         ModuleLocation(..), GhciMode(..), FixityEnv, lookupFixity,
                          IfaceDecls, mkIfaceDecls, dcl_tycl, dcl_rules, dcl_insts,
-                         TyThing(..), DFunId, Avails,
+                         TyThing(..), DFunId, Avails, TypeEnv,
                          WhatsImported(..), GenAvailInfo(..), 
                          ImportVersion, AvailInfo, Deprecations(..),
-                         lookupVersion,
+                         lookupVersion, typeEnvIds
                        )
 
 import CmdLineOpts
@@ -35,7 +38,8 @@ import Id             ( idType, idInfo, isImplicitId, idCgInfo,
                        )
 import DataCon         ( dataConId, dataConSig, dataConFieldLabels, dataConStrictMarks )
 import IdInfo          -- Lots
-import CoreSyn         ( CoreRule(..) )
+import Var              ( Var )
+import CoreSyn         ( CoreRule(..), IdCoreRule )
 import CoreFVs         ( ruleLhsFreeNames )
 import CoreUnfold      ( neverUnfold, unfoldingTemplate )
 import PprCore         ( pprIdCoreRule )
@@ -44,20 +48,18 @@ import Name         ( getName, nameModule, toRdrName, isGlobalName,
 import NameEnv
 import NameSet
 import OccName         ( pprOccName )
-import TyCon           ( TyCon, getSynTyConDefn, isSynTyCon, isNewTyCon, isAlgTyCon, tyConGenIds,
-                         tyConTheta, tyConTyVars, tyConDataCons, tyConFamilySize, 
-                         isClassTyCon, isForeignTyCon
-                       )
+import TyCon
 import Class           ( classExtraBigSig, classTyCon, DefMeth(..) )
 import FieldLabel      ( fieldLabelType )
-import Type            ( splitSigmaTy, tidyTopType, deNoteType, namesOfDFunHead )
+import TcType          ( tcSplitSigmaTy, tidyTopType, deNoteType, namesOfDFunHead )
 import SrcLoc          ( noSrcLoc )
 import Outputable
 import Module          ( ModuleName )
-import Util            ( sortLt )
+import Util            ( sortLt, dropList )
 import ErrUtils                ( dumpIfSet_dyn )
 
 import Monad           ( when )
+import Maybe           ( catMaybes )
 import IO              ( IOMode(..), openFile, hClose )
 \end{code}
 
@@ -83,15 +85,18 @@ mkFinalIface :: GhciMode
 --     a) completes the interface
 --     b) writes it out to a file if necessary
 
-mkFinalIface ghci_mode dflags location 
-            maybe_old_iface new_iface new_details
+mkFinalIface ghci_mode dflags location maybe_old_iface 
+       new_iface@ModIface{ mi_module=mod }
+       new_details@ModDetails{ md_insts=insts, 
+                               md_rules=rules,
+                               md_types=types }
   = do { 
                -- Add the new declarations, and the is-orphan flag
          let iface_w_decls = new_iface { mi_decls = new_decls,
                                          mi_orphan = orphan_mod }
 
                -- Add version information
-       ; let (final_iface, maybe_diffs) = addVersionInfo maybe_old_iface iface_w_decls
+       ; let (final_iface, maybe_diffs) = _scc_ "versioninfo" addVersionInfo maybe_old_iface iface_w_decls
 
                -- Write the interface file, if necessary
        ; when (must_write_hi_file maybe_diffs)
@@ -100,11 +105,12 @@ mkFinalIface ghci_mode dflags location
                -- Debug printing
        ; write_diffs dflags final_iface maybe_diffs
 
-       ; return final_iface }
+       ; orphan_mod `seq`
+         return final_iface }
 
   where
-     must_write_hi_file Nothing      = False
-     must_write_hi_file (Just diffs) = ghci_mode /= Interactive
+     must_write_hi_file Nothing       = False
+     must_write_hi_file (Just _diffs) = ghci_mode /= Interactive
                -- We must write a new .hi file if there are some changes
                -- and we're not in interactive mode
                -- maybe_diffs = 'Nothing' means that even the usages havn't changed, 
@@ -113,11 +119,12 @@ mkFinalIface ghci_mode dflags location
 
      hi_file_path = ml_hi_file location
      new_decls    = mkIfaceDecls ty_cls_dcls rule_dcls inst_dcls
-     inst_dcls    = map ifaceInstance (md_insts new_details)
-     ty_cls_dcls  = foldNameEnv ifaceTyCls [] (md_types new_details)
-     rule_dcls    = map ifaceRule (md_rules new_details)
-     orphan_mod   = isOrphanModule (mi_module new_iface) new_details
+     inst_dcls    = map ifaceInstance insts
+     ty_cls_dcls  = foldNameEnv ifaceTyThing_acc [] types
+     rule_dcls    = map ifaceRule rules
+     orphan_mod   = isOrphanModule mod new_details
 
+write_diffs :: DynFlags -> ModIface -> Maybe SDoc -> IO ()
 write_diffs dflags new_iface Nothing
   = do when (dopt Opt_D_dump_hi_diffs dflags) (printDump (text "INTERFACE UNCHANGED"))
        dumpIfSet_dyn dflags Opt_D_dump_hi "UNCHANGED FINAL INTERFACE" (pprIface new_iface)
@@ -128,18 +135,34 @@ write_diffs dflags new_iface (Just sdoc_diffs)
 \end{code}
 
 \begin{code}
+isOrphanModule :: Module -> ModDetails -> Bool
 isOrphanModule this_mod (ModDetails {md_insts = insts, md_rules = rules})
   = any orphan_inst insts || any orphan_rule rules
   where
+       -- A rule is an orphan if the LHS mentions nothing defined locally
     orphan_inst dfun_id = no_locals (namesOfDFunHead (idType dfun_id))
+       -- A instance is an orphan if its head mentions nothing defined locally
     orphan_rule rule    = no_locals (ruleLhsFreeNames rule)
+
     no_locals names     = isEmptyNameSet (filterNameSet (nameIsLocalOrFrom this_mod) names)
 \end{code}
 
+Implicit Ids and class tycons aren't included in interface files, so
+we miss them out of the accumulating parameter here.
+
+\begin{code}
+ifaceTyThing_acc :: TyThing -> [RenamedTyClDecl] -> [RenamedTyClDecl]
+ifaceTyThing_acc (AnId   id) so_far | isImplicitId id = so_far
+ifaceTyThing_acc (ATyCon id) so_far | isClassTyCon id = so_far
+ifaceTyThing_acc other so_far = ifaceTyThing other : so_far
+\end{code}
+
+Convert *any* TyThing into a RenamedTyClDecl.  Used both for
+generating interface files and for the ':info' command in GHCi.
+
 \begin{code}
-ifaceTyCls :: TyThing -> [RenamedTyClDecl] -> [RenamedTyClDecl]
-ifaceTyCls (AClass clas) so_far
-  = cls_decl : so_far
+ifaceTyThing :: TyThing -> RenamedTyClDecl
+ifaceTyThing (AClass clas) = cls_decl
   where
     cls_decl = ClassDecl { tcdCtxt     = toHsContext sc_theta,
                           tcdName      = getName clas,
@@ -160,15 +183,13 @@ ifaceTyCls (AClass clas) so_far
        = ASSERT(sel_tyvars == clas_tyvars)
          ClassOpSig (getName sel_id) def_meth' (toHsType op_ty) noSrcLoc
        where
-         (sel_tyvars, _, op_ty) = splitSigmaTy (idType sel_id)
+         (sel_tyvars, _, op_ty) = tcSplitSigmaTy (idType sel_id)
          def_meth' = case def_meth of
                         NoDefMeth  -> NoDefMeth
                         GenDefMeth -> GenDefMeth
                         DefMeth id -> DefMeth (getName id)
 
-ifaceTyCls (ATyCon tycon) so_far
-  | isClassTyCon tycon = so_far
-  | otherwise         = ty_decl : so_far
+ifaceTyThing (ATyCon tycon) = ty_decl
   where
     ty_decl | isSynTyCon tycon
            = TySynonym { tcdName   = getName tycon,
@@ -181,24 +202,39 @@ ifaceTyCls (ATyCon tycon) so_far
                        tcdCtxt   = toHsContext (tyConTheta tycon),
                        tcdName   = getName tycon,
                        tcdTyVars = toHsTyVars tyvars,
-                       tcdCons   = map ifaceConDecl (tyConDataCons tycon),
-                       tcdNCons  = tyConFamilySize tycon,
+                       tcdCons   = ifaceConDecls (tyConDataConDetails tycon),
                        tcdDerivs = Nothing,
                        tcdSysNames  = map getName (tyConGenIds tycon),
                        tcdLoc       = noSrcLoc }
 
            | isForeignTyCon tycon
-           = ForeignType { tcdName   = getName tycon,
-                           tcdFoType = DNType, -- The only case at present
-                           tcdLoc    = noSrcLoc }
+           = ForeignType { tcdName    = getName tycon,
+                           tcdExtName = Nothing,
+                           tcdFoType  = DNType,        -- The only case at present
+                           tcdLoc     = noSrcLoc }
+
+           | isPrimTyCon tycon || isFunTyCon tycon
+               -- needed in GHCi for ':info Int#', for example
+           = TyData {  tcdND     = DataType,
+                       tcdCtxt   = [],
+                       tcdName   = getName tycon,
+                       tcdTyVars = toHsTyVars (take (tyConArity tycon) alphaTyVars),
+                       tcdCons   = Unknown,
+                       tcdDerivs = Nothing,
+                       tcdSysNames  = [],
+                       tcdLoc       = noSrcLoc }
 
-           | otherwise = pprPanic "ifaceTyCls" (ppr tycon)
+           | otherwise = pprPanic "ifaceTyThing" (ppr tycon)
 
     tyvars      = tyConTyVars tycon
     (_, syn_ty) = getSynTyConDefn tycon
     new_or_data | isNewTyCon tycon = NewType
                | otherwise        = DataType
 
+    ifaceConDecls Unknown       = Unknown
+    ifaceConDecls (HasCons n)   = HasCons n
+    ifaceConDecls (DataCons cs) = DataCons (map ifaceConDecl cs)
+
     ifaceConDecl data_con 
        = ConDecl (getName data_con) (getName (dataConId data_con))
                  (toHsTyVars ex_tyvars)
@@ -207,7 +243,7 @@ ifaceTyCls (ATyCon tycon) so_far
        where
          (tyvars1, _, ex_tyvars, ex_theta, arg_tys, tycon1) = dataConSig data_con
           field_labels   = dataConFieldLabels data_con
-          strict_marks   = drop (length ex_theta) (dataConStrictMarks data_con)
+          strict_marks   = dropList ex_theta (dataConStrictMarks data_con)
                                -- The 'drop' is because dataConStrictMarks
                                -- includes the existential dictionaries
          details | null field_labels
@@ -220,9 +256,7 @@ ifaceTyCls (ATyCon tycon) so_far
     mk_field strict_mark field_label
        = ([getName field_label], BangType strict_mark (toHsType (fieldLabelType field_label)))
 
-ifaceTyCls (AnId id) so_far
-  | isImplicitId id = so_far
-  | otherwise      = iface_sig : so_far
+ifaceTyThing (AnId id) = iface_sig
   where
     iface_sig = IfaceSig { tcdName   = getName id, 
                           tcdType   = toHsType id_type,
@@ -232,39 +266,38 @@ ifaceTyCls (AnId id) so_far
     id_type = idType id
     id_info = idInfo id
     cg_info = idCgInfo id
-    arity_info = cgArity cg_info
+    arity_info = arityInfo id_info
     caf_info   = cgCafInfo cg_info
 
-    hs_idinfo | opt_OmitInterfacePragmas = []
-             | otherwise                = arity_hsinfo  ++ caf_hsinfo  ++ cpr_hsinfo ++ 
-                                          strict_hsinfo ++ wrkr_hsinfo ++ unfold_hsinfo
+    hs_idinfo | opt_OmitInterfacePragmas
+             = []
+             | otherwise
+             = catMaybes [arity_hsinfo,  caf_hsinfo,
+                          strict_hsinfo, wrkr_hsinfo,
+                          unfold_hsinfo] 
 
     ------------  Arity  --------------
-    arity_hsinfo | arity_info == 0 = []
-                | otherwise       = [HsArity arity_info]
+    arity_hsinfo | arity_info == 0 = Nothing
+                | otherwise       = Just (HsArity arity_info)
 
     ------------ Caf Info --------------
     caf_hsinfo = case caf_info of
-                  NoCafRefs -> [HsNoCafRefs]
-                  otherwise -> []
-
-    ------------ CPR Info --------------
-    cpr_hsinfo = case cprInfo id_info of
-                  ReturnsCPR -> [HsCprInfo]
-                  NoCPRInfo  -> []
+                  NoCafRefs -> Just HsNoCafRefs
+                  _other    -> Nothing
 
     ------------  Strictness  --------------
-    strict_hsinfo = case strictnessInfo id_info of
-                       NoStrictnessInfo -> []
-                       info             -> [HsStrictness info]
+       -- No point in explicitly exporting TopSig
+    strict_hsinfo = case newStrictnessInfo id_info of
+                       Just sig | not (isTopSig sig) -> Just (HsStrictness sig)
+                       _other                        -> Nothing
 
     ------------  Worker  --------------
     work_info   = workerInfo id_info
     has_worker  = case work_info of { HasWorker _ _ -> True; other -> False }
     wrkr_hsinfo = case work_info of
                    HasWorker work_id wrap_arity -> 
-                       [HsWorker (getName work_id) wrap_arity]
-                   NoWorker -> []
+                       Just (HsWorker (getName work_id) wrap_arity)
+                   NoWorker -> Nothing
 
     ------------  Unfolding  --------------
        -- The unfolding is redundant if there is a worker
@@ -272,8 +305,8 @@ ifaceTyCls (AnId id) so_far
     inline_prag = inlinePragInfo id_info
     rhs                = unfoldingTemplate unfold_info
     unfold_hsinfo |  neverUnfold unfold_info 
-                 || has_worker = []
-                 | otherwise   = [HsUnfold inline_prag (toUfExpr rhs)]
+                 || has_worker = Nothing
+                 | otherwise   = Just (HsUnfold inline_prag (toUfExpr rhs))
 \end{code}
 
 \begin{code}
@@ -292,15 +325,17 @@ ifaceInstance dfun_id
                -- and this instance decl wouldn't get imported into a module
                -- that mentioned T but not Tibble.
 
-ifaceRule (id, BuiltinRule _)
+ifaceRule :: IdCoreRule -> RuleDecl Name pat
+ifaceRule (id, BuiltinRule _ _)
   = pprTrace "toHsRule: builtin" (ppr id) (bogusIfaceRule id)
 
-ifaceRule (id, Rule name bndrs args rhs)
-  = IfaceRule name (map toUfBndr bndrs) (getName id)
+ifaceRule (id, Rule name act bndrs args rhs)
+  = IfaceRule name act (map toUfBndr bndrs) (getName id)
              (map toUfExpr args) (toUfExpr rhs) noSrcLoc
 
+bogusIfaceRule :: (NamedThing a) => a -> RuleDecl Name pat
 bogusIfaceRule id
-  = IfaceRule SLIT("bogus") [] (getName id) [] (UfVar (getName id)) noSrcLoc
+  = IfaceRule SLIT("bogus") NeverActive [] (getName id) [] (UfVar (getName id)) noSrcLoc
 \end{code}
 
 
@@ -371,7 +406,7 @@ addVersionInfo (Just old_iface@(ModIface { mi_version  = old_version,
     pp_change False what = text what <+> ptext SLIT("changed")
 
 diffDecls :: VersionInfo                               -- Old version
-         -> NameEnv Fixity -> NameEnv Fixity           -- Old and new fixities
+         -> FixityEnv -> FixityEnv                     -- Old and new fixities
          -> [RenamedTyClDecl] -> [RenamedTyClDecl]     -- Old and new decls
          -> (Bool,             -- True <=> no change
              SDoc,             -- Record of differences
@@ -384,7 +419,7 @@ diffDecls (VersionInfo { vers_module = old_mod_vers, vers_decls = old_decls_vers
        -- When seeing if two decls are the same, 
        -- remember to check whether any relevant fixity has changed
     eq_tc  d1 d2 = d1 == d2 && all (same_fixity . fst) (tyClDeclNames d1)
-    same_fixity n = lookupNameEnv old_fixities n == lookupNameEnv new_fixities n
+    same_fixity n = lookupFixity old_fixities n == lookupFixity new_fixities n
 
     diff ok_so_far pp new_vers []  []      = (ok_so_far, pp, new_vers)
     diff ok_so_far pp new_vers (od:ods) [] = diff False (pp $$ only_old od) new_vers         ods []
@@ -429,10 +464,11 @@ pprModDetails (ModDetails { md_types = type_env, md_insts = dfun_ids, md_rules =
         , dump_insts dfun_ids
         , dump_rules rules]
          
+dump_types :: [Var] -> TypeEnv -> SDoc
 dump_types dfun_ids type_env
   = text "TYPE SIGNATURES" $$ nest 4 (dump_sigs ids)
   where
-    ids = [id | AnId id <- nameEnvElts type_env, want_sig id]
+    ids = [id | id <- typeEnvIds type_env, want_sig id]
     want_sig id | opt_PprStyle_Debug = True
                | otherwise          = isLocalId id && 
                                       isGlobalName (idName id) && 
@@ -442,9 +478,11 @@ dump_types dfun_ids type_env
        -- that the type checker has invented.  User-defined things have
        -- Global names.
 
+dump_insts :: [Var] -> SDoc
 dump_insts []       = empty
 dump_insts dfun_ids = text "INSTANCES" $$ nest 4 (dump_sigs dfun_ids)
 
+dump_sigs :: [Var] -> SDoc
 dump_sigs ids
        -- Print type signatures
        -- Convert to HsType so that we get source-language style printing
@@ -456,6 +494,7 @@ dump_sigs ids
     lt_sig (n1,_) (n2,_) = n1 < n2
     ppr_sig (n,t)        = ppr n <+> dcolon <+> ppr t
 
+dump_rules :: [IdCoreRule] -> SDoc
 dump_rules [] = empty
 dump_rules rs = vcat [ptext SLIT("{-# RULES"),
                      nest 4 (vcat (map pprIdCoreRule rs)),
@@ -484,7 +523,7 @@ writeIface hi_path mod_iface
 pprIface :: ModIface -> SDoc
 pprIface iface
  = vcat [ ptext SLIT("__interface")
-               <+> doubleQuotes (ptext opt_InPackage)
+               <+> doubleQuotes (ptext (mi_package iface))
                <+> ppr (mi_module iface) <+> ppr (vers_module version_info)
                <+> pp_sub_vers
                <+> (if mi_orphan iface then char '!' else empty)
@@ -520,7 +559,7 @@ pprExport (mod, items)
   where
     pp_avail :: AvailInfo -> SDoc
     pp_avail (Avail name)                   = pprOcc name
-    pp_avail (AvailTC n [])                 = empty
+    pp_avail (AvailTC _ [])                 = empty
     pp_avail (AvailTC n (n':ns)) | n==n'     = pprOcc n                    <> pp_export ns
                                 | otherwise = pprOcc n <> char '|' <> pp_export (n':ns)
     
@@ -556,6 +595,7 @@ pprUsage (m, has_orphans, is_boot, whats_imported)
 \end{code}
 
 \begin{code}
+pprIfaceDecls :: NameEnv Int -> IfaceDecls -> SDoc
 pprIfaceDecls version_map decls
   = vcat [ vcat [ppr i <+> semi | i <- dcl_insts decls]
         , vcat (map ppr_decl (dcl_tycl decls))
@@ -570,6 +610,10 @@ pprIfaceDecls version_map decls
 \end{code}
 
 \begin{code}
+pprFixities :: (Outputable a)
+           => NameEnv a
+           -> [TyClDecl Name pat]
+           -> SDoc
 pprFixities fixity_map decls
   = hsep [ ppr fix <+> ppr n 
         | d <- decls, 
@@ -578,6 +622,7 @@ pprFixities fixity_map decls
 
 -- Disgusting to print these two together, but that's 
 -- the way the interface parser currently expects them.
+pprRulesAndDeprecs :: (Outputable a) => [a] -> Deprecations -> SDoc
 pprRulesAndDeprecs [] NoDeprecs = empty
 pprRulesAndDeprecs rules deprecs
   = ptext SLIT("{-##") <+> (pp_rules rules $$ pp_deprecs deprecs) <+> ptext SLIT("##-}")
@@ -592,6 +637,7 @@ pprRulesAndDeprecs rules deprecs
                                        DeprecAll txt  -> doubleQuotes (ptext txt)
                                        DeprecSome env -> ppr_deprec_env env
 
+ppr_deprec_env :: NameEnv (Name, FAST_STRING) -> SDoc
 ppr_deprec_env env = vcat (punctuate semi (map pp_deprec (nameEnvElts env)))
                   where
                     pp_deprec (name, txt) = pprOcc name <+> doubleQuotes (ptext txt)