com.googlecode.blaisemath.style.AttributeSets Maven / Gradle / Ivy

Go to download
/**
 * AttributeSets.java
 * Created Summer 2014
 */
package com.googlecode.blaisemath.style;

/*
 * #%L
 * BlaiseGraphics
 * --
 * Copyright (C) 2014 - 2017 Elisha Peterson
 * --
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */


import com.google.common.annotations.Beta;
import com.google.common.base.Converter;
import com.google.common.base.Joiner;
import com.google.common.base.Joiner.MapJoiner;
import static com.google.common.base.Preconditions.checkNotNull;
import com.google.common.base.Splitter;
import com.google.common.base.Splitter.MapSplitter;
import com.google.common.collect.Maps;
import com.googlecode.blaisemath.util.Colors;
import com.googlecode.blaisemath.util.xml.FontAdapter;
import com.googlecode.blaisemath.util.xml.Point2DAdapter;
import com.googlecode.blaisemath.util.xml.PointAdapter;
import com.googlecode.blaisemath.util.xml.RectAdapter;
import java.awt.Color;
import java.awt.Font;
import java.awt.Point;
import java.awt.geom.Point2D;
import java.awt.geom.Rectangle2D;
import java.util.Map;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.annotation.Nullable;

/**
 * 
 *   Utility library for {@link AttributeSet}.
 * 
 * 
 *   Provides a way to convert {@link AttributeSet} to/from a string. The string is intended to be
 *   compatible with html/css, but some features of the {@code AttributeSet} cannot
 *   be encoded this way, so the operation is not invertible. Conversion to a
 *   string uses the following rules:
 * 
 * 
 *   The attribute name is not used for conversion.
 *   Only values of type Number, String, Color, Marker, and Anchor are supported.
 *   Number, String, and Anchor values are converted in the obvious way.
 *   Colors are converted to #RRGGBB or #AARRGGBB notation, using {@link Colors#stringConverter()}.
 *   Marker values are persisted using their class name.
 *   Null values are converted to the string "none".
 * 
 * 
 *   Conversion from a string uses the following rules:
 * 
 * 
 *   The attribute name is not used for conversion.
 *   If the value matches #RGB, #RRGGBB, or #AARRGGBB it is converted to a color.
 *   A string value "none" is converted to a null value.
 *   If a value can be parsed as an integer or double, it is converted to that type.
 *   Otherwise, values are left as strings.
 * 
 * 
 *   Note that values of type Marker and Anchor are deserialized as strings rather
 *   than their previous type. Blaise supports having string values for these attributes
 *   wherever they are used.
 * 
 * 
 * @author Elisha
 */
public final class AttributeSets {

    /** String used to represent null explicitly. */
    private static final String NULL_STRING = "none";
    
    
    private static final AttributeSetConverter CONVERTER_INST = new AttributeSetConverter();
    private static final AttributeValueConverter VALUE_CONVERTER_INST = new AttributeValueConverter();

    private static final MapSplitter KEYVAL_SPLITTER = Splitter.on(";")
            .omitEmptyStrings().trimResults()
            .withKeyValueSeparator(Splitter.on(":").trimResults());
    private static final MapJoiner KEYVAL_JOINER = Joiner.on("; ")
            .withKeyValueSeparator(":");

    
    // non-instantiable utility class
    private AttributeSets() {
    }
    
    /**
     * Return object that can be used to convert an {@link AttributeSet} to/from a string.
     * The resulting style uses ";" to separate entries, and ":" to separate a key and value.
     * @return converter instance
     */
    @Beta
    public static Converter stringConverter() {
        return CONVERTER_INST;
    }
    
    /**
     * Return object that can be used to convert an {@link AttributeSet} to/from a string.
     * The resulting style uses ";" to separate entries, and ":" to separate a key and value.
     * @param types explicit desired types
     * @return converter instance
     */
    @Beta
    public static Converter stringConverter(Map> types) {
        return new AttributeSetConverter(checkNotNull(types));
    }
    
    /**
     * Return object that can be used to convert string values to/from Java object values.
     * Supports numeric and color types.
     * @return converter instance
     */
    @Beta
    public static Converter valueConverter() {
        return VALUE_CONVERTER_INST;
    }
    
    @Beta
    public static Object valueFromString(String x) {
        Object val = VALUE_CONVERTER_INST.reverse().convert(x);
        return NULL_STRING.equals(val) ? null : val;
    }
    
    /** Converts {@link AttributeSet} to/from a string. */
    private static final class AttributeSetConverter extends Converter {
        /** Used in deserialization for custom type mapping */
        @Nullable
        private final Map> types;

        private AttributeSetConverter() {
            this.types = null;
        }

        private AttributeSetConverter(Map> types) {
            this.types = checkNotNull(types);
        }
        
        @Override
        protected AttributeSet doBackward(String str) {
            if (str == null) {
                return null;
            }
            if (str.isEmpty()) {
                return new AttributeSet();
            }
            AttributeSet res = new AttributeSet();
            Map vals = KEYVAL_SPLITTER.split(str);
            for (String key : vals.keySet()) {
                String sval = vals.get(key);
                Object val;
                if (types != null && types.containsKey(key)) {
                    val = new AttributeValueConverter(types.get(key)).reverse().convert(sval);
                } else {
                    val = VALUE_CONVERTER_INST.reverse().convert(sval);
                }
                if (NULL_STRING.equals(val)) {
                    val = null;
                }
                res.put(key, val);
            }
            return res;
        }

        @Override
        protected String doForward(AttributeSet style) {
            if (style == null) {
                return null;
            }
            Map props = Maps.newTreeMap();
            for (String s : style.getAttributes()) {
                Object styleValue = style.get(s);
                try {
                    String value = VALUE_CONVERTER_INST.convert(styleValue);
                    if (value == null) {
                        value = NULL_STRING;
                    }
                    props.put(s, value);
                } catch (UnsupportedOperationException x) {
                    // keep trying to convert, but log a warning
                    Logger.getLogger(AttributeSets.class.getName()).log(Level.WARNING,
                            "Cannot convert value "+styleValue+" to string.", x);
                }
            }
            return KEYVAL_JOINER.join(props);
        }
    }
    
    /** 
     * Converts {@link AttributeSet} values to/from strings. Supports the following
     * types:
     * 
     * String
     * Double
     * Float
     * Integer
     * Color - in the form #RRGGBB or #AARRGGBB
     * Point - in the form !point[5,6.2]
     * Rectangle - in the form !rectangle[x=2,y=3,w=7,h=12]
     * Boolean - reverses as text
     * Font - reverses as text
     * Anchor - reverses as text
     * 
     * When decoding from strings, the above lists describes how strings that
     * may match more than one type are handled. Types lower in the list are
     * always used prior to those higher up in the list.
     */
    private static final class AttributeValueConverter extends Converter {
        @Nullable
        private final Class prefType;
        
        private AttributeValueConverter() {
            prefType = null;
        }

        private AttributeValueConverter(Class prefType) {
            this.prefType = checkNotNull(prefType);
        }
        
        @Override
        protected Object doBackward(String sval) {
            return prefType == null ? doBackwardBestGuess(sval) : doBackward(sval, prefType);
        }
        
        protected Object doBackwardBestGuess(String sval) {
            if (sval.matches("#[0-9a-fA-f]{3}")
                    || sval.matches("#[0-9a-fA-f]{6}")
                    || sval.matches("#[0-9a-fA-f]{8}")) {
                return Colors.stringConverter().reverse().convert(sval);
            } else if (sval.matches("!point\\[(.*)\\]")) {
                return new Point2DAdapter().unmarshal(sval);
            } else if (sval.matches("!rectangle\\[(.*)\\]")) {
                return new RectAdapter().unmarshal(sval);
            }
            try {
                return Integer.valueOf(sval);
            } catch (NumberFormatException x) {
                // wasn't an integer, try the next thing
            }
            try {
                return Double.valueOf(sval);
            } catch (NumberFormatException x) {
                // wasn't a double, try the next thing
            }
            return sval;
        }
        
        protected Object doBackward(String sval, Class prefType) {
            checkNotNull(prefType);
            if (prefType == Color.class) {
                return Colors.stringConverter().reverse().convert(sval);
            } else if (Point2D.class.isAssignableFrom(prefType)) {
                return new Point2DAdapter().unmarshal(sval);
            } else if (Rectangle2D.class.isAssignableFrom(prefType)) {
                return new RectAdapter().unmarshal(sval);
            } else if (prefType == Integer.class) {
                return Integer.valueOf(sval);
            } else if (prefType == Float.class) {
                return Float.valueOf(sval);
            } else if (prefType == Double.class) {
                return Double.valueOf(sval);
            } else if (prefType == String.class) {
                return sval;
            } else if (prefType == Boolean.class) {
                return Boolean.valueOf(sval);
            } else if (prefType == Anchor.class) {
                return Anchor.valueOf(sval);
            }
            return sval;
        }

        @Override
        protected String doForward(Object val) {
            if (val instanceof Color) {
                return Colors.stringConverter().convert((Color) val);
            } else if (val instanceof Marker) {
                return val.getClass().getSimpleName();
            } else if (val instanceof Rectangle2D) {
                return "!"+new RectAdapter().marshal((Rectangle2D)val);
            } else if (val instanceof Point) {
                return "!"+new PointAdapter().marshal((Point)val);
            } else if (val instanceof Point2D.Double) {
                return "!"+new Point2DAdapter().marshal((Point2D.Double)val);
            } else if (val instanceof Font) {
                return new FontAdapter().marshal((Font) val);
            } else {
                return val+"";
            }
        }
    }
    
}