1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576
|
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Text.RegularExpressions;
using Mono.Cecil;
using Mono.Documentation.Util;
namespace Mono.Documentation.Updater.Formatters.CppFormatters
{
public class CppCxFullMemberFormatter : CppFullMemberFormatter
{
public override string Language => Consts.CppCx;
protected override string RefTypeModifier => " & ";
protected readonly IEnumerable<string> ValueClassPropertyTypeAllowed = new List<string>()
{
"System.String",
"Platform.IBox<T>",
//fundamental numeric types
"System.SByte",
"System.Byte",
"System.Int16",
"System.UInt16",
"System.Int32",
"System.UInt32",
"System.Int64",
"System.UInt64",
"System.Single",
"System.Double",
"System.Decimal"
};
protected readonly IEnumerable<string> CustomAttributesFieldTypesAllowed = new List<string>()
{
"System.Int32",
"System.UInt32",
"System.Boolean",
"System.String",
"Windows.Foundation.HResult",
"Platform.Type"
};
protected static readonly IEnumerable<string> AllowedFundamentalTypes = new List<string>()
{
//fundamental numeric types
"System.Byte",
"System.Int16",
"System.UInt16",
"System.Int32",
"System.UInt32",
"System.Int64",
"System.UInt64",
"System.Single",
"System.Double",
"System.SByte",
//other fundamental types
"System.Object",
"System.Boolean",
"System.Char",
"System.Void",
"System.String",
"System.ValueType",
"System.Enum",
};
protected virtual IList<string> GetAllowedTypes()
{
return new List<string>(AllowedFundamentalTypes)
{
"System.Delegate",
"System.MulticastDelegate",
"System.Type",
"System.Attribute"
};
}
protected readonly IEnumerable<string> CppCxSpecificNamespases = new List<string>()
{
"Platform",
"Platform.Collections",
"Platform.Collections.Details",
"Platform.Details",
"Platform.Metadata",
"Platform.Runtime.CompilerServices",
"Platform.Runtime.InteropServices",
"Windows.Foundation.Collections"
};
protected override StringBuilder AppendNamespace(StringBuilder buf, TypeReference type)
{
string ns = DocUtils.GetNamespace(type, NestedTypeSeparator);
if (GetCppType(type.FullName) == null && !string.IsNullOrEmpty(ns) && ns != "System")
buf.Append(ns).Append(NestedTypeSeparator);
return buf;
}
protected override string GetCppType(string t)
{
// make sure there are no modifiers in the type string (add them back before returning)
string typeToCompare = t;
string[] splitType = null;
if (t.Contains(' '))
{
splitType = t.Split(' ');
typeToCompare = splitType[0];
}
switch (typeToCompare)
{
case "System.Byte": typeToCompare = "byte"; break;
case "System.Int16": typeToCompare = "short"; break;
case "System.Int32": typeToCompare = "int"; break;
case "System.Int64": typeToCompare = "long long"; break;
case "System.UInt16": typeToCompare = "unsigned short"; break;
case "System.UInt32": typeToCompare = "unsigned int"; break;
case "System.UInt64": typeToCompare = "unsigned long long"; break;
case "System.Single": typeToCompare = "float"; break;
case "System.Double": typeToCompare = "double"; break;
case "System.Boolean": typeToCompare = "bool"; break;
case "System.Char": typeToCompare = "char16"; break;
case "System.Void": typeToCompare = "void"; break;
case "System.String": typeToCompare = "Platform::String"; break;
case "System.Object": typeToCompare = "Platform::Object"; break;
case "System.Type": typeToCompare = "Platform::Type"; break;
case "System.Attribute": typeToCompare = "Platform::Metadata::Attribute"; break;
}
if (splitType != null)
{
// re-add modreq/modopt if it was there
splitType[0] = typeToCompare;
typeToCompare = string.Join(" ", splitType);
}
return typeToCompare == t ? null : typeToCompare;
}
protected override StringBuilder AppendArrayTypeName(StringBuilder buf, TypeReference type,
DynamicParserContext context)
{
buf.Append("Platform::Array <");
var item = type is TypeSpecification spec ? spec.ElementType : type.GetElementType();
_AppendTypeName(buf, item, context);
AppendHat(buf, item);
if (type is ArrayType arrayType)
{
int rank = arrayType.Rank;
if (rank > 1)
{
buf.AppendFormat(", {0}", rank);
}
}
buf.Append(">");
return buf;
}
protected override string GetTypeDeclaration(TypeDefinition type)
{
string visibility = GetTypeVisibility(type.Attributes);
if (visibility == null)
return null;
StringBuilder buf = new StringBuilder();
if (!visibility.Contains(":"))
{
AppendWebHostHiddenAttribute(buf, type);
}
buf.Append(visibility);
buf.Append(" ");
if (visibility.Contains(":"))
{
AppendWebHostHiddenAttribute(buf, type);
}
CppFullMemberFormatter full = new CppCxFullMemberFormatter();
if (DocUtils.IsDelegate(type))
{
buf.Append("delegate ");
MethodDefinition invoke = type.GetMethod("Invoke");
buf.Append(full.GetNameWithOptions(invoke.ReturnType)).Append(" ");
buf.Append(GetNameWithOptions(type, false, false));
AppendParameters(buf, invoke, invoke.Parameters);
buf.Append(";");
return buf.ToString();
}
buf.Append(GetTypeKind(type));
buf.Append(" ");
buf.Append(GetCppType(type.FullName) == null
? GetNameWithOptions(type, false, false)
: type.Name);
if (type.IsAbstract && !type.IsInterface)
buf.Append(" abstract");
if (type.IsSealed && !DocUtils.IsDelegate(type) && !type.IsValueType)
buf.Append(" sealed");
if (!type.IsEnum)
{
TypeReference basetype = type.BaseType;
if (basetype != null && basetype.FullName == "System.Object" || type.IsValueType) // FIXME
basetype = null;
List<string> interfaceNames;
try
{
//for c++/cx Resolve() can fail as Cecil understands CX types as .net (eg, "System.Attribute" instead of "Platform::Metadata::Attribute")
interfaceNames = DocUtils.GetUserImplementedInterfaces(type)
.Select(iface => full.GetNameWithOptions(iface, true, false))
.OrderBy(s => s)
.ToList();
}
catch
{
interfaceNames = null;
}
if (basetype != null || interfaceNames?.Count > 0)
buf.Append(" : ");
if (basetype != null)
{
var appendValue = GetCppType(basetype.FullName);
buf.Append(appendValue ?? full.GetNameWithOptions(basetype, true, false));
if (interfaceNames?.Count > 0)
buf.Append(", ");
}
for (int i = 0; i < interfaceNames?.Count; i++)
{
if (i != 0)
buf.Append(", ");
buf.Append(interfaceNames?[i]);
}
}
return buf.ToString();
}
public void AppendWebHostHiddenAttribute(StringBuilder buf, TypeDefinition typeDef)
{
//public unsealed ref class needs to be marked with attribute
//to ensure that is not visible to UWP apps that are written in JavaScript
if (typeDef.IsClass && !typeDef.IsSealed && (typeDef.IsPublic || typeDef.IsNestedPublic) && typeDef.CustomAttributes.All(x => x.GetDeclaringType() != "Windows.Foundation.Metadata.WebHostHiddenAttribute"))
{
buf.Append("[Windows::Foundation::Metadata::WebHostHidden]").Append(GetLineEnding());
}
}
protected override StringBuilder AppendExplisitImplementationMethod(StringBuilder buf, MethodDefinition method)
{
if(IsExplicitlyImplemented(method))
{
buf.Append(" = ");
var interfaceMethodReference = method.Overrides.FirstOrDefault();
buf.Append(GetTypeNameWithOptions(interfaceMethodReference?.DeclaringType, !AppendHatOnReturn, true))
.Append(NestedTypeSeparator);
buf.Append(interfaceMethodReference?.Name);
}
return buf;
}
protected override string AppendSealedModifiers(string modifiersString, MethodDefinition method)
{
if (!IsExplicitlyImplemented(method))
{
if (method.IsFinal) modifiersString += " sealed";
if (modifiersString == " virtual sealed") modifiersString = "";
}
return modifiersString;
}
private bool IsExplicitlyImplemented(MethodDefinition method)
{
if (!method.HasOverrides) return false;
//apply logic for explicit implementation of interface methods
var interfaceMethodReference = method.Overrides.FirstOrDefault();
if (interfaceMethodReference != null
//need to filter UWP specific interfaces, generated by default
//eg from decompile, public sealed class Class1 : __IClass1PublicNonVirtuals, __IClass1ProtectedNonVirtuals
&& !Regex.IsMatch(interfaceMethodReference.DeclaringType.Name,
$"^.*{method.DeclaringType.Name}.*Virtual.*$"))
{
return true;
}
return false;
}
public override bool IsSupported(TypeReference tref)
{
if (HasNestedClassesDuplicateNames(tref))
return false;
var allowedTypes = GetAllowedTypes();
//no support of jagged arrays
if (tref is ArrayType)
{
var typeOfArray= tref is TypeSpecification spec ? spec.ElementType : tref.GetElementType();
if (typeOfArray is ArrayType)
{
return false;
}
if (allowedTypes.Contains(typeOfArray.FullName) ||
CppCxSpecificNamespases.Contains(typeOfArray.Namespace))
{
return true;
}
}
if (allowedTypes.Contains(tref.FullName.Split(' ')[0]) || CppCxSpecificNamespases.Contains(tref.Namespace))
{
return true;
}
var ns = DocUtils.GetNamespace(tref);
var typedef = tref.Resolve();
if (typedef != null)
{
if (DocUtils.IsDelegate(typedef))
{
if (typedef.HasGenericParameters && typedef.IsPublic)
//generic delegates cannot be declared as public
return false;
return
//check types of delegate signature
IsSupported(typedef.GetMethod("Invoke"))
//check type
&& base.IsSupported(tref) && ! (ns.StartsWith("System.") || ns.StartsWith("System"));
}
if (typedef.IsInterface && typedef.HasGenericParameters &&
typedef.GenericParameters.Any(x => x.HasConstraints
|| x.HasReferenceTypeConstraint
|| x.HasDefaultConstructorConstraint
|| x.HasNotNullableValueTypeConstraint)
)
{
//generic interface - Type parameters cannot be constrained
return false;
}
if (HasUnsupportedParent(typedef))
{
return false;
}
var typeVisibility = typedef.Attributes & TypeAttributes.VisibilityMask;
if (typeVisibility == TypeAttributes.Public
//all public types, including those in your own code, must be declared in a namespace
&& (string.IsNullOrEmpty(ns)
//public standard C++ types are not allowed
|| ns.StartsWith("std") || ns.StartsWith("cli"))
)
{
return false;
}
if (typeVisibility == TypeAttributes.NestedPublic
&& (typedef.IsEnum || typedef.IsClass)
)
{
//no support of nested public classes/enums
return false;
}
if (typedef.IsClass && typeVisibility == TypeAttributes.Public && typedef.HasGenericParameters)
{
//Public ref classes that have type parameters (generics) are not permitted.
return false;
}
if (typedef.IsClass && typeVisibility == TypeAttributes.Public)
{
//A public ref class that has a public constructor must also be declared as sealed
//to prevent further derivation through the application binary interface (ABI).
if (typedef.Methods.Any(x => x.IsConstructor && x.IsPublic) && !typedef.IsSealed)
{
return false;
}
}
if (typedef.IsValueType && !typedef.IsEnum && typedef.Fields.Any(x =>
!ValueClassPropertyTypeAllowed.Contains(x.FieldType.FullName) && !(x.FieldType.Resolve() != null && x.FieldType.Resolve().IsEnum)))
{
//A value struct or value class can contain as fields only
//fundamental numeric types, enum classes, Platform::String^, or Platform::IBox <T>^
return false;
}
bool condition;
try
{
//custom attribute can contain only public fields and only with allowed types or enums
condition = IsCustomAttribute(typedef)
&& (typedef.Fields.Any(z =>
!CustomAttributesFieldTypesAllowed.Contains(z.FieldType.FullName)
&& !(z.FieldType.Resolve() != null && z.FieldType.Resolve().IsEnum)
)
|| typedef.Properties.Count != 0
|| typedef.Methods.Count(x => !x.IsConstructor) != 0
|| typedef.Events.Count != 0
);
}
catch
{
condition = false;
}
if (condition)
{
//custom attribute can contain only public fields and only with allowed types or enums
return false;
}
}
//cannot support .Net types
return !ns.StartsWith("System.") && !ns.Equals("System") && base.IsSupported(tref);
}
protected bool HasUnsupportedParent(TypeDefinition typedef)
{
var collect = new List<TypeDefinition>();
TypeReference baseTypeReference = typedef.BaseType;
TypeDefinition basetypeDefenition = null;
var allowedTypes = GetAllowedTypes();
try
{
//iterate through all classes in in inheritance hierarhy to exclude usage of .net types
basetypeDefenition = baseTypeReference?.Resolve();
while (basetypeDefenition != null)
{
if (allowedTypes.Contains(basetypeDefenition.FullName) || basetypeDefenition.BaseType == null)
{
break;
}
collect.Add(basetypeDefenition);
//needs to call Resolve to grab all base classes
basetypeDefenition = basetypeDefenition.BaseType?.Resolve();
}
}
catch (Exception)
{
//for c++/cx Resolve() can fail as Cecil understands types as .net (eg, "System.Attribute" instead of "Platform::Metadata::Attribute")
//needs to ignore those errors
baseTypeReference = basetypeDefenition?.BaseType ?? baseTypeReference;
}
if (collect.Any(x => DocUtils.GetNamespace(x).StartsWith("System.") || DocUtils.GetNamespace(x).Equals("System"))
|| !allowedTypes.Contains(baseTypeReference?.FullName)
&& (
DocUtils.GetNamespace(baseTypeReference).StartsWith("System.")
|| DocUtils.GetNamespace(baseTypeReference).Equals("System")
)
)
//can only be Windows Runtime types(no support for .net types)
return true;
try
{
IEnumerable<TypeReference> interfaceNames = DocUtils.GetUserImplementedInterfaces(typedef).ToList();
if (interfaceNames.Any(x => DocUtils.GetNamespace(x).StartsWith("System.") || DocUtils.GetNamespace(x).Equals("System")))
{
//can only be Windows Runtime types(no support for .net types)
return true;
}
}
catch
{
//for c++/cx Resolve() can fail as Cecil understands types as .net (eg, "System.Attribute" instead of "Platform::Metadata::Attribute")
//needs to ignore those errors
}
return false;
}
public override bool IsSupportedField(FieldDefinition fdef)
{
bool isEnumFieldType;
try
{
var typedef = fdef.FieldType.Resolve();
if (typedef != null)
isEnumFieldType = typedef.IsEnum;
else
isEnumFieldType = false;
}
catch
{
//for c++/cx Resolve() can fail as Cecil understands types as .net (eg, "System.Attribute" instead of "Platform::Metadata::Attribute")
//needs to ignore those errors
isEnumFieldType = false;
}
if (IsCustomAttribute(fdef.DeclaringType))
{
return !CustomAttributesFieldTypesAllowed.Contains(fdef.FieldType.FullName) ||
!isEnumFieldType;
}
if (fdef.IsPublic && fdef.DeclaringType.IsClass && !fdef.DeclaringType.IsValueType && !fdef.DeclaringType.IsEnum)
{
//Public fields are not allowed in ref class
return false;
}
//todo: no const members - which can be??
//const member functions + pointers
return base.IsSupportedField(fdef);
}
public override bool IsSupportedProperty(PropertyDefinition pdef)
{
var propVisibility = GetPropertyVisibility(pdef, out _, out _);
if ((propVisibility.Contains("public:")
|| propVisibility.Contains("protected:"))
&& pdef.Parameters.Count > 0)
//no support of public indexed property
return false;
return base.IsSupportedProperty(pdef);
}
public override bool IsSupportedMethod(MethodDefinition mdef)
{
if (mdef.Parameters.Any(IsParamsParameter))
{
return false;
}
return base.IsSupportedMethod(mdef);
}
private bool IsCustomAttribute(TypeDefinition typedef)
{
var containingTypeNamespace = DocUtils.GetNamespace(typedef);
if (typedef.BaseType?.FullName == "System.Attribute" && !containingTypeNamespace.StartsWith("System.") && !containingTypeNamespace.StartsWith("System"))
{
return true;
}
return false;
}
}
}
|