[project @ 1998-12-02 13:17:09 by simonm]
[ghc-hetmet.git] / ghc / compiler / deSugar / DsCCall.lhs
index e8f20fa..08fa624 100644 (file)
@@ -1,37 +1,44 @@
 %
-% (c) The AQUA Project, Glasgow University, 1994-1996
+% (c) The AQUA Project, Glasgow University, 1994-1998
 %
 \section[DsCCall]{Desugaring \tr{_ccall_}s and \tr{_casm_}s}
 
 \begin{code}
-#include "HsVersions.h"
-
-module DsCCall ( dsCCall ) where
+module DsCCall 
+       ( dsCCall
+       , unboxArg
+       , boxResult
+       ,  wrapUnboxedValue
+       , can'tSeeDataConsPanic
+       
+       ) where
 
-IMP_Ubiq()
+#include "HsVersions.h"
 
 import CoreSyn
 
 import DsMonad
 import DsUtils
 
+import TcHsSyn         ( maybeBoxedPrimType )
 import CoreUtils       ( coreExprType )
-import Id              ( dataConArgTys )
+import Id              ( Id, mkWildId )
+import Const           ( Con(..) )
 import Maybes          ( maybeToBool )
-import PprStyle                ( PprStyle(..) )
-import PprType         ( GenType{-instances-} )
-import Pretty
-import PrelVals                ( packStringForCId )
+import PrelInfo                ( packStringForCId )
 import PrimOp          ( PrimOp(..) )
-import Type            ( isPrimType, maybeAppDataTyConExpandingDicts, maybeAppTyCon,
-                         eqTy, maybeBoxedPrimType )
-import TysPrim         ( byteArrayPrimTy, realWorldTy,  realWorldStatePrimTy,
+import DataCon         ( DataCon, dataConId, dataConArgTys )
+import CallConv
+import Type            ( isUnLiftedType, splitAlgTyConApp_maybe, mkFunTys,
+                         splitTyConApp_maybe, Type
+                       )
+import TysPrim         ( byteArrayPrimTy, realWorldStatePrimTy,
                          byteArrayPrimTyCon, mutableByteArrayPrimTyCon )
-import TysWiredIn      ( getStatePairingConInfo,
-                         realWorldStateTy, stateDataCon, pairDataCon, unitDataCon,
-                         stringTy
+import TysWiredIn      ( unitDataCon, stringTy,
+                         mkUnboxedTupleTy, unboxedPairDataCon,
+                         mkUnboxedTupleTy, unboxedTupleCon
                        )
-import Util            ( pprPanic, pprError, panic )
+import Outputable
 \end{code}
 
 Desugaring of @ccall@s consists of adding some state manipulation,
@@ -74,31 +81,34 @@ dsCCall :: FAST_STRING      -- C routine to invoke
        -> [CoreExpr]   -- Arguments (desugared)
        -> Bool         -- True <=> might cause Haskell GC
        -> Bool         -- True <=> really a "_casm_"
-       -> Type         -- Type of the result (a boxed-prim type)
+       -> Type         -- Type of the result (a boxed-prim IO type)
        -> DsM CoreExpr
 
 dsCCall label args may_gc is_asm result_ty
-  = newSysLocalDs realWorldStateTy     `thenDs` \ old_s ->
-
-    mapAndUnzipDs unboxArg (Var old_s : args)  `thenDs` \ (final_args, arg_wrappers) ->
+  = newSysLocalDs realWorldStatePrimTy `thenDs` \ old_s ->
 
-    boxResult result_ty                                `thenDs` \ (final_result_ty, res_wrapper) ->
+    mapAndUnzipDs unboxArg args        `thenDs` \ (unboxed_args, arg_wrappers) ->
+    boxResult result_ty                `thenDs` \ (final_result_ty, res_wrapper) ->
 
     let
-       the_ccall_op = CCallOp label is_asm may_gc
-                              (map coreExprType final_args)
-                              final_result_ty
-    in
-    mkPrimDs the_ccall_op (map VarArg final_args) `thenDs` \ the_prim_app ->
-    let
+       val_args   = Var old_s : unboxed_args
+       final_args = Type inst_ty : val_args
+
+       -- A CCallOp has type (forall a. a), so we must instantiate
+       -- it at the full type, including the state argument
+       inst_ty = mkFunTys (map coreExprType val_args) final_result_ty
+
+       the_ccall_op = CCallOp (Left label) is_asm may_gc cCallConv
+       the_prim_app = mkPrimApp the_ccall_op final_args
+
        the_body = foldr ($) (res_wrapper the_prim_app) arg_wrappers
     in
-    returnDs (Lam (ValBinder old_s) the_body)
+    returnDs (Lam old_s the_body)
 \end{code}
 
 \begin{code}
 unboxArg :: CoreExpr                   -- The supplied argument
-        -> DsM (CoreExpr,                      -- To pass as the actual argument
+        -> DsM (CoreExpr,              -- To pass as the actual argument
                 CoreExpr -> CoreExpr   -- Wrapper to unbox the arg
                )
 unboxArg arg
@@ -106,22 +116,27 @@ unboxArg arg
   -- Primitive types
   -- ADR Question: can this ever be used?  None of the PrimTypes are
   -- instances of the CCallable class.
-  | isPrimType arg_ty
+  --
+  -- SOF response:
+  --    Oh yes they are, I've just added them :-) Having _ccall_ and _casm_
+  --  that accept unboxed arguments is a Good Thing if you have a stub generator
+  --  which generates the boiler-plate box-unbox code for you, i.e., it may help
+  --  us nuke this very module :-)
+  --
+  | isUnLiftedType arg_ty
   = returnDs (arg, \body -> body)
 
   -- Strings
-  | arg_ty `eqTy` stringTy
+  | arg_ty == stringTy
   -- ToDo (ADR): - allow synonyms of Strings too?
   = newSysLocalDs byteArrayPrimTy              `thenDs` \ prim_arg ->
-    mkAppDs (Var packStringForCId) [VarArg arg]        `thenDs` \ pack_appn ->
     returnDs (Var prim_arg,
-             \body -> Case pack_appn (PrimAlts []
-                                                   (BindDefault prim_arg body))
-    )
+             \body -> Case (App (Var packStringForCId) arg) 
+                           prim_arg [(DEFAULT,[],body)])
 
   | null data_cons
     -- oops: we can't see the data constructors!!!
-  = can't_see_datacons_error "argument" arg_ty
+  = can'tSeeDataConsPanic "argument" arg_ty
 
   -- Byte-arrays, both mutable and otherwise; hack warning
   | is_data_type &&
@@ -130,29 +145,30 @@ unboxArg arg
     (arg2_tycon ==  byteArrayPrimTyCon ||
      arg2_tycon ==  mutableByteArrayPrimTyCon)
     -- and, of course, it is an instance of CCallable
-  = newSysLocalsDs data_con_arg_tys            `thenDs` \ vars@[ixs_var, arr_cts_var] ->
+  = newSysLocalDs arg_ty               `thenDs` \ case_bndr ->
+    newSysLocalsDs data_con_arg_tys    `thenDs` \ vars@[ixs_var, arr_cts_var] ->
     returnDs (Var arr_cts_var,
-             \ body -> Case arg (AlgAlts [(the_data_con,vars,body)]
-                                             NoDefault)
+             \ body -> Case arg case_bndr [(DataCon the_data_con,vars,body)]
     )
 
   -- Data types with a single constructor, which has a single, primitive-typed arg
   | maybeToBool maybe_boxed_prim_arg_ty
-  = newSysLocalDs the_prim_arg_ty              `thenDs` \ prim_arg ->
+  = newSysLocalDs arg_ty               `thenDs` \ case_bndr ->
+    newSysLocalDs the_prim_arg_ty      `thenDs` \ prim_arg ->
     returnDs (Var prim_arg,
-             \ body -> Case arg (AlgAlts [(box_data_con,[prim_arg],body)]
-                                             NoDefault)
+             \ body -> Case arg case_bndr [(DataCon box_data_con,[prim_arg],body)]
     )
 
   | otherwise
-  = pprPanic "unboxArg: " (ppr PprDebug arg_ty)
+  = getSrcLocDs `thenDs` \ l ->
+    pprPanic "unboxArg: " (ppr l <+> ppr arg_ty)
   where
     arg_ty = coreExprType arg
 
     maybe_boxed_prim_arg_ty = maybeBoxedPrimType arg_ty
     (Just (box_data_con, the_prim_arg_ty)) = maybe_boxed_prim_arg_ty
 
-    maybe_data_type                       = maybeAppDataTyConExpandingDicts arg_ty
+    maybe_data_type                       = splitAlgTyConApp_maybe arg_ty
     is_data_type                          = maybeToBool maybe_data_type
     (Just (tycon, tycon_arg_tys, data_cons)) = maybe_data_type
     (the_data_con : other_data_cons)       = data_cons
@@ -160,78 +176,119 @@ unboxArg arg
     data_con_arg_tys = dataConArgTys the_data_con tycon_arg_tys
     (data_con_arg_ty1 : data_con_arg_ty2 : _) = data_con_arg_tys
 
-    maybe_arg2_tycon = maybeAppTyCon data_con_arg_ty2
+    maybe_arg2_tycon = splitTyConApp_maybe data_con_arg_ty2
     Just (arg2_tycon,_) = maybe_arg2_tycon
 
-can't_see_datacons_error thing ty
-  = pprError "ERROR: Can't see the data constructor(s) for _ccall_/_casm_ "
-            (ppBesides [ppStr thing, ppStr "; type: ", ppr PprForUser ty])
+can'tSeeDataConsPanic thing ty
+  = pprPanic "ERROR: Can't see the data constructor(s) for _ccall_/_casm_/foreign declaration"
+            (hcat [text thing, text "; type: ", ppr ty, text "(try compiling with -fno-prune-tydecls ..)\n"])
+
 \end{code}
 
 
 \begin{code}
-boxResult :: Type                              -- Type of desired result
+boxResult :: Type                      -- Type of desired result
          -> DsM (Type,                 -- Type of the result of the ccall itself
                  CoreExpr -> CoreExpr) -- Wrapper for the ccall
-                                                       -- to box the result
+                                       -- to box the result
 boxResult result_ty
   | null data_cons
   -- oops! can't see the data constructors
-  = can't_see_datacons_error "result" result_ty
+  = can'tSeeDataConsPanic "result" result_ty
 
-  -- Data types with a single constructor, which has a single, primitive-typed arg
+  -- Data types with a single nullary constructor
   | (maybeToBool maybe_data_type) &&                           -- Data type
     (null other_data_cons) &&                                  -- Just one constr
-    not (null data_con_arg_tys) && null other_args_tys &&      -- Just one arg
-    isPrimType the_prim_result_ty                              -- of primitive type
+    (null data_con_arg_tys)
   =
-    newSysLocalDs realWorldStatePrimTy                 `thenDs` \ prim_state_id ->
-    newSysLocalDs the_prim_result_ty                   `thenDs` \ prim_result_id ->
-
-    mkConDs stateDataCon [TyArg realWorldTy, VarArg (Var prim_state_id)]  `thenDs` \ new_state ->
-    mkConDs the_data_con (map TyArg tycon_arg_tys ++ [VarArg (Var prim_result_id)]) `thenDs` \ the_result ->
-
-    mkConDs pairDataCon
-           [TyArg result_ty, TyArg realWorldStateTy, VarArg the_result, VarArg new_state]
+    newSysLocalDs realWorldStatePrimTy         `thenDs` \ prim_state_id ->
+{-
+    wrapUnboxedValue result_ty                 `thenDs` \ (state_and_prim_datacon,
+                                                           state_and_prim_ty, prim_result_id, the_result) ->
+    mkConDs ioOkDataCon
+           [TyArg result_ty, VarArg (Var prim_state_id), VarArg the_result]
                                                        `thenDs` \ the_pair ->
+-}
     let
-       the_alt = (state_and_prim_datacon, [prim_state_id, prim_result_id], the_pair)
+       the_pair = mkConApp unboxedPairDataCon
+                           [Type realWorldStatePrimTy, Type result_ty, 
+                            Var prim_state_id, 
+                            Con (DataCon unitDataCon) []]
+       the_alt  = (DataCon (unboxedTupleCon 1), [prim_state_id], the_pair)
+       scrut_ty = mkUnboxedTupleTy 1 [realWorldStatePrimTy]
     in
-    returnDs (state_and_prim_ty,
-             \prim_app -> Case prim_app (AlgAlts [the_alt] NoDefault)
+    returnDs (scrut_ty, \prim_app -> Case prim_app (mkWildId scrut_ty) [the_alt]
     )
 
-  -- Data types with a single nullary constructor
+  -- Data types with a single constructor, which has a single, primitive-typed arg
   | (maybeToBool maybe_data_type) &&                           -- Data type
     (null other_data_cons) &&                                  -- Just one constr
-    (null data_con_arg_tys)
+    not (null data_con_arg_tys) && null other_args_tys &&      -- Just one arg
+    isUnLiftedType the_prim_result_ty                          -- of primitive type
   =
     newSysLocalDs realWorldStatePrimTy         `thenDs` \ prim_state_id ->
-
-    mkConDs stateDataCon [TyArg realWorldTy, VarArg (Var prim_state_id)]
-                                               `thenDs` \ new_state ->
-    mkConDs pairDataCon
-           [TyArg result_ty, TyArg realWorldStateTy, VarArg (Var unitDataCon), VarArg new_state]
-                                               `thenDs` \ the_pair ->
+    newSysLocalDs the_prim_result_ty           `thenDs` \ prim_result_id ->
+    newSysLocalDs ccall_res_type               `thenDs` \ case_bndr ->
 
     let
-       the_alt  = (stateDataCon, [prim_state_id], the_pair)
+       the_result = mkConApp the_data_con (map Type tycon_arg_tys ++ [Var prim_result_id])
+       the_pair   = mkConApp unboxedPairDataCon
+                               [Type realWorldStatePrimTy, Type result_ty, 
+                                Var prim_state_id, the_result]
+       the_alt    = (DataCon unboxedPairDataCon, [prim_state_id, prim_result_id], the_pair)
     in
-    returnDs (realWorldStateTy,
-             \prim_app -> Case prim_app (AlgAlts [the_alt] NoDefault)
+    returnDs (ccall_res_type, \prim_app -> Case prim_app case_bndr [the_alt]
     )
 
   | otherwise
-  = pprPanic "boxResult: " (ppr PprDebug result_ty)
-
+  = pprPanic "boxResult: " (ppr result_ty)
   where
-    maybe_data_type                       = maybeAppDataTyConExpandingDicts result_ty
+    maybe_data_type                       = splitAlgTyConApp_maybe result_ty
     Just (tycon, tycon_arg_tys, data_cons) = maybe_data_type
     (the_data_con : other_data_cons)       = data_cons
+    ccall_res_type = mkUnboxedTupleTy 2 
+                       [realWorldStatePrimTy, the_prim_result_ty]
 
     data_con_arg_tys                      = dataConArgTys the_data_con tycon_arg_tys
     (the_prim_result_ty : other_args_tys)  = data_con_arg_tys
 
-    (state_and_prim_datacon, state_and_prim_ty) = getStatePairingConInfo the_prim_result_ty
-\end{code}
+-- wrap up an unboxed value.
+wrapUnboxedValue :: Type -> DsM (Type, Id, CoreExpr)
+wrapUnboxedValue ty
+  | null data_cons
+      -- oops! can't see the data constructors
+  = can'tSeeDataConsPanic "result" ty
+    -- Data types with a single constructor, which has a single, primitive-typed arg
+  | (maybeToBool maybe_data_type) &&                           -- Data type
+    (null other_data_cons) &&                                  -- Just one constr
+    not (null data_con_arg_tys) && null other_args_tys &&      -- Just one arg
+    isUnLiftedType the_prim_result_ty                          -- of primitive type
+  =
+    newSysLocalDs the_prim_result_ty                    `thenDs` \ prim_result_id ->
+    let
+       the_result = mkConApp the_data_con (map Type tycon_arg_tys ++ [Var prim_result_id])
+    in
+    returnDs (ccall_res_type, prim_result_id, the_result)
 
+  -- Data types with a single nullary constructor
+  | (maybeToBool maybe_data_type) &&                           -- Data type
+    (null other_data_cons) &&                                  -- Just one constr
+    (null data_con_arg_tys)
+  =
+    let unit = dataConId unitDataCon
+       scrut_ty = mkUnboxedTupleTy 1 [realWorldStatePrimTy]
+    in
+    returnDs (scrut_ty, unit, mkConApp unitDataCon [])
+  | otherwise
+  = pprPanic "boxResult: " (ppr ty)
+ where
+   maybe_data_type                       = splitAlgTyConApp_maybe ty
+   Just (tycon, tycon_arg_tys, data_cons) = maybe_data_type
+   (the_data_con : other_data_cons)       = data_cons
+   ccall_res_type = mkUnboxedTupleTy 2 
+                       [realWorldStatePrimTy, the_prim_result_ty]
+
+   data_con_arg_tys                      = dataConArgTys the_data_con tycon_arg_tys
+   (the_prim_result_ty : other_args_tys)  = data_con_arg_tys
+
+\end{code}