/* -*- 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_ModuleLoader_h
#define mozilla_dom_ModuleLoader_h

#include "mozilla/dom/ScriptLoadContext.h"
#include "js/loader/ModuleLoaderBase.h"
#include "js/loader/ScriptLoadRequest.h"
#include "ScriptLoader.h"

class nsIURI;

namespace JS {

class CompileOptions;

namespace loader {

class ModuleLoadRequest;

}  // namespace loader
}  // namespace JS

namespace mozilla {
namespace dom {

class ScriptLoader;
class SRIMetadata;

//////////////////////////////////////////////////////////////
// DOM Module loader implementation
//////////////////////////////////////////////////////////////

class ModuleLoader final : public JS::loader::ModuleLoaderBase {
 private:
  virtual ~ModuleLoader();

 public:
  explicit ModuleLoader(ScriptLoader* aLoader);

  ScriptLoader* GetScriptLoader();

  // Methods that must be overwritten by an extending class
  void EnsureModuleHooksInitialized() override;

  /**
   * Start a load for a module script URI.
   * Sets up the necessary security flags before calling StartLoadInternal.
   * Short-circuits if the module is already being loaded.
   */
  nsresult StartModuleLoad(ScriptLoadRequest* aRequest) override;

  void ProcessLoadedModuleTree(ModuleLoadRequest* aRequest) override;

  nsresult CompileOrFinishModuleScript(
      JSContext* aCx, JS::Handle<JSObject*> aGlobal,
      JS::CompileOptions& aOptions, ModuleLoadRequest* aRequest,
      JS::MutableHandle<JSObject*> aModuleScript) override;

  // Create a top-level module load request.
  static already_AddRefed<ModuleLoadRequest> CreateTopLevel(
      nsIURI* aURI, ScriptFetchOptions* aFetchOptions,
      const SRIMetadata& aIntegrity, nsIURI* aReferrer, ScriptLoader* aLoader,
      ScriptLoadContext* aContext);

  // Create a module load request for a static module import.
  already_AddRefed<ModuleLoadRequest> CreateStaticImport(
      nsIURI* aURI, ModuleLoadRequest* aParent) override;

  // Create a module load request for dynamic module import.
  static already_AddRefed<ModuleLoadRequest> CreateDynamicImport(
      nsIURI* aURI, ScriptFetchOptions* aFetchOptions, nsIURI* aBaseURL,
      ScriptLoadContext* aContext, ScriptLoader* aLoader,
      JS::Handle<JS::Value> aReferencingPrivate,
      JS::Handle<JSString*> aSpecifier, JS::Handle<JSObject*> aPromise);
};

}  // namespace dom
}  // namespace mozilla

#endif  // mozilla_dom_ModuleLoader_h