X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/1c089c47f344926e2f95a8aa342992ed844fe609..e3dbf5934e997729c6f4f5154b1b7f29d5d22149:/src/msw/dcclient.cpp?ds=sidebyside diff --git a/src/msw/dcclient.cpp b/src/msw/dcclient.cpp index 3288e3641b..720398ea5d 100644 --- a/src/msw/dcclient.cpp +++ b/src/msw/dcclient.cpp @@ -6,146 +6,301 @@ // 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__ -#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__ -#pragma hdrstop + #pragma hdrstop #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 +// ---------------------------------------------------------------------------- +// array/list types +// ---------------------------------------------------------------------------- + +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 +// ---------------------------------------------------------------------------- -#if !USE_SHARED_LIBRARY -IMPLEMENT_DYNAMIC_CLASS(wxClientDC, wxDC) IMPLEMENT_DYNAMIC_CLASS(wxWindowDC, wxDC) -IMPLEMENT_DYNAMIC_CLASS(wxPaintDC, wxDC) +IMPLEMENT_DYNAMIC_CLASS(wxClientDC, wxWindowDC) +IMPLEMENT_DYNAMIC_CLASS(wxPaintDC, wxClientDC) + +// ---------------------------------------------------------------------------- +// 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 +// ---------------------------------------------------------------------------- + +wxWindowDC::wxWindowDC() +{ + m_canvas = NULL; +} + +wxWindowDC::wxWindowDC(wxWindow *canvas) +{ + wxCHECK_RET( canvas, _T("invalid window in wxWindowDC") ); + + m_canvas = canvas; + m_hDC = (WXHDC) ::GetWindowDC(GetHwndOf(m_canvas)); + + // m_bOwnsDC was already set to false in the base class ctor, so the DC + // will be released (and not deleted) in ~wxDC + InitDC(); +} + +void wxWindowDC::InitDC() +{ + // 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_canvas->GetBackgroundColour(), wxSOLID)); + + // since we are a window dc we need to grab the palette from the window +#if wxUSE_PALETTE + InitializePalette(); #endif +} -wxClientDC::wxClientDC(void) +void wxWindowDC::DoGetSize(int *width, int *height) const { - m_canvas = NULL; + wxCHECK_RET( m_canvas, _T("wxWindowDC without a window?") ); + + m_canvas->GetSize(width, height); } -wxClientDC::wxClientDC(wxWindow *the_canvas) +// ---------------------------------------------------------------------------- +// wxClientDC +// ---------------------------------------------------------------------------- + +wxClientDC::wxClientDC() { - m_canvas = the_canvas; -// BeginDrawing(); - m_hDC = (WXHDC) ::GetDC((HWND) the_canvas->GetHWND()); + m_canvas = NULL; } -wxClientDC::~wxClientDC(void) +wxClientDC::wxClientDC(wxWindow *canvas) { -// EndDrawing(); + wxCHECK_RET( canvas, _T("invalid window in wxClientDC") ); - if (m_canvas && (HDC) m_hDC) - { - SelectOldObjects(m_hDC); + m_canvas = canvas; + m_hDC = (WXHDC)::GetDC(GetHwndOf(m_canvas)); - ::ReleaseDC((HWND) m_canvas->GetHWND(), (HDC) m_hDC); - m_hDC = 0; - } + // 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) +void wxClientDC::InitDC() { - m_canvas = NULL; + wxWindowDC::InitDC(); + + // in wxUniv build we must manually do some DC adjustments usually + // performed by Windows for us +#ifdef __WXUNIVERSAL__ + wxPoint ptOrigin = m_canvas->GetClientAreaOrigin(); + if ( ptOrigin.x || ptOrigin.y ) + { + // no need to shift DC origin if shift is null + SetDeviceOrigin(ptOrigin.x, ptOrigin.y); + } + + // clip the DC to avoid overwriting the non client area + SetClippingRegion(wxPoint(0, 0), m_canvas->GetClientSize()); +#endif // __WXUNIVERSAL__ } -wxWindowDC::wxWindowDC(wxWindow *the_canvas) +wxClientDC::~wxClientDC() { - 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 ++; } -wxWindowDC::~wxWindowDC(void) +void wxClientDC::DoGetSize(int *width, int *height) const { - if (m_canvas && m_hDC) - { - SelectOldObjects(m_hDC); - - ::ReleaseDC((HWND) m_canvas->GetHWND(), (HDC) m_hDC); - m_hDC = 0; - } - m_hDCCount --; + wxCHECK_RET( m_canvas, _T("wxClientDC without a window?") ); + + m_canvas->GetClientSize(width, height); } -wxPaintDC::wxPaintDC(void) +// ---------------------------------------------------------------------------- +// 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. + +wxArrayDCInfo wxPaintDC::ms_cache; + +wxPaintDC::wxPaintDC() { - m_canvas = NULL; + m_canvas = NULL; } -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!") ); -// Don't call Begin/EndPaint if it's already been called: -// for example, if calling a base class OnPaint. + return; + } +#endif // __WXDEBUG__ -WXHDC wxPaintDC::m_staticPaintHDC = 0; -int wxPaintDC::m_staticPaintCount = 0; + m_canvas = canvas; -wxPaintDC::wxPaintDC(wxWindow *the_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(GetHwndOf(m_canvas), &g_paintStruct); + if (m_hDC) + ms_cache.Add(new wxPaintDCInfo(m_canvas, this)); + } + + // (re)set the DC parameters. + // Note: at this point m_hDC can be NULL under MicroWindows, when dragging. + if (GetHDC()) + InitDC(); +} + +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(GetHwndOf(m_canvas), &g_paintStruct); + + 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; + } +} + +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; - RECT updateRect1 = g_paintStruct.rcPaint; - m_canvas->m_updateRect.x = updateRect1.left; - m_canvas->m_updateRect.y = updateRect1.top; - m_canvas->m_updateRect.width = updateRect1.right - updateRect1.left; - m_canvas->m_updateRect.height = updateRect1.bottom - updateRect1.top; -// m_canvas->m_paintHDC = m_staticPaintHDC ; + 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) - { -// m_canvas->m_paintHDC = 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; } +