1 // Copyright 2005, Google Inc. 2 // All rights reserved. 3 // 4 // Redistribution and use in source and binary forms, with or without 5 // modification, are permitted provided that the following conditions are 6 // met: 7 // 8 // * Redistributions of source code must retain the above copyright 9 // notice, this list of conditions and the following disclaimer. 10 // * Redistributions in binary form must reproduce the above 11 // copyright notice, this list of conditions and the following disclaimer 12 // in the documentation and/or other materials provided with the 13 // distribution. 14 // * Neither the name of Google Inc. nor the names of its 15 // contributors may be used to endorse or promote products derived from 16 // this software without specific prior written permission. 17 // 18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 21 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 24 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 28 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29 30 // The Google C++ Testing and Mocking Framework (Google Test) 31 // 32 // This header file declares the String class and functions used internally by 33 // Google Test. They are subject to change without notice. They should not used 34 // by code external to Google Test. 35 // 36 // This header file is #included by gtest-internal.h. 37 // It should not be #included by other files. 38 39 // IWYU pragma: private, include "gtest/gtest.h" 40 // IWYU pragma: friend gtest/.* 41 // IWYU pragma: friend gmock/.* 42 43 #ifndef GOOGLETEST_INCLUDE_GTEST_INTERNAL_GTEST_STRING_H_ 44 #define GOOGLETEST_INCLUDE_GTEST_INTERNAL_GTEST_STRING_H_ 45 46 #ifdef __BORLANDC__ 47 // string.h is not guaranteed to provide strcpy on C++ Builder. 48 # include <mem.h> 49 #endif 50 51 #include <string.h> 52 #include <cstdint> 53 #include <string> 54 55 #include "gtest/internal/gtest-port.h" 56 57 namespace testing { 58 namespace internal { 59 60 // String - an abstract class holding static string utilities. 61 class GTEST_API_ String { 62 public: 63 // Static utility methods 64 65 // Clones a 0-terminated C string, allocating memory using new. The 66 // caller is responsible for deleting the return value using 67 // delete[]. Returns the cloned string, or NULL if the input is 68 // NULL. 69 // 70 // This is different from strdup() in string.h, which allocates 71 // memory using malloc(). 72 static const char* CloneCString(const char* c_str); 73 74 #if GTEST_OS_WINDOWS_MOBILE 75 // Windows CE does not have the 'ANSI' versions of Win32 APIs. To be 76 // able to pass strings to Win32 APIs on CE we need to convert them 77 // to 'Unicode', UTF-16. 78 79 // Creates a UTF-16 wide string from the given ANSI string, allocating 80 // memory using new. The caller is responsible for deleting the return 81 // value using delete[]. Returns the wide string, or NULL if the 82 // input is NULL. 83 // 84 // The wide string is created using the ANSI codepage (CP_ACP) to 85 // match the behaviour of the ANSI versions of Win32 calls and the 86 // C runtime. 87 static LPCWSTR AnsiToUtf16(const char* c_str); 88 89 // Creates an ANSI string from the given wide string, allocating 90 // memory using new. The caller is responsible for deleting the return 91 // value using delete[]. Returns the ANSI string, or NULL if the 92 // input is NULL. 93 // 94 // The returned string is created using the ANSI codepage (CP_ACP) to 95 // match the behaviour of the ANSI versions of Win32 calls and the 96 // C runtime. 97 static const char* Utf16ToAnsi(LPCWSTR utf16_str); 98 #endif 99 100 // Compares two C strings. Returns true if and only if they have the same 101 // content. 102 // 103 // Unlike strcmp(), this function can handle NULL argument(s). A 104 // NULL C string is considered different to any non-NULL C string, 105 // including the empty string. 106 static bool CStringEquals(const char* lhs, const char* rhs); 107 108 // Converts a wide C string to a String using the UTF-8 encoding. 109 // NULL will be converted to "(null)". If an error occurred during 110 // the conversion, "(failed to convert from wide string)" is 111 // returned. 112 static std::string ShowWideCString(const wchar_t* wide_c_str); 113 114 // Compares two wide C strings. Returns true if and only if they have the 115 // same content. 116 // 117 // Unlike wcscmp(), this function can handle NULL argument(s). A 118 // NULL C string is considered different to any non-NULL C string, 119 // including the empty string. 120 static bool WideCStringEquals(const wchar_t* lhs, const wchar_t* rhs); 121 122 // Compares two C strings, ignoring case. Returns true if and only if 123 // they have the same content. 124 // 125 // Unlike strcasecmp(), this function can handle NULL argument(s). 126 // A NULL C string is considered different to any non-NULL C string, 127 // including the empty string. 128 static bool CaseInsensitiveCStringEquals(const char* lhs, 129 const char* rhs); 130 131 // Compares two wide C strings, ignoring case. Returns true if and only if 132 // they have the same content. 133 // 134 // Unlike wcscasecmp(), this function can handle NULL argument(s). 135 // A NULL C string is considered different to any non-NULL wide C string, 136 // including the empty string. 137 // NB: The implementations on different platforms slightly differ. 138 // On windows, this method uses _wcsicmp which compares according to LC_CTYPE 139 // environment variable. On GNU platform this method uses wcscasecmp 140 // which compares according to LC_CTYPE category of the current locale. 141 // On MacOS X, it uses towlower, which also uses LC_CTYPE category of the 142 // current locale. 143 static bool CaseInsensitiveWideCStringEquals(const wchar_t* lhs, 144 const wchar_t* rhs); 145 146 // Returns true if and only if the given string ends with the given suffix, 147 // ignoring case. Any string is considered to end with an empty suffix. 148 static bool EndsWithCaseInsensitive( 149 const std::string& str, const std::string& suffix); 150 151 // Formats an int value as "%02d". 152 static std::string FormatIntWidth2(int value); // "%02d" for width == 2 153 154 // Formats an int value to given width with leading zeros. 155 static std::string FormatIntWidthN(int value, int width); 156 157 // Formats an int value as "%X". 158 static std::string FormatHexInt(int value); 159 160 // Formats an int value as "%X". 161 static std::string FormatHexUInt32(uint32_t value); 162 163 // Formats a byte as "%02X". 164 static std::string FormatByte(unsigned char value); 165 166 private: 167 String(); // Not meant to be instantiated. 168 }; // class String 169 170 // Gets the content of the stringstream's buffer as an std::string. Each '\0' 171 // character in the buffer is replaced with "\\0". 172 GTEST_API_ std::string StringStreamToString(::std::stringstream* stream); 173 174 } // namespace internal 175 } // namespace testing 176 177 #endif // GOOGLETEST_INCLUDE_GTEST_INTERNAL_GTEST_STRING_H_ 178