File: usertypes.unique.cpp

package info (click to toggle)
sol2 3.5.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 23,096 kB
  • sloc: cpp: 43,816; ansic: 1,018; python: 356; sh: 288; makefile: 202
file content (285 lines) | stat: -rw-r--r-- 9,366 bytes parent folder | download
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
// sol2

// The MIT License (MIT)

// Copyright (c) 2013-2022 Rapptz, ThePhD and contributors

// Permission is hereby granted, free of charge, to any person obtaining a copy of
// this software and associated documentation files (the "Software"), to deal in
// the Software without restriction, including without limitation the rights to
// use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
// the Software, and to permit persons to whom the Software is furnished to do so,
// subject to the following conditions:

// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.

// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
// FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
// COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
// IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
// CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

#include "sol_test.hpp"

#include "common_classes.hpp"

#include <catch2/catch_all.hpp>

inline namespace sol2_test_usertype_unique {
	template <typename Type, typename Deleter = std::default_delete<Type>>
	class checked_ptr {
	private:
		using pointer = Type*;
		pointer ptr;
		Deleter del;

	public:
		checked_ptr() noexcept : checked_ptr(nullptr) {
		}
		checked_ptr(std::nullptr_t) noexcept : ptr(nullptr), del() {
		}
		checked_ptr(pointer ptr_) noexcept : ptr(ptr_), del() {
		}

		pointer get() const noexcept {
			return ptr;
		}

		void reset() noexcept {
			if (ptr != nullptr) {
				del(ptr);
				ptr = nullptr;
			}
		}
	};

	struct checked_class {
		int value = 4645;
	};

	struct unique_user_Display {
		int value = 5;
	};

	std::vector<std::shared_ptr<unique_user_Display>> unique_user_foo() {
		return { std::make_shared<unique_user_Display>(), std::make_shared<unique_user_Display>(), std::make_shared<unique_user_Display>() };
	}

	int unique_user_bar(std::shared_ptr<unique_user_Display> item) {
		return item->value;
	}

	struct factory_test {
	private:
		factory_test() {
			a = true_a;
		}
		~factory_test() {
			a = 0;
		}

	public:
		static int num_saved;
		static int num_killed;

		struct deleter {
			void operator()(factory_test* f) {
				f->~factory_test();
			}
		};

		static const int true_a;
		int a;

		static std::unique_ptr<factory_test, deleter> make() {
			return std::unique_ptr<factory_test, deleter>(new factory_test(), deleter());
		}

		static void save(factory_test& f) {
			new (&f) factory_test();
			++num_saved;
		}

		static void kill(factory_test& f) {
			f.~factory_test();
			++num_killed;
		}
	};

	int factory_test::num_saved = 0;
	int factory_test::num_killed = 0;
	const int factory_test::true_a = 156;

	void const_ptr_test(const std::shared_ptr<int> ptr) {
		REQUIRE(*ptr.get() == 1);
	}
} // namespace sol2_test_usertype_unique

namespace sol {
	template <>
	struct unique_usertype_traits<checked_ptr<checked_class>> {
		static checked_class* get(lua_State*, const checked_ptr<checked_class>& ptr) noexcept {
			return ptr.get();
		}

		static bool is_null(lua_State*, const checked_ptr<checked_class>& ptr) noexcept {
			return ptr.get() == nullptr;
		}
	};
} // namespace sol

void sol_lua_check_access(sol::types<checked_class>, lua_State* L, int index, sol::stack::record& tracking) {
	sol::optional<checked_ptr<checked_class>&> maybe_checked = sol::stack::check_get<checked_ptr<checked_class>&>(L, index, sol::no_panic, tracking);
	if (!maybe_checked.has_value()) {
		return;
	}
	checked_ptr<checked_class>& checked = *maybe_checked;
	if (checked.get() == nullptr) {
		// freak out in whatever way is appropriate, here
		throw std::runtime_error("You dun goofed");
	}
}

TEST_CASE("usertype/unique-shared-ptr", "manage the conversion and use of unique and shared pointers ('unique usertypes')") {
	const int64_t unique_value = 0x7125679355635963;
	auto uniqueint = std::make_unique<int64_t>(unique_value);
	auto sharedint = std::make_shared<int64_t>(unique_value);
	long preusecount = sharedint.use_count();
	{
		sol::state lua;
		lua.open_libraries(sol::lib::base);
		lua.set("uniqueint", std::move(uniqueint));
		lua.set("sharedint", sharedint);
		std::unique_ptr<int64_t>& uniqueintref = lua["uniqueint"];
		std::shared_ptr<int64_t>& sharedintref = lua["sharedint"];
		int64_t* rawuniqueintref = lua["uniqueint"];
		int64_t* rawsharedintref = lua["sharedint"];
		int siusecount = sharedintref.use_count();
		REQUIRE((uniqueintref.get() == rawuniqueintref && sharedintref.get() == rawsharedintref));
		REQUIRE((uniqueintref != nullptr && sharedintref != nullptr && rawuniqueintref != nullptr && rawsharedintref != nullptr));
		REQUIRE((unique_value == *uniqueintref.get() && unique_value == *sharedintref.get()));
		REQUIRE((unique_value == *rawuniqueintref && unique_value == *rawsharedintref));
		REQUIRE(siusecount == sharedint.use_count());
		std::shared_ptr<int64_t> moreref = sharedint;
		REQUIRE(unique_value == *moreref.get());
		REQUIRE(moreref.use_count() == sharedint.use_count());
		REQUIRE(moreref.use_count() == sharedintref.use_count());
	}
	REQUIRE(preusecount == sharedint.use_count());
	std::cout << "----- end of 2" << std::endl;
}

TEST_CASE("usertype/private-constructible", "Check to make sure special snowflake types from Enterprise thingamahjongs work properly.") {
	int numsaved = factory_test::num_saved;
	int numkilled = factory_test::num_killed;
	{
		sol::state lua;
		lua.open_libraries(sol::lib::base);

		lua.new_usertype<factory_test>(
		     "factory_test", "new", sol::initializers(factory_test::save), "__gc", sol::destructor(factory_test::kill), "a", &factory_test::a);

		std::unique_ptr<factory_test, factory_test::deleter> f = factory_test::make();
		lua.set("true_a", factory_test::true_a, "f", f.get());
		{
			auto result = lua.safe_script("assert(f.a == true_a)", sol::script_pass_on_error);
			REQUIRE(result.valid());
		}

		auto code1
		     = "local fresh_f = factory_test:new()\n"
		       "assert(fresh_f.a == true_a)\n";
		auto result1 = lua.safe_script(code1, sol::script_pass_on_error);
		REQUIRE(result1.valid());
	}
	int expectednumsaved = numsaved + 1;
	int expectednumkilled = numkilled + 1;
	REQUIRE(expectednumsaved == factory_test::num_saved);
	REQUIRE(expectednumkilled == factory_test::num_killed);
	std::cout << "----- end of 5" << std::endl;
}

TEST_CASE("usertype/unique_usertype-check", "make sure unique usertypes don't get pushed as references with function calls and the like") {
	class Entity {
	public:
		std::string GetName() {
			return "Charmander";
		}
	};

	sol::state lua;
	lua.open_libraries(sol::lib::base, sol::lib::math, sol::lib::string, sol::lib::io);

	lua.new_usertype<Entity>("Entity", "new", sol::no_constructor, "get_name", &Entity::GetName);

	lua.safe_script(R"(
		function my_func(entity)
		print("INSIDE LUA")
		print(entity:get_name())
		end
)");

	sol::function my_func = lua["my_func"];
	REQUIRE_NOTHROW([&] {
		auto ent = std::make_shared<Entity>();
		my_func(ent);
		Entity ent2;
		my_func(ent2);
		my_func(std::make_shared<Entity>());
	}());
}

TEST_CASE("usertype/unique void pointers", "can compile shared_ptr<void> types and not trip the compiler or sol2's internals") {
	sol::state lua;
	lua.set_function("f", [](std::shared_ptr<void> d) {
		int* pi = static_cast<int*>(d.get());
		REQUIRE(*pi == 567);
	});

	std::shared_ptr<void> s = std::make_shared<int>(567);
	lua["s"] = std::move(s);
	auto result = lua.safe_script("f(s)", sol::script_pass_on_error);
	REQUIRE(result.valid());
}

TEST_CASE("usertype/unique containers", "copyable unique usertypes in containers are just fine and do not deref/decay") {
	sol::state lua;
	lua.open_libraries();

	lua["foo"] = unique_user_foo;
	lua["bar"] = unique_user_bar;
	sol::optional<sol::error> err0 = lua.safe_script("v3 = foo()");
	REQUIRE_FALSE(err0.has_value());
	sol::optional<sol::error> err1 = lua.safe_script("assert(bar(v3[1]) == 5)");
	REQUIRE_FALSE(err1.has_value());
}

TEST_CASE("usertype/unique_usertype checks", "Ensure that access to usertypes can be checked") {
	sol::state lua;

	lua["c"] = checked_ptr<checked_class>(new checked_class());
	lua["c_nil"] = checked_ptr<checked_class>();

	lua["f"] = [](checked_class cc) { std::cout << cc.value << std::endl; };

	sol::optional<sol::error> maybe_error = lua.safe_script("f(c)", sol::script_pass_on_error);
	REQUIRE_FALSE(maybe_error.has_value());

	checked_ptr<checked_class>& c = lua["c"];
	c.reset();

	sol::optional<sol::error> should_error = lua.safe_script("f(c)", sol::script_pass_on_error);
	REQUIRE(should_error.has_value());
}

TEST_CASE("usertype/unique_usertype const", "make sure const-qualified values don't trip the wrong template specializations") {
	sol::state lua;

	lua.set_function("f", &const_ptr_test);

	sol::protected_function lua_f = lua["f"];
	const std::shared_ptr<int> ptr = std::make_shared<int>(1);
	lua_f(ptr);
}