1b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// Copyright 2013 The Chromium Authors. All rights reserved. 2b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// Use of this source code is governed by a BSD-style license that can be 3b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// found in the LICENSE file. 4b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// 5b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// This file defines utility functions for working with strings. 6b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 7b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat#ifndef BASE_STRINGS_STRING_UTIL_H_ 8b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat#define BASE_STRINGS_STRING_UTIL_H_ 9b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 10b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat#include <ctype.h> 11b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat#include <stdarg.h> // va_list 120d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko#include <stddef.h> 130d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko#include <stdint.h> 14b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 15b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat#include <string> 16b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat#include <vector> 17b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 18b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat#include "base/base_export.h" 19b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat#include "base/compiler_specific.h" 20b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat#include "base/strings/string16.h" 21b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat#include "base/strings/string_piece.h" // For implicit conversions. 220d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko#include "build/build_config.h" 23b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 2494ffa55491333f3dcc701befd0d2652922916d99Luis Hector Chavez#if defined(ANDROID) 25b910a63ff3111067e79c016f40a7c1baac943405Daniel Erat// On Android, bionic's stdio.h defines an snprintf macro when being built with 26b910a63ff3111067e79c016f40a7c1baac943405Daniel Erat// clang. Undefine it here so it won't collide with base::snprintf(). 27b910a63ff3111067e79c016f40a7c1baac943405Daniel Erat#undef snprintf 2894ffa55491333f3dcc701befd0d2652922916d99Luis Hector Chavez#endif // defined(ANDROID) 29b910a63ff3111067e79c016f40a7c1baac943405Daniel Erat 30b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Eratnamespace base { 31b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 320d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// C standard-library functions that aren't cross-platform are provided as 330d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// "base::...", and their prototypes are listed below. These functions are 340d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// then implemented as inline calls to the platform-specific equivalents in the 350d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// platform-specific headers. 36b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 37b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// Wrapper for vsnprintf that always null-terminates and always returns the 38b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// number of characters that would be in an untruncated formatted 39b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// string, even when truncation occurs. 40b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Eratint vsnprintf(char* buffer, size_t size, const char* format, va_list arguments) 41b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat PRINTF_FORMAT(3, 0); 42b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 43b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// Some of these implementations need to be inlined. 44b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 45b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// We separate the declaration from the implementation of this inline 46b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// function just so the PRINTF_FORMAT works. 470d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenkoinline int snprintf(char* buffer, 480d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko size_t size, 490d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko _Printf_format_string_ const char* format, 500d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko ...) PRINTF_FORMAT(3, 4); 510d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenkoinline int snprintf(char* buffer, 520d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko size_t size, 530d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko _Printf_format_string_ const char* format, 540d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko ...) { 55b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat va_list arguments; 56b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat va_start(arguments, format); 57b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat int result = vsnprintf(buffer, size, format, arguments); 58b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat va_end(arguments); 59b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat return result; 60b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat} 61b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 62b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// BSD-style safe and consistent string copy functions. 63b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// Copies |src| to |dst|, where |dst_size| is the total allocated size of |dst|. 64b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// Copies at most |dst_size|-1 characters, and always NULL terminates |dst|, as 65b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// long as |dst_size| is not 0. Returns the length of |src| in characters. 66b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// If the return value is >= dst_size, then the output was truncated. 67b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// NOTE: All sizes are in number of characters, NOT in bytes. 68b8cf94937c52feb53b55c39e3f82094d27de464cDaniel EratBASE_EXPORT size_t strlcpy(char* dst, const char* src, size_t dst_size); 69b8cf94937c52feb53b55c39e3f82094d27de464cDaniel EratBASE_EXPORT size_t wcslcpy(wchar_t* dst, const wchar_t* src, size_t dst_size); 70b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 71b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// Scan a wprintf format string to determine whether it's portable across a 72b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// variety of systems. This function only checks that the conversion 73b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// specifiers used by the format string are supported and have the same meaning 74b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// on a variety of systems. It doesn't check for other errors that might occur 75b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// within a format string. 76b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// 77b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// Nonportable conversion specifiers for wprintf are: 78b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// - 's' and 'c' without an 'l' length modifier. %s and %c operate on char 79b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// data on all systems except Windows, which treat them as wchar_t data. 80b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// Use %ls and %lc for wchar_t data instead. 81b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// - 'S' and 'C', which operate on wchar_t data on all systems except Windows, 82b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// which treat them as char data. Use %ls and %lc for wchar_t data 83b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// instead. 84b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// - 'F', which is not identified by Windows wprintf documentation. 85b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// - 'D', 'O', and 'U', which are deprecated and not available on all systems. 86b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// Use %ld, %lo, and %lu instead. 87b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// 88b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// Note that there is no portable conversion specifier for char data when 89b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// working with wprintf. 90b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// 91b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// This function is intended to be called from base::vswprintf. 92b8cf94937c52feb53b55c39e3f82094d27de464cDaniel EratBASE_EXPORT bool IsWprintfFormatPortable(const wchar_t* format); 93b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 94b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// ASCII-specific tolower. The standard library's tolower is locale sensitive, 95b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// so we don't want to use it here. 960d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenkoinline char ToLowerASCII(char c) { 970d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko return (c >= 'A' && c <= 'Z') ? (c + ('a' - 'A')) : c; 980d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko} 990d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenkoinline char16 ToLowerASCII(char16 c) { 100b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat return (c >= 'A' && c <= 'Z') ? (c + ('a' - 'A')) : c; 101b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat} 102b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 103b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// ASCII-specific toupper. The standard library's toupper is locale sensitive, 104b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// so we don't want to use it here. 1050d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenkoinline char ToUpperASCII(char c) { 1060d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko return (c >= 'a' && c <= 'z') ? (c + ('A' - 'a')) : c; 1070d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko} 1080d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenkoinline char16 ToUpperASCII(char16 c) { 109b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat return (c >= 'a' && c <= 'z') ? (c + ('A' - 'a')) : c; 110b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat} 111b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 1120d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// Converts the given string to it's ASCII-lowercase equivalent. 1130d205d712abd16eeed2f5d5b1052a367d23a223fAlex VakulenkoBASE_EXPORT std::string ToLowerASCII(StringPiece str); 1140d205d712abd16eeed2f5d5b1052a367d23a223fAlex VakulenkoBASE_EXPORT string16 ToLowerASCII(StringPiece16 str); 115b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 1160d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// Converts the given string to it's ASCII-uppercase equivalent. 1170d205d712abd16eeed2f5d5b1052a367d23a223fAlex VakulenkoBASE_EXPORT std::string ToUpperASCII(StringPiece str); 1180d205d712abd16eeed2f5d5b1052a367d23a223fAlex VakulenkoBASE_EXPORT string16 ToUpperASCII(StringPiece16 str); 119b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 1200d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// Functor for case-insensitive ASCII comparisons for STL algorithms like 1210d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// std::search. 1220d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// 1230d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// Note that a full Unicode version of this functor is not possible to write 1240d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// because case mappings might change the number of characters, depend on 1250d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// context (combining accents), and require handling UTF-16. If you need 1260d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// proper Unicode support, use base::i18n::ToLower/FoldCase and then just 1270d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// use a normal operator== on the result. 128b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erattemplate<typename Char> struct CaseInsensitiveCompareASCII { 129b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat public: 130b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat bool operator()(Char x, Char y) const { 131b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat return ToLowerASCII(x) == ToLowerASCII(y); 132b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat } 133b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat}; 134b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 1350d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// Like strcasecmp for case-insensitive ASCII characters only. Returns: 1360d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// -1 (a < b) 1370d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// 0 (a == b) 1380d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// 1 (a > b) 1390d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// (unlike strcasecmp which can return values greater or less than 1/-1). For 1400d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// full Unicode support, use base::i18n::ToLower or base::i18h::FoldCase 1410d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// and then just call the normal string operators on the result. 1420d205d712abd16eeed2f5d5b1052a367d23a223fAlex VakulenkoBASE_EXPORT int CompareCaseInsensitiveASCII(StringPiece a, StringPiece b); 1430d205d712abd16eeed2f5d5b1052a367d23a223fAlex VakulenkoBASE_EXPORT int CompareCaseInsensitiveASCII(StringPiece16 a, StringPiece16 b); 1440d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko 1450d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// Equality for ASCII case-insensitive comparisons. For full Unicode support, 1460d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// use base::i18n::ToLower or base::i18h::FoldCase and then compare with either 1470d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// == or !=. 1480d205d712abd16eeed2f5d5b1052a367d23a223fAlex VakulenkoBASE_EXPORT bool EqualsCaseInsensitiveASCII(StringPiece a, StringPiece b); 1490d205d712abd16eeed2f5d5b1052a367d23a223fAlex VakulenkoBASE_EXPORT bool EqualsCaseInsensitiveASCII(StringPiece16 a, StringPiece16 b); 1500d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko 151b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// These threadsafe functions return references to globally unique empty 152b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// strings. 153b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// 154b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// It is likely faster to construct a new empty string object (just a few 155b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// instructions to set the length to 0) than to get the empty string singleton 156b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// returned by these functions (which requires threadsafe singleton access). 157b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// 158b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// Therefore, DO NOT USE THESE AS A GENERAL-PURPOSE SUBSTITUTE FOR DEFAULT 159b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// CONSTRUCTORS. There is only one case where you should use these: functions 160b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// which need to return a string by reference (e.g. as a class member 161b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// accessor), and don't have an empty string to use (e.g. in an error case). 162b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// These should not be used as initializers, function arguments, or return 163b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// values for functions which return by value or outparam. 164b8cf94937c52feb53b55c39e3f82094d27de464cDaniel EratBASE_EXPORT const std::string& EmptyString(); 165b8cf94937c52feb53b55c39e3f82094d27de464cDaniel EratBASE_EXPORT const string16& EmptyString16(); 166b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 167b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// Contains the set of characters representing whitespace in the corresponding 168b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// encoding. Null-terminated. The ASCII versions are the whitespaces as defined 169b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// by HTML5, and don't include control characters. 170b8cf94937c52feb53b55c39e3f82094d27de464cDaniel EratBASE_EXPORT extern const wchar_t kWhitespaceWide[]; // Includes Unicode. 171b8cf94937c52feb53b55c39e3f82094d27de464cDaniel EratBASE_EXPORT extern const char16 kWhitespaceUTF16[]; // Includes Unicode. 172b8cf94937c52feb53b55c39e3f82094d27de464cDaniel EratBASE_EXPORT extern const char kWhitespaceASCII[]; 173b8cf94937c52feb53b55c39e3f82094d27de464cDaniel EratBASE_EXPORT extern const char16 kWhitespaceASCIIAs16[]; // No unicode. 174b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 175b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// Null-terminated string representing the UTF-8 byte order mark. 176b8cf94937c52feb53b55c39e3f82094d27de464cDaniel EratBASE_EXPORT extern const char kUtf8ByteOrderMark[]; 177b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 178b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// Removes characters in |remove_chars| from anywhere in |input|. Returns true 179b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// if any characters were removed. |remove_chars| must be null-terminated. 180b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// NOTE: Safe to use the same variable for both |input| and |output|. 181b8cf94937c52feb53b55c39e3f82094d27de464cDaniel EratBASE_EXPORT bool RemoveChars(const string16& input, 1820d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko const StringPiece16& remove_chars, 183b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat string16* output); 184b8cf94937c52feb53b55c39e3f82094d27de464cDaniel EratBASE_EXPORT bool RemoveChars(const std::string& input, 1850d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko const StringPiece& remove_chars, 186b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat std::string* output); 187b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 188b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// Replaces characters in |replace_chars| from anywhere in |input| with 189b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// |replace_with|. Each character in |replace_chars| will be replaced with 190b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// the |replace_with| string. Returns true if any characters were replaced. 191b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// |replace_chars| must be null-terminated. 192b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// NOTE: Safe to use the same variable for both |input| and |output|. 193b8cf94937c52feb53b55c39e3f82094d27de464cDaniel EratBASE_EXPORT bool ReplaceChars(const string16& input, 1940d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko const StringPiece16& replace_chars, 195b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat const string16& replace_with, 196b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat string16* output); 197b8cf94937c52feb53b55c39e3f82094d27de464cDaniel EratBASE_EXPORT bool ReplaceChars(const std::string& input, 1980d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko const StringPiece& replace_chars, 199b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat const std::string& replace_with, 200b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat std::string* output); 201b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 202b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Eratenum TrimPositions { 203b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat TRIM_NONE = 0, 204b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat TRIM_LEADING = 1 << 0, 205b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat TRIM_TRAILING = 1 << 1, 206b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat TRIM_ALL = TRIM_LEADING | TRIM_TRAILING, 207b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat}; 208b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 209b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// Removes characters in |trim_chars| from the beginning and end of |input|. 210b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// The 8-bit version only works on 8-bit characters, not UTF-8. 211b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// 212b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// It is safe to use the same variable for both |input| and |output| (this is 213b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// the normal usage to trim in-place). 214b8cf94937c52feb53b55c39e3f82094d27de464cDaniel EratBASE_EXPORT bool TrimString(const string16& input, 2150d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko StringPiece16 trim_chars, 216b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat string16* output); 217b8cf94937c52feb53b55c39e3f82094d27de464cDaniel EratBASE_EXPORT bool TrimString(const std::string& input, 2180d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko StringPiece trim_chars, 219b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat std::string* output); 220b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 221b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// StringPiece versions of the above. The returned pieces refer to the original 222b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// buffer. 223b8cf94937c52feb53b55c39e3f82094d27de464cDaniel EratBASE_EXPORT StringPiece16 TrimString(StringPiece16 input, 2240d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko const StringPiece16& trim_chars, 225b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat TrimPositions positions); 226b8cf94937c52feb53b55c39e3f82094d27de464cDaniel EratBASE_EXPORT StringPiece TrimString(StringPiece input, 2270d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko const StringPiece& trim_chars, 228b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat TrimPositions positions); 229b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 230b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// Truncates a string to the nearest UTF-8 character that will leave 231b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// the string less than or equal to the specified byte size. 232b8cf94937c52feb53b55c39e3f82094d27de464cDaniel EratBASE_EXPORT void TruncateUTF8ToByteSize(const std::string& input, 233b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat const size_t byte_size, 234b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat std::string* output); 235b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 2360d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// Trims any whitespace from either end of the input string. 2370d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// 2380d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// The StringPiece versions return a substring referencing the input buffer. 2390d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// The ASCII versions look only for ASCII whitespace. 2400d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// 2410d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// The std::string versions return where whitespace was found. 242b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// NOTE: Safe to use the same variable for both input and output. 243b8cf94937c52feb53b55c39e3f82094d27de464cDaniel EratBASE_EXPORT TrimPositions TrimWhitespace(const string16& input, 244b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat TrimPositions positions, 2450d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko string16* output); 2460d205d712abd16eeed2f5d5b1052a367d23a223fAlex VakulenkoBASE_EXPORT StringPiece16 TrimWhitespace(StringPiece16 input, 2470d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko TrimPositions positions); 248b8cf94937c52feb53b55c39e3f82094d27de464cDaniel EratBASE_EXPORT TrimPositions TrimWhitespaceASCII(const std::string& input, 249b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat TrimPositions positions, 250b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat std::string* output); 2510d205d712abd16eeed2f5d5b1052a367d23a223fAlex VakulenkoBASE_EXPORT StringPiece TrimWhitespaceASCII(StringPiece input, 2520d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko TrimPositions positions); 253b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 254b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// Searches for CR or LF characters. Removes all contiguous whitespace 255b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// strings that contain them. This is useful when trying to deal with text 256b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// copied from terminals. 257b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// Returns |text|, with the following three transformations: 258b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// (1) Leading and trailing whitespace is trimmed. 259b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// (2) If |trim_sequences_with_line_breaks| is true, any other whitespace 260b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// sequences containing a CR or LF are trimmed. 261b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// (3) All other whitespace sequences are converted to single spaces. 262b8cf94937c52feb53b55c39e3f82094d27de464cDaniel EratBASE_EXPORT string16 CollapseWhitespace( 263b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat const string16& text, 264b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat bool trim_sequences_with_line_breaks); 265b8cf94937c52feb53b55c39e3f82094d27de464cDaniel EratBASE_EXPORT std::string CollapseWhitespaceASCII( 266b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat const std::string& text, 267b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat bool trim_sequences_with_line_breaks); 268b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 269b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// Returns true if |input| is empty or contains only characters found in 270b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// |characters|. 271b8cf94937c52feb53b55c39e3f82094d27de464cDaniel EratBASE_EXPORT bool ContainsOnlyChars(const StringPiece& input, 272b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat const StringPiece& characters); 273b8cf94937c52feb53b55c39e3f82094d27de464cDaniel EratBASE_EXPORT bool ContainsOnlyChars(const StringPiece16& input, 274b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat const StringPiece16& characters); 275b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 276b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// Returns true if the specified string matches the criteria. How can a wide 277b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// string be 8-bit or UTF8? It contains only characters that are < 256 (in the 278b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// first case) or characters that use only 8-bits and whose 8-bit 279b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// representation looks like a UTF-8 string (the second case). 280b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// 281b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// Note that IsStringUTF8 checks not only if the input is structurally 282b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// valid but also if it doesn't contain any non-character codepoint 283b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// (e.g. U+FFFE). It's done on purpose because all the existing callers want 284b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// to have the maximum 'discriminating' power from other encodings. If 285b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// there's a use case for just checking the structural validity, we have to 286b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// add a new function for that. 287b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// 288b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// IsStringASCII assumes the input is likely all ASCII, and does not leave early 289b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// if it is not the case. 290b8cf94937c52feb53b55c39e3f82094d27de464cDaniel EratBASE_EXPORT bool IsStringUTF8(const StringPiece& str); 291b8cf94937c52feb53b55c39e3f82094d27de464cDaniel EratBASE_EXPORT bool IsStringASCII(const StringPiece& str); 292b8cf94937c52feb53b55c39e3f82094d27de464cDaniel EratBASE_EXPORT bool IsStringASCII(const StringPiece16& str); 293b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// A convenience adaptor for WebStrings, as they don't convert into 294b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// StringPieces directly. 295b8cf94937c52feb53b55c39e3f82094d27de464cDaniel EratBASE_EXPORT bool IsStringASCII(const string16& str); 296b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat#if defined(WCHAR_T_IS_UTF32) 297b8cf94937c52feb53b55c39e3f82094d27de464cDaniel EratBASE_EXPORT bool IsStringASCII(const std::wstring& str); 298b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat#endif 299b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 3000d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// Compare the lower-case form of the given string against the given 3010d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// previously-lower-cased ASCII string (typically a constant). 3020d205d712abd16eeed2f5d5b1052a367d23a223fAlex VakulenkoBASE_EXPORT bool LowerCaseEqualsASCII(StringPiece str, 3030d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko StringPiece lowecase_ascii); 3040d205d712abd16eeed2f5d5b1052a367d23a223fAlex VakulenkoBASE_EXPORT bool LowerCaseEqualsASCII(StringPiece16 str, 3050d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko StringPiece lowecase_ascii); 3060d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko 3070d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// Performs a case-sensitive string compare of the given 16-bit string against 3080d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// the given 8-bit ASCII string (typically a constant). The behavior is 3090d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// undefined if the |ascii| string is not ASCII. 3100d205d712abd16eeed2f5d5b1052a367d23a223fAlex VakulenkoBASE_EXPORT bool EqualsASCII(StringPiece16 str, StringPiece ascii); 3110d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko 3120d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// Indicates case sensitivity of comparisons. Only ASCII case insensitivity 3130d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// is supported. Full Unicode case-insensitive conversions would need to go in 3140d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// base/i18n so it can use ICU. 315b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// 3160d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// If you need to do Unicode-aware case-insensitive StartsWith/EndsWith, it's 3170d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// best to call base::i18n::ToLower() or base::i18n::FoldCase() (see 3180d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// base/i18n/case_conversion.h for usage advice) on the arguments, and then use 3190d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// the results to a case-sensitive comparison. 3200d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenkoenum class CompareCase { 3210d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko SENSITIVE, 3220d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko INSENSITIVE_ASCII, 3230d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko}; 324b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 3250d205d712abd16eeed2f5d5b1052a367d23a223fAlex VakulenkoBASE_EXPORT bool StartsWith(StringPiece str, 3260d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko StringPiece search_for, 3270d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko CompareCase case_sensitivity); 3280d205d712abd16eeed2f5d5b1052a367d23a223fAlex VakulenkoBASE_EXPORT bool StartsWith(StringPiece16 str, 3290d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko StringPiece16 search_for, 3300d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko CompareCase case_sensitivity); 3310d205d712abd16eeed2f5d5b1052a367d23a223fAlex VakulenkoBASE_EXPORT bool EndsWith(StringPiece str, 3320d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko StringPiece search_for, 3330d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko CompareCase case_sensitivity); 3340d205d712abd16eeed2f5d5b1052a367d23a223fAlex VakulenkoBASE_EXPORT bool EndsWith(StringPiece16 str, 3350d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko StringPiece16 search_for, 3360d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko CompareCase case_sensitivity); 337b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 338b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// Determines the type of ASCII character, independent of locale (the C 339b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// library versions will change based on locale). 340b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erattemplate <typename Char> 341b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Eratinline bool IsAsciiWhitespace(Char c) { 342b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat return c == ' ' || c == '\r' || c == '\n' || c == '\t'; 343b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat} 344b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erattemplate <typename Char> 345b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Eratinline bool IsAsciiAlpha(Char c) { 34694ffa55491333f3dcc701befd0d2652922916d99Luis Hector Chavez return (c >= 'A' && c <= 'Z') || (c >= 'a' && c <= 'z'); 34794ffa55491333f3dcc701befd0d2652922916d99Luis Hector Chavez} 34894ffa55491333f3dcc701befd0d2652922916d99Luis Hector Chaveztemplate <typename Char> 34994ffa55491333f3dcc701befd0d2652922916d99Luis Hector Chavezinline bool IsAsciiUpper(Char c) { 35094ffa55491333f3dcc701befd0d2652922916d99Luis Hector Chavez return c >= 'A' && c <= 'Z'; 35194ffa55491333f3dcc701befd0d2652922916d99Luis Hector Chavez} 35294ffa55491333f3dcc701befd0d2652922916d99Luis Hector Chaveztemplate <typename Char> 35394ffa55491333f3dcc701befd0d2652922916d99Luis Hector Chavezinline bool IsAsciiLower(Char c) { 35494ffa55491333f3dcc701befd0d2652922916d99Luis Hector Chavez return c >= 'a' && c <= 'z'; 355b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat} 356b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erattemplate <typename Char> 357b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Eratinline bool IsAsciiDigit(Char c) { 358b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat return c >= '0' && c <= '9'; 359b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat} 360b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 361b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erattemplate <typename Char> 362b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Eratinline bool IsHexDigit(Char c) { 363b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat return (c >= '0' && c <= '9') || 364b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat (c >= 'A' && c <= 'F') || 365b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat (c >= 'a' && c <= 'f'); 366b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat} 367b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 3680d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// Returns the integer corresponding to the given hex character. For example: 3690d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// '4' -> 4 3700d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// 'a' -> 10 3710d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// 'B' -> 11 3720d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// Assumes the input is a valid hex character. DCHECKs in debug builds if not. 3730d205d712abd16eeed2f5d5b1052a367d23a223fAlex VakulenkoBASE_EXPORT char HexDigitToInt(wchar_t c); 374b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 3750d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko// Returns true if it's a Unicode whitespace character. 3760d205d712abd16eeed2f5d5b1052a367d23a223fAlex VakulenkoBASE_EXPORT bool IsUnicodeWhitespace(wchar_t c); 377b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 378b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// Return a byte string in human-readable format with a unit suffix. Not 379b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// appropriate for use in any UI; use of FormatBytes and friends in ui/base is 380b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// highly recommended instead. TODO(avi): Figure out how to get callers to use 381b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// FormatBytes instead; remove this. 3820d205d712abd16eeed2f5d5b1052a367d23a223fAlex VakulenkoBASE_EXPORT string16 FormatBytesUnlocalized(int64_t bytes); 383b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 384b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// Starting at |start_offset| (usually 0), replace the first instance of 385b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// |find_this| with |replace_with|. 386b8cf94937c52feb53b55c39e3f82094d27de464cDaniel EratBASE_EXPORT void ReplaceFirstSubstringAfterOffset( 387b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat base::string16* str, 388b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat size_t start_offset, 3890d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko StringPiece16 find_this, 3900d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko StringPiece16 replace_with); 391b8cf94937c52feb53b55c39e3f82094d27de464cDaniel EratBASE_EXPORT void ReplaceFirstSubstringAfterOffset( 392b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat std::string* str, 393b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat size_t start_offset, 3940d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko StringPiece find_this, 3950d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko StringPiece replace_with); 396b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 397b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// Starting at |start_offset| (usually 0), look through |str| and replace all 398b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// instances of |find_this| with |replace_with|. 399b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// 400b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// This does entire substrings; use std::replace in <algorithm> for single 401b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// characters, for example: 402b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// std::replace(str.begin(), str.end(), 'a', 'b'); 403b8cf94937c52feb53b55c39e3f82094d27de464cDaniel EratBASE_EXPORT void ReplaceSubstringsAfterOffset( 4040d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko string16* str, 405b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat size_t start_offset, 4060d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko StringPiece16 find_this, 4070d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko StringPiece16 replace_with); 4080d205d712abd16eeed2f5d5b1052a367d23a223fAlex VakulenkoBASE_EXPORT void ReplaceSubstringsAfterOffset( 4090d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko std::string* str, 4100d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko size_t start_offset, 4110d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko StringPiece find_this, 4120d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko StringPiece replace_with); 413b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 414b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// Reserves enough memory in |str| to accommodate |length_with_null| characters, 415b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// sets the size of |str| to |length_with_null - 1| characters, and returns a 416b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// pointer to the underlying contiguous array of characters. This is typically 417b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// used when calling a function that writes results into a character array, but 418b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// the caller wants the data to be managed by a string-like object. It is 419b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// convenient in that is can be used inline in the call, and fast in that it 420b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// avoids copying the results of the call from a char* into a string. 421b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// 422b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// |length_with_null| must be at least 2, since otherwise the underlying string 423b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// would have size 0, and trying to access &((*str)[0]) in that case can result 424b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// in a number of problems. 425b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// 426b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// Internally, this takes linear time because the resize() call 0-fills the 427b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// underlying array for potentially all 428b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// (|length_with_null - 1| * sizeof(string_type::value_type)) bytes. Ideally we 429b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// could avoid this aspect of the resize() call, as we expect the caller to 430b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// immediately write over this memory, but there is no other way to set the size 431b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// of the string, and not doing that will mean people who access |str| rather 432b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// than str.c_str() will get back a string of whatever size |str| had on entry 433b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// to this function (probably 0). 4340d205d712abd16eeed2f5d5b1052a367d23a223fAlex VakulenkoBASE_EXPORT char* WriteInto(std::string* str, size_t length_with_null); 4350d205d712abd16eeed2f5d5b1052a367d23a223fAlex VakulenkoBASE_EXPORT char16* WriteInto(string16* str, size_t length_with_null); 4360d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko#ifndef OS_WIN 4370d205d712abd16eeed2f5d5b1052a367d23a223fAlex VakulenkoBASE_EXPORT wchar_t* WriteInto(std::wstring* str, size_t length_with_null); 4380d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko#endif 439b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 440b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// Does the opposite of SplitString(). 4410d205d712abd16eeed2f5d5b1052a367d23a223fAlex VakulenkoBASE_EXPORT std::string JoinString(const std::vector<std::string>& parts, 4420d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko StringPiece separator); 4430d205d712abd16eeed2f5d5b1052a367d23a223fAlex VakulenkoBASE_EXPORT string16 JoinString(const std::vector<string16>& parts, 4440d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko StringPiece16 separator); 445b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 44694ffa55491333f3dcc701befd0d2652922916d99Luis Hector Chavez// Replace $1-$2-$3..$9 in the format string with values from |subst|. 447b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// Additionally, any number of consecutive '$' characters is replaced by that 448b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// number less one. Eg $$->$, $$$->$$, etc. The offsets parameter here can be 449b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// NULL. This only allows you to use up to nine replacements. 4500d205d712abd16eeed2f5d5b1052a367d23a223fAlex VakulenkoBASE_EXPORT string16 ReplaceStringPlaceholders( 4510d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko const string16& format_string, 4520d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko const std::vector<string16>& subst, 453b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat std::vector<size_t>* offsets); 454b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 455b8cf94937c52feb53b55c39e3f82094d27de464cDaniel EratBASE_EXPORT std::string ReplaceStringPlaceholders( 4560d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko const StringPiece& format_string, 457b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat const std::vector<std::string>& subst, 458b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat std::vector<size_t>* offsets); 459b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 460b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat// Single-string shortcut for ReplaceStringHolders. |offset| may be NULL. 4610d205d712abd16eeed2f5d5b1052a367d23a223fAlex VakulenkoBASE_EXPORT string16 ReplaceStringPlaceholders(const string16& format_string, 4620d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko const string16& a, 4630d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko size_t* offset); 4640d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko 4650d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko} // namespace base 4660d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko 4670d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko#if defined(OS_WIN) 4680d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko#include "base/strings/string_util_win.h" 4690d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko#elif defined(OS_POSIX) 4700d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko#include "base/strings/string_util_posix.h" 4710d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko#else 4720d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko#error Define string operations appropriately for your platform 4730d205d712abd16eeed2f5d5b1052a367d23a223fAlex Vakulenko#endif 474b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat 475b8cf94937c52feb53b55c39e3f82094d27de464cDaniel Erat#endif // BASE_STRINGS_STRING_UTIL_H_ 476