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 /* Invariant: the error strings are allocated in the mempool of the given image */
  36 struct _MonoErrorBoxed {
  37         MonoError error;
  38         MonoImage *image;
  39 };
  40
  41 #define error_init(error) do {  \
  42         ((MonoErrorInternal*)(error))->error_code = MONO_ERROR_NONE;    \
  43         ((MonoErrorInternal*)(error))->flags = 0;       \
  44 } while (0);
  45
  46 #define is_ok(error) ((error)->error_code == MONO_ERROR_NONE)
  47
  48 #define return_if_nok(error) do { if (!is_ok ((error))) return; } while (0)
  49 #define return_val_if_nok(error,val) do { if (!is_ok ((error))) return (val); } while (0)
  50
  51 /* Only use this in icalls */
  52 #define return_val_and_set_pending_if_nok(error,value)  \
  53         if (mono_error_set_pending_exception ((error))) \
  54                 return (value);
  55
  56 void
  57 mono_error_assert_ok_pos (MonoError *error, const char* filename, int lineno) MONO_LLVM_INTERNAL;
  58
  59 #define mono_error_assert_ok(e) mono_error_assert_ok_pos (e, __FILE__, __LINE__);
  60
  61 void
  62 mono_error_dup_strings (MonoError *error, gboolean dup_strings);
  63
  64 /* This function is not very useful as you can't provide any details beyond the message.*/
  65 void
  66 mono_error_set_error (MonoError *error, int error_code, const char *msg_format, ...) MONO_ATTR_FORMAT_PRINTF(3,4);
  67
  68 void
  69 mono_error_set_assembly_load (MonoError *error, const char *assembly_name, const char *msg_format, ...) MONO_ATTR_FORMAT_PRINTF(3,4);
  70
  71 void
  72 mono_error_set_assembly_load_simple (MonoError *error, const char *assembly_name, gboolean refection_only);
  73
  74 void
  75 mono_error_set_type_load_class (MonoError *error, MonoClass *klass, const char *msg_format, ...) MONO_ATTR_FORMAT_PRINTF(3,4);
  76
  77 void
  78 mono_error_vset_type_load_class (MonoError *error, MonoClass *klass, const char *msg_format, va_list args);
  79
  80 void
  81 mono_error_set_type_load_name (MonoError *error, const char *type_name, const char *assembly_name, const char *msg_format, ...) MONO_ATTR_FORMAT_PRINTF(4,5);
  82
  83 void
  84 mono_error_set_method_load (MonoError *error, MonoClass *klass, const char *method_name, const char *msg_format, ...) MONO_ATTR_FORMAT_PRINTF(4,5);
  85
  86 void
  87 mono_error_set_field_load (MonoError *error, MonoClass *klass, const char *field_name, const char *msg_format, ...)  MONO_ATTR_FORMAT_PRINTF(4,5);
  88
  89 void
  90 mono_error_set_bad_image (MonoError *error, MonoImage *image, const char *msg_format, ...) MONO_ATTR_FORMAT_PRINTF(3,4);
  91
  92 void
  93 mono_error_set_bad_image_name (MonoError *error, const char *file_name, const char *msg_format, ...) MONO_ATTR_FORMAT_PRINTF(3,4);
  94
  95 void
  96 mono_error_set_out_of_memory (MonoError *error, const char *msg_format, ...) MONO_ATTR_FORMAT_PRINTF(2,3);
  97
  98 void
  99 mono_error_set_argument (MonoError *error, const char *argument, const char *msg_format, ...) MONO_ATTR_FORMAT_PRINTF(3,4);
 100
 101 void
 102 mono_error_set_argument_null (MonoError *oerror, const char *argument, const char *msg_format, ...) MONO_ATTR_FORMAT_PRINTF(3,4);
 103
 104 void
 105 mono_error_set_not_verifiable (MonoError *oerror, MonoMethod *method, const char *msg_format, ...) MONO_ATTR_FORMAT_PRINTF(3,4);
 106
 107 void
 108 mono_error_set_generic_error (MonoError *error, const char * name_space, const char *name, const char *msg_format, ...) MONO_ATTR_FORMAT_PRINTF(4,5);
 109
 110 void
 111 mono_error_set_execution_engine (MonoError *error, const char *msg_format, ...) MONO_ATTR_FORMAT_PRINTF(2,3);
 112
 113 void
 114 mono_error_set_not_implemented (MonoError *error, const char *msg_format, ...) MONO_ATTR_FORMAT_PRINTF(2,3);
 115
 116 void
 117 mono_error_set_not_supported (MonoError *error, const char *msg_format, ...) MONO_ATTR_FORMAT_PRINTF(2,3);
 118
 119 void
 120 mono_error_set_invalid_operation (MonoError *error, const char *msg_format, ...) MONO_ATTR_FORMAT_PRINTF(2,3);
 121
 122 void
 123 mono_error_set_exception_instance (MonoError *error, MonoException *exc);
 124
 125 void
 126 mono_error_set_invalid_program (MonoError *oerror, const char *msg_format, ...) MONO_ATTR_FORMAT_PRINTF(2,3);
 127
 128 MonoException*
 129 mono_error_prepare_exception (MonoError *error, MonoError *error_out);
 130
 131 MonoException*
 132 mono_error_convert_to_exception (MonoError *error);
 133
 134 void
 135 mono_error_raise_exception (MonoError *error);
 136
 137 void
 138 mono_error_move (MonoError *dest, MonoError *src);
 139
 140 MonoErrorBoxed*
 141 mono_error_box (const MonoError *error, MonoImage *image);
 142
 143 gboolean
 144 mono_error_set_from_boxed (MonoError *error, const MonoErrorBoxed *from);
 145
 146
 147 #endif