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