EndlessHostRoles/Modules/Extensions/CollectionExtensions.cs

using System;
using System.Collections.Generic;
using System.Linq;
using Hazel;

// ReSharper disable ConvertIfStatementToReturnStatement
// ReSharper disable ForCanBeConvertedToForeach

namespace EHR;

public static class CollectionExtensions
{
    /// <summary>
    ///     Returns the key of a dictionary by its value
    /// </summary>
    /// <param name="dictionary">The <see cref="Dictionary{TKey,TValue}" /> to search</param>
    /// <param name="value">The <typeparamref name="TValue" /> used to search for the corresponding key</param>
    /// <typeparam name="TKey">The type of the keys in the <paramref name="dictionary" /></typeparam>
    /// <typeparam name="TValue">The type of the values in the <paramref name="dictionary" /></typeparam>
    /// <returns>
    ///     The key of the <paramref name="dictionary" /> that corresponds to the given <paramref name="value" />, or the
    ///     default value of <typeparamref name="TKey" /> if the <paramref name="value" /> is not found in the
    ///     <paramref name="dictionary" />
    /// </returns>
    public static TKey GetKeyByValue<TKey, TValue>(this Dictionary<TKey, TValue> dictionary, TValue value)
    {
        foreach (KeyValuePair<TKey, TValue> pair in dictionary)
        {
            if (pair.Value.Equals(value))
                return pair.Key;
        }

        return default(TKey);
    }

    /// <summary>
    ///     Sets the value for all existing keys in a dictionary to a specific value
    /// </summary>
    /// <param name="dictionary"></param>
    /// <param name="value"></param>
    /// <typeparam name="TKey"></typeparam>
    /// <typeparam name="TValue"></typeparam>
    public static void SetAllValues<TKey, TValue>(this Dictionary<TKey, TValue> dictionary, TValue value)
    {
        foreach (TKey key in dictionary.Keys.ToArray()) dictionary[key] = value;
    }

    /// <summary>
    ///     Adjusts the value for all existing keys in a dictionary
    /// </summary>
    /// <param name="dictionary">The dictionary to adjust the values of</param>
    /// <param name="adjust">The function to adjust the values with</param>
    /// <typeparam name="TKey"></typeparam>
    /// <typeparam name="TValue"></typeparam>
    public static void AdjustAllValues<TKey, TValue>(this Dictionary<TKey, TValue> dictionary, Func<TValue, TValue> adjust)
    {
        foreach (TKey key in dictionary.Keys.ToArray()) dictionary[key] = adjust(dictionary[key]);
    }

    /// <summary>
    ///     Returns a random element from a collection
    /// </summary>
    /// <param name="collection">The collection</param>
    /// <typeparam name="T">The type of the collection</typeparam>
    /// <returns>
    ///     A random element from the collection, or the default value of <typeparamref name="T" /> if the collection is
    ///     empty
    /// </returns>
    public static T RandomElement<T>(this IList<T> collection)
    {
        if (collection.Count == 0) return default(T);

        return collection[IRandom.Instance.Next(collection.Count)];
    }

    /// <summary>
    ///     Returns a random element from a collection
    /// </summary>
    /// <param name="collection">The collection</param>
    /// <typeparam name="T">The type of the collection</typeparam>
    /// <returns>
    ///     A random element from the collection, or the default value of <typeparamref name="T" /> if the collection is
    ///     empty
    /// </returns>
    public static T RandomElement<T>(this IEnumerable<T> collection)
    {
        if (collection is IList<T> list) return list.RandomElement();

        return collection.ToList().RandomElement();
    }

    /// <summary>
    ///     Combines multiple collections into a single collection
    /// </summary>
    /// <param name="firstCollection">The collection to start with</param>
    /// <param name="collections">The other collections to add to <paramref name="firstCollection" /></param>
    /// <typeparam name="T">The type of the elements in the collections to combine</typeparam>
    /// <returns>
    ///     A collection containing all elements of <paramref name="firstCollection" /> and all
    ///     <paramref name="collections" />
    /// </returns>
    public static IEnumerable<T> CombineWith<T>(this IEnumerable<T> firstCollection, params IEnumerable<T>[] collections)
    {
        return firstCollection.Concat(collections.Flatten());
    }

    /// <summary>
    ///     Executes an action for each element in a collection
    /// </summary>
    /// <param name="collection">The collection to iterate over</param>
    /// <param name="action">The action to execute for each element</param>
    /// <typeparam name="T">The type of the elements in the collection</typeparam>
    public static void Do<T>(this IEnumerable<T> collection, Action<T> action)
    {
        if (collection is List<T> list)
        {
            for (var i = 0; i < list.Count; i++) action(list[i]);

            return;
        }

        foreach (T element in collection) action(element);
    }

    /// <summary>
    ///     Executes an action for each element in a collection if the predicate is true
    /// </summary>
    /// <param name="collection">The collection to iterate over</param>
    /// <param name="fast">Whether to use a fast loop or linq</param>
    /// <param name="predicate">The predicate to check for each element</param>
    /// <param name="action">The action to execute for each element that satisfies the predicate</param>
    /// <typeparam name="T">The type of the elements in the collection</typeparam>
    public static void DoIf<T>(this IEnumerable<T> collection, Func<T, bool> predicate, Action<T> action, bool fast = true)
    {
        if (fast)
        {
            if (collection is List<T> list)
            {
                for (var i = 0; i < list.Count; i++)
                {
                    T element = list[i];
                    if (predicate(element)) action(element);
                }

                return;
            }

            foreach (T element in collection)
            {
                if (predicate(element))
                    action(element);
            }

            return;
        }

        collection.Where(predicate).ToArray().Do(action);
    }

    /// <summary>
    ///     Splits a collection into two collections based on a predicate
    /// </summary>
    /// <param name="collection">The collection to split</param>
    /// <param name="predicate">The predicate to split the collection by</param>
    /// <typeparam name="T">The type of the elements in the collection</typeparam>
    /// <returns>
    ///     A tuple containing two collections: one with elements that satisfy the predicate, and one with elements that
    ///     do not
    /// </returns>
    public static (List<T> TrueList, List<T> FalseList) Split<T>(this IEnumerable<T> collection, Func<T, bool> predicate)
    {
        var list1 = new List<T>();
        var list2 = new List<T>();

        foreach (T element in collection)
        {
            if (predicate(element))
                list1.Add(element);
            else
                list2.Add(element);
        }

        return (list1, list2);
    }

    /// <summary>
    ///     Adds a range of elements to a dictionary
    /// </summary>
    /// <param name="dictionary">The dictionary to add elements to</param>
    /// <param name="other">The dictionary containing the elements to add</param>
    /// <param name="overrideExistingKeys">
    ///     Whether to override existing keys in the <paramref name="dictionary" /> with the
    ///     same keys in the <paramref name="other" /> dictionary. If <c>true</c>, the same keys in the
    ///     <paramref name="dictionary" /> will be overwritten with the values from the <paramref name="other" /> dictionary.
    ///     If <c>false</c>, the same keys in the <paramref name="dictionary" /> will be kept and the values from the
    ///     <paramref name="other" /> dictionary will be ignored
    /// </param>
    /// <typeparam name="TKey">The type of the keys in the dictionaries</typeparam>
    /// <typeparam name="TValue">The type of the values in the dictionaries</typeparam>
    /// <returns>The <paramref name="dictionary" /> with the elements from the <paramref name="other" /> dictionary added</returns>
    public static Dictionary<TKey, TValue> AddRange<TKey, TValue>(this Dictionary<TKey, TValue> dictionary, Dictionary<TKey, TValue> other, bool overrideExistingKeys = true)
    {
        foreach ((TKey key, TValue value) in other)
        {
            if (overrideExistingKeys || !dictionary.ContainsKey(key))
                dictionary[key] = value;
        }

        return dictionary;
    }

    /// <summary>
    ///     Flattens a collection of collections into a single collection
    /// </summary>
    /// <param name="collection">The collection of collections to flatten</param>
    /// <typeparam name="T">The type of the elements in the collections</typeparam>
    /// <returns>A single collection containing all elements of the collections in <paramref name="collection" /></returns>
    public static IEnumerable<T> Flatten<T>(this IEnumerable<IEnumerable<T>> collection)
    {
        return collection.SelectMany(x => x);
    }

    /// <summary>
    ///     Determines whether a collection contains any elements that satisfy a predicate and returns the first element that
    ///     satisfies the predicate
    /// </summary>
    /// <param name="collection">The collection to search</param>
    /// <param name="predicate">The predicate to check for each element</param>
    /// <param name="element">
    ///     The first element that satisfies the predicate, or the default value of <typeparamref name="T" />
    ///     if no elements satisfy the predicate
    /// </param>
    /// <typeparam name="T">The type of the elements in the collection</typeparam>
    /// <returns><c>true</c> if the collection contains any elements that satisfy the predicate, <c>false</c> otherwise</returns>
    public static bool FindFirst<T>(this IEnumerable<T> collection, Func<T, bool> predicate, out T element)
    {
        if (collection is List<T> list)
        {
            for (var i = 0; i < list.Count; i++)
            {
                T item = list[i];

                if (predicate(item))
                {
                    element = item;
                    return true;
                }
            }

            element = default(T);
            return false;
        }

        foreach (T item in collection)
        {
            if (predicate(item))
            {
                element = item;
                return true;
            }
        }

        element = default(T);
        return false;
    }

    public static void NotifyPlayers(this IEnumerable<PlayerControl> players, string text, float time = 6f, bool overrideAll = false, bool log = true, bool setName = true)
    {
        var sender = CustomRpcSender.Create("NotifyPlayers", SendOption.Reliable);
        var hasValue = false;

        foreach (PlayerControl player in players)
        {
            sender.Notify(player, text, time, overrideAll, log, setName);
            hasValue = true;

            if (sender.stream.Length > 800)
            {
                sender.SendMessage();
                sender = CustomRpcSender.Create("NotifyPlayers", SendOption.Reliable);
                hasValue = false;
            }
        }

        sender.SendMessage(dispose: !hasValue);
    }

    #region ToValidPlayers

    /// <summary>
    ///     Converts a collection of player IDs to a collection of <see cref="PlayerControl" /> instances
    /// </summary>
    /// <param name="playerIds"></param>
    /// <returns></returns>
    public static IEnumerable<PlayerControl> ToValidPlayers(this IEnumerable<byte> playerIds)
    {
        return playerIds.Select(Utils.GetPlayer).Where(x => x != null);
    }

    /// <summary>
    ///     Converts a list of player IDs to a list of <see cref="PlayerControl" /> instances
    /// </summary>
    /// <param name="playerIds"></param>
    /// <returns></returns>
    public static List<PlayerControl> ToValidPlayers(this List<byte> playerIds)
    {
        return playerIds.ConvertAll(Utils.GetPlayer).FindAll(x => x != null);
    }

    #endregion

    #region Without

    /// <summary>
    ///     Removes an element from a collection
    /// </summary>
    /// <param name="collection">The collection to remove the element from</param>
    /// <param name="element">The element to remove</param>
    /// <typeparam name="T">The type of the elements in the collection</typeparam>
    /// <returns>
    ///     A collection containing all elements of <paramref name="collection" /> except for <paramref name="element" />
    /// </returns>
    public static IEnumerable<T> Without<T>(this IEnumerable<T> collection, T element)
    {
        return collection.Where(x => !x.Equals(element));
    }

    /// <summary>
    ///     Removes an element from a collection
    /// </summary>
    /// <param name="collection">The collection to remove the element from</param>
    /// <param name="element">The element to remove</param>
    /// <returns>
    ///     A collection containing all elements of <paramref name="collection" /> except for <paramref name="element" />
    /// </returns>
    public static IEnumerable<PlayerControl> Without(this IEnumerable<PlayerControl> collection, PlayerControl element)
    {
        return collection.Where(x => x.PlayerId != element.PlayerId);
    }

    /// <summary>
    ///     Removes an element from a collection
    /// </summary>
    /// <param name="collection">The collection to remove the element from</param>
    /// <param name="element">The element to remove</param>
    /// <returns>
    ///     A collection containing all elements of <paramref name="collection" /> except for <paramref name="element" />
    /// </returns>
    public static IEnumerable<PlainShipRoom> Without(this IEnumerable<PlainShipRoom> collection, PlainShipRoom element)
    {
        return collection.Where(x => x != element);
    }

    #endregion

    #region Shuffle

    /// <summary>
    ///     Shuffles all elements in a collection randomly
    /// </summary>
    /// <typeparam name="T">The type of the collection</typeparam>
    /// <param name="collection">The collection to be shuffled</param>
    /// <returns>A new, shuffled collection as a <see cref="List{T}" /></returns>
    public static List<T> Shuffle<T>(this IEnumerable<T> collection)
    {
        List<T> list = collection.ToList();
        int n = list.Count;
        var r = IRandom.Instance;

        while (n > 1)
        {
            n--;
            int k = r.Next(n + 1);
            (list[n], list[k]) = (list[k], list[n]);
        }

        return list;
    }

    /// <summary>
    ///     Shuffles all elements in a collection randomly
    /// </summary>
    /// <param name="collection">The collection to be shuffled</param>
    /// <typeparam name="T">The type of the collection</typeparam>
    /// <returns>The same collection with its elements shuffled</returns>
    public static List<T> Shuffle<T>(this List<T> collection)
    {
        int n = collection.Count;
        var r = IRandom.Instance;

        while (n > 1)
        {
            n--;
            int k = r.Next(n + 1);
            (collection[n], collection[k]) = (collection[k], collection[n]);
        }

        return collection;
    }

    /// <summary>
    ///     Shuffles all elements in an array randomly
    /// </summary>
    /// <param name="collection">The array to be shuffled</param>
    /// <typeparam name="T">The type of the array</typeparam>
    /// <returns>The same array with its elements shuffled</returns>
    public static T[] Shuffle<T>(this T[] collection)
    {
        int n = collection.Length;
        var r = IRandom.Instance;

        while (n > 1)
        {
            n--;
            int k = r.Next(n + 1);
            (collection[n], collection[k]) = (collection[k], collection[n]);
        }

        return collection;
    }

    #endregion

    #region Partition

    /// <summary>
    ///     Partitions a collection into a specified number of parts
    /// </summary>
    /// <param name="collection">The collection to partition</param>
    /// <param name="parts">The number of parts to partition the collection into</param>
    /// <typeparam name="T">The type of the elements in the collection</typeparam>
    /// <returns>A collection of collections, each containing a part of the original collection</returns>
    public static IEnumerable<IEnumerable<T>> Partition<T>(this IEnumerable<T> collection, int parts)
    {
        List<T> list = collection.ToList();
        int length = list.Count;
        if (parts <= 0 || length == 0) yield break;

        if (parts > length) parts = length;

        int size = length / parts;
        int remainder = length % parts;
        var index = 0;

        for (var i = 0; i < parts; i++)
        {
            int partSize = size + (i < remainder ? 1 : 0);
            yield return list.Skip(index).Take(partSize);
            index += partSize;
        }
    }

    /// <summary>
    ///     Partitions a list into a specified number of parts
    /// </summary>
    /// <param name="collection">The list to partition</param>
    /// <param name="parts">The number of parts to partition the list into</param>
    /// <typeparam name="T">The type of the elements in the list</typeparam>
    /// <returns>A list of lists, each containing a part of the original list</returns>
    public static IEnumerable<IEnumerable<T>> Partition<T>(this IList<T> collection, int parts)
    {
        int length = collection.Count;
        if (parts <= 0 || length == 0) yield break;

        if (parts > length) parts = length;

        int size = length / parts;
        int remainder = length % parts;
        var index = 0;

        for (var i = 0; i < parts; i++)
        {
            int partSize = size + (i < remainder ? 1 : 0);
            yield return collection.Skip(index).Take(partSize);
            index += partSize;
        }
    }

    #endregion
}

public static class Loop
{
    public static void Times(int count, Action<int> action)
    {
        for (var i = 0; i < count; i++) action(i);
    }
}