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>This domain is deprecated - use RunTime or Log instead.</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 Console
{
    // ********************************************************************************************
    // ********************************************************************************************
    // Class Header Stuff
    // ********************************************************************************************
    // ********************************************************************************************


    // No Pubic Constructors
    private Console () { }

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

        parameterNames.put("disable", EMPTY_VEC_STR);

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


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

    /** Console message. */
    public static class ConsoleMessage
        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, true, true, }; }
        
        /** Message source. */
        public final String source;
        
        /** Message severity. */
        public final String level;
        
        /** Message text. */
        public final String text;
        
        /**
         * URL of the message origin.
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final String url;
        
        /**
         * Line number in the resource that generated this message (1-based).
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final Integer line;
        
        /**
         * Column number in the resource that generated this message (1-based).
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final Integer column;
        
        /**
         * Constructor
         *
         * @param source Message source.
         * <BR />Acceptable Values: ["xml", "javascript", "network", "console-api", "storage", "appcache", "rendering", "security", "other", "deprecation", "worker"]
         * 
         * @param level Message severity.
         * <BR />Acceptable Values: ["log", "warning", "error", "debug", "info"]
         * 
         * @param text Message text.
         * 
         * @param url URL of the message origin.
         * <BR /><B>OPTIONAL</B>
         * 
         * @param line Line number in the resource that generated this message (1-based).
         * <BR /><B>OPTIONAL</B>
         * 
         * @param column Column number in the resource that generated this message (1-based).
         * <BR /><B>OPTIONAL</B>
         */
        public ConsoleMessage
            (String source, String level, String text, String url, Integer line, Integer column)
        {
            // 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");
            
            // 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", "console-api", "storage", "appcache", "rendering", "security", "other", "deprecation", "worker"
            );
            BRDPC.checkIAE(
                "level", level,
                "log", "warning", "error", "debug", "info"
            );
            
            this.source  = source;
            this.level   = level;
            this.text    = text;
            this.url     = url;
            this.line    = line;
            this.column  = column;
        }
        
        /**
         * JSON Object Constructor
         * @param jo A Json-Object having data about an instance of {@code 'ConsoleMessage'}.
         */
        public ConsoleMessage (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.url     = ReadJSON.getString(jo, "url", true, false);
            this.line    = ReadBoxedJSON.getInteger(jo, "line", true);
            this.column  = ReadBoxedJSON.getInteger(jo, "column", 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;
        
            ConsoleMessage o = (ConsoleMessage) other;
        
            return
                    Objects.equals(this.source, o.source)
                &&  Objects.equals(this.level, o.level)
                &&  Objects.equals(this.text, o.text)
                &&  Objects.equals(this.url, o.url)
                &&  Objects.equals(this.line, o.line)
                &&  Objects.equals(this.column, o.column);
        }
        
        /** 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.url)
                +   Objects.hashCode(this.line)
                +   Objects.hashCode(this.column);
        }
    }
    
    /** Issued when new console message is added. */
    public static class messageAdded
        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, }; }
        
        /** Console message that has been added. */
        public final Console.ConsoleMessage message;
        
        /**
         * Constructor
         *
         * @param message Console message that has been added.
         */
        public messageAdded(Console.ConsoleMessage message)
        {
            super("Console", "messageAdded", 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 (message == null) BRDPC.throwNPE("message");
            
            this.message  = message;
        }
        
        /**
         * JSON Object Constructor
         * @param jo A Json-Object having data about an instance of {@code 'messageAdded'}.
         */
        public messageAdded (JsonObject jo)
        {
            super("Console", "messageAdded", 1);
        
            this.message  = ReadJSON.getObject(jo, "message", Console.ConsoleMessage.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;
        
            messageAdded o = (messageAdded) other;
        
            return
                    Objects.equals(this.message, o.message);
        }
        
        /** Generates a Hash-Code for {@code 'this'} instance */
        public int hashCode()
        {
            return
                    this.message.hashCode();
        }
    }
    
    
    // Counter for keeping the WebSocket Request ID's distinct.
    private static int counter = 1;
    
    /**
     * Does nothing.
     * 
     * @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> clearMessages()
    {
        final int          webSocketID = 1000000 + 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("clearMessages"),
            parameterNames.get("clearMessages"),
            optionals, webSocketID,
            "Console.clearMessages"
        );
        
        // This Remote Command does not have a Return-Value.
        return new Script<>
            (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues);
    }
    
    /**
     * Disables console domain, prevents further console messages 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 = 1001000 + 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,
            "Console.disable"
        );
        
        // This Remote Command does not have a Return-Value.
        return new Script<>
            (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues);
    }
    
    /**
     * Enables console domain, sends the messages collected so far to the client by means of the
     * <CODE>messageAdded</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 = 1002000 + 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,
            "Console.enable"
        );
        
        // This Remote Command does not have a Return-Value.
        return new Script<>
            (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues);
    }
    
}