icu::LocalArray< T > Class Template Reference

"Smart pointer" class, deletes objects via the C++ array delete[] operator. More...

`#include <localpointer.h>`

Inheritance diagram for icu::LocalArray< T >:

## Public Member Functions

| LocalArray (T *p=nullptr)
| Constructor takes ownership. More...
| LocalArray (T *p, UErrorCode &errorCode)
| Constructor takes ownership and reports an error if nullptr. More...
| LocalArray (LocalArray< T > &&src) noexcept
| Move constructor, leaves src with isNull(). More...
| LocalArray (std::unique_ptr< T[]> &&p)
| Constructs a LocalArray from a C++11 std::unique_ptr of an array type. More...
| ~LocalArray ()
| Destructor deletes the array it owns. More...
LocalArray< T > & | operator= (LocalArray< T > &&src) noexcept
| Move assignment operator, leaves src with isNull(). More...
LocalArray< T > & | operator= (std::unique_ptr< T[]> &&p) noexcept
| Move-assign from an std::unique_ptr to this LocalPointer. More...
void | swap (LocalArray< T > &other) noexcept
| Swap pointers. More...
void | adoptInstead (T *p)
| Deletes the array it owns, and adopts (takes ownership of) the one passed in. More...
void | adoptInsteadAndCheckErrorCode (T *p, UErrorCode &errorCode)
| Deletes the array it owns, and adopts (takes ownership of) the one passed in. More...
T & | operator[] (ptrdiff_t i) const
| Array item access (writable). More...
| operator std::unique_ptr< T[]> () &&
| Conversion operator to a C++11 std::unique_ptr. More...
Public Member Functions inherited from icu::LocalPointerBase< T >
| LocalPointerBase (T *p=nullptr)
| Constructor takes ownership. More...
| ~LocalPointerBase ()
| Destructor deletes the object it owns. More...
UBool | isNull () const
| nullptr check. More...
UBool | isValid () const
| nullptr check. More...
bool | operator== (const T *other) const
| Comparison with a simple pointer, so that existing code with ==nullptr need not be changed. More...
bool | operator!= (const T *other) const
| Comparison with a simple pointer, so that existing code with !=nullptr need not be changed. More...
T * | getAlias () const
| Access without ownership change. More...
T & | operator* () const
| Access without ownership change. More...
T * | operator-> () const
| Access without ownership change. More...
T * | orphan ()
| Gives up ownership; the internal pointer becomes nullptr. More...
void | adoptInstead (T *p)
| Deletes the object it owns, and adopts (takes ownership of) the one passed in. More...

## Friends

void | swap (LocalArray< T > &p1, LocalArray< T > &p2) noexcept
| Non-member LocalArray swap function. More...

## Additional Inherited Members

Static Public Member Functions inherited from icu::LocalPointerBase< T >
static void * | operator new (size_t)=delete
static void * | operator new[] (size_t)=delete
Protected Attributes inherited from icu::LocalPointerBase< T >
T * | ptr
| Actual pointer. More...

## Detailed Description

### template<typename T>
class icu::LocalArray< T >

"Smart pointer" class, deletes objects via the C++ array delete[] operator.

For most methods see the LocalPointerBase base class. Adds operator[] for array item access.

Usage example:

LocalArray<UnicodeString> a(new UnicodeString[2]);
a[0].append((char16_t)0x61);
if(some condition) { return; } // no need to explicitly delete the array
a.adoptInstead(new UnicodeString[4]);
a[3].append((char16_t)0x62).append((char16_t)0x63).reverse();
// no need to explicitly delete the array

See also
  LocalPointerBase

Stable:
  ICU 4.4

Definition at line 366 of file localpointer.h.

## Constructor & Destructor Documentation

## LocalArray() [1/4]

template<typename T >

icu::LocalArray< T >::LocalArray | ( | T * | p = `nullptr` | ) |

inline explicit

Constructor takes ownership.

Parameters

  p | simple pointer to an array of T objects that is adopted

Stable:
  ICU 4.4

Definition at line 375 of file localpointer.h.

## LocalArray() [2/4]

template<typename T >

icu::LocalArray< T >::LocalArray | ( | T * | p,
|  | UErrorCode & | errorCode
| ) |  |

inline

Constructor takes ownership and reports an error if nullptr.

This constructor is intended to be used with other-class constructors that may report a failure UErrorCode, so that callers need to check only for U_FAILURE(errorCode) and not also separately for isNull().

Parameters

  p | simple pointer to an array of T objects that is adopted
  errorCode | in/out UErrorCode, set to U_MEMORY_ALLOCATION_ERROR if p==nullptr and no other failure code had been set

Stable:
  ICU 56

Definition at line 389 of file localpointer.h.

References U_MEMORY_ALLOCATION_ERROR, and U_SUCCESS.

## LocalArray() [3/4]

template<typename T >

icu::LocalArray< T >::LocalArray | ( | LocalArray< T > && | src | ) |

inline noexcept

Move constructor, leaves src with isNull().

Parameters

  src | source smart pointer

Stable:
  ICU 56

Definition at line 399 of file localpointer.h.

References icu::LocalPointerBase< T >::ptr.

## LocalArray() [4/4]

template<typename T >

icu::LocalArray< T >::LocalArray | ( | std::unique_ptr< T[]> && | p | ) |

inline explicit

Constructs a LocalArray from a C++11 std::unique_ptr of an array type.

The LocalPointer steals the array owned by the std::unique_ptr.

This constructor works via move semantics. If your std::unique_ptr is in a local variable, you must use std::move.

Parameters

  p | The std::unique_ptr from which the array will be stolen.

Stable:
  ICU 64

Definition at line 413 of file localpointer.h.

## ~LocalArray()

template<typename T >

icu::LocalArray< T >::~LocalArray | ( |  | ) |

inline

Destructor deletes the array it owns.

Stable:
  ICU 4.4

Definition at line 420 of file localpointer.h.

## Member Function Documentation

## adoptInstead()

template<typename T >

void icu::LocalArray< T >::adoptInstead | ( | T * | p | ) |

inline

Deletes the array it owns, and adopts (takes ownership of) the one passed in.

Parameters

  p | simple pointer to an array of T objects that is adopted

Stable:
  ICU 4.4

Definition at line 475 of file localpointer.h.

## adoptInsteadAndCheckErrorCode()

template<typename T >

void icu::LocalArray< T >::adoptInsteadAndCheckErrorCode | ( | T * | p,
|  | UErrorCode & | errorCode
| ) |  |

inline

Deletes the array it owns, and adopts (takes ownership of) the one passed in.

If U_FAILURE(errorCode), then the current array is retained and the new one deleted.

If U_SUCCESS(errorCode) but the input pointer is nullptr, then U_MEMORY_ALLOCATION_ERROR is set, the current array is deleted, and nullptr is set.

Parameters

  p | simple pointer to an array of T objects that is adopted
  errorCode | in/out UErrorCode, set to U_MEMORY_ALLOCATION_ERROR if p==nullptr and no other failure code had been set

Stable:
  ICU 56

Definition at line 494 of file localpointer.h.

References U_MEMORY_ALLOCATION_ERROR, and U_SUCCESS.

## operator std::unique_ptr< T[]>()

template<typename T >

icu::LocalArray< T >::operator std::unique_ptr< T[]> | ( |  | ) | &&

inline

Conversion operator to a C++11 std::unique_ptr.

Disowns the object and gives it to the returned std::unique_ptr.

This operator works via move semantics. If your LocalPointer is in a local variable, you must use std::move.

Returns
  An std::unique_ptr owning the pointer previously owned by this icu::LocalPointer.

Stable:
  ICU 64

Definition at line 525 of file localpointer.h.

## operator=() [1/2]

template<typename T >

LocalArray<T>& icu::LocalArray< T >::operator= | ( | LocalArray< T > && | src | ) |

inline noexcept

Move assignment operator, leaves src with isNull().

The behavior is undefined if *this and src are the same object.

Parameters

  src | source smart pointer

Returns
  *this

Stable:
  ICU 56

Definition at line 430 of file localpointer.h.

References icu::LocalPointerBase< T >::ptr.

## operator=() [2/2]

template<typename T >

LocalArray<T>& icu::LocalArray< T >::operator= | ( | std::unique_ptr< T[]> && | p | ) |

inline noexcept

Move-assign from an std::unique_ptr to this LocalPointer.

Steals the array from the std::unique_ptr.

Parameters

  p | The std::unique_ptr from which the array will be stolen.

Returns
  *this

Stable:
  ICU 64

Definition at line 445 of file localpointer.h.

## operator[]()

template<typename T >

T& icu::LocalArray< T >::operator[] | ( | ptrdiff_t | i | ) | const

inline

Array item access (writable).

No index bounds check.

Parameters

  i | array index

Returns
  reference to the array item

Stable:
  ICU 4.4

Definition at line 512 of file localpointer.h.

## swap()

template<typename T >

void icu::LocalArray< T >::swap | ( | LocalArray< T > & | other | ) |

inline noexcept

Swap pointers.

Parameters

  other | other smart pointer

Stable:
  ICU 56

Definition at line 455 of file localpointer.h.

References icu::LocalPointerBase< T >::ptr.

## Friends And Related Function Documentation

## swap

template<typename T >

void swap | ( | LocalArray< T > & | p1,
|  | LocalArray< T > & | p2
| ) |  |

friend

Non-member LocalArray swap function.

Parameters

  p1 | will get p2's pointer
  p2 | will get p1's pointer

Stable:
  ICU 56

Definition at line 466 of file localpointer.h.

The documentation for this class was generated from the following file:

- common/unicode/localpointer.h