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 (NamespaceEntry ns, TypeContainer parent, Expression type, int mod_flags,
53 string name, Attributes attrs, Location l)
54 : base (ns, parent, name, l)
57 ModFlags = Modifiers.Check (AllowedModifiers, mod_flags,
58 IsTopLevel ? Modifiers.INTERNAL : Modifiers.PRIVATE, l);
59 OptAttributes = attrs;
61 ordered_enums = new ArrayList ();
62 member_to_location = new Hashtable ();
63 member_to_value = new Hashtable ();
64 in_transit = new Hashtable ();
65 field_builders = new ArrayList ();
69 /// Adds @name to the enumeration space, with @expr
70 /// being its definition.
72 public AdditionResult AddEnumMember (string name, Expression expr, Location loc,
75 if (defined_names.Contains (name))
76 return AdditionResult.NameExists;
78 if (name == "value__") {
79 Report.Error (76, loc, "An item in an enumeration can't have an identifier `value__'");
80 return AdditionResult.Error;
83 DefineName (name, expr);
85 ordered_enums.Add (name);
86 member_to_location.Add (name, loc);
88 if (member_to_attributes == null)
89 member_to_attributes = new Hashtable ();
91 member_to_attributes.Add (name, opt_attrs);
93 return AdditionResult.Success;
97 // This is used by corlib compilation: we map from our
98 // type to a type that is consumable by the DefineField
100 Type MapToInternalType (Type t)
102 if (t == TypeManager.int32_type)
104 if (t == TypeManager.int64_type)
105 return typeof (long);
106 if (t == TypeManager.uint32_type)
107 return typeof (uint);
108 if (t == TypeManager.uint64_type)
109 return typeof (ulong);
110 if (t == TypeManager.float_type)
111 return typeof (float);
112 if (t == TypeManager.double_type)
113 return typeof (double);
114 if (t == TypeManager.byte_type)
115 return typeof (byte);
116 if (t == TypeManager.sbyte_type)
117 return typeof (sbyte);
118 if (t == TypeManager.char_type)
119 return typeof (char);
120 if (t == TypeManager.short_type)
121 return typeof (short);
122 if (t == TypeManager.ushort_type)
123 return typeof (ushort);
125 throw new Exception ();
128 public override TypeBuilder DefineType ()
130 if (TypeBuilder != null)
133 TypeAttributes attr = Modifiers.TypeAttr (ModFlags, IsTopLevel);
135 attr |= TypeAttributes.Class | TypeAttributes.Sealed;
137 UnderlyingType = ResolveType (BaseType, false, Location);
139 if (UnderlyingType != TypeManager.int32_type &&
140 UnderlyingType != TypeManager.uint32_type &&
141 UnderlyingType != TypeManager.int64_type &&
142 UnderlyingType != TypeManager.uint64_type &&
143 UnderlyingType != TypeManager.short_type &&
144 UnderlyingType != TypeManager.ushort_type &&
145 UnderlyingType != TypeManager.byte_type &&
146 UnderlyingType != TypeManager.char_type &&
147 UnderlyingType != TypeManager.sbyte_type) {
148 Report.Error (1008, Location,
149 "Type byte, sbyte, short, char, ushort, int, uint, " +
150 "long, or ulong expected (got: " +
151 TypeManager.CSharpName (UnderlyingType) + ")");
156 if (TypeManager.NamespaceClash (Name, Location))
159 ModuleBuilder builder = CodeGen.ModuleBuilder;
161 TypeBuilder = builder.DefineType (Name, attr, TypeManager.enum_type);
163 TypeBuilder builder = Parent.TypeBuilder;
165 TypeBuilder = builder.DefineNestedType (
166 Basename, attr, TypeManager.enum_type);
170 // Call MapToInternalType for corlib
172 TypeBuilder.DefineField ("value__", UnderlyingType,
173 FieldAttributes.Public | FieldAttributes.SpecialName
174 | FieldAttributes.RTSpecialName);
176 TypeManager.AddEnumType (Name, TypeBuilder, this);
181 bool IsValidEnumConstant (Expression e)
183 if (!(e is Constant))
186 if (e is IntConstant || e is UIntConstant || e is LongConstant ||
187 e is ByteConstant || e is SByteConstant || e is ShortConstant ||
188 e is UShortConstant || e is ULongConstant || e is EnumConstant ||
195 object GetNextDefaultValue (object default_value)
197 if (UnderlyingType == TypeManager.int32_type) {
198 int i = (int) default_value;
200 if (i < System.Int32.MaxValue)
204 } else if (UnderlyingType == TypeManager.uint32_type) {
205 uint i = (uint) default_value;
207 if (i < System.UInt32.MaxValue)
211 } else if (UnderlyingType == TypeManager.int64_type) {
212 long i = (long) default_value;
214 if (i < System.Int64.MaxValue)
218 } else if (UnderlyingType == TypeManager.uint64_type) {
219 ulong i = (ulong) default_value;
221 if (i < System.UInt64.MaxValue)
225 } else if (UnderlyingType == TypeManager.short_type) {
226 short i = (short) default_value;
228 if (i < System.Int16.MaxValue)
232 } else if (UnderlyingType == TypeManager.ushort_type) {
233 ushort i = (ushort) default_value;
235 if (i < System.UInt16.MaxValue)
239 } else if (UnderlyingType == TypeManager.byte_type) {
240 byte i = (byte) default_value;
242 if (i < System.Byte.MaxValue)
246 } else if (UnderlyingType == TypeManager.sbyte_type) {
247 sbyte i = (sbyte) default_value;
249 if (i < System.SByte.MaxValue)
258 void Error_ConstantValueCannotBeConverted (object val, Location loc)
261 Report.Error (31, loc, "Constant value '" + ((Constant) val).AsString () +
262 "' cannot be converted" +
263 " to a " + TypeManager.CSharpName (UnderlyingType));
265 Report.Error (31, loc, "Constant value '" + val +
266 "' cannot be converted" +
267 " to a " + TypeManager.CSharpName (UnderlyingType));
272 /// Determines if a standard implicit conversion exists from
273 /// expr_type to target_type
275 public static bool ImplicitConversionExists (Type expr_type, Type target_type)
277 expr_type = TypeManager.TypeToCoreType (expr_type);
279 if (expr_type == TypeManager.void_type)
282 if (expr_type == target_type)
285 // First numeric conversions
287 if (expr_type == TypeManager.sbyte_type){
289 // From sbyte to short, int, long, float, double.
291 if ((target_type == TypeManager.int32_type) ||
292 (target_type == TypeManager.int64_type) ||
293 (target_type == TypeManager.double_type) ||
294 (target_type == TypeManager.float_type) ||
295 (target_type == TypeManager.short_type) ||
296 (target_type == TypeManager.decimal_type))
299 } else if (expr_type == TypeManager.byte_type){
301 // From byte to short, ushort, int, uint, long, ulong, float, double
303 if ((target_type == TypeManager.short_type) ||
304 (target_type == TypeManager.ushort_type) ||
305 (target_type == TypeManager.int32_type) ||
306 (target_type == TypeManager.uint32_type) ||
307 (target_type == TypeManager.uint64_type) ||
308 (target_type == TypeManager.int64_type) ||
309 (target_type == TypeManager.float_type) ||
310 (target_type == TypeManager.double_type) ||
311 (target_type == TypeManager.decimal_type))
314 } else if (expr_type == TypeManager.short_type){
316 // From short to int, long, float, double
318 if ((target_type == TypeManager.int32_type) ||
319 (target_type == TypeManager.int64_type) ||
320 (target_type == TypeManager.double_type) ||
321 (target_type == TypeManager.float_type) ||
322 (target_type == TypeManager.decimal_type))
325 } else if (expr_type == TypeManager.ushort_type){
327 // From ushort to int, uint, long, ulong, float, double
329 if ((target_type == TypeManager.uint32_type) ||
330 (target_type == TypeManager.uint64_type) ||
331 (target_type == TypeManager.int32_type) ||
332 (target_type == TypeManager.int64_type) ||
333 (target_type == TypeManager.double_type) ||
334 (target_type == TypeManager.float_type) ||
335 (target_type == TypeManager.decimal_type))
338 } else if (expr_type == TypeManager.int32_type){
340 // From int to long, float, double
342 if ((target_type == TypeManager.int64_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.uint32_type){
350 // From uint to long, ulong, float, double
352 if ((target_type == TypeManager.int64_type) ||
353 (target_type == TypeManager.uint64_type) ||
354 (target_type == TypeManager.double_type) ||
355 (target_type == TypeManager.float_type) ||
356 (target_type == TypeManager.decimal_type))
359 } else if ((expr_type == TypeManager.uint64_type) ||
360 (expr_type == TypeManager.int64_type)) {
362 // From long/ulong to float, double
364 if ((target_type == TypeManager.double_type) ||
365 (target_type == TypeManager.float_type) ||
366 (target_type == TypeManager.decimal_type))
369 } else if (expr_type == TypeManager.char_type){
371 // From char to ushort, int, uint, long, ulong, float, double
373 if ((target_type == TypeManager.ushort_type) ||
374 (target_type == TypeManager.int32_type) ||
375 (target_type == TypeManager.uint32_type) ||
376 (target_type == TypeManager.uint64_type) ||
377 (target_type == TypeManager.int64_type) ||
378 (target_type == TypeManager.float_type) ||
379 (target_type == TypeManager.double_type) ||
380 (target_type == TypeManager.decimal_type))
383 } else if (expr_type == TypeManager.float_type){
387 if (target_type == TypeManager.double_type)
395 // Horrible, horrible. But there is no other way we can pass the EmitContext
396 // to the recursive definition triggered by the evaluation of a forward
399 static EmitContext current_ec = null;
402 /// This is used to lookup the value of an enum member. If the member is undefined,
403 /// it attempts to define it and return its value
405 public object LookupEnumValue (EmitContext ec, string name, Location loc)
408 object default_value = null;
411 default_value = member_to_value [name];
413 if (default_value != null)
414 return default_value;
417 // This may happen if we're calling a method in System.Enum, for instance
420 if (!defined_names.Contains (name))
423 if (in_transit.Contains (name)) {
424 Report.Error (110, loc, "The evaluation of the constant value for `" +
425 Name + "." + name + "' involves a circular definition.");
430 // So if the above doesn't happen, we have a member that is undefined
431 // We now proceed to define it
433 Expression val = this [name];
437 int idx = ordered_enums.IndexOf (name);
442 for (int i = 0; i < idx; ++i) {
443 string n = (string) ordered_enums [i];
444 Location m_loc = (Mono.CSharp.Location)
445 member_to_location [n];
446 in_transit.Add (name, true);
448 EmitContext old_ec = current_ec;
451 default_value = LookupEnumValue (ec, n, m_loc);
455 in_transit.Remove (name);
456 if (default_value == null)
460 default_value = GetNextDefaultValue (default_value);
464 bool old = ec.InEnumContext;
465 ec.InEnumContext = true;
466 in_transit.Add (name, true);
468 EmitContext old_ec = current_ec;
470 val = val.Resolve (ec);
473 in_transit.Remove (name);
474 ec.InEnumContext = old;
479 if (!IsValidEnumConstant (val)) {
482 "Type byte, sbyte, short, ushort, int, uint, long, or " +
483 "ulong expected (have: " + val + ")");
488 default_value = c.GetValue ();
490 if (default_value == null) {
491 Error_ConstantValueCannotBeConverted (c, loc);
495 if (val is EnumConstant){
496 Type etype = TypeManager.EnumToUnderlying (c.Type);
498 if (!ImplicitConversionExists (etype, UnderlyingType)){
499 Convert.Error_CannotImplicitConversion (
500 loc, c.Type, UnderlyingType);
506 FieldAttributes attr = FieldAttributes.Public | FieldAttributes.Static
507 | FieldAttributes.Literal;
509 FieldBuilder fb = TypeBuilder.DefineField (name, TypeBuilder, attr);
512 default_value = TypeManager.ChangeType (default_value, UnderlyingType, out fail);
514 Error_ConstantValueCannotBeConverted (c, loc);
518 fb.SetConstant (default_value);
519 field_builders.Add (fb);
520 member_to_value [name] = default_value;
522 if (!TypeManager.RegisterFieldValue (fb, default_value))
526 // Now apply attributes
528 Attribute.ApplyAttributes (ec, fb, fb, (Attributes) member_to_attributes [name]);
530 return default_value;
533 public override bool DefineMembers (TypeContainer parent)
538 public override bool Define (TypeContainer parent)
541 // If there was an error during DefineEnum, return
543 if (TypeBuilder == null)
546 EmitContext ec = new EmitContext (this, this, Location, null,
547 UnderlyingType, ModFlags, false);
550 object default_value = 0;
552 FieldAttributes attr = FieldAttributes.Public | FieldAttributes.Static
553 | FieldAttributes.Literal;
556 foreach (string name in ordered_enums) {
558 // Have we already been defined, thanks to some cross-referencing ?
560 if (member_to_value.Contains (name))
563 Location loc = (Mono.CSharp.Location) member_to_location [name];
565 if (this [name] != null) {
566 default_value = LookupEnumValue (ec, name, loc);
568 if (default_value == null)
571 if (name == "value__"){
572 Report.Error (76, loc, "The name `value__' is reserved for enumerations");
576 FieldBuilder fb = TypeBuilder.DefineField (
577 name, TypeBuilder, attr);
579 if (default_value == null) {
580 Report.Error (543, loc, "Enumerator value for '" + name + "' is too large to " +
586 default_value = TypeManager.ChangeType (default_value, UnderlyingType, out fail);
588 Error_ConstantValueCannotBeConverted (default_value, loc);
592 fb.SetConstant (default_value);
593 field_builders.Add (fb);
594 member_to_value [name] = default_value;
596 if (!TypeManager.RegisterFieldValue (fb, default_value))
600 // Apply attributes on the enum member
602 Attribute.ApplyAttributes (ec, fb, fb, (Attributes) member_to_attributes [name]);
605 default_value = GetNextDefaultValue (default_value);
608 Attribute.ApplyAttributes (ec, TypeBuilder, this, OptAttributes);
616 public override MemberList FindMembers (MemberTypes mt, BindingFlags bf,
617 MemberFilter filter, object criteria)
619 ArrayList members = new ArrayList ();
621 if ((mt & MemberTypes.Field) != 0) {
622 if (criteria is string){
623 if (member_to_value [criteria] == null && current_ec != null){
624 LookupEnumValue (current_ec, (string) criteria, Location.Null);
628 foreach (FieldBuilder fb in field_builders)
629 if (filter (fb, criteria) == true)
633 return new MemberList (members);
636 public override MemberCache MemberCache {
642 public ArrayList ValueNames {
644 return ordered_enums;
649 public Expression this [string name] {
651 return (Expression) defined_names [name];