ChromeUtils.h - mozsearch

mozilla-central/dom/base/ChromeUtils.h (file symbol)

Enable keyboard shortcuts

Source code

Revision control

Copy as Markdown

Other Tools

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */

/* vim: set ts=8 sts=2 et sw=2 tw=80: */

/* 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/. */

#ifndef mozilla_dom_ChromeUtils__

#define mozilla_dom_ChromeUtils__

#include "mozilla/AlreadyAddRefed.h"

#include "mozilla/dom/BindingDeclarations.h"

#include "mozilla/dom/ChromeUtilsBinding.h"

#include "mozilla/dom/Exceptions.h"

#include "mozilla/dom/Record.h"

#include "nsDOMNavigationTiming.h"  // for DOMHighResTimeStamp

#include "nsIDOMProcessChild.h"

#include "nsIDOMProcessParent.h"

namespace mozilla {

class ErrorResult;

namespace devtools {

class HeapSnapshot;

}  // namespace devtools

namespace dom {

class ArrayBufferViewOrArrayBuffer;

class BrowsingContext;

class Element;

class IdleRequestCallback;

struct IdleRequestOptions;

struct MediaMetadataInit;

class MozQueryInterface;

class PrecompiledScript;

class Promise;

struct ProcessActorOptions;

struct WindowActorOptions;

class ChromeUtils {

 private:

  // Implemented in devtools/shared/heapsnapshot/HeapSnapshot.cpp

  static void SaveHeapSnapshotShared(GlobalObject& global,

                                     const HeapSnapshotBoundaries& boundaries,

                                     nsAString& filePath, nsAString& snapshotId,

                                     ErrorResult& rv);

 public:

  // Implemented in devtools/shared/heapsnapshot/HeapSnapshot.cpp

  static uint64_t GetObjectNodeId(GlobalObject& global,

                                  JS::Handle<JSObject*> aVal);

  // Implemented in devtools/shared/heapsnapshot/HeapSnapshot.cpp

  static void SaveHeapSnapshot(GlobalObject& global,

                               const HeapSnapshotBoundaries& boundaries,

                               nsAString& filePath, ErrorResult& rv);

  // Implemented in devtools/shared/heapsnapshot/HeapSnapshot.cpp

  static void SaveHeapSnapshotGetId(GlobalObject& global,

                                    const HeapSnapshotBoundaries& boundaries,

                                    nsAString& snapshotId, ErrorResult& rv);

  // Implemented in devtools/shared/heapsnapshot/HeapSnapshot.cpp

  static already_AddRefed<devtools::HeapSnapshot> ReadHeapSnapshot(

      GlobalObject& global, const nsAString& filePath, ErrorResult& rv);

  static bool IsDevToolsOpened();

  static bool IsDevToolsOpened(GlobalObject& aGlobal);

  static void NotifyDevToolsOpened(GlobalObject& aGlobal);

  static void NotifyDevToolsClosed(GlobalObject& aGlobal);

  static void NondeterministicGetWeakMapKeys(

      GlobalObject& aGlobal, JS::Handle<JS::Value> aMap,

      JS::MutableHandle<JS::Value> aRetval, ErrorResult& aRv);

  static void NondeterministicGetWeakSetKeys(

      GlobalObject& aGlobal, JS::Handle<JS::Value> aSet,

      JS::MutableHandle<JS::Value> aRetval, ErrorResult& aRv);

  static void Base64URLEncode(GlobalObject& aGlobal,

                              const ArrayBufferViewOrArrayBuffer& aSource,

                              const Base64URLEncodeOptions& aOptions,

                              nsACString& aResult, ErrorResult& aRv);

  static void Base64URLDecode(GlobalObject& aGlobal, const nsACString& aString,

                              const Base64URLDecodeOptions& aOptions,

                              JS::MutableHandle<JSObject*> aRetval,

                              ErrorResult& aRv);

  static void ReleaseAssert(GlobalObject& aGlobal, bool aCondition,

                            const nsAString& aMessage);

  static void AddProfilerMarker(GlobalObject& aGlobal, const nsACString& aName,

                                const ProfilerMarkerOptionsOrDouble& aOptions,

                                const Optional<nsACString>& text);

  static void GetXPCOMErrorName(GlobalObject& aGlobal, uint32_t aErrorCode,

                                nsACString& aRetval);

  static void OriginAttributesToSuffix(

      GlobalObject& aGlobal, const dom::OriginAttributesDictionary& aAttrs,

      nsCString& aSuffix);

  static bool OriginAttributesMatchPattern(

      dom::GlobalObject& aGlobal, const dom::OriginAttributesDictionary& aAttrs,

      const dom::OriginAttributesPatternDictionary& aPattern);

  static void CreateOriginAttributesFromOrigin(

      dom::GlobalObject& aGlobal, const nsAString& aOrigin,

      dom::OriginAttributesDictionary& aAttrs, ErrorResult& aRv);

  static void CreateOriginAttributesFromOriginSuffix(

      dom::GlobalObject& aGlobal, const nsAString& aSuffix,

      dom::OriginAttributesDictionary& aAttrs, ErrorResult& aRv);

  static void FillNonDefaultOriginAttributes(

      dom::GlobalObject& aGlobal, const dom::OriginAttributesDictionary& aAttrs,

      dom::OriginAttributesDictionary& aNewAttrs);

  static bool IsOriginAttributesEqual(

      dom::GlobalObject& aGlobal, const dom::OriginAttributesDictionary& aA,

      const dom::OriginAttributesDictionary& aB);

  static bool IsOriginAttributesEqual(

      const dom::OriginAttributesDictionary& aA,

      const dom::OriginAttributesDictionary& aB);

  static bool IsOriginAttributesEqualIgnoringFPD(

      const dom::OriginAttributesDictionary& aA,

      const dom::OriginAttributesDictionary& aB) {

    return aA.mUserContextId == aB.mUserContextId &&

           aA.mPrivateBrowsingId == aB.mPrivateBrowsingId;

  static void GetBaseDomainFromPartitionKey(dom::GlobalObject& aGlobal,

                                            const nsAString& aPartitionKey,

                                            nsAString& aBaseDomain,

                                            ErrorResult& aRv);

  static void GetPartitionKeyFromURL(dom::GlobalObject& aGlobal,

                                     const nsAString& aTopLevelUrl,

                                     const nsAString& aSubresourceUrl,

                                     const Optional<bool>& aForeignContext,

                                     nsAString& aPartitionKey,

                                     ErrorResult& aRv);

  // Implemented in js/xpconnect/loader/ChromeScriptLoader.cpp

  static already_AddRefed<Promise> CompileScript(

      GlobalObject& aGlobal, const nsAString& aUrl,

      const dom::CompileScriptOptionsDictionary& aOptions, ErrorResult& aRv);

  static UniquePtr<MozQueryInterface> GenerateQI(

      const GlobalObject& global, const Sequence<JS::Value>& interfaces);

  static void WaiveXrays(GlobalObject& aGlobal, JS::Handle<JS::Value> aVal,

                         JS::MutableHandle<JS::Value> aRetval,

                         ErrorResult& aRv);

  static void UnwaiveXrays(GlobalObject& aGlobal, JS::Handle<JS::Value> aVal,

                           JS::MutableHandle<JS::Value> aRetval,

                           ErrorResult& aRv);

  static void GetClassName(GlobalObject& aGlobal, JS::Handle<JSObject*> aObj,

                           bool aUnwrap, nsAString& aRetval);

  static bool IsDOMObject(GlobalObject& aGlobal, JS::Handle<JSObject*> aObj,

                          bool aUnwrap);

  static bool IsISOStyleDate(GlobalObject& aGlobal, const nsACString& aStr);

  static void ShallowClone(GlobalObject& aGlobal, JS::Handle<JSObject*> aObj,

                           JS::Handle<JSObject*> aTarget,

                           JS::MutableHandle<JSObject*> aRetval,

                           ErrorResult& aRv);

  static void IdleDispatch(const GlobalObject& global,

                           IdleRequestCallback& callback,

                           const IdleRequestOptions& options, ErrorResult& aRv);

  static void GetRecentJSDevError(GlobalObject& aGlobal,

                                  JS::MutableHandle<JS::Value> aRetval,

                                  ErrorResult& aRv);

  static void ClearRecentJSDevError(GlobalObject& aGlobal);

  static void ClearStyleSheetCacheByPrincipal(GlobalObject&,

                                              nsIPrincipal* aForPrincipal);

  static void ClearStyleSheetCacheBySite(

      GlobalObject&, const nsACString& aSchemelessSite,

      const dom::OriginAttributesPatternDictionary& aPattern);

  static void ClearStyleSheetCache(GlobalObject& aGlobal);

  static void ClearScriptCacheByPrincipal(GlobalObject&,

                                          nsIPrincipal* aForPrincipal);

  static void ClearScriptCacheBySite(

      GlobalObject& aGlobal, const nsACString& aSchemelessSite,

      const dom::OriginAttributesPatternDictionary& aPattern);

  static void ClearScriptCache(GlobalObject& aGlobal);

  static void SetPerfStatsCollectionMask(GlobalObject& aGlobal, uint64_t aMask);

  static already_AddRefed<Promise> CollectPerfStats(GlobalObject& aGlobal,

                                                    ErrorResult& aRv);

  static already_AddRefed<Promise> RequestProcInfo(GlobalObject& aGlobal,

                                                   ErrorResult& aRv);

  static bool VsyncEnabled(GlobalObject& aGlobal);

  static void Import(const GlobalObject& aGlobal,

                     const nsACString& aResourceURI,

                     const Optional<JS::Handle<JSObject*>>& aTargetObj,

                     JS::MutableHandle<JSObject*> aRetval, ErrorResult& aRv);

  static void ImportESModule(const GlobalObject& aGlobal,

                             const nsAString& aResourceURI,

                             const ImportESModuleOptionsDictionary& aOptions,

                             JS::MutableHandle<JSObject*> aRetval,

                             ErrorResult& aRv);

  static void DefineLazyGetter(const GlobalObject& aGlobal,

                               JS::Handle<JSObject*> aTarget,

                               JS::Handle<JS::Value> aName,

                               JS::Handle<JSObject*> aLambda, ErrorResult& aRv);

  static void DefineModuleGetter(const GlobalObject& global,

                                 JS::Handle<JSObject*> target,

                                 const nsAString& id,

                                 const nsAString& resourceURI,

                                 ErrorResult& aRv);

  static void DefineESModuleGetters(

      const GlobalObject& global, JS::Handle<JSObject*> target,

      JS::Handle<JSObject*> modules,

      const ImportESModuleOptionsDictionary& aOptions, ErrorResult& aRv);

#ifdef XP_UNIX

  static void GetLibcConstants(const GlobalObject&, LibcConstants& aConsts);

#endif

  static void GetCallerLocation(const GlobalObject& global,

                                nsIPrincipal* principal,

                                JS::MutableHandle<JSObject*> aRetval);

  static void CreateError(const GlobalObject& global, const nsAString& message,

                          JS::Handle<JSObject*> stack,

                          JS::MutableHandle<JSObject*> aRetVal,

                          ErrorResult& aRv);

  static bool HasReportingHeaderForOrigin(GlobalObject& global,

                                          const nsAString& aOrigin,

                                          ErrorResult& aRv);

  static PopupBlockerState GetPopupControlState(GlobalObject& aGlobal);

  static double LastExternalProtocolIframeAllowed(GlobalObject& aGlobal);

  static void ResetLastExternalProtocolIframeAllowed(GlobalObject& aGlobal);

  static void EndWheelTransaction(GlobalObject& aGlobal);

  static void RegisterWindowActor(const GlobalObject& aGlobal,

                                  const nsACString& aName,

                                  const WindowActorOptions& aOptions,

                                  ErrorResult& aRv);

  static void UnregisterWindowActor(const GlobalObject& aGlobal,

                                    const nsACString& aName);

  static void RegisterProcessActor(const GlobalObject& aGlobal,

                                   const nsACString& aName,

                                   const ProcessActorOptions& aOptions,

                                   ErrorResult& aRv);

  static void UnregisterProcessActor(const GlobalObject& aGlobal,

                                     const nsACString& aName);

  static bool IsClassifierBlockingErrorCode(GlobalObject& aGlobal,

                                            uint32_t aError);

  static void PrivateNoteIntentionalCrash(const GlobalObject& aGlobal,

                                          ErrorResult& aError);

  static nsIDOMProcessChild* GetDomProcessChild(const GlobalObject&);

  static void GetAllDOMProcesses(

      GlobalObject& aGlobal, nsTArray<RefPtr<nsIDOMProcessParent>>& aParents,

      ErrorResult& aRv);

  static void ConsumeInteractionData(

      GlobalObject& aGlobal, Record<nsString, InteractionData>& aInteractions,

      ErrorResult& aRv);

  static already_AddRefed<Promise> CollectScrollingData(GlobalObject& aGlobal,

                                                        ErrorResult& aRv);

  static void GetFormAutofillConfidences(

      GlobalObject& aGlobal, const Sequence<OwningNonNull<Element>>& aElements,

      nsTArray<FormAutofillConfidences>& aResults, ErrorResult& aRv);

  static bool IsDarkBackground(GlobalObject&, Element&);

  static double DateNow(GlobalObject&);

  static void EnsureJSOracleStarted(GlobalObject&);

  static unsigned AliveUtilityProcesses(const GlobalObject&);

  static void GetAllPossibleUtilityActorNames(GlobalObject& aGlobal,

                                              nsTArray<nsCString>& aNames);

  static bool ShouldResistFingerprinting(

      GlobalObject& aGlobal, JSRFPTarget aTarget,

      const Nullable<uint64_t>& aOverriddenFingerprintingSettings);

#ifdef MOZ_WMF_CDM

  static already_AddRefed<Promise> GetWMFContentDecryptionModuleInformation(

      GlobalObject& aGlobal, ErrorResult& aRv);

#endif

  static already_AddRefed<Promise> GetGMPContentDecryptionModuleInformation(

      GlobalObject& aGlobal, ErrorResult& aRv);

 private:

  // Number of DevTools session debugging the current process

  static std::atomic<uint32_t> sDevToolsOpenedCount;

};

}  // namespace dom

}  // namespace mozilla

#endif  // mozilla_dom_ChromeUtils__