[project @ 2005-01-27 10:44:00 by simonpj]
[ghc-hetmet.git] / ghc / compiler / deSugar / Desugar.lhs
index d95ca8c..be26463 100644 (file)
@@ -8,42 +8,44 @@ module Desugar ( deSugar, deSugarExpr ) where
 
 #include "HsVersions.h"
 
-import CmdLineOpts     ( DynFlag(..), dopt, opt_SccProfilingOn )
+import CmdLineOpts     ( DynFlag(..), DynFlags(..), dopt, opt_SccProfilingOn )
+import DriverPhases    ( isHsBoot )
 import HscTypes                ( ModGuts(..), ModGuts, HscEnv(..), GhciMode(..),
-                         Dependencies(..), TypeEnv, 
-                         unQualInScope, availsToNameSet )
+                         Dependencies(..), TypeEnv, IsBootInterface )
 import HsSyn           ( RuleDecl(..), RuleBndr(..), HsExpr(..), LHsExpr,
                          HsBindGroup(..), LRuleDecl, HsBind(..) )
 import TcRnTypes       ( TcGblEnv(..), ImportAvails(..) )
 import MkIface         ( mkUsageInfo )
-import Id              ( Id, setIdLocalExported, idName )
+import Id              ( Id, setIdExported, idName, idIsFrom )
 import Name            ( Name, isExternalName )
 import CoreSyn
 import PprCore         ( pprIdRules, pprCoreExpr )
-import Subst           ( substExpr, mkSubst, mkInScopeSet )
+import CoreSubst       ( substExpr, mkSubst )
 import DsMonad
 import DsExpr          ( dsLExpr )
 import DsBinds         ( dsHsBinds, AutoScc(..) )
 import DsForeign       ( dsForeigns )
 import DsExpr          ()      -- Forces DsExpr to be compiled; DsBinds only
                                -- depends on DsExpr.hi-boot.
-import Module          ( Module, moduleEnvElts, emptyModuleEnv )
+import Module          ( Module, moduleEnvElts, delModuleEnv, moduleFS )
 import Id              ( Id )
 import RdrName         ( GlobalRdrEnv )
 import NameSet
 import VarEnv
 import VarSet
-import Bag             ( isEmptyBag, mapBag, emptyBag, bagToList )
+import Bag             ( Bag, isEmptyBag, emptyBag, bagToList )
 import CoreLint                ( showPass, endPass )
 import CoreFVs         ( ruleRhsFreeVars )
+import Packages                ( PackageState(thPackageId), PackageIdH(..) )
 import ErrUtils                ( doIfSet, dumpIfSet_dyn, pprBagOfWarnings, 
-                         mkWarnMsg, errorsFound, WarnMsg )
+                         errorsFound, WarnMsg )
+import ListSetOps      ( insertList )
 import Outputable
-import qualified Pretty
 import UniqSupply      ( mkSplitUniqSupply )
-import SrcLoc          ( Located(..), SrcSpan, unLoc )
+import SrcLoc          ( Located(..), unLoc )
 import DATA_IOREF      ( readIORef )
 import FastString
+import Util            ( sortLe )
 \end{code}
 
 %************************************************************************
@@ -53,60 +55,104 @@ import FastString
 %************************************************************************
 
 \begin{code}
-deSugar :: HscEnv -> TcGblEnv -> IO (Maybe ModGuts)
+deSugar :: HscEnv -> TcGblEnv -> IO (Bag WarnMsg, Maybe ModGuts)
 -- Can modify PCS by faulting in more declarations
 
 deSugar hsc_env 
         tcg_env@(TcGblEnv { tcg_mod       = mod,
+                           tcg_src       = hsc_src,
                            tcg_type_env  = type_env,
                            tcg_imports   = imports,
                            tcg_exports   = exports,
                            tcg_dus       = dus, 
                            tcg_inst_uses = dfun_uses_var,
+                           tcg_th_used   = th_var,
+                           tcg_keep      = keep_var,
                            tcg_rdr_env   = rdr_env,
                            tcg_fix_env   = fix_env,
                            tcg_deprecs   = deprecs,
+                           tcg_binds     = binds,
+                           tcg_fords     = fords,
+                           tcg_rules     = rules,
                            tcg_insts     = insts })
   = do { showPass dflags "Desugar"
 
-       -- Do desugaring
-       ; let { is_boot = imp_dep_mods imports }
-       ; (results, warnings) <- initDs hsc_env mod type_env is_boot $
-                                dsProgram ghci_mode tcg_env
+       -- Desugar the program
+       ; ((all_prs, ds_rules, ds_fords), warns) 
+               <- initDs hsc_env mod rdr_env type_env $ do
+               { core_prs <- dsHsBinds auto_scc binds []
+               ; (ds_fords, foreign_prs) <- dsForeigns fords
+               ; let all_prs = foreign_prs ++ core_prs
+                     local_bndrs = mkVarSet (map fst all_prs)
+               ; ds_rules <- mappM (dsRule mod local_bndrs) rules
+               ; return (all_prs, ds_rules, ds_fords) }
 
-       ; let { (ds_binds, ds_rules, ds_fords) = results
-             ; warns    = mapBag mk_warn warnings
-             ; warn_doc = pprBagOfWarnings warns }
 
-       -- Display any warnings
-        ; doIfSet (not (isEmptyBag warnings))
-                 (printErrs warn_doc)
 
        -- If warnings are considered errors, leave.
        ; if errorsFound dflags (warns, emptyBag)
-          then return Nothing
+          then return (warns, Nothing)
           else do
 
+       {       -- Add export flags to bindings
+         keep_alive <- readIORef keep_var
+       ; let final_prs = addExportFlags ghci_mode exports keep_alive 
+                                        all_prs ds_rules
+             ds_binds  = [Rec final_prs]
+       -- Notice that we put the whole lot in a big Rec, even the foreign binds
+       -- When compiling PrelFloat, which defines data Float = F# Float#
+       -- we want F# to be in scope in the foreign marshalling code!
+       -- You might think it doesn't matter, but the simplifier brings all top-level
+       -- things into the in-scope set before simplifying; so we get no unfolding for F#!
+
        -- Lint result if necessary
-       { endPass dflags "Desugar" Opt_D_dump_ds ds_binds
+       ; endPass dflags "Desugar" Opt_D_dump_ds ds_binds
 
        -- Dump output
        ; doIfSet (dopt Opt_D_dump_ds dflags) 
                  (printDump (ppr_ds_rules ds_rules))
 
        ; dfun_uses <- readIORef dfun_uses_var          -- What dfuns are used
+       ; th_used   <- readIORef th_var                 -- Whether TH is used
        ; let used_names = allUses dus `unionNameSets` dfun_uses
-       ; usages <- mkUsageInfo hsc_env imports used_names
+             thPackage = thPackageId (pkgState dflags)
+             pkgs | ExtPackage th_id <- thPackage, th_used
+                  = insertList th_id  (imp_dep_pkgs imports)
+                  | otherwise
+                  = imp_dep_pkgs imports
+
+             dep_mods = moduleEnvElts (delModuleEnv (imp_dep_mods imports) mod)
+               -- M.hi-boot can be in the imp_dep_mods, but we must remove
+               -- it before recording the modules on which this one depends!
+               -- (We want to retain M.hi-boot in imp_dep_mods so that 
+               --  loadHiBootInterface can see if M's direct imports depend 
+               --  on M.hi-boot, and hence that we should do the hi-boot consistency 
+               --  check.)
+
+             dir_imp_mods = imp_mods imports
+
+       ; usages <- mkUsageInfo hsc_env dir_imp_mods dep_mods used_names
+
        ; let 
-            deps = Deps { dep_mods = moduleEnvElts (imp_dep_mods imports), 
-                          dep_pkgs = imp_dep_pkgs imports,
-                          dep_orphs = imp_orphs imports }
+               -- Modules don't compare lexicographically usually, 
+               -- but we want them to do so here.
+            le_mod :: Module -> Module -> Bool  
+            le_mod m1 m2 = moduleFS m1 <= moduleFS m2
+            le_dep_mod :: (Module, IsBootInterface) -> (Module, IsBootInterface) -> Bool        
+            le_dep_mod (m1,_) (m2,_) = m1 `le_mod` m2
+
+            deps = Deps { dep_mods  = sortLe le_dep_mod dep_mods,
+                          dep_pkgs  = sortLe (<=)   pkgs,      
+                          dep_orphs = sortLe le_mod (imp_orphs imports) }
+               -- sort to get into canonical order
+
             mod_guts = ModGuts {       
                mg_module   = mod,
+               mg_boot     = isHsBoot hsc_src,
                mg_exports  = exports,
                mg_deps     = deps,
                mg_usages   = usages,
-               mg_dir_imps = [m | (m,_) <- moduleEnvElts (imp_mods imports)],
+               mg_dir_imps = [m | (m,_,_) <- moduleEnvElts dir_imp_mods],
                mg_rdr_env  = rdr_env,
                mg_fix_env  = fix_env,
                mg_deprecs  = deprecs,
@@ -116,19 +162,14 @@ deSugar hsc_env
                mg_binds    = ds_binds,
                mg_foreign  = ds_fords }
        
-        ; return (Just mod_guts)
+        ; return (warns, Just mod_guts)
        }}
 
   where
     dflags       = hsc_dflags hsc_env
     ghci_mode    = hsc_mode hsc_env
-    print_unqual = unQualInScope rdr_env
-
-       -- Desugarer warnings are SDocs; here we
-       -- add the info about whether or not to print unqualified
-    mk_warn :: (SrcSpan,SDoc) -> WarnMsg
-    mk_warn (loc, sdoc) = mkWarnMsg loc print_unqual sdoc
-
+    auto_scc | opt_SccProfilingOn = TopLevel
+            | otherwise          = NoSccs
 
 deSugarExpr :: HscEnv
            -> Module -> GlobalRdrEnv -> TypeEnv 
@@ -139,15 +180,13 @@ deSugarExpr hsc_env this_mod rdr_env type_env tc_expr
        ; us <- mkSplitUniqSupply 'd'
 
        -- Do desugaring
-       ; let { is_boot = emptyModuleEnv }      -- Assume no hi-boot files when
-                                               -- doing stuff from the command line
-       ; (core_expr, ds_warns) <- initDs hsc_env this_mod type_env is_boot $
+       ; (core_expr, ds_warns) <- initDs hsc_env this_mod rdr_env type_env $
                                   dsLExpr tc_expr
 
        -- Display any warnings 
        -- Note: if -Werror is used, we don't signal an error here.
         ; doIfSet (not (isEmptyBag ds_warns))
-                 (printErrs (pprBagOfWarnings (mapBag mk_warn ds_warns)))
+                 (printErrs (pprBagOfWarnings ds_warns))
 
        -- Dump output
        ; dumpIfSet_dyn dflags Opt_D_dump_ds "Desugared" (pprCoreExpr core_expr)
@@ -156,38 +195,7 @@ deSugarExpr hsc_env this_mod rdr_env type_env tc_expr
        }
   where
     dflags       = hsc_dflags hsc_env
-    print_unqual = unQualInScope rdr_env
 
-    mk_warn :: (SrcSpan,SDoc) -> WarnMsg
-    mk_warn (loc,sdoc) = mkWarnMsg loc print_unqual sdoc
-
-
-dsProgram ghci_mode (TcGblEnv { tcg_exports = exports,
-                               tcg_keep    = keep_alive,
-                               tcg_binds   = binds,
-                               tcg_fords   = fords,
-                               tcg_rules   = rules })
-  = dsHsBinds auto_scc binds []        `thenDs` \ core_prs ->
-    dsForeigns fords                   `thenDs` \ (ds_fords, foreign_prs) ->
-    let
-       all_prs = foreign_prs ++ core_prs
-       local_bndrs = mkVarSet (map fst all_prs)
-    in
-    mappM (dsRule local_bndrs) rules   `thenDs` \ ds_rules ->
-    let
-       final_prs = addExportFlags ghci_mode exports keep_alive 
-                                  local_bndrs all_prs ds_rules
-       ds_binds  = [Rec final_prs]
-       -- Notice that we put the whole lot in a big Rec, even the foreign binds
-       -- When compiling PrelFloat, which defines data Float = F# Float#
-       -- we want F# to be in scope in the foreign marshalling code!
-       -- You might think it doesn't matter, but the simplifier brings all top-level
-       -- things into the in-scope set before simplifying; so we get no unfolding for F#!
-    in
-    returnDs (ds_binds, ds_rules, ds_fords)
-  where
-    auto_scc | opt_SccProfilingOn = TopLevel
-            | otherwise          = NoSccs
 
 --             addExportFlags
 -- Set the no-discard flag if either 
@@ -205,19 +213,19 @@ dsProgram ghci_mode (TcGblEnv { tcg_exports = exports,
 -- it's just because the type checker is rather busy already and
 -- I didn't want to pass in yet another mapping.
 
-addExportFlags ghci_mode exports keep_alive bndrs prs rules
+addExportFlags ghci_mode exports keep_alive prs rules
   = [(add_export bndr, rhs) | (bndr,rhs) <- prs]
   where
-    add_export bndr | dont_discard bndr = setIdLocalExported bndr
-                   | otherwise         = bndr
+    add_export bndr
+       | dont_discard bndr = setIdExported bndr
+       | otherwise         = bndr
 
     orph_rhs_fvs = unionVarSets [ ruleRhsFreeVars rule
-                               | (id, rule) <- rules, 
-                                 not (id `elemVarSet` bndrs) ]
-       -- An orphan rule must keep alive the free vars 
-       -- of its right-hand side.  
-       -- Non-orphan rules are attached to the Id (bndr_with_rules above)
-       -- and that keeps the rhs free vars alive
+                               | IdCoreRule _ is_orphan_rule rule <- rules, 
+                                 is_orphan_rule ]
+       -- An orphan rule keeps alive the free vars of its right-hand side.  
+       -- Non-orphan rules are (later, after gentle simplification) 
+       -- attached to the Id and that keeps the rhs free vars alive
 
     dont_discard bndr = is_exported name
                     || name `elemNameSet` keep_alive
@@ -234,9 +242,7 @@ addExportFlags ghci_mode exports keep_alive bndrs prs rules
        -- introduced by the type checker.
     is_exported :: Name -> Bool
     is_exported | ghci_mode == Interactive = isExternalName
-               | otherwise                = (`elemNameSet` export_fvs)
-
-    export_fvs = availsToNameSet exports
+               | otherwise                = (`elemNameSet` exports)
 
 ppr_ds_rules [] = empty
 ppr_ds_rules rules
@@ -253,15 +259,18 @@ ppr_ds_rules rules
 %************************************************************************
 
 \begin{code}
-dsRule :: IdSet -> LRuleDecl Id -> DsM (Id, CoreRule)
-dsRule in_scope (L loc (HsRule name act vars lhs rhs))
+dsRule :: Module -> IdSet -> LRuleDecl Id -> DsM IdCoreRule
+dsRule mod in_scope (L loc (HsRule name act vars lhs rhs))
   = putSrcSpanDs loc $ 
     ds_lhs all_vars lhs                `thenDs` \ (fn, args) ->
     dsLExpr rhs                        `thenDs` \ core_rhs ->
-    returnDs (fn, Rule name act tpl_vars args core_rhs)
+    returnDs (IdCoreRule fn (is_orphan fn) (Rule name act tpl_vars args core_rhs))
   where
-    tpl_vars = [var | RuleBndr (L _ var) <- vars]
-    all_vars = mkInScopeSet (in_scope `unionVarSet` mkVarSet tpl_vars)
+    tpl_vars  = [var | RuleBndr (L _ var) <- vars]
+    all_vars  = mkInScopeSet (extendVarSetList in_scope tpl_vars)
+    is_orphan id = not (idIsFrom mod id)
+       -- NB we can't use isLocalId in the orphan test, 
+       -- because isLocalId isn't true of class methods
 
 ds_lhs all_vars lhs
   = let
@@ -271,17 +280,16 @@ ds_lhs all_vars lhs
                other                                  -> (emptyBag, lhs)
     in
     mappM ds_dict_bind (bagToList dict_binds)  `thenDs` \ dict_binds' ->
-    dsLExpr body                       `thenDs` \ body' ->
+    dsLExpr body                               `thenDs` \ body' ->
 
        -- Substitute the dict bindings eagerly,
        -- and take the body apart into a (f args) form
     let
-       subst_env = mkSubstEnv [id                   | (id,rhs) <- dict_binds']
-                              [ContEx subst_env rhs | (id,rhs) <- dict_binds']
+       subst = mkSubst all_vars emptyVarEnv (mkVarEnv id_pairs)
+       id_pairs = [(id, substExpr subst rhs) | (id,rhs) <- dict_binds']
                        -- Note recursion here... substitution won't terminate
                        -- if there is genuine recursion... which there isn't
 
-       subst = mkSubst all_vars subst_env
        body'' = substExpr subst body'
     in