llvm-project/llvm/unittests/ADT/DepthFirstIteratorTest.cpp
Markus Böck c88a7a7b8e [llvm][ADT] Fix invalid reference type of depth-first, breadth-first and post order iterators
C++s iterator concept requires operator* to return the same type as is specified by the iterators reference type. This functionality is especially important for older generic code that did not yet make use of auto.
An example from within LLVM is iterator_adaptor_base which uses the reference type of the iterator it is wrapping as its return type for operator* (this class is used as base for a lot of other functionality like filter iterators and so on).
Using any of the graph traversal iterators listed above with it would previously fail to compile due to reference being non-const while operator* returned a const reference.

This patch fixes that by correctly specifying reference and using it as the return type of operator* explicitly to prevent further issues in the future.

Differential Revision: https://reviews.llvm.org/D151198
2023-05-23 19:29:58 +02:00

59 lines
1.5 KiB
C++

//=== llvm/unittest/ADT/DepthFirstIteratorTest.cpp - DFS iterator tests ---===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#include "llvm/ADT/DepthFirstIterator.h"
#include "TestGraph.h"
#include "gtest/gtest.h"
using namespace llvm;
namespace llvm {
template <typename T> struct CountedSet {
typedef typename SmallPtrSet<T, 4>::iterator iterator;
SmallPtrSet<T, 4> S;
int InsertVisited = 0;
std::pair<iterator, bool> insert(const T &Item) {
InsertVisited++;
return S.insert(Item);
}
size_t count(const T &Item) const { return S.count(Item); }
void completed(T) { }
};
template <typename T> class df_iterator_storage<CountedSet<T>, true> {
public:
df_iterator_storage(CountedSet<T> &VSet) : Visited(VSet) {}
CountedSet<T> &Visited;
};
TEST(DepthFirstIteratorTest, ActuallyUpdateIterator) {
typedef CountedSet<Graph<3>::NodeType *> StorageT;
typedef df_iterator<Graph<3>, StorageT, true> DFIter;
Graph<3> G;
G.AddEdge(0, 1);
G.AddEdge(0, 2);
StorageT S;
for (auto N : make_range(DFIter::begin(G, S), DFIter::end(G, S)))
(void)N;
EXPECT_EQ(3, S.InsertVisited);
}
static_assert(
std::is_convertible_v<decltype(*std::declval<df_iterator<Graph<3>>>()),
typename df_iterator<Graph<3>>::reference>);
}