capi/dali/public-api/object/base-handle.h

   1 #ifndef __DALI_BASE_HANDLE_H__
   2 #define __DALI_BASE_HANDLE_H__
   3
   4 /*
   5  * Copyright (c) 2014 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 /**
  22  * @addtogroup CAPI_DALI_OBJECT_MODULE
  23  * @{
  24  */
  25
  26 // EXTERNAL INCLUDES
  27 #include <string>
  28
  29 // INTERNAL INCLUDES
  30 #include <dali/public-api/common/dali-common.h>
  31 #include <dali/public-api/object/property-types.h>
  32 #include <dali/public-api/object/property-value.h>
  33 #include <dali/public-api/object/ref-object.h>
  34 #include <dali/public-api/signals/functor-delegate.h>
  35
  36 namespace Dali DALI_IMPORT_API
  37 {
  38
  39 class BaseObject;
  40 class ConnectionTrackerInterface;
  41
  42 /**
  43  * @brief Dali::BaseHandle is a handle to an internal Dali resource.
  44  *
  45  * Each Dali handle consists of a single private pointer, and a set of non-virtual forwarding functions.
  46  * This hides the internal implementation, so it may be modified without affecting the public interface.
  47  *
  48  * Dali handles have implicit smart-pointer semantics.
  49  * This avoids the need to match resource allocation methods like new/delete (the RAII idiom).
  50  *
  51  * Dali handles can be copied by value.
  52  * When a Dali handle is copied, both the copy and original will point to the same Dali resource.
  53  *
  54  * The internal Dali resources are reference counted. copying a Dali handle will increase the reference count.
  55  * A resource will not be deleted until all its Dali::BaseHandle handles are destroyed, or reset.
  56  *
  57  */
  58 class BaseHandle
  59 {
  60 public:
  61
  62   /**
  63    * @brief Used for null pointer assignment below
  64    */
  65   class NullType
  66   {
  67     NullType() { }
  68   };
  69
  70   /**
  71    * @brief This constructor is used by Dali New() methods.
  72    *
  73    * @param [in] handle A pointer to a newly allocated Dali resource
  74    */
  75   BaseHandle(Dali::BaseObject* handle);
  76
  77   /**
  78    * @brief This constructor provides an uninitialized Dali::BaseHandle.
  79    *
  80    * This should be initialized with a Dali New() method before use.
  81    * Methods called on an uninitialized Dali::BaseHandle will assert.
  82    * @code
  83    * BaseHandle handle; // uninitialized
  84    * handle.SomeMethod(); // unsafe! This will assert
  85    *
  86    * handle = SomeClass::New(); // now initialized
  87    * handle.SomeMethod(); // safe
  88    * @endcode
  89    */
  90   BaseHandle();
  91
  92   /**
  93    * @brief Dali::BaseHandle is intended as a base class.
  94    */
  95   virtual ~BaseHandle();
  96
  97   /**
  98    * @brief This copy constructor is required for (smart) pointer semantics.
  99    *
 100    * @param [in] handle A reference to the copied handle
 101    */
 102   BaseHandle(const BaseHandle& handle);
 103
 104   /**
 105    * @brief This assignment operator is required for (smart) pointer semantics.
 106    *
 107    * It makes this handle use the same BaseObject as the copied handle
 108    * @param [in] rhs  A reference to the copied handle
 109    * @return A reference to this handle
 110    */
 111   BaseHandle& operator=(const BaseHandle& rhs);
 112
 113   /**
 114    * @brief This method is defined to allow assignment of the NULL value,
 115    * and will throw an exception if passed any other value.
 116    *
 117    * Assigning to NULL is an alias for Reset().
 118    * @param [in] rhs  A NULL pointer
 119    * @return A reference to this handle
 120    */
 121   BaseHandle& operator=(NullType* rhs);
 122
 123   /**
 124    * @brief Connects a void() functor to a specified signal.
 125    *
 126    * @pre The signal must be available in this object.
 127    * @param [in] connectionTracker A connection tracker which can be used to disconnect.
 128    * @param [in] signalName Name of the signal to connect to.
 129    * @param [in] functor The functor to copy.
 130    * @return True if the signal was available.
 131    */
 132   template <class T>
 133   bool ConnectSignal( ConnectionTrackerInterface* connectionTracker, const std::string& signalName, const T& functor )
 134   {
 135     return DoConnectSignal( connectionTracker, signalName, FunctorDelegate::New( functor ) );
 136   }
 137
 138   /**
 139    * @brief Perform action on this object with the given action name and attributes.
 140    *
 141    * @param [in] actionName The command for the action.
 142    * @param [in] attributes The list of attributes for the action.
 143    * @return The action is performed by the object or not.
 144    */
 145   bool DoAction(const std::string& actionName, const std::vector<Property::Value>& attributes);
 146
 147   /**
 148    * @brief Returns the type name for the Handle.
 149    *
 150    * @return The type name.
 151    */
 152   const std::string& GetTypeName() const;
 153
 154 public:
 155
 156   // BaseHandle accessors
 157
 158   /**
 159    * @brief Retrieve the internal Dali resource.
 160    *
 161    * This is useful for checking the reference count of the internal resource.
 162    * This method will assert, if the Dali::BaseHandle has not been initialized.
 163    * @return The BaseObject which is referenced by the BaseHandle.
 164    */
 165   BaseObject& GetBaseObject();
 166
 167   /**
 168    * @brief Retrieve the internal Dali resource.
 169    *
 170    * This is useful for checking the reference count of the internal resource.
 171    * This method will assert, if the Dali::BaseHandle has not been initialized.
 172    * @return The BaseObject which is referenced by the BaseHandle.
 173    */
 174   const BaseObject& GetBaseObject() const;
 175
 176   /**
 177    * @brief Resets the handle.
 178    *
 179    * If no other handle copies exist, the internal Dali resouce will be deleted.
 180    * Calling this is not required i.e. it will happen automatically when a Dali::BaseHandle is destroyed.
 181    */
 182   void Reset();
 183
 184   // BaseHandle comparisons - This is a variation of the safe bool idiom
 185
 186   /**
 187    * @brief Pointer-to-member type.
 188    * Objects can be implicitly converted to this for validity checks.
 189    */
 190   typedef void (BaseHandle::*BooleanType)() const;
 191
 192   /**
 193    * @brief Converts an handle to a BooleanType.
 194    *
 195    * This is useful for checking whether the handle is empty.
 196    */
 197   operator BooleanType() const;
 198
 199   /**
 200    * @brief Equality operator overload.
 201    *
 202    * @param [in] rhs A reference to the compared handle.
 203    * @return true if the handle handles point to the same Dali resource, or if both are NULL.
 204    */
 205   bool operator==(const BaseHandle& rhs) const;
 206
 207   /**
 208    * @brief Inequality operator overload.
 209    *
 210    * @param [in] rhs A reference to the compared handle.
 211    * @return true if the handle handles point to the different Dali resources.
 212    */
 213   bool operator!=(const BaseHandle& rhs) const;
 214
 215   /**
 216    * @brief Get the reference counted object pointer.
 217    *
 218    * @return A pointer to the reference counted object.
 219    */
 220   Dali::RefObject* GetObjectPtr() const;
 221
 222 private:
 223
 224   /**
 225    * @brief Not intended for application developers.
 226    *
 227    * @param [in] connectionTracker A connection tracker which can be used to disconnect.
 228    * @param [in] signalName Name of the signal to connect to.
 229    * @param [in] functorDelegate A newly allocatated functor delegate (takes ownership).
 230    * @return True if the signal was available.
 231    */
 232   bool DoConnectSignal( ConnectionTrackerInterface* connectionTracker, const std::string& signalName, FunctorDelegate* functorDelegate );
 233
 234   /**
 235    * @brief Used by the safe bool idiom.
 236    *
 237    */
 238   void ThisIsSaferThanReturningVoidStar() const {}
 239
 240 private:
 241
 242   IntrusivePtr<Dali::RefObject> mObjectHandle; ///< Object this handle points at.
 243 };
 244
 245 /**
 246  * @brief Template wrapper to downcast an base object handle to derived class handle.
 247  *
 248  * @pre The BaseHandle has been initialized.
 249  * @param handle to a base object
 250  * @return handle pointer to either a valid deriving handle or an uninitialized handle
 251  */
 252 template< class T >
 253 T DownCast( BaseHandle handle )
 254 {
 255   return T::DownCast( handle );
 256 }
 257
 258 // See also BaseHandle::BooleanType() conversion
 259
 260 /**
 261  * @brief Equality operator
 262  */
 263 template <typename T>
 264 bool operator==(const BaseHandle& lhs, const T& rhs)
 265 {
 266   // We depart from the safe bool idiom to allow Dali::BaseHandle derived classes to be compared
 267   return lhs == static_cast<const BaseHandle&>(rhs);
 268 }
 269
 270 /**
 271  * @brief Equality operator
 272  */
 273 template <typename T>
 274 bool operator!=(const BaseHandle& lhs, const T& rhs)
 275 {
 276   // We depart from the safe bool idiom to allow Dali::BaseHandle derived classes to be compared
 277   return lhs != static_cast<const BaseHandle&>(rhs);
 278 }
 279
 280 // More Operators
 281
 282 /**
 283  * @brief Less than operator
 284  */
 285 bool operator<(const BaseHandle& lhs, const BaseHandle& rhs);
 286
 287 } // namespace Dali
 288
 289 /**
 290  * @}
 291  */
 292 #endif // __DALI_BASE_HANDLE_H__