test_call_policies.cpp revision 12391:ceeca8b41e4b 
1/*
2    tests/test_call_policies.cpp -- keep_alive and call_guard
3
4    Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch>
5
6    All rights reserved. Use of this source code is governed by a
7    BSD-style license that can be found in the LICENSE file.
8*/
9
10#include "pybind11_tests.h"
11
12struct CustomGuard {
13    static bool enabled;
14
15    CustomGuard() { enabled = true; }
16    ~CustomGuard() { enabled = false; }
17
18    static const char *report_status() { return enabled ? "guarded" : "unguarded"; }
19};
20bool CustomGuard::enabled = false;
21
22struct DependentGuard {
23    static bool enabled;
24
25    DependentGuard() { enabled = CustomGuard::enabled; }
26    ~DependentGuard() { enabled = false; }
27
28    static const char *report_status() { return enabled ? "guarded" : "unguarded"; }
29};
30bool DependentGuard::enabled = false;
31
32TEST_SUBMODULE(call_policies, m) {
33    // Parent/Child are used in:
34    // test_keep_alive_argument, test_keep_alive_return_value, test_alive_gc_derived,
35    // test_alive_gc_multi_derived, test_return_none, test_keep_alive_constructor
36    class Child {
37    public:
38        Child() { py::print("Allocating child."); }
39        ~Child() { py::print("Releasing child."); }
40    };
41    py::class_<Child>(m, "Child")
42        .def(py::init<>());
43
44    class Parent {
45    public:
46        Parent() { py::print("Allocating parent."); }
47        ~Parent() { py::print("Releasing parent."); }
48        void addChild(Child *) { }
49        Child *returnChild() { return new Child(); }
50        Child *returnNullChild() { return nullptr; }
51    };
52    py::class_<Parent>(m, "Parent")
53        .def(py::init<>())
54        .def(py::init([](Child *) { return new Parent(); }), py::keep_alive<1, 2>())
55        .def("addChild", &Parent::addChild)
56        .def("addChildKeepAlive", &Parent::addChild, py::keep_alive<1, 2>())
57        .def("returnChild", &Parent::returnChild)
58        .def("returnChildKeepAlive", &Parent::returnChild, py::keep_alive<1, 0>())
59        .def("returnNullChildKeepAliveChild", &Parent::returnNullChild, py::keep_alive<1, 0>())
60        .def("returnNullChildKeepAliveParent", &Parent::returnNullChild, py::keep_alive<0, 1>());
61
62#if !defined(PYPY_VERSION)
63    // test_alive_gc
64    class ParentGC : public Parent {
65    public:
66        using Parent::Parent;
67    };
68    py::class_<ParentGC, Parent>(m, "ParentGC", py::dynamic_attr())
69        .def(py::init<>());
70#endif
71
72    // test_call_guard
73    m.def("unguarded_call", &CustomGuard::report_status);
74    m.def("guarded_call", &CustomGuard::report_status, py::call_guard<CustomGuard>());
75
76    m.def("multiple_guards_correct_order", []() {
77        return CustomGuard::report_status() + std::string(" & ") + DependentGuard::report_status();
78    }, py::call_guard<CustomGuard, DependentGuard>());
79
80    m.def("multiple_guards_wrong_order", []() {
81        return DependentGuard::report_status() + std::string(" & ") + CustomGuard::report_status();
82    }, py::call_guard<DependentGuard, CustomGuard>());
83
84#if defined(WITH_THREAD) && !defined(PYPY_VERSION)
85    // `py::call_guard<py::gil_scoped_release>()` should work in PyPy as well,
86    // but it's unclear how to test it without `PyGILState_GetThisThreadState`.
87    auto report_gil_status = []() {
88        auto is_gil_held = false;
89        if (auto tstate = py::detail::get_thread_state_unchecked())
90            is_gil_held = (tstate == PyGILState_GetThisThreadState());
91
92        return is_gil_held ? "GIL held" : "GIL released";
93    };
94
95    m.def("with_gil", report_gil_status);
96    m.def("without_gil", report_gil_status, py::call_guard<py::gil_scoped_release>());
97#endif
98}
99