2 #ifndef __MONO_METADATA_H__
3 #define __MONO_METADATA_H__
5 #include <mono/utils/mono-publib.h>
7 #include <mono/metadata/blob.h>
8 #include <mono/metadata/row-indexes.h>
9 #include <mono/metadata/image.h>
14 * When embedding, you have to define MONO_ZERO_LEN_ARRAY before including any
15 * other Mono header file if you use a different compiler from the one used to
18 #ifndef MONO_ZERO_LEN_ARRAY
20 #define MONO_ZERO_LEN_ARRAY 0
22 #define MONO_ZERO_LEN_ARRAY 1
26 #define MONO_TYPE_ISSTRUCT(t) mono_type_is_struct (t)
27 #define MONO_TYPE_IS_VOID(t) mono_type_is_void (t)
28 #define MONO_TYPE_IS_POINTER(t) mono_type_is_pointer (t)
29 #define MONO_TYPE_IS_REFERENCE(t) mono_type_is_reference (t)
31 #define MONO_CLASS_IS_INTERFACE(c) ((c->flags & TYPE_ATTRIBUTE_INTERFACE) || (c->byval_arg.type == MONO_TYPE_VAR) || (c->byval_arg.type == MONO_TYPE_MVAR))
33 #define MONO_CLASS_IS_IMPORT(c) ((c->flags & TYPE_ATTRIBUTE_IMPORT))
35 typedef struct _MonoClass MonoClass;
36 typedef struct _MonoDomain MonoDomain;
37 typedef struct _MonoMethod MonoMethod;
40 MONO_EXCEPTION_CLAUSE_NONE,
41 MONO_EXCEPTION_CLAUSE_FILTER,
42 MONO_EXCEPTION_CLAUSE_FINALLY,
43 MONO_EXCEPTION_CLAUSE_FAULT = 4
55 /* ECMA lamespec: the old spec had more info... */
57 MONO_NATIVE_BOOLEAN = 0x02, /* 4 bytes, 0 is false, != 0 is true */
58 MONO_NATIVE_I1 = 0x03,
59 MONO_NATIVE_U1 = 0x04,
60 MONO_NATIVE_I2 = 0x05,
61 MONO_NATIVE_U2 = 0x06,
62 MONO_NATIVE_I4 = 0x07,
63 MONO_NATIVE_U4 = 0x08,
64 MONO_NATIVE_I8 = 0x09,
65 MONO_NATIVE_U8 = 0x0a,
66 MONO_NATIVE_R4 = 0x0b,
67 MONO_NATIVE_R8 = 0x0c,
68 MONO_NATIVE_CURRENCY = 0x0f,
69 MONO_NATIVE_BSTR = 0x13, /* prefixed length, Unicode */
70 MONO_NATIVE_LPSTR = 0x14, /* ANSI, null terminated */
71 MONO_NATIVE_LPWSTR = 0x15, /* UNICODE, null terminated */
72 MONO_NATIVE_LPTSTR = 0x16, /* plattform dep., null terminated */
73 MONO_NATIVE_BYVALTSTR = 0x17,
74 MONO_NATIVE_IUNKNOWN = 0x19,
75 MONO_NATIVE_IDISPATCH = 0x1a,
76 MONO_NATIVE_STRUCT = 0x1b,
77 MONO_NATIVE_INTERFACE = 0x1c,
78 MONO_NATIVE_SAFEARRAY = 0x1d,
79 MONO_NATIVE_BYVALARRAY = 0x1e,
80 MONO_NATIVE_INT = 0x1f,
81 MONO_NATIVE_UINT = 0x20,
82 MONO_NATIVE_VBBYREFSTR = 0x22,
83 MONO_NATIVE_ANSIBSTR = 0x23, /* prefixed length, ANSI */
84 MONO_NATIVE_TBSTR = 0x24, /* prefixed length, plattform dep. */
85 MONO_NATIVE_VARIANTBOOL = 0x25,
86 MONO_NATIVE_FUNC = 0x26,
87 MONO_NATIVE_ASANY = 0x28,
88 MONO_NATIVE_LPARRAY = 0x2a,
89 MONO_NATIVE_LPSTRUCT = 0x2b,
90 MONO_NATIVE_CUSTOM = 0x2c,
91 MONO_NATIVE_ERROR = 0x2d,
92 MONO_NATIVE_MAX = 0x50 /* no info */
95 /* Used only in context of SafeArray */
97 MONO_VARIANT_EMPTY = 0x00,
98 MONO_VARIANT_NULL = 0x01,
99 MONO_VARIANT_I2 = 0x02,
100 MONO_VARIANT_I4 = 0x03,
101 MONO_VARIANT_R4 = 0x04,
102 MONO_VARIANT_R8 = 0x05,
103 MONO_VARIANT_CY = 0x06,
104 MONO_VARIANT_DATE = 0x07,
105 MONO_VARIANT_BSTR = 0x08,
106 MONO_VARIANT_DISPATCH = 0x09,
107 MONO_VARIANT_ERROR = 0x0a,
108 MONO_VARIANT_BOOL = 0x0b,
109 MONO_VARIANT_VARIANT = 0x0c,
110 MONO_VARIANT_UNKNOWN = 0x0d,
111 MONO_VARIANT_DECIMAL = 0x0e,
112 MONO_VARIANT_I1 = 0x10,
113 MONO_VARIANT_UI1 = 0x11,
114 MONO_VARIANT_UI2 = 0x12,
115 MONO_VARIANT_UI4 = 0x13,
116 MONO_VARIANT_I8 = 0x14,
117 MONO_VARIANT_UI8 = 0x15,
118 MONO_VARIANT_INT = 0x16,
119 MONO_VARIANT_UINT = 0x17,
120 MONO_VARIANT_VOID = 0x18,
121 MONO_VARIANT_HRESULT = 0x19,
122 MONO_VARIANT_PTR = 0x1a,
123 MONO_VARIANT_SAFEARRAY = 0x1b,
124 MONO_VARIANT_CARRAY = 0x1c,
125 MONO_VARIANT_USERDEFINED = 0x1d,
126 MONO_VARIANT_LPSTR = 0x1e,
127 MONO_VARIANT_LPWSTR = 0x1f,
128 MONO_VARIANT_RECORD = 0x24,
129 MONO_VARIANT_FILETIME = 0x40,
130 MONO_VARIANT_BLOB = 0x41,
131 MONO_VARIANT_STREAM = 0x42,
132 MONO_VARIANT_STORAGE = 0x43,
133 MONO_VARIANT_STREAMED_OBJECT = 0x44,
134 MONO_VARIANT_STORED_OBJECT = 0x45,
135 MONO_VARIANT_BLOB_OBJECT = 0x46,
136 MONO_VARIANT_CF = 0x47,
137 MONO_VARIANT_CLSID = 0x48,
138 MONO_VARIANT_VECTOR = 0x1000,
139 MONO_VARIANT_ARRAY = 0x2000,
140 MONO_VARIANT_BYREF = 0x4000
141 } MonoMarshalVariant;
144 MONO_MARSHAL_CONV_NONE,
145 MONO_MARSHAL_CONV_BOOL_VARIANTBOOL,
146 MONO_MARSHAL_CONV_BOOL_I4,
147 MONO_MARSHAL_CONV_STR_BSTR,
148 MONO_MARSHAL_CONV_STR_LPSTR,
149 MONO_MARSHAL_CONV_LPSTR_STR,
150 MONO_MARSHAL_CONV_LPTSTR_STR,
151 MONO_MARSHAL_CONV_STR_LPWSTR,
152 MONO_MARSHAL_CONV_LPWSTR_STR,
153 MONO_MARSHAL_CONV_STR_LPTSTR,
154 MONO_MARSHAL_CONV_STR_ANSIBSTR,
155 MONO_MARSHAL_CONV_STR_TBSTR,
156 MONO_MARSHAL_CONV_STR_BYVALSTR,
157 MONO_MARSHAL_CONV_STR_BYVALWSTR,
158 MONO_MARSHAL_CONV_SB_LPSTR,
159 MONO_MARSHAL_CONV_SB_LPTSTR,
160 MONO_MARSHAL_CONV_SB_LPWSTR,
161 MONO_MARSHAL_CONV_LPSTR_SB,
162 MONO_MARSHAL_CONV_LPTSTR_SB,
163 MONO_MARSHAL_CONV_LPWSTR_SB,
164 MONO_MARSHAL_CONV_ARRAY_BYVALARRAY,
165 MONO_MARSHAL_CONV_ARRAY_BYVALCHARARRAY,
166 MONO_MARSHAL_CONV_ARRAY_SAVEARRAY,
167 MONO_MARSHAL_CONV_ARRAY_LPARRAY,
168 MONO_MARSHAL_FREE_LPARRAY,
169 MONO_MARSHAL_CONV_OBJECT_INTERFACE,
170 MONO_MARSHAL_CONV_OBJECT_IDISPATCH,
171 MONO_MARSHAL_CONV_OBJECT_IUNKNOWN,
172 MONO_MARSHAL_CONV_OBJECT_STRUCT,
173 MONO_MARSHAL_CONV_DEL_FTN,
174 MONO_MARSHAL_CONV_FTN_DEL,
175 MONO_MARSHAL_FREE_ARRAY,
176 MONO_MARSHAL_CONV_BSTR_STR,
177 MONO_MARSHAL_CONV_SAFEHANDLE,
178 MONO_MARSHAL_CONV_HANDLEREF
182 MonoMarshalNative native;
185 MonoMarshalNative elem_type;
186 int32_t num_elem; /* -1 if not set */
187 int16_t param_num; /* -1 if not set */
188 int16_t elem_mult; /* -1 if not set */
196 MonoMarshalVariant elem_type;
202 MONO_API void mono_metadata_init (void);
204 MONO_API void mono_metadata_decode_row (const MonoTableInfo *t,
209 MONO_API uint32_t mono_metadata_decode_row_col (const MonoTableInfo *t,
214 * This macro is used to extract the size of the table encoded in
215 * the size_bitfield of MonoTableInfo.
217 #define mono_metadata_table_size(bitfield,table) ((((bitfield) >> ((table)*2)) & 0x3) + 1)
218 #define mono_metadata_table_count(bitfield) ((bitfield) >> 24)
220 MONO_API int mono_metadata_compute_size (MonoImage *meta,
222 uint32_t *result_bitfield);
227 MONO_API const char *mono_metadata_locate (MonoImage *meta, int table, int idx);
228 MONO_API const char *mono_metadata_locate_token (MonoImage *meta, uint32_t token);
230 MONO_API const char *mono_metadata_string_heap (MonoImage *meta, uint32_t table_index);
231 MONO_API const char *mono_metadata_blob_heap (MonoImage *meta, uint32_t table_index);
232 MONO_API const char *mono_metadata_user_string (MonoImage *meta, uint32_t table_index);
233 MONO_API const char *mono_metadata_guid_heap (MonoImage *meta, uint32_t table_index);
235 MONO_API uint32_t mono_metadata_typedef_from_field (MonoImage *meta, uint32_t table_index);
236 MONO_API uint32_t mono_metadata_typedef_from_method (MonoImage *meta, uint32_t table_index);
237 MONO_API uint32_t mono_metadata_nested_in_typedef (MonoImage *meta, uint32_t table_index);
238 MONO_API uint32_t mono_metadata_nesting_typedef (MonoImage *meta, uint32_t table_index, uint32_t start_index);
240 MONO_API MonoClass** mono_metadata_interfaces_from_typedef (MonoImage *meta, uint32_t table_index, unsigned int *count);
242 MONO_API uint32_t mono_metadata_events_from_typedef (MonoImage *meta, uint32_t table_index, unsigned int *end_idx);
243 MONO_API uint32_t mono_metadata_methods_from_event (MonoImage *meta, uint32_t table_index, unsigned int *end);
244 MONO_API uint32_t mono_metadata_properties_from_typedef (MonoImage *meta, uint32_t table_index, unsigned int *end);
245 MONO_API uint32_t mono_metadata_methods_from_property (MonoImage *meta, uint32_t table_index, unsigned int *end);
246 MONO_API uint32_t mono_metadata_packing_from_typedef (MonoImage *meta, uint32_t table_index, uint32_t *packing, uint32_t *size);
247 MONO_API const char* mono_metadata_get_marshal_info (MonoImage *meta, uint32_t idx, mono_bool is_field);
248 MONO_API uint32_t mono_metadata_custom_attrs_from_index (MonoImage *meta, uint32_t cattr_index);
250 MONO_API MonoMarshalSpec *mono_metadata_parse_marshal_spec (MonoImage *image, const char *ptr);
252 MONO_API void mono_metadata_free_marshal_spec (MonoMarshalSpec *spec);
254 MONO_API uint32_t mono_metadata_implmap_from_method (MonoImage *meta, uint32_t method_idx);
256 MONO_API void mono_metadata_field_info (MonoImage *meta,
257 uint32_t table_index,
260 MonoMarshalSpec **marshal_spec);
262 MONO_API uint32_t mono_metadata_get_constant_index (MonoImage *meta, uint32_t token, uint32_t hint);
265 * Functions to extract information from the Blobs
267 MONO_API uint32_t mono_metadata_decode_value (const char *ptr,
269 MONO_API int32_t mono_metadata_decode_signed_value (const char *ptr, const char **rptr);
271 MONO_API uint32_t mono_metadata_decode_blob_size (const char *ptr,
274 MONO_API void mono_metadata_encode_value (uint32_t value, char *bug, char **endbuf);
276 #define MONO_OFFSET_IN_CLAUSE(clause,offset) \
277 ((clause)->try_offset <= (offset) && (offset) < ((clause)->try_offset + (clause)->try_len))
278 #define MONO_OFFSET_IN_HANDLER(clause,offset) \
279 ((clause)->handler_offset <= (offset) && (offset) < ((clause)->handler_offset + (clause)->handler_len))
280 #define MONO_OFFSET_IN_FILTER(clause,offset) \
281 ((clause)->flags == MONO_EXCEPTION_CLAUSE_FILTER && (clause)->data.filter_offset <= (offset) && (offset) < ((clause)->handler_offset))
287 uint32_t handler_offset;
288 uint32_t handler_len;
290 uint32_t filter_offset;
291 MonoClass *catch_class;
293 } MonoExceptionClause;
295 typedef struct _MonoType MonoType;
296 typedef struct _MonoGenericInst MonoGenericInst;
297 typedef struct _MonoGenericClass MonoGenericClass;
298 typedef struct _MonoDynamicGenericClass MonoDynamicGenericClass;
299 typedef struct _MonoGenericContext MonoGenericContext;
300 typedef struct _MonoGenericContainer MonoGenericContainer;
301 typedef struct _MonoGenericParam MonoGenericParam;
302 typedef struct _MonoArrayType MonoArrayType;
303 typedef struct _MonoMethodSignature MonoMethodSignature;
305 /* FIXME: Keeping this name alive for now, since it is part of the exposed API, even though no entrypoint uses it. */
306 typedef struct invalid_name MonoGenericMethod;
309 unsigned int required : 1;
310 unsigned int token : 31;
313 struct _MonoArrayType {
322 typedef struct _MonoMethodHeader MonoMethodHeader;
334 mono_type_is_byref (MonoType *type);
337 mono_type_get_type (MonoType *type);
339 /* For MONO_TYPE_FNPTR */
340 MONO_API MonoMethodSignature*
341 mono_type_get_signature (MonoType *type);
343 /* For MONO_TYPE_CLASS, VALUETYPE */
345 mono_type_get_class (MonoType *type);
347 MONO_API MonoArrayType*
348 mono_type_get_array_type (MonoType *type);
350 /* For MONO_TYPE_PTR */
352 mono_type_get_ptr_type (MonoType *type);
355 mono_type_get_modifiers (MonoType *type, mono_bool *is_required, void **iter);
357 MONO_API mono_bool mono_type_is_struct (MonoType *type);
358 MONO_API mono_bool mono_type_is_void (MonoType *type);
359 MONO_API mono_bool mono_type_is_pointer (MonoType *type);
360 MONO_API mono_bool mono_type_is_reference (MonoType *type);
363 mono_signature_get_return_type (MonoMethodSignature *sig);
366 mono_signature_get_params (MonoMethodSignature *sig, void **iter);
369 mono_signature_get_param_count (MonoMethodSignature *sig);
372 mono_signature_get_call_conv (MonoMethodSignature *sig);
375 mono_signature_vararg_start (MonoMethodSignature *sig);
378 mono_signature_is_instance (MonoMethodSignature *sig);
381 mono_signature_explicit_this (MonoMethodSignature *sig);
384 mono_signature_param_is_out (MonoMethodSignature *sig, int param_num);
386 MONO_API uint32_t mono_metadata_parse_typedef_or_ref (MonoImage *m,
389 MONO_API int mono_metadata_parse_custom_mod (MonoImage *m,
393 MONO_RT_EXTERNAL_ONLY
394 MONO_API MonoArrayType *mono_metadata_parse_array (MonoImage *m,
397 MONO_API void mono_metadata_free_array (MonoArrayType *array);
398 MONO_RT_EXTERNAL_ONLY
399 MONO_API MonoType *mono_metadata_parse_type (MonoImage *m,
400 MonoParseTypeMode mode,
404 MONO_RT_EXTERNAL_ONLY
405 MONO_API MonoType *mono_metadata_parse_param (MonoImage *m,
408 MONO_API MonoType *mono_metadata_parse_ret_type (MonoImage *m,
411 MONO_RT_EXTERNAL_ONLY
412 MONO_API MonoType *mono_metadata_parse_field_type (MonoImage *m,
416 MONO_API MonoType *mono_type_create_from_typespec (MonoImage *image,
418 MONO_API void mono_metadata_free_type (MonoType *type);
419 MONO_API int mono_type_size (MonoType *type,
421 MONO_API int mono_type_stack_size (MonoType *type,
424 MONO_API mono_bool mono_type_generic_inst_is_valuetype (MonoType *type);
425 MONO_API mono_bool mono_metadata_generic_class_is_valuetype (MonoGenericClass *gclass);
426 MONO_API unsigned int mono_metadata_generic_class_hash (MonoGenericClass *gclass);
427 MONO_API mono_bool mono_metadata_generic_class_equal (MonoGenericClass *g1, MonoGenericClass *g2);
429 MONO_API unsigned int mono_metadata_type_hash (MonoType *t1);
430 MONO_API mono_bool mono_metadata_type_equal (MonoType *t1, MonoType *t2);
432 MONO_API MonoMethodSignature *mono_metadata_signature_alloc (MonoImage *image, uint32_t nparams);
434 MONO_API MonoMethodSignature *mono_metadata_signature_dup (MonoMethodSignature *sig);
436 MONO_API MonoMethodSignature *mono_metadata_parse_signature (MonoImage *image,
439 MONO_API MonoMethodSignature *mono_metadata_parse_method_signature (MonoImage *m,
443 MONO_API void mono_metadata_free_method_signature (MonoMethodSignature *method);
445 MONO_API mono_bool mono_metadata_signature_equal (MonoMethodSignature *sig1,
446 MonoMethodSignature *sig2);
448 MONO_API unsigned int mono_signature_hash (MonoMethodSignature *sig);
450 MONO_RT_EXTERNAL_ONLY
451 MONO_API MonoMethodHeader *mono_metadata_parse_mh (MonoImage *m, const char *ptr);
452 MONO_API void mono_metadata_free_mh (MonoMethodHeader *mh);
454 /* MonoMethodHeader acccessors */
455 MONO_API const unsigned char*
456 mono_method_header_get_code (MonoMethodHeader *header, uint32_t* code_size, uint32_t* max_stack);
459 mono_method_header_get_locals (MonoMethodHeader *header, uint32_t* num_locals, mono_bool *init_locals);
462 mono_method_header_get_num_clauses (MonoMethodHeader *header);
465 mono_method_header_get_clauses (MonoMethodHeader *header, MonoMethod *method, void **iter, MonoExceptionClause *clause);
468 mono_type_to_unmanaged (MonoType *type, MonoMarshalSpec *mspec,
469 mono_bool as_field, mono_bool unicode, MonoMarshalConv *conv);
472 * Makes a token based on a table and an index
474 #define mono_metadata_make_token(table,idx) (((table) << 24)| (idx))
477 * Returns the table index that this token encodes.
479 #define mono_metadata_token_table(token) ((token) >> 24)
482 * Returns the index that a token refers to
484 #define mono_metadata_token_index(token) ((token & 0xffffff))
487 #define mono_metadata_token_code(token) ((token & 0xff000000))
489 MONO_API uint32_t mono_metadata_token_from_dor (uint32_t dor_index);
491 MONO_API char *mono_guid_to_string (const uint8_t *guid);
493 MONO_API uint32_t mono_metadata_declsec_from_index (MonoImage *meta, uint32_t idx);
495 MONO_API uint32_t mono_metadata_translate_token_index (MonoImage *image, int table, uint32_t idx);
497 MONO_API void mono_metadata_decode_table_row (MonoImage *image, int table,
502 MONO_API uint32_t mono_metadata_decode_table_row_col (MonoImage *image, int table,
508 #endif /* __MONO_METADATA_H__ */