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