2008-10-24 Mark Probst <mark.probst@gmail.com>
[mono.git] / mono / metadata / metadata.h
index d71c9f82ffabbacbc3e915fb9ca3662e84214f6f..1238b52ef4085b7b5e5fe8e6b9824e2f7648cfa8 100644 (file)
@@ -8,13 +8,18 @@
 #include <mono/metadata/row-indexes.h>
 #include <mono/metadata/image.h>
 
+G_BEGIN_DECLS
+
 #ifdef __GNUC__
 #define MONO_ZERO_LEN_ARRAY 0
 #else
 #define MONO_ZERO_LEN_ARRAY 1
 #endif
 
-#define MONO_TYPE_ISSTRUCT(t) (!(t)->byref && (((t)->type == MONO_TYPE_VALUETYPE && !(t)->data.klass->enumtype) || ((t)->type == MONO_TYPE_TYPEDBYREF) || (((t)->type == MONO_TYPE_GENERICINST) && mono_metadata_generic_class_is_valuetype ((t)->data.generic_class))))
+#define MONO_TYPE_ISSTRUCT(t) (!(t)->byref && (((t)->type == MONO_TYPE_VALUETYPE && \
+       !(t)->data.klass->enumtype) || ((t)->type == MONO_TYPE_TYPEDBYREF) || \
+       (((t)->type == MONO_TYPE_GENERICINST) && mono_metadata_generic_class_is_valuetype ((t)->data.generic_class) && !(t)->data.generic_class->container_class->enumtype)))
+
 #define MONO_TYPE_IS_VOID(t) ((t) && ((t)->type == MONO_TYPE_VOID) && !(t)->byref)
 #define MONO_TYPE_IS_POINTER(t) ((t) && (((t)->byref || ((t)->type == MONO_TYPE_I) || (t)->type == MONO_TYPE_STRING) || ((t)->type == MONO_TYPE_SZARRAY) || ((t)->type == MONO_TYPE_CLASS) || ((t)->type == MONO_TYPE_CLASS) || ((t)->type == MONO_TYPE_OBJECT) || ((t)->type == MONO_TYPE_ARRAY) || ((t)->type == MONO_TYPE_PTR)))
 
 
 #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))
 
+#define MONO_CLASS_IS_IMPORT(c) ((c->flags & TYPE_ATTRIBUTE_IMPORT))
+
 typedef struct _MonoClass MonoClass;
 typedef struct _MonoDomain MonoDomain;
+typedef struct _MonoMethod MonoMethod;
 
 typedef enum {
        MONO_EXCEPTION_CLAUSE_NONE,
@@ -88,6 +96,54 @@ typedef enum {
        MONO_NATIVE_MAX = 0x50 /* no info */
 } MonoMarshalNative;
 
+/* Used only in context of SafeArray */
+typedef enum {
+       MONO_VARIANT_EMPTY = 0x00,
+       MONO_VARIANT_NULL = 0x01,
+       MONO_VARIANT_I2 = 0x02,
+       MONO_VARIANT_I4 = 0x03,
+       MONO_VARIANT_R4 = 0x04,
+       MONO_VARIANT_R8 = 0x05,
+       MONO_VARIANT_CY = 0x06,
+       MONO_VARIANT_DATE = 0x07,
+       MONO_VARIANT_BSTR = 0x08,
+       MONO_VARIANT_DISPATCH = 0x09,
+       MONO_VARIANT_ERROR = 0x0a,
+       MONO_VARIANT_BOOL = 0x0b,
+       MONO_VARIANT_VARIANT = 0x0c,
+       MONO_VARIANT_UNKNOWN = 0x0d,
+       MONO_VARIANT_DECIMAL = 0x0e,
+       MONO_VARIANT_I1 = 0x10,
+       MONO_VARIANT_UI1 = 0x11,
+       MONO_VARIANT_UI2 = 0x12,
+       MONO_VARIANT_UI4 = 0x13,
+       MONO_VARIANT_I8 = 0x14,
+       MONO_VARIANT_UI8 = 0x15,
+       MONO_VARIANT_INT = 0x16,
+       MONO_VARIANT_UINT = 0x17,
+       MONO_VARIANT_VOID = 0x18,
+       MONO_VARIANT_HRESULT = 0x19,
+       MONO_VARIANT_PTR = 0x1a,
+       MONO_VARIANT_SAFEARRAY = 0x1b,
+       MONO_VARIANT_CARRAY = 0x1c,
+       MONO_VARIANT_USERDEFINED = 0x1d,
+       MONO_VARIANT_LPSTR = 0x1e,
+       MONO_VARIANT_LPWSTR = 0x1f,
+       MONO_VARIANT_RECORD = 0x24,
+       MONO_VARIANT_FILETIME = 0x40,
+       MONO_VARIANT_BLOB = 0x41,
+       MONO_VARIANT_STREAM = 0x42,
+       MONO_VARIANT_STORAGE = 0x43,
+       MONO_VARIANT_STREAMED_OBJECT = 0x44,
+       MONO_VARIANT_STORED_OBJECT = 0x45,
+       MONO_VARIANT_BLOB_OBJECT = 0x46,
+       MONO_VARIANT_CF = 0x47,
+       MONO_VARIANT_CLSID = 0x48,
+       MONO_VARIANT_VECTOR = 0x1000,
+       MONO_VARIANT_ARRAY = 0x2000,
+       MONO_VARIANT_BYREF = 0x4000
+} MonoMarshalVariant;
+
 typedef enum {
        MONO_MARSHAL_CONV_NONE,
        MONO_MARSHAL_CONV_BOOL_VARIANTBOOL,
@@ -110,6 +166,7 @@ typedef enum {
        MONO_MARSHAL_CONV_LPTSTR_SB,
        MONO_MARSHAL_CONV_LPWSTR_SB,
        MONO_MARSHAL_CONV_ARRAY_BYVALARRAY,
+       MONO_MARSHAL_CONV_ARRAY_BYVALCHARARRAY,
        MONO_MARSHAL_CONV_ARRAY_SAVEARRAY,
        MONO_MARSHAL_CONV_ARRAY_LPARRAY,
        MONO_MARSHAL_CONV_OBJECT_INTERFACE,
@@ -118,7 +175,10 @@ typedef enum {
        MONO_MARSHAL_CONV_OBJECT_STRUCT,
        MONO_MARSHAL_CONV_DEL_FTN,
        MONO_MARSHAL_CONV_FTN_DEL,
-       MONO_MARSHAL_FREE_ARRAY
+       MONO_MARSHAL_FREE_ARRAY,
+       MONO_MARSHAL_CONV_BSTR_STR,
+       MONO_MARSHAL_CONV_SAFEHANDLE,
+       MONO_MARSHAL_CONV_HANDLEREF
 } MonoMarshalConv;
 
 typedef struct {
@@ -134,6 +194,10 @@ typedef struct {
                        char *custom_name;
                        char *cookie;
                } custom_data;
+               struct {
+                       MonoMarshalVariant elem_type;
+                       gint32 num_elem;
+               } safearray_data;
        } data;
 } MonoMarshalSpec;
 
@@ -204,6 +268,8 @@ guint32     mono_metadata_get_constant_index (MonoImage *meta, guint32 token, gu
  */
 guint32 mono_metadata_decode_value     (const char            *ptr,
                                         const char           **rptr);
+gint32 mono_metadata_decode_signed_value (const char *ptr, const char **rptr);
+
 guint32 mono_metadata_decode_blob_size (const char            *ptr,
                                         const char           **rptr);
 
@@ -213,6 +279,8 @@ void mono_metadata_encode_value (guint32 value, char *bug, char **endbuf);
        ((clause)->try_offset <= (offset) && (offset) < ((clause)->try_offset + (clause)->try_len))
 #define MONO_OFFSET_IN_HANDLER(clause,offset) \
        ((clause)->handler_offset <= (offset) && (offset) < ((clause)->handler_offset + (clause)->handler_len))
+#define MONO_OFFSET_IN_FILTER(clause,offset) \
+       ((clause)->flags == MONO_EXCEPTION_CLAUSE_FILTER && (clause)->data.filter_offset <= (offset) && (offset) < ((clause)->handler_offset))
 
 typedef struct {
        guint32 flags;
@@ -230,13 +298,15 @@ typedef struct _MonoType MonoType;
 typedef struct _MonoGenericInst MonoGenericInst;
 typedef struct _MonoGenericClass MonoGenericClass;
 typedef struct _MonoDynamicGenericClass MonoDynamicGenericClass;
-typedef struct _MonoGenericMethod MonoGenericMethod;
 typedef struct _MonoGenericContext MonoGenericContext;
 typedef struct _MonoGenericContainer MonoGenericContainer;
 typedef struct _MonoGenericParam MonoGenericParam;
 typedef struct _MonoArrayType MonoArrayType;
 typedef struct _MonoMethodSignature MonoMethodSignature;
 
+/* FIXME: Keeping this name alive for now, since it is part of the exposed API, even though no entrypoint uses it.  */
+typedef struct invalid_name MonoGenericMethod;
+
 typedef struct {
        unsigned int required : 1;
        unsigned int token    : 31;
@@ -251,6 +321,9 @@ struct _MonoArrayType {
        int *lobounds;
 };
 
+/* This structure is internal to the runtime: use the mono_type*
+ * accessors below, because it will soon ago away from the public header file.
+ */
 struct _MonoType {
        union {
                MonoClass *klass; /* for VALUETYPE and CLASS */
@@ -261,13 +334,17 @@ struct _MonoType {
                MonoGenericClass *generic_class; /* for GENERICINST */
        } data;
        unsigned int attrs    : 16; /* param attributes or field flags */
-       unsigned int type     : 8;  /* ElementTypeEnum */
+       MonoTypeEnum type     : 8;
        unsigned int num_mods : 6;  /* max 64 modifiers follow at the end */
        unsigned int byref    : 1;
        unsigned int pinned   : 1;  /* valid when included in a local var signature */
        MonoCustomMod modifiers [MONO_ZERO_LEN_ARRAY]; /* this may grow */
 };
 
+/*
+ * This structure is an internal runtime detail: use the mono_signature_*
+ * accessors below, because it will go away from the public header.
+ */
 struct _MonoMethodSignature {
        unsigned int  hasthis : 1;
        unsigned int  explicit_this   : 1;
@@ -283,17 +360,7 @@ struct _MonoMethodSignature {
        MonoType     *params [MONO_ZERO_LEN_ARRAY];
 };
 
-typedef struct {
-       guint32      code_size;
-       const unsigned char  *code;
-       guint16      max_stack;
-       unsigned int num_clauses : 15;
-       /* if num_locals != 0, then the following apply: */
-       unsigned int init_locals : 1;
-       guint16      num_locals;
-       MonoExceptionClause *clauses;
-       MonoType    *locals [MONO_ZERO_LEN_ARRAY];
-} MonoMethodHeader;
+typedef struct _MonoMethodHeader MonoMethodHeader;
 
 typedef enum {
        MONO_PARSE_TYPE,
@@ -321,6 +388,10 @@ mono_type_get_class      (MonoType *type);
 MonoArrayType*
 mono_type_get_array_type (MonoType *type);
 
+/* For MONO_TYPE_PTR */
+MonoType*
+mono_type_get_ptr_type (MonoType *type);
+
 MonoClass*
 mono_type_get_modifiers  (MonoType *type, gboolean *is_required, gpointer *iter);
 
@@ -379,6 +450,7 @@ int            mono_type_size                  (MonoType        *type,
 int            mono_type_stack_size            (MonoType        *type, 
                                                int             *alignment);
 
+gboolean       mono_type_generic_inst_is_valuetype      (MonoType *type);
 gboolean       mono_metadata_generic_class_is_valuetype (MonoGenericClass *gclass);
 guint          mono_metadata_generic_class_hash  (MonoGenericClass *gclass);
 gboolean       mono_metadata_generic_class_equal (MonoGenericClass *g1, MonoGenericClass *g2);
@@ -407,6 +479,19 @@ guint             mono_signature_hash (MonoMethodSignature *sig);
 MonoMethodHeader *mono_metadata_parse_mh (MonoImage *m, const char *ptr);
 void              mono_metadata_free_mh  (MonoMethodHeader *mh);
 
+/* MonoMethodHeader acccessors */
+const unsigned char*
+mono_method_header_get_code (MonoMethodHeader *header, guint32* code_size, guint32* max_stack);
+
+MonoType**
+mono_method_header_get_locals (MonoMethodHeader *header, guint32* num_locals, gboolean *init_locals);
+
+int
+mono_method_header_get_num_clauses (MonoMethodHeader *header);
+
+int
+mono_method_header_get_clauses (MonoMethodHeader *header, MonoMethod *method, gpointer *iter, MonoExceptionClause *clause);
+
 guint32 
 mono_type_to_unmanaged (MonoType *type, MonoMarshalSpec *mspec, 
                        gboolean as_field, gboolean unicode, MonoMarshalConv *conv);
@@ -435,4 +520,17 @@ char *mono_guid_to_string (const guint8 *guid);
 
 guint32 mono_metadata_declsec_from_index (MonoImage *meta, guint32 idx);
 
+guint32 mono_metadata_translate_token_index (MonoImage *image, int table, guint32 idx);
+
+void    mono_metadata_decode_table_row (MonoImage *image, int table,
+                                      int                    idx,
+                                      guint32               *res,
+                                      int                    res_size);
+
+guint32      mono_metadata_decode_table_row_col (MonoImage *image, int table,
+                                          int            idx, 
+                                          guint          col);
+
+G_END_DECLS
+
 #endif /* __MONO_METADATA_H__ */