wxWidgets/src/os2/dcclient.cpp

/////////////////////////////////////////////////////////////////////////////
// Name:        dcclient.cpp
// Purpose:     wxClientDC class
// Author:      David Webster
// Modified by:
// Created:     09/21/99
// RCS-ID:      $Id$
// Copyright:   (c) David Webster
// Licence:     wxWindows licence
/////////////////////////////////////////////////////////////////////////////

// ===========================================================================
// declarations
// ===========================================================================

// ----------------------------------------------------------------------------
// headers
// ----------------------------------------------------------------------------

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

#include "wx/string.h"
#include "wx/log.h"
#include "wx/window.h"

#include "wx/os2/private.h"

#include "wx/dcclient.h"

// ----------------------------------------------------------------------------
// 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
// ----------------------------------------------------------------------------

    IMPLEMENT_DYNAMIC_CLASS(wxWindowDC, wxDC)
    IMPLEMENT_DYNAMIC_CLASS(wxClientDC, wxWindowDC)
    IMPLEMENT_DYNAMIC_CLASS(wxPaintDC, wxWindowDC)

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

static RECT        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_pCanvas = NULL;
}

wxWindowDC::wxWindowDC(wxWindow *the_canvas)
{
  m_pCanvas = the_canvas;
  m_hDC = (WXHDC) ::WinOpenWindowDC(GetWinHwnd(the_canvas) );
  m_nDCCount++;
  //
  // default under PM is that Window and Client DC's are the same
  // so we offer a separate Presentation Space to use for the
  // entire window.  Otherwise, calling BeginPaint will just create
  // chached-micro client presentation space
  //
   m_hPS = GpiCreatePS( m_hab
                       ,m_hDC
                       ,&m_PageSize
                       ,PU_PELS | GPIF_LONG | GPIA_ASSOC
                      );
  ::GpiAssociate(m_hPS, NULLHANDLE);
  ::GpiAssociate(m_hPS, m_hDC);
  SetBackground(wxBrush(m_pCanvas->GetBackgroundColour(), wxSOLID));
}

wxWindowDC::~wxWindowDC()
{
  if (m_pCanvas && m_hDC)
  {
    SelectOldObjects(m_hDC);

    //
    // In PM one does not explicitly close or release an open WindowDC
    // They automatically close with the window, unless explicitly detached
    // but we need to destroy our PS
    //
    if(m_hPS)
    {
        ::GpiAssociate(m_hPS, NULLHANDLE);
        ::GpiDestroyPS(m_hPS);
    }
    m_hPS = NULLHANDLE;
    m_hDC = NULLHANDLE;
  }

  m_nDCCount--;
}

// ----------------------------------------------------------------------------
// wxClientDC
// ----------------------------------------------------------------------------

wxClientDC::wxClientDC()
{
  m_pCanvas = NULL;
}

wxClientDC::wxClientDC(wxWindow *the_canvas)
{
    SIZEL                           vSizl = { 0,0};

    m_pCanvas = the_canvas;

    //
    // default under PM is that Window and Client DC's are the same
    //
    m_hDC = (WXHDC) ::WinOpenWindowDC(GetWinHwnd(the_canvas));
    m_hPS = ::GpiCreatePS( wxGetInstance()
                          ,m_hDC
                          ,&vSizl
                          ,PU_PELS | GPIF_LONG | GPIA_ASSOC
                         );

    //
    // Default mode is BM_LEAVEALONE so we make no call Set the mix
    //
    SetBackground(wxBrush( m_pCanvas->GetBackgroundColour()
                          ,wxSOLID
                         )
                 );
}

wxClientDC::~wxClientDC()
{
  if ( m_pCanvas && GetHdc() )
  {
    SelectOldObjects(m_hDC);

    // We don't explicitly release Device contexts in PM and
    // the cached micro PS is already gone

    m_hDC = 0;
  }
}

// ----------------------------------------------------------------------------
// 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_pCanvas = NULL;
    m_hDC = 0;
}

wxPaintDC::wxPaintDC(
  wxWindow*                         pCanvas
)
{
    wxCHECK_RET(pCanvas, 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_pCanvas = pCanvas;

    //
    // Do we have a DC for this window in the cache?
    //
    wxPaintDCInfo*                  pInfo = FindInCache();

    if (pInfo)
    {
        m_hDC = pInfo->hdc;
        pInfo->count++;
    }
    else // not in cache, create a new one
    {
        HPS                         hPS;

        hPS = ::WinBeginPaint( GetWinHwnd(m_pCanvas)
                              ,NULLHANDLE
                              ,&g_paintStruct
                             );
        if(hPS)
        {
            m_hOldPS = m_hPS;
            m_hPS = hPS;
        }
        m_bIsPaintTime   = TRUE;
        m_hDC = (WXHDC) -1; // to satisfy those anonizmous efforts
        m_vRclPaint = g_paintStruct;
        ms_cache.Add(new wxPaintDCInfo(m_pCanvas, this));
    }
    SetBackground(wxBrush(m_pCanvas->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 )
        {
            ::WinEndPaint(m_hPS);
            m_hPS          = m_hOldPS;
            m_bIsPaintTime = FALSE;
            ms_cache.Remove(index);
        }
        //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++ )
    {
        info = &ms_cache[n];
        if ( info->hwnd == m_pCanvas->GetHWND() )
        {
            if ( index )
                *index = n;
            break;
        }
    }

    return info;
}