1c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Copyright 2005, Google Inc. 2c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// All rights reserved. 3c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 4c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Redistribution and use in source and binary forms, with or without 5c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// modification, are permitted provided that the following conditions are 6c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// met: 7c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 8c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// * Redistributions of source code must retain the above copyright 9c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// notice, this list of conditions and the following disclaimer. 10c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// * Redistributions in binary form must reproduce the above 11c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// copyright notice, this list of conditions and the following disclaimer 12c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// in the documentation and/or other materials provided with the 13c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// distribution. 14c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// * Neither the name of Google Inc. nor the names of its 15c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// contributors may be used to endorse or promote products derived from 16c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// this software without specific prior written permission. 17c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 18c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 21c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 23c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 24c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 28c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 30c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Authors: wan@google.com (Zhanyong Wan), eefacm@gmail.com (Sean Mcafee) 31c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 32c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// The Google C++ Testing Framework (Google Test) 33c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 34c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// This header file declares the String class and functions used internally by 35c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Google Test. They are subject to change without notice. They should not used 36c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// by code external to Google Test. 37c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 38c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// This header file is #included by <gtest/internal/gtest-internal.h>. 39c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// It should not be #included by other files. 40c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 41c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#ifndef GTEST_INCLUDE_GTEST_INTERNAL_GTEST_STRING_H_ 42c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#define GTEST_INCLUDE_GTEST_INTERNAL_GTEST_STRING_H_ 43c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 443345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick#ifdef __BORLANDC__ 453345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick// string.h is not guaranteed to provide strcpy on C++ Builder. 46ddb351dbec246cf1fab5ec20d2d5520909041de1Kristian Monsen# include <mem.h> 473345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick#endif 483345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick 49c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#include <string.h> 50731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick#include "gtest/internal/gtest-port.h" 51c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 52c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#include <string> 53c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 54c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdochnamespace testing { 55c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdochnamespace internal { 56c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 57c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// String - a UTF-8 string class. 58c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 59c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// For historic reasons, we don't use std::string. 60c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 61c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// TODO(wan@google.com): replace this class with std::string or 62c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// implement it in terms of the latter. 63c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 64c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Note that String can represent both NULL and the empty string, 65c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// while std::string cannot represent NULL. 66c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 67c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// NULL and the empty string are considered different. NULL is less 68c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// than anything (including the empty string) except itself. 69c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 70c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// This class only provides minimum functionality necessary for 71c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// implementing Google Test. We do not intend to implement a full-fledged 72c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// string class here. 73c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 74c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Since the purpose of this class is to provide a substitute for 75c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// std::string on platforms where it cannot be used, we define a copy 76c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// constructor and assignment operators such that we don't need 77c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// conditional compilation in a lot of places. 78c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 79c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// In order to make the representation efficient, the d'tor of String 80c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// is not virtual. Therefore DO NOT INHERIT FROM String. 81c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdochclass GTEST_API_ String { 82c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch public: 83c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Static utility methods 84c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 85c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Returns the input enclosed in double quotes if it's not NULL; 86c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // otherwise returns "(null)". For example, "\"Hello\"" is returned 87c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // for input "Hello". 88c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // 89c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // This is useful for printing a C string in the syntax of a literal. 90c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // 91c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Known issue: escape sequences are not handled yet. 92c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch static String ShowCStringQuoted(const char* c_str); 93c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 94c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Clones a 0-terminated C string, allocating memory using new. The 95c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // caller is responsible for deleting the return value using 96c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // delete[]. Returns the cloned string, or NULL if the input is 97c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // NULL. 98c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // 99c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // This is different from strdup() in string.h, which allocates 100c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // memory using malloc(). 101c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch static const char* CloneCString(const char* c_str); 102c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 103c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#if GTEST_OS_WINDOWS_MOBILE 104c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Windows CE does not have the 'ANSI' versions of Win32 APIs. To be 105c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // able to pass strings to Win32 APIs on CE we need to convert them 106c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // to 'Unicode', UTF-16. 107c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 108c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Creates a UTF-16 wide string from the given ANSI string, allocating 109c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // memory using new. The caller is responsible for deleting the return 110c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // value using delete[]. Returns the wide string, or NULL if the 111c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // input is NULL. 112c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // 113c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // The wide string is created using the ANSI codepage (CP_ACP) to 114c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // match the behaviour of the ANSI versions of Win32 calls and the 115c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // C runtime. 116c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch static LPCWSTR AnsiToUtf16(const char* c_str); 117c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 118c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Creates an ANSI string from the given wide string, allocating 119c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // memory using new. The caller is responsible for deleting the return 120c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // value using delete[]. Returns the ANSI string, or NULL if the 121c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // input is NULL. 122c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // 123c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // The returned string is created using the ANSI codepage (CP_ACP) to 124c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // match the behaviour of the ANSI versions of Win32 calls and the 125c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // C runtime. 126c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch static const char* Utf16ToAnsi(LPCWSTR utf16_str); 127c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#endif 128c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 129c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Compares two C strings. Returns true iff they have the same content. 130c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // 131c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Unlike strcmp(), this function can handle NULL argument(s). A 132c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // NULL C string is considered different to any non-NULL C string, 133c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // including the empty string. 134c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch static bool CStringEquals(const char* lhs, const char* rhs); 135c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 136c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Converts a wide C string to a String using the UTF-8 encoding. 137c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // NULL will be converted to "(null)". If an error occurred during 138c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // the conversion, "(failed to convert from wide string)" is 139c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // returned. 140c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch static String ShowWideCString(const wchar_t* wide_c_str); 141c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 142c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Similar to ShowWideCString(), except that this function encloses 143c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // the converted string in double quotes. 144c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch static String ShowWideCStringQuoted(const wchar_t* wide_c_str); 145c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 146c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Compares two wide C strings. Returns true iff they have the same 147c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // content. 148c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // 149c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Unlike wcscmp(), this function can handle NULL argument(s). A 150c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // NULL C string is considered different to any non-NULL C string, 151c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // including the empty string. 152c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch static bool WideCStringEquals(const wchar_t* lhs, const wchar_t* rhs); 153c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 154c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Compares two C strings, ignoring case. Returns true iff they 155c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // have the same content. 156c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // 157c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Unlike strcasecmp(), this function can handle NULL argument(s). 158c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // A NULL C string is considered different to any non-NULL C string, 159c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // including the empty string. 160c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch static bool CaseInsensitiveCStringEquals(const char* lhs, 161c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch const char* rhs); 162c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 163c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Compares two wide C strings, ignoring case. Returns true iff they 164c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // have the same content. 165c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // 166c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Unlike wcscasecmp(), this function can handle NULL argument(s). 167c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // A NULL C string is considered different to any non-NULL wide C string, 168c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // including the empty string. 169c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // NB: The implementations on different platforms slightly differ. 170c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // On windows, this method uses _wcsicmp which compares according to LC_CTYPE 171c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // environment variable. On GNU platform this method uses wcscasecmp 172c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // which compares according to LC_CTYPE category of the current locale. 173c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // On MacOS X, it uses towlower, which also uses LC_CTYPE category of the 174c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // current locale. 175c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch static bool CaseInsensitiveWideCStringEquals(const wchar_t* lhs, 176c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch const wchar_t* rhs); 177c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 178c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Formats a list of arguments to a String, using the same format 179c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // spec string as for printf. 180c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // 181c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // We do not use the StringPrintf class as it is not universally 182c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // available. 183c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // 184c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // The result is limited to 4096 characters (including the tailing 185c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // 0). If 4096 characters are not enough to format the input, 186c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // "<buffer exceeded>" is returned. 187c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch static String Format(const char* format, ...); 188c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 189c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // C'tors 190c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 191c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // The default c'tor constructs a NULL string. 192c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch String() : c_str_(NULL), length_(0) {} 193c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 194c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Constructs a String by cloning a 0-terminated C string. 195c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch String(const char* a_c_str) { // NOLINT 196c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch if (a_c_str == NULL) { 197c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch c_str_ = NULL; 198c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch length_ = 0; 199c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch } else { 200c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch ConstructNonNull(a_c_str, strlen(a_c_str)); 201c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch } 202c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch } 203c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 204c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Constructs a String by copying a given number of chars from a 205c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // buffer. E.g. String("hello", 3) creates the string "hel", 206c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // String("a\0bcd", 4) creates "a\0bc", String(NULL, 0) creates "", 207c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // and String(NULL, 1) results in access violation. 208c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch String(const char* buffer, size_t a_length) { 209c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch ConstructNonNull(buffer, a_length); 210c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch } 211c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 212c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // The copy c'tor creates a new copy of the string. The two 213c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // String objects do not share content. 214c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch String(const String& str) : c_str_(NULL), length_(0) { *this = str; } 215c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 216c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // D'tor. String is intended to be a final class, so the d'tor 217c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // doesn't need to be virtual. 218c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch ~String() { delete[] c_str_; } 219c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 220c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Allows a String to be implicitly converted to an ::std::string or 221c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // ::string, and vice versa. Converting a String containing a NULL 222c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // pointer to ::std::string or ::string is undefined behavior. 223c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Converting a ::std::string or ::string containing an embedded NUL 224c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // character to a String will result in the prefix up to the first 225c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // NUL character. 226c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch String(const ::std::string& str) { 227c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch ConstructNonNull(str.c_str(), str.length()); 228c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch } 229c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 230c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch operator ::std::string() const { return ::std::string(c_str(), length()); } 231c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 232c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#if GTEST_HAS_GLOBAL_STRING 233c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch String(const ::string& str) { 234c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch ConstructNonNull(str.c_str(), str.length()); 235c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch } 236c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 237c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch operator ::string() const { return ::string(c_str(), length()); } 238c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#endif // GTEST_HAS_GLOBAL_STRING 239c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 240c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Returns true iff this is an empty string (i.e. ""). 241c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch bool empty() const { return (c_str() != NULL) && (length() == 0); } 242c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 243c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Compares this with another String. 244c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Returns < 0 if this is less than rhs, 0 if this is equal to rhs, or > 0 245c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // if this is greater than rhs. 246c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch int Compare(const String& rhs) const; 247c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 248c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Returns true iff this String equals the given C string. A NULL 249c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // string and a non-NULL string are considered not equal. 250c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch bool operator==(const char* a_c_str) const { return Compare(a_c_str) == 0; } 251c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 252c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Returns true iff this String is less than the given String. A 253c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // NULL string is considered less than "". 254c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch bool operator<(const String& rhs) const { return Compare(rhs) < 0; } 255c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 256c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Returns true iff this String doesn't equal the given C string. A NULL 257c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // string and a non-NULL string are considered not equal. 258c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch bool operator!=(const char* a_c_str) const { return !(*this == a_c_str); } 259c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 260c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Returns true iff this String ends with the given suffix. *Any* 261c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // String is considered to end with a NULL or empty suffix. 262c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch bool EndsWith(const char* suffix) const; 263c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 264c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Returns true iff this String ends with the given suffix, not considering 265c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // case. Any String is considered to end with a NULL or empty suffix. 266c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch bool EndsWithCaseInsensitive(const char* suffix) const; 267c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 268c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Returns the length of the encapsulated string, or 0 if the 269c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // string is NULL. 270c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch size_t length() const { return length_; } 271c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 272c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Gets the 0-terminated C string this String object represents. 273c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // The String object still owns the string. Therefore the caller 274c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // should NOT delete the return value. 275c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch const char* c_str() const { return c_str_; } 276c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 277c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Assigns a C string to this object. Self-assignment works. 278c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch const String& operator=(const char* a_c_str) { 279c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch return *this = String(a_c_str); 280c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch } 281c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 282c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Assigns a String object to this object. Self-assignment works. 283c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch const String& operator=(const String& rhs) { 284c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch if (this != &rhs) { 285c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch delete[] c_str_; 286c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch if (rhs.c_str() == NULL) { 287c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch c_str_ = NULL; 288c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch length_ = 0; 289c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch } else { 290c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch ConstructNonNull(rhs.c_str(), rhs.length()); 291c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch } 292c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch } 293c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 294c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch return *this; 295c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch } 296c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 297c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch private: 298c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Constructs a non-NULL String from the given content. This 299ddb351dbec246cf1fab5ec20d2d5520909041de1Kristian Monsen // function can only be called when c_str_ has not been allocated. 300c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // ConstructNonNull(NULL, 0) results in an empty string (""). 301c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // ConstructNonNull(NULL, non_zero) is undefined behavior. 302c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch void ConstructNonNull(const char* buffer, size_t a_length) { 303c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch char* const str = new char[a_length + 1]; 304c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch memcpy(str, buffer, a_length); 305c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch str[a_length] = '\0'; 306c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch c_str_ = str; 307c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch length_ = a_length; 308c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch } 309c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 310c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch const char* c_str_; 311c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch size_t length_; 312c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch}; // class String 313c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 314c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Streams a String to an ostream. Each '\0' character in the String 315c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// is replaced with "\\0". 316c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdochinline ::std::ostream& operator<<(::std::ostream& os, const String& str) { 317c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch if (str.c_str() == NULL) { 318c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch os << "(null)"; 319c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch } else { 320c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch const char* const c_str = str.c_str(); 321c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch for (size_t i = 0; i != str.length(); i++) { 322c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch if (c_str[i] == '\0') { 323c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch os << "\\0"; 324c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch } else { 325c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch os << c_str[i]; 326c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch } 327c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch } 328c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch } 329c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch return os; 330c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch} 331c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 332731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick// Gets the content of the stringstream's buffer as a String. Each '\0' 333c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// character in the buffer is replaced with "\\0". 334731df977c0511bca2206b5f333555b1205ff1f43Iain MerrickGTEST_API_ String StringStreamToString(::std::stringstream* stream); 335c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 336c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Converts a streamable value to a String. A NULL pointer is 337c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// converted to "(null)". When the input value is a ::string, 338c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// ::std::string, ::wstring, or ::std::wstring object, each NUL 339c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// character in it is replaced with "\\0". 340c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 341c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Declared here but defined in gtest.h, so that it has access 342c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// to the definition of the Message class, required by the ARM 343c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// compiler. 344c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdochtemplate <typename T> 345c407dc5cd9bdc5668497f21b26b09d988ab439deBen MurdochString StreamableToString(const T& streamable); 346c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 347c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch} // namespace internal 348c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch} // namespace testing 349c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 350c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#endif // GTEST_INCLUDE_GTEST_INTERNAL_GTEST_STRING_H_ 351