UA-.NETStandard/Tools/Opc.Ua.SourceGeneration.Core/Templating/TemplateExtensions.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 System;
using System.Collections;
using System.Collections.Generic;
using System.Linq;
using Opc.Ua.SourceGeneration;

namespace Opc.Ua
{
    internal static class TemplateExtensions
    {
        /// <summary>
        /// Add a template for substitution.
        /// </summary>
        /// <exception cref="ArgumentNullException" />
        /// <exception cref="ArgumentException"></exception>
        public static void AddReplacement(
            this Template template,
            string replacement,
            TemplateString templateString,
            IEnumerable targets,
            WriteTemplateEventHandler onWrite)
        {
            template.AddReplacement(
                replacement,
                templateString,
                targets,
                null,
                onWrite);
        }

        /// <summary>
        /// Add a template for substitution.
        /// </summary>
        /// <exception cref="ArgumentNullException" />
        /// <exception cref="ArgumentException"></exception>
        public static void AddReplacement(
            this Template template,
            string replacement,
            IEnumerable targets,
            LoadTemplateEventHandler onLoad,
            WriteTemplateEventHandler onWrite = null)
        {
            template.AddReplacement(
                replacement,
                TemplateString.Empty,
                targets,
                onLoad,
                onWrite);
        }

        /// <summary>
        /// Initializes a template to use for substitution.
        /// </summary>
        /// <exception cref="ArgumentNullException" />
        /// <exception cref="ArgumentException"></exception>
        public static void AddReplacement(
            this Template template,
            string replacement,
            TemplateString templateString,
            IEnumerable targets,
            LoadTemplateEventHandler onLoad = null,
            WriteTemplateEventHandler onWrite = null)
        {
            object[] targetArray;
            if (targets is string str)
            {
                targetArray = [str];
            }
            else if (targets is null)
            {
                targetArray = [];
            }
            else
            {
                targetArray = [.. targets.Cast<object>()];
            }
            template.AddReplacement(
                replacement,
                templateString,
                targetArray,
                onLoad,
                onWrite);
        }

        /// <summary>
        /// Add a template for substitution.
        /// </summary>
        /// <exception cref="ArgumentNullException" />
        public static void AddReplacement(
            this Template template,
            string replacement,
            TemplateString templateString,
            IReadOnlyList<object> targets,
            WriteTemplateEventHandler onWrite)
        {
            template.AddReplacement(
                replacement,
                templateString,
                targets,
                null,
                onWrite);
        }

        /// <summary>
        /// Add a template for substitution.
        /// </summary>
        /// <exception cref="ArgumentNullException" />
        public static void AddReplacement(
            this Template template,
            string replacement,
            IReadOnlyList<object> targets,
            LoadTemplateEventHandler onLoad,
            WriteTemplateEventHandler onWrite = null)
        {
            template.AddReplacement(
                replacement,
                TemplateString.Empty,
                targets,
                onLoad,
                onWrite);
        }

        /// <summary>
        /// Initializes a template to use for substitution.
        /// </summary>
        /// <exception cref="ArgumentNullException" />
        /// <exception cref="ArgumentException"></exception>
        public static void AddReplacement(
            this Template template,
            string replacement,
            TemplateString templateString,
            IReadOnlyList<object> targets,
            LoadTemplateEventHandler onLoad = null,
            WriteTemplateEventHandler onWrite = null)
        {
            if (template == null)
            {
                throw new ArgumentNullException(nameof(template));
            }
            if (string.IsNullOrEmpty(replacement))
            {
                throw new ArgumentNullException(nameof(replacement));
            }
            if (templateString is null && onLoad is null)
            {
                throw new ArgumentException(
                    "A template loader must be passed if template string is null",
                    nameof(onLoad));
            }
            var definition = new TemplateDefinition
            {
                TemplateString = templateString,
                Targets = targets ?? [],
                OnTemplateLoad = onLoad,
                OnTemplateWrite = onWrite
            };
            template.AddReplacement(replacement, definition);
        }
    }
}