dali/devel-api/common/owner-container.h

   1 #ifndef DALI_OWNER_CONTAINER_H
   2 #define DALI_OWNER_CONTAINER_H
   3
   4 /*
   5  * Copyright (c) 2020 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // INTERNAL INCLUDES
  22 #include <dali/public-api/common/dali-common.h>
  23 #include <dali/public-api/common/dali-vector.h>
  24
  25 namespace Dali
  26 {
  27 /**
  28  * OwnerContainer is a vector which own heap-allocated objects.
  29  * Unlike vector this will call delete on the stored pointers during destruction.
  30  * For example, you can define a vector of heap-allocated Node objects:
  31  * @code
  32  *   typedef OwnerContainer< Node* > NodeContainer;
  33  *
  34  *   NodeContainer container;
  35  *   container.PushBack( new Node() );
  36  *   // container is now responsible for calling delete on Node
  37  *
  38  * @endcode
  39  */
  40 template<class T>
  41 class OwnerContainer : public Dali::Vector<T>
  42 {
  43 public:
  44   using SizeType      = typename Dali::Vector<T>::SizeType;
  45   using Iterator      = typename Vector<T>::Iterator;
  46   using ConstIterator = typename Vector<T>::ConstIterator;
  47
  48   /**
  49    * Create a pointer-container.
  50    */
  51   OwnerContainer() = default;
  52
  53   /**
  54    * Non-virtual destructor; OwnerContainer<T> is not suitable as base class.
  55    */
  56   ~OwnerContainer()
  57   {
  58     Clear();
  59     VectorBase::Release();
  60   }
  61
  62   // Not copyable or movable
  63   OwnerContainer(const OwnerContainer&) = delete;            ///< Deleted copy constructor
  64   OwnerContainer(OwnerContainer&&)      = delete;            ///< Deleted move constructor
  65   OwnerContainer& operator=(const OwnerContainer&) = delete; ///< Deleted copy assignment operator
  66   OwnerContainer& operator=(OwnerContainer&&) = delete;      ///< Deleted move assignment operator
  67
  68   /**
  69    * Test whether the container is empty.
  70    * @return True if the container is empty
  71    */
  72   bool IsEmpty() const
  73   {
  74     return VectorBase::Count() == 0u;
  75   }
  76
  77   /**
  78    * Erase an object from the container (delete from heap).
  79    * @param[in] position A dereferencable iterator to an element in mContainer.
  80    * @return iterator pointing to next element
  81    */
  82   Iterator Erase(Iterator position)
  83   {
  84     Delete(*position);
  85     return Vector<T>::Erase(position);
  86   }
  87
  88   /**
  89    * Erase an object from OwnerContainer
  90    * @param object to remove
  91    */
  92   inline void EraseObject(T object)
  93   {
  94     DALI_ASSERT_DEBUG(object && "NULL object not allowed");
  95
  96     Iterator            iter    = Vector<T>::Begin();
  97     const ConstIterator endIter = Vector<T>::End();
  98     for(; iter != endIter; ++iter)
  99     {
 100       if(*iter == object)
 101       {
 102         Erase(iter);
 103         return;
 104       }
 105     }
 106   }
 107
 108   /**
 109    * Release the ownership of an object, without deleting it.
 110    * @param[in] position A dereferencable iterator to an element in mContainer.
 111    * @post iterators are invalidated by this method.
 112    * @return pointer to the released item
 113    */
 114   T Release(Iterator position)
 115   {
 116     T pointer = *position;
 117     Vector<T>::Erase(position);
 118     return pointer;
 119   }
 120
 121   /**
 122    * Destroy all of the elements in the container.
 123    */
 124   void Clear()
 125   {
 126     ConstIterator end = Vector<T>::End();
 127     for(Iterator iter = Vector<T>::Begin(); iter != end; ++iter)
 128     {
 129       Delete(*iter);
 130     }
 131     Vector<T>::Clear();
 132   }
 133
 134   /**
 135    * Resizes the container to hold specific amount of elements
 136    * @param size to resize to
 137    */
 138   void Resize(SizeType size)
 139   {
 140     if(size < VectorBase::Count())
 141     {
 142       // OwnerContainer owns these heap-allocated objects
 143       ConstIterator end = Vector<T>::End();
 144       for(Iterator iter = Vector<T>::Begin() + size; iter != end; ++iter)
 145       {
 146         Delete(*iter);
 147       }
 148     }
 149     Vector<T>::Resize(size);
 150   }
 151
 152   /**
 153    * Move the ownership of objects from another OwnerContainer to this one
 154    * without deleting them. It will keep the original items here as well.
 155    * @param[in] source where to move elements from to this OwnerContainer
 156    */
 157   void MoveFrom(OwnerContainer& source)
 158   {
 159     typename Vector<T>::SizeType sourceCount = source.Count();
 160     // if source is empty, nothing to move
 161     if(sourceCount > 0u)
 162     {
 163       // Optimisation for the case that this is empty
 164       if(IsEmpty())
 165       {
 166         VectorBase::Swap(source);
 167       }
 168       else
 169       {
 170         // make space for new items
 171         Vector<T>::Reserve(VectorBase::Count() + sourceCount);
 172         Iterator      iter = source.Begin();
 173         ConstIterator end  = source.End();
 174         for(; iter != end; ++iter)
 175         {
 176           T pointer = *iter;
 177           Vector<T>::PushBack(pointer);
 178         }
 179         // cannot call Clear on OwnerContainer as that deletes the elements
 180         source.Vector<T>::Clear();
 181       }
 182     }
 183   }
 184
 185 private:
 186   /**
 187    * @brief delete the contents of the pointer
 188    * Function provided to allow classes to provide a custom destructor through template specialisation
 189    * @param pointer to the object
 190    */
 191   void Delete(T pointer)
 192   {
 193     delete pointer;
 194   }
 195 };
 196
 197 } // namespace Dali
 198
 199 #endif //DALI_OWNER_CONTAINER_H