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