File: src\tools\illink\src\ILLink.Shared\DiagnosticId.cs
Web Access
Project: src\src\tools\illink\src\linker\Mono.Linker.csproj (illink)
// Copyright (c) .NET Foundation and contributors. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
// This is needed due to NativeAOT which doesn't enable nullable globally yet
#nullable enable
 
using System;
 
namespace ILLink.Shared
{
    public enum DiagnosticId
    {
        // Trimming error ids.
        XmlFeatureDoesNotSpecifyFeatureValue = 1001,
        XmlUnsupportedNonBooleanValueForFeature = 1002,
        XmlException = 1003,
        _unused_FailedToProcessDescriptorFile = 1004,
        CouldNotFindMethodInAssembly = 1005,
        CannotStubConstructorWhenBaseTypeDoesNotHaveConstructor = 1006,
        CouldNotFindType = 1007,
        CouldNotFindConstructor = 1008,
        CouldNotFindAssemblyReference = 1009,
        CouldNotLoadAssembly = 1010,
        FailedToWriteOutput = 1011,
        LinkerUnexpectedError = 1012,
        ErrorProcessingXmlLocation = 1013,
        XmlDocumentLocationHasInvalidFeatureDefault = 1014,
        UnrecognizedCommandLineOption = 1015,
        InvalidWarningVersion = 1016,
        InvalidGenerateWarningSuppressionsValue = 1017,
        MissingArgumentForCommanLineOptionName = 1018,
        CustomDataFormatIsInvalid = 1019,
        NoFilesToLinkSpecified = 1020,
        NewMvidAndDeterministicCannotBeUsedAtSameTime = 1021,
        AssemblyInCustomStepOptionCouldNotBeFound = 1022,
        AssemblyPathInCustomStepMustBeFullyQualified = 1023,
        InvalidArgForCustomStep = 1024,
        ExpectedSignToControlNewStepInsertion = 1025,
        PipelineStepCouldNotBeFound = 1026,
        CustomStepTypeCouldNotBeFound = 1027,
        CustomStepTypeIsIncompatibleWithLinkerVersion = 1028,
        InvalidOptimizationValue = 1029,
        InvalidArgumentForTokenOption = 1030,
        InvalidAssemblyAction = 1031,
        RootAssemblyCouldNotBeFound = 1032,
        XmlDescriptorCouldNotBeFound = 1033,
        RootAssemblyDoesNotHaveEntryPoint = 1034,
        RootAssemblyCannotUseAction = 1035,
        InvalidAssemblyName = 1036,
        InvalidAssemblyRootMode = 1037,
        ExportedTypeCannotBeResolved = 1038,
        ReferenceAssemblyCouldNotBeLoaded = 1039,
        FailedToResolveMetadataElement = 1040,
        TypeUsedWithAttributeValueCouldNotBeFound = 1041,
        CannotConverValueToType = 1042,
        CustomAttributeArgumentForTypeRequiresNestedNode = 1043,
        CouldNotResolveCustomAttributeTypeValue = 1044,
        UnexpectedAttributeArgumentType = 1045,
        InvalidMetadataOption = 1046,
        InvalidDependenciesFileFormat = 1047,
 
        // Trimming diagnostic ids.
        TypeHasNoFieldsToPreserve = 2001,
        TypeHasNoMethodsToPreserve = 2002,
        CouldNotResolveDependencyAssembly = 2003,
        CouldNotResolveDependencyType = 2004,
        CouldNotResolveDependencyMember = 2005,
        _unused_UnrecognizedReflectionPattern = 2006,
        XmlCouldNotResolveAssembly = 2007,
        XmlCouldNotResolveType = 2008,
        XmlCouldNotFindMethodOnType = 2009,
        XmlInvalidValueForStub = 2010,
        XmlUnkownBodyModification = 2011,
        XmlCouldNotFindFieldOnType = 2012,
        XmlSubstitutedFieldNeedsToBeStatic = 2013,
        XmlMissingSubstitutionValueForField = 2014,
        XmlInvalidSubstitutionValueForField = 2015,
        XmlCouldNotFindEventOnType = 2016,
        XmlCouldNotFindPropertyOnType = 2017,
        XmlCouldNotFindGetAccesorOfPropertyOnType = 2018,
        XmlCouldNotFindSetAccesorOfPropertyOnType = 2019,
        _unused_RearrangedXmlWarning1 = 2020,
        _unused_RearrangedXmlWarning2 = 2021,
        XmlCouldNotFindMatchingConstructorForCustomAttribute = 2022,
        XmlMoreThanOneReturnElementForMethod = 2023,
        XmlMoreThanOneValueForParameterOfMethod = 2024,
        XmlDuplicatePreserveMember = 2025,
        RequiresUnreferencedCode = 2026,
        AttributeShouldOnlyBeUsedOnceOnMember = 2027,
        AttributeDoesntHaveTheRequiredNumberOfParameters = 2028,
        XmlElementDoesNotContainRequiredAttributeFullname = 2029,
        XmlCouldNotResolveAssemblyForAttribute = 2030,
        XmlAttributeTypeCouldNotBeFound = 2031,
        UnrecognizedParameterInMethodCreateInstance = 2032,
        DeprecatedPreserveDependencyAttribute = 2033,
        DynamicDependencyAttributeCouldNotBeAnalyzed = 2034,
        UnresolvedAssemblyInDynamicDependencyAttribute = 2035,
        UnresolvedTypeInDynamicDependencyAttribute = 2036,
        NoMembersResolvedForMemberSignatureOrType = 2037,
        XmlMissingNameAttributeInResource = 2038,
        XmlInvalidValueForAttributeActionForResource = 2039,
        XmlCouldNotFindResourceToRemoveInAssembly = 2040,
        DynamicallyAccessedMembersIsNotAllowedOnMethods = 2041,
        DynamicallyAccessedMembersCouldNotFindBackingField = 2042,
        DynamicallyAccessedMembersConflictsBetweenPropertyAndAccessor = 2043,
        XmlCouldNotFindAnyTypeInNamespace = 2044,
        AttributeIsReferencedButTrimmerRemoveAllInstances = 2045,
        RequiresUnreferencedCodeAttributeMismatch = 2046,
        _unused_DynamicallyAccessedMembersMismatchBetweenOverrides = 2047,
        XmlRemoveAttributeInstancesCanOnlyBeUsedOnType = 2048,
        UnrecognizedInternalAttribute = 2049,
        CorrectnessOfCOMCannotBeGuaranteed = 2050,
        XmlPropertyDoesNotContainAttributeName = 2051,
        XmlCouldNotFindProperty = 2052,
        _unused_XmlInvalidPropertyValueForProperty = 2053,
        _unused_XmlInvalidArgumentForParameterOfType = 2054,
        MakeGenericType = 2055,
        DynamicallyAccessedMembersOnPropertyConflictsWithBackingField = 2056,
        UnrecognizedTypeNameInTypeGetType = 2057,
        ParametersOfAssemblyCreateInstanceCannotBeAnalyzed = 2058,
        UnrecognizedTypeInRuntimeHelpersRunClassConstructor = 2059,
        MakeGenericMethod = 2060,
        UnresolvedAssemblyInCreateInstance = 2061,
 
        // Unknown value used in a place which requires annotation
        MethodParameterCannotBeStaticallyDetermined = 2062,
        MethodReturnValueCannotBeStaticallyDetermined = 2063,
        FieldValueCannotBeStaticallyDetermined = 2064,
        ImplicitThisCannotBeStaticallyDetermined = 2065,
        TypePassedToGenericParameterCannotBeStaticallyDetermined = 2066,
 
        // Dynamically Accessed Members attribute mismatch.
        DynamicallyAccessedMembersMismatchParameterTargetsParameter = 2067,
        DynamicallyAccessedMembersMismatchParameterTargetsMethodReturnType = 2068,
        DynamicallyAccessedMembersMismatchParameterTargetsField = 2069,
        DynamicallyAccessedMembersMismatchParameterTargetsThisParameter = 2070,
        DynamicallyAccessedMembersMismatchParameterTargetsGenericParameter = 2071,
        DynamicallyAccessedMembersMismatchMethodReturnTypeTargetsParameter = 2072,
        DynamicallyAccessedMembersMismatchMethodReturnTypeTargetsMethodReturnType = 2073,
        DynamicallyAccessedMembersMismatchMethodReturnTypeTargetsField = 2074,
        DynamicallyAccessedMembersMismatchMethodReturnTypeTargetsThisParameter = 2075,
        DynamicallyAccessedMembersMismatchMethodReturnTypeTargetsGenericParameter = 2076,
        DynamicallyAccessedMembersMismatchFieldTargetsParameter = 2077,
        DynamicallyAccessedMembersMismatchFieldTargetsMethodReturnType = 2078,
        DynamicallyAccessedMembersMismatchFieldTargetsField = 2079,
        DynamicallyAccessedMembersMismatchFieldTargetsThisParameter = 2080,
        DynamicallyAccessedMembersMismatchFieldTargetsGenericParameter = 2081,
        DynamicallyAccessedMembersMismatchThisParameterTargetsParameter = 2082,
        DynamicallyAccessedMembersMismatchThisParameterTargetsMethodReturnType = 2083,
        DynamicallyAccessedMembersMismatchThisParameterTargetsField = 2084,
        DynamicallyAccessedMembersMismatchThisParameterTargetsThisParameter = 2085,
        DynamicallyAccessedMembersMismatchThisParameterTargetsGenericParameter = 2086,
        DynamicallyAccessedMembersMismatchTypeArgumentTargetsParameter = 2087,
        DynamicallyAccessedMembersMismatchTypeArgumentTargetsMethodReturnType = 2088,
        DynamicallyAccessedMembersMismatchTypeArgumentTargetsField = 2089,
        DynamicallyAccessedMembersMismatchTypeArgumentTargetsThisParameter = 2090,
        DynamicallyAccessedMembersMismatchTypeArgumentTargetsGenericParameter = 2091,
        DynamicallyAccessedMembersMismatchOnMethodParameterBetweenOverrides = 2092,
        DynamicallyAccessedMembersMismatchOnMethodReturnValueBetweenOverrides = 2093,
        DynamicallyAccessedMembersMismatchOnImplicitThisBetweenOverrides = 2094,
        DynamicallyAccessedMembersMismatchOnGenericParameterBetweenOverrides = 2095,
 
        CaseInsensitiveTypeGetTypeCallIsNotSupported = 2096,
        DynamicallyAccessedMembersOnFieldCanOnlyApplyToTypesOrStrings = 2097,
        DynamicallyAccessedMembersOnMethodParameterCanOnlyApplyToTypesOrStrings = 2098,
        DynamicallyAccessedMembersOnPropertyCanOnlyApplyToTypesOrStrings = 2099,
        XmlUnsuportedWildcard = 2100,
        AssemblyWithEmbeddedXmlApplyToAnotherAssembly = 2101,
        InvalidIsTrimmableValue = 2102,
        PropertyAccessorParameterInLinqExpressionsCannotBeStaticallyDetermined = 2103,
        AssemblyProducedTrimWarnings = 2104,
        _unused_TypeWasNotFoundInAssemblyNorBaseLibrary = 2105,
        DynamicallyAccessedMembersOnMethodReturnValueCanOnlyApplyToTypesOrStrings = 2106,
        MethodsAreAssociatedWithStateMachine = 2107,
        InvalidScopeInUnconditionalSuppressMessage = 2108,
        RequiresUnreferencedCodeOnBaseClass = 2109,
        DynamicallyAccessedMembersFieldAccessedViaReflection = 2110,
        DynamicallyAccessedMembersMethodAccessedViaReflection = 2111,
        DynamicallyAccessedMembersOnTypeReferencesMemberWithRequiresUnreferencedCode = 2112,
        DynamicallyAccessedMembersOnTypeReferencesMemberOnBaseWithRequiresUnreferencedCode = 2113,
        DynamicallyAccessedMembersOnTypeReferencesMemberWithDynamicallyAccessedMembers = 2114,
        DynamicallyAccessedMembersOnTypeReferencesMemberOnBaseWithDynamicallyAccessedMembers = 2115,
        RequiresUnreferencedCodeOnStaticConstructor = 2116,
        MethodsAreAssociatedWithUserMethod = 2117,
        _unused_CompilerGeneratedMemberAccessedViaReflection = 2118,
        _unused_DynamicallyAccessedMembersOnTypeReferencesCompilerGeneratedMember = 2119,
        _unused_DynamicallyAccessedMembersOnTypeReferencesCompilerGeneratedMemberOnBase = 2120,
        RedundantSuppression = 2121,
        TypeNameIsNotAssemblyQualified = 2122,
        RequiresUnreferencedCodeOnEntryPoint = 2123,
        TypeMapGroupTypeCannotBeStaticallyDetermined = 2124,
        _EndTrimAnalysisWarningsSentinel,
 
        // Single-file diagnostic ids.
        AvoidAssemblyLocationInSingleFile = 3000,
        AvoidAssemblyGetFilesInSingleFile = 3001,
        RequiresAssemblyFiles = 3002,
        RequiresAssemblyFilesAttributeMismatch = 3003,
        RequiresAssemblyFilesOnStaticConstructor = 3004,
        RequiresAssemblyFilesOnEntryPoint = 3005,
 
        // Dynamic code diagnostic ids.
        RequiresDynamicCode = 3050,
        RequiresDynamicCodeAttributeMismatch = 3051,
        COMInteropNotSupportedInFullAOT = 3052,
        AssemblyProducedAOTWarnings = 3053,
        GenericRecursionCycle = 3054,
        CorrectnessOfAbstractDelegatesCannotBeGuaranteed = 3055,
        RequiresDynamicCodeOnStaticConstructor = 3056,
        RequiresDynamicCodeOnEntryPoint = 3057,
        _EndAotAnalysisWarningsSentinel,
 
        // Feature guard diagnostic ids.
        ReturnValueDoesNotMatchFeatureGuards = 4000,
        InvalidFeatureGuard = 4001
    }
 
    public static class DiagnosticIdExtensions
    {
        public static string AsString(this DiagnosticId diagnosticId) => $"IL{(int)diagnosticId}";
 
        public static string GetDiagnosticSubcategory(this DiagnosticId diagnosticId) =>
            (int)diagnosticId switch
            {
                2026 => MessageSubCategory.TrimAnalysis,
                2032 => MessageSubCategory.TrimAnalysis,
                2041 => MessageSubCategory.TrimAnalysis,
                2042 => MessageSubCategory.TrimAnalysis,
                2043 => MessageSubCategory.TrimAnalysis,
                2045 => MessageSubCategory.TrimAnalysis,
                2046 => MessageSubCategory.TrimAnalysis,
                2050 => MessageSubCategory.TrimAnalysis,
                >= 2055 and <= 2099 => MessageSubCategory.TrimAnalysis,
                2103 => MessageSubCategory.TrimAnalysis,
                2106 => MessageSubCategory.TrimAnalysis,
                2107 => MessageSubCategory.TrimAnalysis,
                >= 2109 and < (int)DiagnosticId._EndTrimAnalysisWarningsSentinel => MessageSubCategory.TrimAnalysis,
                >= 3050 and <= 3052 => MessageSubCategory.AotAnalysis,
                >= 3054 and < (int)DiagnosticId._EndAotAnalysisWarningsSentinel => MessageSubCategory.AotAnalysis,
                _ => MessageSubCategory.None,
            };
 
        public static string GetDiagnosticCategory(this DiagnosticId diagnosticId) =>
            (int)diagnosticId switch
            {
                > 2000 and < 3000 => DiagnosticCategory.Trimming,
                >= 3000 and < 3050 => DiagnosticCategory.SingleFile,
                >= 3050 and <= 6000 => DiagnosticCategory.AOT,
                _ => throw new ArgumentException($"The provided diagnostic id '{diagnosticId}' does not fall into the range of supported warning codes 2001 to 6000 (inclusive).")
            };
 
        public static string? GetHelpUri(this DiagnosticId diagnosticId) =>
            diagnosticId.GetDiagnosticCategory() switch
            {
                DiagnosticCategory.Trimming => $"https://learn.microsoft.com/dotnet/core/deploying/trimming/trim-warnings/il{(int)diagnosticId}",
                DiagnosticCategory.SingleFile => $"https://learn.microsoft.com/dotnet/core/deploying/single-file/warnings/il{(int)diagnosticId}",
                DiagnosticCategory.AOT => $"https://learn.microsoft.com/dotnet/core/deploying/native-aot/warnings/il{(int)diagnosticId}",
                _ => null
            };
    }
}