<?php

declare(strict_types=1);

namespace Psl\Collection;

use Closure;
use Psl\Dict;
use Psl\Iter;
use Psl\Vec;

use function array_key_exists;
use function array_key_first;
use function array_key_last;
use function count;

/**
 * @template T of array-key
 *
 * @implements MutableSetInterface<T>
 */
final class MutableSet implements MutableSetInterface
{
    /**
     * @var array<T, T>
     */
    private array $elements = [];

    /**
     * Creates a new `MutableSet` containing the values of the given array.
     *
     * @param array<array-key, T> $elements
     *
     * @psalm-mutation-free
     */
    public function __construct(array $elements)
    {
        $set = [];
        foreach ($elements as $element) {
            $set[$element] = $element;
        }

        $this->elements = $set;
    }

    /**
     * Creates and returns a default instance of {@see MutableSet}.
     *
     * @return static A default instance of {@see MutableSet}.
     *
     * @psalm-external-mutation-free
     */
    public static function default(): static
    {
        return new self([]);
    }

    /**
     * Create a set from the given array, using the values of the array as the set values.
     *
     * @template Ts of array-key
     *
     * @param array<array-key, Ts> $elements
     *
     * @return MutableSet<Ts>
     *
     * @pure
     */
    public static function fromArray(array $elements): MutableSet
    {
        return new self($elements);
    }

    /**
     * Create a set from the given iterable, using the values of the iterable as the set values.
     *
     * @template Ts of array-key
     *
     * @param iterable<Ts, Ts> $items
     *
     * @return MutableSet<Ts>
     */
    public static function fromItems(iterable $items): MutableSet
    {
        /**
         * @psalm-suppress InvalidArgument
         *
         * @var array<Ts, Ts>
         */
        $array = iterator_to_array($items);
        return self::fromArray($array);
    }

    /**
     * Create a set from the given $elements array, using the keys of the array as the set values.
     *
     * @template Ts of array-key
     *
     * @param array<Ts, mixed> $elements
     *
     * @return MutableSet<Ts>
     *
     * @pure
     */
    public static function fromArrayKeys(array $elements): MutableSet
    {
        /** @var array<Ts, Ts> $set */
        $set = [];
        foreach ($elements as $element => $_) {
            $set[$element] = $element;
        }

        return new self($set);
    }

    /**
     * Returns the first value in the current `MutableSet`.
     *
     * @return T|null The first value in the current `MutableSet`, or `null` if the
     *                current `MutableSet` is empty.
     *
     * @psalm-mutation-free
     */
    public function first(): null|int|string
    {
        return array_key_first($this->elements);
    }

    /**
     * Returns the last value in the current `MutableSet`.
     *
     * @return T|null The last value in the current `MutableSet`, or `null` if the
     *                current `MutableSet` is empty.
     *
     * @psalm-mutation-free
     */
    public function last(): null|int|string
    {
        return array_key_last($this->elements);
    }

    /**
     * Retrieve an external iterator.
     *
     * @return Iter\Iterator<T, T>
     */
    public function getIterator(): Iter\Iterator
    {
        return Iter\Iterator::create($this->elements);
    }

    /**
     * Is the set empty?
     *
     * @psalm-mutation-free
     */
    public function isEmpty(): bool
    {
        return [] === $this->elements;
    }

    /**
     * Get the number of elements in the current `MutableSet`.
     *
     * @psalm-mutation-free
     *
     * @return int<0, max>
     */
    public function count(): int
    {
        /** @var int<0, max> */
        return count($this->elements);
    }

    /**
     * Get an array copy of the current `MutableSet`.
     *
     * @return array<T, T>
     *
     * @psalm-mutation-free
     */
    public function toArray(): array
    {
        return $this->elements;
    }

    /**
     * Get an array copy of the current `MutableSet`.
     *
     * @return array<T, T>
     *
     * @psalm-mutation-free
     */
    public function jsonSerialize(): array
    {
        return $this->elements;
    }

    /**
     * Returns the provided value if it exists in the current `MutableSet`.
     *
     * As {@see MutableSet} does not have keys, this method checks if the value exists in the set.
     * If the value exists, it is returned to indicate presence in the set. If the value does not exist,
     * an {@see Exception\OutOfBoundsException} is thrown to indicate the absence of the value.
     *
     * @param T $k
     *
     * @throws Exception\OutOfBoundsException If $k is out-of-bounds.
     *
     * @return T
     *
     * @psalm-mutation-free
     */
    public function at(int|string $k): int|string
    {
        if (!array_key_exists($k, $this->elements)) {
            throw Exception\OutOfBoundsException::for($k);
        }

        // the key exists, and we know it's the same as the value.
        return $k;
    }

    /**
     * Determines if the specified value is in the current set.
     *
     * As {@see MutableSet} does not have keys, this method checks if the value exists in the set.
     * If the value exists, it returns true to indicate presence in the set. If the value does not exist,
     * it returns false to indicate the absence of the value.
     *
     * @param T $k
     *
     * @return bool True if the value is in the set, false otherwise.
     *
     * @psalm-mutation-free
     */
    public function contains(int|string $k): bool
    {
        return array_key_exists($k, $this->elements);
    }

    /**
     * Alias of `contains`.
     *
     * @param T $k
     *
     * @return bool True if the value is in the set, false otherwise.
     *
     * @psalm-mutation-free
     */
    public function containsKey(int|string $k): bool
    {
        return $this->contains($k);
    }

    /**
     * Returns the provided value if it is part of the set, or null if it is not.
     *
     * As {@see MutableSet} does not have keys, this method checks if the value exists in the set.
     * If the value exists, it is returned to indicate presence in the set. If the value does not exist,
     * null is returned to indicate the absence of the value.
     *
     * @param T $k
     *
     * @return T|null
     *
     * @psalm-mutation-free
     */
    public function get(int|string $k): null|int|string
    {
        return $this->elements[$k] ?? null;
    }

    /**
     * Returns the first key in the current `MutableSet`.
     *
     * As {@see MutableSet} does not have keys, this method acts as an alias for {@see MutableSet::first()}.
     *
     * @return T|null The first value in the current `MutableSet`, or `null` if the
     *                current `MutableSet` is empty.
     *
     * @psalm-mutation-free
     */
    public function firstKey(): null|int|string
    {
        return $this->first();
    }

    /**
     * Returns the last key in the current `MutableSet`.
     *
     * As {@see MutableSet} does not have keys, this method acts as an alias for {@see MutableSet::last()}.
     *
     * @return T|null The last value in the current `MutableSet`, or `null` if the
     *                current `MutableSet` is empty.
     *
     * @psalm-mutation-free
     */
    public function lastKey(): null|int|string
    {
        return $this->last();
    }

    /**
     * Returns the key of the first element that matches the search value.
     *
     * If no element matches the search value, this function returns null.
     *
     * As {@see MutableSet} does not have keys, this method returns the value itself.
     *
     * @param T $search_value The value that will be search for in the current
     *                        `MutableSet`.
     *
     * @return T|null The value if its found, null otherwise.
     *
     * @psalm-mutation-free
     */
    public function linearSearch(mixed $search_value): null|int|string
    {
        foreach ($this->elements as $element) {
            if ($search_value === $element) {
                return $element;
            }
        }

        return null;
    }

    /**
     * Removes the specified value from the current set.
     *
     * If the value is not in the current set, the current set is unchanged.
     *
     * @param T $k The value to remove.
     *
     * @return MutableSet<T> Returns itself.
     */
    public function remove(int|string $k): MutableSet
    {
        unset($this->elements[$k]);

        return $this;
    }

    /**
     * Removes all elements from the set.
     *
     * @return MutableSet<T> Returns itself
     *
     * @psalm-external-mutation-free
     */
    public function clear(): MutableSet
    {
        $this->elements = [];

        return $this;
    }

    /**
     * Add a value to the set and return the set itself.
     *
     * @param T $v The value to add.
     *
     * @return MutableSet<T> Returns itself.
     *
     * @psalm-external-mutation-free
     */
    public function add(mixed $v): MutableSet
    {
        $this->elements[$v] = $v;

        return $this;
    }

    /**
     * For every element in the provided elements iterable, add the value into the current set.
     *
     * @param iterable<T> $elements The elements with the new values to add
     *
     * @return MutableSet<T> returns itself.
     *
     * @psalm-external-mutation-free
     */
    public function addAll(iterable $elements): MutableSet
    {
        foreach ($elements as $item) {
            $this->add($item);
        }

        return $this;
    }

    /**
     * Returns a `MutableVector` containing the values of the current `MutableSet`.
     *
     * @return MutableVector<T>
     *
     * @psalm-mutation-free
     */
    public function values(): MutableVector
    {
        return MutableVector::fromArray($this->elements);
    }

    /**
     * As {@see MutableSet} does not have keys, this method acts as an alias for {@see MutableSet::values()}.
     *
     * @return MutableVector<T>
     *
     * @psalm-mutation-free
     */
    public function keys(): MutableVector
    {
        return MutableVector::fromArray($this->elements);
    }

    /**
     * Returns a `MutableSet` containing the values of the current `MutableSet`
     * that meet a supplied condition.
     *
     * Only values that meet a certain criteria are affected by a call to
     * `filter()`, while all values are affected by a call to `map()`.
     *
     * The keys associated with the current `MutableSet` remain unchanged in the
     * returned `MutableSet`.
     *
     * @param (Closure(T): bool) $fn The callback containing the condition to apply to the current
     *                               `MutableSet` values.
     *
     * @return MutableSet<T> A `MutableSet` containing the values after a user-specified condition
     *                       is applied.
     */
    public function filter(Closure $fn): MutableSet
    {
        return new MutableSet(Dict\filter_keys($this->elements, $fn));
    }

    /**
     * Applies a user-defined condition to each value in the `MutableSet`,
     *  considering the value as both key and value.
     *
     * This method extends {@see MutableSet::filter()} by providing the value twice to the
     *  callback function: once as the "key" and once as the "value", even though {@see MutableSet} do not have traditional key-value pairs.
     *
     * This allows for filtering based on both the value's "key" and "value" representation, which are identical.
     * It's particularly useful when the distinction between keys and values is relevant for the condition.
     *
     * @param (Closure(T, T): bool) $fn T
     *
     * @return MutableSet<T>
     */
    public function filterWithKey(Closure $fn): MutableSet
    {
        return $this->filter(static fn($k) => $fn($k, $k));
    }

    /**
     * Returns a `MutableSet` after an operation has been applied to each value
     * in the current `MutableSet`.
     *
     * Every value in the current Map is affected by a call to `map()`, unlike
     * `filter()` where only values that meet a certain criteria are affected.
     *
     * The keys will remain unchanged from the current `MutableSet` to the
     * returned `MutableSet`.
     *
     * @template Tu of array-key
     *
     * @param (Closure(T): Tu) $fn The callback containing the operation to apply to the current
     *                             `MutableSet` values.
     *
     * @return MutableSet<Tu> A `MutableSet` containing the values after a user-specified
     *                        operation is applied.
     */
    public function map(Closure $fn): MutableSet
    {
        return new MutableSet(Dict\map($this->elements, $fn));
    }

    /**
     * Transform the values of the current `MutableSet` by applying the provided callback,
     *  considering the value as both key and value.
     *
     * Similar to {@see MutableSet::map()}, this method extends the functionality by providing the value twice to the
     *  callback function: once as the "key" and once as the "value",
     *
     * The allows for transformations that take into account the value's dual role. It's useful for operations where the distinction
     *  between keys and values is relevant.
     *
     * @template Tu of array-key
     *
     * @param (Closure(T, T): Tu) $fn
     *
     * @return MutableSet<Tu>
     */
    public function mapWithKey(Closure $fn): MutableSet
    {
        return $this->map(static fn($k) => $fn($k, $k));
    }

    /**
     * Always throws an exception since `MutableSet` can only contain array-key values.
     *
     * @template Tu
     *
     * @param array<array-key, Tu> $elements The elements to use to combine with the elements of this `MutableSet`.
     *
     * @psalm-mutation-free
     *
     * @throws Exception\RuntimeException Always throws an exception since `MutableSet` can only contain array-key values.
     */
    public function zip(array $elements): never
    {
        throw new Exception\RuntimeException('Cannot zip a MutableSet.');
    }

    /**
     * Returns a `MutableSet` containing the first `n` values of the current
     * `MutableSet`.
     *
     * The returned `MutableSet` will always be a proper subset of the current
     * `MutableSet`.
     *
     * `$n` is 1-based. So the first element is 1, the second 2, etc.
     *
     * @param int<0, max> $n The last element that will be included in the returned
     *                       `MutableSet`.
     *
     * @return MutableSet<T> A `MutableSet` that is a proper subset of the current
     *                       `MutableSet` up to `n` elements.
     *
     * @psalm-mutation-free
     */
    public function take(int $n): MutableSet
    {
        return $this->slice(0, $n);
    }

    /**
     * Returns a `MutableSet` containing the values of the current `MutableSet`
     * up to but not including the first value that produces `false` when passed
     * to the specified callback.
     *
     * The returned `MutableSet` will always be a proper subset of the current
     * `MutableSet`.
     *
     * @param (Closure(T): bool) $fn The callback that is used to determine the stopping
     *                               condition.
     *
     * @return MutableSet<T> A `MutableSet` that is a proper subset of the current
     *                       `MutableSet` up until the callback returns `false`.
     */
    public function takeWhile(Closure $fn): MutableSet
    {
        return new MutableSet(Dict\take_while($this->elements, $fn));
    }

    /**
     * Returns a `MutableSet` containing the values after the `n`-th element of
     * the current `MutableSet`.
     *
     * The returned `MutableSet` will always be a proper subset of the current
     * `setInterface`.
     *
     * `$n` is 1-based. So the first element is 1, the second 2, etc.
     *
     * @param int<0, max> $n The last element to be skipped; the $n+1 element will be the
     *                       first one in the returned `MutableSet`.
     *
     * @return MutableSet<T> A `MutableSet` that is a proper subset of the current
     *                       `MutableSet` containing values after the specified `n`-th element.
     *
     * @psalm-mutation-free
     */
    public function drop(int $n): MutableSet
    {
        return $this->slice($n);
    }

    /**
     * Returns a `MutableSet` containing the values of the current `MutableSet`
     * starting after and including the first value that produces `true` when
     * passed to the specified callback.
     *
     * The returned `MutableSet` will always be a proper subset of the current
     * `MutableSet`.
     *
     * @param (Closure(T): bool) $fn The callback used to determine the starting element for the
     *                               returned `MutableSet`.
     *
     * @return MutableSet<T> A `MutableSet` that is a proper subset of the current
     *                       `MutableSet` starting after the callback returns `true`.
     */
    public function dropWhile(Closure $fn): MutableSet
    {
        return new MutableSet(Dict\drop_while($this->elements, $fn));
    }

    /**
     * Returns a subset of the current `MutableSet` starting from a given index up
     * to, but not including, the element at the provided length from the starting
     * index.
     *
     * `$start` is 0-based. $len is 1-based. So `slice(0, 2)` would return the
     * elements at index 0 and 1.
     *
     * The returned `MutableSet` will always be a proper subset of this
     * `MutableSet`.
     *
     * @param int<0, max> $start The starting index of this set to begin the returned
     *                           `MutableSet`.
     * @param int<0, max> $length The length of the returned `MutableSet`.
     *
     * @return MutableSet<T> A `MutableSet` that is a proper subset of the current
     *                       `MutableSet` starting at `$start` up to but not including
     *                       the element `$start + $length`.
     *
     * @psalm-mutation-free
     */
    public function slice(int $start, null|int $length = null): MutableSet
    {
        /** @psalm-suppress ImpureFunctionCall - conditionally pure */
        return MutableSet::fromArray(Dict\slice($this->elements, $start, $length));
    }

    /**
     * Returns a `MutableVector` containing the original `MutableSet` split into
     * chunks of the given size.
     *
     * If the original `MutableSet` doesn't divide evenly, the final chunk will be
     * smaller.
     *
     * @param positive-int $size The size of each chunk.
     *
     * @return MutableVector<MutableSet<T>> A `MutableVector` containing the original
     *                                      `MutableSet` split into chunks of the given size.
     *
     * @psalm-mutation-free
     */
    public function chunk(int $size): MutableVector
    {
        /**
         * @psalm-suppress MissingThrowsDocblock
         * @psalm-suppress ImpureFunctionCall
         */
        return MutableVector::fromArray(Vec\map(
            /**
             * @psalm-suppress MissingThrowsDocblock
             * @psalm-suppress ImpureFunctionCall
             */
            Vec\chunk($this->toArray(), $size),
            /**
             * @param list<T> $chunk
             *
             * @return MutableSet<T>
             */
            static fn(array $chunk) => MutableSet::fromArray($chunk),
        ));
    }

    /**
     * Determines if the specified offset exists in the current set.
     *
     * @param mixed $offset An offset to check for.
     *
     * @throws Exception\InvalidOffsetException If the offset type is not valid.
     *
     * @return bool Returns true if the specified offset exists, false otherwise.
     *
     * @psalm-mutation-free
     *
     * @psalm-assert array-key $offset
     */
    public function offsetExists(mixed $offset): bool
    {
        if (!is_int($offset) && !is_string($offset)) {
            throw new Exception\InvalidOffsetException(
                'Invalid set read offset type, expected a string or an integer.',
            );
        }

        /** @var T $offset - technically, we don't know if the offset is of type T, but we can assume it is, as this causes no "harm". */
        return $this->contains($offset);
    }

    /**
     * Returns the value at the specified offset.
     *
     * @param mixed $offset The offset to retrieve.
     *
     * @throws Exception\InvalidOffsetException If the offset type is not array-key.
     * @throws Exception\OutOfBoundsException If the offset does not exist.
     *
     * @return T The value at the specified offset.
     *
     * @psalm-mutation-free
     *
     * @psalm-assert array-key $offset
     */
    public function offsetGet(mixed $offset): mixed
    {
        if (!is_int($offset) && !is_string($offset)) {
            throw new Exception\InvalidOffsetException(
                'Invalid set read offset type, expected a string or an integer.',
            );
        }

        /** @var T $offset - technically, we don't know if the offset is of type T, but we can assume it is, as this causes no "harm". */
        return $this->at($offset);
    }

    /**
     * Sets the value at the specified offset.
     *
     * @param mixed $offset The offset to assign the value to.
     * @param T $value The value to set.
     *
     * @psalm-external-mutation-free
     *
     * @psalm-assert null|array-key $offset
     *
     * @throws Exception\InvalidOffsetException If the offset is not null or the value is not the same as the offset.
     */
    public function offsetSet(mixed $offset, mixed $value): void
    {
        if (null === $offset || $offset === $value) {
            $this->add($value);

            return;
        }

        throw new Exception\InvalidOffsetException(
            'Invalid set write offset type, expected null or the same as the value.',
        );
    }

    /**
     * Unsets the value at the specified offset.
     *
     * @param mixed $offset The offset to unset.
     *
     * @psalm-external-mutation-free
     *
     * @psalm-assert array-key $offset
     *
     * @throws Exception\InvalidOffsetException If the offset type is not valid.
     */
    public function offsetUnset(mixed $offset): void
    {
        if (!is_int($offset) && !is_string($offset)) {
            throw new Exception\InvalidOffsetException(
                'Invalid set read offset type, expected a string or an integer.',
            );
        }

        /** @var T $offset - technically, we don't know if the offset is of type T, but we can assume it is, as this causes no "harm". */
        $this->remove($offset);
    }
}