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