2 // attribute.cs: Attribute Handler
4 // Author: Ravi Pratap (ravi@ximian.com)
5 // Marek Safar (marek.safar@seznam.cz)
7 // Licensed under the terms of the GNU GPL
9 // (C) 2001 Ximian, Inc (http://www.ximian.com)
14 using System.Diagnostics;
15 using System.Collections;
16 using System.Collections.Specialized;
17 using System.Reflection;
18 using System.Reflection.Emit;
19 using System.Runtime.InteropServices;
20 using System.Runtime.CompilerServices;
23 namespace Mono.CSharp {
26 /// Base class for objects that can have Attributes applied to them.
28 public abstract class Attributable {
30 /// Attributes for this type
32 Attributes attributes;
34 public Attributable(Attributes attrs)
37 if (attributes != null)
38 attributes.CheckTargets (ValidAttributeTargets);
41 public Attributes OptAttributes
48 if (attributes != null)
49 attributes.CheckTargets (ValidAttributeTargets);
54 /// Use member-specific procedure to apply attribute @a in @cb to the entity being built in @builder
56 public abstract void ApplyAttributeBuilder (Attribute a, CustomAttributeBuilder cb);
59 /// Returns combination of enabled AttributeTargets
61 public abstract AttributeTargets AttributeTargets { get; }
63 public abstract bool IsClsCompliaceRequired (DeclSpace ds);
66 /// Gets list of valid attribute targets for explicit target declaration.
67 /// The first array item is default target. Don't break this rule.
69 protected abstract string[] ValidAttributeTargets { get; }
72 public class Attribute {
74 public readonly string Name;
75 public readonly ArrayList Arguments;
77 public readonly Location Location;
81 // Is non-null if type is AttributeUsageAttribute
82 AttributeUsageAttribute usage_attribute;
84 public AttributeUsageAttribute UsageAttribute {
86 return usage_attribute;
90 MethodImplOptions ImplOptions;
91 UnmanagedType UnmanagedType;
92 CustomAttributeBuilder cb;
94 // non-null if named args present after Resolve () is called
95 PropertyInfo [] prop_info_arr;
96 FieldInfo [] field_info_arr;
97 object [] field_values_arr;
98 object [] prop_values_arr;
101 static PtrHashtable usage_attr_cache = new PtrHashtable ();
103 public Attribute (string target, string name, ArrayList args, Location loc)
111 void Error_InvalidNamedArgument (string name)
113 Report.Error (617, Location, "'" + name + "' is not a valid named attribute " +
114 "argument. Named attribute arguments must be fields which are not " +
115 "readonly, static or const, or properties with a set accessor which "+
119 static void Error_AttributeArgumentNotValid (Location loc)
121 Report.Error (182, loc,
122 "An attribute argument must be a constant expression, typeof " +
123 "expression or array creation expression");
126 void Error_AttributeConstructorMismatch ()
128 Report.Error (-6, Location,
129 "Could not find a constructor for this argument list.");
133 /// Tries to resolve the type of the attribute. Flags an error if it can't, and complain is true.
135 protected virtual Type CheckAttributeType (EmitContext ec, bool complain)
137 Type t1 = RootContext.LookupType (ec.DeclSpace, Name, true, Location);
139 // FIXME: Shouldn't do this for quoted attributes: [@A]
140 Type t2 = RootContext.LookupType (ec.DeclSpace, Name + "Attribute", true, Location);
142 String err0616 = null;
144 if (t1 != null && ! t1.IsSubclassOf (TypeManager.attribute_type)) {
146 err0616 = "'" + Name + "': is not an attribute class";
148 if (t2 != null && ! t2.IsSubclassOf (TypeManager.attribute_type)) {
150 err0616 = (err0616 != null)
151 ? "Neither '" + Name + "' nor '" + Name + "Attribute' is an attribute class"
152 : "'" + Name + "Attribute': is not an attribute class";
155 if (t1 != null && t2 != null) {
156 Report.Error(1614, Location, "'" + Name + "': is ambiguous; "
157 + " use either '@" + Name + "' or '" + Name + "Attribute'");
165 if (err0616 != null) {
166 Report.Error (616, Location, err0616);
171 Report.Error (246, Location,
172 "Could not find attribute '" + Name
173 + "' (are you missing a using directive or an assembly reference ?)");
177 public Type ResolveType (EmitContext ec, bool complain)
180 Type = CheckAttributeType (ec, complain);
185 /// Validates the guid string
187 bool ValidateGuid (string guid)
193 Report.Error (647, Location, "Format of GUID is invalid: " + guid);
198 string GetFullMemberName (string member)
200 return Type.FullName + '.' + member;
204 // Given an expression, if the expression is a valid attribute-argument-expression
205 // returns an object that can be used to encode it, or null on failure.
207 public static bool GetAttributeArgumentExpression (Expression e, Location loc, out object result)
210 result = ((Constant) e).GetValue ();
212 } else if (e is TypeOf) {
213 result = ((TypeOf) e).TypeArg;
215 } else if (e is ArrayCreation){
216 result = ((ArrayCreation) e).EncodeAsAttribute ();
219 } else if (e is EmptyCast) {
221 if (((EmptyCast) e).Child is Constant) {
222 result = ((Constant) ((EmptyCast)e).Child).GetValue();
228 Error_AttributeArgumentNotValid (loc);
232 public CustomAttributeBuilder Resolve (EmitContext ec)
237 Type = CheckAttributeType (ec, true);
238 if (oldType == null && Type == null)
240 if (oldType != null && oldType != Type) {
241 Report.Error (-6, Location,
242 "Attribute {0} resolved to different types at different times: {1} vs. {2}",
243 Name, oldType, Type);
247 bool MethodImplAttr = false;
248 bool MarshalAsAttr = false;
249 bool GuidAttr = false;
250 bool usage_attr = false;
252 bool DoCompares = true;
255 // If we are a certain special attribute, we
256 // set the information accordingly
259 if (Type == TypeManager.attribute_usage_type)
261 else if (Type == TypeManager.methodimpl_attr_type)
262 MethodImplAttr = true;
263 else if (Type == TypeManager.marshal_as_attr_type)
264 MarshalAsAttr = true;
265 else if (Type == TypeManager.guid_attr_type)
270 // Now we extract the positional and named arguments
272 ArrayList pos_args = new ArrayList ();
273 ArrayList named_args = new ArrayList ();
274 int pos_arg_count = 0;
276 if (Arguments != null) {
277 pos_args = (ArrayList) Arguments [0];
278 if (pos_args != null)
279 pos_arg_count = pos_args.Count;
280 if (Arguments.Count > 1)
281 named_args = (ArrayList) Arguments [1];
284 pos_values = new object [pos_arg_count];
287 // First process positional arguments
291 for (i = 0; i < pos_arg_count; i++) {
292 Argument a = (Argument) pos_args [i];
295 if (!a.Resolve (ec, Location))
301 if (!GetAttributeArgumentExpression (e, Location, out val))
304 pos_values [i] = val;
307 usage_attribute = new AttributeUsageAttribute ((AttributeTargets) pos_values [0]);
308 else if (MethodImplAttr)
309 this.ImplOptions = (MethodImplOptions) pos_values [0];
312 // we will later check the validity of the type
314 if (pos_values [0] is string){
315 if (!ValidateGuid ((string) pos_values [0]))
319 } else if (MarshalAsAttr)
321 (System.Runtime.InteropServices.UnmanagedType) pos_values [0];
326 // Now process named arguments
329 ArrayList field_infos = null;
330 ArrayList prop_infos = null;
331 ArrayList field_values = null;
332 ArrayList prop_values = null;
334 if (named_args.Count > 0) {
335 field_infos = new ArrayList ();
336 prop_infos = new ArrayList ();
337 field_values = new ArrayList ();
338 prop_values = new ArrayList ();
341 Hashtable seen_names = new Hashtable();
343 for (i = 0; i < named_args.Count; i++) {
344 DictionaryEntry de = (DictionaryEntry) named_args [i];
345 string member_name = (string) de.Key;
346 Argument a = (Argument) de.Value;
349 if (seen_names.Contains(member_name)) {
350 Report.Error(643, Location, "'" + member_name + "' duplicate named attribute argument");
353 seen_names.Add(member_name, 1);
355 if (!a.Resolve (ec, Location))
358 Expression member = Expression.MemberLookup (
359 ec, Type, member_name,
360 MemberTypes.Field | MemberTypes.Property,
361 BindingFlags.Public | BindingFlags.Instance,
364 if (member == null) {
365 member = Expression.MemberLookup (ec, Type, member_name,
366 MemberTypes.Field | MemberTypes.Property, BindingFlags.NonPublic | BindingFlags.Instance,
369 if (member != null) {
370 Report.Error_T (122, Location, GetFullMemberName (member_name));
375 if (member == null || !(member is PropertyExpr || member is FieldExpr)) {
376 Error_InvalidNamedArgument (member_name);
381 if (member is PropertyExpr) {
382 PropertyExpr pe = (PropertyExpr) member;
383 PropertyInfo pi = pe.PropertyInfo;
386 Error_InvalidNamedArgument (member_name);
391 EmptyCast ecast = e as EmptyCast;
392 if ((ecast != null) && (ecast.Child is Constant))
395 Constant c = e as Constant;
397 if (type != pi.PropertyType) {
398 c = Const.ChangeType (Location, c, pi.PropertyType);
403 object o = c.GetValue ();
406 if (usage_attribute != null) {
407 if (member_name == "AllowMultiple")
408 usage_attribute.AllowMultiple = (bool) o;
409 if (member_name == "Inherited")
410 usage_attribute.Inherited = (bool) o;
413 } else if (e is TypeOf) {
414 prop_values.Add (((TypeOf) e).TypeArg);
415 } else if (e is ArrayCreation) {
416 prop_values.Add (((ArrayCreation) e).EncodeAsAttribute());
418 Error_AttributeArgumentNotValid (Location);
424 } else if (member is FieldExpr) {
425 FieldExpr fe = (FieldExpr) member;
426 FieldInfo fi = fe.FieldInfo;
429 Error_InvalidNamedArgument (member_name);
434 EmptyCast ecast = e as EmptyCast;
435 if ((ecast != null) && (ecast.Child is Constant))
439 // Handle charset here, and set the TypeAttributes
441 Constant c = e as Constant;
443 if (type != fi.FieldType) {
444 c = Const.ChangeType (Location, c, fi.FieldType);
449 object value = c.GetValue ();
450 field_values.Add (value);
451 } else if (e is TypeOf) {
452 field_values.Add (((TypeOf) e).TypeArg);
453 } else if (e is ArrayCreation) {
454 field_values.Add (((ArrayCreation) e).EncodeAsAttribute());
456 Error_AttributeArgumentNotValid (Location);
460 field_infos.Add (fi);
464 Expression mg = Expression.MemberLookup (
465 ec, Type, ".ctor", MemberTypes.Constructor,
466 BindingFlags.Public | BindingFlags.Instance | BindingFlags.DeclaredOnly,
470 Error_AttributeConstructorMismatch ();
474 MethodBase constructor = Invocation.OverloadResolve (
475 ec, (MethodGroupExpr) mg, pos_args, Location);
477 if (constructor == null) {
482 // Now we perform some checks on the positional args as they
483 // cannot be null for a constructor which expects a parameter
487 ParameterData pd = Invocation.GetParameterData (constructor);
489 int group_in_params_array = Int32.MaxValue;
491 if (pc > 0 && pd.ParameterModifier (pc-1) == Parameter.Modifier.PARAMS)
492 group_in_params_array = pc-1;
494 for (int j = 0; j < pos_arg_count; ++j) {
495 Argument a = (Argument) pos_args [j];
497 if (a.Expr is NullLiteral && pd.ParameterType (j) == TypeManager.object_type) {
498 Error_AttributeArgumentNotValid (Location);
502 if (j < group_in_params_array)
505 if (j == group_in_params_array){
506 object v = pos_values [j];
507 int count = pos_arg_count - j;
509 object [] array = new object [count];
510 pos_values [j] = array;
513 object [] array = (object []) pos_values [group_in_params_array];
515 array [j - group_in_params_array] = pos_values [j];
520 // Adjust the size of the pos_values if it had params
522 if (group_in_params_array != Int32.MaxValue){
523 int argc = group_in_params_array+1;
524 object [] new_pos_values = new object [argc];
526 for (int p = 0; p < argc; p++)
527 new_pos_values [p] = pos_values [p];
528 pos_values = new_pos_values;
532 if (named_args.Count > 0) {
533 prop_info_arr = new PropertyInfo [prop_infos.Count];
534 field_info_arr = new FieldInfo [field_infos.Count];
535 field_values_arr = new object [field_values.Count];
536 prop_values_arr = new object [prop_values.Count];
538 field_infos.CopyTo (field_info_arr, 0);
539 field_values.CopyTo (field_values_arr, 0);
541 prop_values.CopyTo (prop_values_arr, 0);
542 prop_infos.CopyTo (prop_info_arr, 0);
544 cb = new CustomAttributeBuilder (
545 (ConstructorInfo) constructor, pos_values,
546 prop_info_arr, prop_values_arr,
547 field_info_arr, field_values_arr);
550 cb = new CustomAttributeBuilder (
551 (ConstructorInfo) constructor, pos_values);
552 } catch (NullReferenceException) {
554 // Don't know what to do here
557 -101, Location, "NullReferenceException while trying to create attribute." +
558 "Something's wrong!");
559 } catch (Exception e) {
562 // using System.ComponentModel;
563 // [DefaultValue (CollectionChangeAction.Add)]
564 // class X { static void Main () {} }
567 -23, Location, "The compiler can not encode this attribute in .NET due to a bug in the .NET runtime. Try the Mono runtime. The exception was: " + e.Message);
574 /// Get a string containing a list of valid targets for the attribute 'attr'
576 public string GetValidTargets ()
578 StringBuilder sb = new StringBuilder ();
579 AttributeTargets targets = GetAttributeUsage ().ValidOn;
581 if ((targets & AttributeTargets.Assembly) != 0)
582 sb.Append ("'assembly' ");
584 if ((targets & AttributeTargets.Class) != 0)
585 sb.Append ("'class' ");
587 if ((targets & AttributeTargets.Constructor) != 0)
588 sb.Append ("'constructor' ");
590 if ((targets & AttributeTargets.Delegate) != 0)
591 sb.Append ("'delegate' ");
593 if ((targets & AttributeTargets.Enum) != 0)
594 sb.Append ("'enum' ");
596 if ((targets & AttributeTargets.Event) != 0)
597 sb.Append ("'event' ");
599 if ((targets & AttributeTargets.Field) != 0)
600 sb.Append ("'field' ");
602 if ((targets & AttributeTargets.Interface) != 0)
603 sb.Append ("'interface' ");
605 if ((targets & AttributeTargets.Method) != 0)
606 sb.Append ("'method' ");
608 if ((targets & AttributeTargets.Module) != 0)
609 sb.Append ("'module' ");
611 if ((targets & AttributeTargets.Parameter) != 0)
612 sb.Append ("'parameter' ");
614 if ((targets & AttributeTargets.Property) != 0)
615 sb.Append ("'property' ");
617 if ((targets & AttributeTargets.ReturnValue) != 0)
618 sb.Append ("'return' ");
620 if ((targets & AttributeTargets.Struct) != 0)
621 sb.Append ("'struct' ");
623 return sb.ToString ();
628 /// Returns AttributeUsage attribute for this type
630 public AttributeUsageAttribute GetAttributeUsage ()
632 AttributeUsageAttribute ua = usage_attr_cache [Type] as AttributeUsageAttribute;
636 Class attr_class = TypeManager.LookupClass (Type);
638 if (attr_class == null) {
639 object[] usage_attr = Type.GetCustomAttributes (TypeManager.attribute_usage_type, true);
640 ua = (AttributeUsageAttribute)usage_attr [0];
641 usage_attr_cache.Add (Type, ua);
645 return attr_class.AttributeUsage;
649 /// Returns custom name of indexer
651 public string GetIndexerAttributeValue (EmitContext ec)
653 if (pos_values == null) {
654 // TODO: It is not neccessary to call whole Resolve (ApplyAttribute does it now) we need only ctor args.
655 // But because a lot of attribute class code must be rewritten will be better to wait...
659 return pos_values [0] as string;
663 /// Returns condition of ConditionalAttribute
665 public string GetConditionalAttributeValue (DeclSpace ds)
667 if (pos_values == null) {
668 EmitContext ec = new EmitContext (ds, ds, Location, null, null, 0, false);
670 // TODO: It is not neccessary to call whole Resolve (ApplyAttribute does it now) we need only ctor args.
671 // But because a lot of attribute class code must be rewritten will be better to wait...
675 // Some error occurred
676 if (pos_values [0] == null)
679 return (string)pos_values [0];
683 /// Creates the instance of ObsoleteAttribute from this attribute instance
685 public ObsoleteAttribute GetObsoleteAttribute (DeclSpace ds)
687 if (pos_values == null) {
688 EmitContext ec = new EmitContext (ds, ds, Location, null, null, 0, false);
690 // TODO: It is not neccessary to call whole Resolve (ApplyAttribute does it now) we need only ctor args.
691 // But because a lot of attribute class code must be rewritten will be better to wait...
695 // Some error occurred
696 if (pos_values == null)
699 if (pos_values.Length == 0)
700 return new ObsoleteAttribute ();
702 if (pos_values.Length == 1)
703 return new ObsoleteAttribute ((string)pos_values [0]);
705 return new ObsoleteAttribute ((string)pos_values [0], (bool)pos_values [1]);
709 /// Returns value of CLSCompliantAttribute contructor parameter but because the method can be called
710 /// before ApplyAttribute. We need to resolve the arguments.
711 /// This situation occurs when class deps is differs from Emit order.
713 public bool GetClsCompliantAttributeValue (DeclSpace ds)
715 if (pos_values == null) {
716 EmitContext ec = new EmitContext (ds, ds, Location, null, null, 0, false);
718 // TODO: It is not neccessary to call whole Resolve (ApplyAttribute does it now) we need only ctor args.
719 // But because a lot of attribute class code must be rewritten will be better to wait...
723 // Some error occurred
724 if (pos_values [0] == null)
727 return (bool)pos_values [0];
730 public object GetPositionalValue (int i)
732 return (pos_values == null) ? null : pos_values[i];
735 object GetFieldValue (string name)
738 if (field_info_arr == null)
741 foreach (FieldInfo fi in field_info_arr) {
743 return field_values_arr [i];
749 public UnmanagedMarshal GetMarshal ()
751 object o = GetFieldValue ("ArraySubType");
752 UnmanagedType array_sub_type = o == null ? UnmanagedType.I4 : (UnmanagedType) o;
754 switch (UnmanagedType) {
755 case UnmanagedType.CustomMarshaler:
756 MethodInfo define_custom = typeof (UnmanagedMarshal).GetMethod ("DefineCustom",
757 BindingFlags.Static | BindingFlags.Public);
758 if (define_custom == null)
761 object [] args = new object [4];
762 args [0] = GetFieldValue ("MarshalTypeRef");
763 args [1] = GetFieldValue ("MarshalCookie");
764 args [2] = GetFieldValue ("MarshalType");
765 args [3] = Guid.Empty;
766 return (UnmanagedMarshal) define_custom.Invoke (null, args);
768 case UnmanagedType.LPArray:
769 return UnmanagedMarshal.DefineLPArray (array_sub_type);
771 case UnmanagedType.SafeArray:
772 return UnmanagedMarshal.DefineSafeArray (array_sub_type);
774 case UnmanagedType.ByValArray:
775 return UnmanagedMarshal.DefineByValArray ((int) GetFieldValue ("SizeConst"));
777 case UnmanagedType.ByValTStr:
778 return UnmanagedMarshal.DefineByValTStr ((int) GetFieldValue ("SizeConst"));
781 return UnmanagedMarshal.DefineUnmanagedMarshal (UnmanagedType);
785 public bool IsInternalCall
787 get { return ImplOptions == MethodImplOptions.InternalCall; }
791 /// Emit attribute for Attributable symbol
793 public void Emit (EmitContext ec, Attributable ias, ListDictionary emitted_attr)
795 CustomAttributeBuilder cb = Resolve (ec);
799 AttributeUsageAttribute usage_attr = GetAttributeUsage ();
800 if ((usage_attr.ValidOn & ias.AttributeTargets) == 0) {
801 // "Attribute '{0}' is not valid on this declaration type. It is valid on {1} declarations only.";
802 Report.Error_T (592, Location, Name, GetValidTargets ());
806 ias.ApplyAttributeBuilder (this, cb);
808 if (!usage_attr.AllowMultiple) {
809 ArrayList emitted_targets = (ArrayList)emitted_attr [Type];
810 if (emitted_targets == null) {
811 emitted_targets = new ArrayList ();
812 emitted_attr.Add (Type, emitted_targets);
813 } else if (emitted_targets.Contains (Target)) {
814 Report.Error (579, Location, "Duplicate '" + Name + "' attribute");
817 emitted_targets.Add (Target);
820 // Here we are testing attribute arguments for array usage (error 3016)
821 if (ias.IsClsCompliaceRequired (ec.DeclSpace)) {
822 if (Arguments == null)
825 ArrayList pos_args = (ArrayList) Arguments [0];
826 if (pos_args != null) {
827 foreach (Argument arg in pos_args) {
828 // Type is undefined (was error 246)
829 if (arg.Type == null)
832 if (arg.Type.IsArray) {
833 Report.Error_T (3016, Location);
839 if (Arguments.Count < 2)
842 ArrayList named_args = (ArrayList) Arguments [1];
843 foreach (DictionaryEntry de in named_args) {
844 Argument arg = (Argument) de.Value;
846 // Type is undefined (was error 246)
847 if (arg.Type == null)
850 if (arg.Type.IsArray) {
851 Report.Error_T (3016, Location);
858 public object GetValue (EmitContext ec, Constant c, Type target)
860 if (Convert.ImplicitConversionExists (ec, c, target))
861 return c.GetValue ();
863 Convert.Error_CannotImplicitConversion (Location, c.Type, target);
867 public MethodBuilder DefinePInvokeMethod (EmitContext ec, TypeBuilder builder, string name,
868 MethodAttributes flags, Type ret_type, Type [] param_types)
871 // We extract from the attribute the information we need
874 if (Arguments == null) {
875 Console.WriteLine ("Internal error : this is not supposed to happen !");
879 ResolveType (ec, true);
883 ArrayList named_args = new ArrayList ();
885 ArrayList pos_args = (ArrayList) Arguments [0];
886 if (Arguments.Count > 1)
887 named_args = (ArrayList) Arguments [1];
890 string dll_name = null;
892 Argument tmp = (Argument) pos_args [0];
894 if (!tmp.Resolve (ec, Location))
897 if (tmp.Expr is Constant)
898 dll_name = (string) ((Constant) tmp.Expr).GetValue ();
900 Error_AttributeArgumentNotValid (Location);
904 // Now we process the named arguments
905 CallingConvention cc = CallingConvention.Winapi;
906 CharSet charset = CharSet.Ansi;
907 bool preserve_sig = true;
909 bool exact_spelling = false;
911 bool set_last_err = false;
912 string entry_point = null;
914 for (int i = 0; i < named_args.Count; i++) {
916 DictionaryEntry de = (DictionaryEntry) named_args [i];
918 string member_name = (string) de.Key;
919 Argument a = (Argument) de.Value;
921 if (!a.Resolve (ec, Location))
924 Expression member = Expression.MemberLookup (
925 ec, Type, member_name,
926 MemberTypes.Field | MemberTypes.Property,
927 BindingFlags.Public | BindingFlags.Instance,
930 if (member == null || !(member is FieldExpr)) {
931 Error_InvalidNamedArgument (member_name);
935 if (member is FieldExpr) {
936 FieldExpr fe = (FieldExpr) member;
937 FieldInfo fi = fe.FieldInfo;
940 Error_InvalidNamedArgument (member_name);
944 if (a.Expr is Constant) {
945 Constant c = (Constant) a.Expr;
948 if (member_name == "CallingConvention"){
949 object val = GetValue (ec, c, typeof (CallingConvention));
952 cc = (CallingConvention) val;
953 } else if (member_name == "CharSet"){
954 charset = (CharSet) c.GetValue ();
955 } else if (member_name == "EntryPoint")
956 entry_point = (string) c.GetValue ();
957 else if (member_name == "SetLastError")
958 set_last_err = (bool) c.GetValue ();
960 else if (member_name == "ExactSpelling")
961 exact_spelling = (bool) c.GetValue ();
963 else if (member_name == "PreserveSig")
964 preserve_sig = (bool) c.GetValue ();
965 } catch (InvalidCastException){
966 Error_InvalidNamedArgument (member_name);
967 Error_AttributeArgumentNotValid (Location);
970 Error_AttributeArgumentNotValid (Location);
977 if (entry_point == null)
980 charset = (CharSet)((int)charset | 0x40);
982 MethodBuilder mb = builder.DefinePInvokeMethod (
983 name, dll_name, entry_point, flags | MethodAttributes.HideBySig,
984 CallingConventions.Standard,
991 mb.SetImplementationFlags (MethodImplAttributes.PreserveSig);
996 private Expression GetValue ()
998 if ((Arguments == null) || (Arguments.Count < 1))
1000 ArrayList al = (ArrayList) Arguments [0];
1001 if ((al == null) || (al.Count < 1))
1003 Argument arg = (Argument) al [0];
1004 if ((arg == null) || (arg.Expr == null))
1009 public string GetString ()
1011 Expression e = GetValue ();
1012 if (e is StringLiteral)
1013 return (e as StringLiteral).Value;
1017 public bool GetBoolean ()
1019 Expression e = GetValue ();
1020 if (e is BoolLiteral)
1021 return (e as BoolLiteral).Value;
1028 /// For global attributes (assembly, module) we need special handling.
1029 /// Attributes can be located in the several files
1031 public class GlobalAttribute: Attribute
1033 public readonly NamespaceEntry ns;
1035 public GlobalAttribute (TypeContainer container, string target, string name, ArrayList args, Location loc):
1036 base (target, name, args, loc)
1038 ns = container.NamespaceEntry;
1041 protected override Type CheckAttributeType (EmitContext ec, bool complain)
1043 NamespaceEntry old = ec.DeclSpace.NamespaceEntry;
1044 if (old == null || old.NS == null || old.NS == Namespace.Root)
1045 ec.DeclSpace.NamespaceEntry = ns;
1046 return base.CheckAttributeType (ec, complain);
1050 public class Attributes {
1051 public ArrayList Attrs;
1053 public Attributes (Attribute a)
1055 Attrs = new ArrayList ();
1059 public Attributes (ArrayList attrs)
1064 public void AddAttributes (ArrayList attrs)
1066 Attrs.AddRange (attrs);
1070 /// Checks whether attribute target is valid for the current element
1072 public void CheckTargets (string[] possible_targets)
1074 foreach (Attribute a in Attrs) {
1075 if (a.Target == null) {
1076 a.Target = possible_targets [0];
1080 if (((IList) possible_targets).Contains (a.Target))
1083 StringBuilder sb = new StringBuilder ();
1084 foreach (string s in possible_targets) {
1088 sb.Remove (sb.Length - 2, 2);
1089 Report.Error_T (657, a.Location, a.Target, sb.ToString ());
1093 private Attribute Search (Type t, EmitContext ec, bool complain)
1095 foreach (Attribute a in Attrs) {
1096 if (a.ResolveType (ec, false) == t)
1102 public Attribute Search (Type t, EmitContext ec)
1104 return Search (t, ec, true);
1108 /// Returns all attributes of type 't'. Use it when attribute is AllowMultiple = true
1110 public Attribute[] SearchMulti (Type t, EmitContext ec)
1112 ArrayList ar = null;
1114 foreach (Attribute a in Attrs) {
1115 if (a.ResolveType (ec, false) == t) {
1117 ar = new ArrayList ();
1122 return ar == null ? null : ar.ToArray (typeof (Attribute)) as Attribute[];
1125 public void Emit (EmitContext ec, Attributable ias)
1127 ListDictionary ld = new ListDictionary ();
1129 foreach (Attribute a in Attrs)
1130 a.Emit (ec, ias, ld);
1133 public bool Contains (Type t, EmitContext ec)
1135 return Search (t, ec) != null;
1138 public Attribute GetClsCompliantAttribute (EmitContext ec)
1140 return Search (TypeManager.cls_compliant_attribute_type, ec, false);
1144 /// Pulls the IndexerName attribute from an Indexer if it exists.
1146 public Attribute GetIndexerNameAttribute (EmitContext ec)
1148 Attribute a = Search (TypeManager.indexer_name_type, ec, false);
1152 // Remove the attribute from the list because it is not emitted
1160 /// Helper class for attribute verification routine.
1162 sealed class AttributeTester
1164 static PtrHashtable analyzed_types = new PtrHashtable ();
1165 static PtrHashtable analyzed_types_obsolete = new PtrHashtable ();
1166 static PtrHashtable analyzed_member_obsolete = new PtrHashtable ();
1167 static PtrHashtable analyzed_method_excluded = new PtrHashtable ();
1169 private AttributeTester ()
1174 /// Returns true if parameters of two compared methods are CLS-Compliant.
1175 /// It tests differing only in ref or out, or in array rank.
1177 public static bool AreOverloadedMethodParamsClsCompliant (Type[] types_a, Type[] types_b)
1179 if (types_a == null || types_b == null)
1182 if (types_a.Length != types_b.Length)
1185 for (int i = 0; i < types_b.Length; ++i) {
1186 Type aType = types_a [i];
1187 Type bType = types_b [i];
1189 if (aType.IsArray && bType.IsArray && aType.GetArrayRank () != bType.GetArrayRank () && aType.GetElementType () == bType.GetElementType ()) {
1193 Type aBaseType = aType;
1194 bool is_either_ref_or_out = false;
1196 if (aType.IsByRef || aType.IsPointer) {
1197 aBaseType = aType.GetElementType ();
1198 is_either_ref_or_out = true;
1201 Type bBaseType = bType;
1202 if (bType.IsByRef || bType.IsPointer)
1204 bBaseType = bType.GetElementType ();
1205 is_either_ref_or_out = !is_either_ref_or_out;
1208 if (aBaseType != bBaseType)
1211 if (is_either_ref_or_out)
1218 /// Goes through all parameters and test if they are CLS-Compliant.
1220 public static bool AreParametersCompliant (Parameter[] fixedParameters, Location loc)
1222 if (fixedParameters == null)
1225 foreach (Parameter arg in fixedParameters) {
1226 if (!AttributeTester.IsClsCompliant (arg.ParameterType)) {
1227 Report.Error_T (3001, loc, arg.GetSignatureForError ());
1236 /// This method tests the CLS compliance of external types. It doesn't test type visibility.
1238 public static bool IsClsCompliant (Type type)
1243 object type_compliance = analyzed_types[type];
1244 if (type_compliance != null)
1245 return type_compliance == TRUE;
1247 if (type.IsPointer) {
1248 analyzed_types.Add (type, null);
1253 if (type.IsArray || type.IsByRef) {
1254 result = IsClsCompliant (TypeManager.GetElementType (type));
1256 result = AnalyzeTypeCompliance (type);
1258 analyzed_types.Add (type, result ? TRUE : FALSE);
1262 static object TRUE = new object ();
1263 static object FALSE = new object ();
1266 /// Non-hierarchical CLS Compliance analyzer
1268 public static bool IsComplianceRequired (MemberInfo mi, DeclSpace ds)
1270 DeclSpace temp_ds = TypeManager.LookupDeclSpace (mi.DeclaringType);
1272 // Type is external, we can get attribute directly
1273 if (temp_ds == null) {
1274 object[] cls_attribute = mi.GetCustomAttributes (TypeManager.cls_compliant_attribute_type, false);
1275 return (cls_attribute.Length == 1 && ((CLSCompliantAttribute)cls_attribute[0]).IsCompliant);
1279 // Interface doesn't store full name
1280 if (temp_ds is Interface)
1283 tmp_name = String.Concat (temp_ds.Name, ".", mi.Name);
1285 MemberCore mc = temp_ds.GetDefinition (tmp_name) as MemberCore;
1286 return mc.IsClsCompliaceRequired (ds);
1289 public static void VerifyModulesClsCompliance ()
1291 Module[] modules = TypeManager.Modules;
1292 if (modules == null)
1295 // The first module is generated assembly
1296 for (int i = 1; i < modules.Length; ++i) {
1297 Module module = modules [i];
1298 if (!IsClsCompliant (module)) {
1299 Report.Error_T (3013, module.Name);
1305 static bool IsClsCompliant (ICustomAttributeProvider attribute_provider)
1307 object[] CompliantAttribute = attribute_provider.GetCustomAttributes (TypeManager.cls_compliant_attribute_type, false);
1308 if (CompliantAttribute.Length == 0)
1311 return ((CLSCompliantAttribute)CompliantAttribute[0]).IsCompliant;
1314 static bool AnalyzeTypeCompliance (Type type)
1316 DeclSpace ds = TypeManager.LookupDeclSpace (type);
1318 return ds.IsClsCompliaceRequired (ds.Parent);
1321 object[] CompliantAttribute = type.GetCustomAttributes (TypeManager.cls_compliant_attribute_type, false);
1322 if (CompliantAttribute.Length == 0)
1323 return IsClsCompliant (type.Assembly);
1325 return ((CLSCompliantAttribute)CompliantAttribute[0]).IsCompliant;
1329 /// Returns instance of ObsoleteAttribute when type is obsolete
1331 public static ObsoleteAttribute GetObsoleteAttribute (Type type)
1333 object type_obsolete = analyzed_types_obsolete [type];
1334 if (type_obsolete == FALSE)
1337 if (type_obsolete != null)
1338 return (ObsoleteAttribute)type_obsolete;
1340 ObsoleteAttribute result = null;
1341 if (type.IsByRef || type.IsArray || type.IsPointer) {
1342 result = GetObsoleteAttribute (TypeManager.GetElementType (type));
1344 DeclSpace type_ds = TypeManager.LookupDeclSpace (type);
1346 // Type is external, we can get attribute directly
1347 if (type_ds == null) {
1348 object[] attribute = type.GetCustomAttributes (TypeManager.obsolete_attribute_type, false);
1349 if (attribute.Length == 1)
1350 result = (ObsoleteAttribute)attribute [0];
1352 result = type_ds.GetObsoleteAttribute (type_ds);
1356 analyzed_types_obsolete.Add (type, result == null ? FALSE : result);
1361 /// Returns instance of ObsoleteAttribute when method is obsolete
1363 public static ObsoleteAttribute GetMethodObsoleteAttribute (MethodBase mb)
1365 IMethodData mc = TypeManager.GetMethod (mb);
1367 return mc.GetObsoleteAttribute ();
1369 // TODO: remove after Constructor will be ready for IMethodData
1370 if (mb.DeclaringType is TypeBuilder)
1373 return GetMemberObsoleteAttribute (mb);
1377 /// Returns instance of ObsoleteAttribute when member is obsolete
1379 public static ObsoleteAttribute GetMemberObsoleteAttribute (MemberInfo mi)
1381 object type_obsolete = analyzed_member_obsolete [mi];
1382 if (type_obsolete == FALSE)
1385 if (type_obsolete != null)
1386 return (ObsoleteAttribute)type_obsolete;
1388 ObsoleteAttribute oa = System.Attribute.GetCustomAttribute (mi, TypeManager.obsolete_attribute_type, false) as ObsoleteAttribute;
1389 analyzed_member_obsolete.Add (mi, oa == null ? FALSE : oa);
1394 /// Common method for Obsolete error/warning reporting.
1396 public static void Report_ObsoleteMessage (ObsoleteAttribute oa, string member, Location loc)
1399 Report.Error_T (619, loc, member, oa.Message);
1403 if (oa.Message == null) {
1404 Report.Warning_T (612, loc, member);
1407 Report.Warning_T (618, loc, member, oa.Message);
1410 public static bool IsConditionalMethodExcluded (MethodBase mb)
1412 object excluded = analyzed_method_excluded [mb];
1413 if (excluded != null)
1414 return excluded == TRUE ? true : false;
1416 ConditionalAttribute[] attrs = mb.GetCustomAttributes (TypeManager.conditional_attribute_type, true) as ConditionalAttribute[];
1417 if (attrs.Length == 0) {
1418 analyzed_method_excluded.Add (mb, FALSE);
1422 foreach (ConditionalAttribute a in attrs) {
1423 if (RootContext.AllDefines.Contains (a.ConditionString)) {
1424 analyzed_method_excluded.Add (mb, FALSE);
1428 analyzed_method_excluded.Add (mb, TRUE);