GithubStar/UA-.NETStandard
1
0
Fork 0
mirror of https://github.com/OPCFoundation/UA-.NETStandard.git synced 2026-10-17 05:11:13 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
master
UA-.NETStandard/tools/Opc.Ua.SourceGeneration/SourceGenerator.cs
T
romanett 442889cba5 Fix source generator audit findings; conform structure-field matrices and type metadata to OPC UA 1.05 (#4569) 
# Description

This PR fixes a bug audit of the source generation projects
(`tools/Opc.Ua.SourceGeneration*`: model loading, NodeSet import, all
emitters, the Roslyn hosts and packaging). It also fixes a max-effort
code review of those fixes, and a check of every spec-relevant change
against the OPC UA 1.05 text.

- **Scope:** about 85 audit findings, 48 review findings and 32
spec-grounding items were addressed. Each fix has a regression test that
fails without it.
- **Wire change:** it includes one deliberate, stack-wide wire change:
**structure-field matrices now follow OPC 10000-6 5.2.5 Table 28**.

Most changes are internal correctness fixes. The sections below list
every change a user can observe: wire formats, generated code and API,
generated address-space content, diagnostics and runtime behaviour.

## Behaviour / user-facing changes

### Wire format (encoders)
- **Binary inline matrices** (OPC 10000-6 5.2.5 Table 28).
- **Layout:** a multi-dimensional *structure field* is encoded as
`Int32[] Dimensions`, then the values **without a length prefix**, with
at least 2 dimensions.
- **Empty and null:** any dimension <= 0 means no values follow, and a
null matrix is `-1`. An empty matrix is written as `[0,0]`.
- **Compatibility:** this is **not compatible with earlier builds of
this SDK** for matrix fields. It applies to generated types,
`[DataType]` types, `Structure`, client ComplexTypes and
`WriteEncodeableMatrix`.
  - **Unchanged:** Variant matrices (5.2.2.16) keep their old encoding.
- **Declared rank decides matrix vs array.** A 1-D `MatrixOf<T>` in an
array field or a Variable value is written as an array again.
Matrix-declared fields go through the new public
`EncoderExtensions.WriteInlineMatrixValue`, which generated code also
uses. A non-empty 1-D value in a matrix field throws `BadEncodingError`.
- **Decoder hardening:**
- Before allocating, the decoder bounds all matrix dimensions against
overflow, `MaxArrayLength` and the remaining message length.
  - The decoder rejects:
    - a matrix with fewer than 2 dimensions;
- a populated matrix whose rank differs from the field's declared rank;
    - a union SwitchField greater than the number of fields;
    - an EncodingMask with unassigned bits set.
- **Encoder `MaxArrayLength`:** the encoder enforces `MaxArrayLength`
for inline matrices, as it already did for arrays.
- **XML structure fields** (5.3.1, 5.3.4, 5.3.5).
- **Fields:** `Structure` and client ComplexTypes write fields like
typed fields (`<A>1</A>`, array elements directly) instead of a Variant
body.
- **Matrix fields:** `Dimensions` and `Elements` go directly inside the
field element, with no `<Matrix>` wrapper.
- **Empty matrices:** written as nil, because XML dimensions must be
greater than 0.
  - **Compatibility:** decoders still accept the old shapes.
- **Enum fixes:** enum array elements with value 0 are no longer
dropped, and enum array element names are fixed.
- **Other encoding fixes:**
- A null `DiagnosticInfo` structure field writes `0x00` instead of
nothing.
- A null scalar field in a runtime `Structure` is written as its default
instead of zero bytes, which used to shift every following field.
- A Variant holding an empty matrix encodes as an empty array instead of
throwing.
  - `Variant.Copy` keeps the matrix identity of null and empty matrices.
- **NodeSet export and the DataContract surrogate** write Variable
values with the Variant rules again. A null or empty `MatrixOf` variable
no longer produces invalid XML or unreadable NodeSets.
- **`JsonEncoder.CanOmitFields`** is `true` only for Compact encoding.
Verbose and RawData JSON include default-valued fields.

### `[DataType]` source-generated types
- **Default-value handling** (OPC 10000-6 5.4.1, Table 1).
- **Encode:** a field is omitted only when its value *and* its declared
default are the type's default (0, false, null). Fields with a
non-default initializer or constructor default, and empty strings, are
always written, so configuration files get slightly larger.
- **JSON decode:** a field missing from JSON decodes to the type
default.
- **XML decode:** a field missing from XML keeps its declared default,
which older configuration files rely on.
- **Why:** this fixes silent round-trip loss, for example
`SamplingInterval = 0` read back as `-1`.
- **Nested `[DataType]` types:** they are now generated inside their
containing types. Without an explicit id, their default TypeId and
XmlName are qualified (e.g. `s=Outer.Foo`); **wire identity change** for
nested types. Colliding activator names get a `_2` suffix.
- **Activators:** they are `internal` when the type, or any containing
type, is not public (was CS0060).
- **Matrix properties:**
  - `MatrixOf<T>` properties use the inline matrix encoding.
- Matrices of non-sealed structures, or with
`StructureHandling.ExtensionObject`, are written as ExtensionObjects.
- Their published ValueRank is 2, because the rank can't be known from
`MatrixOf<T>`.
- **Published StructureDefinitions:**
  - They include base-class fields.
  - Nullable properties are no longer marked optional.
  - Inline structure fields name their concrete type.
- **`[Flags]` enums:** they are published as plain enumerations with
their member values, which matches how they are encoded.
- **Other generated code:**
- `Clone` deep-copies arrays and matrices of structures, Variants,
ExtensionObjects and DataValues.
- `IsEqual` and `GetHashCode` are consistent: EncodingMask, active union
member and NaN handling agree.
- Pooled `Reuse()` restores the freshly constructed state through the
new `protected virtual ResetForReuse()`, and returns an instance to its
runtime type's pool.
- **Enum capture:** enum member values are captured culture-invariantly.
Negative values were lost on cultures that use U+2212 as the minus sign.

### Model-driven generator: generated code, API and file names
- **Removed API:** generated `*_Placeholder` proxy accessors (e.g.
`PowerTrainTypeClient.GetMotorIdentifier_PlaceholderAsync`) and fluent
`X_Placeholder()` accessors are removed; they could never resolve
anything.
- Proxy accessors now look children up by BrowseName with the right
namespace.
- `RoboticsClient` finds motors and gears by type and drives via
`IsDrivenBy`. Its topology snapshots used to be empty.
- **Renamed files:** generated files for a bound `[NodeManager]` are now
named `{Namespace}.{Class}.NodeManager.g.cs` (also `.Factory` and
`.FluentBuilders`).
- **Generated NodeState code:**
- Attributes are set through `baseState`/`nodeState` locals, so children
named like base attributes (e.g. `DataType`, `EventNotifier`) compile.
- Children that hide base members are declared `public new`, using names
reflected from the runtime.
  - `global::` qualification is used throughout.
- **Proxies and fluent builders:** a proxy whose supertype is excluded
(e.g. Draft) derives from the nearest emitted ancestor. Fluent wrappers
and NodeState factories fall back the same way; they used to fail with
CS0246.
- **Derived structures:**
  - The optional-field `EncodingMask` continues across inheritance.
- A derived structure over a base type from another model no longer
relies on `base.ResetForReuse`.
- **Default values:**
- NodeId, QualifiedName and ExpandedNodeId defaults resolve by namespace
URI (`context.NamespaceUris.GetIndexOrAppend`) and server URI.
- StatusCode, negative enum, `double`/`float` (shortest round-trip
literal) and escaped string defaults now compile.
- **Event records:**
- Vendor event records have `Decoder.GetStandardFields(NamespaceTable)`,
and their browse paths use the model's namespace.
- A field whose namespace is unknown to the session no longer matches a
namespace-0 field.
  - Companion `StandardFields` is `[Obsolete]`.
- Vendor simple subtypes such as `Percent : Double` map to their
built-in type.
- **Other fixes:**
- `MethodState.CallAsync` passes the real `objectId` to synchronous
`OnCallMethod2` handlers; it used to pass `NodeId.Null`.
- Enumeration fields with an explicit `Identifier` keep it, instead of
taking a trailing `_<digits>`.
  - Explicit NumericIds are no longer reused by automatic numbering.
  - Dependencies are loaded in topological order.

### Generated address-space content
- **Arguments:**
- Methods without arguments no longer get empty
`InputArguments`/`OutputArguments` properties (OPC 10000-3 5.7).
- About 2,660 automatically assigned namespace-0 NodeIds of 15000 and
above shift. Every NodeId in `StandardTypes.csv` is unchanged.
- **Permissions:** type nodes and method declarations on types now carry
the model's `RolePermissions`/`AccessRestrictions`.
- **Restored nodes:** NodeSet import keeps nodes that were silently
dropped before:
- `NamespaceMetadata` objects and the NodeSet's own TypeDictionary
variables;
  - ISA95 placeholders linked only non-hierarchically;
  - instances whose parent is in another namespace.
- **Import details:**
  - ValueRank > 1 without ArrayDimensions keeps its rank.
  - `svr=` indexes map correctly.
  - Invalid MinimumSamplingInterval values import as -1, not 0.
  - Localized texts prefer the invariant or English translation.
- **StructureDefinitions:**
- They include inherited fields, including for subtypes without their
own fields (e.g. `AnonymousIdentityToken` now publishes PolicyId).
  - The StructureType kind covers inherited AllowSubTypes fields.
  - Unions ignore IsOptional.
- StructureFields never publish ValueRank 0; a OneOrMoreDimensions field
without dimensions becomes rank 2.
- Fields with ValueRank -2/-3 are published as scalar BaseDataType,
which is what is on the wire.
- **OptionSets:**
  - Implicit fields get the next free bit.
- `OptionSetValues` uses null for undefined bits instead of "Reserved",
and structure OptionSets publish all their bits (no 32/96-bit cap).
- Numeric OptionSets are limited to their base type's width, and UInt64
bit 63 works.
- **Schemas:**
- Structures with inline-matrix fields are left out of the `.bsd`
(5.2.5).
- In the BSD, Variant-encoded and non-structure subtyped fields are
described as `ua:Variant`.
- In the `.xsd`, matrix fields are typed `ua:Matrix` with
`Dimensions`/`Elements`, and `EncodingMask` is required.

### NodeSet / model input handling
- **Model selection:**
- The newest NodeSet of a model is chosen by `ModelVersion` (SemVer 2.0
precedence), then PublicationDate. The `Version` attribute, which Annex
F says is not for comparison, is only a tie-break.
- The order is total and does not depend on input order; referenced
assemblies use the same rule.
- **Default names:**
- Invalid default Name/Prefix values are repaired (`201301ISA95` becomes
`_201301ISA95`, `class` becomes `class_`).
  - Valid names are unchanged.
  - Sanitising no longer depends on the OS.
- **`ModelUri` metadata** that doesn't match the NodeSet raises a
warning instead of silently losing the model.
- **Input detection:**
- Only XML files whose root is `ModelDesign` or `UANodeSet` are treated
as models.
- A malformed NodeSet stays a NodeSet input, so it no longer breaks the
ModelDesign pass.
- **`IdentifierFile` paths:** they are normalized (`./`, `../`), and the
suffix match requires a folder boundary.
- **Dependency payloads** (`ModelDependencyV1`) carry field IsOptional,
AllowSubTypes, ArrayDimensions and the producer's namespace tables in
skippable trailers, so old and new readers stay compatible.

### Roslyn host, diagnostics, packaging
- **New diagnostics:**
- MODELGEN036: `[NodeManager]` target not supported (nested, generic,
file-local or global namespace).
- MODELGEN037: `[DataType]` target not supported (struct, generic,
abstract, file-local or global namespace).
- MODELGEN038: the definition of an encodeable base type can't be found.
- **New validator errors:**
- a structure with both optional and subtyped fields (OPC 10000-6 F.13);
  - multi-bit or duplicate OptionSet masks.
- **Diagnostic locations:** `[DataType]`/`[NodeManager]` diagnostics
point at real source locations again, so `#pragma` and `.editorconfig`
apply. MODELGEN010 is the exception.
- **Incremental caching:** pipeline values compare by value, so
unrelated edits no longer regenerate the whole model or all
`[DataType]`s.
- **`ModelSourceGeneratorIgnore`** on a ModelDesign input is honoured;
the design still resolves as a dependency.
- **Cancellation:** a cancelled generation run propagates
`OperationCanceledException` instead of reporting a MODELGEN003 error.
- **Stack package:** the `Stack` NuGet package now ships
`build/OPCFoundation.NetStandard.Opc.Ua.SourceGeneration.Stack.props`,
so `StackSourceGeneratorMode` and `StackSourceGeneratorExclude` reach
the compiler.

## Related Issues

- No tracking issue. The audit, review and spec-grounding reports are
available on request. Contains the matrix wire-format change discussed
for D-5 (OPC 10000-6 5.2.5 Table 28).

## Checklist

- [ ] I have signed the
[CLA](https://opcfoundation.org/license/cla/ContributorLicenseAgreementv1.0.pdf)
and read the
[CONTRIBUTING](https://github.com/OPCFoundation/UA-.NETStandard/blob/master/CONTRIBUTING.md)
doc.
- [x] I have added tests that prove my fix is effective or that my
feature works and increased code coverage.
- [x] I have added all necessary documentation.
(`docs/SourceGeneratedDataTypes.md`, `docs/NodeManagers.md`, generator
readme)
- [x] I have verified that my changes do not introduce (new) build or
analyzer warnings. (`UA.slnx` 0 warnings / 0 errors on net48 and
net10.0)
- [ ] I ran **all** tests locally using the **UA.slnx** solution against
at least .net **framework** and .net **10**, and all passed. The
affected suites were run on net10.0: SourceGeneration Core/Roslyn/Stack,
Types, Core.Encoders, Encoders.Fuzz, Client, Client.ComplexTypes,
PubSub, Core, Server, GDS, Configuration, Di, Robotics, ISA95,
Positioning, OpenUsd, XRegistry. net48 was built; its test legs, and the
post-rebase verification, run in CI.
- [ ] I fixed **all** failing and flaky tests in the CI pipelines and
**all** CodeQL warnings.
- [ ] I have addressed **all** PR feedback received.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-29 00:47:40 +02:00

453 lines
21 KiB
C#
Raw Permalink Blame History

/* ========================================================================
* 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>
/// A <c>[NodeManager]</c> is applied to a class the generated
/// manager cannot be attached to (a nested or generic class).
/// </summary>
public static readonly DiagnosticDescriptor NodeManagerUnsupportedTarget = new(
id: "MODELGEN036",
title: "[NodeManager] class is not supported",
messageFormat: (LocalizableString)("[NodeManager] cannot be applied to class '{0}' " +
"because {1}. Declare the node manager as a top-level, non-generic partial class."),
category: Name,
DiagnosticSeverity.Error,
isEnabledByDefault: true,
helpLinkUri: "www.opcfoundation.org",
customTags: ["opcua"]);
/// <summary>
/// A <c>[DataType]</c> is applied to a type the generated encodeable
/// members cannot be attached to (a struct, a generic type, or a nested
/// type in a non-partial or inaccessible containing type).
/// </summary>
public static readonly DiagnosticDescriptor DataTypeUnsupportedTarget = new(
id: "MODELGEN037",
title: "[DataType] type is not supported",
messageFormat: (LocalizableString)"[DataType] type '{0}' is not supported: {1}",
category: Name,
DiagnosticSeverity.Error,
isEnabledByDefault: true,
helpLinkUri: "www.opcfoundation.org",
customTags: ["opcua"]);
/// <summary>
/// A <c>[DataType]</c> class derives from an encodeable type whose data
/// type definition cannot be found (no <c>[DataType]</c> attribute and
/// no activator exposing a definition, or a generic base). Encode
/// writes the base fields first, but the published StructureDefinition
/// can only list the class's own fields, so it does not describe the
/// encoding (OPC 10000-3 8.48).
/// </summary>
public static readonly DiagnosticDescriptor DataTypeBaseDefinitionUnresolved = new(
id: "MODELGEN038",
title: "[DataType] base type definition cannot be resolved",
messageFormat: (LocalizableString)("[DataType] type '{0}' derives from '{1}', whose data type " +
"definition cannot be resolved. The published StructureDefinition lists only the fields " +
"of '{0}' although the base fields are encoded first. Annotate the base type with " +
"[DataType] or derive from a type that has a generated activator."),
category: Name,
DiagnosticSeverity.Warning,
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;
}
}
}
Reference in New Issue View Git Blame Copy Permalink