aboutsummaryrefslogtreecommitdiff
path: root/libs/kstd/tests/src/observer_ptr.cpp
blob: 2fe22264080f92040a282ce1bd6a707747a5d5d1 (plain)
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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
#include <kstd/observer_ptr>
#include <kstd/tests/os_panic.hpp>

#include <catch2/catch_test_macros.hpp>

#include <utility>

SCENARIO("Observer Pointer initialization and construction", "[observer_ptr]")
{
  GIVEN("An empty context")
  {
    WHEN("constructing by default")
    {
      auto ptr = kstd::observer_ptr<int>{};

      THEN("the observer pointer is null")
      {
        REQUIRE_FALSE(ptr);
      }
    }

    WHEN("constructing from a nullptr")
    {
      auto ptr = kstd::observer_ptr<int>{nullptr};

      THEN("the observer pointer is null")
      {
        REQUIRE_FALSE(ptr);
      }
    }

    WHEN("constructing from a raw pointer")
    {
      auto value = 1;
      auto ptr = kstd::observer_ptr{&value};

      THEN("the observer pointer is not null")
      {
        REQUIRE(ptr);
      }

      THEN("the observer pointer points to the correct object")
      {
        REQUIRE(&*ptr == &value);
      }
    }

    WHEN("copy constructing from an existing observer pointer")
    {
      auto value = 1;
      auto ptr = kstd::observer_ptr{&value};
      auto copy = ptr;

      THEN("the new observer pointer points to the same object as the other observer pointer")
      {
        REQUIRE(&*copy == &value);
      }
    }

    WHEN("copy constructing from an existing observer pointer with a compatible type")
    {
      struct A
      {
      };

      struct B : A
      {
      };

      auto value = B{};
      auto ptr = kstd::observer_ptr<B>(&value);
      auto copy = kstd::observer_ptr<A>(ptr);

      THEN("the new observer pointer points to the same object as the other observer pointer")
      {
        REQUIRE(&*copy == &value);
      }
    }

    WHEN("copy assigning from an existing observer pointer")
    {
      auto value = 1;
      auto ptr = kstd::observer_ptr{&value};
      auto copy = ptr;

      THEN("the new observer pointer points to the same object as the other observer pointer")
      {
        REQUIRE(&*copy == &value);
      }
    }

    WHEN("move constructing from an existing observer pointer")
    {
      auto value = 1;
      auto ptr = kstd::observer_ptr{&value};
      auto copy = std::move(ptr);

      THEN("the new observer pointer points to the same object as the other observer pointer")
      {
        REQUIRE(&*copy == &value);
      }
    }

    WHEN("move assigning from an existing observer pointer")
    {
      auto value = 1;
      auto ptr = kstd::observer_ptr{&value};
      auto copy = std::move(ptr);

      THEN("the new observer pointer points to the same object as the other observer pointer")
      {
        REQUIRE(&*copy == &value);
      }
    }
  }
}

SCENARIO("Observer pointer modifiers", "[observer_ptr]")
{
  GIVEN("A non-null observer pointer")
  {
    auto value = 1;
    auto ptr = kstd::observer_ptr{&value};

    WHEN("releasing the observer pointer")
    {
      auto raw_ptr = ptr.release();

      THEN("the observer pointer is null")
      {
        REQUIRE_FALSE(ptr);
      }

      THEN("the returned pointer points to the correct object")
      {
        REQUIRE(raw_ptr == &value);
      }
    }

    WHEN("resetting the observer pointer to nullptr")
    {
      ptr.reset();

      THEN("the observer pointer is null")
      {
        REQUIRE_FALSE(ptr);
      }
    }

    WHEN("resetting the observer pointer to a new object")
    {
      auto other_value = 2;
      ptr.reset(&other_value);

      THEN("the observer pointer points to the new object")
      {
        REQUIRE(&*ptr == &other_value);
      }
    }

    WHEN("swapping it with another observer pointer")
    {
      auto other_value = 2;
      auto other_ptr = kstd::observer_ptr{&other_value};
      ptr.swap(other_ptr);

      THEN("the observer pointer points to the other object")
      {
        REQUIRE(&*ptr == &other_value);
      }

      THEN("the other observer pointer points to the original object")
      {
        REQUIRE(&*other_ptr == &value);
      }
    }
  }
}

SCENARIO("Observer pointer observers", "[observer_ptr]")
{
  GIVEN("A non-null observer pointer")
  {
    struct A
    {
      int value{};

      constexpr auto operator<=>(A const & other) const noexcept = default;
    };

    auto value = A{1};
    auto ptr = kstd::observer_ptr{&value};

    WHEN("getting the raw pointer")
    {
      auto raw_ptr = ptr.get();

      THEN("the raw pointer points to the correct object")
      {
        REQUIRE(raw_ptr == &value);
      }
    }

    WHEN("dereferencing the observer pointer")
    {
      auto dereferenced = *ptr;

      THEN("the dereferenced value is the correct value")
      {
        REQUIRE(dereferenced == value);
      }
    }

    WHEN("writing through the observer pointer with the arrow operator")
    {
      ptr->value = 2;

      THEN("the value is updated")
      {
        REQUIRE(value.value == 2);
      }
    }

    WHEN("converting the observer pointer to a raw pointer")
    {
      auto raw_ptr = static_cast<A *>(ptr);

      THEN("the raw pointer points to the correct object")
      {
        REQUIRE(raw_ptr == &value);
      }
    }
  }
}