private XSharpVsSignature CreateSignature(ITextBuffer textBuffer, IXMember member, string methodSig, string methodDoc, ITrackingSpan span, bool comma, bool isCtor, XFile file)
{
var doc = methodDoc;
string returns;
string remarks;
if (member != null)
{
doc = XSharpXMLDocMember.GetMemberSummary(member, file.Project, out returns, out remarks);
}
Debug("XSharpSignatureHelpSource.CreateSignature()");
var sig = new XSharpVsSignature(textBuffer, methodSig, doc, null);
var names = new List <String>();
var descriptions = new List <String>();
if (member != null)
{
XSharpXMLDocMember.GetMemberParameters(member, file.Project, names, descriptions);
}
// Moved : Done in the XSharpSignature constructor
// textBuffer.Changed += new EventHandler<TextContentChangedEventArgs>(sig.OnSubjectBufferChanged);
// find the parameters in the method signature :
// MyMethod( param1 AS TYPE1, param2 AS TYPE2 ) AS TYPE3 will turn to
// 0 : MyMethod
// 1 : param1 AS TYPE1
// 2 : param2 AS TYPE2
// 3 : AS TYPE3
string[] pars;
if (isCtor)
{
pars = methodSig.Split(new char[] { '{', ',', '}' });
}
else
{
pars = methodSig.Split(new char[] { '(', ',', ')' });
}
List <IParameter> paramList = new List <IParameter>();
int locusSearchStart = 0;
// i = 1 to skip the MethodName; Length-1 to Skip the ReturnType
while (names.Count < pars.Length)
{
names.Add("");
descriptions.Add("");
}
for (int i = 1; i < pars.Length - 1; i++)
{
string param = pars[i].Trim();
if (string.IsNullOrEmpty(param))
{
continue;
}
//find where this parameter is located in the method signature
int locusStart = methodSig.IndexOf(param, locusSearchStart);
if (locusStart >= 0)
{
Span locus = new Span(locusStart, param.Length);
locusSearchStart = locusStart + param.Length;
// paramList.Add(new XSharpParameter("Documentation for the parameter.", locus, param, sig));
if (!string.IsNullOrEmpty(names[i - 1]))
{
param = names[i - 1];
}
paramList.Add(new XSharpVsParameter(descriptions[i - 1], locus, param, sig));
}
}
sig.Parameters = new ReadOnlyCollection <IParameter>(paramList);
sig.ApplicableToSpan = span;
sig.ComputeCurrentParameter();
return(sig);
}
private void initDescription(XEntityDefinition member) //, _VSOBJDESCOPTIONS flags, IVsObjectBrowserDescription3 description)
{
description = new List <Tuple <string, VSOBDESCRIPTIONSECTION> >();
//
string descText = this.Name;
//
string namesp = "";
string className = "";
if (member != null)
{
if (member.Parent != null)
{
if (member.Parent is IXType)
{
namesp = ((IXType)member.Parent).Namespace;
className = ((IXType)member.Parent).Name;
}
}
//
string modifier = "";
string access = "";
if ((member is XTypeDefinition) && (member.Kind != Kind.Namespace))
{
modifier = member.Modifiers.ToDisplayString();
access = member.Visibility.ToDisplayString();
}
else if ((member is XMemberDefinition) && ((member.Kind != Kind.Function) && (member.Kind != Kind.Procedure)))
{
modifier = member.Modifiers.ToDisplayString();
access = member.Visibility.ToDisplayString();
}
//
if (!String.IsNullOrEmpty(modifier))
{
description.Add(new Tuple <string, VSOBDESCRIPTIONSECTION>(modifier + " ", VSOBDESCRIPTIONSECTION.OBDS_ATTRIBUTE));
}
//
if (!String.IsNullOrEmpty(access))
{
description.Add(new Tuple <string, VSOBDESCRIPTIONSECTION>(access + " ", VSOBDESCRIPTIONSECTION.OBDS_ATTRIBUTE));
//description.AddDescriptionText3(access, VSOBDESCRIPTIONSECTION.OBDS_MISC, null);
}
//
if (member.Kind != Kind.Field)
{
VSOBDESCRIPTIONSECTION descName = VSOBDESCRIPTIONSECTION.OBDS_MISC;
descText = XSettings.FormatKeyword(member.Kind.DisplayName()) + " ";
if (member.Kind == Kind.Constructor)
{
descName = VSOBDESCRIPTIONSECTION.OBDS_NAME;
}
description.Add(new Tuple <string, VSOBDESCRIPTIONSECTION>(descText, descName));
//description.AddDescriptionText3(descText, VSOBDESCRIPTIONSECTION.OBDS_MISC, null);
}
if (member.Kind != Kind.Constructor)
{
descText = member.Name;
description.Add(new Tuple <string, VSOBDESCRIPTIONSECTION>(descText, VSOBDESCRIPTIONSECTION.OBDS_NAME));
}
//description.AddDescriptionText3(descText, VSOBDESCRIPTIONSECTION.OBDS_NAME, null);
// Parameters ?
if (member.Kind.HasParameters())
{
descText = "(";
description.Add(new Tuple <string, VSOBDESCRIPTIONSECTION>(descText, VSOBDESCRIPTIONSECTION.OBDS_MISC));
//description.AddDescriptionText3(descText, VSOBDESCRIPTIONSECTION.OBDS_MISC, null);
XMemberDefinition realmember;
XTypeDefinition type = member as XTypeDefinition;
if (member.Kind == Kind.Delegate && type?.XMembers.Count > 0)
{
realmember = type.XMembers[0];
}
else
{
realmember = member as XMemberDefinition;
}
if (realmember != null && realmember.HasParameters)
{
//
int paramNum = 1;
foreach (XVariable param in realmember.Parameters)
{
descText = param.Name;
description.Add(new Tuple <string, VSOBDESCRIPTIONSECTION>(descText, VSOBDESCRIPTIONSECTION.OBDS_PARAM));
descText = param.ParamTypeDesc;
description.Add(new Tuple <string, VSOBDESCRIPTIONSECTION>(descText, VSOBDESCRIPTIONSECTION.OBDS_MISC));
//description.AddDescriptionText3(descText, VSOBDESCRIPTIONSECTION.OBDS_PARAM, null);
descText = param.TypeName;
//
IVsNavInfo navInfo = buildNavInfo(member.File, param.TypeName);
//
description.Add(new Tuple <string, VSOBDESCRIPTIONSECTION>(descText, VSOBDESCRIPTIONSECTION.OBDS_TYPE));
//description.AddDescriptionText3(descText, VSOBDESCRIPTIONSECTION.OBDS_TYPE, navInfo);
// Need a comma ?
if (paramNum < realmember.ParameterCount)
{
paramNum++;
descText = ",";
description.Add(new Tuple <string, VSOBDESCRIPTIONSECTION>(descText, VSOBDESCRIPTIONSECTION.OBDS_COMMA));
//description.AddDescriptionText3(descText, VSOBDESCRIPTIONSECTION.OBDS_COMMA, null);
}
}
}
descText = ")";
description.Add(new Tuple <string, VSOBDESCRIPTIONSECTION>(descText, VSOBDESCRIPTIONSECTION.OBDS_MISC));
//description.AddDescriptionText3(descText, VSOBDESCRIPTIONSECTION.OBDS_MISC, null);
}
if (member.Kind.HasReturnType())
{
descText = XLiterals.AsKeyWord;
description.Add(new Tuple <string, VSOBDESCRIPTIONSECTION>(descText, VSOBDESCRIPTIONSECTION.OBDS_MISC));
//description.AddDescriptionText3(descText, VSOBDESCRIPTIONSECTION.OBDS_MISC, null);
descText = member.TypeName;
description.Add(new Tuple <string, VSOBDESCRIPTIONSECTION>(descText, VSOBDESCRIPTIONSECTION.OBDS_TYPE));
//description.AddDescriptionText3(descText, VSOBDESCRIPTIONSECTION.OBDS_TYPE, null);
}
//
//if (!((member.Kind == Kind.Function) || (member.Kind == Kind.Procedure) || (member.Kind == Kind.VODLL)) &&
// ((member.Parent is XTypeDefinition) && (member.Parent.Kind == Kind.Class)))
//{
// descText = " CLASS ";
// description.Add(new Tuple<string, VSOBDESCRIPTIONSECTION>(descText, VSOBDESCRIPTIONSECTION.OBDS_MISC));
// //description.AddDescriptionText3(descText, VSOBDESCRIPTIONSECTION.OBDS_MISC, null);
// descText = className;
// description.Add(new Tuple<string, VSOBDESCRIPTIONSECTION>(descText, VSOBDESCRIPTIONSECTION.OBDS_TYPE));
// //description.AddDescriptionText3(descText, VSOBDESCRIPTIONSECTION.OBDS_TYPE, null);
//}
//
description.Add(new Tuple <string, VSOBDESCRIPTIONSECTION>(null, VSOBDESCRIPTIONSECTION.OBDS_ENDDECL));
//description.AddDescriptionText3(null, VSOBDESCRIPTIONSECTION.OBDS_ENDDECL, null);
}
//
if (member.File?.Project != null)
{
string summary = null, returns = null, remarks = null;
List <string> pNames = new List <string>();
List <string> pDescriptions = new List <string>();
if (member is XMemberDefinition)
{
summary = XSharpXMLDocMember.GetMemberSummary((XMemberDefinition)member, member.File?.Project, out returns, out remarks);
XSharpXMLDocMember.GetMemberParameters((XMemberDefinition)member, member.File?.Project, pNames, pDescriptions);
}
else if (member is XTypeDefinition)
{
summary = XSharpXMLDocMember.GetTypeSummary((XTypeDefinition)member, member.File?.Project, out returns, out remarks);
}
if (!String.IsNullOrEmpty(summary))
{
description.Add(new Tuple <string, VSOBDESCRIPTIONSECTION>("\n", VSOBDESCRIPTIONSECTION.OBDS_MISC));
description.Add(new Tuple <string, VSOBDESCRIPTIONSECTION>("\nSummary:\n", VSOBDESCRIPTIONSECTION.OBDS_NAME));
description.Add(new Tuple <string, VSOBDESCRIPTIONSECTION>(summary, VSOBDESCRIPTIONSECTION.OBDS_MISC));
}
if (pNames.Count > 0)
{
description.Add(new Tuple <string, VSOBDESCRIPTIONSECTION>("\n", VSOBDESCRIPTIONSECTION.OBDS_MISC));
description.Add(new Tuple <string, VSOBDESCRIPTIONSECTION>("\nParameters:", VSOBDESCRIPTIONSECTION.OBDS_NAME));
for (int i = 0; i < pNames.Count; i++)
{
description.Add(new Tuple <string, VSOBDESCRIPTIONSECTION>("\n" + pNames[i], VSOBDESCRIPTIONSECTION.OBDS_PARAM));
description.Add(new Tuple <string, VSOBDESCRIPTIONSECTION>(" : ", VSOBDESCRIPTIONSECTION.OBDS_MISC));
description.Add(new Tuple <string, VSOBDESCRIPTIONSECTION>(pDescriptions[i], VSOBDESCRIPTIONSECTION.OBDS_MISC));
}
}
if (!String.IsNullOrEmpty(returns))
{
description.Add(new Tuple <string, VSOBDESCRIPTIONSECTION>("\n", VSOBDESCRIPTIONSECTION.OBDS_MISC));
description.Add(new Tuple <string, VSOBDESCRIPTIONSECTION>("\nReturn:\n", VSOBDESCRIPTIONSECTION.OBDS_NAME));
description.Add(new Tuple <string, VSOBDESCRIPTIONSECTION>(returns, VSOBDESCRIPTIONSECTION.OBDS_MISC));
}
if (!String.IsNullOrEmpty(remarks))
{
description.Add(new Tuple <string, VSOBDESCRIPTIONSECTION>("\n", VSOBDESCRIPTIONSECTION.OBDS_MISC));
description.Add(new Tuple <string, VSOBDESCRIPTIONSECTION>("\nRemarks:\n", VSOBDESCRIPTIONSECTION.OBDS_NAME));
description.Add(new Tuple <string, VSOBDESCRIPTIONSECTION>(remarks, VSOBDESCRIPTIONSECTION.OBDS_MISC));
}
}
}
