Skip to content

Commit

Permalink
Annotate the library with trimming attributes (#1414)
Browse files Browse the repository at this point in the history
  • Loading branch information
martintmk authored Jul 20, 2023
1 parent 38d903e commit dd14ca6
Show file tree
Hide file tree
Showing 30 changed files with 580 additions and 37 deletions.
136 changes: 136 additions & 0 deletions src/LegacySupport/DynamicDependencyAttribute.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,136 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

#pragma warning disable IDE0079
#pragma warning disable SA1101
#pragma warning disable SA1116
#pragma warning disable SA1117
#pragma warning disable SA1512
#pragma warning disable SA1623
#pragma warning disable SA1642
#pragma warning disable S3903

namespace System.Diagnostics.CodeAnalysis;

/// <summary>
/// States a dependency that one member has on another.
/// </summary>
/// <remarks>
/// This can be used to inform tooling of a dependency that is otherwise not evident purely from
/// metadata and IL, for example a member relied on via reflection.
/// </remarks>
[AttributeUsage(
AttributeTargets.Constructor | AttributeTargets.Field | AttributeTargets.Method,
AllowMultiple = true, Inherited = false)]
[ExcludeFromCodeCoverage]
internal sealed class DynamicDependencyAttribute : Attribute
{
/// <summary>
/// Initializes a new instance of the <see cref="DynamicDependencyAttribute"/> class
/// with the specified signature of a member on the same type as the consumer.
/// </summary>
/// <param name="memberSignature">The signature of the member depended on.</param>
public DynamicDependencyAttribute(string memberSignature) => MemberSignature = memberSignature;

/// <summary>
/// Initializes a new instance of the <see cref="DynamicDependencyAttribute"/> class
/// with the specified signature of a member on a <see cref="System.Type"/>.
/// </summary>
/// <param name="memberSignature">The signature of the member depended on.</param>
/// <param name="type">The <see cref="System.Type"/> containing <paramref name="memberSignature"/>.</param>
public DynamicDependencyAttribute(string memberSignature, Type type)
{
MemberSignature = memberSignature;
Type = type;
}

/// <summary>
/// Initializes a new instance of the <see cref="DynamicDependencyAttribute"/> class
/// with the specified signature of a member on a type in an assembly.
/// </summary>
/// <param name="memberSignature">The signature of the member depended on.</param>
/// <param name="typeName">The full name of the type containing the specified member.</param>
/// <param name="assemblyName">The assembly name of the type containing the specified member.</param>
public DynamicDependencyAttribute(string memberSignature, string typeName, string assemblyName)
{
MemberSignature = memberSignature;
TypeName = typeName;
AssemblyName = assemblyName;
}

/// <summary>
/// Initializes a new instance of the <see cref="DynamicDependencyAttribute"/> class
/// with the specified types of members on a <see cref="System.Type"/>.
/// </summary>
/// <param name="memberTypes">The types of members depended on.</param>
/// <param name="type">The <see cref="System.Type"/> containing the specified members.</param>
public DynamicDependencyAttribute(DynamicallyAccessedMemberTypes memberTypes, Type type)
{
MemberTypes = memberTypes;
Type = type;
}

/// <summary>
/// Initializes a new instance of the <see cref="DynamicDependencyAttribute"/> class
/// with the specified types of members on a type in an assembly.
/// </summary>
/// <param name="memberTypes">The types of members depended on.</param>
/// <param name="typeName">The full name of the type containing the specified members.</param>
/// <param name="assemblyName">The assembly name of the type containing the specified members.</param>
public DynamicDependencyAttribute(DynamicallyAccessedMemberTypes memberTypes, string typeName, string assemblyName)
{
MemberTypes = memberTypes;
TypeName = typeName;
AssemblyName = assemblyName;
}

/// <summary>
/// Gets the signature of the member depended on.
/// </summary>
/// <remarks>
/// Either <see cref="MemberSignature"/> must be a valid string or <see cref="MemberTypes"/>
/// must not equal <see cref="DynamicallyAccessedMemberTypes.None"/>, but not both.
/// </remarks>
public string? MemberSignature { get; }

/// <summary>
/// Gets the <see cref="DynamicallyAccessedMemberTypes"/> which specifies the type
/// of members depended on.
/// </summary>
/// <remarks>
/// Either <see cref="MemberSignature"/> must be a valid string or <see cref="MemberTypes"/>
/// must not equal <see cref="DynamicallyAccessedMemberTypes.None"/>, but not both.
/// </remarks>
public DynamicallyAccessedMemberTypes MemberTypes { get; }

/// <summary>
/// Gets the <see cref="System.Type"/> containing the specified member.
/// </summary>
/// <remarks>
/// If neither <see cref="Type"/> nor <see cref="TypeName"/> are specified,
/// the type of the consumer is assumed.
/// </remarks>
public Type? Type { get; }

/// <summary>
/// Gets the full name of the type containing the specified member.
/// </summary>
/// <remarks>
/// If neither <see cref="Type"/> nor <see cref="TypeName"/> are specified,
/// the type of the consumer is assumed.
/// </remarks>
public string? TypeName { get; }

/// <summary>
/// Gets the assembly name of the specified type.
/// </summary>
/// <remarks>
/// <see cref="AssemblyName"/> is only valid when <see cref="TypeName"/> is specified.
/// </remarks>
public string? AssemblyName { get; }

/// <summary>
/// Gets or sets the condition in which the dependency is applicable, e.g. "DEBUG".
/// </summary>
public string? Condition { get; set; }
}
100 changes: 100 additions & 0 deletions src/LegacySupport/DynamicallyAccessedMemberTypes.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

#pragma warning disable IDE0079
#pragma warning disable CA2217
#pragma warning disable SA1413
#pragma warning disable SA1512
#pragma warning disable S4070

namespace System.Diagnostics.CodeAnalysis;

/// <summary>
/// Specifies the types of members that are dynamically accessed.
///
/// This enumeration has a <see cref="FlagsAttribute"/> attribute that allows a
/// bitwise combination of its member values.
/// </summary>
[Flags]
internal enum DynamicallyAccessedMemberTypes
{
/// <summary>
/// Specifies no members.
/// </summary>
None = 0,

/// <summary>
/// Specifies the default, parameterless public constructor.
/// </summary>
PublicParameterlessConstructor = 0x0001,

/// <summary>
/// Specifies all public constructors.
/// </summary>
PublicConstructors = 0x0002 | PublicParameterlessConstructor,

/// <summary>
/// Specifies all non-public constructors.
/// </summary>
NonPublicConstructors = 0x0004,

/// <summary>
/// Specifies all public methods.
/// </summary>
PublicMethods = 0x0008,

/// <summary>
/// Specifies all non-public methods.
/// </summary>
NonPublicMethods = 0x0010,

/// <summary>
/// Specifies all public fields.
/// </summary>
PublicFields = 0x0020,

/// <summary>
/// Specifies all non-public fields.
/// </summary>
NonPublicFields = 0x0040,

/// <summary>
/// Specifies all public nested types.
/// </summary>
PublicNestedTypes = 0x0080,

/// <summary>
/// Specifies all non-public nested types.
/// </summary>
NonPublicNestedTypes = 0x0100,

/// <summary>
/// Specifies all public properties.
/// </summary>
PublicProperties = 0x0200,

/// <summary>
/// Specifies all non-public properties.
/// </summary>
NonPublicProperties = 0x0400,

/// <summary>
/// Specifies all public events.
/// </summary>
PublicEvents = 0x0800,

/// <summary>
/// Specifies all non-public events.
/// </summary>
NonPublicEvents = 0x1000,

/// <summary>
/// Specifies all interfaces implemented by the type.
/// </summary>
Interfaces = 0x2000,

/// <summary>
/// Specifies all members.
/// </summary>
All = ~None
}
57 changes: 57 additions & 0 deletions src/LegacySupport/DynamicallyAccessedMembersAttribute.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

#pragma warning disable IDE0079
#pragma warning disable SA1101
#pragma warning disable SA1116
#pragma warning disable SA1117
#pragma warning disable SA1512
#pragma warning disable SA1623
#pragma warning disable SA1642
#pragma warning disable S3903

namespace System.Diagnostics.CodeAnalysis;

/// <summary>
/// Indicates that certain members on a specified <see cref="Type"/> are accessed dynamically,
/// for example through <see cref="System.Reflection"/>.
/// </summary>
/// <remarks>
/// This allows tools to understand which members are being accessed during the execution
/// of a program.
///
/// This attribute is valid on members whose type is <see cref="Type"/> or <see cref="string"/>.
///
/// When this attribute is applied to a location of type <see cref="string"/>, the assumption is
/// that the string represents a fully qualified type name.
///
/// When this attribute is applied to a class, interface, or struct, the members specified
/// can be accessed dynamically on <see cref="Type"/> instances returned from calling
/// <see cref="object.GetType"/> on instances of that class, interface, or struct.
///
/// If the attribute is applied to a method it's treated as a special case and it implies
/// the attribute should be applied to the "this" parameter of the method. As such the attribute
/// should only be used on instance methods of types assignable to System.Type (or string, but no methods
/// will use it there).
/// </remarks>
[AttributeUsage(
AttributeTargets.Field | AttributeTargets.ReturnValue | AttributeTargets.GenericParameter |
AttributeTargets.Parameter | AttributeTargets.Property | AttributeTargets.Method |
AttributeTargets.Class | AttributeTargets.Interface | AttributeTargets.Struct,
Inherited = false)]
[ExcludeFromCodeCoverage]
internal sealed class DynamicallyAccessedMembersAttribute : Attribute
{
/// <summary>
/// Initializes a new instance of the <see cref="DynamicallyAccessedMembersAttribute"/> class
/// with the specified member types.
/// </summary>
/// <param name="memberTypes">The types of members dynamically accessed.</param>
public DynamicallyAccessedMembersAttribute(DynamicallyAccessedMemberTypes memberTypes) => MemberTypes = memberTypes;

/// <summary>
/// Gets the <see cref="DynamicallyAccessedMemberTypes"/> which specifies the type
/// of members dynamically accessed.
/// </summary>
public DynamicallyAccessedMemberTypes MemberTypes { get; }
}
47 changes: 47 additions & 0 deletions src/LegacySupport/RequiresUnreferencedCodeAttribute.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

#pragma warning disable IDE0079
#pragma warning disable SA1101
#pragma warning disable SA1116
#pragma warning disable SA1117
#pragma warning disable SA1512
#pragma warning disable SA1623
#pragma warning disable SA1642
#pragma warning disable S3903
#pragma warning disable S3996

namespace System.Diagnostics.CodeAnalysis;

/// <summary>
/// /// Indicates that the specified method requires dynamic access to code that is not referenced
/// statically, for example through <see cref="System.Reflection"/>.
/// </summary>
/// <remarks>
/// This allows tools to understand which methods are unsafe to call when removing unreferenced
/// code from an application.
/// </remarks>
[AttributeUsage(AttributeTargets.Method | AttributeTargets.Constructor | AttributeTargets.Class, Inherited = false)]
[ExcludeFromCodeCoverage]
internal sealed class RequiresUnreferencedCodeAttribute : Attribute
{
/// <summary>
/// Initializes a new instance of the <see cref="RequiresUnreferencedCodeAttribute"/> class
/// with the specified message.
/// </summary>
/// <param name="message">
/// A message that contains information about the usage of unreferenced code.
/// </param>
public RequiresUnreferencedCodeAttribute(string message) => Message = message;

/// <summary>
/// Gets a message that contains information about the usage of unreferenced code.
/// </summary>
public string Message { get; }

/// <summary>
/// Gets or sets an optional URL that contains more information about the method,
/// why it requires unreferenced code, and what options a consumer has to deal with it.
/// </summary>
public string? Url { get; set; }
}
Loading

0 comments on commit dd14ca6

Please sign in to comment.