2 // interface.cs: Interface handler
4 // Author: Miguel de Icaza (miguel@gnu.org)
6 // Licensed under the terms of the GNU GPL
8 // (C) 2001 Ximian, Inc (http://www.ximian.com)
11 using System.Collections;
14 using System.Reflection;
15 using System.Reflection.Emit;
17 namespace Mono.CSharp {
22 public class Interface : DeclSpace, IMemberContainer {
23 const MethodAttributes interface_method_attributes =
24 MethodAttributes.Public |
25 MethodAttributes.Abstract |
26 MethodAttributes.HideBySig |
27 MethodAttributes.NewSlot |
28 MethodAttributes.Virtual;
30 const MethodAttributes property_attributes =
31 MethodAttributes.Public |
32 MethodAttributes.Abstract |
33 MethodAttributes.HideBySig |
34 MethodAttributes.NewSlot |
35 MethodAttributes.SpecialName |
36 MethodAttributes.Virtual;
40 ArrayList defined_method;
41 ArrayList defined_indexer;
42 ArrayList defined_events;
43 ArrayList defined_properties;
45 ArrayList method_builders;
46 ArrayList property_builders;
47 ArrayList event_builders;
49 Attributes OptAttributes;
51 public string IndexerName;
53 IMemberContainer parent_container;
54 MemberCache member_cache;
58 // These will happen after the semantic analysis
60 // Hashtable defined_indexers;
61 // Hashtable defined_methods;
64 /// Modifiers allowed in a class declaration
66 public const int AllowedModifiers =
74 public Interface (NamespaceEntry ns, TypeContainer parent, string name, int mod,
75 Attributes attrs, Location l)
76 : base (ns, parent, name, l)
78 ModFlags = Modifiers.Check (AllowedModifiers, mod, Modifiers.PRIVATE, l);
79 OptAttributes = attrs;
81 method_builders = new ArrayList ();
82 property_builders = new ArrayList ();
83 event_builders = new ArrayList ();
86 public AdditionResult AddMethod (InterfaceMethod imethod)
88 string name = imethod.Name;
89 Object value = defined_names [name];
92 if (!(value is InterfaceMethod))
93 return AdditionResult.NameExists;
96 if (defined_method == null)
97 defined_method = new ArrayList ();
99 defined_method.Add (imethod);
101 DefineName (name, imethod);
103 return AdditionResult.Success;
106 public AdditionResult AddProperty (InterfaceProperty iprop)
109 string name = iprop.Name;
111 if ((res = IsValid (name, name)) != AdditionResult.Success)
114 DefineName (name, iprop);
116 if (defined_properties == null)
117 defined_properties = new ArrayList ();
119 defined_properties.Add (iprop);
120 return AdditionResult.Success;
123 public AdditionResult AddEvent (InterfaceEvent ievent)
125 string name = ievent.Name;
128 if ((res = IsValid (name, name)) != AdditionResult.Success)
131 DefineName (name, ievent);
133 if (defined_events == null)
134 defined_events = new ArrayList ();
136 defined_events.Add (ievent);
137 return AdditionResult.Success;
140 public bool AddIndexer (InterfaceIndexer iindexer)
142 if (defined_indexer == null)
143 defined_indexer = new ArrayList ();
145 defined_indexer.Add (iindexer);
149 public ArrayList InterfaceMethods {
151 return defined_method;
155 public ArrayList InterfaceProperties {
157 return defined_properties;
161 public ArrayList InterfaceEvents {
163 return defined_events;
167 public ArrayList InterfaceIndexers {
169 return defined_indexer;
173 public ArrayList Bases {
183 public virtual TypeAttributes InterfaceAttr {
185 TypeAttributes x = TypeAttributes.Interface | TypeAttributes.Abstract;
187 if (IsTopLevel == false) {
189 if ((ModFlags & Modifiers.PROTECTED) != 0
190 && (ModFlags & Modifiers.INTERNAL) != 0)
191 x |= TypeAttributes.NestedFamORAssem;
192 else if ((ModFlags & Modifiers.PROTECTED) != 0)
193 x |= TypeAttributes.NestedFamily;
194 else if ((ModFlags & Modifiers.INTERNAL) != 0)
195 x |= TypeAttributes.NestedAssembly;
196 else if ((ModFlags & Modifiers.PUBLIC) != 0)
197 x |= TypeAttributes.NestedPublic;
199 x |= TypeAttributes.NestedPrivate;
201 if ((ModFlags & Modifiers.PUBLIC) != 0)
202 x |= TypeAttributes.Public;
203 else if ((ModFlags & Modifiers.PRIVATE) != 0)
204 x |= TypeAttributes.NotPublic;
207 if ((ModFlags & Modifiers.ABSTRACT) != 0)
208 x |= TypeAttributes.Abstract;
210 if ((ModFlags & Modifiers.SEALED) != 0)
211 x |= TypeAttributes.Sealed;
217 void Error111 (InterfaceMemberBase ib)
221 "Interface `" + Name + "' already contains a definition with the " +
222 "same return value and parameter types for member `" + ib.Name + "'");
225 bool RegisterMethod (MethodBase mb, InternalParameters ip, Type [] types)
227 if (!TypeManager.RegisterMethod (mb, ip, types))
230 method_builders.Add (mb);
235 // This might trigger a definition of the methods. This happens only
236 // with Attributes, as Attribute classes are processed before interfaces.
237 // Ideally, we should make everything just define recursively in terms
238 // of its dependencies.
240 public MethodInfo [] GetMethods (TypeContainer container)
244 if (!members_defined){
245 if (DefineMembers (container))
246 n = method_builders.Count;
248 n = method_builders.Count;
250 MethodInfo [] mi = new MethodInfo [n];
252 method_builders.CopyTo (mi, 0);
257 // Hack around System.Reflection as found everywhere else
258 public override MemberList FindMembers (MemberTypes mt, BindingFlags bf,
259 MemberFilter filter, object criteria)
261 ArrayList members = new ArrayList ();
263 if ((mt & MemberTypes.Method) != 0) {
264 foreach (MethodBuilder mb in method_builders)
265 if (filter (mb, criteria))
269 if ((mt & MemberTypes.Property) != 0) {
270 foreach (PropertyBuilder pb in property_builders)
271 if (filter (pb, criteria))
275 if ((mt & MemberTypes.Event) != 0) {
276 foreach (MyEventBuilder eb in event_builders)
277 if (filter (eb, criteria))
281 if (((bf & BindingFlags.DeclaredOnly) == 0) && (TypeBuilder.BaseType != null)) {
282 MemberList parent_mi;
284 parent_mi = TypeContainer.FindMembers (
285 TypeBuilder.BaseType, mt, bf, filter, criteria);
287 members.AddRange (parent_mi);
290 return new MemberList (members);
293 public override MemberCache MemberCache {
300 // Populates the methods in the interface
302 void PopulateMethod (TypeContainer parent, DeclSpace decl_space, InterfaceMethod im)
304 Type return_type = im.ReturnType.Type;
305 if (return_type == null)
306 return_type = this.ResolveType (im.ReturnType, false, im.Location);
308 Type [] arg_types = im.ParameterTypes (this);
313 if (return_type == null)
316 if (return_type.IsPointer && !UnsafeOK (this))
319 if (arg_types == null)
322 foreach (Type t in arg_types){
327 if (t.IsPointer && !UnsafeOK (this))
334 mb = TypeBuilder.DefineMethod (
335 im.Name, interface_method_attributes,
336 return_type, arg_types);
338 InternalParameters ip = new InternalParameters (arg_types, im.Parameters);
340 if (!RegisterMethod (mb, ip, arg_types)) {
346 // Define each type attribute (in/out/ref) and
347 // the argument names.
349 p = im.Parameters.FixedParameters;
351 for (i = 0; i < p.Length; i++)
352 mb.DefineParameter (i + 1, p [i].Attributes, p [i].Name);
354 if (i != arg_types.Length)
355 Console.WriteLine ("Implement the type definition for params");
363 // Populates the properties in the interface
365 void PopulateProperty (TypeContainer parent, DeclSpace decl_space, InterfaceProperty ip)
368 MethodBuilder get = null, set = null;
369 ip.Type = this.ResolveTypeExpr (ip.Type, false, ip.Location);
373 Type prop_type = ip.Type.Type;
374 Type [] setter_args = new Type [1];
376 if (prop_type == null)
379 if (prop_type.IsPointer && !UnsafeOK (this))
382 setter_args [0] = prop_type;
385 // FIXME: properties are missing the following
386 // flags: hidebysig newslot specialname
388 pb = TypeBuilder.DefineProperty (
389 ip.Name, PropertyAttributes.None,
393 get = TypeBuilder.DefineMethod (
394 "get_" + ip.Name, property_attributes ,
398 // HACK because System.Reflection.Emit is lame
400 Type [] null_types = null;
401 InternalParameters inp = new InternalParameters
402 (null_types, Parameters.EmptyReadOnlyParameters);
404 if (!RegisterMethod (get, inp, null)) {
409 pb.SetGetMethod (get);
413 setter_args [0] = prop_type;
415 set = TypeBuilder.DefineMethod (
416 "set_" + ip.Name, property_attributes,
417 TypeManager.void_type, setter_args);
419 set.DefineParameter (1, ParameterAttributes.None, "value");
420 pb.SetSetMethod (set);
423 // HACK because System.Reflection.Emit is lame
425 Parameter [] parms = new Parameter [1];
426 parms [0] = new Parameter (ip.Type, "value", Parameter.Modifier.NONE, null);
427 InternalParameters ipp = new InternalParameters (
428 this, new Parameters (parms, null, Location.Null));
430 if (!RegisterMethod (set, ipp, setter_args)) {
436 TypeManager.RegisterProperty (pb, get, set);
437 property_builders.Add (pb);
442 // Populates the events in the interface
444 void PopulateEvent (TypeContainer parent, DeclSpace decl_space, InterfaceEvent ie)
447 // FIXME: We need to do this after delegates have been
448 // declared or we declare them recursively.
451 MethodBuilder add = null, remove = null;
452 ie.Type = this.ResolveTypeExpr (ie.Type, false, ie.Location);
456 Type event_type = ie.Type.Type;
458 if (event_type == null)
461 if (event_type.IsPointer && !UnsafeOK (this))
464 Type [] parameters = new Type [1];
465 parameters [0] = event_type;
467 eb = new MyEventBuilder (null, TypeBuilder, ie.Name,
468 EventAttributes.None, event_type);
471 // Now define the accessors
473 string add_name = "add_" + ie.Name;
475 add = TypeBuilder.DefineMethod (
476 add_name, property_attributes, null, parameters);
477 add.DefineParameter (1, ParameterAttributes.None, "value");
478 eb.SetAddOnMethod (add);
480 string remove_name = "remove_" + ie.Name;
481 remove = TypeBuilder.DefineMethod (
482 remove_name, property_attributes, null, parameters);
483 remove.DefineParameter (1, ParameterAttributes.None, "value");
484 eb.SetRemoveOnMethod (remove);
486 Parameter [] parms = new Parameter [1];
487 parms [0] = new Parameter (ie.Type, "value", Parameter.Modifier.NONE, null);
488 InternalParameters ip = new InternalParameters (
489 this, new Parameters (parms, null, Location.Null));
491 if (!RegisterMethod (add, ip, parameters)) {
496 if (!RegisterMethod (remove, ip, parameters)) {
501 TypeManager.RegisterEvent (eb, add, remove);
502 event_builders.Add (eb);
508 // Populates the indexers in the interface
510 void PopulateIndexer (TypeContainer parent, DeclSpace decl_space, InterfaceIndexer ii)
513 ii.Type = this.ResolveTypeExpr (ii.Type, false, ii.Location);
517 Type prop_type = ii.Type.Type;
518 Type [] arg_types = ii.ParameterTypes (this);
519 Type [] value_arg_types;
521 if (prop_type == null)
524 if (prop_type.IsPointer && !UnsafeOK (this))
528 // Sets up the extra invisible `value' argument for setters.
530 if (arg_types != null){
531 int count = arg_types.Length;
532 value_arg_types = new Type [count + 1];
534 arg_types.CopyTo (value_arg_types, 0);
535 value_arg_types [count] = prop_type;
537 foreach (Type t in arg_types){
538 if (t.IsPointer && !UnsafeOK (this))
542 value_arg_types = new Type [1];
544 value_arg_types [1] = prop_type;
547 EmitContext ec = new EmitContext (parent, decl_space, Location, null,
548 null, ModFlags, false);
550 IndexerName = Attribute.ScanForIndexerName (ec, ii.OptAttributes);
551 if (IndexerName == null)
552 IndexerName = "Item";
554 pb = TypeBuilder.DefineProperty (
555 IndexerName, PropertyAttributes.None,
556 prop_type, arg_types);
558 MethodBuilder set_item = null, get_item = null;
560 Parameter [] p = ii.Parameters.FixedParameters;
562 get_item = TypeBuilder.DefineMethod (
563 "get_" + IndexerName, property_attributes,
564 prop_type, arg_types);
565 pb.SetGetMethod (get_item);
567 // HACK because System.Reflection.Emit is lame
569 InternalParameters ip = new InternalParameters (
570 arg_types, ii.Parameters);
572 if (!RegisterMethod (get_item, ip, arg_types)) {
578 for (int i = 0; i < p.Length; i++)
579 get_item.DefineParameter (
581 p [i].Attributes, p [i].Name);
586 Parameter [] p = ii.Parameters.FixedParameters;
590 pv = new Parameter [p.Length + 1];
592 pv [p.Length] = new Parameter (ii.Type, "value", Parameter.Modifier.NONE, null);
593 Parameters value_params = new Parameters (pv, null, Location.Null);
594 value_params.GetParameterInfo (decl_space);
596 set_item = TypeBuilder.DefineMethod (
597 "set_" + IndexerName, property_attributes,
598 TypeManager.void_type, value_arg_types);
599 pb.SetSetMethod (set_item);
601 // HACK because System.Reflection.Emit is lame
603 InternalParameters ip = new InternalParameters (
604 value_arg_types, value_params);
605 if (!RegisterMethod (set_item, ip, value_arg_types)) {
611 for (; i < p.Length; i++)
612 set_item.DefineParameter (
614 p [i].Attributes, p [i].Name);
617 set_item.DefineParameter (i + 1, ParameterAttributes.None, "value");
620 property_builders.Add (pb);
626 /// Performs the semantic analysis for all the interface members
627 /// that were declared
629 bool SemanticAnalysis ()
631 Hashtable methods = new Hashtable ();
634 if (defined_method != null){
635 foreach (InterfaceMethod im in defined_method){
636 string sig = im.GetSignature (this);
639 // If there was an undefined Type on the signatures
644 if (methods [sig] != null){
652 // FIXME: Here I should check i
657 Type GetInterfaceTypeByName (Expression name)
659 Expression original = name;
660 name = ResolveTypeExpr (name, false, Location);
672 cause = "is a struct";
674 cause = "is a class";
676 cause = "Should not happen.";
678 Report.Error (527, Location, "`"+name+"' " + cause +
679 ", need an interface instead");
685 // Returns the list of interfaces that this interface implements
686 // Or null if it does not implement any interface.
688 // Sets the error boolean accoringly.
690 Type [] GetInterfaceBases (out bool error)
699 tbases = new Type [Bases.Count];
702 foreach (Expression name in Bases){
705 t = GetInterfaceTypeByName (name);
711 if (!Parent.AsAccessible (t, ModFlags))
712 Report.Error (61, Location,
713 "Inconsistent accessibility: base interface `" +
714 TypeManager.CSharpName (t) + "' is less " +
715 "accessible than interface `" +
721 return TypeManager.ExpandInterfaces (tbases);
726 // Defines the Interface in the appropriate ModuleBuilder or TypeBuilder
730 // Rework the way we recurse, because for recursive
731 // definitions of interfaces (A:B and B:A) we report the
732 // error twice, rather than once.
734 public override TypeBuilder DefineType ()
739 if (TypeBuilder != null)
747 ifaces = GetInterfaceBases (out error);
753 if (TypeManager.NamespaceClash (Name, Location))
756 ModuleBuilder builder = CodeGen.ModuleBuilder;
758 TypeBuilder = builder.DefineType (
761 (Type)null, // Parent Type
763 RootContext.RegisterOrder (this);
765 TypeBuilder builder = Parent.TypeBuilder;
767 TypeBuilder = builder.DefineNestedType (
770 (Type) null, //parent type
773 TypeContainer tc = TypeManager.LookupTypeContainer (builder);
774 tc.RegisterOrder (this);
777 TypeManager.AddUserInterface (Name, TypeBuilder, this, ifaces);
784 // Defines the indexers, and also verifies that the IndexerNameAttribute in the
785 // interface is consistent. Either it is `Item' or it is the name defined by all the
786 // indexers with the `IndexerName' attribute.
788 // Turns out that the IndexerNameAttribute is applied to each indexer,
789 // but it is never emitted, instead a DefaultName attribute is attached
792 void DefineIndexers (TypeContainer parent)
794 string interface_indexer_name = null;
796 foreach (InterfaceIndexer ii in defined_indexer){
798 PopulateIndexer (parent, this, ii);
800 if (interface_indexer_name == null){
801 interface_indexer_name = IndexerName;
805 if (IndexerName == interface_indexer_name)
809 668, "Two indexers have different names, " +
810 " you should use the same name for all your indexers");
812 if (interface_indexer_name == null)
813 interface_indexer_name = "Item";
814 IndexerName = interface_indexer_name;
818 /// Performs semantic analysis, and then generates the IL interfaces
820 public override bool DefineMembers (TypeContainer parent)
825 if (!SemanticAnalysis ())
829 if (defined_method != null){
830 foreach (InterfaceMethod im in defined_method)
831 PopulateMethod (parent, this, im);
834 if (defined_properties != null){
835 foreach (InterfaceProperty ip in defined_properties)
836 PopulateProperty (parent, this, ip);
839 if (defined_events != null)
840 foreach (InterfaceEvent ie in defined_events)
841 PopulateEvent (parent, this, ie);
843 if (defined_indexer != null) {
844 DefineIndexers (parent);
846 CustomAttributeBuilder cb = EmitDefaultMemberAttr (
847 parent, IndexerName, ModFlags, Location);
849 TypeBuilder.SetCustomAttribute (cb);
853 if (TypeBuilder.BaseType != null)
854 parent_container = TypeManager.LookupMemberContainer (TypeBuilder.BaseType);
856 member_cache = new MemberCache (this);
858 members_defined = true;
864 // In the case of Interfaces, there is nothing to do here
866 public override bool Define (TypeContainer parent)
872 /// Applies all the attributes.
874 public void Emit (TypeContainer tc)
876 if (OptAttributes != null) {
877 EmitContext ec = new EmitContext (tc, this, Location, null, null,
879 Attribute.ApplyAttributes (ec, TypeBuilder, this, OptAttributes);
882 // Now emit attributes for each interface member
883 if (defined_method != null) {
884 foreach (InterfaceMethod im in defined_method) {
885 EmitContext ec = new EmitContext (tc, this, Location, null,
886 im.ReturnType.Type, ModFlags, false);
888 if (im.OptAttributes != null)
889 Attribute.ApplyAttributes (ec, im.Builder, im, im.OptAttributes);
893 if (defined_properties != null) {
894 foreach (InterfaceProperty ip in defined_properties) {
895 EmitContext ec = new EmitContext (tc, this, Location, null,
896 null, ModFlags, false);
898 if (ip.OptAttributes != null)
899 Attribute.ApplyAttributes (ec, ip.Builder, ip, ip.OptAttributes);
903 if (defined_events != null) {
904 foreach (InterfaceEvent ie in defined_events) {
905 EmitContext ec = new EmitContext (tc, this, Location, null,
906 null, ModFlags, false);
908 if (ie.OptAttributes != null)
909 Attribute.ApplyAttributes (ec, ie.Builder, ie, ie.OptAttributes);
914 public static CustomAttributeBuilder EmitDefaultMemberAttr (TypeContainer parent,
919 EmitContext ec = new EmitContext (parent, loc, null, null, flags);
921 Expression ml = Expression.MemberLookup (ec, TypeManager.default_member_type,
922 ".ctor", MemberTypes.Constructor,
923 BindingFlags.Public | BindingFlags.Instance,
926 if (!(ml is MethodGroupExpr)) {
927 Console.WriteLine ("Internal error !!!!");
931 MethodGroupExpr mg = (MethodGroupExpr) ml;
933 MethodBase constructor = mg.Methods [0];
935 string [] vals = { name };
937 CustomAttributeBuilder cb = null;
939 cb = new CustomAttributeBuilder ((ConstructorInfo) constructor, vals);
941 Report.Warning (-100, "Can not set the indexer default member attribute");
951 string IMemberContainer.Name {
957 Type IMemberContainer.Type {
963 IMemberContainer IMemberContainer.Parent {
965 return parent_container;
969 MemberCache IMemberContainer.MemberCache {
975 bool IMemberContainer.IsInterface {
981 MemberList IMemberContainer.GetMembers (MemberTypes mt, BindingFlags bf)
983 // Interfaces only contain instance members.
984 if ((bf & BindingFlags.Instance) == 0)
985 return MemberList.Empty;
986 if ((bf & BindingFlags.Public) == 0)
987 return MemberList.Empty;
989 ArrayList members = new ArrayList ();
991 if ((mt & MemberTypes.Method) != 0)
992 members.AddRange (method_builders);
994 if ((mt & MemberTypes.Property) != 0)
995 members.AddRange (property_builders);
997 if ((mt & MemberTypes.Event) != 0)
998 members.AddRange (event_builders);
1000 return new MemberList (members);
1004 public class InterfaceMemberBase {
1005 public readonly string Name;
1006 public readonly bool IsNew;
1007 public Attributes OptAttributes;
1009 public InterfaceMemberBase (string name, bool is_new, Attributes attrs)
1013 OptAttributes = attrs;
1017 public class InterfaceProperty : InterfaceMemberBase {
1018 public readonly bool HasSet;
1019 public readonly bool HasGet;
1020 public readonly Location Location;
1021 public Expression Type;
1022 public PropertyBuilder Builder;
1024 public InterfaceProperty (Expression type, string name,
1025 bool is_new, bool has_get, bool has_set,
1026 Attributes attrs, Location loc)
1027 : base (name, is_new, attrs)
1036 public class InterfaceEvent : InterfaceMemberBase {
1037 public readonly Location Location;
1038 public Expression Type;
1039 public MyEventBuilder Builder;
1041 public InterfaceEvent (Expression type, string name, bool is_new, Attributes attrs,
1043 : base (name, is_new, attrs)
1050 public class InterfaceMethod : InterfaceMemberBase {
1051 public Expression ReturnType;
1052 public readonly Parameters Parameters;
1053 public readonly Location Location;
1054 public MethodBuilder Builder;
1056 public InterfaceMethod (Expression return_type, string name, bool is_new, Parameters args,
1057 Attributes attrs, Location l)
1058 : base (name, is_new, attrs)
1060 this.ReturnType = return_type;
1061 this.Parameters = args;
1066 /// Returns the signature for this interface method
1068 public string GetSignature (DeclSpace ds)
1070 ReturnType = ds.ResolveTypeExpr (ReturnType, false, Location);
1071 if (ReturnType == null)
1074 Type ret = ReturnType.Type;
1075 string args = Parameters.GetSignature (ds);
1077 if ((ret == null) || (args == null))
1080 return (IsNew ? "new-" : "") + ret.FullName + "(" + args + ")";
1083 public Type [] ParameterTypes (DeclSpace ds)
1085 return Parameters.GetParameterInfo (ds);
1089 public class InterfaceIndexer : InterfaceMemberBase {
1090 public readonly bool HasGet, HasSet;
1091 public readonly Parameters Parameters;
1092 public readonly Location Location;
1093 public Expression Type;
1094 public PropertyBuilder Builder;
1096 public InterfaceIndexer (Expression type, Parameters args, bool do_get, bool do_set,
1097 bool is_new, Attributes attrs, Location loc)
1098 : base ("", is_new, attrs)
1107 public Type [] ParameterTypes (DeclSpace ds)
1109 return Parameters.GetParameterInfo (ds);