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