1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-06-20 09:32:08 +00:00
serenity/Userland/Libraries/LibJS/Runtime/Map.h
davidot 45646eee43 LibJS: Fix Map Iterators when elements are deleted during iteration
Before this would assume that the element found in operator++ was still
valid when dereferencing it in operator*.
Since any code can have been run since that increment this is not always
valid.
To further simplify the logic of the iterator we no longer store the
index in an optional.
2022-02-10 14:09:39 +00:00

115 lines
2.9 KiB
C++

/*
* Copyright (c) 2021, Idan Horowitz <idan.horowitz@serenityos.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
#include <AK/Concepts.h>
#include <AK/HashMap.h>
#include <AK/RedBlackTree.h>
#include <LibJS/Runtime/GlobalObject.h>
#include <LibJS/Runtime/Object.h>
#include <LibJS/Runtime/Value.h>
namespace JS {
class Map : public Object {
JS_OBJECT(Map, Object);
public:
static Map* create(GlobalObject&);
explicit Map(Object& prototype);
virtual ~Map() override;
void map_clear();
bool map_remove(Value const&);
Optional<Value> map_get(Value const&) const;
bool map_has(Value const&) const;
void map_set(Value const&, Value);
size_t map_size() const;
struct EndIterator {
};
template<bool IsConst>
struct IteratorImpl {
bool is_end() const
{
return m_map.m_keys.begin_from(m_index).is_end()
&& m_map.m_keys.find_smallest_not_below_iterator(m_index).is_end();
}
IteratorImpl& operator++()
{
++m_index;
return *this;
}
decltype(auto) operator*()
{
ensure_next_element();
return *m_map.m_entries.find(*m_map.m_keys.begin_from(m_index));
}
decltype(auto) operator*() const
{
ensure_next_element();
return *m_map.m_entries.find(*m_map.m_keys.begin_from(m_index));
}
bool operator==(IteratorImpl const& other) const { return m_index == other.m_index && &m_map == &other.m_map; }
bool operator==(EndIterator const&) const { return is_end(); }
private:
friend class Map;
IteratorImpl(Map const& map) requires(IsConst)
: m_map(map)
{
ensure_index();
}
IteratorImpl(Map& map) requires(!IsConst)
: m_map(map)
{
ensure_index();
}
void ensure_index() const
{
if (m_map.m_keys.is_empty())
m_index = m_map.m_next_insertion_id;
else
m_index = m_map.m_keys.begin().key();
}
void ensure_next_element() const
{
if (auto it = m_map.m_keys.find_smallest_not_below_iterator(m_index); it.is_end())
m_index = m_map.m_next_insertion_id;
else
m_index = it.key();
}
Conditional<IsConst, Map const&, Map&> m_map;
mutable size_t m_index { 0 };
};
using Iterator = IteratorImpl<false>;
using ConstIterator = IteratorImpl<true>;
ConstIterator begin() const { return { *this }; }
Iterator begin() { return { *this }; }
EndIterator end() const { return {}; }
private:
virtual void visit_edges(Visitor& visitor) override;
size_t m_next_insertion_id { 0 };
RedBlackTree<size_t, Value> m_keys;
HashMap<Value, Value, ValueTraits> m_entries;
};
}