[project @ 2003-08-19 21:59:40 by krc]
[ghc-hetmet.git] / ghc / compiler / coreSyn / MkExternalCore.lhs
index 9b0a507..86c77da 100644 (file)
@@ -15,12 +15,17 @@ import Module
 import CoreSyn
 import HscTypes        
 import TyCon
+import Class
 import TypeRep
 import Type
-import DataCon
+import DataCon ( DataCon, dataConExistentialTyVars, dataConRepArgTys, 
+                 dataConName, dataConWrapId_maybe )
 import CoreSyn
 import Var
 import IdInfo
+import Id      ( idUnfolding )
+import CoreTidy        ( tidyExpr )
+import VarEnv  ( emptyTidyEnv )
 import Literal
 import Name
 import CostCentre
@@ -28,71 +33,72 @@ import Outputable
 import ForeignCall
 import PprExternalCore 
 import CmdLineOpts
+import Maybes  ( orElse, catMaybes )
 import IO
+import FastString
 
-emitExternalCore :: DynFlags -> ModIface -> ModDetails -> IO ()
-emitExternalCore dflags iface details 
+emitExternalCore :: DynFlags -> ModGuts -> IO ()
+emitExternalCore dflags mod_impl
  | opt_EmitExternalCore 
  = (do handle <- openFile corename WriteMode
-       hPutStr handle (show (mkExternalCore iface details))      
+       hPutStrLn handle (show (mkExternalCore mod_impl))      
        hClose handle)
    `catch` (\err -> pprPanic "Failed to open or write external core output file" 
                             (text corename))
    where corename = extCoreName dflags
-emitExternalCore _ _ _ 
+emitExternalCore _ _
  | otherwise
  = return ()
 
 
-mkExternalCore :: ModIface -> ModDetails -> C.Module
-mkExternalCore (ModIface {mi_module=mi_module,mi_exports=mi_exports}) 
-              (ModDetails {md_types=md_types,md_binds=md_binds}) =
-    C.Module mname {- exports -} tdefs vdefs
+mkExternalCore :: ModGuts -> C.Module
+-- The ModGuts has been tidied, but the implicit bindings have
+-- not been injected, so we have to add them manually here
+-- We don't include the strange data-con *workers* because they are
+-- implicit in the data type declaration itself
+mkExternalCore (ModGuts {mg_module=this_mod, mg_types = type_env, mg_binds = binds})
+  = C.Module mname tdefs (map make_vdef all_binds)
   where
-    mname = make_mid mi_module
-{-  exports = foldr (collect_exports md_types) ([],[],[]) all_avails 
-    all_avails = concat (map snd (filter ((== moduleName mi_module) . fst) mi_exports))
--}
-    tdefs = foldr collect_tdefs [] (typeEnvTyCons md_types)
-    vdefs = map make_vdef md_binds
-
-{-
-collect_exports :: TypeEnv -> AvailInfo -> ([C.Tcon],[C.Dcon],[C.Var]) -> ([C.Tcon],[C.Dcon],[C.Var])
-collect_exports tyenv (Avail n) (tcons,dcons,vars) = (tcons,dcons,make_var_id n:vars)      
-collect_exports tyenv (AvailTC n ns) (tcons,dcons,vars) = 
-  case lookupNameEnv_NF tyenv n of
-     ATyCon tc | isAlgTyCon tc -> 
-         (tcon ++ tcons,workers ++ dcons,wrappers ++ vars)
-         where 
-           tcon = if elem n ns then [make_con_id n] else []
-          workers = if isNewTyCon tc then []
-                    else map  (make_con_id . idName . dataConId) exported_dcs
-          exported_dcs = filter (\dc -> elem ((idName . dataConWrapId) dc) ns') dcs
-          dcs = tyConDataConsIfAvailable tc
-          wrappers = map make_var_id ns'
-           ns' = filter (\n' -> n' /= n && not (elem n' recordSels)) ns
-           recordSels = map idName (tyConSelIds tc)
-     AClass cl ->  {- maybe a little too free about exports -}
-        (tcon : tcons,workers ++ dcons,wrappers ++ vars)
-        where 
-          tcon = make_con_id (tyConName tc)
-         workers = if isNewTyCon tc then []
-                    else map (make_con_id . idName . dataConId) dcs 
-         wrappers = map (make_var_id . idName . dataConWrapId) dcs
-          dcs = tyConDataConsIfAvailable tc
-          tc = classTyCon cl
-     _ -> (tcons,dcons,vars)
--}
+    mname  = make_mid this_mod
+    tdefs  = foldr collect_tdefs [] tycons
+
+    all_binds  = implicit_con_wrappers ++ other_implicit_binds ++ binds
+               -- Put the constructor wrappers first, because
+               -- other implicit bindings (notably the fromT functions arising 
+               -- from generics) use the constructor wrappers.
+
+    tycons = map classTyCon (typeEnvClasses type_env) ++ typeEnvTyCons type_env
+
+    implicit_con_wrappers = map get_defn (concatMap implicit_con_ids   (typeEnvElts type_env))
+    other_implicit_binds  = map get_defn (concatMap other_implicit_ids (typeEnvElts type_env))
+
+implicit_con_ids :: TyThing -> [Id]
+implicit_con_ids (ATyCon tc) | isAlgTyCon tc = catMaybes (map dataConWrapId_maybe (tyConDataCons tc))
+implicit_con_ids other                      = []
 
+other_implicit_ids :: TyThing -> [Id]
+other_implicit_ids (ATyCon tc) = tyConSelIds tc ++ tyConGenIds tc
+other_implicit_ids (AClass cl) = classSelIds cl
+other_implicit_ids other       = []
+
+get_defn :: Id -> CoreBind
+get_defn id = NonRec id rhs
+           where
+             rhs  = tidyExpr emptyTidyEnv body 
+             body = unfoldingTemplate (idUnfolding id)
+       -- Don't forget to tidy the body !  Otherwise you get silly things like
+       --      \ tpl -> case tpl of tpl -> (tpl,tpl) -> tpl
+       -- Maybe we should inject these bindings during CoreTidy?
 
 collect_tdefs :: TyCon -> [C.Tdef] -> [C.Tdef]
 collect_tdefs tcon tdefs 
   | isAlgTyCon tcon = tdef: tdefs
   where
     tdef | isNewTyCon tcon = 
-                C.Newtype (make_con_id (tyConName tcon)) (map make_tbind tyvars) repclause 
+                C.Newtype (make_con_qid (tyConName tcon)) (map make_tbind tyvars) repclause 
+         | null (tyConDataCons tcon) = error "MkExternalCore died: can't handle datatype declarations with no data constructors"
          | otherwise = 
-                C.Data (make_con_id (tyConName tcon)) (map make_tbind tyvars) (map make_cdef (tyConDataCons tcon)) 
+                C.Data (make_con_qid (tyConName tcon)) (map make_tbind tyvars) (map make_cdef (tyConDataCons tcon)) 
          where repclause | isRecursiveTyCon tcon = Nothing
                         | otherwise = Just (make_ty rep)
                                            where (_, rep) = newTyConRep tcon
@@ -104,10 +110,10 @@ collect_tdefs _ tdefs = tdefs
 make_cdef :: DataCon -> C.Cdef
 make_cdef dcon =  C.Constr dcon_name existentials tys
   where 
-    dcon_name = make_con_id (idName (dataConId dcon))
+    dcon_name    = make_con_qid (dataConName dcon)
     existentials = map make_tbind ex_tyvars
-          where (_,_,ex_tyvars,_,_,_) = dataConSig dcon
-    tys = map make_ty (dataConRepArgTys dcon)
+    ex_tyvars    = dataConExistentialTyVars dcon
+    tys         = map make_ty (dataConRepArgTys dcon)
 
 make_tbind :: TyVar -> C.Tbind
 make_tbind tv = (make_var_id (tyVarName tv), make_kind (tyVarKind tv))
@@ -115,37 +121,42 @@ make_tbind tv = (make_var_id (tyVarName tv), make_kind (tyVarKind tv))
 make_vbind :: Var -> C.Vbind
 make_vbind v = (make_var_id  (Var.varName v), make_ty (varType v))
 
-make_vdef :: CoreBind -> (Bool, C.Vdefg)
+make_vdef :: CoreBind -> C.Vdefg
 make_vdef b = 
   case b of
-    NonRec v e -> (isGlobalId v,C.Nonrec (f (v,e)))
-    Rec ves -> (or (map g ves),C.Rec (map f ves))
-  where f (v,e) = (n,t,make_exp e)
-                  where (n,t) = make_vbind v
-        g (v,e) = isGlobalId v
+    NonRec v e -> C.Nonrec (f (v,e))
+    Rec ves -> C.Rec (map f ves)
+  where f (v,e) = (make_var_qid (Var.varName v), make_ty (varType v),make_exp e)
 
 make_exp :: CoreExpr -> C.Exp
 make_exp (Var v) =  
   case globalIdDetails v of
-    DataConId _ -> C.Dcon (make_con_qid (Var.varName v))
-    FCallId (CCall (CCallSpec (StaticTarget nm) _ _)) -> C.Ccall (_UNPK_ nm) (make_ty (varType v))
+     -- a DataConId represents the Id of a worker, which is a varName. -- sof 4/02
+--    DataConId _ -> C.Dcon (make_con_qid (Var.varName v))
+    FCallId (CCall (CCallSpec (StaticTarget nm) _ _)) -> C.External (unpackFS nm) (make_ty (varType v))
+    FCallId _ -> error "MkExternalCore died: can't handle non-static-C foreign call"
     _ -> C.Var (make_var_qid (Var.varName v))
+make_exp (Lit (l@(MachLabel s _))) = error "MkExternalCore died: can't handle \"foreign label\" declarations"
 make_exp (Lit l) = C.Lit (make_lit l)
 make_exp (App e (Type t)) = C.Appt (make_exp e) (make_ty t)
 make_exp (App e1 e2) = C.App (make_exp e1) (make_exp e2)
 make_exp (Lam v e) | isTyVar v = C.Lam (C.Tb (make_tbind v)) (make_exp e)
 make_exp (Lam v e) | otherwise = C.Lam (C.Vb (make_vbind v)) (make_exp e)
-make_exp (Let b e) = C.Let (snd (make_vdef b)) (make_exp e)
+make_exp (Let b e) = C.Let (make_vdef b) (make_exp e)
 make_exp (Case e v alts) = C.Case (make_exp e) (make_vbind v) (map make_alt alts)
 make_exp (Note (SCC cc) e) = C.Note "SCC"  (make_exp e) -- temporary
 make_exp (Note (Coerce t_to t_from) e) = C.Coerce (make_ty t_to) (make_exp e)
 make_exp (Note InlineCall e) = C.Note "InlineCall" (make_exp e)
+make_exp (Note (CoreNote s) e) = C.Note s (make_exp e)  -- hdaume: core annotations
 make_exp (Note InlineMe e) = C.Note "InlineMe" (make_exp e)
 make_exp _ = error "MkExternalCore died: make_exp"
 
 make_alt :: CoreAlt -> C.Alt
 make_alt (DataAlt dcon, vs, e) = 
-    C.Acon (make_con_qid (idName (dataConId dcon))) (map make_tbind tbs) (map make_vbind vbs) (make_exp e)
+    C.Acon (make_con_qid (dataConName dcon))
+           (map make_tbind tbs)
+           (map make_vbind vbs)
+          (make_exp e)    
        where (tbs,vbs) = span isTyVar vs
 make_alt (LitAlt l,_,e) = C.Alit (make_lit l) (make_exp e)
 make_alt (DEFAULT,[],e) = C.Adefault (make_exp e)
@@ -155,28 +166,44 @@ make_lit l =
   case l of
     MachChar i | i <= 0xff -> C.Lchar (chr i) t
     MachChar i | otherwise -> C.Lint (toEnum i) t
-    MachStr s -> C.Lstring (_UNPK_ s) t
-    MachAddr i -> C.Lint i t  
+       -- For big characters, use an integer literal with a character type sig
+    MachStr s -> C.Lstring (unpackFS s) t
+    MachNullAddr -> C.Lint 0 t
     MachInt i -> C.Lint i t
     MachInt64 i -> C.Lint i t
     MachWord i -> C.Lint i t
     MachWord64 i -> C.Lint i t
     MachFloat r -> C.Lrational r t
     MachDouble r -> C.Lrational r t
-    MachLabel s -> C.Lstring (_UNPK_ s) t
     _ -> error "MkExternalCore died: make_lit"
   where 
     t = make_ty (literalType l)
 
 make_ty :: Type -> C.Ty
-make_ty (TyVarTy tv) = C.Tvar (make_var_id (tyVarName tv))
-make_ty (AppTy t1 t2) = C.Tapp (make_ty t1) (make_ty t2)
-make_ty (TyConApp tc ts) = foldl C.Tapp (C.Tcon (make_con_qid (tyConName tc))) (map make_ty ts)
-make_ty (FunTy t1 t2) = make_ty (TyConApp funTyCon [t1,t2])
-make_ty (ForAllTy tv t) = C.Tforall (make_tbind tv) (make_ty t)
-make_ty (SourceTy p) = make_ty (sourceTypeRep p)
-make_ty (UsageTy _ t) = make_ty t
-make_ty (NoteTy _ t) = make_ty t
+make_ty (TyVarTy tv)            = C.Tvar (make_var_id (tyVarName tv))
+make_ty (AppTy t1 t2)           = C.Tapp (make_ty t1) (make_ty t2)
+make_ty (FunTy t1 t2)           = make_ty (TyConApp funTyCon [t1,t2])
+make_ty (ForAllTy tv t)         = C.Tforall (make_tbind tv) (make_ty t)
+make_ty (TyConApp tc ts)        = foldl C.Tapp (C.Tcon (make_con_qid (tyConName tc))) 
+                                        (map make_ty ts)
+-- The special case for newtypes says "do not expand newtypes".
+-- Reason: sourceTypeRep does substitution and, while substitution deals
+--        correctly with name capture, it's only correct if you see the uniques!
+--        If you just see occurrence names, name capture may occur.
+-- Example: newtype A a = A (forall b. b -> a)
+--         test :: forall q b. q -> A b
+--         test _ = undefined
+--     Here the 'a' gets substituted by 'b', which is captured.
+-- Another solution would be to expand newtypes before tidying; but that would
+-- expose the representation in interface files, which definitely isn't right.
+-- Maybe CoreTidy should know whether to expand newtypes or not?
+
+make_ty (SourceTy (NType tc ts)) = foldl C.Tapp (C.Tcon (make_con_qid (tyConName tc))) 
+                                        (map make_ty ts)
+
+make_ty (SourceTy p)            = make_ty (sourceTypeRep p)
+make_ty (NoteTy _ t)            = make_ty t
+
 
 
 make_kind :: Kind -> C.Kind
@@ -188,25 +215,25 @@ make_kind _ = error "MkExternalCore died: make_kind"
 
 {- Id generation. -}
 
-{- Use encoded strings, except restore '#'s.
+{- Use encoded strings.
    Also, adjust casing to work around some badly-chosen internal names. -}
 make_id :: Bool -> Name -> C.Id
+make_id is_var nm = (occNameString . nameOccName) nm
+
+{-     SIMON thinks this stuff isn't necessary
 make_id is_var nm = 
   case n of
-    c:cs -> if isUpper c && is_var then (toLower c):(decode cs) 
-           else if isLower c && (not is_var) then (toUpper c):(decode cs)
-            else decode n
+    'Z':cs | is_var -> 'z':cs 
+    'z':cs | not is_var -> 'Z':cs 
+    c:cs | isUpper c && is_var -> 'z':'d':n
+    c:cs | isLower c && (not is_var) -> 'Z':'d':n
+    _ -> n
   where n = (occNameString . nameOccName) nm
-        decode ('z':'h':cs) = '#':(decode cs)
-        decode (c:cs) = c:(decode cs)
-        decode [] = []
+-}
 
 make_var_id :: Name -> C.Id
 make_var_id = make_id True
 
-make_con_id :: Name -> C.Id
-make_con_id = make_id False
-
 make_mid :: Module -> C.Id
 make_mid = moduleNameString . moduleName
 
@@ -215,7 +242,7 @@ make_qid is_var n = (mname,make_id is_var n)
     where mname = 
            case nameModule_maybe n of
             Just m -> make_mid m
-            Nothing -> ""   -- for now!
+            Nothing -> "" 
 
 make_var_qid :: Name -> C.Qual C.Id
 make_var_qid = make_qid True