Merge "Update Object's public header comments" into devel/master
[platform/core/uifw/dali-core.git] / dali / public-api / object / base-handle.h
1 #ifndef __DALI_BASE_HANDLE_H__
2 #define __DALI_BASE_HANDLE_H__
3
4 /*
5  * Copyright (c) 2015 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 <string>
23
24 // INTERNAL INCLUDES
25 #include <dali/public-api/common/dali-common.h>
26 #include <dali/public-api/object/property-types.h>
27 #include <dali/public-api/object/property-value.h>
28 #include <dali/public-api/object/ref-object.h>
29 #include <dali/public-api/signals/functor-delegate.h>
30
31 namespace Dali
32 {
33 /**
34  * @addtogroup dali_core_object
35  * @{
36  */
37
38 class BaseObject;
39 class ConnectionTrackerInterface;
40 class TypeInfo;
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  * @SINCE_1_0.0
58  */
59 class DALI_IMPORT_API BaseHandle
60 {
61 public:
62
63   /**
64    * @brief This constructor is used by Dali New() methods.
65    *
66    * @SINCE_1_0.0
67    * @param [in] handle A pointer to a newly allocated Dali resource
68    */
69   BaseHandle(Dali::BaseObject* handle);
70
71   /**
72    * @brief This constructor provides an uninitialized Dali::BaseHandle.
73    *
74    * This should be initialized with a Dali New() method before use.
75    * Methods called on an uninitialized Dali::BaseHandle will assert.
76    * @code
77    * BaseHandle handle; // uninitialized
78    * handle.SomeMethod(); // unsafe! This will assert
79    *
80    * handle = SomeClass::New(); // now initialized
81    * handle.SomeMethod(); // safe
82    * @endcode
83    * @SINCE_1_0.0
84    */
85   BaseHandle();
86
87   /**
88    * @brief Dali::BaseHandle is intended as a base class
89    *
90    * This is non-virtual since derived BaseHandle types must not contain data.
91    * @SINCE_1_0.0
92    */
93   ~BaseHandle();
94
95   /**
96    * @brief This copy constructor is required for (smart) pointer semantics.
97    *
98    * @SINCE_1_0.0
99    * @param [in] handle A reference to the copied handle
100    */
101   BaseHandle(const BaseHandle& handle);
102
103   /**
104    * @brief This assignment operator is required for (smart) pointer semantics.
105    *
106    * It makes this handle use the same BaseObject as the copied handle
107    * @SINCE_1_0.0
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 Connects a void() functor to a specified signal.
115    *
116    * @SINCE_1_0.0
117    * @param [in] connectionTracker A connection tracker which can be used to disconnect.
118    * @param [in] signalName Name of the signal to connect to.
119    * @param [in] functor The functor to copy.
120    * @return True if the signal was available.
121    * @pre The signal must be available in this object.
122    */
123   template <class T>
124   bool ConnectSignal( ConnectionTrackerInterface* connectionTracker, const std::string& signalName, const T& functor )
125   {
126     return DoConnectSignal( connectionTracker, signalName, FunctorDelegate::New( functor ) );
127   }
128
129   /**
130    * @brief Perform action on this object with the given action name and attributes.
131    *
132    * @SINCE_1_0.0
133    * @param [in] actionName The command for the action.
134    * @param [in] attributes The list of attributes for the action.
135    * @return The action is performed by the object or not.
136    */
137   bool DoAction(const std::string& actionName, const Property::Map& attributes);
138
139   /**
140    * @brief Returns the type name for the Handle.
141    *
142    * Will return an empty string if the typename does not exist. This will happen for types that
143    * have not registered with type-registry.
144    *
145    * @SINCE_1_0.0
146    * @return The type name. Empty string if the typename does not exist.
147    */
148   const std::string& GetTypeName() const;
149
150   /**
151    * @brief Returns the type info for the Handle.
152    *
153    * @SINCE_1_0.0
154    * @return The type info.
155    */
156   bool GetTypeInfo(Dali::TypeInfo& info) const;
157
158 public:
159
160   // BaseHandle accessors
161
162   /**
163    * @brief Retrieve the internal Dali resource.
164    *
165    * This is useful for checking the reference count of the internal resource.
166    * This method will not check the validity of the handle so the caller is expected to check it by using if (handle)
167    * @SINCE_1_0.0
168    * @return The BaseObject which is referenced by the BaseHandle.
169    */
170   BaseObject& GetBaseObject();
171
172   /**
173    * @brief Retrieve the internal Dali resource.
174    *
175    * This is useful for checking the reference count of the internal resource.
176    * This method will not check the validity of the handle so the caller is expected to check it by using if (handle)
177    * @SINCE_1_0.0
178    * @return The BaseObject which is referenced by the BaseHandle.
179    */
180   const BaseObject& GetBaseObject() const;
181
182   /**
183    * @brief Resets the handle.
184    *
185    * If no other handle copies exist, the internal Dali resouce will be deleted.
186    * Calling this is not required i.e. it will happen automatically when a Dali::BaseHandle is destroyed.
187    * @SINCE_1_0.0
188    */
189   void Reset();
190
191   // BaseHandle comparisons - This is a variation of the safe bool idiom
192
193   /**
194    * @brief Pointer-to-member type.
195    * Objects can be implicitly converted to this for validity checks.
196    */
197   typedef void (BaseHandle::*BooleanType)() const;
198
199   /**
200    * @brief Converts an handle to a BooleanType.
201    *
202    * This is useful for checking whether the handle is empty.
203    * @SINCE_1_0.0
204    */
205   operator BooleanType() const;
206
207   /**
208    * @brief Equality operator overload.
209    *
210    * @SINCE_1_0.0
211    * @param [in] rhs A reference to the compared handle.
212    * @return true if the handle handles point to the same Dali resource, or if both are NULL.
213    */
214   bool operator==(const BaseHandle& rhs) const;
215
216   /**
217    * @brief Inequality operator overload.
218    *
219    * @SINCE_1_0.0
220    * @param [in] rhs A reference to the compared handle.
221    * @return true if the handle handles point to the different Dali resources.
222    */
223   bool operator!=(const BaseHandle& rhs) const;
224
225   /**
226    * @brief Get the reference counted object pointer.
227    *
228    * @SINCE_1_0.0
229    * @return A pointer to the reference counted object.
230    */
231   Dali::RefObject* GetObjectPtr() const;
232
233 private:
234
235   /**
236    * @brief Not intended for application developers.
237    *
238    * @SINCE_1_0.0
239    * @param [in] connectionTracker A connection tracker which can be used to disconnect.
240    * @param [in] signalName Name of the signal to connect to.
241    * @param [in] functorDelegate A newly allocatated functor delegate (takes ownership).
242    * @return True if the signal was available.
243    */
244   bool DoConnectSignal( ConnectionTrackerInterface* connectionTracker, const std::string& signalName, FunctorDelegate* functorDelegate );
245
246 protected:
247
248   /**
249    * @brief Used by the safe bool idiom.
250    *
251    * @SINCE_1_0.0
252    */
253   void ThisIsSaferThanReturningVoidStar() const {}
254
255 private:
256
257   IntrusivePtr<Dali::RefObject> mObjectHandle; ///< Object this handle points at.
258
259 };
260
261 /**
262  * @brief Template wrapper to downcast a base object handle to derived class handle.
263  *
264  * @SINCE_1_0.0
265  * @param handle to a base object
266  * @return handle pointer to either a valid deriving handle or an uninitialized handle
267  * @pre The BaseHandle has been initialized.
268  */
269 template< class T >
270 inline T DownCast( BaseHandle handle )
271 {
272   return T::DownCast( handle );
273 }
274
275 // See also BaseHandle::BooleanType() conversion
276
277 /**
278  * @brief Equality operator
279  * @SINCE_1_0.0
280  */
281 template <typename T>
282 inline bool operator==(const BaseHandle& lhs, const T& rhs)
283 {
284   // We depart from the safe bool idiom to allow Dali::BaseHandle derived classes to be compared
285   return lhs == static_cast<const BaseHandle&>(rhs);
286 }
287
288 /**
289  * @brief Equality operator
290  * @SINCE_1_0.0
291  */
292 template <typename T>
293 inline bool operator!=(const BaseHandle& lhs, const T& rhs)
294 {
295   // We depart from the safe bool idiom to allow Dali::BaseHandle derived classes to be compared
296   return lhs != static_cast<const BaseHandle&>(rhs);
297 }
298
299 /**
300  * @brief Less than operator
301  * @SINCE_1_0.0
302  */
303 inline bool operator<(const BaseHandle& lhs, const BaseHandle& rhs)
304 {
305   return lhs.GetObjectPtr() < rhs.GetObjectPtr();
306 }
307
308 /**
309  * @}
310  */
311 } // namespace Dali
312
313 #endif // __DALI_BASE_HANDLE_H__