1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/osx/carbon/utils.mm
3 // Purpose: various cocoa mixin utility functions
4 // Author: Stefan Csomor
7 // RCS-ID: $Id: utilscocoa.mm 48805 2007-09-19 14:52:25Z SC $
8 // Copyright: (c) Stefan Csomor
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 #include "wx/wxprec.h"
14 #if wxOSX_USE_COCOA_OR_CARBON
15 #include <Cocoa/Cocoa.h>
17 #import <UIKit/UIKit.h>
21 #include "wx/osx/private.h"
24 #include "wx/fontutil.h"
27 #include "wx/cocoa/string.h"
35 bool cocoaLoaded = NSApplicationLoad();
36 wxASSERT_MSG(cocoaLoaded,wxT("Couldn't load Cocoa in Carbon Environment")) ;
41 wxMacAutoreleasePool::wxMacAutoreleasePool()
43 m_pool = [[NSAutoreleasePool alloc] init];
46 wxMacAutoreleasePool::~wxMacAutoreleasePool()
48 [(NSAutoreleasePool*)m_pool release];
55 CGContextRef wxOSXGetContextFromCurrentContext()
57 CGContextRef context = (CGContextRef)[[NSGraphicsContext currentContext]
62 bool wxOSXLockFocus( WXWidget view)
64 return [view lockFocusIfCanDraw];
67 void wxOSXUnlockFocus( WXWidget view)
76 CGContextRef wxOSXGetContextFromCurrentContext()
78 CGContextRef context = UIGraphicsGetCurrentContext();
84 // ----------------------------------------------------------------------------
86 // ----------------------------------------------------------------------------
88 void wxMacCocoaRelease( void* obj )
90 [(NSObject*)obj release];
93 void wxMacCocoaAutorelease( void* obj )
95 [(NSObject*)obj autorelease];
98 void* wxMacCocoaRetain( void* obj )
100 [(NSObject*)obj retain];
104 // ----------------------------------------------------------------------------
106 // ----------------------------------------------------------------------------
109 wxFont::wxFont(WX_NSFont nsfont)
112 wxNativeFontInfo info;
113 SetNativeInfoFromNSFont(nsfont, &info);
117 void wxFont::SetNativeInfoFromNSFont(WX_NSFont theFont, wxNativeFontInfo* info)
119 if ( info->m_faceName.empty())
121 //Get more information about the user's chosen font
122 NSFontTraitMask theTraits = [[NSFontManager sharedFontManager] traitsOfFont:theFont];
123 int theFontWeight = [[NSFontManager sharedFontManager] weightOfFont:theFont];
125 wxFontFamily fontFamily = wxFONTFAMILY_DEFAULT;
126 //Set the wx font to the appropriate data
127 if(theTraits & NSFixedPitchFontMask)
128 fontFamily = wxFONTFAMILY_TELETYPE;
130 wxFontStyle fontstyle = wxFONTSTYLE_NORMAL;
131 wxFontWeight fontweight = wxFONTWEIGHT_NORMAL;
132 bool underlined = false;
134 int size = (int) ([theFont pointSize]+0.5);
136 if ( theFontWeight >= 9 )
137 fontweight = wxFONTWEIGHT_BOLD ;
138 else if ( theFontWeight < 5 )
139 fontweight = wxFONTWEIGHT_LIGHT;
141 fontweight = wxFONTWEIGHT_NORMAL ;
143 if ( theTraits & NSItalicFontMask )
144 fontstyle = wxFONTSTYLE_ITALIC ;
146 info->Init(size,fontFamily,fontstyle,fontweight,underlined,
147 wxStringWithNSString([theFont familyName]), wxFONTENCODING_DEFAULT);
152 WX_NSFont wxFont::OSXCreateNSFont(wxOSXSystemFont font, wxNativeFontInfo* info)
154 NSFont* nsfont = nil;
157 case wxOSX_SYSTEM_FONT_NORMAL:
158 nsfont = [NSFont systemFontOfSize:[NSFont systemFontSize]];
160 case wxOSX_SYSTEM_FONT_BOLD:
161 nsfont = [NSFont boldSystemFontOfSize:[NSFont systemFontSize]];
163 case wxOSX_SYSTEM_FONT_SMALL:
164 nsfont = [NSFont systemFontOfSize:[NSFont smallSystemFontSize]];
166 case wxOSX_SYSTEM_FONT_SMALL_BOLD:
167 nsfont = [NSFont boldSystemFontOfSize:[NSFont smallSystemFontSize]];
169 case wxOSX_SYSTEM_FONT_MINI:
170 nsfont = [NSFont systemFontOfSize:
171 [NSFont systemFontSizeForControlSize:NSMiniControlSize]];
173 case wxOSX_SYSTEM_FONT_MINI_BOLD:
174 nsfont = [NSFont boldSystemFontOfSize:
175 [NSFont systemFontSizeForControlSize:NSMiniControlSize]];
177 case wxOSX_SYSTEM_FONT_LABELS:
178 nsfont = [NSFont labelFontOfSize:[NSFont labelFontSize]];
180 case wxOSX_SYSTEM_FONT_VIEWS:
181 nsfont = [NSFont controlContentFontOfSize:0];
187 SetNativeInfoFromNSFont(nsfont, info);
191 static inline double DegToRad(double deg) { return (deg * M_PI) / 180.0; }
192 static const NSAffineTransformStruct kSlantNSTransformStruct = { 1, 0, tan(DegToRad(11)), 1, 0, 0 };
194 WX_NSFont wxFont::OSXCreateNSFont(const wxNativeFontInfo* info)
198 NSFontTraitMask traits = 0;
199 if (info->m_weight == wxFONTWEIGHT_BOLD)
201 traits |= NSBoldFontMask;
204 else if (info->m_weight == wxFONTWEIGHT_LIGHT)
207 if (info->m_style == wxFONTSTYLE_ITALIC || info->m_style == wxFONTSTYLE_SLANT)
208 traits |= NSItalicFontMask;
210 nsFont = [[NSFontManager sharedFontManager] fontWithFamily:wxCFStringRef(info->m_faceName).AsNSString()
211 traits:traits weight:weight size:info->m_pointSize];
215 NSFontTraitMask remainingTraits = traits;
216 nsFont = [[NSFontManager sharedFontManager] fontWithFamily:wxCFStringRef(info->m_faceName).AsNSString()
217 traits:0 weight:5 size:info->m_pointSize];
220 if ( info->m_weight == wxFONTWEIGHT_BOLD )
222 nsFont = [NSFont boldSystemFontOfSize:info->m_pointSize];
223 remainingTraits &= ~NSBoldFontMask;
226 nsFont = [NSFont systemFontOfSize:info->m_pointSize];
229 // fallback - if in doubt, let go of the bold attribute
230 if ( nsFont && (remainingTraits & NSItalicFontMask) )
232 NSFont* nsFontWithTraits = nil;
233 if ( remainingTraits & NSBoldFontMask)
235 nsFontWithTraits = [[NSFontManager sharedFontManager] convertFont:nsFont toHaveTrait:NSBoldFontMask];
236 if ( nsFontWithTraits == nil )
238 nsFontWithTraits = [[NSFontManager sharedFontManager] convertFont:nsFont toHaveTrait:NSItalicFontMask];
239 if ( nsFontWithTraits != nil )
240 remainingTraits &= ~NSItalicFontMask;
244 remainingTraits &= ~NSBoldFontMask;
247 // the code below causes crashes, because fontDescriptorWithMatrix is not returning a valid font descriptor
248 // it adds a NSCTFontMatrixAttribute as well which cannot be disposed of correctly by the autorelease pool
249 // so at the moment we have to disable this and cannot synthesize italic fonts if they are not available on the system
251 if ( remainingTraits & NSItalicFontMask )
253 if ( nsFontWithTraits == nil )
254 nsFontWithTraits = nsFont;
256 NSAffineTransform* transform = [NSAffineTransform transform];
257 [transform setTransformStruct:kSlantNSTransformStruct];
258 [transform scaleBy:info->m_pointSize];
259 NSFontDescriptor* italicDesc = [[nsFontWithTraits fontDescriptor] fontDescriptorWithMatrix:transform];
260 if ( italicDesc != nil )
262 NSFont* f = [NSFont fontWithDescriptor:italicDesc size:(CGFloat)(info->m_pointSize)];
264 nsFontWithTraits = f;
268 if ( nsFontWithTraits != nil )
269 nsFont = nsFontWithTraits;
273 wxASSERT_MSG(nsFont != nil,wxT("Couldn't create nsFont")) ;
274 wxMacCocoaRetain(nsFont);
282 WX_UIFont wxFont::OSXCreateUIFont(wxOSXSystemFont font, wxNativeFontInfo* info)
287 case wxOSX_SYSTEM_FONT_NORMAL:
288 uifont = [UIFont systemFontOfSize:[UIFont systemFontSize]];
290 case wxOSX_SYSTEM_FONT_BOLD:
291 uifont = [UIFont boldSystemFontOfSize:[UIFont systemFontSize]];
293 case wxOSX_SYSTEM_FONT_MINI:
294 case wxOSX_SYSTEM_FONT_SMALL:
295 uifont = [UIFont systemFontOfSize:[UIFont smallSystemFontSize]];
297 case wxOSX_SYSTEM_FONT_MINI_BOLD:
298 case wxOSX_SYSTEM_FONT_SMALL_BOLD:
299 uifont = [UIFont boldSystemFontOfSize:[UIFont smallSystemFontSize]];
301 case wxOSX_SYSTEM_FONT_VIEWS:
302 case wxOSX_SYSTEM_FONT_LABELS:
303 uifont = [UIFont systemFontOfSize:[UIFont labelFontSize]];
309 if ( info->m_faceName.empty())
311 wxFontStyle fontstyle = wxFONTSTYLE_NORMAL;
312 wxFontWeight fontweight = wxFONTWEIGHT_NORMAL;
313 bool underlined = false;
315 int size = (int) ([uifont pointSize]+0.5);
317 NSFontSymbolicTraits traits = [desc symbolicTraits];
319 if ( traits & NSFontBoldTrait )
320 fontweight = wxFONTWEIGHT_BOLD ;
322 fontweight = wxFONTWEIGHT_NORMAL ;
323 if ( traits & NSFontItalicTrait )
324 fontstyle = wxFONTSTYLE_ITALIC ;
326 wxCFStringRef fontname( wxCFRetain([uifont familyName]) );
327 info->Init(size,wxFONTFAMILY_DEFAULT,fontstyle,fontweight,underlined,
328 fontname.AsString(), wxFONTENCODING_DEFAULT);
334 WX_UIFont wxFont::OSXCreateUIFont(const wxNativeFontInfo* info)
337 uiFont = [UIFont fontWithName:wxCFStringRef(info->m_faceName).AsNSString() size:info->m_pointSize];
338 wxMacCocoaRetain(uiFont);
343 // ----------------------------------------------------------------------------
345 // ----------------------------------------------------------------------------
349 WX_UIImage wxOSXGetUIImageFromCGImage( CGImageRef image )
351 UIImage *newImage = [UIImage imageWithCGImage:image];
352 [newImage autorelease];
356 wxBitmap wxOSXCreateSystemBitmap(const wxString& name, const wxString &client, const wxSize& size)
359 // unfortunately this only accesses images in the app bundle, not the system wide globals
360 wxCFStringRef cfname(name);
361 return wxBitmap( [[UIImage imageNamed:cfname.AsNSString()] CGImage] );
371 wxBitmap wxOSXCreateSystemBitmap(const wxString& name, const wxString &client, const wxSize& size)
373 wxCFStringRef cfname(name);
374 wxCFRef<CGImageRef> image( wxOSXCreateCGImageFromNSImage([NSImage imageNamed:cfname.AsNSString()]) );
375 return wxBitmap( image );
378 // From "Cocoa Drawing Guide:Working with Images"
379 WX_NSImage wxOSXGetNSImageFromCGImage( CGImageRef image )
381 NSRect imageRect = NSMakeRect(0.0, 0.0, 0.0, 0.0);
383 // Get the image dimensions.
384 imageRect.size.height = CGImageGetHeight(image);
385 imageRect.size.width = CGImageGetWidth(image);
387 // Create a new image to receive the Quartz image data.
388 NSImage *newImage = [[NSImage alloc] initWithSize:imageRect.size];
389 [newImage lockFocus];
391 // Get the Quartz context and draw.
392 CGContextRef imageContext = (CGContextRef) [[NSGraphicsContext currentContext] graphicsPort];
393 CGContextDrawImage( imageContext, *(CGRect*)&imageRect, image );
394 [newImage unlockFocus];
397 // Create a bitmap rep from the image...
398 NSBitmapImageRep *bitmapRep = [[NSBitmapImageRep alloc] initWithCGImage:cgImage];
399 // Create an NSImage and add the bitmap rep to it...
400 NSImage *image = [[NSImage alloc] init];
401 [image addRepresentation:bitmapRep];
404 [newImage autorelease];
408 CGImageRef wxOSXCreateCGImageFromNSImage( WX_NSImage nsimage )
410 // based on http://www.mail-archive.com/cocoa-dev@lists.apple.com/msg18065.html
412 NSSize imageSize = [nsimage size];
413 CGColorSpaceRef genericRGB = CGColorSpaceCreateWithName(kCGColorSpaceGenericRGB);
414 CGContextRef context = CGBitmapContextCreate(NULL, imageSize.width, imageSize.height, 8, 0, genericRGB, kCGImageAlphaPremultipliedFirst);
415 NSGraphicsContext *nsGraphicsContext = [NSGraphicsContext graphicsContextWithGraphicsPort:context flipped:NO];
416 [NSGraphicsContext saveGraphicsState];
417 [NSGraphicsContext setCurrentContext:nsGraphicsContext];
418 [[NSColor whiteColor] setFill];
419 NSRectFill(NSMakeRect(0.0, 0.0, imageSize.width, imageSize.height));
420 [nsimage drawAtPoint:NSZeroPoint fromRect:NSZeroRect operation:NSCompositeCopy fraction:1.0];
421 [NSGraphicsContext setCurrentContext:nsGraphicsContext];
422 CGImageRef image = CGBitmapContextCreateImage(context);
427 // ----------------------------------------------------------------------------
429 // ----------------------------------------------------------------------------
431 // copied from cursor.mm
433 static NSCursor* wxGetStockCursor( short sIndex )
435 ClassicCursor* pCursor = &gMacCursors[sIndex];
437 //Classic mac cursors are 1bps 16x16 black and white with a
438 //identical mask that is 1 for on and 0 for off
439 NSImage *theImage = [[NSImage alloc] initWithSize:NSMakeSize(16.0,16.0)];
441 //NSCursor takes an NSImage takes a number of Representations - here
442 //we need only one for the raw data
443 NSBitmapImageRep *theRep = [[NSBitmapImageRep alloc]
444 initWithBitmapDataPlanes: NULL // Tell Cocoa to allocate the planes for us.
445 pixelsWide: 16 // All classic cursors are 16x16
447 bitsPerSample: 1 // All classic cursors are bitmaps with bitmasks
448 samplesPerPixel: 2 // Sample 0:image 1:mask
449 hasAlpha: YES // Identify last sample as a mask
450 isPlanar: YES // Use a separate array for each sample
451 colorSpaceName: NSCalibratedWhiteColorSpace // 0.0=black 1.0=white
452 bytesPerRow: 2 // Rows in each plane are on 2-byte boundaries (no pad)
453 bitsPerPixel: 1]; // same as bitsPerSample since data is planar
455 // Ensure that Cocoa allocated 2 and only 2 of the 5 possible planes
456 unsigned char *planes[5];
457 [theRep getBitmapDataPlanes:planes];
458 wxASSERT(planes[0] != NULL);
459 wxASSERT(planes[1] != NULL);
460 wxASSERT(planes[2] == NULL);
461 wxASSERT(planes[3] == NULL);
462 wxASSERT(planes[4] == NULL);
464 // NOTE1: The Cursor's bits field is white=0 black=1.. thus the bitwise-not
465 // Why not use NSCalibratedBlackColorSpace? Because that reverses the
466 // sense of the alpha (mask) plane.
467 // NOTE2: The mask data is 0=off 1=on
468 // NOTE3: Cocoa asks for "premultiplied" color planes. Since we have a
469 // 1-bit color plane and a 1-bit alpha plane we can just do a bitwise-and
470 // on the two. The original cursor bitmaps have 0 (white actually) for
471 // any masked-off pixels. Therefore every masked-off pixel would be wrong
472 // since we bit-flip all of the picture bits. In practice, Cocoa doesn't
473 // seem to care, but we are following the documentation.
475 // Fill in the color (black/white) plane
476 for(int i=0; i<16; ++i)
478 planes[0][2*i ] = (~pCursor->bits[i] & pCursor->mask[i]) >> 8 & 0xff;
479 planes[0][2*i+1] = (~pCursor->bits[i] & pCursor->mask[i]) & 0xff;
481 // Fill in the alpha (i.e. mask) plane
482 for(int i=0; i<16; ++i)
484 planes[1][2*i ] = pCursor->mask[i] >> 8 & 0xff;
485 planes[1][2*i+1] = pCursor->mask[i] & 0xff;
488 //add the representation (data) to the image
489 [theImage addRepresentation:theRep];
491 //create the new cursor
492 NSCursor* theCursor = [[NSCursor alloc] initWithImage:theImage
493 hotSpot:NSMakePoint(pCursor->hotspot[1], pCursor->hotspot[0])
496 //do the usual cleanups
500 //return the new cursor
504 WX_NSCursor wxMacCocoaCreateStockCursor( int cursor_type )
506 WX_NSCursor cursor = nil;
509 case wxCURSOR_COPY_ARROW:
510 cursor = [[NSCursor arrowCursor] retain];
515 // should be displayed by the system when things are running
516 cursor = [[NSCursor arrowCursor] retain];
520 cursor = [[NSCursor IBeamCursor] retain];
524 cursor = [[NSCursor crosshairCursor] retain];
527 case wxCURSOR_SIZENWSE:
528 cursor = wxGetStockCursor(kwxCursorSizeNWSE);
531 case wxCURSOR_SIZENESW:
532 cursor = wxGetStockCursor(kwxCursorSizeNESW);
535 case wxCURSOR_SIZEWE:
536 cursor = [[NSCursor resizeLeftRightCursor] retain];
539 case wxCURSOR_SIZENS:
540 cursor = [[NSCursor resizeUpDownCursor] retain];
543 case wxCURSOR_SIZING:
544 cursor = wxGetStockCursor(kwxCursorSize);
548 cursor = [[NSCursor pointingHandCursor] retain];
551 case wxCURSOR_BULLSEYE:
552 cursor = wxGetStockCursor(kwxCursorBullseye);
555 case wxCURSOR_PENCIL:
556 cursor = wxGetStockCursor(kwxCursorPencil);
559 case wxCURSOR_MAGNIFIER:
560 cursor = wxGetStockCursor(kwxCursorMagnifier);
563 case wxCURSOR_NO_ENTRY:
564 cursor = wxGetStockCursor(kwxCursorNoEntry);
567 case wxCURSOR_PAINT_BRUSH:
568 cursor = wxGetStockCursor(kwxCursorPaintBrush);
571 case wxCURSOR_POINT_LEFT:
572 cursor = wxGetStockCursor(kwxCursorPointLeft);
575 case wxCURSOR_POINT_RIGHT:
576 cursor = wxGetStockCursor(kwxCursorPointRight);
579 case wxCURSOR_QUESTION_ARROW:
580 cursor = wxGetStockCursor(kwxCursorQuestionArrow);
584 cursor = wxGetStockCursor(kwxCursorBlank);
587 case wxCURSOR_RIGHT_ARROW:
588 cursor = wxGetStockCursor(kwxCursorRightArrow);
591 case wxCURSOR_SPRAYCAN:
592 cursor = wxGetStockCursor(kwxCursorRoller);
595 case wxCURSOR_OPEN_HAND:
596 cursor = [[NSCursor openHandCursor] retain];
599 case wxCURSOR_CLOSED_HAND:
600 cursor = [[NSCursor closedHandCursor] retain];
605 case wxCURSOR_LEFT_BUTTON:
606 case wxCURSOR_RIGHT_BUTTON:
607 case wxCURSOR_MIDDLE_BUTTON:
609 cursor = [[NSCursor arrowCursor] retain];
615 // C-based style wrapper routines around NSCursor
616 WX_NSCursor wxMacCocoaCreateCursorFromCGImage( CGImageRef cgImageRef, float hotSpotX, float hotSpotY )
618 static BOOL firstTime = YES;
622 // Must first call [[[NSWindow alloc] init] release] to get the NSWindow machinery set up so that NSCursor can use a window to cache the cursor image
623 [[[NSWindow alloc] init] release];
627 NSImage *nsImage = wxOSXGetNSImageFromCGImage( cgImageRef );
628 NSCursor *cursor = [[NSCursor alloc] initWithImage:nsImage hotSpot:NSMakePoint( hotSpotX, hotSpotY )];
633 void wxMacCocoaSetCursor( WX_NSCursor cursor )
638 void wxMacCocoaHideCursor()
643 void wxMacCocoaShowCursor()