compiler/coreSyn/MkExternalCore.lhs

   1 %
   2 % (c) The University of Glasgow 2001
   3 %
   4 \begin{code}
   5
   6 module MkExternalCore (
   7         emitExternalCore
   8 ) where
   9
  10 #include "HsVersions.h"
  11
  12 import qualified ExternalCore as C
  13 import Char
  14 import Module
  15 import CoreSyn
  16 import HscTypes
  17 import TyCon
  18 import TypeRep
  19 import Type
  20 import PprExternalCore  -- Instances
  21 import DataCon  ( DataCon, dataConTyVars, dataConRepArgTys,
  22                   dataConName, dataConTyCon )
  23 import CoreSyn
  24 import Var
  25 import IdInfo
  26 import Kind
  27 import Literal
  28 import Name
  29 import Outputable
  30 import ForeignCall
  31 import DynFlags ( DynFlags(..) )
  32 import StaticFlags      ( opt_EmitExternalCore )
  33 import IO
  34 import FastString
  35
  36 emitExternalCore :: DynFlags -> CgGuts -> IO ()
  37 emitExternalCore dflags cg_guts
  38  | opt_EmitExternalCore
  39  = (do handle <- openFile corename WriteMode
  40        hPutStrLn handle (show (mkExternalCore cg_guts))
  41        hClose handle)
  42    `catch` (\err -> pprPanic "Failed to open or write external core output file"
  43                              (text corename))
  44    where corename = extCoreName dflags
  45 emitExternalCore _ _
  46  | otherwise
  47  = return ()
  48
  49
  50 mkExternalCore :: CgGuts -> C.Module
  51 -- The ModGuts has been tidied, but the implicit bindings have
  52 -- not been injected, so we have to add them manually here
  53 -- We don't include the strange data-con *workers* because they are
  54 -- implicit in the data type declaration itself
  55 mkExternalCore (CgGuts {cg_module=this_mod, cg_tycons = tycons, cg_binds = binds})
  56   = C.Module mname tdefs (map make_vdef binds)
  57   where
  58     mname  = make_mid this_mod
  59     tdefs  = foldr collect_tdefs [] tycons
  60
  61 collect_tdefs :: TyCon -> [C.Tdef] -> [C.Tdef]
  62 collect_tdefs tcon tdefs
  63   | isAlgTyCon tcon = tdef: tdefs
  64   where
  65     tdef | isNewTyCon tcon =
  66                 C.Newtype (make_con_qid (tyConName tcon)) (map make_tbind tyvars) repclause
  67 -- 20060420 GHC handles empty data types just fine. ExtCore should too! jds
  68 --         | null (tyConDataCons tcon) = error "MkExternalCore died: can't handle datatype declarations with no data constructors"
  69          | otherwise =
  70                 C.Data (make_con_qid (tyConName tcon)) (map make_tbind tyvars) (map make_cdef (tyConDataCons tcon))
  71          where repclause | isRecursiveTyCon tcon = Nothing
  72                          | otherwise = Just (make_ty rep)
  73                                            where (_, rep) = newTyConRep tcon
  74     tyvars = tyConTyVars tcon
  75
  76 collect_tdefs _ tdefs = tdefs
  77
  78
  79 make_cdef :: DataCon -> C.Cdef
  80 make_cdef dcon =  C.Constr dcon_name existentials tys
  81   where
  82     dcon_name    = make_var_id (dataConName dcon)
  83     existentials = map make_tbind ex_tyvars
  84     ex_tyvars    = drop (tyConArity (dataConTyCon dcon)) (dataConTyVars dcon)
  85     tys          = map make_ty (dataConRepArgTys dcon)
  86
  87 make_tbind :: TyVar -> C.Tbind
  88 make_tbind tv = (make_var_id (tyVarName tv), make_kind (tyVarKind tv))
  89
  90 make_vbind :: Var -> C.Vbind
  91 make_vbind v = (make_var_id  (Var.varName v), make_ty (idType v))
  92
  93 make_vdef :: CoreBind -> C.Vdefg
  94 make_vdef b =
  95   case b of
  96     NonRec v e -> C.Nonrec (f (v,e))
  97     Rec ves -> C.Rec (map f ves)
  98   where f (v,e) = (make_var_id (Var.varName v), make_ty (idType v),make_exp e)
  99         -- Top level bindings are unqualified now
 100
 101 make_exp :: CoreExpr -> C.Exp
 102 make_exp (Var v) =
 103   case globalIdDetails v of
 104      -- a DataConId represents the Id of a worker, which is a varName. -- sof 4/02
 105 --    DataConId _ -> C.Dcon (make_con_qid (Var.varName v))
 106     FCallId (CCall (CCallSpec (StaticTarget nm) _ _)) -> C.External (unpackFS nm) (make_ty (idType v))
 107     FCallId _ -> error "MkExternalCore died: can't handle non-static-C foreign call"
 108     _ -> C.Var (make_var_qid (Var.varName v))
 109 make_exp (Lit (l@(MachLabel s _))) = error "MkExternalCore died: can't handle \"foreign label\" declarations"
 110 make_exp (Lit l) = C.Lit (make_lit l)
 111 make_exp (App e (Type t)) = C.Appt (make_exp e) (make_ty t)
 112 make_exp (App e1 e2) = C.App (make_exp e1) (make_exp e2)
 113 make_exp (Lam v e) | isTyVar v = C.Lam (C.Tb (make_tbind v)) (make_exp e)
 114 make_exp (Lam v e) | otherwise = C.Lam (C.Vb (make_vbind v)) (make_exp e)
 115 make_exp (Let b e) = C.Let (make_vdef b) (make_exp e)
 116 -- gaw 2004
 117 make_exp (Case e v ty alts) = C.Case (make_exp e) (make_vbind v) (make_ty ty) (map make_alt alts)
 118 make_exp (Note (SCC cc) e) = C.Note "SCC"  (make_exp e) -- temporary
 119 make_exp (Note (Coerce t_to t_from) e) = C.Coerce (make_ty t_to) (make_exp e)
 120 make_exp (Note InlineCall e) = C.Note "InlineCall" (make_exp e)
 121 make_exp (Note (CoreNote s) e) = C.Note s (make_exp e)  -- hdaume: core annotations
 122 make_exp (Note InlineMe e) = C.Note "InlineMe" (make_exp e)
 123 make_exp _ = error "MkExternalCore died: make_exp"
 124
 125 make_alt :: CoreAlt -> C.Alt
 126 make_alt (DataAlt dcon, vs, e) =
 127     C.Acon (make_con_qid (dataConName dcon))
 128            (map make_tbind tbs)
 129            (map make_vbind vbs)
 130            (make_exp e)
 131         where (tbs,vbs) = span isTyVar vs
 132 make_alt (LitAlt l,_,e) = C.Alit (make_lit l) (make_exp e)
 133 make_alt (DEFAULT,[],e) = C.Adefault (make_exp e)
 134
 135 make_lit :: Literal -> C.Lit
 136 make_lit l =
 137   case l of
 138     MachChar i -> C.Lchar i t
 139     MachStr s -> C.Lstring (unpackFS s) t
 140     MachNullAddr -> C.Lint 0 t
 141     MachInt i -> C.Lint i t
 142     MachInt64 i -> C.Lint i t
 143     MachWord i -> C.Lint i t
 144     MachWord64 i -> C.Lint i t
 145     MachFloat r -> C.Lrational r t
 146     MachDouble r -> C.Lrational r t
 147     _ -> error "MkExternalCore died: make_lit"
 148   where
 149     t = make_ty (literalType l)
 150
 151 make_ty :: Type -> C.Ty
 152 make_ty (TyVarTy tv)             = C.Tvar (make_var_id (tyVarName tv))
 153 make_ty (AppTy t1 t2)            = C.Tapp (make_ty t1) (make_ty t2)
 154 make_ty (FunTy t1 t2)            = make_ty (TyConApp funTyCon [t1,t2])
 155 make_ty (ForAllTy tv t)          = C.Tforall (make_tbind tv) (make_ty t)
 156 make_ty (TyConApp tc ts)         = foldl C.Tapp (C.Tcon (make_con_qid (tyConName tc)))
 157                                          (map make_ty ts)
 158 -- Newtypes are treated just like any other type constructor; not expanded
 159 -- Reason: predTypeRep does substitution and, while substitution deals
 160 --         correctly with name capture, it's only correct if you see the uniques!
 161 --         If you just see occurrence names, name capture may occur.
 162 -- Example: newtype A a = A (forall b. b -> a)
 163 --          test :: forall q b. q -> A b
 164 --          test _ = undefined
 165 --      Here the 'a' gets substituted by 'b', which is captured.
 166 -- Another solution would be to expand newtypes before tidying; but that would
 167 -- expose the representation in interface files, which definitely isn't right.
 168 -- Maybe CoreTidy should know whether to expand newtypes or not?
 169
 170 make_ty (PredTy p)      = make_ty (predTypeRep p)
 171 make_ty (NoteTy _ t)    = make_ty t
 172
 173
 174
 175 make_kind :: Kind -> C.Kind
 176 make_kind (FunKind k1 k2)  = C.Karrow (make_kind k1) (make_kind k2)
 177 make_kind LiftedTypeKind   = C.Klifted
 178 make_kind UnliftedTypeKind = C.Kunlifted
 179 make_kind OpenTypeKind     = C.Kopen
 180 make_kind _ = error "MkExternalCore died: make_kind"
 181
 182 {- Id generation. -}
 183
 184 {- Use encoded strings.
 185    Also, adjust casing to work around some badly-chosen internal names. -}
 186 make_id :: Bool -> Name -> C.Id
 187 make_id is_var nm = (occNameString . nameOccName) nm
 188
 189 {-      SIMON thinks this stuff isn't necessary
 190 make_id is_var nm =
 191   case n of
 192     'Z':cs | is_var -> 'z':cs
 193     'z':cs | not is_var -> 'Z':cs
 194     c:cs | isUpper c && is_var -> 'z':'d':n
 195     c:cs | isLower c && (not is_var) -> 'Z':'d':n
 196     _ -> n
 197   where n = (occNameString . nameOccName) nm
 198 -}
 199
 200 make_var_id :: Name -> C.Id
 201 make_var_id = make_id True
 202
 203 make_mid :: Module -> C.Id
 204 make_mid = moduleString
 205
 206 make_qid :: Bool -> Name -> C.Qual C.Id
 207 make_qid is_var n = (mname,make_id is_var n)
 208     where mname =
 209            case nameModule_maybe n of
 210             Just m -> make_mid m
 211             Nothing -> ""
 212
 213 make_var_qid :: Name -> C.Qual C.Id
 214 make_var_qid = make_qid True
 215
 216 make_con_qid :: Name -> C.Qual C.Id
 217 make_con_qid = make_qid False
 218
 219 \end{code}
 220
 221
 222
 223