1c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// Copyright (c) 2009 The Chromium Authors. All rights reserved. 2c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// Use of this source code is governed by a BSD-style license that can be 3c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// found in the LICENSE file. 4c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 5c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#ifndef BASE_UTF_STRING_CONVERSION_UTILS_H_ 6c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#define BASE_UTF_STRING_CONVERSION_UTILS_H_ 73345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick#pragma once 8c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 9c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// This should only be used by the various UTF string conversion files. 10c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 11c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#include "base/string16.h" 12c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 13c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottnamespace base { 14c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 15c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottinline bool IsValidCodepoint(uint32 code_point) { 16c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Excludes the surrogate code points ([0xD800, 0xDFFF]) and 17c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // codepoints larger than 0x10FFFF (the highest codepoint allowed). 18c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Non-characters and unassigned codepoints are allowed. 19c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott return code_point < 0xD800u || 20c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott (code_point >= 0xE000u && code_point <= 0x10FFFFu); 21c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott} 22c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 23c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdochinline bool IsValidCharacter(uint32 code_point) { 24c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Excludes non-characters (U+FDD0..U+FDEF, and all codepoints ending in 25c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // 0xFFFE or 0xFFFF) from the set of valid code points. 26c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch return code_point < 0xD800u || (code_point >= 0xE000u && 27c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch code_point < 0xFDD0u) || (code_point > 0xFDEFu && 28c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch code_point <= 0x10FFFFu && (code_point & 0xFFFEu) != 0xFFFEu); 29c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch} 30c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 31c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// ReadUnicodeCharacter -------------------------------------------------------- 32c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 33c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// Reads a UTF-8 stream, placing the next code point into the given output 34c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// |*code_point|. |src| represents the entire string to read, and |*char_index| 35c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// is the character offset within the string to start reading at. |*char_index| 36c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// will be updated to index the last character read, such that incrementing it 37c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// (as in a for loop) will take the reader to the next character. 38c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// 39c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// Returns true on success. On false, |*code_point| will be invalid. 40c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottbool ReadUnicodeCharacter(const char* src, 41c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott int32 src_len, 42c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott int32* char_index, 43c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott uint32* code_point_out); 44c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 45c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// Reads a UTF-16 character. The usage is the same as the 8-bit version above. 46c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottbool ReadUnicodeCharacter(const char16* src, 47c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott int32 src_len, 48c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott int32* char_index, 49c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott uint32* code_point); 50c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 51c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#if defined(WCHAR_T_IS_UTF32) 52c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// Reads UTF-32 character. The usage is the same as the 8-bit version above. 53c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottbool ReadUnicodeCharacter(const wchar_t* src, 54c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott int32 src_len, 55c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott int32* char_index, 56c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott uint32* code_point); 57c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#endif // defined(WCHAR_T_IS_UTF32) 58c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 59c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// WriteUnicodeCharacter ------------------------------------------------------- 60c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 61c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// Appends a UTF-8 character to the given 8-bit string. Returns the number of 62c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// bytes written. 63c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottsize_t WriteUnicodeCharacter(uint32 code_point, std::string* output); 64c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 65c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// Appends the given code point as a UTF-16 character to the given 16-bit 66c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// string. Returns the number of 16-bit values written. 67c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottsize_t WriteUnicodeCharacter(uint32 code_point, string16* output); 68c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 69c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#if defined(WCHAR_T_IS_UTF32) 70c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// Appends the given UTF-32 character to the given 32-bit string. Returns the 71c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// number of 32-bit values written. 72c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottinline size_t WriteUnicodeCharacter(uint32 code_point, std::wstring* output) { 73c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // This is the easy case, just append the character. 74c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott output->push_back(code_point); 75c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott return 1; 76c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott} 77c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#endif // defined(WCHAR_T_IS_UTF32) 78c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 79c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// Generalized Unicode converter ----------------------------------------------- 80c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 81c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// Guesses the length of the output in UTF-8 in bytes, clears that output 82c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// string, and reserves that amount of space. We assume that the input 83c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// character types are unsigned, which will be true for UTF-16 and -32 on our 84c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// systems. 85c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scotttemplate<typename CHAR> 86c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottvoid PrepareForUTF8Output(const CHAR* src, size_t src_len, std::string* output); 87c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 88c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// Prepares an output buffer (containing either UTF-16 or -32 data) given some 89c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// UTF-8 input that will be converted to it. See PrepareForUTF8Output(). 90c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scotttemplate<typename STRING> 91c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottvoid PrepareForUTF16Or32Output(const char* src, size_t src_len, STRING* output); 92c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 93c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott} // namespace base 94c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 95c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#endif // BASE_UTF_STRING_CONVERSION_UTILS_H_ 96