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