Sat Aug 25 12:52:54 CEST 2001 Paolo Molaro <lupus@ximian.com>
[mono.git] / mono / metadata / metadata.h
1
2 #ifndef __MONO_METADATA_H__
3 #define __MONO_METADATA_H__
4
5 #include <glib.h>
6
7 #include <mono/metadata/blob.h>
8 #include <mono/metadata/row-indexes.h>
9 #include <mono/metadata/image.h>
10
11 #ifdef __GNUC__
12 #define MONO_ZERO_LEN_ARRAY 0
13 #else
14 #define MONO_ZERO_LEN_ARRAY 1
15 #endif
16
17 typedef struct _MonoClass MonoClass;
18
19 typedef enum {
20         MONO_TABLE_MODULE,
21         MONO_TABLE_TYPEREF,
22         MONO_TABLE_TYPEDEF,
23         MONO_TABLE_UNUSED1,
24         MONO_TABLE_FIELD,
25         MONO_TABLE_UNUSED2,
26         MONO_TABLE_METHOD,
27         MONO_TABLE_UNUSED3,
28         MONO_TABLE_PARAM,
29         MONO_TABLE_INTERFACEIMPL,
30         MONO_TABLE_MEMBERREF,
31         MONO_TABLE_CONSTANT,
32         MONO_TABLE_CUSTOMATTRIBUTE,
33         MONO_TABLE_FIELDMARSHAL,
34         MONO_TABLE_DECLSECURITY,
35         MONO_TABLE_CLASSLAYOUT,
36         MONO_TABLE_FIELDLAYOUT,
37         MONO_TABLE_STANDALONESIG,
38         MONO_TABLE_EVENTMAP,
39         MONO_TABLE_UNUSED4,
40         MONO_TABLE_EVENT,
41         MONO_TABLE_PROPERTYMAP,
42         MONO_TABLE_UNUSED5,
43         MONO_TABLE_PROPERTY,
44         MONO_TABLE_METHODSEMANTICS,
45         MONO_TABLE_METHODIMPL,
46         MONO_TABLE_MODULEREF,
47         MONO_TABLE_TYPESPEC,
48         MONO_TABLE_IMPLMAP,
49         MONO_TABLE_FIELDRVA,
50         MONO_TABLE_UNUSED6,
51         MONO_TABLE_UNUSED7,
52         MONO_TABLE_ASSEMBLY,
53         MONO_TABLE_ASSEMBLYPROCESSOR,
54         MONO_TABLE_ASSEMBLYOS,
55         MONO_TABLE_ASSEMBLYREF,
56         MONO_TABLE_ASSEMBLYREFPROCESSOR,
57         MONO_TABLE_ASSEMBLYREFOS,
58         MONO_TABLE_FILE,
59         MONO_TABLE_EXPORTEDTYPE,
60         MONO_TABLE_MANIFESTRESOURCE,
61         MONO_TABLE_NESTEDCLASS,
62
63 #define MONO_TABLE_LAST MONO_TABLE_NESTEDCLASS
64 } MonoMetaTableEnum;
65
66 typedef enum {
67         MONO_EXCEPTION_CLAUSE_NONE,
68         MONO_EXCEPTION_CLAUSE_FILTER,
69         MONO_EXCEPTION_CLAUSE_FINALLY,
70         MONO_EXCEPTION_CLAUSE_FAULT = 4
71 } MonoExceptionEnum;
72
73 typedef enum {
74         MONO_CALL_DEFAULT,
75         MONO_CALL_C,
76         MONO_CALL_STDCALL,
77         MONO_CALL_THISCALL,
78         MONO_CALL_FASTCALL,
79         MONO_CALL_VARARG
80 } MonoCallConvention;
81
82 void         mono_metadata_decode_row (MonoTableInfo         *t,
83                                        int                    idx,
84                                        guint32               *res,
85                                        int                    res_size);
86
87 guint32      mono_metadata_decode_row_col (MonoTableInfo *t, 
88                                            int            idx, 
89                                            guint          col);
90
91 /*
92  * This macro is used to extract the size of the table encoded in
93  * the size_bitfield of MonoTableInfo.
94  */
95 #define mono_metadata_table_size(bitfield,table) ((((bitfield) >> ((table)*2)) & 0x3) + 1)
96 #define mono_metadata_table_count(bitfield) ((bitfield) >> 24)
97
98 /*
99  *
100  */
101 char          *mono_metadata_locate        (MonoMetadata *meta, int table, int idx);
102 char          *mono_metadata_locate_token  (MonoMetadata *meta, guint32 token);
103                                            
104 const char    *mono_metadata_string_heap   (MonoMetadata *meta, guint32 index);
105 const char    *mono_metadata_blob_heap     (MonoMetadata *meta, guint32 index);
106 const char    *mono_metadata_user_string   (MonoMetadata *meta, guint32 index);
107
108 guint32 mono_metadata_typedef_from_field  (MonoMetadata *meta, guint32 index);
109 guint32 mono_metadata_typedef_from_method (MonoMetadata *meta, guint32 index);
110
111 /*
112  * Functions to extract information from the Blobs
113  */
114 guint32 mono_metadata_decode_value     (const char            *ptr,
115                                         const char           **rptr);
116 guint32 mono_metadata_decode_blob_size (const char            *ptr,
117                                         const char           **rptr);
118
119 typedef struct {
120         guint32 flags;
121         guint32 try_offset;
122         guint32 try_len;
123         guint32 handler_offset;
124         guint32 handler_len;
125         guint32 token_or_filter;
126 } MonoExceptionClause;
127
128 typedef struct _MonoType MonoType;
129 typedef struct _MonoArray MonoArray;
130 typedef struct _MonoMethodSignature MonoMethodSignature;
131
132 typedef struct {
133         unsigned int required : 1;
134         unsigned int token    : 31;
135 } MonoCustomMod;
136
137 struct _MonoArray {
138         MonoType *type;
139         int rank;
140         int numsizes;
141         int numlobounds;
142         int *sizes;
143         int *lobounds;
144 };
145
146 struct _MonoType {
147         union {
148                 MonoClass *klass; /* for VALUETYPE and CLASS */
149                 MonoType *type;   /* for PTR and SZARRAY */
150                 MonoArray *array; /* for ARRAY */
151                 MonoMethodSignature *method;
152         } data;
153         unsigned int attrs    : 16; /* param attributes or field flags */
154         unsigned int type     : 8;  /* ElementTypeEnum */
155         unsigned int num_mods : 6;  /* max 64 modifiers follow at the end */
156         unsigned int byref    : 1;
157         unsigned int pinned   : 1;  /* valid when included in a local var signature */
158         MonoCustomMod modifiers [MONO_ZERO_LEN_ARRAY]; /* this may grow */
159 };
160
161 struct _MonoMethodSignature {
162         char          hasthis;
163         char          explicit_this;
164         char          call_convention;
165         guint16       param_count;
166         guint16       sentinelpos;
167         MonoType     *ret;
168         MonoType    **params;
169         guint32       params_size;
170 };
171
172 typedef struct {
173         guint32      code_size;
174         const unsigned char  *code;
175         guint16      max_stack;
176         unsigned int num_clauses : 15;
177         /* if num_locals != 0, then the following apply: */
178         unsigned int init_locals : 1;
179         guint16      num_locals;
180         MonoType   **locals;
181         guint32      locals_size;
182         MonoExceptionClause *clauses;
183 } MonoMethodHeader;
184
185 typedef enum {
186         MONO_PARSE_TYPE,
187         MONO_PARSE_MOD_TYPE,
188         MONO_PARSE_LOCAL,
189         MONO_PARSE_PARAM,
190         MONO_PARSE_RET,
191         MONO_PARSE_FIELD
192 } MonoParseTypeMode;
193
194 guint32     mono_metadata_parse_typedef_or_ref (MonoMetadata      *m,
195                                                 const char      *ptr,
196                                                 const char     **rptr);
197 int            mono_metadata_parse_custom_mod  (MonoMetadata      *m,
198                                                 MonoCustomMod   *dest,
199                                                 const char      *ptr,
200                                                 const char     **rptr);
201 MonoArray     *mono_metadata_parse_array       (MonoMetadata      *m,
202                                                 const char      *ptr,
203                                                 const char     **rptr);
204 void           mono_metadata_free_array        (MonoArray       *array);
205 MonoType      *mono_metadata_parse_type        (MonoMetadata      *m,
206                                                 MonoParseTypeMode  mode,
207                                                 short              opt_attrs,
208                                                 const char        *ptr,
209                                                 const char       **rptr);
210 MonoType      *mono_metadata_parse_param       (MonoMetadata      *m,
211                                                 const char      *ptr,
212                                                 const char      **rptr);
213 MonoType      *mono_metadata_parse_ret_type    (MonoMetadata      *m,
214                                                 const char      *ptr,
215                                                 const char      **rptr);
216 MonoType      *mono_metadata_parse_field_type  (MonoMetadata      *m,
217                                                 short            field_flags,
218                                                 const char      *ptr,
219                                                 const char      **rptr);
220 void           mono_metadata_free_type         (MonoType        *type);
221 int            mono_type_size                  (MonoType        *type, 
222                                                 int             *alignment);
223
224 MonoMethodSignature  *mono_metadata_parse_method_signature (MonoMetadata            *m,
225                                                             int                    def,
226                                                             const char            *ptr,
227                                                             const char           **rptr);
228 void                  mono_metadata_free_method_signature  (MonoMethodSignature   *method);
229
230 gboolean          mono_metadata_signature_equal (MonoMetadata *m1, 
231                                                  MonoMethodSignature *sig1, 
232                                                  MonoMetadata *m2, 
233                                                  MonoMethodSignature *sig2);
234
235 MonoMethodHeader *mono_metadata_parse_mh (MonoMetadata *m, const char *ptr);
236 void              mono_metadata_free_mh  (MonoMethodHeader *mh);
237
238 /*
239  * Makes a token based on a table and an index
240  */
241 #define mono_metadata_make_token(table,idx) (((table) << 24)| idx)
242
243 /*
244  * Returns the table index that this token encodes.
245  */
246 #define mono_metadata_token_table(token) ((token) >> 24)
247
248  /*
249  * Returns the index that a token refers to
250  */
251 #define mono_metadata_token_index(token) ((token & 0xffffff))
252
253
254 #define mono_metadata_token_code(token) ((token & 0xff000000))
255
256 guint32 mono_metadata_token_from_dor (guint32 dor_index);
257
258 #endif /* __MONO_METADATA_H__ */