1ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root/* 2ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * Copyright (C) 2005 The Android Open Source Project 3ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * 4ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * Licensed under the Apache License, Version 2.0 (the "License"); 5ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * you may not use this file except in compliance with the License. 6ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * You may obtain a copy of the License at 7ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * 8ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * http://www.apache.org/licenses/LICENSE-2.0 9ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * 10ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * Unless required by applicable law or agreed to in writing, software 11ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * distributed under the License is distributed on an "AS IS" BASIS, 12ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * See the License for the specific language governing permissions and 14ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * limitations under the License. 15ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root */ 16ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root 17ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root#ifndef ANDROID_UNICODE_H 18ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root#define ANDROID_UNICODE_H 19ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root 20ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root#include <sys/types.h> 21ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root#include <stdint.h> 22ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root 23ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Rootextern "C" { 24ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root 25ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Roottypedef uint32_t char32_t; 26ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Roottypedef uint16_t char16_t; 27ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root 28ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root// Standard string functions on char16_t strings. 29ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Rootint strcmp16(const char16_t *, const char16_t *); 30ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Rootint strncmp16(const char16_t *s1, const char16_t *s2, size_t n); 31ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Rootsize_t strlen16(const char16_t *); 32ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Rootsize_t strnlen16(const char16_t *, size_t); 33ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Rootchar16_t *strcpy16(char16_t *, const char16_t *); 34ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Rootchar16_t *strncpy16(char16_t *, const char16_t *, size_t); 35ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root 36ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root// Version of comparison that supports embedded nulls. 37ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root// This is different than strncmp() because we don't stop 38ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root// at a nul character and consider the strings to be different 39ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root// if the lengths are different (thus we need to supply the 40ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root// lengths of both strings). This can also be used when 41ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root// your string is not nul-terminated as it will have the 42ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root// equivalent result as strcmp16 (unlike strncmp16). 43ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Rootint strzcmp16(const char16_t *s1, size_t n1, const char16_t *s2, size_t n2); 44ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root 45ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root// Version of strzcmp16 for comparing strings in different endianness. 46ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Rootint strzcmp16_h_n(const char16_t *s1H, size_t n1, const char16_t *s2N, size_t n2); 47ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root 48ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root// Standard string functions on char32_t strings. 49ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Rootsize_t strlen32(const char32_t *); 50ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Rootsize_t strnlen32(const char32_t *, size_t); 51ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root 52ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root/** 53ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * Measure the length of a UTF-32 string in UTF-8. If the string is invalid 54ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * such as containing a surrogate character, -1 will be returned. 55ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root */ 56ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Rootssize_t utf32_to_utf8_length(const char32_t *src, size_t src_len); 57ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root 58ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root/** 59ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * Stores a UTF-8 string converted from "src" in "dst", if "dst_length" is not 60ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * large enough to store the string, the part of the "src" string is stored 61ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * into "dst" as much as possible. See the examples for more detail. 62ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * Returns the size actually used for storing the string. 63ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * dst" is not null-terminated when dst_len is fully used (like strncpy). 64ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * 65ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * Example 1 66ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * "src" == \u3042\u3044 (\xE3\x81\x82\xE3\x81\x84) 67ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * "src_len" == 2 68ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * "dst_len" >= 7 69ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * -> 70ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * Returned value == 6 71ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * "dst" becomes \xE3\x81\x82\xE3\x81\x84\0 72ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * (note that "dst" is null-terminated) 73ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * 74ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * Example 2 75ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * "src" == \u3042\u3044 (\xE3\x81\x82\xE3\x81\x84) 76ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * "src_len" == 2 77ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * "dst_len" == 5 78ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * -> 79ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * Returned value == 3 80ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * "dst" becomes \xE3\x81\x82\0 81ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * (note that "dst" is null-terminated, but \u3044 is not stored in "dst" 82ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * since "dst" does not have enough size to store the character) 83ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * 84ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * Example 3 85ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * "src" == \u3042\u3044 (\xE3\x81\x82\xE3\x81\x84) 86ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * "src_len" == 2 87ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * "dst_len" == 6 88ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * -> 89ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * Returned value == 6 90ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * "dst" becomes \xE3\x81\x82\xE3\x81\x84 91ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * (note that "dst" is NOT null-terminated, like strncpy) 92ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root */ 93ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Rootvoid utf32_to_utf8(const char32_t* src, size_t src_len, char* dst); 94ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root 95ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root/** 96ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * Returns the unicode value at "index". 97ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * Returns -1 when the index is invalid (equals to or more than "src_len"). 98ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * If returned value is positive, it is able to be converted to char32_t, which 99ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * is unsigned. Then, if "next_index" is not NULL, the next index to be used is 100ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * stored in "next_index". "next_index" can be NULL. 101ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root */ 102ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Rootint32_t utf32_from_utf8_at(const char *src, size_t src_len, size_t index, size_t *next_index); 103ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root 104ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root 105ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root/** 106ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * Returns the UTF-8 length of UTF-16 string "src". 107ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root */ 108ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Rootssize_t utf16_to_utf8_length(const char16_t *src, size_t src_len); 109ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root 110ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root/** 111ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * Converts a UTF-16 string to UTF-8. The destination buffer must be large 112ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * enough to fit the UTF-16 as measured by utf16_to_utf8_length with an added 113ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * NULL terminator. 114ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root */ 115ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Rootvoid utf16_to_utf8(const char16_t* src, size_t src_len, char* dst); 116ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root 117ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root/** 118ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * Returns the length of "src" when "src" is valid UTF-8 string. 119ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * Returns 0 if src is NULL or 0-length string. Returns -1 when the source 120ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * is an invalid string. 121ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * 122ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * This function should be used to determine whether "src" is valid UTF-8 123ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * characters with valid unicode codepoints. "src" must be null-terminated. 124ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * 125ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * If you are going to use other utf8_to_... functions defined in this header 126ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * with string which may not be valid UTF-8 with valid codepoint (form 0 to 127ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * 0x10FFFF), you should use this function before calling others, since the 128ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * other functions do not check whether the string is valid UTF-8 or not. 129ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * 130ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * If you do not care whether "src" is valid UTF-8 or not, you should use 131ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * strlen() as usual, which should be much faster. 132ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root */ 133ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Rootssize_t utf8_length(const char *src); 134ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root 135ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root/** 136ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * Measure the length of a UTF-32 string. 137ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root */ 138ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Rootsize_t utf8_to_utf32_length(const char *src, size_t src_len); 139ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root 140ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root/** 141ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * Stores a UTF-32 string converted from "src" in "dst". "dst" must be large 142ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * enough to store the entire converted string as measured by 143ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * utf8_to_utf32_length plus space for a NULL terminator. 144ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root */ 145ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Rootvoid utf8_to_utf32(const char* src, size_t src_len, char32_t* dst); 146ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root 147ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root/** 148ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * Returns the UTF-16 length of UTF-8 string "src". 149ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root */ 150ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Rootssize_t utf8_to_utf16_length(const uint8_t* src, size_t srcLen); 151ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root 152ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root/** 153aa983c91caf848b9659599336a4156c28a125fa9Jeff Brown * Convert UTF-8 to UTF-16 including surrogate pairs. 154aa983c91caf848b9659599336a4156c28a125fa9Jeff Brown * Returns a pointer to the end of the string (where a null terminator might go 155aa983c91caf848b9659599336a4156c28a125fa9Jeff Brown * if you wanted to add one). 156aa983c91caf848b9659599336a4156c28a125fa9Jeff Brown */ 157aa983c91caf848b9659599336a4156c28a125fa9Jeff Brownchar16_t* utf8_to_utf16_no_null_terminator(const uint8_t* src, size_t srcLen, char16_t* dst); 158aa983c91caf848b9659599336a4156c28a125fa9Jeff Brown 159aa983c91caf848b9659599336a4156c28a125fa9Jeff Brown/** 160ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * Convert UTF-8 to UTF-16 including surrogate pairs. The destination buffer 161ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * must be large enough to hold the result as measured by utf8_to_utf16_length 162ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root * plus an added NULL terminator. 163ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root */ 164ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Rootvoid utf8_to_utf16(const uint8_t* src, size_t srcLen, char16_t* dst); 165ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root 1660f10d0abf3e6f6b5631c091256f8b4e7a20a33d0Dianne Hackborn/** 1670f10d0abf3e6f6b5631c091256f8b4e7a20a33d0Dianne Hackborn * Like utf8_to_utf16_no_null_terminator, but you can supply a maximum length of the 1680f10d0abf3e6f6b5631c091256f8b4e7a20a33d0Dianne Hackborn * decoded string. The decoded string will fill up to that length; if it is longer 1690f10d0abf3e6f6b5631c091256f8b4e7a20a33d0Dianne Hackborn * the returned pointer will be to the character after dstLen. 1700f10d0abf3e6f6b5631c091256f8b4e7a20a33d0Dianne Hackborn */ 1710f10d0abf3e6f6b5631c091256f8b4e7a20a33d0Dianne Hackbornchar16_t* utf8_to_utf16_n(const uint8_t* src, size_t srcLen, char16_t* dst, size_t dstLen); 1720f10d0abf3e6f6b5631c091256f8b4e7a20a33d0Dianne Hackborn 173ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root} 174ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root 175ba0165bef09729a33ab8e0ca329342be05e0d859Kenny Root#endif 176