compiler/deSugar/Desugar.lhs

   1 %
   2 % (c) The University of Glasgow 2006
   3 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
   4 %
   5
   6 The Desugarer: turning HsSyn into Core.
   7
   8 \begin{code}
   9 module Desugar ( deSugar, deSugarExpr ) where
  10
  11 import DynFlags
  12 import StaticFlags
  13 import HscTypes
  14 import HsSyn
  15 import TcRnTypes
  16 import MkIface
  17 import Id
  18 import Name
  19 import CoreSyn
  20 import OccurAnal
  21 import PprCore
  22 import DsMonad
  23 import DsExpr
  24 import DsBinds
  25 import DsForeign
  26 import DsExpr           ()      -- Forces DsExpr to be compiled; DsBinds only
  27                                 -- depends on DsExpr.hi-boot.
  28 import Module
  29 import RdrName
  30 import NameSet
  31 import VarSet
  32 import Rules
  33 import CoreLint
  34 import CoreFVs
  35 import ErrUtils
  36 import Outputable
  37 import SrcLoc
  38 import Maybes
  39 import FastString
  40 import Coverage
  41
  42 import Data.IORef
  43 import Data.Char
  44 \end{code}
  45
  46 %************************************************************************
  47 %*                                                                      *
  48 %*              The main function: deSugar
  49 %*                                                                      *
  50 %************************************************************************
  51
  52 \begin{code}
  53 deSugar :: HscEnv -> ModLocation -> TcGblEnv -> IO (Maybe ModGuts)
  54 -- Can modify PCS by faulting in more declarations
  55
  56 deSugar hsc_env
  57         mod_loc
  58         tcg_env@(TcGblEnv { tcg_mod          = mod,
  59                             tcg_src          = hsc_src,
  60                             tcg_type_env     = type_env,
  61                             tcg_imports      = imports,
  62                             tcg_exports      = exports,
  63                             tcg_keep         = keep_var,
  64                             tcg_rdr_env      = rdr_env,
  65                             tcg_fix_env      = fix_env,
  66                             tcg_inst_env     = inst_env,
  67                             tcg_fam_inst_env = fam_inst_env,
  68                             tcg_deprecs      = deprecs,
  69                             tcg_binds        = binds,
  70                             tcg_fords        = fords,
  71                             tcg_rules        = rules,
  72                             tcg_insts        = insts,
  73                             tcg_fam_insts    = fam_insts,
  74                             tcg_hpc          = other_hpc_info })
  75
  76   = do  { let dflags = hsc_dflags hsc_env
  77         ; showPass dflags "Desugar"
  78
  79         -- Desugar the program
  80         ; let export_set = availsToNameSet exports
  81         ; let auto_scc = mkAutoScc mod export_set
  82         ; let target = hscTarget dflags
  83         ; let hpcInfo = emptyHpcInfo other_hpc_info
  84         ; mb_res <- case target of
  85                      HscNothing -> return (Just ([], [], NoStubs, hpcInfo, emptyModBreaks))
  86                      _        -> do (binds_cvr,ds_hpc_info, modBreaks)
  87                                               <- if (opt_Hpc
  88                                                         || target == HscInterpreted)
  89                                                      && (not (isHsBoot hsc_src))
  90                                                  then addCoverageTicksToBinds dflags mod mod_loc (typeEnvTyCons type_env) binds
  91                                                  else return (binds, hpcInfo, emptyModBreaks)
  92                                     initDs hsc_env mod rdr_env type_env $ do
  93                                         { core_prs <- dsTopLHsBinds auto_scc binds_cvr
  94                                         ; (ds_fords, foreign_prs) <- dsForeigns fords
  95                                         ; let all_prs = foreign_prs ++ core_prs
  96                                         ; ds_rules <- mapM dsRule rules
  97                                         ; return (all_prs, catMaybes ds_rules, ds_fords, ds_hpc_info, modBreaks)
  98                                         }
  99         ; case mb_res of {
 100            Nothing -> return Nothing ;
 101            Just (all_prs, ds_rules, ds_fords,ds_hpc_info, modBreaks) -> do
 102
 103         {       -- Add export flags to bindings
 104           keep_alive <- readIORef keep_var
 105         ; let final_prs = addExportFlags target export_set
 106                                  keep_alive all_prs ds_rules
 107               ds_binds  = [Rec final_prs]
 108         -- Notice that we put the whole lot in a big Rec, even the foreign binds
 109         -- When compiling PrelFloat, which defines data Float = F# Float#
 110         -- we want F# to be in scope in the foreign marshalling code!
 111         -- You might think it doesn't matter, but the simplifier brings all top-level
 112         -- things into the in-scope set before simplifying; so we get no unfolding for F#!
 113
 114         -- Lint result if necessary
 115         ; endPass dflags "Desugar" Opt_D_dump_ds ds_binds
 116
 117         -- Dump output
 118         ; doIfSet (dopt Opt_D_dump_ds dflags)
 119                   (printDump (ppr_ds_rules ds_rules))
 120
 121         ; used_names <- mkUsedNames tcg_env
 122         ; deps <- mkDependencies tcg_env
 123
 124         ; let mod_guts = ModGuts {
 125                 mg_module       = mod,
 126                 mg_boot         = isHsBoot hsc_src,
 127                 mg_exports      = exports,
 128                 mg_deps         = deps,
 129                 mg_used_names   = used_names,
 130                 mg_dir_imps     = imp_mods imports,
 131                 mg_rdr_env      = rdr_env,
 132                 mg_fix_env      = fix_env,
 133                 mg_deprecs      = deprecs,
 134                 mg_types        = type_env,
 135                 mg_insts        = insts,
 136                 mg_fam_insts    = fam_insts,
 137                 mg_inst_env     = inst_env,
 138                 mg_fam_inst_env = fam_inst_env,
 139                 mg_rules        = ds_rules,
 140                 mg_binds        = ds_binds,
 141                 mg_foreign      = ds_fords,
 142                 mg_hpc_info     = ds_hpc_info,
 143                 mg_modBreaks    = modBreaks,
 144                 mg_vect_info    = noVectInfo
 145               }
 146         ; return (Just mod_guts)
 147         }}}
 148
 149 mkAutoScc :: Module -> NameSet -> AutoScc
 150 mkAutoScc mod exports
 151   | not opt_SccProfilingOn      -- No profiling
 152   = NoSccs
 153   | opt_AutoSccsOnAllToplevs    -- Add auto-scc on all top-level things
 154   = AddSccs mod (\id -> not $ isDerivedOccName $ getOccName id)
 155     -- See #1641.  This is pretty yucky, but I can't see a better way
 156     -- to identify compiler-generated Ids, and at least this should
 157     -- catch them all.
 158   | opt_AutoSccsOnExportedToplevs       -- Only on exported things
 159   = AddSccs mod (\id -> idName id `elemNameSet` exports)
 160   | otherwise
 161   = NoSccs
 162
 163 deSugarExpr :: HscEnv
 164             -> Module -> GlobalRdrEnv -> TypeEnv
 165             -> LHsExpr Id
 166             -> IO (Maybe CoreExpr)
 167 -- Prints its own errors; returns Nothing if error occurred
 168
 169 deSugarExpr hsc_env this_mod rdr_env type_env tc_expr
 170   = do  { let dflags = hsc_dflags hsc_env
 171         ; showPass dflags "Desugar"
 172
 173         -- Do desugaring
 174         ; mb_core_expr <- initDs hsc_env this_mod rdr_env type_env $
 175                           dsLExpr tc_expr
 176
 177         ; case mb_core_expr of {
 178             Nothing   -> return Nothing ;
 179             Just expr -> do {
 180
 181                 -- Dump output
 182           dumpIfSet_dyn dflags Opt_D_dump_ds "Desugared" (pprCoreExpr expr)
 183
 184         ; return (Just expr) } } }
 185
 186 --              addExportFlags
 187 -- Set the no-discard flag if either
 188 --      a) the Id is exported
 189 --      b) it's mentioned in the RHS of an orphan rule
 190 --      c) it's in the keep-alive set
 191 --
 192 -- It means that the binding won't be discarded EVEN if the binding
 193 -- ends up being trivial (v = w) -- the simplifier would usually just
 194 -- substitute w for v throughout, but we don't apply the substitution to
 195 -- the rules (maybe we should?), so this substitution would make the rule
 196 -- bogus.
 197
 198 -- You might wonder why exported Ids aren't already marked as such;
 199 -- it's just because the type checker is rather busy already and
 200 -- I didn't want to pass in yet another mapping.
 201
 202 addExportFlags :: HscTarget -> NameSet -> NameSet -> [(Id, t)] -> [CoreRule]
 203                -> [(Id, t)]
 204 addExportFlags target exports keep_alive prs rules
 205   = [(add_export bndr, rhs) | (bndr,rhs) <- prs]
 206   where
 207     add_export bndr
 208         | dont_discard bndr = setIdExported bndr
 209         | otherwise         = bndr
 210
 211     orph_rhs_fvs = unionVarSets [ ruleRhsFreeVars rule
 212                                 | rule <- rules,
 213                                   not (isLocalRule rule) ]
 214         -- A non-local rule keeps alive the free vars of its right-hand side.
 215         -- (A "non-local" is one whose head function is not locally defined.)
 216         -- Local rules are (later, after gentle simplification)
 217         -- attached to the Id, and that keeps the rhs free vars alive.
 218
 219     dont_discard bndr = is_exported name
 220                      || name `elemNameSet` keep_alive
 221                      || bndr `elemVarSet` orph_rhs_fvs
 222                      where
 223                         name = idName bndr
 224
 225         -- In interactive mode, we don't want to discard any top-level
 226         -- entities at all (eg. do not inline them away during
 227         -- simplification), and retain them all in the TypeEnv so they are
 228         -- available from the command line.
 229         --
 230         -- isExternalName separates the user-defined top-level names from those
 231         -- introduced by the type checker.
 232     is_exported :: Name -> Bool
 233     is_exported | target == HscInterpreted = isExternalName
 234                 | otherwise                = (`elemNameSet` exports)
 235
 236 ppr_ds_rules :: [CoreRule] -> SDoc
 237 ppr_ds_rules [] = empty
 238 ppr_ds_rules rules
 239   = text "" $$ text "-------------- DESUGARED RULES -----------------" $$
 240     pprRules rules
 241 \end{code}
 242
 243
 244
 245 %************************************************************************
 246 %*                                                                      *
 247 %*              Desugaring transformation rules
 248 %*                                                                      *
 249 %************************************************************************
 250
 251 \begin{code}
 252 dsRule :: LRuleDecl Id -> DsM (Maybe CoreRule)
 253 dsRule (L loc (HsRule name act vars lhs _tv_lhs rhs _fv_rhs))
 254   = putSrcSpanDs loc $
 255     do  { let bndrs = [var | RuleBndr (L _ var) <- vars]
 256         ; lhs'  <- dsLExpr lhs
 257         ; rhs'  <- dsLExpr rhs
 258
 259         ; case decomposeRuleLhs (occurAnalyseExpr lhs') of {
 260                 Nothing -> do { warnDs msg; return Nothing } ;
 261                 Just (fn_id, args) -> do
 262
 263         -- Substitute the dict bindings eagerly,
 264         -- and take the body apart into a (f args) form
 265         { let local_rule = isLocalId fn_id
 266                 -- NB: isLocalId is False of implicit Ids.  This is good becuase
 267                 -- we don't want to attach rules to the bindings of implicit Ids,
 268                 -- because they don't show up in the bindings until just before code gen
 269               fn_name   = idName fn_id
 270
 271               rule = Rule { ru_name = name, ru_fn = fn_name, ru_act = act,
 272                             ru_bndrs = bndrs, ru_args = args, ru_rhs = rhs',
 273                             ru_rough = roughTopNames args,
 274                             ru_local = local_rule }
 275         ; return (Just rule)
 276         } } }
 277   where
 278     msg = hang (ptext (sLit "RULE left-hand side too complicated to desugar; ignored"))
 279              2 (ppr lhs)
 280 \end{code}