UA-.NETStandard/tools/Opc.Ua.SourceGeneration/SourceGenerator.cs

/* ========================================================================
 * Copyright (c) 2005-2025 The OPC Foundation, Inc. All rights reserved.
 *
 * OPC Foundation MIT License 1.00
 *
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following
 * conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 *
 * The complete license agreement can be found here:
 * http://opcfoundation.org/License/MIT/1.00/
 * ======================================================================*/

using Microsoft.CodeAnalysis;
using Microsoft.Extensions.Logging;

namespace Opc.Ua.SourceGeneration
{
    internal static partial class SourceGenerator
    {
        /// <summary>
        /// The namespace prefix for generated code
        /// </summary>
        public const string Name = nameof(ModelSourceGenerator);

        public static readonly DiagnosticDescriptor GenericError = new(
            id: "MODELGEN001",
            title: "Error",
            messageFormat: (LocalizableString)"Error during model generation '{0}'",
            category: Name,
            DiagnosticSeverity.Error,
            isEnabledByDefault: true,
            helpLinkUri: "www.opcfoundation.org",
            customTags: ["opcua"]);

        public static readonly DiagnosticDescriptor GenericWarning = new(
            id: "MODELGEN002",
            title: "Warning",
            messageFormat: (LocalizableString)"Warning during model generation '{0}'",
            category: Name,
            DiagnosticSeverity.Warning,
            isEnabledByDefault: true,
            helpLinkUri: "www.opcfoundation.org",
            customTags: ["opcua"]);

        public static readonly DiagnosticDescriptor Exception = new(
            id: "MODELGEN003",
            title: "Exception",
            messageFormat: (LocalizableString)"Exception during model generation '{0}': {1}",
            category: Name,
            DiagnosticSeverity.Error,
            isEnabledByDefault: true,
            helpLinkUri: "www.opcfoundation.org",
            customTags: ["opcua"]);

        public static readonly DiagnosticDescriptor ModelOverrideSkipped = new(
            id: "MODELGEN013",
            title: "Model already provided by referenced assembly",
            messageFormat: (LocalizableString)("Model URI '{0}' is already provided by " +
                "referenced assembly '{1}' under prefix '{2}'; skipping local generation"),
            category: Name,
            DiagnosticSeverity.Info,
            isEnabledByDefault: true,
            helpLinkUri: "www.opcfoundation.org",
            customTags: ["opcua"]);

        public static readonly DiagnosticDescriptor FluentAccessorsOnlyModelError = new(
            id: "MODELGEN014",
            title: "Fluent-accessors-only model cannot be generated",
            messageFormat: (LocalizableString)("Cannot generate fluent accessors only for model " +
                "URI '{0}', prefix '{1}', input '{2}': {3}"),
            category: Name,
            DiagnosticSeverity.Error,
            isEnabledByDefault: true,
            helpLinkUri: "www.opcfoundation.org",
            customTags: ["opcua"]);

        public static readonly DiagnosticDescriptor FluentAccessorsOnlyOptionsError = new(
            id: "MODELGEN015",
            title: "Invalid fluent-accessors-only configuration",
            messageFormat: (LocalizableString)"Invalid fluent-accessors-only configuration: {0}",
            category: Name,
            DiagnosticSeverity.Error,
            isEnabledByDefault: true,
            helpLinkUri: "www.opcfoundation.org",
            customTags: ["opcua"]);

        public static readonly DiagnosticDescriptor ModelDependencyTieBreak = new(
            id: "MODELGEN012",
            title: "Multiple referenced assemblies expose same model",
            messageFormat: (LocalizableString)("Multiple referenced assemblies provide model " +
                "URI '{0}'; selected '{1}' and ignored '{2}'"),
            category: Name,
            DiagnosticSeverity.Info,
            isEnabledByDefault: true,
            helpLinkUri: "www.opcfoundation.org",
            customTags: ["opcua"]);

        /// <summary>
        /// A <c>[NodeManager]</c> attribute could not be bound to a model
        /// design (no matching URI / Design selector).
        /// </summary>
        public static readonly DiagnosticDescriptor NodeManagerBindingError = new(
            id: "MODELGEN010",
            title: "[NodeManager] binding error",
            messageFormat: (LocalizableString)"{0}",
            category: Name,
            DiagnosticSeverity.Warning,
            isEnabledByDefault: true,
            helpLinkUri: "www.opcfoundation.org",
            customTags: ["opcua"]);

        /// <summary>
        /// A class annotated with <c>[NodeManager]</c> is not declared
        /// <c>partial</c>.
        /// </summary>
        public static readonly DiagnosticDescriptor NodeManagerNotPartial = new(
            id: "MODELGEN011",
            title: "[NodeManager] class must be partial",
            messageFormat: (LocalizableString)"Class '{0}' annotated with [NodeManager] must be declared as partial",
            category: Name,
            DiagnosticSeverity.Error,
            isEnabledByDefault: true,
            helpLinkUri: "www.opcfoundation.org",
            customTags: ["opcua"]);

        /// <summary>
        /// A BrowseName from the design model contained characters that
        /// required escaping when interpolated into a generated C# string
        /// literal (e.g. <c>"</c>, <c>\</c>, or a control character). The
        /// generator escapes the value via
        /// <see cref="StringLiteralEscaper"/> and continues; the warning
        /// surfaces the offending name so the design XML can be cleaned
        /// up. Defence-in-depth: protects the consuming build from a
        /// confusing compiler error if a third-party design XML pulled
        /// into a custom build carries an ill-formed BrowseName.
        /// </summary>
        public static readonly DiagnosticDescriptor BrowseNameUnsafe = new(
            id: "MODELGEN020",
            title: "BrowseName requires C# string-literal escaping (UASG_BROWSENAME_UNSAFE)",
            messageFormat: (LocalizableString)("BrowseName '{0}' contained characters that " +
                "required escaping when emitted into a C# string literal. The generator " +
                "escaped the value and continued; clean up the design XML to remove the " +
                "warning."),
            category: Name,
            DiagnosticSeverity.Warning,
            isEnabledByDefault: true,
            helpLinkUri: "www.opcfoundation.org",
            customTags: ["opcua"]);

        /// <summary>
        /// A <c>[DataType]</c> namespace argument could not be resolved before
        /// source generation.
        /// </summary>
        public static readonly DiagnosticDescriptor DataTypeNamespaceUnresolved = new(
            id: "MODELGEN021",
            title: "[DataType] namespace could not be resolved",
            messageFormat: (LocalizableString)("The Namespace argument '{1}' on [DataType] " +
                "type '{0}' could not be resolved during source generation. Use a string " +
                "literal or a const declared in source or a referenced assembly; values " +
                "generated in the same compilation are unavailable."),
            category: Name,
            DiagnosticSeverity.Error,
            isEnabledByDefault: true,
            helpLinkUri: "www.opcfoundation.org",
            customTags: ["opcua"]);

        public static readonly DiagnosticDescriptor NodesetIdentifierFileMissing = new(
            id: "MODELGEN022",
            title: "NodeSet identifier file is missing",
            messageFormat: (LocalizableString)(
                "NodeSet '{0}' assigns identifier file '{1}', but it was not supplied " +
                "as an AdditionalFile"),
            category: Name,
            DiagnosticSeverity.Error,
            isEnabledByDefault: true,
            helpLinkUri: "www.opcfoundation.org",
            customTags: ["opcua"]);

        public static readonly DiagnosticDescriptor NodesetIdentifierDuplicateSymbolicName = new(
            id: "MODELGEN023",
            title: "NodeSet identifier file has a duplicate symbolic name",
            messageFormat: (LocalizableString)"NodeSet '{0}' identifier file '{1}' duplicates symbolic name '{2}'",
            category: Name,
            DiagnosticSeverity.Error,
            isEnabledByDefault: true,
            helpLinkUri: "www.opcfoundation.org",
            customTags: ["opcua"]);

        public static readonly DiagnosticDescriptor NodesetIdentifierDuplicateNumericId = new(
            id: "MODELGEN024",
            title: "NodeSet identifier file has a duplicate numeric identifier",
            messageFormat: (LocalizableString)"NodeSet '{0}' identifier file '{1}' duplicates numeric identifier '{3}'",
            category: Name,
            DiagnosticSeverity.Error,
            isEnabledByDefault: true,
            helpLinkUri: "www.opcfoundation.org",
            customTags: ["opcua"]);

        public static readonly DiagnosticDescriptor NodesetIdentifierUnknownSymbol = new(
            id: "MODELGEN025",
            title: "NodeSet identifier file references an unknown symbol",
            messageFormat: (LocalizableString)"NodeSet '{0}' identifier file '{1}' references unknown symbol '{2}'",
            category: Name,
            DiagnosticSeverity.Error,
            isEnabledByDefault: true,
            helpLinkUri: "www.opcfoundation.org",
            customTags: ["opcua"]);

        public static readonly DiagnosticDescriptor NodesetIdentifierNumericIdMismatch = new(
            id: "MODELGEN026",
            title: "NodeSet identifier file numeric identifier does not match",
            messageFormat: (LocalizableString)(
                "NodeSet '{0}' identifier file '{1}' symbol '{2}' has numeric " +
                "identifier '{3}' that differs from the NodeSet"),
            category: Name,
            DiagnosticSeverity.Error,
            isEnabledByDefault: true,
            helpLinkUri: "www.opcfoundation.org",
            customTags: ["opcua"]);

        public static readonly DiagnosticDescriptor NodesetIdentifierNodeClassMismatch = new(
            id: "MODELGEN027",
            title: "NodeSet identifier file node class does not match",
            messageFormat: (LocalizableString)(
                "NodeSet '{0}' identifier file '{1}' symbol '{2}' has node class " +
                "'{3}' that differs from the NodeSet"),
            category: Name,
            DiagnosticSeverity.Error,
            isEnabledByDefault: true,
            helpLinkUri: "www.opcfoundation.org",
            customTags: ["opcua"]);

        public static readonly DiagnosticDescriptor NodesetIdentifierAssignedToMultipleModels = new(
            id: "MODELGEN028",
            title: "NodeSet identifier file is assigned to multiple models",
            messageFormat: (LocalizableString)"NodeSet '{0}' shares identifier file '{1}' with another NodeSet model",
            category: Name,
            DiagnosticSeverity.Error,
            isEnabledByDefault: true,
            helpLinkUri: "www.opcfoundation.org",
            customTags: ["opcua"]);

        public static readonly DiagnosticDescriptor NodesetIdentifierInvalidRow = new(
            id: "MODELGEN029",
            title: "NodeSet identifier file contains an invalid row",
            messageFormat: (LocalizableString)"NodeSet '{0}' identifier file '{1}' contains invalid row '{3}'",
            category: Name,
            DiagnosticSeverity.Error,
            isEnabledByDefault: true,
            helpLinkUri: "www.opcfoundation.org",
            customTags: ["opcua"]);

        /// <summary>
        /// A WoT (<c>.tm.json</c>/<c>.td.json</c>/<c>.tm.jsonld</c>/<c>.td.jsonld</c>,
        /// or opted-in <c>.jsonld</c>) AdditionalFile could not even be parsed as
        /// JSON, could not be read, or exceeded a configured resource bound before
        /// any structured conversion diagnostics were available. The input is
        /// skipped; other inputs continue to be processed.
        /// </summary>
        public static readonly DiagnosticDescriptor WotParseError = new(
            id: "MODELGEN030",
            title: "WoT model could not be parsed",
            messageFormat: (LocalizableString)"WoT model '{0}' could not be parsed: {1}",
            category: Name,
            DiagnosticSeverity.Error,
            isEnabledByDefault: true,
            helpLinkUri: "www.opcfoundation.org",
            customTags: ["opcua"]);

        /// <summary>
        /// The WoT-to-NodeSet2 converter reported an error-severity
        /// <c>WotDiagnostic</c> (for example a resource bound, a missing
        /// preservation envelope/native mapping, a dependency/resolver
        /// failure, or another conversion error). The stable
        /// <c>Opc.Ua.Wot.WotDiagnosticCode</c> is embedded in the message.
        /// The affected WoT input is excluded from generation; other inputs
        /// continue to be processed.
        /// </summary>
        public static readonly DiagnosticDescriptor WotConversionError = new(
            id: "MODELGEN031",
            title: "WoT model could not be converted to a NodeSet2 model",
            messageFormat: (LocalizableString)"WoT model '{0}': {1}",
            category: Name,
            DiagnosticSeverity.Error,
            isEnabledByDefault: true,
            helpLinkUri: "www.opcfoundation.org",
            customTags: ["opcua"]);

        /// <summary>
        /// The WoT-to-NodeSet2 converter reported a warning-severity
        /// <c>WotDiagnostic</c> (for example an unresolved dependency/resolver
        /// reference or a lossy synthesis). Generation continues using the
        /// best-effort result.
        /// </summary>
        public static readonly DiagnosticDescriptor WotConversionWarning = new(
            id: "MODELGEN032",
            title: "WoT model conversion produced a warning",
            messageFormat: (LocalizableString)"WoT model '{0}': {1}",
            category: Name,
            DiagnosticSeverity.Warning,
            isEnabledByDefault: true,
            helpLinkUri: "www.opcfoundation.org",
            customTags: ["opcua"]);

        /// <summary>
        /// The WoT-to-NodeSet2 converter reported an info-severity
        /// <c>WotDiagnostic</c> (for example a deterministically generated
        /// NodeId). Provided for visibility only.
        /// </summary>
        public static readonly DiagnosticDescriptor WotConversionInfo = new(
            id: "MODELGEN033",
            title: "WoT model conversion note",
            messageFormat: (LocalizableString)"WoT model '{0}': {1}",
            category: Name,
            DiagnosticSeverity.Info,
            isEnabledByDefault: true,
            helpLinkUri: "www.opcfoundation.org",
            customTags: ["opcua"]);

        /// <summary>
        /// The in-memory NodeSet2 virtual path synthesized for a WoT
        /// AdditionalFile collides with an explicitly supplied
        /// <c>.NodeSet2.xml</c> input or with the virtual path synthesized for
        /// another WoT input (for example <c>Foo.tm.json</c> and
        /// <c>Foo.td.json</c> both mapping to <c>Foo.NodeSet2.xml</c>). The
        /// colliding WoT input is excluded from generation.
        /// </summary>
        public static readonly DiagnosticDescriptor WotVirtualPathCollision = new(
            id: "MODELGEN034",
            title: "WoT model virtual NodeSet2 path collides with another input",
            messageFormat: (LocalizableString)("The in-memory NodeSet2 path '{1}' generated for " +
                "WoT model '{0}' collides with input '{2}'; rename one of the inputs or set " +
                "distinct ModelSourceGeneratorName/ModelSourceGeneratorPrefix metadata"),
            category: Name,
            DiagnosticSeverity.Error,
            isEnabledByDefault: true,
            helpLinkUri: "www.opcfoundation.org",
            customTags: ["opcua"]);

        /// <summary>
        /// A <c>[NodeManager]</c> namespace URI expression could not be
        /// resolved before source generation.
        /// </summary>
        public static readonly DiagnosticDescriptor NodeManagerArgumentUnresolved = new(
            id: "MODELGEN035",
            title: "[NodeManager] namespace URI could not be resolved",
            messageFormat: (LocalizableString)("The {0} expression '{1}' on [NodeManager] " +
                "type '{2}' could not be resolved during source generation. Use a string " +
                "literal or a const declared in source or a referenced assembly; values " +
                "generated in the same compilation are unavailable."),
            category: Name,
            DiagnosticSeverity.Error,
            isEnabledByDefault: true,
            helpLinkUri: "www.opcfoundation.org",
            customTags: ["opcua"]);

        /// <summary>
        /// Get diagnostic descriptor for event id
        /// </summary>
        public static bool TryGetDiagnostic(
            LogLevel logLevel,
            EventId eventId,
            out DiagnosticDescriptor descriptor)
        {
            descriptor = eventId.Id switch
            {
                1 => GenericError,
                2 => GenericWarning,
                3 => Exception,
                20 => BrowseNameUnsafe,
                _ => logLevel switch
                {
                    // Critical is reported as enabled by the generator's logger,
                    // so it has to map to a diagnostic or the message is dropped.
                    LogLevel.Critical => GenericError,
                    LogLevel.Error => GenericError,
                    LogLevel.Warning => GenericWarning,
                    _ => null
                }
            };
            return descriptor != null;
        }
    }
}