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, false, 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 UnderlyingType = ResolveType (BaseType, false, Location);
229 if (UnderlyingType != TypeManager.int32_type &&
230 UnderlyingType != TypeManager.uint32_type &&
231 UnderlyingType != TypeManager.int64_type &&
232 UnderlyingType != TypeManager.uint64_type &&
233 UnderlyingType != TypeManager.short_type &&
234 UnderlyingType != TypeManager.ushort_type &&
235 UnderlyingType != TypeManager.byte_type &&
236 UnderlyingType != TypeManager.sbyte_type) {
237 Report.Error (1008, Location,
238 "Type byte, sbyte, short, ushort, int, uint, " +
239 "long, or ulong expected (got: " +
240 TypeManager.CSharpName (UnderlyingType) + ")");
245 if (TypeManager.NamespaceClash (Name, Location))
248 ModuleBuilder builder = CodeGen.Module.Builder;
250 TypeBuilder = builder.DefineType (Name, attr, TypeManager.enum_type);
252 TypeBuilder builder = Parent.TypeBuilder;
254 TypeBuilder = builder.DefineNestedType (
255 Basename, attr, TypeManager.enum_type);
259 // Call MapToInternalType for corlib
261 TypeBuilder.DefineField ("value__", UnderlyingType,
262 FieldAttributes.Public | FieldAttributes.SpecialName
263 | FieldAttributes.RTSpecialName);
265 TypeManager.AddEnumType (Name, TypeBuilder, this);
270 bool IsValidEnumConstant (Expression e)
272 if (!(e is Constant))
275 if (e is IntConstant || e is UIntConstant || e is LongConstant ||
276 e is ByteConstant || e is SByteConstant || e is ShortConstant ||
277 e is UShortConstant || e is ULongConstant || e is EnumConstant ||
284 object GetNextDefaultValue (object default_value)
286 if (UnderlyingType == TypeManager.int32_type) {
287 int i = (int) default_value;
289 if (i < System.Int32.MaxValue)
293 } else if (UnderlyingType == TypeManager.uint32_type) {
294 uint i = (uint) default_value;
296 if (i < System.UInt32.MaxValue)
300 } else if (UnderlyingType == TypeManager.int64_type) {
301 long i = (long) default_value;
303 if (i < System.Int64.MaxValue)
307 } else if (UnderlyingType == TypeManager.uint64_type) {
308 ulong i = (ulong) default_value;
310 if (i < System.UInt64.MaxValue)
314 } else if (UnderlyingType == TypeManager.short_type) {
315 short i = (short) default_value;
317 if (i < System.Int16.MaxValue)
321 } else if (UnderlyingType == TypeManager.ushort_type) {
322 ushort i = (ushort) default_value;
324 if (i < System.UInt16.MaxValue)
328 } else if (UnderlyingType == TypeManager.byte_type) {
329 byte i = (byte) default_value;
331 if (i < System.Byte.MaxValue)
335 } else if (UnderlyingType == TypeManager.sbyte_type) {
336 sbyte i = (sbyte) default_value;
338 if (i < System.SByte.MaxValue)
347 void Error_ConstantValueCannotBeConverted (object val, Location loc)
350 Report.Error (31, loc, "Constant value '" + ((Constant) val).AsString () +
351 "' cannot be converted" +
352 " to a " + TypeManager.CSharpName (UnderlyingType));
354 Report.Error (31, loc, "Constant value '" + val +
355 "' cannot be converted" +
356 " to a " + TypeManager.CSharpName (UnderlyingType));
361 /// Determines if a standard implicit conversion exists from
362 /// expr_type to target_type
364 public static bool ImplicitConversionExists (Type expr_type, Type target_type)
366 expr_type = TypeManager.TypeToCoreType (expr_type);
368 if (expr_type == TypeManager.void_type)
371 if (expr_type == target_type)
374 // First numeric conversions
376 if (expr_type == TypeManager.sbyte_type){
378 // From sbyte to short, int, long, float, double.
380 if ((target_type == TypeManager.int32_type) ||
381 (target_type == TypeManager.int64_type) ||
382 (target_type == TypeManager.double_type) ||
383 (target_type == TypeManager.float_type) ||
384 (target_type == TypeManager.short_type) ||
385 (target_type == TypeManager.decimal_type))
388 } else if (expr_type == TypeManager.byte_type){
390 // From byte to short, ushort, int, uint, long, ulong, float, double
392 if ((target_type == TypeManager.short_type) ||
393 (target_type == TypeManager.ushort_type) ||
394 (target_type == TypeManager.int32_type) ||
395 (target_type == TypeManager.uint32_type) ||
396 (target_type == TypeManager.uint64_type) ||
397 (target_type == TypeManager.int64_type) ||
398 (target_type == TypeManager.float_type) ||
399 (target_type == TypeManager.double_type) ||
400 (target_type == TypeManager.decimal_type))
403 } else if (expr_type == TypeManager.short_type){
405 // From short to int, long, float, double
407 if ((target_type == TypeManager.int32_type) ||
408 (target_type == TypeManager.int64_type) ||
409 (target_type == TypeManager.double_type) ||
410 (target_type == TypeManager.float_type) ||
411 (target_type == TypeManager.decimal_type))
414 } else if (expr_type == TypeManager.ushort_type){
416 // From ushort to int, uint, long, ulong, float, double
418 if ((target_type == TypeManager.uint32_type) ||
419 (target_type == TypeManager.uint64_type) ||
420 (target_type == TypeManager.int32_type) ||
421 (target_type == TypeManager.int64_type) ||
422 (target_type == TypeManager.double_type) ||
423 (target_type == TypeManager.float_type) ||
424 (target_type == TypeManager.decimal_type))
427 } else if (expr_type == TypeManager.int32_type){
429 // From int to long, float, double
431 if ((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.uint32_type){
439 // From uint to long, ulong, float, double
441 if ((target_type == TypeManager.int64_type) ||
442 (target_type == TypeManager.uint64_type) ||
443 (target_type == TypeManager.double_type) ||
444 (target_type == TypeManager.float_type) ||
445 (target_type == TypeManager.decimal_type))
448 } else if ((expr_type == TypeManager.uint64_type) ||
449 (expr_type == TypeManager.int64_type)) {
451 // From long/ulong to float, double
453 if ((target_type == TypeManager.double_type) ||
454 (target_type == TypeManager.float_type) ||
455 (target_type == TypeManager.decimal_type))
458 } else if (expr_type == TypeManager.char_type){
460 // From char to ushort, int, uint, long, ulong, float, double
462 if ((target_type == TypeManager.ushort_type) ||
463 (target_type == TypeManager.int32_type) ||
464 (target_type == TypeManager.uint32_type) ||
465 (target_type == TypeManager.uint64_type) ||
466 (target_type == TypeManager.int64_type) ||
467 (target_type == TypeManager.float_type) ||
468 (target_type == TypeManager.double_type) ||
469 (target_type == TypeManager.decimal_type))
472 } else if (expr_type == TypeManager.float_type){
476 if (target_type == TypeManager.double_type)
484 // Horrible, horrible. But there is no other way we can pass the EmitContext
485 // to the recursive definition triggered by the evaluation of a forward
488 static EmitContext current_ec = null;
491 /// This is used to lookup the value of an enum member. If the member is undefined,
492 /// it attempts to define it and return its value
494 public object LookupEnumValue (EmitContext ec, string name, Location loc)
497 object default_value = null;
500 default_value = member_to_value [name];
502 if (default_value != null)
503 return default_value;
506 // This may happen if we're calling a method in System.Enum, for instance
509 if (!defined_names.Contains (name))
512 if (in_transit.Contains (name)) {
513 Report.Error (110, loc, "The evaluation of the constant value for `" +
514 Name + "." + name + "' involves a circular definition.");
519 // So if the above doesn't happen, we have a member that is undefined
520 // We now proceed to define it
522 Expression val = this [name];
526 int idx = ordered_enums.IndexOf (name);
531 for (int i = 0; i < idx; ++i) {
532 string n = (string) ordered_enums [i];
533 Location m_loc = (Mono.CSharp.Location)
534 member_to_location [n];
535 in_transit.Add (name, true);
537 EmitContext old_ec = current_ec;
540 default_value = LookupEnumValue (ec, n, m_loc);
544 in_transit.Remove (name);
545 if (default_value == null)
549 default_value = GetNextDefaultValue (default_value);
553 bool old = ec.InEnumContext;
554 ec.InEnumContext = true;
555 in_transit.Add (name, true);
557 EmitContext old_ec = current_ec;
559 val = val.Resolve (ec);
562 in_transit.Remove (name);
563 ec.InEnumContext = old;
568 if (!IsValidEnumConstant (val)) {
571 "Type byte, sbyte, short, ushort, int, uint, long, or " +
572 "ulong expected (have: " + val + ")");
577 default_value = c.GetValue ();
579 if (default_value == null) {
580 Error_ConstantValueCannotBeConverted (c, loc);
584 if (val is EnumConstant){
585 Type etype = TypeManager.EnumToUnderlying (c.Type);
587 if (!ImplicitConversionExists (etype, UnderlyingType)){
588 Convert.Error_CannotImplicitConversion (
589 loc, c.Type, UnderlyingType);
595 EnumMember em = (EnumMember) defined_names [name];
596 em.DefineMember (TypeBuilder);
599 default_value = TypeManager.ChangeType (default_value, UnderlyingType, out fail);
601 Error_ConstantValueCannotBeConverted (c, loc);
605 em.builder.SetConstant (default_value);
606 field_builders.Add (em.builder);
607 member_to_value [name] = default_value;
609 if (!TypeManager.RegisterFieldValue (em.builder, default_value))
612 return default_value;
615 public override bool DefineMembers (TypeContainer parent)
620 public override bool Define ()
623 // If there was an error during DefineEnum, return
625 if (TypeBuilder == null)
628 ec = new EmitContext (this, this, Location, null, UnderlyingType, ModFlags, false);
630 object default_value = 0;
633 foreach (string name in ordered_enums) {
635 // Have we already been defined, thanks to some cross-referencing ?
637 if (member_to_value.Contains (name))
640 Location loc = (Mono.CSharp.Location) member_to_location [name];
642 if (this [name] != null) {
643 default_value = LookupEnumValue (ec, name, loc);
645 if (default_value == null)
648 if (name == "value__"){
649 Report.Error (76, loc, "The name `value__' is reserved for enumerations");
653 EnumMember em = (EnumMember) defined_names [name];
655 em.DefineMember (TypeBuilder);
656 FieldBuilder fb = em.builder;
658 if (default_value == null) {
659 Report.Error (543, loc, "Enumerator value for '" + name + "' is too large to " +
665 default_value = TypeManager.ChangeType (default_value, UnderlyingType, out fail);
667 Error_ConstantValueCannotBeConverted (default_value, loc);
671 fb.SetConstant (default_value);
672 field_builders.Add (fb);
673 member_to_value [name] = default_value;
675 if (!TypeManager.RegisterFieldValue (fb, default_value))
679 default_value = GetNextDefaultValue (default_value);
685 public override void Emit ()
687 if (OptAttributes != null) {
688 OptAttributes.Emit (ec, this);
691 foreach (EnumMember em in defined_names.Values) {
698 void VerifyClsName ()
700 Hashtable ht = new Hashtable ();
701 foreach (string name in ordered_enums) {
702 string locase = name.ToLower (System.Globalization.CultureInfo.InvariantCulture);
703 if (!ht.Contains (locase)) {
704 ht.Add (locase, defined_names [name]);
708 MemberCore conflict = (MemberCore)ht [locase];
709 Report.SymbolRelatedToPreviousError (conflict);
710 conflict = GetDefinition (name);
711 Report.Error (3005, conflict.Location, "Identifier '{0}' differing only in case is not CLS-compliant", conflict.GetSignatureForError ());
715 protected override bool VerifyClsCompliance (DeclSpace ds)
717 if (!base.VerifyClsCompliance (ds))
722 if (!AttributeTester.IsClsCompliant (UnderlyingType)) {
723 Report.Error (3009, Location, "'{0}': base type '{1}' is not CLS-compliant", GetSignatureForError (), TypeManager.CSharpName (UnderlyingType));
730 /// Returns full enum name.
732 string GetEnumeratorName (string valueName)
734 return String.Concat (Name, ".", valueName);
740 public override MemberList FindMembers (MemberTypes mt, BindingFlags bf,
741 MemberFilter filter, object criteria)
743 ArrayList members = new ArrayList ();
745 if ((mt & MemberTypes.Field) != 0) {
746 if (criteria is string){
747 if (member_to_value [criteria] == null && current_ec != null){
748 LookupEnumValue (current_ec, (string) criteria, Location.Null);
752 foreach (FieldBuilder fb in field_builders)
753 if (filter (fb, criteria) == true)
757 return new MemberList (members);
760 public override MemberCache MemberCache {
766 public ArrayList ValueNames {
768 return ordered_enums;
773 public Expression this [string name] {
775 return ((EnumMember) defined_names [name]).Type;
779 public override AttributeTargets AttributeTargets {
781 return AttributeTargets.Enum;
785 protected override void VerifyObsoleteAttribute()
787 // UnderlyingType is never obsolete
791 // Generates xml doc comments (if any), and if required,
792 // handle warning report.
794 internal override void GenerateDocComment (DeclSpace ds)
796 DocUtil.GenerateEnumDocComment (this, ds);
800 // Represents header string for documentation comment.
802 public override string DocCommentHeader {