package Torello.JavaDoc.Annotations;

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

import Torello.Java.StringParse;

import Torello.JavaDoc.Messager.Messager;
import Torello.JavaDoc.Messager.MsgPrintTools;
import Torello.JDUInternal.Miscellaneous.Where.JDUAnnotations;
import Torello.JavaDoc.Messager.Where_Am_I;

import static Torello.Java.C.BCYAN;
import static Torello.Java.C.BGREEN;
import static Torello.Java.C.BYELLOW;
import static Torello.Java.C.BRED;
import static Torello.Java.C.RESET;

import java.util.List;

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


// EXPORTS:
//      public Background background() default Background.Blue;
//      public String title() default "";
//      public String divCSSClass() default "";
//      public String tableCSSClass() default "";
// 
// The following files are relatedf to this Annotation-Mirror Data-Class:
// 
// * Torello.JDUInternal.SimpleFeatures.IntoHTMLTableProc
//      This is the primary or "Work Horse" Method for Generating the HTML-Table that is inserted
//      into the Detail-Entry "description()" section.
// 
// * User-Annotations.css
//      For the CSS Color Choices/Options/Definitions
//      Since there are a suite of Color-Choices which have been presented to the user


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


    // I usually don't do this, but this is used inside of switch-statement, and therefore using 
    // this becomes extremely cumbersome if it isn't in a shorter variable name.

    private static final Where_Am_I WHERE_AM_I = JDUAnnotations.IHTMirror;

    private static final ECData<Torello.JavaDoc.Annotations.IntoHTMLTable.Background> ecParser =
        new ECData<>(
            IntoHTMLTable.Background.class,

            // These are strictly needed for Error message which are being passed to the messager
            JDUAnnotations.IHTMirror,               // Where_Am_I 
            IntoHTMLTable.class.getSimpleName(),    // The name of the Annoation
            "background"                            // The Annotation-Element being processed
        );


    // ********************************************************************************************
    // ********************************************************************************************
    // 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 "IntoHTMLTable"; }


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


    /** Holds data extracted from {@link IntoHTMLTable#background()} */
    public final IntoHTMLTable.Background background;

    /** Holds data extracted from {@link IntoHTMLTable#title()} */
    public final String title;

    /** Holds data extracted from {@link IntoHTMLTable#divCSSClass()} */
    public final ReadOnlyList<String> divCSSClass;

    /** Holds data extracted from {@link IntoHTMLTable#tableCSSClass()} */
    public final ReadOnlyList<String> tableCSSClass;


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


    IHTMirror(
            // The parsed arguments to to the Annotation
            final List<? extends ExpressionTree> arguments,


            // This is the Annotation, as a simple Java-String.  This is very useful for
            // Error-Printing with the Messager.  That's the only purpose of it

            final String annotationAsStr,


            // The Signature of the Detail-Entity onto which this "@LinkJavaSource" Annotation
            // was placed.  Very important for error messages

            final String signature
        )
    {
        IntoHTMLTable.Background    background          = null;
        String                      title               = null;
        String                      divCSSClassSTR      = null;
        String                      tableCSSClassSTR    = null;

        for (int i = 0; i < arguments.size(); i++)
        {
            final ExpressionTree expr = arguments.get(i);

            if (! (expr instanceof AssignmentTree)) Messager.assertFail(
                "Annotation Placed:\n" +
                "    " + BCYAN + annotationAsStr + RESET + '\n' +
                "While parsing the Arguments / Elements of an IHTMirror Annotation, the " +
                "Oracle-Parser (com.sun.source.tree) returned an instance of `ExpressionTree` " +
                "that was not an instance of `AssignmentTree`." +
                MsgPrintTools.annotationProcessingError(),
                WHERE_AM_I
            );

            final AssignmentTree assignExpr = (AssignmentTree) expr;

            // Extracting the left-hand side (LHS) and right-hand side (RHS)
            final ExpressionTree LHS = assignExpr.getVariable();
            final ExpressionTree RHS = assignExpr.getExpression();

            final String lhsStr = LHS.toString();

            final String rhsStr = (RHS instanceof LiteralTree) 
                ? ((LiteralTree) RHS).getValue().toString()
                : RHS.toString();

            switch (lhsStr)
            {
                case "background":

                    if (background != null) HELPER.dupErrorAE
                        (annotationAsStr, background, "background", rhsStr, WHERE_AM_I);
                    else
                        background = ecParser.valueOf(rhsStr, signature);

                    break;


                case "title":

                    if (title != null) HELPER.dupErrorAE
                        (annotationAsStr, title, "title", rhsStr, WHERE_AM_I);
                    else
                        title = rhsStr;

                    break;


                case "divCSSClass":

                    if (divCSSClassSTR != null) HELPER.dupErrorAE
                        (annotationAsStr, divCSSClassSTR,  "divCSSClass", rhsStr, WHERE_AM_I);
                    else
                        divCSSClassSTR = rhsStr;

                    break;


                case "tableCSSClass":

                    if (tableCSSClassSTR != null) HELPER.dupErrorAE
                        (annotationAsStr, tableCSSClassSTR, "tableCSSClass", rhsStr, WHERE_AM_I);
                    else 
                        tableCSSClassSTR = rhsStr;

                    break;


                default: Messager.userErrorContinue(
                    "While proessing a @IntoHTMLTable Annotation, the following " +
                    "Annotation-Element Name was found:\n" +
                    "    [" + lhsStr + "]\n" +
                    "This is not a valid Annotation-Argument.  This is not one of " +
                    "@IntoHTMLTable' Elements (sometimes called \"Arguements\")\n" +
                    "Valid Element-Names for this Annotation Include:\n" +
                    "    background, title, divCSSClass, and tableCSSClass" +
                    MsgPrintTools.annotationProcessingError(),
                    WHERE_AM_I
                );
            }
        }

        this.annotationAsStr    = annotationAsStr;
        this.background         = background;

        this.title = (title.length() == 0)
            ? null 
            : title;

        this.divCSSClass = ((divCSSClassSTR == null) || (divCSSClassSTR.length() == 0))
            ? ReadOnlyArrayList.emptyROAL()
            : new ReadOnlyArrayList<String>(divCSSClassSTR.split("\\s"));

        this.tableCSSClass = ((tableCSSClassSTR == null) || (tableCSSClassSTR.length() == 0))
            ? ReadOnlyArrayList.emptyROAL()
            : new ReadOnlyArrayList<String>(tableCSSClassSTR.split("\\s"));

        IHTErrorCheck.check(this, annotationAsStr, signature);
    }


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


    /** {@inheritDoc} */ @Override
    public String toString()
    {
        // 19 ==> Width of the Title Strings....  They are all 19 characters wide
        // 
        // public final Background              background;
        // public final String                  title;
        // public final ReadOnlyList<String>    divCSSClass;
        // public final ReadOnlyList<String>    tableCSSClass;

        return
            annotationAsStr + '\n' +
            "{\n" +
            "    background:    " + background.toString()                   + '\n' +
            "    title:         " + HELPER.TOSTR(this.title, 19)            + '\n' +
            "    divCSSClass:   " + HELPER.TOSTR(this.divCSSClass, 19)      + '\n' +
            "    tableCSSClass: " + HELPER.TOSTR(this.tableCSSClass, 19)    + '\n' +
            '}';
    }
}