Tue Mar 21 15:54:30 CET 2006 Paolo Molaro <lupus@ximian.com>
[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                 (obj)->fieldname = (value);     \
61         } while (0)
62
63 #define mono_array_length(array) ((array)->max_length)
64 #define mono_array_addr(array,type,index) ((type*)(gpointer) mono_array_addr_with_size (array, sizeof (type), index))
65 #define mono_array_addr_with_size(array,size,index) ( ((char*)(array)->vector) + (size) * (index) )
66 #define mono_array_get(array,type,index) ( *(type*)mono_array_addr ((array), type, (index)) ) 
67 #define mono_array_set(array,type,index,value)  \
68         do {    \
69                 type *__p = (type *) mono_array_addr ((array), type, (index));  \
70                 *__p = (value); \
71         } while (0)
72 #define mono_array_setref(array,index,value)    \
73         do {    \
74                 gpointer *__p = (gpointer *) mono_array_addr ((array), gpointer, (index));      \
75                 *__p = (value); \
76         } while (0)
77 #define mono_array_memcpy_refs(dest,destidx,src,srcidx,count)   \
78         do {    \
79                 memmove (mono_array_addr ((dest), gpointer, (destidx)), mono_array_addr ((src), gpointer, (srcidx)), (count) * sizeof (gpointer));      \
80         } while (0)
81
82 #define mono_string_chars(s) ((gunichar2*)(s)->chars)
83 #define mono_string_length(s) ((s)->length)
84
85 MonoObject *
86 mono_object_new             (MonoDomain *domain, MonoClass *klass);
87
88 MonoObject *
89 mono_object_new_specific    (MonoVTable *vtable);
90
91 /* can be used for classes without finalizer in non-profiling mode */
92 MonoObject *
93 mono_object_new_fast        (MonoVTable *vtable);
94
95 MonoObject *
96 mono_object_new_alloc_specific (MonoVTable *vtable);
97
98 MonoObject *
99 mono_object_new_from_token  (MonoDomain *domain, MonoImage *image, guint32 token);
100
101 MonoArray*
102 mono_array_new              (MonoDomain *domain, MonoClass *eclass, guint32 n);
103
104 MonoArray*
105 mono_array_new_full         (MonoDomain *domain, MonoClass *array_class,
106                              guint32 *lengths, guint32 *lower_bounds);
107
108 MonoArray *
109 mono_array_new_specific     (MonoVTable *vtable, guint32 n);
110
111 MonoArray*
112 mono_array_clone            (MonoArray *array);
113
114 MonoString*
115 mono_string_new_utf16       (MonoDomain *domain, const guint16 *text, gint32 len);
116
117 MonoString*
118 mono_string_new_size        (MonoDomain *domain, gint32 len);
119
120 MonoString*
121 mono_ldstr                  (MonoDomain *domain, MonoImage *image, guint32 str_index);
122
123 MonoString*
124 mono_string_is_interned     (MonoString *str);
125
126 MonoString*
127 mono_string_intern          (MonoString *str);
128
129 MonoString*
130 mono_string_new             (MonoDomain *domain, const char *text);
131
132 MonoString*
133 mono_string_new_wrapper     (const char *text);
134
135 MonoString*
136 mono_string_new_len         (MonoDomain *domain, const char *text, guint length);
137
138 char *
139 mono_string_to_utf8         (MonoString *string_obj);
140
141 gunichar2 *
142 mono_string_to_utf16        (MonoString *string_obj);
143
144 MonoString *
145 mono_string_from_utf16      (gunichar2 *data);
146
147 gboolean
148 mono_string_equal           (MonoString *s1, MonoString *s2);
149
150 guint
151 mono_string_hash            (MonoString *s);
152
153 int
154 mono_object_hash            (MonoObject* obj);
155
156 MonoObject *
157 mono_value_box              (MonoDomain *domain, MonoClass *klass, gpointer val);
158
159 void
160 mono_value_copy             (gpointer dest, gpointer src, MonoClass *klass);
161
162 void
163 mono_value_copy_array       (MonoArray *dest, int dest_idx, gpointer src, int count);
164
165 MonoDomain*
166 mono_object_get_domain      (MonoObject *obj);
167
168 MonoClass*
169 mono_object_get_class       (MonoObject *obj);
170
171 gpointer
172 mono_object_unbox           (MonoObject *obj);
173
174 MonoObject *
175 mono_object_clone           (MonoObject *obj);
176
177 MonoObject *
178 mono_object_isinst          (MonoObject *obj, MonoClass *klass);
179
180 MonoObject *
181 mono_object_isinst_mbyref   (MonoObject *obj, MonoClass *klass);
182
183 MonoObject *
184 mono_object_castclass_mbyref (MonoObject *obj, MonoClass *klass);
185
186 gboolean 
187 mono_monitor_try_enter       (MonoObject *obj, guint32 ms);
188
189 gboolean
190 mono_monitor_enter           (MonoObject *obj);
191
192 guint
193 mono_object_get_size         (MonoObject *o);
194
195 void 
196 mono_monitor_exit            (MonoObject *obj);
197
198 void
199 mono_raise_exception        (MonoException *ex);
200
201 void
202 mono_runtime_object_init    (MonoObject *this_obj);
203
204 void
205 mono_runtime_class_init     (MonoVTable *vtable);
206
207 MonoMethod*
208 mono_object_get_virtual_method (MonoObject *obj, MonoMethod *method);
209
210 MonoObject*
211 mono_runtime_invoke         (MonoMethod *method, void *obj, void **params,
212                              MonoObject **exc);
213
214 MonoMethod *
215 mono_get_delegate_invoke    (MonoClass *klass);
216
217 MonoObject*
218 mono_runtime_delegate_invoke (MonoObject *delegate, void **params, 
219                               MonoObject **exc);
220
221 MonoObject*
222 mono_runtime_invoke_array   (MonoMethod *method, void *obj, MonoArray *params,
223                              MonoObject **exc);
224
225 MonoArray*
226 mono_runtime_get_main_args  (void);
227
228 void
229 mono_runtime_exec_managed_code (MonoDomain *domain,
230                                 MonoMainThreadFunc main_func,
231                                 gpointer main_args);
232
233 int
234 mono_runtime_run_main       (MonoMethod *method, int argc, char* argv[], 
235                              MonoObject **exc);
236
237 int
238 mono_runtime_exec_main      (MonoMethod *method, MonoArray *args,
239                              MonoObject **exc);
240
241 gpointer
242 mono_load_remote_field (MonoObject *this_obj, MonoClass *klass, MonoClassField *field, gpointer *res);
243
244 MonoObject *
245 mono_load_remote_field_new (MonoObject *this_obj, MonoClass *klass, MonoClassField *field);
246
247 void
248 mono_store_remote_field (MonoObject *this_obj, MonoClass *klass, MonoClassField *field, gpointer val);
249
250 void
251 mono_store_remote_field_new (MonoObject *this_obj, MonoClass *klass, MonoClassField *field, MonoObject *arg);
252
253 void
254 mono_unhandled_exception    (MonoObject *exc);
255
256 void
257 mono_print_unhandled_exception (MonoObject *exc);
258
259 gpointer 
260 mono_compile_method        (MonoMethod *method);
261
262 MonoRemoteClass*
263 mono_remote_class (MonoDomain *domain, MonoString *class_name, MonoClass *proxy_class);
264
265 /* accessors for fields and properties */
266 void
267 mono_field_set_value (MonoObject *obj, MonoClassField *field, void *value);
268
269 void
270 mono_field_static_set_value (MonoVTable *vt, MonoClassField *field, void *value);
271
272 void
273 mono_field_get_value (MonoObject *obj, MonoClassField *field, void *value);
274
275 void
276 mono_field_static_get_value (MonoVTable *vt, MonoClassField *field, void *value);
277
278 MonoObject *
279 mono_field_get_value_object (MonoDomain *domain, MonoClassField *field, MonoObject *obj);
280
281 void
282 mono_property_set_value (MonoProperty *prop, void *obj, void **params, MonoObject **exc);
283
284 MonoObject*
285 mono_property_get_value (MonoProperty *prop, void *obj, void **params, MonoObject **exc);
286
287 /* GC handles support 
288  *
289  * A handle can be created to refer to a managed object and either prevent it
290  * from being garbage collected or moved or to be able to know if it has been 
291  * collected or not (weak references).
292  * mono_gchandle_new () is used to prevent an object from being garbage collected
293  * until mono_gchandle_free() is called. Use a TRUE value for the pinned argument to
294  * prevent the object from being moved (this should be avoided as much as possible 
295  * and this should be used only for shorts periods of time or performance will suffer).
296  * To create a weakref use mono_gchandle_new_weakref (): track_resurrection should
297  * usually be false (see the GC docs for more details).
298  * mono_gchandle_get_target () can be used to get the object referenced by both kinds
299  * of handle: for a weakref handle, if an object has been collected, it will return NULL.
300  */
301 guint32      mono_gchandle_new         (MonoObject *obj, gboolean pinned);
302 guint32      mono_gchandle_new_weakref (MonoObject *obj, gboolean track_resurrection);
303 MonoObject*  mono_gchandle_get_target  (guint32 gchandle);
304 void         mono_gchandle_free        (guint32 gchandle);
305
306 G_END_DECLS
307
308 #endif
309