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 // Maybe can be usefull to derive from MemberCore
21 class EnumMember: Attributable {
26 static string[] attribute_targets = new string [] { "field" };
28 public FieldBuilder builder;
30 public EnumMember (string name, Enum parent, Location loc, Attributes attrs):
38 public override void ApplyAttributeBuilder(Attribute a, CustomAttributeBuilder cb)
40 if (a.Type == TypeManager.marshal_as_attr_type) {
41 UnmanagedMarshal marshal = a.GetMarshal ();
42 if (marshal != null) {
43 builder.SetMarshal (marshal);
46 Report.Warning_T (-24, a.Location);
50 builder.SetCustomAttribute (cb);
53 public override AttributeTargets AttributeTargets {
55 return AttributeTargets.Field;
59 public override bool IsClsCompliaceRequired(DeclSpace ds)
61 return parent.IsClsCompliaceRequired (ds);
64 public void DefineMember (TypeBuilder tb)
66 FieldAttributes attr = FieldAttributes.Public | FieldAttributes.Static
67 | FieldAttributes.Literal;
69 builder = tb.DefineField (name, tb, attr);
72 public void Emit (EmitContext ec)
74 if (OptAttributes != null)
75 OptAttributes.Emit (ec, this);
78 // TODO: caching would be usefull
79 public ObsoleteAttribute GetObsoleteAttribute (EmitContext ec)
81 if (OptAttributes == null)
84 Attribute obsolete_attr = OptAttributes.Search (TypeManager.obsolete_attribute_type, ec);
85 if (obsolete_attr == null)
88 ObsoleteAttribute obsolete = obsolete_attr.GetObsoleteAttribute (ec.DeclSpace);
95 protected override string[] ValidAttributeTargets {
97 return attribute_targets;
103 /// Enumeration container
105 public class Enum : DeclSpace {
106 ArrayList ordered_enums;
108 public Expression BaseType;
110 public Type UnderlyingType;
112 Hashtable member_to_location;
113 Hashtable member_to_attributes;
116 // This is for members that have been defined
118 Hashtable member_to_value;
121 // This is used to mark members we're currently defining
123 Hashtable in_transit;
125 ArrayList field_builders;
128 Hashtable name_to_member;
130 public const int AllowedModifiers =
133 Modifiers.PROTECTED |
137 public Enum (NamespaceEntry ns, TypeContainer parent, Expression type,
138 int mod_flags, MemberName name, Attributes attrs, Location l)
139 : base (ns, parent, name, attrs, l)
141 this.BaseType = type;
142 ModFlags = Modifiers.Check (AllowedModifiers, mod_flags,
143 IsTopLevel ? Modifiers.INTERNAL : Modifiers.PRIVATE, l);
145 ordered_enums = new ArrayList ();
146 member_to_location = new Hashtable ();
147 member_to_value = new Hashtable ();
148 in_transit = new Hashtable ();
149 field_builders = new ArrayList ();
151 name_to_member = new Hashtable ();
155 /// Adds @name to the enumeration space, with @expr
156 /// being its definition.
158 public AdditionResult AddEnumMember (string name, Expression expr, Location loc,
159 Attributes opt_attrs)
161 if (defined_names.Contains (name))
162 return AdditionResult.NameExists;
164 if (name == "value__") {
165 Report.Error (76, loc, "An item in an enumeration can't have an identifier `value__'");
166 return AdditionResult.Error;
169 DefineName (name, expr);
171 ordered_enums.Add (name);
172 member_to_location.Add (name, loc);
174 if (member_to_attributes == null)
175 member_to_attributes = new Hashtable ();
177 member_to_attributes.Add (name, opt_attrs);
179 name_to_member.Add (name, new EnumMember (name, this, loc, opt_attrs));
181 return AdditionResult.Success;
185 // This is used by corlib compilation: we map from our
186 // type to a type that is consumable by the DefineField
188 Type MapToInternalType (Type t)
190 if (t == TypeManager.int32_type)
192 if (t == TypeManager.int64_type)
193 return typeof (long);
194 if (t == TypeManager.uint32_type)
195 return typeof (uint);
196 if (t == TypeManager.uint64_type)
197 return typeof (ulong);
198 if (t == TypeManager.float_type)
199 return typeof (float);
200 if (t == TypeManager.double_type)
201 return typeof (double);
202 if (t == TypeManager.byte_type)
203 return typeof (byte);
204 if (t == TypeManager.sbyte_type)
205 return typeof (sbyte);
206 if (t == TypeManager.char_type)
207 return typeof (char);
208 if (t == TypeManager.short_type)
209 return typeof (short);
210 if (t == TypeManager.ushort_type)
211 return typeof (ushort);
213 throw new Exception ();
216 public override TypeBuilder DefineType ()
218 if (TypeBuilder != null)
221 TypeAttributes attr = Modifiers.TypeAttr (ModFlags, IsTopLevel);
223 attr |= TypeAttributes.Class | TypeAttributes.Sealed;
225 if (!(BaseType is TypeLookupExpression)) {
226 Report.Error (1008, Location,
227 "Type byte, sbyte, short, ushort, int, uint, " +
228 "long, or ulong expected (got: `{0}')", BaseType);
232 UnderlyingType = ResolveType (BaseType, false, Location);
234 if (UnderlyingType != TypeManager.int32_type &&
235 UnderlyingType != TypeManager.uint32_type &&
236 UnderlyingType != TypeManager.int64_type &&
237 UnderlyingType != TypeManager.uint64_type &&
238 UnderlyingType != TypeManager.short_type &&
239 UnderlyingType != TypeManager.ushort_type &&
240 UnderlyingType != TypeManager.byte_type &&
241 UnderlyingType != TypeManager.sbyte_type) {
242 Report.Error (1008, Location,
243 "Type byte, sbyte, short, ushort, int, uint, " +
244 "long, or ulong expected (got: " +
245 TypeManager.CSharpName (UnderlyingType) + ")");
250 if (TypeManager.NamespaceClash (Name, Location))
253 ModuleBuilder builder = CodeGen.Module.Builder;
255 TypeBuilder = builder.DefineType (Name, attr, TypeManager.enum_type);
257 TypeBuilder builder = Parent.TypeBuilder;
259 TypeBuilder = builder.DefineNestedType (
260 Basename, attr, TypeManager.enum_type);
264 // Call MapToInternalType for corlib
266 TypeBuilder.DefineField ("value__", UnderlyingType,
267 FieldAttributes.Public | FieldAttributes.SpecialName
268 | FieldAttributes.RTSpecialName);
270 TypeManager.AddEnumType (Name, TypeBuilder, this);
275 bool IsValidEnumConstant (Expression e)
277 if (!(e is Constant))
280 if (e is IntConstant || e is UIntConstant || e is LongConstant ||
281 e is ByteConstant || e is SByteConstant || e is ShortConstant ||
282 e is UShortConstant || e is ULongConstant || e is EnumConstant ||
289 object GetNextDefaultValue (object default_value)
291 if (UnderlyingType == TypeManager.int32_type) {
292 int i = (int) default_value;
294 if (i < System.Int32.MaxValue)
298 } else if (UnderlyingType == TypeManager.uint32_type) {
299 uint i = (uint) default_value;
301 if (i < System.UInt32.MaxValue)
305 } else if (UnderlyingType == TypeManager.int64_type) {
306 long i = (long) default_value;
308 if (i < System.Int64.MaxValue)
312 } else if (UnderlyingType == TypeManager.uint64_type) {
313 ulong i = (ulong) default_value;
315 if (i < System.UInt64.MaxValue)
319 } else if (UnderlyingType == TypeManager.short_type) {
320 short i = (short) default_value;
322 if (i < System.Int16.MaxValue)
326 } else if (UnderlyingType == TypeManager.ushort_type) {
327 ushort i = (ushort) default_value;
329 if (i < System.UInt16.MaxValue)
333 } else if (UnderlyingType == TypeManager.byte_type) {
334 byte i = (byte) default_value;
336 if (i < System.Byte.MaxValue)
340 } else if (UnderlyingType == TypeManager.sbyte_type) {
341 sbyte i = (sbyte) default_value;
343 if (i < System.SByte.MaxValue)
352 void Error_ConstantValueCannotBeConverted (object val, Location loc)
355 Report.Error (31, loc, "Constant value '" + ((Constant) val).AsString () +
356 "' cannot be converted" +
357 " to a " + TypeManager.CSharpName (UnderlyingType));
359 Report.Error (31, loc, "Constant value '" + val +
360 "' cannot be converted" +
361 " to a " + TypeManager.CSharpName (UnderlyingType));
366 /// Determines if a standard implicit conversion exists from
367 /// expr_type to target_type
369 public static bool ImplicitConversionExists (Type expr_type, Type target_type)
371 expr_type = TypeManager.TypeToCoreType (expr_type);
373 if (expr_type == TypeManager.void_type)
376 if (expr_type == target_type)
379 // First numeric conversions
381 if (expr_type == TypeManager.sbyte_type){
383 // From sbyte to short, int, long, float, double.
385 if ((target_type == TypeManager.int32_type) ||
386 (target_type == TypeManager.int64_type) ||
387 (target_type == TypeManager.double_type) ||
388 (target_type == TypeManager.float_type) ||
389 (target_type == TypeManager.short_type) ||
390 (target_type == TypeManager.decimal_type))
393 } else if (expr_type == TypeManager.byte_type){
395 // From byte to short, ushort, int, uint, long, ulong, float, double
397 if ((target_type == TypeManager.short_type) ||
398 (target_type == TypeManager.ushort_type) ||
399 (target_type == TypeManager.int32_type) ||
400 (target_type == TypeManager.uint32_type) ||
401 (target_type == TypeManager.uint64_type) ||
402 (target_type == TypeManager.int64_type) ||
403 (target_type == TypeManager.float_type) ||
404 (target_type == TypeManager.double_type) ||
405 (target_type == TypeManager.decimal_type))
408 } else if (expr_type == TypeManager.short_type){
410 // From short to int, long, float, double
412 if ((target_type == TypeManager.int32_type) ||
413 (target_type == TypeManager.int64_type) ||
414 (target_type == TypeManager.double_type) ||
415 (target_type == TypeManager.float_type) ||
416 (target_type == TypeManager.decimal_type))
419 } else if (expr_type == TypeManager.ushort_type){
421 // From ushort to int, uint, long, ulong, float, double
423 if ((target_type == TypeManager.uint32_type) ||
424 (target_type == TypeManager.uint64_type) ||
425 (target_type == TypeManager.int32_type) ||
426 (target_type == TypeManager.int64_type) ||
427 (target_type == TypeManager.double_type) ||
428 (target_type == TypeManager.float_type) ||
429 (target_type == TypeManager.decimal_type))
432 } else if (expr_type == TypeManager.int32_type){
434 // From int to long, float, double
436 if ((target_type == TypeManager.int64_type) ||
437 (target_type == TypeManager.double_type) ||
438 (target_type == TypeManager.float_type) ||
439 (target_type == TypeManager.decimal_type))
442 } else if (expr_type == TypeManager.uint32_type){
444 // From uint to long, ulong, float, double
446 if ((target_type == TypeManager.int64_type) ||
447 (target_type == TypeManager.uint64_type) ||
448 (target_type == TypeManager.double_type) ||
449 (target_type == TypeManager.float_type) ||
450 (target_type == TypeManager.decimal_type))
453 } else if ((expr_type == TypeManager.uint64_type) ||
454 (expr_type == TypeManager.int64_type)) {
456 // From long/ulong to float, double
458 if ((target_type == TypeManager.double_type) ||
459 (target_type == TypeManager.float_type) ||
460 (target_type == TypeManager.decimal_type))
463 } else if (expr_type == TypeManager.char_type){
465 // From char to ushort, int, uint, long, ulong, float, double
467 if ((target_type == TypeManager.ushort_type) ||
468 (target_type == TypeManager.int32_type) ||
469 (target_type == TypeManager.uint32_type) ||
470 (target_type == TypeManager.uint64_type) ||
471 (target_type == TypeManager.int64_type) ||
472 (target_type == TypeManager.float_type) ||
473 (target_type == TypeManager.double_type) ||
474 (target_type == TypeManager.decimal_type))
477 } else if (expr_type == TypeManager.float_type){
481 if (target_type == TypeManager.double_type)
489 // Horrible, horrible. But there is no other way we can pass the EmitContext
490 // to the recursive definition triggered by the evaluation of a forward
493 static EmitContext current_ec = null;
496 /// This is used to lookup the value of an enum member. If the member is undefined,
497 /// it attempts to define it and return its value
499 public object LookupEnumValue (EmitContext ec, string name, Location loc)
502 object default_value = null;
505 default_value = member_to_value [name];
507 if (default_value != null)
508 return default_value;
511 // This may happen if we're calling a method in System.Enum, for instance
514 if (!defined_names.Contains (name))
517 if (in_transit.Contains (name)) {
518 Report.Error (110, loc, "The evaluation of the constant value for `" +
519 Name + "." + name + "' involves a circular definition.");
524 // So if the above doesn't happen, we have a member that is undefined
525 // We now proceed to define it
527 Expression val = this [name];
531 int idx = ordered_enums.IndexOf (name);
536 for (int i = 0; i < idx; ++i) {
537 string n = (string) ordered_enums [i];
538 Location m_loc = (Mono.CSharp.Location)
539 member_to_location [n];
540 in_transit.Add (name, true);
542 EmitContext old_ec = current_ec;
545 default_value = LookupEnumValue (ec, n, m_loc);
549 in_transit.Remove (name);
550 if (default_value == null)
554 default_value = GetNextDefaultValue (default_value);
558 bool old = ec.InEnumContext;
559 ec.InEnumContext = true;
560 in_transit.Add (name, true);
562 EmitContext old_ec = current_ec;
564 val = val.Resolve (ec);
567 in_transit.Remove (name);
568 ec.InEnumContext = old;
573 if (!IsValidEnumConstant (val)) {
576 "Type byte, sbyte, short, ushort, int, uint, long, or " +
577 "ulong expected (have: " + val + ")");
582 default_value = c.GetValue ();
584 if (default_value == null) {
585 Error_ConstantValueCannotBeConverted (c, loc);
589 if (val is EnumConstant){
590 Type etype = TypeManager.EnumToUnderlying (c.Type);
592 if (!ImplicitConversionExists (etype, UnderlyingType)){
593 Convert.Error_CannotImplicitConversion (
594 loc, c.Type, UnderlyingType);
600 EnumMember em = name_to_member [name] as EnumMember;
601 em.DefineMember (TypeBuilder);
604 default_value = TypeManager.ChangeType (default_value, UnderlyingType, out fail);
606 Error_ConstantValueCannotBeConverted (c, loc);
610 em.builder.SetConstant (default_value);
611 field_builders.Add (em.builder);
612 member_to_value [name] = default_value;
614 if (!TypeManager.RegisterFieldValue (em.builder, default_value))
617 return default_value;
620 public override bool DefineMembers (TypeContainer parent)
625 public override bool Define (TypeContainer parent)
628 // If there was an error during DefineEnum, return
630 if (TypeBuilder == null)
633 EmitContext ec = new EmitContext (this, this, Location, null,
634 UnderlyingType, ModFlags, false);
637 object default_value = 0;
640 foreach (string name in ordered_enums) {
642 // Have we already been defined, thanks to some cross-referencing ?
644 if (member_to_value.Contains (name))
647 Location loc = (Mono.CSharp.Location) member_to_location [name];
649 if (this [name] != null) {
650 default_value = LookupEnumValue (ec, name, loc);
652 if (default_value == null)
655 if (name == "value__"){
656 Report.Error (76, loc, "The name `value__' is reserved for enumerations");
660 EnumMember em = name_to_member [name] as EnumMember;
662 em.DefineMember (TypeBuilder);
663 FieldBuilder fb = em.builder;
665 if (default_value == null) {
666 Report.Error (543, loc, "Enumerator value for '" + name + "' is too large to " +
672 default_value = TypeManager.ChangeType (default_value, UnderlyingType, out fail);
674 Error_ConstantValueCannotBeConverted (default_value, loc);
678 fb.SetConstant (default_value);
679 field_builders.Add (fb);
680 member_to_value [name] = default_value;
682 if (!TypeManager.RegisterFieldValue (fb, default_value))
686 default_value = GetNextDefaultValue (default_value);
691 public override void Emit (TypeContainer tc)
693 EmitContext ec = new EmitContext (tc, this, Location, null, null, ModFlags, false);
695 if (OptAttributes != null) {
696 OptAttributes.Emit (ec, this);
699 foreach (EnumMember em in name_to_member.Values) {
706 protected override bool IsIdentifierClsCompliant (DeclSpace ds)
708 if (!base.IsIdentifierClsCompliant (ds))
711 for (int i = 1; i < ordered_enums.Count; ++i) {
712 string checked_name = ordered_enums [i] as string;
713 for (int ii = 0; ii < ordered_enums.Count; ++ii) {
717 string enumerator_name = ordered_enums [ii] as string;
718 if (String.Compare (checked_name, enumerator_name, true, CultureInfo.InvariantCulture) == 0) {
719 Report.SymbolRelatedToPreviousError ((Location)member_to_location [enumerator_name], enumerator_name);
720 Report.Error_T (3005, (Location)member_to_location [checked_name], GetEnumeratorName (checked_name));
728 protected override bool VerifyClsCompliance (DeclSpace ds)
730 if (!base.VerifyClsCompliance (ds))
733 if (!AttributeTester.IsClsCompliant (UnderlyingType)) {
734 Report.Error_T (3009, Location, GetSignatureForError (), TypeManager.CSharpName (UnderlyingType));
741 /// Returns full enum name.
743 string GetEnumeratorName (string valueName)
745 return String.Concat (Name, ".", valueName);
751 public override MemberList FindMembers (MemberTypes mt, BindingFlags bf,
752 MemberFilter filter, object criteria)
754 ArrayList members = new ArrayList ();
756 if ((mt & MemberTypes.Field) != 0) {
757 if (criteria is string){
758 if (member_to_value [criteria] == null && current_ec != null){
759 LookupEnumValue (current_ec, (string) criteria, Location.Null);
763 foreach (FieldBuilder fb in field_builders)
764 if (filter (fb, criteria) == true)
768 return new MemberList (members);
771 public override MemberCache MemberCache {
777 public ArrayList ValueNames {
779 return ordered_enums;
784 public Expression this [string name] {
786 return (Expression) defined_names [name];
790 public override AttributeTargets AttributeTargets {
792 return AttributeTargets.Enum;
796 protected override void VerifyObsoleteAttribute()
798 // UnderlyingType is never obsolete
802 /// Returns ObsoleteAttribute for both enum type and enum member
804 public ObsoleteAttribute GetObsoleteAttribute (EmitContext ec, string identifier)
806 if ((caching_flags & Flags.Obsolete_Undetected) == 0 && (caching_flags & Flags.Obsolete) == 0) {
810 ObsoleteAttribute oa = GetObsoleteAttribute (ec.DeclSpace);
814 EnumMember em = (EnumMember)name_to_member [identifier];
815 oa = em.GetObsoleteAttribute (ec);
820 caching_flags |= Flags.Obsolete;