Merge pull request #3070 from kumpera/runtime-handles
[mono.git] / mono / utils / mono-error-internals.h
1 #ifndef __MONO_ERROR_INTERNALS_H__
2 #define __MONO_ERROR_INTERNALS_H__
3
4 #include "mono/utils/mono-compiler.h"
5 #include "mono/metadata/class-internals.h"
6
7 /*Keep in sync with MonoError*/
8 typedef struct {
9         unsigned short error_code;
10     unsigned short flags;
11
12         /*These name are suggestions of their content. MonoError internals might use them for something else.*/
13         const char *type_name;
14         const char *assembly_name;
15         const char *member_name;
16         const char *exception_name_space;
17         const char *exception_name;
18         union {
19                 /* Valid if error_code != MONO_ERROR_EXCEPTION_INSTANCE.
20                  * Used by type or field load errors and generic error specified by class.
21                  */
22                 MonoClass *klass;
23                 /* Valid if error_code == MONO_ERROR_EXCEPTION_INSTANCE.
24                  * Generic error specified by a managed instance.
25                  */
26                 uint32_t instance_handle;
27         } exn;
28         const char *full_message;
29         const char *full_message_with_fields;
30         const char *first_argument;
31
32         void *padding [3];
33 } MonoErrorInternal;
34
35 #define error_init(error) do {  \
36         ((MonoErrorInternal*)(error))->error_code = MONO_ERROR_NONE;    \
37         ((MonoErrorInternal*)(error))->flags = 0;       \
38 } while (0);
39
40 #define is_ok(error) ((error)->error_code == MONO_ERROR_NONE)
41
42 #define return_if_nok(error) do { if (!is_ok ((error))) return; } while (0)
43 #define return_val_if_nok(error,val) do { if (!is_ok ((error))) return (val); } while (0)
44
45 /* Only use this in icalls */
46 #define return_val_and_set_pending_if_nok(error,value)  \
47         if (mono_error_set_pending_exception ((error))) \
48                 return (value);
49
50 void
51 mono_error_assert_ok_pos (MonoError *error, const char* filename, int lineno) MONO_LLVM_INTERNAL;
52
53 #define mono_error_assert_ok(e) mono_error_assert_ok_pos (e, __FILE__, __LINE__);
54
55 void
56 mono_error_dup_strings (MonoError *error, gboolean dup_strings);
57
58 /* This function is not very useful as you can't provide any details beyond the message.*/
59 void
60 mono_error_set_error (MonoError *error, int error_code, const char *msg_format, ...);
61
62 void
63 mono_error_set_assembly_load (MonoError *error, const char *assembly_name, const char *msg_format, ...);
64
65 void
66 mono_error_set_assembly_load_simple (MonoError *error, const char *assembly_name, gboolean refection_only);
67
68 void
69 mono_error_set_type_load_class (MonoError *error, MonoClass *klass, const char *msg_format, ...);
70
71 void
72 mono_error_set_type_load_name (MonoError *error, const char *type_name, const char *assembly_name, const char *msg_format, ...);
73
74 void
75 mono_error_set_method_load (MonoError *error, MonoClass *klass, const char *method_name, const char *msg_format, ...);
76
77 void
78 mono_error_set_field_load (MonoError *error, MonoClass *klass, const char *field_name, const char *msg_format, ...);
79
80 void
81 mono_error_set_bad_image (MonoError *error, MonoImage *image, const char *msg_format, ...);
82
83 void
84 mono_error_set_bad_image_name (MonoError *error, const char *file_name, const char *msg_format, ...);
85
86 void
87 mono_error_set_out_of_memory (MonoError *error, const char *msg_format, ...);
88
89 void
90 mono_error_set_argument (MonoError *error, const char *argument, const char *msg_format, ...);
91
92 void
93 mono_error_set_argument_null (MonoError *oerror, const char *argument, const char *msg_format, ...);
94
95 void
96 mono_error_set_not_verifiable (MonoError *oerror, MonoMethod *method, const char *msg_format, ...);
97
98 void
99 mono_error_set_generic_error (MonoError *error, const char * name_space, const char *name, const char *msg_format, ...);
100
101 void
102 mono_error_set_execution_engine (MonoError *error, const char *msg_format, ...);
103
104 void
105 mono_error_set_not_implemented (MonoError *error, const char *msg_format, ...);
106
107 void
108 mono_error_set_not_supported (MonoError *error, const char *msg_format, ...);
109
110 void
111 mono_error_set_invalid_operation (MonoError *error, const char *msg_format, ...);
112
113 void
114 mono_error_set_exception_instance (MonoError *error, MonoException *exc);
115
116 MonoException*
117 mono_error_prepare_exception (MonoError *error, MonoError *error_out);
118
119 MonoException*
120 mono_error_convert_to_exception (MonoError *error);
121
122 void
123 mono_error_raise_exception (MonoError *error);
124
125 void
126 mono_error_move (MonoError *dest, MonoError *src);
127
128 #endif