readability cleanup

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

diff --git a/src/cocoa/dc.mm b/src/cocoa/dc.mm
index 7f19fe770932b1b218957f4f3be1e215488d92f7..b6ee3bf591301e93d35f4570f356e20fd568c7b8 100644 (file)
--- a/src/cocoa/dc.mm
+++ b/src/cocoa/dc.mm
@@ -6,13 +6,17 @@
 // Created:     2003/04/01
 // RCS-ID:      $Id$
 // Copyright:   (c) 2003 David Elliott
 // Created:     2003/04/01
 // RCS-ID:      $Id$
 // Copyright:   (c) 2003 David Elliott

-// Licence:    wxWindows license
+// Licence:    wxWidgets licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

-#include "wx/dc.h"
-#include "wx/log.h"
+#include "wx/wxprec.h"
+#ifndef WX_PRECOMP
+    #include "wx/log.h"
+    #include "wx/dc.h"
+#endif //WX_PRECOMP

 
 #include "wx/cocoa/autorelease.h"
 
 #include "wx/cocoa/autorelease.h"

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

 
 #import <AppKit/NSBezierPath.h>
 #import <AppKit/NSTextStorage.h>
 
 #import <AppKit/NSBezierPath.h>
 #import <AppKit/NSTextStorage.h>


@@ -21,18 +25,54 @@
 #import <AppKit/NSGraphicsContext.h>
 #import <AppKit/NSAffineTransform.h>
 #import <AppKit/NSColor.h>
 #import <AppKit/NSGraphicsContext.h>
 #import <AppKit/NSAffineTransform.h>
 #import <AppKit/NSColor.h>

-#import <AppKit/NSTypeSetter.h>
+#import <AppKit/NSTypesetter.h>

 #import <AppKit/NSImage.h>
 
 #import <AppKit/NSImage.h>
 

+#include "wx/math.h" //math constants
+#include "wx/listimpl.cpp"
+WX_DEFINE_LIST(wxCocoaDCStack);
+

 IMPLEMENT_ABSTRACT_CLASS(wxDC, wxObject)
 IMPLEMENT_ABSTRACT_CLASS(wxDC, wxObject)

-wxDC *wxDC::sm_focusedDC = NULL;

 WX_NSTextStorage wxDC::sm_cocoaNSTextStorage = nil;
 WX_NSLayoutManager wxDC::sm_cocoaNSLayoutManager = nil;
 WX_NSTextContainer wxDC::sm_cocoaNSTextContainer = nil;
 WX_NSTextStorage wxDC::sm_cocoaNSTextStorage = nil;
 WX_NSLayoutManager wxDC::sm_cocoaNSLayoutManager = nil;
 WX_NSTextContainer wxDC::sm_cocoaNSTextContainer = nil;

+wxCocoaDCStack wxDC::sm_cocoaDCStack;
+
+inline void CocoaSetPenForNSBezierPath(wxPen &pen, NSBezierPath *bezpath)
+{
+    [pen.GetNSColor() set];
+    const float *pattern;
+    [bezpath setLineDash:pattern count:pen.GetCocoaLineDash(&pattern) phase:0.0];
+    [bezpath setLineWidth:pen.GetWidth()];
+    switch(pen.GetJoin())
+    {
+    case wxJOIN_BEVEL:
+        [bezpath setLineJoinStyle:NSBevelLineJoinStyle];
+        break;
+    case wxJOIN_ROUND:
+        [bezpath setLineJoinStyle:NSRoundLineJoinStyle];
+        break;
+    case wxJOIN_MITER:
+        [bezpath setLineJoinStyle:NSMiterLineJoinStyle];
+        break;
+    }
+    switch(pen.GetCap())
+    {
+    case wxCAP_ROUND:
+        [bezpath setLineCapStyle:NSRoundLineCapStyle];
+        break;
+    case wxCAP_PROJECTING:
+        [bezpath setLineCapStyle:NSSquareLineCapStyle];
+        break;
+    case wxCAP_BUTT:
+        [bezpath setLineCapStyle:NSButtLineCapStyle];
+        break;
+    }
+}

 
 void wxDC::CocoaInitializeTextSystem()
 {
 
 void wxDC::CocoaInitializeTextSystem()
 {

-    wxASSERT_MSG(!sm_cocoaNSTextStorage && !sm_cocoaNSLayoutManager && !sm_cocoaNSTextContainer,"Text system already initalized!  BAD PROGRAMMER!");
+    wxASSERT_MSG(!sm_cocoaNSTextStorage && !sm_cocoaNSLayoutManager && !sm_cocoaNSTextContainer,wxT("Text system already initalized!  BAD PROGRAMMER!"));

 
     sm_cocoaNSTextStorage = [[NSTextStorage alloc] init];
 
 
     sm_cocoaNSTextStorage = [[NSTextStorage alloc] init];
 


@@ -57,18 +97,120 @@ void wxDC::CocoaShutdownTextSystem()
     [sm_cocoaNSTextStorage release]; sm_cocoaNSTextStorage = nil;
 }
 
     [sm_cocoaNSTextStorage release]; sm_cocoaNSTextStorage = nil;
 }
 

+void wxDC::CocoaUnwindStackAndLoseFocus()
+{
+    wxCocoaDCStack::compatibility_iterator ourNode=sm_cocoaDCStack.Find(this);
+    if(ourNode)
+    {
+        wxCocoaDCStack::compatibility_iterator node=sm_cocoaDCStack.GetFirst();
+        for(;node!=ourNode; node=sm_cocoaDCStack.GetFirst())
+        {
+            wxDC *dc = node->GetData();
+            wxASSERT(dc);
+            wxASSERT(dc!=this);
+            if(!dc->CocoaUnlockFocus())
+            {
+                wxFAIL_MSG(wxT("Unable to unlock focus on higher-level DC!"));
+            }
+            sm_cocoaDCStack.Erase(node);
+        }
+        wxASSERT(node==ourNode);
+        wxASSERT(ourNode->GetData() == this);
+        ourNode->GetData()->CocoaUnlockFocus();
+        sm_cocoaDCStack.Erase(ourNode);
+    }
+}
+
+bool wxDC::CocoaUnwindStackAndTakeFocus()
+{
+    wxCocoaDCStack::compatibility_iterator node=sm_cocoaDCStack.GetFirst();
+    for(;node;node = sm_cocoaDCStack.GetFirst())
+    {
+        wxDC *dc = node->GetData();
+        wxASSERT(dc);
+        // If we're on the stack, then it's unwound enough and we have focus
+        if(dc==this)
+            return true;
+        // If unable to unlockFocus (e.g. wxPaintDC) stop here
+        if(!dc->CocoaUnlockFocus())
+            break;
+        sm_cocoaDCStack.Erase(node);
+    }
+    return CocoaLockFocus();
+}
+

 wxDC::wxDC(void)
 {
 wxDC::wxDC(void)
 {

+    m_cocoaWxToBoundsTransform = nil;
+    m_pen = *wxBLACK_PEN;

 }
 
 wxDC::~wxDC(void)
 {
 }
 
 wxDC::~wxDC(void)
 {

+    [m_cocoaWxToBoundsTransform release];
+}
+
+bool wxDC::CocoaLockFocus()
+{
+    return false;
+}
+
+bool wxDC::CocoaUnlockFocus()
+{
+    return false;
+}
+
+/*static*/ WX_NSAffineTransform wxDC::CocoaGetWxToBoundsTransform(bool isFlipped, float height)
+{
+    NSAffineTransform *transform = nil;
+    // This transform flips the graphics since wxDC uses top-left origin
+    if(!isFlipped)
+    {
+        // The transform is auto released
+        transform = [NSAffineTransform transform];
+        /*  x' = 1x + 0y + 0
+            y' = 0x + -1y + window's height
+        */
+        NSAffineTransformStruct matrix = {
+            1,  0
+        ,   0, -1
+        ,   0, height
+        };
+        [transform setTransformStruct: matrix];
+    }
+    return transform;
+}
+
+void wxDC::CocoaApplyTransformations()
+{
+    [m_cocoaWxToBoundsTransform concat];
+    // TODO: Apply device/logical/user position/scaling transformations
+}
+
+void wxDC::CocoaUnapplyTransformations()
+{
+    // NOTE: You *must* call this with focus held.
+    // Undo all transforms so we're back in true Cocoa coords with
+    // no scaling or flipping.
+    NSAffineTransform *invertTransform;
+    invertTransform = [m_cocoaWxToBoundsTransform copy];
+    [invertTransform invert];
+    [invertTransform concat];
+    [invertTransform release];
+}
+
+bool wxDC::CocoaGetBounds(void *rectData)
+{
+    // We don't know what we are so we can't return anything.
+    return false;

 }
 
 void wxDC::DoDrawRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height)
 {
 }
 
 void wxDC::DoDrawRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height)
 {

+    wxAutoNSAutoreleasePool pool;
+    if(!CocoaTakeFocus()) return;

     NSBezierPath *bezpath = [NSBezierPath bezierPathWithRect:NSMakeRect(x,y,width,height)];
     NSBezierPath *bezpath = [NSBezierPath bezierPathWithRect:NSMakeRect(x,y,width,height)];

-    [m_textForegroundColour.GetNSColor() set];
+    CocoaSetPenForNSBezierPath(m_pen,bezpath);

     [bezpath stroke];
     [m_brush.GetNSColor() set];
     [bezpath fill];
     [bezpath stroke];
     [m_brush.GetNSColor() set];
     [bezpath fill];


@@ -76,11 +218,13 @@ void wxDC::DoDrawRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height)
 
 void wxDC::DoDrawLine(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2)
 {
 
 void wxDC::DoDrawLine(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2)
 {

+    wxAutoNSAutoreleasePool pool;
+    if(!CocoaTakeFocus()) return;

     NSBezierPath *bezpath = [NSBezierPath bezierPath];
     [bezpath moveToPoint:NSMakePoint(x1,y1)];
     [bezpath lineToPoint:NSMakePoint(x2,y2)];
 
     NSBezierPath *bezpath = [NSBezierPath bezierPath];
     [bezpath moveToPoint:NSMakePoint(x1,y1)];
     [bezpath lineToPoint:NSMakePoint(x2,y2)];
 

-    [m_textForegroundColour.GetNSColor() set];
+    CocoaSetPenForNSBezierPath(m_pen,bezpath);

     [bezpath stroke];
 }
 
     [bezpath stroke];
 }
 


@@ -88,9 +232,9 @@ void wxDC::DoGetTextExtent(const wxString& text, wxCoord *x, wxCoord *y, wxCoord
 {
     wxAutoNSAutoreleasePool pool;
 // FIXME: Cache this so it can be used for DoDrawText
 {
     wxAutoNSAutoreleasePool pool;
 // FIXME: Cache this so it can be used for DoDrawText

-    wxASSERT_MSG(sm_cocoaNSTextStorage && sm_cocoaNSLayoutManager && sm_cocoaNSTextContainer, "Text system has not been initialized.  BAD PROGRAMMER!");
+    wxASSERT_MSG(sm_cocoaNSTextStorage && sm_cocoaNSLayoutManager && sm_cocoaNSTextContainer, wxT("Text system has not been initialized.  BAD PROGRAMMER!"));

     NSAttributedString *attributedString = [[NSAttributedString alloc]
     NSAttributedString *attributedString = [[NSAttributedString alloc]

-            initWithString:[NSString stringWithCString:text.c_str()]];
+            initWithString:wxNSStringWithWxString(text.c_str())];

     [sm_cocoaNSTextStorage setAttributedString:attributedString];
     [attributedString release];
 
     [sm_cocoaNSTextStorage setAttributedString:attributedString];
     [attributedString release];
 


@@ -108,9 +252,11 @@ void wxDC::DoGetTextExtent(const wxString& text, wxCoord *x, wxCoord *y, wxCoord
 
 void wxDC::DoDrawText(const wxString& text, wxCoord x, wxCoord y)
 {
 
 void wxDC::DoDrawText(const wxString& text, wxCoord x, wxCoord y)
 {

-    wxASSERT_MSG(sm_cocoaNSTextStorage && sm_cocoaNSLayoutManager && sm_cocoaNSTextContainer, "Text system has not been initialized.  BAD PROGRAMMER!");
+    wxAutoNSAutoreleasePool pool;
+    if(!CocoaTakeFocus()) return;
+    wxASSERT_MSG(sm_cocoaNSTextStorage && sm_cocoaNSLayoutManager && sm_cocoaNSTextContainer, wxT("Text system has not been initialized.  BAD PROGRAMMER!"));

     NSAttributedString *attributedString = [[NSAttributedString alloc]
     NSAttributedString *attributedString = [[NSAttributedString alloc]

-            initWithString:[NSString stringWithCString:text.c_str()]];
+            initWithString:wxNSStringWithWxString(text.c_str())];

     [sm_cocoaNSTextStorage setAttributedString:attributedString];
     [attributedString release];
 
     [sm_cocoaNSTextStorage setAttributedString:attributedString];
     [attributedString release];
 


@@ -134,7 +280,7 @@ void wxDC::DoDrawText(const wxString& text, wxCoord x, wxCoord y)
     // there is no length or we don't start at zero
     if(!glyphRange.length)
         return;
     // there is no length or we don't start at zero
     if(!glyphRange.length)
         return;

-    wxASSERT_MSG(glyphRange.location==0,"glyphRange must begin at zero");
+    wxASSERT_MSG(glyphRange.location==0,wxT("glyphRange must begin at zero"));

 
     NSAffineTransform *transform = [NSAffineTransform transform];
     [transform translateXBy:x yBy:y];
 
     NSAffineTransform *transform = [NSAffineTransform transform];
     [transform translateXBy:x yBy:y];


@@ -156,7 +302,7 @@ void wxDC::DoDrawText(const wxString& text, wxCoord x, wxCoord y)
     [flipTransform concat];
     #if 0
     // Draw+fill a rectangle so we can see where the shit is supposed to be.
     [flipTransform concat];
     #if 0
     // Draw+fill a rectangle so we can see where the shit is supposed to be.

-    wxLogDebug("(%f,%f) (%fx%f)",usedRect.origin.x,usedRect.origin.y,usedRect.size.width,usedRect.size.height);
+    wxLogTrace(wxTRACE_COCOA,wxT("(%f,%f) (%fx%f)"),usedRect.origin.x,usedRect.origin.y,usedRect.size.width,usedRect.size.height);

     NSBezierPath *bezpath = [NSBezierPath bezierPathWithRect:NSMakeRect(0,0,usedRect.size.width,usedRect.size.height)];
     [[NSColor blackColor] set];
     [bezpath stroke];
     NSBezierPath *bezpath = [NSBezierPath bezierPathWithRect:NSMakeRect(0,0,usedRect.size.width,usedRect.size.height)];
     [[NSColor blackColor] set];
     [bezpath stroke];


@@ -186,6 +332,16 @@ int wxDCBase::DeviceToLogicalY(int y) const
     return y;
 }
 
     return y;
 }
 

+int wxDCBase::DeviceToLogicalXRel(int x) const
+{
+    return x;
+}
+
+int wxDCBase::DeviceToLogicalYRel(int y) const
+{
+    return y;
+}
+

 int wxDCBase::LogicalToDeviceX(int x) const
 {
     return x;
 int wxDCBase::LogicalToDeviceX(int x) const
 {
     return x;


@@ -196,21 +352,20 @@ int wxDCBase::LogicalToDeviceY(int y) const
     return y;
 }
 
     return y;
 }
 

+int wxDCBase::LogicalToDeviceXRel(int x) const
+{
+    return x;
+}
+
+int wxDCBase::LogicalToDeviceYRel(int y) const
+{
+    return y;
+}
+

 ///////////////////////////////////////////////////////////////////////////
 // cut here, the rest is stubs
 ///////////////////////////////////////////////////////////////////////////
 
 ///////////////////////////////////////////////////////////////////////////
 // cut here, the rest is stubs
 ///////////////////////////////////////////////////////////////////////////
 

-//-----------------------------------------------------------------------------
-// constants
-//-----------------------------------------------------------------------------
-
-#define mm2inches              0.0393700787402
-#define inches2mm              25.4
-#define mm2twips               56.6929133859
-#define twips2mm               0.0176388888889
-#define mm2pt                  2.83464566929
-#define pt2mm                  0.352777777778
-

 //-----------------------------------------------------------------------------
 // wxDC
 //-----------------------------------------------------------------------------
 //-----------------------------------------------------------------------------
 // wxDC
 //-----------------------------------------------------------------------------


@@ -272,6 +427,7 @@ void wxDC::DoDrawArc(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2, wxCoord xc,
     
 void wxDC::SetPen(const wxPen& pen)
 {
     
 void wxDC::SetPen(const wxPen& pen)
 {

+    m_pen = pen;

 }
 
 void wxDC::SetBrush(const wxBrush& brush)
 }
 
 void wxDC::SetBrush(const wxBrush& brush)


@@ -309,12 +465,14 @@ void wxDC::DoDrawEllipse(wxCoord x, wxCoord y, wxCoord width, wxCoord height)
 
 void wxDC::DoDrawBitmap(const wxBitmap &bmp, wxCoord x, wxCoord y, bool useMask)
 {
 
 void wxDC::DoDrawBitmap(const wxBitmap &bmp, wxCoord x, wxCoord y, bool useMask)
 {

+    wxAutoNSAutoreleasePool pool;
+    if(!CocoaTakeFocus()) return;

     if(!bmp.Ok())
         return;
 
 #if 0
     // Draw a rect so we can see where it's supposed to be
     if(!bmp.Ok())
         return;
 
 #if 0
     // Draw a rect so we can see where it's supposed to be

-    wxLogDebug("image at (%d,%d) size %dx%d",x,y,bmp.GetWidth(),bmp.GetHeight());
+    wxLogTrace(wxTRACE_COCOA,wxT("image at (%d,%d) size %dx%d"),x,y,bmp.GetWidth(),bmp.GetHeight());

     NSBezierPath *bezpath = [NSBezierPath bezierPathWithRect:NSMakeRect(x,y,bmp.GetWidth(),bmp.GetHeight())];
     [[NSColor blackColor] set];
     [bezpath stroke];
     NSBezierPath *bezpath = [NSBezierPath bezierPathWithRect:NSMakeRect(x,y,bmp.GetWidth(),bmp.GetHeight())];
     [[NSColor blackColor] set];
     [bezpath stroke];


@@ -341,12 +499,11 @@ void wxDC::DoDrawBitmap(const wxBitmap &bmp, wxCoord x, wxCoord y, bool useMask)
     [transform concat];
     [flipTransform concat];
 
     [transform concat];
     [flipTransform concat];
 

-    NSImage *nsimage = [[NSImage alloc]
-            initWithSize:NSMakeSize(bmp.GetWidth(), bmp.GetHeight())];
-    [nsimage addRepresentation: const_cast<wxBitmap&>(bmp).GetNSBitmapImageRep()];
+    NSImage *nsimage = [bmp.GetNSImage(useMask) retain];
+

     [nsimage drawAtPoint: NSMakePoint(0,0)
         fromRect: NSMakeRect(0.0,0.0,bmp.GetWidth(),bmp.GetHeight())
     [nsimage drawAtPoint: NSMakePoint(0,0)
         fromRect: NSMakeRect(0.0,0.0,bmp.GetWidth(),bmp.GetHeight())

-        operation: NSCompositeCopy
+        operation: NSCompositeSourceOver

         fraction: 1.0];
         
     [nsimage release];
         fraction: 1.0];
         
     [nsimage release];


@@ -364,6 +521,16 @@ void wxDC::DoCrossHair(wxCoord x, wxCoord y)
 
 
 bool wxDC::DoBlit(wxCoord xdest, wxCoord ydest, wxCoord width, wxCoord height, wxDC *source, wxCoord xsrc, wxCoord ysrc, int rop, bool useMask , wxCoord xsrcMask, wxCoord ysrcMask)
 
 
 bool wxDC::DoBlit(wxCoord xdest, wxCoord ydest, wxCoord width, wxCoord height, wxDC *source, wxCoord xsrc, wxCoord ysrc, int rop, bool useMask , wxCoord xsrcMask, wxCoord ysrcMask)

+{
+    if(!CocoaTakeFocus()) return false;
+    if(!source) return false;
+    return source->CocoaDoBlitOnFocusedDC(xdest,ydest,width,height,
+        xsrc, ysrc, rop, useMask, xsrcMask, ysrcMask);
+}
+
+bool wxDC::CocoaDoBlitOnFocusedDC(wxCoord xdest, wxCoord ydest,
+    wxCoord width, wxCoord height, wxCoord xsrc, wxCoord ysrc,
+    int logicalFunc, bool useMask, wxCoord xsrcMask, wxCoord ysrcMask)

 {
     return false;
 }
 {
     return false;
 }


@@ -395,6 +562,22 @@ void wxDC::SetTextBackground( const wxColour &col )
 
 void wxDC::Clear()
 {
 
 void wxDC::Clear()
 {

+    if(!CocoaTakeFocus()) return;
+
+    NSRect boundsRect;
+    if(!CocoaGetBounds(&boundsRect)) return;
+
+    NSGraphicsContext *context = [NSGraphicsContext currentContext];
+    [context saveGraphicsState];
+
+    // Undo all transforms so when we draw our bounds rect we
+    // really overwrite our bounds rect.
+    CocoaUnapplyTransformations();
+
+    [m_backgroundBrush.GetNSColor() set];
+    [NSBezierPath fillRect:boundsRect];
+
+    [context restoreGraphicsState];

 }
 
 void wxDC::SetBackground(const wxBrush& brush)
 }
 
 void wxDC::SetBackground(const wxBrush& brush)


@@ -482,7 +665,7 @@ void wxDC::ComputeScaleAndOrigin(void)
   {
     // this is a bit artificial, but we need to force wxDC to think
     // the pen has changed
   {
     // this is a bit artificial, but we need to force wxDC to think
     // the pen has changed

-    wxPen* pen = & GetPen();
+    const wxPen* pen = & GetPen();

     wxPen tempPen;
     m_pen = tempPen;
     SetPen(* pen);
     wxPen tempPen;
     m_pen = tempPen;
     SetPen(* pen);