sked/Assets/Spine/Runtime/spine-csharp/Collections/OrderedDictionary.cs

/******************************************************************************
 * Spine Runtimes License Agreement
 * Last updated January 1, 2020. Replaces all prior versions.
 *
 * Copyright (c) 2013-2020, Esoteric Software LLC
 *
 * Integration of the Spine Runtimes into software or otherwise creating
 * derivative works of the Spine Runtimes is permitted under the terms and
 * conditions of Section 2 of the Spine Editor License Agreement:
 * http://esotericsoftware.com/spine-editor-license
 *
 * Otherwise, it is permitted to integrate the Spine Runtimes into software
 * or otherwise create derivative works of the Spine Runtimes (collectively,
 * "Products"), provided that each user of the Products must obtain their own
 * Spine Editor license and redistribution of the Products in any form must
 * include this license and copyright notice.
 *
 * THE SPINE RUNTIMES ARE PROVIDED BY ESOTERIC SOFTWARE LLC "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL ESOTERIC SOFTWARE LLC BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES,
 * BUSINESS INTERRUPTION, OR LOSS OF USE, DATA, OR PROFITS) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THE SPINE RUNTIMES, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *****************************************************************************/

/******************************************************************************
 * Thanks to Travis Parks
 * https://github.com/jehugaleahsa/truncon.collections.OrderedDictionary
 *****************************************************************************/

using System;
using System.Collections;
using System.Collections.Generic;
using System.ComponentModel;
using System.Diagnostics;
using System.Linq;

namespace Spine.Collections
{
	/// <summary>
	/// Represents a dictionary that tracks the order that items were added.
	/// </summary>
	/// <typeparam name="TKey">The type of the dictionary keys.</typeparam>
	/// <typeparam name="TValue">The type of the dictionary values.</typeparam>
	/// <remarks>
	/// This dictionary makes it possible to get the index of a key and a key based on an index.
	/// It can be costly to find the index of a key because it must be searched for linearly.
	/// It can be costly to insert a key/value pair because other key's indexes must be adjusted.
	/// It can be costly to remove a key/value pair because other keys' indexes must be adjusted.
	/// </remarks>
	[DebuggerDisplay("Count = {Count}")]
	[DebuggerTypeProxy(typeof(OrderedDictionaryDebugView<,>))]
	public sealed class OrderedDictionary<TKey, TValue> : IDictionary<TKey, TValue>, IList<KeyValuePair<TKey, TValue>>
	{
		private readonly Dictionary<TKey, int> dictionary;
		private readonly List<TKey> keys;
		private readonly List<TValue> values;
		private int version;

		private const string CollectionModifiedMessage = "Collection was modified; enumeration operation may not execute.";
		private const string EditReadOnlyListMessage = "An attempt was made to edit a read-only list.";
		private const string IndexOutOfRangeMessage = "The index is negative or outside the bounds of the collection.";

		/// <summary>
		/// Initializes a new instance of an OrderedDictionary.
		/// </summary>
		public OrderedDictionary ()
			: this(0, null) {
		}

		/// <summary>
		/// Initializes a new instance of an OrderedDictionary.
		/// </summary>
		/// <param name="capacity">The initial capacity of the dictionary.</param>
		/// <exception cref="System.ArgumentOutOfRangeException">The capacity is less than zero.</exception>
		public OrderedDictionary (int capacity)
			: this(capacity, null) {
		}

		/// <summary>
		/// Initializes a new instance of an OrderedDictionary.
		/// </summary>
		/// <param name="comparer">The equality comparer to use to compare keys.</param>
		public OrderedDictionary (IEqualityComparer<TKey> comparer)
			: this(0, comparer) {
		}

		/// <summary>
		/// Initializes a new instance of an OrderedDictionary.
		/// </summary>
		/// <param name="capacity">The initial capacity of the dictionary.</param>
		/// <param name="comparer">The equality comparer to use to compare keys.</param>
		public OrderedDictionary (int capacity, IEqualityComparer<TKey> comparer) {
			dictionary = new Dictionary<TKey, int>(capacity, comparer ?? EqualityComparer<TKey>.Default);
			keys = new List<TKey>(capacity);
			values = new List<TValue>(capacity);
		}

		/// <summary>
		/// Gets the equality comparer used to compare keys.
		/// </summary>
		public IEqualityComparer<TKey> Comparer {
			get {
				return dictionary.Comparer;
			}
		}

		/// <summary>
		/// Adds the given key/value pair to the dictionary.
		/// </summary>
		/// <param name="key">The key to add to the dictionary.</param>
		/// <param name="value">The value to associated with the key.</param>
		/// <exception cref="System.ArgumentException">The given key already exists in the dictionary.</exception>
		/// <exception cref="System.ArgumentNullException">The key is null.</exception>
		public void Add (TKey key, TValue value) {
			dictionary.Add(key, values.Count);
			keys.Add(key);
			values.Add(value);
			++version;
		}

		/// <summary>
		/// Inserts the given key/value pair at the specified index.
		/// </summary>
		/// <param name="index">The index to insert the key/value pair.</param>
		/// <param name="key">The key to insert.</param>
		/// <param name="value">The value to insert.</param>
		/// <exception cref="System.ArgumentException">The given key already exists in the dictionary.</exception>
		/// <exception cref="System.ArgumentNullException">The key is null.</exception>
		/// <exception cref="System.ArgumentOutOfRangeException">The index is negative -or- larger than the size of the dictionary.</exception>
		public void Insert (int index, TKey key, TValue value) {
			if (index < 0 || index > values.Count) {
				throw new ArgumentOutOfRangeException("index", index, IndexOutOfRangeMessage);
			}
			dictionary.Add(key, index);
			for (int keyIndex = index; keyIndex != keys.Count; ++keyIndex) {
				var otherKey = keys[keyIndex];
				dictionary[otherKey] += 1;
			}
			keys.Insert(index, key);
			values.Insert(index, value);
			++version;
		}

		/// <summary>
		/// Determines whether the given key exists in the dictionary.
		/// </summary>
		/// <param name="key">The key to look for.</param>
		/// <returns>True if the key exists in the dictionary; otherwise, false.</returns>
		/// <exception cref="System.ArgumentNullException">The key is null.</exception>
		public bool ContainsKey (TKey key) {
			return dictionary.ContainsKey(key);
		}

		/// <summary>
		/// Gets the key at the given index.
		/// </summary>
		/// <param name="index">The index of the key to get.</param>
		/// <returns>The key at the given index.</returns>
		/// <exception cref="System.ArgumentOutOfRangeException">The index is negative -or- larger than the number of keys.</exception>
		public TKey GetKey (int index) {
			return keys[index];
		}

		/// <summary>
		/// Gets the index of the given key.
		/// </summary>
		/// <param name="key">The key to get the index of.</param>
		/// <returns>The index of the key in the dictionary -or- -1 if the key is not found.</returns>
		/// <remarks>The operation runs in O(n).</remarks>
		public int IndexOf (TKey key) {
			int index;
			if (dictionary.TryGetValue(key, out index)) {
				return index;
			}
			return -1;
		}

		/// <summary>
		/// Gets the keys in the dictionary in the order they were added.
		/// </summary>
		public KeyCollection Keys {
			get {
				return new KeyCollection(this.dictionary);
			}
		}

		/// <summary>
		/// Removes the key/value pair with the given key from the dictionary.
		/// </summary>
		/// <param name="key">The key of the pair to remove.</param>
		/// <returns>True if the key was found and the pair removed; otherwise, false.</returns>
		/// <exception cref="System.ArgumentNullException">The key is null.</exception>
		public bool Remove (TKey key) {
			int index;
			if (dictionary.TryGetValue(key, out index)) {
				RemoveAt(index);
				return true;
			}
			return false;
		}

		/// <summary>
		/// Removes the key/value pair at the given index.
		/// </summary>
		/// <param name="index">The index of the key/value pair to remove.</param>
		/// <exception cref="System.ArgumentOutOfRangeException">The index is negative -or- larger than the size of the dictionary.</exception>
		public void RemoveAt (int index) {
			var key = keys[index];
			for (int keyIndex = index + 1; keyIndex < keys.Count; ++keyIndex) {
				var otherKey = keys[keyIndex];
				dictionary[otherKey] -= 1;
			}
			dictionary.Remove(key);
			keys.RemoveAt(index);
			values.RemoveAt(index);
			++version;
		}

		/// <summary>
		/// Tries to get the value associated with the given key. If the key is not found,
		/// default(TValue) value is stored in the value.
		/// </summary>
		/// <param name="key">The key to get the value for.</param>
		/// <param name="value">The value used to hold the results.</param>
		/// <returns>True if the key was found; otherwise, false.</returns>
		/// <exception cref="System.ArgumentNullException">The key is null.</exception>
		public bool TryGetValue (TKey key, out TValue value) {
			int index;
			if (dictionary.TryGetValue(key, out index)) {
				value = values[index];
				return true;
			}
			value = default(TValue);
			return false;
		}

		/// <summary>
		/// Gets the values in the dictionary.
		/// </summary>
		public ValueCollection Values {
			get {
				return new ValueCollection(values);
			}
		}

		/// <summary>
		/// Gets or sets the value at the given index.
		/// </summary>
		/// <param name="index">The index of the value to get.</param>
		/// <returns>The value at the given index.</returns>
		/// <exception cref="System.ArgumentOutOfRangeException">The index is negative -or- beyond the length of the dictionary.</exception>
		public TValue this[int index] {
			get {
				return values[index];
			}

			set {
				values[index] = value;
			}
		}

		/// <summary>
		/// Gets or sets the value associated with the given key.
		/// </summary>
		/// <param name="key">The key to get the associated value by or to associate with the value.</param>
		/// <returns>The value associated with the given key.</returns>
		/// <exception cref="System.ArgumentNullException">The key is null.</exception>
		/// <exception cref="System.Collections.Generic.KeyNotFoundException">The key is not in the dictionary.</exception>
		public TValue this[TKey key] {
			get {
				return values[dictionary[key]];
			}
			set {
				int index;
				if (dictionary.TryGetValue(key, out index)) {
					keys[index] = key;
					values[index] = value;
				}
				else {
					Add(key, value);
				}
			}
		}

		/// <summary>
		/// Removes all key/value pairs from the dictionary.
		/// </summary>
		public void Clear () {
			dictionary.Clear();
			keys.Clear();
			values.Clear();
			++version;
		}

		/// <summary>
		/// Gets the number of key/value pairs in the dictionary.
		/// </summary>
		public int Count {
			get {
				return dictionary.Count;
			}
		}

		/// <summary>
		/// Gets the key/value pairs in the dictionary in the order they were added.
		/// </summary>
		/// <returns>An enumerator over the key/value pairs in the dictionary.</returns>
		public IEnumerator<KeyValuePair<TKey, TValue>> GetEnumerator () {
			int startVersion = version;
			for (int index = 0; index != keys.Count; ++index) {
				var key = keys[index];
				var value = values[index];
				yield return new KeyValuePair<TKey, TValue>(key, value);
				if (version != startVersion) {
					throw new InvalidOperationException(CollectionModifiedMessage);
				}
			}
		}

		int IList<KeyValuePair<TKey, TValue>>.IndexOf (KeyValuePair<TKey, TValue> item) {
			int index;
			if (dictionary.TryGetValue(item.Key, out index) && Equals(values[index], item.Value)) {
				return index;
			}
			return -1;
		}

		void IList<KeyValuePair<TKey, TValue>>.Insert (int index, KeyValuePair<TKey, TValue> item) {
			Insert(index, item.Key, item.Value);
		}

		KeyValuePair<TKey, TValue> IList<KeyValuePair<TKey, TValue>>.this[int index] {
			get {
				TKey key = keys[index];
				TValue value = values[index];
				return new KeyValuePair<TKey, TValue>(key, value);
			}
			set {
				TKey key = keys[index];
				if (dictionary.Comparer.Equals(key, value.Key)) {
					dictionary[value.Key] = index;
				}
				else {
					dictionary.Add(value.Key, index); // will throw if key already exists
					dictionary.Remove(key);
				}
				keys[index] = value.Key;
				values[index] = value.Value;
			}
		}

		ICollection<TKey> IDictionary<TKey, TValue>.Keys {
			get {
				return Keys;
			}
		}

		ICollection<TValue> IDictionary<TKey, TValue>.Values {
			get {
				return Values;
			}
		}

		void ICollection<KeyValuePair<TKey, TValue>>.Add (KeyValuePair<TKey, TValue> item) {
			Add(item.Key, item.Value);
		}

		bool ICollection<KeyValuePair<TKey, TValue>>.Contains (KeyValuePair<TKey, TValue> item) {
			int index;
			if (dictionary.TryGetValue(item.Key, out index) && Equals(values[index], item.Value)) {
				return true;
			}
			return false;
		}

		void ICollection<KeyValuePair<TKey, TValue>>.CopyTo (KeyValuePair<TKey, TValue>[] array, int arrayIndex) {
			if (array == null) {
				throw new ArgumentNullException("array");
			}
			if (arrayIndex < 0) {
				throw new ArgumentOutOfRangeException("arrayIndex", arrayIndex, IndexOutOfRangeMessage);
			}
			for (int index = 0; index != keys.Count && arrayIndex < array.Length; ++index, ++arrayIndex) {
				var key = keys[index];
				var value = values[index];
				array[arrayIndex] = new KeyValuePair<TKey, TValue>(key, value);
			}
		}

		bool ICollection<KeyValuePair<TKey, TValue>>.IsReadOnly {
			get {
				return false;
			}
		}

		bool ICollection<KeyValuePair<TKey, TValue>>.Remove (KeyValuePair<TKey, TValue> item) {
			ICollection<KeyValuePair<TKey, TValue>> self = this;
			if (self.Contains(item)) {
				return Remove(item.Key);
			}
			return false;
		}

		IEnumerator IEnumerable.GetEnumerator () {
			return GetEnumerator();
		}

		/// <summary>
		/// Wraps the keys in an OrderDictionary.
		/// </summary>
		public sealed class KeyCollection : ICollection<TKey>
		{
			private readonly Dictionary<TKey, int> dictionary;

			/// <summary>
			/// Initializes a new instance of a KeyCollection.
			/// </summary>
			/// <param name="dictionary">The OrderedDictionary whose keys to wrap.</param>
			/// <exception cref="System.ArgumentNullException">The dictionary is null.</exception>
			internal KeyCollection (Dictionary<TKey, int> dictionary) {
				this.dictionary = dictionary;
			}

			/// <summary>
			/// Copies the keys from the OrderedDictionary to the given array, starting at the given index.
			/// </summary>
			/// <param name="array">The array to copy the keys to.</param>
			/// <param name="arrayIndex">The index into the array to start copying the keys.</param>
			/// <exception cref="System.ArgumentNullException">The array is null.</exception>
			/// <exception cref="System.ArgumentOutOfRangeException">The arrayIndex is negative.</exception>
			/// <exception cref="System.ArgumentException">The array, starting at the given index, is not large enough to contain all the keys.</exception>
			public void CopyTo (TKey[] array, int arrayIndex) {
				dictionary.Keys.CopyTo(array, arrayIndex);
			}

			/// <summary>
			/// Gets the number of keys in the OrderedDictionary.
			/// </summary>
			public int Count {
				get {
					return dictionary.Count;
				}
			}

			/// <summary>
			/// Gets an enumerator over the keys in the OrderedDictionary.
			/// </summary>
			/// <returns>The enumerator.</returns>
			public IEnumerator<TKey> GetEnumerator () {
				return dictionary.Keys.GetEnumerator();
			}

			[EditorBrowsable(EditorBrowsableState.Never)]
			bool ICollection<TKey>.Contains (TKey item) {
				return dictionary.ContainsKey(item);
			}

			[EditorBrowsable(EditorBrowsableState.Never)]
			void ICollection<TKey>.Add (TKey item) {
				throw new NotSupportedException(EditReadOnlyListMessage);
			}

			[EditorBrowsable(EditorBrowsableState.Never)]
			void ICollection<TKey>.Clear () {
				throw new NotSupportedException(EditReadOnlyListMessage);
			}

			[EditorBrowsable(EditorBrowsableState.Never)]
			bool ICollection<TKey>.IsReadOnly {
				get {
					return true;
				}
			}

			[EditorBrowsable(EditorBrowsableState.Never)]
			bool ICollection<TKey>.Remove (TKey item) {
				throw new NotSupportedException(EditReadOnlyListMessage);
			}

			IEnumerator IEnumerable.GetEnumerator () {
				return GetEnumerator();
			}
		}

		/// <summary>
		/// Wraps the keys in an OrderDictionary.
		/// </summary>
		public sealed class ValueCollection : ICollection<TValue>
		{
			private readonly List<TValue> values;

			/// <summary>
			/// Initializes a new instance of a ValueCollection.
			/// </summary>
			/// <param name="values">The OrderedDictionary whose keys to wrap.</param>
			/// <exception cref="System.ArgumentNullException">The dictionary is null.</exception>
			internal ValueCollection (List<TValue> values) {
				this.values = values;
			}

			/// <summary>
			/// Copies the values from the OrderedDictionary to the given array, starting at the given index.
			/// </summary>
			/// <param name="array">The array to copy the values to.</param>
			/// <param name="arrayIndex">The index into the array to start copying the values.</param>
			/// <exception cref="System.ArgumentNullException">The array is null.</exception>
			/// <exception cref="System.ArgumentOutOfRangeException">The arrayIndex is negative.</exception>
			/// <exception cref="System.ArgumentException">The array, starting at the given index, is not large enough to contain all the values.</exception>
			public void CopyTo (TValue[] array, int arrayIndex) {
				values.CopyTo(array, arrayIndex);
			}

			/// <summary>
			/// Gets the number of values in the OrderedDictionary.
			/// </summary>
			public int Count {
				get {
					return values.Count;
				}
			}

			/// <summary>
			/// Gets an enumerator over the values in the OrderedDictionary.
			/// </summary>
			/// <returns>The enumerator.</returns>
			public IEnumerator<TValue> GetEnumerator () {
				return values.GetEnumerator();
			}

			[EditorBrowsable(EditorBrowsableState.Never)]
			bool ICollection<TValue>.Contains (TValue item) {
				return values.Contains(item);
			}

			[EditorBrowsable(EditorBrowsableState.Never)]
			void ICollection<TValue>.Add (TValue item) {
				throw new NotSupportedException(EditReadOnlyListMessage);
			}

			[EditorBrowsable(EditorBrowsableState.Never)]
			void ICollection<TValue>.Clear () {
				throw new NotSupportedException(EditReadOnlyListMessage);
			}

			[EditorBrowsable(EditorBrowsableState.Never)]
			bool ICollection<TValue>.IsReadOnly {
				get {
					return true;
				}
			}

			[EditorBrowsable(EditorBrowsableState.Never)]
			bool ICollection<TValue>.Remove (TValue item) {
				throw new NotSupportedException(EditReadOnlyListMessage);
			}

			IEnumerator IEnumerable.GetEnumerator () {
				return GetEnumerator();
			}
		}
	}

	internal class OrderedDictionaryDebugView<TKey, TValue>
	{
		private readonly OrderedDictionary<TKey, TValue> dictionary;

		public OrderedDictionaryDebugView (OrderedDictionary<TKey, TValue> dictionary) {
			this.dictionary = dictionary;
		}

		[DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
		public KeyValuePair<TKey, TValue>[] Items {
			get {
				return dictionary.ToArray();
			}
		}
	}

	/// <summary>
	/// Provides extensions methods for constructing instances of <see cref="OrderedDictionary{TKey, TValue}"/>.
	/// </summary>
	public static class CollectionExtensions
	{
		#region ToOrderedDictionary

		/// <summary>
		/// Creates a new OrderedDictionary from the given collection, using the key selector to extract the key.
		/// </summary>
		/// <typeparam name="TSource">The type of the items in the collection.</typeparam>
		/// <typeparam name="TKey">The type of the key.</typeparam>
		/// <param name="source">The items to created the OrderedDictionary from.</param>
		/// <param name="keySelector">A delegate that can extract a key from an item in the collection.</param>
		/// <returns>An OrderedDictionary mapping the extracted keys to their values.</returns>
		public static OrderedDictionary<TKey, TSource> ToOrderedDictionary<TSource, TKey> (this IEnumerable<TSource> source, Func<TSource, TKey> keySelector) {
			return ToOrderedDictionary(source, keySelector, null);
		}

		/// <summary>
		/// Creates a new OrderedDictionary from the given collection, using the key selector to extract the key.
		/// The key comparer is passed to the OrderedDictionary for comparing the extracted keys.
		/// </summary>
		/// <typeparam name="TSource">The type of the items in the collection.</typeparam>
		/// <typeparam name="TKey">The type of the key.</typeparam>
		/// <param name="source">The items to created the OrderedDictionary from.</param>
		/// <param name="keySelector">A delegate that can extract a key from an item in the collection.</param>
		/// <param name="comparer">The key equality comparer to use to compare keys in the dictionary.</param>
		/// <returns>An OrderedDictionary mapping the extracted keys to their values.</returns>
		public static OrderedDictionary<TKey, TSource> ToOrderedDictionary<TSource, TKey> (
			this IEnumerable<TSource> source,
			Func<TSource, TKey> keySelector,
			IEqualityComparer<TKey> comparer) {
			if (source == null) {
				throw new ArgumentNullException("source");
			}
			if (keySelector == null) {
				throw new ArgumentNullException("keySelector");
			}
			var dictionary = new OrderedDictionary<TKey, TSource>(comparer);
			foreach (TSource item in source) {
				TKey key = keySelector(item);
				dictionary.Add(key, item);
			}
			return dictionary;
		}

		#endregion
	}
}