ladybird/Libraries/LibWeb/DOM/DOMTokenList.h

/*
 * Copyright (c) 2021, Tim Flynn <trflynn89@serenityos.org>
 * Copyright (c) 2022, Andreas Kling <andreas@ladybird.org>
 * Copyright (c) 2023, Luke Wilde <lukew@serenityos.org>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 */

#pragma once

#include <AK/FlyString.h>
#include <AK/Optional.h>
#include <AK/String.h>
#include <AK/StringView.h>
#include <AK/Vector.h>
#include <LibWeb/Bindings/PlatformObject.h>
#include <LibWeb/Forward.h>
#include <LibWeb/WebIDL/ExceptionOr.h>

namespace Web::DOM {

// https://dom.spec.whatwg.org/#domtokenlist
class DOMTokenList final : public Bindings::PlatformObject {
    WEB_PLATFORM_OBJECT(DOMTokenList, Bindings::PlatformObject);
    GC_DECLARE_ALLOCATOR(DOMTokenList);

public:
    [[nodiscard]] static GC::Ref<DOMTokenList> create(Element& associated_element, FlyString associated_attribute);
    ~DOMTokenList() = default;

    void associated_attribute_changed(StringView value);

    virtual Optional<JS::Value> item_value(size_t index) const override;

    size_t length() const { return m_token_set.size(); }
    Optional<String> item(size_t index) const;
    bool contains(String const& token);
    WebIDL::ExceptionOr<void> add(Vector<String> const& tokens);
    WebIDL::ExceptionOr<void> remove(Vector<String> const& tokens);
    WebIDL::ExceptionOr<bool> toggle(String const& token, Optional<bool> force);
    WebIDL::ExceptionOr<bool> replace(String const& token, String const& new_token);
    WebIDL::ExceptionOr<bool> supports(StringView token);
    String value() const;
    void set_value(String const& value);

private:
    DOMTokenList(Element& associated_element, FlyString associated_attribute);

    virtual void initialize(JS::Realm&) override;
    virtual void visit_edges(Cell::Visitor&) override;

    WebIDL::ExceptionOr<void> validate_token(StringView token) const;
    WebIDL::ExceptionOr<void> validate_token_not_empty(StringView token) const;
    WebIDL::ExceptionOr<void> validate_token_not_whitespace(StringView token) const;
    void run_update_steps();

    String serialize_ordered_set() const;

    GC::Ref<Element> m_associated_element;
    FlyString m_associated_attribute;
    Vector<String> m_token_set;
};

}

struct SupportedTokenKey {
    FlyString element_name;
    FlyString attribute_name;

    constexpr bool operator==(SupportedTokenKey const& other) const = default;
};

namespace AK {

template<>
struct Traits<SupportedTokenKey> : public DefaultTraits<SupportedTokenKey> {
    static unsigned hash(SupportedTokenKey const& key)
    {
        return pair_int_hash(key.element_name.hash(), key.attribute_name.hash());
    }
};

}