2003-06-17 Zoltan Varga <vargaz@freemail.hu>
[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 gint32
25 mono_class_native_size (MonoClass *klass, guint32 *align);
26
27 MonoMarshalType *
28 mono_marshal_load_type_info (MonoClass* klass);
29
30 gint32
31 mono_marshal_type_size (MonoType *type, MonoMarshalSpec *mspec, gint32 *align, 
32                         gboolean as_field, gboolean unicode);
33
34 int            
35 mono_type_native_stack_size (MonoType *type, int *alignment);
36
37 gpointer
38 mono_array_to_savearray (MonoArray *array);
39
40 gpointer
41 mono_array_to_lparray (MonoArray *array);
42
43 void
44 mono_string_utf8_to_builder (MonoStringBuilder *sb, char *text);
45
46 gpointer
47 mono_string_builder_to_utf8 (MonoStringBuilder *sb);
48
49 gpointer
50 mono_string_to_ansibstr (MonoString *string_obj);
51
52 gpointer
53 mono_string_to_bstr (MonoString *string_obj);
54
55 void
56 mono_string_to_byvalstr (gpointer dst, MonoString *src, int size);
57
58 void
59 mono_string_to_byvalwstr (gpointer dst, MonoString *src, int size);
60
61 gpointer
62 mono_delegate_to_ftnptr (MonoDelegate *delegate);
63
64 void * 
65 mono_marshal_string_array (MonoArray *array);
66
67 /* method builder functions */
68
69 void
70 mono_mb_free (MonoMethodBuilder *mb);
71
72 MonoMethodBuilder *
73 mono_mb_new (MonoClass *klass, const char *name, MonoWrapperType type);
74
75 void
76 mono_mb_patch_addr (MonoMethodBuilder *mb, int pos, int value);
77
78 void
79 mono_mb_patch_addr_s (MonoMethodBuilder *mb, int pos, gint8 value);
80
81 guint32
82 mono_mb_add_data (MonoMethodBuilder *mb, gpointer data);
83
84 void
85 mono_mb_emit_native_call (MonoMethodBuilder *mb, MonoMethodSignature *sig, gpointer func);
86
87 void
88 mono_mb_emit_managed_call (MonoMethodBuilder *mb, MonoMethod *method, MonoMethodSignature *opt_sig);
89
90 int
91 mono_mb_add_local (MonoMethodBuilder *mb, MonoType *type);
92
93 MonoMethod *
94 mono_mb_create_method (MonoMethodBuilder *mb, MonoMethodSignature *signature, int max_stack);
95
96 void
97 mono_mb_emit_ldarg (MonoMethodBuilder *mb, guint argnum);
98
99 void
100 mono_mb_emit_ldarg_addr (MonoMethodBuilder *mb, guint argnum);
101
102 void
103 mono_mb_emit_ldloc (MonoMethodBuilder *mb, guint num);
104
105 void
106 mono_mb_emit_ldloc_addr (MonoMethodBuilder *mb, guint locnum);
107
108 void
109 mono_mb_emit_stloc (MonoMethodBuilder *mb, guint num);
110
111 void
112 mono_mb_emit_exception (MonoMethodBuilder *mb);
113
114 void
115 mono_mb_emit_icon (MonoMethodBuilder *mb, gint32 value);
116
117 void
118 mono_mb_emit_add_to_local (MonoMethodBuilder *mb, guint16 local, gint32 incr);
119
120 void
121 mono_mb_emit_ldflda (MonoMethodBuilder *mb, gint32 offset);
122
123 void
124 mono_mb_emit_byte (MonoMethodBuilder *mb, guint8 op);
125
126 void
127 mono_mb_emit_i2 (MonoMethodBuilder *mb, gint16 data);
128
129 void
130 mono_mb_emit_i4 (MonoMethodBuilder *mb, gint32 data);
131
132 void
133 mono_mb_emit_ldstr (MonoMethodBuilder *mb, char *str);
134
135 /* functions to create various architecture independent helper functions */
136
137 MonoMethod *
138 mono_marshal_get_remoting_invoke (MonoMethod *method);
139
140 MonoMethod *
141 mono_marshal_get_remoting_invoke_with_check (MonoMethod *method);
142
143 MonoMethod *
144 mono_marshal_get_delegate_begin_invoke (MonoMethod *method);
145
146 MonoMethod *
147 mono_marshal_get_delegate_end_invoke (MonoMethod *method);
148
149 MonoMethod *
150 mono_marshal_get_delegate_invoke (MonoMethod *method);
151
152 MonoMethod *
153 mono_marshal_get_runtime_invoke (MonoMethod *method);
154
155 MonoMethod *
156 mono_marshal_get_managed_wrapper (MonoMethod *method, MonoObject *this, MonoMarshalSpec **mspecs);
157
158 MonoMethod *
159 mono_marshal_get_icall_wrapper (MonoMethodSignature *sig, const char *name, gconstpointer func);
160
161 MonoMethod *
162 mono_marshal_get_native_wrapper (MonoMethod *method);
163
164 MonoMethod *
165 mono_marshal_get_struct_to_ptr (MonoClass *klass);
166
167 MonoMethod *
168 mono_marshal_get_ptr_to_struct (MonoClass *klass);
169
170 MonoMethod *
171 mono_marshal_get_stfld_wrapper (MonoType *type);
172
173 MonoMethod *
174 mono_marshal_get_ldfld_wrapper (MonoType *type);
175
176 MonoMethod *
177 mono_marshal_get_synchronized_wrapper (MonoMethod *method);
178
179 /* marshaling internal calls */
180
181 void * 
182 mono_marshal_alloc (gpointer size);
183
184 void 
185 mono_marshal_free (gpointer ptr);
186
187 void
188 mono_marshal_free_array (gpointer *ptr, int size);
189
190 void * 
191 mono_marshal_realloc (gpointer ptr, gpointer size);
192
193 void
194 ves_icall_System_Runtime_InteropServices_Marshal_copy_to_unmanaged (MonoArray *src, gint32 start_index,
195                                                                     gpointer dest, gint32 length);
196
197 void
198 ves_icall_System_Runtime_InteropServices_Marshal_copy_from_unmanaged (gpointer src, gint32 start_index,
199                                                                       MonoArray *dest, gint32 length);
200
201 gpointer
202 ves_icall_System_Runtime_InteropServices_Marshal_ReadIntPtr (gpointer ptr, gint32 offset);
203
204 unsigned char
205 ves_icall_System_Runtime_InteropServices_Marshal_ReadByte (gpointer ptr, gint32 offset);
206
207 gint16
208 ves_icall_System_Runtime_InteropServices_Marshal_ReadInt16 (gpointer ptr, gint32 offset);
209
210 gint32
211 ves_icall_System_Runtime_InteropServices_Marshal_ReadInt32 (gpointer ptr, gint32 offset);
212
213 gint64
214 ves_icall_System_Runtime_InteropServices_Marshal_ReadInt64 (gpointer ptr, gint32 offset);
215
216 void
217 ves_icall_System_Runtime_InteropServices_Marshal_WriteByte (gpointer ptr, gint32 offset, unsigned char val);
218
219 void
220 ves_icall_System_Runtime_InteropServices_Marshal_WriteIntPtr (gpointer ptr, gint32 offset, gpointer val);
221
222 void
223 ves_icall_System_Runtime_InteropServices_Marshal_WriteInt16 (gpointer ptr, gint32 offset, gint16 val);
224
225 void
226 ves_icall_System_Runtime_InteropServices_Marshal_WriteInt32 (gpointer ptr, gint32 offset, gint32 val);
227
228 void
229 ves_icall_System_Runtime_InteropServices_Marshal_WriteInt64 (gpointer ptr, gint32 offset, gint64 val);
230
231 MonoString *
232 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringAnsi (char *ptr);
233
234 MonoString *
235 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringAnsi_len (char *ptr, gint32 len);
236
237 MonoString *
238 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringUni (guint16 *ptr);
239
240 MonoString *
241 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringUni_len (guint16 *ptr, gint32 len);
242
243 MonoString *
244 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStringBSTR (gpointer ptr);
245
246 guint32 
247 ves_icall_System_Runtime_InteropServices_Marshal_GetLastWin32Error (void);
248
249 guint32 
250 ves_icall_System_Runtime_InteropServices_Marshal_SizeOf (MonoReflectionType *rtype);
251
252 void
253 ves_icall_System_Runtime_InteropServices_Marshal_StructureToPtr (MonoObject *obj, gpointer dst, MonoBoolean delete_old);
254
255 void
256 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStructure (gpointer src, MonoObject *dst);
257
258 MonoObject *
259 ves_icall_System_Runtime_InteropServices_Marshal_PtrToStructure_type (gpointer src, MonoReflectionType *type);
260
261 int
262 ves_icall_System_Runtime_InteropServices_Marshal_OffsetOf (MonoReflectionType *type, MonoString *field_name);
263
264 gpointer
265 ves_icall_System_Runtime_InteropServices_Marshal_StringToHGlobalAnsi (MonoString *string);
266
267 gpointer
268 ves_icall_System_Runtime_InteropServices_Marshal_StringToHGlobalUni (MonoString *string);
269
270 void
271 ves_icall_System_Runtime_InteropServices_Marshal_DestroyStructure (gpointer src, MonoReflectionType *type);
272
273 #endif /* __MONO_MARSHAL_H__ */
274