mcs/gmcs/enum.cs

   1 //
   2 // enum.cs: Enum handling.
   3 //
   4 // Author: Miguel de Icaza (miguel@gnu.org)
   5 //         Ravi Pratap     (ravi@ximian.com)
   6 //         Marek Safar     (marek.safar@seznam.cz)
   7 //
   8 // Licensed under the terms of the GNU GPL
   9 //
  10 // (C) 2001 Ximian, Inc (http://www.ximian.com)
  11 //
  12
  13 using System;
  14 using System.Collections;
  15 using System.Collections.Specialized;
  16 using System.Reflection;
  17 using System.Reflection.Emit;
  18 using System.Globalization;
  19
  20 namespace Mono.CSharp {
  21
  22         public class EnumMember : MemberCore, IConstant {
  23                 static string[] attribute_targets = new string [] { "field" };
  24
  25                 public FieldBuilder builder;
  26
  27                 readonly Enum parent_enum;
  28                 readonly Expression ValueExpr;
  29                 readonly EnumMember prev_member;
  30
  31                 Constant value;
  32                 bool in_transit;
  33
  34                 // TODO: remove or simplify
  35                 EmitContext ec;
  36
  37                 public EnumMember (Enum parent_enum, EnumMember prev_member, Expression expr,
  38                                 MemberName name, Attributes attrs):
  39                         base (parent_enum, name, attrs)
  40                 {
  41                         this.parent_enum = parent_enum;
  42                         this.ModFlags = parent_enum.ModFlags;
  43                         this.ValueExpr = expr;
  44                         this.prev_member = prev_member;
  45
  46                         ec = new EmitContext (this, parent_enum, parent_enum, Location, null, null, ModFlags, false);
  47                         ec.InEnumContext = true;
  48                 }
  49
  50                 public override void ApplyAttributeBuilder (Attribute a, CustomAttributeBuilder cb)
  51                 {
  52                         if (a.Type == TypeManager.marshal_as_attr_type) {
  53                                 UnmanagedMarshal marshal = a.GetMarshal (this);
  54                                 if (marshal != null) {
  55                                         builder.SetMarshal (marshal);
  56                                 }
  57                                 return;
  58                         }
  59
  60                         if (a.Type.IsSubclassOf (TypeManager.security_attr_type)) {
  61                                 a.Error_InvalidSecurityParent ();
  62                                 return;
  63                         }
  64
  65                         builder.SetCustomAttribute (cb);
  66                 }
  67
  68                 public override AttributeTargets AttributeTargets {
  69                         get {
  70                                 return AttributeTargets.Field;
  71                         }
  72                 }
  73
  74                 static bool IsValidEnumType (Type t)
  75                 {
  76                         return (t == TypeManager.int32_type || t == TypeManager.uint32_type || t == TypeManager.int64_type ||
  77                                 t == TypeManager.byte_type || t == TypeManager.sbyte_type || t == TypeManager.short_type ||
  78                                 t == TypeManager.ushort_type || t == TypeManager.uint64_type || t == TypeManager.char_type ||
  79                                 t.IsEnum);
  80                 }
  81
  82                 public override bool Define ()
  83                 {
  84                         const FieldAttributes attr = FieldAttributes.Public | FieldAttributes.Static | FieldAttributes.Literal;
  85                         TypeBuilder tb = parent_enum.TypeBuilder;
  86                         builder = tb.DefineField (Name, tb, attr);
  87                         ec.ContainerType = tb;
  88
  89                         TypeManager.RegisterConstant (builder, this);
  90                         return true;
  91                 }
  92
  93                 // Because parent is TypeContainer and we have DeclSpace only
  94                 public override void CheckObsoleteness (Location loc)
  95                 {
  96                         parent_enum.CheckObsoleteness (loc);
  97
  98                         ObsoleteAttribute oa = GetObsoleteAttribute ();
  99                         if (oa == null) {
 100                                 return;
 101                         }
 102
 103                         AttributeTester.Report_ObsoleteMessage (oa, GetSignatureForError (), loc);
 104                 }
 105
 106                 public bool ResolveValue ()
 107                 {
 108                         if (value != null)
 109                                 return true;
 110
 111                         if (in_transit) {
 112                                 // suppress cyclic errors
 113                                 value = new EnumConstant (New.Constantify (parent_enum.UnderlyingType), parent_enum.TypeBuilder);
 114                                 Const.Error_CyclicDeclaration (this);
 115                                 return false;
 116                         }
 117
 118                         if (ValueExpr != null) {
 119                                 in_transit = true;
 120                                 Constant c = ValueExpr.ResolveAsConstant (ec, this);
 121                                 in_transit = false;
 122
 123                                 if (c == null)
 124                                         return false;
 125
 126                                 if (c is EnumConstant)
 127                                         c = ((EnumConstant)c).Child;
 128
 129                                 c = c.ToType (parent_enum.UnderlyingType, Location);
 130                                 if (c == null)
 131                                         return false;
 132
 133                                 if (!IsValidEnumType (c.Type)) {
 134                                         Report.Error (1008, Location, "Type byte, sbyte, short, ushort, int, uint, long or ulong expected");
 135                                         return false;
 136                                 }
 137
 138                                 in_transit = false;
 139                                 value = new EnumConstant (c, parent_enum.TypeBuilder);
 140                                 return true;
 141                         }
 142
 143                         if (prev_member == null) {
 144                                 value = new EnumConstant (New.Constantify (parent_enum.UnderlyingType), parent_enum.TypeBuilder);
 145                                 return true;
 146                         }
 147
 148                         if (!prev_member.ResolveValue ())
 149                                 return false;
 150
 151                         in_transit = true;
 152
 153                         try {
 154                                 value = prev_member.value.Increment ();
 155                         }
 156                         catch (OverflowException) {
 157                                 Report.Error (543, Location, "The enumerator value `{0}' is too large to fit in its type `{1}'",
 158                                         GetSignatureForError (), TypeManager.CSharpName (parent_enum.UnderlyingType));
 159                                 return false;
 160                         }
 161                         in_transit = false;
 162
 163                         return true;
 164                 }
 165
 166                 public override void Emit ()
 167                 {
 168                         if (OptAttributes != null)
 169                                 OptAttributes.Emit ();
 170
 171                         if (!ResolveValue ())
 172                                 return;
 173
 174                         builder.SetConstant (value.GetValue ());
 175                         base.Emit ();
 176                 }
 177
 178                 public override string GetSignatureForError()
 179                 {
 180                         return String.Concat (parent_enum.GetSignatureForError (), '.', Name);
 181                 }
 182
 183                 public override string[] ValidAttributeTargets {
 184                         get {
 185                                 return attribute_targets;
 186                         }
 187                 }
 188
 189                 public override string DocCommentHeader {
 190                         get { return "F:"; }
 191                 }
 192
 193                 #region IConstant Members
 194
 195                 public Constant Value {
 196                         get {
 197                                 return value;
 198                         }
 199                 }
 200
 201                 #endregion
 202         }
 203
 204         /// <summary>
 205         ///   Enumeration container
 206         /// </summary>
 207         public class Enum : DeclSpace {
 208                 Expression BaseType;
 209                 public Type UnderlyingType;
 210
 211                 static MemberList no_list = new MemberList (new object[0]);
 212
 213                 public const int AllowedModifiers =
 214                         Modifiers.NEW |
 215                         Modifiers.PUBLIC |
 216                         Modifiers.PROTECTED |
 217                         Modifiers.INTERNAL |
 218                         Modifiers.PRIVATE;
 219
 220                 public Enum (NamespaceEntry ns, DeclSpace parent, Expression type,
 221                              int mod_flags, MemberName name, Attributes attrs)
 222                         : base (ns, parent, name, attrs)
 223                 {
 224                         this.BaseType = type;
 225                         ModFlags = Modifiers.Check (AllowedModifiers, mod_flags,
 226                                                     IsTopLevel ? Modifiers.INTERNAL : Modifiers.PRIVATE, name.Location);
 227                 }
 228
 229                 public void AddEnumMember (EnumMember em)
 230                 {
 231                         if (em.Name == "value__") {
 232                                 Report.Error (76, em.Location, "An item in an enumeration cannot have an identifier `value__'");
 233                                 return;
 234                         }
 235
 236                         if (!AddToContainer (em, em.Name))
 237                                 return;
 238                 }
 239
 240                 public override TypeBuilder DefineType ()
 241                 {
 242                         if (TypeBuilder != null)
 243                                 return TypeBuilder;
 244
 245                         if (!(BaseType is TypeLookupExpression)) {
 246                                 Report.Error (1008, Location,
 247                                         "Type byte, sbyte, short, ushort, int, uint, long or ulong expected");
 248                                 return null;
 249                         }
 250
 251                         TypeExpr ute = BaseType.ResolveAsTypeTerminal (this, false);
 252                         UnderlyingType = ute.Type;
 253
 254                         if (UnderlyingType != TypeManager.int32_type &&
 255                             UnderlyingType != TypeManager.uint32_type &&
 256                             UnderlyingType != TypeManager.int64_type &&
 257                             UnderlyingType != TypeManager.uint64_type &&
 258                             UnderlyingType != TypeManager.short_type &&
 259                             UnderlyingType != TypeManager.ushort_type &&
 260                             UnderlyingType != TypeManager.byte_type  &&
 261                             UnderlyingType != TypeManager.sbyte_type) {
 262                                 Report.Error (1008, Location,
 263                                         "Type byte, sbyte, short, ushort, int, uint, long or ulong expected");
 264                                 return null;
 265                         }
 266
 267                         if (IsTopLevel) {
 268                                 if (TypeManager.NamespaceClash (Name, Location))
 269                                         return null;
 270
 271                                 ModuleBuilder builder = CodeGen.Module.Builder;
 272
 273                                 TypeBuilder = builder.DefineType (Name, TypeAttr, TypeManager.enum_type);
 274                         } else {
 275                                 TypeBuilder builder = Parent.TypeBuilder;
 276
 277                                 TypeBuilder = builder.DefineNestedType (
 278                                         Basename, TypeAttr, TypeManager.enum_type);
 279                         }
 280
 281                         //
 282                         // Call MapToInternalType for corlib
 283                         //
 284                         TypeBuilder.DefineField ("value__", UnderlyingType,
 285                                                  FieldAttributes.Public | FieldAttributes.SpecialName
 286                                                  | FieldAttributes.RTSpecialName);
 287
 288                         TypeManager.AddUserType (this);
 289
 290                         foreach (EnumMember em in defined_names.Values) {
 291                                 if (!em.Define ())
 292                                         return null;
 293                         }
 294
 295                         return TypeBuilder;
 296                 }
 297
 298                 public override bool Define ()
 299                 {
 300                         return true;
 301                 }
 302
 303                 public override void Emit ()
 304                 {
 305                         if (OptAttributes != null) {
 306                                 OptAttributes.Emit ();
 307                         }
 308
 309                         foreach (EnumMember em in defined_names.Values) {
 310                                 em.Emit ();
 311                         }
 312
 313                         base.Emit ();
 314                 }
 315
 316                 //
 317                 // IMemberFinder
 318                 //
 319                 public override MemberList FindMembers (MemberTypes mt, BindingFlags bf,
 320                         MemberFilter filter, object criteria)
 321                 {
 322                         if ((mt & MemberTypes.Field) == 0)
 323                                 return no_list;
 324
 325                         EnumMember em = defined_names [criteria] as EnumMember;
 326                         if (em == null)
 327                                 return no_list;
 328
 329                         FieldBuilder[] fb = new FieldBuilder[] { em.builder };
 330                         return new MemberList (fb);
 331                 }
 332
 333                 void VerifyClsName ()
 334                 {
 335                         HybridDictionary dict = new HybridDictionary (defined_names.Count, true);
 336                         foreach (EnumMember em in defined_names.Values) {
 337                                 if (!em.IsClsComplianceRequired ())
 338                                         continue;
 339
 340                                 try {
 341                                         dict.Add (em.Name, em);
 342                                 }
 343                                 catch (ArgumentException) {
 344                                         Report.SymbolRelatedToPreviousError (em);
 345                                         MemberCore col = (MemberCore)dict [em.Name];
 346                                         Report.Warning (3005, 1, col.Location, "Identifier `{0}' differing only in case is not CLS-compliant", col.GetSignatureForError ());
 347                                 }
 348                         }
 349                 }
 350
 351                 protected override bool VerifyClsCompliance ()
 352                 {
 353                         if (!base.VerifyClsCompliance ())
 354                                 return false;
 355
 356                         VerifyClsName ();
 357
 358                         if (UnderlyingType == TypeManager.uint32_type ||
 359                                 UnderlyingType == TypeManager.uint64_type ||
 360                                 UnderlyingType == TypeManager.ushort_type) {
 361                                 Report.Error (3009, Location, "`{0}': base type `{1}' is not CLS-compliant", GetSignatureForError (), TypeManager.CSharpName (UnderlyingType));
 362                         }
 363
 364                         return true;
 365                 }
 366
 367
 368                 public override MemberCache MemberCache {
 369                         get {
 370                                 return null;
 371                         }
 372                 }
 373
 374                 public override AttributeTargets AttributeTargets {
 375                         get {
 376                                 return AttributeTargets.Enum;
 377                         }
 378                 }
 379
 380                 protected override TypeAttributes TypeAttr {
 381                         get {
 382                                 return Modifiers.TypeAttr (ModFlags, IsTopLevel) |
 383                                 TypeAttributes.Class | TypeAttributes.Sealed |
 384                                 base.TypeAttr;
 385                         }
 386                 }
 387
 388                 //
 389                 // Generates xml doc comments (if any), and if required,
 390                 // handle warning report.
 391                 //
 392                 internal override void GenerateDocComment (DeclSpace ds)
 393                 {
 394                         base.GenerateDocComment (ds);
 395
 396                         foreach (EnumMember em in defined_names.Values) {
 397                                 em.GenerateDocComment (this);
 398                         }
 399                 }
 400
 401                 //
 402                 //   Represents header string for documentation comment.
 403                 //
 404                 public override string DocCommentHeader {
 405                         get { return "T:"; }
 406                 }
 407         }
 408 }