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;
26 public EnumMember (Enum parent_enum, string name, Location loc, Attributes attrs):
27 base (null, name, attrs, loc)
29 this.parent_enum = parent_enum;
32 public override void ApplyAttributeBuilder(Attribute a, CustomAttributeBuilder cb)
34 if (a.Type == TypeManager.marshal_as_attr_type) {
35 UnmanagedMarshal marshal = a.GetMarshal ();
36 if (marshal != null) {
37 builder.SetMarshal (marshal);
40 Report.Warning (-24, a.Location, "The Microsoft Runtime cannot set this marshal info. Please use the Mono runtime instead.");
44 builder.SetCustomAttribute (cb);
47 public override AttributeTargets AttributeTargets {
49 return AttributeTargets.Field;
53 public override bool IsClsCompliaceRequired (DeclSpace ds)
55 return parent_enum.IsClsCompliaceRequired (ds);
58 public void DefineMember (TypeBuilder tb)
60 FieldAttributes attr = FieldAttributes.Public | FieldAttributes.Static
61 | FieldAttributes.Literal;
63 builder = tb.DefineField (Name, tb, attr);
66 public override bool Define ()
68 throw new NotImplementedException ();
71 public void Emit (EmitContext ec)
73 if (OptAttributes != null)
74 OptAttributes.Emit (ec, this);
77 // TODO: caching would be usefull
78 public ObsoleteAttribute GetObsoleteAttribute (EmitContext ec)
80 if (OptAttributes == null)
83 Attribute obsolete_attr = OptAttributes.Search (TypeManager.obsolete_attribute_type, ec);
84 if (obsolete_attr == null)
87 ObsoleteAttribute obsolete = obsolete_attr.GetObsoleteAttribute (ec.DeclSpace);
94 public override string[] ValidAttributeTargets {
96 return attribute_targets;
100 protected override void VerifyObsoleteAttribute()
102 throw new NotImplementedException ();
108 /// Enumeration container
110 public class Enum : DeclSpace {
111 ArrayList ordered_enums;
113 public Expression BaseType;
115 public Type UnderlyingType;
117 Hashtable member_to_location;
118 Hashtable member_to_attributes;
121 // This is for members that have been defined
123 Hashtable member_to_value;
126 // This is used to mark members we're currently defining
128 Hashtable in_transit;
130 ArrayList field_builders;
133 Hashtable name_to_member;
135 public const int AllowedModifiers =
138 Modifiers.PROTECTED |
142 public Enum (NamespaceEntry ns, TypeContainer parent, Expression type, int mod_flags,
143 string name, Attributes attrs, Location l)
144 : base (ns, parent, name, attrs, l)
146 this.BaseType = type;
147 ModFlags = Modifiers.Check (AllowedModifiers, mod_flags,
148 IsTopLevel ? Modifiers.INTERNAL : Modifiers.PRIVATE, l);
150 ordered_enums = new ArrayList ();
151 member_to_location = new Hashtable ();
152 member_to_value = new Hashtable ();
153 in_transit = new Hashtable ();
154 field_builders = new ArrayList ();
156 name_to_member = new Hashtable ();
160 /// Adds @name to the enumeration space, with @expr
161 /// being its definition.
163 public AdditionResult AddEnumMember (string name, Expression expr, Location loc,
164 Attributes opt_attrs)
166 if (defined_names.Contains (name))
167 return AdditionResult.NameExists;
169 if (name == "value__") {
170 Report.Error (76, loc, "An item in an enumeration can't have an identifier `value__'");
171 return AdditionResult.Error;
174 DefineName (name, expr);
176 ordered_enums.Add (name);
177 member_to_location.Add (name, loc);
179 if (member_to_attributes == null)
180 member_to_attributes = new Hashtable ();
182 member_to_attributes.Add (name, opt_attrs);
184 name_to_member.Add (name, new EnumMember (this, name, loc, opt_attrs));
186 return AdditionResult.Success;
190 // This is used by corlib compilation: we map from our
191 // type to a type that is consumable by the DefineField
193 Type MapToInternalType (Type t)
195 if (t == TypeManager.int32_type)
197 if (t == TypeManager.int64_type)
198 return typeof (long);
199 if (t == TypeManager.uint32_type)
200 return typeof (uint);
201 if (t == TypeManager.uint64_type)
202 return typeof (ulong);
203 if (t == TypeManager.float_type)
204 return typeof (float);
205 if (t == TypeManager.double_type)
206 return typeof (double);
207 if (t == TypeManager.byte_type)
208 return typeof (byte);
209 if (t == TypeManager.sbyte_type)
210 return typeof (sbyte);
211 if (t == TypeManager.char_type)
212 return typeof (char);
213 if (t == TypeManager.short_type)
214 return typeof (short);
215 if (t == TypeManager.ushort_type)
216 return typeof (ushort);
218 throw new Exception ();
221 public override TypeBuilder DefineType ()
223 if (TypeBuilder != null)
226 TypeAttributes attr = Modifiers.TypeAttr (ModFlags, IsTopLevel);
228 attr |= TypeAttributes.Class | TypeAttributes.Sealed;
230 if (!(BaseType is TypeLookupExpression)) {
231 Report.Error (1008, Location,
232 "Type byte, sbyte, short, ushort, int, uint, " +
233 "long, or ulong expected (got: `{0}')", BaseType);
237 UnderlyingType = ResolveType (BaseType, false, Location);
239 if (UnderlyingType != TypeManager.int32_type &&
240 UnderlyingType != TypeManager.uint32_type &&
241 UnderlyingType != TypeManager.int64_type &&
242 UnderlyingType != TypeManager.uint64_type &&
243 UnderlyingType != TypeManager.short_type &&
244 UnderlyingType != TypeManager.ushort_type &&
245 UnderlyingType != TypeManager.byte_type &&
246 UnderlyingType != TypeManager.sbyte_type) {
247 Report.Error (1008, Location,
248 "Type byte, sbyte, short, ushort, int, uint, " +
249 "long, or ulong expected (got: " +
250 TypeManager.CSharpName (UnderlyingType) + ")");
255 if (TypeManager.NamespaceClash (Name, Location))
258 ModuleBuilder builder = CodeGen.Module.Builder;
260 TypeBuilder = builder.DefineType (Name, attr, TypeManager.enum_type);
262 TypeBuilder builder = Parent.TypeBuilder;
264 TypeBuilder = builder.DefineNestedType (
265 Basename, attr, TypeManager.enum_type);
269 // Call MapToInternalType for corlib
271 TypeBuilder.DefineField ("value__", UnderlyingType,
272 FieldAttributes.Public | FieldAttributes.SpecialName
273 | FieldAttributes.RTSpecialName);
275 TypeManager.AddEnumType (Name, TypeBuilder, this);
280 bool IsValidEnumConstant (Expression e)
282 if (!(e is Constant))
285 if (e is IntConstant || e is UIntConstant || e is LongConstant ||
286 e is ByteConstant || e is SByteConstant || e is ShortConstant ||
287 e is UShortConstant || e is ULongConstant || e is EnumConstant ||
294 object GetNextDefaultValue (object default_value)
296 if (UnderlyingType == TypeManager.int32_type) {
297 int i = (int) default_value;
299 if (i < System.Int32.MaxValue)
303 } else if (UnderlyingType == TypeManager.uint32_type) {
304 uint i = (uint) default_value;
306 if (i < System.UInt32.MaxValue)
310 } else if (UnderlyingType == TypeManager.int64_type) {
311 long i = (long) default_value;
313 if (i < System.Int64.MaxValue)
317 } else if (UnderlyingType == TypeManager.uint64_type) {
318 ulong i = (ulong) default_value;
320 if (i < System.UInt64.MaxValue)
324 } else if (UnderlyingType == TypeManager.short_type) {
325 short i = (short) default_value;
327 if (i < System.Int16.MaxValue)
331 } else if (UnderlyingType == TypeManager.ushort_type) {
332 ushort i = (ushort) default_value;
334 if (i < System.UInt16.MaxValue)
338 } else if (UnderlyingType == TypeManager.byte_type) {
339 byte i = (byte) default_value;
341 if (i < System.Byte.MaxValue)
345 } else if (UnderlyingType == TypeManager.sbyte_type) {
346 sbyte i = (sbyte) default_value;
348 if (i < System.SByte.MaxValue)
357 void Error_ConstantValueCannotBeConverted (object val, Location loc)
360 Report.Error (31, loc, "Constant value '" + ((Constant) val).AsString () +
361 "' cannot be converted" +
362 " to a " + TypeManager.CSharpName (UnderlyingType));
364 Report.Error (31, loc, "Constant value '" + val +
365 "' cannot be converted" +
366 " to a " + TypeManager.CSharpName (UnderlyingType));
371 /// Determines if a standard implicit conversion exists from
372 /// expr_type to target_type
374 public static bool ImplicitConversionExists (Type expr_type, Type target_type)
376 expr_type = TypeManager.TypeToCoreType (expr_type);
378 if (expr_type == TypeManager.void_type)
381 if (expr_type == target_type)
384 // First numeric conversions
386 if (expr_type == TypeManager.sbyte_type){
388 // From sbyte to short, int, long, float, double.
390 if ((target_type == TypeManager.int32_type) ||
391 (target_type == TypeManager.int64_type) ||
392 (target_type == TypeManager.double_type) ||
393 (target_type == TypeManager.float_type) ||
394 (target_type == TypeManager.short_type) ||
395 (target_type == TypeManager.decimal_type))
398 } else if (expr_type == TypeManager.byte_type){
400 // From byte to short, ushort, int, uint, long, ulong, float, double
402 if ((target_type == TypeManager.short_type) ||
403 (target_type == TypeManager.ushort_type) ||
404 (target_type == TypeManager.int32_type) ||
405 (target_type == TypeManager.uint32_type) ||
406 (target_type == TypeManager.uint64_type) ||
407 (target_type == TypeManager.int64_type) ||
408 (target_type == TypeManager.float_type) ||
409 (target_type == TypeManager.double_type) ||
410 (target_type == TypeManager.decimal_type))
413 } else if (expr_type == TypeManager.short_type){
415 // From short to int, long, float, double
417 if ((target_type == TypeManager.int32_type) ||
418 (target_type == TypeManager.int64_type) ||
419 (target_type == TypeManager.double_type) ||
420 (target_type == TypeManager.float_type) ||
421 (target_type == TypeManager.decimal_type))
424 } else if (expr_type == TypeManager.ushort_type){
426 // From ushort to int, uint, long, ulong, float, double
428 if ((target_type == TypeManager.uint32_type) ||
429 (target_type == TypeManager.uint64_type) ||
430 (target_type == TypeManager.int32_type) ||
431 (target_type == TypeManager.int64_type) ||
432 (target_type == TypeManager.double_type) ||
433 (target_type == TypeManager.float_type) ||
434 (target_type == TypeManager.decimal_type))
437 } else if (expr_type == TypeManager.int32_type){
439 // From int to long, float, double
441 if ((target_type == TypeManager.int64_type) ||
442 (target_type == TypeManager.double_type) ||
443 (target_type == TypeManager.float_type) ||
444 (target_type == TypeManager.decimal_type))
447 } else if (expr_type == TypeManager.uint32_type){
449 // From uint to long, ulong, float, double
451 if ((target_type == TypeManager.int64_type) ||
452 (target_type == TypeManager.uint64_type) ||
453 (target_type == TypeManager.double_type) ||
454 (target_type == TypeManager.float_type) ||
455 (target_type == TypeManager.decimal_type))
458 } else if ((expr_type == TypeManager.uint64_type) ||
459 (expr_type == TypeManager.int64_type)) {
461 // From long/ulong to float, double
463 if ((target_type == TypeManager.double_type) ||
464 (target_type == TypeManager.float_type) ||
465 (target_type == TypeManager.decimal_type))
468 } else if (expr_type == TypeManager.char_type){
470 // From char to ushort, int, uint, long, ulong, float, double
472 if ((target_type == TypeManager.ushort_type) ||
473 (target_type == TypeManager.int32_type) ||
474 (target_type == TypeManager.uint32_type) ||
475 (target_type == TypeManager.uint64_type) ||
476 (target_type == TypeManager.int64_type) ||
477 (target_type == TypeManager.float_type) ||
478 (target_type == TypeManager.double_type) ||
479 (target_type == TypeManager.decimal_type))
482 } else if (expr_type == TypeManager.float_type){
486 if (target_type == TypeManager.double_type)
494 // Horrible, horrible. But there is no other way we can pass the EmitContext
495 // to the recursive definition triggered by the evaluation of a forward
498 static EmitContext current_ec = null;
501 /// This is used to lookup the value of an enum member. If the member is undefined,
502 /// it attempts to define it and return its value
504 public object LookupEnumValue (EmitContext ec, string name, Location loc)
507 object default_value = null;
510 default_value = member_to_value [name];
512 if (default_value != null)
513 return default_value;
516 // This may happen if we're calling a method in System.Enum, for instance
519 if (!defined_names.Contains (name))
522 if (in_transit.Contains (name)) {
523 Report.Error (110, loc, "The evaluation of the constant value for `" +
524 Name + "." + name + "' involves a circular definition.");
529 // So if the above doesn't happen, we have a member that is undefined
530 // We now proceed to define it
532 Expression val = this [name];
536 int idx = ordered_enums.IndexOf (name);
541 for (int i = 0; i < idx; ++i) {
542 string n = (string) ordered_enums [i];
543 Location m_loc = (Mono.CSharp.Location)
544 member_to_location [n];
545 in_transit.Add (name, true);
547 EmitContext old_ec = current_ec;
550 default_value = LookupEnumValue (ec, n, m_loc);
554 in_transit.Remove (name);
555 if (default_value == null)
559 default_value = GetNextDefaultValue (default_value);
563 bool old = ec.InEnumContext;
564 ec.InEnumContext = true;
565 in_transit.Add (name, true);
567 EmitContext old_ec = current_ec;
569 val = val.Resolve (ec);
572 in_transit.Remove (name);
573 ec.InEnumContext = old;
578 if (!IsValidEnumConstant (val)) {
581 "Type byte, sbyte, short, ushort, int, uint, long, or " +
582 "ulong expected (have: " + val + ")");
587 default_value = c.GetValue ();
589 if (default_value == null) {
590 Error_ConstantValueCannotBeConverted (c, loc);
594 if (val is EnumConstant){
595 Type etype = TypeManager.EnumToUnderlying (c.Type);
597 if (!ImplicitConversionExists (etype, UnderlyingType)){
598 Convert.Error_CannotImplicitConversion (
599 loc, c.Type, UnderlyingType);
605 EnumMember em = name_to_member [name] as EnumMember;
606 em.DefineMember (TypeBuilder);
609 default_value = TypeManager.ChangeType (default_value, UnderlyingType, out fail);
611 Error_ConstantValueCannotBeConverted (c, loc);
615 em.builder.SetConstant (default_value);
616 field_builders.Add (em.builder);
617 member_to_value [name] = default_value;
619 if (!TypeManager.RegisterFieldValue (em.builder, default_value))
622 return default_value;
625 public override bool DefineMembers (TypeContainer parent)
630 public override bool Define ()
633 // If there was an error during DefineEnum, return
635 if (TypeBuilder == null)
638 EmitContext ec = new EmitContext (this, this, Location, null,
639 UnderlyingType, ModFlags, false);
642 object default_value = 0;
645 foreach (string name in ordered_enums) {
647 // Have we already been defined, thanks to some cross-referencing ?
649 if (member_to_value.Contains (name))
652 Location loc = (Mono.CSharp.Location) member_to_location [name];
654 if (this [name] != null) {
655 default_value = LookupEnumValue (ec, name, loc);
657 if (default_value == null)
660 if (name == "value__"){
661 Report.Error (76, loc, "The name `value__' is reserved for enumerations");
665 EnumMember em = name_to_member [name] as EnumMember;
667 em.DefineMember (TypeBuilder);
668 FieldBuilder fb = em.builder;
670 if (default_value == null) {
671 Report.Error (543, loc, "Enumerator value for '" + name + "' is too large to " +
677 default_value = TypeManager.ChangeType (default_value, UnderlyingType, out fail);
679 Error_ConstantValueCannotBeConverted (default_value, loc);
683 fb.SetConstant (default_value);
684 field_builders.Add (fb);
685 member_to_value [name] = default_value;
687 if (!TypeManager.RegisterFieldValue (fb, default_value))
691 default_value = GetNextDefaultValue (default_value);
697 public override void Emit ()
699 EmitContext ec = new EmitContext (
700 Parent, this, Location, null, null, ModFlags, false);
702 if (OptAttributes != null) {
703 OptAttributes.Emit (ec, this);
706 foreach (EnumMember em in name_to_member.Values) {
713 void VerifyClsName ()
715 Hashtable ht = new Hashtable ();
716 foreach (string name in ordered_enums) {
717 string locase = name.ToLower (System.Globalization.CultureInfo.InvariantCulture);
718 if (!ht.Contains (locase)) {
719 ht.Add (locase, name_to_member [name]);
723 EnumMember conflict = (EnumMember)ht [locase];
724 Report.SymbolRelatedToPreviousError (conflict);
725 conflict = (EnumMember)name_to_member [name];
726 Report.Error (3005, conflict.Location, "Identifier '{0}' differing only in case is not CLS-compliant", conflict.GetSignatureForError ());
730 protected override bool VerifyClsCompliance (DeclSpace ds)
732 if (!base.VerifyClsCompliance (ds))
737 if (!AttributeTester.IsClsCompliant (UnderlyingType)) {
738 Report.Error (3009, Location, "'{0}': base type '{1}' is not CLS-compliant", GetSignatureForError (), TypeManager.CSharpName (UnderlyingType));
745 /// Returns full enum name.
747 string GetEnumeratorName (string valueName)
749 return String.Concat (Name, ".", valueName);
755 public override MemberList FindMembers (MemberTypes mt, BindingFlags bf,
756 MemberFilter filter, object criteria)
758 ArrayList members = new ArrayList ();
760 if ((mt & MemberTypes.Field) != 0) {
761 if (criteria is string){
762 if (member_to_value [criteria] == null && current_ec != null){
763 LookupEnumValue (current_ec, (string) criteria, Location.Null);
767 foreach (FieldBuilder fb in field_builders)
768 if (filter (fb, criteria) == true)
772 return new MemberList (members);
775 public override MemberCache MemberCache {
781 public ArrayList ValueNames {
783 return ordered_enums;
788 public Expression this [string name] {
790 return (Expression) defined_names [name];
794 public override AttributeTargets AttributeTargets {
796 return AttributeTargets.Enum;
800 protected override void VerifyObsoleteAttribute()
802 // UnderlyingType is never obsolete
806 /// Returns ObsoleteAttribute for both enum type and enum member
808 public ObsoleteAttribute GetObsoleteAttribute (EmitContext ec, string identifier)
810 if ((caching_flags & Flags.Obsolete_Undetected) == 0 && (caching_flags & Flags.Obsolete) == 0) {
814 ObsoleteAttribute oa = GetObsoleteAttribute (ec.DeclSpace);
818 EnumMember em = (EnumMember)name_to_member [identifier];
819 oa = em.GetObsoleteAttribute (ec);
824 caching_flags |= Flags.Obsolete;