src/msw/bitmap.cpp

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