Committing in .

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

diff --git a/src/msw/dcclient.cpp b/src/msw/dcclient.cpp
index 9132057314d86c1aec058881840d67eb00274866..46642e078fc4fc2421bd5e08d049f2409669e7f0 100644 (file)
--- a/src/msw/dcclient.cpp
+++ b/src/msw/dcclient.cpp
@@ -6,139 +6,276 @@
 // Created:     01/02/97
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart and Markus Holzem
 // Created:     01/02/97
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart and Markus Holzem

-// Licence:    wxWindows licence
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

-#ifdef __GNUG__
-#pragma implementation "dcclient.h"
-#endif
+// ===========================================================================
+// declarations
+// ===========================================================================
+
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------

 
 #ifdef __GNUG__
 
 #ifdef __GNUG__

-#pragma implementation
-#pragma implementation "dcclient.h"
+    #pragma implementation "dcclient.h"

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

-#pragma hdrstop
+    #pragma hdrstop

 #endif
 
 #endif
 

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

 
 #include "wx/dcclient.h"
 
 
 #include "wx/dcclient.h"
 

-#include <windows.h>
+// ----------------------------------------------------------------------------
+// array/list types
+// ----------------------------------------------------------------------------

 
 

-#if !USE_SHARED_LIBRARY
-IMPLEMENT_DYNAMIC_CLASS(wxClientDC, wxDC)
-IMPLEMENT_DYNAMIC_CLASS(wxWindowDC, wxDC)
-IMPLEMENT_DYNAMIC_CLASS(wxPaintDC, wxDC)
-#endif
+struct WXDLLEXPORT wxPaintDCInfo
+{
+    wxPaintDCInfo(wxWindow *win, wxDC *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
+// ----------------------------------------------------------------------------
+
+    IMPLEMENT_DYNAMIC_CLASS(wxWindowDC, wxDC)
+    IMPLEMENT_DYNAMIC_CLASS(wxClientDC, wxWindowDC)
+    IMPLEMENT_DYNAMIC_CLASS(wxPaintDC, wxWindowDC)
+
+// ----------------------------------------------------------------------------
+// global variables
+// ----------------------------------------------------------------------------
+
+static PAINTSTRUCT g_paintStruct;
+
+#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
+    // very subtle and difficult to debug refresh/repaint bugs.
+    int g_isPainting = 0;
+#endif // __WXDEBUG__
+
+// ===========================================================================
+// implementation
+// ===========================================================================
+
+// ----------------------------------------------------------------------------
+// wxWindowDC
+// ----------------------------------------------------------------------------

 
 

-wxClientDC::wxClientDC(void)
+wxWindowDC::wxWindowDC()

 {
   m_canvas = NULL;
 }
 
 {
   m_canvas = NULL;
 }
 

-wxClientDC::wxClientDC(wxWindow *the_canvas)
+wxWindowDC::wxWindowDC(wxWindow *the_canvas)

 {
   m_canvas = the_canvas;
 {
   m_canvas = the_canvas;

-//  BeginDrawing();
-  m_hDC = (WXHDC) ::GetDC((HWND) the_canvas->GetHWND());
+  m_hDC = (WXHDC) ::GetWindowDC(GetWinHwnd(the_canvas) );
+  m_hDCCount++;
+
+  SetBackground(wxBrush(m_canvas->GetBackgroundColour(), wxSOLID));

 }
 
 }
 

-wxClientDC::~wxClientDC(void)
+wxWindowDC::~wxWindowDC()

 {
 {

-//  EndDrawing();
-
-  if (m_canvas && (HDC) m_hDC)
+  if (m_canvas && m_hDC)

   {
     SelectOldObjects(m_hDC);
 
   {
     SelectOldObjects(m_hDC);
 

-    ::ReleaseDC((HWND) m_canvas->GetHWND(), (HDC) m_hDC);
-       m_hDC = 0;
+    if ( !::ReleaseDC(GetWinHwnd(m_canvas), GetHdc()) )
+    {
+        wxLogLastError(wxT("ReleaseDC"));
+    }
+
+    m_hDC = 0;

   }
   }

+
+  m_hDCCount--;

 }
 
 }
 

-wxWindowDC::wxWindowDC(void)
+// ----------------------------------------------------------------------------
+// wxClientDC
+// ----------------------------------------------------------------------------
+
+wxClientDC::wxClientDC()

 {
   m_canvas = NULL;
 }
 
 {
   m_canvas = NULL;
 }
 

-wxWindowDC::wxWindowDC(wxWindow *the_canvas)
+wxClientDC::wxClientDC(wxWindow *the_canvas)

 {
   m_canvas = the_canvas;
 {
   m_canvas = the_canvas;

-//  m_hDC = (WXHDC) ::GetDCEx((HWND) the_canvas->GetHWND(), NULL, DCX_WINDOW);
-  m_hDC = (WXHDC) ::GetWindowDC((HWND) the_canvas->GetHWND() );
-  m_hDCCount ++;
+  m_hDC = (WXHDC) ::GetDC(GetWinHwnd(the_canvas));
+
+  // the background mode is only used for text background
+  // and is set in DrawText() to OPAQUE as required, other-
+  // wise always TRANSPARENT, RR
+  ::SetBkMode( GetHdc(), TRANSPARENT );
+
+  SetBackground(wxBrush(m_canvas->GetBackgroundColour(), wxSOLID));

 }
 
 }
 

-wxWindowDC::~wxWindowDC(void)
+wxClientDC::~wxClientDC()

 {
 {

-  if (m_canvas && m_hDC)
+  if ( m_canvas && GetHdc() )

   {
     SelectOldObjects(m_hDC);
 
   {
     SelectOldObjects(m_hDC);
 

-    ::ReleaseDC((HWND) m_canvas->GetHWND(), (HDC) m_hDC);
-       m_hDC = 0;
+    ::ReleaseDC(GetWinHwnd(m_canvas), GetHdc());
+    m_hDC = 0;

   }
   }

-  m_hDCCount --;

 }
 
 }
 

-wxPaintDC::wxPaintDC(void)
+// ----------------------------------------------------------------------------
+// wxPaintDC
+// ----------------------------------------------------------------------------
+
+// VZ: initial implementation (by JACS) only remembered the last wxPaintDC
+//     created and tried to reuse - 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.
+
+wxArrayDCInfo wxPaintDC::ms_cache;
+
+wxPaintDC::wxPaintDC()

 {
 {

-  m_canvas = NULL;
+    m_canvas = NULL;
+    m_hDC = 0;

 }
 
 }
 

-static PAINTSTRUCT g_paintStruct;
+wxPaintDC::wxPaintDC(wxWindow *canvas)
+{
+    wxCHECK_RET( canvas, wxT("NULL canvas in wxPaintDC ctor") );
+
+#ifdef __WXDEBUG__
+    if ( g_isPainting <= 0 )
+    {
+        wxFAIL_MSG( wxT("wxPaintDC may be created only in EVT_PAINT handler!") );
+
+        return;
+    }
+#endif // __WXDEBUG__
+
+    m_canvas = canvas;
+
+    // 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(GetWinHwnd(m_canvas), &g_paintStruct);
+        ms_cache.Add(new wxPaintDCInfo(m_canvas, this));
+    }
+
+    // the background mode is only used for text background
+    // and is set in DrawText() to OPAQUE as required, other-
+    // wise always TRANSPARENT, RR
+    ::SetBkMode( GetHdc(), TRANSPARENT );
+
+    SetBackground(wxBrush(m_canvas->GetBackgroundColour(), wxSOLID));
+}
+
+wxPaintDC::~wxPaintDC()
+{
+    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 )
+        {
+            ::EndPaint(GetWinHwnd(m_canvas), &g_paintStruct);

 
 

-// Don't call Begin/EndPaint if it's already been called:
-// for example, if calling a base class OnPaint.
+            ms_cache.Remove(index);

 
 

-WXHDC wxPaintDC::m_staticPaintHDC = 0;
-int wxPaintDC::m_staticPaintCount = 0;
+            // 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

 
 

-wxPaintDC::wxPaintDC(wxWindow *the_canvas)
+        // prevent the base class dtor from ReleaseDC()ing it again
+        m_hDC = 0;
+    }
+}
+
+wxPaintDCInfo *wxPaintDC::FindInCache(size_t *index) const

 {
 {

-       if ( the_canvas && (m_staticPaintCount == 0))
-       {
-               m_hDC = (WXHDC) ::BeginPaint((HWND) the_canvas->GetHWND(), &g_paintStruct);
-               m_hDCCount ++;
-               m_staticPaintCount ++ ;
-               m_staticPaintHDC = m_hDC ;
-       }
-       else
+    wxPaintDCInfo *info = NULL;
+    size_t nCache = ms_cache.GetCount();
+    for ( size_t n = 0; n < nCache; n++ )

     {
     {

-        wxDebugMsg("wxPaintDC: Using existing HDC\n");
-               m_hDC = m_staticPaintHDC ;
+        info = &ms_cache[n];
+        if ( info->hwnd == m_canvas->GetHWND() )
+        {
+            if ( index )
+                *index = n;
+            break;
+        }

     }
 
     }
 

-  m_canvas = the_canvas;
+    return info;

 }
 
 }
 

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

 {
 {

-       m_staticPaintCount -- ;
-
-       if (m_staticPaintCount == 0)
-       {
-               if ( m_hDC && m_canvas)
-               {
-                       ::EndPaint((HWND) m_canvas->GetHWND(), &g_paintStruct);
-                       m_hDCCount --;
-                       m_hDC = 0;
-               }
-        else
-            wxDebugMsg("~wxPaintDC: Did not release HDC\n");
-
-               m_staticPaintHDC = 0 ;
-       }
-    else
+    wxPaintDCInfo *info = NULL;
+    size_t nCache = ms_cache.GetCount();
+    for ( size_t n = 0; n < nCache; n++ )

     {
     {

-        wxDebugMsg("~wxPaintDC: Did not release HDC\n");
+        info = &ms_cache[n];
+        if ( info->hwnd == win->GetHWND() )
+        {
+            return info->hdc;
+        }

     }
     }

+    return 0;

 }
 
 }