/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#include "nsISupports.idl"

%{C++
namespace mozilla {
namespace dom {
class ContentParent;
class JSActorManager;
} // namespace dom
} // namespace mozilla
%}
[ptr] native ContentParentPtr(mozilla::dom::ContentParent);
[ptr] native JSActorManagerPtr(mozilla::dom::JSActorManager);

interface nsIPrincipal;

webidl JSProcessActorParent;

/**
 * Parent actor interface for a process which can host DOM content.
 *
 * Implemented by either `InProcessParent` for the parent process, or
 * `ContentParent` for a content process.
 */
[scriptable, builtinclass, uuid(81fc08b9-c901-471f-ab0d-876362eba770)]
interface nsIDOMProcessParent: nsISupports {
  /**
   * Internal child process ID. `0` is reserved for the parent process.
   */
  [infallible] readonly attribute unsigned long long childID;

  /**
   * OS ID of the process.
   */
  [infallible] readonly attribute long osPid;

  /**
   * Lookup a JSProcessActorParent managed by this interface by name.
   */
  [implicit_jscontext] JSProcessActorParent getActor(in ACString name);
  JSProcessActorParent getExistingActor(in ACString name);

  /** Can the actor still send messages? */
  [infallible] readonly attribute boolean canSend;

  [notxpcom, nostdcall] ContentParentPtr AsContentParent();

  /** Cast this nsIDOMProcessParent to a JSActorManager */
  [notxpcom, nostdcall] JSActorManagerPtr AsJSActorManager();

  /**
   * Called when we are about to load an origin within a content process.
   * e.g. due to loading a document or remote worker.
   */
  void aboutToLoadOrigin(in nsIPrincipal principal);

  /**
   * Remote type of the process.
   */
  readonly attribute ACString remoteType;

  /*
   * Validates the given principal based on its remote type.
   */
  [binaryname(ValidatePrincipalXPCOM)] boolean validatePrincipal(in nsIPrincipal principal);
};

/**
 * Reference counted and cycle collected interface to expose a
 * UniqueContentParentKeepAlive to chrome JS.
 */
[scriptable, builtinclass, uuid(b43907bd-e40d-4bf5-a85e-866998beb7a9)]
interface nsIContentParentKeepAlive: nsISupports {
  /**
   * Underlying nsIDOMProcessParent which is being kept alive.
   */
  readonly attribute nsIDOMProcessParent domProcess;

  /**
   * Invalidate this nsIContentParentKeepAlive, dropping the keep alive
   * and ContentParent reference without waiting for the object to be gc/cc-ed.
   */
  void invalidateKeepAlive();
};