2 // property.cs: Property based handlers
4 // Authors: Miguel de Icaza (miguel@gnu.org)
5 // Martin Baulig (martin@ximian.com)
6 // Marek Safar (marek.safar@seznam.cz)
8 // Dual licensed under the terms of the MIT X11 or GNU GPL
10 // Copyright 2001, 2002, 2003 Ximian, Inc (http://www.ximian.com)
11 // Copyright 2004-2008 Novell, Inc
15 using System.Collections.Generic;
16 using System.Reflection;
17 using System.Reflection.Emit;
18 using System.Runtime.CompilerServices;
19 using System.Runtime.InteropServices;
20 using System.Security;
21 using System.Security.Permissions;
25 using XmlElement = System.Object;
30 using Mono.CompilerServices.SymbolWriter;
34 // It is used as a base class for all property based members
35 // This includes properties, indexers, and events
36 public abstract class PropertyBasedMember : InterfaceMemberBase
38 public PropertyBasedMember (DeclSpace parent, GenericMethod generic,
39 FullNamedExpression type, Modifiers mod, Modifiers allowed_mod,
40 MemberName name, Attributes attrs)
41 : base (parent, generic, type, mod, allowed_mod, name, attrs)
45 protected void CheckReservedNameConflict (string prefix, MethodSpec accessor)
48 AParametersCollection parameters;
49 if (accessor != null) {
51 parameters = accessor.Parameters;
53 name = prefix + ShortName;
55 name = MemberName.Left + "." + name;
57 if (this is Indexer) {
58 parameters = ((Indexer) this).ParameterInfo;
59 if (prefix[0] == 's') {
60 var data = new IParameterData[parameters.Count + 1];
61 Array.Copy (parameters.FixedParameters, data, data.Length - 1);
62 data[data.Length - 1] = new ParameterData ("value", Parameter.Modifier.NONE);
63 var types = new TypeSpec[data.Length];
64 Array.Copy (parameters.Types, types, data.Length - 1);
65 types[data.Length - 1] = member_type;
67 parameters = new ParametersImported (data, types, false);
71 parameters = ParametersCompiled.CreateFullyResolved (new[] { member_type });
73 parameters = ParametersCompiled.EmptyReadOnlyParameters;
77 var conflict = MemberCache.FindMember (Parent.Definition,
78 new MemberFilter (name, 0, MemberKind.Method, parameters, null),
79 BindingRestriction.DeclaredOnly | BindingRestriction.NoAccessors);
81 if (conflict != null) {
82 Report.SymbolRelatedToPreviousError (conflict);
83 Report.Error (82, Location, "A member `{0}' is already reserved", conflict.GetSignatureForError ());
87 protected override bool VerifyClsCompliance ()
89 if (!base.VerifyClsCompliance ())
92 if (!MemberType.IsCLSCompliant ()) {
93 Report.Warning (3003, 1, Location, "Type of `{0}' is not CLS-compliant",
94 GetSignatureForError ());
101 public class PropertySpec : MemberSpec, IInterfaceMemberSpec
107 public PropertySpec (MemberKind kind, TypeSpec declaringType, IMemberDefinition definition, TypeSpec memberType, PropertyInfo info, Modifiers modifiers)
108 : base (kind, declaringType, definition, modifiers)
111 this.memberType = memberType;
116 public MethodSpec Get {
122 get.IsAccessor = true;
126 public MethodSpec Set {
132 set.IsAccessor = true;
136 public bool IsNotRealProperty {
138 return (state & StateFlags.IsNotRealProperty) != 0;
141 state |= StateFlags.IsNotRealProperty;
145 public bool HasDifferentAccessibility {
147 return HasGet && HasSet &&
148 (Get.Modifiers & Modifiers.AccessibilityMask) != (Set.Modifiers & Modifiers.AccessibilityMask);
164 public PropertyInfo MetaInfo {
166 if ((state & StateFlags.PendingMetaInflate) != 0)
167 throw new NotSupportedException ();
173 public TypeSpec MemberType {
181 public override MemberSpec InflateMember (TypeParameterInflator inflator)
183 var ps = (PropertySpec) base.InflateMember (inflator);
184 ps.memberType = inflator.Inflate (memberType);
190 // Properties and Indexers both generate PropertyBuilders, we use this to share
191 // their common bits.
193 abstract public class PropertyBase : PropertyBasedMember {
195 public class GetMethod : PropertyMethod
197 static string[] attribute_targets = new string [] { "method", "return" };
199 internal const string Prefix = "get_";
201 public GetMethod (PropertyBase method, Modifiers modifiers, Attributes attrs, Location loc)
202 : base (method, Prefix, modifiers, attrs, loc)
206 public override MethodBuilder Define (DeclSpace parent)
208 base.Define (parent);
210 Spec = new MethodSpec (MemberKind.Method, parent.PartialContainer.Definition, this, ReturnType, null, ParameterInfo, ModFlags);
212 method_data = new MethodData (method, ModFlags, flags, this);
214 if (!method_data.Define (parent, method.GetFullName (MemberName), Report))
217 Spec.SetMetaInfo (method_data.MethodBuilder);
219 return method_data.MethodBuilder;
222 public override TypeSpec ReturnType {
224 return method.MemberType;
228 public override ParametersCompiled ParameterInfo {
230 return ParametersCompiled.EmptyReadOnlyParameters;
234 public override string[] ValidAttributeTargets {
236 return attribute_targets;
241 public class SetMethod : PropertyMethod {
243 static string[] attribute_targets = new string [] { "method", "param", "return" };
245 internal const string Prefix = "set_";
247 ImplicitParameter param_attr;
248 protected ParametersCompiled parameters;
250 public SetMethod (PropertyBase method, Modifiers modifiers, ParametersCompiled parameters, Attributes attrs, Location loc)
251 : base (method, Prefix, modifiers, attrs, loc)
253 this.parameters = parameters;
256 protected override void ApplyToExtraTarget (Attribute a, MethodSpec ctor, byte[] cdata, PredefinedAttributes pa)
258 if (a.Target == AttributeTargets.Parameter) {
259 if (param_attr == null)
260 param_attr = new ImplicitParameter (method_data.MethodBuilder);
262 param_attr.ApplyAttributeBuilder (a, ctor, cdata, pa);
266 base.ApplyAttributeBuilder (a, ctor, cdata, pa);
269 public override ParametersCompiled ParameterInfo {
275 public override MethodBuilder Define (DeclSpace parent)
277 parameters.Resolve (this);
279 base.Define (parent);
281 Spec = new MethodSpec (MemberKind.Method, parent.PartialContainer.Definition, this, ReturnType, null, ParameterInfo, ModFlags);
283 method_data = new MethodData (method, ModFlags, flags, this);
285 if (!method_data.Define (parent, method.GetFullName (MemberName), Report))
288 Spec.SetMetaInfo (method_data.MethodBuilder);
290 return method_data.MethodBuilder;
293 public override TypeSpec ReturnType {
295 return TypeManager.void_type;
299 public override string[] ValidAttributeTargets {
301 return attribute_targets;
306 static string[] attribute_targets = new string [] { "property" };
308 public abstract class PropertyMethod : AbstractPropertyEventMethod
310 public const Modifiers AllowedModifiers =
312 Modifiers.PROTECTED |
316 protected readonly PropertyBase method;
317 protected MethodAttributes flags;
319 public PropertyMethod (PropertyBase method, string prefix, Modifiers modifiers, Attributes attrs, Location loc)
320 : base (method, prefix, attrs, loc)
322 this.method = method;
323 this.ModFlags = modifiers | (method.ModFlags & (Modifiers.STATIC | Modifiers.UNSAFE));
326 public override void ApplyAttributeBuilder (Attribute a, MethodSpec ctor, byte[] cdata, PredefinedAttributes pa)
328 if (a.IsInternalMethodImplAttribute) {
329 method.is_external_implementation = true;
332 base.ApplyAttributeBuilder (a, ctor, cdata, pa);
335 public override AttributeTargets AttributeTargets {
337 return AttributeTargets.Method;
341 public override bool IsClsComplianceRequired ()
343 return method.IsClsComplianceRequired ();
346 public virtual MethodBuilder Define (DeclSpace parent)
348 TypeContainer container = parent.PartialContainer;
351 // Check for custom access modifier
353 if ((ModFlags & Modifiers.AccessibilityMask) == 0) {
354 ModFlags |= method.ModFlags;
355 flags = method.flags;
357 if (container.Kind == MemberKind.Interface)
358 Report.Error (275, Location, "`{0}': accessibility modifiers may not be used on accessors in an interface",
359 GetSignatureForError ());
361 if ((method.ModFlags & Modifiers.ABSTRACT) != 0 && (ModFlags & Modifiers.PRIVATE) != 0) {
362 Report.Error (442, Location, "`{0}': abstract properties cannot have private accessors", GetSignatureForError ());
365 CheckModifiers (ModFlags);
366 ModFlags |= (method.ModFlags & (~Modifiers.AccessibilityMask));
367 ModFlags |= Modifiers.PROPERTY_CUSTOM;
368 flags = ModifiersExtensions.MethodAttr (ModFlags);
369 flags |= (method.flags & (~MethodAttributes.MemberAccessMask));
372 CheckAbstractAndExtern (block != null);
373 CheckProtectedModifier ();
375 if (block != null && block.IsIterator)
376 Iterator.CreateIterator (this, Parent.PartialContainer, ModFlags, Compiler);
381 public bool HasCustomAccessModifier {
383 return (ModFlags & Modifiers.PROPERTY_CUSTOM) != 0;
387 public PropertyBase Property {
393 public override ObsoleteAttribute GetAttributeObsolete ()
395 return method.GetAttributeObsolete ();
398 public override string GetSignatureForError()
400 return method.GetSignatureForError () + "." + prefix.Substring (0, 3);
403 void CheckModifiers (Modifiers modflags)
405 if (!ModifiersExtensions.IsRestrictedModifier (modflags & Modifiers.AccessibilityMask, method.ModFlags & Modifiers.AccessibilityMask)) {
406 Report.Error (273, Location,
407 "The accessibility modifier of the `{0}' accessor must be more restrictive than the modifier of the property or indexer `{1}'",
408 GetSignatureForError (), method.GetSignatureForError ());
413 PropertyMethod get, set, first;
414 PropertyBuilder PropertyBuilder;
416 public PropertyBase (DeclSpace parent, FullNamedExpression type, Modifiers mod_flags,
417 Modifiers allowed_mod, MemberName name, Attributes attrs)
418 : base (parent, null, type, mod_flags, allowed_mod, name, attrs)
424 public override AttributeTargets AttributeTargets {
426 return AttributeTargets.Property;
430 public PropertyMethod AccessorFirst {
436 public PropertyMethod AccessorSecond {
438 return first == get ? set : get;
442 public PropertyMethod Get {
451 Parent.AddMember (get);
455 public PropertyMethod Set {
464 Parent.AddMember (set);
468 public override string[] ValidAttributeTargets {
470 return attribute_targets;
476 public override void ApplyAttributeBuilder (Attribute a, MethodSpec ctor, byte[] cdata, PredefinedAttributes pa)
478 if (a.HasSecurityAttribute) {
479 a.Error_InvalidSecurityParent ();
483 if (a.Type == pa.Dynamic) {
484 a.Error_MisusedDynamicAttribute ();
488 PropertyBuilder.SetCustomAttribute ((ConstructorInfo) ctor.GetMetaInfo (), cdata);
491 void CheckMissingAccessor (MemberKind kind, ParametersCompiled parameters, bool get)
493 if (IsExplicitImpl) {
495 if (kind == MemberKind.Indexer)
496 filter = new MemberFilter (MemberCache.IndexerNameAlias, 0, kind, parameters, null);
498 filter = new MemberFilter (MemberName.Name, 0, kind, null, null);
500 var implementing = MemberCache.FindMember (InterfaceType, filter, BindingRestriction.DeclaredOnly) as PropertySpec;
502 if (implementing == null)
505 var accessor = get ? implementing.Get : implementing.Set;
506 if (accessor != null) {
507 Report.SymbolRelatedToPreviousError (accessor);
508 Report.Error (551, Location, "Explicit interface implementation `{0}' is missing accessor `{1}'",
509 GetSignatureForError (), accessor.GetSignatureForError ());
514 protected override bool CheckOverrideAgainstBase (MemberSpec base_member)
516 var ok = base.CheckOverrideAgainstBase (base_member);
519 // Check base property accessors conflict
521 var base_prop = (PropertySpec) base_member;
523 if (!base_prop.HasGet) {
525 Report.SymbolRelatedToPreviousError (base_prop);
526 Report.Error (545, Get.Location,
527 "`{0}': cannot override because `{1}' does not have an overridable get accessor",
528 Get.GetSignatureForError (), base_prop.GetSignatureForError ());
531 } else if (Get.HasCustomAccessModifier || base_prop.HasDifferentAccessibility) {
532 if (!CheckAccessModifiers (Get, base_prop.Get)) {
533 Error_CannotChangeAccessModifiers (Get, base_prop.Get);
540 if (!base_prop.HasSet) {
542 Report.SymbolRelatedToPreviousError (base_prop);
543 Report.Error (546, Set.Location,
544 "`{0}': cannot override because `{1}' does not have an overridable set accessor",
545 Set.GetSignatureForError (), base_prop.GetSignatureForError ());
548 } else if (Set.HasCustomAccessModifier || base_prop.HasDifferentAccessibility) {
549 if (!CheckAccessModifiers (Set, base_prop.Set)) {
550 Error_CannotChangeAccessModifiers (Set, base_prop.Set);
556 if ((Set == null || !Set.HasCustomAccessModifier) && (Get == null || !Get.HasCustomAccessModifier)) {
557 if (!CheckAccessModifiers (this, base_prop)) {
558 Error_CannotChangeAccessModifiers (this, base_prop);
566 protected override void DoMemberTypeDependentChecks ()
568 base.DoMemberTypeDependentChecks ();
572 if (MemberType.IsStatic)
573 Error_StaticReturnType ();
576 protected override void DoMemberTypeIndependentChecks ()
578 base.DoMemberTypeIndependentChecks ();
581 // Accessors modifiers check
583 if (AccessorSecond != null) {
584 if ((Get.ModFlags & Modifiers.AccessibilityMask) != 0 && (Set.ModFlags & Modifiers.AccessibilityMask) != 0) {
585 Report.Error (274, Location, "`{0}': Cannot specify accessibility modifiers for both accessors of the property or indexer",
586 GetSignatureForError ());
588 } else if ((ModFlags & Modifiers.OVERRIDE) == 0 &&
589 (Get == null && (Set.ModFlags & Modifiers.AccessibilityMask) != 0) ||
590 (Set == null && (Get.ModFlags & Modifiers.AccessibilityMask) != 0)) {
591 Report.Error (276, Location,
592 "`{0}': accessibility modifiers on accessors may only be used if the property or indexer has both a get and a set accessor",
593 GetSignatureForError ());
597 protected bool DefineAccessors ()
599 first.Define (Parent);
600 if (AccessorSecond != null)
601 AccessorSecond.Define (Parent);
606 protected void DefineBuilders (MemberKind kind, ParametersCompiled parameters)
608 PropertyBuilder = Parent.TypeBuilder.DefineProperty (
609 GetFullName (MemberName), PropertyAttributes.None,
610 #if !BOOTSTRAP_BASIC // Requires trunk version mscorlib
611 IsStatic ? 0 : CallingConventions.HasThis,
613 MemberType.GetMetaInfo (), null, null,
614 parameters.GetMetaInfo (), null, null);
617 if (kind == MemberKind.Indexer)
618 spec = new IndexerSpec (Parent.Definition, this, MemberType, parameters, PropertyBuilder, ModFlags);
620 spec = new PropertySpec (kind, Parent.Definition, this, MemberType, PropertyBuilder, ModFlags);
625 var method = Get.Spec.GetMetaInfo () as MethodBuilder;
626 if (method != null) {
627 PropertyBuilder.SetGetMethod (method);
628 Parent.MemberCache.AddMember (this, method.Name, Get.Spec);
631 CheckMissingAccessor (kind, parameters, true);
637 var method = Set.Spec.GetMetaInfo () as MethodBuilder;
638 if (method != null) {
639 PropertyBuilder.SetSetMethod (method);
640 Parent.MemberCache.AddMember (this, method.Name, Set.Spec);
643 CheckMissingAccessor (kind, parameters, false);
646 Parent.MemberCache.AddMember (this, PropertyBuilder.Name, spec);
649 public override void Emit ()
651 CheckReservedNameConflict (GetMethod.Prefix, get == null ? null : get.Spec);
652 CheckReservedNameConflict (SetMethod.Prefix, set == null ? null : set.Spec);
654 if (OptAttributes != null)
655 OptAttributes.Emit ();
657 if (member_type == InternalType.Dynamic) {
658 PredefinedAttributes.Get.Dynamic.EmitAttribute (PropertyBuilder);
660 var trans_flags = TypeManager.HasDynamicTypeUsed (member_type);
661 if (trans_flags != null) {
662 var pa = PredefinedAttributes.Get.DynamicTransform;
663 if (pa.Constructor != null || pa.ResolveConstructor (Location, ArrayContainer.MakeType (TypeManager.bool_type))) {
664 PropertyBuilder.SetCustomAttribute (
665 new CustomAttributeBuilder (pa.Constructor, new object[] { trans_flags }));
671 if (AccessorSecond != null)
672 AccessorSecond.Emit (Parent);
677 public override bool IsUsed {
682 return Get.IsUsed | Set.IsUsed;
686 protected override void SetMemberName (MemberName new_name)
688 base.SetMemberName (new_name);
691 Get.UpdateName (this);
694 Set.UpdateName (this);
698 // Represents header string for documentation comment.
700 public override string DocCommentHeader {
705 public class Property : PropertyBase
707 public sealed class BackingField : Field
709 readonly Property property;
711 public BackingField (Property p)
712 : base (p.Parent, p.type_expr,
713 Modifiers.BACKING_FIELD | Modifiers.COMPILER_GENERATED | Modifiers.PRIVATE | (p.ModFlags & (Modifiers.STATIC | Modifiers.UNSAFE)),
714 new MemberName ("<" + p.GetFullName (p.MemberName) + ">k__BackingField", p.Location), null)
719 public string OriginalName {
721 return property.Name;
725 public override string GetSignatureForError ()
727 return property.GetSignatureForError ();
731 public Property (DeclSpace parent, FullNamedExpression type, Modifiers mod,
732 MemberName name, Attributes attrs)
733 : base (parent, type, mod,
734 parent.PartialContainer.Kind == MemberKind.Interface ? AllowedModifiersInterface :
735 parent.PartialContainer.Kind == MemberKind.Struct ? AllowedModifiersStruct :
736 AllowedModifiersClass,
741 void CreateAutomaticProperty ()
743 // Create backing field
744 Field field = new BackingField (this);
745 if (!field.Define ())
748 Parent.PartialContainer.AddField (field);
750 FieldExpr fe = new FieldExpr (field, Location);
751 if ((field.ModFlags & Modifiers.STATIC) == 0)
752 fe.InstanceExpression = new CompilerGeneratedThis (fe.Type, Location);
755 Get.Block = new ToplevelBlock (Compiler, ParametersCompiled.EmptyReadOnlyParameters, Location);
756 Return r = new Return (fe, Location);
757 Get.Block.AddStatement (r);
760 Set.Block = new ToplevelBlock (Compiler, Set.ParameterInfo, Location);
761 Assign a = new SimpleAssign (fe, new SimpleName ("value", Location));
762 Set.Block.AddStatement (new StatementExpression (a));
765 public override bool Define ()
770 flags |= MethodAttributes.HideBySig | MethodAttributes.SpecialName;
772 if (!IsInterface && (ModFlags & (Modifiers.ABSTRACT | Modifiers.EXTERN)) == 0 &&
773 AccessorSecond != null && Get.Block == null && Set.Block == null) {
774 if (RootContext.Version <= LanguageVersion.ISO_2)
775 Report.FeatureIsNotAvailable (Location, "automatically implemented properties");
777 Get.ModFlags |= Modifiers.COMPILER_GENERATED;
778 Set.ModFlags |= Modifiers.COMPILER_GENERATED;
779 CreateAutomaticProperty ();
782 if (!DefineAccessors ())
788 DefineBuilders (MemberKind.Property, ParametersCompiled.EmptyReadOnlyParameters);
792 public override void Emit ()
794 if ((AccessorFirst.ModFlags & (Modifiers.STATIC | Modifiers.COMPILER_GENERATED)) == Modifiers.COMPILER_GENERATED && Parent.PartialContainer.HasExplicitLayout) {
795 Report.Error (842, Location,
796 "Automatically implemented property `{0}' cannot be used inside a type with an explicit StructLayout attribute",
797 GetSignatureForError ());
803 public override string GetDocCommentName (DeclSpace ds)
805 return String.Concat (DocCommentHeader, ds.Name, ".", GetFullName (ShortName).Replace ('.', '#'));
810 /// For case when event is declared like property (with add and remove accessors).
812 public class EventProperty: Event {
813 public abstract class AEventPropertyAccessor : AEventAccessor
815 protected AEventPropertyAccessor (EventProperty method, string prefix, Attributes attrs, Location loc)
816 : base (method, prefix, attrs, loc)
820 public override MethodBuilder Define (DeclSpace ds)
822 CheckAbstractAndExtern (block != null);
823 return base.Define (ds);
826 public override string GetSignatureForError ()
828 return method.GetSignatureForError () + "." + prefix.Substring (0, prefix.Length - 1);
832 public sealed class AddDelegateMethod: AEventPropertyAccessor
834 public AddDelegateMethod (EventProperty method, Attributes attrs, Location loc)
835 : base (method, AddPrefix, attrs, loc)
840 public sealed class RemoveDelegateMethod: AEventPropertyAccessor
842 public RemoveDelegateMethod (EventProperty method, Attributes attrs, Location loc)
843 : base (method, RemovePrefix, attrs, loc)
848 static readonly string[] attribute_targets = new string [] { "event" };
850 public EventProperty (DeclSpace parent, FullNamedExpression type, Modifiers mod_flags, MemberName name, Attributes attrs)
851 : base (parent, type, mod_flags, name, attrs)
855 public override bool Define()
864 public override string[] ValidAttributeTargets {
866 return attribute_targets;
872 /// Event is declared like field.
874 public class EventField : Event {
875 abstract class EventFieldAccessor : AEventAccessor
877 protected EventFieldAccessor (EventField method, string prefix)
878 : base (method, prefix, null, Location.Null)
882 public override void Emit (DeclSpace parent)
884 if ((method.ModFlags & (Modifiers.ABSTRACT | Modifiers.EXTERN)) == 0) {
885 if (parent is Class) {
886 MethodBuilder mb = method_data.MethodBuilder;
887 mb.SetImplementationFlags (mb.GetMethodImplementationFlags () | MethodImplAttributes.Synchronized);
890 var field_info = ((EventField) method).backing_field;
891 FieldExpr f_expr = new FieldExpr (field_info, Location);
892 if ((method.ModFlags & Modifiers.STATIC) == 0)
893 f_expr.InstanceExpression = new CompilerGeneratedThis (field_info.Spec.MemberType, Location);
895 block = new ToplevelBlock (Compiler, ParameterInfo, Location);
896 block.AddStatement (new StatementExpression (
897 new CompoundAssign (Operation,
899 block.GetParameterReference (ParameterInfo[0].Name, Location),
906 protected abstract Binary.Operator Operation { get; }
909 sealed class AddDelegateMethod: EventFieldAccessor
911 public AddDelegateMethod (EventField method):
912 base (method, AddPrefix)
916 protected override Binary.Operator Operation {
917 get { return Binary.Operator.Addition; }
921 sealed class RemoveDelegateMethod: EventFieldAccessor
923 public RemoveDelegateMethod (EventField method):
924 base (method, RemovePrefix)
928 protected override Binary.Operator Operation {
929 get { return Binary.Operator.Subtraction; }
934 static readonly string[] attribute_targets = new string [] { "event", "field", "method" };
935 static readonly string[] attribute_targets_interface = new string[] { "event", "method" };
937 Expression initializer;
939 List<FieldDeclarator> declarators;
941 public EventField (DeclSpace parent, FullNamedExpression type, Modifiers mod_flags, MemberName name, Attributes attrs)
942 : base (parent, type, mod_flags, name, attrs)
944 Add = new AddDelegateMethod (this);
945 Remove = new RemoveDelegateMethod (this);
950 bool HasBackingField {
952 return !IsInterface && (ModFlags & Modifiers.ABSTRACT) == 0;
956 public Expression Initializer {
965 public override string[] ValidAttributeTargets {
967 return HasBackingField ? attribute_targets : attribute_targets_interface;
973 public void AddDeclarator (FieldDeclarator declarator)
975 if (declarators == null)
976 declarators = new List<FieldDeclarator> (2);
978 declarators.Add (declarator);
980 // TODO: This will probably break
981 Parent.AddMember (this, declarator.Name.Value);
984 public override void ApplyAttributeBuilder (Attribute a, MethodSpec ctor, byte[] cdata, PredefinedAttributes pa)
986 if (a.Target == AttributeTargets.Field) {
987 backing_field.ApplyAttributeBuilder (a, ctor, cdata, pa);
991 if (a.Target == AttributeTargets.Method) {
992 int errors = Report.Errors;
993 Add.ApplyAttributeBuilder (a, ctor, cdata, pa);
994 if (errors == Report.Errors)
995 Remove.ApplyAttributeBuilder (a, ctor, cdata, pa);
999 base.ApplyAttributeBuilder (a, ctor, cdata, pa);
1002 public override bool Define()
1004 if (!base.Define ())
1007 if (declarators != null) {
1008 var t = new TypeExpression (MemberType, TypeExpression.Location);
1009 int index = Parent.PartialContainer.Events.IndexOf (this);
1010 foreach (var d in declarators) {
1011 var ef = new EventField (Parent, t, ModFlags, new MemberName (d.Name.Value, d.Name.Location), OptAttributes);
1013 if (d.Initializer != null)
1014 ef.initializer = d.Initializer;
1016 Parent.PartialContainer.Events.Insert (++index, ef);
1020 if (!HasBackingField) {
1025 if (Add.IsInterfaceImplementation)
1028 backing_field = new Field (Parent,
1029 new TypeExpression (MemberType, Location),
1030 Modifiers.BACKING_FIELD | Modifiers.COMPILER_GENERATED | Modifiers.PRIVATE | (ModFlags & (Modifiers.STATIC | Modifiers.UNSAFE)),
1033 Parent.PartialContainer.AddField (backing_field);
1034 backing_field.Initializer = Initializer;
1035 backing_field.ModFlags &= ~Modifiers.COMPILER_GENERATED;
1037 // Call define because we passed fields definition
1038 backing_field.Define ();
1040 // Set backing field for event fields
1041 spec.BackingField = backing_field.Spec;
1047 public abstract class Event : PropertyBasedMember {
1048 public abstract class AEventAccessor : AbstractPropertyEventMethod
1050 protected readonly Event method;
1051 ImplicitParameter param_attr;
1052 ParametersCompiled parameters;
1054 static readonly string[] attribute_targets = new string [] { "method", "param", "return" };
1056 public const string AddPrefix = "add_";
1057 public const string RemovePrefix = "remove_";
1059 protected AEventAccessor (Event method, string prefix, Attributes attrs, Location loc)
1060 : base (method, prefix, attrs, loc)
1062 this.method = method;
1063 this.ModFlags = method.ModFlags;
1064 this.parameters = ParametersCompiled.CreateImplicitParameter (method.TypeExpression, loc);;
1067 public bool IsInterfaceImplementation {
1068 get { return method_data.implementing != null; }
1071 public override void ApplyAttributeBuilder (Attribute a, MethodSpec ctor, byte[] cdata, PredefinedAttributes pa)
1073 if (a.IsInternalMethodImplAttribute) {
1074 method.is_external_implementation = true;
1077 base.ApplyAttributeBuilder (a, ctor, cdata, pa);
1080 protected override void ApplyToExtraTarget (Attribute a, MethodSpec ctor, byte[] cdata, PredefinedAttributes pa)
1082 if (a.Target == AttributeTargets.Parameter) {
1083 if (param_attr == null)
1084 param_attr = new ImplicitParameter (method_data.MethodBuilder);
1086 param_attr.ApplyAttributeBuilder (a, ctor, cdata, pa);
1090 base.ApplyAttributeBuilder (a, ctor, cdata, pa);
1093 public override AttributeTargets AttributeTargets {
1095 return AttributeTargets.Method;
1099 public override bool IsClsComplianceRequired ()
1101 return method.IsClsComplianceRequired ();
1104 public virtual MethodBuilder Define (DeclSpace parent)
1106 parameters.Resolve (this);
1108 method_data = new MethodData (method, method.ModFlags,
1109 method.flags | MethodAttributes.HideBySig | MethodAttributes.SpecialName, this);
1111 if (!method_data.Define (parent, method.GetFullName (MemberName), Report))
1114 MethodBuilder mb = method_data.MethodBuilder;
1115 ParameterInfo.ApplyAttributes (mb);
1116 Spec = new MethodSpec (MemberKind.Method, parent.PartialContainer.Definition, this, ReturnType, mb, ParameterInfo, method.ModFlags);
1117 Spec.IsAccessor = true;
1122 public override TypeSpec ReturnType {
1124 return TypeManager.void_type;
1128 public override ObsoleteAttribute GetAttributeObsolete ()
1130 return method.GetAttributeObsolete ();
1133 public override string[] ValidAttributeTargets {
1135 return attribute_targets;
1139 public override ParametersCompiled ParameterInfo {
1146 AEventAccessor add, remove;
1147 EventBuilder EventBuilder;
1148 protected EventSpec spec;
1150 protected Event (DeclSpace parent, FullNamedExpression type, Modifiers mod_flags, MemberName name, Attributes attrs)
1151 : base (parent, null, type, mod_flags,
1152 parent.PartialContainer.Kind == MemberKind.Interface ? AllowedModifiersInterface :
1153 parent.PartialContainer.Kind == MemberKind.Struct ? AllowedModifiersStruct :
1154 AllowedModifiersClass,
1161 public override AttributeTargets AttributeTargets {
1163 return AttributeTargets.Event;
1167 public AEventAccessor Add {
1173 Parent.AddMember (value);
1177 public AEventAccessor Remove {
1183 Parent.AddMember (value);
1188 public override void ApplyAttributeBuilder (Attribute a, MethodSpec ctor, byte[] cdata, PredefinedAttributes pa)
1190 if ((a.HasSecurityAttribute)) {
1191 a.Error_InvalidSecurityParent ();
1195 EventBuilder.SetCustomAttribute ((ConstructorInfo) ctor.GetMetaInfo (), cdata);
1198 protected override bool CheckOverrideAgainstBase (MemberSpec base_member)
1200 var ok = base.CheckOverrideAgainstBase (base_member);
1202 if (!CheckAccessModifiers (this, base_member)) {
1203 Error_CannotChangeAccessModifiers (this, base_member);
1210 public override bool Define ()
1212 if (!base.Define ())
1215 if (!TypeManager.IsDelegateType (MemberType)) {
1216 Report.Error (66, Location, "`{0}': event must be of a delegate type", GetSignatureForError ());
1223 // Now define the accessors
1225 var AddBuilder = Add.Define (Parent);
1226 if (AddBuilder == null)
1229 var RemoveBuilder = remove.Define (Parent);
1230 if (RemoveBuilder == null)
1233 EventBuilder = Parent.TypeBuilder.DefineEvent (Name, EventAttributes.None, MemberType.GetMetaInfo ());
1234 EventBuilder.SetAddOnMethod (AddBuilder);
1235 EventBuilder.SetRemoveOnMethod (RemoveBuilder);
1237 spec = new EventSpec (Parent.Definition, this, MemberType, ModFlags, Add.Spec, remove.Spec);
1239 Parent.MemberCache.AddMember (this, Name, spec);
1240 Parent.MemberCache.AddMember (this, AddBuilder.Name, Add.Spec);
1241 Parent.MemberCache.AddMember (this, RemoveBuilder.Name, remove.Spec);
1246 public override void Emit ()
1248 CheckReservedNameConflict (null, add.Spec);
1249 CheckReservedNameConflict (null, remove.Spec);
1251 if (OptAttributes != null) {
1252 OptAttributes.Emit ();
1256 Remove.Emit (Parent);
1262 // Represents header string for documentation comment.
1264 public override string DocCommentHeader {
1265 get { return "E:"; }
1269 public class EventSpec : MemberSpec, IInterfaceMemberSpec
1271 MethodSpec add, remove;
1272 FieldSpec backing_field;
1274 public EventSpec (TypeSpec declaringType, IMemberDefinition definition, TypeSpec eventType, Modifiers modifiers, MethodSpec add, MethodSpec remove)
1275 : base (MemberKind.Event, declaringType, definition, modifiers)
1277 this.AccessorAdd = add;
1278 this.AccessorRemove = remove;
1279 this.MemberType = eventType;
1284 public MethodSpec AccessorAdd {
1293 public MethodSpec AccessorRemove {
1302 public FieldSpec BackingField {
1304 return backing_field;
1307 backing_field = value;
1311 public TypeSpec MemberType { get; private set; }
1315 public override MemberSpec InflateMember (TypeParameterInflator inflator)
1317 var es = (EventSpec) base.InflateMember (inflator);
1318 es.MemberType = inflator.Inflate (MemberType);
1323 public class Indexer : PropertyBase, IParametersMember
1325 public class GetIndexerMethod : GetMethod, IParametersMember
1327 ParametersCompiled parameters;
1329 public GetIndexerMethod (PropertyBase property, Modifiers modifiers, ParametersCompiled parameters, Attributes attrs, Location loc)
1330 : base (property, modifiers, attrs, loc)
1332 this.parameters = parameters;
1335 public override MethodBuilder Define (DeclSpace parent)
1337 parameters.Resolve (this);
1338 return base.Define (parent);
1341 public override ParametersCompiled ParameterInfo {
1347 #region IParametersMember Members
1349 AParametersCollection IParametersMember.Parameters {
1355 TypeSpec IInterfaceMemberSpec.MemberType {
1364 public class SetIndexerMethod : SetMethod, IParametersMember
1366 public SetIndexerMethod (PropertyBase property, Modifiers modifiers, ParametersCompiled parameters, Attributes attrs, Location loc)
1367 : base (property, modifiers, parameters, attrs, loc)
1371 #region IParametersMember Members
1373 AParametersCollection IParametersMember.Parameters {
1379 TypeSpec IInterfaceMemberSpec.MemberType {
1388 const Modifiers AllowedModifiers =
1391 Modifiers.PROTECTED |
1392 Modifiers.INTERNAL |
1396 Modifiers.OVERRIDE |
1401 const Modifiers AllowedInterfaceModifiers =
1404 readonly ParametersCompiled parameters;
1406 public Indexer (DeclSpace parent, FullNamedExpression type, MemberName name, Modifiers mod,
1407 ParametersCompiled parameters, Attributes attrs)
1408 : base (parent, type, mod,
1409 parent.PartialContainer.Kind == MemberKind.Interface ? AllowedInterfaceModifiers : AllowedModifiers,
1412 this.parameters = parameters;
1415 public override void ApplyAttributeBuilder (Attribute a, MethodSpec ctor, byte[] cdata, PredefinedAttributes pa)
1417 if (a.Type == pa.IndexerName) {
1418 if (IsExplicitImpl) {
1419 Report.Error (415, a.Location,
1420 "The `{0}' attribute is valid only on an indexer that is not an explicit interface member declaration",
1421 TypeManager.CSharpName (a.Type));
1424 // Attribute was copied to container
1428 base.ApplyAttributeBuilder (a, ctor, cdata, pa);
1431 protected override bool CheckForDuplications ()
1433 return Parent.MemberCache.CheckExistingMembersOverloads (this, parameters);
1436 public override bool Define ()
1438 if (!base.Define ())
1441 if (!DefineParameters (parameters))
1444 if (OptAttributes != null) {
1445 Attribute indexer_attr = OptAttributes.Search (PredefinedAttributes.Get.IndexerName);
1446 if (indexer_attr != null) {
1447 var compiling = indexer_attr.Type.MemberDefinition as TypeContainer;
1448 if (compiling != null)
1449 compiling.Define ();
1451 string name = indexer_attr.GetIndexerAttributeValue ();
1452 if ((ModFlags & Modifiers.OVERRIDE) != 0) {
1453 Report.Error (609, indexer_attr.Location,
1454 "Cannot set the `IndexerName' attribute on an indexer marked override");
1457 if (!string.IsNullOrEmpty (name))
1462 if (InterfaceType != null) {
1463 string base_IndexerName = InterfaceType.MemberDefinition.GetAttributeDefaultMember ();
1464 if (base_IndexerName != Name)
1465 ShortName = base_IndexerName;
1468 if (!Parent.PartialContainer.AddMember (this))
1471 flags |= MethodAttributes.HideBySig | MethodAttributes.SpecialName;
1473 if (!DefineAccessors ())
1479 DefineBuilders (MemberKind.Indexer, parameters);
1483 public override bool EnableOverloadChecks (MemberCore overload)
1485 if (overload is Indexer) {
1486 caching_flags |= Flags.MethodOverloadsExist;
1490 return base.EnableOverloadChecks (overload);
1493 public override string GetDocCommentName (DeclSpace ds)
1495 return DocUtil.GetMethodDocCommentName (this, parameters, ds);
1498 public override string GetSignatureForError ()
1500 StringBuilder sb = new StringBuilder (Parent.GetSignatureForError ());
1501 if (MemberName.Left != null) {
1503 sb.Append (MemberName.Left.GetSignatureForError ());
1506 sb.Append (".this");
1507 sb.Append (parameters.GetSignatureForError ().Replace ('(', '[').Replace (')', ']'));
1508 return sb.ToString ();
1511 public AParametersCollection Parameters {
1517 public ParametersCompiled ParameterInfo {
1523 protected override bool VerifyClsCompliance ()
1525 if (!base.VerifyClsCompliance ())
1528 parameters.VerifyClsCompliance (this);
1533 public class IndexerSpec : PropertySpec, IParametersMember
1535 AParametersCollection parameters;
1537 public IndexerSpec (TypeSpec declaringType, IMemberDefinition definition, TypeSpec memberType, AParametersCollection parameters, PropertyInfo info, Modifiers modifiers)
1538 : base (MemberKind.Indexer, declaringType, definition, memberType, info, modifiers)
1540 this.parameters = parameters;
1544 public AParametersCollection Parameters {
1551 public override string GetSignatureForError ()
1553 return DeclaringType.GetSignatureForError () + ".this" + parameters.GetSignatureForError ("[", "]", parameters.Count);
1556 public override MemberSpec InflateMember (TypeParameterInflator inflator)
1558 var spec = (IndexerSpec) base.InflateMember (inflator);
1559 spec.parameters = parameters.Inflate (inflator);