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    * Erases a range of elements.(delete from heap).
  90    */
  91   Iterator Erase(Iterator first, Iterator last)
  92   {
  93     auto itr = first;
  94     while(itr < last)
  95     {
  96       Delete(*itr);
  97       ++itr;
  98     }
  99
 100     return Vector<T>::Erase(first, last);
 101   }
 102
 103   /**
 104    * Erase an object from OwnerContainer
 105    * @param object to remove
 106    */
 107   inline void EraseObject(T object)
 108   {
 109     DALI_ASSERT_DEBUG(object && "NULL object not allowed");
 110
 111     Iterator            iter    = Vector<T>::Begin();
 112     const ConstIterator endIter = Vector<T>::End();
 113     for(; iter != endIter; ++iter)
 114     {
 115       if(*iter == object)
 116       {
 117         Erase(iter);
 118         return;
 119       }
 120     }
 121   }
 122
 123   /**
 124    * Release the ownership of an object, without deleting it.
 125    * @param[in] position A dereferencable iterator to an element in mContainer.
 126    * @post iterators are invalidated by this method.
 127    * @return pointer to the released item
 128    */
 129   T Release(Iterator position)
 130   {
 131     T pointer = *position;
 132     Vector<T>::Erase(position);
 133     return pointer;
 134   }
 135
 136   /**
 137    * Destroy all of the elements in the container.
 138    */
 139   void Clear()
 140   {
 141     ConstIterator end = Vector<T>::End();
 142     for(Iterator iter = Vector<T>::Begin(); iter != end; ++iter)
 143     {
 144       Delete(*iter);
 145     }
 146     Vector<T>::Clear();
 147   }
 148
 149   /**
 150    * Resizes the container to hold specific amount of elements
 151    * @param size to resize to
 152    */
 153   void Resize(SizeType size)
 154   {
 155     if(size < VectorBase::Count())
 156     {
 157       // OwnerContainer owns these heap-allocated objects
 158       ConstIterator end = Vector<T>::End();
 159       for(Iterator iter = Vector<T>::Begin() + size; iter != end; ++iter)
 160       {
 161         Delete(*iter);
 162       }
 163     }
 164     Vector<T>::Resize(size);
 165   }
 166
 167   /**
 168    * Move the ownership of objects from another OwnerContainer to this one
 169    * without deleting them. It will keep the original items here as well.
 170    * @param[in] source where to move elements from to this OwnerContainer
 171    */
 172   void MoveFrom(OwnerContainer& source)
 173   {
 174     typename Vector<T>::SizeType sourceCount = source.Count();
 175     // if source is empty, nothing to move
 176     if(sourceCount > 0u)
 177     {
 178       // Optimisation for the case that this is empty
 179       if(IsEmpty())
 180       {
 181         VectorBase::Swap(source);
 182       }
 183       else
 184       {
 185         // make space for new items
 186         Vector<T>::Reserve(VectorBase::Count() + sourceCount);
 187         Iterator      iter = source.Begin();
 188         ConstIterator end  = source.End();
 189         for(; iter != end; ++iter)
 190         {
 191           T pointer = *iter;
 192           Vector<T>::PushBack(pointer);
 193         }
 194         // cannot call Clear on OwnerContainer as that deletes the elements
 195         source.Vector<T>::Clear();
 196       }
 197     }
 198   }
 199
 200 private:
 201   /**
 202    * @brief delete the contents of the pointer
 203    * Function provided to allow classes to provide a custom destructor through template specialisation
 204    * @param pointer to the object
 205    */
 206   void Delete(T pointer)
 207   {
 208     delete pointer;
 209   }
 210 };
 211
 212 } // namespace Dali
 213
 214 #endif //DALI_OWNER_CONTAINER_H