mirror of
https://github.com/pybind/pybind11.git
synced 2024-11-13 09:03:54 +00:00
3f589379ec
This commit rewrites the examples that look for constructor/destructor calls to do so via static variable tracking rather than output parsing. The added ConstructorStats class provides methods to keep track of constructors and destructors, number of default/copy/move constructors, and number of copy/move assignments. It also provides a mechanism for storing values (e.g. for value construction), and then allows all of this to be checked at the end of a test by getting the statistics for a C++ (or python mapping) class. By not relying on the precise pattern of constructions/destructions, but rather simply ensuring that every construction is matched with a destruction on the same object, we ensure that everything that gets created also gets destroyed as expected. This replaces all of the various "std::cout << whatever" code in constructors/destructors with `print_created(this)`/`print_destroyed(this)`/etc. functions which provide similar output, but now has a unified format across the different examples, including a new ### prefix that makes mixed example output and lifecycle events easier to distinguish. With this change, relaxed mode is no longer needed, which enables testing for proper destruction under MSVC, and under any other compiler that generates code calling extra constructors, or optimizes away any constructors. GCC/clang are used as the baseline for move constructors; the tests are adapted to allow more move constructors to be evoked (but other types are constructors much have matching counts). This commit also disables output buffering of tests, as the buffering sometimes results in C++ output ending up in the middle of python output (or vice versa), depending on the OS/python version.
101 lines
2.8 KiB
C++
101 lines
2.8 KiB
C++
/*
|
|
example/example-callbacks.cpp -- callbacks
|
|
|
|
Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch>
|
|
|
|
All rights reserved. Use of this source code is governed by a
|
|
BSD-style license that can be found in the LICENSE file.
|
|
*/
|
|
|
|
#include "example.h"
|
|
#include "constructor-stats.h"
|
|
#include <pybind11/functional.h>
|
|
|
|
|
|
bool test_callback1(py::object func) {
|
|
func();
|
|
return false;
|
|
}
|
|
|
|
int test_callback2(py::object func) {
|
|
py::object result = func("Hello", 'x', true, 5);
|
|
return result.cast<int>();
|
|
}
|
|
|
|
void test_callback3(const std::function<int(int)> &func) {
|
|
cout << "func(43) = " << func(43)<< std::endl;
|
|
}
|
|
|
|
std::function<int(int)> test_callback4() {
|
|
return [](int i) { return i+1; };
|
|
}
|
|
|
|
py::cpp_function test_callback5() {
|
|
return py::cpp_function([](int i) { return i+1; },
|
|
py::arg("number"));
|
|
}
|
|
|
|
int dummy_function(int i) { return i + 1; }
|
|
int dummy_function2(int i, int j) { return i + j; }
|
|
std::function<int(int)> roundtrip(std::function<int(int)> f) {
|
|
std::cout << "roundtrip.." << std::endl;
|
|
return f;
|
|
}
|
|
|
|
void test_dummy_function(const std::function<int(int)> &f) {
|
|
using fn_type = int (*)(int);
|
|
auto result = f.target<fn_type>();
|
|
if (!result) {
|
|
std::cout << "could not convert to a function pointer." << std::endl;
|
|
auto r = f(1);
|
|
std::cout << "eval(1) = " << r << std::endl;
|
|
} else if (*result == dummy_function) {
|
|
std::cout << "argument matches dummy_function" << std::endl;
|
|
auto r = (*result)(1);
|
|
std::cout << "eval(1) = " << r << std::endl;
|
|
} else {
|
|
std::cout << "argument does NOT match dummy_function. This should never happen!" << std::endl;
|
|
}
|
|
}
|
|
|
|
struct Payload {
|
|
Payload() {
|
|
print_default_created(this);
|
|
}
|
|
~Payload() {
|
|
print_destroyed(this);
|
|
}
|
|
Payload(const Payload &) {
|
|
print_copy_created(this);
|
|
}
|
|
Payload(Payload &&) {
|
|
print_move_created(this);
|
|
}
|
|
};
|
|
|
|
void init_ex_callbacks(py::module &m) {
|
|
m.def("test_callback1", &test_callback1);
|
|
m.def("test_callback2", &test_callback2);
|
|
m.def("test_callback3", &test_callback3);
|
|
m.def("test_callback4", &test_callback4);
|
|
m.def("test_callback5", &test_callback5);
|
|
|
|
/* Test cleanup of lambda closure */
|
|
|
|
m.def("test_cleanup", []() -> std::function<void(void)> {
|
|
Payload p;
|
|
|
|
return [p]() {
|
|
/* p should be cleaned up when the returned function is garbage collected */
|
|
};
|
|
});
|
|
|
|
/* Test if passing a function pointer from C++ -> Python -> C++ yields the original pointer */
|
|
m.def("dummy_function", &dummy_function);
|
|
m.def("dummy_function2", &dummy_function2);
|
|
m.def("roundtrip", &roundtrip);
|
|
m.def("test_dummy_function", &test_dummy_function);
|
|
// Export the payload constructor statistics for testing purposes:
|
|
m.def("payload_cstats", &ConstructorStats::get<Payload>);
|
|
}
|