package Torello.JavaDoc;

import static Torello.Java.C.*;

import Torello.HTML.*;
import Torello.HTML.NodeSearch.*;

import Torello.Java.FileRW;
import Torello.Java.StringParse;
import Torello.Java.StrCSV;
import Torello.Java.StrIndexOf;

import Torello.Java.Additional.Ret2;
import Torello.Java.Additional.Ret3;

import Torello.JavaDoc.Messager.Messager;
import Torello.JDUInternal.Miscellaneous.Where.JDUUserAPI;
import Torello.JavaDoc.Messager.Where_Am_I;

import java.io.File;
import java.io.IOException;
import java.io.Serializable;

import Torello.Java.ReadOnly.ReadOnlyVector;
import Torello.Java.ReadOnly.ROTreeSetBuilder;
import Torello.Java.ReadOnly.ReadOnlyTreeSet;

import java.util.*;

import java.util.function.Consumer;

/**
 * A class that parses and encapsulates the contents of a <B>{@code 'package-summary.html'}</B>
 * File.
 */
public class PackageSummaryHTML implements Serializable
{
    // When the Messager Reports its errors, this class passes this reference to the Messager
    // to facilitate the printing of that information (What class encountered an error or warning
    // that needs to be printed by the Messager).

    private static final Where_Am_I WHERE_AM_I = JDUUserAPI.PackageSummaryHTML;


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


    public PackageSummaryHTML(
            final String        packageName,
            final SubSection    head,
            final SubSection    topNavBar,
            final SubSection    bottomNavBar,
            final SubSection    description
        )
    {
        this.packageName    = packageName;
        this.head           = head;
        this.topNavBar      = topNavBar;
        this.bottomNavBar   = bottomNavBar;
        this.description    = description;
    }


    // ********************************************************************************************
    // ********************************************************************************************
    // Static-Final Constant Fields
    // ********************************************************************************************
    // ********************************************************************************************


    /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
    protected static final long serialVersionUID = 1;

    /** Deprecated, but useful API Error-Message */
    public static final String JD_FRAMES_WARNING_MESSAGE =
        "javadoc: warning - You have specified to generate frames, by using the --frames " +
            "option.\n" +
        "The default is currently to not generate frames and the support for \n" +
        "frames will be removed in a future release.\n" +
        "To suppress this warning, remove the --frames option and avoid the use of frames.\n";


    // ********************************************************************************************
    // ********************************************************************************************
    // final Class-Data Fields
    // ********************************************************************************************
    // ********************************************************************************************


    /** The name of the Java Package represented by this instance. */
    public final String packageName;


    // Contains the top Navigation Bar's HTML 
    // This, and all SubSection instances, must be private, because they are mutable

    private final SubSection head;

    // Contains the top Navigation Bar's HTML 
    private final SubSection topNavBar;

    // Contains the bottom Navigation Bar's HTML
    private final SubSection bottomNavBar;

    // THe Top-Description HTML/Text
    private final SubSection description;


    // ********************************************************************************************
    // ********************************************************************************************
    // Simple Accessor Methods
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * Allows a User to both retrieve and to modify the contents of the
     * {@code 'package-summary.html'} {@code <HEAD>}-Section.
     * 
     * @return Vectorized-HTML of this Web-Page's {@code <HEAD>...</HEAD>} Section.
     */
    public Vector<HTMLNode> head() { return this.head.html; }

    /**
     * Allows a User to both retrieve and to modify the contents of the
     * {@code 'package-summary.html'} Nav-Bar.
     * 
     * @return Vectorized-HTML of this Web-Page's Upper Navigation Menu-Bar.
     */
    public Vector<HTMLNode> topNavBar()
    { return (this.topNavBar == null) ? null : this.topNavBar.html; }

    /**
     * Allows a User to both retrieve and to modify the contents of the
     * {@code 'package-summary.html'} Nav-Bar.
     * 
     * @return Vectorized-HTML of this Web-Page's Lower Navigation Menu-Bar.
     */
    public Vector<HTMLNode> bottomNavBar()
    { return (this.bottomNavBar == null) ? null : this.bottomNavBar.html; }

    /**
     * Allows a User to both retrieve and to modify the contents of the
     * {@code 'package-summary.html'} Description Text-Area.
     * 
     * @return Vectorized-HTML of this Web-Page's Main Description Box.
     */
    public Vector<HTMLNode> description() { return this.description.html; }


    // ********************************************************************************************
    // ********************************************************************************************
    // Default Package-Summary Cleaner
    // ********************************************************************************************
    // ********************************************************************************************


    private static final String[] searches = { ".", "<br/>", "\n" };

    public static final void defaultCleaner(Vector<HTMLNode> cietSummary)
    {
        // boolean VERBOSE = MsgVerbose.isVerbose();

        // System.out.println("INSIDE MY LAMBDA:\n" + Util.pageToString(cietSummary));

        int i=0, nodePos=-1;

        /*
        if (VERBOSE) MsgVerbose.println
            ("cietSummary: " + BGREEN + Util.pageToString(cietSummary) + RESET);
        */

        while ((nodePos == -1) && (i < searches.length))
            nodePos = TextNodeFind.first(cietSummary, TextComparitor.CN_CI, searches[i++]);

        if (nodePos == -1)
        {
            // if (VERBOSE) MsgVerbose.println("No String Markers Found!  Exiting...");
            return;
        }

        String  s   = cietSummary.elementAt(nodePos).str;
        int     pos = StrIndexOf.first_CI(s, searches[--i]);

        /*
        if (VERBOSE) MsgVerbose.println("s: " + s);
        */

        s = s.substring(0, pos);

        /*
        if (VERBOSE) MsgVerbose.println("s.substring: " + s);
        */

        if (s.length() != 0)
            cietSummary.setElementAt(new TextNode(s), nodePos++);

        if (nodePos < cietSummary.size())
            Util.Remove.range(cietSummary, nodePos, cietSummary.size());


        // Util.removeAllTagNodes(cietSummary);
        // CHANGED March 2nd 2022

        TagNodeRemove.allExcept(cietSummary, TC.Both, "a", "b", "i", "code", "span");

        /*
        if (VERBOSE) MsgVerbose.println(
            BCYAN + Util.pageToString(cietSummary) + RESET +
            "\n************************************************************\n"
        );
        */
    }

}