1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
//! A wide string FFI module for converting to and from wide string variants. //! //! This module provides multiple types of wide strings: `U16String`, `U16CString`, `U32String`, //! and `U32CString`. These types are backed by two generic implementations parameterized by //! element size: `UString<C>` and `UCString<C>`. The `UCString` types are analogous to the //! standard `CString` FFI type, while the `UString` types are analogous to `OsString`. Otherwise, //! `U16` and `U32` types differ only in character width and encoding methods. //! //! For `U16String` and `U32String`, no guarantees are made about the underlying string data; they //! are simply a sequence of UTF-16 *code units* or UTF-32 code points, both of which may be //! ill-formed or contain nul values. `U16CString` and `U32CString`, on the other hand, are aware //! of nul values and are guaranteed to be terminated with a nul value (unless unchecked methods //! are used to construct the strings). Because `U16CString` and `U32CString` are C-style, //! nul-terminated strings, they will have no interior nul values. All four string types may still //! have unpaired UTF-16 surrogates or invalid UTF-32 code points; ill-formed data is preserved //! until conversion to a basic Rust `String`. //! //! Use `U16String` or `U32String` when you simply need to pass-through strings, or when you know //! or don't care if you're not dealing with a nul-terminated string, such as when string lengths //! are provided and you are only reading strings from FFI, not writing them out to a FFI. //! //! Use `U16CString` or `U32CString` when you must properly handle nul values, and must deal with //! nul-terminated C-style wide strings, such as when you pass strings into FFI functions. //! //! # Relationship to other Rust Strings //! //! Standard Rust strings `String` and `str` are well-formed Unicode data encoded as UTF-8. The //! standard strings provide proper handling of Unicode and ensure strong safety guarantees. //! //! `CString` and `CStr` are strings used for C FFI. They handle nul-terminated C-style strings. //! However, they do not have a builtin encoding, and conversions between C-style and other Rust //! strings must specifically encode and decode the strings, and handle possibly invalid encoding //! data. They are safe to use only in passing string-like data back and forth from C APIs but do //! not provide any other guarantees, so may not be well-formed. //! //! `OsString` and `OsStr` are also strings for use with FFI. Unlike `CString`, they do no special //! handling of nul values, but instead have an OS-specified encoding. While, for example, on Linux //! systems this is usually the UTF-8 encoding, this is not the case for every platform. The //! encoding may not even be 8-bit: on Windows, `OsString` uses a malformed encoding sometimes //! referred to as "WTF-8". In any case, like `CString`, `OsString` has no additional guarantees //! and may not be well-formed. //! //! Due to the loss of safety of these other string types, conversion to standard Rust `String` is //! lossy, and may require knowledge of the underlying encoding, including platform-specific //! quirks. //! //! The wide strings in this crate are roughly based on the principles of the string types in //! `std::ffi`, though there are differences. `U16String`, `U32String`, `U16Str`, and `U32Str` are //! roughly similar in role to `OsString` and `OsStr`, while `U16CString`, `U32CString`, `U16CStr`, //! and `U32CStr` are roughly similar in role to `CString` and `CStr`. Conversion to FFI string //! types is generally very straight forward and safe, while conversion directly between standard //! Rust `String` is a lossy conversion just as `OsString` is. //! //! `U16String` and `U16CString` are treated as though they use UTF-16 encoding, even if they may //! contain unpaired surrogates. `U32String` and `U32CString` are treated as though they use UTF-32 //! encoding, even if they may contain values outside the valid Unicode character range. //! //! # Remarks on UTF-16 Code Units //! //! *Code units* are the 16-bit units that comprise UTF-16 sequences. Code units //! can specify Unicode code points either as single units or in *surrogate pairs*. Because every //! code unit might be part of a surrogate pair, many regular string operations, including //! indexing into a wide string, writing to a wide string, or even iterating a wide string should //! be handled with care and are greatly discouraged. Some operations have safer alternatives //! provided, such as Unicode code point iteration instead of code unit iteration. Always keep in //! mind that the number of code units (`len()`) of a wide string is **not** equivalent to the //! number of Unicode characters in the string, merely the length of the UTF-16 encoding sequence. //! In fact, Unicode code points do not even have a one-to-one mapping with characters! //! //! UTF-32 simply encodes Unicode code points as-is in 32-bit values, but Unicode character code //! points are reserved only for 21-bits. Again, Unicode code points do not have a one-to-one //! mapping with the concept of a visual character glyph. //! //! # FFI with C/C++ `wchar_t` //! //! C/C++'s `wchar_t` (and C++'s corresponding `widestring`) varies in size depending on compiler //! and platform. Typically, `wchar_t` is 16-bits on Windows and 32-bits on most Unix-based //! platforms. For convenience when using `wchar_t`-based FFI's, type aliases for the corresponding //! string types are provided: `WideString` aliases `U16String` on Windows or `U32String` //! elsewhere, `WideCString` aliases `U16CString` or `U32CString`, etc. The `WideChar` alias //! is also provided, aliasing `u16` or `u32`. //! //! When not interacting with a FFI using `wchar_t`, it is recommended to use the string types //! directly rather than via the wide alias. //! //! # Examples //! //! The following example uses `U16String` to get Windows error messages, since `FormatMessageW` //! returns a string length for us and we don't need to pass error messages into other FFI //! functions so we don't need to worry about nul values. //! //! ```rust //! # #[cfg(not(windows))] //! # fn main() {} //! # extern crate winapi; //! # extern crate widestring; //! # #[cfg(windows)] //! # fn main() { //! use winapi::um::winbase::{FormatMessageW, LocalFree, FORMAT_MESSAGE_FROM_SYSTEM, //! FORMAT_MESSAGE_ALLOCATE_BUFFER, FORMAT_MESSAGE_IGNORE_INSERTS}; //! use winapi::shared::ntdef::LPWSTR; //! use winapi::shared::minwindef::HLOCAL; //! use std::ptr; //! use widestring::U16String; //! # use winapi::shared::minwindef::DWORD; //! # let error_code: DWORD = 0; //! //! let U16Str: U16String; //! unsafe { //! // First, get a string buffer from some windows api such as FormatMessageW... //! let mut buffer: LPWSTR = ptr::null_mut(); //! let strlen = FormatMessageW(FORMAT_MESSAGE_FROM_SYSTEM | //! FORMAT_MESSAGE_ALLOCATE_BUFFER | //! FORMAT_MESSAGE_IGNORE_INSERTS, //! ptr::null(), //! error_code, // error code from GetLastError() //! 0, //! (&mut buffer as *mut LPWSTR) as LPWSTR, //! 0, //! ptr::null_mut()); //! //! // Get the buffer as a wide string //! U16Str = U16String::from_ptr(buffer, strlen as usize); //! // Since U16String creates an owned copy, it's safe to free original buffer now //! // If you didn't want an owned copy, you could use &U16Str. //! LocalFree(buffer as HLOCAL); //! } //! // Convert to a regular Rust String and use it to your heart's desire! //! let message = U16Str.to_string_lossy(); //! # assert_eq!(message, "The operation completed successfully.\r\n"); //! # } //! ``` //! //! The following example is the functionally the same, only using `U16CString` instead. //! //! ```rust //! # #[cfg(not(windows))] //! # fn main() {} //! # extern crate winapi; //! # extern crate widestring; //! # #[cfg(windows)] //! # fn main() { //! use winapi::um::winbase::{FormatMessageW, LocalFree, FORMAT_MESSAGE_FROM_SYSTEM, //! FORMAT_MESSAGE_ALLOCATE_BUFFER, FORMAT_MESSAGE_IGNORE_INSERTS}; //! use winapi::shared::ntdef::LPWSTR; //! use winapi::shared::minwindef::HLOCAL; //! use std::ptr; //! use widestring::U16CString; //! # use winapi::shared::minwindef::DWORD; //! # let error_code: DWORD = 0; //! //! let U16Str: U16CString; //! unsafe { //! // First, get a string buffer from some windows api such as FormatMessageW... //! let mut buffer: LPWSTR = ptr::null_mut(); //! FormatMessageW(FORMAT_MESSAGE_FROM_SYSTEM | //! FORMAT_MESSAGE_ALLOCATE_BUFFER | //! FORMAT_MESSAGE_IGNORE_INSERTS, //! ptr::null(), //! error_code, // error code from GetLastError() //! 0, //! (&mut buffer as *mut LPWSTR) as LPWSTR, //! 0, //! ptr::null_mut()); //! //! // Get the buffer as a wide string //! U16Str = U16CString::from_ptr_str(buffer); //! // Since U16CString creates an owned copy, it's safe to free original buffer now //! // If you didn't want an owned copy, you could use &U16CStr. //! LocalFree(buffer as HLOCAL); //! } //! // Convert to a regular Rust String and use it to your heart's desire! //! let message = U16Str.to_string_lossy(); //! # assert_eq!(message, "The operation completed successfully.\r\n"); //! # } //! ``` #![deny(future_incompatible)] #![warn( unused, anonymous_parameters, missing_docs, missing_copy_implementations, missing_debug_implementations, trivial_casts, trivial_numeric_casts )] use std::fmt::Debug; mod platform; mod ucstring; mod ustring; pub use ucstring::*; pub use ustring::*; /// Marker trait for primitive types used to represent UTF character data. Should not be used /// directly. pub trait UChar: Debug + Sized + Copy + Ord + Eq { /// NUL character value const NUL: Self; } impl UChar for u16 { const NUL: u16 = 0; } impl UChar for u32 { const NUL: u32 = 0; } /// String slice reference for `U16String`. /// /// `U16Str` is to `U16String` as `str` is to `String`. /// /// `U16Str` is not aware of nul values. Strings may or may not be nul-terminated, and may /// contain invalid and ill-formed UTF-16 data. These strings are intended to be used with /// FFI functions that directly use string length, where the strings are known to have proper /// nul-termination already, or where strings are merely being passed through without modification. /// /// `WideCStr` should be used instead of nul-aware strings are required. /// /// `U16Str` can be converted to many other string types, including `OsString` and `String`, making /// proper Unicode FFI safe and easy. pub type U16Str = UStr<u16>; /// An owned, mutable "wide" string for FFI that is **not** nul-aware. /// /// `U16String` is not aware of nul values. Strings may or may not be nul-terminated, and may /// contain invalid and ill-formed UTF-16 data. These strings are intended to be used with /// FFI functions that directly use string length, where the strings are known to have proper /// nul-termination already, or where strings are merely being passed through without modification. /// /// `WideCString` should be used instead if nul-aware strings are required. /// /// `U16String` can be converted to and from many other standard Rust string types, including /// `OsString` and `String`, making proper Unicode FFI safe and easy. /// /// # Examples /// /// The following example constructs a `U16String` and shows how to convert a `U16String` to a /// regular Rust `String`. /// /// ```rust /// use widestring::U16String; /// let s = "Test"; /// // Create a wide string from the rust string /// let wstr = U16String::from_str(s); /// // Convert back to a rust string /// let rust_str = wstr.to_string_lossy(); /// assert_eq!(rust_str, "Test"); /// ``` pub type U16String = UString<u16>; /// C-style wide string reference for `U16CString`. /// /// `U16CStr` is aware of nul values. Unless unchecked conversions are used, all `U16CStr` /// strings end with a nul-terminator in the underlying buffer and contain no internal nul values. /// The strings may still contain invalid or ill-formed UTF-16 data. These strings are intended to /// be used with FFI functions such as Windows API that may require nul-terminated strings. /// /// `U16CStr` can be converted to and from many other string types, including `U16String`, /// `OsString`, and `String`, making proper Unicode FFI safe and easy. pub type U16CStr = UCStr<u16>; /// An owned, mutable C-style "wide" string for FFI that is nul-aware and nul-terminated. /// /// `U16CString` is aware of nul values. Unless unchecked conversions are used, all `U16CString` /// strings end with a nul-terminator in the underlying buffer and contain no internal nul values. /// The strings may still contain invalid or ill-formed UTF-16 data. These strings are intended to /// be used with FFI functions such as Windows API that may require nul-terminated strings. /// /// `U16CString` can be converted to and from many other string types, including `U16String`, /// `OsString`, and `String`, making proper Unicode FFI safe and easy. /// /// # Examples /// /// The following example constructs a `U16CString` and shows how to convert a `U16CString` to a /// regular Rust `String`. /// /// ```rust /// use widestring::U16CString; /// let s = "Test"; /// // Create a wide string from the rust string /// let wstr = U16CString::from_str(s).unwrap(); /// // Convert back to a rust string /// let rust_str = wstr.to_string_lossy(); /// assert_eq!(rust_str, "Test"); /// ``` pub type U16CString = UCString<u16>; /// String slice reference for `U32String`. /// /// `U32Str` is to `U32String` as `str` is to `String`. /// /// `U32Str` is not aware of nul values. Strings may or may not be nul-terminated, and may /// contain invalid and ill-formed UTF-32 data. These strings are intended to be used with /// FFI functions that directly use string length, where the strings are known to have proper /// nul-termination already, or where strings are merely being passed through without modification. /// /// `WideCStr` should be used instead of nul-aware strings are required. /// /// `U32Str` can be converted to many other string types, including `OsString` and `String`, making /// proper Unicode FFI safe and easy. pub type U32Str = UStr<u32>; /// An owned, mutable 32-bit wide string for FFI that is **not** nul-aware. /// /// `U32String` is not aware of nul values. Strings may or may not be nul-terminated, and may /// contain invalid and ill-formed UTF-32 data. These strings are intended to be used with /// FFI functions that directly use string length, where the strings are known to have proper /// nul-termination already, or where strings are merely being passed through without modification. /// /// `U32CString` should be used instead if nul-aware 32-bit strings are required. /// /// `U32String` can be converted to and from many other standard Rust string types, including /// `OsString` and `String`, making proper Unicode FFI safe and easy. /// /// # Examples /// /// The following example constructs a `U32String` and shows how to convert a `U32String` to a /// regular Rust `String`. /// /// ```rust /// use widestring::U32String; /// let s = "Test"; /// // Create a wide string from the rust string /// let wstr = U32String::from_str(s); /// // Convert back to a rust string /// let rust_str = wstr.to_string_lossy(); /// assert_eq!(rust_str, "Test"); /// ``` pub type U32String = UString<u32>; /// C-style wide string reference for `U32CString`. /// /// `U32CStr` is aware of nul values. Unless unchecked conversions are used, all `U32CStr` /// strings end with a nul-terminator in the underlying buffer and contain no internal nul values. /// The strings may still contain invalid or ill-formed UTF-32 data. These strings are intended to /// be used with FFI functions such as Windows API that may require nul-terminated strings. /// /// `U32CStr` can be converted to and from many other string types, including `U32String`, /// `OsString`, and `String`, making proper Unicode FFI safe and easy. pub type U32CStr = UCStr<u32>; /// An owned, mutable C-style wide string for FFI that is nul-aware and nul-terminated. /// /// `U32CString` is aware of nul values. Unless unchecked conversions are used, all `U32CString` /// strings end with a nul-terminator in the underlying buffer and contain no internal nul values. /// The strings may still contain invalid or ill-formed UTF-32 data. These strings are intended to /// be used with FFI functions such as Windows API that may require nul-terminated strings. /// /// `U32CString` can be converted to and from many other string types, including `U32String`, /// `OsString`, and `String`, making proper Unicode FFI safe and easy. /// /// # Examples /// /// The following example constructs a `U32CString` and shows how to convert a `U32CString` to a /// regular Rust `String`. /// /// ```rust /// use widestring::U32CString; /// let s = "Test"; /// // Create a wide string from the rust string /// let wstr = U32CString::from_str(s).unwrap(); /// // Convert back to a rust string /// let rust_str = wstr.to_string_lossy(); /// assert_eq!(rust_str, "Test"); /// ``` pub type U32CString = UCString<u32>; #[cfg(not(windows))] /// Alias for `U16String` or `U32String` depending on platform. Intended to match typical C `wchar_t` size on platform. pub type WideString = U32String; #[cfg(not(windows))] /// Alias for `U16CString` or `U32CString` depending on platform. Intended to match typical C `wchar_t` size on platform. pub type WideCString = U32CString; #[cfg(not(windows))] /// Alias for `U16Str` or `U32Str` depending on platform. Intended to match typical C `wchar_t` size on platform. pub type WideStr = U32Str; #[cfg(not(windows))] /// Alias for `U16CStr` or `U32CStr` depending on platform. Intended to match typical C `wchar_t` size on platform. pub type WideCStr = U32CStr; #[cfg(not(windows))] /// Alias for `u16` or `u32` depending on platform. Intended to match typical C `wchar_t` size on platform. pub type WideChar = u32; #[cfg(windows)] /// Alias for `U16String` or `U32String` depending on platform. Intended to match typical C `wchar_t` size on platform. pub type WideString = U16String; #[cfg(windows)] /// Alias for `U16CString` or `U32CString` depending on platform. Intended to match typical C `wchar_t` size on platform. pub type WideCString = U16CString; #[cfg(windows)] /// Alias for `U16Str` or `U32Str` depending on platform. Intended to match typical C `wchar_t` size on platform. pub type WideStr = U16Str; #[cfg(windows)] /// Alias for `U16CStr` or `U32CStr` depending on platform. Intended to match typical C `wchar_t` size on platform. pub type WideCStr = U16CStr; #[cfg(windows)] /// Alias for `u16` or `u32` depending on platform. Intended to match typical C `wchar_t` size on platform. pub type WideChar = u16;