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 Torello.Java.JSON.*;

import static Torello.Java.JSON.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 Performance
{
    // ********************************************************************************************
    // ********************************************************************************************
    // Class Header Stuff
    // ********************************************************************************************
    // ********************************************************************************************


    // No Pubic Constructors
    private Performance () { }

    // 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 : Performance.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;

        parameterNames.put("disable", EMPTY_VEC_STR);

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

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

        parameterNames.put("getMetrics", EMPTY_VEC_STR);
    }


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

    /** Run-time execution metric. */
    public static class Metric
        extends BaseType
        implements java.io.Serializable
    {
        /** For Object Serialization.  java.io.Serializable */
        protected static final long serialVersionUID = 1;
        
        public boolean[] optionals()
        { return new boolean[] { false, false, }; }
        
        /** Metric name. */
        public final String name;
        
        /** Metric value. */
        public final Number value;
        
        /**
         * Constructor
         *
         * @param name Metric name.
         * 
         * @param value Metric value.
         */
        public Metric(String name, Number value)
        {
            // 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 (name == null)  BRDPC.throwNPE("name");
            if (value == null) BRDPC.throwNPE("value");
            
            this.name   = name;
            this.value  = value;
        }
        
        /**
         * JSON Object Constructor
         * @param jo A Json-Object having data about an instance of {@code 'Metric'}.
         */
        public Metric (JsonObject jo)
        {
            this.name   = ReadJSON.getString(jo, "name", false, true);
            this.value  = ReadNumberJSON.get(jo, "value", false, true);
        }
        
        
        /** Checks whether {@code 'this'} equals an input Java-{@code Object} */
        public boolean equals(Object other)
        {
            if (other == null)                       return false;
            if (other.getClass() != this.getClass()) return false;
        
            Metric o = (Metric) other;
        
            return
                    Objects.equals(this.name, o.name)
                &&  Objects.equals(this.value, o.value);
        }
        
        /** Generates a Hash-Code for {@code 'this'} instance */
        public int hashCode()
        {
            return
                    Objects.hashCode(this.name)
                +   Objects.hashCode(this.value);
        }
    }
    
    /** Current values of the metrics. */
    public static class metrics
        extends BrowserEvent
        implements java.io.Serializable
    {
        /** For Object Serialization.  java.io.Serializable */
        protected static final long serialVersionUID = 1;
        
        public boolean[] optionals()
        { return new boolean[] { false, false, }; }
        
        /** Current values of the metrics. */
        public final Performance.Metric[] metrics;
        
        /** Timestamp title. */
        public final String title;
        
        /**
         * Constructor
         *
         * @param metrics Current values of the metrics.
         * 
         * @param title Timestamp title.
         */
        public metrics(Performance.Metric[] metrics, String title)
        {
            super("Performance", "metrics", 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 (metrics == null) BRDPC.throwNPE("metrics");
            if (title == null)   BRDPC.throwNPE("title");
            
            this.metrics  = metrics;
            this.title    = title;
        }
        
        /**
         * JSON Object Constructor
         * @param jo A Json-Object having data about an instance of {@code 'metrics'}.
         */
        public metrics (JsonObject jo)
        {
            super("Performance", "metrics", 2);
        
            this.metrics = (jo.getJsonArray("metrics") == null)
                ? null
                : ReadArrJSON.DimN.objArr(jo.getJsonArray("metrics"), null, 0, Performance.Metric[].class);
        
            this.title    = ReadJSON.getString(jo, "title", false, true);
        }
        
        
        /** Checks whether {@code 'this'} equals an input Java-{@code Object} */
        public boolean equals(Object other)
        {
            if (other == null)                       return false;
            if (other.getClass() != this.getClass()) return false;
        
            metrics o = (metrics) other;
        
            return
                    Arrays.deepEquals(this.metrics, o.metrics)
                &&  Objects.equals(this.title, o.title);
        }
        
        /** Generates a Hash-Code for {@code 'this'} instance */
        public int hashCode()
        {
            return
                    Arrays.deepHashCode(this.metrics)
                +   Objects.hashCode(this.title);
        }
    }
    
    
    // Counter for keeping the WebSocket Request ID's distinct.
    private static int counter = 1;
    
    /**
     * Disable collecting and reporting metrics.
     * 
     * @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 = 33000000 + 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,
            "Performance.disable"
        );
        
        // This Remote Command does not have a Return-Value.
        return new Script<>
            (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues);
    }
    
    /**
     * Enable collecting and reporting metrics.
     * 
     * @param timeDomain Time domain to use for collecting and reporting duration metrics.
     * <BR />Acceptable Values: ["timeTicks", "threadTicks"]
     * <BR /><B>OPTIONAL</B>
     * 
     * @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(String timeDomain)
    {
        // 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(
            "timeDomain", timeDomain,
            "timeTicks", "threadTicks"
        );
        
        final int       webSocketID = 33001000 + counter++;
        final boolean[] optionals   = { true, };
        
        // 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,
            "Performance.enable",
            timeDomain
        );
        
        // This Remote Command does not have a Return-Value.
        return new Script<>
            (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues);
    }
    
    /**
     * Sets time domain to use for collecting and reporting duration metrics.
     * Note that this must be called before enabling metrics collection. Calling
     * this method while metrics collection is enabled returns an error.
     * <BR /><B>EXPERIMENTAL</B>
     * <BR /><B>DEPRECATED</B>
     * 
     * @param timeDomain Time domain
     * <BR />Acceptable Values: ["timeTicks", "threadTicks"]
     * 
     * @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> setTimeDomain(String timeDomain)
    {
        // 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 (timeDomain == null) BRDPC.throwNPE("timeDomain");
        
        // 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(
            "timeDomain", timeDomain,
            "timeTicks", "threadTicks"
        );
        
        final int       webSocketID = 33002000 + counter++;
        final boolean[] optionals   = { false, };
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("setTimeDomain"),
            parameterNames.get("setTimeDomain"),
            optionals, webSocketID,
            "Performance.setTimeDomain",
            timeDomain
        );
        
        // This Remote Command does not have a Return-Value.
        return new Script<>
            (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues);
    }
    
    /**
     * Retrieve current values of run-time metrics.
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * {@link Performance.Metric}[]&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,
     * {@link Performance.Metric}[]&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>{@link Performance.Metric}[] (<B>metrics</B></CODE>)
     *     <BR />Current values for run-time metrics.
     * </LI>
     * </UL> */
    public static Script<String, JsonObject, Performance.Metric[]> getMetrics()
    {
        final int          webSocketID = 33003000 + 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("getMetrics"),
            parameterNames.get("getMetrics"),
            optionals, webSocketID,
            "Performance.getMetrics"
        );
        
        // 'JSON Binding' ... Converts Browser Response-JSON to 'Performance.Metric[]'
        Function<JsonObject, Performance.Metric[]> responseProcessor = (JsonObject jo) ->
            (jo.getJsonArray("metrics") == null)
                ? null
                : ReadArrJSON.DimN.objArr(jo.getJsonArray("metrics"), null, 0, Performance.Metric[].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);
    }
    
}