package Torello.JavaDoc;

import java.util.*;
import java.util.function.*;

import Torello.Java.ReadOnly.ReadOnlyMap;
import Torello.Java.ReadOnly.ReadOnlyList;

import Torello.HTML.HTMLNode;
import Torello.HTML.TagNodeIndex;

import Torello.Java.Additional.Ret6;

import Torello.Java.Build.BuildPackage;

import Torello.JDUInternal.FEATURES_SIMPLE.LinksChecker;

import Torello.JDUInternal.DATA_RECORDS.MainLoopData.AnnotationsMirror;
import Torello.JDUInternal.DATA_RECORDS.MainLoopData.JDHFHeaderFacts;

import Torello.JDUInternal.OTHER.ParseJavaSource.JavaSourceCodeFile;

import com.sun.source.tree.MethodTree;
import com.sun.source.tree.VariableTree;
import com.sun.source.tree.ClassTree;

/**
 * IMPORTANT NOTE: Have a "rocket science" moment, and accept that all this is doing is
 * facilitating the "preservation" of the PACKAGE-PRIVATE levels of privacy on these methods,
 * fields and constructors after "The Big Move"
 * 
 * <BR /><BR />
 * Note that "The Big Move" was putting all of the classes that were deemed "HTML Processors" to
 * sub-directories &amp; sub-packages.  Primary User-API classes (such as "JavaDocHTMLFile" and
 * others like "ReflHTML") are still in the main-directory / main-package.
 * 
 * <BR /><BR />
 * The only two options were to make all of these methods, fields and constructors public or to
 * create this portal class!!
 * 
 * <BR /><BR />
 * The reason keeping these methods, fields &amp; constructors package-private is that once this
 * the Upgrader is truly finished, "The API" that users see should make sense, and they shouldn't
 * be bothered with internal coding/logic decisions that they aren't supposed to use. 
 * 
 * <BR /><BR />
 * The stuff "exported" below are used by the sub-packages, which are not exported to the API at
 * all.  The end user doesn't need to know a thing about any of these.  <B>YES</B> it would be easy
 * to cheat using these, but there is no point.  The "readability" of the classes that are listed
 * above is still preserved.  Knock yourself out, there would be no point...
 * 
 * <BR /><BR />
 * All "Details Sections" in this class have been removed.
 */
@StaticFunctional
public class EXPORT_PORTAL
{
    private EXPORT_PORTAL() { }


    // ********************************************************************************************
    // ********************************************************************************************
    // Stats
    // ********************************************************************************************
    // ********************************************************************************************


    // INVOKED: RetrieveEmbedTagMapPropFiles.getPackageLocalEmbedTagMapPropFile
    public static void Stats$registerPackage(
        Stats stats, String packageName, ReadOnlyMap<String, String> packageTagsMap,
        Stats topLevelStatsInstance
    )
    { stats.registerPackage(packageName, packageTagsMap, topLevelStatsInstance); }

    // INVOKED: EmbedTag.replaceEmbedTags
    public static void Stats$incrementTag
        (Stats stats, String packageName, String embedTag, boolean globalTagOrPackageTag)
    { stats.incrementTag(packageName, embedTag, globalTagOrPackageTag); }

    // INVOKED: DetailsFilesProcessor.run - NOTE: Stats.run is NOT STATIC
    public static void Stats$run(
        Stats stats, JavaSourceCodeFile jscf, JavaDocHTMLFile jdhf,
        int numHLM, int numHLC, int numHLF, int numHLAE, int numHLEC, int numHLD
    )
    { stats.run(jscf, jdhf, numHLM, numHLC, numHLF, numHLAE, numHLEC, numHLD); }

    // INVOKED: MainFilesProcessor.PART_TWO_Do_The_Rest
    public static boolean Stats$addStatsButton(
        Vector<HTMLNode> navBarTop, Vector<HTMLNode> navBarBottom,
        String dotDots, String packageName
    )
    { return Stats.addStatsButton(navBarTop, navBarBottom, dotDots, packageName); }

    // INVOKED: ExtraFilesProcessor.add
    public static void Stats$addStatsButton
        (Vector<HTMLNode> page, String dotDots, String packageName)
    { Stats.addStatsButton(page, dotDots, packageName); }


    // ********************************************************************************************
    // ********************************************************************************************
    // Declaration
    // ********************************************************************************************
    // ********************************************************************************************


    // INVOKED:  HiLiteDetails
    public static String Declaration$codeHiLiteString(Declaration d)
    { return d.codeHiLiteString(); }


    // ********************************************************************************************
    // ********************************************************************************************
    // JavaDocHTMLFile
    // ********************************************************************************************
    // ********************************************************************************************


    // INVOKED:  MainFilesProcessor.PART_TWO_Do_The_Rest
    public static void JavaDocHTMLFile$commitChanges(JavaDocHTMLFile jdhf)
    { jdhf.commitChanges(); }

    // INVOKED: MainFilesProcessor.PART_TWO_Do_The_Rest
    public static Hashtable<String, Integer> JavaDocHTMLFile$checkValidity(JavaDocHTMLFile jdhf)
    { return jdhf.checkValidity(); }

    // INVOKED: MainFilesProcessor.PART_TWO_Do_The_Rest
    public static void JavaDocHTMLFile$commitFileToDisk(JavaDocHTMLFile jdhf)
        throws java.io.IOException
    { jdhf.commitFileToDisk();  }


    // ********************************************************************************************
    // ********************************************************************************************
    // SummaryTableHTML
    // ********************************************************************************************
    // ********************************************************************************************


    // INVOKED: RearrangeEntitySummaries
    public static <ENTITY extends Declaration> void SummaryTableHTML$setTableRows(
            SummaryTableHTML<ENTITY> stHTML, Vector<Vector<HTMLNode>> tableRows,
            Vector<ENTITY> rowEntities
        )
    { stHTML.setTableRows(tableRows, rowEntities); }

    // INVOKED: CleanSummaries, RearrangeEntitySummaries
    public static Vector<HTMLNode> SummaryTableHTML$headerRow(SummaryTableHTML<?> stHTML)
    { return stHTML.headerRow; }

    // INVOKED: CSSTagsTopAndSumm
    public static TagNodeIndex SummaryTableHTML$cinzelH3 (SummaryTableHTML<?> stHTML)
    { return stHTML.cinzelH3; }


    // ********************************************************************************************
    // ********************************************************************************************
    // PackageSummaryHTML
    // ********************************************************************************************
    // ********************************************************************************************


    // INVOKED: Uranus
    public static Torello.JDUInternal.FEATURES.SortTypes_FramesSummaries.PkgSort
        PackageSummaryHTML$sorter(PackageSummaryHTML psHTML)
    { return psHTML.sorter; }


    // ********************************************************************************************
    // ********************************************************************************************
    // Stats
    // ********************************************************************************************
    // ********************************************************************************************


    public static void Upgrade$registerEliminatedBuildPackages
        (Upgrade upgrade, ReadOnlyList<BuildPackage> eliminatedBuildPackages)
    { upgrade.registerEliminatedBuildPackages(eliminatedBuildPackages); }
}