[Windows version] WindowImpl cleanup, fixes and improvements. 36/242136/3
authorGyörgy Straub <g.straub@partner.samsung.com>
Mon, 24 Aug 2020 10:33:35 +0000 (11:33 +0100)
committerGyörgy Straub <g.straub@partner.samsung.com>
Tue, 25 Aug 2020 14:17:59 +0000 (15:17 +0100)
- renamed the wordy WindowsPlatformImplementation namespace to simply
  WindowsPlatform;
- Made the invariant windowStyle data member, and the edge width / height
  getters that depend on it, into static consts;
- WindowImpl::CreateHwnd() is now static, and no longer takes the name
  of the window class;
- The window class is only registered once, and then shared (instead of
  registering one for every window, since everything about it - except
  the name - was shared);
- The window class is unregistered once there are no windows left;
- WindowImpl unregisters itself from the event handlers when destroyed,
  or a new HWND was set;
- removed redundant static keyword from constant;
- renamed mHwndToListeners to fit the convention, and moved it into
  an anonymous namespace;

Change-Id: Ic3e6c614539cc939080bf785ffd7d2443ea1703e
Signed-off-by: György Straub <g.straub@partner.samsung.com>
dali/internal/system/windows/callback-manager-win.cpp
dali/internal/system/windows/timer-impl-win.cpp
dali/internal/system/windows/trigger-event.cpp
dali/internal/window-system/windows/platform-implement-win.cpp
dali/internal/window-system/windows/platform-implement-win.h
dali/internal/window-system/windows/window-base-win.cpp
dali/internal/window-system/windows/window-base-win.h

index b840cc5..27f9465 100755 (executable)
@@ -62,7 +62,7 @@ bool WinCallbackManager::AddIdleCallback( CallbackBase* callback, bool hasReturn
 \r
   mCallbacks.insert(callback);\r
 \r
-  WindowsPlatformImplementation::PostWinThreadMessage( WIN_CALLBACK_EVENT, reinterpret_cast<uint64_t>(callback), 0 );\r
+  WindowsPlatform::PostWinThreadMessage( WIN_CALLBACK_EVENT, reinterpret_cast<uint64_t>(callback), 0 );\r
 \r
   return true;\r
 }\r
index 7691199..c30c164 100755 (executable)
@@ -80,7 +80,7 @@ void Timer::Start()
 {
   if( 0 > mImpl->mId )
   {
-    mImpl->mId = WindowsPlatformImplementation::SetTimer( mImpl->mInterval, TimerSourceFunc, this );
+    mImpl->mId = WindowsPlatform::SetTimer( mImpl->mInterval, TimerSourceFunc, this );
   }
 }
 
@@ -88,7 +88,7 @@ void Timer::Stop()
 {
   if( 0 <= mImpl->mId )
   {
-    WindowsPlatformImplementation::KillTimer( mImpl->mId );
+    WindowsPlatform::KillTimer( mImpl->mId );
     mImpl->mId = -1;
   }
 }
index af42ad6..66221cb 100755 (executable)
@@ -42,7 +42,7 @@ TriggerEvent::TriggerEvent( CallbackBase* callback, TriggerEventInterface::Optio
   mOptions( options )\r
 {\r
   // Create accompanying file descriptor.\r
-  mThreadID = WindowsPlatformImplementation::GetCurrentThreadId();\r
+  mThreadID = WindowsPlatform::GetCurrentThreadId();\r
 \r
   if ( mThreadID < 0)\r
   {\r
@@ -70,7 +70,7 @@ void TriggerEvent::Trigger()
     // Increment event counter by 1.\r
     // Writing to the file descriptor triggers the Dispatch() method in the other thread\r
     // (if in multi-threaded environment).\r
-    WindowsPlatformImplementation::PostWinThreadMessage( WIN_CALLBACK_EVENT, reinterpret_cast<uint64_t>( mSelfCallback ), 0, mThreadID );\r
+    WindowsPlatform::PostWinThreadMessage( WIN_CALLBACK_EVENT, reinterpret_cast<uint64_t>( mSelfCallback ), 0, mThreadID );\r
   }\r
   else\r
   {\r
index 65d76b4..d2b7374 100755 (executable)
@@ -27,7 +27,7 @@
 
 namespace
 {
-static constexpr float INCH = 25.4;
+constexpr float INCH = 25.4;
 }
 
 namespace Dali
@@ -39,7 +39,7 @@ namespace Internal
 namespace Adaptor
 {
 
-namespace WindowsPlatformImplementation
+namespace WindowsPlatform
 {
 
 LRESULT CALLBACK WinProc( HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam )
@@ -50,7 +50,56 @@ LRESULT CALLBACK WinProc( HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam )
   return ret;
 }
 
-std::map<uint64_t, WindowImpl*> mHWndToListener;
+namespace
+{
+
+const std::string DALI_WINDOW_CLASS_NAME = "DaliWindow";
+
+uint32_t sNumWindows = 0;
+
+void EnsureWindowClassRegistered()
+{
+  if (sNumWindows == 0)
+  {
+    WNDCLASS cs = { 0 };
+    cs.cbClsExtra = 0;
+    cs.cbWndExtra = 0;
+    cs.hbrBackground = (HBRUSH)(COLOR_WINDOW + 2);
+    cs.hCursor = NULL;
+    cs.hIcon = NULL;
+    cs.hInstance = GetModuleHandle(NULL);
+    cs.lpfnWndProc = (WNDPROC)WinProc;
+    cs.lpszClassName = DALI_WINDOW_CLASS_NAME.c_str();
+    cs.lpszMenuName = NULL;
+    cs.style = CS_VREDRAW | CS_HREDRAW;
+    RegisterClass(&cs);
+  }
+}
+
+void EnsureWindowClassUnregistered()
+{
+  if (sNumWindows == 0)
+  {
+    UnregisterClass(DALI_WINDOW_CLASS_NAME.c_str(), GetModuleHandle(NULL));
+  }
+}
+
+std::map<uint64_t, WindowImpl*> sHWndToListener;
+
+void RemoveListener(uint64_t hWnd)
+{
+  std::map<uint64_t, WindowImpl*>::iterator x = sHWndToListener.find(hWnd);
+  if (sHWndToListener.end() != x)
+  {
+    sHWndToListener.erase(x);
+  }
+}
+
+}
+
+const uint32_t WindowImpl::STYLE = WS_OVERLAPPED;
+const int32_t WindowImpl::EDGE_WIDTH = 8;
+const int32_t WindowImpl::EDGE_HEIGHT = 18;
 
 WindowImpl::WindowImpl()
 {
@@ -58,19 +107,18 @@ WindowImpl::WindowImpl()
   mHWnd = 0;
   mHdc = 0;
   listener = NULL;
-  windowStyle = WS_OVERLAPPED;
 }
 
 WindowImpl::~WindowImpl()
 {
-  mHWndToListener.erase( mHWnd );
+  RemoveListener(mHWnd);
 }
 
 void WindowImpl::ProcWinMessage( uint64_t hWnd, uint32_t uMsg, uint64_t wParam, uint64_t lParam )
 {
-  std::map<uint64_t, WindowImpl*>::iterator x = mHWndToListener.find( hWnd );
+  std::map<uint64_t, WindowImpl*>::iterator x = sHWndToListener.find( hWnd );
 
-  if( mHWndToListener.end() != x )
+  if( sHWndToListener.end() != x )
   {
     CallbackBase* listener = x->second->listener;
 
@@ -102,7 +150,6 @@ int WindowImpl::GetColorDepth()
 }
 
 uint64_t WindowImpl::CreateHwnd(
-  _In_opt_ const char *lpClassName,
   _In_opt_ const char *lpWindowName,
   _In_ int X,
   _In_ int Y,
@@ -110,25 +157,25 @@ uint64_t WindowImpl::CreateHwnd(
   _In_ int nHeight,
   _In_opt_ uint64_t parent )
 {
-  WNDCLASS cs = { 0 };
-  cs.cbClsExtra = 0;
-  cs.cbWndExtra = 0;
-  cs.hbrBackground = (HBRUSH)( COLOR_WINDOW + 2 );
-  cs.hCursor = NULL;
-  cs.hIcon = NULL;
-  cs.hInstance = GetModuleHandle( NULL );
-  cs.lpfnWndProc = (WNDPROC)WinProc;
-  cs.lpszClassName = lpClassName;
-  cs.lpszMenuName = NULL;
-  cs.style = CS_VREDRAW | CS_HREDRAW;
-  RegisterClass( &cs );
-
-  HWND hWnd = CreateWindow( lpClassName, lpWindowName, windowStyle, X, Y, nWidth + 2 * GetEdgeWidth(), nHeight + 2 * GetEdgeHeight(), NULL, NULL, cs.hInstance, NULL );
+  EnsureWindowClassRegistered();
+  ++sNumWindows;
+
+  HWND hWnd = CreateWindow( DALI_WINDOW_CLASS_NAME.c_str(), lpWindowName, STYLE, X, Y,
+    nWidth + 2 * EDGE_WIDTH, nHeight + 2 * EDGE_HEIGHT, NULL, NULL, GetModuleHandle(NULL), NULL );
   ::ShowWindow( hWnd, SW_SHOW );
 
-  SetHWND( reinterpret_cast<uint64_t>(hWnd) );
+  return reinterpret_cast<uint64_t>(hWnd);
+}
 
-  return mHWnd;
+void WindowImpl::DestroyHWnd(uint64_t hWnd)
+{
+  if (hWnd != 0)
+  {
+    ::DestroyWindow(reinterpret_cast<HWND>(hWnd));
+
+    --sNumWindows;
+    EnsureWindowClassUnregistered();
+  }
 }
 
 void WindowImpl::SetListener( CallbackBase *callback )
@@ -144,49 +191,20 @@ bool WindowImpl::PostWinMessage(
   return (bool)PostMessage( reinterpret_cast<HWND>( mHWnd ), Msg, wParam, lParam );
 }
 
-int32_t WindowImpl::GetEdgeWidth()
-{
-  switch( windowStyle )
-  {
-  case WS_OVERLAPPED:
-  {
-    return 8;
-  }
-  default:
-  {
-    return 0;
-  }
-  }
-}
-
-int32_t WindowImpl::GetEdgeHeight()
-{
-  switch( windowStyle )
-  {
-  case WS_OVERLAPPED:
-  {
-    return 18;
-  }
-  default:
-  {
-    return 0;
-  }
-  }
-}
-
 void WindowImpl::SetHWND( uint64_t inHWnd )
 {
   if (mHWnd != inHWnd)
   {
+    RemoveListener(mHWnd);
+
     mHWnd = inHWnd;
     mHdc = reinterpret_cast<uint64_t>(GetDC(reinterpret_cast<HWND>(mHWnd)));
     colorDepth = GetDeviceCaps(reinterpret_cast<HDC>(mHdc), BITSPIXEL) * GetDeviceCaps(reinterpret_cast<HDC>(mHdc), PLANES);
 
-    std::map<uint64_t, WindowImpl*>::iterator x = mHWndToListener.find(mHWnd);
-
-    if (mHWndToListener.end() == x)
+    std::map<uint64_t, WindowImpl*>::iterator x = sHWndToListener.find(mHWnd);
+    if (sHWndToListener.end() == x)
     {
-      mHWndToListener.insert(std::make_pair(mHWnd, this));
+      sHWndToListener.insert(std::make_pair(mHWnd, this));
     }
     else
     {
index e84dce7..6c84b31 100755 (executable)
@@ -34,7 +34,7 @@ namespace Internal
 namespace Adaptor\r
 {\r
 \r
-namespace WindowsPlatformImplementation\r
+namespace WindowsPlatform\r
 {\r
 \r
 bool PostWinThreadMessage(\r
@@ -60,18 +60,17 @@ unsigned int GetCurrentMilliSeconds( void );
 class WindowImpl\r
 {\r
 public:\r
+  static const uint32_t STYLE;\r
+  static const int32_t EDGE_WIDTH;\r
+  static const int32_t EDGE_HEIGHT;\r
+\r
   WindowImpl();\r
 \r
   virtual ~WindowImpl();\r
 \r
   static void ProcWinMessage( uint64_t hWnd, uint32_t uMsg, uint64_t wParam, uint64_t lParam );\r
 \r
-  void GetDPI( float &xDpi, float &yDpi );\r
-\r
-  int GetColorDepth();\r
-\r
-  uint64_t CreateHwnd(\r
-    _In_opt_ const char *lpClassName,\r
+  static uint64_t CreateHwnd(\r
     _In_opt_ const char *lpWindowName,\r
     _In_ int X,\r
     _In_ int Y,\r
@@ -79,6 +78,12 @@ public:
     _In_ int nHeight,\r
     _In_opt_ uint64_t parent );\r
 \r
+  static void DestroyHWnd(uint64_t hWnd);\r
+\r
+  void GetDPI( float &xDpi, float &yDpi );\r
+\r
+  int GetColorDepth();\r
+\r
   void SetListener( CallbackBase *callback );\r
 \r
   bool PostWinMessage(\r
@@ -86,21 +91,14 @@ public:
     _In_ uint64_t wParam,\r
     _In_ uint64_t lParam );\r
 \r
-  int32_t GetEdgeWidth();\r
-\r
-  int32_t GetEdgeHeight();\r
-\r
   void SetHWND(uint64_t inHWnd);\r
   void SetWinProc();\r
 \r
 protected:\r
 \r
 private:\r
-\r
-  unsigned long windowStyle;\r
-\r
   int colorDepth;\r
-  uint64_t mHWnd;\r
+  uint64_t mHWnd; // no ownership, managed outside\r
   uint64_t mHdc;\r
 \r
   CallbackBase *listener;\r
index 86994da..90537a6 100755 (executable)
@@ -127,7 +127,7 @@ void WindowBaseWin::OnMouseButtonDown( int type, TWinEventInfo *event )
     Integration::Point point;
     point.SetDeviceId( touchEvent.multi.device );
     point.SetState( state );
-    point.SetScreenPosition( Vector2( touchEvent.x, touchEvent.y + mWindowImpl.GetEdgeHeight() ) );
+    point.SetScreenPosition( Vector2( touchEvent.x, touchEvent.y + WindowsPlatform::WindowImpl::EDGE_HEIGHT ) );
     point.SetRadius( touchEvent.multi.radius, Vector2( touchEvent.multi.radius_x, touchEvent.multi.radius_y ) );
     point.SetPressure( touchEvent.multi.pressure );
     point.SetAngle( Degree( touchEvent.multi.angle ) );
@@ -151,7 +151,7 @@ void WindowBaseWin::OnMouseButtonUp( int type, TWinEventInfo *event )
     Integration::Point point;
     point.SetDeviceId( touchEvent.multi.device );
     point.SetState( state );
-    point.SetScreenPosition( Vector2( touchEvent.x, touchEvent.y + mWindowImpl.GetEdgeHeight() ) );
+    point.SetScreenPosition( Vector2( touchEvent.x, touchEvent.y + WindowsPlatform::WindowImpl::EDGE_HEIGHT ) );
     point.SetRadius( touchEvent.multi.radius, Vector2( touchEvent.multi.radius_x, touchEvent.multi.radius_y ) );
     point.SetPressure( touchEvent.multi.pressure );
     point.SetAngle( Degree( touchEvent.multi.angle ) );
@@ -175,7 +175,7 @@ void WindowBaseWin::OnMouseButtonMove( int type, TWinEventInfo *event )
     Integration::Point point;
     point.SetDeviceId( touchEvent.multi.device );
     point.SetState( state );
-    point.SetScreenPosition( Vector2( touchEvent.x, touchEvent.y + mWindowImpl.GetEdgeHeight() ) );
+    point.SetScreenPosition( Vector2( touchEvent.x, touchEvent.y + WindowsPlatform::WindowImpl::EDGE_HEIGHT) );
     point.SetRadius( touchEvent.multi.radius, Vector2( touchEvent.multi.radius_x, touchEvent.multi.radius_y ) );
     point.SetPressure( touchEvent.multi.pressure );
     point.SetAngle( Degree( touchEvent.multi.angle ) );
@@ -205,7 +205,7 @@ void WindowBaseWin::OnKeyDown( int type, TWinEventInfo *event )
     DALI_LOG_INFO( gWindowBaseLogFilter, Debug::General, "WindowBaseWin::OnKeyDown\n" );
 
     int keyCode = event->wParam;
-    std::string keyName( WindowsPlatformImplementation::GetKeyName( keyCode ) );
+    std::string keyName( WindowsPlatform::GetKeyName( keyCode ) );
     std::string keyString;
     std::string emptyString;
 
@@ -228,7 +228,7 @@ void WindowBaseWin::OnKeyUp( int type, TWinEventInfo *event )
     DALI_LOG_INFO( gWindowBaseLogFilter, Debug::General, "WindowBaseWin::OnKeyDown\n" );
 
     int keyCode = event->wParam;
-    std::string keyName( WindowsPlatformImplementation::GetKeyName( keyCode ) );
+    std::string keyName( WindowsPlatform::GetKeyName( keyCode ) );
     std::string keyString;
     std::string emptyString;
 
@@ -479,7 +479,8 @@ unsigned int WindowBaseWin::GetSurfaceId( Any surface ) const
 
 void WindowBaseWin::CreateWinWindow( PositionSize positionSize, bool isTransparent )
 {
-  long hWnd = mWindowImpl.CreateHwnd( "Demo", "Demo", positionSize.x, positionSize.y, positionSize.width, positionSize.height, NULL );
+  long hWnd = WindowsPlatform::WindowImpl::CreateHwnd( "Demo", positionSize.x, positionSize.y, positionSize.width, positionSize.height, NULL );
+  mWindowImpl.SetHWND(hWnd);
 
   mWin32Window = static_cast<WinWindowHandle>(hWnd);
 
index 48c0560..b4e5a88 100755 (executable)
@@ -392,7 +392,7 @@ private:
   bool                                 mIsTransparent:1;    ///< Whether the window is transparent (32 bit or 24 bit)
   bool                                 mRotationAppSet:1;
 
-  WindowsPlatformImplementation::WindowImpl mWindowImpl;
+  WindowsPlatform::WindowImpl mWindowImpl;
 };
 
 } // namespace Adaptor