package Torello.JavaDoc.SyntaxHiLite;

import Torello.HTML.InnerTagKeyException;
import Torello.CSS.ClassNameCSSException;

import Torello.HTML.HTMLNode;
import Torello.HTML.TagNode;
import Torello.HTML.SD;
import Torello.HTML.HTMLPage;
import Torello.HTML.Util;

import Torello.Java.FileRW;
import Torello.Java.UnreachableError;

import Torello.Java.ReadOnly.ReadOnlyMap;
import Torello.Java.ReadOnly.ROTreeMapBuilder;

import Torello.Java.Additional.Ret2;

import static Torello.Java.C.BYELLOW;
import static Torello.Java.C.RESET;

import java.util.Vector;
import java.util.Objects;
import java.util.Iterator;

import java.io.IOException;

public class HiLiteHTML
    extends AbstractHiLiter
    implements java.io.Serializable
{
    protected static final long serialVersionUID = 1;


    // ********************************************************************************************
    // ********************************************************************************************
    // Special Attribute HiLiting: Additional / Extra Configuration Class
    // ********************************************************************************************
    // ********************************************************************************************


    public static class Indices
    {
        private Indices() { }

        public static final byte COMMENTS       = 1;
        public static final byte OPENING_TAGS   = 2;
        public static final byte CLOSING_TAGS   = 3;

        public static final byte LT_GT_S        = 4;
        public static final byte TAG_NAMES      = 5;
        public static final byte ATTR_KEYS      = 6;
        public static final byte ATTR_VALS      = 7;
        public static final byte SPLITS         = 8;

        // any_array.length => 9 (Note that any_array[0] is unused!)
        public static final byte CONFIG_ARR_LEN = 9;  
    }


    // ********************************************************************************************
    // ********************************************************************************************
    // STATIC-INNER-CLASS: Config
    // ********************************************************************************************
    // ********************************************************************************************


    public static class Config
        extends AbstractConfig<Torello.JavaDoc.SyntaxHiLite.HiLiteHTML.Config>
        implements java.io.Serializable, Cloneable
    {    
        protected static final long serialVersionUID = 1;

        /*
        spansOrBolds[0] = who-cares?

        spansOrBolds[Indices.COMMENTS]      = true;
        spansOrBolds[Indices.OPENING_TAGS]  = true;
        spansOrBolds[Indices.CLOSING_TAGS]  = true;

        spansOrBolds[Indices.LT_GT_S]       = false;
        spansOrBolds[Indices.TAG_NAMES]     = false;
        spansOrBolds[Indices.ATTR_KEYS]     = false;
        spansOrBolds[Indices.ATTR_VALS]     = false;
        spansOrBolds[Indices.SPLITS]        = false;
        */

        private static final boolean[] default_SpansOrBolds = new boolean[]
        { false, true, true, true, false, false, false, false, false };

        // This is "Package-Private" - it might be used by the equals, tostring and clone methods!
        ROTreeMapBuilder<String, AttribRule> rotmb = null;

        public Config()
        { super(Indices.CONFIG_ARR_LEN, default_SpansOrBolds, HiLiteHTML.Config.class); }

        private Config(HiLiteHTML.Config c)
        {
            super(c);
            if (c.rotmb != null) this.rotmb = c.rotmb.clone();
        }


        // ****************************************************************************************
        // ****************************************************************************************
        // Class-Config - java.lang.Object & java.lang.Cloneable
        // ****************************************************************************************
        // ****************************************************************************************


        public boolean equals(Object other)
        {
            if (! super.equals(other)) return false;
            return ((HiLiteHTML.Config) other).rotmb.equals(this.rotmb);
        }

        public String toString()
        { return ToStringHTML.classConfig(this); }

        public HiLiteHTML.Config clone()
        { return new HiLiteHTML.Config(this); }


        // ****************************************************************************************
        // ****************************************************************************************
        // Class-Config - The Methods added (in addition to) those in super-class "AbstractConfig"
        // ****************************************************************************************
        // ****************************************************************************************


        public synchronized HiLiteHTML.Config addRule(AttribRule rule)
        {
            AttribRule ar = rule.clone();
            ar.validate();
            if (this.rotmb == null) this.rotmb = new ROTreeMapBuilder<>();
            rotmb.put(rule.attributeName, rule);
            return this;
        }

        public synchronized Iterator<AttribRule> getExtraAttribRules()
        {
            return (this.rotmb == null)
                ? java.util.Collections.emptyIterator()
                : rotmb.values().iterator();
        }


        // ****************************************************************************************
        // ****************************************************************************************
        // STATIC-INNER-CLASS Config: Generate HiLiteHTML
        // ****************************************************************************************
        // ****************************************************************************************


        public synchronized HiLiteHTML generateHiLiter() 
        {
            Ret2<TagNode[], TagNode[]> r2 = generateHiLiterHelper();

            final ReadOnlyMap<String, AttribRule> rom = (this.rotmb != null)
                ? this.rotmb.build()
                : null;

            return new HiLiteHTML(r2.a /* openers */, r2.b /* closers */, this.utilize, rom);
        }
    }


    // ********************************************************************************************
    // ********************************************************************************************
    // Special Attribute HiLiting: Additional / Extra Configuration Class
    // ********************************************************************************************
    // ********************************************************************************************


    public static class AttribRule implements java.io.Serializable, Cloneable
    {
        protected static final long serialVersionUID = 1;

        public String attributeName             = null;
        public String attributeName_ClassName   = null;
        public String attributeValue_ClassName  = null;

        public boolean spanOrBold = true;

        public AttribRule() { }

        public void validate()
        {
            InnerTagKeyException.check(this.attributeName);
            ClassNameCSSException.check(this.attributeName_ClassName);
            ClassNameCSSException.check(this.attributeValue_ClassName);
        }

        public HiLiteHTML.AttribRule clone()
        {
            final HiLiteHTML.AttribRule ret = new HiLiteHTML.AttribRule();
    
            ret.attributeName               = this.attributeName;
            ret.attributeName_ClassName     = this.attributeName_ClassName;
            ret.attributeValue_ClassName    = this.attributeValue_ClassName;
            ret.spanOrBold                  = this.spanOrBold;
    
            return ret;
        }
    
        public boolean equals(Object other)
        {
            if (! (other instanceof HiLiteHTML.AttribRule)) return false;
    
            HiLiteHTML.AttribRule o = (HiLiteHTML.AttribRule) other;
    
            return
                    Objects.equals(this.attributeName, o.attributeName)
                &&  Objects.equals(this.attributeName_ClassName, o.attributeName_ClassName)
                &&  Objects.equals(this.attributeValue_ClassName, o.attributeValue_ClassName)
                &&  (this.spanOrBold == o.spanOrBold);
        }

        public String toString()
        { return ToStringHTML.classAttribRule(this); }

        public int hashCode()
        { return this.attributeName.hashCode(); }

    }


    // ********************************************************************************************
    // ********************************************************************************************
    // MAIN-CLASS
    // ********************************************************************************************
    // ********************************************************************************************


    private final DoHiLiteHTML.TagsNonPWA tags;
    private final DoHiLiteHTML.TagsPWA tpwa;

    public final ReadOnlyMap<String, AttribRule> extraRules;

    private HiLiteHTML(
            final TagNode[] openers,
            final TagNode[] closers,
            final boolean[] utilize,
            final ReadOnlyMap<String, AttribRule> extraRules
        )
    {
        super(openers, closers, utilize);

        this.tags       = new DoHiLiteHTML.TagsNonPWA(openers, closers, utilize);
        this.tpwa       = new DoHiLiteHTML.TagsPWA(openers, closers, utilize);
        this.extraRules = extraRules;
    }

    public static HiLiteHTML generateHiLiterDefault()
    { return new Config().generateHiLiter(); }

    public Vector<HTMLNode> hiLite(Vector<HTMLNode> html)
    { return DoHiLiteHTML.run(html, this.tpwa, this.tags); }

    public String toString()
    { return ToStringHTML.classHiLiteHTML(this, this.CONFIG_ARR_LEN, this.tags, this.tpwa); }

    public boolean equals(Object other)
    {
        return (! super.equals(other))
            ? false
            : this.extraRules.equals(((HiLiteHTML) other).extraRules);
    }


    // ********************************************************************************************
    // ********************************************************************************************
    // Testing This
    // ********************************************************************************************
    // ********************************************************************************************


    public static void main(String[] argv) throws IOException 
    {
        String htmlAsStr =
            FileRW.loadFileToString("Torello/BuildJAR/Documentation/Global/Appendable.html");

        Vector<HTMLNode> htmlAsVec = HTMLPage.getPageTokens(htmlAsStr, false);

        HiLiteHTML hl = new Config().generateHiLiter();

        final String css = FileRW.loadFileToString
            ("Torello/HTML/Tools/SyntaxHiLite/data-files/html-default.css");

        String hiLitedHTML = 
            "<HTML>\n<HEAD>\n" +
            "<META HTTP-EQUIV=Cache-Control CONTENT='no-cache, no-store, must-revalidate'>\n" +
            "<META HTTP-EQUIV=Pragma CONTENT=no-cache>\n" +
            "<META HTTP-EQUIV=Expires CONTENT=0>\n" +
            "<STYLE TYPE='text/css'>\n" +
            css + '\n' +
            "</STYLE>\n" +
            "</HEAD>\n" +
            "<BODY>\n" +
            "<PRE CLASS=HL>\n" +
            Util.pageToString(hl.hiLite(htmlAsVec)) + '\n' +
            "</PRE>\n" +
            "</BODY>\n"  +
            "</HTML>\n";

        System.out.println("Writing File: " + BYELLOW + "OUT/out.html" + RESET);
        FileRW.writeFile(hiLitedHTML, "OUT/out.html");

        System.out.println(hl.toString());
    }
}