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