17ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Copyright 2005, Google Inc. 27ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// All rights reserved. 37ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 47ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Redistribution and use in source and binary forms, with or without 57ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// modification, are permitted provided that the following conditions are 67ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// met: 77ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 87ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// * Redistributions of source code must retain the above copyright 97ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// notice, this list of conditions and the following disclaimer. 107ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// * Redistributions in binary form must reproduce the above 117ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// copyright notice, this list of conditions and the following disclaimer 127ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// in the documentation and/or other materials provided with the 137ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// distribution. 147ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// * Neither the name of Google Inc. nor the names of its 157ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// contributors may be used to endorse or promote products derived from 167ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// this software without specific prior written permission. 177ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 187ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 197ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 207ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 217ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 227ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 237ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 247ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 257ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 267ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 277ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 287ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 297ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 307ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Authors: wan@google.com (Zhanyong Wan), eefacm@gmail.com (Sean Mcafee) 317ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 327ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// The Google C++ Testing Framework (Google Test) 337ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 347ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// This header file declares the String class and functions used internally by 357ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Google Test. They are subject to change without notice. They should not used 367ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// by code external to Google Test. 377ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 38e4b9c93fc1b531fe0cfe25a042f6b81c1e7c15c0Benjamin Kramer// This header file is #included by <gtest/internal/gtest-internal.h>. 397ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// It should not be #included by other files. 407ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 417ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#ifndef GTEST_INCLUDE_GTEST_INTERNAL_GTEST_STRING_H_ 427ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#define GTEST_INCLUDE_GTEST_INTERNAL_GTEST_STRING_H_ 437ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 4457240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer#ifdef __BORLANDC__ 4557240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer// string.h is not guaranteed to provide strcpy on C++ Builder. 46b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad# include <mem.h> 4757240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer#endif 4857240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer 497ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#include <string.h> 50b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad#include "gtest/internal/gtest-port.h" 517ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 527ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#include <string> 537ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 547ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmannamespace testing { 557ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmannamespace internal { 567ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 577ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// String - a UTF-8 string class. 587ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 5957240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer// For historic reasons, we don't use std::string. 607ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 6157240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer// TODO(wan@google.com): replace this class with std::string or 6257240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer// implement it in terms of the latter. 6357240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer// 6457240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer// Note that String can represent both NULL and the empty string, 6557240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer// while std::string cannot represent NULL. 667ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 677ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// NULL and the empty string are considered different. NULL is less 687ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// than anything (including the empty string) except itself. 697ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 707ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// This class only provides minimum functionality necessary for 717ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// implementing Google Test. We do not intend to implement a full-fledged 727ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// string class here. 737ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 747ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Since the purpose of this class is to provide a substitute for 757ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// std::string on platforms where it cannot be used, we define a copy 767ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// constructor and assignment operators such that we don't need 777ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// conditional compilation in a lot of places. 787ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 797ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// In order to make the representation efficient, the d'tor of String 807ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// is not virtual. Therefore DO NOT INHERIT FROM String. 8157240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramerclass GTEST_API_ String { 827ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman public: 837ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Static utility methods 847ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 857ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Returns the input enclosed in double quotes if it's not NULL; 867ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // otherwise returns "(null)". For example, "\"Hello\"" is returned 877ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // for input "Hello". 887ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // 897ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // This is useful for printing a C string in the syntax of a literal. 907ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // 917ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Known issue: escape sequences are not handled yet. 927ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman static String ShowCStringQuoted(const char* c_str); 937ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 947ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Clones a 0-terminated C string, allocating memory using new. The 957ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // caller is responsible for deleting the return value using 967ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // delete[]. Returns the cloned string, or NULL if the input is 977ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // NULL. 987ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // 997ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // This is different from strdup() in string.h, which allocates 1007ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // memory using malloc(). 1017ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman static const char* CloneCString(const char* c_str); 1027ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 103190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer#if GTEST_OS_WINDOWS_MOBILE 1047ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Windows CE does not have the 'ANSI' versions of Win32 APIs. To be 1057ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // able to pass strings to Win32 APIs on CE we need to convert them 1067ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // to 'Unicode', UTF-16. 1077ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 1087ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Creates a UTF-16 wide string from the given ANSI string, allocating 1097ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // memory using new. The caller is responsible for deleting the return 1107ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // value using delete[]. Returns the wide string, or NULL if the 1117ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // input is NULL. 1127ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // 1137ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // The wide string is created using the ANSI codepage (CP_ACP) to 1147ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // match the behaviour of the ANSI versions of Win32 calls and the 1157ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // C runtime. 1167ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman static LPCWSTR AnsiToUtf16(const char* c_str); 1177ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 1187ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Creates an ANSI string from the given wide string, allocating 1197ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // memory using new. The caller is responsible for deleting the return 1207ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // value using delete[]. Returns the ANSI string, or NULL if the 1217ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // input is NULL. 1227ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // 1237ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // The returned string is created using the ANSI codepage (CP_ACP) to 1247ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // match the behaviour of the ANSI versions of Win32 calls and the 1257ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // C runtime. 1267ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman static const char* Utf16ToAnsi(LPCWSTR utf16_str); 1277ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#endif 1287ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 1297ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Compares two C strings. Returns true iff they have the same content. 1307ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // 1317ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Unlike strcmp(), this function can handle NULL argument(s). A 1327ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // NULL C string is considered different to any non-NULL C string, 1337ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // including the empty string. 1347ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman static bool CStringEquals(const char* lhs, const char* rhs); 1357ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 1367ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Converts a wide C string to a String using the UTF-8 encoding. 1377ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // NULL will be converted to "(null)". If an error occurred during 1387ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // the conversion, "(failed to convert from wide string)" is 1397ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // returned. 1407ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman static String ShowWideCString(const wchar_t* wide_c_str); 1417ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 1427ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Similar to ShowWideCString(), except that this function encloses 1437ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // the converted string in double quotes. 1447ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman static String ShowWideCStringQuoted(const wchar_t* wide_c_str); 1457ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 1467ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Compares two wide C strings. Returns true iff they have the same 1477ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // content. 1487ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // 1497ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Unlike wcscmp(), this function can handle NULL argument(s). A 1507ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // NULL C string is considered different to any non-NULL C string, 1517ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // including the empty string. 1527ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman static bool WideCStringEquals(const wchar_t* lhs, const wchar_t* rhs); 1537ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 1547ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Compares two C strings, ignoring case. Returns true iff they 1557ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // have the same content. 1567ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // 1577ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Unlike strcasecmp(), this function can handle NULL argument(s). 1587ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // A NULL C string is considered different to any non-NULL C string, 1597ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // including the empty string. 1607ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman static bool CaseInsensitiveCStringEquals(const char* lhs, 1617ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman const char* rhs); 1627ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 1637ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Compares two wide C strings, ignoring case. Returns true iff they 1647ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // have the same content. 1657ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // 1667ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Unlike wcscasecmp(), this function can handle NULL argument(s). 1677ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // A NULL C string is considered different to any non-NULL wide C string, 1687ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // including the empty string. 1697ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // NB: The implementations on different platforms slightly differ. 1707ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // On windows, this method uses _wcsicmp which compares according to LC_CTYPE 1717ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // environment variable. On GNU platform this method uses wcscasecmp 1727ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // which compares according to LC_CTYPE category of the current locale. 1737ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // On MacOS X, it uses towlower, which also uses LC_CTYPE category of the 1747ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // current locale. 1757ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman static bool CaseInsensitiveWideCStringEquals(const wchar_t* lhs, 1767ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman const wchar_t* rhs); 1777ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 1787ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Formats a list of arguments to a String, using the same format 1797ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // spec string as for printf. 1807ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // 1817ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // We do not use the StringPrintf class as it is not universally 1827ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // available. 1837ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // 1847ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // The result is limited to 4096 characters (including the tailing 1857ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // 0). If 4096 characters are not enough to format the input, 1867ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // "<buffer exceeded>" is returned. 1877ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman static String Format(const char* format, ...); 1887ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 1897ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // C'tors 1907ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 1917ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // The default c'tor constructs a NULL string. 192190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer String() : c_str_(NULL), length_(0) {} 1937ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 1947ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Constructs a String by cloning a 0-terminated C string. 19557240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer String(const char* a_c_str) { // NOLINT 19657240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer if (a_c_str == NULL) { 197190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer c_str_ = NULL; 198190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer length_ = 0; 199190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer } else { 20057240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer ConstructNonNull(a_c_str, strlen(a_c_str)); 201190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer } 2027ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } 2037ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 2047ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Constructs a String by copying a given number of chars from a 205190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer // buffer. E.g. String("hello", 3) creates the string "hel", 206190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer // String("a\0bcd", 4) creates "a\0bc", String(NULL, 0) creates "", 207190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer // and String(NULL, 1) results in access violation. 20857240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer String(const char* buffer, size_t a_length) { 20957240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer ConstructNonNull(buffer, a_length); 210190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer } 2117ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 2127ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // The copy c'tor creates a new copy of the string. The two 2137ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // String objects do not share content. 214190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer String(const String& str) : c_str_(NULL), length_(0) { *this = str; } 2157ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 2167ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // D'tor. String is intended to be a final class, so the d'tor 2177ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // doesn't need to be virtual. 2187ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman ~String() { delete[] c_str_; } 2197ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 2207ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Allows a String to be implicitly converted to an ::std::string or 2217ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // ::string, and vice versa. Converting a String containing a NULL 2227ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // pointer to ::std::string or ::string is undefined behavior. 2237ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Converting a ::std::string or ::string containing an embedded NUL 2247ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // character to a String will result in the prefix up to the first 2257ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // NUL character. 226190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer String(const ::std::string& str) { 227190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer ConstructNonNull(str.c_str(), str.length()); 228190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer } 2297ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 230190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer operator ::std::string() const { return ::std::string(c_str(), length()); } 2317ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 2327ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#if GTEST_HAS_GLOBAL_STRING 233190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer String(const ::string& str) { 234190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer ConstructNonNull(str.c_str(), str.length()); 235190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer } 2367ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 237190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer operator ::string() const { return ::string(c_str(), length()); } 2387ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#endif // GTEST_HAS_GLOBAL_STRING 2397ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 2407ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Returns true iff this is an empty string (i.e. ""). 241190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer bool empty() const { return (c_str() != NULL) && (length() == 0); } 2427ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 2437ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Compares this with another String. 2447ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Returns < 0 if this is less than rhs, 0 if this is equal to rhs, or > 0 2457ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // if this is greater than rhs. 2467ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman int Compare(const String& rhs) const; 2477ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 2487ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Returns true iff this String equals the given C string. A NULL 2497ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // string and a non-NULL string are considered not equal. 25057240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer bool operator==(const char* a_c_str) const { return Compare(a_c_str) == 0; } 2517ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 252190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer // Returns true iff this String is less than the given String. A 253190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer // NULL string is considered less than "". 2547ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman bool operator<(const String& rhs) const { return Compare(rhs) < 0; } 2557ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 2567ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Returns true iff this String doesn't equal the given C string. A NULL 2577ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // string and a non-NULL string are considered not equal. 25857240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer bool operator!=(const char* a_c_str) const { return !(*this == a_c_str); } 2597ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 2607ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Returns true iff this String ends with the given suffix. *Any* 2617ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // String is considered to end with a NULL or empty suffix. 2627ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman bool EndsWith(const char* suffix) const; 2637ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 2647ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Returns true iff this String ends with the given suffix, not considering 2657ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // case. Any String is considered to end with a NULL or empty suffix. 2667ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman bool EndsWithCaseInsensitive(const char* suffix) const; 2677ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 268190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer // Returns the length of the encapsulated string, or 0 if the 2697ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // string is NULL. 270190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer size_t length() const { return length_; } 2717ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 2727ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Gets the 0-terminated C string this String object represents. 2737ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // The String object still owns the string. Therefore the caller 2747ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // should NOT delete the return value. 2757ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman const char* c_str() const { return c_str_; } 2767ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 2777ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Assigns a C string to this object. Self-assignment works. 27857240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer const String& operator=(const char* a_c_str) { 27957240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer return *this = String(a_c_str); 28057240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer } 2817ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 2827ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Assigns a String object to this object. Self-assignment works. 283190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer const String& operator=(const String& rhs) { 284190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer if (this != &rhs) { 285190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer delete[] c_str_; 286190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer if (rhs.c_str() == NULL) { 287190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer c_str_ = NULL; 288190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer length_ = 0; 289190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer } else { 290190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer ConstructNonNull(rhs.c_str(), rhs.length()); 291190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer } 292190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer } 293190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer 2947ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman return *this; 2957ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } 2967ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 2977ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman private: 298190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer // Constructs a non-NULL String from the given content. This 299b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad // function can only be called when c_str_ has not been allocated. 300190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer // ConstructNonNull(NULL, 0) results in an empty string (""). 301190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer // ConstructNonNull(NULL, non_zero) is undefined behavior. 30257240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer void ConstructNonNull(const char* buffer, size_t a_length) { 30357240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer char* const str = new char[a_length + 1]; 30457240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer memcpy(str, buffer, a_length); 30557240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer str[a_length] = '\0'; 306190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer c_str_ = str; 30757240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer length_ = a_length; 308190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer } 3097ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 310190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer const char* c_str_; 311190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer size_t length_; 312190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer}; // class String 313190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer 314190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer// Streams a String to an ostream. Each '\0' character in the String 315190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer// is replaced with "\\0". 316190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramerinline ::std::ostream& operator<<(::std::ostream& os, const String& str) { 317190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer if (str.c_str() == NULL) { 318190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer os << "(null)"; 319190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer } else { 320190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer const char* const c_str = str.c_str(); 321190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer for (size_t i = 0; i != str.length(); i++) { 322190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer if (c_str[i] == '\0') { 323190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer os << "\\0"; 324190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer } else { 325190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer os << c_str[i]; 326190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer } 327190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer } 328190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer } 329190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer return os; 3307ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman} 3317ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 332b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// Gets the content of the stringstream's buffer as a String. Each '\0' 3337ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// character in the buffer is replaced with "\\0". 334b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay FoadGTEST_API_ String StringStreamToString(::std::stringstream* stream); 3357ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 3367ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Converts a streamable value to a String. A NULL pointer is 3377ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// converted to "(null)". When the input value is a ::string, 3387ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// ::std::string, ::wstring, or ::std::wstring object, each NUL 3397ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// character in it is replaced with "\\0". 3407ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 3417ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Declared here but defined in gtest.h, so that it has access 3427ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// to the definition of the Message class, required by the ARM 3437ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// compiler. 3447ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmantemplate <typename T> 3457ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha BrukmanString StreamableToString(const T& streamable); 3467ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 3477ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman} // namespace internal 3487ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman} // namespace testing 3497ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 3507ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#endif // GTEST_INCLUDE_GTEST_INTERNAL_GTEST_STRING_H_ 351