File: | usr/src/googletest/googletest/include/gtest/gtest.h |
Warning: | line 1527, column 11 The right operand of '==' is a garbage value |
Press '?' to see keyboard shortcuts
Keyboard shortcuts:
1 | // Copyright (C) 2016-2023 Internet Systems Consortium, Inc. ("ISC") | |||
2 | // | |||
3 | // This Source Code Form is subject to the terms of the Mozilla Public | |||
4 | // License, v. 2.0. If a copy of the MPL was not distributed with this | |||
5 | // file, You can obtain one at http://mozilla.org/MPL/2.0/. | |||
6 | ||||
7 | #include <config.h> | |||
8 | ||||
9 | #include <stdint.h> | |||
10 | #include <cc/simple_parser.h> | |||
11 | #include <gtest/gtest.h> | |||
12 | ||||
13 | using namespace isc; | |||
14 | using namespace isc::data; | |||
15 | using namespace isc::asiolink; | |||
16 | using isc::dhcp::DhcpConfigError; | |||
17 | ||||
18 | /// This list defines required keywords. | |||
19 | const SimpleRequiredKeywords REQUIRED_KEYWORDS = { "foobar" }; | |||
20 | ||||
21 | /// This table defines keywords and types. | |||
22 | const SimpleKeywords KEYWORDS = { | |||
23 | { "id", Element::integer }, | |||
24 | { "prefix", Element::string }, | |||
25 | { "map", Element::map }, | |||
26 | { "any", Element::any } | |||
27 | }; | |||
28 | ||||
29 | /// This table defines sample default values. Although these are DHCPv6 | |||
30 | /// specific, the mechanism is generic and can be used by any other component. | |||
31 | const SimpleDefaults SAMPLE_DEFAULTS = { | |||
32 | { "renew-timer", Element::integer, "900" }, | |||
33 | { "rebind-timer", Element::integer, "1800" }, | |||
34 | { "preferred-lifetime", Element::integer, "3600" }, | |||
35 | { "valid-lifetime", Element::integer, "7200" } | |||
36 | }; | |||
37 | ||||
38 | /// This list defines parameters that can be inherited from one scope | |||
39 | /// to another. Although these are DHCPv6 specific, the mechanism is generic and | |||
40 | /// can be used by any other component. | |||
41 | const ParamsList SAMPLE_INHERITS = { | |||
42 | "renew-timer", | |||
43 | "rebind-timer", | |||
44 | "preferred-lifetime", | |||
45 | "valid-lifetime" | |||
46 | }; | |||
47 | ||||
48 | /// @brief Simple Parser test fixture class | |||
49 | class SimpleParserTest : public ::testing::Test { | |||
50 | public: | |||
51 | /// @brief Checks if specified map has an integer parameter with expected value | |||
52 | /// | |||
53 | /// @param map map to be checked | |||
54 | /// @param param_name name of the parameter to be checked | |||
55 | /// @param exp_value expected value of the parameter. | |||
56 | void checkIntegerValue(const ConstElementPtr& map, const std::string& param_name, | |||
57 | int64_t exp_value) { | |||
58 | ||||
59 | // First check if the passed element is a map. | |||
60 | ASSERT_EQ(Element::map, map->getType())switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::EqHelper::Compare("Element::map" , "map->getType()", Element::map, map->getType()))) ; else return ::testing::internal::AssertHelper(::testing::TestPartResult ::kFatalFailure, "simple_parser_unittest.cc", 60, gtest_ar.failure_message ()) = ::testing::Message(); | |||
61 | ||||
62 | // Now try to get the element being checked | |||
63 | ConstElementPtr elem = map->get(param_name); | |||
64 | ASSERT_TRUE(elem)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar_ = ::testing::AssertionResult(elem)) ; else return :: testing::internal::AssertHelper(::testing::TestPartResult::kFatalFailure , "simple_parser_unittest.cc", 64, ::testing::internal::GetBoolAssertionFailureMessage ( gtest_ar_, "elem", "false", "true").c_str()) = ::testing::Message (); | |||
65 | ||||
66 | // Now check if it's indeed integer | |||
67 | ASSERT_EQ(Element::integer, elem->getType())switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::EqHelper::Compare("Element::integer" , "elem->getType()", Element::integer, elem->getType()) )) ; else return ::testing::internal::AssertHelper(::testing:: TestPartResult::kFatalFailure, "simple_parser_unittest.cc", 67 , gtest_ar.failure_message()) = ::testing::Message(); | |||
68 | ||||
69 | // Finally, check if its value meets expectation. | |||
70 | EXPECT_EQ(exp_value, elem->intValue())switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::EqHelper::Compare("exp_value" , "elem->intValue()", exp_value, elem->intValue()))) ; else ::testing::internal::AssertHelper(::testing::TestPartResult:: kNonFatalFailure, "simple_parser_unittest.cc", 70, gtest_ar.failure_message ()) = ::testing::Message(); | |||
71 | } | |||
72 | }; | |||
73 | ||||
74 | class SimpleParserClassTest : public SimpleParser { | |||
75 | public: | |||
76 | /// @brief Instantiation of getAndConvert | |||
77 | /// | |||
78 | /// @param scope specified parameter will be extracted from this scope | |||
79 | /// @param name name of the parameter for error report | |||
80 | /// @return a bool value | |||
81 | bool getAsBool(ConstElementPtr scope, const std::string& name) { | |||
82 | return (getAndConvert<bool, toBool>(scope, name, "boolean")); | |||
83 | } | |||
84 | ||||
85 | /// @brief Convert to boolean | |||
86 | /// | |||
87 | /// @param str the string "false" or "true" | |||
88 | /// @return false for "false" and true for "true" | |||
89 | /// @thrown isc::OutOfRange if not "false" or "true' | |||
90 | static bool toBool(const std::string& str) { | |||
91 | if (str == "false") { | |||
92 | return (false); | |||
93 | } else if (str == "true") { | |||
94 | return (true); | |||
95 | } else { | |||
96 | isc_throw(TypeError, "not a boolean: " << str)do { std::ostringstream oss__; oss__ << "not a boolean: " << str; throw TypeError("simple_parser_unittest.cc", 96 , oss__.str().c_str()); } while (1); | |||
97 | } | |||
98 | } | |||
99 | }; | |||
100 | ||||
101 | // This test checks if the checkRequired method works as expected. | |||
102 | TEST_F(SimpleParserTest, checkRequired)static_assert(sizeof("SimpleParserTest") > 1, "test_suite_name must not be empty" ); static_assert(sizeof("checkRequired") > 1, "test_name must not be empty" ); class SimpleParserTest_checkRequired_Test : public SimpleParserTest { public: SimpleParserTest_checkRequired_Test() {} private: virtual void TestBody(); static ::testing::TestInfo* const test_info_ __attribute__ ((unused)); SimpleParserTest_checkRequired_Test (SimpleParserTest_checkRequired_Test const &) = delete; void operator=(SimpleParserTest_checkRequired_Test const &) = delete; }; ::testing::TestInfo* const SimpleParserTest_checkRequired_Test ::test_info_ = ::testing::internal::MakeAndRegisterTestInfo( "SimpleParserTest" , "checkRequired", nullptr, nullptr, ::testing::internal::CodeLocation ("simple_parser_unittest.cc", 102), (::testing::internal::GetTypeId <SimpleParserTest>()), ::testing::internal::SuiteApiResolver < SimpleParserTest>::GetSetUpCaseOrSuite("simple_parser_unittest.cc" , 102), ::testing::internal::SuiteApiResolver< SimpleParserTest >::GetTearDownCaseOrSuite("simple_parser_unittest.cc", 102 ), new ::testing::internal::TestFactoryImpl<SimpleParserTest_checkRequired_Test >); void SimpleParserTest_checkRequired_Test::TestBody() { | |||
103 | ConstElementPtr empty = Element::fromJSON("{ }"); | |||
104 | EXPECT_THROW(SimpleParser::checkRequired(REQUIRED_KEYWORDS, empty),switch (0) case 0: default: if (::testing::internal::ConstCharPtr gtest_msg = "") { bool gtest_caught_expected = false; try { if (::testing::internal::AlwaysTrue()) { SimpleParser::checkRequired (REQUIRED_KEYWORDS, empty); }; } catch (DhcpConfigError const &) { gtest_caught_expected = true; } catch (...) { gtest_msg .value = "Expected: " "SimpleParser::checkRequired(REQUIRED_KEYWORDS, empty)" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws a different type." ; goto gtest_label_testthrow_105; } if (!gtest_caught_expected ) { gtest_msg.value = "Expected: " "SimpleParser::checkRequired(REQUIRED_KEYWORDS, empty)" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws nothing." ; goto gtest_label_testthrow_105; } } else gtest_label_testthrow_105 : ::testing::internal::AssertHelper(::testing::TestPartResult ::kNonFatalFailure, "simple_parser_unittest.cc", 105, gtest_msg .value) = ::testing::Message() | |||
105 | DhcpConfigError)switch (0) case 0: default: if (::testing::internal::ConstCharPtr gtest_msg = "") { bool gtest_caught_expected = false; try { if (::testing::internal::AlwaysTrue()) { SimpleParser::checkRequired (REQUIRED_KEYWORDS, empty); }; } catch (DhcpConfigError const &) { gtest_caught_expected = true; } catch (...) { gtest_msg .value = "Expected: " "SimpleParser::checkRequired(REQUIRED_KEYWORDS, empty)" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws a different type." ; goto gtest_label_testthrow_105; } if (!gtest_caught_expected ) { gtest_msg.value = "Expected: " "SimpleParser::checkRequired(REQUIRED_KEYWORDS, empty)" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws nothing." ; goto gtest_label_testthrow_105; } } else gtest_label_testthrow_105 : ::testing::internal::AssertHelper(::testing::TestPartResult ::kNonFatalFailure, "simple_parser_unittest.cc", 105, gtest_msg .value) = ::testing::Message(); | |||
106 | ConstElementPtr other = Element::fromJSON("{ \"foo\": 1, \"bar\": 2 }"); | |||
107 | EXPECT_THROW(SimpleParser::checkRequired(REQUIRED_KEYWORDS, other),switch (0) case 0: default: if (::testing::internal::ConstCharPtr gtest_msg = "") { bool gtest_caught_expected = false; try { if (::testing::internal::AlwaysTrue()) { SimpleParser::checkRequired (REQUIRED_KEYWORDS, other); }; } catch (DhcpConfigError const &) { gtest_caught_expected = true; } catch (...) { gtest_msg .value = "Expected: " "SimpleParser::checkRequired(REQUIRED_KEYWORDS, other)" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws a different type." ; goto gtest_label_testthrow_108; } if (!gtest_caught_expected ) { gtest_msg.value = "Expected: " "SimpleParser::checkRequired(REQUIRED_KEYWORDS, other)" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws nothing." ; goto gtest_label_testthrow_108; } } else gtest_label_testthrow_108 : ::testing::internal::AssertHelper(::testing::TestPartResult ::kNonFatalFailure, "simple_parser_unittest.cc", 108, gtest_msg .value) = ::testing::Message() | |||
108 | DhcpConfigError)switch (0) case 0: default: if (::testing::internal::ConstCharPtr gtest_msg = "") { bool gtest_caught_expected = false; try { if (::testing::internal::AlwaysTrue()) { SimpleParser::checkRequired (REQUIRED_KEYWORDS, other); }; } catch (DhcpConfigError const &) { gtest_caught_expected = true; } catch (...) { gtest_msg .value = "Expected: " "SimpleParser::checkRequired(REQUIRED_KEYWORDS, other)" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws a different type." ; goto gtest_label_testthrow_108; } if (!gtest_caught_expected ) { gtest_msg.value = "Expected: " "SimpleParser::checkRequired(REQUIRED_KEYWORDS, other)" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws nothing." ; goto gtest_label_testthrow_108; } } else gtest_label_testthrow_108 : ::testing::internal::AssertHelper(::testing::TestPartResult ::kNonFatalFailure, "simple_parser_unittest.cc", 108, gtest_msg .value) = ::testing::Message(); | |||
109 | ConstElementPtr good = Element::fromJSON("{ \"foobar\": 2 }"); | |||
110 | EXPECT_NO_THROW(SimpleParser::checkRequired(REQUIRED_KEYWORDS, good))switch (0) case 0: default: if (::testing::internal::AlwaysTrue ()) { try { if (::testing::internal::AlwaysTrue()) { SimpleParser ::checkRequired(REQUIRED_KEYWORDS, good); }; } catch (...) { goto gtest_label_testnothrow_110; } } else gtest_label_testnothrow_110 : ::testing::internal::AssertHelper(::testing::TestPartResult ::kNonFatalFailure, "simple_parser_unittest.cc", 110, "Expected: " "SimpleParser::checkRequired(REQUIRED_KEYWORDS, good)" " doesn't throw an exception.\n" " Actual: it throws.") = ::testing::Message(); | |||
111 | } | |||
112 | ||||
113 | // This test checks if the checkKeywords method works as expected. | |||
114 | TEST_F(SimpleParserTest, checkKeywords)static_assert(sizeof("SimpleParserTest") > 1, "test_suite_name must not be empty" ); static_assert(sizeof("checkKeywords") > 1, "test_name must not be empty" ); class SimpleParserTest_checkKeywords_Test : public SimpleParserTest { public: SimpleParserTest_checkKeywords_Test() {} private: virtual void TestBody(); static ::testing::TestInfo* const test_info_ __attribute__ ((unused)); SimpleParserTest_checkKeywords_Test (SimpleParserTest_checkKeywords_Test const &) = delete; void operator=(SimpleParserTest_checkKeywords_Test const &) = delete; }; ::testing::TestInfo* const SimpleParserTest_checkKeywords_Test ::test_info_ = ::testing::internal::MakeAndRegisterTestInfo( "SimpleParserTest" , "checkKeywords", nullptr, nullptr, ::testing::internal::CodeLocation ("simple_parser_unittest.cc", 114), (::testing::internal::GetTypeId <SimpleParserTest>()), ::testing::internal::SuiteApiResolver < SimpleParserTest>::GetSetUpCaseOrSuite("simple_parser_unittest.cc" , 114), ::testing::internal::SuiteApiResolver< SimpleParserTest >::GetTearDownCaseOrSuite("simple_parser_unittest.cc", 114 ), new ::testing::internal::TestFactoryImpl<SimpleParserTest_checkKeywords_Test >); void SimpleParserTest_checkKeywords_Test::TestBody() { | |||
115 | ConstElementPtr empty = Element::fromJSON("{ }"); | |||
116 | EXPECT_NO_THROW(SimpleParser::checkKeywords(KEYWORDS, empty))switch (0) case 0: default: if (::testing::internal::AlwaysTrue ()) { try { if (::testing::internal::AlwaysTrue()) { SimpleParser ::checkKeywords(KEYWORDS, empty); }; } catch (...) { goto gtest_label_testnothrow_116 ; } } else gtest_label_testnothrow_116: ::testing::internal:: AssertHelper(::testing::TestPartResult::kNonFatalFailure, "simple_parser_unittest.cc" , 116, "Expected: " "SimpleParser::checkKeywords(KEYWORDS, empty)" " doesn't throw an exception.\n" " Actual: it throws.") = :: testing::Message(); | |||
117 | ConstElementPtr id = Element::fromJSON("{ \"id\": 1 }"); | |||
118 | EXPECT_NO_THROW(SimpleParser::checkKeywords(KEYWORDS, id))switch (0) case 0: default: if (::testing::internal::AlwaysTrue ()) { try { if (::testing::internal::AlwaysTrue()) { SimpleParser ::checkKeywords(KEYWORDS, id); }; } catch (...) { goto gtest_label_testnothrow_118 ; } } else gtest_label_testnothrow_118: ::testing::internal:: AssertHelper(::testing::TestPartResult::kNonFatalFailure, "simple_parser_unittest.cc" , 118, "Expected: " "SimpleParser::checkKeywords(KEYWORDS, id)" " doesn't throw an exception.\n" " Actual: it throws.") = :: testing::Message(); | |||
119 | ConstElementPtr any = Element::fromJSON("{ \"any\": 1 }"); | |||
120 | EXPECT_NO_THROW(SimpleParser::checkKeywords(KEYWORDS, any))switch (0) case 0: default: if (::testing::internal::AlwaysTrue ()) { try { if (::testing::internal::AlwaysTrue()) { SimpleParser ::checkKeywords(KEYWORDS, any); }; } catch (...) { goto gtest_label_testnothrow_120 ; } } else gtest_label_testnothrow_120: ::testing::internal:: AssertHelper(::testing::TestPartResult::kNonFatalFailure, "simple_parser_unittest.cc" , 120, "Expected: " "SimpleParser::checkKeywords(KEYWORDS, any)" " doesn't throw an exception.\n" " Actual: it throws.") = :: testing::Message(); | |||
121 | ConstElementPtr bad_id = Element::fromJSON("{ \"id\": true }"); | |||
122 | EXPECT_THROW(SimpleParser::checkKeywords(KEYWORDS, bad_id),switch (0) case 0: default: if (::testing::internal::ConstCharPtr gtest_msg = "") { bool gtest_caught_expected = false; try { if (::testing::internal::AlwaysTrue()) { SimpleParser::checkKeywords (KEYWORDS, bad_id); }; } catch (DhcpConfigError const&) { gtest_caught_expected = true; } catch (...) { gtest_msg.value = "Expected: " "SimpleParser::checkKeywords(KEYWORDS, bad_id)" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws a different type." ; goto gtest_label_testthrow_123; } if (!gtest_caught_expected ) { gtest_msg.value = "Expected: " "SimpleParser::checkKeywords(KEYWORDS, bad_id)" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws nothing." ; goto gtest_label_testthrow_123; } } else gtest_label_testthrow_123 : ::testing::internal::AssertHelper(::testing::TestPartResult ::kNonFatalFailure, "simple_parser_unittest.cc", 123, gtest_msg .value) = ::testing::Message() | |||
123 | DhcpConfigError)switch (0) case 0: default: if (::testing::internal::ConstCharPtr gtest_msg = "") { bool gtest_caught_expected = false; try { if (::testing::internal::AlwaysTrue()) { SimpleParser::checkKeywords (KEYWORDS, bad_id); }; } catch (DhcpConfigError const&) { gtest_caught_expected = true; } catch (...) { gtest_msg.value = "Expected: " "SimpleParser::checkKeywords(KEYWORDS, bad_id)" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws a different type." ; goto gtest_label_testthrow_123; } if (!gtest_caught_expected ) { gtest_msg.value = "Expected: " "SimpleParser::checkKeywords(KEYWORDS, bad_id)" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws nothing." ; goto gtest_label_testthrow_123; } } else gtest_label_testthrow_123 : ::testing::internal::AssertHelper(::testing::TestPartResult ::kNonFatalFailure, "simple_parser_unittest.cc", 123, gtest_msg .value) = ::testing::Message(); | |||
124 | ConstElementPtr bad_prefix = Element::fromJSON("{ \"prefix\": 12 }"); | |||
125 | EXPECT_THROW(SimpleParser::checkKeywords(KEYWORDS, bad_prefix),switch (0) case 0: default: if (::testing::internal::ConstCharPtr gtest_msg = "") { bool gtest_caught_expected = false; try { if (::testing::internal::AlwaysTrue()) { SimpleParser::checkKeywords (KEYWORDS, bad_prefix); }; } catch (DhcpConfigError const& ) { gtest_caught_expected = true; } catch (...) { gtest_msg.value = "Expected: " "SimpleParser::checkKeywords(KEYWORDS, bad_prefix)" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws a different type." ; goto gtest_label_testthrow_126; } if (!gtest_caught_expected ) { gtest_msg.value = "Expected: " "SimpleParser::checkKeywords(KEYWORDS, bad_prefix)" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws nothing." ; goto gtest_label_testthrow_126; } } else gtest_label_testthrow_126 : ::testing::internal::AssertHelper(::testing::TestPartResult ::kNonFatalFailure, "simple_parser_unittest.cc", 126, gtest_msg .value) = ::testing::Message() | |||
126 | DhcpConfigError)switch (0) case 0: default: if (::testing::internal::ConstCharPtr gtest_msg = "") { bool gtest_caught_expected = false; try { if (::testing::internal::AlwaysTrue()) { SimpleParser::checkKeywords (KEYWORDS, bad_prefix); }; } catch (DhcpConfigError const& ) { gtest_caught_expected = true; } catch (...) { gtest_msg.value = "Expected: " "SimpleParser::checkKeywords(KEYWORDS, bad_prefix)" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws a different type." ; goto gtest_label_testthrow_126; } if (!gtest_caught_expected ) { gtest_msg.value = "Expected: " "SimpleParser::checkKeywords(KEYWORDS, bad_prefix)" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws nothing." ; goto gtest_label_testthrow_126; } } else gtest_label_testthrow_126 : ::testing::internal::AssertHelper(::testing::TestPartResult ::kNonFatalFailure, "simple_parser_unittest.cc", 126, gtest_msg .value) = ::testing::Message(); | |||
127 | ConstElementPtr bad_map = Element::fromJSON("{ \"map\": [ ] }"); | |||
128 | EXPECT_THROW(SimpleParser::checkKeywords(KEYWORDS, bad_map),switch (0) case 0: default: if (::testing::internal::ConstCharPtr gtest_msg = "") { bool gtest_caught_expected = false; try { if (::testing::internal::AlwaysTrue()) { SimpleParser::checkKeywords (KEYWORDS, bad_map); }; } catch (DhcpConfigError const&) { gtest_caught_expected = true; } catch (...) { gtest_msg.value = "Expected: " "SimpleParser::checkKeywords(KEYWORDS, bad_map)" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws a different type." ; goto gtest_label_testthrow_129; } if (!gtest_caught_expected ) { gtest_msg.value = "Expected: " "SimpleParser::checkKeywords(KEYWORDS, bad_map)" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws nothing." ; goto gtest_label_testthrow_129; } } else gtest_label_testthrow_129 : ::testing::internal::AssertHelper(::testing::TestPartResult ::kNonFatalFailure, "simple_parser_unittest.cc", 129, gtest_msg .value) = ::testing::Message() | |||
129 | DhcpConfigError)switch (0) case 0: default: if (::testing::internal::ConstCharPtr gtest_msg = "") { bool gtest_caught_expected = false; try { if (::testing::internal::AlwaysTrue()) { SimpleParser::checkKeywords (KEYWORDS, bad_map); }; } catch (DhcpConfigError const&) { gtest_caught_expected = true; } catch (...) { gtest_msg.value = "Expected: " "SimpleParser::checkKeywords(KEYWORDS, bad_map)" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws a different type." ; goto gtest_label_testthrow_129; } if (!gtest_caught_expected ) { gtest_msg.value = "Expected: " "SimpleParser::checkKeywords(KEYWORDS, bad_map)" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws nothing." ; goto gtest_label_testthrow_129; } } else gtest_label_testthrow_129 : ::testing::internal::AssertHelper(::testing::TestPartResult ::kNonFatalFailure, "simple_parser_unittest.cc", 129, gtest_msg .value) = ::testing::Message(); | |||
130 | ConstElementPtr spurious = Element::fromJSON("{ \"spurious\": 1 }"); | |||
131 | EXPECT_THROW(SimpleParser::checkKeywords(KEYWORDS, spurious),switch (0) case 0: default: if (::testing::internal::ConstCharPtr gtest_msg = "") { bool gtest_caught_expected = false; try { if (::testing::internal::AlwaysTrue()) { SimpleParser::checkKeywords (KEYWORDS, spurious); }; } catch (DhcpConfigError const&) { gtest_caught_expected = true; } catch (...) { gtest_msg.value = "Expected: " "SimpleParser::checkKeywords(KEYWORDS, spurious)" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws a different type." ; goto gtest_label_testthrow_132; } if (!gtest_caught_expected ) { gtest_msg.value = "Expected: " "SimpleParser::checkKeywords(KEYWORDS, spurious)" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws nothing." ; goto gtest_label_testthrow_132; } } else gtest_label_testthrow_132 : ::testing::internal::AssertHelper(::testing::TestPartResult ::kNonFatalFailure, "simple_parser_unittest.cc", 132, gtest_msg .value) = ::testing::Message() | |||
132 | DhcpConfigError)switch (0) case 0: default: if (::testing::internal::ConstCharPtr gtest_msg = "") { bool gtest_caught_expected = false; try { if (::testing::internal::AlwaysTrue()) { SimpleParser::checkKeywords (KEYWORDS, spurious); }; } catch (DhcpConfigError const&) { gtest_caught_expected = true; } catch (...) { gtest_msg.value = "Expected: " "SimpleParser::checkKeywords(KEYWORDS, spurious)" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws a different type." ; goto gtest_label_testthrow_132; } if (!gtest_caught_expected ) { gtest_msg.value = "Expected: " "SimpleParser::checkKeywords(KEYWORDS, spurious)" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws nothing." ; goto gtest_label_testthrow_132; } } else gtest_label_testthrow_132 : ::testing::internal::AssertHelper(::testing::TestPartResult ::kNonFatalFailure, "simple_parser_unittest.cc", 132, gtest_msg .value) = ::testing::Message(); | |||
133 | ||||
134 | // Bad type has precedence. | |||
135 | ConstElementPtr bad = Element::fromJSON("{ \"spurious\": 1, \"id\": true }"); | |||
136 | try { | |||
137 | SimpleParser::checkKeywords(KEYWORDS, bad); | |||
138 | ADD_FAILURE()::testing::internal::AssertHelper(::testing::TestPartResult:: kNonFatalFailure, "simple_parser_unittest.cc", 138, "Failed") = ::testing::Message() << "expect exception"; | |||
139 | } catch (const DhcpConfigError& ex) { | |||
140 | EXPECT_EQ("'id' parameter is not an integer", std::string(ex.what()))switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::EqHelper::Compare("\"'id' parameter is not an integer\"" , "std::string(ex.what())", "'id' parameter is not an integer" , std::string(ex.what())))) ; else ::testing::internal::AssertHelper (::testing::TestPartResult::kNonFatalFailure, "simple_parser_unittest.cc" , 140, gtest_ar.failure_message()) = ::testing::Message(); | |||
141 | } catch (...) { | |||
142 | ADD_FAILURE()::testing::internal::AssertHelper(::testing::TestPartResult:: kNonFatalFailure, "simple_parser_unittest.cc", 142, "Failed") = ::testing::Message() << "expect DhcpConfigError"; | |||
143 | } | |||
144 | } | |||
145 | ||||
146 | // This test checks if the parameters can be inherited from the global | |||
147 | // scope to the subnet scope. | |||
148 | TEST_F(SimpleParserTest, deriveParams)static_assert(sizeof("SimpleParserTest") > 1, "test_suite_name must not be empty" ); static_assert(sizeof("deriveParams") > 1, "test_name must not be empty" ); class SimpleParserTest_deriveParams_Test : public SimpleParserTest { public: SimpleParserTest_deriveParams_Test() {} private: virtual void TestBody(); static ::testing::TestInfo* const test_info_ __attribute__ ((unused)); SimpleParserTest_deriveParams_Test (SimpleParserTest_deriveParams_Test const &) = delete; void operator=(SimpleParserTest_deriveParams_Test const &) = delete ; }; ::testing::TestInfo* const SimpleParserTest_deriveParams_Test ::test_info_ = ::testing::internal::MakeAndRegisterTestInfo( "SimpleParserTest" , "deriveParams", nullptr, nullptr, ::testing::internal::CodeLocation ("simple_parser_unittest.cc", 148), (::testing::internal::GetTypeId <SimpleParserTest>()), ::testing::internal::SuiteApiResolver < SimpleParserTest>::GetSetUpCaseOrSuite("simple_parser_unittest.cc" , 148), ::testing::internal::SuiteApiResolver< SimpleParserTest >::GetTearDownCaseOrSuite("simple_parser_unittest.cc", 148 ), new ::testing::internal::TestFactoryImpl<SimpleParserTest_deriveParams_Test >); void SimpleParserTest_deriveParams_Test::TestBody() { | |||
149 | ElementPtr global = Element::fromJSON("{ \"renew-timer\": 1," | |||
150 | " \"rebind-timer\": 2," | |||
151 | " \"preferred-lifetime\": 3," | |||
152 | " \"valid-lifetime\": 4" | |||
153 | "}"); | |||
154 | ElementPtr subnet = Element::fromJSON("{ \"renew-timer\": 100 }"); | |||
155 | ||||
156 | // we should inherit 3 parameters. Renew-timer should remain intact, | |||
157 | // as it was already defined in the subnet scope. | |||
158 | size_t num; | |||
159 | EXPECT_NO_THROW(num = SimpleParser::deriveParams(global, subnet,switch (0) case 0: default: if (::testing::internal::AlwaysTrue ()) { try { if (::testing::internal::AlwaysTrue()) { num = SimpleParser ::deriveParams(global, subnet, SAMPLE_INHERITS); }; } catch ( ...) { goto gtest_label_testnothrow_160; } } else gtest_label_testnothrow_160 : ::testing::internal::AssertHelper(::testing::TestPartResult ::kNonFatalFailure, "simple_parser_unittest.cc", 160, "Expected: " "num = SimpleParser::deriveParams(global, subnet, SAMPLE_INHERITS)" " doesn't throw an exception.\n" " Actual: it throws.") = :: testing::Message() | |||
160 | SAMPLE_INHERITS))switch (0) case 0: default: if (::testing::internal::AlwaysTrue ()) { try { if (::testing::internal::AlwaysTrue()) { num = SimpleParser ::deriveParams(global, subnet, SAMPLE_INHERITS); }; } catch ( ...) { goto gtest_label_testnothrow_160; } } else gtest_label_testnothrow_160 : ::testing::internal::AssertHelper(::testing::TestPartResult ::kNonFatalFailure, "simple_parser_unittest.cc", 160, "Expected: " "num = SimpleParser::deriveParams(global, subnet, SAMPLE_INHERITS)" " doesn't throw an exception.\n" " Actual: it throws.") = :: testing::Message(); | |||
161 | EXPECT_EQ(3, num)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::EqHelper::Compare("3", "num" , 3, num))) ; else ::testing::internal::AssertHelper(::testing ::TestPartResult::kNonFatalFailure, "simple_parser_unittest.cc" , 161, gtest_ar.failure_message()) = ::testing::Message(); | |||
162 | ||||
163 | // Check the values. 3 of them are inherited, while the fourth one | |||
164 | // was already defined in the subnet, so should not be inherited. | |||
165 | checkIntegerValue(subnet, "renew-timer", 100); | |||
166 | checkIntegerValue(subnet, "rebind-timer", 2); | |||
167 | checkIntegerValue(subnet, "preferred-lifetime", 3); | |||
168 | checkIntegerValue(subnet, "valid-lifetime", 4); | |||
169 | } | |||
170 | ||||
171 | // This test checks if global defaults are properly set for DHCPv6. | |||
172 | TEST_F(SimpleParserTest, setDefaults)static_assert(sizeof("SimpleParserTest") > 1, "test_suite_name must not be empty" ); static_assert(sizeof("setDefaults") > 1, "test_name must not be empty" ); class SimpleParserTest_setDefaults_Test : public SimpleParserTest { public: SimpleParserTest_setDefaults_Test() {} private: virtual void TestBody(); static ::testing::TestInfo* const test_info_ __attribute__ ((unused)); SimpleParserTest_setDefaults_Test( SimpleParserTest_setDefaults_Test const &) = delete; void operator=(SimpleParserTest_setDefaults_Test const &) = delete ; }; ::testing::TestInfo* const SimpleParserTest_setDefaults_Test ::test_info_ = ::testing::internal::MakeAndRegisterTestInfo( "SimpleParserTest" , "setDefaults", nullptr, nullptr, ::testing::internal::CodeLocation ("simple_parser_unittest.cc", 172), (::testing::internal::GetTypeId <SimpleParserTest>()), ::testing::internal::SuiteApiResolver < SimpleParserTest>::GetSetUpCaseOrSuite("simple_parser_unittest.cc" , 172), ::testing::internal::SuiteApiResolver< SimpleParserTest >::GetTearDownCaseOrSuite("simple_parser_unittest.cc", 172 ), new ::testing::internal::TestFactoryImpl<SimpleParserTest_setDefaults_Test >); void SimpleParserTest_setDefaults_Test::TestBody() { | |||
173 | ||||
174 | ElementPtr empty = Element::fromJSON("{ }"); | |||
175 | size_t num = 0; | |||
176 | ||||
177 | EXPECT_NO_THROW(num = SimpleParser::setDefaults(empty, SAMPLE_DEFAULTS))switch (0) case 0: default: if (::testing::internal::AlwaysTrue ()) { try { if (::testing::internal::AlwaysTrue()) { num = SimpleParser ::setDefaults(empty, SAMPLE_DEFAULTS); }; } catch (...) { goto gtest_label_testnothrow_177; } } else gtest_label_testnothrow_177 : ::testing::internal::AssertHelper(::testing::TestPartResult ::kNonFatalFailure, "simple_parser_unittest.cc", 177, "Expected: " "num = SimpleParser::setDefaults(empty, SAMPLE_DEFAULTS)" " doesn't throw an exception.\n" " Actual: it throws.") = ::testing::Message(); | |||
178 | ||||
179 | // We expect at least 4 parameters to be inserted. | |||
180 | EXPECT_GE(num, 3)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperGE("num", "3", num , 3))) ; else ::testing::internal::AssertHelper(::testing::TestPartResult ::kNonFatalFailure, "simple_parser_unittest.cc", 180, gtest_ar .failure_message()) = ::testing::Message(); | |||
181 | ||||
182 | checkIntegerValue(empty, "valid-lifetime", 7200); | |||
183 | checkIntegerValue(empty, "preferred-lifetime", 3600); | |||
184 | checkIntegerValue(empty, "rebind-timer", 1800); | |||
185 | checkIntegerValue(empty, "renew-timer", 900); | |||
186 | } | |||
187 | ||||
188 | // This test checks if global defaults are properly set for DHCPv6. | |||
189 | TEST_F(SimpleParserTest, setListDefaults)static_assert(sizeof("SimpleParserTest") > 1, "test_suite_name must not be empty" ); static_assert(sizeof("setListDefaults") > 1, "test_name must not be empty" ); class SimpleParserTest_setListDefaults_Test : public SimpleParserTest { public: SimpleParserTest_setListDefaults_Test() {} private : virtual void TestBody(); static ::testing::TestInfo* const test_info_ __attribute__ ((unused)); SimpleParserTest_setListDefaults_Test (SimpleParserTest_setListDefaults_Test const &) = delete; void operator=(SimpleParserTest_setListDefaults_Test const & ) = delete; }; ::testing::TestInfo* const SimpleParserTest_setListDefaults_Test ::test_info_ = ::testing::internal::MakeAndRegisterTestInfo( "SimpleParserTest" , "setListDefaults", nullptr, nullptr, ::testing::internal::CodeLocation ("simple_parser_unittest.cc", 189), (::testing::internal::GetTypeId <SimpleParserTest>()), ::testing::internal::SuiteApiResolver < SimpleParserTest>::GetSetUpCaseOrSuite("simple_parser_unittest.cc" , 189), ::testing::internal::SuiteApiResolver< SimpleParserTest >::GetTearDownCaseOrSuite("simple_parser_unittest.cc", 189 ), new ::testing::internal::TestFactoryImpl<SimpleParserTest_setListDefaults_Test >); void SimpleParserTest_setListDefaults_Test::TestBody() { | |||
190 | ||||
191 | ElementPtr empty = Element::fromJSON("[{}, {}, {}]"); | |||
192 | size_t num; | |||
| ||||
193 | ||||
194 | EXPECT_NO_THROW(num = SimpleParser::setListDefaults(empty, SAMPLE_DEFAULTS))switch (0) case 0: default: if (::testing::internal::AlwaysTrue ()) { try { if (::testing::internal::AlwaysTrue()) { num = SimpleParser ::setListDefaults(empty, SAMPLE_DEFAULTS); }; } catch (...) { goto gtest_label_testnothrow_194; } } else gtest_label_testnothrow_194 : ::testing::internal::AssertHelper(::testing::TestPartResult ::kNonFatalFailure, "simple_parser_unittest.cc", 194, "Expected: " "num = SimpleParser::setListDefaults(empty, SAMPLE_DEFAULTS)" " doesn't throw an exception.\n" " Actual: it throws.") = :: testing::Message(); | |||
195 | ||||
196 | // We expect at least 12 parameters to be inserted (3 entries, with | |||
197 | // 4 parameters inserted in each) | |||
198 | EXPECT_EQ(12, num)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::EqHelper::Compare("12", "num" , 12, num))) ; else ::testing::internal::AssertHelper(::testing ::TestPartResult::kNonFatalFailure, "simple_parser_unittest.cc" , 198, gtest_ar.failure_message()) = ::testing::Message(); | |||
199 | ||||
200 | ASSERT_EQ(Element::list, empty->getType())switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::EqHelper::Compare("Element::list" , "empty->getType()", Element::list, empty->getType())) ) ; else return ::testing::internal::AssertHelper(::testing:: TestPartResult::kFatalFailure, "simple_parser_unittest.cc", 200 , gtest_ar.failure_message()) = ::testing::Message(); | |||
201 | ASSERT_EQ(3, empty->size())switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::EqHelper::Compare("3", "empty->size()" , 3, empty->size()))) ; else return ::testing::internal::AssertHelper (::testing::TestPartResult::kFatalFailure, "simple_parser_unittest.cc" , 201, gtest_ar.failure_message()) = ::testing::Message(); | |||
202 | ||||
203 | ConstElementPtr first = empty->get(0); | |||
204 | ConstElementPtr second = empty->get(1); | |||
205 | ConstElementPtr third = empty->get(2); | |||
206 | ||||
207 | checkIntegerValue(first, "valid-lifetime", 7200); | |||
208 | checkIntegerValue(first, "preferred-lifetime", 3600); | |||
209 | checkIntegerValue(first, "rebind-timer", 1800); | |||
210 | checkIntegerValue(first, "renew-timer", 900); | |||
211 | ||||
212 | checkIntegerValue(second, "valid-lifetime", 7200); | |||
213 | checkIntegerValue(second, "preferred-lifetime", 3600); | |||
214 | checkIntegerValue(second, "rebind-timer", 1800); | |||
215 | checkIntegerValue(second, "renew-timer", 900); | |||
216 | ||||
217 | checkIntegerValue(third, "valid-lifetime", 7200); | |||
218 | checkIntegerValue(third, "preferred-lifetime", 3600); | |||
219 | checkIntegerValue(third, "rebind-timer", 1800); | |||
220 | checkIntegerValue(third, "renew-timer", 900); | |||
221 | } | |||
222 | ||||
223 | // This test exercises the getIntType template | |||
224 | TEST_F(SimpleParserTest, getIntType)static_assert(sizeof("SimpleParserTest") > 1, "test_suite_name must not be empty" ); static_assert(sizeof("getIntType") > 1, "test_name must not be empty" ); class SimpleParserTest_getIntType_Test : public SimpleParserTest { public: SimpleParserTest_getIntType_Test() {} private: virtual void TestBody(); static ::testing::TestInfo* const test_info_ __attribute__ ((unused)); SimpleParserTest_getIntType_Test(SimpleParserTest_getIntType_Test const &) = delete; void operator=(SimpleParserTest_getIntType_Test const &) = delete; }; ::testing::TestInfo* const SimpleParserTest_getIntType_Test ::test_info_ = ::testing::internal::MakeAndRegisterTestInfo( "SimpleParserTest" , "getIntType", nullptr, nullptr, ::testing::internal::CodeLocation ("simple_parser_unittest.cc", 224), (::testing::internal::GetTypeId <SimpleParserTest>()), ::testing::internal::SuiteApiResolver < SimpleParserTest>::GetSetUpCaseOrSuite("simple_parser_unittest.cc" , 224), ::testing::internal::SuiteApiResolver< SimpleParserTest >::GetTearDownCaseOrSuite("simple_parser_unittest.cc", 224 ), new ::testing::internal::TestFactoryImpl<SimpleParserTest_getIntType_Test >); void SimpleParserTest_getIntType_Test::TestBody() { | |||
225 | ||||
226 | SimpleParserClassTest parser; | |||
227 | ||||
228 | // getIntType checks it can be found | |||
229 | ElementPtr not_found = Element::fromJSON("{ \"bar\": 1 }"); | |||
230 | EXPECT_THROW(parser.getUint8(not_found, "foo"), DhcpConfigError)switch (0) case 0: default: if (::testing::internal::ConstCharPtr gtest_msg = "") { bool gtest_caught_expected = false; try { if (::testing::internal::AlwaysTrue()) { parser.getUint8(not_found , "foo"); }; } catch (DhcpConfigError const&) { gtest_caught_expected = true; } catch (...) { gtest_msg.value = "Expected: " "parser.getUint8(not_found, \"foo\")" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws a different type." ; goto gtest_label_testthrow_230; } if (!gtest_caught_expected ) { gtest_msg.value = "Expected: " "parser.getUint8(not_found, \"foo\")" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws nothing." ; goto gtest_label_testthrow_230; } } else gtest_label_testthrow_230 : ::testing::internal::AssertHelper(::testing::TestPartResult ::kNonFatalFailure, "simple_parser_unittest.cc", 230, gtest_msg .value) = ::testing::Message(); | |||
231 | ||||
232 | // getIntType checks if it is an integer | |||
233 | ElementPtr not_int = Element::fromJSON("{ \"foo\": \"xyz\" }"); | |||
234 | EXPECT_THROW(parser.getUint8(not_int, "foo"), DhcpConfigError)switch (0) case 0: default: if (::testing::internal::ConstCharPtr gtest_msg = "") { bool gtest_caught_expected = false; try { if (::testing::internal::AlwaysTrue()) { parser.getUint8(not_int , "foo"); }; } catch (DhcpConfigError const&) { gtest_caught_expected = true; } catch (...) { gtest_msg.value = "Expected: " "parser.getUint8(not_int, \"foo\")" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws a different type." ; goto gtest_label_testthrow_234; } if (!gtest_caught_expected ) { gtest_msg.value = "Expected: " "parser.getUint8(not_int, \"foo\")" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws nothing." ; goto gtest_label_testthrow_234; } } else gtest_label_testthrow_234 : ::testing::internal::AssertHelper(::testing::TestPartResult ::kNonFatalFailure, "simple_parser_unittest.cc", 234, gtest_msg .value) = ::testing::Message(); | |||
235 | ||||
236 | // getIntType checks bounds | |||
237 | ElementPtr negative = Element::fromJSON("{ \"foo\": -1 }"); | |||
238 | EXPECT_THROW(parser.getUint8(negative, "foo"), DhcpConfigError)switch (0) case 0: default: if (::testing::internal::ConstCharPtr gtest_msg = "") { bool gtest_caught_expected = false; try { if (::testing::internal::AlwaysTrue()) { parser.getUint8(negative , "foo"); }; } catch (DhcpConfigError const&) { gtest_caught_expected = true; } catch (...) { gtest_msg.value = "Expected: " "parser.getUint8(negative, \"foo\")" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws a different type." ; goto gtest_label_testthrow_238; } if (!gtest_caught_expected ) { gtest_msg.value = "Expected: " "parser.getUint8(negative, \"foo\")" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws nothing." ; goto gtest_label_testthrow_238; } } else gtest_label_testthrow_238 : ::testing::internal::AssertHelper(::testing::TestPartResult ::kNonFatalFailure, "simple_parser_unittest.cc", 238, gtest_msg .value) = ::testing::Message(); | |||
239 | ElementPtr too_large = Element::fromJSON("{ \"foo\": 1024 }"); | |||
240 | EXPECT_THROW(parser.getUint8(too_large, "foo"), DhcpConfigError)switch (0) case 0: default: if (::testing::internal::ConstCharPtr gtest_msg = "") { bool gtest_caught_expected = false; try { if (::testing::internal::AlwaysTrue()) { parser.getUint8(too_large , "foo"); }; } catch (DhcpConfigError const&) { gtest_caught_expected = true; } catch (...) { gtest_msg.value = "Expected: " "parser.getUint8(too_large, \"foo\")" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws a different type." ; goto gtest_label_testthrow_240; } if (!gtest_caught_expected ) { gtest_msg.value = "Expected: " "parser.getUint8(too_large, \"foo\")" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws nothing." ; goto gtest_label_testthrow_240; } } else gtest_label_testthrow_240 : ::testing::internal::AssertHelper(::testing::TestPartResult ::kNonFatalFailure, "simple_parser_unittest.cc", 240, gtest_msg .value) = ::testing::Message(); | |||
241 | ||||
242 | // checks if getIntType can return the expected value | |||
243 | ElementPtr hundred = Element::fromJSON("{ \"foo\": 100 }"); | |||
244 | uint8_t val = 0; | |||
245 | EXPECT_NO_THROW(val = parser.getUint8(hundred, "foo"))switch (0) case 0: default: if (::testing::internal::AlwaysTrue ()) { try { if (::testing::internal::AlwaysTrue()) { val = parser .getUint8(hundred, "foo"); }; } catch (...) { goto gtest_label_testnothrow_245 ; } } else gtest_label_testnothrow_245: ::testing::internal:: AssertHelper(::testing::TestPartResult::kNonFatalFailure, "simple_parser_unittest.cc" , 245, "Expected: " "val = parser.getUint8(hundred, \"foo\")" " doesn't throw an exception.\n" " Actual: it throws.") = :: testing::Message(); | |||
246 | EXPECT_EQ(100, val)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::EqHelper::Compare("100", "val" , 100, val))) ; else ::testing::internal::AssertHelper(::testing ::TestPartResult::kNonFatalFailure, "simple_parser_unittest.cc" , 246, gtest_ar.failure_message()) = ::testing::Message(); | |||
247 | } | |||
248 | ||||
249 | // This test exercises the getInteger with range checking | |||
250 | TEST_F(SimpleParserTest, getInteger)static_assert(sizeof("SimpleParserTest") > 1, "test_suite_name must not be empty" ); static_assert(sizeof("getInteger") > 1, "test_name must not be empty" ); class SimpleParserTest_getInteger_Test : public SimpleParserTest { public: SimpleParserTest_getInteger_Test() {} private: virtual void TestBody(); static ::testing::TestInfo* const test_info_ __attribute__ ((unused)); SimpleParserTest_getInteger_Test(SimpleParserTest_getInteger_Test const &) = delete; void operator=(SimpleParserTest_getInteger_Test const &) = delete; }; ::testing::TestInfo* const SimpleParserTest_getInteger_Test ::test_info_ = ::testing::internal::MakeAndRegisterTestInfo( "SimpleParserTest" , "getInteger", nullptr, nullptr, ::testing::internal::CodeLocation ("simple_parser_unittest.cc", 250), (::testing::internal::GetTypeId <SimpleParserTest>()), ::testing::internal::SuiteApiResolver < SimpleParserTest>::GetSetUpCaseOrSuite("simple_parser_unittest.cc" , 250), ::testing::internal::SuiteApiResolver< SimpleParserTest >::GetTearDownCaseOrSuite("simple_parser_unittest.cc", 250 ), new ::testing::internal::TestFactoryImpl<SimpleParserTest_getInteger_Test >); void SimpleParserTest_getInteger_Test::TestBody() { | |||
251 | ||||
252 | // The value specified is 100. | |||
253 | ElementPtr json = Element::fromJSON("{ \"bar\": 100 }"); | |||
254 | int64_t x = -1; | |||
255 | ||||
256 | // Positive case: we expect value in range 0..200. All ok. | |||
257 | EXPECT_NO_THROW(x = SimpleParser::getInteger(json, "bar", 0, 200))switch (0) case 0: default: if (::testing::internal::AlwaysTrue ()) { try { if (::testing::internal::AlwaysTrue()) { x = SimpleParser ::getInteger(json, "bar", 0, 200); }; } catch (...) { goto gtest_label_testnothrow_257 ; } } else gtest_label_testnothrow_257: ::testing::internal:: AssertHelper(::testing::TestPartResult::kNonFatalFailure, "simple_parser_unittest.cc" , 257, "Expected: " "x = SimpleParser::getInteger(json, \"bar\", 0, 200)" " doesn't throw an exception.\n" " Actual: it throws.") = :: testing::Message(); | |||
258 | EXPECT_EQ(100, x)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::EqHelper::Compare("100", "x" , 100, x))) ; else ::testing::internal::AssertHelper(::testing ::TestPartResult::kNonFatalFailure, "simple_parser_unittest.cc" , 258, gtest_ar.failure_message()) = ::testing::Message(); | |||
259 | ||||
260 | // Border checks: 100 for 100..200 range is still ok. | |||
261 | EXPECT_NO_THROW(x = SimpleParser::getInteger(json, "bar", 100, 200))switch (0) case 0: default: if (::testing::internal::AlwaysTrue ()) { try { if (::testing::internal::AlwaysTrue()) { x = SimpleParser ::getInteger(json, "bar", 100, 200); }; } catch (...) { goto gtest_label_testnothrow_261 ; } } else gtest_label_testnothrow_261: ::testing::internal:: AssertHelper(::testing::TestPartResult::kNonFatalFailure, "simple_parser_unittest.cc" , 261, "Expected: " "x = SimpleParser::getInteger(json, \"bar\", 100, 200)" " doesn't throw an exception.\n" " Actual: it throws.") = :: testing::Message(); | |||
262 | // Border checks: 100 for 1..100 range is still ok. | |||
263 | EXPECT_NO_THROW(x = SimpleParser::getInteger(json, "bar", 1, 100))switch (0) case 0: default: if (::testing::internal::AlwaysTrue ()) { try { if (::testing::internal::AlwaysTrue()) { x = SimpleParser ::getInteger(json, "bar", 1, 100); }; } catch (...) { goto gtest_label_testnothrow_263 ; } } else gtest_label_testnothrow_263: ::testing::internal:: AssertHelper(::testing::TestPartResult::kNonFatalFailure, "simple_parser_unittest.cc" , 263, "Expected: " "x = SimpleParser::getInteger(json, \"bar\", 1, 100)" " doesn't throw an exception.\n" " Actual: it throws.") = :: testing::Message(); | |||
264 | ||||
265 | // Out of expected range. Should throw. | |||
266 | EXPECT_THROW(x = SimpleParser::getInteger(json, "bar", 101, 200), OutOfRange)switch (0) case 0: default: if (::testing::internal::ConstCharPtr gtest_msg = "") { bool gtest_caught_expected = false; try { if (::testing::internal::AlwaysTrue()) { x = SimpleParser::getInteger (json, "bar", 101, 200); }; } catch (OutOfRange const&) { gtest_caught_expected = true; } catch (...) { gtest_msg.value = "Expected: " "x = SimpleParser::getInteger(json, \"bar\", 101, 200)" " throws an exception of type " "OutOfRange" ".\n Actual: it throws a different type." ; goto gtest_label_testthrow_266; } if (!gtest_caught_expected ) { gtest_msg.value = "Expected: " "x = SimpleParser::getInteger(json, \"bar\", 101, 200)" " throws an exception of type " "OutOfRange" ".\n Actual: it throws nothing." ; goto gtest_label_testthrow_266; } } else gtest_label_testthrow_266 : ::testing::internal::AssertHelper(::testing::TestPartResult ::kNonFatalFailure, "simple_parser_unittest.cc", 266, gtest_msg .value) = ::testing::Message(); | |||
267 | EXPECT_THROW(x = SimpleParser::getInteger(json, "bar", 1, 99), OutOfRange)switch (0) case 0: default: if (::testing::internal::ConstCharPtr gtest_msg = "") { bool gtest_caught_expected = false; try { if (::testing::internal::AlwaysTrue()) { x = SimpleParser::getInteger (json, "bar", 1, 99); }; } catch (OutOfRange const&) { gtest_caught_expected = true; } catch (...) { gtest_msg.value = "Expected: " "x = SimpleParser::getInteger(json, \"bar\", 1, 99)" " throws an exception of type " "OutOfRange" ".\n Actual: it throws a different type." ; goto gtest_label_testthrow_267; } if (!gtest_caught_expected ) { gtest_msg.value = "Expected: " "x = SimpleParser::getInteger(json, \"bar\", 1, 99)" " throws an exception of type " "OutOfRange" ".\n Actual: it throws nothing." ; goto gtest_label_testthrow_267; } } else gtest_label_testthrow_267 : ::testing::internal::AssertHelper(::testing::TestPartResult ::kNonFatalFailure, "simple_parser_unittest.cc", 267, gtest_msg .value) = ::testing::Message(); | |||
268 | } | |||
269 | ||||
270 | // This test exercises the getAndConvert template | |||
271 | TEST_F(SimpleParserTest, getAndConvert)static_assert(sizeof("SimpleParserTest") > 1, "test_suite_name must not be empty" ); static_assert(sizeof("getAndConvert") > 1, "test_name must not be empty" ); class SimpleParserTest_getAndConvert_Test : public SimpleParserTest { public: SimpleParserTest_getAndConvert_Test() {} private: virtual void TestBody(); static ::testing::TestInfo* const test_info_ __attribute__ ((unused)); SimpleParserTest_getAndConvert_Test (SimpleParserTest_getAndConvert_Test const &) = delete; void operator=(SimpleParserTest_getAndConvert_Test const &) = delete; }; ::testing::TestInfo* const SimpleParserTest_getAndConvert_Test ::test_info_ = ::testing::internal::MakeAndRegisterTestInfo( "SimpleParserTest" , "getAndConvert", nullptr, nullptr, ::testing::internal::CodeLocation ("simple_parser_unittest.cc", 271), (::testing::internal::GetTypeId <SimpleParserTest>()), ::testing::internal::SuiteApiResolver < SimpleParserTest>::GetSetUpCaseOrSuite("simple_parser_unittest.cc" , 271), ::testing::internal::SuiteApiResolver< SimpleParserTest >::GetTearDownCaseOrSuite("simple_parser_unittest.cc", 271 ), new ::testing::internal::TestFactoryImpl<SimpleParserTest_getAndConvert_Test >); void SimpleParserTest_getAndConvert_Test::TestBody() { | |||
272 | ||||
273 | SimpleParserClassTest parser; | |||
274 | ||||
275 | // getAndConvert checks it can be found | |||
276 | ElementPtr not_found = Element::fromJSON("{ \"bar\": \"true\" }"); | |||
277 | EXPECT_THROW(parser.getAsBool(not_found, "foo"), DhcpConfigError)switch (0) case 0: default: if (::testing::internal::ConstCharPtr gtest_msg = "") { bool gtest_caught_expected = false; try { if (::testing::internal::AlwaysTrue()) { parser.getAsBool(not_found , "foo"); }; } catch (DhcpConfigError const&) { gtest_caught_expected = true; } catch (...) { gtest_msg.value = "Expected: " "parser.getAsBool(not_found, \"foo\")" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws a different type." ; goto gtest_label_testthrow_277; } if (!gtest_caught_expected ) { gtest_msg.value = "Expected: " "parser.getAsBool(not_found, \"foo\")" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws nothing." ; goto gtest_label_testthrow_277; } } else gtest_label_testthrow_277 : ::testing::internal::AssertHelper(::testing::TestPartResult ::kNonFatalFailure, "simple_parser_unittest.cc", 277, gtest_msg .value) = ::testing::Message(); | |||
278 | ||||
279 | // getAndConvert checks if it is a string | |||
280 | ElementPtr not_bool = Element::fromJSON("{ \"foo\": 1 }"); | |||
281 | EXPECT_THROW(parser.getAsBool(not_bool, "foo"), DhcpConfigError)switch (0) case 0: default: if (::testing::internal::ConstCharPtr gtest_msg = "") { bool gtest_caught_expected = false; try { if (::testing::internal::AlwaysTrue()) { parser.getAsBool(not_bool , "foo"); }; } catch (DhcpConfigError const&) { gtest_caught_expected = true; } catch (...) { gtest_msg.value = "Expected: " "parser.getAsBool(not_bool, \"foo\")" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws a different type." ; goto gtest_label_testthrow_281; } if (!gtest_caught_expected ) { gtest_msg.value = "Expected: " "parser.getAsBool(not_bool, \"foo\")" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws nothing." ; goto gtest_label_testthrow_281; } } else gtest_label_testthrow_281 : ::testing::internal::AssertHelper(::testing::TestPartResult ::kNonFatalFailure, "simple_parser_unittest.cc", 281, gtest_msg .value) = ::testing::Message(); | |||
282 | ||||
283 | // checks if getAndConvert can return the expected value | |||
284 | ElementPtr a_bool = Element::fromJSON("{ \"foo\": \"false\" }"); | |||
285 | bool val = true; | |||
286 | EXPECT_NO_THROW(val = parser.getAsBool(a_bool, "foo"))switch (0) case 0: default: if (::testing::internal::AlwaysTrue ()) { try { if (::testing::internal::AlwaysTrue()) { val = parser .getAsBool(a_bool, "foo"); }; } catch (...) { goto gtest_label_testnothrow_286 ; } } else gtest_label_testnothrow_286: ::testing::internal:: AssertHelper(::testing::TestPartResult::kNonFatalFailure, "simple_parser_unittest.cc" , 286, "Expected: " "val = parser.getAsBool(a_bool, \"foo\")" " doesn't throw an exception.\n" " Actual: it throws.") = :: testing::Message(); | |||
287 | EXPECT_FALSE(val)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar_ = ::testing::AssertionResult(!(val))) ; else ::testing ::internal::AssertHelper(::testing::TestPartResult::kNonFatalFailure , "simple_parser_unittest.cc", 287, ::testing::internal::GetBoolAssertionFailureMessage ( gtest_ar_, "val", "true", "false").c_str()) = ::testing::Message (); | |||
288 | ||||
289 | // getAndConvert checks conversion | |||
290 | ElementPtr bad_bool = Element::fromJSON("{ \"foo\": \"bar\" }"); | |||
291 | EXPECT_THROW(parser.getAsBool(bad_bool, "bar"), DhcpConfigError)switch (0) case 0: default: if (::testing::internal::ConstCharPtr gtest_msg = "") { bool gtest_caught_expected = false; try { if (::testing::internal::AlwaysTrue()) { parser.getAsBool(bad_bool , "bar"); }; } catch (DhcpConfigError const&) { gtest_caught_expected = true; } catch (...) { gtest_msg.value = "Expected: " "parser.getAsBool(bad_bool, \"bar\")" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws a different type." ; goto gtest_label_testthrow_291; } if (!gtest_caught_expected ) { gtest_msg.value = "Expected: " "parser.getAsBool(bad_bool, \"bar\")" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws nothing." ; goto gtest_label_testthrow_291; } } else gtest_label_testthrow_291 : ::testing::internal::AssertHelper(::testing::TestPartResult ::kNonFatalFailure, "simple_parser_unittest.cc", 291, gtest_msg .value) = ::testing::Message(); | |||
292 | } | |||
293 | ||||
294 | // This test exercises the getIOAddress | |||
295 | TEST_F(SimpleParserTest, getIOAddress)static_assert(sizeof("SimpleParserTest") > 1, "test_suite_name must not be empty" ); static_assert(sizeof("getIOAddress") > 1, "test_name must not be empty" ); class SimpleParserTest_getIOAddress_Test : public SimpleParserTest { public: SimpleParserTest_getIOAddress_Test() {} private: virtual void TestBody(); static ::testing::TestInfo* const test_info_ __attribute__ ((unused)); SimpleParserTest_getIOAddress_Test (SimpleParserTest_getIOAddress_Test const &) = delete; void operator=(SimpleParserTest_getIOAddress_Test const &) = delete ; }; ::testing::TestInfo* const SimpleParserTest_getIOAddress_Test ::test_info_ = ::testing::internal::MakeAndRegisterTestInfo( "SimpleParserTest" , "getIOAddress", nullptr, nullptr, ::testing::internal::CodeLocation ("simple_parser_unittest.cc", 295), (::testing::internal::GetTypeId <SimpleParserTest>()), ::testing::internal::SuiteApiResolver < SimpleParserTest>::GetSetUpCaseOrSuite("simple_parser_unittest.cc" , 295), ::testing::internal::SuiteApiResolver< SimpleParserTest >::GetTearDownCaseOrSuite("simple_parser_unittest.cc", 295 ), new ::testing::internal::TestFactoryImpl<SimpleParserTest_getIOAddress_Test >); void SimpleParserTest_getIOAddress_Test::TestBody() { | |||
296 | ||||
297 | SimpleParserClassTest parser; | |||
298 | ||||
299 | // getAddress checks it can be found | |||
300 | ElementPtr not_found = Element::fromJSON("{ \"bar\": 1 }"); | |||
301 | EXPECT_THROW(parser.getAddress(not_found, "foo"), DhcpConfigError)switch (0) case 0: default: if (::testing::internal::ConstCharPtr gtest_msg = "") { bool gtest_caught_expected = false; try { if (::testing::internal::AlwaysTrue()) { parser.getAddress(not_found , "foo"); }; } catch (DhcpConfigError const&) { gtest_caught_expected = true; } catch (...) { gtest_msg.value = "Expected: " "parser.getAddress(not_found, \"foo\")" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws a different type." ; goto gtest_label_testthrow_301; } if (!gtest_caught_expected ) { gtest_msg.value = "Expected: " "parser.getAddress(not_found, \"foo\")" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws nothing." ; goto gtest_label_testthrow_301; } } else gtest_label_testthrow_301 : ::testing::internal::AssertHelper(::testing::TestPartResult ::kNonFatalFailure, "simple_parser_unittest.cc", 301, gtest_msg .value) = ::testing::Message(); | |||
302 | ||||
303 | // getAddress checks if it is a string | |||
304 | ElementPtr not_addr = Element::fromJSON("{ \"foo\": 1234 }"); | |||
305 | EXPECT_THROW(parser.getAddress(not_addr, "foo"), DhcpConfigError)switch (0) case 0: default: if (::testing::internal::ConstCharPtr gtest_msg = "") { bool gtest_caught_expected = false; try { if (::testing::internal::AlwaysTrue()) { parser.getAddress(not_addr , "foo"); }; } catch (DhcpConfigError const&) { gtest_caught_expected = true; } catch (...) { gtest_msg.value = "Expected: " "parser.getAddress(not_addr, \"foo\")" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws a different type." ; goto gtest_label_testthrow_305; } if (!gtest_caught_expected ) { gtest_msg.value = "Expected: " "parser.getAddress(not_addr, \"foo\")" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws nothing." ; goto gtest_label_testthrow_305; } } else gtest_label_testthrow_305 : ::testing::internal::AssertHelper(::testing::TestPartResult ::kNonFatalFailure, "simple_parser_unittest.cc", 305, gtest_msg .value) = ::testing::Message(); | |||
306 | ||||
307 | // checks if getAddress can return the expected value of v4 address | |||
308 | ElementPtr v4 = Element::fromJSON("{ \"foo\": \"192.0.2.1\" }"); | |||
309 | IOAddress val("::"); | |||
310 | EXPECT_NO_THROW(val = parser.getAddress(v4, "foo"))switch (0) case 0: default: if (::testing::internal::AlwaysTrue ()) { try { if (::testing::internal::AlwaysTrue()) { val = parser .getAddress(v4, "foo"); }; } catch (...) { goto gtest_label_testnothrow_310 ; } } else gtest_label_testnothrow_310: ::testing::internal:: AssertHelper(::testing::TestPartResult::kNonFatalFailure, "simple_parser_unittest.cc" , 310, "Expected: " "val = parser.getAddress(v4, \"foo\")" " doesn't throw an exception.\n" " Actual: it throws.") = ::testing::Message(); | |||
311 | EXPECT_EQ("192.0.2.1" , val.toText())switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::EqHelper::Compare("\"192.0.2.1\"" , "val.toText()", "192.0.2.1", val.toText()))) ; else ::testing ::internal::AssertHelper(::testing::TestPartResult::kNonFatalFailure , "simple_parser_unittest.cc", 311, gtest_ar.failure_message( )) = ::testing::Message(); | |||
312 | ||||
313 | // checks if getAddress can return the expected value of v4 address | |||
314 | ElementPtr v6 = Element::fromJSON("{ \"foo\": \"2001:db8::1\" }"); | |||
315 | EXPECT_NO_THROW(val = parser.getAddress(v6, "foo"))switch (0) case 0: default: if (::testing::internal::AlwaysTrue ()) { try { if (::testing::internal::AlwaysTrue()) { val = parser .getAddress(v6, "foo"); }; } catch (...) { goto gtest_label_testnothrow_315 ; } } else gtest_label_testnothrow_315: ::testing::internal:: AssertHelper(::testing::TestPartResult::kNonFatalFailure, "simple_parser_unittest.cc" , 315, "Expected: " "val = parser.getAddress(v6, \"foo\")" " doesn't throw an exception.\n" " Actual: it throws.") = ::testing::Message(); | |||
316 | EXPECT_EQ("2001:db8::1" , val.toText())switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::EqHelper::Compare("\"2001:db8::1\"" , "val.toText()", "2001:db8::1", val.toText()))) ; else ::testing ::internal::AssertHelper(::testing::TestPartResult::kNonFatalFailure , "simple_parser_unittest.cc", 316, gtest_ar.failure_message( )) = ::testing::Message(); | |||
317 | } | |||
318 | ||||
319 | // This test exercises getDouble() | |||
320 | TEST_F(SimpleParserTest, getDouble)static_assert(sizeof("SimpleParserTest") > 1, "test_suite_name must not be empty" ); static_assert(sizeof("getDouble") > 1, "test_name must not be empty" ); class SimpleParserTest_getDouble_Test : public SimpleParserTest { public: SimpleParserTest_getDouble_Test() {} private: virtual void TestBody(); static ::testing::TestInfo* const test_info_ __attribute__ ((unused)); SimpleParserTest_getDouble_Test(SimpleParserTest_getDouble_Test const &) = delete; void operator=(SimpleParserTest_getDouble_Test const &) = delete; }; ::testing::TestInfo* const SimpleParserTest_getDouble_Test ::test_info_ = ::testing::internal::MakeAndRegisterTestInfo( "SimpleParserTest" , "getDouble", nullptr, nullptr, ::testing::internal::CodeLocation ("simple_parser_unittest.cc", 320), (::testing::internal::GetTypeId <SimpleParserTest>()), ::testing::internal::SuiteApiResolver < SimpleParserTest>::GetSetUpCaseOrSuite("simple_parser_unittest.cc" , 320), ::testing::internal::SuiteApiResolver< SimpleParserTest >::GetTearDownCaseOrSuite("simple_parser_unittest.cc", 320 ), new ::testing::internal::TestFactoryImpl<SimpleParserTest_getDouble_Test >); void SimpleParserTest_getDouble_Test::TestBody() { | |||
321 | ||||
322 | SimpleParserClassTest parser; | |||
323 | std::string json = | |||
324 | "{\n" | |||
325 | " \"string\" : \"12.3\",\n" | |||
326 | " \"bool\" : true, \n" | |||
327 | " \"int\" : 777, \n" | |||
328 | " \"map\" : {}, \n" | |||
329 | " \"list\" : [], \n" | |||
330 | " \"zero\" : 0.0, \n" | |||
331 | " \"fraction\" : .75, \n" | |||
332 | " \"negative\" : -1.45, \n" | |||
333 | " \"positive\" : 346.7 \n" | |||
334 | "}\n"; | |||
335 | ||||
336 | // Create our test set of parameters. | |||
337 | ElementPtr elems; | |||
338 | ASSERT_NO_THROW(elems = Element::fromJSON(json))switch (0) case 0: default: if (::testing::internal::AlwaysTrue ()) { try { if (::testing::internal::AlwaysTrue()) { elems = Element ::fromJSON(json); }; } catch (...) { goto gtest_label_testnothrow_338 ; } } else gtest_label_testnothrow_338: return ::testing::internal ::AssertHelper(::testing::TestPartResult::kFatalFailure, "simple_parser_unittest.cc" , 338, "Expected: " "elems = Element::fromJSON(json)" " doesn't throw an exception.\n" " Actual: it throws.") = ::testing::Message() << " invalid JSON, test is broken"; | |||
339 | ||||
340 | // Verify that a non-existant element is caught. | |||
341 | EXPECT_THROW(parser.getDouble(elems, "not-there"), DhcpConfigError)switch (0) case 0: default: if (::testing::internal::ConstCharPtr gtest_msg = "") { bool gtest_caught_expected = false; try { if (::testing::internal::AlwaysTrue()) { parser.getDouble(elems , "not-there"); }; } catch (DhcpConfigError const&) { gtest_caught_expected = true; } catch (...) { gtest_msg.value = "Expected: " "parser.getDouble(elems, \"not-there\")" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws a different type." ; goto gtest_label_testthrow_341; } if (!gtest_caught_expected ) { gtest_msg.value = "Expected: " "parser.getDouble(elems, \"not-there\")" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws nothing." ; goto gtest_label_testthrow_341; } } else gtest_label_testthrow_341 : ::testing::internal::AssertHelper(::testing::TestPartResult ::kNonFatalFailure, "simple_parser_unittest.cc", 341, gtest_msg .value) = ::testing::Message(); | |||
342 | ||||
343 | // Verify that wrong element types are caught. | |||
344 | EXPECT_THROW(parser.getDouble(elems, "string"), DhcpConfigError)switch (0) case 0: default: if (::testing::internal::ConstCharPtr gtest_msg = "") { bool gtest_caught_expected = false; try { if (::testing::internal::AlwaysTrue()) { parser.getDouble(elems , "string"); }; } catch (DhcpConfigError const&) { gtest_caught_expected = true; } catch (...) { gtest_msg.value = "Expected: " "parser.getDouble(elems, \"string\")" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws a different type." ; goto gtest_label_testthrow_344; } if (!gtest_caught_expected ) { gtest_msg.value = "Expected: " "parser.getDouble(elems, \"string\")" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws nothing." ; goto gtest_label_testthrow_344; } } else gtest_label_testthrow_344 : ::testing::internal::AssertHelper(::testing::TestPartResult ::kNonFatalFailure, "simple_parser_unittest.cc", 344, gtest_msg .value) = ::testing::Message(); | |||
345 | EXPECT_THROW(parser.getDouble(elems, "int"), DhcpConfigError)switch (0) case 0: default: if (::testing::internal::ConstCharPtr gtest_msg = "") { bool gtest_caught_expected = false; try { if (::testing::internal::AlwaysTrue()) { parser.getDouble(elems , "int"); }; } catch (DhcpConfigError const&) { gtest_caught_expected = true; } catch (...) { gtest_msg.value = "Expected: " "parser.getDouble(elems, \"int\")" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws a different type." ; goto gtest_label_testthrow_345; } if (!gtest_caught_expected ) { gtest_msg.value = "Expected: " "parser.getDouble(elems, \"int\")" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws nothing." ; goto gtest_label_testthrow_345; } } else gtest_label_testthrow_345 : ::testing::internal::AssertHelper(::testing::TestPartResult ::kNonFatalFailure, "simple_parser_unittest.cc", 345, gtest_msg .value) = ::testing::Message(); | |||
346 | EXPECT_THROW(parser.getDouble(elems, "bool"), DhcpConfigError)switch (0) case 0: default: if (::testing::internal::ConstCharPtr gtest_msg = "") { bool gtest_caught_expected = false; try { if (::testing::internal::AlwaysTrue()) { parser.getDouble(elems , "bool"); }; } catch (DhcpConfigError const&) { gtest_caught_expected = true; } catch (...) { gtest_msg.value = "Expected: " "parser.getDouble(elems, \"bool\")" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws a different type." ; goto gtest_label_testthrow_346; } if (!gtest_caught_expected ) { gtest_msg.value = "Expected: " "parser.getDouble(elems, \"bool\")" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws nothing." ; goto gtest_label_testthrow_346; } } else gtest_label_testthrow_346 : ::testing::internal::AssertHelper(::testing::TestPartResult ::kNonFatalFailure, "simple_parser_unittest.cc", 346, gtest_msg .value) = ::testing::Message(); | |||
347 | EXPECT_THROW(parser.getDouble(elems, "map"), DhcpConfigError)switch (0) case 0: default: if (::testing::internal::ConstCharPtr gtest_msg = "") { bool gtest_caught_expected = false; try { if (::testing::internal::AlwaysTrue()) { parser.getDouble(elems , "map"); }; } catch (DhcpConfigError const&) { gtest_caught_expected = true; } catch (...) { gtest_msg.value = "Expected: " "parser.getDouble(elems, \"map\")" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws a different type." ; goto gtest_label_testthrow_347; } if (!gtest_caught_expected ) { gtest_msg.value = "Expected: " "parser.getDouble(elems, \"map\")" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws nothing." ; goto gtest_label_testthrow_347; } } else gtest_label_testthrow_347 : ::testing::internal::AssertHelper(::testing::TestPartResult ::kNonFatalFailure, "simple_parser_unittest.cc", 347, gtest_msg .value) = ::testing::Message(); | |||
348 | EXPECT_THROW(parser.getDouble(elems, "list"), DhcpConfigError)switch (0) case 0: default: if (::testing::internal::ConstCharPtr gtest_msg = "") { bool gtest_caught_expected = false; try { if (::testing::internal::AlwaysTrue()) { parser.getDouble(elems , "list"); }; } catch (DhcpConfigError const&) { gtest_caught_expected = true; } catch (...) { gtest_msg.value = "Expected: " "parser.getDouble(elems, \"list\")" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws a different type." ; goto gtest_label_testthrow_348; } if (!gtest_caught_expected ) { gtest_msg.value = "Expected: " "parser.getDouble(elems, \"list\")" " throws an exception of type " "DhcpConfigError" ".\n Actual: it throws nothing." ; goto gtest_label_testthrow_348; } } else gtest_label_testthrow_348 : ::testing::internal::AssertHelper(::testing::TestPartResult ::kNonFatalFailure, "simple_parser_unittest.cc", 348, gtest_msg .value) = ::testing::Message(); | |||
349 | ||||
350 | // Verify valid values are correct. | |||
351 | double value; | |||
352 | ||||
353 | EXPECT_NO_THROW(value = parser.getDouble(elems, "zero"))switch (0) case 0: default: if (::testing::internal::AlwaysTrue ()) { try { if (::testing::internal::AlwaysTrue()) { value = parser .getDouble(elems, "zero"); }; } catch (...) { goto gtest_label_testnothrow_353 ; } } else gtest_label_testnothrow_353: ::testing::internal:: AssertHelper(::testing::TestPartResult::kNonFatalFailure, "simple_parser_unittest.cc" , 353, "Expected: " "value = parser.getDouble(elems, \"zero\")" " doesn't throw an exception.\n" " Actual: it throws.") = :: testing::Message(); | |||
354 | EXPECT_EQ(0.0, value)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::EqHelper::Compare("0.0", "value" , 0.0, value))) ; else ::testing::internal::AssertHelper(::testing ::TestPartResult::kNonFatalFailure, "simple_parser_unittest.cc" , 354, gtest_ar.failure_message()) = ::testing::Message(); | |||
355 | ||||
356 | EXPECT_NO_THROW(value = parser.getDouble(elems, "fraction"))switch (0) case 0: default: if (::testing::internal::AlwaysTrue ()) { try { if (::testing::internal::AlwaysTrue()) { value = parser .getDouble(elems, "fraction"); }; } catch (...) { goto gtest_label_testnothrow_356 ; } } else gtest_label_testnothrow_356: ::testing::internal:: AssertHelper(::testing::TestPartResult::kNonFatalFailure, "simple_parser_unittest.cc" , 356, "Expected: " "value = parser.getDouble(elems, \"fraction\")" " doesn't throw an exception.\n" " Actual: it throws.") = :: testing::Message(); | |||
357 | EXPECT_EQ(.75, value)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::EqHelper::Compare(".75", "value" , .75, value))) ; else ::testing::internal::AssertHelper(::testing ::TestPartResult::kNonFatalFailure, "simple_parser_unittest.cc" , 357, gtest_ar.failure_message()) = ::testing::Message(); | |||
358 | ||||
359 | EXPECT_NO_THROW(value = parser.getDouble(elems, "negative"))switch (0) case 0: default: if (::testing::internal::AlwaysTrue ()) { try { if (::testing::internal::AlwaysTrue()) { value = parser .getDouble(elems, "negative"); }; } catch (...) { goto gtest_label_testnothrow_359 ; } } else gtest_label_testnothrow_359: ::testing::internal:: AssertHelper(::testing::TestPartResult::kNonFatalFailure, "simple_parser_unittest.cc" , 359, "Expected: " "value = parser.getDouble(elems, \"negative\")" " doesn't throw an exception.\n" " Actual: it throws.") = :: testing::Message(); | |||
360 | EXPECT_EQ(-1.45, value)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::EqHelper::Compare("-1.45", "value" , -1.45, value))) ; else ::testing::internal::AssertHelper(:: testing::TestPartResult::kNonFatalFailure, "simple_parser_unittest.cc" , 360, gtest_ar.failure_message()) = ::testing::Message(); | |||
361 | ||||
362 | EXPECT_NO_THROW(value = parser.getDouble(elems, "positive"))switch (0) case 0: default: if (::testing::internal::AlwaysTrue ()) { try { if (::testing::internal::AlwaysTrue()) { value = parser .getDouble(elems, "positive"); }; } catch (...) { goto gtest_label_testnothrow_362 ; } } else gtest_label_testnothrow_362: ::testing::internal:: AssertHelper(::testing::TestPartResult::kNonFatalFailure, "simple_parser_unittest.cc" , 362, "Expected: " "value = parser.getDouble(elems, \"positive\")" " doesn't throw an exception.\n" " Actual: it throws.") = :: testing::Message(); | |||
363 | EXPECT_EQ(346.7, value)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::EqHelper::Compare("346.7", "value" , 346.7, value))) ; else ::testing::internal::AssertHelper(:: testing::TestPartResult::kNonFatalFailure, "simple_parser_unittest.cc" , 363, gtest_ar.failure_message()) = ::testing::Message(); | |||
364 | } |
1 | // Components for manipulating sequences of characters -*- C++ -*- |
2 | |
3 | // Copyright (C) 1997-2023 Free Software Foundation, Inc. |
4 | // |
5 | // This file is part of the GNU ISO C++ Library. This library is free |
6 | // software; you can redistribute it and/or modify it under the |
7 | // terms of the GNU General Public License as published by the |
8 | // Free Software Foundation; either version 3, or (at your option) |
9 | // any later version. |
10 | |
11 | // This library is distributed in the hope that it will be useful, |
12 | // but WITHOUT ANY WARRANTY; without even the implied warranty of |
13 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
14 | // GNU General Public License for more details. |
15 | |
16 | // Under Section 7 of GPL version 3, you are granted additional |
17 | // permissions described in the GCC Runtime Library Exception, version |
18 | // 3.1, as published by the Free Software Foundation. |
19 | |
20 | // You should have received a copy of the GNU General Public License and |
21 | // a copy of the GCC Runtime Library Exception along with this program; |
22 | // see the files COPYING3 and COPYING.RUNTIME respectively. If not, see |
23 | // <http://www.gnu.org/licenses/>. |
24 | |
25 | /** @file bits/basic_string.h |
26 | * This is an internal header file, included by other library headers. |
27 | * Do not attempt to use it directly. @headername{string} |
28 | */ |
29 | |
30 | // |
31 | // ISO C++ 14882: 21 Strings library |
32 | // |
33 | |
34 | #ifndef _BASIC_STRING_H1 |
35 | #define _BASIC_STRING_H1 1 |
36 | |
37 | #pragma GCC system_header |
38 | |
39 | #include <ext/alloc_traits.h> |
40 | #include <debug/debug.h> |
41 | |
42 | #if __cplusplus202002L >= 201103L |
43 | #include <initializer_list> |
44 | #endif |
45 | |
46 | #if __cplusplus202002L >= 201703L |
47 | # include <string_view> |
48 | #endif |
49 | |
50 | #if ! _GLIBCXX_USE_CXX11_ABI1 |
51 | # include "cow_string.h" |
52 | #else |
53 | namespace std _GLIBCXX_VISIBILITY(default)__attribute__ ((__visibility__ ("default"))) |
54 | { |
55 | _GLIBCXX_BEGIN_NAMESPACE_VERSION |
56 | _GLIBCXX_BEGIN_NAMESPACE_CXX11namespace __cxx11 { |
57 | |
58 | #ifdef __cpp_lib_is_constant_evaluated201811L |
59 | // Support P0980R1 in C++20. |
60 | # define __cpp_lib_constexpr_string201907L 201907L |
61 | #elif __cplusplus202002L >= 201703L && _GLIBCXX_HAVE_IS_CONSTANT_EVALUATED1 |
62 | // Support P0426R1 changes to char_traits in C++17. |
63 | # define __cpp_lib_constexpr_string201907L 201611L |
64 | #endif |
65 | |
66 | /** |
67 | * @class basic_string basic_string.h <string> |
68 | * @brief Managing sequences of characters and character-like objects. |
69 | * |
70 | * @ingroup strings |
71 | * @ingroup sequences |
72 | * @headerfile string |
73 | * @since C++98 |
74 | * |
75 | * @tparam _CharT Type of character |
76 | * @tparam _Traits Traits for character type, defaults to |
77 | * char_traits<_CharT>. |
78 | * @tparam _Alloc Allocator type, defaults to allocator<_CharT>. |
79 | * |
80 | * Meets the requirements of a <a href="tables.html#65">container</a>, a |
81 | * <a href="tables.html#66">reversible container</a>, and a |
82 | * <a href="tables.html#67">sequence</a>. Of the |
83 | * <a href="tables.html#68">optional sequence requirements</a>, only |
84 | * @c push_back, @c at, and @c %array access are supported. |
85 | */ |
86 | template<typename _CharT, typename _Traits, typename _Alloc> |
87 | class basic_string |
88 | { |
89 | typedef typename __gnu_cxx::__alloc_traits<_Alloc>::template |
90 | rebind<_CharT>::other _Char_alloc_type; |
91 | |
92 | typedef __gnu_cxx::__alloc_traits<_Char_alloc_type> _Alloc_traits; |
93 | |
94 | // Types: |
95 | public: |
96 | typedef _Traits traits_type; |
97 | typedef typename _Traits::char_type value_type; |
98 | typedef _Char_alloc_type allocator_type; |
99 | typedef typename _Alloc_traits::size_type size_type; |
100 | typedef typename _Alloc_traits::difference_type difference_type; |
101 | typedef typename _Alloc_traits::reference reference; |
102 | typedef typename _Alloc_traits::const_reference const_reference; |
103 | typedef typename _Alloc_traits::pointer pointer; |
104 | typedef typename _Alloc_traits::const_pointer const_pointer; |
105 | typedef __gnu_cxx::__normal_iterator<pointer, basic_string> iterator; |
106 | typedef __gnu_cxx::__normal_iterator<const_pointer, basic_string> |
107 | const_iterator; |
108 | typedef std::reverse_iterator<const_iterator> const_reverse_iterator; |
109 | typedef std::reverse_iterator<iterator> reverse_iterator; |
110 | |
111 | /// Value returned by various member functions when they fail. |
112 | static const size_type npos = static_cast<size_type>(-1); |
113 | |
114 | protected: |
115 | // type used for positions in insert, erase etc. |
116 | #if __cplusplus202002L < 201103L |
117 | typedef iterator __const_iterator; |
118 | #else |
119 | typedef const_iterator __const_iterator; |
120 | #endif |
121 | |
122 | private: |
123 | static _GLIBCXX20_CONSTEXPRconstexpr pointer |
124 | _S_allocate(_Char_alloc_type& __a, size_type __n) |
125 | { |
126 | pointer __p = _Alloc_traits::allocate(__a, __n); |
127 | #if __cpp_lib_constexpr_string201907L >= 201907L |
128 | // std::char_traits begins the lifetime of characters, |
129 | // but custom traits might not, so do it here. |
130 | if constexpr (!is_same_v<_Traits, char_traits<_CharT>>) |
131 | if (std::__is_constant_evaluated()) |
132 | // Begin the lifetime of characters in allocated storage. |
133 | for (size_type __i = 0; __i < __n; ++__i) |
134 | std::construct_at(__builtin_addressof(__p[__i])); |
135 | #endif |
136 | return __p; |
137 | } |
138 | |
139 | #if __cplusplus202002L >= 201703L |
140 | // A helper type for avoiding boiler-plate. |
141 | typedef basic_string_view<_CharT, _Traits> __sv_type; |
142 | |
143 | template<typename _Tp, typename _Res> |
144 | using _If_sv = enable_if_t< |
145 | __and_<is_convertible<const _Tp&, __sv_type>, |
146 | __not_<is_convertible<const _Tp*, const basic_string*>>, |
147 | __not_<is_convertible<const _Tp&, const _CharT*>>>::value, |
148 | _Res>; |
149 | |
150 | // Allows an implicit conversion to __sv_type. |
151 | _GLIBCXX20_CONSTEXPRconstexpr |
152 | static __sv_type |
153 | _S_to_string_view(__sv_type __svt) noexcept |
154 | { return __svt; } |
155 | |
156 | // Wraps a string_view by explicit conversion and thus |
157 | // allows to add an internal constructor that does not |
158 | // participate in overload resolution when a string_view |
159 | // is provided. |
160 | struct __sv_wrapper |
161 | { |
162 | _GLIBCXX20_CONSTEXPRconstexpr explicit |
163 | __sv_wrapper(__sv_type __sv) noexcept : _M_sv(__sv) { } |
164 | |
165 | __sv_type _M_sv; |
166 | }; |
167 | |
168 | /** |
169 | * @brief Only internally used: Construct string from a string view |
170 | * wrapper. |
171 | * @param __svw string view wrapper. |
172 | * @param __a Allocator to use. |
173 | */ |
174 | _GLIBCXX20_CONSTEXPRconstexpr |
175 | explicit |
176 | basic_string(__sv_wrapper __svw, const _Alloc& __a) |
177 | : basic_string(__svw._M_sv.data(), __svw._M_sv.size(), __a) { } |
178 | #endif |
179 | |
180 | // Use empty-base optimization: http://www.cantrip.org/emptyopt.html |
181 | struct _Alloc_hider : allocator_type // TODO check __is_final |
182 | { |
183 | #if __cplusplus202002L < 201103L |
184 | _Alloc_hider(pointer __dat, const _Alloc& __a = _Alloc()) |
185 | : allocator_type(__a), _M_p(__dat) { } |
186 | #else |
187 | _GLIBCXX20_CONSTEXPRconstexpr |
188 | _Alloc_hider(pointer __dat, const _Alloc& __a) |
189 | : allocator_type(__a), _M_p(__dat) { } |
190 | |
191 | _GLIBCXX20_CONSTEXPRconstexpr |
192 | _Alloc_hider(pointer __dat, _Alloc&& __a = _Alloc()) |
193 | : allocator_type(std::move(__a)), _M_p(__dat) { } |
194 | #endif |
195 | |
196 | pointer _M_p; // The actual data. |
197 | }; |
198 | |
199 | _Alloc_hider _M_dataplus; |
200 | size_type _M_string_length; |
201 | |
202 | enum { _S_local_capacity = 15 / sizeof(_CharT) }; |
203 | |
204 | union |
205 | { |
206 | _CharT _M_local_buf[_S_local_capacity + 1]; |
207 | size_type _M_allocated_capacity; |
208 | }; |
209 | |
210 | _GLIBCXX20_CONSTEXPRconstexpr |
211 | void |
212 | _M_data(pointer __p) |
213 | { _M_dataplus._M_p = __p; } |
214 | |
215 | _GLIBCXX20_CONSTEXPRconstexpr |
216 | void |
217 | _M_length(size_type __length) |
218 | { _M_string_length = __length; } |
219 | |
220 | _GLIBCXX20_CONSTEXPRconstexpr |
221 | pointer |
222 | _M_data() const |
223 | { return _M_dataplus._M_p; } |
224 | |
225 | _GLIBCXX20_CONSTEXPRconstexpr |
226 | pointer |
227 | _M_local_data() |
228 | { |
229 | #if __cplusplus202002L >= 201103L |
230 | return std::pointer_traits<pointer>::pointer_to(*_M_local_buf); |
231 | #else |
232 | return pointer(_M_local_buf); |
233 | #endif |
234 | } |
235 | |
236 | _GLIBCXX20_CONSTEXPRconstexpr |
237 | const_pointer |
238 | _M_local_data() const |
239 | { |
240 | #if __cplusplus202002L >= 201103L |
241 | return std::pointer_traits<const_pointer>::pointer_to(*_M_local_buf); |
242 | #else |
243 | return const_pointer(_M_local_buf); |
244 | #endif |
245 | } |
246 | |
247 | _GLIBCXX20_CONSTEXPRconstexpr |
248 | void |
249 | _M_capacity(size_type __capacity) |
250 | { _M_allocated_capacity = __capacity; } |
251 | |
252 | _GLIBCXX20_CONSTEXPRconstexpr |
253 | void |
254 | _M_set_length(size_type __n) |
255 | { |
256 | _M_length(__n); |
257 | traits_type::assign(_M_data()[__n], _CharT()); |
258 | } |
259 | |
260 | _GLIBCXX20_CONSTEXPRconstexpr |
261 | bool |
262 | _M_is_local() const |
263 | { |
264 | if (_M_data() == _M_local_data()) |
265 | { |
266 | if (_M_string_length > _S_local_capacity) |
267 | __builtin_unreachable(); |
268 | return true; |
269 | } |
270 | return false; |
271 | } |
272 | |
273 | // Create & Destroy |
274 | _GLIBCXX20_CONSTEXPRconstexpr |
275 | pointer |
276 | _M_create(size_type&, size_type); |
277 | |
278 | _GLIBCXX20_CONSTEXPRconstexpr |
279 | void |
280 | _M_dispose() |
281 | { |
282 | if (!_M_is_local()) |
283 | _M_destroy(_M_allocated_capacity); |
284 | } |
285 | |
286 | _GLIBCXX20_CONSTEXPRconstexpr |
287 | void |
288 | _M_destroy(size_type __size) throw() |
289 | { _Alloc_traits::deallocate(_M_get_allocator(), _M_data(), __size + 1); } |
290 | |
291 | #if __cplusplus202002L < 201103L || defined _GLIBCXX_DEFINING_STRING_INSTANTIATIONS |
292 | // _M_construct_aux is used to implement the 21.3.1 para 15 which |
293 | // requires special behaviour if _InIterator is an integral type |
294 | template<typename _InIterator> |
295 | void |
296 | _M_construct_aux(_InIterator __beg, _InIterator __end, |
297 | std::__false_type) |
298 | { |
299 | typedef typename iterator_traits<_InIterator>::iterator_category _Tag; |
300 | _M_construct(__beg, __end, _Tag()); |
301 | } |
302 | |
303 | // _GLIBCXX_RESOLVE_LIB_DEFECTS |
304 | // 438. Ambiguity in the "do the right thing" clause |
305 | template<typename _Integer> |
306 | void |
307 | _M_construct_aux(_Integer __beg, _Integer __end, std::__true_type) |
308 | { _M_construct_aux_2(static_cast<size_type>(__beg), __end); } |
309 | |
310 | void |
311 | _M_construct_aux_2(size_type __req, _CharT __c) |
312 | { _M_construct(__req, __c); } |
313 | #endif |
314 | |
315 | // For Input Iterators, used in istreambuf_iterators, etc. |
316 | template<typename _InIterator> |
317 | _GLIBCXX20_CONSTEXPRconstexpr |
318 | void |
319 | _M_construct(_InIterator __beg, _InIterator __end, |
320 | std::input_iterator_tag); |
321 | |
322 | // For forward_iterators up to random_access_iterators, used for |
323 | // string::iterator, _CharT*, etc. |
324 | template<typename _FwdIterator> |
325 | _GLIBCXX20_CONSTEXPRconstexpr |
326 | void |
327 | _M_construct(_FwdIterator __beg, _FwdIterator __end, |
328 | std::forward_iterator_tag); |
329 | |
330 | _GLIBCXX20_CONSTEXPRconstexpr |
331 | void |
332 | _M_construct(size_type __req, _CharT __c); |
333 | |
334 | _GLIBCXX20_CONSTEXPRconstexpr |
335 | allocator_type& |
336 | _M_get_allocator() |
337 | { return _M_dataplus; } |
338 | |
339 | _GLIBCXX20_CONSTEXPRconstexpr |
340 | const allocator_type& |
341 | _M_get_allocator() const |
342 | { return _M_dataplus; } |
343 | |
344 | // Ensure that _M_local_buf is the active member of the union. |
345 | __attribute__((__always_inline__)) |
346 | _GLIBCXX14_CONSTEXPRconstexpr |
347 | pointer |
348 | _M_use_local_data() _GLIBCXX_NOEXCEPTnoexcept |
349 | { |
350 | #if __cpp_lib_is_constant_evaluated201811L |
351 | if (std::is_constant_evaluated()) |
352 | for (size_type __i = 0; __i <= _S_local_capacity; ++__i) |
353 | _M_local_buf[__i] = _CharT(); |
354 | #endif |
355 | return _M_local_data(); |
356 | } |
357 | |
358 | private: |
359 | |
360 | #ifdef _GLIBCXX_DISAMBIGUATE_REPLACE_INST |
361 | // The explicit instantiations in misc-inst.cc require this due to |
362 | // https://gcc.gnu.org/bugzilla/show_bug.cgi?id=64063 |
363 | template<typename _Tp, bool _Requires = |
364 | !__are_same<_Tp, _CharT*>::__value |
365 | && !__are_same<_Tp, const _CharT*>::__value |
366 | && !__are_same<_Tp, iterator>::__value |
367 | && !__are_same<_Tp, const_iterator>::__value> |
368 | struct __enable_if_not_native_iterator |
369 | { typedef basic_string& __type; }; |
370 | template<typename _Tp> |
371 | struct __enable_if_not_native_iterator<_Tp, false> { }; |
372 | #endif |
373 | |
374 | _GLIBCXX20_CONSTEXPRconstexpr |
375 | size_type |
376 | _M_check(size_type __pos, const char* __s) const |
377 | { |
378 | if (__pos > this->size()) |
379 | __throw_out_of_range_fmt(__N("%s: __pos (which is %zu) > "("%s: __pos (which is %zu) > " "this->size() (which is %zu)" ) |
380 | "this->size() (which is %zu)")("%s: __pos (which is %zu) > " "this->size() (which is %zu)" ), |
381 | __s, __pos, this->size()); |
382 | return __pos; |
383 | } |
384 | |
385 | _GLIBCXX20_CONSTEXPRconstexpr |
386 | void |
387 | _M_check_length(size_type __n1, size_type __n2, const char* __s) const |
388 | { |
389 | if (this->max_size() - (this->size() - __n1) < __n2) |
390 | __throw_length_error(__N(__s)(__s)); |
391 | } |
392 | |
393 | |
394 | // NB: _M_limit doesn't check for a bad __pos value. |
395 | _GLIBCXX20_CONSTEXPRconstexpr |
396 | size_type |
397 | _M_limit(size_type __pos, size_type __off) const _GLIBCXX_NOEXCEPTnoexcept |
398 | { |
399 | const bool __testoff = __off < this->size() - __pos; |
400 | return __testoff ? __off : this->size() - __pos; |
401 | } |
402 | |
403 | // True if _Rep and source do not overlap. |
404 | bool |
405 | _M_disjunct(const _CharT* __s) const _GLIBCXX_NOEXCEPTnoexcept |
406 | { |
407 | return (less<const _CharT*>()(__s, _M_data()) |
408 | || less<const _CharT*>()(_M_data() + this->size(), __s)); |
409 | } |
410 | |
411 | // When __n = 1 way faster than the general multichar |
412 | // traits_type::copy/move/assign. |
413 | _GLIBCXX20_CONSTEXPRconstexpr |
414 | static void |
415 | _S_copy(_CharT* __d, const _CharT* __s, size_type __n) |
416 | { |
417 | if (__n == 1) |
418 | traits_type::assign(*__d, *__s); |
419 | else |
420 | traits_type::copy(__d, __s, __n); |
421 | } |
422 | |
423 | _GLIBCXX20_CONSTEXPRconstexpr |
424 | static void |
425 | _S_move(_CharT* __d, const _CharT* __s, size_type __n) |
426 | { |
427 | if (__n == 1) |
428 | traits_type::assign(*__d, *__s); |
429 | else |
430 | traits_type::move(__d, __s, __n); |
431 | } |
432 | |
433 | _GLIBCXX20_CONSTEXPRconstexpr |
434 | static void |
435 | _S_assign(_CharT* __d, size_type __n, _CharT __c) |
436 | { |
437 | if (__n == 1) |
438 | traits_type::assign(*__d, __c); |
439 | else |
440 | traits_type::assign(__d, __n, __c); |
441 | } |
442 | |
443 | // _S_copy_chars is a separate template to permit specialization |
444 | // to optimize for the common case of pointers as iterators. |
445 | template<class _Iterator> |
446 | _GLIBCXX20_CONSTEXPRconstexpr |
447 | static void |
448 | _S_copy_chars(_CharT* __p, _Iterator __k1, _Iterator __k2) |
449 | { |
450 | for (; __k1 != __k2; ++__k1, (void)++__p) |
451 | traits_type::assign(*__p, *__k1); // These types are off. |
452 | } |
453 | |
454 | _GLIBCXX20_CONSTEXPRconstexpr |
455 | static void |
456 | _S_copy_chars(_CharT* __p, iterator __k1, iterator __k2) _GLIBCXX_NOEXCEPTnoexcept |
457 | { _S_copy_chars(__p, __k1.base(), __k2.base()); } |
458 | |
459 | _GLIBCXX20_CONSTEXPRconstexpr |
460 | static void |
461 | _S_copy_chars(_CharT* __p, const_iterator __k1, const_iterator __k2) |
462 | _GLIBCXX_NOEXCEPTnoexcept |
463 | { _S_copy_chars(__p, __k1.base(), __k2.base()); } |
464 | |
465 | _GLIBCXX20_CONSTEXPRconstexpr |
466 | static void |
467 | _S_copy_chars(_CharT* __p, _CharT* __k1, _CharT* __k2) _GLIBCXX_NOEXCEPTnoexcept |
468 | { _S_copy(__p, __k1, __k2 - __k1); } |
469 | |
470 | _GLIBCXX20_CONSTEXPRconstexpr |
471 | static void |
472 | _S_copy_chars(_CharT* __p, const _CharT* __k1, const _CharT* __k2) |
473 | _GLIBCXX_NOEXCEPTnoexcept |
474 | { _S_copy(__p, __k1, __k2 - __k1); } |
475 | |
476 | _GLIBCXX20_CONSTEXPRconstexpr |
477 | static int |
478 | _S_compare(size_type __n1, size_type __n2) _GLIBCXX_NOEXCEPTnoexcept |
479 | { |
480 | const difference_type __d = difference_type(__n1 - __n2); |
481 | |
482 | if (__d > __gnu_cxx::__numeric_traits<int>::__max) |
483 | return __gnu_cxx::__numeric_traits<int>::__max; |
484 | else if (__d < __gnu_cxx::__numeric_traits<int>::__min) |
485 | return __gnu_cxx::__numeric_traits<int>::__min; |
486 | else |
487 | return int(__d); |
488 | } |
489 | |
490 | _GLIBCXX20_CONSTEXPRconstexpr |
491 | void |
492 | _M_assign(const basic_string&); |
493 | |
494 | _GLIBCXX20_CONSTEXPRconstexpr |
495 | void |
496 | _M_mutate(size_type __pos, size_type __len1, const _CharT* __s, |
497 | size_type __len2); |
498 | |
499 | _GLIBCXX20_CONSTEXPRconstexpr |
500 | void |
501 | _M_erase(size_type __pos, size_type __n); |
502 | |
503 | public: |
504 | // Construct/copy/destroy: |
505 | // NB: We overload ctors in some cases instead of using default |
506 | // arguments, per 17.4.4.4 para. 2 item 2. |
507 | |
508 | /** |
509 | * @brief Default constructor creates an empty string. |
510 | */ |
511 | _GLIBCXX20_CONSTEXPRconstexpr |
512 | basic_string() |
513 | _GLIBCXX_NOEXCEPT_IF(is_nothrow_default_constructible<_Alloc>::value)noexcept(is_nothrow_default_constructible<_Alloc>::value ) |
514 | : _M_dataplus(_M_local_data()) |
515 | { |
516 | _M_use_local_data(); |
517 | _M_set_length(0); |
518 | } |
519 | |
520 | /** |
521 | * @brief Construct an empty string using allocator @a a. |
522 | */ |
523 | _GLIBCXX20_CONSTEXPRconstexpr |
524 | explicit |
525 | basic_string(const _Alloc& __a) _GLIBCXX_NOEXCEPTnoexcept |
526 | : _M_dataplus(_M_local_data(), __a) |
527 | { |
528 | _M_use_local_data(); |
529 | _M_set_length(0); |
530 | } |
531 | |
532 | /** |
533 | * @brief Construct string with copy of value of @a __str. |
534 | * @param __str Source string. |
535 | */ |
536 | _GLIBCXX20_CONSTEXPRconstexpr |
537 | basic_string(const basic_string& __str) |
538 | : _M_dataplus(_M_local_data(), |
539 | _Alloc_traits::_S_select_on_copy(__str._M_get_allocator())) |
540 | { |
541 | _M_construct(__str._M_data(), __str._M_data() + __str.length(), |
542 | std::forward_iterator_tag()); |
543 | } |
544 | |
545 | // _GLIBCXX_RESOLVE_LIB_DEFECTS |
546 | // 2583. no way to supply an allocator for basic_string(str, pos) |
547 | /** |
548 | * @brief Construct string as copy of a substring. |
549 | * @param __str Source string. |
550 | * @param __pos Index of first character to copy from. |
551 | * @param __a Allocator to use. |
552 | */ |
553 | _GLIBCXX20_CONSTEXPRconstexpr |
554 | basic_string(const basic_string& __str, size_type __pos, |
555 | const _Alloc& __a = _Alloc()) |
556 | : _M_dataplus(_M_local_data(), __a) |
557 | { |
558 | const _CharT* __start = __str._M_data() |
559 | + __str._M_check(__pos, "basic_string::basic_string"); |
560 | _M_construct(__start, __start + __str._M_limit(__pos, npos), |
561 | std::forward_iterator_tag()); |
562 | } |
563 | |
564 | /** |
565 | * @brief Construct string as copy of a substring. |
566 | * @param __str Source string. |
567 | * @param __pos Index of first character to copy from. |
568 | * @param __n Number of characters to copy. |
569 | */ |
570 | _GLIBCXX20_CONSTEXPRconstexpr |
571 | basic_string(const basic_string& __str, size_type __pos, |
572 | size_type __n) |
573 | : _M_dataplus(_M_local_data()) |
574 | { |
575 | const _CharT* __start = __str._M_data() |
576 | + __str._M_check(__pos, "basic_string::basic_string"); |
577 | _M_construct(__start, __start + __str._M_limit(__pos, __n), |
578 | std::forward_iterator_tag()); |
579 | } |
580 | |
581 | /** |
582 | * @brief Construct string as copy of a substring. |
583 | * @param __str Source string. |
584 | * @param __pos Index of first character to copy from. |
585 | * @param __n Number of characters to copy. |
586 | * @param __a Allocator to use. |
587 | */ |
588 | _GLIBCXX20_CONSTEXPRconstexpr |
589 | basic_string(const basic_string& __str, size_type __pos, |
590 | size_type __n, const _Alloc& __a) |
591 | : _M_dataplus(_M_local_data(), __a) |
592 | { |
593 | const _CharT* __start |
594 | = __str._M_data() + __str._M_check(__pos, "string::string"); |
595 | _M_construct(__start, __start + __str._M_limit(__pos, __n), |
596 | std::forward_iterator_tag()); |
597 | } |
598 | |
599 | /** |
600 | * @brief Construct string initialized by a character %array. |
601 | * @param __s Source character %array. |
602 | * @param __n Number of characters to copy. |
603 | * @param __a Allocator to use (default is default allocator). |
604 | * |
605 | * NB: @a __s must have at least @a __n characters, '\\0' |
606 | * has no special meaning. |
607 | */ |
608 | _GLIBCXX20_CONSTEXPRconstexpr |
609 | basic_string(const _CharT* __s, size_type __n, |
610 | const _Alloc& __a = _Alloc()) |
611 | : _M_dataplus(_M_local_data(), __a) |
612 | { |
613 | // NB: Not required, but considered best practice. |
614 | if (__s == 0 && __n > 0) |
615 | std::__throw_logic_error(__N("basic_string: "("basic_string: " "construction from null is not valid") |
616 | "construction from null is not valid")("basic_string: " "construction from null is not valid")); |
617 | _M_construct(__s, __s + __n, std::forward_iterator_tag()); |
618 | } |
619 | |
620 | /** |
621 | * @brief Construct string as copy of a C string. |
622 | * @param __s Source C string. |
623 | * @param __a Allocator to use (default is default allocator). |
624 | */ |
625 | #if __cpp_deduction_guides201703L && ! defined _GLIBCXX_DEFINING_STRING_INSTANTIATIONS |
626 | // _GLIBCXX_RESOLVE_LIB_DEFECTS |
627 | // 3076. basic_string CTAD ambiguity |
628 | template<typename = _RequireAllocator<_Alloc>> |
629 | #endif |
630 | _GLIBCXX20_CONSTEXPRconstexpr |
631 | basic_string(const _CharT* __s, const _Alloc& __a = _Alloc()) |
632 | : _M_dataplus(_M_local_data(), __a) |
633 | { |
634 | // NB: Not required, but considered best practice. |
635 | if (__s == 0) |
636 | std::__throw_logic_error(__N("basic_string: "("basic_string: " "construction from null is not valid") |
637 | "construction from null is not valid")("basic_string: " "construction from null is not valid")); |
638 | const _CharT* __end = __s + traits_type::length(__s); |
639 | _M_construct(__s, __end, forward_iterator_tag()); |
640 | } |
641 | |
642 | /** |
643 | * @brief Construct string as multiple characters. |
644 | * @param __n Number of characters. |
645 | * @param __c Character to use. |
646 | * @param __a Allocator to use (default is default allocator). |
647 | */ |
648 | #if __cpp_deduction_guides201703L && ! defined _GLIBCXX_DEFINING_STRING_INSTANTIATIONS |
649 | // _GLIBCXX_RESOLVE_LIB_DEFECTS |
650 | // 3076. basic_string CTAD ambiguity |
651 | template<typename = _RequireAllocator<_Alloc>> |
652 | #endif |
653 | _GLIBCXX20_CONSTEXPRconstexpr |
654 | basic_string(size_type __n, _CharT __c, const _Alloc& __a = _Alloc()) |
655 | : _M_dataplus(_M_local_data(), __a) |
656 | { _M_construct(__n, __c); } |
657 | |
658 | #if __cplusplus202002L >= 201103L |
659 | /** |
660 | * @brief Move construct string. |
661 | * @param __str Source string. |
662 | * |
663 | * The newly-created string contains the exact contents of @a __str. |
664 | * @a __str is a valid, but unspecified string. |
665 | */ |
666 | _GLIBCXX20_CONSTEXPRconstexpr |
667 | basic_string(basic_string&& __str) noexcept |
668 | : _M_dataplus(_M_local_data(), std::move(__str._M_get_allocator())) |
669 | { |
670 | if (__str._M_is_local()) |
671 | { |
672 | traits_type::copy(_M_local_buf, __str._M_local_buf, |
673 | __str.length() + 1); |
674 | } |
675 | else |
676 | { |
677 | _M_data(__str._M_data()); |
678 | _M_capacity(__str._M_allocated_capacity); |
679 | } |
680 | |
681 | // Must use _M_length() here not _M_set_length() because |
682 | // basic_stringbuf relies on writing into unallocated capacity so |
683 | // we mess up the contents if we put a '\0' in the string. |
684 | _M_length(__str.length()); |
685 | __str._M_data(__str._M_local_data()); |
686 | __str._M_set_length(0); |
687 | } |
688 | |
689 | /** |
690 | * @brief Construct string from an initializer %list. |
691 | * @param __l std::initializer_list of characters. |
692 | * @param __a Allocator to use (default is default allocator). |
693 | */ |
694 | _GLIBCXX20_CONSTEXPRconstexpr |
695 | basic_string(initializer_list<_CharT> __l, const _Alloc& __a = _Alloc()) |
696 | : _M_dataplus(_M_local_data(), __a) |
697 | { _M_construct(__l.begin(), __l.end(), std::forward_iterator_tag()); } |
698 | |
699 | _GLIBCXX20_CONSTEXPRconstexpr |
700 | basic_string(const basic_string& __str, const _Alloc& __a) |
701 | : _M_dataplus(_M_local_data(), __a) |
702 | { _M_construct(__str.begin(), __str.end(), std::forward_iterator_tag()); } |
703 | |
704 | _GLIBCXX20_CONSTEXPRconstexpr |
705 | basic_string(basic_string&& __str, const _Alloc& __a) |
706 | noexcept(_Alloc_traits::_S_always_equal()) |
707 | : _M_dataplus(_M_local_data(), __a) |
708 | { |
709 | if (__str._M_is_local()) |
710 | { |
711 | traits_type::copy(_M_local_buf, __str._M_local_buf, |
712 | __str.length() + 1); |
713 | _M_length(__str.length()); |
714 | __str._M_set_length(0); |
715 | } |
716 | else if (_Alloc_traits::_S_always_equal() |
717 | || __str.get_allocator() == __a) |
718 | { |
719 | _M_data(__str._M_data()); |
720 | _M_length(__str.length()); |
721 | _M_capacity(__str._M_allocated_capacity); |
722 | __str._M_data(__str._M_local_buf); |
723 | __str._M_set_length(0); |
724 | } |
725 | else |
726 | _M_construct(__str.begin(), __str.end(), std::forward_iterator_tag()); |
727 | } |
728 | #endif // C++11 |
729 | |
730 | #if __cplusplus202002L >= 202100L |
731 | basic_string(nullptr_t) = delete; |
732 | basic_string& operator=(nullptr_t) = delete; |
733 | #endif // C++23 |
734 | |
735 | /** |
736 | * @brief Construct string as copy of a range. |
737 | * @param __beg Start of range. |
738 | * @param __end End of range. |
739 | * @param __a Allocator to use (default is default allocator). |
740 | */ |
741 | #if __cplusplus202002L >= 201103L |
742 | template<typename _InputIterator, |
743 | typename = std::_RequireInputIter<_InputIterator>> |
744 | #else |
745 | template<typename _InputIterator> |
746 | #endif |
747 | _GLIBCXX20_CONSTEXPRconstexpr |
748 | basic_string(_InputIterator __beg, _InputIterator __end, |
749 | const _Alloc& __a = _Alloc()) |
750 | : _M_dataplus(_M_local_data(), __a), _M_string_length(0) |
751 | { |
752 | #if __cplusplus202002L >= 201103L |
753 | _M_construct(__beg, __end, std::__iterator_category(__beg)); |
754 | #else |
755 | typedef typename std::__is_integer<_InputIterator>::__type _Integral; |
756 | _M_construct_aux(__beg, __end, _Integral()); |
757 | #endif |
758 | } |
759 | |
760 | #if __cplusplus202002L >= 201703L |
761 | /** |
762 | * @brief Construct string from a substring of a string_view. |
763 | * @param __t Source object convertible to string view. |
764 | * @param __pos The index of the first character to copy from __t. |
765 | * @param __n The number of characters to copy from __t. |
766 | * @param __a Allocator to use. |
767 | */ |
768 | template<typename _Tp, |
769 | typename = enable_if_t<is_convertible_v<const _Tp&, __sv_type>>> |
770 | _GLIBCXX20_CONSTEXPRconstexpr |
771 | basic_string(const _Tp& __t, size_type __pos, size_type __n, |
772 | const _Alloc& __a = _Alloc()) |
773 | : basic_string(_S_to_string_view(__t).substr(__pos, __n), __a) { } |
774 | |
775 | /** |
776 | * @brief Construct string from a string_view. |
777 | * @param __t Source object convertible to string view. |
778 | * @param __a Allocator to use (default is default allocator). |
779 | */ |
780 | template<typename _Tp, typename = _If_sv<_Tp, void>> |
781 | _GLIBCXX20_CONSTEXPRconstexpr |
782 | explicit |
783 | basic_string(const _Tp& __t, const _Alloc& __a = _Alloc()) |
784 | : basic_string(__sv_wrapper(_S_to_string_view(__t)), __a) { } |
785 | #endif // C++17 |
786 | |
787 | /** |
788 | * @brief Destroy the string instance. |
789 | */ |
790 | _GLIBCXX20_CONSTEXPRconstexpr |
791 | ~basic_string() |
792 | { _M_dispose(); } |
793 | |
794 | /** |
795 | * @brief Assign the value of @a str to this string. |
796 | * @param __str Source string. |
797 | */ |
798 | _GLIBCXX20_CONSTEXPRconstexpr |
799 | basic_string& |
800 | operator=(const basic_string& __str) |
801 | { |
802 | return this->assign(__str); |
803 | } |
804 | |
805 | /** |
806 | * @brief Copy contents of @a s into this string. |
807 | * @param __s Source null-terminated string. |
808 | */ |
809 | _GLIBCXX20_CONSTEXPRconstexpr |
810 | basic_string& |
811 | operator=(const _CharT* __s) |
812 | { return this->assign(__s); } |
813 | |
814 | /** |
815 | * @brief Set value to string of length 1. |
816 | * @param __c Source character. |
817 | * |
818 | * Assigning to a character makes this string length 1 and |
819 | * (*this)[0] == @a c. |
820 | */ |
821 | _GLIBCXX20_CONSTEXPRconstexpr |
822 | basic_string& |
823 | operator=(_CharT __c) |
824 | { |
825 | this->assign(1, __c); |
826 | return *this; |
827 | } |
828 | |
829 | #if __cplusplus202002L >= 201103L |
830 | /** |
831 | * @brief Move assign the value of @a str to this string. |
832 | * @param __str Source string. |
833 | * |
834 | * The contents of @a str are moved into this string (without copying). |
835 | * @a str is a valid, but unspecified string. |
836 | */ |
837 | // _GLIBCXX_RESOLVE_LIB_DEFECTS |
838 | // 2063. Contradictory requirements for string move assignment |
839 | _GLIBCXX20_CONSTEXPRconstexpr |
840 | basic_string& |
841 | operator=(basic_string&& __str) |
842 | noexcept(_Alloc_traits::_S_nothrow_move()) |
843 | { |
844 | const bool __equal_allocs = _Alloc_traits::_S_always_equal() |
845 | || _M_get_allocator() == __str._M_get_allocator(); |
846 | if (!_M_is_local() && _Alloc_traits::_S_propagate_on_move_assign() |
847 | && !__equal_allocs) |
848 | { |
849 | // Destroy existing storage before replacing allocator. |
850 | _M_destroy(_M_allocated_capacity); |
851 | _M_data(_M_local_data()); |
852 | _M_set_length(0); |
853 | } |
854 | // Replace allocator if POCMA is true. |
855 | std::__alloc_on_move(_M_get_allocator(), __str._M_get_allocator()); |
856 | |
857 | if (__str._M_is_local()) |
858 | { |
859 | // We've always got room for a short string, just copy it |
860 | // (unless this is a self-move, because that would violate the |
861 | // char_traits::copy precondition that the ranges don't overlap). |
862 | if (__builtin_expect(std::__addressof(__str) != this, true)) |
863 | { |
864 | if (__str.size()) |
865 | this->_S_copy(_M_data(), __str._M_data(), __str.size()); |
866 | _M_set_length(__str.size()); |
867 | } |
868 | } |
869 | else if (_Alloc_traits::_S_propagate_on_move_assign() || __equal_allocs) |
870 | { |
871 | // Just move the allocated pointer, our allocator can free it. |
872 | pointer __data = nullptr; |
873 | size_type __capacity; |
874 | if (!_M_is_local()) |
875 | { |
876 | if (__equal_allocs) |
877 | { |
878 | // __str can reuse our existing storage. |
879 | __data = _M_data(); |
880 | __capacity = _M_allocated_capacity; |
881 | } |
882 | else // __str can't use it, so free it. |
883 | _M_destroy(_M_allocated_capacity); |
884 | } |
885 | |
886 | _M_data(__str._M_data()); |
887 | _M_length(__str.length()); |
888 | _M_capacity(__str._M_allocated_capacity); |
889 | if (__data) |
890 | { |
891 | __str._M_data(__data); |
892 | __str._M_capacity(__capacity); |
893 | } |
894 | else |
895 | __str._M_data(__str._M_local_buf); |
896 | } |
897 | else // Need to do a deep copy |
898 | assign(__str); |
899 | __str.clear(); |
900 | return *this; |
901 | } |
902 | |
903 | /** |
904 | * @brief Set value to string constructed from initializer %list. |
905 | * @param __l std::initializer_list. |
906 | */ |
907 | _GLIBCXX20_CONSTEXPRconstexpr |
908 | basic_string& |
909 | operator=(initializer_list<_CharT> __l) |
910 | { |
911 | this->assign(__l.begin(), __l.size()); |
912 | return *this; |
913 | } |
914 | #endif // C++11 |
915 | |
916 | #if __cplusplus202002L >= 201703L |
917 | /** |
918 | * @brief Set value to string constructed from a string_view. |
919 | * @param __svt An object convertible to string_view. |
920 | */ |
921 | template<typename _Tp> |
922 | _GLIBCXX20_CONSTEXPRconstexpr |
923 | _If_sv<_Tp, basic_string&> |
924 | operator=(const _Tp& __svt) |
925 | { return this->assign(__svt); } |
926 | |
927 | /** |
928 | * @brief Convert to a string_view. |
929 | * @return A string_view. |
930 | */ |
931 | _GLIBCXX20_CONSTEXPRconstexpr |
932 | operator __sv_type() const noexcept |
933 | { return __sv_type(data(), size()); } |
934 | #endif // C++17 |
935 | |
936 | // Iterators: |
937 | /** |
938 | * Returns a read/write iterator that points to the first character in |
939 | * the %string. |
940 | */ |
941 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
942 | iterator |
943 | begin() _GLIBCXX_NOEXCEPTnoexcept |
944 | { return iterator(_M_data()); } |
945 | |
946 | /** |
947 | * Returns a read-only (constant) iterator that points to the first |
948 | * character in the %string. |
949 | */ |
950 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
951 | const_iterator |
952 | begin() const _GLIBCXX_NOEXCEPTnoexcept |
953 | { return const_iterator(_M_data()); } |
954 | |
955 | /** |
956 | * Returns a read/write iterator that points one past the last |
957 | * character in the %string. |
958 | */ |
959 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
960 | iterator |
961 | end() _GLIBCXX_NOEXCEPTnoexcept |
962 | { return iterator(_M_data() + this->size()); } |
963 | |
964 | /** |
965 | * Returns a read-only (constant) iterator that points one past the |
966 | * last character in the %string. |
967 | */ |
968 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
969 | const_iterator |
970 | end() const _GLIBCXX_NOEXCEPTnoexcept |
971 | { return const_iterator(_M_data() + this->size()); } |
972 | |
973 | /** |
974 | * Returns a read/write reverse iterator that points to the last |
975 | * character in the %string. Iteration is done in reverse element |
976 | * order. |
977 | */ |
978 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
979 | reverse_iterator |
980 | rbegin() _GLIBCXX_NOEXCEPTnoexcept |
981 | { return reverse_iterator(this->end()); } |
982 | |
983 | /** |
984 | * Returns a read-only (constant) reverse iterator that points |
985 | * to the last character in the %string. Iteration is done in |
986 | * reverse element order. |
987 | */ |
988 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
989 | const_reverse_iterator |
990 | rbegin() const _GLIBCXX_NOEXCEPTnoexcept |
991 | { return const_reverse_iterator(this->end()); } |
992 | |
993 | /** |
994 | * Returns a read/write reverse iterator that points to one before the |
995 | * first character in the %string. Iteration is done in reverse |
996 | * element order. |
997 | */ |
998 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
999 | reverse_iterator |
1000 | rend() _GLIBCXX_NOEXCEPTnoexcept |
1001 | { return reverse_iterator(this->begin()); } |
1002 | |
1003 | /** |
1004 | * Returns a read-only (constant) reverse iterator that points |
1005 | * to one before the first character in the %string. Iteration |
1006 | * is done in reverse element order. |
1007 | */ |
1008 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
1009 | const_reverse_iterator |
1010 | rend() const _GLIBCXX_NOEXCEPTnoexcept |
1011 | { return const_reverse_iterator(this->begin()); } |
1012 | |
1013 | #if __cplusplus202002L >= 201103L |
1014 | /** |
1015 | * Returns a read-only (constant) iterator that points to the first |
1016 | * character in the %string. |
1017 | */ |
1018 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
1019 | const_iterator |
1020 | cbegin() const noexcept |
1021 | { return const_iterator(this->_M_data()); } |
1022 | |
1023 | /** |
1024 | * Returns a read-only (constant) iterator that points one past the |
1025 | * last character in the %string. |
1026 | */ |
1027 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
1028 | const_iterator |
1029 | cend() const noexcept |
1030 | { return const_iterator(this->_M_data() + this->size()); } |
1031 | |
1032 | /** |
1033 | * Returns a read-only (constant) reverse iterator that points |
1034 | * to the last character in the %string. Iteration is done in |
1035 | * reverse element order. |
1036 | */ |
1037 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
1038 | const_reverse_iterator |
1039 | crbegin() const noexcept |
1040 | { return const_reverse_iterator(this->end()); } |
1041 | |
1042 | /** |
1043 | * Returns a read-only (constant) reverse iterator that points |
1044 | * to one before the first character in the %string. Iteration |
1045 | * is done in reverse element order. |
1046 | */ |
1047 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
1048 | const_reverse_iterator |
1049 | crend() const noexcept |
1050 | { return const_reverse_iterator(this->begin()); } |
1051 | #endif |
1052 | |
1053 | public: |
1054 | // Capacity: |
1055 | /// Returns the number of characters in the string, not including any |
1056 | /// null-termination. |
1057 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
1058 | size_type |
1059 | size() const _GLIBCXX_NOEXCEPTnoexcept |
1060 | { return _M_string_length; } |
1061 | |
1062 | /// Returns the number of characters in the string, not including any |
1063 | /// null-termination. |
1064 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
1065 | size_type |
1066 | length() const _GLIBCXX_NOEXCEPTnoexcept |
1067 | { return _M_string_length; } |
1068 | |
1069 | /// Returns the size() of the largest possible %string. |
1070 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
1071 | size_type |
1072 | max_size() const _GLIBCXX_NOEXCEPTnoexcept |
1073 | { return (_Alloc_traits::max_size(_M_get_allocator()) - 1) / 2; } |
1074 | |
1075 | /** |
1076 | * @brief Resizes the %string to the specified number of characters. |
1077 | * @param __n Number of characters the %string should contain. |
1078 | * @param __c Character to fill any new elements. |
1079 | * |
1080 | * This function will %resize the %string to the specified |
1081 | * number of characters. If the number is smaller than the |
1082 | * %string's current size the %string is truncated, otherwise |
1083 | * the %string is extended and new elements are %set to @a __c. |
1084 | */ |
1085 | _GLIBCXX20_CONSTEXPRconstexpr |
1086 | void |
1087 | resize(size_type __n, _CharT __c); |
1088 | |
1089 | /** |
1090 | * @brief Resizes the %string to the specified number of characters. |
1091 | * @param __n Number of characters the %string should contain. |
1092 | * |
1093 | * This function will resize the %string to the specified length. If |
1094 | * the new size is smaller than the %string's current size the %string |
1095 | * is truncated, otherwise the %string is extended and new characters |
1096 | * are default-constructed. For basic types such as char, this means |
1097 | * setting them to 0. |
1098 | */ |
1099 | _GLIBCXX20_CONSTEXPRconstexpr |
1100 | void |
1101 | resize(size_type __n) |
1102 | { this->resize(__n, _CharT()); } |
1103 | |
1104 | #if __cplusplus202002L >= 201103L |
1105 | #pragma GCC diagnostic push |
1106 | #pragma GCC diagnostic ignored "-Wdeprecated-declarations" |
1107 | /// A non-binding request to reduce capacity() to size(). |
1108 | _GLIBCXX20_CONSTEXPRconstexpr |
1109 | void |
1110 | shrink_to_fit() noexcept |
1111 | { reserve(); } |
1112 | #pragma GCC diagnostic pop |
1113 | #endif |
1114 | |
1115 | #if __cplusplus202002L > 202002L |
1116 | #define __cpp_lib_string_resize_and_overwrite 202110L |
1117 | /** Resize the string and call a function to fill it. |
1118 | * |
1119 | * @param __n The maximum size requested. |
1120 | * @param __op A callable object that writes characters to the string. |
1121 | * |
1122 | * This is a low-level function that is easy to misuse, be careful. |
1123 | * |
1124 | * Calling `str.resize_and_overwrite(n, op)` will reserve at least `n` |
1125 | * characters in `str`, evaluate `n2 = std::move(op)(str.data(), n)`, |
1126 | * and finally set the string length to `n2` (adding a null terminator |
1127 | * at the end). The function object `op` is allowed to write to the |
1128 | * extra capacity added by the initial reserve operation, which is not |
1129 | * allowed if you just call `str.reserve(n)` yourself. |
1130 | * |
1131 | * This can be used to efficiently fill a `string` buffer without the |
1132 | * overhead of zero-initializing characters that will be overwritten |
1133 | * anyway. |
1134 | * |
1135 | * The callable `op` must not access the string directly (only through |
1136 | * the pointer passed as its first argument), must not write more than |
1137 | * `n` characters to the string, must return a value no greater than `n`, |
1138 | * and must ensure that all characters up to the returned length are |
1139 | * valid after it returns (i.e. there must be no uninitialized values |
1140 | * left in the string after the call, because accessing them would |
1141 | * have undefined behaviour). If `op` exits by throwing an exception |
1142 | * the behaviour is undefined. |
1143 | * |
1144 | * @since C++23 |
1145 | */ |
1146 | template<typename _Operation> |
1147 | constexpr void |
1148 | resize_and_overwrite(size_type __n, _Operation __op); |
1149 | #endif |
1150 | |
1151 | /** |
1152 | * Returns the total number of characters that the %string can hold |
1153 | * before needing to allocate more memory. |
1154 | */ |
1155 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
1156 | size_type |
1157 | capacity() const _GLIBCXX_NOEXCEPTnoexcept |
1158 | { |
1159 | return _M_is_local() ? size_type(_S_local_capacity) |
1160 | : _M_allocated_capacity; |
1161 | } |
1162 | |
1163 | /** |
1164 | * @brief Attempt to preallocate enough memory for specified number of |
1165 | * characters. |
1166 | * @param __res_arg Number of characters required. |
1167 | * @throw std::length_error If @a __res_arg exceeds @c max_size(). |
1168 | * |
1169 | * This function attempts to reserve enough memory for the |
1170 | * %string to hold the specified number of characters. If the |
1171 | * number requested is more than max_size(), length_error is |
1172 | * thrown. |
1173 | * |
1174 | * The advantage of this function is that if optimal code is a |
1175 | * necessity and the user can determine the string length that will be |
1176 | * required, the user can reserve the memory in %advance, and thus |
1177 | * prevent a possible reallocation of memory and copying of %string |
1178 | * data. |
1179 | */ |
1180 | _GLIBCXX20_CONSTEXPRconstexpr |
1181 | void |
1182 | reserve(size_type __res_arg); |
1183 | |
1184 | /** |
1185 | * Equivalent to shrink_to_fit(). |
1186 | */ |
1187 | #if __cplusplus202002L > 201703L |
1188 | [[deprecated("use shrink_to_fit() instead")]] |
1189 | #endif |
1190 | _GLIBCXX20_CONSTEXPRconstexpr |
1191 | void |
1192 | reserve(); |
1193 | |
1194 | /** |
1195 | * Erases the string, making it empty. |
1196 | */ |
1197 | _GLIBCXX20_CONSTEXPRconstexpr |
1198 | void |
1199 | clear() _GLIBCXX_NOEXCEPTnoexcept |
1200 | { _M_set_length(0); } |
1201 | |
1202 | /** |
1203 | * Returns true if the %string is empty. Equivalent to |
1204 | * <code>*this == ""</code>. |
1205 | */ |
1206 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
1207 | bool |
1208 | empty() const _GLIBCXX_NOEXCEPTnoexcept |
1209 | { return this->size() == 0; } |
1210 | |
1211 | // Element access: |
1212 | /** |
1213 | * @brief Subscript access to the data contained in the %string. |
1214 | * @param __pos The index of the character to access. |
1215 | * @return Read-only (constant) reference to the character. |
1216 | * |
1217 | * This operator allows for easy, array-style, data access. |
1218 | * Note that data access with this operator is unchecked and |
1219 | * out_of_range lookups are not defined. (For checked lookups |
1220 | * see at().) |
1221 | */ |
1222 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
1223 | const_reference |
1224 | operator[] (size_type __pos) const _GLIBCXX_NOEXCEPTnoexcept |
1225 | { |
1226 | __glibcxx_assert(__pos <= size())do { if (std::__is_constant_evaluated() && !bool(__pos <= size())) __builtin_unreachable(); } while (false); |
1227 | return _M_data()[__pos]; |
1228 | } |
1229 | |
1230 | /** |
1231 | * @brief Subscript access to the data contained in the %string. |
1232 | * @param __pos The index of the character to access. |
1233 | * @return Read/write reference to the character. |
1234 | * |
1235 | * This operator allows for easy, array-style, data access. |
1236 | * Note that data access with this operator is unchecked and |
1237 | * out_of_range lookups are not defined. (For checked lookups |
1238 | * see at().) |
1239 | */ |
1240 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
1241 | reference |
1242 | operator[](size_type __pos) |
1243 | { |
1244 | // Allow pos == size() both in C++98 mode, as v3 extension, |
1245 | // and in C++11 mode. |
1246 | __glibcxx_assert(__pos <= size())do { if (std::__is_constant_evaluated() && !bool(__pos <= size())) __builtin_unreachable(); } while (false); |
1247 | // In pedantic mode be strict in C++98 mode. |
1248 | _GLIBCXX_DEBUG_PEDASSERT(__cplusplus >= 201103L || __pos < size()); |
1249 | return _M_data()[__pos]; |
1250 | } |
1251 | |
1252 | /** |
1253 | * @brief Provides access to the data contained in the %string. |
1254 | * @param __n The index of the character to access. |
1255 | * @return Read-only (const) reference to the character. |
1256 | * @throw std::out_of_range If @a n is an invalid index. |
1257 | * |
1258 | * This function provides for safer data access. The parameter is |
1259 | * first checked that it is in the range of the string. The function |
1260 | * throws out_of_range if the check fails. |
1261 | */ |
1262 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
1263 | const_reference |
1264 | at(size_type __n) const |
1265 | { |
1266 | if (__n >= this->size()) |
1267 | __throw_out_of_range_fmt(__N("basic_string::at: __n "("basic_string::at: __n " "(which is %zu) >= this->size() " "(which is %zu)") |
1268 | "(which is %zu) >= this->size() "("basic_string::at: __n " "(which is %zu) >= this->size() " "(which is %zu)") |
1269 | "(which is %zu)")("basic_string::at: __n " "(which is %zu) >= this->size() " "(which is %zu)"), |
1270 | __n, this->size()); |
1271 | return _M_data()[__n]; |
1272 | } |
1273 | |
1274 | /** |
1275 | * @brief Provides access to the data contained in the %string. |
1276 | * @param __n The index of the character to access. |
1277 | * @return Read/write reference to the character. |
1278 | * @throw std::out_of_range If @a n is an invalid index. |
1279 | * |
1280 | * This function provides for safer data access. The parameter is |
1281 | * first checked that it is in the range of the string. The function |
1282 | * throws out_of_range if the check fails. |
1283 | */ |
1284 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
1285 | reference |
1286 | at(size_type __n) |
1287 | { |
1288 | if (__n >= size()) |
1289 | __throw_out_of_range_fmt(__N("basic_string::at: __n "("basic_string::at: __n " "(which is %zu) >= this->size() " "(which is %zu)") |
1290 | "(which is %zu) >= this->size() "("basic_string::at: __n " "(which is %zu) >= this->size() " "(which is %zu)") |
1291 | "(which is %zu)")("basic_string::at: __n " "(which is %zu) >= this->size() " "(which is %zu)"), |
1292 | __n, this->size()); |
1293 | return _M_data()[__n]; |
1294 | } |
1295 | |
1296 | #if __cplusplus202002L >= 201103L |
1297 | /** |
1298 | * Returns a read/write reference to the data at the first |
1299 | * element of the %string. |
1300 | */ |
1301 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
1302 | reference |
1303 | front() noexcept |
1304 | { |
1305 | __glibcxx_assert(!empty())do { if (std::__is_constant_evaluated() && !bool(!empty ())) __builtin_unreachable(); } while (false); |
1306 | return operator[](0); |
1307 | } |
1308 | |
1309 | /** |
1310 | * Returns a read-only (constant) reference to the data at the first |
1311 | * element of the %string. |
1312 | */ |
1313 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
1314 | const_reference |
1315 | front() const noexcept |
1316 | { |
1317 | __glibcxx_assert(!empty())do { if (std::__is_constant_evaluated() && !bool(!empty ())) __builtin_unreachable(); } while (false); |
1318 | return operator[](0); |
1319 | } |
1320 | |
1321 | /** |
1322 | * Returns a read/write reference to the data at the last |
1323 | * element of the %string. |
1324 | */ |
1325 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
1326 | reference |
1327 | back() noexcept |
1328 | { |
1329 | __glibcxx_assert(!empty())do { if (std::__is_constant_evaluated() && !bool(!empty ())) __builtin_unreachable(); } while (false); |
1330 | return operator[](this->size() - 1); |
1331 | } |
1332 | |
1333 | /** |
1334 | * Returns a read-only (constant) reference to the data at the |
1335 | * last element of the %string. |
1336 | */ |
1337 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
1338 | const_reference |
1339 | back() const noexcept |
1340 | { |
1341 | __glibcxx_assert(!empty())do { if (std::__is_constant_evaluated() && !bool(!empty ())) __builtin_unreachable(); } while (false); |
1342 | return operator[](this->size() - 1); |
1343 | } |
1344 | #endif |
1345 | |
1346 | // Modifiers: |
1347 | /** |
1348 | * @brief Append a string to this string. |
1349 | * @param __str The string to append. |
1350 | * @return Reference to this string. |
1351 | */ |
1352 | _GLIBCXX20_CONSTEXPRconstexpr |
1353 | basic_string& |
1354 | operator+=(const basic_string& __str) |
1355 | { return this->append(__str); } |
1356 | |
1357 | /** |
1358 | * @brief Append a C string. |
1359 | * @param __s The C string to append. |
1360 | * @return Reference to this string. |
1361 | */ |
1362 | _GLIBCXX20_CONSTEXPRconstexpr |
1363 | basic_string& |
1364 | operator+=(const _CharT* __s) |
1365 | { return this->append(__s); } |
1366 | |
1367 | /** |
1368 | * @brief Append a character. |
1369 | * @param __c The character to append. |
1370 | * @return Reference to this string. |
1371 | */ |
1372 | _GLIBCXX20_CONSTEXPRconstexpr |
1373 | basic_string& |
1374 | operator+=(_CharT __c) |
1375 | { |
1376 | this->push_back(__c); |
1377 | return *this; |
1378 | } |
1379 | |
1380 | #if __cplusplus202002L >= 201103L |
1381 | /** |
1382 | * @brief Append an initializer_list of characters. |
1383 | * @param __l The initializer_list of characters to be appended. |
1384 | * @return Reference to this string. |
1385 | */ |
1386 | _GLIBCXX20_CONSTEXPRconstexpr |
1387 | basic_string& |
1388 | operator+=(initializer_list<_CharT> __l) |
1389 | { return this->append(__l.begin(), __l.size()); } |
1390 | #endif // C++11 |
1391 | |
1392 | #if __cplusplus202002L >= 201703L |
1393 | /** |
1394 | * @brief Append a string_view. |
1395 | * @param __svt An object convertible to string_view to be appended. |
1396 | * @return Reference to this string. |
1397 | */ |
1398 | template<typename _Tp> |
1399 | _GLIBCXX20_CONSTEXPRconstexpr |
1400 | _If_sv<_Tp, basic_string&> |
1401 | operator+=(const _Tp& __svt) |
1402 | { return this->append(__svt); } |
1403 | #endif // C++17 |
1404 | |
1405 | /** |
1406 | * @brief Append a string to this string. |
1407 | * @param __str The string to append. |
1408 | * @return Reference to this string. |
1409 | */ |
1410 | _GLIBCXX20_CONSTEXPRconstexpr |
1411 | basic_string& |
1412 | append(const basic_string& __str) |
1413 | { return this->append(__str._M_data(), __str.size()); } |
1414 | |
1415 | /** |
1416 | * @brief Append a substring. |
1417 | * @param __str The string to append. |
1418 | * @param __pos Index of the first character of str to append. |
1419 | * @param __n The number of characters to append. |
1420 | * @return Reference to this string. |
1421 | * @throw std::out_of_range if @a __pos is not a valid index. |
1422 | * |
1423 | * This function appends @a __n characters from @a __str |
1424 | * starting at @a __pos to this string. If @a __n is is larger |
1425 | * than the number of available characters in @a __str, the |
1426 | * remainder of @a __str is appended. |
1427 | */ |
1428 | _GLIBCXX20_CONSTEXPRconstexpr |
1429 | basic_string& |
1430 | append(const basic_string& __str, size_type __pos, size_type __n = npos) |
1431 | { return this->append(__str._M_data() |
1432 | + __str._M_check(__pos, "basic_string::append"), |
1433 | __str._M_limit(__pos, __n)); } |
1434 | |
1435 | /** |
1436 | * @brief Append a C substring. |
1437 | * @param __s The C string to append. |
1438 | * @param __n The number of characters to append. |
1439 | * @return Reference to this string. |
1440 | */ |
1441 | _GLIBCXX20_CONSTEXPRconstexpr |
1442 | basic_string& |
1443 | append(const _CharT* __s, size_type __n) |
1444 | { |
1445 | __glibcxx_requires_string_len(__s, __n); |
1446 | _M_check_length(size_type(0), __n, "basic_string::append"); |
1447 | return _M_append(__s, __n); |
1448 | } |
1449 | |
1450 | /** |
1451 | * @brief Append a C string. |
1452 | * @param __s The C string to append. |
1453 | * @return Reference to this string. |
1454 | */ |
1455 | _GLIBCXX20_CONSTEXPRconstexpr |
1456 | basic_string& |
1457 | append(const _CharT* __s) |
1458 | { |
1459 | __glibcxx_requires_string(__s); |
1460 | const size_type __n = traits_type::length(__s); |
1461 | _M_check_length(size_type(0), __n, "basic_string::append"); |
1462 | return _M_append(__s, __n); |
1463 | } |
1464 | |
1465 | /** |
1466 | * @brief Append multiple characters. |
1467 | * @param __n The number of characters to append. |
1468 | * @param __c The character to use. |
1469 | * @return Reference to this string. |
1470 | * |
1471 | * Appends __n copies of __c to this string. |
1472 | */ |
1473 | _GLIBCXX20_CONSTEXPRconstexpr |
1474 | basic_string& |
1475 | append(size_type __n, _CharT __c) |
1476 | { return _M_replace_aux(this->size(), size_type(0), __n, __c); } |
1477 | |
1478 | #if __cplusplus202002L >= 201103L |
1479 | /** |
1480 | * @brief Append an initializer_list of characters. |
1481 | * @param __l The initializer_list of characters to append. |
1482 | * @return Reference to this string. |
1483 | */ |
1484 | _GLIBCXX20_CONSTEXPRconstexpr |
1485 | basic_string& |
1486 | append(initializer_list<_CharT> __l) |
1487 | { return this->append(__l.begin(), __l.size()); } |
1488 | #endif // C++11 |
1489 | |
1490 | /** |
1491 | * @brief Append a range of characters. |
1492 | * @param __first Iterator referencing the first character to append. |
1493 | * @param __last Iterator marking the end of the range. |
1494 | * @return Reference to this string. |
1495 | * |
1496 | * Appends characters in the range [__first,__last) to this string. |
1497 | */ |
1498 | #if __cplusplus202002L >= 201103L |
1499 | template<class _InputIterator, |
1500 | typename = std::_RequireInputIter<_InputIterator>> |
1501 | _GLIBCXX20_CONSTEXPRconstexpr |
1502 | #else |
1503 | template<class _InputIterator> |
1504 | #endif |
1505 | basic_string& |
1506 | append(_InputIterator __first, _InputIterator __last) |
1507 | { return this->replace(end(), end(), __first, __last); } |
1508 | |
1509 | #if __cplusplus202002L >= 201703L |
1510 | /** |
1511 | * @brief Append a string_view. |
1512 | * @param __svt An object convertible to string_view to be appended. |
1513 | * @return Reference to this string. |
1514 | */ |
1515 | template<typename _Tp> |
1516 | _GLIBCXX20_CONSTEXPRconstexpr |
1517 | _If_sv<_Tp, basic_string&> |
1518 | append(const _Tp& __svt) |
1519 | { |
1520 | __sv_type __sv = __svt; |
1521 | return this->append(__sv.data(), __sv.size()); |
1522 | } |
1523 | |
1524 | /** |
1525 | * @brief Append a range of characters from a string_view. |
1526 | * @param __svt An object convertible to string_view to be appended from. |
1527 | * @param __pos The position in the string_view to append from. |
1528 | * @param __n The number of characters to append from the string_view. |
1529 | * @return Reference to this string. |
1530 | */ |
1531 | template<typename _Tp> |
1532 | _GLIBCXX20_CONSTEXPRconstexpr |
1533 | _If_sv<_Tp, basic_string&> |
1534 | append(const _Tp& __svt, size_type __pos, size_type __n = npos) |
1535 | { |
1536 | __sv_type __sv = __svt; |
1537 | return _M_append(__sv.data() |
1538 | + std::__sv_check(__sv.size(), __pos, "basic_string::append"), |
1539 | std::__sv_limit(__sv.size(), __pos, __n)); |
1540 | } |
1541 | #endif // C++17 |
1542 | |
1543 | /** |
1544 | * @brief Append a single character. |
1545 | * @param __c Character to append. |
1546 | */ |
1547 | _GLIBCXX20_CONSTEXPRconstexpr |
1548 | void |
1549 | push_back(_CharT __c) |
1550 | { |
1551 | const size_type __size = this->size(); |
1552 | if (__size + 1 > this->capacity()) |
1553 | this->_M_mutate(__size, size_type(0), 0, size_type(1)); |
1554 | traits_type::assign(this->_M_data()[__size], __c); |
1555 | this->_M_set_length(__size + 1); |
1556 | } |
1557 | |
1558 | /** |
1559 | * @brief Set value to contents of another string. |
1560 | * @param __str Source string to use. |
1561 | * @return Reference to this string. |
1562 | */ |
1563 | _GLIBCXX20_CONSTEXPRconstexpr |
1564 | basic_string& |
1565 | assign(const basic_string& __str) |
1566 | { |
1567 | #if __cplusplus202002L >= 201103L |
1568 | if (_Alloc_traits::_S_propagate_on_copy_assign()) |
1569 | { |
1570 | if (!_Alloc_traits::_S_always_equal() && !_M_is_local() |
1571 | && _M_get_allocator() != __str._M_get_allocator()) |
1572 | { |
1573 | // Propagating allocator cannot free existing storage so must |
1574 | // deallocate it before replacing current allocator. |
1575 | if (__str.size() <= _S_local_capacity) |
1576 | { |
1577 | _M_destroy(_M_allocated_capacity); |
1578 | _M_data(_M_use_local_data()); |
1579 | _M_set_length(0); |
1580 | } |
1581 | else |
1582 | { |
1583 | const auto __len = __str.size(); |
1584 | auto __alloc = __str._M_get_allocator(); |
1585 | // If this allocation throws there are no effects: |
1586 | auto __ptr = _S_allocate(__alloc, __len + 1); |
1587 | _M_destroy(_M_allocated_capacity); |
1588 | _M_data(__ptr); |
1589 | _M_capacity(__len); |
1590 | _M_set_length(__len); |
1591 | } |
1592 | } |
1593 | std::__alloc_on_copy(_M_get_allocator(), __str._M_get_allocator()); |
1594 | } |
1595 | #endif |
1596 | this->_M_assign(__str); |
1597 | return *this; |
1598 | } |
1599 | |
1600 | #if __cplusplus202002L >= 201103L |
1601 | /** |
1602 | * @brief Set value to contents of another string. |
1603 | * @param __str Source string to use. |
1604 | * @return Reference to this string. |
1605 | * |
1606 | * This function sets this string to the exact contents of @a __str. |
1607 | * @a __str is a valid, but unspecified string. |
1608 | */ |
1609 | _GLIBCXX20_CONSTEXPRconstexpr |
1610 | basic_string& |
1611 | assign(basic_string&& __str) |
1612 | noexcept(_Alloc_traits::_S_nothrow_move()) |
1613 | { |
1614 | // _GLIBCXX_RESOLVE_LIB_DEFECTS |
1615 | // 2063. Contradictory requirements for string move assignment |
1616 | return *this = std::move(__str); |
1617 | } |
1618 | #endif // C++11 |
1619 | |
1620 | /** |
1621 | * @brief Set value to a substring of a string. |
1622 | * @param __str The string to use. |
1623 | * @param __pos Index of the first character of str. |
1624 | * @param __n Number of characters to use. |
1625 | * @return Reference to this string. |
1626 | * @throw std::out_of_range if @a pos is not a valid index. |
1627 | * |
1628 | * This function sets this string to the substring of @a __str |
1629 | * consisting of @a __n characters at @a __pos. If @a __n is |
1630 | * is larger than the number of available characters in @a |
1631 | * __str, the remainder of @a __str is used. |
1632 | */ |
1633 | _GLIBCXX20_CONSTEXPRconstexpr |
1634 | basic_string& |
1635 | assign(const basic_string& __str, size_type __pos, size_type __n = npos) |
1636 | { return _M_replace(size_type(0), this->size(), __str._M_data() |
1637 | + __str._M_check(__pos, "basic_string::assign"), |
1638 | __str._M_limit(__pos, __n)); } |
1639 | |
1640 | /** |
1641 | * @brief Set value to a C substring. |
1642 | * @param __s The C string to use. |
1643 | * @param __n Number of characters to use. |
1644 | * @return Reference to this string. |
1645 | * |
1646 | * This function sets the value of this string to the first @a __n |
1647 | * characters of @a __s. If @a __n is is larger than the number of |
1648 | * available characters in @a __s, the remainder of @a __s is used. |
1649 | */ |
1650 | _GLIBCXX20_CONSTEXPRconstexpr |
1651 | basic_string& |
1652 | assign(const _CharT* __s, size_type __n) |
1653 | { |
1654 | __glibcxx_requires_string_len(__s, __n); |
1655 | return _M_replace(size_type(0), this->size(), __s, __n); |
1656 | } |
1657 | |
1658 | /** |
1659 | * @brief Set value to contents of a C string. |
1660 | * @param __s The C string to use. |
1661 | * @return Reference to this string. |
1662 | * |
1663 | * This function sets the value of this string to the value of @a __s. |
1664 | * The data is copied, so there is no dependence on @a __s once the |
1665 | * function returns. |
1666 | */ |
1667 | _GLIBCXX20_CONSTEXPRconstexpr |
1668 | basic_string& |
1669 | assign(const _CharT* __s) |
1670 | { |
1671 | __glibcxx_requires_string(__s); |
1672 | return _M_replace(size_type(0), this->size(), __s, |
1673 | traits_type::length(__s)); |
1674 | } |
1675 | |
1676 | /** |
1677 | * @brief Set value to multiple characters. |
1678 | * @param __n Length of the resulting string. |
1679 | * @param __c The character to use. |
1680 | * @return Reference to this string. |
1681 | * |
1682 | * This function sets the value of this string to @a __n copies of |
1683 | * character @a __c. |
1684 | */ |
1685 | _GLIBCXX20_CONSTEXPRconstexpr |
1686 | basic_string& |
1687 | assign(size_type __n, _CharT __c) |
1688 | { return _M_replace_aux(size_type(0), this->size(), __n, __c); } |
1689 | |
1690 | /** |
1691 | * @brief Set value to a range of characters. |
1692 | * @param __first Iterator referencing the first character to append. |
1693 | * @param __last Iterator marking the end of the range. |
1694 | * @return Reference to this string. |
1695 | * |
1696 | * Sets value of string to characters in the range [__first,__last). |
1697 | */ |
1698 | #if __cplusplus202002L >= 201103L |
1699 | template<class _InputIterator, |
1700 | typename = std::_RequireInputIter<_InputIterator>> |
1701 | _GLIBCXX20_CONSTEXPRconstexpr |
1702 | #else |
1703 | template<class _InputIterator> |
1704 | #endif |
1705 | basic_string& |
1706 | assign(_InputIterator __first, _InputIterator __last) |
1707 | { return this->replace(begin(), end(), __first, __last); } |
1708 | |
1709 | #if __cplusplus202002L >= 201103L |
1710 | /** |
1711 | * @brief Set value to an initializer_list of characters. |
1712 | * @param __l The initializer_list of characters to assign. |
1713 | * @return Reference to this string. |
1714 | */ |
1715 | _GLIBCXX20_CONSTEXPRconstexpr |
1716 | basic_string& |
1717 | assign(initializer_list<_CharT> __l) |
1718 | { return this->assign(__l.begin(), __l.size()); } |
1719 | #endif // C++11 |
1720 | |
1721 | #if __cplusplus202002L >= 201703L |
1722 | /** |
1723 | * @brief Set value from a string_view. |
1724 | * @param __svt The source object convertible to string_view. |
1725 | * @return Reference to this string. |
1726 | */ |
1727 | template<typename _Tp> |
1728 | _GLIBCXX20_CONSTEXPRconstexpr |
1729 | _If_sv<_Tp, basic_string&> |
1730 | assign(const _Tp& __svt) |
1731 | { |
1732 | __sv_type __sv = __svt; |
1733 | return this->assign(__sv.data(), __sv.size()); |
1734 | } |
1735 | |
1736 | /** |
1737 | * @brief Set value from a range of characters in a string_view. |
1738 | * @param __svt The source object convertible to string_view. |
1739 | * @param __pos The position in the string_view to assign from. |
1740 | * @param __n The number of characters to assign. |
1741 | * @return Reference to this string. |
1742 | */ |
1743 | template<typename _Tp> |
1744 | _GLIBCXX20_CONSTEXPRconstexpr |
1745 | _If_sv<_Tp, basic_string&> |
1746 | assign(const _Tp& __svt, size_type __pos, size_type __n = npos) |
1747 | { |
1748 | __sv_type __sv = __svt; |
1749 | return _M_replace(size_type(0), this->size(), |
1750 | __sv.data() |
1751 | + std::__sv_check(__sv.size(), __pos, "basic_string::assign"), |
1752 | std::__sv_limit(__sv.size(), __pos, __n)); |
1753 | } |
1754 | #endif // C++17 |
1755 | |
1756 | #if __cplusplus202002L >= 201103L |
1757 | /** |
1758 | * @brief Insert multiple characters. |
1759 | * @param __p Const_iterator referencing location in string to |
1760 | * insert at. |
1761 | * @param __n Number of characters to insert |
1762 | * @param __c The character to insert. |
1763 | * @return Iterator referencing the first inserted char. |
1764 | * @throw std::length_error If new length exceeds @c max_size(). |
1765 | * |
1766 | * Inserts @a __n copies of character @a __c starting at the |
1767 | * position referenced by iterator @a __p. If adding |
1768 | * characters causes the length to exceed max_size(), |
1769 | * length_error is thrown. The value of the string doesn't |
1770 | * change if an error is thrown. |
1771 | */ |
1772 | _GLIBCXX20_CONSTEXPRconstexpr |
1773 | iterator |
1774 | insert(const_iterator __p, size_type __n, _CharT __c) |
1775 | { |
1776 | _GLIBCXX_DEBUG_PEDASSERT(__p >= begin() && __p <= end()); |
1777 | const size_type __pos = __p - begin(); |
1778 | this->replace(__p, __p, __n, __c); |
1779 | return iterator(this->_M_data() + __pos); |
1780 | } |
1781 | #else |
1782 | /** |
1783 | * @brief Insert multiple characters. |
1784 | * @param __p Iterator referencing location in string to insert at. |
1785 | * @param __n Number of characters to insert |
1786 | * @param __c The character to insert. |
1787 | * @throw std::length_error If new length exceeds @c max_size(). |
1788 | * |
1789 | * Inserts @a __n copies of character @a __c starting at the |
1790 | * position referenced by iterator @a __p. If adding |
1791 | * characters causes the length to exceed max_size(), |
1792 | * length_error is thrown. The value of the string doesn't |
1793 | * change if an error is thrown. |
1794 | */ |
1795 | void |
1796 | insert(iterator __p, size_type __n, _CharT __c) |
1797 | { this->replace(__p, __p, __n, __c); } |
1798 | #endif |
1799 | |
1800 | #if __cplusplus202002L >= 201103L |
1801 | /** |
1802 | * @brief Insert a range of characters. |
1803 | * @param __p Const_iterator referencing location in string to |
1804 | * insert at. |
1805 | * @param __beg Start of range. |
1806 | * @param __end End of range. |
1807 | * @return Iterator referencing the first inserted char. |
1808 | * @throw std::length_error If new length exceeds @c max_size(). |
1809 | * |
1810 | * Inserts characters in range [beg,end). If adding characters |
1811 | * causes the length to exceed max_size(), length_error is |
1812 | * thrown. The value of the string doesn't change if an error |
1813 | * is thrown. |
1814 | */ |
1815 | template<class _InputIterator, |
1816 | typename = std::_RequireInputIter<_InputIterator>> |
1817 | _GLIBCXX20_CONSTEXPRconstexpr |
1818 | iterator |
1819 | insert(const_iterator __p, _InputIterator __beg, _InputIterator __end) |
1820 | { |
1821 | _GLIBCXX_DEBUG_PEDASSERT(__p >= begin() && __p <= end()); |
1822 | const size_type __pos = __p - begin(); |
1823 | this->replace(__p, __p, __beg, __end); |
1824 | return iterator(this->_M_data() + __pos); |
1825 | } |
1826 | #else |
1827 | /** |
1828 | * @brief Insert a range of characters. |
1829 | * @param __p Iterator referencing location in string to insert at. |
1830 | * @param __beg Start of range. |
1831 | * @param __end End of range. |
1832 | * @throw std::length_error If new length exceeds @c max_size(). |
1833 | * |
1834 | * Inserts characters in range [__beg,__end). If adding |
1835 | * characters causes the length to exceed max_size(), |
1836 | * length_error is thrown. The value of the string doesn't |
1837 | * change if an error is thrown. |
1838 | */ |
1839 | template<class _InputIterator> |
1840 | void |
1841 | insert(iterator __p, _InputIterator __beg, _InputIterator __end) |
1842 | { this->replace(__p, __p, __beg, __end); } |
1843 | #endif |
1844 | |
1845 | #if __cplusplus202002L >= 201103L |
1846 | /** |
1847 | * @brief Insert an initializer_list of characters. |
1848 | * @param __p Iterator referencing location in string to insert at. |
1849 | * @param __l The initializer_list of characters to insert. |
1850 | * @throw std::length_error If new length exceeds @c max_size(). |
1851 | */ |
1852 | _GLIBCXX20_CONSTEXPRconstexpr |
1853 | iterator |
1854 | insert(const_iterator __p, initializer_list<_CharT> __l) |
1855 | { return this->insert(__p, __l.begin(), __l.end()); } |
1856 | |
1857 | #ifdef _GLIBCXX_DEFINING_STRING_INSTANTIATIONS |
1858 | // See PR libstdc++/83328 |
1859 | void |
1860 | insert(iterator __p, initializer_list<_CharT> __l) |
1861 | { |
1862 | _GLIBCXX_DEBUG_PEDASSERT(__p >= begin() && __p <= end()); |
1863 | this->insert(__p - begin(), __l.begin(), __l.size()); |
1864 | } |
1865 | #endif |
1866 | #endif // C++11 |
1867 | |
1868 | /** |
1869 | * @brief Insert value of a string. |
1870 | * @param __pos1 Position in string to insert at. |
1871 | * @param __str The string to insert. |
1872 | * @return Reference to this string. |
1873 | * @throw std::length_error If new length exceeds @c max_size(). |
1874 | * |
1875 | * Inserts value of @a __str starting at @a __pos1. If adding |
1876 | * characters causes the length to exceed max_size(), |
1877 | * length_error is thrown. The value of the string doesn't |
1878 | * change if an error is thrown. |
1879 | */ |
1880 | _GLIBCXX20_CONSTEXPRconstexpr |
1881 | basic_string& |
1882 | insert(size_type __pos1, const basic_string& __str) |
1883 | { return this->replace(__pos1, size_type(0), |
1884 | __str._M_data(), __str.size()); } |
1885 | |
1886 | /** |
1887 | * @brief Insert a substring. |
1888 | * @param __pos1 Position in string to insert at. |
1889 | * @param __str The string to insert. |
1890 | * @param __pos2 Start of characters in str to insert. |
1891 | * @param __n Number of characters to insert. |
1892 | * @return Reference to this string. |
1893 | * @throw std::length_error If new length exceeds @c max_size(). |
1894 | * @throw std::out_of_range If @a pos1 > size() or |
1895 | * @a __pos2 > @a str.size(). |
1896 | * |
1897 | * Starting at @a pos1, insert @a __n character of @a __str |
1898 | * beginning with @a __pos2. If adding characters causes the |
1899 | * length to exceed max_size(), length_error is thrown. If @a |
1900 | * __pos1 is beyond the end of this string or @a __pos2 is |
1901 | * beyond the end of @a __str, out_of_range is thrown. The |
1902 | * value of the string doesn't change if an error is thrown. |
1903 | */ |
1904 | _GLIBCXX20_CONSTEXPRconstexpr |
1905 | basic_string& |
1906 | insert(size_type __pos1, const basic_string& __str, |
1907 | size_type __pos2, size_type __n = npos) |
1908 | { return this->replace(__pos1, size_type(0), __str._M_data() |
1909 | + __str._M_check(__pos2, "basic_string::insert"), |
1910 | __str._M_limit(__pos2, __n)); } |
1911 | |
1912 | /** |
1913 | * @brief Insert a C substring. |
1914 | * @param __pos Position in string to insert at. |
1915 | * @param __s The C string to insert. |
1916 | * @param __n The number of characters to insert. |
1917 | * @return Reference to this string. |
1918 | * @throw std::length_error If new length exceeds @c max_size(). |
1919 | * @throw std::out_of_range If @a __pos is beyond the end of this |
1920 | * string. |
1921 | * |
1922 | * Inserts the first @a __n characters of @a __s starting at @a |
1923 | * __pos. If adding characters causes the length to exceed |
1924 | * max_size(), length_error is thrown. If @a __pos is beyond |
1925 | * end(), out_of_range is thrown. The value of the string |
1926 | * doesn't change if an error is thrown. |
1927 | */ |
1928 | _GLIBCXX20_CONSTEXPRconstexpr |
1929 | basic_string& |
1930 | insert(size_type __pos, const _CharT* __s, size_type __n) |
1931 | { return this->replace(__pos, size_type(0), __s, __n); } |
1932 | |
1933 | /** |
1934 | * @brief Insert a C string. |
1935 | * @param __pos Position in string to insert at. |
1936 | * @param __s The C string to insert. |
1937 | * @return Reference to this string. |
1938 | * @throw std::length_error If new length exceeds @c max_size(). |
1939 | * @throw std::out_of_range If @a pos is beyond the end of this |
1940 | * string. |
1941 | * |
1942 | * Inserts the first @a n characters of @a __s starting at @a __pos. If |
1943 | * adding characters causes the length to exceed max_size(), |
1944 | * length_error is thrown. If @a __pos is beyond end(), out_of_range is |
1945 | * thrown. The value of the string doesn't change if an error is |
1946 | * thrown. |
1947 | */ |
1948 | _GLIBCXX20_CONSTEXPRconstexpr |
1949 | basic_string& |
1950 | insert(size_type __pos, const _CharT* __s) |
1951 | { |
1952 | __glibcxx_requires_string(__s); |
1953 | return this->replace(__pos, size_type(0), __s, |
1954 | traits_type::length(__s)); |
1955 | } |
1956 | |
1957 | /** |
1958 | * @brief Insert multiple characters. |
1959 | * @param __pos Index in string to insert at. |
1960 | * @param __n Number of characters to insert |
1961 | * @param __c The character to insert. |
1962 | * @return Reference to this string. |
1963 | * @throw std::length_error If new length exceeds @c max_size(). |
1964 | * @throw std::out_of_range If @a __pos is beyond the end of this |
1965 | * string. |
1966 | * |
1967 | * Inserts @a __n copies of character @a __c starting at index |
1968 | * @a __pos. If adding characters causes the length to exceed |
1969 | * max_size(), length_error is thrown. If @a __pos > length(), |
1970 | * out_of_range is thrown. The value of the string doesn't |
1971 | * change if an error is thrown. |
1972 | */ |
1973 | _GLIBCXX20_CONSTEXPRconstexpr |
1974 | basic_string& |
1975 | insert(size_type __pos, size_type __n, _CharT __c) |
1976 | { return _M_replace_aux(_M_check(__pos, "basic_string::insert"), |
1977 | size_type(0), __n, __c); } |
1978 | |
1979 | /** |
1980 | * @brief Insert one character. |
1981 | * @param __p Iterator referencing position in string to insert at. |
1982 | * @param __c The character to insert. |
1983 | * @return Iterator referencing newly inserted char. |
1984 | * @throw std::length_error If new length exceeds @c max_size(). |
1985 | * |
1986 | * Inserts character @a __c at position referenced by @a __p. |
1987 | * If adding character causes the length to exceed max_size(), |
1988 | * length_error is thrown. If @a __p is beyond end of string, |
1989 | * out_of_range is thrown. The value of the string doesn't |
1990 | * change if an error is thrown. |
1991 | */ |
1992 | _GLIBCXX20_CONSTEXPRconstexpr |
1993 | iterator |
1994 | insert(__const_iterator __p, _CharT __c) |
1995 | { |
1996 | _GLIBCXX_DEBUG_PEDASSERT(__p >= begin() && __p <= end()); |
1997 | const size_type __pos = __p - begin(); |
1998 | _M_replace_aux(__pos, size_type(0), size_type(1), __c); |
1999 | return iterator(_M_data() + __pos); |
2000 | } |
2001 | |
2002 | #if __cplusplus202002L >= 201703L |
2003 | /** |
2004 | * @brief Insert a string_view. |
2005 | * @param __pos Position in string to insert at. |
2006 | * @param __svt The object convertible to string_view to insert. |
2007 | * @return Reference to this string. |
2008 | */ |
2009 | template<typename _Tp> |
2010 | _GLIBCXX20_CONSTEXPRconstexpr |
2011 | _If_sv<_Tp, basic_string&> |
2012 | insert(size_type __pos, const _Tp& __svt) |
2013 | { |
2014 | __sv_type __sv = __svt; |
2015 | return this->insert(__pos, __sv.data(), __sv.size()); |
2016 | } |
2017 | |
2018 | /** |
2019 | * @brief Insert a string_view. |
2020 | * @param __pos1 Position in string to insert at. |
2021 | * @param __svt The object convertible to string_view to insert from. |
2022 | * @param __pos2 Start of characters in str to insert. |
2023 | * @param __n The number of characters to insert. |
2024 | * @return Reference to this string. |
2025 | */ |
2026 | template<typename _Tp> |
2027 | _GLIBCXX20_CONSTEXPRconstexpr |
2028 | _If_sv<_Tp, basic_string&> |
2029 | insert(size_type __pos1, const _Tp& __svt, |
2030 | size_type __pos2, size_type __n = npos) |
2031 | { |
2032 | __sv_type __sv = __svt; |
2033 | return this->replace(__pos1, size_type(0), |
2034 | __sv.data() |
2035 | + std::__sv_check(__sv.size(), __pos2, "basic_string::insert"), |
2036 | std::__sv_limit(__sv.size(), __pos2, __n)); |
2037 | } |
2038 | #endif // C++17 |
2039 | |
2040 | /** |
2041 | * @brief Remove characters. |
2042 | * @param __pos Index of first character to remove (default 0). |
2043 | * @param __n Number of characters to remove (default remainder). |
2044 | * @return Reference to this string. |
2045 | * @throw std::out_of_range If @a pos is beyond the end of this |
2046 | * string. |
2047 | * |
2048 | * Removes @a __n characters from this string starting at @a |
2049 | * __pos. The length of the string is reduced by @a __n. If |
2050 | * there are < @a __n characters to remove, the remainder of |
2051 | * the string is truncated. If @a __p is beyond end of string, |
2052 | * out_of_range is thrown. The value of the string doesn't |
2053 | * change if an error is thrown. |
2054 | */ |
2055 | _GLIBCXX20_CONSTEXPRconstexpr |
2056 | basic_string& |
2057 | erase(size_type __pos = 0, size_type __n = npos) |
2058 | { |
2059 | _M_check(__pos, "basic_string::erase"); |
2060 | if (__n == npos) |
2061 | this->_M_set_length(__pos); |
2062 | else if (__n != 0) |
2063 | this->_M_erase(__pos, _M_limit(__pos, __n)); |
2064 | return *this; |
2065 | } |
2066 | |
2067 | /** |
2068 | * @brief Remove one character. |
2069 | * @param __position Iterator referencing the character to remove. |
2070 | * @return iterator referencing same location after removal. |
2071 | * |
2072 | * Removes the character at @a __position from this string. The value |
2073 | * of the string doesn't change if an error is thrown. |
2074 | */ |
2075 | _GLIBCXX20_CONSTEXPRconstexpr |
2076 | iterator |
2077 | erase(__const_iterator __position) |
2078 | { |
2079 | _GLIBCXX_DEBUG_PEDASSERT(__position >= begin() |
2080 | && __position < end()); |
2081 | const size_type __pos = __position - begin(); |
2082 | this->_M_erase(__pos, size_type(1)); |
2083 | return iterator(_M_data() + __pos); |
2084 | } |
2085 | |
2086 | /** |
2087 | * @brief Remove a range of characters. |
2088 | * @param __first Iterator referencing the first character to remove. |
2089 | * @param __last Iterator referencing the end of the range. |
2090 | * @return Iterator referencing location of first after removal. |
2091 | * |
2092 | * Removes the characters in the range [first,last) from this string. |
2093 | * The value of the string doesn't change if an error is thrown. |
2094 | */ |
2095 | _GLIBCXX20_CONSTEXPRconstexpr |
2096 | iterator |
2097 | erase(__const_iterator __first, __const_iterator __last) |
2098 | { |
2099 | _GLIBCXX_DEBUG_PEDASSERT(__first >= begin() && __first <= __last |
2100 | && __last <= end()); |
2101 | const size_type __pos = __first - begin(); |
2102 | if (__last == end()) |
2103 | this->_M_set_length(__pos); |
2104 | else |
2105 | this->_M_erase(__pos, __last - __first); |
2106 | return iterator(this->_M_data() + __pos); |
2107 | } |
2108 | |
2109 | #if __cplusplus202002L >= 201103L |
2110 | /** |
2111 | * @brief Remove the last character. |
2112 | * |
2113 | * The string must be non-empty. |
2114 | */ |
2115 | _GLIBCXX20_CONSTEXPRconstexpr |
2116 | void |
2117 | pop_back() noexcept |
2118 | { |
2119 | __glibcxx_assert(!empty())do { if (std::__is_constant_evaluated() && !bool(!empty ())) __builtin_unreachable(); } while (false); |
2120 | _M_erase(size() - 1, 1); |
2121 | } |
2122 | #endif // C++11 |
2123 | |
2124 | /** |
2125 | * @brief Replace characters with value from another string. |
2126 | * @param __pos Index of first character to replace. |
2127 | * @param __n Number of characters to be replaced. |
2128 | * @param __str String to insert. |
2129 | * @return Reference to this string. |
2130 | * @throw std::out_of_range If @a pos is beyond the end of this |
2131 | * string. |
2132 | * @throw std::length_error If new length exceeds @c max_size(). |
2133 | * |
2134 | * Removes the characters in the range [__pos,__pos+__n) from |
2135 | * this string. In place, the value of @a __str is inserted. |
2136 | * If @a __pos is beyond end of string, out_of_range is thrown. |
2137 | * If the length of the result exceeds max_size(), length_error |
2138 | * is thrown. The value of the string doesn't change if an |
2139 | * error is thrown. |
2140 | */ |
2141 | _GLIBCXX20_CONSTEXPRconstexpr |
2142 | basic_string& |
2143 | replace(size_type __pos, size_type __n, const basic_string& __str) |
2144 | { return this->replace(__pos, __n, __str._M_data(), __str.size()); } |
2145 | |
2146 | /** |
2147 | * @brief Replace characters with value from another string. |
2148 | * @param __pos1 Index of first character to replace. |
2149 | * @param __n1 Number of characters to be replaced. |
2150 | * @param __str String to insert. |
2151 | * @param __pos2 Index of first character of str to use. |
2152 | * @param __n2 Number of characters from str to use. |
2153 | * @return Reference to this string. |
2154 | * @throw std::out_of_range If @a __pos1 > size() or @a __pos2 > |
2155 | * __str.size(). |
2156 | * @throw std::length_error If new length exceeds @c max_size(). |
2157 | * |
2158 | * Removes the characters in the range [__pos1,__pos1 + n) from this |
2159 | * string. In place, the value of @a __str is inserted. If @a __pos is |
2160 | * beyond end of string, out_of_range is thrown. If the length of the |
2161 | * result exceeds max_size(), length_error is thrown. The value of the |
2162 | * string doesn't change if an error is thrown. |
2163 | */ |
2164 | _GLIBCXX20_CONSTEXPRconstexpr |
2165 | basic_string& |
2166 | replace(size_type __pos1, size_type __n1, const basic_string& __str, |
2167 | size_type __pos2, size_type __n2 = npos) |
2168 | { return this->replace(__pos1, __n1, __str._M_data() |
2169 | + __str._M_check(__pos2, "basic_string::replace"), |
2170 | __str._M_limit(__pos2, __n2)); } |
2171 | |
2172 | /** |
2173 | * @brief Replace characters with value of a C substring. |
2174 | * @param __pos Index of first character to replace. |
2175 | * @param __n1 Number of characters to be replaced. |
2176 | * @param __s C string to insert. |
2177 | * @param __n2 Number of characters from @a s to use. |
2178 | * @return Reference to this string. |
2179 | * @throw std::out_of_range If @a pos1 > size(). |
2180 | * @throw std::length_error If new length exceeds @c max_size(). |
2181 | * |
2182 | * Removes the characters in the range [__pos,__pos + __n1) |
2183 | * from this string. In place, the first @a __n2 characters of |
2184 | * @a __s are inserted, or all of @a __s if @a __n2 is too large. If |
2185 | * @a __pos is beyond end of string, out_of_range is thrown. If |
2186 | * the length of result exceeds max_size(), length_error is |
2187 | * thrown. The value of the string doesn't change if an error |
2188 | * is thrown. |
2189 | */ |
2190 | _GLIBCXX20_CONSTEXPRconstexpr |
2191 | basic_string& |
2192 | replace(size_type __pos, size_type __n1, const _CharT* __s, |
2193 | size_type __n2) |
2194 | { |
2195 | __glibcxx_requires_string_len(__s, __n2); |
2196 | return _M_replace(_M_check(__pos, "basic_string::replace"), |
2197 | _M_limit(__pos, __n1), __s, __n2); |
2198 | } |
2199 | |
2200 | /** |
2201 | * @brief Replace characters with value of a C string. |
2202 | * @param __pos Index of first character to replace. |
2203 | * @param __n1 Number of characters to be replaced. |
2204 | * @param __s C string to insert. |
2205 | * @return Reference to this string. |
2206 | * @throw std::out_of_range If @a pos > size(). |
2207 | * @throw std::length_error If new length exceeds @c max_size(). |
2208 | * |
2209 | * Removes the characters in the range [__pos,__pos + __n1) |
2210 | * from this string. In place, the characters of @a __s are |
2211 | * inserted. If @a __pos is beyond end of string, out_of_range |
2212 | * is thrown. If the length of result exceeds max_size(), |
2213 | * length_error is thrown. The value of the string doesn't |
2214 | * change if an error is thrown. |
2215 | */ |
2216 | _GLIBCXX20_CONSTEXPRconstexpr |
2217 | basic_string& |
2218 | replace(size_type __pos, size_type __n1, const _CharT* __s) |
2219 | { |
2220 | __glibcxx_requires_string(__s); |
2221 | return this->replace(__pos, __n1, __s, traits_type::length(__s)); |
2222 | } |
2223 | |
2224 | /** |
2225 | * @brief Replace characters with multiple characters. |
2226 | * @param __pos Index of first character to replace. |
2227 | * @param __n1 Number of characters to be replaced. |
2228 | * @param __n2 Number of characters to insert. |
2229 | * @param __c Character to insert. |
2230 | * @return Reference to this string. |
2231 | * @throw std::out_of_range If @a __pos > size(). |
2232 | * @throw std::length_error If new length exceeds @c max_size(). |
2233 | * |
2234 | * Removes the characters in the range [pos,pos + n1) from this |
2235 | * string. In place, @a __n2 copies of @a __c are inserted. |
2236 | * If @a __pos is beyond end of string, out_of_range is thrown. |
2237 | * If the length of result exceeds max_size(), length_error is |
2238 | * thrown. The value of the string doesn't change if an error |
2239 | * is thrown. |
2240 | */ |
2241 | _GLIBCXX20_CONSTEXPRconstexpr |
2242 | basic_string& |
2243 | replace(size_type __pos, size_type __n1, size_type __n2, _CharT __c) |
2244 | { return _M_replace_aux(_M_check(__pos, "basic_string::replace"), |
2245 | _M_limit(__pos, __n1), __n2, __c); } |
2246 | |
2247 | /** |
2248 | * @brief Replace range of characters with string. |
2249 | * @param __i1 Iterator referencing start of range to replace. |
2250 | * @param __i2 Iterator referencing end of range to replace. |
2251 | * @param __str String value to insert. |
2252 | * @return Reference to this string. |
2253 | * @throw std::length_error If new length exceeds @c max_size(). |
2254 | * |
2255 | * Removes the characters in the range [__i1,__i2). In place, |
2256 | * the value of @a __str is inserted. If the length of result |
2257 | * exceeds max_size(), length_error is thrown. The value of |
2258 | * the string doesn't change if an error is thrown. |
2259 | */ |
2260 | _GLIBCXX20_CONSTEXPRconstexpr |
2261 | basic_string& |
2262 | replace(__const_iterator __i1, __const_iterator __i2, |
2263 | const basic_string& __str) |
2264 | { return this->replace(__i1, __i2, __str._M_data(), __str.size()); } |
2265 | |
2266 | /** |
2267 | * @brief Replace range of characters with C substring. |
2268 | * @param __i1 Iterator referencing start of range to replace. |
2269 | * @param __i2 Iterator referencing end of range to replace. |
2270 | * @param __s C string value to insert. |
2271 | * @param __n Number of characters from s to insert. |
2272 | * @return Reference to this string. |
2273 | * @throw std::length_error If new length exceeds @c max_size(). |
2274 | * |
2275 | * Removes the characters in the range [__i1,__i2). In place, |
2276 | * the first @a __n characters of @a __s are inserted. If the |
2277 | * length of result exceeds max_size(), length_error is thrown. |
2278 | * The value of the string doesn't change if an error is |
2279 | * thrown. |
2280 | */ |
2281 | _GLIBCXX20_CONSTEXPRconstexpr |
2282 | basic_string& |
2283 | replace(__const_iterator __i1, __const_iterator __i2, |
2284 | const _CharT* __s, size_type __n) |
2285 | { |
2286 | _GLIBCXX_DEBUG_PEDASSERT(begin() <= __i1 && __i1 <= __i2 |
2287 | && __i2 <= end()); |
2288 | return this->replace(__i1 - begin(), __i2 - __i1, __s, __n); |
2289 | } |
2290 | |
2291 | /** |
2292 | * @brief Replace range of characters with C string. |
2293 | * @param __i1 Iterator referencing start of range to replace. |
2294 | * @param __i2 Iterator referencing end of range to replace. |
2295 | * @param __s C string value to insert. |
2296 | * @return Reference to this string. |
2297 | * @throw std::length_error If new length exceeds @c max_size(). |
2298 | * |
2299 | * Removes the characters in the range [__i1,__i2). In place, |
2300 | * the characters of @a __s are inserted. If the length of |
2301 | * result exceeds max_size(), length_error is thrown. The |
2302 | * value of the string doesn't change if an error is thrown. |
2303 | */ |
2304 | _GLIBCXX20_CONSTEXPRconstexpr |
2305 | basic_string& |
2306 | replace(__const_iterator __i1, __const_iterator __i2, const _CharT* __s) |
2307 | { |
2308 | __glibcxx_requires_string(__s); |
2309 | return this->replace(__i1, __i2, __s, traits_type::length(__s)); |
2310 | } |
2311 | |
2312 | /** |
2313 | * @brief Replace range of characters with multiple characters |
2314 | * @param __i1 Iterator referencing start of range to replace. |
2315 | * @param __i2 Iterator referencing end of range to replace. |
2316 | * @param __n Number of characters to insert. |
2317 | * @param __c Character to insert. |
2318 | * @return Reference to this string. |
2319 | * @throw std::length_error If new length exceeds @c max_size(). |
2320 | * |
2321 | * Removes the characters in the range [__i1,__i2). In place, |
2322 | * @a __n copies of @a __c are inserted. If the length of |
2323 | * result exceeds max_size(), length_error is thrown. The |
2324 | * value of the string doesn't change if an error is thrown. |
2325 | */ |
2326 | _GLIBCXX20_CONSTEXPRconstexpr |
2327 | basic_string& |
2328 | replace(__const_iterator __i1, __const_iterator __i2, size_type __n, |
2329 | _CharT __c) |
2330 | { |
2331 | _GLIBCXX_DEBUG_PEDASSERT(begin() <= __i1 && __i1 <= __i2 |
2332 | && __i2 <= end()); |
2333 | return _M_replace_aux(__i1 - begin(), __i2 - __i1, __n, __c); |
2334 | } |
2335 | |
2336 | /** |
2337 | * @brief Replace range of characters with range. |
2338 | * @param __i1 Iterator referencing start of range to replace. |
2339 | * @param __i2 Iterator referencing end of range to replace. |
2340 | * @param __k1 Iterator referencing start of range to insert. |
2341 | * @param __k2 Iterator referencing end of range to insert. |
2342 | * @return Reference to this string. |
2343 | * @throw std::length_error If new length exceeds @c max_size(). |
2344 | * |
2345 | * Removes the characters in the range [__i1,__i2). In place, |
2346 | * characters in the range [__k1,__k2) are inserted. If the |
2347 | * length of result exceeds max_size(), length_error is thrown. |
2348 | * The value of the string doesn't change if an error is |
2349 | * thrown. |
2350 | */ |
2351 | #if __cplusplus202002L >= 201103L |
2352 | template<class _InputIterator, |
2353 | typename = std::_RequireInputIter<_InputIterator>> |
2354 | _GLIBCXX20_CONSTEXPRconstexpr |
2355 | basic_string& |
2356 | replace(const_iterator __i1, const_iterator __i2, |
2357 | _InputIterator __k1, _InputIterator __k2) |
2358 | { |
2359 | _GLIBCXX_DEBUG_PEDASSERT(begin() <= __i1 && __i1 <= __i2 |
2360 | && __i2 <= end()); |
2361 | __glibcxx_requires_valid_range(__k1, __k2); |
2362 | return this->_M_replace_dispatch(__i1, __i2, __k1, __k2, |
2363 | std::__false_type()); |
2364 | } |
2365 | #else |
2366 | template<class _InputIterator> |
2367 | #ifdef _GLIBCXX_DISAMBIGUATE_REPLACE_INST |
2368 | typename __enable_if_not_native_iterator<_InputIterator>::__type |
2369 | #else |
2370 | basic_string& |
2371 | #endif |
2372 | replace(iterator __i1, iterator __i2, |
2373 | _InputIterator __k1, _InputIterator __k2) |
2374 | { |
2375 | _GLIBCXX_DEBUG_PEDASSERT(begin() <= __i1 && __i1 <= __i2 |
2376 | && __i2 <= end()); |
2377 | __glibcxx_requires_valid_range(__k1, __k2); |
2378 | typedef typename std::__is_integer<_InputIterator>::__type _Integral; |
2379 | return _M_replace_dispatch(__i1, __i2, __k1, __k2, _Integral()); |
2380 | } |
2381 | #endif |
2382 | |
2383 | // Specializations for the common case of pointer and iterator: |
2384 | // useful to avoid the overhead of temporary buffering in _M_replace. |
2385 | _GLIBCXX20_CONSTEXPRconstexpr |
2386 | basic_string& |
2387 | replace(__const_iterator __i1, __const_iterator __i2, |
2388 | _CharT* __k1, _CharT* __k2) |
2389 | { |
2390 | _GLIBCXX_DEBUG_PEDASSERT(begin() <= __i1 && __i1 <= __i2 |
2391 | && __i2 <= end()); |
2392 | __glibcxx_requires_valid_range(__k1, __k2); |
2393 | return this->replace(__i1 - begin(), __i2 - __i1, |
2394 | __k1, __k2 - __k1); |
2395 | } |
2396 | |
2397 | _GLIBCXX20_CONSTEXPRconstexpr |
2398 | basic_string& |
2399 | replace(__const_iterator __i1, __const_iterator __i2, |
2400 | const _CharT* __k1, const _CharT* __k2) |
2401 | { |
2402 | _GLIBCXX_DEBUG_PEDASSERT(begin() <= __i1 && __i1 <= __i2 |
2403 | && __i2 <= end()); |
2404 | __glibcxx_requires_valid_range(__k1, __k2); |
2405 | return this->replace(__i1 - begin(), __i2 - __i1, |
2406 | __k1, __k2 - __k1); |
2407 | } |
2408 | |
2409 | _GLIBCXX20_CONSTEXPRconstexpr |
2410 | basic_string& |
2411 | replace(__const_iterator __i1, __const_iterator __i2, |
2412 | iterator __k1, iterator __k2) |
2413 | { |
2414 | _GLIBCXX_DEBUG_PEDASSERT(begin() <= __i1 && __i1 <= __i2 |
2415 | && __i2 <= end()); |
2416 | __glibcxx_requires_valid_range(__k1, __k2); |
2417 | return this->replace(__i1 - begin(), __i2 - __i1, |
2418 | __k1.base(), __k2 - __k1); |
2419 | } |
2420 | |
2421 | _GLIBCXX20_CONSTEXPRconstexpr |
2422 | basic_string& |
2423 | replace(__const_iterator __i1, __const_iterator __i2, |
2424 | const_iterator __k1, const_iterator __k2) |
2425 | { |
2426 | _GLIBCXX_DEBUG_PEDASSERT(begin() <= __i1 && __i1 <= __i2 |
2427 | && __i2 <= end()); |
2428 | __glibcxx_requires_valid_range(__k1, __k2); |
2429 | return this->replace(__i1 - begin(), __i2 - __i1, |
2430 | __k1.base(), __k2 - __k1); |
2431 | } |
2432 | |
2433 | #if __cplusplus202002L >= 201103L |
2434 | /** |
2435 | * @brief Replace range of characters with initializer_list. |
2436 | * @param __i1 Iterator referencing start of range to replace. |
2437 | * @param __i2 Iterator referencing end of range to replace. |
2438 | * @param __l The initializer_list of characters to insert. |
2439 | * @return Reference to this string. |
2440 | * @throw std::length_error If new length exceeds @c max_size(). |
2441 | * |
2442 | * Removes the characters in the range [__i1,__i2). In place, |
2443 | * characters in the range [__k1,__k2) are inserted. If the |
2444 | * length of result exceeds max_size(), length_error is thrown. |
2445 | * The value of the string doesn't change if an error is |
2446 | * thrown. |
2447 | */ |
2448 | _GLIBCXX20_CONSTEXPRconstexpr |
2449 | basic_string& replace(const_iterator __i1, const_iterator __i2, |
2450 | initializer_list<_CharT> __l) |
2451 | { return this->replace(__i1, __i2, __l.begin(), __l.size()); } |
2452 | #endif // C++11 |
2453 | |
2454 | #if __cplusplus202002L >= 201703L |
2455 | /** |
2456 | * @brief Replace range of characters with string_view. |
2457 | * @param __pos The position to replace at. |
2458 | * @param __n The number of characters to replace. |
2459 | * @param __svt The object convertible to string_view to insert. |
2460 | * @return Reference to this string. |
2461 | */ |
2462 | template<typename _Tp> |
2463 | _GLIBCXX20_CONSTEXPRconstexpr |
2464 | _If_sv<_Tp, basic_string&> |
2465 | replace(size_type __pos, size_type __n, const _Tp& __svt) |
2466 | { |
2467 | __sv_type __sv = __svt; |
2468 | return this->replace(__pos, __n, __sv.data(), __sv.size()); |
2469 | } |
2470 | |
2471 | /** |
2472 | * @brief Replace range of characters with string_view. |
2473 | * @param __pos1 The position to replace at. |
2474 | * @param __n1 The number of characters to replace. |
2475 | * @param __svt The object convertible to string_view to insert from. |
2476 | * @param __pos2 The position in the string_view to insert from. |
2477 | * @param __n2 The number of characters to insert. |
2478 | * @return Reference to this string. |
2479 | */ |
2480 | template<typename _Tp> |
2481 | _GLIBCXX20_CONSTEXPRconstexpr |
2482 | _If_sv<_Tp, basic_string&> |
2483 | replace(size_type __pos1, size_type __n1, const _Tp& __svt, |
2484 | size_type __pos2, size_type __n2 = npos) |
2485 | { |
2486 | __sv_type __sv = __svt; |
2487 | return this->replace(__pos1, __n1, |
2488 | __sv.data() |
2489 | + std::__sv_check(__sv.size(), __pos2, "basic_string::replace"), |
2490 | std::__sv_limit(__sv.size(), __pos2, __n2)); |
2491 | } |
2492 | |
2493 | /** |
2494 | * @brief Replace range of characters with string_view. |
2495 | * @param __i1 An iterator referencing the start position |
2496 | to replace at. |
2497 | * @param __i2 An iterator referencing the end position |
2498 | for the replace. |
2499 | * @param __svt The object convertible to string_view to insert from. |
2500 | * @return Reference to this string. |
2501 | */ |
2502 | template<typename _Tp> |
2503 | _GLIBCXX20_CONSTEXPRconstexpr |
2504 | _If_sv<_Tp, basic_string&> |
2505 | replace(const_iterator __i1, const_iterator __i2, const _Tp& __svt) |
2506 | { |
2507 | __sv_type __sv = __svt; |
2508 | return this->replace(__i1 - begin(), __i2 - __i1, __sv); |
2509 | } |
2510 | #endif // C++17 |
2511 | |
2512 | private: |
2513 | template<class _Integer> |
2514 | _GLIBCXX20_CONSTEXPRconstexpr |
2515 | basic_string& |
2516 | _M_replace_dispatch(const_iterator __i1, const_iterator __i2, |
2517 | _Integer __n, _Integer __val, __true_type) |
2518 | { return _M_replace_aux(__i1 - begin(), __i2 - __i1, __n, __val); } |
2519 | |
2520 | template<class _InputIterator> |
2521 | _GLIBCXX20_CONSTEXPRconstexpr |
2522 | basic_string& |
2523 | _M_replace_dispatch(const_iterator __i1, const_iterator __i2, |
2524 | _InputIterator __k1, _InputIterator __k2, |
2525 | __false_type); |
2526 | |
2527 | _GLIBCXX20_CONSTEXPRconstexpr |
2528 | basic_string& |
2529 | _M_replace_aux(size_type __pos1, size_type __n1, size_type __n2, |
2530 | _CharT __c); |
2531 | |
2532 | __attribute__((__noinline__, __noclone__, __cold__)) void |
2533 | _M_replace_cold(pointer __p, size_type __len1, const _CharT* __s, |
2534 | const size_type __len2, const size_type __how_much); |
2535 | |
2536 | _GLIBCXX20_CONSTEXPRconstexpr |
2537 | basic_string& |
2538 | _M_replace(size_type __pos, size_type __len1, const _CharT* __s, |
2539 | const size_type __len2); |
2540 | |
2541 | _GLIBCXX20_CONSTEXPRconstexpr |
2542 | basic_string& |
2543 | _M_append(const _CharT* __s, size_type __n); |
2544 | |
2545 | public: |
2546 | |
2547 | /** |
2548 | * @brief Copy substring into C string. |
2549 | * @param __s C string to copy value into. |
2550 | * @param __n Number of characters to copy. |
2551 | * @param __pos Index of first character to copy. |
2552 | * @return Number of characters actually copied |
2553 | * @throw std::out_of_range If __pos > size(). |
2554 | * |
2555 | * Copies up to @a __n characters starting at @a __pos into the |
2556 | * C string @a __s. If @a __pos is %greater than size(), |
2557 | * out_of_range is thrown. |
2558 | */ |
2559 | _GLIBCXX20_CONSTEXPRconstexpr |
2560 | size_type |
2561 | copy(_CharT* __s, size_type __n, size_type __pos = 0) const; |
2562 | |
2563 | /** |
2564 | * @brief Swap contents with another string. |
2565 | * @param __s String to swap with. |
2566 | * |
2567 | * Exchanges the contents of this string with that of @a __s in constant |
2568 | * time. |
2569 | */ |
2570 | _GLIBCXX20_CONSTEXPRconstexpr |
2571 | void |
2572 | swap(basic_string& __s) _GLIBCXX_NOEXCEPTnoexcept; |
2573 | |
2574 | // String operations: |
2575 | /** |
2576 | * @brief Return const pointer to null-terminated contents. |
2577 | * |
2578 | * This is a handle to internal data. Do not modify or dire things may |
2579 | * happen. |
2580 | */ |
2581 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
2582 | const _CharT* |
2583 | c_str() const _GLIBCXX_NOEXCEPTnoexcept |
2584 | { return _M_data(); } |
2585 | |
2586 | /** |
2587 | * @brief Return const pointer to contents. |
2588 | * |
2589 | * This is a pointer to internal data. It is undefined to modify |
2590 | * the contents through the returned pointer. To get a pointer that |
2591 | * allows modifying the contents use @c &str[0] instead, |
2592 | * (or in C++17 the non-const @c str.data() overload). |
2593 | */ |
2594 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
2595 | const _CharT* |
2596 | data() const _GLIBCXX_NOEXCEPTnoexcept |
2597 | { return _M_data(); } |
2598 | |
2599 | #if __cplusplus202002L >= 201703L |
2600 | /** |
2601 | * @brief Return non-const pointer to contents. |
2602 | * |
2603 | * This is a pointer to the character sequence held by the string. |
2604 | * Modifying the characters in the sequence is allowed. |
2605 | */ |
2606 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
2607 | _CharT* |
2608 | data() noexcept |
2609 | { return _M_data(); } |
2610 | #endif |
2611 | |
2612 | /** |
2613 | * @brief Return copy of allocator used to construct this string. |
2614 | */ |
2615 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
2616 | allocator_type |
2617 | get_allocator() const _GLIBCXX_NOEXCEPTnoexcept |
2618 | { return _M_get_allocator(); } |
2619 | |
2620 | /** |
2621 | * @brief Find position of a C substring. |
2622 | * @param __s C string to locate. |
2623 | * @param __pos Index of character to search from. |
2624 | * @param __n Number of characters from @a s to search for. |
2625 | * @return Index of start of first occurrence. |
2626 | * |
2627 | * Starting from @a __pos, searches forward for the first @a |
2628 | * __n characters in @a __s within this string. If found, |
2629 | * returns the index where it begins. If not found, returns |
2630 | * npos. |
2631 | */ |
2632 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
2633 | size_type |
2634 | find(const _CharT* __s, size_type __pos, size_type __n) const |
2635 | _GLIBCXX_NOEXCEPTnoexcept; |
2636 | |
2637 | /** |
2638 | * @brief Find position of a string. |
2639 | * @param __str String to locate. |
2640 | * @param __pos Index of character to search from (default 0). |
2641 | * @return Index of start of first occurrence. |
2642 | * |
2643 | * Starting from @a __pos, searches forward for value of @a __str within |
2644 | * this string. If found, returns the index where it begins. If not |
2645 | * found, returns npos. |
2646 | */ |
2647 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
2648 | size_type |
2649 | find(const basic_string& __str, size_type __pos = 0) const |
2650 | _GLIBCXX_NOEXCEPTnoexcept |
2651 | { return this->find(__str.data(), __pos, __str.size()); } |
2652 | |
2653 | #if __cplusplus202002L >= 201703L |
2654 | /** |
2655 | * @brief Find position of a string_view. |
2656 | * @param __svt The object convertible to string_view to locate. |
2657 | * @param __pos Index of character to search from (default 0). |
2658 | * @return Index of start of first occurrence. |
2659 | */ |
2660 | template<typename _Tp> |
2661 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
2662 | _If_sv<_Tp, size_type> |
2663 | find(const _Tp& __svt, size_type __pos = 0) const |
2664 | noexcept(is_same<_Tp, __sv_type>::value) |
2665 | { |
2666 | __sv_type __sv = __svt; |
2667 | return this->find(__sv.data(), __pos, __sv.size()); |
2668 | } |
2669 | #endif // C++17 |
2670 | |
2671 | /** |
2672 | * @brief Find position of a C string. |
2673 | * @param __s C string to locate. |
2674 | * @param __pos Index of character to search from (default 0). |
2675 | * @return Index of start of first occurrence. |
2676 | * |
2677 | * Starting from @a __pos, searches forward for the value of @a |
2678 | * __s within this string. If found, returns the index where |
2679 | * it begins. If not found, returns npos. |
2680 | */ |
2681 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
2682 | size_type |
2683 | find(const _CharT* __s, size_type __pos = 0) const _GLIBCXX_NOEXCEPTnoexcept |
2684 | { |
2685 | __glibcxx_requires_string(__s); |
2686 | return this->find(__s, __pos, traits_type::length(__s)); |
2687 | } |
2688 | |
2689 | /** |
2690 | * @brief Find position of a character. |
2691 | * @param __c Character to locate. |
2692 | * @param __pos Index of character to search from (default 0). |
2693 | * @return Index of first occurrence. |
2694 | * |
2695 | * Starting from @a __pos, searches forward for @a __c within |
2696 | * this string. If found, returns the index where it was |
2697 | * found. If not found, returns npos. |
2698 | */ |
2699 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
2700 | size_type |
2701 | find(_CharT __c, size_type __pos = 0) const _GLIBCXX_NOEXCEPTnoexcept; |
2702 | |
2703 | /** |
2704 | * @brief Find last position of a string. |
2705 | * @param __str String to locate. |
2706 | * @param __pos Index of character to search back from (default end). |
2707 | * @return Index of start of last occurrence. |
2708 | * |
2709 | * Starting from @a __pos, searches backward for value of @a |
2710 | * __str within this string. If found, returns the index where |
2711 | * it begins. If not found, returns npos. |
2712 | */ |
2713 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
2714 | size_type |
2715 | rfind(const basic_string& __str, size_type __pos = npos) const |
2716 | _GLIBCXX_NOEXCEPTnoexcept |
2717 | { return this->rfind(__str.data(), __pos, __str.size()); } |
2718 | |
2719 | #if __cplusplus202002L >= 201703L |
2720 | /** |
2721 | * @brief Find last position of a string_view. |
2722 | * @param __svt The object convertible to string_view to locate. |
2723 | * @param __pos Index of character to search back from (default end). |
2724 | * @return Index of start of last occurrence. |
2725 | */ |
2726 | template<typename _Tp> |
2727 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
2728 | _If_sv<_Tp, size_type> |
2729 | rfind(const _Tp& __svt, size_type __pos = npos) const |
2730 | noexcept(is_same<_Tp, __sv_type>::value) |
2731 | { |
2732 | __sv_type __sv = __svt; |
2733 | return this->rfind(__sv.data(), __pos, __sv.size()); |
2734 | } |
2735 | #endif // C++17 |
2736 | |
2737 | /** |
2738 | * @brief Find last position of a C substring. |
2739 | * @param __s C string to locate. |
2740 | * @param __pos Index of character to search back from. |
2741 | * @param __n Number of characters from s to search for. |
2742 | * @return Index of start of last occurrence. |
2743 | * |
2744 | * Starting from @a __pos, searches backward for the first @a |
2745 | * __n characters in @a __s within this string. If found, |
2746 | * returns the index where it begins. If not found, returns |
2747 | * npos. |
2748 | */ |
2749 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
2750 | size_type |
2751 | rfind(const _CharT* __s, size_type __pos, size_type __n) const |
2752 | _GLIBCXX_NOEXCEPTnoexcept; |
2753 | |
2754 | /** |
2755 | * @brief Find last position of a C string. |
2756 | * @param __s C string to locate. |
2757 | * @param __pos Index of character to start search at (default end). |
2758 | * @return Index of start of last occurrence. |
2759 | * |
2760 | * Starting from @a __pos, searches backward for the value of |
2761 | * @a __s within this string. If found, returns the index |
2762 | * where it begins. If not found, returns npos. |
2763 | */ |
2764 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
2765 | size_type |
2766 | rfind(const _CharT* __s, size_type __pos = npos) const |
2767 | { |
2768 | __glibcxx_requires_string(__s); |
2769 | return this->rfind(__s, __pos, traits_type::length(__s)); |
2770 | } |
2771 | |
2772 | /** |
2773 | * @brief Find last position of a character. |
2774 | * @param __c Character to locate. |
2775 | * @param __pos Index of character to search back from (default end). |
2776 | * @return Index of last occurrence. |
2777 | * |
2778 | * Starting from @a __pos, searches backward for @a __c within |
2779 | * this string. If found, returns the index where it was |
2780 | * found. If not found, returns npos. |
2781 | */ |
2782 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
2783 | size_type |
2784 | rfind(_CharT __c, size_type __pos = npos) const _GLIBCXX_NOEXCEPTnoexcept; |
2785 | |
2786 | /** |
2787 | * @brief Find position of a character of string. |
2788 | * @param __str String containing characters to locate. |
2789 | * @param __pos Index of character to search from (default 0). |
2790 | * @return Index of first occurrence. |
2791 | * |
2792 | * Starting from @a __pos, searches forward for one of the |
2793 | * characters of @a __str within this string. If found, |
2794 | * returns the index where it was found. If not found, returns |
2795 | * npos. |
2796 | */ |
2797 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
2798 | size_type |
2799 | find_first_of(const basic_string& __str, size_type __pos = 0) const |
2800 | _GLIBCXX_NOEXCEPTnoexcept |
2801 | { return this->find_first_of(__str.data(), __pos, __str.size()); } |
2802 | |
2803 | #if __cplusplus202002L >= 201703L |
2804 | /** |
2805 | * @brief Find position of a character of a string_view. |
2806 | * @param __svt An object convertible to string_view containing |
2807 | * characters to locate. |
2808 | * @param __pos Index of character to search from (default 0). |
2809 | * @return Index of first occurrence. |
2810 | */ |
2811 | template<typename _Tp> |
2812 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
2813 | _If_sv<_Tp, size_type> |
2814 | find_first_of(const _Tp& __svt, size_type __pos = 0) const |
2815 | noexcept(is_same<_Tp, __sv_type>::value) |
2816 | { |
2817 | __sv_type __sv = __svt; |
2818 | return this->find_first_of(__sv.data(), __pos, __sv.size()); |
2819 | } |
2820 | #endif // C++17 |
2821 | |
2822 | /** |
2823 | * @brief Find position of a character of C substring. |
2824 | * @param __s String containing characters to locate. |
2825 | * @param __pos Index of character to search from. |
2826 | * @param __n Number of characters from s to search for. |
2827 | * @return Index of first occurrence. |
2828 | * |
2829 | * Starting from @a __pos, searches forward for one of the |
2830 | * first @a __n characters of @a __s within this string. If |
2831 | * found, returns the index where it was found. If not found, |
2832 | * returns npos. |
2833 | */ |
2834 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
2835 | size_type |
2836 | find_first_of(const _CharT* __s, size_type __pos, size_type __n) const |
2837 | _GLIBCXX_NOEXCEPTnoexcept; |
2838 | |
2839 | /** |
2840 | * @brief Find position of a character of C string. |
2841 | * @param __s String containing characters to locate. |
2842 | * @param __pos Index of character to search from (default 0). |
2843 | * @return Index of first occurrence. |
2844 | * |
2845 | * Starting from @a __pos, searches forward for one of the |
2846 | * characters of @a __s within this string. If found, returns |
2847 | * the index where it was found. If not found, returns npos. |
2848 | */ |
2849 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
2850 | size_type |
2851 | find_first_of(const _CharT* __s, size_type __pos = 0) const |
2852 | _GLIBCXX_NOEXCEPTnoexcept |
2853 | { |
2854 | __glibcxx_requires_string(__s); |
2855 | return this->find_first_of(__s, __pos, traits_type::length(__s)); |
2856 | } |
2857 | |
2858 | /** |
2859 | * @brief Find position of a character. |
2860 | * @param __c Character to locate. |
2861 | * @param __pos Index of character to search from (default 0). |
2862 | * @return Index of first occurrence. |
2863 | * |
2864 | * Starting from @a __pos, searches forward for the character |
2865 | * @a __c within this string. If found, returns the index |
2866 | * where it was found. If not found, returns npos. |
2867 | * |
2868 | * Note: equivalent to find(__c, __pos). |
2869 | */ |
2870 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
2871 | size_type |
2872 | find_first_of(_CharT __c, size_type __pos = 0) const _GLIBCXX_NOEXCEPTnoexcept |
2873 | { return this->find(__c, __pos); } |
2874 | |
2875 | /** |
2876 | * @brief Find last position of a character of string. |
2877 | * @param __str String containing characters to locate. |
2878 | * @param __pos Index of character to search back from (default end). |
2879 | * @return Index of last occurrence. |
2880 | * |
2881 | * Starting from @a __pos, searches backward for one of the |
2882 | * characters of @a __str within this string. If found, |
2883 | * returns the index where it was found. If not found, returns |
2884 | * npos. |
2885 | */ |
2886 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
2887 | size_type |
2888 | find_last_of(const basic_string& __str, size_type __pos = npos) const |
2889 | _GLIBCXX_NOEXCEPTnoexcept |
2890 | { return this->find_last_of(__str.data(), __pos, __str.size()); } |
2891 | |
2892 | #if __cplusplus202002L >= 201703L |
2893 | /** |
2894 | * @brief Find last position of a character of string. |
2895 | * @param __svt An object convertible to string_view containing |
2896 | * characters to locate. |
2897 | * @param __pos Index of character to search back from (default end). |
2898 | * @return Index of last occurrence. |
2899 | */ |
2900 | template<typename _Tp> |
2901 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
2902 | _If_sv<_Tp, size_type> |
2903 | find_last_of(const _Tp& __svt, size_type __pos = npos) const |
2904 | noexcept(is_same<_Tp, __sv_type>::value) |
2905 | { |
2906 | __sv_type __sv = __svt; |
2907 | return this->find_last_of(__sv.data(), __pos, __sv.size()); |
2908 | } |
2909 | #endif // C++17 |
2910 | |
2911 | /** |
2912 | * @brief Find last position of a character of C substring. |
2913 | * @param __s C string containing characters to locate. |
2914 | * @param __pos Index of character to search back from. |
2915 | * @param __n Number of characters from s to search for. |
2916 | * @return Index of last occurrence. |
2917 | * |
2918 | * Starting from @a __pos, searches backward for one of the |
2919 | * first @a __n characters of @a __s within this string. If |
2920 | * found, returns the index where it was found. If not found, |
2921 | * returns npos. |
2922 | */ |
2923 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
2924 | size_type |
2925 | find_last_of(const _CharT* __s, size_type __pos, size_type __n) const |
2926 | _GLIBCXX_NOEXCEPTnoexcept; |
2927 | |
2928 | /** |
2929 | * @brief Find last position of a character of C string. |
2930 | * @param __s C string containing characters to locate. |
2931 | * @param __pos Index of character to search back from (default end). |
2932 | * @return Index of last occurrence. |
2933 | * |
2934 | * Starting from @a __pos, searches backward for one of the |
2935 | * characters of @a __s within this string. If found, returns |
2936 | * the index where it was found. If not found, returns npos. |
2937 | */ |
2938 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
2939 | size_type |
2940 | find_last_of(const _CharT* __s, size_type __pos = npos) const |
2941 | _GLIBCXX_NOEXCEPTnoexcept |
2942 | { |
2943 | __glibcxx_requires_string(__s); |
2944 | return this->find_last_of(__s, __pos, traits_type::length(__s)); |
2945 | } |
2946 | |
2947 | /** |
2948 | * @brief Find last position of a character. |
2949 | * @param __c Character to locate. |
2950 | * @param __pos Index of character to search back from (default end). |
2951 | * @return Index of last occurrence. |
2952 | * |
2953 | * Starting from @a __pos, searches backward for @a __c within |
2954 | * this string. If found, returns the index where it was |
2955 | * found. If not found, returns npos. |
2956 | * |
2957 | * Note: equivalent to rfind(__c, __pos). |
2958 | */ |
2959 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
2960 | size_type |
2961 | find_last_of(_CharT __c, size_type __pos = npos) const _GLIBCXX_NOEXCEPTnoexcept |
2962 | { return this->rfind(__c, __pos); } |
2963 | |
2964 | /** |
2965 | * @brief Find position of a character not in string. |
2966 | * @param __str String containing characters to avoid. |
2967 | * @param __pos Index of character to search from (default 0). |
2968 | * @return Index of first occurrence. |
2969 | * |
2970 | * Starting from @a __pos, searches forward for a character not contained |
2971 | * in @a __str within this string. If found, returns the index where it |
2972 | * was found. If not found, returns npos. |
2973 | */ |
2974 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
2975 | size_type |
2976 | find_first_not_of(const basic_string& __str, size_type __pos = 0) const |
2977 | _GLIBCXX_NOEXCEPTnoexcept |
2978 | { return this->find_first_not_of(__str.data(), __pos, __str.size()); } |
2979 | |
2980 | #if __cplusplus202002L >= 201703L |
2981 | /** |
2982 | * @brief Find position of a character not in a string_view. |
2983 | * @param __svt A object convertible to string_view containing |
2984 | * characters to avoid. |
2985 | * @param __pos Index of character to search from (default 0). |
2986 | * @return Index of first occurrence. |
2987 | */ |
2988 | template<typename _Tp> |
2989 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
2990 | _If_sv<_Tp, size_type> |
2991 | find_first_not_of(const _Tp& __svt, size_type __pos = 0) const |
2992 | noexcept(is_same<_Tp, __sv_type>::value) |
2993 | { |
2994 | __sv_type __sv = __svt; |
2995 | return this->find_first_not_of(__sv.data(), __pos, __sv.size()); |
2996 | } |
2997 | #endif // C++17 |
2998 | |
2999 | /** |
3000 | * @brief Find position of a character not in C substring. |
3001 | * @param __s C string containing characters to avoid. |
3002 | * @param __pos Index of character to search from. |
3003 | * @param __n Number of characters from __s to consider. |
3004 | * @return Index of first occurrence. |
3005 | * |
3006 | * Starting from @a __pos, searches forward for a character not |
3007 | * contained in the first @a __n characters of @a __s within |
3008 | * this string. If found, returns the index where it was |
3009 | * found. If not found, returns npos. |
3010 | */ |
3011 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
3012 | size_type |
3013 | find_first_not_of(const _CharT* __s, size_type __pos, |
3014 | size_type __n) const _GLIBCXX_NOEXCEPTnoexcept; |
3015 | |
3016 | /** |
3017 | * @brief Find position of a character not in C string. |
3018 | * @param __s C string containing characters to avoid. |
3019 | * @param __pos Index of character to search from (default 0). |
3020 | * @return Index of first occurrence. |
3021 | * |
3022 | * Starting from @a __pos, searches forward for a character not |
3023 | * contained in @a __s within this string. If found, returns |
3024 | * the index where it was found. If not found, returns npos. |
3025 | */ |
3026 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
3027 | size_type |
3028 | find_first_not_of(const _CharT* __s, size_type __pos = 0) const |
3029 | _GLIBCXX_NOEXCEPTnoexcept |
3030 | { |
3031 | __glibcxx_requires_string(__s); |
3032 | return this->find_first_not_of(__s, __pos, traits_type::length(__s)); |
3033 | } |
3034 | |
3035 | /** |
3036 | * @brief Find position of a different character. |
3037 | * @param __c Character to avoid. |
3038 | * @param __pos Index of character to search from (default 0). |
3039 | * @return Index of first occurrence. |
3040 | * |
3041 | * Starting from @a __pos, searches forward for a character |
3042 | * other than @a __c within this string. If found, returns the |
3043 | * index where it was found. If not found, returns npos. |
3044 | */ |
3045 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
3046 | size_type |
3047 | find_first_not_of(_CharT __c, size_type __pos = 0) const |
3048 | _GLIBCXX_NOEXCEPTnoexcept; |
3049 | |
3050 | /** |
3051 | * @brief Find last position of a character not in string. |
3052 | * @param __str String containing characters to avoid. |
3053 | * @param __pos Index of character to search back from (default end). |
3054 | * @return Index of last occurrence. |
3055 | * |
3056 | * Starting from @a __pos, searches backward for a character |
3057 | * not contained in @a __str within this string. If found, |
3058 | * returns the index where it was found. If not found, returns |
3059 | * npos. |
3060 | */ |
3061 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
3062 | size_type |
3063 | find_last_not_of(const basic_string& __str, size_type __pos = npos) const |
3064 | _GLIBCXX_NOEXCEPTnoexcept |
3065 | { return this->find_last_not_of(__str.data(), __pos, __str.size()); } |
3066 | |
3067 | #if __cplusplus202002L >= 201703L |
3068 | /** |
3069 | * @brief Find last position of a character not in a string_view. |
3070 | * @param __svt An object convertible to string_view containing |
3071 | * characters to avoid. |
3072 | * @param __pos Index of character to search back from (default end). |
3073 | * @return Index of last occurrence. |
3074 | */ |
3075 | template<typename _Tp> |
3076 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
3077 | _If_sv<_Tp, size_type> |
3078 | find_last_not_of(const _Tp& __svt, size_type __pos = npos) const |
3079 | noexcept(is_same<_Tp, __sv_type>::value) |
3080 | { |
3081 | __sv_type __sv = __svt; |
3082 | return this->find_last_not_of(__sv.data(), __pos, __sv.size()); |
3083 | } |
3084 | #endif // C++17 |
3085 | |
3086 | /** |
3087 | * @brief Find last position of a character not in C substring. |
3088 | * @param __s C string containing characters to avoid. |
3089 | * @param __pos Index of character to search back from. |
3090 | * @param __n Number of characters from s to consider. |
3091 | * @return Index of last occurrence. |
3092 | * |
3093 | * Starting from @a __pos, searches backward for a character not |
3094 | * contained in the first @a __n characters of @a __s within this string. |
3095 | * If found, returns the index where it was found. If not found, |
3096 | * returns npos. |
3097 | */ |
3098 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
3099 | size_type |
3100 | find_last_not_of(const _CharT* __s, size_type __pos, |
3101 | size_type __n) const _GLIBCXX_NOEXCEPTnoexcept; |
3102 | /** |
3103 | * @brief Find last position of a character not in C string. |
3104 | * @param __s C string containing characters to avoid. |
3105 | * @param __pos Index of character to search back from (default end). |
3106 | * @return Index of last occurrence. |
3107 | * |
3108 | * Starting from @a __pos, searches backward for a character |
3109 | * not contained in @a __s within this string. If found, |
3110 | * returns the index where it was found. If not found, returns |
3111 | * npos. |
3112 | */ |
3113 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
3114 | size_type |
3115 | find_last_not_of(const _CharT* __s, size_type __pos = npos) const |
3116 | _GLIBCXX_NOEXCEPTnoexcept |
3117 | { |
3118 | __glibcxx_requires_string(__s); |
3119 | return this->find_last_not_of(__s, __pos, traits_type::length(__s)); |
3120 | } |
3121 | |
3122 | /** |
3123 | * @brief Find last position of a different character. |
3124 | * @param __c Character to avoid. |
3125 | * @param __pos Index of character to search back from (default end). |
3126 | * @return Index of last occurrence. |
3127 | * |
3128 | * Starting from @a __pos, searches backward for a character other than |
3129 | * @a __c within this string. If found, returns the index where it was |
3130 | * found. If not found, returns npos. |
3131 | */ |
3132 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
3133 | size_type |
3134 | find_last_not_of(_CharT __c, size_type __pos = npos) const |
3135 | _GLIBCXX_NOEXCEPTnoexcept; |
3136 | |
3137 | /** |
3138 | * @brief Get a substring. |
3139 | * @param __pos Index of first character (default 0). |
3140 | * @param __n Number of characters in substring (default remainder). |
3141 | * @return The new string. |
3142 | * @throw std::out_of_range If __pos > size(). |
3143 | * |
3144 | * Construct and return a new string using the @a __n |
3145 | * characters starting at @a __pos. If the string is too |
3146 | * short, use the remainder of the characters. If @a __pos is |
3147 | * beyond the end of the string, out_of_range is thrown. |
3148 | */ |
3149 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
3150 | basic_string |
3151 | substr(size_type __pos = 0, size_type __n = npos) const |
3152 | { return basic_string(*this, |
3153 | _M_check(__pos, "basic_string::substr"), __n); } |
3154 | |
3155 | /** |
3156 | * @brief Compare to a string. |
3157 | * @param __str String to compare against. |
3158 | * @return Integer < 0, 0, or > 0. |
3159 | * |
3160 | * Returns an integer < 0 if this string is ordered before @a |
3161 | * __str, 0 if their values are equivalent, or > 0 if this |
3162 | * string is ordered after @a __str. Determines the effective |
3163 | * length rlen of the strings to compare as the smallest of |
3164 | * size() and str.size(). The function then compares the two |
3165 | * strings by calling traits::compare(data(), str.data(),rlen). |
3166 | * If the result of the comparison is nonzero returns it, |
3167 | * otherwise the shorter one is ordered first. |
3168 | */ |
3169 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
3170 | int |
3171 | compare(const basic_string& __str) const |
3172 | { |
3173 | const size_type __size = this->size(); |
3174 | const size_type __osize = __str.size(); |
3175 | const size_type __len = std::min(__size, __osize); |
3176 | |
3177 | int __r = traits_type::compare(_M_data(), __str.data(), __len); |
3178 | if (!__r) |
3179 | __r = _S_compare(__size, __osize); |
3180 | return __r; |
3181 | } |
3182 | |
3183 | #if __cplusplus202002L >= 201703L |
3184 | /** |
3185 | * @brief Compare to a string_view. |
3186 | * @param __svt An object convertible to string_view to compare against. |
3187 | * @return Integer < 0, 0, or > 0. |
3188 | */ |
3189 | template<typename _Tp> |
3190 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
3191 | _If_sv<_Tp, int> |
3192 | compare(const _Tp& __svt) const |
3193 | noexcept(is_same<_Tp, __sv_type>::value) |
3194 | { |
3195 | __sv_type __sv = __svt; |
3196 | const size_type __size = this->size(); |
3197 | const size_type __osize = __sv.size(); |
3198 | const size_type __len = std::min(__size, __osize); |
3199 | |
3200 | int __r = traits_type::compare(_M_data(), __sv.data(), __len); |
3201 | if (!__r) |
3202 | __r = _S_compare(__size, __osize); |
3203 | return __r; |
3204 | } |
3205 | |
3206 | /** |
3207 | * @brief Compare to a string_view. |
3208 | * @param __pos A position in the string to start comparing from. |
3209 | * @param __n The number of characters to compare. |
3210 | * @param __svt An object convertible to string_view to compare |
3211 | * against. |
3212 | * @return Integer < 0, 0, or > 0. |
3213 | */ |
3214 | template<typename _Tp> |
3215 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
3216 | _If_sv<_Tp, int> |
3217 | compare(size_type __pos, size_type __n, const _Tp& __svt) const |
3218 | noexcept(is_same<_Tp, __sv_type>::value) |
3219 | { |
3220 | __sv_type __sv = __svt; |
3221 | return __sv_type(*this).substr(__pos, __n).compare(__sv); |
3222 | } |
3223 | |
3224 | /** |
3225 | * @brief Compare to a string_view. |
3226 | * @param __pos1 A position in the string to start comparing from. |
3227 | * @param __n1 The number of characters to compare. |
3228 | * @param __svt An object convertible to string_view to compare |
3229 | * against. |
3230 | * @param __pos2 A position in the string_view to start comparing from. |
3231 | * @param __n2 The number of characters to compare. |
3232 | * @return Integer < 0, 0, or > 0. |
3233 | */ |
3234 | template<typename _Tp> |
3235 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
3236 | _If_sv<_Tp, int> |
3237 | compare(size_type __pos1, size_type __n1, const _Tp& __svt, |
3238 | size_type __pos2, size_type __n2 = npos) const |
3239 | noexcept(is_same<_Tp, __sv_type>::value) |
3240 | { |
3241 | __sv_type __sv = __svt; |
3242 | return __sv_type(*this) |
3243 | .substr(__pos1, __n1).compare(__sv.substr(__pos2, __n2)); |
3244 | } |
3245 | #endif // C++17 |
3246 | |
3247 | /** |
3248 | * @brief Compare substring to a string. |
3249 | * @param __pos Index of first character of substring. |
3250 | * @param __n Number of characters in substring. |
3251 | * @param __str String to compare against. |
3252 | * @return Integer < 0, 0, or > 0. |
3253 | * |
3254 | * Form the substring of this string from the @a __n characters |
3255 | * starting at @a __pos. Returns an integer < 0 if the |
3256 | * substring is ordered before @a __str, 0 if their values are |
3257 | * equivalent, or > 0 if the substring is ordered after @a |
3258 | * __str. Determines the effective length rlen of the strings |
3259 | * to compare as the smallest of the length of the substring |
3260 | * and @a __str.size(). The function then compares the two |
3261 | * strings by calling |
3262 | * traits::compare(substring.data(),str.data(),rlen). If the |
3263 | * result of the comparison is nonzero returns it, otherwise |
3264 | * the shorter one is ordered first. |
3265 | */ |
3266 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
3267 | int |
3268 | compare(size_type __pos, size_type __n, const basic_string& __str) const |
3269 | { |
3270 | _M_check(__pos, "basic_string::compare"); |
3271 | __n = _M_limit(__pos, __n); |
3272 | const size_type __osize = __str.size(); |
3273 | const size_type __len = std::min(__n, __osize); |
3274 | int __r = traits_type::compare(_M_data() + __pos, __str.data(), __len); |
3275 | if (!__r) |
3276 | __r = _S_compare(__n, __osize); |
3277 | return __r; |
3278 | } |
3279 | |
3280 | /** |
3281 | * @brief Compare substring to a substring. |
3282 | * @param __pos1 Index of first character of substring. |
3283 | * @param __n1 Number of characters in substring. |
3284 | * @param __str String to compare against. |
3285 | * @param __pos2 Index of first character of substring of str. |
3286 | * @param __n2 Number of characters in substring of str. |
3287 | * @return Integer < 0, 0, or > 0. |
3288 | * |
3289 | * Form the substring of this string from the @a __n1 |
3290 | * characters starting at @a __pos1. Form the substring of @a |
3291 | * __str from the @a __n2 characters starting at @a __pos2. |
3292 | * Returns an integer < 0 if this substring is ordered before |
3293 | * the substring of @a __str, 0 if their values are equivalent, |
3294 | * or > 0 if this substring is ordered after the substring of |
3295 | * @a __str. Determines the effective length rlen of the |
3296 | * strings to compare as the smallest of the lengths of the |
3297 | * substrings. The function then compares the two strings by |
3298 | * calling |
3299 | * traits::compare(substring.data(),str.substr(pos2,n2).data(),rlen). |
3300 | * If the result of the comparison is nonzero returns it, |
3301 | * otherwise the shorter one is ordered first. |
3302 | */ |
3303 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
3304 | int |
3305 | compare(size_type __pos1, size_type __n1, const basic_string& __str, |
3306 | size_type __pos2, size_type __n2 = npos) const |
3307 | { |
3308 | _M_check(__pos1, "basic_string::compare"); |
3309 | __str._M_check(__pos2, "basic_string::compare"); |
3310 | __n1 = _M_limit(__pos1, __n1); |
3311 | __n2 = __str._M_limit(__pos2, __n2); |
3312 | const size_type __len = std::min(__n1, __n2); |
3313 | int __r = traits_type::compare(_M_data() + __pos1, |
3314 | __str.data() + __pos2, __len); |
3315 | if (!__r) |
3316 | __r = _S_compare(__n1, __n2); |
3317 | return __r; |
3318 | } |
3319 | |
3320 | /** |
3321 | * @brief Compare to a C string. |
3322 | * @param __s C string to compare against. |
3323 | * @return Integer < 0, 0, or > 0. |
3324 | * |
3325 | * Returns an integer < 0 if this string is ordered before @a __s, 0 if |
3326 | * their values are equivalent, or > 0 if this string is ordered after |
3327 | * @a __s. Determines the effective length rlen of the strings to |
3328 | * compare as the smallest of size() and the length of a string |
3329 | * constructed from @a __s. The function then compares the two strings |
3330 | * by calling traits::compare(data(),s,rlen). If the result of the |
3331 | * comparison is nonzero returns it, otherwise the shorter one is |
3332 | * ordered first. |
3333 | */ |
3334 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
3335 | int |
3336 | compare(const _CharT* __s) const _GLIBCXX_NOEXCEPTnoexcept |
3337 | { |
3338 | __glibcxx_requires_string(__s); |
3339 | const size_type __size = this->size(); |
3340 | const size_type __osize = traits_type::length(__s); |
3341 | const size_type __len = std::min(__size, __osize); |
3342 | int __r = traits_type::compare(_M_data(), __s, __len); |
3343 | if (!__r) |
3344 | __r = _S_compare(__size, __osize); |
3345 | return __r; |
3346 | } |
3347 | |
3348 | // _GLIBCXX_RESOLVE_LIB_DEFECTS |
3349 | // 5 String::compare specification questionable |
3350 | /** |
3351 | * @brief Compare substring to a C string. |
3352 | * @param __pos Index of first character of substring. |
3353 | * @param __n1 Number of characters in substring. |
3354 | * @param __s C string to compare against. |
3355 | * @return Integer < 0, 0, or > 0. |
3356 | * |
3357 | * Form the substring of this string from the @a __n1 |
3358 | * characters starting at @a pos. Returns an integer < 0 if |
3359 | * the substring is ordered before @a __s, 0 if their values |
3360 | * are equivalent, or > 0 if the substring is ordered after @a |
3361 | * __s. Determines the effective length rlen of the strings to |
3362 | * compare as the smallest of the length of the substring and |
3363 | * the length of a string constructed from @a __s. The |
3364 | * function then compares the two string by calling |
3365 | * traits::compare(substring.data(),__s,rlen). If the result of |
3366 | * the comparison is nonzero returns it, otherwise the shorter |
3367 | * one is ordered first. |
3368 | */ |
3369 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
3370 | int |
3371 | compare(size_type __pos, size_type __n1, const _CharT* __s) const |
3372 | { |
3373 | __glibcxx_requires_string(__s); |
3374 | _M_check(__pos, "basic_string::compare"); |
3375 | __n1 = _M_limit(__pos, __n1); |
3376 | const size_type __osize = traits_type::length(__s); |
3377 | const size_type __len = std::min(__n1, __osize); |
3378 | int __r = traits_type::compare(_M_data() + __pos, __s, __len); |
3379 | if (!__r) |
3380 | __r = _S_compare(__n1, __osize); |
3381 | return __r; |
3382 | } |
3383 | |
3384 | /** |
3385 | * @brief Compare substring against a character %array. |
3386 | * @param __pos Index of first character of substring. |
3387 | * @param __n1 Number of characters in substring. |
3388 | * @param __s character %array to compare against. |
3389 | * @param __n2 Number of characters of s. |
3390 | * @return Integer < 0, 0, or > 0. |
3391 | * |
3392 | * Form the substring of this string from the @a __n1 |
3393 | * characters starting at @a __pos. Form a string from the |
3394 | * first @a __n2 characters of @a __s. Returns an integer < 0 |
3395 | * if this substring is ordered before the string from @a __s, |
3396 | * 0 if their values are equivalent, or > 0 if this substring |
3397 | * is ordered after the string from @a __s. Determines the |
3398 | * effective length rlen of the strings to compare as the |
3399 | * smallest of the length of the substring and @a __n2. The |
3400 | * function then compares the two strings by calling |
3401 | * traits::compare(substring.data(),s,rlen). If the result of |
3402 | * the comparison is nonzero returns it, otherwise the shorter |
3403 | * one is ordered first. |
3404 | * |
3405 | * NB: s must have at least n2 characters, '\\0' has |
3406 | * no special meaning. |
3407 | */ |
3408 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
3409 | int |
3410 | compare(size_type __pos, size_type __n1, const _CharT* __s, |
3411 | size_type __n2) const |
3412 | { |
3413 | __glibcxx_requires_string_len(__s, __n2); |
3414 | _M_check(__pos, "basic_string::compare"); |
3415 | __n1 = _M_limit(__pos, __n1); |
3416 | const size_type __len = std::min(__n1, __n2); |
3417 | int __r = traits_type::compare(_M_data() + __pos, __s, __len); |
3418 | if (!__r) |
3419 | __r = _S_compare(__n1, __n2); |
3420 | return __r; |
3421 | } |
3422 | |
3423 | #if __cplusplus202002L >= 202002L |
3424 | [[nodiscard]] |
3425 | constexpr bool |
3426 | starts_with(basic_string_view<_CharT, _Traits> __x) const noexcept |
3427 | { return __sv_type(this->data(), this->size()).starts_with(__x); } |
3428 | |
3429 | [[nodiscard]] |
3430 | constexpr bool |
3431 | starts_with(_CharT __x) const noexcept |
3432 | { return __sv_type(this->data(), this->size()).starts_with(__x); } |
3433 | |
3434 | [[nodiscard, __gnu__::__nonnull__]] |
3435 | constexpr bool |
3436 | starts_with(const _CharT* __x) const noexcept |
3437 | { return __sv_type(this->data(), this->size()).starts_with(__x); } |
3438 | |
3439 | [[nodiscard]] |
3440 | constexpr bool |
3441 | ends_with(basic_string_view<_CharT, _Traits> __x) const noexcept |
3442 | { return __sv_type(this->data(), this->size()).ends_with(__x); } |
3443 | |
3444 | [[nodiscard]] |
3445 | constexpr bool |
3446 | ends_with(_CharT __x) const noexcept |
3447 | { return __sv_type(this->data(), this->size()).ends_with(__x); } |
3448 | |
3449 | [[nodiscard, __gnu__::__nonnull__]] |
3450 | constexpr bool |
3451 | ends_with(const _CharT* __x) const noexcept |
3452 | { return __sv_type(this->data(), this->size()).ends_with(__x); } |
3453 | #endif // C++20 |
3454 | |
3455 | #if __cplusplus202002L > 202002L |
3456 | [[nodiscard]] |
3457 | constexpr bool |
3458 | contains(basic_string_view<_CharT, _Traits> __x) const noexcept |
3459 | { return __sv_type(this->data(), this->size()).contains(__x); } |
3460 | |
3461 | [[nodiscard]] |
3462 | constexpr bool |
3463 | contains(_CharT __x) const noexcept |
3464 | { return __sv_type(this->data(), this->size()).contains(__x); } |
3465 | |
3466 | [[nodiscard, __gnu__::__nonnull__]] |
3467 | constexpr bool |
3468 | contains(const _CharT* __x) const noexcept |
3469 | { return __sv_type(this->data(), this->size()).contains(__x); } |
3470 | #endif // C++23 |
3471 | |
3472 | // Allow basic_stringbuf::__xfer_bufptrs to call _M_length: |
3473 | template<typename, typename, typename> friend class basic_stringbuf; |
3474 | }; |
3475 | _GLIBCXX_END_NAMESPACE_CXX11} |
3476 | _GLIBCXX_END_NAMESPACE_VERSION |
3477 | } // namespace std |
3478 | #endif // _GLIBCXX_USE_CXX11_ABI |
3479 | |
3480 | namespace std _GLIBCXX_VISIBILITY(default)__attribute__ ((__visibility__ ("default"))) |
3481 | { |
3482 | _GLIBCXX_BEGIN_NAMESPACE_VERSION |
3483 | |
3484 | #if __cpp_deduction_guides201703L >= 201606 |
3485 | _GLIBCXX_BEGIN_NAMESPACE_CXX11namespace __cxx11 { |
3486 | template<typename _InputIterator, typename _CharT |
3487 | = typename iterator_traits<_InputIterator>::value_type, |
3488 | typename _Allocator = allocator<_CharT>, |
3489 | typename = _RequireInputIter<_InputIterator>, |
3490 | typename = _RequireAllocator<_Allocator>> |
3491 | basic_string(_InputIterator, _InputIterator, _Allocator = _Allocator()) |
3492 | -> basic_string<_CharT, char_traits<_CharT>, _Allocator>; |
3493 | |
3494 | // _GLIBCXX_RESOLVE_LIB_DEFECTS |
3495 | // 3075. basic_string needs deduction guides from basic_string_view |
3496 | template<typename _CharT, typename _Traits, |
3497 | typename _Allocator = allocator<_CharT>, |
3498 | typename = _RequireAllocator<_Allocator>> |
3499 | basic_string(basic_string_view<_CharT, _Traits>, const _Allocator& = _Allocator()) |
3500 | -> basic_string<_CharT, _Traits, _Allocator>; |
3501 | |
3502 | template<typename _CharT, typename _Traits, |
3503 | typename _Allocator = allocator<_CharT>, |
3504 | typename = _RequireAllocator<_Allocator>> |
3505 | basic_string(basic_string_view<_CharT, _Traits>, |
3506 | typename basic_string<_CharT, _Traits, _Allocator>::size_type, |
3507 | typename basic_string<_CharT, _Traits, _Allocator>::size_type, |
3508 | const _Allocator& = _Allocator()) |
3509 | -> basic_string<_CharT, _Traits, _Allocator>; |
3510 | _GLIBCXX_END_NAMESPACE_CXX11} |
3511 | #endif |
3512 | |
3513 | template<typename _Str> |
3514 | _GLIBCXX20_CONSTEXPRconstexpr |
3515 | inline _Str |
3516 | __str_concat(typename _Str::value_type const* __lhs, |
3517 | typename _Str::size_type __lhs_len, |
3518 | typename _Str::value_type const* __rhs, |
3519 | typename _Str::size_type __rhs_len, |
3520 | typename _Str::allocator_type const& __a) |
3521 | { |
3522 | typedef typename _Str::allocator_type allocator_type; |
3523 | typedef __gnu_cxx::__alloc_traits<allocator_type> _Alloc_traits; |
3524 | _Str __str(_Alloc_traits::_S_select_on_copy(__a)); |
3525 | __str.reserve(__lhs_len + __rhs_len); |
3526 | __str.append(__lhs, __lhs_len); |
3527 | __str.append(__rhs, __rhs_len); |
3528 | return __str; |
3529 | } |
3530 | |
3531 | // operator+ |
3532 | /** |
3533 | * @brief Concatenate two strings. |
3534 | * @param __lhs First string. |
3535 | * @param __rhs Last string. |
3536 | * @return New string with value of @a __lhs followed by @a __rhs. |
3537 | */ |
3538 | template<typename _CharT, typename _Traits, typename _Alloc> |
3539 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
3540 | inline basic_string<_CharT, _Traits, _Alloc> |
3541 | operator+(const basic_string<_CharT, _Traits, _Alloc>& __lhs, |
3542 | const basic_string<_CharT, _Traits, _Alloc>& __rhs) |
3543 | { |
3544 | typedef basic_string<_CharT, _Traits, _Alloc> _Str; |
3545 | return std::__str_concat<_Str>(__lhs.c_str(), __lhs.size(), |
3546 | __rhs.c_str(), __rhs.size(), |
3547 | __lhs.get_allocator()); |
3548 | } |
3549 | |
3550 | /** |
3551 | * @brief Concatenate C string and string. |
3552 | * @param __lhs First string. |
3553 | * @param __rhs Last string. |
3554 | * @return New string with value of @a __lhs followed by @a __rhs. |
3555 | */ |
3556 | template<typename _CharT, typename _Traits, typename _Alloc> |
3557 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
3558 | inline basic_string<_CharT,_Traits,_Alloc> |
3559 | operator+(const _CharT* __lhs, |
3560 | const basic_string<_CharT,_Traits,_Alloc>& __rhs) |
3561 | { |
3562 | __glibcxx_requires_string(__lhs); |
3563 | typedef basic_string<_CharT, _Traits, _Alloc> _Str; |
3564 | return std::__str_concat<_Str>(__lhs, _Traits::length(__lhs), |
3565 | __rhs.c_str(), __rhs.size(), |
3566 | __rhs.get_allocator()); |
3567 | } |
3568 | |
3569 | /** |
3570 | * @brief Concatenate character and string. |
3571 | * @param __lhs First string. |
3572 | * @param __rhs Last string. |
3573 | * @return New string with @a __lhs followed by @a __rhs. |
3574 | */ |
3575 | template<typename _CharT, typename _Traits, typename _Alloc> |
3576 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
3577 | inline basic_string<_CharT,_Traits,_Alloc> |
3578 | operator+(_CharT __lhs, const basic_string<_CharT,_Traits,_Alloc>& __rhs) |
3579 | { |
3580 | typedef basic_string<_CharT, _Traits, _Alloc> _Str; |
3581 | return std::__str_concat<_Str>(__builtin_addressof(__lhs), 1, |
3582 | __rhs.c_str(), __rhs.size(), |
3583 | __rhs.get_allocator()); |
3584 | } |
3585 | |
3586 | /** |
3587 | * @brief Concatenate string and C string. |
3588 | * @param __lhs First string. |
3589 | * @param __rhs Last string. |
3590 | * @return New string with @a __lhs followed by @a __rhs. |
3591 | */ |
3592 | template<typename _CharT, typename _Traits, typename _Alloc> |
3593 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
3594 | inline basic_string<_CharT, _Traits, _Alloc> |
3595 | operator+(const basic_string<_CharT, _Traits, _Alloc>& __lhs, |
3596 | const _CharT* __rhs) |
3597 | { |
3598 | __glibcxx_requires_string(__rhs); |
3599 | typedef basic_string<_CharT, _Traits, _Alloc> _Str; |
3600 | return std::__str_concat<_Str>(__lhs.c_str(), __lhs.size(), |
3601 | __rhs, _Traits::length(__rhs), |
3602 | __lhs.get_allocator()); |
3603 | } |
3604 | /** |
3605 | * @brief Concatenate string and character. |
3606 | * @param __lhs First string. |
3607 | * @param __rhs Last string. |
3608 | * @return New string with @a __lhs followed by @a __rhs. |
3609 | */ |
3610 | template<typename _CharT, typename _Traits, typename _Alloc> |
3611 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
3612 | inline basic_string<_CharT, _Traits, _Alloc> |
3613 | operator+(const basic_string<_CharT, _Traits, _Alloc>& __lhs, _CharT __rhs) |
3614 | { |
3615 | typedef basic_string<_CharT, _Traits, _Alloc> _Str; |
3616 | return std::__str_concat<_Str>(__lhs.c_str(), __lhs.size(), |
3617 | __builtin_addressof(__rhs), 1, |
3618 | __lhs.get_allocator()); |
3619 | } |
3620 | |
3621 | #if __cplusplus202002L >= 201103L |
3622 | template<typename _CharT, typename _Traits, typename _Alloc> |
3623 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
3624 | inline basic_string<_CharT, _Traits, _Alloc> |
3625 | operator+(basic_string<_CharT, _Traits, _Alloc>&& __lhs, |
3626 | const basic_string<_CharT, _Traits, _Alloc>& __rhs) |
3627 | { return std::move(__lhs.append(__rhs)); } |
3628 | |
3629 | template<typename _CharT, typename _Traits, typename _Alloc> |
3630 | _GLIBCXX20_CONSTEXPRconstexpr |
3631 | inline basic_string<_CharT, _Traits, _Alloc> |
3632 | operator+(const basic_string<_CharT, _Traits, _Alloc>& __lhs, |
3633 | basic_string<_CharT, _Traits, _Alloc>&& __rhs) |
3634 | { return std::move(__rhs.insert(0, __lhs)); } |
3635 | |
3636 | template<typename _CharT, typename _Traits, typename _Alloc> |
3637 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
3638 | inline basic_string<_CharT, _Traits, _Alloc> |
3639 | operator+(basic_string<_CharT, _Traits, _Alloc>&& __lhs, |
3640 | basic_string<_CharT, _Traits, _Alloc>&& __rhs) |
3641 | { |
3642 | #if _GLIBCXX_USE_CXX11_ABI1 |
3643 | using _Alloc_traits = allocator_traits<_Alloc>; |
3644 | bool __use_rhs = false; |
3645 | if _GLIBCXX17_CONSTEXPRconstexpr (typename _Alloc_traits::is_always_equal{}) |
3646 | __use_rhs = true; |
3647 | else if (__lhs.get_allocator() == __rhs.get_allocator()) |
3648 | __use_rhs = true; |
3649 | if (__use_rhs) |
3650 | #endif |
3651 | { |
3652 | const auto __size = __lhs.size() + __rhs.size(); |
3653 | if (__size > __lhs.capacity() && __size <= __rhs.capacity()) |
3654 | return std::move(__rhs.insert(0, __lhs)); |
3655 | } |
3656 | return std::move(__lhs.append(__rhs)); |
3657 | } |
3658 | |
3659 | template<typename _CharT, typename _Traits, typename _Alloc> |
3660 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
3661 | inline basic_string<_CharT, _Traits, _Alloc> |
3662 | operator+(const _CharT* __lhs, |
3663 | basic_string<_CharT, _Traits, _Alloc>&& __rhs) |
3664 | { return std::move(__rhs.insert(0, __lhs)); } |
3665 | |
3666 | template<typename _CharT, typename _Traits, typename _Alloc> |
3667 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
3668 | inline basic_string<_CharT, _Traits, _Alloc> |
3669 | operator+(_CharT __lhs, |
3670 | basic_string<_CharT, _Traits, _Alloc>&& __rhs) |
3671 | { return std::move(__rhs.insert(0, 1, __lhs)); } |
3672 | |
3673 | template<typename _CharT, typename _Traits, typename _Alloc> |
3674 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
3675 | inline basic_string<_CharT, _Traits, _Alloc> |
3676 | operator+(basic_string<_CharT, _Traits, _Alloc>&& __lhs, |
3677 | const _CharT* __rhs) |
3678 | { return std::move(__lhs.append(__rhs)); } |
3679 | |
3680 | template<typename _CharT, typename _Traits, typename _Alloc> |
3681 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
3682 | inline basic_string<_CharT, _Traits, _Alloc> |
3683 | operator+(basic_string<_CharT, _Traits, _Alloc>&& __lhs, |
3684 | _CharT __rhs) |
3685 | { return std::move(__lhs.append(1, __rhs)); } |
3686 | #endif |
3687 | |
3688 | // operator == |
3689 | /** |
3690 | * @brief Test equivalence of two strings. |
3691 | * @param __lhs First string. |
3692 | * @param __rhs Second string. |
3693 | * @return True if @a __lhs.compare(@a __rhs) == 0. False otherwise. |
3694 | */ |
3695 | template<typename _CharT, typename _Traits, typename _Alloc> |
3696 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
3697 | inline bool |
3698 | operator==(const basic_string<_CharT, _Traits, _Alloc>& __lhs, |
3699 | const basic_string<_CharT, _Traits, _Alloc>& __rhs) |
3700 | _GLIBCXX_NOEXCEPTnoexcept |
3701 | { |
3702 | return __lhs.size() == __rhs.size() |
3703 | && !_Traits::compare(__lhs.data(), __rhs.data(), __lhs.size()); |
3704 | } |
3705 | |
3706 | /** |
3707 | * @brief Test equivalence of string and C string. |
3708 | * @param __lhs String. |
3709 | * @param __rhs C string. |
3710 | * @return True if @a __lhs.compare(@a __rhs) == 0. False otherwise. |
3711 | */ |
3712 | template<typename _CharT, typename _Traits, typename _Alloc> |
3713 | _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPRconstexpr |
3714 | inline bool |
3715 | operator==(const basic_string<_CharT, _Traits, _Alloc>& __lhs, |
3716 | const _CharT* __rhs) |
3717 | { |
3718 | return __lhs.size() == _Traits::length(__rhs) |
3719 | && !_Traits::compare(__lhs.data(), __rhs, __lhs.size()); |
3720 | } |
3721 | |
3722 | #if __cpp_lib_three_way_comparison201907L |
3723 | /** |
3724 | * @brief Three-way comparison of a string and a C string. |
3725 | * @param __lhs A string. |
3726 | * @param __rhs A null-terminated string. |
3727 | * @return A value indicating whether `__lhs` is less than, equal to, |
3728 | * greater than, or incomparable with `__rhs`. |
3729 | */ |
3730 | template<typename _CharT, typename _Traits, typename _Alloc> |
3731 | [[nodiscard]] |
3732 | constexpr auto |
3733 | operator<=>(const basic_string<_CharT, _Traits, _Alloc>& __lhs, |
3734 | const basic_string<_CharT, _Traits, _Alloc>& __rhs) noexcept |
3735 | -> decltype(__detail::__char_traits_cmp_cat<_Traits>(0)) |
3736 | { return __detail::__char_traits_cmp_cat<_Traits>(__lhs.compare(__rhs)); } |
3737 | |
3738 | /** |
3739 | * @brief Three-way comparison of a string and a C string. |
3740 | * @param __lhs A string. |
3741 | * @param __rhs A null-terminated string. |
3742 | * @return A value indicating whether `__lhs` is less than, equal to, |
3743 | * greater than, or incomparable with `__rhs`. |
3744 | */ |
3745 | template<typename _CharT, typename _Traits, typename _Alloc> |
3746 | [[nodiscard]] |
3747 | constexpr auto |
3748 | operator<=>(const basic_string<_CharT, _Traits, _Alloc>& __lhs, |
3749 | const _CharT* __rhs) noexcept |
3750 | -> decltype(__detail::__char_traits_cmp_cat<_Traits>(0)) |
3751 | { return __detail::__char_traits_cmp_cat<_Traits>(__lhs.compare(__rhs)); } |
3752 | #else |
3753 | /** |
3754 | * @brief Test equivalence of C string and string. |
3755 | * @param __lhs C string. |
3756 | * @param __rhs String. |
3757 | * @return True if @a __rhs.compare(@a __lhs) == 0. False otherwise. |
3758 | */ |
3759 | template<typename _CharT, typename _Traits, typename _Alloc> |
3760 | _GLIBCXX_NODISCARD[[__nodiscard__]] |
3761 | inline bool |
3762 | operator==(const _CharT* __lhs, |
3763 | const basic_string<_CharT, _Traits, _Alloc>& __rhs) |
3764 | { return __rhs == __lhs; } |
3765 | |
3766 | // operator != |
3767 | /** |
3768 | * @brief Test difference of two strings. |
3769 | * @param __lhs First string. |
3770 | * @param __rhs Second string. |
3771 | * @return True if @a __lhs.compare(@a __rhs) != 0. False otherwise. |
3772 | */ |
3773 | template<typename _CharT, typename _Traits, typename _Alloc> |
3774 | _GLIBCXX_NODISCARD[[__nodiscard__]] |
3775 | inline bool |
3776 | operator!=(const basic_string<_CharT, _Traits, _Alloc>& __lhs, |
3777 | const basic_string<_CharT, _Traits, _Alloc>& __rhs) |
3778 | _GLIBCXX_NOEXCEPTnoexcept |
3779 | { return !(__lhs == __rhs); } |
3780 | |
3781 | /** |
3782 | * @brief Test difference of C string and string. |
3783 | * @param __lhs C string. |
3784 | * @param __rhs String. |
3785 | * @return True if @a __rhs.compare(@a __lhs) != 0. False otherwise. |
3786 | */ |
3787 | template<typename _CharT, typename _Traits, typename _Alloc> |
3788 | _GLIBCXX_NODISCARD[[__nodiscard__]] |
3789 | inline bool |
3790 | operator!=(const _CharT* __lhs, |
3791 | const basic_string<_CharT, _Traits, _Alloc>& __rhs) |
3792 | { return !(__rhs == __lhs); } |
3793 | |
3794 | /** |
3795 | * @brief Test difference of string and C string. |
3796 | * @param __lhs String. |
3797 | * @param __rhs C string. |
3798 | * @return True if @a __lhs.compare(@a __rhs) != 0. False otherwise. |
3799 | */ |
3800 | template<typename _CharT, typename _Traits, typename _Alloc> |
3801 | _GLIBCXX_NODISCARD[[__nodiscard__]] |
3802 | inline bool |
3803 | operator!=(const basic_string<_CharT, _Traits, _Alloc>& __lhs, |
3804 | const _CharT* __rhs) |
3805 | { return !(__lhs == __rhs); } |
3806 | |
3807 | // operator < |
3808 | /** |
3809 | * @brief Test if string precedes string. |
3810 | * @param __lhs First string. |
3811 | * @param __rhs Second string. |
3812 | * @return True if @a __lhs precedes @a __rhs. False otherwise. |
3813 | */ |
3814 | template<typename _CharT, typename _Traits, typename _Alloc> |
3815 | _GLIBCXX_NODISCARD[[__nodiscard__]] |
3816 | inline bool |
3817 | operator<(const basic_string<_CharT, _Traits, _Alloc>& __lhs, |
3818 | const basic_string<_CharT, _Traits, _Alloc>& __rhs) |
3819 | _GLIBCXX_NOEXCEPTnoexcept |
3820 | { return __lhs.compare(__rhs) < 0; } |
3821 | |
3822 | /** |
3823 | * @brief Test if string precedes C string. |
3824 | * @param __lhs String. |
3825 | * @param __rhs C string. |
3826 | * @return True if @a __lhs precedes @a __rhs. False otherwise. |
3827 | */ |
3828 | template<typename _CharT, typename _Traits, typename _Alloc> |
3829 | _GLIBCXX_NODISCARD[[__nodiscard__]] |
3830 | inline bool |
3831 | operator<(const basic_string<_CharT, _Traits, _Alloc>& __lhs, |
3832 | const _CharT* __rhs) |
3833 | { return __lhs.compare(__rhs) < 0; } |
3834 | |
3835 | /** |
3836 | * @brief Test if C string precedes string. |
3837 | * @param __lhs C string. |
3838 | * @param __rhs String. |
3839 | * @return True if @a __lhs precedes @a __rhs. False otherwise. |
3840 | */ |
3841 | template<typename _CharT, typename _Traits, typename _Alloc> |
3842 | _GLIBCXX_NODISCARD[[__nodiscard__]] |
3843 | inline bool |
3844 | operator<(const _CharT* __lhs, |
3845 | const basic_string<_CharT, _Traits, _Alloc>& __rhs) |
3846 | { return __rhs.compare(__lhs) > 0; } |
3847 | |
3848 | // operator > |
3849 | /** |
3850 | * @brief Test if string follows string. |
3851 | * @param __lhs First string. |
3852 | * @param __rhs Second string. |
3853 | * @return True if @a __lhs follows @a __rhs. False otherwise. |
3854 | */ |
3855 | template<typename _CharT, typename _Traits, typename _Alloc> |
3856 | _GLIBCXX_NODISCARD[[__nodiscard__]] |
3857 | inline bool |
3858 | operator>(const basic_string<_CharT, _Traits, _Alloc>& __lhs, |
3859 | const basic_string<_CharT, _Traits, _Alloc>& __rhs) |
3860 | _GLIBCXX_NOEXCEPTnoexcept |
3861 | { return __lhs.compare(__rhs) > 0; } |
3862 | |
3863 | /** |
3864 | * @brief Test if string follows C string. |
3865 | * @param __lhs String. |
3866 | * @param __rhs C string. |
3867 | * @return True if @a __lhs follows @a __rhs. False otherwise. |
3868 | */ |
3869 | template<typename _CharT, typename _Traits, typename _Alloc> |
3870 | _GLIBCXX_NODISCARD[[__nodiscard__]] |
3871 | inline bool |
3872 | operator>(const basic_string<_CharT, _Traits, _Alloc>& __lhs, |
3873 | const _CharT* __rhs) |
3874 | { return __lhs.compare(__rhs) > 0; } |
3875 | |
3876 | /** |
3877 | * @brief Test if C string follows string. |
3878 | * @param __lhs C string. |
3879 | * @param __rhs String. |
3880 | * @return True if @a __lhs follows @a __rhs. False otherwise. |
3881 | */ |
3882 | template<typename _CharT, typename _Traits, typename _Alloc> |
3883 | _GLIBCXX_NODISCARD[[__nodiscard__]] |
3884 | inline bool |
3885 | operator>(const _CharT* __lhs, |
3886 | const basic_string<_CharT, _Traits, _Alloc>& __rhs) |
3887 | { return __rhs.compare(__lhs) < 0; } |
3888 | |
3889 | // operator <= |
3890 | /** |
3891 | * @brief Test if string doesn't follow string. |
3892 | * @param __lhs First string. |
3893 | * @param __rhs Second string. |
3894 | * @return True if @a __lhs doesn't follow @a __rhs. False otherwise. |
3895 | */ |
3896 | template<typename _CharT, typename _Traits, typename _Alloc> |
3897 | _GLIBCXX_NODISCARD[[__nodiscard__]] |
3898 | inline bool |
3899 | operator<=(const basic_string<_CharT, _Traits, _Alloc>& __lhs, |
3900 | const basic_string<_CharT, _Traits, _Alloc>& __rhs) |
3901 | _GLIBCXX_NOEXCEPTnoexcept |
3902 | { return __lhs.compare(__rhs) <= 0; } |
3903 | |
3904 | /** |
3905 | * @brief Test if string doesn't follow C string. |
3906 | * @param __lhs String. |
3907 | * @param __rhs C string. |
3908 | * @return True if @a __lhs doesn't follow @a __rhs. False otherwise. |
3909 | */ |
3910 | template<typename _CharT, typename _Traits, typename _Alloc> |
3911 | _GLIBCXX_NODISCARD[[__nodiscard__]] |
3912 | inline bool |
3913 | operator<=(const basic_string<_CharT, _Traits, _Alloc>& __lhs, |
3914 | const _CharT* __rhs) |
3915 | { return __lhs.compare(__rhs) <= 0; } |
3916 | |
3917 | /** |
3918 | * @brief Test if C string doesn't follow string. |
3919 | * @param __lhs C string. |
3920 | * @param __rhs String. |
3921 | * @return True if @a __lhs doesn't follow @a __rhs. False otherwise. |
3922 | */ |
3923 | template<typename _CharT, typename _Traits, typename _Alloc> |
3924 | _GLIBCXX_NODISCARD[[__nodiscard__]] |
3925 | inline bool |
3926 | operator<=(const _CharT* __lhs, |
3927 | const basic_string<_CharT, _Traits, _Alloc>& __rhs) |
3928 | { return __rhs.compare(__lhs) >= 0; } |
3929 | |
3930 | // operator >= |
3931 | /** |
3932 | * @brief Test if string doesn't precede string. |
3933 | * @param __lhs First string. |
3934 | * @param __rhs Second string. |
3935 | * @return True if @a __lhs doesn't precede @a __rhs. False otherwise. |
3936 | */ |
3937 | template<typename _CharT, typename _Traits, typename _Alloc> |
3938 | _GLIBCXX_NODISCARD[[__nodiscard__]] |
3939 | inline bool |
3940 | operator>=(const basic_string<_CharT, _Traits, _Alloc>& __lhs, |
3941 | const basic_string<_CharT, _Traits, _Alloc>& __rhs) |
3942 | _GLIBCXX_NOEXCEPTnoexcept |
3943 | { return __lhs.compare(__rhs) >= 0; } |
3944 | |
3945 | /** |
3946 | * @brief Test if string doesn't precede C string. |
3947 | * @param __lhs String. |
3948 | * @param __rhs C string. |
3949 | * @return True if @a __lhs doesn't precede @a __rhs. False otherwise. |
3950 | */ |
3951 | template<typename _CharT, typename _Traits, typename _Alloc> |
3952 | _GLIBCXX_NODISCARD[[__nodiscard__]] |
3953 | inline bool |
3954 | operator>=(const basic_string<_CharT, _Traits, _Alloc>& __lhs, |
3955 | const _CharT* __rhs) |
3956 | { return __lhs.compare(__rhs) >= 0; } |
3957 | |
3958 | /** |
3959 | * @brief Test if C string doesn't precede string. |
3960 | * @param __lhs C string. |
3961 | * @param __rhs String. |
3962 | * @return True if @a __lhs doesn't precede @a __rhs. False otherwise. |
3963 | */ |
3964 | template<typename _CharT, typename _Traits, typename _Alloc> |
3965 | _GLIBCXX_NODISCARD[[__nodiscard__]] |
3966 | inline bool |
3967 | operator>=(const _CharT* __lhs, |
3968 | const basic_string<_CharT, _Traits, _Alloc>& __rhs) |
3969 | { return __rhs.compare(__lhs) <= 0; } |
3970 | #endif // three-way comparison |
3971 | |
3972 | /** |
3973 | * @brief Swap contents of two strings. |
3974 | * @param __lhs First string. |
3975 | * @param __rhs Second string. |
3976 | * |
3977 | * Exchanges the contents of @a __lhs and @a __rhs in constant time. |
3978 | */ |
3979 | template<typename _CharT, typename _Traits, typename _Alloc> |
3980 | _GLIBCXX20_CONSTEXPRconstexpr |
3981 | inline void |
3982 | swap(basic_string<_CharT, _Traits, _Alloc>& __lhs, |
3983 | basic_string<_CharT, _Traits, _Alloc>& __rhs) |
3984 | _GLIBCXX_NOEXCEPT_IF(noexcept(__lhs.swap(__rhs)))noexcept(noexcept(__lhs.swap(__rhs))) |
3985 | { __lhs.swap(__rhs); } |
3986 | |
3987 | |
3988 | /** |
3989 | * @brief Read stream into a string. |
3990 | * @param __is Input stream. |
3991 | * @param __str Buffer to store into. |
3992 | * @return Reference to the input stream. |
3993 | * |
3994 | * Stores characters from @a __is into @a __str until whitespace is |
3995 | * found, the end of the stream is encountered, or str.max_size() |
3996 | * is reached. If is.width() is non-zero, that is the limit on the |
3997 | * number of characters stored into @a __str. Any previous |
3998 | * contents of @a __str are erased. |
3999 | */ |
4000 | template<typename _CharT, typename _Traits, typename _Alloc> |
4001 | basic_istream<_CharT, _Traits>& |
4002 | operator>>(basic_istream<_CharT, _Traits>& __is, |
4003 | basic_string<_CharT, _Traits, _Alloc>& __str); |
4004 | |
4005 | template<> |
4006 | basic_istream<char>& |
4007 | operator>>(basic_istream<char>& __is, basic_string<char>& __str); |
4008 | |
4009 | /** |
4010 | * @brief Write string to a stream. |
4011 | * @param __os Output stream. |
4012 | * @param __str String to write out. |
4013 | * @return Reference to the output stream. |
4014 | * |
4015 | * Output characters of @a __str into os following the same rules as for |
4016 | * writing a C string. |
4017 | */ |
4018 | template<typename _CharT, typename _Traits, typename _Alloc> |
4019 | inline basic_ostream<_CharT, _Traits>& |
4020 | operator<<(basic_ostream<_CharT, _Traits>& __os, |
4021 | const basic_string<_CharT, _Traits, _Alloc>& __str) |
4022 | { |
4023 | // _GLIBCXX_RESOLVE_LIB_DEFECTS |
4024 | // 586. string inserter not a formatted function |
4025 | return __ostream_insert(__os, __str.data(), __str.size()); |
4026 | } |
4027 | |
4028 | /** |
4029 | * @brief Read a line from stream into a string. |
4030 | * @param __is Input stream. |
4031 | * @param __str Buffer to store into. |
4032 | * @param __delim Character marking end of line. |
4033 | * @return Reference to the input stream. |
4034 | * |
4035 | * Stores characters from @a __is into @a __str until @a __delim is |
4036 | * found, the end of the stream is encountered, or str.max_size() |
4037 | * is reached. Any previous contents of @a __str are erased. If |
4038 | * @a __delim is encountered, it is extracted but not stored into |
4039 | * @a __str. |
4040 | */ |
4041 | template<typename _CharT, typename _Traits, typename _Alloc> |
4042 | basic_istream<_CharT, _Traits>& |
4043 | getline(basic_istream<_CharT, _Traits>& __is, |
4044 | basic_string<_CharT, _Traits, _Alloc>& __str, _CharT __delim); |
4045 | |
4046 | /** |
4047 | * @brief Read a line from stream into a string. |
4048 | * @param __is Input stream. |
4049 | * @param __str Buffer to store into. |
4050 | * @return Reference to the input stream. |
4051 | * |
4052 | * Stores characters from is into @a __str until '\n' is |
4053 | * found, the end of the stream is encountered, or str.max_size() |
4054 | * is reached. Any previous contents of @a __str are erased. If |
4055 | * end of line is encountered, it is extracted but not stored into |
4056 | * @a __str. |
4057 | */ |
4058 | template<typename _CharT, typename _Traits, typename _Alloc> |
4059 | inline basic_istream<_CharT, _Traits>& |
4060 | getline(basic_istream<_CharT, _Traits>& __is, |
4061 | basic_string<_CharT, _Traits, _Alloc>& __str) |
4062 | { return std::getline(__is, __str, __is.widen('\n')); } |
4063 | |
4064 | #if __cplusplus202002L >= 201103L |
4065 | /// Read a line from an rvalue stream into a string. |
4066 | template<typename _CharT, typename _Traits, typename _Alloc> |
4067 | inline basic_istream<_CharT, _Traits>& |
4068 | getline(basic_istream<_CharT, _Traits>&& __is, |
4069 | basic_string<_CharT, _Traits, _Alloc>& __str, _CharT __delim) |
4070 | { return std::getline(__is, __str, __delim); } |
4071 | |
4072 | /// Read a line from an rvalue stream into a string. |
4073 | template<typename _CharT, typename _Traits, typename _Alloc> |
4074 | inline basic_istream<_CharT, _Traits>& |
4075 | getline(basic_istream<_CharT, _Traits>&& __is, |
4076 | basic_string<_CharT, _Traits, _Alloc>& __str) |
4077 | { return std::getline(__is, __str); } |
4078 | #endif |
4079 | |
4080 | template<> |
4081 | basic_istream<char>& |
4082 | getline(basic_istream<char>& __in, basic_string<char>& __str, |
4083 | char __delim); |
4084 | |
4085 | #ifdef _GLIBCXX_USE_WCHAR_T1 |
4086 | template<> |
4087 | basic_istream<wchar_t>& |
4088 | getline(basic_istream<wchar_t>& __in, basic_string<wchar_t>& __str, |
4089 | wchar_t __delim); |
4090 | #endif |
4091 | |
4092 | _GLIBCXX_END_NAMESPACE_VERSION |
4093 | } // namespace |
4094 | |
4095 | #if __cplusplus202002L >= 201103L |
4096 | |
4097 | #include <ext/string_conversions.h> |
4098 | #include <bits/charconv.h> |
4099 | |
4100 | namespace std _GLIBCXX_VISIBILITY(default)__attribute__ ((__visibility__ ("default"))) |
4101 | { |
4102 | _GLIBCXX_BEGIN_NAMESPACE_VERSION |
4103 | _GLIBCXX_BEGIN_NAMESPACE_CXX11namespace __cxx11 { |
4104 | |
4105 | #if _GLIBCXX_USE_C99_STDLIB1 |
4106 | // 21.4 Numeric Conversions [string.conversions]. |
4107 | inline int |
4108 | stoi(const string& __str, size_t* __idx = 0, int __base = 10) |
4109 | { return __gnu_cxx::__stoa<long, int>(&std::strtol, "stoi", __str.c_str(), |
4110 | __idx, __base); } |
4111 | |
4112 | inline long |
4113 | stol(const string& __str, size_t* __idx = 0, int __base = 10) |
4114 | { return __gnu_cxx::__stoa(&std::strtol, "stol", __str.c_str(), |
4115 | __idx, __base); } |
4116 | |
4117 | inline unsigned long |
4118 | stoul(const string& __str, size_t* __idx = 0, int __base = 10) |
4119 | { return __gnu_cxx::__stoa(&std::strtoul, "stoul", __str.c_str(), |
4120 | __idx, __base); } |
4121 | |
4122 | inline long long |
4123 | stoll(const string& __str, size_t* __idx = 0, int __base = 10) |
4124 | { return __gnu_cxx::__stoa(&std::strtoll, "stoll", __str.c_str(), |
4125 | __idx, __base); } |
4126 | |
4127 | inline unsigned long long |
4128 | stoull(const string& __str, size_t* __idx = 0, int __base = 10) |
4129 | { return __gnu_cxx::__stoa(&std::strtoull, "stoull", __str.c_str(), |
4130 | __idx, __base); } |
4131 | |
4132 | // NB: strtof vs strtod. |
4133 | inline float |
4134 | stof(const string& __str, size_t* __idx = 0) |
4135 | { return __gnu_cxx::__stoa(&std::strtof, "stof", __str.c_str(), __idx); } |
4136 | |
4137 | inline double |
4138 | stod(const string& __str, size_t* __idx = 0) |
4139 | { return __gnu_cxx::__stoa(&std::strtod, "stod", __str.c_str(), __idx); } |
4140 | |
4141 | inline long double |
4142 | stold(const string& __str, size_t* __idx = 0) |
4143 | { return __gnu_cxx::__stoa(&std::strtold, "stold", __str.c_str(), __idx); } |
4144 | #endif // _GLIBCXX_USE_C99_STDLIB |
4145 | |
4146 | // DR 1261. Insufficent overloads for to_string / to_wstring |
4147 | |
4148 | _GLIBCXX_NODISCARD[[__nodiscard__]] |
4149 | inline string |
4150 | to_string(int __val) |
4151 | #if _GLIBCXX_USE_CXX11_ABI1 && (__CHAR_BIT__8 * __SIZEOF_INT__4) <= 32 |
4152 | noexcept // any 32-bit value fits in the SSO buffer |
4153 | #endif |
4154 | { |
4155 | const bool __neg = __val < 0; |
4156 | const unsigned __uval = __neg ? (unsigned)~__val + 1u : __val; |
4157 | const auto __len = __detail::__to_chars_len(__uval); |
4158 | string __str(__neg + __len, '-'); |
4159 | __detail::__to_chars_10_impl(&__str[__neg], __len, __uval); |
4160 | return __str; |
4161 | } |
4162 | |
4163 | _GLIBCXX_NODISCARD[[__nodiscard__]] |
4164 | inline string |
4165 | to_string(unsigned __val) |
4166 | #if _GLIBCXX_USE_CXX11_ABI1 && (__CHAR_BIT__8 * __SIZEOF_INT__4) <= 32 |
4167 | noexcept // any 32-bit value fits in the SSO buffer |
4168 | #endif |
4169 | { |
4170 | string __str(__detail::__to_chars_len(__val), '\0'); |
4171 | __detail::__to_chars_10_impl(&__str[0], __str.size(), __val); |
4172 | return __str; |
4173 | } |
4174 | |
4175 | _GLIBCXX_NODISCARD[[__nodiscard__]] |
4176 | inline string |
4177 | to_string(long __val) |
4178 | #if _GLIBCXX_USE_CXX11_ABI1 && (__CHAR_BIT__8 * __SIZEOF_LONG__8) <= 32 |
4179 | noexcept // any 32-bit value fits in the SSO buffer |
4180 | #endif |
4181 | { |
4182 | const bool __neg = __val < 0; |
4183 | const unsigned long __uval = __neg ? (unsigned long)~__val + 1ul : __val; |
4184 | const auto __len = __detail::__to_chars_len(__uval); |
4185 | string __str(__neg + __len, '-'); |
4186 | __detail::__to_chars_10_impl(&__str[__neg], __len, __uval); |
4187 | return __str; |
4188 | } |
4189 | |
4190 | _GLIBCXX_NODISCARD[[__nodiscard__]] |
4191 | inline string |
4192 | to_string(unsigned long __val) |
4193 | #if _GLIBCXX_USE_CXX11_ABI1 && (__CHAR_BIT__8 * __SIZEOF_LONG__8) <= 32 |
4194 | noexcept // any 32-bit value fits in the SSO buffer |
4195 | #endif |
4196 | { |
4197 | string __str(__detail::__to_chars_len(__val), '\0'); |
4198 | __detail::__to_chars_10_impl(&__str[0], __str.size(), __val); |
4199 | return __str; |
4200 | } |
4201 | |
4202 | _GLIBCXX_NODISCARD[[__nodiscard__]] |
4203 | inline string |
4204 | to_string(long long __val) |
4205 | { |
4206 | const bool __neg = __val < 0; |
4207 | const unsigned long long __uval |
4208 | = __neg ? (unsigned long long)~__val + 1ull : __val; |
4209 | const auto __len = __detail::__to_chars_len(__uval); |
4210 | string __str(__neg + __len, '-'); |
4211 | __detail::__to_chars_10_impl(&__str[__neg], __len, __uval); |
4212 | return __str; |
4213 | } |
4214 | |
4215 | _GLIBCXX_NODISCARD[[__nodiscard__]] |
4216 | inline string |
4217 | to_string(unsigned long long __val) |
4218 | { |
4219 | string __str(__detail::__to_chars_len(__val), '\0'); |
4220 | __detail::__to_chars_10_impl(&__str[0], __str.size(), __val); |
4221 | return __str; |
4222 | } |
4223 | |
4224 | #if _GLIBCXX_USE_C99_STDIO1 |
4225 | // NB: (v)snprintf vs sprintf. |
4226 | |
4227 | _GLIBCXX_NODISCARD[[__nodiscard__]] |
4228 | inline string |
4229 | to_string(float __val) |
4230 | { |
4231 | const int __n = |
4232 | __gnu_cxx::__numeric_traits<float>::__max_exponent10 + 20; |
4233 | return __gnu_cxx::__to_xstring<string>(&std::vsnprintf, __n, |
4234 | "%f", __val); |
4235 | } |
4236 | |
4237 | _GLIBCXX_NODISCARD[[__nodiscard__]] |
4238 | inline string |
4239 | to_string(double __val) |
4240 | { |
4241 | const int __n = |
4242 | __gnu_cxx::__numeric_traits<double>::__max_exponent10 + 20; |
4243 | return __gnu_cxx::__to_xstring<string>(&std::vsnprintf, __n, |
4244 | "%f", __val); |
4245 | } |
4246 | |
4247 | _GLIBCXX_NODISCARD[[__nodiscard__]] |
4248 | inline string |
4249 | to_string(long double __val) |
4250 | { |
4251 | const int __n = |
4252 | __gnu_cxx::__numeric_traits<long double>::__max_exponent10 + 20; |
4253 | return __gnu_cxx::__to_xstring<string>(&std::vsnprintf, __n, |
4254 | "%Lf", __val); |
4255 | } |
4256 | #endif // _GLIBCXX_USE_C99_STDIO |
4257 | |
4258 | #if defined(_GLIBCXX_USE_WCHAR_T1) && _GLIBCXX_USE_C99_WCHAR1 |
4259 | inline int |
4260 | stoi(const wstring& __str, size_t* __idx = 0, int __base = 10) |
4261 | { return __gnu_cxx::__stoa<long, int>(&std::wcstol, "stoi", __str.c_str(), |
4262 | __idx, __base); } |
4263 | |
4264 | inline long |
4265 | stol(const wstring& __str, size_t* __idx = 0, int __base = 10) |
4266 | { return __gnu_cxx::__stoa(&std::wcstol, "stol", __str.c_str(), |
4267 | __idx, __base); } |
4268 | |
4269 | inline unsigned long |
4270 | stoul(const wstring& __str, size_t* __idx = 0, int __base = 10) |
4271 | { return __gnu_cxx::__stoa(&std::wcstoul, "stoul", __str.c_str(), |
4272 | __idx, __base); } |
4273 | |
4274 | inline long long |
4275 | stoll(const wstring& __str, size_t* __idx = 0, int __base = 10) |
4276 | { return __gnu_cxx::__stoa(&std::wcstoll, "stoll", __str.c_str(), |
4277 | __idx, __base); } |
4278 | |
4279 | inline unsigned long long |
4280 | stoull(const wstring& __str, size_t* __idx = 0, int __base = 10) |
4281 | { return __gnu_cxx::__stoa(&std::wcstoull, "stoull", __str.c_str(), |
4282 | __idx, __base); } |
4283 | |
4284 | // NB: wcstof vs wcstod. |
4285 | inline float |
4286 | stof(const wstring& __str, size_t* __idx = 0) |
4287 | { return __gnu_cxx::__stoa(&std::wcstof, "stof", __str.c_str(), __idx); } |
4288 | |
4289 | inline double |
4290 | stod(const wstring& __str, size_t* __idx = 0) |
4291 | { return __gnu_cxx::__stoa(&std::wcstod, "stod", __str.c_str(), __idx); } |
4292 | |
4293 | inline long double |
4294 | stold(const wstring& __str, size_t* __idx = 0) |
4295 | { return __gnu_cxx::__stoa(&std::wcstold, "stold", __str.c_str(), __idx); } |
4296 | |
4297 | #ifndef _GLIBCXX_HAVE_BROKEN_VSWPRINTF |
4298 | // DR 1261. |
4299 | _GLIBCXX_NODISCARD[[__nodiscard__]] |
4300 | inline wstring |
4301 | to_wstring(int __val) |
4302 | { return __gnu_cxx::__to_xstring<wstring>(&std::vswprintf, 4 * sizeof(int), |
4303 | L"%d", __val); } |
4304 | |
4305 | _GLIBCXX_NODISCARD[[__nodiscard__]] |
4306 | inline wstring |
4307 | to_wstring(unsigned __val) |
4308 | { return __gnu_cxx::__to_xstring<wstring>(&std::vswprintf, |
4309 | 4 * sizeof(unsigned), |
4310 | L"%u", __val); } |
4311 | |
4312 | _GLIBCXX_NODISCARD[[__nodiscard__]] |
4313 | inline wstring |
4314 | to_wstring(long __val) |
4315 | { return __gnu_cxx::__to_xstring<wstring>(&std::vswprintf, 4 * sizeof(long), |
4316 | L"%ld", __val); } |
4317 | |
4318 | _GLIBCXX_NODISCARD[[__nodiscard__]] |
4319 | inline wstring |
4320 | to_wstring(unsigned long __val) |
4321 | { return __gnu_cxx::__to_xstring<wstring>(&std::vswprintf, |
4322 | 4 * sizeof(unsigned long), |
4323 | L"%lu", __val); } |
4324 | |
4325 | _GLIBCXX_NODISCARD[[__nodiscard__]] |
4326 | inline wstring |
4327 | to_wstring(long long __val) |
4328 | { return __gnu_cxx::__to_xstring<wstring>(&std::vswprintf, |
4329 | 4 * sizeof(long long), |
4330 | L"%lld", __val); } |
4331 | |
4332 | _GLIBCXX_NODISCARD[[__nodiscard__]] |
4333 | inline wstring |
4334 | to_wstring(unsigned long long __val) |
4335 | { return __gnu_cxx::__to_xstring<wstring>(&std::vswprintf, |
4336 | 4 * sizeof(unsigned long long), |
4337 | L"%llu", __val); } |
4338 | |
4339 | _GLIBCXX_NODISCARD[[__nodiscard__]] |
4340 | inline wstring |
4341 | to_wstring(float __val) |
4342 | { |
4343 | const int __n = |
4344 | __gnu_cxx::__numeric_traits<float>::__max_exponent10 + 20; |
4345 | return __gnu_cxx::__to_xstring<wstring>(&std::vswprintf, __n, |
4346 | L"%f", __val); |
4347 | } |
4348 | |
4349 | _GLIBCXX_NODISCARD[[__nodiscard__]] |
4350 | inline wstring |
4351 | to_wstring(double __val) |
4352 | { |
4353 | const int __n = |
4354 | __gnu_cxx::__numeric_traits<double>::__max_exponent10 + 20; |
4355 | return __gnu_cxx::__to_xstring<wstring>(&std::vswprintf, __n, |
4356 | L"%f", __val); |
4357 | } |
4358 | |
4359 | _GLIBCXX_NODISCARD[[__nodiscard__]] |
4360 | inline wstring |
4361 | to_wstring(long double __val) |
4362 | { |
4363 | const int __n = |
4364 | __gnu_cxx::__numeric_traits<long double>::__max_exponent10 + 20; |
4365 | return __gnu_cxx::__to_xstring<wstring>(&std::vswprintf, __n, |
4366 | L"%Lf", __val); |
4367 | } |
4368 | #endif // _GLIBCXX_HAVE_BROKEN_VSWPRINTF |
4369 | #endif // _GLIBCXX_USE_WCHAR_T && _GLIBCXX_USE_C99_WCHAR |
4370 | |
4371 | _GLIBCXX_END_NAMESPACE_CXX11} |
4372 | _GLIBCXX_END_NAMESPACE_VERSION |
4373 | } // namespace |
4374 | |
4375 | #endif /* C++11 */ |
4376 | |
4377 | #if __cplusplus202002L >= 201103L |
4378 | |
4379 | #include <bits/functional_hash.h> |
4380 | |
4381 | namespace std _GLIBCXX_VISIBILITY(default)__attribute__ ((__visibility__ ("default"))) |
4382 | { |
4383 | _GLIBCXX_BEGIN_NAMESPACE_VERSION |
4384 | |
4385 | // _GLIBCXX_RESOLVE_LIB_DEFECTS |
4386 | // 3705. Hashability shouldn't depend on basic_string's allocator |
4387 | |
4388 | template<typename _CharT, typename _Alloc, |
4389 | typename _StrT = basic_string<_CharT, char_traits<_CharT>, _Alloc>> |
4390 | struct __str_hash_base |
4391 | : public __hash_base<size_t, _StrT> |
4392 | { |
4393 | [[__nodiscard__]] |
4394 | size_t |
4395 | operator()(const _StrT& __s) const noexcept |
4396 | { return _Hash_impl::hash(__s.data(), __s.length() * sizeof(_CharT)); } |
4397 | }; |
4398 | |
4399 | #ifndef _GLIBCXX_COMPATIBILITY_CXX0X |
4400 | /// std::hash specialization for string. |
4401 | template<typename _Alloc> |
4402 | struct hash<basic_string<char, char_traits<char>, _Alloc>> |
4403 | : public __str_hash_base<char, _Alloc> |
4404 | { }; |
4405 | |
4406 | /// std::hash specialization for wstring. |
4407 | template<typename _Alloc> |
4408 | struct hash<basic_string<wchar_t, char_traits<wchar_t>, _Alloc>> |
4409 | : public __str_hash_base<wchar_t, _Alloc> |
4410 | { }; |
4411 | |
4412 | template<typename _Alloc> |
4413 | struct __is_fast_hash<hash<basic_string<wchar_t, char_traits<wchar_t>, |
4414 | _Alloc>>> |
4415 | : std::false_type |
4416 | { }; |
4417 | #endif /* _GLIBCXX_COMPATIBILITY_CXX0X */ |
4418 | |
4419 | #ifdef _GLIBCXX_USE_CHAR8_T1 |
4420 | /// std::hash specialization for u8string. |
4421 | template<typename _Alloc> |
4422 | struct hash<basic_string<char8_t, char_traits<char8_t>, _Alloc>> |
4423 | : public __str_hash_base<char8_t, _Alloc> |
4424 | { }; |
4425 | #endif |
4426 | |
4427 | /// std::hash specialization for u16string. |
4428 | template<typename _Alloc> |
4429 | struct hash<basic_string<char16_t, char_traits<char16_t>, _Alloc>> |
4430 | : public __str_hash_base<char16_t, _Alloc> |
4431 | { }; |
4432 | |
4433 | /// std::hash specialization for u32string. |
4434 | template<typename _Alloc> |
4435 | struct hash<basic_string<char32_t, char_traits<char32_t>, _Alloc>> |
4436 | : public __str_hash_base<char32_t, _Alloc> |
4437 | { }; |
4438 | |
4439 | #if ! _GLIBCXX_INLINE_VERSION0 |
4440 | // PR libstdc++/105907 - __is_fast_hash affects unordered container ABI. |
4441 | template<> struct __is_fast_hash<hash<string>> : std::false_type { }; |
4442 | template<> struct __is_fast_hash<hash<wstring>> : std::false_type { }; |
4443 | template<> struct __is_fast_hash<hash<u16string>> : std::false_type { }; |
4444 | template<> struct __is_fast_hash<hash<u32string>> : std::false_type { }; |
4445 | #ifdef _GLIBCXX_USE_CHAR8_T1 |
4446 | template<> struct __is_fast_hash<hash<u8string>> : std::false_type { }; |
4447 | #endif |
4448 | #else |
4449 | // For versioned namespace, assume every std::hash<basic_string<>> is slow. |
4450 | template<typename _CharT, typename _Traits, typename _Alloc> |
4451 | struct __is_fast_hash<hash<basic_string<_CharT, _Traits, _Alloc>>> |
4452 | : std::false_type |
4453 | { }; |
4454 | #endif |
4455 | |
4456 | #if __cplusplus202002L >= 201402L |
4457 | |
4458 | #define __cpp_lib_string_udls201304L 201304L |
4459 | |
4460 | inline namespace literals |
4461 | { |
4462 | inline namespace string_literals |
4463 | { |
4464 | #pragma GCC diagnostic push |
4465 | #pragma GCC diagnostic ignored "-Wliteral-suffix" |
4466 | |
4467 | #if __cpp_lib_constexpr_string201907L >= 201907L |
4468 | # define _GLIBCXX_STRING_CONSTEXPR constexpr |
4469 | #else |
4470 | # define _GLIBCXX_STRING_CONSTEXPR |
4471 | #endif |
4472 | |
4473 | _GLIBCXX_DEFAULT_ABI_TAG__attribute ((__abi_tag__ ("cxx11"))) _GLIBCXX_STRING_CONSTEXPR |
4474 | inline basic_string<char> |
4475 | operator""s(const char* __str, size_t __len) |
4476 | { return basic_string<char>{__str, __len}; } |
4477 | |
4478 | _GLIBCXX_DEFAULT_ABI_TAG__attribute ((__abi_tag__ ("cxx11"))) _GLIBCXX_STRING_CONSTEXPR |
4479 | inline basic_string<wchar_t> |
4480 | operator""s(const wchar_t* __str, size_t __len) |
4481 | { return basic_string<wchar_t>{__str, __len}; } |
4482 | |
4483 | #ifdef _GLIBCXX_USE_CHAR8_T1 |
4484 | _GLIBCXX_DEFAULT_ABI_TAG__attribute ((__abi_tag__ ("cxx11"))) _GLIBCXX_STRING_CONSTEXPR |
4485 | inline basic_string<char8_t> |
4486 | operator""s(const char8_t* __str, size_t __len) |
4487 | { return basic_string<char8_t>{__str, __len}; } |
4488 | #endif |
4489 | |
4490 | _GLIBCXX_DEFAULT_ABI_TAG__attribute ((__abi_tag__ ("cxx11"))) _GLIBCXX_STRING_CONSTEXPR |
4491 | inline basic_string<char16_t> |
4492 | operator""s(const char16_t* __str, size_t __len) |
4493 | { return basic_string<char16_t>{__str, __len}; } |
4494 | |
4495 | _GLIBCXX_DEFAULT_ABI_TAG__attribute ((__abi_tag__ ("cxx11"))) _GLIBCXX_STRING_CONSTEXPR |
4496 | inline basic_string<char32_t> |
4497 | operator""s(const char32_t* __str, size_t __len) |
4498 | { return basic_string<char32_t>{__str, __len}; } |
4499 | |
4500 | #undef _GLIBCXX_STRING_CONSTEXPR |
4501 | #pragma GCC diagnostic pop |
4502 | } // inline namespace string_literals |
4503 | } // inline namespace literals |
4504 | |
4505 | #if __cplusplus202002L >= 201703L |
4506 | namespace __detail::__variant |
4507 | { |
4508 | template<typename> struct _Never_valueless_alt; // see <variant> |
4509 | |
4510 | // Provide the strong exception-safety guarantee when emplacing a |
4511 | // basic_string into a variant, but only if moving the string cannot throw. |
4512 | template<typename _Tp, typename _Traits, typename _Alloc> |
4513 | struct _Never_valueless_alt<std::basic_string<_Tp, _Traits, _Alloc>> |
4514 | : __and_< |
4515 | is_nothrow_move_constructible<std::basic_string<_Tp, _Traits, _Alloc>>, |
4516 | is_nothrow_move_assignable<std::basic_string<_Tp, _Traits, _Alloc>> |
4517 | >::type |
4518 | { }; |
4519 | } // namespace __detail::__variant |
4520 | #endif // C++17 |
4521 | #endif // C++14 |
4522 | |
4523 | _GLIBCXX_END_NAMESPACE_VERSION |
4524 | } // namespace std |
4525 | |
4526 | #endif // C++11 |
4527 | |
4528 | #endif /* _BASIC_STRING_H */ |
1 | // Copyright 2005, Google Inc. | |||
2 | // All rights reserved. | |||
3 | // | |||
4 | // Redistribution and use in source and binary forms, with or without | |||
5 | // modification, are permitted provided that the following conditions are | |||
6 | // met: | |||
7 | // | |||
8 | // * Redistributions of source code must retain the above copyright | |||
9 | // notice, this list of conditions and the following disclaimer. | |||
10 | // * Redistributions in binary form must reproduce the above | |||
11 | // copyright notice, this list of conditions and the following disclaimer | |||
12 | // in the documentation and/or other materials provided with the | |||
13 | // distribution. | |||
14 | // * Neither the name of Google Inc. nor the names of its | |||
15 | // contributors may be used to endorse or promote products derived from | |||
16 | // this software without specific prior written permission. | |||
17 | // | |||
18 | // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |||
19 | // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |||
20 | // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |||
21 | // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |||
22 | // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |||
23 | // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | |||
24 | // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | |||
25 | // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | |||
26 | // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | |||
27 | // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | |||
28 | // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |||
29 | ||||
30 | // | |||
31 | // The Google C++ Testing and Mocking Framework (Google Test) | |||
32 | // | |||
33 | // This header file defines the public API for Google Test. It should be | |||
34 | // included by any test program that uses Google Test. | |||
35 | // | |||
36 | // IMPORTANT NOTE: Due to limitation of the C++ language, we have to | |||
37 | // leave some internal implementation details in this header file. | |||
38 | // They are clearly marked by comments like this: | |||
39 | // | |||
40 | // // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM. | |||
41 | // | |||
42 | // Such code is NOT meant to be used by a user directly, and is subject | |||
43 | // to CHANGE WITHOUT NOTICE. Therefore DO NOT DEPEND ON IT in a user | |||
44 | // program! | |||
45 | // | |||
46 | // Acknowledgment: Google Test borrowed the idea of automatic test | |||
47 | // registration from Barthelemy Dagenais' (barthelemy@prologique.com) | |||
48 | // easyUnit framework. | |||
49 | ||||
50 | // GOOGLETEST_CM0001 DO NOT DELETE | |||
51 | ||||
52 | #ifndef GTEST_INCLUDE_GTEST_GTEST_H_ | |||
53 | #define GTEST_INCLUDE_GTEST_GTEST_H_ | |||
54 | ||||
55 | #include <cstddef> | |||
56 | #include <limits> | |||
57 | #include <memory> | |||
58 | #include <ostream> | |||
59 | #include <type_traits> | |||
60 | #include <vector> | |||
61 | ||||
62 | #include "gtest/internal/gtest-internal.h" | |||
63 | #include "gtest/internal/gtest-string.h" | |||
64 | #include "gtest/gtest-death-test.h" | |||
65 | #include "gtest/gtest-matchers.h" | |||
66 | #include "gtest/gtest-message.h" | |||
67 | #include "gtest/gtest-param-test.h" | |||
68 | #include "gtest/gtest-printers.h" | |||
69 | #include "gtest/gtest_prod.h" | |||
70 | #include "gtest/gtest-test-part.h" | |||
71 | #include "gtest/gtest-typed-test.h" | |||
72 | ||||
73 | GTEST_DISABLE_MSC_WARNINGS_PUSH_(4251 \ | |||
74 | /* class A needs to have dll-interface to be used by clients of class B */) | |||
75 | ||||
76 | namespace testing { | |||
77 | ||||
78 | // Silence C4100 (unreferenced formal parameter) and 4805 | |||
79 | // unsafe mix of type 'const int' and type 'const bool' | |||
80 | #ifdef _MSC_VER | |||
81 | # pragma warning(push) | |||
82 | # pragma warning(disable:4805) | |||
83 | # pragma warning(disable:4100) | |||
84 | #endif | |||
85 | ||||
86 | ||||
87 | // Declares the flags. | |||
88 | ||||
89 | // This flag temporary enables the disabled tests. | |||
90 | GTEST_DECLARE_bool_(also_run_disabled_tests)__attribute__((visibility ("default"))) extern bool FLAGS_gtest_also_run_disabled_tests; | |||
91 | ||||
92 | // This flag brings the debugger on an assertion failure. | |||
93 | GTEST_DECLARE_bool_(break_on_failure)__attribute__((visibility ("default"))) extern bool FLAGS_gtest_break_on_failure; | |||
94 | ||||
95 | // This flag controls whether Google Test catches all test-thrown exceptions | |||
96 | // and logs them as failures. | |||
97 | GTEST_DECLARE_bool_(catch_exceptions)__attribute__((visibility ("default"))) extern bool FLAGS_gtest_catch_exceptions; | |||
98 | ||||
99 | // This flag enables using colors in terminal output. Available values are | |||
100 | // "yes" to enable colors, "no" (disable colors), or "auto" (the default) | |||
101 | // to let Google Test decide. | |||
102 | GTEST_DECLARE_string_(color)__attribute__((visibility ("default"))) extern ::std::string FLAGS_gtest_color; | |||
103 | ||||
104 | // This flag sets up the filter to select by name using a glob pattern | |||
105 | // the tests to run. If the filter is not given all tests are executed. | |||
106 | GTEST_DECLARE_string_(filter)__attribute__((visibility ("default"))) extern ::std::string FLAGS_gtest_filter; | |||
107 | ||||
108 | // This flag controls whether Google Test installs a signal handler that dumps | |||
109 | // debugging information when fatal signals are raised. | |||
110 | GTEST_DECLARE_bool_(install_failure_signal_handler)__attribute__((visibility ("default"))) extern bool FLAGS_gtest_install_failure_signal_handler; | |||
111 | ||||
112 | // This flag causes the Google Test to list tests. None of the tests listed | |||
113 | // are actually run if the flag is provided. | |||
114 | GTEST_DECLARE_bool_(list_tests)__attribute__((visibility ("default"))) extern bool FLAGS_gtest_list_tests; | |||
115 | ||||
116 | // This flag controls whether Google Test emits a detailed XML report to a file | |||
117 | // in addition to its normal textual output. | |||
118 | GTEST_DECLARE_string_(output)__attribute__((visibility ("default"))) extern ::std::string FLAGS_gtest_output; | |||
119 | ||||
120 | // This flags control whether Google Test prints the elapsed time for each | |||
121 | // test. | |||
122 | GTEST_DECLARE_bool_(print_time)__attribute__((visibility ("default"))) extern bool FLAGS_gtest_print_time; | |||
123 | ||||
124 | // This flags control whether Google Test prints UTF8 characters as text. | |||
125 | GTEST_DECLARE_bool_(print_utf8)__attribute__((visibility ("default"))) extern bool FLAGS_gtest_print_utf8; | |||
126 | ||||
127 | // This flag specifies the random number seed. | |||
128 | GTEST_DECLARE_int32_(random_seed)__attribute__((visibility ("default"))) extern ::testing::internal ::Int32 FLAGS_gtest_random_seed; | |||
129 | ||||
130 | // This flag sets how many times the tests are repeated. The default value | |||
131 | // is 1. If the value is -1 the tests are repeating forever. | |||
132 | GTEST_DECLARE_int32_(repeat)__attribute__((visibility ("default"))) extern ::testing::internal ::Int32 FLAGS_gtest_repeat; | |||
133 | ||||
134 | // This flag controls whether Google Test includes Google Test internal | |||
135 | // stack frames in failure stack traces. | |||
136 | GTEST_DECLARE_bool_(show_internal_stack_frames)__attribute__((visibility ("default"))) extern bool FLAGS_gtest_show_internal_stack_frames; | |||
137 | ||||
138 | // When this flag is specified, tests' order is randomized on every iteration. | |||
139 | GTEST_DECLARE_bool_(shuffle)__attribute__((visibility ("default"))) extern bool FLAGS_gtest_shuffle; | |||
140 | ||||
141 | // This flag specifies the maximum number of stack frames to be | |||
142 | // printed in a failure message. | |||
143 | GTEST_DECLARE_int32_(stack_trace_depth)__attribute__((visibility ("default"))) extern ::testing::internal ::Int32 FLAGS_gtest_stack_trace_depth; | |||
144 | ||||
145 | // When this flag is specified, a failed assertion will throw an | |||
146 | // exception if exceptions are enabled, or exit the program with a | |||
147 | // non-zero code otherwise. For use with an external test framework. | |||
148 | GTEST_DECLARE_bool_(throw_on_failure)__attribute__((visibility ("default"))) extern bool FLAGS_gtest_throw_on_failure; | |||
149 | ||||
150 | // When this flag is set with a "host:port" string, on supported | |||
151 | // platforms test results are streamed to the specified port on | |||
152 | // the specified host machine. | |||
153 | GTEST_DECLARE_string_(stream_result_to)__attribute__((visibility ("default"))) extern ::std::string FLAGS_gtest_stream_result_to; | |||
154 | ||||
155 | #if GTEST_USE_OWN_FLAGFILE_FLAG_1 | |||
156 | GTEST_DECLARE_string_(flagfile)__attribute__((visibility ("default"))) extern ::std::string FLAGS_gtest_flagfile; | |||
157 | #endif // GTEST_USE_OWN_FLAGFILE_FLAG_ | |||
158 | ||||
159 | // The upper limit for valid stack trace depths. | |||
160 | const int kMaxStackTraceDepth = 100; | |||
161 | ||||
162 | namespace internal { | |||
163 | ||||
164 | class AssertHelper; | |||
165 | class DefaultGlobalTestPartResultReporter; | |||
166 | class ExecDeathTest; | |||
167 | class NoExecDeathTest; | |||
168 | class FinalSuccessChecker; | |||
169 | class GTestFlagSaver; | |||
170 | class StreamingListenerTest; | |||
171 | class TestResultAccessor; | |||
172 | class TestEventListenersAccessor; | |||
173 | class TestEventRepeater; | |||
174 | class UnitTestRecordPropertyTestHelper; | |||
175 | class WindowsDeathTest; | |||
176 | class FuchsiaDeathTest; | |||
177 | class UnitTestImpl* GetUnitTestImpl(); | |||
178 | void ReportFailureInUnknownLocation(TestPartResult::Type result_type, | |||
179 | const std::string& message); | |||
180 | ||||
181 | } // namespace internal | |||
182 | ||||
183 | // The friend relationship of some of these classes is cyclic. | |||
184 | // If we don't forward declare them the compiler might confuse the classes | |||
185 | // in friendship clauses with same named classes on the scope. | |||
186 | class Test; | |||
187 | class TestSuite; | |||
188 | ||||
189 | // Old API is still available but deprecated | |||
190 | #ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_ | |||
191 | using TestCase = TestSuite; | |||
192 | #endif | |||
193 | class TestInfo; | |||
194 | class UnitTest; | |||
195 | ||||
196 | // A class for indicating whether an assertion was successful. When | |||
197 | // the assertion wasn't successful, the AssertionResult object | |||
198 | // remembers a non-empty message that describes how it failed. | |||
199 | // | |||
200 | // To create an instance of this class, use one of the factory functions | |||
201 | // (AssertionSuccess() and AssertionFailure()). | |||
202 | // | |||
203 | // This class is useful for two purposes: | |||
204 | // 1. Defining predicate functions to be used with Boolean test assertions | |||
205 | // EXPECT_TRUE/EXPECT_FALSE and their ASSERT_ counterparts | |||
206 | // 2. Defining predicate-format functions to be | |||
207 | // used with predicate assertions (ASSERT_PRED_FORMAT*, etc). | |||
208 | // | |||
209 | // For example, if you define IsEven predicate: | |||
210 | // | |||
211 | // testing::AssertionResult IsEven(int n) { | |||
212 | // if ((n % 2) == 0) | |||
213 | // return testing::AssertionSuccess(); | |||
214 | // else | |||
215 | // return testing::AssertionFailure() << n << " is odd"; | |||
216 | // } | |||
217 | // | |||
218 | // Then the failed expectation EXPECT_TRUE(IsEven(Fib(5))) | |||
219 | // will print the message | |||
220 | // | |||
221 | // Value of: IsEven(Fib(5)) | |||
222 | // Actual: false (5 is odd) | |||
223 | // Expected: true | |||
224 | // | |||
225 | // instead of a more opaque | |||
226 | // | |||
227 | // Value of: IsEven(Fib(5)) | |||
228 | // Actual: false | |||
229 | // Expected: true | |||
230 | // | |||
231 | // in case IsEven is a simple Boolean predicate. | |||
232 | // | |||
233 | // If you expect your predicate to be reused and want to support informative | |||
234 | // messages in EXPECT_FALSE and ASSERT_FALSE (negative assertions show up | |||
235 | // about half as often as positive ones in our tests), supply messages for | |||
236 | // both success and failure cases: | |||
237 | // | |||
238 | // testing::AssertionResult IsEven(int n) { | |||
239 | // if ((n % 2) == 0) | |||
240 | // return testing::AssertionSuccess() << n << " is even"; | |||
241 | // else | |||
242 | // return testing::AssertionFailure() << n << " is odd"; | |||
243 | // } | |||
244 | // | |||
245 | // Then a statement EXPECT_FALSE(IsEven(Fib(6))) will print | |||
246 | // | |||
247 | // Value of: IsEven(Fib(6)) | |||
248 | // Actual: true (8 is even) | |||
249 | // Expected: false | |||
250 | // | |||
251 | // NB: Predicates that support negative Boolean assertions have reduced | |||
252 | // performance in positive ones so be careful not to use them in tests | |||
253 | // that have lots (tens of thousands) of positive Boolean assertions. | |||
254 | // | |||
255 | // To use this class with EXPECT_PRED_FORMAT assertions such as: | |||
256 | // | |||
257 | // // Verifies that Foo() returns an even number. | |||
258 | // EXPECT_PRED_FORMAT1(IsEven, Foo()); | |||
259 | // | |||
260 | // you need to define: | |||
261 | // | |||
262 | // testing::AssertionResult IsEven(const char* expr, int n) { | |||
263 | // if ((n % 2) == 0) | |||
264 | // return testing::AssertionSuccess(); | |||
265 | // else | |||
266 | // return testing::AssertionFailure() | |||
267 | // << "Expected: " << expr << " is even\n Actual: it's " << n; | |||
268 | // } | |||
269 | // | |||
270 | // If Foo() returns 5, you will see the following message: | |||
271 | // | |||
272 | // Expected: Foo() is even | |||
273 | // Actual: it's 5 | |||
274 | // | |||
275 | class GTEST_API___attribute__((visibility ("default"))) AssertionResult { | |||
276 | public: | |||
277 | // Copy constructor. | |||
278 | // Used in EXPECT_TRUE/FALSE(assertion_result). | |||
279 | AssertionResult(const AssertionResult& other); | |||
280 | ||||
281 | #if defined(_MSC_VER) && _MSC_VER < 1910 | |||
282 | GTEST_DISABLE_MSC_WARNINGS_PUSH_(4800 /* forcing value to bool */) | |||
283 | #endif | |||
284 | ||||
285 | // Used in the EXPECT_TRUE/FALSE(bool_expression). | |||
286 | // | |||
287 | // T must be contextually convertible to bool. | |||
288 | // | |||
289 | // The second parameter prevents this overload from being considered if | |||
290 | // the argument is implicitly convertible to AssertionResult. In that case | |||
291 | // we want AssertionResult's copy constructor to be used. | |||
292 | template <typename T> | |||
293 | explicit AssertionResult( | |||
294 | const T& success, | |||
295 | typename std::enable_if< | |||
296 | !std::is_convertible<T, AssertionResult>::value>::type* | |||
297 | /*enabler*/ | |||
298 | = nullptr) | |||
299 | : success_(success) {} | |||
300 | ||||
301 | #if defined(_MSC_VER) && _MSC_VER < 1910 | |||
302 | GTEST_DISABLE_MSC_WARNINGS_POP_() | |||
303 | #endif | |||
304 | ||||
305 | // Assignment operator. | |||
306 | AssertionResult& operator=(AssertionResult other) { | |||
307 | swap(other); | |||
308 | return *this; | |||
309 | } | |||
310 | ||||
311 | // Returns true if and only if the assertion succeeded. | |||
312 | operator bool() const { return success_; } // NOLINT | |||
313 | ||||
314 | // Returns the assertion's negation. Used with EXPECT/ASSERT_FALSE. | |||
315 | AssertionResult operator!() const; | |||
316 | ||||
317 | // Returns the text streamed into this AssertionResult. Test assertions | |||
318 | // use it when they fail (i.e., the predicate's outcome doesn't match the | |||
319 | // assertion's expectation). When nothing has been streamed into the | |||
320 | // object, returns an empty string. | |||
321 | const char* message() const { | |||
322 | return message_.get() != nullptr ? message_->c_str() : ""; | |||
323 | } | |||
324 | // Deprecated; please use message() instead. | |||
325 | const char* failure_message() const { return message(); } | |||
326 | ||||
327 | // Streams a custom failure message into this object. | |||
328 | template <typename T> AssertionResult& operator<<(const T& value) { | |||
329 | AppendMessage(Message() << value); | |||
330 | return *this; | |||
331 | } | |||
332 | ||||
333 | // Allows streaming basic output manipulators such as endl or flush into | |||
334 | // this object. | |||
335 | AssertionResult& operator<<( | |||
336 | ::std::ostream& (*basic_manipulator)(::std::ostream& stream)) { | |||
337 | AppendMessage(Message() << basic_manipulator); | |||
338 | return *this; | |||
339 | } | |||
340 | ||||
341 | private: | |||
342 | // Appends the contents of message to message_. | |||
343 | void AppendMessage(const Message& a_message) { | |||
344 | if (message_.get() == nullptr) message_.reset(new ::std::string); | |||
345 | message_->append(a_message.GetString().c_str()); | |||
346 | } | |||
347 | ||||
348 | // Swap the contents of this AssertionResult with other. | |||
349 | void swap(AssertionResult& other); | |||
350 | ||||
351 | // Stores result of the assertion predicate. | |||
352 | bool success_; | |||
353 | // Stores the message describing the condition in case the expectation | |||
354 | // construct is not satisfied with the predicate's outcome. | |||
355 | // Referenced via a pointer to avoid taking too much stack frame space | |||
356 | // with test assertions. | |||
357 | std::unique_ptr< ::std::string> message_; | |||
358 | }; | |||
359 | ||||
360 | // Makes a successful assertion result. | |||
361 | GTEST_API___attribute__((visibility ("default"))) AssertionResult AssertionSuccess(); | |||
362 | ||||
363 | // Makes a failed assertion result. | |||
364 | GTEST_API___attribute__((visibility ("default"))) AssertionResult AssertionFailure(); | |||
365 | ||||
366 | // Makes a failed assertion result with the given failure message. | |||
367 | // Deprecated; use AssertionFailure() << msg. | |||
368 | GTEST_API___attribute__((visibility ("default"))) AssertionResult AssertionFailure(const Message& msg); | |||
369 | ||||
370 | } // namespace testing | |||
371 | ||||
372 | // Includes the auto-generated header that implements a family of generic | |||
373 | // predicate assertion macros. This include comes late because it relies on | |||
374 | // APIs declared above. | |||
375 | #include "gtest/gtest_pred_impl.h" | |||
376 | ||||
377 | namespace testing { | |||
378 | ||||
379 | // The abstract class that all tests inherit from. | |||
380 | // | |||
381 | // In Google Test, a unit test program contains one or many TestSuites, and | |||
382 | // each TestSuite contains one or many Tests. | |||
383 | // | |||
384 | // When you define a test using the TEST macro, you don't need to | |||
385 | // explicitly derive from Test - the TEST macro automatically does | |||
386 | // this for you. | |||
387 | // | |||
388 | // The only time you derive from Test is when defining a test fixture | |||
389 | // to be used in a TEST_F. For example: | |||
390 | // | |||
391 | // class FooTest : public testing::Test { | |||
392 | // protected: | |||
393 | // void SetUp() override { ... } | |||
394 | // void TearDown() override { ... } | |||
395 | // ... | |||
396 | // }; | |||
397 | // | |||
398 | // TEST_F(FooTest, Bar) { ... } | |||
399 | // TEST_F(FooTest, Baz) { ... } | |||
400 | // | |||
401 | // Test is not copyable. | |||
402 | class GTEST_API___attribute__((visibility ("default"))) Test { | |||
403 | public: | |||
404 | friend class TestInfo; | |||
405 | ||||
406 | // The d'tor is virtual as we intend to inherit from Test. | |||
407 | virtual ~Test(); | |||
408 | ||||
409 | // Sets up the stuff shared by all tests in this test case. | |||
410 | // | |||
411 | // Google Test will call Foo::SetUpTestSuite() before running the first | |||
412 | // test in test case Foo. Hence a sub-class can define its own | |||
413 | // SetUpTestSuite() method to shadow the one defined in the super | |||
414 | // class. | |||
415 | // Failures that happen during SetUpTestSuite are logged but otherwise | |||
416 | // ignored. | |||
417 | static void SetUpTestSuite() {} | |||
418 | ||||
419 | // Tears down the stuff shared by all tests in this test suite. | |||
420 | // | |||
421 | // Google Test will call Foo::TearDownTestSuite() after running the last | |||
422 | // test in test case Foo. Hence a sub-class can define its own | |||
423 | // TearDownTestSuite() method to shadow the one defined in the super | |||
424 | // class. | |||
425 | // Failures that happen during TearDownTestSuite are logged but otherwise | |||
426 | // ignored. | |||
427 | static void TearDownTestSuite() {} | |||
428 | ||||
429 | // Legacy API is deprecated but still available | |||
430 | #ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_ | |||
431 | static void TearDownTestCase() {} | |||
432 | static void SetUpTestCase() {} | |||
433 | #endif // GTEST_REMOVE_LEGACY_TEST_CASEAPI_ | |||
434 | ||||
435 | // Returns true if and only if the current test has a fatal failure. | |||
436 | static bool HasFatalFailure(); | |||
437 | ||||
438 | // Returns true if and only if the current test has a non-fatal failure. | |||
439 | static bool HasNonfatalFailure(); | |||
440 | ||||
441 | // Returns true if and only if the current test was skipped. | |||
442 | static bool IsSkipped(); | |||
443 | ||||
444 | // Returns true if and only if the current test has a (either fatal or | |||
445 | // non-fatal) failure. | |||
446 | static bool HasFailure() { return HasFatalFailure() || HasNonfatalFailure(); } | |||
447 | ||||
448 | // Logs a property for the current test, test suite, or for the entire | |||
449 | // invocation of the test program when used outside of the context of a | |||
450 | // test suite. Only the last value for a given key is remembered. These | |||
451 | // are public static so they can be called from utility functions that are | |||
452 | // not members of the test fixture. Calls to RecordProperty made during | |||
453 | // lifespan of the test (from the moment its constructor starts to the | |||
454 | // moment its destructor finishes) will be output in XML as attributes of | |||
455 | // the <testcase> element. Properties recorded from fixture's | |||
456 | // SetUpTestSuite or TearDownTestSuite are logged as attributes of the | |||
457 | // corresponding <testsuite> element. Calls to RecordProperty made in the | |||
458 | // global context (before or after invocation of RUN_ALL_TESTS and from | |||
459 | // SetUp/TearDown method of Environment objects registered with Google | |||
460 | // Test) will be output as attributes of the <testsuites> element. | |||
461 | static void RecordProperty(const std::string& key, const std::string& value); | |||
462 | static void RecordProperty(const std::string& key, int value); | |||
463 | ||||
464 | protected: | |||
465 | // Creates a Test object. | |||
466 | Test(); | |||
467 | ||||
468 | // Sets up the test fixture. | |||
469 | virtual void SetUp(); | |||
470 | ||||
471 | // Tears down the test fixture. | |||
472 | virtual void TearDown(); | |||
473 | ||||
474 | private: | |||
475 | // Returns true if and only if the current test has the same fixture class | |||
476 | // as the first test in the current test suite. | |||
477 | static bool HasSameFixtureClass(); | |||
478 | ||||
479 | // Runs the test after the test fixture has been set up. | |||
480 | // | |||
481 | // A sub-class must implement this to define the test logic. | |||
482 | // | |||
483 | // DO NOT OVERRIDE THIS FUNCTION DIRECTLY IN A USER PROGRAM. | |||
484 | // Instead, use the TEST or TEST_F macro. | |||
485 | virtual void TestBody() = 0; | |||
486 | ||||
487 | // Sets up, executes, and tears down the test. | |||
488 | void Run(); | |||
489 | ||||
490 | // Deletes self. We deliberately pick an unusual name for this | |||
491 | // internal method to avoid clashing with names used in user TESTs. | |||
492 | void DeleteSelf_() { delete this; } | |||
493 | ||||
494 | const std::unique_ptr<GTEST_FLAG_SAVER_::testing::internal::GTestFlagSaver> gtest_flag_saver_; | |||
495 | ||||
496 | // Often a user misspells SetUp() as Setup() and spends a long time | |||
497 | // wondering why it is never called by Google Test. The declaration of | |||
498 | // the following method is solely for catching such an error at | |||
499 | // compile time: | |||
500 | // | |||
501 | // - The return type is deliberately chosen to be not void, so it | |||
502 | // will be a conflict if void Setup() is declared in the user's | |||
503 | // test fixture. | |||
504 | // | |||
505 | // - This method is private, so it will be another compiler error | |||
506 | // if the method is called from the user's test fixture. | |||
507 | // | |||
508 | // DO NOT OVERRIDE THIS FUNCTION. | |||
509 | // | |||
510 | // If you see an error about overriding the following function or | |||
511 | // about it being private, you have mis-spelled SetUp() as Setup(). | |||
512 | struct Setup_should_be_spelled_SetUp {}; | |||
513 | virtual Setup_should_be_spelled_SetUp* Setup() { return nullptr; } | |||
514 | ||||
515 | // We disallow copying Tests. | |||
516 | GTEST_DISALLOW_COPY_AND_ASSIGN_(Test)Test(Test const &) = delete; void operator=(Test const & ) = delete; | |||
517 | }; | |||
518 | ||||
519 | typedef internal::TimeInMillis TimeInMillis; | |||
520 | ||||
521 | // A copyable object representing a user specified test property which can be | |||
522 | // output as a key/value string pair. | |||
523 | // | |||
524 | // Don't inherit from TestProperty as its destructor is not virtual. | |||
525 | class TestProperty { | |||
526 | public: | |||
527 | // C'tor. TestProperty does NOT have a default constructor. | |||
528 | // Always use this constructor (with parameters) to create a | |||
529 | // TestProperty object. | |||
530 | TestProperty(const std::string& a_key, const std::string& a_value) : | |||
531 | key_(a_key), value_(a_value) { | |||
532 | } | |||
533 | ||||
534 | // Gets the user supplied key. | |||
535 | const char* key() const { | |||
536 | return key_.c_str(); | |||
537 | } | |||
538 | ||||
539 | // Gets the user supplied value. | |||
540 | const char* value() const { | |||
541 | return value_.c_str(); | |||
542 | } | |||
543 | ||||
544 | // Sets a new value, overriding the one supplied in the constructor. | |||
545 | void SetValue(const std::string& new_value) { | |||
546 | value_ = new_value; | |||
547 | } | |||
548 | ||||
549 | private: | |||
550 | // The key supplied by the user. | |||
551 | std::string key_; | |||
552 | // The value supplied by the user. | |||
553 | std::string value_; | |||
554 | }; | |||
555 | ||||
556 | // The result of a single Test. This includes a list of | |||
557 | // TestPartResults, a list of TestProperties, a count of how many | |||
558 | // death tests there are in the Test, and how much time it took to run | |||
559 | // the Test. | |||
560 | // | |||
561 | // TestResult is not copyable. | |||
562 | class GTEST_API___attribute__((visibility ("default"))) TestResult { | |||
563 | public: | |||
564 | // Creates an empty TestResult. | |||
565 | TestResult(); | |||
566 | ||||
567 | // D'tor. Do not inherit from TestResult. | |||
568 | ~TestResult(); | |||
569 | ||||
570 | // Gets the number of all test parts. This is the sum of the number | |||
571 | // of successful test parts and the number of failed test parts. | |||
572 | int total_part_count() const; | |||
573 | ||||
574 | // Returns the number of the test properties. | |||
575 | int test_property_count() const; | |||
576 | ||||
577 | // Returns true if and only if the test passed (i.e. no test part failed). | |||
578 | bool Passed() const { return !Skipped() && !Failed(); } | |||
579 | ||||
580 | // Returns true if and only if the test was skipped. | |||
581 | bool Skipped() const; | |||
582 | ||||
583 | // Returns true if and only if the test failed. | |||
584 | bool Failed() const; | |||
585 | ||||
586 | // Returns true if and only if the test fatally failed. | |||
587 | bool HasFatalFailure() const; | |||
588 | ||||
589 | // Returns true if and only if the test has a non-fatal failure. | |||
590 | bool HasNonfatalFailure() const; | |||
591 | ||||
592 | // Returns the elapsed time, in milliseconds. | |||
593 | TimeInMillis elapsed_time() const { return elapsed_time_; } | |||
594 | ||||
595 | // Gets the time of the test case start, in ms from the start of the | |||
596 | // UNIX epoch. | |||
597 | TimeInMillis start_timestamp() const { return start_timestamp_; } | |||
598 | ||||
599 | // Returns the i-th test part result among all the results. i can range from 0 | |||
600 | // to total_part_count() - 1. If i is not in that range, aborts the program. | |||
601 | const TestPartResult& GetTestPartResult(int i) const; | |||
602 | ||||
603 | // Returns the i-th test property. i can range from 0 to | |||
604 | // test_property_count() - 1. If i is not in that range, aborts the | |||
605 | // program. | |||
606 | const TestProperty& GetTestProperty(int i) const; | |||
607 | ||||
608 | private: | |||
609 | friend class TestInfo; | |||
610 | friend class TestSuite; | |||
611 | friend class UnitTest; | |||
612 | friend class internal::DefaultGlobalTestPartResultReporter; | |||
613 | friend class internal::ExecDeathTest; | |||
614 | friend class internal::TestResultAccessor; | |||
615 | friend class internal::UnitTestImpl; | |||
616 | friend class internal::WindowsDeathTest; | |||
617 | friend class internal::FuchsiaDeathTest; | |||
618 | ||||
619 | // Gets the vector of TestPartResults. | |||
620 | const std::vector<TestPartResult>& test_part_results() const { | |||
621 | return test_part_results_; | |||
622 | } | |||
623 | ||||
624 | // Gets the vector of TestProperties. | |||
625 | const std::vector<TestProperty>& test_properties() const { | |||
626 | return test_properties_; | |||
627 | } | |||
628 | ||||
629 | // Sets the start time. | |||
630 | void set_start_timestamp(TimeInMillis start) { start_timestamp_ = start; } | |||
631 | ||||
632 | // Sets the elapsed time. | |||
633 | void set_elapsed_time(TimeInMillis elapsed) { elapsed_time_ = elapsed; } | |||
634 | ||||
635 | // Adds a test property to the list. The property is validated and may add | |||
636 | // a non-fatal failure if invalid (e.g., if it conflicts with reserved | |||
637 | // key names). If a property is already recorded for the same key, the | |||
638 | // value will be updated, rather than storing multiple values for the same | |||
639 | // key. xml_element specifies the element for which the property is being | |||
640 | // recorded and is used for validation. | |||
641 | void RecordProperty(const std::string& xml_element, | |||
642 | const TestProperty& test_property); | |||
643 | ||||
644 | // Adds a failure if the key is a reserved attribute of Google Test | |||
645 | // testsuite tags. Returns true if the property is valid. | |||
646 | // FIXME: Validate attribute names are legal and human readable. | |||
647 | static bool ValidateTestProperty(const std::string& xml_element, | |||
648 | const TestProperty& test_property); | |||
649 | ||||
650 | // Adds a test part result to the list. | |||
651 | void AddTestPartResult(const TestPartResult& test_part_result); | |||
652 | ||||
653 | // Returns the death test count. | |||
654 | int death_test_count() const { return death_test_count_; } | |||
655 | ||||
656 | // Increments the death test count, returning the new count. | |||
657 | int increment_death_test_count() { return ++death_test_count_; } | |||
658 | ||||
659 | // Clears the test part results. | |||
660 | void ClearTestPartResults(); | |||
661 | ||||
662 | // Clears the object. | |||
663 | void Clear(); | |||
664 | ||||
665 | // Protects mutable state of the property vector and of owned | |||
666 | // properties, whose values may be updated. | |||
667 | internal::Mutex test_properites_mutex_; | |||
668 | ||||
669 | // The vector of TestPartResults | |||
670 | std::vector<TestPartResult> test_part_results_; | |||
671 | // The vector of TestProperties | |||
672 | std::vector<TestProperty> test_properties_; | |||
673 | // Running count of death tests. | |||
674 | int death_test_count_; | |||
675 | // The start time, in milliseconds since UNIX Epoch. | |||
676 | TimeInMillis start_timestamp_; | |||
677 | // The elapsed time, in milliseconds. | |||
678 | TimeInMillis elapsed_time_; | |||
679 | ||||
680 | // We disallow copying TestResult. | |||
681 | GTEST_DISALLOW_COPY_AND_ASSIGN_(TestResult)TestResult(TestResult const &) = delete; void operator=(TestResult const &) = delete; | |||
682 | }; // class TestResult | |||
683 | ||||
684 | // A TestInfo object stores the following information about a test: | |||
685 | // | |||
686 | // Test suite name | |||
687 | // Test name | |||
688 | // Whether the test should be run | |||
689 | // A function pointer that creates the test object when invoked | |||
690 | // Test result | |||
691 | // | |||
692 | // The constructor of TestInfo registers itself with the UnitTest | |||
693 | // singleton such that the RUN_ALL_TESTS() macro knows which tests to | |||
694 | // run. | |||
695 | class GTEST_API___attribute__((visibility ("default"))) TestInfo { | |||
696 | public: | |||
697 | // Destructs a TestInfo object. This function is not virtual, so | |||
698 | // don't inherit from TestInfo. | |||
699 | ~TestInfo(); | |||
700 | ||||
701 | // Returns the test suite name. | |||
702 | const char* test_suite_name() const { return test_suite_name_.c_str(); } | |||
703 | ||||
704 | // Legacy API is deprecated but still available | |||
705 | #ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_ | |||
706 | const char* test_case_name() const { return test_suite_name(); } | |||
707 | #endif // GTEST_REMOVE_LEGACY_TEST_CASEAPI_ | |||
708 | ||||
709 | // Returns the test name. | |||
710 | const char* name() const { return name_.c_str(); } | |||
711 | ||||
712 | // Returns the name of the parameter type, or NULL if this is not a typed | |||
713 | // or a type-parameterized test. | |||
714 | const char* type_param() const { | |||
715 | if (type_param_.get() != nullptr) return type_param_->c_str(); | |||
716 | return nullptr; | |||
717 | } | |||
718 | ||||
719 | // Returns the text representation of the value parameter, or NULL if this | |||
720 | // is not a value-parameterized test. | |||
721 | const char* value_param() const { | |||
722 | if (value_param_.get() != nullptr) return value_param_->c_str(); | |||
723 | return nullptr; | |||
724 | } | |||
725 | ||||
726 | // Returns the file name where this test is defined. | |||
727 | const char* file() const { return location_.file.c_str(); } | |||
728 | ||||
729 | // Returns the line where this test is defined. | |||
730 | int line() const { return location_.line; } | |||
731 | ||||
732 | // Return true if this test should not be run because it's in another shard. | |||
733 | bool is_in_another_shard() const { return is_in_another_shard_; } | |||
734 | ||||
735 | // Returns true if this test should run, that is if the test is not | |||
736 | // disabled (or it is disabled but the also_run_disabled_tests flag has | |||
737 | // been specified) and its full name matches the user-specified filter. | |||
738 | // | |||
739 | // Google Test allows the user to filter the tests by their full names. | |||
740 | // The full name of a test Bar in test suite Foo is defined as | |||
741 | // "Foo.Bar". Only the tests that match the filter will run. | |||
742 | // | |||
743 | // A filter is a colon-separated list of glob (not regex) patterns, | |||
744 | // optionally followed by a '-' and a colon-separated list of | |||
745 | // negative patterns (tests to exclude). A test is run if it | |||
746 | // matches one of the positive patterns and does not match any of | |||
747 | // the negative patterns. | |||
748 | // | |||
749 | // For example, *A*:Foo.* is a filter that matches any string that | |||
750 | // contains the character 'A' or starts with "Foo.". | |||
751 | bool should_run() const { return should_run_; } | |||
752 | ||||
753 | // Returns true if and only if this test will appear in the XML report. | |||
754 | bool is_reportable() const { | |||
755 | // The XML report includes tests matching the filter, excluding those | |||
756 | // run in other shards. | |||
757 | return matches_filter_ && !is_in_another_shard_; | |||
758 | } | |||
759 | ||||
760 | // Returns the result of the test. | |||
761 | const TestResult* result() const { return &result_; } | |||
762 | ||||
763 | private: | |||
764 | #if GTEST_HAS_DEATH_TEST1 | |||
765 | friend class internal::DefaultDeathTestFactory; | |||
766 | #endif // GTEST_HAS_DEATH_TEST | |||
767 | friend class Test; | |||
768 | friend class TestSuite; | |||
769 | friend class internal::UnitTestImpl; | |||
770 | friend class internal::StreamingListenerTest; | |||
771 | friend TestInfo* internal::MakeAndRegisterTestInfo( | |||
772 | const char* test_suite_name, const char* name, const char* type_param, | |||
773 | const char* value_param, internal::CodeLocation code_location, | |||
774 | internal::TypeId fixture_class_id, internal::SetUpTestSuiteFunc set_up_tc, | |||
775 | internal::TearDownTestSuiteFunc tear_down_tc, | |||
776 | internal::TestFactoryBase* factory); | |||
777 | ||||
778 | // Constructs a TestInfo object. The newly constructed instance assumes | |||
779 | // ownership of the factory object. | |||
780 | TestInfo(const std::string& test_suite_name, const std::string& name, | |||
781 | const char* a_type_param, // NULL if not a type-parameterized test | |||
782 | const char* a_value_param, // NULL if not a value-parameterized test | |||
783 | internal::CodeLocation a_code_location, | |||
784 | internal::TypeId fixture_class_id, | |||
785 | internal::TestFactoryBase* factory); | |||
786 | ||||
787 | // Increments the number of death tests encountered in this test so | |||
788 | // far. | |||
789 | int increment_death_test_count() { | |||
790 | return result_.increment_death_test_count(); | |||
791 | } | |||
792 | ||||
793 | // Creates the test object, runs it, records its result, and then | |||
794 | // deletes it. | |||
795 | void Run(); | |||
796 | ||||
797 | static void ClearTestResult(TestInfo* test_info) { | |||
798 | test_info->result_.Clear(); | |||
799 | } | |||
800 | ||||
801 | // These fields are immutable properties of the test. | |||
802 | const std::string test_suite_name_; // test suite name | |||
803 | const std::string name_; // Test name | |||
804 | // Name of the parameter type, or NULL if this is not a typed or a | |||
805 | // type-parameterized test. | |||
806 | const std::unique_ptr<const ::std::string> type_param_; | |||
807 | // Text representation of the value parameter, or NULL if this is not a | |||
808 | // value-parameterized test. | |||
809 | const std::unique_ptr<const ::std::string> value_param_; | |||
810 | internal::CodeLocation location_; | |||
811 | const internal::TypeId fixture_class_id_; // ID of the test fixture class | |||
812 | bool should_run_; // True if and only if this test should run | |||
813 | bool is_disabled_; // True if and only if this test is disabled | |||
814 | bool matches_filter_; // True if this test matches the | |||
815 | // user-specified filter. | |||
816 | bool is_in_another_shard_; // Will be run in another shard. | |||
817 | internal::TestFactoryBase* const factory_; // The factory that creates | |||
818 | // the test object | |||
819 | ||||
820 | // This field is mutable and needs to be reset before running the | |||
821 | // test for the second time. | |||
822 | TestResult result_; | |||
823 | ||||
824 | GTEST_DISALLOW_COPY_AND_ASSIGN_(TestInfo)TestInfo(TestInfo const &) = delete; void operator=(TestInfo const &) = delete; | |||
825 | }; | |||
826 | ||||
827 | // A test suite, which consists of a vector of TestInfos. | |||
828 | // | |||
829 | // TestSuite is not copyable. | |||
830 | class GTEST_API___attribute__((visibility ("default"))) TestSuite { | |||
831 | public: | |||
832 | // Creates a TestSuite with the given name. | |||
833 | // | |||
834 | // TestSuite does NOT have a default constructor. Always use this | |||
835 | // constructor to create a TestSuite object. | |||
836 | // | |||
837 | // Arguments: | |||
838 | // | |||
839 | // name: name of the test suite | |||
840 | // a_type_param: the name of the test's type parameter, or NULL if | |||
841 | // this is not a type-parameterized test. | |||
842 | // set_up_tc: pointer to the function that sets up the test suite | |||
843 | // tear_down_tc: pointer to the function that tears down the test suite | |||
844 | TestSuite(const char* name, const char* a_type_param, | |||
845 | internal::SetUpTestSuiteFunc set_up_tc, | |||
846 | internal::TearDownTestSuiteFunc tear_down_tc); | |||
847 | ||||
848 | // Destructor of TestSuite. | |||
849 | virtual ~TestSuite(); | |||
850 | ||||
851 | // Gets the name of the TestSuite. | |||
852 | const char* name() const { return name_.c_str(); } | |||
853 | ||||
854 | // Returns the name of the parameter type, or NULL if this is not a | |||
855 | // type-parameterized test suite. | |||
856 | const char* type_param() const { | |||
857 | if (type_param_.get() != nullptr) return type_param_->c_str(); | |||
858 | return nullptr; | |||
859 | } | |||
860 | ||||
861 | // Returns true if any test in this test suite should run. | |||
862 | bool should_run() const { return should_run_; } | |||
863 | ||||
864 | // Gets the number of successful tests in this test suite. | |||
865 | int successful_test_count() const; | |||
866 | ||||
867 | // Gets the number of skipped tests in this test suite. | |||
868 | int skipped_test_count() const; | |||
869 | ||||
870 | // Gets the number of failed tests in this test suite. | |||
871 | int failed_test_count() const; | |||
872 | ||||
873 | // Gets the number of disabled tests that will be reported in the XML report. | |||
874 | int reportable_disabled_test_count() const; | |||
875 | ||||
876 | // Gets the number of disabled tests in this test suite. | |||
877 | int disabled_test_count() const; | |||
878 | ||||
879 | // Gets the number of tests to be printed in the XML report. | |||
880 | int reportable_test_count() const; | |||
881 | ||||
882 | // Get the number of tests in this test suite that should run. | |||
883 | int test_to_run_count() const; | |||
884 | ||||
885 | // Gets the number of all tests in this test suite. | |||
886 | int total_test_count() const; | |||
887 | ||||
888 | // Returns true if and only if the test suite passed. | |||
889 | bool Passed() const { return !Failed(); } | |||
890 | ||||
891 | // Returns true if and only if the test suite failed. | |||
892 | bool Failed() const { return failed_test_count() > 0; } | |||
893 | ||||
894 | // Returns the elapsed time, in milliseconds. | |||
895 | TimeInMillis elapsed_time() const { return elapsed_time_; } | |||
896 | ||||
897 | // Gets the time of the test suite start, in ms from the start of the | |||
898 | // UNIX epoch. | |||
899 | TimeInMillis start_timestamp() const { return start_timestamp_; } | |||
900 | ||||
901 | // Returns the i-th test among all the tests. i can range from 0 to | |||
902 | // total_test_count() - 1. If i is not in that range, returns NULL. | |||
903 | const TestInfo* GetTestInfo(int i) const; | |||
904 | ||||
905 | // Returns the TestResult that holds test properties recorded during | |||
906 | // execution of SetUpTestSuite and TearDownTestSuite. | |||
907 | const TestResult& ad_hoc_test_result() const { return ad_hoc_test_result_; } | |||
908 | ||||
909 | private: | |||
910 | friend class Test; | |||
911 | friend class internal::UnitTestImpl; | |||
912 | ||||
913 | // Gets the (mutable) vector of TestInfos in this TestSuite. | |||
914 | std::vector<TestInfo*>& test_info_list() { return test_info_list_; } | |||
915 | ||||
916 | // Gets the (immutable) vector of TestInfos in this TestSuite. | |||
917 | const std::vector<TestInfo*>& test_info_list() const { | |||
918 | return test_info_list_; | |||
919 | } | |||
920 | ||||
921 | // Returns the i-th test among all the tests. i can range from 0 to | |||
922 | // total_test_count() - 1. If i is not in that range, returns NULL. | |||
923 | TestInfo* GetMutableTestInfo(int i); | |||
924 | ||||
925 | // Sets the should_run member. | |||
926 | void set_should_run(bool should) { should_run_ = should; } | |||
927 | ||||
928 | // Adds a TestInfo to this test suite. Will delete the TestInfo upon | |||
929 | // destruction of the TestSuite object. | |||
930 | void AddTestInfo(TestInfo * test_info); | |||
931 | ||||
932 | // Clears the results of all tests in this test suite. | |||
933 | void ClearResult(); | |||
934 | ||||
935 | // Clears the results of all tests in the given test suite. | |||
936 | static void ClearTestSuiteResult(TestSuite* test_suite) { | |||
937 | test_suite->ClearResult(); | |||
938 | } | |||
939 | ||||
940 | // Runs every test in this TestSuite. | |||
941 | void Run(); | |||
942 | ||||
943 | // Runs SetUpTestSuite() for this TestSuite. This wrapper is needed | |||
944 | // for catching exceptions thrown from SetUpTestSuite(). | |||
945 | void RunSetUpTestSuite() { | |||
946 | if (set_up_tc_ != nullptr) { | |||
947 | (*set_up_tc_)(); | |||
948 | } | |||
949 | } | |||
950 | ||||
951 | // Runs TearDownTestSuite() for this TestSuite. This wrapper is | |||
952 | // needed for catching exceptions thrown from TearDownTestSuite(). | |||
953 | void RunTearDownTestSuite() { | |||
954 | if (tear_down_tc_ != nullptr) { | |||
955 | (*tear_down_tc_)(); | |||
956 | } | |||
957 | } | |||
958 | ||||
959 | // Returns true if and only if test passed. | |||
960 | static bool TestPassed(const TestInfo* test_info) { | |||
961 | return test_info->should_run() && test_info->result()->Passed(); | |||
962 | } | |||
963 | ||||
964 | // Returns true if and only if test skipped. | |||
965 | static bool TestSkipped(const TestInfo* test_info) { | |||
966 | return test_info->should_run() && test_info->result()->Skipped(); | |||
967 | } | |||
968 | ||||
969 | // Returns true if and only if test failed. | |||
970 | static bool TestFailed(const TestInfo* test_info) { | |||
971 | return test_info->should_run() && test_info->result()->Failed(); | |||
972 | } | |||
973 | ||||
974 | // Returns true if and only if the test is disabled and will be reported in | |||
975 | // the XML report. | |||
976 | static bool TestReportableDisabled(const TestInfo* test_info) { | |||
977 | return test_info->is_reportable() && test_info->is_disabled_; | |||
978 | } | |||
979 | ||||
980 | // Returns true if and only if test is disabled. | |||
981 | static bool TestDisabled(const TestInfo* test_info) { | |||
982 | return test_info->is_disabled_; | |||
983 | } | |||
984 | ||||
985 | // Returns true if and only if this test will appear in the XML report. | |||
986 | static bool TestReportable(const TestInfo* test_info) { | |||
987 | return test_info->is_reportable(); | |||
988 | } | |||
989 | ||||
990 | // Returns true if the given test should run. | |||
991 | static bool ShouldRunTest(const TestInfo* test_info) { | |||
992 | return test_info->should_run(); | |||
993 | } | |||
994 | ||||
995 | // Shuffles the tests in this test suite. | |||
996 | void ShuffleTests(internal::Random* random); | |||
997 | ||||
998 | // Restores the test order to before the first shuffle. | |||
999 | void UnshuffleTests(); | |||
1000 | ||||
1001 | // Name of the test suite. | |||
1002 | std::string name_; | |||
1003 | // Name of the parameter type, or NULL if this is not a typed or a | |||
1004 | // type-parameterized test. | |||
1005 | const std::unique_ptr<const ::std::string> type_param_; | |||
1006 | // The vector of TestInfos in their original order. It owns the | |||
1007 | // elements in the vector. | |||
1008 | std::vector<TestInfo*> test_info_list_; | |||
1009 | // Provides a level of indirection for the test list to allow easy | |||
1010 | // shuffling and restoring the test order. The i-th element in this | |||
1011 | // vector is the index of the i-th test in the shuffled test list. | |||
1012 | std::vector<int> test_indices_; | |||
1013 | // Pointer to the function that sets up the test suite. | |||
1014 | internal::SetUpTestSuiteFunc set_up_tc_; | |||
1015 | // Pointer to the function that tears down the test suite. | |||
1016 | internal::TearDownTestSuiteFunc tear_down_tc_; | |||
1017 | // True if and only if any test in this test suite should run. | |||
1018 | bool should_run_; | |||
1019 | // The start time, in milliseconds since UNIX Epoch. | |||
1020 | TimeInMillis start_timestamp_; | |||
1021 | // Elapsed time, in milliseconds. | |||
1022 | TimeInMillis elapsed_time_; | |||
1023 | // Holds test properties recorded during execution of SetUpTestSuite and | |||
1024 | // TearDownTestSuite. | |||
1025 | TestResult ad_hoc_test_result_; | |||
1026 | ||||
1027 | // We disallow copying TestSuites. | |||
1028 | GTEST_DISALLOW_COPY_AND_ASSIGN_(TestSuite)TestSuite(TestSuite const &) = delete; void operator=(TestSuite const &) = delete; | |||
1029 | }; | |||
1030 | ||||
1031 | // An Environment object is capable of setting up and tearing down an | |||
1032 | // environment. You should subclass this to define your own | |||
1033 | // environment(s). | |||
1034 | // | |||
1035 | // An Environment object does the set-up and tear-down in virtual | |||
1036 | // methods SetUp() and TearDown() instead of the constructor and the | |||
1037 | // destructor, as: | |||
1038 | // | |||
1039 | // 1. You cannot safely throw from a destructor. This is a problem | |||
1040 | // as in some cases Google Test is used where exceptions are enabled, and | |||
1041 | // we may want to implement ASSERT_* using exceptions where they are | |||
1042 | // available. | |||
1043 | // 2. You cannot use ASSERT_* directly in a constructor or | |||
1044 | // destructor. | |||
1045 | class Environment { | |||
1046 | public: | |||
1047 | // The d'tor is virtual as we need to subclass Environment. | |||
1048 | virtual ~Environment() {} | |||
1049 | ||||
1050 | // Override this to define how to set up the environment. | |||
1051 | virtual void SetUp() {} | |||
1052 | ||||
1053 | // Override this to define how to tear down the environment. | |||
1054 | virtual void TearDown() {} | |||
1055 | private: | |||
1056 | // If you see an error about overriding the following function or | |||
1057 | // about it being private, you have mis-spelled SetUp() as Setup(). | |||
1058 | struct Setup_should_be_spelled_SetUp {}; | |||
1059 | virtual Setup_should_be_spelled_SetUp* Setup() { return nullptr; } | |||
1060 | }; | |||
1061 | ||||
1062 | #if GTEST_HAS_EXCEPTIONS(1 && 1) | |||
1063 | ||||
1064 | // Exception which can be thrown from TestEventListener::OnTestPartResult. | |||
1065 | class GTEST_API___attribute__((visibility ("default"))) AssertionException | |||
1066 | : public internal::GoogleTestFailureException { | |||
1067 | public: | |||
1068 | explicit AssertionException(const TestPartResult& result) | |||
1069 | : GoogleTestFailureException(result) {} | |||
1070 | }; | |||
1071 | ||||
1072 | #endif // GTEST_HAS_EXCEPTIONS | |||
1073 | ||||
1074 | // The interface for tracing execution of tests. The methods are organized in | |||
1075 | // the order the corresponding events are fired. | |||
1076 | class TestEventListener { | |||
1077 | public: | |||
1078 | virtual ~TestEventListener() {} | |||
1079 | ||||
1080 | // Fired before any test activity starts. | |||
1081 | virtual void OnTestProgramStart(const UnitTest& unit_test) = 0; | |||
1082 | ||||
1083 | // Fired before each iteration of tests starts. There may be more than | |||
1084 | // one iteration if GTEST_FLAG(repeat) is set. iteration is the iteration | |||
1085 | // index, starting from 0. | |||
1086 | virtual void OnTestIterationStart(const UnitTest& unit_test, | |||
1087 | int iteration) = 0; | |||
1088 | ||||
1089 | // Fired before environment set-up for each iteration of tests starts. | |||
1090 | virtual void OnEnvironmentsSetUpStart(const UnitTest& unit_test) = 0; | |||
1091 | ||||
1092 | // Fired after environment set-up for each iteration of tests ends. | |||
1093 | virtual void OnEnvironmentsSetUpEnd(const UnitTest& unit_test) = 0; | |||
1094 | ||||
1095 | // Fired before the test suite starts. | |||
1096 | virtual void OnTestSuiteStart(const TestSuite& /*test_suite*/) {} | |||
1097 | ||||
1098 | // Legacy API is deprecated but still available | |||
1099 | #ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_ | |||
1100 | virtual void OnTestCaseStart(const TestCase& /*test_case*/) {} | |||
1101 | #endif // GTEST_REMOVE_LEGACY_TEST_CASEAPI_ | |||
1102 | ||||
1103 | // Fired before the test starts. | |||
1104 | virtual void OnTestStart(const TestInfo& test_info) = 0; | |||
1105 | ||||
1106 | // Fired after a failed assertion or a SUCCEED() invocation. | |||
1107 | // If you want to throw an exception from this function to skip to the next | |||
1108 | // TEST, it must be AssertionException defined above, or inherited from it. | |||
1109 | virtual void OnTestPartResult(const TestPartResult& test_part_result) = 0; | |||
1110 | ||||
1111 | // Fired after the test ends. | |||
1112 | virtual void OnTestEnd(const TestInfo& test_info) = 0; | |||
1113 | ||||
1114 | // Fired after the test suite ends. | |||
1115 | virtual void OnTestSuiteEnd(const TestSuite& /*test_suite*/) {} | |||
1116 | ||||
1117 | // Legacy API is deprecated but still available | |||
1118 | #ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_ | |||
1119 | virtual void OnTestCaseEnd(const TestCase& /*test_case*/) {} | |||
1120 | #endif // GTEST_REMOVE_LEGACY_TEST_CASEAPI_ | |||
1121 | ||||
1122 | // Fired before environment tear-down for each iteration of tests starts. | |||
1123 | virtual void OnEnvironmentsTearDownStart(const UnitTest& unit_test) = 0; | |||
1124 | ||||
1125 | // Fired after environment tear-down for each iteration of tests ends. | |||
1126 | virtual void OnEnvironmentsTearDownEnd(const UnitTest& unit_test) = 0; | |||
1127 | ||||
1128 | // Fired after each iteration of tests finishes. | |||
1129 | virtual void OnTestIterationEnd(const UnitTest& unit_test, | |||
1130 | int iteration) = 0; | |||
1131 | ||||
1132 | // Fired after all test activities have ended. | |||
1133 | virtual void OnTestProgramEnd(const UnitTest& unit_test) = 0; | |||
1134 | }; | |||
1135 | ||||
1136 | // The convenience class for users who need to override just one or two | |||
1137 | // methods and are not concerned that a possible change to a signature of | |||
1138 | // the methods they override will not be caught during the build. For | |||
1139 | // comments about each method please see the definition of TestEventListener | |||
1140 | // above. | |||
1141 | class EmptyTestEventListener : public TestEventListener { | |||
1142 | public: | |||
1143 | void OnTestProgramStart(const UnitTest& /*unit_test*/) override {} | |||
1144 | void OnTestIterationStart(const UnitTest& /*unit_test*/, | |||
1145 | int /*iteration*/) override {} | |||
1146 | void OnEnvironmentsSetUpStart(const UnitTest& /*unit_test*/) override {} | |||
1147 | void OnEnvironmentsSetUpEnd(const UnitTest& /*unit_test*/) override {} | |||
1148 | void OnTestSuiteStart(const TestSuite& /*test_suite*/) override {} | |||
1149 | // Legacy API is deprecated but still available | |||
1150 | #ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_ | |||
1151 | void OnTestCaseStart(const TestCase& /*test_case*/) override {} | |||
1152 | #endif // GTEST_REMOVE_LEGACY_TEST_CASEAPI_ | |||
1153 | ||||
1154 | void OnTestStart(const TestInfo& /*test_info*/) override {} | |||
1155 | void OnTestPartResult(const TestPartResult& /*test_part_result*/) override {} | |||
1156 | void OnTestEnd(const TestInfo& /*test_info*/) override {} | |||
1157 | void OnTestSuiteEnd(const TestSuite& /*test_suite*/) override {} | |||
1158 | #ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_ | |||
1159 | void OnTestCaseEnd(const TestCase& /*test_case*/) override {} | |||
1160 | #endif // GTEST_REMOVE_LEGACY_TEST_CASEAPI_ | |||
1161 | ||||
1162 | void OnEnvironmentsTearDownStart(const UnitTest& /*unit_test*/) override {} | |||
1163 | void OnEnvironmentsTearDownEnd(const UnitTest& /*unit_test*/) override {} | |||
1164 | void OnTestIterationEnd(const UnitTest& /*unit_test*/, | |||
1165 | int /*iteration*/) override {} | |||
1166 | void OnTestProgramEnd(const UnitTest& /*unit_test*/) override {} | |||
1167 | }; | |||
1168 | ||||
1169 | // TestEventListeners lets users add listeners to track events in Google Test. | |||
1170 | class GTEST_API___attribute__((visibility ("default"))) TestEventListeners { | |||
1171 | public: | |||
1172 | TestEventListeners(); | |||
1173 | ~TestEventListeners(); | |||
1174 | ||||
1175 | // Appends an event listener to the end of the list. Google Test assumes | |||
1176 | // the ownership of the listener (i.e. it will delete the listener when | |||
1177 | // the test program finishes). | |||
1178 | void Append(TestEventListener* listener); | |||
1179 | ||||
1180 | // Removes the given event listener from the list and returns it. It then | |||
1181 | // becomes the caller's responsibility to delete the listener. Returns | |||
1182 | // NULL if the listener is not found in the list. | |||
1183 | TestEventListener* Release(TestEventListener* listener); | |||
1184 | ||||
1185 | // Returns the standard listener responsible for the default console | |||
1186 | // output. Can be removed from the listeners list to shut down default | |||
1187 | // console output. Note that removing this object from the listener list | |||
1188 | // with Release transfers its ownership to the caller and makes this | |||
1189 | // function return NULL the next time. | |||
1190 | TestEventListener* default_result_printer() const { | |||
1191 | return default_result_printer_; | |||
1192 | } | |||
1193 | ||||
1194 | // Returns the standard listener responsible for the default XML output | |||
1195 | // controlled by the --gtest_output=xml flag. Can be removed from the | |||
1196 | // listeners list by users who want to shut down the default XML output | |||
1197 | // controlled by this flag and substitute it with custom one. Note that | |||
1198 | // removing this object from the listener list with Release transfers its | |||
1199 | // ownership to the caller and makes this function return NULL the next | |||
1200 | // time. | |||
1201 | TestEventListener* default_xml_generator() const { | |||
1202 | return default_xml_generator_; | |||
1203 | } | |||
1204 | ||||
1205 | private: | |||
1206 | friend class TestSuite; | |||
1207 | friend class TestInfo; | |||
1208 | friend class internal::DefaultGlobalTestPartResultReporter; | |||
1209 | friend class internal::NoExecDeathTest; | |||
1210 | friend class internal::TestEventListenersAccessor; | |||
1211 | friend class internal::UnitTestImpl; | |||
1212 | ||||
1213 | // Returns repeater that broadcasts the TestEventListener events to all | |||
1214 | // subscribers. | |||
1215 | TestEventListener* repeater(); | |||
1216 | ||||
1217 | // Sets the default_result_printer attribute to the provided listener. | |||
1218 | // The listener is also added to the listener list and previous | |||
1219 | // default_result_printer is removed from it and deleted. The listener can | |||
1220 | // also be NULL in which case it will not be added to the list. Does | |||
1221 | // nothing if the previous and the current listener objects are the same. | |||
1222 | void SetDefaultResultPrinter(TestEventListener* listener); | |||
1223 | ||||
1224 | // Sets the default_xml_generator attribute to the provided listener. The | |||
1225 | // listener is also added to the listener list and previous | |||
1226 | // default_xml_generator is removed from it and deleted. The listener can | |||
1227 | // also be NULL in which case it will not be added to the list. Does | |||
1228 | // nothing if the previous and the current listener objects are the same. | |||
1229 | void SetDefaultXmlGenerator(TestEventListener* listener); | |||
1230 | ||||
1231 | // Controls whether events will be forwarded by the repeater to the | |||
1232 | // listeners in the list. | |||
1233 | bool EventForwardingEnabled() const; | |||
1234 | void SuppressEventForwarding(); | |||
1235 | ||||
1236 | // The actual list of listeners. | |||
1237 | internal::TestEventRepeater* repeater_; | |||
1238 | // Listener responsible for the standard result output. | |||
1239 | TestEventListener* default_result_printer_; | |||
1240 | // Listener responsible for the creation of the XML output file. | |||
1241 | TestEventListener* default_xml_generator_; | |||
1242 | ||||
1243 | // We disallow copying TestEventListeners. | |||
1244 | GTEST_DISALLOW_COPY_AND_ASSIGN_(TestEventListeners)TestEventListeners(TestEventListeners const &) = delete; void operator=(TestEventListeners const &) = delete; | |||
1245 | }; | |||
1246 | ||||
1247 | // A UnitTest consists of a vector of TestSuites. | |||
1248 | // | |||
1249 | // This is a singleton class. The only instance of UnitTest is | |||
1250 | // created when UnitTest::GetInstance() is first called. This | |||
1251 | // instance is never deleted. | |||
1252 | // | |||
1253 | // UnitTest is not copyable. | |||
1254 | // | |||
1255 | // This class is thread-safe as long as the methods are called | |||
1256 | // according to their specification. | |||
1257 | class GTEST_API___attribute__((visibility ("default"))) UnitTest { | |||
1258 | public: | |||
1259 | // Gets the singleton UnitTest object. The first time this method | |||
1260 | // is called, a UnitTest object is constructed and returned. | |||
1261 | // Consecutive calls will return the same object. | |||
1262 | static UnitTest* GetInstance(); | |||
1263 | ||||
1264 | // Runs all tests in this UnitTest object and prints the result. | |||
1265 | // Returns 0 if successful, or 1 otherwise. | |||
1266 | // | |||
1267 | // This method can only be called from the main thread. | |||
1268 | // | |||
1269 | // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM. | |||
1270 | int Run() GTEST_MUST_USE_RESULT___attribute__ ((warn_unused_result)); | |||
1271 | ||||
1272 | // Returns the working directory when the first TEST() or TEST_F() | |||
1273 | // was executed. The UnitTest object owns the string. | |||
1274 | const char* original_working_dir() const; | |||
1275 | ||||
1276 | // Returns the TestSuite object for the test that's currently running, | |||
1277 | // or NULL if no test is running. | |||
1278 | const TestSuite* current_test_suite() const GTEST_LOCK_EXCLUDED_(mutex_); | |||
1279 | ||||
1280 | // Legacy API is still available but deprecated | |||
1281 | #ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_ | |||
1282 | const TestCase* current_test_case() const GTEST_LOCK_EXCLUDED_(mutex_); | |||
1283 | #endif | |||
1284 | ||||
1285 | // Returns the TestInfo object for the test that's currently running, | |||
1286 | // or NULL if no test is running. | |||
1287 | const TestInfo* current_test_info() const | |||
1288 | GTEST_LOCK_EXCLUDED_(mutex_); | |||
1289 | ||||
1290 | // Returns the random seed used at the start of the current test run. | |||
1291 | int random_seed() const; | |||
1292 | ||||
1293 | // Returns the ParameterizedTestSuiteRegistry object used to keep track of | |||
1294 | // value-parameterized tests and instantiate and register them. | |||
1295 | // | |||
1296 | // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM. | |||
1297 | internal::ParameterizedTestSuiteRegistry& parameterized_test_registry() | |||
1298 | GTEST_LOCK_EXCLUDED_(mutex_); | |||
1299 | ||||
1300 | // Gets the number of successful test suites. | |||
1301 | int successful_test_suite_count() const; | |||
1302 | ||||
1303 | // Gets the number of failed test suites. | |||
1304 | int failed_test_suite_count() const; | |||
1305 | ||||
1306 | // Gets the number of all test suites. | |||
1307 | int total_test_suite_count() const; | |||
1308 | ||||
1309 | // Gets the number of all test suites that contain at least one test | |||
1310 | // that should run. | |||
1311 | int test_suite_to_run_count() const; | |||
1312 | ||||
1313 | // Legacy API is deprecated but still available | |||
1314 | #ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_ | |||
1315 | int successful_test_case_count() const; | |||
1316 | int failed_test_case_count() const; | |||
1317 | int total_test_case_count() const; | |||
1318 | int test_case_to_run_count() const; | |||
1319 | #endif // GTEST_REMOVE_LEGACY_TEST_CASEAPI_ | |||
1320 | ||||
1321 | // Gets the number of successful tests. | |||
1322 | int successful_test_count() const; | |||
1323 | ||||
1324 | // Gets the number of skipped tests. | |||
1325 | int skipped_test_count() const; | |||
1326 | ||||
1327 | // Gets the number of failed tests. | |||
1328 | int failed_test_count() const; | |||
1329 | ||||
1330 | // Gets the number of disabled tests that will be reported in the XML report. | |||
1331 | int reportable_disabled_test_count() const; | |||
1332 | ||||
1333 | // Gets the number of disabled tests. | |||
1334 | int disabled_test_count() const; | |||
1335 | ||||
1336 | // Gets the number of tests to be printed in the XML report. | |||
1337 | int reportable_test_count() const; | |||
1338 | ||||
1339 | // Gets the number of all tests. | |||
1340 | int total_test_count() const; | |||
1341 | ||||
1342 | // Gets the number of tests that should run. | |||
1343 | int test_to_run_count() const; | |||
1344 | ||||
1345 | // Gets the time of the test program start, in ms from the start of the | |||
1346 | // UNIX epoch. | |||
1347 | TimeInMillis start_timestamp() const; | |||
1348 | ||||
1349 | // Gets the elapsed time, in milliseconds. | |||
1350 | TimeInMillis elapsed_time() const; | |||
1351 | ||||
1352 | // Returns true if and only if the unit test passed (i.e. all test suites | |||
1353 | // passed). | |||
1354 | bool Passed() const; | |||
1355 | ||||
1356 | // Returns true if and only if the unit test failed (i.e. some test suite | |||
1357 | // failed or something outside of all tests failed). | |||
1358 | bool Failed() const; | |||
1359 | ||||
1360 | // Gets the i-th test suite among all the test suites. i can range from 0 to | |||
1361 | // total_test_suite_count() - 1. If i is not in that range, returns NULL. | |||
1362 | const TestSuite* GetTestSuite(int i) const; | |||
1363 | ||||
1364 | // Legacy API is deprecated but still available | |||
1365 | #ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_ | |||
1366 | const TestCase* GetTestCase(int i) const; | |||
1367 | #endif // GTEST_REMOVE_LEGACY_TEST_CASEAPI_ | |||
1368 | ||||
1369 | // Returns the TestResult containing information on test failures and | |||
1370 | // properties logged outside of individual test suites. | |||
1371 | const TestResult& ad_hoc_test_result() const; | |||
1372 | ||||
1373 | // Returns the list of event listeners that can be used to track events | |||
1374 | // inside Google Test. | |||
1375 | TestEventListeners& listeners(); | |||
1376 | ||||
1377 | private: | |||
1378 | // Registers and returns a global test environment. When a test | |||
1379 | // program is run, all global test environments will be set-up in | |||
1380 | // the order they were registered. After all tests in the program | |||
1381 | // have finished, all global test environments will be torn-down in | |||
1382 | // the *reverse* order they were registered. | |||
1383 | // | |||
1384 | // The UnitTest object takes ownership of the given environment. | |||
1385 | // | |||
1386 | // This method can only be called from the main thread. | |||
1387 | Environment* AddEnvironment(Environment* env); | |||
1388 | ||||
1389 | // Adds a TestPartResult to the current TestResult object. All | |||
1390 | // Google Test assertion macros (e.g. ASSERT_TRUE, EXPECT_EQ, etc) | |||
1391 | // eventually call this to report their results. The user code | |||
1392 | // should use the assertion macros instead of calling this directly. | |||
1393 | void AddTestPartResult(TestPartResult::Type result_type, | |||
1394 | const char* file_name, | |||
1395 | int line_number, | |||
1396 | const std::string& message, | |||
1397 | const std::string& os_stack_trace) | |||
1398 | GTEST_LOCK_EXCLUDED_(mutex_); | |||
1399 | ||||
1400 | // Adds a TestProperty to the current TestResult object when invoked from | |||
1401 | // inside a test, to current TestSuite's ad_hoc_test_result_ when invoked | |||
1402 | // from SetUpTestSuite or TearDownTestSuite, or to the global property set | |||
1403 | // when invoked elsewhere. If the result already contains a property with | |||
1404 | // the same key, the value will be updated. | |||
1405 | void RecordProperty(const std::string& key, const std::string& value); | |||
1406 | ||||
1407 | // Gets the i-th test suite among all the test suites. i can range from 0 to | |||
1408 | // total_test_suite_count() - 1. If i is not in that range, returns NULL. | |||
1409 | TestSuite* GetMutableTestSuite(int i); | |||
1410 | ||||
1411 | // Accessors for the implementation object. | |||
1412 | internal::UnitTestImpl* impl() { return impl_; } | |||
1413 | const internal::UnitTestImpl* impl() const { return impl_; } | |||
1414 | ||||
1415 | // These classes and functions are friends as they need to access private | |||
1416 | // members of UnitTest. | |||
1417 | friend class ScopedTrace; | |||
1418 | friend class Test; | |||
1419 | friend class internal::AssertHelper; | |||
1420 | friend class internal::StreamingListenerTest; | |||
1421 | friend class internal::UnitTestRecordPropertyTestHelper; | |||
1422 | friend Environment* AddGlobalTestEnvironment(Environment* env); | |||
1423 | friend internal::UnitTestImpl* internal::GetUnitTestImpl(); | |||
1424 | friend void internal::ReportFailureInUnknownLocation( | |||
1425 | TestPartResult::Type result_type, | |||
1426 | const std::string& message); | |||
1427 | ||||
1428 | // Creates an empty UnitTest. | |||
1429 | UnitTest(); | |||
1430 | ||||
1431 | // D'tor | |||
1432 | virtual ~UnitTest(); | |||
1433 | ||||
1434 | // Pushes a trace defined by SCOPED_TRACE() on to the per-thread | |||
1435 | // Google Test trace stack. | |||
1436 | void PushGTestTrace(const internal::TraceInfo& trace) | |||
1437 | GTEST_LOCK_EXCLUDED_(mutex_); | |||
1438 | ||||
1439 | // Pops a trace from the per-thread Google Test trace stack. | |||
1440 | void PopGTestTrace() | |||
1441 | GTEST_LOCK_EXCLUDED_(mutex_); | |||
1442 | ||||
1443 | // Protects mutable state in *impl_. This is mutable as some const | |||
1444 | // methods need to lock it too. | |||
1445 | mutable internal::Mutex mutex_; | |||
1446 | ||||
1447 | // Opaque implementation object. This field is never changed once | |||
1448 | // the object is constructed. We don't mark it as const here, as | |||
1449 | // doing so will cause a warning in the constructor of UnitTest. | |||
1450 | // Mutable state in *impl_ is protected by mutex_. | |||
1451 | internal::UnitTestImpl* impl_; | |||
1452 | ||||
1453 | // We disallow copying UnitTest. | |||
1454 | GTEST_DISALLOW_COPY_AND_ASSIGN_(UnitTest)UnitTest(UnitTest const &) = delete; void operator=(UnitTest const &) = delete; | |||
1455 | }; | |||
1456 | ||||
1457 | // A convenient wrapper for adding an environment for the test | |||
1458 | // program. | |||
1459 | // | |||
1460 | // You should call this before RUN_ALL_TESTS() is called, probably in | |||
1461 | // main(). If you use gtest_main, you need to call this before main() | |||
1462 | // starts for it to take effect. For example, you can define a global | |||
1463 | // variable like this: | |||
1464 | // | |||
1465 | // testing::Environment* const foo_env = | |||
1466 | // testing::AddGlobalTestEnvironment(new FooEnvironment); | |||
1467 | // | |||
1468 | // However, we strongly recommend you to write your own main() and | |||
1469 | // call AddGlobalTestEnvironment() there, as relying on initialization | |||
1470 | // of global variables makes the code harder to read and may cause | |||
1471 | // problems when you register multiple environments from different | |||
1472 | // translation units and the environments have dependencies among them | |||
1473 | // (remember that the compiler doesn't guarantee the order in which | |||
1474 | // global variables from different translation units are initialized). | |||
1475 | inline Environment* AddGlobalTestEnvironment(Environment* env) { | |||
1476 | return UnitTest::GetInstance()->AddEnvironment(env); | |||
1477 | } | |||
1478 | ||||
1479 | // Initializes Google Test. This must be called before calling | |||
1480 | // RUN_ALL_TESTS(). In particular, it parses a command line for the | |||
1481 | // flags that Google Test recognizes. Whenever a Google Test flag is | |||
1482 | // seen, it is removed from argv, and *argc is decremented. | |||
1483 | // | |||
1484 | // No value is returned. Instead, the Google Test flag variables are | |||
1485 | // updated. | |||
1486 | // | |||
1487 | // Calling the function for the second time has no user-visible effect. | |||
1488 | GTEST_API___attribute__((visibility ("default"))) void InitGoogleTest(int* argc, char** argv); | |||
1489 | ||||
1490 | // This overloaded version can be used in Windows programs compiled in | |||
1491 | // UNICODE mode. | |||
1492 | GTEST_API___attribute__((visibility ("default"))) void InitGoogleTest(int* argc, wchar_t** argv); | |||
1493 | ||||
1494 | // This overloaded version can be used on Arduino/embedded platforms where | |||
1495 | // there is no argc/argv. | |||
1496 | GTEST_API___attribute__((visibility ("default"))) void InitGoogleTest(); | |||
1497 | ||||
1498 | namespace internal { | |||
1499 | ||||
1500 | // Separate the error generating code from the code path to reduce the stack | |||
1501 | // frame size of CmpHelperEQ. This helps reduce the overhead of some sanitizers | |||
1502 | // when calling EXPECT_* in a tight loop. | |||
1503 | template <typename T1, typename T2> | |||
1504 | AssertionResult CmpHelperEQFailure(const char* lhs_expression, | |||
1505 | const char* rhs_expression, | |||
1506 | const T1& lhs, const T2& rhs) { | |||
1507 | return EqFailure(lhs_expression, | |||
1508 | rhs_expression, | |||
1509 | FormatForComparisonFailureMessage(lhs, rhs), | |||
1510 | FormatForComparisonFailureMessage(rhs, lhs), | |||
1511 | false); | |||
1512 | } | |||
1513 | ||||
1514 | // This block of code defines operator==/!= | |||
1515 | // to block lexical scope lookup. | |||
1516 | // It prevents using invalid operator==/!= defined at namespace scope. | |||
1517 | struct faketype {}; | |||
1518 | inline bool operator==(faketype, faketype) { return true; } | |||
1519 | inline bool operator!=(faketype, faketype) { return false; } | |||
1520 | ||||
1521 | // The helper function for {ASSERT|EXPECT}_EQ. | |||
1522 | template <typename T1, typename T2> | |||
1523 | AssertionResult CmpHelperEQ(const char* lhs_expression, | |||
1524 | const char* rhs_expression, | |||
1525 | const T1& lhs, | |||
1526 | const T2& rhs) { | |||
1527 | if (lhs == rhs) { | |||
| ||||
1528 | return AssertionSuccess(); | |||
1529 | } | |||
1530 | ||||
1531 | return CmpHelperEQFailure(lhs_expression, rhs_expression, lhs, rhs); | |||
1532 | } | |||
1533 | ||||
1534 | // With this overloaded version, we allow anonymous enums to be used | |||
1535 | // in {ASSERT|EXPECT}_EQ when compiled with gcc 4, as anonymous enums | |||
1536 | // can be implicitly cast to BiggestInt. | |||
1537 | GTEST_API___attribute__((visibility ("default"))) AssertionResult CmpHelperEQ(const char* lhs_expression, | |||
1538 | const char* rhs_expression, | |||
1539 | BiggestInt lhs, | |||
1540 | BiggestInt rhs); | |||
1541 | ||||
1542 | class EqHelper { | |||
1543 | public: | |||
1544 | // This templatized version is for the general case. | |||
1545 | template < | |||
1546 | typename T1, typename T2, | |||
1547 | // Disable this overload for cases where one argument is a pointer | |||
1548 | // and the other is the null pointer constant. | |||
1549 | typename std::enable_if<!std::is_integral<T1>::value || | |||
1550 | !std::is_pointer<T2>::value>::type* = nullptr> | |||
1551 | static AssertionResult Compare(const char* lhs_expression, | |||
1552 | const char* rhs_expression, const T1& lhs, | |||
1553 | const T2& rhs) { | |||
1554 | return CmpHelperEQ(lhs_expression, rhs_expression, lhs, rhs); | |||
1555 | } | |||
1556 | ||||
1557 | // With this overloaded version, we allow anonymous enums to be used | |||
1558 | // in {ASSERT|EXPECT}_EQ when compiled with gcc 4, as anonymous | |||
1559 | // enums can be implicitly cast to BiggestInt. | |||
1560 | // | |||
1561 | // Even though its body looks the same as the above version, we | |||
1562 | // cannot merge the two, as it will make anonymous enums unhappy. | |||
1563 | static AssertionResult Compare(const char* lhs_expression, | |||
1564 | const char* rhs_expression, | |||
1565 | BiggestInt lhs, | |||
1566 | BiggestInt rhs) { | |||
1567 | return CmpHelperEQ(lhs_expression, rhs_expression, lhs, rhs); | |||
1568 | } | |||
1569 | ||||
1570 | template <typename T> | |||
1571 | static AssertionResult Compare( | |||
1572 | const char* lhs_expression, const char* rhs_expression, | |||
1573 | // Handle cases where '0' is used as a null pointer literal. | |||
1574 | std::nullptr_t /* lhs */, T* rhs) { | |||
1575 | // We already know that 'lhs' is a null pointer. | |||
1576 | return CmpHelperEQ(lhs_expression, rhs_expression, static_cast<T*>(nullptr), | |||
1577 | rhs); | |||
1578 | } | |||
1579 | }; | |||
1580 | ||||
1581 | // Separate the error generating code from the code path to reduce the stack | |||
1582 | // frame size of CmpHelperOP. This helps reduce the overhead of some sanitizers | |||
1583 | // when calling EXPECT_OP in a tight loop. | |||
1584 | template <typename T1, typename T2> | |||
1585 | AssertionResult CmpHelperOpFailure(const char* expr1, const char* expr2, | |||
1586 | const T1& val1, const T2& val2, | |||
1587 | const char* op) { | |||
1588 | return AssertionFailure() | |||
1589 | << "Expected: (" << expr1 << ") " << op << " (" << expr2 | |||
1590 | << "), actual: " << FormatForComparisonFailureMessage(val1, val2) | |||
1591 | << " vs " << FormatForComparisonFailureMessage(val2, val1); | |||
1592 | } | |||
1593 | ||||
1594 | // A macro for implementing the helper functions needed to implement | |||
1595 | // ASSERT_?? and EXPECT_??. It is here just to avoid copy-and-paste | |||
1596 | // of similar code. | |||
1597 | // | |||
1598 | // For each templatized helper function, we also define an overloaded | |||
1599 | // version for BiggestInt in order to reduce code bloat and allow | |||
1600 | // anonymous enums to be used with {ASSERT|EXPECT}_?? when compiled | |||
1601 | // with gcc 4. | |||
1602 | // | |||
1603 | // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM. | |||
1604 | ||||
1605 | #define GTEST_IMPL_CMP_HELPER_(op_name, op)\ | |||
1606 | template <typename T1, typename T2>\ | |||
1607 | AssertionResult CmpHelper##op_name(const char* expr1, const char* expr2, \ | |||
1608 | const T1& val1, const T2& val2) {\ | |||
1609 | if (val1 op val2) {\ | |||
1610 | return AssertionSuccess();\ | |||
1611 | } else {\ | |||
1612 | return CmpHelperOpFailure(expr1, expr2, val1, val2, #op);\ | |||
1613 | }\ | |||
1614 | }\__attribute__((visibility ("default"))) | |||
1615 | GTEST_API___attribute__((visibility ("default"))) AssertionResult CmpHelper##op_name(\ | |||
1616 | const char* expr1, const char* expr2, BiggestInt val1, BiggestInt val2) | |||
1617 | ||||
1618 | // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM. | |||
1619 | ||||
1620 | // Implements the helper function for {ASSERT|EXPECT}_NE | |||
1621 | GTEST_IMPL_CMP_HELPER_(NE, !=); | |||
1622 | // Implements the helper function for {ASSERT|EXPECT}_LE | |||
1623 | GTEST_IMPL_CMP_HELPER_(LE, <=); | |||
1624 | // Implements the helper function for {ASSERT|EXPECT}_LT | |||
1625 | GTEST_IMPL_CMP_HELPER_(LT, <); | |||
1626 | // Implements the helper function for {ASSERT|EXPECT}_GE | |||
1627 | GTEST_IMPL_CMP_HELPER_(GE, >=); | |||
1628 | // Implements the helper function for {ASSERT|EXPECT}_GT | |||
1629 | GTEST_IMPL_CMP_HELPER_(GT, >); | |||
1630 | ||||
1631 | #undef GTEST_IMPL_CMP_HELPER_ | |||
1632 | ||||
1633 | // The helper function for {ASSERT|EXPECT}_STREQ. | |||
1634 | // | |||
1635 | // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM. | |||
1636 | GTEST_API___attribute__((visibility ("default"))) AssertionResult CmpHelperSTREQ(const char* s1_expression, | |||
1637 | const char* s2_expression, | |||
1638 | const char* s1, | |||
1639 | const char* s2); | |||
1640 | ||||
1641 | // The helper function for {ASSERT|EXPECT}_STRCASEEQ. | |||
1642 | // | |||
1643 | // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM. | |||
1644 | GTEST_API___attribute__((visibility ("default"))) AssertionResult CmpHelperSTRCASEEQ(const char* s1_expression, | |||
1645 | const char* s2_expression, | |||
1646 | const char* s1, | |||
1647 | const char* s2); | |||
1648 | ||||
1649 | // The helper function for {ASSERT|EXPECT}_STRNE. | |||
1650 | // | |||
1651 | // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM. | |||
1652 | GTEST_API___attribute__((visibility ("default"))) AssertionResult CmpHelperSTRNE(const char* s1_expression, | |||
1653 | const char* s2_expression, | |||
1654 | const char* s1, | |||
1655 | const char* s2); | |||
1656 | ||||
1657 | // The helper function for {ASSERT|EXPECT}_STRCASENE. | |||
1658 | // | |||
1659 | // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM. | |||
1660 | GTEST_API___attribute__((visibility ("default"))) AssertionResult CmpHelperSTRCASENE(const char* s1_expression, | |||
1661 | const char* s2_expression, | |||
1662 | const char* s1, | |||
1663 | const char* s2); | |||
1664 | ||||
1665 | ||||
1666 | // Helper function for *_STREQ on wide strings. | |||
1667 | // | |||
1668 | // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM. | |||
1669 | GTEST_API___attribute__((visibility ("default"))) AssertionResult CmpHelperSTREQ(const char* s1_expression, | |||
1670 | const char* s2_expression, | |||
1671 | const wchar_t* s1, | |||
1672 | const wchar_t* s2); | |||
1673 | ||||
1674 | // Helper function for *_STRNE on wide strings. | |||
1675 | // | |||
1676 | // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM. | |||
1677 | GTEST_API___attribute__((visibility ("default"))) AssertionResult CmpHelperSTRNE(const char* s1_expression, | |||
1678 | const char* s2_expression, | |||
1679 | const wchar_t* s1, | |||
1680 | const wchar_t* s2); | |||
1681 | ||||
1682 | } // namespace internal | |||
1683 | ||||
1684 | // IsSubstring() and IsNotSubstring() are intended to be used as the | |||
1685 | // first argument to {EXPECT,ASSERT}_PRED_FORMAT2(), not by | |||
1686 | // themselves. They check whether needle is a substring of haystack | |||
1687 | // (NULL is considered a substring of itself only), and return an | |||
1688 | // appropriate error message when they fail. | |||
1689 | // | |||
1690 | // The {needle,haystack}_expr arguments are the stringified | |||
1691 | // expressions that generated the two real arguments. | |||
1692 | GTEST_API___attribute__((visibility ("default"))) AssertionResult IsSubstring( | |||
1693 | const char* needle_expr, const char* haystack_expr, | |||
1694 | const char* needle, const char* haystack); | |||
1695 | GTEST_API___attribute__((visibility ("default"))) AssertionResult IsSubstring( | |||
1696 | const char* needle_expr, const char* haystack_expr, | |||
1697 | const wchar_t* needle, const wchar_t* haystack); | |||
1698 | GTEST_API___attribute__((visibility ("default"))) AssertionResult IsNotSubstring( | |||
1699 | const char* needle_expr, const char* haystack_expr, | |||
1700 | const char* needle, const char* haystack); | |||
1701 | GTEST_API___attribute__((visibility ("default"))) AssertionResult IsNotSubstring( | |||
1702 | const char* needle_expr, const char* haystack_expr, | |||
1703 | const wchar_t* needle, const wchar_t* haystack); | |||
1704 | GTEST_API___attribute__((visibility ("default"))) AssertionResult IsSubstring( | |||
1705 | const char* needle_expr, const char* haystack_expr, | |||
1706 | const ::std::string& needle, const ::std::string& haystack); | |||
1707 | GTEST_API___attribute__((visibility ("default"))) AssertionResult IsNotSubstring( | |||
1708 | const char* needle_expr, const char* haystack_expr, | |||
1709 | const ::std::string& needle, const ::std::string& haystack); | |||
1710 | ||||
1711 | #if GTEST_HAS_STD_WSTRING(!(GTEST_OS_LINUX_ANDROID || GTEST_OS_CYGWIN || GTEST_OS_SOLARIS || GTEST_OS_HAIKU)) | |||
1712 | GTEST_API___attribute__((visibility ("default"))) AssertionResult IsSubstring( | |||
1713 | const char* needle_expr, const char* haystack_expr, | |||
1714 | const ::std::wstring& needle, const ::std::wstring& haystack); | |||
1715 | GTEST_API___attribute__((visibility ("default"))) AssertionResult IsNotSubstring( | |||
1716 | const char* needle_expr, const char* haystack_expr, | |||
1717 | const ::std::wstring& needle, const ::std::wstring& haystack); | |||
1718 | #endif // GTEST_HAS_STD_WSTRING | |||
1719 | ||||
1720 | namespace internal { | |||
1721 | ||||
1722 | // Helper template function for comparing floating-points. | |||
1723 | // | |||
1724 | // Template parameter: | |||
1725 | // | |||
1726 | // RawType: the raw floating-point type (either float or double) | |||
1727 | // | |||
1728 | // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM. | |||
1729 | template <typename RawType> | |||
1730 | AssertionResult CmpHelperFloatingPointEQ(const char* lhs_expression, | |||
1731 | const char* rhs_expression, | |||
1732 | RawType lhs_value, | |||
1733 | RawType rhs_value) { | |||
1734 | const FloatingPoint<RawType> lhs(lhs_value), rhs(rhs_value); | |||
1735 | ||||
1736 | if (lhs.AlmostEquals(rhs)) { | |||
1737 | return AssertionSuccess(); | |||
1738 | } | |||
1739 | ||||
1740 | ::std::stringstream lhs_ss; | |||
1741 | lhs_ss << std::setprecision(std::numeric_limits<RawType>::digits10 + 2) | |||
1742 | << lhs_value; | |||
1743 | ||||
1744 | ::std::stringstream rhs_ss; | |||
1745 | rhs_ss << std::setprecision(std::numeric_limits<RawType>::digits10 + 2) | |||
1746 | << rhs_value; | |||
1747 | ||||
1748 | return EqFailure(lhs_expression, | |||
1749 | rhs_expression, | |||
1750 | StringStreamToString(&lhs_ss), | |||
1751 | StringStreamToString(&rhs_ss), | |||
1752 | false); | |||
1753 | } | |||
1754 | ||||
1755 | // Helper function for implementing ASSERT_NEAR. | |||
1756 | // | |||
1757 | // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM. | |||
1758 | GTEST_API___attribute__((visibility ("default"))) AssertionResult DoubleNearPredFormat(const char* expr1, | |||
1759 | const char* expr2, | |||
1760 | const char* abs_error_expr, | |||
1761 | double val1, | |||
1762 | double val2, | |||
1763 | double abs_error); | |||
1764 | ||||
1765 | // INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE. | |||
1766 | // A class that enables one to stream messages to assertion macros | |||
1767 | class GTEST_API___attribute__((visibility ("default"))) AssertHelper { | |||
1768 | public: | |||
1769 | // Constructor. | |||
1770 | AssertHelper(TestPartResult::Type type, | |||
1771 | const char* file, | |||
1772 | int line, | |||
1773 | const char* message); | |||
1774 | ~AssertHelper(); | |||
1775 | ||||
1776 | // Message assignment is a semantic trick to enable assertion | |||
1777 | // streaming; see the GTEST_MESSAGE_ macro below. | |||
1778 | void operator=(const Message& message) const; | |||
1779 | ||||
1780 | private: | |||
1781 | // We put our data in a struct so that the size of the AssertHelper class can | |||
1782 | // be as small as possible. This is important because gcc is incapable of | |||
1783 | // re-using stack space even for temporary variables, so every EXPECT_EQ | |||
1784 | // reserves stack space for another AssertHelper. | |||
1785 | struct AssertHelperData { | |||
1786 | AssertHelperData(TestPartResult::Type t, | |||
1787 | const char* srcfile, | |||
1788 | int line_num, | |||
1789 | const char* msg) | |||
1790 | : type(t), file(srcfile), line(line_num), message(msg) { } | |||
1791 | ||||
1792 | TestPartResult::Type const type; | |||
1793 | const char* const file; | |||
1794 | int const line; | |||
1795 | std::string const message; | |||
1796 | ||||
1797 | private: | |||
1798 | GTEST_DISALLOW_COPY_AND_ASSIGN_(AssertHelperData)AssertHelperData(AssertHelperData const &) = delete; void operator=(AssertHelperData const &) = delete; | |||
1799 | }; | |||
1800 | ||||
1801 | AssertHelperData* const data_; | |||
1802 | ||||
1803 | GTEST_DISALLOW_COPY_AND_ASSIGN_(AssertHelper)AssertHelper(AssertHelper const &) = delete; void operator =(AssertHelper const &) = delete; | |||
1804 | }; | |||
1805 | ||||
1806 | enum GTestColor { COLOR_DEFAULT, COLOR_RED, COLOR_GREEN, COLOR_YELLOW }; | |||
1807 | ||||
1808 | GTEST_API___attribute__((visibility ("default"))) GTEST_ATTRIBUTE_PRINTF_(2, 3)__attribute__((__format__(__printf__, 2, 3))) void ColoredPrintf(GTestColor color, | |||
1809 | const char* fmt, | |||
1810 | ...); | |||
1811 | ||||
1812 | } // namespace internal | |||
1813 | ||||
1814 | // The pure interface class that all value-parameterized tests inherit from. | |||
1815 | // A value-parameterized class must inherit from both ::testing::Test and | |||
1816 | // ::testing::WithParamInterface. In most cases that just means inheriting | |||
1817 | // from ::testing::TestWithParam, but more complicated test hierarchies | |||
1818 | // may need to inherit from Test and WithParamInterface at different levels. | |||
1819 | // | |||
1820 | // This interface has support for accessing the test parameter value via | |||
1821 | // the GetParam() method. | |||
1822 | // | |||
1823 | // Use it with one of the parameter generator defining functions, like Range(), | |||
1824 | // Values(), ValuesIn(), Bool(), and Combine(). | |||
1825 | // | |||
1826 | // class FooTest : public ::testing::TestWithParam<int> { | |||
1827 | // protected: | |||
1828 | // FooTest() { | |||
1829 | // // Can use GetParam() here. | |||
1830 | // } | |||
1831 | // ~FooTest() override { | |||
1832 | // // Can use GetParam() here. | |||
1833 | // } | |||
1834 | // void SetUp() override { | |||
1835 | // // Can use GetParam() here. | |||
1836 | // } | |||
1837 | // void TearDown override { | |||
1838 | // // Can use GetParam() here. | |||
1839 | // } | |||
1840 | // }; | |||
1841 | // TEST_P(FooTest, DoesBar) { | |||
1842 | // // Can use GetParam() method here. | |||
1843 | // Foo foo; | |||
1844 | // ASSERT_TRUE(foo.DoesBar(GetParam())); | |||
1845 | // } | |||
1846 | // INSTANTIATE_TEST_SUITE_P(OneToTenRange, FooTest, ::testing::Range(1, 10)); | |||
1847 | ||||
1848 | template <typename T> | |||
1849 | class WithParamInterface { | |||
1850 | public: | |||
1851 | typedef T ParamType; | |||
1852 | virtual ~WithParamInterface() {} | |||
1853 | ||||
1854 | // The current parameter value. Is also available in the test fixture's | |||
1855 | // constructor. | |||
1856 | static const ParamType& GetParam() { | |||
1857 | GTEST_CHECK_(parameter_ != nullptr)switch (0) case 0: default: if (::testing::internal::IsTrue(parameter_ != nullptr)) ; else ::testing::internal::GTestLog(::testing:: internal::GTEST_FATAL, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 1857).GetStream() << "Condition " "parameter_ != nullptr" " failed. " | |||
1858 | << "GetParam() can only be called inside a value-parameterized test " | |||
1859 | << "-- did you intend to write TEST_P instead of TEST_F?"; | |||
1860 | return *parameter_; | |||
1861 | } | |||
1862 | ||||
1863 | private: | |||
1864 | // Sets parameter value. The caller is responsible for making sure the value | |||
1865 | // remains alive and unchanged throughout the current test. | |||
1866 | static void SetParam(const ParamType* parameter) { | |||
1867 | parameter_ = parameter; | |||
1868 | } | |||
1869 | ||||
1870 | // Static value used for accessing parameter during a test lifetime. | |||
1871 | static const ParamType* parameter_; | |||
1872 | ||||
1873 | // TestClass must be a subclass of WithParamInterface<T> and Test. | |||
1874 | template <class TestClass> friend class internal::ParameterizedTestFactory; | |||
1875 | }; | |||
1876 | ||||
1877 | template <typename T> | |||
1878 | const T* WithParamInterface<T>::parameter_ = nullptr; | |||
1879 | ||||
1880 | // Most value-parameterized classes can ignore the existence of | |||
1881 | // WithParamInterface, and can just inherit from ::testing::TestWithParam. | |||
1882 | ||||
1883 | template <typename T> | |||
1884 | class TestWithParam : public Test, public WithParamInterface<T> { | |||
1885 | }; | |||
1886 | ||||
1887 | // Macros for indicating success/failure in test code. | |||
1888 | ||||
1889 | // Skips test in runtime. | |||
1890 | // Skipping test aborts current function. | |||
1891 | // Skipped tests are neither successful nor failed. | |||
1892 | #define GTEST_SKIP()return ::testing::internal::AssertHelper(::testing::TestPartResult ::kSkip, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 1892, "Skipped") = ::testing::Message() GTEST_SKIP_("Skipped")return ::testing::internal::AssertHelper(::testing::TestPartResult ::kSkip, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 1892, "Skipped") = ::testing::Message() | |||
1893 | ||||
1894 | // ADD_FAILURE unconditionally adds a failure to the current test. | |||
1895 | // SUCCEED generates a success - it doesn't automatically make the | |||
1896 | // current test successful, as a test is only successful when it has | |||
1897 | // no failure. | |||
1898 | // | |||
1899 | // EXPECT_* verifies that a certain condition is satisfied. If not, | |||
1900 | // it behaves like ADD_FAILURE. In particular: | |||
1901 | // | |||
1902 | // EXPECT_TRUE verifies that a Boolean condition is true. | |||
1903 | // EXPECT_FALSE verifies that a Boolean condition is false. | |||
1904 | // | |||
1905 | // FAIL and ASSERT_* are similar to ADD_FAILURE and EXPECT_*, except | |||
1906 | // that they will also abort the current function on failure. People | |||
1907 | // usually want the fail-fast behavior of FAIL and ASSERT_*, but those | |||
1908 | // writing data-driven tests often find themselves using ADD_FAILURE | |||
1909 | // and EXPECT_* more. | |||
1910 | ||||
1911 | // Generates a nonfatal failure with a generic message. | |||
1912 | #define ADD_FAILURE()::testing::internal::AssertHelper(::testing::TestPartResult:: kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 1912, "Failed") = ::testing::Message() GTEST_NONFATAL_FAILURE_("Failed")::testing::internal::AssertHelper(::testing::TestPartResult:: kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 1912, "Failed") = ::testing::Message() | |||
1913 | ||||
1914 | // Generates a nonfatal failure at the given source file location with | |||
1915 | // a generic message. | |||
1916 | #define ADD_FAILURE_AT(file, line)::testing::internal::AssertHelper(::testing::TestPartResult:: kNonFatalFailure, file, line, "Failed") = ::testing::Message( ) \ | |||
1917 | GTEST_MESSAGE_AT_(file, line, "Failed", \::testing::internal::AssertHelper(::testing::TestPartResult:: kNonFatalFailure, file, line, "Failed") = ::testing::Message( ) | |||
1918 | ::testing::TestPartResult::kNonFatalFailure)::testing::internal::AssertHelper(::testing::TestPartResult:: kNonFatalFailure, file, line, "Failed") = ::testing::Message( ) | |||
1919 | ||||
1920 | // Generates a fatal failure with a generic message. | |||
1921 | #define GTEST_FAIL()return ::testing::internal::AssertHelper(::testing::TestPartResult ::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 1921, "Failed") = ::testing::Message() GTEST_FATAL_FAILURE_("Failed")return ::testing::internal::AssertHelper(::testing::TestPartResult ::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 1921, "Failed") = ::testing::Message() | |||
1922 | ||||
1923 | // Like GTEST_FAIL(), but at the given source file location. | |||
1924 | #define GTEST_FAIL_AT(file, line)::testing::internal::AssertHelper(::testing::TestPartResult:: kFatalFailure, file, line, "Failed") = ::testing::Message() \ | |||
1925 | GTEST_MESSAGE_AT_(file, line, "Failed", \::testing::internal::AssertHelper(::testing::TestPartResult:: kFatalFailure, file, line, "Failed") = ::testing::Message() | |||
1926 | ::testing::TestPartResult::kFatalFailure)::testing::internal::AssertHelper(::testing::TestPartResult:: kFatalFailure, file, line, "Failed") = ::testing::Message() | |||
1927 | ||||
1928 | // Define this macro to 1 to omit the definition of FAIL(), which is a | |||
1929 | // generic name and clashes with some other libraries. | |||
1930 | #if !GTEST_DONT_DEFINE_FAIL | |||
1931 | # define FAIL()return ::testing::internal::AssertHelper(::testing::TestPartResult ::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 1931, "Failed") = ::testing::Message() GTEST_FAIL()return ::testing::internal::AssertHelper(::testing::TestPartResult ::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 1931, "Failed") = ::testing::Message() | |||
1932 | #endif | |||
1933 | ||||
1934 | // Generates a success with a generic message. | |||
1935 | #define GTEST_SUCCEED()::testing::internal::AssertHelper(::testing::TestPartResult:: kSuccess, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 1935, "Succeeded") = ::testing::Message() GTEST_SUCCESS_("Succeeded")::testing::internal::AssertHelper(::testing::TestPartResult:: kSuccess, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 1935, "Succeeded") = ::testing::Message() | |||
1936 | ||||
1937 | // Define this macro to 1 to omit the definition of SUCCEED(), which | |||
1938 | // is a generic name and clashes with some other libraries. | |||
1939 | #if !GTEST_DONT_DEFINE_SUCCEED | |||
1940 | # define SUCCEED()::testing::internal::AssertHelper(::testing::TestPartResult:: kSuccess, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 1940, "Succeeded") = ::testing::Message() GTEST_SUCCEED()::testing::internal::AssertHelper(::testing::TestPartResult:: kSuccess, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 1940, "Succeeded") = ::testing::Message() | |||
1941 | #endif | |||
1942 | ||||
1943 | // Macros for testing exceptions. | |||
1944 | // | |||
1945 | // * {ASSERT|EXPECT}_THROW(statement, expected_exception): | |||
1946 | // Tests that the statement throws the expected exception. | |||
1947 | // * {ASSERT|EXPECT}_NO_THROW(statement): | |||
1948 | // Tests that the statement doesn't throw any exception. | |||
1949 | // * {ASSERT|EXPECT}_ANY_THROW(statement): | |||
1950 | // Tests that the statement throws an exception. | |||
1951 | ||||
1952 | #define EXPECT_THROW(statement, expected_exception)switch (0) case 0: default: if (::testing::internal::ConstCharPtr gtest_msg = "") { bool gtest_caught_expected = false; try { if (::testing::internal::AlwaysTrue()) { statement; }; } catch ( expected_exception const&) { gtest_caught_expected = true ; } catch (...) { gtest_msg.value = "Expected: " "statement" " throws an exception of type " "expected_exception" ".\n Actual: it throws a different type." ; goto gtest_label_testthrow_1952; } if (!gtest_caught_expected ) { gtest_msg.value = "Expected: " "statement" " throws an exception of type " "expected_exception" ".\n Actual: it throws nothing."; goto gtest_label_testthrow_1952; } } else gtest_label_testthrow_1952 : ::testing::internal::AssertHelper(::testing::TestPartResult ::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 1952, gtest_msg.value) = ::testing::Message() \ | |||
1953 | GTEST_TEST_THROW_(statement, expected_exception, GTEST_NONFATAL_FAILURE_)switch (0) case 0: default: if (::testing::internal::ConstCharPtr gtest_msg = "") { bool gtest_caught_expected = false; try { if (::testing::internal::AlwaysTrue()) { statement; }; } catch ( expected_exception const&) { gtest_caught_expected = true ; } catch (...) { gtest_msg.value = "Expected: " "statement" " throws an exception of type " "expected_exception" ".\n Actual: it throws a different type." ; goto gtest_label_testthrow_1953; } if (!gtest_caught_expected ) { gtest_msg.value = "Expected: " "statement" " throws an exception of type " "expected_exception" ".\n Actual: it throws nothing."; goto gtest_label_testthrow_1953; } } else gtest_label_testthrow_1953 : ::testing::internal::AssertHelper(::testing::TestPartResult ::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 1953, gtest_msg.value) = ::testing::Message() | |||
1954 | #define EXPECT_NO_THROW(statement)switch (0) case 0: default: if (::testing::internal::AlwaysTrue ()) { try { if (::testing::internal::AlwaysTrue()) { statement ; }; } catch (...) { goto gtest_label_testnothrow_1954; } } else gtest_label_testnothrow_1954: ::testing::internal::AssertHelper (::testing::TestPartResult::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 1954, "Expected: " "statement" " doesn't throw an exception.\n" " Actual: it throws.") = ::testing::Message() \ | |||
1955 | GTEST_TEST_NO_THROW_(statement, GTEST_NONFATAL_FAILURE_)switch (0) case 0: default: if (::testing::internal::AlwaysTrue ()) { try { if (::testing::internal::AlwaysTrue()) { statement ; }; } catch (...) { goto gtest_label_testnothrow_1955; } } else gtest_label_testnothrow_1955: ::testing::internal::AssertHelper (::testing::TestPartResult::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 1955, "Expected: " "statement" " doesn't throw an exception.\n" " Actual: it throws.") = ::testing::Message() | |||
1956 | #define EXPECT_ANY_THROW(statement)switch (0) case 0: default: if (::testing::internal::AlwaysTrue ()) { bool gtest_caught_any = false; try { if (::testing::internal ::AlwaysTrue()) { statement; }; } catch (...) { gtest_caught_any = true; } if (!gtest_caught_any) { goto gtest_label_testanythrow_1956 ; } } else gtest_label_testanythrow_1956: ::testing::internal ::AssertHelper(::testing::TestPartResult::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 1956, "Expected: " "statement" " throws an exception.\n" " Actual: it doesn't." ) = ::testing::Message() \ | |||
1957 | GTEST_TEST_ANY_THROW_(statement, GTEST_NONFATAL_FAILURE_)switch (0) case 0: default: if (::testing::internal::AlwaysTrue ()) { bool gtest_caught_any = false; try { if (::testing::internal ::AlwaysTrue()) { statement; }; } catch (...) { gtest_caught_any = true; } if (!gtest_caught_any) { goto gtest_label_testanythrow_1957 ; } } else gtest_label_testanythrow_1957: ::testing::internal ::AssertHelper(::testing::TestPartResult::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 1957, "Expected: " "statement" " throws an exception.\n" " Actual: it doesn't." ) = ::testing::Message() | |||
1958 | #define ASSERT_THROW(statement, expected_exception)switch (0) case 0: default: if (::testing::internal::ConstCharPtr gtest_msg = "") { bool gtest_caught_expected = false; try { if (::testing::internal::AlwaysTrue()) { statement; }; } catch ( expected_exception const&) { gtest_caught_expected = true ; } catch (...) { gtest_msg.value = "Expected: " "statement" " throws an exception of type " "expected_exception" ".\n Actual: it throws a different type." ; goto gtest_label_testthrow_1958; } if (!gtest_caught_expected ) { gtest_msg.value = "Expected: " "statement" " throws an exception of type " "expected_exception" ".\n Actual: it throws nothing."; goto gtest_label_testthrow_1958; } } else gtest_label_testthrow_1958 : return ::testing::internal::AssertHelper(::testing::TestPartResult ::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 1958, gtest_msg.value) = ::testing::Message() \ | |||
1959 | GTEST_TEST_THROW_(statement, expected_exception, GTEST_FATAL_FAILURE_)switch (0) case 0: default: if (::testing::internal::ConstCharPtr gtest_msg = "") { bool gtest_caught_expected = false; try { if (::testing::internal::AlwaysTrue()) { statement; }; } catch ( expected_exception const&) { gtest_caught_expected = true ; } catch (...) { gtest_msg.value = "Expected: " "statement" " throws an exception of type " "expected_exception" ".\n Actual: it throws a different type." ; goto gtest_label_testthrow_1959; } if (!gtest_caught_expected ) { gtest_msg.value = "Expected: " "statement" " throws an exception of type " "expected_exception" ".\n Actual: it throws nothing."; goto gtest_label_testthrow_1959; } } else gtest_label_testthrow_1959 : return ::testing::internal::AssertHelper(::testing::TestPartResult ::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 1959, gtest_msg.value) = ::testing::Message() | |||
1960 | #define ASSERT_NO_THROW(statement)switch (0) case 0: default: if (::testing::internal::AlwaysTrue ()) { try { if (::testing::internal::AlwaysTrue()) { statement ; }; } catch (...) { goto gtest_label_testnothrow_1960; } } else gtest_label_testnothrow_1960: return ::testing::internal::AssertHelper (::testing::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 1960, "Expected: " "statement" " doesn't throw an exception.\n" " Actual: it throws.") = ::testing::Message() \ | |||
1961 | GTEST_TEST_NO_THROW_(statement, GTEST_FATAL_FAILURE_)switch (0) case 0: default: if (::testing::internal::AlwaysTrue ()) { try { if (::testing::internal::AlwaysTrue()) { statement ; }; } catch (...) { goto gtest_label_testnothrow_1961; } } else gtest_label_testnothrow_1961: return ::testing::internal::AssertHelper (::testing::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 1961, "Expected: " "statement" " doesn't throw an exception.\n" " Actual: it throws.") = ::testing::Message() | |||
1962 | #define ASSERT_ANY_THROW(statement)switch (0) case 0: default: if (::testing::internal::AlwaysTrue ()) { bool gtest_caught_any = false; try { if (::testing::internal ::AlwaysTrue()) { statement; }; } catch (...) { gtest_caught_any = true; } if (!gtest_caught_any) { goto gtest_label_testanythrow_1962 ; } } else gtest_label_testanythrow_1962: return ::testing::internal ::AssertHelper(::testing::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 1962, "Expected: " "statement" " throws an exception.\n" " Actual: it doesn't." ) = ::testing::Message() \ | |||
1963 | GTEST_TEST_ANY_THROW_(statement, GTEST_FATAL_FAILURE_)switch (0) case 0: default: if (::testing::internal::AlwaysTrue ()) { bool gtest_caught_any = false; try { if (::testing::internal ::AlwaysTrue()) { statement; }; } catch (...) { gtest_caught_any = true; } if (!gtest_caught_any) { goto gtest_label_testanythrow_1963 ; } } else gtest_label_testanythrow_1963: return ::testing::internal ::AssertHelper(::testing::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 1963, "Expected: " "statement" " throws an exception.\n" " Actual: it doesn't." ) = ::testing::Message() | |||
1964 | ||||
1965 | // Boolean assertions. Condition can be either a Boolean expression or an | |||
1966 | // AssertionResult. For more information on how to use AssertionResult with | |||
1967 | // these macros see comments on that class. | |||
1968 | #define EXPECT_TRUE(condition)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar_ = ::testing::AssertionResult(condition)) ; else :: testing::internal::AssertHelper(::testing::TestPartResult::kNonFatalFailure , "/usr/src/googletest/googletest/include/gtest/gtest.h", 1968 , ::testing::internal::GetBoolAssertionFailureMessage( gtest_ar_ , "condition", "false", "true").c_str()) = ::testing::Message () \ | |||
1969 | GTEST_TEST_BOOLEAN_(condition, #condition, false, true, \switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar_ = ::testing::AssertionResult(condition)) ; else :: testing::internal::AssertHelper(::testing::TestPartResult::kNonFatalFailure , "/usr/src/googletest/googletest/include/gtest/gtest.h", 1970 , ::testing::internal::GetBoolAssertionFailureMessage( gtest_ar_ , #condition, "false", "true").c_str()) = ::testing::Message( ) | |||
1970 | GTEST_NONFATAL_FAILURE_)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar_ = ::testing::AssertionResult(condition)) ; else :: testing::internal::AssertHelper(::testing::TestPartResult::kNonFatalFailure , "/usr/src/googletest/googletest/include/gtest/gtest.h", 1970 , ::testing::internal::GetBoolAssertionFailureMessage( gtest_ar_ , #condition, "false", "true").c_str()) = ::testing::Message( ) | |||
1971 | #define EXPECT_FALSE(condition)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar_ = ::testing::AssertionResult(!(condition))) ; else ::testing::internal::AssertHelper(::testing::TestPartResult:: kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 1971, ::testing::internal::GetBoolAssertionFailureMessage( gtest_ar_ , "condition", "true", "false").c_str()) = ::testing::Message () \ | |||
1972 | GTEST_TEST_BOOLEAN_(!(condition), #condition, true, false, \switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar_ = ::testing::AssertionResult(!(condition))) ; else ::testing::internal::AssertHelper(::testing::TestPartResult:: kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 1973, ::testing::internal::GetBoolAssertionFailureMessage( gtest_ar_ , #condition, "true", "false").c_str()) = ::testing::Message( ) | |||
1973 | GTEST_NONFATAL_FAILURE_)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar_ = ::testing::AssertionResult(!(condition))) ; else ::testing::internal::AssertHelper(::testing::TestPartResult:: kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 1973, ::testing::internal::GetBoolAssertionFailureMessage( gtest_ar_ , #condition, "true", "false").c_str()) = ::testing::Message( ) | |||
1974 | #define ASSERT_TRUE(condition)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar_ = ::testing::AssertionResult(condition)) ; else return ::testing::internal::AssertHelper(::testing::TestPartResult:: kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 1974, ::testing::internal::GetBoolAssertionFailureMessage( gtest_ar_ , "condition", "false", "true").c_str()) = ::testing::Message () \ | |||
1975 | GTEST_TEST_BOOLEAN_(condition, #condition, false, true, \switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar_ = ::testing::AssertionResult(condition)) ; else return ::testing::internal::AssertHelper(::testing::TestPartResult:: kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 1976, ::testing::internal::GetBoolAssertionFailureMessage( gtest_ar_ , #condition, "false", "true").c_str()) = ::testing::Message( ) | |||
1976 | GTEST_FATAL_FAILURE_)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar_ = ::testing::AssertionResult(condition)) ; else return ::testing::internal::AssertHelper(::testing::TestPartResult:: kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 1976, ::testing::internal::GetBoolAssertionFailureMessage( gtest_ar_ , #condition, "false", "true").c_str()) = ::testing::Message( ) | |||
1977 | #define ASSERT_FALSE(condition)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar_ = ::testing::AssertionResult(!(condition))) ; else return ::testing::internal::AssertHelper(::testing::TestPartResult ::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 1977, ::testing::internal::GetBoolAssertionFailureMessage( gtest_ar_ , "condition", "true", "false").c_str()) = ::testing::Message () \ | |||
1978 | GTEST_TEST_BOOLEAN_(!(condition), #condition, true, false, \switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar_ = ::testing::AssertionResult(!(condition))) ; else return ::testing::internal::AssertHelper(::testing::TestPartResult ::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 1979, ::testing::internal::GetBoolAssertionFailureMessage( gtest_ar_ , #condition, "true", "false").c_str()) = ::testing::Message( ) | |||
1979 | GTEST_FATAL_FAILURE_)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar_ = ::testing::AssertionResult(!(condition))) ; else return ::testing::internal::AssertHelper(::testing::TestPartResult ::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 1979, ::testing::internal::GetBoolAssertionFailureMessage( gtest_ar_ , #condition, "true", "false").c_str()) = ::testing::Message( ) | |||
1980 | ||||
1981 | // Macros for testing equalities and inequalities. | |||
1982 | // | |||
1983 | // * {ASSERT|EXPECT}_EQ(v1, v2): Tests that v1 == v2 | |||
1984 | // * {ASSERT|EXPECT}_NE(v1, v2): Tests that v1 != v2 | |||
1985 | // * {ASSERT|EXPECT}_LT(v1, v2): Tests that v1 < v2 | |||
1986 | // * {ASSERT|EXPECT}_LE(v1, v2): Tests that v1 <= v2 | |||
1987 | // * {ASSERT|EXPECT}_GT(v1, v2): Tests that v1 > v2 | |||
1988 | // * {ASSERT|EXPECT}_GE(v1, v2): Tests that v1 >= v2 | |||
1989 | // | |||
1990 | // When they are not, Google Test prints both the tested expressions and | |||
1991 | // their actual values. The values must be compatible built-in types, | |||
1992 | // or you will get a compiler error. By "compatible" we mean that the | |||
1993 | // values can be compared by the respective operator. | |||
1994 | // | |||
1995 | // Note: | |||
1996 | // | |||
1997 | // 1. It is possible to make a user-defined type work with | |||
1998 | // {ASSERT|EXPECT}_??(), but that requires overloading the | |||
1999 | // comparison operators and is thus discouraged by the Google C++ | |||
2000 | // Usage Guide. Therefore, you are advised to use the | |||
2001 | // {ASSERT|EXPECT}_TRUE() macro to assert that two objects are | |||
2002 | // equal. | |||
2003 | // | |||
2004 | // 2. The {ASSERT|EXPECT}_??() macros do pointer comparisons on | |||
2005 | // pointers (in particular, C strings). Therefore, if you use it | |||
2006 | // with two C strings, you are testing how their locations in memory | |||
2007 | // are related, not how their content is related. To compare two C | |||
2008 | // strings by content, use {ASSERT|EXPECT}_STR*(). | |||
2009 | // | |||
2010 | // 3. {ASSERT|EXPECT}_EQ(v1, v2) is preferred to | |||
2011 | // {ASSERT|EXPECT}_TRUE(v1 == v2), as the former tells you | |||
2012 | // what the actual value is when it fails, and similarly for the | |||
2013 | // other comparisons. | |||
2014 | // | |||
2015 | // 4. Do not depend on the order in which {ASSERT|EXPECT}_??() | |||
2016 | // evaluate their arguments, which is undefined. | |||
2017 | // | |||
2018 | // 5. These macros evaluate their arguments exactly once. | |||
2019 | // | |||
2020 | // Examples: | |||
2021 | // | |||
2022 | // EXPECT_NE(Foo(), 5); | |||
2023 | // EXPECT_EQ(a_pointer, NULL); | |||
2024 | // ASSERT_LT(i, array_size); | |||
2025 | // ASSERT_GT(records.size(), 0) << "There is no record left."; | |||
2026 | ||||
2027 | #define EXPECT_EQ(val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::EqHelper::Compare("val1", "val2" , val1, val2))) ; else ::testing::internal::AssertHelper(::testing ::TestPartResult::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2027, gtest_ar.failure_message()) = ::testing::Message() \ | |||
2028 | EXPECT_PRED_FORMAT2(::testing::internal::EqHelper::Compare, val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::EqHelper::Compare("val1", "val2" , val1, val2))) ; else ::testing::internal::AssertHelper(::testing ::TestPartResult::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2028, gtest_ar.failure_message()) = ::testing::Message() | |||
2029 | #define EXPECT_NE(val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperNE("val1", "val2", val1, val2))) ; else ::testing::internal::AssertHelper(::testing ::TestPartResult::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2029, gtest_ar.failure_message()) = ::testing::Message() \ | |||
2030 | EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperNE, val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperNE("val1", "val2", val1, val2))) ; else ::testing::internal::AssertHelper(::testing ::TestPartResult::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2030, gtest_ar.failure_message()) = ::testing::Message() | |||
2031 | #define EXPECT_LE(val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperLE("val1", "val2", val1, val2))) ; else ::testing::internal::AssertHelper(::testing ::TestPartResult::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2031, gtest_ar.failure_message()) = ::testing::Message() \ | |||
2032 | EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperLE, val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperLE("val1", "val2", val1, val2))) ; else ::testing::internal::AssertHelper(::testing ::TestPartResult::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2032, gtest_ar.failure_message()) = ::testing::Message() | |||
2033 | #define EXPECT_LT(val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperLT("val1", "val2", val1, val2))) ; else ::testing::internal::AssertHelper(::testing ::TestPartResult::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2033, gtest_ar.failure_message()) = ::testing::Message() \ | |||
2034 | EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperLT, val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperLT("val1", "val2", val1, val2))) ; else ::testing::internal::AssertHelper(::testing ::TestPartResult::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2034, gtest_ar.failure_message()) = ::testing::Message() | |||
2035 | #define EXPECT_GE(val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperGE("val1", "val2", val1, val2))) ; else ::testing::internal::AssertHelper(::testing ::TestPartResult::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2035, gtest_ar.failure_message()) = ::testing::Message() \ | |||
2036 | EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperGE, val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperGE("val1", "val2", val1, val2))) ; else ::testing::internal::AssertHelper(::testing ::TestPartResult::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2036, gtest_ar.failure_message()) = ::testing::Message() | |||
2037 | #define EXPECT_GT(val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperGT("val1", "val2", val1, val2))) ; else ::testing::internal::AssertHelper(::testing ::TestPartResult::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2037, gtest_ar.failure_message()) = ::testing::Message() \ | |||
2038 | EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperGT, val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperGT("val1", "val2", val1, val2))) ; else ::testing::internal::AssertHelper(::testing ::TestPartResult::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2038, gtest_ar.failure_message()) = ::testing::Message() | |||
2039 | ||||
2040 | #define GTEST_ASSERT_EQ(val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::EqHelper::Compare("val1", "val2" , val1, val2))) ; else return ::testing::internal::AssertHelper (::testing::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2040, gtest_ar.failure_message()) = ::testing::Message() \ | |||
2041 | ASSERT_PRED_FORMAT2(::testing::internal::EqHelper::Compare, val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::EqHelper::Compare("val1", "val2" , val1, val2))) ; else return ::testing::internal::AssertHelper (::testing::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2041, gtest_ar.failure_message()) = ::testing::Message() | |||
2042 | #define GTEST_ASSERT_NE(val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperNE("val1", "val2", val1, val2))) ; else return ::testing::internal::AssertHelper (::testing::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2042, gtest_ar.failure_message()) = ::testing::Message() \ | |||
2043 | ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperNE, val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperNE("val1", "val2", val1, val2))) ; else return ::testing::internal::AssertHelper (::testing::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2043, gtest_ar.failure_message()) = ::testing::Message() | |||
2044 | #define GTEST_ASSERT_LE(val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperLE("val1", "val2", val1, val2))) ; else return ::testing::internal::AssertHelper (::testing::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2044, gtest_ar.failure_message()) = ::testing::Message() \ | |||
2045 | ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperLE, val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperLE("val1", "val2", val1, val2))) ; else return ::testing::internal::AssertHelper (::testing::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2045, gtest_ar.failure_message()) = ::testing::Message() | |||
2046 | #define GTEST_ASSERT_LT(val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperLT("val1", "val2", val1, val2))) ; else return ::testing::internal::AssertHelper (::testing::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2046, gtest_ar.failure_message()) = ::testing::Message() \ | |||
2047 | ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperLT, val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperLT("val1", "val2", val1, val2))) ; else return ::testing::internal::AssertHelper (::testing::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2047, gtest_ar.failure_message()) = ::testing::Message() | |||
2048 | #define GTEST_ASSERT_GE(val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperGE("val1", "val2", val1, val2))) ; else return ::testing::internal::AssertHelper (::testing::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2048, gtest_ar.failure_message()) = ::testing::Message() \ | |||
2049 | ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperGE, val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperGE("val1", "val2", val1, val2))) ; else return ::testing::internal::AssertHelper (::testing::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2049, gtest_ar.failure_message()) = ::testing::Message() | |||
2050 | #define GTEST_ASSERT_GT(val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperGT("val1", "val2", val1, val2))) ; else return ::testing::internal::AssertHelper (::testing::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2050, gtest_ar.failure_message()) = ::testing::Message() \ | |||
2051 | ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperGT, val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperGT("val1", "val2", val1, val2))) ; else return ::testing::internal::AssertHelper (::testing::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2051, gtest_ar.failure_message()) = ::testing::Message() | |||
2052 | ||||
2053 | // Define macro GTEST_DONT_DEFINE_ASSERT_XY to 1 to omit the definition of | |||
2054 | // ASSERT_XY(), which clashes with some users' own code. | |||
2055 | ||||
2056 | #if !GTEST_DONT_DEFINE_ASSERT_EQ | |||
2057 | # define ASSERT_EQ(val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::EqHelper::Compare("val1", "val2" , val1, val2))) ; else return ::testing::internal::AssertHelper (::testing::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2057, gtest_ar.failure_message()) = ::testing::Message() GTEST_ASSERT_EQ(val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::EqHelper::Compare("val1", "val2" , val1, val2))) ; else return ::testing::internal::AssertHelper (::testing::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2057, gtest_ar.failure_message()) = ::testing::Message() | |||
2058 | #endif | |||
2059 | ||||
2060 | #if !GTEST_DONT_DEFINE_ASSERT_NE | |||
2061 | # define ASSERT_NE(val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperNE("val1", "val2", val1, val2))) ; else return ::testing::internal::AssertHelper (::testing::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2061, gtest_ar.failure_message()) = ::testing::Message() GTEST_ASSERT_NE(val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperNE("val1", "val2", val1, val2))) ; else return ::testing::internal::AssertHelper (::testing::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2061, gtest_ar.failure_message()) = ::testing::Message() | |||
2062 | #endif | |||
2063 | ||||
2064 | #if !GTEST_DONT_DEFINE_ASSERT_LE | |||
2065 | # define ASSERT_LE(val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperLE("val1", "val2", val1, val2))) ; else return ::testing::internal::AssertHelper (::testing::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2065, gtest_ar.failure_message()) = ::testing::Message() GTEST_ASSERT_LE(val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperLE("val1", "val2", val1, val2))) ; else return ::testing::internal::AssertHelper (::testing::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2065, gtest_ar.failure_message()) = ::testing::Message() | |||
2066 | #endif | |||
2067 | ||||
2068 | #if !GTEST_DONT_DEFINE_ASSERT_LT | |||
2069 | # define ASSERT_LT(val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperLT("val1", "val2", val1, val2))) ; else return ::testing::internal::AssertHelper (::testing::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2069, gtest_ar.failure_message()) = ::testing::Message() GTEST_ASSERT_LT(val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperLT("val1", "val2", val1, val2))) ; else return ::testing::internal::AssertHelper (::testing::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2069, gtest_ar.failure_message()) = ::testing::Message() | |||
2070 | #endif | |||
2071 | ||||
2072 | #if !GTEST_DONT_DEFINE_ASSERT_GE | |||
2073 | # define ASSERT_GE(val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperGE("val1", "val2", val1, val2))) ; else return ::testing::internal::AssertHelper (::testing::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2073, gtest_ar.failure_message()) = ::testing::Message() GTEST_ASSERT_GE(val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperGE("val1", "val2", val1, val2))) ; else return ::testing::internal::AssertHelper (::testing::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2073, gtest_ar.failure_message()) = ::testing::Message() | |||
2074 | #endif | |||
2075 | ||||
2076 | #if !GTEST_DONT_DEFINE_ASSERT_GT | |||
2077 | # define ASSERT_GT(val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperGT("val1", "val2", val1, val2))) ; else return ::testing::internal::AssertHelper (::testing::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2077, gtest_ar.failure_message()) = ::testing::Message() GTEST_ASSERT_GT(val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperGT("val1", "val2", val1, val2))) ; else return ::testing::internal::AssertHelper (::testing::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2077, gtest_ar.failure_message()) = ::testing::Message() | |||
2078 | #endif | |||
2079 | ||||
2080 | // C-string Comparisons. All tests treat NULL and any non-NULL string | |||
2081 | // as different. Two NULLs are equal. | |||
2082 | // | |||
2083 | // * {ASSERT|EXPECT}_STREQ(s1, s2): Tests that s1 == s2 | |||
2084 | // * {ASSERT|EXPECT}_STRNE(s1, s2): Tests that s1 != s2 | |||
2085 | // * {ASSERT|EXPECT}_STRCASEEQ(s1, s2): Tests that s1 == s2, ignoring case | |||
2086 | // * {ASSERT|EXPECT}_STRCASENE(s1, s2): Tests that s1 != s2, ignoring case | |||
2087 | // | |||
2088 | // For wide or narrow string objects, you can use the | |||
2089 | // {ASSERT|EXPECT}_??() macros. | |||
2090 | // | |||
2091 | // Don't depend on the order in which the arguments are evaluated, | |||
2092 | // which is undefined. | |||
2093 | // | |||
2094 | // These macros evaluate their arguments exactly once. | |||
2095 | ||||
2096 | #define EXPECT_STREQ(s1, s2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperSTREQ("s1", "s2", s1 , s2))) ; else ::testing::internal::AssertHelper(::testing::TestPartResult ::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2096, gtest_ar.failure_message()) = ::testing::Message() \ | |||
2097 | EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperSTREQ, s1, s2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperSTREQ("s1", "s2", s1 , s2))) ; else ::testing::internal::AssertHelper(::testing::TestPartResult ::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2097, gtest_ar.failure_message()) = ::testing::Message() | |||
2098 | #define EXPECT_STRNE(s1, s2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperSTRNE("s1", "s2", s1 , s2))) ; else ::testing::internal::AssertHelper(::testing::TestPartResult ::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2098, gtest_ar.failure_message()) = ::testing::Message() \ | |||
2099 | EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperSTRNE, s1, s2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperSTRNE("s1", "s2", s1 , s2))) ; else ::testing::internal::AssertHelper(::testing::TestPartResult ::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2099, gtest_ar.failure_message()) = ::testing::Message() | |||
2100 | #define EXPECT_STRCASEEQ(s1, s2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperSTRCASEEQ("s1", "s2" , s1, s2))) ; else ::testing::internal::AssertHelper(::testing ::TestPartResult::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2100, gtest_ar.failure_message()) = ::testing::Message() \ | |||
2101 | EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperSTRCASEEQ, s1, s2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperSTRCASEEQ("s1", "s2" , s1, s2))) ; else ::testing::internal::AssertHelper(::testing ::TestPartResult::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2101, gtest_ar.failure_message()) = ::testing::Message() | |||
2102 | #define EXPECT_STRCASENE(s1, s2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperSTRCASENE("s1", "s2" , s1, s2))) ; else ::testing::internal::AssertHelper(::testing ::TestPartResult::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2102, gtest_ar.failure_message()) = ::testing::Message()\ | |||
2103 | EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperSTRCASENE, s1, s2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperSTRCASENE("s1", "s2" , s1, s2))) ; else ::testing::internal::AssertHelper(::testing ::TestPartResult::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2103, gtest_ar.failure_message()) = ::testing::Message() | |||
2104 | ||||
2105 | #define ASSERT_STREQ(s1, s2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperSTREQ("s1", "s2", s1 , s2))) ; else return ::testing::internal::AssertHelper(::testing ::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2105, gtest_ar.failure_message()) = ::testing::Message() \ | |||
2106 | ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperSTREQ, s1, s2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperSTREQ("s1", "s2", s1 , s2))) ; else return ::testing::internal::AssertHelper(::testing ::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2106, gtest_ar.failure_message()) = ::testing::Message() | |||
2107 | #define ASSERT_STRNE(s1, s2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperSTRNE("s1", "s2", s1 , s2))) ; else return ::testing::internal::AssertHelper(::testing ::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2107, gtest_ar.failure_message()) = ::testing::Message() \ | |||
2108 | ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperSTRNE, s1, s2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperSTRNE("s1", "s2", s1 , s2))) ; else return ::testing::internal::AssertHelper(::testing ::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2108, gtest_ar.failure_message()) = ::testing::Message() | |||
2109 | #define ASSERT_STRCASEEQ(s1, s2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperSTRCASEEQ("s1", "s2" , s1, s2))) ; else return ::testing::internal::AssertHelper(:: testing::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2109, gtest_ar.failure_message()) = ::testing::Message() \ | |||
2110 | ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperSTRCASEEQ, s1, s2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperSTRCASEEQ("s1", "s2" , s1, s2))) ; else return ::testing::internal::AssertHelper(:: testing::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2110, gtest_ar.failure_message()) = ::testing::Message() | |||
2111 | #define ASSERT_STRCASENE(s1, s2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperSTRCASENE("s1", "s2" , s1, s2))) ; else return ::testing::internal::AssertHelper(:: testing::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2111, gtest_ar.failure_message()) = ::testing::Message()\ | |||
2112 | ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperSTRCASENE, s1, s2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperSTRCASENE("s1", "s2" , s1, s2))) ; else return ::testing::internal::AssertHelper(:: testing::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2112, gtest_ar.failure_message()) = ::testing::Message() | |||
2113 | ||||
2114 | // Macros for comparing floating-point numbers. | |||
2115 | // | |||
2116 | // * {ASSERT|EXPECT}_FLOAT_EQ(val1, val2): | |||
2117 | // Tests that two float values are almost equal. | |||
2118 | // * {ASSERT|EXPECT}_DOUBLE_EQ(val1, val2): | |||
2119 | // Tests that two double values are almost equal. | |||
2120 | // * {ASSERT|EXPECT}_NEAR(v1, v2, abs_error): | |||
2121 | // Tests that v1 and v2 are within the given distance to each other. | |||
2122 | // | |||
2123 | // Google Test uses ULP-based comparison to automatically pick a default | |||
2124 | // error bound that is appropriate for the operands. See the | |||
2125 | // FloatingPoint template class in gtest-internal.h if you are | |||
2126 | // interested in the implementation details. | |||
2127 | ||||
2128 | #define EXPECT_FLOAT_EQ(val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperFloatingPointEQ< float>("val1", "val2", val1, val2))) ; else ::testing::internal ::AssertHelper(::testing::TestPartResult::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2128, gtest_ar.failure_message()) = ::testing::Message()\ | |||
2129 | EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperFloatingPointEQ<float>, \switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperFloatingPointEQ< float>("val1", "val2", val1, val2))) ; else ::testing::internal ::AssertHelper(::testing::TestPartResult::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2130, gtest_ar.failure_message()) = ::testing::Message() | |||
2130 | val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperFloatingPointEQ< float>("val1", "val2", val1, val2))) ; else ::testing::internal ::AssertHelper(::testing::TestPartResult::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2130, gtest_ar.failure_message()) = ::testing::Message() | |||
2131 | ||||
2132 | #define EXPECT_DOUBLE_EQ(val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperFloatingPointEQ< double>("val1", "val2", val1, val2))) ; else ::testing::internal ::AssertHelper(::testing::TestPartResult::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2132, gtest_ar.failure_message()) = ::testing::Message()\ | |||
2133 | EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperFloatingPointEQ<double>, \switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperFloatingPointEQ< double>("val1", "val2", val1, val2))) ; else ::testing::internal ::AssertHelper(::testing::TestPartResult::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2134, gtest_ar.failure_message()) = ::testing::Message() | |||
2134 | val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperFloatingPointEQ< double>("val1", "val2", val1, val2))) ; else ::testing::internal ::AssertHelper(::testing::TestPartResult::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2134, gtest_ar.failure_message()) = ::testing::Message() | |||
2135 | ||||
2136 | #define ASSERT_FLOAT_EQ(val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperFloatingPointEQ< float>("val1", "val2", val1, val2))) ; else return ::testing ::internal::AssertHelper(::testing::TestPartResult::kFatalFailure , "/usr/src/googletest/googletest/include/gtest/gtest.h", 2136 , gtest_ar.failure_message()) = ::testing::Message()\ | |||
2137 | ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperFloatingPointEQ<float>, \switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperFloatingPointEQ< float>("val1", "val2", val1, val2))) ; else return ::testing ::internal::AssertHelper(::testing::TestPartResult::kFatalFailure , "/usr/src/googletest/googletest/include/gtest/gtest.h", 2138 , gtest_ar.failure_message()) = ::testing::Message() | |||
2138 | val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperFloatingPointEQ< float>("val1", "val2", val1, val2))) ; else return ::testing ::internal::AssertHelper(::testing::TestPartResult::kFatalFailure , "/usr/src/googletest/googletest/include/gtest/gtest.h", 2138 , gtest_ar.failure_message()) = ::testing::Message() | |||
2139 | ||||
2140 | #define ASSERT_DOUBLE_EQ(val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperFloatingPointEQ< double>("val1", "val2", val1, val2))) ; else return ::testing ::internal::AssertHelper(::testing::TestPartResult::kFatalFailure , "/usr/src/googletest/googletest/include/gtest/gtest.h", 2140 , gtest_ar.failure_message()) = ::testing::Message()\ | |||
2141 | ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperFloatingPointEQ<double>, \switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperFloatingPointEQ< double>("val1", "val2", val1, val2))) ; else return ::testing ::internal::AssertHelper(::testing::TestPartResult::kFatalFailure , "/usr/src/googletest/googletest/include/gtest/gtest.h", 2142 , gtest_ar.failure_message()) = ::testing::Message() | |||
2142 | val1, val2)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::CmpHelperFloatingPointEQ< double>("val1", "val2", val1, val2))) ; else return ::testing ::internal::AssertHelper(::testing::TestPartResult::kFatalFailure , "/usr/src/googletest/googletest/include/gtest/gtest.h", 2142 , gtest_ar.failure_message()) = ::testing::Message() | |||
2143 | ||||
2144 | #define EXPECT_NEAR(val1, val2, abs_error)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::DoubleNearPredFormat("val1" , "val2", "abs_error", val1, val2, abs_error))) ; else ::testing ::internal::AssertHelper(::testing::TestPartResult::kNonFatalFailure , "/usr/src/googletest/googletest/include/gtest/gtest.h", 2144 , gtest_ar.failure_message()) = ::testing::Message()\ | |||
2145 | EXPECT_PRED_FORMAT3(::testing::internal::DoubleNearPredFormat, \switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::DoubleNearPredFormat("val1" , "val2", "abs_error", val1, val2, abs_error))) ; else ::testing ::internal::AssertHelper(::testing::TestPartResult::kNonFatalFailure , "/usr/src/googletest/googletest/include/gtest/gtest.h", 2146 , gtest_ar.failure_message()) = ::testing::Message() | |||
2146 | val1, val2, abs_error)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::DoubleNearPredFormat("val1" , "val2", "abs_error", val1, val2, abs_error))) ; else ::testing ::internal::AssertHelper(::testing::TestPartResult::kNonFatalFailure , "/usr/src/googletest/googletest/include/gtest/gtest.h", 2146 , gtest_ar.failure_message()) = ::testing::Message() | |||
2147 | ||||
2148 | #define ASSERT_NEAR(val1, val2, abs_error)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::DoubleNearPredFormat("val1" , "val2", "abs_error", val1, val2, abs_error))) ; else return ::testing::internal::AssertHelper(::testing::TestPartResult:: kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2148, gtest_ar.failure_message()) = ::testing::Message()\ | |||
2149 | ASSERT_PRED_FORMAT3(::testing::internal::DoubleNearPredFormat, \switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::DoubleNearPredFormat("val1" , "val2", "abs_error", val1, val2, abs_error))) ; else return ::testing::internal::AssertHelper(::testing::TestPartResult:: kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2150, gtest_ar.failure_message()) = ::testing::Message() | |||
2150 | val1, val2, abs_error)switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::DoubleNearPredFormat("val1" , "val2", "abs_error", val1, val2, abs_error))) ; else return ::testing::internal::AssertHelper(::testing::TestPartResult:: kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2150, gtest_ar.failure_message()) = ::testing::Message() | |||
2151 | ||||
2152 | // These predicate format functions work on floating-point values, and | |||
2153 | // can be used in {ASSERT|EXPECT}_PRED_FORMAT2*(), e.g. | |||
2154 | // | |||
2155 | // EXPECT_PRED_FORMAT2(testing::DoubleLE, Foo(), 5.0); | |||
2156 | ||||
2157 | // Asserts that val1 is less than, or almost equal to, val2. Fails | |||
2158 | // otherwise. In particular, it fails if either val1 or val2 is NaN. | |||
2159 | GTEST_API___attribute__((visibility ("default"))) AssertionResult FloatLE(const char* expr1, const char* expr2, | |||
2160 | float val1, float val2); | |||
2161 | GTEST_API___attribute__((visibility ("default"))) AssertionResult DoubleLE(const char* expr1, const char* expr2, | |||
2162 | double val1, double val2); | |||
2163 | ||||
2164 | ||||
2165 | #if GTEST_OS_WINDOWS | |||
2166 | ||||
2167 | // Macros that test for HRESULT failure and success, these are only useful | |||
2168 | // on Windows, and rely on Windows SDK macros and APIs to compile. | |||
2169 | // | |||
2170 | // * {ASSERT|EXPECT}_HRESULT_{SUCCEEDED|FAILED}(expr) | |||
2171 | // | |||
2172 | // When expr unexpectedly fails or succeeds, Google Test prints the | |||
2173 | // expected result and the actual result with both a human-readable | |||
2174 | // string representation of the error, if available, as well as the | |||
2175 | // hex result code. | |||
2176 | # define EXPECT_HRESULT_SUCCEEDED(expr) \ | |||
2177 | EXPECT_PRED_FORMAT1(::testing::internal::IsHRESULTSuccess, (expr))switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::IsHRESULTSuccess("(expr)", ( expr)))) ; else ::testing::internal::AssertHelper(::testing:: TestPartResult::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2177, gtest_ar.failure_message()) = ::testing::Message() | |||
2178 | ||||
2179 | # define ASSERT_HRESULT_SUCCEEDED(expr) \ | |||
2180 | ASSERT_PRED_FORMAT1(::testing::internal::IsHRESULTSuccess, (expr))switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::IsHRESULTSuccess("(expr)", ( expr)))) ; else return ::testing::internal::AssertHelper(::testing ::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2180, gtest_ar.failure_message()) = ::testing::Message() | |||
2181 | ||||
2182 | # define EXPECT_HRESULT_FAILED(expr) \ | |||
2183 | EXPECT_PRED_FORMAT1(::testing::internal::IsHRESULTFailure, (expr))switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::IsHRESULTFailure("(expr)", ( expr)))) ; else ::testing::internal::AssertHelper(::testing:: TestPartResult::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2183, gtest_ar.failure_message()) = ::testing::Message() | |||
2184 | ||||
2185 | # define ASSERT_HRESULT_FAILED(expr) \ | |||
2186 | ASSERT_PRED_FORMAT1(::testing::internal::IsHRESULTFailure, (expr))switch (0) case 0: default: if (const ::testing::AssertionResult gtest_ar = (::testing::internal::IsHRESULTFailure("(expr)", ( expr)))) ; else return ::testing::internal::AssertHelper(::testing ::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2186, gtest_ar.failure_message()) = ::testing::Message() | |||
2187 | ||||
2188 | #endif // GTEST_OS_WINDOWS | |||
2189 | ||||
2190 | // Macros that execute statement and check that it doesn't generate new fatal | |||
2191 | // failures in the current thread. | |||
2192 | // | |||
2193 | // * {ASSERT|EXPECT}_NO_FATAL_FAILURE(statement); | |||
2194 | // | |||
2195 | // Examples: | |||
2196 | // | |||
2197 | // EXPECT_NO_FATAL_FAILURE(Process()); | |||
2198 | // ASSERT_NO_FATAL_FAILURE(Process()) << "Process() failed"; | |||
2199 | // | |||
2200 | #define ASSERT_NO_FATAL_FAILURE(statement)switch (0) case 0: default: if (::testing::internal::AlwaysTrue ()) { ::testing::internal::HasNewFatalFailureHelper gtest_fatal_failure_checker ; if (::testing::internal::AlwaysTrue()) { statement; }; if ( gtest_fatal_failure_checker.has_new_fatal_failure()) { goto gtest_label_testnofatal_2200 ; } } else gtest_label_testnofatal_2200: return ::testing::internal ::AssertHelper(::testing::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2200, "Expected: " "statement" " doesn't generate new fatal " "failures in the current thread.\n" " Actual: it does.") = :: testing::Message() \ | |||
2201 | GTEST_TEST_NO_FATAL_FAILURE_(statement, GTEST_FATAL_FAILURE_)switch (0) case 0: default: if (::testing::internal::AlwaysTrue ()) { ::testing::internal::HasNewFatalFailureHelper gtest_fatal_failure_checker ; if (::testing::internal::AlwaysTrue()) { statement; }; if ( gtest_fatal_failure_checker.has_new_fatal_failure()) { goto gtest_label_testnofatal_2201 ; } } else gtest_label_testnofatal_2201: return ::testing::internal ::AssertHelper(::testing::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2201, "Expected: " "statement" " doesn't generate new fatal " "failures in the current thread.\n" " Actual: it does.") = :: testing::Message() | |||
2202 | #define EXPECT_NO_FATAL_FAILURE(statement)switch (0) case 0: default: if (::testing::internal::AlwaysTrue ()) { ::testing::internal::HasNewFatalFailureHelper gtest_fatal_failure_checker ; if (::testing::internal::AlwaysTrue()) { statement; }; if ( gtest_fatal_failure_checker.has_new_fatal_failure()) { goto gtest_label_testnofatal_2202 ; } } else gtest_label_testnofatal_2202: ::testing::internal:: AssertHelper(::testing::TestPartResult::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2202, "Expected: " "statement" " doesn't generate new fatal " "failures in the current thread.\n" " Actual: it does.") = :: testing::Message() \ | |||
2203 | GTEST_TEST_NO_FATAL_FAILURE_(statement, GTEST_NONFATAL_FAILURE_)switch (0) case 0: default: if (::testing::internal::AlwaysTrue ()) { ::testing::internal::HasNewFatalFailureHelper gtest_fatal_failure_checker ; if (::testing::internal::AlwaysTrue()) { statement; }; if ( gtest_fatal_failure_checker.has_new_fatal_failure()) { goto gtest_label_testnofatal_2203 ; } } else gtest_label_testnofatal_2203: ::testing::internal:: AssertHelper(::testing::TestPartResult::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2203, "Expected: " "statement" " doesn't generate new fatal " "failures in the current thread.\n" " Actual: it does.") = :: testing::Message() | |||
2204 | ||||
2205 | // Causes a trace (including the given source file path and line number, | |||
2206 | // and the given message) to be included in every test failure message generated | |||
2207 | // by code in the scope of the lifetime of an instance of this class. The effect | |||
2208 | // is undone with the destruction of the instance. | |||
2209 | // | |||
2210 | // The message argument can be anything streamable to std::ostream. | |||
2211 | // | |||
2212 | // Example: | |||
2213 | // testing::ScopedTrace trace("file.cc", 123, "message"); | |||
2214 | // | |||
2215 | class GTEST_API___attribute__((visibility ("default"))) ScopedTrace { | |||
2216 | public: | |||
2217 | // The c'tor pushes the given source file location and message onto | |||
2218 | // a trace stack maintained by Google Test. | |||
2219 | ||||
2220 | // Template version. Uses Message() to convert the values into strings. | |||
2221 | // Slow, but flexible. | |||
2222 | template <typename T> | |||
2223 | ScopedTrace(const char* file, int line, const T& message) { | |||
2224 | PushTrace(file, line, (Message() << message).GetString()); | |||
2225 | } | |||
2226 | ||||
2227 | // Optimize for some known types. | |||
2228 | ScopedTrace(const char* file, int line, const char* message) { | |||
2229 | PushTrace(file, line, message ? message : "(null)"); | |||
2230 | } | |||
2231 | ||||
2232 | ScopedTrace(const char* file, int line, const std::string& message) { | |||
2233 | PushTrace(file, line, message); | |||
2234 | } | |||
2235 | ||||
2236 | // The d'tor pops the info pushed by the c'tor. | |||
2237 | // | |||
2238 | // Note that the d'tor is not virtual in order to be efficient. | |||
2239 | // Don't inherit from ScopedTrace! | |||
2240 | ~ScopedTrace(); | |||
2241 | ||||
2242 | private: | |||
2243 | void PushTrace(const char* file, int line, std::string message); | |||
2244 | ||||
2245 | GTEST_DISALLOW_COPY_AND_ASSIGN_(ScopedTrace)ScopedTrace(ScopedTrace const &) = delete; void operator= (ScopedTrace const &) = delete; | |||
2246 | } GTEST_ATTRIBUTE_UNUSED___attribute__ ((unused)); // A ScopedTrace object does its job in its | |||
2247 | // c'tor and d'tor. Therefore it doesn't | |||
2248 | // need to be used otherwise. | |||
2249 | ||||
2250 | // Causes a trace (including the source file path, the current line | |||
2251 | // number, and the given message) to be included in every test failure | |||
2252 | // message generated by code in the current scope. The effect is | |||
2253 | // undone when the control leaves the current scope. | |||
2254 | // | |||
2255 | // The message argument can be anything streamable to std::ostream. | |||
2256 | // | |||
2257 | // In the implementation, we include the current line number as part | |||
2258 | // of the dummy variable name, thus allowing multiple SCOPED_TRACE()s | |||
2259 | // to appear in the same block - as long as they are on different | |||
2260 | // lines. | |||
2261 | // | |||
2262 | // Assuming that each thread maintains its own stack of traces. | |||
2263 | // Therefore, a SCOPED_TRACE() would (correctly) only affect the | |||
2264 | // assertions in its own thread. | |||
2265 | #define SCOPED_TRACE(message)::testing::ScopedTrace gtest_trace_2265( "/usr/src/googletest/googletest/include/gtest/gtest.h" , 2265, (message)) \ | |||
2266 | ::testing::ScopedTrace GTEST_CONCAT_TOKEN_(gtest_trace_, __LINE__)gtest_trace_2266(\ | |||
2267 | __FILE__"/usr/src/googletest/googletest/include/gtest/gtest.h", __LINE__2267, (message)) | |||
2268 | ||||
2269 | // Compile-time assertion for type equality. | |||
2270 | // StaticAssertTypeEq<type1, type2>() compiles if and only if type1 and type2 | |||
2271 | // are the same type. The value it returns is not interesting. | |||
2272 | // | |||
2273 | // Instead of making StaticAssertTypeEq a class template, we make it a | |||
2274 | // function template that invokes a helper class template. This | |||
2275 | // prevents a user from misusing StaticAssertTypeEq<T1, T2> by | |||
2276 | // defining objects of that type. | |||
2277 | // | |||
2278 | // CAVEAT: | |||
2279 | // | |||
2280 | // When used inside a method of a class template, | |||
2281 | // StaticAssertTypeEq<T1, T2>() is effective ONLY IF the method is | |||
2282 | // instantiated. For example, given: | |||
2283 | // | |||
2284 | // template <typename T> class Foo { | |||
2285 | // public: | |||
2286 | // void Bar() { testing::StaticAssertTypeEq<int, T>(); } | |||
2287 | // }; | |||
2288 | // | |||
2289 | // the code: | |||
2290 | // | |||
2291 | // void Test1() { Foo<bool> foo; } | |||
2292 | // | |||
2293 | // will NOT generate a compiler error, as Foo<bool>::Bar() is never | |||
2294 | // actually instantiated. Instead, you need: | |||
2295 | // | |||
2296 | // void Test2() { Foo<bool> foo; foo.Bar(); } | |||
2297 | // | |||
2298 | // to cause a compiler error. | |||
2299 | template <typename T1, typename T2> | |||
2300 | constexpr bool StaticAssertTypeEq() noexcept { | |||
2301 | static_assert(std::is_same<T1, T2>::value, | |||
2302 | "type1 and type2 are not the same type"); | |||
2303 | return true; | |||
2304 | } | |||
2305 | ||||
2306 | // Defines a test. | |||
2307 | // | |||
2308 | // The first parameter is the name of the test suite, and the second | |||
2309 | // parameter is the name of the test within the test suite. | |||
2310 | // | |||
2311 | // The convention is to end the test suite name with "Test". For | |||
2312 | // example, a test suite for the Foo class can be named FooTest. | |||
2313 | // | |||
2314 | // Test code should appear between braces after an invocation of | |||
2315 | // this macro. Example: | |||
2316 | // | |||
2317 | // TEST(FooTest, InitializesCorrectly) { | |||
2318 | // Foo foo; | |||
2319 | // EXPECT_TRUE(foo.StatusIsOK()); | |||
2320 | // } | |||
2321 | ||||
2322 | // Note that we call GetTestTypeId() instead of GetTypeId< | |||
2323 | // ::testing::Test>() here to get the type ID of testing::Test. This | |||
2324 | // is to work around a suspected linker bug when using Google Test as | |||
2325 | // a framework on Mac OS X. The bug causes GetTypeId< | |||
2326 | // ::testing::Test>() to return different values depending on whether | |||
2327 | // the call is from the Google Test framework itself or from user test | |||
2328 | // code. GetTestTypeId() is guaranteed to always return the same | |||
2329 | // value, as it always calls GetTypeId<>() from the Google Test | |||
2330 | // framework. | |||
2331 | #define GTEST_TEST(test_suite_name, test_name)static_assert(sizeof("test_suite_name") > 1, "test_suite_name must not be empty" ); static_assert(sizeof("test_name") > 1, "test_name must not be empty" ); class test_suite_name_test_name_Test : public ::testing::Test { public: test_suite_name_test_name_Test() {} private: virtual void TestBody(); static ::testing::TestInfo* const test_info_ __attribute__ ((unused)); test_suite_name_test_name_Test(test_suite_name_test_name_Test const &) = delete; void operator=(test_suite_name_test_name_Test const &) = delete; }; ::testing::TestInfo* const test_suite_name_test_name_Test ::test_info_ = ::testing::internal::MakeAndRegisterTestInfo( "test_suite_name" , "test_name", nullptr, nullptr, ::testing::internal::CodeLocation ("/usr/src/googletest/googletest/include/gtest/gtest.h", 2331 ), (::testing::internal::GetTestTypeId()), ::testing::internal ::SuiteApiResolver< ::testing::Test>::GetSetUpCaseOrSuite ("/usr/src/googletest/googletest/include/gtest/gtest.h", 2331 ), ::testing::internal::SuiteApiResolver< ::testing::Test> ::GetTearDownCaseOrSuite("/usr/src/googletest/googletest/include/gtest/gtest.h" , 2331), new ::testing::internal::TestFactoryImpl<test_suite_name_test_name_Test >); void test_suite_name_test_name_Test::TestBody() \ | |||
2332 | GTEST_TEST_(test_suite_name, test_name, ::testing::Test, \static_assert(sizeof("test_suite_name") > 1, "test_suite_name must not be empty" ); static_assert(sizeof("test_name") > 1, "test_name must not be empty" ); class test_suite_name_test_name_Test : public ::testing::Test { public: test_suite_name_test_name_Test() {} private: virtual void TestBody(); static ::testing::TestInfo* const test_info_ __attribute__ ((unused)); test_suite_name_test_name_Test(test_suite_name_test_name_Test const &) = delete; void operator=(test_suite_name_test_name_Test const &) = delete; }; ::testing::TestInfo* const test_suite_name_test_name_Test ::test_info_ = ::testing::internal::MakeAndRegisterTestInfo( "test_suite_name" , "test_name", nullptr, nullptr, ::testing::internal::CodeLocation ("/usr/src/googletest/googletest/include/gtest/gtest.h", 2333 ), (::testing::internal::GetTestTypeId()), ::testing::internal ::SuiteApiResolver< ::testing::Test>::GetSetUpCaseOrSuite ("/usr/src/googletest/googletest/include/gtest/gtest.h", 2333 ), ::testing::internal::SuiteApiResolver< ::testing::Test> ::GetTearDownCaseOrSuite("/usr/src/googletest/googletest/include/gtest/gtest.h" , 2333), new ::testing::internal::TestFactoryImpl<test_suite_name_test_name_Test >); void test_suite_name_test_name_Test::TestBody() | |||
2333 | ::testing::internal::GetTestTypeId())static_assert(sizeof("test_suite_name") > 1, "test_suite_name must not be empty" ); static_assert(sizeof("test_name") > 1, "test_name must not be empty" ); class test_suite_name_test_name_Test : public ::testing::Test { public: test_suite_name_test_name_Test() {} private: virtual void TestBody(); static ::testing::TestInfo* const test_info_ __attribute__ ((unused)); test_suite_name_test_name_Test(test_suite_name_test_name_Test const &) = delete; void operator=(test_suite_name_test_name_Test const &) = delete; }; ::testing::TestInfo* const test_suite_name_test_name_Test ::test_info_ = ::testing::internal::MakeAndRegisterTestInfo( "test_suite_name" , "test_name", nullptr, nullptr, ::testing::internal::CodeLocation ("/usr/src/googletest/googletest/include/gtest/gtest.h", 2333 ), (::testing::internal::GetTestTypeId()), ::testing::internal ::SuiteApiResolver< ::testing::Test>::GetSetUpCaseOrSuite ("/usr/src/googletest/googletest/include/gtest/gtest.h", 2333 ), ::testing::internal::SuiteApiResolver< ::testing::Test> ::GetTearDownCaseOrSuite("/usr/src/googletest/googletest/include/gtest/gtest.h" , 2333), new ::testing::internal::TestFactoryImpl<test_suite_name_test_name_Test >); void test_suite_name_test_name_Test::TestBody() | |||
2334 | ||||
2335 | // Define this macro to 1 to omit the definition of TEST(), which | |||
2336 | // is a generic name and clashes with some other libraries. | |||
2337 | #if !GTEST_DONT_DEFINE_TEST | |||
2338 | #define TEST(test_suite_name, test_name)static_assert(sizeof("test_suite_name") > 1, "test_suite_name must not be empty" ); static_assert(sizeof("test_name") > 1, "test_name must not be empty" ); class test_suite_name_test_name_Test : public ::testing::Test { public: test_suite_name_test_name_Test() {} private: virtual void TestBody(); static ::testing::TestInfo* const test_info_ __attribute__ ((unused)); test_suite_name_test_name_Test(test_suite_name_test_name_Test const &) = delete; void operator=(test_suite_name_test_name_Test const &) = delete; }; ::testing::TestInfo* const test_suite_name_test_name_Test ::test_info_ = ::testing::internal::MakeAndRegisterTestInfo( "test_suite_name" , "test_name", nullptr, nullptr, ::testing::internal::CodeLocation ("/usr/src/googletest/googletest/include/gtest/gtest.h", 2338 ), (::testing::internal::GetTestTypeId()), ::testing::internal ::SuiteApiResolver< ::testing::Test>::GetSetUpCaseOrSuite ("/usr/src/googletest/googletest/include/gtest/gtest.h", 2338 ), ::testing::internal::SuiteApiResolver< ::testing::Test> ::GetTearDownCaseOrSuite("/usr/src/googletest/googletest/include/gtest/gtest.h" , 2338), new ::testing::internal::TestFactoryImpl<test_suite_name_test_name_Test >); void test_suite_name_test_name_Test::TestBody() GTEST_TEST(test_suite_name, test_name)static_assert(sizeof("test_suite_name") > 1, "test_suite_name must not be empty" ); static_assert(sizeof("test_name") > 1, "test_name must not be empty" ); class test_suite_name_test_name_Test : public ::testing::Test { public: test_suite_name_test_name_Test() {} private: virtual void TestBody(); static ::testing::TestInfo* const test_info_ __attribute__ ((unused)); test_suite_name_test_name_Test(test_suite_name_test_name_Test const &) = delete; void operator=(test_suite_name_test_name_Test const &) = delete; }; ::testing::TestInfo* const test_suite_name_test_name_Test ::test_info_ = ::testing::internal::MakeAndRegisterTestInfo( "test_suite_name" , "test_name", nullptr, nullptr, ::testing::internal::CodeLocation ("/usr/src/googletest/googletest/include/gtest/gtest.h", 2338 ), (::testing::internal::GetTestTypeId()), ::testing::internal ::SuiteApiResolver< ::testing::Test>::GetSetUpCaseOrSuite ("/usr/src/googletest/googletest/include/gtest/gtest.h", 2338 ), ::testing::internal::SuiteApiResolver< ::testing::Test> ::GetTearDownCaseOrSuite("/usr/src/googletest/googletest/include/gtest/gtest.h" , 2338), new ::testing::internal::TestFactoryImpl<test_suite_name_test_name_Test >); void test_suite_name_test_name_Test::TestBody() | |||
2339 | #endif | |||
2340 | ||||
2341 | // Defines a test that uses a test fixture. | |||
2342 | // | |||
2343 | // The first parameter is the name of the test fixture class, which | |||
2344 | // also doubles as the test suite name. The second parameter is the | |||
2345 | // name of the test within the test suite. | |||
2346 | // | |||
2347 | // A test fixture class must be declared earlier. The user should put | |||
2348 | // the test code between braces after using this macro. Example: | |||
2349 | // | |||
2350 | // class FooTest : public testing::Test { | |||
2351 | // protected: | |||
2352 | // void SetUp() override { b_.AddElement(3); } | |||
2353 | // | |||
2354 | // Foo a_; | |||
2355 | // Foo b_; | |||
2356 | // }; | |||
2357 | // | |||
2358 | // TEST_F(FooTest, InitializesCorrectly) { | |||
2359 | // EXPECT_TRUE(a_.StatusIsOK()); | |||
2360 | // } | |||
2361 | // | |||
2362 | // TEST_F(FooTest, ReturnsElementCountCorrectly) { | |||
2363 | // EXPECT_EQ(a_.size(), 0); | |||
2364 | // EXPECT_EQ(b_.size(), 1); | |||
2365 | // } | |||
2366 | // | |||
2367 | // GOOGLETEST_CM0011 DO NOT DELETE | |||
2368 | #define TEST_F(test_fixture, test_name)static_assert(sizeof("test_fixture") > 1, "test_suite_name must not be empty" ); static_assert(sizeof("test_name") > 1, "test_name must not be empty" ); class test_fixture_test_name_Test : public test_fixture { public : test_fixture_test_name_Test() {} private: virtual void TestBody (); static ::testing::TestInfo* const test_info_ __attribute__ ((unused)); test_fixture_test_name_Test(test_fixture_test_name_Test const &) = delete; void operator=(test_fixture_test_name_Test const &) = delete; }; ::testing::TestInfo* const test_fixture_test_name_Test ::test_info_ = ::testing::internal::MakeAndRegisterTestInfo( "test_fixture" , "test_name", nullptr, nullptr, ::testing::internal::CodeLocation ("/usr/src/googletest/googletest/include/gtest/gtest.h", 2368 ), (::testing::internal::GetTypeId<test_fixture>()), :: testing::internal::SuiteApiResolver< test_fixture>::GetSetUpCaseOrSuite ("/usr/src/googletest/googletest/include/gtest/gtest.h", 2368 ), ::testing::internal::SuiteApiResolver< test_fixture> ::GetTearDownCaseOrSuite("/usr/src/googletest/googletest/include/gtest/gtest.h" , 2368), new ::testing::internal::TestFactoryImpl<test_fixture_test_name_Test >); void test_fixture_test_name_Test::TestBody()\ | |||
2369 | GTEST_TEST_(test_fixture, test_name, test_fixture, \static_assert(sizeof("test_fixture") > 1, "test_suite_name must not be empty" ); static_assert(sizeof("test_name") > 1, "test_name must not be empty" ); class test_fixture_test_name_Test : public test_fixture { public : test_fixture_test_name_Test() {} private: virtual void TestBody (); static ::testing::TestInfo* const test_info_ __attribute__ ((unused)); test_fixture_test_name_Test(test_fixture_test_name_Test const &) = delete; void operator=(test_fixture_test_name_Test const &) = delete; }; ::testing::TestInfo* const test_fixture_test_name_Test ::test_info_ = ::testing::internal::MakeAndRegisterTestInfo( "test_fixture" , "test_name", nullptr, nullptr, ::testing::internal::CodeLocation ("/usr/src/googletest/googletest/include/gtest/gtest.h", 2370 ), (::testing::internal::GetTypeId<test_fixture>()), :: testing::internal::SuiteApiResolver< test_fixture>::GetSetUpCaseOrSuite ("/usr/src/googletest/googletest/include/gtest/gtest.h", 2370 ), ::testing::internal::SuiteApiResolver< test_fixture> ::GetTearDownCaseOrSuite("/usr/src/googletest/googletest/include/gtest/gtest.h" , 2370), new ::testing::internal::TestFactoryImpl<test_fixture_test_name_Test >); void test_fixture_test_name_Test::TestBody() | |||
2370 | ::testing::internal::GetTypeId<test_fixture>())static_assert(sizeof("test_fixture") > 1, "test_suite_name must not be empty" ); static_assert(sizeof("test_name") > 1, "test_name must not be empty" ); class test_fixture_test_name_Test : public test_fixture { public : test_fixture_test_name_Test() {} private: virtual void TestBody (); static ::testing::TestInfo* const test_info_ __attribute__ ((unused)); test_fixture_test_name_Test(test_fixture_test_name_Test const &) = delete; void operator=(test_fixture_test_name_Test const &) = delete; }; ::testing::TestInfo* const test_fixture_test_name_Test ::test_info_ = ::testing::internal::MakeAndRegisterTestInfo( "test_fixture" , "test_name", nullptr, nullptr, ::testing::internal::CodeLocation ("/usr/src/googletest/googletest/include/gtest/gtest.h", 2370 ), (::testing::internal::GetTypeId<test_fixture>()), :: testing::internal::SuiteApiResolver< test_fixture>::GetSetUpCaseOrSuite ("/usr/src/googletest/googletest/include/gtest/gtest.h", 2370 ), ::testing::internal::SuiteApiResolver< test_fixture> ::GetTearDownCaseOrSuite("/usr/src/googletest/googletest/include/gtest/gtest.h" , 2370), new ::testing::internal::TestFactoryImpl<test_fixture_test_name_Test >); void test_fixture_test_name_Test::TestBody() | |||
2371 | ||||
2372 | // Returns a path to temporary directory. | |||
2373 | // Tries to determine an appropriate directory for the platform. | |||
2374 | GTEST_API___attribute__((visibility ("default"))) std::string TempDir(); | |||
2375 | ||||
2376 | #ifdef _MSC_VER | |||
2377 | # pragma warning(pop) | |||
2378 | #endif | |||
2379 | ||||
2380 | // Dynamically registers a test with the framework. | |||
2381 | // | |||
2382 | // This is an advanced API only to be used when the `TEST` macros are | |||
2383 | // insufficient. The macros should be preferred when possible, as they avoid | |||
2384 | // most of the complexity of calling this function. | |||
2385 | // | |||
2386 | // The `factory` argument is a factory callable (move-constructible) object or | |||
2387 | // function pointer that creates a new instance of the Test object. It | |||
2388 | // handles ownership to the caller. The signature of the callable is | |||
2389 | // `Fixture*()`, where `Fixture` is the test fixture class for the test. All | |||
2390 | // tests registered with the same `test_suite_name` must return the same | |||
2391 | // fixture type. This is checked at runtime. | |||
2392 | // | |||
2393 | // The framework will infer the fixture class from the factory and will call | |||
2394 | // the `SetUpTestSuite` and `TearDownTestSuite` for it. | |||
2395 | // | |||
2396 | // Must be called before `RUN_ALL_TESTS()` is invoked, otherwise behavior is | |||
2397 | // undefined. | |||
2398 | // | |||
2399 | // Use case example: | |||
2400 | // | |||
2401 | // class MyFixture : public ::testing::Test { | |||
2402 | // public: | |||
2403 | // // All of these optional, just like in regular macro usage. | |||
2404 | // static void SetUpTestSuite() { ... } | |||
2405 | // static void TearDownTestSuite() { ... } | |||
2406 | // void SetUp() override { ... } | |||
2407 | // void TearDown() override { ... } | |||
2408 | // }; | |||
2409 | // | |||
2410 | // class MyTest : public MyFixture { | |||
2411 | // public: | |||
2412 | // explicit MyTest(int data) : data_(data) {} | |||
2413 | // void TestBody() override { ... } | |||
2414 | // | |||
2415 | // private: | |||
2416 | // int data_; | |||
2417 | // }; | |||
2418 | // | |||
2419 | // void RegisterMyTests(const std::vector<int>& values) { | |||
2420 | // for (int v : values) { | |||
2421 | // ::testing::RegisterTest( | |||
2422 | // "MyFixture", ("Test" + std::to_string(v)).c_str(), nullptr, | |||
2423 | // std::to_string(v).c_str(), | |||
2424 | // __FILE__, __LINE__, | |||
2425 | // // Important to use the fixture type as the return type here. | |||
2426 | // [=]() -> MyFixture* { return new MyTest(v); }); | |||
2427 | // } | |||
2428 | // } | |||
2429 | // ... | |||
2430 | // int main(int argc, char** argv) { | |||
2431 | // std::vector<int> values_to_test = LoadValuesFromConfig(); | |||
2432 | // RegisterMyTests(values_to_test); | |||
2433 | // ... | |||
2434 | // return RUN_ALL_TESTS(); | |||
2435 | // } | |||
2436 | // | |||
2437 | template <int&... ExplicitParameterBarrier, typename Factory> | |||
2438 | TestInfo* RegisterTest(const char* test_suite_name, const char* test_name, | |||
2439 | const char* type_param, const char* value_param, | |||
2440 | const char* file, int line, Factory factory) { | |||
2441 | using TestT = typename std::remove_pointer<decltype(factory())>::type; | |||
2442 | ||||
2443 | class FactoryImpl : public internal::TestFactoryBase { | |||
2444 | public: | |||
2445 | explicit FactoryImpl(Factory f) : factory_(std::move(f)) {} | |||
2446 | Test* CreateTest() override { return factory_(); } | |||
2447 | ||||
2448 | private: | |||
2449 | Factory factory_; | |||
2450 | }; | |||
2451 | ||||
2452 | return internal::MakeAndRegisterTestInfo( | |||
2453 | test_suite_name, test_name, type_param, value_param, | |||
2454 | internal::CodeLocation(file, line), internal::GetTypeId<TestT>(), | |||
2455 | internal::SuiteApiResolver<TestT>::GetSetUpCaseOrSuite(file, line), | |||
2456 | internal::SuiteApiResolver<TestT>::GetTearDownCaseOrSuite(file, line), | |||
2457 | new FactoryImpl{std::move(factory)}); | |||
2458 | } | |||
2459 | ||||
2460 | } // namespace testing | |||
2461 | ||||
2462 | // Use this function in main() to run all tests. It returns 0 if all | |||
2463 | // tests are successful, or 1 otherwise. | |||
2464 | // | |||
2465 | // RUN_ALL_TESTS() should be invoked after the command line has been | |||
2466 | // parsed by InitGoogleTest(). | |||
2467 | // | |||
2468 | // This function was formerly a macro; thus, it is in the global | |||
2469 | // namespace and has an all-caps name. | |||
2470 | int RUN_ALL_TESTS() GTEST_MUST_USE_RESULT___attribute__ ((warn_unused_result)); | |||
2471 | ||||
2472 | inline int RUN_ALL_TESTS() { | |||
2473 | return ::testing::UnitTest::GetInstance()->Run(); | |||
2474 | } | |||
2475 | ||||
2476 | GTEST_DISABLE_MSC_WARNINGS_POP_() // 4251 | |||
2477 | ||||
2478 | #endif // GTEST_INCLUDE_GTEST_GTEST_H_ |