src/msw/bitmap.cpp

   1 ////////////////////////////////////////////////////////////////////////////
   2 // Name:        bitmap.cpp
   3 // Purpose:     wxBitmap
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     04/01/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 #ifdef __GNUG__
  21     #pragma implementation "bitmap.h"
  22 #endif
  23
  24 // For compilers that support precompilation, includes "wx.h".
  25 #include "wx/wxprec.h"
  26
  27 #ifdef __BORLANDC__
  28     #pragma hdrstop
  29 #endif
  30
  31 #ifndef WX_PRECOMP
  32     #include <stdio.h>
  33
  34     #include "wx/list.h"
  35     #include "wx/utils.h"
  36     #include "wx/app.h"
  37     #include "wx/palette.h"
  38     #include "wx/dcmemory.h"
  39     #include "wx/bitmap.h"
  40     #include "wx/icon.h"
  41 #endif
  42
  43 #include "wx/msw/private.h"
  44 #include "wx/log.h"
  45
  46 #if wxUSE_WXDIB
  47 #include "wx/msw/dib.h"
  48 #endif
  49
  50 #include "wx/image.h"
  51 #include "wx/xpmdecod.h"
  52
  53 #ifdef wxHAVE_RAW_BITMAP
  54 #include "wx/rawbmp.h"
  55 #endif
  56
  57 // missing from mingw32 header
  58 #ifndef CLR_INVALID
  59     #define CLR_INVALID ((COLORREF)-1)
  60 #endif // no CLR_INVALID
  61
  62 // ----------------------------------------------------------------------------
  63 // Bitmap data
  64 // ----------------------------------------------------------------------------
  65
  66 class WXDLLEXPORT wxBitmapRefData : public wxGDIImageRefData
  67 {
  68 public:
  69     wxBitmapRefData();
  70     virtual ~wxBitmapRefData() { Free(); }
  71
  72     virtual void Free();
  73
  74     // set the mask object to use as the mask, we take ownership of it
  75     void SetMask(wxMask *mask)
  76     {
  77         delete m_bitmapMask;
  78         m_bitmapMask = mask;
  79     }
  80
  81     // set the HBITMAP to use as the mask
  82     void SetMask(HBITMAP hbmpMask)
  83     {
  84         SetMask(new wxMask((WXHBITMAP)hbmpMask));
  85     }
  86
  87     // return the mask
  88     wxMask *GetMask() const { return m_bitmapMask; }
  89
  90 public:
  91 #if wxUSE_PALETTE
  92     wxPalette     m_bitmapPalette;
  93 #endif // wxUSE_PALETTE
  94
  95     // MSW-specific
  96     // ------------
  97
  98 #ifdef __WXDEBUG__
  99     // this field is solely for error checking: we detect selecting a bitmap
 100     // into more than one DC at once or deleting a bitmap still selected into a
 101     // DC (both are serious programming errors under Windows)
 102     wxDC         *m_selectedInto;
 103 #endif // __WXDEBUG__
 104
 105 #if wxUSE_WXDIB
 106     // when GetRawData() is called for a DDB we need to convert it to a DIB
 107     // first to be able to provide direct access to it and we cache that DIB
 108     // here and convert it back to DDB when UngetRawData() is called
 109     wxDIB *m_dib;
 110 #endif
 111
 112     // true if we have alpha transparency info and can be drawn using
 113     // AlphaBlend()
 114     bool m_hasAlpha;
 115
 116     // true if our HBITMAP is a DIB section, false if it is a DDB
 117     bool m_isDIB;
 118
 119 private:
 120     // optional mask for transparent drawing
 121     wxMask       *m_bitmapMask;
 122
 123     DECLARE_NO_COPY_CLASS(wxBitmapRefData)
 124 };
 125
 126 // ----------------------------------------------------------------------------
 127 // macros
 128 // ----------------------------------------------------------------------------
 129
 130 IMPLEMENT_DYNAMIC_CLASS(wxBitmap, wxGDIObject)
 131 IMPLEMENT_DYNAMIC_CLASS(wxMask, wxObject)
 132
 133 IMPLEMENT_DYNAMIC_CLASS(wxBitmapHandler, wxObject)
 134
 135 // ============================================================================
 136 // implementation
 137 // ============================================================================
 138
 139 // ----------------------------------------------------------------------------
 140 // helper functions
 141 // ----------------------------------------------------------------------------
 142
 143 // decide whether we should create a DIB or a DDB for the given parameters
 144 static bool wxShouldCreateDIB(int w, int h, int d, WXHDC hdc)
 145 {
 146 #if wxUSE_WXDIB
 147     // here is the logic:
 148     //
 149     //  (a) if hdc is specified, the caller explicitly wants DDB
 150     //  (b) otherwise, create a DIB if depth >= 24 (we don't support 16bpp or
 151     //      less DIBs anyhow)
 152     //  (c) finally, create DIBs under Win9x even if the depth hasn't been
 153     //      explicitly specified but the current display depth is 24 or more
 154     //      and the image is "big", i.e. > 16Mb which is the theoretical limit
 155     //      for DDBs under Win9x
 156     //
 157     // consequences (all of which seem to make sense):
 158     //
 159     //  (i)     by default, DDBs are created (depth == -1 usually)
 160     //  (ii)    DIBs can be created by explicitly specifying the depth
 161     //  (iii)   using a DC always forces creating a DDB
 162     return !hdc &&
 163             (d >= 24 ||
 164                 (d == -1 &&
 165                     wxDIB::GetLineSize(w, wxDisplayDepth())*h > 16*1024*1024));
 166 #else
 167     return FALSE;
 168 #endif
 169 }
 170
 171 // ----------------------------------------------------------------------------
 172 // wxBitmapRefData
 173 // ----------------------------------------------------------------------------
 174
 175 wxBitmapRefData::wxBitmapRefData()
 176 {
 177 #ifdef __WXDEBUG__
 178     m_selectedInto = NULL;
 179 #endif
 180     m_bitmapMask = NULL;
 181
 182     m_hBitmap = (WXHBITMAP) NULL;
 183 #if wxUSE_WXDIB
 184     m_dib = NULL;
 185 #endif
 186
 187     m_isDIB =
 188     m_hasAlpha = FALSE;
 189 }
 190
 191 void wxBitmapRefData::Free()
 192 {
 193     wxASSERT_MSG( !m_selectedInto,
 194                   wxT("deleting bitmap still selected into wxMemoryDC") );
 195
 196 #if wxUSE_WXDIB
 197     wxASSERT_MSG( !m_dib, _T("forgot to call wxBitmap::UngetRawData()!") );
 198 #endif
 199
 200     if ( m_hBitmap)
 201     {
 202         if ( !::DeleteObject((HBITMAP)m_hBitmap) )
 203         {
 204             wxLogLastError(wxT("DeleteObject(hbitmap)"));
 205         }
 206     }
 207
 208     delete m_bitmapMask;
 209     m_bitmapMask = NULL;
 210 }
 211
 212 // ----------------------------------------------------------------------------
 213 // wxBitmap creation
 214 // ----------------------------------------------------------------------------
 215
 216 // this function should be called from all wxBitmap ctors
 217 void wxBitmap::Init()
 218 {
 219     // m_refData = NULL; done in the base class ctor
 220 }
 221
 222 wxGDIImageRefData *wxBitmap::CreateData() const
 223 {
 224     return new wxBitmapRefData;
 225 }
 226
 227 #ifdef __WIN32__
 228
 229 bool wxBitmap::CopyFromIconOrCursor(const wxGDIImage& icon)
 230 {
 231 #if !defined(__WXMICROWIN__) && !defined(__WXWINCE__)
 232     // it may be either HICON or HCURSOR
 233     HICON hicon = (HICON)icon.GetHandle();
 234
 235     ICONINFO iconInfo;
 236     if ( !::GetIconInfo(hicon, &iconInfo) )
 237     {
 238         wxLogLastError(wxT("GetIconInfo"));
 239
 240         return FALSE;
 241     }
 242
 243     wxBitmapRefData *refData = new wxBitmapRefData;
 244     m_refData = refData;
 245
 246     int w = icon.GetWidth(),
 247         h = icon.GetHeight();
 248
 249     refData->m_width = w;
 250     refData->m_height = h;
 251     refData->m_depth = wxDisplayDepth();
 252
 253     refData->m_hBitmap = (WXHBITMAP)iconInfo.hbmColor;
 254
 255     // the mask returned by GetIconInfo() is inversed compared to the usual
 256     // wxWin convention
 257     refData->SetMask(wxInvertMask(iconInfo.hbmMask, w, h));
 258
 259
 260     // delete the old one now as we don't need it any more
 261     ::DeleteObject(iconInfo.hbmMask);
 262
 263 #if WXWIN_COMPATIBILITY_2
 264     refData->m_ok = TRUE;
 265 #endif // WXWIN_COMPATIBILITY_2
 266
 267     return TRUE;
 268 #else
 269     return FALSE;
 270 #endif
 271 }
 272
 273 #endif // Win32
 274
 275 bool wxBitmap::CopyFromCursor(const wxCursor& cursor)
 276 {
 277     UnRef();
 278
 279     if ( !cursor.Ok() )
 280         return FALSE;
 281
 282 #ifdef __WIN16__
 283     wxFAIL_MSG( _T("don't know how to convert cursor to bitmap") );
 284
 285     return FALSE;
 286 #else
 287     return CopyFromIconOrCursor(cursor);
 288 #endif // Win16
 289 }
 290
 291 bool wxBitmap::CopyFromIcon(const wxIcon& icon)
 292 {
 293     UnRef();
 294
 295     if ( !icon.Ok() )
 296         return FALSE;
 297
 298     // GetIconInfo() doesn't exist under Win16 and I don't know any other way
 299     // to create a bitmap from icon there - but using this way we won't have
 300     // the mask (FIXME)
 301 #ifdef __WIN16__
 302     int width = icon.GetWidth(),
 303         height = icon.GetHeight();
 304
 305     // copy the icon to the bitmap
 306     ScreenHDC hdcScreen;
 307     HDC hdc = ::CreateCompatibleDC(hdcScreen);
 308     HBITMAP hbitmap = ::CreateCompatibleBitmap(hdcScreen, width, height);
 309     HBITMAP hbmpOld = (HBITMAP)::SelectObject(hdc, hbitmap);
 310
 311     ::DrawIcon(hdc, 0, 0, GetHiconOf(icon));
 312
 313     ::SelectObject(hdc, hbmpOld);
 314     ::DeleteDC(hdc);
 315
 316     wxBitmapRefData *refData = new wxBitmapRefData;
 317     m_refData = refData;
 318
 319     refData->m_width = width;
 320     refData->m_height = height;
 321     refData->m_depth = wxDisplayDepth();
 322
 323     refData->m_hBitmap = (WXHBITMAP)hbitmap;
 324
 325 #if WXWIN_COMPATIBILITY_2
 326     refData->m_ok = TRUE;
 327 #endif // WXWIN_COMPATIBILITY_2
 328
 329     return TRUE;
 330 #else // Win32
 331     return CopyFromIconOrCursor(icon);
 332 #endif // Win16/Win32
 333 }
 334
 335 #if wxUSE_WXDIB
 336 bool wxBitmap::CopyFromDIB(const wxDIB& dib)
 337 {
 338     wxCHECK_MSG( dib.IsOk(), FALSE, _T("invalid DIB in CopyFromDIB") );
 339
 340     HBITMAP hbitmap = dib.CreateDDB();
 341     if ( !hbitmap )
 342         return FALSE;
 343
 344     UnRef();
 345
 346     wxBitmapRefData *refData = new wxBitmapRefData;
 347     m_refData = refData;
 348
 349     refData->m_width = dib.GetWidth();
 350     refData->m_height = dib.GetHeight();
 351     refData->m_depth = dib.GetDepth();
 352
 353     refData->m_hBitmap = (WXHBITMAP)hbitmap;
 354
 355 #if wxUSE_PALETTE
 356     wxPalette *palette = dib.CreatePalette();
 357     if ( palette )
 358     {
 359         refData->m_bitmapPalette = *palette;
 360     }
 361
 362     delete palette;
 363 #endif // wxUSE_PALETTE
 364
 365     return TRUE;
 366 }
 367 #endif
 368
 369 wxBitmap::~wxBitmap()
 370 {
 371 }
 372
 373 wxBitmap::wxBitmap(const char bits[], int width, int height, int depth)
 374 {
 375     Init();
 376
 377 #ifndef __WXMICROWIN__
 378     wxBitmapRefData *refData = new wxBitmapRefData;
 379     m_refData = refData;
 380
 381     refData->m_width = width;
 382     refData->m_height = height;
 383     refData->m_depth = depth;
 384
 385     char *data;
 386     if ( depth == 1 )
 387     {
 388         // we assume that it is in XBM format which is not quite the same as
 389         // the format CreateBitmap() wants because the order of bytes in the
 390         // line is inversed!
 391         const size_t bytesPerLine = (width + 7) / 8;
 392         const size_t padding = bytesPerLine % 2;
 393         const size_t len = height * ( padding + bytesPerLine );
 394         data = (char *)malloc(len);
 395         const char *src = bits;
 396         char *dst = data;
 397
 398         for ( int rows = 0; rows < height; rows++ )
 399         {
 400             for ( size_t cols = 0; cols < bytesPerLine; cols++ )
 401             {
 402                 unsigned char val = *src++;
 403                 unsigned char reversed = 0;
 404
 405                 for ( int bits = 0; bits < 8; bits++)
 406                 {
 407                     reversed <<= 1;
 408                     reversed |= (val & 0x01);
 409                     val >>= 1;
 410                 }
 411                 *dst++ = reversed;
 412             }
 413
 414             if ( padding )
 415                 *dst++ = 0;
 416         }
 417     }
 418     else
 419     {
 420         // bits should already be in Windows standard format
 421         data = (char *)bits;    // const_cast is harmless
 422     }
 423
 424     HBITMAP hbmp = ::CreateBitmap(width, height, 1, depth, data);
 425     if ( !hbmp )
 426     {
 427         wxLogLastError(wxT("CreateBitmap"));
 428     }
 429
 430     if ( data != bits )
 431     {
 432         free(data);
 433     }
 434
 435     SetHBITMAP((WXHBITMAP)hbmp);
 436 #endif
 437 }
 438
 439 // Create from XPM data
 440 bool wxBitmap::CreateFromXpm(const char **data)
 441 {
 442 #if wxUSE_IMAGE && wxUSE_XPM
 443     Init();
 444
 445     wxCHECK_MSG( data != NULL, FALSE, wxT("invalid bitmap data") )
 446
 447     wxXPMDecoder decoder;
 448     wxImage img = decoder.ReadData(data);
 449     wxCHECK_MSG( img.Ok(), FALSE, wxT("invalid bitmap data") )
 450
 451     *this = wxBitmap(img);
 452     return TRUE;
 453 #else
 454     return FALSE;
 455 #endif
 456 }
 457
 458 wxBitmap::wxBitmap(int w, int h, int d)
 459 {
 460     Init();
 461
 462     (void)Create(w, h, d);
 463 }
 464
 465 wxBitmap::wxBitmap(int w, int h, const wxDC& dc)
 466 {
 467     Init();
 468
 469     (void)Create(w, h, dc);
 470 }
 471
 472 wxBitmap::wxBitmap(void *data, long type, int width, int height, int depth)
 473 {
 474     Init();
 475
 476     (void)Create(data, type, width, height, depth);
 477 }
 478
 479 wxBitmap::wxBitmap(const wxString& filename, wxBitmapType type)
 480 {
 481     Init();
 482
 483     LoadFile(filename, (int)type);
 484 }
 485
 486 bool wxBitmap::Create(int width, int height, int depth)
 487 {
 488     return DoCreate(width, height, depth, 0);
 489 }
 490
 491 bool wxBitmap::Create(int width, int height, const wxDC& dc)
 492 {
 493     wxCHECK_MSG( dc.Ok(), FALSE, _T("invalid HDC in wxBitmap::Create()") );
 494
 495     return DoCreate(width, height, -1, dc.GetHDC());
 496 }
 497
 498 bool wxBitmap::DoCreate(int w, int h, int d, WXHDC hdc)
 499 {
 500     UnRef();
 501
 502     m_refData = new wxBitmapRefData;
 503
 504     GetBitmapData()->m_width = w;
 505     GetBitmapData()->m_height = h;
 506
 507     HBITMAP hbmp;
 508
 509 #if wxUSE_WXDIB
 510     if ( wxShouldCreateDIB(w, h, d, hdc) )
 511     {
 512         if ( d == -1 )
 513         {
 514             // create DIBs without alpha channel by default
 515             d = 24;
 516         }
 517
 518         wxDIB dib(w, h, d);
 519         if ( !dib.IsOk() )
 520            return FALSE;
 521
 522         // don't delete the DIB section in dib object dtor
 523         hbmp = dib.Detach();
 524
 525         GetBitmapData()->m_isDIB = TRUE;
 526         GetBitmapData()->m_depth = d;
 527     }
 528     else // create a DDB
 529 #endif
 530     {
 531         if ( d == -1 )
 532             d = wxDisplayDepth();
 533
 534         GetBitmapData()->m_depth = d;
 535
 536 #ifndef __WXMICROWIN__
 537         if ( d > 0 )
 538         {
 539             hbmp = ::CreateBitmap(w, h, 1, d, NULL);
 540             if ( !hbmp )
 541             {
 542                 wxLogLastError(wxT("CreateBitmap"));
 543             }
 544         }
 545         else
 546 #endif // !__WXMICROWIN__
 547         {
 548             ScreenHDC dc;
 549             hbmp = ::CreateCompatibleBitmap(dc, w, h);
 550             if ( !hbmp )
 551             {
 552                 wxLogLastError(wxT("CreateCompatibleBitmap"));
 553             }
 554
 555             GetBitmapData()->m_depth = wxDisplayDepth();
 556         }
 557     }
 558
 559     SetHBITMAP((WXHBITMAP)hbmp);
 560
 561 #if WXWIN_COMPATIBILITY_2
 562     GetBitmapData()->m_ok = hbmp != 0;
 563 #endif // WXWIN_COMPATIBILITY_2
 564
 565     return Ok();
 566 }
 567
 568 #if wxUSE_IMAGE
 569
 570 // ----------------------------------------------------------------------------
 571 // wxImage to/from conversions for Microwin
 572 // ----------------------------------------------------------------------------
 573
 574 // Microwin versions are so different from normal ones that it really doesn't
 575 // make sense to use #ifdefs inside the function bodies
 576 #ifdef __WXMICROWIN__
 577
 578 bool wxBitmap::CreateFromImage(const wxImage& image, int depth, const wxDC& dc)
 579 {
 580     // Set this to 1 to experiment with mask code,
 581     // which currently doesn't work
 582     #define USE_MASKS 0
 583
 584     m_refData = new wxBitmapRefData();
 585
 586     // Initial attempt at a simple-minded implementation.
 587     // The bitmap will always be created at the screen depth,
 588     // so the 'depth' argument is ignored.
 589
 590     HDC hScreenDC = ::GetDC(NULL);
 591     int screenDepth = ::GetDeviceCaps(hScreenDC, BITSPIXEL);
 592
 593     HBITMAP hBitmap = ::CreateCompatibleBitmap(hScreenDC, image.GetWidth(), image.GetHeight());
 594     HBITMAP hMaskBitmap = NULL;
 595     HBITMAP hOldMaskBitmap = NULL;
 596     HDC hMaskDC = NULL;
 597     unsigned char maskR = 0;
 598     unsigned char maskG = 0;
 599     unsigned char maskB = 0;
 600
 601     //    printf("Created bitmap %d\n", (int) hBitmap);
 602     if (hBitmap == NULL)
 603     {
 604         ::ReleaseDC(NULL, hScreenDC);
 605         return FALSE;
 606     }
 607     HDC hMemDC = ::CreateCompatibleDC(hScreenDC);
 608
 609     HBITMAP hOldBitmap = ::SelectObject(hMemDC, hBitmap);
 610     ::ReleaseDC(NULL, hScreenDC);
 611
 612     // created an mono-bitmap for the possible mask
 613     bool hasMask = image.HasMask();
 614
 615     if ( hasMask )
 616     {
 617 #if USE_MASKS
 618         // FIXME: we should be able to pass bpp = 1, but
 619         // GdBlit can't handle a different depth
 620 #if 0
 621         hMaskBitmap = ::CreateBitmap( (WORD)image.GetWidth(), (WORD)image.GetHeight(), 1, 1, NULL );
 622 #else
 623         hMaskBitmap = ::CreateCompatibleBitmap( hMemDC, (WORD)image.GetWidth(), (WORD)image.GetHeight());
 624 #endif
 625         maskR = image.GetMaskRed();
 626         maskG = image.GetMaskGreen();
 627         maskB = image.GetMaskBlue();
 628
 629         if (!hMaskBitmap)
 630         {
 631             hasMask = FALSE;
 632         }
 633         else
 634         {
 635             hScreenDC = ::GetDC(NULL);
 636             hMaskDC = ::CreateCompatibleDC(hScreenDC);
 637            ::ReleaseDC(NULL, hScreenDC);
 638
 639             hOldMaskBitmap = ::SelectObject( hMaskDC, hMaskBitmap);
 640         }
 641 #else
 642         hasMask = FALSE;
 643 #endif
 644     }
 645
 646     int i, j;
 647     for (i = 0; i < image.GetWidth(); i++)
 648     {
 649         for (j = 0; j < image.GetHeight(); j++)
 650         {
 651             unsigned char red = image.GetRed(i, j);
 652             unsigned char green = image.GetGreen(i, j);
 653             unsigned char blue = image.GetBlue(i, j);
 654
 655             ::SetPixel(hMemDC, i, j, PALETTERGB(red, green, blue));
 656
 657             if (hasMask)
 658             {
 659                 // scan the bitmap for the transparent colour and set the corresponding
 660                 // pixels in the mask to BLACK and the rest to WHITE
 661                 if (maskR == red && maskG == green && maskB == blue)
 662                     ::SetPixel(hMaskDC, i, j, PALETTERGB(0, 0, 0));
 663                 else
 664                     ::SetPixel(hMaskDC, i, j, PALETTERGB(255, 255, 255));
 665             }
 666         }
 667     }
 668
 669     ::SelectObject(hMemDC, hOldBitmap);
 670     ::DeleteDC(hMemDC);
 671     if (hasMask)
 672     {
 673         ::SelectObject(hMaskDC, hOldMaskBitmap);
 674         ::DeleteDC(hMaskDC);
 675
 676         ((wxBitmapRefData*)m_refData)->SetMask(hMaskBitmap);
 677     }
 678
 679     SetWidth(image.GetWidth());
 680     SetHeight(image.GetHeight());
 681     SetDepth(screenDepth);
 682     SetHBITMAP( (WXHBITMAP) hBitmap );
 683
 684 #if wxUSE_PALETTE
 685     // Copy the palette from the source image
 686     SetPalette(image.GetPalette());
 687 #endif // wxUSE_PALETTE
 688
 689 #if WXWIN_COMPATIBILITY_2
 690     // check the wxBitmap object
 691     GetBitmapData()->SetOk();
 692 #endif // WXWIN_COMPATIBILITY_2
 693
 694     return TRUE;
 695 }
 696
 697 wxImage wxBitmap::ConvertToImage() const
 698 {
 699     // Initial attempt at a simple-minded implementation.
 700     // The bitmap will always be created at the screen depth,
 701     // so the 'depth' argument is ignored.
 702     // TODO: transparency (create a mask image)
 703
 704     if (!Ok())
 705     {
 706         wxFAIL_MSG( wxT("bitmap is invalid") );
 707         return wxNullImage;
 708     }
 709
 710     wxImage image;
 711
 712     wxCHECK_MSG( Ok(), wxNullImage, wxT("invalid bitmap") );
 713
 714     // create an wxImage object
 715     int width = GetWidth();
 716     int height = GetHeight();
 717     image.Create( width, height );
 718     unsigned char *data = image.GetData();
 719     if( !data )
 720     {
 721         wxFAIL_MSG( wxT("could not allocate data for image") );
 722         return wxNullImage;
 723     }
 724
 725     HDC hScreenDC = ::GetDC(NULL);
 726
 727     HDC hMemDC = ::CreateCompatibleDC(hScreenDC);
 728     ::ReleaseDC(NULL, hScreenDC);
 729
 730     HBITMAP hBitmap = (HBITMAP) GetHBITMAP();
 731
 732     HBITMAP hOldBitmap = ::SelectObject(hMemDC, hBitmap);
 733
 734     int i, j;
 735     for (i = 0; i < GetWidth(); i++)
 736     {
 737         for (j = 0; j < GetHeight(); j++)
 738         {
 739             COLORREF color = ::GetPixel(hMemDC, i, j);
 740             unsigned char red = GetRValue(color);
 741             unsigned char green = GetGValue(color);
 742             unsigned char blue = GetBValue(color);
 743
 744             image.SetRGB(i, j, red, green, blue);
 745         }
 746     }
 747
 748     ::SelectObject(hMemDC, hOldBitmap);
 749     ::DeleteDC(hMemDC);
 750
 751 #if wxUSE_PALETTE
 752     // Copy the palette from the source image
 753     if (GetPalette())
 754         image.SetPalette(* GetPalette());
 755 #endif // wxUSE_PALETTE
 756
 757     return image;
 758 }
 759
 760 #endif // __WXMICROWIN__
 761
 762 // ----------------------------------------------------------------------------
 763 // wxImage to/from conversions
 764 // ----------------------------------------------------------------------------
 765
 766 bool wxBitmap::CreateFromImage(const wxImage& image, int depth)
 767 {
 768     return CreateFromImage(image, depth, 0);
 769 }
 770
 771 bool wxBitmap::CreateFromImage(const wxImage& image, const wxDC& dc)
 772 {
 773     wxCHECK_MSG( dc.Ok(), FALSE,
 774                     _T("invalid HDC in wxBitmap::CreateFromImage()") );
 775
 776     return CreateFromImage(image, -1, dc.GetHDC());
 777 }
 778
 779 bool wxBitmap::CreateFromImage(const wxImage& image, int depth, WXHDC hdc )
 780 {
 781 #if wxUSE_WXDIB
 782     wxCHECK_MSG( image.Ok(), FALSE, wxT("invalid image") );
 783
 784     UnRef();
 785
 786     // first convert the image to DIB
 787     const int h = image.GetHeight();
 788     const int w = image.GetWidth();
 789
 790     wxDIB dib(image);
 791     if ( !dib.IsOk() )
 792         return FALSE;
 793
 794
 795     // store the bitmap parameters
 796     wxBitmapRefData *refData = new wxBitmapRefData;
 797     refData->m_width = w;
 798     refData->m_height = h;
 799     refData->m_hasAlpha = image.HasAlpha();
 800
 801     m_refData = refData;
 802
 803
 804     // next either store DIB as is or create a DDB from it
 805     HBITMAP hbitmap;
 806
 807     // are we going to use DIB?
 808     //
 809     // NB: DDBs don't support alpha so if we have alpha channel we must use DIB
 810     if ( image.HasAlpha() || wxShouldCreateDIB(w, h, depth, hdc) )
 811     {
 812         // don't delete the DIB section in dib object dtor
 813         hbitmap = dib.Detach();
 814
 815         refData->m_isDIB = TRUE;
 816         refData->m_depth = dib.GetDepth();
 817     }
 818     else // we need to convert DIB to DDB
 819     {
 820         hbitmap = dib.CreateDDB((HDC)hdc);
 821
 822         refData->m_depth = depth == -1 ? wxDisplayDepth() : depth;
 823     }
 824
 825     // validate this object
 826     SetHBITMAP((WXHBITMAP)hbitmap);
 827
 828 #if WXWIN_COMPATIBILITY_2
 829     m_refData->m_ok = TRUE;
 830 #endif // WXWIN_COMPATIBILITY_2
 831
 832     // finally also set the mask if we have one
 833     if ( image.HasMask() )
 834     {
 835         SetMask(new wxMask(*this, wxColour(image.GetMaskRed(),
 836                                            image.GetMaskGreen(),
 837                                            image.GetMaskBlue())));
 838     }
 839
 840     return TRUE;
 841 #else
 842     // FIXME: wxWinCE doesn't support wxDIB yet
 843     return FALSE;
 844 #endif
 845 }
 846
 847 wxImage wxBitmap::ConvertToImage() const
 848 {
 849     // FIXME: this is untested code for WinCE, and
 850     // the mask is not yet handled.
 851     // For tips, see:
 852     // http://www.codeproject.com/bitmap/dibsection.asp?print=true
 853
 854 #ifdef __WXWINCE__
 855     // the colour used as transparent one in wxImage and the one it is replaced
 856     // with when it really occurs in the bitmap
 857     static const int MASK_RED = 1;
 858     static const int MASK_GREEN = 2;
 859     static const int MASK_BLUE = 3;
 860     static const int MASK_BLUE_REPLACEMENT = 2;
 861
 862     wxImage image;
 863
 864     wxCHECK_MSG( Ok(), wxNullImage, wxT("invalid bitmap") );
 865
 866     // create an wxImage object
 867     int width = GetWidth();
 868     int height = GetHeight();
 869     image.Create( width, height );
 870     unsigned char *data = image.GetData();
 871     if( !data )
 872     {
 873         wxFAIL_MSG( wxT("could not allocate data for image") );
 874         return wxNullImage;
 875     }
 876
 877     // calc the number of bytes per scanline and padding in the DIB
 878     int bytePerLine = width*3;
 879     int sizeDWORD = sizeof( DWORD );
 880     int lineBoundary =  bytePerLine % sizeDWORD;
 881     int padding = 0;
 882     if( lineBoundary > 0 )
 883     {
 884         padding = sizeDWORD - lineBoundary;
 885         bytePerLine += padding;
 886     }
 887
 888     // create a DIB header
 889     int headersize = sizeof(BITMAPINFOHEADER);
 890     BITMAPINFO *lpDIBh = (BITMAPINFO *) malloc( headersize );
 891     if( !lpDIBh )
 892     {
 893         wxFAIL_MSG( wxT("could not allocate data for DIB header") );
 894         free( data );
 895         return wxNullImage;
 896     }
 897     // Fill in the DIB header
 898     lpDIBh->bmiHeader.biSize = headersize;
 899     lpDIBh->bmiHeader.biWidth = width;
 900     lpDIBh->bmiHeader.biHeight = -height;
 901     lpDIBh->bmiHeader.biSizeImage = bytePerLine * height;
 902     lpDIBh->bmiHeader.biPlanes = 1;
 903     lpDIBh->bmiHeader.biBitCount = 24;
 904     lpDIBh->bmiHeader.biCompression = BI_RGB;
 905     lpDIBh->bmiHeader.biClrUsed = 0;
 906     // These seem not really needed for our purpose here.
 907     lpDIBh->bmiHeader.biClrImportant = 0;
 908     lpDIBh->bmiHeader.biXPelsPerMeter = 0;
 909     lpDIBh->bmiHeader.biYPelsPerMeter = 0;
 910
 911     // memory for DIB data is allocated by CreateDIBSection
 912     void *lpBits = NULL;
 913
 914     // copy data from the device-dependent bitmap to the DIB
 915     HDC hdc = ::GetDC(NULL);
 916     HBITMAP hBitmap = (HBITMAP) GetHBITMAP();
 917
 918     HBITMAP hBitmapSection = ::CreateDIBSection( hdc, lpDIBh, DIB_RGB_COLORS, & lpBits, NULL, 0 );
 919     if (!hBitmapSection)
 920     {
 921         wxFAIL_MSG( wxT("could not create a DIB section") );
 922         return wxNullImage;
 923     }
 924
 925     // Copy the image from the DDB to the DIBSection
 926     // Need to copy the supplied bitmap onto the newly created DIBsection
 927     HDC hMemDC = CreateCompatibleDC(hdc);
 928         HDC hCopyDC = CreateCompatibleDC(hdc);
 929
 930     if (! hMemDC || ! hCopyDC)
 931     {
 932         wxFAIL_MSG( wxT("unable to create compatible DCs") );
 933         return wxNullImage;
 934     }
 935
 936 #if 0
 937     if (m_hPal)
 938     {
 939         SelectPalette(hMemDC, m_hPal, FALSE);   RealizePalette(hMemDC);
 940         SelectPalette(hCopyDC, m_hPal, FALSE);  RealizePalette(hCopyDC);
 941     }
 942 #endif
 943
 944     HBITMAP hOldMemBitmap  = (HBITMAP) SelectObject(hMemDC,  hBitmap);
 945     HBITMAP hOldCopyBitmap = (HBITMAP) SelectObject(hCopyDC, hBitmapSection);
 946
 947     BitBlt(hCopyDC, 0, 0, GetWidth(), GetHeight(), hMemDC, 0, 0, SRCCOPY);
 948
 949     SelectObject(hMemDC,  hOldMemBitmap);
 950     SelectObject(hCopyDC, hOldCopyBitmap);
 951     DeleteDC(hMemDC);
 952     DeleteDC(hCopyDC);
 953
 954 #if 0
 955     if (m_hPal)
 956     {
 957                 HGDIOBJ hObj = ::GetStockObject(DEFAULT_PALETTE);
 958         SelectObject(hMemDC, hObj);
 959         SelectObject(hCopyDC, hObj);
 960     }
 961 #endif
 962
 963         ReleaseDC(NULL, hdc);
 964
 965     // copy DIB data into the wxImage object
 966     int i, j;
 967     unsigned char *ptdata = data;
 968     unsigned char *ptbits = (unsigned char*) lpBits;
 969     for( i=0; i<height; i++ )
 970     {
 971         for( j=0; j<width; j++ )
 972         {
 973             *(ptdata++) = *(ptbits+2);
 974             *(ptdata++) = *(ptbits+1);
 975             *(ptdata++) = *(ptbits  );
 976             ptbits += 3;
 977         }
 978         ptbits += padding;
 979     }
 980
 981     // TODO
 982 #if 0
 983     // similarly, set data according to the possible mask bitmap
 984     if( GetMask() && GetMask()->GetMaskBitmap() )
 985     {
 986         hbitmap = (HBITMAP) GetMask()->GetMaskBitmap();
 987         // memory DC created, color set, data copied, and memory DC deleted
 988         HDC memdc = ::CreateCompatibleDC( hdc );
 989         ::SetTextColor( memdc, RGB( 0, 0, 0 ) );
 990         ::SetBkColor( memdc, RGB( 255, 255, 255 ) );
 991         ::GetDIBits( memdc, hbitmap, 0, height, lpBits, lpDIBh, DIB_RGB_COLORS );
 992         ::DeleteDC( memdc );
 993         ptdata = data;
 994         ptbits = lpBits;
 995         for( i=0; i<height; i++ )
 996         {
 997             for( j=0; j<width; j++ )
 998             {
 999                 // is this pixel transparent?
1000                 if ( *ptbits != 0 )
1001                 {
1002                     if ( (ptdata[0] == MASK_RED) &&
1003                             (ptdata[1] == MASK_GREEN) &&
1004                                 (ptdata[2] == MASK_BLUE) )
1005                     {
1006                         // we have to fudge the colour a bit to prevent this
1007                         // pixel from appearing transparent
1008                         ptdata[2] = MASK_BLUE_REPLACEMENT;
1009                     }
1010                     ptdata += 3;
1011                 }
1012                 else // masked pixel
1013                 {
1014                     *(ptdata++)  = MASK_RED;
1015                     *(ptdata++)  = MASK_GREEN;
1016                     *(ptdata++)  = MASK_BLUE;
1017                 }
1018                 ptbits += 3;
1019             }
1020             ptbits += padding;
1021         }
1022
1023         image.SetMaskColour( MASK_RED, MASK_GREEN, MASK_BLUE );
1024         image.SetMask( TRUE );
1025     }
1026     else
1027 #endif
1028     {
1029         image.SetMask( FALSE );
1030     }
1031
1032     // free allocated resources
1033     ::ReleaseDC(NULL, hdc);
1034     free(lpDIBh);
1035
1036     // Delete the DIB section
1037     ::DeleteObject(hBitmapSection);
1038
1039     return image;
1040 #else
1041     // the colour used as transparent one in wxImage and the one it is replaced
1042     // with when it really occurs in the bitmap
1043     static const int MASK_RED = 1;
1044     static const int MASK_GREEN = 2;
1045     static const int MASK_BLUE = 3;
1046     static const int MASK_BLUE_REPLACEMENT = 2;
1047
1048     wxImage image;
1049
1050     wxCHECK_MSG( Ok(), wxNullImage, wxT("invalid bitmap") );
1051
1052     // create an wxImage object
1053     int width = GetWidth();
1054     int height = GetHeight();
1055     image.Create( width, height );
1056     unsigned char *data = image.GetData();
1057     if( !data )
1058     {
1059         wxFAIL_MSG( wxT("could not allocate data for image") );
1060         return wxNullImage;
1061     }
1062
1063     // calc the number of bytes per scanline and padding in the DIB
1064     int bytePerLine = width*3;
1065     int sizeDWORD = sizeof( DWORD );
1066     int lineBoundary =  bytePerLine % sizeDWORD;
1067     int padding = 0;
1068     if( lineBoundary > 0 )
1069     {
1070         padding = sizeDWORD - lineBoundary;
1071         bytePerLine += padding;
1072     }
1073
1074     // create a DIB header
1075     int headersize = sizeof(BITMAPINFOHEADER);
1076     BITMAPINFO *lpDIBh = (BITMAPINFO *) malloc( headersize );
1077     if( !lpDIBh )
1078     {
1079         wxFAIL_MSG( wxT("could not allocate data for DIB header") );
1080         free( data );
1081         return wxNullImage;
1082     }
1083     // Fill in the DIB header
1084     lpDIBh->bmiHeader.biSize = headersize;
1085     lpDIBh->bmiHeader.biWidth = width;
1086     lpDIBh->bmiHeader.biHeight = -height;
1087     lpDIBh->bmiHeader.biSizeImage = bytePerLine * height;
1088     lpDIBh->bmiHeader.biPlanes = 1;
1089     lpDIBh->bmiHeader.biBitCount = 24;
1090     lpDIBh->bmiHeader.biCompression = BI_RGB;
1091     lpDIBh->bmiHeader.biClrUsed = 0;
1092     // These seem not really needed for our purpose here.
1093     lpDIBh->bmiHeader.biClrImportant = 0;
1094     lpDIBh->bmiHeader.biXPelsPerMeter = 0;
1095     lpDIBh->bmiHeader.biYPelsPerMeter = 0;
1096     // memory for DIB data
1097     unsigned char *lpBits;
1098     lpBits = (unsigned char *) malloc( lpDIBh->bmiHeader.biSizeImage );
1099     if( !lpBits )
1100     {
1101         wxFAIL_MSG( wxT("could not allocate data for DIB") );
1102         free( data );
1103         free( lpDIBh );
1104         return wxNullImage;
1105     }
1106
1107     // copy data from the device-dependent bitmap to the DIB
1108     HDC hdc = ::GetDC(NULL);
1109     HBITMAP hbitmap;
1110     hbitmap = (HBITMAP) GetHBITMAP();
1111     ::GetDIBits( hdc, hbitmap, 0, height, lpBits, lpDIBh, DIB_RGB_COLORS );
1112
1113     // copy DIB data into the wxImage object
1114     int i, j;
1115     unsigned char *ptdata = data;
1116     unsigned char *ptbits = lpBits;
1117     for( i=0; i<height; i++ )
1118     {
1119         for( j=0; j<width; j++ )
1120         {
1121             *(ptdata++) = *(ptbits+2);
1122             *(ptdata++) = *(ptbits+1);
1123             *(ptdata++) = *(ptbits  );
1124             ptbits += 3;
1125         }
1126         ptbits += padding;
1127     }
1128
1129     // similarly, set data according to the possible mask bitmap
1130     if( GetMask() && GetMask()->GetMaskBitmap() )
1131     {
1132         hbitmap = (HBITMAP) GetMask()->GetMaskBitmap();
1133         // memory DC created, color set, data copied, and memory DC deleted
1134         HDC memdc = ::CreateCompatibleDC( hdc );
1135         ::SetTextColor( memdc, RGB( 0, 0, 0 ) );
1136         ::SetBkColor( memdc, RGB( 255, 255, 255 ) );
1137         ::GetDIBits( memdc, hbitmap, 0, height, lpBits, lpDIBh, DIB_RGB_COLORS );
1138         ::DeleteDC( memdc );
1139         ptdata = data;
1140         ptbits = lpBits;
1141         for( i=0; i<height; i++ )
1142         {
1143             for( j=0; j<width; j++ )
1144             {
1145                 // is this pixel transparent?
1146                 if ( *ptbits != 0 )
1147                 {
1148                     if ( (ptdata[0] == MASK_RED) &&
1149                             (ptdata[1] == MASK_GREEN) &&
1150                                 (ptdata[2] == MASK_BLUE) )
1151                     {
1152                         // we have to fudge the colour a bit to prevent this
1153                         // pixel from appearing transparent
1154                         ptdata[2] = MASK_BLUE_REPLACEMENT;
1155                     }
1156                     ptdata += 3;
1157                 }
1158                 else // masked pixel
1159                 {
1160                     *(ptdata++)  = MASK_RED;
1161                     *(ptdata++)  = MASK_GREEN;
1162                     *(ptdata++)  = MASK_BLUE;
1163                 }
1164                 ptbits += 3;
1165             }
1166             ptbits += padding;
1167         }
1168
1169         image.SetMaskColour( MASK_RED, MASK_GREEN, MASK_BLUE );
1170         image.SetMask( TRUE );
1171     }
1172     else
1173     {
1174         image.SetMask( FALSE );
1175     }
1176     // free allocated resources
1177     ::ReleaseDC(NULL, hdc);
1178     free(lpDIBh);
1179     free(lpBits);
1180
1181     return image;
1182 #endif
1183 }
1184
1185 #endif // wxUSE_IMAGE
1186
1187 // ----------------------------------------------------------------------------
1188 // loading and saving bitmaps
1189 // ----------------------------------------------------------------------------
1190
1191 bool wxBitmap::LoadFile(const wxString& filename, long type)
1192 {
1193     UnRef();
1194
1195     wxBitmapHandler *handler = wxDynamicCast(FindHandler(type), wxBitmapHandler);
1196
1197     if ( handler )
1198     {
1199         m_refData = new wxBitmapRefData;
1200
1201         return handler->LoadFile(this, filename, type, -1, -1);
1202     }
1203 #if wxUSE_IMAGE
1204     else
1205     {
1206         wxImage image;
1207         if ( image.LoadFile( filename, type ) && image.Ok() )
1208         {
1209             *this = wxBitmap(image);
1210
1211             return TRUE;
1212         }
1213     }
1214 #endif // wxUSE_IMAGE
1215
1216     return FALSE;
1217 }
1218
1219 bool wxBitmap::Create(void *data, long type, int width, int height, int depth)
1220 {
1221     UnRef();
1222
1223     wxBitmapHandler *handler = wxDynamicCast(FindHandler(type), wxBitmapHandler);
1224
1225     if ( !handler )
1226     {
1227         wxLogDebug(wxT("Failed to create bitmap: no bitmap handler for type %ld defined."), type);
1228
1229         return FALSE;
1230     }
1231
1232     m_refData = new wxBitmapRefData;
1233
1234     return handler->Create(this, data, type, width, height, depth);
1235 }
1236
1237 bool wxBitmap::SaveFile(const wxString& filename,
1238                         int type,
1239                         const wxPalette *palette)
1240 {
1241     wxBitmapHandler *handler = wxDynamicCast(FindHandler(type), wxBitmapHandler);
1242
1243     if ( handler )
1244     {
1245         return handler->SaveFile(this, filename, type, palette);
1246     }
1247 #if wxUSE_IMAGE
1248     else
1249     {
1250         // FIXME what about palette? shouldn't we use it?
1251         wxImage image = ConvertToImage();
1252         if ( image.Ok() )
1253         {
1254             return image.SaveFile(filename, type);
1255         }
1256     }
1257 #endif // wxUSE_IMAGE
1258
1259     return FALSE;
1260 }
1261
1262 // ----------------------------------------------------------------------------
1263 // sub bitmap extraction
1264 // ----------------------------------------------------------------------------
1265
1266 wxBitmap wxBitmap::GetSubBitmap( const wxRect& rect) const
1267 {
1268     wxCHECK_MSG( Ok() &&
1269                  (rect.x >= 0) && (rect.y >= 0) &&
1270                  (rect.x+rect.width <= GetWidth()) &&
1271                  (rect.y+rect.height <= GetHeight()),
1272                  wxNullBitmap, wxT("Invalid bitmap or bitmap region") );
1273
1274     wxBitmap ret( rect.width, rect.height );
1275     wxASSERT_MSG( ret.Ok(), wxT("GetSubBitmap error") );
1276
1277 #ifndef __WXMICROWIN__
1278     // TODO: copy alpha channel data if any
1279
1280     // copy bitmap data
1281     MemoryHDC dcSrc,
1282               dcDst;
1283
1284     {
1285         SelectInHDC selectSrc(dcSrc, GetHbitmap()),
1286                     selectDst(dcDst, GetHbitmapOf(ret));
1287
1288         if ( !selectSrc || !selectDst )
1289         {
1290             wxLogLastError(_T("SelectObjct(hBitmap)"));
1291         }
1292
1293         if ( !::BitBlt(dcDst, 0, 0, rect.width, rect.height,
1294                        dcSrc, rect.x, rect.y, SRCCOPY) )
1295         {
1296             wxLogLastError(_T("BitBlt"));
1297         }
1298     }
1299
1300     // copy mask if there is one
1301     if ( GetMask() )
1302     {
1303         HBITMAP hbmpMask = ::CreateBitmap(rect.width, rect.height, 1, 1, 0);
1304
1305         SelectInHDC selectSrc(dcSrc, (HBITMAP) GetMask()->GetMaskBitmap()),
1306                     selectDst(dcDst, hbmpMask);
1307
1308         if ( !::BitBlt(dcDst, 0, 0, rect.width, rect.height,
1309                        dcSrc, rect.x, rect.y, SRCCOPY) )
1310         {
1311             wxLogLastError(_T("BitBlt"));
1312         }
1313
1314         wxMask *mask = new wxMask((WXHBITMAP) hbmpMask);
1315         ret.SetMask(mask);
1316     }
1317 #endif // !__WXMICROWIN__
1318
1319     return ret;
1320 }
1321
1322 // ----------------------------------------------------------------------------
1323 // wxBitmap accessors
1324 // ----------------------------------------------------------------------------
1325
1326 #if wxUSE_PALETTE
1327 wxPalette* wxBitmap::GetPalette() const
1328 {
1329     return GetBitmapData() ? &GetBitmapData()->m_bitmapPalette
1330                            : (wxPalette *) NULL;
1331 }
1332 #endif
1333
1334 wxMask *wxBitmap::GetMask() const
1335 {
1336     return GetBitmapData() ? GetBitmapData()->GetMask() : (wxMask *) NULL;
1337 }
1338
1339 #ifdef __WXDEBUG__
1340
1341 wxDC *wxBitmap::GetSelectedInto() const
1342 {
1343     return GetBitmapData() ? GetBitmapData()->m_selectedInto : (wxDC *) NULL;
1344 }
1345
1346 #endif
1347
1348 #if WXWIN_COMPATIBILITY_2_4
1349
1350 int wxBitmap::GetQuality() const
1351 {
1352     return 0;
1353 }
1354
1355 #endif // WXWIN_COMPATIBILITY_2_4
1356
1357 void wxBitmap::UseAlpha()
1358 {
1359     if ( GetBitmapData() )
1360         GetBitmapData()->m_hasAlpha = true;
1361 }
1362
1363 bool wxBitmap::HasAlpha() const
1364 {
1365     return GetBitmapData() && GetBitmapData()->m_hasAlpha;
1366 }
1367
1368 // ----------------------------------------------------------------------------
1369 // wxBitmap setters
1370 // ----------------------------------------------------------------------------
1371
1372 #ifdef __WXDEBUG__
1373
1374 void wxBitmap::SetSelectedInto(wxDC *dc)
1375 {
1376     if ( GetBitmapData() )
1377         GetBitmapData()->m_selectedInto = dc;
1378 }
1379
1380 #endif
1381
1382 #if wxUSE_PALETTE
1383
1384 void wxBitmap::SetPalette(const wxPalette& palette)
1385 {
1386     EnsureHasData();
1387
1388     GetBitmapData()->m_bitmapPalette = palette;
1389 }
1390
1391 #endif // wxUSE_PALETTE
1392
1393 void wxBitmap::SetMask(wxMask *mask)
1394 {
1395     EnsureHasData();
1396
1397     GetBitmapData()->SetMask(mask);
1398 }
1399
1400 #if WXWIN_COMPATIBILITY_2
1401
1402 void wxBitmap::SetOk(bool isOk)
1403 {
1404     EnsureHasData();
1405
1406     GetBitmapData()->m_ok = isOk;
1407 }
1408
1409 #endif // WXWIN_COMPATIBILITY_2
1410
1411 #if WXWIN_COMPATIBILITY_2_4
1412
1413 void wxBitmap::SetQuality(int WXUNUSED(quality))
1414 {
1415 }
1416
1417 #endif // WXWIN_COMPATIBILITY_2_4
1418
1419 // ----------------------------------------------------------------------------
1420 // raw bitmap access support
1421 // ----------------------------------------------------------------------------
1422
1423 #ifdef wxHAVE_RAW_BITMAP
1424 void *wxBitmap::GetRawData(wxPixelDataBase& data, int bpp)
1425 {
1426 #if wxUSE_WXDIB
1427     if ( !Ok() )
1428     {
1429         // no bitmap, no data (raw or otherwise)
1430         return NULL;
1431     }
1432
1433     // if we're already a DIB we can access our data directly, but if not we
1434     // need to convert this DDB to a DIB section and use it for raw access and
1435     // then convert it back
1436     HBITMAP hDIB;
1437     if ( !GetBitmapData()->m_isDIB )
1438     {
1439         wxCHECK_MSG( !GetBitmapData()->m_dib, FALSE,
1440                         _T("GetRawData() may be called only once") );
1441
1442         wxDIB *dib = new wxDIB(*this);
1443         if ( !dib->IsOk() )
1444         {
1445             delete dib;
1446
1447             return NULL;
1448         }
1449
1450         // we'll free it in UngetRawData()
1451         GetBitmapData()->m_dib = dib;
1452
1453         hDIB = dib->GetHandle();
1454     }
1455     else // we're a DIB
1456     {
1457         hDIB = GetHbitmap();
1458     }
1459
1460     DIBSECTION ds;
1461     if ( ::GetObject(hDIB, sizeof(ds), &ds) != sizeof(DIBSECTION) )
1462     {
1463         wxFAIL_MSG( _T("failed to get DIBSECTION from a DIB?") );
1464
1465         return NULL;
1466     }
1467
1468     // check that the bitmap is in correct format
1469     if ( ds.dsBm.bmBitsPixel != bpp )
1470     {
1471         wxFAIL_MSG( _T("incorrect bitmap type in wxBitmap::GetRawData()") );
1472
1473         return NULL;
1474     }
1475
1476     // ok, store the relevant info in wxPixelDataBase
1477     const LONG h = ds.dsBm.bmHeight;
1478
1479     data.m_width = ds.dsBm.bmWidth;
1480     data.m_height = h;
1481
1482     // remember that DIBs are stored in top to bottom order!
1483     const LONG bytesPerRow = ds.dsBm.bmWidthBytes;
1484     data.m_stride = -bytesPerRow;
1485
1486     char *bits = (char *)ds.dsBm.bmBits;
1487     if ( h > 1 )
1488     {
1489         bits += (h - 1)*bytesPerRow;
1490     }
1491
1492     return bits;
1493 #else
1494     return NULL;
1495 #endif
1496 }
1497
1498 void wxBitmap::UngetRawData(wxPixelDataBase& dataBase)
1499 {
1500 #if wxUSE_WXDIB
1501     if ( !Ok() )
1502         return;
1503
1504     // the cast is ugly but we can't do without it and without making this
1505     // function template (and hence inline) unfortunately
1506     typedef wxPixelData<wxBitmap, wxAlphaPixelFormat> PixelData;
1507     PixelData& data = (PixelData &)dataBase;
1508
1509     if ( !data )
1510     {
1511         // invalid data, don't crash -- but don't assert neither as we're
1512         // called automatically from wxPixelDataBase dtor and so there is no
1513         // way to prevent this from happening
1514         return;
1515     }
1516
1517     if ( GetBitmapData()->m_hasAlpha )
1518     {
1519         // AlphaBlend() wants to have premultiplied source alpha but
1520         // wxRawBitmap API uses normal, not premultiplied, colours, so adjust
1521         // them here now
1522         PixelData::Iterator p(data);
1523
1524         const int w = data.GetWidth();
1525         const int h = data.GetHeight();
1526
1527         for ( int y = 0; y < h; y++ )
1528         {
1529             PixelData::Iterator rowStart = p;
1530
1531             for ( int x = 0; x < w; x++ )
1532             {
1533                 const unsigned alpha = p.Alpha();
1534
1535                 p.Red() = (p.Red() * alpha + 127) / 255;
1536                 p.Blue() = (p.Blue() * alpha + 127) / 255;
1537                 p.Green() = (p.Green() * alpha + 127) / 255;
1538
1539                 ++p;
1540             }
1541
1542             p = rowStart;
1543             p.OffsetY(data, 1);
1544         }
1545
1546         // if we're a DDB we need to convert DIB back to DDB now to make the
1547         // changes made via raw bitmap access effective
1548         if ( !GetBitmapData()->m_isDIB )
1549         {
1550             wxDIB *dib = GetBitmapData()->m_dib;
1551             GetBitmapData()->m_dib = NULL;
1552
1553             // TODO: convert
1554
1555             delete dib;
1556         }
1557     }
1558 #endif
1559 }
1560 #endif // #ifdef wxHAVE_RAW_BITMAP
1561
1562 // ----------------------------------------------------------------------------
1563 // wxMask
1564 // ----------------------------------------------------------------------------
1565
1566 wxMask::wxMask()
1567 {
1568     m_maskBitmap = 0;
1569 }
1570
1571 // Construct a mask from a bitmap and a colour indicating
1572 // the transparent area
1573 wxMask::wxMask(const wxBitmap& bitmap, const wxColour& colour)
1574 {
1575     m_maskBitmap = 0;
1576     Create(bitmap, colour);
1577 }
1578
1579 // Construct a mask from a bitmap and a palette index indicating
1580 // the transparent area
1581 wxMask::wxMask(const wxBitmap& bitmap, int paletteIndex)
1582 {
1583     m_maskBitmap = 0;
1584     Create(bitmap, paletteIndex);
1585 }
1586
1587 // Construct a mask from a mono bitmap (copies the bitmap).
1588 wxMask::wxMask(const wxBitmap& bitmap)
1589 {
1590     m_maskBitmap = 0;
1591     Create(bitmap);
1592 }
1593
1594 wxMask::~wxMask()
1595 {
1596     if ( m_maskBitmap )
1597         ::DeleteObject((HBITMAP) m_maskBitmap);
1598 }
1599
1600 // Create a mask from a mono bitmap (copies the bitmap).
1601 bool wxMask::Create(const wxBitmap& bitmap)
1602 {
1603 #ifndef __WXMICROWIN__
1604     wxCHECK_MSG( bitmap.Ok() && bitmap.GetDepth() == 1, FALSE,
1605                  _T("can't create mask from invalid or not monochrome bitmap") );
1606
1607     if ( m_maskBitmap )
1608     {
1609         ::DeleteObject((HBITMAP) m_maskBitmap);
1610         m_maskBitmap = 0;
1611     }
1612
1613     m_maskBitmap = (WXHBITMAP) CreateBitmap(
1614                                             bitmap.GetWidth(),
1615                                             bitmap.GetHeight(),
1616                                             1, 1, 0
1617                                            );
1618     HDC srcDC = CreateCompatibleDC(0);
1619     SelectObject(srcDC, (HBITMAP) bitmap.GetHBITMAP());
1620     HDC destDC = CreateCompatibleDC(0);
1621     SelectObject(destDC, (HBITMAP) m_maskBitmap);
1622     BitBlt(destDC, 0, 0, bitmap.GetWidth(), bitmap.GetHeight(), srcDC, 0, 0, SRCCOPY);
1623     SelectObject(srcDC, 0);
1624     DeleteDC(srcDC);
1625     SelectObject(destDC, 0);
1626     DeleteDC(destDC);
1627     return TRUE;
1628 #else
1629     return FALSE;
1630 #endif
1631 }
1632
1633 // Create a mask from a bitmap and a palette index indicating
1634 // the transparent area
1635 bool wxMask::Create(const wxBitmap& bitmap, int paletteIndex)
1636 {
1637     if ( m_maskBitmap )
1638     {
1639         ::DeleteObject((HBITMAP) m_maskBitmap);
1640         m_maskBitmap = 0;
1641     }
1642
1643 #if wxUSE_PALETTE
1644     if (bitmap.Ok() && bitmap.GetPalette()->Ok())
1645     {
1646         unsigned char red, green, blue;
1647         if (bitmap.GetPalette()->GetRGB(paletteIndex, &red, &green, &blue))
1648         {
1649             wxColour transparentColour(red, green, blue);
1650             return Create(bitmap, transparentColour);
1651         }
1652     }
1653 #endif // wxUSE_PALETTE
1654
1655     return FALSE;
1656 }
1657
1658 // Create a mask from a bitmap and a colour indicating
1659 // the transparent area
1660 bool wxMask::Create(const wxBitmap& bitmap, const wxColour& colour)
1661 {
1662 #ifndef __WXMICROWIN__
1663     wxCHECK_MSG( bitmap.Ok(), FALSE, _T("invalid bitmap in wxMask::Create") );
1664
1665     if ( m_maskBitmap )
1666     {
1667         ::DeleteObject((HBITMAP) m_maskBitmap);
1668         m_maskBitmap = 0;
1669     }
1670
1671     int width = bitmap.GetWidth(),
1672         height = bitmap.GetHeight();
1673
1674     // scan the bitmap for the transparent colour and set the corresponding
1675     // pixels in the mask to BLACK and the rest to WHITE
1676     COLORREF maskColour = wxColourToPalRGB(colour);
1677     m_maskBitmap = (WXHBITMAP)::CreateBitmap(width, height, 1, 1, 0);
1678
1679     HDC srcDC = ::CreateCompatibleDC(NULL);
1680     HDC destDC = ::CreateCompatibleDC(NULL);
1681     if ( !srcDC || !destDC )
1682     {
1683         wxLogLastError(wxT("CreateCompatibleDC"));
1684     }
1685
1686     bool ok = TRUE;
1687
1688     // SelectObject() will fail
1689     wxASSERT_MSG( !bitmap.GetSelectedInto(),
1690                   _T("bitmap can't be selected in another DC") );
1691
1692     HGDIOBJ hbmpSrcOld = ::SelectObject(srcDC, GetHbitmapOf(bitmap));
1693     if ( !hbmpSrcOld )
1694     {
1695         wxLogLastError(wxT("SelectObject"));
1696
1697         ok = FALSE;
1698     }
1699
1700     HGDIOBJ hbmpDstOld = ::SelectObject(destDC, (HBITMAP)m_maskBitmap);
1701     if ( !hbmpDstOld )
1702     {
1703         wxLogLastError(wxT("SelectObject"));
1704
1705         ok = FALSE;
1706     }
1707
1708     if ( ok )
1709     {
1710         // this will create a monochrome bitmap with 0 points for the pixels
1711         // which have the same value as the background colour and 1 for the
1712         // others
1713         ::SetBkColor(srcDC, maskColour);
1714         ::BitBlt(destDC, 0, 0, width, height, srcDC, 0, 0, NOTSRCCOPY);
1715     }
1716
1717     ::SelectObject(srcDC, hbmpSrcOld);
1718     ::DeleteDC(srcDC);
1719     ::SelectObject(destDC, hbmpDstOld);
1720     ::DeleteDC(destDC);
1721
1722     return ok;
1723 #else // __WXMICROWIN__
1724     return FALSE;
1725 #endif // __WXMICROWIN__/!__WXMICROWIN__
1726 }
1727
1728 // ----------------------------------------------------------------------------
1729 // wxBitmapHandler
1730 // ----------------------------------------------------------------------------
1731
1732 bool wxBitmapHandler::Create(wxGDIImage *image,
1733                              void *data,
1734                              long flags,
1735                              int width, int height, int depth)
1736 {
1737     wxBitmap *bitmap = wxDynamicCast(image, wxBitmap);
1738
1739     return bitmap ? Create(bitmap, data, flags, width, height, depth) : FALSE;
1740 }
1741
1742 bool wxBitmapHandler::Load(wxGDIImage *image,
1743                            const wxString& name,
1744                            long flags,
1745                            int width, int height)
1746 {
1747     wxBitmap *bitmap = wxDynamicCast(image, wxBitmap);
1748
1749     return bitmap ? LoadFile(bitmap, name, flags, width, height) : FALSE;
1750 }
1751
1752 bool wxBitmapHandler::Save(wxGDIImage *image,
1753                            const wxString& name,
1754                            int type)
1755 {
1756     wxBitmap *bitmap = wxDynamicCast(image, wxBitmap);
1757
1758     return bitmap ? SaveFile(bitmap, name, type) : FALSE;
1759 }
1760
1761 bool wxBitmapHandler::Create(wxBitmap *WXUNUSED(bitmap),
1762                              void *WXUNUSED(data),
1763                              long WXUNUSED(type),
1764                              int WXUNUSED(width),
1765                              int WXUNUSED(height),
1766                              int WXUNUSED(depth))
1767 {
1768     return FALSE;
1769 }
1770
1771 bool wxBitmapHandler::LoadFile(wxBitmap *WXUNUSED(bitmap),
1772                                const wxString& WXUNUSED(name),
1773                                long WXUNUSED(type),
1774                                int WXUNUSED(desiredWidth),
1775                                int WXUNUSED(desiredHeight))
1776 {
1777     return FALSE;
1778 }
1779
1780 bool wxBitmapHandler::SaveFile(wxBitmap *WXUNUSED(bitmap),
1781                                const wxString& WXUNUSED(name),
1782                                int WXUNUSED(type),
1783                                const wxPalette *WXUNUSED(palette))
1784 {
1785     return FALSE;
1786 }
1787
1788 // ----------------------------------------------------------------------------
1789 // DIB functions
1790 // ----------------------------------------------------------------------------
1791
1792 #ifndef __WXMICROWIN__
1793 bool wxCreateDIB(long xSize, long ySize, long bitsPerPixel,
1794                  HPALETTE hPal, LPBITMAPINFO* lpDIBHeader)
1795 {
1796    unsigned long   i, headerSize;
1797    LPBITMAPINFO    lpDIBheader = NULL;
1798    LPPALETTEENTRY  lpPe = NULL;
1799
1800
1801    // Allocate space for a DIB header
1802    headerSize = (sizeof(BITMAPINFOHEADER) + (256 * sizeof(PALETTEENTRY)));
1803    lpDIBheader = (BITMAPINFO *) malloc(headerSize);
1804    lpPe = (PALETTEENTRY *)((BYTE*)lpDIBheader + sizeof(BITMAPINFOHEADER));
1805
1806    GetPaletteEntries(hPal, 0, 256, lpPe);
1807
1808    memset(lpDIBheader, 0x00, sizeof(BITMAPINFOHEADER));
1809
1810    // Fill in the static parts of the DIB header
1811    lpDIBheader->bmiHeader.biSize = sizeof(BITMAPINFOHEADER);
1812    lpDIBheader->bmiHeader.biWidth = xSize;
1813    lpDIBheader->bmiHeader.biHeight = ySize;
1814    lpDIBheader->bmiHeader.biPlanes = 1;
1815
1816    // this value must be 1, 4, 8 or 24 so PixelDepth can only be
1817    lpDIBheader->bmiHeader.biBitCount = (WORD)(bitsPerPixel);
1818    lpDIBheader->bmiHeader.biCompression = BI_RGB;
1819    lpDIBheader->bmiHeader.biSizeImage = xSize * abs(ySize) * bitsPerPixel >> 3;
1820    lpDIBheader->bmiHeader.biClrUsed = 256;
1821
1822
1823    // Initialize the DIB palette
1824    for (i = 0; i < 256; i++) {
1825       lpDIBheader->bmiColors[i].rgbReserved = lpPe[i].peFlags;
1826       lpDIBheader->bmiColors[i].rgbRed = lpPe[i].peRed;
1827       lpDIBheader->bmiColors[i].rgbGreen = lpPe[i].peGreen;
1828       lpDIBheader->bmiColors[i].rgbBlue = lpPe[i].peBlue;
1829    }
1830
1831    *lpDIBHeader = lpDIBheader;
1832
1833    return TRUE;
1834 }
1835
1836 void wxFreeDIB(LPBITMAPINFO lpDIBHeader)
1837 {
1838     free(lpDIBHeader);
1839 }
1840 #endif
1841
1842 // ----------------------------------------------------------------------------
1843 // global helper functions implemented here
1844 // ----------------------------------------------------------------------------
1845
1846 // helper of wxBitmapToHICON/HCURSOR
1847 static
1848 HICON wxBitmapToIconOrCursor(const wxBitmap& bmp,
1849                              bool iconWanted,
1850                              int hotSpotX,
1851                              int hotSpotY)
1852 {
1853     if ( !bmp.Ok() )
1854     {
1855         // we can't create an icon/cursor form nothing
1856         return 0;
1857     }
1858
1859     wxMask *mask = bmp.GetMask();
1860     if ( !mask )
1861     {
1862         // we must have a mask for an icon, so even if it's probably incorrect,
1863         // do create it (grey is the "standard" transparent colour)
1864         mask = new wxMask(bmp, *wxLIGHT_GREY);
1865     }
1866
1867     ICONINFO iconInfo;
1868     iconInfo.fIcon = iconWanted;  // do we want an icon or a cursor?
1869     if ( !iconWanted )
1870     {
1871         iconInfo.xHotspot = hotSpotX;
1872         iconInfo.yHotspot = hotSpotY;
1873     }
1874
1875     iconInfo.hbmMask = wxInvertMask((HBITMAP)mask->GetMaskBitmap());
1876     iconInfo.hbmColor = GetHbitmapOf(bmp);
1877
1878     // black out the transparent area to preserve background colour, because
1879     // Windows blits the original bitmap using SRCINVERT (XOR) after applying
1880     // the mask to the dest rect.
1881     {
1882         MemoryHDC dcSrc, dcDst;
1883         SelectInHDC selectMask(dcSrc, (HBITMAP)mask->GetMaskBitmap()),
1884                     selectBitmap(dcDst, iconInfo.hbmColor);
1885
1886         if ( !::BitBlt(dcDst, 0, 0, bmp.GetWidth(), bmp.GetHeight(),
1887                        dcSrc, 0, 0, SRCAND) )
1888         {
1889             wxLogLastError(_T("BitBlt"));
1890         }
1891     }
1892
1893     HICON hicon = ::CreateIconIndirect(&iconInfo);
1894
1895     if ( !bmp.GetMask() )
1896     {
1897         // we created the mask, now delete it
1898         delete mask;
1899     }
1900
1901     // delete the inverted mask bitmap we created as well
1902     ::DeleteObject(iconInfo.hbmMask);
1903
1904     return hicon;
1905 }
1906
1907 HICON wxBitmapToHICON(const wxBitmap& bmp)
1908 {
1909     return wxBitmapToIconOrCursor(bmp, TRUE, 0, 0);
1910 }
1911
1912 HCURSOR wxBitmapToHCURSOR(const wxBitmap& bmp, int hotSpotX, int hotSpotY)
1913 {
1914     return (HCURSOR)wxBitmapToIconOrCursor(bmp, FALSE, hotSpotX, hotSpotY);
1915 }
1916
1917 HBITMAP wxInvertMask(HBITMAP hbmpMask, int w, int h)
1918 {
1919 #ifndef __WXMICROWIN__
1920     wxCHECK_MSG( hbmpMask, 0, _T("invalid bitmap in wxInvertMask") );
1921
1922     // get width/height from the bitmap if not given
1923     if ( !w || !h )
1924     {
1925         BITMAP bm;
1926         ::GetObject(hbmpMask, sizeof(BITMAP), (LPVOID)&bm);
1927         w = bm.bmWidth;
1928         h = bm.bmHeight;
1929     }
1930
1931     HDC hdcSrc = ::CreateCompatibleDC(NULL);
1932     HDC hdcDst = ::CreateCompatibleDC(NULL);
1933     if ( !hdcSrc || !hdcDst )
1934     {
1935         wxLogLastError(wxT("CreateCompatibleDC"));
1936     }
1937
1938     HBITMAP hbmpInvMask = ::CreateBitmap(w, h, 1, 1, 0);
1939     if ( !hbmpInvMask )
1940     {
1941         wxLogLastError(wxT("CreateBitmap"));
1942     }
1943
1944     ::SelectObject(hdcSrc, hbmpMask);
1945     ::SelectObject(hdcDst, hbmpInvMask);
1946     if ( !::BitBlt(hdcDst, 0, 0, w, h,
1947                    hdcSrc, 0, 0,
1948                    NOTSRCCOPY) )
1949     {
1950         wxLogLastError(wxT("BitBlt"));
1951     }
1952
1953     ::DeleteDC(hdcSrc);
1954     ::DeleteDC(hdcDst);
1955
1956     return hbmpInvMask;
1957 #else
1958     return 0;
1959 #endif
1960 }