2004-05-03 Gonzalo Paniagua Javier <gonzalo@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 #include <mono/metadata/threads-types.h>
6
7 #if 1
8 #ifdef __GNUC__
9 #define mono_assert(expr)                  G_STMT_START{                  \
10      if (!(expr))                                                         \
11        {                                                                  \
12                 MonoException *ex;                                        \
13                 char *msg = g_strdup_printf ("file %s: line %d (%s): "    \
14                 "assertion failed: (%s)", __FILE__, __LINE__,             \
15                 __PRETTY_FUNCTION__, #expr);                              \
16                 ex = mono_get_exception_execution_engine (msg);           \
17                 g_free (msg);                                             \
18                 mono_raise_exception (ex);                                \
19        };                               }G_STMT_END
20
21 #define mono_assert_not_reached()                 G_STMT_START{           \
22      MonoException *ex;                                                   \
23      char *msg = g_strdup_printf ("file %s: line %d (%s): "               \
24      "should not be reached", __FILE__, __LINE__, __PRETTY_FUNCTION__);   \
25      ex = mono_get_exception_execution_engine (msg);                      \
26      g_free (msg);                                                        \
27      mono_raise_exception (ex);                                           \
28 }G_STMT_END
29 #else /* not GNUC */
30 #define mono_assert(expr)                  G_STMT_START{                  \
31      if (!(expr))                                                         \
32        {                                                                  \
33                 MonoException *ex;                                        \
34                 char *msg = g_strdup_printf ("file %s: line %d: "         \
35                 "assertion failed: (%s)", __FILE__, __LINE__,             \
36                 #expr);                                                   \
37                 ex = mono_get_exception_execution_engine (msg);           \
38                 g_free (msg);                                             \
39                 mono_raise_exception (ex);                                \
40        };                               }G_STMT_END
41
42 #define mono_assert_not_reached()                 G_STMT_START{           \
43      MonoException *ex;                                                   \
44      char *msg = g_strdup_printf ("file %s: line %d): "                   \
45      "should not be reached", __FILE__, __LINE__);                        \
46      ex = mono_get_exception_execution_engine (msg);                      \
47      g_free (msg);                                                        \
48      mono_raise_exception (ex);                                           \
49 }G_STMT_END
50 #endif
51 #else
52 #define mono_assert(expr) g_assert(expr)
53 #define mono_assert_not_reached() g_assert_not_reached() 
54 #endif
55
56 #define MONO_CHECK_ARG(arg, expr)               G_STMT_START{             \
57      if (!(expr))                                                         \
58        {                                                                  \
59                 MonoException *ex;                                        \
60                 char *msg = g_strdup_printf ("assertion `%s' failed",     \
61                 #expr);                                                   \
62                 if (arg) {} /* check if the name exists */                \
63                 ex = mono_get_exception_argument (#arg, msg);             \
64                 g_free (msg);                                             \
65                 mono_raise_exception (ex);                                \
66        };                               }G_STMT_END
67
68 #define MONO_CHECK_ARG_NULL(arg)            G_STMT_START{                 \
69      if (arg == NULL)                                                     \
70        {                                                                  \
71                 MonoException *ex;                                        \
72                 if (arg) {} /* check if the name exists */                \
73                 ex = mono_get_exception_argument_null (#arg);             \
74                 mono_raise_exception (ex);                                \
75        };                               }G_STMT_END
76
77 typedef guchar MonoBoolean;
78
79 typedef struct _MonoReflectionMethod MonoReflectionMethod;
80 typedef struct _MonoDelegate MonoDelegate;
81
82 typedef struct {
83         MonoVTable *vtable;
84         MonoThreadsSync *synchronisation;
85 } MonoObject;
86
87 typedef struct {
88         MonoObject obj;
89         MonoObject *identity;
90 } MonoMarshalByRefObject;
91
92 typedef struct {
93         guint32 length;
94         guint32 lower_bound;
95 } MonoArrayBounds;
96
97 typedef struct {
98         MonoObject obj;
99         /* bounds is NULL for szarrays */
100         MonoArrayBounds *bounds;
101         /* total number of elements of the array */
102         guint32 max_length; 
103         /* we use double to ensure proper alignment on platforms that need it */
104         double vector [MONO_ZERO_LEN_ARRAY];
105 } MonoArray;
106
107 typedef struct {
108         MonoObject object;
109         gint32 length;
110         gunichar2 chars [MONO_ZERO_LEN_ARRAY];
111 } MonoString;
112
113 typedef struct {
114         MonoObject object;
115         gint32 length;
116         MonoString *str;
117 } MonoStringBuilder;
118
119 typedef struct {
120         MonoObject object;
121         MonoType  *type;
122 } MonoReflectionType;
123
124 typedef struct {
125         MonoType *type;
126         gpointer  value;
127         MonoClass *klass;
128 } MonoTypedRef;
129
130 typedef struct {
131         gpointer args;
132 } MonoArgumentHandle;
133
134 typedef struct {
135         MonoMethodSignature *sig;
136         gpointer args;
137         gint32 next_arg;
138         gint32 num_args;
139 } MonoArgIterator;
140
141 typedef struct {
142         MonoObject object;
143         MonoArray  *trace_ips;
144         MonoObject *inner_ex;
145         MonoString *message;
146         MonoString *help_link;
147         MonoString *class_name;
148         MonoString *stack_trace;
149         MonoString *remote_stack_trace;
150         gint32      remote_stack_index;
151         gint32      hresult;
152         MonoString *source;
153 } MonoException;
154
155 typedef struct {
156         MonoException base;
157 } MonoSystemException;
158
159 typedef struct {
160         MonoSystemException base;
161         MonoString *param_name;
162 } MonoArgumentException;
163
164 typedef struct {
165         MonoSystemException base;
166         MonoString *msg;
167         MonoString *type_name;
168 } MonoTypeLoadException;
169
170 typedef struct {
171         MonoObject   object;
172         MonoObject  *async_state;
173         MonoObject  *handle;
174         MonoObject  *async_delegate;
175         gpointer     data;
176         MonoBoolean  sync_completed;
177         MonoBoolean  completed;
178         MonoBoolean  endinvoke_called;
179         MonoObject  *async_callback;
180 } MonoAsyncResult;
181
182 typedef struct {
183         MonoMarshalByRefObject object;
184         gpointer     handle;
185         MonoBoolean  disposed;
186 } MonoWaitHandle;
187
188 typedef struct {
189         MonoObject  object;
190         MonoReflectionType *class_to_proxy;     
191         MonoObject *context;
192         MonoObject *unwrapped_server;
193 } MonoRealProxy;
194
195 typedef struct {
196         MonoObject       object;
197         MonoRealProxy   *rp;    
198         MonoRemoteClass *remote_class;
199         MonoBoolean      custom_type_info;
200 } MonoTransparentProxy;
201
202 /* This is a copy of System.Runtime.Remoting.Messaging.CallType */
203 typedef enum {
204         CallType_Sync = 0,
205         CallType_BeginInvoke = 1,
206         CallType_EndInvoke = 2,
207         CallType_OneWay = 3
208 } MonoCallType;
209
210 typedef struct {
211         MonoObject obj;
212         MonoReflectionMethod *method;
213         MonoArray  *args;               
214         MonoArray  *names;              
215         MonoArray  *arg_types;  
216         MonoObject *ctx;
217         MonoObject *rval;
218         MonoObject *exc;
219         MonoAsyncResult *async_result;
220         guint32     call_type;
221 } MonoMethodMessage;
222
223 typedef struct {
224         MonoObject obj;
225         gint32 il_offset;
226         gint32 native_offset;
227         MonoReflectionMethod *method;
228         MonoString *filename;
229         gint32 line;
230         gint32 column;
231 } MonoStackFrame;
232
233 typedef struct {
234         MonoObject  obj;
235         HANDLE      handle;
236         MonoObject *culture_info;
237         MonoObject *ui_culture_info;
238         MonoBoolean threadpool_thread;
239         gunichar2  *name;
240         guint32     name_len;
241         guint32     state;
242         MonoException *abort_exc;
243         MonoObject *abort_state;
244         guint32 tid;
245         HANDLE      start_notify;
246         gpointer stack_ptr;
247         gpointer *static_data;
248         gpointer jit_data;
249         gpointer lock_data;
250         GSList *appdomain_refs;
251 } MonoThread;
252
253 typedef struct {
254         MonoString *name;
255         MonoReflectionType *type;
256         MonoObject *value;
257 } MonoSerializationEntry;
258
259 typedef struct {
260         guint32 state;
261         MonoObject *additional;
262 } MonoStreamingContext;
263
264 typedef struct {
265         MonoObject obj;
266         MonoBoolean readOnly;
267         MonoString *AMDesignator;
268         MonoString *PMDesignator;
269         MonoString *DateSeparator;
270         MonoString *TimeSeparator;
271         MonoString *ShortDatePattern;
272         MonoString *LongDatePattern;
273         MonoString *ShortTimePattern;
274         MonoString *LongTimePattern;
275         MonoString *MonthDayPattern;
276         MonoString *YearMonthPattern;
277         MonoString *FullDateTimePattern;
278         MonoString *RFC1123Pattern;
279         MonoString *SortableDateTimePattern;
280         MonoString *UniversalSortableDateTimePattern;
281         guint32 FirstDayOfWeek;
282         MonoObject *Calendar;
283         guint32 CalendarWeekRule;
284         MonoArray *AbbreviatedDayNames;
285         MonoArray *DayNames;
286         MonoArray *MonthNames;
287         MonoArray *AbbreviatedMonthNames;
288 } MonoDateTimeFormatInfo;
289
290 typedef struct 
291 {
292         MonoObject obj;
293         MonoBoolean readOnly;
294         MonoString *decimalFormats;
295         MonoString *currencyFormats;
296         MonoString *percentFormats;
297         MonoString *digitPattern;
298         MonoString *zeroPattern;
299         gint32 currencyDecimalDigits;
300         MonoString *currencyDecimalSeparator;
301         MonoString *currencyGroupSeparator;
302         MonoArray *currencyGroupSizes;
303         gint32 currencyNegativePattern;
304         gint32 currencyPositivePattern;
305         MonoString *currencySymbol;
306         MonoString *naNSymbol;
307         MonoString *negativeInfinitySymbol;
308         MonoString *negativeSign;
309         guint32 numberDecimalDigits;
310         MonoString *numberDecimalSeparator;
311         MonoString *numberGroupSeparator;
312         MonoArray *numberGroupSizes;
313         gint32 numberNegativePattern;
314         gint32 percentDecimalDigits;
315         MonoString *percentDecimalSeparator;
316         MonoString *percentGroupSeparator;
317         MonoArray *percentGroupSizes;
318         gint32 percentNegativePattern;
319         gint32 percentPositivePattern;
320         MonoString *percentSymbol;
321         MonoString *perMilleSymbol;
322         MonoString *positiveInfinitySymbol;
323         MonoString *positiveSign;
324 } MonoNumberFormatInfo;
325
326 typedef struct {
327         MonoObject obj;
328         gint32 lcid;
329         MonoString *icu_name;
330         gpointer ICU_collator;
331 } MonoCompareInfo;
332
333 typedef struct {
334         MonoObject obj;
335         MonoBoolean is_read_only;
336         gint32 lcid;
337         gint32 parent_lcid;
338         gint32 specific_lcid;
339         gint32 datetime_index;
340         gint32 number_index;
341         MonoBoolean use_user_override;
342         MonoNumberFormatInfo *number_format;
343         MonoDateTimeFormatInfo *datetime_format;
344         MonoObject *textinfo;
345         MonoString *name;
346         MonoString *displayname;
347         MonoString *englishname;
348         MonoString *nativename;
349         MonoString *iso3lang;
350         MonoString *iso2lang;
351         MonoString *icu_name;
352         MonoString *win3lang;
353         MonoCompareInfo *compareinfo;
354 } MonoCultureInfo;
355
356 typedef struct {
357         MonoObject obj;
358         MonoString *str;
359         gint32 options;
360         MonoArray *key;
361         gint32 lcid;
362 } MonoSortKey;
363
364 typedef MonoObject* (*MonoInvokeFunc)        (MonoMethod *method, void *obj, void **params, MonoObject **exc);
365 typedef gpointer    (*MonoCompileFunc)       (MonoMethod *method);
366 typedef void        (*MonoMainThreadFunc)    (gpointer user_data);
367
368 #define mono_object_class(obj) (((MonoObject*)(obj))->vtable->klass)
369 #define mono_object_domain(obj) (((MonoObject*)(obj))->vtable->domain)
370
371 #define mono_array_length(array) ((array)->max_length)
372 #define mono_array_addr(array,type,index) ( ((char*)(array)->vector) + sizeof (type) * (index) )
373 #define mono_array_addr_with_size(array,size,index) ( ((char*)(array)->vector) + (size) * (index) )
374 #define mono_array_get(array,type,index) ( *(type*)mono_array_addr ((array), type, (index)) ) 
375 #define mono_array_set(array,type,index,value)  \
376         do {    \
377                 type *__p = (type *) mono_array_addr ((array), type, (index));  \
378                 *__p = (value); \
379         } while (0)
380
381 #define mono_string_chars(s) ((gunichar2*)(s)->chars)
382 #define mono_string_length(s) ((s)->length)
383 #define mono_stringbuilder_capacity(sb) ((sb)->str->length)
384
385 MonoObject *
386 mono_object_new             (MonoDomain *domain, MonoClass *klass);
387
388 MonoObject *
389 mono_object_new_specific    (MonoVTable *vtable);
390
391 /* can be used for classes without finalizer in non-profiling mode */
392 MonoObject *
393 mono_object_new_fast        (MonoVTable *vtable);
394
395 MonoObject *
396 mono_object_new_alloc_specific (MonoVTable *vtable);
397
398 MonoObject *
399 mono_object_new_from_token  (MonoDomain *domain, MonoImage *image, guint32 token);
400
401 MonoArray*
402 mono_array_new              (MonoDomain *domain, MonoClass *eclass, guint32 n);
403
404 MonoArray*
405 mono_array_new_full         (MonoDomain *domain, MonoClass *array_class,
406                              guint32 *lengths, guint32 *lower_bounds);
407
408 MonoArray *
409 mono_array_new_specific     (MonoVTable *vtable, guint32 n);
410
411 MonoArray*
412 mono_array_clone            (MonoArray *array);
413
414 MonoString*
415 mono_string_new_utf16       (MonoDomain *domain, const guint16 *text, gint32 len);
416
417 MonoString*
418 mono_string_new_size        (MonoDomain *domain, gint32 len);
419
420 MonoString*
421 mono_ldstr                  (MonoDomain *domain, MonoImage *image, guint32 str_index);
422
423 MonoString*
424 mono_string_is_interned     (MonoString *str);
425
426 MonoString*
427 mono_string_intern          (MonoString *str);
428
429 MonoString*
430 mono_string_new             (MonoDomain *domain, const char *text);
431
432 MonoString*
433 mono_string_new_wrapper     (const char *text);
434
435 MonoString*
436 mono_string_new_len         (MonoDomain *domain, const char *text, guint length);
437
438 char *
439 mono_string_to_utf8         (MonoString *string_obj);
440
441 gunichar2 *
442 mono_string_to_utf16        (MonoString *string_obj);
443
444 MonoString *
445 mono_string_from_utf16      (gunichar2 *data);
446
447 void       
448 mono_object_free            (MonoObject *o);
449
450 MonoObject *
451 mono_value_box              (MonoDomain *domain, MonoClass *klass, gpointer val);
452
453 gpointer
454 mono_object_unbox           (MonoObject *obj);
455
456 MonoObject *
457 mono_object_clone           (MonoObject *obj);
458
459 MonoObject *
460 mono_object_isinst          (MonoObject *obj, MonoClass *klass);
461
462 MonoObject *
463 mono_object_isinst_mbyref   (MonoObject *obj, MonoClass *klass);
464
465 MonoObject *
466 mono_object_castclass_mbyref (MonoObject *obj, MonoClass *klass);
467
468 typedef void (*MonoExceptionFunc) (MonoException *ex);
469
470 void
471 mono_install_handler        (MonoExceptionFunc func);
472
473 void
474 mono_raise_exception        (MonoException *ex);
475
476 void
477 mono_runtime_object_init    (MonoObject *this_obj);
478
479 void
480 mono_runtime_class_init     (MonoVTable *vtable);
481
482 void        
483 mono_install_runtime_invoke (MonoInvokeFunc func);
484
485 void        
486 mono_install_compile_method (MonoCompileFunc func);
487
488 MonoMethod*
489 mono_object_get_virtual_method (MonoObject *obj, MonoMethod *method);
490
491 MonoObject*
492 mono_runtime_invoke         (MonoMethod *method, void *obj, void **params,
493                              MonoObject **exc);
494
495 MonoMethod *
496 mono_get_delegate_invoke    (MonoClass *klass);
497
498 MonoObject*
499 mono_runtime_delegate_invoke (MonoObject *delegate, void **params, 
500                               MonoObject **exc);
501
502 MonoObject*
503 mono_runtime_invoke_array   (MonoMethod *method, void *obj, MonoArray *params,
504                              MonoObject **exc);
505
506 MonoArray*
507 mono_runtime_get_main_args  (void);
508
509 void
510 mono_runtime_exec_managed_code (MonoDomain *domain,
511                                 MonoMainThreadFunc main_func,
512                                 gpointer main_args);
513
514 int
515 mono_runtime_run_main       (MonoMethod *method, int argc, char* argv[], 
516                              MonoObject **exc);
517
518 int
519 mono_runtime_exec_main      (MonoMethod *method, MonoArray *args,
520                              MonoObject **exc);
521
522 MonoAsyncResult *
523 mono_async_result_new       (MonoDomain *domain, HANDLE handle, 
524                              MonoObject *state, gpointer data);
525
526 MonoWaitHandle *
527 mono_wait_handle_new        (MonoDomain *domain, HANDLE handle);
528
529 void
530 mono_message_init           (MonoDomain *domain, MonoMethodMessage *this_obj, 
531                              MonoReflectionMethod *method, MonoArray *out_args);
532
533 MonoObject *
534 mono_remoting_invoke        (MonoObject *real_proxy, MonoMethodMessage *msg, 
535                              MonoObject **exc, MonoArray **out_args);
536
537 MonoObject *
538 mono_message_invoke         (MonoObject *target, MonoMethodMessage *msg, 
539                              MonoObject **exc, MonoArray **out_args);
540
541 MonoMethodMessage *
542 mono_method_call_message_new (MonoMethod *method, gpointer *params, MonoMethod *invoke, 
543                               MonoDelegate **cb, MonoObject **state);
544
545 gpointer
546 mono_load_remote_field (MonoObject *this_obj, MonoClass *klass, MonoClassField *field, gpointer *res);
547
548 MonoObject *
549 mono_load_remote_field_new (MonoObject *this_obj, MonoClass *klass, MonoClassField *field);
550
551 void
552 mono_store_remote_field (MonoObject *this_obj, MonoClass *klass, MonoClassField *field, gpointer val);
553
554 void
555 mono_store_remote_field_new (MonoObject *this_obj, MonoClass *klass, MonoClassField *field, MonoObject *arg);
556
557 void
558 mono_method_return_message_restore (MonoMethod *method, gpointer *params, MonoArray *out_args);
559
560 void
561 mono_unhandled_exception    (MonoObject *exc);
562
563 void
564 mono_print_unhandled_exception (MonoObject *exc);
565
566 void
567 mono_delegate_ctor          (MonoObject *this_obj, MonoObject *target, gpointer addr);
568
569 gpointer 
570 mono_compile_method        (MonoMethod *method);
571
572 MonoRemoteClass*
573 mono_remote_class (MonoDomain *domain, MonoString *class_name, MonoClass *proxy_class);
574
575 void
576 mono_upgrade_remote_class (MonoDomain *domain, MonoRemoteClass *remote_class, MonoClass *klass);
577
578 /* accessors for fields and properties */
579 void
580 mono_field_set_value (MonoObject *obj, MonoClassField *field, void *value);
581
582 void
583 mono_field_static_set_value (MonoVTable *vt, MonoClassField *field, void *value);
584
585 void
586 mono_field_get_value (MonoObject *obj, MonoClassField *field, void *value);
587
588 void
589 mono_field_static_get_value (MonoVTable *vt, MonoClassField *field, void *value);
590
591 MonoObject *
592 mono_field_get_value_object (MonoDomain *domain, MonoClassField *field, MonoObject *obj);
593
594 void
595 mono_property_set_value (MonoProperty *prop, void *obj, void **params, MonoObject **exc);
596
597 MonoObject*
598 mono_property_get_value (MonoProperty *prop, void *obj, void **params, MonoObject **exc);
599
600 void
601 mono_type_initialization_init (void);
602
603 #endif
604