Node.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 System.Collections.Generic;
using System.Runtime.Serialization;
using System.Threading;

using SourceSpan = SiliconStudio.Shaders.Ast.SourceSpan;

namespace SiliconStudio.Shaders.Ast
{
    /// <summary>
    /// Abstract node.
    /// </summary>
    public abstract class Node
    {
        /// <summary>
        /// list of childrens for ast navigation.
        /// </summary>
        [VisitorIgnore]
        private List<Node> childrenList = null;
        private Dictionary<object, object> tags;

        /// <summary>
        /// Initializes a new instance of the <see cref="Node"/> class.
        /// </summary>
        protected Node()
        {
        }

        /// <summary>
        /// Gets or sets the source span.
        /// </summary>
        /// <value>
        /// The source span.
        /// </value>
        public SourceSpan Span { get; set; }


        public override bool Equals(object against)
        {
            return base.Equals(against);
        }

        public override int GetHashCode()
        {
            return base.GetHashCode();
        }

        public static bool operator ==(Node left, Node right)
        {
            return Equals(left, right);
        }

        public static bool operator !=(Node left, Node right)
        {
            return !Equals(left, right);
        }

        /// <summary>
        /// Gets the childrens.
        /// </summary>
        protected List<Node> ChildrenList
        {
            get
            {
                if (childrenList == null)
                    childrenList = new List<Node>();
                return childrenList;
            }
        }

        /// <summary>
        /// Gets a tag value associated to this node..
        /// </summary>
        /// <param name="tagKey">The tag key.</param>
        /// <returns>The tag value</returns>
        public object GetTag(object tagKey)
        {
            if (tags == null) return null;
            object result;
            tags.TryGetValue(tagKey, out result);
            return result;
        }


        /// <summary>
        /// Gets a tag value associated to this node..
        /// </summary>
        /// <param name="tagKey">The tag key.</param>
        /// <returns>The tag value</returns>
        public bool RemoveTag(object tagKey)
        {
            if (tags == null) return true;
            return tags.Remove(tagKey);
        }

        /// <summary>
        /// Determines whether the specified instance contains this tag.
        /// </summary>
        /// <param name="tagKey">The tag key.</param>
        /// <returns>
        ///   <c>true</c> if the specified instance contains this tag; otherwise, <c>false</c>.
        /// </returns>
        public bool ContainsTag(object tagKey)
        {
            if (tags == null) return false;
            return tags.ContainsKey(tagKey);
        }

        /// <summary>
        /// Sets a tag value associated to this node.
        /// </summary>
        /// <param name="tagKey">The tag key.</param>
        /// <param name="tagValue">The tag value.</param>
        public void SetTag(object tagKey, object tagValue)
        {
            if (tags == null) tags = new Dictionary<object, object>();
            tags.Remove(tagKey);
            tags.Add(tagKey, tagValue);
        }

        /// <summary>
        /// Gets the child nodes.
        /// </summary>
        /// <returns>An enumeration of child nodes</returns>
        public virtual IEnumerable<Node> Childrens()
        {
            return ChildrenList;
        }

        /// <inheritdoc/>
        public override string ToString()
        {
            return GetType().Name;
        }
    }
}