ghc/compiler/deSugar/Desugar.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
   3 %
   4 \section[Desugar]{@deSugar@: the main function}
   5
   6 \begin{code}
   7 module Desugar ( deSugar, deSugarExpr ) where
   8
   9 #include "HsVersions.h"
  10
  11 import CmdLineOpts      ( DynFlag(..), dopt, opt_SccProfilingOn )
  12 import HscTypes         ( ModGuts(..), ModGuts, HscEnv(..), GhciMode(..),
  13                           Dependencies(..), TypeEnv,
  14                           unQualInScope, availsToNameSet )
  15 import HsSyn            ( RuleDecl(..), RuleBndr(..), HsExpr(..), LHsExpr,
  16                           HsBindGroup(..), LRuleDecl, HsBind(..) )
  17 import TcRnTypes        ( TcGblEnv(..), ImportAvails(..) )
  18 import MkIface          ( mkUsageInfo )
  19 import Id               ( Id, setIdLocalExported, idName )
  20 import Name             ( Name, isExternalName )
  21 import CoreSyn
  22 import PprCore          ( pprIdRules, pprCoreExpr )
  23 import Subst            ( substExpr, mkSubst, mkInScopeSet )
  24 import DsMonad
  25 import DsExpr           ( dsLExpr )
  26 import DsBinds          ( dsHsBinds, AutoScc(..) )
  27 import DsForeign        ( dsForeigns )
  28 import DsExpr           ()      -- Forces DsExpr to be compiled; DsBinds only
  29                                 -- depends on DsExpr.hi-boot.
  30 import Module           ( Module, moduleEnvElts, emptyModuleEnv )
  31 import Id               ( Id )
  32 import RdrName          ( GlobalRdrEnv )
  33 import NameSet
  34 import VarEnv
  35 import VarSet
  36 import Bag              ( Bag, isEmptyBag, mapBag, emptyBag, bagToList )
  37 import CoreLint         ( showPass, endPass )
  38 import CoreFVs          ( ruleRhsFreeVars )
  39 import Packages         ( thPackage )
  40 import ErrUtils         ( doIfSet, dumpIfSet_dyn, pprBagOfWarnings,
  41                           mkWarnMsg, errorsFound, WarnMsg )
  42 import ListSetOps       ( insertList )
  43 import Outputable
  44 import UniqSupply       ( mkSplitUniqSupply )
  45 import SrcLoc           ( Located(..), SrcSpan, unLoc )
  46 import DATA_IOREF       ( readIORef )
  47 import FastString
  48 import Data.List        ( sort )
  49 \end{code}
  50
  51 %************************************************************************
  52 %*                                                                      *
  53 %*              The main function: deSugar
  54 %*                                                                      *
  55 %************************************************************************
  56
  57 \begin{code}
  58 deSugar :: HscEnv -> TcGblEnv -> IO (Bag WarnMsg, Maybe ModGuts)
  59 -- Can modify PCS by faulting in more declarations
  60
  61 deSugar hsc_env
  62         tcg_env@(TcGblEnv { tcg_mod       = mod,
  63                             tcg_type_env  = type_env,
  64                             tcg_imports   = imports,
  65                             tcg_exports   = exports,
  66                             tcg_dus       = dus,
  67                             tcg_inst_uses = dfun_uses_var,
  68                             tcg_th_used   = th_var,
  69                             tcg_rdr_env   = rdr_env,
  70                             tcg_fix_env   = fix_env,
  71                             tcg_deprecs   = deprecs,
  72                             tcg_insts     = insts })
  73   = do  { showPass dflags "Desugar"
  74
  75         -- Do desugaring
  76         ; let { is_boot = imp_dep_mods imports }
  77         ; (results, warnings) <- initDs hsc_env mod type_env is_boot $
  78                                  dsProgram ghci_mode tcg_env
  79
  80         ; let { (ds_binds, ds_rules, ds_fords) = results
  81               ; warns    = mapBag mk_warn warnings
  82               }
  83
  84         -- If warnings are considered errors, leave.
  85         ; if errorsFound dflags (warns, emptyBag)
  86            then return (warns, Nothing)
  87            else do
  88
  89         -- Lint result if necessary
  90         { endPass dflags "Desugar" Opt_D_dump_ds ds_binds
  91
  92         -- Dump output
  93         ; doIfSet (dopt Opt_D_dump_ds dflags)
  94                   (printDump (ppr_ds_rules ds_rules))
  95
  96         ; dfun_uses <- readIORef dfun_uses_var          -- What dfuns are used
  97         ; let used_names = allUses dus `unionNameSets` dfun_uses
  98         ; usages <- mkUsageInfo hsc_env imports used_names
  99
 100         ; th_used <- readIORef th_var
 101         ; let
 102              pkgs | th_used   = insertList thPackage (imp_dep_pkgs imports)
 103                   | otherwise = imp_dep_pkgs imports
 104
 105              deps = Deps { dep_mods = moduleEnvElts (imp_dep_mods imports),
 106                            dep_pkgs  = sort pkgs,
 107                            dep_orphs = sort (imp_orphs imports) }
 108                 -- sort to get into canonical order
 109
 110              mod_guts = ModGuts {
 111                 mg_module   = mod,
 112                 mg_exports  = exports,
 113                 mg_deps     = deps,
 114                 mg_usages   = usages,
 115                 mg_dir_imps = [m | (m,_) <- moduleEnvElts (imp_mods imports)],
 116                 mg_rdr_env  = rdr_env,
 117                 mg_fix_env  = fix_env,
 118                 mg_deprecs  = deprecs,
 119                 mg_types    = type_env,
 120                 mg_insts    = insts,
 121                 mg_rules    = ds_rules,
 122                 mg_binds    = ds_binds,
 123                 mg_foreign  = ds_fords }
 124
 125         ; return (warns, Just mod_guts)
 126         }}
 127
 128   where
 129     dflags       = hsc_dflags hsc_env
 130     ghci_mode    = hsc_mode hsc_env
 131     print_unqual = unQualInScope rdr_env
 132
 133         -- Desugarer warnings are SDocs; here we
 134         -- add the info about whether or not to print unqualified
 135     mk_warn :: (SrcSpan,SDoc) -> WarnMsg
 136     mk_warn (loc, sdoc) = mkWarnMsg loc print_unqual sdoc
 137
 138
 139 deSugarExpr :: HscEnv
 140             -> Module -> GlobalRdrEnv -> TypeEnv
 141             -> LHsExpr Id
 142             -> IO CoreExpr
 143 deSugarExpr hsc_env this_mod rdr_env type_env tc_expr
 144   = do  { showPass dflags "Desugar"
 145         ; us <- mkSplitUniqSupply 'd'
 146
 147         -- Do desugaring
 148         ; let { is_boot = emptyModuleEnv }      -- Assume no hi-boot files when
 149                                                 -- doing stuff from the command line
 150         ; (core_expr, ds_warns) <- initDs hsc_env this_mod type_env is_boot $
 151                                    dsLExpr tc_expr
 152
 153         -- Display any warnings
 154         -- Note: if -Werror is used, we don't signal an error here.
 155         ; doIfSet (not (isEmptyBag ds_warns))
 156                   (printErrs (pprBagOfWarnings (mapBag mk_warn ds_warns)))
 157
 158         -- Dump output
 159         ; dumpIfSet_dyn dflags Opt_D_dump_ds "Desugared" (pprCoreExpr core_expr)
 160
 161         ; return core_expr
 162         }
 163   where
 164     dflags       = hsc_dflags hsc_env
 165     print_unqual = unQualInScope rdr_env
 166
 167     mk_warn :: (SrcSpan,SDoc) -> WarnMsg
 168     mk_warn (loc,sdoc) = mkWarnMsg loc print_unqual sdoc
 169
 170
 171 dsProgram ghci_mode (TcGblEnv { tcg_exports = exports,
 172                                 tcg_keep    = keep_alive,
 173                                 tcg_binds   = binds,
 174                                 tcg_fords   = fords,
 175                                 tcg_rules   = rules })
 176   = dsHsBinds auto_scc binds [] `thenDs` \ core_prs ->
 177     dsForeigns fords                    `thenDs` \ (ds_fords, foreign_prs) ->
 178     let
 179         all_prs = foreign_prs ++ core_prs
 180         local_bndrs = mkVarSet (map fst all_prs)
 181     in
 182     mappM (dsRule local_bndrs) rules    `thenDs` \ ds_rules ->
 183     let
 184         final_prs = addExportFlags ghci_mode exports keep_alive
 185                                    local_bndrs all_prs ds_rules
 186         ds_binds  = [Rec final_prs]
 187         -- Notice that we put the whole lot in a big Rec, even the foreign binds
 188         -- When compiling PrelFloat, which defines data Float = F# Float#
 189         -- we want F# to be in scope in the foreign marshalling code!
 190         -- You might think it doesn't matter, but the simplifier brings all top-level
 191         -- things into the in-scope set before simplifying; so we get no unfolding for F#!
 192     in
 193     returnDs (ds_binds, ds_rules, ds_fords)
 194   where
 195     auto_scc | opt_SccProfilingOn = TopLevel
 196              | otherwise          = NoSccs
 197
 198 --              addExportFlags
 199 -- Set the no-discard flag if either
 200 --      a) the Id is exported
 201 --      b) it's mentioned in the RHS of an orphan rule
 202 --      c) it's in the keep-alive set
 203 --
 204 -- It means that the binding won't be discarded EVEN if the binding
 205 -- ends up being trivial (v = w) -- the simplifier would usually just
 206 -- substitute w for v throughout, but we don't apply the substitution to
 207 -- the rules (maybe we should?), so this substitution would make the rule
 208 -- bogus.
 209
 210 -- You might wonder why exported Ids aren't already marked as such;
 211 -- it's just because the type checker is rather busy already and
 212 -- I didn't want to pass in yet another mapping.
 213
 214 addExportFlags ghci_mode exports keep_alive bndrs prs rules
 215   = [(add_export bndr, rhs) | (bndr,rhs) <- prs]
 216   where
 217     add_export bndr | dont_discard bndr = setIdLocalExported bndr
 218                     | otherwise         = bndr
 219
 220     orph_rhs_fvs = unionVarSets [ ruleRhsFreeVars rule
 221                                 | (id, rule) <- rules,
 222                                   not (id `elemVarSet` bndrs) ]
 223         -- An orphan rule must keep alive the free vars
 224         -- of its right-hand side.
 225         -- Non-orphan rules are attached to the Id (bndr_with_rules above)
 226         -- and that keeps the rhs free vars alive
 227
 228     dont_discard bndr = is_exported name
 229                      || name `elemNameSet` keep_alive
 230                      || bndr `elemVarSet` orph_rhs_fvs
 231                      where
 232                         name = idName bndr
 233
 234         -- In interactive mode, we don't want to discard any top-level
 235         -- entities at all (eg. do not inline them away during
 236         -- simplification), and retain them all in the TypeEnv so they are
 237         -- available from the command line.
 238         --
 239         -- isExternalName separates the user-defined top-level names from those
 240         -- introduced by the type checker.
 241     is_exported :: Name -> Bool
 242     is_exported | ghci_mode == Interactive = isExternalName
 243                 | otherwise                = (`elemNameSet` exports)
 244
 245 ppr_ds_rules [] = empty
 246 ppr_ds_rules rules
 247   = text "" $$ text "-------------- DESUGARED RULES -----------------" $$
 248     pprIdRules rules
 249 \end{code}
 250
 251
 252
 253 %************************************************************************
 254 %*                                                                      *
 255 %*              Desugaring transformation rules
 256 %*                                                                      *
 257 %************************************************************************
 258
 259 \begin{code}
 260 dsRule :: IdSet -> LRuleDecl Id -> DsM (Id, CoreRule)
 261 dsRule in_scope (L loc (HsRule name act vars lhs rhs))
 262   = putSrcSpanDs loc $
 263     ds_lhs all_vars lhs         `thenDs` \ (fn, args) ->
 264     dsLExpr rhs                 `thenDs` \ core_rhs ->
 265     returnDs (fn, Rule name act tpl_vars args core_rhs)
 266   where
 267     tpl_vars = [var | RuleBndr (L _ var) <- vars]
 268     all_vars = mkInScopeSet (extendVarSetList in_scope tpl_vars)
 269
 270 ds_lhs all_vars lhs
 271   = let
 272         (dict_binds, body) =
 273            case unLoc lhs of
 274                 (HsLet [HsBindGroup dict_binds _ _] body) -> (dict_binds, body)
 275                 other                                  -> (emptyBag, lhs)
 276     in
 277     mappM ds_dict_bind (bagToList dict_binds)   `thenDs` \ dict_binds' ->
 278     dsLExpr body                        `thenDs` \ body' ->
 279
 280         -- Substitute the dict bindings eagerly,
 281         -- and take the body apart into a (f args) form
 282     let
 283         subst_env = mkSubstEnv [id                   | (id,rhs) <- dict_binds']
 284                                [ContEx subst_env rhs | (id,rhs) <- dict_binds']
 285                         -- Note recursion here... substitution won't terminate
 286                         -- if there is genuine recursion... which there isn't
 287
 288         subst = mkSubst all_vars subst_env
 289         body'' = substExpr subst body'
 290     in
 291
 292         -- Now unpack the resulting body
 293     let
 294         pair = case collectArgs body'' of
 295                         (Var fn, args) -> (fn, args)
 296                         other          -> pprPanic "dsRule" (ppr lhs)
 297     in
 298     returnDs pair
 299
 300 ds_dict_bind (L _ (VarBind id rhs)) =
 301   dsLExpr rhs `thenDs` \ rhs' ->
 302   returnDs (id,rhs')
 303 \end{code}