dali/public-api/object/ref-object.h

   1 #ifndef __DALI_REF_OBJECT_H__
   2 #define __DALI_REF_OBJECT_H__
   3
   4 /*
   5  * Copyright (c) 2018 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 // EXTERNAL INCLUDES
  22 #include <dali/public-api/common/dali-common.h>
  23 #include <dali/public-api/common/intrusive-ptr.h>
  24
  25 #include <atomic>
  26
  27 namespace Dali
  28 {
  29 /**
  30  * @addtogroup dali_core_object
  31  * @{
  32  */
  33
  34 class Value;
  35
  36 /**
  37  * @brief Base class for reference counted objects.
  38  *
  39  * Typically this should be used with an intrusive pointer,
  40  * instead of calling Reference() and Unreference() methods directly.
  41  * @SINCE_1_0.0
  42  */
  43 class DALI_CORE_API RefObject
  44 {
  45 public:
  46
  47   /**
  48    * @brief Increments the object's reference count.
  49    * @SINCE_1_0.0
  50    */
  51   void Reference();
  52
  53   /**
  54    * @brief Decrements the object's reference count.
  55    *
  56    * When the reference count drops to zero, the object will self-destruct.
  57    * @SINCE_1_0.0
  58    */
  59   void Unreference();
  60
  61   /**
  62    * @brief Retrieves the object's reference count.
  63    *
  64    * @SINCE_1_0.0
  65    * @return The reference count
  66    */
  67   int ReferenceCount();
  68
  69 protected:
  70
  71   /**
  72    * @brief Default constructor.
  73    * @SINCE_1_0.0
  74    */
  75   RefObject();
  76
  77   /**
  78    * @brief RefObject is intended as a base class.
  79    *
  80    * A RefObject may only be deleted when its reference count is zero.
  81    * @SINCE_1_0.0
  82    */
  83   virtual ~RefObject();
  84
  85   /**
  86    * @brief Copy constructor.
  87    *
  88    * The newly copied object will have a reference count of zero.
  89    * @SINCE_1_0.0
  90    * @param[in] rhs The object to copy
  91    */
  92   RefObject(const RefObject& rhs);
  93
  94   /**
  95    * @brief Assignment operator.
  96    *
  97    * The newly copied object will have a reference count of zero.
  98    * @SINCE_1_0.0
  99    * @param[in] rhs The object to copy
 100    * @return A reference to this
 101    */
 102   RefObject& operator=(const RefObject& rhs);
 103
 104 private:
 105   volatile std::atomic<int> mCount; ///< Reference count
 106 };
 107
 108 /**
 109  * @}
 110  */
 111 } // namespace Dali
 112
 113 #endif // __DALI_REF_OBJECT_H__