2 // enum.cs: Enum handling.
4 // Author: Miguel de Icaza (miguel@gnu.org)
5 // Ravi Pratap (ravi@ximian.com)
6 // Marek Safar (marek.safar@seznam.cz)
8 // Licensed under the terms of the GNU GPL
10 // (C) 2001 Ximian, Inc (http://www.ximian.com)
14 using System.Collections;
15 using System.Collections.Specialized;
16 using System.Reflection;
17 using System.Reflection.Emit;
18 using System.Globalization;
20 namespace Mono.CSharp {
22 public class EnumMember : MemberCore, IConstant {
23 static string[] attribute_targets = new string [] { "field" };
25 public FieldBuilder builder;
27 readonly Enum parent_enum;
28 readonly Expression ValueExpr;
29 readonly EnumMember prev_member;
34 // TODO: remove or simplify
37 public EnumMember (Enum parent_enum, EnumMember prev_member, Expression expr,
38 MemberName name, Attributes attrs):
39 base (parent_enum, name, attrs)
41 this.parent_enum = parent_enum;
42 this.ModFlags = parent_enum.ModFlags;
43 this.ValueExpr = expr;
44 this.prev_member = prev_member;
46 ec = new EmitContext (this, parent_enum, parent_enum, Location, null, null, ModFlags, false);
47 ec.InEnumContext = true;
50 public override void ApplyAttributeBuilder (Attribute a, CustomAttributeBuilder cb)
52 if (a.Type == TypeManager.marshal_as_attr_type) {
53 UnmanagedMarshal marshal = a.GetMarshal (this);
54 if (marshal != null) {
55 builder.SetMarshal (marshal);
60 if (a.Type.IsSubclassOf (TypeManager.security_attr_type)) {
61 a.Error_InvalidSecurityParent ();
65 builder.SetCustomAttribute (cb);
68 public override AttributeTargets AttributeTargets {
70 return AttributeTargets.Field;
74 bool IsValidEnumType (Type t)
76 return (t == TypeManager.int32_type || t == TypeManager.uint32_type || t == TypeManager.int64_type ||
77 t == TypeManager.byte_type || t == TypeManager.sbyte_type || t == TypeManager.short_type ||
78 t == TypeManager.ushort_type || t == TypeManager.uint64_type || t == TypeManager.char_type ||
82 public override bool Define ()
84 const FieldAttributes attr = FieldAttributes.Public | FieldAttributes.Static | FieldAttributes.Literal;
85 TypeBuilder tb = parent_enum.TypeBuilder;
86 builder = tb.DefineField (Name, tb, attr);
87 ec.ContainerType = tb;
89 TypeManager.RegisterConstant (builder, this);
93 // Because parent is TypeContainer and we have DeclSpace only
94 public override void CheckObsoleteness (Location loc)
96 parent_enum.CheckObsoleteness (loc);
98 ObsoleteAttribute oa = GetObsoleteAttribute ();
103 AttributeTester.Report_ObsoleteMessage (oa, GetSignatureForError (), loc);
106 public bool ResolveValue ()
112 // suppress cyclic errors
113 value = new EnumConstant (New.Constantify (parent_enum.UnderlyingType), parent_enum.TypeBuilder);
114 Const.Error_CyclicDeclaration (this);
118 if (ValueExpr != null) {
120 Constant c = ValueExpr.ResolveAsConstant (ec, this);
126 if (c is EnumConstant)
127 c = ((EnumConstant)c).Child;
129 c = c.ToType (parent_enum.UnderlyingType, Location);
133 if (!IsValidEnumType (c.Type)) {
134 Report.Error (1008, Location, "Type byte, sbyte, short, ushort, int, uint, long or ulong expected");
139 value = new EnumConstant (c, parent_enum.TypeBuilder);
143 if (prev_member == null) {
144 value = new EnumConstant (New.Constantify (parent_enum.UnderlyingType), parent_enum.TypeBuilder);
148 if (!prev_member.ResolveValue ())
154 value = prev_member.value.Increment ();
156 catch (OverflowException) {
157 Report.Error (543, Location, "The enumerator value `{0}' is too large to fit in its type `{1}'",
158 GetSignatureForError (), TypeManager.CSharpName (parent_enum.UnderlyingType));
166 public override void Emit ()
168 if (OptAttributes != null)
169 OptAttributes.Emit ();
171 if (!ResolveValue ())
174 builder.SetConstant (value.GetValue ());
178 public override string GetSignatureForError()
180 return String.Concat (parent_enum.GetSignatureForError (), '.', Name);
183 public override string[] ValidAttributeTargets {
185 return attribute_targets;
189 public override string DocCommentHeader {
193 #region IConstant Members
195 public Constant Value {
205 /// Enumeration container
207 public class Enum : DeclSpace {
209 public Type UnderlyingType;
211 static MemberList no_list = new MemberList (new object[0]);
213 public const int AllowedModifiers =
216 Modifiers.PROTECTED |
220 public Enum (NamespaceEntry ns, TypeContainer parent, Expression type,
221 int mod_flags, MemberName name, Attributes attrs)
222 : base (ns, parent, name, attrs)
224 this.BaseType = type;
225 ModFlags = Modifiers.Check (AllowedModifiers, mod_flags,
226 IsTopLevel ? Modifiers.INTERNAL : Modifiers.PRIVATE, name.Location);
229 public void AddEnumMember (EnumMember em)
231 if (em.Name == "value__") {
232 Report.Error (76, em.Location, "An item in an enumeration cannot have an identifier `value__'");
236 if (!AddToContainer (em, em.Name))
240 public override TypeBuilder DefineType ()
242 if (TypeBuilder != null)
245 if (!(BaseType is TypeLookupExpression)) {
246 Report.Error (1008, Location,
247 "Type byte, sbyte, short, ushort, int, uint, long or ulong expected");
251 TypeExpr ute = BaseType.ResolveAsTypeTerminal (this, false);
252 UnderlyingType = ute.Type;
254 if (UnderlyingType != TypeManager.int32_type &&
255 UnderlyingType != TypeManager.uint32_type &&
256 UnderlyingType != TypeManager.int64_type &&
257 UnderlyingType != TypeManager.uint64_type &&
258 UnderlyingType != TypeManager.short_type &&
259 UnderlyingType != TypeManager.ushort_type &&
260 UnderlyingType != TypeManager.byte_type &&
261 UnderlyingType != TypeManager.sbyte_type) {
262 Report.Error (1008, Location,
263 "Type byte, sbyte, short, ushort, int, uint, long or ulong expected");
268 if (TypeManager.NamespaceClash (Name, Location))
271 ModuleBuilder builder = CodeGen.Module.Builder;
273 TypeBuilder = builder.DefineType (Name, TypeAttr, TypeManager.enum_type);
275 TypeBuilder builder = Parent.TypeBuilder;
277 TypeBuilder = builder.DefineNestedType (
278 Basename, TypeAttr, TypeManager.enum_type);
282 // Call MapToInternalType for corlib
284 TypeBuilder.DefineField ("value__", UnderlyingType,
285 FieldAttributes.Public | FieldAttributes.SpecialName
286 | FieldAttributes.RTSpecialName);
288 TypeManager.AddUserType (this);
290 foreach (EnumMember em in defined_names.Values) {
298 public override bool Define ()
303 public override void Emit ()
305 if (OptAttributes != null) {
306 OptAttributes.Emit ();
309 foreach (EnumMember em in defined_names.Values) {
319 public override MemberList FindMembers (MemberTypes mt, BindingFlags bf,
320 MemberFilter filter, object criteria)
322 if ((mt & MemberTypes.Field) == 0)
325 EnumMember em = defined_names [criteria] as EnumMember;
329 FieldBuilder[] fb = new FieldBuilder[] { em.builder };
330 return new MemberList (fb);
333 void VerifyClsName ()
335 HybridDictionary dict = new HybridDictionary (defined_names.Count, true);
336 foreach (EnumMember em in defined_names.Values) {
337 if (!em.IsClsComplianceRequired ())
341 dict.Add (em.Name, em);
343 catch (ArgumentException) {
344 Report.SymbolRelatedToPreviousError (em);
345 MemberCore col = (MemberCore)dict [em.Name];
346 Report.Error (3005, col.Location, "Identifier `{0}' differing only in case is not CLS-compliant", col.GetSignatureForError ());
351 protected override bool VerifyClsCompliance ()
353 if (!base.VerifyClsCompliance ())
358 if (UnderlyingType == TypeManager.uint32_type ||
359 UnderlyingType == TypeManager.uint64_type ||
360 UnderlyingType == TypeManager.ushort_type) {
361 Report.Error (3009, Location, "`{0}': base type `{1}' is not CLS-compliant", GetSignatureForError (), TypeManager.CSharpName (UnderlyingType));
368 public override MemberCache MemberCache {
374 public override AttributeTargets AttributeTargets {
376 return AttributeTargets.Enum;
380 protected override TypeAttributes TypeAttr {
382 return Modifiers.TypeAttr (ModFlags, IsTopLevel) |
383 TypeAttributes.Class | TypeAttributes.Sealed |
389 // Generates xml doc comments (if any), and if required,
390 // handle warning report.
392 internal override void GenerateDocComment (DeclSpace ds)
394 base.GenerateDocComment (ds);
396 foreach (EnumMember em in defined_names.Values) {
397 em.GenerateDocComment (this);
402 // Represents header string for documentation comment.
404 public override string DocCommentHeader {