Better fix

[wxWidgets.git] / src / msw / dcclient.cpp

diff --git a/src/msw/dcclient.cpp b/src/msw/dcclient.cpp
index e29e8b472fb0cbe85948fd7ad1792d528bd5f9e6..3eff38d0d4bbd01b181d52090bf2c6fb58537757 100644 (file)
--- a/src/msw/dcclient.cpp
+++ b/src/msw/dcclient.cpp
@@ -1,11 +1,11 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        dcclient.cpp
+// Name:        src/msw/dcclient.cpp

 // Purpose:     wxClientDC class
 // Author:      Julian Smart
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$
 // Purpose:     wxClientDC class
 // Author:      Julian Smart
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$

-// Copyright:   (c) Julian Smart and Markus Holzem
+// Copyright:   (c) Julian Smart

 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 


@@ -17,10 +17,6 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

-#ifdef __GNUG__
-    #pragma implementation "dcclient.h"
-#endif
-

 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 


@@ -28,24 +24,43 @@
     #pragma hdrstop
 #endif
 
     #pragma hdrstop
 #endif
 

-#include "wx/string.h"
-#include "wx/log.h"
-#include "wx/window.h"
+#include "wx/dcclient.h"
+#include "wx/msw/dcclient.h"
+
+#ifndef WX_PRECOMP
+    #include "wx/string.h"
+    #include "wx/log.h"
+    #include "wx/window.h"
+#endif

 
 #include "wx/msw/private.h"
 
 
 #include "wx/msw/private.h"
 

-#include "wx/dcclient.h"
+// ----------------------------------------------------------------------------
+// array/list types
+// ----------------------------------------------------------------------------
+
+struct WXDLLEXPORT wxPaintDCInfo
+{
+    wxPaintDCInfo(wxWindow *win, wxPaintDCImpl *dc)
+    {
+        hwnd = win->GetHWND();
+        hdc = dc->GetHDC();
+        count = 1;
+    }
+
+    WXHWND    hwnd;       // window for this DC
+    WXHDC     hdc;        // the DC handle
+    size_t    count;      // usage count
+};
+
+#include "wx/arrimpl.cpp"
+
+WX_DEFINE_OBJARRAY(wxArrayDCInfo)

 
 // ----------------------------------------------------------------------------
 // macros
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // macros
 // ----------------------------------------------------------------------------
 

-#if !USE_SHARED_LIBRARY
-    IMPLEMENT_DYNAMIC_CLASS(wxWindowDC, wxDC)
-    IMPLEMENT_DYNAMIC_CLASS(wxClientDC, wxWindowDC)
-    IMPLEMENT_DYNAMIC_CLASS(wxPaintDC, wxWindowDC)
-#endif
-

 // ----------------------------------------------------------------------------
 // global variables
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // global variables
 // ----------------------------------------------------------------------------


@@ -54,10 +69,10 @@ static PAINTSTRUCT g_paintStruct;
 
 #ifdef __WXDEBUG__
     // a global variable which we check to verify that wxPaintDC are only
 
 #ifdef __WXDEBUG__
     // a global variable which we check to verify that wxPaintDC are only

-    // created in resopnse to WM_PAINT message - doing this from elsewhere is a
-    // common programming error among wxWindows programmers and might lead to
+    // created in response to WM_PAINT message - doing this from elsewhere is a
+    // common programming error among wxWidgets programmers and might lead to

     // very subtle and difficult to debug refresh/repaint bugs.
     // very subtle and difficult to debug refresh/repaint bugs.

-    extern bool g_isPainting = FALSE;
+    int g_isPainting = 0;

 #endif // __WXDEBUG__
 
 // ===========================================================================
 #endif // __WXDEBUG__
 
 // ===========================================================================


@@ -65,121 +80,312 @@ static PAINTSTRUCT g_paintStruct;
 // ===========================================================================
 
 // ----------------------------------------------------------------------------
 // ===========================================================================
 
 // ----------------------------------------------------------------------------

-// wxWindowDC
+// wxMSWWindowDCImpl

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-wxWindowDC::wxWindowDC()
+IMPLEMENT_ABSTRACT_CLASS(wxWindowDCImpl, wxMSWDCImpl)
+
+wxWindowDCImpl::wxWindowDCImpl( wxDC *owner ) :
+   wxMSWDCImpl( owner )

 {
 {

-  m_canvas = NULL;

 }
 
 }
 

-wxWindowDC::wxWindowDC(wxWindow *the_canvas)
+wxWindowDCImpl::wxWindowDCImpl( wxDC *owner, wxWindow *window ) :
+   wxMSWDCImpl( owner )

 {
 {

-  m_canvas = the_canvas;
-  m_hDC = (WXHDC) ::GetWindowDC(GetWinHwnd(the_canvas) );
-  m_hDCCount++;
+    wxCHECK_RET( window, _T("invalid window in wxWindowDCImpl") );
+
+    m_window = window;
+    m_hDC = (WXHDC) ::GetWindowDC(GetHwndOf(m_window));

 
 

-  SetBackground(wxBrush(m_canvas->GetBackgroundColour(), wxSOLID));
+    // m_bOwnsDC was already set to false in the base class ctor, so the DC
+    // will be released (and not deleted) in ~wxDC
+    InitDC();

 }
 
 }
 

-wxWindowDC::~wxWindowDC()
+void wxWindowDCImpl::InitDC()

 {
 {

-  if (m_canvas && m_hDC)
-  {
-    SelectOldObjects(m_hDC);
+    // the background mode is only used for text background and is set in
+    // DrawText() to OPAQUE as required, otherwise always TRANSPARENT,
+    ::SetBkMode(GetHdc(), TRANSPARENT);
+
+    // default bg colour is pne of the window
+    SetBackground(wxBrush(m_window->GetBackgroundColour(), wxSOLID));
+
+    // since we are a window dc we need to grab the palette from the window
+#if wxUSE_PALETTE
+    InitializePalette();
+#endif
+}

 
 

-    ::ReleaseDC(GetWinHwnd(m_canvas), GetHdc());
-    m_hDC = 0;
-  }
+void wxWindowDCImpl::DoGetSize(int *width, int *height) const
+{
+    wxCHECK_RET( m_window, _T("wxWindowDCImpl without a window?") );

 
 

-  m_hDCCount--;
+    m_window->GetSize(width, height);

 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------

-// wxClientDC
+// wxClientDCImpl

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-wxClientDC::wxClientDC()
+IMPLEMENT_ABSTRACT_CLASS(wxClientDCImpl, wxWindowDCImpl)
+
+wxClientDCImpl::wxClientDCImpl( wxDC *owner ) :
+   wxWindowDCImpl( owner )

 {
 {

-  m_canvas = NULL;

 }
 
 }
 

-wxClientDC::wxClientDC(wxWindow *the_canvas)
+wxClientDCImpl::wxClientDCImpl( wxDC *owner, wxWindow *window ) :
+   wxWindowDCImpl( owner )

 {
 {

-  m_canvas = the_canvas;
-  m_hDC = (WXHDC) ::GetDC(GetWinHwnd(the_canvas));
+    wxCHECK_RET( window, _T("invalid window in wxClientDCImpl") );
+
+    m_window = window;
+    m_hDC = (WXHDC)::GetDC(GetHwndOf(window));

 
 

-  SetBackground(wxBrush(m_canvas->GetBackgroundColour(), wxSOLID));
+    // m_bOwnsDC was already set to false in the base class ctor, so the DC
+    // will be released (and not deleted) in ~wxDC
+
+    InitDC();

 }
 
 }
 

-wxClientDC::~wxClientDC()
+void wxClientDCImpl::InitDC()

 {
 {

-  if ( m_canvas && GetHdc() )
-  {
-    SelectOldObjects(m_hDC);
+    wxWindowDCImpl::InitDC();
+
+    // in wxUniv build we must manually do some DC adjustments usually
+    // performed by Windows for us
+    //
+    // we also need to take the menu/toolbar manually into account under
+    // Windows CE because they're just another control there, not anything
+    // special as usually under Windows
+#if defined(__WXUNIVERSAL__) || defined(__WXWINCE__)
+    wxPoint ptOrigin = m_window->GetClientAreaOrigin();
+    if ( ptOrigin.x || ptOrigin.y )
+    {
+        // no need to shift DC origin if shift is null
+        SetDeviceOrigin(ptOrigin.x, ptOrigin.y);
+    }

 
 

-    ::ReleaseDC(GetWinHwnd(m_canvas), GetHdc());
-    m_hDC = 0;
-  }
+    // clip the DC to avoid overwriting the non client area
+    wxSize size = m_window->GetClientSize();
+    DoSetClippingRegion(0, 0, size.x, size.y);
+#endif // __WXUNIVERSAL__ || __WXWINCE__

 }
 
 }
 

-// ----------------------------------------------------------------------------
-// wxPaintDC
-// ----------------------------------------------------------------------------
+wxClientDCImpl::~wxClientDCImpl()
+{
+}

 
 

-// TODO (VZ) I have still some doubts about this hack and I still think that we
-//           should store pairs of (hwnd, hdc) and not just the DC - what if
-//           BeginPaint() was called on other window? It seems to work like
-//           this, but to be sure about it we'd need to store hwnd too...
+void wxClientDCImpl::DoGetSize(int *width, int *height) const
+{
+    wxCHECK_RET( m_window, _T("wxClientDCImpl without a window?") );

 
 

-WXHDC  wxPaintDC::ms_PaintHDC = 0;
-size_t wxPaintDC::ms_PaintCount = 0; // count of ms_PaintHDC usage
+    m_window->GetClientSize(width, height);
+}
+
+// ----------------------------------------------------------------------------
+// wxPaintDCImpl
+// ----------------------------------------------------------------------------

 
 

-wxPaintDC::wxPaintDC()
+// VZ: initial implementation (by JACS) only remembered the last wxPaintDC
+//     created and tried to reuse it - this was supposed to take care of a
+//     situation when a derived class OnPaint() calls base class OnPaint()
+//     because in this case ::BeginPaint() shouldn't be called second time.
+//
+//     I'm not sure how useful this is, however we must remember the HWND
+//     associated with the last HDC as well - otherwise we may (and will!) try
+//     to reuse the HDC for another HWND which is a nice recipe for disaster.
+//
+//     So we store a list of windows for which we already have the DC and not
+//     just one single hDC. This seems to work, but I'm really not sure about
+//     the usefullness of the whole idea - IMHO it's much better to not call
+//     base class OnPaint() at all, or, if we really want to allow it, add a
+//     "wxPaintDC *" parameter to wxPaintEvent which should be used if it's
+//     !NULL instead of creating a new DC.
+
+IMPLEMENT_ABSTRACT_CLASS(wxPaintDCImpl, wxClientDCImpl)
+
+wxArrayDCInfo wxPaintDCImpl::ms_cache;
+
+wxPaintDCImpl::wxPaintDCImpl( wxDC *owner ) :
+   wxClientDCImpl( owner )

 {
 {

-  m_canvas = NULL;

 }
 
 }
 

-wxPaintDC::wxPaintDC(wxWindow *canvas)
+wxPaintDCImpl::wxPaintDCImpl( wxDC *owner, wxWindow *window ) :
+   wxClientDCImpl( owner )

 {
 {

-  wxCHECK_RET( canvas, "NULL canvas in wxPaintDC ctor" );
-  
+    wxCHECK_RET( window, wxT("NULL canvas in wxPaintDCImpl ctor") );
+

 #ifdef __WXDEBUG__
 #ifdef __WXDEBUG__

-  wxCHECK_RET( g_isPainting, _T("wxPaintDC may be created only in EVT_PAINT handler!") );
-#endif
+    if ( g_isPainting <= 0 )
+    {
+        wxFAIL_MSG( wxT("wxPaintDCImpl may be created only in EVT_PAINT handler!") );
+
+        return;
+    }
+#endif // __WXDEBUG__
+
+    m_window = window;
+
+    // do we have a DC for this window in the cache?
+    wxPaintDCInfo *info = FindInCache();
+    if ( info )
+    {
+        m_hDC = info->hdc;
+        info->count++;
+    }
+    else // not in cache, create a new one
+    {
+        m_hDC = (WXHDC)::BeginPaint(GetHwndOf(m_window), &g_paintStruct);
+        if (m_hDC)
+            ms_cache.Add(new wxPaintDCInfo(m_window, this));
+    }
+
+    // Note: at this point m_hDC can be NULL under MicroWindows, when dragging.
+    if (!GetHDC())
+        return;
+
+    // (re)set the DC parameters.
+    InitDC();
+
+    // the HDC can have a clipping box (which we didn't set), make sure our
+    // DoGetClippingBox() checks for it
+    m_clipping = true;
+}
+
+wxPaintDCImpl::~wxPaintDCImpl()
+{
+    if ( m_hDC )
+    {
+        SelectOldObjects(m_hDC);
+
+        size_t index;
+        wxPaintDCInfo *info = FindInCache(&index);
+
+        wxCHECK_RET( info, wxT("existing DC should have a cache entry") );
+
+        if ( --info->count == 0 )
+        {
+            ::EndPaint(GetHwndOf(m_window), &g_paintStruct);
+
+            ms_cache.RemoveAt(index);

 
 

-  m_canvas = canvas;
+            // Reduce the number of bogus reports of non-freed memory
+            // at app exit
+            if (ms_cache.IsEmpty())
+                ms_cache.Clear();
+        }
+        //else: cached DC entry is still in use

 
 

-  // Don't call Begin/EndPaint if it's already been called: for example, if
-  // calling a base class OnPaint.
-  if ( ms_PaintCount > 0 ) {
-    // it means that we've already called BeginPaint and so we must just
-    // reuse the same HDC (BeginPaint shouldn't be called more than once)
-    wxASSERT( ms_PaintHDC );
+        // prevent the base class dtor from ReleaseDC()ing it again
+        m_hDC = 0;
+    }
+}

 
 

-    m_hDC = ms_PaintHDC;
-    ms_PaintCount++;
-  }
-  else {
-    ms_PaintHDC =
-    m_hDC = (WXHDC)::BeginPaint((HWND)m_canvas->GetHWND(), &g_paintStruct);
-    ms_PaintCount = 1;
-    m_hDCCount++;
-  }
+wxPaintDCInfo *wxPaintDCImpl::FindInCache(size_t *index) const
+{
+    wxPaintDCInfo *info = NULL;
+    size_t nCache = ms_cache.GetCount();
+    for ( size_t n = 0; n < nCache; n++ )
+    {
+        wxPaintDCInfo *info1 = &ms_cache[n];
+        if ( info1->hwnd == m_window->GetHWND() )
+        {
+            info = info1;
+            if ( index )
+                *index = n;
+            break;
+        }
+    }

 
 

-  SetBackground(wxBrush(m_canvas->GetBackgroundColour(), wxSOLID));
+    return info;

 }
 
 }
 

-wxPaintDC::~wxPaintDC()
+// find the entry for this DC in the cache (keyed by the window)
+WXHDC wxPaintDCImpl::FindDCInCache(wxWindow* win)

 {
 {

-  if ( m_hDC ) {
-    if ( !--ms_PaintCount ) {
-      ::EndPaint((HWND)m_canvas->GetHWND(), &g_paintStruct);
-      m_hDCCount--;
-      m_hDC = (WXHDC) NULL;
-      ms_PaintHDC = (WXHDC) NULL;
+    size_t nCache = ms_cache.GetCount();
+    for ( size_t n = 0; n < nCache; n++ )
+    {
+        wxPaintDCInfo *info = &ms_cache[n];
+        if ( info->hwnd == win->GetHWND() )
+        {
+            return info->hdc;
+        }

     }
     }

-    //else: ms_PaintHDC still in use
-  }
+    return 0;
+}
+
+/*
+ * wxPaintDCEx
+ */
+
+// TODO: don't duplicate wxPaintDCImpl code here!!
+
+class wxPaintDCExImpl: public wxPaintDCImpl
+{
+public:
+    wxPaintDCExImpl( wxDC *owner, wxWindow *window, WXHDC dc );
+    ~wxPaintDCExImpl();
+
+    int m_saveState;
+};
+
+
+IMPLEMENT_ABSTRACT_CLASS(wxPaintDCEx,wxPaintDC)
+
+wxPaintDCEx::wxPaintDCEx(wxWindow *window, WXHDC dc)
+           : wxPaintDC(new wxPaintDCExImpl(this, window, dc))
+{
+}
+
+wxPaintDCExImpl::wxPaintDCExImpl(wxDC *owner, wxWindow *window, WXHDC dc)
+               : wxPaintDCImpl( owner )
+{
+        wxCHECK_RET( dc, wxT("wxPaintDCEx requires an existing device context") );
+
+        m_saveState = 0;
+
+        m_window = window;
+
+        wxPaintDCInfo *info = FindInCache();
+        if ( info )
+        {
+           m_hDC = info->hdc;
+           info->count++;
+        }
+        else // not in cache, create a new one
+        {
+                m_hDC = dc;
+                ms_cache.Add(new wxPaintDCInfo(m_window, this));
+                m_saveState = SaveDC((HDC) dc);
+        }
+}
+
+wxPaintDCExImpl::~wxPaintDCExImpl()
+{
+        size_t index;
+        wxPaintDCInfo *info = FindInCache(&index);
+
+        wxCHECK_RET( info, wxT("existing DC should have a cache entry") );
+
+        if ( --info->count == 0 )
+        {
+                RestoreDC((HDC) m_hDC, m_saveState);
+                ms_cache.RemoveAt(index);
+
+                // Reduce the number of bogus reports of non-freed memory
+                // at app exit
+                if (ms_cache.IsEmpty())
+                        ms_cache.Clear();
+        }
+        //else: cached DC entry is still in use
+
+        // prevent the base class dtor from ReleaseDC()ing it again
+        m_hDC = 0;

 }
 
 }
 

+