PostScriptRenderer.java

/*
 * Copyright 2015 Robin Stuart, Daniel Gredler
 *
 * 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.
 */

package uk.org.okapibarcode.output;

import static uk.org.okapibarcode.graphics.TextAlignment.CENTER;
import static uk.org.okapibarcode.graphics.TextAlignment.JUSTIFY;
import static uk.org.okapibarcode.util.Doubles.roughlyEqual;
import static uk.org.okapibarcode.util.Integers.normalizeRotation;

import java.io.BufferedWriter;
import java.io.IOException;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.io.Writer;
import java.nio.charset.StandardCharsets;
import java.util.Locale;
import java.util.Objects;

import uk.org.okapibarcode.backend.OkapiInternalException;
import uk.org.okapibarcode.backend.Symbol;
import uk.org.okapibarcode.graphics.Circle;
import uk.org.okapibarcode.graphics.Color;
import uk.org.okapibarcode.graphics.Hexagon;
import uk.org.okapibarcode.graphics.Rectangle;
import uk.org.okapibarcode.graphics.TextAlignment;
import uk.org.okapibarcode.graphics.TextBox;

/**
 * Renders symbologies to EPS (Encapsulated PostScript).
 *
 * @author <a href="mailto:rstuart114@gmail.com">Robin Stuart</a>
 * @author Daniel Gredler
 */
public final class PostScriptRenderer implements SymbolRenderer {

    /** The writer to render to. */
    private final Writer writer;

    /** The magnification factor to apply. */
    private final double magnification;

    /** The paper (background) color. */
    private final Color paper;

    /** The ink (foreground) color. */
    private final Color ink;

    /** The clockwise rotation of the symbol in degrees. */
    private final int rotation;

    /**
     * Creates a new PostScript renderer.
     *
     * @param writer the writer to render to
     * @param magnification the magnification factor to apply
     * @param paper the paper (background) color
     * @param ink the ink (foreground) color
     */
    public PostScriptRenderer(Writer writer, double magnification, Color paper, Color ink) {
        this(writer, magnification, paper, ink, 0);
    }

    /**
     * Creates a new PostScript renderer.
     *
     * @param writer the writer to render to
     * @param magnification the magnification factor to apply
     * @param paper the paper (background) color
     * @param ink the ink (foreground) color
     * @param rotation the clockwise rotation of the symbol in degrees (must be a multiple of 90)
     */
    public PostScriptRenderer(Writer writer, double magnification, Color paper, Color ink, int rotation) {
        this.writer = Objects.requireNonNull(writer);
        this.magnification = magnification;
        this.paper = Objects.requireNonNull(paper);
        this.ink = Objects.requireNonNull(ink);
        this.rotation = normalizeRotation(rotation);
    }

    /**
     * Creates a new PostScript renderer.
     *
     * @param out the output stream to render to
     * @param magnification the magnification factor to apply
     * @param paper the paper (background) color
     * @param ink the ink (foreground) color
     */
    public PostScriptRenderer(OutputStream out, double magnification, Color paper, Color ink) {
        this(out, magnification, paper, ink, 0);
    }

    /**
     * Creates a new PostScript renderer.
     *
     * @param out the output stream to render to
     * @param magnification the magnification factor to apply
     * @param paper the paper (background) color
     * @param ink the ink (foreground) color
     * @param rotation the clockwise rotation of the symbol in degrees (must be a multiple of 90)
     */
    public PostScriptRenderer(OutputStream out, double magnification, Color paper, Color ink, int rotation) {
        this(new BufferedWriter(new OutputStreamWriter(Objects.requireNonNull(out), StandardCharsets.UTF_8)),
             magnification, paper, ink, rotation);
    }

    /** {@inheritDoc} */
    @Override
    public void render(Symbol symbol) throws IOException {

        // All y dimensions are reversed because EPS origin (0,0) is at the bottom left, not top left

        String content = symbol.getContent();
        int width = (int) Math.ceil(symbol.getWidth() * magnification);
        int height = (int) Math.ceil(symbol.getHeight() * magnification);
        int marginX = (int) (symbol.getQuietZoneHorizontal() * magnification);
        int marginY = (int) (symbol.getQuietZoneVertical() * magnification);

        int rotatedHeight = height;
        int rotatedWidth = width;
        switch (rotation) {
            case 90:
            case 270:
                rotatedHeight = width;
                rotatedWidth = height;
                break;
            default:
                break;
        }

        String title;
        if (content.isEmpty()) {
            title = "OkapiBarcode Generated Symbol";
        } else {
            title = content;
        }

        try {

            // Header
            writer.append("%!PS-Adobe-3.0 EPSF-3.0\n");
            writer.append("%%Creator: OkapiBarcode\n");
            writer.append("%%Title: ").append(title).append('\n');
            writer.append("%%Pages: 0\n");
            writer.append("%%BoundingBox: 0 0 ").append(i2s(rotatedWidth)).append(" ").append(i2s(rotatedHeight)).append("\n");
            writer.append("%%EndComments\n");

            // Definitions
            writer.append("/TL { setlinewidth moveto lineto stroke } bind def\n");
            writer.append("/TC { moveto 0 360 arc 360 0 arcn fill } bind def\n");
            writer.append("/TH { 0 setlinewidth moveto lineto lineto lineto lineto lineto closepath fill } bind def\n");
            writer.append("/TB { 2 copy } bind def\n");
            writer.append("/TR { newpath 4 1 roll exch moveto 1 index 0 rlineto 0 exch rlineto neg 0 rlineto closepath fill } bind def\n");
            writer.append("/TE { pop pop } bind def\n");

            // Set orientation
            switch (rotation) {
                case 90:
                    writer.append("gsave\n")
                          .append(d2s(-rotation)).append(" rotate\n")
                          .append(d2s(-width)).append(" 0.00 translate\n");
                    break;
                case 180:
                    writer.append("gsave\n")
                          .append(d2s(-rotation)).append(" rotate\n")
                          .append(d2s(-width)).append(" ").append(d2s(-height)).append(" translate\n");
                    break;
                case 270:
                    writer.append("gsave\n")
                          .append(d2s(-rotation)).append(" rotate\n")
                          .append("0.00 ").append(d2s(-height)).append(" translate\n");
                    break;
                default:
                    break;
            }

            // Background
            writer.append("newpath\n");
            writer.append(d2s(ink.red / 255.0)).append(" ")
                  .append(d2s(ink.green / 255.0)).append(" ")
                  .append(d2s(ink.blue / 255.0)).append(" setrgbcolor\n");
            writer.append(d2s(paper.red / 255.0)).append(" ")
                  .append(d2s(paper.green / 255.0)).append(" ")
                  .append(d2s(paper.blue / 255.0)).append(" setrgbcolor\n");
            writer.append(d2s(height)).append(" 0.00 TB 0.00 ").append(d2s(width)).append(" TR\n");

            // Rectangles
            for (int i = 0; i < symbol.getRectangles().size(); i++) {
                Rectangle rect = symbol.getRectangles().get(i);
                if (i == 0) {
                    writer.append("TE\n");
                    writer.append(d2s(ink.red / 255.0)).append(" ")
                          .append(d2s(ink.green / 255.0)).append(" ")
                          .append(d2s(ink.blue / 255.0)).append(" setrgbcolor\n");
                    writer.append(d2s(rect.height * magnification)).append(" ")
                          .append(d2s(height - ((rect.y + rect.height) * magnification) - marginY)).append(" TB ")
                          .append(d2s((rect.x * magnification) + marginX)).append(" ")
                          .append(d2s(rect.width * magnification)).append(" TR\n");
                } else {
                    Rectangle prev = symbol.getRectangles().get(i - 1);
                    if (!roughlyEqual(rect.height, prev.height) || !roughlyEqual(rect.y, prev.y)) {
                        writer.append("TE\n");
                        writer.append(d2s(ink.red / 255.0)).append(" ")
                              .append(d2s(ink.green / 255.0)).append(" ")
                              .append(d2s(ink.blue / 255.0)).append(" setrgbcolor\n");
                        writer.append(d2s(rect.height * magnification)).append(" ")
                              .append(d2s(height - ((rect.y + rect.height) * magnification) - marginY)).append(" ");
                    }
                    writer.append("TB ").append(d2s((rect.x * magnification) + marginX)).append(" ").append(d2s(rect.width * magnification)).append(" TR\n");
                }
            }

            // Text
            for (int i = 0; i < symbol.getTexts().size(); i++) {
                TextBox text = symbol.getTexts().get(i);
                TextAlignment alignment = (text.alignment == JUSTIFY && text.text.length() == 1 ? CENTER : text.alignment);
                if (i == 0) {
                    writer.append("TE\n");
                    writer.append(d2s(ink.red / 255.0)).append(" ")
                          .append(d2s(ink.green / 255.0)).append(" ")
                          .append(d2s(ink.blue / 255.0)).append(" setrgbcolor\n");
                }
                writer.append("matrix currentmatrix\n");
                writer.append("/").append(symbol.getFontName()).append(" findfont\n");
                writer.append(d2s(symbol.getFontSize() * magnification)).append(" scalefont setfont\n");
                double y = height - (text.y * magnification) - marginY;
                switch (alignment) {
                    case LEFT:
                        double leftX = (magnification * text.x) + marginX;
                        writer.append(" 0 0 moveto ").append(d2s(leftX)).append(" ").append(d2s(y))
                              .append(" translate 0.00 rotate 0 0 moveto\n");
                        writer.append(" (").append(text.text).append(") show\n");
                        break;
                    case JUSTIFY:
                        double textX = (magnification * text.x) + marginX;
                        double textW = (magnification * text.width);
                        writer.append(" 0 0 moveto ").append(d2s(textX)).append(" ").append(d2s(y))
                              .append(" translate 0.00 rotate 0 0 moveto\n");
                        writer.append(" (").append(text.text).append(") dup stringwidth pop ")
                              .append(d2s(textW)).append(" sub neg 1 index length 1 sub div 0")
                              .append(" 3 -1 roll ashow\n");
                        break;
                    case RIGHT:
                        double rightX = (magnification * text.x) + (magnification * text.width) + marginX;
                        writer.append(" 0 0 moveto ").append(d2s(rightX)).append(" ").append(d2s(y))
                              .append(" translate 0.00 rotate 0 0 moveto\n");
                        writer.append(" (").append(text.text).append(") stringwidth\n");
                        writer.append("pop\n");
                        writer.append("-1 mul 0 rmoveto\n");
                        writer.append(" (").append(text.text).append(") show\n");
                        break;
                    case CENTER:
                        double centerX = (magnification * text.x) + (magnification * text.width / 2) + marginX;
                        writer.append(" 0 0 moveto ").append(d2s(centerX)).append(" ").append(d2s(y))
                              .append(" translate 0.00 rotate 0 0 moveto\n");
                        writer.append(" (").append(text.text).append(") stringwidth\n");
                        writer.append("pop\n");
                        writer.append("-2 div 0 rmoveto\n");
                        writer.append(" (").append(text.text).append(") show\n");
                        break;
                    default:
                        throw new OkapiInternalException("Unknown alignment: " + alignment);
                }
                writer.append("setmatrix\n");
            }

            // Circles
            // Because MaxiCode size is fixed, this ignores magnification
            for (int i = 0; i < symbol.getTarget().size(); i += 2) {
                Circle circle1 = symbol.getTarget().get(i);
                Circle circle2 = symbol.getTarget().get(i + 1);
                if (i == 0) {
                    writer.append("TE\n");
                    writer.append(d2s(ink.red / 255.0)).append(" ")
                          .append(d2s(ink.green / 255.0)).append(" ")
                          .append(d2s(ink.blue / 255.0)).append(" setrgbcolor\n");
                    writer.append(d2s(ink.red / 255.0)).append(" ")
                          .append(d2s(ink.green / 255.0)).append(" ")
                          .append(d2s(ink.blue / 255.0)).append(" setrgbcolor\n");
                }
                double x1 = circle1.centreX;
                double x2 = circle2.centreX;
                double y1 = height - circle1.centreY;
                double y2 = height - circle2.centreY;
                double r1 = circle1.radius;
                double r2 = circle2.radius;
                writer.append(d2s(x1 + marginX))
                      .append(" ").append(d2s(y1 - marginY))
                      .append(" ").append(d2s(r1))
                      .append(" ").append(d2s(x2 + marginX))
                      .append(" ").append(d2s(y2 - marginY))
                      .append(" ").append(d2s(r2))
                      .append(" ").append(d2s(x2 + r2 + marginX))
                      .append(" ").append(d2s(y2 - marginY))
                      .append(" TC\n");
            }

            // Hexagons
            // Because MaxiCode size is fixed, this ignores magnification
            for (Hexagon hexagon : symbol.getHexagons()) {
                for (int j = 0; j < 6; j++) {
                    writer.append(d2s(hexagon.getX(j) + marginX)).append(" ")
                          .append(d2s((height - hexagon.getY(j)) - marginY)).append(" ");
                }
                writer.append(" TH\n");
            }

            // Restore original transformation if rotated
            if (rotation != 0) {
                writer.append("grestore\n");
            }

            // Footer
            writer.append("\nshowpage\n");

        } finally {
            writer.close();
        }
    }

    private static String i2s(int i) {
        return String.valueOf(i);
    }

    private static String d2s(double d) {
        return String.format(Locale.ROOT, "%.2f", d);
    }
}