js/xpconnect/loader/SyncModuleLoader.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef mozilla_loader_SyncModuleLoader_h
   8 #define mozilla_loader_SyncModuleLoader_h
   9
  10 #include "js/loader/LoadContextBase.h"
  11 #include "js/loader/ModuleLoaderBase.h"
  12
  13 class mozJSModuleLoader;
  14
  15 namespace mozilla {
  16 namespace loader {
  17
  18 class SyncScriptLoader : public JS::loader::ScriptLoaderInterface {
  19  public:
  20   NS_DECL_ISUPPORTS
  21
  22  private:
  23   ~SyncScriptLoader() = default;
  24
  25   nsIURI* GetBaseURI() const override;
  26
  27   void ReportErrorToConsole(ScriptLoadRequest* aRequest,
  28                             nsresult aResult) const override;
  29
  30   void ReportWarningToConsole(ScriptLoadRequest* aRequest,
  31                               const char* aMessageName,
  32                               const nsTArray<nsString>& aParams) const override;
  33
  34   nsresult FillCompileOptionsForRequest(
  35       JSContext* cx, ScriptLoadRequest* aRequest, JS::CompileOptions* aOptions,
  36       JS::MutableHandle<JSScript*> aIntroductionScript) override;
  37 };
  38
  39 class SyncModuleLoader : public JS::loader::ModuleLoaderBase {
  40  public:
  41   NS_DECL_ISUPPORTS_INHERITED
  42   NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(SyncModuleLoader,
  43                                            JS::loader::ModuleLoaderBase)
  44
  45   SyncModuleLoader(SyncScriptLoader* aScriptLoader,
  46                    nsIGlobalObject* aGlobalObject);
  47
  48   [[nodiscard]] nsresult ProcessRequests();
  49
  50   void MaybeReportLoadError(JSContext* aCx);
  51
  52  private:
  53   ~SyncModuleLoader();
  54
  55   already_AddRefed<ModuleLoadRequest> CreateStaticImport(
  56       nsIURI* aURI, JS::ModuleType aModuleType,
  57       ModuleLoadRequest* aParent) override;
  58
  59   already_AddRefed<ModuleLoadRequest> CreateDynamicImport(
  60       JSContext* aCx, nsIURI* aURI, JS::ModuleType aModuleType,
  61       LoadedScript* aMaybeActiveScript, JS::Handle<JSString*> aSpecifier,
  62       JS::Handle<JSObject*> aPromise) override;
  63
  64   void OnDynamicImportStarted(ModuleLoadRequest* aRequest) override;
  65
  66   bool CanStartLoad(ModuleLoadRequest* aRequest, nsresult* aRvOut) override;
  67
  68   nsresult StartFetch(ModuleLoadRequest* aRequest) override;
  69
  70   nsresult CompileFetchedModule(
  71       JSContext* aCx, JS::Handle<JSObject*> aGlobal,
  72       JS::CompileOptions& aOptions, ModuleLoadRequest* aRequest,
  73       JS::MutableHandle<JSObject*> aModuleScript) override;
  74
  75   void OnModuleLoadComplete(ModuleLoadRequest* aRequest) override;
  76
  77   JS::loader::ScriptLoadRequestList mLoadRequests;
  78
  79   // If any of module scripts failed to load, exception is set here until it's
  80   // reported by MaybeReportLoadError.
  81   JS::PersistentRooted<JS::Value> mLoadException;
  82 };
  83
  84 // Data specific to SyncModuleLoader that is associated with each load
  85 // request.
  86 class SyncLoadContext : public JS::loader::LoadContextBase {
  87  public:
  88   SyncLoadContext() : LoadContextBase(JS::loader::ContextKind::Sync) {}
  89
  90  public:
  91   // The result of compiling a module script. These fields are used temporarily
  92   // before being passed to the module loader.
  93   nsresult mRv;
  94
  95   // The exception thrown during compiling a module script. These fields are
  96   // used temporarily before being passed to the module loader.
  97   JS::PersistentRooted<JS::Value> mExceptionValue;
  98
  99   JS::PersistentRooted<JSScript*> mScript;
 100 };
 101
 102 }  // namespace loader
 103 }  // namespace mozilla
 104
 105 #endif  // mozilla_loader_SyncModuleLoader_h