psalm/src/Psalm/Internal/Provider/StatementsVolatileCache.php

<?php

namespace Psalm\Internal\Provider;

use InvalidArgumentException;
use PhpParser\Node\Stmt;

use function array_key_exists;
use function array_search;
use function array_splice;
use function count;
use function is_null;
use function key;
use function reset;

/**
 * @internal Owned by StatementsProvider
 * @todo: track variables size instead
 */
final class StatementsVolatileCache
{
    /**
     * @var array<string, list<Stmt>>
     */
    protected array $cache = [];

    /**
     * @var array<int, string>
     */
    protected array $access = [];

    protected int $max_size;

    protected static ?StatementsVolatileCache $instance = null;

    public function __construct(int $max_size = 4096)
    {
        $this->max_size = $max_size;
    }

    public static function getInstance(): StatementsVolatileCache
    {
        if (is_null(self::$instance)) {
            self::$instance = new self();
        }

        return self::$instance;
    }

    public function has(string $key): bool
    {
        return array_key_exists($key, $this->cache);
    }

    /**
     * @return list<Stmt>
     * @throws InvalidArgumentException
     */
    public function get(string $key): array
    {
        if (! $this->has($key)) {
            throw new InvalidArgumentException('Given $key does not exists');
        }

        $access_index = array_search($key, $this->access);
        if (false !== $access_index) {
            array_splice($this->access, $access_index, 1);
        }
        $this->access[] = $key;

        return $this->cache[$key];
    }

    /**
     * @param list<Stmt> $content
     */
    public function set(string $key, array $content): void
    {
        if (count($this->cache) > $this->max_size) {
            reset($this->access);

            $oldest_key_index = key($this->access);

            if (! is_null($oldest_key_index)) {
                $oldest_key = $this->access[$oldest_key_index];
                unset($this->cache[$oldest_key]);
                unset($this->access[$oldest_key_index]);
            }
        }

        $this->cache[$key] = $content;
        $this->access[] = $key;
    }

    public function clearCache(): void
    {
        $this->cache = [];
        $this->access = [];
    }
}