/// <summary>
/// C# compiler uses complecated logic to generate docIds for Eii properties. Need to have special logic here.
/// </summary>
/// <param name="property">Value to process</param>
/// <returns>DocId for property member wchich needs to be equal to docId generated by compiler's /doc flag </returns>
protected override string EiiPropertyProcessing(PropertyReference property)
{
string name;
PropertyDefinition propertyDef = property as PropertyDefinition;
MethodDefinition method = null;
if (propertyDef != null)
{
method = propertyDef.GetMethod ?? propertyDef.SetMethod;
}
if (method != null && !DocUtils.IsExplicitlyImplemented(method))
{
name = property.Name;
}
else
{
DocUtils.GetInfoForExplicitlyImplementedMethod(method, out var iface, out var ifaceMethod);
AddTypeCount = false;
name = string.Join("#", new string[] {
GetTypeName(iface).Replace(".", "#"),
DocUtils.GetMember(property.Name)
});
AddTypeCount = true;
}
return(name);
}
protected override StringBuilder AppendMethodName(StringBuilder buf, MethodDefinition method)
{
if (DocUtils.IsExplicitlyImplemented(method))
{
TypeReference iface;
MethodReference ifaceMethod;
DocUtils.GetInfoForExplicitlyImplementedMethod(method, out iface, out ifaceMethod);
return(buf.Append(new CSharpMemberFormatter(this.TypeMap).GetName(iface))
.Append('.')
.Append(ifaceMethod.Name));
}
return(base.AppendMethodName(buf, method));
}
protected override string GetPropertyName(PropertyReference property)
{
string name = null;
PropertyDefinition propertyDef = property as PropertyDefinition;
MethodDefinition method = null;
if (propertyDef != null)
{
method = propertyDef.GetMethod ?? propertyDef.SetMethod;
}
if (method != null && !DocUtils.IsExplicitlyImplemented(method))
{
name = property.Name;
}
else
{
TypeReference iface;
MethodReference ifaceMethod;
DocUtils.GetInfoForExplicitlyImplementedMethod(method, out iface, out ifaceMethod);
AddTypeCount = false;
name = string.Join("#", new string[] {
GetTypeName(iface).Replace(".", "#"),
DocUtils.GetMember(property.Name)
});
AddTypeCount = true;
}
StringBuilder buf = new StringBuilder();
buf.Append(GetName(property.DeclaringType));
buf.Append('.');
buf.Append(name);
IList <ParameterDefinition> parameters = property.Parameters;
if (parameters.Count > 0)
{
genDeclType = property.DeclaringType;
buf.Append('(');
IList <GenericParameter> genArgs = property.DeclaringType.GenericParameters;
AppendParameter(buf, genArgs, parameters[0]);
for (int i = 1; i < parameters.Count; ++i)
{
buf.Append(',');
AppendParameter(buf, genArgs, parameters[i]);
}
buf.Append(')');
genDeclType = null;
}
return(buf.ToString());
}
protected override string GetMethodName(MethodReference method)
{
string name = null;
MethodDefinition methodDef = method as MethodDefinition;
if (methodDef == null || !DocUtils.IsExplicitlyImplemented(methodDef))
{
name = method.Name;
}
else
{
TypeReference iface;
MethodReference ifaceMethod;
DocUtils.GetInfoForExplicitlyImplementedMethod(methodDef, out iface, out ifaceMethod);
AddTypeCount = false;
name = GetTypeName(iface) + "." + ifaceMethod.Name;
AddTypeCount = true;
}
return(GetMethodDefinitionName(method, name));
}
protected override string GetPropertyDeclaration(PropertyDefinition property)
{
string getVisible = null;
if (DocUtils.IsAvailablePropertyMethod(property.GetMethod))
{
getVisible = AppendVisibility(new StringBuilder(), property.GetMethod).ToString();
}
string setVisible = null;
if (DocUtils.IsAvailablePropertyMethod(property.SetMethod))
{
setVisible = AppendVisibility(new StringBuilder(), property.SetMethod).ToString();
}
if (setVisible == null && getVisible == null)
{
return(null);
}
StringBuilder buf = new StringBuilder();
IEnumerable <MemberReference> defs = property.DeclaringType.GetDefaultMembers();
bool indexer = false;
foreach (MemberReference mi in defs)
{
if (mi == property)
{
indexer = true;
break;
}
}
if (indexer)
{
buf.Append("Default ");
}
if (getVisible != null && (setVisible == null || (setVisible != null && getVisible == setVisible)))
{
buf.Append(getVisible);
}
else if (setVisible != null && getVisible == null)
{
buf.Append(setVisible);
}
else
{
buf.Append("Public");
}
// Pick an accessor to use for static/virtual/override/etc. checks.
var method = property.SetMethod;
if (method == null)
{
method = property.GetMethod;
}
string modifiers = String.Empty;
if (method.IsStatic && !IsModule(method.DeclaringType))
{
modifiers += " Shared";
}
if (method.IsVirtual && !method.IsAbstract)
{
if ((method.Attributes & MethodAttributes.NewSlot) != 0)
{
modifiers += " Overridable";
}
else
{
modifiers += " Overrides";
}
}
TypeDefinition declDef = (TypeDefinition)method.DeclaringType;
if (method.IsAbstract && !declDef.IsInterface)
{
modifiers += " MustOverride";
}
if (method.IsFinal)
{
modifiers += " NotOverridable";
}
if (modifiers == " MustOverride NotOverridable")
{
modifiers = "";
}
if (modifiers == " Overridable NotOverridable")
{
modifiers = "";
}
buf.Append(modifiers).Append(' ');
if (getVisible != null && setVisible == null)
{
buf.Append("ReadOnly ");
}
buf.Append("Property ");
buf.Append(property.Name.Split('.').Last());
if (property.Parameters.Count != 0)
{
AppendParameters(buf, method, property.Parameters, '(', ')');
}
buf.Append(" As ");
buf.Append(GetTypeName(property.PropertyType, new DynamicParserContext(property)));
if (DocUtils.IsExplicitlyImplemented(property.GetMethod))
{
TypeReference iface;
MethodReference ifaceMethod;
DocUtils.GetInfoForExplicitlyImplementedMethod(method, out iface, out ifaceMethod);
buf.Append(" Implements ")
.Append(new VBMemberFormatter(this.TypeMap).GetName(iface))
.Append('.')
.Append(DocUtils.GetPropertyName(property, NestedTypeSeparator).Split('.').Last());
}
return(buf.ToString());
}
protected override string GetMethodDeclaration(MethodDefinition method)
{
if (method.HasCustomAttributes && method.CustomAttributes.Cast <CustomAttribute>().Any(
ca => ca.GetDeclaringType() == "System.Diagnostics.Contracts.ContractInvariantMethodAttribute"))
{
return(null);
}
// Special signature for destructors.
if (method.Name == "Finalize" && method.Parameters.Count == 0)
{
return(GetFinalizerName(method));
}
StringBuilder buf = new StringBuilder();
if (DocUtils.IsExtensionMethod(method))
{
buf.Append("<Extension()>" + GetLineEnding());
}
AppendVisibility(buf, method);
if (buf.Length == 0 &&
!(DocUtils.IsExplicitlyImplemented(method) && !method.IsSpecialName))
{
return(null);
}
AppendModifiers(buf, method);
if (buf.Length != 0)
{
buf.Append(" ");
}
bool isFunction = method.MethodReturnType.ReturnType.FullName != "System.Void";
if (!DocUtils.IsOperator(method))
{
if (isFunction)
{
buf.Append("Function ");
}
else
{
buf.Append("Sub ");
}
}
AppendMethodName(buf, method);
AppendGenericMethod(buf, method).Append(" ");
AppendParameters(buf, method, method.Parameters);
AppendGenericMethodConstraints(buf, method);
if (isFunction)
{
buf.Append(" As ").Append(GetTypeName(method.ReturnType, new DynamicParserContext(method.MethodReturnType)));
}
if (DocUtils.IsExplicitlyImplemented(method))
{
TypeReference iface;
MethodReference ifaceMethod;
DocUtils.GetInfoForExplicitlyImplementedMethod(method, out iface, out ifaceMethod);
buf.Append(" Implements ")
.Append(new VBMemberFormatter(this.TypeMap).GetName(iface))
.Append('.')
.Append(ifaceMethod.Name);
}
return(buf.ToString());
}
private static IEnumerable <MemberReference> GetReflectionMembersCore(TypeDefinition type, string docName, string memberType)
{
// In case of dropping the namespace, we have to remove the dropped NS
// so that docName will match what's in the assembly/type
if (MDocUpdater.HasDroppedNamespace(type) && docName.StartsWith(MDocUpdater.droppedNamespace + "."))
{
int droppedNsLength = MDocUpdater.droppedNamespace.Length;
docName = docName.Substring(droppedNsLength + 1, docName.Length - droppedNsLength - 1);
}
// need to worry about 4 forms of //@MemberName values:
// 1. "Normal" (non-generic) member names: GetEnumerator
// - Lookup as-is.
// 2. Explicitly-implemented interface member names: System.Collections.IEnumerable.Current
// - try as-is, and try type.member (due to "kludge" for property
// support.
// 3. "Normal" Generic member names: Sort<T> (CSC)
// - need to remove generic parameters --> "Sort"
// 4. Explicitly-implemented interface members for generic interfaces:
// -- System.Collections.Generic.IEnumerable<T>.Current
// - Try as-is, and try type.member, *keeping* the generic parameters.
// --> System.Collections.Generic.IEnumerable<T>.Current, IEnumerable<T>.Current
// 5. As of 2008-01-02, gmcs will do e.g. 'IFoo`1[A].Method' instead of
// 'IFoo<A>.Method' for explicitly implemented methods; don't interpret
// this as (1) or (2).
if (docName.IndexOf('<') == -1 && docName.IndexOf('[') == -1)
{
int memberCount = 0;
// Cases 1 & 2
foreach (MemberReference mi in type.GetMembers(docName))
{
memberCount++;
yield return(mi);
}
if (memberCount == 0 && CountChars(docName, '.') > 0)
{
Func <MemberReference, bool> verifyInterface = (member) =>
{
var meth = member as MethodDefinition;
if (meth == null && member is PropertyReference)
{
var propertyDefinition = ((PropertyReference)member).Resolve();
meth = propertyDefinition.GetMethod ?? propertyDefinition.SetMethod;
}
return(meth != null && (member.Name.Equals(".ctor") || DocUtils.IsExplicitlyImplemented(meth)));
};
// might be a property; try only type.member instead of
// namespace.type.member.
var typeMember = DocUtils.GetTypeDotMember(docName);
var memberName = DocUtils.GetMember(docName);
foreach (MemberReference mi in
type.GetMembers(typeMember).Where(verifyInterface))
{
memberCount++;
yield return(mi);
}
// some VB libraries use just the member name
foreach (MemberReference mi in
type.GetMembers(memberName).Where(verifyInterface))
{
memberCount++;
yield return(mi);
}
// some VB libraries use a `typemember` naming convention
foreach (MemberReference mi in
type.GetMembers(typeMember.Replace(".", "")).Where(verifyInterface))
{
memberCount++;
yield return(mi);
}
// if we still haven't found the member, there are some VB libraries
// that use a different interface name for implementation.
if (memberCount == 0)
{
foreach (MemberReference mi in
type
.GetMembers()
.Where(m => m.Name.StartsWith("I", StringComparison.InvariantCultureIgnoreCase) &&
m.Name.EndsWith(memberName, StringComparison.InvariantCultureIgnoreCase))
.Where(verifyInterface))
{
memberCount++;
yield return(mi);
}
}
if (memberCount == 0 && memberType == "Property")
{
foreach (MemberReference mr in type.GetMembers().Where(x => x is PropertyDefinition))
{
var method = ((PropertyDefinition)mr).GetMethod ?? ((PropertyDefinition)mr).SetMethod;
if (method?.Overrides != null && method.Overrides.Any())
{
DocUtils.GetInfoForExplicitlyImplementedMethod(method, out TypeReference iface, out MethodReference ifaceMethod);
var newName = DocUtils.GetMemberForProperty(ifaceMethod.Name);
if (newName == memberName && verifyInterface(mr) && docName.Contains(iface.Name))
{
yield return(mr);
}
}
}
}
}
yield break;
}
// cases 3 & 4
int numLt = 0;
int numDot = 0;
int startLt, startType, startMethod;
startLt = startType = startMethod = -1;
for (int i = 0; i < docName.Length; ++i)
{
switch (docName[i])
{
case '<':
if (numLt == 0)
{
startLt = i;
}
++numLt;
break;
case '>':
--numLt;
if (numLt == 0 && (i + 1) < docName.Length)
{
// there's another character in docName, so this <...> sequence is
// probably part of a generic type -- case 4.
startLt = -1;
}
break;
case '.':
startType = startMethod;
startMethod = i;
++numDot;
break;
}
}
string refName = startLt == -1 ? docName : docName.Substring(0, startLt);
// case 3
foreach (MemberReference mi in type.GetMembers(refName))
{
yield return(mi);
}
// case 4
foreach (MemberReference mi in type.GetMembers(refName.Substring(startType + 1)))
{
yield return(mi);
}
// If we _still_ haven't found it, we've hit another generic naming issue:
// post Mono 1.1.18, gmcs generates [[FQTN]] instead of <TypeName> for
// explicitly-implemented METHOD names (not properties), e.g.
// "System.Collections.Generic.IEnumerable`1[[Foo, test, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null]].GetEnumerator"
// instead of "System.Collections.Generic.IEnumerable<Foo>.GetEnumerator",
// which the XML docs will contain.
//
// Alas, we can't derive the Mono name from docName, so we need to iterate
// over all member names, convert them into CSC format, and compare... :-(
if (numDot == 0)
{
yield break;
}
foreach (MemberReference mi in type.GetMembers())
{
if (MDocUpdater.GetMemberName(mi) == docName)
{
yield return(mi);
}
}
}
protected override StringBuilder AppendMethodName(StringBuilder buf, MethodDefinition method)
{
if (DocUtils.IsExplicitlyImplemented(method))
{
TypeReference iface;
MethodReference ifaceMethod;
DocUtils.GetInfoForExplicitlyImplementedMethod(method, out iface, out ifaceMethod);
return(buf.Append(new CSharpMemberFormatter().GetName(iface))
.Append('.')
.Append(ifaceMethod.Name));
}
if (method.Name.StartsWith("op_", StringComparison.Ordinal))
{
// this is an operator
switch (method.Name)
{
case "op_Implicit":
case "op_Explicit":
buf.Length--; // remove the last space, which assumes a member name is coming
return(buf);
case "op_Addition":
case "op_UnaryPlus":
return(buf.Append("operator +"));
case "op_Subtraction":
case "op_UnaryNegation":
return(buf.Append("operator -"));
case "op_Division":
return(buf.Append("operator /"));
case "op_Multiply":
return(buf.Append("operator *"));
case "op_Modulus":
return(buf.Append("operator %"));
case "op_BitwiseAnd":
return(buf.Append("operator &"));
case "op_BitwiseOr":
return(buf.Append("operator |"));
case "op_ExclusiveOr":
return(buf.Append("operator ^"));
case "op_LeftShift":
return(buf.Append("operator <<"));
case "op_RightShift":
return(buf.Append("operator >>"));
case "op_LogicalNot":
return(buf.Append("operator !"));
case "op_OnesComplement":
return(buf.Append("operator ~"));
case "op_Decrement":
return(buf.Append("operator --"));
case "op_Increment":
return(buf.Append("operator ++"));
case "op_True":
return(buf.Append("operator true"));
case "op_False":
return(buf.Append("operator false"));
case "op_Equality":
return(buf.Append("operator =="));
case "op_Inequality":
return(buf.Append("operator !="));
case "op_LessThan":
return(buf.Append("operator <"));
case "op_LessThanOrEqual":
return(buf.Append("operator <="));
case "op_GreaterThan":
return(buf.Append("operator >"));
case "op_GreaterThanOrEqual":
return(buf.Append("operator >="));
default:
return(base.AppendMethodName(buf, method));
}
}
else
{
return(base.AppendMethodName(buf, method));
}
}
