X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e6460682a21a5f58ff7914676fd80b0730803398..a6fb8636e551162537ac094da81bafa5ee7fdf83:/src/msw/dcclient.cpp?ds=sidebyside diff --git a/src/msw/dcclient.cpp b/src/msw/dcclient.cpp index e1cd97a1ad..0f8ac84876 100644 --- a/src/msw/dcclient.cpp +++ b/src/msw/dcclient.cpp @@ -5,141 +5,356 @@ // Modified by: // Created: 01/02/97 // RCS-ID: $Id$ -// Copyright: (c) Julian Smart and Markus Holzem -// Licence: wxWindows licence +// Copyright: (c) Julian Smart +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// -#ifdef __GNUG__ -#pragma implementation "dcclient.h" +// =========================================================================== +// declarations +// =========================================================================== + +// ---------------------------------------------------------------------------- +// headers +// ---------------------------------------------------------------------------- + +#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) + #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 "wx/log.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(wxWindowDC, wxDC) IMPLEMENT_DYNAMIC_CLASS(wxClientDC, wxWindowDC) -IMPLEMENT_DYNAMIC_CLASS(wxPaintDC, wxWindowDC) -#endif +IMPLEMENT_DYNAMIC_CLASS(wxPaintDC, wxClientDC) +IMPLEMENT_CLASS(wxPaintDCEx, wxPaintDC) -/* - * wxWindowDC - */ +// ---------------------------------------------------------------------------- +// global variables +// ---------------------------------------------------------------------------- + +static PAINTSTRUCT g_paintStruct; + +#ifdef __WXDEBUG__ + // a global variable which we check to verify that wxPaintDC are only + // 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. + int g_isPainting = 0; +#endif // __WXDEBUG__ + +// =========================================================================== +// implementation +// =========================================================================== + +// ---------------------------------------------------------------------------- +// wxWindowDC +// ---------------------------------------------------------------------------- -wxWindowDC::wxWindowDC(void) +wxWindowDC::wxWindowDC() { - m_canvas = NULL; + m_canvas = NULL; } -wxWindowDC::wxWindowDC(wxWindow *the_canvas) +wxWindowDC::wxWindowDC(wxWindow *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 ++; + 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(); } -wxWindowDC::~wxWindowDC(void) +void wxWindowDC::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_canvas->GetBackgroundColour(), wxSOLID)); - ::ReleaseDC((HWND) m_canvas->GetHWND(), (HDC) m_hDC); - m_hDC = 0; - } - m_hDCCount --; + // since we are a window dc we need to grab the palette from the window +#if wxUSE_PALETTE + InitializePalette(); +#endif } -/* - * wxClientDC - */ +void wxWindowDC::DoGetSize(int *width, int *height) const +{ + wxCHECK_RET( m_canvas, _T("wxWindowDC without a window?") ); + + m_canvas->GetSize(width, height); +} -wxClientDC::wxClientDC(void) +// ---------------------------------------------------------------------------- +// wxClientDC +// ---------------------------------------------------------------------------- + +wxClientDC::wxClientDC() { - m_canvas = NULL; + m_canvas = NULL; } -wxClientDC::wxClientDC(wxWindow *the_canvas) +wxClientDC::wxClientDC(wxWindow *canvas) { - m_canvas = the_canvas; -// BeginDrawing(); - m_hDC = (WXHDC) ::GetDC((HWND) the_canvas->GetHWND()); + wxCHECK_RET( canvas, _T("invalid window in wxClientDC") ); + + m_canvas = canvas; + m_hDC = (WXHDC)::GetDC(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(); } -wxClientDC::~wxClientDC(void) +void wxClientDC::InitDC() { -// EndDrawing(); + wxWindowDC::InitDC(); - if (m_canvas && (HDC) m_hDC) - { - SelectOldObjects(m_hDC); + // 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_canvas->GetClientAreaOrigin(); + if ( ptOrigin.x || ptOrigin.y ) + { + // no need to shift DC origin if shift is null + SetDeviceOrigin(ptOrigin.x, ptOrigin.y); + } - ::ReleaseDC((HWND) m_canvas->GetHWND(), (HDC) m_hDC); - m_hDC = 0; - } + // clip the DC to avoid overwriting the non client area + SetClippingRegion(wxPoint(0, 0), m_canvas->GetClientSize()); +#endif // __WXUNIVERSAL__ || __WXWINCE__ } -/* - * wxPaintDC - */ +wxClientDC::~wxClientDC() +{ +} -wxPaintDC::wxPaintDC(void) +void wxClientDC::DoGetSize(int *width, int *height) const { - m_canvas = NULL; + wxCHECK_RET( m_canvas, _T("wxClientDC without a window?") ); + + m_canvas->GetClientSize(width, height); } -static PAINTSTRUCT g_paintStruct; +// ---------------------------------------------------------------------------- +// 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. -// Don't call Begin/EndPaint if it's already been called: -// for example, if calling a base class OnPaint. +wxArrayDCInfo wxPaintDC::ms_cache; -WXHDC wxPaintDC::ms_PaintHDC = 0; -size_t wxPaintDC::ms_PaintCount = 0; // count of ms_PaintHDC usage +wxPaintDC::wxPaintDC() +{ + m_canvas = NULL; +} wxPaintDC::wxPaintDC(wxWindow *canvas) { - wxCHECK_RET( canvas, "NULL canvas in wxPaintDC ctor" ); + 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!") ); - m_canvas = canvas; - 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 ); + return; + } +#endif // __WXDEBUG__ + + m_canvas = canvas; - m_hDC = ms_PaintHDC; - ms_PaintCount++; - } - else { - ms_PaintHDC = - m_hDC = (WXHDC)::BeginPaint((HWND)m_canvas->GetHWND(), &g_paintStruct); - ms_PaintCount = 1; - m_hDCCount++; - } + // 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 ) { - if ( !--ms_PaintCount ) { - ::EndPaint((HWND)m_canvas->GetHWND(), &g_paintStruct); - m_hDCCount--; - m_hDC = (WXHDC) NULL; - ms_PaintHDC = (WXHDC) NULL; + 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 +{ + 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_canvas->GetHWND() ) + { + info = info1; + if ( index ) + *index = n; + break; + } + } + + return info; +} + +// find the entry for this DC in the cache (keyed by the window) +WXHDC wxPaintDC::FindDCInCache(wxWindow* win) +{ + 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 wxPaintDC code here!! + +wxPaintDCEx::wxPaintDCEx(wxWindow *canvas, WXHDC dc) : saveState(0) +{ + wxCHECK_RET( dc, wxT("wxPaintDCEx requires an existing device context") ); + + m_canvas = canvas; + + 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_canvas, this)); + saveState = SaveDC((HDC) dc); + } +} + +wxPaintDCEx::~wxPaintDCEx() +{ + size_t index; + wxPaintDCInfo *info = FindInCache(&index); + + wxCHECK_RET( info, wxT("existing DC should have a cache entry") ); + + if ( !--info->count ) + { + RestoreDC((HDC) m_hDC, 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; }