/* Run the Ptolemy model tests in the auto/ directory using cg code generation under JUnit.

   Copyright (c) 2011-2014 The Regents of the University of California.
   All rights reserved.
   Permission is hereby granted, without written agreement and without
   license or royalty fees, to use, copy, modify, and distribute this
   software and its documentation for any purpose, provided that the above
   copyright notice and the following two paragraphs appear in all copies
   of this software.

   IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
   FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
   ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
   THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
   SUCH DAMAGE.

   THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
   INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
   MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
   PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
   CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
   ENHANCEMENTS, OR MODIFICATIONS.

   PT_COPYRIGHT_VERSION_2
   COPYRIGHTENDKEY

 */

package ptolemy.util.test.junit;

import java.io.File;
import java.lang.reflect.Method;
import java.util.Arrays;
import java.util.LinkedList;

import org.junit.Assert;

import ptolemy.util.FileUtilities;
import ptolemy.util.StringUtilities;

///////////////////////////////////////////////////////////////////
//// AutoCGTests

/**
 * Run the Ptolemy model tests in the auto/ directory using cg code generation
 * under JUnit.
 *
 * <p>
 * This class provides common facilities used by classes that generate
 * C and Java code.
 *
 * @author Christopher Brooks
 * @version $Id: AutoCGTests.java 70402 2014-10-23 00:52:20Z cxh $
 * @since Ptolemy II 10.0
 * @Pt.ProposedRating Red (cxh)
 * @Pt.AcceptedRating Red (cxh)
 */
public class AutoCGTests extends ModelTests {

    /**
     * Find the ptolemy.cg.kernel.generic.GenericCodeGenerator class
     * and its generateCode static method that takes an array of
     * strings.
     *
     * @exception Throwable If the class or constructor cannot be found.
     */
    public void setUp() throws Throwable {
        _applicationClass = Class
                .forName("ptolemy.cg.kernel.generic.GenericCodeGenerator");

        _cgDirectory = new File(StringUtilities.getProperty("user.home")
                + "/cg");

        Class[] argTypes = new Class[] { String[].class };
        _generateCodeMethod = _applicationClass.getMethod("generateCode",
                argTypes);
    }

    /**
     *  Generate, compile and run code for a model.
     *  The
     *  @param fullPath
     *            The full path to the model file to be executed. If the
     *            fullPath ends with the value of the
     *            {@link #THERE_ARE_NO_AUTO_TESTS}, then the method returns
     *            immediately.
     * @param language Either "c" or "java".
     * @param generateInSubdirectory If true, then generate the code in
     * in a subdirectory of ~/cg/.
     * @param inline If true, then generate inline code.
     * @param maximumLinesPerBlock The maximum number of line of code
     * generated per block
     * @param variablesAsArrays If true, then try to save space by
     * putting variables into arrays.
     * @param generatorPackageList A semicolon or * separated list of
     * Java packages to be searched for adapters.  For example,
     * generic.program.procedural.c.arduino means use the arduino
     * target.
     * @exception Throwable If thrown while generating, compiling or
     * executing the compiled code.
     */
    public void runModel(String fullPath, String language,
            boolean generateInSubdirectory, boolean inline,
            int maximumLinesPerBlock, boolean variablesAsArrays,
            String generatorPackageList) throws Throwable {
        if (fullPath.endsWith(THERE_ARE_NO_AUTO_TESTS)) {
            System.out.println("No auto/*.xml tests in "
                    + StringUtilities.getProperty("user.dir"));
            return;
        }

        // Delete the ~/cg directory each time so that if the user generates code for
        // a model using -generateInSubdirectory, we can still have gcc generate an
        // executable with that name.
        if (!FileUtilities.deleteDirectory(_cgDirectory)) {
            System.out.println("Warning, failed to delete " + _cgDirectory);
        }

        LinkedList<String> argumentsList = new LinkedList<String>(
                Arrays.asList("-language", language, "-generateInSubdirectory",
                        Boolean.toString(generateInSubdirectory), "-inline",
                        Boolean.toString(inline), "-maximumLinesPerBlock",
                        Integer.toString(maximumLinesPerBlock),
                        "-variablesAsArrays",
                        Boolean.toString(variablesAsArrays)));
        if (generatorPackageList != null && generatorPackageList.length() > 0) {
            argumentsList.add("-generatorPackageList");
            argumentsList.add(generatorPackageList);
        }
        argumentsList.add(fullPath);

        String[] args = argumentsList.toArray(new String[argumentsList.size()]);

        System.out.print("----------------- AutoCG $PTII/bin/ptcg");
        for (int i = 0; i < args.length; i++) {
            System.out.print(" " + args[i]);
        }

        int returnValue = ((Integer) _generateCodeMethod.invoke(null,
                (Object) args)).intValue();
        if (returnValue != 0) {
            System.out
            .println("AutoCGTests: "
                    + fullPath
                    + ": Return value of the last command executed was not zero, it was: "
                    + returnValue + ", marking this as a test failure.");
            Assert.fail("Return value of the last command executed was not zero, it was: "
                    + returnValue);
        }
    }

    ///////////////////////////////////////////////////////////////////
    ////                         protected variables               ////

    /** The directory where the code is generated, usually $HOME/cg. */
    protected static File _cgDirectory;

    /** The GenericCodeGenerator.generateCode(String[]) method. */
    protected static Method _generateCodeMethod;

}