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>Provides access to log entries.</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 Log
{
    // ********************************************************************************************
    // ********************************************************************************************
    // Class Header Stuff
    // ********************************************************************************************
    // ********************************************************************************************


    // No Pubic Constructors
    private Log () { }

    // 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 : Log.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("clear", EMPTY_VEC_STR);

        parameterNames.put("disable", EMPTY_VEC_STR);

        parameterNames.put("enable", EMPTY_VEC_STR);

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

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


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

    /** Log entry. */
    public static class LogEntry
        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, false, true, false, true, true, true, true, true, true, }; }
        
        /** Log entry source. */
        public final String source;
        
        /** Log entry severity. */
        public final String level;
        
        /** Logged text. */
        public final String text;
        
        /**
         * <CODE>[No Description Provided by Google]</CODE>
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final String category;
        
        /** Timestamp when this entry was added. */
        public final Number timestamp;
        
        /**
         * URL of the resource if known.
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final String url;
        
        /**
         * Line number in the resource.
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final Integer lineNumber;
        
        /**
         * JavaScript stack trace.
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final RunTime.StackTrace stackTrace;
        
        /**
         * Identifier of the network request associated with this entry.
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final String networkRequestId;
        
        /**
         * Identifier of the worker associated with this entry.
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final String workerId;
        
        /**
         * Call arguments.
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final RunTime.RemoteObject[] args;
        
        /**
         * Constructor
         *
         * @param source Log entry source.
         * <BR />Acceptable Values: ["xml", "javascript", "network", "storage", "appcache", "rendering", "security", "deprecation", "worker", "violation", "intervention", "recommendation", "other"]
         * 
         * @param level Log entry severity.
         * <BR />Acceptable Values: ["verbose", "info", "warning", "error"]
         * 
         * @param text Logged text.
         * 
         * @param category -
         * <BR />Acceptable Values: ["cors"]
         * <BR /><B>OPTIONAL</B>
         * 
         * @param timestamp Timestamp when this entry was added.
         * 
         * @param url URL of the resource if known.
         * <BR /><B>OPTIONAL</B>
         * 
         * @param lineNumber Line number in the resource.
         * <BR /><B>OPTIONAL</B>
         * 
         * @param stackTrace JavaScript stack trace.
         * <BR /><B>OPTIONAL</B>
         * 
         * @param networkRequestId Identifier of the network request associated with this entry.
         * <BR /><B>OPTIONAL</B>
         * 
         * @param workerId Identifier of the worker associated with this entry.
         * <BR /><B>OPTIONAL</B>
         * 
         * @param args Call arguments.
         * <BR /><B>OPTIONAL</B>
         */
        public LogEntry(
                String source, String level, String text, String category, Number timestamp, 
                String url, Integer lineNumber, RunTime.StackTrace stackTrace, 
                String networkRequestId, String workerId, RunTime.RemoteObject[] args
            )
        {
            // 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 (source == null)    BRDPC.throwNPE("source");
            if (level == null)     BRDPC.throwNPE("level");
            if (text == null)      BRDPC.throwNPE("text");
            if (timestamp == null) BRDPC.throwNPE("timestamp");
            
            // 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(
                "source", source,
                "xml", "javascript", "network", "storage", "appcache", "rendering", "security", "deprecation", "worker", "violation", "intervention", "recommendation", "other"
            );
            BRDPC.checkIAE(
                "level", level,
                "verbose", "info", "warning", "error"
            );
            BRDPC.checkIAE(
                "category", category,
                "cors"
            );
            
            this.source            = source;
            this.level             = level;
            this.text              = text;
            this.category          = category;
            this.timestamp         = timestamp;
            this.url               = url;
            this.lineNumber        = lineNumber;
            this.stackTrace        = stackTrace;
            this.networkRequestId  = networkRequestId;
            this.workerId          = workerId;
            this.args              = args;
        }
        
        /**
         * JSON Object Constructor
         * @param jo A Json-Object having data about an instance of {@code 'LogEntry'}.
         */
        public LogEntry (JsonObject jo)
        {
            this.source            = ReadJSON.getString(jo, "source", false, true);
            this.level             = ReadJSON.getString(jo, "level", false, true);
            this.text              = ReadJSON.getString(jo, "text", false, true);
            this.category          = ReadJSON.getString(jo, "category", true, false);
            this.timestamp         = ReadNumberJSON.get(jo, "timestamp", false, true);
            this.url               = ReadJSON.getString(jo, "url", true, false);
            this.lineNumber        = ReadBoxedJSON.getInteger(jo, "lineNumber", true);
            this.stackTrace        = ReadJSON.getObject(jo, "stackTrace", RunTime.StackTrace.class, true, false);
            this.networkRequestId  = ReadJSON.getString(jo, "networkRequestId", true, false);
            this.workerId          = ReadJSON.getString(jo, "workerId", true, false);
            this.args = (jo.getJsonArray("args") == null)
                ? null
                : RJArrDimN.objArr(jo.getJsonArray("args"), null, 0, RunTime.RemoteObject[].class);
        
        }
        
        
        /** 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;
        
            LogEntry o = (LogEntry) other;
        
            return
                    Objects.equals(this.source, o.source)
                &&  Objects.equals(this.level, o.level)
                &&  Objects.equals(this.text, o.text)
                &&  Objects.equals(this.category, o.category)
                &&  Objects.equals(this.timestamp, o.timestamp)
                &&  Objects.equals(this.url, o.url)
                &&  Objects.equals(this.lineNumber, o.lineNumber)
                &&  Objects.equals(this.stackTrace, o.stackTrace)
                &&  Objects.equals(this.networkRequestId, o.networkRequestId)
                &&  Objects.equals(this.workerId, o.workerId)
                &&  Arrays.deepEquals(this.args, o.args);
        }
        
        /** Generates a Hash-Code for {@code 'this'} instance */
        public int hashCode()
        {
            return
                    Objects.hashCode(this.source)
                +   Objects.hashCode(this.level)
                +   Objects.hashCode(this.text)
                +   Objects.hashCode(this.category)
                +   Objects.hashCode(this.timestamp)
                +   Objects.hashCode(this.url)
                +   Objects.hashCode(this.lineNumber)
                +   this.stackTrace.hashCode()
                +   Objects.hashCode(this.networkRequestId)
                +   Objects.hashCode(this.workerId)
                +   Arrays.deepHashCode(this.args);
        }
    }
    
    /** Violation configuration setting. */
    public static class ViolationSetting
        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, }; }
        
        /** Violation type. */
        public final String name;
        
        /** Time threshold to trigger upon. */
        public final Number threshold;
        
        /**
         * Constructor
         *
         * @param name Violation type.
         * <BR />Acceptable Values: ["longTask", "longLayout", "blockedEvent", "blockedParser", "discouragedAPIUse", "handler", "recurringHandler"]
         * 
         * @param threshold Time threshold to trigger upon.
         */
        public ViolationSetting(String name, Number threshold)
        {
            // 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 (threshold == null) BRDPC.throwNPE("threshold");
            
            // 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(
                "name", name,
                "longTask", "longLayout", "blockedEvent", "blockedParser", "discouragedAPIUse", "handler", "recurringHandler"
            );
            
            this.name       = name;
            this.threshold  = threshold;
        }
        
        /**
         * JSON Object Constructor
         * @param jo A Json-Object having data about an instance of {@code 'ViolationSetting'}.
         */
        public ViolationSetting (JsonObject jo)
        {
            this.name       = ReadJSON.getString(jo, "name", false, true);
            this.threshold  = ReadNumberJSON.get(jo, "threshold", 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;
        
            ViolationSetting o = (ViolationSetting) other;
        
            return
                    Objects.equals(this.name, o.name)
                &&  Objects.equals(this.threshold, o.threshold);
        }
        
        /** Generates a Hash-Code for {@code 'this'} instance */
        public int hashCode()
        {
            return
                    Objects.hashCode(this.name)
                +   Objects.hashCode(this.threshold);
        }
    }
    
    /** Issued when new message was logged. */
    public static class entryAdded
        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, }; }
        
        /** The entry. */
        public final Log.LogEntry entry;
        
        /**
         * Constructor
         *
         * @param entry The entry.
         */
        public entryAdded(Log.LogEntry entry)
        {
            super("Log", "entryAdded", 1);
            
            // 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 (entry == null) BRDPC.throwNPE("entry");
            
            this.entry  = entry;
        }
        
        /**
         * JSON Object Constructor
         * @param jo A Json-Object having data about an instance of {@code 'entryAdded'}.
         */
        public entryAdded (JsonObject jo)
        {
            super("Log", "entryAdded", 1);
        
            this.entry  = ReadJSON.getObject(jo, "entry", Log.LogEntry.class, 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;
        
            entryAdded o = (entryAdded) other;
        
            return
                    Objects.equals(this.entry, o.entry);
        }
        
        /** Generates a Hash-Code for {@code 'this'} instance */
        public int hashCode()
        {
            return
                    this.entry.hashCode();
        }
    }
    
    
    // Counter for keeping the WebSocket Request ID's distinct.
    private static int counter = 1;
    
    /**
     * Clears the log.
     * 
     * @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> clear()
    {
        final int          webSocketID = 28000000 + 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("clear"),
            parameterNames.get("clear"),
            optionals, webSocketID,
            "Log.clear"
        );
        
        // This Remote Command does not have a Return-Value.
        return new Script<>
            (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues);
    }
    
    /**
     * Disables log domain, prevents further log entries from being reported to the client.
     * 
     * @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 = 28001000 + 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,
            "Log.disable"
        );
        
        // This Remote Command does not have a Return-Value.
        return new Script<>
            (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues);
    }
    
    /**
     * Enables log domain, sends the entries collected so far to the client by means of the
     * <CODE>entryAdded</CODE> notification.
     * 
     * @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 = 28002000 + 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,
            "Log.enable"
        );
        
        // This Remote Command does not have a Return-Value.
        return new Script<>
            (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues);
    }
    
    /**
     * start violation reporting.
     * 
     * @param config Configuration for violations.
     * 
     * @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> startViolationsReport
        (Log.ViolationSetting[] config)
    {
        // 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 (config == null) BRDPC.throwNPE("config");
        
        final int       webSocketID = 28003000 + counter++;
        final boolean[] optionals   = { false, };
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("startViolationsReport"),
            parameterNames.get("startViolationsReport"),
            optionals, webSocketID,
            "Log.startViolationsReport",
            (Object) config
        );
        
        // This Remote Command does not have a Return-Value.
        return new Script<>
            (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues);
    }
    
    /**
     * Stop violation reporting.
     * 
     * @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> stopViolationsReport()
    {
        final int          webSocketID = 28004000 + 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("stopViolationsReport"),
            parameterNames.get("stopViolationsReport"),
            optionals, webSocketID,
            "Log.stopViolationsReport"
        );
        
        // This Remote Command does not have a Return-Value.
        return new Script<>
            (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues);
    }
    
}