2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
4 \section[Foreign]{Foreign calls}
8 -- The above warning supression flag is a temporary kludge.
9 -- While working on this module you are encouraged to remove it and fix
10 -- any warnings in the module. See
11 -- http://hackage.haskell.org/trac/ghc/wiki/Commentary/CodingStyle#Warnings
16 Safety(..), playSafe, playThreadSafe,
18 CExportSpec(..), CLabelString, isCLabelString, pprCLabelString,
20 CCallTarget(..), isDynamicTarget,
21 CCallConv(..), defaultCCallConv, ccallConvToInt, ccallConvAttribute,
23 DNCallSpec(..), DNKind(..), DNType(..),
28 import Char ( isAlphaNum )
34 %************************************************************************
36 \subsubsection{Data types}
38 %************************************************************************
44 deriving( Eq ) -- We compare them when seeing if an interface
45 -- has changed (for versioning purposes)
46 {-! derive: Binary !-}
48 -- We may need more clues to distinguish foreign calls
49 -- but this simple printer will do for now
50 instance Outputable ForeignCall where
51 ppr (CCall cc) = ppr cc
52 ppr (DNCall dn) = ppr dn
58 = PlaySafe -- Might invoke Haskell GC, or do a call back, or
59 -- switch threads, etc. So make sure things are
60 -- tidy before the call
61 Bool -- => True, external function is also re-entrant.
62 -- [if supported, RTS arranges for the external call
63 -- to be executed by a separate OS thread, i.e.,
64 -- _concurrently_ to the execution of other Haskell threads.]
66 | PlayRisky -- None of the above can happen; the call will return
67 -- without interacting with the runtime system at all
69 -- Show used just for Show Lex.Token, I think
70 {-! derive: Binary !-}
72 instance Outputable Safety where
73 ppr (PlaySafe False) = ptext (sLit "safe")
74 ppr (PlaySafe True) = ptext (sLit "threadsafe")
75 ppr PlayRisky = ptext (sLit "unsafe")
77 playSafe :: Safety -> Bool
78 playSafe PlaySafe{} = True
79 playSafe PlayRisky = False
81 playThreadSafe :: Safety -> Bool
82 playThreadSafe (PlaySafe x) = x
83 playThreadSafe _ = False
87 %************************************************************************
89 \subsubsection{Calling C}
91 %************************************************************************
95 = CExportStatic -- foreign export ccall foo :: ty
96 CLabelString -- C Name of exported function
98 {-! derive: Binary !-}
101 = CCallSpec CCallTarget -- What to call
102 CCallConv -- Calling convention to use.
105 {-! derive: Binary !-}
112 = StaticTarget CLabelString -- An "unboxed" ccall# to `fn'.
113 | DynamicTarget -- First argument (an Addr#) is the function pointer
115 {-! derive: Binary !-}
117 isDynamicTarget :: CCallTarget -> Bool
118 isDynamicTarget DynamicTarget = True
119 isDynamicTarget _ = False
123 Stuff to do with calling convention:
125 ccall: Caller allocates parameters, *and* deallocates them.
127 stdcall: Caller allocates parameters, callee deallocates.
128 Function name has @N after it, where N is number of arg bytes
131 ToDo: The stdcall calling convention is x86 (win32) specific,
132 so perhaps we should emit a warning if it's being used on other
136 data CCallConv = CCallConv | StdCallConv | CmmCallConv
138 {-! derive: Binary !-}
140 instance Outputable CCallConv where
141 ppr StdCallConv = ptext (sLit "stdcall")
142 ppr CCallConv = ptext (sLit "ccall")
143 ppr CmmCallConv = ptext (sLit "C--")
145 defaultCCallConv :: CCallConv
146 defaultCCallConv = CCallConv
148 ccallConvToInt :: CCallConv -> Int
149 ccallConvToInt StdCallConv = 0
150 ccallConvToInt CCallConv = 1
153 Generate the gcc attribute corresponding to the given
154 calling convention (used by PprAbsC):
157 ccallConvAttribute :: CCallConv -> String
158 ccallConvAttribute StdCallConv = "__attribute__((__stdcall__))"
159 ccallConvAttribute CCallConv = ""
163 type CLabelString = FastString -- A C label, completely unencoded
165 pprCLabelString :: CLabelString -> SDoc
166 pprCLabelString lbl = ftext lbl
168 isCLabelString :: CLabelString -> Bool -- Checks to see if this is a valid C label
170 = all ok (unpackFS lbl)
172 ok c = isAlphaNum c || c == '_' || c == '.'
173 -- The '.' appears in e.g. "foo.so" in the
174 -- module part of a ExtName. Maybe it should be separate
178 Printing into C files:
181 instance Outputable CExportSpec where
182 ppr (CExportStatic str _) = pprCLabelString str
184 instance Outputable CCallSpec where
185 ppr (CCallSpec fun cconv safety)
186 = hcat [ ifPprDebug callconv, ppr_fun fun ]
188 callconv = text "{-" <> ppr cconv <> text "-}"
190 gc_suf | playSafe safety = text "_GC"
193 ppr_fun DynamicTarget = text "__dyn_ccall" <> gc_suf <+> text "\"\""
194 ppr_fun (StaticTarget fn) = text "__ccall" <> gc_suf <+> pprCLabelString fn
198 %************************************************************************
200 \subsubsection{.NET interop}
202 %************************************************************************
206 DNCallSpec Bool -- True => static method/field
207 DNKind -- what type of access
209 String -- fully qualified method/field name.
210 [DNType] -- argument types.
211 DNType -- result type.
213 {-! derive: Binary !-}
220 {-! derive: Binary !-}
242 {-! derive: Binary !-}
244 withDNTypes :: DNCallSpec -> [DNType] -> DNType -> DNCallSpec
245 withDNTypes (DNCallSpec isStatic k assem nm _ _) argTys resTy
246 = DNCallSpec isStatic k assem nm argTys resTy
248 instance Outputable DNCallSpec where
249 ppr (DNCallSpec isStatic kind ass nm _ _ )
251 (if isStatic then text "static" else empty) <+>
252 (text (case kind of { DNMethod -> "method" ; DNField -> "field"; DNConstructor -> "ctor" })) <+>
253 (if null ass then char ' ' else char '[' <> text ass <> char ']') <>
260 %************************************************************************
264 %************************************************************************
267 {-* Generated by DrIFT-v1.0 : Look, but Don't Touch. *-}
268 instance Binary ForeignCall where
269 put_ bh (CCall aa) = do
272 put_ bh (DNCall ab) = do
283 instance Binary Safety where
284 put_ bh (PlaySafe aa) = do
287 put_ bh PlayRisky = do
294 _ -> do return PlayRisky
296 instance Binary CExportSpec where
297 put_ bh (CExportStatic aa ab) = do
303 return (CExportStatic aa ab)
305 instance Binary CCallSpec where
306 put_ bh (CCallSpec aa ab ac) = do
314 return (CCallSpec aa ab ac)
316 instance Binary CCallTarget where
317 put_ bh (StaticTarget aa) = do
320 put_ bh DynamicTarget = do
326 return (StaticTarget aa)
327 _ -> do return DynamicTarget
329 instance Binary CCallConv where
330 put_ bh CCallConv = do
332 put_ bh StdCallConv = do
337 0 -> do return CCallConv
338 _ -> do return StdCallConv
340 instance Binary DNCallSpec where
341 put_ bh (DNCallSpec isStatic kind ass nm _ _) = do
351 return (DNCallSpec isStatic kind ass nm [] undefined)
353 instance Binary DNKind where
354 put_ bh DNMethod = do
358 put_ bh DNConstructor = do
363 0 -> do return DNMethod
364 1 -> do return DNField
365 _ -> do return DNConstructor
367 instance Binary DNType where
374 put_ bh DNDouble = do
390 put_ bh DNWord16 = do
392 put_ bh DNWord32 = do
394 put_ bh DNWord64 = do
400 put_ bh DNObject = do
402 put_ bh DNString = do
419 11 -> return DNWord16
420 12 -> return DNWord32
421 13 -> return DNWord64
424 16 -> return DNObject
425 17 -> return DNString
427 -- Imported from other files :-