1 /*
2     tests/test_local_bindings.cpp -- tests the py::module_local class feature which makes a class
3                                      binding local to the module in which it is defined.
4 
5     Copyright (c) 2017 Jason Rhinelander <jason@imaginary.ca>
6 
7     All rights reserved. Use of this source code is governed by a
8     BSD-style license that can be found in the LICENSE file.
9 */
10 
11 #include "pybind11_tests.h"
12 #include "local_bindings.h"
13 
14 #include <pybind11/stl.h>
15 #include <pybind11/stl_bind.h>
16 
17 #include <numeric>
18 #include <utility>
19 
TEST_SUBMODULE(local_bindings,m)20 TEST_SUBMODULE(local_bindings, m) {
21     // test_load_external
22     m.def("load_external1", [](ExternalType1 &e) { return e.i; });
23     m.def("load_external2", [](ExternalType2 &e) { return e.i; });
24 
25     // test_local_bindings
26     // Register a class with py::module_local:
27     bind_local<LocalType, -1>(m, "LocalType", py::module_local())
28         .def("get3", [](LocalType &t) { return t.i + 3; })
29         ;
30 
31     m.def("local_value", [](LocalType &l) { return l.i; });
32 
33     // test_nonlocal_failure
34     // The main pybind11 test module is loaded first, so this registration will succeed (the second
35     // one, in pybind11_cross_module_tests.cpp, is designed to fail):
36     bind_local<NonLocalType, 0>(m, "NonLocalType")
37         .def(py::init<int>())
38         .def("get", [](LocalType &i) { return i.i; })
39         ;
40 
41     // test_duplicate_local
42     // py::module_local declarations should be visible across compilation units that get linked together;
43     // this tries to register a duplicate local.  It depends on a definition in test_class.cpp and
44     // should raise a runtime error from the duplicate definition attempt.  If test_class isn't
45     // available it *also* throws a runtime error (with "test_class not enabled" as value).
46     m.def("register_local_external", [m]() {
47         auto main = py::module_::import("pybind11_tests");
48         if (py::hasattr(main, "class_")) {
49             bind_local<LocalExternal, 7>(m, "LocalExternal", py::module_local());
50         }
51         else throw std::runtime_error("test_class not enabled");
52     });
53 
54     // test_stl_bind_local
55     // stl_bind.h binders defaults to py::module_local if the types are local or converting:
56     py::bind_vector<LocalVec>(m, "LocalVec");
57     py::bind_map<LocalMap>(m, "LocalMap");
58     // and global if the type (or one of the types, for the map) is global:
59     py::bind_vector<NonLocalVec>(m, "NonLocalVec");
60     py::bind_map<NonLocalMap>(m, "NonLocalMap");
61 
62     // test_stl_bind_global
63     // They can, however, be overridden to global using `py::module_local(false)`:
64     bind_local<NonLocal2, 10>(m, "NonLocal2");
65     py::bind_vector<LocalVec2>(m, "LocalVec2", py::module_local());
66     py::bind_map<NonLocalMap2>(m, "NonLocalMap2", py::module_local(false));
67 
68     // test_mixed_local_global
69     // We try this both with the global type registered first and vice versa (the order shouldn't
70     // matter).
71     m.def("register_mixed_global", [m]() {
72         bind_local<MixedGlobalLocal, 100>(m, "MixedGlobalLocal", py::module_local(false));
73     });
74     m.def("register_mixed_local", [m]() {
75         bind_local<MixedLocalGlobal, 1000>(m, "MixedLocalGlobal", py::module_local());
76     });
77     m.def("get_mixed_gl", [](int i) { return MixedGlobalLocal(i); });
78     m.def("get_mixed_lg", [](int i) { return MixedLocalGlobal(i); });
79 
80     // test_internal_locals_differ
81     m.def("local_cpp_types_addr", []() { return (uintptr_t) &py::detail::get_local_internals().registered_types_cpp; });
82 
83     // test_stl_caster_vs_stl_bind
84     m.def("load_vector_via_caster", [](std::vector<int> v) {
85         return std::accumulate(v.begin(), v.end(), 0);
86     });
87 
88     // test_cross_module_calls
89     m.def("return_self", [](LocalVec *v) { return v; });
90     m.def("return_copy", [](const LocalVec &v) { return LocalVec(v); });
91 
92     class Cat : public pets::Pet {
93     public:
94         explicit Cat(std::string name) : Pet(std::move(name)) {}
95     };
96     py::class_<pets::Pet>(m, "Pet", py::module_local())
97         .def("get_name", &pets::Pet::name);
98     // Binding for local extending class:
99     py::class_<Cat, pets::Pet>(m, "Cat")
100         .def(py::init<std::string>());
101     m.def("pet_name", [](pets::Pet &p) { return p.name(); });
102 
103     py::class_<MixGL>(m, "MixGL").def(py::init<int>());
104     m.def("get_gl_value", [](MixGL &o) { return o.i + 10; });
105 
106     py::class_<MixGL2>(m, "MixGL2").def(py::init<int>());
107 }
108