ladybird/Userland/Libraries/LibWeb/HTML/ListOfAvailableImages.h

/*
 * Copyright (c) 2023, Andreas Kling <kling@serenityos.org>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 */

#pragma once

#include <AK/HashMap.h>
#include <AK/URL.h>
#include <LibJS/Heap/Cell.h>
#include <LibWeb/Forward.h>
#include <LibWeb/HTML/CORSSettingAttribute.h>
#include <LibWeb/HTML/Origin.h>

namespace Web::HTML {

// https://html.spec.whatwg.org/multipage/images.html#list-of-available-images
class ListOfAvailableImages : public JS::Cell {
    JS_CELL(ListOfAvailableImages, Cell);
    JS_DECLARE_ALLOCATOR(ListOfAvailableImages);

public:
    struct Key {
        URL url;
        HTML::CORSSettingAttribute mode;
        Optional<HTML::Origin> origin;

        [[nodiscard]] bool operator==(Key const& other) const;
        [[nodiscard]] u32 hash() const;

    private:
        mutable Optional<u32> cached_hash;
    };

    struct Entry {
        Entry(JS::NonnullGCPtr<DecodedImageData> image_data, bool ignore_higher_layer_caching)
            : image_data(move(image_data))
            , ignore_higher_layer_caching(ignore_higher_layer_caching)
        {
        }

        JS::NonnullGCPtr<DecodedImageData> image_data;
        bool ignore_higher_layer_caching { false };
    };

    ListOfAvailableImages();
    ~ListOfAvailableImages();

    void add(Key const&, JS::NonnullGCPtr<DecodedImageData>, bool ignore_higher_layer_caching);
    void remove(Key const&);
    [[nodiscard]] Entry* get(Key const&);

    void visit_edges(JS::Cell::Visitor& visitor) override;

private:
    HashMap<Key, NonnullOwnPtr<Entry>> m_images;
};

}

namespace AK {

template<>
struct Traits<Web::HTML::ListOfAvailableImages::Key> : public DefaultTraits<Web::HTML::ListOfAvailableImages::Key> {
    static unsigned hash(Web::HTML::ListOfAvailableImages::Key const& key)
    {
        return key.hash();
    }
    static bool equals(Web::HTML::ListOfAvailableImages::Key const& a, Web::HTML::ListOfAvailableImages::Key const& b)
    {
        return a == b;
    }
};

}