SearchVisitor.cs

Go to the documentation of this file.

// Copyright (c) 2014 Silicon Studio Corp. (http://siliconstudio.co.jp)
// This file is distributed under GPL v3. See LICENSE.md for details.
using System;
using SiliconStudio.Shaders.Ast;

namespace SiliconStudio.Shaders.Visitor
{
    /// <summary>
    /// A visitor that takes a filter function to apply to each node.
    /// </summary>
    public class SearchVisitor : ShaderVisitor
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="SearchVisitor"/> class.
        /// </summary>
        /// <param name="filterFunction">The filter function.</param>
        /// <param name="buildScopeDeclaration">if set to <c>true</c> [build scope declaration].</param>
        /// <param name="useNodeStack">if set to <c>true</c> [use node stack].</param>
        protected SearchVisitor(Func<Node, Node> filterFunction, bool buildScopeDeclaration = false, bool useNodeStack = false)
            : base(buildScopeDeclaration, useNodeStack)
        {
            FilterFunction = filterFunction;
        }

        /// <summary>
        /// Gets or sets the filter function.
        /// </summary>
        /// <value>
        /// The filter function.
        /// </value>
        protected Func<Node, Node> FilterFunction { get; set; }

        /// <summary>
        /// Visits the specified node.
        /// </summary>
        /// <param name="node">The node.</param>
        /// <returns>The filtered node</returns>
        [Visit]
        protected override Node Visit(Node node)
        {
            node = FilterFunction(node);
            return (node != null) ? base.Visit(node) : null;
        }

        /// <summary>
        /// Searches from the specified node.
        /// </summary>
        /// <param name="node">The node.</param>
        /// <param name="filter">The filter function to apply to each node.</param>
        /// <param name="buildScopeDeclaration">if set to <c>true</c> [build scope declaration].</param>
        /// <param name="useNodeStack">if set to <c>true</c> [use node stack].</param>
        public static void Run(Node node, Func<Node, Node> filter, bool buildScopeDeclaration = false, bool useNodeStack = false)
        {
            var visitor = new SearchVisitor(filter, buildScopeDeclaration, useNodeStack);
            visitor.Visit(node);
        }
    }
}