com.sun.javafx.css.StyleManager Maven / Gradle / Ivy
Show all versions of openjfx-78-backport Show documentation
/*
* Copyright (c) 2010, 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.sun.javafx.css;
import javafx.css.Styleable;
import java.io.FileNotFoundException;
import java.io.FilePermission;
import java.io.IOException;
import java.lang.ref.Reference;
import java.lang.ref.WeakReference;
import java.net.MalformedURLException;
import java.net.URI;
import java.net.URL;
import java.security.AccessControlContext;
import java.security.AccessController;
import java.security.PermissionCollection;
import java.security.PrivilegedAction;
import java.security.PrivilegedActionException;
import java.security.PrivilegedExceptionAction;
import java.security.ProtectionDomain;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;
import javafx.collections.FXCollections;
import javafx.collections.ListChangeListener.Change;
import javafx.collections.ObservableList;
import javafx.scene.Node;
import javafx.scene.Parent;
import javafx.scene.Scene;
import javafx.scene.text.Font;
import javafx.stage.Window;
import com.sun.javafx.css.parser.CSSParser;
import java.util.Map.Entry;
import java.util.Set;
import java.util.WeakHashMap;
import javafx.css.CssMetaData;
import javafx.css.PseudoClass;
import javafx.css.StyleOrigin;
import javafx.scene.image.Image;
import javafx.stage.PopupWindow;
import javafx.util.Pair;
import sun.util.logging.PlatformLogger;
/**
* Contains the stylesheet state for a single scene. This includes both the
* Stylesheets defined on the Scene itself as well as a map of stylesheets for
* "style"s defined on the Node itself. These containers are kept in the
* containerMap, key'd by the Scene to which they belong. One of the key
* responsibilities of the StylesheetContainer is to create and maintain an
* admittedly elaborate series of caches so as to minimize the amount of time it
* takes to match a Node to its eventual StyleHelper, and to reuse the
* StyleHelper as much as possible.
Initially, the cache is empty. It is
* recreated whenever the userStylesheets on the container change, or whenever
* the userAgentStylesheet changes. The cache is built up as nodes are looked
* for, and thus there is some overhead associated with the first lookup but
* which is then not repeated for subsequent lookups.
The cache system used
* is a two level cache. The first level cache simply maps the
* classname/id/styleclass combination of the request node to a 2nd level cache.
* If the node has "styles" specified then we still use this 2nd level cache,
* but must combine its selectors with the selectors specified in "styles" and perform
* more work to cascade properly.
The 2nd level cache contains a data
* structure called the Cache. The Cache contains an ordered sequence of Rules,
* a Long, and a Map. The ordered sequence of selectors are the selectors that *may*
* match a node with the given classname, id, and style class. For example,
* selectors which may apply are any selector where the simple selector of the selector
* contains a reference to the id, style class, or classname of the Node, or a
* compound selector who's "descendant" part is a simple selector which contains
* a reference to the id, style class, or classname of the Node.
During
* lookup, we will iterate over all the potential selectors and discover if they
* apply to this particular node. If so, then we toggle a bit position in the
* Long corresponding to the position of the selector that matched. This long then
* becomes our key into the final map.
Once we have established our key, we
* will visit the map and look for an existing StyleHelper. If we find a
* StyleHelper, then we will return it. If not, then we will take the Rules that
* matched and construct a new StyleHelper from their various parts.
This
* system, while elaborate, also provides for numerous fast paths and sharing of
* data structures which should dramatically reduce the memory and runtime
* performance overhead associated with CSS by reducing the matching overhead
* and caching as much as possible. We make no attempt to use weak references
* here, so if memory issues result one work around would be to toggle the root
* user agent stylesheet or stylesheets on the scene to cause the cache to be
* flushed.
*/
final public class StyleManager {
private static PlatformLogger LOGGER;
private static PlatformLogger getLogger() {
if (LOGGER == null) {
LOGGER = com.sun.javafx.Logging.getCSSLogger();
}
return LOGGER;
}
private static class InstanceHolder {
final static StyleManager INSTANCE = new StyleManager();
}
/**
* Return the StyleManager instance.
*/
public static StyleManager getInstance() {
return InstanceHolder.INSTANCE;
}
/**
*
* @param styleable
* @return
* @deprecated Use {@link javafx.css.Styleable#getCssMetaData()}
*/
// TODO: is this used anywhere?
@Deprecated public static List> getStyleables(final Styleable styleable) {
return styleable != null
? styleable.getCssMetaData()
: Collections.>emptyList();
}
/**
*
* @param node
* @return
* @deprecated Use {@link javafx.scene.Node#getCssMetaData()}
*/
// TODO: is this used anywhere?
@Deprecated public static List> getStyleables(final Node node) {
return node != null
? node.getCssMetaData()
: Collections.>emptyList();
}
private StyleManager() {
}
/**
* Each Scene has its own cache. If a scene is closed,
* then StyleManager is told to forget the scene and it's cache is annihilated.
*/
private static final Map cacheContainerMap
= new WeakHashMap();
private CacheContainer getCacheContainer(Styleable styleable) {
if (styleable == null) return null;
Scene scene = null;
if (styleable instanceof Node) {
Node node = (Node)styleable;
scene = node.getScene();
} else if (styleable instanceof Window) {
// this catches the PopupWindow case
scene = ((Window)styleable).getScene();
}
// todo: what other Styleables need to be handled here?
CacheContainer container = cacheContainerMap.get(scene);
if (container == null) {
container = new CacheContainer();
cacheContainerMap.put(scene, container);
}
return container;
}
/**
* StyleHelper uses this cache but it lives here so it can be cleared
* when style-sheets change.
*/
public StyleCache getSharedCache(Styleable styleable, StyleCache.Key key) {
CacheContainer container = getCacheContainer(styleable);
if (container == null) return null;
Map styleCache = container.getStyleCache();
if (styleCache == null) return null;
StyleCache sharedCache = styleCache.get(key);
if (sharedCache == null) {
sharedCache = new StyleCache();
styleCache.put(new StyleCache.Key(key), sharedCache);
}
return sharedCache;
}
public StyleMap getStyleMap(Styleable styleable, int smapId) {
if (smapId == -1) return StyleMap.EMPTY_MAP;
CacheContainer container = getCacheContainer(styleable);
if (container == null) return StyleMap.EMPTY_MAP;
return container.getStyleMap(smapId);
}
/**
* This stylesheet represents the "default" set of styles for the entire
* platform. This is typically only set by the UI Controls module, and
* otherwise is generally null. Whenever this variable changes (via the
* setDefaultUserAgentStylesheet function call) then we will end up clearing
* all of the caches.
*/
private final List userAgentStylesheets =
new ArrayList();
////////////////////////////////////////////////////////////////////////////
//
// stylesheet handling
//
////////////////////////////////////////////////////////////////////////////
/*
* A container for stylesheets and the Parents or Scenes that use them.
* If a stylesheet is removed, then all other Parents or Scenes
* that use that stylesheet should get new styles if the
* stylesheet is added back in since the stylesheet may have been
* removed and re-added because it was edited (typical of SceneBuilder).
* This container provides the hooks to get back to those Parents or Scenes.
*
* StylesheetContainer are created and added to stylesheetContainerMap
* in the method gatherParentStylesheets.
*
* StylesheetContainer are created and added to sceneStylesheetMap in
* the method updateStylesheets
*/
private static class StylesheetContainer {
// the stylesheet url
final String fname;
// the parsed stylesheet so we don't reparse for every parent that uses it
final Stylesheet stylesheet;
// the parents or scenes that use this stylesheet. Typically, this list
// should be very small.
final SelectorPartitioning selectorPartitioning;
// who uses this stylesheet?
final RefList sceneUsers;
final RefList parentUsers;
// the keys for finding Cache entries that use this stylesheet.
// This list should also be fairly small
final RefList keys;
// RT-24516 -- cache images coming from this stylesheet.
// This just holds a hard reference to the image.
final List imageCache;
final int hash;
StylesheetContainer(String fname, Stylesheet stylesheet) {
this.fname = fname;
hash = (fname != null) ? fname.hashCode() : 127;
this.stylesheet = stylesheet;
if (stylesheet != null) {
selectorPartitioning = new SelectorPartitioning();
final List rules = stylesheet.getRules();
final int rMax = rules == null || rules.isEmpty() ? 0 : rules.size();
for (int r=0; r selectors = rule.getUnobservedSelectorList();
final int sMax = selectors == null || selectors.isEmpty() ? 0 : selectors.size();
for (int s=0; s < sMax; s++) {
final Selector selector = selectors.get(s);
selectorPartitioning.partition(selector);
}
}
} else {
selectorPartitioning = null;
}
this.sceneUsers = new RefList();
this.parentUsers = new RefList();
this.keys = new RefList();
// this just holds a hard reference to the image
this.imageCache = new ArrayList();
}
@Override
public int hashCode() {
return hash;
}
@Override
public boolean equals(Object obj) {
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
final StylesheetContainer other = (StylesheetContainer) obj;
if ((this.fname == null) ? (other.fname != null) : !this.fname.equals(other.fname)) {
return false;
}
return true;
}
@Override public String toString() {
return fname;
}
}
/*
* A list that holds references. Used by StylesheetContainer.
* We only ever add to this list, or the whole container gets thrown
* away.
*/
private static class RefList {
final List> list = new ArrayList>();
void add(K key) {
for (int n=list.size()-1; 0<=n; --n) {
final Reference ref = list.get(n);
final K k = ref.get();
if (k == null) {
// stale reference, remove it.
list.remove(n);
} else {
// already have it, bail
if (k == key) {
return;
}
}
}
// not found, add it.
list.add(new WeakReference(key));
}
}
/**
* A map from String => Stylesheet. If a stylesheet for the
* given URL has already been loaded then we'll simply reuse the stylesheet
* rather than loading a duplicate.
*/
private final Map stylesheetContainerMap
= new HashMap();
/**
* called from Window when the scene is closed.
*/
public void forget(Scene scene) {
final CacheContainer cacheContainer = cacheContainerMap.remove(scene);
if (cacheContainer != null) {
cacheContainer.clearCache();
}
//
// remove this scene and any parents belonging to this scene from the
// stylesheetContainerMap
//
Set> stylesheetContainers = stylesheetContainerMap.entrySet();
Iterator> iter = stylesheetContainers.iterator();
while(iter.hasNext()) {
Entry entry = iter.next();
StylesheetContainer container = entry.getValue();
Iterator> sceneIter = container.sceneUsers.list.iterator();
while (sceneIter.hasNext()) {
Reference ref = sceneIter.next();
Scene _scene = ref.get();
if (_scene == scene || _scene == null) {
sceneIter.remove();
}
}
Iterator> parentIter = container.parentUsers.list.iterator();
while (parentIter.hasNext()) {
Reference ref = parentIter.next();
Parent _parent = ref.get();
if (_parent == null || _parent.getScene() == scene || _parent.getScene() == null) {
parentIter.remove();
}
}
if (container.sceneUsers.list.isEmpty() &&
container.parentUsers.list.isEmpty()) {
iter.remove();
}
}
}
/**
* called from Parent's or Scene's stylesheets property's onChanged method
*/
public void stylesheetsChanged(Scene scene, Change c) {
// annihilate the cache?
boolean annihilate = false;
final boolean isPopup = scene.getWindow() instanceof PopupWindow;
c.reset();
while (c.next()) {
//
// don't care about adds from popups since popup scene gets its
// stylesheets from the scene of its root window.
//
if (isPopup == false && c.wasAdded()) {
//
// if a stylesheet is added, then the cache should be cleared
// only if that stylesheet isn't already in the
// stylesheetContainerMap. Just because one scene adds the
// same stylesheet as another doesn't mean that the other
// scene's CSS is invalid.
//
final List addedSubList = c.getAddedSubList();
for (int n=0, nMax=addedSubList.size(); n> iter = container.sceneUsers.list.iterator();
while (iter.hasNext()) {
Reference ref = iter.next();
Scene s = ref.get();
if (s == scene) {
annihilate = false;
break;
}
if (s == null) iter.remove();
}
}
}
if (annihilate) {
//
// Once we know we are going to nuke the cache,
// there is no need to look at other adds.
//
break;
}
}
} else if (c.wasRemoved()) {
if (isPopup == false) {
//
// If a stylesheet was removed from the scene, then the styles
// will need to be remapped.
//
annihilate = true;
break;
} else /* isPopup == true */ {
//
// If the scene is from a popup, then styles don't need to
// be remapped but the popup scene needs to be removed from
// the containers.
//
final List removedList = c.getRemoved();
for (int n=0, nMax=removedList.size(); n> refList = sc.sceneUsers.list;
for(int r=refList.size()-1; 0 <= r; --r) {
final Reference ref = refList.get(r);
final Scene s = (ref != null) ? ref.get() : null;
if (s == scene) {
refList.remove(r);
break;
}
}
if (refList.isEmpty()) {
stylesheetContainerMap.remove(rkey);
}
}
}
}
}
}
if (isPopup == false) {
if (annihilate) {
CacheContainer container = cacheContainerMap.get(scene);
if (container != null) container.clearCache();
}
processChange(c);
}
}
/**
* called from Parent's or Scene's stylesheets property's onChanged method
*/
public void stylesheetsChanged(Parent parent, Change c) {
processChange(c);
}
/**
* called from Parent's or Scene's stylesheets property's onChanged method
*/
private void processChange(Change c) {
// make sure we start from the beginning should this Change
// have been used before entering this method.
c.reset();
while (c.next()) {
// RT-22565
// If the String was removed, remove it from stylesheetContainerMap
// and remove all Caches that got styles from the stylesheet.
// The stylesheet may still be referenced by some other parent or
// scene, in which case the stylesheet will be reparsed and added
// back to stylesheetContainerMap when the StyleHelper is updated
// with new styles.
//
// This incurs a some overhead since the stylesheet has to be
// reparsed, but this keeps the other scenes and parents that use
// the stylesheet in sync. For example, SceneBuilder will remove
// and then add a stylesheet after it has been edited and all
// parents that use that stylesheet should get the new values.
//
if (c.wasRemoved()) {
final List list = c.getRemoved();
int nMax = list != null ? list.size() : 0;
for (int n = 0; n < nMax; n++) {
final String fname = list.get(n);
// remove this stylesheet from the container and clear
// all caches used by it
StylesheetContainer sc = stylesheetContainerMap.remove(fname);
if (sc != null) {
clearCache(sc);
if (sc.selectorPartitioning != null) {
sc.selectorPartitioning.reset();
}
}
}
}
// RT-22565: only wasRemoved matters. If the logic was applied to
// wasAdded, then the stylesheet would be reparsed each time a
// a Parent added it.
}
}
// RT-22565: Called from parentStylesheetsChanged to clear the cache entries
// for parents and scenes that use the same stylesheet
private void clearCache(StylesheetContainer sc) {
if (sc == null) return;
// clean up image cache by removing images from the cache that
// might have come from this stylesheet
cleanUpImageCache(sc.fname);
final List> sceneList = sc.sceneUsers.list;
final List> parentList = sc.parentUsers.list;
for (int n=sceneList.size()-1; 0<=n; --n) {
final Reference ref = sceneList.remove(n);
final Scene scene = ref.get();
ref.clear();
if (scene == null) {
continue;
}
scene.getRoot().impl_reapplyCSS();
}
for (int n=parentList.size()-1; 0<=n; --n) {
final Reference ref = parentList.remove(n);
final Parent parent = ref.get();
ref.clear();
if (parent == null || parent.getScene() == null) {
continue;
}
//
// tell parent it needs to reapply css
// No harm is done if parent is in a scene that has had
// impl_reapplyCSS called on the root.
//
parent.impl_reapplyCSS();
}
}
////////////////////////////////////////////////////////////////////////////
//
// Image caching
//
////////////////////////////////////////////////////////////////////////////
Map imageCache = new HashMap();
public Image getCachedImage(String url) {
Image image = imageCache.get(url);
if (image == null) {
try {
image = new Image(url);
imageCache.put(url, image);
} catch (IllegalArgumentException iae) {
// url was empty!
final PlatformLogger logger = getLogger();
if (logger != null && logger.isLoggable(PlatformLogger.WARNING)) {
LOGGER.warning(iae.getLocalizedMessage());
}
} catch (NullPointerException npe) {
// url was null!
final PlatformLogger logger = getLogger();
if (logger != null && logger.isLoggable(PlatformLogger.WARNING)) {
LOGGER.warning(npe.getLocalizedMessage());
}
}
}
return image;
}
private void cleanUpImageCache(String fname) {
if (fname == null && imageCache.isEmpty()) return;
if (fname.trim().isEmpty()) return;
int len = fname.lastIndexOf('/');
final String path = (len > 0) ? fname.substring(0,len) : fname;
final int plen = path.length();
final String[] entriesToRemove = new String[imageCache.size()];
int count = 0;
final Set> entrySet = imageCache.entrySet();
for(Entry entry : entrySet) {
final String key = entry.getKey();
len = key.lastIndexOf('/');
final String kpath = (len > 0) ? key.substring(0, len) : key;
final int klen = kpath.length();
// if the longer path begins with the shorter path,
// then assume the image came from this path.
boolean match = (klen > plen) ? kpath.startsWith(path) : path.startsWith(kpath);
if (match) entriesToRemove[count++] = key;
}
for (int n=0; n() {
@Override
public URI run() throws java.net.URISyntaxException, java.security.PrivilegedActionException {
return StyleManager.class.getProtectionDomain().getCodeSource().getLocation().toURI();
}
});
final String styleManagerJarPath = styleManagerJarURI.getSchemeSpecificPart();
String requestedFilePath = requestedFileUrI.getSchemeSpecificPart();
String requestedFileJarPart = requestedFilePath.substring(requestedFilePath.indexOf('/'), requestedFilePath.indexOf("!/"));
/*
** it's the correct jar, check it's a file access
** strip off the leading jar
*/
if (styleManagerJarPath.equals(requestedFileJarPart)) {
/*
** strip off the leading "jar",
** the css file name is past the last '!'
*/
String requestedFileJarPathNoLeadingSlash = fname.substring(fname.indexOf("!/")+2);
/*
** check that it's looking for a css file in the runtime jar
*/
if (fname.endsWith(".css") || fname.endsWith(".bss")) {
/*
** set up a read permission for the jar
*/
FilePermission perm = new FilePermission(styleManagerJarPath, "read");
PermissionCollection perms = perm.newPermissionCollection();
perms.add(perm);
AccessControlContext permsAcc = new AccessControlContext(
new ProtectionDomain[] {
new ProtectionDomain(null, perms)
});
/*
** check that the jar file exists, and that we're allowed to
** read it.
*/
JarFile jar = null;
try {
jar = AccessController.doPrivileged(new PrivilegedExceptionAction() {
@Override
public JarFile run() throws FileNotFoundException, IOException {
return new JarFile(styleManagerJarPath);
}
}, permsAcc);
} catch (PrivilegedActionException pae) {
/*
** we got either a FileNotFoundException or an IOException
** in the privileged read. Return the same error as we
** would have returned if the css file hadn't of existed.
*/
return null;
}
if (jar != null) {
/*
** check that the file is in the jar
*/
JarEntry entry = jar.getJarEntry(requestedFileJarPathNoLeadingSlash);
if (entry != null) {
/*
** allow read access to the jar
*/
return AccessController.doPrivileged(
new PrivilegedAction() {
@Override public Stylesheet run() {
return loadStylesheetUnPrivileged(fname);
}}, permsAcc);
}
}
}
}
}
/*
** no matter what happen, we return the same error that would
** be returned if the css file hadn't of existed.
** That way there in no information leaked.
*/
return null;
}
/*
** no matter what happen, we return the same error that would
** be returned if the css file hadn't of existed.
** That way there in no information leaked.
*/
catch (java.net.URISyntaxException e) {
return null;
}
catch (java.security.PrivilegedActionException e) {
return null;
}
}
}
private static Stylesheet loadStylesheetUnPrivileged(final String fname) {
Boolean parse = AccessController.doPrivileged(new PrivilegedAction() {
@Override public Boolean run() {
final String bss = System.getProperty("binary.css");
// binary.css is true by default.
// parse only if the file is not a .bss
// and binary.css is set to false
return (!fname.endsWith(".bss") && bss != null) ?
!Boolean.valueOf(bss) : Boolean.FALSE;
}
});
try {
final String ext = (parse) ? (".css") : (".bss");
java.net.URL url = null;
Stylesheet stylesheet = null;
// check if url has extension, if not then just url as is and always parse as css text
if (!(fname.endsWith(".css") || fname.endsWith(".bss"))) {
url = getURL(fname);
parse = true;
} else {
final String name = fname.substring(0, fname.length() - 4);
url = getURL(name+ext);
if (url == null && (parse = !parse)) {
// If we failed to get the URL for the .bss file,
// fall back to the .css file.
// Note that 'parse' is toggled in the test.
url = getURL(name+".css");
}
if ((url != null) && !parse) {
stylesheet = Stylesheet.loadBinary(url);
if (stylesheet == null && (parse = !parse)) {
// If we failed to load the .bss file,
// fall back to the .css file.
// Note that 'parse' is toggled in the test.
url = getURL(fname);
}
}
}
// either we failed to load the .bss file, or parse
// was set to true.
if ((url != null) && parse) {
stylesheet = CSSParser.getInstance().parse(url);
}
if (stylesheet == null) {
if (errors != null) {
CssError error =
new CssError(
"Resource \""+fname+"\" not found."
);
errors.add(error);
}
if (getLogger().isLoggable(PlatformLogger.WARNING)) {
getLogger().warning(
String.format("Resource \"%s\" not found.", fname)
);
}
}
// load any fonts from @font-face
if (stylesheet != null) {
faceLoop: for(FontFace fontFace: stylesheet.getFontFaces()) {
for(FontFace.FontFaceSrc src: fontFace.getSources()) {
if (src.getType() == FontFace.FontFaceSrcType.URL) {
Font loadedFont = Font.loadFont(src.getSrc(),10);
if (loadedFont != null) {
getLogger().info("Loaded @font-face font [" + loadedFont.getName() + "]");
} else {
getLogger().info("Could not load @font-face font [" + src.getSrc() + "]");
}
continue faceLoop;
}
}
}
}
return stylesheet;
} catch (FileNotFoundException fnfe) {
if (errors != null) {
CssError error =
new CssError(
"Stylesheet \""+fname+"\" not found."
);
errors.add(error);
}
if (getLogger().isLoggable(PlatformLogger.INFO)) {
getLogger().info("Could not find stylesheet: " + fname);//, fnfe);
}
} catch (IOException ioe) {
if (errors != null) {
CssError error =
new CssError(
"Could not load stylesheet: " + fname
);
errors.add(error);
}
if (getLogger().isLoggable(PlatformLogger.INFO)) {
getLogger().info("Could not load stylesheet: " + fname);//, ioe);
}
}
return null;
}
////////////////////////////////////////////////////////////////////////////
//
// User Agent stylesheet handling
//
////////////////////////////////////////////////////////////////////////////
private int getIndex(String fname) {
for(int n=0,nMax = userAgentStylesheets.size(); n -1) {
// already have it
return;
}
// RT-20643
CssError.setCurrentScene(scene);
if (userAgentStylesheets.isEmpty()) {
// default UA stylesheet is always index 0
// but a default hasn't been set, so leave room for it.
userAgentStylesheets.add(null);
}
Stylesheet ua_stylesheet = loadStylesheet(fname);
userAgentStylesheets.add(new StylesheetContainer(fname, ua_stylesheet));
if (ua_stylesheet != null) {
ua_stylesheet.setOrigin(StyleOrigin.USER_AGENT);
userAgentStylesheetsChanged();
}
// RT-20643
CssError.setCurrentScene(null);
}
/**
* Add a user agent stylesheet, possibly overriding styles in the default
* user agent stylesheet.
* @param scene Only used in CssError for tracking back to the scene that loaded the stylesheet
* @param ua_stylesheet The stylesheet to add as a user-agent stylesheet
*/
public void addUserAgentStylesheet(Scene scene, Stylesheet ua_stylesheet) {
// RT-20643
CssError.setCurrentScene(scene);
if (userAgentStylesheets.isEmpty()) {
// default UA stylesheet is always index 0
// but a default hasn't been set, so leave room for it.
userAgentStylesheets.add(null);
}
if (ua_stylesheet != null) {
ua_stylesheet.setOrigin(StyleOrigin.USER_AGENT);
URL url = ua_stylesheet.getUrl();
userAgentStylesheets.add(new StylesheetContainer(url != null ? url.toExternalForm() : "", ua_stylesheet));
userAgentStylesheetsChanged();
}
// RT-20643
CssError.setCurrentScene(null);
}
/**
* Set the default user agent stylesheet.
*
* @param fname The file URL, either relative or absolute, as a String.
*/
public void setDefaultUserAgentStylesheet(String fname) {
setDefaultUserAgentStylesheet(null, fname);
}
/**
* Set the default user agent stylesheet
* @param scene Only used in CssError for tracking back to the scene that loaded the stylesheet
* @param fname The file URL, either relative or absolute, as a String.
*/
// For RT-20643
public void setDefaultUserAgentStylesheet(Scene scene, String fname) {
if (fname == null || fname.trim().isEmpty()) {
throw new IllegalArgumentException("null arg fname");
}
// if this stylesheet has been added already, move it to first element
int index = getIndex(fname);
if (index != -1) {
if (index > 0) {
StylesheetContainer sc = userAgentStylesheets.get(index);
userAgentStylesheets.remove(index);
userAgentStylesheets.set(0, sc);
}
return;
}
// RT-20643
CssError.setCurrentScene(scene);
Stylesheet ua_stylesheet = loadStylesheet(fname);
StylesheetContainer sc = new StylesheetContainer(fname, ua_stylesheet);
if (userAgentStylesheets.isEmpty()) {
userAgentStylesheets.add(sc);
} else {
userAgentStylesheets.set(0,sc);
}
if (ua_stylesheet != null) {
ua_stylesheet.setOrigin(StyleOrigin.USER_AGENT);
userAgentStylesheetsChanged();
}
// RT-20643
CssError.setCurrentScene(null);
}
/**
* Set the user agent stylesheet. This is the base default stylesheet for
* the platform
*/
public void setDefaultUserAgentStylesheet(Stylesheet stylesheet) {
if (stylesheet == null ) {
throw new IllegalArgumentException("null arg ua_stylesheet");
}
final URL url = stylesheet.getUrl();
final String fname = url != null ? url.toExternalForm() : "";
// if this stylesheet has been added already, move it to first element
int index = getIndex(fname);
if (index != -1) {
if (index > 0) {
StylesheetContainer sc = userAgentStylesheets.get(index);
userAgentStylesheets.remove(index);
userAgentStylesheets.set(0, sc);
}
return;
}
StylesheetContainer sc = new StylesheetContainer(fname, stylesheet);
if (userAgentStylesheets.isEmpty()) {
userAgentStylesheets.add(sc);
} else {
userAgentStylesheets.set(0,sc);
}
stylesheet.setOrigin(StyleOrigin.USER_AGENT);
userAgentStylesheetsChanged();
}
/*
* If the userAgentStylesheets change, then all scenes are updated.
*/
private void userAgentStylesheetsChanged() {
for (CacheContainer container : cacheContainerMap.values()) {
container.clearCache();
}
for (Scene scene : cacheContainerMap.keySet()) {
if (scene == null) {
continue;
}
scene.getRoot().impl_reapplyCSS();
}
}
//
// recurse so that stylesheets of Parents closest to the root are
// added to the list first. The ensures that declarations for
// stylesheets further down the tree (closer to the leaf) have
// a higer ordinal in the cascade.
//
private List gatherParentStylesheets(Parent parent) {
if (parent == null) {
return Collections.emptyList();
}
final List parentStylesheets = parent.impl_getAllParentStylesheets();
if (parentStylesheets == null || parentStylesheets.isEmpty()) {
return Collections.emptyList();
}
final List list = new ArrayList();
// RT-20643
CssError.setCurrentScene(parent.getScene());
for (int n = 0, nMax = parentStylesheets.size(); n < nMax; n++) {
final String fname = parentStylesheets.get(n);
StylesheetContainer container = null;
if (stylesheetContainerMap.containsKey(fname)) {
container = stylesheetContainerMap.get(fname);
// RT-22565: remember that this parent uses this stylesheet.
// Later, if the cache is cleared, the parent is told to
// reapply css.
container.parentUsers.add(parent);
} else {
final Stylesheet stylesheet = loadStylesheet(fname);
// stylesheet may be null which would mean that some IOException
// was thrown while trying to load it. Add it to the
// stylesheetContainerMap anyway as this will prevent further
// attempts to parse the file
container =
new StylesheetContainer(fname, stylesheet);
// RT-22565: remember that this parent uses this stylesheet.
// Later, if the cache is cleared, the parent is told to
// reapply css.
container.parentUsers.add(parent);
stylesheetContainerMap.put(fname, container);
}
if (container != null) {
list.add(container);
}
}
// RT-20643
CssError.setCurrentScene(null);
return list;
}
//
//
//
private List gatherSceneStylesheets(Scene scene) {
if (scene == null) {
return Collections.emptyList();
}
final List sceneStylesheets = scene.getStylesheets();
if (sceneStylesheets == null || sceneStylesheets.isEmpty()) {
return Collections.emptyList();
}
final List list =
new ArrayList(sceneStylesheets.size());
// RT-20643
CssError.setCurrentScene(scene);
for (int n = 0, nMax = sceneStylesheets.size(); n < nMax; n++) {
final String fname = sceneStylesheets.get(n);
StylesheetContainer container = null;
if (stylesheetContainerMap.containsKey(fname)) {
container = stylesheetContainerMap.get(fname);
container.sceneUsers.add(scene);
} else {
final Stylesheet stylesheet = loadStylesheet(fname);
// stylesheet may be null which would mean that some IOException
// was thrown while trying to load it. Add it to the
// stylesheetContainerMap anyway as this will prevent further
// attempts to parse the file
container =
new StylesheetContainer(fname, stylesheet);
container.sceneUsers.add(scene);
stylesheetContainerMap.put(fname, container);
}
if (container != null) {
list.add(container);
}
}
// RT-20643
CssError.setCurrentScene(null);
return list;
}
// return true if this node or any of its parents has an inline style.
private static Node nodeWithInlineStyles(Node node) {
Node parent = node;
while (parent != null) {
final String inlineStyle = parent.getStyle();
if (inlineStyle != null && inlineStyle.isEmpty() == false) {
return parent;
}
parent = parent.getParent();
}
return null;
}
// reuse key to avoid creation of numerous small objects
private Key key = null;
/**
* Finds matching styles for this Node.
*/
public StyleMap findMatchingStyles(Node node, Set[] triggerStates) {
final Scene scene = node.getScene();
if (scene == null) {
return StyleMap.EMPTY_MAP;
}
CacheContainer cacheContainer = getCacheContainer(node);
if (cacheContainer == null) {
assert false : node.toString();
return StyleMap.EMPTY_MAP;
}
final Parent parent =
(node instanceof Parent)
? (Parent) node : node.getParent();
final List parentStylesheets =
gatherParentStylesheets(parent);
final boolean hasParentStylesheets = parentStylesheets.isEmpty() == false;
final List sceneStylesheets =
gatherSceneStylesheets(scene);
final boolean hasSceneStylesheets = sceneStylesheets.isEmpty() == false;
final String inlineStyle = node.getStyle();
final boolean hasInlineStyles = inlineStyle != null && inlineStyle.trim().isEmpty() == false;
//
// Are there any stylesheets at all?
// If not, then there is nothing to match and the
// resulting StyleMap is going to end up empty
//
if (hasInlineStyles == false
&& hasParentStylesheets == false
&& hasSceneStylesheets == false
&& userAgentStylesheets.isEmpty()) {
return StyleMap.EMPTY_MAP;
}
final String name = node.getClass().getName();
final int dotPos = name.lastIndexOf('.');
final String cname = name.substring(dotPos+1); // want Foo, not bada.bing.Foo
final String id = node.getId();
final List styleClasses = node.getStyleClass();
if (key == null) {
key = new Key();
}
key.className = cname;
key.id = id;
for(int n=0, nMax=styleClasses.size(); n cacheMap = cacheContainer.getCacheMap(parentStylesheets);
Cache cache = cacheMap.get(key);
if (cache != null) {
// key will be reused, so clear the styleClasses for next use
key.styleClasses.clear();
} else {
// If the cache is null, then we need to create a new Cache and
// add it to the cache map
// Construct the list of Selectors that could possibly apply
final List selectorData = new ArrayList<>();
// User agent stylesheets have lowest precedence and go first
if (userAgentStylesheets.isEmpty() == false) {
for(int n=0, nMax=userAgentStylesheets.size(); n matchingRules =
container.selectorPartitioning.match(id, cname, key.styleClasses);
selectorData.addAll(matchingRules);
}
}
}
// Scene stylesheets come next since declarations from
// parent stylesheets should take precedence.
if (sceneStylesheets.isEmpty() == false) {
for(int n=0, nMax=sceneStylesheets.size(); n matchingRules =
container.selectorPartitioning.match(id, cname, key.styleClasses);
selectorData.addAll(matchingRules);
}
}
}
// lastly, parent stylesheets
if (hasParentStylesheets) {
final int nMax = parentStylesheets == null ? 0 : parentStylesheets.size();
for(int n=0; n matchingRules =
container.selectorPartitioning.match(id, cname, key.styleClasses);
selectorData.addAll(matchingRules);
}
}
}
// create a new Cache from these selectors.
cache = new Cache(selectorData);
cacheMap.put(key, cache);
// cause a new Key to be created the next time this method is called
key = null;
}
//
// Create a style helper for this node from the styles that match.
//
StyleMap smap = cache.getStyleMap(cacheContainer, node, triggerStates, hasInlineStyles);
return smap;
}
////////////////////////////////////////////////////////////////////////////
//
// CssError reporting
//
////////////////////////////////////////////////////////////////////////////
private static ObservableList errors = null;
/**
* Errors that may have occurred during css processing.
* This list is null until errorsProperty() is called.
* @return
*/
public static ObservableList errorsProperty() {
if (errors == null) {
errors = FXCollections.observableArrayList();
}
return errors;
}
/**
* Errors that may have occurred during css processing.
* This list is null until errorsProperty() is called and is used
* internally to figure out whether or not anyone is interested in
* receiving CssError.
* Not meant for general use - call errorsProperty() instead.
* @return
*/
public static ObservableList getErrors() {
return errors;
}
////////////////////////////////////////////////////////////////////////////
//
// Classes and routines for mapping styles to a Node
//
////////////////////////////////////////////////////////////////////////////
private static List cacheMapKey;
// Each Scene has its own cache
private static class CacheContainer {
private Map getStyleCache() {
if (styleCache == null) styleCache = new HashMap();
return styleCache;
}
private Map getCacheMap(List parentStylesheets) {
if (cacheMap == null) {
cacheMap = new HashMap,Map>();
}
if (parentStylesheets == null || parentStylesheets.isEmpty()) {
Map cmap = cacheMap.get(null);
if (cmap == null) {
cmap = new HashMap();
cacheMap.put(null, cmap);
}
return cmap;
} else {
final int nMax = parentStylesheets.size();
if (cacheMapKey == null) {
cacheMapKey = new ArrayList(nMax);
}
for (int n=0; n cmap = cacheMap.get(cacheMapKey);
if (cmap == null) {
cmap = new HashMap();
cacheMap.put(cacheMapKey, cmap);
// create a new cacheMapKey the next time this method is called
cacheMapKey = null;
} else {
// reuse cacheMapKey, but not the data, the next time this method is called
cacheMapKey.clear();
}
return cmap;
}
}
private List getStyleMapList() {
if (styleMapList == null) styleMapList = new ArrayList();
return styleMapList;
}
private int nextSmapId() {
styleMapId = baseStyleMapId + getStyleMapList().size();
return styleMapId;
}
private void addStyleMap(StyleMap smap) {
assert ((smap.getId() - baseStyleMapId) == getStyleMapList().size());
getStyleMapList().add(smap);
}
public StyleMap getStyleMap(int smapId) {
final int correctedId = smapId - baseStyleMapId;
if (0 <= correctedId && correctedId < getStyleMapList().size()) {
return getStyleMapList().get(correctedId);
}
return StyleMap.EMPTY_MAP;
}
private void clearCache() {
if (cacheMap != null) cacheMap.clear();
if (styleCache != null) styleCache.clear();
if (styleMapList != null) styleMapList.clear();
baseStyleMapId = styleMapId;
// 7/8ths is totally arbitrary
if (baseStyleMapId > Integer.MAX_VALUE*7/8) {
baseStyleMapId = styleMapId = 0;
}
}
/**
* Get the mapping of property to style from Node.style for this node.
*/
private Selector getInlineStyleSelector(String inlineStyle) {
// If there are no styles for this property then we can just bail
if ((inlineStyle == null) || inlineStyle.trim().isEmpty()) return null;
if (inlineStylesCache != null && inlineStylesCache.containsKey(inlineStyle)) {
// Value of Map entry may be null!
return inlineStylesCache.get(inlineStyle);
}
//
// inlineStyle wasn't in the inlineStylesCache, or inlineStylesCache was null
//
if (inlineStylesCache == null) {
inlineStylesCache = new HashMap<>();
}
final Stylesheet inlineStylesheet =
CSSParser.getInstance().parse("*{"+inlineStyle+"}");
if (inlineStylesheet != null) {
inlineStylesheet.setOrigin(StyleOrigin.INLINE);
List rules = inlineStylesheet.getRules();
Rule rule = rules != null && !rules.isEmpty() ? rules.get(0) : null;
List selectors = rule != null ? rule.getUnobservedSelectorList() : null;
Selector selector = selectors != null && !selectors.isEmpty() ? selectors.get(0) : null;
selector.setOrdinal(-1);
inlineStylesCache.put(inlineStyle, selector);
return selector;
} else {
// even if inlineStylesheet is null, put it in cache so we don't
// bother with trying to parse it again.
inlineStylesCache.put(inlineStyle, null);
return null;
}
}
private Map styleCache;
private Map, Map> cacheMap;
private List styleMapList;
/**
* Cache of parsed, inline styles. The key is Node.style.
* The value is the Selector from the inline stylesheet.
*/
private Map inlineStylesCache;
/*
* A simple counter used to generate a unique id for a StyleMap.
* This unique id is used by StyleHelper in figuring out which
* style cache to use.
*/
private int styleMapId = 0;
// When the cache is cleared, styleMapId counting begins here.
// If a StyleHelper calls getStyleMap with an id less than the
// baseStyleMapId, then that StyleHelper is working with an old
// cache and is no longer valid.
private int baseStyleMapId = 0;
}
/**
* Creates and caches maps of styles, reusing them as often as practical.
*/
private static class Cache {
private static class Key {
final long[] key;
final String inlineStyle;
Key(long[] key, String inlineStyle) {
this.key = key;
// let inlineStyle be null if it is empty
this.inlineStyle = (inlineStyle != null && inlineStyle.trim().isEmpty() ? null : inlineStyle);
}
@Override public String toString() {
return Arrays.toString(key) + (inlineStyle != null ? "* {" + inlineStyle + "}" : "");
}
@Override
public int hashCode() {
int hash = 3;
hash = 17 * hash + Arrays.hashCode(this.key);
if (inlineStyle != null) hash = 17 * hash + inlineStyle.hashCode();
return hash;
}
@Override
public boolean equals(Object obj) {
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
final Key other = (Key) obj;
if (inlineStyle == null ? other.inlineStyle != null : !inlineStyle.equals(other.inlineStyle)) {
return false;
}
if (!Arrays.equals(this.key, other.key)) {
return false;
}
return true;
}
}
// this must be initialized to the appropriate possible selectors when
// the helper cache is created by the StylesheetContainer. Note that
// SelectorPartioning sorts the matched selectors by ordinal, so this
// list of selectors will be in the same order in which the selectors
// appear in the stylesheets.
private final List selectors;
private final Map cache;
Cache(List selectors) {
this.selectors = selectors;
this.cache = new HashMap();
}
private StyleMap getStyleMap(CacheContainer cacheContainer, Node node, Set[] triggerStates, boolean hasInlineStyle) {
if ((selectors == null || selectors.isEmpty()) && !hasInlineStyle) {
return StyleMap.EMPTY_MAP;
}
final int selectorDataSize = selectors.size();
//
// Since the list of selectors is found by matching only the
// rightmost selector, the set of selectors may larger than those
// selectors that actually match the node. The following loop
// whittles the list down to those selectors that apply.
//
//
// To lookup from the cache, we construct a key from a Long
// where the selectors that match this particular node are
// represented by bits on the long[].
//
long key[] = new long[selectorDataSize/Long.SIZE + 1];
boolean nothingMatched = true;
for (int s = 0; s < selectorDataSize; s++) {
final Selector sel = selectors.get(s);
//
// This particular flavor of applies takes a PseudoClassState[]
// fills in the pseudo-class states from the selectors where
// they apply to a node. This is an expedient to looking the
// applies loopa second time on the matching selectors. This has to
// be done ahead of the cache lookup since not all nodes that
// have the same set of selectors will have the same node hierarchy.
//
// For example, if I have .foo:hover:focused .bar:selected {...}
// and the "bar" node is 4 away from the root and the foo
// node is two away from the root, pseudoclassBits would be
// [selected, 0, hover:focused, 0]
// Note that the states run from leaf to root. This is how
// the code in StyleHelper expects things.
// Note also that, if the selector does not apply, the triggerStates
// is unchanged.
//
if (sel.applies(node, triggerStates, 0)) {
final int index = s / Long.SIZE;
final long mask = key[index] | 1l << s;
key[index] = mask;
nothingMatched = false;
}
}
// nothing matched!
if (nothingMatched && hasInlineStyle == false) {
return StyleMap.EMPTY_MAP;
}
final String inlineStyle = node.getStyle();
final Key keyObj = new Key(key, inlineStyle);
if (cache.containsKey(keyObj)) {
Integer styleMapId = cache.get(keyObj);
final StyleMap styleMap = styleMapId != null
? cacheContainer.getStyleMap(styleMapId.intValue())
: StyleMap.EMPTY_MAP;
return styleMap;
}
final List selectors = new ArrayList<>();
if (hasInlineStyle) {
Selector selector = cacheContainer.getInlineStyleSelector(inlineStyle);
if (selector != null) selectors.add(selector);
}
for (int k = 0; k pairs = new ArrayList<>(1);
int ordinal = 0;
final List stylesheetRules = inlineStylesheet.getRules();
List selectorList = null;
for (int i = 0, imax = stylesheetRules.size(); i < imax; i++) {
final Rule rule = stylesheetRules.get(i);
if (rule == null) continue;
List selectors = rule.getUnobservedSelectorList();
if (selectorList == null || selectors.isEmpty()) continue;
selectorList.addAll(selectors);
}
// TODO: should have a cacheContainer for inline styles?
return new StyleMap(-1, selectorList);
}
/**
* The key used in the cacheMap of the StylesheetContainer
*/
private static class Key {
// note that the class name here is the *full* class name, such as
// javafx.scene.control.Button. We only bother parsing this down to the
// last part when doing matching against selectors, and so want to avoid
// having to do a bunch of preliminary parsing in places where it isn't
// necessary.
String className;
String id;
final StyleClassSet styleClasses;
private Key() {
styleClasses = new StyleClassSet();
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o instanceof Key) {
Key other = (Key)o;
if (className == null ? other.className != null : (className.equals(other.className) == false)) {
return false;
}
if (id == null ? other.id != null : (id.equals(other.id) == false)) {
return false;
}
return this.styleClasses.equals(other.styleClasses);
}
return true;
}
@Override
public int hashCode() {
int hash = 7;
hash = 29 * hash + (this.className != null ? this.className.hashCode() : 0);
hash = 29 * hash + (this.id != null ? this.id.hashCode() : 0);
hash = 29 * hash + this.styleClasses.hashCode();
return hash;
}
}
}