Bug Summary

File:usr/src/googletest/googletest/include/gtest/gtest.h
Warning:line 1394, column 11
The right operand of '==' is a garbage value

Annotated Source Code

Press '?' to see keyboard shortcuts

clang -cc1 -cc1 -triple x86_64-redhat-linux-gnu -O2 -analyze -disable-free -clear-ast-before-backend -disable-llvm-verifier -discard-value-names -main-file-name simple_parser_unittest.cc -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=cplusplus -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -setup-static-analyzer -mrelocation-model pic -pic-level 2 -pic-is-pie -mframe-pointer=none -fmath-errno -ffp-contract=on -fno-rounding-math -mconstructor-aliases -funwind-tables=2 -target-cpu x86-64 -tune-cpu generic -debugger-tuning=gdb -fdebug-compilation-dir=/home/fedora/workspace/kea-dev/clang-static-analyzer/build/meson-private/tmpz0p224zs -fcoverage-compilation-dir=/home/fedora/workspace/kea-dev/clang-static-analyzer/build/meson-private/tmpz0p224zs -resource-dir /usr/bin/../lib/clang/22 -I src/lib/cc/tests/kea-cc-tests.p -I src/lib/cc/tests -I ../../../src/lib/cc/tests -I . -I ../../.. -I src -I ../../../src -I src/bin -I ../../../src/bin -I src/lib -I ../../../src/lib -I /usr/src/googletest/googletest -I /usr/src/googletest/googletest/include -I /usr/include -D _GLIBCXX_ASSERTIONS=1 -D _FILE_OFFSET_BITS=64 -D BOOST_ALL_NO_LIB -internal-isystem /usr/bin/../lib/gcc/x86_64-redhat-linux/16/../../../../include/c++/16 -internal-isystem /usr/bin/../lib/gcc/x86_64-redhat-linux/16/../../../../include/c++/16/x86_64-redhat-linux -internal-isystem /usr/bin/../lib/gcc/x86_64-redhat-linux/16/../../../../include/c++/16/backward -internal-isystem /usr/bin/../lib/clang/22/include -internal-isystem /usr/local/include -internal-isystem /usr/bin/../lib/gcc/x86_64-redhat-linux/16/../../../../x86_64-redhat-linux/include -internal-externc-isystem /include -internal-externc-isystem /usr/include -Wwrite-strings -Wno-missing-field-initializers -fdeprecated-macro -ferror-limit 19 -fgnuc-version=4.2.1 -fskip-odr-check-in-gmf -fcxx-exceptions -fexceptions -fcolor-diagnostics -vectorize-loops -vectorize-slp -analyzer-output=html -faddrsig -fdwarf2-cfi-asm -o /home/fedora/workspace/kea-dev/clang-static-analyzer/build/meson-logs/scanbuild/2026-06-18-163926-5114-1 -x c++ ../../../src/lib/cc/tests/simple_parser_unittest.cc

../../../src/lib/cc/tests/simple_parser_unittest.cc

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#include <testutils/gtest_utils.h>
13
14#include <list>
15
16using namespace isc;
17using namespace isc::data;
18using namespace isc::asiolink;
19using isc::dhcp::DhcpConfigError;
20
21/// This list defines required keywords.
22const SimpleRequiredKeywords REQUIRED_KEYWORDS = { "foobar" };
23
24/// This table defines keywords and types.
25const SimpleKeywords KEYWORDS = {
26 { "id", Element::integer },
27 { "prefix", Element::string },
28 { "map", Element::map },
29 { "any", Element::any }
30};
31
32/// This table defines sample default values. Although these are DHCPv6
33/// specific, the mechanism is generic and can be used by any other component.
34const SimpleDefaults SAMPLE_DEFAULTS = {
35 { "renew-timer", Element::integer, "900" },
36 { "rebind-timer", Element::integer, "1800" },
37 { "preferred-lifetime", Element::integer, "3600" },
38 { "valid-lifetime", Element::integer, "7200" }
39};
40
41/// This list defines parameters that can be inherited from one scope
42/// to another. Although these are DHCPv6 specific, the mechanism is generic and
43/// can be used by any other component.
44const ParamsList SAMPLE_INHERITS = {
45 "renew-timer",
46 "rebind-timer",
47 "preferred-lifetime",
48 "valid-lifetime"
49};
50
51/// @brief Simple Parser test fixture class
52class SimpleParserTest : public ::testing::Test {
53public:
54 /// @brief Checks if specified map has an integer parameter with expected value
55 ///
56 /// @param map map to be checked
57 /// @param param_name name of the parameter to be checked
58 /// @param exp_value expected value of the parameter.
59 void checkIntegerValue(const ConstElementPtr& map, const std::string& param_name,
60 int64_t exp_value) {
61
62 // First check if the passed element is a map.
63 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, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 63, gtest_ar.failure_message()) = ::testing::Message()
;
64
65 // Now try to get the element being checked
66 ConstElementPtr elem = map->get(param_name);
67 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
, "../../../src/lib/cc/tests/simple_parser_unittest.cc", 67, ::
testing::internal::GetBoolAssertionFailureMessage( gtest_ar_,
"elem", "false", "true") .c_str()) = ::testing::Message()
;
68
69 // Now check if it's indeed integer
70 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, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 70, gtest_ar.failure_message()) = ::testing::Message()
;
71
72 // Finally, check if its value meets expectation.
73 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, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 73, gtest_ar.failure_message()) = ::testing::Message()
;
74 }
75};
76
77class SimpleParserClassTest : public SimpleParser {
78public:
79 /// @brief Instantiation of getAndConvert
80 ///
81 /// @param scope specified parameter will be extracted from this scope
82 /// @param name name of the parameter for error report
83 /// @return a bool value
84 bool getAsBool(ConstElementPtr scope, const std::string& name) {
85 return (getAndConvert<bool, toBool>(scope, name, "boolean"));
86 }
87
88 /// @brief Convert to boolean
89 ///
90 /// @param str the string "false" or "true"
91 /// @return false for "false" and true for "true"
92 /// @thrown isc::OutOfRange if not "false" or "true'
93 static bool toBool(const std::string& str) {
94 if (str == "false") {
95 return (false);
96 } else if (str == "true") {
97 return (true);
98 } else {
99 isc_throw(TypeError, "not a boolean: " << str)do { std::ostringstream oss__; oss__ << "not a boolean: "
<< str; throw TypeError("../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 99, oss__.str().c_str()); } while (1)
;
100 }
101 }
102};
103
104// This test checks if the checkRequired method works as expected.
105TEST_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() = default; ~
SimpleParserTest_checkRequired_Test() override = default; SimpleParserTest_checkRequired_Test
(const SimpleParserTest_checkRequired_Test &) = delete; SimpleParserTest_checkRequired_Test
& operator=( const SimpleParserTest_checkRequired_Test &
) = delete; SimpleParserTest_checkRequired_Test (SimpleParserTest_checkRequired_Test
&&) noexcept = delete; SimpleParserTest_checkRequired_Test
& operator=( SimpleParserTest_checkRequired_Test &&
) noexcept = delete; private: void TestBody() override; [[maybe_unused
]] static ::testing::TestInfo* const test_info_; }; ::testing
::TestInfo* const SimpleParserTest_checkRequired_Test::test_info_
= ::testing::internal::MakeAndRegisterTestInfo( "SimpleParserTest"
, "checkRequired", nullptr, nullptr, ::testing::internal::CodeLocation
("../../../src/lib/cc/tests/simple_parser_unittest.cc", 105),
(::testing::internal::GetTypeId<SimpleParserTest>()), ::
testing::internal::SuiteApiResolver< SimpleParserTest>::
GetSetUpCaseOrSuite("../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 105), ::testing::internal::SuiteApiResolver< SimpleParserTest
>::GetTearDownCaseOrSuite("../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 105), new ::testing::internal::TestFactoryImpl<SimpleParserTest_checkRequired_Test
>); void SimpleParserTest_checkRequired_Test::TestBody()
{
106 ConstElementPtr empty = Element::fromJSON("{ }");
107 EXPECT_THROW(SimpleParser::checkRequired(REQUIRED_KEYWORDS, empty),switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { bool gtest_caught_expected = false; try { if (
::testing::internal::AlwaysTrue()) { SimpleParser::checkRequired
(REQUIRED_KEYWORDS, empty); } else static_assert(true, ""); }
catch (DhcpConfigError const&) { gtest_caught_expected =
true; } catch (typename std::conditional< std::is_same<
typename std::remove_cv<typename std::remove_reference<
DhcpConfigError>::type>::type, std::exception>::value
, const ::testing::internal::NeverThrown&, const std::exception
&>::type e) { gtest_msg.value = "Expected: " "SimpleParser::checkRequired(REQUIRED_KEYWORDS, empty)"
" throws an exception of type " "DhcpConfigError" ".\n Actual: it throws "
; gtest_msg.value += ::testing::internal::GetTypeName(typeid(
e)); gtest_msg.value += " with description \""; gtest_msg.value
+= e.what(); gtest_msg.value += "\"."; goto gtest_label_testthrow_108
; } 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_108; } 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_108; } } else gtest_label_testthrow_108
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 108, gtest_msg.value.c_str()) = ::testing::Message()
108 DhcpConfigError)switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { bool gtest_caught_expected = false; try { if (
::testing::internal::AlwaysTrue()) { SimpleParser::checkRequired
(REQUIRED_KEYWORDS, empty); } else static_assert(true, ""); }
catch (DhcpConfigError const&) { gtest_caught_expected =
true; } catch (typename std::conditional< std::is_same<
typename std::remove_cv<typename std::remove_reference<
DhcpConfigError>::type>::type, std::exception>::value
, const ::testing::internal::NeverThrown&, const std::exception
&>::type e) { gtest_msg.value = "Expected: " "SimpleParser::checkRequired(REQUIRED_KEYWORDS, empty)"
" throws an exception of type " "DhcpConfigError" ".\n Actual: it throws "
; gtest_msg.value += ::testing::internal::GetTypeName(typeid(
e)); gtest_msg.value += " with description \""; gtest_msg.value
+= e.what(); gtest_msg.value += "\"."; goto gtest_label_testthrow_108
; } 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_108; } 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_108; } } else gtest_label_testthrow_108
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 108, gtest_msg.value.c_str()) = ::testing::Message()
;
109 ConstElementPtr other = Element::fromJSON("{ \"foo\": 1, \"bar\": 2 }");
110 EXPECT_THROW(SimpleParser::checkRequired(REQUIRED_KEYWORDS, other),switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { bool gtest_caught_expected = false; try { if (
::testing::internal::AlwaysTrue()) { SimpleParser::checkRequired
(REQUIRED_KEYWORDS, other); } else static_assert(true, ""); }
catch (DhcpConfigError const&) { gtest_caught_expected =
true; } catch (typename std::conditional< std::is_same<
typename std::remove_cv<typename std::remove_reference<
DhcpConfigError>::type>::type, std::exception>::value
, const ::testing::internal::NeverThrown&, const std::exception
&>::type e) { gtest_msg.value = "Expected: " "SimpleParser::checkRequired(REQUIRED_KEYWORDS, other)"
" throws an exception of type " "DhcpConfigError" ".\n Actual: it throws "
; gtest_msg.value += ::testing::internal::GetTypeName(typeid(
e)); gtest_msg.value += " with description \""; gtest_msg.value
+= e.what(); gtest_msg.value += "\"."; goto gtest_label_testthrow_111
; } 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_111; } 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_111; } } else gtest_label_testthrow_111
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 111, gtest_msg.value.c_str()) = ::testing::Message()
111 DhcpConfigError)switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { bool gtest_caught_expected = false; try { if (
::testing::internal::AlwaysTrue()) { SimpleParser::checkRequired
(REQUIRED_KEYWORDS, other); } else static_assert(true, ""); }
catch (DhcpConfigError const&) { gtest_caught_expected =
true; } catch (typename std::conditional< std::is_same<
typename std::remove_cv<typename std::remove_reference<
DhcpConfigError>::type>::type, std::exception>::value
, const ::testing::internal::NeverThrown&, const std::exception
&>::type e) { gtest_msg.value = "Expected: " "SimpleParser::checkRequired(REQUIRED_KEYWORDS, other)"
" throws an exception of type " "DhcpConfigError" ".\n Actual: it throws "
; gtest_msg.value += ::testing::internal::GetTypeName(typeid(
e)); gtest_msg.value += " with description \""; gtest_msg.value
+= e.what(); gtest_msg.value += "\"."; goto gtest_label_testthrow_111
; } 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_111; } 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_111; } } else gtest_label_testthrow_111
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 111, gtest_msg.value.c_str()) = ::testing::Message()
;
112 ConstElementPtr good = Element::fromJSON("{ \"foobar\": 2 }");
113 EXPECT_NO_THROW(SimpleParser::checkRequired(REQUIRED_KEYWORDS, good))switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { try { if (::testing::internal::AlwaysTrue()) {
SimpleParser::checkRequired(REQUIRED_KEYWORDS, good); } else
static_assert(true, ""); } catch (std::exception const& e
) { gtest_msg.value = "it throws "; gtest_msg.value += ::testing
::internal::GetTypeName(typeid(e)); gtest_msg.value += " with description \""
; gtest_msg.value += e.what(); gtest_msg.value += "\"."; goto
gtest_label_testnothrow_113; } catch (...) { gtest_msg.value
= "it throws."; goto gtest_label_testnothrow_113; } } else gtest_label_testnothrow_113
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 113, ("Expected: " "SimpleParser::checkRequired(REQUIRED_KEYWORDS, good)"
" doesn't throw an exception.\n" " Actual: " + gtest_msg.value
) .c_str()) = ::testing::Message()
;
114}
115
116// This test checks if the checkKeywords method works as expected.
117TEST_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() = default; ~
SimpleParserTest_checkKeywords_Test() override = default; SimpleParserTest_checkKeywords_Test
(const SimpleParserTest_checkKeywords_Test &) = delete; SimpleParserTest_checkKeywords_Test
& operator=( const SimpleParserTest_checkKeywords_Test &
) = delete; SimpleParserTest_checkKeywords_Test (SimpleParserTest_checkKeywords_Test
&&) noexcept = delete; SimpleParserTest_checkKeywords_Test
& operator=( SimpleParserTest_checkKeywords_Test &&
) noexcept = delete; private: void TestBody() override; [[maybe_unused
]] static ::testing::TestInfo* const test_info_; }; ::testing
::TestInfo* const SimpleParserTest_checkKeywords_Test::test_info_
= ::testing::internal::MakeAndRegisterTestInfo( "SimpleParserTest"
, "checkKeywords", nullptr, nullptr, ::testing::internal::CodeLocation
("../../../src/lib/cc/tests/simple_parser_unittest.cc", 117),
(::testing::internal::GetTypeId<SimpleParserTest>()), ::
testing::internal::SuiteApiResolver< SimpleParserTest>::
GetSetUpCaseOrSuite("../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 117), ::testing::internal::SuiteApiResolver< SimpleParserTest
>::GetTearDownCaseOrSuite("../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 117), new ::testing::internal::TestFactoryImpl<SimpleParserTest_checkKeywords_Test
>); void SimpleParserTest_checkKeywords_Test::TestBody()
{
118 ConstElementPtr empty = Element::fromJSON("{ }");
119 EXPECT_NO_THROW(SimpleParser::checkKeywords(KEYWORDS, empty))switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { try { if (::testing::internal::AlwaysTrue()) {
SimpleParser::checkKeywords(KEYWORDS, empty); } else static_assert
(true, ""); } catch (std::exception const& e) { gtest_msg
.value = "it throws "; gtest_msg.value += ::testing::internal
::GetTypeName(typeid(e)); gtest_msg.value += " with description \""
; gtest_msg.value += e.what(); gtest_msg.value += "\"."; goto
gtest_label_testnothrow_119; } catch (...) { gtest_msg.value
= "it throws."; goto gtest_label_testnothrow_119; } } else gtest_label_testnothrow_119
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 119, ("Expected: " "SimpleParser::checkKeywords(KEYWORDS, empty)"
" doesn't throw an exception.\n" " Actual: " + gtest_msg.value
) .c_str()) = ::testing::Message()
;
120 ConstElementPtr id = Element::fromJSON("{ \"id\": 1 }");
121 EXPECT_NO_THROW(SimpleParser::checkKeywords(KEYWORDS, id))switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { try { if (::testing::internal::AlwaysTrue()) {
SimpleParser::checkKeywords(KEYWORDS, id); } else static_assert
(true, ""); } catch (std::exception const& e) { gtest_msg
.value = "it throws "; gtest_msg.value += ::testing::internal
::GetTypeName(typeid(e)); gtest_msg.value += " with description \""
; gtest_msg.value += e.what(); gtest_msg.value += "\"."; goto
gtest_label_testnothrow_121; } catch (...) { gtest_msg.value
= "it throws."; goto gtest_label_testnothrow_121; } } else gtest_label_testnothrow_121
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 121, ("Expected: " "SimpleParser::checkKeywords(KEYWORDS, id)"
" doesn't throw an exception.\n" " Actual: " + gtest_msg.value
) .c_str()) = ::testing::Message()
;
122 ConstElementPtr any = Element::fromJSON("{ \"any\": 1 }");
123 EXPECT_NO_THROW(SimpleParser::checkKeywords(KEYWORDS, any))switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { try { if (::testing::internal::AlwaysTrue()) {
SimpleParser::checkKeywords(KEYWORDS, any); } else static_assert
(true, ""); } catch (std::exception const& e) { gtest_msg
.value = "it throws "; gtest_msg.value += ::testing::internal
::GetTypeName(typeid(e)); gtest_msg.value += " with description \""
; gtest_msg.value += e.what(); gtest_msg.value += "\"."; goto
gtest_label_testnothrow_123; } catch (...) { gtest_msg.value
= "it throws."; goto gtest_label_testnothrow_123; } } else gtest_label_testnothrow_123
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 123, ("Expected: " "SimpleParser::checkKeywords(KEYWORDS, any)"
" doesn't throw an exception.\n" " Actual: " + gtest_msg.value
) .c_str()) = ::testing::Message()
;
124 ConstElementPtr bad_id = Element::fromJSON("{ \"id\": true }");
125 EXPECT_THROW(SimpleParser::checkKeywords(KEYWORDS, bad_id),switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { bool gtest_caught_expected = false; try { if (
::testing::internal::AlwaysTrue()) { SimpleParser::checkKeywords
(KEYWORDS, bad_id); } else static_assert(true, ""); } catch (
DhcpConfigError const&) { gtest_caught_expected = true; }
catch (typename std::conditional< std::is_same<typename
std::remove_cv<typename std::remove_reference< DhcpConfigError
>::type>::type, std::exception>::value, const ::testing
::internal::NeverThrown&, const std::exception&>::
type e) { gtest_msg.value = "Expected: " "SimpleParser::checkKeywords(KEYWORDS, bad_id)"
" throws an exception of type " "DhcpConfigError" ".\n Actual: it throws "
; gtest_msg.value += ::testing::internal::GetTypeName(typeid(
e)); gtest_msg.value += " with description \""; gtest_msg.value
+= e.what(); gtest_msg.value += "\"."; goto gtest_label_testthrow_126
; } 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_126; } 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_126; } } else gtest_label_testthrow_126
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 126, gtest_msg.value.c_str()) = ::testing::Message()
126 DhcpConfigError)switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { bool gtest_caught_expected = false; try { if (
::testing::internal::AlwaysTrue()) { SimpleParser::checkKeywords
(KEYWORDS, bad_id); } else static_assert(true, ""); } catch (
DhcpConfigError const&) { gtest_caught_expected = true; }
catch (typename std::conditional< std::is_same<typename
std::remove_cv<typename std::remove_reference< DhcpConfigError
>::type>::type, std::exception>::value, const ::testing
::internal::NeverThrown&, const std::exception&>::
type e) { gtest_msg.value = "Expected: " "SimpleParser::checkKeywords(KEYWORDS, bad_id)"
" throws an exception of type " "DhcpConfigError" ".\n Actual: it throws "
; gtest_msg.value += ::testing::internal::GetTypeName(typeid(
e)); gtest_msg.value += " with description \""; gtest_msg.value
+= e.what(); gtest_msg.value += "\"."; goto gtest_label_testthrow_126
; } 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_126; } 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_126; } } else gtest_label_testthrow_126
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 126, gtest_msg.value.c_str()) = ::testing::Message()
;
127 ConstElementPtr bad_prefix = Element::fromJSON("{ \"prefix\": 12 }");
128 EXPECT_THROW(SimpleParser::checkKeywords(KEYWORDS, bad_prefix),switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { bool gtest_caught_expected = false; try { if (
::testing::internal::AlwaysTrue()) { SimpleParser::checkKeywords
(KEYWORDS, bad_prefix); } else static_assert(true, ""); } catch
(DhcpConfigError const&) { gtest_caught_expected = true;
} catch (typename std::conditional< std::is_same<typename
std::remove_cv<typename std::remove_reference< DhcpConfigError
>::type>::type, std::exception>::value, const ::testing
::internal::NeverThrown&, const std::exception&>::
type e) { gtest_msg.value = "Expected: " "SimpleParser::checkKeywords(KEYWORDS, bad_prefix)"
" throws an exception of type " "DhcpConfigError" ".\n Actual: it throws "
; gtest_msg.value += ::testing::internal::GetTypeName(typeid(
e)); gtest_msg.value += " with description \""; gtest_msg.value
+= e.what(); gtest_msg.value += "\"."; goto gtest_label_testthrow_129
; } 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_129; } 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_129; } } else gtest_label_testthrow_129
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 129, gtest_msg.value.c_str()) = ::testing::Message()
129 DhcpConfigError)switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { bool gtest_caught_expected = false; try { if (
::testing::internal::AlwaysTrue()) { SimpleParser::checkKeywords
(KEYWORDS, bad_prefix); } else static_assert(true, ""); } catch
(DhcpConfigError const&) { gtest_caught_expected = true;
} catch (typename std::conditional< std::is_same<typename
std::remove_cv<typename std::remove_reference< DhcpConfigError
>::type>::type, std::exception>::value, const ::testing
::internal::NeverThrown&, const std::exception&>::
type e) { gtest_msg.value = "Expected: " "SimpleParser::checkKeywords(KEYWORDS, bad_prefix)"
" throws an exception of type " "DhcpConfigError" ".\n Actual: it throws "
; gtest_msg.value += ::testing::internal::GetTypeName(typeid(
e)); gtest_msg.value += " with description \""; gtest_msg.value
+= e.what(); gtest_msg.value += "\"."; goto gtest_label_testthrow_129
; } 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_129; } 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_129; } } else gtest_label_testthrow_129
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 129, gtest_msg.value.c_str()) = ::testing::Message()
;
130 ConstElementPtr bad_map = Element::fromJSON("{ \"map\": [ ] }");
131 EXPECT_THROW(SimpleParser::checkKeywords(KEYWORDS, bad_map),switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { bool gtest_caught_expected = false; try { if (
::testing::internal::AlwaysTrue()) { SimpleParser::checkKeywords
(KEYWORDS, bad_map); } else static_assert(true, ""); } catch (
DhcpConfigError const&) { gtest_caught_expected = true; }
catch (typename std::conditional< std::is_same<typename
std::remove_cv<typename std::remove_reference< DhcpConfigError
>::type>::type, std::exception>::value, const ::testing
::internal::NeverThrown&, const std::exception&>::
type e) { gtest_msg.value = "Expected: " "SimpleParser::checkKeywords(KEYWORDS, bad_map)"
" throws an exception of type " "DhcpConfigError" ".\n Actual: it throws "
; gtest_msg.value += ::testing::internal::GetTypeName(typeid(
e)); gtest_msg.value += " with description \""; gtest_msg.value
+= e.what(); gtest_msg.value += "\"."; goto gtest_label_testthrow_132
; } 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_132; } 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_132; } } else gtest_label_testthrow_132
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 132, gtest_msg.value.c_str()) = ::testing::Message()
132 DhcpConfigError)switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { bool gtest_caught_expected = false; try { if (
::testing::internal::AlwaysTrue()) { SimpleParser::checkKeywords
(KEYWORDS, bad_map); } else static_assert(true, ""); } catch (
DhcpConfigError const&) { gtest_caught_expected = true; }
catch (typename std::conditional< std::is_same<typename
std::remove_cv<typename std::remove_reference< DhcpConfigError
>::type>::type, std::exception>::value, const ::testing
::internal::NeverThrown&, const std::exception&>::
type e) { gtest_msg.value = "Expected: " "SimpleParser::checkKeywords(KEYWORDS, bad_map)"
" throws an exception of type " "DhcpConfigError" ".\n Actual: it throws "
; gtest_msg.value += ::testing::internal::GetTypeName(typeid(
e)); gtest_msg.value += " with description \""; gtest_msg.value
+= e.what(); gtest_msg.value += "\"."; goto gtest_label_testthrow_132
; } 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_132; } 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_132; } } else gtest_label_testthrow_132
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 132, gtest_msg.value.c_str()) = ::testing::Message()
;
133 ConstElementPtr spurious = Element::fromJSON("{ \"spurious\": 1 }");
134 EXPECT_THROW(SimpleParser::checkKeywords(KEYWORDS, spurious),switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { bool gtest_caught_expected = false; try { if (
::testing::internal::AlwaysTrue()) { SimpleParser::checkKeywords
(KEYWORDS, spurious); } else static_assert(true, ""); } catch
(DhcpConfigError const&) { gtest_caught_expected = true;
} catch (typename std::conditional< std::is_same<typename
std::remove_cv<typename std::remove_reference< DhcpConfigError
>::type>::type, std::exception>::value, const ::testing
::internal::NeverThrown&, const std::exception&>::
type e) { gtest_msg.value = "Expected: " "SimpleParser::checkKeywords(KEYWORDS, spurious)"
" throws an exception of type " "DhcpConfigError" ".\n Actual: it throws "
; gtest_msg.value += ::testing::internal::GetTypeName(typeid(
e)); gtest_msg.value += " with description \""; gtest_msg.value
+= e.what(); gtest_msg.value += "\"."; goto gtest_label_testthrow_135
; } 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_135; } 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_135; } } else gtest_label_testthrow_135
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 135, gtest_msg.value.c_str()) = ::testing::Message()
135 DhcpConfigError)switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { bool gtest_caught_expected = false; try { if (
::testing::internal::AlwaysTrue()) { SimpleParser::checkKeywords
(KEYWORDS, spurious); } else static_assert(true, ""); } catch
(DhcpConfigError const&) { gtest_caught_expected = true;
} catch (typename std::conditional< std::is_same<typename
std::remove_cv<typename std::remove_reference< DhcpConfigError
>::type>::type, std::exception>::value, const ::testing
::internal::NeverThrown&, const std::exception&>::
type e) { gtest_msg.value = "Expected: " "SimpleParser::checkKeywords(KEYWORDS, spurious)"
" throws an exception of type " "DhcpConfigError" ".\n Actual: it throws "
; gtest_msg.value += ::testing::internal::GetTypeName(typeid(
e)); gtest_msg.value += " with description \""; gtest_msg.value
+= e.what(); gtest_msg.value += "\"."; goto gtest_label_testthrow_135
; } 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_135; } 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_135; } } else gtest_label_testthrow_135
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 135, gtest_msg.value.c_str()) = ::testing::Message()
;
136
137 // Bad type has precedence.
138 ConstElementPtr bad = Element::fromJSON("{ \"spurious\": 1, \"id\": true }");
139 try {
140 SimpleParser::checkKeywords(KEYWORDS, bad);
141 ADD_FAILURE()::testing::internal::AssertHelper(::testing::TestPartResult::
kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 141, "Failed") = ::testing::Message()
<< "expect exception";
142 } catch (const DhcpConfigError& ex) {
143 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, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 143, gtest_ar.failure_message()) = ::testing::Message()
;
144 } catch (...) {
145 ADD_FAILURE()::testing::internal::AssertHelper(::testing::TestPartResult::
kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 145, "Failed") = ::testing::Message()
<< "expect DhcpConfigError";
146 }
147}
148
149// This test checks if the parameters can be inherited from the global
150// scope to the subnet scope.
151TEST_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() = default; ~SimpleParserTest_deriveParams_Test
() override = default; SimpleParserTest_deriveParams_Test (const
SimpleParserTest_deriveParams_Test &) = delete; SimpleParserTest_deriveParams_Test
& operator=( const SimpleParserTest_deriveParams_Test &
) = delete; SimpleParserTest_deriveParams_Test (SimpleParserTest_deriveParams_Test
&&) noexcept = delete; SimpleParserTest_deriveParams_Test
& operator=( SimpleParserTest_deriveParams_Test &&
) noexcept = delete; private: void TestBody() override; [[maybe_unused
]] static ::testing::TestInfo* const test_info_; }; ::testing
::TestInfo* const SimpleParserTest_deriveParams_Test::test_info_
= ::testing::internal::MakeAndRegisterTestInfo( "SimpleParserTest"
, "deriveParams", nullptr, nullptr, ::testing::internal::CodeLocation
("../../../src/lib/cc/tests/simple_parser_unittest.cc", 151),
(::testing::internal::GetTypeId<SimpleParserTest>()), ::
testing::internal::SuiteApiResolver< SimpleParserTest>::
GetSetUpCaseOrSuite("../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 151), ::testing::internal::SuiteApiResolver< SimpleParserTest
>::GetTearDownCaseOrSuite("../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 151), new ::testing::internal::TestFactoryImpl<SimpleParserTest_deriveParams_Test
>); void SimpleParserTest_deriveParams_Test::TestBody()
{
152 ElementPtr global = Element::fromJSON("{ \"renew-timer\": 1,"
153 " \"rebind-timer\": 2,"
154 " \"preferred-lifetime\": 3,"
155 " \"valid-lifetime\": 4"
156 "}");
157 ElementPtr subnet = Element::fromJSON("{ \"renew-timer\": 100 }");
158
159 // we should inherit 3 parameters. Renew-timer should remain intact,
160 // as it was already defined in the subnet scope.
161 size_t num;
1
'num' declared without an initial value
162 EXPECT_NO_THROW(num = SimpleParser::deriveParams(global, subnet,switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { try { if (::testing::internal::AlwaysTrue()) {
num = SimpleParser::deriveParams(global, subnet, SAMPLE_INHERITS
); } else static_assert(true, ""); } catch (std::exception const
& e) { gtest_msg.value = "it throws "; gtest_msg.value +=
::testing::internal::GetTypeName(typeid(e)); gtest_msg.value
+= " with description \""; gtest_msg.value += e.what(); gtest_msg
.value += "\"."; goto gtest_label_testnothrow_163; } catch (...
) { gtest_msg.value = "it throws."; goto gtest_label_testnothrow_163
; } } else gtest_label_testnothrow_163 : ::testing::internal::
AssertHelper(::testing::TestPartResult::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 163, ("Expected: " "num = SimpleParser::deriveParams(global, subnet, SAMPLE_INHERITS)"
" doesn't throw an exception.\n" " Actual: " + gtest_msg.value
) .c_str()) = ::testing::Message()
2
Control jumps to 'case 0:' at line 162
3
Taking true branch
4
Assuming the condition is false
5
Taking false branch
163 SAMPLE_INHERITS))switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { try { if (::testing::internal::AlwaysTrue()) {
num = SimpleParser::deriveParams(global, subnet, SAMPLE_INHERITS
); } else static_assert(true, ""); } catch (std::exception const
& e) { gtest_msg.value = "it throws "; gtest_msg.value +=
::testing::internal::GetTypeName(typeid(e)); gtest_msg.value
+= " with description \""; gtest_msg.value += e.what(); gtest_msg
.value += "\"."; goto gtest_label_testnothrow_163; } catch (...
) { gtest_msg.value = "it throws."; goto gtest_label_testnothrow_163
; } } else gtest_label_testnothrow_163 : ::testing::internal::
AssertHelper(::testing::TestPartResult::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 163, ("Expected: " "num = SimpleParser::deriveParams(global, subnet, SAMPLE_INHERITS)"
" doesn't throw an exception.\n" " Actual: " + gtest_msg.value
) .c_str()) = ::testing::Message()
;
164 EXPECT_EQ(3U, num)switch (0) case 0: default: if (const ::testing::AssertionResult
gtest_ar = (::testing::internal::EqHelper::Compare("3U", "num"
, 3U, num))) ; else ::testing::internal::AssertHelper(::testing
::TestPartResult::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 164, gtest_ar.failure_message()) = ::testing::Message()
;
6
Control jumps to 'case 0:' at line 164
7
Passing value via 4th parameter 'rhs'
8
Calling 'EqHelper::Compare'
165
166 // Check the values. 3 of them are inherited, while the fourth one
167 // was already defined in the subnet, so should not be inherited.
168 checkIntegerValue(subnet, "renew-timer", 100);
169 checkIntegerValue(subnet, "rebind-timer", 2);
170 checkIntegerValue(subnet, "preferred-lifetime", 3);
171 checkIntegerValue(subnet, "valid-lifetime", 4);
172}
173
174// This test checks if global defaults are properly set for DHCPv6.
175TEST_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() = default; ~SimpleParserTest_setDefaults_Test
() override = default; SimpleParserTest_setDefaults_Test (const
SimpleParserTest_setDefaults_Test &) = delete; SimpleParserTest_setDefaults_Test
& operator=( const SimpleParserTest_setDefaults_Test &
) = delete; SimpleParserTest_setDefaults_Test (SimpleParserTest_setDefaults_Test
&&) noexcept = delete; SimpleParserTest_setDefaults_Test
& operator=( SimpleParserTest_setDefaults_Test &&
) noexcept = delete; private: void TestBody() override; [[maybe_unused
]] static ::testing::TestInfo* const test_info_; }; ::testing
::TestInfo* const SimpleParserTest_setDefaults_Test::test_info_
= ::testing::internal::MakeAndRegisterTestInfo( "SimpleParserTest"
, "setDefaults", nullptr, nullptr, ::testing::internal::CodeLocation
("../../../src/lib/cc/tests/simple_parser_unittest.cc", 175),
(::testing::internal::GetTypeId<SimpleParserTest>()), ::
testing::internal::SuiteApiResolver< SimpleParserTest>::
GetSetUpCaseOrSuite("../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 175), ::testing::internal::SuiteApiResolver< SimpleParserTest
>::GetTearDownCaseOrSuite("../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 175), new ::testing::internal::TestFactoryImpl<SimpleParserTest_setDefaults_Test
>); void SimpleParserTest_setDefaults_Test::TestBody()
{
176
177 ElementPtr empty = Element::fromJSON("{ }");
178 size_t num = 0;
179
180 EXPECT_NO_THROW(num = SimpleParser::setDefaults(empty, SAMPLE_DEFAULTS))switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { try { if (::testing::internal::AlwaysTrue()) {
num = SimpleParser::setDefaults(empty, SAMPLE_DEFAULTS); } else
static_assert(true, ""); } catch (std::exception const& e
) { gtest_msg.value = "it throws "; gtest_msg.value += ::testing
::internal::GetTypeName(typeid(e)); gtest_msg.value += " with description \""
; gtest_msg.value += e.what(); gtest_msg.value += "\"."; goto
gtest_label_testnothrow_180; } catch (...) { gtest_msg.value
= "it throws."; goto gtest_label_testnothrow_180; } } else gtest_label_testnothrow_180
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 180, ("Expected: " "num = SimpleParser::setDefaults(empty, SAMPLE_DEFAULTS)"
" doesn't throw an exception.\n" " Actual: " + gtest_msg.value
) .c_str()) = ::testing::Message()
;
181
182 // We expect at least 4 parameters to be inserted.
183 EXPECT_GE(num, 3U)switch (0) case 0: default: if (const ::testing::AssertionResult
gtest_ar = (::testing::internal::CmpHelperGE("num", "3U", num
, 3U))) ; else ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 183, gtest_ar.failure_message()) = ::testing::Message()
;
184
185 checkIntegerValue(empty, "valid-lifetime", 7200);
186 checkIntegerValue(empty, "preferred-lifetime", 3600);
187 checkIntegerValue(empty, "rebind-timer", 1800);
188 checkIntegerValue(empty, "renew-timer", 900);
189}
190
191// This test checks if global defaults are properly set for DHCPv6.
192TEST_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() = default;
~SimpleParserTest_setListDefaults_Test() override = default;
SimpleParserTest_setListDefaults_Test (const SimpleParserTest_setListDefaults_Test
&) = delete; SimpleParserTest_setListDefaults_Test &
operator=( const SimpleParserTest_setListDefaults_Test &
) = delete; SimpleParserTest_setListDefaults_Test (SimpleParserTest_setListDefaults_Test
&&) noexcept = delete; SimpleParserTest_setListDefaults_Test
& operator=( SimpleParserTest_setListDefaults_Test &&
) noexcept = delete; private: void TestBody() override; [[maybe_unused
]] static ::testing::TestInfo* const test_info_; }; ::testing
::TestInfo* const SimpleParserTest_setListDefaults_Test::test_info_
= ::testing::internal::MakeAndRegisterTestInfo( "SimpleParserTest"
, "setListDefaults", nullptr, nullptr, ::testing::internal::CodeLocation
("../../../src/lib/cc/tests/simple_parser_unittest.cc", 192),
(::testing::internal::GetTypeId<SimpleParserTest>()), ::
testing::internal::SuiteApiResolver< SimpleParserTest>::
GetSetUpCaseOrSuite("../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 192), ::testing::internal::SuiteApiResolver< SimpleParserTest
>::GetTearDownCaseOrSuite("../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 192), new ::testing::internal::TestFactoryImpl<SimpleParserTest_setListDefaults_Test
>); void SimpleParserTest_setListDefaults_Test::TestBody()
{
193
194 ElementPtr empty = Element::fromJSON("[{}, {}, {}]");
195 size_t num;
196
197 EXPECT_NO_THROW(num = SimpleParser::setListDefaults(empty, SAMPLE_DEFAULTS))switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { try { if (::testing::internal::AlwaysTrue()) {
num = SimpleParser::setListDefaults(empty, SAMPLE_DEFAULTS);
} else static_assert(true, ""); } catch (std::exception const
& e) { gtest_msg.value = "it throws "; gtest_msg.value +=
::testing::internal::GetTypeName(typeid(e)); gtest_msg.value
+= " with description \""; gtest_msg.value += e.what(); gtest_msg
.value += "\"."; goto gtest_label_testnothrow_197; } catch (...
) { gtest_msg.value = "it throws."; goto gtest_label_testnothrow_197
; } } else gtest_label_testnothrow_197 : ::testing::internal::
AssertHelper(::testing::TestPartResult::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 197, ("Expected: " "num = SimpleParser::setListDefaults(empty, SAMPLE_DEFAULTS)"
" doesn't throw an exception.\n" " Actual: " + gtest_msg.value
) .c_str()) = ::testing::Message()
;
198
199 // We expect at least 12 parameters to be inserted (3 entries, with
200 // 4 parameters inserted in each)
201 EXPECT_EQ(12U, num)switch (0) case 0: default: if (const ::testing::AssertionResult
gtest_ar = (::testing::internal::EqHelper::Compare("12U", "num"
, 12U, num))) ; else ::testing::internal::AssertHelper(::testing
::TestPartResult::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 201, gtest_ar.failure_message()) = ::testing::Message()
;
202
203 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, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 203, gtest_ar.failure_message()) = ::testing::Message()
;
204 ASSERT_EQ(3U, empty->size())switch (0) case 0: default: if (const ::testing::AssertionResult
gtest_ar = (::testing::internal::EqHelper::Compare("3U", "empty->size()"
, 3U, empty->size()))) ; else return ::testing::internal::
AssertHelper(::testing::TestPartResult::kFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 204, gtest_ar.failure_message()) = ::testing::Message()
;
205
206 ConstElementPtr first = empty->get(0);
207 ConstElementPtr second = empty->get(1);
208 ConstElementPtr third = empty->get(2);
209
210 checkIntegerValue(first, "valid-lifetime", 7200);
211 checkIntegerValue(first, "preferred-lifetime", 3600);
212 checkIntegerValue(first, "rebind-timer", 1800);
213 checkIntegerValue(first, "renew-timer", 900);
214
215 checkIntegerValue(second, "valid-lifetime", 7200);
216 checkIntegerValue(second, "preferred-lifetime", 3600);
217 checkIntegerValue(second, "rebind-timer", 1800);
218 checkIntegerValue(second, "renew-timer", 900);
219
220 checkIntegerValue(third, "valid-lifetime", 7200);
221 checkIntegerValue(third, "preferred-lifetime", 3600);
222 checkIntegerValue(third, "rebind-timer", 1800);
223 checkIntegerValue(third, "renew-timer", 900);
224}
225
226// This test exercises the getIntType template
227TEST_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() = default; ~SimpleParserTest_getIntType_Test
() override = default; SimpleParserTest_getIntType_Test (const
SimpleParserTest_getIntType_Test &) = delete; SimpleParserTest_getIntType_Test
& operator=( const SimpleParserTest_getIntType_Test &
) = delete; SimpleParserTest_getIntType_Test (SimpleParserTest_getIntType_Test
&&) noexcept = delete; SimpleParserTest_getIntType_Test
& operator=( SimpleParserTest_getIntType_Test &&
) noexcept = delete; private: void TestBody() override; [[maybe_unused
]] static ::testing::TestInfo* const test_info_; }; ::testing
::TestInfo* const SimpleParserTest_getIntType_Test::test_info_
= ::testing::internal::MakeAndRegisterTestInfo( "SimpleParserTest"
, "getIntType", nullptr, nullptr, ::testing::internal::CodeLocation
("../../../src/lib/cc/tests/simple_parser_unittest.cc", 227),
(::testing::internal::GetTypeId<SimpleParserTest>()), ::
testing::internal::SuiteApiResolver< SimpleParserTest>::
GetSetUpCaseOrSuite("../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 227), ::testing::internal::SuiteApiResolver< SimpleParserTest
>::GetTearDownCaseOrSuite("../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 227), new ::testing::internal::TestFactoryImpl<SimpleParserTest_getIntType_Test
>); void SimpleParserTest_getIntType_Test::TestBody()
{
228
229 SimpleParserClassTest parser;
230
231 // getIntType checks it can be found
232 ElementPtr not_found = Element::fromJSON("{ \"bar\": 1 }");
233 EXPECT_THROW(parser.getUint8(not_found, "foo"), DhcpConfigError)switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { bool gtest_caught_expected = false; try { if (
::testing::internal::AlwaysTrue()) { parser.getUint8(not_found
, "foo"); } else static_assert(true, ""); } catch (DhcpConfigError
const&) { gtest_caught_expected = true; } catch (typename
std::conditional< std::is_same<typename std::remove_cv
<typename std::remove_reference< DhcpConfigError>::type
>::type, std::exception>::value, const ::testing::internal
::NeverThrown&, const std::exception&>::type e) { gtest_msg
.value = "Expected: " "parser.getUint8(not_found, \"foo\")" " throws an exception of type "
"DhcpConfigError" ".\n Actual: it throws "; gtest_msg.value
+= ::testing::internal::GetTypeName(typeid(e)); gtest_msg.value
+= " with description \""; gtest_msg.value += e.what(); gtest_msg
.value += "\"."; goto gtest_label_testthrow_233; } 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_233; } 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_233; } } else gtest_label_testthrow_233
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 233, gtest_msg.value.c_str()) = ::testing::Message()
;
234
235 // getIntType checks if it is an integer
236 ElementPtr not_int = Element::fromJSON("{ \"foo\": \"xyz\" }");
237 EXPECT_THROW(parser.getUint8(not_int, "foo"), DhcpConfigError)switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { bool gtest_caught_expected = false; try { if (
::testing::internal::AlwaysTrue()) { parser.getUint8(not_int,
"foo"); } else static_assert(true, ""); } catch (DhcpConfigError
const&) { gtest_caught_expected = true; } catch (typename
std::conditional< std::is_same<typename std::remove_cv
<typename std::remove_reference< DhcpConfigError>::type
>::type, std::exception>::value, const ::testing::internal
::NeverThrown&, const std::exception&>::type e) { gtest_msg
.value = "Expected: " "parser.getUint8(not_int, \"foo\")" " throws an exception of type "
"DhcpConfigError" ".\n Actual: it throws "; gtest_msg.value
+= ::testing::internal::GetTypeName(typeid(e)); gtest_msg.value
+= " with description \""; gtest_msg.value += e.what(); gtest_msg
.value += "\"."; goto gtest_label_testthrow_237; } 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_237; } 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_237; } } else gtest_label_testthrow_237
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 237, gtest_msg.value.c_str()) = ::testing::Message()
;
238
239 // getIntType checks bounds
240 ElementPtr negative = Element::fromJSON("{ \"foo\": -1 }");
241 EXPECT_THROW(parser.getUint8(negative, "foo"), DhcpConfigError)switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { bool gtest_caught_expected = false; try { if (
::testing::internal::AlwaysTrue()) { parser.getUint8(negative
, "foo"); } else static_assert(true, ""); } catch (DhcpConfigError
const&) { gtest_caught_expected = true; } catch (typename
std::conditional< std::is_same<typename std::remove_cv
<typename std::remove_reference< DhcpConfigError>::type
>::type, std::exception>::value, const ::testing::internal
::NeverThrown&, const std::exception&>::type e) { gtest_msg
.value = "Expected: " "parser.getUint8(negative, \"foo\")" " throws an exception of type "
"DhcpConfigError" ".\n Actual: it throws "; gtest_msg.value
+= ::testing::internal::GetTypeName(typeid(e)); gtest_msg.value
+= " with description \""; gtest_msg.value += e.what(); gtest_msg
.value += "\"."; goto gtest_label_testthrow_241; } 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_241; } 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_241; } } else gtest_label_testthrow_241
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 241, gtest_msg.value.c_str()) = ::testing::Message()
;
242 ElementPtr too_large = Element::fromJSON("{ \"foo\": 1024 }");
243 EXPECT_THROW(parser.getUint8(too_large, "foo"), DhcpConfigError)switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { bool gtest_caught_expected = false; try { if (
::testing::internal::AlwaysTrue()) { parser.getUint8(too_large
, "foo"); } else static_assert(true, ""); } catch (DhcpConfigError
const&) { gtest_caught_expected = true; } catch (typename
std::conditional< std::is_same<typename std::remove_cv
<typename std::remove_reference< DhcpConfigError>::type
>::type, std::exception>::value, const ::testing::internal
::NeverThrown&, const std::exception&>::type e) { gtest_msg
.value = "Expected: " "parser.getUint8(too_large, \"foo\")" " throws an exception of type "
"DhcpConfigError" ".\n Actual: it throws "; gtest_msg.value
+= ::testing::internal::GetTypeName(typeid(e)); gtest_msg.value
+= " with description \""; gtest_msg.value += e.what(); gtest_msg
.value += "\"."; goto gtest_label_testthrow_243; } 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_243; } 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_243; } } else gtest_label_testthrow_243
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 243, gtest_msg.value.c_str()) = ::testing::Message()
;
244
245 // checks if getIntType can return the expected value
246 ElementPtr hundred = Element::fromJSON("{ \"foo\": 100 }");
247 uint8_t val = 0;
248 EXPECT_NO_THROW(val = parser.getUint8(hundred, "foo"))switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { try { if (::testing::internal::AlwaysTrue()) {
val = parser.getUint8(hundred, "foo"); } else static_assert(
true, ""); } catch (std::exception const& e) { gtest_msg.
value = "it throws "; gtest_msg.value += ::testing::internal::
GetTypeName(typeid(e)); gtest_msg.value += " with description \""
; gtest_msg.value += e.what(); gtest_msg.value += "\"."; goto
gtest_label_testnothrow_248; } catch (...) { gtest_msg.value
= "it throws."; goto gtest_label_testnothrow_248; } } else gtest_label_testnothrow_248
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 248, ("Expected: " "val = parser.getUint8(hundred, \"foo\")"
" doesn't throw an exception.\n" " Actual: " + gtest_msg.value
) .c_str()) = ::testing::Message()
;
249 EXPECT_EQ(100U, val)switch (0) case 0: default: if (const ::testing::AssertionResult
gtest_ar = (::testing::internal::EqHelper::Compare("100U", "val"
, 100U, val))) ; else ::testing::internal::AssertHelper(::testing
::TestPartResult::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 249, gtest_ar.failure_message()) = ::testing::Message()
;
250}
251
252// This test exercises the getInteger with range checking
253TEST_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() = default; ~SimpleParserTest_getInteger_Test
() override = default; SimpleParserTest_getInteger_Test (const
SimpleParserTest_getInteger_Test &) = delete; SimpleParserTest_getInteger_Test
& operator=( const SimpleParserTest_getInteger_Test &
) = delete; SimpleParserTest_getInteger_Test (SimpleParserTest_getInteger_Test
&&) noexcept = delete; SimpleParserTest_getInteger_Test
& operator=( SimpleParserTest_getInteger_Test &&
) noexcept = delete; private: void TestBody() override; [[maybe_unused
]] static ::testing::TestInfo* const test_info_; }; ::testing
::TestInfo* const SimpleParserTest_getInteger_Test::test_info_
= ::testing::internal::MakeAndRegisterTestInfo( "SimpleParserTest"
, "getInteger", nullptr, nullptr, ::testing::internal::CodeLocation
("../../../src/lib/cc/tests/simple_parser_unittest.cc", 253),
(::testing::internal::GetTypeId<SimpleParserTest>()), ::
testing::internal::SuiteApiResolver< SimpleParserTest>::
GetSetUpCaseOrSuite("../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 253), ::testing::internal::SuiteApiResolver< SimpleParserTest
>::GetTearDownCaseOrSuite("../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 253), new ::testing::internal::TestFactoryImpl<SimpleParserTest_getInteger_Test
>); void SimpleParserTest_getInteger_Test::TestBody()
{
254
255 // The value specified is 100.
256 ElementPtr json = Element::fromJSON("{ \"bar\": 100 }");
257 int64_t x = -1;
258
259 // Positive case: we expect value in range 0..200. All ok.
260 EXPECT_NO_THROW(x = SimpleParser::getInteger(json, "bar", 0, 200))switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { try { if (::testing::internal::AlwaysTrue()) {
x = SimpleParser::getInteger(json, "bar", 0, 200); } else static_assert
(true, ""); } catch (std::exception const& e) { gtest_msg
.value = "it throws "; gtest_msg.value += ::testing::internal
::GetTypeName(typeid(e)); gtest_msg.value += " with description \""
; gtest_msg.value += e.what(); gtest_msg.value += "\"."; goto
gtest_label_testnothrow_260; } catch (...) { gtest_msg.value
= "it throws."; goto gtest_label_testnothrow_260; } } else gtest_label_testnothrow_260
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 260, ("Expected: " "x = SimpleParser::getInteger(json, \"bar\", 0, 200)"
" doesn't throw an exception.\n" " Actual: " + gtest_msg.value
) .c_str()) = ::testing::Message()
;
261 EXPECT_EQ(100U, x)switch (0) case 0: default: if (const ::testing::AssertionResult
gtest_ar = (::testing::internal::EqHelper::Compare("100U", "x"
, 100U, x))) ; else ::testing::internal::AssertHelper(::testing
::TestPartResult::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 261, gtest_ar.failure_message()) = ::testing::Message()
;
262
263 // Border checks: 100 for 100..200 range is still ok.
264 EXPECT_NO_THROW(x = SimpleParser::getInteger(json, "bar", 100, 200))switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { try { if (::testing::internal::AlwaysTrue()) {
x = SimpleParser::getInteger(json, "bar", 100, 200); } else static_assert
(true, ""); } catch (std::exception const& e) { gtest_msg
.value = "it throws "; gtest_msg.value += ::testing::internal
::GetTypeName(typeid(e)); gtest_msg.value += " with description \""
; gtest_msg.value += e.what(); gtest_msg.value += "\"."; goto
gtest_label_testnothrow_264; } catch (...) { gtest_msg.value
= "it throws."; goto gtest_label_testnothrow_264; } } else gtest_label_testnothrow_264
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 264, ("Expected: " "x = SimpleParser::getInteger(json, \"bar\", 100, 200)"
" doesn't throw an exception.\n" " Actual: " + gtest_msg.value
) .c_str()) = ::testing::Message()
;
265 // Border checks: 100 for 1..100 range is still ok.
266 EXPECT_NO_THROW(x = SimpleParser::getInteger(json, "bar", 1, 100))switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { try { if (::testing::internal::AlwaysTrue()) {
x = SimpleParser::getInteger(json, "bar", 1, 100); } else static_assert
(true, ""); } catch (std::exception const& e) { gtest_msg
.value = "it throws "; gtest_msg.value += ::testing::internal
::GetTypeName(typeid(e)); gtest_msg.value += " with description \""
; gtest_msg.value += e.what(); gtest_msg.value += "\"."; goto
gtest_label_testnothrow_266; } catch (...) { gtest_msg.value
= "it throws."; goto gtest_label_testnothrow_266; } } else gtest_label_testnothrow_266
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 266, ("Expected: " "x = SimpleParser::getInteger(json, \"bar\", 1, 100)"
" doesn't throw an exception.\n" " Actual: " + gtest_msg.value
) .c_str()) = ::testing::Message()
;
267
268 // Out of expected range. Should throw.
269 EXPECT_THROW(x = SimpleParser::getInteger(json, "bar", 101, 200), OutOfRange)switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { bool gtest_caught_expected = false; try { if (
::testing::internal::AlwaysTrue()) { x = SimpleParser::getInteger
(json, "bar", 101, 200); } else static_assert(true, ""); } catch
(OutOfRange const&) { gtest_caught_expected = true; } catch
(typename std::conditional< std::is_same<typename std::
remove_cv<typename std::remove_reference< OutOfRange>
::type>::type, std::exception>::value, const ::testing::
internal::NeverThrown&, const std::exception&>::type
e) { gtest_msg.value = "Expected: " "x = SimpleParser::getInteger(json, \"bar\", 101, 200)"
" throws an exception of type " "OutOfRange" ".\n Actual: it throws "
; gtest_msg.value += ::testing::internal::GetTypeName(typeid(
e)); gtest_msg.value += " with description \""; gtest_msg.value
+= e.what(); gtest_msg.value += "\"."; goto gtest_label_testthrow_269
; } 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_269; } 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_269; } } else gtest_label_testthrow_269
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 269, gtest_msg.value.c_str()) = ::testing::Message()
;
270 EXPECT_THROW(x = SimpleParser::getInteger(json, "bar", 1, 99), OutOfRange)switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { bool gtest_caught_expected = false; try { if (
::testing::internal::AlwaysTrue()) { x = SimpleParser::getInteger
(json, "bar", 1, 99); } else static_assert(true, ""); } catch
(OutOfRange const&) { gtest_caught_expected = true; } catch
(typename std::conditional< std::is_same<typename std::
remove_cv<typename std::remove_reference< OutOfRange>
::type>::type, std::exception>::value, const ::testing::
internal::NeverThrown&, const std::exception&>::type
e) { gtest_msg.value = "Expected: " "x = SimpleParser::getInteger(json, \"bar\", 1, 99)"
" throws an exception of type " "OutOfRange" ".\n Actual: it throws "
; gtest_msg.value += ::testing::internal::GetTypeName(typeid(
e)); gtest_msg.value += " with description \""; gtest_msg.value
+= e.what(); gtest_msg.value += "\"."; goto gtest_label_testthrow_270
; } 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_270; } 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_270; } } else gtest_label_testthrow_270
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 270, gtest_msg.value.c_str()) = ::testing::Message()
;
271}
272
273// This test exercises the getAndConvert template
274TEST_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() = default; ~
SimpleParserTest_getAndConvert_Test() override = default; SimpleParserTest_getAndConvert_Test
(const SimpleParserTest_getAndConvert_Test &) = delete; SimpleParserTest_getAndConvert_Test
& operator=( const SimpleParserTest_getAndConvert_Test &
) = delete; SimpleParserTest_getAndConvert_Test (SimpleParserTest_getAndConvert_Test
&&) noexcept = delete; SimpleParserTest_getAndConvert_Test
& operator=( SimpleParserTest_getAndConvert_Test &&
) noexcept = delete; private: void TestBody() override; [[maybe_unused
]] static ::testing::TestInfo* const test_info_; }; ::testing
::TestInfo* const SimpleParserTest_getAndConvert_Test::test_info_
= ::testing::internal::MakeAndRegisterTestInfo( "SimpleParserTest"
, "getAndConvert", nullptr, nullptr, ::testing::internal::CodeLocation
("../../../src/lib/cc/tests/simple_parser_unittest.cc", 274),
(::testing::internal::GetTypeId<SimpleParserTest>()), ::
testing::internal::SuiteApiResolver< SimpleParserTest>::
GetSetUpCaseOrSuite("../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 274), ::testing::internal::SuiteApiResolver< SimpleParserTest
>::GetTearDownCaseOrSuite("../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 274), new ::testing::internal::TestFactoryImpl<SimpleParserTest_getAndConvert_Test
>); void SimpleParserTest_getAndConvert_Test::TestBody()
{
275
276 SimpleParserClassTest parser;
277
278 // getAndConvert checks it can be found
279 ElementPtr not_found = Element::fromJSON("{ \"bar\": \"true\" }");
280 EXPECT_THROW(parser.getAsBool(not_found, "foo"), DhcpConfigError)switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { bool gtest_caught_expected = false; try { if (
::testing::internal::AlwaysTrue()) { parser.getAsBool(not_found
, "foo"); } else static_assert(true, ""); } catch (DhcpConfigError
const&) { gtest_caught_expected = true; } catch (typename
std::conditional< std::is_same<typename std::remove_cv
<typename std::remove_reference< DhcpConfigError>::type
>::type, std::exception>::value, const ::testing::internal
::NeverThrown&, const std::exception&>::type e) { gtest_msg
.value = "Expected: " "parser.getAsBool(not_found, \"foo\")" " throws an exception of type "
"DhcpConfigError" ".\n Actual: it throws "; gtest_msg.value
+= ::testing::internal::GetTypeName(typeid(e)); gtest_msg.value
+= " with description \""; gtest_msg.value += e.what(); gtest_msg
.value += "\"."; goto gtest_label_testthrow_280; } 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_280; } 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_280; } } else gtest_label_testthrow_280
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 280, gtest_msg.value.c_str()) = ::testing::Message()
;
281
282 // getAndConvert checks if it is a string
283 ElementPtr not_bool = Element::fromJSON("{ \"foo\": 1 }");
284 EXPECT_THROW(parser.getAsBool(not_bool, "foo"), DhcpConfigError)switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { bool gtest_caught_expected = false; try { if (
::testing::internal::AlwaysTrue()) { parser.getAsBool(not_bool
, "foo"); } else static_assert(true, ""); } catch (DhcpConfigError
const&) { gtest_caught_expected = true; } catch (typename
std::conditional< std::is_same<typename std::remove_cv
<typename std::remove_reference< DhcpConfigError>::type
>::type, std::exception>::value, const ::testing::internal
::NeverThrown&, const std::exception&>::type e) { gtest_msg
.value = "Expected: " "parser.getAsBool(not_bool, \"foo\")" " throws an exception of type "
"DhcpConfigError" ".\n Actual: it throws "; gtest_msg.value
+= ::testing::internal::GetTypeName(typeid(e)); gtest_msg.value
+= " with description \""; gtest_msg.value += e.what(); gtest_msg
.value += "\"."; goto gtest_label_testthrow_284; } 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_284; } 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_284; } } else gtest_label_testthrow_284
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 284, gtest_msg.value.c_str()) = ::testing::Message()
;
285
286 // checks if getAndConvert can return the expected value
287 ElementPtr a_bool = Element::fromJSON("{ \"foo\": \"false\" }");
288 bool val = true;
289 EXPECT_NO_THROW(val = parser.getAsBool(a_bool, "foo"))switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { try { if (::testing::internal::AlwaysTrue()) {
val = parser.getAsBool(a_bool, "foo"); } else static_assert(
true, ""); } catch (std::exception const& e) { gtest_msg.
value = "it throws "; gtest_msg.value += ::testing::internal::
GetTypeName(typeid(e)); gtest_msg.value += " with description \""
; gtest_msg.value += e.what(); gtest_msg.value += "\"."; goto
gtest_label_testnothrow_289; } catch (...) { gtest_msg.value
= "it throws."; goto gtest_label_testnothrow_289; } } else gtest_label_testnothrow_289
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 289, ("Expected: " "val = parser.getAsBool(a_bool, \"foo\")"
" doesn't throw an exception.\n" " Actual: " + gtest_msg.value
) .c_str()) = ::testing::Message()
;
290 EXPECT_FALSE(val)switch (0) case 0: default: if (const ::testing::AssertionResult
gtest_ar_ = ::testing::AssertionResult(!(val))) ; else ::testing
::internal::AssertHelper(::testing::TestPartResult::kNonFatalFailure
, "../../../src/lib/cc/tests/simple_parser_unittest.cc", 290,
::testing::internal::GetBoolAssertionFailureMessage( gtest_ar_
, "val", "true", "false") .c_str()) = ::testing::Message()
;
291
292 // getAndConvert checks conversion
293 ElementPtr bad_bool = Element::fromJSON("{ \"foo\": \"bar\" }");
294 EXPECT_THROW(parser.getAsBool(bad_bool, "bar"), DhcpConfigError)switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { bool gtest_caught_expected = false; try { if (
::testing::internal::AlwaysTrue()) { parser.getAsBool(bad_bool
, "bar"); } else static_assert(true, ""); } catch (DhcpConfigError
const&) { gtest_caught_expected = true; } catch (typename
std::conditional< std::is_same<typename std::remove_cv
<typename std::remove_reference< DhcpConfigError>::type
>::type, std::exception>::value, const ::testing::internal
::NeverThrown&, const std::exception&>::type e) { gtest_msg
.value = "Expected: " "parser.getAsBool(bad_bool, \"bar\")" " throws an exception of type "
"DhcpConfigError" ".\n Actual: it throws "; gtest_msg.value
+= ::testing::internal::GetTypeName(typeid(e)); gtest_msg.value
+= " with description \""; gtest_msg.value += e.what(); gtest_msg
.value += "\"."; goto gtest_label_testthrow_294; } 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_294; } 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_294; } } else gtest_label_testthrow_294
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 294, gtest_msg.value.c_str()) = ::testing::Message()
;
295}
296
297// This test exercises the getIOAddress
298TEST_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() = default; ~SimpleParserTest_getIOAddress_Test
() override = default; SimpleParserTest_getIOAddress_Test (const
SimpleParserTest_getIOAddress_Test &) = delete; SimpleParserTest_getIOAddress_Test
& operator=( const SimpleParserTest_getIOAddress_Test &
) = delete; SimpleParserTest_getIOAddress_Test (SimpleParserTest_getIOAddress_Test
&&) noexcept = delete; SimpleParserTest_getIOAddress_Test
& operator=( SimpleParserTest_getIOAddress_Test &&
) noexcept = delete; private: void TestBody() override; [[maybe_unused
]] static ::testing::TestInfo* const test_info_; }; ::testing
::TestInfo* const SimpleParserTest_getIOAddress_Test::test_info_
= ::testing::internal::MakeAndRegisterTestInfo( "SimpleParserTest"
, "getIOAddress", nullptr, nullptr, ::testing::internal::CodeLocation
("../../../src/lib/cc/tests/simple_parser_unittest.cc", 298),
(::testing::internal::GetTypeId<SimpleParserTest>()), ::
testing::internal::SuiteApiResolver< SimpleParserTest>::
GetSetUpCaseOrSuite("../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 298), ::testing::internal::SuiteApiResolver< SimpleParserTest
>::GetTearDownCaseOrSuite("../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 298), new ::testing::internal::TestFactoryImpl<SimpleParserTest_getIOAddress_Test
>); void SimpleParserTest_getIOAddress_Test::TestBody()
{
299
300 SimpleParserClassTest parser;
301
302 // getAddress checks it can be found
303 ElementPtr not_found = Element::fromJSON("{ \"bar\": 1 }");
304 EXPECT_THROW(parser.getAddress(not_found, "foo"), DhcpConfigError)switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { bool gtest_caught_expected = false; try { if (
::testing::internal::AlwaysTrue()) { parser.getAddress(not_found
, "foo"); } else static_assert(true, ""); } catch (DhcpConfigError
const&) { gtest_caught_expected = true; } catch (typename
std::conditional< std::is_same<typename std::remove_cv
<typename std::remove_reference< DhcpConfigError>::type
>::type, std::exception>::value, const ::testing::internal
::NeverThrown&, const std::exception&>::type e) { gtest_msg
.value = "Expected: " "parser.getAddress(not_found, \"foo\")"
" throws an exception of type " "DhcpConfigError" ".\n Actual: it throws "
; gtest_msg.value += ::testing::internal::GetTypeName(typeid(
e)); gtest_msg.value += " with description \""; gtest_msg.value
+= e.what(); gtest_msg.value += "\"."; goto gtest_label_testthrow_304
; } 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_304; } 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_304; } } else gtest_label_testthrow_304
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 304, gtest_msg.value.c_str()) = ::testing::Message()
;
305
306 // getAddress checks if it is a string
307 ElementPtr not_addr = Element::fromJSON("{ \"foo\": 1234 }");
308 EXPECT_THROW(parser.getAddress(not_addr, "foo"), DhcpConfigError)switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { bool gtest_caught_expected = false; try { if (
::testing::internal::AlwaysTrue()) { parser.getAddress(not_addr
, "foo"); } else static_assert(true, ""); } catch (DhcpConfigError
const&) { gtest_caught_expected = true; } catch (typename
std::conditional< std::is_same<typename std::remove_cv
<typename std::remove_reference< DhcpConfigError>::type
>::type, std::exception>::value, const ::testing::internal
::NeverThrown&, const std::exception&>::type e) { gtest_msg
.value = "Expected: " "parser.getAddress(not_addr, \"foo\")" " throws an exception of type "
"DhcpConfigError" ".\n Actual: it throws "; gtest_msg.value
+= ::testing::internal::GetTypeName(typeid(e)); gtest_msg.value
+= " with description \""; gtest_msg.value += e.what(); gtest_msg
.value += "\"."; goto gtest_label_testthrow_308; } 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_308; } 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_308; } } else gtest_label_testthrow_308
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 308, gtest_msg.value.c_str()) = ::testing::Message()
;
309
310 // checks if getAddress can return the expected value of v4 address
311 ElementPtr v4 = Element::fromJSON("{ \"foo\": \"192.0.2.1\" }");
312 IOAddress val("::");
313 EXPECT_NO_THROW(val = parser.getAddress(v4, "foo"))switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { try { if (::testing::internal::AlwaysTrue()) {
val = parser.getAddress(v4, "foo"); } else static_assert(true
, ""); } catch (std::exception const& e) { gtest_msg.value
= "it throws "; gtest_msg.value += ::testing::internal::GetTypeName
(typeid(e)); gtest_msg.value += " with description \""; gtest_msg
.value += e.what(); gtest_msg.value += "\"."; goto gtest_label_testnothrow_313
; } catch (...) { gtest_msg.value = "it throws."; goto gtest_label_testnothrow_313
; } } else gtest_label_testnothrow_313 : ::testing::internal::
AssertHelper(::testing::TestPartResult::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 313, ("Expected: " "val = parser.getAddress(v4, \"foo\")" " doesn't throw an exception.\n"
" Actual: " + gtest_msg.value) .c_str()) = ::testing::Message
()
;
314 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
, "../../../src/lib/cc/tests/simple_parser_unittest.cc", 314,
gtest_ar.failure_message()) = ::testing::Message()
;
315
316 // checks if getAddress can return the expected value of v4 address
317 ElementPtr v6 = Element::fromJSON("{ \"foo\": \"2001:db8::1\" }");
318 EXPECT_NO_THROW(val = parser.getAddress(v6, "foo"))switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { try { if (::testing::internal::AlwaysTrue()) {
val = parser.getAddress(v6, "foo"); } else static_assert(true
, ""); } catch (std::exception const& e) { gtest_msg.value
= "it throws "; gtest_msg.value += ::testing::internal::GetTypeName
(typeid(e)); gtest_msg.value += " with description \""; gtest_msg
.value += e.what(); gtest_msg.value += "\"."; goto gtest_label_testnothrow_318
; } catch (...) { gtest_msg.value = "it throws."; goto gtest_label_testnothrow_318
; } } else gtest_label_testnothrow_318 : ::testing::internal::
AssertHelper(::testing::TestPartResult::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 318, ("Expected: " "val = parser.getAddress(v6, \"foo\")" " doesn't throw an exception.\n"
" Actual: " + gtest_msg.value) .c_str()) = ::testing::Message
()
;
319 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
, "../../../src/lib/cc/tests/simple_parser_unittest.cc", 319,
gtest_ar.failure_message()) = ::testing::Message()
;
320}
321
322// This test exercises getDouble()
323TEST_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() = default; ~SimpleParserTest_getDouble_Test
() override = default; SimpleParserTest_getDouble_Test (const
SimpleParserTest_getDouble_Test &) = delete; SimpleParserTest_getDouble_Test
& operator=( const SimpleParserTest_getDouble_Test &
) = delete; SimpleParserTest_getDouble_Test (SimpleParserTest_getDouble_Test
&&) noexcept = delete; SimpleParserTest_getDouble_Test
& operator=( SimpleParserTest_getDouble_Test &&)
noexcept = delete; private: void TestBody() override; [[maybe_unused
]] static ::testing::TestInfo* const test_info_; }; ::testing
::TestInfo* const SimpleParserTest_getDouble_Test::test_info_
= ::testing::internal::MakeAndRegisterTestInfo( "SimpleParserTest"
, "getDouble", nullptr, nullptr, ::testing::internal::CodeLocation
("../../../src/lib/cc/tests/simple_parser_unittest.cc", 323),
(::testing::internal::GetTypeId<SimpleParserTest>()), ::
testing::internal::SuiteApiResolver< SimpleParserTest>::
GetSetUpCaseOrSuite("../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 323), ::testing::internal::SuiteApiResolver< SimpleParserTest
>::GetTearDownCaseOrSuite("../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 323), new ::testing::internal::TestFactoryImpl<SimpleParserTest_getDouble_Test
>); void SimpleParserTest_getDouble_Test::TestBody()
{
324
325 SimpleParserClassTest parser;
326 std::string json =
327 "{\n"
328 " \"string\" : \"12.3\",\n"
329 " \"bool\" : true, \n"
330 " \"int\" : 777, \n"
331 " \"map\" : {}, \n"
332 " \"list\" : [], \n"
333 " \"zero\" : 0.0, \n"
334 " \"fraction\" : .75, \n"
335 " \"negative\" : -1.45, \n"
336 " \"positive\" : 346.7 \n"
337 "}\n";
338
339 // Create our test set of parameters.
340 ElementPtr elems;
341 ASSERT_NO_THROW(elems = Element::fromJSON(json))switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { try { if (::testing::internal::AlwaysTrue()) {
elems = Element::fromJSON(json); } else static_assert(true, ""
); } catch (std::exception const& e) { gtest_msg.value = "it throws "
; gtest_msg.value += ::testing::internal::GetTypeName(typeid(
e)); gtest_msg.value += " with description \""; gtest_msg.value
+= e.what(); gtest_msg.value += "\"."; goto gtest_label_testnothrow_341
; } catch (...) { gtest_msg.value = "it throws."; goto gtest_label_testnothrow_341
; } } else gtest_label_testnothrow_341 : return ::testing::internal
::AssertHelper(::testing::TestPartResult::kFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 341, ("Expected: " "elems = Element::fromJSON(json)" " doesn't throw an exception.\n"
" Actual: " + gtest_msg.value) .c_str()) = ::testing::Message
()
<< " invalid JSON, test is broken";
342
343 // Verify that a non-existant element is caught.
344 EXPECT_THROW(parser.getDouble(elems, "not-there"), DhcpConfigError)switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { bool gtest_caught_expected = false; try { if (
::testing::internal::AlwaysTrue()) { parser.getDouble(elems, "not-there"
); } else static_assert(true, ""); } catch (DhcpConfigError const
&) { gtest_caught_expected = true; } catch (typename std::
conditional< std::is_same<typename std::remove_cv<typename
std::remove_reference< DhcpConfigError>::type>::type
, std::exception>::value, const ::testing::internal::NeverThrown
&, const std::exception&>::type e) { gtest_msg.value
= "Expected: " "parser.getDouble(elems, \"not-there\")" " throws an exception of type "
"DhcpConfigError" ".\n Actual: it throws "; gtest_msg.value
+= ::testing::internal::GetTypeName(typeid(e)); gtest_msg.value
+= " with description \""; gtest_msg.value += e.what(); gtest_msg
.value += "\"."; goto gtest_label_testthrow_344; } 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_344; } 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_344; } } else gtest_label_testthrow_344
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 344, gtest_msg.value.c_str()) = ::testing::Message()
;
345
346 // Verify that wrong element types are caught.
347 EXPECT_THROW(parser.getDouble(elems, "string"), DhcpConfigError)switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { bool gtest_caught_expected = false; try { if (
::testing::internal::AlwaysTrue()) { parser.getDouble(elems, "string"
); } else static_assert(true, ""); } catch (DhcpConfigError const
&) { gtest_caught_expected = true; } catch (typename std::
conditional< std::is_same<typename std::remove_cv<typename
std::remove_reference< DhcpConfigError>::type>::type
, std::exception>::value, const ::testing::internal::NeverThrown
&, const std::exception&>::type e) { gtest_msg.value
= "Expected: " "parser.getDouble(elems, \"string\")" " throws an exception of type "
"DhcpConfigError" ".\n Actual: it throws "; gtest_msg.value
+= ::testing::internal::GetTypeName(typeid(e)); gtest_msg.value
+= " with description \""; gtest_msg.value += e.what(); gtest_msg
.value += "\"."; goto gtest_label_testthrow_347; } 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_347; } 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_347; } } else gtest_label_testthrow_347
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 347, gtest_msg.value.c_str()) = ::testing::Message()
;
348 EXPECT_THROW(parser.getDouble(elems, "int"), DhcpConfigError)switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { bool gtest_caught_expected = false; try { if (
::testing::internal::AlwaysTrue()) { parser.getDouble(elems, "int"
); } else static_assert(true, ""); } catch (DhcpConfigError const
&) { gtest_caught_expected = true; } catch (typename std::
conditional< std::is_same<typename std::remove_cv<typename
std::remove_reference< DhcpConfigError>::type>::type
, std::exception>::value, const ::testing::internal::NeverThrown
&, const std::exception&>::type e) { gtest_msg.value
= "Expected: " "parser.getDouble(elems, \"int\")" " throws an exception of type "
"DhcpConfigError" ".\n Actual: it throws "; gtest_msg.value
+= ::testing::internal::GetTypeName(typeid(e)); gtest_msg.value
+= " with description \""; gtest_msg.value += e.what(); gtest_msg
.value += "\"."; goto gtest_label_testthrow_348; } 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_348; } 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_348; } } else gtest_label_testthrow_348
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 348, gtest_msg.value.c_str()) = ::testing::Message()
;
349 EXPECT_THROW(parser.getDouble(elems, "bool"), DhcpConfigError)switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { bool gtest_caught_expected = false; try { if (
::testing::internal::AlwaysTrue()) { parser.getDouble(elems, "bool"
); } else static_assert(true, ""); } catch (DhcpConfigError const
&) { gtest_caught_expected = true; } catch (typename std::
conditional< std::is_same<typename std::remove_cv<typename
std::remove_reference< DhcpConfigError>::type>::type
, std::exception>::value, const ::testing::internal::NeverThrown
&, const std::exception&>::type e) { gtest_msg.value
= "Expected: " "parser.getDouble(elems, \"bool\")" " throws an exception of type "
"DhcpConfigError" ".\n Actual: it throws "; gtest_msg.value
+= ::testing::internal::GetTypeName(typeid(e)); gtest_msg.value
+= " with description \""; gtest_msg.value += e.what(); gtest_msg
.value += "\"."; goto gtest_label_testthrow_349; } 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_349; } 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_349; } } else gtest_label_testthrow_349
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 349, gtest_msg.value.c_str()) = ::testing::Message()
;
350 EXPECT_THROW(parser.getDouble(elems, "map"), DhcpConfigError)switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { bool gtest_caught_expected = false; try { if (
::testing::internal::AlwaysTrue()) { parser.getDouble(elems, "map"
); } else static_assert(true, ""); } catch (DhcpConfigError const
&) { gtest_caught_expected = true; } catch (typename std::
conditional< std::is_same<typename std::remove_cv<typename
std::remove_reference< DhcpConfigError>::type>::type
, std::exception>::value, const ::testing::internal::NeverThrown
&, const std::exception&>::type e) { gtest_msg.value
= "Expected: " "parser.getDouble(elems, \"map\")" " throws an exception of type "
"DhcpConfigError" ".\n Actual: it throws "; gtest_msg.value
+= ::testing::internal::GetTypeName(typeid(e)); gtest_msg.value
+= " with description \""; gtest_msg.value += e.what(); gtest_msg
.value += "\"."; goto gtest_label_testthrow_350; } 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_350; } 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_350; } } else gtest_label_testthrow_350
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 350, gtest_msg.value.c_str()) = ::testing::Message()
;
351 EXPECT_THROW(parser.getDouble(elems, "list"), DhcpConfigError)switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { bool gtest_caught_expected = false; try { if (
::testing::internal::AlwaysTrue()) { parser.getDouble(elems, "list"
); } else static_assert(true, ""); } catch (DhcpConfigError const
&) { gtest_caught_expected = true; } catch (typename std::
conditional< std::is_same<typename std::remove_cv<typename
std::remove_reference< DhcpConfigError>::type>::type
, std::exception>::value, const ::testing::internal::NeverThrown
&, const std::exception&>::type e) { gtest_msg.value
= "Expected: " "parser.getDouble(elems, \"list\")" " throws an exception of type "
"DhcpConfigError" ".\n Actual: it throws "; gtest_msg.value
+= ::testing::internal::GetTypeName(typeid(e)); gtest_msg.value
+= " with description \""; gtest_msg.value += e.what(); gtest_msg
.value += "\"."; goto gtest_label_testthrow_351; } 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_351; } 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_351; } } else gtest_label_testthrow_351
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 351, gtest_msg.value.c_str()) = ::testing::Message()
;
352
353 // Verify valid values are correct.
354 double value;
355
356 EXPECT_NO_THROW(value = parser.getDouble(elems, "zero"))switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { try { if (::testing::internal::AlwaysTrue()) {
value = parser.getDouble(elems, "zero"); } else static_assert
(true, ""); } catch (std::exception const& e) { gtest_msg
.value = "it throws "; gtest_msg.value += ::testing::internal
::GetTypeName(typeid(e)); gtest_msg.value += " with description \""
; gtest_msg.value += e.what(); gtest_msg.value += "\"."; goto
gtest_label_testnothrow_356; } catch (...) { gtest_msg.value
= "it throws."; goto gtest_label_testnothrow_356; } } else gtest_label_testnothrow_356
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 356, ("Expected: " "value = parser.getDouble(elems, \"zero\")"
" doesn't throw an exception.\n" " Actual: " + gtest_msg.value
) .c_str()) = ::testing::Message()
;
357 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, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 357, gtest_ar.failure_message()) = ::testing::Message()
;
358
359 EXPECT_NO_THROW(value = parser.getDouble(elems, "fraction"))switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { try { if (::testing::internal::AlwaysTrue()) {
value = parser.getDouble(elems, "fraction"); } else static_assert
(true, ""); } catch (std::exception const& e) { gtest_msg
.value = "it throws "; gtest_msg.value += ::testing::internal
::GetTypeName(typeid(e)); gtest_msg.value += " with description \""
; gtest_msg.value += e.what(); gtest_msg.value += "\"."; goto
gtest_label_testnothrow_359; } catch (...) { gtest_msg.value
= "it throws."; goto gtest_label_testnothrow_359; } } else gtest_label_testnothrow_359
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 359, ("Expected: " "value = parser.getDouble(elems, \"fraction\")"
" doesn't throw an exception.\n" " Actual: " + gtest_msg.value
) .c_str()) = ::testing::Message()
;
360 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, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 360, gtest_ar.failure_message()) = ::testing::Message()
;
361
362 EXPECT_NO_THROW(value = parser.getDouble(elems, "negative"))switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { try { if (::testing::internal::AlwaysTrue()) {
value = parser.getDouble(elems, "negative"); } else static_assert
(true, ""); } catch (std::exception const& e) { gtest_msg
.value = "it throws "; gtest_msg.value += ::testing::internal
::GetTypeName(typeid(e)); gtest_msg.value += " with description \""
; gtest_msg.value += e.what(); gtest_msg.value += "\"."; goto
gtest_label_testnothrow_362; } catch (...) { gtest_msg.value
= "it throws."; goto gtest_label_testnothrow_362; } } else gtest_label_testnothrow_362
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 362, ("Expected: " "value = parser.getDouble(elems, \"negative\")"
" doesn't throw an exception.\n" " Actual: " + gtest_msg.value
) .c_str()) = ::testing::Message()
;
363 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, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 363, gtest_ar.failure_message()) = ::testing::Message()
;
364
365 EXPECT_NO_THROW(value = parser.getDouble(elems, "positive"))switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { try { if (::testing::internal::AlwaysTrue()) {
value = parser.getDouble(elems, "positive"); } else static_assert
(true, ""); } catch (std::exception const& e) { gtest_msg
.value = "it throws "; gtest_msg.value += ::testing::internal
::GetTypeName(typeid(e)); gtest_msg.value += " with description \""
; gtest_msg.value += e.what(); gtest_msg.value += "\"."; goto
gtest_label_testnothrow_365; } catch (...) { gtest_msg.value
= "it throws."; goto gtest_label_testnothrow_365; } } else gtest_label_testnothrow_365
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 365, ("Expected: " "value = parser.getDouble(elems, \"positive\")"
" doesn't throw an exception.\n" " Actual: " + gtest_msg.value
) .c_str()) = ::testing::Message()
;
366 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, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 366, gtest_ar.failure_message()) = ::testing::Message()
;
367}
368
369TEST_F(SimpleParserTest, rangeCheckedIntegerUint32)static_assert(sizeof("SimpleParserTest") > 1, "test_suite_name must not be empty"
); static_assert(sizeof("rangeCheckedIntegerUint32") > 1, "test_name must not be empty"
); class SimpleParserTest_rangeCheckedIntegerUint32_Test : public
SimpleParserTest { public: SimpleParserTest_rangeCheckedIntegerUint32_Test
() = default; ~SimpleParserTest_rangeCheckedIntegerUint32_Test
() override = default; SimpleParserTest_rangeCheckedIntegerUint32_Test
(const SimpleParserTest_rangeCheckedIntegerUint32_Test &
) = delete; SimpleParserTest_rangeCheckedIntegerUint32_Test &
operator=( const SimpleParserTest_rangeCheckedIntegerUint32_Test
&) = delete; SimpleParserTest_rangeCheckedIntegerUint32_Test
(SimpleParserTest_rangeCheckedIntegerUint32_Test &&)
noexcept = delete; SimpleParserTest_rangeCheckedIntegerUint32_Test
& operator=( SimpleParserTest_rangeCheckedIntegerUint32_Test
&&) noexcept = delete; private: void TestBody() override
; [[maybe_unused]] static ::testing::TestInfo* const test_info_
; }; ::testing::TestInfo* const SimpleParserTest_rangeCheckedIntegerUint32_Test
::test_info_ = ::testing::internal::MakeAndRegisterTestInfo( "SimpleParserTest"
, "rangeCheckedIntegerUint32", nullptr, nullptr, ::testing::internal
::CodeLocation("../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 369), (::testing::internal::GetTypeId<SimpleParserTest>
()), ::testing::internal::SuiteApiResolver< SimpleParserTest
>::GetSetUpCaseOrSuite("../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 369), ::testing::internal::SuiteApiResolver< SimpleParserTest
>::GetTearDownCaseOrSuite("../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 369), new ::testing::internal::TestFactoryImpl<SimpleParserTest_rangeCheckedIntegerUint32_Test
>); void SimpleParserTest_rangeCheckedIntegerUint32_Test::
TestBody()
{
370 struct Scenario {
371 int64_t input_value_;
372 bool should_throw_;
373 };
374
375 std::list<Scenario> scenarios = {
376 { (static_cast<int64_t>(std::numeric_limits<uint32_t>::min()) - 1), true },
377 { std::numeric_limits<uint32_t>::min(), false },
378 { std::numeric_limits<uint32_t>::max(), false },
379 { (static_cast<int64_t>(std::numeric_limits<uint32_t>::max()) + 1), true }
380 };
381
382 for (auto const& scenario : scenarios) {
383 ElementPtr scope = Element::createMap();
384 scope->set("some-number", Element::create(scenario.input_value_));
385 uint32_t output_value;
386 if (scenario.should_throw_) {
387 std::stringstream os;
388 os << "'some-number' : " << scenario.input_value_
389 << " is out of range, must be >= "
390 << std::numeric_limits<uint32_t>::min() << " and <= "
391 << std::numeric_limits<uint32_t>::max();
392 ASSERT_THROW_MSG(SimpleParser::rangeCheckedInteger(scope, "some-number", output_value),{ try { SimpleParser::rangeCheckedInteger(scope, "some-number"
, output_value); return ::testing::internal::AssertHelper(::testing
::TestPartResult::kFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 393, "Failed") = ::testing::Message() << "no exception, expected: "
<< "DhcpConfigError"; } catch (const DhcpConfigError&
ex) { switch (0) case 0: default: if (const ::testing::AssertionResult
gtest_ar = (::testing::internal::EqHelper::Compare("std::string(ex.what())"
, "os.str()", std::string(ex.what()), os.str()))) ; else return
::testing::internal::AssertHelper(::testing::TestPartResult::
kFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 393, gtest_ar.failure_message()) = ::testing::Message(); } catch
(...) { return ::testing::internal::AssertHelper(::testing::
TestPartResult::kFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 393, "Failed") = ::testing::Message() << "wrong exception type thrown, expected: "
<< "DhcpConfigError"; } }
393 DhcpConfigError, os.str()){ try { SimpleParser::rangeCheckedInteger(scope, "some-number"
, output_value); return ::testing::internal::AssertHelper(::testing
::TestPartResult::kFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 393, "Failed") = ::testing::Message() << "no exception, expected: "
<< "DhcpConfigError"; } catch (const DhcpConfigError&
ex) { switch (0) case 0: default: if (const ::testing::AssertionResult
gtest_ar = (::testing::internal::EqHelper::Compare("std::string(ex.what())"
, "os.str()", std::string(ex.what()), os.str()))) ; else return
::testing::internal::AssertHelper(::testing::TestPartResult::
kFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 393, gtest_ar.failure_message()) = ::testing::Message(); } catch
(...) { return ::testing::internal::AssertHelper(::testing::
TestPartResult::kFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 393, "Failed") = ::testing::Message() << "wrong exception type thrown, expected: "
<< "DhcpConfigError"; } }
;
394 } else {
395 ASSERT_NO_THROW(SimpleParser::rangeCheckedInteger(scope, "some-number", output_value))switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { try { if (::testing::internal::AlwaysTrue()) {
SimpleParser::rangeCheckedInteger(scope, "some-number", output_value
); } else static_assert(true, ""); } catch (std::exception const
& e) { gtest_msg.value = "it throws "; gtest_msg.value +=
::testing::internal::GetTypeName(typeid(e)); gtest_msg.value
+= " with description \""; gtest_msg.value += e.what(); gtest_msg
.value += "\"."; goto gtest_label_testnothrow_395; } catch (...
) { gtest_msg.value = "it throws."; goto gtest_label_testnothrow_395
; } } else gtest_label_testnothrow_395 : return ::testing::internal
::AssertHelper(::testing::TestPartResult::kFatalFailure, "../../../src/lib/cc/tests/simple_parser_unittest.cc"
, 395, ("Expected: " "SimpleParser::rangeCheckedInteger(scope, \"some-number\", output_value)"
" doesn't throw an exception.\n" " Actual: " + gtest_msg.value
) .c_str()) = ::testing::Message()
;
396 }
397 }
398}

/usr/bin/../lib/gcc/x86_64-redhat-linux/16/../../../../include/c++/16/bits/basic_string.h

1// Components for manipulating sequences of characters -*- C++ -*-
2
3// Copyright (C) 1997-2026 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#ifdef _GLIBCXX_SYSHDR
38#pragma GCC system_header
39#endif
40
41#include <ext/alloc_traits.h>
42#include <debug/debug.h>
43
44#if __cplusplus201703L >= 201103L
45#include <initializer_list>
46#endif
47
48#include <bits/version.h>
49
50#ifdef __glibcxx_string_view201803L // >= C++17
51# include <string_view>
52#endif
53
54#if __glibcxx_containers_ranges // C++ >= 23
55# include <bits/ranges_algobase.h> // ranges::copy
56# include <bits/ranges_util.h> // ranges::subrange
57#endif
58
59#if __glibcxx_to_string >= 202306L // C++ >= 26
60# include <charconv>
61#endif
62
63#if ! _GLIBCXX_USE_CXX11_ABI1
64# include "cow_string.h"
65#else
66
67namespace std _GLIBCXX_VISIBILITY(default)__attribute__ ((__visibility__ ("default")))
68{
69_GLIBCXX_BEGIN_NAMESPACE_VERSION
70_GLIBCXX_BEGIN_NAMESPACE_CXX11namespace __cxx11 {
71
72 /**
73 * @class basic_string basic_string.h <string>
74 * @brief Managing sequences of characters and character-like objects.
75 *
76 * @ingroup strings
77 * @ingroup sequences
78 * @headerfile string
79 * @since C++98
80 *
81 * @tparam _CharT Type of character
82 * @tparam _Traits Traits for character type, defaults to
83 * char_traits<_CharT>.
84 * @tparam _Alloc Allocator type, defaults to allocator<_CharT>.
85 *
86 * Meets the requirements of a <a href="tables.html#65">container</a>, a
87 * <a href="tables.html#66">reversible container</a>, and a
88 * <a href="tables.html#67">sequence</a>. Of the
89 * <a href="tables.html#68">optional sequence requirements</a>, only
90 * @c push_back, @c at, and @c %array access are supported.
91 */
92 template<typename _CharT, typename _Traits, typename _Alloc>
93 class basic_string
94 {
95#if __cplusplus201703L >= 202002L
96 static_assert(is_trivially_copyable_v<_CharT>
97 && is_trivially_default_constructible_v<_CharT>
98 && is_standard_layout_v<_CharT>);
99 static_assert(is_same_v<_CharT, typename _Traits::char_type>);
100 static_assert(is_same_v<_CharT, typename _Alloc::value_type>);
101 using _Char_alloc_type = _Alloc;
102#else
103 typedef typename __gnu_cxx::__alloc_traits<_Alloc>::template
104 rebind<_CharT>::other _Char_alloc_type;
105#endif
106
107 typedef __gnu_cxx::__alloc_traits<_Char_alloc_type> _Alloc_traits;
108
109 // Types:
110 public:
111 typedef _Traits traits_type;
112 typedef typename _Traits::char_type value_type;
113 typedef _Char_alloc_type allocator_type;
114 typedef typename _Alloc_traits::size_type size_type;
115 typedef typename _Alloc_traits::difference_type difference_type;
116 typedef typename _Alloc_traits::reference reference;
117 typedef typename _Alloc_traits::const_reference const_reference;
118 typedef typename _Alloc_traits::pointer pointer;
119 typedef typename _Alloc_traits::const_pointer const_pointer;
120 typedef __gnu_cxx::__normal_iterator<pointer, basic_string> iterator;
121 typedef __gnu_cxx::__normal_iterator<const_pointer, basic_string>
122 const_iterator;
123 typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
124 typedef std::reverse_iterator<iterator> reverse_iterator;
125
126 /// Value returned by various member functions when they fail.
127 static const size_type npos = static_cast<size_type>(-1);
128
129 protected:
130 // type used for positions in insert, erase etc.
131#if __cplusplus201703L < 201103L
132 typedef iterator __const_iterator;
133#else
134 typedef const_iterator __const_iterator;
135#endif
136
137 private:
138 static _GLIBCXX20_CONSTEXPR pointer
139 _S_allocate(_Char_alloc_type& __a, size_type __n)
140 {
141 pointer __p = _Alloc_traits::allocate(__a, __n);
142#if __glibcxx_constexpr_string201611L >= 201907L
143 // std::char_traits begins the lifetime of characters,
144 // but custom traits might not, so do it here.
145 if constexpr (!is_same_v<_Traits, char_traits<_CharT>>)
146 if (std::__is_constant_evaluated())
147 // Begin the lifetime of characters in allocated storage.
148 for (size_type __i = 0; __i < __n; ++__i)
149 std::construct_at(__builtin_addressof(__p[__i]));
150#endif
151 return __p;
152 }
153
154#ifdef __glibcxx_string_view201803L // >= C++17
155 // A helper type for avoiding boiler-plate.
156 typedef basic_string_view<_CharT, _Traits> __sv_type;
157
158 template<typename _Tp, typename _Res>
159 using _If_sv = enable_if_t<
160 __and_<is_convertible<const _Tp&, __sv_type>,
161 __not_<is_convertible<const _Tp*, const basic_string*>>,
162 __not_<is_convertible<const _Tp&, const _CharT*>>>::value,
163 _Res>;
164
165 // Allows an implicit conversion to __sv_type.
166 _GLIBCXX20_CONSTEXPR
167 static __sv_type
168 _S_to_string_view(__sv_type __svt) noexcept
169 { return __svt; }
170
171 // Wraps a string_view by explicit conversion and thus
172 // allows to add an internal constructor that does not
173 // participate in overload resolution when a string_view
174 // is provided.
175 struct __sv_wrapper
176 {
177 _GLIBCXX20_CONSTEXPR explicit
178 __sv_wrapper(__sv_type __sv) noexcept : _M_sv(__sv) { }
179
180 __sv_type _M_sv;
181 };
182
183 /**
184 * @brief Only internally used: Construct string from a string view
185 * wrapper.
186 * @param __svw string view wrapper.
187 * @param __a Allocator to use.
188 */
189 _GLIBCXX20_CONSTEXPR
190 explicit
191 basic_string(__sv_wrapper __svw, const _Alloc& __a)
192 : basic_string(__svw._M_sv.data(), __svw._M_sv.size(), __a) { }
193#endif
194
195 // Use empty-base optimization: http://www.cantrip.org/emptyopt.html
196 struct _Alloc_hider : allocator_type // TODO check __is_final
197 {
198#if __cplusplus201703L < 201103L
199 _Alloc_hider(pointer __dat, const _Alloc& __a = _Alloc())
200 : allocator_type(__a), _M_p(__dat) { }
201#else
202 _GLIBCXX20_CONSTEXPR
203 _Alloc_hider(pointer __dat, const _Alloc& __a)
204 : allocator_type(__a), _M_p(__dat) { }
205
206 _GLIBCXX20_CONSTEXPR
207 _Alloc_hider(pointer __dat, _Alloc&& __a = _Alloc())
208 : allocator_type(std::move(__a)), _M_p(__dat) { }
209#endif
210
211 pointer _M_p; // The actual data.
212 };
213
214 _Alloc_hider _M_dataplus;
215 size_type _M_string_length;
216
217 enum { _S_local_capacity = 15 / sizeof(_CharT) };
218
219 union
220 {
221 _CharT _M_local_buf[_S_local_capacity + 1];
222 size_type _M_allocated_capacity;
223 };
224
225 _GLIBCXX20_CONSTEXPR
226 void
227 _M_data(pointer __p)
228 { _M_dataplus._M_p = __p; }
229
230 _GLIBCXX20_CONSTEXPR
231 void
232 _M_length(size_type __length)
233 { _M_string_length = __length; }
234
235 _GLIBCXX20_CONSTEXPR
236 pointer
237 _M_data() const
238 { return _M_dataplus._M_p; }
239
240 _GLIBCXX20_CONSTEXPR
241 pointer
242 _M_local_data()
243 {
244#if __cplusplus201703L >= 201103L
245 return std::pointer_traits<pointer>::pointer_to(*_M_local_buf);
246#else
247 return pointer(_M_local_buf);
248#endif
249 }
250
251 _GLIBCXX20_CONSTEXPR
252 const_pointer
253 _M_local_data() const
254 {
255#if __cplusplus201703L >= 201103L
256 return std::pointer_traits<const_pointer>::pointer_to(*_M_local_buf);
257#else
258 return const_pointer(_M_local_buf);
259#endif
260 }
261
262 _GLIBCXX20_CONSTEXPR
263 void
264 _M_capacity(size_type __capacity)
265 { _M_allocated_capacity = __capacity; }
266
267 _GLIBCXX20_CONSTEXPR
268 void
269 _M_set_length(size_type __n)
270 {
271 traits_type::assign(_M_data()[__n], _CharT());
272 _M_length(__n);
273 }
274
275 _GLIBCXX20_CONSTEXPR
276 bool
277 _M_is_local() const
278 {
279 if (_M_data() == _M_local_data())
280 {
281 if (_M_string_length > _S_local_capacity)
282 __builtin_unreachable();
283 return true;
284 }
285 return false;
286 }
287
288 // Create & Destroy
289 _GLIBCXX20_CONSTEXPR
290 pointer
291 _M_create(size_type&, size_type);
292
293 _GLIBCXX20_CONSTEXPR
294 void
295 _M_dispose()
296 {
297 if (!_M_is_local())
298 _M_destroy(_M_allocated_capacity);
299 }
300
301 _GLIBCXX20_CONSTEXPR
302 void
303 _M_destroy(size_type __size) throw()
304 { _Alloc_traits::deallocate(_M_get_allocator(), _M_data(), __size + 1); }
305
306#if __cplusplus201703L < 201103L || defined _GLIBCXX_DEFINING_STRING_INSTANTIATIONS
307 // _M_construct_aux is used to implement the 21.3.1 para 15 which
308 // requires special behaviour if _InIterator is an integral type
309 template<typename _InIterator>
310 void
311 _M_construct_aux(_InIterator __beg, _InIterator __end,
312 std::__false_type)
313 {
314 typedef typename iterator_traits<_InIterator>::iterator_category _Tag;
315 _M_construct(__beg, __end, _Tag());
316 }
317
318 // _GLIBCXX_RESOLVE_LIB_DEFECTS
319 // 438. Ambiguity in the "do the right thing" clause
320 template<typename _Integer>
321 void
322 _M_construct_aux(_Integer __beg, _Integer __end, std::__true_type)
323 { _M_construct_aux_2(static_cast<size_type>(__beg), __end); }
324
325 void
326 _M_construct_aux_2(size_type __req, _CharT __c)
327 { _M_construct(__req, __c); }
328#endif
329
330 // For Input Iterators, used in istreambuf_iterators, etc.
331 template<typename _InIterator>
332 _GLIBCXX20_CONSTEXPR
333 void
334 _M_construct(_InIterator __beg, _InIterator __end,
335 std::input_iterator_tag);
336
337 // For forward_iterators up to random_access_iterators, used for
338 // string::iterator, _CharT*, etc.
339 template<typename _FwdIterator>
340 _GLIBCXX20_CONSTEXPR
341 void
342 _M_construct(_FwdIterator __beg, _FwdIterator __end,
343 std::forward_iterator_tag);
344
345 _GLIBCXX20_CONSTEXPR
346 void
347 _M_construct(size_type __req, _CharT __c);
348
349 // Construct using block of memory of known size.
350 // If _Terminated is true assume that source is already 0 terminated.
351 template<bool _Terminated>
352 _GLIBCXX20_CONSTEXPR
353 void
354 _M_construct(const _CharT *__c, size_type __n);
355
356#if __cplusplus201703L >= 202302L
357 constexpr void
358 _M_construct(basic_string&& __str, size_type __pos, size_type __n);
359#endif
360
361 _GLIBCXX20_CONSTEXPR
362 allocator_type&
363 _M_get_allocator()
364 { return _M_dataplus; }
365
366 _GLIBCXX20_CONSTEXPR
367 const allocator_type&
368 _M_get_allocator() const
369 { return _M_dataplus; }
370
371 // Ensure that _M_local_buf is the active member of the union.
372 __attribute__((__always_inline__))
373 _GLIBCXX14_CONSTEXPRconstexpr
374 void
375 _M_init_local_buf() _GLIBCXX_NOEXCEPTnoexcept
376 {
377#if __glibcxx_is_constant_evaluated
378 if (std::is_constant_evaluated())
379 for (size_type __i = 0; __i <= _S_local_capacity; ++__i)
380 _M_local_buf[__i] = _CharT();
381#endif
382 }
383
384 __attribute__((__always_inline__))
385 _GLIBCXX14_CONSTEXPRconstexpr
386 pointer
387 _M_use_local_data() _GLIBCXX_NOEXCEPTnoexcept
388 {
389#if __cpp_lib_is_constant_evaluated
390 _M_init_local_buf();
391#endif
392 return _M_local_data();
393 }
394
395 private:
396
397#ifdef _GLIBCXX_DISAMBIGUATE_REPLACE_INST
398 // The explicit instantiations in misc-inst.cc require this due to
399 // https://gcc.gnu.org/bugzilla/show_bug.cgi?id=64063
400 template<typename _Tp, bool _Requires =
401 !__are_same<_Tp, _CharT*>::__value
402 && !__are_same<_Tp, const _CharT*>::__value
403 && !__are_same<_Tp, iterator>::__value
404 && !__are_same<_Tp, const_iterator>::__value>
405 struct __enable_if_not_native_iterator
406 { typedef basic_string& __type; };
407 template<typename _Tp>
408 struct __enable_if_not_native_iterator<_Tp, false> { };
409#endif
410
411 _GLIBCXX20_CONSTEXPR
412 size_type
413 _M_check(size_type __pos, const char* __s) const
414 {
415 if (__pos > this->size())
416 __throw_out_of_range_fmt(__N("%s: __pos (which is %zu) > "("%s: __pos (which is %zu) > " "this->size() (which is %zu)"
)
417 "this->size() (which is %zu)")("%s: __pos (which is %zu) > " "this->size() (which is %zu)"
)
,
418 __s, (size_t)__pos, (size_t)this->size());
419 return __pos;
420 }
421
422 _GLIBCXX20_CONSTEXPR
423 void
424 _M_check_length(size_type __n1, size_type __n2, const char* __s) const
425 {
426 if (this->max_size() - (this->size() - __n1) < __n2)
427 __throw_length_error(__N(__s)(__s));
428 }
429
430
431 // NB: _M_limit doesn't check for a bad __pos value.
432 _GLIBCXX20_CONSTEXPR
433 size_type
434 _M_limit(size_type __pos, size_type __off) const _GLIBCXX_NOEXCEPTnoexcept
435 {
436 const bool __testoff = __off < this->size() - __pos;
437 return __testoff ? __off : this->size() - __pos;
438 }
439
440 // True if _Rep and source do not overlap.
441 bool
442 _M_disjunct(const _CharT* __s) const _GLIBCXX_NOEXCEPTnoexcept
443 {
444 return (less<const _CharT*>()(__s, _M_data())
445 || less<const _CharT*>()(_M_data() + this->size(), __s));
446 }
447
448 // When __n = 1 way faster than the general multichar
449 // traits_type::copy/move/assign.
450 _GLIBCXX20_CONSTEXPR
451 static void
452 _S_copy(_CharT* __d, const _CharT* __s, size_type __n)
453 {
454 if (__n == 1)
455 traits_type::assign(*__d, *__s);
456 else
457 traits_type::copy(__d, __s, __n);
458 }
459
460 _GLIBCXX20_CONSTEXPR
461 static void
462 _S_move(_CharT* __d, const _CharT* __s, size_type __n)
463 {
464 if (__n == 1)
465 traits_type::assign(*__d, *__s);
466 else
467 traits_type::move(__d, __s, __n);
468 }
469
470 _GLIBCXX20_CONSTEXPR
471 static void
472 _S_assign(_CharT* __d, size_type __n, _CharT __c)
473 {
474 if (__n == 1)
475 traits_type::assign(*__d, __c);
476 else
477 traits_type::assign(__d, __n, __c);
478 }
479
480#pragma GCC diagnostic push
481#pragma GCC diagnostic ignored "-Wc++17-extensions"
482 // _S_copy_chars is a separate template to permit specialization
483 // to optimize for the common case of pointers as iterators.
484 template<class _Iterator>
485 _GLIBCXX20_CONSTEXPR
486 static void
487 _S_copy_chars(_CharT* __p, _Iterator __k1, _Iterator __k2)
488 {
489#if __cplusplus201703L >= 201103L
490 using _IterBase = decltype(std::__niter_base(__k1));
491 if constexpr (__or_<is_same<_IterBase, _CharT*>,
492 is_same<_IterBase, const _CharT*>>::value)
493 _S_copy(__p, std::__niter_base(__k1), __k2 - __k1);
494#if __cpp_lib_concepts
495 else if constexpr (requires {
496 requires contiguous_iterator<_Iterator>;
497 { std::to_address(__k1) }
498 -> convertible_to<const _CharT*>;
499 })
500 {
501 const auto __d = __k2 - __k1;
502 (void) (__k1 + __d); // See P3349R1
503 _S_copy(__p, std::to_address(__k1), static_cast<size_type>(__d));
504 }
505#endif
506 else
507#endif
508 for (; __k1 != __k2; ++__k1, (void)++__p)
509 traits_type::assign(*__p, static_cast<_CharT>(*__k1));
510 }
511#pragma GCC diagnostic pop
512
513#if __cplusplus201703L < 201103L || defined _GLIBCXX_DEFINING_STRING_INSTANTIATIONS
514 static void
515 _S_copy_chars(_CharT* __p, iterator __k1, iterator __k2)
516 { _S_copy_chars(__p, __k1.base(), __k2.base()); }
517
518 static void
519 _S_copy_chars(_CharT* __p, const_iterator __k1, const_iterator __k2)
520 { _S_copy_chars(__p, __k1.base(), __k2.base()); }
521
522 static void
523 _S_copy_chars(_CharT* __p, _CharT* __k1, _CharT* __k2)
524 { _S_copy(__p, __k1, __k2 - __k1); }
525
526 static void
527 _S_copy_chars(_CharT* __p, const _CharT* __k1, const _CharT* __k2)
528 { _S_copy(__p, __k1, __k2 - __k1); }
529#endif
530
531#if __glibcxx_containers_ranges // C++ >= 23
532 // pre: __n == ranges::distance(__rg). __p+[0,__n) is a valid range.
533 template<typename _Rg>
534 static constexpr void
535 _S_copy_range(pointer __p, _Rg&& __rg, size_type __n)
536 {
537 if constexpr (requires {
538 requires ranges::contiguous_range<_Rg>;
539 { ranges::data(std::forward<_Rg>(__rg)) }
540 -> convertible_to<const _CharT*>;
541 })
542 _S_copy(__p, ranges::data(std::forward<_Rg>(__rg)), __n);
543 else
544 {
545 auto __first = ranges::begin(__rg);
546 const auto __last = ranges::end(__rg);
547 for (; __first != __last; ++__first)
548 traits_type::assign(*__p++, static_cast<_CharT>(*__first));
549 }
550 }
551#endif
552
553 _GLIBCXX20_CONSTEXPR
554 static int
555 _S_compare(size_type __n1, size_type __n2) _GLIBCXX_NOEXCEPTnoexcept
556 {
557 const difference_type __d = difference_type(__n1 - __n2);
558
559 if (__d > __gnu_cxx::__numeric_traits<int>::__max)
560 return __gnu_cxx::__numeric_traits<int>::__max;
561 else if (__d < __gnu_cxx::__numeric_traits<int>::__min)
562 return __gnu_cxx::__numeric_traits<int>::__min;
563 else
564 return int(__d);
565 }
566
567 _GLIBCXX20_CONSTEXPR
568 void
569 _M_assign(const basic_string&);
570
571 _GLIBCXX20_CONSTEXPR
572 void
573 _M_mutate(size_type __pos, size_type __len1, const _CharT* __s,
574 size_type __len2);
575
576 _GLIBCXX20_CONSTEXPR
577 void
578 _M_erase(size_type __pos, size_type __n);
579
580 public:
581 // Construct/copy/destroy:
582 // NB: We overload ctors in some cases instead of using default
583 // arguments, per 17.4.4.4 para. 2 item 2.
584
585 /**
586 * @brief Default constructor creates an empty string.
587 */
588 _GLIBCXX20_CONSTEXPR
589 basic_string()
590 _GLIBCXX_NOEXCEPT_IF(is_nothrow_default_constructible<_Alloc>::value)noexcept(is_nothrow_default_constructible<_Alloc>::value
)
591#if __cpp_concepts && __glibcxx_type_trait_variable_templates201510L
592 requires is_default_constructible_v<_Alloc>
593#endif
594 : _M_dataplus(_M_local_data())
595 {
596 _M_init_local_buf();
597 _M_set_length(0);
598 }
599
600 /**
601 * @brief Construct an empty string using allocator @a a.
602 */
603 _GLIBCXX20_CONSTEXPR
604 explicit
605 basic_string(const _Alloc& __a) _GLIBCXX_NOEXCEPTnoexcept
606 : _M_dataplus(_M_local_data(), __a)
607 {
608 _M_init_local_buf();
609 _M_set_length(0);
610 }
611
612 /**
613 * @brief Construct string with copy of value of @a __str.
614 * @param __str Source string.
615 */
616 _GLIBCXX20_CONSTEXPR
617 basic_string(const basic_string& __str)
618 : _M_dataplus(_M_local_data(),
619 _Alloc_traits::_S_select_on_copy(__str._M_get_allocator()))
620 {
621 _M_construct<true>(__str._M_data(), __str.length());
622 }
623
624 // _GLIBCXX_RESOLVE_LIB_DEFECTS
625 // 2583. no way to supply an allocator for basic_string(str, pos)
626 /**
627 * @brief Construct string as copy of a substring.
628 * @param __str Source string.
629 * @param __pos Index of first character to copy from.
630 * @param __a Allocator to use.
631 */
632 _GLIBCXX20_CONSTEXPR
633 basic_string(const basic_string& __str, size_type __pos,
634 const _Alloc& __a = _Alloc())
635 : _M_dataplus(_M_local_data(), __a)
636 {
637 const _CharT* __start = __str._M_data()
638 + __str._M_check(__pos, "basic_string::basic_string");
639 _M_construct(__start, __start + __str._M_limit(__pos, npos),
640 std::forward_iterator_tag());
641 }
642
643 /**
644 * @brief Construct string as copy of a substring.
645 * @param __str Source string.
646 * @param __pos Index of first character to copy from.
647 * @param __n Number of characters to copy.
648 */
649 _GLIBCXX20_CONSTEXPR
650 basic_string(const basic_string& __str, size_type __pos,
651 size_type __n)
652 : _M_dataplus(_M_local_data())
653 {
654 const _CharT* __start = __str._M_data()
655 + __str._M_check(__pos, "basic_string::basic_string");
656 _M_construct(__start, __start + __str._M_limit(__pos, __n),
657 std::forward_iterator_tag());
658 }
659
660 /**
661 * @brief Construct string as copy of a substring.
662 * @param __str Source string.
663 * @param __pos Index of first character to copy from.
664 * @param __n Number of characters to copy.
665 * @param __a Allocator to use.
666 */
667 _GLIBCXX20_CONSTEXPR
668 basic_string(const basic_string& __str, size_type __pos,
669 size_type __n, const _Alloc& __a)
670 : _M_dataplus(_M_local_data(), __a)
671 {
672 const _CharT* __start
673 = __str._M_data() + __str._M_check(__pos, "string::string");
674 _M_construct(__start, __start + __str._M_limit(__pos, __n),
675 std::forward_iterator_tag());
676 }
677
678#if __cplusplus201703L >= 202302L
679 _GLIBCXX20_CONSTEXPR
680 basic_string(basic_string&& __str, size_type __pos,
681 const _Alloc& __a = _Alloc())
682 : _M_dataplus(_M_local_data(), __a)
683 {
684 __pos = __str._M_check(__pos, "string::string");
685 _M_construct(std::move(__str), __pos, __str.length() - __pos);
686 }
687
688 _GLIBCXX20_CONSTEXPR
689 basic_string(basic_string&& __str, size_type __pos, size_type __n,
690 const _Alloc& __a = _Alloc())
691 : _M_dataplus(_M_local_data(), __a)
692 {
693 __pos = __str._M_check(__pos, "string::string");
694 _M_construct(std::move(__str), __pos, __str._M_limit(__pos, __n));
695 }
696#endif // C++23
697
698 /**
699 * @brief Construct string initialized by a character %array.
700 * @param __s Source character %array.
701 * @param __n Number of characters to copy.
702 * @param __a Allocator to use (default is default allocator).
703 *
704 * NB: @a __s must have at least @a __n characters, &apos;\\0&apos;
705 * has no special meaning.
706 */
707 _GLIBCXX20_CONSTEXPR
708 basic_string(const _CharT* __s, size_type __n,
709 const _Alloc& __a = _Alloc())
710 : _M_dataplus(_M_local_data(), __a)
711 {
712 // NB: Not required, but considered best practice.
713 if (__s == 0 && __n > 0)
714 std::__throw_logic_error(__N("basic_string: "("basic_string: " "construction from null is not valid")
715 "construction from null is not valid")("basic_string: " "construction from null is not valid"));
716 _M_construct(__s, __s + __n, std::forward_iterator_tag());
717 }
718
719 /**
720 * @brief Construct string as copy of a C string.
721 * @param __s Source C string.
722 * @param __a Allocator to use (default is default allocator).
723 */
724#if __cpp_deduction_guides201703L && ! defined _GLIBCXX_DEFINING_STRING_INSTANTIATIONS
725 // _GLIBCXX_RESOLVE_LIB_DEFECTS
726 // 3076. basic_string CTAD ambiguity
727 template<typename = _RequireAllocator<_Alloc>>
728#endif
729 _GLIBCXX20_CONSTEXPR
730 basic_string(const _CharT* __s, const _Alloc& __a = _Alloc())
731 : _M_dataplus(_M_local_data(), __a)
732 {
733 // NB: Not required, but considered best practice.
734 if (__s == 0)
735 std::__throw_logic_error(__N("basic_string: "("basic_string: " "construction from null is not valid")
736 "construction from null is not valid")("basic_string: " "construction from null is not valid"));
737 const _CharT* __end = __s + traits_type::length(__s);
738 _M_construct(__s, __end, forward_iterator_tag());
739 }
740
741 /**
742 * @brief Construct string as multiple characters.
743 * @param __n Number of characters.
744 * @param __c Character to use.
745 * @param __a Allocator to use (default is default allocator).
746 */
747#if __cpp_deduction_guides201703L && ! defined _GLIBCXX_DEFINING_STRING_INSTANTIATIONS
748 // _GLIBCXX_RESOLVE_LIB_DEFECTS
749 // 3076. basic_string CTAD ambiguity
750 template<typename = _RequireAllocator<_Alloc>>
751#endif
752 _GLIBCXX20_CONSTEXPR
753 basic_string(size_type __n, _CharT __c, const _Alloc& __a = _Alloc())
754 : _M_dataplus(_M_local_data(), __a)
755 { _M_construct(__n, __c); }
756
757#if __cplusplus201703L >= 201103L
758 /**
759 * @brief Move construct string.
760 * @param __str Source string.
761 *
762 * The newly-created string contains the exact contents of @a __str.
763 * @a __str is a valid, but unspecified string.
764 */
765 _GLIBCXX20_CONSTEXPR
766 basic_string(basic_string&& __str) noexcept
767 : _M_dataplus(_M_local_data(), std::move(__str._M_get_allocator()))
768 {
769 if (__str._M_is_local())
770 {
771 _M_init_local_buf();
772 traits_type::copy(_M_local_buf, __str._M_local_buf,
773 __str.length() + 1);
774 }
775 else
776 {
777 _M_data(__str._M_data());
778 _M_capacity(__str._M_allocated_capacity);
779 }
780
781 // Must use _M_length() here not _M_set_length() because
782 // basic_stringbuf relies on writing into unallocated capacity so
783 // we mess up the contents if we put a '\0' in the string.
784 _M_length(__str.length());
785 __str._M_data(__str._M_use_local_data());
786 __str._M_set_length(0);
787 }
788
789#if __glibcxx_containers_ranges // C++ >= 23
790 /**
791 * @brief Construct a string from a range.
792 * @since C++23
793 */
794 template<__detail::__container_compatible_range<_CharT> _Rg>
795 constexpr
796 basic_string(from_range_t, _Rg&& __rg, const _Alloc& __a = _Alloc())
797 : basic_string(__a)
798 {
799 if constexpr (ranges::forward_range<_Rg> || ranges::sized_range<_Rg>)
800 {
801 const auto __n = static_cast<size_type>(ranges::distance(__rg));
802 reserve(__n);
803 _S_copy_range(_M_data(), std::forward<_Rg>(__rg), __n);
804 _M_set_length(__n);
805 }
806 else
807 {
808 auto __first = ranges::begin(__rg);
809 const auto __last = ranges::end(__rg);
810 for (; __first != __last; ++__first)
811 push_back(*__first);
812 }
813 }
814#endif
815
816 /**
817 * @brief Construct string from an initializer %list.
818 * @param __l std::initializer_list of characters.
819 * @param __a Allocator to use (default is default allocator).
820 */
821 _GLIBCXX20_CONSTEXPR
822 basic_string(initializer_list<_CharT> __l, const _Alloc& __a = _Alloc())
823 : _M_dataplus(_M_local_data(), __a)
824 { _M_construct(__l.begin(), __l.end(), std::forward_iterator_tag()); }
825
826 _GLIBCXX20_CONSTEXPR
827 basic_string(const basic_string& __str, const _Alloc& __a)
828 : _M_dataplus(_M_local_data(), __a)
829 { _M_construct(__str.begin(), __str.end(), std::forward_iterator_tag()); }
830
831 _GLIBCXX20_CONSTEXPR
832 basic_string(basic_string&& __str, const _Alloc& __a)
833 noexcept(_Alloc_traits::_S_always_equal())
834 : _M_dataplus(_M_local_data(), __a)
835 {
836 if (__str._M_is_local())
837 {
838 _M_init_local_buf();
839 traits_type::copy(_M_local_buf, __str._M_local_buf,
840 __str.length() + 1);
841 _M_length(__str.length());
842 __str._M_set_length(0);
843 }
844 else if (_Alloc_traits::_S_always_equal()
845 || __str.get_allocator() == __a)
846 {
847 _M_data(__str._M_data());
848 _M_length(__str.length());
849 _M_capacity(__str._M_allocated_capacity);
850 __str._M_data(__str._M_use_local_data());
851 __str._M_set_length(0);
852 }
853 else
854 _M_construct(__str.begin(), __str.end(), std::forward_iterator_tag());
855 }
856#endif // C++11
857
858#if __cplusplus201703L >= 202100L
859 basic_string(nullptr_t) = delete;
860 basic_string& operator=(nullptr_t) = delete;
861#endif // C++23
862
863 /**
864 * @brief Construct string as copy of a range.
865 * @param __beg Start of range.
866 * @param __end End of range.
867 * @param __a Allocator to use (default is default allocator).
868 */
869#if __cplusplus201703L >= 201103L
870 template<typename _InputIterator,
871 typename = std::_RequireInputIter<_InputIterator>>
872#else
873 template<typename _InputIterator>
874#endif
875 _GLIBCXX20_CONSTEXPR
876 basic_string(_InputIterator __beg, _InputIterator __end,
877 const _Alloc& __a = _Alloc())
878 : _M_dataplus(_M_local_data(), __a), _M_string_length(0)
879 {
880#if __cplusplus201703L >= 201103L
881 _M_construct(__beg, __end, std::__iterator_category(__beg));
882#else
883 typedef typename std::__is_integer<_InputIterator>::__type _Integral;
884 _M_construct_aux(__beg, __end, _Integral());
885#endif
886 }
887
888#ifdef __glibcxx_string_view201803L // >= C++17
889 /**
890 * @brief Construct string from a substring of a string_view.
891 * @param __t Source object convertible to string view.
892 * @param __pos The index of the first character to copy from __t.
893 * @param __n The number of characters to copy from __t.
894 * @param __a Allocator to use.
895 */
896 template<typename _Tp,
897 typename = enable_if_t<is_convertible_v<const _Tp&, __sv_type>>>
898 _GLIBCXX20_CONSTEXPR
899 basic_string(const _Tp& __t, size_type __pos, size_type __n,
900 const _Alloc& __a = _Alloc())
901 : basic_string(_S_to_string_view(__t).substr(__pos, __n), __a) { }
902
903 /**
904 * @brief Construct string from a string_view.
905 * @param __t Source object convertible to string view.
906 * @param __a Allocator to use (default is default allocator).
907 */
908 template<typename _Tp, typename = _If_sv<_Tp, void>>
909 _GLIBCXX20_CONSTEXPR
910 explicit
911 basic_string(const _Tp& __t, const _Alloc& __a = _Alloc())
912 : basic_string(__sv_wrapper(_S_to_string_view(__t)), __a) { }
913#endif // C++17
914
915 /**
916 * @brief Destroy the string instance.
917 */
918 _GLIBCXX20_CONSTEXPR
919 ~basic_string()
920 { _M_dispose(); }
921
922 /**
923 * @brief Assign the value of @a str to this string.
924 * @param __str Source string.
925 */
926 _GLIBCXX20_CONSTEXPR
927 basic_string&
928 operator=(const basic_string& __str)
929 {
930 return this->assign(__str);
931 }
932
933 /**
934 * @brief Copy contents of @a s into this string.
935 * @param __s Source null-terminated string.
936 */
937 _GLIBCXX20_CONSTEXPR
938 basic_string&
939 operator=(const _CharT* __s)
940 { return this->assign(__s); }
941
942 /**
943 * @brief Set value to string of length 1.
944 * @param __c Source character.
945 *
946 * Assigning to a character makes this string length 1 and
947 * (*this)[0] == @a c.
948 */
949 _GLIBCXX20_CONSTEXPR
950 basic_string&
951 operator=(_CharT __c)
952 {
953 this->assign(1, __c);
954 return *this;
955 }
956
957#if __cplusplus201703L >= 201103L
958 /**
959 * @brief Move assign the value of @a str to this string.
960 * @param __str Source string.
961 *
962 * The contents of @a str are moved into this string (without copying).
963 * @a str is a valid, but unspecified string.
964 */
965 // _GLIBCXX_RESOLVE_LIB_DEFECTS
966 // 2063. Contradictory requirements for string move assignment
967 _GLIBCXX20_CONSTEXPR
968 basic_string&
969 operator=(basic_string&& __str)
970 noexcept(_Alloc_traits::_S_nothrow_move())
971 {
972 const bool __equal_allocs = _Alloc_traits::_S_always_equal()
973 || _M_get_allocator() == __str._M_get_allocator();
974 if (!_M_is_local() && _Alloc_traits::_S_propagate_on_move_assign()
975 && !__equal_allocs)
976 {
977 // Destroy existing storage before replacing allocator.
978 _M_destroy(_M_allocated_capacity);
979 _M_data(_M_local_data());
980 _M_set_length(0);
981 }
982 // Replace allocator if POCMA is true.
983 std::__alloc_on_move(_M_get_allocator(), __str._M_get_allocator());
984
985 if (__str._M_is_local())
986 {
987 // We've always got room for a short string, just copy it
988 // (unless this is a self-move, because that would violate the
989 // char_traits::copy precondition that the ranges don't overlap).
990 if (__builtin_expect(std::__addressof(__str) != this, true))
991 {
992 if (__str.size())
993 this->_S_copy(_M_data(), __str._M_data(), __str.size());
994 _M_set_length(__str.size());
995 }
996 }
997 else if (_Alloc_traits::_S_propagate_on_move_assign() || __equal_allocs)
998 {
999 // Just move the allocated pointer, our allocator can free it.
1000 pointer __data = nullptr;
1001 size_type __capacity;
1002 if (!_M_is_local())
1003 {
1004 if (__equal_allocs)
1005 {
1006 // __str can reuse our existing storage.
1007 __data = _M_data();
1008 __capacity = _M_allocated_capacity;
1009 }
1010 else // __str can't use it, so free it.
1011 _M_destroy(_M_allocated_capacity);
1012 }
1013
1014 _M_data(__str._M_data());
1015 _M_length(__str.length());
1016 _M_capacity(__str._M_allocated_capacity);
1017 if (__data)
1018 {
1019 __str._M_data(__data);
1020 __str._M_capacity(__capacity);
1021 }
1022 else
1023 __str._M_data(__str._M_use_local_data());
1024 }
1025 else // Need to do a deep copy
1026 _M_assign(__str);
1027 __str.clear();
1028 return *this;
1029 }
1030
1031 /**
1032 * @brief Set value to string constructed from initializer %list.
1033 * @param __l std::initializer_list.
1034 */
1035 _GLIBCXX20_CONSTEXPR
1036 basic_string&
1037 operator=(initializer_list<_CharT> __l)
1038 {
1039 this->assign(__l.begin(), __l.size());
1040 return *this;
1041 }
1042#endif // C++11
1043
1044#ifdef __glibcxx_string_view201803L // >= C++17
1045 /**
1046 * @brief Set value to string constructed from a string_view.
1047 * @param __svt An object convertible to string_view.
1048 */
1049 template<typename _Tp>
1050 _GLIBCXX20_CONSTEXPR
1051 _If_sv<_Tp, basic_string&>
1052 operator=(const _Tp& __svt)
1053 { return this->assign(__svt); }
1054
1055 /**
1056 * @brief Convert to a string_view.
1057 * @return A string_view.
1058 */
1059 _GLIBCXX20_CONSTEXPR
1060 operator __sv_type() const noexcept
1061 { return __sv_type(data(), size()); }
1062#endif // C++17
1063
1064 // Iterators:
1065 /**
1066 * Returns a read/write iterator that points to the first character in
1067 * the %string.
1068 */
1069 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
1070 iterator
1071 begin() _GLIBCXX_NOEXCEPTnoexcept
1072 { return iterator(_M_data()); }
1073
1074 /**
1075 * Returns a read-only (constant) iterator that points to the first
1076 * character in the %string.
1077 */
1078 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
1079 const_iterator
1080 begin() const _GLIBCXX_NOEXCEPTnoexcept
1081 { return const_iterator(_M_data()); }
1082
1083 /**
1084 * Returns a read/write iterator that points one past the last
1085 * character in the %string.
1086 */
1087 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
1088 iterator
1089 end() _GLIBCXX_NOEXCEPTnoexcept
1090 { return iterator(_M_data() + this->size()); }
1091
1092 /**
1093 * Returns a read-only (constant) iterator that points one past the
1094 * last character in the %string.
1095 */
1096 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
1097 const_iterator
1098 end() const _GLIBCXX_NOEXCEPTnoexcept
1099 { return const_iterator(_M_data() + this->size()); }
1100
1101 /**
1102 * Returns a read/write reverse iterator that points to the last
1103 * character in the %string. Iteration is done in reverse element
1104 * order.
1105 */
1106 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
1107 reverse_iterator
1108 rbegin() _GLIBCXX_NOEXCEPTnoexcept
1109 { return reverse_iterator(this->end()); }
1110
1111 /**
1112 * Returns a read-only (constant) reverse iterator that points
1113 * to the last character in the %string. Iteration is done in
1114 * reverse element order.
1115 */
1116 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
1117 const_reverse_iterator
1118 rbegin() const _GLIBCXX_NOEXCEPTnoexcept
1119 { return const_reverse_iterator(this->end()); }
1120
1121 /**
1122 * Returns a read/write reverse iterator that points to one before the
1123 * first character in the %string. Iteration is done in reverse
1124 * element order.
1125 */
1126 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
1127 reverse_iterator
1128 rend() _GLIBCXX_NOEXCEPTnoexcept
1129 { return reverse_iterator(this->begin()); }
1130
1131 /**
1132 * Returns a read-only (constant) reverse iterator that points
1133 * to one before the first character in the %string. Iteration
1134 * is done in reverse element order.
1135 */
1136 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
1137 const_reverse_iterator
1138 rend() const _GLIBCXX_NOEXCEPTnoexcept
1139 { return const_reverse_iterator(this->begin()); }
1140
1141#if __cplusplus201703L >= 201103L
1142 /**
1143 * Returns a read-only (constant) iterator that points to the first
1144 * character in the %string.
1145 */
1146 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
1147 const_iterator
1148 cbegin() const noexcept
1149 { return const_iterator(this->_M_data()); }
1150
1151 /**
1152 * Returns a read-only (constant) iterator that points one past the
1153 * last character in the %string.
1154 */
1155 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
1156 const_iterator
1157 cend() const noexcept
1158 { return const_iterator(this->_M_data() + this->size()); }
1159
1160 /**
1161 * Returns a read-only (constant) reverse iterator that points
1162 * to the last character in the %string. Iteration is done in
1163 * reverse element order.
1164 */
1165 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
1166 const_reverse_iterator
1167 crbegin() const noexcept
1168 { return const_reverse_iterator(this->end()); }
1169
1170 /**
1171 * Returns a read-only (constant) reverse iterator that points
1172 * to one before the first character in the %string. Iteration
1173 * is done in reverse element order.
1174 */
1175 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
1176 const_reverse_iterator
1177 crend() const noexcept
1178 { return const_reverse_iterator(this->begin()); }
1179#endif
1180
1181 public:
1182 // Capacity:
1183 /// Returns the number of characters in the string, not including any
1184 /// null-termination.
1185 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
1186 size_type
1187 size() const _GLIBCXX_NOEXCEPTnoexcept
1188 {
1189 size_type __sz = _M_string_length;
1190 if (__sz > max_size ())
1191 __builtin_unreachable();
1192 return __sz;
1193 }
1194
1195 /// Returns the number of characters in the string, not including any
1196 /// null-termination.
1197 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
1198 size_type
1199 length() const _GLIBCXX_NOEXCEPTnoexcept
1200 { return size(); }
1201
1202 /// Returns the size() of the largest possible %string.
1203 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
1204 size_type
1205 max_size() const _GLIBCXX_NOEXCEPTnoexcept
1206 {
1207 const size_t __diffmax
1208 = __gnu_cxx::__numeric_traits<ptrdiff_t>::__max / sizeof(_CharT);
1209 const size_t __allocmax = _Alloc_traits::max_size(_M_get_allocator());
1210 return (std::min)(__diffmax, __allocmax) - 1;
1211 }
1212
1213 /**
1214 * @brief Resizes the %string to the specified number of characters.
1215 * @param __n Number of characters the %string should contain.
1216 * @param __c Character to fill any new elements.
1217 *
1218 * This function will %resize the %string to the specified
1219 * number of characters. If the number is smaller than the
1220 * %string's current size the %string is truncated, otherwise
1221 * the %string is extended and new elements are %set to @a __c.
1222 */
1223 _GLIBCXX20_CONSTEXPR
1224 void
1225 resize(size_type __n, _CharT __c);
1226
1227 /**
1228 * @brief Resizes the %string to the specified number of characters.
1229 * @param __n Number of characters the %string should contain.
1230 *
1231 * This function will resize the %string to the specified length. If
1232 * the new size is smaller than the %string's current size the %string
1233 * is truncated, otherwise the %string is extended and new characters
1234 * are default-constructed. For basic types such as char, this means
1235 * setting them to 0.
1236 */
1237 _GLIBCXX20_CONSTEXPR
1238 void
1239 resize(size_type __n)
1240 { this->resize(__n, _CharT()); }
1241
1242#if __cplusplus201703L >= 201103L
1243#pragma GCC diagnostic push
1244#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
1245 /// A non-binding request to reduce capacity() to size().
1246 _GLIBCXX20_CONSTEXPR
1247 void
1248 shrink_to_fit() noexcept
1249 { reserve(); }
1250#pragma GCC diagnostic pop
1251#endif
1252
1253#ifdef __glibcxx_string_resize_and_overwrite // C++ >= 23
1254 /** Resize the string and call a function to fill it.
1255 *
1256 * @param __n The maximum size requested.
1257 * @param __op A callable object that writes characters to the string.
1258 *
1259 * This is a low-level function that is easy to misuse, be careful.
1260 *
1261 * Calling `str.resize_and_overwrite(n, op)` will reserve at least `n`
1262 * characters in `str`, evaluate `n2 = std::move(op)(str.data(), n)`,
1263 * and finally set the string length to `n2` (adding a null terminator
1264 * at the end). The function object `op` is allowed to write to the
1265 * extra capacity added by the initial reserve operation, which is not
1266 * allowed if you just call `str.reserve(n)` yourself.
1267 *
1268 * This can be used to efficiently fill a `string` buffer without the
1269 * overhead of zero-initializing characters that will be overwritten
1270 * anyway.
1271 *
1272 * The callable `op` must not access the string directly (only through
1273 * the pointer passed as its first argument), must not write more than
1274 * `n` characters to the string, must return a value no greater than `n`,
1275 * and must ensure that all characters up to the returned length are
1276 * valid after it returns (i.e. there must be no uninitialized values
1277 * left in the string after the call, because accessing them would
1278 * have undefined behaviour). If `op` exits by throwing an exception
1279 * the behaviour is undefined.
1280 *
1281 * @since C++23
1282 */
1283 template<typename _Operation>
1284 constexpr void
1285 resize_and_overwrite(size_type __n, _Operation __op);
1286#endif
1287
1288#if __cplusplus201703L >= 201103L
1289 /// Non-standard version of resize_and_overwrite for C++11 and above.
1290 template<typename _Operation>
1291 _GLIBCXX20_CONSTEXPR void
1292 __resize_and_overwrite(size_type __n, _Operation __op);
1293#endif
1294
1295 /**
1296 * Returns the total number of characters that the %string can hold
1297 * before needing to allocate more memory.
1298 */
1299 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
1300 size_type
1301 capacity() const _GLIBCXX_NOEXCEPTnoexcept
1302 {
1303 size_t __sz = _M_is_local() ? size_type(_S_local_capacity)
1304 : _M_allocated_capacity;
1305 if (__sz < _S_local_capacity || __sz > max_size ())
1306 __builtin_unreachable();
1307 return __sz;
1308 }
1309
1310 /**
1311 * @brief Attempt to preallocate enough memory for specified number of
1312 * characters.
1313 * @param __res_arg Number of characters required.
1314 * @throw std::length_error If @a __res_arg exceeds @c max_size().
1315 *
1316 * This function attempts to reserve enough memory for the
1317 * %string to hold the specified number of characters. If the
1318 * number requested is more than max_size(), length_error is
1319 * thrown.
1320 *
1321 * The advantage of this function is that if optimal code is a
1322 * necessity and the user can determine the string length that will be
1323 * required, the user can reserve the memory in %advance, and thus
1324 * prevent a possible reallocation of memory and copying of %string
1325 * data.
1326 */
1327 _GLIBCXX20_CONSTEXPR
1328 void
1329 reserve(size_type __res_arg);
1330
1331 /**
1332 * Equivalent to shrink_to_fit().
1333 */
1334#if __cplusplus201703L >= 202002L
1335 [[deprecated("use shrink_to_fit() instead")]]
1336#endif
1337 _GLIBCXX20_CONSTEXPR
1338 void
1339 reserve();
1340
1341 /**
1342 * Erases the string, making it empty.
1343 */
1344 _GLIBCXX20_CONSTEXPR
1345 void
1346 clear() _GLIBCXX_NOEXCEPTnoexcept
1347 { _M_set_length(0); }
1348
1349 /**
1350 * Returns true if the %string is empty. Equivalent to
1351 * <code>*this == ""</code>.
1352 */
1353 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
1354 bool
1355 empty() const _GLIBCXX_NOEXCEPTnoexcept
1356 { return _M_string_length == 0; }
1357
1358 // Element access:
1359 /**
1360 * @brief Subscript access to the data contained in the %string.
1361 * @param __pos The index of the character to access.
1362 * @return Read-only (constant) reference to the character.
1363 *
1364 * This operator allows for easy, array-style, data access.
1365 * Note that data access with this operator is unchecked and
1366 * out_of_range lookups are not defined. (For checked lookups
1367 * see at().)
1368 */
1369 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
1370 const_reference
1371 operator[] (size_type __pos) const _GLIBCXX_NOEXCEPTnoexcept
1372 {
1373 __glibcxx_assert(__pos <= size())do { if (__builtin_expect(!bool(__pos <= size()), false)) std
::__glibcxx_assert_fail("/usr/bin/../lib/gcc/x86_64-redhat-linux/16/../../../../include/c++/16/bits/basic_string.h"
, 1373, __PRETTY_FUNCTION__, "__pos <= size()"); } while (
false)
;
1374 return _M_data()[__pos];
1375 }
1376
1377 /**
1378 * @brief Subscript access to the data contained in the %string.
1379 * @param __pos The index of the character to access.
1380 * @return Read/write reference to the character.
1381 *
1382 * This operator allows for easy, array-style, data access.
1383 * Note that data access with this operator is unchecked and
1384 * out_of_range lookups are not defined. (For checked lookups
1385 * see at().)
1386 */
1387 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
1388 reference
1389 operator[](size_type __pos)
1390 {
1391 // Allow pos == size() both in C++98 mode, as v3 extension,
1392 // and in C++11 mode.
1393 __glibcxx_assert(__pos <= size())do { if (__builtin_expect(!bool(__pos <= size()), false)) std
::__glibcxx_assert_fail("/usr/bin/../lib/gcc/x86_64-redhat-linux/16/../../../../include/c++/16/bits/basic_string.h"
, 1393, __PRETTY_FUNCTION__, "__pos <= size()"); } while (
false)
;
1394 // In pedantic mode be strict in C++98 mode.
1395 _GLIBCXX_DEBUG_PEDASSERT(__cplusplus >= 201103L || __pos < size());
1396 return _M_data()[__pos];
1397 }
1398
1399 /**
1400 * @brief Provides access to the data contained in the %string.
1401 * @param __n The index of the character to access.
1402 * @return Read-only (const) reference to the character.
1403 * @throw std::out_of_range If @a n is an invalid index.
1404 *
1405 * This function provides for safer data access. The parameter is
1406 * first checked that it is in the range of the string. The function
1407 * throws out_of_range if the check fails.
1408 */
1409 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
1410 const_reference
1411 at(size_type __n) const
1412 {
1413 if (__n >= this->size())
1414 __throw_out_of_range_fmt(__N("basic_string::at: __n "("basic_string::at: __n " "(which is %zu) >= this->size() "
"(which is %zu)")
1415 "(which is %zu) >= this->size() "("basic_string::at: __n " "(which is %zu) >= this->size() "
"(which is %zu)")
1416 "(which is %zu)")("basic_string::at: __n " "(which is %zu) >= this->size() "
"(which is %zu)")
,
1417 __n, this->size());
1418 return _M_data()[__n];
1419 }
1420
1421 /**
1422 * @brief Provides access to the data contained in the %string.
1423 * @param __n The index of the character to access.
1424 * @return Read/write reference to the character.
1425 * @throw std::out_of_range If @a n is an invalid index.
1426 *
1427 * This function provides for safer data access. The parameter is
1428 * first checked that it is in the range of the string. The function
1429 * throws out_of_range if the check fails.
1430 */
1431 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
1432 reference
1433 at(size_type __n)
1434 {
1435 if (__n >= size())
1436 __throw_out_of_range_fmt(__N("basic_string::at: __n "("basic_string::at: __n " "(which is %zu) >= this->size() "
"(which is %zu)")
1437 "(which is %zu) >= this->size() "("basic_string::at: __n " "(which is %zu) >= this->size() "
"(which is %zu)")
1438 "(which is %zu)")("basic_string::at: __n " "(which is %zu) >= this->size() "
"(which is %zu)")
,
1439 __n, this->size());
1440 return _M_data()[__n];
1441 }
1442
1443#if __cplusplus201703L >= 201103L
1444 /**
1445 * Returns a read/write reference to the data at the first
1446 * element of the %string.
1447 */
1448 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
1449 reference
1450 front() noexcept
1451 {
1452 __glibcxx_assert(!empty())do { if (__builtin_expect(!bool(!empty()), false)) std::__glibcxx_assert_fail
("/usr/bin/../lib/gcc/x86_64-redhat-linux/16/../../../../include/c++/16/bits/basic_string.h"
, 1452, __PRETTY_FUNCTION__, "!empty()"); } while (false)
;
1453 return operator[](0);
1454 }
1455
1456 /**
1457 * Returns a read-only (constant) reference to the data at the first
1458 * element of the %string.
1459 */
1460 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
1461 const_reference
1462 front() const noexcept
1463 {
1464 __glibcxx_assert(!empty())do { if (__builtin_expect(!bool(!empty()), false)) std::__glibcxx_assert_fail
("/usr/bin/../lib/gcc/x86_64-redhat-linux/16/../../../../include/c++/16/bits/basic_string.h"
, 1464, __PRETTY_FUNCTION__, "!empty()"); } while (false)
;
1465 return operator[](0);
1466 }
1467
1468 /**
1469 * Returns a read/write reference to the data at the last
1470 * element of the %string.
1471 */
1472 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
1473 reference
1474 back() noexcept
1475 {
1476 __glibcxx_assert(!empty())do { if (__builtin_expect(!bool(!empty()), false)) std::__glibcxx_assert_fail
("/usr/bin/../lib/gcc/x86_64-redhat-linux/16/../../../../include/c++/16/bits/basic_string.h"
, 1476, __PRETTY_FUNCTION__, "!empty()"); } while (false)
;
1477 return operator[](this->size() - 1);
1478 }
1479
1480 /**
1481 * Returns a read-only (constant) reference to the data at the
1482 * last element of the %string.
1483 */
1484 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
1485 const_reference
1486 back() const noexcept
1487 {
1488 __glibcxx_assert(!empty())do { if (__builtin_expect(!bool(!empty()), false)) std::__glibcxx_assert_fail
("/usr/bin/../lib/gcc/x86_64-redhat-linux/16/../../../../include/c++/16/bits/basic_string.h"
, 1488, __PRETTY_FUNCTION__, "!empty()"); } while (false)
;
1489 return operator[](this->size() - 1);
1490 }
1491#endif
1492
1493 // Modifiers:
1494 /**
1495 * @brief Append a string to this string.
1496 * @param __str The string to append.
1497 * @return Reference to this string.
1498 */
1499 _GLIBCXX20_CONSTEXPR
1500 basic_string&
1501 operator+=(const basic_string& __str)
1502 { return this->append(__str); }
1503
1504 /**
1505 * @brief Append a C string.
1506 * @param __s The C string to append.
1507 * @return Reference to this string.
1508 */
1509 _GLIBCXX20_CONSTEXPR
1510 basic_string&
1511 operator+=(const _CharT* __s)
1512 { return this->append(__s); }
1513
1514 /**
1515 * @brief Append a character.
1516 * @param __c The character to append.
1517 * @return Reference to this string.
1518 */
1519 _GLIBCXX20_CONSTEXPR
1520 basic_string&
1521 operator+=(_CharT __c)
1522 {
1523 this->push_back(__c);
1524 return *this;
1525 }
1526
1527#if __cplusplus201703L >= 201103L
1528 /**
1529 * @brief Append an initializer_list of characters.
1530 * @param __l The initializer_list of characters to be appended.
1531 * @return Reference to this string.
1532 */
1533 _GLIBCXX20_CONSTEXPR
1534 basic_string&
1535 operator+=(initializer_list<_CharT> __l)
1536 { return this->append(__l.begin(), __l.size()); }
1537#endif // C++11
1538
1539#ifdef __glibcxx_string_view201803L // >= C++17
1540 /**
1541 * @brief Append a string_view.
1542 * @param __svt An object convertible to string_view to be appended.
1543 * @return Reference to this string.
1544 */
1545 template<typename _Tp>
1546 _GLIBCXX20_CONSTEXPR
1547 _If_sv<_Tp, basic_string&>
1548 operator+=(const _Tp& __svt)
1549 { return this->append(__svt); }
1550#endif // C++17
1551
1552 /**
1553 * @brief Append a string to this string.
1554 * @param __str The string to append.
1555 * @return Reference to this string.
1556 */
1557 _GLIBCXX20_CONSTEXPR
1558 basic_string&
1559 append(const basic_string& __str)
1560 { return this->append(__str._M_data(), __str.size()); }
1561
1562 /**
1563 * @brief Append a substring.
1564 * @param __str The string to append.
1565 * @param __pos Index of the first character of str to append.
1566 * @param __n The number of characters to append.
1567 * @return Reference to this string.
1568 * @throw std::out_of_range if @a __pos is not a valid index.
1569 *
1570 * This function appends @a __n characters from @a __str
1571 * starting at @a __pos to this string. If @a __n is is larger
1572 * than the number of available characters in @a __str, the
1573 * remainder of @a __str is appended.
1574 */
1575 _GLIBCXX20_CONSTEXPR
1576 basic_string&
1577 append(const basic_string& __str, size_type __pos, size_type __n = npos)
1578 { return this->append(__str._M_data()
1579 + __str._M_check(__pos, "basic_string::append"),
1580 __str._M_limit(__pos, __n)); }
1581
1582 /**
1583 * @brief Append a C substring.
1584 * @param __s The C string to append.
1585 * @param __n The number of characters to append.
1586 * @return Reference to this string.
1587 */
1588 _GLIBCXX20_CONSTEXPR
1589 basic_string&
1590 append(const _CharT* __s, size_type __n)
1591 {
1592 __glibcxx_requires_string_len(__s, __n);
1593 _M_check_length(size_type(0), __n, "basic_string::append");
1594 return _M_append(__s, __n);
1595 }
1596
1597 /**
1598 * @brief Append a C string.
1599 * @param __s The C string to append.
1600 * @return Reference to this string.
1601 */
1602 _GLIBCXX20_CONSTEXPR
1603 basic_string&
1604 append(const _CharT* __s)
1605 {
1606 __glibcxx_requires_string(__s);
1607 const size_type __n = traits_type::length(__s);
1608 _M_check_length(size_type(0), __n, "basic_string::append");
1609 return _M_append(__s, __n);
1610 }
1611
1612 /**
1613 * @brief Append multiple characters.
1614 * @param __n The number of characters to append.
1615 * @param __c The character to use.
1616 * @return Reference to this string.
1617 *
1618 * Appends __n copies of __c to this string.
1619 */
1620 _GLIBCXX20_CONSTEXPR
1621 basic_string&
1622 append(size_type __n, _CharT __c)
1623 { return _M_replace_aux(this->size(), size_type(0), __n, __c); }
1624
1625#if __glibcxx_containers_ranges // C++ >= 23
1626 /**
1627 * @brief Append a range to the string.
1628 * @param __rg A range of values that are convertible to `value_type`.
1629 * @since C++23
1630 *
1631 * The range `__rg` is allowed to overlap with `*this`.
1632 */
1633 template<__detail::__container_compatible_range<_CharT> _Rg>
1634 constexpr basic_string&
1635 append_range(_Rg&& __rg)
1636 {
1637 // N.B. __rg may overlap with *this, so we must copy from __rg before
1638 // existing elements or iterators referring to *this are invalidated.
1639 // e.g. in s.append_range(views::concat(s, str)), rg overlaps s.
1640 if constexpr (ranges::forward_range<_Rg> || ranges::sized_range<_Rg>)
1641 {
1642 const auto __len = size_type(ranges::distance(__rg));
1643
1644 // Don't care if this addition wraps around, we check it below:
1645 const size_type __newlen = size() + __len;
1646
1647 if ((capacity() - size()) >= __len)
1648 _S_copy_range(_M_data() + size(), std::forward<_Rg>(__rg),
1649 __len);
1650 else
1651 {
1652 _M_check_length(0, __len, "basic_string::append_range");
1653 basic_string __s(_M_get_allocator());
1654 __s.reserve(__newlen);
1655 _S_copy_range(__s._M_data() + size(), std::forward<_Rg>(__rg),
1656 __len);
1657 _S_copy(__s._M_data(), _M_data(), size());
1658 if (!_M_is_local())
1659 _M_destroy(_M_allocated_capacity);
1660 _M_data(__s._M_data());
1661 _M_capacity(__s._M_allocated_capacity);
1662 __s._M_data(__s._M_local_data());
1663 __s._M_length(0);
1664 }
1665 _M_set_length(__newlen); // adds null-terminator
1666 }
1667 else
1668 {
1669 basic_string __s(from_range, std::forward<_Rg>(__rg),
1670 _M_get_allocator());
1671 append(__s);
1672 }
1673 return *this;
1674 }
1675#endif
1676
1677#if __cplusplus201703L >= 201103L
1678 /**
1679 * @brief Append an initializer_list of characters.
1680 * @param __l The initializer_list of characters to append.
1681 * @return Reference to this string.
1682 */
1683 _GLIBCXX20_CONSTEXPR
1684 basic_string&
1685 append(initializer_list<_CharT> __l)
1686 { return this->append(__l.begin(), __l.size()); }
1687#endif // C++11
1688
1689 /**
1690 * @brief Append a range of characters.
1691 * @param __first Iterator referencing the first character to append.
1692 * @param __last Iterator marking the end of the range.
1693 * @return Reference to this string.
1694 *
1695 * Appends characters in the range [__first,__last) to this string.
1696 */
1697#if __cplusplus201703L >= 201103L
1698 template<class _InputIterator,
1699 typename = std::_RequireInputIter<_InputIterator>>
1700 _GLIBCXX20_CONSTEXPR
1701#else
1702 template<class _InputIterator>
1703#endif
1704 basic_string&
1705 append(_InputIterator __first, _InputIterator __last)
1706 { return this->replace(end(), end(), __first, __last); }
1707
1708#ifdef __glibcxx_string_view201803L
1709 /**
1710 * @brief Append a string_view.
1711 * @param __svt An object convertible to string_view to be appended.
1712 * @return Reference to this string.
1713 */
1714 template<typename _Tp>
1715 _GLIBCXX20_CONSTEXPR
1716 _If_sv<_Tp, basic_string&>
1717 append(const _Tp& __svt)
1718 {
1719 __sv_type __sv = __svt;
1720 return this->append(__sv.data(), __sv.size());
1721 }
1722
1723 /**
1724 * @brief Append a range of characters from a string_view.
1725 * @param __svt An object convertible to string_view to be appended from.
1726 * @param __pos The position in the string_view to append from.
1727 * @param __n The number of characters to append from the string_view.
1728 * @return Reference to this string.
1729 */
1730 template<typename _Tp>
1731 _GLIBCXX20_CONSTEXPR
1732 _If_sv<_Tp, basic_string&>
1733 append(const _Tp& __svt, size_type __pos, size_type __n = npos)
1734 {
1735 __sv_type __sv = __svt;
1736 return _M_append(__sv.data()
1737 + std::__sv_check(__sv.size(), __pos, "basic_string::append"),
1738 std::__sv_limit(__sv.size(), __pos, __n));
1739 }
1740#endif // C++17
1741
1742 /**
1743 * @brief Append a single character.
1744 * @param __c Character to append.
1745 */
1746 _GLIBCXX20_CONSTEXPR
1747 void
1748 push_back(_CharT __c)
1749 {
1750 const size_type __size = this->size();
1751 if (__size + 1 > this->capacity())
1752 this->_M_mutate(__size, size_type(0), 0, size_type(1));
1753 traits_type::assign(this->_M_data()[__size], __c);
1754 this->_M_set_length(__size + 1);
1755 }
1756
1757 /**
1758 * @brief Set value to contents of another string.
1759 * @param __str Source string to use.
1760 * @return Reference to this string.
1761 */
1762 _GLIBCXX20_CONSTEXPR
1763 basic_string&
1764 assign(const basic_string& __str)
1765 {
1766#if __cplusplus201703L >= 201103L
1767 if (_Alloc_traits::_S_propagate_on_copy_assign())
1768 {
1769 if (!_Alloc_traits::_S_always_equal() && !_M_is_local()
1770 && _M_get_allocator() != __str._M_get_allocator())
1771 {
1772 // Propagating allocator cannot free existing storage so must
1773 // deallocate it before replacing current allocator.
1774 if (__str.size() <= _S_local_capacity)
1775 {
1776 _M_destroy(_M_allocated_capacity);
1777 _M_data(_M_use_local_data());
1778 _M_set_length(0);
1779 }
1780 else
1781 {
1782 const auto __len = __str.size();
1783 auto __alloc = __str._M_get_allocator();
1784 // If this allocation throws there are no effects:
1785 auto __ptr = _S_allocate(__alloc, __len + 1);
1786 _M_destroy(_M_allocated_capacity);
1787 _M_data(__ptr);
1788 _M_capacity(__len);
1789 _M_set_length(__len);
1790 }
1791 }
1792 std::__alloc_on_copy(_M_get_allocator(), __str._M_get_allocator());
1793 }
1794#endif
1795 this->_M_assign(__str);
1796 return *this;
1797 }
1798
1799#if __cplusplus201703L >= 201103L
1800 /**
1801 * @brief Set value to contents of another string.
1802 * @param __str Source string to use.
1803 * @return Reference to this string.
1804 *
1805 * This function sets this string to the exact contents of @a __str.
1806 * @a __str is a valid, but unspecified string.
1807 */
1808 _GLIBCXX20_CONSTEXPR
1809 basic_string&
1810 assign(basic_string&& __str)
1811 noexcept(_Alloc_traits::_S_nothrow_move())
1812 {
1813 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1814 // 2063. Contradictory requirements for string move assignment
1815 return *this = std::move(__str);
1816 }
1817#endif // C++11
1818
1819 /**
1820 * @brief Set value to a substring of a string.
1821 * @param __str The string to use.
1822 * @param __pos Index of the first character of str.
1823 * @param __n Number of characters to use.
1824 * @return Reference to this string.
1825 * @throw std::out_of_range if @a pos is not a valid index.
1826 *
1827 * This function sets this string to the substring of @a __str
1828 * consisting of @a __n characters at @a __pos. If @a __n is
1829 * is larger than the number of available characters in @a
1830 * __str, the remainder of @a __str is used.
1831 */
1832 _GLIBCXX20_CONSTEXPR
1833 basic_string&
1834 assign(const basic_string& __str, size_type __pos, size_type __n = npos)
1835 { return _M_replace(size_type(0), this->size(), __str._M_data()
1836 + __str._M_check(__pos, "basic_string::assign"),
1837 __str._M_limit(__pos, __n)); }
1838
1839 /**
1840 * @brief Set value to a C substring.
1841 * @param __s The C string to use.
1842 * @param __n Number of characters to use.
1843 * @return Reference to this string.
1844 *
1845 * This function sets the value of this string to the first @a __n
1846 * characters of @a __s. If @a __n is is larger than the number of
1847 * available characters in @a __s, the remainder of @a __s is used.
1848 */
1849 _GLIBCXX20_CONSTEXPR
1850 basic_string&
1851 assign(const _CharT* __s, size_type __n)
1852 {
1853 __glibcxx_requires_string_len(__s, __n);
1854 return _M_replace(size_type(0), this->size(), __s, __n);
1855 }
1856
1857 /**
1858 * @brief Set value to contents of a C string.
1859 * @param __s The C string to use.
1860 * @return Reference to this string.
1861 *
1862 * This function sets the value of this string to the value of @a __s.
1863 * The data is copied, so there is no dependence on @a __s once the
1864 * function returns.
1865 */
1866 _GLIBCXX20_CONSTEXPR
1867 basic_string&
1868 assign(const _CharT* __s)
1869 {
1870 __glibcxx_requires_string(__s);
1871 return _M_replace(size_type(0), this->size(), __s,
1872 traits_type::length(__s));
1873 }
1874
1875 /**
1876 * @brief Set value to multiple characters.
1877 * @param __n Length of the resulting string.
1878 * @param __c The character to use.
1879 * @return Reference to this string.
1880 *
1881 * This function sets the value of this string to @a __n copies of
1882 * character @a __c.
1883 */
1884 _GLIBCXX20_CONSTEXPR
1885 basic_string&
1886 assign(size_type __n, _CharT __c)
1887 { return _M_replace_aux(size_type(0), this->size(), __n, __c); }
1888
1889 /**
1890 * @brief Set value to a range of characters.
1891 * @param __first Iterator referencing the first character to append.
1892 * @param __last Iterator marking the end of the range.
1893 * @return Reference to this string.
1894 *
1895 * Sets value of string to characters in the range [__first,__last).
1896 */
1897#if __cplusplus201703L >= 201103L
1898#pragma GCC diagnostic push
1899#pragma GCC diagnostic ignored "-Wc++17-extensions"
1900 template<class _InputIterator,
1901 typename = std::_RequireInputIter<_InputIterator>>
1902 _GLIBCXX20_CONSTEXPR
1903 basic_string&
1904 assign(_InputIterator __first, _InputIterator __last)
1905 {
1906 using _IterTraits = iterator_traits<_InputIterator>;
1907 if constexpr (is_pointer<decltype(std::__niter_base(__first))>::value
1908 && is_same<typename _IterTraits::value_type,
1909 _CharT>::value)
1910 {
1911 __glibcxx_requires_valid_range(__first, __last);
1912 return _M_replace(size_type(0), size(),
1913 std::__niter_base(__first), __last - __first);
1914 }
1915#if __cplusplus201703L >= 202002L
1916 else if constexpr (contiguous_iterator<_InputIterator>
1917 && is_same_v<iter_value_t<_InputIterator>,
1918 _CharT>)
1919 {
1920 __glibcxx_requires_valid_range(__first, __last);
1921 return _M_replace(size_type(0), size(),
1922 std::to_address(__first), __last - __first);
1923 }
1924#endif
1925 else
1926 return *this = basic_string(__first, __last, get_allocator());
1927 }
1928#pragma GCC diagnostic pop
1929#else
1930 template<class _InputIterator>
1931 basic_string&
1932 assign(_InputIterator __first, _InputIterator __last)
1933 { return this->replace(begin(), end(), __first, __last); }
1934#endif
1935
1936#if __glibcxx_containers_ranges // C++ >= 23
1937 /**
1938 * @brief Assign a range to the string.
1939 * @param __rg A range of values that are convertible to `value_type`.
1940 * @since C++23
1941 *
1942 * The range `__rg` is allowed to overlap with `*this`.
1943 */
1944 template<__detail::__container_compatible_range<_CharT> _Rg>
1945 constexpr basic_string&
1946 assign_range(_Rg&& __rg)
1947 {
1948 basic_string __s(from_range, std::forward<_Rg>(__rg),
1949 _M_get_allocator());
1950 assign(std::move(__s));
1951 return *this;
1952 }
1953#endif
1954
1955#if __cplusplus201703L >= 201103L
1956 /**
1957 * @brief Set value to an initializer_list of characters.
1958 * @param __l The initializer_list of characters to assign.
1959 * @return Reference to this string.
1960 */
1961 _GLIBCXX20_CONSTEXPR
1962 basic_string&
1963 assign(initializer_list<_CharT> __l)
1964 {
1965 // The initializer_list array cannot alias the characters in *this
1966 // so we don't need to use replace to that case.
1967 const size_type __n = __l.size();
1968 if (__n > capacity())
1969 *this = basic_string(__l.begin(), __l.end(), get_allocator());
1970 else
1971 {
1972 if (__n)
1973 _S_copy(_M_data(), __l.begin(), __n);
1974 _M_set_length(__n);
1975 }
1976 return *this;
1977 }
1978#endif // C++11
1979
1980#ifdef __glibcxx_string_view201803L // >= C++17
1981 /**
1982 * @brief Set value from a string_view.
1983 * @param __svt The source object convertible to string_view.
1984 * @return Reference to this string.
1985 */
1986 template<typename _Tp>
1987 _GLIBCXX20_CONSTEXPR
1988 _If_sv<_Tp, basic_string&>
1989 assign(const _Tp& __svt)
1990 {
1991 __sv_type __sv = __svt;
1992 return this->assign(__sv.data(), __sv.size());
1993 }
1994
1995 /**
1996 * @brief Set value from a range of characters in a string_view.
1997 * @param __svt The source object convertible to string_view.
1998 * @param __pos The position in the string_view to assign from.
1999 * @param __n The number of characters to assign.
2000 * @return Reference to this string.
2001 */
2002 template<typename _Tp>
2003 _GLIBCXX20_CONSTEXPR
2004 _If_sv<_Tp, basic_string&>
2005 assign(const _Tp& __svt, size_type __pos, size_type __n = npos)
2006 {
2007 __sv_type __sv = __svt;
2008 return _M_replace(size_type(0), this->size(),
2009 __sv.data()
2010 + std::__sv_check(__sv.size(), __pos, "basic_string::assign"),
2011 std::__sv_limit(__sv.size(), __pos, __n));
2012 }
2013#endif // C++17
2014
2015#if __cplusplus201703L >= 201103L
2016 /**
2017 * @brief Insert multiple characters.
2018 * @param __p Const_iterator referencing location in string to
2019 * insert at.
2020 * @param __n Number of characters to insert
2021 * @param __c The character to insert.
2022 * @return Iterator referencing the first inserted char.
2023 * @throw std::length_error If new length exceeds @c max_size().
2024 *
2025 * Inserts @a __n copies of character @a __c starting at the
2026 * position referenced by iterator @a __p. If adding
2027 * characters causes the length to exceed max_size(),
2028 * length_error is thrown. The value of the string doesn't
2029 * change if an error is thrown.
2030 */
2031 _GLIBCXX20_CONSTEXPR
2032 iterator
2033 insert(const_iterator __p, size_type __n, _CharT __c)
2034 {
2035 _GLIBCXX_DEBUG_PEDASSERT(__p >= begin() && __p <= end());
2036 const size_type __pos = __p - begin();
2037 this->replace(__p, __p, __n, __c);
2038 return iterator(this->_M_data() + __pos);
2039 }
2040#else
2041 /**
2042 * @brief Insert multiple characters.
2043 * @param __p Iterator referencing location in string to insert at.
2044 * @param __n Number of characters to insert
2045 * @param __c The character to insert.
2046 * @throw std::length_error If new length exceeds @c max_size().
2047 *
2048 * Inserts @a __n copies of character @a __c starting at the
2049 * position referenced by iterator @a __p. If adding
2050 * characters causes the length to exceed max_size(),
2051 * length_error is thrown. The value of the string doesn't
2052 * change if an error is thrown.
2053 */
2054 void
2055 insert(iterator __p, size_type __n, _CharT __c)
2056 { this->replace(__p, __p, __n, __c); }
2057#endif
2058
2059#if __cplusplus201703L >= 201103L
2060 /**
2061 * @brief Insert a range of characters.
2062 * @param __p Const_iterator referencing location in string to
2063 * insert at.
2064 * @param __beg Start of range.
2065 * @param __end End of range.
2066 * @return Iterator referencing the first inserted char.
2067 * @throw std::length_error If new length exceeds @c max_size().
2068 *
2069 * Inserts characters in range [beg,end). If adding characters
2070 * causes the length to exceed max_size(), length_error is
2071 * thrown. The value of the string doesn't change if an error
2072 * is thrown.
2073 */
2074 template<class _InputIterator,
2075 typename = std::_RequireInputIter<_InputIterator>>
2076 _GLIBCXX20_CONSTEXPR
2077 iterator
2078 insert(const_iterator __p, _InputIterator __beg, _InputIterator __end)
2079 {
2080 _GLIBCXX_DEBUG_PEDASSERT(__p >= begin() && __p <= end());
2081 const size_type __pos = __p - begin();
2082 this->replace(__p, __p, __beg, __end);
2083 return iterator(this->_M_data() + __pos);
2084 }
2085#else
2086 /**
2087 * @brief Insert a range of characters.
2088 * @param __p Iterator referencing location in string to insert at.
2089 * @param __beg Start of range.
2090 * @param __end End of range.
2091 * @throw std::length_error If new length exceeds @c max_size().
2092 *
2093 * Inserts characters in range [__beg,__end). If adding
2094 * characters causes the length to exceed max_size(),
2095 * length_error is thrown. The value of the string doesn't
2096 * change if an error is thrown.
2097 */
2098 template<class _InputIterator>
2099 void
2100 insert(iterator __p, _InputIterator __beg, _InputIterator __end)
2101 { this->replace(__p, __p, __beg, __end); }
2102#endif
2103
2104#if __glibcxx_containers_ranges // C++ >= 23
2105 /**
2106 * @brief Insert a range into the string.
2107 * @param __rg A range of values that are convertible to `value_type`.
2108 * @since C++23
2109 *
2110 * The range `__rg` is allowed to overlap with `*this`.
2111 */
2112 template<__detail::__container_compatible_range<_CharT> _Rg>
2113 constexpr iterator
2114 insert_range(const_iterator __p, _Rg&& __rg)
2115 {
2116 auto __pos = __p - cbegin();
2117
2118 if constexpr (ranges::forward_range<_Rg>)
2119 if (ranges::empty(__rg))
2120 return begin() + __pos;
2121
2122
2123 if (__p == cend())
2124 append_range(std::forward<_Rg>(__rg));
2125 else
2126 {
2127 basic_string __s(from_range, std::forward<_Rg>(__rg),
2128 _M_get_allocator());
2129 insert(__pos, __s);
2130 }
2131 return begin() + __pos;
2132 }
2133#endif
2134
2135#if __cplusplus201703L >= 201103L
2136 /**
2137 * @brief Insert an initializer_list of characters.
2138 * @param __p Iterator referencing location in string to insert at.
2139 * @param __l The initializer_list of characters to insert.
2140 * @throw std::length_error If new length exceeds @c max_size().
2141 */
2142 _GLIBCXX20_CONSTEXPR
2143 iterator
2144 insert(const_iterator __p, initializer_list<_CharT> __l)
2145 { return this->insert(__p, __l.begin(), __l.end()); }
2146
2147#ifdef _GLIBCXX_DEFINING_STRING_INSTANTIATIONS
2148 // See PR libstdc++/83328
2149 void
2150 insert(iterator __p, initializer_list<_CharT> __l)
2151 {
2152 _GLIBCXX_DEBUG_PEDASSERT(__p >= begin() && __p <= end());
2153 this->insert(__p - begin(), __l.begin(), __l.size());
2154 }
2155#endif
2156#endif // C++11
2157
2158 /**
2159 * @brief Insert value of a string.
2160 * @param __pos1 Position in string to insert at.
2161 * @param __str The string to insert.
2162 * @return Reference to this string.
2163 * @throw std::length_error If new length exceeds @c max_size().
2164 *
2165 * Inserts value of @a __str starting at @a __pos1. If adding
2166 * characters causes the length to exceed max_size(),
2167 * length_error is thrown. The value of the string doesn't
2168 * change if an error is thrown.
2169 */
2170 _GLIBCXX20_CONSTEXPR
2171 basic_string&
2172 insert(size_type __pos1, const basic_string& __str)
2173 { return this->replace(__pos1, size_type(0),
2174 __str._M_data(), __str.size()); }
2175
2176 /**
2177 * @brief Insert a substring.
2178 * @param __pos1 Position in string to insert at.
2179 * @param __str The string to insert.
2180 * @param __pos2 Start of characters in str to insert.
2181 * @param __n Number of characters to insert.
2182 * @return Reference to this string.
2183 * @throw std::length_error If new length exceeds @c max_size().
2184 * @throw std::out_of_range If @a pos1 > size() or
2185 * @a __pos2 > @a str.size().
2186 *
2187 * Starting at @a pos1, insert @a __n character of @a __str
2188 * beginning with @a __pos2. If adding characters causes the
2189 * length to exceed max_size(), length_error is thrown. If @a
2190 * __pos1 is beyond the end of this string or @a __pos2 is
2191 * beyond the end of @a __str, out_of_range is thrown. The
2192 * value of the string doesn't change if an error is thrown.
2193 */
2194 _GLIBCXX20_CONSTEXPR
2195 basic_string&
2196 insert(size_type __pos1, const basic_string& __str,
2197 size_type __pos2, size_type __n = npos)
2198 { return this->replace(__pos1, size_type(0), __str._M_data()
2199 + __str._M_check(__pos2, "basic_string::insert"),
2200 __str._M_limit(__pos2, __n)); }
2201
2202 /**
2203 * @brief Insert a C substring.
2204 * @param __pos Position in string to insert at.
2205 * @param __s The C string to insert.
2206 * @param __n The number of characters to insert.
2207 * @return Reference to this string.
2208 * @throw std::length_error If new length exceeds @c max_size().
2209 * @throw std::out_of_range If @a __pos is beyond the end of this
2210 * string.
2211 *
2212 * Inserts the first @a __n characters of @a __s starting at @a
2213 * __pos. If adding characters causes the length to exceed
2214 * max_size(), length_error is thrown. If @a __pos is beyond
2215 * end(), out_of_range is thrown. The value of the string
2216 * doesn't change if an error is thrown.
2217 */
2218 _GLIBCXX20_CONSTEXPR
2219 basic_string&
2220 insert(size_type __pos, const _CharT* __s, size_type __n)
2221 { return this->replace(__pos, size_type(0), __s, __n); }
2222
2223 /**
2224 * @brief Insert a C string.
2225 * @param __pos Position in string to insert at.
2226 * @param __s The C string to insert.
2227 * @return Reference to this string.
2228 * @throw std::length_error If new length exceeds @c max_size().
2229 * @throw std::out_of_range If @a pos is beyond the end of this
2230 * string.
2231 *
2232 * Inserts the first @a n characters of @a __s starting at @a __pos. If
2233 * adding characters causes the length to exceed max_size(),
2234 * length_error is thrown. If @a __pos is beyond end(), out_of_range is
2235 * thrown. The value of the string doesn't change if an error is
2236 * thrown.
2237 */
2238 _GLIBCXX20_CONSTEXPR
2239 basic_string&
2240 insert(size_type __pos, const _CharT* __s)
2241 {
2242 __glibcxx_requires_string(__s);
2243 return this->replace(__pos, size_type(0), __s,
2244 traits_type::length(__s));
2245 }
2246
2247 /**
2248 * @brief Insert multiple characters.
2249 * @param __pos Index in string to insert at.
2250 * @param __n Number of characters to insert
2251 * @param __c The character to insert.
2252 * @return Reference to this string.
2253 * @throw std::length_error If new length exceeds @c max_size().
2254 * @throw std::out_of_range If @a __pos is beyond the end of this
2255 * string.
2256 *
2257 * Inserts @a __n copies of character @a __c starting at index
2258 * @a __pos. If adding characters causes the length to exceed
2259 * max_size(), length_error is thrown. If @a __pos > length(),
2260 * out_of_range is thrown. The value of the string doesn't
2261 * change if an error is thrown.
2262 */
2263 _GLIBCXX20_CONSTEXPR
2264 basic_string&
2265 insert(size_type __pos, size_type __n, _CharT __c)
2266 { return _M_replace_aux(_M_check(__pos, "basic_string::insert"),
2267 size_type(0), __n, __c); }
2268
2269 /**
2270 * @brief Insert one character.
2271 * @param __p Iterator referencing position in string to insert at.
2272 * @param __c The character to insert.
2273 * @return Iterator referencing newly inserted char.
2274 * @throw std::length_error If new length exceeds @c max_size().
2275 *
2276 * Inserts character @a __c at position referenced by @a __p.
2277 * If adding character causes the length to exceed max_size(),
2278 * length_error is thrown. If @a __p is beyond end of string,
2279 * out_of_range is thrown. The value of the string doesn't
2280 * change if an error is thrown.
2281 */
2282 _GLIBCXX20_CONSTEXPR
2283 iterator
2284 insert(__const_iterator __p, _CharT __c)
2285 {
2286 _GLIBCXX_DEBUG_PEDASSERT(__p >= begin() && __p <= end());
2287 const size_type __pos = __p - begin();
2288 _M_replace_aux(__pos, size_type(0), size_type(1), __c);
2289 return iterator(_M_data() + __pos);
2290 }
2291
2292#ifdef __glibcxx_string_view201803L // >= C++17
2293 /**
2294 * @brief Insert a string_view.
2295 * @param __pos Position in string to insert at.
2296 * @param __svt The object convertible to string_view to insert.
2297 * @return Reference to this string.
2298 */
2299 template<typename _Tp>
2300 _GLIBCXX20_CONSTEXPR
2301 _If_sv<_Tp, basic_string&>
2302 insert(size_type __pos, const _Tp& __svt)
2303 {
2304 __sv_type __sv = __svt;
2305 return this->insert(__pos, __sv.data(), __sv.size());
2306 }
2307
2308 /**
2309 * @brief Insert a string_view.
2310 * @param __pos1 Position in string to insert at.
2311 * @param __svt The object convertible to string_view to insert from.
2312 * @param __pos2 Start of characters in str to insert.
2313 * @param __n The number of characters to insert.
2314 * @return Reference to this string.
2315 */
2316 template<typename _Tp>
2317 _GLIBCXX20_CONSTEXPR
2318 _If_sv<_Tp, basic_string&>
2319 insert(size_type __pos1, const _Tp& __svt,
2320 size_type __pos2, size_type __n = npos)
2321 {
2322 __sv_type __sv = __svt;
2323 return this->replace(__pos1, size_type(0),
2324 __sv.data()
2325 + std::__sv_check(__sv.size(), __pos2, "basic_string::insert"),
2326 std::__sv_limit(__sv.size(), __pos2, __n));
2327 }
2328#endif // C++17
2329
2330 /**
2331 * @brief Remove characters.
2332 * @param __pos Index of first character to remove (default 0).
2333 * @param __n Number of characters to remove (default remainder).
2334 * @return Reference to this string.
2335 * @throw std::out_of_range If @a pos is beyond the end of this
2336 * string.
2337 *
2338 * Removes @a __n characters from this string starting at @a
2339 * __pos. The length of the string is reduced by @a __n. If
2340 * there are < @a __n characters to remove, the remainder of
2341 * the string is truncated. If @a __p is beyond end of string,
2342 * out_of_range is thrown. The value of the string doesn't
2343 * change if an error is thrown.
2344 */
2345 _GLIBCXX20_CONSTEXPR
2346 basic_string&
2347 erase(size_type __pos = 0, size_type __n = npos)
2348 {
2349 _M_check(__pos, "basic_string::erase");
2350 if (__n == npos)
2351 this->_M_set_length(__pos);
2352 else if (__n != 0)
2353 this->_M_erase(__pos, _M_limit(__pos, __n));
2354 return *this;
2355 }
2356
2357 /**
2358 * @brief Remove one character.
2359 * @param __position Iterator referencing the character to remove.
2360 * @return iterator referencing same location after removal.
2361 *
2362 * Removes the character at @a __position from this string. The value
2363 * of the string doesn't change if an error is thrown.
2364 */
2365 _GLIBCXX20_CONSTEXPR
2366 iterator
2367 erase(__const_iterator __position)
2368 {
2369 _GLIBCXX_DEBUG_PEDASSERT(__position >= begin()
2370 && __position < end());
2371 const size_type __pos = __position - begin();
2372 this->_M_erase(__pos, size_type(1));
2373 return iterator(_M_data() + __pos);
2374 }
2375
2376 /**
2377 * @brief Remove a range of characters.
2378 * @param __first Iterator referencing the first character to remove.
2379 * @param __last Iterator referencing the end of the range.
2380 * @return Iterator referencing location of first after removal.
2381 *
2382 * Removes the characters in the range [first,last) from this string.
2383 * The value of the string doesn't change if an error is thrown.
2384 */
2385 _GLIBCXX20_CONSTEXPR
2386 iterator
2387 erase(__const_iterator __first, __const_iterator __last)
2388 {
2389 _GLIBCXX_DEBUG_PEDASSERT(__first >= begin() && __first <= __last
2390 && __last <= end());
2391 const size_type __pos = __first - begin();
2392 if (__last == end())
2393 this->_M_set_length(__pos);
2394 else
2395 this->_M_erase(__pos, __last - __first);
2396 return iterator(this->_M_data() + __pos);
2397 }
2398
2399#if __cplusplus201703L >= 201103L
2400 /**
2401 * @brief Remove the last character.
2402 *
2403 * The string must be non-empty.
2404 */
2405 _GLIBCXX20_CONSTEXPR
2406 void
2407 pop_back() noexcept
2408 {
2409 __glibcxx_assert(!empty())do { if (__builtin_expect(!bool(!empty()), false)) std::__glibcxx_assert_fail
("/usr/bin/../lib/gcc/x86_64-redhat-linux/16/../../../../include/c++/16/bits/basic_string.h"
, 2409, __PRETTY_FUNCTION__, "!empty()"); } while (false)
;
2410 _M_erase(size() - 1, 1);
2411 }
2412#endif // C++11
2413
2414 /**
2415 * @brief Replace characters with value from another string.
2416 * @param __pos Index of first character to replace.
2417 * @param __n Number of characters to be replaced.
2418 * @param __str String to insert.
2419 * @return Reference to this string.
2420 * @throw std::out_of_range If @a pos is beyond the end of this
2421 * string.
2422 * @throw std::length_error If new length exceeds @c max_size().
2423 *
2424 * Removes the characters in the range [__pos,__pos+__n) from
2425 * this string. In place, the value of @a __str is inserted.
2426 * If @a __pos is beyond end of string, out_of_range is thrown.
2427 * If the length of the result exceeds max_size(), length_error
2428 * is thrown. The value of the string doesn't change if an
2429 * error is thrown.
2430 */
2431 _GLIBCXX20_CONSTEXPR
2432 basic_string&
2433 replace(size_type __pos, size_type __n, const basic_string& __str)
2434 { return this->replace(__pos, __n, __str._M_data(), __str.size()); }
2435
2436 /**
2437 * @brief Replace characters with value from another string.
2438 * @param __pos1 Index of first character to replace.
2439 * @param __n1 Number of characters to be replaced.
2440 * @param __str String to insert.
2441 * @param __pos2 Index of first character of str to use.
2442 * @param __n2 Number of characters from str to use.
2443 * @return Reference to this string.
2444 * @throw std::out_of_range If @a __pos1 > size() or @a __pos2 >
2445 * __str.size().
2446 * @throw std::length_error If new length exceeds @c max_size().
2447 *
2448 * Removes the characters in the range [__pos1,__pos1 + n) from this
2449 * string. In place, the value of @a __str is inserted. If @a __pos is
2450 * beyond end of string, out_of_range is thrown. If the length of the
2451 * result exceeds max_size(), length_error is thrown. The value of the
2452 * string doesn't change if an error is thrown.
2453 */
2454 _GLIBCXX20_CONSTEXPR
2455 basic_string&
2456 replace(size_type __pos1, size_type __n1, const basic_string& __str,
2457 size_type __pos2, size_type __n2 = npos)
2458 { return this->replace(__pos1, __n1, __str._M_data()
2459 + __str._M_check(__pos2, "basic_string::replace"),
2460 __str._M_limit(__pos2, __n2)); }
2461
2462 /**
2463 * @brief Replace characters with value of a C substring.
2464 * @param __pos Index of first character to replace.
2465 * @param __n1 Number of characters to be replaced.
2466 * @param __s C string to insert.
2467 * @param __n2 Number of characters from @a s to use.
2468 * @return Reference to this string.
2469 * @throw std::out_of_range If @a pos1 > size().
2470 * @throw std::length_error If new length exceeds @c max_size().
2471 *
2472 * Removes the characters in the range [__pos,__pos + __n1)
2473 * from this string. In place, the first @a __n2 characters of
2474 * @a __s are inserted, or all of @a __s if @a __n2 is too large. If
2475 * @a __pos is beyond end of string, out_of_range is thrown. If
2476 * the length of result exceeds max_size(), length_error is
2477 * thrown. The value of the string doesn't change if an error
2478 * is thrown.
2479 */
2480 _GLIBCXX20_CONSTEXPR
2481 basic_string&
2482 replace(size_type __pos, size_type __n1, const _CharT* __s,
2483 size_type __n2)
2484 {
2485 __glibcxx_requires_string_len(__s, __n2);
2486 return _M_replace(_M_check(__pos, "basic_string::replace"),
2487 _M_limit(__pos, __n1), __s, __n2);
2488 }
2489
2490 /**
2491 * @brief Replace characters with value of a C string.
2492 * @param __pos Index of first character to replace.
2493 * @param __n1 Number of characters to be replaced.
2494 * @param __s C string to insert.
2495 * @return Reference to this string.
2496 * @throw std::out_of_range If @a pos > size().
2497 * @throw std::length_error If new length exceeds @c max_size().
2498 *
2499 * Removes the characters in the range [__pos,__pos + __n1)
2500 * from this string. In place, the characters of @a __s are
2501 * inserted. If @a __pos is beyond end of string, out_of_range
2502 * is thrown. If the length of result exceeds max_size(),
2503 * length_error is thrown. The value of the string doesn't
2504 * change if an error is thrown.
2505 */
2506 _GLIBCXX20_CONSTEXPR
2507 basic_string&
2508 replace(size_type __pos, size_type __n1, const _CharT* __s)
2509 {
2510 __glibcxx_requires_string(__s);
2511 return this->replace(__pos, __n1, __s, traits_type::length(__s));
2512 }
2513
2514 /**
2515 * @brief Replace characters with multiple characters.
2516 * @param __pos Index of first character to replace.
2517 * @param __n1 Number of characters to be replaced.
2518 * @param __n2 Number of characters to insert.
2519 * @param __c Character to insert.
2520 * @return Reference to this string.
2521 * @throw std::out_of_range If @a __pos > size().
2522 * @throw std::length_error If new length exceeds @c max_size().
2523 *
2524 * Removes the characters in the range [pos,pos + n1) from this
2525 * string. In place, @a __n2 copies of @a __c are inserted.
2526 * If @a __pos is beyond end of string, out_of_range is thrown.
2527 * If the length of result exceeds max_size(), length_error is
2528 * thrown. The value of the string doesn't change if an error
2529 * is thrown.
2530 */
2531 _GLIBCXX20_CONSTEXPR
2532 basic_string&
2533 replace(size_type __pos, size_type __n1, size_type __n2, _CharT __c)
2534 { return _M_replace_aux(_M_check(__pos, "basic_string::replace"),
2535 _M_limit(__pos, __n1), __n2, __c); }
2536
2537 /**
2538 * @brief Replace range of characters with string.
2539 * @param __i1 Iterator referencing start of range to replace.
2540 * @param __i2 Iterator referencing end of range to replace.
2541 * @param __str String value to insert.
2542 * @return Reference to this string.
2543 * @throw std::length_error If new length exceeds @c max_size().
2544 *
2545 * Removes the characters in the range [__i1,__i2). In place,
2546 * the value of @a __str is inserted. If the length of result
2547 * exceeds max_size(), length_error is thrown. The value of
2548 * the string doesn't change if an error is thrown.
2549 */
2550 _GLIBCXX20_CONSTEXPR
2551 basic_string&
2552 replace(__const_iterator __i1, __const_iterator __i2,
2553 const basic_string& __str)
2554 { return this->replace(__i1, __i2, __str._M_data(), __str.size()); }
2555
2556 /**
2557 * @brief Replace range of characters with C substring.
2558 * @param __i1 Iterator referencing start of range to replace.
2559 * @param __i2 Iterator referencing end of range to replace.
2560 * @param __s C string value to insert.
2561 * @param __n Number of characters from s to insert.
2562 * @return Reference to this string.
2563 * @throw std::length_error If new length exceeds @c max_size().
2564 *
2565 * Removes the characters in the range [__i1,__i2). In place,
2566 * the first @a __n characters of @a __s are inserted. If the
2567 * length of result exceeds max_size(), length_error is thrown.
2568 * The value of the string doesn't change if an error is
2569 * thrown.
2570 */
2571 _GLIBCXX20_CONSTEXPR
2572 basic_string&
2573 replace(__const_iterator __i1, __const_iterator __i2,
2574 const _CharT* __s, size_type __n)
2575 {
2576 _GLIBCXX_DEBUG_PEDASSERT(begin() <= __i1 && __i1 <= __i2
2577 && __i2 <= end());
2578 return this->replace(__i1 - begin(), __i2 - __i1, __s, __n);
2579 }
2580
2581 /**
2582 * @brief Replace range of characters with C string.
2583 * @param __i1 Iterator referencing start of range to replace.
2584 * @param __i2 Iterator referencing end of range to replace.
2585 * @param __s C string value to insert.
2586 * @return Reference to this string.
2587 * @throw std::length_error If new length exceeds @c max_size().
2588 *
2589 * Removes the characters in the range [__i1,__i2). In place,
2590 * the characters of @a __s are inserted. If the length of
2591 * result exceeds max_size(), length_error is thrown. The
2592 * value of the string doesn't change if an error is thrown.
2593 */
2594 _GLIBCXX20_CONSTEXPR
2595 basic_string&
2596 replace(__const_iterator __i1, __const_iterator __i2, const _CharT* __s)
2597 {
2598 __glibcxx_requires_string(__s);
2599 return this->replace(__i1, __i2, __s, traits_type::length(__s));
2600 }
2601
2602 /**
2603 * @brief Replace range of characters with multiple characters
2604 * @param __i1 Iterator referencing start of range to replace.
2605 * @param __i2 Iterator referencing end of range to replace.
2606 * @param __n Number of characters to insert.
2607 * @param __c Character to insert.
2608 * @return Reference to this string.
2609 * @throw std::length_error If new length exceeds @c max_size().
2610 *
2611 * Removes the characters in the range [__i1,__i2). In place,
2612 * @a __n copies of @a __c are inserted. If the length of
2613 * result exceeds max_size(), length_error is thrown. The
2614 * value of the string doesn't change if an error is thrown.
2615 */
2616 _GLIBCXX20_CONSTEXPR
2617 basic_string&
2618 replace(__const_iterator __i1, __const_iterator __i2, size_type __n,
2619 _CharT __c)
2620 {
2621 _GLIBCXX_DEBUG_PEDASSERT(begin() <= __i1 && __i1 <= __i2
2622 && __i2 <= end());
2623 return _M_replace_aux(__i1 - begin(), __i2 - __i1, __n, __c);
2624 }
2625
2626 /**
2627 * @brief Replace range of characters with range.
2628 * @param __i1 Iterator referencing start of range to replace.
2629 * @param __i2 Iterator referencing end of range to replace.
2630 * @param __k1 Iterator referencing start of range to insert.
2631 * @param __k2 Iterator referencing end of range to insert.
2632 * @return Reference to this string.
2633 * @throw std::length_error If new length exceeds @c max_size().
2634 *
2635 * Removes the characters in the range [__i1,__i2). In place,
2636 * characters in the range [__k1,__k2) are inserted. If the
2637 * length of result exceeds max_size(), length_error is thrown.
2638 * The value of the string doesn't change if an error is
2639 * thrown.
2640 */
2641#if __cplusplus201703L >= 201103L
2642 template<class _InputIterator,
2643 typename = std::_RequireInputIter<_InputIterator>>
2644 _GLIBCXX20_CONSTEXPR
2645 basic_string&
2646 replace(const_iterator __i1, const_iterator __i2,
2647 _InputIterator __k1, _InputIterator __k2)
2648 {
2649 _GLIBCXX_DEBUG_PEDASSERT(begin() <= __i1 && __i1 <= __i2
2650 && __i2 <= end());
2651 __glibcxx_requires_valid_range(__k1, __k2);
2652 return this->_M_replace_dispatch(__i1, __i2, __k1, __k2,
2653 std::__false_type());
2654 }
2655#else
2656 template<class _InputIterator>
2657#ifdef _GLIBCXX_DISAMBIGUATE_REPLACE_INST
2658 typename __enable_if_not_native_iterator<_InputIterator>::__type
2659#else
2660 basic_string&
2661#endif
2662 replace(iterator __i1, iterator __i2,
2663 _InputIterator __k1, _InputIterator __k2)
2664 {
2665 _GLIBCXX_DEBUG_PEDASSERT(begin() <= __i1 && __i1 <= __i2
2666 && __i2 <= end());
2667 __glibcxx_requires_valid_range(__k1, __k2);
2668 typedef typename std::__is_integer<_InputIterator>::__type _Integral;
2669 return _M_replace_dispatch(__i1, __i2, __k1, __k2, _Integral());
2670 }
2671#endif
2672
2673 // Specializations for the common case of pointer and iterator:
2674 // useful to avoid the overhead of temporary buffering in _M_replace.
2675 _GLIBCXX20_CONSTEXPR
2676 basic_string&
2677 replace(__const_iterator __i1, __const_iterator __i2,
2678 _CharT* __k1, _CharT* __k2)
2679 {
2680 _GLIBCXX_DEBUG_PEDASSERT(begin() <= __i1 && __i1 <= __i2
2681 && __i2 <= end());
2682 __glibcxx_requires_valid_range(__k1, __k2);
2683 return this->replace(__i1 - begin(), __i2 - __i1,
2684 __k1, __k2 - __k1);
2685 }
2686
2687 _GLIBCXX20_CONSTEXPR
2688 basic_string&
2689 replace(__const_iterator __i1, __const_iterator __i2,
2690 const _CharT* __k1, const _CharT* __k2)
2691 {
2692 _GLIBCXX_DEBUG_PEDASSERT(begin() <= __i1 && __i1 <= __i2
2693 && __i2 <= end());
2694 __glibcxx_requires_valid_range(__k1, __k2);
2695 return this->replace(__i1 - begin(), __i2 - __i1,
2696 __k1, __k2 - __k1);
2697 }
2698
2699 _GLIBCXX20_CONSTEXPR
2700 basic_string&
2701 replace(__const_iterator __i1, __const_iterator __i2,
2702 iterator __k1, iterator __k2)
2703 {
2704 _GLIBCXX_DEBUG_PEDASSERT(begin() <= __i1 && __i1 <= __i2
2705 && __i2 <= end());
2706 __glibcxx_requires_valid_range(__k1, __k2);
2707 return this->replace(__i1 - begin(), __i2 - __i1,
2708 __k1.base(), __k2 - __k1);
2709 }
2710
2711 _GLIBCXX20_CONSTEXPR
2712 basic_string&
2713 replace(__const_iterator __i1, __const_iterator __i2,
2714 const_iterator __k1, const_iterator __k2)
2715 {
2716 _GLIBCXX_DEBUG_PEDASSERT(begin() <= __i1 && __i1 <= __i2
2717 && __i2 <= end());
2718 __glibcxx_requires_valid_range(__k1, __k2);
2719 return this->replace(__i1 - begin(), __i2 - __i1,
2720 __k1.base(), __k2 - __k1);
2721 }
2722
2723#if __glibcxx_containers_ranges // C++ >= 23
2724 /**
2725 * @brief Replace part of the string with a range.
2726 * @param __rg A range of values that are convertible to `value_type`.
2727 * @since C++23
2728 *
2729 * The range `__rg` is allowed to overlap with `*this`.
2730 */
2731 template<__detail::__container_compatible_range<_CharT> _Rg>
2732 constexpr basic_string&
2733 replace_with_range(const_iterator __i1, const_iterator __i2, _Rg&& __rg)
2734 {
2735 if (__i1 == cend())
2736 append_range(std::forward<_Rg>(__rg));
2737 else
2738 {
2739 basic_string __s(from_range, std::forward<_Rg>(__rg),
2740 _M_get_allocator());
2741 replace(__i1, __i2, __s);
2742 }
2743 return *this;
2744 }
2745#endif
2746
2747#if __cplusplus201703L >= 201103L
2748 /**
2749 * @brief Replace range of characters with initializer_list.
2750 * @param __i1 Iterator referencing start of range to replace.
2751 * @param __i2 Iterator referencing end of range to replace.
2752 * @param __l The initializer_list of characters to insert.
2753 * @return Reference to this string.
2754 * @throw std::length_error If new length exceeds @c max_size().
2755 *
2756 * Removes the characters in the range [__i1,__i2). In place,
2757 * characters in the range [__k1,__k2) are inserted. If the
2758 * length of result exceeds max_size(), length_error is thrown.
2759 * The value of the string doesn't change if an error is
2760 * thrown.
2761 */
2762 _GLIBCXX20_CONSTEXPR
2763 basic_string& replace(const_iterator __i1, const_iterator __i2,
2764 initializer_list<_CharT> __l)
2765 { return this->replace(__i1, __i2, __l.begin(), __l.size()); }
2766#endif // C++11
2767
2768#ifdef __glibcxx_string_view201803L // >= C++17
2769 /**
2770 * @brief Replace range of characters with string_view.
2771 * @param __pos The position to replace at.
2772 * @param __n The number of characters to replace.
2773 * @param __svt The object convertible to string_view to insert.
2774 * @return Reference to this string.
2775 */
2776 template<typename _Tp>
2777 _GLIBCXX20_CONSTEXPR
2778 _If_sv<_Tp, basic_string&>
2779 replace(size_type __pos, size_type __n, const _Tp& __svt)
2780 {
2781 __sv_type __sv = __svt;
2782 return this->replace(__pos, __n, __sv.data(), __sv.size());
2783 }
2784
2785 /**
2786 * @brief Replace range of characters with string_view.
2787 * @param __pos1 The position to replace at.
2788 * @param __n1 The number of characters to replace.
2789 * @param __svt The object convertible to string_view to insert from.
2790 * @param __pos2 The position in the string_view to insert from.
2791 * @param __n2 The number of characters to insert.
2792 * @return Reference to this string.
2793 */
2794 template<typename _Tp>
2795 _GLIBCXX20_CONSTEXPR
2796 _If_sv<_Tp, basic_string&>
2797 replace(size_type __pos1, size_type __n1, const _Tp& __svt,
2798 size_type __pos2, size_type __n2 = npos)
2799 {
2800 __sv_type __sv = __svt;
2801 return this->replace(__pos1, __n1,
2802 __sv.data()
2803 + std::__sv_check(__sv.size(), __pos2, "basic_string::replace"),
2804 std::__sv_limit(__sv.size(), __pos2, __n2));
2805 }
2806
2807 /**
2808 * @brief Replace range of characters with string_view.
2809 * @param __i1 An iterator referencing the start position
2810 to replace at.
2811 * @param __i2 An iterator referencing the end position
2812 for the replace.
2813 * @param __svt The object convertible to string_view to insert from.
2814 * @return Reference to this string.
2815 */
2816 template<typename _Tp>
2817 _GLIBCXX20_CONSTEXPR
2818 _If_sv<_Tp, basic_string&>
2819 replace(const_iterator __i1, const_iterator __i2, const _Tp& __svt)
2820 {
2821 __sv_type __sv = __svt;
2822 return this->replace(__i1 - begin(), __i2 - __i1, __sv);
2823 }
2824#endif // C++17
2825
2826 private:
2827 template<class _Integer>
2828 _GLIBCXX20_CONSTEXPR
2829 basic_string&
2830 _M_replace_dispatch(const_iterator __i1, const_iterator __i2,
2831 _Integer __n, _Integer __val, __true_type)
2832 { return _M_replace_aux(__i1 - begin(), __i2 - __i1, __n, __val); }
2833
2834 template<class _InputIterator>
2835 _GLIBCXX20_CONSTEXPR
2836 basic_string&
2837 _M_replace_dispatch(const_iterator __i1, const_iterator __i2,
2838 _InputIterator __k1, _InputIterator __k2,
2839 __false_type);
2840
2841 _GLIBCXX20_CONSTEXPR
2842 basic_string&
2843 _M_replace_aux(size_type __pos1, size_type __n1, size_type __n2,
2844 _CharT __c);
2845
2846 __attribute__((__noinline__, __noclone__, __cold__)) void
2847 _M_replace_cold(pointer __p, size_type __len1, const _CharT* __s,
2848 const size_type __len2, const size_type __how_much);
2849
2850 _GLIBCXX20_CONSTEXPR
2851 basic_string&
2852 _M_replace(size_type __pos, size_type __len1, const _CharT* __s,
2853 const size_type __len2);
2854
2855 _GLIBCXX20_CONSTEXPR
2856 basic_string&
2857 _M_append(const _CharT* __s, size_type __n);
2858
2859 public:
2860
2861 /**
2862 * @brief Copy substring into C string.
2863 * @param __s C string to copy value into.
2864 * @param __n Number of characters to copy.
2865 * @param __pos Index of first character to copy.
2866 * @return Number of characters actually copied
2867 * @throw std::out_of_range If __pos > size().
2868 *
2869 * Copies up to @a __n characters starting at @a __pos into the
2870 * C string @a __s. If @a __pos is %greater than size(),
2871 * out_of_range is thrown.
2872 */
2873 _GLIBCXX20_CONSTEXPR
2874 size_type
2875 copy(_CharT* __s, size_type __n, size_type __pos = 0) const;
2876
2877 /**
2878 * @brief Swap contents with another string.
2879 * @param __s String to swap with.
2880 *
2881 * Exchanges the contents of this string with that of @a __s in constant
2882 * time.
2883 */
2884 _GLIBCXX20_CONSTEXPR
2885 void
2886 swap(basic_string& __s) _GLIBCXX_NOEXCEPTnoexcept;
2887
2888 // String operations:
2889 /**
2890 * @brief Return const pointer to null-terminated contents.
2891 *
2892 * This is a handle to internal data. Do not modify or dire things may
2893 * happen.
2894 */
2895 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
2896 const _CharT*
2897 c_str() const _GLIBCXX_NOEXCEPTnoexcept
2898 { return _M_data(); }
2899
2900 /**
2901 * @brief Return const pointer to contents.
2902 *
2903 * This is a pointer to internal data. It is undefined to modify
2904 * the contents through the returned pointer. To get a pointer that
2905 * allows modifying the contents use @c &str[0] instead,
2906 * (or in C++17 the non-const @c str.data() overload).
2907 */
2908 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
2909 const _CharT*
2910 data() const _GLIBCXX_NOEXCEPTnoexcept
2911 { return _M_data(); }
2912
2913#if __cplusplus201703L >= 201703L
2914 /**
2915 * @brief Return non-const pointer to contents.
2916 *
2917 * This is a pointer to the character sequence held by the string.
2918 * Modifying the characters in the sequence is allowed.
2919 */
2920 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
2921 _CharT*
2922 data() noexcept
2923 { return _M_data(); }
2924#endif
2925
2926 /**
2927 * @brief Return copy of allocator used to construct this string.
2928 */
2929 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
2930 allocator_type
2931 get_allocator() const _GLIBCXX_NOEXCEPTnoexcept
2932 { return _M_get_allocator(); }
2933
2934 /**
2935 * @brief Find position of a C substring.
2936 * @param __s C string to locate.
2937 * @param __pos Index of character to search from.
2938 * @param __n Number of characters from @a s to search for.
2939 * @return Index of start of first occurrence.
2940 *
2941 * Starting from @a __pos, searches forward for the first @a
2942 * __n characters in @a __s within this string. If found,
2943 * returns the index where it begins. If not found, returns
2944 * npos.
2945 */
2946 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
2947 size_type
2948 find(const _CharT* __s, size_type __pos, size_type __n) const
2949 _GLIBCXX_NOEXCEPTnoexcept;
2950
2951 /**
2952 * @brief Find position of a string.
2953 * @param __str String to locate.
2954 * @param __pos Index of character to search from (default 0).
2955 * @return Index of start of first occurrence.
2956 *
2957 * Starting from @a __pos, searches forward for value of @a __str within
2958 * this string. If found, returns the index where it begins. If not
2959 * found, returns npos.
2960 */
2961 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
2962 size_type
2963 find(const basic_string& __str, size_type __pos = 0) const
2964 _GLIBCXX_NOEXCEPTnoexcept
2965 { return this->find(__str.data(), __pos, __str.size()); }
2966
2967#ifdef __glibcxx_string_view201803L // >= C++17
2968 /**
2969 * @brief Find position of a string_view.
2970 * @param __svt The object convertible to string_view to locate.
2971 * @param __pos Index of character to search from (default 0).
2972 * @return Index of start of first occurrence.
2973 */
2974 template<typename _Tp>
2975 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
2976 _If_sv<_Tp, size_type>
2977 find(const _Tp& __svt, size_type __pos = 0) const
2978 noexcept(is_same<_Tp, __sv_type>::value)
2979 {
2980 __sv_type __sv = __svt;
2981 return this->find(__sv.data(), __pos, __sv.size());
2982 }
2983#endif // C++17
2984
2985 /**
2986 * @brief Find position of a C string.
2987 * @param __s C string to locate.
2988 * @param __pos Index of character to search from (default 0).
2989 * @return Index of start of first occurrence.
2990 *
2991 * Starting from @a __pos, searches forward for the value of @a
2992 * __s within this string. If found, returns the index where
2993 * it begins. If not found, returns npos.
2994 */
2995 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
2996 size_type
2997 find(const _CharT* __s, size_type __pos = 0) const _GLIBCXX_NOEXCEPTnoexcept
2998 {
2999 __glibcxx_requires_string(__s);
3000 return this->find(__s, __pos, traits_type::length(__s));
3001 }
3002
3003 /**
3004 * @brief Find position of a character.
3005 * @param __c Character to locate.
3006 * @param __pos Index of character to search from (default 0).
3007 * @return Index of first occurrence.
3008 *
3009 * Starting from @a __pos, searches forward for @a __c within
3010 * this string. If found, returns the index where it was
3011 * found. If not found, returns npos.
3012 */
3013 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
3014 size_type
3015 find(_CharT __c, size_type __pos = 0) const _GLIBCXX_NOEXCEPTnoexcept;
3016
3017 /**
3018 * @brief Find last position of a string.
3019 * @param __str String to locate.
3020 * @param __pos Index of character to search back from (default end).
3021 * @return Index of start of last occurrence.
3022 *
3023 * Starting from @a __pos, searches backward for value of @a
3024 * __str within this string. If found, returns the index where
3025 * it begins. If not found, returns npos.
3026 */
3027 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
3028 size_type
3029 rfind(const basic_string& __str, size_type __pos = npos) const
3030 _GLIBCXX_NOEXCEPTnoexcept
3031 { return this->rfind(__str.data(), __pos, __str.size()); }
3032
3033#ifdef __glibcxx_string_view201803L // >= C++17
3034 /**
3035 * @brief Find last position of a string_view.
3036 * @param __svt The object convertible to string_view to locate.
3037 * @param __pos Index of character to search back from (default end).
3038 * @return Index of start of last occurrence.
3039 */
3040 template<typename _Tp>
3041 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
3042 _If_sv<_Tp, size_type>
3043 rfind(const _Tp& __svt, size_type __pos = npos) const
3044 noexcept(is_same<_Tp, __sv_type>::value)
3045 {
3046 __sv_type __sv = __svt;
3047 return this->rfind(__sv.data(), __pos, __sv.size());
3048 }
3049#endif // C++17
3050
3051 /**
3052 * @brief Find last position of a C substring.
3053 * @param __s C string to locate.
3054 * @param __pos Index of character to search back from.
3055 * @param __n Number of characters from s to search for.
3056 * @return Index of start of last occurrence.
3057 *
3058 * Starting from @a __pos, searches backward for the first @a
3059 * __n characters in @a __s within this string. If found,
3060 * returns the index where it begins. If not found, returns
3061 * npos.
3062 */
3063 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
3064 size_type
3065 rfind(const _CharT* __s, size_type __pos, size_type __n) const
3066 _GLIBCXX_NOEXCEPTnoexcept;
3067
3068 /**
3069 * @brief Find last position of a C string.
3070 * @param __s C string to locate.
3071 * @param __pos Index of character to start search at (default end).
3072 * @return Index of start of last occurrence.
3073 *
3074 * Starting from @a __pos, searches backward for the value of
3075 * @a __s within this string. If found, returns the index
3076 * where it begins. If not found, returns npos.
3077 */
3078 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
3079 size_type
3080 rfind(const _CharT* __s, size_type __pos = npos) const
3081 {
3082 __glibcxx_requires_string(__s);
3083 return this->rfind(__s, __pos, traits_type::length(__s));
3084 }
3085
3086 /**
3087 * @brief Find last position of a character.
3088 * @param __c Character to locate.
3089 * @param __pos Index of character to search back from (default end).
3090 * @return Index of last occurrence.
3091 *
3092 * Starting from @a __pos, searches backward for @a __c within
3093 * this string. If found, returns the index where it was
3094 * found. If not found, returns npos.
3095 */
3096 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
3097 size_type
3098 rfind(_CharT __c, size_type __pos = npos) const _GLIBCXX_NOEXCEPTnoexcept;
3099
3100 /**
3101 * @brief Find position of a character of string.
3102 * @param __str String containing characters to locate.
3103 * @param __pos Index of character to search from (default 0).
3104 * @return Index of first occurrence.
3105 *
3106 * Starting from @a __pos, searches forward for one of the
3107 * characters of @a __str within this string. If found,
3108 * returns the index where it was found. If not found, returns
3109 * npos.
3110 */
3111 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
3112 size_type
3113 find_first_of(const basic_string& __str, size_type __pos = 0) const
3114 _GLIBCXX_NOEXCEPTnoexcept
3115 { return this->find_first_of(__str.data(), __pos, __str.size()); }
3116
3117#ifdef __glibcxx_string_view201803L // >= C++17
3118 /**
3119 * @brief Find position of a character of a string_view.
3120 * @param __svt An object convertible to string_view containing
3121 * characters to locate.
3122 * @param __pos Index of character to search from (default 0).
3123 * @return Index of first occurrence.
3124 */
3125 template<typename _Tp>
3126 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
3127 _If_sv<_Tp, size_type>
3128 find_first_of(const _Tp& __svt, size_type __pos = 0) const
3129 noexcept(is_same<_Tp, __sv_type>::value)
3130 {
3131 __sv_type __sv = __svt;
3132 return this->find_first_of(__sv.data(), __pos, __sv.size());
3133 }
3134#endif // C++17
3135
3136 /**
3137 * @brief Find position of a character of C substring.
3138 * @param __s String containing characters to locate.
3139 * @param __pos Index of character to search from.
3140 * @param __n Number of characters from s to search for.
3141 * @return Index of first occurrence.
3142 *
3143 * Starting from @a __pos, searches forward for one of the
3144 * first @a __n characters of @a __s within this string. If
3145 * found, returns the index where it was found. If not found,
3146 * returns npos.
3147 */
3148 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
3149 size_type
3150 find_first_of(const _CharT* __s, size_type __pos, size_type __n) const
3151 _GLIBCXX_NOEXCEPTnoexcept;
3152
3153 /**
3154 * @brief Find position of a character of C string.
3155 * @param __s String containing characters to locate.
3156 * @param __pos Index of character to search from (default 0).
3157 * @return Index of first occurrence.
3158 *
3159 * Starting from @a __pos, searches forward for one of the
3160 * characters of @a __s within this string. If found, returns
3161 * the index where it was found. If not found, returns npos.
3162 */
3163 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
3164 size_type
3165 find_first_of(const _CharT* __s, size_type __pos = 0) const
3166 _GLIBCXX_NOEXCEPTnoexcept
3167 {
3168 __glibcxx_requires_string(__s);
3169 return this->find_first_of(__s, __pos, traits_type::length(__s));
3170 }
3171
3172 /**
3173 * @brief Find position of a character.
3174 * @param __c Character to locate.
3175 * @param __pos Index of character to search from (default 0).
3176 * @return Index of first occurrence.
3177 *
3178 * Starting from @a __pos, searches forward for the character
3179 * @a __c within this string. If found, returns the index
3180 * where it was found. If not found, returns npos.
3181 *
3182 * Note: equivalent to find(__c, __pos).
3183 */
3184 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
3185 size_type
3186 find_first_of(_CharT __c, size_type __pos = 0) const _GLIBCXX_NOEXCEPTnoexcept
3187 { return this->find(__c, __pos); }
3188
3189 /**
3190 * @brief Find last position of a character of string.
3191 * @param __str String containing characters to locate.
3192 * @param __pos Index of character to search back from (default end).
3193 * @return Index of last occurrence.
3194 *
3195 * Starting from @a __pos, searches backward for one of the
3196 * characters of @a __str within this string. If found,
3197 * returns the index where it was found. If not found, returns
3198 * npos.
3199 */
3200 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
3201 size_type
3202 find_last_of(const basic_string& __str, size_type __pos = npos) const
3203 _GLIBCXX_NOEXCEPTnoexcept
3204 { return this->find_last_of(__str.data(), __pos, __str.size()); }
3205
3206#ifdef __glibcxx_string_view201803L // >= C++17
3207 /**
3208 * @brief Find last position of a character of string.
3209 * @param __svt An object convertible to string_view containing
3210 * characters to locate.
3211 * @param __pos Index of character to search back from (default end).
3212 * @return Index of last occurrence.
3213 */
3214 template<typename _Tp>
3215 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
3216 _If_sv<_Tp, size_type>
3217 find_last_of(const _Tp& __svt, size_type __pos = npos) const
3218 noexcept(is_same<_Tp, __sv_type>::value)
3219 {
3220 __sv_type __sv = __svt;
3221 return this->find_last_of(__sv.data(), __pos, __sv.size());
3222 }
3223#endif // C++17
3224
3225 /**
3226 * @brief Find last position of a character of C substring.
3227 * @param __s C string containing characters to locate.
3228 * @param __pos Index of character to search back from.
3229 * @param __n Number of characters from s to search for.
3230 * @return Index of last occurrence.
3231 *
3232 * Starting from @a __pos, searches backward for one of the
3233 * first @a __n characters of @a __s within this string. If
3234 * found, returns the index where it was found. If not found,
3235 * returns npos.
3236 */
3237 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
3238 size_type
3239 find_last_of(const _CharT* __s, size_type __pos, size_type __n) const
3240 _GLIBCXX_NOEXCEPTnoexcept;
3241
3242 /**
3243 * @brief Find last position of a character of C string.
3244 * @param __s C string containing characters to locate.
3245 * @param __pos Index of character to search back from (default end).
3246 * @return Index of last occurrence.
3247 *
3248 * Starting from @a __pos, searches backward for one of the
3249 * characters of @a __s within this string. If found, returns
3250 * the index where it was found. If not found, returns npos.
3251 */
3252 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
3253 size_type
3254 find_last_of(const _CharT* __s, size_type __pos = npos) const
3255 _GLIBCXX_NOEXCEPTnoexcept
3256 {
3257 __glibcxx_requires_string(__s);
3258 return this->find_last_of(__s, __pos, traits_type::length(__s));
3259 }
3260
3261 /**
3262 * @brief Find last position of a character.
3263 * @param __c Character to locate.
3264 * @param __pos Index of character to search back from (default end).
3265 * @return Index of last occurrence.
3266 *
3267 * Starting from @a __pos, searches backward for @a __c within
3268 * this string. If found, returns the index where it was
3269 * found. If not found, returns npos.
3270 *
3271 * Note: equivalent to rfind(__c, __pos).
3272 */
3273 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
3274 size_type
3275 find_last_of(_CharT __c, size_type __pos = npos) const _GLIBCXX_NOEXCEPTnoexcept
3276 { return this->rfind(__c, __pos); }
3277
3278 /**
3279 * @brief Find position of a character not in string.
3280 * @param __str String containing characters to avoid.
3281 * @param __pos Index of character to search from (default 0).
3282 * @return Index of first occurrence.
3283 *
3284 * Starting from @a __pos, searches forward for a character not contained
3285 * in @a __str within this string. If found, returns the index where it
3286 * was found. If not found, returns npos.
3287 */
3288 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
3289 size_type
3290 find_first_not_of(const basic_string& __str, size_type __pos = 0) const
3291 _GLIBCXX_NOEXCEPTnoexcept
3292 { return this->find_first_not_of(__str.data(), __pos, __str.size()); }
3293
3294#ifdef __glibcxx_string_view201803L // >= C++17
3295 /**
3296 * @brief Find position of a character not in a string_view.
3297 * @param __svt A object convertible to string_view containing
3298 * characters to avoid.
3299 * @param __pos Index of character to search from (default 0).
3300 * @return Index of first occurrence.
3301 */
3302 template<typename _Tp>
3303 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
3304 _If_sv<_Tp, size_type>
3305 find_first_not_of(const _Tp& __svt, size_type __pos = 0) const
3306 noexcept(is_same<_Tp, __sv_type>::value)
3307 {
3308 __sv_type __sv = __svt;
3309 return this->find_first_not_of(__sv.data(), __pos, __sv.size());
3310 }
3311#endif // C++17
3312
3313 /**
3314 * @brief Find position of a character not in C substring.
3315 * @param __s C string containing characters to avoid.
3316 * @param __pos Index of character to search from.
3317 * @param __n Number of characters from __s to consider.
3318 * @return Index of first occurrence.
3319 *
3320 * Starting from @a __pos, searches forward for a character not
3321 * contained in the first @a __n characters of @a __s within
3322 * this string. If found, returns the index where it was
3323 * found. If not found, returns npos.
3324 */
3325 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
3326 size_type
3327 find_first_not_of(const _CharT* __s, size_type __pos,
3328 size_type __n) const _GLIBCXX_NOEXCEPTnoexcept;
3329
3330 /**
3331 * @brief Find position of a character not in C string.
3332 * @param __s C string containing characters to avoid.
3333 * @param __pos Index of character to search from (default 0).
3334 * @return Index of first occurrence.
3335 *
3336 * Starting from @a __pos, searches forward for a character not
3337 * contained in @a __s within this string. If found, returns
3338 * the index where it was found. If not found, returns npos.
3339 */
3340 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
3341 size_type
3342 find_first_not_of(const _CharT* __s, size_type __pos = 0) const
3343 _GLIBCXX_NOEXCEPTnoexcept
3344 {
3345 __glibcxx_requires_string(__s);
3346 return this->find_first_not_of(__s, __pos, traits_type::length(__s));
3347 }
3348
3349 /**
3350 * @brief Find position of a different character.
3351 * @param __c Character to avoid.
3352 * @param __pos Index of character to search from (default 0).
3353 * @return Index of first occurrence.
3354 *
3355 * Starting from @a __pos, searches forward for a character
3356 * other than @a __c within this string. If found, returns the
3357 * index where it was found. If not found, returns npos.
3358 */
3359 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
3360 size_type
3361 find_first_not_of(_CharT __c, size_type __pos = 0) const
3362 _GLIBCXX_NOEXCEPTnoexcept;
3363
3364 /**
3365 * @brief Find last position of a character not in string.
3366 * @param __str String containing characters to avoid.
3367 * @param __pos Index of character to search back from (default end).
3368 * @return Index of last occurrence.
3369 *
3370 * Starting from @a __pos, searches backward for a character
3371 * not contained in @a __str within this string. If found,
3372 * returns the index where it was found. If not found, returns
3373 * npos.
3374 */
3375 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
3376 size_type
3377 find_last_not_of(const basic_string& __str, size_type __pos = npos) const
3378 _GLIBCXX_NOEXCEPTnoexcept
3379 { return this->find_last_not_of(__str.data(), __pos, __str.size()); }
3380
3381#ifdef __glibcxx_string_view201803L // >= C++17
3382 /**
3383 * @brief Find last position of a character not in a string_view.
3384 * @param __svt An object convertible to string_view containing
3385 * characters to avoid.
3386 * @param __pos Index of character to search back from (default end).
3387 * @return Index of last occurrence.
3388 */
3389 template<typename _Tp>
3390 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
3391 _If_sv<_Tp, size_type>
3392 find_last_not_of(const _Tp& __svt, size_type __pos = npos) const
3393 noexcept(is_same<_Tp, __sv_type>::value)
3394 {
3395 __sv_type __sv = __svt;
3396 return this->find_last_not_of(__sv.data(), __pos, __sv.size());
3397 }
3398#endif // C++17
3399
3400 /**
3401 * @brief Find last position of a character not in C substring.
3402 * @param __s C string containing characters to avoid.
3403 * @param __pos Index of character to search back from.
3404 * @param __n Number of characters from s to consider.
3405 * @return Index of last occurrence.
3406 *
3407 * Starting from @a __pos, searches backward for a character not
3408 * contained in the first @a __n characters of @a __s within this string.
3409 * If found, returns the index where it was found. If not found,
3410 * returns npos.
3411 */
3412 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
3413 size_type
3414 find_last_not_of(const _CharT* __s, size_type __pos,
3415 size_type __n) const _GLIBCXX_NOEXCEPTnoexcept;
3416 /**
3417 * @brief Find last position of a character not in C string.
3418 * @param __s C string containing characters to avoid.
3419 * @param __pos Index of character to search back from (default end).
3420 * @return Index of last occurrence.
3421 *
3422 * Starting from @a __pos, searches backward for a character
3423 * not contained in @a __s within this string. If found,
3424 * returns the index where it was found. If not found, returns
3425 * npos.
3426 */
3427 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
3428 size_type
3429 find_last_not_of(const _CharT* __s, size_type __pos = npos) const
3430 _GLIBCXX_NOEXCEPTnoexcept
3431 {
3432 __glibcxx_requires_string(__s);
3433 return this->find_last_not_of(__s, __pos, traits_type::length(__s));
3434 }
3435
3436 /**
3437 * @brief Find last position of a different character.
3438 * @param __c Character to avoid.
3439 * @param __pos Index of character to search back from (default end).
3440 * @return Index of last occurrence.
3441 *
3442 * Starting from @a __pos, searches backward for a character other than
3443 * @a __c within this string. If found, returns the index where it was
3444 * found. If not found, returns npos.
3445 */
3446 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
3447 size_type
3448 find_last_not_of(_CharT __c, size_type __pos = npos) const
3449 _GLIBCXX_NOEXCEPTnoexcept;
3450
3451 /**
3452 * @brief Get a substring.
3453 * @param __pos Index of first character (default 0).
3454 * @param __n Number of characters in substring (default remainder).
3455 * @return The new string.
3456 * @throw std::out_of_range If __pos > size().
3457 *
3458 * Construct and return a new string using the @a __n
3459 * characters starting at @a __pos. If the string is too
3460 * short, use the remainder of the characters. If @a __pos is
3461 * beyond the end of the string, out_of_range is thrown.
3462 */
3463 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
3464 basic_string
3465 substr(size_type __pos = 0, size_type __n = npos) const
3466 { return basic_string(*this,
3467 _M_check(__pos, "basic_string::substr"), __n); }
3468
3469#if __cplusplus201703L >= 202302L
3470 _GLIBCXX_NODISCARD[[__nodiscard__]]
3471 constexpr basic_string
3472 substr(size_type __pos = 0) &&
3473 { return basic_string(std::move(*this), __pos); }
3474
3475 _GLIBCXX_NODISCARD[[__nodiscard__]]
3476 constexpr basic_string
3477 substr(size_type __pos, size_type __n) &&
3478 { return basic_string(std::move(*this), __pos, __n); }
3479#endif // C++23
3480
3481#ifdef __glibcxx_string_subview // >= C++26
3482 /**
3483 * @brief Get a subview.
3484 * @param __pos Index of first character (default 0).
3485 * @param __n Number of characters in subview (default remainder).
3486 * @return The subview.
3487 * @throw std::out_of_range If __pos > size().
3488 *
3489 * Construct and return a subview using the `__n` characters starting at
3490 * `__pos`. If the string is too short, use the remainder of the
3491 * characters. If `__pos` is beyond the end of the string, out_of_range
3492 * is thrown.
3493 */
3494 [[nodiscard]]
3495 constexpr basic_string_view<_CharT, _Traits>
3496 subview(size_type __pos = 0, size_type __n = npos) const
3497 { return __sv_type(*this).subview(__pos, __n); }
3498#endif
3499
3500 /**
3501 * @brief Compare to a string.
3502 * @param __str String to compare against.
3503 * @return Integer < 0, 0, or > 0.
3504 *
3505 * Returns an integer < 0 if this string is ordered before @a
3506 * __str, 0 if their values are equivalent, or > 0 if this
3507 * string is ordered after @a __str. Determines the effective
3508 * length rlen of the strings to compare as the smallest of
3509 * size() and str.size(). The function then compares the two
3510 * strings by calling traits::compare(data(), str.data(),rlen).
3511 * If the result of the comparison is nonzero returns it,
3512 * otherwise the shorter one is ordered first.
3513 */
3514 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
3515 int
3516 compare(const basic_string& __str) const
3517 {
3518 const size_type __size = this->size();
3519 const size_type __osize = __str.size();
3520 const size_type __len = std::min(__size, __osize);
3521
3522 int __r = traits_type::compare(_M_data(), __str.data(), __len);
3523 if (!__r)
3524 __r = _S_compare(__size, __osize);
3525 return __r;
3526 }
3527
3528#ifdef __glibcxx_string_view201803L // >= C++17
3529 /**
3530 * @brief Compare to a string_view.
3531 * @param __svt An object convertible to string_view to compare against.
3532 * @return Integer < 0, 0, or > 0.
3533 */
3534 template<typename _Tp>
3535 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
3536 _If_sv<_Tp, int>
3537 compare(const _Tp& __svt) const
3538 noexcept(is_same<_Tp, __sv_type>::value)
3539 {
3540 __sv_type __sv = __svt;
3541 const size_type __size = this->size();
3542 const size_type __osize = __sv.size();
3543 const size_type __len = std::min(__size, __osize);
3544
3545 int __r = traits_type::compare(_M_data(), __sv.data(), __len);
3546 if (!__r)
3547 __r = _S_compare(__size, __osize);
3548 return __r;
3549 }
3550
3551 /**
3552 * @brief Compare to a string_view.
3553 * @param __pos A position in the string to start comparing from.
3554 * @param __n The number of characters to compare.
3555 * @param __svt An object convertible to string_view to compare
3556 * against.
3557 * @return Integer < 0, 0, or > 0.
3558 */
3559 template<typename _Tp>
3560 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
3561 _If_sv<_Tp, int>
3562 compare(size_type __pos, size_type __n, const _Tp& __svt) const
3563 {
3564 __sv_type __sv = __svt;
3565 return __sv_type(*this).substr(__pos, __n).compare(__sv);
3566 }
3567
3568 /**
3569 * @brief Compare to a string_view.
3570 * @param __pos1 A position in the string to start comparing from.
3571 * @param __n1 The number of characters to compare.
3572 * @param __svt An object convertible to string_view to compare
3573 * against.
3574 * @param __pos2 A position in the string_view to start comparing from.
3575 * @param __n2 The number of characters to compare.
3576 * @return Integer < 0, 0, or > 0.
3577 */
3578 template<typename _Tp>
3579 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
3580 _If_sv<_Tp, int>
3581 compare(size_type __pos1, size_type __n1, const _Tp& __svt,
3582 size_type __pos2, size_type __n2 = npos) const
3583 {
3584 __sv_type __sv = __svt;
3585 return __sv_type(*this)
3586 .substr(__pos1, __n1).compare(__sv.substr(__pos2, __n2));
3587 }
3588#endif // C++17
3589
3590 /**
3591 * @brief Compare substring to a string.
3592 * @param __pos Index of first character of substring.
3593 * @param __n Number of characters in substring.
3594 * @param __str String to compare against.
3595 * @return Integer < 0, 0, or > 0.
3596 *
3597 * Form the substring of this string from the @a __n characters
3598 * starting at @a __pos. Returns an integer < 0 if the
3599 * substring is ordered before @a __str, 0 if their values are
3600 * equivalent, or > 0 if the substring is ordered after @a
3601 * __str. Determines the effective length rlen of the strings
3602 * to compare as the smallest of the length of the substring
3603 * and @a __str.size(). The function then compares the two
3604 * strings by calling
3605 * traits::compare(substring.data(),str.data(),rlen). If the
3606 * result of the comparison is nonzero returns it, otherwise
3607 * the shorter one is ordered first.
3608 */
3609 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
3610 int
3611 compare(size_type __pos, size_type __n, const basic_string& __str) const
3612 {
3613 _M_check(__pos, "basic_string::compare");
3614 __n = _M_limit(__pos, __n);
3615 const size_type __osize = __str.size();
3616 const size_type __len = std::min(__n, __osize);
3617 int __r = traits_type::compare(_M_data() + __pos, __str.data(), __len);
3618 if (!__r)
3619 __r = _S_compare(__n, __osize);
3620 return __r;
3621 }
3622
3623 /**
3624 * @brief Compare substring to a substring.
3625 * @param __pos1 Index of first character of substring.
3626 * @param __n1 Number of characters in substring.
3627 * @param __str String to compare against.
3628 * @param __pos2 Index of first character of substring of str.
3629 * @param __n2 Number of characters in substring of str.
3630 * @return Integer < 0, 0, or > 0.
3631 *
3632 * Form the substring of this string from the @a __n1
3633 * characters starting at @a __pos1. Form the substring of @a
3634 * __str from the @a __n2 characters starting at @a __pos2.
3635 * Returns an integer < 0 if this substring is ordered before
3636 * the substring of @a __str, 0 if their values are equivalent,
3637 * or > 0 if this substring is ordered after the substring of
3638 * @a __str. Determines the effective length rlen of the
3639 * strings to compare as the smallest of the lengths of the
3640 * substrings. The function then compares the two strings by
3641 * calling
3642 * traits::compare(substring.data(),str.substr(pos2,n2).data(),rlen).
3643 * If the result of the comparison is nonzero returns it,
3644 * otherwise the shorter one is ordered first.
3645 */
3646 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
3647 int
3648 compare(size_type __pos1, size_type __n1, const basic_string& __str,
3649 size_type __pos2, size_type __n2 = npos) const
3650 {
3651 _M_check(__pos1, "basic_string::compare");
3652 __str._M_check(__pos2, "basic_string::compare");
3653 __n1 = _M_limit(__pos1, __n1);
3654 __n2 = __str._M_limit(__pos2, __n2);
3655 const size_type __len = std::min(__n1, __n2);
3656 int __r = traits_type::compare(_M_data() + __pos1,
3657 __str.data() + __pos2, __len);
3658 if (!__r)
3659 __r = _S_compare(__n1, __n2);
3660 return __r;
3661 }
3662
3663 /**
3664 * @brief Compare to a C string.
3665 * @param __s C string to compare against.
3666 * @return Integer < 0, 0, or > 0.
3667 *
3668 * Returns an integer < 0 if this string is ordered before @a __s, 0 if
3669 * their values are equivalent, or > 0 if this string is ordered after
3670 * @a __s. Determines the effective length rlen of the strings to
3671 * compare as the smallest of size() and the length of a string
3672 * constructed from @a __s. The function then compares the two strings
3673 * by calling traits::compare(data(),s,rlen). If the result of the
3674 * comparison is nonzero returns it, otherwise the shorter one is
3675 * ordered first.
3676 */
3677 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
3678 int
3679 compare(const _CharT* __s) const _GLIBCXX_NOEXCEPTnoexcept
3680 {
3681 __glibcxx_requires_string(__s);
3682 const size_type __size = this->size();
3683 const size_type __osize = traits_type::length(__s);
3684 const size_type __len = std::min(__size, __osize);
3685 int __r = traits_type::compare(_M_data(), __s, __len);
3686 if (!__r)
3687 __r = _S_compare(__size, __osize);
3688 return __r;
3689 }
3690
3691 // _GLIBCXX_RESOLVE_LIB_DEFECTS
3692 // 5 String::compare specification questionable
3693 /**
3694 * @brief Compare substring to a C string.
3695 * @param __pos Index of first character of substring.
3696 * @param __n1 Number of characters in substring.
3697 * @param __s C string to compare against.
3698 * @return Integer < 0, 0, or > 0.
3699 *
3700 * Form the substring of this string from the @a __n1
3701 * characters starting at @a pos. Returns an integer < 0 if
3702 * the substring is ordered before @a __s, 0 if their values
3703 * are equivalent, or > 0 if the substring is ordered after @a
3704 * __s. Determines the effective length rlen of the strings to
3705 * compare as the smallest of the length of the substring and
3706 * the length of a string constructed from @a __s. The
3707 * function then compares the two string by calling
3708 * traits::compare(substring.data(),__s,rlen). If the result of
3709 * the comparison is nonzero returns it, otherwise the shorter
3710 * one is ordered first.
3711 */
3712 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
3713 int
3714 compare(size_type __pos, size_type __n1, const _CharT* __s) const
3715 {
3716 __glibcxx_requires_string(__s);
3717 _M_check(__pos, "basic_string::compare");
3718 __n1 = _M_limit(__pos, __n1);
3719 const size_type __osize = traits_type::length(__s);
3720 const size_type __len = std::min(__n1, __osize);
3721 int __r = traits_type::compare(_M_data() + __pos, __s, __len);
3722 if (!__r)
3723 __r = _S_compare(__n1, __osize);
3724 return __r;
3725 }
3726
3727 /**
3728 * @brief Compare substring against a character %array.
3729 * @param __pos Index of first character of substring.
3730 * @param __n1 Number of characters in substring.
3731 * @param __s character %array to compare against.
3732 * @param __n2 Number of characters of s.
3733 * @return Integer < 0, 0, or > 0.
3734 *
3735 * Form the substring of this string from the @a __n1
3736 * characters starting at @a __pos. Form a string from the
3737 * first @a __n2 characters of @a __s. Returns an integer < 0
3738 * if this substring is ordered before the string from @a __s,
3739 * 0 if their values are equivalent, or > 0 if this substring
3740 * is ordered after the string from @a __s. Determines the
3741 * effective length rlen of the strings to compare as the
3742 * smallest of the length of the substring and @a __n2. The
3743 * function then compares the two strings by calling
3744 * traits::compare(substring.data(),s,rlen). If the result of
3745 * the comparison is nonzero returns it, otherwise the shorter
3746 * one is ordered first.
3747 *
3748 * NB: s must have at least n2 characters, &apos;\\0&apos; has
3749 * no special meaning.
3750 */
3751 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
3752 int
3753 compare(size_type __pos, size_type __n1, const _CharT* __s,
3754 size_type __n2) const
3755 {
3756 __glibcxx_requires_string_len(__s, __n2);
3757 _M_check(__pos, "basic_string::compare");
3758 __n1 = _M_limit(__pos, __n1);
3759 const size_type __len = std::min(__n1, __n2);
3760 int __r = traits_type::compare(_M_data() + __pos, __s, __len);
3761 if (!__r)
3762 __r = _S_compare(__n1, __n2);
3763 return __r;
3764 }
3765
3766#if __cplusplus201703L >= 202002L
3767 [[nodiscard]]
3768 constexpr bool
3769 starts_with(basic_string_view<_CharT, _Traits> __x) const noexcept
3770 { return __sv_type(this->data(), this->size()).starts_with(__x); }
3771
3772 [[nodiscard]]
3773 constexpr bool
3774 starts_with(_CharT __x) const noexcept
3775 { return __sv_type(this->data(), this->size()).starts_with(__x); }
3776
3777 [[nodiscard, __gnu__::__nonnull__]]
3778 constexpr bool
3779 starts_with(const _CharT* __x) const noexcept
3780 { return __sv_type(this->data(), this->size()).starts_with(__x); }
3781
3782 [[nodiscard]]
3783 constexpr bool
3784 ends_with(basic_string_view<_CharT, _Traits> __x) const noexcept
3785 { return __sv_type(this->data(), this->size()).ends_with(__x); }
3786
3787 [[nodiscard]]
3788 constexpr bool
3789 ends_with(_CharT __x) const noexcept
3790 { return __sv_type(this->data(), this->size()).ends_with(__x); }
3791
3792 [[nodiscard, __gnu__::__nonnull__]]
3793 constexpr bool
3794 ends_with(const _CharT* __x) const noexcept
3795 { return __sv_type(this->data(), this->size()).ends_with(__x); }
3796#endif // C++20
3797
3798#if __cplusplus201703L > 202002L
3799 [[nodiscard]]
3800 constexpr bool
3801 contains(basic_string_view<_CharT, _Traits> __x) const noexcept
3802 { return __sv_type(this->data(), this->size()).contains(__x); }
3803
3804 [[nodiscard]]
3805 constexpr bool
3806 contains(_CharT __x) const noexcept
3807 { return __sv_type(this->data(), this->size()).contains(__x); }
3808
3809 [[nodiscard, __gnu__::__nonnull__]]
3810 constexpr bool
3811 contains(const _CharT* __x) const noexcept
3812 { return __sv_type(this->data(), this->size()).contains(__x); }
3813#endif // C++23
3814
3815 // Allow basic_stringbuf::__xfer_bufptrs to call _M_length:
3816 template<typename, typename, typename> friend class basic_stringbuf;
3817 };
3818_GLIBCXX_END_NAMESPACE_CXX11}
3819_GLIBCXX_END_NAMESPACE_VERSION
3820} // namespace std
3821#endif // _GLIBCXX_USE_CXX11_ABI
3822
3823namespace std _GLIBCXX_VISIBILITY(default)__attribute__ ((__visibility__ ("default")))
3824{
3825_GLIBCXX_BEGIN_NAMESPACE_VERSION
3826
3827#if __cpp_deduction_guides201703L >= 201606
3828_GLIBCXX_BEGIN_NAMESPACE_CXX11namespace __cxx11 {
3829 template<typename _InputIterator, typename _CharT
3830 = typename iterator_traits<_InputIterator>::value_type,
3831 typename _Allocator = allocator<_CharT>,
3832 typename = _RequireInputIter<_InputIterator>,
3833 typename = _RequireAllocator<_Allocator>>
3834 basic_string(_InputIterator, _InputIterator, _Allocator = _Allocator())
3835 -> basic_string<_CharT, char_traits<_CharT>, _Allocator>;
3836
3837 // _GLIBCXX_RESOLVE_LIB_DEFECTS
3838 // 3075. basic_string needs deduction guides from basic_string_view
3839 template<typename _CharT, typename _Traits,
3840 typename _Allocator = allocator<_CharT>,
3841 typename = _RequireAllocator<_Allocator>>
3842 basic_string(basic_string_view<_CharT, _Traits>, const _Allocator& = _Allocator())
3843 -> basic_string<_CharT, _Traits, _Allocator>;
3844
3845 template<typename _CharT, typename _Traits,
3846 typename _Allocator = allocator<_CharT>,
3847 typename = _RequireAllocator<_Allocator>>
3848 basic_string(basic_string_view<_CharT, _Traits>,
3849 typename basic_string<_CharT, _Traits, _Allocator>::size_type,
3850 typename basic_string<_CharT, _Traits, _Allocator>::size_type,
3851 const _Allocator& = _Allocator())
3852 -> basic_string<_CharT, _Traits, _Allocator>;
3853
3854#if __glibcxx_containers_ranges // C++ >= 23
3855 template<ranges::input_range _Rg,
3856 typename _Allocator = allocator<ranges::range_value_t<_Rg>>>
3857 basic_string(from_range_t, _Rg&&, _Allocator = _Allocator())
3858 -> basic_string<ranges::range_value_t<_Rg>,
3859 char_traits<ranges::range_value_t<_Rg>>,
3860 _Allocator>;
3861#endif
3862_GLIBCXX_END_NAMESPACE_CXX11}
3863#endif
3864
3865 template<typename _Str>
3866 _GLIBCXX20_CONSTEXPR
3867 inline _Str
3868 __str_concat(typename _Str::value_type const* __lhs,
3869 typename _Str::size_type __lhs_len,
3870 typename _Str::value_type const* __rhs,
3871 typename _Str::size_type __rhs_len,
3872 typename _Str::allocator_type const& __a)
3873 {
3874 typedef typename _Str::allocator_type allocator_type;
3875 typedef __gnu_cxx::__alloc_traits<allocator_type> _Alloc_traits;
3876 _Str __str(_Alloc_traits::_S_select_on_copy(__a));
3877 __str.reserve(__lhs_len + __rhs_len);
3878 __str.append(__lhs, __lhs_len);
3879 __str.append(__rhs, __rhs_len);
3880 return __str;
3881 }
3882
3883 // operator+
3884 /**
3885 * @brief Concatenate two strings.
3886 * @param __lhs First string.
3887 * @param __rhs Last string.
3888 * @return New string with value of @a __lhs followed by @a __rhs.
3889 */
3890 template<typename _CharT, typename _Traits, typename _Alloc>
3891 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
3892 inline basic_string<_CharT, _Traits, _Alloc>
3893 operator+(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
3894 const basic_string<_CharT, _Traits, _Alloc>& __rhs)
3895 {
3896 typedef basic_string<_CharT, _Traits, _Alloc> _Str;
3897 return std::__str_concat<_Str>(__lhs.c_str(), __lhs.size(),
3898 __rhs.c_str(), __rhs.size(),
3899 __lhs.get_allocator());
3900 }
3901
3902 /**
3903 * @brief Concatenate C string and string.
3904 * @param __lhs First string.
3905 * @param __rhs Last string.
3906 * @return New string with value of @a __lhs followed by @a __rhs.
3907 */
3908 template<typename _CharT, typename _Traits, typename _Alloc>
3909 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
3910 inline basic_string<_CharT,_Traits,_Alloc>
3911 operator+(const _CharT* __lhs,
3912 const basic_string<_CharT,_Traits,_Alloc>& __rhs)
3913 {
3914 __glibcxx_requires_string(__lhs);
3915 typedef basic_string<_CharT, _Traits, _Alloc> _Str;
3916 return std::__str_concat<_Str>(__lhs, _Traits::length(__lhs),
3917 __rhs.c_str(), __rhs.size(),
3918 __rhs.get_allocator());
3919 }
3920
3921 /**
3922 * @brief Concatenate character and string.
3923 * @param __lhs First string.
3924 * @param __rhs Last string.
3925 * @return New string with @a __lhs followed by @a __rhs.
3926 */
3927 template<typename _CharT, typename _Traits, typename _Alloc>
3928 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
3929 inline basic_string<_CharT,_Traits,_Alloc>
3930 operator+(_CharT __lhs, const basic_string<_CharT,_Traits,_Alloc>& __rhs)
3931 {
3932 typedef basic_string<_CharT, _Traits, _Alloc> _Str;
3933 return std::__str_concat<_Str>(__builtin_addressof(__lhs), 1,
3934 __rhs.c_str(), __rhs.size(),
3935 __rhs.get_allocator());
3936 }
3937
3938 /**
3939 * @brief Concatenate string and C string.
3940 * @param __lhs First string.
3941 * @param __rhs Last string.
3942 * @return New string with @a __lhs followed by @a __rhs.
3943 */
3944 template<typename _CharT, typename _Traits, typename _Alloc>
3945 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
3946 inline basic_string<_CharT, _Traits, _Alloc>
3947 operator+(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
3948 const _CharT* __rhs)
3949 {
3950 __glibcxx_requires_string(__rhs);
3951 typedef basic_string<_CharT, _Traits, _Alloc> _Str;
3952 return std::__str_concat<_Str>(__lhs.c_str(), __lhs.size(),
3953 __rhs, _Traits::length(__rhs),
3954 __lhs.get_allocator());
3955 }
3956 /**
3957 * @brief Concatenate string and character.
3958 * @param __lhs First string.
3959 * @param __rhs Last string.
3960 * @return New string with @a __lhs followed by @a __rhs.
3961 */
3962 template<typename _CharT, typename _Traits, typename _Alloc>
3963 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
3964 inline basic_string<_CharT, _Traits, _Alloc>
3965 operator+(const basic_string<_CharT, _Traits, _Alloc>& __lhs, _CharT __rhs)
3966 {
3967 typedef basic_string<_CharT, _Traits, _Alloc> _Str;
3968 return std::__str_concat<_Str>(__lhs.c_str(), __lhs.size(),
3969 __builtin_addressof(__rhs), 1,
3970 __lhs.get_allocator());
3971 }
3972
3973#if __cplusplus201703L >= 201103L
3974 template<typename _CharT, typename _Traits, typename _Alloc>
3975 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
3976 inline basic_string<_CharT, _Traits, _Alloc>
3977 operator+(basic_string<_CharT, _Traits, _Alloc>&& __lhs,
3978 const basic_string<_CharT, _Traits, _Alloc>& __rhs)
3979 { return std::move(__lhs.append(__rhs)); }
3980
3981 template<typename _CharT, typename _Traits, typename _Alloc>
3982 _GLIBCXX20_CONSTEXPR
3983 inline basic_string<_CharT, _Traits, _Alloc>
3984 operator+(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
3985 basic_string<_CharT, _Traits, _Alloc>&& __rhs)
3986 { return std::move(__rhs.insert(0, __lhs)); }
3987
3988 template<typename _CharT, typename _Traits, typename _Alloc>
3989 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
3990 inline basic_string<_CharT, _Traits, _Alloc>
3991 operator+(basic_string<_CharT, _Traits, _Alloc>&& __lhs,
3992 basic_string<_CharT, _Traits, _Alloc>&& __rhs)
3993 {
3994#pragma GCC diagnostic push
3995#pragma GCC diagnostic ignored "-Wc++17-extensions" // if constexpr
3996 // Return value must use __lhs.get_allocator(), but if __rhs has equal
3997 // allocator then we can choose which parameter to modify in-place.
3998 bool __use_rhs = false;
3999 if constexpr (allocator_traits<_Alloc>::is_always_equal::value)
4000 __use_rhs = true;
4001 else if (__lhs.get_allocator() == __rhs.get_allocator())
4002 __use_rhs = true;
4003 if (__use_rhs)
4004 {
4005 const auto __size = __lhs.size() + __rhs.size();
4006 if (__size > __lhs.capacity() && __size <= __rhs.capacity())
4007 return std::move(__rhs.insert(0, __lhs));
4008 }
4009 return std::move(__lhs.append(__rhs));
4010#pragma GCC diagnostic pop
4011 }
4012
4013 template<typename _CharT, typename _Traits, typename _Alloc>
4014 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
4015 inline basic_string<_CharT, _Traits, _Alloc>
4016 operator+(const _CharT* __lhs,
4017 basic_string<_CharT, _Traits, _Alloc>&& __rhs)
4018 { return std::move(__rhs.insert(0, __lhs)); }
4019
4020 template<typename _CharT, typename _Traits, typename _Alloc>
4021 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
4022 inline basic_string<_CharT, _Traits, _Alloc>
4023 operator+(_CharT __lhs,
4024 basic_string<_CharT, _Traits, _Alloc>&& __rhs)
4025 { return std::move(__rhs.insert(0, 1, __lhs)); }
4026
4027 template<typename _CharT, typename _Traits, typename _Alloc>
4028 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
4029 inline basic_string<_CharT, _Traits, _Alloc>
4030 operator+(basic_string<_CharT, _Traits, _Alloc>&& __lhs,
4031 const _CharT* __rhs)
4032 { return std::move(__lhs.append(__rhs)); }
4033
4034 template<typename _CharT, typename _Traits, typename _Alloc>
4035 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
4036 inline basic_string<_CharT, _Traits, _Alloc>
4037 operator+(basic_string<_CharT, _Traits, _Alloc>&& __lhs,
4038 _CharT __rhs)
4039 { return std::move(__lhs.append(1, __rhs)); }
4040#endif
4041
4042#if __glibcxx_string_view201803L >= 202403L
4043 // const string & + string_view
4044 template<typename _CharT, typename _Traits, typename _Alloc>
4045 [[nodiscard]]
4046 constexpr basic_string<_CharT, _Traits, _Alloc>
4047 operator+(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
4048 type_identity_t<basic_string_view<_CharT, _Traits>> __rhs)
4049 {
4050 using _Str = basic_string<_CharT, _Traits, _Alloc>;
4051 return std::__str_concat<_Str>(__lhs.data(), __lhs.size(),
4052 __rhs.data(), __rhs.size(),
4053 __lhs.get_allocator());
4054 }
4055
4056 // string && + string_view
4057 template<typename _CharT, typename _Traits, typename _Alloc>
4058 [[nodiscard]]
4059 constexpr basic_string<_CharT, _Traits, _Alloc>
4060 operator+(basic_string<_CharT, _Traits, _Alloc>&& __lhs,
4061 type_identity_t<basic_string_view<_CharT, _Traits>> __rhs)
4062 {
4063 return std::move(__lhs.append(__rhs));
4064 }
4065
4066 // string_view + const string &
4067 template<typename _CharT, typename _Traits, typename _Alloc>
4068 [[nodiscard]]
4069 constexpr basic_string<_CharT, _Traits, _Alloc>
4070 operator+(type_identity_t<basic_string_view<_CharT, _Traits>> __lhs,
4071 const basic_string<_CharT, _Traits, _Alloc>& __rhs)
4072 {
4073 using _Str = basic_string<_CharT, _Traits, _Alloc>;
4074 return std::__str_concat<_Str>(__lhs.data(), __lhs.size(),
4075 __rhs.data(), __rhs.size(),
4076 __rhs.get_allocator());
4077 }
4078
4079 // string_view + string &&
4080 template<typename _CharT, typename _Traits, typename _Alloc>
4081 [[nodiscard]]
4082 constexpr basic_string<_CharT, _Traits, _Alloc>
4083 operator+(type_identity_t<basic_string_view<_CharT, _Traits>> __lhs,
4084 basic_string<_CharT, _Traits, _Alloc>&& __rhs)
4085 {
4086 return std::move(__rhs.insert(0, __lhs));
4087 }
4088#endif
4089
4090 // operator ==
4091 /**
4092 * @brief Test equivalence of two strings.
4093 * @param __lhs First string.
4094 * @param __rhs Second string.
4095 * @return True if @a __lhs.compare(@a __rhs) == 0. False otherwise.
4096 */
4097 template<typename _CharT, typename _Traits, typename _Alloc>
4098 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
4099 inline bool
4100 operator==(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
4101 const basic_string<_CharT, _Traits, _Alloc>& __rhs)
4102 _GLIBCXX_NOEXCEPTnoexcept
4103 {
4104 return __lhs.size() == __rhs.size()
4105 && !_Traits::compare(__lhs.data(), __rhs.data(), __lhs.size());
4106 }
4107
4108 /**
4109 * @brief Test equivalence of string and C string.
4110 * @param __lhs String.
4111 * @param __rhs C string.
4112 * @return True if @a __lhs.compare(@a __rhs) == 0. False otherwise.
4113 */
4114 template<typename _CharT, typename _Traits, typename _Alloc>
4115 _GLIBCXX_NODISCARD[[__nodiscard__]] _GLIBCXX20_CONSTEXPR
4116 inline bool
4117 operator==(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
4118 const _CharT* __rhs)
4119 {
4120 return __lhs.size() == _Traits::length(__rhs)
4121 && !_Traits::compare(__lhs.data(), __rhs, __lhs.size());
4122 }
4123
4124#if __cpp_lib_three_way_comparison
4125 /**
4126 * @brief Three-way comparison of a string and a C string.
4127 * @param __lhs A string.
4128 * @param __rhs A null-terminated string.
4129 * @return A value indicating whether `__lhs` is less than, equal to,
4130 * greater than, or incomparable with `__rhs`.
4131 */
4132 template<typename _CharT, typename _Traits, typename _Alloc>
4133 [[nodiscard]]
4134 constexpr auto
4135 operator<=>(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
4136 const basic_string<_CharT, _Traits, _Alloc>& __rhs) noexcept
4137 -> decltype(__detail::__char_traits_cmp_cat<_Traits>(0))
4138 { return __detail::__char_traits_cmp_cat<_Traits>(__lhs.compare(__rhs)); }
4139
4140 /**
4141 * @brief Three-way comparison of a string and a C string.
4142 * @param __lhs A string.
4143 * @param __rhs A null-terminated string.
4144 * @return A value indicating whether `__lhs` is less than, equal to,
4145 * greater than, or incomparable with `__rhs`.
4146 */
4147 template<typename _CharT, typename _Traits, typename _Alloc>
4148 [[nodiscard]]
4149 constexpr auto
4150 operator<=>(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
4151 const _CharT* __rhs) noexcept
4152 -> decltype(__detail::__char_traits_cmp_cat<_Traits>(0))
4153 { return __detail::__char_traits_cmp_cat<_Traits>(__lhs.compare(__rhs)); }
4154#else
4155 /**
4156 * @brief Test equivalence of C string and string.
4157 * @param __lhs C string.
4158 * @param __rhs String.
4159 * @return True if @a __rhs.compare(@a __lhs) == 0. False otherwise.
4160 */
4161 template<typename _CharT, typename _Traits, typename _Alloc>
4162 _GLIBCXX_NODISCARD[[__nodiscard__]]
4163 inline bool
4164 operator==(const _CharT* __lhs,
4165 const basic_string<_CharT, _Traits, _Alloc>& __rhs)
4166 { return __rhs == __lhs; }
4167
4168 // operator !=
4169 /**
4170 * @brief Test difference of two strings.
4171 * @param __lhs First string.
4172 * @param __rhs Second string.
4173 * @return True if @a __lhs.compare(@a __rhs) != 0. False otherwise.
4174 */
4175 template<typename _CharT, typename _Traits, typename _Alloc>
4176 _GLIBCXX_NODISCARD[[__nodiscard__]]
4177 inline bool
4178 operator!=(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
4179 const basic_string<_CharT, _Traits, _Alloc>& __rhs)
4180 _GLIBCXX_NOEXCEPTnoexcept
4181 { return !(__lhs == __rhs); }
4182
4183 /**
4184 * @brief Test difference of C string and string.
4185 * @param __lhs C string.
4186 * @param __rhs String.
4187 * @return True if @a __rhs.compare(@a __lhs) != 0. False otherwise.
4188 */
4189 template<typename _CharT, typename _Traits, typename _Alloc>
4190 _GLIBCXX_NODISCARD[[__nodiscard__]]
4191 inline bool
4192 operator!=(const _CharT* __lhs,
4193 const basic_string<_CharT, _Traits, _Alloc>& __rhs)
4194 { return !(__rhs == __lhs); }
4195
4196 /**
4197 * @brief Test difference of string and C string.
4198 * @param __lhs String.
4199 * @param __rhs C string.
4200 * @return True if @a __lhs.compare(@a __rhs) != 0. False otherwise.
4201 */
4202 template<typename _CharT, typename _Traits, typename _Alloc>
4203 _GLIBCXX_NODISCARD[[__nodiscard__]]
4204 inline bool
4205 operator!=(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
4206 const _CharT* __rhs)
4207 { return !(__lhs == __rhs); }
4208
4209 // operator <
4210 /**
4211 * @brief Test if string precedes string.
4212 * @param __lhs First string.
4213 * @param __rhs Second string.
4214 * @return True if @a __lhs precedes @a __rhs. False otherwise.
4215 */
4216 template<typename _CharT, typename _Traits, typename _Alloc>
4217 _GLIBCXX_NODISCARD[[__nodiscard__]]
4218 inline bool
4219 operator<(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
4220 const basic_string<_CharT, _Traits, _Alloc>& __rhs)
4221 _GLIBCXX_NOEXCEPTnoexcept
4222 { return __lhs.compare(__rhs) < 0; }
4223
4224 /**
4225 * @brief Test if string precedes C string.
4226 * @param __lhs String.
4227 * @param __rhs C string.
4228 * @return True if @a __lhs precedes @a __rhs. False otherwise.
4229 */
4230 template<typename _CharT, typename _Traits, typename _Alloc>
4231 _GLIBCXX_NODISCARD[[__nodiscard__]]
4232 inline bool
4233 operator<(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
4234 const _CharT* __rhs)
4235 { return __lhs.compare(__rhs) < 0; }
4236
4237 /**
4238 * @brief Test if C string precedes string.
4239 * @param __lhs C string.
4240 * @param __rhs String.
4241 * @return True if @a __lhs precedes @a __rhs. False otherwise.
4242 */
4243 template<typename _CharT, typename _Traits, typename _Alloc>
4244 _GLIBCXX_NODISCARD[[__nodiscard__]]
4245 inline bool
4246 operator<(const _CharT* __lhs,
4247 const basic_string<_CharT, _Traits, _Alloc>& __rhs)
4248 { return __rhs.compare(__lhs) > 0; }
4249
4250 // operator >
4251 /**
4252 * @brief Test if string follows string.
4253 * @param __lhs First string.
4254 * @param __rhs Second string.
4255 * @return True if @a __lhs follows @a __rhs. False otherwise.
4256 */
4257 template<typename _CharT, typename _Traits, typename _Alloc>
4258 _GLIBCXX_NODISCARD[[__nodiscard__]]
4259 inline bool
4260 operator>(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
4261 const basic_string<_CharT, _Traits, _Alloc>& __rhs)
4262 _GLIBCXX_NOEXCEPTnoexcept
4263 { return __lhs.compare(__rhs) > 0; }
4264
4265 /**
4266 * @brief Test if string follows C string.
4267 * @param __lhs String.
4268 * @param __rhs C string.
4269 * @return True if @a __lhs follows @a __rhs. False otherwise.
4270 */
4271 template<typename _CharT, typename _Traits, typename _Alloc>
4272 _GLIBCXX_NODISCARD[[__nodiscard__]]
4273 inline bool
4274 operator>(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
4275 const _CharT* __rhs)
4276 { return __lhs.compare(__rhs) > 0; }
4277
4278 /**
4279 * @brief Test if C string follows string.
4280 * @param __lhs C string.
4281 * @param __rhs String.
4282 * @return True if @a __lhs follows @a __rhs. False otherwise.
4283 */
4284 template<typename _CharT, typename _Traits, typename _Alloc>
4285 _GLIBCXX_NODISCARD[[__nodiscard__]]
4286 inline bool
4287 operator>(const _CharT* __lhs,
4288 const basic_string<_CharT, _Traits, _Alloc>& __rhs)
4289 { return __rhs.compare(__lhs) < 0; }
4290
4291 // operator <=
4292 /**
4293 * @brief Test if string doesn't follow string.
4294 * @param __lhs First string.
4295 * @param __rhs Second string.
4296 * @return True if @a __lhs doesn't follow @a __rhs. False otherwise.
4297 */
4298 template<typename _CharT, typename _Traits, typename _Alloc>
4299 _GLIBCXX_NODISCARD[[__nodiscard__]]
4300 inline bool
4301 operator<=(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
4302 const basic_string<_CharT, _Traits, _Alloc>& __rhs)
4303 _GLIBCXX_NOEXCEPTnoexcept
4304 { return __lhs.compare(__rhs) <= 0; }
4305
4306 /**
4307 * @brief Test if string doesn't follow C string.
4308 * @param __lhs String.
4309 * @param __rhs C string.
4310 * @return True if @a __lhs doesn't follow @a __rhs. False otherwise.
4311 */
4312 template<typename _CharT, typename _Traits, typename _Alloc>
4313 _GLIBCXX_NODISCARD[[__nodiscard__]]
4314 inline bool
4315 operator<=(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
4316 const _CharT* __rhs)
4317 { return __lhs.compare(__rhs) <= 0; }
4318
4319 /**
4320 * @brief Test if C string doesn't follow string.
4321 * @param __lhs C string.
4322 * @param __rhs String.
4323 * @return True if @a __lhs doesn't follow @a __rhs. False otherwise.
4324 */
4325 template<typename _CharT, typename _Traits, typename _Alloc>
4326 _GLIBCXX_NODISCARD[[__nodiscard__]]
4327 inline bool
4328 operator<=(const _CharT* __lhs,
4329 const basic_string<_CharT, _Traits, _Alloc>& __rhs)
4330 { return __rhs.compare(__lhs) >= 0; }
4331
4332 // operator >=
4333 /**
4334 * @brief Test if string doesn't precede string.
4335 * @param __lhs First string.
4336 * @param __rhs Second string.
4337 * @return True if @a __lhs doesn't precede @a __rhs. False otherwise.
4338 */
4339 template<typename _CharT, typename _Traits, typename _Alloc>
4340 _GLIBCXX_NODISCARD[[__nodiscard__]]
4341 inline bool
4342 operator>=(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
4343 const basic_string<_CharT, _Traits, _Alloc>& __rhs)
4344 _GLIBCXX_NOEXCEPTnoexcept
4345 { return __lhs.compare(__rhs) >= 0; }
4346
4347 /**
4348 * @brief Test if string doesn't precede C string.
4349 * @param __lhs String.
4350 * @param __rhs C string.
4351 * @return True if @a __lhs doesn't precede @a __rhs. False otherwise.
4352 */
4353 template<typename _CharT, typename _Traits, typename _Alloc>
4354 _GLIBCXX_NODISCARD[[__nodiscard__]]
4355 inline bool
4356 operator>=(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
4357 const _CharT* __rhs)
4358 { return __lhs.compare(__rhs) >= 0; }
4359
4360 /**
4361 * @brief Test if C string doesn't precede string.
4362 * @param __lhs C string.
4363 * @param __rhs String.
4364 * @return True if @a __lhs doesn't precede @a __rhs. False otherwise.
4365 */
4366 template<typename _CharT, typename _Traits, typename _Alloc>
4367 _GLIBCXX_NODISCARD[[__nodiscard__]]
4368 inline bool
4369 operator>=(const _CharT* __lhs,
4370 const basic_string<_CharT, _Traits, _Alloc>& __rhs)
4371 { return __rhs.compare(__lhs) <= 0; }
4372#endif // three-way comparison
4373
4374 /**
4375 * @brief Swap contents of two strings.
4376 * @param __lhs First string.
4377 * @param __rhs Second string.
4378 *
4379 * Exchanges the contents of @a __lhs and @a __rhs in constant time.
4380 */
4381 template<typename _CharT, typename _Traits, typename _Alloc>
4382 _GLIBCXX20_CONSTEXPR
4383 inline void
4384 swap(basic_string<_CharT, _Traits, _Alloc>& __lhs,
4385 basic_string<_CharT, _Traits, _Alloc>& __rhs)
4386 _GLIBCXX_NOEXCEPT_IF(noexcept(__lhs.swap(__rhs)))noexcept(noexcept(__lhs.swap(__rhs)))
4387 { __lhs.swap(__rhs); }
4388
4389
4390 /**
4391 * @brief Read stream into a string.
4392 * @param __is Input stream.
4393 * @param __str Buffer to store into.
4394 * @return Reference to the input stream.
4395 *
4396 * Stores characters from @a __is into @a __str until whitespace is
4397 * found, the end of the stream is encountered, or str.max_size()
4398 * is reached. If is.width() is non-zero, that is the limit on the
4399 * number of characters stored into @a __str. Any previous
4400 * contents of @a __str are erased.
4401 */
4402 template<typename _CharT, typename _Traits, typename _Alloc>
4403 basic_istream<_CharT, _Traits>&
4404 operator>>(basic_istream<_CharT, _Traits>& __is,
4405 basic_string<_CharT, _Traits, _Alloc>& __str);
4406
4407 template<>
4408 basic_istream<char>&
4409 operator>>(basic_istream<char>& __is, basic_string<char>& __str);
4410
4411 /**
4412 * @brief Write string to a stream.
4413 * @param __os Output stream.
4414 * @param __str String to write out.
4415 * @return Reference to the output stream.
4416 *
4417 * Output characters of @a __str into os following the same rules as for
4418 * writing a C string.
4419 */
4420 template<typename _CharT, typename _Traits, typename _Alloc>
4421 inline basic_ostream<_CharT, _Traits>&
4422 operator<<(basic_ostream<_CharT, _Traits>& __os,
4423 const basic_string<_CharT, _Traits, _Alloc>& __str)
4424 {
4425 // _GLIBCXX_RESOLVE_LIB_DEFECTS
4426 // 586. string inserter not a formatted function
4427 return __ostream_insert(__os, __str.data(), __str.size());
4428 }
4429
4430 /**
4431 * @brief Read a line from stream into a string.
4432 * @param __is Input stream.
4433 * @param __str Buffer to store into.
4434 * @param __delim Character marking end of line.
4435 * @return Reference to the input stream.
4436 *
4437 * Stores characters from @a __is into @a __str until @a __delim is
4438 * found, the end of the stream is encountered, or str.max_size()
4439 * is reached. Any previous contents of @a __str are erased. If
4440 * @a __delim is encountered, it is extracted but not stored into
4441 * @a __str.
4442 */
4443 template<typename _CharT, typename _Traits, typename _Alloc>
4444 basic_istream<_CharT, _Traits>&
4445 getline(basic_istream<_CharT, _Traits>& __is,
4446 basic_string<_CharT, _Traits, _Alloc>& __str, _CharT __delim);
4447
4448 /**
4449 * @brief Read a line from stream into a string.
4450 * @param __is Input stream.
4451 * @param __str Buffer to store into.
4452 * @return Reference to the input stream.
4453 *
4454 * Stores characters from is into @a __str until &apos;\n&apos; is
4455 * found, the end of the stream is encountered, or str.max_size()
4456 * is reached. Any previous contents of @a __str are erased. If
4457 * end of line is encountered, it is extracted but not stored into
4458 * @a __str.
4459 */
4460 template<typename _CharT, typename _Traits, typename _Alloc>
4461 inline basic_istream<_CharT, _Traits>&
4462 getline(basic_istream<_CharT, _Traits>& __is,
4463 basic_string<_CharT, _Traits, _Alloc>& __str)
4464 { return std::getline(__is, __str, __is.widen('\n')); }
4465
4466#if __cplusplus201703L >= 201103L
4467 /// Read a line from an rvalue stream into a string.
4468 template<typename _CharT, typename _Traits, typename _Alloc>
4469 inline basic_istream<_CharT, _Traits>&
4470 getline(basic_istream<_CharT, _Traits>&& __is,
4471 basic_string<_CharT, _Traits, _Alloc>& __str, _CharT __delim)
4472 { return std::getline(__is, __str, __delim); }
4473
4474 /// Read a line from an rvalue stream into a string.
4475 template<typename _CharT, typename _Traits, typename _Alloc>
4476 inline basic_istream<_CharT, _Traits>&
4477 getline(basic_istream<_CharT, _Traits>&& __is,
4478 basic_string<_CharT, _Traits, _Alloc>& __str)
4479 { return std::getline(__is, __str); }
4480#endif
4481
4482 template<>
4483 basic_istream<char>&
4484 getline(basic_istream<char>& __in, basic_string<char>& __str,
4485 char __delim);
4486
4487#ifdef _GLIBCXX_USE_WCHAR_T1
4488 template<>
4489 basic_istream<wchar_t>&
4490 getline(basic_istream<wchar_t>& __in, basic_string<wchar_t>& __str,
4491 wchar_t __delim);
4492#endif
4493
4494_GLIBCXX_END_NAMESPACE_VERSION
4495} // namespace
4496
4497#if __cplusplus201703L >= 201103L
4498
4499#include <ext/string_conversions.h>
4500#include <bits/charconv.h>
4501
4502namespace std _GLIBCXX_VISIBILITY(default)__attribute__ ((__visibility__ ("default")))
4503{
4504_GLIBCXX_BEGIN_NAMESPACE_VERSION
4505_GLIBCXX_BEGIN_NAMESPACE_CXX11namespace __cxx11 {
4506
4507 // 21.4 Numeric Conversions [string.conversions].
4508 inline int
4509 stoi(const string& __str, size_t* __idx = 0, int __base = 10)
4510 { return __gnu_cxx::__stoa<long, int>(&std::strtol, "stoi", __str.c_str(),
4511 __idx, __base); }
4512
4513 inline long
4514 stol(const string& __str, size_t* __idx = 0, int __base = 10)
4515 { return __gnu_cxx::__stoa(&std::strtol, "stol", __str.c_str(),
4516 __idx, __base); }
4517
4518 inline unsigned long
4519 stoul(const string& __str, size_t* __idx = 0, int __base = 10)
4520 { return __gnu_cxx::__stoa(&std::strtoul, "stoul", __str.c_str(),
4521 __idx, __base); }
4522
4523#if _GLIBCXX_USE_C99_STDLIB1
4524 inline long long
4525 stoll(const string& __str, size_t* __idx = 0, int __base = 10)
4526 { return __gnu_cxx::__stoa(&std::strtoll, "stoll", __str.c_str(),
4527 __idx, __base); }
4528
4529 inline unsigned long long
4530 stoull(const string& __str, size_t* __idx = 0, int __base = 10)
4531 { return __gnu_cxx::__stoa(&std::strtoull, "stoull", __str.c_str(),
4532 __idx, __base); }
4533#elif __LONG_WIDTH__64 == __LONG_LONG_WIDTH__
4534 inline long long
4535 stoll(const string& __str, size_t* __idx = 0, int __base = 10)
4536 { return std::stol(__str, __idx, __base); }
4537
4538 inline unsigned long long
4539 stoull(const string& __str, size_t* __idx = 0, int __base = 10)
4540 { return std::stoul(__str, __idx, __base); }
4541#endif
4542
4543 inline double
4544 stod(const string& __str, size_t* __idx = 0)
4545 { return __gnu_cxx::__stoa(&std::strtod, "stod", __str.c_str(), __idx); }
4546
4547#if _GLIBCXX_HAVE_STRTOF1
4548 // NB: strtof vs strtod.
4549 inline float
4550 stof(const string& __str, size_t* __idx = 0)
4551 { return __gnu_cxx::__stoa(&std::strtof, "stof", __str.c_str(), __idx); }
4552#else
4553 inline float
4554 stof(const string& __str, size_t* __idx = 0)
4555 {
4556 double __d = std::stod(__str, __idx);
4557 if (__builtin_isfinite(__d) && __d != 0.0)
4558 {
4559 double __abs_d = __builtin_fabs(__d);
4560 if (__abs_d < __FLT_MIN__1.17549435e-38F || __abs_d > __FLT_MAX__3.40282347e+38F)
4561 {
4562 errno(*__errno_location ()) = ERANGE34;
4563 std::__throw_out_of_range("stof");
4564 }
4565 }
4566 return __d;
4567 }
4568#endif
4569
4570#if _GLIBCXX_HAVE_STRTOLD1 && ! _GLIBCXX_HAVE_BROKEN_STRTOLD
4571 inline long double
4572 stold(const string& __str, size_t* __idx = 0)
4573 { return __gnu_cxx::__stoa(&std::strtold, "stold", __str.c_str(), __idx); }
4574#elif __DBL_MANT_DIG__53 == __LDBL_MANT_DIG__64
4575 inline long double
4576 stold(const string& __str, size_t* __idx = 0)
4577 { return std::stod(__str, __idx); }
4578#endif
4579
4580 // _GLIBCXX_RESOLVE_LIB_DEFECTS
4581 // DR 1261. Insufficent overloads for to_string / to_wstring
4582
4583 _GLIBCXX_NODISCARD[[__nodiscard__]]
4584 inline string
4585 to_string(int __val)
4586#if _GLIBCXX_USE_CXX11_ABI1 && (__CHAR_BIT__8 * __SIZEOF_INT__4) <= 32
4587 noexcept // any 32-bit value fits in the SSO buffer
4588#endif
4589 {
4590 const bool __neg = __val < 0;
4591 const unsigned __uval = __neg ? (unsigned)~__val + 1u : __val;
4592 const auto __len = __detail::__to_chars_len(__uval);
4593 string __str;
4594 __str.__resize_and_overwrite(__neg + __len, [=](char* __p, size_t __n) {
4595 __p[0] = '-';
4596 __detail::__to_chars_10_impl(__p + (int)__neg, __len, __uval);
4597 return __n;
4598 });
4599 return __str;
4600 }
4601
4602 _GLIBCXX_NODISCARD[[__nodiscard__]]
4603 inline string
4604 to_string(unsigned __val)
4605#if _GLIBCXX_USE_CXX11_ABI1 && (__CHAR_BIT__8 * __SIZEOF_INT__4) <= 32
4606 noexcept // any 32-bit value fits in the SSO buffer
4607#endif
4608 {
4609 const auto __len = __detail::__to_chars_len(__val);
4610 string __str;
4611 __str.__resize_and_overwrite(__len, [__val](char* __p, size_t __n) {
4612 __detail::__to_chars_10_impl(__p, __n, __val);
4613 return __n;
4614 });
4615 return __str;
4616 }
4617
4618 _GLIBCXX_NODISCARD[[__nodiscard__]]
4619 inline string
4620 to_string(long __val)
4621#if _GLIBCXX_USE_CXX11_ABI1 && (__CHAR_BIT__8 * __SIZEOF_LONG__8) <= 32
4622 noexcept // any 32-bit value fits in the SSO buffer
4623#endif
4624 {
4625 const bool __neg = __val < 0;
4626 const unsigned long __uval = __neg ? (unsigned long)~__val + 1ul : __val;
4627 const auto __len = __detail::__to_chars_len(__uval);
4628 string __str;
4629 __str.__resize_and_overwrite(__neg + __len, [=](char* __p, size_t __n) {
4630 __p[0] = '-';
4631 __detail::__to_chars_10_impl(__p + (int)__neg, __len, __uval);
4632 return __n;
4633 });
4634 return __str;
4635 }
4636
4637 _GLIBCXX_NODISCARD[[__nodiscard__]]
4638 inline string
4639 to_string(unsigned long __val)
4640#if _GLIBCXX_USE_CXX11_ABI1 && (__CHAR_BIT__8 * __SIZEOF_LONG__8) <= 32
4641 noexcept // any 32-bit value fits in the SSO buffer
4642#endif
4643 {
4644 const auto __len = __detail::__to_chars_len(__val);
4645 string __str;
4646 __str.__resize_and_overwrite(__len, [__val](char* __p, size_t __n) {
4647 __detail::__to_chars_10_impl(__p, __n, __val);
4648 return __n;
4649 });
4650 return __str;
4651 }
4652
4653 _GLIBCXX_NODISCARD[[__nodiscard__]]
4654 inline string
4655 to_string(long long __val)
4656 {
4657 const bool __neg = __val < 0;
4658 const unsigned long long __uval
4659 = __neg ? (unsigned long long)~__val + 1ull : __val;
4660 const auto __len = __detail::__to_chars_len(__uval);
4661 string __str;
4662 __str.__resize_and_overwrite(__neg + __len, [=](char* __p, size_t __n) {
4663 __p[0] = '-';
4664 __detail::__to_chars_10_impl(__p + (int)__neg, __len, __uval);
4665 return __n;
4666 });
4667 return __str;
4668 }
4669
4670 _GLIBCXX_NODISCARD[[__nodiscard__]]
4671 inline string
4672 to_string(unsigned long long __val)
4673 {
4674 const auto __len = __detail::__to_chars_len(__val);
4675 string __str;
4676 __str.__resize_and_overwrite(__len, [__val](char* __p, size_t __n) {
4677 __detail::__to_chars_10_impl(__p, __n, __val);
4678 return __n;
4679 });
4680 return __str;
4681 }
4682
4683#if __glibcxx_to_string >= 202306L // C++ >= 26
4684
4685 [[nodiscard]]
4686 inline string
4687 to_string(float __val)
4688 {
4689 string __str;
4690 size_t __len = 15;
4691 do {
4692 __str.resize_and_overwrite(__len,
4693 [__val, &__len] (char* __p, size_t __n) {
4694 auto [__end, __err] = std::to_chars(__p, __p + __n, __val);
4695 if (__err == errc{}) [[likely]]
4696 return __end - __p;
4697 __len *= 2;
4698 return __p - __p;;
4699 });
4700 } while (__str.empty());
4701 return __str;
4702 }
4703
4704 [[nodiscard]]
4705 inline string
4706 to_string(double __val)
4707 {
4708 string __str;
4709 size_t __len = 15;
4710 do {
4711 __str.resize_and_overwrite(__len,
4712 [__val, &__len] (char* __p, size_t __n) {
4713 auto [__end, __err] = std::to_chars(__p, __p + __n, __val);
4714 if (__err == errc{}) [[likely]]
4715 return __end - __p;
4716 __len *= 2;
4717 return __p - __p;;
4718 });
4719 } while (__str.empty());
4720 return __str;
4721 }
4722
4723 [[nodiscard]]
4724 inline string
4725 to_string(long double __val)
4726 {
4727 string __str;
4728 size_t __len = 15;
4729 do {
4730 __str.resize_and_overwrite(__len,
4731 [__val, &__len] (char* __p, size_t __n) {
4732 auto [__end, __err] = std::to_chars(__p, __p + __n, __val);
4733 if (__err == errc{}) [[likely]]
4734 return __end - __p;
4735 __len *= 2;
4736 return __p - __p;;
4737 });
4738 } while (__str.empty());
4739 return __str;
4740 }
4741#elif _GLIBCXX_USE_C99_STDIO1
4742#pragma GCC diagnostic push
4743#pragma GCC diagnostic ignored "-Wsuggest-attribute=format"
4744 // NB: (v)snprintf vs sprintf.
4745
4746 _GLIBCXX_NODISCARD[[__nodiscard__]]
4747 inline string
4748 to_string(float __val)
4749 {
4750 const int __n =
4751 __gnu_cxx::__numeric_traits<float>::__max_exponent10 + 20;
4752 return __gnu_cxx::__to_xstring<string>(&std::vsnprintf, __n,
4753 "%f", __val);
4754 }
4755
4756 _GLIBCXX_NODISCARD[[__nodiscard__]]
4757 inline string
4758 to_string(double __val)
4759 {
4760 const int __n =
4761 __gnu_cxx::__numeric_traits<double>::__max_exponent10 + 20;
4762 return __gnu_cxx::__to_xstring<string>(&std::vsnprintf, __n,
4763 "%f", __val);
4764 }
4765
4766 _GLIBCXX_NODISCARD[[__nodiscard__]]
4767 inline string
4768 to_string(long double __val)
4769 {
4770 const int __n =
4771 __gnu_cxx::__numeric_traits<long double>::__max_exponent10 + 20;
4772 return __gnu_cxx::__to_xstring<string>(&std::vsnprintf, __n,
4773 "%Lf", __val);
4774 }
4775#pragma GCC diagnostic pop
4776#endif // _GLIBCXX_USE_C99_STDIO
4777
4778#if defined(_GLIBCXX_USE_WCHAR_T1) && _GLIBCXX_USE_C99_WCHAR1
4779 inline int
4780 stoi(const wstring& __str, size_t* __idx = 0, int __base = 10)
4781 { return __gnu_cxx::__stoa<long, int>(&std::wcstol, "stoi", __str.c_str(),
4782 __idx, __base); }
4783
4784 inline long
4785 stol(const wstring& __str, size_t* __idx = 0, int __base = 10)
4786 { return __gnu_cxx::__stoa(&std::wcstol, "stol", __str.c_str(),
4787 __idx, __base); }
4788
4789 inline unsigned long
4790 stoul(const wstring& __str, size_t* __idx = 0, int __base = 10)
4791 { return __gnu_cxx::__stoa(&std::wcstoul, "stoul", __str.c_str(),
4792 __idx, __base); }
4793
4794 inline long long
4795 stoll(const wstring& __str, size_t* __idx = 0, int __base = 10)
4796 { return __gnu_cxx::__stoa(&std::wcstoll, "stoll", __str.c_str(),
4797 __idx, __base); }
4798
4799 inline unsigned long long
4800 stoull(const wstring& __str, size_t* __idx = 0, int __base = 10)
4801 { return __gnu_cxx::__stoa(&std::wcstoull, "stoull", __str.c_str(),
4802 __idx, __base); }
4803
4804 // NB: wcstof vs wcstod.
4805 inline float
4806 stof(const wstring& __str, size_t* __idx = 0)
4807 { return __gnu_cxx::__stoa(&std::wcstof, "stof", __str.c_str(), __idx); }
4808
4809 inline double
4810 stod(const wstring& __str, size_t* __idx = 0)
4811 { return __gnu_cxx::__stoa(&std::wcstod, "stod", __str.c_str(), __idx); }
4812
4813 inline long double
4814 stold(const wstring& __str, size_t* __idx = 0)
4815 { return __gnu_cxx::__stoa(&std::wcstold, "stold", __str.c_str(), __idx); }
4816#endif
4817
4818#ifdef _GLIBCXX_USE_WCHAR_T1
4819#pragma GCC diagnostic push
4820#pragma GCC diagnostic ignored "-Wc++17-extensions"
4821 _GLIBCXX20_CONSTEXPR
4822 inline void
4823 __to_wstring_numeric(const char* __s, int __len, wchar_t* __wout)
4824 {
4825 // This condition is true if exec-charset and wide-exec-charset share the
4826 // same values for the ASCII subset or the EBCDIC invariant character set.
4827 if constexpr (wchar_t('0') == L'0' && wchar_t('-') == L'-'
4828 && wchar_t('.') == L'.' && wchar_t('e') == L'e')
4829 {
4830 for (int __i = 0; __i < __len; ++__i)
4831 __wout[__i] = (wchar_t) __s[__i];
4832 }
4833 else
4834 {
4835 wchar_t __wc[256];
4836 for (int __i = '0'; __i <= '9'; ++__i)
4837 __wc[__i] = L'0' + __i;
4838 __wc['.'] = L'.';
4839 __wc['+'] = L'+';
4840 __wc['-'] = L'-';
4841 __wc['a'] = L'a';
4842 __wc['b'] = L'b';
4843 __wc['c'] = L'c';
4844 __wc['d'] = L'd';
4845 __wc['e'] = L'e';
4846 __wc['f'] = L'f';
4847 __wc['i'] = L'i'; // for "inf"
4848 __wc['n'] = L'n'; // for "nan" and "inf"
4849 __wc['p'] = L'p'; // for hexfloats "0x1p1"
4850 __wc['x'] = L'x';
4851 __wc['A'] = L'A';
4852 __wc['B'] = L'B';
4853 __wc['C'] = L'C';
4854 __wc['D'] = L'D';
4855 __wc['E'] = L'E';
4856 __wc['F'] = L'F';
4857 __wc['I'] = L'I';
4858 __wc['N'] = L'N';
4859 __wc['P'] = L'P';
4860 __wc['X'] = L'X';
4861
4862 for (int __i = 0; __i < __len; ++__i)
4863 __wout[__i] = __wc[(int)__s[__i]];
4864 }
4865 }
4866
4867#if __glibcxx_constexpr_string201611L >= 201907L
4868 constexpr
4869#endif
4870 inline wstring
4871#ifdef __glibcxx_string_view201803L // >= C++17
4872 __to_wstring_numeric(string_view __s)
4873#else
4874 __to_wstring_numeric(const string& __s)
4875#endif
4876 {
4877 if constexpr (wchar_t('0') == L'0' && wchar_t('-') == L'-'
4878 && wchar_t('.') == L'.' && wchar_t('e') == L'e')
4879 return wstring(__s.data(), __s.data() + __s.size());
4880 else
4881 {
4882 wstring __ws;
4883 auto __f = __s.data();
4884 __ws.__resize_and_overwrite(__s.size(),
4885 [__f] (wchar_t* __to, int __n) {
4886 std::__to_wstring_numeric(__f, __n, __to);
4887 return __n;
4888 });
4889 return __ws;
4890 }
4891 }
4892#pragma GCC diagnostic pop
4893
4894 _GLIBCXX_NODISCARD[[__nodiscard__]]
4895 inline wstring
4896 to_wstring(int __val)
4897 { return std::__to_wstring_numeric(std::to_string(__val)); }
4898
4899 _GLIBCXX_NODISCARD[[__nodiscard__]]
4900 inline wstring
4901 to_wstring(unsigned __val)
4902 { return std::__to_wstring_numeric(std::to_string(__val)); }
4903
4904 _GLIBCXX_NODISCARD[[__nodiscard__]]
4905 inline wstring
4906 to_wstring(long __val)
4907 { return std::__to_wstring_numeric(std::to_string(__val)); }
4908
4909 _GLIBCXX_NODISCARD[[__nodiscard__]]
4910 inline wstring
4911 to_wstring(unsigned long __val)
4912 { return std::__to_wstring_numeric(std::to_string(__val)); }
4913
4914 _GLIBCXX_NODISCARD[[__nodiscard__]]
4915 inline wstring
4916 to_wstring(long long __val)
4917 { return std::__to_wstring_numeric(std::to_string(__val)); }
4918
4919 _GLIBCXX_NODISCARD[[__nodiscard__]]
4920 inline wstring
4921 to_wstring(unsigned long long __val)
4922 { return std::__to_wstring_numeric(std::to_string(__val)); }
4923
4924#if __glibcxx_to_string || _GLIBCXX_USE_C99_STDIO1
4925 _GLIBCXX_NODISCARD[[__nodiscard__]]
4926 inline wstring
4927 to_wstring(float __val)
4928 { return std::__to_wstring_numeric(std::to_string(__val)); }
4929
4930 _GLIBCXX_NODISCARD[[__nodiscard__]]
4931 inline wstring
4932 to_wstring(double __val)
4933 { return std::__to_wstring_numeric(std::to_string(__val)); }
4934
4935 _GLIBCXX_NODISCARD[[__nodiscard__]]
4936 inline wstring
4937 to_wstring(long double __val)
4938 { return std::__to_wstring_numeric(std::to_string(__val)); }
4939#endif
4940#endif // _GLIBCXX_USE_WCHAR_T
4941
4942_GLIBCXX_END_NAMESPACE_CXX11}
4943_GLIBCXX_END_NAMESPACE_VERSION
4944} // namespace
4945
4946#endif /* C++11 */
4947
4948#if __cplusplus201703L >= 201103L
4949
4950#include <bits/functional_hash.h>
4951
4952namespace std _GLIBCXX_VISIBILITY(default)__attribute__ ((__visibility__ ("default")))
4953{
4954_GLIBCXX_BEGIN_NAMESPACE_VERSION
4955
4956 // _GLIBCXX_RESOLVE_LIB_DEFECTS
4957 // 3705. Hashability shouldn't depend on basic_string's allocator
4958
4959 template<typename _CharT, typename _Alloc,
4960 typename _StrT = basic_string<_CharT, char_traits<_CharT>, _Alloc>>
4961 struct __str_hash_base
4962 : public __hash_base<size_t, _StrT>
4963 {
4964 [[__nodiscard__]]
4965 size_t
4966 operator()(const _StrT& __s) const noexcept
4967 { return _Hash_impl::hash(__s.data(), __s.length() * sizeof(_CharT)); }
4968 };
4969
4970#ifndef _GLIBCXX_COMPATIBILITY_CXX0X
4971 /// std::hash specialization for string.
4972 template<typename _Alloc>
4973 struct hash<basic_string<char, char_traits<char>, _Alloc>>
4974 : public __str_hash_base<char, _Alloc>
4975 { };
4976
4977 /// std::hash specialization for wstring.
4978 template<typename _Alloc>
4979 struct hash<basic_string<wchar_t, char_traits<wchar_t>, _Alloc>>
4980 : public __str_hash_base<wchar_t, _Alloc>
4981 { };
4982
4983 template<typename _Alloc>
4984 struct __is_fast_hash<hash<basic_string<wchar_t, char_traits<wchar_t>,
4985 _Alloc>>>
4986 : std::false_type
4987 { };
4988#endif /* _GLIBCXX_COMPATIBILITY_CXX0X */
4989
4990#ifdef _GLIBCXX_USE_CHAR8_T
4991 /// std::hash specialization for u8string.
4992 template<typename _Alloc>
4993 struct hash<basic_string<char8_t, char_traits<char8_t>, _Alloc>>
4994 : public __str_hash_base<char8_t, _Alloc>
4995 { };
4996#endif
4997
4998 /// std::hash specialization for u16string.
4999 template<typename _Alloc>
5000 struct hash<basic_string<char16_t, char_traits<char16_t>, _Alloc>>
5001 : public __str_hash_base<char16_t, _Alloc>
5002 { };
5003
5004 /// std::hash specialization for u32string.
5005 template<typename _Alloc>
5006 struct hash<basic_string<char32_t, char_traits<char32_t>, _Alloc>>
5007 : public __str_hash_base<char32_t, _Alloc>
5008 { };
5009
5010#if ! _GLIBCXX_INLINE_VERSION0
5011 // PR libstdc++/105907 - __is_fast_hash affects unordered container ABI.
5012 template<> struct __is_fast_hash<hash<string>> : std::false_type { };
5013 template<> struct __is_fast_hash<hash<wstring>> : std::false_type { };
5014 template<> struct __is_fast_hash<hash<u16string>> : std::false_type { };
5015 template<> struct __is_fast_hash<hash<u32string>> : std::false_type { };
5016#ifdef _GLIBCXX_USE_CHAR8_T
5017 template<> struct __is_fast_hash<hash<u8string>> : std::false_type { };
5018#endif
5019#else
5020 // For versioned namespace, assume every std::hash<basic_string<>> is slow.
5021 template<typename _CharT, typename _Traits, typename _Alloc>
5022 struct __is_fast_hash<hash<basic_string<_CharT, _Traits, _Alloc>>>
5023 : std::false_type
5024 { };
5025#endif
5026
5027#ifdef __glibcxx_string_udls201304L // C++ >= 14
5028 inline namespace literals
5029 {
5030 inline namespace string_literals
5031 {
5032#pragma GCC diagnostic push
5033#pragma GCC diagnostic ignored "-Wliteral-suffix"
5034
5035#if __glibcxx_constexpr_string201611L >= 201907L
5036# define _GLIBCXX_STRING_CONSTEXPR constexpr
5037#else
5038# define _GLIBCXX_STRING_CONSTEXPR
5039#endif
5040
5041 _GLIBCXX_DEFAULT_ABI_TAG__attribute ((__abi_tag__ ("cxx11"))) _GLIBCXX_STRING_CONSTEXPR
5042 inline basic_string<char>
5043 operator""s(const char* __str, size_t __len)
5044 { return basic_string<char>{__str, __len}; }
5045
5046 _GLIBCXX_DEFAULT_ABI_TAG__attribute ((__abi_tag__ ("cxx11"))) _GLIBCXX_STRING_CONSTEXPR
5047 inline basic_string<wchar_t>
5048 operator""s(const wchar_t* __str, size_t __len)
5049 { return basic_string<wchar_t>{__str, __len}; }
5050
5051#ifdef _GLIBCXX_USE_CHAR8_T
5052 _GLIBCXX_DEFAULT_ABI_TAG__attribute ((__abi_tag__ ("cxx11"))) _GLIBCXX_STRING_CONSTEXPR
5053 inline basic_string<char8_t>
5054 operator""s(const char8_t* __str, size_t __len)
5055 { return basic_string<char8_t>{__str, __len}; }
5056#endif
5057
5058 _GLIBCXX_DEFAULT_ABI_TAG__attribute ((__abi_tag__ ("cxx11"))) _GLIBCXX_STRING_CONSTEXPR
5059 inline basic_string<char16_t>
5060 operator""s(const char16_t* __str, size_t __len)
5061 { return basic_string<char16_t>{__str, __len}; }
5062
5063 _GLIBCXX_DEFAULT_ABI_TAG__attribute ((__abi_tag__ ("cxx11"))) _GLIBCXX_STRING_CONSTEXPR
5064 inline basic_string<char32_t>
5065 operator""s(const char32_t* __str, size_t __len)
5066 { return basic_string<char32_t>{__str, __len}; }
5067
5068#undef _GLIBCXX_STRING_CONSTEXPR
5069#pragma GCC diagnostic pop
5070 } // inline namespace string_literals
5071 } // inline namespace literals
5072#endif // __glibcxx_string_udls
5073
5074#ifdef __glibcxx_variant202102L // >= C++17
5075 namespace __detail::__variant
5076 {
5077 template<typename> struct _Never_valueless_alt; // see <variant>
5078
5079 // Provide the strong exception-safety guarantee when emplacing a
5080 // basic_string into a variant, but only if moving the string cannot throw.
5081 template<typename _Tp, typename _Traits, typename _Alloc>
5082 struct _Never_valueless_alt<std::basic_string<_Tp, _Traits, _Alloc>>
5083 : __and_<
5084 is_nothrow_move_constructible<std::basic_string<_Tp, _Traits, _Alloc>>,
5085 is_nothrow_move_assignable<std::basic_string<_Tp, _Traits, _Alloc>>
5086 >::type
5087 { };
5088 } // namespace __detail::__variant
5089#endif // C++17
5090
5091_GLIBCXX_END_NAMESPACE_VERSION
5092} // namespace std
5093
5094#endif // C++11
5095
5096#endif /* _BASIC_STRING_H */

/usr/src/googletest/googletest/include/gtest/gtest.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// The Google C++ Testing and Mocking Framework (Google Test)
31//
32// This header file defines the public API for Google Test. It should be
33// included by any test program that uses Google Test.
34//
35// IMPORTANT NOTE: Due to limitation of the C++ language, we have to
36// leave some internal implementation details in this header file.
37// They are clearly marked by comments like this:
38//
39// // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
40//
41// Such code is NOT meant to be used by a user directly, and is subject
42// to CHANGE WITHOUT NOTICE. Therefore DO NOT DEPEND ON IT in a user
43// program!
44//
45// Acknowledgment: Google Test borrowed the idea of automatic test
46// registration from Barthelemy Dagenais' (barthelemy@prologique.com)
47// easyUnit framework.
48
49#ifndef GOOGLETEST_INCLUDE_GTEST_GTEST_H_
50#define GOOGLETEST_INCLUDE_GTEST_GTEST_H_
51
52#include <cstddef>
53#include <cstdint>
54#include <limits>
55#include <memory>
56#include <ostream>
57#include <set>
58#include <sstream>
59#include <string>
60#include <type_traits>
61#include <vector>
62
63#include "gtest/gtest-assertion-result.h" // IWYU pragma: export
64#include "gtest/gtest-death-test.h" // IWYU pragma: export
65#include "gtest/gtest-matchers.h" // IWYU pragma: export
66#include "gtest/gtest-message.h" // IWYU pragma: export
67#include "gtest/gtest-param-test.h" // IWYU pragma: export
68#include "gtest/gtest-printers.h" // IWYU pragma: export
69#include "gtest/gtest-test-part.h" // IWYU pragma: export
70#include "gtest/gtest-typed-test.h" // IWYU pragma: export
71#include "gtest/gtest_pred_impl.h" // IWYU pragma: export
72#include "gtest/gtest_prod.h" // IWYU pragma: export
73#include "gtest/internal/gtest-internal.h"
74#include "gtest/internal/gtest-string.h"
75
76GTEST_DISABLE_MSC_WARNINGS_PUSH_(4251 \
77/* class A needs to have dll-interface to be used by clients of class B */)
78
79// Declares the flags.
80
81// This flag temporary enables the disabled tests.
82GTEST_DECLARE_bool_(also_run_disabled_tests)namespace testing { __attribute__((visibility("default"))) extern
bool FLAGS_gtest_also_run_disabled_tests; } static_assert(true
, "no-op to require trailing semicolon")
;
83
84// This flag brings the debugger on an assertion failure.
85GTEST_DECLARE_bool_(break_on_failure)namespace testing { __attribute__((visibility("default"))) extern
bool FLAGS_gtest_break_on_failure; } static_assert(true, "no-op to require trailing semicolon"
)
;
86
87// This flag controls whether Google Test catches all test-thrown exceptions
88// and logs them as failures.
89GTEST_DECLARE_bool_(catch_exceptions)namespace testing { __attribute__((visibility("default"))) extern
bool FLAGS_gtest_catch_exceptions; } static_assert(true, "no-op to require trailing semicolon"
)
;
90
91// This flag enables using colors in terminal output. Available values are
92// "yes" to enable colors, "no" (disable colors), or "auto" (the default)
93// to let Google Test decide.
94GTEST_DECLARE_string_(color)namespace testing { __attribute__((visibility("default"))) extern
::std::string FLAGS_gtest_color; } static_assert(true, "no-op to require trailing semicolon"
)
;
95
96// This flag controls whether the test runner should continue execution past
97// first failure.
98GTEST_DECLARE_bool_(fail_fast)namespace testing { __attribute__((visibility("default"))) extern
bool FLAGS_gtest_fail_fast; } static_assert(true, "no-op to require trailing semicolon"
)
;
99
100// This flag sets up the filter to select by name using a glob pattern
101// the tests to run. If the filter is not given all tests are executed.
102GTEST_DECLARE_string_(filter)namespace testing { __attribute__((visibility("default"))) extern
::std::string FLAGS_gtest_filter; } static_assert(true, "no-op to require trailing semicolon"
)
;
103
104// This flag controls whether Google Test installs a signal handler that dumps
105// debugging information when fatal signals are raised.
106GTEST_DECLARE_bool_(install_failure_signal_handler)namespace testing { __attribute__((visibility("default"))) extern
bool FLAGS_gtest_install_failure_signal_handler; } static_assert
(true, "no-op to require trailing semicolon")
;
107
108// This flag causes the Google Test to list tests. None of the tests listed
109// are actually run if the flag is provided.
110GTEST_DECLARE_bool_(list_tests)namespace testing { __attribute__((visibility("default"))) extern
bool FLAGS_gtest_list_tests; } static_assert(true, "no-op to require trailing semicolon"
)
;
111
112// This flag controls whether Google Test emits a detailed XML report to a file
113// in addition to its normal textual output.
114GTEST_DECLARE_string_(output)namespace testing { __attribute__((visibility("default"))) extern
::std::string FLAGS_gtest_output; } static_assert(true, "no-op to require trailing semicolon"
)
;
115
116// This flags control whether Google Test prints only test failures.
117GTEST_DECLARE_bool_(brief)namespace testing { __attribute__((visibility("default"))) extern
bool FLAGS_gtest_brief; } static_assert(true, "no-op to require trailing semicolon"
)
;
118
119// This flags control whether Google Test prints the elapsed time for each
120// test.
121GTEST_DECLARE_bool_(print_time)namespace testing { __attribute__((visibility("default"))) extern
bool FLAGS_gtest_print_time; } static_assert(true, "no-op to require trailing semicolon"
)
;
122
123// This flags control whether Google Test prints UTF8 characters as text.
124GTEST_DECLARE_bool_(print_utf8)namespace testing { __attribute__((visibility("default"))) extern
bool FLAGS_gtest_print_utf8; } static_assert(true, "no-op to require trailing semicolon"
)
;
125
126// This flag specifies the random number seed.
127GTEST_DECLARE_int32_(random_seed)namespace testing { __attribute__((visibility("default"))) extern
std::int32_t FLAGS_gtest_random_seed; } static_assert(true, "no-op to require trailing semicolon"
)
;
128
129// This flag sets how many times the tests are repeated. The default value
130// is 1. If the value is -1 the tests are repeating forever.
131GTEST_DECLARE_int32_(repeat)namespace testing { __attribute__((visibility("default"))) extern
std::int32_t FLAGS_gtest_repeat; } static_assert(true, "no-op to require trailing semicolon"
)
;
132
133// This flag controls whether Google Test Environments are recreated for each
134// repeat of the tests. The default value is true. If set to false the global
135// test Environment objects are only set up once, for the first iteration, and
136// only torn down once, for the last.
137GTEST_DECLARE_bool_(recreate_environments_when_repeating)namespace testing { __attribute__((visibility("default"))) extern
bool FLAGS_gtest_recreate_environments_when_repeating; } static_assert
(true, "no-op to require trailing semicolon")
;
138
139// This flag controls whether Google Test includes Google Test internal
140// stack frames in failure stack traces.
141GTEST_DECLARE_bool_(show_internal_stack_frames)namespace testing { __attribute__((visibility("default"))) extern
bool FLAGS_gtest_show_internal_stack_frames; } static_assert
(true, "no-op to require trailing semicolon")
;
142
143// When this flag is specified, tests' order is randomized on every iteration.
144GTEST_DECLARE_bool_(shuffle)namespace testing { __attribute__((visibility("default"))) extern
bool FLAGS_gtest_shuffle; } static_assert(true, "no-op to require trailing semicolon"
)
;
145
146// This flag specifies the maximum number of stack frames to be
147// printed in a failure message.
148GTEST_DECLARE_int32_(stack_trace_depth)namespace testing { __attribute__((visibility("default"))) extern
std::int32_t FLAGS_gtest_stack_trace_depth; } static_assert(
true, "no-op to require trailing semicolon")
;
149
150// When this flag is specified, a failed assertion will throw an
151// exception if exceptions are enabled, or exit the program with a
152// non-zero code otherwise. For use with an external test framework.
153GTEST_DECLARE_bool_(throw_on_failure)namespace testing { __attribute__((visibility("default"))) extern
bool FLAGS_gtest_throw_on_failure; } static_assert(true, "no-op to require trailing semicolon"
)
;
154
155// When this flag is set with a "host:port" string, on supported
156// platforms test results are streamed to the specified port on
157// the specified host machine.
158GTEST_DECLARE_string_(stream_result_to)namespace testing { __attribute__((visibility("default"))) extern
::std::string FLAGS_gtest_stream_result_to; } static_assert(
true, "no-op to require trailing semicolon")
;
159
160#if GTEST_USE_OWN_FLAGFILE_FLAG_1
161GTEST_DECLARE_string_(flagfile)namespace testing { __attribute__((visibility("default"))) extern
::std::string FLAGS_gtest_flagfile; } static_assert(true, "no-op to require trailing semicolon"
)
;
162#endif // GTEST_USE_OWN_FLAGFILE_FLAG_
163
164namespace testing {
165
166// Silence C4100 (unreferenced formal parameter) and 4805
167// unsafe mix of type 'const int' and type 'const bool'
168GTEST_DISABLE_MSC_WARNINGS_PUSH_(4805 4100)
169
170// The upper limit for valid stack trace depths.
171const int kMaxStackTraceDepth = 100;
172
173namespace internal {
174
175class AssertHelper;
176class DefaultGlobalTestPartResultReporter;
177class ExecDeathTest;
178class NoExecDeathTest;
179class FinalSuccessChecker;
180class GTestFlagSaver;
181class StreamingListenerTest;
182class TestResultAccessor;
183class TestEventListenersAccessor;
184class TestEventRepeater;
185class UnitTestRecordPropertyTestHelper;
186class WindowsDeathTest;
187class FuchsiaDeathTest;
188class UnitTestImpl* GetUnitTestImpl();
189void ReportFailureInUnknownLocation(TestPartResult::Type result_type,
190 const std::string& message);
191std::set<std::string>* GetIgnoredParameterizedTestSuites();
192
193// A base class that prevents subclasses from being copyable.
194// We do this instead of using '= delete' so as to avoid triggering warnings
195// inside user code regarding any of our declarations.
196class GTestNonCopyable {
197 public:
198 GTestNonCopyable() = default;
199 GTestNonCopyable(const GTestNonCopyable&) = delete;
200 GTestNonCopyable& operator=(const GTestNonCopyable&) = delete;
201 ~GTestNonCopyable() = default;
202};
203
204} // namespace internal
205
206// The friend relationship of some of these classes is cyclic.
207// If we don't forward declare them the compiler might confuse the classes
208// in friendship clauses with same named classes on the scope.
209class Test;
210class TestSuite;
211
212// Old API is still available but deprecated
213#ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_
214using TestCase = TestSuite;
215#endif
216class TestInfo;
217class UnitTest;
218
219// The abstract class that all tests inherit from.
220//
221// In Google Test, a unit test program contains one or many TestSuites, and
222// each TestSuite contains one or many Tests.
223//
224// When you define a test using the TEST macro, you don't need to
225// explicitly derive from Test - the TEST macro automatically does
226// this for you.
227//
228// The only time you derive from Test is when defining a test fixture
229// to be used in a TEST_F. For example:
230//
231// class FooTest : public testing::Test {
232// protected:
233// void SetUp() override { ... }
234// void TearDown() override { ... }
235// ...
236// };
237//
238// TEST_F(FooTest, Bar) { ... }
239// TEST_F(FooTest, Baz) { ... }
240//
241// Test is not copyable.
242class GTEST_API___attribute__((visibility("default"))) Test {
243 public:
244 friend class TestInfo;
245
246 // The d'tor is virtual as we intend to inherit from Test.
247 virtual ~Test();
248
249 // Sets up the stuff shared by all tests in this test suite.
250 //
251 // Google Test will call Foo::SetUpTestSuite() before running the first
252 // test in test suite Foo. Hence a sub-class can define its own
253 // SetUpTestSuite() method to shadow the one defined in the super
254 // class.
255 static void SetUpTestSuite() {}
256
257 // Tears down the stuff shared by all tests in this test suite.
258 //
259 // Google Test will call Foo::TearDownTestSuite() after running the last
260 // test in test suite Foo. Hence a sub-class can define its own
261 // TearDownTestSuite() method to shadow the one defined in the super
262 // class.
263 static void TearDownTestSuite() {}
264
265 // Legacy API is deprecated but still available. Use SetUpTestSuite and
266 // TearDownTestSuite instead.
267#ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_
268 static void TearDownTestCase() {}
269 static void SetUpTestCase() {}
270#endif // GTEST_REMOVE_LEGACY_TEST_CASEAPI_
271
272 // Returns true if and only if the current test has a fatal failure.
273 static bool HasFatalFailure();
274
275 // Returns true if and only if the current test has a non-fatal failure.
276 static bool HasNonfatalFailure();
277
278 // Returns true if and only if the current test was skipped.
279 static bool IsSkipped();
280
281 // Returns true if and only if the current test has a (either fatal or
282 // non-fatal) failure.
283 static bool HasFailure() { return HasFatalFailure() || HasNonfatalFailure(); }
284
285 // Logs a property for the current test, test suite, or for the entire
286 // invocation of the test program when used outside of the context of a
287 // test suite. Only the last value for a given key is remembered. These
288 // are public static so they can be called from utility functions that are
289 // not members of the test fixture. Calls to RecordProperty made during
290 // lifespan of the test (from the moment its constructor starts to the
291 // moment its destructor finishes) will be output in XML as attributes of
292 // the <testcase> element. Properties recorded from fixture's
293 // SetUpTestSuite or TearDownTestSuite are logged as attributes of the
294 // corresponding <testsuite> element. Calls to RecordProperty made in the
295 // global context (before or after invocation of RUN_ALL_TESTS and from
296 // SetUp/TearDown method of Environment objects registered with Google
297 // Test) will be output as attributes of the <testsuites> element.
298 static void RecordProperty(const std::string& key, const std::string& value);
299 // We do not define a custom serialization except for values that can be
300 // converted to int64_t, but other values could be logged in this way.
301 template <typename T, std::enable_if_t<std::is_convertible<T, int64_t>::value,
302 bool> = true>
303 static void RecordProperty(const std::string& key, const T& value) {
304 RecordProperty(key, (Message() << value).GetString());
305 }
306
307 protected:
308 // Creates a Test object.
309 Test();
310
311 // Sets up the test fixture.
312 virtual void SetUp();
313
314 // Tears down the test fixture.
315 virtual void TearDown();
316
317 private:
318 // Returns true if and only if the current test has the same fixture class
319 // as the first test in the current test suite.
320 static bool HasSameFixtureClass();
321
322 // Runs the test after the test fixture has been set up.
323 //
324 // A sub-class must implement this to define the test logic.
325 //
326 // DO NOT OVERRIDE THIS FUNCTION DIRECTLY IN A USER PROGRAM.
327 // Instead, use the TEST or TEST_F macro.
328 virtual void TestBody() = 0;
329
330 // Sets up, executes, and tears down the test.
331 void Run();
332
333 // Deletes self. We deliberately pick an unusual name for this
334 // internal method to avoid clashing with names used in user TESTs.
335 void DeleteSelf_() { delete this; }
336
337 const std::unique_ptr<GTEST_FLAG_SAVER_::testing::internal::GTestFlagSaver> gtest_flag_saver_;
338
339 // Often a user misspells SetUp() as Setup() and spends a long time
340 // wondering why it is never called by Google Test. The declaration of
341 // the following method is solely for catching such an error at
342 // compile time:
343 //
344 // - The return type is deliberately chosen to be not void, so it
345 // will be a conflict if void Setup() is declared in the user's
346 // test fixture.
347 //
348 // - This method is private, so it will be another compiler error
349 // if the method is called from the user's test fixture.
350 //
351 // DO NOT OVERRIDE THIS FUNCTION.
352 //
353 // If you see an error about overriding the following function or
354 // about it being private, you have mis-spelled SetUp() as Setup().
355 struct Setup_should_be_spelled_SetUp {};
356 virtual Setup_should_be_spelled_SetUp* Setup() { return nullptr; }
357
358 // We disallow copying Tests.
359 Test(const Test&) = delete;
360 Test& operator=(const Test&) = delete;
361};
362
363typedef internal::TimeInMillis TimeInMillis;
364
365// A copyable object representing a user specified test property which can be
366// output as a key/value string pair.
367//
368// Don't inherit from TestProperty as its destructor is not virtual.
369class TestProperty {
370 public:
371 // C'tor. TestProperty does NOT have a default constructor.
372 // Always use this constructor (with parameters) to create a
373 // TestProperty object.
374 TestProperty(const std::string& a_key, const std::string& a_value)
375 : key_(a_key), value_(a_value) {}
376
377 // Gets the user supplied key.
378 const char* key() const { return key_.c_str(); }
379
380 // Gets the user supplied value.
381 const char* value() const { return value_.c_str(); }
382
383 // Sets a new value, overriding the one supplied in the constructor.
384 void SetValue(const std::string& new_value) { value_ = new_value; }
385
386 private:
387 // The key supplied by the user.
388 std::string key_;
389 // The value supplied by the user.
390 std::string value_;
391};
392
393// The result of a single Test. This includes a list of
394// TestPartResults, a list of TestProperties, a count of how many
395// death tests there are in the Test, and how much time it took to run
396// the Test.
397//
398// TestResult is not copyable.
399class GTEST_API___attribute__((visibility("default"))) TestResult {
400 public:
401 // Creates an empty TestResult.
402 TestResult();
403
404 // D'tor. Do not inherit from TestResult.
405 ~TestResult();
406
407 // Gets the number of all test parts. This is the sum of the number
408 // of successful test parts and the number of failed test parts.
409 int total_part_count() const;
410
411 // Returns the number of the test properties.
412 int test_property_count() const;
413
414 // Returns true if and only if the test passed (i.e. no test part failed).
415 bool Passed() const { return !Skipped() && !Failed(); }
416
417 // Returns true if and only if the test was skipped.
418 bool Skipped() const;
419
420 // Returns true if and only if the test failed.
421 bool Failed() const;
422
423 // Returns true if and only if the test fatally failed.
424 bool HasFatalFailure() const;
425
426 // Returns true if and only if the test has a non-fatal failure.
427 bool HasNonfatalFailure() const;
428
429 // Returns the elapsed time, in milliseconds.
430 TimeInMillis elapsed_time() const { return elapsed_time_; }
431
432 // Gets the time of the test case start, in ms from the start of the
433 // UNIX epoch.
434 TimeInMillis start_timestamp() const { return start_timestamp_; }
435
436 // Returns the i-th test part result among all the results. i can range from 0
437 // to total_part_count() - 1. If i is not in that range, aborts the program.
438 const TestPartResult& GetTestPartResult(int i) const;
439
440 // Returns the i-th test property. i can range from 0 to
441 // test_property_count() - 1. If i is not in that range, aborts the
442 // program.
443 const TestProperty& GetTestProperty(int i) const;
444
445 private:
446 friend class TestInfo;
447 friend class TestSuite;
448 friend class UnitTest;
449 friend class internal::DefaultGlobalTestPartResultReporter;
450 friend class internal::ExecDeathTest;
451 friend class internal::TestResultAccessor;
452 friend class internal::UnitTestImpl;
453 friend class internal::WindowsDeathTest;
454 friend class internal::FuchsiaDeathTest;
455
456 // Gets the vector of TestPartResults.
457 const std::vector<TestPartResult>& test_part_results() const {
458 return test_part_results_;
459 }
460
461 // Gets the vector of TestProperties.
462 const std::vector<TestProperty>& test_properties() const {
463 return test_properties_;
464 }
465
466 // Sets the start time.
467 void set_start_timestamp(TimeInMillis start) { start_timestamp_ = start; }
468
469 // Sets the elapsed time.
470 void set_elapsed_time(TimeInMillis elapsed) { elapsed_time_ = elapsed; }
471
472 // Adds a test property to the list. The property is validated and may add
473 // a non-fatal failure if invalid (e.g., if it conflicts with reserved
474 // key names). If a property is already recorded for the same key, the
475 // value will be updated, rather than storing multiple values for the same
476 // key. xml_element specifies the element for which the property is being
477 // recorded and is used for validation.
478 void RecordProperty(const std::string& xml_element,
479 const TestProperty& test_property);
480
481 // Adds a failure if the key is a reserved attribute of Google Test
482 // testsuite tags. Returns true if the property is valid.
483 // FIXME: Validate attribute names are legal and human readable.
484 static bool ValidateTestProperty(const std::string& xml_element,
485 const TestProperty& test_property);
486
487 // Adds a test part result to the list.
488 void AddTestPartResult(const TestPartResult& test_part_result);
489
490 // Returns the death test count.
491 int death_test_count() const { return death_test_count_; }
492
493 // Increments the death test count, returning the new count.
494 int increment_death_test_count() { return ++death_test_count_; }
495
496 // Clears the test part results.
497 void ClearTestPartResults();
498
499 // Clears the object.
500 void Clear();
501
502 // Protects mutable state of the property vector and of owned
503 // properties, whose values may be updated.
504 internal::Mutex test_properties_mutex_;
505
506 // The vector of TestPartResults
507 std::vector<TestPartResult> test_part_results_;
508 // The vector of TestProperties
509 std::vector<TestProperty> test_properties_;
510 // Running count of death tests.
511 int death_test_count_;
512 // The start time, in milliseconds since UNIX Epoch.
513 TimeInMillis start_timestamp_;
514 // The elapsed time, in milliseconds.
515 TimeInMillis elapsed_time_;
516
517 // We disallow copying TestResult.
518 TestResult(const TestResult&) = delete;
519 TestResult& operator=(const TestResult&) = delete;
520}; // class TestResult
521
522// A TestInfo object stores the following information about a test:
523//
524// Test suite name
525// Test name
526// Whether the test should be run
527// A function pointer that creates the test object when invoked
528// Test result
529//
530// The constructor of TestInfo registers itself with the UnitTest
531// singleton such that the RUN_ALL_TESTS() macro knows which tests to
532// run.
533class GTEST_API___attribute__((visibility("default"))) TestInfo {
534 public:
535 // Destructs a TestInfo object. This function is not virtual, so
536 // don't inherit from TestInfo.
537 ~TestInfo();
538
539 // Returns the test suite name.
540 const char* test_suite_name() const { return test_suite_name_.c_str(); }
541
542// Legacy API is deprecated but still available
543#ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_
544 const char* test_case_name() const { return test_suite_name(); }
545#endif // GTEST_REMOVE_LEGACY_TEST_CASEAPI_
546
547 // Returns the test name.
548 const char* name() const { return name_.c_str(); }
549
550 // Returns the name of the parameter type, or NULL if this is not a typed
551 // or a type-parameterized test.
552 const char* type_param() const {
553 if (type_param_ != nullptr) return type_param_->c_str();
554 return nullptr;
555 }
556
557 // Returns the text representation of the value parameter, or NULL if this
558 // is not a value-parameterized test.
559 const char* value_param() const {
560 if (value_param_ != nullptr) return value_param_->c_str();
561 return nullptr;
562 }
563
564 // Returns the file name where this test is defined.
565 const char* file() const { return location_.file.c_str(); }
566
567 // Returns the line where this test is defined.
568 int line() const { return location_.line; }
569
570 // Return true if this test should not be run because it's in another shard.
571 bool is_in_another_shard() const { return is_in_another_shard_; }
572
573 // Returns true if this test should run, that is if the test is not
574 // disabled (or it is disabled but the also_run_disabled_tests flag has
575 // been specified) and its full name matches the user-specified filter.
576 //
577 // Google Test allows the user to filter the tests by their full names.
578 // The full name of a test Bar in test suite Foo is defined as
579 // "Foo.Bar". Only the tests that match the filter will run.
580 //
581 // A filter is a colon-separated list of glob (not regex) patterns,
582 // optionally followed by a '-' and a colon-separated list of
583 // negative patterns (tests to exclude). A test is run if it
584 // matches one of the positive patterns and does not match any of
585 // the negative patterns.
586 //
587 // For example, *A*:Foo.* is a filter that matches any string that
588 // contains the character 'A' or starts with "Foo.".
589 bool should_run() const { return should_run_; }
590
591 // Returns true if and only if this test will appear in the XML report.
592 bool is_reportable() const {
593 // The XML report includes tests matching the filter, excluding those
594 // run in other shards.
595 return matches_filter_ && !is_in_another_shard_;
596 }
597
598 // Returns the result of the test.
599 const TestResult* result() const { return &result_; }
600
601 private:
602#ifdef GTEST_HAS_DEATH_TEST1
603 friend class internal::DefaultDeathTestFactory;
604#endif // GTEST_HAS_DEATH_TEST
605 friend class Test;
606 friend class TestSuite;
607 friend class internal::UnitTestImpl;
608 friend class internal::StreamingListenerTest;
609 friend TestInfo* internal::MakeAndRegisterTestInfo(
610 std::string test_suite_name, const char* name, const char* type_param,
611 const char* value_param, internal::CodeLocation code_location,
612 internal::TypeId fixture_class_id, internal::SetUpTestSuiteFunc set_up_tc,
613 internal::TearDownTestSuiteFunc tear_down_tc,
614 internal::TestFactoryBase* factory);
615
616 // Constructs a TestInfo object. The newly constructed instance assumes
617 // ownership of the factory object.
618 TestInfo(std::string test_suite_name, std::string name,
619 const char* a_type_param, // NULL if not a type-parameterized test
620 const char* a_value_param, // NULL if not a value-parameterized test
621 internal::CodeLocation a_code_location,
622 internal::TypeId fixture_class_id,
623 internal::TestFactoryBase* factory);
624
625 // Increments the number of death tests encountered in this test so
626 // far.
627 int increment_death_test_count() {
628 return result_.increment_death_test_count();
629 }
630
631 // Creates the test object, runs it, records its result, and then
632 // deletes it.
633 void Run();
634
635 // Skip and records the test result for this object.
636 void Skip();
637
638 static void ClearTestResult(TestInfo* test_info) {
639 test_info->result_.Clear();
640 }
641
642 // These fields are immutable properties of the test.
643 const std::string test_suite_name_; // test suite name
644 const std::string name_; // Test name
645 // Name of the parameter type, or NULL if this is not a typed or a
646 // type-parameterized test.
647 const std::unique_ptr<const ::std::string> type_param_;
648 // Text representation of the value parameter, or NULL if this is not a
649 // value-parameterized test.
650 const std::unique_ptr<const ::std::string> value_param_;
651 internal::CodeLocation location_;
652 const internal::TypeId fixture_class_id_; // ID of the test fixture class
653 bool should_run_; // True if and only if this test should run
654 bool is_disabled_; // True if and only if this test is disabled
655 bool matches_filter_; // True if this test matches the
656 // user-specified filter.
657 bool is_in_another_shard_; // Will be run in another shard.
658 internal::TestFactoryBase* const factory_; // The factory that creates
659 // the test object
660
661 // This field is mutable and needs to be reset before running the
662 // test for the second time.
663 TestResult result_;
664
665 TestInfo(const TestInfo&) = delete;
666 TestInfo& operator=(const TestInfo&) = delete;
667};
668
669// A test suite, which consists of a vector of TestInfos.
670//
671// TestSuite is not copyable.
672class GTEST_API___attribute__((visibility("default"))) TestSuite {
673 public:
674 // Creates a TestSuite with the given name.
675 //
676 // TestSuite does NOT have a default constructor. Always use this
677 // constructor to create a TestSuite object.
678 //
679 // Arguments:
680 //
681 // name: name of the test suite
682 // a_type_param: the name of the test's type parameter, or NULL if
683 // this is not a type-parameterized test.
684 // set_up_tc: pointer to the function that sets up the test suite
685 // tear_down_tc: pointer to the function that tears down the test suite
686 TestSuite(const std::string& name, const char* a_type_param,
687 internal::SetUpTestSuiteFunc set_up_tc,
688 internal::TearDownTestSuiteFunc tear_down_tc);
689
690 // Destructor of TestSuite.
691 virtual ~TestSuite();
692
693 // Gets the name of the TestSuite.
694 const char* name() const { return name_.c_str(); }
695
696 // Returns the name of the parameter type, or NULL if this is not a
697 // type-parameterized test suite.
698 const char* type_param() const {
699 if (type_param_ != nullptr) return type_param_->c_str();
700 return nullptr;
701 }
702
703 // Returns true if any test in this test suite should run.
704 bool should_run() const { return should_run_; }
705
706 // Gets the number of successful tests in this test suite.
707 int successful_test_count() const;
708
709 // Gets the number of skipped tests in this test suite.
710 int skipped_test_count() const;
711
712 // Gets the number of failed tests in this test suite.
713 int failed_test_count() const;
714
715 // Gets the number of disabled tests that will be reported in the XML report.
716 int reportable_disabled_test_count() const;
717
718 // Gets the number of disabled tests in this test suite.
719 int disabled_test_count() const;
720
721 // Gets the number of tests to be printed in the XML report.
722 int reportable_test_count() const;
723
724 // Get the number of tests in this test suite that should run.
725 int test_to_run_count() const;
726
727 // Gets the number of all tests in this test suite.
728 int total_test_count() const;
729
730 // Returns true if and only if the test suite passed.
731 bool Passed() const { return !Failed(); }
732
733 // Returns true if and only if the test suite failed.
734 bool Failed() const {
735 return failed_test_count() > 0 || ad_hoc_test_result().Failed();
736 }
737
738 // Returns the elapsed time, in milliseconds.
739 TimeInMillis elapsed_time() const { return elapsed_time_; }
740
741 // Gets the time of the test suite start, in ms from the start of the
742 // UNIX epoch.
743 TimeInMillis start_timestamp() const { return start_timestamp_; }
744
745 // Returns the i-th test among all the tests. i can range from 0 to
746 // total_test_count() - 1. If i is not in that range, returns NULL.
747 const TestInfo* GetTestInfo(int i) const;
748
749 // Returns the TestResult that holds test properties recorded during
750 // execution of SetUpTestSuite and TearDownTestSuite.
751 const TestResult& ad_hoc_test_result() const { return ad_hoc_test_result_; }
752
753 private:
754 friend class Test;
755 friend class internal::UnitTestImpl;
756
757 // Gets the (mutable) vector of TestInfos in this TestSuite.
758 std::vector<TestInfo*>& test_info_list() { return test_info_list_; }
759
760 // Gets the (immutable) vector of TestInfos in this TestSuite.
761 const std::vector<TestInfo*>& test_info_list() const {
762 return test_info_list_;
763 }
764
765 // Returns the i-th test among all the tests. i can range from 0 to
766 // total_test_count() - 1. If i is not in that range, returns NULL.
767 TestInfo* GetMutableTestInfo(int i);
768
769 // Sets the should_run member.
770 void set_should_run(bool should) { should_run_ = should; }
771
772 // Adds a TestInfo to this test suite. Will delete the TestInfo upon
773 // destruction of the TestSuite object.
774 void AddTestInfo(TestInfo* test_info);
775
776 // Clears the results of all tests in this test suite.
777 void ClearResult();
778
779 // Clears the results of all tests in the given test suite.
780 static void ClearTestSuiteResult(TestSuite* test_suite) {
781 test_suite->ClearResult();
782 }
783
784 // Runs every test in this TestSuite.
785 void Run();
786
787 // Skips the execution of tests under this TestSuite
788 void Skip();
789
790 // Runs SetUpTestSuite() for this TestSuite. This wrapper is needed
791 // for catching exceptions thrown from SetUpTestSuite().
792 void RunSetUpTestSuite() {
793 if (set_up_tc_ != nullptr) {
794 (*set_up_tc_)();
795 }
796 }
797
798 // Runs TearDownTestSuite() for this TestSuite. This wrapper is
799 // needed for catching exceptions thrown from TearDownTestSuite().
800 void RunTearDownTestSuite() {
801 if (tear_down_tc_ != nullptr) {
802 (*tear_down_tc_)();
803 }
804 }
805
806 // Returns true if and only if test passed.
807 static bool TestPassed(const TestInfo* test_info) {
808 return test_info->should_run() && test_info->result()->Passed();
809 }
810
811 // Returns true if and only if test skipped.
812 static bool TestSkipped(const TestInfo* test_info) {
813 return test_info->should_run() && test_info->result()->Skipped();
814 }
815
816 // Returns true if and only if test failed.
817 static bool TestFailed(const TestInfo* test_info) {
818 return test_info->should_run() && test_info->result()->Failed();
819 }
820
821 // Returns true if and only if the test is disabled and will be reported in
822 // the XML report.
823 static bool TestReportableDisabled(const TestInfo* test_info) {
824 return test_info->is_reportable() && test_info->is_disabled_;
825 }
826
827 // Returns true if and only if test is disabled.
828 static bool TestDisabled(const TestInfo* test_info) {
829 return test_info->is_disabled_;
830 }
831
832 // Returns true if and only if this test will appear in the XML report.
833 static bool TestReportable(const TestInfo* test_info) {
834 return test_info->is_reportable();
835 }
836
837 // Returns true if the given test should run.
838 static bool ShouldRunTest(const TestInfo* test_info) {
839 return test_info->should_run();
840 }
841
842 // Shuffles the tests in this test suite.
843 void ShuffleTests(internal::Random* random);
844
845 // Restores the test order to before the first shuffle.
846 void UnshuffleTests();
847
848 // Name of the test suite.
849 std::string name_;
850 // Name of the parameter type, or NULL if this is not a typed or a
851 // type-parameterized test.
852 const std::unique_ptr<const ::std::string> type_param_;
853 // The vector of TestInfos in their original order. It owns the
854 // elements in the vector.
855 std::vector<TestInfo*> test_info_list_;
856 // Provides a level of indirection for the test list to allow easy
857 // shuffling and restoring the test order. The i-th element in this
858 // vector is the index of the i-th test in the shuffled test list.
859 std::vector<int> test_indices_;
860 // Pointer to the function that sets up the test suite.
861 internal::SetUpTestSuiteFunc set_up_tc_;
862 // Pointer to the function that tears down the test suite.
863 internal::TearDownTestSuiteFunc tear_down_tc_;
864 // True if and only if any test in this test suite should run.
865 bool should_run_;
866 // The start time, in milliseconds since UNIX Epoch.
867 TimeInMillis start_timestamp_;
868 // Elapsed time, in milliseconds.
869 TimeInMillis elapsed_time_;
870 // Holds test properties recorded during execution of SetUpTestSuite and
871 // TearDownTestSuite.
872 TestResult ad_hoc_test_result_;
873
874 // We disallow copying TestSuites.
875 TestSuite(const TestSuite&) = delete;
876 TestSuite& operator=(const TestSuite&) = delete;
877};
878
879// An Environment object is capable of setting up and tearing down an
880// environment. You should subclass this to define your own
881// environment(s).
882//
883// An Environment object does the set-up and tear-down in virtual
884// methods SetUp() and TearDown() instead of the constructor and the
885// destructor, as:
886//
887// 1. You cannot safely throw from a destructor. This is a problem
888// as in some cases Google Test is used where exceptions are enabled, and
889// we may want to implement ASSERT_* using exceptions where they are
890// available.
891// 2. You cannot use ASSERT_* directly in a constructor or
892// destructor.
893class Environment {
894 public:
895 // The d'tor is virtual as we need to subclass Environment.
896 virtual ~Environment() = default;
897
898 // Override this to define how to set up the environment.
899 virtual void SetUp() {}
900
901 // Override this to define how to tear down the environment.
902 virtual void TearDown() {}
903
904 private:
905 // If you see an error about overriding the following function or
906 // about it being private, you have mis-spelled SetUp() as Setup().
907 struct Setup_should_be_spelled_SetUp {};
908 virtual Setup_should_be_spelled_SetUp* Setup() { return nullptr; }
909};
910
911#if GTEST_HAS_EXCEPTIONS1
912
913// Exception which can be thrown from TestEventListener::OnTestPartResult.
914class GTEST_API___attribute__((visibility("default"))) AssertionException
915 : public internal::GoogleTestFailureException {
916 public:
917 explicit AssertionException(const TestPartResult& result)
918 : GoogleTestFailureException(result) {}
919};
920
921#endif // GTEST_HAS_EXCEPTIONS
922
923// The interface for tracing execution of tests. The methods are organized in
924// the order the corresponding events are fired.
925class TestEventListener {
926 public:
927 virtual ~TestEventListener() = default;
928
929 // Fired before any test activity starts.
930 virtual void OnTestProgramStart(const UnitTest& unit_test) = 0;
931
932 // Fired before each iteration of tests starts. There may be more than
933 // one iteration if GTEST_FLAG(repeat) is set. iteration is the iteration
934 // index, starting from 0.
935 virtual void OnTestIterationStart(const UnitTest& unit_test,
936 int iteration) = 0;
937
938 // Fired before environment set-up for each iteration of tests starts.
939 virtual void OnEnvironmentsSetUpStart(const UnitTest& unit_test) = 0;
940
941 // Fired after environment set-up for each iteration of tests ends.
942 virtual void OnEnvironmentsSetUpEnd(const UnitTest& unit_test) = 0;
943
944 // Fired before the test suite starts.
945 virtual void OnTestSuiteStart(const TestSuite& /*test_suite*/) {}
946
947 // Legacy API is deprecated but still available
948#ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_
949 virtual void OnTestCaseStart(const TestCase& /*test_case*/) {}
950#endif // GTEST_REMOVE_LEGACY_TEST_CASEAPI_
951
952 // Fired before the test starts.
953 virtual void OnTestStart(const TestInfo& test_info) = 0;
954
955 // Fired when a test is disabled
956 virtual void OnTestDisabled(const TestInfo& /*test_info*/) {}
957
958 // Fired after a failed assertion or a SUCCEED() invocation.
959 // If you want to throw an exception from this function to skip to the next
960 // TEST, it must be AssertionException defined above, or inherited from it.
961 virtual void OnTestPartResult(const TestPartResult& test_part_result) = 0;
962
963 // Fired after the test ends.
964 virtual void OnTestEnd(const TestInfo& test_info) = 0;
965
966 // Fired after the test suite ends.
967 virtual void OnTestSuiteEnd(const TestSuite& /*test_suite*/) {}
968
969// Legacy API is deprecated but still available
970#ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_
971 virtual void OnTestCaseEnd(const TestCase& /*test_case*/) {}
972#endif // GTEST_REMOVE_LEGACY_TEST_CASEAPI_
973
974 // Fired before environment tear-down for each iteration of tests starts.
975 virtual void OnEnvironmentsTearDownStart(const UnitTest& unit_test) = 0;
976
977 // Fired after environment tear-down for each iteration of tests ends.
978 virtual void OnEnvironmentsTearDownEnd(const UnitTest& unit_test) = 0;
979
980 // Fired after each iteration of tests finishes.
981 virtual void OnTestIterationEnd(const UnitTest& unit_test, int iteration) = 0;
982
983 // Fired after all test activities have ended.
984 virtual void OnTestProgramEnd(const UnitTest& unit_test) = 0;
985};
986
987// The convenience class for users who need to override just one or two
988// methods and are not concerned that a possible change to a signature of
989// the methods they override will not be caught during the build. For
990// comments about each method please see the definition of TestEventListener
991// above.
992class EmptyTestEventListener : public TestEventListener {
993 public:
994 void OnTestProgramStart(const UnitTest& /*unit_test*/) override {}
995 void OnTestIterationStart(const UnitTest& /*unit_test*/,
996 int /*iteration*/) override {}
997 void OnEnvironmentsSetUpStart(const UnitTest& /*unit_test*/) override {}
998 void OnEnvironmentsSetUpEnd(const UnitTest& /*unit_test*/) override {}
999 void OnTestSuiteStart(const TestSuite& /*test_suite*/) override {}
1000// Legacy API is deprecated but still available
1001#ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_
1002 void OnTestCaseStart(const TestCase& /*test_case*/) override {}
1003#endif // GTEST_REMOVE_LEGACY_TEST_CASEAPI_
1004
1005 void OnTestStart(const TestInfo& /*test_info*/) override {}
1006 void OnTestDisabled(const TestInfo& /*test_info*/) override {}
1007 void OnTestPartResult(const TestPartResult& /*test_part_result*/) override {}
1008 void OnTestEnd(const TestInfo& /*test_info*/) override {}
1009 void OnTestSuiteEnd(const TestSuite& /*test_suite*/) override {}
1010#ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_
1011 void OnTestCaseEnd(const TestCase& /*test_case*/) override {}
1012#endif // GTEST_REMOVE_LEGACY_TEST_CASEAPI_
1013
1014 void OnEnvironmentsTearDownStart(const UnitTest& /*unit_test*/) override {}
1015 void OnEnvironmentsTearDownEnd(const UnitTest& /*unit_test*/) override {}
1016 void OnTestIterationEnd(const UnitTest& /*unit_test*/,
1017 int /*iteration*/) override {}
1018 void OnTestProgramEnd(const UnitTest& /*unit_test*/) override {}
1019};
1020
1021// TestEventListeners lets users add listeners to track events in Google Test.
1022class GTEST_API___attribute__((visibility("default"))) TestEventListeners {
1023 public:
1024 TestEventListeners();
1025 ~TestEventListeners();
1026
1027 // Appends an event listener to the end of the list. Google Test assumes
1028 // the ownership of the listener (i.e. it will delete the listener when
1029 // the test program finishes).
1030 void Append(TestEventListener* listener);
1031
1032 // Removes the given event listener from the list and returns it. It then
1033 // becomes the caller's responsibility to delete the listener. Returns
1034 // NULL if the listener is not found in the list.
1035 TestEventListener* Release(TestEventListener* listener);
1036
1037 // Returns the standard listener responsible for the default console
1038 // output. Can be removed from the listeners list to shut down default
1039 // console output. Note that removing this object from the listener list
1040 // with Release transfers its ownership to the caller and makes this
1041 // function return NULL the next time.
1042 TestEventListener* default_result_printer() const {
1043 return default_result_printer_;
1044 }
1045
1046 // Returns the standard listener responsible for the default XML output
1047 // controlled by the --gtest_output=xml flag. Can be removed from the
1048 // listeners list by users who want to shut down the default XML output
1049 // controlled by this flag and substitute it with custom one. Note that
1050 // removing this object from the listener list with Release transfers its
1051 // ownership to the caller and makes this function return NULL the next
1052 // time.
1053 TestEventListener* default_xml_generator() const {
1054 return default_xml_generator_;
1055 }
1056
1057 // Controls whether events will be forwarded by the repeater to the
1058 // listeners in the list.
1059 void SuppressEventForwarding(bool);
1060
1061 private:
1062 friend class TestSuite;
1063 friend class TestInfo;
1064 friend class internal::DefaultGlobalTestPartResultReporter;
1065 friend class internal::NoExecDeathTest;
1066 friend class internal::TestEventListenersAccessor;
1067 friend class internal::UnitTestImpl;
1068
1069 // Returns repeater that broadcasts the TestEventListener events to all
1070 // subscribers.
1071 TestEventListener* repeater();
1072
1073 // Sets the default_result_printer attribute to the provided listener.
1074 // The listener is also added to the listener list and previous
1075 // default_result_printer is removed from it and deleted. The listener can
1076 // also be NULL in which case it will not be added to the list. Does
1077 // nothing if the previous and the current listener objects are the same.
1078 void SetDefaultResultPrinter(TestEventListener* listener);
1079
1080 // Sets the default_xml_generator attribute to the provided listener. The
1081 // listener is also added to the listener list and previous
1082 // default_xml_generator is removed from it and deleted. The listener can
1083 // also be NULL in which case it will not be added to the list. Does
1084 // nothing if the previous and the current listener objects are the same.
1085 void SetDefaultXmlGenerator(TestEventListener* listener);
1086
1087 // Controls whether events will be forwarded by the repeater to the
1088 // listeners in the list.
1089 bool EventForwardingEnabled() const;
1090
1091 // The actual list of listeners.
1092 internal::TestEventRepeater* repeater_;
1093 // Listener responsible for the standard result output.
1094 TestEventListener* default_result_printer_;
1095 // Listener responsible for the creation of the XML output file.
1096 TestEventListener* default_xml_generator_;
1097
1098 // We disallow copying TestEventListeners.
1099 TestEventListeners(const TestEventListeners&) = delete;
1100 TestEventListeners& operator=(const TestEventListeners&) = delete;
1101};
1102
1103// A UnitTest consists of a vector of TestSuites.
1104//
1105// This is a singleton class. The only instance of UnitTest is
1106// created when UnitTest::GetInstance() is first called. This
1107// instance is never deleted.
1108//
1109// UnitTest is not copyable.
1110//
1111// This class is thread-safe as long as the methods are called
1112// according to their specification.
1113class GTEST_API___attribute__((visibility("default"))) UnitTest {
1114 public:
1115 // Gets the singleton UnitTest object. The first time this method
1116 // is called, a UnitTest object is constructed and returned.
1117 // Consecutive calls will return the same object.
1118 static UnitTest* GetInstance();
1119
1120 // Runs all tests in this UnitTest object and prints the result.
1121 // Returns 0 if successful, or 1 otherwise.
1122 //
1123 // This method can only be called from the main thread.
1124 //
1125 // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1126 int Run() GTEST_MUST_USE_RESULT___attribute__((warn_unused_result));
1127
1128 // Returns the working directory when the first TEST() or TEST_F()
1129 // was executed. The UnitTest object owns the string.
1130 const char* original_working_dir() const;
1131
1132 // Returns the TestSuite object for the test that's currently running,
1133 // or NULL if no test is running.
1134 const TestSuite* current_test_suite() const GTEST_LOCK_EXCLUDED_(mutex_);
1135
1136// Legacy API is still available but deprecated
1137#ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_
1138 const TestCase* current_test_case() const GTEST_LOCK_EXCLUDED_(mutex_);
1139#endif
1140
1141 // Returns the TestInfo object for the test that's currently running,
1142 // or NULL if no test is running.
1143 const TestInfo* current_test_info() const GTEST_LOCK_EXCLUDED_(mutex_);
1144
1145 // Returns the random seed used at the start of the current test run.
1146 int random_seed() const;
1147
1148 // Returns the ParameterizedTestSuiteRegistry object used to keep track of
1149 // value-parameterized tests and instantiate and register them.
1150 //
1151 // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1152 internal::ParameterizedTestSuiteRegistry& parameterized_test_registry()
1153 GTEST_LOCK_EXCLUDED_(mutex_);
1154
1155 // Gets the number of successful test suites.
1156 int successful_test_suite_count() const;
1157
1158 // Gets the number of failed test suites.
1159 int failed_test_suite_count() const;
1160
1161 // Gets the number of all test suites.
1162 int total_test_suite_count() const;
1163
1164 // Gets the number of all test suites that contain at least one test
1165 // that should run.
1166 int test_suite_to_run_count() const;
1167
1168 // Legacy API is deprecated but still available
1169#ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_
1170 int successful_test_case_count() const;
1171 int failed_test_case_count() const;
1172 int total_test_case_count() const;
1173 int test_case_to_run_count() const;
1174#endif // GTEST_REMOVE_LEGACY_TEST_CASEAPI_
1175
1176 // Gets the number of successful tests.
1177 int successful_test_count() const;
1178
1179 // Gets the number of skipped tests.
1180 int skipped_test_count() const;
1181
1182 // Gets the number of failed tests.
1183 int failed_test_count() const;
1184
1185 // Gets the number of disabled tests that will be reported in the XML report.
1186 int reportable_disabled_test_count() const;
1187
1188 // Gets the number of disabled tests.
1189 int disabled_test_count() const;
1190
1191 // Gets the number of tests to be printed in the XML report.
1192 int reportable_test_count() const;
1193
1194 // Gets the number of all tests.
1195 int total_test_count() const;
1196
1197 // Gets the number of tests that should run.
1198 int test_to_run_count() const;
1199
1200 // Gets the time of the test program start, in ms from the start of the
1201 // UNIX epoch.
1202 TimeInMillis start_timestamp() const;
1203
1204 // Gets the elapsed time, in milliseconds.
1205 TimeInMillis elapsed_time() const;
1206
1207 // Returns true if and only if the unit test passed (i.e. all test suites
1208 // passed).
1209 bool Passed() const;
1210
1211 // Returns true if and only if the unit test failed (i.e. some test suite
1212 // failed or something outside of all tests failed).
1213 bool Failed() const;
1214
1215 // Gets the i-th test suite among all the test suites. i can range from 0 to
1216 // total_test_suite_count() - 1. If i is not in that range, returns NULL.
1217 const TestSuite* GetTestSuite(int i) const;
1218
1219// Legacy API is deprecated but still available
1220#ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_
1221 const TestCase* GetTestCase(int i) const;
1222#endif // GTEST_REMOVE_LEGACY_TEST_CASEAPI_
1223
1224 // Returns the TestResult containing information on test failures and
1225 // properties logged outside of individual test suites.
1226 const TestResult& ad_hoc_test_result() const;
1227
1228 // Returns the list of event listeners that can be used to track events
1229 // inside Google Test.
1230 TestEventListeners& listeners();
1231
1232 private:
1233 // Registers and returns a global test environment. When a test
1234 // program is run, all global test environments will be set-up in
1235 // the order they were registered. After all tests in the program
1236 // have finished, all global test environments will be torn-down in
1237 // the *reverse* order they were registered.
1238 //
1239 // The UnitTest object takes ownership of the given environment.
1240 //
1241 // This method can only be called from the main thread.
1242 Environment* AddEnvironment(Environment* env);
1243
1244 // Adds a TestPartResult to the current TestResult object. All
1245 // Google Test assertion macros (e.g. ASSERT_TRUE, EXPECT_EQ, etc)
1246 // eventually call this to report their results. The user code
1247 // should use the assertion macros instead of calling this directly.
1248 void AddTestPartResult(TestPartResult::Type result_type,
1249 const char* file_name, int line_number,
1250 const std::string& message,
1251 const std::string& os_stack_trace)
1252 GTEST_LOCK_EXCLUDED_(mutex_);
1253
1254 // Adds a TestProperty to the current TestResult object when invoked from
1255 // inside a test, to current TestSuite's ad_hoc_test_result_ when invoked
1256 // from SetUpTestSuite or TearDownTestSuite, or to the global property set
1257 // when invoked elsewhere. If the result already contains a property with
1258 // the same key, the value will be updated.
1259 void RecordProperty(const std::string& key, const std::string& value);
1260
1261 // Gets the i-th test suite among all the test suites. i can range from 0 to
1262 // total_test_suite_count() - 1. If i is not in that range, returns NULL.
1263 TestSuite* GetMutableTestSuite(int i);
1264
1265 // Invokes OsStackTrackGetterInterface::UponLeavingGTest. UponLeavingGTest()
1266 // should be called immediately before Google Test calls user code. It saves
1267 // some information about the current stack that CurrentStackTrace() will use
1268 // to find and hide Google Test stack frames.
1269 void UponLeavingGTest();
1270
1271 // Sets the TestSuite object for the test that's currently running.
1272 void set_current_test_suite(TestSuite* a_current_test_suite)
1273 GTEST_LOCK_EXCLUDED_(mutex_);
1274
1275 // Sets the TestInfo object for the test that's currently running.
1276 void set_current_test_info(TestInfo* a_current_test_info)
1277 GTEST_LOCK_EXCLUDED_(mutex_);
1278
1279 // Accessors for the implementation object.
1280 internal::UnitTestImpl* impl() { return impl_; }
1281 const internal::UnitTestImpl* impl() const { return impl_; }
1282
1283 // These classes and functions are friends as they need to access private
1284 // members of UnitTest.
1285 friend class ScopedTrace;
1286 friend class Test;
1287 friend class TestInfo;
1288 friend class TestSuite;
1289 friend class internal::AssertHelper;
1290 friend class internal::StreamingListenerTest;
1291 friend class internal::UnitTestRecordPropertyTestHelper;
1292 friend Environment* AddGlobalTestEnvironment(Environment* env);
1293 friend std::set<std::string>* internal::GetIgnoredParameterizedTestSuites();
1294 friend internal::UnitTestImpl* internal::GetUnitTestImpl();
1295 friend void internal::ReportFailureInUnknownLocation(
1296 TestPartResult::Type result_type, const std::string& message);
1297
1298 // Creates an empty UnitTest.
1299 UnitTest();
1300
1301 // D'tor
1302 virtual ~UnitTest();
1303
1304 // Pushes a trace defined by SCOPED_TRACE() on to the per-thread
1305 // Google Test trace stack.
1306 void PushGTestTrace(const internal::TraceInfo& trace)
1307 GTEST_LOCK_EXCLUDED_(mutex_);
1308
1309 // Pops a trace from the per-thread Google Test trace stack.
1310 void PopGTestTrace() GTEST_LOCK_EXCLUDED_(mutex_);
1311
1312 // Protects mutable state in *impl_. This is mutable as some const
1313 // methods need to lock it too.
1314 mutable internal::Mutex mutex_;
1315
1316 // Opaque implementation object. This field is never changed once
1317 // the object is constructed. We don't mark it as const here, as
1318 // doing so will cause a warning in the constructor of UnitTest.
1319 // Mutable state in *impl_ is protected by mutex_.
1320 internal::UnitTestImpl* impl_;
1321
1322 // We disallow copying UnitTest.
1323 UnitTest(const UnitTest&) = delete;
1324 UnitTest& operator=(const UnitTest&) = delete;
1325};
1326
1327// A convenient wrapper for adding an environment for the test
1328// program.
1329//
1330// You should call this before RUN_ALL_TESTS() is called, probably in
1331// main(). If you use gtest_main, you need to call this before main()
1332// starts for it to take effect. For example, you can define a global
1333// variable like this:
1334//
1335// testing::Environment* const foo_env =
1336// testing::AddGlobalTestEnvironment(new FooEnvironment);
1337//
1338// However, we strongly recommend you to write your own main() and
1339// call AddGlobalTestEnvironment() there, as relying on initialization
1340// of global variables makes the code harder to read and may cause
1341// problems when you register multiple environments from different
1342// translation units and the environments have dependencies among them
1343// (remember that the compiler doesn't guarantee the order in which
1344// global variables from different translation units are initialized).
1345inline Environment* AddGlobalTestEnvironment(Environment* env) {
1346 return UnitTest::GetInstance()->AddEnvironment(env);
1347}
1348
1349// Initializes Google Test. This must be called before calling
1350// RUN_ALL_TESTS(). In particular, it parses a command line for the
1351// flags that Google Test recognizes. Whenever a Google Test flag is
1352// seen, it is removed from argv, and *argc is decremented.
1353//
1354// No value is returned. Instead, the Google Test flag variables are
1355// updated.
1356//
1357// Calling the function for the second time has no user-visible effect.
1358GTEST_API___attribute__((visibility("default"))) void InitGoogleTest(int* argc, char** argv);
1359
1360// This overloaded version can be used in Windows programs compiled in
1361// UNICODE mode.
1362GTEST_API___attribute__((visibility("default"))) void InitGoogleTest(int* argc, wchar_t** argv);
1363
1364// This overloaded version can be used on Arduino/embedded platforms where
1365// there is no argc/argv.
1366GTEST_API___attribute__((visibility("default"))) void InitGoogleTest();
1367
1368namespace internal {
1369
1370// Separate the error generating code from the code path to reduce the stack
1371// frame size of CmpHelperEQ. This helps reduce the overhead of some sanitizers
1372// when calling EXPECT_* in a tight loop.
1373template <typename T1, typename T2>
1374AssertionResult CmpHelperEQFailure(const char* lhs_expression,
1375 const char* rhs_expression, const T1& lhs,
1376 const T2& rhs) {
1377 return EqFailure(lhs_expression, rhs_expression,
1378 FormatForComparisonFailureMessage(lhs, rhs),
1379 FormatForComparisonFailureMessage(rhs, lhs), false);
1380}
1381
1382// This block of code defines operator==/!=
1383// to block lexical scope lookup.
1384// It prevents using invalid operator==/!= defined at namespace scope.
1385struct faketype {};
1386inline bool operator==(faketype, faketype) { return true; }
1387inline bool operator!=(faketype, faketype) { return false; }
1388
1389// The helper function for {ASSERT|EXPECT}_EQ.
1390template <typename T1, typename T2>
1391AssertionResult CmpHelperEQ(const char* lhs_expression,
1392 const char* rhs_expression, const T1& lhs,
1393 const T2& rhs) {
1394 if (lhs == rhs) {
11
The right operand of '==' is a garbage value
1395 return AssertionSuccess();
1396 }
1397
1398 return CmpHelperEQFailure(lhs_expression, rhs_expression, lhs, rhs);
1399}
1400
1401class EqHelper {
1402 public:
1403 // This templatized version is for the general case.
1404 template <
1405 typename T1, typename T2,
1406 // Disable this overload for cases where one argument is a pointer
1407 // and the other is the null pointer constant.
1408 typename std::enable_if<!std::is_integral<T1>::value ||
1409 !std::is_pointer<T2>::value>::type* = nullptr>
1410 static AssertionResult Compare(const char* lhs_expression,
1411 const char* rhs_expression, const T1& lhs,
1412 const T2& rhs) {
1413 return CmpHelperEQ(lhs_expression, rhs_expression, lhs, rhs);
9
Passing 'rhs' via 4th parameter 'rhs'
10
Calling 'CmpHelperEQ<unsigned int, unsigned long>'
1414 }
1415
1416 // With this overloaded version, we allow anonymous enums to be used
1417 // in {ASSERT|EXPECT}_EQ when compiled with gcc 4, as anonymous
1418 // enums can be implicitly cast to BiggestInt.
1419 //
1420 // Even though its body looks the same as the above version, we
1421 // cannot merge the two, as it will make anonymous enums unhappy.
1422 static AssertionResult Compare(const char* lhs_expression,
1423 const char* rhs_expression, BiggestInt lhs,
1424 BiggestInt rhs) {
1425 return CmpHelperEQ(lhs_expression, rhs_expression, lhs, rhs);
1426 }
1427
1428 template <typename T>
1429 static AssertionResult Compare(
1430 const char* lhs_expression, const char* rhs_expression,
1431 // Handle cases where '0' is used as a null pointer literal.
1432 std::nullptr_t /* lhs */, T* rhs) {
1433 // We already know that 'lhs' is a null pointer.
1434 return CmpHelperEQ(lhs_expression, rhs_expression, static_cast<T*>(nullptr),
1435 rhs);
1436 }
1437};
1438
1439// Separate the error generating code from the code path to reduce the stack
1440// frame size of CmpHelperOP. This helps reduce the overhead of some sanitizers
1441// when calling EXPECT_OP in a tight loop.
1442template <typename T1, typename T2>
1443AssertionResult CmpHelperOpFailure(const char* expr1, const char* expr2,
1444 const T1& val1, const T2& val2,
1445 const char* op) {
1446 return AssertionFailure()
1447 << "Expected: (" << expr1 << ") " << op << " (" << expr2
1448 << "), actual: " << FormatForComparisonFailureMessage(val1, val2)
1449 << " vs " << FormatForComparisonFailureMessage(val2, val1);
1450}
1451
1452// A macro for implementing the helper functions needed to implement
1453// ASSERT_?? and EXPECT_??. It is here just to avoid copy-and-paste
1454// of similar code.
1455//
1456// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1457
1458#define GTEST_IMPL_CMP_HELPER_(op_name, op) \
1459 template <typename T1, typename T2> \
1460 AssertionResult CmpHelper##op_name(const char* expr1, const char* expr2, \
1461 const T1& val1, const T2& val2) { \
1462 if (val1 op val2) { \
1463 return AssertionSuccess(); \
1464 } else { \
1465 return CmpHelperOpFailure(expr1, expr2, val1, val2, #op); \
1466 } \
1467 }
1468
1469// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1470
1471// Implements the helper function for {ASSERT|EXPECT}_NE
1472GTEST_IMPL_CMP_HELPER_(NE, !=)
1473// Implements the helper function for {ASSERT|EXPECT}_LE
1474GTEST_IMPL_CMP_HELPER_(LE, <=)
1475// Implements the helper function for {ASSERT|EXPECT}_LT
1476GTEST_IMPL_CMP_HELPER_(LT, <)
1477// Implements the helper function for {ASSERT|EXPECT}_GE
1478GTEST_IMPL_CMP_HELPER_(GE, >=)
1479// Implements the helper function for {ASSERT|EXPECT}_GT
1480GTEST_IMPL_CMP_HELPER_(GT, >)
1481
1482#undef GTEST_IMPL_CMP_HELPER_
1483
1484// The helper function for {ASSERT|EXPECT}_STREQ.
1485//
1486// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1487GTEST_API___attribute__((visibility("default"))) AssertionResult CmpHelperSTREQ(const char* s1_expression,
1488 const char* s2_expression,
1489 const char* s1, const char* s2);
1490
1491// The helper function for {ASSERT|EXPECT}_STRCASEEQ.
1492//
1493// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1494GTEST_API___attribute__((visibility("default"))) AssertionResult CmpHelperSTRCASEEQ(const char* s1_expression,
1495 const char* s2_expression,
1496 const char* s1, const char* s2);
1497
1498// The helper function for {ASSERT|EXPECT}_STRNE.
1499//
1500// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1501GTEST_API___attribute__((visibility("default"))) AssertionResult CmpHelperSTRNE(const char* s1_expression,
1502 const char* s2_expression,
1503 const char* s1, const char* s2);
1504
1505// The helper function for {ASSERT|EXPECT}_STRCASENE.
1506//
1507// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1508GTEST_API___attribute__((visibility("default"))) AssertionResult CmpHelperSTRCASENE(const char* s1_expression,
1509 const char* s2_expression,
1510 const char* s1, const char* s2);
1511
1512// Helper function for *_STREQ on wide strings.
1513//
1514// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1515GTEST_API___attribute__((visibility("default"))) AssertionResult CmpHelperSTREQ(const char* s1_expression,
1516 const char* s2_expression,
1517 const wchar_t* s1, const wchar_t* s2);
1518
1519// Helper function for *_STRNE on wide strings.
1520//
1521// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1522GTEST_API___attribute__((visibility("default"))) AssertionResult CmpHelperSTRNE(const char* s1_expression,
1523 const char* s2_expression,
1524 const wchar_t* s1, const wchar_t* s2);
1525
1526} // namespace internal
1527
1528// IsSubstring() and IsNotSubstring() are intended to be used as the
1529// first argument to {EXPECT,ASSERT}_PRED_FORMAT2(), not by
1530// themselves. They check whether needle is a substring of haystack
1531// (NULL is considered a substring of itself only), and return an
1532// appropriate error message when they fail.
1533//
1534// The {needle,haystack}_expr arguments are the stringified
1535// expressions that generated the two real arguments.
1536GTEST_API___attribute__((visibility("default"))) AssertionResult IsSubstring(const char* needle_expr,
1537 const char* haystack_expr,
1538 const char* needle,
1539 const char* haystack);
1540GTEST_API___attribute__((visibility("default"))) AssertionResult IsSubstring(const char* needle_expr,
1541 const char* haystack_expr,
1542 const wchar_t* needle,
1543 const wchar_t* haystack);
1544GTEST_API___attribute__((visibility("default"))) AssertionResult IsNotSubstring(const char* needle_expr,
1545 const char* haystack_expr,
1546 const char* needle,
1547 const char* haystack);
1548GTEST_API___attribute__((visibility("default"))) AssertionResult IsNotSubstring(const char* needle_expr,
1549 const char* haystack_expr,
1550 const wchar_t* needle,
1551 const wchar_t* haystack);
1552GTEST_API___attribute__((visibility("default"))) AssertionResult IsSubstring(const char* needle_expr,
1553 const char* haystack_expr,
1554 const ::std::string& needle,
1555 const ::std::string& haystack);
1556GTEST_API___attribute__((visibility("default"))) AssertionResult IsNotSubstring(const char* needle_expr,
1557 const char* haystack_expr,
1558 const ::std::string& needle,
1559 const ::std::string& haystack);
1560
1561#if GTEST_HAS_STD_WSTRING1
1562GTEST_API___attribute__((visibility("default"))) AssertionResult IsSubstring(const char* needle_expr,
1563 const char* haystack_expr,
1564 const ::std::wstring& needle,
1565 const ::std::wstring& haystack);
1566GTEST_API___attribute__((visibility("default"))) AssertionResult IsNotSubstring(const char* needle_expr,
1567 const char* haystack_expr,
1568 const ::std::wstring& needle,
1569 const ::std::wstring& haystack);
1570#endif // GTEST_HAS_STD_WSTRING
1571
1572namespace internal {
1573
1574// Helper template function for comparing floating-points.
1575//
1576// Template parameter:
1577//
1578// RawType: the raw floating-point type (either float or double)
1579//
1580// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1581template <typename RawType>
1582AssertionResult CmpHelperFloatingPointEQ(const char* lhs_expression,
1583 const char* rhs_expression,
1584 RawType lhs_value, RawType rhs_value) {
1585 const FloatingPoint<RawType> lhs(lhs_value), rhs(rhs_value);
1586
1587 if (lhs.AlmostEquals(rhs)) {
1588 return AssertionSuccess();
1589 }
1590
1591 ::std::stringstream lhs_ss;
1592 lhs_ss.precision(std::numeric_limits<RawType>::digits10 + 2);
1593 lhs_ss << lhs_value;
1594
1595 ::std::stringstream rhs_ss;
1596 rhs_ss.precision(std::numeric_limits<RawType>::digits10 + 2);
1597 rhs_ss << rhs_value;
1598
1599 return EqFailure(lhs_expression, rhs_expression,
1600 StringStreamToString(&lhs_ss), StringStreamToString(&rhs_ss),
1601 false);
1602}
1603
1604// Helper function for implementing ASSERT_NEAR.
1605//
1606// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1607GTEST_API___attribute__((visibility("default"))) AssertionResult DoubleNearPredFormat(const char* expr1,
1608 const char* expr2,
1609 const char* abs_error_expr,
1610 double val1, double val2,
1611 double abs_error);
1612
1613// INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE.
1614// A class that enables one to stream messages to assertion macros
1615class GTEST_API___attribute__((visibility("default"))) AssertHelper {
1616 public:
1617 // Constructor.
1618 AssertHelper(TestPartResult::Type type, const char* file, int line,
1619 const char* message);
1620 ~AssertHelper();
1621
1622 // Message assignment is a semantic trick to enable assertion
1623 // streaming; see the GTEST_MESSAGE_ macro below.
1624 void operator=(const Message& message) const;
1625
1626 private:
1627 // We put our data in a struct so that the size of the AssertHelper class can
1628 // be as small as possible. This is important because gcc is incapable of
1629 // re-using stack space even for temporary variables, so every EXPECT_EQ
1630 // reserves stack space for another AssertHelper.
1631 struct AssertHelperData {
1632 AssertHelperData(TestPartResult::Type t, const char* srcfile, int line_num,
1633 const char* msg)
1634 : type(t), file(srcfile), line(line_num), message(msg) {}
1635
1636 TestPartResult::Type const type;
1637 const char* const file;
1638 int const line;
1639 std::string const message;
1640
1641 private:
1642 AssertHelperData(const AssertHelperData&) = delete;
1643 AssertHelperData& operator=(const AssertHelperData&) = delete;
1644 };
1645
1646 AssertHelperData* const data_;
1647
1648 AssertHelper(const AssertHelper&) = delete;
1649 AssertHelper& operator=(const AssertHelper&) = delete;
1650};
1651
1652} // namespace internal
1653
1654// The pure interface class that all value-parameterized tests inherit from.
1655// A value-parameterized class must inherit from both ::testing::Test and
1656// ::testing::WithParamInterface. In most cases that just means inheriting
1657// from ::testing::TestWithParam, but more complicated test hierarchies
1658// may need to inherit from Test and WithParamInterface at different levels.
1659//
1660// This interface has support for accessing the test parameter value via
1661// the GetParam() method.
1662//
1663// Use it with one of the parameter generator defining functions, like Range(),
1664// Values(), ValuesIn(), Bool(), Combine(), and ConvertGenerator<T>().
1665//
1666// class FooTest : public ::testing::TestWithParam<int> {
1667// protected:
1668// FooTest() {
1669// // Can use GetParam() here.
1670// }
1671// ~FooTest() override {
1672// // Can use GetParam() here.
1673// }
1674// void SetUp() override {
1675// // Can use GetParam() here.
1676// }
1677// void TearDown override {
1678// // Can use GetParam() here.
1679// }
1680// };
1681// TEST_P(FooTest, DoesBar) {
1682// // Can use GetParam() method here.
1683// Foo foo;
1684// ASSERT_TRUE(foo.DoesBar(GetParam()));
1685// }
1686// INSTANTIATE_TEST_SUITE_P(OneToTenRange, FooTest, ::testing::Range(1, 10));
1687
1688template <typename T>
1689class WithParamInterface {
1690 public:
1691 typedef T ParamType;
1692 virtual ~WithParamInterface() = default;
1693
1694 // The current parameter value. Is also available in the test fixture's
1695 // constructor.
1696 static const ParamType& GetParam() {
1697 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"
, 1697) .GetStream() << "Condition " "parameter_ != nullptr"
" failed. "
1698 << "GetParam() can only be called inside a value-parameterized test "
1699 << "-- did you intend to write TEST_P instead of TEST_F?";
1700 return *parameter_;
1701 }
1702
1703 private:
1704 // Sets parameter value. The caller is responsible for making sure the value
1705 // remains alive and unchanged throughout the current test.
1706 static void SetParam(const ParamType* parameter) { parameter_ = parameter; }
1707
1708 // Static value used for accessing parameter during a test lifetime.
1709 static const ParamType* parameter_;
1710
1711 // TestClass must be a subclass of WithParamInterface<T> and Test.
1712 template <class TestClass>
1713 friend class internal::ParameterizedTestFactory;
1714};
1715
1716template <typename T>
1717const T* WithParamInterface<T>::parameter_ = nullptr;
1718
1719// Most value-parameterized classes can ignore the existence of
1720// WithParamInterface, and can just inherit from ::testing::TestWithParam.
1721
1722template <typename T>
1723class TestWithParam : public Test, public WithParamInterface<T> {};
1724
1725// Macros for indicating success/failure in test code.
1726
1727// Skips test in runtime.
1728// Skipping test aborts current function.
1729// Skipped tests are neither successful nor failed.
1730#define GTEST_SKIP()return ::testing::internal::AssertHelper(::testing::TestPartResult
::kSkip, "/usr/src/googletest/googletest/include/gtest/gtest.h"
, 1730, "") = ::testing::Message()
GTEST_SKIP_("")return ::testing::internal::AssertHelper(::testing::TestPartResult
::kSkip, "/usr/src/googletest/googletest/include/gtest/gtest.h"
, 1730, "") = ::testing::Message()
1731
1732// ADD_FAILURE unconditionally adds a failure to the current test.
1733// SUCCEED generates a success - it doesn't automatically make the
1734// current test successful, as a test is only successful when it has
1735// no failure.
1736//
1737// EXPECT_* verifies that a certain condition is satisfied. If not,
1738// it behaves like ADD_FAILURE. In particular:
1739//
1740// EXPECT_TRUE verifies that a Boolean condition is true.
1741// EXPECT_FALSE verifies that a Boolean condition is false.
1742//
1743// FAIL and ASSERT_* are similar to ADD_FAILURE and EXPECT_*, except
1744// that they will also abort the current function on failure. People
1745// usually want the fail-fast behavior of FAIL and ASSERT_*, but those
1746// writing data-driven tests often find themselves using ADD_FAILURE
1747// and EXPECT_* more.
1748
1749// Generates a nonfatal failure with a generic message.
1750#define ADD_FAILURE()::testing::internal::AssertHelper(::testing::TestPartResult::
kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h"
, 1750, "Failed") = ::testing::Message()
GTEST_NONFATAL_FAILURE_("Failed")::testing::internal::AssertHelper(::testing::TestPartResult::
kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h"
, 1750, "Failed") = ::testing::Message()
1751
1752// Generates a nonfatal failure at the given source file location with
1753// a generic message.
1754#define ADD_FAILURE_AT(file, line)::testing::internal::AssertHelper(::testing::TestPartResult::
kNonFatalFailure, file, line, "Failed") = ::testing::Message(
)
\
1755 GTEST_MESSAGE_AT_(file, line, "Failed", \::testing::internal::AssertHelper(::testing::TestPartResult::
kNonFatalFailure, file, line, "Failed") = ::testing::Message(
)
1756 ::testing::TestPartResult::kNonFatalFailure)::testing::internal::AssertHelper(::testing::TestPartResult::
kNonFatalFailure, file, line, "Failed") = ::testing::Message(
)
1757
1758// Generates a fatal failure with a generic message.
1759#define GTEST_FAIL()return ::testing::internal::AssertHelper(::testing::TestPartResult
::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h"
, 1759, "Failed") = ::testing::Message()
GTEST_FATAL_FAILURE_("Failed")return ::testing::internal::AssertHelper(::testing::TestPartResult
::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h"
, 1759, "Failed") = ::testing::Message()
1760
1761// Like GTEST_FAIL(), but at the given source file location.
1762#define GTEST_FAIL_AT(file, line)return ::testing::internal::AssertHelper(::testing::TestPartResult
::kFatalFailure, file, line, "Failed") = ::testing::Message()
\
1763 return GTEST_MESSAGE_AT_(file, line, "Failed", \::testing::internal::AssertHelper(::testing::TestPartResult::
kFatalFailure, file, line, "Failed") = ::testing::Message()
1764 ::testing::TestPartResult::kFatalFailure)::testing::internal::AssertHelper(::testing::TestPartResult::
kFatalFailure, file, line, "Failed") = ::testing::Message()
1765
1766// Define this macro to 1 to omit the definition of FAIL(), which is a
1767// generic name and clashes with some other libraries.
1768#if !(defined(GTEST_DONT_DEFINE_FAIL) && GTEST_DONT_DEFINE_FAIL)
1769#define FAIL()return ::testing::internal::AssertHelper(::testing::TestPartResult
::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h"
, 1769, "Failed") = ::testing::Message()
GTEST_FAIL()return ::testing::internal::AssertHelper(::testing::TestPartResult
::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h"
, 1769, "Failed") = ::testing::Message()
1770#define FAIL_AT(file, line)return ::testing::internal::AssertHelper(::testing::TestPartResult
::kFatalFailure, file, line, "Failed") = ::testing::Message()
GTEST_FAIL_AT(file, line)return ::testing::internal::AssertHelper(::testing::TestPartResult
::kFatalFailure, file, line, "Failed") = ::testing::Message()
1771#endif
1772
1773// Generates a success with a generic message.
1774#define GTEST_SUCCEED()::testing::internal::AssertHelper(::testing::TestPartResult::
kSuccess, "/usr/src/googletest/googletest/include/gtest/gtest.h"
, 1774, "Succeeded") = ::testing::Message()
GTEST_SUCCESS_("Succeeded")::testing::internal::AssertHelper(::testing::TestPartResult::
kSuccess, "/usr/src/googletest/googletest/include/gtest/gtest.h"
, 1774, "Succeeded") = ::testing::Message()
1775
1776// Define this macro to 1 to omit the definition of SUCCEED(), which
1777// is a generic name and clashes with some other libraries.
1778#if !(defined(GTEST_DONT_DEFINE_SUCCEED) && GTEST_DONT_DEFINE_SUCCEED)
1779#define SUCCEED()::testing::internal::AssertHelper(::testing::TestPartResult::
kSuccess, "/usr/src/googletest/googletest/include/gtest/gtest.h"
, 1779, "Succeeded") = ::testing::Message()
GTEST_SUCCEED()::testing::internal::AssertHelper(::testing::TestPartResult::
kSuccess, "/usr/src/googletest/googletest/include/gtest/gtest.h"
, 1779, "Succeeded") = ::testing::Message()
1780#endif
1781
1782// Macros for testing exceptions.
1783//
1784// * {ASSERT|EXPECT}_THROW(statement, expected_exception):
1785// Tests that the statement throws the expected exception.
1786// * {ASSERT|EXPECT}_NO_THROW(statement):
1787// Tests that the statement doesn't throw any exception.
1788// * {ASSERT|EXPECT}_ANY_THROW(statement):
1789// Tests that the statement throws an exception.
1790
1791#define EXPECT_THROW(statement, expected_exception)switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { bool gtest_caught_expected = false; try { if (
::testing::internal::AlwaysTrue()) { statement; } else static_assert
(true, ""); } catch (expected_exception const&) { gtest_caught_expected
= true; } catch (typename std::conditional< std::is_same<
typename std::remove_cv<typename std::remove_reference<
expected_exception>::type>::type, std::exception>::
value, const ::testing::internal::NeverThrown&, const std
::exception&>::type e) { gtest_msg.value = "Expected: "
"statement" " throws an exception of type " "expected_exception"
".\n Actual: it throws "; gtest_msg.value += ::testing::internal
::GetTypeName(typeid(e)); gtest_msg.value += " with description \""
; gtest_msg.value += e.what(); gtest_msg.value += "\"."; goto
gtest_label_testthrow_1791; } catch (...) { gtest_msg.value =
"Expected: " "statement" " throws an exception of type " "expected_exception"
".\n Actual: it throws a different type."; goto gtest_label_testthrow_1791
; } 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_1791
; } } else gtest_label_testthrow_1791 : ::testing::internal::
AssertHelper(::testing::TestPartResult::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h"
, 1791, gtest_msg.value.c_str()) = ::testing::Message()
\
1792 GTEST_TEST_THROW_(statement, expected_exception, GTEST_NONFATAL_FAILURE_)switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { bool gtest_caught_expected = false; try { if (
::testing::internal::AlwaysTrue()) { statement; } else static_assert
(true, ""); } catch (expected_exception const&) { gtest_caught_expected
= true; } catch (typename std::conditional< std::is_same<
typename std::remove_cv<typename std::remove_reference<
expected_exception>::type>::type, std::exception>::
value, const ::testing::internal::NeverThrown&, const std
::exception&>::type e) { gtest_msg.value = "Expected: "
"statement" " throws an exception of type " "expected_exception"
".\n Actual: it throws "; gtest_msg.value += ::testing::internal
::GetTypeName(typeid(e)); gtest_msg.value += " with description \""
; gtest_msg.value += e.what(); gtest_msg.value += "\"."; goto
gtest_label_testthrow_1792; } catch (...) { gtest_msg.value =
"Expected: " "statement" " throws an exception of type " "expected_exception"
".\n Actual: it throws a different type."; goto gtest_label_testthrow_1792
; } 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_1792
; } } else gtest_label_testthrow_1792 : ::testing::internal::
AssertHelper(::testing::TestPartResult::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h"
, 1792, gtest_msg.value.c_str()) = ::testing::Message()
1793#define EXPECT_NO_THROW(statement)switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { try { if (::testing::internal::AlwaysTrue()) {
statement; } else static_assert(true, ""); } catch (std::exception
const& e) { gtest_msg.value = "it throws "; gtest_msg.value
+= ::testing::internal::GetTypeName(typeid(e)); gtest_msg.value
+= " with description \""; gtest_msg.value += e.what(); gtest_msg
.value += "\"."; goto gtest_label_testnothrow_1793; } catch (
...) { gtest_msg.value = "it throws."; goto gtest_label_testnothrow_1793
; } } else gtest_label_testnothrow_1793 : ::testing::internal
::AssertHelper(::testing::TestPartResult::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h"
, 1793, ("Expected: " "statement" " doesn't throw an exception.\n"
" Actual: " + gtest_msg.value) .c_str()) = ::testing::Message
()
\
1794 GTEST_TEST_NO_THROW_(statement, GTEST_NONFATAL_FAILURE_)switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { try { if (::testing::internal::AlwaysTrue()) {
statement; } else static_assert(true, ""); } catch (std::exception
const& e) { gtest_msg.value = "it throws "; gtest_msg.value
+= ::testing::internal::GetTypeName(typeid(e)); gtest_msg.value
+= " with description \""; gtest_msg.value += e.what(); gtest_msg
.value += "\"."; goto gtest_label_testnothrow_1794; } catch (
...) { gtest_msg.value = "it throws."; goto gtest_label_testnothrow_1794
; } } else gtest_label_testnothrow_1794 : ::testing::internal
::AssertHelper(::testing::TestPartResult::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h"
, 1794, ("Expected: " "statement" " doesn't throw an exception.\n"
" Actual: " + gtest_msg.value) .c_str()) = ::testing::Message
()
1795#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; } else static_assert(true, ""); }
catch (...) { gtest_caught_any = true; } if (!gtest_caught_any
) { goto gtest_label_testanythrow_1795; } } else gtest_label_testanythrow_1795
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h"
, 1795, "Expected: " "statement" " throws an exception.\n" " Actual: it doesn't."
) = ::testing::Message()
\
1796 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; } else static_assert(true, ""); }
catch (...) { gtest_caught_any = true; } if (!gtest_caught_any
) { goto gtest_label_testanythrow_1796; } } else gtest_label_testanythrow_1796
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h"
, 1796, "Expected: " "statement" " throws an exception.\n" " Actual: it doesn't."
) = ::testing::Message()
1797#define ASSERT_THROW(statement, expected_exception)switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { bool gtest_caught_expected = false; try { if (
::testing::internal::AlwaysTrue()) { statement; } else static_assert
(true, ""); } catch (expected_exception const&) { gtest_caught_expected
= true; } catch (typename std::conditional< std::is_same<
typename std::remove_cv<typename std::remove_reference<
expected_exception>::type>::type, std::exception>::
value, const ::testing::internal::NeverThrown&, const std
::exception&>::type e) { gtest_msg.value = "Expected: "
"statement" " throws an exception of type " "expected_exception"
".\n Actual: it throws "; gtest_msg.value += ::testing::internal
::GetTypeName(typeid(e)); gtest_msg.value += " with description \""
; gtest_msg.value += e.what(); gtest_msg.value += "\"."; goto
gtest_label_testthrow_1797; } catch (...) { gtest_msg.value =
"Expected: " "statement" " throws an exception of type " "expected_exception"
".\n Actual: it throws a different type."; goto gtest_label_testthrow_1797
; } 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_1797
; } } else gtest_label_testthrow_1797 : return ::testing::internal
::AssertHelper(::testing::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h"
, 1797, gtest_msg.value.c_str()) = ::testing::Message()
\
1798 GTEST_TEST_THROW_(statement, expected_exception, GTEST_FATAL_FAILURE_)switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { bool gtest_caught_expected = false; try { if (
::testing::internal::AlwaysTrue()) { statement; } else static_assert
(true, ""); } catch (expected_exception const&) { gtest_caught_expected
= true; } catch (typename std::conditional< std::is_same<
typename std::remove_cv<typename std::remove_reference<
expected_exception>::type>::type, std::exception>::
value, const ::testing::internal::NeverThrown&, const std
::exception&>::type e) { gtest_msg.value = "Expected: "
"statement" " throws an exception of type " "expected_exception"
".\n Actual: it throws "; gtest_msg.value += ::testing::internal
::GetTypeName(typeid(e)); gtest_msg.value += " with description \""
; gtest_msg.value += e.what(); gtest_msg.value += "\"."; goto
gtest_label_testthrow_1798; } catch (...) { gtest_msg.value =
"Expected: " "statement" " throws an exception of type " "expected_exception"
".\n Actual: it throws a different type."; goto gtest_label_testthrow_1798
; } 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_1798
; } } else gtest_label_testthrow_1798 : return ::testing::internal
::AssertHelper(::testing::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h"
, 1798, gtest_msg.value.c_str()) = ::testing::Message()
1799#define ASSERT_NO_THROW(statement)switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { try { if (::testing::internal::AlwaysTrue()) {
statement; } else static_assert(true, ""); } catch (std::exception
const& e) { gtest_msg.value = "it throws "; gtest_msg.value
+= ::testing::internal::GetTypeName(typeid(e)); gtest_msg.value
+= " with description \""; gtest_msg.value += e.what(); gtest_msg
.value += "\"."; goto gtest_label_testnothrow_1799; } catch (
...) { gtest_msg.value = "it throws."; goto gtest_label_testnothrow_1799
; } } else gtest_label_testnothrow_1799 : return ::testing::internal
::AssertHelper(::testing::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h"
, 1799, ("Expected: " "statement" " doesn't throw an exception.\n"
" Actual: " + gtest_msg.value) .c_str()) = ::testing::Message
()
\
1800 GTEST_TEST_NO_THROW_(statement, GTEST_FATAL_FAILURE_)switch (0) case 0: default: if (::testing::internal::TrueWithString
gtest_msg{}) { try { if (::testing::internal::AlwaysTrue()) {
statement; } else static_assert(true, ""); } catch (std::exception
const& e) { gtest_msg.value = "it throws "; gtest_msg.value
+= ::testing::internal::GetTypeName(typeid(e)); gtest_msg.value
+= " with description \""; gtest_msg.value += e.what(); gtest_msg
.value += "\"."; goto gtest_label_testnothrow_1800; } catch (
...) { gtest_msg.value = "it throws."; goto gtest_label_testnothrow_1800
; } } else gtest_label_testnothrow_1800 : return ::testing::internal
::AssertHelper(::testing::TestPartResult::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h"
, 1800, ("Expected: " "statement" " doesn't throw an exception.\n"
" Actual: " + gtest_msg.value) .c_str()) = ::testing::Message
()
1801#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; } else static_assert(true, ""); }
catch (...) { gtest_caught_any = true; } if (!gtest_caught_any
) { goto gtest_label_testanythrow_1801; } } else gtest_label_testanythrow_1801
: return ::testing::internal::AssertHelper(::testing::TestPartResult
::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h"
, 1801, "Expected: " "statement" " throws an exception.\n" " Actual: it doesn't."
) = ::testing::Message()
\
1802 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; } else static_assert(true, ""); }
catch (...) { gtest_caught_any = true; } if (!gtest_caught_any
) { goto gtest_label_testanythrow_1802; } } else gtest_label_testanythrow_1802
: return ::testing::internal::AssertHelper(::testing::TestPartResult
::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h"
, 1802, "Expected: " "statement" " throws an exception.\n" " Actual: it doesn't."
) = ::testing::Message()
1803
1804// Boolean assertions. Condition can be either a Boolean expression or an
1805// AssertionResult. For more information on how to use AssertionResult with
1806// these macros see comments on that class.
1807#define GTEST_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", 1807
, ::testing::internal::GetBoolAssertionFailureMessage( gtest_ar_
, "condition", "false", "true") .c_str()) = ::testing::Message
()
\
1808 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", 1809
, ::testing::internal::GetBoolAssertionFailureMessage( gtest_ar_
, #condition, "false", "true") .c_str()) = ::testing::Message
()
1809 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", 1809
, ::testing::internal::GetBoolAssertionFailureMessage( gtest_ar_
, #condition, "false", "true") .c_str()) = ::testing::Message
()
1810#define GTEST_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"
, 1810, ::testing::internal::GetBoolAssertionFailureMessage( gtest_ar_
, "condition", "true", "false") .c_str()) = ::testing::Message
()
\
1811 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"
, 1812, ::testing::internal::GetBoolAssertionFailureMessage( gtest_ar_
, #condition, "true", "false") .c_str()) = ::testing::Message
()
1812 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"
, 1812, ::testing::internal::GetBoolAssertionFailureMessage( gtest_ar_
, #condition, "true", "false") .c_str()) = ::testing::Message
()
1813#define GTEST_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"
, 1813, ::testing::internal::GetBoolAssertionFailureMessage( gtest_ar_
, "condition", "false", "true") .c_str()) = ::testing::Message
()
\
1814 GTEST_TEST_BOOLEAN_(condition, #condition, false, true, 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"
, 1814, ::testing::internal::GetBoolAssertionFailureMessage( gtest_ar_
, #condition, "false", "true") .c_str()) = ::testing::Message
()
1815#define GTEST_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"
, 1815, ::testing::internal::GetBoolAssertionFailureMessage( gtest_ar_
, "condition", "true", "false") .c_str()) = ::testing::Message
()
\
1816 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"
, 1817, ::testing::internal::GetBoolAssertionFailureMessage( gtest_ar_
, #condition, "true", "false") .c_str()) = ::testing::Message
()
1817 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"
, 1817, ::testing::internal::GetBoolAssertionFailureMessage( gtest_ar_
, #condition, "true", "false") .c_str()) = ::testing::Message
()
1818
1819// Define these macros to 1 to omit the definition of the corresponding
1820// EXPECT or ASSERT, which clashes with some users' own code.
1821
1822#if !(defined(GTEST_DONT_DEFINE_EXPECT_TRUE) && GTEST_DONT_DEFINE_EXPECT_TRUE)
1823#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", 1823
, ::testing::internal::GetBoolAssertionFailureMessage( gtest_ar_
, "condition", "false", "true") .c_str()) = ::testing::Message
()
GTEST_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", 1823
, ::testing::internal::GetBoolAssertionFailureMessage( gtest_ar_
, "condition", "false", "true") .c_str()) = ::testing::Message
()
1824#endif
1825
1826#if !(defined(GTEST_DONT_DEFINE_EXPECT_FALSE) && GTEST_DONT_DEFINE_EXPECT_FALSE)
1827#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"
, 1827, ::testing::internal::GetBoolAssertionFailureMessage( gtest_ar_
, "condition", "true", "false") .c_str()) = ::testing::Message
()
GTEST_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"
, 1827, ::testing::internal::GetBoolAssertionFailureMessage( gtest_ar_
, "condition", "true", "false") .c_str()) = ::testing::Message
()
1828#endif
1829
1830#if !(defined(GTEST_DONT_DEFINE_ASSERT_TRUE) && GTEST_DONT_DEFINE_ASSERT_TRUE)
1831#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"
, 1831, ::testing::internal::GetBoolAssertionFailureMessage( gtest_ar_
, "condition", "false", "true") .c_str()) = ::testing::Message
()
GTEST_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"
, 1831, ::testing::internal::GetBoolAssertionFailureMessage( gtest_ar_
, "condition", "false", "true") .c_str()) = ::testing::Message
()
1832#endif
1833
1834#if !(defined(GTEST_DONT_DEFINE_ASSERT_FALSE) && GTEST_DONT_DEFINE_ASSERT_FALSE)
1835#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"
, 1835, ::testing::internal::GetBoolAssertionFailureMessage( gtest_ar_
, "condition", "true", "false") .c_str()) = ::testing::Message
()
GTEST_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"
, 1835, ::testing::internal::GetBoolAssertionFailureMessage( gtest_ar_
, "condition", "true", "false") .c_str()) = ::testing::Message
()
1836#endif
1837
1838// Macros for testing equalities and inequalities.
1839//
1840// * {ASSERT|EXPECT}_EQ(v1, v2): Tests that v1 == v2
1841// * {ASSERT|EXPECT}_NE(v1, v2): Tests that v1 != v2
1842// * {ASSERT|EXPECT}_LT(v1, v2): Tests that v1 < v2
1843// * {ASSERT|EXPECT}_LE(v1, v2): Tests that v1 <= v2
1844// * {ASSERT|EXPECT}_GT(v1, v2): Tests that v1 > v2
1845// * {ASSERT|EXPECT}_GE(v1, v2): Tests that v1 >= v2
1846//
1847// When they are not, Google Test prints both the tested expressions and
1848// their actual values. The values must be compatible built-in types,
1849// or you will get a compiler error. By "compatible" we mean that the
1850// values can be compared by the respective operator.
1851//
1852// Note:
1853//
1854// 1. It is possible to make a user-defined type work with
1855// {ASSERT|EXPECT}_??(), but that requires overloading the
1856// comparison operators and is thus discouraged by the Google C++
1857// Usage Guide. Therefore, you are advised to use the
1858// {ASSERT|EXPECT}_TRUE() macro to assert that two objects are
1859// equal.
1860//
1861// 2. The {ASSERT|EXPECT}_??() macros do pointer comparisons on
1862// pointers (in particular, C strings). Therefore, if you use it
1863// with two C strings, you are testing how their locations in memory
1864// are related, not how their content is related. To compare two C
1865// strings by content, use {ASSERT|EXPECT}_STR*().
1866//
1867// 3. {ASSERT|EXPECT}_EQ(v1, v2) is preferred to
1868// {ASSERT|EXPECT}_TRUE(v1 == v2), as the former tells you
1869// what the actual value is when it fails, and similarly for the
1870// other comparisons.
1871//
1872// 4. Do not depend on the order in which {ASSERT|EXPECT}_??()
1873// evaluate their arguments, which is undefined.
1874//
1875// 5. These macros evaluate their arguments exactly once.
1876//
1877// Examples:
1878//
1879// EXPECT_NE(Foo(), 5);
1880// EXPECT_EQ(a_pointer, NULL);
1881// ASSERT_LT(i, array_size);
1882// ASSERT_GT(records.size(), 0) << "There is no record left.";
1883
1884#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"
, 1884, gtest_ar.failure_message()) = ::testing::Message()
\
1885 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"
, 1885, gtest_ar.failure_message()) = ::testing::Message()
1886#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"
, 1886, gtest_ar.failure_message()) = ::testing::Message()
\
1887 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"
, 1887, gtest_ar.failure_message()) = ::testing::Message()
1888#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"
, 1888, gtest_ar.failure_message()) = ::testing::Message()
\
1889 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"
, 1889, gtest_ar.failure_message()) = ::testing::Message()
1890#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"
, 1890, gtest_ar.failure_message()) = ::testing::Message()
\
1891 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"
, 1891, gtest_ar.failure_message()) = ::testing::Message()
1892#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"
, 1892, gtest_ar.failure_message()) = ::testing::Message()
\
1893 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"
, 1893, gtest_ar.failure_message()) = ::testing::Message()
1894#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"
, 1894, gtest_ar.failure_message()) = ::testing::Message()
\
1895 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"
, 1895, gtest_ar.failure_message()) = ::testing::Message()
1896
1897#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"
, 1897, gtest_ar.failure_message()) = ::testing::Message()
\
1898 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"
, 1898, gtest_ar.failure_message()) = ::testing::Message()
1899#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"
, 1899, gtest_ar.failure_message()) = ::testing::Message()
\
1900 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"
, 1900, gtest_ar.failure_message()) = ::testing::Message()
1901#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"
, 1901, gtest_ar.failure_message()) = ::testing::Message()
\
1902 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"
, 1902, gtest_ar.failure_message()) = ::testing::Message()
1903#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"
, 1903, gtest_ar.failure_message()) = ::testing::Message()
\
1904 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"
, 1904, gtest_ar.failure_message()) = ::testing::Message()
1905#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"
, 1905, gtest_ar.failure_message()) = ::testing::Message()
\
1906 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"
, 1906, gtest_ar.failure_message()) = ::testing::Message()
1907#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"
, 1907, gtest_ar.failure_message()) = ::testing::Message()
\
1908 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"
, 1908, gtest_ar.failure_message()) = ::testing::Message()
1909
1910// Define macro GTEST_DONT_DEFINE_ASSERT_XY to 1 to omit the definition of
1911// ASSERT_XY(), which clashes with some users' own code.
1912
1913#if !(defined(GTEST_DONT_DEFINE_ASSERT_EQ) && GTEST_DONT_DEFINE_ASSERT_EQ)
1914#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"
, 1914, 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"
, 1914, gtest_ar.failure_message()) = ::testing::Message()
1915#endif
1916
1917#if !(defined(GTEST_DONT_DEFINE_ASSERT_NE) && GTEST_DONT_DEFINE_ASSERT_NE)
1918#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"
, 1918, 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"
, 1918, gtest_ar.failure_message()) = ::testing::Message()
1919#endif
1920
1921#if !(defined(GTEST_DONT_DEFINE_ASSERT_LE) && GTEST_DONT_DEFINE_ASSERT_LE)
1922#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"
, 1922, 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"
, 1922, gtest_ar.failure_message()) = ::testing::Message()
1923#endif
1924
1925#if !(defined(GTEST_DONT_DEFINE_ASSERT_LT) && GTEST_DONT_DEFINE_ASSERT_LT)
1926#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"
, 1926, 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"
, 1926, gtest_ar.failure_message()) = ::testing::Message()
1927#endif
1928
1929#if !(defined(GTEST_DONT_DEFINE_ASSERT_GE) && GTEST_DONT_DEFINE_ASSERT_GE)
1930#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"
, 1930, 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"
, 1930, gtest_ar.failure_message()) = ::testing::Message()
1931#endif
1932
1933#if !(defined(GTEST_DONT_DEFINE_ASSERT_GT) && GTEST_DONT_DEFINE_ASSERT_GT)
1934#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"
, 1934, 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"
, 1934, gtest_ar.failure_message()) = ::testing::Message()
1935#endif
1936
1937// C-string Comparisons. All tests treat NULL and any non-NULL string
1938// as different. Two NULLs are equal.
1939//
1940// * {ASSERT|EXPECT}_STREQ(s1, s2): Tests that s1 == s2
1941// * {ASSERT|EXPECT}_STRNE(s1, s2): Tests that s1 != s2
1942// * {ASSERT|EXPECT}_STRCASEEQ(s1, s2): Tests that s1 == s2, ignoring case
1943// * {ASSERT|EXPECT}_STRCASENE(s1, s2): Tests that s1 != s2, ignoring case
1944//
1945// For wide or narrow string objects, you can use the
1946// {ASSERT|EXPECT}_??() macros.
1947//
1948// Don't depend on the order in which the arguments are evaluated,
1949// which is undefined.
1950//
1951// These macros evaluate their arguments exactly once.
1952
1953#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"
, 1953, gtest_ar.failure_message()) = ::testing::Message()
\
1954 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"
, 1954, gtest_ar.failure_message()) = ::testing::Message()
1955#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"
, 1955, gtest_ar.failure_message()) = ::testing::Message()
\
1956 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"
, 1956, gtest_ar.failure_message()) = ::testing::Message()
1957#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"
, 1957, gtest_ar.failure_message()) = ::testing::Message()
\
1958 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"
, 1958, gtest_ar.failure_message()) = ::testing::Message()
1959#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"
, 1959, gtest_ar.failure_message()) = ::testing::Message()
\
1960 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"
, 1960, gtest_ar.failure_message()) = ::testing::Message()
1961
1962#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"
, 1962, gtest_ar.failure_message()) = ::testing::Message()
\
1963 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"
, 1963, gtest_ar.failure_message()) = ::testing::Message()
1964#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"
, 1964, gtest_ar.failure_message()) = ::testing::Message()
\
1965 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"
, 1965, gtest_ar.failure_message()) = ::testing::Message()
1966#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"
, 1966, gtest_ar.failure_message()) = ::testing::Message()
\
1967 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"
, 1967, gtest_ar.failure_message()) = ::testing::Message()
1968#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"
, 1968, gtest_ar.failure_message()) = ::testing::Message()
\
1969 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"
, 1969, gtest_ar.failure_message()) = ::testing::Message()
1970
1971// Macros for comparing floating-point numbers.
1972//
1973// * {ASSERT|EXPECT}_FLOAT_EQ(val1, val2):
1974// Tests that two float values are almost equal.
1975// * {ASSERT|EXPECT}_DOUBLE_EQ(val1, val2):
1976// Tests that two double values are almost equal.
1977// * {ASSERT|EXPECT}_NEAR(v1, v2, abs_error):
1978// Tests that v1 and v2 are within the given distance to each other.
1979//
1980// Google Test uses ULP-based comparison to automatically pick a default
1981// error bound that is appropriate for the operands. See the
1982// FloatingPoint template class in gtest-internal.h if you are
1983// interested in the implementation details.
1984
1985#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"
, 1985, gtest_ar.failure_message()) = ::testing::Message()
\
1986 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"
, 1987, gtest_ar.failure_message()) = ::testing::Message()
1987 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"
, 1987, gtest_ar.failure_message()) = ::testing::Message()
1988
1989#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"
, 1989, gtest_ar.failure_message()) = ::testing::Message()
\
1990 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"
, 1991, gtest_ar.failure_message()) = ::testing::Message()
1991 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"
, 1991, gtest_ar.failure_message()) = ::testing::Message()
1992
1993#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", 1993
, gtest_ar.failure_message()) = ::testing::Message()
\
1994 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", 1995
, gtest_ar.failure_message()) = ::testing::Message()
1995 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", 1995
, gtest_ar.failure_message()) = ::testing::Message()
1996
1997#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", 1997
, gtest_ar.failure_message()) = ::testing::Message()
\
1998 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", 1999
, gtest_ar.failure_message()) = ::testing::Message()
1999 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", 1999
, gtest_ar.failure_message()) = ::testing::Message()
2000
2001#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", 2001
, gtest_ar.failure_message()) = ::testing::Message()
\
2002 EXPECT_PRED_FORMAT3(::testing::internal::DoubleNearPredFormat, val1, val2, \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", 2003
, gtest_ar.failure_message()) = ::testing::Message()
2003 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", 2003
, gtest_ar.failure_message()) = ::testing::Message()
2004
2005#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"
, 2005, gtest_ar.failure_message()) = ::testing::Message()
\
2006 ASSERT_PRED_FORMAT3(::testing::internal::DoubleNearPredFormat, val1, val2, \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"
, 2007, gtest_ar.failure_message()) = ::testing::Message()
2007 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"
, 2007, gtest_ar.failure_message()) = ::testing::Message()
2008
2009// These predicate format functions work on floating-point values, and
2010// can be used in {ASSERT|EXPECT}_PRED_FORMAT2*(), e.g.
2011//
2012// EXPECT_PRED_FORMAT2(testing::DoubleLE, Foo(), 5.0);
2013
2014// Asserts that val1 is less than, or almost equal to, val2. Fails
2015// otherwise. In particular, it fails if either val1 or val2 is NaN.
2016GTEST_API___attribute__((visibility("default"))) AssertionResult FloatLE(const char* expr1, const char* expr2,
2017 float val1, float val2);
2018GTEST_API___attribute__((visibility("default"))) AssertionResult DoubleLE(const char* expr1, const char* expr2,
2019 double val1, double val2);
2020
2021#ifdef GTEST_OS_WINDOWS
2022
2023// Macros that test for HRESULT failure and success, these are only useful
2024// on Windows, and rely on Windows SDK macros and APIs to compile.
2025//
2026// * {ASSERT|EXPECT}_HRESULT_{SUCCEEDED|FAILED}(expr)
2027//
2028// When expr unexpectedly fails or succeeds, Google Test prints the
2029// expected result and the actual result with both a human-readable
2030// string representation of the error, if available, as well as the
2031// hex result code.
2032#define EXPECT_HRESULT_SUCCEEDED(expr) \
2033 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"
, 2033, gtest_ar.failure_message()) = ::testing::Message()
2034
2035#define ASSERT_HRESULT_SUCCEEDED(expr) \
2036 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"
, 2036, gtest_ar.failure_message()) = ::testing::Message()
2037
2038#define EXPECT_HRESULT_FAILED(expr) \
2039 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"
, 2039, gtest_ar.failure_message()) = ::testing::Message()
2040
2041#define ASSERT_HRESULT_FAILED(expr) \
2042 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"
, 2042, gtest_ar.failure_message()) = ::testing::Message()
2043
2044#endif // GTEST_OS_WINDOWS
2045
2046// Macros that execute statement and check that it doesn't generate new fatal
2047// failures in the current thread.
2048//
2049// * {ASSERT|EXPECT}_NO_FATAL_FAILURE(statement);
2050//
2051// Examples:
2052//
2053// EXPECT_NO_FATAL_FAILURE(Process());
2054// ASSERT_NO_FATAL_FAILURE(Process()) << "Process() failed";
2055//
2056#define ASSERT_NO_FATAL_FAILURE(statement)switch (0) case 0: default: if (::testing::internal::AlwaysTrue
()) { const ::testing::internal::HasNewFatalFailureHelper gtest_fatal_failure_checker
; if (::testing::internal::AlwaysTrue()) { statement; } else static_assert
(true, ""); if (gtest_fatal_failure_checker.has_new_fatal_failure
()) { goto gtest_label_testnofatal_2056; } } else gtest_label_testnofatal_2056
: return ::testing::internal::AssertHelper(::testing::TestPartResult
::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h"
, 2056, "Expected: " "statement" " doesn't generate new fatal "
"failures in the current thread.\n" " Actual: it does.") = ::
testing::Message()
\
2057 GTEST_TEST_NO_FATAL_FAILURE_(statement, GTEST_FATAL_FAILURE_)switch (0) case 0: default: if (::testing::internal::AlwaysTrue
()) { const ::testing::internal::HasNewFatalFailureHelper gtest_fatal_failure_checker
; if (::testing::internal::AlwaysTrue()) { statement; } else static_assert
(true, ""); if (gtest_fatal_failure_checker.has_new_fatal_failure
()) { goto gtest_label_testnofatal_2057; } } else gtest_label_testnofatal_2057
: return ::testing::internal::AssertHelper(::testing::TestPartResult
::kFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h"
, 2057, "Expected: " "statement" " doesn't generate new fatal "
"failures in the current thread.\n" " Actual: it does.") = ::
testing::Message()
2058#define EXPECT_NO_FATAL_FAILURE(statement)switch (0) case 0: default: if (::testing::internal::AlwaysTrue
()) { const ::testing::internal::HasNewFatalFailureHelper gtest_fatal_failure_checker
; if (::testing::internal::AlwaysTrue()) { statement; } else static_assert
(true, ""); if (gtest_fatal_failure_checker.has_new_fatal_failure
()) { goto gtest_label_testnofatal_2058; } } else gtest_label_testnofatal_2058
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h"
, 2058, "Expected: " "statement" " doesn't generate new fatal "
"failures in the current thread.\n" " Actual: it does.") = ::
testing::Message()
\
2059 GTEST_TEST_NO_FATAL_FAILURE_(statement, GTEST_NONFATAL_FAILURE_)switch (0) case 0: default: if (::testing::internal::AlwaysTrue
()) { const ::testing::internal::HasNewFatalFailureHelper gtest_fatal_failure_checker
; if (::testing::internal::AlwaysTrue()) { statement; } else static_assert
(true, ""); if (gtest_fatal_failure_checker.has_new_fatal_failure
()) { goto gtest_label_testnofatal_2059; } } else gtest_label_testnofatal_2059
: ::testing::internal::AssertHelper(::testing::TestPartResult
::kNonFatalFailure, "/usr/src/googletest/googletest/include/gtest/gtest.h"
, 2059, "Expected: " "statement" " doesn't generate new fatal "
"failures in the current thread.\n" " Actual: it does.") = ::
testing::Message()
2060
2061// Causes a trace (including the given source file path and line number,
2062// and the given message) to be included in every test failure message generated
2063// by code in the scope of the lifetime of an instance of this class. The effect
2064// is undone with the destruction of the instance.
2065//
2066// The message argument can be anything streamable to std::ostream.
2067//
2068// Example:
2069// testing::ScopedTrace trace("file.cc", 123, "message");
2070//
2071class GTEST_API___attribute__((visibility("default"))) ScopedTrace {
2072 public:
2073 // The c'tor pushes the given source file location and message onto
2074 // a trace stack maintained by Google Test.
2075
2076 // Template version. Uses Message() to convert the values into strings.
2077 // Slow, but flexible.
2078 template <typename T>
2079 ScopedTrace(const char* file, int line, const T& message) {
2080 PushTrace(file, line, (Message() << message).GetString());
2081 }
2082
2083 // Optimize for some known types.
2084 ScopedTrace(const char* file, int line, const char* message) {
2085 PushTrace(file, line, message ? message : "(null)");
2086 }
2087
2088 ScopedTrace(const char* file, int line, const std::string& message) {
2089 PushTrace(file, line, message);
2090 }
2091
2092 // The d'tor pops the info pushed by the c'tor.
2093 //
2094 // Note that the d'tor is not virtual in order to be efficient.
2095 // Don't inherit from ScopedTrace!
2096 ~ScopedTrace();
2097
2098 private:
2099 void PushTrace(const char* file, int line, std::string message);
2100
2101 ScopedTrace(const ScopedTrace&) = delete;
2102 ScopedTrace& operator=(const ScopedTrace&) = delete;
2103};
2104
2105// Causes a trace (including the source file path, the current line
2106// number, and the given message) to be included in every test failure
2107// message generated by code in the current scope. The effect is
2108// undone when the control leaves the current scope.
2109//
2110// The message argument can be anything streamable to std::ostream.
2111//
2112// In the implementation, we include the current line number as part
2113// of the dummy variable name, thus allowing multiple SCOPED_TRACE()s
2114// to appear in the same block - as long as they are on different
2115// lines.
2116//
2117// Assuming that each thread maintains its own stack of traces.
2118// Therefore, a SCOPED_TRACE() would (correctly) only affect the
2119// assertions in its own thread.
2120#define SCOPED_TRACE(message)const ::testing::ScopedTrace gtest_trace_2120( "/usr/src/googletest/googletest/include/gtest/gtest.h"
, 2120, (message))
\
2121 const ::testing::ScopedTrace GTEST_CONCAT_TOKEN_(gtest_trace_, __LINE__)gtest_trace_2121( \
2122 __FILE__"/usr/src/googletest/googletest/include/gtest/gtest.h", __LINE__2122, (message))
2123
2124// Compile-time assertion for type equality.
2125// StaticAssertTypeEq<type1, type2>() compiles if and only if type1 and type2
2126// are the same type. The value it returns is not interesting.
2127//
2128// Instead of making StaticAssertTypeEq a class template, we make it a
2129// function template that invokes a helper class template. This
2130// prevents a user from misusing StaticAssertTypeEq<T1, T2> by
2131// defining objects of that type.
2132//
2133// CAVEAT:
2134//
2135// When used inside a method of a class template,
2136// StaticAssertTypeEq<T1, T2>() is effective ONLY IF the method is
2137// instantiated. For example, given:
2138//
2139// template <typename T> class Foo {
2140// public:
2141// void Bar() { testing::StaticAssertTypeEq<int, T>(); }
2142// };
2143//
2144// the code:
2145//
2146// void Test1() { Foo<bool> foo; }
2147//
2148// will NOT generate a compiler error, as Foo<bool>::Bar() is never
2149// actually instantiated. Instead, you need:
2150//
2151// void Test2() { Foo<bool> foo; foo.Bar(); }
2152//
2153// to cause a compiler error.
2154template <typename T1, typename T2>
2155constexpr bool StaticAssertTypeEq() noexcept {
2156 static_assert(std::is_same<T1, T2>::value, "T1 and T2 are not the same type");
2157 return true;
2158}
2159
2160// Defines a test.
2161//
2162// The first parameter is the name of the test suite, and the second
2163// parameter is the name of the test within the test suite.
2164//
2165// The convention is to end the test suite name with "Test". For
2166// example, a test suite for the Foo class can be named FooTest.
2167//
2168// Test code should appear between braces after an invocation of
2169// this macro. Example:
2170//
2171// TEST(FooTest, InitializesCorrectly) {
2172// Foo foo;
2173// EXPECT_TRUE(foo.StatusIsOK());
2174// }
2175
2176// Note that we call GetTestTypeId() instead of GetTypeId<
2177// ::testing::Test>() here to get the type ID of testing::Test. This
2178// is to work around a suspected linker bug when using Google Test as
2179// a framework on Mac OS X. The bug causes GetTypeId<
2180// ::testing::Test>() to return different values depending on whether
2181// the call is from the Google Test framework itself or from user test
2182// code. GetTestTypeId() is guaranteed to always return the same
2183// value, as it always calls GetTypeId<>() from the Google Test
2184// framework.
2185#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() = default; ~test_suite_name_test_name_Test
() override = default; test_suite_name_test_name_Test (const test_suite_name_test_name_Test
&) = delete; test_suite_name_test_name_Test & operator
=( const test_suite_name_test_name_Test &) = delete; test_suite_name_test_name_Test
(test_suite_name_test_name_Test &&) noexcept = delete
; test_suite_name_test_name_Test & operator=( test_suite_name_test_name_Test
&&) noexcept = delete; private: void TestBody() override
; [[maybe_unused]] static ::testing::TestInfo* const test_info_
; }; ::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", 2185
), (::testing::internal::GetTestTypeId()), ::testing::internal
::SuiteApiResolver< ::testing::Test>::GetSetUpCaseOrSuite
("/usr/src/googletest/googletest/include/gtest/gtest.h", 2185
), ::testing::internal::SuiteApiResolver< ::testing::Test>
::GetTearDownCaseOrSuite("/usr/src/googletest/googletest/include/gtest/gtest.h"
, 2185), new ::testing::internal::TestFactoryImpl<test_suite_name_test_name_Test
>); void test_suite_name_test_name_Test::TestBody()
\
2186 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() = default; ~test_suite_name_test_name_Test
() override = default; test_suite_name_test_name_Test (const test_suite_name_test_name_Test
&) = delete; test_suite_name_test_name_Test & operator
=( const test_suite_name_test_name_Test &) = delete; test_suite_name_test_name_Test
(test_suite_name_test_name_Test &&) noexcept = delete
; test_suite_name_test_name_Test & operator=( test_suite_name_test_name_Test
&&) noexcept = delete; private: void TestBody() override
; [[maybe_unused]] static ::testing::TestInfo* const test_info_
; }; ::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", 2187
), (::testing::internal::GetTestTypeId()), ::testing::internal
::SuiteApiResolver< ::testing::Test>::GetSetUpCaseOrSuite
("/usr/src/googletest/googletest/include/gtest/gtest.h", 2187
), ::testing::internal::SuiteApiResolver< ::testing::Test>
::GetTearDownCaseOrSuite("/usr/src/googletest/googletest/include/gtest/gtest.h"
, 2187), new ::testing::internal::TestFactoryImpl<test_suite_name_test_name_Test
>); void test_suite_name_test_name_Test::TestBody()
2187 ::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() = default; ~test_suite_name_test_name_Test
() override = default; test_suite_name_test_name_Test (const test_suite_name_test_name_Test
&) = delete; test_suite_name_test_name_Test & operator
=( const test_suite_name_test_name_Test &) = delete; test_suite_name_test_name_Test
(test_suite_name_test_name_Test &&) noexcept = delete
; test_suite_name_test_name_Test & operator=( test_suite_name_test_name_Test
&&) noexcept = delete; private: void TestBody() override
; [[maybe_unused]] static ::testing::TestInfo* const test_info_
; }; ::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", 2187
), (::testing::internal::GetTestTypeId()), ::testing::internal
::SuiteApiResolver< ::testing::Test>::GetSetUpCaseOrSuite
("/usr/src/googletest/googletest/include/gtest/gtest.h", 2187
), ::testing::internal::SuiteApiResolver< ::testing::Test>
::GetTearDownCaseOrSuite("/usr/src/googletest/googletest/include/gtest/gtest.h"
, 2187), new ::testing::internal::TestFactoryImpl<test_suite_name_test_name_Test
>); void test_suite_name_test_name_Test::TestBody()
2188
2189// Define this macro to 1 to omit the definition of TEST(), which
2190// is a generic name and clashes with some other libraries.
2191#if !(defined(GTEST_DONT_DEFINE_TEST) && GTEST_DONT_DEFINE_TEST)
2192#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() = default; ~test_suite_name_test_name_Test
() override = default; test_suite_name_test_name_Test (const test_suite_name_test_name_Test
&) = delete; test_suite_name_test_name_Test & operator
=( const test_suite_name_test_name_Test &) = delete; test_suite_name_test_name_Test
(test_suite_name_test_name_Test &&) noexcept = delete
; test_suite_name_test_name_Test & operator=( test_suite_name_test_name_Test
&&) noexcept = delete; private: void TestBody() override
; [[maybe_unused]] static ::testing::TestInfo* const test_info_
; }; ::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", 2192
), (::testing::internal::GetTestTypeId()), ::testing::internal
::SuiteApiResolver< ::testing::Test>::GetSetUpCaseOrSuite
("/usr/src/googletest/googletest/include/gtest/gtest.h", 2192
), ::testing::internal::SuiteApiResolver< ::testing::Test>
::GetTearDownCaseOrSuite("/usr/src/googletest/googletest/include/gtest/gtest.h"
, 2192), 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() = default; ~test_suite_name_test_name_Test
() override = default; test_suite_name_test_name_Test (const test_suite_name_test_name_Test
&) = delete; test_suite_name_test_name_Test & operator
=( const test_suite_name_test_name_Test &) = delete; test_suite_name_test_name_Test
(test_suite_name_test_name_Test &&) noexcept = delete
; test_suite_name_test_name_Test & operator=( test_suite_name_test_name_Test
&&) noexcept = delete; private: void TestBody() override
; [[maybe_unused]] static ::testing::TestInfo* const test_info_
; }; ::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", 2192
), (::testing::internal::GetTestTypeId()), ::testing::internal
::SuiteApiResolver< ::testing::Test>::GetSetUpCaseOrSuite
("/usr/src/googletest/googletest/include/gtest/gtest.h", 2192
), ::testing::internal::SuiteApiResolver< ::testing::Test>
::GetTearDownCaseOrSuite("/usr/src/googletest/googletest/include/gtest/gtest.h"
, 2192), new ::testing::internal::TestFactoryImpl<test_suite_name_test_name_Test
>); void test_suite_name_test_name_Test::TestBody()
2193#endif
2194
2195// Defines a test that uses a test fixture.
2196//
2197// The first parameter is the name of the test fixture class, which
2198// also doubles as the test suite name. The second parameter is the
2199// name of the test within the test suite.
2200//
2201// A test fixture class must be declared earlier. The user should put
2202// the test code between braces after using this macro. Example:
2203//
2204// class FooTest : public testing::Test {
2205// protected:
2206// void SetUp() override { b_.AddElement(3); }
2207//
2208// Foo a_;
2209// Foo b_;
2210// };
2211//
2212// TEST_F(FooTest, InitializesCorrectly) {
2213// EXPECT_TRUE(a_.StatusIsOK());
2214// }
2215//
2216// TEST_F(FooTest, ReturnsElementCountCorrectly) {
2217// EXPECT_EQ(a_.size(), 0);
2218// EXPECT_EQ(b_.size(), 1);
2219// }
2220#define GTEST_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() = default; ~test_fixture_test_name_Test
() override = default; test_fixture_test_name_Test (const test_fixture_test_name_Test
&) = delete; test_fixture_test_name_Test & operator=
( const test_fixture_test_name_Test &) = delete; test_fixture_test_name_Test
(test_fixture_test_name_Test &&) noexcept = delete; test_fixture_test_name_Test
& operator=( test_fixture_test_name_Test &&) noexcept
= delete; private: void TestBody() override; [[maybe_unused]
] static ::testing::TestInfo* const test_info_; }; ::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"
, 2220), (::testing::internal::GetTypeId<test_fixture>(
)), ::testing::internal::SuiteApiResolver< test_fixture>
::GetSetUpCaseOrSuite("/usr/src/googletest/googletest/include/gtest/gtest.h"
, 2220), ::testing::internal::SuiteApiResolver< test_fixture
>::GetTearDownCaseOrSuite("/usr/src/googletest/googletest/include/gtest/gtest.h"
, 2220), new ::testing::internal::TestFactoryImpl<test_fixture_test_name_Test
>); void test_fixture_test_name_Test::TestBody()
\
2221 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() = default; ~test_fixture_test_name_Test
() override = default; test_fixture_test_name_Test (const test_fixture_test_name_Test
&) = delete; test_fixture_test_name_Test & operator=
( const test_fixture_test_name_Test &) = delete; test_fixture_test_name_Test
(test_fixture_test_name_Test &&) noexcept = delete; test_fixture_test_name_Test
& operator=( test_fixture_test_name_Test &&) noexcept
= delete; private: void TestBody() override; [[maybe_unused]
] static ::testing::TestInfo* const test_info_; }; ::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"
, 2222), (::testing::internal::GetTypeId<test_fixture>(
)), ::testing::internal::SuiteApiResolver< test_fixture>
::GetSetUpCaseOrSuite("/usr/src/googletest/googletest/include/gtest/gtest.h"
, 2222), ::testing::internal::SuiteApiResolver< test_fixture
>::GetTearDownCaseOrSuite("/usr/src/googletest/googletest/include/gtest/gtest.h"
, 2222), new ::testing::internal::TestFactoryImpl<test_fixture_test_name_Test
>); void test_fixture_test_name_Test::TestBody()
2222 ::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() = default; ~test_fixture_test_name_Test
() override = default; test_fixture_test_name_Test (const test_fixture_test_name_Test
&) = delete; test_fixture_test_name_Test & operator=
( const test_fixture_test_name_Test &) = delete; test_fixture_test_name_Test
(test_fixture_test_name_Test &&) noexcept = delete; test_fixture_test_name_Test
& operator=( test_fixture_test_name_Test &&) noexcept
= delete; private: void TestBody() override; [[maybe_unused]
] static ::testing::TestInfo* const test_info_; }; ::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"
, 2222), (::testing::internal::GetTypeId<test_fixture>(
)), ::testing::internal::SuiteApiResolver< test_fixture>
::GetSetUpCaseOrSuite("/usr/src/googletest/googletest/include/gtest/gtest.h"
, 2222), ::testing::internal::SuiteApiResolver< test_fixture
>::GetTearDownCaseOrSuite("/usr/src/googletest/googletest/include/gtest/gtest.h"
, 2222), new ::testing::internal::TestFactoryImpl<test_fixture_test_name_Test
>); void test_fixture_test_name_Test::TestBody()
2223#if !(defined(GTEST_DONT_DEFINE_TEST_F) && GTEST_DONT_DEFINE_TEST_F)
2224#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() = default; ~test_fixture_test_name_Test
() override = default; test_fixture_test_name_Test (const test_fixture_test_name_Test
&) = delete; test_fixture_test_name_Test & operator=
( const test_fixture_test_name_Test &) = delete; test_fixture_test_name_Test
(test_fixture_test_name_Test &&) noexcept = delete; test_fixture_test_name_Test
& operator=( test_fixture_test_name_Test &&) noexcept
= delete; private: void TestBody() override; [[maybe_unused]
] static ::testing::TestInfo* const test_info_; }; ::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"
, 2224), (::testing::internal::GetTypeId<test_fixture>(
)), ::testing::internal::SuiteApiResolver< test_fixture>
::GetSetUpCaseOrSuite("/usr/src/googletest/googletest/include/gtest/gtest.h"
, 2224), ::testing::internal::SuiteApiResolver< test_fixture
>::GetTearDownCaseOrSuite("/usr/src/googletest/googletest/include/gtest/gtest.h"
, 2224), new ::testing::internal::TestFactoryImpl<test_fixture_test_name_Test
>); void test_fixture_test_name_Test::TestBody()
GTEST_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() = default; ~test_fixture_test_name_Test
() override = default; test_fixture_test_name_Test (const test_fixture_test_name_Test
&) = delete; test_fixture_test_name_Test & operator=
( const test_fixture_test_name_Test &) = delete; test_fixture_test_name_Test
(test_fixture_test_name_Test &&) noexcept = delete; test_fixture_test_name_Test
& operator=( test_fixture_test_name_Test &&) noexcept
= delete; private: void TestBody() override; [[maybe_unused]
] static ::testing::TestInfo* const test_info_; }; ::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"
, 2224), (::testing::internal::GetTypeId<test_fixture>(
)), ::testing::internal::SuiteApiResolver< test_fixture>
::GetSetUpCaseOrSuite("/usr/src/googletest/googletest/include/gtest/gtest.h"
, 2224), ::testing::internal::SuiteApiResolver< test_fixture
>::GetTearDownCaseOrSuite("/usr/src/googletest/googletest/include/gtest/gtest.h"
, 2224), new ::testing::internal::TestFactoryImpl<test_fixture_test_name_Test
>); void test_fixture_test_name_Test::TestBody()
2225#endif
2226
2227// Returns a path to a temporary directory, which should be writable. It is
2228// implementation-dependent whether or not the path is terminated by the
2229// directory-separator character.
2230GTEST_API___attribute__((visibility("default"))) std::string TempDir();
2231
2232// Returns a path to a directory that contains ancillary data files that might
2233// be used by tests. It is implementation dependent whether or not the path is
2234// terminated by the directory-separator character. The directory and the files
2235// in it should be considered read-only.
2236GTEST_API___attribute__((visibility("default"))) std::string SrcDir();
2237
2238GTEST_DISABLE_MSC_WARNINGS_POP_() // 4805 4100
2239
2240// Dynamically registers a test with the framework.
2241//
2242// This is an advanced API only to be used when the `TEST` macros are
2243// insufficient. The macros should be preferred when possible, as they avoid
2244// most of the complexity of calling this function.
2245//
2246// The `factory` argument is a factory callable (move-constructible) object or
2247// function pointer that creates a new instance of the Test object. It
2248// handles ownership to the caller. The signature of the callable is
2249// `Fixture*()`, where `Fixture` is the test fixture class for the test. All
2250// tests registered with the same `test_suite_name` must return the same
2251// fixture type. This is checked at runtime.
2252//
2253// The framework will infer the fixture class from the factory and will call
2254// the `SetUpTestSuite` and `TearDownTestSuite` for it.
2255//
2256// Must be called before `RUN_ALL_TESTS()` is invoked, otherwise behavior is
2257// undefined.
2258//
2259// Use case example:
2260//
2261// class MyFixture : public ::testing::Test {
2262// public:
2263// // All of these optional, just like in regular macro usage.
2264// static void SetUpTestSuite() { ... }
2265// static void TearDownTestSuite() { ... }
2266// void SetUp() override { ... }
2267// void TearDown() override { ... }
2268// };
2269//
2270// class MyTest : public MyFixture {
2271// public:
2272// explicit MyTest(int data) : data_(data) {}
2273// void TestBody() override { ... }
2274//
2275// private:
2276// int data_;
2277// };
2278//
2279// void RegisterMyTests(const std::vector<int>& values) {
2280// for (int v : values) {
2281// ::testing::RegisterTest(
2282// "MyFixture", ("Test" + std::to_string(v)).c_str(), nullptr,
2283// std::to_string(v).c_str(),
2284// __FILE__, __LINE__,
2285// // Important to use the fixture type as the return type here.
2286// [=]() -> MyFixture* { return new MyTest(v); });
2287// }
2288// }
2289// ...
2290// int main(int argc, char** argv) {
2291// ::testing::InitGoogleTest(&argc, argv);
2292// std::vector<int> values_to_test = LoadValuesFromConfig();
2293// RegisterMyTests(values_to_test);
2294// ...
2295// return RUN_ALL_TESTS();
2296// }
2297//
2298template <int&... ExplicitParameterBarrier, typename Factory>
2299TestInfo* RegisterTest(const char* test_suite_name, const char* test_name,
2300 const char* type_param, const char* value_param,
2301 const char* file, int line, Factory factory) {
2302 using TestT = typename std::remove_pointer<decltype(factory())>::type;
2303
2304 class FactoryImpl : public internal::TestFactoryBase {
2305 public:
2306 explicit FactoryImpl(Factory f) : factory_(std::move(f)) {}
2307 Test* CreateTest() override { return factory_(); }
2308
2309 private:
2310 Factory factory_;
2311 };
2312
2313 return internal::MakeAndRegisterTestInfo(
2314 test_suite_name, test_name, type_param, value_param,
2315 internal::CodeLocation(file, line), internal::GetTypeId<TestT>(),
2316 internal::SuiteApiResolver<TestT>::GetSetUpCaseOrSuite(file, line),
2317 internal::SuiteApiResolver<TestT>::GetTearDownCaseOrSuite(file, line),
2318 new FactoryImpl{std::move(factory)});
2319}
2320
2321} // namespace testing
2322
2323// Use this function in main() to run all tests. It returns 0 if all
2324// tests are successful, or 1 otherwise.
2325//
2326// RUN_ALL_TESTS() should be invoked after the command line has been
2327// parsed by InitGoogleTest(). RUN_ALL_TESTS will tear down and delete any
2328// installed environments and should only be called once per binary.
2329//
2330// This function was formerly a macro; thus, it is in the global
2331// namespace and has an all-caps name.
2332int RUN_ALL_TESTS() GTEST_MUST_USE_RESULT___attribute__((warn_unused_result));
2333
2334inline int RUN_ALL_TESTS() { return ::testing::UnitTest::GetInstance()->Run(); }
2335
2336GTEST_DISABLE_MSC_WARNINGS_POP_() // 4251
2337
2338#endif // GOOGLETEST_INCLUDE_GTEST_GTEST_H_