1dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// Copyright 2005, Google Inc. 2dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// All rights reserved. 3dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// 4dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// Redistribution and use in source and binary forms, with or without 5dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// modification, are permitted provided that the following conditions are 6dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// met: 7dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// 8dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// * Redistributions of source code must retain the above copyright 9dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// notice, this list of conditions and the following disclaimer. 10dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// * Redistributions in binary form must reproduce the above 11dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// copyright notice, this list of conditions and the following disclaimer 12dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// in the documentation and/or other materials provided with the 13dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// distribution. 14dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// * Neither the name of Google Inc. nor the names of its 15dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// contributors may be used to endorse or promote products derived from 16dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// this software without specific prior written permission. 17dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// 18dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 21dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 23dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 24dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 28dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// 30dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// Authors: wan@google.com (Zhanyong Wan), eefacm@gmail.com (Sean Mcafee) 31dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// 32dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// The Google C++ Testing Framework (Google Test) 33dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// 34dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// This header file declares the String class and functions used internally by 35dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// Google Test. They are subject to change without notice. They should not used 36dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// by code external to Google Test. 37dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// 38dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// This header file is #included by <gtest/internal/gtest-internal.h>. 39dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// It should not be #included by other files. 40dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 41dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter#ifndef GTEST_INCLUDE_GTEST_INTERNAL_GTEST_STRING_H_ 42dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter#define GTEST_INCLUDE_GTEST_INTERNAL_GTEST_STRING_H_ 43dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 4446108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan#ifdef __BORLANDC__ 4546108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan// string.h is not guaranteed to provide strcpy on C++ Builder. 4646108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan# include <mem.h> 4746108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan#endif 48dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 4946108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan#include <string.h> 50dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter#include <string> 5146108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan 5246108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan#include "gtest/internal/gtest-port.h" 53dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 54dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixternamespace testing { 55dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixternamespace internal { 56dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 57dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// String - a UTF-8 string class. 58dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// 5946108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan// For historic reasons, we don't use std::string. 60dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// 6146108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan// TODO(wan@google.com): replace this class with std::string or 6246108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan// implement it in terms of the latter. 6346108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan// 6446108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan// Note that String can represent both NULL and the empty string, 6546108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan// while std::string cannot represent NULL. 66dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// 67dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// NULL and the empty string are considered different. NULL is less 68dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// than anything (including the empty string) except itself. 69dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// 70dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// This class only provides minimum functionality necessary for 71dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// implementing Google Test. We do not intend to implement a full-fledged 72dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// string class here. 73dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// 74dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// Since the purpose of this class is to provide a substitute for 75dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// std::string on platforms where it cannot be used, we define a copy 76dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// constructor and assignment operators such that we don't need 77dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// conditional compilation in a lot of places. 78dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// 79dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// In order to make the representation efficient, the d'tor of String 80dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// is not virtual. Therefore DO NOT INHERIT FROM String. 8146108a219a4b812dd8f36fee479a0340ea5963f5Ben Chanclass GTEST_API_ String { 82dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter public: 83dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // Static utility methods 84dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 85dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // Returns the input enclosed in double quotes if it's not NULL; 86dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // otherwise returns "(null)". For example, "\"Hello\"" is returned 87dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // for input "Hello". 88dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // 89dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // This is useful for printing a C string in the syntax of a literal. 90dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // 91dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // Known issue: escape sequences are not handled yet. 92dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter static String ShowCStringQuoted(const char* c_str); 93dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 94dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // Clones a 0-terminated C string, allocating memory using new. The 95dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // caller is responsible for deleting the return value using 96dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // delete[]. Returns the cloned string, or NULL if the input is 97dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // NULL. 98dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // 99dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // This is different from strdup() in string.h, which allocates 100dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // memory using malloc(). 101dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter static const char* CloneCString(const char* c_str); 102dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 10346108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan#if GTEST_OS_WINDOWS_MOBILE 104dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // Windows CE does not have the 'ANSI' versions of Win32 APIs. To be 105dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // able to pass strings to Win32 APIs on CE we need to convert them 106dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // to 'Unicode', UTF-16. 107dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 108dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // Creates a UTF-16 wide string from the given ANSI string, allocating 109dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // memory using new. The caller is responsible for deleting the return 110dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // value using delete[]. Returns the wide string, or NULL if the 111dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // input is NULL. 112dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // 113dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // The wide string is created using the ANSI codepage (CP_ACP) to 114dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // match the behaviour of the ANSI versions of Win32 calls and the 115dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // C runtime. 116dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter static LPCWSTR AnsiToUtf16(const char* c_str); 117dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 118dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // Creates an ANSI string from the given wide string, allocating 119dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // memory using new. The caller is responsible for deleting the return 120dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // value using delete[]. Returns the ANSI string, or NULL if the 121dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // input is NULL. 122dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // 123dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // The returned string is created using the ANSI codepage (CP_ACP) to 124dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // match the behaviour of the ANSI versions of Win32 calls and the 125dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // C runtime. 126dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter static const char* Utf16ToAnsi(LPCWSTR utf16_str); 127dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter#endif 128dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 129dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // Compares two C strings. Returns true iff they have the same content. 130dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // 131dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // Unlike strcmp(), this function can handle NULL argument(s). A 132dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // NULL C string is considered different to any non-NULL C string, 133dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // including the empty string. 134dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter static bool CStringEquals(const char* lhs, const char* rhs); 135dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 136dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // Converts a wide C string to a String using the UTF-8 encoding. 137dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // NULL will be converted to "(null)". If an error occurred during 138dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // the conversion, "(failed to convert from wide string)" is 139dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // returned. 140dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter static String ShowWideCString(const wchar_t* wide_c_str); 141dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 142dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // Similar to ShowWideCString(), except that this function encloses 143dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // the converted string in double quotes. 144dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter static String ShowWideCStringQuoted(const wchar_t* wide_c_str); 145dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 146dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // Compares two wide C strings. Returns true iff they have the same 147dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // content. 148dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // 149dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // Unlike wcscmp(), this function can handle NULL argument(s). A 150dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // NULL C string is considered different to any non-NULL C string, 151dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // including the empty string. 152dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter static bool WideCStringEquals(const wchar_t* lhs, const wchar_t* rhs); 153dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 154dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // Compares two C strings, ignoring case. Returns true iff they 155dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // have the same content. 156dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // 157dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // Unlike strcasecmp(), this function can handle NULL argument(s). 158dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // A NULL C string is considered different to any non-NULL C string, 159dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // including the empty string. 160dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter static bool CaseInsensitiveCStringEquals(const char* lhs, 161dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter const char* rhs); 162dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 163dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // Compares two wide C strings, ignoring case. Returns true iff they 164dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // have the same content. 165dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // 166dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // Unlike wcscasecmp(), this function can handle NULL argument(s). 167dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // A NULL C string is considered different to any non-NULL wide C string, 168dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // including the empty string. 169dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // NB: The implementations on different platforms slightly differ. 170dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // On windows, this method uses _wcsicmp which compares according to LC_CTYPE 171dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // environment variable. On GNU platform this method uses wcscasecmp 172dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // which compares according to LC_CTYPE category of the current locale. 173dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // On MacOS X, it uses towlower, which also uses LC_CTYPE category of the 174dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // current locale. 175dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter static bool CaseInsensitiveWideCStringEquals(const wchar_t* lhs, 176dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter const wchar_t* rhs); 177dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 178dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // Formats a list of arguments to a String, using the same format 179dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // spec string as for printf. 180dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // 181dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // We do not use the StringPrintf class as it is not universally 182dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // available. 183dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // 184dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // The result is limited to 4096 characters (including the tailing 185dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // 0). If 4096 characters are not enough to format the input, 186dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // "<buffer exceeded>" is returned. 187dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter static String Format(const char* format, ...); 188dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 189dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // C'tors 190dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 191dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // The default c'tor constructs a NULL string. 19246108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan String() : c_str_(NULL), length_(0) {} 193dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 194dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // Constructs a String by cloning a 0-terminated C string. 19546108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan String(const char* a_c_str) { // NOLINT 19646108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan if (a_c_str == NULL) { 19746108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan c_str_ = NULL; 19846108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan length_ = 0; 19946108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan } else { 20046108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan ConstructNonNull(a_c_str, strlen(a_c_str)); 20146108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan } 202dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter } 203dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 204dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // Constructs a String by copying a given number of chars from a 20546108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan // buffer. E.g. String("hello", 3) creates the string "hel", 20646108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan // String("a\0bcd", 4) creates "a\0bc", String(NULL, 0) creates "", 20746108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan // and String(NULL, 1) results in access violation. 20846108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan String(const char* buffer, size_t a_length) { 20946108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan ConstructNonNull(buffer, a_length); 21046108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan } 211dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 212dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // The copy c'tor creates a new copy of the string. The two 213dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // String objects do not share content. 21446108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan String(const String& str) : c_str_(NULL), length_(0) { *this = str; } 215dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 216dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // D'tor. String is intended to be a final class, so the d'tor 217dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // doesn't need to be virtual. 218dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter ~String() { delete[] c_str_; } 219dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 220dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // Allows a String to be implicitly converted to an ::std::string or 221dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // ::string, and vice versa. Converting a String containing a NULL 222dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // pointer to ::std::string or ::string is undefined behavior. 223dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // Converting a ::std::string or ::string containing an embedded NUL 224dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // character to a String will result in the prefix up to the first 225dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // NUL character. 22646108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan String(const ::std::string& str) { // NOLINT 22746108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan ConstructNonNull(str.c_str(), str.length()); 22846108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan } 229dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 23046108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan operator ::std::string() const { return ::std::string(c_str(), length()); } 231dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 232dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter#if GTEST_HAS_GLOBAL_STRING 23346108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan String(const ::string& str) { // NOLINT 23446108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan ConstructNonNull(str.c_str(), str.length()); 23546108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan } 236dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 23746108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan operator ::string() const { return ::string(c_str(), length()); } 238dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter#endif // GTEST_HAS_GLOBAL_STRING 239dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 240dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // Returns true iff this is an empty string (i.e. ""). 24146108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan bool empty() const { return (c_str() != NULL) && (length() == 0); } 242dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 243dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // Compares this with another String. 244dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // Returns < 0 if this is less than rhs, 0 if this is equal to rhs, or > 0 245dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // if this is greater than rhs. 246dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter int Compare(const String& rhs) const; 247dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 248dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // Returns true iff this String equals the given C string. A NULL 249dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // string and a non-NULL string are considered not equal. 25046108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan bool operator==(const char* a_c_str) const { return Compare(a_c_str) == 0; } 251dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 25246108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan // Returns true iff this String is less than the given String. A 25346108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan // NULL string is considered less than "". 254dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter bool operator<(const String& rhs) const { return Compare(rhs) < 0; } 255dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 256dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // Returns true iff this String doesn't equal the given C string. A NULL 257dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // string and a non-NULL string are considered not equal. 25846108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan bool operator!=(const char* a_c_str) const { return !(*this == a_c_str); } 259dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 260dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // Returns true iff this String ends with the given suffix. *Any* 261dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // String is considered to end with a NULL or empty suffix. 262dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter bool EndsWith(const char* suffix) const; 263dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 264dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // Returns true iff this String ends with the given suffix, not considering 265dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // case. Any String is considered to end with a NULL or empty suffix. 266dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter bool EndsWithCaseInsensitive(const char* suffix) const; 267dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 26846108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan // Returns the length of the encapsulated string, or 0 if the 269dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // string is NULL. 27046108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan size_t length() const { return length_; } 271dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 272dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // Gets the 0-terminated C string this String object represents. 273dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // The String object still owns the string. Therefore the caller 274dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // should NOT delete the return value. 275dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter const char* c_str() const { return c_str_; } 276dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 277dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // Assigns a C string to this object. Self-assignment works. 27846108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan const String& operator=(const char* a_c_str) { 27946108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan return *this = String(a_c_str); 28046108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan } 281dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 282dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter // Assigns a String object to this object. Self-assignment works. 28346108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan const String& operator=(const String& rhs) { 28446108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan if (this != &rhs) { 28546108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan delete[] c_str_; 28646108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan if (rhs.c_str() == NULL) { 28746108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan c_str_ = NULL; 28846108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan length_ = 0; 28946108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan } else { 29046108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan ConstructNonNull(rhs.c_str(), rhs.length()); 29146108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan } 29246108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan } 29346108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan 294dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter return *this; 295dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter } 296dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 297dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter private: 29846108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan // Constructs a non-NULL String from the given content. This 29946108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan // function can only be called when c_str_ has not been allocated. 30046108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan // ConstructNonNull(NULL, 0) results in an empty string (""). 30146108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan // ConstructNonNull(NULL, non_zero) is undefined behavior. 30246108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan void ConstructNonNull(const char* buffer, size_t a_length) { 30346108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan char* const str = new char[a_length + 1]; 30446108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan memcpy(str, buffer, a_length); 30546108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan str[a_length] = '\0'; 30646108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan c_str_ = str; 30746108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan length_ = a_length; 30846108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan } 309dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 31046108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan const char* c_str_; 31146108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan size_t length_; 31246108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan}; // class String 31346108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan 31446108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan// Streams a String to an ostream. Each '\0' character in the String 31546108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan// is replaced with "\\0". 31646108a219a4b812dd8f36fee479a0340ea5963f5Ben Chaninline ::std::ostream& operator<<(::std::ostream& os, const String& str) { 31746108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan if (str.c_str() == NULL) { 31846108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan os << "(null)"; 31946108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan } else { 32046108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan const char* const c_str = str.c_str(); 32146108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan for (size_t i = 0; i != str.length(); i++) { 32246108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan if (c_str[i] == '\0') { 32346108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan os << "\\0"; 32446108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan } else { 32546108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan os << c_str[i]; 32646108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan } 32746108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan } 32846108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan } 32946108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan return os; 330dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter} 331dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 33246108a219a4b812dd8f36fee479a0340ea5963f5Ben Chan// Gets the content of the stringstream's buffer as a String. Each '\0' 333dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// character in the buffer is replaced with "\\0". 33446108a219a4b812dd8f36fee479a0340ea5963f5Ben ChanGTEST_API_ String StringStreamToString(::std::stringstream* stream); 335dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 336dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// Converts a streamable value to a String. A NULL pointer is 337dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// converted to "(null)". When the input value is a ::string, 338dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// ::std::string, ::wstring, or ::std::wstring object, each NUL 339dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// character in it is replaced with "\\0". 340dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 341dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// Declared here but defined in gtest.h, so that it has access 342dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// to the definition of the Message class, required by the ARM 343dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter// compiler. 344dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixtertemplate <typename T> 345dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken MixterString StreamableToString(const T& streamable); 346dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 347dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter} // namespace internal 348dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter} // namespace testing 349dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter 350dd1c93d5709e32713961cfd95fe30489a4ad2d26Ken Mixter#endif // GTEST_INCLUDE_GTEST_INTERNAL_GTEST_STRING_H_ 351