ladybird/AK/Find.h
Timothy Flynn 7f37a8f60f AK: Add an AK::find helper to return a reference to the found value
This is often more convenient than dealing with iterators.

This commit includes a couple conversions to find_value as examples.
2025-04-06 13:45:10 +02:00

57 lines
1.6 KiB
C++

/*
* Copyright (c) 2021, the SerenityOS developers.
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
#include <AK/Concepts.h>
#include <AK/Optional.h>
#include <AK/Traits.h>
#include <AK/Types.h>
namespace AK {
template<typename TEndIterator, IteratorPairWith<TEndIterator> TIterator, typename TUnaryPredicate>
[[nodiscard]] constexpr TIterator find_if(TIterator first, TEndIterator last, TUnaryPredicate&& pred)
{
for (; first != last; ++first) {
if (pred(*first)) {
return first;
}
}
return last;
}
template<typename TEndIterator, IteratorPairWith<TEndIterator> TIterator, typename V>
[[nodiscard]] constexpr TIterator find(TIterator first, TEndIterator last, V const& value)
{
return find_if(first, last, [&]<typename T>(T const& entry) { return Traits<T>::equals(entry, value); });
}
template<typename TEndIterator, IteratorPairWith<TEndIterator> TIterator, typename V>
[[nodiscard]] constexpr size_t find_index(TIterator first, TEndIterator last, V const& value)
requires(requires(TIterator it) { it.index(); })
{
return find_if(first, last, [&]<typename T>(T const& entry) { return Traits<T>::equals(entry, value); }).index();
}
template<IterableContainer Container, typename TUnaryPredicate>
[[nodiscard]] constexpr auto find_value(Container const& container, TUnaryPredicate&& pred)
-> Optional<decltype(*container.begin())>
{
auto it = find_if(container.begin(), container.end(), forward<TUnaryPredicate>(pred));
if (it != container.end())
return *it;
return {};
}
}
#if USING_AK_GLOBALLY
using AK::find;
using AK::find_if;
using AK::find_index;
using AK::find_value;
#endif