445326902b2f625f0c4fe8ecd3c483fa17356285
[platform/core/uifw/dali-adaptor.git] / dali / internal / adaptor / common / adaptor-impl.h
1 #ifndef DALI_INTERNAL_ADAPTOR_IMPL_H
2 #define DALI_INTERNAL_ADAPTOR_IMPL_H
3
4 /*
5  * Copyright (c) 2019 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/vector-wrapper.h>
23 #include <dali/public-api/common/view-mode.h>
24 #include <dali/public-api/math/rect.h>
25 #include <dali/public-api/signals/callback.h>
26 #include <dali/public-api/math/uint-16-pair.h>
27 #include <dali/integration-api/render-controller.h>
28
29 // INTERNAL INCLUDES
30 #include <dali/integration-api/adaptor.h>
31 #include <dali/integration-api/scene.h>
32
33 #ifdef DALI_ADAPTOR_COMPILATION
34 #include <dali/integration-api/scene-holder-impl.h>
35 #else
36 #include <dali/integration-api/adaptors/scene-holder-impl.h>
37 #endif
38
39 #include <dali/public-api/adaptor-framework/tts-player.h>
40 #include <dali/devel-api/adaptor-framework/clipboard.h>
41
42 #include <dali/internal/graphics/common/graphics-interface.h>
43
44 #include <dali/internal/legacy/common/tizen-platform-abstraction.h>
45 #include <dali/internal/adaptor/common/adaptor-internal-services.h>
46 #include <dali/internal/system/common/environment-options.h>
47 #include <dali/internal/system/common/core-event-interface.h>
48 #include <dali/internal/input/common/drag-and-drop-detector-impl.h>
49 #include <dali/internal/window-system/common/damage-observer.h>
50 #include <dali/internal/window-system/common/window-visibility-observer.h>
51 #include <dali/internal/system/common/kernel-trace.h>
52 #include <dali/internal/system/common/system-trace.h>
53 #include <dali/integration-api/trigger-event-factory.h>
54 #include <dali/internal/network/common/socket-factory.h>
55
56
57 namespace Dali
58 {
59
60 class RenderSurfaceInterface;
61
62 namespace Integration
63 {
64 class Core;
65 class GlAbstraction;
66 class Processor;
67 }
68
69 namespace Internal
70 {
71
72 namespace Adaptor
73 {
74 class DisplayConnection;
75 class GraphicsFactory;
76 class GestureManager;
77 class GlImplementation;
78 class GlSyncImplementation;
79 class ThreadController;
80 class TriggerEvent;
81 class CallbackManager;
82 class FeedbackPluginProxy;
83 class FeedbackController;
84 class VSyncMonitor;
85 class PerformanceInterface;
86 class LifeCycleObserver;
87 class ObjectProfiler;
88 class SceneHolder;
89
90 /**
91  * Implementation of the Adaptor class.
92  */
93 class Adaptor : public Integration::RenderController,
94                 public AdaptorInternalServices,
95                 public CoreEventInterface,
96                 public DamageObserver,
97                 public WindowVisibilityObserver
98 {
99 public:
100
101   typedef Dali::Adaptor::AdaptorSignalType AdaptorSignalType;
102
103   typedef Uint16Pair SurfaceSize;          ///< Surface size type
104
105   /**
106    * Creates a New Adaptor
107    * @param[in]  window              The window handle
108    * @param[in]  surface             A render surface can be one of the following
109    *                                  - Pixmap, adaptor will use existing Pixmap to draw on to
110    *                                  - Window, adaptor will use existing Window to draw on to
111    * @param[in]  configuration       The context loss configuration ( to choose resource discard policy )
112    * @param[in]  environmentOptions  A pointer to the environment options. If NULL then one is created.
113    */
114   static Dali::Adaptor* New( Dali::Integration::SceneHolder window,
115                              Dali::RenderSurfaceInterface* surface,
116                              Dali::Configuration::ContextLoss configuration,
117                              EnvironmentOptions* environmentOptions );
118
119   /**
120    * Creates a New Adaptor
121    * @param[in]  window              The window handle
122    * @param[in]  configuration       The context loss configuration ( to choose resource discard policy )
123    * @param[in]  environmentOptions  A pointer to the environment options. If NULL then one is created.
124    */
125   static Dali::Adaptor* New( Dali::Integration::SceneHolder window,
126                              Dali::Configuration::ContextLoss configuration,
127                              EnvironmentOptions* environmentOptions );
128
129   /**
130    * Creates a New Adaptor
131    * @param[in]  graphicsFactory     A factory that creates the graphics interface
132    * @param[in]  window              The window handle
133    * @param[in]  surface             A render surface can be one of the following
134    *                                  - Pixmap, adaptor will use existing Pixmap to draw on to
135    *                                  - Window, adaptor will use existing Window to draw on to
136    * @param[in]  configuration       The context loss configuration ( to choose resource discard policy )
137    * @param[in]  environmentOptions  A pointer to the environment options. If NULL then one is created.
138    */
139   static Dali::Adaptor* New( GraphicsFactory& graphicsFactory,
140                              Dali::Integration::SceneHolder window,
141                              Dali::RenderSurfaceInterface* surface,
142                              Dali::Configuration::ContextLoss configuration,
143                              EnvironmentOptions* environmentOptions );
144
145   /**
146    * Creates a New Adaptor
147    * @param[in]  graphicsFactory     A factory that creates the graphics interface
148    * @param[in]  window              The window handle
149    * @param[in]  configuration       The context loss configuration ( to choose resource discard policy )
150    * @param[in]  environmentOptions  A pointer to the environment options. If NULL then one is created.
151    */
152   static Dali::Adaptor* New( GraphicsFactory& graphicsFactory,
153                              Dali::Integration::SceneHolder window,
154                              Dali::Configuration::ContextLoss configuration,
155                              EnvironmentOptions* environmentOptions );
156
157   /**
158    * 2-step initialisation, this should be called after creating an adaptor instance.
159    * @param[in]  graphicsFactory     A factory that creates the graphics interface
160    * @param[in]  configuration       The context loss configuration ( to choose resource discard policy )
161    */
162   void Initialize( GraphicsFactory& graphicsFactory, Dali::Configuration::ContextLoss configuration );
163
164   /**
165    * Virtual destructor.
166    */
167   virtual ~Adaptor();
168
169   /**
170    * @copydoc Dali::Adaptor::Get()
171    */
172   static Dali::Adaptor& Get();
173
174   /**
175    * @copydoc Dali::Adaptor::IsAvailable()
176    */
177   static bool IsAvailable();
178
179   /**
180    * @copydoc Dali::Core::SceneCreated();
181    */
182   void SceneCreated();
183
184 public: // AdaptorInternalServices implementation
185   /**
186    * @copydoc Dali::Adaptor::Start()
187    */
188   virtual void Start();
189
190   /**
191    * @copydoc Dali::Adaptor::Pause()
192    */
193   virtual void Pause();
194
195   /**
196    * @copydoc Dali::Adaptor::Resume()
197    */
198   virtual void Resume();
199
200   /**
201    * @copydoc Dali::Adaptor::Stop()
202    */
203   virtual void Stop();
204
205   /**
206    * @copydoc Dali::Adaptor::ContextLost()
207    */
208   virtual void ContextLost();
209
210   /**
211    * @copydoc Dali::Adaptor::ContextRegained()
212    */
213   virtual void ContextRegained();
214
215   /**
216    * @copydoc Dali::EventFeeder::FeedTouchPoint()
217    */
218   virtual void FeedTouchPoint( TouchPoint& point, int timeStamp );
219
220   /**
221    * @copydoc Dali::EventFeeder::FeedWheelEvent()
222    */
223   virtual void FeedWheelEvent( WheelEvent& wheelEvent );
224
225   /**
226    * @copydoc Dali::EventFeeder::FeedKeyEvent()
227    */
228   virtual void FeedKeyEvent( KeyEvent& keyEvent );
229
230   /**
231    * @copydoc Dali::Adaptor::ReplaceSurface()
232    */
233   virtual void ReplaceSurface( Dali::Integration::SceneHolder window, Dali::RenderSurfaceInterface& surface );
234
235   /**
236    * @copydoc Dali::Adaptor::GetSurface()
237    */
238   virtual Dali::RenderSurfaceInterface& GetSurface() const;
239
240   /**
241    * @copydoc Dali::Adaptor::ReleaseSurfaceLock()
242    */
243   virtual void ReleaseSurfaceLock();
244
245   /**
246    * Retrieve the TtsPlayer.
247    * @param[in] mode The mode of TtsPlayer
248    * @return A handle to the TtsPlayer.
249    */
250   virtual Dali::TtsPlayer GetTtsPlayer(Dali::TtsPlayer::Mode mode);
251
252   /**
253    * @copydoc Dali::Adaptor::AddIdle()
254    */
255   virtual bool AddIdle( CallbackBase* callback, bool hasReturnValue, bool forceAdd );
256
257   /**
258    * Adds a new Window instance to the Adaptor
259    * @param[in]  childWindow The child window instance
260    * @param[in]  childWindowName The child window title/name
261    * @param[in]  childWindowClassName The class name that the child window belongs to
262    * @param[in]  childWindowMode The mode of the child window
263    */
264   virtual bool AddWindow( Dali::Integration::SceneHolder* childWindow,
265                           const std::string& childWindowName,
266                           const std::string& childWindowClassName,
267                           const bool& childWindowMode );
268
269   /**
270    * Removes an existing Window instance from the Adaptor
271    * @param[in]  window The Window instance
272    */
273   virtual bool RemoveWindow( Dali::Integration::SceneHolder* childWindow );
274
275   /**
276    * Removes an existing Window instance from the Adaptor
277    * @param[in]  windowName The Window name
278    * @note If two Windows have the same name, the first one that matches will be removed
279    */
280   virtual bool RemoveWindow( std::string childWindowName );
281
282   /**
283    * @copydoc Dali::Adaptor::RemoveIdle()
284    */
285   virtual void RemoveIdle( CallbackBase* callback );
286
287   /**
288    * Sets a pre-render callback.
289    */
290   void SetPreRenderCallback( CallbackBase* callback );
291
292   /**
293    * Removes an existing Window instance from the Adaptor
294    * @param[in]  childWindow The Window instance
295    */
296   bool RemoveWindow( Dali::Internal::Adaptor::SceneHolder* childWindow );
297
298 public:
299
300   /**
301    * @return the Core instance
302    */
303   virtual Dali::Integration::Core& GetCore();
304
305   /**
306    * @copydoc Dali::Adaptor::SetRenderRefreshRate()
307    */
308   void SetRenderRefreshRate( unsigned int numberOfVSyncsPerRender );
309
310   /**
311    * @copydoc Dali::Adaptor::SetUseHardwareVSync()
312    */
313   void SetUseHardwareVSync(bool useHardware);
314
315   /**
316    * Return the PlatformAbstraction.
317    * @return The PlatformAbstraction.
318    */
319   Integration::PlatformAbstraction& GetPlatformAbstraction() const;
320
321   /**
322    * Sets the Drag & Drop Listener.
323    * @param[in] detector The detector to send Drag & Drop events to.
324    */
325   void SetDragAndDropDetector( DragAndDropDetectorPtr detector );
326
327   /**
328    * Destroy the TtsPlayer of specific mode.
329    * @param[in] mode The mode of TtsPlayer to destroy
330    */
331   void DestroyTtsPlayer(Dali::TtsPlayer::Mode mode);
332
333   /**
334    * @brief Sets minimum distance in pixels that the fingers must move towards/away from each other in order to
335    * trigger a pinch gesture
336    *
337    * @param[in] distance The minimum pinch distance in pixels
338    */
339   void SetMinimumPinchDistance(float distance);
340
341   /**
342    * Gets native window handle
343    *
344    * @return native window handle
345    */
346   Any GetNativeWindowHandle();
347
348   /**
349    * Get the native display associated with the graphics backend
350    *
351    * @return A handle to the native display
352    */
353   Any GetGraphicsDisplay();
354
355   /**
356    * Sets use remote surface for Surface output
357    * @param[in] useRemoteSurface True if the remote surface is used
358    */
359   void SetUseRemoteSurface(bool useRemoteSurface);
360
361 public:
362
363   /**
364    * Adds an adaptor observer so that we can observe the adaptor's lifetime events.
365    * @param[in]  observer  The observer.
366    * @note Observers should remove themselves when they are destroyed.
367    */
368   void AddObserver( LifeCycleObserver& observer );
369
370   /**
371    * Removes the observer from the adaptor.
372    * @param[in]  observer  The observer to remove.
373    * @note Observers should remove themselves when they are destroyed.
374    */
375   void RemoveObserver( LifeCycleObserver& observer );
376
377   /**
378    * Emits the Notification event to the Dali core.
379    */
380   void SendNotificationEvent();
381
382   /**
383    * Request adaptor to update once
384    */
385   void RequestUpdateOnce();
386
387   /**
388    * @copydoc Dali::Adaptor::NotifySceneCreated()
389    */
390   void NotifySceneCreated();
391
392   /**
393    * @copydoc Dali::Adaptor::NotifyLanguageChanged()
394    */
395   void NotifyLanguageChanged();
396
397   /**
398    * Gets AppId of current application
399    */
400   void GetAppId( std::string& appId );
401
402   /**
403    * Informs core the surface size has changed
404    */
405   void SurfaceResizePrepare( Dali::RenderSurfaceInterface* surface, SurfaceSize surfaceSize );
406
407   /**
408    * Informs ThreadController the surface size has changed
409    */
410   void SurfaceResizeComplete( Dali::RenderSurfaceInterface* surface, SurfaceSize surfaceSize );
411
412   /**
413    * Sets layout direction of root by system language
414    * @param[in] locale System locale
415    */
416   void SetRootLayoutDirection( std::string locale );
417
418   /**
419    * @copydoc Dali::Adaptor::RenderOnce
420    */
421   void RenderOnce();
422
423   /**
424    * @copydoc Dali::Adaptor::GetLogFactory
425    */
426   const LogFactoryInterface& GetLogFactory();
427
428   /**
429    * @copydoc Dali::Adaptor::RegisterProcessor
430    */
431   void RegisterProcessor( Integration::Processor& processor );
432
433   /**
434    * @coydoc Dali::Adaptor::UnregisterProcessor
435    */
436   void UnregisterProcessor( Integration::Processor& processor );
437
438 public:  //AdaptorInternalServices
439
440   /**
441    * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetPlatformAbstractionInterface()
442    */
443   virtual Dali::Integration::PlatformAbstraction& GetPlatformAbstractionInterface();
444
445   /**
446    * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetDisplayConnectionInterface()
447    */
448   virtual Dali::DisplayConnection& GetDisplayConnectionInterface();
449
450   /**
451    * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetGraphicsInterface()
452    */
453   virtual GraphicsInterface& GetGraphicsInterface();
454
455   /**
456    * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetTriggerEventInterface()
457    */
458   virtual TriggerEventInterface& GetProcessCoreEventsTrigger();
459
460   /**
461    * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetTriggerEventFactoryInterface()
462    */
463   virtual TriggerEventFactoryInterface& GetTriggerEventFactoryInterface();
464
465   /**
466    * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetSocketFactoryInterface()
467    */
468   virtual SocketFactoryInterface& GetSocketFactoryInterface();
469
470   /**
471    * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetRenderSurfaceInterface()
472    */
473   virtual Dali::RenderSurfaceInterface* GetRenderSurfaceInterface();
474
475   /**
476    * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetVSyncMonitorInterface()
477    */
478   virtual VSyncMonitorInterface* GetVSyncMonitorInterface();
479
480   /**
481    * @copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetPerformanceInterface()
482    */
483   virtual PerformanceInterface* GetPerformanceInterface();
484
485   /**
486    * copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetKernelTraceInterface()
487    */
488   virtual TraceInterface& GetKernelTraceInterface();
489
490   /**
491    * copydoc Dali::Internal::Adaptor::AdaptorInternalServices::GetSystemTraceInterface()
492    */
493   virtual TraceInterface& GetSystemTraceInterface();
494
495 public: // Signals
496
497   /**
498    * @copydoc Dali::Adaptor::SignalResized
499    */
500   AdaptorSignalType& ResizedSignal()
501   {
502     return mResizedSignal;
503   }
504
505   /**
506    * @copydoc Dali::Adaptor::LanguageChangedSignal
507    */
508   AdaptorSignalType& LanguageChangedSignal()
509   {
510     return mLanguageChangedSignal;
511   }
512
513   /**
514    * Gets the gesture manager.
515    * @return The GestureManager
516    */
517   GestureManager* GetGestureManager() const
518   {
519     return mGestureManager;
520   }
521
522 private: // From Dali::Internal::Adaptor::CoreEventInterface
523
524   /**
525    * @copydoc Dali::Internal::Adaptor::CoreEventInterface::QueueCoreEvent()
526    */
527   virtual void QueueCoreEvent(const Dali::Integration::Event& event);
528
529   /**
530    * @copydoc Dali::Internal::Adaptor:CoreEventInterface:::ProcessCoreEvents()
531    */
532   virtual void ProcessCoreEvents();
533
534 private: // From Dali::Integration::RenderController
535
536   /**
537    * @copydoc Dali::Integration::RenderController::RequestUpdate()
538    */
539   virtual void RequestUpdate( bool forceUpdate );
540
541   /**
542    * @copydoc Dali::Integration::RenderController::RequestProcessEventsOnIdle()
543    */
544   virtual void RequestProcessEventsOnIdle( bool forceProcess );
545
546 private: // From Dali::Internal::Adaptor::WindowVisibilityObserver
547
548   /**
549    * Called when the window becomes fully or partially visible.
550    */
551   virtual void OnWindowShown();
552
553   /**
554    * Called when the window is fully hidden.
555    */
556   virtual void OnWindowHidden();
557
558 private: // From Dali::Internal::Adaptor::DamageObserver
559
560   /**
561    * @copydoc Dali::Internal::Adaptor::DamageObserver::OnDamaged()
562    */
563   void OnDamaged( const DamageArea& area );
564
565 private:
566
567   // Undefined
568   Adaptor(const Adaptor&) = delete;
569   Adaptor& operator=(Adaptor&) = delete;
570
571 private:
572
573   /**
574    * Assigns the render surface to the adaptor
575    *
576    */
577   void SetSurface(Dali::RenderSurfaceInterface *surface);
578
579   /**
580    * called after surface is created
581    */
582   void SurfaceInitialized();
583
584   /**
585    * Sends an notification message from main loop idle handler
586    */
587   bool ProcessCoreEventsFromIdle();
588
589   /**
590    * Gets path for data/resource storage.
591    * @param[out] path Path for data/resource storage
592    */
593   void GetDataStoragePath(std::string& path);
594
595   /**
596    * Sets up system information if needs
597    */
598   void SetupSystemInformation();
599
600   /**
601    * Adds a callback to be run when entering an idle state.
602    *
603    * A callback of the following type should be used:
604    * @code
605    *   bool MyFunction();
606    * @endcode
607    * This callback will be called repeatedly as long as it returns true. A return of 0 deletes this callback.
608    */
609   bool AddIdleEnterer( CallbackBase* callback, bool forceAdd );
610
611   /**
612    * Removes a previously added the idle enterer callback.
613    */
614   void RemoveIdleEnterer( CallbackBase* callback );
615
616 private:
617
618   /**
619    * Constructor
620    * @param[in]  window       window handle
621    * @param[in]  adaptor      The public adaptor
622    * @param[in]  surface      A render surface can be one of the following
623    *                          - Pixmap, adaptor will use existing Pixmap to draw on to
624    *                          - Window, adaptor will use existing Window to draw on to
625    * @param[in]  environmentOptions  A pointer to the environment options. If NULL then one is created.
626    */
627   Adaptor( Dali::Integration::SceneHolder window, Dali::Adaptor& adaptor, Dali::RenderSurfaceInterface* surface, EnvironmentOptions* environmentOptions );
628
629 private: // Types
630
631   enum State
632   {
633     READY,               ///< Initial state before Adaptor::Start is called.
634     RUNNING,             ///< Adaptor is running.
635     PAUSED,              ///< Adaptor has been paused.
636     PAUSED_WHILE_HIDDEN, ///< Adaptor is paused while window is hidden (& cannot be resumed until window is shown).
637     STOPPED,             ///< Adaptor has been stopped.
638   };
639
640   using SceneHolderPtr = IntrusivePtr< Dali::Internal::Adaptor::SceneHolder >;
641   using WindowContainer = std::vector<SceneHolderPtr>;
642   using ObserverContainer = std::vector<LifeCycleObserver*>;
643
644 private: // Data
645
646   AdaptorSignalType                     mResizedSignal;               ///< Resized signal.
647   AdaptorSignalType                     mLanguageChangedSignal;       ///< Language changed signal.
648
649   Dali::Adaptor&                        mAdaptor;                     ///< Reference to public adaptor instance.
650   State                                 mState;                       ///< Current state of the adaptor
651   Dali::Integration::Core*              mCore;                        ///< Dali Core
652   ThreadController*                     mThreadController;            ///< Controls the threads
653   VSyncMonitor*                         mVSyncMonitor;                ///< Monitors VSync events
654
655   GraphicsInterface*                    mGraphics;                    ///< Graphics interface
656   Dali::DisplayConnection*              mDisplayConnection;           ///< Display connection
657   WindowContainer                       mWindows;                     ///< A container of all the Windows that are currently created
658
659   TizenPlatform::TizenPlatformAbstraction* mPlatformAbstraction;      ///< Platform abstraction
660
661   CallbackManager*                      mCallbackManager;             ///< Used to install callbacks
662   bool                                  mNotificationOnIdleInstalled; ///< whether the idle handler is installed to send an notification event
663   TriggerEventInterface*                mNotificationTrigger;         ///< Notification event trigger
664   GestureManager*                       mGestureManager;              ///< Gesture manager
665   FeedbackPluginProxy*                  mDaliFeedbackPlugin;          ///< Used to access feedback support
666   FeedbackController*                   mFeedbackController;          ///< Plays feedback effects for Dali-Toolkit UI Controls.
667   Dali::TtsPlayer                       mTtsPlayers[Dali::TtsPlayer::MODE_NUM];                   ///< Provides TTS support
668   ObserverContainer                     mObservers;                   ///< A list of adaptor observer pointers
669   DragAndDropDetectorPtr                mDragAndDropDetector;         ///< The Drag & Drop detector
670   EnvironmentOptions*                   mEnvironmentOptions;          ///< environment options
671   PerformanceInterface*                 mPerformanceInterface;        ///< Performance interface
672   KernelTrace                           mKernelTracer;                ///< Kernel tracer
673   SystemTrace                           mSystemTracer;                ///< System tracer
674   TriggerEventFactory                   mTriggerEventFactory;         ///< Trigger event factory
675   ObjectProfiler*                       mObjectProfiler;              ///< Tracks object lifetime for profiling
676   SocketFactory                         mSocketFactory;               ///< Socket factory
677   const bool                            mEnvironmentOptionsOwned:1;   ///< Whether we own the EnvironmentOptions (and thus, need to delete it)
678   bool                                  mUseRemoteSurface;            ///< whether the remoteSurface is used or not
679
680 public:
681   inline static Adaptor& GetImplementation(Dali::Adaptor& adaptor) { return *adaptor.mImpl; }
682 };
683
684 } // namespace Internal
685
686 } // namespace Adaptor
687
688 } // namespace Dali
689
690 #endif // DALI_INTERNAL_ADAPTOR_IMPL_H