1 /*
   2  * Copyright (c) 2011, 2014, 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 #include <Carbon/Carbon.h>
  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 shortcut, do nothing,
  74     // because AVTView has already sent corresponding key event to the Java
  75     // layer from performKeyEquivalent.
  76     // There is an exception from the rule above, though: if a window with
  77     // a menu gets minimized by user and there are no other windows to take
  78     // focus, the window's menu won't be removed from the global menu bar.
  79     // However, the Java layer won't handle invocation by a shortcut coming
  80     // from this "frameless" menu, because there are no active windows. This
  81     // means we have to handle it here.
  82     NSEvent *currEvent = [[NSApplication sharedApplication] currentEvent];
  83     if (fIsCheckbox) {
  84         static JNF_CLASS_CACHE(jc_CCheckboxMenuItem, "sun/lwawt/macosx/CCheckboxMenuItem");
  85         static JNF_MEMBER_CACHE(jm_ckHandleAction, jc_CCheckboxMenuItem, "handleAction", "(Z)V");
  86         
  87         // Send the opposite of what's currently checked -- the action
  88         // indicates what state we're going to.
  89         NSInteger state = [sender state];
  90         jboolean newState = (state == NSOnState ? JNI_FALSE : JNI_TRUE);
  91         JNFCallVoidMethod(env, fPeer, jm_ckHandleAction, newState);
  92     }
  93     else {
  94         if ([currEvent type] == NSKeyDown) {
  95             // Event available through sender variable hence NSApplication
  96             // not needed for checking the keyboard input sans the modifier keys
  97             // Also, the method used to fetch eventKey earlier would be locale dependent
  98             // With earlier implementation, if MenuKey: e EventKey: ा ; if input method
  99             // is not U.S. (Devanagari in this case)
 100             // With current implementation, EventKey = MenuKey = e irrespective of
 101             // input method
 102             NSString *eventKey = [sender keyEquivalent];
 103             // Apple uses characters from private Unicode range for some of the
 104             // keys, so we need to do the same translation here that we do
 105             // for the regular key down events
 106             if ([eventKey length] == 1) {
 107                 unichar origChar = [eventKey characterAtIndex:0];
 108                 unichar newChar =  NsCharToJavaChar(origChar, 0);
 109                 if (newChar == java_awt_event_KeyEvent_CHAR_UNDEFINED) {
 110                     newChar = origChar;
 111                 }
 112                 eventKey = [NSString stringWithCharacters: &newChar length: 1];
 113             }
 114             NSWindow *keyWindow = [NSApp keyWindow];
 115             if (keyWindow != nil) {
 116                 return;
 117             }
 118         }
 119         else {
 120             static JNF_CLASS_CACHE(jc_CMenuItem, "sun/lwawt/macosx/CMenuItem");
 121             static JNF_MEMBER_CACHE(jm_handleAction, jc_CMenuItem, "handleAction", "(JI)V"); // AWT_THREADING Safe (event)
 122             
 123             NSUInteger modifiers = [currEvent modifierFlags];
 124             jint javaModifiers = NsKeyModifiersToJavaModifiers(modifiers, NO);
 125             
 126             JNFCallVoidMethod(env, fPeer, jm_handleAction, UTC(currEvent), javaModifiers); // AWT_THREADING Safe (event)
 127         }
 128     }
 129     JNF_COCOA_EXIT(env);
 130     
 131 }
 132 
 133 - (void) setJavaLabel:(NSString *)theLabel shortcut:(NSString *)theKeyEquivalent modifierMask:(jint)modifiers {
 134     
 135     NSUInteger modifierMask = 0;
 136     
 137     if (![theKeyEquivalent isEqualToString:@""]) {
 138         // Force the key equivalent to lower case if not using the shift key.
 139         // Otherwise AppKit will draw a Shift glyph in the menu.
 140         if ((modifiers & java_awt_event_KeyEvent_SHIFT_MASK) == 0) {
 141             theKeyEquivalent = [theKeyEquivalent lowercaseString];
 142         }
 143         
 144         // Hack for the question mark -- SHIFT and / means use the question mark.
 145         if ((modifiers & java_awt_event_KeyEvent_SHIFT_MASK) != 0 &&
 146             [theKeyEquivalent isEqualToString:@"/"])
 147         {
 148             theKeyEquivalent = @"?";
 149             modifiers &= ~java_awt_event_KeyEvent_SHIFT_MASK;
 150         }
 151         
 152         modifierMask = JavaModifiersToNsKeyModifiers(modifiers, NO);
 153     }
 154     
 155     [ThreadUtilities performOnMainThreadWaiting:YES block:^(){
 156         [fMenuItem setKeyEquivalent:theKeyEquivalent];
 157         [fMenuItem setKeyEquivalentModifierMask:modifierMask];
 158         [fMenuItem setTitle:theLabel];
 159     }];
 160 }
 161 
 162 - (void) setJavaImage:(NSImage *)theImage {
 163     
 164     [ThreadUtilities performOnMainThreadWaiting:NO block:^(){
 165         [fMenuItem setImage:theImage];
 166     }];
 167 }
 168 
 169 - (void) setJavaToolTipText:(NSString *)theText {
 170     
 171     [ThreadUtilities performOnMainThreadWaiting:NO block:^(){
 172         [fMenuItem setToolTip:theText];
 173     }];
 174 }
 175 
 176 
 177 - (void)setJavaEnabled:(BOOL) enabled {
 178     
 179     [ThreadUtilities performOnMainThreadWaiting:NO block:^(){
 180         @synchronized(self) {
 181             fIsEnabled = enabled;
 182             
 183             // Warning:  This won't work if the parent menu is disabled.
 184             // See [CMenu syncFromJava]. We still need to call it here so
 185             // the NSMenuItem itself gets properly updated.
 186             [fMenuItem setEnabled:fIsEnabled];
 187         }
 188     }];
 189 }
 190 
 191 - (BOOL)isEnabled {
 192     
 193     BOOL enabled = NO;
 194     @synchronized(self) {
 195         enabled = fIsEnabled;
 196     }
 197     return enabled;
 198 }
 199 
 200 
 201 - (void)setJavaState:(BOOL)newState {
 202     
 203     [ThreadUtilities performOnMainThreadWaiting:NO block:^(){
 204         [fMenuItem setState:(newState ? NSOnState : NSOffState)];
 205     }];
 206 }
 207 
 208 - (void)cleanup {
 209     [fMenuItem setAction:NULL];
 210     [fMenuItem setTarget:nil];
 211 }
 212 
 213 - (void)dealloc {
 214     [fMenuItem release];
 215     fMenuItem = nil;
 216     
 217     [super dealloc];
 218 }
 219 
 220 - (void)addNSMenuItemToMenu:(NSMenu *)inMenu {
 221     [inMenu addItem:fMenuItem];
 222 }
 223 
 224 - (NSMenuItem *)menuItem {
 225     return [[fMenuItem retain] autorelease];
 226 }
 227 
 228 - (void)setIsCheckbox {
 229     fIsCheckbox = YES;
 230 }
 231 
 232 - (void) _createMenuItem_OnAppKitThread: (NSMutableArray *)argValue {
 233     jobject cPeerObjGlobal = (jobject)[[argValue objectAtIndex: 0] pointerValue];
 234     NSNumber * asSeparator = (NSNumber *)[argValue objectAtIndex: 1];
 235     CMenuItem *aCMenuItem = [self initWithPeer: cPeerObjGlobal asSeparator: asSeparator];
 236     [argValue removeAllObjects];
 237     [argValue addObject: aCMenuItem];
 238 }
 239 
 240 - (NSString *)description {
 241     return [NSString stringWithFormat:@"CMenuItem[ %@ ]", fMenuItem];
 242 }
 243 
 244 @end
 245 
 246 /** Convert a Java keycode for SetMenuItemCmd */
 247 static unichar AWTKeyToMacShortcut(jint awtKey, BOOL doShift) {
 248     unichar macKey = 0;
 249     
 250     if ((awtKey >= java_awt_event_KeyEvent_VK_0 && awtKey <= java_awt_event_KeyEvent_VK_9) ||
 251         (awtKey >= java_awt_event_KeyEvent_VK_A && awtKey <= java_awt_event_KeyEvent_VK_Z))
 252     {
 253         // These ranges are the same in ASCII
 254         macKey = awtKey;
 255     } else if (awtKey >= java_awt_event_KeyEvent_VK_F1 && awtKey <= java_awt_event_KeyEvent_VK_F12) {
 256         // Support for F1 - F12 has been around since Java 1.0 and fall into a lower range.
 257         macKey = awtKey - java_awt_event_KeyEvent_VK_F1 + NSF1FunctionKey;
 258     } else if (awtKey >= java_awt_event_KeyEvent_VK_F13 && awtKey <= java_awt_event_KeyEvent_VK_F24) {
 259         // Support for F13-F24 came in Java 1.2 and are at a different range.
 260         macKey = awtKey - java_awt_event_KeyEvent_VK_F13 + NSF13FunctionKey;
 261     } else {
 262         // Special characters
 263         switch (awtKey) {
 264             case java_awt_event_KeyEvent_VK_BACK_QUOTE      : macKey = '`'; break;
 265             case java_awt_event_KeyEvent_VK_QUOTE           : macKey = '\''; break;
 266                 
 267             case java_awt_event_KeyEvent_VK_ESCAPE          : macKey = 0x1B; break;
 268             case java_awt_event_KeyEvent_VK_SPACE           : macKey = ' '; break;
 269             case java_awt_event_KeyEvent_VK_PAGE_UP         : macKey = NSPageUpFunctionKey; break;
 270             case java_awt_event_KeyEvent_VK_PAGE_DOWN       : macKey = NSPageDownFunctionKey; break;
 271             case java_awt_event_KeyEvent_VK_END             : macKey = NSEndFunctionKey; break;
 272             case java_awt_event_KeyEvent_VK_HOME            : macKey = NSHomeFunctionKey; break;
 273                 
 274             case java_awt_event_KeyEvent_VK_LEFT            : macKey = NSLeftArrowFunctionKey; break;
 275             case java_awt_event_KeyEvent_VK_UP              : macKey = NSUpArrowFunctionKey; break;
 276             case java_awt_event_KeyEvent_VK_RIGHT           : macKey = NSRightArrowFunctionKey; break;
 277             case java_awt_event_KeyEvent_VK_DOWN            : macKey = NSDownArrowFunctionKey; break;
 278                 
 279             case java_awt_event_KeyEvent_VK_COMMA           : macKey = ','; break;
 280                 
 281                 // Mac OS doesn't distinguish between the two '-' keys...
 282             case java_awt_event_KeyEvent_VK_MINUS           :
 283             case java_awt_event_KeyEvent_VK_SUBTRACT        : macKey = '-'; break;
 284                 
 285                 // or the two '.' keys...
 286             case java_awt_event_KeyEvent_VK_DECIMAL         :
 287             case java_awt_event_KeyEvent_VK_PERIOD          : macKey = '.'; break;
 288                 
 289                 // or the two '/' keys.
 290             case java_awt_event_KeyEvent_VK_DIVIDE          :
 291             case java_awt_event_KeyEvent_VK_SLASH           : macKey = '/'; break;
 292                 
 293             case java_awt_event_KeyEvent_VK_SEMICOLON       : macKey = ';'; break;
 294             case java_awt_event_KeyEvent_VK_EQUALS          : macKey = '='; break;
 295                 
 296             case java_awt_event_KeyEvent_VK_OPEN_BRACKET    : macKey = '['; break;
 297             case java_awt_event_KeyEvent_VK_BACK_SLASH      : macKey = '\\'; break;
 298             case java_awt_event_KeyEvent_VK_CLOSE_BRACKET   : macKey = ']'; break;
 299                 
 300             case java_awt_event_KeyEvent_VK_MULTIPLY        : macKey = '*'; break;
 301             case java_awt_event_KeyEvent_VK_ADD             : macKey = '+'; break;
 302                 
 303             case java_awt_event_KeyEvent_VK_HELP            : macKey = NSHelpFunctionKey; break;
 304             case java_awt_event_KeyEvent_VK_TAB             : macKey = NSTabCharacter; break;
 305             case java_awt_event_KeyEvent_VK_ENTER           : macKey = NSNewlineCharacter; break;
 306             case java_awt_event_KeyEvent_VK_BACK_SPACE      : macKey = NSBackspaceCharacter; break;
 307             case java_awt_event_KeyEvent_VK_DELETE          : macKey = NSDeleteCharacter; break;
 308             case java_awt_event_KeyEvent_VK_CLEAR           : macKey = NSClearDisplayFunctionKey; break;
 309             case java_awt_event_KeyEvent_VK_AMPERSAND       : macKey = '&'; break;
 310             case java_awt_event_KeyEvent_VK_ASTERISK        : macKey = '*'; break;
 311             case java_awt_event_KeyEvent_VK_QUOTEDBL        : macKey = '\"'; break;
 312             case java_awt_event_KeyEvent_VK_LESS            : macKey = '<'; break;
 313             case java_awt_event_KeyEvent_VK_GREATER         : macKey = '>'; break;
 314             case java_awt_event_KeyEvent_VK_BRACELEFT       : macKey = '{'; break;
 315             case java_awt_event_KeyEvent_VK_BRACERIGHT      : macKey = '}'; break;
 316             case java_awt_event_KeyEvent_VK_AT              : macKey = '@'; break;
 317             case java_awt_event_KeyEvent_VK_COLON           : macKey = ':'; break;
 318             case java_awt_event_KeyEvent_VK_CIRCUMFLEX      : macKey = '^'; break;
 319             case java_awt_event_KeyEvent_VK_DOLLAR          : macKey = '$'; break;
 320             case java_awt_event_KeyEvent_VK_EXCLAMATION_MARK : macKey = '!'; break;
 321             case java_awt_event_KeyEvent_VK_LEFT_PARENTHESIS : macKey = '('; break;
 322             case java_awt_event_KeyEvent_VK_NUMBER_SIGN     : macKey = '#'; break;
 323             case java_awt_event_KeyEvent_VK_PLUS            : macKey = '+'; break;
 324             case java_awt_event_KeyEvent_VK_RIGHT_PARENTHESIS: macKey = ')'; break;
 325             case java_awt_event_KeyEvent_VK_UNDERSCORE      : macKey = '_'; break;
 326         }
 327     }
 328     return macKey;
 329 }
 330 
 331 /*
 332  * Class:     sun_lwawt_macosx_CMenuItem
 333  * Method:    nativeSetLabel
 334  * Signature: (JLjava/lang/String;CII)V
 335  */
 336 JNIEXPORT void JNICALL
 337 Java_sun_lwawt_macosx_CMenuItem_nativeSetLabel
 338 (JNIEnv *env, jobject peer,
 339  jlong menuItemObj, jstring label,
 340  jchar shortcutKey, jint shortcutKeyCode, jint mods)
 341 {
 342     JNF_COCOA_ENTER(env);
 343     NSString *theLabel = JNFJavaToNSString(env, label);
 344     NSString *theKeyEquivalent = nil;
 345     unichar macKey = shortcutKey;
 346     
 347     if (macKey == 0) {
 348         macKey = AWTKeyToMacShortcut(shortcutKeyCode, (mods & java_awt_event_KeyEvent_SHIFT_MASK) != 0);
 349     }
 350     
 351     if (macKey != 0) {
 352         unichar equivalent[1] = {macKey};
 353         theKeyEquivalent = [NSString stringWithCharacters:equivalent length:1];
 354     } else {
 355         theKeyEquivalent = @"";
 356     }
 357     
 358     [((CMenuItem *)jlong_to_ptr(menuItemObj)) setJavaLabel:theLabel shortcut:theKeyEquivalent modifierMask:mods];
 359     JNF_COCOA_EXIT(env);
 360 }
 361 
 362 /*
 363  * Class:     sun_lwawt_macosx_CMenuItem
 364  * Method:    nativeSetTooltip
 365  * Signature: (JLjava/lang/String;)V
 366  */
 367 JNIEXPORT void JNICALL
 368 Java_sun_lwawt_macosx_CMenuItem_nativeSetTooltip
 369 (JNIEnv *env, jobject peer, jlong menuItemObj, jstring tooltip)
 370 {
 371     JNF_COCOA_ENTER(env);
 372     NSString *theTooltip = JNFJavaToNSString(env, tooltip);
 373     [((CMenuItem *)jlong_to_ptr(menuItemObj)) setJavaToolTipText:theTooltip];
 374     JNF_COCOA_EXIT(env);
 375 }
 376 
 377 /*
 378  * Class:     sun_lwawt_macosx_CMenuItem
 379  * Method:    nativeSetImage
 380  * Signature: (JJ)V
 381  */
 382 JNIEXPORT void JNICALL
 383 Java_sun_lwawt_macosx_CMenuItem_nativeSetImage
 384 (JNIEnv *env, jobject peer, jlong menuItemObj, jlong image)
 385 {
 386     JNF_COCOA_ENTER(env);
 387     [((CMenuItem *)jlong_to_ptr(menuItemObj)) setJavaImage:(NSImage*)jlong_to_ptr(image)];
 388     JNF_COCOA_EXIT(env);
 389 }
 390 
 391 /*
 392  * Class:     sun_lwawt_macosx_CMenuItem
 393  * Method:    nativeCreate
 394  * Signature: (JZ)J
 395  */
 396 JNIEXPORT jlong JNICALL
 397 Java_sun_lwawt_macosx_CMenuItem_nativeCreate
 398 (JNIEnv *env, jobject peer, jlong parentCMenuObj, jboolean isSeparator)
 399 {
 400     
 401     CMenuItem *aCMenuItem = nil;
 402     CMenu *parentCMenu = (CMenu *)jlong_to_ptr(parentCMenuObj);
 403     JNF_COCOA_ENTER(env);
 404     
 405     jobject cPeerObjGlobal = (*env)->NewGlobalRef(env, peer);
 406     
 407     NSMutableArray *args = nil;
 408     
 409     // Create a new item....
 410     if (isSeparator == JNI_TRUE) {
 411         args = [[NSMutableArray alloc] initWithObjects:[NSValue valueWithBytes:&cPeerObjGlobal objCType:@encode(jobject)], [NSNumber numberWithBool:YES],  nil];
 412     } else {
 413         args = [[NSMutableArray alloc] initWithObjects:[NSValue valueWithBytes:&cPeerObjGlobal objCType:@encode(jobject)], [NSNumber numberWithBool:NO],  nil];
 414     }
 415     
 416     [ThreadUtilities performOnMainThread:@selector(_createMenuItem_OnAppKitThread:) on:[CMenuItem alloc] withObject:args waitUntilDone:YES];
 417     
 418     aCMenuItem = (CMenuItem *)[args objectAtIndex: 0];
 419     
 420     if (aCMenuItem == nil) {
 421         return 0L;
 422     }
 423     
 424     // and add it to the parent item.
 425     [parentCMenu addJavaMenuItem: aCMenuItem];
 426     
 427     // setLabel will be called after creation completes.
 428     
 429     JNF_COCOA_EXIT(env);
 430     return ptr_to_jlong(aCMenuItem);
 431 }
 432 
 433 /*
 434  * Class:     sun_lwawt_macosx_CMenuItem
 435  * Method:    nativeSetEnabled
 436  * Signature: (JZ)V
 437  */
 438 JNIEXPORT void JNICALL
 439 Java_sun_lwawt_macosx_CMenuItem_nativeSetEnabled
 440 (JNIEnv *env, jobject peer, jlong menuItemObj, jboolean enable)
 441 {
 442     JNF_COCOA_ENTER(env);
 443     CMenuItem *item = (CMenuItem *)jlong_to_ptr(menuItemObj);
 444     [item setJavaEnabled: (enable == JNI_TRUE)];
 445     JNF_COCOA_EXIT(env);
 446 }
 447 
 448 /*
 449  * Class:     sun_lwawt_macosx_CCheckboxMenuItem
 450  * Method:    nativeSetState
 451  * Signature: (IZ)V
 452  */
 453 JNIEXPORT void JNICALL
 454 Java_sun_lwawt_macosx_CCheckboxMenuItem_nativeSetState
 455 (JNIEnv *env, jobject peer, jlong menuItemObj, jboolean state)
 456 {
 457     JNF_COCOA_ENTER(env);
 458     CMenuItem *item = (CMenuItem *)jlong_to_ptr(menuItemObj);
 459     [item setJavaState: (state == JNI_TRUE)];
 460     JNF_COCOA_EXIT(env);
 461 }
 462 
 463 /*
 464  * Class:     sun_lwawt_macosx_CCheckboxMenuItem
 465  * Method:    nativeSetState
 466  * Signature: (IZ)V
 467  */
 468 JNIEXPORT void JNICALL
 469 Java_sun_lwawt_macosx_CCheckboxMenuItem_nativeSetIsCheckbox
 470 (JNIEnv *env, jobject peer, jlong menuItemObj)
 471 {
 472     JNF_COCOA_ENTER(env);
 473     CMenuItem *item = (CMenuItem *)jlong_to_ptr(menuItemObj);
 474     [item setIsCheckbox];
 475     JNF_COCOA_EXIT(env);
 476 }