Tue Jul 27 15:47:17 CEST 2004 Paolo Molaro <lupus@ximian.com>
[mono.git] / mono / metadata / class.c
index 636cd6ae38e9c18caf32ed8685a25eeae90cc602..6283d3c1531763aced284694dcbdeeb7715e713b 100644 (file)
@@ -40,6 +40,7 @@ gboolean mono_print_vtable = FALSE;
 
 static MonoClass * mono_class_create_from_typedef (MonoImage *image, guint32 type_token);
 
+void (*mono_debugger_start_class_init_func) (MonoClass *klass) = NULL;
 void (*mono_debugger_class_init_func) (MonoClass *klass) = NULL;
 
 MonoClass *
@@ -57,16 +58,16 @@ mono_class_from_typeref (MonoImage *image, guint32 type_token)
        name = mono_metadata_string_heap (image, cols [MONO_TYPEREF_NAME]);
        nspace = mono_metadata_string_heap (image, cols [MONO_TYPEREF_NAMESPACE]);
        
-       idx = cols [MONO_TYPEREF_SCOPE] >> RESOLTION_SCOPE_BITS;
-       switch (cols [MONO_TYPEREF_SCOPE] & RESOLTION_SCOPE_MASK) {
-       case RESOLTION_SCOPE_MODULE:
+       idx = cols [MONO_TYPEREF_SCOPE] >> MONO_RESOLTION_SCOPE_BITS;
+       switch (cols [MONO_TYPEREF_SCOPE] & MONO_RESOLTION_SCOPE_MASK) {
+       case MONO_RESOLTION_SCOPE_MODULE:
                if (!idx)
                        g_error ("null ResolutionScope not yet handled");
                /* a typedef in disguise */
                return mono_class_from_name (image, nspace, name);
-       case RESOLTION_SCOPE_MODULEREF:
+       case MONO_RESOLTION_SCOPE_MODULEREF:
                return mono_class_from_name (image->modules [idx - 1], nspace, name);
-       case RESOLTION_SCOPE_TYPEREF: {
+       case MONO_RESOLTION_SCOPE_TYPEREF: {
                MonoClass *enclosing = mono_class_from_typeref (image, MONO_TOKEN_TYPE_REF | idx);
                GList *tmp;
                mono_class_init (enclosing);
@@ -78,7 +79,7 @@ mono_class_from_typeref (MonoImage *image, guint32 type_token)
                g_warning ("TypeRef ResolutionScope not yet handled (%d)", idx);
                return NULL;
        }
-       case RESOLTION_SCOPE_ASSEMBLYREF:
+       case MONO_RESOLTION_SCOPE_ASSEMBLYREF:
                break;
        }
 
@@ -690,7 +691,7 @@ mono_class_layout_fields (MonoClass *class)
                int size, align;
                field = &class->fields [i];
                        
-               if (!(field->type->attrs & FIELD_ATTRIBUTE_STATIC))
+               if (!(field->type->attrs & FIELD_ATTRIBUTE_STATIC) || field->type->attrs & FIELD_ATTRIBUTE_LITERAL)
                        continue;
                if (mono_field_is_deleted (field))
                        continue;
@@ -1298,6 +1299,9 @@ mono_class_init (MonoClass *class)
 
        class->init_pending = 1;
 
+       if (mono_debugger_start_class_init_func)
+               mono_debugger_start_class_init_func (class);
+
        mono_stats.initialized_class_count++;
 
        if (class->generic_inst && !class->generic_inst->is_dynamic) {
@@ -1456,6 +1460,10 @@ mono_class_init (MonoClass *class)
                 */
                setup_interface_offsets (class, 0);
                mono_loader_unlock ();
+
+               if (mono_debugger_class_init_func)
+                       mono_debugger_class_init_func (class);
+
                return;
        }
 
@@ -1523,7 +1531,6 @@ mono_class_init (MonoClass *class)
                mono_debugger_class_init_func (class);
 }
 
-
 void
 mono_class_setup_mono_type (MonoClass *class)
 {
@@ -1755,22 +1762,13 @@ mono_class_create_from_typedef (MonoImage *image, guint32 type_token)
        }
 
        g_assert (mono_metadata_token_table (type_token) == MONO_TABLE_TYPEDEF);
-       
+
        mono_metadata_decode_row (tt, tidx - 1, cols, MONO_TYPEDEF_SIZE);
        
        name = mono_metadata_string_heap (image, cols [MONO_TYPEDEF_NAME]);
        nspace = mono_metadata_string_heap (image, cols [MONO_TYPEDEF_NAMESPACE]);
 
-       if (cols [MONO_TYPEDEF_EXTENDS])
-               parent = mono_class_get (image, mono_metadata_token_from_dor (cols [MONO_TYPEDEF_EXTENDS]));
-       interfaces = mono_metadata_interfaces_from_typedef (image, type_token, &icount);
-
        class = g_malloc0 (sizeof (MonoClass));
-                          
-       g_hash_table_insert (image->class_cache, GUINT_TO_POINTER (type_token), class);
-
-       class->interfaces = interfaces;
-       class->interface_count = icount;
 
        class->name = name;
        class->name_space = nspace;
@@ -1779,6 +1777,15 @@ mono_class_create_from_typedef (MonoImage *image, guint32 type_token)
        class->type_token = type_token;
        class->flags = cols [MONO_TYPEDEF_FLAGS];
 
+       g_hash_table_insert (image->class_cache, GUINT_TO_POINTER (type_token), class);
+
+       if (cols [MONO_TYPEDEF_EXTENDS])
+               parent = mono_class_get (image, mono_metadata_token_from_dor (cols [MONO_TYPEDEF_EXTENDS]));
+       interfaces = mono_metadata_interfaces_from_typedef (image, type_token, &icount);
+
+       class->interfaces = interfaces;
+       class->interface_count = icount;
+
        if ((class->flags & TYPE_ATTRIBUTE_STRING_FORMAT_MASK) == TYPE_ATTRIBUTE_UNICODE_CLASS)
                class->unicode = 1;
        /* fixme: maybe we must set this on windows 
@@ -2016,7 +2023,7 @@ mono_fnptr_class_get (MonoMethodSignature *sig)
        result->name_space = "MonoFNPtrFakeClass";
        result->image = NULL; /* need to fix... */
        result->inited = TRUE;
-       result->flags = TYPE_ATTRIBUTE_CLASS; // | (el_class->flags & TYPE_ATTRIBUTE_VISIBILITY_MASK);
+       result->flags = TYPE_ATTRIBUTE_CLASS; /* | (el_class->flags & TYPE_ATTRIBUTE_VISIBILITY_MASK); */
        /* Can pointers get boxed? */
        result->instance_size = sizeof (gpointer);
        result->cast_class = result->element_class = result;
@@ -2124,7 +2131,7 @@ mono_class_create_from_typespec (MonoImage *image, guint32 type_spec,
                class = mono_array_class_get (type->data.klass, 1);
                break;
        case MONO_TYPE_PTR:
-               class = mono_class_from_mono_type (type->data.type);
+               class = mono_ptr_class_get (type->data.type);
                break;
        case MONO_TYPE_GENERICINST:
                g_assert (type->data.generic_inst->klass);
@@ -2390,6 +2397,12 @@ mono_class_get_field_from_name (MonoClass *klass, const char *name)
        return NULL;
 }
 
+void *
+mono_vtable_get_static_field_data (MonoVTable *vt)
+{
+       return vt->data;
+}
+
 MonoProperty*
 mono_class_get_property_from_name (MonoClass *klass, const char *name)
 {
@@ -2470,6 +2483,22 @@ mono_class_get_full (MonoImage *image, guint32 type_token, MonoGenericContext *c
        return mono_class_from_mono_type (inflated);
 }
 
+/**
+ * mono_class_from_name_case:
+ * @image: The MonoImage where the type is looked up in, or NULL for looking up in all loaded assemblies
+ * @name_space: the type namespace
+ * @name: the type short name.
+ *
+ * Obtains a MonoClass with a given namespace and a given name which
+ * is located in the given MonoImage.   The namespace and name
+ * lookups are case insensitive.
+ *
+ * You can also pass `NULL' to the image, and that will lookup for
+ * a type with the given namespace and name in all of the loaded
+ * assemblies: notice that since there might be a name clash in this
+ * case, passing NULL is not encouraged if you need a precise type.
+ *
+ */
 MonoClass *
 mono_class_from_name_case (MonoImage *image, const char* name_space, const char *name)
 {
@@ -2515,6 +2544,22 @@ return_nested_in (MonoClass *class, char *nested) {
        return NULL;
 }
 
+
+/**
+ * mono_class_from_name_case:
+ * @image: The MonoImage where the type is looked up in, or NULL for looking up in all loaded assemblies
+ * @name_space: the type namespace
+ * @name: the type short name.
+ *
+ * Obtains a MonoClass with a given namespace and a given name which
+ * is located in the given MonoImage.   
+ *
+ * You can also pass `NULL' to the image, and that will lookup for
+ * a type with the given namespace and name in all of the loaded
+ * assemblies: notice that since there might be a name clash in this
+ * case, passing NULL is not encouraged if you need a precise type.
+ *
+ */
 MonoClass *
 mono_class_from_name (MonoImage *image, const char* name_space, const char *name)
 {
@@ -2558,8 +2603,8 @@ mono_class_from_name (MonoImage *image, const char* name_space, const char *name
                mono_metadata_decode_row (t, idx - 1, cols, MONO_EXP_TYPE_SIZE);
 
                impl = cols [MONO_EXP_TYPE_IMPLEMENTATION];
-               if ((impl & IMPLEMENTATION_MASK) == IMPLEMENTATION_FILE) {
-                       loaded_image = mono_assembly_load_module (image->assembly, impl >> IMPLEMENTATION_BITS);
+               if ((impl & MONO_IMPLEMENTATION_MASK) == MONO_IMPLEMENTATION_FILE) {
+                       loaded_image = mono_assembly_load_module (image->assembly, impl >> MONO_IMPLEMENTATION_BITS);
                        if (!loaded_image)
                                return NULL;
                        class = mono_class_from_name (loaded_image, name_space, name);
@@ -2870,102 +2915,216 @@ mono_class_get_image (MonoClass *klass)
        return klass->image;
 }
 
+/**
+ * mono_class_get_element_class:
+ * @klass: the MonoClass to act on
+ *
+ * Returns the element class of an array or an enumeration.
+ */
 MonoClass*
 mono_class_get_element_class (MonoClass *klass)
 {
        return klass->element_class;
 }
 
+/**
+ * mono_class_is_valuetype:
+ * @klass: the MonoClass to act on
+ *
+ * Returns true if the MonoClass represents a ValueType.
+ */
 gboolean
 mono_class_is_valuetype (MonoClass *klass)
 {
        return klass->valuetype;
 }
 
+/**
+ * mono_class_is_enum:
+ * @klass: the MonoClass to act on
+ *
+ * Returns true if the MonoClass represents an enumeration.
+ */
 gboolean
 mono_class_is_enum (MonoClass *klass)
 {
        return klass->enumtype;
 }
 
+/**
+ * mono_class_enum_basetype:
+ * @klass: the MonoClass to act on
+ *
+ * Returns the underlying type representation for an enumeration.
+ */
 MonoType*
 mono_class_enum_basetype (MonoClass *klass)
 {
        return klass->enum_basetype;
 }
 
+/**
+ * mono_class_get_parent
+ * @klass: the MonoClass to act on
+ *
+ * Returns the parent class for this class.
+ */
 MonoClass*
 mono_class_get_parent (MonoClass *klass)
 {
        return klass->parent;
 }
 
+/**
+ * mono_class_get_nesting_type;
+ * @klass: the MonoClass to act on
+ *
+ * Returns the container type where this type is nested or NULL if this type is not a nested type.
+ */
 MonoClass*
 mono_class_get_nesting_type (MonoClass *klass)
 {
        return klass->nested_in;
 }
 
+/**
+ * mono_class_get_rank:
+ * @klass: the MonoClass to act on
+ *
+ * Returns the rank for the array (the number of dimensions).
+ */
 int
 mono_class_get_rank (MonoClass *klass)
 {
        return klass->rank;
 }
 
+/**
+ * mono_class_get_flags:
+ * @klass: the MonoClass to act on
+ *
+ * The type flags from the TypeDef table from the metadata.
+ * see the TYPE_ATTRIBUTE_* definitions on tabledefs.h for the
+ * different values.
+ *
+ * Returns the flags from the TypeDef table.
+ */
 guint32
 mono_class_get_flags (MonoClass *klass)
 {
        return klass->flags;
 }
 
+/**
+ * mono_class_get_name
+ * @klass: the MonoClass to act on
+ *
+ * Returns the name of the class.
+ */
 const char*
 mono_class_get_name (MonoClass *klass)
 {
        return klass->name;
 }
 
+/**
+ * mono_class_get_namespace:
+ * @klass: the MonoClass to act on
+ *
+ * Returns the namespace of the class.
+ */
 const char*
 mono_class_get_namespace (MonoClass *klass)
 {
        return klass->name_space;
 }
 
+/**
+ * mono_class_get_type:
+ * @klass: the MonoClass to act on
+ *
+ * This method returns the internal Type representation for the class.
+ *
+ * Returns the MonoType from the class.
+ */
 MonoType*
 mono_class_get_type (MonoClass *klass)
 {
        return &klass->byval_arg;
 }
 
+/**
+ * mono_class_get_byref_type:
+ * @klass: the MonoClass to act on
+ *
+ * 
+ */
 MonoType*
 mono_class_get_byref_type (MonoClass *klass)
 {
        return &klass->this_arg;
 }
 
+/**
+ * mono_class_num_fields:
+ * @klass: the MonoClass to act on
+ *
+ * Returns the number of static and instance fields in the class.
+ */
 int
 mono_class_num_fields (MonoClass *klass)
 {
        return klass->field.count;
 }
 
+/**
+ * mono_class_num_methods:
+ * @klass: the MonoClass to act on
+ *
+ * Returns the number of methods in the class.
+ */
 int
 mono_class_num_methods (MonoClass *klass)
 {
        return klass->method.count;
 }
 
+/**
+ * mono_class_num_properties
+ * @klass: the MonoClass to act on
+ *
+ * Returns the number of properties in the class.
+ */
 int
 mono_class_num_properties (MonoClass *klass)
 {
        return klass->property.count;
 }
 
+/**
+ * mono_class_num_events:
+ * @klass: the MonoClass to act on
+ *
+ * Returns the number of events in the class.
+ */
 int
 mono_class_num_events (MonoClass *klass)
 {
        return klass->event.count;
 }
 
+/**
+ * mono_class_get_fields:
+ * @klass: the MonoClass to act on
+ *
+ * This routine is an iterator routine for retrieving the fields in a class.
+ *
+ * You must pass a gpointer that points to zero and is treated as an opaque handle to
+ * iterate over all of the elements.  When no more values are
+ * available, the return value is NULL.
+ *
+ * Returns a `MonoClassField *' on each iteration, or NULL when no more fields are available.
+ */
 MonoClassField*
 mono_class_get_fields (MonoClass* klass, gpointer *iter)
 {
@@ -2991,6 +3150,18 @@ mono_class_get_fields (MonoClass* klass, gpointer *iter)
        return NULL;
 }
 
+/**
+ * mono_class_get_methods
+ * @klass: the MonoClass to act on
+ *
+ * This routine is an iterator routine for retrieving the fields in a class.
+ *
+ * You must pass a gpointer that points to zero and is treated as an opaque handle to
+ * iterate over all of the elements.  When no more values are
+ * available, the return value is NULL.
+ *
+ * Returns a MonoMethod on each iteration or NULL when no more methods are available.
+ */
 MonoMethod*
 mono_class_get_methods (MonoClass* klass, gpointer *iter)
 {
@@ -3018,6 +3189,18 @@ mono_class_get_methods (MonoClass* klass, gpointer *iter)
        return NULL;
 }
 
+/**
+ * mono_class_get_properties:
+ * @klass: the MonoClass to act on
+ *
+ * This routine is an iterator routine for retrieving the properties in a class.
+ *
+ * You must pass a gpointer that points to zero and is treated as an opaque handle to
+ * iterate over all of the elements.  When no more values are
+ * available, the return value is NULL.
+ *
+ * Returns a `MonoProperty *' on each invocation, or NULL when no more are available.
+ */
 MonoProperty*
 mono_class_get_properties (MonoClass* klass, gpointer *iter)
 {
@@ -3043,6 +3226,18 @@ mono_class_get_properties (MonoClass* klass, gpointer *iter)
        return NULL;
 }
 
+/**
+ * mono_class_get_events:
+ * @klass: the MonoClass to act on
+ *
+ * This routine is an iterator routine for retrieving the properties in a class.
+ *
+ * You must pass a gpointer that points to zero and is treated as an opaque handle to
+ * iterate over all of the elements.  When no more values are
+ * available, the return value is NULL.
+ *
+ * Returns a `MonoEvent *' on each invocation, or NULL when no more are available.
+ */
 MonoEvent*
 mono_class_get_events (MonoClass* klass, gpointer *iter)
 {
@@ -3068,6 +3263,18 @@ mono_class_get_events (MonoClass* klass, gpointer *iter)
        return NULL;
 }
 
+/**
+ * mono_class_get_interfaaces
+ * @klass: the MonoClass to act on
+ *
+ * This routine is an iterator routine for retrieving the interfaces implemented by this class.
+ *
+ * You must pass a gpointer that points to zero and is treated as an opaque handle to
+ * iterate over all of the elements.  When no more values are
+ * available, the return value is NULL.
+ *
+ * Returns a `Monoclass *' on each invocation, or NULL when no more are available.
+ */
 MonoClass*
 mono_class_get_interfaces (MonoClass* klass, gpointer *iter)
 {
@@ -3095,6 +3302,18 @@ mono_class_get_interfaces (MonoClass* klass, gpointer *iter)
        return NULL;
 }
 
+/**
+ * mono_class_get_interfaaces
+ * @klass: the MonoClass to act on
+ *
+ * This routine is an iterator routine for retrieving the nested types of a class.
+ *
+ * You must pass a gpointer that points to zero and is treated as an opaque handle to
+ * iterate over all of the elements.  When no more values are
+ * available, the return value is NULL.
+ *
+ * Returns a `Monoclass *' on each invocation, or NULL when no more are available.
+ */
 MonoClass*
 mono_class_get_nested_types (MonoClass* klass, gpointer *iter)
 {
@@ -3122,90 +3341,189 @@ mono_class_get_nested_types (MonoClass* klass, gpointer *iter)
        return NULL;
 }
 
+/**
+ * mono_field_get_name:
+ * @field: the MonoClassField to act on
+ *
+ * Returns the name of the field.
+ */
 const char*
 mono_field_get_name (MonoClassField *field)
 {
        return field->name;
 }
 
+/**
+ * mono_field_get_type:
+ * @field: the MonoClassField to act on
+ *
+ * Returns MonoType of the field.
+ */
 MonoType*
 mono_field_get_type (MonoClassField *field)
 {
        return field->type;
 }
 
+/**
+ * mono_field_get_type:
+ * @field: the MonoClassField to act on
+ *
+ * Returns MonoClass where the field was defined.
+ */
 MonoClass*
 mono_field_get_parent (MonoClassField *field)
 {
        return field->parent;
 }
 
+/**
+ * mono_field_get_flags;
+ * @field: the MonoClassField to act on
+ *
+ * The metadata flags for a field are encoded using the
+ * FIELD_ATTRIBUTE_* constants.  See the tabledefs.h file for details.
+ *
+ * Returns the flags for the field.
+ */
 guint32
 mono_field_get_flags (MonoClassField *field)
 {
        return field->type->attrs;
 }
 
+/**
+ * mono_property_get_name: 
+ * @prop: the MonoProperty to act on
+ *
+ * Returns the name of the property
+ */
 const char*
 mono_property_get_name (MonoProperty *prop)
 {
        return prop->name;
 }
 
+/**
+ * mono_property_get_set_method
+ * @prop: the MonoProperty to act on.
+ *
+ * Returns the setter method of the property (A MonoMethod)
+ */
 MonoMethod*
 mono_property_get_set_method (MonoProperty *prop)
 {
        return prop->set;
 }
 
+/**
+ * mono_property_get_get_method
+ * @prop: the MonoProperty to act on.
+ *
+ * Returns the setter method of the property (A MonoMethod)
+ */
 MonoMethod*
 mono_property_get_get_method (MonoProperty *prop)
 {
        return prop->get;
 }
 
+/**
+ * mono_property_get_parent:
+ * @prop: the MonoProperty to act on.
+ *
+ * Returns the MonoClass where the property was defined.
+ */
 MonoClass*
 mono_property_get_parent (MonoProperty *prop)
 {
        return prop->parent;
 }
 
+/**
+ * mono_property_get_flags:
+ * @prop: the MonoProperty to act on.
+ *
+ * The metadata flags for a property are encoded using the
+ * PROPERTY_ATTRIBUTE_* constants.  See the tabledefs.h file for details.
+ *
+ * Returns the flags for the property.
+ */
 guint32
 mono_property_get_flags (MonoProperty *prop)
 {
        return prop->attrs;
 }
 
+/**
+ * mono_event_get_name:
+ * @event: the MonoEvent to act on
+ *
+ * Returns the name of the event.
+ */
 const char*
 mono_event_get_name (MonoEvent *event)
 {
        return event->name;
 }
 
+/**
+ * mono_event_get_add_method:
+ * @event: The MonoEvent to act on.
+ *
+ * Returns the `add' method for the event (a MonoMethod).
+ */
 MonoMethod*
 mono_event_get_add_method (MonoEvent *event)
 {
        return event->add;
 }
 
+/**
+ * mono_event_get_remove_method:
+ * @event: The MonoEvent to act on.
+ *
+ * Returns the `remove' method for the event (a MonoMethod).
+ */
 MonoMethod*
 mono_event_get_remove_method (MonoEvent *event)
 {
        return event->remove;
 }
 
+/**
+ * mono_event_get_raise_method:
+ * @event: The MonoEvent to act on.
+ *
+ * Returns the `raise' method for the event (a MonoMethod).
+ */
 MonoMethod*
 mono_event_get_raise_method (MonoEvent *event)
 {
        return event->raise;
 }
 
+/**
+ * mono_event_get_parent:
+ * @event: the MonoEvent to act on.
+ *
+ * Returns the MonoClass where the event is defined.
+ */
 MonoClass*
 mono_event_get_parent (MonoEvent *event)
 {
        return event->parent;
 }
 
+/**
+ * mono_event_get_flags
+ * @event: the MonoEvent to act on.
+ *
+ * The metadata flags for an event are encoded using the
+ * EVENT_* constants.  See the tabledefs.h file for details.
+ *
+ * Returns the flags for the event.
+ */
 guint32
 mono_event_get_flags (MonoEvent *event)
 {