The final batch of changes for the new coercion representation
[ghc-hetmet.git] / compiler / coreSyn / MkExternalCore.lhs
index ce09288..78df509 100644 (file)
@@ -1,8 +1,7 @@
-%
-% (c) The University of Glasgow 2001
+
+% (c) The University of Glasgow 2001-2006
 %
 \begin{code}
-
 module MkExternalCore (
        emitExternalCore
 ) where
@@ -10,50 +9,67 @@ module MkExternalCore (
 #include "HsVersions.h"
 
 import qualified ExternalCore as C
-import Char
 import Module
 import CoreSyn
 import HscTypes        
 import TyCon
+-- import Class
+-- import TysPrim( eqPredPrimTyCon )
 import TypeRep
 import Type
-import PprExternalCore -- Instances
-import DataCon ( DataCon, dataConTyVars, dataConRepArgTys, 
-                 dataConName, dataConTyCon )
-import CoreSyn
+import PprExternalCore () -- Instances
+import DataCon
+import Coercion
 import Var
 import IdInfo
-import Kind
 import Literal
 import Name
 import Outputable
+import Encoding
 import ForeignCall
-import DynFlags        ( DynFlags(..) )
-import StaticFlags     ( opt_EmitExternalCore )
-import IO
+import DynFlags
 import FastString
+import Exception
+
+import Data.Char
+import System.IO
 
 emitExternalCore :: DynFlags -> CgGuts -> IO ()
 emitExternalCore dflags cg_guts
- | opt_EmitExternalCore 
+ | dopt Opt_EmitExternalCore dflags
  = (do handle <- openFile corename WriteMode
-       hPutStrLn handle (show (mkExternalCore cg_guts))      
+       hPutStrLn handle (show (mkExternalCore cg_guts))
        hClose handle)
-   `catch` (\err -> pprPanic "Failed to open or write external core output file" 
-                            (text corename))
+   `catchIO` (\_ -> pprPanic "Failed to open or write external core output file"
+                             (text corename))
    where corename = extCoreName dflags
 emitExternalCore _ _
  | otherwise
  = return ()
 
+-- Reinventing the Reader monad; whee.
+newtype CoreM a = CoreM (CoreState -> (CoreState, a))
+type CoreState = Module
+instance Monad CoreM where
+  (CoreM m) >>= f = CoreM (\ s -> case m s of
+                                    (s',r) -> case f r of
+                                                CoreM f' -> f' s')
+  return x = CoreM (\ s -> (s, x))
+runCoreM :: CoreM a -> CoreState -> a
+runCoreM (CoreM f) s = snd $ f s
+ask :: CoreM CoreState
+ask = CoreM (\ s -> (s,s))
 
 mkExternalCore :: CgGuts -> 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 (CgGuts {cg_module=this_mod, cg_tycons = tycons, cg_binds = binds})
-  = C.Module mname tdefs (map make_vdef binds)
+mkExternalCore (CgGuts {cg_module=this_mod, cg_tycons = tycons, 
+                        cg_binds = binds})
+{- Note that modules can be mutually recursive, but even so, we
+   print out dependency information within each module. -}
+  = C.Module mname tdefs (runCoreM (mapM (make_vdef True) binds) this_mod)
   where
     mname  = make_mid this_mod
     tdefs  = foldr collect_tdefs [] tycons
@@ -63,78 +79,117 @@ collect_tdefs tcon tdefs
   | isAlgTyCon tcon = tdef: tdefs
   where
     tdef | isNewTyCon tcon = 
-                C.Newtype (make_con_qid (tyConName tcon)) (map make_tbind tyvars) repclause 
--- 20060420 GHC handles empty data types just fine. ExtCore should too! jds
---         | null (tyConDataCons tcon) = error "MkExternalCore died: can't handle datatype declarations with no data constructors"
+                C.Newtype (qtc tcon) 
+                  (qcc (newTyConCo tcon))
+                  (map make_tbind tyvars) 
+                  (make_ty (snd (newTyConRhs tcon)))
          | otherwise = 
-                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
+                C.Data (qtc tcon) (map make_tbind tyvars) 
+                   (map make_cdef (tyConDataCons tcon)) 
     tyvars = tyConTyVars tcon
 
 collect_tdefs _ tdefs = tdefs
 
+qtc :: TyCon -> C.Qual C.Tcon
+qtc = make_con_qid . tyConName
+
+qcc :: CoAxiom -> C.Qual C.Tcon
+qcc = make_con_qid . co_ax_name
 
 make_cdef :: DataCon -> C.Cdef
 make_cdef dcon =  C.Constr dcon_name existentials tys
   where 
-    dcon_name    = make_var_id (dataConName dcon)
+    dcon_name    = make_qid False False (dataConName dcon)
     existentials = map make_tbind ex_tyvars
-    ex_tyvars    = drop (tyConArity (dataConTyCon dcon)) (dataConTyVars dcon)
+    ex_tyvars    = dataConExTyVars dcon
     tys         = map make_ty (dataConRepArgTys dcon)
 
 make_tbind :: TyVar -> C.Tbind
 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 (idType v))
+make_vbind v = (make_var_id  (Var.varName v), make_ty (varType v))
 
-make_vdef :: CoreBind -> C.Vdefg
-make_vdef b = 
+make_vdef :: Bool -> CoreBind -> CoreM C.Vdefg
+make_vdef topLevel b = 
   case b of
-    NonRec v e -> C.Nonrec (f (v,e))
-    Rec ves -> C.Rec (map f ves)
-  where f (v,e) = (make_var_id (Var.varName v), make_ty (idType v),make_exp e)
-       -- Top level bindings are unqualified now
-
-make_exp :: CoreExpr -> C.Exp
-make_exp (Var v) =  
-  case globalIdDetails v of
-     -- 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 (idType 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 (make_vdef b) (make_exp e)
--- gaw 2004
-make_exp (Case e v ty alts) = C.Case (make_exp e) (make_vbind v) (make_ty ty) (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 (CoreNote s) e) = C.Note s (make_exp e)  -- hdaume: core annotations
-make_exp (Note InlineMe e) = C.Note "InlineMe" (make_exp e)
+    NonRec v e -> f (v,e)     >>= (return . C.Nonrec)
+    Rec ves    -> mapM f ves  >>= (return . C.Rec)
+  where
+  f :: (CoreBndr,CoreExpr) -> CoreM C.Vdef
+  f (v,e) = do
+          localN <- isALocal vName
+          let local = not topLevel || localN
+          rhs <- make_exp e
+          -- use local flag to determine where to add the module name
+          return (local, make_qid local True vName, make_ty (varType v),rhs)
+       where vName = Var.varName v
+
+make_exp :: CoreExpr -> CoreM C.Exp
+make_exp (Var v) = do
+  let vName = Var.varName v
+  isLocal <- isALocal vName
+  return $
+     case idDetails v of
+       FCallId (CCall (CCallSpec (StaticTarget nm _) callconv _)) 
+           -> C.External (unpackFS nm) (showSDoc (ppr callconv)) (make_ty (varType v))
+       FCallId (CCall (CCallSpec DynamicTarget     callconv _)) 
+           -> C.DynExternal            (showSDoc (ppr callconv)) (make_ty (varType v))
+       -- Constructors are always exported, so make sure to declare them
+       -- with qualified names
+       DataConWorkId _ -> C.Var (make_var_qid False vName)
+       DataConWrapId _ -> C.Var (make_var_qid False vName)
+       _ -> C.Var (make_var_qid isLocal vName)
+make_exp (Lit (MachLabel s _ _)) = return $ C.Label (unpackFS s)
+make_exp (Lit l) = return $ C.Lit (make_lit l)
+make_exp (App e (Type t)) = make_exp e >>= (\ b -> return $ C.Appt b (make_ty t))
+make_exp (App _e (Coercion _co)) = error "make_exp (App _ (Coercion _))"    -- TODO
+make_exp (App e1 e2) = do
+   rator <- make_exp e1
+   rand <- make_exp e2
+   return $ C.App rator rand
+make_exp (Lam v e) | isTyVar v = make_exp e >>= (\ b -> 
+                                    return $ C.Lam (C.Tb (make_tbind v)) b)
+make_exp (Lam v e) | otherwise = make_exp e >>= (\ b -> 
+                                    return $ C.Lam (C.Vb (make_vbind v)) b)
+make_exp (Cast e co) = make_exp e >>= (\ b -> return $ C.Cast b (make_co co))
+make_exp (Let b e) = do
+  vd   <- make_vdef False b
+  body <- make_exp e
+  return $ C.Let vd body
+make_exp (Case e v ty alts) = do
+  scrut <- make_exp e
+  newAlts  <- mapM make_alt alts
+  return $ C.Case scrut (make_vbind v) (make_ty ty) newAlts
+make_exp (Note (SCC _) e) = make_exp e >>= (return . C.Note "SCC") -- temporary
+make_exp (Note (CoreNote s) e) = make_exp e >>= (return . C.Note s)  -- hdaume: core annotations
 make_exp _ = error "MkExternalCore died: make_exp"
 
-make_alt :: CoreAlt -> C.Alt
-make_alt (DataAlt dcon, vs, e) = 
-    C.Acon (make_con_qid (dataConName dcon))
+make_alt :: CoreAlt -> CoreM C.Alt
+make_alt (DataAlt dcon, vs, e) = do
+    newE <- make_exp e
+    return $ C.Acon (make_con_qid (dataConName dcon))
            (map make_tbind tbs)
            (map make_vbind vbs)
-          (make_exp e)    
+          newE
        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)
+make_alt (LitAlt l,_,e)   = make_exp e >>= (return . (C.Alit (make_lit l)))
+make_alt (DEFAULT,[],e)   = make_exp e >>= (return . C.Adefault)
+-- This should never happen, as the DEFAULT alternative binds no variables,
+-- but we might as well check for it:
+make_alt a@(DEFAULT,_ ,_) = pprPanic ("MkExternalCore: make_alt: DEFAULT "
+             ++ "alternative had a non-empty var list") (ppr a)
+
 
 make_lit :: Literal -> C.Lit
 make_lit l = 
   case l of
-    MachChar i -> C.Lchar i t
+    -- Note that we need to check whether the character is "big".
+    -- External Core only allows character literals up to '\xff'.
+    MachChar i | i <= chr 0xff -> C.Lchar i t
+    -- For a character bigger than 0xff, we represent it in ext-core
+    -- as an int lit with a char type.
+    MachChar i             -> C.Lint (fromIntegral $ ord i) t 
     MachStr s -> C.Lstring (unpackFS s) t
     MachNullAddr -> C.Lint 0 t
     MachInt i -> C.Lint i t
@@ -147,13 +202,20 @@ make_lit l =
   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 (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)
+-- Expand type synonyms, then convert.
+make_ty :: Type -> C.Ty                 -- Be sure to expand types recursively!
+                                        -- example: FilePath ~> String ~> [Char]
+make_ty t | Just expanded <- tcView t = make_ty expanded
+make_ty t = make_ty' t
+-- note calls to make_ty so as to expand types recursively
+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' (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)       = make_tyConApp tc ts
+
 -- Newtypes are treated just like any other type constructor; not expanded
 -- Reason: predTypeRep does substitution and, while substitution deals
 --        correctly with name capture, it's only correct if you see the uniques!
@@ -166,55 +228,90 @@ make_ty (TyConApp tc ts)   = foldl C.Tapp (C.Tcon (make_con_qid (tyConName tc)))
 -- expose the representation in interface files, which definitely isn't right.
 -- Maybe CoreTidy should know whether to expand newtypes or not?
 
-make_ty (PredTy p)     = make_ty (predTypeRep p)
-make_ty (NoteTy _ t)   = make_ty t
-
+make_ty' (PredTy p)    = make_ty (predTypeRep p)
 
+make_tyConApp :: TyCon -> [Type] -> C.Ty
+make_tyConApp tc ts =
+  foldl C.Tapp (C.Tcon (qtc tc)) 
+           (map make_ty ts)
 
 make_kind :: Kind -> C.Kind
-make_kind (FunKind k1 k2)  = C.Karrow (make_kind k1) (make_kind k2)
-make_kind LiftedTypeKind   = C.Klifted
-make_kind UnliftedTypeKind = C.Kunlifted
-make_kind OpenTypeKind     = C.Kopen
+make_kind (PredTy (EqPred t1 t2)) = C.Keq (make_ty t1) (make_ty t2)
+make_kind (FunTy k1 k2)  = C.Karrow (make_kind k1) (make_kind k2)
+make_kind k
+  | isLiftedTypeKind k   = C.Klifted
+  | isUnliftedTypeKind k = C.Kunlifted
+  | isOpenTypeKind k     = C.Kopen
 make_kind _ = error "MkExternalCore died: make_kind"
 
 {- Id generation. -}
 
-{- 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
-    '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
--}
+-- include uniques for internal names in order to avoid name shadowing
+make_id _is_var nm = ((occNameString . nameOccName) nm)
+  ++ (if isInternalName nm then (show . nameUnique) nm else "")
 
 make_var_id :: Name -> C.Id
 make_var_id = make_id True
 
+-- It's important to encode the module name here, because in External Core,
+-- base:GHC.Base => base:GHCziBase
+-- We don't do this in pprExternalCore because we
+-- *do* want to keep the package name (we don't want baseZCGHCziBase,
+-- because that would just be ugly.)
+-- SIGH.
+-- We encode the package name as well.
 make_mid :: Module -> C.Id
-make_mid = moduleString
-
-make_qid :: Bool -> Name -> C.Qual C.Id
-make_qid is_var n = (mname,make_id is_var n)
+-- Super ugly code, but I can't find anything else that does quite what I
+-- want (encodes the hierarchical module name without encoding the colon
+-- that separates the package name from it.)
+make_mid m = showSDoc $
+              (text $ zEncodeString $ packageIdString $ modulePackageId m)
+              <> text ":"
+              <> (pprEncoded $ pprModuleName $ moduleName m)
+     where pprEncoded = pprCode CStyle
+               
+make_qid :: Bool -> Bool -> Name -> C.Qual C.Id
+make_qid force_unqual is_var n = (mname,make_id is_var n)
     where mname = 
            case nameModule_maybe n of
-            Just m -> make_mid m
-            Nothing -> "" 
+            Just m | not force_unqual -> make_mid m
+            _ -> "" 
 
-make_var_qid :: Name -> C.Qual C.Id
-make_var_qid = make_qid True
+make_var_qid :: Bool -> Name -> C.Qual C.Id
+make_var_qid force_unqual = make_qid force_unqual True
 
 make_con_qid :: Name -> C.Qual C.Id
-make_con_qid = make_qid False
-
+make_con_qid = make_qid False False
+
+make_co :: Coercion -> C.Ty
+make_co (Refl ty)             = make_ty ty
+make_co (TyConAppCo tc cos)   = make_conAppCo (qtc tc) cos
+make_co (AppCo c1 c2)         = C.Tapp (make_co c1) (make_co c2)
+make_co (ForAllCo tv co)      = C.Tforall (make_tbind tv) (make_co co)
+make_co (CoVarCo cv)          = C.Tvar (make_var_id (coVarName cv))
+make_co (AxiomInstCo cc cos)  = make_conAppCo (qcc cc) cos
+make_co (UnsafeCo t1 t2)      = C.UnsafeCoercion (make_ty t1) (make_ty t2)
+make_co (SymCo co)            = C.SymCoercion (make_co co)
+make_co (TransCo c1 c2)       = C.TransCoercion (make_co c1) (make_co c2)
+make_co (NthCo d co)          = C.NthCoercion d (make_co co)
+make_co (InstCo co ty)        = C.InstCoercion (make_co co) (make_ty ty)
+
+-- Used for both tycon app coercions and axiom instantiations.
+make_conAppCo :: C.Qual C.Tcon -> [Coercion] -> C.Ty
+make_conAppCo con cos =
+  foldl C.Tapp (C.Tcon con) 
+           (map make_co cos)
+
+-------
+isALocal :: Name -> CoreM Bool
+isALocal vName = do
+  modName <- ask
+  return $ case nameModule_maybe vName of
+             -- Not sure whether isInternalName corresponds to "local"ness
+             -- in the External Core sense; need to re-read the spec.
+             Just m | m == modName -> isInternalName vName
+             _                     -> False
 \end{code}