package Torello.Browser;

import java.util.*;
import javax.json.*;
import javax.json.stream.*;
import java.io.*;

import java.lang.reflect.Method;
import java.lang.reflect.Parameter;
import java.util.function.Function;

import Torello.Java.Additional.*;

import static Torello.Java.Additional.JFlag.*;

import Torello.Java.StrCmpr;
import Torello.JavaDoc.StaticFunctional;
import Torello.JavaDoc.JDHeaderBackgroundImg;
import Torello.JavaDoc.Excuse;

/**
 * <SPAN CLASS=CopiedJDK><B><CODE>[No Description Provided by Google]</CODE></B></SPAN>
 * 
 * <EMBED CLASS='external-html' DATA-FILE-ID=CODE_GEN_NOTE>
 */
@StaticFunctional(Excused={"counter"}, Excuses={Excuse.CONFIGURATION})
@JDHeaderBackgroundImg(EmbedTagFileID="WOOD_PLANK_NOTE")
public class LayerTree
{
    // ********************************************************************************************
    // ********************************************************************************************
    // Class Header Stuff
    // ********************************************************************************************
    // ********************************************************************************************


    // No Pubic Constructors
    private LayerTree () { }

    // These two Vector's are used by all the "Methods" exported by this class.  java.lang.reflect
    // is used to generate the JSON String's.  It saves thousands of lines of Auto-Generated Code.
    private static final Map<String, Vector<String>>    parameterNames = new HashMap<>();
    private static final Map<String, Vector<Class<?>>>  parameterTypes = new HashMap<>();

    // Some Methods do not take any parameters - for instance all the "enable()" and "disable()"
    // I simply could not get ride of RAW-TYPES and UNCHECKED warnings... so there are now,
    // offically, two empty-vectors.  One for String's, and the other for Classes.

    private static final Vector<String>     EMPTY_VEC_STR = new Vector<>();
    private static final Vector<Class<?>>   EMPTY_VEC_CLASS = new Vector<>();

    static
    {
        for (Method m : LayerTree.class.getMethods())
        {
            // This doesn't work!  The parameter names are all "arg0" ... "argN"
            // It works for java.lang.reflect.Field, BUT NOT java.lang.reflect.Parameter!
            //
            // Vector<String> parameterNamesList = new Vector<>(); -- NOPE!

            Vector<Class<?>> parameterTypesList = new Vector<>();
        
            for (Parameter p : m.getParameters()) parameterTypesList.add(p.getType());

            parameterTypes.put(
                m.getName(),
                (parameterTypesList.size() > 0) ? parameterTypesList : EMPTY_VEC_CLASS
            );
        }
    }

    static
    {
        Vector<String> v = null;

        v = new Vector<String>(1);
        parameterNames.put("compositingReasons", v);
        Collections.addAll(v, new String[]
        { "layerId", });

        parameterNames.put("disable", EMPTY_VEC_STR);

        parameterNames.put("enable", EMPTY_VEC_STR);

        v = new Vector<String>(1);
        parameterNames.put("loadSnapshot", v);
        Collections.addAll(v, new String[]
        { "tiles", });

        v = new Vector<String>(1);
        parameterNames.put("makeSnapshot", v);
        Collections.addAll(v, new String[]
        { "layerId", });

        v = new Vector<String>(4);
        parameterNames.put("profileSnapshot", v);
        Collections.addAll(v, new String[]
        { "snapshotId", "minRepeatCount", "minDuration", "clipRect", });

        v = new Vector<String>(1);
        parameterNames.put("releaseSnapshot", v);
        Collections.addAll(v, new String[]
        { "snapshotId", });

        v = new Vector<String>(4);
        parameterNames.put("replaySnapshot", v);
        Collections.addAll(v, new String[]
        { "snapshotId", "fromStep", "toStep", "scale", });

        v = new Vector<String>(1);
        parameterNames.put("snapshotCommandLog", v);
        Collections.addAll(v, new String[]
        { "snapshotId", });
    }


    // ********************************************************************************************
    // ********************************************************************************************
    // Types - Static Inner Classes
    // ********************************************************************************************
    // ********************************************************************************************

    // public static class LayerId => String
    
    // public static class SnapshotId => String
    
    // public static class PaintProfile => Number[]
    
    /** Rectangle where scrolling happens on the main thread. */
    public static class ScrollRect extends BaseType
    {
        /** For Object Serialization.  java.io.Serializable */
        protected static final long serialVersionUID = 1;
        
        public boolean[] optionals()
        { return new boolean[] { false, false, }; }
        
        /** Rectangle itself. */
        public final DOM.Rect rect;
        
        /** Reason for rectangle to force scrolling on the main thread */
        public final String type;
        
        /**
         * Constructor
         *
         * @param rect Rectangle itself.
         * 
         * @param type Reason for rectangle to force scrolling on the main thread
         * <BR />Acceptable Values: ["RepaintsOnScroll", "TouchEventHandler", "WheelEventHandler"]
         */
        public ScrollRect(DOM.Rect rect, String type)
        {
            // Exception-Check(s) to ensure that if any parameters which are not declared as
            // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
            
            if (rect == null) BRDPC.throwNPE("rect");
            if (type == null) BRDPC.throwNPE("type");
            
            // Exception-Check(s) to ensure that if any parameters which must adhere to a
            // provided List of Enumerated Values, fails, then IllegalArgumentException shall throw.
            
            BRDPC.checkIAE(
                "type", type,
                "RepaintsOnScroll", "TouchEventHandler", "WheelEventHandler"
            );
            
            this.rect  = rect;
            this.type  = type;
        }
        
        /**
         * JSON Object Constructor
         * @param jo A Json-Object having data about an instance of {@code 'ScrollRect'}.
         */
        public ScrollRect (JsonObject jo)
        {
            this.rect  = ReadJSON.XL.getObject(jo, "rect", DOM.Rect.class, false, true);
            this.type  = ReadJSON.getString(jo, "type", false, true);
        }
        
    }
    
    /** Sticky position constraints. */
    public static class StickyPositionConstraint extends BaseType
    {
        /** For Object Serialization.  java.io.Serializable */
        protected static final long serialVersionUID = 1;
        
        public boolean[] optionals()
        { return new boolean[] { false, false, true, true, }; }
        
        /** Layout rectangle of the sticky element before being shifted */
        public final DOM.Rect stickyBoxRect;
        
        /** Layout rectangle of the containing block of the sticky element */
        public final DOM.Rect containingBlockRect;
        
        /**
         * The nearest sticky layer that shifts the sticky box
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final String nearestLayerShiftingStickyBox;
        
        /**
         * The nearest sticky layer that shifts the containing block
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final String nearestLayerShiftingContainingBlock;
        
        /**
         * Constructor
         *
         * @param stickyBoxRect Layout rectangle of the sticky element before being shifted
         * 
         * @param containingBlockRect Layout rectangle of the containing block of the sticky element
         * 
         * @param nearestLayerShiftingStickyBox The nearest sticky layer that shifts the sticky box
         * <BR /><B>OPTIONAL</B>
         * 
         * @param nearestLayerShiftingContainingBlock The nearest sticky layer that shifts the containing block
         * <BR /><B>OPTIONAL</B>
         */
        public StickyPositionConstraint(
                DOM.Rect stickyBoxRect, DOM.Rect containingBlockRect, 
                String nearestLayerShiftingStickyBox, String nearestLayerShiftingContainingBlock
            )
        {
            // Exception-Check(s) to ensure that if any parameters which are not declared as
            // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
            
            if (stickyBoxRect == null)       BRDPC.throwNPE("stickyBoxRect");
            if (containingBlockRect == null) BRDPC.throwNPE("containingBlockRect");
            
            this.stickyBoxRect                        = stickyBoxRect;
            this.containingBlockRect                  = containingBlockRect;
            this.nearestLayerShiftingStickyBox        = nearestLayerShiftingStickyBox;
            this.nearestLayerShiftingContainingBlock  = nearestLayerShiftingContainingBlock;
        }
        
        /**
         * JSON Object Constructor
         * @param jo A Json-Object having data about an instance of {@code 'StickyPositionConstraint'}.
         */
        public StickyPositionConstraint (JsonObject jo)
        {
            this.stickyBoxRect                        = ReadJSON.XL.getObject(jo, "stickyBoxRect", DOM.Rect.class, false, true);
            this.containingBlockRect                  = ReadJSON.XL.getObject(jo, "containingBlockRect", DOM.Rect.class, false, true);
            this.nearestLayerShiftingStickyBox        = ReadJSON.getString(jo, "nearestLayerShiftingStickyBox", true, false);
            this.nearestLayerShiftingContainingBlock  = ReadJSON.getString(jo, "nearestLayerShiftingContainingBlock", true, false);
        }
        
    }
    
    /** Serialized fragment of layer picture along with its offset within the layer. */
    public static class PictureTile extends BaseType
    {
        /** For Object Serialization.  java.io.Serializable */
        protected static final long serialVersionUID = 1;
        
        public boolean[] optionals()
        { return new boolean[] { false, false, false, }; }
        
        /** Offset from owning layer left boundary */
        public final Number x;
        
        /** Offset from owning layer top boundary */
        public final Number y;
        
        /** Base64-encoded snapshot data. (Encoded as a base64 string when passed over JSON) */
        public final String picture;
        
        /**
         * Constructor
         *
         * @param x Offset from owning layer left boundary
         * 
         * @param y Offset from owning layer top boundary
         * 
         * @param picture Base64-encoded snapshot data. (Encoded as a base64 string when passed over JSON)
         */
        public PictureTile(Number x, Number y, String picture)
        {
            // Exception-Check(s) to ensure that if any parameters which are not declared as
            // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
            
            if (x == null)       BRDPC.throwNPE("x");
            if (y == null)       BRDPC.throwNPE("y");
            if (picture == null) BRDPC.throwNPE("picture");
            
            this.x        = x;
            this.y        = y;
            this.picture  = picture;
        }
        
        /**
         * JSON Object Constructor
         * @param jo A Json-Object having data about an instance of {@code 'PictureTile'}.
         */
        public PictureTile (JsonObject jo)
        {
            this.x        = ReadJSON.getNUMBER(jo, "x", false, true);
            this.y        = ReadJSON.getNUMBER(jo, "y", false, true);
            this.picture  = ReadJSON.getString(jo, "picture", false, true);
        }
        
    }
    
    /** Information about a compositing layer. */
    public static class Layer extends BaseType
    {
        /** For Object Serialization.  java.io.Serializable */
        protected static final long serialVersionUID = 1;
        
        public boolean[] optionals()
        { return new boolean[] { false, true, true, false, false, false, false, true, true, true, true, false, false, true, true, true, }; }
        
        /** The unique id for this layer. */
        public final String layerId;
        
        /**
         * The id of parent (not present for root).
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final String parentLayerId;
        
        /**
         * The backend id for the node associated with this layer.
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final Integer backendNodeId;
        
        /** Offset from parent layer, X coordinate. */
        public final Number offsetX;
        
        /** Offset from parent layer, Y coordinate. */
        public final Number offsetY;
        
        /** Layer width. */
        public final Number width;
        
        /** Layer height. */
        public final Number height;
        
        /**
         * Transformation matrix for layer, default is identity matrix
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final Number[] transform;
        
        /**
         * Transform anchor point X, absent if no transform specified
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final Number anchorX;
        
        /**
         * Transform anchor point Y, absent if no transform specified
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final Number anchorY;
        
        /**
         * Transform anchor point Z, absent if no transform specified
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final Number anchorZ;
        
        /** Indicates how many time this layer has painted. */
        public final int paintCount;
        
        /**
         * Indicates whether this layer hosts any content, rather than being used for
         * transform/scrolling purposes only.
         */
        public final boolean drawsContent;
        
        /**
         * Set if layer is not visible.
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final Boolean invisible;
        
        /**
         * Rectangles scrolling on main thread only.
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final LayerTree.ScrollRect[] scrollRects;
        
        /**
         * Sticky position constraint information
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final LayerTree.StickyPositionConstraint stickyPositionConstraint;
        
        /**
         * Constructor
         *
         * @param layerId The unique id for this layer.
         * 
         * @param parentLayerId The id of parent (not present for root).
         * <BR /><B>OPTIONAL</B>
         * 
         * @param backendNodeId The backend id for the node associated with this layer.
         * <BR /><B>OPTIONAL</B>
         * 
         * @param offsetX Offset from parent layer, X coordinate.
         * 
         * @param offsetY Offset from parent layer, Y coordinate.
         * 
         * @param width Layer width.
         * 
         * @param height Layer height.
         * 
         * @param transform Transformation matrix for layer, default is identity matrix
         * <BR /><B>OPTIONAL</B>
         * 
         * @param anchorX Transform anchor point X, absent if no transform specified
         * <BR /><B>OPTIONAL</B>
         * 
         * @param anchorY Transform anchor point Y, absent if no transform specified
         * <BR /><B>OPTIONAL</B>
         * 
         * @param anchorZ Transform anchor point Z, absent if no transform specified
         * <BR /><B>OPTIONAL</B>
         * 
         * @param paintCount Indicates how many time this layer has painted.
         * 
         * @param drawsContent 
         * Indicates whether this layer hosts any content, rather than being used for
         * transform/scrolling purposes only.
         * 
         * @param invisible Set if layer is not visible.
         * <BR /><B>OPTIONAL</B>
         * 
         * @param scrollRects Rectangles scrolling on main thread only.
         * <BR /><B>OPTIONAL</B>
         * 
         * @param stickyPositionConstraint Sticky position constraint information
         * <BR /><B>OPTIONAL</B>
         */
        public Layer(
                String layerId, String parentLayerId, Integer backendNodeId, Number offsetX, 
                Number offsetY, Number width, Number height, Number[] transform, Number anchorX, 
                Number anchorY, Number anchorZ, int paintCount, boolean drawsContent, 
                Boolean invisible, LayerTree.ScrollRect[] scrollRects, 
                LayerTree.StickyPositionConstraint stickyPositionConstraint
            )
        {
            // Exception-Check(s) to ensure that if any parameters which are not declared as
            // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
            
            if (layerId == null) BRDPC.throwNPE("layerId");
            if (offsetX == null) BRDPC.throwNPE("offsetX");
            if (offsetY == null) BRDPC.throwNPE("offsetY");
            if (width == null)   BRDPC.throwNPE("width");
            if (height == null)  BRDPC.throwNPE("height");
            
            this.layerId                   = layerId;
            this.parentLayerId             = parentLayerId;
            this.backendNodeId             = backendNodeId;
            this.offsetX                   = offsetX;
            this.offsetY                   = offsetY;
            this.width                     = width;
            this.height                    = height;
            this.transform                 = transform;
            this.anchorX                   = anchorX;
            this.anchorY                   = anchorY;
            this.anchorZ                   = anchorZ;
            this.paintCount                = paintCount;
            this.drawsContent              = drawsContent;
            this.invisible                 = invisible;
            this.scrollRects               = scrollRects;
            this.stickyPositionConstraint  = stickyPositionConstraint;
        }
        
        /**
         * JSON Object Constructor
         * @param jo A Json-Object having data about an instance of {@code 'Layer'}.
         */
        public Layer (JsonObject jo)
        {
            this.layerId                   = ReadJSON.getString(jo, "layerId", false, true);
            this.parentLayerId             = ReadJSON.getString(jo, "parentLayerId", true, false);
            this.backendNodeId             = ReadJSON.getINTEGER(jo, "backendNodeId", true);
            this.offsetX                   = ReadJSON.getNUMBER(jo, "offsetX", false, true);
            this.offsetY                   = ReadJSON.getNUMBER(jo, "offsetY", false, true);
            this.width                     = ReadJSON.getNUMBER(jo, "width", false, true);
            this.height                    = ReadJSON.getNUMBER(jo, "height", false, true);
            this.transform                 = (jo.getJsonArray("transform") == null)
            ? null
            : ReadArrJSON.DimN.arrNumber(jo.getJsonArray("transform"), -1, 0, null, Number[].class);;
            this.anchorX                   = ReadJSON.getNUMBER(jo, "anchorX", true, false);
            this.anchorY                   = ReadJSON.getNUMBER(jo, "anchorY", true, false);
            this.anchorZ                   = ReadJSON.getNUMBER(jo, "anchorZ", true, false);
            this.paintCount                = ReadJSON.getInt(jo, "paintCount");
            this.drawsContent              = ReadJSON.getBoolean(jo, "drawsContent");
            this.invisible                 = ReadJSON.getBOOLEAN(jo, "invisible", true);
            this.scrollRects               = (jo.getJsonArray("scrollRects") == null)
            ? null
            : ReadArrJSON.DimN.objArr(jo.getJsonArray("scrollRects"), null, 0, LayerTree.ScrollRect[].class);
            this.stickyPositionConstraint  = ReadJSON.XL.getObject(jo, "stickyPositionConstraint", LayerTree.StickyPositionConstraint.class, true, false);
        }
        
    }
    
    /** <CODE>[No Description Provided by Google]</CODE> */
    public static class layerPainted extends BrowserEvent
    {
        /** For Object Serialization.  java.io.Serializable */
        protected static final long serialVersionUID = 1;
        
        public boolean[] optionals()
        { return new boolean[] { false, false, }; }
        
        /** The id of the painted layer. */
        public final String layerId;
        
        /** Clip rectangle. */
        public final DOM.Rect clip;
        
        /**
         * Constructor
         *
         * @param layerId The id of the painted layer.
         * 
         * @param clip Clip rectangle.
         */
        public layerPainted(String layerId, DOM.Rect clip)
        {
            super("LayerTree", "layerPainted", 2);
            
            // Exception-Check(s) to ensure that if any parameters which are not declared as
            // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
            
            if (layerId == null) BRDPC.throwNPE("layerId");
            if (clip == null)    BRDPC.throwNPE("clip");
            
            this.layerId  = layerId;
            this.clip     = clip;
        }
        
        /**
         * JSON Object Constructor
         * @param jo A Json-Object having data about an instance of {@code 'layerPainted'}.
         */
        public layerPainted (JsonObject jo)
        {
            super("LayerTree", "layerPainted", 2);
        
            this.layerId  = ReadJSON.getString(jo, "layerId", false, true);
            this.clip     = ReadJSON.XL.getObject(jo, "clip", DOM.Rect.class, false, true);
        }
        
    }
    
    /** <CODE>[No Description Provided by Google]</CODE> */
    public static class layerTreeDidChange extends BrowserEvent
    {
        /** For Object Serialization.  java.io.Serializable */
        protected static final long serialVersionUID = 1;
        
        public boolean[] optionals()
        { return new boolean[] { true, }; }
        
        /**
         * Layer tree, absent if not in the comspositing mode.
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final LayerTree.Layer[] layers;
        
        /**
         * Constructor
         *
         * @param layers Layer tree, absent if not in the comspositing mode.
         * <BR /><B>OPTIONAL</B>
         */
        public layerTreeDidChange(LayerTree.Layer[] layers)
        {
            super("LayerTree", "layerTreeDidChange", 1);
            
            this.layers  = layers;
        }
        
        /**
         * JSON Object Constructor
         * @param jo A Json-Object having data about an instance of {@code 'layerTreeDidChange'}.
         */
        public layerTreeDidChange (JsonObject jo)
        {
            super("LayerTree", "layerTreeDidChange", 1);
        
            this.layers  = (jo.getJsonArray("layers") == null)
            ? null
            : ReadArrJSON.DimN.objArr(jo.getJsonArray("layers"), null, 0, LayerTree.Layer[].class);
        }
        
    }
    
    
    // Counter for keeping the WebSocket Request ID's distinct.
    private static int counter = 1;
    
    /**
     * Provides the reasons why the given layer was composited.
     * 
     * @param layerId The id of the layer for which we want to get the reasons it was composited.
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * {@link Ret2}&gt;</CODE>
     *
     * <BR /><BR />This {@link Script} may be <B STYLE='color:red'>executed</B> (using 
     * {@link Script#exec()}), and a {@link Promise} returned.
     *
     * <BR /><BR />When the {@code Promise} is <B STYLE='color: red'>awaited</B>
     * (using {@link Promise#await()}), the {@code Ret2} will subsequently
     * be returned from that call.
     * 
     * <BR /><BR />The <B STYLE='color: red'>returned</B> values are encapsulated
     * in an instance of <B>{@link Ret2}</B>
     *
     * <BR /><BR /><UL CLASS=JDUL>
     * <LI><CODE><B>Ret2.a:</B> String[] (<B>compositingReasons</B>)</CODE>
     *     <BR />A list of strings specifying reasons for the given layer to become composited.
     *     <BR /><BR /></LI>
     * <LI><CODE><B>Ret2.b:</B> String[] (<B>compositingReasonIds</B>)</CODE>
     *     <BR />A list of strings specifying reason IDs for the given layer to become composited.
     *     </LI>
     * </UL>
     */
    public static Script<String, JsonObject, Ret2<String[], String[]>> compositingReasons
        (String layerId)
    {
        // Exception-Check(s) to ensure that if any parameters which are not declared as
        // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
        
        if (layerId == null) BRDPC.throwNPE("layerId");
        
        final int       webSocketID = 27000000 + counter++;
        final boolean[] optionals   = { false, };
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("compositingReasons"),
            parameterNames.get("compositingReasons"),
            optionals, webSocketID,
            "LayerTree.compositingReasons",
            layerId
        );
        
        // 'JSON Binding' ... Converts Browser Response-JSON into Java-Type 'Ret2'
        Function<JsonObject, Ret2<String[], String[]>> 
            responseProcessor = (JsonObject jo) -> new Ret2<>(
                (jo.getJsonArray("compositingReasons") == null)
                    ? null
                    : ReadArrJSON.DimN.strArr(jo.getJsonArray("compositingReasons"), null, 0, String[].class),
                (jo.getJsonArray("compositingReasonIds") == null)
                    ? null
                    : ReadArrJSON.DimN.strArr(jo.getJsonArray("compositingReasonIds"), null, 0, String[].class)
            );
        
        // Pass the 'defaultSender' to Script-Constructor
        // The sender that is used can be changed before executing script.
        return new Script<>(BRDPC.defaultSender, webSocketID, requestJSON, responseProcessor);
    }
    
    /**
     * Disables compositing tree inspection.
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * {@link Ret0}&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 />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 <JsonObject,} {@link Ret0}
     * {@code >} to ensure the Browser Function has run to completion.
     */
    public static Script<String, JsonObject, Ret0> disable()
    {
        final int          webSocketID = 27001000 + counter++;
        final boolean[]    optionals   = new boolean[0];
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("disable"),
            parameterNames.get("disable"),
            optionals, webSocketID,
            "LayerTree.disable"
        );
        
        // This Remote Command does not have a Return-Value.
        return new Script<>
            (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues);
    }
    
    /**
     * Enables compositing tree inspection.
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * {@link Ret0}&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 />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 <JsonObject,} {@link Ret0}
     * {@code >} to ensure the Browser Function has run to completion.
     */
    public static Script<String, JsonObject, Ret0> enable()
    {
        final int          webSocketID = 27002000 + counter++;
        final boolean[]    optionals   = new boolean[0];
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("enable"),
            parameterNames.get("enable"),
            optionals, webSocketID,
            "LayerTree.enable"
        );
        
        // This Remote Command does not have a Return-Value.
        return new Script<>
            (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues);
    }
    
    /**
     * Returns the snapshot identifier.
     * 
     * @param tiles An array of tiles composing the snapshot.
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * String&gt;</CODE>
     * 
     * <BR /><BR />This <B>script</B> may be <B STYLE='color: red'>executed</B>, using
     * {@link Script#exec()}, and afterwards, a {@link Promise}<CODE>&lt;JsonObject,
     * String&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
      * may be retrieved.</I>
     *
     * <BR /><BR />This Browser Function <B STYLE='color: red'>returns</B>
     * <BR /><BR /><UL CLASS=JDUL>
     * <LI><CODE>String (<B>snapshotId</B></CODE>)
     *     <BR />The id of the snapshot.
     * </LI>
     * </UL> */
    public static Script<String, JsonObject, String> loadSnapshot(LayerTree.PictureTile[] tiles)
    {
        // Exception-Check(s) to ensure that if any parameters which are not declared as
        // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
        
        if (tiles == null) BRDPC.throwNPE("tiles");
        
        final int       webSocketID = 27003000 + counter++;
        final boolean[] optionals   = { false, };
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("loadSnapshot"),
            parameterNames.get("loadSnapshot"),
            optionals, webSocketID,
            "LayerTree.loadSnapshot",
            (Object) tiles
        );
        
        // 'JSON Binding' ... Converts Browser Response-JSON to 'String'
        Function<JsonObject, String> responseProcessor = (JsonObject jo) ->
            ReadJSON.getString(jo, "snapshotId", false, true);
        
        // Pass the 'defaultSender' to Script-Constructor
        // The sender that is used can be changed before executing script.
        return new Script<>(BRDPC.defaultSender, webSocketID, requestJSON, responseProcessor);
    }
    
    /**
     * Returns the layer snapshot identifier.
     * 
     * @param layerId The id of the layer.
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * String&gt;</CODE>
     * 
     * <BR /><BR />This <B>script</B> may be <B STYLE='color: red'>executed</B>, using
     * {@link Script#exec()}, and afterwards, a {@link Promise}<CODE>&lt;JsonObject,
     * String&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
      * may be retrieved.</I>
     *
     * <BR /><BR />This Browser Function <B STYLE='color: red'>returns</B>
     * <BR /><BR /><UL CLASS=JDUL>
     * <LI><CODE>String (<B>snapshotId</B></CODE>)
     *     <BR />The id of the layer snapshot.
     * </LI>
     * </UL> */
    public static Script<String, JsonObject, String> makeSnapshot(String layerId)
    {
        // Exception-Check(s) to ensure that if any parameters which are not declared as
        // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
        
        if (layerId == null) BRDPC.throwNPE("layerId");
        
        final int       webSocketID = 27004000 + counter++;
        final boolean[] optionals   = { false, };
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("makeSnapshot"),
            parameterNames.get("makeSnapshot"),
            optionals, webSocketID,
            "LayerTree.makeSnapshot",
            layerId
        );
        
        // 'JSON Binding' ... Converts Browser Response-JSON to 'String'
        Function<JsonObject, String> responseProcessor = (JsonObject jo) ->
            ReadJSON.getString(jo, "snapshotId", false, true);
        
        // Pass the 'defaultSender' to Script-Constructor
        // The sender that is used can be changed before executing script.
        return new Script<>(BRDPC.defaultSender, webSocketID, requestJSON, responseProcessor);
    }
    
    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * @param snapshotId The id of the layer snapshot.
     * 
     * @param minRepeatCount The maximum number of times to replay the snapshot (1, if not specified).
     * <BR /><B>OPTIONAL</B>
     * 
     * @param minDuration The minimum duration (in seconds) to replay the snapshot.
     * <BR /><B>OPTIONAL</B>
     * 
     * @param clipRect The clip rectangle to apply when replaying the snapshot.
     * <BR /><B>OPTIONAL</B>
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * Number[][]&gt;</CODE>
     * 
     * <BR /><BR />This <B>script</B> may be <B STYLE='color: red'>executed</B>, using
     * {@link Script#exec()}, and afterwards, a {@link Promise}<CODE>&lt;JsonObject,
     * Number[][]&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
      * may be retrieved.</I>
     *
     * <BR /><BR />This Browser Function <B STYLE='color: red'>returns</B>
     * <BR /><BR /><UL CLASS=JDUL>
     * <LI><CODE>Number[][] (<B>timings</B></CODE>)
     *     <BR />The array of paint profiles, one per run.
     * </LI>
     * </UL> */
    public static Script<String, JsonObject, Number[][]> profileSnapshot
        (String snapshotId, Integer minRepeatCount, Number minDuration, DOM.Rect clipRect)
    {
        // Exception-Check(s) to ensure that if any parameters which are not declared as
        // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
        
        if (snapshotId == null) BRDPC.throwNPE("snapshotId");
        
        final int       webSocketID = 27005000 + counter++;
        final boolean[] optionals   = { false, true, true, true, };
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("profileSnapshot"),
            parameterNames.get("profileSnapshot"),
            optionals, webSocketID,
            "LayerTree.profileSnapshot",
            snapshotId, minRepeatCount, minDuration, clipRect
        );
        
        // 'JSON Binding' ... Converts Browser Response-JSON to 'Number[][]'
        Function<JsonObject, Number[][]> responseProcessor = (JsonObject jo) ->
            (jo.getJsonArray("timings") == null)
                ? null
                : ReadArrJSON.DimN.arrNumber(jo.getJsonArray("timings"), -1, 0, null, Number[][].class);;
        
        // Pass the 'defaultSender' to Script-Constructor
        // The sender that is used can be changed before executing script.
        return new Script<>(BRDPC.defaultSender, webSocketID, requestJSON, responseProcessor);
    }
    
    /**
     * Releases layer snapshot captured by the back-end.
     * 
     * @param snapshotId The id of the layer snapshot.
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * {@link Ret0}&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 />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 <JsonObject,} {@link Ret0}
     * {@code >} to ensure the Browser Function has run to completion.
     */
    public static Script<String, JsonObject, Ret0> releaseSnapshot(String snapshotId)
    {
        // Exception-Check(s) to ensure that if any parameters which are not declared as
        // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
        
        if (snapshotId == null) BRDPC.throwNPE("snapshotId");
        
        final int       webSocketID = 27006000 + counter++;
        final boolean[] optionals   = { false, };
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("releaseSnapshot"),
            parameterNames.get("releaseSnapshot"),
            optionals, webSocketID,
            "LayerTree.releaseSnapshot",
            snapshotId
        );
        
        // This Remote Command does not have a Return-Value.
        return new Script<>
            (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues);
    }
    
    /**
     * Replays the layer snapshot and returns the resulting bitmap.
     * 
     * @param snapshotId The id of the layer snapshot.
     * 
     * @param fromStep The first step to replay from (replay from the very start if not specified).
     * <BR /><B>OPTIONAL</B>
     * 
     * @param toStep The last step to replay to (replay till the end if not specified).
     * <BR /><B>OPTIONAL</B>
     * 
     * @param scale The scale to apply while replaying (defaults to 1).
     * <BR /><B>OPTIONAL</B>
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * String&gt;</CODE>
     * 
     * <BR /><BR />This <B>script</B> may be <B STYLE='color: red'>executed</B>, using
     * {@link Script#exec()}, and afterwards, a {@link Promise}<CODE>&lt;JsonObject,
     * String&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
      * may be retrieved.</I>
     *
     * <BR /><BR />This Browser Function <B STYLE='color: red'>returns</B>
     * <BR /><BR /><UL CLASS=JDUL>
     * <LI><CODE>String (<B>dataURL</B></CODE>)
     *     <BR />A data: URL for resulting image.
     * </LI>
     * </UL> */
    public static Script<String, JsonObject, String> replaySnapshot
        (String snapshotId, Integer fromStep, Integer toStep, Number scale)
    {
        // Exception-Check(s) to ensure that if any parameters which are not declared as
        // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
        
        if (snapshotId == null) BRDPC.throwNPE("snapshotId");
        
        final int       webSocketID = 27007000 + counter++;
        final boolean[] optionals   = { false, true, true, true, };
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("replaySnapshot"),
            parameterNames.get("replaySnapshot"),
            optionals, webSocketID,
            "LayerTree.replaySnapshot",
            snapshotId, fromStep, toStep, scale
        );
        
        // 'JSON Binding' ... Converts Browser Response-JSON to 'String'
        Function<JsonObject, String> responseProcessor = (JsonObject jo) ->
            ReadJSON.getString(jo, "dataURL", false, true);
        
        // Pass the 'defaultSender' to Script-Constructor
        // The sender that is used can be changed before executing script.
        return new Script<>(BRDPC.defaultSender, webSocketID, requestJSON, responseProcessor);
    }
    
    /**
     * Replays the layer snapshot and returns canvas log.
     * 
     * @param snapshotId The id of the layer snapshot.
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * JsonArray&gt;</CODE>
     * 
     * <BR /><BR />This <B>script</B> may be <B STYLE='color: red'>executed</B>, using
     * {@link Script#exec()}, and afterwards, a {@link Promise}<CODE>&lt;JsonObject,
     * JsonArray&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
      * may be retrieved.</I>
     *
     * <BR /><BR />This Browser Function <B STYLE='color: red'>returns</B>
     * <BR /><BR /><UL CLASS=JDUL>
     * <LI><CODE>JsonArray (<B>commandLog</B></CODE>)
     *     <BR />The array of canvas function calls.
     * </LI>
     * </UL> */
    public static Script<String, JsonObject, JsonArray> snapshotCommandLog(String snapshotId)
    {
        // Exception-Check(s) to ensure that if any parameters which are not declared as
        // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
        
        if (snapshotId == null) BRDPC.throwNPE("snapshotId");
        
        final int       webSocketID = 27008000 + counter++;
        final boolean[] optionals   = { false, };
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("snapshotCommandLog"),
            parameterNames.get("snapshotCommandLog"),
            optionals, webSocketID,
            "LayerTree.snapshotCommandLog",
            snapshotId
        );
        
        // 'JSON Binding' ... Converts Browser Response-JSON to 'JsonArray'
        Function<JsonObject, JsonArray> responseProcessor = (JsonObject jo) ->
            jo.getJsonArray("commandLog");
        
        // Pass the 'defaultSender' to Script-Constructor
        // The sender that is used can be changed before executing script.
        return new Script<>(BRDPC.defaultSender, webSocketID, requestJSON, responseProcessor);
    }
    
}