File: iter_swap.pass.cpp

package info (click to toggle)
llvm-toolchain-21 1%3A21.1.7-1
  • links: PTS, VCS
  • area: main
  • in suites: forky
  • size: 2,245,064 kB
  • sloc: cpp: 7,619,731; ansic: 1,434,018; asm: 1,058,748; python: 252,740; f90: 94,671; objc: 70,685; lisp: 42,813; pascal: 18,401; sh: 8,601; ml: 5,111; perl: 4,720; makefile: 3,676; awk: 3,523; javascript: 2,409; xml: 892; fortran: 770
file content (186 lines) | stat: -rw-r--r-- 7,468 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
//===----------------------------------------------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//

// REQUIRES: std-at-least-c++23

// <ranges>

// friend constexpr void iter_swap(const iterator& x, const iterator& y);

#include <ranges>

#include <algorithm>
#include <array>
#include <cassert>
#include <span>
#include <string>
#include <string_view>
#include <type_traits>
#include <utility>
#include <vector>

template <class I>
concept CanIterSwap = requires(I i) { iter_swap(i); };

enum class SwapKind { no_swap, with_same_type, with_different_type };
enum class IterKind { inner_view, pattern };

template <std::forward_iterator Iter, IterKind Kind>
class IterSwapTrackingIterator {
public:
  using value_type      = std::iter_value_t<Iter>;
  using difference_type = std::iter_difference_t<Iter>;

  constexpr Iter get_iter() const { return iter_; }

  constexpr SwapKind* get_flag() const { return flag_; }

  IterSwapTrackingIterator() = default;
  constexpr explicit IterSwapTrackingIterator(Iter iter, SwapKind* flag = nullptr)
      : iter_(std::move(iter)), flag_(flag) {}

  constexpr IterSwapTrackingIterator& operator++() {
    ++iter_;
    return *this;
  }

  constexpr IterSwapTrackingIterator operator++(int) {
    auto tmp = *this;
    ++*this;
    return tmp;
  }

  constexpr decltype(auto) operator*() const { return *iter_; }

  constexpr bool operator==(const IterSwapTrackingIterator& other) const { return iter_ == other.iter_; }

  friend constexpr decltype(auto) iter_swap(const IterSwapTrackingIterator& lhs, const IterSwapTrackingIterator& rhs) {
    assert(lhs.flag_ != nullptr && rhs.flag_ != nullptr);
    *lhs.flag_ = *rhs.flag_ = SwapKind::with_same_type;
    return std::ranges::iter_swap(lhs.iter_, rhs.iter_);
  }

  template <std::indirectly_swappable<Iter> OtherIter, IterKind OtherKind>
  friend constexpr decltype(auto)
  iter_swap(const IterSwapTrackingIterator& lhs, const IterSwapTrackingIterator<OtherIter, OtherKind>& rhs) {
    assert(lhs.flag_ != nullptr && rhs.get_flag() != nullptr);
    *lhs.flag_ = *rhs.get_flag() = SwapKind::with_different_type;
    return std::ranges::iter_swap(lhs.iter_, rhs.get_iter());
  }

private:
  Iter iter_      = Iter();
  SwapKind* flag_ = nullptr;
};

static_assert(std::forward_iterator<IterSwapTrackingIterator<int*, IterKind::inner_view>> &&
              !std::bidirectional_iterator<IterSwapTrackingIterator<int*, IterKind::inner_view>>);

constexpr bool test() {
  { // Test common usage
    using V       = std::vector<std::string>;
    using Pattern = std::string;
    using JWV     = std::ranges::join_with_view<std::ranges::owning_view<V>, std::ranges::owning_view<Pattern>>;
    using namespace std::string_view_literals;

    JWV jwv(V{"std", "ranges", "views", "join_with_view"}, Pattern{":: "});
    assert(std::ranges::equal(jwv, "std:: ranges:: views:: join_with_view"sv));

    auto it = jwv.begin();
    iter_swap(it, std::ranges::next(it, 2)); // Swap elements of the same inner range.
    assert(std::ranges::equal(jwv, "dts:: ranges:: views:: join_with_view"sv));

    std::ranges::advance(it, 3);
    iter_swap(std::as_const(it), std::ranges::next(it, 2)); // Swap elements of the pattern.
    assert(std::ranges::equal(jwv, "dts ::ranges ::views ::join_with_view"sv));

    std::ranges::advance(it, 3);
    const auto it2 = jwv.begin();
    iter_swap(std::as_const(it), it2); // Swap elements of different inner ranges.
    assert(std::ranges::equal(jwv, "rts ::danges ::views ::join_with_view"sv));

    std::ranges::advance(it, 6);
    iter_swap(std::as_const(it), it2); // Swap element from inner range with element from the pattern.
    assert(std::ranges::equal(jwv, " tsr::dangesr::viewsr::join_with_view"sv));

    static_assert(std::is_void_v<decltype(iter_swap(it, it))>);
    static_assert(std::is_void_v<decltype(iter_swap(it2, it2))>);
    static_assert(!CanIterSwap<std::ranges::iterator_t<const JWV>>);
    static_assert(!CanIterSwap<const std::ranges::iterator_t<const JWV>>);
  }

  { // Make sure `iter_swap` calls underlying's iterator `iter_swap` (not `ranges::swap(*i1, *i2)`).
    using Inner               = std::vector<int>;
    using InnerTrackingIter   = IterSwapTrackingIterator<Inner::iterator, IterKind::inner_view>;
    using TrackingInner       = std::ranges::subrange<InnerTrackingIter>;
    using Pattern             = std::array<int, 2>;
    using PatternTrackingIter = IterSwapTrackingIterator<Pattern::iterator, IterKind::pattern>;
    using TrackingPattern     = std::ranges::subrange<PatternTrackingIter>;
    using JWV                 = std::ranges::join_with_view<std::span<TrackingInner>, TrackingPattern>;

    std::array<Inner, 3> v{{{1, 2, 3}, {4, 5}}};
    Pattern pat{-1, -2};

    SwapKind v_swap_kind = SwapKind::no_swap;
    std::array<TrackingInner, 2> tracking_v{
        TrackingInner(InnerTrackingIter(v[0].begin(), &v_swap_kind), InnerTrackingIter(v[0].end())),
        TrackingInner(InnerTrackingIter(v[1].begin(), &v_swap_kind), InnerTrackingIter(v[1].end()))};

    SwapKind pat_swap_kind = SwapKind::no_swap;
    TrackingPattern tracking_pat(PatternTrackingIter(pat.begin(), &pat_swap_kind), PatternTrackingIter(pat.end()));

    JWV jwv(tracking_v, tracking_pat);
    auto it1 = jwv.begin();
    auto it2 = std::ranges::next(it1);

    // Test calling `iter_swap` when both `it1` and `it2` point to elements of `v`.
    assert(v_swap_kind == SwapKind::no_swap);
    iter_swap(it1, it2);
    assert(*it1 == 2 && *it2 == 1);
    assert(v_swap_kind == SwapKind::with_same_type && pat_swap_kind == SwapKind::no_swap);

    // Test calling `iter_swap` when `it1` points to element of `v` and `it2` points to element of `pat`.
    std::ranges::advance(it2, 2);
    v_swap_kind = SwapKind::no_swap;
    assert(pat_swap_kind == SwapKind::no_swap);
    iter_swap(it1, it2);
    assert(*it1 == -1 && *it2 == 2);
    assert(v_swap_kind == SwapKind::with_different_type && pat_swap_kind == SwapKind::with_different_type);

    // Test calling `iter_swap` when `it1` and `it2` point to elements of `pat`.
    std::ranges::advance(it1, 4);
    v_swap_kind = pat_swap_kind = SwapKind::no_swap;
    iter_swap(it1, it2);
    assert(*it1 == 2 && *it2 == -2);
    assert(v_swap_kind == SwapKind::no_swap && pat_swap_kind == SwapKind::with_same_type);

    // Test calling `iter_swap` when `it1` points to element of `pat` and `it2` points to element of `v`.
    std::ranges::advance(it2, 3);
    v_swap_kind = pat_swap_kind = SwapKind::no_swap;
    iter_swap(it1, it2);
    assert(*it1 == 5 && *it2 == 2);
    assert(v_swap_kind == SwapKind::with_different_type && pat_swap_kind == SwapKind::with_different_type);
  }

  { // InnerIter and PatternIter don't model indirectly swappable
    using JWV = std::ranges::join_with_view<std::span<std::string>, std::string_view>;
    static_assert(!CanIterSwap<std::ranges::iterator_t<JWV>>);
    static_assert(!CanIterSwap<const std::ranges::iterator_t<JWV>>);
    static_assert(!CanIterSwap<std::ranges::iterator_t<const JWV>>);
    static_assert(!CanIterSwap<const std::ranges::iterator_t<const JWV>>);
  }

  return true;
}

int main(int, char**) {
  test();
  static_assert(test());

  return 0;
}