* locales.c
[mono.git] / mono / metadata / marshal.h
1
2 /*
3  * marshal.h: Routines for marshaling complex types in P/Invoke methods.
4  * 
5  * Author:
6  *   Paolo Molaro (lupus@ximian.com)
7  *
8  * (C) 2002 Ximian, Inc.  http://www.ximian.com
9  *
10  */
11
12 #ifndef __MONO_MARSHAL_H__
13 #define __MONO_MARSHAL_H__
14
15 #include <mono/metadata/class.h>
16 #include <mono/metadata/object.h>
17 #include <mono/metadata/opcodes.h>
18 #include <mono/metadata/reflection.h>
19
20 typedef struct _MonoMethodBuilder MonoMethodBuilder;
21
22 /* marshaling helper functions */
23
24 void
25 mono_marshal_init (void);
26
27 gint32
28 mono_class_native_size (MonoClass *klass, guint32 *align);
29
30 MonoMarshalType *
31 mono_marshal_load_type_info (MonoClass* klass);
32
33 gint32
34 mono_marshal_type_size (MonoType *type, MonoMarshalSpec *mspec, gint32 *align, 
35                         gboolean as_field, gboolean unicode);
36
37 int            
38 mono_type_native_stack_size (MonoType *type, int *alignment);
39
40 gpointer
41 mono_array_to_savearray (MonoArray *array);
42
43 gpointer
44 mono_array_to_lparray (MonoArray *array);
45
46 void
47 mono_string_utf8_to_builder (MonoStringBuilder *sb, char *text);
48
49 void
50 mono_string_utf16_to_builder (MonoStringBuilder *sb, gunichar2 *text);
51
52 gpointer
53 mono_string_builder_to_utf8 (MonoStringBuilder *sb);
54
55 gpointer
56 mono_string_builder_to_utf16 (MonoStringBuilder *sb);
57
58 gpointer
59 mono_string_to_ansibstr (MonoString *string_obj);
60
61 gpointer
62 mono_string_to_bstr (MonoString *string_obj);
63
64 void
65 mono_string_to_byvalstr (gpointer dst, MonoString *src, int size);
66
67 void
68 mono_string_to_byvalwstr (gpointer dst, MonoString *src, int size);
69
70 gpointer
71 mono_delegate_to_ftnptr (MonoDelegate *delegate);
72
73 void * 
74 mono_marshal_string_array (MonoArray *array);
75
76 void *
77 mono_marshal_string_array_to_unicode (MonoArray *array);
78
79 void
80 mono_marshal_set_last_error (void);
81
82 /* method builder functions */
83
84 void
85 mono_mb_free (MonoMethodBuilder *mb);
86
87 MonoMethodBuilder *
88 mono_mb_new (MonoClass *klass, const char *name, MonoWrapperType type);
89
90 void
91 mono_mb_patch_addr (MonoMethodBuilder *mb, int pos, int value);
92
93 void
94 mono_mb_patch_addr_s (MonoMethodBuilder *mb, int pos, gint8 value);
95
96 guint32
97 mono_mb_add_data (MonoMethodBuilder *mb, gpointer data);
98
99 void
100 mono_mb_emit_native_call (MonoMethodBuilder *mb, MonoMethodSignature *sig, gpointer func);
101
102 void
103 mono_mb_emit_managed_call (MonoMethodBuilder *mb, MonoMethod *method, MonoMethodSignature *opt_sig);
104
105 int
106 mono_mb_add_local (MonoMethodBuilder *mb, MonoType *type);
107
108 MonoMethod *
109 mono_mb_create_method (MonoMethodBuilder *mb, MonoMethodSignature *signature, int max_stack);
110
111 void
112 mono_mb_emit_ldarg (MonoMethodBuilder *mb, guint argnum);
113
114 void
115 mono_mb_emit_ldarg_addr (MonoMethodBuilder *mb, guint argnum);
116
117 void
118 mono_mb_emit_ldloc (MonoMethodBuilder *mb, guint num);
119
120 void
121 mono_mb_emit_ldloc_addr (MonoMethodBuilder *mb, guint locnum);
122
123 void
124 mono_mb_emit_stloc (MonoMethodBuilder *mb, guint num);
125
126 void
127 mono_mb_emit_exception (MonoMethodBuilder *mb, const char *exc_name, const char *msg);
128
129 void
130 mono_mb_emit_icon (MonoMethodBuilder *mb, gint32 value);
131
132 guint32
133 mono_mb_emit_branch (MonoMethodBuilder *mb, guint8 op);
134
135 void
136 mono_mb_emit_add_to_local (MonoMethodBuilder *mb, guint16 local, gint32 incr);
137
138 void
139 mono_mb_emit_ldflda (MonoMethodBuilder *mb, gint32 offset);
140
141 void
142 mono_mb_emit_byte (MonoMethodBuilder *mb, guint8 op);
143
144 void
145 mono_mb_emit_i2 (MonoMethodBuilder *mb, gint16 data);
146
147 void
148 mono_mb_emit_i4 (MonoMethodBuilder *mb, gint32 data);
149
150 void
151 mono_mb_emit_ldstr (MonoMethodBuilder *mb, char *str);
152
153 /* functions to create various architecture independent helper functions */
154
155 MonoMethod *
156 mono_marshal_method_from_wrapper (MonoMethod *wrapper);
157
158 MonoMethod *
159 mono_marshal_get_remoting_invoke (MonoMethod *method);
160
161 MonoMethod *
162 mono_marshal_get_remoting_invoke_with_check (MonoMethod *method);
163
164 MonoMethod *
165 mono_marshal_get_delegate_begin_invoke (MonoMethod *method);
166
167 MonoMethod *
168 mono_marshal_get_delegate_end_invoke (MonoMethod *method);
169
170 MonoMethod *
171 mono_marshal_get_delegate_invoke (MonoMethod *method);
172
173 MonoMethod *
174 mono_marshal_get_runtime_invoke (MonoMethod *method);
175
176 MonoMethod *
177 mono_marshal_get_managed_wrapper (MonoMethod *method, MonoObject *this, MonoMarshalSpec **mspecs);
178
179 MonoMethod *
180 mono_marshal_get_icall_wrapper (MonoMethodSignature *sig, const char *name, gconstpointer func);
181
182 MonoMethod *
183 mono_marshal_get_native_wrapper (MonoMethod *method);
184
185 MonoMethod *
186 mono_marshal_get_struct_to_ptr (MonoClass *klass);
187
188 MonoMethod *
189 mono_marshal_get_ptr_to_struct (MonoClass *klass);
190
191 MonoMethod *
192 mono_marshal_get_stfld_wrapper (MonoType *type);
193
194 MonoMethod *
195 mono_marshal_get_ldfld_wrapper (MonoType *type);
196
197 MonoMethod *
198 mono_marshal_get_synchronized_wrapper (MonoMethod *method);
199
200 MonoMethod *
201 mono_marshal_get_isinst (MonoClass *klass);
202
203 MonoMethod *
204 mono_marshal_get_castclass (MonoClass *klass);
205
206 MonoMethod *
207 mono_marshal_get_proxy_cancast (MonoClass *klass);
208
209 /* marshaling internal calls */
210
211 void * 
212 mono_marshal_alloc (gpointer size);
213
214 void 
215 mono_marshal_free (gpointer ptr);
216
217 void
218 mono_marshal_free_array (gpointer *ptr, int size);
219
220 void * 
221 mono_marshal_realloc (gpointer ptr, gpointer size);
222
223 void
224 ves_icall_System_Runtime_InteropServices_Marshal_copy_to_unmanaged (MonoArray *src, gint32 start_index,
225                                                                     gpointer dest, gint32 length);
226
227 void
228 ves_icall_System_Runtime_InteropServices_Marshal_copy_from_unmanaged (gpointer src, gint32 start_index,
229                                                                       MonoArray *dest, gint32 length);
230
231 gpointer
232 ves_icall_System_Runtime_InteropServices_Marshal_ReadIntPtr (gpointer ptr, gint32 offset);
233
234 unsigned char
235 ves_icall_System_Runtime_InteropServices_Marshal_ReadByte (gpointer ptr, gint32 offset);
236
237 gint16
238 ves_icall_System_Runtime_InteropServices_Marshal_ReadInt16 (gpointer ptr, gint32 offset);
239
240 gint32
241 ves_icall_System_Runtime_InteropServices_Marshal_ReadInt32 (gpointer ptr, gint32 offset);
242
243 gint64
244 ves_icall_System_Runtime_InteropServices_Marshal_ReadInt64 (gpointer ptr, gint32 offset);
245
246 void
247 ves_icall_System_Runtime_InteropServices_Marshal_WriteByte (gpointer ptr, gint32 offset, unsigned char val);
248
249 void
250 ves_icall_System_Runtime_InteropServices_Marshal_WriteIntPtr (gpointer ptr, gint32 offset, gpointer val);
251
252 void
253 ves_icall_System_Runtime_InteropServices_Marshal_WriteInt16 (gpointer ptr, gint32 offset, gint16 val);
254
255 void
256 ves_icall_System_Runtime_InteropServices_Marshal_WriteInt32 (gpointer ptr, gint32 offset, gint32 val);
257
258 void
259 ves_icall_System_Runtime_InteropServices_Marshal_WriteInt64 (gpointer ptr, gint32 offset, gint64 val);
260
261 MonoString *
262 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringAnsi (char *ptr);
263
264 MonoString *
265 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringAnsi_len (char *ptr, gint32 len);
266
267 MonoString *
268 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringUni (guint16 *ptr);
269
270 MonoString *
271 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringUni_len (guint16 *ptr, gint32 len);
272
273 MonoString *
274 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringBSTR (gpointer ptr);
275
276 guint32 
277 ves_icall_System_Runtime_InteropServices_Marshal_GetLastWin32Error (void);
278
279 guint32 
280 ves_icall_System_Runtime_InteropServices_Marshal_SizeOf (MonoReflectionType *rtype);
281
282 void
283 ves_icall_System_Runtime_InteropServices_Marshal_StructureToPtr (MonoObject *obj, gpointer dst, MonoBoolean delete_old);
284
285 void
286 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStructure (gpointer src, MonoObject *dst);
287
288 MonoObject *
289 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStructure_type (gpointer src, MonoReflectionType *type);
290
291 int
292 ves_icall_System_Runtime_InteropServices_Marshal_OffsetOf (MonoReflectionType *type, MonoString *field_name);
293
294 gpointer
295 ves_icall_System_Runtime_InteropServices_Marshal_StringToHGlobalAnsi (MonoString *string);
296
297 gpointer
298 ves_icall_System_Runtime_InteropServices_Marshal_StringToHGlobalUni (MonoString *string);
299
300 void
301 ves_icall_System_Runtime_InteropServices_Marshal_DestroyStructure (gpointer src, MonoReflectionType *type);
302
303 void*
304 ves_icall_System_Runtime_InteropServices_Marshal_AllocCoTaskMem (int size);
305
306 void
307 ves_icall_System_Runtime_InteropServices_Marshal_FreeCoTaskMem (void *ptr);
308
309 void*
310 ves_icall_System_Runtime_InteropServices_Marshal_UnsafeAddrOfPinnedArrayElement (MonoArray *arrayobj, int index);
311
312 #endif /* __MONO_MARSHAL_H__ */
313