/* $Id: GenerateLatexTest.java,v 1.14 2007/02/25 20:04:33 m31 Exp $
 *
 * This file is part of the project "Hilbert II" - http://www.qedeq.org
 *
 * Copyright 2000-2007,  Michael Meyling <mime@qedeq.org>.
 *
 * "Hilbert II" is free software; you can redistribute
 * it and/or modify it under the terms of the GNU General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This program 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 for more details.
 */

package org.qedeq.kernel.latex;

import java.io.File;
import java.io.IOException;

import org.qedeq.kernel.bo.control.QedeqBoFactoryTest;
import org.qedeq.kernel.bo.module.ModuleDataException;
import org.qedeq.kernel.rel.test.text.Xml2Latex;
import org.qedeq.kernel.test.QedeqTestCase;
import org.qedeq.kernel.utility.IoUtility;
import org.qedeq.kernel.xml.mapper.XmlFilePositionException;

/**
 * Test generating LaTeX files for all known samples.
 * 
 * @version $Revision: 1.14 $
 * @author Michael Meyling
 */
public final class GenerateLatexTest extends QedeqTestCase {

    /**
     * Start main process.
     * 
     * @throws Exception
     */
    public void testGeneration() throws Exception {
        File docDir = new File("../QedeqDoc");
        File genDir = new File("../QedeqGenerated");
        // test if we are in the normal development environment, where a project with name
        //  "../QedeqDoc" exists, otherwise we assume to run within the release directory
        //  structure where the docs are in the directory ../doc
        if (!docDir.exists()) {
            docDir = new File("../doc");
            genDir = new File("../doc");
            if (!docDir.exists()) {
                throw new IOException("unknown source directory for qedeq modules");
            }
        }
        
        generate(docDir, "math/qedeq_sample1.xml", genDir);
        generate(docDir, "math/qedeq_set_theory_v1.xml", genDir);
        generate(docDir, "math/qedeq_logic_v1.xml", genDir);
        generate(docDir, "project/qedeq_basic_concept.xml", genDir);
        generate(docDir, "project/qedeq_logic_language.xml", genDir);
                
        try {
            generate(new File("."), "data/qedeq_sample2_error.xml", "de",
                new File("."));
            fail("IllegalModuleDataException expected");
        } catch (XmlFilePositionException e) {
            assertTrue(e.getCause() instanceof ModuleDataException);
            assertEquals(221, e.getSourceArea().getStartPosition().getLine());
            assertEquals(9, e.getSourceArea().getStartPosition().getColumn());
        }
    }
    
    /**
     * Call the generation of one LaTeX file and copy XML source to same destination directory for
     * all supported languages.
     * <p>
     * Tests also if the parsed context can be found by
     * {@link org.qedeq.kernel.xml.mapper.Context2XPath#getXPath(ModuleContext)}.
     *
     * @param   dir         Start directory.
     * @param   xml         Relative path to XML file. Must not be <code>null</code>.
     * @param   destinationDirectory Directory path for LaTeX file. Must not be <code>null</code>.
     * @throws  Exception   Failure.
     */
    private final static void generate(final File dir, final String xml, 
            final File destinationDirectory) throws Exception {
        generate(dir, xml, "en", destinationDirectory);
        generate(dir, xml, "de", destinationDirectory);
        QedeqBoFactoryTest.loadQedeqAndAssertContext(new File(dir, xml));
    }

    /**
     * Call the generation of one LaTeX file and copy XML source to same destination directory.
     *
     * @param   dir         Start directory.
     * @param   xml         Relative path to XML file. Must not be <code>null</code>.
     * @param   language    Generate text in this language. Can be <code>null</code>.
     * @param   destinationDirectory Directory path for LaTeX file. Must not be <code>null</code>.
     * @throws  IOException File IO failed.
     * @throws  XmlFilePositionException File data is invalid.
     */
    private static void generate(final File dir, final String xml, final String language,
            final File destinationDirectory) throws IOException, XmlFilePositionException {
        final File xmlFile = new File(dir, xml);
        final File texFile = new File(Xml2Latex.generate(xmlFile.getAbsolutePath(), null, language, 
            "1"));
        final File texCopy = new File(destinationDirectory, new File(new File(xml).getParent(), 
            texFile.getName()).getPath());
        final File xmlCopy = new File(destinationDirectory, xml);
        IoUtility.copyFile(xmlFile, xmlCopy);
        IoUtility.copyFile(texFile, texCopy);
    }

}