//
// decl.cs: Declaration base class for structs, classes, enums and interfaces.
//
// Author: Miguel de Icaza (miguel@gnu.org)
//
// Licensed under the terms of the GNU GPL
//
// (C) 2001 Ximian, Inc (http://www.ximian.com)
//
// TODO: Move the method verification stuff from the class.cs and interface.cs here
//
using System;
using System.Text;
using System.Collections;
using System.Reflection.Emit;
using System.Reflection;
namespace Mono.CSharp {
public class MemberName {
public readonly string Name;
public readonly TypeArguments TypeArguments;
public readonly MemberName Left;
public static readonly MemberName Null = new MemberName ("");
public MemberName (string name)
{
this.Name = name;
}
public MemberName (string name, TypeArguments args)
: this (name)
{
this.TypeArguments = args;
}
public MemberName (MemberName left, string name, TypeArguments args)
: this (name, args)
{
this.Left = left;
}
public string GetName ()
{
if (Left != null)
return Left.GetName () + "." + Name;
else
return Name;
}
public string GetFullName ()
{
string full_name;
if (TypeArguments != null)
full_name = Name + "<" + TypeArguments + ">";
else
full_name = Name;
if (Left != null)
return Left.GetFullName () + "." + full_name;
else
return full_name;
}
public string GetMemberName ()
{
string full_name;
if (Left != null)
return Left.GetFullName () + "." + Name;
else
return Name;
}
public Expression GetTypeExpression (Location loc)
{
if (Left != null) {
Expression lexpr = Left.GetTypeExpression (loc);
if (TypeArguments != null)
return new GenericMemberAccess (lexpr, Name, TypeArguments, loc);
else
return new MemberAccess (lexpr, Name, loc);
} else {
if (TypeArguments != null)
return new ConstructedType (Name, TypeArguments, loc);
else
return new SimpleName (Name, loc);
}
}
public override string ToString ()
{
string full_name;
if (TypeArguments != null)
full_name = Name + "<" + TypeArguments + ">";
else
full_name = Name;
if (Left != null)
return Left + "." + full_name;
else
return full_name;
}
}
///
/// Base representation for members. This is only used to keep track
/// of Name, Location and Modifier flags.
///
public abstract class MemberCore {
///
/// Public name
///
public string Name;
///
/// Modifier flags that the user specified in the source code
///
public int ModFlags;
///
/// Location where this declaration happens
///
public readonly Location Location;
///
/// Attributes for this type
///
Attributes attributes;
public MemberCore (string name, Attributes attrs, Location loc)
{
Name = name;
Location = loc;
attributes = attrs;
}
public abstract bool Define (TypeContainer parent);
//
// Returns full member name for error message
//
public virtual string GetSignatureForError () {
return Name;
}
public Attributes OptAttributes
{
get {
return attributes;
}
set {
attributes = value;
}
}
//
// Whehter is it ok to use an unsafe pointer in this type container
//
public bool UnsafeOK (DeclSpace parent)
{
//
// First check if this MemberCore modifier flags has unsafe set
//
if ((ModFlags & Modifiers.UNSAFE) != 0)
return true;
if (parent.UnsafeContext)
return true;
Expression.UnsafeError (Location);
return false;
}
}
///
/// Base class for structs, classes, enumerations and interfaces.
///
///
/// They all create new declaration spaces. This
/// provides the common foundation for managing those name
/// spaces.
///
public abstract class DeclSpace : MemberCore {
///
/// This points to the actual definition that is being
/// created with System.Reflection.Emit
///
public TypeBuilder TypeBuilder;
///
/// If we are a generic type, this is the type we are
/// currently defining. We need to lookup members on this
/// instead of the TypeBuilder.
///
public TypeExpr CurrentType;
///
/// This variable tracks whether we have Closed the type
///
public bool Created = false;
//
// This is the namespace in which this typecontainer
// was declared. We use this to resolve names.
//
public NamespaceEntry NamespaceEntry;
public Hashtable Cache = new Hashtable ();
public string Basename;
///
/// defined_names is used for toplevel objects
///
protected Hashtable defined_names;
bool is_generic;
//
// Whether we are Generic
//
public bool IsGeneric {
get {
if (is_generic)
return true;
else if (parent != null)
return parent.IsGeneric;
else
return false;
}
}
TypeContainer parent;
public DeclSpace (NamespaceEntry ns, TypeContainer parent, string name, Attributes attrs, Location l)
: base (name, attrs, l)
{
NamespaceEntry = ns;
Basename = name.Substring (1 + name.LastIndexOf ('.'));
defined_names = new Hashtable ();
this.parent = parent;
}
public void RecordDecl ()
{
if ((NamespaceEntry != null) && (parent == RootContext.Tree.Types))
NamespaceEntry.DefineName (Basename, this);
}
///
/// The result value from adding an declaration into
/// a struct or a class
///
public enum AdditionResult {
///
/// The declaration has been successfully
/// added to the declation space.
///
Success,
///
/// The symbol has already been defined.
///
NameExists,
///
/// Returned if the declation being added to the
/// name space clashes with its container name.
///
/// The only exceptions for this are constructors
/// and static constructors
///
EnclosingClash,
///
/// Returned if a constructor was created (because syntactically
/// it looked like a constructor) but was not (because the name
/// of the method is not the same as the container class
///
NotAConstructor,
///
/// This is only used by static constructors to emit the
/// error 111, but this error for other things really
/// happens at another level for other functions.
///
MethodExists,
///
/// Some other error.
///
Error
}
///
/// Returns a status code based purely on the name
/// of the member being added
///
protected AdditionResult IsValid (string basename, string name)
{
if (basename == Basename)
return AdditionResult.EnclosingClash;
if (defined_names.Contains (name))
return AdditionResult.NameExists;
return AdditionResult.Success;
}
public static int length;
public static int small;
///
/// Introduce @name into this declaration space and
/// associates it with the object @o. Note that for
/// methods this will just point to the first method. o
///
public void DefineName (string name, object o)
{
defined_names.Add (name, o);
#if DEBUGME
int p = name.LastIndexOf ('.');
int l = name.Length;
length += l;
small += l -p;
#endif
}
///
/// Returns the object associated with a given name in the declaration
/// space. This is the inverse operation of `DefineName'
///
public object GetDefinition (string name)
{
return defined_names [name];
}
bool in_transit = false;
///
/// This function is used to catch recursive definitions
/// in declarations.
///
public bool InTransit {
get {
return in_transit;
}
set {
in_transit = value;
}
}
public TypeContainer Parent {
get {
return parent;
}
}
///
/// Looks up the alias for the name
///
public string LookupAlias (string name)
{
if (NamespaceEntry != null)
return NamespaceEntry.LookupAlias (name);
else
return null;
}
//
// root_types contains all the types. All TopLevel types
// hence have a parent that points to `root_types', that is
// why there is a non-obvious test down here.
//
public bool IsTopLevel {
get {
if (parent != null){
if (parent.parent == null)
return true;
}
return false;
}
}
public virtual void CloseType ()
{
if (!Created){
try {
TypeBuilder.CreateType ();
} catch {
//
// The try/catch is needed because
// nested enumerations fail to load when they
// are defined.
//
// Even if this is the right order (enumerations
// declared after types).
//
// Note that this still creates the type and
// it is possible to save it
}
Created = true;
}
}
///
/// Should be overriten by the appropriate declaration space
///
public abstract TypeBuilder DefineType ();
///
/// Define all members, but don't apply any attributes or do anything which may
/// access not-yet-defined classes. This method also creates the MemberCache.
///
public abstract bool DefineMembers (TypeContainer parent);
//
// Whether this is an `unsafe context'
//
public bool UnsafeContext {
get {
if ((ModFlags & Modifiers.UNSAFE) != 0)
return true;
if (parent != null)
return parent.UnsafeContext;
return false;
}
}
public static string MakeFQN (string nsn, string name)
{
if (nsn == "")
return name;
return String.Concat (nsn, ".", name);
}
EmitContext type_resolve_ec;
EmitContext GetTypeResolveEmitContext (TypeContainer parent, Location loc)
{
type_resolve_ec = new EmitContext (parent, this, loc, null, null, ModFlags, false);
type_resolve_ec.ResolvingTypeTree = true;
return type_resolve_ec;
}
//
// Looks up the type, as parsed into the expression `e'
//
public Type ResolveType (Expression e, bool silent, Location loc)
{
TypeExpr d = ResolveTypeExpr (e, silent, loc);
if (d == null)
return null;
return ResolveType (d, loc);
}
public Type ResolveType (TypeExpr d, Location loc)
{
if (!d.CheckAccessLevel (this)) {
Report. Error (122, loc, "`" + d.Name + "' " +
"is inaccessible because of its protection level");
return null;
}
Type t = d.ResolveType (type_resolve_ec);
if (t == null)
return null;
TypeContainer tc = TypeManager.LookupTypeContainer (t);
if ((tc != null) && tc.IsGeneric) {
ConstructedType ctype = new ConstructedType (
t, TypeParameters, loc);
t = ctype.ResolveType (type_resolve_ec);
}
return t;
}
//
// Resolves the expression `e' for a type, and will recursively define
// types.
//
public TypeExpr ResolveTypeExpr (Expression e, bool silent, Location loc)
{
if (type_resolve_ec == null)
type_resolve_ec = GetTypeResolveEmitContext (parent, loc);
type_resolve_ec.loc = loc;
if (this is GenericMethod)
type_resolve_ec.ContainerType = Parent.TypeBuilder;
else
type_resolve_ec.ContainerType = TypeBuilder;
int errors = Report.Errors;
TypeExpr d = e.ResolveAsTypeTerminal (type_resolve_ec);
if ((d != null) && (d.eclass == ExprClass.Type))
return d;
if (silent || (Report.Errors != errors))
return null;
if (e is SimpleName){
SimpleName s = new SimpleName (((SimpleName) e).Name, -1, loc);
d = s.ResolveAsTypeTerminal (type_resolve_ec);
if ((d == null) || (d.Type == null)) {
Report.Error (246, loc, "Cannot find type `{0}'", e);
return null;
}
int num_args = TypeManager.GetNumberOfTypeArguments (d.Type);
if (num_args == 0) {
Report.Error (308, loc,
"The non-generic type `{0}' cannot " +
"be used with type arguments.",
TypeManager.CSharpName (d.Type));
return null;
}
Report.Error (305, loc,
"Using the generic type `{0}' " +
"requires {1} type arguments",
TypeManager.GetFullName (d.Type), num_args);
return null;
}
Report.Error (246, loc, "Cannot find type `{0}'", e);
return null;
}
public bool CheckAccessLevel (Type check_type)
{
TypeBuilder tb;
if (this is GenericMethod)
tb = Parent.TypeBuilder;
else
tb = TypeBuilder;
if (check_type.IsGenericInstance)
check_type = check_type.GetGenericTypeDefinition ();
if (check_type == tb)
return true;
if (check_type.IsGenericParameter)
return true; // FIXME
TypeAttributes check_attr = check_type.Attributes & TypeAttributes.VisibilityMask;
//
// Broken Microsoft runtime, return public for arrays, no matter what
// the accessibility is for their underlying class, and they return
// NonPublic visibility for pointers
//
if (check_type.IsArray || check_type.IsPointer)
return CheckAccessLevel (TypeManager.GetElementType (check_type));
switch (check_attr){
case TypeAttributes.Public:
return true;
case TypeAttributes.NotPublic:
//
// This test should probably use the declaringtype.
//
if (check_type.Assembly == tb.Assembly){
return true;
}
return false;
case TypeAttributes.NestedPublic:
return true;
case TypeAttributes.NestedPrivate:
string check_type_name = check_type.FullName;
string type_name = CurrentType != null ?
CurrentType.Name : tb.FullName;
int cio = check_type_name.LastIndexOf ('+');
string container = check_type_name.Substring (0, cio);
//
// Check if the check_type is a nested class of the current type
//
if (check_type_name.StartsWith (type_name + "+")){
return true;
}
if (type_name.StartsWith (container)){
return true;
}
return false;
case TypeAttributes.NestedFamily:
//
// Only accessible to methods in current type or any subtypes
//
return FamilyAccessible (tb, check_type);
case TypeAttributes.NestedFamANDAssem:
return (check_type.Assembly == tb.Assembly) &&
FamilyAccessible (tb, check_type);
case TypeAttributes.NestedFamORAssem:
return (check_type.Assembly == tb.Assembly) ||
FamilyAccessible (tb, check_type);
case TypeAttributes.NestedAssembly:
return check_type.Assembly == tb.Assembly;
}
Console.WriteLine ("HERE: " + check_attr);
return false;
}
protected bool FamilyAccessible (TypeBuilder tb, Type check_type)
{
Type declaring = check_type.DeclaringType;
if (tb.IsSubclassOf (declaring))
return true;
string check_type_name = check_type.FullName;
int cio = check_type_name.LastIndexOf ('+');
string container = check_type_name.Substring (0, cio);
//
// Check if the check_type is a nested class of the current type
//
if (check_type_name.StartsWith (container + "+"))
return true;
return false;
}
// Access level of a type.
const int X = 1;
enum AccessLevel { // Each column represents `is this scope larger or equal to Blah scope'
// Public Assembly Protected
Protected = (0 << 0) | (0 << 1) | (X << 2),
Public = (X << 0) | (X << 1) | (X << 2),
Private = (0 << 0) | (0 << 1) | (0 << 2),
Internal = (0 << 0) | (X << 1) | (0 << 2),
ProtectedOrInternal = (0 << 0) | (X << 1) | (X << 2),
}
static AccessLevel GetAccessLevelFromModifiers (int flags)
{
if ((flags & Modifiers.INTERNAL) != 0) {
if ((flags & Modifiers.PROTECTED) != 0)
return AccessLevel.ProtectedOrInternal;
else
return AccessLevel.Internal;
} else if ((flags & Modifiers.PROTECTED) != 0)
return AccessLevel.Protected;
else if ((flags & Modifiers.PRIVATE) != 0)
return AccessLevel.Private;
else
return AccessLevel.Public;
}
// What is the effective access level of this?
// TODO: Cache this?
AccessLevel EffectiveAccessLevel {
get {
AccessLevel myAccess = GetAccessLevelFromModifiers (ModFlags);
if (!IsTopLevel && (Parent != null))
return myAccess & Parent.EffectiveAccessLevel;
return myAccess;
}
}
// Return the access level for type `t'
static AccessLevel TypeEffectiveAccessLevel (Type t)
{
if (t.IsPublic)
return AccessLevel.Public;
if (t.IsNestedPrivate)
return AccessLevel.Private;
if (t.IsNotPublic)
return AccessLevel.Internal;
// By now, it must be nested
AccessLevel parentLevel = TypeEffectiveAccessLevel (t.DeclaringType);
if (t.IsNestedPublic)
return parentLevel;
if (t.IsNestedAssembly)
return parentLevel & AccessLevel.Internal;
if (t.IsNestedFamily)
return parentLevel & AccessLevel.Protected;
if (t.IsNestedFamORAssem)
return parentLevel & AccessLevel.ProtectedOrInternal;
if (t.IsNestedFamANDAssem)
throw new NotImplementedException ("NestedFamANDAssem not implemented, cant make this kind of type from c# anyways");
// nested private is taken care of
throw new Exception ("I give up, what are you?");
}
//
// This answers `is the type P, as accessible as a member M which has the
// accessability @flags which is declared as a nested member of the type T, this declspace'
//
public bool AsAccessible (Type p, int flags)
{
if (p.IsGenericParameter)
return true; // FIXME
//
// 1) if M is private, its accessability is the same as this declspace.
// we already know that P is accessible to T before this method, so we
// may return true.
//
if ((flags & Modifiers.PRIVATE) != 0)
return true;
while (p.IsArray || p.IsPointer || p.IsByRef)
p = TypeManager.GetElementType (p);
AccessLevel pAccess = TypeEffectiveAccessLevel (p);
AccessLevel mAccess = this.EffectiveAccessLevel &
GetAccessLevelFromModifiers (flags);
// for every place from which we can access M, we must
// be able to access P as well. So, we want
// For every bit in M and P, M_i -> P_1 == true
// or, ~ (M -> P) == 0 <-> ~ ( ~M | P) == 0
return ~ (~ mAccess | pAccess) == 0;
}
static DoubleHash dh = new DoubleHash (1000);
Type DefineTypeAndParents (DeclSpace tc)
{
DeclSpace container = tc.Parent;
if (container.TypeBuilder == null && container.Name != "")
DefineTypeAndParents (container);
return tc.DefineType ();
}
Type LookupInterfaceOrClass (string ns, string name, out bool error)
{
DeclSpace parent;
Type t;
object r;
error = false;
if (dh.Lookup (ns, name, out r))
return (Type) r;
else {
if (ns != ""){
if (Namespace.IsNamespace (ns)){
string fullname = (ns != "") ? ns + "." + name : name;
t = TypeManager.LookupType (fullname);
} else
t = null;
} else
t = TypeManager.LookupType (name);
}
if (t != null) {
dh.Insert (ns, name, t);
return t;
}
//
// In case we are fed a composite name, normalize it.
//
int p = name.LastIndexOf ('.');
if (p != -1){
ns = MakeFQN (ns, name.Substring (0, p));
name = name.Substring (p+1);
}
parent = RootContext.Tree.LookupByNamespace (ns, name);
if (parent == null) {
dh.Insert (ns, name, null);
return null;
}
t = DefineTypeAndParents (parent);
if (t == null){
error = true;
return null;
}
dh.Insert (ns, name, t);
return t;
}
public static void Error_AmbiguousTypeReference (Location loc, string name, Type t1, Type t2)
{
Report.Error (104, loc,
String.Format ("`{0}' is an ambiguous reference ({1} or {2}) ", name,
t1.FullName, t2.FullName));
}
public Type FindNestedType (Location loc, string name,
out DeclSpace containing_ds)
{
Type t;
bool error;
containing_ds = this;
while (containing_ds != null){
Type container_type = containing_ds.TypeBuilder;
Type current_type = container_type;
while (current_type != null && current_type != TypeManager.object_type) {
string pre = current_type.FullName;
t = LookupInterfaceOrClass (pre, name, out error);
if (error)
return null;
if ((t != null) && containing_ds.CheckAccessLevel (t))
return t;
current_type = current_type.BaseType;
}
containing_ds = containing_ds.Parent;
}
return null;
}
///
/// GetType is used to resolve type names at the DeclSpace level.
/// Use this to lookup class/struct bases, interface bases or
/// delegate type references
///
///
///
/// Contrast this to LookupType which is used inside method bodies to
/// lookup types that have already been defined. GetType is used
/// during the tree resolution process and potentially define
/// recursively the type
///
public Type FindType (Location loc, string name, int num_type_args)
{
Type t;
bool error;
//
// For the case the type we are looking for is nested within this one
// or is in any base class
//
DeclSpace containing_ds = this;
while (containing_ds != null){
Type container_type = containing_ds.TypeBuilder;
Type current_type = container_type;
while (current_type != null && current_type != TypeManager.object_type) {
string pre = current_type.FullName;
t = LookupInterfaceOrClass (pre, name, out error);
if (error)
return null;
if ((t != null) &&
containing_ds.CheckAccessLevel (t) &&
TypeManager.CheckGeneric (t, num_type_args))
return t;
current_type = current_type.BaseType;
}
containing_ds = containing_ds.Parent;
}
//
// Attempt to lookup the class on our namespace and all it's implicit parents
//
for (NamespaceEntry ns = NamespaceEntry; ns != null; ns = ns.ImplicitParent) {
t = LookupInterfaceOrClass (ns.FullName, name, out error);
if (error)
return null;
if ((t != null) && TypeManager.CheckGeneric (t, num_type_args))
return t;
}
//
// Attempt to do a direct unqualified lookup
//
t = LookupInterfaceOrClass ("", name, out error);
if (error)
return null;
if ((t != null) && TypeManager.CheckGeneric (t, num_type_args))
return t;
//
// Attempt to lookup the class on any of the `using'
// namespaces
//
for (NamespaceEntry ns = NamespaceEntry; ns != null; ns = ns.Parent){
t = LookupInterfaceOrClass (ns.FullName, name, out error);
if (error)
return null;
if ((t != null) && TypeManager.CheckGeneric (t, num_type_args))
return t;
//
// Now check the using clause list
//
Type match = null;
foreach (Namespace using_ns in ns.GetUsingTable ()) {
match = LookupInterfaceOrClass (using_ns.Name, name, out error);
if (error)
return null;
if ((match != null) &&
TypeManager.CheckGeneric (match, num_type_args)) {
if (t != null){
if (CheckAccessLevel (match)) {
Error_AmbiguousTypeReference (loc, name, t, match);
return null;
}
continue;
}
t = match;
}
}
if ((t != null) && TypeManager.CheckGeneric (t, num_type_args))
return t;
}
//Report.Error (246, Location, "Can not find type `"+name+"'");
return null;
}
///
/// This function is broken and not what you're looking for. It should only
/// be used while the type is still being created since it doesn't use the cache
/// and relies on the filter doing the member name check.
///
public abstract MemberList FindMembers (MemberTypes mt, BindingFlags bf,
MemberFilter filter, object criteria);
///
/// If we have a MemberCache, return it. This property may return null if the
/// class doesn't have a member cache or while it's still being created.
///
public abstract MemberCache MemberCache {
get;
}
//
// Extensions for generics
//
TypeParameter[] type_params;
TypeParameter[] type_param_list;
protected string GetInstantiationName ()
{
StringBuilder sb = new StringBuilder (Name);
sb.Append ("<");
for (int i = 0; i < type_param_list.Length; i++) {
if (i > 0)
sb.Append (",");
sb.Append (type_param_list [i].Name);
}
sb.Append (">");
return sb.ToString ();
}
bool check_type_parameter (ArrayList list, int start, string name)
{
for (int i = 0; i < start; i++) {
TypeParameter param = (TypeParameter) list [i];
if (param.Name != name)
continue;
if (RootContext.WarningLevel >= 3)
Report.Warning (
693, Location,
"Type parameter `{0}' has same name " +
"as type parameter from outer type `{1}'",
name, parent.GetInstantiationName ());
return false;
}
return true;
}
TypeParameter[] initialize_type_params ()
{
if (type_param_list != null)
return type_param_list;
DeclSpace the_parent = parent;
if (this is GenericMethod)
the_parent = the_parent.Parent;
int start = 0;
TypeParameter[] parent_params = null;
if ((the_parent != null) && the_parent.IsGeneric) {
parent_params = the_parent.initialize_type_params ();
start = parent_params != null ? parent_params.Length : 0;
}
ArrayList list = new ArrayList ();
if (parent_params != null)
list.AddRange (parent_params);
int count = type_params != null ? type_params.Length : 0;
for (int i = 0; i < count; i++) {
TypeParameter param = type_params [i];
check_type_parameter (list, start, param.Name);
list.Add (param);
}
type_param_list = new TypeParameter [list.Count];
list.CopyTo (type_param_list, 0);
return type_param_list;
}
///
/// Called by the parser to configure the type_parameter_list for this
/// declaration space
///
public AdditionResult SetParameterInfo (TypeArguments args,
ArrayList constraints_list)
{
string[] type_parameter_list = args.GetDeclarations ();
if (type_parameter_list == null)
return AdditionResult.Error;
return SetParameterInfo (type_parameter_list, constraints_list);
}
public AdditionResult SetParameterInfo (IList type_parameter_list,
ArrayList constraints_list)
{
type_params = new TypeParameter [type_parameter_list.Count];
//
// Mark this type as Generic
//
is_generic = true;
//
// Register all the names
//
for (int i = 0; i < type_parameter_list.Count; i++) {
string name = (string) type_parameter_list [i];
AdditionResult res = IsValid (name, name);
if (res != AdditionResult.Success)
return res;
Constraints constraints = null;
if (constraints_list != null) {
foreach (Constraints constraint in constraints_list) {
if (constraint.TypeParameter == name) {
constraints = constraint;
break;
}
}
}
type_params [i] = new TypeParameter (name, constraints, Location);
DefineName (name, type_params [i]);
}
return AdditionResult.Success;
}
public TypeParameter[] TypeParameters {
get {
if (!IsGeneric)
throw new InvalidOperationException ();
if (type_param_list == null)
initialize_type_params ();
return type_param_list;
}
}
protected TypeParameter[] CurrentTypeParameters {
get {
if (!IsGeneric)
throw new InvalidOperationException ();
if (type_params != null)
return type_params;
else
return new TypeParameter [0];
}
}
public int CountTypeParameters {
get {
if (!IsGeneric)
return 0;
if (type_param_list == null)
initialize_type_params ();
return type_param_list.Length;
}
}
public TypeParameterExpr LookupGeneric (string name, Location loc)
{
if (!IsGeneric)
return null;
foreach (TypeParameter type_param in CurrentTypeParameters) {
if (type_param.Name != name)
continue;
return new TypeParameterExpr (type_param, loc);
}
if (parent != null)
return parent.LookupGeneric (name, loc);
return null;
}
}
///
/// This is a readonly list of MemberInfo's.
///
public class MemberList : IList {
public readonly IList List;
int count;
///
/// Create a new MemberList from the given IList.
///
public MemberList (IList list)
{
if (list != null)
this.List = list;
else
this.List = new ArrayList ();
count = List.Count;
}
///
/// Concatenate the ILists `first' and `second' to a new MemberList.
///
public MemberList (IList first, IList second)
{
ArrayList list = new ArrayList ();
list.AddRange (first);
list.AddRange (second);
count = list.Count;
List = list;
}
public static readonly MemberList Empty = new MemberList (new ArrayList ());
///
/// Cast the MemberList into a MemberInfo[] array.
///
///
/// This is an expensive operation, only use it if it's really necessary.
///
public static explicit operator MemberInfo [] (MemberList list)
{
Timer.StartTimer (TimerType.MiscTimer);
MemberInfo [] result = new MemberInfo [list.Count];
list.CopyTo (result, 0);
Timer.StopTimer (TimerType.MiscTimer);
return result;
}
// ICollection
public int Count {
get {
return count;
}
}
public bool IsSynchronized {
get {
return List.IsSynchronized;
}
}
public object SyncRoot {
get {
return List.SyncRoot;
}
}
public void CopyTo (Array array, int index)
{
List.CopyTo (array, index);
}
// IEnumerable
public IEnumerator GetEnumerator ()
{
return List.GetEnumerator ();
}
// IList
public bool IsFixedSize {
get {
return true;
}
}
public bool IsReadOnly {
get {
return true;
}
}
object IList.this [int index] {
get {
return List [index];
}
set {
throw new NotSupportedException ();
}
}
// FIXME: try to find out whether we can avoid the cast in this indexer.
public MemberInfo this [int index] {
get {
return (MemberInfo) List [index];
}
}
public int Add (object value)
{
throw new NotSupportedException ();
}
public void Clear ()
{
throw new NotSupportedException ();
}
public bool Contains (object value)
{
return List.Contains (value);
}
public int IndexOf (object value)
{
return List.IndexOf (value);
}
public void Insert (int index, object value)
{
throw new NotSupportedException ();
}
public void Remove (object value)
{
throw new NotSupportedException ();
}
public void RemoveAt (int index)
{
throw new NotSupportedException ();
}
}
///
/// This interface is used to get all members of a class when creating the
/// member cache. It must be implemented by all DeclSpace derivatives which
/// want to support the member cache and by TypeHandle to get caching of
/// non-dynamic types.
///
public interface IMemberContainer {
///
/// The name of the IMemberContainer. This is only used for
/// debugging purposes.
///
string Name {
get;
}
///
/// The type of this IMemberContainer.
///
Type Type {
get;
}
///
/// Returns the IMemberContainer of the parent class or null if this
/// is an interface or TypeManger.object_type.
/// This is used when creating the member cache for a class to get all
/// members from the parent class.
///
IMemberContainer Parent {
get;
}
///
/// Whether this is an interface.
///
bool IsInterface {
get;
}
///
/// Returns all members of this class with the corresponding MemberTypes
/// and BindingFlags.
///
///
/// When implementing this method, make sure not to return any inherited
/// members and check the MemberTypes and BindingFlags properly.
/// Unfortunately, System.Reflection is lame and doesn't provide a way to
/// get the BindingFlags (static/non-static,public/non-public) in the
/// MemberInfo class, but the cache needs this information. That's why
/// this method is called multiple times with different BindingFlags.
///
MemberList GetMembers (MemberTypes mt, BindingFlags bf);
///
/// Return the container's member cache.
///
MemberCache MemberCache {
get;
}
}
///
/// The MemberCache is used by dynamic and non-dynamic types to speed up
/// member lookups. It has a member name based hash table; it maps each member
/// name to a list of CacheEntry objects. Each CacheEntry contains a MemberInfo
/// and the BindingFlags that were initially used to get it. The cache contains
/// all members of the current class and all inherited members. If this cache is
/// for an interface types, it also contains all inherited members.
///
/// There are two ways to get a MemberCache:
/// * if this is a dynamic type, lookup the corresponding DeclSpace and then
/// use the DeclSpace.MemberCache property.
/// * if this not a dynamic type, call TypeHandle.GetTypeHandle() to get a
/// TypeHandle instance for the type and then use TypeHandle.MemberCache.
///
public class MemberCache {
public readonly IMemberContainer Container;
protected Hashtable member_hash;
protected Hashtable method_hash;
Hashtable interface_hash;
///
/// Create a new MemberCache for the given IMemberContainer `container'.
///
public MemberCache (IMemberContainer container)
{
this.Container = container;
Timer.IncrementCounter (CounterType.MemberCache);
Timer.StartTimer (TimerType.CacheInit);
// If we have a parent class (we have a parent class unless we're
// TypeManager.object_type), we deep-copy its MemberCache here.
if (Container.IsInterface) {
MemberCache parent;
interface_hash = new Hashtable ();
if (Container.Parent != null)
parent = Container.Parent.MemberCache;
else
parent = TypeHandle.ObjectType.MemberCache;
member_hash = SetupCacheForInterface (parent);
} else if (Container.Parent != null)
member_hash = SetupCache (Container.Parent.MemberCache);
else
member_hash = new Hashtable ();
// If this is neither a dynamic type nor an interface, create a special
// method cache with all declared and inherited methods.
Type type = container.Type;
if (!(type is TypeBuilder) && !type.IsInterface) {
method_hash = new Hashtable ();
AddMethods (type);
}
// Add all members from the current class.
AddMembers (Container);
Timer.StopTimer (TimerType.CacheInit);
}
///
/// Bootstrap this member cache by doing a deep-copy of our parent.
///
Hashtable SetupCache (MemberCache parent)
{
Hashtable hash = new Hashtable ();
IDictionaryEnumerator it = parent.member_hash.GetEnumerator ();
while (it.MoveNext ()) {
hash [it.Key] = ((ArrayList) it.Value).Clone ();
}
return hash;
}
///
/// Add the contents of `new_hash' to `hash'.
///
void AddHashtable (Hashtable hash, Hashtable new_hash)
{
IDictionaryEnumerator it = new_hash.GetEnumerator ();
while (it.MoveNext ()) {
ArrayList list = (ArrayList) hash [it.Key];
if (list != null)
list.AddRange ((ArrayList) it.Value);
else
hash [it.Key] = ((ArrayList) it.Value).Clone ();
}
}
///
/// Bootstrap the member cache for an interface type.
/// Type.GetMembers() won't return any inherited members for interface types,
/// so we need to do this manually. Interfaces also inherit from System.Object.
///
Hashtable SetupCacheForInterface (MemberCache parent)
{
Hashtable hash = SetupCache (parent);
TypeExpr [] ifaces = TypeManager.GetInterfaces (Container.Type);
foreach (TypeExpr iface in ifaces) {
Type itype = iface.Type;
if (interface_hash.Contains (itype))
continue;
interface_hash [itype] = null;
IMemberContainer iface_container =
TypeManager.LookupMemberContainer (itype);
MemberCache iface_cache = iface_container.MemberCache;
AddHashtable (hash, iface_cache.member_hash);
if (iface_cache.interface_hash == null)
continue;
foreach (Type parent_contains in iface_cache.interface_hash.Keys)
interface_hash [parent_contains] = null;
}
return hash;
}
///
/// Add all members from class `container' to the cache.
///
void AddMembers (IMemberContainer container)
{
// We need to call AddMembers() with a single member type at a time
// to get the member type part of CacheEntry.EntryType right.
AddMembers (MemberTypes.Constructor, container);
AddMembers (MemberTypes.Field, container);
AddMembers (MemberTypes.Method, container);
AddMembers (MemberTypes.Property, container);
AddMembers (MemberTypes.Event, container);
// Nested types are returned by both Static and Instance searches.
AddMembers (MemberTypes.NestedType,
BindingFlags.Static | BindingFlags.Public, container);
AddMembers (MemberTypes.NestedType,
BindingFlags.Static | BindingFlags.NonPublic, container);
}
void AddMembers (MemberTypes mt, IMemberContainer container)
{
AddMembers (mt, BindingFlags.Static | BindingFlags.Public, container);
AddMembers (mt, BindingFlags.Static | BindingFlags.NonPublic, container);
AddMembers (mt, BindingFlags.Instance | BindingFlags.Public, container);
AddMembers (mt, BindingFlags.Instance | BindingFlags.NonPublic, container);
}
///
/// Add all members from class `container' with the requested MemberTypes and
/// BindingFlags to the cache. This method is called multiple times with different
/// MemberTypes and BindingFlags.
///
void AddMembers (MemberTypes mt, BindingFlags bf, IMemberContainer container)
{
MemberList members = container.GetMembers (mt, bf);
foreach (MemberInfo member in members) {
string name = member.Name;
int pos = name.IndexOf ('<');
if (pos > 0)
name = name.Substring (0, pos);
// We use a name-based hash table of ArrayList's.
ArrayList list = (ArrayList) member_hash [name];
if (list == null) {
list = new ArrayList ();
member_hash.Add (name, list);
}
// When this method is called for the current class, the list will
// already contain all inherited members from our parent classes.
// We cannot add new members in front of the list since this'd be an
// expensive operation, that's why the list is sorted in reverse order
// (ie. members from the current class are coming last).
list.Add (new CacheEntry (container, member, mt, bf));
}
}
///
/// Add all declared and inherited methods from class `type' to the method cache.
///
void AddMethods (Type type)
{
AddMethods (BindingFlags.Static | BindingFlags.Public |
BindingFlags.FlattenHierarchy, type);
AddMethods (BindingFlags.Static | BindingFlags.NonPublic |
BindingFlags.FlattenHierarchy, type);
AddMethods (BindingFlags.Instance | BindingFlags.Public, type);
AddMethods (BindingFlags.Instance | BindingFlags.NonPublic, type);
}
void AddMethods (BindingFlags bf, Type type)
{
MemberInfo [] members = type.GetMethods (bf);
Array.Reverse (members);
foreach (MethodBase member in members) {
string name = member.Name;
// Varargs methods aren't allowed in C# code.
if ((member.CallingConvention & CallingConventions.VarArgs) != 0)
continue;
// We use a name-based hash table of ArrayList's.
ArrayList list = (ArrayList) method_hash [name];
if (list == null) {
list = new ArrayList ();
method_hash.Add (name, list);
}
// Unfortunately, the elements returned by Type.GetMethods() aren't
// sorted so we need to do this check for every member.
BindingFlags new_bf = bf;
if (member.DeclaringType == type)
new_bf |= BindingFlags.DeclaredOnly;
list.Add (new CacheEntry (Container, member, MemberTypes.Method, new_bf));
}
}
///
/// Compute and return a appropriate `EntryType' magic number for the given
/// MemberTypes and BindingFlags.
///
protected static EntryType GetEntryType (MemberTypes mt, BindingFlags bf)
{
EntryType type = EntryType.None;
if ((mt & MemberTypes.Constructor) != 0)
type |= EntryType.Constructor;
if ((mt & MemberTypes.Event) != 0)
type |= EntryType.Event;
if ((mt & MemberTypes.Field) != 0)
type |= EntryType.Field;
if ((mt & MemberTypes.Method) != 0)
type |= EntryType.Method;
if ((mt & MemberTypes.Property) != 0)
type |= EntryType.Property;
// Nested types are returned by static and instance searches.
if ((mt & MemberTypes.NestedType) != 0)
type |= EntryType.NestedType | EntryType.Static | EntryType.Instance;
if ((bf & BindingFlags.Instance) != 0)
type |= EntryType.Instance;
if ((bf & BindingFlags.Static) != 0)
type |= EntryType.Static;
if ((bf & BindingFlags.Public) != 0)
type |= EntryType.Public;
if ((bf & BindingFlags.NonPublic) != 0)
type |= EntryType.NonPublic;
if ((bf & BindingFlags.DeclaredOnly) != 0)
type |= EntryType.Declared;
return type;
}
///
/// The `MemberTypes' enumeration type is a [Flags] type which means that it may
/// denote multiple member types. Returns true if the given flags value denotes a
/// single member types.
///
public static bool IsSingleMemberType (MemberTypes mt)
{
switch (mt) {
case MemberTypes.Constructor:
case MemberTypes.Event:
case MemberTypes.Field:
case MemberTypes.Method:
case MemberTypes.Property:
case MemberTypes.NestedType:
return true;
default:
return false;
}
}
///
/// We encode the MemberTypes and BindingFlags of each members in a "magic"
/// number to speed up the searching process.
///
[Flags]
protected enum EntryType {
None = 0x000,
Instance = 0x001,
Static = 0x002,
MaskStatic = Instance|Static,
Public = 0x004,
NonPublic = 0x008,
MaskProtection = Public|NonPublic,
Declared = 0x010,
Constructor = 0x020,
Event = 0x040,
Field = 0x080,
Method = 0x100,
Property = 0x200,
NestedType = 0x400,
MaskType = Constructor|Event|Field|Method|Property|NestedType
}
protected struct CacheEntry {
public readonly IMemberContainer Container;
public readonly EntryType EntryType;
public readonly MemberInfo Member;
public CacheEntry (IMemberContainer container, MemberInfo member,
MemberTypes mt, BindingFlags bf)
{
this.Container = container;
this.Member = member;
this.EntryType = GetEntryType (mt, bf);
}
}
///
/// This is called each time we're walking up one level in the class hierarchy
/// and checks whether we can abort the search since we've already found what
/// we were looking for.
///
protected bool DoneSearching (ArrayList list)
{
//
// We've found exactly one member in the current class and it's not
// a method or constructor.
//
if (list.Count == 1 && !(list [0] is MethodBase))
return true;
//
// Multiple properties: we query those just to find out the indexer
// name
//
if ((list.Count > 0) && (list [0] is PropertyInfo))
return true;
return false;
}
///
/// Looks up members with name `name'. If you provide an optional
/// filter function, it'll only be called with members matching the
/// requested member name.
///
/// This method will try to use the cache to do the lookup if possible.
///
/// Unlike other FindMembers implementations, this method will always
/// check all inherited members - even when called on an interface type.
///
/// If you know that you're only looking for methods, you should use
/// MemberTypes.Method alone since this speeds up the lookup a bit.
/// When doing a method-only search, it'll try to use a special method
/// cache (unless it's a dynamic type or an interface) and the returned
/// MemberInfo's will have the correct ReflectedType for inherited methods.
/// The lookup process will automatically restart itself in method-only
/// search mode if it discovers that it's about to return methods.
///
ArrayList global = new ArrayList ();
bool using_global = false;
public MemberList FindMembers (MemberTypes mt, BindingFlags bf, string name,
MemberFilter filter, object criteria)
{
if (using_global)
throw new Exception ();
bool declared_only = (bf & BindingFlags.DeclaredOnly) != 0;
bool method_search = mt == MemberTypes.Method;
// If we have a method cache and we aren't already doing a method-only search,
// then we restart a method search if the first match is a method.
bool do_method_search = !method_search && (method_hash != null);
ArrayList applicable;
// If this is a method-only search, we try to use the method cache if
// possible; a lookup in the method cache will return a MemberInfo with
// the correct ReflectedType for inherited methods.
if (method_search && (method_hash != null))
applicable = (ArrayList) method_hash [name];
else
applicable = (ArrayList) member_hash [name];
if (applicable == null)
return MemberList.Empty;
//
// 32 slots gives 53 rss/54 size
// 2/4 slots gives 55 rss
//
// Strange: from 25,000 calls, only 1,800
// are above 2. Why does this impact it?
//
global.Clear ();
using_global = true;
Timer.StartTimer (TimerType.CachedLookup);
EntryType type = GetEntryType (mt, bf);
IMemberContainer current = Container;
// `applicable' is a list of all members with the given member name `name'
// in the current class and all its parent classes. The list is sorted in
// reverse order due to the way how the cache is initialy created (to speed
// things up, we're doing a deep-copy of our parent).
for (int i = applicable.Count-1; i >= 0; i--) {
CacheEntry entry = (CacheEntry) applicable [i];
// This happens each time we're walking one level up in the class
// hierarchy. If we're doing a DeclaredOnly search, we must abort
// the first time this happens (this may already happen in the first
// iteration of this loop if there are no members with the name we're
// looking for in the current class).
if (entry.Container != current) {
if (declared_only || DoneSearching (global))
break;
current = entry.Container;
}
// Is the member of the correct type ?
if ((entry.EntryType & type & EntryType.MaskType) == 0)
continue;
// Is the member static/non-static ?
if ((entry.EntryType & type & EntryType.MaskStatic) == 0)
continue;
// Apply the filter to it.
if (filter (entry.Member, criteria)) {
if ((entry.EntryType & EntryType.MaskType) != EntryType.Method)
do_method_search = false;
global.Add (entry.Member);
}
}
Timer.StopTimer (TimerType.CachedLookup);
// If we have a method cache and we aren't already doing a method-only
// search, we restart in method-only search mode if the first match is
// a method. This ensures that we return a MemberInfo with the correct
// ReflectedType for inherited methods.
if (do_method_search && (global.Count > 0)){
using_global = false;
return FindMembers (MemberTypes.Method, bf, name, filter, criteria);
}
using_global = false;
MemberInfo [] copy = new MemberInfo [global.Count];
global.CopyTo (copy);
return new MemberList (copy);
}
//
// This finds the method or property for us to override. invocationType is the type where
// the override is going to be declared, name is the name of the method/property, and
// paramTypes is the parameters, if any to the method or property
//
// Because the MemberCache holds members from this class and all the base classes,
// we can avoid tons of reflection stuff.
//
public MemberInfo FindMemberToOverride (Type invocationType, string name, Type [] paramTypes, bool is_property)
{
ArrayList applicable;
if (method_hash != null && !is_property)
applicable = (ArrayList) method_hash [name];
else
applicable = (ArrayList) member_hash [name];
if (applicable == null)
return null;
//
// Walk the chain of methods, starting from the top.
//
for (int i = applicable.Count - 1; i >= 0; i--) {
CacheEntry entry = (CacheEntry) applicable [i];
if ((entry.EntryType & (is_property ? EntryType.Property : EntryType.Method)) == 0)
continue;
PropertyInfo pi = null;
MethodInfo mi = null;
Type [] cmpAttrs;
if (is_property) {
pi = (PropertyInfo) entry.Member;
cmpAttrs = TypeManager.GetArgumentTypes (pi);
} else {
mi = (MethodInfo) entry.Member;
cmpAttrs = TypeManager.GetArgumentTypes (mi);
}
//
// Check the arguments
//
if (cmpAttrs.Length != paramTypes.Length)
continue;
for (int j = cmpAttrs.Length - 1; j >= 0; j --) {
if (!paramTypes [j].Equals (cmpAttrs [j]))
goto next;
}
//
// get one of the methods because this has the visibility info.
//
if (is_property) {
mi = pi.GetGetMethod (true);
if (mi == null)
mi = pi.GetSetMethod (true);
}
//
// Check visibility
//
switch (mi.Attributes & MethodAttributes.MemberAccessMask) {
case MethodAttributes.Private:
//
// A private method is Ok if we are a nested subtype.
// The spec actually is not very clear about this, see bug 52458.
//
if (invocationType == entry.Container.Type ||
TypeManager.IsNestedChildOf (invocationType, entry.Container.Type))
return entry.Member;
break;
case MethodAttributes.FamANDAssem:
case MethodAttributes.Assembly:
//
// Check for assembly methods
//
if (mi.DeclaringType.Assembly == CodeGen.Assembly.Builder)
return entry.Member;
break;
default:
//
// A protected method is ok, because we are overriding.
// public is always ok.
//
return entry.Member;
}
next:
;
}
return null;
}
}
}