1 /* 2 * Copyright (c) 2011, 2013, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 #import <JavaNativeFoundation/JavaNativeFoundation.h> 27 28 #import "CMenuItem.h" 29 #import "CMenu.h" 30 #import "AWTEvent.h" 31 #import "ThreadUtilities.h" 32 33 #import "java_awt_Event.h" 34 #import "java_awt_event_KeyEvent.h" 35 #import "sun_lwawt_macosx_CMenuItem.h" 36 37 #define NOT_A_CHECKBOXMENU -2 38 39 40 @implementation CMenuItem 41 42 - (id) initWithPeer:(jobject)peer asSeparator: (NSNumber *) asSeparator{ 43 AWT_ASSERT_APPKIT_THREAD; 44 self = [super initWithPeer:peer]; 45 if (self) { 46 if ([asSeparator boolValue]) { 47 fMenuItem = (NSMenuItem*)[NSMenuItem separatorItem]; 48 [fMenuItem retain]; 49 } else { 50 fMenuItem = [[NSMenuItem alloc] init]; 51 [fMenuItem setAction:@selector(handleAction:)]; 52 [fMenuItem setTarget:self]; 53 } 54 fIsCheckbox = NO; 55 fIsEnabled = YES; 56 } 57 return self; 58 } 59 60 // This is because NSApplication doesn't check the target's window when sending 61 // actions; they only check the target itself. We always return YES, 62 // since we shouldn't even be installed unless our window is active. 63 - (BOOL) worksWhenModal { 64 return YES; 65 } 66 67 // Events 68 - (void)handleAction:(NSMenuItem *)sender { 69 AWT_ASSERT_APPKIT_THREAD; 70 JNIEnv *env = [ThreadUtilities getJNIEnv]; 71 JNF_COCOA_ENTER(env); 72 73 // If we are called as a result of user pressing a shorcut, do nothing, 74 // because AVTView has already sent corresponding key event to the Java 75 // layer from performKeyEquivalent 76 NSEvent *currEvent = [[NSApplication sharedApplication] currentEvent]; 77 if ([currEvent type] == NSKeyDown) { 78 NSString *menuKey = [sender keyEquivalent]; 79 NSString *eventKey = [currEvent charactersIgnoringModifiers]; 80 81 // Apple uses characters from private Unicode range for some of the 82 // keys, so we need to do the same translation here that we do 83 // for the regular key down events 84 if ([eventKey length] == 1) { 85 unichar origChar = [eventKey characterAtIndex:0]; 86 unichar newChar = NsCharToJavaChar(origChar, 0); 87 if (newChar == java_awt_event_KeyEvent_CHAR_UNDEFINED) { 88 newChar = origChar; 89 } 90 91 eventKey = [NSString stringWithCharacters: &newChar length: 1]; 92 } 93 94 if ([menuKey isEqualToString:eventKey]) { 95 return; 96 } 97 } 98 99 if (fIsCheckbox) { 100 static JNF_CLASS_CACHE(jc_CCheckboxMenuItem, "sun/lwawt/macosx/CCheckboxMenuItem"); 101 static JNF_MEMBER_CACHE(jm_ckHandleAction, jc_CCheckboxMenuItem, "handleAction", "(Z)V"); 102 103 // Send the opposite of what's currently checked -- the action 104 // indicates what state we're going to. 105 NSInteger state = [sender state]; 106 jboolean newState = (state == NSOnState ? JNI_FALSE : JNI_TRUE); 107 JNFCallVoidMethod(env, fPeer, jm_ckHandleAction, newState); 108 } else { 109 static JNF_CLASS_CACHE(jc_CMenuItem, "sun/lwawt/macosx/CMenuItem"); 110 static JNF_MEMBER_CACHE(jm_handleAction, jc_CMenuItem, "handleAction", "(JI)V"); // AWT_THREADING Safe (event) 111 112 NSUInteger modifiers = [currEvent modifierFlags]; 113 jint javaModifiers = NsKeyModifiersToJavaModifiers(modifiers, NO); 114 115 JNFCallVoidMethod(env, fPeer, jm_handleAction, UTC(currEvent), javaModifiers); // AWT_THREADING Safe (event) 116 } 117 JNF_COCOA_EXIT(env); 118 } 119 120 - (void) setJavaLabel:(NSString *)theLabel shortcut:(NSString *)theKeyEquivalent modifierMask:(jint)modifiers { 121 122 NSUInteger modifierMask = 0; 123 124 if (![theKeyEquivalent isEqualToString:@""]) { 125 // Force the key equivalent to lower case if not using the shift key. 126 // Otherwise AppKit will draw a Shift glyph in the menu. 127 if ((modifiers & java_awt_event_KeyEvent_SHIFT_MASK) == 0) { 128 theKeyEquivalent = [theKeyEquivalent lowercaseString]; 129 } 130 131 // Hack for the question mark -- SHIFT and / means use the question mark. 132 if ((modifiers & java_awt_event_KeyEvent_SHIFT_MASK) != 0 && 133 [theKeyEquivalent isEqualToString:@"/"]) 134 { 135 theKeyEquivalent = @"?"; 136 modifiers &= ~java_awt_event_KeyEvent_SHIFT_MASK; 137 } 138 139 modifierMask = JavaModifiersToNsKeyModifiers(modifiers, NO); 140 } 141 142 [ThreadUtilities performOnMainThreadWaiting:YES block:^(){ 143 [fMenuItem setKeyEquivalent:theKeyEquivalent]; 144 [fMenuItem setKeyEquivalentModifierMask:modifierMask]; 145 [fMenuItem setTitle:theLabel]; 146 }]; 147 } 148 149 - (void) setJavaImage:(NSImage *)theImage { 150 151 [ThreadUtilities performOnMainThreadWaiting:NO block:^(){ 152 [fMenuItem setImage:theImage]; 153 }]; 154 } 155 156 - (void) setJavaToolTipText:(NSString *)theText { 157 158 [ThreadUtilities performOnMainThreadWaiting:NO block:^(){ 159 [fMenuItem setToolTip:theText]; 160 }]; 161 } 162 163 164 - (void)setJavaEnabled:(BOOL) enabled { 165 166 [ThreadUtilities performOnMainThreadWaiting:NO block:^(){ 167 @synchronized(self) { 168 fIsEnabled = enabled; 169 170 // Warning: This won't work if the parent menu is disabled. 171 // See [CMenu syncFromJava]. We still need to call it here so 172 // the NSMenuItem itself gets properly updated. 173 [fMenuItem setEnabled:fIsEnabled]; 174 } 175 }]; 176 } 177 178 - (BOOL)isEnabled { 179 180 BOOL enabled = NO; 181 @synchronized(self) { 182 enabled = fIsEnabled; 183 } 184 return enabled; 185 } 186 187 188 - (void)setJavaState:(BOOL)newState { 189 190 [ThreadUtilities performOnMainThreadWaiting:NO block:^(){ 191 [fMenuItem setState:(newState ? NSOnState : NSOffState)]; 192 }]; 193 } 194 195 - (void)cleanup { 196 [fMenuItem setAction:NULL]; 197 [fMenuItem setTarget:nil]; 198 } 199 200 - (void)dealloc { 201 [fMenuItem release]; 202 fMenuItem = nil; 203 204 [super dealloc]; 205 } 206 207 - (void)addNSMenuItemToMenu:(NSMenu *)inMenu { 208 [inMenu addItem:fMenuItem]; 209 } 210 211 - (NSMenuItem *)menuItem { 212 return [[fMenuItem retain] autorelease]; 213 } 214 215 - (void)setIsCheckbox { 216 fIsCheckbox = YES; 217 } 218 219 - (void) _createMenuItem_OnAppKitThread: (NSMutableArray *)argValue { 220 jobject cPeerObjGlobal = (jobject)[[argValue objectAtIndex: 0] pointerValue]; 221 NSNumber * asSeparator = (NSNumber *)[argValue objectAtIndex: 1]; 222 CMenuItem *aCMenuItem = [self initWithPeer: cPeerObjGlobal asSeparator: asSeparator]; 223 [argValue removeAllObjects]; 224 [argValue addObject: aCMenuItem]; 225 } 226 227 - (NSString *)description { 228 return [NSString stringWithFormat:@"CMenuItem[ %@ ]", fMenuItem]; 229 } 230 231 @end 232 233 /** Convert a Java keycode for SetMenuItemCmd */ 234 static unichar AWTKeyToMacShortcut(jint awtKey, BOOL doShift) { 235 unichar macKey = 0; 236 237 if ((awtKey >= java_awt_event_KeyEvent_VK_0 && awtKey <= java_awt_event_KeyEvent_VK_9) || 238 (awtKey >= java_awt_event_KeyEvent_VK_A && awtKey <= java_awt_event_KeyEvent_VK_Z)) 239 { 240 // These ranges are the same in ASCII 241 macKey = awtKey; 242 } else if (awtKey >= java_awt_event_KeyEvent_VK_F1 && awtKey <= java_awt_event_KeyEvent_VK_F12) { 243 // Support for F1 - F12 has been around since Java 1.0 and fall into a lower range. 244 macKey = awtKey - java_awt_event_KeyEvent_VK_F1 + NSF1FunctionKey; 245 } else if (awtKey >= java_awt_event_KeyEvent_VK_F13 && awtKey <= java_awt_event_KeyEvent_VK_F24) { 246 // Support for F13-F24 came in Java 1.2 and are at a different range. 247 macKey = awtKey - java_awt_event_KeyEvent_VK_F13 + NSF13FunctionKey; 248 } else { 249 // Special characters 250 switch (awtKey) { 251 case java_awt_event_KeyEvent_VK_BACK_QUOTE : macKey = '`'; break; 252 case java_awt_event_KeyEvent_VK_QUOTE : macKey = '\''; break; 253 254 case java_awt_event_KeyEvent_VK_ESCAPE : macKey = 0x1B; break; 255 // case java_awt_event_KeyEvent_VK_SPACE : macKey = kMenuSpaceGlyph; break; 256 case java_awt_event_KeyEvent_VK_PAGE_UP : macKey = NSPageUpFunctionKey; break; 257 case java_awt_event_KeyEvent_VK_PAGE_DOWN : macKey = NSPageDownFunctionKey; break; 258 case java_awt_event_KeyEvent_VK_END : macKey = NSEndFunctionKey; break; 259 case java_awt_event_KeyEvent_VK_HOME : macKey = NSHomeFunctionKey; break; 260 261 case java_awt_event_KeyEvent_VK_LEFT : macKey = NSLeftArrowFunctionKey; break; 262 case java_awt_event_KeyEvent_VK_UP : macKey = NSUpArrowFunctionKey; break; 263 case java_awt_event_KeyEvent_VK_RIGHT : macKey = NSRightArrowFunctionKey; break; 264 case java_awt_event_KeyEvent_VK_DOWN : macKey = NSDownArrowFunctionKey; break; 265 266 case java_awt_event_KeyEvent_VK_COMMA : macKey = ','; break; 267 268 // Mac OS doesn't distinguish between the two '-' keys... 269 case java_awt_event_KeyEvent_VK_MINUS : 270 case java_awt_event_KeyEvent_VK_SUBTRACT : macKey = '-'; break; 271 272 // or the two '.' keys... 273 case java_awt_event_KeyEvent_VK_DECIMAL : 274 case java_awt_event_KeyEvent_VK_PERIOD : macKey = '.'; break; 275 276 // or the two '/' keys. 277 case java_awt_event_KeyEvent_VK_DIVIDE : 278 case java_awt_event_KeyEvent_VK_SLASH : macKey = '/'; break; 279 280 case java_awt_event_KeyEvent_VK_SEMICOLON : macKey = ';'; break; 281 case java_awt_event_KeyEvent_VK_EQUALS : macKey = '='; break; 282 283 case java_awt_event_KeyEvent_VK_OPEN_BRACKET : macKey = '['; break; 284 case java_awt_event_KeyEvent_VK_BACK_SLASH : macKey = '\\'; break; 285 case java_awt_event_KeyEvent_VK_CLOSE_BRACKET : macKey = ']'; break; 286 287 case java_awt_event_KeyEvent_VK_MULTIPLY : macKey = '*'; break; 288 case java_awt_event_KeyEvent_VK_ADD : macKey = '+'; break; 289 290 case java_awt_event_KeyEvent_VK_HELP : macKey = NSHelpFunctionKey; break; 291 case java_awt_event_KeyEvent_VK_TAB : macKey = NSTabCharacter; break; 292 case java_awt_event_KeyEvent_VK_ENTER : macKey = NSCarriageReturnCharacter; break; 293 case java_awt_event_KeyEvent_VK_BACK_SPACE : macKey = NSBackspaceCharacter; break; 294 case java_awt_event_KeyEvent_VK_DELETE : macKey = NSDeleteCharacter; break; 295 case java_awt_event_KeyEvent_VK_CLEAR : macKey = NSClearDisplayFunctionKey; break; 296 case java_awt_event_KeyEvent_VK_AMPERSAND : macKey = '&'; break; 297 case java_awt_event_KeyEvent_VK_ASTERISK : macKey = '*'; break; 298 case java_awt_event_KeyEvent_VK_QUOTEDBL : macKey = '\"'; break; 299 case java_awt_event_KeyEvent_VK_LESS : macKey = '<'; break; 300 case java_awt_event_KeyEvent_VK_GREATER : macKey = '>'; break; 301 case java_awt_event_KeyEvent_VK_BRACELEFT : macKey = '{'; break; 302 case java_awt_event_KeyEvent_VK_BRACERIGHT : macKey = '}'; break; 303 case java_awt_event_KeyEvent_VK_AT : macKey = '@'; break; 304 case java_awt_event_KeyEvent_VK_COLON : macKey = ':'; break; 305 case java_awt_event_KeyEvent_VK_CIRCUMFLEX : macKey = '^'; break; 306 case java_awt_event_KeyEvent_VK_DOLLAR : macKey = '$'; break; 307 case java_awt_event_KeyEvent_VK_EXCLAMATION_MARK : macKey = '!'; break; 308 case java_awt_event_KeyEvent_VK_LEFT_PARENTHESIS : macKey = '('; break; 309 case java_awt_event_KeyEvent_VK_NUMBER_SIGN : macKey = '#'; break; 310 case java_awt_event_KeyEvent_VK_PLUS : macKey = '+'; break; 311 case java_awt_event_KeyEvent_VK_RIGHT_PARENTHESIS: macKey = ')'; break; 312 case java_awt_event_KeyEvent_VK_UNDERSCORE : macKey = '_'; break; 313 } 314 } 315 return macKey; 316 } 317 318 /* 319 * Class: sun_lwawt_macosx_CMenuItem 320 * Method: nativeSetLabel 321 * Signature: (JLjava/lang/String;CII)V 322 */ 323 JNIEXPORT void JNICALL 324 Java_sun_lwawt_macosx_CMenuItem_nativeSetLabel 325 (JNIEnv *env, jobject peer, 326 jlong menuItemObj, jstring label, 327 jchar shortcutKey, jint shortcutKeyCode, jint mods) 328 { 329 JNF_COCOA_ENTER(env); 330 NSString *theLabel = JNFJavaToNSString(env, label); 331 NSString *theKeyEquivalent = nil; 332 unichar macKey = shortcutKey; 333 334 if (macKey == 0) { 335 macKey = AWTKeyToMacShortcut(shortcutKeyCode, (mods & java_awt_event_KeyEvent_SHIFT_MASK) != 0); 336 } 337 338 if (macKey != 0) { 339 unichar equivalent[1] = {macKey}; 340 theKeyEquivalent = [NSString stringWithCharacters:equivalent length:1]; 341 } else { 342 theKeyEquivalent = @""; 343 } 344 345 [((CMenuItem *)jlong_to_ptr(menuItemObj)) setJavaLabel:theLabel shortcut:theKeyEquivalent modifierMask:mods]; 346 JNF_COCOA_EXIT(env); 347 } 348 349 /* 350 * Class: sun_lwawt_macosx_CMenuItem 351 * Method: nativeSetTooltip 352 * Signature: (JLjava/lang/String;)V 353 */ 354 JNIEXPORT void JNICALL 355 Java_sun_lwawt_macosx_CMenuItem_nativeSetTooltip 356 (JNIEnv *env, jobject peer, jlong menuItemObj, jstring tooltip) 357 { 358 JNF_COCOA_ENTER(env); 359 NSString *theTooltip = JNFJavaToNSString(env, tooltip); 360 [((CMenuItem *)jlong_to_ptr(menuItemObj)) setJavaToolTipText:theTooltip]; 361 JNF_COCOA_EXIT(env); 362 } 363 364 /* 365 * Class: sun_lwawt_macosx_CMenuItem 366 * Method: nativeSetImage 367 * Signature: (JJ)V 368 */ 369 JNIEXPORT void JNICALL 370 Java_sun_lwawt_macosx_CMenuItem_nativeSetImage 371 (JNIEnv *env, jobject peer, jlong menuItemObj, jlong image) 372 { 373 JNF_COCOA_ENTER(env); 374 [((CMenuItem *)jlong_to_ptr(menuItemObj)) setJavaImage:(NSImage*)jlong_to_ptr(image)]; 375 JNF_COCOA_EXIT(env); 376 } 377 378 /* 379 * Class: sun_lwawt_macosx_CMenuItem 380 * Method: nativeCreate 381 * Signature: (JZ)J 382 */ 383 JNIEXPORT jlong JNICALL 384 Java_sun_lwawt_macosx_CMenuItem_nativeCreate 385 (JNIEnv *env, jobject peer, jlong parentCMenuObj, jboolean isSeparator) 386 { 387 388 CMenuItem *aCMenuItem = nil; 389 CMenu *parentCMenu = (CMenu *)jlong_to_ptr(parentCMenuObj); 390 JNF_COCOA_ENTER(env); 391 392 jobject cPeerObjGlobal = (*env)->NewGlobalRef(env, peer); 393 394 NSMutableArray *args = nil; 395 396 // Create a new item.... 397 if (isSeparator == JNI_TRUE) { 398 args = [[NSMutableArray alloc] initWithObjects:[NSValue valueWithBytes:&cPeerObjGlobal objCType:@encode(jobject)], [NSNumber numberWithBool:YES], nil]; 399 } else { 400 args = [[NSMutableArray alloc] initWithObjects:[NSValue valueWithBytes:&cPeerObjGlobal objCType:@encode(jobject)], [NSNumber numberWithBool:NO], nil]; 401 } 402 403 [ThreadUtilities performOnMainThread:@selector(_createMenuItem_OnAppKitThread:) on:[CMenuItem alloc] withObject:args waitUntilDone:YES]; 404 405 aCMenuItem = (CMenuItem *)[args objectAtIndex: 0]; 406 407 if (aCMenuItem == nil) { 408 return 0L; 409 } 410 411 // and add it to the parent item. 412 [parentCMenu addJavaMenuItem: aCMenuItem]; 413 414 // setLabel will be called after creation completes. 415 416 if (aCMenuItem) { 417 CFRetain(aCMenuItem); // GC 418 [aCMenuItem release]; 419 } 420 421 JNF_COCOA_EXIT(env); 422 return ptr_to_jlong(aCMenuItem); 423 } 424 425 /* 426 * Class: sun_lwawt_macosx_CMenuItem 427 * Method: nativeSetEnabled 428 * Signature: (JZ)V 429 */ 430 JNIEXPORT void JNICALL 431 Java_sun_lwawt_macosx_CMenuItem_nativeSetEnabled 432 (JNIEnv *env, jobject peer, jlong menuItemObj, jboolean enable) 433 { 434 JNF_COCOA_ENTER(env); 435 CMenuItem *item = (CMenuItem *)jlong_to_ptr(menuItemObj); 436 [item setJavaEnabled: (enable == JNI_TRUE)]; 437 JNF_COCOA_EXIT(env); 438 } 439 440 /* 441 * Class: sun_lwawt_macosx_CCheckboxMenuItem 442 * Method: nativeSetState 443 * Signature: (IZ)V 444 */ 445 JNIEXPORT void JNICALL 446 Java_sun_lwawt_macosx_CCheckboxMenuItem_nativeSetState 447 (JNIEnv *env, jobject peer, jlong menuItemObj, jboolean state) 448 { 449 JNF_COCOA_ENTER(env); 450 CMenuItem *item = (CMenuItem *)jlong_to_ptr(menuItemObj); 451 [item setJavaState: (state == JNI_TRUE)]; 452 JNF_COCOA_EXIT(env); 453 } 454 455 /* 456 * Class: sun_lwawt_macosx_CCheckboxMenuItem 457 * Method: nativeSetState 458 * Signature: (IZ)V 459 */ 460 JNIEXPORT void JNICALL 461 Java_sun_lwawt_macosx_CCheckboxMenuItem_nativeSetIsCheckbox 462 (JNIEnv *env, jobject peer, jlong menuItemObj) 463 { 464 JNF_COCOA_ENTER(env); 465 CMenuItem *item = (CMenuItem *)jlong_to_ptr(menuItemObj); 466 [item setIsCheckbox]; 467 JNF_COCOA_EXIT(env); 468 }