The Tor Browser / file revision

 // Copyright (c) 2006-2008 The Chromium Authors. All rights reserved.

 // Use of this source code is governed by a BSD-style license that can be

 // found in the LICENSE file.

 //

 // This file defines utility functions for working with strings.

 #ifndef BASE_STRING_UTIL_H_

 #define BASE_STRING_UTIL_H_

 #include <stdarg.h>   // va_list

 #include <ctype.h>

 #include <string>

 #include <vector>

 #include "base/basictypes.h"

 #include "base/string16.h"

 #include "base/string_piece.h"  // For implicit conversions.

 // Safe standard library wrappers for all platforms.

 namespace base {

 // C standard-library functions like "strncasecmp" and "snprintf" that aren't

 // cross-platform are provided as "base::strncasecmp", and their prototypes

 // are listed below.  These functions are then implemented as inline calls

 // to the platform-specific equivalents in the platform-specific headers.

 // Compare the two strings s1 and s2 without regard to case using

 // the current locale; returns 0 if they are equal, 1 if s1 > s2, and -1 if

 // s2 > s1 according to a lexicographic comparison.

 int strcasecmp(const char* s1, const char* s2);

 // Compare up to count characters of s1 and s2 without regard to case using

 // the current locale; returns 0 if they are equal, 1 if s1 > s2, and -1 if

 // s2 > s1 according to a lexicographic comparison.

 int strncasecmp(const char* s1, const char* s2, size_t count);

 // Wrapper for vsnprintf that always null-terminates and always returns the

 // number of characters that would be in an untruncated formatted

 // string, even when truncation occurs.

 int vsnprintf(char* buffer, size_t size, const char* format, va_list arguments);

 // vswprintf always null-terminates, but when truncation occurs, it will either

 // return -1 or the number of characters that would be in an untruncated

 // formatted string.  The actual return value depends on the underlying

 // C library's vswprintf implementation.

 int vswprintf(wchar_t* buffer, size_t size,

               const wchar_t* format, va_list arguments);

 // Some of these implementations need to be inlined.

 inline int snprintf(char* buffer, size_t size, const char* format, ...) {

   va_list arguments;

   va_start(arguments, format);

   int result = vsnprintf(buffer, size, format, arguments);

   va_end(arguments);

   return result;

 }

 inline int swprintf(wchar_t* buffer, size_t size, const wchar_t* format, ...) {

   va_list arguments;

   va_start(arguments, format);

   int result = vswprintf(buffer, size, format, arguments);

   va_end(arguments);

   return result;

 }

 // BSD-style safe and consistent string copy functions.

 // Copies |src| to |dst|, where |dst_size| is the total allocated size of |dst|.

 // Copies at most |dst_size|-1 characters, and always NULL terminates |dst|, as

 // long as |dst_size| is not 0.  Returns the length of |src| in characters.

 // If the return value is >= dst_size, then the output was truncated.

 // NOTE: All sizes are in number of characters, NOT in bytes.

 size_t strlcpy(char* dst, const char* src, size_t dst_size);

 size_t wcslcpy(wchar_t* dst, const wchar_t* src, size_t dst_size);

 // Scan a wprintf format string to determine whether it's portable across a

 // variety of systems.  This function only checks that the conversion

 // specifiers used by the format string are supported and have the same meaning

 // on a variety of systems.  It doesn't check for other errors that might occur

 // within a format string.

 //

 // Nonportable conversion specifiers for wprintf are:

 //  - 's' and 'c' without an 'l' length modifier.  %s and %c operate on char

 //     data on all systems except Windows, which treat them as wchar_t data.

 //     Use %ls and %lc for wchar_t data instead.

 //  - 'S' and 'C', which operate on wchar_t data on all systems except Windows,

 //     which treat them as char data.  Use %ls and %lc for wchar_t data

 //     instead.

 //  - 'F', which is not identified by Windows wprintf documentation.

 //  - 'D', 'O', and 'U', which are deprecated and not available on all systems.

 //     Use %ld, %lo, and %lu instead.

 //

 // Note that there is no portable conversion specifier for char data when

 // working with wprintf.

 //

 // This function is intended to be called from base::vswprintf.

 bool IsWprintfFormatPortable(const wchar_t* format);

 }  // namespace base

 #if defined(OS_WIN)

 #include "base/string_util_win.h"

 #elif defined(OS_POSIX)

 #include "base/string_util_posix.h"

 #else

 #error Define string operations appropriately for your platform

 #endif

 // Trims any whitespace from either end of the input string.  Returns where

 // whitespace was found.

 // The non-wide version has two functions:

 // * TrimWhitespaceASCII()

 //   This function is for ASCII strings and only looks for ASCII whitespace;

 // * TrimWhitespaceUTF8()

 //   This function is for UTF-8 strings and looks for Unicode whitespace.

 // Please choose the best one according to your usage.

 // NOTE: Safe to use the same variable for both input and output.

 enum TrimPositions {

   TRIM_NONE     = 0,

   TRIM_LEADING  = 1 << 0,

   TRIM_TRAILING = 1 << 1,

   TRIM_ALL      = TRIM_LEADING | TRIM_TRAILING

 };

 TrimPositions TrimWhitespace(const std::wstring& input,

                              TrimPositions positions,

                              std::wstring* output);

 TrimPositions TrimWhitespaceASCII(const std::string& input,

                                   TrimPositions positions,

                                   std::string* output);

 // Deprecated. This function is only for backward compatibility and calls

 // TrimWhitespaceASCII().

 TrimPositions TrimWhitespace(const std::string& input,

                              TrimPositions positions,

                              std::string* output);

 // Searches  for CR or LF characters.  Removes all contiguous whitespace

 // strings that contain them.  This is useful when trying to deal with text

 // copied from terminals.

 // Returns |text, with the following three transformations:

 // (1) Leading and trailing whitespace is trimmed.

 // (2) If |trim_sequences_with_line_breaks| is true, any other whitespace

 //     sequences containing a CR or LF are trimmed.

 // (3) All other whitespace sequences are converted to single spaces.

 std::wstring CollapseWhitespace(const std::wstring& text,

                                 bool trim_sequences_with_line_breaks);

 // These convert between ASCII (7-bit) and Wide/UTF16 strings.

 std::string WideToASCII(const std::wstring& wide);

 std::wstring ASCIIToWide(const std::string& ascii);

 std::string UTF16ToASCII(const string16& utf16);

 string16 ASCIIToUTF16(const std::string& ascii);

 // These convert between UTF-8, -16, and -32 strings. They are potentially slow,

 // so avoid unnecessary conversions. The low-level versions return a boolean

 // indicating whether the conversion was 100% valid. In this case, it will still

 // do the best it can and put the result in the output buffer. The versions that

 // return strings ignore this error and just return the best conversion

 // possible.

 bool WideToUTF8(const wchar_t* src, size_t src_len, std::string* output);

 std::string WideToUTF8(const std::wstring& wide);

 bool UTF8ToWide(const char* src, size_t src_len, std::wstring* output);

 std::wstring UTF8ToWide(const ::StringPiece& utf8);

 bool IsStringASCII(const std::wstring& str);

 bool IsStringASCII(const std::string& str);

 bool IsStringASCII(const string16& str);

 // Specialized string-conversion functions.

 std::string IntToString(int value);

 std::wstring IntToWString(int value);

 std::string UintToString(unsigned int value);

 std::wstring UintToWString(unsigned int value);

 std::string Int64ToString(int64_t value);

 std::wstring Int64ToWString(int64_t value);

 std::string Uint64ToString(uint64_t value);

 std::wstring Uint64ToWString(uint64_t value);

 // The DoubleToString methods convert the double to a string format that

 // ignores the locale.  If you want to use locale specific formatting, use ICU.

 std::string DoubleToString(double value);

 std::wstring DoubleToWString(double value);

 // Perform a best-effort conversion of the input string to a numeric type,

 // setting |*output| to the result of the conversion.  Returns true for

 // "perfect" conversions; returns false in the following cases:

 //  - Overflow/underflow.  |*output| will be set to the maximum value supported

 //    by the data type.

 //  - Trailing characters in the string after parsing the number.  |*output|

 //    will be set to the value of the number that was parsed.

 //  - No characters parseable as a number at the beginning of the string.

 //    |*output| will be set to 0.

 //  - Empty string.  |*output| will be set to 0.

 bool StringToInt(const std::string& input, int* output);

 bool StringToInt(const string16& input, int* output);

 bool StringToInt64(const std::string& input, int64_t* output);

 bool StringToInt64(const string16& input, int64_t* output);

 // Convenience forms of the above, when the caller is uninterested in the

 // boolean return value.  These return only the |*output| value from the

 // above conversions: a best-effort conversion when possible, otherwise, 0.

 int StringToInt(const std::string& value);

 int StringToInt(const string16& value);

 int64_t StringToInt64(const std::string& value);

 int64_t StringToInt64(const string16& value);

 // Return a C++ string given printf-like input.

 std::string StringPrintf(const char* format, ...);

 std::wstring StringPrintf(const wchar_t* format, ...);

 // Store result into a supplied string and return it

 const std::string& SStringPrintf(std::string* dst, const char* format, ...);

 const std::wstring& SStringPrintf(std::wstring* dst,

                                   const wchar_t* format, ...);

 // Append result to a supplied string

 void StringAppendF(std::string* dst, const char* format, ...);

 void StringAppendF(std::wstring* dst, const wchar_t* format, ...);

 //-----------------------------------------------------------------------------

 // Splits |str| into a vector of strings delimited by |s|. Append the results

 // into |r| as they appear. If several instances of |s| are contiguous, or if

 // |str| begins with or ends with |s|, then an empty string is inserted.

 //

 // Every substring is trimmed of any leading or trailing white space.

 void SplitString(const std::wstring& str,

                  wchar_t s,

                  std::vector<std::wstring>* r);

 void SplitString(const std::string& str,

                  char s,

                  std::vector<std::string>* r);

 #endif  // BASE_STRING_UTIL_H_