2 * Copyright 2017 Facebook, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 #include <folly/MapUtil.h>
21 #include <unordered_map>
23 #include <folly/Traits.h>
24 #include <folly/portability/GTest.h>
26 using namespace folly;
28 TEST(MapUtil, get_default) {
31 EXPECT_EQ(2, get_default(m, 1, 42));
32 EXPECT_EQ(42, get_default(m, 2, 42));
33 EXPECT_EQ(0, get_default(m, 3));
36 TEST(MapUtil, get_default_function) {
39 EXPECT_EQ(2, get_default(m, 1, [] { return 42; }));
40 EXPECT_EQ(42, get_default(m, 2, [] { return 42; }));
41 EXPECT_EQ(0, get_default(m, 3));
44 TEST(MapUtil, get_or_throw) {
47 EXPECT_EQ(2, get_or_throw(m, 1));
48 EXPECT_THROW(get_or_throw(m, 2), std::out_of_range);
49 EXPECT_EQ(&m[1], &get_or_throw(m, 1));
50 get_or_throw(m, 1) = 3;
51 EXPECT_EQ(3, get_or_throw(m, 1));
53 EXPECT_EQ(&m[1], &get_or_throw(cm, 1));
54 EXPECT_EQ(3, get_or_throw(cm, 1));
55 EXPECT_THROW(get_or_throw(cm, 2), std::out_of_range);
58 TEST(MapUtil, get_or_throw_specified) {
61 EXPECT_EQ(2, get_or_throw<std::runtime_error>(m, 1));
62 EXPECT_THROW(get_or_throw<std::runtime_error>(m, 2), std::runtime_error);
65 TEST(MapUtil, get_optional) {
68 EXPECT_TRUE(get_optional(m, 1).hasValue());
69 EXPECT_EQ(2, get_optional(m, 1).value());
70 EXPECT_FALSE(get_optional(m, 2).hasValue());
73 TEST(MapUtil, get_ref_default) {
77 EXPECT_EQ(2, get_ref_default(m, 1, i));
78 EXPECT_EQ(42, get_ref_default(m, 2, i));
79 EXPECT_EQ(std::addressof(i), std::addressof(get_ref_default(m, 2, i)));
82 TEST(MapUtil, get_ref_default_function) {
86 EXPECT_EQ(2, get_ref_default(m, 1, [&i]() -> const int& { return i; }));
87 EXPECT_EQ(42, get_ref_default(m, 2, [&i]() -> const int& { return i; }));
91 get_ref_default(m, 2, [&i]() -> const int& { return i; })));
92 // statically disallowed:
93 // get_ref_default(m, 2, [] { return 7; });
96 TEST(MapUtil, get_ptr) {
99 EXPECT_EQ(2, *get_ptr(m, 1));
100 EXPECT_TRUE(get_ptr(m, 2) == nullptr);
102 EXPECT_EQ(4, m.at(1));
105 TEST(MapUtil, get_ptr_path_simple) {
107 map<int, map<int, map<int, map<int, int>>>> m{{1, {{2, {{3, {{4, 5}}}}}}}};
108 EXPECT_EQ(5, *get_ptr(m, 1, 2, 3, 4));
109 EXPECT_TRUE(get_ptr(m, 1, 2, 3, 4));
110 EXPECT_FALSE(get_ptr(m, 1, 2, 3, 0));
111 EXPECT_TRUE(get_ptr(m, 1, 2, 3));
112 EXPECT_FALSE(get_ptr(m, 1, 2, 0));
113 EXPECT_TRUE(get_ptr(m, 1, 2));
114 EXPECT_FALSE(get_ptr(m, 1, 0));
115 EXPECT_TRUE(get_ptr(m, 1));
116 EXPECT_FALSE(get_ptr(m, 0));
118 ++*get_ptr(m, 1, 2, 3, 4);
119 EXPECT_EQ(6, *get_ptr(cm, 1, 2, 3, 4));
120 EXPECT_TRUE(get_ptr(cm, 1, 2, 3, 4));
121 EXPECT_FALSE(get_ptr(cm, 1, 2, 3, 0));
124 TEST(MapUtil, get_ptr_path_mixed) {
126 using std::unordered_map;
128 unordered_map<string, map<int, map<string, int>>> m{{"a", {{1, {{"b", 7}}}}}};
129 EXPECT_EQ(7, *get_ptr(m, "a", 1, "b"));
130 EXPECT_TRUE(get_ptr(m, "a", 1, "b"));
131 EXPECT_FALSE(get_ptr(m, "b", 1, "b"));
132 EXPECT_FALSE(get_ptr(m, "a", 2, "b"));
133 EXPECT_FALSE(get_ptr(m, "a", 1, "c"));
134 EXPECT_TRUE(get_ptr(m, "a", 1, "b"));
135 EXPECT_TRUE(get_ptr(m, "a", 1));
136 EXPECT_TRUE(get_ptr(m, "a"));
138 ++*get_ptr(m, "a", 1, "b");
139 EXPECT_EQ(8, *get_ptr(cm, "a", 1, "b"));
140 EXPECT_TRUE(get_ptr(cm, "a", 1, "b"));
141 EXPECT_FALSE(get_ptr(cm, "b", 1, "b"));
145 template <typename T>
146 struct element_type {
147 using type = typename std::decay<T>::type;
150 template <typename T>
151 struct element_type<T()> {
155 template <typename T>
156 using element_type_t = typename element_type<T>::type;
158 template <typename T, typename = void>
159 struct Compiles : std::false_type {};
161 template <typename T>
164 void_t<decltype(get_ref_default(
165 std::declval<std::map<int, element_type_t<T>>>(),
167 std::declval<T>()))>> : std::true_type {};
170 TEST(MapUtil, get_default_temporary) {
171 EXPECT_TRUE(Compiles<const int&>::value);
172 EXPECT_TRUE(Compiles<int&>::value);
173 EXPECT_FALSE(Compiles<const int&&>::value);
174 EXPECT_FALSE(Compiles<int&&>::value);
176 EXPECT_TRUE(Compiles<const int&()>::value);
177 EXPECT_TRUE(Compiles<int&()>::value);
178 EXPECT_FALSE(Compiles<int()>::value);
181 TEST(MapUtil, get_default_path) {
183 map<int, map<int, int>> m;
185 EXPECT_EQ(42, get_default(m, 4, 2, 42));
186 EXPECT_EQ(42, get_default(m, 1, 3, 42));
189 TEST(MapUtil, get_default_path_mixed) {
191 using std::unordered_map;
193 map<int, unordered_map<string, StringPiece>> m;
195 const string key2 = "hello";
196 constexpr StringPiece value = "world";
197 constexpr StringPiece dflt = "default";
198 m[key1][key2] = value;
199 EXPECT_EQ(value, get_default(m, 42, key2, dflt));
200 EXPECT_EQ(value, get_default(m, key1, "hello", dflt));
201 EXPECT_EQ(dflt, get_default(m, 0, key2, dflt));
202 EXPECT_EQ(dflt, get_default(m, key1, "bad", "default"));
205 TEST(MapUtil, get_ref_default_path) {
207 map<int, map<int, int>> m;
210 EXPECT_EQ(42, get_ref_default(m, 4, 2, dflt));
211 EXPECT_EQ(dflt, get_ref_default(m, 1, 3, dflt));
214 TEST(MapUtil, get_ref_default_path_mixed) {
216 using std::unordered_map;
218 map<int, unordered_map<string, StringPiece>> m;
220 const string key2 = "hello";
221 constexpr StringPiece value = "world";
222 constexpr StringPiece dflt = "default";
223 m[key1][key2] = value;
224 EXPECT_EQ(value, get_ref_default(m, 42, key2, dflt));
225 EXPECT_EQ(value, get_ref_default(m, key1, "hello", dflt));
226 EXPECT_EQ(dflt, get_ref_default(m, 0, key2, dflt));
227 EXPECT_EQ(dflt, get_ref_default(m, key1, "bad", dflt));
231 template <typename T, typename = void>
232 struct GetRefDefaultPathCompiles : std::false_type {};
234 template <typename T>
235 struct GetRefDefaultPathCompiles<
237 void_t<decltype(get_ref_default(
238 std::declval<std::map<int, std::map<int, element_type_t<T>>>>(),
241 std::declval<T>()))>> : std::true_type {};
244 TEST(MapUtil, get_ref_default_path_temporary) {
245 EXPECT_TRUE(GetRefDefaultPathCompiles<const int&>::value);
246 EXPECT_TRUE(GetRefDefaultPathCompiles<int&>::value);
247 EXPECT_FALSE(GetRefDefaultPathCompiles<const int&&>::value);
248 EXPECT_FALSE(GetRefDefaultPathCompiles<int&&>::value);
253 class TestConstruction {
258 TestConstruction(TestConstruction&&) {
261 TestConstruction(const TestConstruction&) {
265 explicit TestConstruction(std::string&& string)
266 : string_{std::move(string)} {}
267 explicit TestConstruction(int&& integer) : integer_{integer} {}
269 TestConstruction& operator=(const TestConstruction&) = delete;
270 TestConstruction& operator=(TestConstruction&&) = delete;
273 std::string string_{};
278 TEST(MapUtil, test_get_default_deferred_construction) {
279 auto map = std::unordered_map<int, TestConstruction>{};
281 std::piecewise_construct,
282 std::forward_as_tuple(1),
283 std::forward_as_tuple(1));
285 EXPECT_EQ(map.at(1).integer_, 1);
288 auto val = get_default(map, 0, 1);
289 EXPECT_EQ(val.integer_, 1);
290 EXPECT_EQ(val.string_, "");
294 auto val = get_default(map, 0, "something");
295 EXPECT_EQ(val.integer_, 0);
296 EXPECT_EQ(val.string_, "something");