/*

 * Copyright (c) 2015, 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.

 *

 * 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.

 */

/**

 * Copyright (C) 2013-2014 IBM Corporation and Others. All Rights Reserved.

 */

import java.awt.Color;

import java.awt.Composite;

import java.awt.Font;

import java.awt.FontFormatException;

import java.awt.FontMetrics;

import java.awt.Graphics;

import java.awt.Graphics2D;

import java.awt.GraphicsConfiguration;

import java.awt.Image;

import java.awt.Paint;

import java.awt.Rectangle;

import java.awt.RenderingHints;

import java.awt.RenderingHints.Key;

import java.awt.Shape;

import java.awt.Stroke;

import java.awt.font.FontRenderContext;

import java.awt.font.GlyphVector;

import java.awt.font.TextLayout;

import java.awt.geom.AffineTransform;

import java.awt.image.BufferedImage;

import java.awt.image.BufferedImageOp;

import java.awt.image.ImageObserver;

import java.awt.image.RenderedImage;

import java.awt.image.renderable.RenderableImage;

import java.io.BufferedInputStream;

import java.io.File;

import java.io.FileInputStream;

import java.io.FileNotFoundException;

import java.io.IOException;

import java.io.InputStream;

import java.text.AttributedCharacterIterator;

import java.util.ArrayList;

import java.util.List;

import java.util.Map;

import java.util.MissingResourceException;

import java.util.TreeMap;

import javax.xml.parsers.DocumentBuilder;

import javax.xml.parsers.DocumentBuilderFactory;

import javax.xml.parsers.ParserConfigurationException;

import org.w3c.dom.Document;

import org.w3c.dom.Element;

import org.w3c.dom.NamedNodeMap;

import org.w3c.dom.Node;

import org.w3c.dom.NodeList;

import org.xml.sax.SAXException;

/**

 * This test runs against a test XML file. It opens the fonts and attempts

 * to shape and layout glyphs.

 * Note that the test is highly environment dependent- you must have

 * the same versions of the same fonts available or the test will fail.

 *

 * It is similar to letest which is part of ICU.

 * For reference, here are some reference items:

 * ICU's test file:

 *  http://source.icu-project.org/repos/icu/icu/trunk/source/test/testdata/letest.xml

 * ICU's readme for the similar test:

 *  http://source.icu-project.org/repos/icu/icu/trunk/source/test/letest/readme.html

 *

 * @bug 8054203

 * @test

 * @summary manual test of layout engine behavior. Takes an XML control file.

 * @compile TestLayoutVsICU.java

 * @author srl

 * @run main/manual

 */

public class TestLayoutVsICU {

    public static boolean OPT_DRAW = false;

    public static boolean OPT_VERBOSE = false;

    public static boolean OPT_FAILMISSING = false;

    public static boolean OPT_NOTHROW= false; // if true - don't stop on failure

    public static int docs = 0; // # docs processed

    public static int skipped = 0; // cases skipped due to bad font

    public static int total = 0; // cases processed

    public static int bad = 0; // cases with errs

    public static final String XML_LAYOUT_TESTS = "layout-tests"; // top level

    public static final String XML_TEST_CASE = "test-case";

    public static final String XML_TEST_FONT = "test-font";

    public static final String XML_TEST_TEXT = "test-text";

    public static final String XML_RESULT_GLYPHS = "result-glyphs";

    public static final String XML_ID = "id";

    public static final String XML_SCRIPT = "script";

    public static final String XML_NAME = "name";

    public static final String XML_VERSION = "version";

    public static final String XML_CHECKSUM = "checksum";

    public static final String XML_RESULT_INDICES = "result-indices";

    public static final String XML_RESULT_POSITIONS = "result-positions";

    /**

     * @param args

     * @throws IOException

     * @throws SAXException

     * @throws ParserConfigurationException

     */

    public static void main(String[] args) throws ParserConfigurationException, SAXException, IOException {

        System.out.println("Java " + System.getProperty("java.version") + " from " + System.getProperty("java.vendor"));

        TestLayoutVsICU tlvi = null;

        for(String arg : args) {

            if(arg.equals("-d")) {

                OPT_DRAW = true;

            } else if(arg.equals("-n")) {

                OPT_NOTHROW = true;

            } else if(arg.equals("-v")) {

                OPT_VERBOSE = true;

            } else if(arg.equals("-f")) {

                OPT_FAILMISSING = true;

            } else {

                if(tlvi == null) {

                    tlvi = new TestLayoutVsICU();

                }

                try {

                    tlvi.show(arg);

                } finally {

                    if(OPT_VERBOSE) {

                        System.out.println("# done with " + arg);

                    }

                }

            }

        }

        if(tlvi == null) {

            throw new IllegalArgumentException("No XML input. Usage: " + TestLayoutVsICU.class.getSimpleName() + " [-d][-v][-f] letest.xml ...");

        } else {

            System.out.println("\n\nRESULTS:\n");

            System.out.println(skipped+"\tskipped due to missing font");

            System.out.println(total+"\ttested of which:");

            System.out.println(bad+"\twere bad");

            if(bad>0) {

                throw new InternalError("One or more failure(s)");

            }

        }

    }

    String id;

    private void show(String arg) throws ParserConfigurationException, SAXException, IOException {

        id = "<none>";

        File xmlFile = new File(arg);

        if(!xmlFile.exists()) {

            throw new FileNotFoundException("Can't open input XML file " + arg);

        }

        DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();

        DocumentBuilder db = dbf.newDocumentBuilder();

        if(OPT_VERBOSE) {

            System.out.println("# Parsing " + xmlFile.getAbsolutePath());

        }

        Document doc = db.parse(xmlFile);

        Element e = doc.getDocumentElement();

        if(!XML_LAYOUT_TESTS.equals(e.getNodeName())) {

            throw new IllegalArgumentException("Document " + xmlFile.getAbsolutePath() + " does not have <layout-tests> as its base");

        }

        NodeList testCases = e.getElementsByTagName(XML_TEST_CASE);

        for(int caseNo=0;caseNo<testCases.getLength();caseNo++) {

            final Node testCase = testCases.item(caseNo);

            final Map<String,String> testCaseAttrs = attrs(testCase);

            id = testCaseAttrs.get(XML_ID);

            final String script = testCaseAttrs.get(XML_SCRIPT);

            String testText = null;

            Integer[] expectGlyphs = null;

            Integer[] expectIndices = null;

            Map<String,String> fontAttrs = null;

            if(OPT_VERBOSE) {

                System.out.println("#"+caseNo+" id="+id + ", script="+script);

            }

            NodeList children = testCase.getChildNodes();

            for(int sub=0;sub<children.getLength();sub++) {

                Node n = children.item(sub);

                if(n.getNodeType()!=Node.ELEMENT_NODE) continue;

                String nn = n.getNodeName();

                if(nn.equals(XML_TEST_FONT)) {

                    fontAttrs = attrs(n);

                } else if(nn.equals(XML_TEST_TEXT)) {

                    testText = n.getTextContent();

                } else if(nn.equals(XML_RESULT_GLYPHS)) {

                    String hex = n.getTextContent();

                    expectGlyphs = parseHexArray(hex);

                } else if(nn.equals(XML_RESULT_INDICES)) {

                    String hex = n.getTextContent();

                    expectIndices = parseHexArray(hex);

                } else if(OPT_VERBOSE) {

                    System.out.println("Ignoring node " + nn);

                }

            }

            if(fontAttrs == null) {

                throw new IllegalArgumentException(id + " Missing node " + XML_TEST_FONT);

            }

            if(testText == null) {

                throw new IllegalArgumentException(id + " Missing node " + XML_TEST_TEXT);

            }

            String fontName = fontAttrs.get(XML_NAME);

            Font f = getFont(fontName, fontAttrs);

            if(f==null) {

                if(OPT_FAILMISSING) {

                    throw new MissingResourceException("Missing font,  abort test", Font.class.getName(), fontName);

                }

                System.out.println("Skipping " + id + " because font is missing: " + fontName);

                skipped++;

                continue;

            }

            FontRenderContext frc = new FontRenderContext(null, true, true);

            TextLayout tl = new TextLayout(testText,f,frc);

            final List<GlyphVector> glyphs = new ArrayList<GlyphVector>();

            Graphics2D myg2 = new Graphics2D(){

                    @Override

                    public void draw(Shape s) {

                        // TODO Auto-generated method stub

                    }

                    @Override

                    public boolean drawImage(Image img, AffineTransform xform,

                                             ImageObserver obs) {

                        // TODO Auto-generated method stub

                        return false;

                    }

                    @Override

                    public void drawImage(BufferedImage img,

                                          BufferedImageOp op, int x, int y) {

                        // TODO Auto-generated method stub

                    }

                    @Override

                    public void drawRenderedImage(RenderedImage img,

                                                  AffineTransform xform) {

                        // TODO Auto-generated method stub

                    }

                    @Override

                    public void drawRenderableImage(RenderableImage img,

                                                    AffineTransform xform) {

                        // TODO Auto-generated method stub

                    }

                    @Override

                    public void drawString(String str, int x, int y) {

                        // TODO Auto-generated method stub

                    }

                    @Override

                    public void drawString(String str, float x, float y) {

                        // TODO Auto-generated method stub

                    }

                    @Override

                    public void drawString(

                                           AttributedCharacterIterator iterator, int x, int y) {

                        // TODO Auto-generated method stub

                    }

                    @Override

                    public void drawString(

                                           AttributedCharacterIterator iterator, float x,

                                           float y) {

                        // TODO Auto-generated method stub

                    }

                    @Override

                    public void drawGlyphVector(GlyphVector g, float x, float y) {

                        if(x!=0.0 || y!=0.0) {

                            throw new InternalError("x,y should be 0 but got " + x+","+y);

                        }

                        //System.err.println("dGV : " + g.toString() + " @ "+x+","+y);

                        glyphs.add(g);

                    }

                    @Override

                    public void fill(Shape s) {

                        // TODO Auto-generated method stub

                    }

                    @Override

                    public boolean hit(Rectangle rect, Shape s, boolean onStroke) {

                        // TODO Auto-generated method stub

                        return false;

                    }

                    @Override

                    public GraphicsConfiguration getDeviceConfiguration() {

                        // TODO Auto-generated method stub

                        return null;

                    }

                    @Override

                    public void setComposite(Composite comp) {

                        // TODO Auto-generated method stub

                    }

                    @Override

                    public void setPaint(Paint paint) {

                        // TODO Auto-generated method stub

                    }

                    @Override

                    public void setStroke(Stroke s) {

                        // TODO Auto-generated method stub

                    }

                    @Override

                    public void setRenderingHint(Key hintKey, Object hintValue) {

                        // TODO Auto-generated method stub

                    }

                    @Override

                    public Object getRenderingHint(Key hintKey) {

                        // TODO Auto-generated method stub

                        return null;

                    }

                    @Override

                    public void setRenderingHints(Map<?, ?> hints) {

                        // TODO Auto-generated method stub

                    }

                    @Override

                    public void addRenderingHints(Map<?, ?> hints) {

                        // TODO Auto-generated method stub

                    }

                    @Override

                    public RenderingHints getRenderingHints() {

                        // TODO Auto-generated method stub

                        return null;

                    }

                    @Override

                    public void translate(int x, int y) {

                        // TODO Auto-generated method stub

                    }

                    @Override

                    public void translate(double tx, double ty) {

                        // TODO Auto-generated method stub

                    }

                    @Override

                    public void rotate(double theta) {

                        // TODO Auto-generated method stub

                    }

                    @Override

                    public void rotate(double theta, double x, double y) {

                        // TODO Auto-generated method stub

                    }

                    @Override

                    public void scale(double sx, double sy) {

                        // TODO Auto-generated method stub

                    }

                    @Override

                    public void shear(double shx, double shy) {

                        // TODO Auto-generated method stub

                    }

                    @Override

                    public void transform(AffineTransform Tx) {

                        // TODO Auto-generated method stub

                    }

                    @Override

                    public void setTransform(AffineTransform Tx) {

                        // TODO Auto-generated method stub

                    }

                    @Override

                    public AffineTransform getTransform() {

                        // TODO Auto-generated method stub

                        return null;

                    }

                    @Override

                    public Paint getPaint() {

                        // TODO Auto-generated method stub

                        return null;

                    }

                    @Override

                    public Composite getComposite() {

                        // TODO Auto-generated method stub

                        return null;

                    }

                    @Override

                    public void setBackground(Color color) {

                        // TODO Auto-generated method stub

                    }

                    @Override

                    public Color getBackground() {

                        // TODO Auto-generated method stub

                        return null;

                    }

                    @Override

                    public Stroke getStroke() {

                        // TODO Auto-generated method stub

                        return null;

                    }

                    @Override

                    public void clip(Shape s) {

                        // TODO Auto-generated method stub

                    }

                    @Override

                    public FontRenderContext getFontRenderContext() {

                        // TODO Auto-generated method stub

                        return null;

                    }

                    @Override

                    public Graphics create() {

                        // TODO Auto-generated method stub

                        return null;

                    }

                    @Override

                    public Color getColor() {

                        // TODO Auto-generated method stub

                        return null;

                    }

                    @Override

                    public void setColor(Color c) {

                        // TODO Auto-generated method stub

                    }

                    @Override

                    public void setPaintMode() {

                        // TODO Auto-generated method stub

                    }

                    @Override

                    public void setXORMode(Color c1) {

                        // TODO Auto-generated method stub

                    }

                    @Override

                    public Font getFont() {

                        // TODO Auto-generated method stub

                        return null;

                    }

                    @Override

                    public void setFont(Font font) {

                        // TODO Auto-generated method stub

                    }

                    @Override

                    public FontMetrics getFontMetrics(Font f) {

                        // TODO Auto-generated method stub

                        return null;

                    }

                    @Override

                    public Rectangle getClipBounds() {

                        // TODO Auto-generated method stub

                        return null;

                    }

                    @Override

                    public void clipRect(int x, int y, int width, int height) {

                        // TODO Auto-generated method stub