1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
|
(*
Copyright (c) 2000
Cambridge University Technical Services Limited
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*)
signature CInterfaceSig = sig
(**********************************************************************
* ForeignException
**********************************************************************)
exception Foreign of string;
(**********************************************************************
* ForeignDebug
**********************************************************************)
val get_foreign_debug : unit -> int
val set_foreign_debug : int -> unit
(**********************************************************************
* Ctype
**********************************************************************)
include CtypeSig
(**********************************************************************
* LowerLevel
**********************************************************************)
type vol
val alloc : int -> Ctype -> vol
val address : vol -> vol
val deref : vol -> vol
val offset : int -> Ctype -> vol -> vol
val assign : Ctype -> vol -> vol -> unit
val null : vol
val max_volatile_creation_info_depth : int ref;
val inform_about_symbol_reload : bool ref;
val fillCstring : vol -> string -> unit
val toCstring : string -> vol
val toCchar : char -> vol
val toCdouble : real -> vol
val toCfloat : real -> vol
val toCint : int -> vol
val toClong : int -> vol
val toCshort : int -> vol
val toCuint : int -> vol
val toCbytes : Word8Vector.vector -> vol
(* These take an argument type list, the result type and an ML function
and create a C function value which can be passed to a C function.
Functions with Pascal calling conventions are used for Windows callbacks. *)
val toCfunction : Ctype list -> Ctype -> (vol list -> vol) -> vol
val toPascalfunction : Ctype list -> Ctype -> (vol list -> vol) -> vol
(* We don't currently provide the reverse although we could probably use the
call_sym function.
val fromCfunction : vol -> (Ctype * vol) list -> Ctype -> vol
val fromPascalfunction : vol -> (Ctype * vol) list -> Ctype -> vol
*)
val fromCstring : vol -> string
val fromCchar : vol -> char
val fromCdouble : vol -> real
val fromCfloat : vol -> real
val fromCint : vol -> int
val fromClong : vol -> int
val fromCshort : vol -> int
val fromCuint : vol -> int
val fromCbytes : vol * int -> Word8Vector.vector
type dylib
type sym
val load_lib : string -> dylib
val load_sym : dylib -> string -> sym
val get_sym : string -> string -> sym
val setFinal : sym -> vol -> unit
val set_libPath : dylib -> string -> unit
val get_libPath : dylib -> string
val call_sym : sym -> (Ctype * vol) list -> Ctype -> vol
structure Union : UnionSig
val call_sym_and_convert
: sym -> (Ctype, vol) Union.directedArg list -> Ctype Union.unionChoice
-> (vol Union.union * vol Union.union list)
val volOfSym : sym -> vol
val mapSym : (vol -> 'a) -> sym -> 'a
(**********************************************************************
* CallWithConv
**********************************************************************)
type 'a Conversion;
val mapConversion : ('a -> 'b) * ('b -> 'a) -> 'a Conversion -> 'b Conversion
val mkConversion : (vol -> 'a) -> ('a -> vol) -> Ctype -> 'a Conversion
val breakConversion : 'a Conversion -> (vol -> 'a) * ('a -> vol) * Ctype
val global : sym -> 'a Conversion -> unit -> 'a
val setGlobal:sym -> 'a Conversion -> 'a -> unit
val call0 : sym -> unit -> 'a Conversion -> unit -> 'a
val call1 : sym -> 'a Conversion -> 'b Conversion -> 'a -> 'b
val call2 : sym -> 'a Conversion * 'b Conversion -> 'c Conversion -> 'a * 'b -> 'c
val call3 : sym ->
'a Conversion
* 'b Conversion
* 'c Conversion -> 'd Conversion
-> 'a * 'b * 'c -> 'd
val call4 : sym ->
'a Conversion
* 'b Conversion
* 'c Conversion
* 'd Conversion -> 'e Conversion
-> 'a * 'b * 'c * 'd -> 'e
val call5 : sym ->
'a Conversion
* 'b Conversion
* 'c Conversion
* 'd Conversion
* 'e Conversion -> 'f Conversion
-> 'a * 'b * 'c * 'd * 'e -> 'f
val call6 : sym ->
'a Conversion
* 'b Conversion
* 'c Conversion
* 'd Conversion
* 'e Conversion
* 'f Conversion -> 'g Conversion
-> 'a * 'b * 'c * 'd * 'e * 'f -> 'g
val call7 : sym ->
'a Conversion
* 'b Conversion
* 'c Conversion
* 'd Conversion
* 'e Conversion
* 'f Conversion
* 'g Conversion -> 'h Conversion
-> 'a * 'b * 'c * 'd * 'e * 'f * 'g -> 'h
val call8 : sym ->
'a Conversion
* 'b Conversion
* 'c Conversion
* 'd Conversion
* 'e Conversion
* 'f Conversion
* 'g Conversion
* 'h Conversion -> 'i Conversion
-> 'a * 'b * 'c * 'd * 'e * 'f * 'g * 'h -> 'i
val call9 : sym ->
'a Conversion
* 'b Conversion
* 'c Conversion
* 'd Conversion
* 'e Conversion
* 'f Conversion
* 'g Conversion
* 'h Conversion
* 'i Conversion -> 'j Conversion
-> 'a * 'b * 'c * 'd * 'e * 'f * 'g * 'h * 'i -> 'j
val call10 : sym ->
'a Conversion
* 'b Conversion
* 'c Conversion
* 'd Conversion
* 'e Conversion
* 'f Conversion
* 'g Conversion
* 'h Conversion
* 'i Conversion
* 'j Conversion -> 'k Conversion
-> 'a * 'b * 'c * 'd * 'e * 'f * 'g * 'h * 'i * 'j -> 'k
val call11 : sym ->
'a Conversion
* 'b Conversion
* 'c Conversion
* 'd Conversion
* 'e Conversion
* 'f Conversion
* 'g Conversion
* 'h Conversion
* 'i Conversion
* 'j Conversion
* 'k Conversion -> 'l Conversion
-> 'a * 'b * 'c * 'd * 'e * 'f * 'g * 'h * 'i * 'j * 'k -> 'l
val call12 : sym ->
'a Conversion
* 'b Conversion
* 'c Conversion
* 'd Conversion
* 'e Conversion
* 'f Conversion
* 'g Conversion
* 'h Conversion
* 'i Conversion
* 'j Conversion
* 'k Conversion
* 'l Conversion -> 'm Conversion
-> 'a * 'b * 'c * 'd * 'e * 'f * 'g * 'h * 'i * 'j * 'k * 'l -> 'm
val call13 : sym ->
'a Conversion
* 'b Conversion
* 'c Conversion
* 'd Conversion
* 'e Conversion
* 'f Conversion
* 'g Conversion
* 'h Conversion
* 'i Conversion
* 'j Conversion
* 'k Conversion
* 'l Conversion
* 'm Conversion -> 'n Conversion
-> 'a * 'b * 'c * 'd * 'e * 'f * 'g * 'h * 'i * 'j * 'k * 'l * 'm -> 'n
val call14 : sym ->
'a Conversion
* 'b Conversion
* 'c Conversion
* 'd Conversion
* 'e Conversion
* 'f Conversion
* 'g Conversion
* 'h Conversion
* 'i Conversion
* 'j Conversion
* 'k Conversion
* 'l Conversion
* 'm Conversion
* 'n Conversion -> 'p Conversion
-> 'a * 'b * 'c * 'd * 'e * 'f * 'g * 'h * 'i * 'j * 'k * 'l * 'm * 'n -> 'p
val call15 : sym ->
'a Conversion
* 'b Conversion
* 'c Conversion
* 'd Conversion
* 'e Conversion
* 'f Conversion
* 'g Conversion
* 'h Conversion
* 'i Conversion
* 'j Conversion
* 'k Conversion
* 'l Conversion
* 'm Conversion
* 'n Conversion
* 'p Conversion -> 'q Conversion
-> 'a * 'b * 'c * 'd * 'e * 'f * 'g * 'h * 'i * 'j * 'k * 'l * 'm * 'n * 'p -> 'q
val call1ret1 : sym -> unit -> 'a Conversion -> unit -> 'a
val call2ret1 : sym -> 'a Conversion -> 'b Conversion -> 'a -> 'b
val call2ret2 : sym -> unit -> 'a Conversion * 'b Conversion -> unit -> 'a * 'b
val call3ret1 : sym -> 'a Conversion * 'b Conversion -> 'c Conversion -> 'a * 'b -> 'c
val call3ret2 : sym -> 'a Conversion -> 'b Conversion * 'c Conversion -> 'a -> 'b * 'c
val call4ret1 : sym ->
'a Conversion
* 'b Conversion
* 'c Conversion -> 'd Conversion -> 'a * 'b * 'c -> 'd
val call4ret2 : sym ->
'a Conversion
* 'b Conversion -> 'c Conversion
* 'd Conversion -> 'a * 'b -> 'c * 'd
val call4ret3 : sym ->
'a Conversion -> 'b Conversion
* 'c Conversion
* 'd Conversion -> 'a -> 'b * 'c * 'd
val call5ret1 : sym ->
'a Conversion
* 'b Conversion
* 'c Conversion
* 'd Conversion -> 'e Conversion -> 'a * 'b * 'c * 'd -> 'e
val call5ret2 : sym ->
'a Conversion
* 'b Conversion
* 'c Conversion -> 'd Conversion
* 'e Conversion -> 'a * 'b * 'c -> 'd * 'e
(**********************************************************************
* Struct
**********************************************************************)
val break_struct : Ctype list -> vol -> vol list
val make_struct : (Ctype * vol) list -> vol
(**********************************************************************
* Conversions
**********************************************************************)
val CHAR : char Conversion
val DOUBLE : real Conversion
val FLOAT : real Conversion
val INT : int Conversion
val LONG : int Conversion
val SHORT : int Conversion
val STRING : string Conversion
val VOID : unit Conversion
val BOOL : bool Conversion
val POINTER : vol Conversion
val UINT : int Conversion
val POINTERTO : 'a Conversion -> 'a Conversion
val STRING' : string Conversion
(**********************************************************************
* StructConversionals
**********************************************************************)
val STRUCT2 : 'a Conversion * 'b Conversion -> ('a * 'b) Conversion
val STRUCT3 : 'a Conversion * 'b Conversion * 'c Conversion -> ('a * 'b * 'c) Conversion
val STRUCT4 : 'a Conversion * 'b Conversion * 'c Conversion * 'd Conversion -> ('a * 'b * 'c * 'd) Conversion
val STRUCT5 : 'a Conversion * 'b Conversion * 'c Conversion * 'd Conversion * 'e Conversion -> ('a * 'b * 'c * 'd * 'e) Conversion
val STRUCT6 : 'a Conversion * 'b Conversion * 'c Conversion * 'd Conversion * 'e Conversion * 'f Conversion -> ('a * 'b * 'c * 'd * 'e * 'f) Conversion
val STRUCT7 : 'a Conversion * 'b Conversion * 'c Conversion * 'd Conversion * 'e Conversion * 'f Conversion * 'g Conversion -> ('a * 'b * 'c * 'd * 'e * 'f * 'g) Conversion
val STRUCT8 : 'a Conversion * 'b Conversion * 'c Conversion * 'd Conversion * 'e Conversion * 'f Conversion * 'g Conversion * 'h Conversion -> ('a * 'b * 'c * 'd * 'e * 'f * 'g * 'h) Conversion
val STRUCT9 : 'a Conversion * 'b Conversion * 'c Conversion * 'd Conversion * 'e Conversion * 'f Conversion * 'g Conversion * 'h Conversion * 'i Conversion -> ('a * 'b * 'c * 'd * 'e * 'f * 'g * 'h * 'i) Conversion
(**********************************************************************
* Function Conversionals
**********************************************************************)
val FUNCTION0 : unit -> 'a Conversion -> ( unit -> 'a ) Conversion
val PASCALFUNCTION0 : unit -> 'a Conversion -> ( unit -> 'a ) Conversion
val FUNCTION1 : 'a Conversion -> 'b Conversion -> ( 'a -> 'b ) Conversion
val PASCALFUNCTION1 : 'a Conversion -> 'b Conversion -> ( 'a -> 'b ) Conversion
val FUNCTION2 : 'a Conversion * 'b Conversion -> 'c Conversion -> ( 'a * 'b -> 'c) Conversion
val PASCALFUNCTION2 : 'a Conversion * 'b Conversion -> 'c Conversion -> ( 'a * 'b -> 'c) Conversion
val FUNCTION3 : 'a Conversion * 'b Conversion * 'c Conversion -> 'd Conversion
-> ( 'a * 'b * 'c -> 'd) Conversion
val PASCALFUNCTION3 : 'a Conversion * 'b Conversion * 'c Conversion -> 'd Conversion
-> ( 'a * 'b * 'c -> 'd) Conversion
val FUNCTION4 : 'a Conversion * 'b Conversion * 'c Conversion * 'd Conversion -> 'e Conversion
-> ( 'a * 'b * 'c * 'd -> 'e) Conversion
val PASCALFUNCTION4 : 'a Conversion * 'b Conversion * 'c Conversion * 'd Conversion -> 'e Conversion
-> ( 'a * 'b * 'c * 'd -> 'e) Conversion
end;
|
