/* ======================================================================== * 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 System.Collections.Generic; using System.Collections.Immutable; using System.Composition; using System.Linq; using System.Threading; using System.Threading.Tasks; using Microsoft.CodeAnalysis; using Microsoft.CodeAnalysis.CodeActions; using Microsoft.CodeAnalysis.CodeFixes; using Microsoft.CodeAnalysis.CSharp; using Microsoft.CodeAnalysis.CSharp.Syntax; using Opc.Ua.MigrationAnalyzer.Diagnostics; namespace Opc.Ua.MigrationAnalyzer.CodeFixer { /// /// UA0008 code fix: wrap each variadic argument of ISession.Call / /// ISession.CallAsync with Variant.From(...) (replacing /// null literals with Variant.Null). /// [ExportCodeFixProvider(LanguageNames.CSharp, Name = nameof(UA0008SessionCallParamsObjectCodeFix))] [Shared] public sealed class UA0008SessionCallParamsObjectCodeFix : CodeFixProvider { public override ImmutableArray FixableDiagnosticIds { get; } = [DiagnosticIds.UA0008]; public override FixAllProvider GetFixAllProvider() { return WellKnownFixAllProviders.BatchFixer; } public override async Task RegisterCodeFixesAsync(CodeFixContext context) { SyntaxNode root = (await context.Document.GetSyntaxRootAsync(context.CancellationToken) .ConfigureAwait(false))!; foreach (Diagnostic diagnostic in context.Diagnostics) { SyntaxNode node = root.FindNode(diagnostic.Location.SourceSpan, getInnermostNodeForTie: true); InvocationExpressionSyntax invocation = node.AncestorsAndSelf() .OfType() .FirstOrDefault(); if (invocation is null || invocation.ArgumentList is null) { continue; } if (!diagnostic.Properties.TryGetValue( WellKnownProperties.MethodName, out string methodName)) { continue; } context.RegisterCodeFix( CodeAction.Create( title: "Wrap arguments with 'Variant.From(...)'", createChangedDocument: ct => ApplyAsync(context.Document, invocation, methodName, ct), equivalenceKey: DiagnosticIds.UA0008), diagnostic); } } private static async Task ApplyAsync( Document document, InvocationExpressionSyntax invocation, string methodName, CancellationToken cancellationToken) { int firstVariadicIndex = methodName == "Call" ? 2 : 3; SeparatedSyntaxList originalArgs = invocation.ArgumentList.Arguments; var newArgs = new List(originalArgs.Count); for (int i = 0; i < originalArgs.Count; i++) { ArgumentSyntax arg = originalArgs[i]; if (i < firstVariadicIndex) { newArgs.Add(arg); continue; } newArgs.Add(arg.WithExpression(Wrap(arg.Expression))); } InvocationExpressionSyntax newInvocation = invocation .WithArgumentList(invocation.ArgumentList.WithArguments( SyntaxFactory.SeparatedList(newArgs))); SyntaxNode root = (await document.GetSyntaxRootAsync(cancellationToken).ConfigureAwait(false))!; SyntaxNode newRoot = root.ReplaceNode(invocation, newInvocation); return document.WithSyntaxRoot(newRoot); } private static ExpressionSyntax Wrap(ExpressionSyntax expression) { if (expression is LiteralExpressionSyntax literal && literal.IsKind(SyntaxKind.NullLiteralExpression)) { return SyntaxFactory.MemberAccessExpression( SyntaxKind.SimpleMemberAccessExpression, SyntaxFactory.IdentifierName("Variant"), SyntaxFactory.IdentifierName("Null")) .WithTriviaFrom(expression); } ExpressionSyntax stripped = expression.WithoutTrivia(); InvocationExpressionSyntax call = SyntaxFactory.InvocationExpression( SyntaxFactory.MemberAccessExpression( SyntaxKind.SimpleMemberAccessExpression, SyntaxFactory.IdentifierName("Variant"), SyntaxFactory.IdentifierName("From")), SyntaxFactory.ArgumentList( SyntaxFactory.SingletonSeparatedList( SyntaxFactory.Argument(stripped)))); return call.WithTriviaFrom(expression); } } }