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 attr |= TypeAttributes.Class | TypeAttributes.Sealed;
218 if (!(BaseType is TypeLookupExpression)) {
219 Report.Error (1008, Location,
220 "Type byte, sbyte, short, ushort, int, uint, " +
221 "long, or ulong expected (got: `{0}')", BaseType);
225 UnderlyingType = ResolveType (BaseType, false, Location);
227 if (UnderlyingType != TypeManager.int32_type &&
228 UnderlyingType != TypeManager.uint32_type &&
229 UnderlyingType != TypeManager.int64_type &&
230 UnderlyingType != TypeManager.uint64_type &&
231 UnderlyingType != TypeManager.short_type &&
232 UnderlyingType != TypeManager.ushort_type &&
233 UnderlyingType != TypeManager.byte_type &&
234 UnderlyingType != TypeManager.sbyte_type) {
235 Report.Error (1008, Location,
236 "Type byte, sbyte, short, ushort, int, uint, " +
237 "long, or ulong expected (got: " +
238 TypeManager.CSharpName (UnderlyingType) + ")");
243 if (TypeManager.NamespaceClash (Name, Location))
246 ModuleBuilder builder = CodeGen.Module.Builder;
248 TypeBuilder = builder.DefineType (Name, attr, TypeManager.enum_type);
250 TypeBuilder builder = Parent.TypeBuilder;
252 TypeBuilder = builder.DefineNestedType (
253 Basename, attr, TypeManager.enum_type);
257 // Call MapToInternalType for corlib
259 TypeBuilder.DefineField ("value__", UnderlyingType,
260 FieldAttributes.Public | FieldAttributes.SpecialName
261 | FieldAttributes.RTSpecialName);
263 TypeManager.AddEnumType (Name, TypeBuilder, this);
268 bool IsValidEnumConstant (Expression e)
270 if (!(e is Constant))
273 if (e is IntConstant || e is UIntConstant || e is LongConstant ||
274 e is ByteConstant || e is SByteConstant || e is ShortConstant ||
275 e is UShortConstant || e is ULongConstant || e is EnumConstant ||
282 object GetNextDefaultValue (object default_value)
284 if (UnderlyingType == TypeManager.int32_type) {
285 int i = (int) default_value;
287 if (i < System.Int32.MaxValue)
291 } else if (UnderlyingType == TypeManager.uint32_type) {
292 uint i = (uint) default_value;
294 if (i < System.UInt32.MaxValue)
298 } else if (UnderlyingType == TypeManager.int64_type) {
299 long i = (long) default_value;
301 if (i < System.Int64.MaxValue)
305 } else if (UnderlyingType == TypeManager.uint64_type) {
306 ulong i = (ulong) default_value;
308 if (i < System.UInt64.MaxValue)
312 } else if (UnderlyingType == TypeManager.short_type) {
313 short i = (short) default_value;
315 if (i < System.Int16.MaxValue)
319 } else if (UnderlyingType == TypeManager.ushort_type) {
320 ushort i = (ushort) default_value;
322 if (i < System.UInt16.MaxValue)
326 } else if (UnderlyingType == TypeManager.byte_type) {
327 byte i = (byte) default_value;
329 if (i < System.Byte.MaxValue)
333 } else if (UnderlyingType == TypeManager.sbyte_type) {
334 sbyte i = (sbyte) default_value;
336 if (i < System.SByte.MaxValue)
345 void Error_ConstantValueCannotBeConverted (object val, Location loc)
348 Report.Error (31, loc, "Constant value '" + ((Constant) val).AsString () +
349 "' cannot be converted" +
350 " to a " + TypeManager.CSharpName (UnderlyingType));
352 Report.Error (31, loc, "Constant value '" + val +
353 "' cannot be converted" +
354 " to a " + TypeManager.CSharpName (UnderlyingType));
359 /// Determines if a standard implicit conversion exists from
360 /// expr_type to target_type
362 public static bool ImplicitConversionExists (Type expr_type, Type target_type)
364 expr_type = TypeManager.TypeToCoreType (expr_type);
366 if (expr_type == TypeManager.void_type)
369 if (expr_type == target_type)
372 // First numeric conversions
374 if (expr_type == TypeManager.sbyte_type){
376 // From sbyte to short, int, long, float, double.
378 if ((target_type == TypeManager.int32_type) ||
379 (target_type == TypeManager.int64_type) ||
380 (target_type == TypeManager.double_type) ||
381 (target_type == TypeManager.float_type) ||
382 (target_type == TypeManager.short_type) ||
383 (target_type == TypeManager.decimal_type))
386 } else if (expr_type == TypeManager.byte_type){
388 // From byte to short, ushort, int, uint, long, ulong, float, double
390 if ((target_type == TypeManager.short_type) ||
391 (target_type == TypeManager.ushort_type) ||
392 (target_type == TypeManager.int32_type) ||
393 (target_type == TypeManager.uint32_type) ||
394 (target_type == TypeManager.uint64_type) ||
395 (target_type == TypeManager.int64_type) ||
396 (target_type == TypeManager.float_type) ||
397 (target_type == TypeManager.double_type) ||
398 (target_type == TypeManager.decimal_type))
401 } else if (expr_type == TypeManager.short_type){
403 // From short to int, long, float, double
405 if ((target_type == TypeManager.int32_type) ||
406 (target_type == TypeManager.int64_type) ||
407 (target_type == TypeManager.double_type) ||
408 (target_type == TypeManager.float_type) ||
409 (target_type == TypeManager.decimal_type))
412 } else if (expr_type == TypeManager.ushort_type){
414 // From ushort to int, uint, long, ulong, float, double
416 if ((target_type == TypeManager.uint32_type) ||
417 (target_type == TypeManager.uint64_type) ||
418 (target_type == TypeManager.int32_type) ||
419 (target_type == TypeManager.int64_type) ||
420 (target_type == TypeManager.double_type) ||
421 (target_type == TypeManager.float_type) ||
422 (target_type == TypeManager.decimal_type))
425 } else if (expr_type == TypeManager.int32_type){
427 // From int to long, float, double
429 if ((target_type == TypeManager.int64_type) ||
430 (target_type == TypeManager.double_type) ||
431 (target_type == TypeManager.float_type) ||
432 (target_type == TypeManager.decimal_type))
435 } else if (expr_type == TypeManager.uint32_type){
437 // From uint to long, ulong, float, double
439 if ((target_type == TypeManager.int64_type) ||
440 (target_type == TypeManager.uint64_type) ||
441 (target_type == TypeManager.double_type) ||
442 (target_type == TypeManager.float_type) ||
443 (target_type == TypeManager.decimal_type))
446 } else if ((expr_type == TypeManager.uint64_type) ||
447 (expr_type == TypeManager.int64_type)) {
449 // From long/ulong to float, double
451 if ((target_type == TypeManager.double_type) ||
452 (target_type == TypeManager.float_type) ||
453 (target_type == TypeManager.decimal_type))
456 } else if (expr_type == TypeManager.char_type){
458 // From char to ushort, int, uint, long, ulong, float, double
460 if ((target_type == TypeManager.ushort_type) ||
461 (target_type == TypeManager.int32_type) ||
462 (target_type == TypeManager.uint32_type) ||
463 (target_type == TypeManager.uint64_type) ||
464 (target_type == TypeManager.int64_type) ||
465 (target_type == TypeManager.float_type) ||
466 (target_type == TypeManager.double_type) ||
467 (target_type == TypeManager.decimal_type))
470 } else if (expr_type == TypeManager.float_type){
474 if (target_type == TypeManager.double_type)
482 // Horrible, horrible. But there is no other way we can pass the EmitContext
483 // to the recursive definition triggered by the evaluation of a forward
486 static EmitContext current_ec = null;
489 /// This is used to lookup the value of an enum member. If the member is undefined,
490 /// it attempts to define it and return its value
492 public object LookupEnumValue (EmitContext ec, string name, Location loc)
495 object default_value = null;
498 default_value = member_to_value [name];
500 if (default_value != null)
501 return default_value;
504 // This may happen if we're calling a method in System.Enum, for instance
507 if (!defined_names.Contains (name))
510 if (in_transit.Contains (name)) {
511 Report.Error (110, loc, "The evaluation of the constant value for `" +
512 Name + "." + name + "' involves a circular definition.");
517 // So if the above doesn't happen, we have a member that is undefined
518 // We now proceed to define it
520 Expression val = this [name];
524 int idx = ordered_enums.IndexOf (name);
529 for (int i = 0; i < idx; ++i) {
530 string n = (string) ordered_enums [i];
531 Location m_loc = (Mono.CSharp.Location)
532 member_to_location [n];
533 in_transit.Add (name, true);
535 EmitContext old_ec = current_ec;
538 default_value = LookupEnumValue (ec, n, m_loc);
542 in_transit.Remove (name);
543 if (default_value == null)
547 default_value = GetNextDefaultValue (default_value);
551 bool old = ec.InEnumContext;
552 ec.InEnumContext = true;
553 in_transit.Add (name, true);
555 EmitContext old_ec = current_ec;
557 val = val.Resolve (ec);
560 in_transit.Remove (name);
561 ec.InEnumContext = old;
566 if (!IsValidEnumConstant (val)) {
569 "Type byte, sbyte, short, ushort, int, uint, long, or " +
570 "ulong expected (have: " + val + ")");
575 default_value = c.GetValue ();
577 if (default_value == null) {
578 Error_ConstantValueCannotBeConverted (c, loc);
582 if (val is EnumConstant){
583 Type etype = TypeManager.EnumToUnderlying (c.Type);
585 if (!ImplicitConversionExists (etype, UnderlyingType)){
586 Convert.Error_CannotImplicitConversion (
587 loc, c.Type, UnderlyingType);
593 EnumMember em = (EnumMember) defined_names [name];
594 em.DefineMember (TypeBuilder);
597 default_value = TypeManager.ChangeType (default_value, UnderlyingType, out fail);
599 Error_ConstantValueCannotBeConverted (c, loc);
603 em.builder.SetConstant (default_value);
604 field_builders.Add (em.builder);
605 member_to_value [name] = default_value;
607 if (!TypeManager.RegisterFieldValue (em.builder, default_value))
610 return default_value;
613 public override bool DefineMembers (TypeContainer parent)
618 public override bool Define ()
621 // If there was an error during DefineEnum, return
623 if (TypeBuilder == null)
626 EmitContext ec = new EmitContext (this, this, Location, null,
627 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 EmitContext ec = new EmitContext (
688 Parent, this, Location, null, null, ModFlags, false);
690 if (OptAttributes != null) {
691 OptAttributes.Emit (ec, this);
694 foreach (EnumMember em in defined_names.Values) {
701 void VerifyClsName ()
703 Hashtable ht = new Hashtable ();
704 foreach (string name in ordered_enums) {
705 string locase = name.ToLower (System.Globalization.CultureInfo.InvariantCulture);
706 if (!ht.Contains (locase)) {
707 ht.Add (locase, defined_names [name]);
711 MemberCore conflict = (MemberCore)ht [locase];
712 Report.SymbolRelatedToPreviousError (conflict);
713 conflict = GetDefinition (name);
714 Report.Error (3005, conflict.Location, "Identifier '{0}' differing only in case is not CLS-compliant", conflict.GetSignatureForError ());
718 protected override bool VerifyClsCompliance (DeclSpace ds)
720 if (!base.VerifyClsCompliance (ds))
725 if (!AttributeTester.IsClsCompliant (UnderlyingType)) {
726 Report.Error (3009, Location, "'{0}': base type '{1}' is not CLS-compliant", GetSignatureForError (), TypeManager.CSharpName (UnderlyingType));
733 /// Returns full enum name.
735 string GetEnumeratorName (string valueName)
737 return String.Concat (Name, ".", valueName);
743 public override MemberList FindMembers (MemberTypes mt, BindingFlags bf,
744 MemberFilter filter, object criteria)
746 ArrayList members = new ArrayList ();
748 if ((mt & MemberTypes.Field) != 0) {
749 if (criteria is string){
750 if (member_to_value [criteria] == null && current_ec != null){
751 LookupEnumValue (current_ec, (string) criteria, Location.Null);
755 foreach (FieldBuilder fb in field_builders)
756 if (filter (fb, criteria) == true)
760 return new MemberList (members);
763 public override MemberCache MemberCache {
769 public ArrayList ValueNames {
771 return ordered_enums;
776 public Expression this [string name] {
778 return ((EnumMember) defined_names [name]).Type;
782 public override AttributeTargets AttributeTargets {
784 return AttributeTargets.Enum;
788 protected override void VerifyObsoleteAttribute()
790 // UnderlyingType is never obsolete
794 // Generates xml doc comments (if any), and if required,
795 // handle warning report.
797 internal override void GenerateDocComment (DeclSpace ds)
799 DocUtil.GenerateEnumDocComment (this, ds);
803 // Represents header string for documentation comment.
805 public override string DocCommentHeader {