Improve External Core syntax for newtypes
[ghc-hetmet.git] / compiler / coreSyn / MkExternalCore.lhs
index 1dc3b7e..99ea425 100644 (file)
@@ -22,36 +22,59 @@ import Var
 import IdInfo
 import Literal
 import Name
-import NameSet
-import UniqSet
 import Outputable
+import Encoding
 import ForeignCall
 import DynFlags
 import StaticFlags
-import IO
 import FastString
 
-emitExternalCore :: DynFlags -> NameSet -> CgGuts -> IO ()
-emitExternalCore dflags exports cg_guts
+import IO
+import Data.Char
+
+emitExternalCore :: DynFlags -> CgGuts -> IO ()
+emitExternalCore dflags cg_guts
  | opt_EmitExternalCore 
  = (do handle <- openFile corename WriteMode
-       hPutStrLn handle (show (mkExternalCore exports cg_guts))      
+       hPutStrLn handle (show (mkExternalCore cg_guts))      
        hClose handle)
    `catch` (\_ -> pprPanic "Failed to open or write external core output file"
                            (text corename))
    where corename = extCoreName dflags
-emitExternalCore _ _ _
+emitExternalCore _ _
  | otherwise
  = return ()
 
-
-mkExternalCore :: NameSet -> CgGuts -> C.Module
+-- 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 exports (CgGuts {cg_module=this_mod, cg_tycons = tycons, cg_binds = binds})
-  = C.Module mname tdefs (map (make_vdef exports) binds)
+mkExternalCore (CgGuts {cg_module=this_mod, cg_tycons = tycons, 
+                        cg_binds = binds})
+ -- Note that we flatten binds at the top level:
+ -- every module is just a single recursive bag of declarations.
+ -- Rationale: since modules can be mutually recursive, 
+ -- there's not much reason to preserve dependency info within a module.
+  = C.Module mname tdefs (case flattenBinds binds of
+                          -- check for empty list so we don't create an
+                          -- empty Rec group
+                            [] -> []
+                            bs  -> [(runCoreM (make_vdef True
+                                      (Rec bs)) this_mod)])
   where
     mname  = make_mid this_mod
     tdefs  = foldr collect_tdefs [] tycons
@@ -61,26 +84,18 @@ collect_tdefs tcon tdefs
   | isAlgTyCon tcon = tdef: tdefs
   where
     tdef | isNewTyCon tcon = 
-                C.Newtype (qtc tcon) (map make_tbind tyvars) 
+                C.Newtype (qtc tcon) 
                   (case newTyConCo_maybe tcon of
-                     Just coercion -> (qtc coercion, 
-                       make_kind $ (uncurry mkCoKind) $  
-                                  case isCoercionTyCon_maybe coercion of
-                                    -- See Note [Newtype coercions] in 
-                                    -- types/TyCon
-                                    Just (arity,coKindFun) -> coKindFun $
-                                       map mkTyVarTy $ take arity tyvars
-                                    Nothing -> pprPanic ("MkExternalCore:\
-                                      coercion tcon should have a kind fun")
-                                        (ppr tcon))
+                     Just co -> qtc co
                      Nothing       -> pprPanic ("MkExternalCore: newtype tcon\
                                        should have a coercion: ") (ppr tcon))
+                  (map make_tbind tyvars) 
                    repclause 
          | otherwise = 
-                C.Data (qtc tcon) (map make_tbind tyvars) (map make_cdef (tyConDataCons tcon)) 
+                C.Data (qtc tcon) (map make_tbind tyvars) 
+                   (map make_cdef (tyConDataCons tcon)) 
          where repclause | isRecursiveTyCon tcon || isOpenTyCon tcon= Nothing
-                        | otherwise = Just (make_ty (repType rhs))
-                                           where (_, rhs) = newTyConRhs tcon
+                        | otherwise = Just (make_ty (snd (newTyConRhs tcon)))
     tyvars = tyConTyVars tcon
 
 collect_tdefs _ tdefs = tdefs
@@ -92,7 +107,7 @@ qtc = make_con_qid . tyConName
 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    = dataConExTyVars dcon
     tys         = map make_ty (dataConRepArgTys dcon)
@@ -103,53 +118,74 @@ 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_vdef :: NameSet -> CoreBind -> C.Vdefg
-make_vdef exports 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)
+    NonRec v e -> f (v,e)     >>= (return . C.Nonrec)
+    Rec ves    -> mapM f ves  >>= (return . C.Rec)
   where
-  f (v,e) = (local, make_var_id (Var.varName v), make_ty (idType v),make_exp e)
-       where local = not $ elementOfUniqSet (Var.varName v) exports
-       -- 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) callconv _)) 
-        -> C.External (unpackFS nm) (showSDoc (ppr callconv)) (make_ty (idType v))
-    FCallId (CCall (CCallSpec DynamicTarget     callconv _)) 
-        -> C.DynExternal            (showSDoc (ppr callconv)) (make_ty (idType v))
-    FCallId _ 
-        -> pprPanic "MkExternalCore died: can't handle non-{static,dynamic}-C foreign call"
+  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 (idType 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 globalIdDetails v of
+       FCallId (CCall (CCallSpec (StaticTarget nm) callconv _)) 
+           -> C.External (unpackFS nm) (showSDoc (ppr callconv)) (make_ty (idType v))
+       FCallId (CCall (CCallSpec DynamicTarget     callconv _)) 
+           -> C.DynExternal            (showSDoc (ppr callconv)) (make_ty (idType v))
+       FCallId _ 
+           -> pprPanic "MkExternalCore died: can't handle non-{static,dynamic}-C foreign call"
                     (ppr v)
-    _ -> C.Var (make_var_qid (Var.varName v))
-make_exp (Lit (MachLabel s _)) = C.Label (unpackFS s)
-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 (Cast e co) = C.Cast (make_exp e) (make_ty co)
-make_exp (Let b e) = C.Let (make_vdef emptyNameSet 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 _) e) = C.Note "SCC"  (make_exp e) -- temporary
-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)
+       -- 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 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_ty 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 (Note InlineMe e) = make_exp e >>= (return . C.Note "InlineMe")
 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 "
@@ -159,7 +195,12 @@ make_alt a@(DEFAULT,_ ,_) = pprPanic ("MkExternalCore: make_alt: DEFAULT "
 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
@@ -172,12 +213,19 @@ 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 (qtc tc)) 
+-- 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)       = foldl C.Tapp (C.Tcon (qtc tc)) 
                                         (map make_ty ts)
 -- Newtypes are treated just like any other type constructor; not expanded
 -- Reason: predTypeRep does substitution and, while substitution deals
@@ -191,7 +239,7 @@ make_ty (TyConApp tc ts)     = foldl C.Tapp (C.Tcon (qtc 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' (PredTy p)    = make_ty (predTypeRep p)
 
 
 
@@ -208,7 +256,9 @@ make_kind _ = error "MkExternalCore died: make_kind"
 {- Id generation. -}
 
 make_id :: Bool -> Name -> C.Id
-make_id _is_var nm = (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
@@ -219,27 +269,39 @@ make_var_id = make_id True
 -- *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
 -- 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 = (packageIdString (modulePackageId m)) ++
-             ":" ++
-             showSDoc (pprCode CStyle (pprModuleName (moduleName m)))
+make_mid m = showSDoc $
+              (text $ zEncodeString $ packageIdString $ modulePackageId m)
+              <> text ":"
+              <> (pprEncoded $ pprModuleName $ moduleName m)
+     where pprEncoded = pprCode CStyle
                
-make_qid :: Bool -> Name -> C.Qual C.Id
-make_qid is_var n = (mname,make_id is_var n)
+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
+
+-------
+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}