2005-05-31 Sebastien Pouliot <sebastien@ximian.com>
[mono.git] / mcs / mcs / enum.cs
old mode 100755 (executable)
new mode 100644 (file)
index 7068be7..f2ed451
@@ -17,33 +17,34 @@ using System.Globalization;
 
 namespace Mono.CSharp {
 
-       // Maybe can be usefull to derive from MemberCore
-       class EnumMember: Attributable {
-               string name;
-               Enum parent;
-               Location loc;
-
+       class EnumMember: MemberCore {
                static string[] attribute_targets = new string [] { "field" };
 
+               Enum parent_enum;
                public FieldBuilder builder;
+               internal readonly Expression Type;
 
-               public EnumMember (string name, Enum parent, Location loc, Attributes attrs):
-                       base (attrs)
+               public EnumMember (Enum parent_enum, Expression expr, string name,
+                                  Location loc, Attributes attrs):
+                       base (null, new MemberName (name), attrs, loc)
                {
-                       this.name = name;
-                       this.parent = parent;
-                       this.loc = loc;
+                       this.parent_enum = parent_enum;
+                       this.ModFlags = parent_enum.ModFlags;
+                       this.Type = expr;
                }
 
-               public override void ApplyAttributeBuilder(Attribute a, CustomAttributeBuilder cb)
+               public override void ApplyAttributeBuilder (Attribute a, CustomAttributeBuilder cb)
                {
                        if (a.Type == TypeManager.marshal_as_attr_type) {
-                               UnmanagedMarshal marshal = a.GetMarshal ();
+                               UnmanagedMarshal marshal = a.GetMarshal (this);
                                if (marshal != null) {
                                        builder.SetMarshal (marshal);
-                                       return;
                                }
-                               Report.Warning_T (-24, a.Location);
+                               return;
+                       }
+
+                       if (a.Type.IsSubclassOf (TypeManager.security_attr_type)) {
+                               a.Error_InvalidSecurityParent ();
                                return;
                        }
 
@@ -56,61 +57,66 @@ namespace Mono.CSharp {
                        }
                }
 
-               public override bool IsClsCompliaceRequired(DeclSpace ds)
-               {
-                       return parent.IsClsCompliaceRequired (ds);
-               }
-
                public void DefineMember (TypeBuilder tb)
                {
                        FieldAttributes attr = FieldAttributes.Public | FieldAttributes.Static
                                | FieldAttributes.Literal;
                        
-                       builder = tb.DefineField (name, tb, attr);
+                       builder = tb.DefineField (Name, tb, attr);
+               }
+
+               public override bool Define ()
+               {
+                       throw new NotImplementedException ();
                }
 
                public void Emit (EmitContext ec)
                {
                        if (OptAttributes != null)
                                OptAttributes.Emit (ec, this); 
+
+                       Emit ();
                }
 
-               // TODO: caching would be usefull
-               public ObsoleteAttribute GetObsoleteAttribute (EmitContext ec)
+               public override string GetSignatureForError()
                {
-                       if (OptAttributes == null)
-                               return null;
-
-                       Attribute obsolete_attr = OptAttributes.Search (TypeManager.obsolete_attribute_type, ec);
-                       if (obsolete_attr == null)
-                               return null;
-
-                       ObsoleteAttribute obsolete = obsolete_attr.GetObsoleteAttribute (ec.DeclSpace);
-                       if (obsolete == null)
-                               return null;
-
-                       return obsolete;
+                       return String.Concat (parent_enum.GetSignatureForError (), '.', base.GetSignatureForError ());
                }
 
-               protected override string[] ValidAttributeTargets {
+               public override string[] ValidAttributeTargets {
                        get {
                                return attribute_targets;
                        }
                }
+
+               protected override bool VerifyClsCompliance(DeclSpace ds)
+               {
+                       // Because parent is TypeContainer and we have only DeclSpace parent.
+                       // Parameter replacing is required
+                       return base.VerifyClsCompliance (parent_enum);
+               }
+
+               // There is no base type
+               protected override void VerifyObsoleteAttribute()
+               {
+               }
+
+               public override string DocCommentHeader {
+                       get { return "F:"; }
+               }
        }
 
        /// <summary>
        ///   Enumeration container
        /// </summary>
        public class Enum : DeclSpace {
-               ArrayList ordered_enums;
+               public ArrayList ordered_enums;
                
                public Expression BaseType;
                
                public Type UnderlyingType;
 
                Hashtable member_to_location;
-               Hashtable member_to_attributes;
 
                //
                // This is for members that have been defined
@@ -123,9 +129,6 @@ namespace Mono.CSharp {
                Hashtable in_transit;
                
                ArrayList field_builders;
-
-
-               Hashtable name_to_member;
                
                public const int AllowedModifiers =
                        Modifiers.NEW |
@@ -134,8 +137,8 @@ namespace Mono.CSharp {
                        Modifiers.INTERNAL |
                        Modifiers.PRIVATE;
 
-               public Enum (NamespaceEntry ns, TypeContainer parent, Expression type, int mod_flags,
-                            string name, Attributes attrs, Location l)
+               public Enum (NamespaceEntry ns, TypeContainer parent, Expression type,
+                            int mod_flags, MemberName name, Attributes attrs, Location l)
                        : base (ns, parent, name, attrs, l)
                {
                        this.BaseType = type;
@@ -147,70 +150,28 @@ namespace Mono.CSharp {
                        member_to_value = new Hashtable ();
                        in_transit = new Hashtable ();
                        field_builders = new ArrayList ();
-
-                       name_to_member = new Hashtable ();
                }
 
                /// <summary>
                ///   Adds @name to the enumeration space, with @expr
                ///   being its definition.  
                /// </summary>
-               public AdditionResult AddEnumMember (string name, Expression expr, Location loc,
-                                                    Attributes opt_attrs)
+               public void AddEnumMember (string name, Expression expr, Location loc, Attributes opt_attrs, string documentation)
                {
-                       if (defined_names.Contains (name))
-                               return AdditionResult.NameExists;
-
                        if (name == "value__") {
                                Report.Error (76, loc, "An item in an enumeration can't have an identifier `value__'");
-                               return AdditionResult.Error;
+                               return;
                        }
 
-                       DefineName (name, expr);
+                       EnumMember em = new EnumMember (this, expr, name, loc, opt_attrs);
+                       em.DocComment = documentation;
+                       if (!AddToContainer (em, name))
+                               return;
+
 
+                       // TODO: can be almost deleted
                        ordered_enums.Add (name);
                        member_to_location.Add (name, loc);
-
-                       if (member_to_attributes == null)
-                               member_to_attributes = new Hashtable ();
-
-                       member_to_attributes.Add (name, opt_attrs);
-
-                       name_to_member.Add (name, new EnumMember (name, this, loc, opt_attrs));
-                       
-                       return AdditionResult.Success;
-               }
-
-               //
-               // This is used by corlib compilation: we map from our
-               // type to a type that is consumable by the DefineField
-               //
-               Type MapToInternalType (Type t)
-               {
-                       if (t == TypeManager.int32_type)
-                               return typeof (int);
-                       if (t == TypeManager.int64_type)
-                               return typeof (long);
-                       if (t == TypeManager.uint32_type)
-                               return typeof (uint);
-                       if (t == TypeManager.uint64_type)
-                               return typeof (ulong);
-                       if (t == TypeManager.float_type)
-                               return typeof (float);
-                       if (t == TypeManager.double_type)
-                               return typeof (double);
-                       if (t == TypeManager.byte_type)
-                               return typeof (byte);
-                       if (t == TypeManager.sbyte_type)
-                               return typeof (sbyte);
-                       if (t == TypeManager.char_type)
-                               return typeof (char);
-                       if (t == TypeManager.short_type)
-                               return typeof (short);
-                       if (t == TypeManager.ushort_type)
-                               return typeof (ushort);
-
-                       throw new Exception ();
                }
                
                public override TypeBuilder DefineType ()
@@ -218,9 +179,8 @@ namespace Mono.CSharp {
                        if (TypeBuilder != null)
                                return TypeBuilder;
 
-                       TypeAttributes attr = Modifiers.TypeAttr (ModFlags, IsTopLevel);
-
-                       attr |= TypeAttributes.Class | TypeAttributes.Sealed;
+                       ec = new EmitContext (this, this, Location, null, null, ModFlags, false);
+                       ec.InEnumContext = true;
 
                        if (!(BaseType is TypeLookupExpression)) {
                                Report.Error (1008, Location,
@@ -229,7 +189,8 @@ namespace Mono.CSharp {
                                return null;
                        }
 
-                       UnderlyingType = ResolveType (BaseType, false, Location);
+                       TypeExpr ute = ResolveBaseTypeExpr (BaseType, false, Location);
+                       UnderlyingType = ute.Type;
 
                        if (UnderlyingType != TypeManager.int32_type &&
                            UnderlyingType != TypeManager.uint32_type &&
@@ -252,14 +213,16 @@ namespace Mono.CSharp {
                                
                                ModuleBuilder builder = CodeGen.Module.Builder;
 
-                               TypeBuilder = builder.DefineType (Name, attr, TypeManager.enum_type);
+                               TypeBuilder = builder.DefineType (Name, TypeAttr, TypeManager.enum_type);
                        } else {
                                TypeBuilder builder = Parent.TypeBuilder;
 
                                TypeBuilder = builder.DefineNestedType (
-                                       Basename, attr, TypeManager.enum_type);
+                                       Basename, TypeAttr, TypeManager.enum_type);
                        }
 
+                       ec.ContainerType = TypeBuilder;
+
                        //
                        // Call MapToInternalType for corlib
                        //
@@ -485,19 +448,14 @@ namespace Mono.CSharp {
                        return false;
                }
 
-               //
-               // Horrible, horrible.  But there is no other way we can pass the EmitContext
-               // to the recursive definition triggered by the evaluation of a forward
-               // expression
-               //
-               static EmitContext current_ec = null;
-               
                /// <summary>
                ///  This is used to lookup the value of an enum member. If the member is undefined,
                ///  it attempts to define it and return its value
                /// </summary>
-               public object LookupEnumValue (EmitContext ec, string name, Location loc)
+               public object LookupEnumValue (string name, Location loc)
                {
+                       if (ec == null)
+                               Report.Error (-1, loc, "Enum.LookupEnumValue () called too soon");
                        
                        object default_value = null;
                        Constant c = null;
@@ -538,14 +496,7 @@ namespace Mono.CSharp {
                                                Location m_loc = (Mono.CSharp.Location)
                                                        member_to_location [n];
                                                in_transit.Add (name, true);
-
-                                               EmitContext old_ec = current_ec;
-                                               current_ec = ec;
-                       
-                                               default_value = LookupEnumValue (ec, n, m_loc);
-
-                                               current_ec = old_ec;
-                                               
+                                               default_value = LookupEnumValue (n, m_loc);
                                                in_transit.Remove (name);
                                                if (default_value == null)
                                                        return null;
@@ -555,17 +506,9 @@ namespace Mono.CSharp {
                                }
                                
                        } else {
-                               bool old = ec.InEnumContext;
-                               ec.InEnumContext = true;
                                in_transit.Add (name, true);
-
-                               EmitContext old_ec = current_ec;
-                               current_ec = ec;
-                               val = val.Resolve (ec);
-                               current_ec = old_ec;
-                               
+                               val = val.Resolve (EmitContext);
                                in_transit.Remove (name);
-                               ec.InEnumContext = old;
 
                                if (val == null)
                                        return null;
@@ -597,7 +540,7 @@ namespace Mono.CSharp {
                                }
                        }
 
-                       EnumMember em = name_to_member [name] as EnumMember;
+                       EnumMember em = (EnumMember) defined_names [name];
                        em.DefineMember (TypeBuilder);
 
                        bool fail;
@@ -630,9 +573,8 @@ namespace Mono.CSharp {
                        if (TypeBuilder == null)
                                return false;
 
-                       EmitContext ec = new EmitContext (this, this, Location, null,
-                                                         UnderlyingType, ModFlags, false);
-
+                       if (ec == null)
+                               throw new InternalErrorException ("Enum.Define () called too soon");
                        
                        object default_value = 0;
                        
@@ -647,7 +589,7 @@ namespace Mono.CSharp {
                                Location loc = (Mono.CSharp.Location) member_to_location [name];
 
                                if (this [name] != null) {
-                                       default_value = LookupEnumValue (ec, name, loc);
+                                       default_value = LookupEnumValue (name, loc);
 
                                        if (default_value == null)
                                                return true;
@@ -657,7 +599,7 @@ namespace Mono.CSharp {
                                                return false;
                                        }
 
-                                       EnumMember em = name_to_member [name] as EnumMember;
+                                       EnumMember em = (EnumMember) defined_names [name];
 
                                        em.DefineMember (TypeBuilder);
                                        FieldBuilder fb = em.builder;
@@ -691,62 +633,48 @@ namespace Mono.CSharp {
 
                public override void Emit ()
                {
-                       EmitContext ec = new EmitContext (
-                               Parent, this, Location, null, null, ModFlags, false);
-
                        if (OptAttributes != null) {
                                OptAttributes.Emit (ec, this);
                        }
 
-                       foreach (EnumMember em in name_to_member.Values) {
+                       foreach (EnumMember em in defined_names.Values) {
                                em.Emit (ec);
                        }
 
                        base.Emit ();
                }
                
-               protected override bool IsIdentifierClsCompliant (DeclSpace ds)
-               {
-                       if (!base.IsIdentifierClsCompliant (ds))
-                               return false;
-
-                       for (int i = 1; i < ordered_enums.Count; ++i) {
-                               string checked_name = ordered_enums [i] as string;
-                               for (int ii = 0; ii < ordered_enums.Count; ++ii) {
-                                       if (ii == i)
-                                               continue;
-
-                                       string enumerator_name = ordered_enums [ii] as string;
-                                       if (String.Compare (checked_name, enumerator_name, true, CultureInfo.InvariantCulture) == 0) {
-                                               Report.SymbolRelatedToPreviousError ((Location)member_to_location [enumerator_name], enumerator_name);
-                                               Report.Error_T (3005, (Location)member_to_location [checked_name], GetEnumeratorName (checked_name));
-                                               break;
-                                       }
-                               }
-                       }
-                       return true;
-               }
+               void VerifyClsName ()
+               {
+                       Hashtable ht = new Hashtable ();
+                       foreach (string name in ordered_enums) {
+                               string locase = name.ToLower (System.Globalization.CultureInfo.InvariantCulture);
+                               if (!ht.Contains (locase)) {
+                                       ht.Add (locase, defined_names [name]);
+                                       continue;
+                               }
+                               MemberCore conflict = (MemberCore)ht [locase];
+                               Report.SymbolRelatedToPreviousError (conflict);
+                               conflict = GetDefinition (name);
+                               Report.Error (3005, conflict.Location, "Identifier '{0}' differing only in case is not CLS-compliant", conflict.GetSignatureForError ());
+                       }
+               }
 
                protected override bool VerifyClsCompliance (DeclSpace ds)
                {
                        if (!base.VerifyClsCompliance (ds))
                                return false;
 
+                       VerifyClsName ();
+
                        if (!AttributeTester.IsClsCompliant (UnderlyingType)) {
-                               Report.Error_T (3009, Location, GetSignatureForError (), TypeManager.CSharpName (UnderlyingType));
+                               Report.Error (3009, Location, "'{0}': base type '{1}' is not CLS-compliant", GetSignatureForError (), TypeManager.CSharpName (UnderlyingType));
                        }
 
                        return true;
                }
                
-               /// <summary>
-               /// Returns full enum name.
-               /// </summary>
-               string GetEnumeratorName (string valueName)
-               {
-                       return String.Concat (Name, ".", valueName);
-               }
-
                //
                // IMemberFinder
                //
@@ -756,10 +684,8 @@ namespace Mono.CSharp {
                        ArrayList members = new ArrayList ();
 
                        if ((mt & MemberTypes.Field) != 0) {
-                               if (criteria is string){
-                                       if (member_to_value [criteria] == null && current_ec != null){
-                                               LookupEnumValue (current_ec, (string) criteria, Location.Null);
-                                       }
+                               if (criteria is string && member_to_value [criteria] == null) {
+                                       LookupEnumValue ((string) criteria, Location.Null);
                                }
                                
                                foreach (FieldBuilder fb in field_builders)
@@ -785,7 +711,7 @@ namespace Mono.CSharp {
                // indexer
                public Expression this [string name] {
                        get {
-                               return (Expression) defined_names [name];
+                               return ((EnumMember) defined_names [name]).Type;
                        }
                }
 
@@ -795,32 +721,34 @@ namespace Mono.CSharp {
                        }
                }
 
+               protected override TypeAttributes TypeAttr {
+                       get {
+                               return Modifiers.TypeAttr (ModFlags, IsTopLevel) |
+                               TypeAttributes.Class | TypeAttributes.Sealed |
+                               base.TypeAttr;
+                       }
+               }
+
+
                protected override void VerifyObsoleteAttribute()
                {
                        // UnderlyingType is never obsolete
                }
 
-               /// <summary>
-               /// Returns ObsoleteAttribute for both enum type and enum member
-               /// </summary>
-               public ObsoleteAttribute GetObsoleteAttribute (EmitContext ec, string identifier)
+               //
+               // Generates xml doc comments (if any), and if required,
+               // handle warning report.
+               //
+               internal override void GenerateDocComment (DeclSpace ds)
                {
-                       if ((caching_flags & Flags.Obsolete_Undetected) == 0 && (caching_flags & Flags.Obsolete) == 0) {
-                               return null;
-                       }
-
-                       ObsoleteAttribute oa = GetObsoleteAttribute (ec.DeclSpace);
-                       if (oa != null)
-                               return oa;
-
-                       EnumMember em = (EnumMember)name_to_member [identifier];
-                       oa = em.GetObsoleteAttribute (ec);
-
-                       if (oa == null)
-                               return null;
+                       DocUtil.GenerateEnumDocComment (this, ds);
+               }
 
-                       caching_flags |= Flags.Obsolete;
-                       return oa;
+               //
+               //   Represents header string for documentation comment.
+               //
+               public override string DocCommentHeader {
+                       get { return "T:"; }
                }
        }
 }