| // © 2017 and later: Unicode, Inc. and others. |
| // License & terms of use: http://www.unicode.org/copyright.html |
| |
| // char16ptr.h |
| // created: 2017feb28 Markus W. Scherer |
| |
| #ifndef __CHAR16PTR_H__ |
| #define __CHAR16PTR_H__ |
| |
| #include <cstddef> |
| #include "unicode/utypes.h" |
| |
| /** |
| * \file |
| * \brief C++ API: char16_t pointer wrappers with |
| * implicit conversion to/from bit-compatible raw pointer types. |
| * Also conversion functions from char16_t * to UChar * and OldUChar *. |
| */ |
| |
| U_NAMESPACE_BEGIN |
| |
| /** |
| * \def U_ALIASING_BARRIER |
| * Barrier for pointer anti-aliasing optimizations even across function boundaries. |
| * @internal |
| */ |
| #ifdef U_ALIASING_BARRIER |
| // Use the predefined value. |
| #elif (defined(__clang__) || defined(__GNUC__)) && (U_PLATFORM != U_PF_BROWSER_NATIVE_CLIENT) |
| # define U_ALIASING_BARRIER(ptr) asm volatile("" : : "rm"(ptr) : "memory") |
| #endif |
| |
| /** |
| * char16_t * wrapper with implicit conversion from distinct but bit-compatible pointer types. |
| * @draft ICU 59 |
| */ |
| class U_COMMON_API Char16Ptr final { |
| public: |
| /** |
| * Copies the pointer. |
| * @param p pointer |
| * @draft ICU 59 |
| */ |
| inline Char16Ptr(char16_t *p); |
| /** |
| * Converts the pointer to char16_t *. |
| * @param p pointer to be converted |
| * @draft ICU 59 |
| */ |
| inline Char16Ptr(uint16_t *p); |
| #if U_SIZEOF_WCHAR_T==2 || defined(U_IN_DOXYGEN) |
| /** |
| * Converts the pointer to char16_t *. |
| * (Only defined if U_SIZEOF_WCHAR_T==2.) |
| * @param p pointer to be converted |
| * @draft ICU 59 |
| */ |
| inline Char16Ptr(wchar_t *p); |
| #endif |
| /** |
| * nullptr constructor. |
| * @param p nullptr |
| * @draft ICU 59 |
| */ |
| inline Char16Ptr(std::nullptr_t p); |
| /** |
| * Destructor. |
| * @draft ICU 59 |
| */ |
| inline ~Char16Ptr(); |
| |
| /** |
| * Pointer access. |
| * @return the wrapped pointer |
| * @draft ICU 59 |
| */ |
| inline char16_t *get() const; |
| /** |
| * char16_t pointer access via type conversion (e.g., static_cast). |
| * @return the wrapped pointer |
| * @draft ICU 59 |
| */ |
| inline operator char16_t *() const { return get(); } |
| #if 0 |
| // this does not help ! |
| inline operator uint16_t *() const { |
| return reinterpret_cast<uint16_t*>(get()); |
| } |
| #endif |
| |
| private: |
| Char16Ptr() = delete; |
| |
| #ifdef U_ALIASING_BARRIER |
| template<typename T> static char16_t *cast(T *t) { |
| U_ALIASING_BARRIER(t); |
| return reinterpret_cast<char16_t *>(t); |
| } |
| |
| char16_t *p; |
| #else |
| union { |
| char16_t *cp; |
| uint16_t *up; |
| wchar_t *wp; |
| } u; |
| #endif |
| }; |
| |
| #ifdef U_ALIASING_BARRIER |
| |
| Char16Ptr::Char16Ptr(char16_t *p) : p(p) {} |
| Char16Ptr::Char16Ptr(uint16_t *p) : p(cast(p)) {} |
| #if U_SIZEOF_WCHAR_T==2 |
| Char16Ptr::Char16Ptr(wchar_t *p) : p(cast(p)) {} |
| #endif |
| Char16Ptr::Char16Ptr(std::nullptr_t p) : p(p) {} |
| Char16Ptr::~Char16Ptr() { |
| U_ALIASING_BARRIER(p); |
| } |
| |
| char16_t *Char16Ptr::get() const { return p; } |
| |
| #else |
| |
| Char16Ptr::Char16Ptr(char16_t *p) { u.cp = p; } |
| Char16Ptr::Char16Ptr(uint16_t *p) { u.up = p; } |
| #if U_SIZEOF_WCHAR_T==2 |
| Char16Ptr::Char16Ptr(wchar_t *p) { u.wp = p; } |
| #endif |
| Char16Ptr::Char16Ptr(std::nullptr_t p) { u.cp = p; } |
| Char16Ptr::~Char16Ptr() {} |
| |
| char16_t *Char16Ptr::get() const { return u.cp; } |
| |
| #endif |
| |
| /** |
| * const char16_t * wrapper with implicit conversion from distinct but bit-compatible pointer types. |
| * @draft ICU 59 |
| */ |
| class U_COMMON_API ConstChar16Ptr final { |
| public: |
| /** |
| * Copies the pointer. |
| * @param p pointer |
| * @draft ICU 59 |
| */ |
| inline ConstChar16Ptr(const char16_t *p); |
| /** |
| * Converts the pointer to char16_t *. |
| * @param p pointer to be converted |
| * @draft ICU 59 |
| */ |
| inline ConstChar16Ptr(const uint16_t *p); |
| #if U_SIZEOF_WCHAR_T==2 || defined(U_IN_DOXYGEN) |
| /** |
| * Converts the pointer to char16_t *. |
| * (Only defined if U_SIZEOF_WCHAR_T==2.) |
| * @param p pointer to be converted |
| * @draft ICU 59 |
| */ |
| inline ConstChar16Ptr(const wchar_t *p); |
| #endif |
| /** |
| * nullptr constructor. |
| * @param p nullptr |
| * @draft ICU 59 |
| */ |
| inline ConstChar16Ptr(const std::nullptr_t p); |
| /** |
| * Destructor. |
| * @draft ICU 59 |
| */ |
| inline ~ConstChar16Ptr(); |
| |
| /** |
| * Pointer access. |
| * @return the wrapped pointer |
| * @draft ICU 59 |
| */ |
| inline const char16_t *get() const; |
| /** |
| * char16_t pointer access via type conversion (e.g., static_cast). |
| * @return the wrapped pointer |
| * @draft ICU 59 |
| */ |
| inline operator const char16_t *() const { return get(); } |
| |
| private: |
| ConstChar16Ptr() = delete; |
| |
| #ifdef U_ALIASING_BARRIER |
| template<typename T> static const char16_t *cast(const T *t) { |
| U_ALIASING_BARRIER(t); |
| return reinterpret_cast<const char16_t *>(t); |
| } |
| |
| const char16_t *p; |
| #else |
| union { |
| const char16_t *cp; |
| const uint16_t *up; |
| const wchar_t *wp; |
| } u; |
| #endif |
| }; |
| |
| #ifdef U_ALIASING_BARRIER |
| |
| ConstChar16Ptr::ConstChar16Ptr(const char16_t *p) : p(p) {} |
| ConstChar16Ptr::ConstChar16Ptr(const uint16_t *p) : p(cast(p)) {} |
| #if U_SIZEOF_WCHAR_T==2 |
| ConstChar16Ptr::ConstChar16Ptr(const wchar_t *p) : p(cast(p)) {} |
| #endif |
| ConstChar16Ptr::ConstChar16Ptr(const std::nullptr_t p) : p(p) {} |
| ConstChar16Ptr::~ConstChar16Ptr() { |
| U_ALIASING_BARRIER(p); |
| } |
| |
| const char16_t *ConstChar16Ptr::get() const { return p; } |
| |
| #else |
| |
| ConstChar16Ptr::ConstChar16Ptr(const char16_t *p) { u.cp = p; } |
| ConstChar16Ptr::ConstChar16Ptr(const uint16_t *p) { u.up = p; } |
| #if U_SIZEOF_WCHAR_T==2 |
| ConstChar16Ptr::ConstChar16Ptr(const wchar_t *p) { u.wp = p; } |
| #endif |
| ConstChar16Ptr::ConstChar16Ptr(const std::nullptr_t p) { u.cp = p; } |
| ConstChar16Ptr::~ConstChar16Ptr() {} |
| |
| const char16_t *ConstChar16Ptr::get() const { return u.cp; } |
| |
| #endif |
| |
| /** |
| * Converts from const char16_t * to const UChar *. |
| * Includes an aliasing barrier if available. |
| * @param p pointer |
| * @return p as const UChar * |
| * @draft ICU 59 |
| */ |
| inline U_COMMON_API const UChar* U_EXPORT2 toUCharPtr(const char16_t *p) { |
| #ifdef U_ALIASING_BARRIER |
| U_ALIASING_BARRIER(p); |
| #endif |
| return reinterpret_cast<const UChar *>(p); |
| } |
| |
| /** |
| * Converts from char16_t * to UChar *. |
| * Includes an aliasing barrier if available. |
| * @param p pointer |
| * @return p as UChar * |
| * @draft ICU 59 |
| */ |
| inline U_COMMON_API UChar* U_EXPORT2 toUCharPtr(char16_t *p) { |
| #ifdef U_ALIASING_BARRIER |
| U_ALIASING_BARRIER(p); |
| #endif |
| return reinterpret_cast<UChar *>(p); |
| } |
| |
| /** |
| * Converts from const char16_t * to const OldUChar *. |
| * Includes an aliasing barrier if available. |
| * @param p pointer |
| * @return p as const OldUChar * |
| * @draft ICU 59 |
| */ |
| inline U_COMMON_API const OldUChar* U_EXPORT2 toOldUCharPtr(const char16_t *p) { |
| #ifdef U_ALIASING_BARRIER |
| U_ALIASING_BARRIER(p); |
| #endif |
| return reinterpret_cast<const OldUChar *>(p); |
| } |
| |
| /** |
| * Converts from char16_t * to OldUChar *. |
| * Includes an aliasing barrier if available. |
| * @param p pointer |
| * @return p as OldUChar * |
| * @draft ICU 59 |
| */ |
| inline U_COMMON_API OldUChar* U_EXPORT2 toOldUCharPtr(char16_t *p) { |
| #ifdef U_ALIASING_BARRIER |
| U_ALIASING_BARRIER(p); |
| #endif |
| return reinterpret_cast<OldUChar *>(p); |
| } |
| |
| U_NAMESPACE_END |
| |
| #endif // __CHAR16PTR_H__ |