mono/utils/mono-error.h

   1 /**
   2  * \file
   3  */
   4
   5 #ifndef __MONO_ERROR_H__
   6 #define __MONO_ERROR_H__
   7
   8 #include <mono/utils/mono-publib.h>
   9
  10 enum {
  11         /*
  12         The supplied strings were dup'd by means of calling mono_error_dup_strings.
  13         */
  14         MONO_ERROR_FREE_STRINGS = 0x0001,
  15
  16         /*
  17         Something happened while processing the error and the resulting message is incomplete.
  18         */
  19         MONO_ERROR_INCOMPLETE = 0x0002,
  20         /*
  21         This MonoError is heap allocated in a mempool
  22         */
  23         MONO_ERROR_MEMPOOL_BOXED = 0x0004
  24 };
  25
  26 enum {
  27         MONO_ERROR_NONE = 0,
  28         MONO_ERROR_MISSING_METHOD = 1,
  29         MONO_ERROR_MISSING_FIELD = 2,
  30         MONO_ERROR_TYPE_LOAD = 3,
  31         MONO_ERROR_FILE_NOT_FOUND = 4,
  32         MONO_ERROR_BAD_IMAGE = 5,
  33         MONO_ERROR_OUT_OF_MEMORY = 6,
  34         MONO_ERROR_ARGUMENT = 7,
  35         MONO_ERROR_ARGUMENT_NULL = 11,
  36         MONO_ERROR_NOT_VERIFIABLE = 8,
  37         MONO_ERROR_INVALID_PROGRAM = 12,
  38         MONO_ERROR_MEMBER_ACCESS = 13,
  39
  40         /*
  41          * This is a generic error mechanism is you need to raise an arbitrary corlib exception.
  42          * You must pass the exception name otherwise prepare_exception will fail with internal execution.
  43          */
  44         MONO_ERROR_GENERIC = 9,
  45         /* This one encapsulates a managed exception instance */
  46         MONO_ERROR_EXCEPTION_INSTANCE = 10,
  47
  48         /* Not a valid error code - indicates that the error was cleaned up and reused */
  49         MONO_ERROR_CLEANUP_CALLED_SENTINEL = 0xffff
  50 };
  51
  52 /*Keep in sync with MonoErrorInternal*/
  53 typedef union _MonoError {
  54         // Merge two uint16 into one uint32 so it can be initialized
  55         // with one instruction instead of two.
  56         uint32_t init;
  57         struct {
  58                 uint16_t error_code;
  59                 uint16_t private_flags; /*DON'T TOUCH */
  60                 void *hidden_1 [12]; /*DON'T TOUCH */
  61         };
  62 } MonoError;
  63
  64 /* Mempool-allocated MonoError.*/
  65 typedef struct _MonoErrorBoxed MonoErrorBoxed;
  66
  67 MONO_BEGIN_DECLS
  68
  69 MONO_RT_EXTERNAL_ONLY
  70 MONO_API void
  71 mono_error_init (MonoError *error);
  72
  73 MONO_API void
  74 mono_error_init_flags (MonoError *error, unsigned short flags);
  75
  76 MONO_API void
  77 mono_error_cleanup (MonoError *error);
  78
  79 MONO_API mono_bool
  80 mono_error_ok (MonoError *error);
  81
  82 MONO_API unsigned short
  83 mono_error_get_error_code (MonoError *error);
  84
  85 MONO_API const char*
  86 mono_error_get_message (MonoError *error);
  87
  88 MONO_END_DECLS
  89
  90 #endif