src/os2/dcclient.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        dcclient.cpp
   3 // Purpose:     wxClientDC class
   4 // Author:      David Webster
   5 // Modified by:
   6 // Created:     09/21/99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) David Webster
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ===========================================================================
  13 // declarations
  14 // ===========================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 // For compilers that support precompilation, includes "wx.h".
  21 #include "wx/wxprec.h"
  22
  23 #include "wx/string.h"
  24 #include "wx/log.h"
  25 #include "wx/window.h"
  26 #include "wx/app.h"
  27
  28 #include "wx/os2/private.h"
  29
  30 #include "wx/dcclient.h"
  31
  32 // ----------------------------------------------------------------------------
  33 // array/list types
  34 // ----------------------------------------------------------------------------
  35
  36 struct WXDLLEXPORT wxPaintDCInfo
  37 {
  38     wxPaintDCInfo( wxWindow* pWin
  39                   ,wxDC*     pDC
  40                  )
  41     {
  42         m_hWnd = pWin->GetHWND();
  43         m_hDC = pDC->GetHDC();
  44         m_nCount = 1;
  45     }
  46
  47     WXHWND                          m_hWnd;   // window for this DC
  48     WXHDC                           m_hDC;    // the DC handle
  49     size_t                          m_nCount; // usage count
  50 }; // end of wxPaintDCInfot
  51
  52 #include "wx/arrimpl.cpp"
  53
  54 WX_DEFINE_OBJARRAY(wxArrayDCInfo);
  55
  56 // ----------------------------------------------------------------------------
  57 // macros
  58 // ----------------------------------------------------------------------------
  59
  60     IMPLEMENT_DYNAMIC_CLASS(wxWindowDC, wxDC)
  61     IMPLEMENT_DYNAMIC_CLASS(wxClientDC, wxWindowDC)
  62     IMPLEMENT_DYNAMIC_CLASS(wxPaintDC, wxWindowDC)
  63
  64 // ----------------------------------------------------------------------------
  65 // global variables
  66 // ----------------------------------------------------------------------------
  67
  68 static RECT        g_paintStruct;
  69
  70 #ifdef __WXDEBUG__
  71     // a global variable which we check to verify that wxPaintDC are only
  72     // created in resopnse to WM_PAINT message - doing this from elsewhere is a
  73     // common programming error among wxWindows programmers and might lead to
  74     // very subtle and difficult to debug refresh/repaint bugs.
  75     int g_isPainting = 0;
  76 #endif // __WXDEBUG__
  77
  78 // ===========================================================================
  79 // implementation
  80 // ===========================================================================
  81
  82 // ----------------------------------------------------------------------------
  83 // wxWindowDC
  84 // ----------------------------------------------------------------------------
  85
  86 wxWindowDC::wxWindowDC()
  87 {
  88     m_pCanvas = NULL;
  89 }
  90
  91 wxWindowDC::wxWindowDC(
  92   wxWindow*                         pTheCanvas
  93 )
  94 {
  95     ERRORID                         vError;
  96     wxString                        sError;
  97
  98     m_pCanvas = pTheCanvas;
  99     m_hDC = (WXHDC) ::WinOpenWindowDC(GetWinHwnd(pTheCanvas) );
 100
 101     //
 102     // default under PM is that Window and Client DC's are the same
 103     // so we offer a separate Presentation Space to use for the
 104     // entire window.  Otherwise, calling BeginPaint will just create
 105     // chached-micro client presentation space
 106     //
 107      m_hPS = ::GpiCreatePS( vHabmain
 108                            ,m_hDC
 109                            ,&m_PageSize
 110                            ,PU_PELS | GPIF_LONG | GPIA_ASSOC
 111                           );
 112     ::GpiAssociate(m_hPS, NULLHANDLE);
 113     ::GpiAssociate(m_hPS, m_hDC);
 114
 115     //
 116     // Set the wxWindows color table
 117     //
 118     if (!::GpiCreateLogColorTable( m_hPS
 119                                   ,0L
 120                                   ,LCOLF_CONSECRGB
 121                                   ,0L
 122                                   ,(LONG)wxTheColourDatabase->m_nSize
 123                                   ,(PLONG)wxTheColourDatabase->m_palTable
 124                                  ))
 125     {
 126         vError = ::WinGetLastError(vHabmain);
 127         sError = wxPMErrorToStr(vError);
 128         wxLogError("Unable to set current color table. Error: %s\n", sError);
 129     }
 130     ::GpiCreateLogColorTable( m_hPS
 131                              ,0L
 132                              ,LCOLF_RGB
 133                              ,0L
 134                              ,0L
 135                              ,NULL
 136                             );
 137     ::WinQueryWindowRect( GetWinHwnd(m_pCanvas)
 138                          ,&m_vRclPaint
 139                         );
 140     InitDC();
 141 } // end of wxWindowDC::wxWindowDC
 142
 143 void wxWindowDC::InitDC()
 144 {
 145     wxColour                        vColor;
 146
 147     vColor.InitFromName("BLACK");
 148     m_pen.SetColour(vColor);
 149     vColor.Set("WHITE");
 150     m_brush.SetColour(vColor);
 151     //
 152     // The background mode is only used for text background and is set in
 153     // DrawText() to OPAQUE as required, otherwise always TRANSPARENT,
 154     //
 155     ::GpiSetBackMix(GetHPS(), BM_LEAVEALONE);
 156
 157     //
 158     // Default bg colour is pne of the window
 159     //
 160     SetBackground(wxBrush(m_pCanvas->GetBackgroundColour(), wxSOLID));
 161 } // end of wxWindowDC::InitDC
 162
 163 // ----------------------------------------------------------------------------
 164 // wxClientDC
 165 // ----------------------------------------------------------------------------
 166
 167 wxClientDC::wxClientDC()
 168 {
 169     m_pCanvas = NULL;
 170 }
 171
 172 wxClientDC::wxClientDC(
 173   wxWindow*                         pTheCanvas
 174 )
 175 {
 176     SIZEL                           vSizl = { 0,0};
 177     ERRORID                         vError;
 178     wxString                        sError;
 179
 180     m_pCanvas = pTheCanvas;
 181
 182     //
 183     // default under PM is that Window and Client DC's are the same
 184     //
 185     m_hDC = (WXHDC) ::WinOpenWindowDC(GetWinHwnd(pTheCanvas));
 186     m_hPS = ::GpiCreatePS( wxGetInstance()
 187                           ,m_hDC
 188                           ,&vSizl
 189                           ,PU_PELS | GPIF_LONG | GPIA_ASSOC
 190                          );
 191
 192     // Set the wxWindows color table
 193     if (!::GpiCreateLogColorTable( m_hPS
 194                                   ,0L
 195                                   ,LCOLF_CONSECRGB
 196                                   ,0L
 197                                   ,(LONG)wxTheColourDatabase->m_nSize
 198                                   ,(PLONG)wxTheColourDatabase->m_palTable
 199                                  ))
 200     {
 201         vError = ::WinGetLastError(vHabmain);
 202         sError = wxPMErrorToStr(vError);
 203         wxLogError("Unable to set current color table. Error: %s\n", sError);
 204     }
 205     ::GpiCreateLogColorTable( m_hPS
 206                              ,0L
 207                              ,LCOLF_RGB
 208                              ,0L
 209                              ,0L
 210                              ,NULL
 211                             );
 212     //
 213     // Set the DC/PS rectangle
 214     //
 215     ::WinQueryWindowRect( GetWinHwnd(m_pCanvas)
 216                          ,&m_vRclPaint
 217                         );
 218     InitDC();
 219 } // end of wxClientDC::wxClientDC
 220
 221 void wxClientDC::InitDC()
 222 {
 223     wxWindowDC::InitDC();
 224
 225     // in wxUniv build we must manually do some DC adjustments usually
 226     // performed by Windows for us
 227 #ifdef __WXUNIVERSAL__
 228     wxPoint ptOrigin = m_canvas->GetClientAreaOrigin();
 229     if ( ptOrigin.x || ptOrigin.y )
 230     {
 231         // no need to shift DC origin if shift is null
 232         SetDeviceOrigin(ptOrigin.x, ptOrigin.y);
 233     }
 234
 235     // clip the DC to avoid overwriting the non client area
 236     SetClippingRegion(wxPoint(0, 0), m_canvas->GetClientSize());
 237 #endif // __WXUNIVERSAL__
 238 } // end of wxClientDC::InitDC
 239
 240 wxClientDC::~wxClientDC()
 241 {
 242 } // end of wxClientDC::~wxClientDC
 243
 244 // ----------------------------------------------------------------------------
 245 // wxPaintDC
 246 // ----------------------------------------------------------------------------
 247
 248 wxArrayDCInfo wxPaintDC::ms_cache;
 249
 250 wxPaintDC::wxPaintDC()
 251 {
 252     m_pCanvas = NULL;
 253     m_hDC = 0;
 254 }
 255
 256 wxPaintDC::wxPaintDC(
 257   wxWindow*                         pCanvas
 258 )
 259 {
 260     wxCHECK_RET(pCanvas, wxT("NULL canvas in wxPaintDC ctor"));
 261
 262 #ifdef __WXDEBUG__
 263     if (g_isPainting <= 0)
 264     {
 265         wxFAIL_MSG( wxT("wxPaintDC may be created only in EVT_PAINT handler!") );
 266         return;
 267     }
 268 #endif // __WXDEBUG__
 269
 270     m_pCanvas = pCanvas;
 271
 272     //
 273     // Do we have a DC for this window in the cache?
 274     //
 275     wxPaintDCInfo*                  pInfo = FindInCache();
 276
 277     if (pInfo)
 278     {
 279         m_hDC = pInfo->m_hDC;
 280         pInfo->m_nCount++;
 281     }
 282     else // not in cache, create a new one
 283     {
 284         HPS                         hPS;
 285
 286         hPS = ::WinBeginPaint( GetWinHwnd(m_pCanvas)
 287                               ,NULLHANDLE
 288                               ,&g_paintStruct
 289                              );
 290         if(hPS)
 291         {
 292             m_hOldPS = m_hPS;
 293             m_hPS = hPS;
 294             ::GpiCreateLogColorTable( m_hPS
 295                                      ,0L
 296                                      ,LCOLF_CONSECRGB
 297                                      ,0L
 298                                      ,(LONG)wxTheColourDatabase->m_nSize
 299                                      ,(PLONG)wxTheColourDatabase->m_palTable
 300                                     );
 301             ::GpiCreateLogColorTable( m_hPS
 302                                      ,0L
 303                                      ,LCOLF_RGB
 304                                      ,0L
 305                                      ,0L
 306                                      ,NULL
 307                                     );
 308
 309             ::WinFillRect(hPS, &g_paintStruct,  m_pCanvas->GetBackgroundColour().GetPixel());
 310             ::WinQueryWindowRect( GetWinHwnd(m_pCanvas)
 311                                  ,&m_vRclPaint
 312                                 );
 313         }
 314
 315         m_bIsPaintTime   = TRUE;
 316         m_hDC = (WXHDC) -1; // to satisfy those anonizmous efforts
 317         ms_cache.Add(new wxPaintDCInfo(m_pCanvas, this));
 318     }
 319     InitDC();
 320 } // end of wxPaintDC::wxPaintDC
 321
 322 wxPaintDC::~wxPaintDC()
 323 {
 324     if ( m_hDC )
 325     {
 326         SelectOldObjects(m_hDC);
 327
 328         size_t                      nIndex;
 329         wxPaintDCInfo*              pInfo = FindInCache(&nIndex);
 330
 331         wxCHECK_RET( pInfo, wxT("existing DC should have a cache entry") );
 332
 333         if ( !--pInfo->m_nCount )
 334         {
 335             ::WinEndPaint(m_hPS);
 336             m_hPS          = m_hOldPS;
 337             m_bIsPaintTime = FALSE;
 338             ms_cache.RemoveAt(nIndex);
 339         }
 340         //else: cached DC entry is still in use
 341
 342         // prevent the base class dtor from ReleaseDC()ing it again
 343         m_hDC = 0;
 344     }
 345 }
 346
 347 wxPaintDCInfo* wxPaintDC::FindInCache(
 348   size_t*                           pIndex
 349 ) const
 350 {
 351     wxPaintDCInfo*                  pInfo = NULL;
 352     size_t                          nCache = ms_cache.GetCount();
 353
 354     for (size_t n = 0; n < nCache; n++)
 355     {
 356         pInfo = &ms_cache[n];
 357         if (pInfo->m_hWnd == m_pCanvas->GetHWND())
 358         {
 359             if (pIndex)
 360                 *pIndex = n;
 361             break;
 362         }
 363     }
 364     return pInfo;
 365 } // end of wxPaintDC::FindInCache
 366
 367 // find the entry for this DC in the cache (keyed by the window)
 368 WXHDC wxPaintDC::FindDCInCache(
 369   wxWindow*                         pWin
 370 )
 371 {
 372     wxPaintDCInfo*                  pInfo = NULL;
 373     size_t                          nCache = ms_cache.GetCount();
 374
 375     for (size_t n = 0; n < nCache; n++)
 376     {
 377         pInfo = &ms_cache[n];
 378         if (pInfo->m_hWnd == pWin->GetHWND())
 379         {
 380             return pInfo->m_hDC;
 381         }
 382     }
 383     return 0;
 384 } // end of wxPaintDC::FindInCache
 385