package Torello.Browser;

/**
 * A simple way of representing the various Browser Domains offered by the Remote Browser.
 * Protocol.  Instances of this <B>{@code enum}</B> are attched to each and every
 * {@link BrowserEvent} which is generated &amp; propagated by the browser.
 */
public enum Domains 
{
    // ********************************************************************************************
    // ********************************************************************************************
    // Browser API Domains
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * {@code [No Description provided by Google]}
     * @see Torello.Browser.BrowserAPI.Accessibility
     */
    Accessibility(true /* BrowserAPI */),

    /**
     * {@code [No Description provided by Google]}
     * @see Torello.Browser.BrowserAPI.Animation
     */
    Animation(true /* BrowserAPI */),

    /**
     * Audits domain allows investigation of page violations and possible improvements.
     * @see Torello.Browser.BrowserAPI.Audits
     */
    Audits(true /* BrowserAPI */),

    /**
     * Defines commands and events for Autofill.
     * @see Torello.Browser.BrowserAPI.Autofill
     */
    Autofill(true /* BrowserAPI */),

    /**
     * Defines events for background web platform features.
     * @see Torello.Browser.BrowserAPI.BackgroundService
     */
    BackgroundService(true /* BrowserAPI */),

    /**
     * This domain allows configuring virtual Bluetooth devices to test the web-bluetooth API.
     * @see Torello.Browser.BrowserAPI.BluetoothEmulation
     */
    BluetoothEmulation(true /* BrowserAPI */),

    /**
     * The Browser domain defines methods and events for browser managing.
     * @see Torello.Browser.BrowserAPI.Browser
     */
    Browser(true /* BrowserAPI */),

    /**
     * This domain exposes CSS read/write operations. All CSS objects (stylesheets, rules, and
     * styles) have an associated `id` used in subsequent operations on the related object. Each
     * object type has a specific `id` structure, and those are not interchangeable between objects
     * of different kinds. CSS objects can be loaded using the `get*ForNode()` calls (which accept
     * a DOM node id). A client can also keep track of stylesheets via the
     * `styleSheetAdded`/`styleSheetRemoved` events and subsequently load the required stylesheet
     * contents using the `getStyleSheet[Text]()` methods.
     * @see Torello.Browser.BrowserAPI.CSS
     */
    CSS(true /* BrowserAPI */),

    /**
     * {@code [No Description provided by Google]}
     * @see Torello.Browser.BrowserAPI.CacheStorage
     */
    CacheStorage(true /* BrowserAPI */),

    /**
     * A domain for interacting with Cast, Presentation API, and Remote Playback API
     * functionalities.
     * @see Torello.Browser.BrowserAPI.Cast
     */
    Cast(true /* BrowserAPI */),

    /**
     * This domain exposes DOM read/write operations. Each DOM Node is represented with its mirror
     * object that has an `id`. This `id` can be used to get additional information on the Node,
     * resolve it into the JavaScript object wrapper, etc. It is important that client receives DOM
     * events only for the nodes that are known to the client. Backend keeps track of the nodes
     * that were sent to the client and never sends the same node twice. It is client's
     * responsibility to collect information about the nodes that were sent to the client. Note
     * that `iframe` owner elements will return corresponding document elements as their child
     * nodes.
     * @see Torello.Browser.BrowserAPI.DOM
     */
    DOM(true /* BrowserAPI */),

    /**
     * DOM debugging allows setting breakpoints on particular DOM operations and events. JavaScript
     * execution will stop on these operations as if there was a regular breakpoint set.
     * @see Torello.Browser.BrowserAPI.DOMDebugger
     */
    DOMDebugger(true /* BrowserAPI */),

    /**
     * This domain facilitates obtaining document snapshots with DOM, layout, and style
     * information.
     * @see Torello.Browser.BrowserAPI.DOMSnapshot
     */
    DOMSnapshot(true /* BrowserAPI */),

    /**
     * Query and modify DOM storage.
     * @see Torello.Browser.BrowserAPI.DOMStorage
     */
    DOMStorage(true /* BrowserAPI */),

    /**
     * {@code [No Description provided by Google]}
     * @see Torello.Browser.BrowserAPI.DeviceAccess
     */
    DeviceAccess(true /* BrowserAPI */),

    /**
     * {@code [No Description provided by Google]}
     * @see Torello.Browser.BrowserAPI.DeviceOrientation
     */
    DeviceOrientation(true /* BrowserAPI */),

    /**
     * This domain emulates different environments for the page.
     * @see Torello.Browser.BrowserAPI.Emulation
     */
    Emulation(true /* BrowserAPI */),

    /**
     * EventBreakpoints permits setting JavaScript breakpoints on operations and events occurring
     * in native code invoked from JavaScript. Once breakpoint is hit, it is reported through
     * Debugger domain, similarly to regular breakpoints being hit.
     * @see Torello.Browser.BrowserAPI.EventBreakpoints
     */
    EventBreakpoints(true /* BrowserAPI */),

    /**
     * Defines commands and events for browser extensions.
     * @see Torello.Browser.BrowserAPI.Extensions
     */
    Extensions(true /* BrowserAPI */),

    /**
     * This domain allows interacting with the FedCM dialog.
     * @see Torello.Browser.BrowserAPI.FedCm
     */
    FedCm(true /* BrowserAPI */),

    /**
     * A domain for letting clients substitute browser's network layer with client code.
     * @see Torello.Browser.BrowserAPI.Fetch
     */
    Fetch(true /* BrowserAPI */),

    /**
     * {@code [No Description provided by Google]}
     * @see Torello.Browser.BrowserAPI.FileSystem
     */
    FileSystem(true /* BrowserAPI */),

    /**
     * This domain provides experimental commands only supported in headless mode.
     * @see Torello.Browser.BrowserAPI.HeadlessExperimental
     */
    HeadlessExperimental(true /* BrowserAPI */),

    /**
     * Input/Output operations for streams produced by DevTools.
     * @see Torello.Browser.BrowserAPI.IO
     */
    IO(true /* BrowserAPI */),

    /**
     * {@code [No Description provided by Google]}
     * @see Torello.Browser.BrowserAPI.IndexedDB
     */
    IndexedDB(true /* BrowserAPI */),

    /**
     * {@code [No Description provided by Google]}
     * @see Torello.Browser.BrowserAPI.Input
     */
    Input(true /* BrowserAPI */),

    /**
     * {@code [No Description provided by Google]}
     * @see Torello.Browser.BrowserAPI.Inspector
     */
    Inspector(true /* BrowserAPI */),

    /**
     * {@code [No Description provided by Google]}
     * @see Torello.Browser.BrowserAPI.LayerTree
     */
    LayerTree(true /* BrowserAPI */),

    /**
     * Provides access to log entries.
     * @see Torello.Browser.BrowserAPI.Log
     */
    Log(true /* BrowserAPI */),

    /**
     * This domain allows detailed inspection of media elements
     * @see Torello.Browser.BrowserAPI.Media
     */
    Media(true /* BrowserAPI */),

    /**
     * {@code [No Description provided by Google]}
     * @see Torello.Browser.BrowserAPI.Memory
     */
    Memory(true /* BrowserAPI */),

    /**
     * Network domain allows tracking network activities of the page. It exposes information about
     * http, file, data and other requests and responses, their headers, bodies, timing, etc.
     * @see Torello.Browser.BrowserAPI.Network
     */
    Network(true /* BrowserAPI */),

    /**
     * This domain provides various functionality related to drawing atop the inspected page.
     * @see Torello.Browser.BrowserAPI.Overlay
     */
    Overlay(true /* BrowserAPI */),

    /**
     * This domain allows interacting with the browser to control PWAs.
     * @see Torello.Browser.BrowserAPI.PWA
     */
    PWA(true /* BrowserAPI */),

    /**
     * Actions and events related to the inspected page belong to the page domain.
     * @see Torello.Browser.BrowserAPI.Page
     */
    Page(true /* BrowserAPI */),

    /**
     * {@code [No Description provided by Google]}
     * @see Torello.Browser.BrowserAPI.Performance
     */
    Performance(true /* BrowserAPI */),

    /**
     * Reporting of performance timeline events, as specified in
     * https://w3c.github.io/performance-timeline/#dom-performanceobserver.
     * @see Torello.Browser.BrowserAPI.PerformanceTimeline
     */
    PerformanceTimeline(true /* BrowserAPI */),

    /**
     * {@code [No Description provided by Google]}
     * @see Torello.Browser.BrowserAPI.Preload
     */
    Preload(true /* BrowserAPI */),

    /**
     * Security
     * @see Torello.Browser.BrowserAPI.Security
     */
    Security(true /* BrowserAPI */),

    /**
     * {@code [No Description provided by Google]}
     * @see Torello.Browser.BrowserAPI.ServiceWorker
     */
    ServiceWorker(true /* BrowserAPI */),

    /**
     * {@code [No Description provided by Google]}
     * @see Torello.Browser.BrowserAPI.Storage
     */
    Storage(true /* BrowserAPI */),

    /**
     * The SystemInfo domain defines methods and events for querying low-level system information.
     * @see Torello.Browser.BrowserAPI.SystemInfo
     */
    SystemInfo(true /* BrowserAPI */),

    /**
     * Supports additional targets discovery and allows to attach to them.
     * @see Torello.Browser.BrowserAPI.Target
     */
    Target(true /* BrowserAPI */),

    /**
     * The Tethering domain defines methods and events for browser port binding.
     * @see Torello.Browser.BrowserAPI.Tethering
     */
    Tethering(true /* BrowserAPI */),

    /**
     * {@code [No Description provided by Google]}
     * @see Torello.Browser.BrowserAPI.Tracing
     */
    Tracing(true /* BrowserAPI */),

    /**
     * This domain allows inspection of Web Audio API. https://webaudio.github.io/web-audio-api/
     * @see Torello.Browser.BrowserAPI.WebAudio
     */
    WebAudio(true /* BrowserAPI */),

    /**
     * This domain allows configuring virtual authenticators to test the WebAuthn API.
     * @see Torello.Browser.BrowserAPI.WebAuthn
     */
    WebAuthn(true /* BrowserAPI */),


    // ********************************************************************************************
    // ********************************************************************************************
    // JavaScript API Domains
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * This domain is deprecated - use RunTime or Log instead.
     * @see Torello.Browser.JavaScriptAPI.Console
     */
    Console(false /* JavaScriptAPI */),

    /**
     * Debugger domain exposes JavaScript debugging capabilities. It allows setting and removing
     * breakpoints, stepping through execution, exploring stack traces, etc.
     * @see Torello.Browser.JavaScriptAPI.Debugger
     */
    Debugger(false /* JavaScriptAPI */),

    /**
     * {@code [No Description provided by Google]}
     * @see Torello.Browser.JavaScriptAPI.HeapProfiler
     */
    HeapProfiler(false /* JavaScriptAPI */),

    /**
     * {@code [No Description provided by Google]}
     * @see Torello.Browser.JavaScriptAPI.Profiler
     */
    Profiler(false /* JavaScriptAPI */),

    /**
     * RunTime domain exposes JavaScript runtime by means of remote evaluation and mirror objects.
     * Evaluation results are returned as mirror object that expose object type, string
     * representation and unique identifier that can be used for further object reference. Original
     * objects are maintained in memory unless they are either explicitly released or are released
     * along with the other objects in their object group.
     * @see Torello.Browser.JavaScriptAPI.RunTime
     */
    RunTime(false /* JavaScriptAPI */),

    /**
     * This domain is deprecated.
     * @see Torello.Browser.JavaScriptAPI.Schema
     */
    Schema(false /* JavaScriptAPI */);


    // ********************************************************************************************
    // ********************************************************************************************
    // Constructor ana Constants
    // ********************************************************************************************
    // ********************************************************************************************


    /** {@code TRUE} indicates that a constant is a member of the JavaScript API */
    public static final boolean BrowserAPI = true;

    /** {@code FALSE} indicates that a constant is a member of the Browser API */
    public static final boolean JSAPI = false;

    /**
     * When {@code TRUE}, this {@code Domain} is amongst the Browser-API {@code Domains}.
     * When {@code FALSE}, this is a member of the JavaScript-API {@code Domains}.
     */
    public final boolean browserAPI_Or_JSAPI;

    private Domains(boolean browserAPI_Or_JSAPI)
    { this.browserAPI_Or_JSAPI = browserAPI_Or_JSAPI; };

    /**
     * Geerates a Full-Path Class-Name, as a {@code String} for the Domain that is represented
     * this Enum-Constant.  If {@code 'this'} Enum-Constant were {@link #Animation}, this method
     * would return:
     * 
     * <BR /><BR /><B>{@code "Torello.Browser.BrowserAPI.Animation"}</B>
     */
    public String toFullPackageName()
    {
        return 
            "Torello.Browser." +
            (this.browserAPI_Or_JSAPI ? "BrowserAPI" : "JavaScriptAPI") +
            '.' +
            this.name();
    }

    /**
     * Generates the Package-Name for the API in which this Domain resides.  If {@code 'this'}
     * Enum-Constant were {@link #Animation}, this method would return:
     * 
     * <BR /><BR /><B>{@code "Torello.Browser.BrowserAPI"}</B>
     */
    public String getPackageName()
    {
        return
            "Torello.Browser." +
            (this.browserAPI_Or_JSAPI ? "BrowserAPI" : "JavaScriptAPI");
    }

    // Used by the builders.  It's transient, so it's not serialized
    private transient Class<?> domainClass = null;

    public Class<?> getDomainClass()
    {
        if (this.domainClass != null) return this.domainClass;

        try
        {
            this.domainClass = Class.forName(this.toFullPackageName());

            if (this.domainClass == null) throw new DomainEnumError(
                "Class.forName(...) returned null for Domain Class:\n" +
                this.toFullPackageName()
            );

            return this.domainClass;
        }

        catch (ClassNotFoundException e)
        {
            throw new DomainEnumError(
                "Unable to load the Domain Class using Class.forName(...):\n" +
                this.toFullPackageName(),
                e
            );
        }

        catch (LinkageError e)
        {
            throw new DomainEnumError(
                "The Domain Class was found, but Java could not load/link/initialize it:\n" +
                this.toFullPackageName(),
                e
            );
        }

        catch (SecurityException e)
        {
            throw new DomainEnumError(
                "A SecurityManager prevented loading the Domain Class:\n" +
                this.toFullPackageName(),
                e
            );
        }
    }

    private static class DomainEnumError extends Error
    {
        protected static final long serialVersionUID = 1;

        private DomainEnumError(final String message)
        { super(message); }

        private DomainEnumError(final String message, final Throwable cause)
        { super(message, cause); }
    }
}