shapes/custom/CustomShapeDescription.java

/*
 * Copyright (c) 2018 Helmut Neemann
 * Use of this source code is governed by the GPL v3 license
 * that can be found in the LICENSE file.
 */
package de.neemann.digital.draw.shapes.custom;

import de.neemann.digital.core.ObservableValue;
import de.neemann.digital.core.ObservableValues;
import de.neemann.digital.core.element.PinDescription;
import de.neemann.digital.draw.elements.Circuit;
import de.neemann.digital.draw.elements.PinException;
import de.neemann.digital.draw.graphics.*;
import de.neemann.digital.draw.graphics.Polygon;
import de.neemann.digital.draw.shapes.Drawable;
import de.neemann.digital.lang.Lang;

import java.awt.*;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.Iterator;

/**
 * Is intended to be stored in a file.
 */
public final class CustomShapeDescription implements Iterable<CustomShapeDescription.Holder> {

    private final HashMap<String, Pin> pins;
    private final ArrayList<Holder> drawables;
    private final TextHolder label;

    /**
     * Creates a new instance
     */
    private CustomShapeDescription(HashMap<String, Pin> pins, ArrayList<Holder> drawables, TextHolder label) {
        this.pins = pins;
        this.drawables = drawables;
        this.label = label;
    }

    /**
     * Returns the position of the given pin.
     *
     * @param name the name of the pin
     * @return the position of the pin
     * @throws PinException thrown if pin is not found
     */
    Pin getPin(String name) throws PinException {
        final Pin pin = pins.get(name);
        if (pin == null)
            throw new PinException(Lang.get("err_customShapeHasNoPin_N", name));
        return pin;
    }

    @Override
    public Iterator<Holder> iterator() {
        return drawables.iterator();
    }

    /**
     * Transforms this custom shape
     *
     * @param tr the transformation
     */
    public void transform(Transform tr) {
        for (Holder h : drawables)
            h.transform(tr);
        for (Pin p : pins.values())
            p.transform(tr);
        if (label != null)
            label.transform(tr);
    }

    /**
     * @return the number of pins in this shape
     */
    public int getPinCount() {
        return pins.size();
    }

    /**
     * @return the TextHolder used to draw the label, maybe null
     */
    public TextHolder getLabel() {
        return label;
    }

    /**
     * @return the dfined pins
     */
    public Collection<Pin> getPins() {
        return pins.values();
    }

    /**
     * @return true if shape is empty
     */
    public boolean isEmpty() {
        return drawables.isEmpty() && pins.isEmpty();
    }

    /**
     * Checks the compatibility of this shape to the given circuit
     *
     * @param circuit the circuit
     * @throws PinException PinException
     */
    public void checkCompatibility(Circuit circuit) throws PinException {
        final ObservableValues outputNames = circuit.getOutputNames();
        for (ObservableValue out : outputNames)
            getPin(out.getName());
        final PinDescription[] inputNames = circuit.getInputNames();
        for (PinDescription in : inputNames)
            getPin(in.getName());

        int pinsNum = outputNames.size() + inputNames.length;
        if (pinsNum != pins.size())
            throw new PinException(Lang.get("err_morePinsDefinedInSVGAsNeeded"));
    }

    /*
     * Two CustomShapeDescriptions are equal if and only if they are both empty!
     */
    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;

        CustomShapeDescription customShapeDescription = (CustomShapeDescription) o;

        return customShapeDescription.isEmpty() && isEmpty();
    }

    @Override
    public int hashCode() {
        if (isEmpty())
            return 0;
        return super.hashCode();
    }

    private interface Transformable {
        void transform(Transform tr);
    }

    interface Holder extends Drawable, Transformable {
    }

    /**
     * Stores a line.
     */
    public static final class LineHolder implements Holder {
        private Vector p1;
        private Vector p2;
        private final int thickness;
        private final Color color;

        private LineHolder(Vector p1, Vector p2, int thickness, Color color) {
            this.p1 = p1;
            this.p2 = p2;
            this.thickness = thickness;
            this.color = color;
        }

        @Override
        public void drawTo(Graphic graphic, Style highLight) {
            graphic.drawLine(p1, p2, Style.NORMAL.deriveStyle(thickness, false, color));
        }

        /**
         * @return first coordinate
         */
        public VectorInterface getP1() {
            return p1;
        }

        /**
         * @return second coordinate
         */
        public VectorInterface getP2() {
            return p2;
        }

        @Override
        public void transform(Transform tr) {
            p1 = p1.transform(tr).round();
            p2 = p2.transform(tr).round();
        }
    }

    /**
     * Stores a circle
     */
    public static final class CircleHolder implements Holder {
        private Vector p1;
        private Vector p2;
        private final int thickness;
        private final Color color;
        private final boolean filled;


        private CircleHolder(Vector p1, Vector p2, int thickness, Color color, boolean filled) {
            this.p1 = p1;
            this.p2 = p2;
            this.thickness = thickness;
            this.color = color;
            this.filled = filled;
        }

        @Override
        public void drawTo(Graphic graphic, Style highLight) {
            graphic.drawCircle(p1, p2, Style.NORMAL.deriveStyle(thickness, filled, color));
        }

        /**
         * @return first coordinate
         */
        public VectorInterface getP1() {
            return p1;
        }

        /**
         * @return second coordinate
         */
        public VectorInterface getP2() {
            return p2;
        }

        @Override
        public void transform(Transform tr) {
            p1 = p1.transform(tr).round();
            p2 = p2.transform(tr).round();
        }
    }

    /**
     * Stores a polygon
     */
    public static final class PolygonHolder implements Holder {
        private Polygon poly;
        private final int thickness;
        private final boolean filled;
        private final Color color;

        private PolygonHolder(Polygon poly, int thickness, boolean filled, Color color) {
            this.poly = poly;
            this.thickness = thickness;
            this.filled = filled;
            this.color = color;
        }

        @Override
        public void drawTo(Graphic graphic, Style highLight) {
            graphic.drawPolygon(poly, Style.NORMAL.deriveStyle(thickness, filled, color));
        }

        /**
         * @return the stored polygon
         */
        public Polygon getPolygon() {
            return poly;
        }

        @Override
        public void transform(Transform tr) {
            poly = poly.transform(tr);
        }
    }

    /**
     * Stores a text
     */
    public static final class TextHolder implements Holder {
        private Vector p1;
        private Vector p2;
        private final String text;
        private final Orientation orientation;
        private final int size;
        private final Color color;

        private TextHolder(Vector p1, Vector p2, String text, Orientation orientation, int size, Color color) {
            this.p1 = p1;
            this.p2 = p2;
            this.text = text;
            this.orientation = orientation;
            this.size = size;
            this.color = color;
        }

        @Override
        public void drawTo(Graphic graphic, Style highLight) {
            drawText(graphic, text);
        }

        /**
         * Draws the given text to the given graphic instance
         *
         * @param graphic the graphic instance to draw to
         * @param text    the text to draw
         */
        public void drawText(Graphic graphic, String text) {
            graphic.drawText(p1, p2, text, orientation,
                    Style.NORMAL
                            .deriveFontStyle(size, true)
                            .deriveColor(color));
        }

        @Override
        public void transform(Transform tr) {
            p1 = p1.transform(tr).round();
            p2 = p2.transform(tr).round();
        }

        /**
         * @return the text position
         */
        public Vector getPos() {
            return p1;
        }

        /**
         * @return the font size
         */
        public int getFontSize() {
            return size;
        }

        /**
         * @return the text string
         */
        public String getText() {
            return text;
        }
    }

    /**
     * Describes a pin position
     */
    public static final class Pin implements Transformable {
        private Vector pos;
        private boolean showLabel;

        private Pin(Vector pos, boolean showLabel) {
            this.pos = pos;
            this.showLabel = showLabel;
        }

        boolean isShowLabel() {
            return showLabel;
        }

        /**
         * @return the position of the pin
         */
        public Vector getPos() {
            return pos;
        }

        @Override
        public void transform(Transform tr) {
            pos = pos.transform(tr).round();
        }
    }

    /**
     * Used to build a custom shape description
     */
    public static final class Builder {
        private final HashMap<String, Pin> pins;
        private final ArrayList<Holder> drawables;
        private TextHolder label;

        /**
         * Creates a new builder
         */
        public Builder() {
            pins = new HashMap<>();
            drawables = new ArrayList<>();
        }

        /**
         * Sets the label positioning info.
         *
         * @param pos0            pos0
         * @param pos1            pos1
         * @param textOrientation textOrientation
         * @param fontSize        fontSize
         * @param filled          filled
         * @return this for chained calls
         */
        public Builder setLabel(Vector pos0, Vector pos1, Orientation textOrientation, int fontSize, Color filled) {
            label = new TextHolder(pos0, pos1, "", textOrientation, fontSize, filled);
            return this;
        }

        /**
         * Adds a pin to this shape description
         *
         * @param name      the name of the pin
         * @param pos       the pins position
         * @param showLabel if true the label of the pin is shown
         * @return this for chained calls
         */
        public Builder addPin(String name, Vector pos, boolean showLabel) {
            pins.put(name, new Pin(pos, showLabel));
            return this;
        }


        /**
         * Adds a polygon to the shape
         *
         * @param p1        starting point of the line
         * @param p2        ending point of the line
         * @param thickness the line thickness
         * @param color     the color to use
         * @return this for chained calls
         */
        public Builder addLine(Vector p1, Vector p2, int thickness, Color color) {
            drawables.add(new LineHolder(p1, p2, thickness, color));
            return this;
        }

        /**
         * Adds a circle to the shape
         *
         * @param p1        upper left corner of the circles bounding box
         * @param p2        lower right corner of the circles bounding box
         * @param thickness the line thickness
         * @param color     the color to use
         * @param filled    true if filled
         * @return this for chained calls
         */
        public Builder addCircle(Vector p1, Vector p2, int thickness, Color color, boolean filled) {
            drawables.add(new CircleHolder(p1, p2, thickness, color, filled));
            return this;
        }

        /**
         * Adds a polygon to the shape
         *
         * @param poly      the polygon to add
         * @param thickness the line thickness
         * @param color     the color to use
         * @param filled    true if filled
         * @return this for chained calls
         */
        public Builder addPolygon(Polygon poly, int thickness, Color color, boolean filled) {
            drawables.add(new PolygonHolder(poly, thickness, filled, color));
            return this;
        }

        /**
         * Adds a text to the shape
         *
         * @param p1          position
         * @param p2          second position to determin the base line orientation
         * @param text        the text to draw
         * @param orientation the orientation of the text
         * @param size        the font size
         * @param color       the text color
         * @return this for chained calls
         */
        public Builder addText(Vector p1, Vector p2, String text, Orientation orientation, int size, Color color) {
            drawables.add(new TextHolder(p1, p2, text, orientation, size, color));
            return this;
        }

        /**
         * @return the {@link CustomShapeDescription}
         */
        public CustomShapeDescription build() {
            return new CustomShapeDescription(pins, drawables, label);
        }

    }
}