package Torello.Browser.BrowserAPI;

// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***
// Java-HTML Imports
// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***

import Torello.Browser.*;
import Torello.Browser.helper.*;
import Torello.Browser.JavaScriptAPI.*;
import Torello.JSON.*;

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

import Torello.JavaDoc.Annotations.StaticFunctional;
import Torello.JavaDoc.Annotations.JDHeaderBackgroundImg;

import Torello.Browser.BrowserAPI.NestedHelpers.Commands.DOMDebugger$$Commands;


// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***
// JDK Imports
// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***

import javax.json.JsonObject;
import javax.json.JsonValue;

/**
 * <SPAN CLASS=COPIEDJDK><B>DOM debugging allows setting breakpoints on particular DOM operations and events. JavaScript
 * execution will stop on these operations as if there was a regular breakpoint set.</B></SPAN>
 * <EMBED CLASS='external-html' DATA-FILE-ID=CDP.CODE_GEN_NOTE>
 */
@StaticFunctional@JDHeaderBackgroundImg(EmbedTagFileID="CDP.WOOD_PLANK_NOTE")
public class DOMDebugger
{
    // No Pubic Constructors
    private DOMDebugger() { }


    // ********************************************************************************************
    // ********************************************************************************************
    // Enumerated String Constants Lists
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * CSP Violation type.
     * 
     * <BR /><B CLASS=Exp-Top>EXPERIMENTAL</B>
     * <BR /><BR /><B CLASS=StrEnumType>String-Enumeration Type</B>
     */
    public static final ReadOnlyList<String> CSPViolationType = new ReadOnlyArrayList<>
        (String.class, "trustedtype-policy-violation", "trustedtype-sink-violation");

    /**
     * DOM breakpoint type.
     * <BR /><BR /><B CLASS=StrEnumType>String-Enumeration Type</B>
     */
    public static final ReadOnlyList<String> DOMBreakpointType = new ReadOnlyArrayList<>
        (String.class, "attribute-modified", "node-removed", "subtree-modified");



    // ********************************************************************************************
    // ********************************************************************************************
    // Basic Types
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * Object event listener.
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=DOMDebugger DATA-API=BrowserAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_TYPE_JDHBI")
    public static class EventListener
        extends BaseType<EventListener>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

        private static final NestedHelper<DOMDebugger.EventListener> singleton =
            Torello.Browser.BrowserAPI.NestedHelpers.Types.
                DOMDebugger$$EventListener$$.singleton;

        /** <CODE>EventListener</CODE>'s type. */
        public final String type;

        /** <CODE>EventListener</CODE>'s useCapture. */
        public final boolean useCapture;

        /** <CODE>EventListener</CODE>'s passive flag. */
        public final boolean passive;

        /** <CODE>EventListener</CODE>'s once flag. */
        public final boolean once;

        /** Script id of the handler code. */
        public final String scriptId;

        /** Line number in the script (0-based). */
        public final int lineNumber;

        /** Column number in the script (0-based). */
        public final int columnNumber;

        /**
         * Event handler function value.
         * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
         */
        public final RunTime.RemoteObject handler;

        /**
         * Event original handler function value.
         * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
         */
        public final RunTime.RemoteObject originalHandler;

        /**
         * Node the listener is added to (if any).
         * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
         */
        public final Integer backendNodeId;

        /** Constructor.  Please review this class' fields for documentation. */
        public EventListener(
                ReadOnlyList<Boolean> isPresent, String type, boolean useCapture, boolean passive,
                boolean once, String scriptId, int lineNumber, int columnNumber,
                RunTime.RemoteObject handler, RunTime.RemoteObject originalHandler,
                Integer backendNodeId
            )
        {
            super(singleton, Domains.DOMDebugger, "EventListener", 10);

            this.type               = type;
            this.useCapture         = useCapture;
            this.passive            = passive;
            this.once               = once;
            this.scriptId           = scriptId;
            this.lineNumber         = lineNumber;
            this.columnNumber       = columnNumber;
            this.handler            = handler;
            this.originalHandler    = originalHandler;
            this.backendNodeId      = backendNodeId;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 10, "DOMDebugger.EventListener");
        }

        /** Creates an instance of this class from a {@link JsonObject}.*/
        public static EventListener fromJSON(JsonObject jo)
        { return singleton.fromJSON(jo); }

        /** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
        public static NestedDescriptor<EventListener> descriptor()
        { return singleton.descriptor(); }
    }




    // ********************************************************************************************
    // ********************************************************************************************
    // Commands
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * Returns event listeners of the given object.
     * 
     * @param objectId Identifier of the object to return listeners for.
     * 
     * @param depth 
     * The maximum depth at which Node children should be retrieved, defaults to 1. Use -1 for the
     * entire subtree or provide an integer larger than 0.
     * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
     * 
     * @param pierce 
     * Whether or not iframes and shadow roots should be traversed when returning the subtree
     * (default is false). Reports listeners for all contexts if pierce is enabled.
     * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
     * 
     * @return An instance of <CODE>{@link Script}&lt;{@link DOMDebugger.EventListener}[]&gt;</CODE>
     * 
     * <BR /><BR />This <B>script</B> may be <B STYLE='color: red'>executed</B>, using
     * {@link Script#exec(WebSocketSender) Script.exec}, and afterwards, a {@link Promise}
     * <CODE>&lt;{@link DOMDebugger.EventListener}[]&gt;</CODE> will be returned
     *
     * <BR /><BR />Finally, the <B>{@code Promise}</B> may be <B STYLE='color: red'>awaited</B>,
     * using {@link Promise#await()}, <I>and the returned result of this Browser Function may
     * be retrieved.</I>
     *
     * <BR /><BR /><DIV CLASS=JDHint>
     * This Browser Function's {@code Promise} returns:
     * <CODE>{@link DOMDebugger.EventListener}[] (<B>listeners</B>)</CODE>
     * <BR />
     * Array of relevant listeners.
     * </DIV>
     */
    public static Script<DOMDebugger.EventListener[]> getEventListeners
        (String objectId, Integer depth, Boolean pierce)
    {
        // Convert all Method Parameters into a JSON Request-Object (as a String)
        final String requestJSON = WriteJSON.get(
            DOMDebugger$$Commands.getEventListeners$$, "DOMDebugger.getEventListeners",
            objectId, depth, pierce
        );

        return new Script<>(
            Domains.DOMDebugger, "getEventListeners", requestJSON,
            DOMDebugger$$Commands::getEventListeners,
            DOMDebugger.EventListener[].class
        );
    }

    /**
     * Removes DOM breakpoint that was set using <CODE>setDOMBreakpoint</CODE>.
     * 
     * @param nodeId Identifier of the node to remove breakpoint from.
     * 
     * @param type Type of the breakpoint to remove.
     * 
     * @return An instance of <CODE>{@link Script}&lt;Void&gt;</CODE>
     *
     * <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
     * browser receives the invocation-request.
     *
     * <BR /><BR /><DIV CLASS=JDHint>
     * This Browser-Function <I>does not have</I> a return-value.  You may choose to
     * <B STYLE='color: red'>await</B> the {@link Promise}{@code <Void>} to ensure that
     * the Browser Function has run to completion.
     * </DIV>
     */
    public static Script<Void> removeDOMBreakpoint(int nodeId, String type)
    {
        // Convert all Method Parameters into a JSON Request-Object (as a String)
        final String requestJSON = WriteJSON.get(
            DOMDebugger$$Commands.removeDOMBreakpoint$$, "DOMDebugger.removeDOMBreakpoint",
            nodeId, type
        );

        return Script.NO_RET(Domains.DOMDebugger, "removeDOMBreakpoint", requestJSON);
    }

    /**
     * Removes breakpoint on particular DOM event.
     * 
     * @param eventName Event name.
     * 
     * @param targetName EventTarget interface name.
     * <BR /><B CLASS=Opt-Top>OPTIONAL</B><B CLASS=Exp-Top>EXPERIMENTAL</B>
     * 
     * @return An instance of <CODE>{@link Script}&lt;Void&gt;</CODE>
     *
     * <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
     * browser receives the invocation-request.
     *
     * <BR /><BR /><DIV CLASS=JDHint>
     * This Browser-Function <I>does not have</I> a return-value.  You may choose to
     * <B STYLE='color: red'>await</B> the {@link Promise}{@code <Void>} to ensure that
     * the Browser Function has run to completion.
     * </DIV>
     */
    public static Script<Void> removeEventListenerBreakpoint(String eventName, String targetName)
    {
        // Convert all Method Parameters into a JSON Request-Object (as a String)
        final String requestJSON = WriteJSON.get(
            DOMDebugger$$Commands.removeEventListenerBreakpoint$$,
            "DOMDebugger.removeEventListenerBreakpoint",
            eventName, targetName
        );

        return Script.NO_RET(Domains.DOMDebugger, "removeEventListenerBreakpoint", requestJSON);
    }

    /**
     * Removes breakpoint on particular native event.
     * 
     * <BR /><B CLASS=Exp-Top>EXPERIMENTAL</B><B CLASS=Dep-Top>DEPRECATED</B>
     * 
     * @param eventName Instrumentation name to stop on.
     * 
     * @return An instance of <CODE>{@link Script}&lt;Void&gt;</CODE>
     *
     * <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
     * browser receives the invocation-request.
     *
     * <BR /><BR /><DIV CLASS=JDHint>
     * This Browser-Function <I>does not have</I> a return-value.  You may choose to
     * <B STYLE='color: red'>await</B> the {@link Promise}{@code <Void>} to ensure that
     * the Browser Function has run to completion.
     * </DIV>
     */
    public static Script<Void> removeInstrumentationBreakpoint(String eventName)
    {
        // Build the JSON Request-Object (as a String); only 1 Parameter is passed
        final String requestJSON = WriteJSON.get(
            CDPTypes.STRING, "eventName", false, "DOMDebugger.removeInstrumentationBreakpoint",
            eventName
        );

        return Script.NO_RET(Domains.DOMDebugger, "removeInstrumentationBreakpoint", requestJSON);
    }

    /**
     * Removes breakpoint from XMLHttpRequest.
     * 
     * @param url Resource URL substring.
     * 
     * @return An instance of <CODE>{@link Script}&lt;Void&gt;</CODE>
     *
     * <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
     * browser receives the invocation-request.
     *
     * <BR /><BR /><DIV CLASS=JDHint>
     * This Browser-Function <I>does not have</I> a return-value.  You may choose to
     * <B STYLE='color: red'>await</B> the {@link Promise}{@code <Void>} to ensure that
     * the Browser Function has run to completion.
     * </DIV>
     */
    public static Script<Void> removeXHRBreakpoint(String url)
    {
        // Build the JSON Request-Object (as a String); only 1 Parameter is passed
        final String requestJSON = WriteJSON.get
            (CDPTypes.STRING, "url", false, "DOMDebugger.removeXHRBreakpoint", url);

        return Script.NO_RET(Domains.DOMDebugger, "removeXHRBreakpoint", requestJSON);
    }

    /**
     * Sets breakpoint on particular CSP violations.
     * 
     * <BR /><B CLASS=Exp-Top>EXPERIMENTAL</B>
     * 
     * @param violationTypes CSP Violations to stop upon.
     * 
     * @return An instance of <CODE>{@link Script}&lt;Void&gt;</CODE>
     *
     * <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
     * browser receives the invocation-request.
     *
     * <BR /><BR /><DIV CLASS=JDHint>
     * This Browser-Function <I>does not have</I> a return-value.  You may choose to
     * <B STYLE='color: red'>await</B> the {@link Promise}{@code <Void>} to ensure that
     * the Browser Function has run to completion.
     * </DIV>
     */
    public static Script<Void> setBreakOnCSPViolation(String[] violationTypes)
    {
        // Build the JSON Request-Object (as a String); only 1 Parameter is passed
        final String requestJSON = WriteJSON.get(
            CDPTypes.STRING_ARRAY_1D, "violationTypes", false,
            "DOMDebugger.setBreakOnCSPViolation", (Object) violationTypes
        );

        return Script.NO_RET(Domains.DOMDebugger, "setBreakOnCSPViolation", requestJSON);
    }

    /**
     * Sets breakpoint on particular operation with DOM.
     * 
     * @param nodeId Identifier of the node to set breakpoint on.
     * 
     * @param type Type of the operation to stop upon.
     * 
     * @return An instance of <CODE>{@link Script}&lt;Void&gt;</CODE>
     *
     * <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
     * browser receives the invocation-request.
     *
     * <BR /><BR /><DIV CLASS=JDHint>
     * This Browser-Function <I>does not have</I> a return-value.  You may choose to
     * <B STYLE='color: red'>await</B> the {@link Promise}{@code <Void>} to ensure that
     * the Browser Function has run to completion.
     * </DIV>
     */
    public static Script<Void> setDOMBreakpoint(int nodeId, String type)
    {
        // Convert all Method Parameters into a JSON Request-Object (as a String)
        final String requestJSON = WriteJSON.get(
            DOMDebugger$$Commands.setDOMBreakpoint$$, "DOMDebugger.setDOMBreakpoint",
            nodeId, type
        );

        return Script.NO_RET(Domains.DOMDebugger, "setDOMBreakpoint", requestJSON);
    }

    /**
     * Sets breakpoint on particular DOM event.
     * 
     * @param eventName DOM Event name to stop on (any DOM event will do).
     * 
     * @param targetName 
     * EventTarget interface name to stop on. If equal to <CODE>"*"</CODE> or not provided, will stop on any
     * EventTarget.
     * <BR /><B CLASS=Opt-Top>OPTIONAL</B><B CLASS=Exp-Top>EXPERIMENTAL</B>
     * 
     * @return An instance of <CODE>{@link Script}&lt;Void&gt;</CODE>
     *
     * <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
     * browser receives the invocation-request.
     *
     * <BR /><BR /><DIV CLASS=JDHint>
     * This Browser-Function <I>does not have</I> a return-value.  You may choose to
     * <B STYLE='color: red'>await</B> the {@link Promise}{@code <Void>} to ensure that
     * the Browser Function has run to completion.
     * </DIV>
     */
    public static Script<Void> setEventListenerBreakpoint(String eventName, String targetName)
    {
        // Convert all Method Parameters into a JSON Request-Object (as a String)
        final String requestJSON = WriteJSON.get(
            DOMDebugger$$Commands.setEventListenerBreakpoint$$,
            "DOMDebugger.setEventListenerBreakpoint",
            eventName, targetName
        );

        return Script.NO_RET(Domains.DOMDebugger, "setEventListenerBreakpoint", requestJSON);
    }

    /**
     * Sets breakpoint on particular native event.
     * 
     * <BR /><B CLASS=Exp-Top>EXPERIMENTAL</B><B CLASS=Dep-Top>DEPRECATED</B>
     * 
     * @param eventName Instrumentation name to stop on.
     * 
     * @return An instance of <CODE>{@link Script}&lt;Void&gt;</CODE>
     *
     * <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
     * browser receives the invocation-request.
     *
     * <BR /><BR /><DIV CLASS=JDHint>
     * This Browser-Function <I>does not have</I> a return-value.  You may choose to
     * <B STYLE='color: red'>await</B> the {@link Promise}{@code <Void>} to ensure that
     * the Browser Function has run to completion.
     * </DIV>
     */
    public static Script<Void> setInstrumentationBreakpoint(String eventName)
    {
        // Build the JSON Request-Object (as a String); only 1 Parameter is passed
        final String requestJSON = WriteJSON.get(
            CDPTypes.STRING, "eventName", false, "DOMDebugger.setInstrumentationBreakpoint",
            eventName
        );

        return Script.NO_RET(Domains.DOMDebugger, "setInstrumentationBreakpoint", requestJSON);
    }

    /**
     * Sets breakpoint on XMLHttpRequest.
     * 
     * @param url Resource URL substring. All XHRs having this substring in the URL will get stopped upon.
     * 
     * @return An instance of <CODE>{@link Script}&lt;Void&gt;</CODE>
     *
     * <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
     * browser receives the invocation-request.
     *
     * <BR /><BR /><DIV CLASS=JDHint>
     * This Browser-Function <I>does not have</I> a return-value.  You may choose to
     * <B STYLE='color: red'>await</B> the {@link Promise}{@code <Void>} to ensure that
     * the Browser Function has run to completion.
     * </DIV>
     */
    public static Script<Void> setXHRBreakpoint(String url)
    {
        // Build the JSON Request-Object (as a String); only 1 Parameter is passed
        final String requestJSON = WriteJSON.get
            (CDPTypes.STRING, "url", false, "DOMDebugger.setXHRBreakpoint", url);

        return Script.NO_RET(Domains.DOMDebugger, "setXHRBreakpoint", requestJSON);
    }


}