test_stl.cpp revision 12391
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" 1112391Sjason@lowepower.com#include <pybind11/stl.h> 1212391Sjason@lowepower.com 1312391Sjason@lowepower.com// Test with `std::variant` in C++17 mode, or with `boost::variant` in C++11/14 1412391Sjason@lowepower.com#if PYBIND11_HAS_VARIANT 1512391Sjason@lowepower.comusing std::variant; 1612391Sjason@lowepower.com#elif defined(PYBIND11_TEST_BOOST) && (!defined(_MSC_VER) || _MSC_VER >= 1910) 1712391Sjason@lowepower.com# include <boost/variant.hpp> 1812391Sjason@lowepower.com# define PYBIND11_HAS_VARIANT 1 1912391Sjason@lowepower.comusing boost::variant; 2012391Sjason@lowepower.com 2112391Sjason@lowepower.comnamespace pybind11 { namespace detail { 2212391Sjason@lowepower.comtemplate <typename... Ts> 2312391Sjason@lowepower.comstruct type_caster<boost::variant<Ts...>> : variant_caster<boost::variant<Ts...>> {}; 2412391Sjason@lowepower.com 2512391Sjason@lowepower.comtemplate <> 2612391Sjason@lowepower.comstruct visit_helper<boost::variant> { 2712391Sjason@lowepower.com template <typename... Args> 2812391Sjason@lowepower.com static auto call(Args &&...args) -> decltype(boost::apply_visitor(args...)) { 2912391Sjason@lowepower.com return boost::apply_visitor(args...); 3012391Sjason@lowepower.com } 3112391Sjason@lowepower.com}; 3212391Sjason@lowepower.com}} // namespace pybind11::detail 3312391Sjason@lowepower.com#endif 3412391Sjason@lowepower.com 3512391Sjason@lowepower.com/// Issue #528: templated constructor 3612391Sjason@lowepower.comstruct TplCtorClass { 3712391Sjason@lowepower.com template <typename T> TplCtorClass(const T &) { } 3812391Sjason@lowepower.com bool operator==(const TplCtorClass &) const { return true; } 3912391Sjason@lowepower.com}; 4012391Sjason@lowepower.com 4112391Sjason@lowepower.comnamespace std { 4212391Sjason@lowepower.com template <> 4312391Sjason@lowepower.com struct hash<TplCtorClass> { size_t operator()(const TplCtorClass &) const { return 0; } }; 4412391Sjason@lowepower.com} 4512391Sjason@lowepower.com 4612391Sjason@lowepower.com 4712391Sjason@lowepower.comTEST_SUBMODULE(stl, m) { 4812391Sjason@lowepower.com // test_vector 4912391Sjason@lowepower.com m.def("cast_vector", []() { return std::vector<int>{1}; }); 5012391Sjason@lowepower.com m.def("load_vector", [](const std::vector<int> &v) { return v.at(0) == 1 && v.at(1) == 2; }); 5112391Sjason@lowepower.com // `std::vector<bool>` is special because it returns proxy objects instead of references 5212391Sjason@lowepower.com m.def("cast_bool_vector", []() { return std::vector<bool>{true, false}; }); 5312391Sjason@lowepower.com m.def("load_bool_vector", [](const std::vector<bool> &v) { 5412391Sjason@lowepower.com return v.at(0) == true && v.at(1) == false; 5512391Sjason@lowepower.com }); 5612391Sjason@lowepower.com // Unnumbered regression (caused by #936): pointers to stl containers aren't castable 5712391Sjason@lowepower.com static std::vector<RValueCaster> lvv{2}; 5812391Sjason@lowepower.com m.def("cast_ptr_vector", []() { return &lvv; }); 5912391Sjason@lowepower.com 6012391Sjason@lowepower.com // test_array 6112391Sjason@lowepower.com m.def("cast_array", []() { return std::array<int, 2> {{1 , 2}}; }); 6212391Sjason@lowepower.com m.def("load_array", [](const std::array<int, 2> &a) { return a[0] == 1 && a[1] == 2; }); 6312391Sjason@lowepower.com 6412391Sjason@lowepower.com // test_valarray 6512391Sjason@lowepower.com m.def("cast_valarray", []() { return std::valarray<int>{1, 4, 9}; }); 6612391Sjason@lowepower.com m.def("load_valarray", [](const std::valarray<int>& v) { 6712391Sjason@lowepower.com return v.size() == 3 && v[0] == 1 && v[1] == 4 && v[2] == 9; 6812391Sjason@lowepower.com }); 6912391Sjason@lowepower.com 7012391Sjason@lowepower.com // test_map 7112391Sjason@lowepower.com m.def("cast_map", []() { return std::map<std::string, std::string>{{"key", "value"}}; }); 7212391Sjason@lowepower.com m.def("load_map", [](const std::map<std::string, std::string> &map) { 7312391Sjason@lowepower.com return map.at("key") == "value" && map.at("key2") == "value2"; 7412391Sjason@lowepower.com }); 7512391Sjason@lowepower.com 7612391Sjason@lowepower.com // test_set 7712391Sjason@lowepower.com m.def("cast_set", []() { return std::set<std::string>{"key1", "key2"}; }); 7812391Sjason@lowepower.com m.def("load_set", [](const std::set<std::string> &set) { 7912391Sjason@lowepower.com return set.count("key1") && set.count("key2") && set.count("key3"); 8012391Sjason@lowepower.com }); 8112391Sjason@lowepower.com 8212391Sjason@lowepower.com // test_recursive_casting 8312391Sjason@lowepower.com m.def("cast_rv_vector", []() { return std::vector<RValueCaster>{2}; }); 8412391Sjason@lowepower.com m.def("cast_rv_array", []() { return std::array<RValueCaster, 3>(); }); 8512391Sjason@lowepower.com // NB: map and set keys are `const`, so while we technically do move them (as `const Type &&`), 8612391Sjason@lowepower.com // casters don't typically do anything with that, which means they fall to the `const Type &` 8712391Sjason@lowepower.com // caster. 8812391Sjason@lowepower.com m.def("cast_rv_map", []() { return std::unordered_map<std::string, RValueCaster>{{"a", RValueCaster{}}}; }); 8912391Sjason@lowepower.com m.def("cast_rv_nested", []() { 9012391Sjason@lowepower.com std::vector<std::array<std::list<std::unordered_map<std::string, RValueCaster>>, 2>> v; 9112391Sjason@lowepower.com v.emplace_back(); // add an array 9212391Sjason@lowepower.com v.back()[0].emplace_back(); // add a map to the array 9312391Sjason@lowepower.com v.back()[0].back().emplace("b", RValueCaster{}); 9412391Sjason@lowepower.com v.back()[0].back().emplace("c", RValueCaster{}); 9512391Sjason@lowepower.com v.back()[1].emplace_back(); // add a map to the array 9612391Sjason@lowepower.com v.back()[1].back().emplace("a", RValueCaster{}); 9712391Sjason@lowepower.com return v; 9812391Sjason@lowepower.com }); 9912391Sjason@lowepower.com static std::array<RValueCaster, 2> lva; 10012391Sjason@lowepower.com static std::unordered_map<std::string, RValueCaster> lvm{{"a", RValueCaster{}}, {"b", RValueCaster{}}}; 10112391Sjason@lowepower.com static std::unordered_map<std::string, std::vector<std::list<std::array<RValueCaster, 2>>>> lvn; 10212391Sjason@lowepower.com lvn["a"].emplace_back(); // add a list 10312391Sjason@lowepower.com lvn["a"].back().emplace_back(); // add an array 10412391Sjason@lowepower.com lvn["a"].emplace_back(); // another list 10512391Sjason@lowepower.com lvn["a"].back().emplace_back(); // add an array 10612391Sjason@lowepower.com lvn["b"].emplace_back(); // add a list 10712391Sjason@lowepower.com lvn["b"].back().emplace_back(); // add an array 10812391Sjason@lowepower.com lvn["b"].back().emplace_back(); // add another array 10912391Sjason@lowepower.com m.def("cast_lv_vector", []() -> const decltype(lvv) & { return lvv; }); 11012391Sjason@lowepower.com m.def("cast_lv_array", []() -> const decltype(lva) & { return lva; }); 11112391Sjason@lowepower.com m.def("cast_lv_map", []() -> const decltype(lvm) & { return lvm; }); 11212391Sjason@lowepower.com m.def("cast_lv_nested", []() -> const decltype(lvn) & { return lvn; }); 11312391Sjason@lowepower.com // #853: 11412391Sjason@lowepower.com m.def("cast_unique_ptr_vector", []() { 11512391Sjason@lowepower.com std::vector<std::unique_ptr<UserType>> v; 11612391Sjason@lowepower.com v.emplace_back(new UserType{7}); 11712391Sjason@lowepower.com v.emplace_back(new UserType{42}); 11812391Sjason@lowepower.com return v; 11912391Sjason@lowepower.com }); 12012391Sjason@lowepower.com 12112391Sjason@lowepower.com // test_move_out_container 12212391Sjason@lowepower.com struct MoveOutContainer { 12312391Sjason@lowepower.com struct Value { int value; }; 12412391Sjason@lowepower.com std::list<Value> move_list() const { return {{0}, {1}, {2}}; } 12512391Sjason@lowepower.com }; 12612391Sjason@lowepower.com py::class_<MoveOutContainer::Value>(m, "MoveOutContainerValue") 12712391Sjason@lowepower.com .def_readonly("value", &MoveOutContainer::Value::value); 12812391Sjason@lowepower.com py::class_<MoveOutContainer>(m, "MoveOutContainer") 12912391Sjason@lowepower.com .def(py::init<>()) 13012391Sjason@lowepower.com .def_property_readonly("move_list", &MoveOutContainer::move_list); 13112391Sjason@lowepower.com 13212391Sjason@lowepower.com // Class that can be move- and copy-constructed, but not assigned 13312391Sjason@lowepower.com struct NoAssign { 13412391Sjason@lowepower.com int value; 13512391Sjason@lowepower.com 13612391Sjason@lowepower.com explicit NoAssign(int value = 0) : value(value) { } 13712391Sjason@lowepower.com NoAssign(const NoAssign &) = default; 13812391Sjason@lowepower.com NoAssign(NoAssign &&) = default; 13912391Sjason@lowepower.com 14012391Sjason@lowepower.com NoAssign &operator=(const NoAssign &) = delete; 14112391Sjason@lowepower.com NoAssign &operator=(NoAssign &&) = delete; 14212391Sjason@lowepower.com }; 14312391Sjason@lowepower.com py::class_<NoAssign>(m, "NoAssign", "Class with no C++ assignment operators") 14412391Sjason@lowepower.com .def(py::init<>()) 14512391Sjason@lowepower.com .def(py::init<int>()); 14612391Sjason@lowepower.com 14712391Sjason@lowepower.com#ifdef PYBIND11_HAS_OPTIONAL 14812391Sjason@lowepower.com // test_optional 14912391Sjason@lowepower.com m.attr("has_optional") = true; 15012391Sjason@lowepower.com 15112391Sjason@lowepower.com using opt_int = std::optional<int>; 15212391Sjason@lowepower.com using opt_no_assign = std::optional<NoAssign>; 15312391Sjason@lowepower.com m.def("double_or_zero", [](const opt_int& x) -> int { 15412391Sjason@lowepower.com return x.value_or(0) * 2; 15512391Sjason@lowepower.com }); 15612391Sjason@lowepower.com m.def("half_or_none", [](int x) -> opt_int { 15712391Sjason@lowepower.com return x ? opt_int(x / 2) : opt_int(); 15812391Sjason@lowepower.com }); 15912391Sjason@lowepower.com m.def("test_nullopt", [](opt_int x) { 16012391Sjason@lowepower.com return x.value_or(42); 16112391Sjason@lowepower.com }, py::arg_v("x", std::nullopt, "None")); 16212391Sjason@lowepower.com m.def("test_no_assign", [](const opt_no_assign &x) { 16312391Sjason@lowepower.com return x ? x->value : 42; 16412391Sjason@lowepower.com }, py::arg_v("x", std::nullopt, "None")); 16512391Sjason@lowepower.com 16612391Sjason@lowepower.com m.def("nodefer_none_optional", [](std::optional<int>) { return true; }); 16712391Sjason@lowepower.com m.def("nodefer_none_optional", [](py::none) { return false; }); 16812391Sjason@lowepower.com#endif 16912391Sjason@lowepower.com 17012391Sjason@lowepower.com#ifdef PYBIND11_HAS_EXP_OPTIONAL 17112391Sjason@lowepower.com // test_exp_optional 17212391Sjason@lowepower.com m.attr("has_exp_optional") = true; 17312391Sjason@lowepower.com 17412391Sjason@lowepower.com using exp_opt_int = std::experimental::optional<int>; 17512391Sjason@lowepower.com using exp_opt_no_assign = std::experimental::optional<NoAssign>; 17612391Sjason@lowepower.com m.def("double_or_zero_exp", [](const exp_opt_int& x) -> int { 17712391Sjason@lowepower.com return x.value_or(0) * 2; 17812391Sjason@lowepower.com }); 17912391Sjason@lowepower.com m.def("half_or_none_exp", [](int x) -> exp_opt_int { 18012391Sjason@lowepower.com return x ? exp_opt_int(x / 2) : exp_opt_int(); 18112391Sjason@lowepower.com }); 18212391Sjason@lowepower.com m.def("test_nullopt_exp", [](exp_opt_int x) { 18312391Sjason@lowepower.com return x.value_or(42); 18412391Sjason@lowepower.com }, py::arg_v("x", std::experimental::nullopt, "None")); 18512391Sjason@lowepower.com m.def("test_no_assign_exp", [](const exp_opt_no_assign &x) { 18612391Sjason@lowepower.com return x ? x->value : 42; 18712391Sjason@lowepower.com }, py::arg_v("x", std::experimental::nullopt, "None")); 18812391Sjason@lowepower.com#endif 18912391Sjason@lowepower.com 19012391Sjason@lowepower.com#ifdef PYBIND11_HAS_VARIANT 19112391Sjason@lowepower.com static_assert(std::is_same<py::detail::variant_caster_visitor::result_type, py::handle>::value, 19212391Sjason@lowepower.com "visitor::result_type is required by boost::variant in C++11 mode"); 19312391Sjason@lowepower.com 19412391Sjason@lowepower.com struct visitor { 19512391Sjason@lowepower.com using result_type = const char *; 19612391Sjason@lowepower.com 19712391Sjason@lowepower.com result_type operator()(int) { return "int"; } 19812391Sjason@lowepower.com result_type operator()(std::string) { return "std::string"; } 19912391Sjason@lowepower.com result_type operator()(double) { return "double"; } 20012391Sjason@lowepower.com result_type operator()(std::nullptr_t) { return "std::nullptr_t"; } 20112391Sjason@lowepower.com }; 20212391Sjason@lowepower.com 20312391Sjason@lowepower.com // test_variant 20412391Sjason@lowepower.com m.def("load_variant", [](variant<int, std::string, double, std::nullptr_t> v) { 20512391Sjason@lowepower.com return py::detail::visit_helper<variant>::call(visitor(), v); 20612391Sjason@lowepower.com }); 20712391Sjason@lowepower.com m.def("load_variant_2pass", [](variant<double, int> v) { 20812391Sjason@lowepower.com return py::detail::visit_helper<variant>::call(visitor(), v); 20912391Sjason@lowepower.com }); 21012391Sjason@lowepower.com m.def("cast_variant", []() { 21112391Sjason@lowepower.com using V = variant<int, std::string>; 21212391Sjason@lowepower.com return py::make_tuple(V(5), V("Hello")); 21312391Sjason@lowepower.com }); 21412391Sjason@lowepower.com#endif 21512391Sjason@lowepower.com 21612391Sjason@lowepower.com // #528: templated constructor 21712391Sjason@lowepower.com // (no python tests: the test here is that this compiles) 21812391Sjason@lowepower.com m.def("tpl_ctor_vector", [](std::vector<TplCtorClass> &) {}); 21912391Sjason@lowepower.com m.def("tpl_ctor_map", [](std::unordered_map<TplCtorClass, TplCtorClass> &) {}); 22012391Sjason@lowepower.com m.def("tpl_ctor_set", [](std::unordered_set<TplCtorClass> &) {}); 22112391Sjason@lowepower.com#if defined(PYBIND11_HAS_OPTIONAL) 22212391Sjason@lowepower.com m.def("tpl_constr_optional", [](std::optional<TplCtorClass> &) {}); 22312391Sjason@lowepower.com#elif defined(PYBIND11_HAS_EXP_OPTIONAL) 22412391Sjason@lowepower.com m.def("tpl_constr_optional", [](std::experimental::optional<TplCtorClass> &) {}); 22512391Sjason@lowepower.com#endif 22612391Sjason@lowepower.com 22712391Sjason@lowepower.com // test_vec_of_reference_wrapper 22812391Sjason@lowepower.com // #171: Can't return STL structures containing reference wrapper 22912391Sjason@lowepower.com m.def("return_vec_of_reference_wrapper", [](std::reference_wrapper<UserType> p4) { 23012391Sjason@lowepower.com static UserType p1{1}, p2{2}, p3{3}; 23112391Sjason@lowepower.com return std::vector<std::reference_wrapper<UserType>> { 23212391Sjason@lowepower.com std::ref(p1), std::ref(p2), std::ref(p3), p4 23312391Sjason@lowepower.com }; 23412391Sjason@lowepower.com }); 23512391Sjason@lowepower.com 23612391Sjason@lowepower.com // test_stl_pass_by_pointer 23712391Sjason@lowepower.com m.def("stl_pass_by_pointer", [](std::vector<int>* v) { return *v; }, "v"_a=nullptr); 23812391Sjason@lowepower.com} 239