8301302: Platform preferences API

modules/javafx.graphics/.classpath

@@ -30,7 +30,7 @@
 	<classpathentry combineaccessrules="false" kind="src" path="/base">
 		<attributes>
 			<attribute name="module" value="true"/>
-			<attribute name="add-exports" value="javafx.base/com.sun.javafx.property=javafx.graphics:javafx.base/test.util.memory=javafx.graphics"/>
+			<attribute name="add-exports" value="javafx.base/com.sun.javafx.property=javafx.graphics:javafx.base/test.javafx.collections=javafx.graphics:javafx.base/test.util.memory=javafx.graphics"/>
 		</attributes>
 	</classpathentry>
 	<classpathentry kind="con" path="org.eclipse.jdt.junit.JUNIT_CONTAINER/5">

modules/javafx.graphics/src/main/java/com/sun/glass/ui/Application.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2010, 2022, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2010, 2023, 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
@@ -84,8 +84,7 @@ public void handleOpenFilesAction(Application app, long time, String files[]) {
         // currently used only on Mac OS X
         public void handleQuitAction(Application app, long time) {
         }
-        public boolean handleThemeChanged(String themeName) {
-            return false;
+        public void handlePreferencesChanged(Map<String, Object> preferences) {
         }
     }
 
@@ -259,12 +258,11 @@ protected void notifyWillResignActive() {
         }
     }
 
-    protected boolean notifyThemeChanged(String themeName) {
+    protected void notifyPreferencesChanged(Map<String, Object> preferences) {
         EventHandler handler = getEventHandler();
         if (handler != null) {
-            return handler.handleThemeChanged(themeName);
+            handler.handlePreferencesChanged(preferences);
         }
-        return false;
     }
 
     protected void notifyDidResignActive() {
@@ -675,19 +673,6 @@ protected abstract FileChooserResult staticCommonDialogs_showFileChooser(Window
     protected abstract int staticView_getMultiClickMaxX();
     protected abstract int staticView_getMultiClickMaxY();
 
-    public String getHighContrastScheme(String themeName) {
-        return themeName;
-    }
-
-    /**
-     * Gets the Name of the currently active high contrast theme.
-     * If null, then high contrast is not enabled.
-     */
-    public String getHighContrastTheme() {
-        checkEventThread();
-        return null;
-    }
-
     protected boolean _supportsInputMethods() {
         // Overridden in subclasses
         return false;
@@ -768,4 +753,37 @@ public final Optional<Boolean> isKeyLocked(int keyCode) {
                 return Optional.empty();
         }
     }
+
+    /**
+     * Returns the current set of platform properties as a map of platform-specific keys to
+     * arbitrary values. Callers should assume that the returned map is immutable, while
+     * implementations should either return an immutable map, or give up ownership of the
+     * returned map.
+     *
+     * @return the current set of platform preferences
+     */
+    public Map<String, Object> getPlatformPreferences() {
+        return Map.of();
+    }
+
+    /**
+     * Returns a map of platform-specific preference keys to well-known keys.
+     * <p>
+     * For example, the platform-specific key "Windows.UIColor.Foreground" is mapped to the
+     * well-known key "foregroundColor", which makes it easier to write shared code without
+     * depending on platform-specific details.
+     * <p>
+     * The following well-known keys are currently supported, which correspond to the names of color
+     * properties on the {@link com.sun.javafx.application.preferences.PreferenceProperties} class:
+     * <ul>
+     *     <li>foregroundColor
+     *     <li>backgroundColor
+     *     <li>accentColor
+     * </ul>
+     *
+     * @return a map of platform-specific keys to well-known keys
+     */
+    public Map<String, String> getWellKnownPlatformPreferenceKeys() {
+        return Map.of();
+    }
 }

modules/javafx.graphics/src/main/java/com/sun/glass/ui/gtk/GtkApplication.java

@@ -467,4 +467,14 @@ protected boolean _supportsInputMethods() {
     @Override
     protected native int _isKeyLocked(int keyCode);
 
+    @Override
+    public native Map<String, Object> getPlatformPreferences();
+
+    @Override
+    public Map<String, String> getWellKnownPlatformPreferenceKeys() {
+        return Map.of(
+            "GTK.theme_fg_color", "foregroundColor",
+            "GTK.theme_bg_color", "backgroundColor"
+        );
+    }
 }

modules/javafx.graphics/src/main/java/com/sun/glass/ui/mac/MacApplication.java

@@ -36,6 +36,7 @@
 
 import java.security.AccessController;
 import java.security.PrivilegedAction;
+import java.util.Map;
 import java.util.concurrent.CountDownLatch;
 import java.util.concurrent.TimeUnit;
 
@@ -388,4 +389,16 @@ public String getDataDirectory() {
 
     @Override
     protected native int _isKeyLocked(int keyCode);
+
+    @Override
+    public native Map<String, Object> getPlatformPreferences();
+
+    @Override
+    public Map<String, String> getWellKnownPlatformPreferenceKeys() {
+        return Map.of(
+            "macOS.NSColor.textColor", "foregroundColor",
+            "macOS.NSColor.textBackgroundColor", "backgroundColor",
+            "macOS.NSColor.controlAccentColor", "accentColor"
+        );
+    }
 }

modules/javafx.graphics/src/main/java/com/sun/glass/ui/win/WinApplication.java

@@ -27,7 +27,6 @@
 import com.sun.glass.ui.*;
 import com.sun.glass.ui.CommonDialogs.ExtensionFilter;
 import com.sun.glass.ui.CommonDialogs.FileChooserResult;
-import com.sun.javafx.application.PlatformImpl;
 import com.sun.prism.impl.PrismSettings;
 import com.sun.javafx.tk.Toolkit;
 
@@ -36,12 +35,11 @@
 import java.nio.IntBuffer;
 import java.security.AccessController;
 import java.security.PrivilegedAction;
-import java.util.ResourceBundle;
+import java.util.Map;
 
 final class WinApplication extends Application implements InvokeLaterDispatcher.InvokeLaterSubmitter {
 
     static float overrideUIScale;
-    private static final String BASE_NAME = "com/sun/glass/ui/win/themes";
 
     private static boolean getBoolean(String propname, boolean defval, String description) {
         String str = System.getProperty(propname);
@@ -341,17 +339,6 @@ public Pixels createPixels(int width, int height, IntBuffer data, float scalex,
         }
     }
 
-    @Override
-    public String getHighContrastScheme(String themeName) {
-        return PlatformImpl.HighContrastScheme.fromThemeName(ResourceBundle.getBundle(BASE_NAME)::getString, themeName);
-    }
-
-    private native String _getHighContrastTheme();
-    @Override public String getHighContrastTheme() {
-        checkEventThread();
-        return getHighContrastScheme(_getHighContrastTheme());
-    }
-
     @Override
     protected boolean _supportsInputMethods() {
         return true;
@@ -380,4 +367,16 @@ public String getDataDirectory() {
 
     @Override
     protected native int _isKeyLocked(int keyCode);
+
+    @Override
+    public native Map<String, Object> getPlatformPreferences();
+
+    @Override
+    public Map<String, String> getWellKnownPlatformPreferenceKeys() {
+        return Map.of(
+            "Windows.UIColor.ForegroundColor", "foregroundColor",
+            "Windows.UIColor.BackgroundColor", "backgroundColor",
+            "Windows.UIColor.AccentColor", "accentColor"
+        );
+    }
 }

modules/javafx.graphics/src/main/java/com/sun/javafx/application/PlatformImpl.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2010, 2022, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2010, 2023, 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
@@ -27,6 +27,7 @@
 
 import static com.sun.javafx.FXPermissions.CREATE_TRANSPARENT_WINDOW_PERMISSION;
 import com.sun.javafx.PlatformUtil;
+import com.sun.javafx.application.preferences.PlatformPreferences;
 import com.sun.javafx.css.StyleManager;
 import com.sun.javafx.tk.TKListener;
 import com.sun.javafx.tk.TKStage;
@@ -1044,4 +1045,57 @@ private static boolean isSupportedImpl(ConditionalFeature feature) {
                 return Toolkit.getToolkit().isSupported(feature);
         }
     }
+
+    private static PlatformPreferences platformPreferences;
+
+    public static PlatformPreferences getPlatformPreferences() {
+        if (platformPreferences == null) {
+            throw new IllegalStateException("Toolkit not initialized");
+        }
+
+        return platformPreferences;
+    }
+
+    /**
+     * Called by Glass when the toolkit is initialized.
+     *
+     * @param wellKnownKeys a map of platform-specific keys to well-known keys
+     * @param preferences the initial set of platform preferences
+     */
+    public static void initPreferences(Map<String, String> wellKnownKeys, Map<String, Object> preferences) {
+        platformPreferences = new PlatformPreferences(wellKnownKeys);
+        platformPreferences.update(preferences);
+    }
+
+    /**
+     * Called by Glass when one or several platform preferences have changed.
+     * <p>
+     * This method can be called on any thread. The supplied {@code preferences} map may
+     * include all platform preferences, or only the changed preferences. If a preference
+     * was removed, the corresponding key is mapped to {@code null}.
+     *
+     * @param preferences a map that includes the changed preferences
+     */
+    public static void updatePreferences(Map<String, Object> preferences) {
+        if (isFxApplicationThread()) {
+            checkHighContrastThemeChanged(preferences);
+            platformPreferences.update(preferences);
+        } else {
+            // Make a defensive copy in case the caller of this method decides to re-use or
+            // modify its preferences map after the method returns. Don't use Map.copyOf
+            // because the preferences map may contain null values.
+            Map<String, Object> preferencesCopy = new HashMap<>(preferences);
+            runLater(() -> updatePreferences(preferencesCopy));
+        }
+    }
+
+    // This method will be removed when StyleThemes are added.
+    private static void checkHighContrastThemeChanged(Map<String, Object> preferences) {
+        if (preferences.get("Windows.SPI.HighContrastOn") == Boolean.TRUE) {
+            setAccessibilityTheme(preferences.get("Windows.SPI.HighContrastColorScheme") instanceof String s ? s : null);
+        } else {
+            setAccessibilityTheme(null);
+        }
+    }
+
 }

modules/javafx.graphics/src/main/java/com/sun/javafx/application/preferences/ChangedValue.java

@@ -0,0 +1,73 @@
+/*
+ * Copyright (c) 2023, 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.javafx.application.preferences;
+
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Objects;
+
+/**
+ * Contains information about a changed value.
+ */
+public record ChangedValue(Object oldValue, Object newValue) {
+
+    /**
+     * Returns a map that contains the new or changed mappings of {@code current} compared to {@code old}.
+     * A value has changed if {@link Objects#equals(Object, Object)} or {@link Arrays#equals(Object[], Object[])}
+     * returns {@code false} when invoked with the old and new value.
+     *
+     * @param old the old mappings
+     * @param current the current mappings
+     * @return a mapping of keys to changed values
+     */
+    public static Map<String, ChangedValue> getEffectiveChanges(Map<String, Object> old, Map<String, Object> current) {
+        Map<String, ChangedValue> changed = null;
+
+        for (Map.Entry<String, Object> entry : current.entrySet()) {
+            Object newValue = entry.getValue();
+            Object oldValue = old.get(entry.getKey());
+            boolean equals;
+
+            if (oldValue instanceof Object[] oldArray && newValue instanceof Object[] newArray) {
+                equals = Arrays.equals(oldArray, newArray);
+            } else {
+                equals = Objects.equals(oldValue, newValue);
+            }
+
+            if (!equals) {
+                if (changed == null) {
+                    changed = new HashMap<>();
+                }
+
+                changed.put(entry.getKey(), new ChangedValue(oldValue, newValue));
+            }
+        }
+
+        return changed != null ? changed : Map.of();
+    }
+
+}