2004-11-07 Ben Maurer <bmaurer@ximian.com>
[mono-project.git] / mono / metadata / object.h
blobe448a74ca1fecc600b22ac2d5c65120857272bfc
1 #ifndef _MONO_CLI_OBJECT_H_
2 #define _MONO_CLI_OBJECT_H_
4 #include <mono/metadata/class.h>
6 typedef guchar MonoBoolean;
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;
23 typedef struct {
24 MonoVTable *vtable;
25 MonoThreadsSync *synchronisation;
26 } MonoObject;
28 typedef struct {
29 guint32 length;
30 guint32 lower_bound;
31 } MonoArrayBounds;
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;
43 typedef struct {
44 MonoObject object;
45 gint32 length;
46 gunichar2 chars [MONO_ZERO_LEN_ARRAY];
47 } MonoString;
49 typedef MonoObject* (*MonoInvokeFunc) (MonoMethod *method, void *obj, void **params, MonoObject **exc);
50 typedef gpointer (*MonoCompileFunc) (MonoMethod *method);
51 typedef void (*MonoFreeMethodFunc) (MonoMethod *method);
52 typedef void (*MonoMainThreadFunc) (gpointer user_data);
54 #define mono_object_class(obj) (((MonoObject*)(obj))->vtable->klass)
55 #define mono_object_domain(obj) (((MonoObject*)(obj))->vtable->domain)
57 #define mono_array_length(array) ((array)->max_length)
58 #define mono_array_addr(array,type,index) ((type*) mono_array_addr_with_size (array, sizeof (type), index))
59 #define mono_array_addr_with_size(array,size,index) ( ((char*)(array)->vector) + (size) * (index) )
60 #define mono_array_get(array,type,index) ( *(type*)mono_array_addr ((array), type, (index)) )
61 #define mono_array_set(array,type,index,value) \
62 do { \
63 type *__p = (type *) mono_array_addr ((array), type, (index)); \
64 *__p = (value); \
65 } while (0)
67 #define mono_string_chars(s) ((gunichar2*)(s)->chars)
68 #define mono_string_length(s) ((s)->length)
70 MonoObject *
71 mono_object_new (MonoDomain *domain, MonoClass *klass);
73 MonoObject *
74 mono_object_new_specific (MonoVTable *vtable);
76 /* can be used for classes without finalizer in non-profiling mode */
77 MonoObject *
78 mono_object_new_fast (MonoVTable *vtable);
80 MonoObject *
81 mono_object_new_alloc_specific (MonoVTable *vtable);
83 void*
84 mono_class_get_allocation_ftn (MonoVTable *vtable, gboolean *pass_size_in_words);
86 MonoObject *
87 mono_object_new_from_token (MonoDomain *domain, MonoImage *image, guint32 token);
89 MonoArray*
90 mono_array_new (MonoDomain *domain, MonoClass *eclass, guint32 n);
92 MonoArray*
93 mono_array_new_full (MonoDomain *domain, MonoClass *array_class,
94 guint32 *lengths, guint32 *lower_bounds);
96 MonoArray *
97 mono_array_new_specific (MonoVTable *vtable, guint32 n);
99 MonoArray*
100 mono_array_clone (MonoArray *array);
102 MonoString*
103 mono_string_new_utf16 (MonoDomain *domain, const guint16 *text, gint32 len);
105 MonoString*
106 mono_string_new_size (MonoDomain *domain, gint32 len);
108 MonoString*
109 mono_ldstr (MonoDomain *domain, MonoImage *image, guint32 str_index);
111 MonoString*
112 mono_string_is_interned (MonoString *str);
114 MonoString*
115 mono_string_intern (MonoString *str);
117 MonoString*
118 mono_string_new (MonoDomain *domain, const char *text);
120 MonoString*
121 mono_string_new_wrapper (const char *text);
123 MonoString*
124 mono_string_new_len (MonoDomain *domain, const char *text, guint length);
126 char *
127 mono_string_to_utf8 (MonoString *string_obj);
129 gunichar2 *
130 mono_string_to_utf16 (MonoString *string_obj);
132 MonoString *
133 mono_string_from_utf16 (gunichar2 *data);
135 MonoObject *
136 mono_value_box (MonoDomain *domain, MonoClass *klass, gpointer val);
138 MonoDomain*
139 mono_object_get_domain (MonoObject *obj);
141 MonoClass*
142 mono_object_get_class (MonoObject *obj);
144 gpointer
145 mono_object_unbox (MonoObject *obj);
147 MonoObject *
148 mono_object_clone (MonoObject *obj);
150 MonoObject *
151 mono_object_isinst (MonoObject *obj, MonoClass *klass);
153 MonoObject *
154 mono_object_isinst_mbyref (MonoObject *obj, MonoClass *klass);
156 MonoObject *
157 mono_object_castclass_mbyref (MonoObject *obj, MonoClass *klass);
159 gboolean
160 mono_monitor_try_enter (MonoObject *obj, guint32 ms);
162 gboolean
163 mono_monitor_enter (MonoObject *obj);
165 void
166 mono_monitor_exit (MonoObject *obj);
168 void
169 mono_raise_exception (MonoException *ex);
171 void
172 mono_runtime_object_init (MonoObject *this_obj);
174 void
175 mono_runtime_class_init (MonoVTable *vtable);
177 MonoMethod*
178 mono_object_get_virtual_method (MonoObject *obj, MonoMethod *method);
180 MonoObject*
181 mono_runtime_invoke (MonoMethod *method, void *obj, void **params,
182 MonoObject **exc);
184 MonoMethod *
185 mono_get_delegate_invoke (MonoClass *klass);
187 MonoObject*
188 mono_runtime_delegate_invoke (MonoObject *delegate, void **params,
189 MonoObject **exc);
191 MonoObject*
192 mono_runtime_invoke_array (MonoMethod *method, void *obj, MonoArray *params,
193 MonoObject **exc);
195 MonoArray*
196 mono_runtime_get_main_args (void);
198 void
199 mono_runtime_exec_managed_code (MonoDomain *domain,
200 MonoMainThreadFunc main_func,
201 gpointer main_args);
204 mono_runtime_run_main (MonoMethod *method, int argc, char* argv[],
205 MonoObject **exc);
208 mono_runtime_exec_main (MonoMethod *method, MonoArray *args,
209 MonoObject **exc);
211 gpointer
212 mono_load_remote_field (MonoObject *this_obj, MonoClass *klass, MonoClassField *field, gpointer *res);
214 MonoObject *
215 mono_load_remote_field_new (MonoObject *this_obj, MonoClass *klass, MonoClassField *field);
217 void
218 mono_store_remote_field (MonoObject *this_obj, MonoClass *klass, MonoClassField *field, gpointer val);
220 void
221 mono_store_remote_field_new (MonoObject *this_obj, MonoClass *klass, MonoClassField *field, MonoObject *arg);
223 void
224 mono_unhandled_exception (MonoObject *exc);
226 void
227 mono_print_unhandled_exception (MonoObject *exc);
229 gpointer
230 mono_compile_method (MonoMethod *method);
232 void
233 mono_runtime_free_method (MonoMethod *method);
235 MonoRemoteClass*
236 mono_remote_class (MonoDomain *domain, MonoString *class_name, MonoClass *proxy_class);
238 void
239 mono_upgrade_remote_class (MonoDomain *domain, MonoRemoteClass *remote_class, MonoClass *klass);
241 /* accessors for fields and properties */
242 void
243 mono_field_set_value (MonoObject *obj, MonoClassField *field, void *value);
245 void
246 mono_field_static_set_value (MonoVTable *vt, MonoClassField *field, void *value);
248 void
249 mono_field_get_value (MonoObject *obj, MonoClassField *field, void *value);
251 void
252 mono_field_static_get_value (MonoVTable *vt, MonoClassField *field, void *value);
254 MonoObject *
255 mono_field_get_value_object (MonoDomain *domain, MonoClassField *field, MonoObject *obj);
257 void
258 mono_property_set_value (MonoProperty *prop, void *obj, void **params, MonoObject **exc);
260 MonoObject*
261 mono_property_get_value (MonoProperty *prop, void *obj, void **params, MonoObject **exc);
263 /* GC handles support
265 * A handle can be created to refer to a managed object and either prevent it
266 * from being garbage collected or moved or to be able to know if it has been
267 * collected or not (weak references).
268 * mono_gchandle_new () is used to prevent an object from being garbage collected
269 * until mono_gchandle_free() is called. Use a TRUE value for the pinned argument to
270 * prevent the object from being moved (this should be avoided as much as possible
271 * and this should be used only for shorts periods of time or performance will suffer).
272 * To create a weakref use mono_gchandle_new_weakref (): track_resurrection should
273 * usually be false (see the GC docs for more details).
274 * mono_gchandle_get_target () can be used to get the object referenced by both kinds
275 * of handle: for a weakref handle, if an object has been collected, it will return NULL.
277 guint32 mono_gchandle_new (MonoObject *obj, gboolean pinned);
278 guint32 mono_gchandle_new_weakref (MonoObject *obj, gboolean track_resurrection);
279 MonoObject* mono_gchandle_get_target (guint32 gchandle);
280 void mono_gchandle_free (guint32 gchandle);
282 #endif