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;
17 namespace Mono.CSharp {
20 /// Enumeration container
22 public class Enum : DeclSpace {
23 ArrayList ordered_enums;
25 public Expression BaseType;
26 public Attributes OptAttributes;
28 public Type UnderlyingType;
30 Hashtable member_to_location;
31 Hashtable member_to_attributes;
34 // This is for members that have been defined
36 Hashtable member_to_value;
39 // This is used to mark members we're currently defining
43 ArrayList field_builders;
45 public const int AllowedModifiers =
52 public Enum (TypeContainer parent, Expression type, int mod_flags, string name, Attributes attrs, Location l)
53 : base (parent, name, l)
56 ModFlags = Modifiers.Check (AllowedModifiers, mod_flags,
57 IsTopLevel ? Modifiers.INTERNAL : Modifiers.PRIVATE, l);
58 OptAttributes = attrs;
60 ordered_enums = new ArrayList ();
61 member_to_location = new Hashtable ();
62 member_to_value = new Hashtable ();
63 in_transit = new Hashtable ();
64 field_builders = new ArrayList ();
68 /// Adds @name to the enumeration space, with @expr
69 /// being its definition.
71 public AdditionResult AddEnumMember (string name, Expression expr, Location loc,
74 if (defined_names.Contains (name))
75 return AdditionResult.NameExists;
77 DefineName (name, expr);
79 ordered_enums.Add (name);
80 member_to_location.Add (name, loc);
82 if (member_to_attributes == null)
83 member_to_attributes = new Hashtable ();
85 member_to_attributes.Add (name, opt_attrs);
87 return AdditionResult.Success;
91 // This is used by corlib compilation: we map from our
92 // type to a type that is consumable by the DefineField
94 Type MapToInternalType (Type t)
96 if (t == TypeManager.int32_type)
98 if (t == TypeManager.int64_type)
100 if (t == TypeManager.uint32_type)
101 return typeof (uint);
102 if (t == TypeManager.uint64_type)
103 return typeof (ulong);
104 if (t == TypeManager.float_type)
105 return typeof (float);
106 if (t == TypeManager.double_type)
107 return typeof (double);
108 if (t == TypeManager.byte_type)
109 return typeof (byte);
110 if (t == TypeManager.sbyte_type)
111 return typeof (sbyte);
112 if (t == TypeManager.char_type)
113 return typeof (char);
114 if (t == TypeManager.short_type)
115 return typeof (short);
116 if (t == TypeManager.ushort_type)
117 return typeof (ushort);
119 throw new Exception ();
122 public override TypeBuilder DefineType ()
124 if (TypeBuilder != null)
127 TypeAttributes attr = Modifiers.TypeAttr (ModFlags, IsTopLevel);
129 attr |= TypeAttributes.Class | TypeAttributes.Sealed;
131 UnderlyingType = ResolveType (BaseType, false, Location);
133 if (UnderlyingType != TypeManager.int32_type &&
134 UnderlyingType != TypeManager.uint32_type &&
135 UnderlyingType != TypeManager.int64_type &&
136 UnderlyingType != TypeManager.uint64_type &&
137 UnderlyingType != TypeManager.short_type &&
138 UnderlyingType != TypeManager.ushort_type &&
139 UnderlyingType != TypeManager.byte_type &&
140 UnderlyingType != TypeManager.sbyte_type) {
141 Report.Error (1008, Location,
142 "Type byte, sbyte, short, ushort, int, uint, " +
143 "long, or ulong expected (got: " +
144 TypeManager.CSharpName (UnderlyingType) + ")");
149 ModuleBuilder builder = CodeGen.ModuleBuilder;
151 TypeBuilder = builder.DefineType (Name, attr, TypeManager.enum_type);
153 TypeBuilder builder = Parent.TypeBuilder;
155 TypeBuilder = builder.DefineNestedType (
156 Basename, attr, TypeManager.enum_type);
160 // Call MapToInternalType for corlib
162 TypeBuilder.DefineField ("value__", UnderlyingType,
163 FieldAttributes.Public | FieldAttributes.SpecialName
164 | FieldAttributes.RTSpecialName);
166 TypeManager.AddEnumType (Name, TypeBuilder, this);
171 bool IsValidEnumConstant (Expression e)
173 if (!(e is Constant))
176 if (e is IntConstant || e is UIntConstant || e is LongConstant ||
177 e is ByteConstant || e is SByteConstant || e is ShortConstant ||
178 e is UShortConstant || e is ULongConstant || e is EnumConstant)
184 object GetNextDefaultValue (object default_value)
186 if (UnderlyingType == TypeManager.int32_type) {
187 int i = (int) default_value;
189 if (i < System.Int32.MaxValue)
193 } else if (UnderlyingType == TypeManager.uint32_type) {
194 uint i = (uint) default_value;
196 if (i < System.UInt32.MaxValue)
200 } else if (UnderlyingType == TypeManager.int64_type) {
201 long i = (long) default_value;
203 if (i < System.Int64.MaxValue)
207 } else if (UnderlyingType == TypeManager.uint64_type) {
208 ulong i = (ulong) default_value;
210 if (i < System.UInt64.MaxValue)
214 } else if (UnderlyingType == TypeManager.short_type) {
215 short i = (short) default_value;
217 if (i < System.Int16.MaxValue)
221 } else if (UnderlyingType == TypeManager.ushort_type) {
222 ushort i = (ushort) default_value;
224 if (i < System.UInt16.MaxValue)
228 } else if (UnderlyingType == TypeManager.byte_type) {
229 byte i = (byte) default_value;
231 if (i < System.Byte.MaxValue)
235 } else if (UnderlyingType == TypeManager.sbyte_type) {
236 sbyte i = (sbyte) default_value;
238 if (i < System.SByte.MaxValue)
247 void Error_ConstantValueCannotBeConverted (object val, Location loc)
250 Report.Error (31, loc, "Constant value '" + ((Constant) val).AsString () +
251 "' cannot be converted" +
252 " to a " + TypeManager.CSharpName (UnderlyingType));
254 Report.Error (31, loc, "Constant value '" + val +
255 "' cannot be converted" +
256 " to a " + TypeManager.CSharpName (UnderlyingType));
261 /// Determines if a standard implicit conversion exists from
262 /// expr_type to target_type
264 public static bool ImplicitConversionExists (Type expr_type, Type target_type)
266 expr_type = TypeManager.TypeToCoreType (expr_type);
268 if (expr_type == TypeManager.void_type)
271 if (expr_type == target_type)
274 // First numeric conversions
276 if (expr_type == TypeManager.sbyte_type){
278 // From sbyte to short, int, long, float, double.
280 if ((target_type == TypeManager.int32_type) ||
281 (target_type == TypeManager.int64_type) ||
282 (target_type == TypeManager.double_type) ||
283 (target_type == TypeManager.float_type) ||
284 (target_type == TypeManager.short_type) ||
285 (target_type == TypeManager.decimal_type))
288 } else if (expr_type == TypeManager.byte_type){
290 // From byte to short, ushort, int, uint, long, ulong, float, double
292 if ((target_type == TypeManager.short_type) ||
293 (target_type == TypeManager.ushort_type) ||
294 (target_type == TypeManager.int32_type) ||
295 (target_type == TypeManager.uint32_type) ||
296 (target_type == TypeManager.uint64_type) ||
297 (target_type == TypeManager.int64_type) ||
298 (target_type == TypeManager.float_type) ||
299 (target_type == TypeManager.double_type) ||
300 (target_type == TypeManager.decimal_type))
303 } else if (expr_type == TypeManager.short_type){
305 // From short to int, long, float, double
307 if ((target_type == TypeManager.int32_type) ||
308 (target_type == TypeManager.int64_type) ||
309 (target_type == TypeManager.double_type) ||
310 (target_type == TypeManager.float_type) ||
311 (target_type == TypeManager.decimal_type))
314 } else if (expr_type == TypeManager.ushort_type){
316 // From ushort to int, uint, long, ulong, float, double
318 if ((target_type == TypeManager.uint32_type) ||
319 (target_type == TypeManager.uint64_type) ||
320 (target_type == TypeManager.int32_type) ||
321 (target_type == TypeManager.int64_type) ||
322 (target_type == TypeManager.double_type) ||
323 (target_type == TypeManager.float_type) ||
324 (target_type == TypeManager.decimal_type))
327 } else if (expr_type == TypeManager.int32_type){
329 // From int to long, float, double
331 if ((target_type == TypeManager.int64_type) ||
332 (target_type == TypeManager.double_type) ||
333 (target_type == TypeManager.float_type) ||
334 (target_type == TypeManager.decimal_type))
337 } else if (expr_type == TypeManager.uint32_type){
339 // From uint to long, ulong, float, double
341 if ((target_type == TypeManager.int64_type) ||
342 (target_type == TypeManager.uint64_type) ||
343 (target_type == TypeManager.double_type) ||
344 (target_type == TypeManager.float_type) ||
345 (target_type == TypeManager.decimal_type))
348 } else if ((expr_type == TypeManager.uint64_type) ||
349 (expr_type == TypeManager.int64_type)) {
351 // From long/ulong to float, double
353 if ((target_type == TypeManager.double_type) ||
354 (target_type == TypeManager.float_type) ||
355 (target_type == TypeManager.decimal_type))
358 } else if (expr_type == TypeManager.char_type){
360 // From char to ushort, int, uint, long, ulong, float, double
362 if ((target_type == TypeManager.ushort_type) ||
363 (target_type == TypeManager.int32_type) ||
364 (target_type == TypeManager.uint32_type) ||
365 (target_type == TypeManager.uint64_type) ||
366 (target_type == TypeManager.int64_type) ||
367 (target_type == TypeManager.float_type) ||
368 (target_type == TypeManager.double_type) ||
369 (target_type == TypeManager.decimal_type))
372 } else if (expr_type == TypeManager.float_type){
376 if (target_type == TypeManager.double_type)
384 /// This is used to lookup the value of an enum member. If the member is undefined,
385 /// it attempts to define it and return its value
387 public object LookupEnumValue (EmitContext ec, string name, Location loc)
389 object default_value = null;
392 default_value = member_to_value [name];
394 if (default_value != null)
395 return default_value;
398 // This may happen if we're calling a method in System.Enum, for instance
401 if (!defined_names.Contains (name))
404 if (in_transit.Contains (name)) {
405 Report.Error (110, loc, "The evaluation of the constant value for `" +
406 Name + "." + name + "' involves a circular definition.");
411 // So if the above doesn't happen, we have a member that is undefined
412 // We now proceed to define it
414 Expression val = this [name];
418 int idx = ordered_enums.IndexOf (name);
423 for (int i = 0; i < idx; ++i) {
424 string n = (string) ordered_enums [i];
425 Location m_loc = (Mono.CSharp.Location)
426 member_to_location [n];
427 in_transit.Add (name, true);
428 default_value = LookupEnumValue (ec, n, m_loc);
429 in_transit.Remove (name);
430 if (default_value == null)
434 default_value = GetNextDefaultValue (default_value);
438 bool old = ec.InEnumContext;
439 ec.InEnumContext = true;
440 in_transit.Add (name, true);
441 val = val.Resolve (ec);
442 in_transit.Remove (name);
443 ec.InEnumContext = old;
448 if (!IsValidEnumConstant (val)) {
451 "Type byte, sbyte, short, ushort, int, uint, long, or " +
452 "ulong expected (have: " + val + ")");
457 default_value = c.GetValue ();
459 if (default_value == null) {
460 Error_ConstantValueCannotBeConverted (c, loc);
464 if (val is EnumConstant){
465 Type etype = TypeManager.EnumToUnderlying (c.Type);
467 if (!ImplicitConversionExists (etype, UnderlyingType)){
468 Expression.Error_CannotConvertImplicit (
469 loc, c.Type, UnderlyingType);
475 FieldAttributes attr = FieldAttributes.Public | FieldAttributes.Static
476 | FieldAttributes.Literal;
478 FieldBuilder fb = TypeBuilder.DefineField (name, UnderlyingType, attr);
481 default_value = TypeManager.ChangeType (default_value, UnderlyingType);
483 Error_ConstantValueCannotBeConverted (c, loc);
487 fb.SetConstant (default_value);
488 field_builders.Add (fb);
489 member_to_value [name] = default_value;
491 if (!TypeManager.RegisterFieldValue (fb, default_value))
495 // Now apply attributes
497 Attribute.ApplyAttributes (ec, fb, fb, (Attributes) member_to_attributes [name], loc);
499 return default_value;
502 public override bool DefineMembers (TypeContainer parent)
507 public override bool Define (TypeContainer parent)
510 // If there was an error during DefineEnum, return
512 if (TypeBuilder == null)
515 EmitContext ec = new EmitContext (parent, this, Location, null,
516 UnderlyingType, ModFlags, false);
518 object default_value = 0;
520 FieldAttributes attr = FieldAttributes.Public | FieldAttributes.Static
521 | FieldAttributes.Literal;
524 foreach (string name in ordered_enums) {
526 // Have we already been defined, thanks to some cross-referencing ?
528 if (member_to_value.Contains (name))
531 Location loc = (Mono.CSharp.Location) member_to_location [name];
533 if (this [name] != null) {
534 default_value = LookupEnumValue (ec, name, loc);
536 if (default_value == null)
540 FieldBuilder fb = TypeBuilder.DefineField (
541 name, UnderlyingType, attr);
543 if (default_value == null) {
544 Report.Error (543, loc, "Enumerator value for '" + name + "' is too large to " +
550 default_value = TypeManager.ChangeType (default_value, UnderlyingType);
552 Error_ConstantValueCannotBeConverted (default_value, loc);
556 fb.SetConstant (default_value);
557 field_builders.Add (fb);
558 member_to_value [name] = default_value;
560 if (!TypeManager.RegisterFieldValue (fb, default_value))
564 // Apply attributes on the enum member
566 Attribute.ApplyAttributes (ec, fb, fb, (Attributes) member_to_attributes [name], loc);
569 default_value = GetNextDefaultValue (default_value);
572 Attribute.ApplyAttributes (ec, TypeBuilder, this, OptAttributes, Location);
580 public override MemberList FindMembers (MemberTypes mt, BindingFlags bf,
581 MemberFilter filter, object criteria)
583 ArrayList members = new ArrayList ();
585 if ((mt & MemberTypes.Field) != 0) {
586 foreach (FieldBuilder fb in field_builders)
587 if (filter (fb, criteria) == true)
591 return new MemberList (members);
594 public override MemberCache MemberCache {
600 public ArrayList ValueNames {
602 return ordered_enums;
607 public Expression this [string name] {
609 return (Expression) defined_names [name];