In metadata:
[mono.git] / mono / metadata / object.h
1 #ifndef _MONO_CLI_OBJECT_H_
2 #define _MONO_CLI_OBJECT_H_
3
4 #include <mono/metadata/class.h>
5
6 G_BEGIN_DECLS
7
8 typedef guchar MonoBoolean;
9
10 typedef struct _MonoReflectionMethod MonoReflectionMethod;
11 typedef struct _MonoReflectionAssembly MonoReflectionAssembly;
12 typedef struct _MonoReflectionModule MonoReflectionModule;
13 typedef struct _MonoReflectionField MonoReflectionField;
14 typedef struct _MonoReflectionProperty MonoReflectionProperty;
15 typedef struct _MonoReflectionEvent MonoReflectionEvent;
16 typedef struct _MonoReflectionType MonoReflectionType;
17 typedef struct _MonoDelegate MonoDelegate;
18 typedef struct _MonoException MonoException;
19 typedef struct _MonoThreadsSync MonoThreadsSync;
20 typedef struct _MonoThread MonoThread;
21 typedef struct _MonoDynamicAssembly MonoDynamicAssembly;
22 typedef struct _MonoDynamicImage MonoDynamicImage;
23 typedef struct _MonoReflectionMethodBody MonoReflectionMethodBody;
24 typedef struct _MonoAppContext MonoAppContext;
25
26 typedef struct {
27         MonoVTable *vtable;
28         MonoThreadsSync *synchronisation;
29 } MonoObject;
30
31 typedef struct {
32         guint32 length;
33         guint32 lower_bound;
34 } MonoArrayBounds;
35
36 typedef struct {
37         MonoObject obj;
38         /* bounds is NULL for szarrays */
39         MonoArrayBounds *bounds;
40         /* total number of elements of the array */
41         guint32 max_length; 
42         /* we use double to ensure proper alignment on platforms that need it */
43         double vector [MONO_ZERO_LEN_ARRAY];
44 } MonoArray;
45
46 typedef struct {
47         MonoObject object;
48         gint32 length;
49         gunichar2 chars [MONO_ZERO_LEN_ARRAY];
50 } MonoString;
51
52 typedef MonoObject* (*MonoInvokeFunc)        (MonoMethod *method, void *obj, void **params, MonoObject **exc);
53 typedef gpointer    (*MonoCompileFunc)       (MonoMethod *method);
54 typedef void        (*MonoMainThreadFunc)    (gpointer user_data);
55
56 #define mono_object_class(obj) (((MonoObject*)(obj))->vtable->klass)
57 #define mono_object_domain(obj) (((MonoObject*)(obj))->vtable->domain)
58
59 #define MONO_OBJECT_SETREF(obj,fieldname,value) do {    \
60                 mono_gc_wbarrier_set_field ((MonoObject*)(obj), &((obj)->fieldname), (MonoObject*)value);       \
61                 /*(obj)->fieldname = (value);*/ \
62         } while (0)
63
64 /* This should be used if 's' can reside on the heap */
65 #define MONO_STRUCT_SETREF(s,field,value) do { \
66         mono_gc_wbarrier_generic_store (&((s)->field), (MonoObject*)(value)); \
67     } while (0)
68
69 #define mono_array_length(array) ((array)->max_length)
70 #define mono_array_addr(array,type,index) ((type*)(gpointer) mono_array_addr_with_size (array, sizeof (type), index))
71 #define mono_array_addr_with_size(array,size,index) ( ((char*)(array)->vector) + (size) * (index) )
72 #define mono_array_get(array,type,index) ( *(type*)mono_array_addr ((array), type, (index)) ) 
73 #define mono_array_set(array,type,index,value)  \
74         do {    \
75                 type *__p = (type *) mono_array_addr ((array), type, (index));  \
76                 *__p = (value); \
77         } while (0)
78 #define mono_array_setref(array,index,value)    \
79         do {    \
80                 gpointer *__p = (gpointer *) mono_array_addr ((array), gpointer, (index));      \
81                 mono_gc_wbarrier_set_arrayref ((array), __p, (MonoObject*)(value));     \
82                 /* *__p = (value);*/    \
83         } while (0)
84 #define mono_array_memcpy_refs(dest,destidx,src,srcidx,count)   \
85         do {    \
86                 gpointer *__p = (gpointer *) mono_array_addr ((dest), gpointer, (destidx));     \
87                 mono_gc_wbarrier_arrayref_copy ((dest), __p, (count));  \
88                 memmove (__p, mono_array_addr ((src), gpointer, (srcidx)), (count) * sizeof (gpointer));        \
89         } while (0)
90
91 #define mono_string_chars(s) ((gunichar2*)(s)->chars)
92 #define mono_string_length(s) ((s)->length)
93
94 MonoObject *
95 mono_object_new             (MonoDomain *domain, MonoClass *klass);
96
97 MonoObject *
98 mono_object_new_specific    (MonoVTable *vtable);
99
100 /* can be used for classes without finalizer in non-profiling mode */
101 MonoObject *
102 mono_object_new_fast        (MonoVTable *vtable);
103
104 MonoObject *
105 mono_object_new_alloc_specific (MonoVTable *vtable);
106
107 MonoObject *
108 mono_object_new_from_token  (MonoDomain *domain, MonoImage *image, guint32 token);
109
110 MonoArray*
111 mono_array_new              (MonoDomain *domain, MonoClass *eclass, guint32 n);
112
113 MonoArray*
114 mono_array_new_full         (MonoDomain *domain, MonoClass *array_class,
115                              guint32 *lengths, guint32 *lower_bounds);
116
117 MonoArray *
118 mono_array_new_specific     (MonoVTable *vtable, guint32 n);
119
120 MonoArray*
121 mono_array_clone            (MonoArray *array);
122
123 MonoString*
124 mono_string_new_utf16       (MonoDomain *domain, const guint16 *text, gint32 len);
125
126 MonoString*
127 mono_string_new_size        (MonoDomain *domain, gint32 len);
128
129 MonoString*
130 mono_ldstr                  (MonoDomain *domain, MonoImage *image, guint32 str_index);
131
132 MonoString*
133 mono_string_is_interned     (MonoString *str);
134
135 MonoString*
136 mono_string_intern          (MonoString *str);
137
138 MonoString*
139 mono_string_new             (MonoDomain *domain, const char *text);
140
141 MonoString*
142 mono_string_new_wrapper     (const char *text);
143
144 MonoString*
145 mono_string_new_len         (MonoDomain *domain, const char *text, guint length);
146
147 char *
148 mono_string_to_utf8         (MonoString *string_obj);
149
150 gunichar2 *
151 mono_string_to_utf16        (MonoString *string_obj);
152
153 MonoString *
154 mono_string_from_utf16      (gunichar2 *data);
155
156 gboolean
157 mono_string_equal           (MonoString *s1, MonoString *s2);
158
159 guint
160 mono_string_hash            (MonoString *s);
161
162 int
163 mono_object_hash            (MonoObject* obj);
164
165 MonoObject *
166 mono_value_box              (MonoDomain *domain, MonoClass *klass, gpointer val);
167
168 void
169 mono_value_copy             (gpointer dest, gpointer src, MonoClass *klass);
170
171 void
172 mono_value_copy_array       (MonoArray *dest, int dest_idx, gpointer src, int count);
173
174 MonoDomain*
175 mono_object_get_domain      (MonoObject *obj);
176
177 MonoClass*
178 mono_object_get_class       (MonoObject *obj);
179
180 gpointer
181 mono_object_unbox           (MonoObject *obj);
182
183 MonoObject *
184 mono_object_clone           (MonoObject *obj);
185
186 MonoObject *
187 mono_object_isinst          (MonoObject *obj, MonoClass *klass);
188
189 MonoObject *
190 mono_object_isinst_mbyref   (MonoObject *obj, MonoClass *klass);
191
192 MonoObject *
193 mono_object_castclass_mbyref (MonoObject *obj, MonoClass *klass);
194
195 gboolean 
196 mono_monitor_try_enter       (MonoObject *obj, guint32 ms);
197
198 gboolean
199 mono_monitor_enter           (MonoObject *obj);
200
201 guint
202 mono_object_get_size         (MonoObject *o);
203
204 void 
205 mono_monitor_exit            (MonoObject *obj);
206
207 void
208 mono_raise_exception        (MonoException *ex);
209
210 void
211 mono_runtime_object_init    (MonoObject *this_obj);
212
213 void
214 mono_runtime_class_init     (MonoVTable *vtable);
215
216 MonoMethod*
217 mono_object_get_virtual_method (MonoObject *obj, MonoMethod *method);
218
219 MonoObject*
220 mono_runtime_invoke         (MonoMethod *method, void *obj, void **params,
221                              MonoObject **exc);
222
223 MonoMethod *
224 mono_get_delegate_invoke    (MonoClass *klass);
225
226 MonoObject*
227 mono_runtime_delegate_invoke (MonoObject *delegate, void **params, 
228                               MonoObject **exc);
229
230 MonoObject*
231 mono_runtime_invoke_array   (MonoMethod *method, void *obj, MonoArray *params,
232                              MonoObject **exc);
233
234 gpointer
235 mono_method_get_unmanaged_thunk (MonoMethod *method);
236
237 MonoArray*
238 mono_runtime_get_main_args  (void);
239
240 void
241 mono_runtime_exec_managed_code (MonoDomain *domain,
242                                 MonoMainThreadFunc main_func,
243                                 gpointer main_args);
244
245 int
246 mono_runtime_run_main       (MonoMethod *method, int argc, char* argv[], 
247                              MonoObject **exc);
248
249 int
250 mono_runtime_exec_main      (MonoMethod *method, MonoArray *args,
251                              MonoObject **exc);
252
253 gpointer
254 mono_load_remote_field (MonoObject *this_obj, MonoClass *klass, MonoClassField *field, gpointer *res);
255
256 MonoObject *
257 mono_load_remote_field_new (MonoObject *this_obj, MonoClass *klass, MonoClassField *field);
258
259 void
260 mono_store_remote_field (MonoObject *this_obj, MonoClass *klass, MonoClassField *field, gpointer val);
261
262 void
263 mono_store_remote_field_new (MonoObject *this_obj, MonoClass *klass, MonoClassField *field, MonoObject *arg);
264
265 void
266 mono_unhandled_exception    (MonoObject *exc);
267
268 void
269 mono_print_unhandled_exception (MonoObject *exc);
270
271 gpointer 
272 mono_compile_method        (MonoMethod *method);
273
274 MonoRemoteClass*
275 mono_remote_class (MonoDomain *domain, MonoString *class_name, MonoClass *proxy_class);
276
277 /* accessors for fields and properties */
278 void
279 mono_field_set_value (MonoObject *obj, MonoClassField *field, void *value);
280
281 void
282 mono_field_static_set_value (MonoVTable *vt, MonoClassField *field, void *value);
283
284 void
285 mono_field_get_value (MonoObject *obj, MonoClassField *field, void *value);
286
287 void
288 mono_field_static_get_value (MonoVTable *vt, MonoClassField *field, void *value);
289
290 MonoObject *
291 mono_field_get_value_object (MonoDomain *domain, MonoClassField *field, MonoObject *obj);
292
293 void
294 mono_property_set_value (MonoProperty *prop, void *obj, void **params, MonoObject **exc);
295
296 MonoObject*
297 mono_property_get_value (MonoProperty *prop, void *obj, void **params, MonoObject **exc);
298
299 /* GC handles support 
300  *
301  * A handle can be created to refer to a managed object and either prevent it
302  * from being garbage collected or moved or to be able to know if it has been 
303  * collected or not (weak references).
304  * mono_gchandle_new () is used to prevent an object from being garbage collected
305  * until mono_gchandle_free() is called. Use a TRUE value for the pinned argument to
306  * prevent the object from being moved (this should be avoided as much as possible 
307  * and this should be used only for shorts periods of time or performance will suffer).
308  * To create a weakref use mono_gchandle_new_weakref (): track_resurrection should
309  * usually be false (see the GC docs for more details).
310  * mono_gchandle_get_target () can be used to get the object referenced by both kinds
311  * of handle: for a weakref handle, if an object has been collected, it will return NULL.
312  */
313 guint32      mono_gchandle_new         (MonoObject *obj, gboolean pinned);
314 guint32      mono_gchandle_new_weakref (MonoObject *obj, gboolean track_resurrection);
315 MonoObject*  mono_gchandle_get_target  (guint32 gchandle);
316 void         mono_gchandle_free        (guint32 gchandle);
317
318 /* GC write barriers support */
319 void mono_gc_wbarrier_set_field     (MonoObject *obj, gpointer field_ptr, MonoObject* value);
320 void mono_gc_wbarrier_set_arrayref  (MonoArray *arr, gpointer slot_ptr, MonoObject* value);
321 void mono_gc_wbarrier_arrayref_copy (MonoArray *arr, gpointer slot_ptr, int count);
322 void mono_gc_wbarrier_generic_store (gpointer ptr, MonoObject* value);
323 void mono_gc_wbarrier_value_copy    (gpointer dest, gpointer src, int count, MonoClass *klass);
324 void mono_gc_wbarrier_object        (MonoObject* obj);
325
326 G_END_DECLS
327
328 #endif
329