public TypeDocumentation(TypeDefinition typeDefinition, PackageTargetFramework framework, PackageAssemblyXmlDocs xmlDocs,
Lazy <ICSharpCode.Decompiler.CSharp.CSharpDecompiler> decompiler, Lazy <ICSharpCode.Decompiler.CSharp.CSharpDecompiler> idecompiler,
ICSharpCode.Decompiler.CSharp.OutputVisitor.CSharpFormattingOptions format)
{
this.xmlDocs = xmlDocs;
this.typeDefinition = typeDefinition;
this.framework = framework;
this.decompiler = decompiler;
this.idecompiler = idecompiler;
this.format = format;
SummaryHtml = "";
SummaryText = "";
DocumentationHtml = "";
if (xmlDocs != null)
{
var tn = typeDefinition.GetXmlName();
if (xmlDocs.MemberDocs.TryGetValue(tn, out var td))
{
SummaryHtml = XmlToHtml(td.SummaryXml);
SummaryText = XmlToText(td.SummaryXml);
if (ignoreSummaryTextRe.IsMatch(SummaryHtml))
{
SummaryHtml = "";
SummaryText = "";
}
}
}
var w = new StringWriter();
WriteDocumentation(w);
DocumentationHtml = w.ToString();
}
public void ConvertSymbol(ISymbol symbol, TokenWriter writer, CSharpFormattingOptions formattingPolicy)
{
if (symbol == null)
{
throw new ArgumentNullException("symbol");
}
if (writer == null)
{
throw new ArgumentNullException("writer");
}
if (formattingPolicy == null)
{
throw new ArgumentNullException("formattingPolicy");
}
TypeSystemAstBuilder astBuilder = CreateAstBuilder();
AstNode node = astBuilder.ConvertSymbol(symbol);
EntityDeclaration entityDecl = node as EntityDeclaration;
if (entityDecl != null)
{
PrintModifiers(entityDecl.Modifiers, writer);
}
if ((ConversionFlags & ConversionFlags.ShowDefinitionKeyword) == ConversionFlags.ShowDefinitionKeyword)
{
if (node is TypeDeclaration)
{
switch (((TypeDeclaration)node).ClassType)
{
case ClassType.Class:
writer.WriteKeyword(Roles.ClassKeyword, "class");
break;
case ClassType.Struct:
writer.WriteKeyword(Roles.StructKeyword, "struct");
break;
case ClassType.Interface:
writer.WriteKeyword(Roles.InterfaceKeyword, "interface");
break;
case ClassType.Enum:
writer.WriteKeyword(Roles.EnumKeyword, "enum");
break;
default:
throw new Exception("Invalid value for ClassType");
}
writer.Space();
}
else if (node is DelegateDeclaration)
{
writer.WriteKeyword(Roles.DelegateKeyword, "delegate");
writer.Space();
}
else if (node is EventDeclaration)
{
writer.WriteKeyword(EventDeclaration.EventKeywordRole, "event");
writer.Space();
}
else if (node is NamespaceDeclaration)
{
writer.WriteKeyword(Roles.NamespaceKeyword, "namespace");
writer.Space();
}
}
if ((ConversionFlags & ConversionFlags.ShowReturnType) == ConversionFlags.ShowReturnType)
{
var rt = node.GetChildByRole(Roles.Type);
if (!rt.IsNull)
{
rt.AcceptVisitor(new CSharpOutputVisitor(writer, formattingPolicy));
writer.Space();
}
}
if (symbol is ITypeDefinition)
{
WriteTypeDeclarationName((ITypeDefinition)symbol, writer, formattingPolicy);
}
else if (symbol is IMember)
{
WriteMemberDeclarationName((IMember)symbol, writer, formattingPolicy);
}
else
{
writer.WriteIdentifier(Identifier.Create(symbol.Name));
}
if ((ConversionFlags & ConversionFlags.ShowParameterList) == ConversionFlags.ShowParameterList && HasParameters(symbol))
{
writer.WriteToken(symbol.SymbolKind == SymbolKind.Indexer ? Roles.LBracket : Roles.LPar, symbol.SymbolKind == SymbolKind.Indexer ? "[" : "(");
bool first = true;
foreach (var param in node.GetChildrenByRole(Roles.Parameter))
{
if (first)
{
first = false;
}
else
{
writer.WriteToken(Roles.Comma, ",");
writer.Space();
}
param.AcceptVisitor(new CSharpOutputVisitor(writer, formattingPolicy));
}
writer.WriteToken(symbol.SymbolKind == SymbolKind.Indexer ? Roles.RBracket : Roles.RPar, symbol.SymbolKind == SymbolKind.Indexer ? "]" : ")");
}
if ((ConversionFlags & ConversionFlags.ShowBody) == ConversionFlags.ShowBody && !(node is TypeDeclaration))
{
IProperty property = symbol as IProperty;
if (property != null)
{
writer.Space();
writer.WriteToken(Roles.LBrace, "{");
writer.Space();
if (property.CanGet)
{
writer.WriteKeyword(PropertyDeclaration.GetKeywordRole, "get");
writer.WriteToken(Roles.Semicolon, ";");
writer.Space();
}
if (property.CanSet)
{
writer.WriteKeyword(PropertyDeclaration.SetKeywordRole, "set");
writer.WriteToken(Roles.Semicolon, ";");
writer.Space();
}
writer.WriteToken(Roles.RBrace, "}");
}
else
{
writer.WriteToken(Roles.Semicolon, ";");
}
}
}
void WriteMemberDeclarationName(IMember member, TokenWriter writer, CSharpFormattingOptions formattingPolicy)
{
TypeSystemAstBuilder astBuilder = CreateAstBuilder();
EntityDeclaration node = astBuilder.ConvertEntity(member);
if ((ConversionFlags & ConversionFlags.ShowDeclaringType) == ConversionFlags.ShowDeclaringType && member.DeclaringType != null)
{
ConvertType(member.DeclaringType, writer, formattingPolicy);
writer.WriteToken(Roles.Dot, ".");
}
switch (member.SymbolKind)
{
case SymbolKind.Indexer:
writer.WriteKeyword(Roles.Identifier, "this");
break;
case SymbolKind.Constructor:
WriteQualifiedName(member.DeclaringType.Name, writer, formattingPolicy);
break;
case SymbolKind.Destructor:
writer.WriteToken(DestructorDeclaration.TildeRole, "~");
WriteQualifiedName(member.DeclaringType.Name, writer, formattingPolicy);
break;
case SymbolKind.Operator:
switch (member.Name)
{
case "op_Implicit":
writer.WriteKeyword(OperatorDeclaration.ImplicitRole, "implicit");
writer.Space();
writer.WriteKeyword(OperatorDeclaration.OperatorKeywordRole, "operator");
writer.Space();
ConvertType(member.ReturnType, writer, formattingPolicy);
break;
case "op_Explicit":
writer.WriteKeyword(OperatorDeclaration.ExplicitRole, "explicit");
writer.Space();
writer.WriteKeyword(OperatorDeclaration.OperatorKeywordRole, "operator");
writer.Space();
ConvertType(member.ReturnType, writer, formattingPolicy);
break;
default:
writer.WriteKeyword(OperatorDeclaration.OperatorKeywordRole, "operator");
writer.Space();
var operatorType = OperatorDeclaration.GetOperatorType(member.Name);
if (operatorType.HasValue)
{
writer.WriteToken(OperatorDeclaration.GetRole(operatorType.Value), OperatorDeclaration.GetToken(operatorType.Value));
}
else
{
writer.WriteIdentifier(node.NameToken);
}
break;
}
break;
default:
writer.WriteIdentifier(Identifier.Create(member.Name));
break;
}
if ((ConversionFlags & ConversionFlags.ShowTypeParameterList) == ConversionFlags.ShowTypeParameterList && member.SymbolKind == SymbolKind.Method)
{
var outputVisitor = new CSharpOutputVisitor(writer, formattingPolicy);
outputVisitor.WriteTypeParameters(node.GetChildrenByRole(Roles.TypeParameter));
}
}
