1 // Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
11 //! Character manipulation.
13 //! For more details, see ::rustc_unicode::char (a.k.a. std::char)
15 #![allow(non_snake_case)]
16 #![stable(feature = "core_char", since = "1.2.0")]
20 use option::Option::{None, Some};
24 // UTF-8 ranges and tags for encoding characters
25 const TAG_CONT: u8 = 0b1000_0000;
26 const TAG_TWO_B: u8 = 0b1100_0000;
27 const TAG_THREE_B: u8 = 0b1110_0000;
28 const TAG_FOUR_B: u8 = 0b1111_0000;
29 const MAX_ONE_B: u32 = 0x80;
30 const MAX_TWO_B: u32 = 0x800;
31 const MAX_THREE_B: u32 = 0x10000;
34 Lu Uppercase_Letter an uppercase letter
35 Ll Lowercase_Letter a lowercase letter
36 Lt Titlecase_Letter a digraphic character, with first part uppercase
37 Lm Modifier_Letter a modifier letter
38 Lo Other_Letter other letters, including syllables and ideographs
39 Mn Nonspacing_Mark a nonspacing combining mark (zero advance width)
40 Mc Spacing_Mark a spacing combining mark (positive advance width)
41 Me Enclosing_Mark an enclosing combining mark
42 Nd Decimal_Number a decimal digit
43 Nl Letter_Number a letterlike numeric character
44 No Other_Number a numeric character of other type
45 Pc Connector_Punctuation a connecting punctuation mark, like a tie
46 Pd Dash_Punctuation a dash or hyphen punctuation mark
47 Ps Open_Punctuation an opening punctuation mark (of a pair)
48 Pe Close_Punctuation a closing punctuation mark (of a pair)
49 Pi Initial_Punctuation an initial quotation mark
50 Pf Final_Punctuation a final quotation mark
51 Po Other_Punctuation a punctuation mark of other type
52 Sm Math_Symbol a symbol of primarily mathematical use
53 Sc Currency_Symbol a currency sign
54 Sk Modifier_Symbol a non-letterlike modifier symbol
55 So Other_Symbol a symbol of other type
56 Zs Space_Separator a space character (of various non-zero widths)
57 Zl Line_Separator U+2028 LINE SEPARATOR only
58 Zp Paragraph_Separator U+2029 PARAGRAPH SEPARATOR only
59 Cc Control a C0 or C1 control code
60 Cf Format a format control character
61 Cs Surrogate a surrogate code point
62 Co Private_Use a private-use character
63 Cn Unassigned a reserved unassigned code point or a noncharacter
66 /// The highest valid code point
67 #[stable(feature = "rust1", since = "1.0.0")]
68 pub const MAX: char = '\u{10ffff}';
70 /// Converts a `u32` to an `Option<char>`.
77 /// assert_eq!(char::from_u32(0x2764), Some('❤'));
78 /// assert_eq!(char::from_u32(0x110000), None); // invalid character
81 #[stable(feature = "rust1", since = "1.0.0")]
82 pub fn from_u32(i: u32) -> Option<char> {
83 // catch out-of-bounds and surrogates
84 if (i > MAX as u32) || (i >= 0xD800 && i <= 0xDFFF) {
87 Some(unsafe { from_u32_unchecked(i) })
91 /// Converts a `u32` to an `char`, not checking whether it is a valid unicode
94 #[unstable(feature = "char_from_unchecked", reason = "recently added API",
96 pub unsafe fn from_u32_unchecked(i: u32) -> char {
100 /// Converts a number to the character representing it.
104 /// Returns `Some(char)` if `num` represents one digit under `radix`,
105 /// using one character of `0-9` or `a-z`, or `None` if it doesn't.
109 /// Panics if given an `radix` > 36.
116 /// let c = char::from_digit(4, 10);
118 /// assert_eq!(c, Some('4'));
121 #[stable(feature = "rust1", since = "1.0.0")]
122 pub fn from_digit(num: u32, radix: u32) -> Option<char> {
124 panic!("from_digit: radix is too high (maximum 36)");
129 Some((b'0' + num) as char)
131 Some((b'a' + num - 10) as char)
138 // NB: the stabilization and documentation for this trait is in
139 // unicode/char.rs, not here
140 #[allow(missing_docs)] // docs in libunicode/u_char.rs
142 #[unstable(feature = "core_char_ext",
143 reason = "the stable interface is `impl char` in later crate",
146 fn is_digit(self, radix: u32) -> bool;
147 fn to_digit(self, radix: u32) -> Option<u32>;
148 fn escape_unicode(self) -> EscapeUnicode;
149 fn escape_default(self) -> EscapeDefault;
150 fn len_utf8(self) -> usize;
151 fn len_utf16(self) -> usize;
152 fn encode_utf8(self, dst: &mut [u8]) -> Option<usize>;
153 fn encode_utf16(self, dst: &mut [u16]) -> Option<usize>;
156 impl CharExt for char {
158 fn is_digit(self, radix: u32) -> bool {
159 self.to_digit(radix).is_some()
163 fn to_digit(self, radix: u32) -> Option<u32> {
165 panic!("to_digit: radix is too high (maximum 36)");
167 let val = match self {
168 '0' ... '9' => self as u32 - '0' as u32,
169 'a' ... 'z' => self as u32 - 'a' as u32 + 10,
170 'A' ... 'Z' => self as u32 - 'A' as u32 + 10,
173 if val < radix { Some(val) }
178 fn escape_unicode(self) -> EscapeUnicode {
179 EscapeUnicode { c: self, state: EscapeUnicodeState::Backslash }
183 fn escape_default(self) -> EscapeDefault {
184 let init_state = match self {
185 '\t' => EscapeDefaultState::Backslash('t'),
186 '\r' => EscapeDefaultState::Backslash('r'),
187 '\n' => EscapeDefaultState::Backslash('n'),
188 '\\' | '\'' | '"' => EscapeDefaultState::Backslash(self),
189 '\x20' ... '\x7e' => EscapeDefaultState::Char(self),
190 _ => EscapeDefaultState::Unicode(self.escape_unicode())
192 EscapeDefault { state: init_state }
196 fn len_utf8(self) -> usize {
197 let code = self as u32;
198 if code < MAX_ONE_B {
200 } else if code < MAX_TWO_B {
202 } else if code < MAX_THREE_B {
210 fn len_utf16(self) -> usize {
211 let ch = self as u32;
212 if (ch & 0xFFFF) == ch { 1 } else { 2 }
216 fn encode_utf8(self, dst: &mut [u8]) -> Option<usize> {
217 encode_utf8_raw(self as u32, dst)
221 fn encode_utf16(self, dst: &mut [u16]) -> Option<usize> {
222 encode_utf16_raw(self as u32, dst)
226 /// Encodes a raw u32 value as UTF-8 into the provided byte buffer,
227 /// and then returns the number of bytes written.
229 /// If the buffer is not large enough, nothing will be written into it
230 /// and a `None` will be returned.
232 #[unstable(feature = "char_internals",
233 reason = "this function should not be exposed publicly",
236 pub fn encode_utf8_raw(code: u32, dst: &mut [u8]) -> Option<usize> {
237 // Marked #[inline] to allow llvm optimizing it away
238 if code < MAX_ONE_B && !dst.is_empty() {
241 } else if code < MAX_TWO_B && dst.len() >= 2 {
242 dst[0] = (code >> 6 & 0x1F) as u8 | TAG_TWO_B;
243 dst[1] = (code & 0x3F) as u8 | TAG_CONT;
245 } else if code < MAX_THREE_B && dst.len() >= 3 {
246 dst[0] = (code >> 12 & 0x0F) as u8 | TAG_THREE_B;
247 dst[1] = (code >> 6 & 0x3F) as u8 | TAG_CONT;
248 dst[2] = (code & 0x3F) as u8 | TAG_CONT;
250 } else if dst.len() >= 4 {
251 dst[0] = (code >> 18 & 0x07) as u8 | TAG_FOUR_B;
252 dst[1] = (code >> 12 & 0x3F) as u8 | TAG_CONT;
253 dst[2] = (code >> 6 & 0x3F) as u8 | TAG_CONT;
254 dst[3] = (code & 0x3F) as u8 | TAG_CONT;
261 /// Encodes a raw u32 value as UTF-16 into the provided `u16` buffer,
262 /// and then returns the number of `u16`s written.
264 /// If the buffer is not large enough, nothing will be written into it
265 /// and a `None` will be returned.
267 #[unstable(feature = "char_internals",
268 reason = "this function should not be exposed publicly",
271 pub fn encode_utf16_raw(mut ch: u32, dst: &mut [u16]) -> Option<usize> {
272 // Marked #[inline] to allow llvm optimizing it away
273 if (ch & 0xFFFF) == ch && !dst.is_empty() {
274 // The BMP falls through (assuming non-surrogate, as it should)
277 } else if dst.len() >= 2 {
278 // Supplementary planes break into surrogates.
280 dst[0] = 0xD800 | ((ch >> 10) as u16);
281 dst[1] = 0xDC00 | ((ch as u16) & 0x3FF);
288 /// An iterator over the characters that represent a `char`, as escaped by
289 /// Rust's unicode escaping rules.
291 #[stable(feature = "rust1", since = "1.0.0")]
292 pub struct EscapeUnicode {
294 state: EscapeUnicodeState
298 enum EscapeUnicodeState {
307 #[stable(feature = "rust1", since = "1.0.0")]
308 impl Iterator for EscapeUnicode {
311 fn next(&mut self) -> Option<char> {
313 EscapeUnicodeState::Backslash => {
314 self.state = EscapeUnicodeState::Type;
317 EscapeUnicodeState::Type => {
318 self.state = EscapeUnicodeState::LeftBrace;
321 EscapeUnicodeState::LeftBrace => {
323 while (self.c as u32) >> (4 * (n + 1)) != 0 {
326 self.state = EscapeUnicodeState::Value(n);
329 EscapeUnicodeState::Value(offset) => {
330 let c = from_digit(((self.c as u32) >> (offset * 4)) & 0xf, 16).unwrap();
332 self.state = EscapeUnicodeState::RightBrace;
334 self.state = EscapeUnicodeState::Value(offset - 1);
338 EscapeUnicodeState::RightBrace => {
339 self.state = EscapeUnicodeState::Done;
342 EscapeUnicodeState::Done => None,
346 fn size_hint(&self) -> (usize, Option<usize>) {
348 while (self.c as usize) >> (4 * (n + 1)) != 0 {
351 let n = match self.state {
352 EscapeUnicodeState::Backslash => n + 5,
353 EscapeUnicodeState::Type => n + 4,
354 EscapeUnicodeState::LeftBrace => n + 3,
355 EscapeUnicodeState::Value(offset) => offset + 2,
356 EscapeUnicodeState::RightBrace => 1,
357 EscapeUnicodeState::Done => 0,
363 /// An iterator over the characters that represent a `char`, escaped
364 /// for maximum portability.
366 #[stable(feature = "rust1", since = "1.0.0")]
367 pub struct EscapeDefault {
368 state: EscapeDefaultState
372 enum EscapeDefaultState {
376 Unicode(EscapeUnicode),
379 #[stable(feature = "rust1", since = "1.0.0")]
380 impl Iterator for EscapeDefault {
383 fn next(&mut self) -> Option<char> {
385 EscapeDefaultState::Backslash(c) => {
386 self.state = EscapeDefaultState::Char(c);
389 EscapeDefaultState::Char(c) => {
390 self.state = EscapeDefaultState::Done;
393 EscapeDefaultState::Done => None,
394 EscapeDefaultState::Unicode(ref mut iter) => iter.next(),
398 fn size_hint(&self) -> (usize, Option<usize>) {
400 EscapeDefaultState::Char(_) => (1, Some(1)),
401 EscapeDefaultState::Backslash(_) => (2, Some(2)),
402 EscapeDefaultState::Unicode(ref iter) => iter.size_hint(),
403 EscapeDefaultState::Done => (0, Some(0)),