package Torello.JavaDoc.SyntaxHiLite;

import Torello.Java.OSCommands;
import Torello.Java.OSExtras;
import Torello.Java.OSResponse;
import Torello.Java.StrCmpr;
import Torello.Java.OSJavaPipe;
import Torello.Java.FileRW;

import Torello.Java.ReadOnly.ReadOnlyArrayList;
import Torello.Java.ReadOnly.ReadOnlyList;
import Torello.JavaDoc.Annotations.LinkJavaSource;
import Torello.HTML.HTMLNode;
import Torello.HTML.HTMLPage;
import Torello.HTML.Util;

import java.util.Objects;
import java.util.Vector;
import java.io.IOException;

/**
 * Java-Adapter for a Python-Tool which Hi-Lites Source Code.
 * 
 * <BR /><BR />
 * Visit <A HREF='pygments.org' TARGET=_blank>http://Pygments.org</A> for details.
 * 
 * <EMBED CLASS='external-html' DATA-FILE-ID=CLI_HELP>
 * <EMBED CLASS='external-html' DATA-FILE-ID=PYGMENTIZE_CLASSES>
 * 
 * @see OSCommands
 * @see OSJavaPipe
 */
public class Pygmentize extends OSCommands
{
    public static final ReadOnlyList<String> CODE_TYPES = new ReadOnlyArrayList<>(
        "java", "html", "js", "css", "json", "properties", "xml", "py", "c", "cpp", "csharp", "go",
        "php", "ruby", "bash", "sh", "sql", "yaml", "toml", "ini", "docker", "make", "gradle",
        "swift", "kotlin", "rust", "scala", "perl", "r", "ts", "tsx", "jsx", "md", "txt"
    );


    // ********************************************************************************************
    // ********************************************************************************************
    // Constructor
    // ********************************************************************************************
    // ********************************************************************************************


    public static void main(String[] argv) throws IOException
    {
        if (argv.length != 1)
        {
            System.out.println("You must pass the file-name of a Java-File");
            System.exit(1);
        }

        final Pygmentize        p = new Pygmentize();
        final String            f = FileRW.loadFileToString(argv[0]);
        final Vector<HTMLNode>  h = p.hiLite(f, "java", true, (byte) 1);
        final String            s = Util.pageToString(h);

        System.out.println(s);
    }

    public Pygmentize() { super(null, null); }

    public Pygmentize clone()
    { throw new RuntimeException(new CloneNotSupportedException()); }


    // ********************************************************************************************
    // ********************************************************************************************
    // Convert Source-Code (as a String) into an HiLited HTML-String
    // ********************************************************************************************
    // ********************************************************************************************


    // NON-HTML-TEXT Output Save ...
    //  new String[] { "pygmentize", "-l", codeTypeParam,  "-O", dashO }

    @LinkJavaSource(handle="CleanHTML", name="clean")
    public synchronized Vector<HTMLNode> hiLite(
            final String    codeText,
            final String    codeTypeParam,
            final boolean   useLineNumbers,
            final byte      styleNum
        )
        throws IOException
    {
        Objects.requireNonNull(codeText,        "'codeText' Parameter has been passed null.");
        Objects.requireNonNull(codeTypeParam,   "'codeTypeParam' Parameter has been passed null.");

        final String dashO =
            "classprefix=H" + styleNum + "-" +
            (useLineNumbers ? ",linenos=table" : "");

        final String[] cmdArr =
            { "pygmentize", "-l", codeTypeParam, "-f", "html",  "-O", dashO };

        // This "Pipes" the input to the CLI Command
        this.osExtras           = new OSExtras();
        this.osExtras.javaPipe  = new OSJavaPipe(codeText);

        // Run Python's "pygmentize" - downloaded via 'pip' from Pygments.org
        final OSResponse osr = super.printAndRun(cmdArr);

        if (osr.response != 0) throw new PygmentizeException(
            "The O/S Process for 'pygmentize' has returned a non-zero Status\n" +
            THROW.HORIZ_SEP +
            "OSResponse.response: " +       osr.response + '\n' +
            "OSResponse.errorOutpu:\n" +    osr.errorOutput + '\n' +
            THROW.paramsAsStr(codeText, codeTypeParam, styleNum, useLineNumbers)
        );

        try 
        {
            final String html               = osr.standardOutput;
            final Vector<HTMLNode> retVec   = HTMLPage.getPageTokens(html, false);

            CleanHTML.clean(retVec, useLineNumbers);

            return retVec;
        }

        catch (Exception e) 
        {
            throw new PygmentizeException(
                "An error has occured while attempting to parse and simplify the returned HTML" +
                THROW.paramsAsStr(codeText, codeTypeParam, styleNum, useLineNumbers),
                e
            );
        }
    }

    public synchronized Vector<HTMLNode> hiLite(
            final String        codeText,
            final String        codeTypeParam,
            final boolean       includeLineNumbers,
            final byte          styleNum,
            final HiLiteCache   cache
        )
        throws IOException
    {
        Objects.requireNonNull(codeText,        "'codeText' Parameter has been passed null.");
        Objects.requireNonNull(codeTypeParam,   "'codeTypeParam' Parameter has been passed null.");
        Objects.requireNonNull(cache,           "'cache' Parameter has been passed null.");

        // FIRST: Check the Cache, to see if the exact String has been hilited!
        final String cached =
            cache.get(codeText, codeTypeParam, includeLineNumbers, styleNum);

        // If there was a Cache hit -> return that String rather than querying the server.
        if (cached != null) return HTMLPage.getPageTokens(cached, false);


        // NO?  ==>  Then query the server.
        // 
        // final Vector<HTMLNode> retVec = RESTToVector.run
        //     (codeText, codeTypeParam, styleTypeParam, includeLineNumbers);

        final Vector<HTMLNode> html =
            this.hiLite(codeText, codeTypeParam, includeLineNumbers, styleNum);

        // Make sure to save the response in the Cache for next time
        cache.checkIn
            (codeText, Util.pageToString(html), codeTypeParam, includeLineNumbers, styleNum);

        return html;
    }
}