package Torello.Browser.JsonAST;

import Torello.Browser.JsonAST.TypeNode;

import Torello.Java.ReadOnly.ReadOnlyList;
import Torello.Java.ReadOnly.ReadOnlySet;

import Torello.Java.ReadOnly.ROTreeSetBuilder;
import Torello.Java.ReadOnly.ROArrayListBuilder;

import Torello.Java.UnreachableError;
import Torello.Java.StrCSV;
import Torello.Java.StrPrint;

/**
 * <EMBED CLASS='external-html' DATA-FILE-ID=INFO_DATA>
 * @see ExtraData
 * @see SERIALIZED_AST#browserDat
 * @see SERIALIZED_AST#jsDat
 */
@Torello.JavaDoc.Annotations.JDHeaderBackgroundImg(EmbedTagFileID="SERIALIZER_JDHBI")
public class InfoData implements java.io.Serializable
{
    static InfoData.Builder builder() { return new InfoData.Builder(); }

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


    // *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***
    // Lists - The names of these lists *OUGHT TO* explain exatly what they are lists of ...
    // *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***

    /**
     * <EMBED CLASS='external-html' DATA-FILE-ID=ID_ELIM_TYPE_NODES>
     * @see #simpleTypeNodes
     * @see #enumValTypeNodes
     */
    public final ReadOnlyList<TypeNode> eliminatedTypeNodes;

    /** <EMBED CLASS='external-html' DATA-FILE-ID=ID_SIMPLE_TYPE_NODES> */
    public final ReadOnlyList<TypeNode> simpleTypeNodes;

    /** <EMBED CLASS='external-html' DATA-FILE-ID=ID_ENUM_VAL_TYPE_NODES> */
    public final ReadOnlyList<TypeNode> enumValTypeNodes;

    /** <EMBED CLASS='external-html' DATA-FILE-ID=ID_MARKER_EVENT_NODES> */
    public final ReadOnlyList<EventNode> markerEventNodes;


    // *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***
    // Sets - The names of these sets *OUGHT TO* explain exatly what they are lists of ...
    // *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***

    /**
     * <EMBED CLASS='external-html' DATA-FILE-ID=ID_HAS_ENUM_STR_LISTS>
     * @see Entity#ownerDomain
     * @see #enumValTypeNodes
     */
    public final ReadOnlySet<Domain> hasEnumStrLists;

    /**
     * The list of domains which have at least one zero-property type (and were eliminated during
     * the code generation step).
     */
    public final ReadOnlySet<Domain> hasSimpleTypes;

    /**
     * <EMBED CLASS='external-html' DATA-FILE-ID=ID_HAS_MARKER_EVENTS>
     * @see Entity#ownerDomain
     * @see #markerEventNodes
     */
    public final ReadOnlySet<Domain> hasMarkerEvents;

    /**
     * The set of all domains which have actual nested java inner classes defined within them.
     * There are relatively few domains in the CDP API that do not actually define any types, though
     * there are some.
     * 
     * <BR /><BR />
     * In the most recent parsing and generation of the "Browser API" from CDP, 41 out of the 47
     * Domains have actual, reified, events.  You may see the {@link #toString() toString Output}
     * for this class by clicking the link.
     */
    public final ReadOnlySet<Domain> hasReifiedTypes;

    /**
     * This should list all domains that have commands which return more than one value as a result
     * of their invocation.  Rather than return tuples of results, a dedicated nested-inner type is
     * created for any CDP command that needs to actually return more than one value.
     */
    public final ReadOnlySet<Domain> hasReifiedReturnTypes;

    /**
     * The set of all domains which have actual nested java inner classes defined within them.
     * Event inner classes are not actually defined in any way that is different from standard 
     * inner types.  Instead, they are just listed on their respective Java-Doc Pages as "Event 
     * Classes" which are only generated when the CDP API actually fires an event for them.
     * 
     * <BR /><BR />
     * In the most recent parsing and generation of the "Browser API" from CDP, 33 out of the 47
     * Domains have actual, reified, events.  You may see the {@link #toString() toString Output}
     * for this class by clicking the link.
     */
    public final ReadOnlySet<Domain> hasReifiedEvents;


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


    InfoData(
            final ReadOnlyList<TypeNode>    eliminatedTypeNodes,
            final ReadOnlyList<TypeNode>    simpleTypeNodes,
            final ReadOnlyList<TypeNode>    enumValTypeNodes,
            final ReadOnlyList<EventNode>   markerEventNodes,

            final ReadOnlySet<Domain>       hasEnumStrLists,
            final ReadOnlySet<Domain>       hasSimpleTypes,
            final ReadOnlySet<Domain>       hasMarkerEvents,

            final ReadOnlySet<Domain>       hasReifiedTypes,
            final ReadOnlySet<Domain>       hasReifiedReturnTypes,
            final ReadOnlySet<Domain>       hasReifiedEvents
        )
    {
        this.eliminatedTypeNodes    = eliminatedTypeNodes;
        this.simpleTypeNodes        = simpleTypeNodes;
        this.enumValTypeNodes       = enumValTypeNodes;
        this.markerEventNodes       = markerEventNodes;

        this.hasEnumStrLists    = hasEnumStrLists;
        this.hasSimpleTypes     = hasSimpleTypes;
        this.hasMarkerEvents    = hasMarkerEvents;

        this.hasReifiedTypes        = hasReifiedTypes;
        this.hasReifiedReturnTypes  = hasReifiedReturnTypes;
        this.hasReifiedEvents       = hasReifiedEvents;
    }


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


    /**
     * Generates a {@code String} representation of the contents of this {@code 'InfoData'} 
     * instance.  The only two instances of {@code 'InfoData'} which are generated are the one for
     * the "Browser API" along with the instance which represents Google's "JavaScript API"
     * 
     * <BR /><BR />
     * The "See Also" link below provides a direct link to the two fields within the class 
     * {@link SERIALIZED_AST} which contains a reference / pointer to an instance of this class.
     * 
     * @return A {@code String} representation / summary of one of the two API's.
     * 
     * @see SERIALIZED_AST#browserDat
     * @see SERIALIZED_AST#jsDat
     */
    public String toString()
    {
        return
            "{\n" +
            "    this.hasEnumStrLists:"     + list(this.hasEnumStrLists) +
            "    this.hasSimpleTypes:"      + list(this.hasSimpleTypes) +
            "    this.hasMarkerEvents:"     + list(this.hasMarkerEvents) +
            "    this.hasReifiedTypes:"     + list(this.hasReifiedTypes) +
            "    this.hasReifiedEvents:"    + list(this.hasReifiedEvents) +
            '\n' +
            "    this.eliminatedTypeNodes.size(): " + this.eliminatedTypeNodes.size()       + '\n' +
            "    this.simpleTypeNodes.size():     " + this.simpleTypeNodes.size()           + '\n' +
            "    this.enumValTypeNodes.size():    " + this.enumValTypeNodes.size()          + '\n' +
            "    this.markerEventNodes.size():    " + this.markerEventNodes.size()          + '\n' +
            '\n' +
            "    this.hasEnumStrLists.size():       " + this.hasEnumStrLists.size()         + '\n' +
            "    this.hasSimpleTypes.size():        " + this.hasSimpleTypes.size()          + '\n' +
            "    this.hasMarkerEvents.size():       " + this.hasMarkerEvents.size()         + '\n' +
            'n' +
            "    this.hasReifiedTypes.size():       " + this.hasReifiedTypes.size()         + '\n' +
            "    this.hasReifiedReturnTypes.size(): " + this.hasReifiedReturnTypes.size()   + '\n' +
            "    this.hasReifiedEvents.size():      " + this.hasReifiedEvents.size()        + '\n' +
            "}\n";
    }

    private static String list(final ReadOnlySet<Domain> domainList)
    {
        final String csv =
            '\n' +
            "        " +
            StrCSV.toCSV(domainList, (Domain d) -> d.name, true, null) +
            '\n' +
            '\n';

        return StrPrint.wrapToIndentation(csv, 100);
    }


    // ********************************************************************************************
    // ********************************************************************************************
    // Builder
    // ********************************************************************************************
    // ********************************************************************************************


    // When complicated data gets moving there is nothing more valuable than enuring that the code 
    // which is going to "use" your data (Here, AST data) - is final, immutable and read only.
    // 
    // Using this "Builder" design pattern means that the "InfoData" class that is saved to disk 
    // so that the Code Generator can later retrieve it - CONTAINS NOTHING BUT FINAL, IMMUTABLE AND
    // READ-ONLY DATA.  

    static class Builder
    {
        private Builder() { }


        // *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***
        // Lists ==> The exact same lists as above, but as "ReadOnlyList Builders" instead
        // *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***

        private final ROArrayListBuilder<TypeNode> eliminatedTypeNodesROALB =
            new ROArrayListBuilder<>();

        private final ROArrayListBuilder<TypeNode> simpleTypeNodesROALB =
            new ROArrayListBuilder<>();

        private final ROArrayListBuilder<TypeNode> enumValTypeNodesROALB =
            new ROArrayListBuilder<>();

        private final ROArrayListBuilder<EventNode> markerEventNodesROALB =
            new ROArrayListBuilder<>();


        // *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***
        // Sets ==> The exact same sets as above, but as "ReadOnlySet Builders" instead
        // *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***

        private final ROTreeSetBuilder<Domain> hasEnumStrListsROTSB =
            new ROTreeSetBuilder<>();

        private final ROTreeSetBuilder<Domain> hasSimpleTypesROTSB =
            new ROTreeSetBuilder<>();

        private final ROTreeSetBuilder<Domain> hasMarkerEventsROTSB =
            new ROTreeSetBuilder<>();


        // *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***
        // More Sets ==> Specifically for the "Reified Nested Types"
        // *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***

        private final ROTreeSetBuilder<Domain> hasReifiedTypesROTSB =
            new ROTreeSetBuilder<>();

        private final ROTreeSetBuilder<Domain> hasReifiedReturnTypesROTSB =
            new ROTreeSetBuilder<>();

        private final ROTreeSetBuilder<Domain> hasReifiedEventsROTSB =
            new ROTreeSetBuilder<>();
        

        // *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***
        // Builder Methods that "add stuff" into this builder!  (How the builder "builds")
        // *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***

        void enumValType(final TypeNode tn)
        {
            if (tn.enumVals == null)    throw new UnreachableError();
            if (tn.isReifiedInnerClass) throw new UnreachableError();

            enumValTypeNodesROALB.add(tn);
            eliminatedTypeNodesROALB.add(tn);
            hasEnumStrListsROTSB.add(tn.ownerDomain);
        }

        void simpleType(final TypeNode tn)
        {
            if (tn.isReifiedInnerClass) throw new UnreachableError();
            if (tn.properties != null)  throw new UnreachableError();

            simpleTypeNodesROALB.add(tn);
            eliminatedTypeNodesROALB.add(tn);
            hasSimpleTypesROTSB.add(tn.ownerDomain);
        }

        void markerEvent(final EventNode en)
        {
            if (en.parameters != null) throw new UnreachableError();
            markerEventNodesROALB.add(en);
            hasMarkerEventsROTSB.add(en.ownerDomain);
        }

        void reifiedInnerType(final TypeNode tn)
        {
            if (! tn.isReifiedInnerClass)   throw new UnreachableError();
            if (tn.properties == null)      throw new UnreachableError();
            if (tn.properties.size() == 0)  throw new UnreachableError();

            hasReifiedTypesROTSB.add(tn.ownerDomain);
        }

        void reifiedReturnType(final CommandNode cn)
        {
            if (! cn.hasReifiedRetInnerClass)   throw new UnreachableError();
            if (cn.returns == null)             throw new UnreachableError();
            if (cn.returns.size() <= 1)         throw new UnreachableError();

            hasReifiedReturnTypesROTSB.add(cn.ownerDomain);
        }

        void reifiedEvent(final EventNode en)
        {
            if (! en.isReifiedInnerClass)   throw new UnreachableError();
            if (en.parameters == null)      throw new UnreachableError();
            if (en.parameters.size() == 0)  throw new UnreachableError();

            hasReifiedEventsROTSB.add(en.ownerDomain);
        }

        InfoData build()
        {
            return new InfoData(
                eliminatedTypeNodesROALB.build(),
                simpleTypeNodesROALB.build(),
                enumValTypeNodesROALB.build(),
                markerEventNodesROALB.build(),

                hasEnumStrListsROTSB.build(),
                hasSimpleTypesROTSB.build(),
                hasMarkerEventsROTSB.build(),

                hasReifiedTypesROTSB.build(),
                hasReifiedReturnTypesROTSB.build(),
                hasReifiedEventsROTSB.build()
            );
        }
    }

}