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 if ( remainingTraits & NSItalicFontMask)
249 if ( nsFontWithTraits == nil )
250 nsFontWithTraits = nsFont;
252 NSAffineTransform* transform = [NSAffineTransform transform];
253 [transform setTransformStruct:kSlantNSTransformStruct];
254 [transform scaleBy:info->m_pointSize];
255 NSFontDescriptor* italicDesc = [[nsFontWithTraits fontDescriptor] fontDescriptorWithMatrix:transform];
256 if ( italicDesc != nil )
258 NSFont* f = [NSFont fontWithDescriptor:italicDesc size:(CGFloat)(info->m_pointSize)];
260 nsFontWithTraits = f;
263 if ( nsFontWithTraits != nil )
264 nsFont = nsFontWithTraits;
268 wxASSERT_MSG(nsFont != nil,wxT("Couldn't create nsFont")) ;
269 wxMacCocoaRetain(nsFont);
277 WX_UIFont wxFont::OSXCreateUIFont(wxOSXSystemFont font, wxNativeFontInfo* info)
282 case wxOSX_SYSTEM_FONT_NORMAL:
283 uifont = [UIFont systemFontOfSize:[UIFont systemFontSize]];
285 case wxOSX_SYSTEM_FONT_BOLD:
286 uifont = [UIFont boldSystemFontOfSize:[UIFont systemFontSize]];
288 case wxOSX_SYSTEM_FONT_MINI:
289 case wxOSX_SYSTEM_FONT_SMALL:
290 uifont = [UIFont systemFontOfSize:[UIFont smallSystemFontSize]];
292 case wxOSX_SYSTEM_FONT_MINI_BOLD:
293 case wxOSX_SYSTEM_FONT_SMALL_BOLD:
294 uifont = [UIFont boldSystemFontOfSize:[UIFont smallSystemFontSize]];
296 case wxOSX_SYSTEM_FONT_VIEWS:
297 case wxOSX_SYSTEM_FONT_LABELS:
298 uifont = [UIFont systemFontOfSize:[UIFont labelFontSize]];
304 if ( info->m_faceName.empty())
306 wxFontStyle fontstyle = wxFONTSTYLE_NORMAL;
307 wxFontWeight fontweight = wxFONTWEIGHT_NORMAL;
308 bool underlined = false;
310 int size = (int) ([uifont pointSize]+0.5);
312 NSFontSymbolicTraits traits = [desc symbolicTraits];
314 if ( traits & NSFontBoldTrait )
315 fontweight = wxFONTWEIGHT_BOLD ;
317 fontweight = wxFONTWEIGHT_NORMAL ;
318 if ( traits & NSFontItalicTrait )
319 fontstyle = wxFONTSTYLE_ITALIC ;
321 wxCFStringRef fontname( wxCFRetain([uifont familyName]) );
322 info->Init(size,wxFONTFAMILY_DEFAULT,fontstyle,fontweight,underlined,
323 fontname.AsString(), wxFONTENCODING_DEFAULT);
329 WX_UIFont wxFont::OSXCreateUIFont(const wxNativeFontInfo* info)
332 uiFont = [UIFont fontWithName:wxCFStringRef(info->m_faceName).AsNSString() size:info->m_pointSize];
333 wxMacCocoaRetain(uiFont);
338 // ----------------------------------------------------------------------------
340 // ----------------------------------------------------------------------------
344 WX_UIImage wxOSXGetUIImageFromCGImage( CGImageRef image )
346 UIImage *newImage = [UIImage imageWithCGImage:image];
347 [newImage autorelease];
355 // From "Cocoa Drawing Guide:Working with Images"
356 WX_NSImage wxOSXGetNSImageFromCGImage( CGImageRef image )
358 NSRect imageRect = NSMakeRect(0.0, 0.0, 0.0, 0.0);
360 // Get the image dimensions.
361 imageRect.size.height = CGImageGetHeight(image);
362 imageRect.size.width = CGImageGetWidth(image);
364 // Create a new image to receive the Quartz image data.
365 NSImage *newImage = [[NSImage alloc] initWithSize:imageRect.size];
366 [newImage lockFocus];
368 // Get the Quartz context and draw.
369 CGContextRef imageContext = (CGContextRef) [[NSGraphicsContext currentContext] graphicsPort];
370 CGContextDrawImage( imageContext, *(CGRect*)&imageRect, image );
371 [newImage unlockFocus];
374 // Create a bitmap rep from the image...
375 NSBitmapImageRep *bitmapRep = [[NSBitmapImageRep alloc] initWithCGImage:cgImage];
376 // Create an NSImage and add the bitmap rep to it...
377 NSImage *image = [[NSImage alloc] init];
378 [image addRepresentation:bitmapRep];
381 [newImage autorelease];
385 CGImageRef wxOSXCreateCGImageFromNSImage( WX_NSImage nsimage )
387 // based on http://www.mail-archive.com/cocoa-dev@lists.apple.com/msg18065.html
389 NSSize imageSize = [nsimage size];
390 CGColorSpaceRef genericRGB = CGColorSpaceCreateWithName(kCGColorSpaceGenericRGB);
391 CGContextRef context = CGBitmapContextCreate(NULL, imageSize.width, imageSize.height, 8, 0, genericRGB, kCGImageAlphaPremultipliedFirst);
392 NSGraphicsContext *nsGraphicsContext = [NSGraphicsContext graphicsContextWithGraphicsPort:context flipped:NO];
393 [NSGraphicsContext saveGraphicsState];
394 [NSGraphicsContext setCurrentContext:nsGraphicsContext];
395 [[NSColor whiteColor] setFill];
396 NSRectFill(NSMakeRect(0.0, 0.0, imageSize.width, imageSize.height));
397 [nsimage drawAtPoint:NSZeroPoint fromRect:NSZeroRect operation:NSCompositeCopy fraction:1.0];
398 [NSGraphicsContext setCurrentContext:nsGraphicsContext];
399 CGImageRef image = CGBitmapContextCreateImage(context);
404 // ----------------------------------------------------------------------------
406 // ----------------------------------------------------------------------------
408 // copied from cursor.mm
410 static NSCursor* wxGetStockCursor( short sIndex )
412 ClassicCursor* pCursor = &gMacCursors[sIndex];
414 //Classic mac cursors are 1bps 16x16 black and white with a
415 //identical mask that is 1 for on and 0 for off
416 NSImage *theImage = [[NSImage alloc] initWithSize:NSMakeSize(16.0,16.0)];
418 //NSCursor takes an NSImage takes a number of Representations - here
419 //we need only one for the raw data
420 NSBitmapImageRep *theRep = [[NSBitmapImageRep alloc]
421 initWithBitmapDataPlanes: NULL // Tell Cocoa to allocate the planes for us.
422 pixelsWide: 16 // All classic cursors are 16x16
424 bitsPerSample: 1 // All classic cursors are bitmaps with bitmasks
425 samplesPerPixel: 2 // Sample 0:image 1:mask
426 hasAlpha: YES // Identify last sample as a mask
427 isPlanar: YES // Use a separate array for each sample
428 colorSpaceName: NSCalibratedWhiteColorSpace // 0.0=black 1.0=white
429 bytesPerRow: 2 // Rows in each plane are on 2-byte boundaries (no pad)
430 bitsPerPixel: 1]; // same as bitsPerSample since data is planar
432 // Ensure that Cocoa allocated 2 and only 2 of the 5 possible planes
433 unsigned char *planes[5];
434 [theRep getBitmapDataPlanes:planes];
435 wxASSERT(planes[0] != NULL);
436 wxASSERT(planes[1] != NULL);
437 wxASSERT(planes[2] == NULL);
438 wxASSERT(planes[3] == NULL);
439 wxASSERT(planes[4] == NULL);
441 // NOTE1: The Cursor's bits field is white=0 black=1.. thus the bitwise-not
442 // Why not use NSCalibratedBlackColorSpace? Because that reverses the
443 // sense of the alpha (mask) plane.
444 // NOTE2: The mask data is 0=off 1=on
445 // NOTE3: Cocoa asks for "premultiplied" color planes. Since we have a
446 // 1-bit color plane and a 1-bit alpha plane we can just do a bitwise-and
447 // on the two. The original cursor bitmaps have 0 (white actually) for
448 // any masked-off pixels. Therefore every masked-off pixel would be wrong
449 // since we bit-flip all of the picture bits. In practice, Cocoa doesn't
450 // seem to care, but we are following the documentation.
452 // Fill in the color (black/white) plane
453 for(int i=0; i<16; ++i)
455 planes[0][2*i ] = (~pCursor->bits[i] & pCursor->mask[i]) >> 8 & 0xff;
456 planes[0][2*i+1] = (~pCursor->bits[i] & pCursor->mask[i]) & 0xff;
458 // Fill in the alpha (i.e. mask) plane
459 for(int i=0; i<16; ++i)
461 planes[1][2*i ] = pCursor->mask[i] >> 8 & 0xff;
462 planes[1][2*i+1] = pCursor->mask[i] & 0xff;
465 //add the representation (data) to the image
466 [theImage addRepresentation:theRep];
468 //create the new cursor
469 NSCursor* theCursor = [[NSCursor alloc] initWithImage:theImage
470 hotSpot:NSMakePoint(pCursor->hotspot[1], pCursor->hotspot[0])
473 //do the usual cleanups
477 //return the new cursor
481 WX_NSCursor wxMacCocoaCreateStockCursor( int cursor_type )
483 WX_NSCursor cursor = nil;
486 case wxCURSOR_COPY_ARROW:
487 cursor = [[NSCursor arrowCursor] retain];
492 // should be displayed by the system when things are running
493 cursor = [[NSCursor arrowCursor] retain];
497 cursor = [[NSCursor IBeamCursor] retain];
501 cursor = [[NSCursor crosshairCursor] retain];
504 case wxCURSOR_SIZENWSE:
505 cursor = wxGetStockCursor(kwxCursorSizeNWSE);
508 case wxCURSOR_SIZENESW:
509 cursor = wxGetStockCursor(kwxCursorSizeNESW);
512 case wxCURSOR_SIZEWE:
513 cursor = [[NSCursor resizeLeftRightCursor] retain];
516 case wxCURSOR_SIZENS:
517 cursor = [[NSCursor resizeUpDownCursor] retain];
520 case wxCURSOR_SIZING:
521 cursor = wxGetStockCursor(kwxCursorSize);
525 cursor = [[NSCursor pointingHandCursor] retain];
528 case wxCURSOR_BULLSEYE:
529 cursor = wxGetStockCursor(kwxCursorBullseye);
532 case wxCURSOR_PENCIL:
533 cursor = wxGetStockCursor(kwxCursorPencil);
536 case wxCURSOR_MAGNIFIER:
537 cursor = wxGetStockCursor(kwxCursorMagnifier);
540 case wxCURSOR_NO_ENTRY:
541 cursor = wxGetStockCursor(kwxCursorNoEntry);
544 case wxCURSOR_PAINT_BRUSH:
545 cursor = wxGetStockCursor(kwxCursorPaintBrush);
548 case wxCURSOR_POINT_LEFT:
549 cursor = wxGetStockCursor(kwxCursorPointLeft);
552 case wxCURSOR_POINT_RIGHT:
553 cursor = wxGetStockCursor(kwxCursorPointRight);
556 case wxCURSOR_QUESTION_ARROW:
557 cursor = wxGetStockCursor(kwxCursorQuestionArrow);
561 cursor = wxGetStockCursor(kwxCursorBlank);
564 case wxCURSOR_RIGHT_ARROW:
565 cursor = wxGetStockCursor(kwxCursorRightArrow);
568 case wxCURSOR_SPRAYCAN:
569 cursor = wxGetStockCursor(kwxCursorRoller);
572 case wxCURSOR_OPEN_HAND:
573 cursor = [[NSCursor openHandCursor] retain];
576 case wxCURSOR_CLOSED_HAND:
577 cursor = [[NSCursor closedHandCursor] retain];
582 case wxCURSOR_LEFT_BUTTON:
583 case wxCURSOR_RIGHT_BUTTON:
584 case wxCURSOR_MIDDLE_BUTTON:
586 cursor = [[NSCursor arrowCursor] retain];
592 // C-based style wrapper routines around NSCursor
593 WX_NSCursor wxMacCocoaCreateCursorFromCGImage( CGImageRef cgImageRef, float hotSpotX, float hotSpotY )
595 static BOOL firstTime = YES;
599 // 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
600 [[[NSWindow alloc] init] release];
604 NSImage *nsImage = wxOSXGetNSImageFromCGImage( cgImageRef );
605 NSCursor *cursor = [[NSCursor alloc] initWithImage:nsImage hotSpot:NSMakePoint( hotSpotX, hotSpotY )];
610 void wxMacCocoaSetCursor( WX_NSCursor cursor )
615 void wxMacCocoaHideCursor()
620 void wxMacCocoaShowCursor()