remove extraneous returns

[wxWidgets.git] / src / cocoa / dcmemory.mm

diff --git a/src/cocoa/dcmemory.mm b/src/cocoa/dcmemory.mm
index bf3920f49e29d76b86ec180bab50194a01dc14d3..0eb5905b14faca218e4678017dbb921d8c390064 100644 (file)
--- a/src/cocoa/dcmemory.mm
+++ b/src/cocoa/dcmemory.mm
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        src/cocoa/dcmemory.mm
 /////////////////////////////////////////////////////////////////////////////
 // Name:        src/cocoa/dcmemory.mm

-// Purpose:     wxMemoryDC class
+// Purpose:     wxMemoryDCImpl class

 // Author:      David Elliott
 // Modified by:
 // Created:     2003/03/16
 // Author:      David Elliott
 // Modified by:
 // Created:     2003/03/16


@@ -13,9 +13,9 @@
 
 #ifndef WX_PRECOMP
     #include "wx/log.h"
 
 #ifndef WX_PRECOMP
     #include "wx/log.h"

-    #include "wx/dcmemory.h"

 #endif //WX_PRECOMP
 
 #endif //WX_PRECOMP
 

+#include "wx/cocoa/dcmemory.h"

 #include "wx/cocoa/autorelease.h"
 
 #import <AppKit/NSImage.h>
 #include "wx/cocoa/autorelease.h"
 
 #import <AppKit/NSImage.h>


@@ -25,33 +25,30 @@
 #import <AppKit/NSBezierPath.h>
 
 //-----------------------------------------------------------------------------
 #import <AppKit/NSBezierPath.h>
 
 //-----------------------------------------------------------------------------

-// wxMemoryDC
+// wxMemoryDCImpl

 //-----------------------------------------------------------------------------
 
 //-----------------------------------------------------------------------------
 

-IMPLEMENT_DYNAMIC_CLASS(wxMemoryDC,wxDC)
+IMPLEMENT_ABSTRACT_CLASS(wxMemoryDCImpl,wxCocoaDCImpl)

 
 

-wxMemoryDC::wxMemoryDC( const wxBitmap& bitmap )
+void wxMemoryDCImpl::Init()

 {
     m_cocoaNSImage = NULL;
     m_ok = false;
 {
     m_cocoaNSImage = NULL;
     m_ok = false;

-
-    if ( bitmap.IsOk() )
-        SelectObject(bitmap);

 }
 
 }
 

-wxMemoryDC::wxMemoryDC( wxDC *WXUNUSED(dc) )
+wxMemoryDCImpl::wxMemoryDCImpl(wxMemoryDC *owner, wxDC *WXUNUSED(dc))
+:   wxCocoaDCImpl(owner)

 {
 {

-    m_cocoaNSImage = NULL;
-    m_ok = false;
+    Init();

 }
 
 }
 

-wxMemoryDC::~wxMemoryDC(void)
+wxMemoryDCImpl::~wxMemoryDCImpl(void)

 {
     CocoaUnwindStackAndLoseFocus();
     [m_cocoaNSImage release];
 }
 
 {
     CocoaUnwindStackAndLoseFocus();
     [m_cocoaNSImage release];
 }
 

-bool wxMemoryDC::CocoaLockFocus()
+bool wxMemoryDCImpl::CocoaLockFocus()

 {
     if(m_cocoaNSImage)
     {
 {
     if(m_cocoaNSImage)
     {


@@ -67,7 +64,7 @@ bool wxMemoryDC::CocoaLockFocus()
     return false;
 }
 
     return false;
 }
 

-bool wxMemoryDC::CocoaUnlockFocus()
+bool wxMemoryDCImpl::CocoaUnlockFocus()

 {
     [m_cocoaNSImage unlockFocus];
     return true;
 {
     [m_cocoaNSImage unlockFocus];
     return true;


@@ -75,13 +72,19 @@ bool wxMemoryDC::CocoaUnlockFocus()
 
 // NOTE: The AppKit is unable to draw onto an NSBitmapImageRep so we must
 // instead copy the data to an offscreen window, then copy it back
 
 // NOTE: The AppKit is unable to draw onto an NSBitmapImageRep so we must
 // instead copy the data to an offscreen window, then copy it back

-void wxMemoryDC::SelectObject( const wxBitmap& bitmap )
+void wxMemoryDCImpl::DoSelect( const wxBitmap& bitmap )

 {
     wxAutoNSAutoreleasePool pool;
     if(m_selectedBitmap.Ok())
     {
         CocoaTakeFocus();
         wxASSERT(m_cocoaNSImage);
 {
     wxAutoNSAutoreleasePool pool;
     if(m_selectedBitmap.Ok())
     {
         CocoaTakeFocus();
         wxASSERT(m_cocoaNSImage);

+        // Replace the bitmap's native data with a newly created one based on the
+        // NSImage that has been (potentially) drawn upon.  Note that this may and
+        // probably will in many cases change the bitmap's format.
+        // There is nothing we can do about this using pure Cocoa code.  Even using
+        // CGBitmapContext is not an option because it only supports a limited
+        // number of bitmap formats.  Specifically, 24-bpp is not supported.

         m_selectedBitmap.SetNSBitmapImageRep(
             [[NSBitmapImageRep alloc]
                 initWithFocusedViewRect:NSMakeRect(0.0,0.0,
         m_selectedBitmap.SetNSBitmapImageRep(
             [[NSBitmapImageRep alloc]
                 initWithFocusedViewRect:NSMakeRect(0.0,0.0,


@@ -100,6 +103,16 @@ void wxMemoryDC::SelectObject( const wxBitmap& bitmap )
                     m_selectedBitmap.GetHeight())];
 
         // Now copy the data
                     m_selectedBitmap.GetHeight())];
 
         // Now copy the data

+        // Pass false to GetNSImage so the mask is not applied as an alpha channel.
+        // Cocoa uses premultiplied alpha so applying the mask would cause all
+        // color information masked out to be turned black which is undesirable.
+        // FIXME: Currently, the mask will not be updated if any drawing occurs.
+        // My only suggestion is for wxCocoa users to eschew the mask in favor
+        // of an alpha channel or to recreate the mask after drawing.
+        // The only way to fix this is to draw twice, once as normal and again
+        // onto the mask to update it.  That would require overriding every
+        // single drawing primitive (e.g. DoDrawLine, DoDrawRectangle, etc.)
+        // and would be a major undertaking.

         NSImage *nsimage = [m_selectedBitmap.GetNSImage(false) retain];
         [m_cocoaNSImage lockFocus];
         [nsimage drawAtPoint: NSMakePoint(0,0)
         NSImage *nsimage = [m_selectedBitmap.GetNSImage(false) retain];
         [m_cocoaNSImage lockFocus];
         [nsimage drawAtPoint: NSMakePoint(0,0)


@@ -112,7 +125,7 @@ void wxMemoryDC::SelectObject( const wxBitmap& bitmap )
     }
 }
 
     }
 }
 

-void wxMemoryDC::DoGetSize( int *width, int *height ) const
+void wxMemoryDCImpl::DoGetSize( int *width, int *height ) const

 {
     if(width)
         *width = m_selectedBitmap.GetWidth();
 {
     if(width)
         *width = m_selectedBitmap.GetWidth();


@@ -120,7 +133,7 @@ void wxMemoryDC::DoGetSize( int *width, int *height ) const
         *height = m_selectedBitmap.GetHeight();
 }
 
         *height = m_selectedBitmap.GetHeight();
 }
 

-bool wxMemoryDC::CocoaDoBlitOnFocusedDC(wxCoord xdest, wxCoord ydest,
+bool wxMemoryDCImpl::CocoaDoBlitOnFocusedDC(wxCoord xdest, wxCoord ydest,

     wxCoord width, wxCoord height, wxCoord xsrc, wxCoord ysrc,
     int logicalFunc, bool useMask, wxCoord xsrcMask, wxCoord ysrcMask)
 {
     wxCoord width, wxCoord height, wxCoord xsrc, wxCoord ysrc,
     int logicalFunc, bool useMask, wxCoord xsrcMask, wxCoord ysrcMask)
 {


@@ -146,19 +159,53 @@ bool wxMemoryDC::CocoaDoBlitOnFocusedDC(wxCoord xdest, wxCoord ydest,
     [transform concat];
     [flipTransform concat];
 
     [transform concat];
     [flipTransform concat];
 

+    NSImage *sourceImage;
+    if(useMask)
+    {
+        sourceImage = [m_cocoaNSImage copy];
+        // Apply the mask to the copied image
+        NSBitmapImageRep *maskRep = m_selectedBitmap.GetMask()->GetNSBitmapImageRep();
+        NSImage *maskImage = [[NSImage alloc] initWithSize:[maskRep size]];
+        [maskImage addRepresentation:maskRep];
+        [sourceImage lockFocus];
+        [maskImage compositeToPoint:NSZeroPoint operation:NSCompositeDestinationIn];
+        [sourceImage unlockFocus];
+        [maskImage release];
+    }
+    else
+    {   // retain the m_cocoaNSImage so it has the same ownership as the copy done in the other case.
+        sourceImage = [m_cocoaNSImage retain];
+    }
+    NSCompositingOperation drawingOp;
+    switch(logicalFunc)
+    {
+    case wxCOPY:
+        // Even if not using the mask, the image might have an alpha channel
+        // so always use NSCompositeSourceOver.  If the image is fully opaque
+        // it works out the same as NSCompositeCopy.
+        drawingOp = NSCompositeSourceOver;
+        break;
+    // FIXME: implement more raster ops
+    default:
+        wxLogDebug(wxT("wxCocoa does not support blitting with raster operation %d."), logicalFunc);
+        // Just use the default operation.
+        drawingOp = NSCompositeCopy;
+    }
+

     wxLogTrace(wxTRACE_COCOA,wxT("[m_cocoaNSImage isFlipped]=%d"), [m_cocoaNSImage isFlipped]);
     wxLogTrace(wxTRACE_COCOA,wxT("[m_cocoaNSImage isFlipped]=%d"), [m_cocoaNSImage isFlipped]);

-    [m_cocoaNSImage drawAtPoint: NSMakePoint(0,0)
+    [sourceImage drawAtPoint: NSMakePoint(0,0)

         fromRect: NSMakeRect(xsrc,
             m_selectedBitmap.GetHeight()-height-ysrc,
             width, height)
         fromRect: NSMakeRect(xsrc,
             m_selectedBitmap.GetHeight()-height-ysrc,
             width, height)

-        operation: NSCompositeCopy // FIXME: raster ops
+        operation: drawingOp

         fraction: 1.0];
 
         fraction: 1.0];
 

+    [sourceImage release]; // It was either retained, copied, or allocated.

     [context restoreGraphicsState];
     return false;
 }
 
     [context restoreGraphicsState];
     return false;
 }
 

-bool wxMemoryDC::CocoaGetBounds(void *rectData)
+bool wxMemoryDCImpl::CocoaGetBounds(void *rectData)

 {
     if(!rectData)
         return false;
 {
     if(!rectData)
         return false;