com.sun.glass.ui.mac.MacApplication Maven / Gradle / Ivy
The newest version!
/*
* Copyright (c) 2010, 2024, 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.sun.glass.ui.mac;
import com.sun.glass.events.KeyEvent;
import com.sun.glass.ui.*;
import com.sun.glass.ui.CommonDialogs.ExtensionFilter;
import com.sun.glass.ui.CommonDialogs.FileChooserResult;
import com.sun.javafx.application.preferences.PreferenceMapping;
import com.sun.javafx.util.Logging;
import javafx.scene.paint.Color;
import java.io.File;
import java.nio.ByteBuffer;
import java.nio.IntBuffer;
import java.security.AccessController;
import java.security.PrivilegedAction;
import java.util.Map;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;
final class MacApplication extends Application implements InvokeLaterDispatcher.InvokeLaterSubmitter {
private native static void _initIDs(boolean disableSyncRendering);
static {
@SuppressWarnings("removal")
var dummy = AccessController.doPrivileged((PrivilegedAction) () -> {
Application.loadNativeLibrary();
return null;
});
@SuppressWarnings("removal")
boolean disableSyncRendering = AccessController
.doPrivileged((PrivilegedAction) () ->
Boolean.getBoolean("glass.disableSyncRendering"));
_initIDs(disableSyncRendering);
}
native static int _getMacKey(int code);
private String applicationClassName;
private boolean isTaskbarApplication = false;
private final InvokeLaterDispatcher invokeLaterDispatcher;
private static final CountDownLatch keepAliveLatch = new CountDownLatch(1);
/**
* Starts a non-daemon KeepAlive thread to ensure that the
* JavaFX toolkit keeps running until the toolkit exits. On
* other platforms, the JavaFX Application Thread is created
* as a non-daemon Java thread when the toolkit starts. On
* macOS, we use the existing AppKit thread as the JavaFX
* Application thread, and attach it to the JVM as a daemon
* thread. In the case of Swing / JavaFX interop, AWT attaches
* the AppKit thread as a daemon thread. Since there is no other
* non-daemon thread, we create one so that the JavaFX toolkit
* will not exit prematurely.
*/
private static void startKeepAliveThread() {
Thread thr = new Thread(() -> {
try {
keepAliveLatch.await();
} catch (InterruptedException ex) {
throw new RuntimeException("Unexpected exception: ", ex);
}
});
thr.setName("JavaFX-KeepAlive");
thr.setDaemon(false);
thr.start();
}
/**
* Terminates the KeepAlive thread.
*/
private static void finishKeepAliveThread() {
keepAliveLatch.countDown();
}
MacApplication() {
// Embedded in SWT, with shared event thread
@SuppressWarnings("removal")
boolean isEventThread = AccessController
.doPrivileged((PrivilegedAction) () -> Boolean.getBoolean("javafx.embed.isEventThread"));
if (!isEventThread) {
invokeLaterDispatcher = new InvokeLaterDispatcher(this);
invokeLaterDispatcher.start();
} else {
invokeLaterDispatcher = null;
}
}
private Menu appleMenu;
native void _runLoop(ClassLoader classLoader, Runnable launchable,
boolean isTaskbarApplication);
@Override
protected void runLoop(final Runnable launchable) {
// For normal (not embedded) taskbar applications the masOS activation
// init code will deactivate and then reactivate the application to
// allow the system menubar to work properly.
// We need to spin up a nested event loop and wait for the reactivation
// to finish prior to allowing the rest of the initialization to run.
final Runnable wrappedRunnable = () -> {
if (isTriggerReactivation()) {
waitForReactivation();
}
applicationClassName = _getApplicationClassName();
launchable.run();
};
@SuppressWarnings("removal")
boolean tmp =
AccessController.doPrivileged((PrivilegedAction) () -> {
String taskbarAppProp = System.getProperty("glass.taskbarApplication");
return !"false".equalsIgnoreCase(taskbarAppProp);
});
isTaskbarApplication = tmp;
// Create a non-daemon KeepAlive thread so the FX toolkit
// doesn't exit prematurely.
startKeepAliveThread();
ClassLoader classLoader = MacApplication.class.getClassLoader();
_runLoop(classLoader, wrappedRunnable, isTaskbarApplication);
}
private final CountDownLatch reactivationLatch = new CountDownLatch(1);
// Spin up a nested event loop waiting for the app reactivation event
void waitForReactivation() {
final EventLoop eventLoop = createEventLoop();
Thread thr = new Thread(() -> {
try {
if (!reactivationLatch.await(5, TimeUnit.SECONDS)) {
Logging.getJavaFXLogger().warning("Timeout while waiting for app reactivation");
}
} catch (InterruptedException ex) {
Logging.getJavaFXLogger().warning("Exception while waiting for app reactivation: " + ex);
}
Application.invokeLater(() -> {
eventLoop.leave(null);
});
});
thr.setDaemon(true);
thr.start();
eventLoop.enter();
}
native private void _finishTerminating();
@Override
protected void finishTerminating() {
_finishTerminating();
finishKeepAliveThread();
super.finishTerminating();
}
private void notifyApplicationDidTerminate() {
setEventThread(null);
}
private boolean firstDidResignActive = false;
@Override
protected void notifyDidResignActive() {
firstDidResignActive = true;
super.notifyDidResignActive();
}
@Override
protected void notifyDidBecomeActive() {
if (firstDidResignActive) {
reactivationLatch.countDown();
}
super.notifyDidBecomeActive();
}
// Called from the native code
private void setEventThread() {
setEventThread(Thread.currentThread());
}
native private Object _enterNestedEventLoopImpl();
@Override protected Object _enterNestedEventLoop() {
if (invokeLaterDispatcher != null) {
invokeLaterDispatcher.notifyEnteringNestedEventLoop();
}
try {
return _enterNestedEventLoopImpl();
} finally {
if (invokeLaterDispatcher != null) {
invokeLaterDispatcher.notifyLeftNestedEventLoop();
}
}
}
native private void _leaveNestedEventLoopImpl(Object retValue);
@Override protected void _leaveNestedEventLoop(Object retValue) {
if (invokeLaterDispatcher != null) {
invokeLaterDispatcher.notifyLeavingNestedEventLoop();
}
_leaveNestedEventLoopImpl(retValue);
}
native private void _hide();
native private void _hideOtherApplications();
native private void _unhideAllApplications();
public void installAppleMenu(MenuBar menubar) {
this.appleMenu = createMenu("Apple");
MenuItem hideMenu = createMenuItem("Hide " + getName(), new MenuItem.Callback() {
@Override public void action() {
MacApplication.this._hide();
}
@Override public void validate() {
}
}, 'h', KeyEvent.MODIFIER_COMMAND);
this.appleMenu.add(hideMenu);
MenuItem hideOthersMenu = createMenuItem("Hide Others", new MenuItem.Callback() {
@Override public void action() {
MacApplication.this._hideOtherApplications();
}
@Override public void validate() {
}
}, 'h', KeyEvent.MODIFIER_COMMAND | KeyEvent.MODIFIER_ALT);
this.appleMenu.add(hideOthersMenu);
MenuItem unhideAllMenu = createMenuItem("Show All", new MenuItem.Callback() {
@Override public void action() {
MacApplication.this._unhideAllApplications();
}
@Override public void validate() {
}
});
this.appleMenu.add(unhideAllMenu);
this.appleMenu.add(MenuItem.Separator);
MenuItem quitMenu = createMenuItem("Quit " + getName(), new MenuItem.Callback() {
@Override public void action() {
Application.EventHandler eh = getEventHandler();
if (eh != null) {
eh.handleQuitAction(Application.GetApplication(), System.nanoTime());
}
}
@Override public void validate() {
}
}, 'q', KeyEvent.MODIFIER_COMMAND);
this.appleMenu.add(quitMenu);
menubar.add(this.appleMenu);
}
public Menu getAppleMenu() {
return this.appleMenu;
}
@Override public void installDefaultMenus(MenuBar menubar) {
installAppleMenu(menubar);
}
// FACTORY METHODS
@Override public Window createWindow(Window owner, Screen screen, int styleMask) {
return new MacWindow(owner, screen, styleMask);
}
@Override public View createView() {
return new MacView();
}
@Override public Cursor createCursor(int type) {
return new MacCursor(type);
}
@Override public Cursor createCursor(int x, int y, Pixels pixels) {
return new MacCursor(x, y, pixels);
}
@Override protected void staticCursor_setVisible(boolean visible) {
MacCursor.setVisible_impl(visible);
}
@Override protected Size staticCursor_getBestSize(int width, int height) {
return MacCursor.getBestSize_impl(width, height);
}
@Override public Pixels createPixels(int width, int height, ByteBuffer data) {
return new MacPixels(width, height, data);
}
@Override public Pixels createPixels(int width, int height, ByteBuffer data, float scalex, float scaley) {
return new MacPixels(width, height, data, scalex, scaley);
}
@Override public Pixels createPixels(int width, int height, IntBuffer data) {
return new MacPixels(width, height, data);
}
@Override
public Pixels createPixels(int width, int height, IntBuffer data, float scalex, float scaley) {
return new MacPixels(width, height, data, scalex, scaley);
}
@Override protected int staticPixels_getNativeFormat() {
return MacPixels.getNativeFormat_impl();
}
@Override public GlassRobot createRobot() {
return new MacRobot();
}
@Override native protected double staticScreen_getVideoRefreshPeriod();
@Override native protected Screen[] staticScreen_getScreens();
@Override public Timer createTimer(Runnable runnable) {
return new MacTimer(runnable);
}
@Override protected int staticTimer_getMinPeriod() {
return MacTimer.getMinPeriod_impl();
}
@Override protected int staticTimer_getMaxPeriod() {
return MacTimer.getMaxPeriod_impl();
}
@Override public Accessible createAccessible() {
return new MacAccessible();
}
@Override protected FileChooserResult staticCommonDialogs_showFileChooser(Window owner, String folder, String filename, String title, int type,
boolean multipleMode, ExtensionFilter[] extensionFilters, int defaultFilterIndex) {
return MacCommonDialogs.showFileChooser_impl(owner, folder, filename,
title, type, multipleMode, extensionFilters, defaultFilterIndex);
}
@Override protected File staticCommonDialogs_showFolderChooser(Window owner, String folder, String title) {
return MacCommonDialogs.showFolderChooser_impl(owner, folder, title);
}
@Override protected long staticView_getMultiClickTime() {
return MacView.getMultiClickTime_impl();
}
@Override protected int staticView_getMultiClickMaxX() {
return MacView.getMultiClickMaxX_impl();
}
@Override protected int staticView_getMultiClickMaxY() {
return MacView.getMultiClickMaxY_impl();
}
@Override native protected void _invokeAndWait(Runnable runnable);
private native void _submitForLaterInvocation(Runnable r);
// InvokeLaterDispatcher.InvokeLaterSubmitter
@Override public void submitForLaterInvocation(Runnable r) {
_submitForLaterInvocation(r);
}
@Override protected void _invokeLater(Runnable runnable) {
if (invokeLaterDispatcher != null) {
invokeLaterDispatcher.invokeLater(runnable);
} else {
submitForLaterInvocation(runnable);
}
}
@Override
protected boolean _supportsInputMethods() {
return true;
}
@Override
protected boolean _supportsTransparentWindows() {
return true;
}
@Override protected boolean _supportsUnifiedWindows() {
return true;
}
@Override native protected boolean _supportsSystemMenu();
// NOTE: this will not return a valid result until the native _runloop
// method has been executed and called the Runnable passed to that method.
native private boolean _isTriggerReactivation();
boolean isTriggerReactivation() {
return _isTriggerReactivation();
}
private native String _getDataDirectory();
@Override
public String getDataDirectory() {
checkEventThread();
String baseDirectory = _getDataDirectory();
if (baseDirectory == null || baseDirectory.length() == 0) {
return super.getDataDirectory();
}
return baseDirectory + File.separator + name + File.separator;
}
@Override
protected native int _getKeyCodeForChar(char c, int hint);
@Override
protected native int _isKeyLocked(int keyCode);
private native String _getApplicationClassName();
@Override
public native Map getPlatformPreferences();
@Override
public Map> getPlatformKeyMappings() {
return Map.of(
"macOS.NSColor.textColor", new PreferenceMapping<>("foregroundColor", Color.class),
"macOS.NSColor.textBackgroundColor", new PreferenceMapping<>("backgroundColor", Color.class),
"macOS.NSColor.controlAccentColor", new PreferenceMapping<>("accentColor", Color.class),
"macOS.NSWorkspace.accessibilityDisplayShouldReduceMotion", new PreferenceMapping<>("reducedMotion", Boolean.class),
"macOS.NSWorkspace.accessibilityDisplayShouldReduceTransparency", new PreferenceMapping<>("reducedTransparency", Boolean.class)
);
}
// This list needs to be kept in sync with PlatformSupport.m in the Glass toolkit for macOS.
@Override
public Map> getPlatformKeys() {
return Map.ofEntries(
Map.entry("macOS.NSColor.labelColor", Color.class),
Map.entry("macOS.NSColor.secondaryLabelColor", Color.class),
Map.entry("macOS.NSColor.tertiaryLabelColor", Color.class),
Map.entry("macOS.NSColor.quaternaryLabelColor", Color.class),
Map.entry("macOS.NSColor.textColor", Color.class),
Map.entry("macOS.NSColor.placeholderTextColor", Color.class),
Map.entry("macOS.NSColor.selectedTextColor", Color.class),
Map.entry("macOS.NSColor.textBackgroundColor", Color.class),
Map.entry("macOS.NSColor.selectedTextBackgroundColor", Color.class),
Map.entry("macOS.NSColor.keyboardFocusIndicatorColor", Color.class),
Map.entry("macOS.NSColor.unemphasizedSelectedTextColor", Color.class),
Map.entry("macOS.NSColor.unemphasizedSelectedTextBackgroundColor", Color.class),
Map.entry("macOS.NSColor.linkColor", Color.class),
Map.entry("macOS.NSColor.separatorColor", Color.class),
Map.entry("macOS.NSColor.selectedContentBackgroundColor", Color.class),
Map.entry("macOS.NSColor.unemphasizedSelectedContentBackgroundColor", Color.class),
Map.entry("macOS.NSColor.selectedMenuItemTextColor", Color.class),
Map.entry("macOS.NSColor.gridColor", Color.class),
Map.entry("macOS.NSColor.headerTextColor", Color.class),
Map.entry("macOS.NSColor.alternatingContentBackgroundColors", Color[].class),
Map.entry("macOS.NSColor.controlAccentColor", Color.class),
Map.entry("macOS.NSColor.controlColor", Color.class),
Map.entry("macOS.NSColor.controlBackgroundColor", Color.class),
Map.entry("macOS.NSColor.controlTextColor", Color.class),
Map.entry("macOS.NSColor.disabledControlTextColor", Color.class),
Map.entry("macOS.NSColor.selectedControlColor", Color.class),
Map.entry("macOS.NSColor.selectedControlTextColor", Color.class),
Map.entry("macOS.NSColor.alternateSelectedControlTextColor", Color.class),
Map.entry("macOS.NSColor.currentControlTint", String.class),
Map.entry("macOS.NSColor.windowBackgroundColor", Color.class),
Map.entry("macOS.NSColor.windowFrameTextColor", Color.class),
Map.entry("macOS.NSColor.underPageBackgroundColor", Color.class),
Map.entry("macOS.NSColor.findHighlightColor", Color.class),
Map.entry("macOS.NSColor.highlightColor", Color.class),
Map.entry("macOS.NSColor.shadowColor", Color.class),
Map.entry("macOS.NSColor.systemBlueColor", Color.class),
Map.entry("macOS.NSColor.systemBrownColor", Color.class),
Map.entry("macOS.NSColor.systemGrayColor", Color.class),
Map.entry("macOS.NSColor.systemGreenColor", Color.class),
Map.entry("macOS.NSColor.systemIndigoColor", Color.class),
Map.entry("macOS.NSColor.systemOrangeColor", Color.class),
Map.entry("macOS.NSColor.systemPinkColor", Color.class),
Map.entry("macOS.NSColor.systemPurpleColor", Color.class),
Map.entry("macOS.NSColor.systemRedColor", Color.class),
Map.entry("macOS.NSColor.systemTealColor", Color.class),
Map.entry("macOS.NSColor.systemYellowColor", Color.class),
Map.entry("macOS.NSWorkspace.accessibilityDisplayShouldReduceMotion", Boolean.class),
Map.entry("macOS.NSWorkspace.accessibilityDisplayShouldReduceTransparency", Boolean.class)
);
}
private static final String SUPPRESS_AWT_WARNING_PROPERTY = "javafx.preferences.suppressAppleAwtWarning";
private static final String AWT_APPEARANCE_PROPERTY = "apple.awt.application.appearance";
private static final String AWT_APPLICATION_CLASS = "NSApplicationAWT";
private static final String AWT_SYSTEM_APPEARANCE = "system";
@SuppressWarnings("removal")
private boolean checkSystemAppearance = AccessController.doPrivileged(
(PrivilegedAction) () -> !Boolean.getBoolean(SUPPRESS_AWT_WARNING_PROPERTY));
@Override
public void checkPlatformPreferencesSupport() {
if (checkSystemAppearance && AWT_APPLICATION_CLASS.equals(applicationClassName)) {
@SuppressWarnings("removal")
String awtAppearanceProperty = AccessController.doPrivileged(
(PrivilegedAction) () -> System.getProperty(AWT_APPEARANCE_PROPERTY));
if (!AWT_SYSTEM_APPEARANCE.equals(awtAppearanceProperty)) {
Logging.getJavaFXLogger().warning(String.format(
"Reported preferences may not reflect macOS system preferences unless the system%n" +
"property %s=%s is set. This warning can be disabled by%n" +
"setting %s=true.",
AWT_APPEARANCE_PROPERTY,
AWT_SYSTEM_APPEARANCE,
SUPPRESS_AWT_WARNING_PROPERTY));
}
}
checkSystemAppearance = false;
}
}