| /* |
| * Copyright (c) 2011, 2013, Oracle and/or its affiliates. All rights reserved. |
| * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| * |
| * This code is free software; you can redistribute it and/or modify it |
| * under the terms of the GNU General Public License version 2 only, as |
| * published by the Free Software Foundation. Oracle designates this |
| * particular file as subject to the "Classpath" exception as provided |
| * by Oracle in the LICENSE file that accompanied this code. |
| * |
| * This code is distributed in the hope that it will be useful, but WITHOUT |
| * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| * version 2 for more details (a copy is included in the LICENSE file that |
| * accompanied this code). |
| * |
| * You should have received a copy of the GNU General Public License version |
| * 2 along with this work; if not, write to the Free Software Foundation, |
| * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| * |
| * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| * or visit www.oracle.com if you need additional information or have any |
| * questions. |
| */ |
| |
| package com.apple.eawt; |
| |
| import java.awt.*; |
| import java.awt.event.WindowEvent; |
| import java.io.File; |
| import java.net.*; |
| import java.util.*; |
| import java.util.List; |
| import sun.awt.AppContext; |
| import sun.awt.SunToolkit; |
| |
| import com.apple.eawt.AppEvent.*; |
| |
| class _AppEventHandler { |
| private static final int NOTIFY_ABOUT = 1; |
| private static final int NOTIFY_PREFS = 2; |
| private static final int NOTIFY_OPEN_APP = 3; |
| private static final int NOTIFY_REOPEN_APP = 4; |
| private static final int NOTIFY_QUIT = 5; |
| private static final int NOTIFY_SHUTDOWN = 6; |
| private static final int NOTIFY_ACTIVE_APP_GAINED = 7; |
| private static final int NOTIFY_ACTIVE_APP_LOST = 8; |
| private static final int NOTIFY_APP_HIDDEN = 9; |
| private static final int NOTIFY_APP_SHOWN = 10; |
| private static final int NOTIFY_USER_SESSION_ACTIVE = 11; |
| private static final int NOTIFY_USER_SESSION_INACTIVE = 12; |
| private static final int NOTIFY_SCREEN_SLEEP = 13; |
| private static final int NOTIFY_SCREEN_WAKE = 14; |
| private static final int NOTIFY_SYSTEM_SLEEP = 15; |
| private static final int NOTIFY_SYSTEM_WAKE = 16; |
| |
| private static final int REGISTER_USER_SESSION = 1; |
| private static final int REGISTER_SCREEN_SLEEP = 2; |
| private static final int REGISTER_SYSTEM_SLEEP = 3; |
| |
| private static native void nativeOpenCocoaAboutWindow(); |
| private static native void nativeReplyToAppShouldTerminate(final boolean shouldTerminate); |
| private static native void nativeRegisterForNotification(final int notification); |
| |
| final static _AppEventHandler instance = new _AppEventHandler(); |
| static _AppEventHandler getInstance() { |
| return instance; |
| } |
| |
| // single shot dispatchers (some queuing, others not) |
| final _AboutDispatcher aboutDispatcher = new _AboutDispatcher(); |
| final _PreferencesDispatcher preferencesDispatcher = new _PreferencesDispatcher(); |
| final _OpenFileDispatcher openFilesDispatcher = new _OpenFileDispatcher(); |
| final _PrintFileDispatcher printFilesDispatcher = new _PrintFileDispatcher(); |
| final _OpenURIDispatcher openURIDispatcher = new _OpenURIDispatcher(); |
| final _QuitDispatcher quitDispatcher = new _QuitDispatcher(); |
| final _OpenAppDispatcher openAppDispatcher = new _OpenAppDispatcher(); |
| |
| // multiplexing dispatchers (contains listener lists) |
| final _AppReOpenedDispatcher reOpenAppDispatcher = new _AppReOpenedDispatcher(); |
| final _AppForegroundDispatcher foregroundAppDispatcher = new _AppForegroundDispatcher(); |
| final _HiddenAppDispatcher hiddenAppDispatcher = new _HiddenAppDispatcher(); |
| final _UserSessionDispatcher userSessionDispatcher = new _UserSessionDispatcher(); |
| final _ScreenSleepDispatcher screenSleepDispatcher = new _ScreenSleepDispatcher(); |
| final _SystemSleepDispatcher systemSleepDispatcher = new _SystemSleepDispatcher(); |
| |
| final _AppEventLegacyHandler legacyHandler = new _AppEventLegacyHandler(this); |
| |
| QuitStrategy defaultQuitAction = QuitStrategy.SYSTEM_EXIT_0; |
| |
| _AppEventHandler() { |
| final String strategyProp = System.getProperty("apple.eawt.quitStrategy"); |
| if (strategyProp == null) return; |
| |
| if ("CLOSE_ALL_WINDOWS".equals(strategyProp)) { |
| setDefaultQuitStrategy(QuitStrategy.CLOSE_ALL_WINDOWS); |
| } else if ("SYSTEM_EXIT_O".equals(strategyProp)) { |
| setDefaultQuitStrategy(QuitStrategy.SYSTEM_EXIT_0); |
| } else { |
| System.err.println("unrecognized apple.eawt.quitStrategy: " + strategyProp); |
| } |
| } |
| |
| void addListener(final AppEventListener listener) { |
| if (listener instanceof AppReOpenedListener) reOpenAppDispatcher.addListener((AppReOpenedListener)listener); |
| if (listener instanceof AppForegroundListener) foregroundAppDispatcher.addListener((AppForegroundListener)listener); |
| if (listener instanceof AppHiddenListener) hiddenAppDispatcher.addListener((AppHiddenListener)listener); |
| if (listener instanceof UserSessionListener) userSessionDispatcher.addListener((UserSessionListener)listener); |
| if (listener instanceof ScreenSleepListener) screenSleepDispatcher.addListener((ScreenSleepListener)listener); |
| if (listener instanceof SystemSleepListener) systemSleepDispatcher.addListener((SystemSleepListener)listener); |
| } |
| |
| void removeListener(final AppEventListener listener) { |
| if (listener instanceof AppReOpenedListener) reOpenAppDispatcher.removeListener((AppReOpenedListener)listener); |
| if (listener instanceof AppForegroundListener) foregroundAppDispatcher.removeListener((AppForegroundListener)listener); |
| if (listener instanceof AppHiddenListener) hiddenAppDispatcher.removeListener((AppHiddenListener)listener); |
| if (listener instanceof UserSessionListener) userSessionDispatcher.removeListener((UserSessionListener)listener); |
| if (listener instanceof ScreenSleepListener) screenSleepDispatcher.removeListener((ScreenSleepListener)listener); |
| if (listener instanceof SystemSleepListener) systemSleepDispatcher.removeListener((SystemSleepListener)listener); |
| } |
| |
| void openCocoaAboutWindow() { |
| nativeOpenCocoaAboutWindow(); |
| } |
| |
| void setDefaultQuitStrategy(final QuitStrategy defaultQuitAction) { |
| this.defaultQuitAction = defaultQuitAction; |
| } |
| |
| QuitResponse currentQuitResponse; |
| synchronized QuitResponse obtainQuitResponse() { |
| if (currentQuitResponse != null) return currentQuitResponse; |
| return currentQuitResponse = new QuitResponse(this); |
| } |
| |
| synchronized void cancelQuit() { |
| currentQuitResponse = null; |
| nativeReplyToAppShouldTerminate(false); |
| } |
| |
| synchronized void performQuit() { |
| currentQuitResponse = null; |
| |
| try { |
| if (defaultQuitAction == QuitStrategy.SYSTEM_EXIT_0) System.exit(0); |
| |
| if (defaultQuitAction != QuitStrategy.CLOSE_ALL_WINDOWS) { |
| throw new RuntimeException("Unknown quit action"); |
| } |
| |
| EventQueue.invokeLater(new Runnable() { |
| public void run() { |
| // walk frames from back to front |
| final Frame[] allFrames = Frame.getFrames(); |
| for (int i = allFrames.length - 1; i >= 0; i--) { |
| final Frame frame = allFrames[i]; |
| frame.dispatchEvent(new WindowEvent(frame, WindowEvent.WINDOW_CLOSING)); |
| } |
| } |
| }); |
| } finally { |
| // Either we've just called System.exit(), or the app will call |
| // it when processing a WINDOW_CLOSING event. Either way, we reply |
| // to Cocoa that we don't want to exit the event loop yet. |
| nativeReplyToAppShouldTerminate(false); |
| } |
| } |
| |
| /* |
| * callbacks from native delegate |
| */ |
| private static void handlePrintFiles(final List<String> filenames) { |
| instance.printFilesDispatcher.dispatch(new _NativeEvent(filenames)); |
| } |
| |
| private static void handleOpenFiles(final List<String> filenames, final String searchTerm) { |
| instance.openFilesDispatcher.dispatch(new _NativeEvent(filenames, searchTerm)); |
| } |
| |
| private static void handleOpenURI(final String uri) { |
| instance.openURIDispatcher.dispatch(new _NativeEvent(uri)); |
| } |
| |
| // default funnel for non-complex events |
| private static void handleNativeNotification(final int code) { |
| // System.out.println(code); |
| |
| switch (code) { |
| case NOTIFY_ABOUT: |
| instance.aboutDispatcher.dispatch(new _NativeEvent()); |
| break; |
| case NOTIFY_PREFS: |
| instance.preferencesDispatcher.dispatch(new _NativeEvent()); |
| break; |
| case NOTIFY_OPEN_APP: |
| instance.openAppDispatcher.dispatch(new _NativeEvent()); |
| break; |
| case NOTIFY_REOPEN_APP: |
| instance.reOpenAppDispatcher.dispatch(new _NativeEvent()); |
| break; |
| case NOTIFY_QUIT: |
| instance.quitDispatcher.dispatch(new _NativeEvent()); |
| break; |
| case NOTIFY_SHUTDOWN: |
| // do nothing for now |
| break; |
| case NOTIFY_ACTIVE_APP_GAINED: |
| instance.foregroundAppDispatcher.dispatch(new _NativeEvent(Boolean.TRUE)); |
| break; |
| case NOTIFY_ACTIVE_APP_LOST: |
| instance.foregroundAppDispatcher.dispatch(new _NativeEvent(Boolean.FALSE)); |
| break; |
| case NOTIFY_APP_HIDDEN: |
| instance.hiddenAppDispatcher.dispatch(new _NativeEvent(Boolean.TRUE)); |
| break; |
| case NOTIFY_APP_SHOWN: |
| instance.hiddenAppDispatcher.dispatch(new _NativeEvent(Boolean.FALSE)); |
| break; |
| case NOTIFY_USER_SESSION_ACTIVE: |
| instance.userSessionDispatcher.dispatch(new _NativeEvent(Boolean.TRUE)); |
| break; |
| case NOTIFY_USER_SESSION_INACTIVE: |
| instance.userSessionDispatcher.dispatch(new _NativeEvent(Boolean.FALSE)); |
| break; |
| case NOTIFY_SCREEN_SLEEP: |
| instance.screenSleepDispatcher.dispatch(new _NativeEvent(Boolean.TRUE)); |
| break; |
| case NOTIFY_SCREEN_WAKE: |
| instance.screenSleepDispatcher.dispatch(new _NativeEvent(Boolean.FALSE)); |
| break; |
| case NOTIFY_SYSTEM_SLEEP: |
| instance.systemSleepDispatcher.dispatch(new _NativeEvent(Boolean.TRUE)); |
| break; |
| case NOTIFY_SYSTEM_WAKE: |
| instance.systemSleepDispatcher.dispatch(new _NativeEvent(Boolean.FALSE)); |
| break; |
| default: |
| System.err.println("EAWT unknown native notification: " + code); |
| break; |
| } |
| } |
| |
| |
| class _AboutDispatcher extends _AppEventDispatcher<AboutHandler> { |
| void performDefaultAction(final _NativeEvent event) { |
| openCocoaAboutWindow(); // if the handler is null, fall back to showing the Cocoa default |
| } |
| |
| void performUsing(final AboutHandler handler, final _NativeEvent event) { |
| handler.handleAbout(new AboutEvent()); |
| } |
| } |
| |
| class _PreferencesDispatcher extends _AppEventDispatcher<PreferencesHandler> { |
| synchronized void setHandler(final PreferencesHandler handler) { |
| super.setHandler(handler); |
| |
| _AppMenuBarHandler.getInstance().setPreferencesMenuItemVisible(handler != null); |
| _AppMenuBarHandler.getInstance().setPreferencesMenuItemEnabled(handler != null); |
| } |
| |
| void performUsing(final PreferencesHandler handler, final _NativeEvent event) { |
| handler.handlePreferences(new PreferencesEvent()); |
| } |
| } |
| |
| class _OpenAppDispatcher extends _QueuingAppEventDispatcher<com.apple.eawt._OpenAppHandler> { |
| void performUsing(com.apple.eawt._OpenAppHandler handler, _NativeEvent event) { |
| handler.handleOpenApp(); |
| } |
| } |
| |
| class _AppReOpenedDispatcher extends _AppEventMultiplexor<AppReOpenedListener> { |
| void performOnListener(AppReOpenedListener listener, final _NativeEvent event) { |
| final AppReOpenedEvent e = new AppReOpenedEvent(); |
| listener.appReOpened(e); |
| } |
| } |
| |
| class _AppForegroundDispatcher extends _BooleanAppEventMultiplexor<AppForegroundListener, AppForegroundEvent> { |
| AppForegroundEvent createEvent(final boolean isTrue) { return new AppForegroundEvent(); } |
| |
| void performFalseEventOn(final AppForegroundListener listener, final AppForegroundEvent e) { |
| listener.appMovedToBackground(e); |
| } |
| |
| void performTrueEventOn(final AppForegroundListener listener, final AppForegroundEvent e) { |
| listener.appRaisedToForeground(e); |
| } |
| } |
| |
| class _HiddenAppDispatcher extends _BooleanAppEventMultiplexor<AppHiddenListener, AppHiddenEvent> { |
| AppHiddenEvent createEvent(final boolean isTrue) { return new AppHiddenEvent(); } |
| |
| void performFalseEventOn(final AppHiddenListener listener, final AppHiddenEvent e) { |
| listener.appUnhidden(e); |
| } |
| |
| void performTrueEventOn(final AppHiddenListener listener, final AppHiddenEvent e) { |
| listener.appHidden(e); |
| } |
| } |
| |
| class _UserSessionDispatcher extends _BooleanAppEventMultiplexor<UserSessionListener, UserSessionEvent> { |
| UserSessionEvent createEvent(final boolean isTrue) { return new UserSessionEvent(); } |
| |
| void performFalseEventOn(final UserSessionListener listener, final UserSessionEvent e) { |
| listener.userSessionDeactivated(e); |
| } |
| |
| void performTrueEventOn(final UserSessionListener listener, final UserSessionEvent e) { |
| listener.userSessionActivated(e); |
| } |
| |
| void registerNativeListener() { |
| nativeRegisterForNotification(REGISTER_USER_SESSION); |
| } |
| } |
| |
| class _ScreenSleepDispatcher extends _BooleanAppEventMultiplexor<ScreenSleepListener, ScreenSleepEvent> { |
| ScreenSleepEvent createEvent(final boolean isTrue) { return new ScreenSleepEvent(); } |
| |
| void performFalseEventOn(final ScreenSleepListener listener, final ScreenSleepEvent e) { |
| listener.screenAwoke(e); |
| } |
| |
| void performTrueEventOn(final ScreenSleepListener listener, final ScreenSleepEvent e) { |
| listener.screenAboutToSleep(e); |
| } |
| |
| void registerNativeListener() { |
| nativeRegisterForNotification(REGISTER_SCREEN_SLEEP); |
| } |
| } |
| |
| class _SystemSleepDispatcher extends _BooleanAppEventMultiplexor<SystemSleepListener, SystemSleepEvent> { |
| SystemSleepEvent createEvent(final boolean isTrue) { return new SystemSleepEvent(); } |
| |
| void performFalseEventOn(final SystemSleepListener listener, final SystemSleepEvent e) { |
| listener.systemAwoke(e); |
| } |
| |
| void performTrueEventOn(final SystemSleepListener listener, final SystemSleepEvent e) { |
| listener.systemAboutToSleep(e); |
| } |
| |
| void registerNativeListener() { |
| nativeRegisterForNotification(REGISTER_SYSTEM_SLEEP); |
| } |
| } |
| |
| class _OpenFileDispatcher extends _QueuingAppEventDispatcher<OpenFilesHandler> { |
| void performUsing(final OpenFilesHandler handler, final _NativeEvent event) { |
| // create file list from fileNames |
| final List<String> fileNameList = event.get(0); |
| final ArrayList<File> files = new ArrayList<File>(fileNameList.size()); |
| for (final String fileName : fileNameList) files.add(new File(fileName)); |
| |
| // populate the properties map |
| final String searchTerm = event.get(1); |
| handler.openFiles(new OpenFilesEvent(files, searchTerm)); |
| } |
| } |
| |
| class _PrintFileDispatcher extends _QueuingAppEventDispatcher<PrintFilesHandler> { |
| void performUsing(final PrintFilesHandler handler, final _NativeEvent event) { |
| // create file list from fileNames |
| final List<String> fileNameList = event.get(0); |
| final ArrayList<File> files = new ArrayList<File>(fileNameList.size()); |
| for (final String fileName : fileNameList) files.add(new File(fileName)); |
| |
| handler.printFiles(new PrintFilesEvent(files)); |
| } |
| } |
| |
| // Java URLs can't handle unknown protocol types, which is why we use URIs |
| class _OpenURIDispatcher extends _QueuingAppEventDispatcher<OpenURIHandler> { |
| void performUsing(final OpenURIHandler handler, final _NativeEvent event) { |
| final String urlString = event.get(0); |
| try { |
| handler.openURI(new OpenURIEvent(new URI(urlString))); |
| } catch (final URISyntaxException e) { |
| throw new RuntimeException(e); |
| } |
| } |
| } |
| |
| class _QuitDispatcher extends _AppEventDispatcher<QuitHandler> { |
| void performDefaultAction(final _NativeEvent event) { |
| obtainQuitResponse().performQuit(); |
| } |
| |
| void performUsing(final QuitHandler handler, final _NativeEvent event) { |
| final QuitResponse response = obtainQuitResponse(); // obtains the "current" quit response |
| handler.handleQuitRequestWith(new QuitEvent(), response); |
| } |
| } |
| |
| |
| // -- ABSTRACT QUEUE/EVENT/LISTENER HELPERS -- |
| |
| // generic little "raw event" that's constructed easily from the native callbacks |
| static class _NativeEvent { |
| Object[] args; |
| |
| public _NativeEvent(final Object... args) { |
| this.args = args; |
| } |
| |
| @SuppressWarnings("unchecked") |
| <T> T get(final int i) { |
| if (args == null) return null; |
| return (T)args[i]; |
| } |
| } |
| |
| abstract class _AppEventMultiplexor<L> { |
| private final Map<L, AppContext> listenerToAppContext = |
| new IdentityHashMap<L, AppContext>(); |
| boolean nativeListenerRegistered; |
| |
| // called from AppKit Thread-0 |
| void dispatch(final _NativeEvent event, final Object... args) { |
| // grab a local ref to the listeners and its contexts as an array of the map's entries |
| final ArrayList<Map.Entry<L, AppContext>> localEntries; |
| synchronized (this) { |
| if (listenerToAppContext.size() == 0) { |
| return; |
| } |
| localEntries = new ArrayList<Map.Entry<L, AppContext>>(listenerToAppContext.size()); |
| localEntries.addAll(listenerToAppContext.entrySet()); |
| } |
| |
| for (final Map.Entry<L, AppContext> e : localEntries) { |
| final L listener = e.getKey(); |
| final AppContext listenerContext = e.getValue(); |
| SunToolkit.invokeLaterOnAppContext(listenerContext, new Runnable() { |
| public void run() { |
| performOnListener(listener, event); |
| } |
| }); |
| } |
| } |
| |
| synchronized void addListener(final L listener) { |
| setListenerContext(listener, AppContext.getAppContext()); |
| |
| if (!nativeListenerRegistered) { |
| registerNativeListener(); |
| nativeListenerRegistered = true; |
| } |
| } |
| |
| synchronized void removeListener(final L listener) { |
| listenerToAppContext.remove(listener); |
| } |
| |
| abstract void performOnListener(L listener, final _NativeEvent event); |
| void registerNativeListener() { } |
| |
| private void setListenerContext(L listener, AppContext listenerContext) { |
| if (listenerContext == null) { |
| throw new RuntimeException( |
| "Attempting to add a listener from a thread group without AppContext"); |
| } |
| listenerToAppContext.put(listener, AppContext.getAppContext()); |
| } |
| } |
| |
| abstract class _BooleanAppEventMultiplexor<L, E> extends _AppEventMultiplexor<L> { |
| @Override |
| void performOnListener(L listener, final _NativeEvent event) { |
| final boolean isTrue = Boolean.TRUE.equals(event.get(0)); |
| final E e = createEvent(isTrue); |
| if (isTrue) { |
| performTrueEventOn(listener, e); |
| } else { |
| performFalseEventOn(listener, e); |
| } |
| } |
| |
| abstract E createEvent(final boolean isTrue); |
| abstract void performTrueEventOn(final L listener, final E e); |
| abstract void performFalseEventOn(final L listener, final E e); |
| } |
| |
| /* |
| * Ensures that setting and obtaining an app event handler is done in |
| * both a thread-safe manner, and that user code is performed on the |
| * AWT EventQueue thread. |
| * |
| * Allows native to blindly lob new events into the dispatcher, |
| * knowing that they will only be dispatched once a handler is set. |
| * |
| * User code is not (and should not be) run under any synchronized lock. |
| */ |
| abstract class _AppEventDispatcher<H> { |
| H _handler; |
| AppContext handlerContext; |
| |
| // called from AppKit Thread-0 |
| void dispatch(final _NativeEvent event) { |
| // grab a local ref to the handler |
| final H localHandler; |
| final AppContext localHandlerContext; |
| synchronized (_AppEventDispatcher.this) { |
| localHandler = _handler; |
| localHandlerContext = handlerContext; |
| } |
| |
| if (localHandler == null) { |
| performDefaultAction(event); |
| } else { |
| SunToolkit.invokeLaterOnAppContext(localHandlerContext, new Runnable() { |
| public void run() { |
| performUsing(localHandler, event); |
| } |
| }); |
| } |
| } |
| |
| synchronized void setHandler(final H handler) { |
| this._handler = handler; |
| |
| setHandlerContext(AppContext.getAppContext()); |
| |
| // if a new handler is installed, block addition of legacy ApplicationListeners |
| if (handler == legacyHandler) return; |
| legacyHandler.blockLegacyAPI(); |
| } |
| |
| void performDefaultAction(final _NativeEvent event) { } // by default, do nothing |
| abstract void performUsing(final H handler, final _NativeEvent event); |
| |
| protected void setHandlerContext(AppContext ctx) { |
| if (ctx == null) { |
| throw new RuntimeException( |
| "Attempting to set a handler from a thread group without AppContext"); |
| } |
| |
| handlerContext = ctx; |
| } |
| } |
| |
| abstract class _QueuingAppEventDispatcher<H> extends _AppEventDispatcher<H> { |
| List<_NativeEvent> queuedEvents = new LinkedList<_NativeEvent>(); |
| |
| @Override |
| void dispatch(final _NativeEvent event) { |
| synchronized (this) { |
| // dispatcher hasn't started yet |
| if (queuedEvents != null) { |
| queuedEvents.add(event); |
| return; |
| } |
| } |
| |
| super.dispatch(event); |
| } |
| |
| synchronized void setHandler(final H handler) { |
| this._handler = handler; |
| |
| setHandlerContext(AppContext.getAppContext()); |
| |
| // dispatch any events in the queue |
| if (queuedEvents != null) { |
| // grab a local ref to the queue, so the real one can be nulled out |
| final java.util.List<_NativeEvent> localQueuedEvents = queuedEvents; |
| queuedEvents = null; |
| if (localQueuedEvents.size() != 0) { |
| for (final _NativeEvent arg : localQueuedEvents) { |
| dispatch(arg); |
| } |
| } |
| } |
| |
| // if a new handler is installed, block addition of legacy ApplicationListeners |
| if (handler == legacyHandler) return; |
| legacyHandler.blockLegacyAPI(); |
| } |
| } |
| } |