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 package sun.lwawt.macosx;
  27 
  28 import sun.awt.SunToolkit;
  29 import sun.lwawt.LWWindowPeer;
  30 import sun.lwawt.PlatformEventNotifier;
  31 
  32 import java.awt.Toolkit;
  33 import java.awt.event.MouseEvent;
  34 import java.awt.event.InputEvent;
  35 import java.awt.event.MouseWheelEvent;
  36 import java.awt.event.KeyEvent;
  37 import java.util.Locale;
  38 
  39 /**
  40  * Translates NSEvents/NPCocoaEvents into AWT events.
  41  */
  42 final class CPlatformResponder {
  43 
  44     private final PlatformEventNotifier eventNotifier;
  45     private final boolean isNpapiCallback;
  46     private int lastKeyPressCode = KeyEvent.VK_UNDEFINED;
  47 
  48     CPlatformResponder(final PlatformEventNotifier eventNotifier,
  49                        final boolean isNpapiCallback) {
  50         this.eventNotifier = eventNotifier;
  51         this.isNpapiCallback = isNpapiCallback;
  52     }
  53 
  54     /**
  55      * Handles mouse events.
  56      */
  57     void handleMouseEvent(int eventType, int modifierFlags, int buttonNumber,
  58                           int clickCount, int x, int y, int absoluteX,
  59                           int absoluteY) {
  60         final SunToolkit tk = (SunToolkit)Toolkit.getDefaultToolkit();
  61         if ((buttonNumber > 2 && !tk.areExtraMouseButtonsEnabled())
  62                 || buttonNumber > tk.getNumberOfButtons() - 1) {
  63             return;
  64         }
  65 
  66         int jeventType = isNpapiCallback ? NSEvent.npToJavaEventType(eventType) :
  67                                            NSEvent.nsToJavaEventType(eventType);
  68 
  69         int jbuttonNumber = MouseEvent.NOBUTTON;
  70         int jclickCount = 0;
  71 
  72         if (jeventType != MouseEvent.MOUSE_MOVED &&
  73             jeventType != MouseEvent.MOUSE_ENTERED &&
  74             jeventType != MouseEvent.MOUSE_EXITED)
  75         {
  76             jbuttonNumber = NSEvent.nsToJavaButton(buttonNumber);
  77             jclickCount = clickCount;
  78         }
  79 
  80         int jmodifiers = NSEvent.nsToJavaMouseModifiers(buttonNumber,
  81                                                         modifierFlags);
  82         boolean jpopupTrigger = NSEvent.isPopupTrigger(jmodifiers);
  83 
  84         eventNotifier.notifyMouseEvent(jeventType, System.currentTimeMillis(), jbuttonNumber,
  85                 x, y, absoluteX, absoluteY, jmodifiers, jclickCount,
  86                 jpopupTrigger, null);
  87     }
  88 
  89     /**
  90      * Handles scroll events.
  91      */
  92     void handleScrollEvent(final int x, final int y, final int modifierFlags,
  93                            final double deltaX, final double deltaY) {
  94         final int buttonNumber = CocoaConstants.kCGMouseButtonCenter;
  95         int jmodifiers = NSEvent.nsToJavaMouseModifiers(buttonNumber,
  96                                                         modifierFlags);
  97         final boolean isShift = (jmodifiers & InputEvent.SHIFT_DOWN_MASK) != 0;
  98 
  99         // Vertical scroll.
 100         if (!isShift && deltaY != 0.0) {
 101             dispatchScrollEvent(x, y, jmodifiers, deltaY);
 102         }
 103         // Horizontal scroll or shirt+vertical scroll.
 104         final double delta = isShift && deltaY != 0.0 ? deltaY : deltaX;
 105         if (delta != 0.0) {
 106             jmodifiers |= InputEvent.SHIFT_DOWN_MASK;
 107             dispatchScrollEvent(x, y, jmodifiers, delta);
 108         }
 109     }
 110 
 111     private void dispatchScrollEvent(final int x, final int y,
 112                                      final int modifiers, final double delta) {
 113         final long when = System.currentTimeMillis();
 114         final int scrollType = MouseWheelEvent.WHEEL_UNIT_SCROLL;
 115         final int scrollAmount = 1;
 116         int wheelRotation = (int) delta;
 117         int signum = (int) Math.signum(delta);
 118         if (signum * delta < 1) {
 119             wheelRotation = signum;
 120         }
 121         // invert the wheelRotation for the peer
 122         eventNotifier.notifyMouseWheelEvent(when, x, y, modifiers, scrollType,
 123                 scrollAmount, -wheelRotation, -delta, null);
 124     }
 125 
 126     /**
 127      * Handles key events.
 128      */
 129     void handleKeyEvent(int eventType, int modifierFlags, String chars, String charsIgnoringModifiers,
 130                         short keyCode, boolean needsKeyTyped, boolean needsKeyReleased) {
 131         boolean isFlagsChangedEvent =
 132             isNpapiCallback ? (eventType == CocoaConstants.NPCocoaEventFlagsChanged) :
 133                               (eventType == CocoaConstants.NSFlagsChanged);
 134 
 135         int jeventType = KeyEvent.KEY_PRESSED;
 136         int jkeyCode = KeyEvent.VK_UNDEFINED;
 137         int jkeyLocation = KeyEvent.KEY_LOCATION_UNKNOWN;
 138         boolean postsTyped = false;
 139 
 140         char testChar = KeyEvent.CHAR_UNDEFINED;
 141         boolean isDeadChar = (chars!= null && chars.length() == 0);
 142 
 143         if (isFlagsChangedEvent) {
 144             int[] in = new int[] {modifierFlags, keyCode};
 145             int[] out = new int[3]; // [jkeyCode, jkeyLocation, jkeyType]
 146 
 147             NSEvent.nsKeyModifiersToJavaKeyInfo(in, out);
 148 
 149             jkeyCode = out[0];
 150             jkeyLocation = out[1];
 151             jeventType = out[2];
 152         } else {
 153             if (chars != null && chars.length() > 0) {
 154                 testChar = chars.charAt(0);
 155             }
 156 
 157             char testCharIgnoringModifiers = charsIgnoringModifiers != null && charsIgnoringModifiers.length() > 0 ?
 158                     charsIgnoringModifiers.charAt(0) : KeyEvent.CHAR_UNDEFINED;
 159 
 160             int[] in = new int[] {testCharIgnoringModifiers, isDeadChar ? 1 : 0, modifierFlags, keyCode};
 161             int[] out = new int[3]; // [jkeyCode, jkeyLocation, deadChar]
 162 
 163             postsTyped = NSEvent.nsToJavaKeyInfo(in, out);
 164             if (!postsTyped) {
 165                 testChar = KeyEvent.CHAR_UNDEFINED;
 166             }
 167 
 168             if(isDeadChar){
 169                 testChar = (char) out[2];
 170                 if(testChar == 0){
 171                     return;
 172                 }
 173             }
 174 
 175             // If Pinyin Simplified input method is selected, CAPS_LOCK key is supposed to switch
 176             // input to latin letters.
 177             // It is necessary to use testCharIgnoringModifiers instead of testChar for event
 178             // generation in such case to avoid uppercase letters in text components.
 179             LWCToolkit lwcToolkit = (LWCToolkit)Toolkit.getDefaultToolkit();
 180             if (lwcToolkit.getLockingKeyState(KeyEvent.VK_CAPS_LOCK) &&
 181                     Locale.SIMPLIFIED_CHINESE.equals(lwcToolkit.getDefaultKeyboardLocale())) {
 182                 testChar = testCharIgnoringModifiers;
 183             }
 184 
 185             jkeyCode = out[0];
 186             jkeyLocation = out[1];
 187             jeventType = isNpapiCallback ? NSEvent.npToJavaEventType(eventType) :
 188                                            NSEvent.nsToJavaEventType(eventType);
 189         }
 190 
 191         char javaChar = NSEvent.nsToJavaChar(testChar, modifierFlags);
 192         // Some keys may generate a KEY_TYPED, but we can't determine
 193         // what that character is. That's likely a bug, but for now we
 194         // just check for CHAR_UNDEFINED.
 195         if (javaChar == KeyEvent.CHAR_UNDEFINED) {
 196             postsTyped = false;
 197         }
 198 
 199 
 200         int jmodifiers = NSEvent.nsToJavaKeyModifiers(modifierFlags);
 201         long when = System.currentTimeMillis();
 202 
 203         if (jeventType == KeyEvent.KEY_PRESSED) {
 204             lastKeyPressCode = jkeyCode;
 205         }
 206         eventNotifier.notifyKeyEvent(jeventType, when, jmodifiers,
 207                 jkeyCode, javaChar, jkeyLocation);
 208 
 209         // Current browser may be sending input events, so don't
 210         // post the KEY_TYPED here.
 211         postsTyped &= needsKeyTyped;
 212 
 213         // That's the reaction on the PRESSED (not RELEASED) event as it comes to
 214         // appear in MacOSX.
 215         // Modifier keys (shift, etc) don't want to send TYPED events.
 216         // On the other hand we don't want to generate keyTyped events
 217         // for clipboard related shortcuts like Meta + [CVX]
 218         if (jeventType == KeyEvent.KEY_PRESSED && postsTyped &&
 219                 (jmodifiers & KeyEvent.META_DOWN_MASK) == 0) {
 220             // Enter and Space keys finish the input method processing,
 221             // KEY_TYPED and KEY_RELEASED events for them are synthesized in handleInputEvent.
 222             if (needsKeyReleased && (jkeyCode == KeyEvent.VK_ENTER || jkeyCode == KeyEvent.VK_SPACE)) {
 223                 return;
 224             }
 225             eventNotifier.notifyKeyEvent(KeyEvent.KEY_TYPED, when, jmodifiers,
 226                     KeyEvent.VK_UNDEFINED, javaChar,
 227                     KeyEvent.KEY_LOCATION_UNKNOWN);
 228             //If events come from Firefox, released events should also be generated.
 229             if (needsKeyReleased) {
 230                 eventNotifier.notifyKeyEvent(KeyEvent.KEY_RELEASED, when, jmodifiers,
 231                         jkeyCode, javaChar,
 232                         KeyEvent.KEY_LOCATION_UNKNOWN);
 233             }
 234         }
 235     }
 236 
 237     void handleInputEvent(String text) {
 238         if (text != null) {
 239             int index = 0, length = text.length();
 240             char c = 0;
 241             while (index < length) {
 242                 c = text.charAt(index);
 243                 eventNotifier.notifyKeyEvent(KeyEvent.KEY_TYPED,
 244                         System.currentTimeMillis(),
 245                         0, KeyEvent.VK_UNDEFINED, c,
 246                         KeyEvent.KEY_LOCATION_UNKNOWN);
 247                 index++;
 248             }
 249             eventNotifier.notifyKeyEvent(KeyEvent.KEY_RELEASED,
 250                     System.currentTimeMillis(),
 251                     0, lastKeyPressCode, c,
 252                     KeyEvent.KEY_LOCATION_UNKNOWN);
 253         }
 254     }
 255 
 256     void handleWindowFocusEvent(boolean gained, LWWindowPeer opposite) {
 257         eventNotifier.notifyActivation(gained, opposite);
 258     }
 259 }