2 // enum.cs: Enum handling.
4 // Author: Miguel de Icaza (miguel@gnu.org)
5 // Ravi Pratap (ravi@ximian.com)
7 // Licensed under the terms of the GNU GPL
9 // (C) 2001 Ximian, Inc (http://www.ximian.com)
13 using System.Collections;
14 using System.Reflection;
15 using System.Reflection.Emit;
16 using System.Globalization;
18 namespace Mono.CSharp {
20 class EnumMember: MemberCore {
21 static string[] attribute_targets = new string [] { "field" };
24 public FieldBuilder builder;
25 internal readonly Expression Type;
27 public EnumMember (Enum parent_enum, Expression expr, string name,
28 Location loc, Attributes attrs):
29 base (null, new MemberName (name), attrs, loc)
31 this.parent_enum = parent_enum;
32 this.ModFlags = parent_enum.ModFlags;
36 public override void ApplyAttributeBuilder(Attribute a, CustomAttributeBuilder cb)
38 if (a.Type == TypeManager.marshal_as_attr_type) {
39 UnmanagedMarshal marshal = a.GetMarshal (this);
40 if (marshal != null) {
41 builder.SetMarshal (marshal);
46 if (a.Type.IsSubclassOf (TypeManager.security_attr_type)) {
47 a.Error_InvalidSecurityParent ();
51 builder.SetCustomAttribute (cb);
54 public override AttributeTargets AttributeTargets {
56 return AttributeTargets.Field;
60 public void DefineMember (TypeBuilder tb)
62 FieldAttributes attr = FieldAttributes.Public | FieldAttributes.Static
63 | FieldAttributes.Literal;
65 builder = tb.DefineField (Name, tb, attr);
68 public override bool Define ()
70 throw new NotImplementedException ();
73 public void Emit (EmitContext ec)
75 if (OptAttributes != null)
76 OptAttributes.Emit (ec, this);
81 public override string GetSignatureForError()
83 return String.Concat (parent_enum.GetSignatureForError (), '.', base.GetSignatureForError ());
86 public override string[] ValidAttributeTargets {
88 return attribute_targets;
92 protected override bool VerifyClsCompliance(DeclSpace ds)
94 // Because parent is TypeContainer and we have only DeclSpace parent.
95 // Parameter replacing is required
96 return base.VerifyClsCompliance (parent_enum);
99 // There is no base type
100 protected override void VerifyObsoleteAttribute()
104 public override string DocCommentHeader {
110 /// Enumeration container
112 public class Enum : DeclSpace {
113 public ArrayList ordered_enums;
115 public Expression BaseType;
117 public Type UnderlyingType;
119 Hashtable member_to_location;
122 // This is for members that have been defined
124 Hashtable member_to_value;
127 // This is used to mark members we're currently defining
129 Hashtable in_transit;
131 ArrayList field_builders;
133 public const int AllowedModifiers =
136 Modifiers.PROTECTED |
140 public Enum (NamespaceEntry ns, TypeContainer parent, Expression type,
141 int mod_flags, MemberName name, Attributes attrs, Location l)
142 : base (ns, parent, name, attrs, l)
144 this.BaseType = type;
145 ModFlags = Modifiers.Check (AllowedModifiers, mod_flags,
146 IsTopLevel ? Modifiers.INTERNAL : Modifiers.PRIVATE, l);
148 ordered_enums = new ArrayList ();
149 member_to_location = new Hashtable ();
150 member_to_value = new Hashtable ();
151 in_transit = new Hashtable ();
152 field_builders = new ArrayList ();
156 /// Adds @name to the enumeration space, with @expr
157 /// being its definition.
159 public void AddEnumMember (string name, Expression expr, Location loc, Attributes opt_attrs, string documentation)
161 if (name == "value__") {
162 Report.Error (76, loc, "An item in an enumeration can't have an identifier `value__'");
166 EnumMember em = new EnumMember (this, expr, name, loc, opt_attrs);
167 em.DocComment = documentation;
168 if (!AddToContainer (em, name, ""))
172 // TODO: can be almost deleted
173 ordered_enums.Add (name);
174 member_to_location.Add (name, loc);
178 // This is used by corlib compilation: we map from our
179 // type to a type that is consumable by the DefineField
181 Type MapToInternalType (Type t)
183 if (t == TypeManager.int32_type)
185 if (t == TypeManager.int64_type)
186 return typeof (long);
187 if (t == TypeManager.uint32_type)
188 return typeof (uint);
189 if (t == TypeManager.uint64_type)
190 return typeof (ulong);
191 if (t == TypeManager.float_type)
192 return typeof (float);
193 if (t == TypeManager.double_type)
194 return typeof (double);
195 if (t == TypeManager.byte_type)
196 return typeof (byte);
197 if (t == TypeManager.sbyte_type)
198 return typeof (sbyte);
199 if (t == TypeManager.char_type)
200 return typeof (char);
201 if (t == TypeManager.short_type)
202 return typeof (short);
203 if (t == TypeManager.ushort_type)
204 return typeof (ushort);
206 throw new Exception ();
209 public override TypeBuilder DefineType ()
211 if (TypeBuilder != null)
214 TypeAttributes attr = Modifiers.TypeAttr (ModFlags, IsTopLevel);
216 ec = new EmitContext (this, this, Location, null, null, ModFlags, false);
218 attr |= TypeAttributes.Class | TypeAttributes.Sealed;
220 if (!(BaseType is TypeLookupExpression)) {
221 Report.Error (1008, Location,
222 "Type byte, sbyte, short, ushort, int, uint, " +
223 "long, or ulong expected (got: `{0}')", BaseType);
227 TypeExpr ute = ResolveBaseTypeExpr (BaseType, false, Location);
228 UnderlyingType = ute.Type;
230 if (UnderlyingType != TypeManager.int32_type &&
231 UnderlyingType != TypeManager.uint32_type &&
232 UnderlyingType != TypeManager.int64_type &&
233 UnderlyingType != TypeManager.uint64_type &&
234 UnderlyingType != TypeManager.short_type &&
235 UnderlyingType != TypeManager.ushort_type &&
236 UnderlyingType != TypeManager.byte_type &&
237 UnderlyingType != TypeManager.sbyte_type) {
238 Report.Error (1008, Location,
239 "Type byte, sbyte, short, ushort, int, uint, " +
240 "long, or ulong expected (got: " +
241 TypeManager.CSharpName (UnderlyingType) + ")");
246 if (TypeManager.NamespaceClash (Name, Location))
249 ModuleBuilder builder = CodeGen.Module.Builder;
251 TypeBuilder = builder.DefineType (Name, attr, TypeManager.enum_type);
253 TypeBuilder builder = Parent.TypeBuilder;
255 TypeBuilder = builder.DefineNestedType (
256 Basename, attr, TypeManager.enum_type);
260 // Call MapToInternalType for corlib
262 TypeBuilder.DefineField ("value__", UnderlyingType,
263 FieldAttributes.Public | FieldAttributes.SpecialName
264 | FieldAttributes.RTSpecialName);
266 TypeManager.AddEnumType (Name, TypeBuilder, this);
271 bool IsValidEnumConstant (Expression e)
273 if (!(e is Constant))
276 if (e is IntConstant || e is UIntConstant || e is LongConstant ||
277 e is ByteConstant || e is SByteConstant || e is ShortConstant ||
278 e is UShortConstant || e is ULongConstant || e is EnumConstant ||
285 object GetNextDefaultValue (object default_value)
287 if (UnderlyingType == TypeManager.int32_type) {
288 int i = (int) default_value;
290 if (i < System.Int32.MaxValue)
294 } else if (UnderlyingType == TypeManager.uint32_type) {
295 uint i = (uint) default_value;
297 if (i < System.UInt32.MaxValue)
301 } else if (UnderlyingType == TypeManager.int64_type) {
302 long i = (long) default_value;
304 if (i < System.Int64.MaxValue)
308 } else if (UnderlyingType == TypeManager.uint64_type) {
309 ulong i = (ulong) default_value;
311 if (i < System.UInt64.MaxValue)
315 } else if (UnderlyingType == TypeManager.short_type) {
316 short i = (short) default_value;
318 if (i < System.Int16.MaxValue)
322 } else if (UnderlyingType == TypeManager.ushort_type) {
323 ushort i = (ushort) default_value;
325 if (i < System.UInt16.MaxValue)
329 } else if (UnderlyingType == TypeManager.byte_type) {
330 byte i = (byte) default_value;
332 if (i < System.Byte.MaxValue)
336 } else if (UnderlyingType == TypeManager.sbyte_type) {
337 sbyte i = (sbyte) default_value;
339 if (i < System.SByte.MaxValue)
348 void Error_ConstantValueCannotBeConverted (object val, Location loc)
351 Report.Error (31, loc, "Constant value '" + ((Constant) val).AsString () +
352 "' cannot be converted" +
353 " to a " + TypeManager.CSharpName (UnderlyingType));
355 Report.Error (31, loc, "Constant value '" + val +
356 "' cannot be converted" +
357 " to a " + TypeManager.CSharpName (UnderlyingType));
362 /// Determines if a standard implicit conversion exists from
363 /// expr_type to target_type
365 public static bool ImplicitConversionExists (Type expr_type, Type target_type)
367 expr_type = TypeManager.TypeToCoreType (expr_type);
369 if (expr_type == TypeManager.void_type)
372 if (expr_type == target_type)
375 // First numeric conversions
377 if (expr_type == TypeManager.sbyte_type){
379 // From sbyte to short, int, long, float, double.
381 if ((target_type == TypeManager.int32_type) ||
382 (target_type == TypeManager.int64_type) ||
383 (target_type == TypeManager.double_type) ||
384 (target_type == TypeManager.float_type) ||
385 (target_type == TypeManager.short_type) ||
386 (target_type == TypeManager.decimal_type))
389 } else if (expr_type == TypeManager.byte_type){
391 // From byte to short, ushort, int, uint, long, ulong, float, double
393 if ((target_type == TypeManager.short_type) ||
394 (target_type == TypeManager.ushort_type) ||
395 (target_type == TypeManager.int32_type) ||
396 (target_type == TypeManager.uint32_type) ||
397 (target_type == TypeManager.uint64_type) ||
398 (target_type == TypeManager.int64_type) ||
399 (target_type == TypeManager.float_type) ||
400 (target_type == TypeManager.double_type) ||
401 (target_type == TypeManager.decimal_type))
404 } else if (expr_type == TypeManager.short_type){
406 // From short to int, long, float, double
408 if ((target_type == TypeManager.int32_type) ||
409 (target_type == TypeManager.int64_type) ||
410 (target_type == TypeManager.double_type) ||
411 (target_type == TypeManager.float_type) ||
412 (target_type == TypeManager.decimal_type))
415 } else if (expr_type == TypeManager.ushort_type){
417 // From ushort to int, uint, long, ulong, float, double
419 if ((target_type == TypeManager.uint32_type) ||
420 (target_type == TypeManager.uint64_type) ||
421 (target_type == TypeManager.int32_type) ||
422 (target_type == TypeManager.int64_type) ||
423 (target_type == TypeManager.double_type) ||
424 (target_type == TypeManager.float_type) ||
425 (target_type == TypeManager.decimal_type))
428 } else if (expr_type == TypeManager.int32_type){
430 // From int to long, float, double
432 if ((target_type == TypeManager.int64_type) ||
433 (target_type == TypeManager.double_type) ||
434 (target_type == TypeManager.float_type) ||
435 (target_type == TypeManager.decimal_type))
438 } else if (expr_type == TypeManager.uint32_type){
440 // From uint to long, ulong, float, double
442 if ((target_type == TypeManager.int64_type) ||
443 (target_type == TypeManager.uint64_type) ||
444 (target_type == TypeManager.double_type) ||
445 (target_type == TypeManager.float_type) ||
446 (target_type == TypeManager.decimal_type))
449 } else if ((expr_type == TypeManager.uint64_type) ||
450 (expr_type == TypeManager.int64_type)) {
452 // From long/ulong to float, double
454 if ((target_type == TypeManager.double_type) ||
455 (target_type == TypeManager.float_type) ||
456 (target_type == TypeManager.decimal_type))
459 } else if (expr_type == TypeManager.char_type){
461 // From char to ushort, int, uint, long, ulong, float, double
463 if ((target_type == TypeManager.ushort_type) ||
464 (target_type == TypeManager.int32_type) ||
465 (target_type == TypeManager.uint32_type) ||
466 (target_type == TypeManager.uint64_type) ||
467 (target_type == TypeManager.int64_type) ||
468 (target_type == TypeManager.float_type) ||
469 (target_type == TypeManager.double_type) ||
470 (target_type == TypeManager.decimal_type))
473 } else if (expr_type == TypeManager.float_type){
477 if (target_type == TypeManager.double_type)
485 // Horrible, horrible. But there is no other way we can pass the EmitContext
486 // to the recursive definition triggered by the evaluation of a forward
489 static EmitContext current_ec = null;
492 /// This is used to lookup the value of an enum member. If the member is undefined,
493 /// it attempts to define it and return its value
495 public object LookupEnumValue (EmitContext ec, string name, Location loc)
498 object default_value = null;
501 default_value = member_to_value [name];
503 if (default_value != null)
504 return default_value;
507 // This may happen if we're calling a method in System.Enum, for instance
510 if (!defined_names.Contains (name))
513 if (in_transit.Contains (name)) {
514 Report.Error (110, loc, "The evaluation of the constant value for `" +
515 Name + "." + name + "' involves a circular definition.");
520 // So if the above doesn't happen, we have a member that is undefined
521 // We now proceed to define it
523 Expression val = this [name];
527 int idx = ordered_enums.IndexOf (name);
532 for (int i = 0; i < idx; ++i) {
533 string n = (string) ordered_enums [i];
534 Location m_loc = (Mono.CSharp.Location)
535 member_to_location [n];
536 in_transit.Add (name, true);
538 EmitContext old_ec = current_ec;
541 default_value = LookupEnumValue (ec, n, m_loc);
545 in_transit.Remove (name);
546 if (default_value == null)
550 default_value = GetNextDefaultValue (default_value);
554 bool old = ec.InEnumContext;
555 ec.InEnumContext = true;
556 in_transit.Add (name, true);
558 EmitContext old_ec = current_ec;
560 val = val.Resolve (ec);
563 in_transit.Remove (name);
564 ec.InEnumContext = old;
569 if (!IsValidEnumConstant (val)) {
572 "Type byte, sbyte, short, ushort, int, uint, long, or " +
573 "ulong expected (have: " + val + ")");
578 default_value = c.GetValue ();
580 if (default_value == null) {
581 Error_ConstantValueCannotBeConverted (c, loc);
585 if (val is EnumConstant){
586 Type etype = TypeManager.EnumToUnderlying (c.Type);
588 if (!ImplicitConversionExists (etype, UnderlyingType)){
589 Convert.Error_CannotImplicitConversion (
590 loc, c.Type, UnderlyingType);
596 EnumMember em = (EnumMember) defined_names [name];
597 em.DefineMember (TypeBuilder);
600 default_value = TypeManager.ChangeType (default_value, UnderlyingType, out fail);
602 Error_ConstantValueCannotBeConverted (c, loc);
606 em.builder.SetConstant (default_value);
607 field_builders.Add (em.builder);
608 member_to_value [name] = default_value;
610 if (!TypeManager.RegisterFieldValue (em.builder, default_value))
613 return default_value;
616 public override bool DefineMembers (TypeContainer parent)
621 public override bool Define ()
624 // If there was an error during DefineEnum, return
626 if (TypeBuilder == null)
629 ec = new EmitContext (this, this, Location, null, UnderlyingType, ModFlags, false);
631 object default_value = 0;
634 foreach (string name in ordered_enums) {
636 // Have we already been defined, thanks to some cross-referencing ?
638 if (member_to_value.Contains (name))
641 Location loc = (Mono.CSharp.Location) member_to_location [name];
643 if (this [name] != null) {
644 default_value = LookupEnumValue (ec, name, loc);
646 if (default_value == null)
649 if (name == "value__"){
650 Report.Error (76, loc, "The name `value__' is reserved for enumerations");
654 EnumMember em = (EnumMember) defined_names [name];
656 em.DefineMember (TypeBuilder);
657 FieldBuilder fb = em.builder;
659 if (default_value == null) {
660 Report.Error (543, loc, "Enumerator value for '" + name + "' is too large to " +
666 default_value = TypeManager.ChangeType (default_value, UnderlyingType, out fail);
668 Error_ConstantValueCannotBeConverted (default_value, loc);
672 fb.SetConstant (default_value);
673 field_builders.Add (fb);
674 member_to_value [name] = default_value;
676 if (!TypeManager.RegisterFieldValue (fb, default_value))
680 default_value = GetNextDefaultValue (default_value);
686 public override void Emit ()
688 if (OptAttributes != null) {
689 OptAttributes.Emit (ec, this);
692 foreach (EnumMember em in defined_names.Values) {
699 void VerifyClsName ()
701 Hashtable ht = new Hashtable ();
702 foreach (string name in ordered_enums) {
703 string locase = name.ToLower (System.Globalization.CultureInfo.InvariantCulture);
704 if (!ht.Contains (locase)) {
705 ht.Add (locase, defined_names [name]);
709 MemberCore conflict = (MemberCore)ht [locase];
710 Report.SymbolRelatedToPreviousError (conflict);
711 conflict = GetDefinition (name);
712 Report.Error (3005, conflict.Location, "Identifier '{0}' differing only in case is not CLS-compliant", conflict.GetSignatureForError ());
716 protected override bool VerifyClsCompliance (DeclSpace ds)
718 if (!base.VerifyClsCompliance (ds))
723 if (!AttributeTester.IsClsCompliant (UnderlyingType)) {
724 Report.Error (3009, Location, "'{0}': base type '{1}' is not CLS-compliant", GetSignatureForError (), TypeManager.CSharpName (UnderlyingType));
731 /// Returns full enum name.
733 string GetEnumeratorName (string valueName)
735 return String.Concat (Name, ".", valueName);
741 public override MemberList FindMembers (MemberTypes mt, BindingFlags bf,
742 MemberFilter filter, object criteria)
744 ArrayList members = new ArrayList ();
746 if ((mt & MemberTypes.Field) != 0) {
747 if (criteria is string){
748 if (member_to_value [criteria] == null && current_ec != null){
749 LookupEnumValue (current_ec, (string) criteria, Location.Null);
753 foreach (FieldBuilder fb in field_builders)
754 if (filter (fb, criteria) == true)
758 return new MemberList (members);
761 public override MemberCache MemberCache {
767 public ArrayList ValueNames {
769 return ordered_enums;
774 public Expression this [string name] {
776 return ((EnumMember) defined_names [name]).Type;
780 public override AttributeTargets AttributeTargets {
782 return AttributeTargets.Enum;
786 protected override void VerifyObsoleteAttribute()
788 // UnderlyingType is never obsolete
792 // Generates xml doc comments (if any), and if required,
793 // handle warning report.
795 internal override void GenerateDocComment (DeclSpace ds)
797 DocUtil.GenerateEnumDocComment (this, ds);
801 // Represents header string for documentation comment.
803 public override string DocCommentHeader {