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
12 // Copyright 2011 Xamarin Inc
16 using System.Collections.Generic;
18 using Mono.CompilerServices.SymbolWriter;
21 using XmlElement = System.Object;
25 using IKVM.Reflection;
26 using IKVM.Reflection.Emit;
28 using System.Reflection;
29 using System.Reflection.Emit;
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 protected PropertyBasedMember (TypeDefinition parent, FullNamedExpression type, Modifiers mod, Modifiers allowed_mod, MemberName name, Attributes attrs)
39 : base (parent, type, mod, allowed_mod, name, attrs)
43 protected void CheckReservedNameConflict (string prefix, MethodSpec accessor)
46 AParametersCollection parameters;
47 if (accessor != null) {
49 parameters = accessor.Parameters;
51 name = prefix + ShortName;
53 name = MemberName.Left + "." + name;
55 if (this is Indexer) {
56 parameters = ((Indexer) this).ParameterInfo;
57 if (prefix[0] == 's') {
58 var data = new IParameterData[parameters.Count + 1];
59 Array.Copy (parameters.FixedParameters, data, data.Length - 1);
60 data[data.Length - 1] = new ParameterData ("value", Parameter.Modifier.NONE);
61 var types = new TypeSpec[data.Length];
62 Array.Copy (parameters.Types, types, data.Length - 1);
63 types[data.Length - 1] = member_type;
65 parameters = new ParametersImported (data, types, false);
69 parameters = ParametersCompiled.CreateFullyResolved (new[] { member_type });
71 parameters = ParametersCompiled.EmptyReadOnlyParameters;
75 var conflict = MemberCache.FindMember (Parent.Definition,
76 new MemberFilter (name, 0, MemberKind.Method, parameters, null),
77 BindingRestriction.DeclaredOnly | BindingRestriction.NoAccessors);
79 if (conflict != null) {
80 Report.SymbolRelatedToPreviousError (conflict);
81 Report.Error (82, Location, "A member `{0}' is already reserved", conflict.GetSignatureForError ());
85 protected override bool VerifyClsCompliance ()
87 if (!base.VerifyClsCompliance ())
90 if (!MemberType.IsCLSCompliant ()) {
91 Report.Warning (3003, 1, Location, "Type of `{0}' is not CLS-compliant",
92 GetSignatureForError ());
99 public class PropertySpec : MemberSpec, IInterfaceMemberSpec
105 public PropertySpec (MemberKind kind, TypeSpec declaringType, IMemberDefinition definition, TypeSpec memberType, PropertyInfo info, Modifiers modifiers)
106 : base (kind, declaringType, definition, modifiers)
109 this.memberType = memberType;
114 public MethodSpec Get {
120 get.IsAccessor = true;
124 public MethodSpec Set {
130 set.IsAccessor = true;
134 public bool HasDifferentAccessibility {
136 return HasGet && HasSet &&
137 (Get.Modifiers & Modifiers.AccessibilityMask) != (Set.Modifiers & Modifiers.AccessibilityMask);
153 public PropertyInfo MetaInfo {
155 if ((state & StateFlags.PendingMetaInflate) != 0)
156 throw new NotSupportedException ();
162 public TypeSpec MemberType {
170 public override MemberSpec InflateMember (TypeParameterInflator inflator)
172 var ps = (PropertySpec) base.InflateMember (inflator);
173 ps.memberType = inflator.Inflate (memberType);
177 public override List<MissingTypeSpecReference> ResolveMissingDependencies (MemberSpec caller)
179 return memberType.ResolveMissingDependencies (this);
184 // Properties and Indexers both generate PropertyBuilders, we use this to share
185 // their common bits.
187 abstract public class PropertyBase : PropertyBasedMember {
189 public class GetMethod : PropertyMethod
191 static readonly string[] attribute_targets = new string [] { "method", "return" };
193 internal const string Prefix = "get_";
195 public GetMethod (PropertyBase method, Modifiers modifiers, Attributes attrs, Location loc)
196 : base (method, Prefix, modifiers, attrs, loc)
200 public override void Define (TypeContainer parent)
202 base.Define (parent);
204 Spec = new MethodSpec (MemberKind.Method, parent.PartialContainer.Definition, this, ReturnType, ParameterInfo, ModFlags);
206 method_data = new MethodData (method, ModFlags, flags, this);
208 method_data.Define (parent.PartialContainer, method.GetFullName (MemberName));
211 public override TypeSpec ReturnType {
213 return method.MemberType;
217 public override ParametersCompiled ParameterInfo {
219 return ParametersCompiled.EmptyReadOnlyParameters;
223 public override string[] ValidAttributeTargets {
225 return attribute_targets;
230 public class SetMethod : PropertyMethod {
232 static readonly string[] attribute_targets = new string[] { "method", "param", "return" };
234 internal const string Prefix = "set_";
236 protected ParametersCompiled parameters;
238 public SetMethod (PropertyBase method, Modifiers modifiers, ParametersCompiled parameters, Attributes attrs, Location loc)
239 : base (method, Prefix, modifiers, attrs, loc)
241 this.parameters = parameters;
244 protected override void ApplyToExtraTarget (Attribute a, MethodSpec ctor, byte[] cdata, PredefinedAttributes pa)
246 if (a.Target == AttributeTargets.Parameter) {
247 parameters[parameters.Count - 1].ApplyAttributeBuilder (a, ctor, cdata, pa);
251 base.ApplyToExtraTarget (a, ctor, cdata, pa);
254 public override ParametersCompiled ParameterInfo {
260 public override void Define (TypeContainer parent)
262 parameters.Resolve (this);
264 base.Define (parent);
266 Spec = new MethodSpec (MemberKind.Method, parent.PartialContainer.Definition, this, ReturnType, ParameterInfo, ModFlags);
268 method_data = new MethodData (method, ModFlags, flags, this);
270 method_data.Define (parent.PartialContainer, method.GetFullName (MemberName));
273 public override TypeSpec ReturnType {
275 return Parent.Compiler.BuiltinTypes.Void;
279 public override string[] ValidAttributeTargets {
281 return attribute_targets;
286 static readonly string[] attribute_targets = new string[] { "property" };
288 public abstract class PropertyMethod : AbstractPropertyEventMethod
290 const Modifiers AllowedModifiers =
292 Modifiers.PROTECTED |
296 protected readonly PropertyBase method;
297 protected MethodAttributes flags;
299 public PropertyMethod (PropertyBase method, string prefix, Modifiers modifiers, Attributes attrs, Location loc)
300 : base (method, prefix, attrs, loc)
302 this.method = method;
303 this.ModFlags = ModifiersExtensions.Check (AllowedModifiers, modifiers, 0, loc, Report);
304 this.ModFlags |= (method.ModFlags & (Modifiers.STATIC | Modifiers.UNSAFE));
307 public override void ApplyAttributeBuilder (Attribute a, MethodSpec ctor, byte[] cdata, PredefinedAttributes pa)
309 if (a.Type == pa.MethodImpl) {
310 method.is_external_implementation = a.IsInternalCall ();
313 base.ApplyAttributeBuilder (a, ctor, cdata, pa);
316 public override AttributeTargets AttributeTargets {
318 return AttributeTargets.Method;
322 public override bool IsClsComplianceRequired ()
324 return method.IsClsComplianceRequired ();
327 public virtual void Define (TypeContainer parent)
329 var container = parent.PartialContainer;
332 // Check for custom access modifier
334 if ((ModFlags & Modifiers.AccessibilityMask) == 0) {
335 ModFlags |= method.ModFlags;
336 flags = method.flags;
338 CheckModifiers (ModFlags);
339 ModFlags |= (method.ModFlags & (~Modifiers.AccessibilityMask));
340 ModFlags |= Modifiers.PROPERTY_CUSTOM;
342 if (container.Kind == MemberKind.Interface) {
343 Report.Error (275, Location, "`{0}': accessibility modifiers may not be used on accessors in an interface",
344 GetSignatureForError ());
345 } else if ((ModFlags & Modifiers.PRIVATE) != 0) {
346 if ((method.ModFlags & Modifiers.ABSTRACT) != 0) {
347 Report.Error (442, Location, "`{0}': abstract properties cannot have private accessors", GetSignatureForError ());
350 ModFlags &= ~Modifiers.VIRTUAL;
353 flags = ModifiersExtensions.MethodAttr (ModFlags) | MethodAttributes.SpecialName;
356 CheckAbstractAndExtern (block != null);
357 CheckProtectedModifier ();
360 if (block.IsIterator)
361 Iterator.CreateIterator (this, Parent.PartialContainer, ModFlags);
363 if (Compiler.Settings.WriteMetadataOnly)
368 public bool HasCustomAccessModifier {
370 return (ModFlags & Modifiers.PROPERTY_CUSTOM) != 0;
374 public PropertyBase Property {
380 public override ObsoleteAttribute GetAttributeObsolete ()
382 return method.GetAttributeObsolete ();
385 public override string GetSignatureForError()
387 return method.GetSignatureForError () + "." + prefix.Substring (0, 3);
390 void CheckModifiers (Modifiers modflags)
392 if (!ModifiersExtensions.IsRestrictedModifier (modflags & Modifiers.AccessibilityMask, method.ModFlags & Modifiers.AccessibilityMask)) {
393 Report.Error (273, Location,
394 "The accessibility modifier of the `{0}' accessor must be more restrictive than the modifier of the property or indexer `{1}'",
395 GetSignatureForError (), method.GetSignatureForError ());
400 PropertyMethod get, set, first;
401 PropertyBuilder PropertyBuilder;
403 protected PropertyBase (TypeDefinition parent, FullNamedExpression type, Modifiers mod_flags, Modifiers allowed_mod, MemberName name, Attributes attrs)
404 : base (parent, type, mod_flags, allowed_mod, name, attrs)
410 public override AttributeTargets AttributeTargets {
412 return AttributeTargets.Property;
416 public PropertyMethod AccessorFirst {
422 public PropertyMethod AccessorSecond {
424 return first == get ? set : get;
428 public override Variance ExpectedMemberTypeVariance {
430 return (get != null && set != null) ?
431 Variance.None : set == null ?
433 Variance.Contravariant;
437 public PropertyMethod Get {
446 Parent.AddNameToContainer (get, get.MemberName.Basename);
450 public PropertyMethod Set {
459 Parent.AddNameToContainer (set, set.MemberName.Basename);
463 public override string[] ValidAttributeTargets {
465 return attribute_targets;
471 public override void ApplyAttributeBuilder (Attribute a, MethodSpec ctor, byte[] cdata, PredefinedAttributes pa)
473 if (a.HasSecurityAttribute) {
474 a.Error_InvalidSecurityParent ();
478 if (a.Type == pa.Dynamic) {
479 a.Error_MisusedDynamicAttribute ();
483 PropertyBuilder.SetCustomAttribute ((ConstructorInfo) ctor.GetMetaInfo (), cdata);
486 void CheckMissingAccessor (MemberKind kind, ParametersCompiled parameters, bool get)
488 if (IsExplicitImpl) {
490 if (kind == MemberKind.Indexer)
491 filter = new MemberFilter (MemberCache.IndexerNameAlias, 0, kind, parameters, null);
493 filter = new MemberFilter (MemberName.Name, 0, kind, null, null);
495 var implementing = MemberCache.FindMember (InterfaceType, filter, BindingRestriction.DeclaredOnly) as PropertySpec;
497 if (implementing == null)
500 var accessor = get ? implementing.Get : implementing.Set;
501 if (accessor != null) {
502 Report.SymbolRelatedToPreviousError (accessor);
503 Report.Error (551, Location, "Explicit interface implementation `{0}' is missing accessor `{1}'",
504 GetSignatureForError (), accessor.GetSignatureForError ());
509 protected override bool CheckOverrideAgainstBase (MemberSpec base_member)
511 var ok = base.CheckOverrideAgainstBase (base_member);
514 // Check base property accessors conflict
516 var base_prop = (PropertySpec) base_member;
518 if ((ModFlags & Modifiers.SEALED) != 0 && base_prop.HasGet && !base_prop.Get.IsAccessible (this)) {
519 // TODO: Should be different error code but csc uses for some reason same
520 Report.SymbolRelatedToPreviousError (base_prop);
521 Report.Error (545, Location,
522 "`{0}': cannot override because `{1}' does not have accessible get accessor",
523 GetSignatureForError (), base_prop.GetSignatureForError ());
527 if (!base_prop.HasGet) {
529 Report.SymbolRelatedToPreviousError (base_prop);
530 Report.Error (545, Get.Location,
531 "`{0}': cannot override because `{1}' does not have an overridable get accessor",
532 Get.GetSignatureForError (), base_prop.GetSignatureForError ());
535 } else if (Get.HasCustomAccessModifier || base_prop.HasDifferentAccessibility) {
536 if (!base_prop.Get.IsAccessible (this)) {
537 // Same as csc but it should be different error code
538 Report.Error (115, Get.Location, "`{0}' is marked as an override but no accessible `get' accessor found to override",
539 GetSignatureForError ());
541 } else if (!CheckAccessModifiers (Get, base_prop.Get)) {
542 Error_CannotChangeAccessModifiers (Get, base_prop.Get);
549 if (base_prop.HasSet) {
550 if ((ModFlags & Modifiers.SEALED) != 0 && !base_prop.Set.IsAccessible (this)) {
551 // TODO: Should be different error code but csc uses for some reason same
552 Report.SymbolRelatedToPreviousError (base_prop);
553 Report.Error (546, Location,
554 "`{0}': cannot override because `{1}' does not have accessible set accessor",
555 GetSignatureForError (), base_prop.GetSignatureForError ());
559 if ((ModFlags & Modifiers.AutoProperty) != 0) {
560 Report.Error (8080, Location, "`{0}': Auto-implemented properties must override all accessors of the overridden property",
561 GetSignatureForError ());
566 if (!base_prop.HasSet) {
568 Report.SymbolRelatedToPreviousError (base_prop);
569 Report.Error (546, Set.Location,
570 "`{0}': cannot override because `{1}' does not have an overridable set accessor",
571 Set.GetSignatureForError (), base_prop.GetSignatureForError ());
574 } else if (Set.HasCustomAccessModifier || base_prop.HasDifferentAccessibility) {
575 if (!base_prop.Set.IsAccessible (this)) {
576 // Same as csc but it should be different error code
577 Report.Error (115, Set.Location, "`{0}' is marked as an override but no accessible `set' accessor found to override",
578 GetSignatureForError ());
580 } else if (!CheckAccessModifiers (Set, base_prop.Set)) {
581 Error_CannotChangeAccessModifiers (Set, base_prop.Set);
587 if ((Set == null || !Set.HasCustomAccessModifier) && (Get == null || !Get.HasCustomAccessModifier)) {
588 if (!CheckAccessModifiers (this, base_prop)) {
589 Error_CannotChangeAccessModifiers (this, base_prop);
597 protected override void DoMemberTypeDependentChecks ()
599 base.DoMemberTypeDependentChecks ();
603 if (MemberType.IsStatic)
604 Error_StaticReturnType ();
607 protected override void DoMemberTypeIndependentChecks ()
609 base.DoMemberTypeIndependentChecks ();
612 // Accessors modifiers check
614 if (AccessorSecond != null) {
615 if ((Get.ModFlags & Modifiers.AccessibilityMask) != 0 && (Set.ModFlags & Modifiers.AccessibilityMask) != 0) {
616 Report.Error (274, Location, "`{0}': Cannot specify accessibility modifiers for both accessors of the property or indexer",
617 GetSignatureForError ());
619 } else if ((ModFlags & Modifiers.OVERRIDE) == 0 &&
620 ((Get == null && (Set.ModFlags & Modifiers.AccessibilityMask) != 0) || (Set == null && (Get.ModFlags & Modifiers.AccessibilityMask) != 0))) {
621 Report.Error (276, Location,
622 "`{0}': accessibility modifiers on accessors may only be used if the property or indexer has both a get and a set accessor",
623 GetSignatureForError ());
627 protected bool DefineAccessors ()
629 first.Define (Parent);
630 if (AccessorSecond != null)
631 AccessorSecond.Define (Parent);
636 protected void DefineBuilders (MemberKind kind, ParametersCompiled parameters)
638 PropertyBuilder = Parent.TypeBuilder.DefineProperty (
639 GetFullName (MemberName), PropertyAttributes.None,
640 #if !BOOTSTRAP_BASIC // Requires trunk version mscorlib
641 IsStatic ? 0 : CallingConventions.HasThis,
643 MemberType.GetMetaInfo (), null, null,
644 parameters.GetMetaInfo (), null, null);
647 if (kind == MemberKind.Indexer)
648 spec = new IndexerSpec (Parent.Definition, this, MemberType, parameters, PropertyBuilder, ModFlags);
650 spec = new PropertySpec (kind, Parent.Definition, this, MemberType, PropertyBuilder, ModFlags);
654 Parent.MemberCache.AddMember (this, Get.Spec.Name, Get.Spec);
656 CheckMissingAccessor (kind, parameters, true);
661 Parent.MemberCache.AddMember (this, Set.Spec.Name, Set.Spec);
663 CheckMissingAccessor (kind, parameters, false);
666 Parent.MemberCache.AddMember (this, PropertyBuilder.Name, spec);
669 public override void Emit ()
671 CheckReservedNameConflict (GetMethod.Prefix, get == null ? null : get.Spec);
672 CheckReservedNameConflict (SetMethod.Prefix, set == null ? null : set.Spec);
674 if (OptAttributes != null)
675 OptAttributes.Emit ();
677 if (member_type.BuiltinType == BuiltinTypeSpec.Type.Dynamic) {
678 Module.PredefinedAttributes.Dynamic.EmitAttribute (PropertyBuilder);
679 } else if (member_type.HasDynamicElement) {
680 Module.PredefinedAttributes.Dynamic.EmitAttribute (PropertyBuilder, member_type, Location);
683 ConstraintChecker.Check (this, member_type, type_expr.Location);
686 if (AccessorSecond != null)
687 AccessorSecond.Emit (Parent);
692 public override bool IsUsed {
697 return Get.IsUsed | Set.IsUsed;
701 public override void PrepareEmit ()
703 AccessorFirst.PrepareEmit ();
704 if (AccessorSecond != null)
705 AccessorSecond.PrepareEmit ();
708 var method = Get.Spec.GetMetaInfo () as MethodBuilder;
710 PropertyBuilder.SetGetMethod (method);
714 var method = Set.Spec.GetMetaInfo () as MethodBuilder;
716 PropertyBuilder.SetSetMethod (method);
720 protected override void SetMemberName (MemberName new_name)
722 base.SetMemberName (new_name);
725 Get.UpdateName (this);
728 Set.UpdateName (this);
731 public override void WriteDebugSymbol (MonoSymbolFile file)
734 get.WriteDebugSymbol (file);
737 set.WriteDebugSymbol (file);
741 // Represents header string for documentation comment.
743 public override string DocCommentHeader {
748 public class Property : PropertyBase
750 public sealed class BackingFieldDeclaration : Field
752 readonly Property property;
753 const Modifiers DefaultModifiers = Modifiers.BACKING_FIELD | Modifiers.COMPILER_GENERATED | Modifiers.PRIVATE | Modifiers.DEBUGGER_HIDDEN;
755 public BackingFieldDeclaration (Property p, bool readOnly)
756 : base (p.Parent, p.type_expr, DefaultModifiers | (p.ModFlags & (Modifiers.STATIC | Modifiers.UNSAFE)),
757 new MemberName ("<" + p.GetFullName (p.MemberName) + ">k__BackingField", p.Location), null)
761 ModFlags |= Modifiers.READONLY;
764 public Property OriginalProperty {
770 public override string GetSignatureForError ()
772 return property.GetSignatureForError ();
776 static readonly string[] attribute_target_auto = new string[] { "property", "field" };
778 public Property (TypeDefinition parent, FullNamedExpression type, Modifiers mod,
779 MemberName name, Attributes attrs)
780 : base (parent, type, mod,
781 parent.PartialContainer.Kind == MemberKind.Interface ? AllowedModifiersInterface :
782 parent.PartialContainer.Kind == MemberKind.Struct ? AllowedModifiersStruct :
783 AllowedModifiersClass,
788 public BackingFieldDeclaration BackingField { get; private set; }
790 public Expression Initializer { get; set; }
792 public override void Accept (StructuralVisitor visitor)
794 visitor.Visit (this);
797 public override void ApplyAttributeBuilder (Attribute a, MethodSpec ctor, byte[] cdata, PredefinedAttributes pa)
799 if (a.Target == AttributeTargets.Field) {
800 BackingField.ApplyAttributeBuilder (a, ctor, cdata, pa);
804 base.ApplyAttributeBuilder (a, ctor, cdata, pa);
807 void CreateAutomaticProperty ()
809 // Create backing field
810 BackingField = new BackingFieldDeclaration (this, Initializer == null && Set == null);
811 if (!BackingField.Define ())
814 if (Initializer != null) {
815 BackingField.Initializer = Initializer;
816 Parent.RegisterFieldForInitialization (BackingField, new FieldInitializer (BackingField, Initializer, Location));
817 BackingField.ModFlags |= Modifiers.READONLY;
820 Parent.PartialContainer.Members.Add (BackingField);
822 FieldExpr fe = new FieldExpr (BackingField, Location);
823 if ((BackingField.ModFlags & Modifiers.STATIC) == 0) {
824 fe.InstanceExpression = new CompilerGeneratedThis (Parent.CurrentType, Location);
825 Parent.PartialContainer.HasInstanceField = true;
829 // Create get block but we careful with location to
830 // emit only single sequence point per accessor. This allow
831 // to set a breakpoint on it even with no user code
833 Get.Block = new ToplevelBlock (Compiler, ParametersCompiled.EmptyReadOnlyParameters, Location.Null);
834 Return r = new Return (fe, Get.Location);
835 Get.Block.AddStatement (r);
836 Get.ModFlags |= Modifiers.COMPILER_GENERATED;
840 Set.Block = new ToplevelBlock (Compiler, Set.ParameterInfo, Location.Null);
841 Assign a = new SimpleAssign (fe, new SimpleName ("value", Location.Null), Location.Null);
842 Set.Block.AddStatement (new StatementExpression (a, Set.Location));
843 Set.ModFlags |= Modifiers.COMPILER_GENERATED;
847 public override bool Define ()
852 flags |= MethodAttributes.HideBySig | MethodAttributes.SpecialName;
854 bool auto = AccessorFirst.Block == null && (AccessorSecond == null || AccessorSecond.Block == null) &&
855 (ModFlags & (Modifiers.ABSTRACT | Modifiers.EXTERN)) == 0;
857 if (Initializer != null) {
859 Report.Error (8050, Location, "`{0}': Only auto-implemented properties can have initializers",
860 GetSignatureForError ());
863 Report.Error (8052, Location, "`{0}': Properties inside interfaces cannot have initializers",
864 GetSignatureForError ());
866 if (Compiler.Settings.Version < LanguageVersion.V_6)
867 Report.FeatureIsNotAvailable (Compiler, Location, "auto-implemented property initializer");
871 ModFlags |= Modifiers.AutoProperty;
873 Report.Error (8051, Location, "Auto-implemented property `{0}' must have get accessor",
874 GetSignatureForError ());
878 if (Compiler.Settings.Version < LanguageVersion.V_3 && Initializer == null)
879 Report.FeatureIsNotAvailable (Compiler, Location, "auto-implemented properties");
881 CreateAutomaticProperty ();
884 if (!DefineAccessors ())
887 if (AccessorSecond == null) {
889 if (AccessorFirst is GetMethod)
890 pm = new SetMethod (this, 0, ParametersCompiled.EmptyReadOnlyParameters, null, Location);
892 pm = new GetMethod (this, 0, null, Location);
894 Parent.AddNameToContainer (pm, pm.MemberName.Basename);
900 DefineBuilders (MemberKind.Property, ParametersCompiled.EmptyReadOnlyParameters);
904 public override void Emit ()
906 if ((AccessorFirst.ModFlags & (Modifiers.STATIC | Modifiers.AutoProperty)) == Modifiers.AutoProperty && Parent.PartialContainer.HasExplicitLayout) {
907 Report.Error (842, Location,
908 "Automatically implemented property `{0}' cannot be used inside a type with an explicit StructLayout attribute",
909 GetSignatureForError ());
915 public override string[] ValidAttributeTargets {
917 return Get != null && ((Get.ModFlags & Modifiers.COMPILER_GENERATED) != 0) ?
918 attribute_target_auto : base.ValidAttributeTargets;
924 /// For case when event is declared like property (with add and remove accessors).
926 public class EventProperty: Event {
927 public abstract class AEventPropertyAccessor : AEventAccessor
929 protected AEventPropertyAccessor (EventProperty method, string prefix, Attributes attrs, Location loc)
930 : base (method, prefix, attrs, loc)
934 public override void Define (TypeContainer ds)
936 CheckAbstractAndExtern (block != null);
940 public override string GetSignatureForError ()
942 return method.GetSignatureForError () + "." + prefix.Substring (0, prefix.Length - 1);
946 public sealed class AddDelegateMethod: AEventPropertyAccessor
948 public AddDelegateMethod (EventProperty method, Attributes attrs, Location loc)
949 : base (method, AddPrefix, attrs, loc)
954 public sealed class RemoveDelegateMethod: AEventPropertyAccessor
956 public RemoveDelegateMethod (EventProperty method, Attributes attrs, Location loc)
957 : base (method, RemovePrefix, attrs, loc)
962 static readonly string[] attribute_targets = new string [] { "event" };
964 public EventProperty (TypeDefinition parent, FullNamedExpression type, Modifiers mod_flags, MemberName name, Attributes attrs)
965 : base (parent, type, mod_flags, name, attrs)
969 public override void Accept (StructuralVisitor visitor)
971 visitor.Visit (this);
974 public override bool Define()
983 public override string[] ValidAttributeTargets {
985 return attribute_targets;
991 /// Event is declared like field.
993 public class EventField : Event
995 abstract class EventFieldAccessor : AEventAccessor
997 protected EventFieldAccessor (EventField method, string prefix)
998 : base (method, prefix, null, method.Location)
1002 protected abstract MethodSpec GetOperation (Location loc);
1004 public override void Emit (TypeDefinition parent)
1006 if ((method.ModFlags & (Modifiers.ABSTRACT | Modifiers.EXTERN)) == 0 && !Compiler.Settings.WriteMetadataOnly) {
1007 block = new ToplevelBlock (Compiler, ParameterInfo, Location) {
1008 IsCompilerGenerated = true
1010 FabricateBodyStatement ();
1016 void FabricateBodyStatement ()
1019 // Delegate obj1 = backing_field
1021 // Delegate obj2 = obj1;
1022 // obj1 = Interlocked.CompareExchange (ref backing_field, Delegate.Combine|Remove(obj2, value), obj1);
1023 // } while ((object)obj1 != (object)obj2)
1026 var field_info = ((EventField) method).backing_field;
1027 FieldExpr f_expr = new FieldExpr (field_info, Location);
1029 f_expr.InstanceExpression = new CompilerGeneratedThis (Parent.CurrentType, Location);
1031 var obj1 = LocalVariable.CreateCompilerGenerated (field_info.MemberType, block, Location);
1032 var obj2 = LocalVariable.CreateCompilerGenerated (field_info.MemberType, block, Location);
1034 block.AddStatement (new StatementExpression (new SimpleAssign (new LocalVariableReference (obj1, Location), f_expr)));
1036 var cond = new BooleanExpression (new Binary (Binary.Operator.Inequality,
1037 new Cast (new TypeExpression (Module.Compiler.BuiltinTypes.Object, Location), new LocalVariableReference (obj1, Location), Location),
1038 new Cast (new TypeExpression (Module.Compiler.BuiltinTypes.Object, Location), new LocalVariableReference (obj2, Location), Location)));
1040 var body = new ExplicitBlock (block, Location, Location);
1041 block.AddStatement (new Do (body, cond, Location, Location));
1043 body.AddStatement (new StatementExpression (
1044 new SimpleAssign (new LocalVariableReference (obj2, Location), new LocalVariableReference (obj1, Location))));
1046 var args_oper = new Arguments (2);
1047 args_oper.Add (new Argument (new LocalVariableReference (obj2, Location)));
1048 args_oper.Add (new Argument (block.GetParameterReference (0, Location)));
1050 var op_method = GetOperation (Location);
1052 var args = new Arguments (3);
1053 args.Add (new Argument (f_expr, Argument.AType.Ref));
1054 args.Add (new Argument (new Cast (
1055 new TypeExpression (field_info.MemberType, Location),
1056 new Invocation (MethodGroupExpr.CreatePredefined (op_method, op_method.DeclaringType, Location), args_oper),
1058 args.Add (new Argument (new LocalVariableReference (obj1, Location)));
1060 var cas = Module.PredefinedMembers.InterlockedCompareExchange_T.Get ();
1062 if (Module.PredefinedMembers.MonitorEnter_v4.Get () != null || Module.PredefinedMembers.MonitorEnter.Get () != null) {
1063 // Workaround for cripled (e.g. microframework) mscorlib without CompareExchange
1064 body.AddStatement (new Lock (
1065 block.GetParameterReference (0, Location),
1066 new StatementExpression (new SimpleAssign (
1067 f_expr, args [1].Expr, Location), Location), Location));
1069 Module.PredefinedMembers.InterlockedCompareExchange_T.Resolve (Location);
1072 body.AddStatement (new StatementExpression (new SimpleAssign (
1073 new LocalVariableReference (obj1, Location),
1074 new Invocation (MethodGroupExpr.CreatePredefined (cas, cas.DeclaringType, Location), args))));
1079 sealed class AddDelegateMethod: EventFieldAccessor
1081 public AddDelegateMethod (EventField method):
1082 base (method, AddPrefix)
1086 protected override MethodSpec GetOperation (Location loc)
1088 return Module.PredefinedMembers.DelegateCombine.Resolve (loc);
1092 sealed class RemoveDelegateMethod: EventFieldAccessor
1094 public RemoveDelegateMethod (EventField method):
1095 base (method, RemovePrefix)
1099 protected override MethodSpec GetOperation (Location loc)
1101 return Module.PredefinedMembers.DelegateRemove.Resolve (loc);
1106 static readonly string[] attribute_targets = new string [] { "event", "field", "method" };
1107 static readonly string[] attribute_targets_interface = new string[] { "event", "method" };
1109 Expression initializer;
1110 Field backing_field;
1111 List<FieldDeclarator> declarators;
1113 public EventField (TypeDefinition parent, FullNamedExpression type, Modifiers mod_flags, MemberName name, Attributes attrs)
1114 : base (parent, type, mod_flags, name, attrs)
1116 Add = new AddDelegateMethod (this);
1117 Remove = new RemoveDelegateMethod (this);
1122 public List<FieldDeclarator> Declarators {
1124 return this.declarators;
1128 bool HasBackingField {
1130 return !IsInterface && (ModFlags & Modifiers.ABSTRACT) == 0;
1134 public Expression Initializer {
1139 initializer = value;
1143 public override string[] ValidAttributeTargets {
1145 return HasBackingField ? attribute_targets : attribute_targets_interface;
1152 public override void Accept (StructuralVisitor visitor)
1154 visitor.Visit (this);
1157 public void AddDeclarator (FieldDeclarator declarator)
1159 if (declarators == null)
1160 declarators = new List<FieldDeclarator> (2);
1162 declarators.Add (declarator);
1164 Parent.AddNameToContainer (this, declarator.Name.Value);
1167 public override void ApplyAttributeBuilder (Attribute a, MethodSpec ctor, byte[] cdata, PredefinedAttributes pa)
1169 if (a.Target == AttributeTargets.Field) {
1170 backing_field.ApplyAttributeBuilder (a, ctor, cdata, pa);
1174 if (a.Target == AttributeTargets.Method) {
1175 int errors = Report.Errors;
1176 Add.ApplyAttributeBuilder (a, ctor, cdata, pa);
1177 if (errors == Report.Errors)
1178 Remove.ApplyAttributeBuilder (a, ctor, cdata, pa);
1182 base.ApplyAttributeBuilder (a, ctor, cdata, pa);
1185 public override bool Define()
1187 var mod_flags_src = ModFlags;
1189 if (!base.Define ())
1192 if (declarators != null) {
1193 if ((mod_flags_src & Modifiers.DEFAULT_ACCESS_MODIFIER) != 0)
1194 mod_flags_src &= ~(Modifiers.AccessibilityMask | Modifiers.DEFAULT_ACCESS_MODIFIER);
1196 var t = new TypeExpression (MemberType, TypeExpression.Location);
1197 foreach (var d in declarators) {
1198 var ef = new EventField (Parent, t, mod_flags_src, new MemberName (d.Name.Value, d.Name.Location), OptAttributes);
1200 if (d.Initializer != null)
1201 ef.initializer = d.Initializer;
1204 Parent.PartialContainer.Members.Add (ef);
1208 if (!HasBackingField) {
1213 backing_field = new Field (Parent,
1214 new TypeExpression (MemberType, Location),
1215 Modifiers.BACKING_FIELD | Modifiers.COMPILER_GENERATED | Modifiers.DEBUGGER_HIDDEN | Modifiers.PRIVATE | (ModFlags & (Modifiers.STATIC | Modifiers.UNSAFE)),
1218 Parent.PartialContainer.Members.Add (backing_field);
1219 backing_field.Initializer = Initializer;
1221 // Call define because we passed fields definition
1222 backing_field.Define ();
1224 // Set backing field for event fields
1225 spec.BackingField = backing_field.Spec;
1231 public abstract class Event : PropertyBasedMember
1233 public abstract class AEventAccessor : AbstractPropertyEventMethod
1235 protected readonly Event method;
1236 readonly ParametersCompiled parameters;
1238 static readonly string[] attribute_targets = new string [] { "method", "param", "return" };
1240 public const string AddPrefix = "add_";
1241 public const string RemovePrefix = "remove_";
1243 protected AEventAccessor (Event method, string prefix, Attributes attrs, Location loc)
1244 : base (method, prefix, attrs, loc)
1246 this.method = method;
1247 this.ModFlags = method.ModFlags;
1248 this.parameters = ParametersCompiled.CreateImplicitParameter (method.TypeExpression, loc);
1251 public bool IsInterfaceImplementation {
1252 get { return method_data.implementing != null; }
1255 public override void ApplyAttributeBuilder (Attribute a, MethodSpec ctor, byte[] cdata, PredefinedAttributes pa)
1257 if (a.Type == pa.MethodImpl) {
1258 method.is_external_implementation = a.IsInternalCall ();
1261 base.ApplyAttributeBuilder (a, ctor, cdata, pa);
1264 protected override void ApplyToExtraTarget (Attribute a, MethodSpec ctor, byte[] cdata, PredefinedAttributes pa)
1266 if (a.Target == AttributeTargets.Parameter) {
1267 parameters[0].ApplyAttributeBuilder (a, ctor, cdata, pa);
1271 base.ApplyToExtraTarget (a, ctor, cdata, pa);
1274 public override AttributeTargets AttributeTargets {
1276 return AttributeTargets.Method;
1280 public override bool IsClsComplianceRequired ()
1282 return method.IsClsComplianceRequired ();
1285 public virtual void Define (TypeContainer parent)
1287 // Fill in already resolved event type to speed things up and
1288 // avoid confusing duplicate errors
1289 ((Parameter) parameters.FixedParameters[0]).Type = method.member_type;
1290 parameters.Types = new TypeSpec[] { method.member_type };
1292 method_data = new MethodData (method, method.ModFlags,
1293 method.flags | MethodAttributes.HideBySig | MethodAttributes.SpecialName, this);
1295 if (!method_data.Define (parent.PartialContainer, method.GetFullName (MemberName)))
1298 if (Compiler.Settings.WriteMetadataOnly)
1301 Spec = new MethodSpec (MemberKind.Method, parent.PartialContainer.Definition, this, ReturnType, ParameterInfo, method.ModFlags);
1302 Spec.IsAccessor = true;
1305 public override TypeSpec ReturnType {
1307 return Parent.Compiler.BuiltinTypes.Void;
1311 public override ObsoleteAttribute GetAttributeObsolete ()
1313 return method.GetAttributeObsolete ();
1316 public MethodData MethodData {
1322 public override string[] ValidAttributeTargets {
1324 return attribute_targets;
1328 public override ParametersCompiled ParameterInfo {
1335 AEventAccessor add, remove;
1336 EventBuilder EventBuilder;
1337 protected EventSpec spec;
1339 protected Event (TypeDefinition parent, FullNamedExpression type, Modifiers mod_flags, MemberName name, Attributes attrs)
1340 : base (parent, type, mod_flags,
1341 parent.PartialContainer.Kind == MemberKind.Interface ? AllowedModifiersInterface :
1342 parent.PartialContainer.Kind == MemberKind.Struct ? AllowedModifiersStruct :
1343 AllowedModifiersClass,
1350 public override AttributeTargets AttributeTargets {
1352 return AttributeTargets.Event;
1356 public AEventAccessor Add {
1362 Parent.AddNameToContainer (value, value.MemberName.Basename);
1366 public override Variance ExpectedMemberTypeVariance {
1368 return Variance.Contravariant;
1372 public AEventAccessor Remove {
1378 Parent.AddNameToContainer (value, value.MemberName.Basename);
1383 public override void ApplyAttributeBuilder (Attribute a, MethodSpec ctor, byte[] cdata, PredefinedAttributes pa)
1385 if ((a.HasSecurityAttribute)) {
1386 a.Error_InvalidSecurityParent ();
1390 EventBuilder.SetCustomAttribute ((ConstructorInfo) ctor.GetMetaInfo (), cdata);
1393 protected override bool CheckOverrideAgainstBase (MemberSpec base_member)
1395 var ok = base.CheckOverrideAgainstBase (base_member);
1397 if (!CheckAccessModifiers (this, base_member)) {
1398 Error_CannotChangeAccessModifiers (this, base_member);
1405 public override bool Define ()
1407 if (!base.Define ())
1410 if (!MemberType.IsDelegate) {
1411 Report.Error (66, Location, "`{0}': event must be of a delegate type", GetSignatureForError ());
1418 // Now define the accessors
1420 add.Define (Parent);
1421 remove.Define (Parent);
1423 EventBuilder = Parent.TypeBuilder.DefineEvent (GetFullName (MemberName), EventAttributes.None, MemberType.GetMetaInfo ());
1425 spec = new EventSpec (Parent.Definition, this, MemberType, ModFlags, Add.Spec, remove.Spec);
1427 Parent.MemberCache.AddMember (this, GetFullName (MemberName), spec);
1428 Parent.MemberCache.AddMember (this, Add.Spec.Name, Add.Spec);
1429 Parent.MemberCache.AddMember (this, Remove.Spec.Name, remove.Spec);
1434 public override void Emit ()
1436 CheckReservedNameConflict (null, add.Spec);
1437 CheckReservedNameConflict (null, remove.Spec);
1439 if (OptAttributes != null) {
1440 OptAttributes.Emit ();
1443 ConstraintChecker.Check (this, member_type, type_expr.Location);
1446 Remove.Emit (Parent);
1451 public override void PrepareEmit ()
1453 base.PrepareEmit ();
1456 remove.PrepareEmit ();
1458 EventBuilder.SetAddOnMethod (add.MethodData.MethodBuilder);
1459 EventBuilder.SetRemoveOnMethod (remove.MethodData.MethodBuilder);
1462 public override void WriteDebugSymbol (MonoSymbolFile file)
1464 add.WriteDebugSymbol (file);
1465 remove.WriteDebugSymbol (file);
1469 // Represents header string for documentation comment.
1471 public override string DocCommentHeader {
1472 get { return "E:"; }
1476 public class EventSpec : MemberSpec, IInterfaceMemberSpec
1478 MethodSpec add, remove;
1479 FieldSpec backing_field;
1481 public EventSpec (TypeSpec declaringType, IMemberDefinition definition, TypeSpec eventType, Modifiers modifiers, MethodSpec add, MethodSpec remove)
1482 : base (MemberKind.Event, declaringType, definition, modifiers)
1484 this.AccessorAdd = add;
1485 this.AccessorRemove = remove;
1486 this.MemberType = eventType;
1491 public MethodSpec AccessorAdd {
1500 public MethodSpec AccessorRemove {
1509 public FieldSpec BackingField {
1511 return backing_field;
1514 backing_field = value;
1518 public TypeSpec MemberType { get; private set; }
1522 public override MemberSpec InflateMember (TypeParameterInflator inflator)
1524 var es = (EventSpec) base.InflateMember (inflator);
1525 es.MemberType = inflator.Inflate (MemberType);
1527 if (backing_field != null)
1528 es.backing_field = (FieldSpec) backing_field.InflateMember (inflator);
1533 public override List<MissingTypeSpecReference> ResolveMissingDependencies (MemberSpec caller)
1535 return MemberType.ResolveMissingDependencies (this);
1539 public class Indexer : PropertyBase, IParametersMember
1541 public class GetIndexerMethod : GetMethod, IParametersMember
1543 ParametersCompiled parameters;
1545 public GetIndexerMethod (PropertyBase property, Modifiers modifiers, ParametersCompiled parameters, Attributes attrs, Location loc)
1546 : base (property, modifiers, attrs, loc)
1548 this.parameters = parameters;
1551 public override void Define (TypeContainer parent)
1553 // Disable reporting, parameters are resolved twice
1554 Report.DisableReporting ();
1556 parameters.Resolve (this);
1558 Report.EnableReporting ();
1561 base.Define (parent);
1564 public override ParametersCompiled ParameterInfo {
1570 #region IParametersMember Members
1572 AParametersCollection IParametersMember.Parameters {
1578 TypeSpec IInterfaceMemberSpec.MemberType {
1587 public class SetIndexerMethod : SetMethod, IParametersMember
1589 public SetIndexerMethod (PropertyBase property, Modifiers modifiers, ParametersCompiled parameters, Attributes attrs, Location loc)
1590 : base (property, modifiers, parameters, attrs, loc)
1594 #region IParametersMember Members
1596 AParametersCollection IParametersMember.Parameters {
1602 TypeSpec IInterfaceMemberSpec.MemberType {
1611 const Modifiers AllowedModifiers =
1614 Modifiers.PROTECTED |
1615 Modifiers.INTERNAL |
1619 Modifiers.OVERRIDE |
1624 const Modifiers AllowedInterfaceModifiers =
1627 readonly ParametersCompiled parameters;
1629 public Indexer (TypeDefinition parent, FullNamedExpression type, MemberName name, Modifiers mod, ParametersCompiled parameters, Attributes attrs)
1630 : base (parent, type, mod,
1631 parent.PartialContainer.Kind == MemberKind.Interface ? AllowedInterfaceModifiers : AllowedModifiers,
1634 this.parameters = parameters;
1639 AParametersCollection IParametersMember.Parameters {
1645 public ParametersCompiled ParameterInfo {
1654 public override void Accept (StructuralVisitor visitor)
1656 visitor.Visit (this);
1659 public override void ApplyAttributeBuilder (Attribute a, MethodSpec ctor, byte[] cdata, PredefinedAttributes pa)
1661 if (a.Type == pa.IndexerName) {
1662 // Attribute was copied to container
1666 base.ApplyAttributeBuilder (a, ctor, cdata, pa);
1669 protected override bool CheckForDuplications ()
1671 return Parent.MemberCache.CheckExistingMembersOverloads (this, parameters);
1674 public override bool Define ()
1676 if (!base.Define ())
1679 if (!DefineParameters (parameters))
1682 if (OptAttributes != null) {
1683 Attribute indexer_attr = OptAttributes.Search (Module.PredefinedAttributes.IndexerName);
1684 if (indexer_attr != null) {
1685 var compiling = indexer_attr.Type.MemberDefinition as TypeContainer;
1686 if (compiling != null)
1687 compiling.Define ();
1689 if (IsExplicitImpl) {
1690 Report.Error (415, indexer_attr.Location,
1691 "The `{0}' attribute is valid only on an indexer that is not an explicit interface member declaration",
1692 indexer_attr.Type.GetSignatureForError ());
1693 } else if ((ModFlags & Modifiers.OVERRIDE) != 0) {
1694 Report.Error (609, indexer_attr.Location,
1695 "Cannot set the `IndexerName' attribute on an indexer marked override");
1697 string name = indexer_attr.GetIndexerAttributeValue ();
1699 if (!string.IsNullOrEmpty (name)) {
1700 SetMemberName (new MemberName (MemberName.Left, name, Location));
1706 if (InterfaceType != null) {
1707 string base_IndexerName = InterfaceType.MemberDefinition.GetAttributeDefaultMember ();
1708 if (base_IndexerName != ShortName) {
1709 SetMemberName (new MemberName (MemberName.Left, base_IndexerName, new TypeExpression (InterfaceType, Location), Location));
1713 Parent.AddNameToContainer (this, MemberName.Basename);
1715 flags |= MethodAttributes.HideBySig | MethodAttributes.SpecialName;
1717 if (!DefineAccessors ())
1723 DefineBuilders (MemberKind.Indexer, parameters);
1727 public override bool EnableOverloadChecks (MemberCore overload)
1729 if (overload is Indexer) {
1730 caching_flags |= Flags.MethodOverloadsExist;
1734 return base.EnableOverloadChecks (overload);
1737 public override void Emit ()
1739 parameters.CheckConstraints (this);
1744 public override string GetSignatureForError ()
1746 StringBuilder sb = new StringBuilder (Parent.GetSignatureForError ());
1747 if (MemberName.ExplicitInterface != null) {
1749 sb.Append (MemberName.ExplicitInterface.GetSignatureForError ());
1752 sb.Append (".this");
1753 sb.Append (parameters.GetSignatureForError ("[", "]", parameters.Count));
1754 return sb.ToString ();
1757 public override string GetSignatureForDocumentation ()
1759 return base.GetSignatureForDocumentation () + parameters.GetSignatureForDocumentation ();
1762 public override void PrepareEmit ()
1764 base.PrepareEmit ();
1765 parameters.ResolveDefaultValues (this);
1768 protected override bool VerifyClsCompliance ()
1770 if (!base.VerifyClsCompliance ())
1773 parameters.VerifyClsCompliance (this);
1778 public class IndexerSpec : PropertySpec, IParametersMember
1780 AParametersCollection parameters;
1782 public IndexerSpec (TypeSpec declaringType, IMemberDefinition definition, TypeSpec memberType, AParametersCollection parameters, PropertyInfo info, Modifiers modifiers)
1783 : base (MemberKind.Indexer, declaringType, definition, memberType, info, modifiers)
1785 this.parameters = parameters;
1789 public AParametersCollection Parameters {
1796 public override string GetSignatureForDocumentation ()
1798 return base.GetSignatureForDocumentation () + parameters.GetSignatureForDocumentation ();
1801 public override string GetSignatureForError ()
1803 return DeclaringType.GetSignatureForError () + ".this" + parameters.GetSignatureForError ("[", "]", parameters.Count);
1806 public override MemberSpec InflateMember (TypeParameterInflator inflator)
1808 var spec = (IndexerSpec) base.InflateMember (inflator);
1809 spec.parameters = parameters.Inflate (inflator);
1813 public override List<MissingTypeSpecReference> ResolveMissingDependencies (MemberSpec caller)
1815 var missing = base.ResolveMissingDependencies (caller);
1817 foreach (var pt in parameters.Types) {
1818 var m = pt.GetMissingDependencies (caller);
1822 if (missing == null)
1823 missing = new List<MissingTypeSpecReference> ();
1825 missing.AddRange (m);