112391Sjason@lowepower.com/* 212391Sjason@lowepower.com tests/test_stl.cpp -- STL type casters 312391Sjason@lowepower.com 412391Sjason@lowepower.com Copyright (c) 2017 Wenzel Jakob <wenzel.jakob@epfl.ch> 512391Sjason@lowepower.com 612391Sjason@lowepower.com All rights reserved. Use of this source code is governed by a 712391Sjason@lowepower.com BSD-style license that can be found in the LICENSE file. 812391Sjason@lowepower.com*/ 912391Sjason@lowepower.com 1012391Sjason@lowepower.com#include "pybind11_tests.h" 1114299Sbbruce@ucdavis.edu#include "constructor_stats.h" 1212391Sjason@lowepower.com#include <pybind11/stl.h> 1312391Sjason@lowepower.com 1414299Sbbruce@ucdavis.edu#include <vector> 1514299Sbbruce@ucdavis.edu#include <string> 1614299Sbbruce@ucdavis.edu 1712391Sjason@lowepower.com// Test with `std::variant` in C++17 mode, or with `boost::variant` in C++11/14 1812391Sjason@lowepower.com#if PYBIND11_HAS_VARIANT 1912391Sjason@lowepower.comusing std::variant; 2012391Sjason@lowepower.com#elif defined(PYBIND11_TEST_BOOST) && (!defined(_MSC_VER) || _MSC_VER >= 1910) 2112391Sjason@lowepower.com# include <boost/variant.hpp> 2212391Sjason@lowepower.com# define PYBIND11_HAS_VARIANT 1 2312391Sjason@lowepower.comusing boost::variant; 2412391Sjason@lowepower.com 2512391Sjason@lowepower.comnamespace pybind11 { namespace detail { 2612391Sjason@lowepower.comtemplate <typename... Ts> 2712391Sjason@lowepower.comstruct type_caster<boost::variant<Ts...>> : variant_caster<boost::variant<Ts...>> {}; 2812391Sjason@lowepower.com 2912391Sjason@lowepower.comtemplate <> 3012391Sjason@lowepower.comstruct visit_helper<boost::variant> { 3112391Sjason@lowepower.com template <typename... Args> 3212391Sjason@lowepower.com static auto call(Args &&...args) -> decltype(boost::apply_visitor(args...)) { 3312391Sjason@lowepower.com return boost::apply_visitor(args...); 3412391Sjason@lowepower.com } 3512391Sjason@lowepower.com}; 3612391Sjason@lowepower.com}} // namespace pybind11::detail 3712391Sjason@lowepower.com#endif 3812391Sjason@lowepower.com 3914299Sbbruce@ucdavis.eduPYBIND11_MAKE_OPAQUE(std::vector<std::string, std::allocator<std::string>>); 4014299Sbbruce@ucdavis.edu 4112391Sjason@lowepower.com/// Issue #528: templated constructor 4212391Sjason@lowepower.comstruct TplCtorClass { 4312391Sjason@lowepower.com template <typename T> TplCtorClass(const T &) { } 4412391Sjason@lowepower.com bool operator==(const TplCtorClass &) const { return true; } 4512391Sjason@lowepower.com}; 4612391Sjason@lowepower.com 4712391Sjason@lowepower.comnamespace std { 4812391Sjason@lowepower.com template <> 4912391Sjason@lowepower.com struct hash<TplCtorClass> { size_t operator()(const TplCtorClass &) const { return 0; } }; 5012391Sjason@lowepower.com} 5112391Sjason@lowepower.com 5212391Sjason@lowepower.com 5312391Sjason@lowepower.comTEST_SUBMODULE(stl, m) { 5412391Sjason@lowepower.com // test_vector 5512391Sjason@lowepower.com m.def("cast_vector", []() { return std::vector<int>{1}; }); 5612391Sjason@lowepower.com m.def("load_vector", [](const std::vector<int> &v) { return v.at(0) == 1 && v.at(1) == 2; }); 5712391Sjason@lowepower.com // `std::vector<bool>` is special because it returns proxy objects instead of references 5812391Sjason@lowepower.com m.def("cast_bool_vector", []() { return std::vector<bool>{true, false}; }); 5912391Sjason@lowepower.com m.def("load_bool_vector", [](const std::vector<bool> &v) { 6012391Sjason@lowepower.com return v.at(0) == true && v.at(1) == false; 6112391Sjason@lowepower.com }); 6212391Sjason@lowepower.com // Unnumbered regression (caused by #936): pointers to stl containers aren't castable 6312391Sjason@lowepower.com static std::vector<RValueCaster> lvv{2}; 6412391Sjason@lowepower.com m.def("cast_ptr_vector", []() { return &lvv; }); 6512391Sjason@lowepower.com 6614299Sbbruce@ucdavis.edu // test_deque 6714299Sbbruce@ucdavis.edu m.def("cast_deque", []() { return std::deque<int>{1}; }); 6814299Sbbruce@ucdavis.edu m.def("load_deque", [](const std::deque<int> &v) { return v.at(0) == 1 && v.at(1) == 2; }); 6914299Sbbruce@ucdavis.edu 7012391Sjason@lowepower.com // test_array 7112391Sjason@lowepower.com m.def("cast_array", []() { return std::array<int, 2> {{1 , 2}}; }); 7212391Sjason@lowepower.com m.def("load_array", [](const std::array<int, 2> &a) { return a[0] == 1 && a[1] == 2; }); 7312391Sjason@lowepower.com 7412391Sjason@lowepower.com // test_valarray 7512391Sjason@lowepower.com m.def("cast_valarray", []() { return std::valarray<int>{1, 4, 9}; }); 7612391Sjason@lowepower.com m.def("load_valarray", [](const std::valarray<int>& v) { 7712391Sjason@lowepower.com return v.size() == 3 && v[0] == 1 && v[1] == 4 && v[2] == 9; 7812391Sjason@lowepower.com }); 7912391Sjason@lowepower.com 8012391Sjason@lowepower.com // test_map 8112391Sjason@lowepower.com m.def("cast_map", []() { return std::map<std::string, std::string>{{"key", "value"}}; }); 8212391Sjason@lowepower.com m.def("load_map", [](const std::map<std::string, std::string> &map) { 8312391Sjason@lowepower.com return map.at("key") == "value" && map.at("key2") == "value2"; 8412391Sjason@lowepower.com }); 8512391Sjason@lowepower.com 8612391Sjason@lowepower.com // test_set 8712391Sjason@lowepower.com m.def("cast_set", []() { return std::set<std::string>{"key1", "key2"}; }); 8812391Sjason@lowepower.com m.def("load_set", [](const std::set<std::string> &set) { 8912391Sjason@lowepower.com return set.count("key1") && set.count("key2") && set.count("key3"); 9012391Sjason@lowepower.com }); 9112391Sjason@lowepower.com 9212391Sjason@lowepower.com // test_recursive_casting 9312391Sjason@lowepower.com m.def("cast_rv_vector", []() { return std::vector<RValueCaster>{2}; }); 9412391Sjason@lowepower.com m.def("cast_rv_array", []() { return std::array<RValueCaster, 3>(); }); 9512391Sjason@lowepower.com // NB: map and set keys are `const`, so while we technically do move them (as `const Type &&`), 9612391Sjason@lowepower.com // casters don't typically do anything with that, which means they fall to the `const Type &` 9712391Sjason@lowepower.com // caster. 9812391Sjason@lowepower.com m.def("cast_rv_map", []() { return std::unordered_map<std::string, RValueCaster>{{"a", RValueCaster{}}}; }); 9912391Sjason@lowepower.com m.def("cast_rv_nested", []() { 10012391Sjason@lowepower.com std::vector<std::array<std::list<std::unordered_map<std::string, RValueCaster>>, 2>> v; 10112391Sjason@lowepower.com v.emplace_back(); // add an array 10212391Sjason@lowepower.com v.back()[0].emplace_back(); // add a map to the array 10312391Sjason@lowepower.com v.back()[0].back().emplace("b", RValueCaster{}); 10412391Sjason@lowepower.com v.back()[0].back().emplace("c", RValueCaster{}); 10512391Sjason@lowepower.com v.back()[1].emplace_back(); // add a map to the array 10612391Sjason@lowepower.com v.back()[1].back().emplace("a", RValueCaster{}); 10712391Sjason@lowepower.com return v; 10812391Sjason@lowepower.com }); 10912391Sjason@lowepower.com static std::array<RValueCaster, 2> lva; 11012391Sjason@lowepower.com static std::unordered_map<std::string, RValueCaster> lvm{{"a", RValueCaster{}}, {"b", RValueCaster{}}}; 11112391Sjason@lowepower.com static std::unordered_map<std::string, std::vector<std::list<std::array<RValueCaster, 2>>>> lvn; 11212391Sjason@lowepower.com lvn["a"].emplace_back(); // add a list 11312391Sjason@lowepower.com lvn["a"].back().emplace_back(); // add an array 11412391Sjason@lowepower.com lvn["a"].emplace_back(); // another list 11512391Sjason@lowepower.com lvn["a"].back().emplace_back(); // add an array 11612391Sjason@lowepower.com lvn["b"].emplace_back(); // add a list 11712391Sjason@lowepower.com lvn["b"].back().emplace_back(); // add an array 11812391Sjason@lowepower.com lvn["b"].back().emplace_back(); // add another array 11912391Sjason@lowepower.com m.def("cast_lv_vector", []() -> const decltype(lvv) & { return lvv; }); 12012391Sjason@lowepower.com m.def("cast_lv_array", []() -> const decltype(lva) & { return lva; }); 12112391Sjason@lowepower.com m.def("cast_lv_map", []() -> const decltype(lvm) & { return lvm; }); 12212391Sjason@lowepower.com m.def("cast_lv_nested", []() -> const decltype(lvn) & { return lvn; }); 12312391Sjason@lowepower.com // #853: 12412391Sjason@lowepower.com m.def("cast_unique_ptr_vector", []() { 12512391Sjason@lowepower.com std::vector<std::unique_ptr<UserType>> v; 12612391Sjason@lowepower.com v.emplace_back(new UserType{7}); 12712391Sjason@lowepower.com v.emplace_back(new UserType{42}); 12812391Sjason@lowepower.com return v; 12912391Sjason@lowepower.com }); 13012391Sjason@lowepower.com 13112391Sjason@lowepower.com // test_move_out_container 13212391Sjason@lowepower.com struct MoveOutContainer { 13312391Sjason@lowepower.com struct Value { int value; }; 13412391Sjason@lowepower.com std::list<Value> move_list() const { return {{0}, {1}, {2}}; } 13512391Sjason@lowepower.com }; 13612391Sjason@lowepower.com py::class_<MoveOutContainer::Value>(m, "MoveOutContainerValue") 13712391Sjason@lowepower.com .def_readonly("value", &MoveOutContainer::Value::value); 13812391Sjason@lowepower.com py::class_<MoveOutContainer>(m, "MoveOutContainer") 13912391Sjason@lowepower.com .def(py::init<>()) 14012391Sjason@lowepower.com .def_property_readonly("move_list", &MoveOutContainer::move_list); 14112391Sjason@lowepower.com 14212391Sjason@lowepower.com // Class that can be move- and copy-constructed, but not assigned 14312391Sjason@lowepower.com struct NoAssign { 14412391Sjason@lowepower.com int value; 14512391Sjason@lowepower.com 14612391Sjason@lowepower.com explicit NoAssign(int value = 0) : value(value) { } 14712391Sjason@lowepower.com NoAssign(const NoAssign &) = default; 14812391Sjason@lowepower.com NoAssign(NoAssign &&) = default; 14912391Sjason@lowepower.com 15012391Sjason@lowepower.com NoAssign &operator=(const NoAssign &) = delete; 15112391Sjason@lowepower.com NoAssign &operator=(NoAssign &&) = delete; 15212391Sjason@lowepower.com }; 15312391Sjason@lowepower.com py::class_<NoAssign>(m, "NoAssign", "Class with no C++ assignment operators") 15412391Sjason@lowepower.com .def(py::init<>()) 15512391Sjason@lowepower.com .def(py::init<int>()); 15612391Sjason@lowepower.com 15712391Sjason@lowepower.com#ifdef PYBIND11_HAS_OPTIONAL 15812391Sjason@lowepower.com // test_optional 15912391Sjason@lowepower.com m.attr("has_optional") = true; 16012391Sjason@lowepower.com 16112391Sjason@lowepower.com using opt_int = std::optional<int>; 16212391Sjason@lowepower.com using opt_no_assign = std::optional<NoAssign>; 16312391Sjason@lowepower.com m.def("double_or_zero", [](const opt_int& x) -> int { 16412391Sjason@lowepower.com return x.value_or(0) * 2; 16512391Sjason@lowepower.com }); 16612391Sjason@lowepower.com m.def("half_or_none", [](int x) -> opt_int { 16712391Sjason@lowepower.com return x ? opt_int(x / 2) : opt_int(); 16812391Sjason@lowepower.com }); 16912391Sjason@lowepower.com m.def("test_nullopt", [](opt_int x) { 17012391Sjason@lowepower.com return x.value_or(42); 17112391Sjason@lowepower.com }, py::arg_v("x", std::nullopt, "None")); 17212391Sjason@lowepower.com m.def("test_no_assign", [](const opt_no_assign &x) { 17312391Sjason@lowepower.com return x ? x->value : 42; 17412391Sjason@lowepower.com }, py::arg_v("x", std::nullopt, "None")); 17512391Sjason@lowepower.com 17612391Sjason@lowepower.com m.def("nodefer_none_optional", [](std::optional<int>) { return true; }); 17712391Sjason@lowepower.com m.def("nodefer_none_optional", [](py::none) { return false; }); 17812391Sjason@lowepower.com#endif 17912391Sjason@lowepower.com 18012391Sjason@lowepower.com#ifdef PYBIND11_HAS_EXP_OPTIONAL 18112391Sjason@lowepower.com // test_exp_optional 18212391Sjason@lowepower.com m.attr("has_exp_optional") = true; 18312391Sjason@lowepower.com 18412391Sjason@lowepower.com using exp_opt_int = std::experimental::optional<int>; 18512391Sjason@lowepower.com using exp_opt_no_assign = std::experimental::optional<NoAssign>; 18612391Sjason@lowepower.com m.def("double_or_zero_exp", [](const exp_opt_int& x) -> int { 18712391Sjason@lowepower.com return x.value_or(0) * 2; 18812391Sjason@lowepower.com }); 18912391Sjason@lowepower.com m.def("half_or_none_exp", [](int x) -> exp_opt_int { 19012391Sjason@lowepower.com return x ? exp_opt_int(x / 2) : exp_opt_int(); 19112391Sjason@lowepower.com }); 19212391Sjason@lowepower.com m.def("test_nullopt_exp", [](exp_opt_int x) { 19312391Sjason@lowepower.com return x.value_or(42); 19412391Sjason@lowepower.com }, py::arg_v("x", std::experimental::nullopt, "None")); 19512391Sjason@lowepower.com m.def("test_no_assign_exp", [](const exp_opt_no_assign &x) { 19612391Sjason@lowepower.com return x ? x->value : 42; 19712391Sjason@lowepower.com }, py::arg_v("x", std::experimental::nullopt, "None")); 19812391Sjason@lowepower.com#endif 19912391Sjason@lowepower.com 20012391Sjason@lowepower.com#ifdef PYBIND11_HAS_VARIANT 20112391Sjason@lowepower.com static_assert(std::is_same<py::detail::variant_caster_visitor::result_type, py::handle>::value, 20212391Sjason@lowepower.com "visitor::result_type is required by boost::variant in C++11 mode"); 20312391Sjason@lowepower.com 20412391Sjason@lowepower.com struct visitor { 20512391Sjason@lowepower.com using result_type = const char *; 20612391Sjason@lowepower.com 20712391Sjason@lowepower.com result_type operator()(int) { return "int"; } 20812391Sjason@lowepower.com result_type operator()(std::string) { return "std::string"; } 20912391Sjason@lowepower.com result_type operator()(double) { return "double"; } 21012391Sjason@lowepower.com result_type operator()(std::nullptr_t) { return "std::nullptr_t"; } 21112391Sjason@lowepower.com }; 21212391Sjason@lowepower.com 21312391Sjason@lowepower.com // test_variant 21412391Sjason@lowepower.com m.def("load_variant", [](variant<int, std::string, double, std::nullptr_t> v) { 21512391Sjason@lowepower.com return py::detail::visit_helper<variant>::call(visitor(), v); 21612391Sjason@lowepower.com }); 21712391Sjason@lowepower.com m.def("load_variant_2pass", [](variant<double, int> v) { 21812391Sjason@lowepower.com return py::detail::visit_helper<variant>::call(visitor(), v); 21912391Sjason@lowepower.com }); 22012391Sjason@lowepower.com m.def("cast_variant", []() { 22112391Sjason@lowepower.com using V = variant<int, std::string>; 22212391Sjason@lowepower.com return py::make_tuple(V(5), V("Hello")); 22312391Sjason@lowepower.com }); 22412391Sjason@lowepower.com#endif 22512391Sjason@lowepower.com 22612391Sjason@lowepower.com // #528: templated constructor 22712391Sjason@lowepower.com // (no python tests: the test here is that this compiles) 22812391Sjason@lowepower.com m.def("tpl_ctor_vector", [](std::vector<TplCtorClass> &) {}); 22912391Sjason@lowepower.com m.def("tpl_ctor_map", [](std::unordered_map<TplCtorClass, TplCtorClass> &) {}); 23012391Sjason@lowepower.com m.def("tpl_ctor_set", [](std::unordered_set<TplCtorClass> &) {}); 23112391Sjason@lowepower.com#if defined(PYBIND11_HAS_OPTIONAL) 23212391Sjason@lowepower.com m.def("tpl_constr_optional", [](std::optional<TplCtorClass> &) {}); 23312391Sjason@lowepower.com#elif defined(PYBIND11_HAS_EXP_OPTIONAL) 23412391Sjason@lowepower.com m.def("tpl_constr_optional", [](std::experimental::optional<TplCtorClass> &) {}); 23512391Sjason@lowepower.com#endif 23612391Sjason@lowepower.com 23712391Sjason@lowepower.com // test_vec_of_reference_wrapper 23812391Sjason@lowepower.com // #171: Can't return STL structures containing reference wrapper 23912391Sjason@lowepower.com m.def("return_vec_of_reference_wrapper", [](std::reference_wrapper<UserType> p4) { 24012391Sjason@lowepower.com static UserType p1{1}, p2{2}, p3{3}; 24112391Sjason@lowepower.com return std::vector<std::reference_wrapper<UserType>> { 24212391Sjason@lowepower.com std::ref(p1), std::ref(p2), std::ref(p3), p4 24312391Sjason@lowepower.com }; 24412391Sjason@lowepower.com }); 24512391Sjason@lowepower.com 24612391Sjason@lowepower.com // test_stl_pass_by_pointer 24712391Sjason@lowepower.com m.def("stl_pass_by_pointer", [](std::vector<int>* v) { return *v; }, "v"_a=nullptr); 24814299Sbbruce@ucdavis.edu 24914299Sbbruce@ucdavis.edu // #1258: pybind11/stl.h converts string to vector<string> 25014299Sbbruce@ucdavis.edu m.def("func_with_string_or_vector_string_arg_overload", [](std::vector<std::string>) { return 1; }); 25114299Sbbruce@ucdavis.edu m.def("func_with_string_or_vector_string_arg_overload", [](std::list<std::string>) { return 2; }); 25214299Sbbruce@ucdavis.edu m.def("func_with_string_or_vector_string_arg_overload", [](std::string) { return 3; }); 25314299Sbbruce@ucdavis.edu 25414299Sbbruce@ucdavis.edu class Placeholder { 25514299Sbbruce@ucdavis.edu public: 25614299Sbbruce@ucdavis.edu Placeholder() { print_created(this); } 25714299Sbbruce@ucdavis.edu Placeholder(const Placeholder &) = delete; 25814299Sbbruce@ucdavis.edu ~Placeholder() { print_destroyed(this); } 25914299Sbbruce@ucdavis.edu }; 26014299Sbbruce@ucdavis.edu py::class_<Placeholder>(m, "Placeholder"); 26114299Sbbruce@ucdavis.edu 26214299Sbbruce@ucdavis.edu /// test_stl_vector_ownership 26314299Sbbruce@ucdavis.edu m.def("test_stl_ownership", 26414299Sbbruce@ucdavis.edu []() { 26514299Sbbruce@ucdavis.edu std::vector<Placeholder *> result; 26614299Sbbruce@ucdavis.edu result.push_back(new Placeholder()); 26714299Sbbruce@ucdavis.edu return result; 26814299Sbbruce@ucdavis.edu }, 26914299Sbbruce@ucdavis.edu py::return_value_policy::take_ownership); 27014299Sbbruce@ucdavis.edu 27114299Sbbruce@ucdavis.edu m.def("array_cast_sequence", [](std::array<int, 3> x) { return x; }); 27214299Sbbruce@ucdavis.edu 27314299Sbbruce@ucdavis.edu /// test_issue_1561 27414299Sbbruce@ucdavis.edu struct Issue1561Inner { std::string data; }; 27514299Sbbruce@ucdavis.edu struct Issue1561Outer { std::vector<Issue1561Inner> list; }; 27614299Sbbruce@ucdavis.edu 27714299Sbbruce@ucdavis.edu py::class_<Issue1561Inner>(m, "Issue1561Inner") 27814299Sbbruce@ucdavis.edu .def(py::init<std::string>()) 27914299Sbbruce@ucdavis.edu .def_readwrite("data", &Issue1561Inner::data); 28014299Sbbruce@ucdavis.edu 28114299Sbbruce@ucdavis.edu py::class_<Issue1561Outer>(m, "Issue1561Outer") 28214299Sbbruce@ucdavis.edu .def(py::init<>()) 28314299Sbbruce@ucdavis.edu .def_readwrite("list", &Issue1561Outer::list); 28412391Sjason@lowepower.com} 285