package Torello.JavaDoc.Annotations;

import Torello.HTML.TagNode;
import Torello.HTML.TextNode;
import Torello.HTML.HTMLNode;

import Torello.Java.StrCSV;

import Torello.Java.ReadOnly.ReadOnlyList;
import Torello.Java.ReadOnly.ReadOnlyArrayList;
import Torello.Java.ReadOnly.ROArrayListBuilder;

import Torello.JavaDoc.Messager.Messager;
import Torello.JavaDoc.Messager.MsgVerbose;

import Torello.JDUInternal.Miscellaneous.Where.JDUAnnotations;

import com.sun.source.tree.ExpressionTree;
import com.sun.source.tree.AssignmentTree;

import java.util.List;

import static com.sun.source.tree.Tree.Kind.ASSIGNMENT;


// EXPORTS:
//      String[] CSSClass() default { };
//      String[] EmbedTagFileID() default { };
// 
// package Torello.JDUInternal.Features.EXTERNAL_HTML_FILES
//      The classes in this package do the processing for inserting the HTML from External-HTML
//      Files into Java-Doc '.html' Output-Files.  It places an HTML <IMG SRC=...> at the top of
//      the page.  The Imge contains a Wooden-Panel, and the User's JDHBI HTML for that class is 
//      then placed on top of / over the Wood-Paneling


/**
 * An internally used data-record class used for storing all user-supplied annotation data 
 * associated with a single use / application of the {@link JDHeaderBackgroundImg} annotation.
 * 
 * @see Torello.JavaDoc.Annotations.JDHeaderBackgroundImg
 */
@Torello.JavaDoc.Annotations.JDHeaderBackgroundImg(EmbedTagFileID="MIRROR_JDHBI")
public class JDHBIMirror implements AnnotationMirror
{
    // ********************************************************************************************
    // ********************************************************************************************
    // Static Constants
    // ********************************************************************************************
    // ********************************************************************************************


    private static final String JDHBI_ATTR_NAME =
        Torello.JDUInternal.Features.EXTERNAL_HTML_FILES.ReplaceTags.EXPORT.JDHBI_ATTR_NAME();

    private static final String JDHBI_ATTR_VALUE =
        Torello.JDUInternal.Features.EXTERNAL_HTML_FILES.ReplaceTags.EXPORT.JDHBI_ATTR_VALUE();

    // Used simply to insert a new-line character into an HTML-Vector
    private static final TextNode NEW_LINE = new TextNode("\n");


    // ********************************************************************************************
    // ********************************************************************************************
    // Public, Final, ReadOnly, Mirrored Fields
    // ********************************************************************************************
    // ********************************************************************************************


    /** Holds data extracted from {@link JDHeaderBackgroundImg#EmbedTagFileID()} */
    public final ReadOnlyList<HTMLNode> externalEmbedTags;

    /** Holds data extracted from {@link JDHeaderBackgroundImg#CSSClass()} */
    public final TagNode tnDIV;


    // ********************************************************************************************
    // ********************************************************************************************
    // interface AnnotationMirror
    // ********************************************************************************************
    // ********************************************************************************************


    // Stores the actual text of the @StaticFunctional annotation which was placed.
    // This is nothing more than the exact line that was originally inserted into the class.
    // The only reason this is even needed (in case you are wondering) is because the error 
    // checking & error printing code outputs this text when printing an error message.

    private final String annotationAsStr;

    /** {@inheritDoc} */ @Override
    public String getAnnotationAsString() { return annotationAsStr; }

    /** {@inheritDoc} */ @Override
    public String getAnnotationName() { return "JDHeaderBackgroundImg"; }


    // ********************************************************************************************
    // ********************************************************************************************
    // Package-Private Constructor, Invoked by class "TypeAnnotationMirrors"
    // ********************************************************************************************
    // ********************************************************************************************


    JDHBIMirror(
            final List<? extends ExpressionTree>    arguments,
            final String                            annotationAsStr
        )
    {
        this.annotationAsStr = annotationAsStr;

        ReadOnlyList<String>    cssClasses          = null;
        ReadOnlyList<String>    embedTagFileIDs     = null;
        ReadOnlyList<HTMLNode>  externalEmbedTags   = null;
        TagNode                 tnDIV               = null;

        for (ExpressionTree argument : arguments)
        {
            /*
            System.out.println(
                "argument:                            " + argument.toString() + '\n' +
                "argument.getKind():                  " + argument.getKind().toString() + '\n' +
                "argument.getClass().getSimpleName(): " + argument.getClass().getSimpleName()
            );
            */

            // System.out.println(argument);

            if (argument.getKind() != ASSIGNMENT) Messager.assertFail(
                "The ExpressionTree returned by the @JDHeaderBackgroundImg arguments list was " +
                "not of type ASSIGNMENT, but rather " + argument.getKind() + '\n' +
                "ExpressionTree.toString(): " + argument.toString() + '\n' +
                "All Annotation Expressions: " + StrCSV.toCSV(arguments, true, true, null),
                null,
                JDUAnnotations.JDHBIMirror
            );

            String          elemName    = ((AssignmentTree) argument).getVariable().toString();
            ExpressionTree  elemValue   = ((AssignmentTree) argument).getExpression();

            /*
            System.out.println(
                "    elemName:             " + elemName + '\n' +
                "    elemValue.toString(): " + elemValue.toString() + '\n' +
                "    elemValue.getKind():  " + elemValue.getKind().toString() + '\n' +
                "    elemValue.getClass(): " + elemValue.getClass().getSimpleName() + '\n'
            );
            */

            if (elemName.equals("CSSClass")) cssClasses =
                HELPER.handleStringArray(elemValue, "CSSClass", JDUAnnotations.CSSLMirror);

            else if (elemName.equals("EmbedTagFileID")) embedTagFileIDs =
                HELPER.handleStringArray(elemValue, "EmbedTagFileID", JDUAnnotations.CSSLMirror);

            else Messager.assertFail(
                "There was an Expression Variable-Name that was neither 'CSSClass' nor " +
                "'EmbedTagFileID', but rather: " + elemName,
                null,
                JDUAnnotations.JDHBIMirror
            );
        }

        if (embedTagFileIDs == null)
            externalEmbedTags = ReadOnlyArrayList.emptyROAL();

        else 
        {
            int i = 0;

            ROArrayListBuilder<HTMLNode> roalb = new ROArrayListBuilder<>();

            for (String embedTagFileID : embedTagFileIDs)
            {
                roalb.add(
                    new TagNode(
                        "<EMBED DATA-" + JDHBI_ATTR_NAME + '=' + JDHBI_ATTR_VALUE +
                        " CLASS='external-html' DATA-FILE-ID=" +
                        embedTagFileIDs.get(i++) +">"
                    ));

                roalb.add(NEW_LINE);
            }

            externalEmbedTags = roalb.build();
        }


        // These are used in class "EmbedTag" which does all of the HTML work for
        // "JDHeaderBackgroundImg"

        if (cssClasses == null)
            tnDIV = null;

        else if (cssClasses.size() == 1)
            tnDIV = new TagNode("<DIV CLASS=" + cssClasses.get(0) + ">");

        else
        {
            // When the user uses the annotation as below:
            // @JDHeaderBackgroundImg(CSSClass={"MyCSSClassA", "MyCSSClassB", "MyCSSClassC", ...})

            final StringBuilder sb = new StringBuilder();

            for (String cssClass : cssClasses) sb.append(cssClass + " ");

            tnDIV = new TagNode
                ("<DIV CLASS='" + sb.subSequence(0, sb.length() - 1) + "'>");
        }

        if (MsgVerbose.isVerbose()) MsgVerbose.println(
            "@JDHeaderBackgroundImg Annotation-Processing Mirror Class:" +
            "    cssClasses:      " + StrCSV.toCSV(cssClasses, true, false, null) + '\n' +
            "    embedTagFileIDs: " + StrCSV.toCSV(embedTagFileIDs, true, false, null)
        );

        this.externalEmbedTags  = externalEmbedTags;
        this.tnDIV              = tnDIV;
    }

    // ********************************************************************************************
    // ********************************************************************************************
    // toString
    // ********************************************************************************************
    // ********************************************************************************************


    /** {@inheritDoc} */ @Override
    public String toString()
    {
        // public final ReadOnlyList<HTMLNode> externalEmbedTags;
        // public final TagNode tnDIV;
        // 
        // "    externalEmbedTags: ".length() ==> 23

        return 
            annotationAsStr + '\n' +
            "{\n" +
            "    externalEmbedTags: " + HELPER.TOSTR(this.externalEmbedTags, 23) + '\n' +
            "    tnDIV:             " + HELPER.TOSTR(this.tnDIV.str, 23) + '\n' +
            "}";

    }
}