File: test_return_value_policy.cpp

package info (click to toggle)
emscripten 3.1.69%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 121,860 kB
  • sloc: ansic: 636,110; cpp: 425,974; javascript: 78,401; python: 58,404; sh: 49,154; pascal: 5,237; makefile: 3,366; asm: 2,415; lisp: 1,869
file content (357 lines) | stat: -rw-r--r-- 10,250 bytes parent folder | download | duplicates (2)
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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
#include <stdio.h>
#include <functional>
#include <emscripten.h>
#include <emscripten/bind.h>

using namespace emscripten;

// Counters to track Value structs lifetimes.
static int default_constructed = 0, copy_constructed = 0,
           move_constructed = 0, destructed = 0;

struct Value {
  std::string name;
  Value() : name("initial") {
    printf("create\n");
    default_constructed++;
  }
  Value(const Value &v) {
    printf("copy\n");
    name = v.name;
    copy_constructed++;
  }
  Value(Value&& v) {
    printf("move\n");
    name = std::move(v.name);
    move_constructed++;
  }
  Value& operator=(Value other) {
    printf("copy assign\n");
    return *this;
  }
  std::string getName() {
    return name;
  }
  void setName(std::string _name) {
    name = _name;
  }
  ~Value() {
    printf("destroy\n");
    destructed++;
  }
};

void resetCounters() {
  default_constructed = 0;
  copy_constructed = 0,
  move_constructed = 0;
  destructed = 0;
}

void assertDefault(int count) {
  assert(count == default_constructed);
  default_constructed = 0;
}

void assertCopy(int count) {
  assert(count == copy_constructed);
  copy_constructed = 0;
}

void assertMove(int count) {
  assert(count == move_constructed);
  move_constructed = 0;
}

void assertDestructed(int count) {
  assert(count == destructed);
  destructed = 0;
}

void assertAllCountsZero() {
  assert(default_constructed == 0);
  assert(copy_constructed == 0);
  assert(move_constructed == 0);
  assert(destructed == 0);
}

struct ValueHolder {
  ValueHolder() {};
  Value value;
  Value* valuePtr;

  Value* getPtr() {
    return &value;
  }
  Value getValue() {
    return value;
  }
  Value& getRef() {
    return value;
  }

  void set(Value v) {
    value = v;
  }
  Value get() const {
    return value;
  }
  void initializePtr() {
    valuePtr = new Value();
  }
  Value* getNewPtr() const {
    return new Value();
  }
  const Value* getNewPtrConst() const {
    return new Value();
  }
  void setPtr(Value* v) {
    valuePtr = v;
  }
  static Value* staticGetPtr() {
    static Value v;
    return &v;
  }
};

const Value* value_holder(const ValueHolder& target) {
  return target.getNewPtrConst();
}

Value* _valuePtr;
Value _value;

void initializeValuePtr() {
  _valuePtr = new Value();
}

void resetValue() {
  _value.name = "initial";
}

void deleteValue() {
  delete _valuePtr;
}

Value* getPtr() {
  return _valuePtr;
};

Value* getNewPtr() {
  return new Value();
};

Value getValue() {
  return Value();
};

Value& getRef() {
  return _value;
};

int main() {
  EM_ASM(
    /////////////////////////////////
    // Test RVP with plain functions.
    /////////////////////////////////
    Module.resetCounters();

    console.log("getPtrTakeOwnership");
    var value = Module.getPtrTakeOwnership();
    value.delete();
    Module.assertDefault(1);
    Module.assertDestructed(1);
    Module.assertAllCountsZero();

    console.log("getPtrReference");
    Module.initializeValuePtr();
    value = Module.getPtrReference();
    // Check that both references are updated.
    value.setName("reference");
    value = Module.getPtrReference();
    assert(value.getName() === "reference");
    // TODO: enforce that we can't delete it from JS.
    Module.deleteValue();
    Module.assertDefault(1);
    Module.assertDestructed(1);
    Module.assertAllCountsZero();

    console.log("getValueDefault");
    value = Module.getValueDefault();
    value.delete();
    Module.assertDefault(1);
    Module.assertCopy(1);
    Module.assertDestructed(2);
    Module.assertAllCountsZero();

    console.log("getValueTakeOwnership");
    value = Module.getValueTakeOwnership();
    value.delete();
    Module.assertDefault(1);
    Module.assertMove(1);
    Module.assertDestructed(2);
    Module.assertAllCountsZero();

    console.log("getRefDefault");
    value = Module.getRefDefault();
    value.delete();
    Module.assertCopy(1);
    Module.assertDestructed(1);
    Module.assertAllCountsZero();

    console.log("getRefTakeOwnership");
    value = Module.getRefTakeOwnership();
    value.delete();
    Module.assertMove(1);
    Module.assertDestructed(1);
    Module.assertAllCountsZero();

    console.log("getRefReference");
    value = Module.getRefReference();
    Module.assertAllCountsZero();

    ///////////////////////////////
    // Test RVP with class methods.
    ///////////////////////////////
    console.log("Module.ValueHolder");
    var valueHolder = new Module.ValueHolder();
    Module.resetCounters();

    console.log("valueHolder.getPtrTakeOwnership");
    value = valueHolder.getPtrTakeOwnership();
    value.delete();
    Module.assertDefault(1);
    Module.assertDestructed(1);
    Module.assertAllCountsZero();

    console.log("valueHolder.getPtrReference");
    value = valueHolder.getPtrReference();
    Module.assertAllCountsZero();

    console.log("valueHolder.getPtrWithStdFunctionTakeOwnership");
    value = valueHolder.getPtrWithStdFunctionTakeOwnership();
    value.delete();
    Module.assertDefault(1);
    Module.assertDestructed(1);
    Module.assertAllCountsZero();

    valueHolder.delete();

    ////////////////////////////////////////
    // Test RVP with static class functions.
    ////////////////////////////////////////
    // These bindings use the same machinery as regular function bindings,
    // so don't bother extensively testing them.
    Module.resetCounters();
    console.log("staticGetPtrReference");
    value = Module.ValueHolder.staticGetPtrReference();
    Module.assertDefault(1);
    Module.assertAllCountsZero();

    ////////////////////////////////////////
    // Test RVP with class properties.
    ////////////////////////////////////////
    var valueHolder = new Module.ValueHolder();
    Module.resetCounters();
    console.log("valueHolder.valueDefault");
    var originalValueProp = valueHolder.valueReference;
    var valueProp = valueHolder.valueDefault;
    valueProp.setName("copy");
    assert(originalValueProp.getName() === "initial");
    valueProp.delete();
    Module.assertCopy(1);
    Module.assertDestructed(1);
    Module.assertAllCountsZero();

    console.log("valueHolder.valueReference");
    valueProp = valueHolder.valueReference;
    // Check that both references are updated.
    valueProp.setName("reference");
    valueProp = valueHolder.valueReference;
    assert(valueProp.getName() === "reference");
    Module.assertAllCountsZero();

    console.log("valueHolder.valueTakeOwnership");
    var originalValueProp = valueHolder.valueReference;
    valueProp = valueHolder.valueTakeOwnership;
    valueProp.setName("move");
    assert(originalValueProp.getName() === "");
    valueProp.delete();
    Module.assertMove(1);
    Module.assertDestructed(1);
    Module.assertAllCountsZero();

    console.log("valueHolder.valuePtrReference");
    valueHolder.initializeValuePtr();
    valueProp = valueHolder.valuePtrReference;
    Module.assertDefault(1);
    Module.assertAllCountsZero();

    console.log("valueHolder.valuePtrTakeOwnership");
    valueHolder.initializeValuePtr();
    valueProp = valueHolder.valuePtrTakeOwnership;
    valueProp.delete();
    Module.assertDefault(1);
    Module.assertDestructed(1);
    Module.assertAllCountsZero();

    valueHolder.delete();
  );
}

EMSCRIPTEN_BINDINGS(xxx) {
  function("resetCounters", &resetCounters);
  function("initializeValuePtr", &initializeValuePtr);
  function("deleteValue", &deleteValue);
  function("assertAllCountsZero", &assertAllCountsZero);
  function("assertDefault", &assertDefault);
  function("assertCopy", &assertCopy);
  function("assertMove", &assertMove);
  function("assertDestructed", &assertDestructed);

  class_<Value>("Value")
    .function("getName", &Value::getName)
    .function("setName", &Value::setName);

  // Skip the test for getPtr with a default return policy since raw pointers
  // must explicitly choose a policy.
  function("getPtrTakeOwnership", &getNewPtr, return_value_policy::take_ownership());
  function("getPtrReference", &getPtr, return_value_policy::reference());

  function("getValueDefault", &getValue);
  function("getValueTakeOwnership", &getValue, return_value_policy::take_ownership());
  // Skip the test for getValue with a reference return policy since it is not
  // allowed.

  function("getRefDefault", &getRef);
  function("getRefTakeOwnership", &getRef, return_value_policy::take_ownership());
  function("getRefReference", &getRef, return_value_policy::reference());

  class_<ValueHolder>("ValueHolder")
    .constructor<>()
    .function("getPtrTakeOwnership", &ValueHolder::getNewPtr, return_value_policy::take_ownership())
    .function("getPtrReference", &ValueHolder::getPtr, return_value_policy::reference())
    .function("getPtrWithStdFunctionTakeOwnership", std::function<const Value*(const ValueHolder&)>(&value_holder), return_value_policy::take_ownership())
    .class_function("staticGetPtrReference", &ValueHolder::staticGetPtr, return_value_policy::reference())
    .function("initializeValuePtr", &ValueHolder::initializePtr)

    // Test the code path for properties directly bound to a member.
    .property("valueDefault", &ValueHolder::value)
    .property("valueReference", &ValueHolder::value, return_value_policy::reference())
    .property("valueTakeOwnership", &ValueHolder::value, return_value_policy::take_ownership())

    // Test binding raw pointers with the various methods.
    .property("valuePtrReference", &ValueHolder::valuePtr, return_value_policy::reference())
    .property("valuePtrTakeOwnership", &ValueHolder::valuePtr, return_value_policy::take_ownership())

    // Check that compiling with getter and setter methods works as expected.
    // These are only tested for compilation since they use the same underlying
    // mechanisms as the other property bindings.
    // Getter only.
    .property("getterValue", &ValueHolder::get, return_value_policy::reference())
    // Getter and setter.
    .property("getterSetterValue", &ValueHolder::get, &ValueHolder::set, return_value_policy::reference())
    // std::function getter.
    .property("getterPtrWithStdFunctionReference", std::function<const Value*(const ValueHolder&)>(&value_holder), return_value_policy::reference())
    ;
}